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