gas/testsuite/lib/gas-defs.exp

   1 # Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   2 # 2004, 2005, 2007 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 3 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, Inc., 51 Franklin Street - Fifth Floor, Boston,
  17 # MA 02110-1301, USA.
  18
  19 # Please email any bugs, comments, and/or additions to this file to:
  20 # dejagnu@gnu.org
  21
  22 # This file was written by Ken Raeburn (raeburn@cygnus.com).
  23
  24 proc gas_version {} {
  25     global AS
  26     if [is_remote host] then {
  27         remote_exec host "$AS -version < /dev/null" "" "" "gas.version"
  28         remote_exec host "which $AS" "" "" "gas.which"
  29
  30         remote_upload host "gas.version"
  31         remote_upload host "gas.which"
  32
  33         set which_as [file_contents "gas.which"]
  34         set tmp [file_contents "gas.version"]
  35
  36         remote_file build delete "gas.version"
  37         remote_file build delete "gas.which"
  38         remote_file host delete "gas.version"
  39         remote_file host delete "gas.which"
  40     } else {
  41         set which_as [which $AS]
  42         catch "exec $AS -version < /dev/null" tmp
  43     }
  44
  45     # Should find a way to discard constant parts, keep whatever's
  46     # left, so the version string could be almost anything at all...
  47     regexp "\[^\n\]* (cygnus-|)(\[-0-9.a-zA-Z-\]+)\[\r\n\].*" $tmp version cyg number
  48     if ![info exists number] then {
  49         return "$which_as (no version number)\n"
  50     }
  51     clone_output "$which_as $number\n"
  52     unset version
  53 }
  54
  55 proc gas_host_run { cmd redir } {
  56     verbose "Executing $cmd $redir"
  57     set return_contents_of ""
  58     if [regexp ">& */dev/null" $redir] then {
  59         set output_file ""
  60         set command "$cmd $redir"
  61     } elseif [regexp "> */dev/null" $redir] then {
  62         set output_file ""
  63         set command "$cmd 2>gas.stderr"
  64         set return_contents_of "gas.stderr"
  65     } elseif [regexp ">&.*" $redir] then {
  66         # See PR 5322 for why the following line is used.
  67         regsub ">&" $redir "" output_file
  68         set command "$cmd 2>&1"
  69     } elseif [regexp "2>.*" $redir] then {
  70         set output_file "gas.out"
  71         set command "$cmd $redir"
  72         set return_contents_of "gas.out"
  73     } elseif [regexp ">.*" $redir] then {
  74         set output_file ""
  75         set command "$cmd $redir 2>gas.stderr"
  76         set return_contents_of "gas.stderr"
  77     } elseif { "$redir" == "" } then {
  78         set output_file "gas.out"
  79         set command "$cmd 2>&1"
  80         set return_contents_of "gas.out"
  81     } else {
  82         fail "gas_host_run: unknown form of redirection string"
  83     }
  84
  85     set status [remote_exec host [concat sh -c [list $command]] "" "/dev/null" "$output_file"]
  86     set to_return ""
  87     if { "$return_contents_of" != "" } then {
  88         remote_upload host "$return_contents_of"
  89         set to_return [file_contents "$return_contents_of"]
  90         regsub "\n$" $to_return "" to_return
  91     }
  92
  93     if { [lindex $status 0] == 0 && "$output_file" != ""
  94          && "$output_file" != "$return_contents_of" } then {
  95         remote_upload host "$output_file"
  96     }
  97
  98     return [list [lindex $status 0] "$to_return"]
  99 }
 100
 101 proc gas_run { prog as_opts redir } {
 102     global AS
 103     global ASFLAGS
 104     global comp_output
 105     global srcdir
 106     global subdir
 107     global host_triplet
 108
 109     set status [gas_host_run "$AS $ASFLAGS $as_opts $srcdir/$subdir/$prog" "$redir"]
 110     set comp_output [lindex $status 1]
 111     if { [lindex $status 0] != 0 && [regexp "2>.*" $redir] } then {
 112         append comp_output "child process exited abnormally"
 113     }
 114     set comp_output [prune_warnings $comp_output]
 115     verbose "output was $comp_output"
 116     return [list $comp_output ""]
 117 }
 118
 119 proc all_ones { args } {
 120     foreach x $args { if [expr $x!=1] { return 0 } }
 121     return 1
 122 }
 123
 124 # ${tool}_finish (gas_finish) will be called by runtest.exp.  But
 125 # gas_finish should only be used with gas_start.  We use gas_started
 126 # to tell gas_finish if gas_start has been called so that runtest.exp
 127 # can call gas_finish without closing the wrong fd.
 128 set gas_started 0
 129
 130 proc gas_start { prog as_opts } {
 131     global AS
 132     global ASFLAGS
 133     global srcdir
 134     global subdir
 135     global spawn_id
 136     global gas_started
 137
 138     set gas_started 1
 139
 140     verbose -log "Starting $AS $ASFLAGS $as_opts $prog" 2
 141     set status [gas_host_run "$AS $ASFLAGS $as_opts $srcdir/$subdir/$prog" ">&gas.out"]
 142     spawn -noecho -nottycopy cat gas.out
 143 }
 144
 145 proc gas_finish { } {
 146     global spawn_id
 147     global gas_started
 148
 149     if { $gas_started == 1 } {
 150         catch "close"
 151         catch "wait"
 152         set gas_started 0
 153     }
 154 }
 155
 156 proc want_no_output { testname } {
 157     global comp_output
 158
 159     if ![string match "" $comp_output] then {
 160         send_log "$comp_output\n"
 161         verbose "$comp_output" 3
 162     }
 163     if [string match "" $comp_output] then {
 164         pass "$testname"
 165         return 1
 166     } else {
 167         fail "$testname"
 168         return 0
 169     }
 170 }
 171
 172 proc gas_test_old { file as_opts testname } {
 173     gas_run $file $as_opts ""
 174     return [want_no_output $testname]
 175 }
 176
 177 proc gas_test { file as_opts var_opts testname } {
 178     global comp_output
 179
 180     set i 0
 181     foreach word $var_opts {
 182         set ignore_stdout($i) [string match "*>" $word]
 183         set opt($i) [string trim $word {>}]
 184         incr i
 185     }
 186     set max [expr 1<<$i]
 187     for {set i 0} {[expr $i<$max]} {incr i} {
 188         set maybe_ignore_stdout ""
 189         set extra_opts ""
 190         for {set bit 0} {(1<<$bit)<$max} {incr bit} {
 191             set num [expr 1<<$bit]
 192             if [expr $i&$num] then {
 193                 set extra_opts "$extra_opts $opt($bit)"
 194                 if $ignore_stdout($bit) then {
 195                     set maybe_ignore_stdout ">/dev/null"
 196                 }
 197             }
 198         }
 199         set extra_opts [string trim $extra_opts]
 200         gas_run $file "$as_opts $extra_opts" $maybe_ignore_stdout
 201
 202         # Should I be able to use a conditional expression here?
 203         if [string match "" $extra_opts] then {
 204             want_no_output $testname
 205         } else {
 206             want_no_output "$testname ($extra_opts)"
 207         }
 208     }
 209     if [info exists errorInfo] then {
 210         unset errorInfo
 211     }
 212 }
 213
 214 proc gas_test_ignore_stdout { file as_opts testname } {
 215     global comp_output
 216
 217     gas_run $file $as_opts ">/dev/null"
 218     want_no_output $testname
 219 }
 220
 221 proc gas_test_error { file as_opts testname } {
 222     global comp_output
 223
 224     gas_run $file $as_opts ">/dev/null"
 225     if ![string match "" $comp_output] then {
 226         send_log "$comp_output\n"
 227         verbose "$comp_output" 3
 228     }
 229     if [string match "" $comp_output] then {
 230         fail "$testname"
 231     } else {
 232         pass "$testname"
 233     }
 234 }
 235
 236 proc gas_exit {} {}
 237
 238 proc gas_init { args } {
 239     global target_cpu
 240     global target_cpu_family
 241     global target_family
 242     global target_vendor
 243     global target_os
 244     global stdoptlist
 245
 246     case "$target_cpu" in {
 247         "m68???"                { set target_cpu_family m68k }
 248         "i[3-7]86"              { set target_cpu_family i386 }
 249         default                 { set target_cpu_family $target_cpu }
 250     }
 251
 252     set target_family "$target_cpu_family-$target_vendor-$target_os"
 253     set stdoptlist "-a>"
 254
 255     if ![istarget "*-*-*"] {
 256         perror "Target name [istarget] is not a triple."
 257     }
 258     # Need to return an empty string.
 259     return
 260 }
 261
 262 #
 263 # is_elf_format
 264 #       true if the object format is known to be ELF
 265 #
 266 proc is_elf_format {} {
 267     if { ![istarget *-*-sysv4*] \
 268          && ![istarget *-*-unixware*] \
 269          && ![istarget *-*-elf*] \
 270          && ![istarget *-*-eabi*] \
 271          && ![istarget hppa*64*-*-hpux*] \
 272          && ![istarget *-*-linux*] \
 273          && ![istarget frv-*-uclinux*] \
 274          && ![istarget *-*-irix5*] \
 275          && ![istarget *-*-irix6*] \
 276          && ![istarget *-*-netbsd*] \
 277          && ![istarget *-*-openbsd*] \
 278          && ![istarget *-*-solaris2*] } {
 279         return 0
 280     }
 281
 282     if { [istarget *-*-linux*aout*] \
 283          || [istarget *-*-linux*oldld*] } {
 284         return 0
 285     }
 286
 287     if { ![istarget *-*-netbsdelf*] \
 288          && ([istarget *-*-netbsd*aout*] \
 289              || [istarget *-*-netbsdpe*] \
 290              || [istarget arm*-*-netbsd*] \
 291              || [istarget sparc-*-netbsd*] \
 292              || [istarget i*86-*-netbsd*] \
 293              || [istarget m68*-*-netbsd*] \
 294              || [istarget vax-*-netbsd*] \
 295              || [istarget ns32k-*-netbsd*]) } {
 296         return 0
 297     }
 298
 299     if { [istarget arm-*-openbsd*] \
 300          || [istarget i386-*-openbsd\[0-2\].*] \
 301          || [istarget i386-*-openbsd3.\[0-3\]] \
 302          || [istarget m68*-*-openbsd*] \
 303          || [istarget ns32k-*-openbsd*] \
 304          || [istarget sparc-*-openbsd\[0-2\].*] \
 305          || [istarget sparc-*-openbsd3.\[0-1\]] \
 306          || [istarget vax-*-openbsd*] } {
 307         return 0
 308     }
 309
 310     return 1
 311 }
 312
 313 # run_dump_tests TESTCASES EXTRA_OPTIONS
 314 # Wrapper for run_dump_test, which is suitable for invoking as
 315 #   run_dump_tests [lsort [glob -nocomplain $srcdir/$subdir/*.d]]
 316 # EXTRA_OPTIONS are passed down to run_dump_test.  Honors runtest_file_p.
 317 # Body cribbed from dg-runtest.
 318
 319 proc run_dump_tests { testcases {extra_options {}} } {
 320     global runtests
 321
 322     foreach testcase $testcases {
 323         # If testing specific files and this isn't one of them, skip it.
 324         if ![runtest_file_p $runtests $testcase] {
 325             continue
 326         }
 327         run_dump_test [file rootname [file tail $testcase]] $extra_options
 328     }
 329 }
 330
 331
 332 # run_dump_test FILE (optional:) EXTRA_OPTIONS
 333 #
 334 # Assemble a .s file, then run some utility on it and check the output.
 335 #
 336 # There should be an assembly language file named FILE.s in the test
 337 # suite directory, and a pattern file called FILE.d.  `run_dump_test'
 338 # will assemble FILE.s, run some tool like `objdump', `objcopy', or
 339 # `nm' on the .o file to produce textual output, and then analyze that
 340 # with regexps.  The FILE.d file specifies what program to run, and
 341 # what to expect in its output.
 342 #
 343 # The FILE.d file begins with zero or more option lines, which specify
 344 # flags to pass to the assembler, the program to run to dump the
 345 # assembler's output, and the options it wants.  The option lines have
 346 # the syntax:
 347 #
 348 #         # OPTION: VALUE
 349 #
 350 # OPTION is the name of some option, like "name" or "objdump", and
 351 # VALUE is OPTION's value.  The valid options are described below.
 352 # Whitespace is ignored everywhere, except within VALUE.  The option
 353 # list ends with the first line that doesn't match the above syntax.
 354 # However, a line within the options that begins with a #, but doesn't
 355 # have a recognizable option name followed by a colon, is considered a
 356 # comment and entirely ignored.
 357 #
 358 # The optional EXTRA_OPTIONS argument to `run_dump_test' is a list of
 359 # two-element lists.  The first element of each is an option name, and
 360 # the second additional arguments to be added on to the end of the
 361 # option list as given in FILE.d.  (If omitted, no additional options
 362 # are added.)
 363 #
 364 # The interesting options are:
 365 #
 366 #   name: TEST-NAME
 367 #       The name of this test, passed to DejaGNU's `pass' and `fail'
 368 #       commands.  If omitted, this defaults to FILE, the root of the
 369 #       .s and .d files' names.
 370 #
 371 #   as: FLAGS
 372 #       When assembling FILE.s, pass FLAGS to the assembler.
 373 #
 374 #   PROG: PROGRAM-NAME
 375 #       The name of the program to run to analyze the .o file produced
 376 #       by the assembler.  This can be omitted; run_dump_test will guess
 377 #       which program to run by seeing which of the flags options below
 378 #       is present.
 379 #
 380 #   objdump: FLAGS
 381 #   nm: FLAGS
 382 #   objcopy: FLAGS
 383 #       Use the specified program to analyze the .o file, and pass it
 384 #       FLAGS, in addition to the .o file name.  Note that they are run
 385 #       with LC_ALL=C in the environment to give consistent sorting
 386 #       of symbols.
 387 #
 388 #   source: SOURCE
 389 #       Assemble the file SOURCE.s.  If omitted, this defaults to FILE.s.
 390 #       This is useful if several .d files want to share a .s file.
 391 #
 392 #   target: GLOBS...
 393 #       Run this test only on a specified list of targets.  More precisely,
 394 #       each glob in the space-separated list is passed to "istarget"; if
 395 #       it evaluates true for any of them, the test will be run, otherwise
 396 #       it will be marked unsupported.
 397 #
 398 #   not-target: GLOBS...
 399 #       Do not run this test on a specified list of targets.  Again,
 400 #       the each glob in the space-separated list is passed to
 401 #       "istarget", and the test is run if it evaluates *false* for
 402 #       *all* of them.  Otherwise it will be marked unsupported.
 403 #
 404 #   skip: GLOBS...
 405 #   not-skip: GLOBS...
 406 #       These are exactly the same as "not-target" and "target",
 407 #       respectively, except that they do nothing at all if the check
 408 #       fails.  They should only be used in groups, to construct a single
 409 #       test which is run on all targets but with variant options or
 410 #       expected output on some targets.  (For example, see
 411 #       gas/arm/inst.d and gas/arm/wince_inst.d.)
 412 #
 413 #   error: REGEX
 414 #       An error with message matching REGEX must be emitted for the test
 415 #       to pass.  The PROG, objdump, nm and objcopy options have no
 416 #       meaning and need not supplied if this is present.
 417 #
 418 #   warning: REGEX
 419 #       Expect a gas warning matching REGEX.  It is an error to issue
 420 #       both "error" and "warning".
 421 #
 422 #   stderr: FILE
 423 #       FILE contains regexp lines to be matched against the diagnostic
 424 #       output of the assembler.  This does not preclude the use of
 425 #       PROG, nm, objdump, or objcopy.
 426 #
 427 #   error-output: FILE
 428 #       Means the same as 'stderr', but also indicates that the assembler
 429 #       is expected to exit unsuccessfully (therefore PROG, objdump, nm,
 430 #       and objcopy have no meaning and should not be supplied).
 431 #
 432 # Each option may occur at most once.
 433 #
 434 # After the option lines come regexp lines.  `run_dump_test' calls
 435 # `regexp_diff' to compare the output of the dumping tool against the
 436 # regexps in FILE.d.  `regexp_diff' is defined later in this file; see
 437 # further comments there.
 438
 439 proc run_dump_test { name {extra_options {}} } {
 440     global subdir srcdir
 441     global OBJDUMP NM AS OBJCOPY READELF
 442     global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
 443     global host_triplet
 444     global env
 445
 446     if [string match "*/*" $name] {
 447         set file $name
 448         set name [file tail $name]
 449     } else {
 450         set file "$srcdir/$subdir/$name"
 451     }
 452     set opt_array [slurp_options "${file}.d"]
 453     if { $opt_array == -1 } {
 454         perror "error reading options from $file.d"
 455         unresolved $subdir/$name
 456         return
 457     }
 458     set opts(as) {}
 459     set opts(objdump) {}
 460     set opts(nm) {}
 461     set opts(objcopy) {}
 462     set opts(readelf) {}
 463     set opts(name) {}
 464     set opts(PROG) {}
 465     set opts(source) {}
 466     set opts(stderr) {}
 467     set opts(error) {}
 468     set opts(error-output) {}
 469     set opts(warning) {}
 470     set opts(target) {}
 471     set opts(not-target) {}
 472     set opts(skip) {}
 473     set opts(not-skip) {}
 474
 475     foreach i $opt_array {
 476         set opt_name [lindex $i 0]
 477         set opt_val [lindex $i 1]
 478         if ![info exists opts($opt_name)] {
 479             perror "unknown option $opt_name in file $file.d"
 480             unresolved $subdir/$name
 481             return
 482         }
 483         if [string length $opts($opt_name)] {
 484             perror "option $opt_name multiply set in $file.d"
 485             unresolved $subdir/$name
 486             return
 487         }
 488         if { $opt_name == "as" } {
 489             set opt_val [subst $opt_val]
 490         }
 491         set opts($opt_name) $opt_val
 492     }
 493
 494     foreach i $extra_options {
 495         set opt_name [lindex $i 0]
 496         set opt_val [lindex $i 1]
 497         if ![info exists opts($opt_name)] {
 498             perror "unknown option $opt_name given in extra_opts"
 499             unresolved $subdir/$name
 500             return
 501         }
 502         # add extra option to end of existing option, adding space
 503         # if necessary.
 504         if [string length $opts($opt_name)] {
 505             append opts($opt_name) " "
 506         }
 507         append opts($opt_name) $opt_val
 508     }
 509
 510     if { $opts(name) == "" } {
 511         set testname "$subdir/$name"
 512     } else {
 513         set testname $opts(name)
 514     }
 515     verbose "Testing $testname"
 516
 517     if { (($opts(warning) != "") && ($opts(error) != "")) \
 518          || (($opts(warning) != "") && ($opts(stderr) != "")) \
 519          || (($opts(error-output) != "") && ($opts(stderr) != "")) \
 520          || (($opts(error-output) != "") && ($opts(error) != "")) \
 521          || (($opts(error-output) != "") && ($opts(warning) != "")) } {
 522         perror "$testname: bad mix of stderr, error-output, error, and warning test-directives"
 523         unresolved $testname
 524         return
 525     }
 526     if { $opts(error-output) != "" } then {
 527         set opts(stderr) $opts(error-output)
 528     }
 529
 530     set program ""
 531     # It's meaningless to require an output-testing method when we
 532     # expect an error.
 533     if { $opts(error) == "" && $opts(error-output) == "" } {
 534         if {$opts(PROG) != ""} {
 535             switch -- $opts(PROG) {
 536                 objdump { set program objdump }
 537                 nm      { set program nm }
 538                 objcopy { set program objcopy }
 539                 readelf { set program readelf }
 540                 default {
 541                     perror "unrecognized program option $opts(PROG) in $file.d"
 542                     unresolved $testname
 543                     return }
 544             }
 545         } else {
 546             # Guess which program to run, by seeing which option was specified.
 547             foreach p {objdump objcopy nm readelf} {
 548                 if {$opts($p) != ""} {
 549                     if {$program != ""} {
 550                         perror "ambiguous dump program in $file.d"
 551                         unresolved $testname
 552                         return
 553                     } else {
 554                         set program $p
 555                     }
 556                 }
 557             }
 558         }
 559         if { $program == "" && $opts(warning) == "" } {
 560             perror "dump program unspecified in $file.d"
 561             unresolved $testname
 562             return
 563         }
 564     }
 565
 566     # Handle skipping the test on specified targets.
 567     # You can have both skip/not-skip and target/not-target, but you can't
 568     # have both skip and not-skip, or target and not-target, in the same file.
 569     if { $opts(skip) != "" } then {
 570         if { $opts(not-skip) != "" } then {
 571             perror "$testname: mixing skip and not-skip directives is invalid"
 572             unresolved $testname
 573             return
 574         }
 575         foreach glob $opts(skip) {
 576             if {[istarget $glob]} { return }
 577         }
 578     }
 579     if { $opts(not-skip) != "" } then {
 580         set skip 1
 581         foreach glob $opts(not-skip) {
 582             if {[istarget $glob]} {
 583                 set skip 0
 584                 break
 585             }
 586         }
 587         if {$skip} { return }
 588     }
 589     if { $opts(target) != "" } then {
 590         if { $opts(not-target) != "" } then {
 591             perror "$testname: mixing target and not-target directives is invalid"
 592             unresolved $testname
 593             return
 594         }
 595         set skip 1
 596         foreach glob $opts(target) {
 597             if {[istarget $glob]} {
 598                 set skip 0
 599                 break
 600             }
 601         }
 602         if {$skip} {
 603             unsupported $testname
 604             return
 605         }
 606     }
 607     if { $opts(not-target) != "" } then {
 608         foreach glob $opts(not-target) {
 609             if {[istarget $glob]} {
 610                 unsupported $testname
 611                 return
 612             }
 613         }
 614     }
 615
 616
 617     if { $opts(source) == "" } {
 618         set sourcefile ${file}.s
 619     } else {
 620         set sourcefile $srcdir/$subdir/$opts(source)
 621     }
 622
 623     set cmd "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile"
 624     send_log "$cmd\n"
 625     set status [gas_host_run $cmd ""]
 626     set cmdret [lindex $status 0]
 627     set comp_output [prune_warnings [lindex $status 1]]
 628
 629     set expmsg $opts(error)
 630     if { $opts(warning) != "" } {
 631         set expmsg $opts(warning)
 632     }
 633     if { $cmdret != 0 || $comp_output != "" || $expmsg != "" } then {
 634         # If the executed program writes to stderr and stderr is not
 635         # redirected, exec *always* returns failure, regardless of the
 636         # program exit code.  Thankfully, we can retrieve the true
 637         # return status from a special variable.  Redirection would
 638         # cause a tcl-specific message to be appended, and we'd rather
 639         # not deal with that if we can help it.
 640         global errorCode
 641         if { $cmdret != 0 && [lindex $errorCode 0] == "NONE" } {
 642             set cmdret 0
 643         }
 644
 645         set exitstat "succeeded"
 646         if { $cmdret != 0 } { set exitstat "failed" }
 647
 648         send_log "$comp_output\n"
 649         verbose "$comp_output" 3
 650         if { $opts(stderr) == "" }  then {
 651             if { [regexp $expmsg $comp_output] \
 652                     && (($cmdret == 0) == ($opts(warning) != "")) } {
 653                 # We have the expected output from gas.
 654                 # Return if there's nothing more to do.
 655                 if { $opts(error) != "" || $program == "" } {
 656                     pass $testname
 657                     return
 658                 }
 659             } else {
 660                 verbose -log "$exitstat with: <$comp_output>, expected: <$expmsg>"
 661
 662                 fail $testname
 663                 return
 664             }
 665         } else {
 666             catch {write_file dump.stderr "$comp_output"} write_output
 667             if ![string match "" $write_output] then {
 668                 send_log "error writing dump.stderr: $write_output\n"
 669                 verbose "error writing dump.stderr: $write_output" 3
 670                 send_log "$comp_output\n"
 671                 verbose "$comp_output" 3
 672                 fail $testname
 673                 return
 674             }
 675             set stderrfile $srcdir/$subdir/$opts(stderr)
 676             verbose "wrote pruned stderr to dump.stderr" 3
 677             if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
 678                 if { $opts(error) != "" } {
 679                     verbose -log "$exitstat with: <$comp_output>, expected: <$opts(error)>"
 680                     if [regexp $opts(error) $comp_output] {
 681                         pass $testname
 682                         return
 683                     }
 684                 }
 685                 fail $testname
 686                 verbose "pruned stderr is [file_contents "dump.stderr"]" 2
 687                 return
 688             } elseif { $opts(error-output) != "" } then {
 689                 pass $testname
 690                 return
 691             }
 692         }
 693     } else {
 694         if { $opts(error) != "" || $opts(error-output) != "" } {
 695             fail $testname
 696         }
 697     }
 698
 699     if { $program == "" } {
 700         return
 701     }
 702     set progopts1 $opts($program)
 703     eval set progopts \$[string toupper $program]FLAGS
 704     eval set binary \$[string toupper $program]
 705
 706     if { ![is_remote host] && [which $binary] == 0 } {
 707         untested $testname
 708         return
 709     }
 710
 711     if { $progopts1 == "" } { set $progopts1 "-r" }
 712     verbose "running $binary $progopts $progopts1" 3
 713
 714     # Objcopy, unlike the other two, won't send its output to stdout,
 715     # so we have to run it specially.
 716     set cmd "$binary $progopts $progopts1 dump.o"
 717     set redir ">dump.out"
 718     if { $program == "objcopy" } {
 719         set cmd "$binary $progopts $progopts1 dump.o dump.out"
 720         set redir ""
 721     }
 722
 723     # Ensure consistent sorting of symbols
 724     if {[info exists env(LC_ALL)]} {
 725         set old_lc_all $env(LC_ALL)
 726     }
 727     set env(LC_ALL) "C"
 728     send_log "$cmd\n"
 729     set status [gas_host_run "$cmd" "$redir"]
 730     set comp_output [prune_warnings [lindex $status 1]]
 731     if {[info exists old_lc_all]} {
 732         set env(LC_ALL) $old_lc_all
 733     } else {
 734         unset env(LC_ALL)
 735     }
 736     set comp_output [prune_warnings $comp_output]
 737     if ![string match "" $comp_output] then {
 738         send_log "$comp_output\n"
 739         fail $testname
 740         return
 741     }
 742
 743     verbose_eval {[file_contents "dump.out"]} 3
 744     if { [regexp_diff "dump.out" "${file}.d"] } then {
 745         fail $testname
 746         verbose "output is [file_contents "dump.out"]" 2
 747         return
 748     }
 749
 750     pass $testname
 751 }
 752
 753 proc slurp_options { file } {
 754     if [catch { set f [open $file r] } x] {
 755         #perror "couldn't open `$file': $x"
 756         perror "$x"
 757         return -1
 758     }
 759     set opt_array {}
 760     # whitespace expression
 761     set ws  {[  ]*}
 762     set nws {[^         ]*}
 763     # whitespace is ignored anywhere except within the options list;
 764     # option names are alphabetic plus dash
 765     set pat "^#${ws}(\[a-zA-Z-\]*)$ws:${ws}(.*)$ws\$"
 766     while { [gets $f line] != -1 } {
 767         set line [string trim $line]
 768         # Whitespace here is space-tab.
 769         if [regexp $pat $line xxx opt_name opt_val] {
 770             # match!
 771             lappend opt_array [list $opt_name $opt_val]
 772         } elseif {![regexp "^#" $line ]} {
 773             break
 774         }
 775     }
 776     close $f
 777     return $opt_array
 778 }
 779
 780 proc objdump { opts } {
 781     global OBJDUMP
 782     global comp_output
 783     global host_triplet
 784
 785     set status [gas_host_run "$OBJDUMP $opts" ""]
 786     set comp_output [prune_warnings [lindex $status 1]]
 787     verbose "objdump output=$comp_output\n" 3
 788 }
 789
 790 proc objdump_start_no_subdir { prog opts } {
 791     global OBJDUMP
 792     global srcdir
 793     global spawn_id
 794
 795     verbose "Starting $OBJDUMP $opts $prog" 2
 796     set status [gas_host_run "$OBJDUMP $opts $prog" ">&gas.out"]
 797     spawn -noecho -nottycopy cat gas.out
 798 }
 799
 800 proc objdump_finish { } {
 801     global spawn_id
 802
 803     catch "close"
 804     catch "wait"
 805 }
 806
 807 # Default timeout is 10 seconds, loses on a slow machine.  But some
 808 # configurations of dejagnu may override it.
 809 if {$timeout<120} then { set timeout 120 }
 810
 811 expect_after -i {
 812     timeout                     { perror "timeout" }
 813     "virtual memory exhausted"  { perror "virtual memory exhausted" }
 814     buffer_full                 { perror "buffer full" }
 815     eof                         { perror "eof" }
 816 }
 817
 818 # regexp_diff, based on simple_diff taken from ld test suite
 819 #       compares two files line-by-line
 820 #       file1 contains strings, file2 contains regexps and #-comments
 821 #       blank lines are ignored in either file
 822 #       returns non-zero if differences exist
 823 #
 824 proc regexp_diff { file_1 file_2 } {
 825
 826     set eof -1
 827     set end_1 0
 828     set end_2 0
 829     set differences 0
 830     set diff_pass 0
 831
 832     if [file exists $file_1] then {
 833         set file_a [open $file_1 r]
 834     } else {
 835         perror "$file_1 doesn't exist"
 836         return 1
 837     }
 838
 839     if [file exists $file_2] then {
 840         set file_b [open $file_2 r]
 841     } else {
 842         perror "$file_2 doesn't exist"
 843         close $file_a
 844         return 1
 845     }
 846
 847     verbose " Regexp-diff'ing: $file_1 $file_2" 2
 848
 849     while { 1 } {
 850         set line_a ""
 851         set line_b ""
 852         while { [string length $line_a] == 0 } {
 853             if { [gets $file_a line_a] == $eof } {
 854                 set end_1 1
 855                 break
 856             }
 857         }
 858         while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
 859             if [ string match "#pass" $line_b ] {
 860                 set end_2 1
 861                 set diff_pass 1
 862                 break
 863             } elseif [ string match "#..." $line_b ] {
 864                 if { [gets $file_b line_b] == $eof } {
 865                     set end_2 1
 866                     set diff_pass 1
 867                     break
 868                 }
 869                 verbose "looking for \"^$line_b$\"" 3
 870                 while { ![regexp "^$line_b$" "$line_a"] } {
 871                     verbose "skipping    \"$line_a\"" 3
 872                     if { [gets $file_a line_a] == $eof } {
 873                         set end_1 1
 874                         break
 875                     }
 876                 }
 877                 break
 878             }
 879             if { [gets $file_b line_b] == $eof } {
 880                 set end_2 1
 881                 break
 882             }
 883         }
 884
 885         if { $diff_pass } {
 886             break
 887         } elseif { $end_1 && $end_2 } {
 888             break
 889         } elseif { $end_1 } {
 890             send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
 891             verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
 892             set differences 1
 893             break
 894         } elseif { $end_2 } {
 895             send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
 896             verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
 897             set differences 1
 898             break
 899         } else {
 900             verbose "regexp \"^$line_b$\"\nline   \"$line_a\"" 3
 901             if ![regexp "^$line_b$" "$line_a"] {
 902                 send_log "regexp_diff match failure\n"
 903                 send_log "regexp \"^$line_b$\"\nline   \"$line_a\"\n"
 904                 verbose "regexp_diff match failure\n" 3
 905                 set differences 1
 906             }
 907         }
 908     }
 909
 910     if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
 911         send_log "$file_1 and $file_2 are different lengths\n"
 912         verbose "$file_1 and $file_2 are different lengths" 3
 913         set differences 1
 914     }
 915
 916     close $file_a
 917     close $file_b
 918
 919     return $differences
 920 }
 921
 922 proc file_contents { filename } {
 923     set file [open $filename r]
 924     set contents [read $file]
 925     close $file
 926     return $contents
 927 }
 928
 929 proc write_file { filename contents } {
 930     set file [open $filename w]
 931     puts $file "$contents"
 932     close $file
 933 }
 934
 935 proc verbose_eval { expr { level 1 } } {
 936     global verbose
 937     if $verbose>$level then { eval verbose "$expr" $level }
 938 }
 939
 940 # This definition is taken from an unreleased version of DejaGnu.  Once
 941 # that version gets released, and has been out in the world for a few
 942 # months at least, it may be safe to delete this copy.
 943 if ![string length [info proc prune_warnings]] {
 944     #
 945     # prune_warnings -- delete various system verbosities from TEXT.
 946     #
 947     # An example is:
 948     # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
 949     #
 950     # Sites with particular verbose os's may wish to override this in site.exp.
 951     #
 952     proc prune_warnings { text } {
 953         # This is from sun4's.  Do it for all machines for now.
 954         # The "\\1" is to try to preserve a "\n" but only if necessary.
 955         regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
 956
 957         # It might be tempting to get carried away and delete blank lines, etc.
 958         # Just delete *exactly* what we're ask to, and that's it.
 959         return $text
 960     }
 961 }
 962
 963 # run_list_test NAME (optional): OPTS TESTNAME
 964 #
 965 # Assemble the file "NAME.d" with command line options OPTS and
 966 # compare the assembler standard error output against thee regular
 967 # expressions given in the file "NAME.l".  If TESTNAME is provided,
 968 # it will be used as the name of the test.
 969
 970 proc run_list_test { name {opts {}} {testname {}} } {
 971     global srcdir subdir
 972     if { [string length $testname] == 0 } then {
 973         set testname "[file tail $subdir] $name"
 974     }
 975     set file $srcdir/$subdir/$name
 976     gas_run ${name}.s $opts ">&dump.out"
 977     if { [regexp_diff "dump.out" "${file}.l"] } then {
 978         fail $testname
 979         verbose "output is [file_contents "dump.out"]" 2
 980         return
 981     }
 982     pass $testname
 983 }