Commit Graph

52 Commits

Author SHA1 Message Date
Seth Howell
12e840b937 test/unit: move unittest.sh and dependencies here.
All files called directly by the unittest.sh script are now located in
the test/unit directory.

Change-Id: I95cfb3d5b7c6ede59d7183c39466f32b7e676643
Signed-off-by: Seth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/401717
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-03-13 18:44:34 -04:00
GangCao
b41a99f2b0 doc: add the example to configure different memory size
A new parameter HUGEMEM added to configure the memory usage

Change-Id: I2ad536520b0855e5b6ae36f5c63ace8a52705ac5
Signed-off-by: GangCao <gang.cao@intel.com>
Reviewed-on: https://review.gerrithub.io/385366
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2017-11-14 12:47:25 -05:00
Dariusz Stojaczyk
71ea826507 bdev_virtio: added doc page
Change-Id: Ia88ae52117068ac395dad9ad3d7ac818e41077fb
Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/380956
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-10-20 19:44:23 -04:00
Hailiang Wang
93533c2002 script: add pkgdep.sh to install dependencies automatically.
Change-Id: I7447a28fa8ecd8395a85b66952d19aa25683876c
Signed-off-by: Hailiang Wang <hailiangx.e.wang@intel.com>
Reviewed-on: https://review.gerrithub.io/374946
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-09-07 13:48:29 -04:00
Paul Luse
27d89d64e1 doc: fix incorrect package name in readme
Change-Id: If8bdcadbeb21ab76a65799236bb5c1b9982c0a83
Signed-off-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-on: https://review.gerrithub.io/376895
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-09-06 16:03:26 -04:00
Ben Walker
de191b8fb1 doc: Move vagrant documentation to main doc/ page
This makes it easier to find from the main landing page.

Change-Id: Ic142427cede869c9cbfc6c265c8e4625731f8ce1
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/376232
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-31 17:15:52 -04:00
Jim Harris
bfb1ddba7a README: clarify RDMA package dependencies
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I55b8de444169718bcb1197e1a8afbdfc9d2e5234

Reviewed-on: https://review.gerrithub.io/374498
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-08-16 16:13:29 -04:00
Paul Luse
870ce250f1 doc: update root README.md
First in a series of doc updates. Add in-page links for sections
and various updates to each section for clarity. Note that this
readme is focused on getting the code and running unit tests
but includes some other basic info also. The last section links
to spdk.io where the developer page is the home for details on
contributing.

Change-Id: Ibbe5a070488cf295c1decd1a8b72b23fd140e942
Signed-off-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-on: https://review.gerrithub.io/362847
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2017-07-05 16:36:32 -04:00
Paul Luse
fadfd84920 vagrant: minor tweaks
Update readme files and startup scripts

Change-Id: Ia42269d04db9e9338f6adcaaae0d0d44c18e0e5c
Signed-off-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-on: https://review.gerrithub.io/362257
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2017-05-25 13:52:25 -04:00
Paul Luse
b499ae64ad doc: update readme
Clarrifications for DPDK submodule

Change-Id: I7374c1f904f1c5c46c46c299af72816d96a770ff
Signed-off-by: Paul Luse <paul.e.luse@intel.com>
2017-05-17 13:42:32 -07:00
Jim Harris
737b1b571b build: add dpdk as a submodule
This will allow a git clone to default to an SPDK-specific
version of the DPDK repository.  Users can still override
to use a separate DPDK repository/installation with the
--with-dpdk configure script options.

While here, remove gzip option for the git-archive operations
in autopackage.sh.  We need to add a git-archive for the DPDK
submodule if we are using it, and compressing at -9 adds a lot
of unnecessary time.  Since we are not archiving these packages,
there is no need to compress them.  Also explicitly disable
coverage and ubsan for the autopackage build, since this build
is only to test compilation and is not actually used for any
test execution.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I3cf8a2ed984003a175cdece6542636ede8cb2479
2017-05-17 09:49:27 -07:00
Jim Harris
11fa540377 scripts: add a vagrant setup
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I074c779d1736733b6864dfbcab529151e01fa4b7
2017-05-02 17:51:50 -07:00
Jim Harris
a160dfdf80 README.md: update dpdk instructions to remove version from dir name
Having a consistent name for the location of the dpdk directory
makes it easier to write other scripts or documentation.  So change
the README so that instead of 'dpdk-17.02' the directory will just
be named 'dpdk'.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ie03e91712a7acb52a1d076f285504df845f81209
2017-05-02 15:16:37 -07:00
Ben Walker
9dd998cdc0 Add a configure script to generate the CONFIG file
Add a configure script in the root of the repository
that looks and feels like one that would be generated
by autotools. This script simply generates a CONFIG
file for you, which used to be done by hand.

Now to build SPDK you can do the following:

./configure --with-dpdk=path
make

