Storage Performance Development Kit
Clone or download
Donaim and jimharris make: Fix test app Makefile dependencies
Add dependency $(ENV_LIBS) for test/env/*
 as part of new variable $(ADDITIONAL_LIBS) which is direct dependency
 of $(APP) in mk/spdk.unittest.mk

This solves the problem of
 make not triggering LINKing for test/env/*
 after changes made to lib/env_dpdk/*.c

Issue was that Makefiles in test/env/*/ classified tests as unittests
 by including mk/spdk.unittest.mk
But unittests are not using env_dpdk which means that
 unittests don't relink on env_dpdk update

Change-Id: I91b6690dc92d68bc69bbf11ac5336d3a7f56e4e4
Signed-off-by: Vitaliy Mysak <vitaliy.mysak@intel.com>
Reviewed-on: https://review.gerrithub.io/425665
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Dariusz Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Latest commit 4a7240a Sep 15, 2018
Permalink
Failed to load latest commit information.
.githooks test: use SKIP_DPDK_BUILD in pre-push githook Jul 14, 2018
app iscsi, nvmf, vhost: remove default config file pathnames Sep 5, 2018
build/lib build: consolidate library outputs in build/lib Nov 17, 2016
doc doc: add rpc example to bdev doc for crypto Sep 17, 2018
dpdk @ 08332d1 dpdk: move submodule to latest commit Sep 10, 2018
dpdkbuild bdev: Add crypto virtual bdev module Sep 17, 2018
etc/spdk test/ioat: remove unnecessary config entires Aug 30, 2018
examples blobcli: modify blobcli to use io unit size instead of page size Sep 18, 2018
go go: empty Go package Jun 28, 2018
include nvme: fix FC-related comments in spdk_nvme_transport_id Sep 18, 2018
intel-ipsec-mb @ 134c90c ipsec: update submodule commit Jul 26, 2018
lib ioat: change the return type of ioat_channel_destruct() to be void Sep 18, 2018
mk make: Fix test app Makefile dependencies Sep 19, 2018
scripts scripts: fix executable attribute for includes Sep 18, 2018
shared_lib build: add quiet output for recently added shared lib build Sep 6, 2018
test make: Fix test app Makefile dependencies Sep 19, 2018
.astylerc astyle: change "add-braces" to "j" for compatibility Dec 14, 2017
.gitignore shared_lib: Update shared lib build and install Aug 16, 2018
.gitmodules build: add intel-ipsec-mb submodule Jul 19, 2018
.travis.yml .travis.yml: tweak IRC notification Mar 16, 2018
CHANGELOG.md scripts: add config converter Sep 18, 2018
CONFIG build: remove DPDK_DIR Sep 7, 2018
CONTRIBUTING.md Add CONTRIBUTING.md Sep 5, 2017
ISSUE_TEMPLATE.md github: Add issue tracker template Apr 19, 2018
LICENSE Remove year from copyright headers. Jan 28, 2016
Makefile build: fix shared library dependencies Sep 6, 2018
README.md doc: clarify alternate dpdk options Sep 7, 2018
autobuild.sh autobuild: add shared object build to tests Sep 10, 2018
autopackage.sh autopackage: add ipsec submodule to autopackage Sep 4, 2018
autorun.sh autorun: make config setup common to all scripts May 3, 2017
autorun_post.py post_process: print coverage tables in a new directory Aug 21, 2018
autotest.sh blobstore: Add tests for bdev_blob_queue_io in blobstore Sep 18, 2018
configure bdev: Add crypto virtual bdev module Sep 17, 2018

README.md

Storage Performance Development Kit

Build Status

The Storage Performance Development Kit (SPDK) provides a set of tools and libraries for writing high performance, scalable, user-mode storage applications. It achieves high performance by moving all of the necessary drivers into userspace and operating in a polled mode instead of relying on interrupts, which avoids kernel context switches and eliminates interrupt handling overhead.

The development kit currently includes:

In this readme:

Documentation

Doxygen API documentation is available, as well as a Porting Guide for porting SPDK to different frameworks and operating systems.

Source Code

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

Prerequisites

The dependencies can be installed automatically by scripts/pkgdep.sh.

./scripts/pkgdep.sh

Build

Linux:

./configure
make

FreeBSD: Note: Make sure you have the matching kernel source in /usr/src/ and also note that CONFIG_COVERAGE option is not available right now for FreeBSD builds.

./configure
gmake

Unit Tests

./test/unit/unittest.sh

You will see several error messages when running the unit tests, but they are part of the test suite. The final message at the end of the script indicates success or failure.

Vagrant

A Vagrant setup is also provided to create a Linux VM with a virtual NVMe controller to get up and running quickly. Currently this has only been tested on MacOS and Ubuntu 16.04.2 LTS with the VirtualBox provider. The VirtualBox Extension Pack must also be installed in order to get the required NVMe support.

Details on the Vagrant setup can be found in the SPDK Vagrant documentation.

Advanced Build Options

Optional components and other build-time configuration are controlled by settings in two Makefile fragments in the root of the repository. CONFIG contains the base settings. Running the configure script generates a new file, CONFIG.local, that contains overrides to the base CONFIG file. For advanced configuration, there are a number of additional options to configure that may be used, or CONFIG.local can simply be created and edited by hand. A description of all possible options is located in CONFIG.

Boolean (on/off) options are configured with a 'y' (yes) or 'n' (no). For example, this line of CONFIG controls whether the optional RDMA (libibverbs) support is enabled:

CONFIG_RDMA?=n

To enable RDMA, this line may be added to CONFIG.local with a 'y' instead of 'n'. For the majority of options this can be done using the configure script. For example:

./configure --with-rdma

Additionally, CONFIG options may also be overridden on the make command line:

make CONFIG_RDMA=y

Users may wish to use a version of DPDK different from the submodule included in the SPDK repository. Note, this includes the ability to build not only from DPDK sources, but also just with the includes and libraries installed via the dpdk and dpdk-devel packages. To specify an alternate DPDK installation, run configure with the --with-dpdk option. For example:

Linux:

./configure --with-dpdk=/path/to/dpdk/x86_64-native-linuxapp-gcc
make

FreeBSD:

./configure --with-dpdk=/path/to/dpdk/x86_64-native-bsdapp-clang
gmake

The options specified on the make command line take precedence over the default values in CONFIG and CONFIG.local. This can be useful if you, for example, generate a CONFIG.local using the configure script and then have one or two options (i.e. debug builds) that you wish to turn on and off frequently.

Hugepages and Device Binding

Before running an SPDK application, some hugepages must be allocated and any NVMe and I/OAT devices must be unbound from the native kernel drivers. SPDK includes a script to automate this process on both Linux and FreeBSD. This script should be run as root.

sudo scripts/setup.sh

Users may wish to configure a specific memory size. Below is an example of configuring 8192MB memory.

sudo HUGEMEM=8192 scripts/setup.sh

Example Code

Example code is located in the examples directory. The examples are compiled automatically as part of the build process. Simply call any of the examples with no arguments to see the help output. You'll likely need to run the examples as a privileged user (root) unless you've done additional configuration to grant your user permission to allocate huge pages and map devices through vfio.

Contributing

For additional details on how to get more involved in the community, including contributing code and participating in discussions and other activities, please refer to spdk.io