1#!/usr/bin/env bash 2# SPDX-License-Identifier: BSD-3-Clause 3# Copyright (C) 2018 Intel Corporation 4# All rights reserved. 5# Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 6# 7# Environment variables: 8# $valgrind Specify the valgrind command line, if not 9# then a default command line is used 10 11set -xe 12 13testdir=$(readlink -f $(dirname $0)) 14rootdir=$(readlink -f $(dirname $0)/../..) 15source "$rootdir/test/common/autotest_common.sh" 16 17cd "$rootdir" 18 19function unittest_bdev() { 20 $valgrind $testdir/lib/bdev/bdev.c/bdev_ut 21 $valgrind $testdir/lib/bdev/nvme/bdev_nvme.c/bdev_nvme_ut 22 $valgrind $testdir/lib/bdev/raid/bdev_raid.c/bdev_raid_ut 23 $valgrind $testdir/lib/bdev/raid/concat.c/concat_ut 24 $valgrind $testdir/lib/bdev/raid/raid1.c/raid1_ut 25 $valgrind $testdir/lib/bdev/bdev_zone.c/bdev_zone_ut 26 $valgrind $testdir/lib/bdev/gpt/gpt.c/gpt_ut 27 $valgrind $testdir/lib/bdev/part.c/part_ut 28 $valgrind $testdir/lib/bdev/scsi_nvme.c/scsi_nvme_ut 29 $valgrind $testdir/lib/bdev/vbdev_lvol.c/vbdev_lvol_ut 30 $valgrind $testdir/lib/bdev/vbdev_zone_block.c/vbdev_zone_block_ut 31 $valgrind $testdir/lib/bdev/mt/bdev.c/bdev_ut 32} 33 34function unittest_blob() { 35 # We do not compile blob_ut on systems with too old Cunit, so do 36 # not try to execute it if it doesn't exist 37 if [[ -e $testdir/lib/blob/blob.c/blob_ut ]]; then 38 $valgrind $testdir/lib/blob/blob.c/blob_ut 39 fi 40 $valgrind $testdir/lib/blob/blob_bdev.c/blob_bdev_ut 41 $valgrind $testdir/lib/blobfs/tree.c/tree_ut 42 $valgrind $testdir/lib/blobfs/blobfs_async_ut/blobfs_async_ut 43 # blobfs_sync_ut hangs when run under valgrind, so don't use $valgrind 44 $testdir/lib/blobfs/blobfs_sync_ut/blobfs_sync_ut 45 $valgrind $testdir/lib/blobfs/blobfs_bdev.c/blobfs_bdev_ut 46} 47 48function unittest_event() { 49 $valgrind $testdir/lib/event/app.c/app_ut 50 $valgrind $testdir/lib/event/reactor.c/reactor_ut 51} 52 53function unittest_ftl() { 54 $valgrind $testdir/lib/ftl/ftl_band.c/ftl_band_ut 55 $valgrind $testdir/lib/ftl/ftl_bitmap.c/ftl_bitmap_ut 56 $valgrind $testdir/lib/ftl/ftl_io.c/ftl_io_ut 57 $valgrind $testdir/lib/ftl/ftl_mngt/ftl_mngt_ut 58 $valgrind $testdir/lib/ftl/ftl_mempool.c/ftl_mempool_ut 59 $valgrind $testdir/lib/ftl/ftl_l2p/ftl_l2p_ut 60 $valgrind $testdir/lib/ftl/ftl_sb/ftl_sb_ut 61 $valgrind $testdir/lib/ftl/ftl_layout_upgrade/ftl_layout_upgrade_ut 62} 63 64function unittest_iscsi() { 65 $valgrind $testdir/lib/iscsi/conn.c/conn_ut 66 $valgrind $testdir/lib/iscsi/param.c/param_ut 67 $valgrind $testdir/lib/iscsi/tgt_node.c/tgt_node_ut 68 $valgrind $testdir/lib/iscsi/iscsi.c/iscsi_ut 69 $valgrind $testdir/lib/iscsi/init_grp.c/init_grp_ut 70 $valgrind $testdir/lib/iscsi/portal_grp.c/portal_grp_ut 71} 72 73function unittest_json() { 74 $valgrind $testdir/lib/json/json_parse.c/json_parse_ut 75 $valgrind $testdir/lib/json/json_util.c/json_util_ut 76 $valgrind $testdir/lib/json/json_write.c/json_write_ut 77 $valgrind $testdir/lib/jsonrpc/jsonrpc_server.c/jsonrpc_server_ut 78} 79 80function unittest_rpc() { 81 $valgrind $testdir/lib/rpc/rpc.c/rpc_ut 82} 83 84function unittest_nvme() { 85 $valgrind $testdir/lib/nvme/nvme.c/nvme_ut 86 $valgrind $testdir/lib/nvme/nvme_ctrlr.c/nvme_ctrlr_ut 87 $valgrind $testdir/lib/nvme/nvme_ctrlr_cmd.c/nvme_ctrlr_cmd_ut 88 $valgrind $testdir/lib/nvme/nvme_ctrlr_ocssd_cmd.c/nvme_ctrlr_ocssd_cmd_ut 89 $valgrind $testdir/lib/nvme/nvme_ns.c/nvme_ns_ut 90 $valgrind $testdir/lib/nvme/nvme_ns_cmd.c/nvme_ns_cmd_ut 91 $valgrind $testdir/lib/nvme/nvme_ns_ocssd_cmd.c/nvme_ns_ocssd_cmd_ut 92 $valgrind $testdir/lib/nvme/nvme_qpair.c/nvme_qpair_ut 93 $valgrind $testdir/lib/nvme/nvme_pcie.c/nvme_pcie_ut 94 $valgrind $testdir/lib/nvme/nvme_poll_group.c/nvme_poll_group_ut 95 $valgrind $testdir/lib/nvme/nvme_quirks.c/nvme_quirks_ut 96 $valgrind $testdir/lib/nvme/nvme_tcp.c/nvme_tcp_ut 97 $valgrind $testdir/lib/nvme/nvme_transport.c/nvme_transport_ut 98 $valgrind $testdir/lib/nvme/nvme_io_msg.c/nvme_io_msg_ut 99 $valgrind $testdir/lib/nvme/nvme_pcie_common.c/nvme_pcie_common_ut 100 $valgrind $testdir/lib/nvme/nvme_fabric.c/nvme_fabric_ut 101 $valgrind $testdir/lib/nvme/nvme_opal.c/nvme_opal_ut 102} 103 104function unittest_nvmf() { 105 $valgrind $testdir/lib/nvmf/ctrlr.c/ctrlr_ut 106 $valgrind $testdir/lib/nvmf/ctrlr_bdev.c/ctrlr_bdev_ut 107 $valgrind $testdir/lib/nvmf/ctrlr_discovery.c/ctrlr_discovery_ut 108 $valgrind $testdir/lib/nvmf/subsystem.c/subsystem_ut 109 $valgrind $testdir/lib/nvmf/tcp.c/tcp_ut 110 $valgrind $testdir/lib/nvmf/nvmf.c/nvmf_ut 111} 112 113function unittest_scsi() { 114 $valgrind $testdir/lib/scsi/dev.c/dev_ut 115 $valgrind $testdir/lib/scsi/lun.c/lun_ut 116 $valgrind $testdir/lib/scsi/scsi.c/scsi_ut 117 $valgrind $testdir/lib/scsi/scsi_bdev.c/scsi_bdev_ut 118 $valgrind $testdir/lib/scsi/scsi_pr.c/scsi_pr_ut 119} 120 121function unittest_sock() { 122 $valgrind $testdir/lib/sock/sock.c/sock_ut 123 $valgrind $testdir/lib/sock/posix.c/posix_ut 124 # Check whether uring is configured 125 if grep -q '#define SPDK_CONFIG_URING 1' $rootdir/include/spdk/config.h; then 126 $valgrind $testdir/lib/sock/uring.c/uring_ut 127 fi 128} 129 130function unittest_util() { 131 $valgrind $testdir/lib/util/base64.c/base64_ut 132 $valgrind $testdir/lib/util/bit_array.c/bit_array_ut 133 $valgrind $testdir/lib/util/cpuset.c/cpuset_ut 134 $valgrind $testdir/lib/util/crc16.c/crc16_ut 135 $valgrind $testdir/lib/util/crc32_ieee.c/crc32_ieee_ut 136 $valgrind $testdir/lib/util/crc32c.c/crc32c_ut 137 $valgrind $testdir/lib/util/string.c/string_ut 138 $valgrind $testdir/lib/util/dif.c/dif_ut 139 $valgrind $testdir/lib/util/iov.c/iov_ut 140 $valgrind $testdir/lib/util/math.c/math_ut 141 $valgrind $testdir/lib/util/pipe.c/pipe_ut 142 $valgrind $testdir/lib/util/xor.c/xor_ut 143} 144 145function unittest_init() { 146 $valgrind $testdir/lib/init/subsystem.c/subsystem_ut 147} 148 149if [ $SPDK_RUN_VALGRIND -eq 1 ] && [ $SPDK_RUN_ASAN -eq 1 ]; then 150 echo "ERR: Tests cannot be run if both SPDK_RUN_VALGRIND and SPDK_RUN_ASAN options are selected simultaneously" 151 exit 1 152fi 153 154# if ASAN is enabled, use it. If not use valgrind if installed but allow 155# the env variable to override the default shown below. 156if [ -z ${valgrind+x} ]; then 157 if grep -q '#undef SPDK_CONFIG_ASAN' $rootdir/include/spdk/config.h && hash valgrind; then 158 valgrind='valgrind --leak-check=full --error-exitcode=2 --verbose' 159 else 160 valgrind='' 161 fi 162fi 163if [ $SPDK_RUN_VALGRIND -eq 1 ]; then 164 if [ -n "$valgrind" ]; then 165 run_test "valgrind" echo "Using valgrind for unit tests" 166 else 167 echo "ERR: SPDK_RUN_VALGRIND option is enabled but valgrind is not available" 168 exit 1 169 fi 170fi 171 172# setup local unit test coverage if cov is available 173# lcov takes considerable time to process clang coverage. 174# Disabling lcov allow us to do this. 175# More information: https://github.com/spdk/spdk/issues/1693 176CC_TYPE=$(grep CC_TYPE $rootdir/mk/cc.mk) 177if hash lcov && grep -q '#define SPDK_CONFIG_COVERAGE 1' $rootdir/include/spdk/config.h && ! [[ "$CC_TYPE" == *"clang"* ]]; then 178 cov_avail="yes" 179else 180 cov_avail="no" 181fi 182if [ "$cov_avail" = "yes" ]; then 183 # set unit test output dir if not specified in env var 184 if [[ -z $output_dir ]]; then 185 UT_COVERAGE="ut_coverage" 186 else 187 UT_COVERAGE=$output_dir/ut_coverage 188 fi 189 mkdir -p $UT_COVERAGE 190 export LCOV_OPTS=" 191 --rc lcov_branch_coverage=1 192 --rc lcov_function_coverage=1 193 --rc genhtml_branch_coverage=1 194 --rc genhtml_function_coverage=1 195 --rc genhtml_legend=1 196 --rc geninfo_all_blocks=1 197 " 198 export LCOV="lcov $LCOV_OPTS --no-external" 199 # zero out coverage data 200 $LCOV -q -c -i -d . -t "Baseline" -o $UT_COVERAGE/ut_cov_base.info 201fi 202 203# workaround for valgrind v3.13 on arm64 204if [ $(uname -m) = "aarch64" ]; then 205 export LD_HWCAP_MASK=1 206fi 207 208run_test "unittest_pci_event" $valgrind $testdir/lib/env_dpdk/pci_event.c/pci_event_ut 209run_test "unittest_include" $valgrind $testdir/include/spdk/histogram_data.h/histogram_ut 210run_test "unittest_bdev" unittest_bdev 211if grep -q '#define SPDK_CONFIG_CRYPTO 1' $rootdir/include/spdk/config.h; then 212 run_test "unittest_bdev_crypto" $valgrind $testdir/lib/bdev/crypto.c/crypto_ut 213 run_test "unittest_bdev_crypto" $valgrind $testdir/lib/accel/dpdk_cryptodev.c/accel_dpdk_cryptodev_ut 214fi 215 216if grep -q '#define SPDK_CONFIG_VBDEV_COMPRESS 1' $rootdir/include/spdk/config.h; then 217 run_test "unittest_bdev_compress" $valgrind $testdir/lib/bdev/compress.c/compress_ut 218 run_test "unittest_lib_reduce" $valgrind $testdir/lib/reduce/reduce.c/reduce_ut 219fi 220 221if grep -q '#define SPDK_CONFIG_DPDK_COMPRESSDEV 1' $rootdir/include/spdk/config.h; then 222 run_test "unittest_dpdk_compressdev" $valgrind $testdir/lib/accel/dpdk_compressdev.c/accel_dpdk_compressdev_ut 223fi 224 225if grep -q '#define SPDK_CONFIG_RAID5F 1' $rootdir/include/spdk/config.h; then 226 run_test "unittest_bdev_raid5f" $valgrind $testdir/lib/bdev/raid/raid5f.c/raid5f_ut 227fi 228 229run_test "unittest_blob_blobfs" unittest_blob 230run_test "unittest_event" unittest_event 231if [ $(uname -s) = Linux ]; then 232 run_test "unittest_ftl" unittest_ftl 233fi 234 235run_test "unittest_accel" $valgrind $testdir/lib/accel/accel.c/accel_ut 236run_test "unittest_ioat" $valgrind $testdir/lib/ioat/ioat.c/ioat_ut 237if grep -q '#define SPDK_CONFIG_IDXD 1' $rootdir/include/spdk/config.h; then 238 run_test "unittest_idxd_user" $valgrind $testdir/lib/idxd/idxd_user.c/idxd_user_ut 239fi 240run_test "unittest_iscsi" unittest_iscsi 241run_test "unittest_json" unittest_json 242run_test "unittest_rpc" unittest_rpc 243run_test "unittest_notify" $valgrind $testdir/lib/notify/notify.c/notify_ut 244run_test "unittest_nvme" unittest_nvme 245run_test "unittest_log" $valgrind $testdir/lib/log/log.c/log_ut 246run_test "unittest_lvol" $valgrind $testdir/lib/lvol/lvol.c/lvol_ut 247if grep -q '#define SPDK_CONFIG_RDMA 1' $rootdir/include/spdk/config.h; then 248 run_test "unittest_nvme_rdma" $valgrind $testdir/lib/nvme/nvme_rdma.c/nvme_rdma_ut 249 run_test "unittest_nvmf_transport" $valgrind $testdir/lib/nvmf/transport.c/transport_ut 250 run_test "unittest_rdma" $valgrind $testdir/lib/rdma/common.c/common_ut 251fi 252 253if grep -q '#define SPDK_CONFIG_NVME_CUSE 1' $rootdir/include/spdk/config.h; then 254 run_test "unittest_nvme_cuse" $valgrind $testdir/lib/nvme/nvme_cuse.c/nvme_cuse_ut 255fi 256 257run_test "unittest_nvmf" unittest_nvmf 258if grep -q '#define SPDK_CONFIG_FC 1' $rootdir/include/spdk/config.h; then 259 run_test "unittest_nvmf_fc" $valgrind $testdir/lib/nvmf/fc.c/fc_ut 260 run_test "unittest_nvmf_fc_ls" $valgrind $testdir/lib/nvmf/fc_ls.c/fc_ls_ut 261fi 262 263if grep -q '#define SPDK_CONFIG_RDMA 1' $rootdir/include/spdk/config.h; then 264 run_test "unittest_nvmf_rdma" $valgrind $testdir/lib/nvmf/rdma.c/rdma_ut 265fi 266 267run_test "unittest_scsi" unittest_scsi 268run_test "unittest_sock" unittest_sock 269run_test "unittest_thread" $valgrind $testdir/lib/thread/thread.c/thread_ut 270run_test "unittest_util" unittest_util 271if grep -q '#define SPDK_CONFIG_VHOST 1' $rootdir/include/spdk/config.h; then 272 run_test "unittest_vhost" $valgrind $testdir/lib/vhost/vhost.c/vhost_ut 273fi 274run_test "unittest_dma" $valgrind $testdir/lib/dma/dma.c/dma_ut 275 276run_test "unittest_init" unittest_init 277 278if [ "$cov_avail" = "yes" ] && ! [[ "$CC_TYPE" == *"clang"* ]]; then 279 $LCOV -q -d . -c -t "$(hostname)" -o $UT_COVERAGE/ut_cov_test.info 280 $LCOV -q -a $UT_COVERAGE/ut_cov_base.info -a $UT_COVERAGE/ut_cov_test.info -o $UT_COVERAGE/ut_cov_total.info 281 $LCOV -q -a $UT_COVERAGE/ut_cov_total.info -o $UT_COVERAGE/ut_cov_unit.info 282 $LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/app/*" -o $UT_COVERAGE/ut_cov_unit.info 283 $LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/dpdk/*" -o $UT_COVERAGE/ut_cov_unit.info 284 $LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/examples/*" -o $UT_COVERAGE/ut_cov_unit.info 285 $LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/lib/vhost/rte_vhost/*" -o $UT_COVERAGE/ut_cov_unit.info 286 $LCOV -q -r $UT_COVERAGE/ut_cov_unit.info "$rootdir/test/*" -o $UT_COVERAGE/ut_cov_unit.info 287 rm -f $UT_COVERAGE/ut_cov_base.info $UT_COVERAGE/ut_cov_test.info 288 genhtml $UT_COVERAGE/ut_cov_unit.info --output-directory $UT_COVERAGE 289 # git -C option not used for compatibility reasons 290 owner=$(stat -c "%U" $rootdir) 291 cd $rootdir 292 sudo -u $owner git clean -f "*.gcda" 293fi 294 295set +x 296 297echo 298echo 299echo "=====================" 300echo "All unit tests passed" 301echo "=====================" 302if [ "$cov_avail" = "yes" ]; then 303 echo "Note: coverage report is here: $rootdir/$UT_COVERAGE" 304else 305 echo "WARN: lcov not installed or SPDK built without coverage!" 306fi 307if grep -q '#undef SPDK_CONFIG_ASAN' $rootdir/include/spdk/config.h && [ "$valgrind" = "" ]; then 308 echo "WARN: neither valgrind nor ASAN is enabled!" 309fi 310 311echo 312echo 313