d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
284 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
a606a3ed5c
Go to file
Daniel Verkamp a606a3ed5c nvme/reset: simplify timing logic and shorten test 
Change-Id: I070223e25988e9a35a4df91331ea88bc4f7c5f13
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-03-14 08:12:36 -07:00
doc doc: add spdk/ path to Doxygen indexes 2016-02-17 12:18:27 -07:00
examples nvme_manage: accept more PCI address formats 2016-03-11 09:37:21 -07:00
include/spdk nvme manage: Add interface for format progress indicator. 2016-03-10 09:02:06 +08:00
lib nvme: don't set interrupt vector in create_io_cq 2016-03-14 08:04:44 -07:00
mk build: don't print top-level directory 2016-03-08 10:59:56 -07:00
scripts build: remove redundant MAKEFLAGS set 2016-03-07 13:25:18 -07:00
test nvme/reset: simplify timing logic and shorten test 2016-03-14 08:12:36 -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 CONFIG: allow overriding options in make command 2015-10-22 12:24:57 -07:00
autotest.sh Add vfio support to scripts. 2016-02-22 11:30:47 -07:00
CHANGELOG.md Add a changelog 2016-03-09 07:25:09 -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 build: don't print top-level directory 2016-03-08 10:59:56 -07:00
PORTING.md Add porting guide. 2015-09-28 09:07:19 -07:00
README.md Update the README to point users at the examples. 2016-03-11 10:23:03 -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

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.

The development kit currently includes:

  • NVMe driver
  • I/OAT (DMA engine) driver

Documentation

Doxygen API documentation is available, as well as a Porting Guide for porting SPDK to different frameworks and operating systems.

Many examples are available in the examples directory.

Changelog

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

sudo dnf install -y gcc libpciaccess-devel CUnit-devel libaio-devel

Ubuntu/Debian:

sudo apt-get install -y 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. Both of these scripts should be run as root.

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

Examples

Example code is located in the examples directory. The examples are compiled automatically as part of the build process. Simply call any of the examples with no arguments to see the help output. You'll likely need to run the examples as a privileged user (root) unless you've done additional configuration to grant your user permission to allocate huge pages and map devices through vfio.