numam-spdk
Go to file
Cunyin Chang b86bd41aa6 nvmf: Remove unused return value.
Change-Id: I5df0339cfaa5877612705c5dce17b1fd69967208
Signed-off-by: Cunyin Chang <cunyin.chang@intel.com>
2016-06-27 09:19:17 -07:00
app build: include -lrt and -lpthread in LDFLAGS 2016-06-23 09:04:02 -07:00
doc doc/nvmf: add description of how to enable NVMf 2016-06-08 16:39:39 -07:00
etc/spdk nvmf: remove unimplemented AuthFile config 2016-06-09 14:25:26 -07:00
examples nvme: Update nvme_spec.h to 1.2.1 2016-06-24 09:18:14 -07:00
include/spdk nvmf: remove unused spdk_nvmf_capsule_rsp 2016-06-27 09:13:35 -07:00
lib nvmf: Remove unused return value. 2016-06-27 09:19:17 -07:00
mk build: move -lrt to a new SYS_LIBS variable 2016-06-23 09:29:22 -07:00
scripts genconfig: undef bool options so #ifdef works 2016-06-24 10:42:18 -07:00
test nvmf: Move process_*_cmd functions to request.h/c 2016-06-24 11:30:59 -07:00
.astylerc build: check formatting with astyle 2015-09-23 09:05:51 -07:00
.gitignore Expand .gitignore 2016-06-21 09:58:01 -07:00
.travis.yml build: add Travis CI integration 2015-11-04 11:05:59 -07:00
autobuild.sh nvme: Add an fio plugin 2016-05-18 13:51:36 -07:00
autopackage.sh CONFIG: allow overriding options in make command 2015-10-22 12:24:57 -07:00
autotest.sh nvmf: add unit tests 2016-06-08 08:49:38 -07:00
CHANGELOG.md changelog: update to 16.06 and add NVMf 2016-06-07 10:16:08 -07:00
CONFIG nvmf: add NVMe over Fabrics userspace target 2016-06-06 15:21:25 -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
PORTING.md Add porting guide. 2015-09-28 09:07:19 -07:00
README.md docs: Update README.md to reflect NVMf target 2016-06-08 16:18:56 -07:00
unittest.sh unittest.sh: generate config.h 2016-06-08 16:06:08 -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:

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

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
# Additional dependencies for NVMf:
sudo dnf install -y libibverbs-devel librdmacm-devel

Ubuntu/Debian:

sudo apt-get install -y gcc libpciaccess-dev make libcunit1-dev libaio-dev
# Additional dependencies for NVMf:
sudo apt-get install -y libibverbs-dev librdmacm-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.