numam-spdk
Go to file
Shuhei Matsumoto 6bc4a314ae bdev/raid: Update the comment of raid_bdev_add_base_bdevs()
Implementation was updated by the previous patch series but the
comment was not. Hence update the comment in this patch.

Change-Id: Ib2097561501984c4ad213652ba716ce195c7bea5
Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-on: https://review.gerrithub.io/424737
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Kunal Sablok <kunal.sablok@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2018-09-11 19:00:05 +00:00
.githooks test: use SKIP_DPDK_BUILD in pre-push githook 2018-07-14 02:20:30 +00:00
app iscsi, nvmf, vhost: remove default config file pathnames 2018-09-05 19:46:17 +00:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc bdev: remove get_bdevs_config RPC 2018-09-05 19:46:17 +00:00
dpdk@08332d13b3 dpdk: move submodule to latest commit 2018-09-10 23:33:23 +00:00
dpdkbuild dpdkbuild: always compile librte_kvargs 2018-08-15 17:43:30 +00:00
etc/spdk test/ioat: remove unnecessary config entires 2018-08-30 14:45:48 +00:00
examples fio_plugin: fix wrong block_size with PI 2018-09-10 16:26:00 +00:00
go go: empty Go package 2018-06-28 18:15:51 +00:00
include nvmf: Add function to get local addr for a qpair 2018-09-11 15:23:33 +00:00
intel-ipsec-mb@134c90c912 ipsec: update submodule commit 2018-07-26 22:29:25 +00:00
lib bdev/raid: Update the comment of raid_bdev_add_base_bdevs() 2018-09-11 19:00:05 +00:00
mk build: explicitly link unit tests with static libraries 2018-08-16 14:27:18 +00:00
scripts scripts: change shebang 2018-09-10 17:44:10 +00:00
shared_lib build: add quiet output for recently added shared lib build 2018-09-06 23:59:30 +00:00
test bdev/raid: Change construct_raid_bdev RPC to be consistent to other bdev modules 2018-09-11 19:00:05 +00:00
.astylerc astyle: change "add-braces" to "j" for compatibility 2017-12-13 21:23:27 -05:00
.gitignore shared_lib: Update shared lib build and install 2018-08-16 00:27:53 +00:00
.gitmodules build: add intel-ipsec-mb submodule 2018-07-19 00:06:55 +00:00
.travis.yml .travis.yml: tweak IRC notification 2018-03-16 18:52:11 -04:00
autobuild.sh autobuild: add shared object build to tests 2018-09-10 17:50:06 +00:00
autopackage.sh autopackage: add ipsec submodule to autopackage 2018-09-04 18:49:12 +00:00
autorun_post.py post_process: print coverage tables in a new directory 2018-08-21 22:11:11 +00:00
autorun.sh autorun: make config setup common to all scripts 2017-05-02 17:11:46 -07:00
autotest.sh test: refactor the run_test function to add detailed information 2018-08-15 17:24:01 +00:00
CHANGELOG.md build: remove DPDK_DIR 2018-09-07 16:01:28 +00:00
CONFIG build: remove DPDK_DIR 2018-09-07 16:01:28 +00:00
configure configure: fix typo and add exit on error 2018-08-28 23:01:28 +00: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 build: fix shared library dependencies 2018-09-06 23:59:30 +00:00
README.md doc: clarify alternate dpdk options 2018-09-07 20:25:54 +00: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 overridden 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. Note, this includes the ability to build not only from DPDK sources, but also just with the includes and libraries installed via the dpdk and dpdk-devel packages. 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 activities, please refer to spdk.io