7fa9063148
There are multiple things wrong with current python tests: * they don't stop the execution on error * the output makes it difficult to understand what really happened inside the test * there is no easy way to reproduce a failure if there is one (besides running the same test script again) * they currently suffer from intermittent failures and there's no-one there to fix them * they stand out from the rest of spdk tests, which are written in bash So we rewrite those tests to bash. They will use rpc.py daemon to send RPC commands, so they won't take any more time to run than python tests. The tests are going to be split them into a few different categories: * clones * snapshots * thin provisioning * tasting * renaming * resizing * all the dumb ones - construct, destruct, etc Each file is a standalone test script, with common utility functions located in test/lvol/common.sh. Each file tests a single, specific feature, but under multiple conditions. Each test case is implemented as a separate function, so if you touch only one lvol feature, you can run only one test script, and if e.g. only a later test case notoriously breaks, you can comment out all the previous test case invocations (up to ~10 lines) and focus only on that failing one. The new tests don't correspond 1:1 to the old python ones - they now cover more. Whenever there was a negative test to check if creating lvs on inexistent bdev failed, we'll now also create a dummy bdev beforehand, so that lvs will have more opportunity to do something it should not. Some other test cases were squashed. A few negative tests required a lot of setup just to try doing something illegal and see if spdk crashed. We'll now do those illegal operations in a single test case, giving lvol lib more opportunity to break. Even if illegal operation did not cause any segfault, is the lvolstore/lvol still usable? E.g. if we try to create an lvol on an lvs that doesn't have enough free clusters and it fails as expected, will it be still possible to create a valid lvol afterwards? Besides sending various RPC commands and checking their return code, we'll also parse and compare various fields in JSON RPC output from get_lvol_stores or get_bdevs RPC. We'll use inline jq calls for that. Whenever something's off, it will be clear which RPC returned invalid values and what were the expected values even without having detailed error prints. The tests are designed to be as easy as possible to debug whenever something goes wrong. This patch removes one test case from python tests and adds a corresponding test into the new test/lvol/lvol2.sh file. The script will be renamed to just lvol.sh after the existing lvol.sh (which starts all python tests) is finally removed. As for the bash script itself - each test case is run through a run_test() function which verifies there were no lvolstores, lvols, or bdevs left after the test case has finished. Inside the particular tests we will still check if the lvolstore removal at the end was successful, but that's because we want to make sure it's gone e.g even before we remove the underlying lvs' base bdev. Change-Id: Iaa2bb656233e1c9f0c35093f190ac26c39e78623 Signed-off-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com> Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com> Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/459517 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Karol Latecki <karol.latecki@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com> |
||
|---|---|---|
| .githooks | ||
| app | ||
| build/lib | ||
| doc | ||
| dpdk@b5c9624957 | ||
| dpdkbuild | ||
| etc/spdk | ||
| examples | ||
| go | ||
| include | ||
| intel-ipsec-mb@489ec6082a | ||
| ipsecbuild | ||
| isa-l@f3993f5c0b | ||
| isalbuild | ||
| lib | ||
| mk | ||
| module | ||
| ocf@6fb1a697a4 | ||
| pkg | ||
| scripts | ||
| shared_lib | ||
| test | ||
| .astylerc | ||
| .gitignore | ||
| .gitmodules | ||
| autobuild.sh | ||
| autopackage.sh | ||
| autorun_post.py | ||
| autorun.sh | ||
| autotest.sh | ||
| CHANGELOG.md | ||
| CONFIG | ||
| configure | ||
| CONTRIBUTING.md | ||
| ISSUE_TEMPLATE.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
Storage Performance Development Kit
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:
- NVMe driver
- I/OAT (DMA engine) driver
- NVMe over Fabrics target
- iSCSI target
- vhost target
- Virtio-SCSI driver
In this readme:
- Documentation
- Prerequisites
- Source Code
- Build
- Unit Tests
- Vagrant
- Advanced Build Options
- Shared libraries
- Hugepages and Device Binding
- Example Code
- Contributing
Documentation
Doxygen API documentation is available, as well as a Porting Guide for porting SPDK to different frameworks and operating systems.
Source Code
git clone https://github.com/spdk/spdk
cd spdk
git submodule update --init
Prerequisites
The dependencies can be installed automatically by scripts/pkgdep.sh.
./scripts/pkgdep.sh
Build
Linux:
./configure
make
FreeBSD: Note: Make sure you have the matching kernel source in /usr/src/ and also note that CONFIG_COVERAGE option is not available right now for FreeBSD builds.
./configure
gmake
Unit Tests
./test/unit/unittest.sh
You will see several error messages when running the unit tests, but they are part of the test suite. The final message at the end of the script indicates success or failure.
Vagrant
A Vagrant setup is also provided to create a Linux VM with a virtual NVMe controller to get up and running quickly. Currently this has only been tested on MacOS and Ubuntu 16.04.2 LTS with the VirtualBox provider. The VirtualBox Extension Pack must also be installed in order to get the required NVMe support.
Details on the Vagrant setup can be found in the SPDK Vagrant documentation.
Advanced Build Options
Optional components and other build-time configuration are controlled by
settings in the Makefile configuration file in the root of the repository. CONFIG
contains the base settings for the configure script. This script generates a new
file, mk/config.mk, that contains final build settings. For advanced configuration,
there are a number of additional options to configure that may be used, or
mk/config.mk can simply be created and edited by hand. A description of all
possible options is located in CONFIG.
Boolean (on/off) options are configured with a 'y' (yes) or 'n' (no). For
example, this line of CONFIG controls whether the optional RDMA (libibverbs)
support is enabled:
CONFIG_RDMA?=n
To enable RDMA, this line may be added to mk/config.mk with a 'y' instead of
'n'. For the majority of options this can be done using the configure script.
For example:
./configure --with-rdma
Additionally, CONFIG options may also be overridden on the make command
line:
make CONFIG_RDMA=y
Users may wish to use a version of DPDK different from the submodule included in the SPDK repository. Note, this includes the ability to build not only from DPDK sources, but also just with the includes and libraries installed via the dpdk and dpdk-devel packages. To specify an alternate DPDK installation, run configure with the --with-dpdk option. For example:
Linux:
./configure --with-dpdk=/path/to/dpdk/x86_64-native-linuxapp-gcc
make
FreeBSD:
./configure --with-dpdk=/path/to/dpdk/x86_64-native-bsdapp-clang
gmake
The options specified on the make command line take precedence over the
values in mk/config.mk. This can be useful if you, for example, generate
a mk/config.mk using the configure script and then have one or two
options (i.e. debug builds) that you wish to turn on and off frequently.
Shared libraries
By default, the build of the SPDK yields static libraries against which
the SPDK applications and examples are linked.
Configure option --with-shared provides the ability to produce SPDK shared
libraries, in addition to the default static ones. Use of this flag also
results in the SPDK executables linked to the shared versions of libraries.
SPDK shared libraries by default, are located in ./build/lib. This includes
the single SPDK shared lib encompassing all of the SPDK static libs
(libspdk.so) as well as individual SPDK shared libs corresponding to each
of the SPDK static ones.
In order to start a SPDK app linked with SPDK shared libraries, make sure to do the following steps:
- run ldconfig specifying the directory containing SPDK shared libraries
- provide proper
LD_LIBRARY_PATH
Linux:
./configure --with-shared
make
ldconfig -v -n ./build/lib
LD_LIBRARY_PATH=./build/lib/ ./app/spdk_tgt/spdk_tgt
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
Users may wish to configure a specific memory size. Below is an example of configuring 8192MB memory.
sudo HUGEMEM=8192 scripts/setup.sh
Example Code
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.
Contributing
For additional details on how to get more involved in the community, including contributing code and participating in discussions and other activities, please refer to spdk.io