Go to file

Daniel Verkamp 8374a727a9 nvme: refactor nvme_attach() into nvme_probe() The new probing API will find all NVMe devices on the system and ask the caller whether to attach to each one. The caller will then receive a callback once each controller has finished initializing and has been attached to the driver. This will enable cleanup of the PCI abstraction layer (enabling us to use DPDK PCI functionality) as well as allowing future work on parallel NVMe controller startup and PCIe hotplug support. Change-Id: I3cdde7bfab0bc0bea1993dd549b9b0e8d36db9be Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>		2016-02-03 11:15:31 -07:00
doc	nvme: refactor nvme_attach() into nvme_probe()	2016-02-03 11:15:31 -07:00
examples	nvme: refactor nvme_attach() into nvme_probe()	2016-02-03 11:15:31 -07:00
include/spdk	nvme: refactor nvme_attach() into nvme_probe()	2016-02-03 11:15:31 -07:00
lib	nvme: refactor nvme_attach() into nvme_probe()	2016-02-03 11:15:31 -07:00
mk	Remove year from copyright headers.	2016-01-28 08:54:18 -07:00
scripts	Update bind.sh to bind nvme/ioat to uio_pci_generic driver	2016-02-01 15:37:00 -07:00
test	nvme: refactor nvme_attach() into nvme_probe()	2016-02-03 11:15:31 -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