1 # Copyright (C) 1999-2022 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).*"
192 ".*DW_AT_language.*(ANSI C|C11).*"
193 ".*DW_AT_name.*(testprog.c|indirect string).*"
195 ".*DW_AT_name.*(main|indirect string).*"
196 ".*\(DW_OP_addr: 0\).*"
199 # The MSP430 in LARGE mode does not generate a DW_OP_addr.
200 setup_xfail msp430*-*-*
202 foreach looked_for $sought {
203 set lines [grep $output $looked_for]
204 if ![llength $lines] then {
205 fail "readelf -wi: missing: $looked_for"
211 file_on_host delete $output
217 # This tests "readelf -wa", but on a file with a compressed
218 # .debug_abbrev section.
220 proc readelf_compressed_wa_test {} {
226 # Compile the compressed-debug-section test file.
227 if { [target_compile $srcdir/$subdir/dw2-compressed.S tmpdir/dw2-compressed.o object debug] != "" } {
228 verbose "Unable to compile test file."
229 untested "readelf -wa (compressed)"
234 set tempfile [remote_download host tmpdir/dw2-compressed.o]
236 # Run "readelf -wa" on it.
237 set got [remote_exec host "$READELF $READELFFLAGS -wa $tempfile" "" "/dev/null" "readelf.out"]
239 # Upload the results.
240 set output [remote_upload host readelf.out]
242 file_on_host delete $tempfile
244 if { [string compare [file_contents readelf.out] [file_contents $srcdir/$subdir/readelf.wa]] != 0 } then {
245 fail "readelf -wa (compressed)"
246 verbose "output is \n[file_contents readelf.out]" 2
247 verbose "expected is \n[file_contents $srcdir/$subdir/readelf.wa]" 2
251 pass "readelf -wa (compressed)"
254 # Test readelf's dumping abilities.
256 proc readelf_dump_test {} {
262 # Assemble the dump test file.
263 if {![binutils_assemble $srcdir/$subdir/dumptest.s tmpdir/dumptest.o]} then {
264 unsupported "readelf -p: failed to assemble dump test file"
268 set tempfile [remote_download host tmpdir/dumptest.o]
270 # Run "readelf -p.data" on it.
271 set sect_names [get_standard_section_names]
272 if { $sect_names != "" } {
273 set got [remote_exec host "$READELF $READELFFLAGS -p[lindex $sect_names 1] $tempfile" "" "/dev/null" "readelf.out"]
275 set got [remote_exec host "$READELF $READELFFLAGS -p.data $tempfile" "" "/dev/null" "readelf.out"]
277 set got [lindex $got 1]
279 # Upload the results.
280 set output [remote_upload host readelf.out]
282 # Check for something going wrong.
283 if ![string match "" $got] then {
284 fail "readelf -p: unexpected output"
290 # Search for strings that should be in the output.
295 foreach looked_for $sought {
296 set lines [grep $output $looked_for]
297 if ![llength $lines] then {
298 fail "readelf -p: missing: $looked_for"
304 file_on_host delete $tempfile
305 file_on_host delete $output
310 # XXX FIXME: Add test of readelf -x here
313 # Tests whether readelf can read thin archives
314 proc readelf_thin_archive_test {} {
317 if ![is_remote host] {
318 set tempfile tmpdir/bintest.o
319 set templib tmpdir/bintest.thin.a
320 set libname tmpdir/bintest.thin.a
322 set tempfile [remote_download host tmpdir/bintest.o]
323 set templib [remote_download host tmpdir/bintest.thin.a]
324 set libname bintest.thin.a
327 set testname "readelf -h bintest.thin"
328 set got [binutils_run $AR "rcT $libname ${tempfile}"]
329 if ![string match "" $got] {
334 readelf_test -h $templib readelf.h.thin
339 if ![is_remote host] {
340 if {[which $READELF] == 0} then {
341 perror "$READELF does not exist"
346 send_user "Version [binutil_version $READELF]"
348 # Assemble the test file.
349 if {![binutils_assemble $srcdir/$subdir/bintest.s tmpdir/bintest.o]} then {
350 unsupported "readelf -h bintest (failed to assemble)"
351 unsupported "readelf -S bintest (failed to assemble)"
352 unsupported "readelf -s bintest (failed to assemble)"
353 unsupported "readelf -r bintest (failed to assemble)"
358 if ![is_remote host] {
359 set tempfile tmpdir/bintest.o
361 set tempfile [remote_download host tmpdir/bintest.o]
364 # First, determine the size, so specific output matchers can be used.
365 readelf_find_size $tempfile 1
368 readelf_test -h $tempfile readelf.h
369 readelf_test -S $tempfile readelf.s
370 setup_xfail "mips-*-*irix*"
371 readelf_test -s $tempfile readelf.ss
372 readelf_test -r $tempfile readelf.r
374 readelf_thin_archive_test
377 # Test demangling symbol names.
378 if {![binutils_assemble $srcdir/$subdir/mangled.s tmpdir/mangled.o]} then {
379 unsupported "readelf -s -C bintest (failed to assemble)"
382 if ![is_remote host] {
383 set tempfile tmpdir/mangled.o
385 set tempfile [remote_download host tmpdir/mangled.o]
389 readelf_test {--syms --demangle --wide} $tempfile readelf.demangled
393 readelf_compressed_wa_test
397 # These dump tests require an assembler.
398 if {[which $AS] != 0} then {
399 run_dump_test "pr25543"
400 run_dump_test "retain1a"
401 run_dump_test "retain1b"
402 run_dump_test "readelf-maskos-1a"
403 run_dump_test "readelf-maskos-1b"
404 if {![istarget *-*-hpux*]} then {
405 run_dump_test pr26548
406 if {![binutils_assemble_flags $srcdir/$subdir/pr26548.s tmpdir/pr26548e.o {--defsym ERROR=1}]} then {
407 unsupported "pr26548e (failed to assemble)"
409 if ![is_remote host] {
410 set tempfile tmpdir/pr26548e.o
412 set tempfile [remote_download host tmpdir/pr26548e.o]
414 readelf_test -Wwi $tempfile pr26548e.d
419 # PR 13482 - Check for off-by-one errors when dumping .note sections.
420 if {![binutils_assemble $srcdir/$subdir/version.s tmpdir/version.o]} then {
421 unsupported "readelf -n version (failed to assemble)"
424 if ![is_remote host] {
425 set tempfile tmpdir/version.o
427 set tempfile [remote_download host tmpdir/version.o]
430 readelf_test -n $tempfile readelf.n
434 # PR 18374 - Check that relocations against the .debug_loc section
435 # do not prevent readelf from displaying all the location lists.
436 if {![binutils_assemble $srcdir/$subdir/pr18374.s tmpdir/pr18374.o]} then {
437 unsupported "readelf --debug-dump=loc pr18374 (failed to assemble)"
440 if ![is_remote host] {
441 set tempfile tmpdir/pr18374.o
443 set tempfile [remote_download host tmpdir/pr18374.o]
446 readelf_test --debug-dump=loc $tempfile readelf.pr18374
450 # locview - Check dumping of location lists with location views.
451 if {![binutils_assemble $srcdir/$subdir/locview-1.s tmpdir/locview-1.o]} then {
452 unsupported "readelf --debug-dump=loc locview-1 (failed to assemble)"
455 if ![is_remote host] {
456 set tempfile tmpdir/locview-1.o
458 set tempfile [remote_download host tmpdir/locview-1.o]
461 readelf_test --debug-dump=loc $tempfile readelf.locview-1
463 if {![binutils_assemble $srcdir/$subdir/locview-2.s tmpdir/locview-2.o]} then {
464 unsupported "readelf --debug-dump=loc locview-2 (failed to assemble)"
467 if ![is_remote host] {
468 set tempfile tmpdir/locview-2.o
470 set tempfile [remote_download host tmpdir/locview-2.o]
473 readelf_test --debug-dump=loc $tempfile readelf.locview-2
477 # Check that decompressed dumps work.
478 if {![binutils_assemble $srcdir/$subdir/z.s tmpdir/z.o]} then {
479 unsupported "readelf --decompress --hex-dump .debug_loc z (failed to assemble)"
482 if ![is_remote host] {
483 set tempfile tmpdir/z.o
485 set tempfile [remote_download host tmpdir/z.o]
488 readelf_test {--decompress --hex-dump .debug_loc} $tempfile readelf.z
491 # Skip the next test for the RISCV architectures because they
492 # do not support .ULEB128 pseudo-ops with non-constant values.
493 if ![istarget "riscv*-*-*"] then {
496 if [istarget "hppa*64*-*-hpux*"] {
497 set hpux "--defsym HPUX=1"
500 # Assemble the DWARF-5 test file.
501 if {![binutils_assemble_flags $srcdir/$subdir/dw5.S tmpdir/dw5.o $hpux]} then {
502 unsupported "readelf -wiaoRlL dw5 (failed to assemble)"
506 if ![is_remote host] {
507 set tempfile tmpdir/dw5.o
509 set tempfile [remote_download host tmpdir/dw5.o]
512 # First, determine the size, so specific output matchers can be used.
513 readelf_find_size $tempfile 2
515 # Make sure that readelf can decode the contents.
516 readelf_test -wiaoRlL $tempfile dw5.W
520 # Assemble the DWARF-5 attributes test file.
521 if {![binutils_assemble_flags $srcdir/$subdir/dwarf-attributes.S tmpdir/dwarf-attributes.o ""]} then {
522 unsupported "readelf -wi dwarf-attributes (failed to assemble)"
525 if ![is_remote host] {
526 set tempfile tmpdir/dwarf-attributes.o
528 set tempfile [remote_download host tmpdir/dwarf-attributes.o]
531 # First, determine the size, so specific output matchers can be used.
532 readelf_find_size $tempfile 3
534 # Make sure that readelf can decode the contents.
535 readelf_test -wi $tempfile dwarf-attributes.W
538 # Check that debug link sections can be dumped.
539 if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
540 unsupported "readelf --debug-dump=links (failed to assemble debuglink.s)"
542 if ![is_remote host] {
543 set tempfile tmpdir/debuglink.o
545 set tempfile [remote_download host tmpdir/debuglink.o]
548 readelf_test {--debug-dump=links -wN} $tempfile readelf.k
550 # Check that debug link sections can be followed.
551 if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
552 unsupported "readelf --debug-dump=follow-links (failed to assemble linkdebug.s)"
554 if [is_remote host] {
555 set tempfile2 [remote_download host tmpdir/linkdebug.debug]
558 readelf_test "-wKis -P" $tempfile readelf.wKis
562 if {![binutils_assemble $srcdir/$subdir/dwo.s tmpdir/dwo.o]} then {
563 unsupported "readelf --debug-dump=links (failed to assemble dwo.s)"
565 if ![is_remote host] {
566 set tempfile tmpdir/dwo.o
568 set tempfile [remote_download host tmpdir/dwo.o]
571 readelf_test {--debug-dump=links --debug-dump=no-follow-links} $tempfile readelf.k2
574 if {![binutils_assemble $srcdir/$subdir/zero-sec.s tmpdir/zero-sec.o]} then {
575 unsupported "readelf --enable-checks (failed to assemble zero-sec.s)"
577 if ![is_remote host] {
578 set tempfile tmpdir/zero-sec.o
580 set tempfile [remote_download host tmpdir/zero-sec.o]
583 readelf_test {--enable-checks --sections --wide} $tempfile zero-sec.r
586 if ![is_remote host] {
587 set test $srcdir/$subdir/pr26112.o.bz2
588 # We need to strip the ".bz2", but can leave the dirname.
589 set t $subdir/[file tail $test]
590 set testname [file rootname $t]
592 set tempfile tmpdir/pr26112.o
593 if {[catch "system \"bzip2 -dc $test > $tempfile\""] != 0} {
594 untested "bzip2 -dc ($testname)"
596 readelf_test {--debug-dump=macro -wN} $tempfile pr26112.r