devtools/test-build.sh

   1 #! /bin/sh -e
   2 # SPDX-License-Identifier: BSD-3-Clause
   3 # Copyright 2015 6WIND S.A.
   4
   5 default_path=$PATH
   6
   7 # Load config options:
   8 # - ARMV8_CRYPTO_LIB_PATH
   9 # - DPDK_ABI_REF_DIR
  10 # - DPDK_ABI_REF_VERSION
  11 # - DPDK_BUILD_TEST_CONFIGS (defconfig1+option1+option2 defconfig2)
  12 # - DPDK_BUILD_TEST_DIR
  13 # - DPDK_DEP_ARCHIVE
  14 # - DPDK_DEP_BPF (y/[n])
  15 # - DPDK_DEP_CFLAGS
  16 # - DPDK_DEP_ELF (y/[n])
  17 # - DPDK_DEP_ISAL (y/[n])
  18 # - DPDK_DEP_JSON (y/[n])
  19 # - DPDK_DEP_LDFLAGS
  20 # - DPDK_DEP_MLX (y/[n])
  21 # - DPDK_DEP_NFB (y/[n])
  22 # - DPDK_DEP_NUMA ([y]/n)
  23 # - DPDK_DEP_PCAP (y/[n])
  24 # - DPDK_DEP_SSL (y/[n])
  25 # - DPDK_DEP_IPSEC_MB (y/[n])
  26 # - DPDK_DEP_SZE (y/[n])
  27 # - DPDK_DEP_ZLIB (y/[n])
  28 # - DPDK_MAKE_JOBS (int)
  29 # - DPDK_NOTIFY (notify-send)
  30 # - FLEXRAN_SDK
  31 # - LIBMUSDK_PATH
  32 devtools_dir=$(dirname $(readlink -f $0))
  33 . $devtools_dir/load-devel-config
  34
  35 print_usage () {
  36         echo "usage: $(basename $0) [-h] [-jX] [-s] [config1 [config2] ...]]"
  37 }
  38
  39 print_help () {
  40         echo 'Test building several targets with different options'
  41         echo
  42         print_usage
  43         cat <<- END_OF_HELP
  44
  45         options:
  46                 -h    this help
  47                 -jX   use X parallel jobs in "make"
  48                 -s    short test only first config without tests|examples|doc
  49                 -v    verbose build
  50
  51         config: defconfig[[~][+]option1[[~][+]option2...]]
  52                 Example: x86_64-native-linux-gcc+debug~RXTX_CALLBACKS
  53                 The lowercase options are defined inside $(basename $0).
  54                 The uppercase options can be the end of a defconfig option
  55                 to enable if prefixed with '+' or to disable if prefixed with '~'.
  56                 Default is to automatically enable most of the options.
  57                 The external dependencies are setup with DPDK_DEP_* variables.
  58                 If no config on command line, DPDK_BUILD_TEST_CONFIGS is used.
  59         END_OF_HELP
  60 }
  61
  62 [ -z $MAKE ] && command -v gmake > /dev/null && MAKE=gmake
  63 [ -z $MAKE ] && command -v make > /dev/null && MAKE=make
  64 [ -z $MAKE ] && echo "Cannot find make or gmake" && exit 1
  65
  66 J=$DPDK_MAKE_JOBS
  67 builds_dir=${DPDK_BUILD_TEST_DIR:-.}
  68 short=false
  69 unset verbose
  70 # for ABI checks, we need debuginfo
  71 test_cflags="-Wfatal-errors -g"
  72 while getopts hj:sv ARG ; do
  73         case $ARG in
  74                 j ) J=$OPTARG ;;
  75                 s ) short=true ;;
  76                 v ) verbose='V=1' ;;
  77                 h ) print_help ; exit 0 ;;
  78                 ? ) print_usage ; exit 1 ;;
  79         esac
  80 done
  81 shift $(($OPTIND - 1))
  82 configs=${*:-$DPDK_BUILD_TEST_CONFIGS}
  83
  84 success=false
  85 on_exit ()
  86 {
  87         if $success ; then
  88                 [ "$DPDK_NOTIFY" != notify-send ] || \
  89                         notify-send -u low --icon=dialog-information 'DPDK build' 'finished'
  90         elif [ -z "$signal" ] ; then
  91                 [ -z "$dir" ] || echo "failed to build $dir" >&2
  92                 [ "$DPDK_NOTIFY" != notify-send ] || \
  93                         notify-send -u low --icon=dialog-error 'DPDK build' 'failed'
  94         fi
  95 }
  96 # catch manual interrupt to ignore notification
  97 trap "signal=INT ; trap - INT ; kill -INT $$" INT
  98 # notify result on exit
  99 trap on_exit EXIT
 100
 101 cd $devtools_dir/..
 102
 103 reset_env ()
 104 {
 105         export PATH=$default_path
 106         unset CROSS
 107         unset DPDK_DEP_ARCHIVE
 108         unset DPDK_DEP_BPF
 109         unset DPDK_DEP_CFLAGS
 110         unset DPDK_DEP_ELF
 111         unset DPDK_DEP_ISAL
 112         unset DPDK_DEP_JSON
 113         unset DPDK_DEP_LDFLAGS
 114         unset DPDK_DEP_MLX
 115         unset DPDK_DEP_NFB
 116         unset DPDK_DEP_NUMA
 117         unset DPDK_DEP_PCAP
 118         unset DPDK_DEP_SSL
 119         unset DPDK_DEP_IPSEC_MB
 120         unset DPDK_DEP_SZE
 121         unset DPDK_DEP_ZLIB
 122         unset ARMV8_CRYPTO_LIB_PATH
 123         unset FLEXRAN_SDK
 124         unset LIBMUSDK_PATH
 125         unset PQOS_INSTALL_PATH
 126 }
 127
 128 config () # <directory> <target> <options>
 129 {
 130         reconfig=false
 131         if git rev-parse 2>&- && [ -n "$(git diff HEAD~ -- config)" ] ; then
 132                 echo 'Default config may have changed'
 133                 reconfig=true
 134         fi
 135         if [ ! -e $1/.config ] || $reconfig ; then
 136                 echo "================== Configure $1"
 137                 ${MAKE} T=$2 O=$1 config
 138
 139                 echo 'Customize configuration'
 140                 # Built-in options (lowercase)
 141                 ! echo $3 | grep -q '+default' || \
 142                 sed -ri="" 's,(RTE_MACHINE=")native,\1default,' $1/.config
 143                 echo $3 | grep -q '+next' || \
 144                 sed -ri=""           's,(NEXT_ABI=)y,\1n,' $1/.config
 145                 ! echo $3 | grep -q '+shared' || \
 146                 sed -ri=""         's,(SHARED_LIB=)n,\1y,' $1/.config
 147                 ! echo $3 | grep -q '+debug' || ( \
 148                 sed -ri=""  's,(RTE_LOG_DP_LEVEL=).*,\1RTE_LOG_DEBUG,' $1/.config
 149                 sed -ri=""           's,(_DEBUG.*=)n,\1y,' $1/.config
 150                 sed -ri=""  's,(_STAT)([S_].*=|=)n,\1\2y,' $1/.config
 151                 sed -ri="" 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config )
 152
 153                 # Automatic configuration
 154                 test "$DPDK_DEP_NUMA" != n || \
 155                 sed -ri=""             's,(NUMA.*=)y,\1n,' $1/.config
 156                 sed -ri=""    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
 157                 sed -ri=""             's,(BYPASS=)n,\1y,' $1/.config
 158                 test "$DPDK_DEP_ARCHIVE" != y || \
 159                 sed -ri=""       's,(RESOURCE_TAR=)n,\1y,' $1/.config
 160                 test "$DPDK_DEP_BPF" != y || \
 161                 sed -ri=""         's,(PMD_AF_XDP=)n,\1y,' $1/.config
 162                 test "$DPDK_DEP_ISAL" != y || \
 163                 sed -ri=""           's,(PMD_ISAL=)n,\1y,' $1/.config
 164                 test "$DPDK_DEP_MLX" != y || \
 165                 sed -ri=""           's,(MLX._PMD=)n,\1y,' $1/.config
 166                 test "$DPDK_DEP_NFB" != y || \
 167                 sed -ri=""            's,(NFB_PMD=)n,\1y,' $1/.config
 168                 test "$DPDK_DEP_SZE" != y || \
 169                 sed -ri=""       's,(PMD_SZEDATA2=)n,\1y,' $1/.config
 170                 test "$DPDK_DEP_ZLIB" != y || \
 171                 sed -ri=""          's,(BNX2X_PMD=)n,\1y,' $1/.config
 172                 test "$DPDK_DEP_ZLIB" != y || \
 173                 sed -ri=""           's,(PMD_ZLIB=)n,\1y,' $1/.config
 174                 test "$DPDK_DEP_ZLIB" != y || \
 175                 sed -ri=""   's,(COMPRESSDEV_TEST=)n,\1y,' $1/.config
 176                 test "$DPDK_DEP_PCAP" != y || \
 177                 sed -ri=""               's,(PCAP=)n,\1y,' $1/.config
 178                 test -z "$ARMV8_CRYPTO_LIB_PATH" || \
 179                 sed -ri=""   's,(PMD_ARMV8_CRYPTO=)n,\1y,' $1/.config
 180                 test "$DPDK_DEP_IPSEC_MB" != y || \
 181                 sed -ri=""       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
 182                 test "$DPDK_DEP_IPSEC_MB" != y || \
 183                 sed -ri=""      's,(PMD_AESNI_GCM=)n,\1y,' $1/.config
 184                 test "$DPDK_DEP_IPSEC_MB" != y || \
 185                 sed -ri=""            's,(PMD_ZUC=)n,\1y,' $1/.config
 186                 test "$DPDK_DEP_IPSEC_MB" != y || \
 187                 sed -ri=""         's,(PMD_KASUMI=)n,\1y,' $1/.config
 188                 test "$DPDK_DEP_IPSEC_MB" != y || \
 189                 sed -ri=""         's,(PMD_SNOW3G=)n,\1y,' $1/.config
 190                 test "$DPDK_DEP_SSL" != y || \
 191                 sed -ri=""            's,(PMD_CCP=)n,\1y,' $1/.config
 192                 test "$DPDK_DEP_SSL" != y || \
 193                 sed -ri=""        's,(PMD_OPENSSL=)n,\1y,' $1/.config
 194                 test "$DPDK_DEP_SSL" != y || \
 195                 sed -ri=""            's,(QAT_SYM=)n,\1y,' $1/.config
 196                 test -z "$FLEXRAN_SDK" || \
 197                 sed -ri=""     's,(BBDEV_TURBO_SW=)n,\1y,' $1/.config
 198                 sed -ri=""           's,(SCHED_.*=)n,\1y,' $1/.config
 199                 test -z "$LIBMUSDK_PATH" || \
 200                 sed -ri=""   's,(PMD_MVSAM_CRYPTO=)n,\1y,' $1/.config
 201                 test -z "$LIBMUSDK_PATH" || \
 202                 sed -ri=""          's,(MVPP2_PMD=)n,\1y,' $1/.config
 203                 test -z "$LIBMUSDK_PATH" || \
 204                 sed -ri=""         's,(MVNETA_PMD=)n,\1y,' $1/.config
 205                 test "$DPDK_DEP_ELF" != y || \
 206                 sed -ri=""            's,(BPF_ELF=)n,\1y,' $1/.config
 207                 test "$DPDK_DEP_JSON" != y || \
 208                 sed -ri=""          's,(TELEMETRY=)n,\1y,' $1/.config
 209                 build_config_hook $1 $2 $3
 210
 211                 # Explicit enabler/disabler (uppercase)
 212                 for option in $(echo $3 | sed 's,[~+], &,g') ; do
 213                         pattern=$(echo $option | cut -c2-)
 214                         if echo $option | grep -q '^~' ; then
 215                                 sed -ri="" "s,($pattern=)y,\1n," $1/.config
 216                         elif echo $option | grep -q '^+' ; then
 217                                 sed -ri="" "s,($pattern=)n,\1y," $1/.config
 218                         fi
 219                 done
 220         fi
 221 }
 222
 223 # default empty hook to override in devel config
 224 build_config_hook () # <directory> <target> <options>
 225 {
 226         :
 227 }
 228
 229 for conf in $configs ; do
 230         target=$(echo $conf | sed 's,[~+].*,,')
 231         # reload config with DPDK_TARGET set
 232         DPDK_TARGET=$target
 233         reset_env
 234         . $devtools_dir/load-devel-config
 235
 236         options=$(echo $conf | sed 's,[^~+]*,,')
 237         dir=$builds_dir/$conf
 238         config $dir $target $options
 239
 240         echo "================== Build $conf"
 241         ${MAKE} -j$J EXTRA_CFLAGS="$test_cflags $DPDK_DEP_CFLAGS" \
 242                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose O=$dir
 243         ! $short || break
 244         export RTE_TARGET=$target
 245         rm -rf $dir/install
 246         ${MAKE} install O=$dir DESTDIR=$dir/install prefix=
 247         echo "================== Build examples for $conf"
 248         export RTE_SDK=$(readlink -f $dir)/install/share/dpdk
 249         ln -sTf $(pwd)/lib $RTE_SDK/lib # workaround for vm_power_manager
 250         ${MAKE} -j$J -sC examples \
 251                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose \
 252                 O=$(readlink -f $dir)/examples
 253         unset RTE_TARGET
 254         if [ -n "$DPDK_ABI_REF_VERSION" ]; then
 255                 abirefdir=${DPDK_ABI_REF_DIR:-reference}/$DPDK_ABI_REF_VERSION
 256                 if [ ! -d $abirefdir/$conf ]; then
 257                         # clone current sources
 258                         if [ ! -d $abirefdir/src ]; then
 259                                 git clone --local --no-hardlinks \
 260                                         --single-branch \
 261                                         -b $DPDK_ABI_REF_VERSION \
 262                                         $(pwd) $abirefdir/src
 263                         fi
 264
 265                         cd $abirefdir/src
 266
 267                         rm -rf $abirefdir/build
 268                         config $abirefdir/build $target $options
 269
 270                         echo -n "================== Build $conf "
 271                         echo "($DPDK_ABI_REF_VERSION)"
 272                         ${MAKE} -j$J \
 273                                 EXTRA_CFLAGS="$test_cflags $DPDK_DEP_CFLAGS" \
 274                                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose \
 275                                 O=$abirefdir/build
 276                         export RTE_TARGET=$target
 277                         ${MAKE} install O=$abirefdir/build \
 278                                 DESTDIR=$abirefdir/$conf \
 279                                 prefix=
 280                         unset RTE_TARGET
 281                         $devtools_dir/gen-abi.sh $abirefdir/$conf
 282
 283                         # back to current workdir
 284                         cd $devtools_dir/..
 285                 fi
 286
 287                 echo "================== Check ABI $conf"
 288                 $devtools_dir/gen-abi.sh $dir/install
 289                 $devtools_dir/check-abi.sh $abirefdir/$conf $dir/install
 290         fi
 291         echo "################## $conf done."
 292         unset dir
 293 done
 294
 295 if ! $short ; then
 296         mkdir -p .check
 297         echo "================== Build doxygen HTML API"
 298         ${MAKE} doc-api-html >/dev/null 2>.check/doc.txt
 299         echo "================== Build sphinx HTML guides"
 300         ${MAKE} doc-guides-html >/dev/null 2>>.check/doc.txt
 301         echo "================== Check docs"
 302         diff -u /dev/null .check/doc.txt
 303 fi
 304
 305 success=true