3 # SPDX-License-Identifier: BSD-2-Clause
5 # Copyright (c) 2018-2020 Gavin D. Howard and contributors.
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions are met:
10 # * Redistributions of source code must retain the above copyright notice, this
11 # list of conditions and the following disclaimer.
13 # * Redistributions in binary form must reproduce the above copyright notice,
14 # this list of conditions and the following disclaimer in the documentation
15 # and/or other materials provided with the distribution.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
31 printf 'usage: %s [run_tests] [generate_tests] [test_with_clang] [test_with_gcc] \n' "$script"
32 printf ' [run_sanitizers] [run_valgrind] [run_64_bit] [run_gen_script]\n'
42 printf '*******************\n'
45 printf '*******************\n'
55 _configure_CFLAGS="$1"
61 _configure_configure_flags="$1"
64 _configure_GEN_HOST="$1"
67 _configure_LONG_BIT="$1"
70 if [ "$gen_tests" -eq 0 ]; then
71 _configure_configure_flags="-G $_configure_configure_flags"
74 if [ "$_configure_CC" = "clang" ]; then
75 _configure_CFLAGS="$clang_flags $_configure_CFLAGS"
76 elif [ "$_configure_CC" = "gcc" ]; then
77 _configure_CFLAGS="$gcc_flags $_configure_CFLAGS"
80 _configure_header=$(printf 'Running ./configure.sh %s ...' "$_configure_configure_flags")
81 _configure_header=$(printf "$_configure_header\n CC=\"%s\"\n" "$_configure_CC")
82 _configure_header=$(printf "$_configure_header\n CFLAGS=\"%s\"\n" "$_configure_CFLAGS")
83 _configure_header=$(printf "$_configure_header\n LONG_BIT=%s" "$_configure_LONG_BIT")
84 _configure_header=$(printf "$_configure_header\n GEN_HOST=%s" "$_configure_GEN_HOST")
86 header "$_configure_header"
87 CFLAGS="$_configure_CFLAGS" CC="$_configure_CC" GEN_HOST="$_configure_GEN_HOST" \
88 LONG_BIT="$_configure_LONG_BIT" ./configure.sh $_configure_configure_flags > /dev/null
99 _build_configure_flags="$1"
108 configure "$_build_CFLAGS" "$_build_CC" "$_build_configure_flags" "$_build_GEN_HOST" "$_build_LONG_BIT"
110 _build_header=$(printf 'Building...\n CC=%s' "$_build_CC")
111 _build_header=$(printf "$_build_header\n CFLAGS=\"%s\"" "$_build_CFLAGS")
112 _build_header=$(printf "$_build_header\n LONG_BIT=%s" "$_build_LONG_BIT")
113 _build_header=$(printf "$_build_header\n GEN_HOST=%s" "$_build_GEN_HOST")
115 header "$_build_header"
117 do_make > /dev/null 2> "$scriptdir/.test.txt"
119 if [ -s "$scriptdir/.test.txt" ]; then
120 printf '%s generated warning(s):\n' "$_build_CC"
122 cat "$scriptdir/.test.txt"
129 header "Running tests"
131 if [ "$#" -gt 0 ]; then
140 _runconfigtests_CFLAGS="$1"
143 _runconfigtests_CC="$1"
146 _runconfigtests_configure_flags="$1"
149 _runconfigtests_GEN_HOST="$1"
152 _runconfigtests_LONG_BIT="$1"
155 _runconfigtests_run_tests="$1"
158 if [ "$_runconfigtests_run_tests" -ne 0 ]; then
159 _runconfigtests_header=$(printf 'Running tests with configure flags')
161 _runconfigtests_header=$(printf 'Building with configure flags')
164 _runconfigtests_header=$(printf "$_runconfigtests_header \"%s\" ...\n" "$_runconfigtests_configure_flags")
165 _runconfigtests_header=$(printf "$_runconfigtests_header\n CC=%s\n" "$_runconfigseries_CC")
166 _runconfigtests_header=$(printf "$_runconfigtests_header\n CFLAGS=\"%s\"" "$_runconfigseries_CFLAGS")
167 _runconfigtests_header=$(printf "$_runconfigtests_header\n LONG_BIT=%s" "$_runconfigtests_LONG_BIT")
168 _runconfigtests_header=$(printf "$_runconfigtests_header\n GEN_HOST=%s" "$_runconfigtests_GEN_HOST")
170 header "$_runconfigtests_header"
172 build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
173 "$_runconfigtests_configure_flags" "$_runconfigtests_GEN_HOST" \
174 "$_runconfigtests_LONG_BIT"
176 if [ "$_runconfigtests_run_tests" -ne 0 ]; then
182 build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
183 "$_runconfigtests_configure_flags -b" "$_runconfigtests_GEN_HOST" \
184 "$_runconfigtests_LONG_BIT"
186 if [ "$_runconfigtests_run_tests" -ne 0 ]; then
192 build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
193 "$_runconfigtests_configure_flags -d" "$_runconfigtests_GEN_HOST" \
194 "$_runconfigtests_LONG_BIT"
196 if [ "$_runconfigtests_run_tests" -ne 0 ]; then
205 _runconfigseries_CFLAGS="$1"
208 _runconfigseries_CC="$1"
211 _runconfigseries_configure_flags="$1"
214 _runconfigseries_run_tests="$1"
217 if [ "$run_64_bit" -ne 0 ]; then
219 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
220 "$_runconfigseries_configure_flags" 1 64 "$_runconfigseries_run_tests"
222 if [ "$run_gen_script" -ne 0 ]; then
223 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
224 "$_runconfigseries_configure_flags" 0 64 "$_runconfigseries_run_tests"
227 runconfigtests "$_runconfigseries_CFLAGS -DBC_RAND_BUILTIN=0" "$_runconfigseries_CC" \
228 "$_runconfigseries_configure_flags" 1 64 "$_runconfigseries_run_tests"
232 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
233 "$_runconfigseries_configure_flags" 1 32 "$_runconfigseries_run_tests"
235 if [ "$run_gen_script" -ne 0 ]; then
236 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
237 "$_runconfigseries_configure_flags" 0 32 "$_runconfigseries_run_tests"
243 _runtestseries_CFLAGS="$1"
246 _runtestseries_CC="$1"
249 _runtestseries_configure_flags="$1"
252 _runtestseries_run_tests="$1"
255 _runtestseries_flags="E H N P EH EN EP HN HP NP EHN EHP ENP HNP EHNP"
257 runconfigseries "$_runtestseries_CFLAGS" "$_runtestseries_CC" \
258 "$_runtestseries_configure_flags" "$_runtestseries_run_tests"
260 for f in $_runtestseries_flags; do
261 runconfigseries "$_runtestseries_CFLAGS" "$_runtestseries_CC" \
262 "$_runtestseries_configure_flags -$f" "$_runtestseries_run_tests"
268 _runlibtests_CFLAGS="$1"
274 _runlibtests_configure_flags="$1"
277 _runlibtests_run_tests="$1"
280 _runlibtests_configure_flags="$_runlibtests_configure_flags -a"
282 build "$_runlibtests_CFLAGS" "$_runlibtests_CC" "$_runlibtests_configure_flags" 1 64
284 if [ "$_runlibtests_run_tests" -ne 0 ]; then
288 build "$_runlibtests_CFLAGS" "$_runlibtests_CC" "$_runlibtests_configure_flags" 1 32
290 if [ "$_runlibtests_run_tests" -ne 0 ]; then
297 _runtests_CFLAGS="$1"
303 _runtests_configure_flags="$1"
306 _runtests_run_tests="$1"
309 runtestseries "-std=c99 $_runtests_CFLAGS" "$_runtests_CC" "$_runtests_configure_flags" "$_runtests_run_tests"
310 runtestseries "-std=c11 $_runtests_CFLAGS" "$_runtests_CC" "$_runtests_configure_flags" "$_runtests_run_tests"
315 header "Running Karatsuba tests"
316 do_make karatsuba_test
321 header "Running valgrind"
323 if [ "$run_64_bit" -ne 0 ]; then
329 build "$debug" "gcc" "-O0 -g" "1" "$_vg_bits"
334 build "$debug" "gcc" "-O0 -gb" "1" "$_vg_bits"
339 build "$debug" "gcc" "-O0 -gd" "1" "$_vg_bits"
350 _debug_run_tests="$1"
353 runtests "$debug" "$_debug_CC" "-g" "$_debug_run_tests"
355 if [ "$_debug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
356 runtests "$debug -fsanitize=undefined" "$_debug_CC" "-g" "$_debug_run_tests"
359 runlibtests "$debug" "$_debug_CC" "-g" "$_debug_run_tests"
361 if [ "$_debug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
362 runlibtests "$debug -fsanitize=undefined" "$_debug_CC" "-g" "$_debug_run_tests"
371 _release_run_tests="$1"
374 runtests "$release" "$_release_CC" "-O3" "$_release_run_tests"
376 runlibtests "$release" "$_release_CC" "-O3" "$_release_run_tests"
384 _reldebug_run_tests="$1"
387 runtests "$debug" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
389 if [ "$_reldebug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
390 runtests "$debug -fsanitize=address" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
391 runtests "$debug -fsanitize=memory" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
394 runlibtests "$debug" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
396 if [ "$_reldebug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
397 runlibtests "$debug -fsanitize=address" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
398 runlibtests "$debug -fsanitize=memory" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
407 _minsize_run_tests="$1"
410 runtests "$release" "$_minsize_CC" "-Os" "$_minsize_run_tests"
412 runlibtests "$release" "$_minsize_CC" "-Os" "$_minsize_run_tests"
420 _build_set_run_tests="$1"
423 debug "$_build_set_CC" "$_build_set_run_tests"
424 release "$_build_set_CC" "$_build_set_run_tests"
425 reldebug "$_build_set_CC" "$_build_set_run_tests"
426 minsize "$_build_set_CC" "$_build_set_run_tests"
429 clang_flags="-Weverything -Wno-padded -Wno-switch-enum -Wno-format-nonliteral"
430 clang_flags="$clang_flags -Wno-cast-align -Wno-missing-noreturn -Wno-disabled-macro-expansion"
431 clang_flags="$clang_flags -Wno-unreachable-code -Wno-unreachable-code-return"
432 clang_flags="$clang_flags -Wno-implicit-fallthrough"
433 gcc_flags="-Wno-maybe-uninitialized -Wno-clobbered"
435 cflags="-Wall -Wextra -Werror -pedantic -Wno-conditional-uninitialized"
437 debug="$cflags -fno-omit-frame-pointer"
438 release="$cflags -DNDEBUG"
443 scriptdir=$(dirname "$script")
445 if [ "$#" -gt 0 ]; then
452 if [ "$#" -gt 0 ]; then
459 if [ "$#" -gt 0 ]; then
466 if [ "$#" -gt 0 ]; then
473 if [ "$#" -gt 0 ]; then
480 if [ "$#" -gt 0 ]; then
487 if [ "$#" -gt 0 ]; then
494 if [ "$#" -gt 0 ]; then
501 if [ "$run_64_bit" -ne 0 ]; then
509 if [ "$test_with_clang" -ne 0 ]; then
511 elif [ "$test_with_gcc" -ne 0 ]; then
517 export ASAN_OPTIONS="abort_on_error=1"
518 export UBSAN_OPTIONS="print_stack_trace=1,silence_unsigned_overflow=1"
520 build "$debug" "$defcc" "-g" "1" "$bits"
522 header "Running math library under --standard"
524 printf 'quit\n' | bin/bc -ls
526 version=$(make version)
530 if [ "$test_with_clang" -ne 0 ]; then
531 build_set "clang" "$run_tests"
534 if [ "$test_with_gcc" -ne 0 ]; then
535 build_set "gcc" "$run_tests"
538 if [ "$run_tests" -ne 0 ]; then
540 build "$release" "$defcc" "-O3" "1" "$bits"
544 if [ "$run_valgrind" -ne 0 -a "$test_with_gcc" -ne 0 ]; then
549 printf 'Tests successful.\n'
553 command -v afl-gcc > /dev/null 2>&1
558 if [ "$err" -eq 0 ]; then
560 header "Configuring for afl-gcc..."
562 configure "$debug $gcc_flags -DBC_ENABLE_RAND=0" "afl-gcc" "-HNP -gO3" "1" "$bits"
567 printf 'Then run %s/tests/randmath.py and the fuzzer.\n' "$scriptdir"
569 printf 'Then run ASan on the fuzzer test cases with the following build:\n'
571 printf ' CFLAGS="-fsanitize=address -fno-omit-frame-pointer -DBC_ENABLE_RAND=0" ./configure.sh -gO3 -HNPS\n'
574 printf 'Then run the GitHub release script as follows:\n'
576 printf ' <github_release> %s .travis.yml codecov.yml release.sh \\\n' "$version"
577 printf ' RELEASE.md tests/afl.py tests/radamsa.sh tests/radamsa.txt tests/randmath.py \\\n'
578 printf ' tests/bc/scripts/timeconst.bc\n'