d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk
1,176 Commits 24 Branches 51 Tags 318 MiB
C 82.7%
Shell 7.4%
Python 4.8%
Makefile 4.7%
C++ 0.3%
e912a90f77
Go to file
Daniel Verkamp e912a90f77 env: pass PCI address when claiming devices 
The PCI device claim function does not need the whole spdk_pci_device
structure, just the address.

Change-Id: If59df512043ee062cf9f759bdc104fc522625ba8
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-11-01 10:07:30 -07:00
app nvmf: only save PCI address in direct ctrlr data 2016-11-01 09:40:36 -07:00
doc doc: remove link to nvme_driver_integration page 2016-11-01 09:43:32 -07:00
etc/spdk iscsi: fix comment issue. If not specified reactor mask , we only use core 0. (#48) 2016-10-20 09:37:05 -07:00
examples nvme_manage: use spdk_pci_addr_compare() 2016-11-01 09:40:36 -07:00
include/spdk env: pass PCI address when claiming devices 2016-11-01 10:07:30 -07:00
lib env: pass PCI address when claiming devices 2016-11-01 10:07:30 -07:00
mk nvme: move I/O qpair allocation to transport 2016-10-19 08:09:45 -07:00
scripts bdev/rbd: use consistent block_size name in RPC 2016-10-31 13:48:27 -07:00
test env: add struct spdk_pci_id and getter function 2016-11-01 09:40:36 -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 rbd: Enable rbd compilation in automation test 2016-10-14 14:04:15 -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: Clearly denote start/end test in log 2016-10-24 09:10:39 -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 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.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.