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