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 if lt "$dpdk_ver" 24.07.0; then 177 patch -p1 < "$rootdir/test/common/config/pkgdep/patches/dpdk/24.03/pcapng-add-memcpy-check.patch" 178 fi 179 if ge "$dpdk_ver" 24.07.0; then 180 patch -p1 < "$rootdir/test/common/config/pkgdep/patches/dpdk/24.07/uio-open-in-primary.patch" 181 fi 182 183 dpdk_kmods="false" 184 if [ "$(uname -s)" = "FreeBSD" ]; then 185 dpdk_kmods="true" 186 fi 187 188 meson build-tmp --prefix="$external_dpdk_dir" --libdir lib \ 189 -Denable_docs=false -Denable_kmods="$dpdk_kmods" -Dtests=false \ 190 -Dc_link_args="$dpdk_ldflags" -Dc_args="$dpdk_cflags" \ 191 -Dmachine=native -Denable_drivers=$(printf "%s," "${DPDK_DRIVERS[@]}") 192 ninja -C "$external_dpdk_base_dir/build-tmp" $MAKEFLAGS 193 194 if [[ $(uname -s) == "FreeBSD" ]]; then 195 # Under FreeBSD, install requires root privileges since it also attempts to install 196 # requested drivers under /boot. 197 sudo -E ninja -C "$external_dpdk_base_dir/build-tmp" $MAKEFLAGS install 198 # Sanitize ownership of the target directory post sudo above 199 sudo chown -R "$USER" "$external_dpdk_base_dir" 200 # Make sure kernel modules are available for freebsd_update_contigmem_mod() to fetch 201 mapfile -t drivers < <(find "$external_dpdk_base_dir/build-tmp" -name '*.ko') 202 if ((${#drivers[@]} > 0)); then 203 mkdir -p "$external_dpdk_dir/kmod" 204 cp -f "${drivers[@]}" "$external_dpdk_dir/kmod/" 205 fi 206 else 207 ninja -C "$external_dpdk_base_dir/build-tmp" $MAKEFLAGS install 208 209 fi 210 211 # Save this path. In tests are run using autorun.sh then autotest.sh 212 # script will be unaware of LD_LIBRARY_PATH and will fail tests. 213 cat <<- LD_PATH > /tmp/spdk-ld-path 214 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH 215 export PKG_CONFIG_PATH=$PKG_CONFIG_PATH 216 LD_PATH 217 218 cd "$orgdir" 219} 220 221check_dpdk_pci_api() { 222 local dpdk_dir 223 224 if [[ -n "$SPDK_TEST_NATIVE_DPDK" ]]; then 225 dpdk_dir=$(dirname "$SPDK_RUN_EXTERNAL_DPDK") 226 fi 227 228 "$rootdir/scripts/env_dpdk/check_dpdk_pci_api.sh" check "$dpdk_dir" 229} 230 231make_fail_cleanup() { 232 if [ -d $out/scan-build-tmp ]; then 233 scanoutput=$(ls -1 $out/scan-build-tmp/) 234 mv $out/scan-build-tmp/$scanoutput $out/scan-build 235 rm -rf $out/scan-build-tmp 236 chmod -R a+rX $out/scan-build 237 fi 238 false 239} 240 241_scanbuild_make() { 242 pass=true 243 "$rootdir/configure" $config_params --without-shared 244 $scanbuild $MAKE $MAKEFLAGS > $out/build_output.txt && rm -rf $out/scan-build-tmp || make_fail_cleanup 245 xtrace_disable 246 247 rm -f $out/*files.txt 248 for ent in $(find app examples lib module test -type f | grep -vF ".h"); do 249 if [[ $ent == lib/env_ocf* ]]; then continue; fi 250 if file -bi $ent | grep -q 'text/x-c'; then 251 echo $ent | sed 's/\.cp\{0,2\}$//g' >> $out/all_c_files.txt 252 fi 253 done 254 xtrace_restore 255 256 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 257 cat $rootdir/test/common/skipped_build_files.txt >> $out/built_c_files.txt 258 259 sort -o $out/all_c_files.txt $out/all_c_files.txt 260 sort -o $out/built_c_files.txt $out/built_c_files.txt 261 # from comm manual: 262 # -2 suppress column 2 (lines unique to FILE2) 263 # -3 suppress column 3 (lines that appear in both files) 264 # comm may exit 1 if no lines were printed (undocumented, unreliable) 265 comm -2 -3 $out/all_c_files.txt $out/built_c_files.txt > $out/unbuilt_c_files.txt || true 266 267 if [ $(wc -l < $out/unbuilt_c_files.txt) -ge 1 ]; then 268 echo "missing files" 269 cat <<- ERROR 270 The following C files were not built. Either scanbuild CI job needs to 271 be updated with proper flags to build these files, or exceptions need 272 to be added to test/common/skipped_build_files.txt 273 274 $(< "$out/unbuilt_c_files.txt") 275 ERROR 276 pass=false 277 fi 278 279 $pass 280} 281 282porcelain_check() { 283 if [ $(git status --porcelain --ignore-submodules | wc -l) -ne 0 ]; then 284 echo "Generated files missing from .gitignore:" 285 git status --porcelain --ignore-submodules 286 exit 1 287 fi 288} 289 290# Check that header file dependencies are working correctly by 291# capturing a binary's stat data before and after touching a 292# header file and re-making. 293header_dependency_check() { 294 STAT1=$(stat $SPDK_BIN_DIR/spdk_tgt) 295 sleep 1 296 touch "$rootdir/lib/nvme/nvme_internal.h" 297 $MAKE $MAKEFLAGS 298 STAT2=$(stat $SPDK_BIN_DIR/spdk_tgt) 299 300 if [ "$STAT1" == "$STAT2" ]; then 301 echo "Header dependency check failed" 302 false 303 fi 304} 305 306test_make_install() { 307 $MAKE $MAKEFLAGS install DESTDIR="$SPDK_WORKSPACE" prefix=/usr 308} 309 310test_make_uninstall() { 311 # Create empty file to check if it is not deleted by target uninstall 312 touch "$SPDK_WORKSPACE/usr/lib/sample_xyz.a" 313 $MAKE $MAKEFLAGS uninstall DESTDIR="$SPDK_WORKSPACE" prefix=/usr 314 if [[ $(find "$SPDK_WORKSPACE/usr" -type f -print | wc -l) -ne 1 ]]; then 315 ls -lR "$SPDK_WORKSPACE" 316 echo "Make uninstall failed" 317 exit 1 318 fi 319} 320 321_build_doc() { 322 local doxygenv 323 doxygenv=$(doxygen --version) 324 325 $MAKE -C "$rootdir"/doc --no-print-directory $MAKEFLAGS Q=@ &> "$out"/doxygen.log 326 if [ -s "$out"/doxygen.log ]; then 327 if [[ "$doxygenv" == "1.8.20" ]]; then 328 # Doxygen 1.8.20 produces false positives, see: 329 # https://github.com/doxygen/doxygen/issues/7948 330 grep -vE '\\ilinebr' 331 elif [[ "$doxygenv" == "1.9.5" ]]; then 332 # Doxygen 1.9.5 produces false positives, see: 333 # https://github.com/doxygen/doxygen/issues/9552 and 334 # https://github.com/doxygen/doxygen/issues/9678 335 grep -vE '\\ifile|@param' 336 else 337 cat - 338 fi < "$out/doxygen.log" && echo "Doxygen errors found!" && return 1 339 340 echo "Doxygen $doxygenv detected. No warnings except false positives, continuing the test" 341 fi 342 if hash pdflatex 2> /dev/null; then 343 $MAKE -C "$rootdir"/doc/output/latex --no-print-directory $MAKEFLAGS &>> "$out"/doxygen.log 344 fi 345 mkdir -p "$out"/doc 346 # Copy and remove files to avoid mv: failed to preserve ownership error 347 cp -r --preserve=mode "$rootdir"/doc/output/html "$out"/doc 348 rm -rf "$rootdir"/doc/output/html 349 if [ -f "$rootdir"/doc/output/latex/refman.pdf ]; then 350 mv "$rootdir"/doc/output/latex/refman.pdf "$out"/doc/spdk.pdf 351 fi 352 $MAKE -C "$rootdir"/doc --no-print-directory $MAKEFLAGS clean &>> "$out"/doxygen.log 353 if [ -s "$out"/doxygen.log ]; then 354 # Save the log as an artifact in case we are working with potentially broken version 355 eq "$doxygenv" 1.8.20 || rm "$out"/doxygen.log 356 fi 357 rm -rf "$rootdir"/doc/output 358} 359 360check_format() { 361 run_test "autobuild_check_format" "$rootdir/scripts/check_format.sh" 362} 363 364check_so_deps() { 365 run_test "autobuild_check_so_deps" "$rootdir/test/make/check_so_deps.sh" -c "$spdk_conf" -a "$SPDK_ABI_DIR" 366} 367 368external_code() { 369 run_test "autobuild_external_code" "$rootdir/test/external_code/test_make.sh" "$rootdir" 370} 371 372dpdk_pci_api() { 373 run_test "autobuild_check_dpdk_pci_api" check_dpdk_pci_api 374} 375 376build_files() { 377 "$rootdir/configure" $config_params --without-shared 378 $MAKE $MAKEFLAGS 379 run_test "autobuild_generated_files_check" porcelain_check 380 run_test "autobuild_header_dependency_check" header_dependency_check 381 run_test "autobuild_make_install" test_make_install 382 run_test "autobuild_make_uninstall" test_make_uninstall 383 $MAKE clean 384 run_test "autobuild_generated_files_check_post_clean" porcelain_check 385} 386 387build_doc() { 388 run_test "autobuild_build_doc" _build_doc 389} 390 391autobuild_test_suite_tiny() { 392 check_format 393 check_so_deps 394 dpdk_pci_api 395} 396 397autobuild_test_suite_ext() { 398 external_code 399} 400 401autobuild_test_suite_full() { 402 autobuild_test_suite_tiny 403 autobuild_test_suite_ext 404 build_files 405 build_doc 406} 407 408_autobuild_test_suite() { 409 case "$SPDK_TEST_AUTOBUILD" in 410 tiny) autobuild_test_suite_tiny ;; 411 ext) autobuild_test_suite_ext ;; 412 full) autobuild_test_suite_full ;; 413 esac 414} 415 416_unittest_build() { 417 "$rootdir/configure" $config_params --without-shared 418 $MAKE $MAKEFLAGS 419} 420 421autobuild_test_suite() { 422 run_test "autobuild" _autobuild_test_suite 423} 424 425unittest_build() { 426 run_test "unittest_build" _unittest_build 427} 428 429scanbuild_make() { 430 run_test "scanbuild_make" _scanbuild_make 431} 432 433ocf_precompile() { 434 run_test "autobuild_ocf_precompile" _ocf_precompile 435} 436 437llvm_precompile() { 438 run_test "autobuild_llvm_precompile" _llvm_precompile 439} 440 441build_native_dpdk() { 442 run_test "build_native_dpdk" _build_native_dpdk 443} 444 445build_packaging() { 446 run_test "packaging" "$rootdir/test/packaging/packaging.sh" 447} 448 449_build_release() ( 450 local jobs LD 451 452 if [[ -n $SPDK_TEST_NATIVE_DPDK && -e /tmp/spdk-ld-path ]]; then 453 source /tmp/spdk-ld-path 454 fi 455 456 if [[ $CC == *clang* ]]; then 457 jobs=$(($(nproc) / 2)) 458 case "$(uname -s)" in 459 Linux) # Shipped by default with binutils under most of the Linux distros 460 export LD=ld.gold LDFLAGS="-Wl,--threads,--thread-count=$jobs" MAKEFLAGS="-j$jobs" ;; 461 FreeBSD) # Default compiler which does support LTO, set it explicitly for visibility 462 export LD=ld.lld ;; 463 esac 464 fi 465 466 "$rootdir/configure" $config_params \ 467 --disable-debug \ 468 --disable-unit-tests \ 469 --enable-lto 470 471 $MAKE -C "$rootdir" $MAKEFLAGS 472) 473 474build_release() { 475 run_test "build_release" _build_release 476} 477 478out=$output_dir 479SPDK_WORKSPACE=$(mktemp -dt "spdk_$(date +%s).XXXXXX") 480 481if [[ -n $EXTERNAL_MAKE_HUGEMEM ]]; then 482 export EXTERNAL_MAKE_HUGEMEM 483fi 484 485if [ -n "$SPDK_TEST_NATIVE_DPDK" ]; then 486 scanbuild_exclude=" --exclude $(dirname $SPDK_RUN_EXTERNAL_DPDK)" 487else 488 scanbuild_exclude="--exclude $rootdir/dpdk/" 489fi 490# We exclude /tmp as it's used by xnvme's liburing subproject for storing 491# temporary .c files which are picked up as buggy by the scanbuild. 492scanbuild_exclude+=" --exclude $rootdir/xnvme --exclude /tmp" 493 494scanbuild="scan-build -o $output_dir/scan-build-tmp $scanbuild_exclude --status-bugs" 495config_params=$(get_config_params) 496 497start_monitor_resources 498trap 'stop_monitor_resources' EXIT 499