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