d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ff7e2122c7
numam-spdk/README.md
Daniel Verkamp a7c6c3cc18 README: add libaio dependency 
libaio is required by examples/nvme/perf on Linux, so add it to the list
of dependencies to install before building.

Change-Id: Iae590153f54327711081f9e81538dae4b2ef3f71
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-21 10:47:55 -07:00

2.0 KiB
Raw Blame History

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
  • libaio-devel

Ubuntu/Debian:

  • 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-2.2.0.tar.gz
3) tar xfz dpdk-2.2.0.tar.gz
4) cd dpdk-2.2.0

Linux:

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

FreeBSD:

5) 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-2.2.0/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-2.2.0/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 scripts to automate this process on both Linux and FreeBSD.

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