d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
1,482 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
c00bce397d
Go to file
Ben Walker c00bce397d nvme: Move nvme_hotplug_monitor up in the file 
Avoid having to forward declare.

Change-Id: Ib1e5629f855fa70ba77247972823a8418a5fc7a9
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-19 11:22:53 -07:00
app nvme: Remove probe_info, just use transport_id 2016-12-12 10:49:17 -07:00
build/lib build: consolidate library outputs in build/lib 2016-11-17 13:15:09 -07:00
doc doc: update link to renamed deallocate function 2016-12-08 10:01:08 -07:00
etc/spdk rpc: allow listening on a Unix socket 2016-12-15 08:06:33 -07:00
examples test/nvme/hotplug: print an error if counts mismatch 2016-12-15 16:29:34 -07:00
include likely.h: fix spdk_likely condition 2016-12-15 13:01:08 -07:00
lib nvme: Move nvme_hotplug_monitor up in the file 2016-12-19 11:22:53 -07:00
mk test/nvme: don't link unit tests against spdk_nvme 2016-12-08 14:19:25 -07:00
scripts scripts/rpc.py: add Unix socket support 2016-12-15 08:06:33 -07:00
test nvme: add offset to spdk_nvme_ctrlr_cmd_get_log_page() 2016-12-15 11:16:14 -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 readme, travis: update to DPDK 16.11 2016-11-15 11:14:32 -07:00
autobuild.sh autobuild: log current git version and date 2016-12-16 10:27:28 -07:00
autopackage.sh autopackage: enable -Werror in release build 2016-11-17 10:29:11 -07:00
autorun.sh eofnl: check for extra trailing newlines 2016-10-11 13:30:33 -07:00
autotest.sh test: Add autotest for hotplug. 2016-12-14 15:04:33 -07:00
CHANGELOG.md changelog: add bdev changes and NVMe multi-process 2016-12-14 15:09:01 -07:00
CONFIG config: add option to turn on UBSan 2016-12-06 11:17:33 -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 env: rename default implementation to env_dpdk 2016-11-14 08:48:20 -07:00
README.md readme, travis: update to DPDK 16.11 2016-11-15 11:14:32 -07:00
unittest.sh scsi: translate nvme error to scsi error (#54) 2016-10-28 13:06:45 -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.11.tar.xz
3) tar xf dpdk-16.11.tar.xz

Linux:

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

FreeBSD:

4) (cd dpdk-16.11 && 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.11/x86_64-native-linuxapp-gcc

FreeBSD:

gmake DPDK_DIR=./dpdk-16.11/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.