Change-Id: I44ebb91f0cb1468b86da4c0033ac1406595d4967
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-04-03 13:30:12 -07:00
Daniel Verkamp
509fedf011 doc: link to vhost docs from readme and changelog
Change-Id: Ia12de190c5b6c42d1a52dafc5fbab9de93913037
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-03-29 21:40:11 -07:00
Seth Howell
1fe17d0a2a README.md: added command line for installing dependencies on FreeBSD.
Change-Id: I9dcae817d61f90e233d7dd6416b6c30e540dcf9b
Signed-off-by: Seth Howell <seth.howell@intel.com>
2017-03-15 10:36:42 -07:00
Daniel Verkamp
1d07ccc6ae readme: drop redundant 'make' command example
Change-Id: I5e4750a0305cd619d58c552d3937e50b017d8f49
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-02-22 17:57:48 -07:00
Daniel Verkamp
77e6598dcb readme: update instructions to use DPDK 17.02
Change-Id: I2acefeaa22871d860fd546a792cfbe498c2dfda1
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-02-16 10:01:08 -07:00
Daniel Verkamp
8f0aed2dd3 readme: add a section about CONFIG
Change-Id: I5a6cd28ee9a3b37921355af46dafdd0f4b606c1a
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-24 15:43:20 -07:00
Daniel Verkamp
93ab7c31e4 doc: move porting guide into doc/ and add to index
This moves all the documentation under the doc/ tree for consistency.

Replace the link to include/spdk/env.h to raw text - the Doxygen
Markdown parser will automatically turn it into a link since it is a
Doxygen input file.

Change-Id: If6bde1cfc965cada2c741acd5505026545ad4cf7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-17 16:25:04 -07:00
Daniel Verkamp
a3658ab042 Change doc link to new spdk.io/doc location
Also make sure all links point to the canonical www.spdk.io, not
spdk.io, to avoid extra redirects.

Change-Id: I5696abf8569c36f9be741bc932e320d8b7156875
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-12-19 15:57:12 -07:00
Daniel Verkamp
ad8f708667 readme, travis: update to DPDK 16.11
Change-Id: I41b8dc302884b7a231a1caffe7f82ada8527ac11
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-11-15 11:14:32 -07:00
Ben Walker
6b1e4e732d Drop libpciaccess and switch to DPDK PCI
This patch also drops support for automatically unbinding
devices from the kernel - run scripts/setup.sh first.

Our generic pci interface is now hidden behind include/spdk/pci.h
and implemented in lib/util/pci.c. We no longer wrap the calls
in nvme_impl.h or ioat_impl.h. The implementation now only uses
DPDK and the libpciaccess dependency has been removed. If using
a version of DPDK earlier than 16.07, enumerating devices
by class code isn't available and only Intel SSDs will be
discovered. DPDK 16.07 adds enumeration by class code and all
NVMe devices will be correctly discovered.

Change-Id: I0e8bac36b5ca57df604a2b310c47342c67dc9f3c
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-10-04 15:59:00 -07:00
Daniel Verkamp
326a0224b2 readme: convert list of features into doc links
Change-Id: I01fa93ca51576c5b356fc2193f81e210ef411908
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-09-28 08:20:09 -07:00
Changpeng Liu
9d9dc0389f iscsi: add document description about iSCSI target
Change-Id: Iaba08f45461643cbb231d50580788d24ea34a431
Signed-off-by: Changpeng Liu <changpeng.liu@intel.com>
2016-09-02 09:21:58 -07:00
Daniel Verkamp
c3162ca0fb readme: add C++ compiler to dependency list
A C++ compiler is required to build the trace app. Add it to the list of
packages to install.

Change-Id: Ia30a42721d10a07a1b7949a815eb5616f575d878
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-08-16 15:44:12 -07:00
Daniel Verkamp
0fc7daffe5 Replace "NVMf" with "NVMe over Fabrics" in docs
Use the final official spec name rather than a non-standard
abbreviation.

Change-Id: I4d797294be35b2fbf7b39570ea3246eb71c8d8ce
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-08-08 16:35:11 -07:00
Ben Walker
d29384bf97 iscsi: Add an iscsi library.
Change-Id: I28f3f4723a66f845eb478a6873d7aedb8f5409b8
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-08-03 14:43:40 -07:00
Daniel Verkamp
8779605323 readme: update to DPDK 16.07
Change-Id: I928721f1908de6695c7f2bf05ea2ca032b59d29c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-08-01 10:33:56 -07:00
Ben Walker
988e88c82a docs: Update README.md to reflect NVMf target
Change-Id: Iadf635cb018baa1cfbd56fc11714a662aa8c9c3c
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-06-08 16:18:56 -07:00
Daniel Verkamp
4de0491a1b readme: add NVMf dependencies
Change-Id: I013a466089b48459f3bff3b9fc1b7e966efa6f3c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-06-07 10:16:08 -07:00
Daniel Verkamp
a60b63ad65 README: update to DPDK 16.04
Change-Id: Ic969a1d3362bb132eb6d4e5f032ebb6e71d3cee0
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-05-11 10:50:55 -07:00
Ben Walker
f92c0daa53 Update doxygen link in README.md
Change-Id: I5b1cd8d48bf62279710ce7b80bd3c398e532c628
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-05-06 15:28:23 -07:00
Daniel Verkamp
c83f9378da scripts: merge hugepage config into setup.sh
For now, drop the option to configure the number of hugepages (just use
the default 1024).

