BENCHMARKING

   1 A guide to benchmarking nbdkit
   2 ==============================
   3
   4
   5 General comments
   6 ----------------
   7
   8 * The plugin matters!  Different plugins have completely different
   9   uses, implementations and threading models.  There is little point
  10   in talking about "the performance of nbdkit" without mentioning what
  11   plugin you are testing.
  12
  13 * The client matters!  Does the client support multi-conn?  Does the
  14   client use the oldstyle or newstyle protocol?  Has the client been
  15   written with performance in mind?  The currently best clients are
  16   (a) the Linux kernel (nbd.ko) (b) qemu.  Make sure you are using
  17   recent versions and have multi-conn enabled.
  18
  19 * Filters affect performance.  When benchmarking you should never use
  20   filters unless filters are what you are trying to benchmark.
  21
  22
  23 Testing using Linux kernel client and fio
  24 -----------------------------------------
  25
  26 (1) Install Jens Axboe's fio (Flexible I/O tester)
  27
  28 https://github.com/axboe/fio
  29
  30 (2) Create the fio configuation file:
  31
  32 Create /var/tmp/test.fio containing:
  33
  34 ----------------------------------------------------------------------
  35 [test]
  36 rw=randrw
  37 size=64m
  38 directory=/var/tmp/nbd
  39 ioengine=libaio
  40 iodepth=4
  41 direct=1
  42 numjobs=8
  43 group_reporting
  44 time_based
  45 runtime=120
  46 ----------------------------------------------------------------------
  47
  48 (3) Run nbdkit.
  49
  50 From the nbdkit source directory:
  51
  52 rm /tmp/sock
  53 ./nbdkit -f -U /tmp/sock memory 1G
  54
  55 (4) Loop mount the NBD server:
  56
  57 modprobe nbd
  58 nbd-client -C 8 -b 512 -unix /tmp/sock /dev/nbd0
  59 mkfs.xfs -f /dev/nbd0
  60 mkdir /var/tmp/nbd
  61 mount /dev/nbd0 /var/tmp/nbd
  62
  63 (5) Run the fio test:
  64
  65 fio /var/tmp/test.fio
  66
  67
  68 Variations
  69 ----------
  70
  71 * Try turning multi-conn on or off or adjusting the number of
  72   connections.  See the nbd-client -C option.
  73
  74 * Try adjusting the number of fio threads.
  75
  76 * Run nbdkit under perf:
  77
  78   perf record -a -g --call-graph=dwarf -- \
  79       server/nbdkit  -f -U /tmp/sock \
  80           ./plugins/memory/.libs/nbdkit-memory-plugin.so 1G
  81
  82 * Use other plugins.  nbdkit-file-plugin is an important one to test.
  83   It might also be worth devising a test using a readonly plugin.
  84
  85
  86 Future work
  87 -----------
  88
  89 * Write an NBD I/O engine for fio.