1 # Copyright (C) 1999-2020 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 xfails } {
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 foreach xfail $xfails {
96 if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
97 fail "$testname (reason: unexpected output)"
103 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 {
122 verbose "output is \n[file_contents readelf.out]" 2
129 # Simple proc to skip certain expected warning messages.
131 proc prune_readelf_wi_warnings { text } {
132 regsub -all "(^|\n)(.*Skipping unexpected symbol type.*)" $text "\\1" text
136 # Testing the "readelf -wi" option is difficult because there
137 # is no guaranteed order to the output, and because some ports
138 # will use indirect string references, whilst others will use
139 # direct references. So instead of having an expected output
140 # file, like the other readelf tests, we grep for strings that
141 # really ought to be there.
143 proc readelf_wi_test {} {
149 # Compile the second test file.
150 if { [target_compile $srcdir/$subdir/testprog.c tmpdir/testprog.o object debug] != "" } {
151 verbose "Unable to compile test file."
152 untested "readelf -wi"
157 set tempfile [remote_download host tmpdir/testprog.o]
159 # Run "readelf -wi" on it.
160 set got [remote_exec host "$READELF $READELFFLAGS -wi $tempfile" "" "/dev/null" "readelf.out"]
162 # Upload the results.
163 set output [remote_upload host readelf.out]
165 file_on_host delete $tempfile
167 # Strip any superflous warnings.
168 set got [prune_readelf_wi_warnings [lindex $got 1]]
170 if ![string match "" $got] then {
171 fail "readelf $READELFFLAGS -wi (reason: unexpected output)"
177 if ![file size $output] then {
178 # If the output file is empty, then this target does not
179 # generate dwarf2 output. This is not a failure.
180 verbose "No output from 'readelf -wi'"
181 untested "readelf -wi"
185 # Search for strings that should be in the output.
187 ".*DW_TAG_compile_unit.*"
188 ".*DW_TAG_subprogram.*"
189 ".*DW_TAG_base_type.*"
190 ".*DW_AT_producer.*(GNU C|indirect string).*"
191 ".*DW_AT_language.*ANSI C.*"
192 ".*DW_AT_name.*(testprog.c|indirect string).*"
194 ".*DW_AT_name.*(main|indirect string).*"
195 ".*\(DW_OP_addr: 0\).*"
198 # The MSP430 in LARGE mode does not generate a DW_OP_addr.
199 setup_xfail msp430*-*-*
201 foreach looked_for $sought {
202 set lines [grep $output $looked_for]
203 if ![llength $lines] then {
204 fail "readelf -wi: missing: $looked_for"
210 file_on_host delete $output
216 # This tests "readelf -wa", but on a file with a compressed
217 # .debug_abbrev section.
219 proc readelf_compressed_wa_test {} {
225 # Compile the compressed-debug-section test file.
226 if { [target_compile $srcdir/$subdir/dw2-compressed.S tmpdir/dw2-compressed.o object debug] != "" } {
227 verbose "Unable to compile test file."
228 untested "readelf -wa (compressed)"
233 set tempfile [remote_download host tmpdir/dw2-compressed.o]
235 # Run "readelf -wa" on it.
236 set got [remote_exec host "$READELF $READELFFLAGS -wa $tempfile" "" "/dev/null" "readelf.out"]
238 # Upload the results.
239 set output [remote_upload host readelf.out]
241 file_on_host delete $tempfile
243 if { [string compare [file_contents readelf.out] [file_contents $srcdir/$subdir/readelf.wa]] != 0 } then {
244 fail "readelf -wa (compressed)"
245 verbose "output is \n[file_contents readelf.out]" 2
246 verbose "expected is \n[file_contents $srcdir/$subdir/readelf.wa]" 2
250 pass "readelf -wa (compressed)"
253 # Test readelf's dumping abilities.
255 proc readelf_dump_test {} {
261 # Assemble the dump test file.
262 if {![binutils_assemble $srcdir/$subdir/dumptest.s tmpdir/dumptest.o]} then {
263 unresolved "readelf -p: failed to assemble dump test file"
267 set tempfile [remote_download host tmpdir/dumptest.o]
269 # Run "readelf -p.data" on it.
270 set sect_names [get_standard_section_names]
271 if { $sect_names != "" } {
272 set got [remote_exec host "$READELF $READELFFLAGS -p[lindex $sect_names 1] $tempfile" "" "/dev/null" "readelf.out"]
274 set got [remote_exec host "$READELF $READELFFLAGS -p.data $tempfile" "" "/dev/null" "readelf.out"]
276 set got [lindex $got 1]
278 # Upload the results.
279 set output [remote_upload host readelf.out]
281 # Check for something going wrong.
282 if ![string match "" $got] then {
283 fail "readelf -p: unexpected output"
289 # Search for strings that should be in the output.
294 foreach looked_for $sought {
295 set lines [grep $output $looked_for]
296 if ![llength $lines] then {
297 fail "readelf -p: missing: $looked_for"
303 file_on_host delete $tempfile
304 file_on_host delete $output
309 # XXX FIXME: Add test of readelf -x here
312 if ![is_remote host] {
313 if {[which $READELF] == 0} then {
314 perror "$READELF does not exist"
319 send_user "Version [binutil_version $READELF]"
321 # Assemble the test file.
322 if {![binutils_assemble $srcdir/$subdir/bintest.s tmpdir/bintest.o]} then {
323 unresolved "readelf -h bintest (failed to assemble)"
324 unresolved "readelf -S bintest (failed to assemble)"
325 unresolved "readelf -s bintest (failed to assemble)"
326 unresolved "readelf -r bintest (failed to assemble)"
331 if ![is_remote host] {
332 set tempfile tmpdir/bintest.o
334 set tempfile [remote_download host tmpdir/bintest.o]
337 # First, determine the size, so specific output matchers can be used.
338 readelf_find_size $tempfile 1
341 readelf_test -h $tempfile readelf.h {}
342 readelf_test -S $tempfile readelf.s {}
343 setup_xfail "mips-*-*irix*"
344 readelf_test -s $tempfile readelf.ss {}
345 readelf_test -r $tempfile readelf.r {}
349 readelf_compressed_wa_test
352 run_dump_test "pr25543"
354 # PR 13482 - Check for off-by-one errors when dumping .note sections.
355 if {![binutils_assemble $srcdir/$subdir/version.s tmpdir/version.o]} then {
356 unresolved "readelf -n version (failed to assemble)"
359 if ![is_remote host] {
360 set tempfile tmpdir/version.o
362 set tempfile [remote_download host tmpdir/version.o]
365 readelf_test -n $tempfile readelf.n {}
369 # PR 18374 - Check that relocations against the .debug_loc section
370 # do not prevent readelf from displaying all the location lists.
371 if {![binutils_assemble $srcdir/$subdir/pr18374.s tmpdir/pr18374.o]} then {
372 unresolved "readelf --debug-dump=loc pr18374 (failed to assemble)"
375 if ![is_remote host] {
376 set tempfile tmpdir/pr18374.o
378 set tempfile [remote_download host tmpdir/pr18374.o]
381 readelf_test --debug-dump=loc $tempfile readelf.pr18374 {}
385 # locview - Check dumping of location lists with location views.
386 if {![binutils_assemble $srcdir/$subdir/locview-1.s tmpdir/locview-1.o]} then {
387 unresolved "readelf --debug-dump=loc locview-1 (failed to assemble)"
390 if ![is_remote host] {
391 set tempfile tmpdir/locview-1.o
393 set tempfile [remote_download host tmpdir/locview-1.o]
396 readelf_test --debug-dump=loc $tempfile readelf.locview-1 {}
398 if {![binutils_assemble $srcdir/$subdir/locview-2.s tmpdir/locview-2.o]} then {
399 unresolved "readelf --debug-dump=loc locview-2 (failed to assemble)"
402 if ![is_remote host] {
403 set tempfile tmpdir/locview-2.o
405 set tempfile [remote_download host tmpdir/locview-2.o]
408 readelf_test --debug-dump=loc $tempfile readelf.locview-2 {}
412 # Check that decompressed dumps work.
413 if {![binutils_assemble $srcdir/$subdir/z.s tmpdir/z.o]} then {
414 unresolved "readelf --decompress --hex-dump .debug_loc z (failed to assemble)"
417 if ![is_remote host] {
418 set tempfile tmpdir/z.o
420 set tempfile [remote_download host tmpdir/z.o]
423 readelf_test {--decompress --hex-dump .debug_loc} $tempfile readelf.z {}
426 # Skip the next test for the RISCV architectures because they
427 # do not support .ULEB128 pseudo-ops with non-constant values.
428 if ![istarget "riscv*-*-*"] then {
431 if [istarget "hppa*64*-*-hpux*"] {
432 set hpux "--defsym HPUX=1"
435 # Assemble the DWARF-5 test file.
436 if {![binutils_assemble_flags $srcdir/$subdir/dw5.S tmpdir/dw5.o $hpux]} then {
437 unresolved "readelf -wiaoRlL dw5 (failed to assemble)"
441 if ![is_remote host] {
442 set tempfile tmpdir/dw5.o
444 set tempfile [remote_download host tmpdir/dw5.o]
447 # First, determine the size, so specific output matchers can be used.
448 readelf_find_size $tempfile 2
450 # Make sure that readelf can decode the contents.
451 readelf_test -wiaoRlL $tempfile dw5.W { nds32*-elf }
455 # Assemble the DWARF-5 attributes test file.
456 if {![binutils_assemble_flags $srcdir/$subdir/dwarf-attributes.S tmpdir/dwarf-attributes.o ""]} then {
457 unresolved "readelf -wi dwarf-attributes (failed to assemble)"
460 if ![is_remote host] {
461 set tempfile tmpdir/dwarf-attributes.o
463 set tempfile [remote_download host tmpdir/dwarf-attributes.o]
466 # First, determine the size, so specific output matchers can be used.
467 readelf_find_size $tempfile 3
469 # Make sure that readelf can decode the contents.
470 readelf_test -wi $tempfile dwarf-attributes.W {}
473 # Check that debug link sections can be dumped.
474 if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
475 unresolved "readelf --debug-dump=links (failed to assemble debuglink.s)"
477 if ![is_remote host] {
478 set tempfile tmpdir/debuglink.o
480 set tempfile [remote_download host tmpdir/debuglink.o]
483 readelf_test {--debug-dump=links} $tempfile readelf.k {}
485 # Check that debug link sections can be followed.
486 if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
487 unresolved "readelf --debug-dump=follow-links (failed to assemble linkdebug.s)"
489 if [is_remote host] {
490 set tempfile2 [remote_download host tmpdir/linkdebug.debug]
493 readelf_test {-wKis} $tempfile readelf.wKis {}
497 if {![binutils_assemble $srcdir/$subdir/dwo.s tmpdir/dwo.o]} then {
498 unresolved "readelf --debug-dump=links (failed to assemble dwo.s)"
500 if ![is_remote host] {
501 set tempfile tmpdir/dwo.o
503 set tempfile [remote_download host tmpdir/dwo.o]
506 readelf_test {--debug-dump=links} $tempfile readelf.k2 {}