Change-Id: I686b6151e4a32ffa4ae9a9cf2694693369e03f49
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-04-14 13:36:44 -07:00
Ben Walker
badade1eed Update the README to point users at the examples.
This is very minimal and needs to be expanded, but
at least point the users at the examples as the next
place to go.

Change-Id: I74025f7addb994f97d01accb89d2e9bc870740bf
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-03-11 10:23:03 -07:00
Ben Walker
add1515c86 Clarifications to README.md
* List the components in the development kit
* Mention the examples directory
* Add installation commands for dependencies

Change-Id: I31302b3cd2e5df4f24b8da30af66f9f1daa11eaa
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-03-11 10:08:16 -07:00
Daniel Verkamp
04cde460cf Add a changelog
Import the release notes from previous releases and fill out the major
features for the next release.

Change-Id: I5050d6cc83a92fac4f1dbed5f7ef039cca208765
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-03-09 07:25:09 -07:00
Ben Walker
03a0af30c8 Add the mailing list to README.md.
Change-Id: Iac2c600095042c86a51bad28038bc4b6c2f31ed2
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-26 15:50:59 -07:00
Ben Walker
89ce43646f Add gitter link to README.md
Change-Id: I1f5858ddacdee9cc182aae627454bc146f44fa1d
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-26 14:36:53 -07:00
Daniel Verkamp
add9186f73 README: cd to DPDK dir in a subshell
Tweak the build instructions slightly to make them simpler to follow.

If someone is reading the instructions top to bottom, the section about
how to build SPDK assumes the current directory is the top-level SPDK
repository, but if the reader just finished building DPDK, they would be
in the DPDK directory.

Change-Id: Ie3dd587bcf1ac41ac3579a75f9b329b0eeaafd7a
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-02-23 12:24:52 -07:00
Ben Walker
55dc5f2131 Add vfio support to scripts.
cleanup.sh and unbind.sh have been combined into a single
setup.sh that takes one optional parameter (reset). If no
parameter is given, the script will automatically bind
all NVMe and IOAT devices to either uio_pci_generic
or vfio-pci, as appropriate based on IOMMU settings. If
the reset parameter is given, the devices will be bound back
to the appropriate kernel drivers.

Change-Id: I25db3234f1ecfb352a281e5093f4c1aa455152ae
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-02-22 11:30:47 -07:00
Daniel Verkamp
a7c6c3cc18 README: add libaio dependency
libaio is required by examples/nvme/perf on Linux, so add it to the list
of dependencies to install before building.

Change-Id: Iae590153f54327711081f9e81538dae4b2ef3f71
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-21 10:47:55 -07:00
Daniel Verkamp
b663d3c669 README: update to DPDK 2.2.0
DPDK's install target now requires DESTDIR to be set, so change the
build instructions to set DESTDIR=. to match previous behavior.

Change-Id: Ib697c2f54704210a5b60278ba1a5b20a16f517be
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-05 13:18:21 -07:00
Daniel Verkamp
d4ab30ba33 ioat: add user-mode Intel I/OAT driver
The ioat driver supports DMA engine copy offload hardware available on
Intel Xeon platforms.

Change-Id: Ida0b17b25816576948ddb1b0443587e0f09574d4
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-12-09 10:14:15 -07:00
Ben Walker
af2a731de3 build: Allow relative path for DPDK_DIR
This is very convenient. It also works from subdirectories, as
long as you adjust the relative path you pass appropriately.

Change-Id: I8cfeac380ccb5fad4389ee1feb838f986a837f11
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2015-12-07 14:08:28 -07:00
Daniel Verkamp
4d7b500ade README: add link to Doxygen API docs
Change-Id: I0b91e14ccce642079537abc09d92682ee5598c2d
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-11-04 15:07:46 -07:00
Daniel Verkamp
f04508a30c README: add Travis CI build status image
Change-Id: I2555c069bc9f0847636dc662639ad13e589a28f2
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2015-11-04 14:39:38 -07:00
Jim Harris
f0649be5a0 Add porting guide.
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ic028d9d776b094fc2fa048c23424aec2c8434cc6
2015-09-28 09:07:19 -07:00
Jim Harris
4ac57251d5 README.md: add build instructions for FreeBSD
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I4500366475ffbaa9c91ea62a07522c2f82a9a372
2015-09-25 12:45:04 -07:00
Jim Harris
5e95ec6f47 README.md: add more detailed quick start instructions
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I267f27edb8797c794dc732334b557f44dc677015
2015-09-24 09:59:56 -07:00