release.sh

   1 #! /bin/sh
   2 #
   3 # SPDX-License-Identifier: BSD-2-Clause
   4 #
   5 # Copyright (c) 2018-2020 Gavin D. Howard and contributors.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions are met:
   9 #
  10 # * Redistributions of source code must retain the above copyright notice, this
  11 #   list of conditions and the following disclaimer.
  12 #
  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.
  16 #
  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.
  28 #
  29
  30 usage() {
  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'
  33         exit 1
  34 }
  35
  36 header() {
  37
  38         _header_msg="$1"
  39         shift
  40
  41         printf '\n'
  42         printf '*******************\n'
  43         printf "$_header_msg"
  44         printf '\n'
  45         printf '*******************\n'
  46         printf '\n'
  47 }
  48
  49 do_make() {
  50         make -j4 "$@"
  51 }
  52
  53 configure() {
  54
  55         _configure_CFLAGS="$1"
  56         shift
  57
  58         _configure_CC="$1"
  59         shift
  60
  61         _configure_configure_flags="$1"
  62         shift
  63
  64         _configure_GEN_HOST="$1"
  65         shift
  66
  67         _configure_LONG_BIT="$1"
  68         shift
  69
  70         if [ "$gen_tests" -eq 0 ]; then
  71                 _configure_configure_flags="-G $_configure_configure_flags"
  72         fi
  73
  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"
  78         fi
  79
  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")
  85
  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
  89 }
  90
  91 build() {
  92
  93         _build_CFLAGS="$1"
  94         shift
  95
  96         _build_CC="$1"
  97         shift
  98
  99         _build_configure_flags="$1"
 100         shift
 101
 102         _build_GEN_HOST="$1"
 103         shift
 104
 105         _build_LONG_BIT="$1"
 106         shift
 107
 108         configure "$_build_CFLAGS" "$_build_CC" "$_build_configure_flags" "$_build_GEN_HOST" "$_build_LONG_BIT"
 109
 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")
 114
 115         header "$_build_header"
 116
 117         do_make > /dev/null 2> "$scriptdir/.test.txt"
 118
 119         if [ -s "$scriptdir/.test.txt" ]; then
 120                 printf '%s generated warning(s):\n' "$_build_CC"
 121                 printf '\n'
 122                 cat "$scriptdir/.test.txt"
 123                 exit 1
 124         fi
 125 }
 126
 127 runtest() {
 128
 129         header "Running tests"
 130
 131         if [ "$#" -gt 0 ]; then
 132                 do_make "$@"
 133         else
 134                 do_make test
 135         fi
 136 }
 137
 138 runconfigtests() {
 139
 140         _runconfigtests_CFLAGS="$1"
 141         shift
 142
 143         _runconfigtests_CC="$1"
 144         shift
 145
 146         _runconfigtests_configure_flags="$1"
 147         shift
 148
 149         _runconfigtests_GEN_HOST="$1"
 150         shift
 151
 152         _runconfigtests_LONG_BIT="$1"
 153         shift
 154
 155         _runconfigtests_run_tests="$1"
 156         shift
 157
 158         if [ "$_runconfigtests_run_tests" -ne 0 ]; then
 159                 _runconfigtests_header=$(printf 'Running tests with configure flags')
 160         else
 161                 _runconfigtests_header=$(printf 'Building with configure flags')
 162         fi
 163
 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")
 169
 170         header "$_runconfigtests_header"
 171
 172         build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
 173                 "$_runconfigtests_configure_flags" "$_runconfigtests_GEN_HOST" \
 174                 "$_runconfigtests_LONG_BIT"
 175
 176         if [ "$_runconfigtests_run_tests" -ne 0 ]; then
 177                 runtest
 178         fi
 179
 180         do_make clean
 181
 182         build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
 183                 "$_runconfigtests_configure_flags -b" "$_runconfigtests_GEN_HOST" \
 184                 "$_runconfigtests_LONG_BIT"
 185
 186         if [ "$_runconfigtests_run_tests" -ne 0 ]; then
 187                 runtest
 188         fi
 189
 190         do_make clean
 191
 192         build "$_runconfigtests_CFLAGS" "$_runconfigtests_CC" \
 193                 "$_runconfigtests_configure_flags -d" "$_runconfigtests_GEN_HOST" \
 194                 "$_runconfigtests_LONG_BIT"
 195
 196         if [ "$_runconfigtests_run_tests" -ne 0 ]; then
 197                 runtest
 198         fi
 199
 200         do_make clean
 201 }
 202
 203 runconfigseries() {
 204
 205         _runconfigseries_CFLAGS="$1"
 206         shift
 207
 208         _runconfigseries_CC="$1"
 209         shift
 210
 211         _runconfigseries_configure_flags="$1"
 212         shift
 213
 214         _runconfigseries_run_tests="$1"
 215         shift
 216
 217         if [ "$run_64_bit" -ne 0 ]; then
 218
 219                 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
 220                         "$_runconfigseries_configure_flags" 1 64 "$_runconfigseries_run_tests"
 221
 222                 if [ "$run_gen_script" -ne 0 ]; then
 223                         runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
 224                                 "$_runconfigseries_configure_flags" 0 64 "$_runconfigseries_run_tests"
 225                 fi
 226
 227                 runconfigtests "$_runconfigseries_CFLAGS -DBC_RAND_BUILTIN=0" "$_runconfigseries_CC" \
 228                         "$_runconfigseries_configure_flags" 1 64 "$_runconfigseries_run_tests"
 229
 230         fi
 231
 232         runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
 233                 "$_runconfigseries_configure_flags" 1 32 "$_runconfigseries_run_tests"
 234
 235         if [ "$run_gen_script" -ne 0 ]; then
 236                 runconfigtests "$_runconfigseries_CFLAGS" "$_runconfigseries_CC" \
 237                         "$_runconfigseries_configure_flags" 0 32 "$_runconfigseries_run_tests"
 238         fi
 239 }
 240
 241 runtestseries() {
 242
 243         _runtestseries_CFLAGS="$1"
 244         shift
 245
 246         _runtestseries_CC="$1"
 247         shift
 248
 249         _runtestseries_configure_flags="$1"
 250         shift
 251
 252         _runtestseries_run_tests="$1"
 253         shift
 254
 255         _runtestseries_flags="E H N P EH EN EP HN HP NP EHN EHP ENP HNP EHNP"
 256
 257         runconfigseries "$_runtestseries_CFLAGS" "$_runtestseries_CC" \
 258                 "$_runtestseries_configure_flags" "$_runtestseries_run_tests"
 259
 260         for f in $_runtestseries_flags; do
 261                 runconfigseries "$_runtestseries_CFLAGS" "$_runtestseries_CC" \
 262                         "$_runtestseries_configure_flags -$f" "$_runtestseries_run_tests"
 263         done
 264 }
 265
 266 runtests() {
 267
 268         _runtests_CFLAGS="$1"
 269         shift
 270
 271         _runtests_CC="$1"
 272         shift
 273
 274         _runtests_configure_flags="$1"
 275         shift
 276
 277         _runtests_run_tests="$1"
 278         shift
 279
 280         runtestseries "-std=c99 $_runtests_CFLAGS" "$_runtests_CC" "$_runtests_configure_flags" "$_runtests_run_tests"
 281         runtestseries "-std=c11 $_runtests_CFLAGS" "$_runtests_CC" "$_runtests_configure_flags" "$_runtests_run_tests"
 282 }
 283
 284 karatsuba() {
 285
 286         header "Running Karatsuba tests"
 287         do_make karatsuba_test
 288 }
 289
 290 vg() {
 291
 292         header "Running valgrind"
 293
 294         if [ "$run_64_bit" -ne 0 ]; then
 295                 _vg_bits=64
 296         else
 297                 _vg_bits=32
 298         fi
 299
 300         build "$debug" "gcc" "-O0 -g" "1" "$_vg_bits"
 301         runtest valgrind
 302
 303         do_make clean_config
 304
 305         build "$debug" "gcc" "-O0 -gb" "1" "$_vg_bits"
 306         runtest valgrind
 307
 308         do_make clean_config
 309
 310         build "$debug" "gcc" "-O0 -gd" "1" "$_vg_bits"
 311         runtest valgrind
 312
 313         do_make clean_config
 314 }
 315
 316 debug() {
 317
 318         _debug_CC="$1"
 319         shift
 320
 321         _debug_run_tests="$1"
 322         shift
 323
 324         runtests "$debug" "$_debug_CC" "-g" "$_debug_run_tests"
 325
 326         if [ "$_debug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
 327                 runtests "$debug -fsanitize=undefined" "$_debug_CC" "-g" "$_debug_run_tests"
 328         fi
 329 }
 330
 331 release() {
 332
 333         _release_CC="$1"
 334         shift
 335
 336         _release_run_tests="$1"
 337         shift
 338
 339         runtests "$release" "$_release_CC" "-O3" "$_release_run_tests"
 340 }
 341
 342 reldebug() {
 343
 344         _reldebug_CC="$1"
 345         shift
 346
 347         _reldebug_run_tests="$1"
 348         shift
 349
 350         runtests "$debug" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
 351
 352         if [ "$_reldebug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then
 353                 runtests "$debug -fsanitize=address" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
 354                 runtests "$debug -fsanitize=memory" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests"
 355         fi
 356 }
 357
 358 minsize() {
 359
 360         _minsize_CC="$1"
 361         shift
 362
 363         _minsize_run_tests="$1"
 364         shift
 365
 366         runtests "$release" "$_minsize_CC" "-Os" "$_minsize_run_tests"
 367 }
 368
 369 build_set() {
 370
 371         _build_set_CC="$1"
 372         shift
 373
 374         _build_set_run_tests="$1"
 375         shift
 376
 377         debug "$_build_set_CC" "$_build_set_run_tests"
 378         release "$_build_set_CC" "$_build_set_run_tests"
 379         reldebug "$_build_set_CC" "$_build_set_run_tests"
 380         minsize "$_build_set_CC" "$_build_set_run_tests"
 381 }
 382
 383 clang_flags="-Weverything -Wno-padded -Wno-switch-enum -Wno-format-nonliteral"
 384 clang_flags="$clang_flags -Wno-cast-align -Wno-missing-noreturn -Wno-disabled-macro-expansion"
 385 clang_flags="$clang_flags -Wno-unreachable-code -Wno-unreachable-code-return"
 386 clang_flags="$clang_flags -Wno-implicit-fallthrough"
 387 gcc_flags="-Wno-maybe-uninitialized -Wno-clobbered"
 388
 389 cflags="-Wall -Wextra -Werror -pedantic -Wno-conditional-uninitialized"
 390
 391 debug="$cflags -fno-omit-frame-pointer"
 392 release="$cflags -DNDEBUG"
 393
 394 set -e
 395
 396 script="$0"
 397 scriptdir=$(dirname "$script")
 398
 399 if [ "$#" -gt 0 ]; then
 400         run_tests="$1"
 401         shift
 402 else
 403         run_tests=1
 404 fi
 405
 406 if [ "$#" -gt 0 ]; then
 407         gen_tests="$1"
 408         shift
 409 else
 410         gen_tests=1
 411 fi
 412
 413 if [ "$#" -gt 0 ]; then
 414         test_with_clang="$1"
 415         shift
 416 else
 417         test_with_clang=1
 418 fi
 419
 420 if [ "$#" -gt 0 ]; then
 421         test_with_gcc="$1"
 422         shift
 423 else
 424         test_with_gcc=1
 425 fi
 426
 427 if [ "$#" -gt 0 ]; then
 428         run_sanitizers="$1"
 429         shift
 430 else
 431         run_sanitizers=1
 432 fi
 433
 434 if [ "$#" -gt 0 ]; then
 435         run_valgrind="$1"
 436         shift
 437 else
 438         run_valgrind=1
 439 fi
 440
 441 if [ "$#" -gt 0 ]; then
 442         run_64_bit="$1"
 443         shift
 444 else
 445         run_64_bit=1
 446 fi
 447
 448 if [ "$#" -gt 0 ]; then
 449         run_gen_script="$1"
 450         shift
 451 else
 452         run_gen_script=0
 453 fi
 454
 455 if [ "$run_64_bit" -ne 0 ]; then
 456         bits=64
 457 else
 458         bits=32
 459 fi
 460
 461 cd "$scriptdir"
 462
 463 if [ "$test_with_clang" -ne 0 ]; then
 464         defcc="clang"
 465 elif [ "$test_with_gcc" -ne 0 ]; then
 466         defcc="gcc"
 467 else
 468         defcc="c99"
 469 fi
 470
 471 export ASAN_OPTIONS="abort_on_error=1"
 472 export UBSAN_OPTIONS="print_stack_trace=1,silence_unsigned_overflow=1"
 473
 474 build "$debug" "$defcc" "-g" "1" "$bits"
 475
 476 header "Running math library under --standard"
 477
 478 printf 'quit\n' | bin/bc -ls
 479
 480 version=$(make version)
 481
 482 do_make clean_tests
 483
 484 if [ "$test_with_clang" -ne 0 ]; then
 485         build_set "clang" "$run_tests"
 486 fi
 487
 488 if [ "$test_with_gcc" -ne 0 ]; then
 489         build_set "gcc" "$run_tests"
 490 fi
 491
 492 if [ "$run_tests" -ne 0 ]; then
 493
 494         build "$release" "$defcc" "-O3" "1" "$bits"
 495
 496         karatsuba
 497
 498         if [ "$run_valgrind" -ne 0 -a "$test_with_gcc" -ne 0 ]; then
 499                 vg
 500         fi
 501
 502         printf '\n'
 503         printf 'Tests successful.\n'
 504
 505         set +e
 506
 507         command -v afl-gcc > /dev/null 2>&1
 508         err="$?"
 509
 510         set -e
 511
 512         if [ "$err" -eq 0 ]; then
 513
 514                 header "Configuring for afl-gcc..."
 515
 516                 configure "$debug $gcc_flags -DBC_ENABLE_RAND=0" "afl-gcc" "-HNP -gO3" "1" "$bits"
 517
 518                 printf '\n'
 519                 printf 'Run make\n'
 520                 printf '\n'
 521                 printf 'Then run %s/tests/randmath.py and the fuzzer.\n' "$scriptdir"
 522                 printf '\n'
 523                 printf 'Then run ASan on the fuzzer test cases with the following build:\n'
 524                 printf '\n'
 525                 printf '    CFLAGS="-fsanitize=address -fno-omit-frame-pointer -DBC_ENABLE_RAND=0" ./configure.sh -gO3 -HNPS\n'
 526                 printf '    make\n'
 527                 printf '\n'
 528                 printf 'Then run the GitHub release script as follows:\n'
 529                 printf '\n'
 530                 printf '    <github_release> %s .travis.yml codecov.yml release.sh \\\n' "$version"
 531                 printf '    RELEASE.md tests/afl.py tests/radamsa.sh tests/radamsa.txt tests/randmath.py \\\n'
 532                 printf '    tests/bc/scripts/timeconst.bc\n'
 533
 534         fi
 535
 536 fi