Go to file

Daniel Verkamp f40e98d200 autobuild: add sleep to fix dependency test With a reasonably fast machine, the full build can take less than a second. Make sure that at least one second has passed so the stat output will differ when testing Makefile dependencies. Change-Id: I462944d00c9c2ace2f6a1a7d6dadec4f77c25784 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2015-11-03 15:19:36 -07:00
doc	doc: remove reference to nonexistent images dir	2015-09-24 11:24:16 -07:00
examples	nvme/perf: Add support for multiple cores per device.	2015-11-03 13:07:37 -07:00
include/spdk	util: add file size and block size functions	2015-10-26 11:16:56 -07:00
lib	build: enable missing function declaration warning	2015-11-02 14:40:23 -07:00
mk	build: disable missing field initializer warning	2015-11-02 19:47:34 -07:00
scripts	build: add CONFIG_COVERAGE code coverage option	2015-11-02 14:40:49 -07:00
test	build: enable strict prototypes warning	2015-11-02 16:05:06 -07:00
.astylerc	build: check formatting with astyle	2015-09-23 09:05:51 -07:00
.gitignore	build: add CONFIG_COVERAGE code coverage option	2015-11-02 14:40:49 -07:00
autobuild.sh	autobuild: add sleep to fix dependency test	2015-11-03 15:19:36 -07:00
autopackage.sh	CONFIG: allow overriding options in make command	2015-10-22 12:24:57 -07:00
autotest.sh	build: add CONFIG_COVERAGE code coverage option	2015-11-02 14:40:49 -07:00
CONFIG	build: add CONFIG_COVERAGE code coverage option	2015-11-02 14:40:49 -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