d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
381 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
ca3d1c5b45
Go to file
Changpeng Liu ca3d1c5b45 spdk: add controller memory buffer support in driver 
The D3700/D3600 series support Controller Memory Buffer(CMB) feature,
CMB is available for holding submission queues, for those controllers
which can support submission queues in CMB, user can set the option
whether to enable it or not.

Change-Id: I8b0dc9e28dd6f5bb01bee99a532087212c04e492
Signed-off-by: Changpeng Liu <changpeng.liu@intel.com>
2016-05-13 08:14:10 +08:00
app trace: add tracepoint library and app 2016-05-11 10:43:09 -07:00
doc
examples nvme_manage: Add command to support firmware upgrade. 2016-05-11 10:18:38 -07:00
include/spdk spdk: add controller memory buffer support in driver 2016-05-13 08:14:10 +08:00
lib spdk: add controller memory buffer support in driver 2016-05-13 08:14:10 +08:00
mk trace: add tracepoint library and app 2016-05-11 10:43:09 -07:00
scripts check_format.sh: check C++ files (.cpp) 2016-05-11 14:10:58 -07:00
test spdk: add controller memory buffer support in driver 2016-05-13 08:14:10 +08:00
.astylerc
.gitignore
.travis.yml
autobuild.sh
autopackage.sh
autotest.sh log: add SPDK logging library 2016-05-09 15:54:49 -07:00
CHANGELOG.md
CONFIG
LICENSE
Makefile trace: add tracepoint library and app 2016-05-11 10:43:09 -07:00
PORTING.md
README.md README: update to DPDK 16.04 2016-05-11 10:50:55 -07:00
unittest.sh log: add SPDK logging library 2016-05-09 15:54:49 -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-16.04.tar.gz
3) tar xfz dpdk-16.04.tar.gz

Linux:

4) (cd dpdk-16.04 && make install T=x86_64-native-linuxapp-gcc DESTDIR=.)

FreeBSD:

4) (cd dpdk-16.04 && 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-16.04/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-16.04/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.