binutils/testsuite/binutils-all/readelf.exp

   1 #   Copyright (C) 1999-2022 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 } {
  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     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
  93         fail "$testname (reason: unexpected output)"
  94         send_log $got
  95         send_log "\n"
  96         return
  97     }
  98
  99     if { [is_elf_unused_section_symbols ] } {
 100         set target_machine unused
 101     } else {
 102         set target_machine ""
 103     }
 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         send_log [file_contents readelf.out]
 122         send_log "\n"
 123         fail $testname
 124         return
 125     }
 126
 127     pass $testname
 128 }
 129
 130 # Simple proc to skip certain expected warning messages.
 131
 132 proc prune_readelf_wi_warnings { text } {
 133     regsub -all "(^|\n)(.*Skipping unexpected symbol type.*)" $text "\\1" text
 134     return $text
 135 }
 136
 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.
 143
 144 proc readelf_wi_test {} {
 145     global READELF
 146     global READELFFLAGS
 147     global srcdir
 148     global subdir
 149
 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"
 154         return
 155     }
 156
 157     # Download it.
 158     set tempfile [remote_download host tmpdir/testprog.o]
 159
 160     # Run "readelf -wi" on it.
 161     set got [remote_exec host "$READELF $READELFFLAGS -wi $tempfile" "" "/dev/null" "readelf.out"]
 162
 163     # Upload the results.
 164     set output [remote_upload host readelf.out]
 165
 166     file_on_host delete $tempfile
 167
 168     # Strip any superflous warnings.
 169     set got [prune_readelf_wi_warnings [lindex $got 1]]
 170
 171     if ![string match "" $got] then {
 172         fail "readelf $READELFFLAGS -wi (reason: unexpected output)"
 173         send_log $got
 174         send_log "\n"
 175         return
 176     }
 177
 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"
 183         return
 184     }
 185
 186     # Search for strings that should be in the output.
 187     set sought {
 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).*"
 194         ".*DW_AT_name.*fn.*"
 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).*"
 198     }
 199
 200     # The MSP430 in LARGE mode does not generate a DW_OP_addr.
 201     setup_xfail msp430*-*-*
 202
 203     foreach looked_for $sought {
 204         set lines [grep $output $looked_for]
 205         if ![llength $lines] then {
 206             fail "readelf -wi: missing: $looked_for"
 207             send_log readelf.out
 208             return
 209         }
 210     }
 211
 212     file_on_host delete $output
 213
 214     # All done.
 215     pass "readelf -wi"
 216 }
 217
 218 # This tests "readelf -wa", but on a file with a compressed
 219 # .debug_abbrev section.
 220
 221 proc readelf_compressed_wa_test {} {
 222     global READELF
 223     global READELFFLAGS
 224     global srcdir
 225     global subdir
 226
 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)"
 231         return
 232     }
 233
 234     # Download it.
 235     set tempfile [remote_download host tmpdir/dw2-compressed.o]
 236
 237     # Run "readelf -wa" on it.
 238     set got [remote_exec host "$READELF $READELFFLAGS -wa $tempfile" "" "/dev/null" "readelf.out"]
 239
 240     # Upload the results.
 241     set output [remote_upload host readelf.out]
 242
 243     file_on_host delete $tempfile
 244
 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
 249         return
 250     }
 251
 252     pass "readelf -wa (compressed)"
 253 }
 254
 255 # Test readelf's dumping abilities.
 256
 257 proc readelf_dump_test {} {
 258     global READELF
 259     global READELFFLAGS
 260     global srcdir
 261     global subdir
 262
 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"
 266       return
 267     }
 268     # Download it.
 269     set tempfile [remote_download host tmpdir/dumptest.o]
 270
 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"]
 275     } else {
 276         set got [remote_exec host "$READELF $READELFFLAGS -p.data $tempfile" "" "/dev/null" "readelf.out"]
 277     }
 278     set got [lindex $got 1]
 279
 280     # Upload the results.
 281     set output [remote_upload host readelf.out]
 282
 283     # Check for something going wrong.
 284     if ![string match "" $got] then {
 285         fail "readelf -p: unexpected output"
 286         send_log $got
 287         send_log "\n"
 288         return
 289     }
 290
 291     # Search for strings that should be in the output.
 292     set sought {
 293         ".*test_string.*"
 294     }
 295
 296     foreach looked_for $sought {
 297         set lines [grep $output $looked_for]
 298         if ![llength $lines] then {
 299             fail "readelf -p: missing: $looked_for"
 300             send_log readelf.out
 301             return
 302         }
 303     }
 304
 305     file_on_host delete $tempfile
 306     file_on_host delete $output
 307
 308     # All done.
 309     pass "readelf -p"
 310
 311     # XXX FIXME: Add test of readelf -x here
 312 }
 313
 314 # Tests whether readelf can read thin archives
 315 proc readelf_thin_archive_test {} {
 316     global AR
 317
 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
 322     } else {
 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
 326     }
 327
 328     set testname "readelf -h bintest.thin"
 329     set got [binutils_run $AR "rcT $libname ${tempfile}"]
 330     if ![string match "" $got] {
 331         fail $testname
 332         return
 333     }
 334
 335     readelf_test -h $templib readelf.h.thin
 336
 337     pass $testname
 338 }
 339
 340 if ![is_remote host] {
 341     if {[which $READELF] == 0} then {
 342         perror "$READELF does not exist"
 343         return
 344     }
 345 }
 346
 347 send_user "Version [binutil_version $READELF]"
 348
 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)"
 355     global readelf_size
 356     set readelf_size ""
 357 } else {
 358
 359     if ![is_remote host] {
 360         set tempfile tmpdir/bintest.o
 361     } else {
 362         set tempfile [remote_download host tmpdir/bintest.o]
 363     }
 364
 365     # First, determine the size, so specific output matchers can be used.
 366     readelf_find_size $tempfile 1
 367
 368     # Run the tests.
 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
 374
 375     readelf_thin_archive_test
 376 }
 377
 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)"
 381 } else {
 382
 383     if ![is_remote host] {
 384         set tempfile tmpdir/mangled.o
 385     } else {
 386         set tempfile [remote_download host tmpdir/mangled.o]
 387     }
 388
 389     # Run the test.
 390     readelf_test {--syms --demangle --wide} $tempfile readelf.demangled
 391 }
 392
 393 readelf_wi_test
 394 readelf_compressed_wa_test
 395
 396 readelf_dump_test
 397
 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)"
 409         } else {
 410             if ![is_remote host] {
 411                 set tempfile tmpdir/pr26548e.o
 412             } else {
 413                 set tempfile [remote_download host tmpdir/pr26548e.o]
 414             }
 415             readelf_test -Wwi $tempfile pr26548e.d
 416         }
 417     }
 418 }
 419
 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)"
 423 } else {
 424
 425     if ![is_remote host] {
 426         set tempfile tmpdir/version.o
 427     } else {
 428         set tempfile [remote_download host tmpdir/version.o]
 429     }
 430
 431     readelf_test -n $tempfile readelf.n
 432 }
 433
 434
 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)"
 439 } else {
 440
 441     if ![is_remote host] {
 442         set tempfile tmpdir/pr18374.o
 443     } else {
 444         set tempfile [remote_download host tmpdir/pr18374.o]
 445     }
 446
 447     readelf_test --debug-dump=loc $tempfile readelf.pr18374
 448 }
 449
 450
 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)"
 454 } else {
 455
 456     if ![is_remote host] {
 457         set tempfile tmpdir/locview-1.o
 458     } else {
 459         set tempfile [remote_download host tmpdir/locview-1.o]
 460     }
 461
 462     readelf_test --debug-dump=loc $tempfile readelf.locview-1
 463 }
 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)"
 466 } else {
 467
 468     if ![is_remote host] {
 469         set tempfile tmpdir/locview-2.o
 470     } else {
 471         set tempfile [remote_download host tmpdir/locview-2.o]
 472     }
 473
 474     readelf_test --debug-dump=loc $tempfile readelf.locview-2
 475 }
 476
 477
 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)"
 481 } else {
 482
 483     if ![is_remote host] {
 484         set tempfile tmpdir/z.o
 485     } else {
 486         set tempfile [remote_download host tmpdir/z.o]
 487     }
 488
 489     readelf_test {--decompress --hex-dump .debug_loc} $tempfile readelf.z
 490 }
 491
 492 set hpux ""
 493
 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 {
 497
 498     if [istarget "hppa*64*-*-hpux*"] {
 499         set hpux "--defsym HPUX=1"
 500     }
 501
 502     # Assemble the DWARF-5 test file.
 503     if {![binutils_assemble_flags $srcdir/$subdir/dw5.S tmpdir/dw5.o $hpux]} then {
 504         unsupported "readelf -wiaoRlL dw5 (failed to assemble)"
 505     } else {
 506
 507         # Download it.
 508         if ![is_remote host] {
 509             set tempfile tmpdir/dw5.o
 510         } else {
 511             set tempfile [remote_download host tmpdir/dw5.o]
 512         }
 513
 514         # First, determine the size, so specific output matchers can be used.
 515         readelf_find_size $tempfile 2
 516
 517         # Make sure that readelf can decode the contents.
 518         readelf_test -wiaoRlL $tempfile dw5.W
 519     }
 520 }
 521
 522 # Assemble the DWARF-5 attributes test file.
 523 if {![binutils_assemble_flags $srcdir/$subdir/dwarf-attributes.S tmpdir/dwarf-attributes.o ""]} then {
 524     unsupported "readelf -wi dwarf-attributes (failed to assemble)"
 525 } else {
 526     # Download it.
 527     if ![is_remote host] {
 528         set tempfile tmpdir/dwarf-attributes.o
 529     } else {
 530         set tempfile [remote_download host tmpdir/dwarf-attributes.o]
 531     }
 532
 533     # First, determine the size, so specific output matchers can be used.
 534     readelf_find_size $tempfile 3
 535
 536     # Make sure that readelf can decode the contents.
 537     readelf_test -wi $tempfile dwarf-attributes.W
 538 }
 539
 540 # Check that debug link sections can be dumped.
 541 if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
 542     unsupported "readelf --debug-dump=links (failed to assemble debuglink.s)"
 543 } else {
 544     if ![is_remote host] {
 545         set tempfile tmpdir/debuglink.o
 546     } else {
 547         set tempfile [remote_download host tmpdir/debuglink.o]
 548     }
 549
 550     readelf_test {--debug-dump=links -wN} $tempfile readelf.k
 551
 552     # Check that debug link sections can be followed.
 553     if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
 554         unsupported "readelf --debug-dump=follow-links (failed to assemble linkdebug.s)"
 555     } else {
 556         if [is_remote host] {
 557             set tempfile2 [remote_download host tmpdir/linkdebug.debug]
 558         }
 559
 560         readelf_test "-wKis -P" $tempfile readelf.wKis
 561     }
 562 }
 563
 564 if {![binutils_assemble $srcdir/$subdir/dwo.s tmpdir/dwo.o]} then {
 565     unsupported "readelf --debug-dump=links (failed to assemble dwo.s)"
 566 } else {
 567     if ![is_remote host] {
 568         set tempfile tmpdir/dwo.o
 569     } else {
 570         set tempfile [remote_download host tmpdir/dwo.o]
 571     }
 572
 573     readelf_test {--debug-dump=links --debug-dump=no-follow-links} $tempfile readelf.k2
 574 }
 575
 576 if {![binutils_assemble $srcdir/$subdir/zero-sec.s tmpdir/zero-sec.o]} then {
 577     unsupported "readelf --enable-checks (failed to assemble zero-sec.s)"
 578 } else {
 579     if ![is_remote host] {
 580         set tempfile tmpdir/zero-sec.o
 581     } else {
 582         set tempfile [remote_download host tmpdir/zero-sec.o]
 583     }
 584
 585     readelf_test {--enable-checks --sections --wide} $tempfile zero-sec.r
 586 }
 587
 588 if ![is_remote host] {
 589     set test $srcdir/$subdir/pr26112.o.bz2
 590     # We need to strip the ".bz2", but can leave the dirname.
 591     set t $subdir/[file tail $test]
 592     set testname [file rootname $t]
 593     verbose $testname
 594     set tempfile tmpdir/pr26112.o
 595     if {[catch "system \"bzip2 -dc $test > $tempfile\""] != 0} {
 596         untested "bzip2 -dc ($testname)"
 597     } else {
 598         readelf_test {--debug-dump=macro -wN} $tempfile pr26112.r
 599     }
 600 }
 601
 602 # Check dwarf-5 support for DW_OP_addrx.
 603 if {![binutils_assemble_flags $srcdir/$subdir/dw5-op.S tmpdir/dw5-op.o $hpux]} then {
 604     unsupported "readelf -wi dw5-op (failed to assemble)"
 605 } else {
 606
 607 # Download it.
 608 if ![is_remote host] {
 609     set tempfile tmpdir/dw5-op.o
 610 } else {
 611     set tempfile [remote_download host tmpdir/dw5-op.o]
 612 }
 613
 614 # First, determine the size, so specific output matchers can be used.
 615 readelf_find_size $tempfile 2
 616
 617 # Make sure that readelf can decode the contents.
 618 readelf_test -wi $tempfile dw5-op.W
 619 }