libmudflap/testsuite/lib/mfdg.exp

   1 # `mfdg' - overrides parts of general purpose testcase driver.
   2 # Copyright (C) 1994 - 2001, 2003 Free Software Foundation, Inc.
   3
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17
  18
  19 # This is a modified excerpt of dejagnu/lib/dg.exp.
  20
  21 load_lib dg.exp
  22
  23
  24 # dg-test -- runs a new style DejaGnu test
  25 #
  26 # Syntax: dg-test [-keep-output] prog tool_flags default_extra_tool_flags
  27 #
  28 # PROG is the full path name of the file to pass to the tool (eg: compiler).
  29 # TOOL_FLAGS is a set of options to always pass.
  30 # DEFAULT_EXTRA_TOOL_FLAGS are additional options if the testcase has none.
  31
  32 #proc dg-test { prog tool_flags default_extra_tool_flags } {
  33 proc dg-test { args } {
  34     global dg-do-what-default dg-interpreter-batch-mode dg-linenum-format
  35     global errorCode errorInfo
  36     global tool
  37     global srcdir               ;# eg: /calvin/dje/build/gcc/./testsuite/
  38     global host_triplet target_triplet
  39
  40     set keep 0
  41     set i 0
  42     set dg-repetitions 1 ;# may be overridden by { dg-repetitions N }
  43     global dg-timeout
  44     set dg-timeout 0 ;# likewise by { dg-timeout N }
  45
  46     if { [string index [lindex $args 0] 0] == "-" } {
  47         for { set i 0 } { $i < [llength $args] } { incr i } {
  48             if { [lindex $args $i] == "--" } {
  49                 incr i
  50                 break
  51             } elseif { [lindex $args $i] == "-keep-output" } {
  52                 set keep 1
  53             } elseif { [string index [lindex $args $i] 0] == "-" } {
  54                 clone_output "ERROR: dg-test: illegal argument: [lindex $args $i]"
  55                 return
  56             } else {
  57                 break
  58             }
  59         }
  60     }
  61
  62     if { $i + 3 != [llength $args] } {
  63         clone_output "ERROR: dg-test: missing arguments in call"
  64         return
  65     }
  66     set prog [lindex $args $i]
  67     set tool_flags [lindex $args [expr $i + 1]]
  68     set default_extra_tool_flags [lindex $args [expr $i + 2]]
  69
  70     set text "\[- A-Za-z0-9\.\;\"\_\:\'\`\(\)\!\#\=\+\?\&\*]*"
  71
  72     set name [dg-trim-dirname $srcdir $prog]
  73     # If we couldn't rip $srcdir out of `prog' then just do the best we can.
  74     # The point is to reduce the unnecessary noise in the logs.  Don't strip
  75     # out too much because different testcases with the same name can confuse
  76     # `test-tool'.
  77     if [string match "/*" $name] {
  78         set name "[file tail [file dirname $prog]]/[file tail $prog]"
  79     }
  80
  81     if {$tool_flags != ""} {
  82         append name " ($tool_flags)"
  83     }
  84
  85     # Process any embedded dg options in the testcase.
  86
  87     # Use "" for the second element of dg-do-what so we can tell if it's been
  88     # explicitly set to "S".
  89     set dg-do-what [list ${dg-do-what-default} "" P]
  90     set dg-excess-errors-flag 0
  91     set dg-messages ""
  92     set dg-extra-tool-flags $default_extra_tool_flags
  93     set dg-final-code ""
  94
  95     # `dg-output-text' is a list of two elements: pass/fail and text.
  96     # Leave second element off for now (indicates "don't perform test")
  97     set dg-output-text "P"
  98
  99     # Define our own "special function" `unknown' so we catch spelling errors.
 100     # But first rename the existing one so we can restore it afterwards.
 101     catch {rename dg-save-unknown ""}
 102     rename unknown dg-save-unknown
 103     proc unknown { args } {
 104         return -code error "unknown dg option: $args"
 105     }
 106
 107     set tmp [dg-get-options $prog]
 108     foreach op $tmp {
 109         verbose "Processing option: $op" 3
 110         set status [catch "$op" errmsg]
 111         if { $status != 0 } {
 112             if { 0 && [info exists errorInfo] } {
 113                 # This also prints a backtrace which will just confuse
 114                 # testcase writers, so it's disabled.
 115                 perror "$name: $errorInfo\n"
 116             } else {
 117                 perror "$name: $errmsg for \"$op\"\n"
 118             }
 119             # ??? The call to unresolved here is necessary to clear `errcnt'.
 120             # What we really need is a proc like perror that doesn't set errcnt.
 121             # It should also set exit_status to 1.
 122             unresolved "$name: $errmsg for \"$op\""
 123             return
 124         }
 125     }
 126
 127     # Restore normal error handling.
 128     rename unknown ""
 129     rename dg-save-unknown unknown
 130
 131     # If we're not supposed to try this test on this target, we're done.
 132     if { [lindex ${dg-do-what} 1] == "N" } {
 133         unsupported "$name"
 134         verbose "$name not supported on this target, skipping it" 3
 135         return
 136     }
 137
 138     # Run the tool and analyze the results.
 139     # The result of ${tool}-dg-test is in a bit of flux.
 140     # Currently it is the name of the output file (or "" if none).
 141     # If we need more than this it will grow into a list of things.
 142     # No intention is made (at this point) to preserve upward compatibility
 143     # (though at some point we'll have to).
 144
 145     set results [${tool}-dg-test $prog [lindex ${dg-do-what} 0] "$tool_flags ${dg-extra-tool-flags}"];
 146
 147     set comp_output [lindex $results 0];
 148     set output_file [lindex $results 1];
 149
 150     #send_user "\nold_dejagnu.exp: comp_output1 = :$comp_output:\n\n"
 151     #send_user "\nold_dejagnu.exp: message = :$message:\n\n"
 152     #send_user "\nold_dejagnu.exp: message length = [llength $message]\n\n"
 153
 154     foreach i ${dg-messages} {
 155         verbose "Scanning for message: $i" 4
 156
 157         # Remove all error messages for the line [lindex $i 0]
 158         # in the source file.  If we find any, success!
 159         set line [lindex $i 0]
 160         set pattern [lindex $i 2]
 161         set comment [lindex $i 3]
 162         #send_user "Before:\n$comp_output\n"
 163         if [regsub -all "(^|\n)(\[^\n\]+$line\[^\n\]*($pattern)\[^\n\]*\n?)+" $comp_output "\n" comp_output] {
 164             set comp_output [string trimleft $comp_output]
 165             set ok pass
 166             set uhoh fail
 167         } else {
 168             set ok fail
 169             set uhoh pass
 170         }
 171         #send_user "After:\n$comp_output\n"
 172
 173         # $line will either be a formatted line number or a number all by
 174         # itself.  Delete the formatting.
 175         scan $line ${dg-linenum-format} line
 176         switch [lindex $i 1] {
 177             "ERROR" {
 178                 $ok "$name $comment (test for errors, line $line)"
 179             }
 180             "XERROR" {
 181                 x$ok "$name $comment (test for errors, line $line)"
 182             }
 183             "WARNING" {
 184                 $ok "$name $comment (test for warnings, line $line)"
 185             }
 186             "XWARNING" {
 187                 x$ok "$name $comment (test for warnings, line $line)"
 188             }
 189             "BOGUS" {
 190                 $uhoh "$name $comment (test for bogus messages, line $line)"
 191             }
 192             "XBOGUS" {
 193                 x$uhoh "$name $comment (test for bogus messages, line $line)"
 194             }
 195             "BUILD" {
 196                 $uhoh "$name $comment (test for build failure, line $line)"
 197             }
 198             "XBUILD" {
 199                 x$uhoh "$name $comment (test for build failure, line $line)"
 200             }
 201             "EXEC" { }
 202             "XEXEC" { }
 203         }
 204         #send_user "\nold_dejagnu.exp: comp_output2= :$comp_output:\n\n"
 205     }
 206     #send_user "\nold_dejagnu.exp: comp_output3 = :$comp_output:\n\n"
 207
 208     # Remove messages from the tool that we can ignore.
 209     #send_user "comp_output: $comp_output\n"
 210     set comp_output [prune_warnings $comp_output]
 211
 212     if { [info proc ${tool}-dg-prune] != "" } {
 213         set comp_output [${tool}-dg-prune $target_triplet $comp_output]
 214         switch -glob $comp_output {
 215             "::untested::*" {
 216                 regsub "::untested::" $comp_output "" message
 217                 untested "$name: $message"
 218                 return
 219             }
 220             "::unresolved::*" {
 221                 regsub "::unresolved::" $comp_output "" message
 222                 unresolved "$name: $message"
 223                 return
 224             }
 225             "::unsupported::*" {
 226                 regsub "::unsupported::" $comp_output "" message
 227                 unsupported "$name: $message"
 228                 return
 229             }
 230         }
 231     }
 232
 233     # See if someone forgot to delete the extra lines.
 234     regsub -all "\n+" $comp_output "\n" comp_output
 235     regsub "^\n+" $comp_output "" comp_output
 236     #send_user "comp_output: $comp_output\n"
 237
 238     # Don't do this if we're testing an interpreter.
 239     # FIXME: why?
 240     if { ${dg-interpreter-batch-mode} == 0 } {
 241         # Catch excess errors (new bugs or incomplete testcases).
 242         if ${dg-excess-errors-flag} {
 243             setup_xfail "*-*-*"
 244         }
 245         if ![string match "" $comp_output] {
 246             fail "$name (test for excess errors)"
 247             send_log "Excess errors:\n$comp_output\n"
 248         } else {
 249             pass "$name (test for excess errors)"
 250         }
 251     }
 252
 253     # Run the executable image if asked to do so.
 254     # FIXME: This is the only place where we assume a standard meaning to
 255     # the `keyword' argument of dg-do.  This could be cleaned up.
 256     if { [lindex ${dg-do-what} 0] == "run" } {
 257         if ![file exists $output_file] {
 258             warning "$name compilation failed to produce executable"
 259         } else {
 260             set testname $name
 261             for {set rep 0} {$rep < ${dg-repetitions}} {incr rep} {
 262                 # include repetition number in test name
 263                 if {$rep > 0} { set name "$testname (rerun $rep)" }
 264
 265                 set status -1
 266                 set result [${tool}_load $output_file]
 267                 set status [lindex $result 0];
 268                 set output [lindex $result 1];
 269                 #send_user "After exec, status: $status\n"
 270
 271                 if { "$status" == "pass" } {
 272                     verbose "Exec succeeded." 3
 273                 } elseif { "$status" == "fail" } {
 274                     # It would be nice to get some info out of errorCode.
 275                     if [info exists errorCode] {
 276                         verbose "Exec failed, errorCode: $errorCode" 3
 277                     } else {
 278                         verbose "Exec failed, errorCode not defined!" 3
 279                     }
 280                 }
 281
 282                 if { [lindex ${dg-do-what} 2] == "F" } {
 283                     # Instead of modelling this as an xfail (via setup_xfail),
 284                     # treat an expected crash as a success.
 285                     if { $status == "pass" } then { set status fail } else { set status pass }
 286                     set testtype "crash"
 287                 } else { set testtype "execution" }
 288
 289                 $status "$name $testtype test"
 290
 291                 if { [llength ${dg-output-text}] > 1 } {
 292                     #send_user "${dg-output-text}\n"
 293                     if { [lindex ${dg-output-text} 0] == "F" } {
 294                         setup_xfail "*-*-*"
 295                     }
 296                     set texttmp [lindex ${dg-output-text} 1]
 297                     if { ![regexp $texttmp ${output}] } {
 298                         fail "$name output pattern test"
 299                     } else {
 300                         pass "$name output pattern test"
 301                     }
 302                     verbose -log "Output pattern $texttmp"
 303                     unset texttmp
 304                 }
 305             }
 306         }
 307     }
 308
 309     # Are there any further tests to perform?
 310     # Note that if the program has special run-time requirements, running
 311     # of the program can be delayed until here.  Ditto for other situations.
 312     # It would be a bit cumbersome though.
 313
 314     if ![string match ${dg-final-code} ""] {
 315         regsub -all "\\\\(\[{}\])" ${dg-final-code} "\\1" dg-final-code
 316         # Note that the use of `args' here makes this a varargs proc.
 317         proc dg-final-proc { args } ${dg-final-code}
 318         verbose "Running dg-final tests." 3
 319         verbose "dg-final-proc:\n[info body dg-final-proc]" 4
 320         if [catch "dg-final-proc $prog" errmsg] {
 321             perror "$name: error executing dg-final: $errmsg"
 322             # ??? The call to unresolved here is necessary to clear `errcnt'.
 323             # What we really need is a proc like perror that doesn't set errcnt.
 324             # It should also set exit_status to 1.
 325             unresolved "$name: error executing dg-final: $errmsg"
 326         }
 327     }
 328
 329     # Do some final clean up.
 330     # When testing an interpreter, we don't compile something and leave an
 331     # output file.
 332     if { ! ${keep} && ${dg-interpreter-batch-mode} == 0 } {
 333         catch "exec rm -f $output_file"
 334     }
 335 }
 336
 337
 338
 339 #
 340 # Indicate that this test case is to be rerun several times.  This
 341 # is useful if it is nondeterministic.  This applies to rerunning the
 342 # test program only, not rebuilding it.
 343 # The embedded format is "{ dg-repetitions N }", where N is the number
 344 # of repetitions.  It better be greater than zero.
 345 #
 346 proc dg-repetitions { line value } {
 347     upvar dg-repetitions repetitions
 348     set repetitions $value
 349 }
 350
 351
 352 #
 353 # Indicate that this test case is to be run with a short timeout.
 354 # The embedded format is "{ dg-timeout N }", where N is in seconds.
 355 #
 356 proc dg-timeout { line value } {
 357     global dg-timeout
 358     set dg-timeout $value
 359 }
 360
 361
 362 # dejagnu's config/unix.exp hard-codes 300 seconds as the timeout
 363 # for any natively run executable.  That's too long for tests run
 364 # multiple times and that may possibly hang.  So we override it here
 365 # to provide some degree of control.
 366 rename standard_wait hooked_standard_wait
 367 proc standard_wait { dest timeout } {
 368     global dg-timeout
 369     if {[info exists dg-timeout]} {
 370         if {${dg-timeout} > 0} {
 371             verbose -log "Overriding timeout = ${dg-timeout}"
 372             set timeout ${dg-timeout}
 373         }
 374     }
 375
 376     hooked_standard_wait $dest $timeout
 377 }