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