870ce250f1
First in a series of doc updates. Add in-page links for sections and various updates to each section for clarity. Note that this readme is focused on getting the code and running unit tests but includes some other basic info also. The last section links to spdk.io where the developer page is the home for details on contributing. Change-Id: Ibbe5a070488cf295c1decd1a8b72b23fd140e942 Signed-off-by: Paul Luse <paul.e.luse@intel.com> Reviewed-on: https://review.gerrithub.io/362847 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com>
6.4 KiB
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:
In this readme:
- Documentation
- Prerequisites
- Source Code
- Build
- Unit Tests
- Vagrant
- Advanced Build Options
- Hugepages and Device Binding
- Example Code
- Contributing
Documentation
Doxygen API documentation is available, as well as a Porting Guide for porting SPDK to different frameworks and operating systems.
Prerequisites
Note: The requirements for building the docs can take a while to install so you may want to skip them unless you need them.
Fedora/CentOS:
sudo dnf install -y gcc gcc-c++ make CUnit-devel libaio-devel openssl-devel \
git astyle-devel python-pep8 lcov python clang-analyzer
# Additional dependencies for NVMe over Fabrics
sudo dnf install -y libibverbs-devel librdmacm-devel
# Additional dependencies for building docs
sudo dnf install -y doxygen mscgen
Ubuntu/Debian:
sudo apt-get install -y gcc g++ make libcunit1-dev libaio-dev libssl-dev \
git astyle pep8 lcov clang
# Additional dependencies for NVMe over Fabrics
sudo apt-get install -y libibverbs-dev librdmacm
# Additional dependencies for building docs
sudo apt-get install -y doxygen mscgen
FreeBSD:
sudo pkg install gmake cunit openssl git devel/astyle bash devel/pep8 \
python
# Additional dependencies for building docs
sudo pkg install doxygen mscgen
Source Code
git clone https://github.com/spdk/spdk
cd spdk
git submodule update --init
Build
Linux:
./configure
make
FreeBSD: Note: Make sure you have the matching kernel source in /usr/src/ and also note that CONFIG_COVERAGE option is not available right now for FreeBSD builds.
./configure
gmake
Unit Tests
./unittest.sh
You will see several error messages when running the unit tests, but they are part of the test suite. The final message at the end of the script indicates success or failure.
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 and Ubuntu 16.04.2 LTS with the VirtualBox provider. The VirtualBox Extension Pack must also be installed in order to get the required NVMe support.
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-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
Example Code
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.
Contributing
For additional details on how to get more involved in the community, including contributing code and participating in discussions and other activiites, please refer to spdk.io