History

Daniel Verkamp 8eef5183d3 bdev: remove spdk_bdev_poller_start() lcore option Always start bdev pollers on the calling core. This removes the lcore concept from the bdev poller abstraction and simplifies the job of spdk_bdev_initialize() callers providing their own poller and event implementations. All callers except the NVMe bdev hotplug poller already used the current core as the parameter. The NVMe HotplugPollCore option was undocumented and unused in any of the tests or example configuration files, so it should be safe to remove. Change-Id: I93b466e1e58901b8785c40cbe296fa46c157850f Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/382857 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>		2017-10-18 20:28:29 -04: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	bdev: remove spdk_bdev_poller_start() lcore option	2017-10-18 20:28:29 -04:00
full_bench.fio	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
Makefile	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
README.md	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04: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 2.21:

cd fio && git checkout fio-2.21

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.