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.
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 interesting options are:
213 # The name of this test, passed to DejaGNU's `pass' and `fail'
214 # commands. If omitted, this defaults to FILE, the root of the
215 # .s and .d files' names.
218 # When assembling FILE.s, pass FLAGS to the assembler.
221 # The name of the program to run to analyze the .o file produced
222 # by the assembler. This can be omitted; run_dump_test will guess
223 # which program to run by seeing which of the flags options below
229 # Use the specified program to analyze the .o file, and pass it
230 # FLAGS, in addition to the .o file name. Note that they are run
231 # with LC_ALL=C in the environment to give consistent sorting
235 # Assemble the file SOURCE.s. If omitted, this defaults to FILE.s.
236 # This is useful if several .d files want to share a .s file.
239 # An error with message matching REGEX must be emitted for the test
240 # to pass. The PROG, objdump, nm and objcopy options have no
241 # meaning and need not supplied if this is present.
243 # Each option may occur at most once.
245 # After the option lines come regexp lines. `run_dump_test' calls
246 # `regexp_diff' to compare the output of the dumping tool against the
247 # regexps in FILE.d. `regexp_diff' is defined later in this file; see
248 # further comments there.
250 proc run_dump_test { name } {
252 global OBJDUMP NM AS OBJCOPY READELF
253 global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
257 if [string match "*/*" $name] {
259 set name [file tail $name]
261 set file "$srcdir/$subdir/$name"
263 set opt_array [slurp_options "${file}.d"]
264 if { $opt_array == -1 } {
265 perror "error reading options from $file.d"
266 unresolved $subdir/$name
280 foreach i $opt_array {
281 set opt_name [lindex $i 0]
282 set opt_val [lindex $i 1]
283 if ![info exists opts($opt_name)] {
284 perror "unknown option $opt_name in file $file.d"
285 unresolved $subdir/$name
288 if [string length $opts($opt_name)] {
289 perror "option $opt_name multiply set in $file.d"
290 unresolved $subdir/$name
293 set opts($opt_name) $opt_val
296 if {$opts(PROG) != ""} {
297 switch -- $opts(PROG) {
299 { set program objdump }
303 { set program objcopy }
305 { set program readelf }
307 { perror "unrecognized program option $opts(PROG) in $file.d"
308 unresolved $subdir/$name
311 } elseif { $opts(error) != "" } {
312 # It's meaningless to require an output-testing method when we
313 # expect an error. For simplicity, we fake an arbitrary method.
316 # Guess which program to run, by seeing which option was specified.
318 foreach p {objdump objcopy nm readelf} {
319 if {$opts($p) != ""} {
320 if {$program != ""} {
321 perror "ambiguous dump program in $file.d"
322 unresolved $subdir/$name
329 if {$program == ""} {
330 perror "dump program unspecified in $file.d"
331 unresolved $subdir/$name
336 set progopts1 $opts($program)
337 eval set progopts \$[string toupper $program]FLAGS
338 eval set binary \$[string toupper $program]
339 if { $opts(name) == "" } {
340 set testname "$subdir/$name"
342 set testname $opts(name)
345 if { $opts(source) == "" } {
346 set sourcefile ${file}.s
348 set sourcefile $srcdir/$subdir/$opts(source)
351 send_log "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile\n"
352 catch "exec $srcdir/lib/run $AS $ASFLAGS $opts(as) -o dump.o $sourcefile" comp_output
353 set comp_output [prune_warnings $comp_output]
355 if ![string match "" $comp_output] then {
356 if { $opts(stderr) == "" } then {
357 send_log "$comp_output\n"
358 verbose "$comp_output" 3
360 if { $opts(error) != "" } {
361 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
362 if [regexp $opts(error) $comp_output] {
370 catch {write_file dump.stderr "$comp_output"} write_output
371 if ![string match "" $write_output] then {
372 send_log "error writing dump.stderr: $write_output\n"
373 verbose "error writing dump.stderr: $write_output" 3
374 send_log "$comp_output\n"
375 verbose "$comp_output" 3
379 set stderrfile $srcdir/$subdir/$opts(stderr)
380 send_log "wrote pruned stderr to dump.stderr\n"
381 verbose "wrote pruned stderr to dump.stderr" 3
382 if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
383 if { $opts(error) != "" } {
384 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
385 if [regexp $opts(error) $comp_output] {
391 verbose "pruned stderr is [file_contents "dump.stderr"]" 2
397 if { [which $binary] == 0 } {
402 if { $progopts1 == "" } { set $progopts1 "-r" }
403 verbose "running $binary $progopts $progopts1" 3
405 # Objcopy, unlike the other two, won't send its output to stdout,
406 # so we have to run it specially.
407 set cmd "$binary $progopts $progopts1 dump.o > dump.out"
408 if { $program == "objcopy" } {
409 set cmd "$binary $progopts $progopts1 dump.o dump.out"
412 # Ensure consistent sorting of symbols
413 if {[info exists env(LC_ALL)]} {
414 set old_lc_all $env(LC_ALL)
418 catch "exec $cmd" comp_output
419 if {[info exists old_lc_all]} {
420 set env(LC_ALL) $old_lc_all
424 set comp_output [prune_warnings $comp_output]
425 if ![string match "" $comp_output] then {
426 send_log "$comp_output\n"
431 verbose_eval {[file_contents "dump.out"]} 3
432 if { [regexp_diff "dump.out" "${file}.d"] } then {
434 verbose "output is [file_contents "dump.out"]" 2
441 proc slurp_options { file } {
442 if [catch { set f [open $file r] } x] {
443 #perror "couldn't open `$file': $x"
448 # whitespace expression
451 # whitespace is ignored anywhere except within the options list;
452 # option names are alphabetic only
453 set pat "^#${ws}(\[a-zA-Z\]*)$ws:${ws}(.*)$ws\$"
454 while { [gets $f line] != -1 } {
455 set line [string trim $line]
456 # Whitespace here is space-tab.
457 if [regexp $pat $line xxx opt_name opt_val] {
459 lappend opt_array [list $opt_name $opt_val]
468 proc objdump { opts } {
473 catch "exec $OBJDUMP $opts" comp_output
474 set comp_output [prune_warnings $comp_output]
475 verbose "objdump output=$comp_output\n" 3
478 proc objdump_start_no_subdir { prog opts } {
483 verbose "Starting $OBJDUMP $opts $prog" 2
485 spawn -noecho -nottyinit $srcdir/lib/run $OBJDUMP $opts $prog
487 if ![regexp {^[0-9]+} $foo] then {
488 perror "Can't run $prog: $foo"
492 proc objdump_finish { } {
499 # Default timeout is 10 seconds, loses on a slow machine. But some
500 # configurations of dejagnu may override it.
501 if {$timeout<120} then { set timeout 120 }
504 timeout { perror "timeout" }
505 "virtual memory exhausted" { perror "virtual memory exhausted" }
506 buffer_full { perror "buffer full" }
510 # regexp_diff, based on simple_diff taken from ld test suite
511 # compares two files line-by-line
512 # file1 contains strings, file2 contains regexps and #-comments
513 # blank lines are ignored in either file
514 # returns non-zero if differences exist
516 proc regexp_diff { file_1 file_2 } {
524 if [file exists $file_1] then {
525 set file_a [open $file_1 r]
527 warning "$file_1 doesn't exist"
531 if [file exists $file_2] then {
532 set file_b [open $file_2 r]
534 fail "$file_2 doesn't exist"
539 verbose " Regexp-diff'ing: $file_1 $file_2" 2
544 while { [string length $line_a] == 0 } {
545 if { [gets $file_a line_a] == $eof } {
550 while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
551 if [ string match "#pass" $line_b ] {
555 } elseif [ string match "#..." $line_b ] {
556 if { [gets $file_b line_b] == $eof } {
560 verbose "looking for \"^$line_b$\"" 3
561 while { ![regexp "^$line_b$" "$line_a"] } {
562 verbose "skipping \"$line_a\"" 3
563 if { [gets $file_a line_a] == $eof } {
570 if { [gets $file_b line_b] == $eof } {
578 } elseif { $end_1 && $end_2 } {
580 } elseif { $end_1 } {
581 send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
582 verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
585 } elseif { $end_2 } {
586 send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
587 verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
591 verbose "regexp \"^$line_b$\"\nline \"$line_a\"" 3
592 if ![regexp "^$line_b$" "$line_a"] {
593 send_log "regexp_diff match failure\n"
594 send_log "regexp \"^$line_b$\"\nline \"$line_a\"\n"
595 verbose "regexp_diff match failure\n" 3
601 if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
602 send_log "$file_1 and $file_2 are different lengths\n"
603 verbose "$file_1 and $file_2 are different lengths" 3
613 proc file_contents { filename } {
614 set file [open $filename r]
615 set contents [read $file]
620 proc write_file { filename contents } {
621 set file [open $filename w]
622 puts $file "$contents"
626 proc verbose_eval { expr { level 1 } } {
628 if $verbose>$level then { eval verbose "$expr" $level }
631 # This definition is taken from an unreleased version of DejaGnu. Once
632 # that version gets released, and has been out in the world for a few
633 # months at least, it may be safe to delete this copy.
634 if ![string length [info proc prune_warnings]] {
636 # prune_warnings -- delete various system verbosities from TEXT.
639 # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
641 # Sites with particular verbose os's may wish to override this in site.exp.
643 proc prune_warnings { text } {
644 # This is from sun4's. Do it for all machines for now.
645 # The "\\1" is to try to preserve a "\n" but only if necessary.
646 regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
648 # It might be tempting to get carried away and delete blank lines, etc.
649 # Just delete *exactly* what we're ask to, and that's it.