libstdc++-v3/mkcheck.in

   1 #!/usr/bin/env bash
   2
   3
   4 # Script to do automated testing and data collection for various test
   5 # files, so that we don't have to do this by hand on every test file.
   6 # It attempts to collect some diagnostic info about size and speed that
   7 # should be useful in the future as the library gets tuned for size
   8 # and speed.  In addition, it tests static and shared linkage, iff each
   9 # has been enabled.
  10
  11 # Invocation
  12 # mkcheck [01] (path to build) (path to src) (path to install)
  13
  14 ### XXX There are a lot of tests in here for OS-specific stuff.  If we
  15 ###     move to a 'configure.target' method of determining those extra
  16 ###     flags and whatnot, we can take out all those things and source
  17 ###     that file from here.  (Write that file with this in mind...)
  18
  19 ### XXX Note that breaking out of this with ^C will not work.  Dunno why.
  20
  21
  22 # 1: variables
  23 #
  24 # WHICH determines if you are
  25 # (0) testing the build binary and headers, or
  26 # (1) testing the installed binary and headers, or
  27 WHICH=$1
  28 if [ "$WHICH"x = 0x ] && [ $# -eq 3 ]; then
  29   echo "running mkcheck"
  30   echo "$0: testing the build directory"
  31   query="--built-library"
  32 elif [ "$WHICH"x = 1x ] && [ $# -eq 4 ]; then
  33   echo "running mkcheck"
  34   echo "$0: testing the install directory $4"
  35   query="--installed-library"
  36 else
  37   echo 'Usage: mkcheck 0 (path to build) (path to src)'
  38   echo '       mkcheck 1 (path to build) (path to src) (path to install)'
  39   exit 1;
  40 fi
  41
  42 # Now that we've successfully translated the numerical option into
  43 # a symbolic one, we can safely ignore it.
  44 shift
  45
  46 # This has been true all along.  Found out about it the hard way...
  47 case $BASH_VERSION in
  48     1*)  echo 'You need bash 2.x to run mkcheck.  Exiting.'; exit 1 ;;
  49     *)   ;;   # ??
  50 esac
  51
  52 # Compute the flags necessary to run the testsuite.
  53 saved_ifs=$IFS
  54 # bash 2.01 does the wrong thing with $* if IFS doesn't include space
  55 IFS=': '
  56 set `../tests_flags ${query} $*` || exit 1
  57 BUILD_DIR=$1; SRC_DIR=$2; PREFIX_DIR=$3; CXX=$4; CXXFLAGS=$5; INCLUDES=$6; LIBS=$7;
  58 IFS=$saved_ifs
  59
  60 # Build libtoolized surrogates to compile and run testcases.  Also,
  61 # adjust CXX so that the newly built compiler can find headers.
  62 if [ x$WHICH = x0 ] ; then
  63     CXX="$CXX -B`dirname $CXX`/"
  64 fi
  65 LIBTOOL="$BUILD_DIR/libtool"
  66 LTEXE="$LIBTOOL --mode=execute"
  67 LTCXX="$LIBTOOL --tag=CXX --mode=link $CXX $CXXFLAGS $INCLUDES $LIBS"
  68
  69 # specific libtool flag(s) to force the use of shared libraries, if any
  70 SH_FLAG=
  71
  72 # specific libtool flag(s) to force the use of static libraries, if any
  73 ST_FLAG="-static"
  74 #ST_FLAG="-all-static"
  75
  76 # Set up the testing directory, which should be in a directory called
  77 # "testsuite" in the root level of the build directory.
  78 TEST_DIR='.'
  79 # help libtool keep quiet
  80 if [ ! -d ${TEST_DIR}/.libs ]; then
  81     mkdir $TEST_DIR/.libs
  82 fi
  83
  84 # the name of the file that will collect and hold all this useful data:
  85 RESULTS_FILE="$TEST_DIR/$(date +%Y%m%d)-mkcheck.txt"
  86
  87 # the name of the log file that will append compiler diagnostics:
  88 LOG_FILE="$TEST_DIR/$(date +%Y%m%d)-mkchecklog.txt"
  89
  90 # the names of the specific test files to be run
  91 TESTS_FILE="$TEST_DIR/$(date +%Y%m%d)-mkcheckfiles.txt"
  92
  93 # the heap size and virtual mem limit for testsuite binaries
  94 # See http://gcc.gnu.org/ml/libstdc++/2000-10/msg00029.html
  95 MAX_MEM_USAGE=16384
  96
  97 #
  98 # 2: clean, make files, append general test info
  99 #
 100
 101 # Remove old executables.
 102 rm -rf "$TEST_DIR"/*exe
 103
 104 # Remove old core files (which now get left in cwd, not $TEST_DIR).
 105 rm -rf ./*core*
 106
 107 if [ -f $RESULTS_FILE ]; then
 108     rm $RESULTS_FILE
 109 fi
 110 if [ -f $LOG_FILE ]; then
 111     rm $LOG_FILE
 112 fi
 113
 114 # Make a list of the files we're going to run, or use an old one if it exists.
 115 if [ ! -f "$TESTS_FILE" ]; then
 116     echo "making file $TESTS_FILE"
 117     for LONG_NAME in $SRC_DIR/testsuite/*/*.cc
 118     do
 119         DIR_NAME=$(dirname $LONG_NAME)
 120         SHORT_NAME="`basename $DIR_NAME`/`basename $LONG_NAME`"
 121         echo "$SHORT_NAME" >> $TESTS_FILE
 122     done
 123 fi
 124
 125 # Nasty solution to replace GNU date(1)'s %s time_t output function.
 126 TIMER_COMMAND=$TEST_DIR/printnow.exe
 127 if [ ! -x "$TIMER_COMMAND" ]; then
 128     echo "making utility $TIMER_COMMAND"
 129     gcc -o "$TIMER_COMMAND" "$SRC_DIR/testsuite/printnow.c"
 130     strip "$TIMER_COMMAND"
 131 fi
 132
 133 # Copy over the data files for filebufs
 134 cp $SRC_DIR/testsuite/27_io/*.txt $TEST_DIR
 135 cp $SRC_DIR/testsuite/27_io/*.tst $TEST_DIR
 136 chmod u+w $TEST_DIR/*.txt
 137 chmod u+w $TEST_DIR/*.tst
 138
 139 # Emit useful info about compiler and platform
 140 echo "host: $(uname -mrsv)" >> $RESULTS_FILE
 141 echo "compiler: $($CXX -v 2>&1)" >> $RESULTS_FILE
 142 echo "compiler flags: $CXXFLAGS" >> $RESULTS_FILE
 143 echo "date: $(date +%Y%m%d)" >> $RESULTS_FILE
 144 echo "" >> $RESULTS_FILE
 145
 146 explanation='+: pass, -b: build failure, -r: run failure, x: disabled'
 147 printf "%s\n     %s\n"  'p == pass/fail execution test'  "$explanation"  \
 148        >> $RESULTS_FILE
 149 echo "ctime == time to compile and link" >> $RESULTS_FILE
 150 echo "etime == time for executable to run" >> $RESULTS_FILE
 151 echo "text == size of the executable text section" >> $RESULTS_FILE
 152 echo "data == size of the executable data section" >> $RESULTS_FILE
 153 echo "total == size of the executable" >> $RESULTS_FILE
 154 echo "" >> $RESULTS_FILE
 155
 156 echo "p" | awk '{printf("%s ", $1)}' >> $RESULTS_FILE
 157 echo "ctime" "etime" | awk '{printf("%s\t%s\t", $1, $2)}' >> $RESULTS_FILE
 158 echo "text" "data" | awk '{printf("%s\t%s\t", $1, $2)}' >> $RESULTS_FILE
 159 echo "total" "name" | awk '{printf("%s\t%s\t", $1, $2)}' >> $RESULTS_FILE
 160 echo "" >> $RESULTS_FILE
 161
 162 # Counters.  These could be members of an array, but they'd all have to
 163 # become individuals anyhow if we ever change this script to super-portable sh.
 164 shared_pass=0
 165 shared_fail=0
 166 static_pass=0
 167 static_fail=0
 168
 169
 170 #
 171 # 2.5:  support functions
 172 #
 173
 174 # Figure out how to extract size information from binaries.  We take
 175 # the text of the value we want as an argument, and leave the size in
 176 # the appropriate variable.
 177 #
 178 # We discover what kind of size(1) we are using *once* and build a shell
 179 # function named 'size_command' to wrap it.  (The "function" keyword is
 180 # redundant here, but helps me read it, so there.)  Previously we were
 181 # re-discovering the size(1) arguments three times for each test; sloooow.
 182 #
 183 # It is VERY IMPORTANT not to compare these numbers across platforms.
 184 # Different size(1)'s extract section information differently.  For
 185 # example, using the native Sun size(1) and GNU size(1) built for Suns
 186 # on the exact same binary will give very different numbers, due to all
 187 # the variance in command-line options and arbitrary names of ELF sections.
 188 #
 189 # and suddenly we go to 2-space indentations...
 190 setup_size_command()
 191 {
 192   if size --version 2> /dev/null | grep -c GNU > /dev/null;
 193   then    # Then we're using a GNU size(1) built for this platform.
 194     # We lose .rodata and .data1 and who knows what else... kludge.
 195     function size_command()
 196     {
 197       case $1 in
 198         TEXT)  TEXT=$(size -A $EXENAME | grep ^.text | awk '{print $2}')  ;;
 199         DATA)  DATA=$(size -A $EXENAME | awk '/^\.data[         ]/{print $2}')  ;;
 200         SIZE)  SIZE=$(size -A $EXENAME | grep otal | awk '{print $2}')  ;;
 201       esac
 202     }
 203   else
 204     # Not using GNU size; check for platform.  These numbers seem to match
 205     # up to text/data/total, although their meanings seem to be different.
 206     # THIS TABLE IS SORTED.  KEEP IT THAT WAY.
 207     case @host_os@ in
 208       *aix*)
 209         function size_command()
 210         {
 211           case $1 in
 212             TEXT)  TEXT=$(size -X32_64 $EXENAME | awk '{print $2}')  ;;
 213             DATA)  DATA=$(size -X32_64 $EXENAME | awk '{print $4}')  ;;
 214             SIZE)  SIZE=$(size -X32_64 $EXENAME | awk '{print $12}')  ;;
 215           esac
 216         }
 217         ;;
 218       *irix*)
 219         function size_command()
 220         {
 221           case $1 in
 222             TEXT)  TEXT=$(size -4 $EXENAME | awk '{print $1}')  ;;
 223             DATA)  DATA=$(size -4 $EXENAME | awk '{print $3}')  ;;
 224             SIZE)  SIZE=$(size -4 $EXENAME | awk '{print $7}')  ;;
 225           esac
 226         }
 227         ;;
 228       *solaris*)
 229         function size_command()
 230         {
 231           case $1 in
 232             TEXT)  TEXT=$(size $EXENAME | awk '{print $1}')  ;;
 233             DATA)  DATA=$(size $EXENAME | awk '{print $3}')  ;;
 234             SIZE)  SIZE=$(size $EXENAME | awk '{print $7}')  ;;
 235           esac
 236         }
 237         ;;
 238       *)
 239         echo ' * Warning!  Skipping section sizes!' 1>&2
 240         function size_command()
 241         {
 242         case $1 in
 243           TEXT)  TEXT=0 ;;
 244           DATA)  DATA=0 ;;
 245           SIZE)  SIZE=0 ;;
 246         esac
 247         }
 248         ;;
 249     esac
 250   fi
 251 }
 252
 253 # Test for file output
 254 test_for_output()
 255 {
 256     # This checks for emitted output files, which is useful when
 257     # testing file-related output.  The rules for this working are as
 258     # follows: the emitted file must have the ".txt" extension, and be
 259     # based on the actual *.cc file's name.  For example, 27/filbuf.cc
 260     # currently outputs files named 27/filebuf-2.txt and 27/filebuf-3.txt.
 261     # Also, the first emitted file must be in the form $NAME-1.txt.
 262     # The control file must follow the same constraints, but have a
 263     # ".tst" extension.  Thus, you have 27/filebuf-2.tst, etc.
 264
 265     # NAME contains the source name, like 27/filebuf.cc
 266     # From that NAME, we want to generate some possible names, using
 267     # ls on MATCH, a pattern description generated with sed.
 268
 269     # this is the name of the resulting diff file, if any
 270     DIFF_FILE="`echo $TEST_NAME | sed 's/cc$/diff/'`"
 271     # construct wildcard names, ie for $NAME=filebuf.cc, makes "filebuf*.tst"
 272     DATA_FILES="`echo $TEST_NAME | sed 's/\.cc/\*\.tst/g'`"
 273     # make sure there is at least one, then go
 274     ST_E="`echo $TEST_NAME | sed 's/\.cc/\-1\.tst/g'`"
 275     if [ -f $ST_E ]; then
 276         # list of actual files that match the wildcard above, ie
 277         # "filebuf-1.tst"
 278         ST_MATCH_LIST="`ls $DATA_FILES`"
 279         for i in $ST_MATCH_LIST; do
 280             # ST_OUT_FILE is generated in the build directory.
 281             PRE_NAME2="$TEST_DIR/`basename $i`"
 282             ST_OUT_FILE="`echo $PRE_NAME2 | sed 's/tst$/txt/'`"
 283             diff $ST_OUT_FILE $i > $DIFF_FILE
 284             if [ -s $DIFF_FILE ]; then
 285                 RESULT="-r"
 286             else
 287                 RESULT="+"
 288             fi
 289             rm $DIFF_FILE
 290         done
 291     else
 292         # the file does no output, and didn't abnormally
 293         # terminate, so assume passed.
 294         RESULT="+"
 295     fi
 296 }
 297
 298
 299 #
 300 # 3: compile, link, execute, time
 301 #
 302 # Abstract out the common code for compiling, linking, executing and printing.
 303 test_file()
 304 {
 305     # NB: S_FLAG has to be last argument because it may be null, and
 306     # error checking hasn't been invented yet.
 307     NAME=$1
 308     EXENAME=$2
 309     S_FLAG=$3
 310
 311     SRC_NAME="$SRC_DIR/testsuite/$1"
 312     TEST_NAME="$TEST_DIR/`basename $NAME`"
 313
 314     # This would be deliciously easy if GNU date's %s were always around.
 315     # There are three ways to do this:  1) use the builtin 'time' like we
 316     # do later; then getting compiler errors into LOG_FILE is a nightmare.
 317     # 2) Grab the output of a formatted date(1) and do the math; harder
 318     # and harder as we try compiling at, say, top of the hour; we would
 319     # eventually have to calculate time_t anyhow.  Or 3) just grab two
 320     # time_t's (no more overhead than grabbing two date(1)'s).
 321     compiler_invocation="$LTCXX $S_FLAG $SRC_NAME -o $EXENAME"
 322     COMP_TIME_START=$($TIMER_COMMAND)
 323     $compiler_invocation >> compile.out 2>&1
 324     COMP_TIME_END=$($TIMER_COMMAND)
 325
 326     if [ $COMP_TIME_START -lt $COMP_TIME_END ]; then
 327         C_TIME=$[ $COMP_TIME_END - $COMP_TIME_START ]
 328     else
 329         C_TIME="0"
 330     fi
 331
 332     if [ -f $EXENAME ]; then
 333         rm compile.out
 334         size_command TEXT
 335         size_command DATA
 336         size_command SIZE
 337
 338         # Actually run the executable and time it.  Note that output
 339         # printed by the executable will be lost and cannot be redirected,
 340         # because we need to capture the output of 'time'.  Bummer.
 341         TIMEFORMAT='timemark %R'
 342         E_TIME_TEXT="$(exec 2>&1;                                        \
 343                      ulimit -d $MAX_MEM_USAGE; ulimit -v $MAX_MEM_USAGE; \
 344                      time $LTEXE $EXENAME)"
 345         E_ABNORMAL_TERMINATION=$?
 346         E_TIME="$(echo $E_TIME_TEXT | awk '{print $2}')"
 347         # joining those two commands does not work due to quoting problems:
 348         #E_TIME="$(exec 2>&1; time $EXENAME | awk '{print $2}')"
 349         # this will work as a fallback on certain systems...?
 350         #E_TIME=$(exec 2>&1; time $EXENAME | cut -d ' ' -f 2)
 351
 352         if [ "$E_ABNORMAL_TERMINATION" -ne 0 ]; then
 353             RESULT='-r'
 354             rm -f ./*core
 355             # sometimes you want to save all core files for review:
 356             #mv ./core $EXENAME.core
 357             # sometimes the OS allows you to name core files yourself:
 358             #mv ./*core $EXENAME.core
 359             #mv ./core* $EXENAME.core
 360         else
 361             test_for_output
 362         fi
 363
 364         # sometimes you want to save all failing exe files for review:
 365         if [ "$RESULT" = "+" ]; then
 366             rm "$EXENAME"
 367         fi
 368     else
 369         # the file did not compile/link.
 370         printf "\n" >> $LOG_FILE
 371         `cat compile.out >> $LOG_FILE`
 372         rm compile.out
 373         RESULT="-b"
 374         TEXT="0"
 375         DATA="0"
 376         SIZE="0"
 377     fi
 378
 379     # update the counters
 380     if test "$RESULT" = "+" ; then
 381         if test x"$S_FLAG" = x"$ST_FLAG"; then
 382             static_pass=`expr $static_pass + 1`
 383         else
 384             shared_pass=`expr $shared_pass + 1`
 385         fi
 386     else
 387         if test x"$S_FLAG" = x"$ST_FLAG"; then
 388             static_fail=`expr $static_fail + 1`
 389         else
 390             shared_fail=`expr $shared_fail + 1`
 391         fi
 392     fi
 393
 394     printf "%s\t" "$RESULT"
 395     printf "%-2s %d\t%.3f\t%s\t%s\t%s\t%s %s\n"   \
 396         "$RESULT" $C_TIME $E_TIME $TEXT $DATA $SIZE $NAME "$S_FLAG"    \
 397         >> $RESULTS_FILE
 398 }
 399
 400 setup_size_command
 401 echo ""
 402 echo "Detailed test results in .${RESULTS_FILE/$BUILD_DIR}"
 403 echo $explanation
 404 echo "------------------------------------------------------------------------"
 405 printf "static\tshared\ttest\n"
 406 echo "------------------------------------------------------------------------"
 407
 408 TEST_TIME_START=$($TIMER_COMMAND)
 409 for NAME in `cat $TESTS_FILE`
 410 do
 411     PRE_NAME="$TEST_DIR/`basename $NAME`"
 412     ST_NAME="`echo $PRE_NAME | sed 's/cc$/st-exe/'`"
 413     SH_NAME="`echo $PRE_NAME | sed 's/cc$/sh-exe/'`"
 414
 415     if test @enable_static@ = yes; then
 416         test_file $NAME $ST_NAME "$ST_FLAG"
 417     else
 418         printf "x\t"
 419         printf "static skipped\n" >> $RESULTS_FILE
 420     fi
 421     if test @enable_shared@ = yes; then
 422         test_file $NAME $SH_NAME "$SH_FLAG"
 423     else
 424         printf "x\t"
 425         printf "shared skipped\n" >> $RESULTS_FILE
 426     fi
 427     printf "%s\n" "$NAME"
 428
 429     echo "" >> $RESULTS_FILE
 430 done
 431 TEST_TIME_END=$($TIMER_COMMAND)
 432
 433
 434 #
 435 # 4: summary
 436 #
 437 # grep can count faster than we can...
 438 total_failures=`expr ${shared_fail} + ${static_fail}`
 439 total_successes=`expr ${shared_pass} + ${static_pass}`
 440 resultstext="pass/fail results:  ${shared_pass}/${shared_fail} shared + ${static_pass}/${static_fail} static = ${total_successes}/${total_failures} total"
 441 if [ $total_failures -eq 0 ]; then
 442     resultstext="${resultstext}, WIN WIN"
 443 fi
 444 sed -e "/^date:/a\\
 445 $resultstext" $RESULTS_FILE > ${RESULTS_FILE}.tmp
 446 mv ${RESULTS_FILE}.tmp $RESULTS_FILE
 447
 448 if [ $TEST_TIME_START -lt $TEST_TIME_END ]; then
 449     TEST_TIME=$[ $TEST_TIME_END - $TEST_TIME_START ]
 450     echo "testrun == $TEST_TIME seconds"
 451     echo "testrun == $TEST_TIME seconds" >> $RESULTS_FILE
 452 fi
 453
 454 exit 0
 455
 456