numam-spdk
Go to file
Daniel Verkamp b23409854c doc: point Documentation link at index page
Rather than hard-coding the spdk.io/doc link, change the Doxygen header
to output a link to index.html (the main Doxygen page) so that it will
always point within the current doc tree.

This is important for archived release versions of the documentation,
since their documentation link should point at their own main page, not
the current master doc.

Change-Id: I788eee995543e425c24ff787f3f13956c5b813b7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-18 16:07:31 -07:00
app event: remove spdk_event_allocate() next parameter 2017-01-05 11:57:18 -07:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc doc: point Documentation link at index page 2017-01-18 16:07:31 -07:00
etc/spdk rpc: allow listening on a Unix socket 2016-12-15 08:06:33 -07:00
examples nvme/pcie: Add the support to probe nvme by pci_addr 2017-01-18 15:30:45 -07:00
include log: use facilitynames to set/get log facility (#81) 2017-01-17 11:20:34 -07:00
lib nvme/pcie: Add the support to probe nvme by pci_addr 2017-01-18 15:30:45 -07:00
mk test/nvme: don't link unit tests against spdk_nvme 2016-12-08 14:19:25 -07:00
scripts scripts/genconfig.py: fix format specs for older Python 2017-01-13 10:36:10 -07:00
test bdevperf: save offset and unmap desc in bdevperf_task 2017-01-18 16:06:45 -07:00
.astylerc build: check formatting with astyle 2015-09-23 09:05:51 -07:00
.gitignore gitignore: ignore .kdev4 (KDevelop) files 2016-07-12 09:08:01 -07:00
.travis.yml readme, travis: update to DPDK 16.11 2016-11-15 11:14:32 -07:00
autobuild.sh autobuild: log current git version and date 2016-12-16 10:27:28 -07:00
autopackage.sh autopackage: enable -Werror in release build 2016-11-17 10:29:11 -07:00
autorun.sh eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
autotest.sh test: Add autotest for hotplug. 2016-12-14 15:04:33 -07:00
CHANGELOG.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
CONFIG config: add option to turn on UBSan 2016-12-06 11:17:33 -07:00
LICENSE Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile build: generate config.h and implicitly include it 2016-06-08 10:26:50 -07:00
README.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
unittest.sh test/nvme: move nvme_pcie unit tests to a new file 2017-01-09 11:36:27 -07:00

Storage Performance Development Kit

Build Status

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:

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 gcc-c++ CUnit-devel libaio-devel openssl-devel
# Additional dependencies for NVMe over Fabrics:
sudo dnf install -y libibverbs-devel librdmacm-devel

Ubuntu/Debian:

sudo apt-get install -y gcc g++ make libcunit1-dev libaio-dev libssl-dev
# Additional dependencies for NVMe over Fabrics:
sudo apt-get install -y libibverbs-dev librdmacm-dev

FreeBSD:

  • gcc
  • gmake
  • cunit
  • openssl

Additionally, DPDK is required.

1) cd /path/to/spdk
2) wget http://fast.dpdk.org/rel/dpdk-16.11.tar.xz
3) tar xf dpdk-16.11.tar.xz

Linux:

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

FreeBSD:

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

FreeBSD:

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