0e93df5c34
Previously, we used cap_lo and cap_hi to represent the 32-bit halves of the full CAP register. However, it is simpler to keep them in a single 64-bit structure, and is no less efficient on 64-bit platforms. Also name the NSSRS field from NVMe 1.2, which was previously reserved. Change-Id: I1d5d9b0dccbb12373b4aed3db29c883881d43223 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Storage Performance Development Kit
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.
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.