Go to file

Daniel Verkamp c02b179490 Remove year from copyright headers. Also add a space between Copyright and (c). The copyright year can be determined using git metadata. Also remove the duplicated "All rights reserved." - every instance of this line already has a corresponding "All rights reserved" immediately below it, except for examples/ioat/kperf/kmod/dma_perf.c, where I have added it manually. Performed using this command: git ls-files \| xargs sed -i -e 's/Copyright(c) \(.*\) Intel Corporation. All rights reserved./Copyright (c) Intel Corporation./' Change-Id: I3779f404966800709024eb1eb66a50068af2716c Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2016-01-28 08:54:18 -07:00
doc	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
examples	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
include/spdk	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
lib	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
mk	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
scripts	spdk: add the ioat_kperf test tool to autobuild system	2016-01-22 07:58:13 -07:00
test	Remove year from copyright headers.	2016-01-28 08:54:18 -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
.travis.yml	build: add Travis CI integration	2015-11-04 11:05:59 -07:00
autobuild.sh	spdk: add the ioat_kperf test tool to autobuild system	2016-01-22 07:58:13 -07:00
autopackage.sh	CONFIG: allow overriding options in make command	2015-10-22 12:24:57 -07:00
autotest.sh	spdk: add the ioat_kperf test tool to autobuild system	2016-01-22 07:58:13 -07:00
CONFIG	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
LICENSE	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
Makefile	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
PORTING.md	Add porting guide.	2015-09-28 09:07:19 -07:00
README.md	README: add libaio dependency	2016-01-21 10:47:55 -07:00
unittest.sh	ioat: add user-mode Intel I/OAT driver	2015-12-09 10:14:15 -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.

Documentation

Doxygen API documentation

Porting Guide

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

gcc
libpciaccess-devel
CUnit-devel
libaio-devel

Ubuntu/Debian:

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
4) cd dpdk-2.2.0

Linux:

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

FreeBSD:

5) 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.

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