[llvm-objdump] --adjust-vma adjust symbol table

[HamidrezaSK]

Summary

Add a shouldAdjustVA(Section) guard on top of address update.

Update llvm-objdump file to update symbol table when --adjust-vma used.

Fixes #63203

[mysterymath]

llvm/tools/llvm-objdump/llvm-objdump.cpp

2403

This needs a shouldAdjustVA(Section) guard like other places where the adjustment is added, to avoid adjusting e.g. non-alloc sections.

[HamidrezaSK]

Add a shouldAdjustVA(Section) guard on top of the address update.

[jhenderson]

As this patch is supposed to be fixing an issue in Github, please add "Fixes #63203" to your commit message for this patch.

llvm/test/tools/llvm-objdump/X86/adjust-vma.test

35–38

Nit: You will see in the other parts of this test that the ADJUST blocks are indented slightly to ensure they line up with the NOADJUST blocks. Please could you do the same here, to make it easier to read and compare.

llvm/tools/llvm-objdump/llvm-objdump.cpp

2403

We need a test case that shows that this shouldAdjustVA function has been called. I don't believe any of the symbols in the test you've added are impacted by this? You can add a symbol to the YAML in the test file that is in the .debug_str section, to achieve this, I believe.

[MaskRay]

llvm/tools/llvm-objdump/llvm-objdump.cpp

2403

I think this should be if (SecI != O.section_end() && shouldAdjustVA(*SecI)) to protect a dereference of O.section_end().

D153401 will add another interesting test about a SHN_ABS symbol.

[HamidrezaSK]

Adjust the indentation symbol table test ADJUST blocks to line up with the NOADJUST blocks.

Adjust the guard on top of the address update to if (SecI != O.section_end() && shouldAdjustVA(*SecI)) to protect a dereference of O.section_end().

Adjust adjust-vma test to add SHN_ABS symbol test (D153401).

[MaskRay]

D153401 has landed, so you'll need to rebase on top of it.

[jhenderson]

LGTM too, after the rebase.

[xgupta]

Rebased and committed in https://reviews.llvm.org/rG7b7470600c1b30d6f1acf500976e1c06e5282aa0.

llvm/test/tools/llvm-objdump/X86/adjust-vma.test

 # RUN: yaml2obj %s -o %t
 # RUN: llvm-objdump --all-headers -D -z %t | FileCheck %s --check-prefixes=COMMON,NOADJUST
 # RUN: llvm-objdump --all-headers -D -z --adjust-vma=0x0 %t | FileCheck %s --check-prefixes=COMMON,NOADJUST
 # RUN: llvm-objdump --all-headers -D -z --adjust-vma=0x123000 %t | FileCheck %s --check-prefixes=COMMON,ADJUST
 
 # NOADJUST:      Sections:
 # NOADJUST-NEXT: Idx Name           Size     VMA              Type
 # NOADJUST-NEXT:  0                 00000000 0000000000000000
 # NOADJUST-NEXT:  1 .text           00000002 0000000000000000 TEXT
 # NOADJUST-NEXT:  2 .debug_str      00000004 0000000000000000
 # NOADJUST-NEXT:  3 .rela.debug_str 00000018 0000000000000000
 # NOADJUST-NEXT:  4 .data           00000004 0000000000000000 DATA
 # NOADJUST-NEXT:  5 .rela.data      00000018 0000000000000000
-# NOADJUST-NEXT:  6 .symtab         00000060 0000000000000000
-# NOADJUST-NEXT:  7 .strtab         00000010 0000000000000000
+# NOADJUST-NEXT:  6 .symtab         {{.*}}   0000000000000000
+# NOADJUST-NEXT:  7 .strtab         {{.*}}   0000000000000000
 # NOADJUST-NEXT:  8 .shstrtab       0000003c 0000000000000000
 
 # ADJUST:        Sections:
 # ADJUST-NEXT:   Idx Name           Size     VMA              Type
 # ADJUST-NEXT:    0                 00000000 0000000000000000
 # ADJUST-NEXT:    1 .text           00000002 0000000000123000 TEXT
 # ADJUST-NEXT:    2 .debug_str      00000004 0000000000000000
 # ADJUST-NEXT:    3 .rela.debug_str 00000018 0000000000000000
 # ADJUST-NEXT:    4 .data           00000004 0000000000123000 DATA
 # ADJUST-NEXT:    5 .rela.data      00000018 0000000000000000
