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_CFLAGS
  39 # - DPDK_DEP_LDFLAGS
  40 # - DPDK_DEP_MOFED (y/[n])
  41 # - DPDK_DEP_PCAP (y/[n])
  42 # - DPDK_DEP_SSL (y/[n])
  43 # - DPDK_DEP_SZE (y/[n])
  44 # - DPDK_DEP_ZLIB (y/[n])
  45 # - DPDK_MAKE_JOBS (int)
  46 # - DPDK_NOTIFY (notify-send)
  47 . $(dirname $(readlink -e $0))/load-devel-config.sh
  48
  49 print_usage () {
  50         echo "usage: $(basename $0) [-h] [-jX] [-s] [config1 [config2] ...]]"
  51 }
  52
  53 print_help () {
  54         echo 'Test building several targets with different options'
  55         echo
  56         print_usage
  57         cat <<- END_OF_HELP
  58
  59         options:
  60                 -h    this help
  61                 -jX   use X parallel jobs in "make"
  62                 -s    short test with only first config without examples/doc
  63
  64         config: defconfig[[~][+]option1[[~][+]option2...]]
  65                 Example: x86_64-native-linuxapp-gcc+debug~RXTX_CALLBACKS
  66                 The lowercase options are defined inside $(basename $0).
  67                 The uppercase options can be the end of a defconfig option
  68                 to enable if prefixed with '+' or to disable if prefixed with '~'.
  69                 Default is to automatically enable most of the options.
  70                 The external dependencies are setup with DPDK_DEP_* variables.
  71                 If no config on command line, DPDK_BUILD_TEST_CONFIGS is used.
  72         END_OF_HELP
  73 }
  74
  75 J=$DPDK_MAKE_JOBS
  76 short=false
  77 maxerr=-Wfatal-errors
  78 while getopts hj:s ARG ; do
  79         case $ARG in
  80                 j ) J=$OPTARG ;;
  81                 s ) short=true ;;
  82                 h ) print_help ; exit 0 ;;
  83                 ? ) print_usage ; exit 1 ;;
  84         esac
  85 done
  86 shift $(($OPTIND - 1))
  87 configs=${*:-$DPDK_BUILD_TEST_CONFIGS}
  88
  89 success=false
  90 on_exit ()
  91 {
  92         if [ "$DPDK_NOTIFY" = notify-send ] ; then
  93                 if $success ; then
  94                         notify-send -u low --icon=dialog-information 'DPDK build' 'finished'
  95                 elif [ -z "$signal" ] ; then
  96                         notify-send -u low --icon=dialog-error 'DPDK build' 'failed'
  97                 fi
  98         fi
  99 }
 100 # catch manual interrupt to ignore notification
 101 trap "signal=INT ; trap - INT ; kill -INT $$" INT
 102 # notify result on exit
 103 trap on_exit EXIT
 104
 105 cd $(dirname $(readlink -m $0))/..
 106
 107 reset_env ()
 108 {
 109         export PATH=$default_path
 110         unset CROSS
 111         unset DPDK_DEP_CFLAGS
 112         unset DPDK_DEP_LDFLAGS
 113         unset DPDK_DEP_MOFED
 114         unset DPDK_DEP_PCAP
 115         unset DPDK_DEP_SSL
 116         unset DPDK_DEP_SZE
 117         unset DPDK_DEP_ZLIB
 118         unset AESNI_MULTI_BUFFER_LIB_PATH
 119         unset PQOS_INSTALL_PATH
 120 }
 121
 122 config () # <directory> <target> <options>
 123 {
 124         if [ ! -e $1/.config ] ; then
 125                 echo "================== Configure $1"
 126                 make T=$2 O=$1 config
 127
 128                 echo 'Customize configuration'
 129                 # Built-in options (lowercase)
 130                 ! echo $3 | grep -q '+default' || \
 131                 sed -ri 's,(RTE_MACHINE=")native,\1default,' $1/.config
 132                 echo $3 | grep -q '+next' || \
 133                 sed -ri           's,(NEXT_ABI=)y,\1n,' $1/.config
 134                 ! echo $3 | grep -q '+shared' || \
 135                 sed -ri         's,(SHARED_LIB=)n,\1y,' $1/.config
 136                 ! echo $3 | grep -q '+debug' || \
 137                 sed -ri            's,(DEBUG.*=)n,\1y,' $1/.config
 138
 139                 # Automatic configuration
 140                 ! echo $2 | grep -q '^x86_64' || \
 141                 sed -ri               's,(NUMA=)n,\1y,' $1/.config
 142                 sed -ri         's,(PCI_CONFIG=)n,\1y,' $1/.config
 143                 sed -ri    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
 144                 sed -ri             's,(BYPASS=)n,\1y,' $1/.config
 145                 test "$DPDK_DEP_MOFED" != y || \
 146                 sed -ri           's,(MLX._PMD=)n,\1y,' $1/.config
 147                 test "$DPDK_DEP_SZE" != y || \
 148                 sed -ri       's,(PMD_SZEDATA2=)n,\1y,' $1/.config
 149                 test "$DPDK_DEP_ZLIB" != y || \
 150                 sed -ri          's,(BNX2X_PMD=)n,\1y,' $1/.config
 151                 sed -ri            's,(NFP_PMD=)n,\1y,' $1/.config
 152                 test "$DPDK_DEP_PCAP" != y || \
 153                 sed -ri               's,(PCAP=)n,\1y,' $1/.config
 154                 test -z "$AESNI_MULTI_BUFFER_LIB_PATH" || \
 155                 sed -ri       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
 156                 test -z "$AESNI_MULTI_BUFFER_LIB_PATH" || \
 157                 sed -ri      's,(PMD_AESNI_GCM=)n,\1y,' $1/.config
 158                 test "$DPDK_DEP_SSL" != y || \
 159                 sed -ri            's,(PMD_QAT=)n,\1y,' $1/.config
 160                 sed -ri        's,(KNI_VHOST.*=)n,\1y,' $1/.config
 161                 sed -ri           's,(SCHED_.*=)n,\1y,' $1/.config
 162                 sed -ri 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config
 163
 164                 # Explicit enabler/disabler (uppercase)
 165                 for option in $(echo $3 | sed 's,[~+], &,g') ; do
 166                         pattern=$(echo $option | cut -c2-)
 167                         if echo $option | grep -q '^~' ; then
 168                                 sed -ri "s,($pattern=)y,\1n," $1/.config
 169                         elif echo $option | grep -q '^+' ; then
 170                                 sed -ri "s,($pattern=)n,\1y," $1/.config
 171                         fi
 172                 done
 173         fi
 174 }
 175
 176 for conf in $configs ; do
 177         target=$(echo $conf | sed 's,[~+].*,,')
 178         # reload config with DPDK_TARGET set
 179         DPDK_TARGET=$target
 180         reset_env
 181         . $(dirname $(readlink -e $0))/load-devel-config.sh
 182
 183         options=$(echo $conf | sed 's,[^~+]*,,')
 184         dir=$conf
 185         config $dir $target $options
 186
 187         echo "================== Build $dir"
 188         make -j$J EXTRA_CFLAGS="$maxerr $DPDK_DEP_CFLAGS" \
 189                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" O=$dir
 190         ! $short || break
 191         echo "================== Build examples for $dir"
 192         export RTE_SDK=$(pwd)
 193         export RTE_TARGET=$dir
 194         make -j$J -sC examples \
 195                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" \
 196                 O=$(readlink -m $dir/examples)
 197         ! echo $target | grep -q '^x86_64' || \
 198         make -j$J -sC examples/performance-thread \
 199                 EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS" \
 200                 O=$(readlink -m $dir/examples/performance-thread)
 201         unset RTE_TARGET
 202         echo "################## $dir done."
 203 done
 204
 205 if ! $short ; then
 206         mkdir -p .check
 207         echo "================== Build doxygen HTML API"
 208         make doc-api-html >/dev/null 2>.check/doc.txt
 209         echo "================== Build sphinx HTML guides"
 210         make doc-guides-html >/dev/null 2>>.check/doc.txt
 211         echo "================== Check docs"
 212         diff -u /dev/null .check/doc.txt
 213 fi
 214
 215 success=true