validate 13.2 KB
Newer Older
1 2 3
#!/bin/sh

set -e
4

5 6 7 8 9
show_help () {
    cat <<EOF
Usage: $0 [FLAGS]...

Validate GHC source tree against testsuite; see
10
https://gitlab.haskell.org/ghc/ghc/wikis/testing-patches for more
11 12 13
information.

Flags:
14
  --no-clean        don't clean first, just carry on from
15 16
                    a previous interrupted validation run
  --testsuite-only  don't build the compiler, just run the test suite
Ben Gamari's avatar
Ben Gamari committed
17
  --build-only      don't test the compiler, just build it
18 19 20 21
  --hpc             build stage2 with -fhpc, and see how much of the
                    compiler the test suite covers.
                    2008-07-01: 63% slower than the default.
                    HTML generated here: testsuite/hpc_output/hpc_index.html
22 23 24
  --fast            Omit binary distribution. Omit certain tests.
  --slow            Build stage2 with -DDEBUG. Run tests for all WAYS,
                    but skip those that call compiler_stats_num_field.
25
                    2008-07-01: 14% slower than the default.
26
  --quiet           More pretty build log.
thomie's avatar
thomie committed
27
                    See Note [Default build system verbosity].
28 29 30 31
  --legacy          Build the compiler and run the tests through the legacy
                    make-based build system.
  --stack           Use Stack to build Hadrian and to provide the bootstrap
                    compiler.
32 33
  --help            shows this usage help.

34 35 36
  validate runs 'make -j\$THREADS', where by default THREADS is the number of
  cpus your computer has +1. You can set the environment variable THREADS to
  override this. For a sequential build you would for example use
37

38
    THREADS=1 ./validate
39

40 41 42
  You can set the 'config_args' environment variable to pass flags to
  'configure'.

43 44 45 46 47
  You can also use environment variables to pass extra options to the
  testsuite. For example:

    TEST='read001 read002' ./validate --testsuite-only --fast

48 49 50
EOF
}

51 52
no_clean=0
testsuite_only=0
Ben Gamari's avatar
Ben Gamari committed
53
build_only=0
54
hpc=NO
55
speed=NORMAL
56
be_quiet=0
57 58 59 60
# Validate uses gzip compression for the binary distribution to avoid the rather
# heavy cost of xz, which is the typical default. The options are defined in
# mk/config.mk.in
tar_comp=gzip
61
use_hadrian=YES
62
use_stack=NO
63
hadrian_build_root=_validatebuild
64 65 66 67 68 69 70 71 72 73

while [ $# -gt 0 ]
do
    case "$1" in
    --no-clean)
        no_clean=1
        ;;
    --testsuite-only)
        testsuite_only=1
        ;;
Ben Gamari's avatar
Ben Gamari committed
74 75 76
    --build-only)
        build_only=1
        ;;
77
    --hpc)
78 79 80
        hpc=YES
        ;;
    --slow)
81
        speed=SLOW
82 83
        ;;
    --fast)
84 85
        speed=FAST
        ;;
thomie's avatar
thomie committed
86
    --normal) # for backward compat
87
        speed=NORMAL
88
        ;;
89 90 91
    --quiet)
        be_quiet=1
        ;;
92
    --legacy)
Ben Gamari's avatar
Ben Gamari committed
93 94
        use_hadrian=NO
        ;;
95
    --stack)
Ben Gamari's avatar
Ben Gamari committed
96 97
        use_stack=YES
        ;;
98 99 100
    --help)
        show_help
        exit 0;;
101
    *)
102 103
        echo "$0: unrecognized argument '$1'" >&2
        echo "Try '$0 --help' for more information." >&2
104 105 106 107 108
        exit 1;;
    esac
    shift
done

109 110 111
check_packages () {
    if [ "$bindistdir" = "" ]
    then
Ben Gamari's avatar
Ben Gamari committed
112 113 114 115
        if [ "$use_hadrian" = "YES" ]
        then
            ghc_pkg=$hadrian_build_root/stage1/bin/ghc-pkg
        else
116
            ghc_pkg=inplace/bin/ghc-pkg
Ben Gamari's avatar
Ben Gamari committed
117
        fi
118
    else
thomie's avatar
thomie committed
119 120 121 122 123 124 125 126 127 128
        ghc_pkg="$bindistdir"/bin/ghc-pkg
    fi

    if [ $be_quiet -eq 1 ]
    then
        "$ghc_pkg" check
    else
        echo "== Start $1 package check"
        "$ghc_pkg" check -v
        echo "== End $1 package check"
129 130 131
    fi
}

