d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
369 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
e42620be57
Go to file
Daniel Verkamp e42620be57 conf: add configuration file parsing library 
Originally based on code from istgt.

Change-Id: Ie789ba511332528aa29f13428d95306253c2ceb5
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-05-09 10:43:47 -07:00
doc doc/nvme: move pages to separate text files 2016-03-29 10:49:06 -07:00
examples identify: Add support for intel marketing description page 2016-05-06 09:01:52 +08:00
include/spdk conf: add configuration file parsing library 2016-05-09 10:43:47 -07:00
lib conf: add configuration file parsing library 2016-05-09 10:43:47 -07:00
mk build: prepare spdk.common.mk for building C++ files 2016-03-25 04:31:32 -07:00
scripts spdk: Enable vfio for non-privileged user. 2016-04-14 14:24:23 -07:00
test test/nvme: initialize payload.md in ctrlr_cmd_ut 2016-05-06 12:52:05 -07:00
.astylerc build: check formatting with astyle 2015-09-23 09:05:51 -07:00
.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 doc: merge ioat and nvme into a single Doxyfile 2016-03-25 09:59:39 -07:00
autopackage.sh CONFIG: allow overriding options in make command 2015-10-22 12:24:57 -07:00
autotest.sh scripts: merge hugepage config into setup.sh 2016-04-14 13:36:44 -07:00
CHANGELOG.md CHANGELOG: add NVMe E2E and VFIO PCI support 2016-04-28 16:00:33 -07:00
CONFIG config: make -Werror optional and off by default 2016-03-18 10:42:28 -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 doxygen link in README.md 2016-05-06 15:28:23 -07:00
unittest.sh config: make -Werror optional and off by default 2016-03-18 10:42:28 -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 a script to automate this process on both Linux and FreeBSD. This script should be run as root.

sudo 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.