[DirectX] Add ObjectFile boilerplate for objdump #151434
Open
+373
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds boilerplate code to implement the object::ObjectFile interface for the DXContainer object file and an empty implementation of the objdump Dumper object. At this point in the implementation it can't do much other than dump the part names, offsets, and sizes. Dumping detailed structured section contents to be extended in subsequent PRs. Fixes llvm#151433
|
@llvm/pr-subscribers-llvm-binary-utilities @llvm/pr-subscribers-backend-directx Author: Chris B (llvm-beanz) ChangesThis change adds boilerplate code to implement the object::ObjectFile interface for the DXContainer object file and an empty implementation of the objdump Dumper object. Adding an ObjectFile implementation for DXContainer is a bit odd because the DXContainer format doesn't have a symbol table, so there isn't a reasonable implementation for the SymbolicFile interfaces. That said, it does have sections, and it will be useful for objdump to be able to inspect some of the structured data stored in some of the special named sections. At this point in the implementation it can't do much other than dump the part names, offsets, and sizes. Dumping detailed structured section contents to be extended in subsequent PRs. Fixes #151433 Full diff: https://github.com/llvm/llvm-project/pull/151434.diff 14 Files Affected:
diff --git a/llvm/include/llvm-c/Object.h b/llvm/include/llvm-c/Object.h
index 0fc4ebe969a06..f24f768570c5e 100644
--- a/llvm/include/llvm-c/Object.h
+++ b/llvm/include/llvm-c/Object.h
@@ -55,6 +55,7 @@ typedef enum {
LLVMBinaryTypeMachO64B, /**< MachO 64-bit, big endian. */
LLVMBinaryTypeWasm, /**< Web Assembly. */
LLVMBinaryTypeOffload, /**< Offloading fatbinary. */
+ LLVMBinaryTypeDXcontainer, /**< DirectX Binary Container. */
} LLVMBinaryType;
diff --git a/llvm/include/llvm/Object/Binary.h b/llvm/include/llvm/Object/Binary.h
index bd98f40dbc706..a531ba6a812c4 100644
--- a/llvm/include/llvm/Object/Binary.h
+++ b/llvm/include/llvm/Object/Binary.h
@@ -72,6 +72,7 @@ class LLVM_ABI Binary {
ID_GOFF,
ID_Wasm,
+ ID_DXContainer,
ID_EndObjects
};
@@ -161,6 +162,8 @@ class LLVM_ABI Binary {
bool isWinRes() const { return TypeID == ID_WinRes; }
+ bool isDXContainer() const { return TypeID == ID_DXContainer; }
+
Triple::ObjectFormatType getTripleObjectFormat() const {
if (isCOFF())
return Triple::COFF;
diff --git a/llvm/include/llvm/Object/DXContainer.h b/llvm/include/llvm/Object/DXContainer.h
index 51f570da6df52..274efeee96c7c 100644
--- a/llvm/include/llvm/Object/DXContainer.h
+++ b/llvm/include/llvm/Object/DXContainer.h
@@ -20,6 +20,7 @@
#include "llvm/ADT/Twine.h"
#include "llvm/BinaryFormat/DXContainer.h"
#include "llvm/Object/Error.h"
+#include "llvm/Object/ObjectFile.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Endian.h"
#include "llvm/Support/Error.h"
@@ -499,6 +500,7 @@ class DXContainer {
} IteratorState;
friend class DXContainer;
+ friend class DXContainerObjectFile;
PartIterator(const DXContainer &C,
SmallVectorImpl<uint32_t>::const_iterator It)
@@ -584,6 +586,85 @@ class DXContainer {
}
};
+class DXContainerObjectFile : public ObjectFile {
+private:
+ friend class ObjectFile;
+ DXContainer Container;
+
+ using PartData = DXContainer::PartIterator::PartData;
+ llvm::SmallVector<PartData> Parts;
+ using PartIterator = llvm::SmallVector<PartData>::iterator;
+
+ DXContainerObjectFile(DXContainer C)
+ : ObjectFile(ID_DXContainer, MemoryBufferRef(C.getData(), "")),
+ Container(C) {
+ for (auto &P : C)
+ Parts.push_back(P);
+ }
+
+public:
+ static bool classof(const Binary *v) { return v->isDXContainer(); }
+
+ Expected<StringRef> getSymbolName(DataRefImpl) const override { return ""; }
+ Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;
+ uint64_t getSymbolValueImpl(DataRefImpl Symb) const override { return 0; }
+ uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override {
+ return 0;
+ }
+ Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override {
+ return SymbolRef::Type::ST_Unknown;
+ }
+
+ Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;
+ void moveSectionNext(DataRefImpl &Sec) const override;
+ Expected<StringRef> getSectionName(DataRefImpl Sec) const override;
+ uint64_t getSectionAddress(DataRefImpl Sec) const override;
+ uint64_t getSectionIndex(DataRefImpl Sec) const override;
+ uint64_t getSectionSize(DataRefImpl Sec) const override;
+ Expected<ArrayRef<uint8_t>>
+ getSectionContents(DataRefImpl Sec) const override;
+
+ uint64_t getSectionAlignment(DataRefImpl Sec) const override;
+ bool isSectionCompressed(DataRefImpl Sec) const override;
+ bool isSectionText(DataRefImpl Sec) const override;
+ bool isSectionData(DataRefImpl Sec) const override;
+ bool isSectionBSS(DataRefImpl Sec) const override;
+ bool isSectionVirtual(DataRefImpl Sec) const override;
+
+ relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
+ relocation_iterator section_rel_end(DataRefImpl Sec) const override;
+
+ void moveRelocationNext(DataRefImpl &Rel) const override;
+ uint64_t getRelocationOffset(DataRefImpl Rel) const override;
+ symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
+ uint64_t getRelocationType(DataRefImpl Rel) const override;
+ void getRelocationTypeName(DataRefImpl Rel,
+ SmallVectorImpl<char> &Result) const override;
+
+ section_iterator section_begin() const override;
+ section_iterator section_end() const override;
+
+ uint8_t getBytesInAddress() const override;
+ StringRef getFileFormatName() const override;
+ Triple::ArchType getArch() const override;
+ Expected<SubtargetFeatures> getFeatures() const override;
+
+ void moveSymbolNext(DataRefImpl &Symb) const override {}
+ Error printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
+ Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override {
+ return 0;
+ }
+ basic_symbol_iterator symbol_begin() const override {
+ return basic_symbol_iterator(SymbolRef());
+ }
+ basic_symbol_iterator symbol_end() const override {
+ return basic_symbol_iterator(SymbolRef());
+ }
+ bool is64Bit() const override { return 0; }
+
+ bool isRelocatableObject() const override { return false; }
+};
+
} // namespace object
} // namespace llvm
diff --git a/llvm/include/llvm/Object/ObjectFile.h b/llvm/include/llvm/Object/ObjectFile.h
index 613c36a6a56d7..289cc770e3466 100644
--- a/llvm/include/llvm/Object/ObjectFile.h
+++ b/llvm/include/llvm/Object/ObjectFile.h
@@ -44,6 +44,7 @@ class SectionRef;
class SymbolRef;
class symbol_iterator;
class WasmObjectFile;
+class DXContainerObjectFile;
using section_iterator = content_iterator<SectionRef>;
@@ -401,6 +402,9 @@ class LLVM_ABI ObjectFile : public SymbolicFile {
static Expected<std::unique_ptr<WasmObjectFile>>
createWasmObjectFile(MemoryBufferRef Object);
+
+ static Expected<std::unique_ptr<DXContainerObjectFile>>
+ createDXContainerObjectFile(MemoryBufferRef Object);
};
/// A filtered iterator for SectionRefs that skips sections based on some given
diff --git a/llvm/lib/Object/Binary.cpp b/llvm/lib/Object/Binary.cpp
index 2dfae8ab5d3c6..da2a7bb0a19da 100644
--- a/llvm/lib/Object/Binary.cpp
+++ b/llvm/lib/Object/Binary.cpp
@@ -75,6 +75,7 @@ Expected<std::unique_ptr<Binary>> object::createBinary(MemoryBufferRef Buffer,
case file_magic::xcoff_object_32:
case file_magic::xcoff_object_64:
case file_magic::wasm_object:
+ case file_magic::dxcontainer_object:
return ObjectFile::createSymbolicFile(Buffer, Type, Context, InitContent);
case file_magic::macho_universal_binary:
return MachOUniversalBinary::create(Buffer);
@@ -87,7 +88,6 @@ Expected<std::unique_ptr<Binary>> object::createBinary(MemoryBufferRef Buffer,
case file_magic::clang_ast:
case file_magic::cuda_fatbinary:
case file_magic::coff_cl_gl_object:
- case file_magic::dxcontainer_object:
case file_magic::offload_bundle:
case file_magic::offload_bundle_compressed:
case file_magic::spirv_object:
diff --git a/llvm/lib/Object/DXContainer.cpp b/llvm/lib/Object/DXContainer.cpp
index 0b46ff71240b7..cab49fc685982 100644
--- a/llvm/lib/Object/DXContainer.cpp
+++ b/llvm/lib/Object/DXContainer.cpp
@@ -11,6 +11,7 @@
#include "llvm/Object/Error.h"
#include "llvm/Support/Endian.h"
#include "llvm/Support/FormatVariadic.h"
+#include "llvm/TargetParser/SubtargetFeature.h"
using namespace llvm;
using namespace llvm::object;
@@ -515,3 +516,157 @@ uint8_t DirectX::PSVRuntimeInfo::getSigPatchOrPrimCount() const {
return P->SigPatchOrPrimElements;
return 0;
}
+
+class DXNotSupportedError : public ErrorInfo<DXNotSupportedError> {
+public:
+ static char ID;
+
+ DXNotSupportedError(StringRef S) : FeatureString(S) {}
+
+ void log(raw_ostream &OS) const override {
+ OS << "DXContainer does not support " << FeatureString;
+ }
+
+ std::error_code convertToErrorCode() const override {
+ return inconvertibleErrorCode();
+ }
+
+private:
+ StringRef FeatureString;
+};
+
+char DXNotSupportedError::ID = 0;
+
+Expected<section_iterator>
+DXContainerObjectFile::getSymbolSection(DataRefImpl Symb) const {
+ return make_error<DXNotSupportedError>("Symbol sections");
+}
+
+Expected<uint64_t>
+DXContainerObjectFile::getSymbolAddress(DataRefImpl Symb) const {
+ return make_error<DXNotSupportedError>("Symbol addresses");
+}
+
+void DXContainerObjectFile::moveSectionNext(DataRefImpl &Sec) const {
+ PartIterator It = reinterpret_cast<PartIterator>(Sec.p);
+ if (It == Parts.end())
+ return;
+
+ It++;
+ Sec.p = reinterpret_cast<uintptr_t>(It);
+}
+
+Expected<StringRef>
+DXContainerObjectFile::getSectionName(DataRefImpl Sec) const {
+ PartIterator It = reinterpret_cast<PartIterator>(Sec.p);
+ return StringRef(It->Part.getName());
+}
+
+uint64_t DXContainerObjectFile::getSectionAddress(DataRefImpl Sec) const {
+ PartIterator It = reinterpret_cast<PartIterator>(Sec.p);
+ return It->Offset;
+}
+
+uint64_t DXContainerObjectFile::getSectionIndex(DataRefImpl Sec) const {
+ return (Sec.p - reinterpret_cast<uintptr_t>(Parts.begin())) /
+ sizeof(PartIterator);
+}
+
+uint64_t DXContainerObjectFile::getSectionSize(DataRefImpl Sec) const {
+ PartIterator It = reinterpret_cast<PartIterator>(Sec.p);
+ return It->Data.size();
+}
+Expected<ArrayRef<uint8_t>>
+DXContainerObjectFile::getSectionContents(DataRefImpl Sec) const {
+ PartIterator It = reinterpret_cast<PartIterator>(Sec.p);
+ return ArrayRef<uint8_t>(It->Data.bytes_begin(), It->Data.size());
+}
+
+uint64_t DXContainerObjectFile::getSectionAlignment(DataRefImpl Sec) const {
+ return 1;
+}
+
+bool DXContainerObjectFile::isSectionCompressed(DataRefImpl Sec) const {
+ return false;
+}
+
+bool DXContainerObjectFile::isSectionText(DataRefImpl Sec) const {
+ return false;
+}
+
+bool DXContainerObjectFile::isSectionData(DataRefImpl Sec) const {
+ return false;
+}
+
+bool DXContainerObjectFile::isSectionBSS(DataRefImpl Sec) const {
+ return false;
+}
+
+bool DXContainerObjectFile::isSectionVirtual(DataRefImpl Sec) const {
+ return false;
+}
+
+relocation_iterator
+DXContainerObjectFile::section_rel_begin(DataRefImpl Sec) const {
+ return relocation_iterator(RelocationRef());
+}
+
+relocation_iterator
+DXContainerObjectFile::section_rel_end(DataRefImpl Sec) const {
+ return relocation_iterator(RelocationRef());
+}
+
+void DXContainerObjectFile::moveRelocationNext(DataRefImpl &Rel) const {}
+
+uint64_t DXContainerObjectFile::getRelocationOffset(DataRefImpl Rel) const {
+ return 0;
+}
+
+symbol_iterator
+DXContainerObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
+ return symbol_iterator(SymbolRef());
+}
+
+uint64_t DXContainerObjectFile::getRelocationType(DataRefImpl Rel) const {
+ return 0;
+}
+
+void DXContainerObjectFile::getRelocationTypeName(
+ DataRefImpl Rel, SmallVectorImpl<char> &Result) const {}
+
+section_iterator DXContainerObjectFile::section_begin() const {
+ DataRefImpl Sec;
+ Sec.p = reinterpret_cast<uintptr_t>(Parts.begin());
+ return section_iterator(SectionRef(Sec, this));
+}
+section_iterator DXContainerObjectFile::section_end() const {
+ DataRefImpl Sec;
+ Sec.p = reinterpret_cast<uintptr_t>(Parts.end());
+ return section_iterator(SectionRef(Sec, this));
+}
+
+uint8_t DXContainerObjectFile::getBytesInAddress() const { return 4; }
+
+StringRef DXContainerObjectFile::getFileFormatName() const {
+ return "DirectX Container";
+}
+
+Triple::ArchType DXContainerObjectFile::getArch() const { return Triple::dxil; }
+
+Expected<SubtargetFeatures> DXContainerObjectFile::getFeatures() const {
+ return SubtargetFeatures();
+}
+
+Error DXContainerObjectFile::printSymbolName(raw_ostream &OS,
+ DataRefImpl Symb) const {
+ return make_error<DXNotSupportedError>("Symbol names");
+}
+
+Expected<std::unique_ptr<DXContainerObjectFile>>
+ObjectFile::createDXContainerObjectFile(MemoryBufferRef Object) {
+ auto ExC = DXContainer::create(Object);
+ if (!ExC)
+ return ExC.takeError();
+ std::unique_ptr<DXContainerObjectFile> Obj(new DXContainerObjectFile(*ExC));
+ return std::move(Obj);
+}
diff --git a/llvm/lib/Object/Object.cpp b/llvm/lib/Object/Object.cpp
index c62944ad3eeba..112927ed69e84 100644
--- a/llvm/lib/Object/Object.cpp
+++ b/llvm/lib/Object/Object.cpp
@@ -124,6 +124,8 @@ LLVMBinaryType LLVMBinaryGetType(LLVMBinaryRef BR) {
return LLVMBinaryTypeOffload;
case ID_Wasm:
return LLVMBinaryTypeWasm;
+ case ID_DXContainer:
+ return LLVMBinaryTypeDXcontainer;
case ID_StartObjects:
case ID_EndObjects:
llvm_unreachable("Marker types are not valid binary kinds!");
diff --git a/llvm/lib/Object/ObjectFile.cpp b/llvm/lib/Object/ObjectFile.cpp
index 6a226a3bbdbca..b0e4ea0a51ba1 100644
--- a/llvm/lib/Object/ObjectFile.cpp
+++ b/llvm/lib/Object/ObjectFile.cpp
@@ -15,6 +15,7 @@
#include "llvm/BinaryFormat/Magic.h"
#include "llvm/Object/Binary.h"
#include "llvm/Object/COFF.h"
+#include "llvm/Object/DXContainer.h"
#include "llvm/Object/Error.h"
#include "llvm/Object/MachO.h"
#include "llvm/Object/Wasm.h"
@@ -165,7 +166,6 @@ ObjectFile::createObjectFile(MemoryBufferRef Object, file_magic Type,
case file_magic::goff_object:
case file_magic::cuda_fatbinary:
case file_magic::offload_binary:
- case file_magic::dxcontainer_object:
case file_magic::offload_bundle:
case file_magic::offload_bundle_compressed:
case file_magic::spirv_object:
@@ -201,6 +201,8 @@ ObjectFile::createObjectFile(MemoryBufferRef Object, file_magic Type,
return createXCOFFObjectFile(Object, Binary::ID_XCOFF64);
case file_magic::wasm_object:
return createWasmObjectFile(Object);
+ case file_magic::dxcontainer_object:
+ return createDXContainerObjectFile(Object);
}
llvm_unreachable("Unexpected Object File Type");
}
diff --git a/llvm/lib/Object/SymbolicFile.cpp b/llvm/lib/Object/SymbolicFile.cpp
index e87ecb1491090..47295e6027f2c 100644
--- a/llvm/lib/Object/SymbolicFile.cpp
+++ b/llvm/lib/Object/SymbolicFile.cpp
@@ -68,6 +68,7 @@ SymbolicFile::createSymbolicFile(MemoryBufferRef Object, file_magic Type,
case file_magic::xcoff_object_32:
case file_magic::xcoff_object_64:
case file_magic::wasm_object:
+ case file_magic::dxcontainer_object:
return ObjectFile::createObjectFile(Object, Type, InitContent);
case file_magic::coff_import_library:
return std::unique_ptr<SymbolicFile>(new COFFImportFile(Object));
@@ -123,6 +124,7 @@ bool SymbolicFile::isSymbolicFile(file_magic Type, const LLVMContext *Context) {
case file_magic::elf_relocatable:
case file_magic::macho_object:
case file_magic::coff_object:
+ case file_magic::dxcontainer_object:
return true;
default:
return false;
diff --git a/llvm/test/tools/llvm-objdump/DXContainer/part-headers.yaml b/llvm/test/tools/llvm-objdump/DXContainer/part-headers.yaml
new file mode 100644
index 0000000000000..dd1ffb634e996
--- /dev/null
+++ b/llvm/test/tools/llvm-objdump/DXContainer/part-headers.yaml
@@ -0,0 +1,58 @@
+# RUN: yaml2obj %s -o %t
+# RUN: llvm-objdump -h %t | FileCheck %s --check-prefix=HEADERS
+# RUN: llvm-objdump -s %t | FileCheck %s --check-prefix=CONTENTS
+
+#HEADERS: Idx Name Size VMA Type
+#HEADERS-NEXT: 0 FKE0 00000008 0000003c
+#HEADERS-NEXT: 1 FKE1 00000008 0000004c
+#HEADERS-NEXT: 2 FKE2 00000008 0000005c
+#HEADERS-NEXT: 3 FKE3 00000078 0000006c
+#HEADERS-NEXT: 4 FKE4 00000698 000000ec
+#HEADERS-NEXT: 5 FKE5 00000014 0000078c
+#HEADERS-NEXT: 6 DXIL 0000001c 000007a8
+
+#CONTENTS: Contents of section FKE0:
+#CONTENTS: Contents of section FKE1:
+#CONTENTS: Contents of section FKE2:
+#CONTENTS: Contents of section FKE3:
+#CONTENTS: Contents of section FKE4:
+#CONTENTS: Contents of section FKE5:
+#CONTENTS: Contents of section DXIL:
+#CONTENTS-NEXT: 07a8 65000500 08000000 4458494c 05010000 e.......DXIL....
+#CONTENTS-NEXT: 07b8 10000000 04000000 4243c0de ........BC..
+
+--- !dxcontainer
+Header:
+ Hash: [ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 ]
+ Version:
+ Major: 1
+ Minor: 0
+ FileSize: 3548
+ PartCount: 7
+ PartOffsets: [ 60, 76, 92, 108, 236, 1932, 1960 ]
+Parts:
+ - Name: FKE0
+ Size: 8
+ - Name: FKE1
+ Size: 8
+ - Name: FKE2
+ Size: 8
+ - Name: FKE3
+ Size: 120
+ - Name: FKE4
+ Size: 1688
+ - Name: FKE5
+ Size: 20
+ - Name: DXIL
+ Size: 28
+ Program:
+ MajorVersion: 6
+ MinorVersion: 5
+ ShaderKind: 5
+ Size: 8
+ DXILMajorVersion: 1
+ DXILMinorVersion: 5
+ DXILSize: 4
+ DXIL: [ 0x42, 0x43, 0xC0, 0xDE, ]
+...
diff --git a/llvm/tools/llvm-objdump/CMakeLists.txt b/llvm/tools/llvm-objdump/CMakeLists.txt
index 7e3197f0a0bd3..41d301cd3d77d 100644
--- a/llvm/tools/llvm-objdump/CMakeLists.txt
+++ b/llvm/tools/llvm-objdump/CMakeLists.txt
@@ -28,6 +28,7 @@ add_llvm_tool(llvm-objdump
llvm-objdump.cpp
SourcePrinter.cpp
COFFDump.cpp
+ DXContainerDump.cpp
ELFDump.cpp
MachODump.cpp
OffloadDump.cpp
diff --git a/llvm/tools/llvm-objdump/DXContainerDump.cpp b/llvm/tools/llvm-objdump/DXContainerDump.cpp
new file mode 100644
index 0000000000000..8ca01873f2ad8
--- /dev/null
+++ b/llvm/tools/llvm-objdump/DXContainerDump.cpp
@@ -0,0 +1,30 @@
+//===-- DXContainerDump.cpp - DXContainer-specific dumper -----------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// This file implements the DXContainer-specific dumper for llvm-objdump.
+///
+//===----------------------------------------------------------------------===//
+
+#include "llvm-objdump.h"
+#include "llvm/Object/DXContainer.h"
+
+using namespace llvm;
+
+namespace {
+class DXContainerDumper : public objdump::Dumper {
+public:
+ DXContainerDumper(const object::DXContainerObjectFile &Obj)
+ : objdump::Dumper(Obj) {}
+};
+} // namespace
+
+std::unique_ptr<objdump::Dumper> llvm::objdump::createDXContainerDumper(
+ const object::DXContainerObjectFile &Obj) {
+ return std::make_unique<DXContainerDumper>(Obj);
+}
diff --git a/llvm/tools/llvm-objdump/llvm-objdump.cpp b/llvm/tools/llvm-objdump/llvm-objdump.cpp
index 0316c4ba51da6..60365a698433c 100644
--- a/llvm/tools/llvm-objdump/llvm-objdump.cpp
+++ b/llvm/tools/llvm-objdump/llvm-objdump.cpp
@@ -50,6 +50,7 @@
#include "llvm/Object/BuildID.h"
#include "llvm/Object/COFF.h"
#include "llvm/Object/COFFImportFile.h"
+#include "llvm/Object/DXContainer.h"
#include "llvm/Object/ELFObjectFile.h"
#include "llvm/Object/ELFTypes.h"
#include "llvm/Object/FaultMapParser.h"
@@ -386,6 +387,8 @@ static Expected<std::unique_ptr<Dumper>> createDumper(const ObjectFile &Obj) {
return createWasmDumper(*O);
if (const auto *O = dyn_cast<XCOFFObjectFile>(&Obj))
return createXCOFFDumper(*O);
+ if (const auto *O = dyn_cast<DXContainerObjectFile>(&Obj))
+ return createDXContainerDumper(*O);
return createStringError(errc::invalid_argument,
"unsupported object file format");
diff --git a/llvm/tools/llvm-objdump/llvm-objdump.h b/llvm/tools/llvm-objdump/llvm-objdump.h
index ce0642950ebdd..3525be9a5314a 100644
--- a/llvm/tools/llvm-objdump/llvm-objdump.h
+++ b/llvm/tools/llvm-objdump/llvm-objdump.h
@@ -36,6 +36,7 @@ class ELFObjectFileBase;
class MachOObjectFile;
class WasmObjectFile;
class XCOFFObjectFile;
+class DXContainer;
} // namespace object
namespace objdump {
@@ -105,6 +106,8 @@ std::unique_ptr<Dumper> createELFDumper(const object::ELFObjectFileBase &Obj);
std::unique_ptr<Dumper> createMachODumper(const object::MachOObjectFile &Obj);
std::unique_ptr<Dumper> createWasmDumper(const object::WasmObjectFile &Obj);
std::unique_ptr<Dumper> createXCOFFDumper(const object::XCOFFObjectFile &Obj);
+std::unique_ptr<Dumper>
+createDXContainerDumper(const object::DXContainerObjectFile &Obj);
// Various helper functions.
|
MaskRay
reviewed
Jul 31, 2025
| #HEADERS-NEXT: 5 FKE5 00000014 0000078c | ||
| #HEADERS-NEXT: 6 DXIL 0000001c 000007a8 | ||
|
|
||
| #CONTENTS: Contents of section FKE0: |
There was a problem hiding this comment.
Is the FKE0 content not useful?
There was a problem hiding this comment.
I'll add the first line of each section to the test (which for the smaller sections will be everything). Since they're not known named sections with data that the YAML represents, the encoder just fills them with 0's.
../llvm/test/tools/llvm-objdump/DXContainer/part-headers.yaml
bogner
reviewed
Jul 31, 2025
Comment on lines
608
to
616
| Expected<StringRef> getSymbolName(DataRefImpl) const override { return ""; } | ||
| Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override; | ||
| uint64_t getSymbolValueImpl(DataRefImpl Symb) const override { return 0; } | ||
| uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override { | ||
| return 0; | ||
| } | ||
| Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override { | ||
| return SymbolRef::Type::ST_Unknown; | ||
| } |
There was a problem hiding this comment.
Can getSymbolName and getSymbolType return errors like the other symbol-related Expected<T> functions here? Alternatively, the specific symbol APIs could probably all be made llvm_unreachable() as in my other suggestion, as I don't think they should be dynamically reachable.
Comment on lines
610
to
613
| uint64_t getSymbolValueImpl(DataRefImpl Symb) const override { return 0; } | ||
| uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override { | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
These can probably be replaced with llvm_unreachable("DXContainer does not have symbols") or something like that. Similarly for getSymbolFlags and moveSymbolNext below - they should never actually be called since the symbol iterator is an empty list.
| basic_symbol_iterator symbol_end() const override { | ||
| return basic_symbol_iterator(SymbolRef()); | ||
| } | ||
| bool is64Bit() const override { return 0; } |
There was a problem hiding this comment.
Suggested change
| bool is64Bit() const override { return 0; } | |
| bool is64Bit() const override { return false; } |
Comment on lines
+593
to
+599
| bool DXContainerObjectFile::isSectionText(DataRefImpl Sec) const { | ||
| return false; | ||
| } | ||
|
|
||
| bool DXContainerObjectFile::isSectionData(DataRefImpl Sec) const { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
I don't actually see where these APIs are used, but arguably the DXIL section could be text and the other sections data I think.
There was a problem hiding this comment.
I really wasn't sure what to do about DXIL. I'm not sure if it should be Text or Bitcode (both are potentially reasonable). My gut is actually bitcode so we can create an IRObject from it to disassemble, but I'd like to defer that.
I suppose we could make everything else data sections. It isn't really what they traditionally mean by data because it isn't constant data referred to by the program.
These are mostly used during symbol dumping to denote what type of section a symbol points into. Are you okay pushing off any work on this into subsequent changes when we can figure out how to handle other features? Alternatively I could just make isSectionData return true for now and then everything is just data.
llvm/lib/Object/DXContainer.cpp
Outdated
Comment on lines
619
to
623
| void DXContainerObjectFile::moveRelocationNext(DataRefImpl &Rel) const {} | ||
|
|
||
| uint64_t DXContainerObjectFile::getRelocationOffset(DataRefImpl Rel) const { | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
Relocation APIs could probably also be unreachable.
bogner
approved these changes
Jul 31, 2025
lhames
reviewed
Aug 1, 2025
| Expected<uint64_t> | ||
| DXContainerObjectFile::getSymbolAddress(DataRefImpl Symb) const { | ||
| return make_error<DXNotSupportedError>("Symbol addresses"); | ||
| } | ||
|
|
||
| uint64_t DXContainerObjectFile::getSymbolValueImpl(DataRefImpl Symb) const { | ||
| llvm_unreachable("DXContainer does not support symbols"); |
There was a problem hiding this comment.
@bogner @llvm-beanz I think the DXContainerObjectFile should present as if it had empty symbol and relocation tables, rather than making these operations unreachable.
From a design perspective you should be able to iterate over the set of symbols and relocations in an object file, and empty sets are perfectly legal.
As a practical matter presenting empty sets will allow llvm-objdump -r and llvm-objdump -t to behave sensibly, whereas unreachable will cause them to crash.
There was a problem hiding this comment.
I don't think what you're saying here is in conflict to having llvm_unreachable here. With this patch llvm-objdump -r produces the output:
>bin/llvm-objdump -r part-headers.yaml.tmp
: file format directx container
and llvm-objdump -t produces:
> bin/llvm-objdump -t part-headers.yaml.tmp
: file format directx container
SYMBOL TABLE:
The iterators are implemented and all effectively return end iterators so that the result is an empty set. The only way you'd really hit these unreachable is if you tried to access or increment one of the iterators, and since they would be invalid, that would always be a logic error.
There was a problem hiding this comment.
Oh, you're totally right. My bad!
LGTM. :)
MaskRay
reviewed
Aug 1, 2025
| @@ -0,0 +1,30 @@ | |||
| //===-- DXContainerDump.cpp -----------------------------------------------===// | |||
There was a problem hiding this comment.
//===----------------------------------------------------------------------===//
MaskRay
approved these changes
Aug 1, 2025
V-FEXrt
approved these changes
Aug 1, 2025
lhames
approved these changes
Aug 2, 2025
| Expected<uint64_t> | ||
| DXContainerObjectFile::getSymbolAddress(DataRefImpl Symb) const { | ||
| return make_error<DXNotSupportedError>("Symbol addresses"); | ||
| } | ||
|
|
||
| uint64_t DXContainerObjectFile::getSymbolValueImpl(DataRefImpl Symb) const { | ||
| llvm_unreachable("DXContainer does not support symbols"); |
There was a problem hiding this comment.
Oh, you're totally right. My bad!
LGTM. :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds boilerplate code to implement the object::ObjectFile interface for the DXContainer object file and an empty implementation of the objdump Dumper object.
Adding an ObjectFile implementation for DXContainer is a bit odd because the DXContainer format doesn't have a symbol table, so there isn't a reasonable implementation for the SymbolicFile interfaces. That said, it does have sections, and it will be useful for objdump to be able to inspect some of the structured data stored in some of the special named sections.
At this point in the implementation it can't do much other than dump the part names, offsets, and sizes. Dumping detailed structured section contents to be extended in subsequent PRs.
Fixes #151433