History

Andrey Kuzmin 4e51a274de Fix fio_plugin build for FIO_IOOPS_VERSION >= 24. Fio commit d3b07186b1d4c7c1d9adc1306407458ce41ad048 changed return type of the ioengine->queue method to a new enumeration type fio_q_status. Add preprocessor checks to ensure SPDK fio_plugin builds successfully with both current and earlier fio ioengine API version. Change-Id: Ie9eb818473c6453624d6cfe51a19c6bf0d17e334 Signed-off-by: Andrey Kuzmin <andrey.v.kuzmin@gmail.com> Reviewed-on: https://review.gerrithub.io/413749 Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>		2018-06-05 16:35:52 +00:00
..
.gitignore	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
bdev.conf.in	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
example_config.fio	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
fio_plugin.c	Fix fio_plugin build for FIO_IOOPS_VERSION >= 24.	2018-06-05 16:35:52 +00:00
full_bench.fio	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
Makefile	build: add @: to remaining 'all' targets	2018-02-14 17:38:25 -05:00
README.md	CHANGELOG: add fio 3.3 support	2018-01-11 15:02:54 -05:00

README.md

Compiling fio

Clone the fio source repository from https://github.com/axboe/fio

git clone https://github.com/axboe/fio

Then check out the fio 3.3:

cd fio && git checkout fio-3.3

Finally, compile the code:

make

Compiling SPDK

Clone the SPDK source repository from https://github.com/spdk/spdk

git clone https://github.com/spdk/spdk
git submodule update --init

Then, run the SPDK configure script to enable fio (point it to the root of the fio repository):

cd spdk
./configure --with-fio=/path/to/fio/repo <other configuration options>

Finally, build SPDK:

make

Note to advanced users: These steps assume you're using the DPDK submodule. If you are using your own version of DPDK, the fio plugin requires that DPDK be compiled with -fPIC. You can compile DPDK with -fPIC by modifying your DPDK configuration file and adding the line:

EXTRA_CFLAGS=-fPIC

Usage

To use the SPDK fio plugin with fio, specify the plugin binary using LD_PRELOAD when running fio and set ioengine=spdk_bdev in the fio configuration file (see example_config.fio in the same directory as this README).

LD_PRELOAD=<path to spdk repo>/examples/bdev/fio_plugin/fio_plugin fio

The fio configuration file must contain one new parameter:

spdk_conf=./examples/bdev/fio_plugin/bdev.conf

This must point at an SPDK configuration file. There are a number of example configuration files in the SPDK repository under etc/spdk.

You can specify which block device to run against by setting the filename parameter to the block device name:

filename=Malloc0

Or for NVMe devices:

filename=Nvme0n1

Currently the SPDK fio plugin is limited to the thread usage model, so fio jobs must also specify thread=1 when using the SPDK fio plugin.

fio also currently has a race condition on shutdown if dynamically loading the ioengine by specifying the engine's full path via the ioengine parameter - LD_PRELOAD is recommended to avoid this race condition.

When testing random workloads, it is recommended to set norandommap=1. fio's random map processing consumes extra CPU cycles which will degrade performance over time with the fio_plugin since all I/O are submitted and completed on a single CPU core.