binutils/testsuite/binutils-all/readelf.exp

   1 #   Copyright (C) 1999-2020 Free Software Foundation, Inc.
   2
   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.
   7 #
   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.
  12 #
  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.
  16
  17 # Please email any bugs, comments, and/or additions to this file to:
  18 # bug-dejagnu@prep.ai.mit.edu
  19
  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>.
  23
  24 # Exclude non-ELF targets.
  25 if ![is_elf_format] {
  26     verbose "$READELF is only intended for ELF targets" 2
  27     return
  28 }
  29
  30 # First some helpful procedures, then the tests themselves
  31
  32 # Return the contents of the filename given
  33 proc file_contents { filename } {
  34     set file [open $filename r]
  35     set contents [read $file]
  36     close $file
  37     return $contents
  38 }
  39
  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
  42 # EI_CLASS line here.
  43 proc readelf_find_size { binary_file test_iteration } {
  44     global READELF
  45     global READELFFLAGS
  46     global readelf_size
  47
  48     set readelf_size ""
  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"
  53     }
  54
  55     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]]} then {
  56         send_log $got
  57         fail $testname
  58         return
  59     }
  60
  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]"
  65         fail $testname
  66         return
  67     } else {
  68         verbose -log "ELF size is $readelf_size"
  69     }
  70
  71     pass $testname
  72 }
  73
  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.
  78
  79 proc readelf_test { options binary_file regexp_file xfails } {
  80
  81     global READELF
  82     global READELFFLAGS
  83     global readelf_size
  84     global srcdir
  85     global subdir
  86
  87     set testname "readelf $options [file rootname [file tail $binary_file]]"
  88
  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"]
  91
  92     foreach xfail $xfails {
  93         setup_xfail $xfail
  94     }
  95
  96     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
  97         fail "$testname (reason: unexpected output)"
  98         send_log $got
  99         send_log "\n"
 100         return
 101     }
 102
 103     set target_machine ""
 104     if [istarget "mips*-*-*"] then {
 105         if [is_bad_symtab] then {
 106             set target_machine mips
 107         } else {
 108             set target_machine tmips
 109         }
 110     }
 111
 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
 118     }
 119
 120     if { [regexp_diff readelf.out $srcdir/$subdir/$regexp_file] } then {
 121         fail $testname
 122         verbose "output is \n[file_contents readelf.out]" 2
 123         return
 124     }
 125
 126     pass $testname
 127 }
 128
 129 # Simple proc to skip certain expected warning messages.
 130
 131 proc prune_readelf_wi_warnings { text } {
 132     regsub -all "(^|\n)(.*Skipping unexpected symbol type.*)" $text "\\1" text
 133     return $text
 134 }
 135
 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.
 142
 143 proc readelf_wi_test {} {
 144     global READELF
 145     global READELFFLAGS
 146     global srcdir
 147     global subdir
 148
 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"
 153         return
 154     }
 155
 156     # Download it.
 157     set tempfile [remote_download host tmpdir/testprog.o]
 158
 159     # Run "readelf -wi" on it.
 160     set got [remote_exec host "$READELF $READELFFLAGS -wi $tempfile" "" "/dev/null" "readelf.out"]
 161
 162     # Upload the results.
 163     set output [remote_upload host readelf.out]
 164
 165     file_on_host delete $tempfile
 166
 167     # Strip any superflous warnings.
 168     set got [prune_readelf_wi_warnings [lindex $got 1]]
 169
 170     if ![string match "" $got] then {
 171         fail "readelf $READELFFLAGS -wi (reason: unexpected output)"
 172         send_log $got
 173         send_log "\n"
 174         return
 175     }
 176
 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"
 182         return
 183     }
 184
 185     # Search for strings that should be in the output.
 186     set sought {
 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).*"
 193         ".*DW_AT_name.*fn.*"
 194         ".*DW_AT_name.*(main|indirect string).*"
 195         ".*\(DW_OP_addr: 0\).*"
 196     }
 197
 198     # The MSP430 in LARGE mode does not generate a DW_OP_addr.
 199     setup_xfail msp430*-*-*
 200
 201     foreach looked_for $sought {
 202         set lines [grep $output $looked_for]
 203         if ![llength $lines] then {
 204             fail "readelf -wi: missing: $looked_for"
 205             send_log readelf.out
 206             return
 207         }
 208     }
 209
 210     file_on_host delete $output
 211
 212     # All done.
 213     pass "readelf -wi"
 214 }
 215
 216 # This tests "readelf -wa", but on a file with a compressed
 217 # .debug_abbrev section.
 218
 219 proc readelf_compressed_wa_test {} {
 220     global READELF
 221     global READELFFLAGS
 222     global srcdir
 223     global subdir
 224
 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)"
 229         return
 230     }
 231
 232     # Download it.
 233     set tempfile [remote_download host tmpdir/dw2-compressed.o]
 234
 235     # Run "readelf -wa" on it.
 236     set got [remote_exec host "$READELF $READELFFLAGS -wa $tempfile" "" "/dev/null" "readelf.out"]
 237
 238     # Upload the results.
 239     set output [remote_upload host readelf.out]
 240
 241     file_on_host delete $tempfile
 242
 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
 247         return
 248     }
 249
 250     pass "readelf -wa (compressed)"
 251 }
 252
 253 # Test readelf's dumping abilities.
 254
 255 proc readelf_dump_test {} {
 256     global READELF
 257     global READELFFLAGS
 258     global srcdir
 259     global subdir
 260
 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"
 264       return
 265     }
 266     # Download it.
 267     set tempfile [remote_download host tmpdir/dumptest.o]
 268
 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"]
 273     } else {
 274         set got [remote_exec host "$READELF $READELFFLAGS -p.data $tempfile" "" "/dev/null" "readelf.out"]
 275     }
 276     set got [lindex $got 1]
 277
 278     # Upload the results.
 279     set output [remote_upload host readelf.out]
 280
 281     # Check for something going wrong.
 282     if ![string match "" $got] then {
 283         fail "readelf -p: unexpected output"
 284         send_log $got
 285         send_log "\n"
 286         return
 287     }
 288
 289     # Search for strings that should be in the output.
 290     set sought {
 291         ".*test_string.*"
 292     }
 293
 294     foreach looked_for $sought {
 295         set lines [grep $output $looked_for]
 296         if ![llength $lines] then {
 297             fail "readelf -p: missing: $looked_for"
 298             send_log readelf.out
 299             return
 300         }
 301     }
 302
 303     file_on_host delete $tempfile
 304     file_on_host delete $output
 305
 306     # All done.
 307     pass "readelf -p"
 308
 309     # XXX FIXME: Add test of readelf -x here
 310 }
 311
 312 if ![is_remote host] {
 313     if {[which $READELF] == 0} then {
 314         perror "$READELF does not exist"
 315         return
 316     }
 317 }
 318
 319 send_user "Version [binutil_version $READELF]"
 320
 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)"
 327     global readelf_size
 328     set readelf_size ""
 329 } else {
 330
 331     if ![is_remote host] {
 332         set tempfile tmpdir/bintest.o
 333     } else {
 334         set tempfile [remote_download host tmpdir/bintest.o]
 335     }
 336
 337     # First, determine the size, so specific output matchers can be used.
 338     readelf_find_size $tempfile 1
 339
 340     # Run the tests.
 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  {}
 346 }
 347
 348 # Test demangling symbol names.
 349 if {![binutils_assemble $srcdir/$subdir/mangled.s tmpdir/mangled.o]} then {
 350     unresolved "readelf -s -C bintest (failed to assemble)"
 351 } else {
 352
 353     if ![is_remote host] {
 354         set tempfile tmpdir/mangled.o
 355     } else {
 356         set tempfile [remote_download host tmpdir/mangled.o]
 357     }
 358
 359     # Run the test.
 360     readelf_test {--syms --demangle --wide} $tempfile readelf.demangled {}
 361 }
 362
 363 readelf_wi_test
 364 readelf_compressed_wa_test
 365
 366 readelf_dump_test
 367 run_dump_test "pr25543"
 368
 369
 370 # PR 13482 - Check for off-by-one errors when dumping .note sections.
 371 if {![binutils_assemble $srcdir/$subdir/version.s tmpdir/version.o]} then {
 372     unresolved "readelf -n version (failed to assemble)"
 373 } else {
 374
 375     if ![is_remote host] {
 376         set tempfile tmpdir/version.o
 377     } else {
 378         set tempfile [remote_download host tmpdir/version.o]
 379     }
 380
 381     readelf_test -n $tempfile readelf.n  {}
 382 }
 383
 384
 385 # PR 18374 - Check that relocations against the .debug_loc section
 386 # do not prevent readelf from displaying all the location lists.
 387 if {![binutils_assemble $srcdir/$subdir/pr18374.s tmpdir/pr18374.o]} then {
 388     unresolved "readelf --debug-dump=loc pr18374 (failed to assemble)"
 389 } else {
 390
 391     if ![is_remote host] {
 392         set tempfile tmpdir/pr18374.o
 393     } else {
 394         set tempfile [remote_download host tmpdir/pr18374.o]
 395     }
 396
 397     readelf_test --debug-dump=loc $tempfile readelf.pr18374  {}
 398 }
 399
 400
 401 # locview - Check dumping of location lists with location views.
 402 if {![binutils_assemble $srcdir/$subdir/locview-1.s tmpdir/locview-1.o]} then {
 403     unresolved "readelf --debug-dump=loc locview-1 (failed to assemble)"
 404 } else {
 405
 406     if ![is_remote host] {
 407         set tempfile tmpdir/locview-1.o
 408     } else {
 409         set tempfile [remote_download host tmpdir/locview-1.o]
 410     }
 411
 412     readelf_test --debug-dump=loc $tempfile readelf.locview-1  {}
 413 }
 414 if {![binutils_assemble $srcdir/$subdir/locview-2.s tmpdir/locview-2.o]} then {
 415     unresolved "readelf --debug-dump=loc locview-2 (failed to assemble)"
 416 } else {
 417
 418     if ![is_remote host] {
 419         set tempfile tmpdir/locview-2.o
 420     } else {
 421         set tempfile [remote_download host tmpdir/locview-2.o]
 422     }
 423
 424     readelf_test --debug-dump=loc $tempfile readelf.locview-2  {}
 425 }
 426
 427
 428 # Check that decompressed dumps work.
 429 if {![binutils_assemble $srcdir/$subdir/z.s tmpdir/z.o]} then {
 430     unresolved "readelf --decompress --hex-dump .debug_loc z (failed to assemble)"
 431 } else {
 432
 433     if ![is_remote host] {
 434         set tempfile tmpdir/z.o
 435     } else {
 436         set tempfile [remote_download host tmpdir/z.o]
 437     }
 438
 439     readelf_test {--decompress --hex-dump .debug_loc} $tempfile readelf.z  {}
 440 }
 441
 442 # Skip the next test for the RISCV architectures because they
 443 # do not support .ULEB128 pseudo-ops with non-constant values.
 444 if ![istarget "riscv*-*-*"] then {
 445
 446     set hpux ""
 447     if [istarget "hppa*64*-*-hpux*"] {
 448         set hpux "--defsym HPUX=1"
 449     }
 450
 451     # Assemble the DWARF-5 test file.
 452     if {![binutils_assemble_flags $srcdir/$subdir/dw5.S tmpdir/dw5.o $hpux]} then {
 453         unresolved "readelf -wiaoRlL dw5 (failed to assemble)"
 454     } else {
 455
 456         # Download it.
 457         if ![is_remote host] {
 458             set tempfile tmpdir/dw5.o
 459         } else {
 460             set tempfile [remote_download host tmpdir/dw5.o]
 461         }
 462
 463         # First, determine the size, so specific output matchers can be used.
 464         readelf_find_size $tempfile 2
 465
 466         # Make sure that readelf can decode the contents.
 467         readelf_test -wiaoRlL $tempfile dw5.W {}
 468     }
 469 }
 470
 471 # Assemble the DWARF-5 attributes test file.
 472 if {![binutils_assemble_flags $srcdir/$subdir/dwarf-attributes.S tmpdir/dwarf-attributes.o ""]} then {
 473     unresolved "readelf -wi dwarf-attributes (failed to assemble)"
 474 } else {
 475     # Download it.
 476     if ![is_remote host] {
 477         set tempfile tmpdir/dwarf-attributes.o
 478     } else {
 479         set tempfile [remote_download host tmpdir/dwarf-attributes.o]
 480     }
 481
 482     # First, determine the size, so specific output matchers can be used.
 483     readelf_find_size $tempfile 3
 484
 485     # Make sure that readelf can decode the contents.
 486     readelf_test -wi $tempfile dwarf-attributes.W {}
 487 }
 488
 489 # Check that debug link sections can be dumped.
 490 if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
 491     unresolved "readelf --debug-dump=links (failed to assemble debuglink.s)"
 492 } else {
 493     if ![is_remote host] {
 494         set tempfile tmpdir/debuglink.o
 495     } else {
 496         set tempfile [remote_download host tmpdir/debuglink.o]
 497     }
 498
 499     readelf_test {--debug-dump=links} $tempfile readelf.k  {}
 500
 501     # Check that debug link sections can be followed.
 502     if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
 503         unresolved "readelf --debug-dump=follow-links (failed to assemble linkdebug.s)"
 504     } else {
 505         if [is_remote host] {
 506             set tempfile2 [remote_download host tmpdir/linkdebug.debug]
 507         }
 508
 509         readelf_test {-wKis} $tempfile readelf.wKis  {}
 510     }
 511 }
 512
 513 if {![binutils_assemble $srcdir/$subdir/dwo.s tmpdir/dwo.o]} then {
 514     unresolved "readelf --debug-dump=links (failed to assemble dwo.s)"
 515 } else {
 516     if ![is_remote host] {
 517         set tempfile tmpdir/dwo.o
 518     } else {
 519         set tempfile [remote_download host tmpdir/dwo.o]
 520     }
 521
 522     readelf_test {--debug-dump=links} $tempfile readelf.k2  {}
 523 }
 524
 525 if {![binutils_assemble $srcdir/$subdir/zero-sec.s tmpdir/zero-sec.o]} then {
 526     unresolved "readelf --enable-checks (failed to assemble zero-sec.s)"
 527 } else {
 528     if ![is_remote host] {
 529         set tempfile tmpdir/zero-sec.o
 530     } else {
 531         set tempfile [remote_download host tmpdir/zero-sec.o]
 532     }
 533
 534     readelf_test {--enable-checks --sections --wide} $tempfile zero-sec.r {}
 535 }
 536
 537 if ![is_remote host] {
 538     set test $srcdir/$subdir/pr26112.o.bz2
 539     # We need to strip the ".bz2", but can leave the dirname.
 540     set t $subdir/[file tail $test]
 541     set testname [file rootname $t]
 542     verbose $testname
 543     set tempfile tmpdir/pr26112.o
 544     if {[catch "system \"bzip2 -dc $test > $tempfile\""] != 0} {
 545         untested "bzip2 -dc ($testname)"
 546     } else {
 547         readelf_test {--debug-dump=macro} $tempfile pr26112.r {}
 548     }
 549 }