Ben Gamari's avatar
Ben Gamari committed
132
CPUS=`mk/detect-cpu-count.sh`
133

134 135
if ! [ -d testsuite ]
then
136
    echo 'Could not find the testsuite for validation' >&2
137 138 139
    exit 1
fi

140
if [ "$THREADS" = "" ]; then
141
    threads=$(($CPUS + 1)) # `expr $CPUS + 1`
142
else
143
    threads="$THREADS"
144 145
fi

146 147
echo "using THREADS=${threads}" >&2

148
if [ "$use_hadrian" = "NO" ]
149
then
thomie's avatar
thomie committed
150
    make="gmake"
Ben Gamari's avatar
Ben Gamari committed
151 152 153 154 155 156 157 158 159 160 161
    if type gmake > /dev/null 2> /dev/null
    then
        make="gmake"
    else
        make="make"
    fi
    if [ $be_quiet -eq 1 ]; then
        # See Note [Default build system verbosity].
        make="$make -s"
    fi
    $make -C utils/checkUniques
162
else
163
    # Just build hadrian.
164 165
    if [ "$use_stack" = "NO" ]
    then
166
        hadrian/build --help > /dev/null
Ben Gamari's avatar
Ben Gamari committed
167
        cd hadrian
168
        hadrian_cmd=$(cabal new-exec -- which hadrian | grep 'hadrian$')
169
    else
Ben Gamari's avatar
Ben Gamari committed
170 171 172
        if [ $no_clean -eq 0 ]; then
            rm -rf hadrian/.stack-work
        fi
173
        hadrian/build-stack --help > /dev/null
Ben Gamari's avatar
Ben Gamari committed
174 175
        cd hadrian
        hadrian_cmd=$(stack exec -- which hadrian)
176
    fi
177 178 179 180 181 182
    cd ..
    # TODO: define a hadrian Flavour that mimics
    # mk/flavours/validate.mk and use it here
    # Until then, we're using the default flavour.
    hadrian="$hadrian_cmd -j$threads --build-root=$hadrian_build_root"
    if [ $be_quiet -eq 0 ]; then
Ben Gamari's avatar
Ben Gamari committed
183
        hadrian="$hadrian -V"
184 185
    fi
    echo "Hadrian command: $hadrian"
186 187
fi

188
if [ $testsuite_only -eq 0 ]; then
Ben Gamari's avatar
Ben Gamari committed
189
    thisdir=`pwd`
190

Ben Gamari's avatar
Ben Gamari committed
191 192 193 194 195 196 197
    if [ $no_clean -eq 0 ]; then
        if [ "$use_hadrian" = "NO" ]
        then
            $make maintainer-clean
        else
            $hadrian clean && rm -rf $hadrian_build_root
        fi
Simon Marlow's avatar
Simon Marlow committed
198

Ben Gamari's avatar
Ben Gamari committed
199
        INSTDIR="$thisdir/inst"
Simon Marlow's avatar
Simon Marlow committed
200

Ben Gamari's avatar
Ben Gamari committed
201 202
        python3 ./boot --validate
        ./configure --prefix="$INSTDIR" $config_args
203 204 205 206
    fi

    if [ "$use_hadrian" = "NO" ]
    then
Ben Gamari's avatar
Ben Gamari committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
        echo "Validating=YES"       >  mk/are-validating.mk
        echo "ValidateSpeed=$speed" >> mk/are-validating.mk
        echo "ValidateHpc=$hpc"     >> mk/are-validating.mk

        # Note [Default build system verbosity].
        #
        # From https://gitlab.haskell.org/ghc/ghc/wikis/design/build-system:
        #
        #   "The build system should clearly report what it's doing (and sometimes
        #   why), without being too verbose. It should emit actual command lines as
        #   much as possible, so that they can be inspected and cut & pasted."
        #
        # That should be the default. Only suppress commands, by setting V=0 and using
        # `make -s`, when user explicitly asks for it with `./validate --quiet`.
        if [ $be_quiet -eq 1 ]; then
      # See Note [Default build system verbosity].
            echo "V=0"                  >> mk/are-validating.mk # Less gunk
        fi

        $make -j$threads
        # For a "debug make", add "--debug=b --debug=m"
228
    else
Ben Gamari's avatar
Ben Gamari committed
229 230 231 232 233 234 235 236 237
        case $speed in
        SLOW)
            flavour=slow-validate ;;
        NORMAL)
            flavour=validate ;;
        FAST)
            flavour=validate ;;
        esac
        $hadrian --flavour=$flavour
238
    fi
239

Ben Gamari's avatar
Ben Gamari committed
240
    check_packages post-build
241

