projects / binutils-gdb.git / blob
? search:


2a2aaf4a17d175b684daccf3eef56d8635cfc04b
[binutils-gdb.git] / binutils / testsuite / lib / binutils-common.exp
1 # Copyright (C) 1993-2022 Free Software Foundation, Inc.
2 #
3 # This file is part of the GNU Binutils.
4 #
5 # This file is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
18 # MA 02110-1301, USA.
19
20 # True if the object format is known to be ELF.
21 #
22 proc is_elf_format {} {
23 # config.sub for these targets curiously transforms a target doublet
24 # ending in -elf to -none. eg. m68hc12-elf to m68hc12-unknown-none
25 # They are always elf.
26 if { [istarget m68hc1*-*] || [istarget s12z*-*] || [istarget xgate-*] } {
27 return 1;
28 }
29 # vxworks (and windiss) excluded due to number of ELF tests that need
30 # modifying to pass on those targets.
31 # && ![istarget *-*-vxworks*]
32 # && ![istarget *-*-windiss*]
33
34 if { ![istarget *-*-chorus*]
35 && ![istarget *-*-cloudabi*]
36 && ![istarget *-*-eabi*]
37 && ![istarget *-*-*elf*]
38 && ![istarget *-*-*freebsd*]
39 && ![istarget *-*-fuchsia*]
40 && ![istarget *-*-gnu*]
41 && ![istarget *-*-irix5*]
42 && ![istarget *-*-irix6*]
43 && ![istarget *-*-kaos*]
44 && ![istarget *-*-*linux*]
45 && ![istarget *-*-lynxos*]
46 && ![istarget *-*-nacl*]
47 && ![istarget *-*-netbsd*]
48 && ![istarget *-*-nto*]
49 && ![istarget *-*-openbsd*]
50 && ![istarget *-*-rtems*]
51 && ![istarget *-*-solaris2*]
52 && ![istarget *-*-sysv4*]
53 && ![istarget *-*-unixware*]
54 && ![istarget *-*-wasm32*]
55 && ![istarget avr-*-*]
56 && ![istarget hppa*64*-*-hpux*]
57 && ![istarget i?86-*-beos*]
58 && ![istarget ia64-*-hpux*] } {
59 return 0
60 }
61
62 if { [istarget i?86-*-beospe*] } {
63 return 0
64 }
65
66 if { [istarget *-*-linux*ecoff*]
67 || [istarget *-*-rtemscoff*] } {
68 return 0
69 }
70
71 if { [istarget *-*-netbsdaout*] } {
72 return 0
73 }
74
75 if { [istarget arm-*-openbsd*]
76 || [istarget ns32k-*-openbsd*]
77 || [istarget vax-*-openbsd*] } {
78 return 0
79 }
80
81 return 1
82 }
83
84 # True if the object format is known to be a.out.
85 #
86 proc is_aout_format {} {
87 if { [istarget *-*-*aout*]
88 || [istarget *-*-bsd*]
89 || [istarget *-*-msdos*]
90 || [istarget ns32k-*-*]
91 || [istarget pdp11-*-*] } {
92 return 1
93 }
94 return 0
95 }
96
97 # True if the object format is known to be PE COFF.
98 #
99 proc is_pecoff_format args {
100 if { [llength $args] == 1 } {
101 set m_os [lindex $args 0]
102 } else {
103 set m_os *-*
104 }
105 if { [istarget $m_os-beospe*]
106 || [istarget $m_os-cegcc*]
107 || [istarget $m_os-cygwin*]
108 || [istarget $m_os-interix*]
109 || [istarget $m_os-mingw*]
110 || [istarget $m_os-pe*]
111 || [istarget $m_os-winnt*] } {
112 return 1
113 }
114 return 0
115 }
116
117 proc is_som_format {} {
118 if { ![istarget hppa*-*-*] || [istarget hppa*64*-*-*] } {
119 return 0;
120 }
121 if { [istarget *-*-osf*] \
122 || [istarget {*-*-h[ip]ux*}] \
123 || [istarget *-*-mpeix*] \
124 || [istarget *-*-bsd*] } {
125 return 1;
126 }
127 return 0;
128 }
129
130 proc is_xcoff_format {} {
131 if { [istarget rs6000-*-*]
132 || [istarget powerpc*-*-aix*]
133 || [istarget powerpc*-*-beos*]
134 || [istarget powerpc*-*-macos*] } {
135 return 1;
136 }
137 return 0;
138 }
139
140 # True if the object format is known to be 64-bit ELF.
141 #
142 proc is_elf64 { binary_file } {
143 global READELF
144 global READELFFLAGS
145
146 set tmpfile [file dirname $binary_file]/readelf.out
147 set readelf_size ""
148 catch "exec $READELF $READELFFLAGS -h $binary_file > $tmpfile" got
149
150 if ![string match "" $got] then {
151 return 0
152 }
153
154 if { ![regexp "\n\[ \]*Class:\[ \]*ELF(\[0-9\]+)\n" \
155 [file_contents $tmpfile] nil readelf_size] } {
156 return 0
157 }
158
159 if { $readelf_size == "64" } {
160 return 1
161 }
162
163 return 0
164 }
165
166 # True if the object format is known to use RELA relocations.
167 #
168 proc is_rela { binary_file } {
169 global READELF
170 global READELFFLAGS
171
172 set tmpfile [file dirname $binary_file]/readelf.out
173 catch "exec $READELF $READELFFLAGS -S $binary_file > $tmpfile" got
174
175 if ![string match "" $got] then {
176 return 0
177 }
178
179 if { ![regexp "RELA" [file_contents $tmpfile]] } {
180 return 0
181 }
182
183 return 1
184 }
185
186 # Return the file name suffix required for executables, if any.
187 #
188 proc exeext {} {
189 if { [istarget *-*-cygwin*]
190 || [istarget *-*-mingw*]
191 || [istarget *-*-msdos*]
192 || [istarget *-*-*vms*] } {
193 return ".exe"
194 }
195 return ""
196 }
197
198 # True if the target matches TARGET, specified as a TCL procedure if
199 # in square brackets or as machine triplet otherwise.
200 #
201 proc match_target { target } {
202 if [regexp {^!?\[.*\]$} $target] {
203 return $target
204 } else {
205 return [istarget $target]
206 }
207 }
208
209 # True if the ELF target supports setting the ELF header OSABI field
210 # to ELFOSABI_GNU or ELFOSABI_FREEBSD, a requirement for STT_GNU_IFUNC
211 # symbol and SHF_GNU_MBIND or SHF_GNU_RETAIN section support.
212 #
213 # This generally depends on the target OS only, however there are a
214 # number of exceptions for bare metal targets as follows. The MSP430
215 # and Visium targets set OSABI to ELFOSABI_STANDALONE. Likewise
216 # non-EABI ARM targets set OSABI to ELFOSABI_ARM
217 #
218 # Non-Linux HPPA defaults to ELFOSABI_HPUX.
219 #
220 # Note that some TI C6X targets use ELFOSABI_C6000_* but one doesn't,
221 # so we don't try to sort out tic6x here. (The effect is that linker
222 # testcases will generally need to exclude tic6x or use a -m option.)
223 #
224 proc supports_gnu_osabi {} {
225 if { [istarget *-*-gnu*]
226 || [istarget *-*-linux*]
227 || [istarget *-*-nacl*]
228 || ( [istarget *-*-*bsd*] && ![istarget arm*-*-netbsd*] )
229 || [istarget *-*-lynxos]
230 || ( [istarget *-*-nto*] && ![istarget arm*-*-*] )
231 || [istarget *-*-irix*]
232 || [istarget *-*-*eabi*]
233 || [istarget *-*-rtems*] } {
234 return 1
235 }
236 if { [istarget "wasm32*-*-*"] } {
237 return 1
238 }
239 if { ![istarget "*-*-elf*"] } {
240 return 0
241 }
242 if { [istarget "arm*-*-*"]
243 || [istarget "msp430-*-*"]
244 || [istarget "hppa-unknown-elf"]
245 || [istarget "visium-*-*"] } {
246 return 0
247 }
248 return 1
249 }
250
251 # Return true if target uses the generic_link_hash_table linker.
252 proc is_generic { } {
253 if { [istarget "d30v-*-*"]
254 || [istarget "dlx-*-*"]
255 || [istarget "pj*-*-*"]
256 || [istarget "s12z-*-*"]
257 || [istarget "xgate-*-*"] } {
258 return 1
259 }
260 return 0
261 }
262
263 # True if the object format is ELF with unused section symbols.
264 proc is_elf_unused_section_symbols {} {
265 global AS ASFLAGS READELF
266
267 if {![info exists elf_unused_section_symbols_saved]} {
268 set elf_unused_section_symbols_saved 1
269 if { [is_elf_format] } {
270 set base "empty[pid]"
271 set src "$base.s"
272 set obj "$base.obj"
273 set f [open $src "w"]
274 close $f
275 set cmd "$AS $ASFLAGS -o $obj $src"
276 send_log "$cmd\n"
277 set cmdret [remote_exec host $cmd]
278 set cmdret [lindex $cmdret 0]
279 if { $cmdret == 0 } {
280 set cmd "$READELF -sW $obj"
281 send_log "$cmd\n"
282 set got [remote_exec host $cmd]
283 if { ![string match "*SECTION*" $got] } {
284 set elf_unused_section_symbols_saved 0
285 }
286 }
287 file delete $obj
288 file delete $src
289 }
290 }
291 return $elf_unused_section_symbols_saved
292 }
293
294 # True if the ELF target supports STB_GNU_UNIQUE.
295 #
296 # This require ELFOSABI_GNU, and `bfd_elf_final_link'.
297 #
298 proc supports_gnu_unique {} {
299 if { [istarget *-*-freebsd*] } {
300 return 0
301 }
302 if { [supports_gnu_osabi] && ![is_generic] } {
303 return 1
304 }
305 return 0
306 }
307
308 # True for targets that do not sort .symtab as per the ELF standard.
309 # ie. any that have mips_elf32_be_vec, mips_elf32_le_vec,
310 # mips_elf32_n_be_vec or mips_elf32_n_le_vec as the primary bfd target
311 # vector in config.bfd. When syncing with config.bfd, don't forget that
312 # earlier case-matches trump later ones.
313 proc is_bad_symtab {} {
314 if { ![istarget "mips*-*-*"] } {
315 return 0;
316 }
317 if { [istarget "*-*-chorus*"]
318 || [istarget "*-*-irix5*"]
319 || [istarget "*-*-irix6*"]
320 || [istarget "*-*-none"]
321 || [istarget "*-*-rtems*"]
322 || [istarget "*-*-windiss"] } {
323 return 1;
324 }
325 if { [istarget "*-*-elf*"]
326 && ![istarget "*-sde-*"]
327 && ![istarget "*-mti-*"]
328 && ![istarget "*-img-*"] } {
329 return 1;
330 }
331 if { [istarget "*-*-openbsd*"]
332 && ![istarget "mips64*-*-*"] } {
333 return 1;
334 }
335 return 0;
336 }
337
338 # Returns true if -shared is supported on the target
339
340 proc check_shared_lib_support { } {
341 global shared_available_saved
342 global ld
343
344 if {![info exists shared_available_saved]} {
345 set ld_output [remote_exec host $ld "-shared"]
346 if { [ string first "not supported" $ld_output ] >= 0 } {
347 set shared_available_saved 0
348 } else {
349 set shared_available_saved 1
350 }
351 }
352 return $shared_available_saved
353 }
354
355 # Returns true if -pie is supported on the target
356
357 proc check_pie_support { } {
358 global pie_available_saved
359 global ld
360
361 if {![info exists pie_available_saved]} {
362 set ld_output [remote_exec host $ld "-pie"]
363 if { [ string first "not supported" $ld_output ] >= 0 } {
364 set pie_available_saved 0
365 } else {
366 set pie_available_saved 1
367 }
368 }
369 return $pie_available_saved
370 }
371
372 proc check_relro_support { } {
373 global relro_available_saved
374 global ld
375
376 if {![info exists relro_available_saved]} {
377 remote_file host delete norelro
378 set ld_output [remote_exec host $ld "-z norelro"]
379 if { [string first "not supported" $ld_output] >= 0
380 || [string first "unrecognized option" $ld_output] >= 0
381 || [string first "-z norelro ignored" $ld_output] >= 0
382 || [string first "cannot find norelro" $ld_output] >= 0 } {
383 set relro_available_saved 0
384 } else {
385 set relro_available_saved 1
386 }
387 }
388 return $relro_available_saved
389 }
390
391 # Check for support of the .noinit section, used for data that is not
392 # initialized at load, or during the application's initialization sequence.
393 proc supports_noinit_section {} {
394 # .noinit is only supported by ELF targets.
395 if { ![is_elf_format] } {
396 return 0;
397 }
398
399 # Targets that set HAVE_NOINIT=yes in their emulparams script utilizing
400 # elf.sc, or explicitly define a .noinit section in their linker script.
401 #
402 # arc-*-* is not included here, since it only supports .noinit with the
403 # non-default arcv2elf emulation.
404 if {[istarget "arm-*-*"]
405 || [istarget "avr-*-*"]
406 || [istarget "msp430-*-*"]
407 || [istarget "pru-*-*"] } {
408 return 1;
409 }
410 return 0;
411 }
412
413 # Check for support of the .persistent section, used for data that is
414 # initialized at load, but not during the application's initialization sequence.
415 proc supports_persistent_section {} {
416 # .persistent is only supported by ELF targets.
417 if { ![is_elf_format] } {
418 return 0;
419 }
420
421 # Targets that set HAVE_PERSISTENT=yes in their emulparams script utilizing
422 # elf.sc, or explicitly define a .persistent section in their linker script.
423 if { [istarget "arm-*-*"]
424 || [istarget "msp430-*-*"] } {
425 return 1;
426 }
427 return 0;
428 }
429
430 # Whether a target support DT_RELR sections.
431 proc supports_dt_relr {} {
432 if { ([istarget x86_64-*-*]
433 || [istarget i?86-*-*]
434 || [istarget powerpc64*-*-*])
435 && ([istarget *-*-linux*]
436 || [istarget *-*-gnu*]) } {
437 return 1
438 }
439 return 0
440 }
441
442 # Compare two files line-by-line. FILE_1 is the actual output and FILE_2
443 # is the expected output. Ignore blank lines in either file.
444 #
445 # FILE_2 is a series of regexps, comments and # directives. The directives
446 # are:
447 #
448 # #pass
449 # Treat the test as a PASS if everything up till this point has
450 # matched. Ignore any remaining lines in either FILE_1 or FILE_2.
451 #
452 # #failif
453 # Reverse the sense of the test: expect differences to exist.
454 #
455 # #...
456 # REGEXP
457 # Skip all lines in FILE_1 until the first that matches REGEXP.
458 #
459 # #?REGEXP
460 # Optionally match REGEXP against line from FILE_1. If the REGEXP
461 # does not match then the next line from FILE_2 is tried.
462 #
463 # Other # lines are comments. Regexp lines starting with the `!' character
464 # specify inverse matching (use `\!' for literal matching against a leading
465 # `!'). Skip empty lines in both files.
466 #
467 # The first optional argument is a list of regexp substitutions of the form:
468 #
469 # EXP1 SUBSPEC1 EXP2 SUBSPEC2 ...
470 #
471 # This tells the function to apply each regexp substitution EXPi->SUBSPECi
472 # in order to every line of FILE_2.
473 #
474 # Return nonzero if differences exist.
475 proc regexp_diff { file_1 file_2 args } {
476 set eof -1
477 set end_1 0
478 set end_2 0
479 set differences 0
480 set diff_pass 0
481 set fail_if_match 0
482 set ref_subst ""
483 if { [llength $args] > 0 } {
484 set ref_subst [lindex $args 0]
485 }
486 if { [llength $args] > 1 } {
487 perror "Too many arguments to regexp_diff"
488 return 1
489 }
490
491 if [file exists $file_1] then {
492 set file_a [open $file_1 r]
493 } else {
494 perror "$file_1 doesn't exist"
495 return 1
496 }
497
498 if [file exists $file_2] then {
499 set file_b [open $file_2 r]
500 } else {
501 perror "$file_2 doesn't exist"
502 close $file_a
503 return 1
504 }
505
506 verbose " Regexp-diff'ing: $file_1 $file_2" 2
507
508 while { 1 } {
509 set line_a ""
510 set line_b ""
511 while { [string length $line_a] == 0 } {
512 # Ignore blank line in FILE_1.
513 if { [gets $file_a line_a] == $eof } {
514 set end_1 1
515 break
516 }
517 }
518 while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
519 if { [string match "#pass" $line_b] } {
520 set end_2 1
521 set diff_pass 1
522 break
523 } elseif { [string match "#failif" $line_b] } {
524 send_log "fail if no difference\n"
525 verbose "fail if no difference" 3
526 set fail_if_match 1
527 } elseif { [string match "#..." $line_b] } {
528 if { [gets $file_b line_b] == $eof } {
529 set end_2 1
530 set diff_pass 1
531 break
532 }
533 set negated [expr { [string index $line_b 0] == "!" }]
534 set line_bx [string range $line_b $negated end]
535 set n [expr { $negated ? "! " : "" }]
536 # Substitute on the reference.
537 foreach {name value} $ref_subst {
538 regsub -- $name $line_bx $value line_bx
539 }
540 verbose "looking for $n\"^$line_bx$\"" 3
541 while { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
542 verbose "skipping \"$line_a\"" 3
543 if { [gets $file_a line_a] == $eof } {
544 set end_1 1
545 break
546 }
547 }
548 break
549 } elseif { [string match "#\\?*" $line_b] } {
550 if { ! $end_1 } {
551 set line_b [string replace $line_b 0 1]
552 set negated [expr { [string index $line_b 0] == "!" }]
553 set line_bx [string range $line_b $negated end]
554 set n [expr { $negated ? "! " : "" }]
555 # Substitute on the reference.
556 foreach {name value} $ref_subst {
557 regsub -- $name $line_bx $value line_bx
558 }
559 verbose "optional match for $n\"^$line_bx$\"" 3
560 if { [expr [regexp "^$line_bx$" "$line_a"] != $negated] } {
561 break
562 }
563 }
564 }
565 if { [gets $file_b line_b] == $eof } {
566 set end_2 1
567 break
568 }
569 }
570
571 if { $diff_pass } {
572 break
573 } elseif { $end_1 && $end_2 } {
574 break
575 } elseif { $end_1 } {
576 send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
577 verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
578 set differences 1
579 break
580 } elseif { $end_2 } {
581 send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
582 verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
583 set differences 1
584 break
585 } else {
586 set negated [expr { [string index $line_b 0] == "!" }]
587 set line_bx [string range $line_b $negated end]
588 set n [expr { $negated ? "! " : "" }]
589 set s [expr { $negated ? " " : "" }]
590 # Substitute on the reference.
591 foreach {name value} $ref_subst {
592 regsub -- $name $line_bx $value line_bx
593 }
594 verbose "regexp $n\"^$line_bx$\"\nline \"$line_a\"" 3
595 if { [expr [regexp "^$line_bx$" "$line_a"] == $negated] } {
596 send_log "regexp_diff match failure\n"
597 send_log "regexp $n\"^$line_bx$\"\nline $s\"$line_a\"\n"
598 verbose "regexp_diff match failure\n" 3
599 set differences 1
600 }
601 }
602 }
603
604 if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
605 send_log "$file_1 and $file_2 are different lengths\n"
606 verbose "$file_1 and $file_2 are different lengths" 3
607 set differences 1
608 }
609
610 if { $fail_if_match } {
611 if { $differences == 0 } {
612 set differences 1
613 } else {
614 set differences 0
615 }
616 }
617
618 close $file_a
619 close $file_b
620
621 return $differences
622 }
623
624 # prune_warnings_extra -- delete extra warnings from TEXT.
625 #
626 # An example is:
627 # ld: warning: /lib64/ld-linux-x86-64.so.2: unsupported GNU_PROPERTY_TYPE (5) type : 0xc0010001
628 proc prune_warnings_extra { text } {
629 global experimental
630 # Warnings are only pruned from non-experimental code (ie code not
631 # on a release branch). For experimental code we want the warnings
632 # as they indicate that the sources need to be updated to recognise
633 # the new properties.
634 if { "$experimental" == "false" } {
635 # The "\\1" is to try to preserve a "\n" but only if necessary.
636 regsub -all "(^|\n)(\[^\n\]*: warning:\[^\n\]*unsupported GNU_PROPERTY_TYPE\[^\n\]*\n?)+" $text "\\1" text
637 }
638 # PR binutils/23898: It is OK to have gaps in build notes.
639 regsub -all "(^|\n)(\[^\n\]*: Warning: Gap in build notes detected from\[^\n\]*\n?)+" $text "\\1" text
640 return $text
641 }
642
643 # This definition is taken from an unreleased version of DejaGnu. Once
644 # that version gets released, and has been out in the world for a few
645 # months at least, it may be safe to delete this copy.
646 if ![string length [info proc prune_warnings]] {
647 #
648 # prune_warnings -- delete various system verbosities from TEXT
649 #
650 # An example is:
651 # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
652 #
653 # Sites with particular verbose os's may wish to override this in site.exp.
654 #
655 proc prune_warnings { text } {
656 # This is from sun4's. Do it for all machines for now.
657 # The "\\1" is to try to preserve a "\n" but only if necessary.
658 regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
659 # It might be tempting to get carried away and delete blank lines, etc.
660 # Just delete *exactly* what we're ask to, and that's it.
661 set text [prune_warnings_extra $text]
662 return $text
663 }
664 } elseif { [info procs saved-prune_warnings] == [list] } {
665 rename prune_warnings saved-prune_warnings
666 proc prune_warnings { text } {
667 set text [saved-prune_warnings $text]
668 set text [prune_warnings_extra $text]
669 return $text
670 }
671 }
672
673 # run_dump_test FILE (optional:) EXTRA_OPTIONS
674 #
675 # Assemble a .s file, then run some utility on it and check the output.
676 # Optionally generate the .s file first by running the compiler.
677 #
678 # There should be an assembly language file named FILE.s in the test
679 # suite directory, and a pattern file called FILE.d. run_dump_test
680 # will assemble FILE.s, optionally run objcopy on the object file,
681 # optionally run ld, optionally run another objcopy, optionally run
682 # another tool under test specified by PROG, then run a dump tool like
683 # addr2line, nm, objdump, readelf or size on the object file to produce
684 # textual output, and then analyze that with regexps.
685 # The FILE.d file specifies what program to run, and what to expect in
686 # its output.
687 #
688 # The FILE.d file begins with zero or more option lines, which specify
689 # flags to pass to the assembler, the program to run to dump the
690 # assembler's output, and the options it wants. The option lines have
691 # the syntax:
692 #
693 # # OPTION: VALUE
694 #
695 # OPTION is the name of some option, like "name" or "objdump", and
696 # VALUE is OPTION's value. The valid options are described below.
697 # Whitespace is ignored everywhere, except within VALUE. The option
698 # list ends with the first line that doesn't match the above syntax.
699 # However, a line within the options that begins with a #, but doesn't
700 # have a recognizable option name followed by a colon, is considered a
701 # comment and entirely ignored.
702 #
703 # The optional EXTRA_OPTIONS argument to `run_dump_test' is a list of
704 # two-element lists. The first element of each is an option name, and
705 # the second additional arguments to be added on to the end of the
706 # option list as given in FILE.d. (If omitted, no additional options
707 # are added.)
708 #
709 # The interesting options are:
710 #
711 # name: TEST-NAME
712 # The name of this test, passed to DejaGNU's `pass' and `fail'
713 # commands. If omitted, this defaults to FILE, the root of the
714 # .s and .d files' names.
715 #
716 # as: FLAGS
717 # When assembling, pass FLAGS to the assembler.
718 # If assembling several files, you can pass different assembler
719 # options in the "source" directives. See below.
720 # Multiple instances of this directive tells run_dump_test to run the test
721 # multiple times -- one time with each set of flags provided.
722 # Each instance will run exactly as a file with a single "as" line, it is
723 # not possible to condition any behaviour on which set of "as" flags is
724 # used. That means that the "source" specific options are appended to
725 # the "as" flags for their corresponding files, and any extra processing
726 # (e.g. with "ld" and "objcopy") is repeated for each test.
727 #
728 # ld: FLAGS
729 # Link assembled files using FLAGS, in the order of the "source"
730 # directives, when using multiple files.
731 #
732 # ld_after_inputfiles: FLAGS
733 # Similar to "ld", but put FLAGS after all input files.
734 #
735 # cc: FLAGS
736 # Run the compiler with FLAGS (to which -S is added) to generate assembler
737 # source first. source: must be provided and should consist of .c files.
738 # Source-specific CC flags are not supported.
739 #
740 # objcopy_objects: FLAGS
741 # Run objcopy with the specified flags after assembling any source
742 # that has the special marker RUN_OBJCOPY in the source specific
743 # flags.
744 #
745 # objcopy_linked_file: FLAGS
746 # Run objcopy on the linked file with the specified flags.
747 # This lets you transform the linked file using objcopy, before the
748 # result is analyzed by an analyzer program specified below.
749 #
750 # PROG: PROGRAM-NAME
751 # The name of a program under test, to run to modify or analyze the
752 # .o file produced by the assembler. Recognised names are: ar,
753 # elfedit, nm, objcopy, ranlib, strings, and strip.
754 #
755 # DUMPPROG: PROGRAM-NAME
756 # The name of the program to run to analyze the file produced
757 # by the assembler or the linker. This can be omitted;
758 # run_dump_test will guess which program to run from which of
759 # the flags options below is present.
760 #
761 # addr2line: FLAGS
762 # nm: FLAGS
763 # objdump: FLAGS
764 # readelf: FLAGS
765 # size: FLAGS
766 # Use the specified program to analyze the output file, and pass it
767 # FLAGS, in addition to the output name. Note that they are run
768 # with LC_ALL=C in the environment to give consistent sorting of
769 # symbols. If no FLAGS are needed then you can use:
770 # DUMPPROG: [nm objdump readelf addr2line]
771 # instead, or just pass a flag that happens to be the default.
772 # If objdump is the dump tool and we're not dumping binary, nor
773 # have run ld, then the standard section names (.text, .data and
774 # .bss) are replaced by target ones if any (eg. rx-elf uses "P"
775 # instead of .text). The substition is done for both the
776 # objdump options (eg: "-j .text" is replaced by "-j P") and the
777 # reference file.
778 #
779 # source: SOURCE [FLAGS]
780 # Assemble the file SOURCE.s using the flags in the "as" directive
781 # and the (optional) FLAGS. If omitted, the source defaults to
782 # FILE.s.
783 # This is useful if several .d files want to share a .s file.
784 # More than one "source" directive can be given, which is useful
785 # when testing linking.
786 #
787 # dump: DUMP
788 # Match against DUMP.d. If omitted, this defaults to FILE.d. This
789 # is useful if several .d files differ by options only. Options are
790 # always read from FILE.d.
791 #
792 # target: GLOB|PROC ...
793 # Run this test only on a specified list of targets. More precisely,
794 # in the space-separated list each glob is passed to "istarget" and
795 # each proc is called as a TCL procedure. List items are interpreted
796 # such that procs are denoted by surrounding square brackets, and any
797 # other items are consired globs. If the call evaluates true for any
798 # of them, the test will be run, otherwise it will be marked
799 # unsupported.
800 #
801 # notarget: GLOB|PROC ...
802 # Do not run this test on a specified list of targets. Again, each
803 # glob in the space-separated list is passed to "istarget" and each
804 # proc is called as a TCL procedure, and the test is run if it
805 # evaluates *false* for *all* of them. Otherwise it will be marked
806 # unsupported.
807 #
808 # alltargets: GLOB|PROC ...
809 # Run this test on a specified list of targets. Again, each
810 # glob in the space-separated list is passed to "istarget" and each
811 # proc is called as a TCL procedure, and the test is run if it
812 # evaluates *true* for *all* of them. Otherwise it will be marked
813 # unsupported.
814 #
815 # skip: GLOB|PROC ...
816 # anyskip: GLOB|PROC ...
817 # noskip: GLOB|PROC ...
818 # These are exactly the same as "notarget", "alltargets" and
819 # "target" respectively, except that they do nothing at all if the
820 # check fails. They should only be used in groups, to construct a
821 # single test which is run on all targets but with variant options
822 # or expected output on some targets. (For example, see
823 # gas/arm/inst.d and gas/arm/wince_inst.d.)
824 #
825 # xfail: GLOB|PROC ...
826 # Run this test and it is is expected to fail on a specified list
827 # of targets.
828 #
829 # error: REGEX
830 # An error with message matching REGEX must be emitted for the test
831 # to pass. The DUMPPROG, addr2line, nm, objdump, readelf and size
832 # options have no meaning and need not supplied if this is present.
833 # Multiple "error" directives append to the expected error message.
834 #
835 # error_output: FILE
836 # Means the same as 'error', except the regular expression lines
837 # are contains in FILE.
838 #
839 # warning: REGEX
840 # Expect a warning matching REGEX. It is an error to issue
841 # both "error" and "warning". Multiple "warning" directives
842 # append to the expected warning message.
843 #
844 # warning_output: FILE
845 # Means the same as 'warning', except the regular expression
846 # lines are contains in FILE.
847 #
848 # map: FILE
849 # Adding this option will cause the linker to generate a linker
850 # map file, using the -Map=MAPFILE command line option. If
851 # there is no -Map=MAPFILE in the 'ld: FLAGS' then one will be
852 # added to the linker command line. The contents of the
853 # generated MAPFILE are then compared against the regexp lines
854 # in FILE using `regexp_diff' (see below for details).
855 #
856 # section_subst: no
857 # Means that the section substitution for objdump is disabled.
858 #
859 # Each option may occur at most once unless otherwise mentioned.
860 #
861 # After the option lines come regexp lines. run_dump_test calls
862 # regexp_diff to compare the output of the dumping tool against the
863 # regexps in FILE.d.
864 #
865 proc run_dump_test { name {extra_options {}} } {
866 global ADDR2LINE ADDR2LINEFLAGS AS ASFLAGS CC_FOR_TARGET CFLAGS_FOR_TARGET
867 global ELFEDIT ELFEDITFLAGS LD LDFLAGS NM NMFLAGS OBJCOPY OBJCOPYFLAGS
868 global OBJDUMP OBJDUMPFLAGS READELF READELFFLAGS STRIP STRIPFLAGS
869 global copyfile env runtests srcdir subdir verbose
870 global DT_RELR_LDFLAGS NO_DT_RELR_LDFLAGS
871
872 if [string match "*/*" $name] {
873 set file $name
874 set name [file tail $name]
875 } else {
876 set file "$srcdir/$subdir/$name"
877 }
878
879 if ![runtest_file_p $runtests $name] then {
880 return
881 }
882
883 set opt_array [slurp_options "${file}.d"]
884 if { $opt_array == -1 } {
885 perror "error reading options from $file.d"
886 unresolved $subdir/$name
887 return
888 }
889 set dumpfile tmpdir/dump.out
890 set run_ld 0
891 set run_objcopy 0
892 set objfile_names {}
893 set opts(PROG) {}
894 set opts(DUMPPROG) {}
895 set opts(addr2line) {}
896 set opts(alltargets) {}
897 set opts(anyskip) {}
898 set opts(ar) {}
899 set opts(as) {}
900 set as_final_flags {}
901 set as_additional_flags {}
902 set opts(cc) {}
903 set opts(dump) {}
904 set opts(elfedit) {}
905 set opts(error) {}
906 set opts(error_output) {}
907 set opts(ld) {}
908 set opts(ld_after_inputfiles) {}
909 set opts(map) {}
910 set opts(name) {}
911 set opts(nm) {}
912 set opts(noskip) {}
913 set opts(notarget) {}
914 set opts(objcopy) {}
915 set opts(objcopy_linked_file) {}
916 set opts(objcopy_objects) {}
917 set opts(objdump) {}
918 set opts(ranlib) {}
919 set opts(readelf) {}
920 set opts(section_subst) {}
921 set opts(size) {}
922 set opts(strings) {}
923 set opts(strip) {}
924 set opts(skip) {}
925 set opts(source) {}
926 set opts(strip) {}
927 set opts(target) {}
928 set opts(warning) {}
929 set opts(warning_output) {}
930 set opts(xfail) {}
931
932 set in_extra 0
933 foreach i [concat $opt_array {{} {}} $extra_options] {
934 set opt_name [lindex $i 0]
935 set opt_val [lindex $i 1]
936 if { $opt_name == "" } {
937 set in_extra 1
938 continue
939 }
940 if ![info exists opts($opt_name)] {
941 perror "unknown option $opt_name in file $file.d"
942 unresolved $subdir/$name
943 return
944 }
945
946 # Allow more substitutions, including tcl functions, for as, ld,
947 # and cc. Not done in general because extra quoting is needed for glob
948 # args used for example in binutils-all/remove-relocs-04.d.
949 if { $opt_name == "as" || $opt_name == "ld" || $opt_name == "cc" } {
950 set opt_val [subst $opt_val]
951 } else {
952 # Just substitute $srcdir and $subdir
953 regsub -all {\$srcdir} "$opt_val" "$srcdir" opt_val
954 regsub -all {\$subdir} "$opt_val" "$subdir" opt_val
955 }
956
957 switch -- $opt_name {
958 xfail {}
959 target {}
960 alltargets {}
961 notarget {}
962 skip {}
963 anyskip {}
964 noskip {}
965 warning {}
966 error {}
967 source {
968 # Move any source-specific as-flags to a separate list to
969 # simplify processing.
970 if { [llength $opt_val] > 1 } {
971 lappend asflags [lrange $opt_val 1 end]
972 set opt_val [lindex $opt_val 0]
973 } else {
974 lappend asflags {}
975 }
976
977 # Create the object file name based on nothing but the source
978 # file name.
979 set new_objfile \
980 [concat tmpdir/[file rootname [file tail [lindex $opt_val 0]]].o]
981 # But, sometimes, we have the exact same source filename in
982 # different directories (foo/src.s bar/src.s) which would lead
983 # us to try and create two src.o files. We detect this
984 # conflict here, and instead create src.o and src1.o.
985 set j 0
986 while { [lsearch $objfile_names $new_objfile] != -1 } {
987 incr j
988 set new_objfile \
989 [concat tmpdir/[file rootname [file tail [lindex $opt_val 0]]]${j}.o]
990 }
991 lappend objfile_names $new_objfile
992 }
993 default {
994 if { !$in_extra
995 && [string length $opts($opt_name)]
996 && $opt_name != "as" } {
997 perror "option $opt_name multiply set in $file.d"
998 unresolved $subdir/$name
999 return
1000 }
1001
1002 # A single "#ld:" with no options should do the right thing.
1003 if { $opt_name == "ld" } {
1004 set run_ld 1
1005 }
1006 # Likewise objcopy_linked_file.
1007 if { $opt_name == "objcopy_linked_file" } {
1008 set run_objcopy 1
1009 }
1010 }
1011 }
1012
1013 # Append differently whether it's a message (without space) or
1014 # an option or list (with space).
1015 switch -- $opt_name {
1016 warning -
1017 error {
1018 append opts($opt_name) $opt_val
1019 }
1020 as {
1021 if { $in_extra } {
1022 set as_additional_flags [concat $as_additional_flags $opt_val]
1023 } else {
1024 lappend opts(as) $opt_val
1025 }
1026 }
1027 default {
1028 set opts($opt_name) [concat $opts($opt_name) $opt_val]
1029 }
1030 }
1031 }
1032
1033 # Ensure there is something in $opts(as) for the foreach loop below.
1034 if { [llength $opts(as)] == 0 } {
1035 set opts(as) [list " "]
1036 }
1037 foreach x $opts(as) {
1038 if { [string length $x] && [string length $as_additional_flags] } {
1039 append x " "
1040 }
1041 append x $as_additional_flags
1042 regsub {\[big_or_little_endian\]} $x \
1043 [big_or_little_endian] x
1044 lappend as_final_flags $x
1045 }
1046
1047 regsub {\[big_or_little_endian\]} $opts(ld) \
1048 [big_or_little_endian] opts(ld)
1049
1050 if { $opts(name) == "" } {
1051 set testname "$subdir/$name"
1052 } else {
1053 set testname $opts(name)
1054 }
1055
1056 set err_warn 0
1057 foreach opt { warning error warning_output error_output } {
1058 if { $opts($opt) != "" } {
1059 if { $err_warn } {
1060 perror "$testname: bad mix of warning and error test directives"
1061 unresolved $testname
1062 return
1063 }
1064 set err_warn 1
1065 }
1066 }
1067
1068 # Decide early whether we should run the test for this target.
1069 if { [llength $opts(noskip)] > 0 } {
1070 set targmatch 0
1071 foreach targ $opts(noskip) {
1072 if [match_target $targ] {
1073 set targmatch 1
1074 break
1075 }
1076 }
1077 if { $targmatch == 0 } {
1078 return
1079 }
1080 }
1081 foreach targ $opts(anyskip) {
1082 if ![match_target $targ] {
1083 return
1084 }
1085 }
1086 foreach targ $opts(skip) {
1087 if [match_target $targ] {
1088 return
1089 }
1090 }
1091 if { [llength $opts(target)] > 0 } {
1092 set targmatch 0
1093 foreach targ $opts(target) {
1094 if [match_target $targ] {
1095 set targmatch 1
1096 break
1097 }
1098 }
1099 if { $targmatch == 0 } {
1100 unsupported $testname
1101 return
1102 }
1103 }
1104 foreach targ $opts(alltargets) {
1105 if ![match_target $targ] {
1106 unsupported $testname
1107 return
1108 }
1109 }
1110 foreach targ $opts(notarget) {
1111 if [match_target $targ] {
1112 unsupported $testname
1113 return
1114 }
1115 }
1116
1117 set dumpprogram ""
1118 # It's meaningless to require an output-testing method when we
1119 # expect an error.
1120 if { $opts(error) == "" && $opts(error_output) == "" } {
1121 if { $opts(DUMPPROG) != "" } {
1122 switch -- $opts(DUMPPROG) {
1123 addr2line { set dumpprogram addr2line }
1124 nm { set dumpprogram nm }
1125 objdump { set dumpprogram objdump }
1126 readelf { set dumpprogram readelf }
1127 size { set dumpprogram size }
1128 default {
1129 perror "unrecognized DUMPPROG option $opts(DUMPPROG) in $file.d"
1130 unresolved $testname
1131 return
1132 }
1133 }
1134 } else {
1135 # Guess which program to run, by seeing which option was specified.
1136 foreach p {addr2line nm objdump readelf size} {
1137 if {$opts($p) != ""} {
1138 if {$dumpprogram != ""} {
1139 perror "ambiguous dump program in $file.d"
1140 unresolved $testname
1141 return
1142 } else {
1143 set dumpprogram $p
1144 }
1145 }
1146 }
1147 }
1148 if { $dumpprogram == "" && $opts(map) == "" && !$err_warn } {
1149 perror "dump program unspecified in $file.d"
1150 unresolved $testname
1151 return
1152 }
1153 }
1154
1155 # Possibly compile some of the inputs, and build up a replacement
1156 # for opts(source) with the output .s names substituted in as we go.
1157 # Set the .s names from the objfile_names to take advantage of the
1158 # uniquification that happened earlier.
1159 if { $opts(cc) != ""} {
1160 set cmdret 0
1161 set new_source ""
1162
1163 foreach cfile $opts(source) ofile $objfile_names {
1164 if { [file extension $cfile] != ".c" } {
1165 lappend new_source "$cfile"
1166 continue
1167 }
1168
1169 if { ! [string match "./*" $cfile] } {
1170 set cfile "$srcdir/$subdir/$cfile"
1171 }
1172 # ofile is never absolute, so this always works to protect sfile
1173 # from later absolutization.
1174 set sfile "./[file rootname $ofile].s"
1175 set cmd "$CC_FOR_TARGET $CFLAGS_FOR_TARGET -S $opts(cc) -o $sfile $cfile"
1176 send_log "$cmd\n"
1177 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>&1"]] "" "/dev/null" "dump.tmp"]
1178 remote_upload host "dump.tmp"
1179 set comp_output [prune_warnings [file_contents "dump.tmp"]]
1180 remote_file host delete "dump.tmp"
1181 remote_file build delete "dump.tmp"
1182 lappend new_source "$sfile"
1183 set cmdret [lindex $cmdret 0]
1184
1185 regsub "\n$" $comp_output "" comp_output
1186 if { $cmdret != 0} {
1187 send_log "compilation of $cfile failed, exit status $cmdret with <$comp_output>"
1188 # Should this be 'unresolved', or is that too silent?
1189 fail $testname
1190 return 0
1191 }
1192 }
1193 set opts(source) $new_source
1194 }
1195
1196 if { $opts(source) == "" } {
1197 set sourcefiles [list ${file}.s]
1198 set asflags [list ""]
1199 set objfile_names [list tmpdir/[file tail ${file}].o]
1200 } else {
1201 set sourcefiles {}
1202 foreach sf $opts(source) {
1203 if { [string match "./*" $sf] } {
1204 lappend sourcefiles "$sf"
1205 } else {
1206 lappend sourcefiles "$srcdir/$subdir/$sf"
1207 }
1208 }
1209 }
1210
1211 if { $opts(dump) == "" } {
1212 set dfile ${file}.d
1213 } else {
1214 set dfile $srcdir/$subdir/$opts(dump)
1215 }
1216
1217 # Time to setup xfailures.
1218 foreach targ $opts(xfail) {
1219 if [match_target $targ] {
1220 setup_xfail "*-*-*"
1221 break
1222 }
1223 }
1224
1225 foreach as_flags $as_final_flags {
1226 # Assemble each file.
1227 set objfiles {}
1228 for { set i 0 } { $i < [llength $sourcefiles] } { incr i } {
1229 set sourcefile [lindex $sourcefiles $i]
1230 set sourceasflags [lindex $asflags $i]
1231 set run_objcopy_objects 0
1232
1233 if { [string match "*RUN_OBJCOPY*" $sourceasflags] } {
1234 set run_objcopy_objects 1
1235 }
1236 regsub "RUN_OBJCOPY" $sourceasflags "" sourceasflags
1237
1238 set objfile [lindex $objfile_names $i]
1239 catch "exec rm -f $objfile" exec_output
1240 lappend objfiles $objfile
1241
1242 if { $as_flags == "binary" } {
1243 while {[file type $sourcefile] eq "link"} {
1244 set newfile [file readlink $sourcefile]
1245 if {[string index $newfile 0] ne "/"} {
1246 set newfile [file dirname $sourcefile]/$newfile
1247 }
1248 set sourcefile $newfile
1249 }
1250 set newfile [remote_download host $sourcefile $objfile]
1251 set cmdret 0
1252 if { $newfile == "" } {
1253 set cmdret 1
1254 }
1255 } else {
1256 if { [istarget "hppa*-*-*"] \
1257 && ![istarget "*-*-linux*"] \
1258 && ![istarget "*-*-netbsd*" ] } {
1259 set cmd "sed -e 's/^\[ \]*\.comm \\(\[^,\]*\\),\\(.*\\)/\\1 .comm \\2/' < $sourcefile > tmpdir/asm.s"
1260 send_log "$cmd\n"
1261 set cmdret [remote_exec host [concat sh -c [list "$cmd"]]]
1262 set cmdret [lindex $cmdret 0]
1263 if { $cmdret != 0 } {
1264 perror "sed failure"
1265 unresolved $testname
1266 continue
1267 }
1268 set sourcefile tmpdir/asm.s
1269 }
1270 set cmd "$AS $ASFLAGS $as_flags $sourceasflags -o $objfile $sourcefile"
1271
1272 send_log "$cmd\n"
1273 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>&1"]] "" "/dev/null" "dump.tmp"]
1274 remote_upload host "dump.tmp"
1275 set comp_output [prune_warnings [file_contents "dump.tmp"]]
1276 remote_file host delete "dump.tmp"
1277 remote_file build delete "dump.tmp"
1278 set cmdret [lindex $cmdret 0]
1279 }
1280 if { $cmdret == 0 && $run_objcopy_objects } {
1281 set cmd "$OBJCOPY $opts(objcopy_objects) $objfile"
1282
1283 send_log "$cmd\n"
1284 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>&1"]] \
1285 "" "/dev/null" "dump.tmp"]
1286 remote_upload host "dump.tmp"
1287 append comp_output [prune_warnings [file_contents "dump.tmp"]]
1288 remote_file host delete "dump.tmp"
1289 remote_file build delete "dump.tmp"
1290 set cmdret [lindex $cmdret 0]
1291 }
1292 }
1293
1294 # Perhaps link the file(s).
1295 if { $cmdret == 0 && $run_ld } {
1296 set objfile "tmpdir/dump"
1297 catch "exec rm -f $objfile" exec_output
1298
1299 set ld_extra_opt ""
1300 global ld
1301 set ld "$LD"
1302 if [check_relro_support] {
1303 set ld_extra_opt "-z norelro"
1304 }
1305
1306 # Add -L$srcdir/$subdir so that the linker command can use
1307 # linker scripts in the source directory.
1308 set cmd "$LD $ld_extra_opt $LDFLAGS -L$srcdir/$subdir \
1309 $opts(ld) -o $objfile $objfiles $opts(ld_after_inputfiles)"
1310
1311 # If needed then check for, or add a -Map option.
1312 set mapfile ""
1313 if { $opts(map) != "" } then {
1314 if { [regexp -- "-Map=(\[^ \]+)" $cmd all mapfile] } then {
1315 # Found existing mapfile option
1316 verbose -log "Existing mapfile '$mapfile' found"
1317 } else {
1318 # No mapfile option.
1319 set mapfile "tmpdir/dump.map"
1320 verbose -log "Adding mapfile '$mapfile'"
1321 set cmd "$cmd -Map=$mapfile"
1322 }
1323 }
1324
1325 send_log "$cmd\n"
1326 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>&1"]] "" "/dev/null" "dump.tmp"]
1327 remote_upload host "dump.tmp"
1328 append comp_output [file_contents "dump.tmp"]
1329 remote_file host delete "dump.tmp"
1330 remote_file build delete "dump.tmp"
1331 set cmdret [lindex $cmdret 0]
1332
1333 if { $cmdret == 0 && $run_objcopy } {
1334 set infile $objfile
1335 set objfile "tmpdir/dump1"
1336 remote_file host delete $objfile
1337
1338 # Note that we don't use OBJCOPYFLAGS here; any flags must be
1339 # explicitly specified.
1340 set cmd "$OBJCOPY $opts(objcopy_linked_file) $infile $objfile"
1341
1342 send_log "$cmd\n"
1343 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>&1"]] "" "/dev/null" "dump.tmp"]
1344 remote_upload host "dump.tmp"
1345 append comp_output [file_contents "dump.tmp"]
1346 remote_file host delete "dump.tmp"
1347 remote_file build delete "dump.tmp"
1348 set cmdret [lindex $cmdret 0]
1349 }
1350 } else {
1351 set objfile [lindex $objfiles 0]
1352 }
1353
1354 if { $cmdret == 0 && $opts(PROG) != "" } {
1355 set destopt ${copyfile}.o
1356 switch -- $opts(PROG) {
1357 ar { set program ar }
1358 elfedit {
1359 set program elfedit
1360 set destopt ""
1361 }
1362 nm { set program nm }
1363 objcopy { set program objcopy }
1364 ranlib { set program ranlib }
1365 strings { set program strings }
1366 strip {
1367 set program strip
1368 set destopt "-o $destopt"
1369 }
1370 default {
1371 perror "unrecognized PROG option $opts(PROG) in $file.d"
1372 unresolved $testname
1373 continue
1374 }
1375 }
1376
1377 set progopts1 $opts($program)
1378 eval set progopts \$[string toupper $program]FLAGS
1379 eval set binary \$[string toupper $program]
1380
1381 if { ![is_remote host] && [which $binary] == 0 } {
1382 untested $testname
1383 continue
1384 }
1385
1386 verbose "running $binary $progopts $progopts1" 3
1387 set cmd "$binary $progopts $progopts1 $objfile $destopt"
1388
1389 # Ensure consistent sorting of symbols
1390 if {[info exists env(LC_ALL)]} {
1391 set old_lc_all $env(LC_ALL)
1392 }
1393 set env(LC_ALL) "C"
1394 send_log "$cmd\n"
1395 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>dump.tmp"]] "" "/dev/null"]
1396 set cmdret [lindex $cmdret 0]
1397 remote_upload host "dump.tmp"
1398 append comp_output [prune_warnings [file_contents "dump.tmp"]]
1399 remote_file host delete "dump.tmp"
1400 remote_file build delete "dump.tmp"
1401 if {[info exists old_lc_all]} {
1402 set env(LC_ALL) $old_lc_all
1403 } else {
1404 unset env(LC_ALL)
1405 }
1406 if { $destopt != "" } {
1407 set objfile ${copyfile}.o
1408 }
1409 }
1410
1411 set want_out(source) ""
1412 set want_out(terminal) 0
1413 if { $err_warn } {
1414 if { $opts(error) != "" || $opts(error_output) != "" } {
1415 set want_out(terminal) 1
1416 }
1417
1418 if { $opts(error) != "" || $opts(warning) != "" } {
1419 set want_out(source) "regex"
1420 if { $opts(error) != "" } {
1421 set want_out(regex) $opts(error)
1422 } else {
1423 set want_out(regex) $opts(warning)
1424 }
1425 } else {
1426 set want_out(source) "file"
1427 if { $opts(error_output) != "" } {
1428 set want_out(file) $opts(error_output)
1429 } else {
1430 set want_out(file) $opts(warning_output)
1431 }
1432 }
1433 }
1434
1435 regsub "\n$" $comp_output "" comp_output
1436 if { $cmdret != 0 || $comp_output != "" || $want_out(source) != "" } {
1437 set exitstat "succeeded"
1438 if { $cmdret != 0 } { set exitstat "failed" }
1439
1440 if { $want_out(source) == "regex" } {
1441 verbose -log "$exitstat with: <$comp_output>, expected: <$want_out(regex)>"
1442 } elseif { $want_out(source) == "file" } {
1443 verbose -log "$exitstat with: <$comp_output>, expected in file $want_out(file)"
1444 set_file_contents "tmpdir/ld.messages" "$comp_output"
1445 } else {
1446 verbose -log "$exitstat with: <$comp_output>, no expected output"
1447 }
1448
1449 if { (($want_out(source) == "") == ($comp_output == "")) \
1450 && (($cmdret == 0) == ($want_out(terminal) == 0)) \
1451 && ((($want_out(source) == "regex") \
1452 && [regexp -- $want_out(regex) $comp_output]) \
1453 || (($want_out(source) == "file") \
1454 && (![regexp_diff "tmpdir/ld.messages" "$srcdir/$subdir/$want_out(file)"]))) } {
1455 # We have the expected output.
1456 if { $want_out(terminal) || $dumpprogram == "" } {
1457 pass $testname
1458 continue
1459 }
1460 } else {
1461 fail $testname
1462 continue
1463 }
1464 }
1465
1466 # We must not have expected failure if we get here.
1467 if { $want_out(terminal) } {
1468 fail $testname
1469 continue
1470 }
1471
1472 if { $opts(map) != "" } then {
1473 # Check the map file matches.
1474 set map_pattern_file $srcdir/$subdir/$opts(map)
1475 verbose -log "Compare '$mapfile' against '$map_pattern_file'"
1476 if { [regexp_diff $mapfile $map_pattern_file] } then {
1477 fail "$testname (map file check)"
1478 } else {
1479 pass "$testname (map file check)"
1480 }
1481
1482 if { $dumpprogram == "" } then {
1483 continue
1484 }
1485 }
1486
1487 set progopts1 $opts($dumpprogram)
1488 eval set progopts \$[string toupper $dumpprogram]FLAGS
1489 eval set binary \$[string toupper $dumpprogram]
1490
1491 if { ![is_remote host] && [which $binary] == 0 } {
1492 untested $testname
1493 continue
1494 }
1495
1496 # For objdump of gas output, automatically translate standard section names
1497 set sect_names ""
1498 if { !$run_ld && $dumpprogram == "objdump" \
1499 && $opts(section_subst) != "no" \
1500 && ![string match "*-b binary*" $progopts1] } {
1501 set sect_names [get_standard_section_names]
1502 if { $sect_names != ""} {
1503 regsub -- "\\.text" $progopts1 "[lindex $sect_names 0]" progopts1
1504 regsub -- "\\.data" $progopts1 "[lindex $sect_names 1]" progopts1
1505 regsub -- "\\.bss" $progopts1 "[lindex $sect_names 2]" progopts1
1506 }
1507 }
1508
1509 if { $progopts1 == "" } { set $progopts1 "-r" }
1510 verbose "running $binary $progopts $progopts1" 3
1511
1512 set cmd "$binary $progopts $progopts1 $objfile > $dumpfile"
1513
1514 # Ensure consistent sorting of symbols
1515 if {[info exists env(LC_ALL)]} {
1516 set old_lc_all $env(LC_ALL)
1517 }
1518 set env(LC_ALL) "C"
1519 send_log "$cmd\n"
1520 set cmdret [remote_exec host [concat sh -c [list "$cmd 2>dump.tmp"]] "" "/dev/null"]
1521 set cmdret [lindex $cmdret 0]
1522 remote_upload host "dump.tmp"
1523 set comp_output [prune_warnings [file_contents "dump.tmp"]]
1524 remote_file host delete "dump.tmp"
1525 remote_file build delete "dump.tmp"
1526 if {[info exists old_lc_all]} {
1527 set env(LC_ALL) $old_lc_all
1528 } else {
1529 unset env(LC_ALL)
1530 }
1531 if { $cmdret != 0 || $comp_output != "" } {
1532 send_log "exited abnormally with $cmdret, output:$comp_output\n"
1533 fail $testname
1534 continue
1535 }
1536
1537 if { $verbose > 2 } then { verbose "output is [file_contents $dumpfile]" 3 }
1538
1539 # Create the substition list for objdump output.
1540 set regexp_subst ""
1541 if { $sect_names != "" } {
1542 set regexp_subst [list "\\\\?\\.text" [lindex $sect_names 0] \
1543 "\\\\?\\.data" [lindex $sect_names 1] \
1544 "\\\\?\\.bss" [lindex $sect_names 2] ]
1545 }
1546
1547 if { [regexp_diff $dumpfile "${dfile}" $regexp_subst] } then {
1548 fail $testname
1549 if { $verbose == 2 } then { verbose "output is [file_contents $dumpfile]" 2 }
1550 continue
1551 }
1552
1553 pass $testname
1554 }
1555 }
1556
1557 proc slurp_options { file } {
1558 # If options_regsub(foo) is set to {a b}, then the contents of a
1559 # "#foo:" line will have regsub -all applied to replace a with b.
1560 global options_regsub
1561
1562 if [catch { set f [open $file r] } x] {
1563 #perror "couldn't open `$file': $x"
1564 perror "$x"
1565 return -1
1566 }
1567 set opt_array {}
1568 # whitespace expression
1569 set ws {[ ]*}
1570 set nws {[^ ]*}
1571 # whitespace is ignored anywhere except within the options list;
1572 # option names are alphanumeric plus underscore.
1573 set pat "^#${ws}(\[a-zA-Z0-9_\]*)$ws:${ws}(.*)$ws\$"
1574 while { [gets $f line] != -1 } {
1575 set line [string trim $line]
1576 # Whitespace here is space-tab.
1577 if [regexp $pat $line xxx opt_name opt_val] {
1578 # match!
1579 if [info exists options_regsub($opt_name)] {
1580 set subst $options_regsub($opt_name)
1581 regsub -all -- [lindex $subst 0] $opt_val [lindex $subst 1] \
1582 opt_val
1583 }
1584 lappend opt_array [list $opt_name $opt_val]
1585 } elseif {![regexp "^#" $line ]} {
1586 break
1587 }
1588 }
1589 close $f
1590 return $opt_array
1591 }
1592
1593 proc file_contents { filename } {
1594 set file [open $filename r]
1595 set contents [read $file]
1596 close $file
1597 return $contents
1598 }
1599
1600 proc set_file_contents { filename contents } {
1601 set file [open $filename w]
1602 puts $file "$contents"
1603 close $file
1604 }
1605
1606 # Look for big-endian or little-endian switches in the multlib
1607 # options and translate these into a -EB or -EL switch. Note
1608 # we cannot rely upon proc process_multilib_options to do this
1609 # for us because for some targets the compiler does not support
1610 # -EB/-EL but it does support -mbig-endian/-mlittle-endian, and
1611 # the site.exp file will include the switch "-mbig-endian"
1612 # (rather than "big-endian") which is not detected by proc
1613 # process_multilib_options.
1614 #
1615 proc big_or_little_endian {} {
1616
1617 if [board_info [target_info name] exists multilib_flags] {
1618 set tmp_flags " [board_info [target_info name] multilib_flags]"
1619
1620 foreach x $tmp_flags {
1621 switch -glob $x {
1622 *big*endian -
1623 eb -
1624 EB -
1625 -eb -
1626 -EB -
1627 -mb -
1628 -meb {
1629 set flags " -EB"
1630 return $flags
1631 }
1632 *little*endian -
1633 el -
1634 EL -
1635 -el -
1636 -EL -
1637 -ml -
1638 -mel {
1639 set flags " -EL"
1640 return $flags
1641 }
1642 }
1643 }
1644 }
1645
1646 set flags ""
1647 return $flags
1648 }
1649
1650 # Internal procedure: return the names of the standard sections
1651 #
1652 proc get_standard_section_names {} {
1653 if [istarget "rx-*-elf"] {
1654 return { "P" "D_1" "B_1" }
1655 }
1656 if { [istarget "alpha*-*-*vms*"] || [is_som_format] } {
1657 return { {\$CODE\$} {\$DATA\$} {\$BSS\$} }
1658 }
1659 return
1660 }