d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
1,034 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
46b7d49af0
Go to file
Krzysztof Jakimiak 46b7d49af0 spdk: add iov buffers to struct spdk_scsi_task 
Preparation for SGL support (readv/writev).

Change-Id: I14a116d764ebc582ea0a0077cc5a0d0bac638cb0
Signed-off-by: Krzysztof Jakimiak <krzysztof.jakimiak@intel.com>
2016-10-05 09:40:13 -07:00
app Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
doc Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
etc/spdk Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
examples Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
include/spdk spdk: add iov buffers to struct spdk_scsi_task 2016-10-05 09:40:13 -07:00
lib spdk: add iov buffers to struct spdk_scsi_task 2016-10-05 09:40:13 -07:00
mk Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
scripts Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
test Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -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 autotest: only delete partitions on NVMe namespaces 2016-10-04 12:20:44 -07:00
CHANGELOG.md Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
CONFIG Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -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 Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
README.md Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
unittest.sh Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -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++ 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++ make libcunit1-dev libaio-dev libssl-dev
# Additional dependencies for NVMe over Fabrics:
sudo apt-get install -y libibverbs-dev librdmacm-dev

FreeBSD:

  • gcc
  • 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.