Ben Gamari's avatar
Ben Gamari committed
242 243 244 245 246 247 248 249
    bindistdir="bindisttest/install   dir"
    ghc="$bindistdir/bin/ghc"

    # -----------------------------------------------------------------------------
    # Build and test a binary distribution (not --fast)

    if [ $speed != "FAST" ]; then
        if [ "$use_hadrian" = "NO" ]
250
        then
Ben Gamari's avatar
Ben Gamari committed
251 252
            $make binary-dist-prep TAR_COMP=$tar_comp
            $make test_bindist TEST_PREP=YES TAR_COMP=$tar_comp
253
        else
Ben Gamari's avatar
Ben Gamari committed
254 255 256 257 258 259 260
            $hadrian binary-dist --docs=no-sphinx
            cfgdir=$(find $hadrian_build_root/bindist/ -name 'configure' | head -1)
            dir=$(dirname $cfgdir)
            cd "$dir"
            ./configure --prefix="$thisdir/$bindistdir" && make install
            cd $thisdir
            "$ghc" -e 'Data.Text.IO.putStrLn (Data.Text.pack "bindist test: OK")'
261
        fi
262

Ben Gamari's avatar
Ben Gamari committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        check_packages post-install

        if [ "$use_hadrian" = "NO" ]
        then
            $make validate_build_xhtml BINDIST_PREFIX="$thisdir/$bindistdir"
        else
            cd libraries/xhtml
            dynamicGhc=$("../../$ghc" --info | grep "GHC Dynamic" | cut -d',' -f3 | cut -d'"' -f2)
            if [ "$dynamicGhc" = "NO" ]
            then
                libFlags="--enable-shared --disable-library-vanilla"
            else
                libFlags="--disable-shared --enable-library-vanilla"
            fi
            libFlags="$libFlags --disable-library-prof"

            "../../$ghc" --make Setup
            ./Setup configure \
                --with-ghc="$thisdir/$ghc" \
                --with-haddock="$thisdir/$bindistdir/bin/haddock" \
                $libFlags \
                --global --builddir=dist-bindist \
                --prefix="$thisdir/$bindistdir"
            ./Setup build --builddir=dist-bindist
            ./Setup haddock -v0 --ghc-options=-optP-P --builddir=dist-bindist
            ./Setup install --builddir=dist-bindist
            ./Setup clean --builddir=dist-bindist
            rm -f Setup Setup.exe Setup.hi Setup.o
            cd ../../
        fi
293

Ben Gamari's avatar
Ben Gamari committed
294 295
        check_packages post-xhtml
    fi
296
fi # testsuite-only
297

298 299 300
# -----------------------------------------------------------------------------
# Run the testsuite

Ben Gamari's avatar
Ben Gamari committed
301 302 303 304 305 306 307 308 309 310
if [ "$build_only" -eq 1 ]; then
    cat <<EOF
-------------------------------------------------------------------
Congratulations!  This tree has compiled successfully.

You can now test your new compiler using ./validate --testsuite-only.
EOF
    exit 0
fi

311
if [ "$hpc" = YES ]
312 313 314 315 316 317 318 319 320
then
    # XXX With threads we'd need to give a different tix file to each thread
    #     and then sum them up at the end
    threads=1
    HPCTIXFILE=$thisdir/testsuite/hpc_output/ghc.tix
    export HPCTIXFILE
    rm -f $HPCTIXFILE
fi

321 322
case "$speed" in
SLOW)
Ben Gamari's avatar
Ben Gamari committed
323 324 325 326
    MAKE_TEST_TARGET=slowtest
    BINDIST="BINDIST=YES"
    HADRIAN_TEST_SPEED=slow
    ;;
327
NORMAL)
Ben Gamari's avatar
Ben Gamari committed
328 329 330 331
    MAKE_TEST_TARGET=test
    BINDIST="BINDIST=YES"
    HADRIAN_TEST_SPEED=normal
    ;;
332
FAST)
Ben Gamari's avatar
Ben Gamari committed
333 334 335 336
    MAKE_TEST_TARGET=fasttest
    BINDIST="BINDIST=NO"
    HADRIAN_TEST_SPEED=fast
    ;;
337
esac
338

339
if [ $be_quiet -eq 1 ] && [ -z $VERBOSE ]; then
340
    TEST_VERBOSITY="VERBOSE=1"
341 342
fi

343 344 345 346 347 348
# We need to be quite picky on Windows about which Python interpreter we use
# (#12554, #12661). Allow the user to override it.
if [ "z$PYTHON" != "z" ]; then
    PYTHON_ARG="PYTHON=$PYTHON"
fi

