numam-spdk

Go to file

Daniel Verkamp 396c32c48f conf: move structures out of public API header Change-Id: Id2a7f083d959c9bbe493c383e6c9578de34c5eae Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2016-11-16 10:33:16 -07:00
app	conf: add accessors for section name and num	2016-11-16 10:33:12 -07:00
doc	doc: remove link to nvme_driver_integration page	2016-11-01 09:43:32 -07:00
etc/spdk	etc/nvmf.conf: add [Rpc] section example	2016-11-02 09:12:53 -07:00
examples	nvme: create the mempool from the name with the suffix of pid	2016-11-09 22:04:27 -05:00
include/spdk	conf: move structures out of public API header	2016-11-16 10:33:16 -07:00
lib	conf: move structures out of public API header	2016-11-16 10:33:16 -07:00
mk	nvme: move I/O qpair allocation to transport	2016-10-19 08:09:45 -07:00
scripts	setup.sh: two minor fixes	2016-11-09 10:04:41 -07:00
test	scsi/init_ut: use the public conf API	2016-11-16 10:33:16 -07:00
.astylerc	build: check formatting with astyle	2015-09-23 09:05:51 -07:00
.gitignore	gitignore: ignore .kdev4 (KDevelop) files	2016-07-12 09:08:01 -07:00
.travis.yml	readme, travis: update to DPDK 16.11	2016-11-15 11:14:32 -07:00
autobuild.sh	rbd: Enable rbd compilation in automation test	2016-10-14 14:04:15 -07:00
autopackage.sh	CONFIG: allow overriding options in make command	2015-10-22 12:24:57 -07:00
autorun.sh	eofnl: check for extra trailing newlines	2016-10-11 13:30:33 -07:00
autotest.sh	test/rbd: Enable fio test for iSCSI target while using RBD as LUN	2016-11-09 08:57:54 -07:00
CHANGELOG.md	nvme: return virtual address in SGL callback	2016-11-09 08:57:40 -07:00
CONFIG	env: rename default implementation to env_dpdk	2016-11-14 08:48:20 -07:00
LICENSE	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
Makefile	build: generate config.h and implicitly include it	2016-06-08 10:26:50 -07:00
PORTING.md	env: rename default implementation to env_dpdk	2016-11-14 08:48:20 -07:00
README.md	readme, travis: update to DPDK 16.11	2016-11-15 11:14:32 -07:00
unittest.sh	scsi: translate nvme error to scsi error (#54 )	2016-10-28 13:06:45 -07:00

README.md

Storage Performance Development Kit

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:

gcc
gmake
cunit
openssl

Additionally, DPDK is required.

1) cd /path/to/spdk
2) wget http://fast.dpdk.org/rel/dpdk-16.11.tar.xz
3) tar xf dpdk-16.11.tar.xz

Linux:

4) (cd dpdk-16.11 && make install T=x86_64-native-linuxapp-gcc DESTDIR=.)

FreeBSD:

4) (cd dpdk-16.11 && gmake install T=x86_64-native-bsdapp-clang DESTDIR=.)

Building

Once the prerequisites are installed, run 'make' within the SPDK directory to build the SPDK libraries and examples.

make DPDK_DIR=/path/to/dpdk

If you followed the instructions above for building DPDK:

Linux:

make DPDK_DIR=./dpdk-16.11/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-16.11/x86_64-native-bsdapp-clang

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.