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