numam-spdk
Go to file
Michal Berger 6b8f9a0f81 test/bdev: Convert setup_rbd_conf() to RPC calls
Change-Id: Icfbb571d1cd2a2539cd9026f1437c75450b77512
Signed-off-by: Michal Berger <michalx.berger@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/1022
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
2020-03-31 07:55:58 +00:00
.githooks githooks: limit the number of threads for pre-push hook 2019-08-07 12:30:38 +00:00
app global: rename copy to accel 2020-02-18 08:05:34 +00:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc lib/event: Add elapsed time of thread to output of framework_get_reactors RPC 2020-03-25 07:52:53 +00:00
dpdk@76f9669b1f dpdk: include minor rte_vhost fix 2020-03-23 09:37:35 +00:00
dpdkbuild dpdkbuild: build and link with rte_hash if RAID5 is built 2020-03-18 08:02:43 +00:00
etc/spdk nvmf/tcp: Add the sock priority setting in conf file. 2020-01-07 12:20:20 +00:00
examples make: don't link vpp into fio plugins. 2020-03-26 08:12:04 +00:00
go go: empty Go package 2018-06-28 18:15:51 +00:00
include nvme: add SGL dword alignment requirement flag when SGL is supported 2020-03-25 07:54:40 +00:00
intel-ipsec-mb@489ec6082a ipsec: move to version 0.52 2019-04-24 22:49:11 +00:00
ipsecbuild Makefile: don't override MAKEFLAGS in submake 2020-02-21 09:33:45 +00:00
isa-l@f3993f5c0b spdk: Upgrade isa-l to add support for aarch64 2019-11-04 12:26:00 +00:00
isalbuild Makefile: don't override MAKEFLAGS in submake 2020-02-21 09:33:45 +00:00
lib nvme: fix issue with io queue size 2020-03-26 13:13:45 +00:00
mk make: don't link vpp into fio plugins. 2020-03-26 08:12:04 +00:00
module lib/event: Add elapsed time of thread to output of framework_get_reactors RPC 2020-03-25 07:52:53 +00:00
ocf@6fb1a697a4 lib/bdev/ocf: update of ocf library to version 19.06 2019-10-22 17:22:41 +00:00
pkg spdk.spec: fix typo 2020-03-12 09:02:50 +00:00
scripts test/bdev: Convert setup_rbd_conf() to RPC calls 2020-03-31 07:55:58 +00:00
shared_lib make: rev SO versions individually for libraries. 2020-03-18 08:02:30 +00:00
test test/bdev: Convert setup_rbd_conf() to RPC calls 2020-03-31 07:55:58 +00:00
.astylerc astyle: change "add-braces" to "j" for compatibility 2017-12-13 21:23:27 -05:00
.gitignore configure: Dump build CONFIG to sourceable file 2020-03-17 14:44:20 +00:00
.gitmodules ocf: add ocf submodule 2019-02-27 17:26:51 +00:00
autobuild.sh test/build: add test directory to scanbuild verification 2020-03-11 11:34:55 +00:00
autopackage.sh test: fix SC2103 errors on older shellcheck. 2019-11-18 13:06:49 +00:00
autorun_post.py autorun_post: skip confirming executed tests 2020-01-31 12:36:29 +00:00
autorun.sh test: Run autotest.sh with sudo -E 2019-07-03 04:15:18 +00:00
autotest.sh test/bdev: Split crypto test and convert it to RPC calls 2020-03-31 07:55:58 +00:00
CHANGELOG.md lib/util: Add spdk_sn32_lt/gt() to compare two numbers based on serial number arithmetic 2020-03-19 08:51:31 +00:00
CONFIG build: add option to disable building unit tests 2020-03-10 09:12:21 +00:00
configure sock/uring: Add the async network I/O support for socket 2020-03-20 08:41:28 +00:00
CONTRIBUTING.md Add CONTRIBUTING.md 2017-09-05 13:25:45 -04:00
ISSUE_TEMPLATE.md Fix Markdown MD022 linter warnings - headers blank lines 2020-02-17 10:07:21 +00:00
LICENSE Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile build: add option to disable building unit tests 2020-03-10 09:12:21 +00:00
README.md Update Vagrant section in README.md 2020-03-16 08:45:42 +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. The scripts/pkgdep.sh script will automatically install the bare minimum dependencies required to build SPDK. Use --help to see information on installing dependencies for optional components

./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 been tested on MacOS, Ubuntu 16.04.2 LTS and Ubuntu 18.04.3 LTS with the VirtualBox and Libvirt provider. The VirtualBox Extension Pack or [Vagrant Libvirt] (https://github.com/vagrant-libvirt/vagrant-libvirt) 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.

AWS

The following setup is known to work on AWS: Image: Ubuntu 18.04 Before running setup.sh, run modprobe vfio-pci then: DRIVER_OVERRIDE=vfio-pci ./setup.sh

Advanced Build Options

Optional components and other build-time configuration are controlled by settings in the Makefile configuration file in the root of the repository. CONFIG contains the base settings for the configure script. This script generates a new file, mk/config.mk, that contains final build settings. For advanced configuration, there are a number of additional options to configure that may be used, or mk/config.mk 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 mk/config.mk 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 values in mk/config.mk. This can be useful if you, for example, generate a mk/config.mk using the configure script and then have one or two options (i.e. debug builds) that you wish to turn on and off frequently.

Shared libraries

By default, the build of the SPDK yields static libraries against which the SPDK applications and examples are linked. Configure option --with-shared provides the ability to produce SPDK shared libraries, in addition to the default static ones. Use of this flag also results in the SPDK executables linked to the shared versions of libraries. SPDK shared libraries by default, are located in ./build/lib. This includes the single SPDK shared lib encompassing all of the SPDK static libs (libspdk.so) as well as individual SPDK shared libs corresponding to each of the SPDK static ones.

In order to start a SPDK app linked with SPDK shared libraries, make sure to do the following steps:

  • run ldconfig specifying the directory containing SPDK shared libraries
  • provide proper LD_LIBRARY_PATH

Linux:

./configure --with-shared
make
ldconfig -v -n ./build/lib
LD_LIBRARY_PATH=./build/lib/ ./app/spdk_tgt/spdk_tgt

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