scripts/test-build.sh

   1 #! /bin/sh -e
   2
   3 # BSD LICENSE
   4 #
   5 # Copyright 2015 6WIND S.A.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 #
  11 #   * Redistributions of source code must retain the above copyright
  12 #     notice, this list of conditions and the following disclaimer.
  13 #   * Redistributions in binary form must reproduce the above copyright
  14 #     notice, this list of conditions and the following disclaimer in
  15 #     the documentation and/or other materials provided with the
  16 #     distribution.
  17 #   * Neither the name of 6WIND S.A. nor the names of its
  18 #     contributors may be used to endorse or promote products derived
  19 #     from this software without specific prior written permission.
  20 #
  21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 default_path=$PATH
  34
  35 # Load config options:
  36 # - AESNI_MULTI_BUFFER_LIB_PATH
  37 # - DPDK_BUILD_TEST_CONFIGS (defconfig1+option1+option2 defconfig2)
  38 # - DPDK_DEP_ARCHIVE
  39 # - DPDK_DEP_CFLAGS
  40 # - DPDK_DEP_LDFLAGS
  41 # - DPDK_DEP_MOFED (y/[n])
  42 # - DPDK_DEP_NUMA (y/[n])
  43 # - DPDK_DEP_PCAP (y/[n])
  44 # - DPDK_DEP_SSL (y/[n])
  45 # - DPDK_DEP_SZE (y/[n])
  46 # - DPDK_DEP_ZLIB (y/[n])
  47 # - DPDK_MAKE_JOBS (int)
  48 # - DPDK_NOTIFY (notify-send)
  49 # - LIBSSO_SNOW3G_PATH
  50 # - LIBSSO_KASUMI_PATH
  51 . $(dirname $(readlink -e $0))/load-devel-config.sh
  52
  53 print_usage () {
  54         echo "usage: $(basename $0) [-h] [-jX] [-s] [config1 [config2] ...]]"
  55 }
  56
  57 print_help () {
  58         echo 'Test building several targets with different options'
  59         echo
  60         print_usage
  61         cat <<- END_OF_HELP
  62
  63         options:
  64                 -h    this help
  65                 -jX   use X parallel jobs in "make"
  66                 -s    short test with only first config without examples/doc
  67                 -v    verbose build
  68
  69         config: defconfig[[~][+]option1[[~][+]option2...]]
  70                 Example: x86_64-native-linuxapp-gcc+debug~RXTX_CALLBACKS
  71                 The lowercase options are defined inside $(basename $0).
  72                 The uppercase options can be the end of a defconfig option
  73                 to enable if prefixed with '+' or to disable if prefixed with '~'.
  74                 Default is to automatically enable most of the options.
  75                 The external dependencies are setup with DPDK_DEP_* variables.
  76                 If no config on command line, DPDK_BUILD_TEST_CONFIGS is used.
  77         END_OF_HELP
  78 }
  79
  80 J=$DPDK_MAKE_JOBS
  81 short=false
  82 unset verbose
  83 maxerr=-Wfatal-errors
  84 while getopts hj:sv ARG ; do
  85         case $ARG in
  86                 j ) J=$OPTARG ;;
  87                 s ) short=true ;;
  88                 v ) verbose='V=1' ;;
  89                 h ) print_help ; exit 0 ;;
  90                 ? ) print_usage ; exit 1 ;;
  91         esac
  92 done
  93 shift $(($OPTIND - 1))
  94 configs=${*:-$DPDK_BUILD_TEST_CONFIGS}
  95
  96 success=false
  97 on_exit ()
  98 {
  99         if $success ; then
 100                 [ "$DPDK_NOTIFY" != notify-send ] || \
 101                         notify-send -u low --icon=dialog-information 'DPDK build' 'finished'
 102         elif [ -z "$signal" ] ; then
 103                 [ -z "$dir" ] || echo "failed to build $dir" >&2
 104                 [ "$DPDK_NOTIFY" != notify-send ] || \
 105                         notify-send -u low --icon=dialog-error 'DPDK build' 'failed'
 106         fi
 107 }
 108 # catch manual interrupt to ignore notification
 109 trap "signal=INT ; trap - INT ; kill -INT $$" INT
 110 # notify result on exit
 111 trap on_exit EXIT
 112
 113 cd $(dirname $(readlink -m $0))/..
 114
 115 reset_env ()
 116 {
 117         export PATH=$default_path
 118         unset CROSS
 119         unset DPDK_DEP_ARCHIVE
 120         unset DPDK_DEP_CFLAGS
 121         unset DPDK_DEP_LDFLAGS
 122         unset DPDK_DEP_MOFED
 123         unset DPDK_DEP_NUMA
 124         unset DPDK_DEP_PCAP
 125         unset DPDK_DEP_SSL
 126         unset DPDK_DEP_SZE
 127         unset DPDK_DEP_ZLIB
 128         unset AESNI_MULTI_BUFFER_LIB_PATH
 129         unset LIBSSO_SNOW3G_PATH
 130         unset LIBSSO_KASUMI_PATH
 131         unset PQOS_INSTALL_PATH
 132 }
 133
 134 config () # <directory> <target> <options>
 135 {
 136         reconfig=false
 137         if git rev-parse 2>&- && [ -n "$(git diff HEAD~ -- config)" ] ; then
 138                 echo 'Default config may have changed'
 139                 reconfig=true
 140         fi
 141         if [ ! -e $1/.config ] || $reconfig ; then
 142                 echo "================== Configure $1"
 143                 make T=$2 O=$1 config
 144
 145                 echo 'Customize configuration'
 146                 # Built-in options (lowercase)
 147                 ! echo $3 | grep -q '+default' || \
 148                 sed -ri 's,(RTE_MACHINE=")native,\1default,' $1/.config
 149                 echo $3 | grep -q '+next' || \
 150                 sed -ri           's,(NEXT_ABI=)y,\1n,' $1/.config
 151                 ! echo $3 | grep -q '+shared' || \
 152                 sed -ri         's,(SHARED_LIB=)n,\1y,' $1/.config
 153                 ! echo $3 | grep -q '+debug' || ( \
 154                 sed -ri     's,(RTE_LOG_LEVEL=).*,\1RTE_LOG_DEBUG,' $1/.config
 155                 sed -ri           's,(_DEBUG.*=)n,\1y,' $1/.config
 156                 sed -ri            's,(_STAT.*=)n,\1y,' $1/.config
 157                 sed -ri 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config )
 158
 159                 # Automatic configuration
 160                 test "$DPDK_DEP_NUMA" != y || \
 161                 sed -ri               's,(NUMA=)n,\1y,' $1/.config
 162                 sed -ri    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
 163                 sed -ri             's,(BYPASS=)n,\1y,' $1/.config
 164                 test "$DPDK_DEP_ARCHIVE" != y || \
 165                 sed -ri       's,(RESOURCE_TAR=)n,\1y,' $1/.config
 166                 test "$DPDK_DEP_MOFED" != y || \
 167                 sed -ri           's,(MLX._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,(QEDE_PMD=)n,\1y,' $1/.config
 174                 sed -ri            's,(NFP_PMD=)n,\1y,' $1/.config
 175                 test "$DPDK_DEP_PCAP" != y || \
 176                 sed -ri               's,(PCAP=)n,\1y,' $1/.config
 177                 test -z "$AESNI_MULTI_BUFFER_LIB_PATH" || \
 178                 sed -ri       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
 179                 test -z "$AESNI_MULTI_BUFFER_LIB_PATH" || \
 180                 sed -ri      's,(PMD_AESNI_GCM=)n,\1y,' $1/.config
 181                 test -z "$LIBSSO_SNOW3G_PATH" || \
 182                 sed -ri         's,(PMD_SNOW3G=)n,\1y,' $1/.config
 183                 test -z "$LIBSSO_KASUMI_PATH" || \
 184                 sed -ri         's,(PMD_KASUMI=)n,\1y,' $1/.config
 185                 test "$DPDK_DEP_SSL" != y || \
 186                 sed -ri            's,(PMD_QAT=)n,\1y,' $1/.config
 187                 sed -ri        's,(KNI_VHOST.*=)n,\1y,' $1/.config
 188                 sed -ri           's,(SCHED_.*=)n,\1y,' $1/.config
 189                 build_config_hook $1 $2 $3
 190
 191                 # Explicit enabler/disabler (uppercase)
 192                 for option in $(echo $3 | sed 's,[~+], &,g') ; do
 193                         pattern=$(echo $option | cut -c2-)
 194                         if echo $option | grep -q '^~' ; then
 195                                 sed -ri "s,($pattern=)y,\1n," $1/.config
 196                         elif echo $option | grep -q '^+' ; then
 197                                 sed -ri "s,($pattern=)n,\1y," $1/.config
 198                         fi
 199                 done
 200         fi
 201 }
 202
 203 # default empty hook to override in devel config
 204 build_config_hook () # <directory> <target> <options>
 205 {
 206         :
 207 }
 208
 209 for conf in $configs ; do
 210         target=$(echo $conf | sed 's,[~+].*,,')
 211         # reload config with DPDK_TARGET set
 212         DPDK_TARGET=$target
 213         reset_env
 214         . $(dirname $(readlink -e $0))/load-devel-config.sh
 215
 216         options=$(echo $conf | sed 's,[^~+]*,,')
 217         dir=$conf
 218         config $dir $target $options
 219
 220         echo "================== Build $dir"
 221         make -j$J EXTRA_CFLAGS="$maxerr $DPDK_DEP_CFLAGS" \
 222                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose O=$dir
 223         ! $short || break
 224         echo "================== Build examples for $dir"
 225         export RTE_SDK=$(pwd)
 226         export RTE_TARGET=$dir
 227         make -j$J -sC examples \
 228                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose \
 229                 O=$(readlink -m $dir/examples)
 230         ! echo $target | grep -q '^x86_64' || \
 231         make -j$J -sC examples/performance-thread \
 232                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" $verbose \
 233                 O=$(readlink -m $dir/examples/performance-thread)
 234         unset RTE_TARGET
 235         echo "################## $dir done."
 236         unset dir
 237 done
 238
 239 if ! $short ; then
 240         mkdir -p .check
 241         echo "================== Build doxygen HTML API"
 242         make doc-api-html >/dev/null 2>.check/doc.txt
 243         echo "================== Build sphinx HTML guides"
 244         make doc-guides-html >/dev/null 2>>.check/doc.txt
 245         echo "================== Check docs"
 246         diff -u /dev/null .check/doc.txt
 247 fi
 248
 249 success=true