1 # Copyright 1993, 1994, 1995, 1996, 1997, 2000, 2001, 2003, 2004, 2006, 2007,
2 # 2009, 2010 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 3 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
18 # Please email any bugs, comments, and/or additions to this file to:
19 # bug-dejagnu@prep.ai.mit.edu
21 # This file was written by Rob Savoye <rob@cygnus.com>
22 # and extended by Ian Lance Taylor <ian@cygnus.com>
24 proc load_common_lib { name } {
28 load_common_lib binutils-common.exp
30 proc binutil_version { prog } {
31 if ![is_remote host] {
32 set path [which $prog]
33 if {$path == 0} then {
34 perror "$prog can't be run, file not found."
40 set state [remote_exec host $prog --version]
41 set tmp "[lindex $state 1]\n"
42 # Should find a way to discard constant parts, keep whatever's
43 # left, so the version string could be almost anything at all...
44 regexp "\[^\n\]* (cygnus-|)(\[-0-9.a-zA-Z-\]+)\[\r\n\].*" "$tmp" version cyg number
45 if ![info exists number] then {
46 return "$path (no version number)\n"
48 return "$path $number\n"
52 # default_binutils_run
53 # run a program, returning the output
54 # sets binutils_run_failed if the program does not exist
56 proc default_binutils_run { prog progargs } {
57 global binutils_run_failed
60 set binutils_run_failed 0
62 if ![is_remote host] {
63 if {[which $prog] == 0} then {
64 perror "$prog does not exist"
65 set binutils_run_failed 1
70 send_log "$prog $progargs\n"
71 verbose "$prog $progargs"
73 # Gotta quote dollar-signs because they get mangled by the
75 regsub -all "\\$" "$progargs" "\\$" progargs
77 set state [remote_exec host $prog $progargs]
78 set exec_output [prune_warnings [lindex $state 1]]
79 if {![string match "" $exec_output]} then {
80 send_log "$exec_output\n"
81 verbose "$exec_output"
83 if { [lindex $state 0] != 0 } {
84 set exec_output "$prog exited with status [lindex $state 0]"
85 send_log "$exec_output\n"
86 verbose "$exec_output"
93 # default_binutils_assemble_flags
96 proc default_binutils_assemble_flags { source object asflags } {
100 # The HPPA assembler syntax is a little different than most, to make
101 # the test source file assemble we need to run it through sed.
103 # This is a hack in that it won't scale well if other targets need
104 # similar transformations to assemble. We'll generalize the hack
105 # if/when other targets need similar handling.
106 if { [istarget "hppa*-*-*"] && ![istarget "*-*-linux*" ] } then {
107 set sed_file $srcdir/config/hppa.sed
108 send_log "sed -f $sed_file < $source > asm.s\n"
109 verbose "sed -f $sed_file < $source > asm.s"
110 catch "exec sed -f $sed_file < $source > asm.s"
114 set exec_output [target_assemble $source $object $asflags]
115 set exec_output [prune_warnings $exec_output]
117 if [string match "" $exec_output] {
120 send_log "$exec_output\n"
121 verbose "$exec_output"
122 perror "$source: assembly failed"
129 # Returns target executable extension, if any.
132 if { [istarget *-*-mingw*] || [istarget *-*-cygwin*] } {
139 # Copied and modified from gas.
141 # run_dump_test FILE (optional:) EXTRA_OPTIONS
143 # Assemble a .s file, then run some utility on it and check the output.
145 # There should be an assembly language file named FILE.s in the test
146 # suite directory, and a pattern file called FILE.d. `run_dump_test'
147 # will assemble FILE.s, run some tool like `objdump', `objcopy', or
148 # `nm' on the .o file to produce textual output, and then analyze that
149 # with regexps. The FILE.d file specifies what program to run, and
150 # what to expect in its output.
152 # The FILE.d file begins with zero or more option lines, which specify
153 # flags to pass to the assembler, the program to run to dump the
154 # assembler's output, and the options it wants. The option lines have
159 # OPTION is the name of some option, like "name" or "objdump", and
160 # VALUE is OPTION's value. The valid options are described below.
161 # Whitespace is ignored everywhere, except within VALUE. The option
162 # list ends with the first line that doesn't match the above syntax.
163 # However, a line within the options that begins with a #, but doesn't
164 # have a recognizable option name followed by a colon, is considered a
165 # comment and entirely ignored.
167 # The optional EXTRA_OPTIONS argument to `run_dump_test' is a list of
168 # two-element lists. The first element of each is an option name, and
169 # the second additional arguments to be added on to the end of the
170 # option list as given in FILE.d. (If omitted, no additional options
173 # The interesting options are:
176 # The name of this test, passed to DejaGNU's `pass' and `fail'
177 # commands. If omitted, this defaults to FILE, the root of the
178 # .s and .d files' names.
181 # When assembling FILE.s, pass FLAGS to the assembler.
184 # The name of the program to run to analyze the .o file produced
185 # by the assembler. This can be omitted; run_dump_test will guess
186 # which program to run by seeing which of the flags options below
192 # Use the specified program to analyze the .o file, and pass it
193 # FLAGS, in addition to the .o file name. Note that they are run
194 # with LC_ALL=C in the environment to give consistent sorting
198 # Assemble the file SOURCE.s. If omitted, this defaults to FILE.s.
199 # This is useful if several .d files want to share a .s file.
202 # Run this test only on a specified list of targets. More precisely,
203 # each glob in the space-separated list is passed to "istarget"; if
204 # it evaluates true for any of them, the test will be run, otherwise
205 # it will be marked unsupported.
207 # not-target: GLOBS...
208 # Do not run this test on a specified list of targets. Again,
209 # the each glob in the space-separated list is passed to
210 # "istarget", and the test is run if it evaluates *false* for
211 # *all* of them. Otherwise it will be marked unsupported.
215 # These are exactly the same as "not-target" and "target",
216 # respectively, except that they do nothing at all if the check
217 # fails. They should only be used in groups, to construct a single
218 # test which is run on all targets but with variant options or
219 # expected output on some targets. (For example, see
220 # gas/arm/inst.d and gas/arm/wince_inst.d.)
223 # An error with message matching REGEX must be emitted for the test
224 # to pass. The PROG, objdump, nm and objcopy options have no
225 # meaning and need not supplied if this is present.
228 # Expect a gas warning matching REGEX. It is an error to issue
229 # both "error" and "warning".
232 # FILE contains regexp lines to be matched against the diagnostic
233 # output of the assembler. This does not preclude the use of
234 # PROG, nm, objdump, or objcopy.
237 # Means the same as 'stderr', but also indicates that the assembler
238 # is expected to exit unsuccessfully (therefore PROG, objdump, nm,
239 # and objcopy have no meaning and should not be supplied).
241 # Each option may occur at most once.
243 # After the option lines come regexp lines. `run_dump_test' calls
244 # `regexp_diff' to compare the output of the dumping tool against the
245 # regexps in FILE.d. `regexp_diff' is defined later in this file; see
246 # further comments there.
248 proc run_dump_test { name {extra_options {}} } {
250 global OBJDUMP NM OBJCOPY READELF STRIP
251 global OBJDUMPFLAGS NMFLAGS OBJCOPYFLAGS READELFFLAGS STRIPFLAGS
252 global ELFEDIT ELFEDITFLAGS
258 if [string match "*/*" $name] {
260 set name [file tail $name]
262 set file "$srcdir/$subdir/$name"
264 set opt_array [slurp_options "${file}.d"]
265 if { $opt_array == -1 } {
266 perror "error reading options from $file.d"
267 unresolved $subdir/$name
270 set opts(addr2line) {}
284 set opts(DUMPPROG) {}
287 set opts(not-target) {}
289 set opts(not-skip) {}
291 foreach i $opt_array {
292 set opt_name [lindex $i 0]
293 set opt_val [lindex $i 1]
294 if ![info exists opts($opt_name)] {
295 perror "unknown option $opt_name in file $file.d"
296 unresolved $subdir/$name
300 # Permit the option to use $srcdir to refer to the source
302 regsub -all "\\\$srcdir" "$opt_val" "$srcdir/$subdir" opt_val
304 if [string length $opts($opt_name)] {
305 perror "option $opt_name multiply set in $file.d"
306 unresolved $subdir/$name
309 set opts($opt_name) $opt_val
312 foreach i $extra_options {
313 set opt_name [lindex $i 0]
314 set opt_val [lindex $i 1]
315 if ![info exists opts($opt_name)] {
316 perror "unknown option $opt_name given in extra_opts"
317 unresolved $subdir/$name
321 # Permit the option to use $srcdir to refer to the source
323 regsub -all "\\\$srcdir" "$opt_val" "$srcdir/$subdir" opt_val
325 # add extra option to end of existing option, adding space
327 if [string length $opts($opt_name)] {
328 append opts($opt_name) " "
330 append opts($opt_name) $opt_val
333 if { $opts(name) == "" } {
334 set testname "$subdir/$name"
336 set testname $opts(name)
338 verbose "Testing $testname"
340 if {$opts(PROG) == ""} {
341 perror "program isn't set in $file.d"
347 switch -- $opts(PROG) {
348 ar { set program ar }
349 objcopy { set program objcopy }
350 ranlib { set program ranlib }
355 strings { set program strings }
356 elfedit { set program elfedit }
358 perror "unrecognized program option $opts(PROG) in $file.d"
364 if { $opts(DUMPPROG) != "" } {
365 switch -- $opts(DUMPPROG) {
366 addr2line { set dumpprogram addr2line }
367 nm { set dumpprogram nm }
368 objdump { set dumpprogram objdump }
369 readelf { set dumpprogram readelf }
370 size { set dumpprogram size }
372 perror "unrecognized dump program option $opts(DUMPPROG) in $file.d"
377 # Guess which program to run, by seeing which option was specified.
378 foreach p {objdump nm readelf} {
379 if {$opts($p) != ""} {
380 if {$dumpprogram != ""} {
381 perror "ambiguous dump program in $file.d"
391 # Handle skipping the test on specified targets.
392 # You can have both skip/not-skip and target/not-target, but you can't
393 # have both skip and not-skip, or target and not-target, in the same file.
394 if { $opts(skip) != "" } then {
395 if { $opts(not-skip) != "" } then {
396 perror "$testname: mixing skip and not-skip directives is invalid"
400 foreach glob $opts(skip) {
401 if {[istarget $glob]} { return }
404 if { $opts(not-skip) != "" } then {
406 foreach glob $opts(not-skip) {
407 if {[istarget $glob]} {
412 if {$skip} { return }
414 if { $opts(target) != "" } then {
415 if { $opts(not-target) != "" } then {
416 perror "$testname: mixing target and not-target directives is invalid"
421 foreach glob $opts(target) {
422 if {[istarget $glob]} {
428 unsupported $testname
432 if { $opts(not-target) != "" } then {
433 foreach glob $opts(not-target) {
434 if {[istarget $glob]} {
435 unsupported $testname
441 if { $opts(source) == "" } {
442 set srcfile ${file}.s
444 set srcfile $srcdir/$subdir/$opts(source)
447 set exec_output [binutils_assemble_flags ${srcfile} $tempfile $opts(as)]
448 if [string match "" $exec_output] then {
449 send_log "$exec_output\n"
450 verbose "$exec_output"
455 set progopts1 $opts($program)
456 eval set progopts \$[string toupper $program]FLAGS
457 eval set binary \$[string toupper $program]
459 set exec_output [binutils_run $binary "$progopts $progopts1 $tempfile $destopt ${copyfile}.o"]
460 if ![string match "" $exec_output] {
461 send_log "$exec_output\n"
462 verbose "$exec_output"
467 set progopts1 $opts($dumpprogram)
468 eval set progopts \$[string toupper $dumpprogram]FLAGS
469 eval set binary \$[string toupper $dumpprogram]
471 if { ![is_remote host] && [which $binary] == 0 } {
476 verbose "running $binary $progopts $progopts1" 3
478 set cmd "$binary $progopts $progopts1 ${copyfile}.o"
480 # Ensure consistent sorting of symbols
481 if {[info exists env(LC_ALL)]} {
482 set old_lc_all $env(LC_ALL)
486 set comp_output [remote_exec host $cmd "" "/dev/null" "tmpdir/dump.out"]
487 if {[info exists old_lc_all]} {
488 set env(LC_ALL) $old_lc_all
492 if { [lindex $comp_output 0] != 0 } then {
493 send_log "$comp_output\n"
497 set comp_output [prune_warnings [lindex $comp_output 1]]
498 if ![string match "" $comp_output] then {
499 send_log "$comp_output\n"
504 verbose_eval {[file_contents "tmpdir/dump.out"]} 3
505 if { [regexp_diff "tmpdir/dump.out" "${file}.d"] } then {
507 verbose "output is [file_contents "tmpdir/dump.out"]" 2
514 proc slurp_options { file } {
515 if [catch { set f [open $file r] } x] {
516 #perror "couldn't open `$file': $x"
521 # whitespace expression
524 # whitespace is ignored anywhere except within the options list;
525 # option names are alphabetic plus dash
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] {
532 lappend opt_array [list $opt_name $opt_val]
533 } elseif {![regexp "^#" $line ]} {
541 # regexp_diff, based on simple_diff taken from ld test suite
542 # compares two files line-by-line
543 # file1 contains strings, file2 contains regexps and #-comments
544 # blank lines are ignored in either file
545 # returns non-zero if differences exist
547 proc regexp_diff { file_1 file_2 } {
555 if [file exists $file_1] then {
556 set file_a [open $file_1 r]
558 perror "$file_1 doesn't exist"
562 if [file exists $file_2] then {
563 set file_b [open $file_2 r]
565 perror "$file_2 doesn't exist"
570 verbose " Regexp-diff'ing: $file_1 $file_2" 2
575 while { [string length $line_a] == 0 } {
576 if { [gets $file_a line_a] == $eof } {
581 while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
582 if [ string match "#pass" $line_b ] {
586 } elseif [ string match "#..." $line_b ] {
587 if { [gets $file_b line_b] == $eof } {
592 verbose "looking for \"^$line_b$\"" 3
593 while { ![regexp "^$line_b$" "$line_a"] } {
594 verbose "skipping \"$line_a\"" 3
595 if { [gets $file_a line_a] == $eof } {
602 if { [gets $file_b line_b] == $eof } {
610 } elseif { $end_1 && $end_2 } {
612 } elseif { $end_1 } {
613 send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
614 verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
617 } elseif { $end_2 } {
618 send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
619 verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
623 verbose "regexp \"^$line_b$\"\nline \"$line_a\"" 3
624 if ![regexp "^$line_b$" "$line_a"] {
625 send_log "regexp_diff match failure\n"
626 send_log "regexp \"^$line_b$\"\nline \"$line_a\"\n"
627 verbose "regexp_diff match failure\n" 3
633 if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
634 send_log "$file_1 and $file_2 are different lengths\n"
635 verbose "$file_1 and $file_2 are different lengths" 3
645 proc file_contents { filename } {
646 set file [open $filename r]
647 set contents [read $file]
652 proc verbose_eval { expr { level 1 } } {
654 if $verbose>$level then { eval verbose "$expr" $level }