1 //===- llvm-cxxdump.cpp - Dump C++ data in an Object File -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Dumps C++ data resident in object files and archives.
12 //===----------------------------------------------------------------------===//
14 #include "llvm-cxxdump.h"
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/Object/Archive.h"
18 #include "llvm/Object/ObjectFile.h"
19 #include "llvm/Object/SymbolSize.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/Endian.h"
22 #include "llvm/Support/FileSystem.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/PrettyStackTrace.h"
25 #include "llvm/Support/Signals.h"
26 #include "llvm/Support/TargetRegistry.h"
27 #include "llvm/Support/TargetSelect.h"
28 #include "llvm/Support/raw_ostream.h"
31 #include <system_error>
34 using namespace llvm::object;
35 using namespace llvm::support;
38 cl::list<std::string> InputFilenames(cl::Positional,
39 cl::desc("<input object files>"),
45 static void error(std::error_code EC) {
48 outs() << "\nError reading file: " << EC.message() << ".\n";
55 static void reportError(StringRef Input, StringRef Message) {
58 errs() << Input << ": " << Message << "\n";
63 static void reportError(StringRef Input, std::error_code EC) {
64 reportError(Input, EC.message());
67 static SmallVectorImpl<SectionRef> &getRelocSections(const ObjectFile *Obj,
68 const SectionRef &Sec) {
69 static bool MappingDone = false;
70 static std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
72 for (const SectionRef &Section : Obj->sections()) {
73 section_iterator Sec2 = Section.getRelocatedSection();
74 if (Sec2 != Obj->section_end())
75 SectionRelocMap[*Sec2].push_back(Section);
79 return SectionRelocMap[Sec];
82 static void collectRelocatedSymbols(const ObjectFile *Obj,
83 const SectionRef &Sec, uint64_t SecAddress,
84 uint64_t SymAddress, uint64_t SymSize,
85 StringRef *I, StringRef *E) {
86 uint64_t SymOffset = SymAddress - SecAddress;
87 uint64_t SymEnd = SymOffset + SymSize;
88 for (const SectionRef &SR : getRelocSections(Obj, Sec)) {
89 for (const object::RelocationRef &Reloc : SR.relocations()) {
92 const object::symbol_iterator RelocSymI = Reloc.getSymbol();
93 if (RelocSymI == Obj->symbol_end())
95 ErrorOr<StringRef> RelocSymName = RelocSymI->getName();
96 error(RelocSymName.getError());
97 uint64_t Offset = Reloc.getOffset();
98 if (Offset >= SymOffset && Offset < SymEnd) {
106 static void collectRelocationOffsets(
107 const ObjectFile *Obj, const SectionRef &Sec, uint64_t SecAddress,
108 uint64_t SymAddress, uint64_t SymSize, StringRef SymName,
109 std::map<std::pair<StringRef, uint64_t>, StringRef> &Collection) {
110 uint64_t SymOffset = SymAddress - SecAddress;
111 uint64_t SymEnd = SymOffset + SymSize;
112 for (const SectionRef &SR : getRelocSections(Obj, Sec)) {
113 for (const object::RelocationRef &Reloc : SR.relocations()) {
114 const object::symbol_iterator RelocSymI = Reloc.getSymbol();
115 if (RelocSymI == Obj->symbol_end())
117 ErrorOr<StringRef> RelocSymName = RelocSymI->getName();
118 error(RelocSymName.getError());
119 uint64_t Offset = Reloc.getOffset();
120 if (Offset >= SymOffset && Offset < SymEnd)
121 Collection[std::make_pair(SymName, Offset - SymOffset)] = *RelocSymName;
126 static void dumpCXXData(const ObjectFile *Obj) {
127 struct CompleteObjectLocator {
128 StringRef Symbols[2];
129 ArrayRef<little32_t> Data;
131 struct ClassHierarchyDescriptor {
132 StringRef Symbols[1];
133 ArrayRef<little32_t> Data;
135 struct BaseClassDescriptor {
136 StringRef Symbols[2];
137 ArrayRef<little32_t> Data;
139 struct TypeDescriptor {
140 StringRef Symbols[1];
142 StringRef MangledName;
147 struct CatchableTypeArray {
150 struct CatchableType {
152 uint32_t NonVirtualBaseAdjustmentOffset;
153 int32_t VirtualBasePointerOffset;
154 uint32_t VirtualBaseAdjustmentOffset;
156 StringRef Symbols[2];
158 std::map<std::pair<StringRef, uint64_t>, StringRef> VFTableEntries;
159 std::map<std::pair<StringRef, uint64_t>, StringRef> TIEntries;
160 std::map<std::pair<StringRef, uint64_t>, StringRef> CTAEntries;
161 std::map<StringRef, ArrayRef<little32_t>> VBTables;
162 std::map<StringRef, CompleteObjectLocator> COLs;
163 std::map<StringRef, ClassHierarchyDescriptor> CHDs;
164 std::map<std::pair<StringRef, uint64_t>, StringRef> BCAEntries;
165 std::map<StringRef, BaseClassDescriptor> BCDs;
166 std::map<StringRef, TypeDescriptor> TDs;
167 std::map<StringRef, ThrowInfo> TIs;
168 std::map<StringRef, CatchableTypeArray> CTAs;
169 std::map<StringRef, CatchableType> CTs;
171 std::map<std::pair<StringRef, uint64_t>, StringRef> VTableSymEntries;
172 std::map<std::pair<StringRef, uint64_t>, int64_t> VTableDataEntries;
173 std::map<std::pair<StringRef, uint64_t>, StringRef> VTTEntries;
174 std::map<StringRef, StringRef> TINames;
176 uint8_t BytesInAddress = Obj->getBytesInAddress();
178 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
179 object::computeSymbolSizes(*Obj);
181 for (auto &P : SymAddr) {
182 object::SymbolRef Sym = P.first;
183 uint64_t SymSize = P.second;
184 ErrorOr<StringRef> SymNameOrErr = Sym.getName();
185 error(SymNameOrErr.getError());
186 StringRef SymName = *SymNameOrErr;
187 object::section_iterator SecI(Obj->section_begin());
188 error(Sym.getSection(SecI));
189 // Skip external symbols.
190 if (SecI == Obj->section_end())
192 const SectionRef &Sec = *SecI;
193 // Skip virtual or BSS sections.
194 if (Sec.isBSS() || Sec.isVirtual())
196 StringRef SecContents;
197 error(Sec.getContents(SecContents));
198 ErrorOr<uint64_t> SymAddressOrErr = Sym.getAddress();
199 error(SymAddressOrErr.getError());
200 uint64_t SymAddress = *SymAddressOrErr;
201 uint64_t SecAddress = Sec.getAddress();
202 uint64_t SecSize = Sec.getSize();
203 uint64_t SymOffset = SymAddress - SecAddress;
204 StringRef SymContents = SecContents.substr(SymOffset, SymSize);
206 // VFTables in the MS-ABI start with '??_7' and are contained within their
207 // own COMDAT section. We then determine the contents of the VFTable by
208 // looking at each relocation in the section.
209 if (SymName.startswith("??_7")) {
210 // Each relocation either names a virtual method or a thunk. We note the
211 // offset into the section and the symbol used for the relocation.
212 collectRelocationOffsets(Obj, Sec, SecAddress, SecAddress, SecSize,
213 SymName, VFTableEntries);
215 // VBTables in the MS-ABI start with '??_8' and are filled with 32-bit
216 // offsets of virtual bases.
217 else if (SymName.startswith("??_8")) {
218 ArrayRef<little32_t> VBTableData(
219 reinterpret_cast<const little32_t *>(SymContents.data()),
220 SymContents.size() / sizeof(little32_t));
221 VBTables[SymName] = VBTableData;
223 // Complete object locators in the MS-ABI start with '??_R4'
224 else if (SymName.startswith("??_R4")) {
225 CompleteObjectLocator COL;
226 COL.Data = ArrayRef<little32_t>(
227 reinterpret_cast<const little32_t *>(SymContents.data()), 3);
228 StringRef *I = std::begin(COL.Symbols), *E = std::end(COL.Symbols);
229 collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
232 // Class hierarchy descriptors in the MS-ABI start with '??_R3'
233 else if (SymName.startswith("??_R3")) {
234 ClassHierarchyDescriptor CHD;
235 CHD.Data = ArrayRef<little32_t>(
236 reinterpret_cast<const little32_t *>(SymContents.data()), 3);
237 StringRef *I = std::begin(CHD.Symbols), *E = std::end(CHD.Symbols);
238 collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
241 // Class hierarchy descriptors in the MS-ABI start with '??_R2'
242 else if (SymName.startswith("??_R2")) {
243 // Each relocation names a base class descriptor. We note the offset into
244 // the section and the symbol used for the relocation.
245 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
246 SymName, BCAEntries);
248 // Base class descriptors in the MS-ABI start with '??_R1'
249 else if (SymName.startswith("??_R1")) {
250 BaseClassDescriptor BCD;
251 BCD.Data = ArrayRef<little32_t>(
252 reinterpret_cast<const little32_t *>(SymContents.data()) + 1, 5);
253 StringRef *I = std::begin(BCD.Symbols), *E = std::end(BCD.Symbols);
254 collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
257 // Type descriptors in the MS-ABI start with '??_R0'
258 else if (SymName.startswith("??_R0")) {
259 const char *DataPtr = SymContents.drop_front(BytesInAddress).data();
261 if (BytesInAddress == 8)
262 TD.AlwaysZero = *reinterpret_cast<const little64_t *>(DataPtr);
264 TD.AlwaysZero = *reinterpret_cast<const little32_t *>(DataPtr);
265 TD.MangledName = SymContents.drop_front(BytesInAddress * 2);
266 StringRef *I = std::begin(TD.Symbols), *E = std::end(TD.Symbols);
267 collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
270 // Throw descriptors in the MS-ABI start with '_TI'
271 else if (SymName.startswith("_TI") || SymName.startswith("__TI")) {
273 TI.Flags = *reinterpret_cast<const little32_t *>(SymContents.data());
274 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
278 // Catchable type arrays in the MS-ABI start with _CTA or __CTA.
279 else if (SymName.startswith("_CTA") || SymName.startswith("__CTA")) {
280 CatchableTypeArray CTA;
282 *reinterpret_cast<const little32_t *>(SymContents.data());
283 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
284 SymName, CTAEntries);
287 // Catchable types in the MS-ABI start with _CT or __CT.
288 else if (SymName.startswith("_CT") || SymName.startswith("__CT")) {
289 const little32_t *DataPtr =
290 reinterpret_cast<const little32_t *>(SymContents.data());
292 CT.Flags = DataPtr[0];
293 CT.NonVirtualBaseAdjustmentOffset = DataPtr[2];
294 CT.VirtualBasePointerOffset = DataPtr[3];
295 CT.VirtualBaseAdjustmentOffset = DataPtr[4];
296 CT.Size = DataPtr[5];
297 StringRef *I = std::begin(CT.Symbols), *E = std::end(CT.Symbols);
298 collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
301 // Construction vtables in the Itanium ABI start with '_ZTT' or '__ZTT'.
302 else if (SymName.startswith("_ZTT") || SymName.startswith("__ZTT")) {
303 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
304 SymName, VTTEntries);
306 // Typeinfo names in the Itanium ABI start with '_ZTS' or '__ZTS'.
307 else if (SymName.startswith("_ZTS") || SymName.startswith("__ZTS")) {
308 TINames[SymName] = SymContents.slice(0, SymContents.find('\0'));
310 // Vtables in the Itanium ABI start with '_ZTV' or '__ZTV'.
311 else if (SymName.startswith("_ZTV") || SymName.startswith("__ZTV")) {
312 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
313 SymName, VTableSymEntries);
314 for (uint64_t SymOffI = 0; SymOffI < SymSize; SymOffI += BytesInAddress) {
315 auto Key = std::make_pair(SymName, SymOffI);
316 if (VTableSymEntries.count(Key))
318 const char *DataPtr =
319 SymContents.substr(SymOffI, BytesInAddress).data();
321 if (BytesInAddress == 8)
322 VData = *reinterpret_cast<const little64_t *>(DataPtr);
324 VData = *reinterpret_cast<const little32_t *>(DataPtr);
325 VTableDataEntries[Key] = VData;
328 // Typeinfo structures in the Itanium ABI start with '_ZTI' or '__ZTI'.
329 else if (SymName.startswith("_ZTI") || SymName.startswith("__ZTI")) {
330 // FIXME: Do something with these!
333 for (const auto &VFTableEntry : VFTableEntries) {
334 StringRef VFTableName = VFTableEntry.first.first;
335 uint64_t Offset = VFTableEntry.first.second;
336 StringRef SymName = VFTableEntry.second;
337 outs() << VFTableName << '[' << Offset << "]: " << SymName << '\n';
339 for (const auto &VBTable : VBTables) {
340 StringRef VBTableName = VBTable.first;
342 for (little32_t Offset : VBTable.second) {
343 outs() << VBTableName << '[' << Idx << "]: " << Offset << '\n';
344 Idx += sizeof(Offset);
347 for (const auto &COLPair : COLs) {
348 StringRef COLName = COLPair.first;
349 const CompleteObjectLocator &COL = COLPair.second;
350 outs() << COLName << "[IsImageRelative]: " << COL.Data[0] << '\n';
351 outs() << COLName << "[OffsetToTop]: " << COL.Data[1] << '\n';
352 outs() << COLName << "[VFPtrOffset]: " << COL.Data[2] << '\n';
353 outs() << COLName << "[TypeDescriptor]: " << COL.Symbols[0] << '\n';
354 outs() << COLName << "[ClassHierarchyDescriptor]: " << COL.Symbols[1]
357 for (const auto &CHDPair : CHDs) {
358 StringRef CHDName = CHDPair.first;
359 const ClassHierarchyDescriptor &CHD = CHDPair.second;
360 outs() << CHDName << "[AlwaysZero]: " << CHD.Data[0] << '\n';
361 outs() << CHDName << "[Flags]: " << CHD.Data[1] << '\n';
362 outs() << CHDName << "[NumClasses]: " << CHD.Data[2] << '\n';
363 outs() << CHDName << "[BaseClassArray]: " << CHD.Symbols[0] << '\n';
365 for (const auto &BCAEntry : BCAEntries) {
366 StringRef BCAName = BCAEntry.first.first;
367 uint64_t Offset = BCAEntry.first.second;
368 StringRef SymName = BCAEntry.second;
369 outs() << BCAName << '[' << Offset << "]: " << SymName << '\n';
371 for (const auto &BCDPair : BCDs) {
372 StringRef BCDName = BCDPair.first;
373 const BaseClassDescriptor &BCD = BCDPair.second;
374 outs() << BCDName << "[TypeDescriptor]: " << BCD.Symbols[0] << '\n';
375 outs() << BCDName << "[NumBases]: " << BCD.Data[0] << '\n';
376 outs() << BCDName << "[OffsetInVBase]: " << BCD.Data[1] << '\n';
377 outs() << BCDName << "[VBPtrOffset]: " << BCD.Data[2] << '\n';
378 outs() << BCDName << "[OffsetInVBTable]: " << BCD.Data[3] << '\n';
379 outs() << BCDName << "[Flags]: " << BCD.Data[4] << '\n';
380 outs() << BCDName << "[ClassHierarchyDescriptor]: " << BCD.Symbols[1]
383 for (const auto &TDPair : TDs) {
384 StringRef TDName = TDPair.first;
385 const TypeDescriptor &TD = TDPair.second;
386 outs() << TDName << "[VFPtr]: " << TD.Symbols[0] << '\n';
387 outs() << TDName << "[AlwaysZero]: " << TD.AlwaysZero << '\n';
388 outs() << TDName << "[MangledName]: ";
389 outs().write_escaped(TD.MangledName.rtrim(StringRef("\0", 1)),
390 /*UseHexEscapes=*/true)
393 for (const auto &TIPair : TIs) {
394 StringRef TIName = TIPair.first;
395 const ThrowInfo &TI = TIPair.second;
396 auto dumpThrowInfoFlag = [&](const char *Name, uint32_t Flag) {
397 outs() << TIName << "[Flags." << Name
398 << "]: " << (TI.Flags & Flag ? "true" : "false") << '\n';
400 auto dumpThrowInfoSymbol = [&](const char *Name, int Offset) {
401 outs() << TIName << '[' << Name << "]: ";
402 auto Entry = TIEntries.find(std::make_pair(TIName, Offset));
403 outs() << (Entry == TIEntries.end() ? "null" : Entry->second) << '\n';
405 outs() << TIName << "[Flags]: " << TI.Flags << '\n';
406 dumpThrowInfoFlag("Const", 1);
407 dumpThrowInfoFlag("Volatile", 2);
408 dumpThrowInfoSymbol("CleanupFn", 4);
409 dumpThrowInfoSymbol("ForwardCompat", 8);
410 dumpThrowInfoSymbol("CatchableTypeArray", 12);
412 for (const auto &CTAPair : CTAs) {
413 StringRef CTAName = CTAPair.first;
414 const CatchableTypeArray &CTA = CTAPair.second;
416 outs() << CTAName << "[NumEntries]: " << CTA.NumEntries << '\n';
419 for (auto I = CTAEntries.lower_bound(std::make_pair(CTAName, 0)),
420 E = CTAEntries.upper_bound(std::make_pair(CTAName, UINT64_MAX));
422 outs() << CTAName << '[' << Idx++ << "]: " << I->second << '\n';
424 for (const auto &CTPair : CTs) {
425 StringRef CTName = CTPair.first;
426 const CatchableType &CT = CTPair.second;
427 auto dumpCatchableTypeFlag = [&](const char *Name, uint32_t Flag) {
428 outs() << CTName << "[Flags." << Name
429 << "]: " << (CT.Flags & Flag ? "true" : "false") << '\n';
431 outs() << CTName << "[Flags]: " << CT.Flags << '\n';
432 dumpCatchableTypeFlag("ScalarType", 1);
433 dumpCatchableTypeFlag("VirtualInheritance", 4);
434 outs() << CTName << "[TypeDescriptor]: " << CT.Symbols[0] << '\n';
435 outs() << CTName << "[NonVirtualBaseAdjustmentOffset]: "
436 << CT.NonVirtualBaseAdjustmentOffset << '\n';
438 << "[VirtualBasePointerOffset]: " << CT.VirtualBasePointerOffset
440 outs() << CTName << "[VirtualBaseAdjustmentOffset]: "
441 << CT.VirtualBaseAdjustmentOffset << '\n';
442 outs() << CTName << "[Size]: " << CT.Size << '\n';
444 << "[CopyCtor]: " << (CT.Symbols[1].empty() ? "null" : CT.Symbols[1])
447 for (const auto &VTTPair : VTTEntries) {
448 StringRef VTTName = VTTPair.first.first;
449 uint64_t VTTOffset = VTTPair.first.second;
450 StringRef VTTEntry = VTTPair.second;
451 outs() << VTTName << '[' << VTTOffset << "]: " << VTTEntry << '\n';
453 for (const auto &TIPair : TINames) {
454 StringRef TIName = TIPair.first;
455 outs() << TIName << ": " << TIPair.second << '\n';
457 auto VTableSymI = VTableSymEntries.begin();
458 auto VTableSymE = VTableSymEntries.end();
459 auto VTableDataI = VTableDataEntries.begin();
460 auto VTableDataE = VTableDataEntries.end();
462 bool SymDone = VTableSymI == VTableSymE;
463 bool DataDone = VTableDataI == VTableDataE;
464 if (SymDone && DataDone)
466 if (!SymDone && (DataDone || VTableSymI->first < VTableDataI->first)) {
467 StringRef VTableName = VTableSymI->first.first;
468 uint64_t Offset = VTableSymI->first.second;
469 StringRef VTableEntry = VTableSymI->second;
470 outs() << VTableName << '[' << Offset << "]: ";
471 outs() << VTableEntry;
476 if (!DataDone && (SymDone || VTableDataI->first < VTableSymI->first)) {
477 StringRef VTableName = VTableDataI->first.first;
478 uint64_t Offset = VTableDataI->first.second;
479 int64_t VTableEntry = VTableDataI->second;
480 outs() << VTableName << '[' << Offset << "]: ";
481 outs() << VTableEntry;
489 static void dumpArchive(const Archive *Arc) {
490 for (const Archive::Child &ArcC : Arc->children()) {
491 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = ArcC.getAsBinary();
492 if (std::error_code EC = ChildOrErr.getError()) {
493 // Ignore non-object files.
494 if (EC != object_error::invalid_file_type)
495 reportError(Arc->getFileName(), EC.message());
499 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
502 reportError(Arc->getFileName(), cxxdump_error::unrecognized_file_format);
506 static void dumpInput(StringRef File) {
507 // If file isn't stdin, check that it exists.
508 if (File != "-" && !sys::fs::exists(File)) {
509 reportError(File, cxxdump_error::file_not_found);
513 // Attempt to open the binary.
514 ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
515 if (std::error_code EC = BinaryOrErr.getError()) {
516 reportError(File, EC);
519 Binary &Binary = *BinaryOrErr.get().getBinary();
521 if (Archive *Arc = dyn_cast<Archive>(&Binary))
523 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
526 reportError(File, cxxdump_error::unrecognized_file_format);
529 int main(int argc, const char *argv[]) {
530 sys::PrintStackTraceOnErrorSignal();
531 PrettyStackTraceProgram X(argc, argv);
534 // Initialize targets.
535 llvm::InitializeAllTargetInfos();
537 // Register the target printer for --version.
538 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
540 cl::ParseCommandLineOptions(argc, argv, "LLVM C++ ABI Data Dumper\n");
542 // Default to stdin if no filename is specified.
543 if (opts::InputFilenames.size() == 0)
544 opts::InputFilenames.push_back("-");
546 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),