-# ADJUST-NEXT:    6 .symtab         00000060 0000000000000000
-# ADJUST-NEXT:    7 .strtab         00000010 0000000000000000
+# ADJUST-NEXT:    6 .symtab         {{.*}}   0000000000000000
+# ADJUST-NEXT:    7 .strtab         {{.*}}   0000000000000000
 # ADJUST-NEXT:    8 .shstrtab       0000003c 0000000000000000
 
-# COMMON:      SYMBOL TABLE:
-# COMMON-NEXT:  0000000000000001  l F .text 0000000000000000 func
-# COMMON-NEXT:  0000000000000000  l   .text 0000000000000000 sym
-# COMMON-NEXT:  0000000000000000  l d .text 0000000000000000 .text
+# NOADJUST:      SYMBOL TABLE:
+# NOADJUST-NEXT:  0000000000000001  l F .text      0000000000000000 func
+# NOADJUST-NEXT:  0000000000000000  l   .text      0000000000000000 sym
+# NOADJUST-NEXT:  0000000000000000  l d .text      0000000000000000 .text
+# NOADJUST-NEXT:  0000000000003333  l   *ABS*      0000000000000000 abs
+# NOADJUST-NEXT:  0000000000000000  l   .debug_str 0000000000000000 debug_str_sym
+
+# ADJUST:        SYMBOL TABLE:
+# ADJUST-NEXT:    0000000000123001  l F .text      0000000000000000 func
+# ADJUST-NEXT:    0000000000123000  l   .text      0000000000000000 sym
+# ADJUST-NEXT:    0000000000123000  l d .text      0000000000000000 .text
+# ADJUST-NEXT:    0000000000003333  l   *ABS*      0000000000000000 abs
+# ADJUST-NEXT:    0000000000000000  l   .debug_str 0000000000000000 debug_str_sym
 
 # NOADJUST:      0000000000000000 <sym>:
 # NOADJUST-NEXT:   0: {{.*}}  nop
 # NOADJUST:      0000000000000001 <func>:
 # NOADJUST-NEXT:   1: {{.*}}  retq
 
 # ADJUST:        0000000000123000 <sym>:
 # ADJUST-NEXT:     123000: {{.*}} nop
 # ADJUST:        0000000000123001 <func>:
 # ADJUST-NEXT:     123001: {{.*}} retq
 
-# NOADJUST:      0000000000000000 <.debug_str>:
+# NOADJUST:      0000000000000000 <debug_str_sym>:
 # NOADJUST-NEXT:   0: {{.*}}  %al, (%rax)
 # NOADJUST-NEXT:      0000000000000001:  R_X86_64_32  .text
 # NOADJUST-NEXT:   2: {{.*}}  addb    %al, (%rax)
 
-# ADJUST:        0000000000000000 <.debug_str>:
+# ADJUST:        0000000000000000 <debug_str_sym>:
 # ADJUST-NEXT:     0: {{.*}}  %al, (%rax)
 # ADJUST-NEXT:        0000000000123001:  R_X86_64_32  .text
 # ADJUST-NEXT:     2: {{.*}}  addb    %al, (%rax)
 
 # COMMON:        0000000000000000    <.rela.debug_str>:
 # COMMON-NEXT:     0: {{.*}}  addl %eax, (%rax)
 ## ... There are more lines here. We do not care.
 
- Name:            func
     Type:            STT_FUNC
     Section:         .text
     Value:           0x0000000000000001
   - Name:            sym
     Section:         .text
   - Name:            .text
     Type:            STT_SECTION
     Section:         .text
+  - Name:            abs
+    Index:           SHN_ABS
+    Value:           0x3333
+  - Name:            debug_str_sym
+    Section:         .debug_str

llvm/tools/llvm-objdump/llvm-objdump.cpp

 
 void objdump::printSymbol(const ObjectFile &O, const SymbolRef &Symbol,
                           ArrayRef<VersionEntry> SymbolVersions,
                           StringRef FileName, StringRef ArchiveName,
                           StringRef ArchitectureName, bool DumpDynamic) {
   const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(&O);
   uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName, ArchiveName,
                                    ArchitectureName);
+  section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
+  if (SecI != O.section_end() && shouldAdjustVA(*SecI))
+    Address += AdjustVMA;
   if ((Address < StartAddress) || (Address > StopAddress))
     return;
   SymbolRef::Type Type =
       unwrapOrError(Symbol.getType(), FileName, ArchiveName, ArchitectureName);
   uint32_t Flags =
       unwrapOrError(Symbol.getFlags(), FileName, ArchiveName, ArchitectureName);
 
   // Don't ask a Mach-O STAB symbol for its section unless you know that