[ci skip] includes: detabify/dewhitespace stg/SMP.h
[ghc.git] / validate
index 406cfe0..8ea9eac 100755 (executable)
--- a/validate
+++ b/validate
@@ -1,24 +1,43 @@
 #!/bin/sh
 
-# Flags:
-#   --no-clean:       don't make clean first, just carry on from
-#                     a previous interrupted validation run
-#   --testsuite-only: don't build the compiler, just run
-#                     the test suite
-#   --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
-#   --fast:           Default. Opposite to --slow.
-#   --slow:           Build stage2 with -DDEBUG.
-#                     2008-07-01: 14% slower than the default.
-
 set -e
 
+show_help () {
+    cat <<EOF
+Usage: $0 [FLAGS]...
+
+Validate GHC source tree against testsuite; see
+http://ghc.haskell.org/trac/ghc/wiki/TestingPatches for more
+information.
+
+Flags:
+  --no-clean        don't make clean first, just carry on from
+                    a previous interrupted validation run
+  --testsuite-only  don't build the compiler, just run the test suite
+  --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
+  --normal          Default settings
+  --fast            Omit dyn way, omit binary distribution
+  --slow            Build stage2 with -DDEBUG.
+                    2008-07-01: 14% slower than the default.
+  --dph:            Also build libraries/dph and run associated tests.
+  --help            shows this usage help.
+
+  Set environment variable 'CPUS' to number of cores, to exploit
+  multiple cpu cores, e.g.
+
+    CPUS=8 ./validate
+
+EOF
+}
+
 no_clean=0
 testsuite_only=0
 hpc=NO
-slow=NO
+speed=NORMAL
+use_dph=0
 
 while [ $# -gt 0 ]
 do
@@ -33,31 +52,76 @@ do
         hpc=YES
         ;;
     --slow)
-        slow=YES
+        speed=SLOW
         ;;
     --fast)
-        slow=NO
+        speed=FAST
+        ;;
+    --normal)
+        speed=NORMAL
+        ;;
+    --no-dph) # for backward compat
+        use_dph=0
         ;;
+    --dph)
+        use_dph=1
+        ;;
+    --help)
+        show_help
+        exit 0;;
     *)
-        echo "Bad argument: $1" >&2
+        echo "$0: unrecognized argument '$1'" >&2
+        echo "Try '$0 --help' for more information." >&2
         exit 1;;
     esac
     shift
 done
 
+check_packages () {
+    echo "== Start $1 package check"
+    if [ "$bindistdir" = "" ]
+    then
+        inplace/bin/ghc-pkg check -v
+    else
+        "$bindistdir"/bin/ghc-pkg check -v
+    fi
+    echo "== End $1 package check"
+}
+
+detect_cpu_count () {
+    if [ "$CPUS" = "" ]; then
+        # Windows standard environment variable
+        CPUS="$NUMBER_OF_PROCESSORS"
+    fi
+
+    if [ "$CPUS" = "" ]; then
+        # Linux
+        CPUS=`getconf _NPROCESSORS_ONLN 2>/dev/null`
+    fi
+
+    if [ "$CPUS" = "" ]; then
+        # FreeBSD
+        CPUS=`getconf NPROCESSORS_ONLN 2>/dev/null`
+    fi
+
+    if [ "$CPUS" = "" ]; then
+        # nothing helped
+        CPUS="1"
+    fi
+
+    echo "using ${CPUS} CPUs" >&2
+}
+
+detect_cpu_count
+
 if ! [ -d testsuite ]
 then
-    echo 'You need the testsuite to validate' >&2
-    echo 'Run "./sync-all --testsuite get" to get it' >&2
+    echo 'Could not find the testsuite for validation' >&2
     exit 1
 fi
 
 if [ "$THREADS" = "" ]; then
-    if [ "$CPUS" = "" ]; then
-        threads=2
-    else
-        threads=$(($CPUS + 1)) # `expr $CPUS + 1`
-    fi
+    threads=$(($CPUS + 1)) # `expr $CPUS + 1`
 else
     threads="$THREADS"
 fi
@@ -80,39 +144,58 @@ if [ $no_clean -eq 0 ]; then
         INSTDIR=`cygpath -m "$INSTDIR"`
     fi
 