thomie's avatar
thomie committed
349
rm -f testsuite_summary.txt testsuite_summary_stage1.txt
350

351 352 353 354
if [ "$use_hadrian" = "NO" ]
then
    # Use LOCAL=0, see Note [Running tests in /tmp].
    $make -C testsuite/tests $BINDIST $PYTHON_ARG \
Ben Gamari's avatar
Ben Gamari committed
355 356 357 358
    $MAKE_TEST_TARGET stage=2 LOCAL=0 $TEST_VERBOSITY THREADS=$threads \
    NO_PRINT_SUMMARY=YES SUMMARY_FILE=../../testsuite_summary.txt \
    JUNIT_FILE=../../testsuite.xml \
    2>&1 | tee testlog
359 360 361 362 363

    # Run a few tests using the stage1 compiler.
    # See Note [Why is there no stage1 setup function?].
    # Don't use BINDIST=YES, as stage1 is not available in a bindist.
    $make -C testsuite/tests/stage1 $PYTHON_ARG \
Ben Gamari's avatar
Ben Gamari committed
364 365 366 367
    $MAKE_TEST_TARGET stage=1 LOCAL=0 $TEST_VERBOSITY THREADS=$threads \
    NO_PRINT_SUMMARY=YES SUMMARY_FILE=../../../testsuite_summary_stage1.txt \
    JUNIT_FILE=../../../testsuite_stage1.xml \
    2>&1 | tee testlog-stage1
368 369 370 371 372 373 374 375 376 377
else
    testghc="$thisdir/$ghc"
    arg="test --test-speed=$HADRIAN_TEST_SPEED \
              --test-compiler=\"$testghc\" \
              --summary=$thisdir/testsuite_summary.txt \
              --summary-junit=$thisdir/testsuite.xml"
    sh -c "$hadrian $arg"
    # TODO: Run testsuite/tests/stage1 using the stage 1 compiler when
    # BINDIST=NO.
fi
378 379 380 381 382 383 384

echo
echo '==== STAGE 1 TESTS ==== '
cat testsuite_summary_stage1.txt

echo '==== STAGE 2 TESTS ==== '
cat testsuite_summary.txt
385

386 387
check_packages post-testsuite

388
if [ "$hpc" = YES ]
389 390 391 392
then
    utils/hpc/hpc markup --hpcdir=. --srcdir=compiler --srcdir=testsuite/hpc_output --destdir=testsuite/hpc_output testsuite/hpc_output/ghc.tix
fi

393
if
thomie's avatar
thomie committed
394 395 396 397
    grep '\<0 caused framework failures' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected passes' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected failures' testsuite_summary.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected stat failures' testsuite_summary.txt >/dev/null 2>/dev/null &&
398 399 400 401 402 403

    grep '\<0 caused framework failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected passes' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null &&
    grep '\<0 unexpected stat failures' testsuite_summary_stage1.txt >/dev/null 2>/dev/null ; then

404 405 406
    if [ $testsuite_only -eq 0 ] && [ $no_clean -eq 0 ]
    then
        cat <<EOF
thomie's avatar
thomie committed
407
-------------------------------------------------------------------
408 409 410 411 412 413 414 415
Congratulations!  This tree has passed minimal testing.

NOTE: If you have made changes that may cause failures not tested for by
the minimal testing procedure, please do further testing as necessary.

When you are satisfied that you haven't broken anything, go ahead and
push/send your patches.
EOF
416
        if [ -f mk/validate.mk ] && grep -q "^[^#]" mk/validate.mk
417 418 419 420 421 422 423
        then
            cat <<EOF

WARNING: You seem to have things set in mk/validate.mk. Please check
that it is OK before pushing.
EOF
        fi
424 425 426
        cat <<EOF
-------------------------------------------------------------------
EOF
427 428
    else
        cat <<EOF
thomie's avatar
thomie committed
429
-------------------------------------------------------------------
430 431 432 433 434
I didn't find any problems, but this wasn't a complete validate run,
so be careful!

NOTE: If you have made changes that may cause failures not tested for by
the minimal testing procedure, please do further testing as necessary.
435
-------------------------------------------------------------------
436
EOF
Ben Gamari's avatar
Ben Gamari committed
437
    fi
438
else
thomie's avatar
thomie committed
439 440 441 442
    if [ $be_quiet -eq 0 ]
    then
       cat <<EOF
-------------------------------------------------------------------
443 444
Oops!  Looks like you have some unexpected test results or framework failures.
Please fix them before pushing/sending patches.
445
-------------------------------------------------------------------
446
EOF
thomie's avatar
thomie committed
447
    fi
448
    exit 1
449
fi