xref: /spdk/test/unit/unittest.sh (revision b30d57cdad6d2bc75cc1e4e2ebbcebcb0d98dcfa)
1#!/usr/bin/env bash
2#
3# Environment variables:
4#  $valgrind    Specify the valgrind command line, if not
5#               then a default command line is used
6
7set -xe
8
9testdir=$(readlink -f $(dirname $0))
10rootdir=$(readlink -f $(dirname $0)/../..)
11source "$rootdir/test/common/autotest_common.sh"
12
13cd "$rootdir"
14
15function unittest_bdev() {
16	$valgrind $testdir/lib/bdev/bdev.c/bdev_ut
17	$valgrind $testdir/lib/bdev/bdev_ocssd.c/bdev_ocssd_ut
18	$valgrind $testdir/lib/bdev/raid/bdev_raid.c/bdev_raid_ut
19	$valgrind $testdir/lib/bdev/bdev_zone.c/bdev_zone_ut
20	$valgrind $testdir/lib/bdev/gpt/gpt.c/gpt_ut
21	$valgrind $testdir/lib/bdev/part.c/part_ut
22	$valgrind $testdir/lib/bdev/scsi_nvme.c/scsi_nvme_ut
23	$valgrind $testdir/lib/bdev/vbdev_lvol.c/vbdev_lvol_ut
24	$valgrind $testdir/lib/bdev/vbdev_zone_block.c/vbdev_zone_block_ut
25	$valgrind $testdir/lib/bdev/mt/bdev.c/bdev_ut
26}
27
28function unittest_blob() {
29	# We do not compile blob_ut on systems with too old Cunit, so do
30	# not try to execute it if it doesn't exist
31	if [[ -e $testdir/lib/blob/blob.c/blob_ut ]]; then
32		$valgrind $testdir/lib/blob/blob.c/blob_ut
33	fi
34	$valgrind $testdir/lib/blobfs/tree.c/tree_ut
35	$valgrind $testdir/lib/blobfs/blobfs_async_ut/blobfs_async_ut
36	# blobfs_sync_ut hangs when run under valgrind, so don't use $valgrind
37	$testdir/lib/blobfs/blobfs_sync_ut/blobfs_sync_ut
38	$valgrind $testdir/lib/blobfs/blobfs_bdev.c/blobfs_bdev_ut
39}
40
41function unittest_event() {
42	$valgrind $testdir/lib/event/subsystem.c/subsystem_ut
43	$valgrind $testdir/lib/event/app.c/app_ut
44	$valgrind $testdir/lib/event/reactor.c/reactor_ut
45}
46
47function unittest_ftl() {
48	$valgrind $testdir/lib/ftl/ftl_ppa/ftl_ppa_ut
49	$valgrind $testdir/lib/ftl/ftl_band.c/ftl_band_ut
50	$valgrind $testdir/lib/ftl/ftl_reloc.c/ftl_reloc_ut
51	$valgrind $testdir/lib/ftl/ftl_wptr/ftl_wptr_ut
52	$valgrind $testdir/lib/ftl/ftl_md/ftl_md_ut
53	$valgrind $testdir/lib/ftl/ftl_io.c/ftl_io_ut
54}
55
56function unittest_iscsi() {
57	$valgrind $testdir/lib/iscsi/conn.c/conn_ut
58	$valgrind $testdir/lib/iscsi/param.c/param_ut
59	$valgrind $testdir/lib/iscsi/tgt_node.c/tgt_node_ut
60	$valgrind $testdir/lib/iscsi/iscsi.c/iscsi_ut
61	$valgrind $testdir/lib/iscsi/init_grp.c/init_grp_ut
62	$valgrind $testdir/lib/iscsi/portal_grp.c/portal_grp_ut
63}
64
65function unittest_json() {
66	$valgrind $testdir/lib/json/json_parse.c/json_parse_ut
67	$valgrind $testdir/lib/json/json_util.c/json_util_ut
68	$valgrind $testdir/lib/json/json_write.c/json_write_ut
69	$valgrind $testdir/lib/jsonrpc/jsonrpc_server.c/jsonrpc_server_ut
70}
71
72function unittest_nvme() {
73	$valgrind $testdir/lib/nvme/nvme.c/nvme_ut
74	$valgrind $testdir/lib/nvme/nvme_ctrlr.c/nvme_ctrlr_ut
75	$valgrind $testdir/lib/nvme/nvme_ctrlr_cmd.c/nvme_ctrlr_cmd_ut
76	$valgrind $testdir/lib/nvme/nvme_ctrlr_ocssd_cmd.c/nvme_ctrlr_ocssd_cmd_ut
77	$valgrind $testdir/lib/nvme/nvme_ns.c/nvme_ns_ut
78	$valgrind $testdir/lib/nvme/nvme_ns_cmd.c/nvme_ns_cmd_ut
79	$valgrind $testdir/lib/nvme/nvme_ns_ocssd_cmd.c/nvme_ns_ocssd_cmd_ut
80	$valgrind $testdir/lib/nvme/nvme_qpair.c/nvme_qpair_ut
81	$valgrind $testdir/lib/nvme/nvme_pcie.c/nvme_pcie_ut
82	$valgrind $testdir/lib/nvme/nvme_poll_group.c/nvme_poll_group_ut
83	$valgrind $testdir/lib/nvme/nvme_quirks.c/nvme_quirks_ut
84	$valgrind $testdir/lib/nvme/nvme_tcp.c/nvme_tcp_ut
85	$valgrind $testdir/lib/nvme/nvme_uevent.c/nvme_uevent_ut
86}
87
88function unittest_nvmf() {
89	$valgrind $testdir/lib/nvmf/ctrlr.c/ctrlr_ut
90	$valgrind $testdir/lib/nvmf/ctrlr_bdev.c/ctrlr_bdev_ut
91	$valgrind $testdir/lib/nvmf/ctrlr_discovery.c/ctrlr_discovery_ut
92	$valgrind $testdir/lib/nvmf/subsystem.c/subsystem_ut
93	$valgrind $testdir/lib/nvmf/tcp.c/tcp_ut
94}
95
96function unittest_scsi() {
97	$valgrind $testdir/lib/scsi/dev.c/dev_ut
98	$valgrind $testdir/lib/scsi/lun.c/lun_ut
99	$valgrind $testdir/lib/scsi/scsi.c/scsi_ut
100	$valgrind $testdir/lib/scsi/scsi_bdev.c/scsi_bdev_ut
101	$valgrind $testdir/lib/scsi/scsi_pr.c/scsi_pr_ut
102}
103
104function unittest_sock() {
105	$valgrind $testdir/lib/sock/sock.c/sock_ut
106	$valgrind $testdir/lib/sock/posix.c/posix_ut
107	# Check whether uring is configured
108	if grep -q '#define SPDK_CONFIG_URING 1' $rootdir/include/spdk/config.h; then
109		$valgrind $testdir/lib/sock/uring.c/uring_ut
110	fi
111}
112
113function unittest_util() {
114	$valgrind $testdir/lib/util/base64.c/base64_ut
115	$valgrind $testdir/lib/util/bit_array.c/bit_array_ut
116	$valgrind $testdir/lib/util/cpuset.c/cpuset_ut
117	$valgrind $testdir/lib/util/crc16.c/crc16_ut
118	$valgrind $testdir/lib/util/crc32_ieee.c/crc32_ieee_ut
119	$valgrind $testdir/lib/util/crc32c.c/crc32c_ut
120	$valgrind $testdir/lib/util/string.c/string_ut
121	$valgrind $testdir/lib/util/dif.c/dif_ut
122	$valgrind $testdir/lib/util/iov.c/iov_ut
123	$valgrind $testdir/lib/util/math.c/math_ut
124	$valgrind $testdir/lib/util/pipe.c/pipe_ut
125}
126
127# if ASAN is enabled, use it.  If not use valgrind if installed but allow
128# the env variable to override the default shown below.
129if [ -z ${valgrind+x} ]; then
130	if grep -q '#undef SPDK_CONFIG_ASAN' $rootdir/include/spdk/config.h && hash valgrind; then
131		valgrind='valgrind --leak-check=full --error-exitcode=2'
132	else
133		valgrind=''
134	fi
135fi
136
137# setup local unit test coverage if cov is available
138# lcov takes considerable time to process clang coverage.
139# Disabling lcov allow us to do this.
140# More information: https://github.com/spdk/spdk/issues/1693
141CC_TYPE=$(grep CC_TYPE $rootdir/mk/cc.mk)
142if hash lcov && grep -q '#define SPDK_CONFIG_COVERAGE 1' $rootdir/include/spdk/config.h && ! [[ "$CC_TYPE" == *"clang"* ]]; then
143	cov_avail="yes"
144else
145	cov_avail="no"
146fi
147if [ "$cov_avail" = "yes" ]; then
148	# set unit test output dir if not specified in env var
149	if [ -z ${UT_COVERAGE+x} ]; then
150		UT_COVERAGE="ut_coverage"
151	fi
152	mkdir -p $UT_COVERAGE
153	export LCOV_OPTS="
154		--rc lcov_branch_coverage=1
155		--rc lcov_function_coverage=1
156		--rc genhtml_branch_coverage=1
157		--rc genhtml_function_coverage=1
158		--rc genhtml_legend=1
159		--rc geninfo_all_blocks=1
160		"
161	export LCOV="lcov $LCOV_OPTS --no-external"
162	# zero out coverage data
163	$LCOV -q -c -i -d . -t "Baseline" -o $UT_COVERAGE/ut_cov_base.info
164fi
165
166# workaround for valgrind v3.13 on arm64
167if [ $(uname -m) = "aarch64" ]; then
168	export LD_HWCAP_MASK=1
169fi
170
171run_test "unittest_include" $valgrind $testdir/include/spdk/histogram_data.h/histogram_ut
172run_test "unittest_bdev" unittest_bdev
173if grep -q '#define SPDK_CONFIG_CRYPTO 1' $rootdir/include/spdk/config.h; then
174	run_test "unittest_bdev_crypto" $valgrind $testdir/lib/bdev/crypto.c/crypto_ut
175fi
176
177if grep -q '#define SPDK_CONFIG_REDUCE 1' $rootdir/include/spdk/config.h; then
178	run_test "unittest_bdev_reduce" $valgrind $testdir/lib/bdev/compress.c/compress_ut
179fi
180
181if grep -q '#define SPDK_CONFIG_PMDK 1' $rootdir/include/spdk/config.h; then
182	run_test "unittest_bdev_pmem" $valgrind $testdir/lib/bdev/pmem/bdev_pmem_ut
183fi
184
185if grep -q '#define SPDK_CONFIG_RAID5 1' $rootdir/include/spdk/config.h; then
186	run_test "unittest_bdev_raid5" $valgrind $testdir/lib/bdev/raid/raid5.c/raid5_ut
187fi
188
189run_test "unittest_blob_blobfs" unittest_blob
190run_test "unittest_event" unittest_event
191if [ $(uname -s) = Linux ]; then
192	run_test "unittest_ftl" unittest_ftl
193fi
194
195run_test "unittest_ioat" $valgrind $testdir/lib/ioat/ioat.c/ioat_ut
196if grep -q '#define SPDK_CONFIG_IDXD 1' $rootdir/include/spdk/config.h; then
197	run_test "unittest_idxd" $valgrind $testdir/lib/idxd/idxd.c/idxd_ut
198fi
199run_test "unittest_iscsi" unittest_iscsi
200run_test "unittest_json" unittest_json
201run_test "unittest_notify" $valgrind $testdir/lib/notify/notify.c/notify_ut
202run_test "unittest_nvme" unittest_nvme
203run_test "unittest_log" $valgrind $testdir/lib/log/log.c/log_ut
204run_test "unittest_lvol" $valgrind $testdir/lib/lvol/lvol.c/lvol_ut
205if grep -q '#define SPDK_CONFIG_RDMA 1' $rootdir/include/spdk/config.h; then
206	run_test "unittest_nvme_rdma" $valgrind $testdir/lib/nvme/nvme_rdma.c/nvme_rdma_ut
207fi
208
209run_test "unittest_nvmf" unittest_nvmf
210if grep -q '#define SPDK_CONFIG_FC 1' $rootdir/include/spdk/config.h; then
211	run_test "unittest_nvmf_fc" $valgrind $testdir/lib/nvmf/fc.c/fc_ut
212	run_test "unittest_nvmf_fc_ls" $valgrind $testdir/lib/nvmf/fc_ls.c/fc_ls_ut
213fi
214
215if grep -q '#define SPDK_CONFIG_RDMA 1' $rootdir/include/spdk/config.h; then
216	run_test "unittest_nvmf_rdma" $valgrind $testdir/lib/nvmf/rdma.c/rdma_ut
217fi
218
219run_test "unittest_scsi" unittest_scsi
220run_test "unittest_sock" unittest_sock
221run_test "unittest_thread" $valgrind $testdir/lib/thread/thread.c/thread_ut
222run_test "unittest_util" unittest_util
223if grep -q '#define SPDK_CONFIG_VHOST 1' $rootdir/include/spdk/config.h; then
224	run_test "unittest_vhost" $valgrind $testdir/lib/vhost/vhost.c/vhost_ut
225fi
226
227if [ "$cov_avail" = "yes" ] && ! [[ "$CC_TYPE" == *"clang"* ]]; then
228	$LCOV -q -d . -c -t "$(hostname)" -o $UT_COVERAGE/ut_cov_test.info
229	$LCOV -q -a $UT_COVERAGE/ut_cov_base.info -a $UT_COVERAGE/ut_cov_test.info -o $UT_COVERAGE/ut_cov_total.info
230	$LCOV -q -a $UT_COVERAGE/ut_cov_total.info -o $UT_COVERAGE/ut_cov_unit.info
231	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/app/*" -o $UT_COVERAGE/ut_cov_unit.info
232	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/dpdk/*" -o $UT_COVERAGE/ut_cov_unit.info
233	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/examples/*" -o $UT_COVERAGE/ut_cov_unit.info
234	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/include/*" -o $UT_COVERAGE/ut_cov_unit.info
235	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/lib/vhost/rte_vhost/*" -o $UT_COVERAGE/ut_cov_unit.info
236	$LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/test/*" -o $UT_COVERAGE/ut_cov_unit.info
237	rm -f $UT_COVERAGE/ut_cov_base.info $UT_COVERAGE/ut_cov_test.info
238	genhtml $UT_COVERAGE/ut_cov_unit.info --output-directory $UT_COVERAGE
239	# git -C option not used for compatibility reasons
240	(cd $rootdir && git clean -f "*.gcda")
241fi
242
243set +x
244
245echo
246echo
247echo "====================="
248echo "All unit tests passed"
249echo "====================="
250if [ "$cov_avail" = "yes" ]; then
251	echo "Note: coverage report is here: $rootdir/$UT_COVERAGE"
252else
253	echo "WARN: lcov not installed or SPDK built without coverage!"
254fi
255if grep -q '#undef SPDK_CONFIG_ASAN' $rootdir/include/spdk/config.h && [ "$valgrind" = "" ]; then
256	echo "WARN: neither valgrind nor ASAN is enabled!"
257fi
258
259echo
260echo
261