scripts: add help for build testing
[dpdk.git] / 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 # Load config options:
34 # - DPDK_BUILD_TEST_CONFIGS (target1+option1+option2 target2)
35 # - DPDK_DEP_CFLAGS
36 # - DPDK_DEP_LDFLAGS
37 # - DPDK_DEP_MOFED (y/[n])
38 # - DPDK_DEP_PCAP (y/[n])
39 # - DPDK_NOTIFY (notify-send)
40 . scripts/load-devel-config.sh
41
42 print_usage () {
43         echo "usage: $(basename $0) [-h] [-jX] [-s] [config1 [config2] ...]]"
44 }
45
46 print_help () {
47         echo 'Test building several targets with different options'
48         echo
49         print_usage
50         cat <<- END_OF_HELP
51
52         options:
53                 -h    this help
54                 -jX   use X parallel jobs in "make"
55                 -s    short test with only first config without examples/doc
56
57         config: defconfig name followed by switches delimited with "+" sign
58                 Example: x86_64-native-linuxapp-gcc+next+shared+combined
59                 Default is to enable most of the options.
60                 The external dependencies are setup with DPDK_DEP_* variables.
61         END_OF_HELP
62 }
63
64 J=$DPDK_MAKE_JOBS
65 short=false
66 while getopts hj:s ARG ; do
67         case $ARG in
68                 j ) J=$OPTARG ;;
69                 s ) short=true ;;
70                 h ) print_help ; exit 0 ;;
71                 ? ) print_usage ; exit 1 ;;
72         esac
73 done
74 shift $(($OPTIND - 1))
75 configs=${*:-$DPDK_BUILD_TEST_CONFIGS}
76
77 success=false
78 on_exit ()
79 {
80         if [ "$DPDK_NOTIFY" = notify-send ] ; then
81                 if $success ; then
82                         notify-send -u low --icon=dialog-information 'DPDK build' 'finished'
83                 elif [ -z "$signal" ] ; then
84                         notify-send -u low --icon=dialog-error 'DPDK build' 'failed'
85                 fi
86         fi
87 }
88 # catch manual interrupt to ignore notification
89 trap "signal=INT ; trap - INT ; kill -INT $$" INT
90 # notify result on exit
91 trap on_exit EXIT
92
93 cd $(dirname $(readlink -m $0))/..
94
95 config () # <directory> <target> <options>
96 {
97         if [ ! -e $1/.config ] ; then
98                 echo Custom configuration
99                 make T=$2 O=$1 config
100                 echo $3 | grep -q next || \
101                 sed -ri           's,(NEXT_ABI=)y,\1n,' $1/.config
102                 ! echo $3 | grep -q shared || \
103                 sed -ri         's,(SHARED_LIB=)n,\1y,' $1/.config
104                 ! echo $3 | grep -q combined || \
105                 sed -ri       's,(COMBINE_LIBS=)n,\1y,' $1/.config
106                 echo $2 | grep -q '^i686' || \
107                 sed -ri               's,(NUMA=)n,\1y,' $1/.config
108                 sed -ri         's,(PCI_CONFIG=)n,\1y,' $1/.config
109                 sed -ri    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
110                 sed -ri             's,(BYPASS=)n,\1y,' $1/.config
111                 test "$DPDK_DEP_MOFED" != y || \
112                 echo $2 | grep -q '^clang$' || \
113                 echo $3 | grep -q 'shared.*combined' || \
114                 sed -ri           's,(MLX._PMD=)n,\1y,' $1/.config
115                 test "$DPDK_DEP_SZE" != y || \
116                 echo $2 | grep -q '^i686' || \
117                 sed -ri       's,(PMD_SZEDATA2=)n,\1y,' $1/.config
118                 test "$DPDK_DEP_ZLIB" != y || \
119                 sed -ri          's,(BNX2X_PMD=)n,\1y,' $1/.config
120                 sed -ri            's,(NFP_PMD=)n,\1y,' $1/.config
121                 test "$DPDK_DEP_PCAP" != y || \
122                 sed -ri               's,(PCAP=)n,\1y,' $1/.config
123                 test -z "$AESNI_MULTI_BUFFER_LIB_PATH" || \
124                 echo $2 | grep -q '^i686' || \
125                 echo $3 | grep -q 'shared.*combined' || \
126                 sed -ri       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
127                 test "$DPDK_DEP_SSL" != y || \
128                 echo $2 | grep -q '^i686' || \
129                 echo $3 | grep -q 'shared.*combined' || \
130                 sed -ri            's,(PMD_QAT=)n,\1y,' $1/.config
131                 sed -ri        's,(KNI_VHOST.*=)n,\1y,' $1/.config
132                 sed -ri           's,(SCHED_.*=)n,\1y,' $1/.config
133                 ! echo $2 | grep -q '^i686' || \
134                 sed -ri              's,(POWER=)y,\1n,' $1/.config
135                 sed -ri 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config
136                 sed -ri            's,(DEBUG.*=)n,\1y,' $1/.config
137         fi
138 }
139
140 for conf in $configs ; do
141         target=$(echo $conf | cut -d'+' -f1)
142         options=$(echo $conf | cut -d'+' -sf2- --output-delimiter='-')
143         if [ -z "$options" ] ; then
144                 dir=$target
145                 config $dir $target
146                 # Use install rule
147                 make -j$J T=$target install EXTRA_CFLAGS="$DPDK_DEP_CFLAGS" EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS"
148                 $short || make -j$J T=$target examples O=$dir/examples EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS"
149         else
150                 dir=$target-$options
151                 config $dir $target $options
152                 echo "================== Build $dir"
153                 # Use O variable without install
154                 make -j$J O=$dir EXTRA_CFLAGS="$DPDK_DEP_CFLAGS" EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS"
155                 echo "================== Build examples for $dir"
156                 make -j$J -sC examples RTE_SDK=$(pwd) RTE_TARGET=$dir O=$(readlink -m $dir/examples) EXTRA_LDFLAGS="$DPDK_DEP_LDFLAGS"
157         fi
158         echo "################## $dir done."
159         ! $short || break
160 done
161
162 if ! $short ; then
163         mkdir -p .check
164         echo "================== Build doxygen HTML API"
165         make doc-api-html >/dev/null 2>.check/doc.txt
166         echo "================== Build sphinx HTML guides"
167         make doc-guides-html >/dev/null 2>>.check/doc.txt
168         echo "================== Check docs"
169         diff -u /dev/null .check/doc.txt
170 fi
171
172 success=true