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