blob: 693b012d4f8851d19147be3fd047aa9bf18e7a12 [file] [log] [blame]
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001#!/bin/sh
2
Simon Butcherd7f19022016-10-14 09:49:48 +01003# all.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01004#
Simon Butcherd7f19022016-10-14 09:49:48 +01005# This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01006#
Gilles Peskined7602c22017-12-21 15:59:21 +01007# Copyright (c) 2014-2017, ARM Limited, All Rights Reserved
8
9
10
11################################################################
12#### Documentation
13################################################################
14
Simon Butcherd7f19022016-10-14 09:49:48 +010015# Purpose
Gilles Peskined7602c22017-12-21 15:59:21 +010016# -------
Simon Butcherd7f19022016-10-14 09:49:48 +010017#
18# To run all tests possible or available on the platform.
19#
Gilles Peskined7602c22017-12-21 15:59:21 +010020# Notes for users
21# ---------------
22#
Simon Butcherd7f19022016-10-14 09:49:48 +010023# Warning: the test is destructive. It includes various build modes and
24# configurations, and can and will arbitrarily change the current CMake
Gilles Peskined7602c22017-12-21 15:59:21 +010025# configuration. The following files must be committed into git:
26# * include/mbedtls/config.h
27# * Makefile, library/Makefile, programs/Makefile, tests/Makefile
28# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Simon Butcherd7f19022016-10-14 09:49:48 +010030#
Gilles Peskined7602c22017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
38# * arm-gcc and mingw-gcc
39# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
40# * OpenSSL and GnuTLS command line tools, recent enough for the
41# interoperability tests. If they don't support SSLv3 then a legacy
42# version of these tools must be present as well (search for LEGACY
43# below).
44# See the invocation of check_tools below for details.
45#
46# This script must be invoked from the toplevel directory of a git
47# working copy of Mbed TLS.
48#
49# Note that the output is not saved. You may want to run
50# script -c tests/scripts/all.sh
51# or
52# tests/scripts/all.sh >all.log 2>&1
53#
54# Notes for maintainers
55# ---------------------
56#
57# The tests are roughly in order from fastest to slowest. This doesn't
58# have to be exact, but in general you should add slower tests towards
59# the end and fast checks near the beginning.
60#
61# Sanity checks have the following form:
62# 1. msg "short description of what is about to be done"
63# 2. run sanity check (failure stops the script)
64#
65# Build or build-and-test steps have the following form:
66# 1. msg "short description of what is about to be done"
67# 2. cleanup
68# 3. preparation (config.pl, cmake, ...) (failure stops the script)
69# 4. make
70# 5. Run tests if relevant. All tests must be prefixed with
71# if_build_successful for the sake of --keep-going.
72
73
74
75################################################################
76#### Initialization and command line parsing
77################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010078
Simon Butcherd7f19022016-10-14 09:49:48 +010079# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010080set -eu
81
82if [ -d library -a -d include -a -d tests ]; then :; else
Simon Butcherd7f19022016-10-14 09:49:48 +010083 err_msg "Must be run from mbed TLS root"
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010084 exit 1
85fi
86
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000087CONFIG_H='include/mbedtls/config.h'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +020088CONFIG_BAK="$CONFIG_H.bak"
89
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010090MEMORY=0
Simon Butcherd7f19022016-10-14 09:49:48 +010091FORCE=0
Gilles Peskinea8bf9862017-12-11 00:01:40 +010092KEEP_GOING=0
Simon Butcherd7f19022016-10-14 09:49:48 +010093RELEASE=0
Gilles Peskineb9344e32017-12-19 18:24:31 +010094RUN_ARMCC=1
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010095
Simon Butcherd7f19022016-10-14 09:49:48 +010096# Default commands, can be overriden by the environment
97: ${OPENSSL:="openssl"}
98: ${OPENSSL_LEGACY:="$OPENSSL"}
99: ${GNUTLS_CLI:="gnutls-cli"}
100: ${GNUTLS_SERV:="gnutls-serv"}
101: ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
102: ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
103: ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
104
105usage()
106{
Gilles Peskinea6901f42017-12-10 23:43:39 +0100107 cat <<EOF
108Usage: $0 [OPTION]...
109 -h|--help Print this help.
110
111General options:
112 -f|--force Force the tests to overwrite any modified files.
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100113 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskinea6901f42017-12-10 23:43:39 +0100114 -m|--memory Additional optional memory tests.
Gilles Peskineb9344e32017-12-19 18:24:31 +0100115 --armcc Run ARM Compiler builds (on by default).
116 --no-armcc Skip ARM Compiler builds.
Gilles Peskinea6901f42017-12-10 23:43:39 +0100117 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
118 -r|--release-test Run this script in release mode. This fixes the seed value to 1.
119 -s|--seed Integer seed value to use for this test run.
120
121Tool path options:
122 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
123 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
124 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
125 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
126 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
127 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
128EOF
Simon Butcherd7f19022016-10-14 09:49:48 +0100129}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100130
131# remove built files as well as the cmake cache/config
132cleanup()
133{
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100134 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200135
Manuel Pégourié-Gonnard77d56bb2015-07-28 15:00:37 +0200136 find . -name yotta -prune -o -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} \+
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000137 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Paul Bakkerfe0984d2014-06-13 00:13:45 +0200138 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile
139 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200140
141 if [ -f "$CONFIG_BAK" ]; then
142 mv "$CONFIG_BAK" "$CONFIG_H"
143 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100144}
145
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100146# Executed on exit. May be redefined depending on command line options.
147final_report () {
148 :
149}
150
151fatal_signal () {
152 cleanup
153 final_report $1
154 trap - $1
155 kill -$1 $$
156}
157
158trap 'fatal_signal HUP' HUP
159trap 'fatal_signal INT' INT
160trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200161
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100162msg()
163{
164 echo ""
165 echo "******************************************************************"
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100166 echo "* $1 "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000167 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100168 echo "******************************************************************"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100169 current_section=$1
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100170}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100171
Simon Butcherd7f19022016-10-14 09:49:48 +0100172err_msg()
173{
174 echo "$1" >&2
175}
176
177check_tools()
178{
179 for TOOL in "$@"; do
180 if ! `hash "$TOOL" >/dev/null 2>&1`; then
181 err_msg "$TOOL not found!"
182 exit 1
183 fi
184 done
185}
186
187while [ $# -gt 0 ]; do
188 case "$1" in
Gilles Peskineb9344e32017-12-19 18:24:31 +0100189 --armcc)
190 RUN_ARMCC=1
191 ;;
Simon Butcherd7f19022016-10-14 09:49:48 +0100192 --force|-f)
193 FORCE=1
194 ;;
Simon Butcherd7f19022016-10-14 09:49:48 +0100195 --gnutls-cli)
196 shift
197 GNUTLS_CLI="$1"
198 ;;
Simon Butcherd7f19022016-10-14 09:49:48 +0100199 --gnutls-legacy-cli)
200 shift
201 GNUTLS_LEGACY_CLI="$1"
202 ;;
203 --gnutls-legacy-serv)
204 shift
205 GNUTLS_LEGACY_SERV="$1"
206 ;;
Gilles Peskinea6901f42017-12-10 23:43:39 +0100207 --gnutls-serv)
208 shift
209 GNUTLS_SERV="$1"
210 ;;
211 --help|-h)
Simon Butcherd7f19022016-10-14 09:49:48 +0100212 usage
Gilles Peskinea6901f42017-12-10 23:43:39 +0100213 exit
214 ;;
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100215 --keep-going|-k)
216 KEEP_GOING=1
217 ;;
Gilles Peskinea6901f42017-12-10 23:43:39 +0100218 --memory|-m)
219 MEMORY=1
220 ;;
Gilles Peskineb9344e32017-12-19 18:24:31 +0100221 --no-armcc)
222 RUN_ARMCC=0
223 ;;
Gilles Peskinea6901f42017-12-10 23:43:39 +0100224 --openssl)
225 shift
226 OPENSSL="$1"
227 ;;
228 --openssl-legacy)
229 shift
230 OPENSSL_LEGACY="$1"
231 ;;
232 --out-of-source-dir)
233 shift
234 OUT_OF_SOURCE_DIR="$1"
235 ;;
236 --release-test|-r)
237 RELEASE=1
238 ;;
239 --seed|-s)
240 shift
241 SEED="$1"
242 ;;
243 *)
244 echo >&2 "Unknown option: $1"
245 echo >&2 "Run $0 --help for usage."
246 exit 120
Simon Butcherd7f19022016-10-14 09:49:48 +0100247 ;;
248 esac
249 shift
250done
251
252if [ $FORCE -eq 1 ]; then
253 rm -rf yotta/module "$OUT_OF_SOURCE_DIR"
254 git checkout-index -f -q $CONFIG_H
255 cleanup
256else
257
258 if [ -d yotta/module ]; then
259 err_msg "Warning - there is an existing yotta module in the directory 'yotta/module'"
260 echo "You can either delete your work and retry, or force the test to overwrite the"
261 echo "test by rerunning the script as: $0 --force"
262 exit 1
263 fi
264
265 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
266 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
267 echo "You can either delete this directory manually, or force the test by rerunning"
268 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
269 exit 1
270 fi
271
272 if ! git diff-files --quiet include/mbedtls/config.h; then
Simon Butcherd7f19022016-10-14 09:49:48 +0100273 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
274 echo "You can either delete or preserve your work, or force the test by rerunning the"
275 echo "script as: $0 --force"
276 exit 1
277 fi
278fi
279
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100280build_status=0
281if [ $KEEP_GOING -eq 1 ]; then
282 failure_summary=
283 failure_count=0
284 start_red=
285 end_color=
286 if [ -t 1 ]; then
287 case "$TERM" in
288 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
289 start_red=$(printf '\033[31m')
290 end_color=$(printf '\033[0m')
291 ;;
292 esac
293 fi
294 record_status () {
295 if "$@"; then
296 last_status=0
297 else
298 last_status=$?
299 text="$current_section: $* -> $last_status"
300 failure_summary="$failure_summary
301$text"
302 failure_count=$((failure_count + 1))
303 echo "${start_red}^^^^$text^^^^${end_color}"
304 fi
305 }
306 make () {
307 case "$*" in
308 *test|*check)
309 if [ $build_status -eq 0 ]; then
310 record_status command make "$@"
311 else
312 echo "(skipped because the build failed)"
313 fi
314 ;;
315 *)
316 record_status command make "$@"
317 build_status=$last_status
318 ;;
319 esac
320 }
321 final_report () {
322 if [ $failure_count -gt 0 ]; then
323 echo
324 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
325 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
326 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
327 elif [ -z "${1-}" ]; then
328 echo "SUCCESS :)"
329 fi
330 if [ -n "${1-}" ]; then
331 echo "Killed by SIG$1."
332 fi
333 }
334else
335 record_status () {
336 "$@"
337 }
338fi
339if_build_succeeded () {
340 if [ $build_status -eq 0 ]; then
341 record_status "$@"
342 fi
343}
344
Simon Butcherd7f19022016-10-14 09:49:48 +0100345if [ $RELEASE -eq 1 ]; then
346 # Fix the seed value to 1 to ensure that the tests are deterministic.
347 SEED=1
348fi
349
350msg "info: $0 configuration"
351echo "MEMORY: $MEMORY"
352echo "FORCE: $FORCE"
353echo "SEED: ${SEED-"UNSET"}"
354echo "OPENSSL: $OPENSSL"
355echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
356echo "GNUTLS_CLI: $GNUTLS_CLI"
357echo "GNUTLS_SERV: $GNUTLS_SERV"
358echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
359echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
360
361# To avoid setting OpenSSL and GnuTLS for each call to compat.sh and ssl-opt.sh
362# we just export the variables they require
363export OPENSSL_CMD="$OPENSSL"
364export GNUTLS_CLI="$GNUTLS_CLI"
365export GNUTLS_SERV="$GNUTLS_SERV"
366
367# Avoid passing --seed flag in every call to ssl-opt.sh
368[ ! -z ${SEED+set} ] && export SEED
369
370# Make sure the tools we need are available.
371check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$GNUTLS_CLI" "$GNUTLS_SERV" \
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100372 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV" "doxygen" "dot" \
Gilles Peskineb9344e32017-12-19 18:24:31 +0100373 "arm-none-eabi-gcc"
374if [ $RUN_ARMCC -ne 0 ]; then
375 check_tools "armcc"
376fi
Simon Butcherd7f19022016-10-14 09:49:48 +0100377
Gilles Peskined7602c22017-12-21 15:59:21 +0100378
379
380################################################################
381#### Basic checks
382################################################################
383
Simon Butcherd7f19022016-10-14 09:49:48 +0100384#
385# Test Suites to be executed
386#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200387# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100388# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard61bc57a2014-08-14 11:29:06 +0200389# and/or are more likely to fail than others (eg I use Clang most of the
390# time, so start with a GCC build).
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200391# 2. Minimize total running time, by avoiding useless rebuilds
392#
393# Indicative running times are given for reference.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100394
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100395msg "test: recursion.pl" # < 1s
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200396tests/scripts/recursion.pl library/*.c
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100397
Manuel Pégourié-Gonnardb3b8e432015-02-13 14:52:19 +0000398msg "test: freshness of generated source files" # < 1s
399tests/scripts/check-generated-files.sh
400
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200401msg "test: doxygen markup outside doxygen blocks" # < 1s
402tests/scripts/check-doxy-blocks.pl
403
Manuel Pégourié-Gonnarda687baf2015-04-09 11:09:03 +0200404msg "test/build: declared and exported names" # < 3s
405cleanup
406tests/scripts/check-names.sh
407
Gilles Peskined7602c22017-12-21 15:59:21 +0100408
409
410################################################################
411#### Build and test many configurations and targets
412################################################################
413
Simon Butcher73156352015-11-04 00:36:30 +0000414# Yotta not supported in 2.1 branch
415#msg "build: create and build yotta module" # ~ 30s
416#cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100417#record_status tests/scripts/yotta-build.sh
Manuel Pégourié-Gonnard77d56bb2015-07-28 15:00:37 +0200418
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100419msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100420cleanup
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100421CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100422make
423
Simon Butcherd7f19022016-10-14 09:49:48 +0100424msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100425make test
426programs/test/selftest
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200427
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100428msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100429if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200430
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100431msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100432if_build_succeeded tests/scripts/test-ref-configs.pl
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200433
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200434msg "build: with ASan (rebuild after ref-configs)" # ~ 1 min
435make
436
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100437msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100438if_build_succeeded tests/compat.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200439
Hanno Becker797c0842017-10-19 15:49:21 +0100440msg "build: default config except MFL extension (ASan build)" # ~ 30s
441cleanup
442cp "$CONFIG_H" "$CONFIG_BAK"
443scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
444CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
445make
446
447msg "test: ssl-opt.sh, MFL-related tests"
448tests/ssl-opt.sh -f "Max fragment length"
449
Simon Butcher02b8d482016-03-15 20:39:52 +0000450msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
451cleanup
452cp "$CONFIG_H" "$CONFIG_BAK"
453scripts/config.pl set MBEDTLS_SSL_PROTO_SSL3
454CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
455make
456
Simon Butcherd7f19022016-10-14 09:49:48 +0100457msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
Simon Butcher02b8d482016-03-15 20:39:52 +0000458make test
459programs/test/selftest
460
461msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100462if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
463if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher02b8d482016-03-15 20:39:52 +0000464
465msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100466if_build_succeeded tests/ssl-opt.sh
Simon Butcher02b8d482016-03-15 20:39:52 +0000467
Hanno Becker4f9973e2017-10-24 11:56:28 +0100468msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
469cleanup
470cp "$CONFIG_H" "$CONFIG_BAK"
471scripts/config.pl unset MBEDTLS_SSL_RENEGOTIATION
472CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
473make
474
475msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
476make test
477
478msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100479if_build_succeeded tests/ssl-opt.sh
Hanno Becker4f9973e2017-10-24 11:56:28 +0100480
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100481msg "build: cmake, full config, clang" # ~ 50s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100482cleanup
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200483cp "$CONFIG_H" "$CONFIG_BAK"
484scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100486CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check .
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100487make
488
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100489msg "test: main suites (full config)" # ~ 5s
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200490make test
491
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100492msg "test: ssl-opt.sh default (full config)" # ~ 1s
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100493if_build_succeeded tests/ssl-opt.sh -f Default
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200494
Manuel Pégourié-Gonnardea0920f2015-03-24 09:50:15 +0100495msg "test: compat.sh RC4, DES & NULL (full config)" # ~ 2 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100496if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -e '3DES\|DES-CBC3' -f 'NULL\|DES\|RC4\|ARCFOUR'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200497
Gilles Peskine31ed29d2018-03-01 22:23:50 +0100498msg "build: make, full config + DEPRECATED_WARNING, gcc -O" # ~ 30s
499cleanup
500cp "$CONFIG_H" "$CONFIG_BAK"
501scripts/config.pl full
Gilles Peskine29af5f32018-02-21 19:28:12 +0100502scripts/config.pl set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine31ed29d2018-03-01 22:23:50 +0100503# Build with -O -Wextra to catch a maximum of issues.
504make CC=gcc CFLAGS='-O -Werror -Wall -Wextra' lib programs
505make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
506
507msg "build: make, full config + DEPRECATED_REMOVED, clang -O" # ~ 30s
508# No cleanup, just tweak the configuration and rebuild
509make clean
510scripts/config.pl unset MBEDTLS_DEPRECATED_WARNING
Gilles Peskine29af5f32018-02-21 19:28:12 +0100511scripts/config.pl set MBEDTLS_DEPRECATED_REMOVED
Gilles Peskine31ed29d2018-03-01 22:23:50 +0100512# Build with -O -Wextra to catch a maximum of issues.
513make CC=clang CFLAGS='-O -Werror -Wall -Wextra' lib programs
514make CC=clang CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
Gilles Peskine29af5f32018-02-21 19:28:12 +0100515
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200516msg "test/build: curves.pl (gcc)" # ~ 4 min
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100517cleanup
518cmake -D CMAKE_BUILD_TYPE:String=Debug .
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100519if_build_succeeded tests/scripts/curves.pl
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100520
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200521msg "test/build: key-exchanges (gcc)" # ~ 1 min
522cleanup
523cmake -D CMAKE_BUILD_TYPE:String=Check .
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100524if_build_succeeded tests/scripts/key-exchanges.pl
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200525
Manuel Pégourié-Gonnard61fe8b02015-03-13 14:33:16 +0000526msg "build: Unix make, -Os (gcc)" # ~ 30s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100527cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100528make CC=gcc CFLAGS='-Werror -Os'
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530# this is meant to cath missing #define mbedtls_printf etc
Manuel Pégourié-Gonnard981732b2015-02-17 15:46:45 +0000531# disable fsio to catch some more missing #include <stdio.h>
Manuel Pégourié-Gonnard757ca002015-03-23 15:24:07 +0100532msg "build: full config except platform/fsio, make, gcc" # ~ 30s
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +0000533cleanup
534cp "$CONFIG_H" "$CONFIG_BAK"
535scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536scripts/config.pl unset MBEDTLS_PLATFORM_C
537scripts/config.pl unset MBEDTLS_PLATFORM_MEMORY
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +0100538scripts/config.pl unset MBEDTLS_PLATFORM_PRINTF_ALT
539scripts/config.pl unset MBEDTLS_PLATFORM_FPRINTF_ALT
540scripts/config.pl unset MBEDTLS_PLATFORM_SNPRINTF_ALT
541scripts/config.pl unset MBEDTLS_PLATFORM_EXIT_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
543scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100544make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +0000545
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +0100546# catch compile bugs in _uninit functions
547msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
548cleanup
549cp "$CONFIG_H" "$CONFIG_BAK"
550scripts/config.pl full
Manuel Pégourié-Gonnard7ee5ddd2015-06-03 10:33:55 +0100551scripts/config.pl set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100552make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +0100553
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200554msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
555cleanup
556cp "$CONFIG_H" "$CONFIG_BAK"
557scripts/config.pl full
558scripts/config.pl unset MBEDTLS_SSL_SRV_C
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100559make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200560
561msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
562cleanup
563cp "$CONFIG_H" "$CONFIG_BAK"
564scripts/config.pl full
565scripts/config.pl unset MBEDTLS_SSL_CLI_C
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100566make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200567
Manuel Pégourié-Gonnardf78e4de2015-05-29 10:52:14 +0200568msg "build: full config except net.c, make, gcc -std=c99 -pedantic" # ~ 30s
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +0200569cleanup
570cp "$CONFIG_H" "$CONFIG_BAK"
571scripts/config.pl full
Manuel Pégourié-Gonnardf78e4de2015-05-29 10:52:14 +0200572scripts/config.pl unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
573scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100574make CC=gcc CFLAGS='-Werror -O0 -std=c99 -pedantic' lib
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +0200575
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +0200576if uname -a | grep -F Linux >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100577 msg "build/test: make shared" # ~ 40s
578 cleanup
579 make SHARED=1 all check
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +0200580fi
581
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000582if uname -a | grep -F x86_64 >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100583 msg "build: i386, make, gcc" # ~ 30s
584 cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100585 make CC=gcc CFLAGS='-Werror -m32'
Andres Amaya Garcia401441b2017-05-08 11:19:19 +0100586
587 msg "test: i386, make, gcc"
588 make test
589
590 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
591 cleanup
592 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32'
593
594 msg "test: 64-bit ILP32, make, gcc"
595 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000596fi # x86_64
597
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000598msg "build: arm-none-eabi-gcc, make" # ~ 10s
599cleanup
600cp "$CONFIG_H" "$CONFIG_BAK"
601scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602scripts/config.pl unset MBEDTLS_NET_C
603scripts/config.pl unset MBEDTLS_TIMING_C
604scripts/config.pl unset MBEDTLS_FS_IO
Simon Butcherd7f19022016-10-14 09:49:48 +0100605scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000606# following things are not in the default config
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
608scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
609scripts/config.pl unset MBEDTLS_THREADING_C
610scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
611scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100612make CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld CFLAGS=-Werror lib
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000613
Gilles Peskineb9344e32017-12-19 18:24:31 +0100614if [ $RUN_ARMCC -ne 0 ]; then
615 msg "build: armcc, make"
616 cleanup
617 cp "$CONFIG_H" "$CONFIG_BAK"
618 scripts/config.pl full
619 scripts/config.pl unset MBEDTLS_NET_C
620 scripts/config.pl unset MBEDTLS_TIMING_C
621 scripts/config.pl unset MBEDTLS_FS_IO
622 scripts/config.pl unset MBEDTLS_HAVE_TIME
623 scripts/config.pl unset MBEDTLS_HAVE_TIME_DATE
624 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
625 # following things are not in the default config
626 scripts/config.pl unset MBEDTLS_DEPRECATED_WARNING
627 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
628 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
629 scripts/config.pl unset MBEDTLS_THREADING_C
630 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
631 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
632 make CC=armcc AR=armar WARNING_CFLAGS= lib
633fi
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +0100634
Gilles Peskineb49351d2017-05-12 15:26:58 +0200635msg "build: allow SHA1 in certificates by default"
636cleanup
637cp "$CONFIG_H" "$CONFIG_BAK"
638scripts/config.pl set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100639make CFLAGS='-Werror -Wall -Wextra'
Gilles Peskineb49351d2017-05-12 15:26:58 +0200640msg "test: allow SHA1 in certificates by default"
641make test
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100642if_build_succeeded tests/ssl-opt.sh -f SHA-1
Gilles Peskineb49351d2017-05-12 15:26:58 +0200643
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +0100644if which i686-w64-mingw32-gcc >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100645 msg "build: cross-mingw64, make" # ~ 30s
646 cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100647 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS=-Werror WINDOWS_BUILD=1
648 make WINDOWS_BUILD=1 clean
649 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS=-Werror WINDOWS_BUILD=1 SHARED=1
650 make WINDOWS_BUILD=1 clean
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +0100651fi
652
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000653# MemSan currently only available on Linux 64 bits
654if uname -a | grep 'Linux.*x86_64' >/dev/null; then
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000655
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100656 msg "build: MSan (clang)" # ~ 1 min 20s
657 cleanup
658 cp "$CONFIG_H" "$CONFIG_BAK"
659 scripts/config.pl unset MBEDTLS_AESNI_C # memsan doesn't grok asm
660 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
661 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +0200662
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100663 msg "test: main suites (MSan)" # ~ 10s
664 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100665
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100666 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100667 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100668
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100669 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100670
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100671 if [ "$MEMORY" -gt 0 ]; then
672 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100673 if_build_succeeded tests/compat.sh
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100674 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100675
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000676else # no MemSan
677
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100678 msg "build: Release (clang)"
679 cleanup
680 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
681 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000682
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100683 msg "test: main suites valgrind (Release)"
684 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000685
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100686 # Optional part(s)
687 # Currently broken, programs don't seem to receive signals
688 # under valgrind on OS X
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000689
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100690 if [ "$MEMORY" -gt 0 ]; then
691 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100692 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100693 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000694
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100695 if [ "$MEMORY" -gt 1 ]; then
696 msg "test: compat.sh --memcheck (Release)"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100697 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100698 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000699
700fi # MemSan
701
Simon Butcherd7f19022016-10-14 09:49:48 +0100702msg "build: cmake 'out-of-source' build"
703cleanup
704MBEDTLS_ROOT_DIR="$PWD"
705mkdir "$OUT_OF_SOURCE_DIR"
706cd "$OUT_OF_SOURCE_DIR"
707cmake "$MBEDTLS_ROOT_DIR"
708make
709
710msg "test: cmake 'out-of-source' build"
711make test
712cd "$MBEDTLS_ROOT_DIR"
713rm -rf "$OUT_OF_SOURCE_DIR"
714
Gilles Peskined7602c22017-12-21 15:59:21 +0100715
716
717################################################################
718#### Termination
719################################################################
720
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100721msg "Done, cleaning up"
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100722cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100723
724final_report