History

Jim Harris d132ee3531 build: use DEPDIRS variables to build SPDK_LIB_LIST All of our Makefiles duplicate huge lists of libraries in SPDK_LIB_LIST. We have a very precise and accurate accounting of the library dependencies in mk/spdk.lib_deps.mk which can be used to generate the full list if the app specifies the modules and subsystem libraries it wishes to link. I did a first pass through all of the existing Makefiles to take advantage of this new functionality. There may be more optimizations we can make later but don't want to hold up this patch for all of them. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Icdaf6f749a6908df2c2ce2db22631a4af4ff3a9e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5553 Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>		2020-12-18 09:40:01 +00:00
..
.gitignore	bdev: Add an example fio plugin	2017-08-04 20:03:37 -04:00
bdev.json	bdev_fio: remove legacy config support	2020-10-21 20:46:20 +00:00
example_config.fio	bdev_fio: remove legacy config support	2020-10-21 20:46:20 +00:00
fio_plugin.c	remove unneeded spdk_internal/thread.h includes	2020-12-10 14:38:04 +00:00
full_bench.fio	doc: remove mentions of legacy config	2020-10-22 17:08:41 +00:00
Makefile	build: use DEPDIRS variables to build SPDK_LIB_LIST	2020-12-18 09:40:01 +00:00
README.md	doc: remove mentions of legacy config	2020-10-22 17:08:41 +00:00

README.md

Introduction

This directory contains a plug-in module for fio to enable use with SPDK. Fio is free software published under version 2 of the GPL license.

Compiling fio

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

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

Compile the fio code and install:

make
make install

Compiling SPDK

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

git clone https://github.com/spdk/spdk
cd 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>/build/fio/spdk_bdev fio

The fio configuration file must contain one new parameter:

spdk_json_conf=./examples/bdev/fio_plugin/bdev.json

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.