d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
1,077 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
0c8a5d8ce6
Go to file
Daniel Verkamp 0c8a5d8ce6 nvmf/rpc: rename listen_addrs -> listen_addresses 
Change the output of get_nvmf_subsystems to be consistent with
construct_nvmf_subsystem.

Change-Id: I6987f6cbd916a870e9b15f0faa3cce2ed6d49795
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-10-13 08:50:03 -07:00
app nvmf/rpc: rename listen_addrs -> listen_addresses 2016-10-13 08:50:03 -07:00
doc nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -07:00
etc/spdk eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
examples env: Remove unused DPDK headers. 2016-10-12 09:53:32 -07:00
include/spdk env: Eliminate remaining usage of rte_memzone 2016-10-12 09:53:32 -07:00
lib nvme: fix sgl processing for single sge payloads > 4KB 2016-10-12 14:51:58 -07:00
mk nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -07:00
scripts eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
test nvme: fix sgl processing for single sge payloads > 4KB 2016-10-12 14:51:58 -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 travis: install specific linux-headers version 2016-10-10 09:49:54 -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 eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
autotest.sh test: add new ext4test 2016-10-12 14:49:49 -07:00
CHANGELOG.md changelog: deallocate to dataset management change 2016-10-06 08:58:37 -07:00
CONFIG nvme: Eliminate nvme_impl.h and use the swappable env lib. 2016-10-11 13:34:09 -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 eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
README.md Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
unittest.sh travis: install DPDK and other dependencies 2016-10-07 15:34:18 -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.