1 //===-- ObjDumper.h ---------------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLVM_TOOLS_LLVM_READOBJ_OBJDUMPER_H 10 #define LLVM_TOOLS_LLVM_READOBJ_OBJDUMPER_H 11 12 #include <memory> 13 #include <system_error> 14 15 #include "llvm/ADT/StringRef.h" 16 #include "llvm/Object/ObjectFile.h" 17 #include "llvm/Support/CommandLine.h" 18 19 #include <unordered_set> 20 21 namespace llvm { 22 namespace object { 23 class COFFImportFile; 24 class ObjectFile; 25 class XCOFFObjectFile; 26 class ELFObjectFileBase; 27 } 28 namespace codeview { 29 class GlobalTypeTableBuilder; 30 class MergingTypeTableBuilder; 31 } // namespace codeview 32 33 class ScopedPrinter; 34 35 class ObjDumper { 36 public: 37 ObjDumper(ScopedPrinter &Writer, StringRef ObjName); 38 virtual ~ObjDumper(); 39 40 virtual bool canDumpContent() { return true; } 41 42 virtual void printFileHeaders() = 0; 43 virtual void printSectionHeaders() = 0; 44 virtual void printRelocations() = 0; 45 virtual void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols) { 46 if (PrintSymbols) 47 printSymbols(); 48 if (PrintDynamicSymbols) 49 printDynamicSymbols(); 50 } 51 virtual void printProgramHeaders(bool PrintProgramHeaders, 52 cl::boolOrDefault PrintSectionMapping) { 53 if (PrintProgramHeaders) 54 printProgramHeaders(); 55 if (PrintSectionMapping == cl::BOU_TRUE) 56 printSectionMapping(); 57 } 58 59 virtual void printUnwindInfo() = 0; 60 61 // Only implemented for ELF at this time. 62 virtual void printDependentLibs() {} 63 virtual void printDynamicRelocations() { } 64 virtual void printDynamicTable() { } 65 virtual void printNeededLibraries() { } 66 virtual void printSectionAsHex(StringRef SectionName) {} 67 virtual void printHashTable() { } 68 virtual void printGnuHashTable() {} 69 virtual void printHashSymbols() {} 70 virtual void printLoadName() {} 71 virtual void printVersionInfo() {} 72 virtual void printGroupSections() {} 73 virtual void printHashHistograms() {} 74 virtual void printCGProfile() {} 75 virtual void printBBAddrMaps() {} 76 virtual void printAddrsig() {} 77 virtual void printNotes() {} 78 virtual void printELFLinkerOptions() {} 79 virtual void printStackSizes() {} 80 virtual void printSectionDetails() {} 81 virtual void printArchSpecificInfo() {} 82 83 // Only implemented for PE/COFF. 84 virtual void printCOFFImports() { } 85 virtual void printCOFFExports() { } 86 virtual void printCOFFDirectives() { } 87 virtual void printCOFFBaseReloc() { } 88 virtual void printCOFFDebugDirectory() { } 89 virtual void printCOFFTLSDirectory() {} 90 virtual void printCOFFResources() {} 91 virtual void printCOFFLoadConfig() { } 92 virtual void printCodeViewDebugInfo() { } 93 virtual void 94 mergeCodeViewTypes(llvm::codeview::MergingTypeTableBuilder &CVIDs, 95 llvm::codeview::MergingTypeTableBuilder &CVTypes, 96 llvm::codeview::GlobalTypeTableBuilder &GlobalCVIDs, 97 llvm::codeview::GlobalTypeTableBuilder &GlobalCVTypes, 98 bool GHash) {} 99 100 // Only implemented for MachO. 101 virtual void printMachODataInCode() { } 102 virtual void printMachOVersionMin() { } 103 virtual void printMachODysymtab() { } 104 virtual void printMachOSegment() { } 105 virtual void printMachOIndirectSymbols() { } 106 virtual void printMachOLinkerOptions() { } 107 108 // Currently only implemented for XCOFF. 109 virtual void printStringTable() { } 110 111 virtual void printStackMap() const = 0; 112 113 void printAsStringList(StringRef StringContent); 114 115 void printSectionsAsString(const object::ObjectFile &Obj, 116 ArrayRef<std::string> Sections); 117 void printSectionsAsHex(const object::ObjectFile &Obj, 118 ArrayRef<std::string> Sections); 119 120 std::function<Error(const Twine &Msg)> WarningHandler; 121 void reportUniqueWarning(Error Err) const; 122 void reportUniqueWarning(const Twine &Msg) const; 123 124 protected: 125 ScopedPrinter &W; 126 127 private: 128 virtual void printSymbols() {} 129 virtual void printDynamicSymbols() {} 130 virtual void printProgramHeaders() {} 131 virtual void printSectionMapping() {} 132 133 std::unordered_set<std::string> Warnings; 134 }; 135 136 std::unique_ptr<ObjDumper> createCOFFDumper(const object::COFFObjectFile &Obj, 137 ScopedPrinter &Writer); 138 139 std::unique_ptr<ObjDumper> createELFDumper(const object::ELFObjectFileBase &Obj, 140 ScopedPrinter &Writer); 141 142 std::unique_ptr<ObjDumper> createMachODumper(const object::MachOObjectFile &Obj, 143 ScopedPrinter &Writer); 144 145 std::unique_ptr<ObjDumper> createWasmDumper(const object::WasmObjectFile &Obj, 146 ScopedPrinter &Writer); 147 148 std::unique_ptr<ObjDumper> createXCOFFDumper(const object::XCOFFObjectFile &Obj, 149 ScopedPrinter &Writer); 150 151 void dumpCOFFImportFile(const object::COFFImportFile *File, 152 ScopedPrinter &Writer); 153 154 void dumpCodeViewMergedTypes(ScopedPrinter &Writer, 155 ArrayRef<ArrayRef<uint8_t>> IpiRecords, 156 ArrayRef<ArrayRef<uint8_t>> TpiRecords); 157 158 } // namespace llvm 159 160 #endif 161