737b1b571b
This will allow a git clone to default to an SPDK-specific version of the DPDK repository. Users can still override to use a separate DPDK repository/installation with the --with-dpdk configure script options. While here, remove gzip option for the git-archive operations in autopackage.sh. We need to add a git-archive for the DPDK submodule if we are using it, and compressing at -9 adds a lot of unnecessary time. Since we are not archiving these packages, there is no need to compress them. Also explicitly disable coverage and ubsan for the autopackage build, since this build is only to test compilation and is not actually used for any test execution. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I3cf8a2ed984003a175cdece6542636ede8cb2479
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:
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 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:
sudo pkg install gmake cunit openssl
Additionally, DPDK is required. The SPDK repository includes a suitable version of DPDK as a submodule. Newer versions of git will automatically fetch the DPDK submodule. Older versions of git may require:
1) git submodule init
2) git submodule update
Building
Once the prerequisites are installed, building follows the common configure and make pattern. If you followed the instructions above for building DPDK:
Linux:
./configure --with-dpdk=./dpdk/x86_64-native-linuxapp-gcc
make
FreeBSD:
./configure --with-dpdk=./dpdk/x86_64-native-bsdapp-clang
gmake
Vagrant
A Vagrant setup is also provided to create a Linux VM with a virtual NVMe controller to get up and running quickly. Currently this has only been tested on MacOS with the VirtualBox provider. The VirtualBox Extension Pack must also be installed for NVMe support.
If you are behind a corporate firewall, set http_proxy and https_proxy in your environment before running the following steps.
1) vagrant up
2) vagrant ssh
3) cd /spdk
4) sudo examples/nvme/hello_world/hello_world
Additional details on the Vagrant setup can be found in scripts/vagrant/README.md.
Advanced Build Options
Optional components and other build-time configuration are controlled by
settings in two Makefile fragments in the root of the repository. CONFIG
contains the base settings. Running the configure script generates a new
file, CONFIG.local, that contains overrides to the base CONFIG file. For
advanced configuration, there are a number of additional options to configure
that may be used, or CONFIG.local can simply be created and edited by hand. A
description of all possible options is located in CONFIG.
Boolean (on/off) options are configured with a 'y' (yes) or 'n' (no). For
example, this line of CONFIG controls whether the optional RDMA (libibverbs)
support is enabled:
CONFIG_RDMA?=n
To enable RDMA, this line may be added to CONFIG.local with a 'y' instead of
'n'. For the majority of options this can be done using the configure script.
For example:
./configure --with-dpdk=./dpdk/x86_64-native-linuxapp-gcc --with-rdma
Additionally, CONFIG options may also be overrriden on the make command
line:
make CONFIG_RDMA=y
Users may wish to use a version of DPDK different from the submodule included in the SPDK repository. To specify an alternate DPDK installation, run configure with the --with-dpdk option. For example:
Linux:
./configure --with-dpdk=/path/to/dpdk/x86_64-native-linuxapp-gcc
make
FreeBSD:
./configure --with-dpdk=/path/to/dpdk/x86_64-native-bsdapp-clang
gmake
The options specified on the make command line take precedence over the
default values in CONFIG and CONFIG.local. This can be useful if you, for
example, generate a CONFIG.local using the configure script and then have
one or two options (i.e. debug builds) that you wish to turn on and off
frequently.
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.