Go to file

Daniel Verkamp ac0c37924c nvme: validate child I/O in splitting test Check the LBA and block count fields of the I/Os generated by the splitting function to ensure they were split correctly. Change-Id: I84abb1ac462fb7423d51a1be384fd1be68dfecae Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2015-09-28 14:04:51 -07:00
doc	doc: remove reference to nonexistent images dir	2015-09-24 11:24:16 -07:00
examples	Fix header file dependencies.	2015-09-28 09:07:04 -07:00
include/spdk	Add pci_device_has_non_null_driver().	2015-09-25 12:45:04 -07:00
lib	nvme: move nvme_request_add_child to nvme_ns_cmd.c	2015-09-28 14:04:11 -07:00
mk	Fix header file dependencies.	2015-09-28 09:07:04 -07:00
scripts	Add unbind_nvme.sh script.	2015-09-25 12:45:04 -07:00
test	nvme: validate child I/O in splitting test	2015-09-28 14:04:51 -07:00
.astylerc	build: check formatting with astyle	2015-09-23 09:05:51 -07:00
.gitignore	README.md: add more detailed quick start instructions	2015-09-24 09:59:56 -07:00
autobuild.sh	Fix header file dependencies.	2015-09-28 09:07:04 -07:00
autopackage.sh	build: build with DEBUG=n during autopackage	2015-09-25 14:23:01 -07:00
autotest.sh	autotest: capture core dumps on early exits	2015-09-25 09:49:09 -07:00
CONFIG	SPDK: Initial check-in	2015-09-21 08:52:41 -07:00
LICENSE	SPDK: Initial check-in	2015-09-21 08:52:41 -07:00
Makefile	SPDK: Initial check-in	2015-09-21 08:52:41 -07:00
PORTING.md	Add porting guide.	2015-09-28 09:07:19 -07:00
README.md	Add porting guide.	2015-09-28 09:07:19 -07:00

README.md

Storage Performance Development Kit

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.

Porting Guide

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

gcc
libpciaccess-devel
CUnit-devel

Ubuntu/Debian:

gcc
libpciaccess-dev
make
libcunit1-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.1.0.tar.gz
3) tar xfz dpdk-2.1.0.tar.gz
4) cd dpdk-2.1.0

Linux:

5) make install T=x86_64-native-linuxapp-gcc

FreeBSD:

5) gmake install T=x86_64-native-bsdapp-clang

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=`pwd`/dpdk-2.1.0/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=`pwd`/dpdk-2.1.0/x86_64-native-bsdapp-clang

Hugepages and Device Binding

Before running an SPDK application, some hugepages must be allocated and any NVMe devices must be unbound from the native NVMe kernel driver. SPDK includes scripts to automate this process on both Linux and FreeBSD.

1) scripts/configure_hugepages.sh
2) scripts/unbind_nvme.sh