-    /usr/bin/perl -w boot --validate --required-tag=dph
+    if [ $use_dph -eq 1 ]; then
+        /usr/bin/perl -w boot --validate --required-tag=dph
+    else
+        /usr/bin/perl -w boot --validate
+    fi
     ./configure --prefix="$INSTDIR" $config_args
 fi
 
 thisdir=`utils/ghc-pwd/dist-boot/ghc-pwd`
 
-echo "Validating=YES" > mk/are-validating.mk
-
-$make -j$threads ValidateHpc=$hpc ValidateSlow=$slow
-
-$make binary-dist-prep
-$make test_bindist TEST_PREP=YES
-
-#
-# Install the mtl package into the bindist, because it is used by some
-# tests.  It isn't essential that we do this (the failing tests will
-# be treated as expected failures), but we get a bit more test
-# coverage, and also verify that we can install a package into the
-# bindist with Cabal.
-#
-bindistdir="bindisttest/install dir"
-cd libraries/mtl
-"$thisdir/$bindistdir/bin/ghc" --make Setup
-./Setup configure --with-ghc="$thisdir/$bindistdir/bin/ghc" --with-haddock="$thisdir/$bindistdir/bin/haddock" --global --builddir=dist-bindist --prefix="$thisdir/$bindistdir"
-./Setup build   --builddir=dist-bindist
-./Setup haddock --builddir=dist-bindist
-./Setup install --builddir=dist-bindist
-./Setup clean   --builddir=dist-bindist
-rm -f Setup Setup.exe Setup.hi Setup.o
-cd $thisdir
+echo "Validating=YES"       >  mk/are-validating.mk
+echo "ValidateSpeed=$speed" >> mk/are-validating.mk
+echo "ValidateHpc=$hpc"     >> mk/are-validating.mk
+
+if [ $use_dph -eq 1 ]; then
+    echo "BUILD_DPH=YES"    >> mk/are-validating.mk
+else
+    echo "BUILD_DPH=NO"     >> mk/are-validating.mk
+fi
+
+$make -j$threads
+# For a "debug make", add "--debug=b --debug=m"
+
+check_packages post-build
+
+# -----------------------------------------------------------------------------
+# Build and test a binary distribution (not --fast)
+
+if [ $speed != "FAST" ]; then
+
+    $make binary-dist-prep
+    $make test_bindist TEST_PREP=YES
+
+    #
+    # Install the xhtml package into the bindist.
+    # This verifies that we can install a package into the
+    # bindist with Cabal.
+    #
+    bindistdir="bindisttest/install   dir"
+
+    check_packages post-install
+
+    $make validate_build_xhtml BINDIST_PREFIX="$thisdir/$bindistdir"
+
+    check_packages post-xhtml
+fi
 
 fi # testsuite-only
 
+# -----------------------------------------------------------------------------
+# Run the testsuite
+
 if [ "$hpc" = YES ]
 then
     # XXX With threads we'd need to give a different tix file to each thread
@@ -123,14 +206,24 @@ then
     rm -f $HPCTIXFILE
 fi
 
-if [ "$slow" = YES ]
-then
-MAKE_TEST_TARGET=fulltest
-else
-MAKE_TEST_TARGET=test
-fi
+case "$speed" in
+SLOW)
+        MAKE_TEST_TARGET=fulltest
+        BINDIST="BINDIST=YES"
+        ;;
+NORMAL)
+        MAKE_TEST_TARGET=test
+        BINDIST="BINDIST=YES"
+        ;;
+FAST)
+        MAKE_TEST_TARGET=test
+        BINDIST="BINDIST=NO"
+        ;;
+esac
+
+$make $MAKE_TEST_TARGET stage=2 $BINDIST THREADS=$threads 2>&1 | tee testlog
 
-$make $MAKE_TEST_TARGET stage=2 BINDIST=YES THREADS=$threads 2>&1 | tee testlog
+check_packages post-testsuite
 
 if [ "$hpc" = YES ]
 then
@@ -141,7 +234,8 @@ echo "-------------------------------------------------------------------"
 if
     grep '\<0 caused framework failures' testlog >/dev/null 2>/dev/null &&
     grep '\<0 unexpected passes' testlog >/dev/null 2>/dev/null &&
-    grep '\<0 unexpected failures' testlog >/dev/null 2>/dev/null ; then
+    grep '\<0 unexpected failures' testlog >/dev/null 2>/dev/null &&
+    ! grep 'Some files are written by multiple tests' testlog >/dev/null 2>/dev/null ; then
     if [ $testsuite_only -eq 0 ] && [ $no_clean -eq 0 ]
     then
         cat <<EOF