d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
1,009 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
1ad2c3ea73
Go to file
Ben Walker 1ad2c3ea73 nvmf: Add support for multiple sessions per subsystem. 
This feature should only be used if clients are coordinating
with one another.

Change-Id: I89a437441a7e3fbcc1e5f6efa1c8e970ade7c2ec
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-09-29 11:04:15 -07:00
app nvme: move global request_mempool allocation into nvme_impl 2016-09-27 14:25:39 -07:00
doc iscsi: add document description about iSCSI target 2016-09-02 09:21:58 -07:00
etc/spdk nvmf: Add support for virtual controller. 2016-08-25 15:02:21 -07:00
examples ioat: Use log library instead of ioat_printf 2016-09-28 10:15:56 -07:00
include/spdk util: add context parameter for unique I/O channels 2016-09-28 07:53:47 -07:00
lib nvmf: Add support for multiple sessions per subsystem. 2016-09-29 11:04:15 -07:00
mk ioat: Use log library instead of ioat_printf 2016-09-28 10:15:56 -07:00
scripts nvmf: Add support for RPC interfaces. 2016-09-26 16:07:30 -07:00
test Fix some cppcheck errors on lib/iscsi & lib/scsi. (#41) 2016-09-28 13:55:56 -07:00
.astylerc build: check formatting with astyle 2015-09-23 09:05:51 -07:00
.gitignore gitignore: ignore .kdev4 (KDevelop) files 2016-07-12 09:08:01 -07:00
.travis.yml build: add Travis CI integration 2015-11-04 11:05:59 -07:00
autobuild.sh nvme: Add an fio plugin 2016-05-18 13:51:36 -07:00
autopackage.sh CONFIG: allow overriding options in make command 2015-10-22 12:24:57 -07:00
autorun.sh addition of autorun.sh script 2016-08-05 12:50:36 -07:00
autotest.sh test: Add calsoft test for iscsi target. 2016-09-27 08:13:07 -07:00
CHANGELOG.md Replace "NVMf" with "NVMe over Fabrics" in docs 2016-08-08 16:35:11 -07:00
CONFIG CONFIG: rename CONFIG_NVMF to CONFIG_RDMA 2016-07-14 12:58:17 -07:00
LICENSE Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile build: generate config.h and implicitly include it 2016-06-08 10:26:50 -07:00
PORTING.md Add porting guide. 2015-09-28 09:07:19 -07:00
README.md readme: convert list of features into doc links 2016-09-28 08:20:09 -07:00
unittest.sh unittest.sh: build log library earlier 2016-09-28 13:38:53 -07:00

README.md

Storage Performance Development Kit

Build Status

SPDK Mailing List

SPDK on 01.org

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:

Documentation

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

Many examples are available in the examples directory.

Changelog

Prerequisites

To build SPDK, some dependencies must be installed.

Fedora/CentOS:

sudo dnf install -y gcc gcc-c++ libpciaccess-devel CUnit-devel libaio-devel openssl-devel
# Additional dependencies for NVMe over Fabrics:
sudo dnf install -y libibverbs-devel librdmacm-devel

Ubuntu/Debian:

sudo apt-get install -y gcc g++ libpciaccess-dev make libcunit1-dev libaio-dev libssl-dev
# Additional dependencies for NVMe over Fabrics:
sudo apt-get install -y libibverbs-dev librdmacm-dev

FreeBSD:

  • gcc
  • libpciaccess
  • gmake
  • cunit
  • openssl

Additionally, DPDK is required.

1) cd /path/to/spdk
2) wget http://fast.dpdk.org/rel/dpdk-16.07.tar.xz
3) tar xf dpdk-16.07.tar.xz

Linux:

4) (cd dpdk-16.07 && make install T=x86_64-native-linuxapp-gcc DESTDIR=.)

FreeBSD:

4) (cd dpdk-16.07 && gmake install T=x86_64-native-bsdapp-clang DESTDIR=.)

Building

Once the prerequisites are installed, run 'make' within the SPDK directory to build the SPDK libraries and examples.

make DPDK_DIR=/path/to/dpdk

If you followed the instructions above for building DPDK:

Linux:

make DPDK_DIR=./dpdk-16.07/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-16.07/x86_64-native-bsdapp-clang

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

Examples

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.