1#!/usr/bin/env bash 2# SPDX-License-Identifier: BSD-3-Clause 3# Copyright (C) 2022 Intel Corporation. 4# All rights reserved. 5 6spdk_conf=${spdk_conf:-"$1"} 7 8if [[ ! -f $spdk_conf ]]; then 9 echo "ERROR: SPDK test configuration not specified" 10 return 1 11fi 12 13source "$spdk_conf" 14source "$rootdir/test/common/autotest_common.sh" 15source "$rootdir/scripts/common.sh" 16 17_ocf_precompile() { 18 # We compile OCF sources ourselves 19 # They don't need to be checked with scanbuild and code coverage is not applicable 20 # So we precompile OCF now for further use as standalone static library 21 "$rootdir/configure" $(echo $config_params | sed 's/--enable-coverage//g') 22 $MAKE $MAKEFLAGS include/spdk/config.h 23 CC=gcc CCAR=ar $MAKE $MAKEFLAGS -C "$rootdir/lib/env_ocf" exportlib O="$rootdir/ocf.a" 24 # Set config to use precompiled library 25 config_params="$config_params --with-ocf=/$rootdir/ocf.a" 26 # need to reconfigure to avoid clearing ocf related files on future make clean. 27 "$rootdir/configure" $config_params 28} 29 30# Find matching llvm fuzzer library and clang compiler version 31_llvm_precompile() { 32 [[ $(clang --version) =~ "version "(([0-9]+).([0-9]+).([0-9]+)) ]] 33 clang_num=${BASH_REMATCH[2]} 34 35 export CC=clang-$clang_num 36 export CXX=clang++-$clang_num 37 38 fuzzer_libs=(/usr/lib*/clang/@("$clang_num"|"$clang_version")/lib/*linux*/libclang_rt.fuzzer_no_main?(-x86_64).a) 39 fuzzer_lib=${fuzzer_libs[0]} 40 [[ -e $fuzzer_lib ]] 41 42 config_params="$config_params --with-fuzzer=$fuzzer_lib" 43 # need to reconfigure to avoid clearing llvm related files on future make clean. 44 "$rootdir/configure" $config_params 45} 46 47_build_native_dpdk() { 48 local external_dpdk_dir 49 local external_dpdk_base_dir 50 local compiler_version 51 local compiler 52 local dpdk_kmods 53 local repo='dpdk' 54 55 compiler=${CC:-gcc} 56 57 # Export CC to be absolutely sure it's set. 58 # If CC was not set and we defaulted to "gcc" then we need to do the export 59 # so that "meson build" command a few lines below is aware of which compiler 60 # to use. 61 export CC="$compiler" 62 63 if [[ $compiler != *clang* && $compiler != *gcc* ]]; then 64 echo "Unsupported compiler detected ($compiler), failing the test" >&2 65 return 1 66 fi 67 68 compiler_version=$("$compiler" -dumpversion) 69 compiler_version=${compiler_version%%.*} 70 external_dpdk_dir="$SPDK_RUN_EXTERNAL_DPDK" 71 external_dpdk_base_dir="$(dirname $external_dpdk_dir)" 72 73 if [[ ! -d "$external_dpdk_base_dir" ]]; then 74 if [[ $SPDK_TEST_NATIVE_DPDK != 'main' ]]; then 75 repo='dpdk-stable' 76 fi 77 echo "DPDK directory does not exist at the provided location." 78 sudo mkdir -p "$external_dpdk_base_dir" 79 sudo chown -R $(whoami) "$external_dpdk_base_dir"/.. 80 git clone --branch "$SPDK_TEST_NATIVE_DPDK" --depth 1 http://dpdk.org/git/${repo} "$external_dpdk_base_dir" 81 fi 82 orgdir=$PWD 83 git -C "$external_dpdk_base_dir" log --oneline -n 5 84 85 dpdk_cflags="-fPIC -g -fcommon" 86 dpdk_ldflags="" 87 dpdk_ver=$(< "$external_dpdk_base_dir/VERSION") 88 89 if [[ $compiler == *gcc* && $compiler_version -ge 5 ]]; then 90 dpdk_cflags+=" -Werror" 91 fi 92 93 if [[ $compiler == *gcc* && $compiler_version -ge 10 ]]; then 94 dpdk_cflags+=" -Wno-stringop-overflow" 95 fi 96 97 # the drivers we use 98 # net/i40e driver is not really needed by us, but it's built as a workaround 99 # for DPDK issue: https://bugs.dpdk.org/show_bug.cgi?id=576 100 DPDK_DRIVERS=("bus" "bus/pci" "bus/vdev" "mempool/ring" "net/i40e" "net/i40e/base") 101 102 local mlx5_libs_added="n" 103 if [[ "$SPDK_TEST_CRYPTO" -eq 1 || "$SPDK_TEST_SMA" -eq 1 ]]; then 104 intel_ipsec_mb_ver=v0.54 105 intel_ipsec_mb_drv=crypto/aesni_mb 106 intel_ipsec_lib="" 107 if ge "$dpdk_ver" 21.11.0; then 108 # Minimum supported version of intel-ipsec-mb, for DPDK >= 21.11, is 1.0. 109 # Source of the aesni_mb driver was moved to ipsec_mb. .{h,so,a} were moved 110 # to ./lib. 111 # https://github.com/dpdk/dpdk/commit/918fd2f1466b0e3b21a033df7012a77a83665582. 112 intel_ipsec_mb_ver=v1.0 113 intel_ipsec_mb_drv=crypto/ipsec_mb 114 intel_ipsec_lib=lib 115 fi 116 git clone --branch "$intel_ipsec_mb_ver" --depth 1 https://github.com/intel/intel-ipsec-mb.git "$external_dpdk_base_dir/intel-ipsec-mb" 117 cd "$external_dpdk_base_dir/intel-ipsec-mb" 118 $MAKE $MAKEFLAGS all SHARED=y EXTRA_CFLAGS=-fPIC 119 DPDK_DRIVERS+=("crypto") 120 DPDK_DRIVERS+=("$intel_ipsec_mb_drv") 121 DPDK_DRIVERS+=("crypto/qat") 122 DPDK_DRIVERS+=("compress/qat") 123 DPDK_DRIVERS+=("common/qat") 124 # 21.11.0 is version of DPDK with stable support for mlx5 crypto. 125 if ge "$dpdk_ver" 21.11.0; then 126 # SPDK enables CRYPTO_MLX in case supported version of DPDK is detected 127 # so make sure proper libs are built. 128 DPDK_DRIVERS+=("bus/auxiliary") 129 DPDK_DRIVERS+=("common/mlx5") 130 DPDK_DRIVERS+=("common/mlx5/linux") 131 DPDK_DRIVERS+=("crypto/mlx5") 132 mlx5_libs_added="y" 133 fi 134 dpdk_cflags+=" -I$external_dpdk_base_dir/intel-ipsec-mb/$intel_ipsec_lib" 135 dpdk_ldflags+=" -L$external_dpdk_base_dir/intel-ipsec-mb/$intel_ipsec_lib" 136 export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$external_dpdk_base_dir/intel-ipsec-mb/$intel_ipsec_lib" 137 fi 138 139 if [[ "$SPDK_TEST_VBDEV_COMPRESS" -eq 1 ]]; then 140 isal_dir="$external_dpdk_base_dir/isa-l" 141 git clone --branch v2.29.0 --depth 1 https://github.com/intel/isa-l.git "$isal_dir" 142 143 cd $isal_dir 144 ./autogen.sh 145 ./configure CFLAGS="-fPIC -g -O2" --enable-shared=yes --prefix="$isal_dir/build" 146 ln -s $PWD/include $PWD/isa-l 147 $MAKE $MAKEFLAGS all 148 $MAKE install 149 DPDK_DRIVERS+=("compress") 150 DPDK_DRIVERS+=("compress/isal") 151 DPDK_DRIVERS+=("compress/qat") 152 DPDK_DRIVERS+=("common/qat") 153 if ge "$dpdk_ver" 21.02.0; then 154 # SPDK enables REDUCE_MLX in case supported version of DPDK is detected 155 # so make sure proper libs are built. 156 if test $mlx5_libs_added = "n"; then 157 DPDK_DRIVERS+=("bus/auxiliary") 158 DPDK_DRIVERS+=("common/mlx5") 159 DPDK_DRIVERS+=("common/mlx5/linux") 160 fi 161 DPDK_DRIVERS+=("compress/mlx5") 162 fi 163 export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$isal_dir/build/lib/pkgconfig" 164 export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$isal_dir/build/lib" 165 fi 166 167 cd $external_dpdk_base_dir 168 if [ "$(uname -s)" = "Linux" ]; then 169 if lt $dpdk_ver 21.11.0; then 170 patch -p1 < "$rootdir/test/common/config/pkgdep/patches/dpdk/20.11/dpdk_pci.patch" 171 patch -p1 < "$rootdir/test/common/config/pkgdep/patches/dpdk/20.11/dpdk_qat.patch" 172 else 173 patch -p1 < "$rootdir/test/common/config/pkgdep/patches/dpdk/21.11+/dpdk_qat.patch" 174 fi 175 fi 176 177 dpdk_kmods="false" 178 if [ "$(uname -s)" = "FreeBSD" ]; then 179 dpdk_kmods="true" 180 fi 181 182 meson build-tmp --prefix="$external_dpdk_dir" --libdir lib \ 183 -Denable_docs=false -Denable_kmods="$dpdk_kmods" -Dtests=false \ 184 -Dc_link_args="$dpdk_ldflags" -Dc_args="$dpdk_cflags" \ 185 -Dmachine=native -Denable_drivers=$(printf "%s," "${DPDK_DRIVERS[@]}") 186 ninja -C "$external_dpdk_base_dir/build-tmp" $MAKEFLAGS 187 ninja -C "$external_dpdk_base_dir/build-tmp" $MAKEFLAGS install 188 189 if [[ $(uname -s) == "FreeBSD" ]]; then 190 # Make sure kernel modules are available for freebsd_update_contigmem_mod() to fetch 191 mapfile -t drivers < <(find "$external_dpdk_base_dir/build-tmp" -name '*.ko') 192 if ((${#drivers[@]} > 0)); then 193 mkdir -p "$external_dpdk_dir/kmod" 194 cp -f "${drivers[@]}" "$external_dpdk_dir/kmod/" 195 fi 196 fi 197 198 # Save this path. In tests are run using autorun.sh then autotest.sh 199 # script will be unaware of LD_LIBRARY_PATH and will fail tests. 200 cat <<- LD_PATH > /tmp/spdk-ld-path 201 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH 202 export PKG_CONFIG_PATH=$PKG_CONFIG_PATH 203 LD_PATH 204 205 cd "$orgdir" 206} 207 208check_dpdk_pci_api() { 209 local dpdk_dir 210 211 if [[ -n "$SPDK_TEST_NATIVE_DPDK" ]]; then 212 dpdk_dir=$(dirname "$SPDK_RUN_EXTERNAL_DPDK") 213 fi 214 215 "$rootdir/scripts/env_dpdk/check_dpdk_pci_api.sh" check "$dpdk_dir" 216} 217 218make_fail_cleanup() { 219 if [ -d $out/scan-build-tmp ]; then 220 scanoutput=$(ls -1 $out/scan-build-tmp/) 221 mv $out/scan-build-tmp/$scanoutput $out/scan-build 222 rm -rf $out/scan-build-tmp 223 chmod -R a+rX $out/scan-build 224 fi 225 false 226} 227 228_scanbuild_make() { 229 pass=true 230 "$rootdir/configure" $config_params --without-shared 231 $scanbuild $MAKE $MAKEFLAGS > $out/build_output.txt && rm -rf $out/scan-build-tmp || make_fail_cleanup 232 xtrace_disable 233 234 rm -f $out/*files.txt 235 for ent in $(find app examples lib module test -type f | grep -vF ".h"); do 236 if [[ $ent == lib/env_ocf* ]]; then continue; fi 237 if file -bi $ent | grep -q 'text/x-c'; then 238 echo $ent | sed 's/\.cp\{0,2\}$//g' >> $out/all_c_files.txt 239 fi 240 done 241 xtrace_restore 242 243 grep -E "CC|CXX" $out/build_output.txt | sed 's/\s\s\(CC\|CXX\)\s//g' | sed 's/\.o//g' > $out/built_c_files.txt 244 cat $rootdir/test/common/skipped_build_files.txt >> $out/built_c_files.txt 245 246 sort -o $out/all_c_files.txt $out/all_c_files.txt 247 sort -o $out/built_c_files.txt $out/built_c_files.txt 248 # from comm manual: 249 # -2 suppress column 2 (lines unique to FILE2) 250 # -3 suppress column 3 (lines that appear in both files) 251 # comm may exit 1 if no lines were printed (undocumented, unreliable) 252 comm -2 -3 $out/all_c_files.txt $out/built_c_files.txt > $out/unbuilt_c_files.txt || true 253 254 if [ $(wc -l < $out/unbuilt_c_files.txt) -ge 1 ]; then 255 echo "missing files" 256 cat <<- ERROR 257 The following C files were not built. Either scanbuild CI job needs to 258 be updated with proper flags to build these files, or exceptions need 259 to be added to test/common/skipped_build_files.txt 260 261 $(<"$out/unbuilt_c_files.txt") 262 ERROR 263 pass=false 264 fi 265 266 $pass 267} 268 269porcelain_check() { 270 if [ $(git status --porcelain --ignore-submodules | wc -l) -ne 0 ]; then 271 echo "Generated files missing from .gitignore:" 272 git status --porcelain --ignore-submodules 273 exit 1 274 fi 275} 276 277# Check that header file dependencies are working correctly by 278# capturing a binary's stat data before and after touching a 279# header file and re-making. 280header_dependency_check() { 281 STAT1=$(stat $SPDK_BIN_DIR/spdk_tgt) 282 sleep 1 283 touch "$rootdir/lib/nvme/nvme_internal.h" 284 $MAKE $MAKEFLAGS 285 STAT2=$(stat $SPDK_BIN_DIR/spdk_tgt) 286 287 if [ "$STAT1" == "$STAT2" ]; then 288 echo "Header dependency check failed" 289 false 290 fi 291} 292 293test_make_install() { 294 $MAKE $MAKEFLAGS install DESTDIR="$SPDK_WORKSPACE" prefix=/usr 295} 296 297test_make_uninstall() { 298 # Create empty file to check if it is not deleted by target uninstall 299 touch "$SPDK_WORKSPACE/usr/lib/sample_xyz.a" 300 $MAKE $MAKEFLAGS uninstall DESTDIR="$SPDK_WORKSPACE" prefix=/usr 301 if [[ $(find "$SPDK_WORKSPACE/usr" -type f -print | wc -l) -ne 1 ]]; then 302 ls -lR "$SPDK_WORKSPACE" 303 echo "Make uninstall failed" 304 exit 1 305 fi 306} 307 308_build_doc() { 309 local doxygenv 310 doxygenv=$(doxygen --version) 311 312 $MAKE -C "$rootdir"/doc --no-print-directory $MAKEFLAGS Q=@ &> "$out"/doxygen.log 313 if [ -s "$out"/doxygen.log ]; then 314 if [[ "$doxygenv" == "1.8.20" ]]; then 315 # Doxygen 1.8.20 produces false positives, see: 316 # https://github.com/doxygen/doxygen/issues/7948 317 grep -vE '\\ilinebr' 318 elif [[ "$doxygenv" == "1.9.5" ]]; then 319 # Doxygen 1.9.5 produces false positives, see: 320 # https://github.com/doxygen/doxygen/issues/9552 and 321 # https://github.com/doxygen/doxygen/issues/9678 322 grep -vE '\\ifile|@param' 323 else 324 cat - 325 fi < "$out/doxygen.log" && echo "Doxygen errors found!" && return 1 326 327 echo "Doxygen $doxygenv detected. No warnings except false positives, continuing the test" 328 fi 329 if hash pdflatex 2> /dev/null; then 330 $MAKE -C "$rootdir"/doc/output/latex --no-print-directory $MAKEFLAGS &>> "$out"/doxygen.log 331 fi 332 mkdir -p "$out"/doc 333 # Copy and remove files to avoid mv: failed to preserve ownership error 334 cp -r --preserve=mode "$rootdir"/doc/output/html "$out"/doc 335 rm -rf "$rootdir"/doc/output/html 336 if [ -f "$rootdir"/doc/output/latex/refman.pdf ]; then 337 mv "$rootdir"/doc/output/latex/refman.pdf "$out"/doc/spdk.pdf 338 fi 339 $MAKE -C "$rootdir"/doc --no-print-directory $MAKEFLAGS clean &>> "$out"/doxygen.log 340 if [ -s "$out"/doxygen.log ]; then 341 # Save the log as an artifact in case we are working with potentially broken version 342 eq "$doxygenv" 1.8.20 || rm "$out"/doxygen.log 343 fi 344 rm -rf "$rootdir"/doc/output 345} 346 347check_format() { 348 run_test "autobuild_check_format" "$rootdir/scripts/check_format.sh" 349} 350 351check_so_deps() { 352 run_test "autobuild_check_so_deps" "$rootdir/test/make/check_so_deps.sh" -c "$spdk_conf" -a "$SPDK_ABI_DIR" 353} 354 355external_code() { 356 run_test "autobuild_external_code" "$rootdir/test/external_code/test_make.sh" "$rootdir" 357} 358 359dpdk_pci_api() { 360 run_test "autobuild_check_dpdk_pci_api" check_dpdk_pci_api 361} 362 363build_files() { 364 "$rootdir/configure" $config_params --without-shared 365 $MAKE $MAKEFLAGS 366 run_test "autobuild_generated_files_check" porcelain_check 367 run_test "autobuild_header_dependency_check" header_dependency_check 368 run_test "autobuild_make_install" test_make_install 369 run_test "autobuild_make_uninstall" test_make_uninstall 370 $MAKE clean 371 run_test "autobuild_generated_files_check_post_clean" porcelain_check 372} 373 374build_doc() { 375 run_test "autobuild_build_doc" _build_doc 376} 377 378autobuild_test_suite_tiny() { 379 check_format 380 check_so_deps 381 dpdk_pci_api 382} 383 384autobuild_test_suite_ext() { 385 external_code 386} 387 388autobuild_test_suite_full() { 389 autobuild_test_suite_tiny 390 autobuild_test_suite_ext 391 build_files 392 build_doc 393} 394 395_autobuild_test_suite() { 396 case "$SPDK_TEST_AUTOBUILD" in 397 tiny) autobuild_test_suite_tiny ;; 398 ext) autobuild_test_suite_ext ;; 399 full) autobuild_test_suite_full ;; 400 esac 401} 402 403_unittest_build() { 404 "$rootdir/configure" $config_params --without-shared 405 $MAKE $MAKEFLAGS 406} 407 408autobuild_test_suite() { 409 run_test "autobuild" _autobuild_test_suite 410} 411 412unittest_build() { 413 run_test "unittest_build" _unittest_build 414} 415 416scanbuild_make() { 417 run_test "scanbuild_make" _scanbuild_make 418} 419 420ocf_precompile() { 421 run_test "autobuild_ocf_precompile" _ocf_precompile 422} 423 424llvm_precompile() { 425 run_test "autobuild_llvm_precompile" _llvm_precompile 426} 427 428build_native_dpdk() { 429 run_test "build_native_dpdk" _build_native_dpdk 430} 431 432build_packaging() { 433 run_test "packaging" "$rootdir/test/packaging/packaging.sh" 434} 435 436out=$output_dir 437SPDK_WORKSPACE=$(mktemp -dt "spdk_$(date +%s).XXXXXX") 438 439if [[ -n $EXTERNAL_MAKE_HUGEMEM ]]; then 440 export EXTERNAL_MAKE_HUGEMEM 441fi 442 443if [ -n "$SPDK_TEST_NATIVE_DPDK" ]; then 444 scanbuild_exclude=" --exclude $(dirname $SPDK_RUN_EXTERNAL_DPDK)" 445else 446 scanbuild_exclude="--exclude $rootdir/dpdk/" 447fi 448# We exclude /tmp as it's used by xnvme's liburing subproject for storing 449# temporary .c files which are picked up as buggy by the scanbuild. 450scanbuild_exclude+=" --exclude $rootdir/xnvme --exclude /tmp" 451 452scanbuild="scan-build -o $output_dir/scan-build-tmp $scanbuild_exclude --status-bugs" 453config_params=$(get_config_params) 454 455start_monitor_resources 456trap 'stop_monitor_resources' EXIT 457