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>"),
43 static int ReturnValue = EXIT_SUCCESS;
47 static bool error(std::error_code EC) {
51 ReturnValue = EXIT_FAILURE;
52 outs() << "\nError reading file: " << EC.message() << ".\n";
59 static void reportError(StringRef Input, StringRef Message) {
63 errs() << Input << ": " << Message << "\n";
65 ReturnValue = EXIT_FAILURE;
68 static void reportError(StringRef Input, std::error_code EC) {
69 reportError(Input, EC.message());
72 static SmallVectorImpl<SectionRef> &getRelocSections(const ObjectFile *Obj,
73 const SectionRef &Sec) {
74 static bool MappingDone = false;
75 static std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
77 for (const SectionRef &Section : Obj->sections()) {
78 section_iterator Sec2 = Section.getRelocatedSection();
79 if (Sec2 != Obj->section_end())
80 SectionRelocMap[*Sec2].push_back(Section);
84 return SectionRelocMap[Sec];
87 static bool collectRelocatedSymbols(const ObjectFile *Obj,
88 const SectionRef &Sec, uint64_t SecAddress,
89 uint64_t SymAddress, uint64_t SymSize,
90 StringRef *I, StringRef *E) {
91 uint64_t SymOffset = SymAddress - SecAddress;
92 uint64_t SymEnd = SymOffset + SymSize;
93 for (const SectionRef &SR : getRelocSections(Obj, Sec)) {
94 for (const object::RelocationRef &Reloc : SR.relocations()) {
97 const object::symbol_iterator RelocSymI = Reloc.getSymbol();
98 if (RelocSymI == Obj->symbol_end())
100 StringRef RelocSymName;
101 if (error(RelocSymI->getName(RelocSymName)))
103 uint64_t Offset = Reloc.getOffset();
104 if (Offset >= SymOffset && Offset < SymEnd) {
113 static bool collectRelocationOffsets(
114 const ObjectFile *Obj, const SectionRef &Sec, uint64_t SecAddress,
115 uint64_t SymAddress, uint64_t SymSize, StringRef SymName,
116 std::map<std::pair<StringRef, uint64_t>, StringRef> &Collection) {
117 uint64_t SymOffset = SymAddress - SecAddress;
118 uint64_t SymEnd = SymOffset + SymSize;
119 for (const SectionRef &SR : getRelocSections(Obj, Sec)) {
120 for (const object::RelocationRef &Reloc : SR.relocations()) {
121 const object::symbol_iterator RelocSymI = Reloc.getSymbol();
122 if (RelocSymI == Obj->symbol_end())
124 StringRef RelocSymName;
125 if (error(RelocSymI->getName(RelocSymName)))
127 uint64_t Offset = Reloc.getOffset();
128 if (Offset >= SymOffset && Offset < SymEnd)
129 Collection[std::make_pair(SymName, Offset - SymOffset)] = RelocSymName;
135 static void dumpCXXData(const ObjectFile *Obj) {
136 struct CompleteObjectLocator {
137 StringRef Symbols[2];
138 ArrayRef<little32_t> Data;
140 struct ClassHierarchyDescriptor {
141 StringRef Symbols[1];
142 ArrayRef<little32_t> Data;
144 struct BaseClassDescriptor {
145 StringRef Symbols[2];
146 ArrayRef<little32_t> Data;
148 struct TypeDescriptor {
149 StringRef Symbols[1];
151 StringRef MangledName;
156 struct CatchableTypeArray {
159 struct CatchableType {
161 uint32_t NonVirtualBaseAdjustmentOffset;
162 int32_t VirtualBasePointerOffset;
163 uint32_t VirtualBaseAdjustmentOffset;
165 StringRef Symbols[2];
167 std::map<std::pair<StringRef, uint64_t>, StringRef> VFTableEntries;
168 std::map<std::pair<StringRef, uint64_t>, StringRef> TIEntries;
169 std::map<std::pair<StringRef, uint64_t>, StringRef> CTAEntries;
170 std::map<StringRef, ArrayRef<little32_t>> VBTables;
171 std::map<StringRef, CompleteObjectLocator> COLs;
172 std::map<StringRef, ClassHierarchyDescriptor> CHDs;
173 std::map<std::pair<StringRef, uint64_t>, StringRef> BCAEntries;
174 std::map<StringRef, BaseClassDescriptor> BCDs;
175 std::map<StringRef, TypeDescriptor> TDs;
176 std::map<StringRef, ThrowInfo> TIs;
177 std::map<StringRef, CatchableTypeArray> CTAs;
178 std::map<StringRef, CatchableType> CTs;
180 std::map<std::pair<StringRef, uint64_t>, StringRef> VTableSymEntries;
181 std::map<std::pair<StringRef, uint64_t>, int64_t> VTableDataEntries;
182 std::map<std::pair<StringRef, uint64_t>, StringRef> VTTEntries;
183 std::map<StringRef, StringRef> TINames;
185 uint8_t BytesInAddress = Obj->getBytesInAddress();
187 std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
188 object::computeSymbolSizes(*Obj);
190 for (auto &P : SymAddr) {
191 object::SymbolRef Sym = P.first;
192 uint64_t SymSize = P.second;
194 if (error(Sym.getName(SymName)))
196 object::section_iterator SecI(Obj->section_begin());
197 if (error(Sym.getSection(SecI)))
199 // Skip external symbols.
200 if (SecI == Obj->section_end())
202 const SectionRef &Sec = *SecI;
203 // Skip virtual or BSS sections.
204 if (Sec.isBSS() || Sec.isVirtual())
206 StringRef SecContents;
207 if (error(Sec.getContents(SecContents)))
210 if (error(Sym.getAddress(SymAddress)))
212 uint64_t SecAddress = Sec.getAddress();
213 uint64_t SecSize = Sec.getSize();
214 uint64_t SymOffset = SymAddress - SecAddress;
215 StringRef SymContents = SecContents.substr(SymOffset, SymSize);
217 // VFTables in the MS-ABI start with '??_7' and are contained within their
218 // own COMDAT section. We then determine the contents of the VFTable by
219 // looking at each relocation in the section.
220 if (SymName.startswith("??_7")) {
221 // Each relocation either names a virtual method or a thunk. We note the
222 // offset into the section and the symbol used for the relocation.
223 collectRelocationOffsets(Obj, Sec, SecAddress, SecAddress, SecSize,
224 SymName, VFTableEntries);
226 // VBTables in the MS-ABI start with '??_8' and are filled with 32-bit
227 // offsets of virtual bases.
228 else if (SymName.startswith("??_8")) {
229 ArrayRef<little32_t> VBTableData(
230 reinterpret_cast<const little32_t *>(SymContents.data()),
231 SymContents.size() / sizeof(little32_t));
232 VBTables[SymName] = VBTableData;
234 // Complete object locators in the MS-ABI start with '??_R4'
235 else if (SymName.startswith("??_R4")) {
236 CompleteObjectLocator COL;
237 COL.Data = ArrayRef<little32_t>(
238 reinterpret_cast<const little32_t *>(SymContents.data()), 3);
239 StringRef *I = std::begin(COL.Symbols), *E = std::end(COL.Symbols);
240 if (collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I,
245 // Class hierarchy descriptors in the MS-ABI start with '??_R3'
246 else if (SymName.startswith("??_R3")) {
247 ClassHierarchyDescriptor CHD;
248 CHD.Data = ArrayRef<little32_t>(
249 reinterpret_cast<const little32_t *>(SymContents.data()), 3);
250 StringRef *I = std::begin(CHD.Symbols), *E = std::end(CHD.Symbols);
251 if (collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I,
256 // Class hierarchy descriptors in the MS-ABI start with '??_R2'
257 else if (SymName.startswith("??_R2")) {
258 // Each relocation names a base class descriptor. We note the offset into
259 // the section and the symbol used for the relocation.
260 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
261 SymName, BCAEntries);
263 // Base class descriptors in the MS-ABI start with '??_R1'
264 else if (SymName.startswith("??_R1")) {
265 BaseClassDescriptor BCD;
266 BCD.Data = ArrayRef<little32_t>(
267 reinterpret_cast<const little32_t *>(SymContents.data()) + 1, 5);
268 StringRef *I = std::begin(BCD.Symbols), *E = std::end(BCD.Symbols);
269 if (collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I,
274 // Type descriptors in the MS-ABI start with '??_R0'
275 else if (SymName.startswith("??_R0")) {
276 const char *DataPtr = SymContents.drop_front(BytesInAddress).data();
278 if (BytesInAddress == 8)
279 TD.AlwaysZero = *reinterpret_cast<const little64_t *>(DataPtr);
281 TD.AlwaysZero = *reinterpret_cast<const little32_t *>(DataPtr);
282 TD.MangledName = SymContents.drop_front(BytesInAddress * 2);
283 StringRef *I = std::begin(TD.Symbols), *E = std::end(TD.Symbols);
284 if (collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I,
289 // Throw descriptors in the MS-ABI start with '_TI'
290 else if (SymName.startswith("_TI") || SymName.startswith("__TI")) {
292 TI.Flags = *reinterpret_cast<const little32_t *>(SymContents.data());
293 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
297 // Catchable type arrays in the MS-ABI start with _CTA or __CTA.
298 else if (SymName.startswith("_CTA") || SymName.startswith("__CTA")) {
299 CatchableTypeArray CTA;
301 *reinterpret_cast<const little32_t *>(SymContents.data());
302 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
303 SymName, CTAEntries);
306 // Catchable types in the MS-ABI start with _CT or __CT.
307 else if (SymName.startswith("_CT") || SymName.startswith("__CT")) {
308 const little32_t *DataPtr =
309 reinterpret_cast<const little32_t *>(SymContents.data());
311 CT.Flags = DataPtr[0];
312 CT.NonVirtualBaseAdjustmentOffset = DataPtr[2];
313 CT.VirtualBasePointerOffset = DataPtr[3];
314 CT.VirtualBaseAdjustmentOffset = DataPtr[4];
315 CT.Size = DataPtr[5];
316 StringRef *I = std::begin(CT.Symbols), *E = std::end(CT.Symbols);
317 if (collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I,
322 // Construction vtables in the Itanium ABI start with '_ZTT' or '__ZTT'.
323 else if (SymName.startswith("_ZTT") || SymName.startswith("__ZTT")) {
324 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
325 SymName, VTTEntries);
327 // Typeinfo names in the Itanium ABI start with '_ZTS' or '__ZTS'.
328 else if (SymName.startswith("_ZTS") || SymName.startswith("__ZTS")) {
329 TINames[SymName] = SymContents.slice(0, SymContents.find('\0'));
331 // Vtables in the Itanium ABI start with '_ZTV' or '__ZTV'.
332 else if (SymName.startswith("_ZTV") || SymName.startswith("__ZTV")) {
333 collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
334 SymName, VTableSymEntries);
335 for (uint64_t SymOffI = 0; SymOffI < SymSize; SymOffI += BytesInAddress) {
336 auto Key = std::make_pair(SymName, SymOffI);
337 if (VTableSymEntries.count(Key))
339 const char *DataPtr =
340 SymContents.substr(SymOffI, BytesInAddress).data();
342 if (BytesInAddress == 8)
343 VData = *reinterpret_cast<const little64_t *>(DataPtr);
345 VData = *reinterpret_cast<const little32_t *>(DataPtr);
346 VTableDataEntries[Key] = VData;
349 // Typeinfo structures in the Itanium ABI start with '_ZTI' or '__ZTI'.
350 else if (SymName.startswith("_ZTI") || SymName.startswith("__ZTI")) {
351 // FIXME: Do something with these!
354 for (const auto &VFTableEntry : VFTableEntries) {
355 StringRef VFTableName = VFTableEntry.first.first;
356 uint64_t Offset = VFTableEntry.first.second;
357 StringRef SymName = VFTableEntry.second;
358 outs() << VFTableName << '[' << Offset << "]: " << SymName << '\n';
360 for (const auto &VBTable : VBTables) {
361 StringRef VBTableName = VBTable.first;
363 for (little32_t Offset : VBTable.second) {
364 outs() << VBTableName << '[' << Idx << "]: " << Offset << '\n';
365 Idx += sizeof(Offset);
368 for (const auto &COLPair : COLs) {
369 StringRef COLName = COLPair.first;
370 const CompleteObjectLocator &COL = COLPair.second;
371 outs() << COLName << "[IsImageRelative]: " << COL.Data[0] << '\n';
372 outs() << COLName << "[OffsetToTop]: " << COL.Data[1] << '\n';
373 outs() << COLName << "[VFPtrOffset]: " << COL.Data[2] << '\n';
374 outs() << COLName << "[TypeDescriptor]: " << COL.Symbols[0] << '\n';
375 outs() << COLName << "[ClassHierarchyDescriptor]: " << COL.Symbols[1]
378 for (const auto &CHDPair : CHDs) {
379 StringRef CHDName = CHDPair.first;
380 const ClassHierarchyDescriptor &CHD = CHDPair.second;
381 outs() << CHDName << "[AlwaysZero]: " << CHD.Data[0] << '\n';
382 outs() << CHDName << "[Flags]: " << CHD.Data[1] << '\n';
383 outs() << CHDName << "[NumClasses]: " << CHD.Data[2] << '\n';
384 outs() << CHDName << "[BaseClassArray]: " << CHD.Symbols[0] << '\n';
386 for (const auto &BCAEntry : BCAEntries) {
387 StringRef BCAName = BCAEntry.first.first;
388 uint64_t Offset = BCAEntry.first.second;
389 StringRef SymName = BCAEntry.second;
390 outs() << BCAName << '[' << Offset << "]: " << SymName << '\n';
392 for (const auto &BCDPair : BCDs) {
393 StringRef BCDName = BCDPair.first;
394 const BaseClassDescriptor &BCD = BCDPair.second;
395 outs() << BCDName << "[TypeDescriptor]: " << BCD.Symbols[0] << '\n';
396 outs() << BCDName << "[NumBases]: " << BCD.Data[0] << '\n';
397 outs() << BCDName << "[OffsetInVBase]: " << BCD.Data[1] << '\n';
398 outs() << BCDName << "[VBPtrOffset]: " << BCD.Data[2] << '\n';
399 outs() << BCDName << "[OffsetInVBTable]: " << BCD.Data[3] << '\n';
400 outs() << BCDName << "[Flags]: " << BCD.Data[4] << '\n';
401 outs() << BCDName << "[ClassHierarchyDescriptor]: " << BCD.Symbols[1]
404 for (const auto &TDPair : TDs) {
405 StringRef TDName = TDPair.first;
406 const TypeDescriptor &TD = TDPair.second;
407 outs() << TDName << "[VFPtr]: " << TD.Symbols[0] << '\n';
408 outs() << TDName << "[AlwaysZero]: " << TD.AlwaysZero << '\n';
409 outs() << TDName << "[MangledName]: ";
410 outs().write_escaped(TD.MangledName.rtrim(StringRef("\0", 1)),
411 /*UseHexEscapes=*/true)
414 for (const auto &TIPair : TIs) {
415 StringRef TIName = TIPair.first;
416 const ThrowInfo &TI = TIPair.second;
417 auto dumpThrowInfoFlag = [&](const char *Name, uint32_t Flag) {
418 outs() << TIName << "[Flags." << Name
419 << "]: " << (TI.Flags & Flag ? "true" : "false") << '\n';
421 auto dumpThrowInfoSymbol = [&](const char *Name, int Offset) {
422 outs() << TIName << '[' << Name << "]: ";
423 auto Entry = TIEntries.find(std::make_pair(TIName, Offset));
424 outs() << (Entry == TIEntries.end() ? "null" : Entry->second) << '\n';
426 outs() << TIName << "[Flags]: " << TI.Flags << '\n';
427 dumpThrowInfoFlag("Const", 1);
428 dumpThrowInfoFlag("Volatile", 2);
429 dumpThrowInfoSymbol("CleanupFn", 4);
430 dumpThrowInfoSymbol("ForwardCompat", 8);
431 dumpThrowInfoSymbol("CatchableTypeArray", 12);
433 for (const auto &CTAPair : CTAs) {
434 StringRef CTAName = CTAPair.first;
435 const CatchableTypeArray &CTA = CTAPair.second;
437 outs() << CTAName << "[NumEntries]: " << CTA.NumEntries << '\n';
440 for (auto I = CTAEntries.lower_bound(std::make_pair(CTAName, 0)),
441 E = CTAEntries.upper_bound(std::make_pair(CTAName, UINT64_MAX));
443 outs() << CTAName << '[' << Idx++ << "]: " << I->second << '\n';
445 for (const auto &CTPair : CTs) {
446 StringRef CTName = CTPair.first;
447 const CatchableType &CT = CTPair.second;
448 auto dumpCatchableTypeFlag = [&](const char *Name, uint32_t Flag) {
449 outs() << CTName << "[Flags." << Name
450 << "]: " << (CT.Flags & Flag ? "true" : "false") << '\n';
452 outs() << CTName << "[Flags]: " << CT.Flags << '\n';
453 dumpCatchableTypeFlag("ScalarType", 1);
454 dumpCatchableTypeFlag("VirtualInheritance", 4);
455 outs() << CTName << "[TypeDescriptor]: " << CT.Symbols[0] << '\n';
456 outs() << CTName << "[NonVirtualBaseAdjustmentOffset]: "
457 << CT.NonVirtualBaseAdjustmentOffset << '\n';
459 << "[VirtualBasePointerOffset]: " << CT.VirtualBasePointerOffset
461 outs() << CTName << "[VirtualBaseAdjustmentOffset]: "
462 << CT.VirtualBaseAdjustmentOffset << '\n';
463 outs() << CTName << "[Size]: " << CT.Size << '\n';
465 << "[CopyCtor]: " << (CT.Symbols[1].empty() ? "null" : CT.Symbols[1])
468 for (const auto &VTTPair : VTTEntries) {
469 StringRef VTTName = VTTPair.first.first;
470 uint64_t VTTOffset = VTTPair.first.second;
471 StringRef VTTEntry = VTTPair.second;
472 outs() << VTTName << '[' << VTTOffset << "]: " << VTTEntry << '\n';
474 for (const auto &TIPair : TINames) {
475 StringRef TIName = TIPair.first;
476 outs() << TIName << ": " << TIPair.second << '\n';
478 auto VTableSymI = VTableSymEntries.begin();
479 auto VTableSymE = VTableSymEntries.end();
480 auto VTableDataI = VTableDataEntries.begin();
481 auto VTableDataE = VTableDataEntries.end();
483 bool SymDone = VTableSymI == VTableSymE;
484 bool DataDone = VTableDataI == VTableDataE;
485 if (SymDone && DataDone)
487 if (!SymDone && (DataDone || VTableSymI->first < VTableDataI->first)) {
488 StringRef VTableName = VTableSymI->first.first;
489 uint64_t Offset = VTableSymI->first.second;
490 StringRef VTableEntry = VTableSymI->second;
491 outs() << VTableName << '[' << Offset << "]: ";
492 outs() << VTableEntry;
497 if (!DataDone && (SymDone || VTableDataI->first < VTableSymI->first)) {
498 StringRef VTableName = VTableDataI->first.first;
499 uint64_t Offset = VTableDataI->first.second;
500 int64_t VTableEntry = VTableDataI->second;
501 outs() << VTableName << '[' << Offset << "]: ";
502 outs() << VTableEntry;
510 static void dumpArchive(const Archive *Arc) {
511 for (const Archive::Child &ArcC : Arc->children()) {
512 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = ArcC.getAsBinary();
513 if (std::error_code EC = ChildOrErr.getError()) {
514 // Ignore non-object files.
515 if (EC != object_error::invalid_file_type)
516 reportError(Arc->getFileName(), EC.message());
520 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
523 reportError(Arc->getFileName(), cxxdump_error::unrecognized_file_format);
527 static void dumpInput(StringRef File) {
528 // If file isn't stdin, check that it exists.
529 if (File != "-" && !sys::fs::exists(File)) {
530 reportError(File, cxxdump_error::file_not_found);
534 // Attempt to open the binary.
535 ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
536 if (std::error_code EC = BinaryOrErr.getError()) {
537 reportError(File, EC);
540 Binary &Binary = *BinaryOrErr.get().getBinary();
542 if (Archive *Arc = dyn_cast<Archive>(&Binary))
544 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
547 reportError(File, cxxdump_error::unrecognized_file_format);
550 int main(int argc, const char *argv[]) {
551 sys::PrintStackTraceOnErrorSignal();
552 PrettyStackTraceProgram X(argc, argv);
555 // Initialize targets.
556 llvm::InitializeAllTargetInfos();
558 // Register the target printer for --version.
559 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
561 cl::ParseCommandLineOptions(argc, argv, "LLVM C++ ABI Data Dumper\n");
563 // Default to stdin if no filename is specified.
564 if (opts::InputFilenames.size() == 0)
565 opts::InputFilenames.push_back("-");
567 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),