Skip to content

Commit

Permalink
[llvm-objdump] Support CHPE code ranges in disassembler.
Browse files Browse the repository at this point in the history 
Reviewed By: jhenderson, MaskRay
Differential Revision: https://reviews.llvm.org/D149095
  • Loading branch information
@cjacek
cjacek committed Aug 14, 2023
1 parent c95361e commit 7a28b0b
Show file tree
Hide file tree
Showing 2 changed files with 170 additions and 10 deletions.
117 changes: 109 additions & 8 deletions llvm/test/tools/llvm-objdump/COFF/arm64ec.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,72 @@
# REQUIRES: aarch64-registered-target

## Check that AMD64 image file with CHPE data is recognized as ARM64EC.
# RUN: yaml2obj %s -o %t -DMACHINE=IMAGE_FILE_MACHINE_AMD64
# RUN: llvm-objdump -d %t | FileCheck --check-prefixes=DISASM,ARM64EC %s
# RUN: llvm-readobj --coff-load-config %t | FileCheck --check-prefix=CODEMAP %s
# RUN: yaml2obj --docnum=1 %s -o %t1 -DMACHINE=IMAGE_FILE_MACHINE_AMD64
# RUN: llvm-readobj --coff-load-config %t1 | FileCheck --check-prefix=CODEMAP %s
# RUN: %if x86-registered-target %{ \
# RUN: llvm-objdump -d %t1 | FileCheck --check-prefixes=DISASM,ARM64EC %s \
# RUN: %} %else %{ \
# RUN: llvm-objdump -d %t1 2>&1 | FileCheck --check-prefixes=DISASM-NO-X64,ARM64EC,WARN1 %s \
# RUN: %}

## Check that ARM64 image file with CHPE data is recognized as ARM64X.
# RUN: yaml2obj %s -o %t -DMACHINE=IMAGE_FILE_MACHINE_ARM64
# RUN: llvm-objdump -d %t | FileCheck --check-prefixes=DISASM,ARM64X %s
# RUN: llvm-readobj --coff-load-config %t | FileCheck --check-prefix=CODEMAP %s
# RUN: yaml2obj --docnum=1 %s -o %t2 -DMACHINE=IMAGE_FILE_MACHINE_ARM64
# RUN: llvm-readobj --coff-load-config %t2 | FileCheck --check-prefix=CODEMAP %s
# RUN: %if x86-registered-target %{ \
# RUN: llvm-objdump -d %t2 | FileCheck --check-prefixes=DISASM,ARM64X %s \
# RUN: %} %else %{ \
# RUN: llvm-objdump -d %t2 2>&1 | FileCheck --check-prefixes=DISASM-NO-X64,ARM64X,WARN1 %s \
# RUN: %}

## Check handling of an explicit, non-default triple.
# RUN: %if !x86-registered-target %{ \
# RUN: llvm-objdump --triple arm64ec-w64-windows-gnu -d %t1 2>&1 \
# RUN: | FileCheck --check-prefixes=DISASM-NO-X64,ARM64EC,WARN2 %s \
# RUN: %}

# ARM64EC: file format coff-arm64ec
# ARM64X: file format coff-arm64x

# DISASM: 180001000: 52800040 mov w0, #0x2
# WARN1: llvm-objdump: warning: '{{.*}}': unable to get target for 'x86_64--', see --version and --triple.
# WARN2: llvm-objdump: warning: '{{.*}}': unable to get target for 'x86_64-w64-windows-gnu', see --version and --triple.

# DISASM: Disassembly of section .text:
# DISASM-EMPTY:
# DISASM-NEXT: 0000000180001000 <.text>:
# DISASM-NEXT: 180001000: 52800040 mov w0, #0x2
# DISASM-NEXT: 180001004: d65f03c0 ret
# DISASM-NEXT: ...
# DISASM: 180002020: 528000a0 mov w0, #0x5
# DISASM-NEXT: 180001020: b8 03 00 00 00 movl $0x3, %eax
# DISASM-NEXT: 180001025: c3 retq
# DISASM-EMPTY:
# DISASM-NEXT: Disassembly of section .test:
# DISASM-EMPTY:
# DISASM-NEXT: 0000000180002000 <.test>:
# DISASM-NEXT: 180002000: b8 06 00 00 00 movl $0x6, %eax
# DISASM-NEXT: 180002005: c3 retq
# DISASM-NEXT: 180002006: cc int3
# DISASM-NEXT: ...
# DISASM-NEXT: 180002020: 528000a0 mov w0, #0x5
# DISASM-NEXT: 180002024: d65f03c0 ret

# DISASM-NO-X64: Disassembly of section .text:
# DISASM-NO-X64-EMPTY:
# DISASM-NO-X64-NEXT: 0000000180001000 <.text>:
# DISASM-NO-X64-NEXT: 180001000: 52800040 mov w0, #0x2
# DISASM-NO-X64-NEXT: 180001004: d65f03c0 ret
# DISASM-NO-X64-NEXT: ...
# DISASM-NO-X64-NEXT: 180001020: 000003b8 udf #0x3b8
# DISASM-NO-X64-NEXT: 180001024: 00 c3 <unknown>
# DISASM-NO-X64-EMPTY:
# DISASM-NO-X64-NEXT: Disassembly of section .test:
# DISASM-NO-X64-EMPTY:
# DISASM-NO-X64-NEXT: 0000000180002000 <.test>:
# DISASM-NO-X64-NEXT: 180002000: 000006b8 udf #0x6b8
# DISASM-NO-X64-NEXT: 180002004: 00ccc300 <unknown>
# DISASM-NO-X64-NEXT: ...
# DISASM-NO-X64-NEXT: 180002020: 528000a0 mov w0, #0x5
# DISASM-NO-X64-NEXT: 180002024: d65f03c0 ret

