numam-spdk
Go to file
Shuhei Matsumoto 46a3d50baa subsystem/nvmf: Add set_nvmf_target_options/config RPCs
Two new RPCs allocate and initialize options and conf dynamically.
Initialization of NVMf subsystem skips initialization of them
if they are already allocated.

To use and test them, add python script too.

Change-Id: I3be83c33edf9960cb4340d52abb47b7331a6fb92
Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-on: https://review.gerrithub.io/406932
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-06-12 17:41:29 +00:00
.githooks git: add .githooks to repository 2018-05-04 22:17:35 +00:00
app thread: Move threading abstraction code out of util 2018-06-12 15:24:07 +00:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc thread: Move threading abstraction code out of util 2018-06-12 15:24:07 +00:00
dpdk@b354dddee3 dpdk: update submodule to latest spdk-18.02 branch 2018-05-22 16:59:25 +00:00
dpdkbuild build: add 'make install' rule 2017-11-27 17:58:02 -05:00
etc/spdk vhost:Update the device config in vhost.conf.in 2018-05-03 19:46:59 +00:00
examples blob: add metadata dump capability 2018-06-12 16:36:04 +00:00
include nvme: add PI to spdk_nvme_ns_cmd_read/writev() 2018-06-12 17:40:32 +00:00
lib subsystem/nvmf: Add set_nvmf_target_options/config RPCs 2018-06-12 17:41:29 +00:00
mk thread: Move threading abstraction code out of util 2018-06-12 15:24:07 +00:00
scripts subsystem/nvmf: Add set_nvmf_target_options/config RPCs 2018-06-12 17:41:29 +00:00
test bdev/qos: add the bandwidth rate limit control 2018-06-12 16:38:14 +00:00
.astylerc astyle: change "add-braces" to "j" for compatibility 2017-12-13 21:23:27 -05:00
.gitignore Makefile: try harder to use correct Python interpreter 2018-01-30 15:44:10 -05:00
.gitmodules build: add dpdk as a submodule 2017-05-17 09:49:27 -07:00
.travis.yml .travis.yml: tweak IRC notification 2018-03-16 18:52:11 -04:00
autobuild.sh ioat: remove ioat kperf kernel driver test harness 2018-04-30 17:11:53 +00:00
autopackage.sh autotest_common.sh: move to test/common 2018-02-27 20:37:27 -05:00
autorun_post.py autorun_post: save aggregated test completion list to file 2018-04-03 15:12:50 -04:00
autorun.sh autorun: make config setup common to all scripts 2017-05-02 17:11:46 -07:00
autotest.sh test/vhost: remove config-ro Qemu option from config 2018-06-06 17:20:30 +00:00
CHANGELOG.md thread: Rename io_channel.h to thread.h 2018-06-12 15:24:07 +00:00
CONFIG bdev/pmem: change all NVML strings to PMDK 2018-04-07 00:07:57 -04:00
configure bdev/pmem: change all NVML strings to PMDK 2018-04-07 00:07:57 -04:00
CONTRIBUTING.md Add CONTRIBUTING.md 2017-09-05 13:25:45 -04:00
ISSUE_TEMPLATE.md github: Add issue tracker template 2018-04-19 13:50:08 -04:00
LICENSE Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile configure: add --disable-tests option 2018-03-12 13:50:34 -04:00
README.md test/unit: move unittest.sh and dependencies here. 2018-03-13 18:44:34 -04:00

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