numam-spdk
Go to file
Daniel Verkamp 49977bc28e changelog: begin filling out v17.07 section
Change-Id: I83813557d33e34be13dab543ab513127b568bf80
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/362044
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2017-06-02 12:04:58 -04:00
app nvmf_tgt: decouple RPC ns list from subsystem internals 2017-06-01 19:43:45 -04:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc io_channel: Remove per-channel priority 2017-05-26 13:42:19 -04:00
dpdk@d426cbab21 Update dpdk submodule to d426cbab2: 2017-05-22 15:31:15 -04:00
dpdkbuild dpdkbuild: enable -g for debug builds 2017-05-31 14:50:50 -04:00
etc/spdk test/blobfs: use test stub 2017-05-25 16:55:03 -04:00
examples env: Rename spdk_malloc/zmalloc/realloc/free to spdk_dma_(func) 2017-05-31 15:30:27 -04:00
include bdev: Remove reset_type 2017-06-02 12:02:53 -04:00
lib vhost: remove direct DPDK API call from vhost library 2017-06-02 12:04:15 -04:00
mk Add thread sanitizer to configure options 2017-05-26 13:17:14 -04:00
scripts autobuild.sh && autotest_common.sh: added configuration flags for valgrind and scan-build. 2017-06-01 12:14:39 -04:00
test test/iscsi_tgt/ext4test: update for DPDK submodule 2017-06-02 12:04:30 -04:00
.astylerc scripts/check_format.sh: only check tracked files 2017-04-26 16:35:34 -07:00
.gitignore unittests: add local UT coverage 2017-05-18 09:48:23 -07:00
.gitmodules build: add dpdk as a submodule 2017-05-17 09:49:27 -07:00
.travis.yml travis: switch to using the dpdk submodule 2017-05-22 22:17:55 -04:00
autobuild.sh autobuild.sh && autotest_common.sh: added configuration flags for valgrind and scan-build. 2017-06-01 12:14:39 -04:00
autopackage.sh autopackage: avoid timezone issues with git archive 2017-06-02 12:04:44 -04:00
autorun.sh autorun: make config setup common to all scripts 2017-05-02 17:11:46 -07:00
autotest.sh autotest: ignore coverage info for DPDK 2017-06-01 14:00:02 -04:00
CHANGELOG.md changelog: begin filling out v17.07 section 2017-06-02 12:04:58 -04:00
CONFIG Add thread sanitizer to configure options 2017-05-26 13:17:14 -04:00
configure Add thread sanitizer to configure options 2017-05-26 13:17:14 -04:00
LICENSE Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile build: add dpdk as a submodule 2017-05-17 09:49:27 -07:00
README.md vagrant: minor tweaks 2017-05-25 13:52:25 -04:00
unittest.sh unittest.sh: limit coverage to libraries 2017-05-18 11:10:08 -07:00

Storage Performance Development Kit

Build Status

SPDK Mailing List

SPDK on 01.org

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:

Documentation

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

Many examples are available in the examples directory.

Changelog

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

sudo dnf install -y gcc gcc-c++ CUnit-devel libaio-devel openssl-devel
# Additional dependencies for NVMe over Fabrics:
sudo dnf install -y libibverbs-devel librdmacm-devel

Ubuntu/Debian:

sudo apt-get install -y gcc g++ make libcunit1-dev libaio-dev libssl-dev
# Additional dependencies for NVMe over Fabrics:
sudo apt-get install -y libibverbs-dev librdmacm-dev

FreeBSD:

sudo pkg install gmake cunit openssl

Additionally, DPDK is required. The SPDK repository includes a suitable version of DPDK as a submodule:

git submodule update --init

Building

Once the prerequisites are installed, building follows the common configure and make pattern (note: this will build the DPDK submodule as well).

Linux:

./configure
make

FreeBSD:

./configure
gmake

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 scripts/vagrant/README.md.

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-dpdk=./dpdk/x86_64-native-linuxapp-gcc --with-rdma

Additionally, CONFIG options may also be overrriden 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. 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

Examples

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.