numam-spdk

Go to file

Ziye Yang deb90a93de SPDK: add nvme_remove_child_request helper function This patch is used to add a nvme_request remove child helpler function Change-Id: I1e5bb228d53333ca3601f4ae30fcd801ea39e532 Signed-off-by: Ziye Yang <ziye.yang@intel.com>		2016-04-08 09:36:57 -07:00
doc	doc/nvme: move pages to separate text files	2016-03-29 10:49:06 -07:00
examples	manage: add support for protection info and multi-path IO	2016-04-07 10:24:07 -07:00
include/spdk	doc/ioat: add missing parameter documentation	2016-03-29 11:31:16 -07:00
lib	SPDK: add nvme_remove_child_request helper function	2016-04-08 09:36:57 -07:00
mk	config: make -Werror optional and off by default	2016-03-18 10:42:28 -07:00
scripts	autotest: only run NVMe AER test in nightly tests	2016-03-28 15:11:55 -07:00
test	SPDK: add nvme_remove_child_request helper function	2016-04-08 09:36:57 -07:00
.astylerc
.gitignore	kperf: add .gitignore entries	2016-02-23 16:36:37 -07:00
.travis.yml
autobuild.sh	doc: merge ioat and nvme into a single Doxyfile	2016-03-25 09:59:39 -07:00
autopackage.sh
autotest.sh	autotest: add timing enter/exit for setup/cleanup	2016-03-16 08:14:45 -07:00
CHANGELOG.md	nvme: make I/O queue allocation explicit	2016-03-14 16:00:54 -07:00
CONFIG	config: make -Werror optional and off by default	2016-03-18 10:42:28 -07:00
LICENSE
Makefile	build: don't print top-level directory	2016-03-08 10:59:56 -07:00
PORTING.md
README.md	Update the README to point users at the examples.	2016-03-11 10:23:03 -07:00
unittest.sh	config: make -Werror optional and off by default	2016-03-18 10:42:28 -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:

NVMe driver
I/OAT (DMA engine) driver

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 libpciaccess-devel CUnit-devel libaio-devel

Ubuntu/Debian:

sudo apt-get install -y gcc libpciaccess-dev make libcunit1-dev libaio-dev

FreeBSD:

gcc
libpciaccess
gmake
cunit

Additionally, DPDK is required.

1) cd /path/to/spdk
2) wget http://dpdk.org/browse/dpdk/snapshot/dpdk-2.2.0.tar.gz
3) tar xfz dpdk-2.2.0.tar.gz

Linux:

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

FreeBSD:

4) (cd dpdk-2.2.0 && 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-2.2.0/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-2.2.0/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 scripts to automate this process on both Linux and FreeBSD. Both of these scripts should be run as root.

1) scripts/configure_hugepages.sh
2) 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.