1 # Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002
2 # Free Software Foundation, Inc.
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 # Please email any bugs, comments, and/or additions to this file to:
21 # This file was written by Ken Raeburn (raeburn@cygnus.com).
25 catch "exec $AS -version < /dev/null" tmp
26 # Should find a way to discard constant parts, keep whatever's
27 # left, so the version string could be almost anything at all...
28 regexp "\[^\n\]* (cygnus-|)(\[-0-9.a-zA-Z-\]+)\[\r\n\].*" $tmp version cyg number
29 if ![info exists number] then {
30 return "[which $AS] (no version number)\n"
32 clone_output "[which $AS] $number\n"
36 proc gas_run { prog as_opts redir } {
44 verbose "Executing $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir"
45 catch "exec $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir" comp_output
46 set comp_output [prune_warnings $comp_output]
47 verbose "output was $comp_output"
48 return [list $comp_output ""];
51 proc all_ones { args } {
52 foreach x $args { if [expr $x!=1] { return 0 } }
56 proc gas_start { prog as_opts } {
63 verbose "Starting $AS $ASFLAGS $as_opts $prog" 2
65 spawn -noecho -nottycopy $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog
67 if ![regexp {^[0-9]+} $foo] then {
68 perror "Can't run $subdir/$prog: $foo"
79 proc want_no_output { testname } {
82 if ![string match "" $comp_output] then {
83 send_log "$comp_output\n"
84 verbose "$comp_output" 3
86 if [string match "" $comp_output] then {
95 proc gas_test_old { file as_opts testname } {
96 gas_run $file $as_opts ""
97 return [want_no_output $testname]
100 proc gas_test { file as_opts var_opts testname } {
104 foreach word $var_opts {
105 set ignore_stdout($i) [string match "*>" $word]
106 set opt($i) [string trim $word {>}]
110 for {set i 0} {[expr $i<$max]} {incr i} {
111 set maybe_ignore_stdout ""
113 for {set bit 0} {(1<<$bit)<$max} {incr bit} {
114 set num [expr 1<<$bit]
115 if [expr $i&$num] then {
116 set extra_opts "$extra_opts $opt($bit)"
117 if $ignore_stdout($bit) then {
118 set maybe_ignore_stdout ">/dev/null"
122 set extra_opts [string trim $extra_opts]
123 gas_run $file "$as_opts $extra_opts" $maybe_ignore_stdout
125 # Should I be able to use a conditional expression here?
126 if [string match "" $extra_opts] then {
127 want_no_output $testname
129 want_no_output "$testname ($extra_opts)"
132 if [info exists errorInfo] then {
137 proc gas_test_ignore_stdout { file as_opts testname } {
140 gas_run $file $as_opts ">/dev/null"
141 want_no_output $testname
144 proc gas_test_error { file as_opts testname } {
147 gas_run $file $as_opts ">/dev/null"
148 if ![string match "" $comp_output] then {
149 send_log "$comp_output\n"
150 verbose "$comp_output" 3
152 if [string match "" $comp_output] then {
161 proc gas_init { args } {
163 global target_cpu_family
169 case "$target_cpu" in {
170 "m68???" { set target_cpu_family m68k }
171 "i[34]86" { set target_cpu_family i386 }
172 default { set target_cpu_family $target_cpu }
175 set target_family "$target_cpu_family-$target_vendor-$target_os"
178 if ![istarget "*-*-*"] {
179 perror "Target name [istarget] is not a triple."
181 # Need to return an empty string.
186 # run_dump_test FILE (optional:) EXTRA_OPTIONS
188 # Assemble a .s file, then run some utility on it and check the output.
190 # There should be an assembly language file named FILE.s in the test
191 # suite directory, and a pattern file called FILE.d. `run_dump_test'
192 # will assemble FILE.s, run some tool like `objdump', `objcopy', or
193 # `nm' on the .o file to produce textual output, and then analyze that
194 # with regexps. The FILE.d file specifies what program to run, and
195 # what to expect in its output.
197 # The FILE.d file begins with zero or more option lines, which specify
198 # flags to pass to the assembler, the program to run to dump the
199 # assembler's output, and the options it wants. The option lines have
204 # OPTION is the name of some option, like "name" or "objdump", and
205 # VALUE is OPTION's value. The valid options are described below.
206 # Whitespace is ignored everywhere, except within VALUE. The option
207 # list ends with the first line that doesn't match the above syntax
208 # (hmm, not great for error detection).
210 # The optional EXTRA_OPTIONS argument to `run_dump_test' is a list of
211 # two-element lists. The first element of each is an option name, and
212 # the second additional arguments to be added on to the end of the
213 # option list as given in FILE.d. (If omitted, no additional options
216 # The interesting options are:
219 # The name of this test, passed to DejaGNU's `pass' and `fail'
220 # commands. If omitted, this defaults to FILE, the root of the
221 # .s and .d files' names.
224 # When assembling FILE.s, pass FLAGS to the assembler.
227 # The name of the program to run to analyze the .o file produced
228 # by the assembler. This can be omitted; run_dump_test will guess
229 # which program to run by seeing which of the flags options below
235 # Use the specified program to analyze the .o file, and pass it
236 # FLAGS, in addition to the .o file name. Note that they are run
237 # with LC_ALL=C in the environment to give consistent sorting
241 # Assemble the file SOURCE.s. If omitted, this defaults to FILE.s.
242 # This is useful if several .d files want to share a .s file.
245 # An error with message matching REGEX must be emitted for the test
246 # to pass. The PROG, objdump, nm and objcopy options have no
247 # meaning and need not supplied if this is present.
249 # Each option may occur at most once.
251 # After the option lines come regexp lines. `run_dump_test' calls
252 # `regexp_diff' to compare the output of the dumping tool against the
253 # regexps in FILE.d. `regexp_diff' is defined later in this file; see
254 # further comments there.
256 proc run_dump_test { name {extra_options {}} } {
258 global OBJDUMP NM AS OBJCOPY READELF
259 global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
263 if [string match "*/*" $name] {
265 set name [file tail $name]
267 set file "$srcdir/$subdir/$name"
269 set opt_array [slurp_options "${file}.d"]
270 if { $opt_array == -1 } {
271 perror "error reading options from $file.d"
272 unresolved $subdir/$name
286 foreach i $opt_array {
287 set opt_name [lindex $i 0]
288 set opt_val [lindex $i 1]
289 if ![info exists opts($opt_name)] {
290 perror "unknown option $opt_name in file $file.d"
291 unresolved $subdir/$name
294 if [string length $opts($opt_name)] {
295 perror "option $opt_name multiply set in $file.d"
296 unresolved $subdir/$name
299 set opts($opt_name) $opt_val
302 foreach i $extra_options {
303 set opt_name [lindex $i 0]
304 set opt_val [lindex $i 1]
305 if ![info exists opts($opt_name)] {
306 perror "unknown option $opt_name given in extra_opts"
307 unresolved $subdir/$name
310 # add extra option to end of existing option, adding space
312 if [string length $opts($opt_name)] {
313 append opts($opt_name) " "
315 append opts($opt_name) $opt_val
318 if {$opts(PROG) != ""} {
319 switch -- $opts(PROG) {
321 { set program objdump }
325 { set program objcopy }
327 { set program readelf }
329 { perror "unrecognized program option $opts(PROG) in $file.d"
330 unresolved $subdir/$name
333 } elseif { $opts(error) != "" } {
334 # It's meaningless to require an output-testing method when we
335 # expect an error. For simplicity, we fake an arbitrary method.
338 # Guess which program to run, by seeing which option was specified.
340 foreach p {objdump objcopy nm readelf} {
341 if {$opts($p) != ""} {
342 if {$program != ""} {
343 perror "ambiguous dump program in $file.d"
344 unresolved $subdir/$name
351 if {$program == ""} {
352 perror "dump program unspecified in $file.d"
353 unresolved $subdir/$name
358 set progopts1 $opts($program)
359 eval set progopts \$[string toupper $program]FLAGS
360 eval set binary \$[string toupper $program]
361 if { $opts(name) == "" } {
362 set testname "$subdir/$name"
364 set testname $opts(name)
367 if { $opts(source) == "" } {
368 set sourcefile ${file}.s
370 set sourcefile $srcdir/$subdir/$opts(source)
373 send_log "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile\n"
374 catch "exec $srcdir/lib/run $AS $ASFLAGS $opts(as) -o dump.o $sourcefile" comp_output
375 set comp_output [prune_warnings $comp_output]
377 if ![string match "" $comp_output] then {
378 if { $opts(stderr) == "" } then {
379 send_log "$comp_output\n"
380 verbose "$comp_output" 3
382 if { $opts(error) != "" } {
383 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
384 if [regexp $opts(error) $comp_output] {
392 catch {write_file dump.stderr "$comp_output"} write_output
393 if ![string match "" $write_output] then {
394 send_log "error writing dump.stderr: $write_output\n"
395 verbose "error writing dump.stderr: $write_output" 3
396 send_log "$comp_output\n"
397 verbose "$comp_output" 3
401 set stderrfile $srcdir/$subdir/$opts(stderr)
402 send_log "wrote pruned stderr to dump.stderr\n"
403 verbose "wrote pruned stderr to dump.stderr" 3
404 if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
405 if { $opts(error) != "" } {
406 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
407 if [regexp $opts(error) $comp_output] {
413 verbose "pruned stderr is [file_contents "dump.stderr"]" 2
419 if { [which $binary] == 0 } {
424 if { $progopts1 == "" } { set $progopts1 "-r" }
425 verbose "running $binary $progopts $progopts1" 3
427 # Objcopy, unlike the other two, won't send its output to stdout,
428 # so we have to run it specially.
429 set cmd "$binary $progopts $progopts1 dump.o > dump.out"
430 if { $program == "objcopy" } {
431 set cmd "$binary $progopts $progopts1 dump.o dump.out"
434 # Ensure consistent sorting of symbols
435 if {[info exists env(LC_ALL)]} {
436 set old_lc_all $env(LC_ALL)
440 catch "exec $cmd" comp_output
441 if {[info exists old_lc_all]} {
442 set env(LC_ALL) $old_lc_all
446 set comp_output [prune_warnings $comp_output]
447 if ![string match "" $comp_output] then {
448 send_log "$comp_output\n"
453 verbose_eval {[file_contents "dump.out"]} 3
454 if { [regexp_diff "dump.out" "${file}.d"] } then {
456 verbose "output is [file_contents "dump.out"]" 2
463 proc slurp_options { file } {
464 if [catch { set f [open $file r] } x] {
465 #perror "couldn't open `$file': $x"
470 # whitespace expression
473 # whitespace is ignored anywhere except within the options list;
474 # option names are alphabetic only
475 set pat "^#${ws}(\[a-zA-Z\]*)$ws:${ws}(.*)$ws\$"
476 while { [gets $f line] != -1 } {
477 set line [string trim $line]
478 # Whitespace here is space-tab.
479 if [regexp $pat $line xxx opt_name opt_val] {
481 lappend opt_array [list $opt_name $opt_val]
490 proc objdump { opts } {
495 catch "exec $OBJDUMP $opts" comp_output
496 set comp_output [prune_warnings $comp_output]
497 verbose "objdump output=$comp_output\n" 3
500 proc objdump_start_no_subdir { prog opts } {
505 verbose "Starting $OBJDUMP $opts $prog" 2
507 spawn -noecho -nottyinit $srcdir/lib/run $OBJDUMP $opts $prog
509 if ![regexp {^[0-9]+} $foo] then {
510 perror "Can't run $prog: $foo"
514 proc objdump_finish { } {
521 # Default timeout is 10 seconds, loses on a slow machine. But some
522 # configurations of dejagnu may override it.
523 if {$timeout<120} then { set timeout 120 }
526 timeout { perror "timeout" }
527 "virtual memory exhausted" { perror "virtual memory exhausted" }
528 buffer_full { perror "buffer full" }
532 # regexp_diff, based on simple_diff taken from ld test suite
533 # compares two files line-by-line
534 # file1 contains strings, file2 contains regexps and #-comments
535 # blank lines are ignored in either file
536 # returns non-zero if differences exist
538 proc regexp_diff { file_1 file_2 } {
546 if [file exists $file_1] then {
547 set file_a [open $file_1 r]
549 warning "$file_1 doesn't exist"
553 if [file exists $file_2] then {
554 set file_b [open $file_2 r]
556 fail "$file_2 doesn't exist"
561 verbose " Regexp-diff'ing: $file_1 $file_2" 2
566 while { [string length $line_a] == 0 } {
567 if { [gets $file_a line_a] == $eof } {
572 while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
573 if [ string match "#pass" $line_b ] {
577 } elseif [ string match "#..." $line_b ] {
578 if { [gets $file_b line_b] == $eof } {
582 verbose "looking for \"^$line_b$\"" 3
583 while { ![regexp "^$line_b$" "$line_a"] } {
584 verbose "skipping \"$line_a\"" 3
585 if { [gets $file_a line_a] == $eof } {
592 if { [gets $file_b line_b] == $eof } {
600 } elseif { $end_1 && $end_2 } {
602 } elseif { $end_1 } {
603 send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
604 verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
607 } elseif { $end_2 } {
608 send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
609 verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
613 verbose "regexp \"^$line_b$\"\nline \"$line_a\"" 3
614 if ![regexp "^$line_b$" "$line_a"] {
615 send_log "regexp_diff match failure\n"
616 send_log "regexp \"^$line_b$\"\nline \"$line_a\"\n"
617 verbose "regexp_diff match failure\n" 3
623 if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
624 send_log "$file_1 and $file_2 are different lengths\n"
625 verbose "$file_1 and $file_2 are different lengths" 3
635 proc file_contents { filename } {
636 set file [open $filename r]
637 set contents [read $file]
642 proc write_file { filename contents } {
643 set file [open $filename w]
644 puts $file "$contents"
648 proc verbose_eval { expr { level 1 } } {
650 if $verbose>$level then { eval verbose "$expr" $level }
653 # This definition is taken from an unreleased version of DejaGnu. Once
654 # that version gets released, and has been out in the world for a few
655 # months at least, it may be safe to delete this copy.
656 if ![string length [info proc prune_warnings]] {
658 # prune_warnings -- delete various system verbosities from TEXT.
661 # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
663 # Sites with particular verbose os's may wish to override this in site.exp.
665 proc prune_warnings { text } {
666 # This is from sun4's. Do it for all machines for now.
667 # The "\\1" is to try to preserve a "\n" but only if necessary.
668 regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
670 # It might be tempting to get carried away and delete blank lines, etc.
671 # Just delete *exactly* what we're ask to, and that's it.