Storage Performance Development Kit
C Shell Python Makefile C++ Perl Other
Clone or download
optimistyzy and changpe1 bdev/aio: Add the epoll support
This patch is used to add the epoll suport and make
the group polling more efficient.

Change-Id: I93416514a53dc45471e375b39aa051e6500de412
Signed-off-by: Ziye Yang <optimistyzy@gmail.com>
Reviewed-on: https://review.gerrithub.io/421432
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: GangCao <gang.cao@intel.com>
Latest commit 6ff8f60 Aug 10, 2018
Permalink
Failed to load latest commit information.
.githooks test: use SKIP_DPDK_BUILD in pre-push githook Jul 14, 2018
app app: allow full-name command line options Aug 13, 2018
build/lib build: consolidate library outputs in build/lib Nov 17, 2016
doc doc: Update concurrency doc with new name for thread.h Aug 8, 2018
dpdk @ c860b29 dpdk: move submodule to latest from dpdk fork Aug 7, 2018
dpdkbuild build: add intel-ipsec-mb submodule Jul 19, 2018
etc/spdk bdev/nvme: Add set_bdev_nvme_options Jul 26, 2018
examples app: allow full-name command line options Aug 13, 2018
go go: empty Go package Jun 28, 2018
include nvmf: Queue pairs can no longer be removed from poll groups Aug 13, 2018
intel-ipsec-mb @ 134c90c ipsec: update submodule commit Jul 26, 2018
lib bdev/aio: Add the epoll support Aug 14, 2018
mk log: add backtrace option Jul 25, 2018
scripts setup.sh: cleanup bdevtest /dev/shm entries Aug 13, 2018
shared_lib shared_lib: add libspdk_thread to libspdk.so Jun 28, 2018
test test/nvmf: remove nested lvol test for nvmf Aug 14, 2018
.astylerc astyle: change "add-braces" to "j" for compatibility Dec 14, 2017
.gitignore shared_lib: only export spdk_* symbols Jun 19, 2018
.gitmodules build: add intel-ipsec-mb submodule Jul 19, 2018
.travis.yml .travis.yml: tweak IRC notification Mar 16, 2018
CHANGELOG.md version: 18.10 pre Aug 3, 2018
CONFIG log: add backtrace option Jul 25, 2018
CONTRIBUTING.md Add CONTRIBUTING.md Sep 5, 2017
ISSUE_TEMPLATE.md github: Add issue tracker template Apr 19, 2018
LICENSE Remove year from copyright headers. Jan 28, 2016
Makefile env: Don't build DPDK if the user specifies an alternate env Jul 20, 2018
README.md test/unit: move unittest.sh and dependencies here. Mar 13, 2018
autobuild.sh autobuild.sh: don't check for untracked files in submodules Jul 26, 2018
autopackage.sh autobuild.sh: don't check for untracked files in submodules Jul 26, 2018
autorun.sh autorun: make config setup common to all scripts May 3, 2017
autorun_post.py autorun_post: save aggregated test completion list to file Apr 3, 2018
autotest.sh test/lvol: add tasting with different lvol store cluster sizes Aug 13, 2018
configure configure: validate log backtrace level Aug 10, 2018

README.md

Storage Performance Development Kit

Build Status

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

Doxygen API documentation is available, as well as a Porting Guide for porting SPDK to different frameworks and operating systems.

Source Code

git clone https://github.com/spdk/spdk
cd spdk
git submodule update --init

Prerequisites

The dependencies can be installed automatically by scripts/pkgdep.sh.

./scripts/pkgdep.sh

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

./test/unit/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 the SPDK Vagrant documentation.

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

Users may wish to configure a specific memory size. Below is an example of configuring 8192MB memory.

sudo HUGEMEM=8192 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