numam-spdk
Go to file
Jim Harris d4d82fc3ab event: directly add poller when adding to current core
This is required since pollers are now directly removed
(rather than scheduling an event) when the unregister call
is made on the poller's lcore.

Without this change, if a poller is registered then
immediately unregistered, the unregistration will seg
fault since the event adding the poller has not executed
yet.

Also add a test case that exhibits the sequence of events
described in this commit message.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I5c6ba0ee224ac1f8f3ebb8e7571714e718bd42db
2016-10-11 15:35:36 -07:00
app env: Replace rte_malloc with spdk_zmalloc 2016-10-11 13:34:09 -07:00
doc nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -07:00
etc/spdk eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
examples Replace rte_get_tsc calls with spdk_get_ticks 2016-10-11 13:34:09 -07:00
include/spdk nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -07:00
lib event: directly add poller when adding to current core 2016-10-11 15:35:36 -07:00
mk nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -07:00
scripts eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
test event: directly add poller when adding to current core 2016-10-11 15:35:36 -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 travis: install specific linux-headers version 2016-10-10 09:49:54 -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
autorun.sh eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
autotest.sh memory: Rename to env 2016-10-05 09:49:35 -07:00
CHANGELOG.md changelog: deallocate to dataset management change 2016-10-06 08:58:37 -07:00
CONFIG nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -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 eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
README.md Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
unittest.sh travis: install DPDK and other dependencies 2016-10-07 15:34:18 -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.07.tar.xz
3) tar xf dpdk-16.07.tar.xz

Linux:

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

FreeBSD:

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

FreeBSD:

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