2015-09-21 15:52:41 +00:00
|
|
|
#
|
|
|
|
# BSD LICENSE
|
|
|
|
#
|
2016-01-26 17:47:22 +00:00
|
|
|
# Copyright (c) Intel Corporation.
|
2015-09-21 15:52:41 +00:00
|
|
|
# All rights reserved.
|
2021-06-15 13:25:07 +00:00
|
|
|
# Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
2015-09-21 15:52:41 +00:00
|
|
|
#
|
|
|
|
# Redistribution and use in source and binary forms, with or without
|
|
|
|
# modification, are permitted provided that the following conditions
|
|
|
|
# are met:
|
|
|
|
#
|
|
|
|
# * Redistributions of source code must retain the above copyright
|
|
|
|
# notice, this list of conditions and the following disclaimer.
|
|
|
|
# * Redistributions in binary form must reproduce the above copyright
|
|
|
|
# notice, this list of conditions and the following disclaimer in
|
|
|
|
# the documentation and/or other materials provided with the
|
|
|
|
# distribution.
|
|
|
|
# * Neither the name of Intel Corporation nor the names of its
|
|
|
|
# contributors may be used to endorse or promote products derived
|
|
|
|
# from this software without specific prior written permission.
|
|
|
|
#
|
|
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
#
|
|
|
|
|
2017-11-15 17:36:36 +00:00
|
|
|
# Installation prefix
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_PREFIX="/usr/local"
|
2017-11-15 17:36:36 +00:00
|
|
|
|
2019-07-23 17:52:47 +00:00
|
|
|
# Target architecture
|
|
|
|
CONFIG_ARCH=native
|
|
|
|
|
2019-07-09 12:40:41 +00:00
|
|
|
# Prefix for cross compilation
|
|
|
|
CONFIG_CROSS_PREFIX=
|
|
|
|
|
2015-09-21 15:52:41 +00:00
|
|
|
# Build with debug logging. Turn off for performance testing and normal usage
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_DEBUG=n
|
2015-09-21 15:52:41 +00:00
|
|
|
|
2016-03-18 17:40:34 +00:00
|
|
|
# Treat warnings as errors (fail the build on any warning).
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_WERROR=n
|
2016-03-18 17:40:34 +00:00
|
|
|
|
2016-03-24 20:27:53 +00:00
|
|
|
# Build with link-time optimization.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_LTO=n
|
2016-03-24 20:27:53 +00:00
|
|
|
|
2019-02-11 18:19:32 +00:00
|
|
|
# Generate profile guided optimization data.
|
|
|
|
CONFIG_PGO_CAPTURE=n
|
|
|
|
|
|
|
|
# Use profile guided optimization data.
|
|
|
|
CONFIG_PGO_USE=n
|
|
|
|
|
2015-10-22 18:26:21 +00:00
|
|
|
# Build with code coverage instrumentation.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_COVERAGE=n
|
2015-10-22 18:26:21 +00:00
|
|
|
|
2015-11-04 19:46:09 +00:00
|
|
|
# Build with Address Sanitizer enabled
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_ASAN=n
|
2015-11-04 19:46:09 +00:00
|
|
|
|
2016-11-30 18:16:25 +00:00
|
|
|
# Build with Undefined Behavior Sanitizer enabled
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_UBSAN=n
|
2016-11-30 18:16:25 +00:00
|
|
|
|
test/nvmf: fuzz nvmf target using LLVM's libFuzzer
LLVM provides libFuzzer which does coverage-guided
fuzzing of a library or application under test. For
SPDK, we can use this as a new and better way to
generate random commands to the SPDK nvmf target.
By default, libFuzzer provides the main() and your
source file just provides the function called by
LLVM for each iteration of random data. But this
doesn't really work for SPDK since we need to start
the app framework and the nvmf target. So we
specify -fsanitizer=fuzzer-no-link, explicitly
specify the location of the fuzzer_no_main library
and then call LLVMFuzzerRunDriver to start the
fuzzing process once we are ready.
Since this is all coverage-guided, we invoke the
fuzzer inside the nvmf target application. So this
patch creates a new target application called
'llvm_nvme_fuzz'. One core is needed to run the
nvmf target, then we spawn a pthread to run the
fuzzer against it.
Currently there are two fuzzers defined. Fuzzer 0
does random testing of admin commands. Fuzzer 1
is focused solely on GET_LOG_PAGE and fuzzes a
smaller subset of the bytes in the spdk_nvme_cmd.
Additional fuzzers can be added in the future for
other commands, testing I/O queues, data payloads,
etc.
You do need to specify CC and CXX when running
configure, as well as specify the location of the
special clang_rt.fuzz_no_main library. The path of
that library is dependent on your clang version and
architecture. If using clang-12 on x86_64 platform,
it will look like:
CC=clang-12 CXX=clang++-12 ./configure --with-fuzzer= \
/usr/lib/llvm-12/lib/clang/12.0.0/lib/linux/libclang_rt.fuzzer_no_main-x86_64.a
Then just do the following to demonstrate the fuzzer
tool.
make
test/nvmf/target/llvm_nvme_fuzz.sh --time=60 --fuzzer=0
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iee0997501893ac284a3947a1db7a155c5ceb7849
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10038
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-10-15 21:54:52 +00:00
|
|
|
# Build with LLVM fuzzing enabled
|
|
|
|
CONFIG_FUZZER=n
|
|
|
|
CONFIG_FUZZER_LIB=
|
|
|
|
|
2017-05-24 22:00:54 +00:00
|
|
|
# Build with Thread Sanitizer enabled
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_TSAN=n
|
2017-05-24 22:00:54 +00:00
|
|
|
|
2020-03-06 09:08:29 +00:00
|
|
|
# Build functional tests
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_TESTS=y
|
2018-03-06 22:39:04 +00:00
|
|
|
|
2020-03-06 09:08:29 +00:00
|
|
|
# Build unit tests
|
|
|
|
CONFIG_UNIT_TESTS=y
|
|
|
|
|
2020-02-27 16:59:20 +00:00
|
|
|
# Build examples
|
|
|
|
CONFIG_EXAMPLES=y
|
|
|
|
|
2021-04-17 05:09:30 +00:00
|
|
|
# Build apps
|
|
|
|
CONFIG_APPS=y
|
|
|
|
|
2021-01-14 11:06:33 +00:00
|
|
|
# Build with Control-flow Enforcement Technology (CET)
|
|
|
|
CONFIG_CET=n
|
|
|
|
|
2016-08-10 17:28:20 +00:00
|
|
|
# Directory that contains the desired SPDK environment library.
|
|
|
|
# By default, this is implemented using DPDK.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_ENV=
|
2016-08-10 17:28:20 +00:00
|
|
|
|
2015-09-21 15:52:41 +00:00
|
|
|
# This directory should contain 'include' and 'lib' directories for your DPDK
|
2018-09-06 21:09:14 +00:00
|
|
|
# installation.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_DPDK_DIR=
|
2021-06-15 16:42:29 +00:00
|
|
|
# Automatically set via pkg-config when bare --with-dpdk is set
|
|
|
|
CONFIG_DPDK_LIB_DIR=
|
|
|
|
CONFIG_DPDK_INC_DIR=
|
|
|
|
CONFIG_DPDK_PKG_CONFIG=n
|
2015-09-21 15:52:41 +00:00
|
|
|
|
2021-03-03 09:48:43 +00:00
|
|
|
# This directory should contain 'include' and 'lib' directories for WPDK.
|
|
|
|
CONFIG_WPDK_DIR=
|
|
|
|
|
2018-09-26 11:19:28 +00:00
|
|
|
# Build SPDK FIO plugin. Requires CONFIG_FIO_SOURCE_DIR set to a valid
|
2016-04-13 00:58:29 +00:00
|
|
|
# fio source code directory.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_FIO_PLUGIN=n
|
2016-04-13 00:58:29 +00:00
|
|
|
|
|
|
|
# This directory should contain the source code directory for fio
|
|
|
|
# which is required for building the SPDK FIO plugin.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_FIO_SOURCE_DIR=/usr/src/fio
|
2016-06-06 21:44:30 +00:00
|
|
|
|
2016-07-13 22:34:28 +00:00
|
|
|
# Enable RDMA support for the NVMf target.
|
2016-06-06 21:44:30 +00:00
|
|
|
# Requires ibverbs development libraries.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_RDMA=n
|
|
|
|
CONFIG_RDMA_SEND_WITH_INVAL=n
|
2020-01-21 14:03:40 +00:00
|
|
|
CONFIG_RDMA_SET_ACK_TIMEOUT=n
|
2020-03-14 12:08:29 +00:00
|
|
|
CONFIG_RDMA_PROV=verbs
|
2016-09-20 04:12:45 +00:00
|
|
|
|
2019-10-24 18:04:33 +00:00
|
|
|
# Enable NVMe Character Devices.
|
|
|
|
CONFIG_NVME_CUSE=n
|
|
|
|
|
2019-04-22 09:28:02 +00:00
|
|
|
# Enable FC support for the NVMf target.
|
|
|
|
# Requires FC low level driver (from FC vendor)
|
|
|
|
CONFIG_FC=n
|
|
|
|
CONFIG_FC_PATH=
|
|
|
|
|
2016-09-20 04:12:45 +00:00
|
|
|
# Build Ceph RBD support in bdev modules
|
|
|
|
# Requires librbd development libraries
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_RBD=n
|
2017-03-06 20:34:45 +00:00
|
|
|
|
|
|
|
# Build vhost library.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_VHOST=y
|
2017-09-29 08:49:51 +00:00
|
|
|
|
2017-10-17 17:04:28 +00:00
|
|
|
# Build vhost initiator (Virtio) driver.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_VIRTIO=y
|
2017-10-17 17:04:28 +00:00
|
|
|
|
2020-08-19 15:35:38 +00:00
|
|
|
# Build custom vfio-user transport for NVMf target and NVMe initiator.
|
2021-01-28 10:27:57 +00:00
|
|
|
CONFIG_VFIO_USER=n
|
2021-02-19 09:31:12 +00:00
|
|
|
CONFIG_VFIO_USER_DIR=
|
2020-11-02 15:32:20 +00:00
|
|
|
|
2018-04-03 23:07:39 +00:00
|
|
|
# Build with PMDK backends
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_PMDK=n
|
|
|
|
CONFIG_PMDK_DIR=
|
2018-03-13 14:42:45 +00:00
|
|
|
|
2018-10-15 20:46:41 +00:00
|
|
|
# Enable the dependencies for building the compress vbdev
|
2018-09-21 14:37:54 +00:00
|
|
|
CONFIG_REDUCE=n
|
|
|
|
|
2021-06-15 13:25:07 +00:00
|
|
|
# Enable mlx5_pci dpdk compress PMD, enabled automatically if CONFIG_REDUCE=y and libmlx5 exists
|
|
|
|
CONFIG_REDUCE_MLX5=n
|
|
|
|
|
2017-12-04 17:07:04 +00:00
|
|
|
# Requires libiscsi development libraries.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_ISCSI_INITIATOR=n
|
2018-05-08 11:30:29 +00:00
|
|
|
|
2018-03-22 23:24:14 +00:00
|
|
|
# Enable the dependencies for building the crypto vbdev
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_CRYPTO=n
|
2018-08-14 17:56:26 +00:00
|
|
|
|
|
|
|
# Build spdk shared libraries in addition to the static ones.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_SHARED=n
|
2018-09-26 11:19:28 +00:00
|
|
|
|
|
|
|
# Build with VTune suport.
|
2018-09-21 14:32:36 +00:00
|
|
|
CONFIG_VTUNE=n
|
|
|
|
CONFIG_VTUNE_DIR=
|
2018-10-10 17:09:07 +00:00
|
|
|
|
2019-01-13 20:28:21 +00:00
|
|
|
# Build Intel IPSEC_MB library
|
|
|
|
CONFIG_IPSEC_MB=n
|
2018-09-20 16:54:49 +00:00
|
|
|
|
|
|
|
# Enable OCF module
|
|
|
|
CONFIG_OCF=n
|
|
|
|
CONFIG_OCF_PATH=
|
|
|
|
CONFIG_CUSTOMOCF=n
|
2019-01-21 09:05:59 +00:00
|
|
|
|
|
|
|
# Build ISA-L library
|
|
|
|
CONFIG_ISAL=y
|
2019-02-14 19:07:42 +00:00
|
|
|
|
|
|
|
# Build with IO_URING support
|
|
|
|
CONFIG_URING=n
|
|
|
|
|
|
|
|
# Path to custom built IO_URING library
|
|
|
|
CONFIG_URING_PATH=
|
2019-10-08 12:28:49 +00:00
|
|
|
|
|
|
|
# Build with FUSE support
|
|
|
|
CONFIG_FUSE=n
|
2019-11-04 11:35:50 +00:00
|
|
|
|
|
|
|
# Build with RAID5 support
|
|
|
|
CONFIG_RAID5=n
|
2020-04-10 15:29:01 +00:00
|
|
|
|
|
|
|
# Build with IDXD support
|
2021-03-31 10:09:42 +00:00
|
|
|
# In this mode, SPDK fully controls the DSA device.
|
2020-04-10 15:29:01 +00:00
|
|
|
CONFIG_IDXD=n
|
usdt: add User Space DTrace support to SPDK
For now, we will keep this disabled by default,
enable with --with-usdt option to the configure
script. Long-term we will want to enable this by
default, and only disable via configure.
Modules can include spdk_internal/usdt.h and add
probes such as:
SPDK_DTRACE_PROBE2(probe_name, ptr, val);
When USDT is enabled, these will translate to
DTRACE_PROBE2(spdk, probe_name, ptr, val). When
USDT is disabled, these will translate to nothing.
Later patches will add some probe points to the
nvmf target, some bpftrace scripts, and instructions
for how to successfully capture data with these
probe points and scripts.
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Id168e2c800fa5522815a175026386319014cfdaa
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7173
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2021-03-31 22:33:20 +00:00
|
|
|
|
|
|
|
# Build with USDT support
|
|
|
|
CONFIG_USDT=n
|
2021-03-31 10:09:42 +00:00
|
|
|
|
|
|
|
# Build with IDXD kernel support.
|
|
|
|
# In this mode, SPDK shares the DSA device with the kernel.
|
|
|
|
CONFIG_IDXD_KERNEL=n
|