* gas/h8300/t03_add.exp: Remove stray semicolons.
[deliverable/binutils-gdb.git] / gas / testsuite / lib / gas-defs.exp
1 # Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
2 # 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, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17
18 # Please email any bugs, comments, and/or additions to this file to:
19 # dejagnu@gnu.org
20
21 # This file was written by Ken Raeburn (raeburn@cygnus.com).
22
23 proc gas_version {} {
24 global AS
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"
31 }
32 clone_output "[which $AS] $number\n"
33 unset version
34 }
35
36 proc gas_run { prog as_opts redir } {
37 global AS
38 global ASFLAGS
39 global comp_output
40 global srcdir
41 global subdir
42 global host_triplet
43
44 verbose -log "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 ""]
49 }
50
51 proc all_ones { args } {
52 foreach x $args { if [expr $x!=1] { return 0 } }
53 return 1
54 }
55
56 proc gas_start { prog as_opts } {
57 global AS
58 global ASFLAGS
59 global srcdir
60 global subdir
61 global spawn_id
62
63 verbose -log "Starting $AS $ASFLAGS $as_opts $prog" 2
64 catch {
65 spawn -noecho -nottycopy $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog
66 } foo
67 if ![regexp {^[0-9]+} $foo] then {
68 perror "Can't run $subdir/$prog: $foo"
69 }
70 }
71
72 proc gas_finish { } {
73 global spawn_id
74
75 catch "close"
76 catch "wait"
77 }
78
79 proc want_no_output { testname } {
80 global comp_output
81
82 if ![string match "" $comp_output] then {
83 send_log "$comp_output\n"
84 verbose "$comp_output" 3
85 }
86 if [string match "" $comp_output] then {
87 pass "$testname"
88 return 1
89 } else {
90 fail "$testname"
91 return 0
92 }
93 }
94
95 proc gas_test_old { file as_opts testname } {
96 gas_run $file $as_opts ""
97 return [want_no_output $testname]
98 }
99
100 proc gas_test { file as_opts var_opts testname } {
101 global comp_output
102
103 set i 0
104 foreach word $var_opts {
105 set ignore_stdout($i) [string match "*>" $word]
106 set opt($i) [string trim $word {>}]
107 incr i
108 }
109 set max [expr 1<<$i]
110 for {set i 0} {[expr $i<$max]} {incr i} {
111 set maybe_ignore_stdout ""
112 set extra_opts ""
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"
119 }
120 }
121 }
122 set extra_opts [string trim $extra_opts]
123 gas_run $file "$as_opts $extra_opts" $maybe_ignore_stdout
124
125 # Should I be able to use a conditional expression here?
126 if [string match "" $extra_opts] then {
127 want_no_output $testname
128 } else {
129 want_no_output "$testname ($extra_opts)"
130 }
131 }
132 if [info exists errorInfo] then {
133 unset errorInfo
134 }
135 }
136
137 proc gas_test_ignore_stdout { file as_opts testname } {
138 global comp_output
139
140 gas_run $file $as_opts ">/dev/null"
141 want_no_output $testname
142 }
143
144 proc gas_test_error { file as_opts testname } {
145 global comp_output
146
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
151 }
152 if [string match "" $comp_output] then {
153 fail "$testname"
154 } else {
155 pass "$testname"
156 }
157 }
158
159 proc gas_exit {} {}
160
161 proc gas_init { args } {
162 global target_cpu
163 global target_cpu_family
164 global target_family
165 global target_vendor
166 global target_os
167 global stdoptlist
168
169 case "$target_cpu" in {
170 "m68???" { set target_cpu_family m68k }
171 "i[3-7]86" { set target_cpu_family i386 }
172 default { set target_cpu_family $target_cpu }
173 }
174
175 set target_family "$target_cpu_family-$target_vendor-$target_os"
176 set stdoptlist "-a>"
177
178 if ![istarget "*-*-*"] {
179 perror "Target name [istarget] is not a triple."
180 }
181 # Need to return an empty string.
182 return
183 }
184
185 #
186 # is_elf_format
187 # true if the object format is known to be ELF
188 #
189 proc is_elf_format {} {
190 if { ![istarget *-*-sysv4*] \
191 && ![istarget *-*-unixware*] \
192 && ![istarget *-*-elf*] \
193 && ![istarget *-*-eabi*] \
194 && ![istarget hppa*64*-*-hpux*] \
195 && ![istarget *-*-linux*] \
196 && ![istarget frv-*-uclinux*] \
197 && ![istarget *-*-irix5*] \
198 && ![istarget *-*-irix6*] \
199 && ![istarget *-*-netbsd*] \
200 && ![istarget *-*-openbsd*] \
201 && ![istarget *-*-solaris2*] } {
202 return 0
203 }
204
205 if { [istarget *-*-linux*aout*] \
206 || [istarget *-*-linux*oldld*] } {
207 return 0
208 }
209
210 if { ![istarget *-*-netbsdelf*] \
211 && ([istarget *-*-netbsd*aout*] \
212 || [istarget *-*-netbsdpe*] \
213 || [istarget arm*-*-netbsd*] \
214 || [istarget sparc-*-netbsd*] \
215 || [istarget i*86-*-netbsd*] \
216 || [istarget m68*-*-netbsd*] \
217 || [istarget vax-*-netbsd*] \
218 || [istarget ns32k-*-netbsd*]) } {
219 return 0
220 }
221
222 if { [istarget arm-*-openbsd*] \
223 || [istarget i386-*-openbsd\[0-2\].*] \
224 || [istarget i386-*-openbsd3.\[0-3\]] \
225 || [istarget m68*-*-openbsd*] \
226 || [istarget ns32k-*-openbsd*] \
227 || [istarget sparc-*-openbsd\[0-2\].*] \
228 || [istarget sparc-*-openbsd3.\[0-1\]] \
229 || [istarget vax-*-openbsd*] } {
230 return 0
231 }
232
233 return 1
234 }
235
236
237 # run_dump_test FILE (optional:) EXTRA_OPTIONS
238 #
239 # Assemble a .s file, then run some utility on it and check the output.
240 #
241 # There should be an assembly language file named FILE.s in the test
242 # suite directory, and a pattern file called FILE.d. `run_dump_test'
243 # will assemble FILE.s, run some tool like `objdump', `objcopy', or
244 # `nm' on the .o file to produce textual output, and then analyze that
245 # with regexps. The FILE.d file specifies what program to run, and
246 # what to expect in its output.
247 #
248 # The FILE.d file begins with zero or more option lines, which specify
249 # flags to pass to the assembler, the program to run to dump the
250 # assembler's output, and the options it wants. The option lines have
251 # the syntax:
252 #
253 # # OPTION: VALUE
254 #
255 # OPTION is the name of some option, like "name" or "objdump", and
256 # VALUE is OPTION's value. The valid options are described below.
257 # Whitespace is ignored everywhere, except within VALUE. The option
258 # list ends with the first line that doesn't match the above syntax
259 # (hmm, not great for error detection).
260 #
261 # The optional EXTRA_OPTIONS argument to `run_dump_test' is a list of
262 # two-element lists. The first element of each is an option name, and
263 # the second additional arguments to be added on to the end of the
264 # option list as given in FILE.d. (If omitted, no additional options
265 # are added.)
266 #
267 # The interesting options are:
268 #
269 # name: TEST-NAME
270 # The name of this test, passed to DejaGNU's `pass' and `fail'
271 # commands. If omitted, this defaults to FILE, the root of the
272 # .s and .d files' names.
273 #
274 # as: FLAGS
275 # When assembling FILE.s, pass FLAGS to the assembler.
276 #
277 # PROG: PROGRAM-NAME
278 # The name of the program to run to analyze the .o file produced
279 # by the assembler. This can be omitted; run_dump_test will guess
280 # which program to run by seeing which of the flags options below
281 # is present.
282 #
283 # objdump: FLAGS
284 # nm: FLAGS
285 # objcopy: FLAGS
286 # Use the specified program to analyze the .o file, and pass it
287 # FLAGS, in addition to the .o file name. Note that they are run
288 # with LC_ALL=C in the environment to give consistent sorting
289 # of symbols.
290 #
291 # source: SOURCE
292 # Assemble the file SOURCE.s. If omitted, this defaults to FILE.s.
293 # This is useful if several .d files want to share a .s file.
294 #
295 # error: REGEX
296 # An error with message matching REGEX must be emitted for the test
297 # to pass. The PROG, objdump, nm and objcopy options have no
298 # meaning and need not supplied if this is present.
299 #
300 # Each option may occur at most once.
301 #
302 # After the option lines come regexp lines. `run_dump_test' calls
303 # `regexp_diff' to compare the output of the dumping tool against the
304 # regexps in FILE.d. `regexp_diff' is defined later in this file; see
305 # further comments there.
306
307 proc run_dump_test { name {extra_options {}} } {
308 global subdir srcdir
309 global OBJDUMP NM AS OBJCOPY READELF
310 global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
311 global host_triplet
312 global env
313
314 if [string match "*/*" $name] {
315 set file $name
316 set name [file tail $name]
317 } else {
318 set file "$srcdir/$subdir/$name"
319 }
320 set opt_array [slurp_options "${file}.d"]
321 if { $opt_array == -1 } {
322 perror "error reading options from $file.d"
323 unresolved $subdir/$name
324 return
325 }
326 set opts(as) {}
327 set opts(objdump) {}
328 set opts(nm) {}
329 set opts(objcopy) {}
330 set opts(readelf) {}
331 set opts(name) {}
332 set opts(PROG) {}
333 set opts(source) {}
334 set opts(stderr) {}
335 set opts(error) {}
336
337 foreach i $opt_array {
338 set opt_name [lindex $i 0]
339 set opt_val [lindex $i 1]
340 if ![info exists opts($opt_name)] {
341 perror "unknown option $opt_name in file $file.d"
342 unresolved $subdir/$name
343 return
344 }
345 if [string length $opts($opt_name)] {
346 perror "option $opt_name multiply set in $file.d"
347 unresolved $subdir/$name
348 return
349 }
350 set opts($opt_name) $opt_val
351 }
352
353 foreach i $extra_options {
354 set opt_name [lindex $i 0]
355 set opt_val [lindex $i 1]
356 if ![info exists opts($opt_name)] {
357 perror "unknown option $opt_name given in extra_opts"
358 unresolved $subdir/$name
359 return
360 }
361 # add extra option to end of existing option, adding space
362 # if necessary.
363 if [string length $opts($opt_name)] {
364 append opts($opt_name) " "
365 }
366 append opts($opt_name) $opt_val
367 }
368
369 if {$opts(PROG) != ""} {
370 switch -- $opts(PROG) {
371 objdump
372 { set program objdump }
373 nm
374 { set program nm }
375 objcopy
376 { set program objcopy }
377 readelf
378 { set program readelf }
379 default
380 { perror "unrecognized program option $opts(PROG) in $file.d"
381 unresolved $subdir/$name
382 return }
383 }
384 } elseif { $opts(error) != "" } {
385 # It's meaningless to require an output-testing method when we
386 # expect an error. For simplicity, we fake an arbitrary method.
387 set program "nm"
388 } else {
389 # Guess which program to run, by seeing which option was specified.
390 set program ""
391 foreach p {objdump objcopy nm readelf} {
392 if {$opts($p) != ""} {
393 if {$program != ""} {
394 perror "ambiguous dump program in $file.d"
395 unresolved $subdir/$name
396 return
397 } else {
398 set program $p
399 }
400 }
401 }
402 if {$program == ""} {
403 perror "dump program unspecified in $file.d"
404 unresolved $subdir/$name
405 return
406 }
407 }
408
409 set progopts1 $opts($program)
410 eval set progopts \$[string toupper $program]FLAGS
411 eval set binary \$[string toupper $program]
412 if { $opts(name) == "" } {
413 set testname "$subdir/$name"
414 } else {
415 set testname $opts(name)
416 }
417
418 if { $opts(source) == "" } {
419 set sourcefile ${file}.s
420 } else {
421 set sourcefile $srcdir/$subdir/$opts(source)
422 }
423
424 send_log "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile\n"
425 catch "exec $srcdir/lib/run $AS $ASFLAGS $opts(as) -o dump.o $sourcefile" comp_output
426 set comp_output [prune_warnings $comp_output]
427
428 if { ![string match "" $comp_output] || $opts(stderr) != "" } then {
429 if { $opts(stderr) == "" } then {
430 send_log "$comp_output\n"
431 verbose "$comp_output" 3
432
433 if { $opts(error) != "" } {
434 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
435 if [regexp $opts(error) $comp_output] {
436 pass $testname
437 return
438 }
439 }
440 fail $testname
441 return
442 } else {
443 catch {write_file dump.stderr "$comp_output"} write_output
444 if ![string match "" $write_output] then {
445 send_log "error writing dump.stderr: $write_output\n"
446 verbose "error writing dump.stderr: $write_output" 3
447 send_log "$comp_output\n"
448 verbose "$comp_output" 3
449 fail $testname
450 return
451 }
452 set stderrfile $srcdir/$subdir/$opts(stderr)
453 send_log "wrote pruned stderr to dump.stderr\n"
454 verbose "wrote pruned stderr to dump.stderr" 3
455 if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
456 if { $opts(error) != "" } {
457 verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
458 if [regexp $opts(error) $comp_output] {
459 pass $testname
460 return
461 }
462 }
463 fail $testname
464 verbose "pruned stderr is [file_contents "dump.stderr"]" 2
465 return
466 }
467 }
468 }
469
470 if { [which $binary] == 0 } {
471 untested $testname
472 return
473 }
474
475 if { $progopts1 == "" } { set $progopts1 "-r" }
476 verbose "running $binary $progopts $progopts1" 3
477
478 # Objcopy, unlike the other two, won't send its output to stdout,
479 # so we have to run it specially.
480 set cmd "$binary $progopts $progopts1 dump.o > dump.out"
481 if { $program == "objcopy" } {
482 set cmd "$binary $progopts $progopts1 dump.o dump.out"
483 }
484
485 # Ensure consistent sorting of symbols
486 if {[info exists env(LC_ALL)]} {
487 set old_lc_all $env(LC_ALL)
488 }
489 set env(LC_ALL) "C"
490 send_log "$cmd\n"
491 catch "exec $cmd" comp_output
492 if {[info exists old_lc_all]} {
493 set env(LC_ALL) $old_lc_all
494 } else {
495 unset env(LC_ALL)
496 }
497 set comp_output [prune_warnings $comp_output]
498 if ![string match "" $comp_output] then {
499 send_log "$comp_output\n"
500 fail $testname
501 return
502 }
503
504 verbose_eval {[file_contents "dump.out"]} 3
505 if { [regexp_diff "dump.out" "${file}.d"] } then {
506 fail $testname
507 verbose "output is [file_contents "dump.out"]" 2
508 return
509 }
510
511 pass $testname
512 }
513
514 proc slurp_options { file } {
515 if [catch { set f [open $file r] } x] {
516 #perror "couldn't open `$file': $x"
517 perror "$x"
518 return -1
519 }
520 set opt_array {}
521 # whitespace expression
522 set ws {[ ]*}
523 set nws {[^ ]*}
524 # whitespace is ignored anywhere except within the options list;
525 # option names are alphabetic only
526 set pat "^#${ws}(\[a-zA-Z\]*)$ws:${ws}(.*)$ws\$"
527 while { [gets $f line] != -1 } {
528 set line [string trim $line]
529 # Whitespace here is space-tab.
530 if [regexp $pat $line xxx opt_name opt_val] {
531 # match!
532 lappend opt_array [list $opt_name $opt_val]
533 } else {
534 break
535 }
536 }
537 close $f
538 return $opt_array
539 }
540
541 proc objdump { opts } {
542 global OBJDUMP
543 global comp_output
544 global host_triplet
545
546 catch "exec $OBJDUMP $opts" comp_output
547 set comp_output [prune_warnings $comp_output]
548 verbose "objdump output=$comp_output\n" 3
549 }
550
551 proc objdump_start_no_subdir { prog opts } {
552 global OBJDUMP
553 global srcdir
554 global spawn_id
555
556 verbose "Starting $OBJDUMP $opts $prog" 2
557 catch {
558 spawn -noecho -nottyinit $srcdir/lib/run $OBJDUMP $opts $prog
559 } foo
560 if ![regexp {^[0-9]+} $foo] then {
561 perror "Can't run $prog: $foo"
562 }
563 }
564
565 proc objdump_finish { } {
566 global spawn_id
567
568 catch "close"
569 catch "wait"
570 }
571
572 # Default timeout is 10 seconds, loses on a slow machine. But some
573 # configurations of dejagnu may override it.
574 if {$timeout<120} then { set timeout 120 }
575
576 expect_after -i {
577 timeout { perror "timeout" }
578 "virtual memory exhausted" { perror "virtual memory exhausted" }
579 buffer_full { perror "buffer full" }
580 eof { perror "eof" }
581 }
582
583 # regexp_diff, based on simple_diff taken from ld test suite
584 # compares two files line-by-line
585 # file1 contains strings, file2 contains regexps and #-comments
586 # blank lines are ignored in either file
587 # returns non-zero if differences exist
588 #
589 proc regexp_diff { file_1 file_2 } {
590
591 set eof -1
592 set end_1 0
593 set end_2 0
594 set differences 0
595 set diff_pass 0
596
597 if [file exists $file_1] then {
598 set file_a [open $file_1 r]
599 } else {
600 perror "$file_1 doesn't exist"
601 return 1
602 }
603
604 if [file exists $file_2] then {
605 set file_b [open $file_2 r]
606 } else {
607 perror "$file_2 doesn't exist"
608 close $file_a
609 return 1
610 }
611
612 verbose " Regexp-diff'ing: $file_1 $file_2" 2
613
614 while { 1 } {
615 set line_a ""
616 set line_b ""
617 while { [string length $line_a] == 0 } {
618 if { [gets $file_a line_a] == $eof } {
619 set end_1 1
620 break
621 }
622 }
623 while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
624 if [ string match "#pass" $line_b ] {
625 set end_2 1
626 set diff_pass 1
627 break
628 } elseif [ string match "#..." $line_b ] {
629 if { [gets $file_b line_b] == $eof } {
630 set end_2 1
631 break
632 }
633 verbose "looking for \"^$line_b$\"" 3
634 while { ![regexp "^$line_b$" "$line_a"] } {
635 verbose "skipping \"$line_a\"" 3
636 if { [gets $file_a line_a] == $eof } {
637 set end_1 1
638 break
639 }
640 }
641 break
642 }
643 if { [gets $file_b line_b] == $eof } {
644 set end_2 1
645 break
646 }
647 }
648
649 if { $diff_pass } {
650 break
651 } elseif { $end_1 && $end_2 } {
652 break
653 } elseif { $end_1 } {
654 send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
655 verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
656 set differences 1
657 break
658 } elseif { $end_2 } {
659 send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
660 verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
661 set differences 1
662 break
663 } else {
664 verbose "regexp \"^$line_b$\"\nline \"$line_a\"" 3
665 if ![regexp "^$line_b$" "$line_a"] {
666 send_log "regexp_diff match failure\n"
667 send_log "regexp \"^$line_b$\"\nline \"$line_a\"\n"
668 verbose "regexp_diff match failure\n" 3
669 set differences 1
670 }
671 }
672 }
673
674 if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
675 send_log "$file_1 and $file_2 are different lengths\n"
676 verbose "$file_1 and $file_2 are different lengths" 3
677 set differences 1
678 }
679
680 close $file_a
681 close $file_b
682
683 return $differences
684 }
685
686 proc file_contents { filename } {
687 set file [open $filename r]
688 set contents [read $file]
689 close $file
690 return $contents
691 }
692
693 proc write_file { filename contents } {
694 set file [open $filename w]
695 puts $file "$contents"
696 close $file
697 }
698
699 proc verbose_eval { expr { level 1 } } {
700 global verbose
701 if $verbose>$level then { eval verbose "$expr" $level }
702 }
703
704 # This definition is taken from an unreleased version of DejaGnu. Once
705 # that version gets released, and has been out in the world for a few
706 # months at least, it may be safe to delete this copy.
707 if ![string length [info proc prune_warnings]] {
708 #
709 # prune_warnings -- delete various system verbosities from TEXT.
710 #
711 # An example is:
712 # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
713 #
714 # Sites with particular verbose os's may wish to override this in site.exp.
715 #
716 proc prune_warnings { text } {
717 # This is from sun4's. Do it for all machines for now.
718 # The "\\1" is to try to preserve a "\n" but only if necessary.
719 regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
720
721 # It might be tempting to get carried away and delete blank lines, etc.
722 # Just delete *exactly* what we're ask to, and that's it.
723 return $text
724 }
725 }
This page took 0.044203 seconds and 4 git commands to generate.