xref: /spdk/autotest.sh (revision 167ad6fb3ade0a58da32b6d09824aae4d3e2c79f)
1#!/usr/bin/env bash
2#  SPDX-License-Identifier: BSD-3-Clause
3#  Copyright (C) 2015 Intel Corporation
4#  All rights reserved.
5#
6
7rootdir=$(readlink -f $(dirname $0))
8
9# In autotest_common.sh all tests are disabled by default.
10# If the configuration of tests is not provided, no tests will be carried out.
11if [[ ! -f $1 ]]; then
12	echo "ERROR: SPDK test configuration not specified"
13	exit 1
14fi
15
16# Autotest.sh, as part of autorun.sh, runs in a different
17# shell process than autobuild.sh. Use helper file to pass
18# over env variable containing libraries paths.
19if [[ -e /tmp/spdk-ld-path ]]; then
20	source /tmp/spdk-ld-path
21fi
22
23source "$1"
24source "$rootdir/test/common/autotest_common.sh"
25source "$rootdir/test/nvmf/common.sh"
26
27if [ $EUID -ne 0 ]; then
28	echo "$0 must be run as root"
29	exit 1
30fi
31
32if [ $(uname -s) = Linux ]; then
33	old_core_pattern=$(< /proc/sys/kernel/core_pattern)
34	mkdir -p "$output_dir/coredumps"
35	# Set core_pattern to a known value to avoid ABRT, systemd-coredump, etc.
36	# Dump the $output_dir path to a file so collector can pick it up while executing.
37	# We don't set in in the core_pattern command line because of the string length limitation
38	# of 128 bytes. See 'man core 5' for details.
39	echo "|$rootdir/scripts/core-collector.sh %P %s %t" > /proc/sys/kernel/core_pattern
40	echo "$output_dir/coredumps" > "$rootdir/.coredump_path"
41
42	# make sure nbd (network block device) driver is loaded if it is available
43	# this ensures that when tests need to use nbd, it will be fully initialized
44	modprobe nbd || true
45
46	if udevadm=$(type -P udevadm); then
47		"$udevadm" monitor --property &> "$output_dir/udev.log" &
48		udevadm_pid=$!
49	fi
50fi
51
52trap "autotest_cleanup || :; exit 1" SIGINT SIGTERM EXIT
53
54timing_enter autotest
55
56create_test_list
57
58src=$(readlink -f $(dirname $0))
59out=$output_dir
60cd $src
61
62freebsd_update_contigmem_mod
63freebsd_set_maxsock_buf
64
65# lcov takes considerable time to process clang coverage.
66# Disabling lcov allow us to do this.
67# More information: https://github.com/spdk/spdk/issues/1693
68CC_TYPE=$(grep CC_TYPE mk/cc.mk)
69if hash lcov && ! [[ "$CC_TYPE" == *"clang"* ]]; then
70	export LCOV_OPTS="
71		--rc lcov_branch_coverage=1
72		--rc lcov_function_coverage=1
73		--rc genhtml_branch_coverage=1
74		--rc genhtml_function_coverage=1
75		--rc genhtml_legend=1
76		--rc geninfo_all_blocks=1
77		"
78	export LCOV="lcov $LCOV_OPTS --no-external"
79	# Print lcov version to log
80	$LCOV -v
81	# zero out coverage data
82	$LCOV -q -c -i -t "Baseline" -d $src -o $out/cov_base.info
83fi
84
85# Make sure the disks are clean (no leftover partition tables)
86timing_enter pre_cleanup
87# Remove old domain socket pathname just in case
88rm -f /var/tmp/spdk*.sock
89
90# Load the kernel driver
91$rootdir/scripts/setup.sh reset
92
93get_zoned_devs
94
95if ((${#zoned_devs[@]} > 0)); then
96	# FIXME: For now make sure zoned devices are tested on-demand by
97	# a designated tests instead of falling into any other. The main
98	# concern here are fio workloads where specific configuration
99	# must be in place for it to work with the zoned device.
100	export PCI_BLOCKED="${zoned_devs[*]}"
101	export PCI_ZONED="${zoned_devs[*]}"
102fi
103
104# Delete all leftover lvols and gpt partitions
105# Matches both /dev/nvmeXnY on Linux and /dev/nvmeXnsY on BSD
106# Filter out nvme with partitions - the "p*" suffix
107for dev in $(ls /dev/nvme*n* | grep -v p || true); do
108	# Skip zoned devices as non-sequential IO will always fail
109	[[ -z ${zoned_devs["${dev##*/}"]} ]] || continue
110	if ! block_in_use "$dev"; then
111		dd if=/dev/zero of="$dev" bs=1M count=1
112	fi
113done
114
115sync
116
117if ! xtrace_disable_per_cmd reap_spdk_processes; then
118	echo "WARNING: Lingering SPDK processes were detected. Testing environment may be unstable" >&2
119fi
120
121if [ $(uname -s) = Linux ]; then
122	run_test "setup.sh" "$rootdir/test/setup/test-setup.sh"
123fi
124
125$rootdir/scripts/setup.sh status
126
127if [[ $(uname -s) == Linux ]]; then
128	# Revert NVMe namespaces to default state
129	nvme_namespace_revert
130fi
131
132timing_exit pre_cleanup
133
134# set up huge pages
135timing_enter afterboot
136$rootdir/scripts/setup.sh
137timing_exit afterboot
138
139# Revert existing OPAL to factory settings that may have been left from earlier failed tests.
140# This ensures we won't hit any unexpected failures due to NVMe SSDs being locked.
141opal_revert_cleanup
142
143#####################
144# Unit Tests
145#####################
146
147if [ $SPDK_TEST_UNITTEST -eq 1 ]; then
148	run_test "unittest" $rootdir/test/unit/unittest.sh
149fi
150
151if [ $SPDK_RUN_FUNCTIONAL_TEST -eq 1 ]; then
152	if [[ $SPDK_TEST_CRYPTO -eq 1 || $SPDK_TEST_VBDEV_COMPRESS -eq 1 ]]; then
153		if [[ $SPDK_TEST_USE_IGB_UIO -eq 1 ]]; then
154			$rootdir/scripts/qat_setup.sh igb_uio
155		else
156			$rootdir/scripts/qat_setup.sh
157		fi
158	fi
159	timing_enter lib
160
161	run_test "env" $rootdir/test/env/env.sh
162	run_test "rpc" $rootdir/test/rpc/rpc.sh
163	run_test "rpc_client" $rootdir/test/rpc_client/rpc_client.sh
164	run_test "json_config" $rootdir/test/json_config/json_config.sh
165	run_test "json_config_extra_key" $rootdir/test/json_config/json_config_extra_key.sh
166	run_test "alias_rpc" $rootdir/test/json_config/alias_rpc/alias_rpc.sh
167
168	if [[ $SPDK_JSONRPC_GO_CLIENT -eq 0 ]]; then
169		run_test "spdkcli_tcp" $rootdir/test/spdkcli/tcp.sh
170	fi
171
172	run_test "dpdk_mem_utility" $rootdir/test/dpdk_memory_utility/test_dpdk_mem_info.sh
173	run_test "event" $rootdir/test/event/event.sh
174	run_test "thread" $rootdir/test/thread/thread.sh
175	run_test "accel" $rootdir/test/accel/accel.sh
176	run_test "app_cmdline" $rootdir/test/app/cmdline.sh
177	run_test "version" $rootdir/test/app/version.sh
178
179	if [ $SPDK_TEST_BLOCKDEV -eq 1 ]; then
180		run_test "blockdev_general" $rootdir/test/bdev/blockdev.sh
181		run_test "bdev_raid" $rootdir/test/bdev/bdev_raid.sh
182		run_test "bdevperf_config" $rootdir/test/bdev/bdevperf/test_config.sh
183		if [[ $(uname -s) == Linux ]]; then
184			run_test "reactor_set_interrupt" $rootdir/test/interrupt/reactor_set_interrupt.sh
185			run_test "reap_unregistered_poller" $rootdir/test/interrupt/reap_unregistered_poller.sh
186		fi
187	fi
188
189	if [[ $(uname -s) == Linux ]]; then
190		if [[ $SPDK_TEST_BLOCKDEV -eq 1 || $SPDK_TEST_URING -eq 1 ]]; then
191			# The crypto job also includes the SPDK_TEST_BLOCKDEV in its configuration hence the
192			# dd tests are executed there as well. However, these tests can take a significant
193			# amount of time to complete (up to 4min) on a physical system leading to a potential
194			# job timeout. Avoid that by skipping these tests - this should not affect the coverage
195			# since dd tests are still run as part of the vg jobs.
196			if [[ $SPDK_TEST_CRYPTO -eq 0 ]]; then
197				run_test "spdk_dd" $rootdir/test/dd/dd.sh
198			fi
199		fi
200	fi
201
202	if [ $SPDK_TEST_NVME -eq 1 ]; then
203		run_test "blockdev_nvme" $rootdir/test/bdev/blockdev.sh "nvme"
204		if [[ $(uname -s) == Linux ]]; then
205			run_test "blockdev_nvme_gpt" $rootdir/test/bdev/blockdev.sh "gpt"
206		fi
207		run_test "nvme" $rootdir/test/nvme/nvme.sh
208		if [[ $SPDK_TEST_NVME_PMR -eq 1 ]]; then
209			run_test "nvme_pmr" $rootdir/test/nvme/nvme_pmr.sh
210		fi
211
212		run_test "nvme_scc" $rootdir/test/nvme/nvme_scc.sh
213
214		if [[ $SPDK_TEST_NVME_BP -eq 1 ]]; then
215			run_test "nvme_bp" $rootdir/test/nvme/nvme_bp.sh
216		fi
217		if [[ $SPDK_TEST_NVME_CUSE -eq 1 ]]; then
218			run_test "nvme_cuse" $rootdir/test/nvme/cuse/nvme_cuse.sh
219		fi
220		if [[ $SPDK_TEST_NVME_CMB -eq 1 ]]; then
221			run_test "nvme_cmb" $rootdir/test/nvme/cmb/cmb.sh
222		fi
223		if [[ $SPDK_TEST_NVME_FDP -eq 1 ]]; then
224			run_test "nvme_fdp" test/nvme/nvme_fdp.sh
225		fi
226
227		if [[ $SPDK_TEST_NVME_ZNS -eq 1 ]]; then
228			run_test "nvme_zns" $rootdir/test/nvme/zns/zns.sh
229		fi
230
231		run_test "nvme_rpc" $rootdir/test/nvme/nvme_rpc.sh
232		run_test "nvme_rpc_timeouts" $rootdir/test/nvme/nvme_rpc_timeouts.sh
233		# Only test hotplug without ASAN enabled. Since if it is
234		# enabled, it catches SEGV earlier than our handler which
235		# breaks the hotplug logic.
236		if [ $SPDK_RUN_ASAN -eq 0 ] && [ $(uname -s) = Linux ]; then
237			run_test "sw_hotplug" $rootdir/test/nvme/sw_hotplug.sh
238		fi
239
240		if [[ $SPDK_TEST_XNVME -eq 1 ]]; then
241			run_test "nvme_xnvme" $rootdir/test/nvme/xnvme/xnvme.sh
242			run_test "blockdev_xnvme" $rootdir/test/bdev/blockdev.sh "xnvme"
243			# Run ublk with xnvme since they have similar kernel dependencies
244			run_test "ublk" $rootdir/test/ublk/ublk.sh
245		fi
246	fi
247
248	if [ $SPDK_TEST_IOAT -eq 1 ]; then
249		run_test "ioat" $rootdir/test/ioat/ioat.sh
250	fi
251
252	timing_exit lib
253
254	if [ $SPDK_TEST_ISCSI -eq 1 ]; then
255		run_test "iscsi_tgt" $rootdir/test/iscsi_tgt/iscsi_tgt.sh
256		run_test "spdkcli_iscsi" $rootdir/test/spdkcli/iscsi.sh
257
258		# Run raid spdkcli test under iSCSI since blockdev tests run on systems that can't run spdkcli yet
259		run_test "spdkcli_raid" $rootdir/test/spdkcli/raid.sh
260	fi
261
262	if [ $SPDK_TEST_BLOBFS -eq 1 ]; then
263		run_test "rocksdb" $rootdir/test/blobfs/rocksdb/rocksdb.sh
264		run_test "blobstore" $rootdir/test/blobstore/blobstore.sh
265		run_test "blobstore_grow" $rootdir/test/blobstore/blobstore_grow/blobstore_grow.sh
266		run_test "blobfs" $rootdir/test/blobfs/blobfs.sh
267		run_test "hello_blob" $SPDK_EXAMPLE_DIR/hello_blob \
268			examples/blob/hello_world/hello_blob.json
269	fi
270
271	if [ $SPDK_TEST_NVMF -eq 1 ]; then
272		export NET_TYPE
273		# The NVMe-oF run test cases are split out like this so that the parser that compiles the
274		# list of all tests can properly differentiate them. Please do not merge them into one line.
275		if [ "$SPDK_TEST_NVMF_TRANSPORT" = "rdma" ]; then
276			run_test "nvmf_rdma" $rootdir/test/nvmf/nvmf.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
277			run_test "spdkcli_nvmf_rdma" $rootdir/test/spdkcli/nvmf.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
278		elif [ "$SPDK_TEST_NVMF_TRANSPORT" = "tcp" ]; then
279			run_test "nvmf_tcp" $rootdir/test/nvmf/nvmf.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
280			if [[ $SPDK_TEST_URING -eq 0 ]]; then
281				run_test "spdkcli_nvmf_tcp" $rootdir/test/spdkcli/nvmf.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
282				run_test "nvmf_identify_passthru" $rootdir/test/nvmf/target/identify_passthru.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
283			fi
284			run_test "nvmf_dif" $rootdir/test/nvmf/target/dif.sh
285			run_test "nvmf_abort_qd_sizes" $rootdir/test/nvmf/target/abort_qd_sizes.sh
286		elif [ "$SPDK_TEST_NVMF_TRANSPORT" = "fc" ]; then
287			run_test "nvmf_fc" $rootdir/test/nvmf/nvmf.sh --transport=$SPDK_TEST_NVMF_TRANSPORT
288			run_test "spdkcli_nvmf_fc" $rootdir/test/spdkcli/nvmf.sh
289		else
290			echo "unknown NVMe transport, please specify rdma, tcp, or fc."
291			exit 1
292		fi
293	fi
294
295	if [ $SPDK_TEST_VHOST -eq 1 ]; then
296		run_test "vhost" $rootdir/test/vhost/vhost.sh
297	fi
298
299	if [ $SPDK_TEST_VFIOUSER_QEMU -eq 1 ]; then
300		run_test "vfio_user_qemu" $rootdir/test/vfio_user/vfio_user.sh
301	fi
302
303	if [ $SPDK_TEST_LVOL -eq 1 ]; then
304		run_test "lvol" $rootdir/test/lvol/lvol.sh
305		run_test "blob_io_wait" $rootdir/test/blobstore/blob_io_wait/blob_io_wait.sh
306	fi
307
308	if [ $SPDK_TEST_VHOST_INIT -eq 1 ]; then
309		timing_enter vhost_initiator
310		run_test "vhost_blockdev" $rootdir/test/vhost/initiator/blockdev.sh
311		run_test "spdkcli_virtio" $rootdir/test/spdkcli/virtio.sh
312		run_test "vhost_shared" $rootdir/test/vhost/shared/shared.sh
313		run_test "vhost_fuzz" $rootdir/test/vhost/fuzz/fuzz.sh
314		timing_exit vhost_initiator
315	fi
316
317	if [ $SPDK_TEST_RBD -eq 1 ]; then
318		run_test "blockdev_rbd" $rootdir/test/bdev/blockdev.sh "rbd"
319		run_test "spdkcli_rbd" $rootdir/test/spdkcli/rbd.sh
320	fi
321
322	if [ $SPDK_TEST_OCF -eq 1 ]; then
323		run_test "ocf" $rootdir/test/ocf/ocf.sh
324	fi
325
326	if [ $SPDK_TEST_FTL -eq 1 ]; then
327		run_test "ftl" $rootdir/test/ftl/ftl.sh
328	fi
329
330	if [ $SPDK_TEST_VMD -eq 1 ]; then
331		run_test "vmd" $rootdir/test/vmd/vmd.sh
332	fi
333
334	if [ $SPDK_TEST_VBDEV_COMPRESS -eq 1 ]; then
335		run_test "compress_compdev" $rootdir/test/compress/compress.sh "compdev"
336		run_test "compress_isal" $rootdir/test/compress/compress.sh "isal"
337	fi
338
339	if [ $SPDK_TEST_OPAL -eq 1 ]; then
340		run_test "nvme_opal" $rootdir/test/nvme/nvme_opal.sh
341	fi
342
343	if [ $SPDK_TEST_CRYPTO -eq 1 ]; then
344		run_test "blockdev_crypto_aesni" $rootdir/test/bdev/blockdev.sh "crypto_aesni"
345		run_test "blockdev_crypto_sw" $rootdir/test/bdev/blockdev.sh "crypto_sw"
346		run_test "blockdev_crypto_qat" $rootdir/test/bdev/blockdev.sh "crypto_qat"
347		run_test "chaining" $rootdir/test/bdev/chaining.sh
348	fi
349
350	if [[ $SPDK_TEST_SCHEDULER -eq 1 ]]; then
351		run_test "scheduler" $rootdir/test/scheduler/scheduler.sh
352	fi
353
354	if [[ $SPDK_TEST_SMA -eq 1 ]]; then
355		run_test "sma" $rootdir/test/sma/sma.sh
356	fi
357
358	if [[ $SPDK_TEST_FUZZER -eq 1 ]]; then
359		run_test "llvm_fuzz" $rootdir/test/fuzz/llvm.sh
360	fi
361
362	if [[ $SPDK_TEST_RAID5 -eq 1 ]]; then
363		run_test "blockdev_raid5f" $rootdir/test/bdev/blockdev.sh "raid5f"
364	fi
365fi
366
367trap - SIGINT SIGTERM EXIT
368
369timing_enter post_cleanup
370autotest_cleanup
371timing_exit post_cleanup
372
373timing_exit autotest
374chmod a+r $output_dir/timing.txt
375
376[[ -f "$output_dir/udev.log" ]] && rm -f "$output_dir/udev.log"
377
378if hash lcov && ! [[ "$CC_TYPE" == *"clang"* ]]; then
379	# generate coverage data and combine with baseline
380	$LCOV -q -c -d $src -t "$(hostname)" -o $out/cov_test.info
381	$LCOV -q -a $out/cov_base.info -a $out/cov_test.info -o $out/cov_total.info
382	$LCOV -q -r $out/cov_total.info '*/dpdk/*' -o $out/cov_total.info
383	$LCOV -q -r $out/cov_total.info '/usr/*' -o $out/cov_total.info
384	$LCOV -q -r $out/cov_total.info '*/examples/vmd/*' -o $out/cov_total.info
385	$LCOV -q -r $out/cov_total.info '*/app/spdk_lspci/*' -o $out/cov_total.info
386	$LCOV -q -r $out/cov_total.info '*/app/spdk_top/*' -o $out/cov_total.info
387	rm -f cov_base.info cov_test.info OLD_STDOUT OLD_STDERR
388fi
389