src/ceph/src/test/fio/README.md

   1 FIO
   2 ===
   3
   4 Ceph uses the fio workload generator and benchmarking utility.
   5
   6 To fetch the fio sources:
   7
   8     git clone git://git.kernel.dk/fio.git
   9
  10 To build fio:
  11
  12     ./configure
  13     make
  14
  15 RBD
  16 ---
  17
  18 The fio engine for rbd is located in the fio tree itself, so you'll need to
  19 build it from source.
  20
  21 If you install the ceph libraries to a location that isn't in your
  22 LD_LIBRARY_PATH, be sure to add it:
  23
  24     export LD_LIBRARY_PATH=/path/to/install/lib
  25
  26 To build fio with rbd:
  27
  28     ./configure --extra-cflags="-I/path/to/install/include -L/path/to/install/lib"
  29     make
  30
  31 If configure fails with "Rados Block Device engine   no", see config.log for
  32 details and adjust the cflags as necessary.
  33
  34 To view the fio options specific to the rbd engine:
  35
  36     ./fio --enghelp=rbd
  37
  38 See examples/rbd.fio for an example job file. To run:
  39
  40     ./fio examples/rbd.fio
  41
  42 ObjectStore
  43 -----------
  44
  45 This fio engine allows you to mount and use a ceph object store directly,
  46 without having to build a ceph cluster or start any daemons.
  47
  48 Because the ObjectStore is not a public-facing interface, we build it inside
  49 of the ceph tree and load libfio_ceph_objectstore.so into fio as an external
  50 engine.
  51
  52 To build fio_ceph_objectstore:
  53 ```
  54   mkdir build && cd build
  55   cmake -DWITH_FIO=ON -DFIO_INCLUDE_DIR=/path/to/fio -DCMAKE_BUILD_TYPE=Release /path/to/ceph
  56   make -C src/test/fio install
  57 ```
  58 If you install the ceph libraries to a location that isn't in your
  59 LD_LIBRARY_PATH, be sure to add it:
  60
  61     export LD_LIBRARY_PATH=/path/to/install/lib
  62
  63 To view the fio options specific to the objectstore engine:
  64
  65     ./fio --enghelp=libfio_ceph_objectstore.so
  66
  67 The conf= option requires a ceph configuration file (ceph.conf). Example job
  68 and conf files for each object store are provided in the same directory as
  69 this README.
  70
  71 To run:
  72
  73     ./fio /path/to/job.fio