1 # Copyright
(C
) 1999-2024 Free Software Foundation
, Inc.
3 # This
program is free software
; you can redistribute it and
/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation
; either version
3 of the License
, or
6 #
(at your option
) any later version.
8 # This
program is distributed in the hope that it will be useful
,
9 # but WITHOUT
ANY WARRANTY
; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License
for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this
program; if not
, write to the Free Software
15 # Foundation
, Inc.
, 51 Franklin Street
- Fifth Floor
, Boston
, MA
02110-1301, USA.
17 # Please email
any bugs
, comments
, and
/or additions to this file to
:
18 # bug
-dejagnu@prep.ai.mit.edu
20 # Written by Nick Clifton
<nickc@cygnus.com
>
21 # Based
on scripts written by Ian Lance Taylor
<ian@cygnus.com
>
22 # and Ken Raeburn
<raeburn@cygnus.com
>.
24 # Exclude non
-ELF targets.
26 verbose
"$READELF is only intended for ELF targets" 2
30 # First some helpful procedures
, then the tests themselves
32 #
Return the contents of the filename given
33 proc file_contents
{ filename
} {
34 set file
[open $filename r
]
35 set contents
[read $file
]
40 # Find out the size by reading the output of the EI_CLASS field.
41 # Similar to the test
for readelf
-h
, but we
're just looking for the
43 proc readelf_find_size { binary_file test_iteration } {
49 set testname "finding out ELF size with readelf -h ($test_iteration)"
50 set got [remote_exec host "$READELF $READELFFLAGS -h $binary_file" "" "/dev/null" "readelf.out"]
51 if [is_remote host] then {
52 remote_upload host "readelf.out"
55 if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]]} then {
61 if { ! [regexp "\n\[ \]*Class:\[ \]*ELF(\[0-9\]+)\n" \
62 [file_contents readelf.out] nil readelf_size] } {
63 verbose -log "EI_CLASS field not found in output"
64 verbose -log "output is \n[file_contents readelf.out]"
68 verbose -log "ELF size is $readelf_size"
74 # Run an individual readelf test.
75 # Basically readelf is run on the binary_file with the given options.
76 # Readelf's output is captured and
then compared against the contents
77 # of the regexp_file
-readelf_size
if it
exists, else regexp_file.
79 proc readelf_test
{ options binary_file regexp_file
} {
87 set testname
"readelf $options [file rootname [file tail $binary_file]]"
89 send_log
"exec $READELF $READELFFLAGS $options $binary_file > readelf.out\n"
90 set got
[remote_exec host
"$READELF $READELFFLAGS $options $binary_file" "" "/dev/null" "readelf.out"]
92 if { [lindex $got
0] != 0 ||
![string match
"" [lindex $got 1]] } then {
93 fail
"$testname (reason: unexpected output)"
99 if { [is_elf_unused_section_symbols
] } {
100 set target_machine unused
102 set target_machine
""
104 if [istarget
"mips*-*-*"] then {
105 if [is_bad_symtab
] then {
106 set target_machine mips
108 set target_machine tmips
112 if { $target_machine
!= "" && [file exists $srcdir/$subdir/$regexp_file-$readelf_size-$target_machine] } then {
113 set regexp_file $regexp_file
-$readelf_size
-$target_machine
114 } elseif
{ $target_machine
!= "" && [file exists $srcdir/$subdir/$regexp_file-$target_machine] } then {
115 set regexp_file $regexp_file
-$target_machine
116 } elseif
{ [file
exists $srcdir
/$subdir
/$regexp_file
-$readelf_size
] } then {
117 set regexp_file $regexp_file
-$readelf_size
120 if { [regexp_diff readelf.out $srcdir
/$subdir
/$regexp_file
] } then {
121 send_log
[file_contents readelf.out
]
130 # Simple proc to skip certain expected warning messages.
132 proc prune_readelf_wi_warnings
{ text } {
133 regsub
-all
"(^|\n)(.*Skipping unexpected symbol type.*)" $text "\\1" text
137 # Testing the
"readelf -wi" option is difficult because there
138 # is no guaranteed order to the output
, and because some ports
139 # will use indirect string references
, whilst others will use
140 # direct references. So instead of having an expected output
141 # file
, like the other readelf tests
, we grep
for strings that
142 # really ought to be there.
144 proc readelf_wi_test
{} {
150 #
Compile the second test file.
151 if { [target_compile $srcdir
/$subdir
/testprog.c tmpdir
/testprog.o object debug
] != "" } {
152 verbose
"Unable to compile test file."
153 untested
"readelf -wi"
158 set tempfile
[remote_download host tmpdir
/testprog.o
]
160 # Run
"readelf -wi" on it.
161 set got
[remote_exec host
"$READELF $READELFFLAGS -wi $tempfile" "" "/dev/null" "readelf.out"]
163 # Upload the results.
164 set output
[remote_upload host readelf.out
]
166 file_on_host
delete $tempfile
168 #
Strip any superflous warnings.
169 set got
[prune_readelf_wi_warnings
[lindex $got
1]]
171 if ![string match
"" $got] then {
172 fail
"readelf $READELFFLAGS -wi (reason: unexpected output)"
178 if ![file size $output
] then {
179 #
If the output file is empty
, then this target does not
180 # generate dwarf2 output. This is not a failure.
181 verbose
"No output from 'readelf -wi'"
182 untested
"readelf -wi"
186 # Search
for strings that should be in the output.
188 ".*DW_TAG_compile_unit.*"
189 ".*DW_TAG_subprogram.*"
190 ".*DW_TAG_base_type.*"
191 ".*DW_AT_producer.*(GNU C|indirect string|indexed string).*"
192 ".*DW_AT_language.*(ANSI C|C11).*"
193 ".*DW_AT_name.*(testprog.c|indirect string|indexed string).*"
195 ".*DW_AT_name.*(main|indirect string|indexed string).*"
196 ".*(DW_OP_addr: 0|DW_OP_addrx <0>).*"
197 ".*DW_AT_name.*(main|indirect string).*"
200 # The MSP430 in LARGE
mode does not generate a DW_OP_addr.
201 setup_xfail msp430
*-*-*
203 foreach looked_for $sought
{
204 set lines
[grep $output $looked_for
]
205 if ![llength $lines
] then {
206 fail
"readelf -wi: missing: $looked_for"
212 file_on_host
delete $output
218 # This tests
"readelf -wa", but on a file with a compressed
219 # .debug_abbrev section.
221 proc readelf_compressed_wa_test
{} {
227 #
Compile the compressed
-debug
-section test file.
228 if { [target_compile $srcdir
/$subdir
/dw2
-compressed.S tmpdir
/dw2
-compressed.o object debug
] != "" } {
229 verbose
"Unable to compile test file."
230 untested
"readelf -wa (compressed)"
235 set tempfile
[remote_download host tmpdir
/dw2
-compressed.o
]
237 # Run
"readelf -wa" on it.
238 set got
[remote_exec host
"$READELF $READELFFLAGS -wa $tempfile" "" "/dev/null" "readelf.out"]
240 # Upload the results.
241 set output
[remote_upload host readelf.out
]
243 file_on_host
delete $tempfile
245 if { [string compare
[file_contents readelf.out
] [file_contents $srcdir
/$subdir
/readelf.wa
]] != 0 } then {
246 fail
"readelf -wa (compressed)"
247 verbose
"output is \n[file_contents readelf.out]" 2
248 verbose
"expected is \n[file_contents $srcdir/$subdir/readelf.wa]" 2
252 pass
"readelf -wa (compressed)"
255 # Test readelf
's dumping abilities.
257 proc readelf_dump_test {} {
263 # Assemble the dump test file.
264 if {![binutils_assemble $srcdir/$subdir/dumptest.s tmpdir/dumptest.o]} then {
265 unsupported "readelf -p: failed to assemble dump test file"
269 set tempfile [remote_download host tmpdir/dumptest.o]
271 # Run "readelf -p.data" on it.
272 set sect_names [get_standard_section_names]
273 if { $sect_names != "" } {
274 set got [remote_exec host "$READELF $READELFFLAGS -p[lindex $sect_names 1] $tempfile" "" "/dev/null" "readelf.out"]
276 set got [remote_exec host "$READELF $READELFFLAGS -p.data $tempfile" "" "/dev/null" "readelf.out"]
278 set got [lindex $got 1]
280 # Upload the results.
281 set output [remote_upload host readelf.out]
283 # Check for something going wrong.
284 if ![string match "" $got] then {
285 fail "readelf -p: unexpected output"
291 # Search for strings that should be in the output.
296 foreach looked_for $sought {
297 set lines [grep $output $looked_for]
298 if ![llength $lines] then {
299 fail "readelf -p: missing: $looked_for"
305 file_on_host delete $tempfile
306 file_on_host delete $output
311 # XXX FIXME: Add test of readelf -x here
314 # Tests whether readelf can read thin archives
315 proc readelf_thin_archive_test {} {
318 if ![is_remote host] {
319 set tempfile tmpdir/bintest.o
320 set templib tmpdir/bintest.thin.a
321 set libname tmpdir/bintest.thin.a
323 set tempfile [remote_download host tmpdir/bintest.o]
324 set templib [remote_download host tmpdir/bintest.thin.a]
325 set libname bintest.thin.a
328 set testname "readelf -h bintest.thin"
329 set got [binutils_run $AR "rcT $libname ${tempfile}"]
330 if ![string match "" $got] {
335 readelf_test -h $templib readelf.h.thin
340 if ![is_remote host] {
341 if {[which $READELF] == 0} then {
342 perror "$READELF does not exist"
347 send_user "Version [binutil_version $READELF]"
349 # Assemble the test file.
350 if {![binutils_assemble $srcdir/$subdir/bintest.s tmpdir/bintest.o]} then {
351 unsupported "readelf -h bintest (failed to assemble)"
352 unsupported "readelf -S bintest (failed to assemble)"
353 unsupported "readelf -s bintest (failed to assemble)"
354 unsupported "readelf -r bintest (failed to assemble)"
359 if ![is_remote host] {
360 set tempfile tmpdir/bintest.o
362 set tempfile [remote_download host tmpdir/bintest.o]
365 # First, determine the size, so specific output matchers can be used.
366 readelf_find_size $tempfile 1
369 readelf_test -h $tempfile readelf.h
370 readelf_test -S $tempfile readelf.s
371 setup_xfail "mips-*-*irix*"
372 readelf_test -s $tempfile readelf.ss
373 readelf_test -r $tempfile readelf.r
375 readelf_thin_archive_test
378 # Test demangling symbol names.
379 if {![binutils_assemble $srcdir/$subdir/mangled.s tmpdir/mangled.o]} then {
380 unsupported "readelf -s -C bintest (failed to assemble)"
383 if ![is_remote host] {
384 set tempfile tmpdir/mangled.o
386 set tempfile [remote_download host tmpdir/mangled.o]
390 readelf_test {--syms --demangle --wide} $tempfile readelf.demangled
394 readelf_compressed_wa_test
398 # These dump tests require an assembler.
399 if {[which $AS] != 0} then {
400 run_dump_test "pr25543"
401 run_dump_test "retain1a"
402 run_dump_test "retain1b"
403 run_dump_test "readelf-maskos-1a"
404 run_dump_test "readelf-maskos-1b"
405 if {![istarget *-*-hpux*]} then {
406 run_dump_test pr26548
407 if {![binutils_assemble_flags $srcdir/$subdir/pr26548.s tmpdir/pr26548e.o {--defsym ERROR=1}]} then {
408 unsupported "pr26548e (failed to assemble)"
410 if ![is_remote host] {
411 set tempfile tmpdir/pr26548e.o
413 set tempfile [remote_download host tmpdir/pr26548e.o]
415 readelf_test -Wwi $tempfile pr26548e.d
420 # PR 13482 - Check for off-by-one errors when dumping .note sections.
421 if {![binutils_assemble $srcdir/$subdir/version.s tmpdir/version.o]} then {
422 unsupported "readelf -n version (failed to assemble)"
425 if ![is_remote host] {
426 set tempfile tmpdir/version.o
428 set tempfile [remote_download host tmpdir/version.o]
431 readelf_test -n $tempfile readelf.n
435 # PR 18374 - Check that relocations against the .debug_loc section
436 # do not prevent readelf from displaying all the location lists.
437 if {![binutils_assemble $srcdir/$subdir/pr18374.s tmpdir/pr18374.o]} then {
438 unsupported "readelf --debug-dump=loc pr18374 (failed to assemble)"
441 if ![is_remote host] {
442 set tempfile tmpdir/pr18374.o
444 set tempfile [remote_download host tmpdir/pr18374.o]
447 readelf_test --debug-dump=loc $tempfile readelf.pr18374
451 # locview - Check dumping of location lists with location views.
452 if {![binutils_assemble $srcdir/$subdir/locview-1.s tmpdir/locview-1.o]} then {
453 unsupported "readelf --debug-dump=loc locview-1 (failed to assemble)"
456 if ![is_remote host] {
457 set tempfile tmpdir/locview-1.o
459 set tempfile [remote_download host tmpdir/locview-1.o]
462 readelf_test --debug-dump=loc $tempfile readelf.locview-1
464 if {![binutils_assemble $srcdir/$subdir/locview-2.s tmpdir/locview-2.o]} then {
465 unsupported "readelf --debug-dump=loc locview-2 (failed to assemble)"
468 if ![is_remote host] {
469 set tempfile tmpdir/locview-2.o
471 set tempfile [remote_download host tmpdir/locview-2.o]
474 readelf_test --debug-dump=loc $tempfile readelf.locview-2
478 # Check that decompressed dumps work.
479 if {![binutils_assemble $srcdir/$subdir/z.s tmpdir/z.o]} then {
480 unsupported "readelf --decompress --hex-dump .debug_loc z (failed to assemble)"
483 if ![is_remote host] {
484 set tempfile tmpdir/z.o
486 set tempfile [remote_download host tmpdir/z.o]
489 readelf_test {--decompress --hex-dump .debug_loc} $tempfile readelf.z
494 # Skip the next test for the RISCV architectures because they
495 # do not support .ULEB128 pseudo-ops with non-constant values.
496 if ![istarget "riscv*-*-*"] then {
498 if [istarget "hppa*64*-*-hpux*"] {
499 set flags "--defsym HPUX=1"
502 # LoongArch relax align add nops, so label subtractions will increase
503 if [istarget "loongarch*-*-*"] {
504 set flags "-mno-relax"
507 # Assemble the DWARF-5 test file.
508 if {![binutils_assemble_flags $srcdir/$subdir/dw5.S tmpdir/dw5.o $flags]} then {
509 unsupported "readelf -wiaoRlL dw5 (failed to assemble)"
513 if ![is_remote host] {
514 set tempfile tmpdir/dw5.o
516 set tempfile [remote_download host tmpdir/dw5.o]
519 # First, determine the size, so specific output matchers can be used.
520 readelf_find_size $tempfile 2
522 # Make sure that readelf can decode the contents.
523 readelf_test -wiaoRlL $tempfile dw5.W
527 # Assemble the DWARF-5 attributes test file.
528 if {![binutils_assemble_flags $srcdir/$subdir/dwarf-attributes.S tmpdir/dwarf-attributes.o ""]} then {
529 unsupported "readelf -wi dwarf-attributes (failed to assemble)"
532 if ![is_remote host] {
533 set tempfile tmpdir/dwarf-attributes.o
535 set tempfile [remote_download host tmpdir/dwarf-attributes.o]
538 # First, determine the size, so specific output matchers can be used.
539 readelf_find_size $tempfile 3
541 # Make sure that readelf can decode the contents.
542 readelf_test -wi $tempfile dwarf-attributes.W
545 # Check that debug link sections can be dumped.
546 if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
547 unsupported "readelf --debug-dump=links (failed to assemble debuglink.s)"
549 if ![is_remote host] {
550 set tempfile tmpdir/debuglink.o
552 set tempfile [remote_download host tmpdir/debuglink.o]
555 readelf_test {--debug-dump=links -wN} $tempfile readelf.k
557 # Check that debug link sections can be followed.
558 if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
559 unsupported "readelf --debug-dump=follow-links (failed to assemble linkdebug.s)"
561 if [is_remote host] {
562 set tempfile2 [remote_download host tmpdir/linkdebug.debug]
565 readelf_test "-wKis -P" $tempfile readelf.wKis
569 if {![binutils_assemble $srcdir/$subdir/dwo.s tmpdir/dwo.o]} then {
570 unsupported "readelf --debug-dump=links (failed to assemble dwo.s)"
572 if ![is_remote host] {
573 set tempfile tmpdir/dwo.o
575 set tempfile [remote_download host tmpdir/dwo.o]
578 readelf_test {--debug-dump=links --debug-dump=no-follow-links} $tempfile readelf.k2
581 if {![binutils_assemble $srcdir/$subdir/zero-sec.s tmpdir/zero-sec.o]} then {
582 unsupported "readelf --enable-checks (failed to assemble zero-sec.s)"
584 if ![is_remote host] {
585 set tempfile tmpdir/zero-sec.o
587 set tempfile [remote_download host tmpdir/zero-sec.o]
590 readelf_test {--enable-checks --sections --wide} $tempfile zero-sec.r
593 if ![is_remote host] {
594 set test $srcdir/$subdir/pr26112.o.bz2
595 # We need to strip the ".bz2", but can leave the dirname.
596 set t $subdir/[file tail $test]
597 set testname [file rootname $t]
599 set tempfile tmpdir/pr26112.o
600 if {[catch "system \"bzip2 -dc $test > $tempfile\""] != 0} {
601 untested "bzip2 -dc ($testname)"
603 readelf_test {--debug-dump=macro -wN} $tempfile pr26112.r
606 set test $srcdir/$subdir/pr26160.dwp.bz2
607 # We need to strip the ".bz2", but can leave the dirname.
608 set t $subdir/[file tail $test]
609 set testname [file rootname $t]
611 set tempfile tmpdir/pr26160.dwp
612 if {[catch "system \"bzip2 -dc $test > $tempfile\""] != 0} {
613 untested "bzip2 -dc ($testname)"
615 readelf_test {-wi} $tempfile pr26160.r
619 # Check dwarf-5 support for DW_OP_addrx.
620 if {![binutils_assemble_flags $srcdir/$subdir/dw5-op.S tmpdir/dw5-op.o $flags]} then {
621 unsupported "readelf -wi dw5-op (failed to assemble)"
625 if ![is_remote host] {
626 set tempfile tmpdir/dw5-op.o
628 set tempfile [remote_download host tmpdir/dw5-op.o]
631 # First, determine the size, so specific output matchers can be used.
632 readelf_find_size $tempfile 2
634 # Make sure that readelf can decode the contents.
635 readelf_test -wi $tempfile dw5-op.W
638 # Test the -j/--display-section option.
639 # Check that multiple options accumulate.
640 # Check that both numbers and names can be used.
641 readelf_test {-j .rela.debug_info --display-section=.rel.debug_info} $tempfile display-section.r
642 readelf_test --display-section=0 $tempfile display-section.0
645 # Test that RELR relocations are display correctly.
646 proc readelf_relr_test {} {
652 set testname "readelf -r (RELR)"
654 # Assemble the RELR test file (using magic to work for both 32-bit and
656 if {![binutils_assemble $srcdir/$subdir/relr.s tmpdir/relr.o]} then {
657 unsupported "$testname: failed to assemble RELR test file"
662 set tempfile [remote_download host tmpdir/relr.o]
664 # Run "readelf -r" on it.
665 set got [remote_exec host "$READELF $READELFFLAGS -r $tempfile" "" "/dev/null" "readelf.out"]
666 set got [lindex $got 1]
668 # Upload the results.
669 set output [remote_upload host readelf.out]
671 # Check for something going wrong.
672 if ![string match "" $got] then {
673 fail "$testname: unexpected output"
679 # Search for strings that should be in the output.
680 # There will also be these strings:
681 # readelf: Error: Section 4 has invalid sh_entsize of 0
682 # readelf: Error: (Using the expected size of 8 for the rest of this dump)
683 # But we ignore them...
686 "0000: 0+01000 0+01000 .*"
687 "0001: 0+00003 0+0100. .*"
690 foreach looked_for $sought {
691 set lines [grep $output $looked_for]
692 if ![llength $lines] then {
693 fail "$testname: missing: $looked_for"
699 file_on_host delete $tempfile
700 file_on_host delete $output
706 # The AVR, H8300, IP2K and Z80 targets' .dc.a pseudo
-op creates a
707 #
16-bit entry rather than a
32-bit entry. Thus creating an
708 # invalid RELR relocation.
709 setup_xfail
"avr-*-*" "h8300-*-*" "ip2k-*-*" "z80-*-*"