numam-spdk
Go to file
Zeng Linggang 5096b4e033 build: remove redundant MAKEFLAGS set
Change-Id: I4596284950c491acc576192d8e9b3a31241fbe49
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-03-07 13:25:18 -07:00
doc doc: add spdk/ path to Doxygen indexes 2016-02-17 12:18:27 -07:00
examples nvme_manage: sort devices by PCI address 2016-03-04 16:08:14 -07:00
include/spdk spdk: Add namespace management interface and unit tests. 2016-03-04 09:52:30 +08:00
lib nvme: Add SGL support in NVMe driver 2016-03-04 09:36:40 -07:00
mk build: add config option to use Address Sanitizer 2016-02-23 16:41:31 -07:00
scripts build: remove redundant MAKEFLAGS set 2016-03-07 13:25:18 -07:00
test nvme: Add SGL support in NVMe driver 2016-03-04 09:36:40 -07:00
.astylerc
.gitignore kperf: add .gitignore entries 2016-02-23 16:36:37 -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
autotest.sh Add vfio support to scripts. 2016-02-22 11:30:47 -07:00
CONFIG build: add config option to use Address Sanitizer 2016-02-23 16:41:31 -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
README.md Add the mailing list to README.md. 2016-02-26 15:50:59 -07:00
unittest.sh ioat: add user-mode Intel I/OAT driver 2015-12-09 10:14:15 -07:00

Storage Performance Development Kit

Build Status Gitter

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.

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

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.

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