# CODEMAP: CodeMap [
# CODEMAP-NEXT: 0x1000 - 0x1008 ARM64EC
# CODEMAP-NEXT: 0x1020 - 0x2007 X64
Expand Down Expand Up @@ -88,3 +136,56 @@ sections:
- UInt32: 0x8
symbols: []
...

## Check error handling of invalid code map RVA.
# RUN: yaml2obj --docnum=2 %s -o %t-invalid
# RUN: not llvm-objdump -d %t-invalid 2>&1 | FileCheck --check-prefixes=ERR %s -DFILE=%t-invalid
# ERR: error: '[[FILE]]': RVA 0x6000 for CHPE code map not found

--- !COFF
OptionalHeader:
ImageBase: 0x180000000
SectionAlignment: 4096
FileAlignment: 512
DLLCharacteristics: [ ]
LoadConfigTable:
RelativeVirtualAddress: 0x3000
Size: 320
header:
Machine: IMAGE_FILE_MACHINE_AMD64
Characteristics: [ IMAGE_FILE_EXECUTABLE_IMAGE, IMAGE_FILE_LARGE_ADDRESS_AWARE, IMAGE_FILE_DLL ]
sections:
- Name: .rdata
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ ]
VirtualAddress: 0x3000
VirtualSize: 328
StructuredData:
- LoadConfig:
CHPEMetadataPointer: 0x180004000
- Name: .data
Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_READ, IMAGE_SCN_MEM_WRITE ]
VirtualAddress: 0x4000
VirtualSize: 112
StructuredData:
- UInt32: 1 # Version
- UInt32: 0x6000 # CodeMap
- UInt32: 3 # CodeMapCount
- UInt32: 0 # CodeRangesToEntryPoints
- UInt32: 0 # RedirectionMetadata
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0 # CodeRangesToEntryPointsCount
- UInt32: 0 # RedirectionMetadataCount
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
- UInt32: 0
symbols: []
...
63 changes: 61 additions & 2 deletions llvm/tools/llvm-objdump/llvm-objdump.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1412,8 +1412,31 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj,
SourcePrinter &SP, bool InlineRelocs) {
DisassemblerTarget *DT = &PrimaryTarget;
bool PrimaryIsThumb = false;
if (isArmElf(Obj))
PrimaryIsThumb = PrimaryTarget.SubtargetInfo->checkFeatures("+thumb-mode");
SmallVector<std::pair<uint64_t, uint64_t>, 0> CHPECodeMap;

if (SecondaryTarget) {
if (isArmElf(Obj)) {
PrimaryIsThumb =
PrimaryTarget.SubtargetInfo->checkFeatures("+thumb-mode");
} else if (const auto *COFFObj = dyn_cast<COFFObjectFile>(&Obj)) {
const chpe_metadata *CHPEMetadata = COFFObj->getCHPEMetadata();
if (CHPEMetadata && CHPEMetadata->CodeMapCount) {
uintptr_t CodeMapInt;
cantFail(COFFObj->getRvaPtr(CHPEMetadata->CodeMap, CodeMapInt));
auto CodeMap = reinterpret_cast<const chpe_range_entry *>(CodeMapInt);

for (uint32_t i = 0; i < CHPEMetadata->CodeMapCount; ++i) {
if (CodeMap[i].getType() == chpe_range_type::Amd64 &&
CodeMap[i].Length) {
// Store x86_64 CHPE code ranges.
uint64_t Start = CodeMap[i].getStart() + COFFObj->getImageBase();
CHPECodeMap.emplace_back(Start, Start + CodeMap[i].Length);
}
}
llvm::sort(CHPECodeMap);
}
}
}

std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
if (InlineRelocs)
Expand Down Expand Up @@ -1902,6 +1925,24 @@ disassembleObject(ObjectFile &Obj, const ObjectFile &DbgObj,
DT = PrimaryIsThumb ? &PrimaryTarget : &*SecondaryTarget;
}
}
} else if (!CHPECodeMap.empty()) {
uint64_t Address = SectionAddr + Index;
auto It = partition_point(
CHPECodeMap,
[Address](const std::pair<uint64_t, uint64_t> &Entry) {
return Entry.first <= Address;
});
if (It != CHPECodeMap.begin() && Address < (It - 1)->second) {
DT = &*SecondaryTarget;
} else {
DT = &PrimaryTarget;
// X64 disassembler range may have left Index unaligned, so
// make sure that it's aligned when we switch back to ARM64
// code.
Index = llvm::alignTo(Index, 4);
if (Index >= End)
break;
}
}

if (DumpARMELFData) {
Expand Down Expand Up @@ -2211,6 +2252,24 @@ static void disassembleObject(ObjectFile *Obj, bool InlineRelocs) {
Features.AddFeature("+thumb-mode");
SecondaryTarget.emplace(PrimaryTarget, Features);
}
} else if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
const chpe_metadata *CHPEMetadata = COFFObj->getCHPEMetadata();
if (CHPEMetadata && CHPEMetadata->CodeMapCount) {
// Set up x86_64 disassembler for ARM64EC binaries.
Triple X64Triple(TripleName);
X64Triple.setArch(Triple::ArchType::x86_64);

std::string Error;
const Target *X64Target =
TargetRegistry::lookupTarget("", X64Triple, Error);
if (X64Target) {
SubtargetFeatures X64Features;
SecondaryTarget.emplace(X64Target, *Obj, X64Triple.getTriple(), "",
X64Features);
} else {
reportWarning(Error, Obj->getFileName());
}
}
}

const ObjectFile *DbgObj = Obj;
Expand Down

0 comments on commit 7a28b0b

Please sign in to comment.