d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
383 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
cd8e9833f9
Go to file
Daniel Verkamp cd8e9833f9 nvme: remove unused CMB_SQ_SUPPORTED flag 
The user can determine whether submission queues will be placed in the
controller memory buffer by checking the controller options use_cmb_sqs
flag in the attach callback.

Change-Id: I8a925ef99a48665a0e2ffaa90d9ff2b79b90b2fa
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-05-12 13:20:10 -07:00
app trace: add tracepoint library and app 2016-05-11 10:43:09 -07:00
doc doc/nvme: move pages to separate text files 2016-03-29 10:49:06 -07:00
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 nvme: remove unused CMB_SQ_SUPPORTED flag 2016-05-12 13:20:10 -07: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 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 log: add SPDK logging library 2016-05-09 15:54:49 -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 trace: add tracepoint library and app 2016-05-11 10:43:09 -07:00
PORTING.md Add porting guide. 2015-09-28 09:07:19 -07:00
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.