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