numam-spdk
Go to file
Daniel Verkamp c714a9f06f configure_hugepages: use number of pages on FreeBSD
Also request fewer huge pages overall during autotest.

Change-Id: I6744c9a948e8db24b8ed3c7d9d99c89e1e50ba9c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-12-07 16:32:19 -07:00
doc doc: tweak Doxygen footer 2015-11-10 09:31:16 -07:00
examples build: define a common Makefile clean command 2015-12-07 15:14:36 -07:00
include/spdk nvme: add max completions limit to I/O polling 2015-11-05 15:07:52 -07:00
lib build: define a common Makefile clean command 2015-12-07 15:14:36 -07:00
mk build: define a common Makefile clean command 2015-12-07 15:14:36 -07:00
scripts configure_hugepages: use number of pages on FreeBSD 2015-12-07 16:32:19 -07:00
test build: define a common Makefile clean command 2015-12-07 15:14:36 -07:00
.astylerc build: check formatting with astyle 2015-09-23 09:05:51 -07:00
.gitignore build: add CONFIG_COVERAGE code coverage option 2015-11-02 14:40:49 -07:00
.travis.yml build: add Travis CI integration 2015-11-04 11:05:59 -07:00
autobuild.sh autobuild: add sleep to fix dependency test 2015-11-03 15:19:36 -07:00
autopackage.sh CONFIG: allow overriding options in make command 2015-10-22 12:24:57 -07:00
autotest.sh configure_hugepages: use number of pages on FreeBSD 2015-12-07 16:32:19 -07:00
CONFIG build: add CONFIG_COVERAGE code coverage option 2015-11-02 14:40:49 -07:00
LICENSE SPDK: Initial check-in 2015-09-21 08:52:41 -07:00
Makefile build: allow make to work from any directory 2015-11-04 10:19:08 -07:00
PORTING.md Add porting guide. 2015-09-28 09:07:19 -07:00
README.md build: Allow relative path for DPDK_DIR 2015-12-07 14:08:28 -07:00
unittest.sh build: add Travis CI integration 2015-11-04 11:05:59 -07:00

Storage Performance Development Kit

Build Status

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.

Documentation

Doxygen API documentation

Porting Guide

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

  • gcc
  • libpciaccess-devel
  • CUnit-devel

Ubuntu/Debian:

  • gcc
  • libpciaccess-dev
  • make
  • libcunit1-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.1.0.tar.gz
3) tar xfz dpdk-2.1.0.tar.gz
4) cd dpdk-2.1.0

Linux:

5) make install T=x86_64-native-linuxapp-gcc

FreeBSD:

5) gmake install T=x86_64-native-bsdapp-clang

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.1.0/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-2.1.0/x86_64-native-bsdapp-clang

Hugepages and Device Binding

Before running an SPDK application, some hugepages must be allocated and any NVMe devices must be unbound from the native NVMe kernel driver. SPDK includes scripts to automate this process on both Linux and FreeBSD.

1) scripts/configure_hugepages.sh
2) scripts/unbind_nvme.sh