xref: /freebsd-src/contrib/llvm-project/llvm/tools/llvm-cxxdump/llvm-cxxdump.cpp (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
10b57cec5SDimitry Andric //===- llvm-cxxdump.cpp - Dump C++ data in an Object File -------*- C++ -*-===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // Dumps C++ data resident in object files and archives.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric 
130b57cec5SDimitry Andric #include "llvm-cxxdump.h"
140b57cec5SDimitry Andric #include "Error.h"
150b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
16349cc55cSDimitry Andric #include "llvm/MC/TargetRegistry.h"
170b57cec5SDimitry Andric #include "llvm/Object/Archive.h"
180b57cec5SDimitry Andric #include "llvm/Object/ObjectFile.h"
190b57cec5SDimitry Andric #include "llvm/Object/SymbolSize.h"
200b57cec5SDimitry Andric #include "llvm/Support/Debug.h"
210b57cec5SDimitry Andric #include "llvm/Support/Endian.h"
220b57cec5SDimitry Andric #include "llvm/Support/FileSystem.h"
230b57cec5SDimitry Andric #include "llvm/Support/InitLLVM.h"
240b57cec5SDimitry Andric #include "llvm/Support/TargetSelect.h"
250b57cec5SDimitry Andric #include "llvm/Support/WithColor.h"
260b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
270b57cec5SDimitry Andric #include <map>
280b57cec5SDimitry Andric #include <string>
290b57cec5SDimitry Andric #include <system_error>
300b57cec5SDimitry Andric 
310b57cec5SDimitry Andric using namespace llvm;
320b57cec5SDimitry Andric using namespace llvm::object;
330b57cec5SDimitry Andric using namespace llvm::support;
340b57cec5SDimitry Andric 
350b57cec5SDimitry Andric namespace opts {
36fe6060f1SDimitry Andric cl::OptionCategory CXXDumpCategory("CXX Dump Options");
370b57cec5SDimitry Andric cl::list<std::string> InputFilenames(cl::Positional,
380b57cec5SDimitry Andric                                      cl::desc("<input object files>"),
3981ad6265SDimitry Andric                                      cl::cat(CXXDumpCategory));
400b57cec5SDimitry Andric } // namespace opts
410b57cec5SDimitry Andric 
420b57cec5SDimitry Andric namespace llvm {
430b57cec5SDimitry Andric 
error(std::error_code EC)440b57cec5SDimitry Andric static void error(std::error_code EC) {
450b57cec5SDimitry Andric   if (!EC)
460b57cec5SDimitry Andric     return;
470b57cec5SDimitry Andric   WithColor::error(outs(), "") << "reading file: " << EC.message() << ".\n";
480b57cec5SDimitry Andric   outs().flush();
490b57cec5SDimitry Andric   exit(1);
500b57cec5SDimitry Andric }
510b57cec5SDimitry Andric 
error(Error Err)52349cc55cSDimitry Andric [[noreturn]] static void error(Error Err) {
530b57cec5SDimitry Andric   logAllUnhandledErrors(std::move(Err), WithColor::error(outs()),
540b57cec5SDimitry Andric                         "reading file: ");
550b57cec5SDimitry Andric   outs().flush();
560b57cec5SDimitry Andric   exit(1);
570b57cec5SDimitry Andric }
580b57cec5SDimitry Andric 
590b57cec5SDimitry Andric template <typename T>
unwrapOrError(Expected<T> EO)600b57cec5SDimitry Andric T unwrapOrError(Expected<T> EO) {
610b57cec5SDimitry Andric   if (!EO)
620b57cec5SDimitry Andric     error(EO.takeError());
630b57cec5SDimitry Andric   return std::move(*EO);
640b57cec5SDimitry Andric }
650b57cec5SDimitry Andric 
660b57cec5SDimitry Andric } // namespace llvm
670b57cec5SDimitry Andric 
reportError(StringRef Input,StringRef Message)680b57cec5SDimitry Andric static void reportError(StringRef Input, StringRef Message) {
690b57cec5SDimitry Andric   if (Input == "-")
700b57cec5SDimitry Andric     Input = "<stdin>";
710b57cec5SDimitry Andric   WithColor::error(errs(), Input) << Message << "\n";
720b57cec5SDimitry Andric   errs().flush();
730b57cec5SDimitry Andric   exit(1);
740b57cec5SDimitry Andric }
750b57cec5SDimitry Andric 
reportError(StringRef Input,std::error_code EC)760b57cec5SDimitry Andric static void reportError(StringRef Input, std::error_code EC) {
770b57cec5SDimitry Andric   reportError(Input, EC.message());
780b57cec5SDimitry Andric }
790b57cec5SDimitry Andric 
800b57cec5SDimitry Andric static std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
810b57cec5SDimitry Andric 
collectRelocatedSymbols(const ObjectFile * Obj,const SectionRef & Sec,uint64_t SecAddress,uint64_t SymAddress,uint64_t SymSize,StringRef * I,StringRef * E)820b57cec5SDimitry Andric static void collectRelocatedSymbols(const ObjectFile *Obj,
830b57cec5SDimitry Andric                                     const SectionRef &Sec, uint64_t SecAddress,
840b57cec5SDimitry Andric                                     uint64_t SymAddress, uint64_t SymSize,
850b57cec5SDimitry Andric                                     StringRef *I, StringRef *E) {
860b57cec5SDimitry Andric   uint64_t SymOffset = SymAddress - SecAddress;
870b57cec5SDimitry Andric   uint64_t SymEnd = SymOffset + SymSize;
880b57cec5SDimitry Andric   for (const SectionRef &SR : SectionRelocMap[Sec]) {
890b57cec5SDimitry Andric     for (const object::RelocationRef &Reloc : SR.relocations()) {
900b57cec5SDimitry Andric       if (I == E)
910b57cec5SDimitry Andric         break;
920b57cec5SDimitry Andric       const object::symbol_iterator RelocSymI = Reloc.getSymbol();
930b57cec5SDimitry Andric       if (RelocSymI == Obj->symbol_end())
940b57cec5SDimitry Andric         continue;
950b57cec5SDimitry Andric       Expected<StringRef> RelocSymName = RelocSymI->getName();
960b57cec5SDimitry Andric       error(errorToErrorCode(RelocSymName.takeError()));
970b57cec5SDimitry Andric       uint64_t Offset = Reloc.getOffset();
980b57cec5SDimitry Andric       if (Offset >= SymOffset && Offset < SymEnd) {
990b57cec5SDimitry Andric         *I = *RelocSymName;
1000b57cec5SDimitry Andric         ++I;
1010b57cec5SDimitry Andric       }
1020b57cec5SDimitry Andric     }
1030b57cec5SDimitry Andric   }
1040b57cec5SDimitry Andric }
1050b57cec5SDimitry Andric 
collectRelocationOffsets(const ObjectFile * Obj,const SectionRef & Sec,uint64_t SecAddress,uint64_t SymAddress,uint64_t SymSize,StringRef SymName,std::map<std::pair<StringRef,uint64_t>,StringRef> & Collection)1060b57cec5SDimitry Andric static void collectRelocationOffsets(
1070b57cec5SDimitry Andric     const ObjectFile *Obj, const SectionRef &Sec, uint64_t SecAddress,
1080b57cec5SDimitry Andric     uint64_t SymAddress, uint64_t SymSize, StringRef SymName,
1090b57cec5SDimitry Andric     std::map<std::pair<StringRef, uint64_t>, StringRef> &Collection) {
1100b57cec5SDimitry Andric   uint64_t SymOffset = SymAddress - SecAddress;
1110b57cec5SDimitry Andric   uint64_t SymEnd = SymOffset + SymSize;
1120b57cec5SDimitry Andric   for (const SectionRef &SR : SectionRelocMap[Sec]) {
1130b57cec5SDimitry Andric     for (const object::RelocationRef &Reloc : SR.relocations()) {
1140b57cec5SDimitry Andric       const object::symbol_iterator RelocSymI = Reloc.getSymbol();
1150b57cec5SDimitry Andric       if (RelocSymI == Obj->symbol_end())
1160b57cec5SDimitry Andric         continue;
1170b57cec5SDimitry Andric       Expected<StringRef> RelocSymName = RelocSymI->getName();
1180b57cec5SDimitry Andric       error(errorToErrorCode(RelocSymName.takeError()));
1190b57cec5SDimitry Andric       uint64_t Offset = Reloc.getOffset();
1200b57cec5SDimitry Andric       if (Offset >= SymOffset && Offset < SymEnd)
1210b57cec5SDimitry Andric         Collection[std::make_pair(SymName, Offset - SymOffset)] = *RelocSymName;
1220b57cec5SDimitry Andric     }
1230b57cec5SDimitry Andric   }
1240b57cec5SDimitry Andric }
1250b57cec5SDimitry Andric 
dumpCXXData(const ObjectFile * Obj)1260b57cec5SDimitry Andric static void dumpCXXData(const ObjectFile *Obj) {
1270b57cec5SDimitry Andric   struct CompleteObjectLocator {
1280b57cec5SDimitry Andric     StringRef Symbols[2];
1290b57cec5SDimitry Andric     ArrayRef<little32_t> Data;
1300b57cec5SDimitry Andric   };
1310b57cec5SDimitry Andric   struct ClassHierarchyDescriptor {
1320b57cec5SDimitry Andric     StringRef Symbols[1];
1330b57cec5SDimitry Andric     ArrayRef<little32_t> Data;
1340b57cec5SDimitry Andric   };
1350b57cec5SDimitry Andric   struct BaseClassDescriptor {
1360b57cec5SDimitry Andric     StringRef Symbols[2];
1370b57cec5SDimitry Andric     ArrayRef<little32_t> Data;
1380b57cec5SDimitry Andric   };
1390b57cec5SDimitry Andric   struct TypeDescriptor {
1400b57cec5SDimitry Andric     StringRef Symbols[1];
1410b57cec5SDimitry Andric     uint64_t AlwaysZero;
1420b57cec5SDimitry Andric     StringRef MangledName;
1430b57cec5SDimitry Andric   };
1440b57cec5SDimitry Andric   struct ThrowInfo {
1450b57cec5SDimitry Andric     uint32_t Flags;
1460b57cec5SDimitry Andric   };
1470b57cec5SDimitry Andric   struct CatchableTypeArray {
1480b57cec5SDimitry Andric     uint32_t NumEntries;
1490b57cec5SDimitry Andric   };
1500b57cec5SDimitry Andric   struct CatchableType {
1510b57cec5SDimitry Andric     uint32_t Flags;
1520b57cec5SDimitry Andric     uint32_t NonVirtualBaseAdjustmentOffset;
1530b57cec5SDimitry Andric     int32_t VirtualBasePointerOffset;
1540b57cec5SDimitry Andric     uint32_t VirtualBaseAdjustmentOffset;
1550b57cec5SDimitry Andric     uint32_t Size;
1560b57cec5SDimitry Andric     StringRef Symbols[2];
1570b57cec5SDimitry Andric   };
1580b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> VFTableEntries;
1590b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> TIEntries;
1600b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> CTAEntries;
1610b57cec5SDimitry Andric   std::map<StringRef, ArrayRef<little32_t>> VBTables;
1620b57cec5SDimitry Andric   std::map<StringRef, CompleteObjectLocator> COLs;
1630b57cec5SDimitry Andric   std::map<StringRef, ClassHierarchyDescriptor> CHDs;
1640b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> BCAEntries;
1650b57cec5SDimitry Andric   std::map<StringRef, BaseClassDescriptor> BCDs;
1660b57cec5SDimitry Andric   std::map<StringRef, TypeDescriptor> TDs;
1670b57cec5SDimitry Andric   std::map<StringRef, ThrowInfo> TIs;
1680b57cec5SDimitry Andric   std::map<StringRef, CatchableTypeArray> CTAs;
1690b57cec5SDimitry Andric   std::map<StringRef, CatchableType> CTs;
1700b57cec5SDimitry Andric 
1710b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> VTableSymEntries;
1720b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, int64_t> VTableDataEntries;
1730b57cec5SDimitry Andric   std::map<std::pair<StringRef, uint64_t>, StringRef> VTTEntries;
1740b57cec5SDimitry Andric   std::map<StringRef, StringRef> TINames;
1750b57cec5SDimitry Andric 
1760b57cec5SDimitry Andric   SectionRelocMap.clear();
1770b57cec5SDimitry Andric   for (const SectionRef &Section : Obj->sections()) {
1788bcb0991SDimitry Andric     Expected<section_iterator> ErrOrSec = Section.getRelocatedSection();
1798bcb0991SDimitry Andric     if (!ErrOrSec)
1808bcb0991SDimitry Andric       error(ErrOrSec.takeError());
1818bcb0991SDimitry Andric 
1828bcb0991SDimitry Andric     section_iterator Sec2 = *ErrOrSec;
1830b57cec5SDimitry Andric     if (Sec2 != Obj->section_end())
1840b57cec5SDimitry Andric       SectionRelocMap[*Sec2].push_back(Section);
1850b57cec5SDimitry Andric   }
1860b57cec5SDimitry Andric 
1870b57cec5SDimitry Andric   uint8_t BytesInAddress = Obj->getBytesInAddress();
1880b57cec5SDimitry Andric 
1890b57cec5SDimitry Andric   std::vector<std::pair<SymbolRef, uint64_t>> SymAddr =
1900b57cec5SDimitry Andric       object::computeSymbolSizes(*Obj);
1910b57cec5SDimitry Andric 
1920b57cec5SDimitry Andric   for (auto &P : SymAddr) {
1930b57cec5SDimitry Andric     object::SymbolRef Sym = P.first;
1940b57cec5SDimitry Andric     uint64_t SymSize = P.second;
1950b57cec5SDimitry Andric     Expected<StringRef> SymNameOrErr = Sym.getName();
1960b57cec5SDimitry Andric     error(errorToErrorCode(SymNameOrErr.takeError()));
1970b57cec5SDimitry Andric     StringRef SymName = *SymNameOrErr;
1980b57cec5SDimitry Andric     Expected<object::section_iterator> SecIOrErr = Sym.getSection();
1990b57cec5SDimitry Andric     error(errorToErrorCode(SecIOrErr.takeError()));
2000b57cec5SDimitry Andric     object::section_iterator SecI = *SecIOrErr;
2010b57cec5SDimitry Andric     // Skip external symbols.
2020b57cec5SDimitry Andric     if (SecI == Obj->section_end())
2030b57cec5SDimitry Andric       continue;
2040b57cec5SDimitry Andric     const SectionRef &Sec = *SecI;
2050b57cec5SDimitry Andric     // Skip virtual or BSS sections.
2060b57cec5SDimitry Andric     if (Sec.isBSS() || Sec.isVirtual())
2070b57cec5SDimitry Andric       continue;
2080b57cec5SDimitry Andric     StringRef SecContents = unwrapOrError(Sec.getContents());
2090b57cec5SDimitry Andric     Expected<uint64_t> SymAddressOrErr = Sym.getAddress();
2100b57cec5SDimitry Andric     error(errorToErrorCode(SymAddressOrErr.takeError()));
2110b57cec5SDimitry Andric     uint64_t SymAddress = *SymAddressOrErr;
2120b57cec5SDimitry Andric     uint64_t SecAddress = Sec.getAddress();
2130b57cec5SDimitry Andric     uint64_t SecSize = Sec.getSize();
2140b57cec5SDimitry Andric     uint64_t SymOffset = SymAddress - SecAddress;
2150b57cec5SDimitry Andric     StringRef SymContents = SecContents.substr(SymOffset, SymSize);
2160b57cec5SDimitry Andric 
2170b57cec5SDimitry Andric     // VFTables in the MS-ABI start with '??_7' and are contained within their
2180b57cec5SDimitry Andric     // own COMDAT section.  We then determine the contents of the VFTable by
2190b57cec5SDimitry Andric     // looking at each relocation in the section.
220*5f757f3fSDimitry Andric     if (SymName.starts_with("??_7")) {
2210b57cec5SDimitry Andric       // Each relocation either names a virtual method or a thunk.  We note the
2220b57cec5SDimitry Andric       // offset into the section and the symbol used for the relocation.
2230b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SecAddress, SecSize,
2240b57cec5SDimitry Andric                                SymName, VFTableEntries);
2250b57cec5SDimitry Andric     }
2260b57cec5SDimitry Andric     // VBTables in the MS-ABI start with '??_8' and are filled with 32-bit
2270b57cec5SDimitry Andric     // offsets of virtual bases.
228*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_8")) {
2290b57cec5SDimitry Andric       ArrayRef<little32_t> VBTableData(
2300b57cec5SDimitry Andric           reinterpret_cast<const little32_t *>(SymContents.data()),
2310b57cec5SDimitry Andric           SymContents.size() / sizeof(little32_t));
2320b57cec5SDimitry Andric       VBTables[SymName] = VBTableData;
2330b57cec5SDimitry Andric     }
2340b57cec5SDimitry Andric     // Complete object locators in the MS-ABI start with '??_R4'
235*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_R4")) {
2360b57cec5SDimitry Andric       CompleteObjectLocator COL;
237bdd1243dSDimitry Andric       COL.Data =
238bdd1243dSDimitry Andric           ArrayRef(reinterpret_cast<const little32_t *>(SymContents.data()), 3);
2390b57cec5SDimitry Andric       StringRef *I = std::begin(COL.Symbols), *E = std::end(COL.Symbols);
2400b57cec5SDimitry Andric       collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
2410b57cec5SDimitry Andric       COLs[SymName] = COL;
2420b57cec5SDimitry Andric     }
2430b57cec5SDimitry Andric     // Class hierarchy descriptors in the MS-ABI start with '??_R3'
244*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_R3")) {
2450b57cec5SDimitry Andric       ClassHierarchyDescriptor CHD;
246bdd1243dSDimitry Andric       CHD.Data =
247bdd1243dSDimitry Andric           ArrayRef(reinterpret_cast<const little32_t *>(SymContents.data()), 3);
2480b57cec5SDimitry Andric       StringRef *I = std::begin(CHD.Symbols), *E = std::end(CHD.Symbols);
2490b57cec5SDimitry Andric       collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
2500b57cec5SDimitry Andric       CHDs[SymName] = CHD;
2510b57cec5SDimitry Andric     }
2520b57cec5SDimitry Andric     // Class hierarchy descriptors in the MS-ABI start with '??_R2'
253*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_R2")) {
2540b57cec5SDimitry Andric       // Each relocation names a base class descriptor.  We note the offset into
2550b57cec5SDimitry Andric       // the section and the symbol used for the relocation.
2560b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
2570b57cec5SDimitry Andric                                SymName, BCAEntries);
2580b57cec5SDimitry Andric     }
2590b57cec5SDimitry Andric     // Base class descriptors in the MS-ABI start with '??_R1'
260*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_R1")) {
2610b57cec5SDimitry Andric       BaseClassDescriptor BCD;
262bdd1243dSDimitry Andric       BCD.Data = ArrayRef(
2630b57cec5SDimitry Andric           reinterpret_cast<const little32_t *>(SymContents.data()) + 1, 5);
2640b57cec5SDimitry Andric       StringRef *I = std::begin(BCD.Symbols), *E = std::end(BCD.Symbols);
2650b57cec5SDimitry Andric       collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
2660b57cec5SDimitry Andric       BCDs[SymName] = BCD;
2670b57cec5SDimitry Andric     }
2680b57cec5SDimitry Andric     // Type descriptors in the MS-ABI start with '??_R0'
269*5f757f3fSDimitry Andric     else if (SymName.starts_with("??_R0")) {
2700b57cec5SDimitry Andric       const char *DataPtr = SymContents.drop_front(BytesInAddress).data();
2710b57cec5SDimitry Andric       TypeDescriptor TD;
2720b57cec5SDimitry Andric       if (BytesInAddress == 8)
2730b57cec5SDimitry Andric         TD.AlwaysZero = *reinterpret_cast<const little64_t *>(DataPtr);
2740b57cec5SDimitry Andric       else
2750b57cec5SDimitry Andric         TD.AlwaysZero = *reinterpret_cast<const little32_t *>(DataPtr);
2760b57cec5SDimitry Andric       TD.MangledName = SymContents.drop_front(BytesInAddress * 2);
2770b57cec5SDimitry Andric       StringRef *I = std::begin(TD.Symbols), *E = std::end(TD.Symbols);
2780b57cec5SDimitry Andric       collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
2790b57cec5SDimitry Andric       TDs[SymName] = TD;
2800b57cec5SDimitry Andric     }
2810b57cec5SDimitry Andric     // Throw descriptors in the MS-ABI start with '_TI'
282*5f757f3fSDimitry Andric     else if (SymName.starts_with("_TI") || SymName.starts_with("__TI")) {
2830b57cec5SDimitry Andric       ThrowInfo TI;
2840b57cec5SDimitry Andric       TI.Flags = *reinterpret_cast<const little32_t *>(SymContents.data());
2850b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
2860b57cec5SDimitry Andric                                SymName, TIEntries);
2870b57cec5SDimitry Andric       TIs[SymName] = TI;
2880b57cec5SDimitry Andric     }
2890b57cec5SDimitry Andric     // Catchable type arrays in the MS-ABI start with _CTA or __CTA.
290*5f757f3fSDimitry Andric     else if (SymName.starts_with("_CTA") || SymName.starts_with("__CTA")) {
2910b57cec5SDimitry Andric       CatchableTypeArray CTA;
2920b57cec5SDimitry Andric       CTA.NumEntries =
2930b57cec5SDimitry Andric           *reinterpret_cast<const little32_t *>(SymContents.data());
2940b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
2950b57cec5SDimitry Andric                                SymName, CTAEntries);
2960b57cec5SDimitry Andric       CTAs[SymName] = CTA;
2970b57cec5SDimitry Andric     }
2980b57cec5SDimitry Andric     // Catchable types in the MS-ABI start with _CT or __CT.
299*5f757f3fSDimitry Andric     else if (SymName.starts_with("_CT") || SymName.starts_with("__CT")) {
3000b57cec5SDimitry Andric       const little32_t *DataPtr =
3010b57cec5SDimitry Andric           reinterpret_cast<const little32_t *>(SymContents.data());
3020b57cec5SDimitry Andric       CatchableType CT;
3030b57cec5SDimitry Andric       CT.Flags = DataPtr[0];
3040b57cec5SDimitry Andric       CT.NonVirtualBaseAdjustmentOffset = DataPtr[2];
3050b57cec5SDimitry Andric       CT.VirtualBasePointerOffset = DataPtr[3];
3060b57cec5SDimitry Andric       CT.VirtualBaseAdjustmentOffset = DataPtr[4];
3070b57cec5SDimitry Andric       CT.Size = DataPtr[5];
3080b57cec5SDimitry Andric       StringRef *I = std::begin(CT.Symbols), *E = std::end(CT.Symbols);
3090b57cec5SDimitry Andric       collectRelocatedSymbols(Obj, Sec, SecAddress, SymAddress, SymSize, I, E);
3100b57cec5SDimitry Andric       CTs[SymName] = CT;
3110b57cec5SDimitry Andric     }
3120b57cec5SDimitry Andric     // Construction vtables in the Itanium ABI start with '_ZTT' or '__ZTT'.
313*5f757f3fSDimitry Andric     else if (SymName.starts_with("_ZTT") || SymName.starts_with("__ZTT")) {
3140b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
3150b57cec5SDimitry Andric                                SymName, VTTEntries);
3160b57cec5SDimitry Andric     }
3170b57cec5SDimitry Andric     // Typeinfo names in the Itanium ABI start with '_ZTS' or '__ZTS'.
318*5f757f3fSDimitry Andric     else if (SymName.starts_with("_ZTS") || SymName.starts_with("__ZTS")) {
3190b57cec5SDimitry Andric       TINames[SymName] = SymContents.slice(0, SymContents.find('\0'));
3200b57cec5SDimitry Andric     }
3210b57cec5SDimitry Andric     // Vtables in the Itanium ABI start with '_ZTV' or '__ZTV'.
322*5f757f3fSDimitry Andric     else if (SymName.starts_with("_ZTV") || SymName.starts_with("__ZTV")) {
3230b57cec5SDimitry Andric       collectRelocationOffsets(Obj, Sec, SecAddress, SymAddress, SymSize,
3240b57cec5SDimitry Andric                                SymName, VTableSymEntries);
3250b57cec5SDimitry Andric       for (uint64_t SymOffI = 0; SymOffI < SymSize; SymOffI += BytesInAddress) {
3260b57cec5SDimitry Andric         auto Key = std::make_pair(SymName, SymOffI);
3270b57cec5SDimitry Andric         if (VTableSymEntries.count(Key))
3280b57cec5SDimitry Andric           continue;
3290b57cec5SDimitry Andric         const char *DataPtr =
3300b57cec5SDimitry Andric             SymContents.substr(SymOffI, BytesInAddress).data();
3310b57cec5SDimitry Andric         int64_t VData;
3320b57cec5SDimitry Andric         if (BytesInAddress == 8)
3330b57cec5SDimitry Andric           VData = *reinterpret_cast<const little64_t *>(DataPtr);
3340b57cec5SDimitry Andric         else
3350b57cec5SDimitry Andric           VData = *reinterpret_cast<const little32_t *>(DataPtr);
3360b57cec5SDimitry Andric         VTableDataEntries[Key] = VData;
3370b57cec5SDimitry Andric       }
3380b57cec5SDimitry Andric     }
3390b57cec5SDimitry Andric     // Typeinfo structures in the Itanium ABI start with '_ZTI' or '__ZTI'.
340*5f757f3fSDimitry Andric     else if (SymName.starts_with("_ZTI") || SymName.starts_with("__ZTI")) {
3410b57cec5SDimitry Andric       // FIXME: Do something with these!
3420b57cec5SDimitry Andric     }
3430b57cec5SDimitry Andric   }
3440b57cec5SDimitry Andric   for (const auto &VFTableEntry : VFTableEntries) {
3450b57cec5SDimitry Andric     StringRef VFTableName = VFTableEntry.first.first;
3460b57cec5SDimitry Andric     uint64_t Offset = VFTableEntry.first.second;
3470b57cec5SDimitry Andric     StringRef SymName = VFTableEntry.second;
3480b57cec5SDimitry Andric     outs() << VFTableName << '[' << Offset << "]: " << SymName << '\n';
3490b57cec5SDimitry Andric   }
3500b57cec5SDimitry Andric   for (const auto &VBTable : VBTables) {
3510b57cec5SDimitry Andric     StringRef VBTableName = VBTable.first;
3520b57cec5SDimitry Andric     uint32_t Idx = 0;
3530b57cec5SDimitry Andric     for (little32_t Offset : VBTable.second) {
3540b57cec5SDimitry Andric       outs() << VBTableName << '[' << Idx << "]: " << Offset << '\n';
3550b57cec5SDimitry Andric       Idx += sizeof(Offset);
3560b57cec5SDimitry Andric     }
3570b57cec5SDimitry Andric   }
3580b57cec5SDimitry Andric   for (const auto &COLPair : COLs) {
3590b57cec5SDimitry Andric     StringRef COLName = COLPair.first;
3600b57cec5SDimitry Andric     const CompleteObjectLocator &COL = COLPair.second;
3610b57cec5SDimitry Andric     outs() << COLName << "[IsImageRelative]: " << COL.Data[0] << '\n';
3620b57cec5SDimitry Andric     outs() << COLName << "[OffsetToTop]: " << COL.Data[1] << '\n';
3630b57cec5SDimitry Andric     outs() << COLName << "[VFPtrOffset]: " << COL.Data[2] << '\n';
3640b57cec5SDimitry Andric     outs() << COLName << "[TypeDescriptor]: " << COL.Symbols[0] << '\n';
3650b57cec5SDimitry Andric     outs() << COLName << "[ClassHierarchyDescriptor]: " << COL.Symbols[1]
3660b57cec5SDimitry Andric            << '\n';
3670b57cec5SDimitry Andric   }
3680b57cec5SDimitry Andric   for (const auto &CHDPair : CHDs) {
3690b57cec5SDimitry Andric     StringRef CHDName = CHDPair.first;
3700b57cec5SDimitry Andric     const ClassHierarchyDescriptor &CHD = CHDPair.second;
3710b57cec5SDimitry Andric     outs() << CHDName << "[AlwaysZero]: " << CHD.Data[0] << '\n';
3720b57cec5SDimitry Andric     outs() << CHDName << "[Flags]: " << CHD.Data[1] << '\n';
3730b57cec5SDimitry Andric     outs() << CHDName << "[NumClasses]: " << CHD.Data[2] << '\n';
3740b57cec5SDimitry Andric     outs() << CHDName << "[BaseClassArray]: " << CHD.Symbols[0] << '\n';
3750b57cec5SDimitry Andric   }
3760b57cec5SDimitry Andric   for (const auto &BCAEntry : BCAEntries) {
3770b57cec5SDimitry Andric     StringRef BCAName = BCAEntry.first.first;
3780b57cec5SDimitry Andric     uint64_t Offset = BCAEntry.first.second;
3790b57cec5SDimitry Andric     StringRef SymName = BCAEntry.second;
3800b57cec5SDimitry Andric     outs() << BCAName << '[' << Offset << "]: " << SymName << '\n';
3810b57cec5SDimitry Andric   }
3820b57cec5SDimitry Andric   for (const auto &BCDPair : BCDs) {
3830b57cec5SDimitry Andric     StringRef BCDName = BCDPair.first;
3840b57cec5SDimitry Andric     const BaseClassDescriptor &BCD = BCDPair.second;
3850b57cec5SDimitry Andric     outs() << BCDName << "[TypeDescriptor]: " << BCD.Symbols[0] << '\n';
3860b57cec5SDimitry Andric     outs() << BCDName << "[NumBases]: " << BCD.Data[0] << '\n';
3870b57cec5SDimitry Andric     outs() << BCDName << "[OffsetInVBase]: " << BCD.Data[1] << '\n';
3880b57cec5SDimitry Andric     outs() << BCDName << "[VBPtrOffset]: " << BCD.Data[2] << '\n';
3890b57cec5SDimitry Andric     outs() << BCDName << "[OffsetInVBTable]: " << BCD.Data[3] << '\n';
3900b57cec5SDimitry Andric     outs() << BCDName << "[Flags]: " << BCD.Data[4] << '\n';
3910b57cec5SDimitry Andric     outs() << BCDName << "[ClassHierarchyDescriptor]: " << BCD.Symbols[1]
3920b57cec5SDimitry Andric            << '\n';
3930b57cec5SDimitry Andric   }
3940b57cec5SDimitry Andric   for (const auto &TDPair : TDs) {
3950b57cec5SDimitry Andric     StringRef TDName = TDPair.first;
3960b57cec5SDimitry Andric     const TypeDescriptor &TD = TDPair.second;
3970b57cec5SDimitry Andric     outs() << TDName << "[VFPtr]: " << TD.Symbols[0] << '\n';
3980b57cec5SDimitry Andric     outs() << TDName << "[AlwaysZero]: " << TD.AlwaysZero << '\n';
3990b57cec5SDimitry Andric     outs() << TDName << "[MangledName]: ";
4000b57cec5SDimitry Andric     outs().write_escaped(TD.MangledName.rtrim(StringRef("\0", 1)),
4010b57cec5SDimitry Andric                          /*UseHexEscapes=*/true)
4020b57cec5SDimitry Andric         << '\n';
4030b57cec5SDimitry Andric   }
4040b57cec5SDimitry Andric   for (const auto &TIPair : TIs) {
4050b57cec5SDimitry Andric     StringRef TIName = TIPair.first;
4060b57cec5SDimitry Andric     const ThrowInfo &TI = TIPair.second;
4070b57cec5SDimitry Andric     auto dumpThrowInfoFlag = [&](const char *Name, uint32_t Flag) {
4080b57cec5SDimitry Andric       outs() << TIName << "[Flags." << Name
4090b57cec5SDimitry Andric              << "]: " << (TI.Flags & Flag ? "true" : "false") << '\n';
4100b57cec5SDimitry Andric     };
4110b57cec5SDimitry Andric     auto dumpThrowInfoSymbol = [&](const char *Name, int Offset) {
4120b57cec5SDimitry Andric       outs() << TIName << '[' << Name << "]: ";
4130b57cec5SDimitry Andric       auto Entry = TIEntries.find(std::make_pair(TIName, Offset));
4140b57cec5SDimitry Andric       outs() << (Entry == TIEntries.end() ? "null" : Entry->second) << '\n';
4150b57cec5SDimitry Andric     };
4160b57cec5SDimitry Andric     outs() << TIName << "[Flags]: " << TI.Flags << '\n';
4170b57cec5SDimitry Andric     dumpThrowInfoFlag("Const", 1);
4180b57cec5SDimitry Andric     dumpThrowInfoFlag("Volatile", 2);
4190b57cec5SDimitry Andric     dumpThrowInfoSymbol("CleanupFn", 4);
4200b57cec5SDimitry Andric     dumpThrowInfoSymbol("ForwardCompat", 8);
4210b57cec5SDimitry Andric     dumpThrowInfoSymbol("CatchableTypeArray", 12);
4220b57cec5SDimitry Andric   }
4230b57cec5SDimitry Andric   for (const auto &CTAPair : CTAs) {
4240b57cec5SDimitry Andric     StringRef CTAName = CTAPair.first;
4250b57cec5SDimitry Andric     const CatchableTypeArray &CTA = CTAPair.second;
4260b57cec5SDimitry Andric 
4270b57cec5SDimitry Andric     outs() << CTAName << "[NumEntries]: " << CTA.NumEntries << '\n';
4280b57cec5SDimitry Andric 
4290b57cec5SDimitry Andric     unsigned Idx = 0;
4300b57cec5SDimitry Andric     for (auto I = CTAEntries.lower_bound(std::make_pair(CTAName, 0)),
4310b57cec5SDimitry Andric               E = CTAEntries.upper_bound(std::make_pair(CTAName, UINT64_MAX));
4320b57cec5SDimitry Andric          I != E; ++I)
4330b57cec5SDimitry Andric       outs() << CTAName << '[' << Idx++ << "]: " << I->second << '\n';
4340b57cec5SDimitry Andric   }
4350b57cec5SDimitry Andric   for (const auto &CTPair : CTs) {
4360b57cec5SDimitry Andric     StringRef CTName = CTPair.first;
4370b57cec5SDimitry Andric     const CatchableType &CT = CTPair.second;
4380b57cec5SDimitry Andric     auto dumpCatchableTypeFlag = [&](const char *Name, uint32_t Flag) {
4390b57cec5SDimitry Andric       outs() << CTName << "[Flags." << Name
4400b57cec5SDimitry Andric              << "]: " << (CT.Flags & Flag ? "true" : "false") << '\n';
4410b57cec5SDimitry Andric     };
4420b57cec5SDimitry Andric     outs() << CTName << "[Flags]: " << CT.Flags << '\n';
4430b57cec5SDimitry Andric     dumpCatchableTypeFlag("ScalarType", 1);
4440b57cec5SDimitry Andric     dumpCatchableTypeFlag("VirtualInheritance", 4);
4450b57cec5SDimitry Andric     outs() << CTName << "[TypeDescriptor]: " << CT.Symbols[0] << '\n';
4460b57cec5SDimitry Andric     outs() << CTName << "[NonVirtualBaseAdjustmentOffset]: "
4470b57cec5SDimitry Andric            << CT.NonVirtualBaseAdjustmentOffset << '\n';
4480b57cec5SDimitry Andric     outs() << CTName
4490b57cec5SDimitry Andric            << "[VirtualBasePointerOffset]: " << CT.VirtualBasePointerOffset
4500b57cec5SDimitry Andric            << '\n';
4510b57cec5SDimitry Andric     outs() << CTName << "[VirtualBaseAdjustmentOffset]: "
4520b57cec5SDimitry Andric            << CT.VirtualBaseAdjustmentOffset << '\n';
4530b57cec5SDimitry Andric     outs() << CTName << "[Size]: " << CT.Size << '\n';
4540b57cec5SDimitry Andric     outs() << CTName
4550b57cec5SDimitry Andric            << "[CopyCtor]: " << (CT.Symbols[1].empty() ? "null" : CT.Symbols[1])
4560b57cec5SDimitry Andric            << '\n';
4570b57cec5SDimitry Andric   }
4580b57cec5SDimitry Andric   for (const auto &VTTPair : VTTEntries) {
4590b57cec5SDimitry Andric     StringRef VTTName = VTTPair.first.first;
4600b57cec5SDimitry Andric     uint64_t VTTOffset = VTTPair.first.second;
4610b57cec5SDimitry Andric     StringRef VTTEntry = VTTPair.second;
4620b57cec5SDimitry Andric     outs() << VTTName << '[' << VTTOffset << "]: " << VTTEntry << '\n';
4630b57cec5SDimitry Andric   }
4640b57cec5SDimitry Andric   for (const auto &TIPair : TINames) {
4650b57cec5SDimitry Andric     StringRef TIName = TIPair.first;
4660b57cec5SDimitry Andric     outs() << TIName << ": " << TIPair.second << '\n';
4670b57cec5SDimitry Andric   }
4680b57cec5SDimitry Andric   auto VTableSymI = VTableSymEntries.begin();
4690b57cec5SDimitry Andric   auto VTableSymE = VTableSymEntries.end();
4700b57cec5SDimitry Andric   auto VTableDataI = VTableDataEntries.begin();
4710b57cec5SDimitry Andric   auto VTableDataE = VTableDataEntries.end();
4720b57cec5SDimitry Andric   for (;;) {
4730b57cec5SDimitry Andric     bool SymDone = VTableSymI == VTableSymE;
4740b57cec5SDimitry Andric     bool DataDone = VTableDataI == VTableDataE;
4750b57cec5SDimitry Andric     if (SymDone && DataDone)
4760b57cec5SDimitry Andric       break;
4770b57cec5SDimitry Andric     if (!SymDone && (DataDone || VTableSymI->first < VTableDataI->first)) {
4780b57cec5SDimitry Andric       StringRef VTableName = VTableSymI->first.first;
4790b57cec5SDimitry Andric       uint64_t Offset = VTableSymI->first.second;
4800b57cec5SDimitry Andric       StringRef VTableEntry = VTableSymI->second;
4810b57cec5SDimitry Andric       outs() << VTableName << '[' << Offset << "]: ";
4820b57cec5SDimitry Andric       outs() << VTableEntry;
4830b57cec5SDimitry Andric       outs() << '\n';
4840b57cec5SDimitry Andric       ++VTableSymI;
4850b57cec5SDimitry Andric       continue;
4860b57cec5SDimitry Andric     }
4870b57cec5SDimitry Andric     if (!DataDone && (SymDone || VTableDataI->first < VTableSymI->first)) {
4880b57cec5SDimitry Andric       StringRef VTableName = VTableDataI->first.first;
4890b57cec5SDimitry Andric       uint64_t Offset = VTableDataI->first.second;
4900b57cec5SDimitry Andric       int64_t VTableEntry = VTableDataI->second;
4910b57cec5SDimitry Andric       outs() << VTableName << '[' << Offset << "]: ";
4920b57cec5SDimitry Andric       outs() << VTableEntry;
4930b57cec5SDimitry Andric       outs() << '\n';
4940b57cec5SDimitry Andric       ++VTableDataI;
4950b57cec5SDimitry Andric       continue;
4960b57cec5SDimitry Andric     }
4970b57cec5SDimitry Andric   }
4980b57cec5SDimitry Andric }
4990b57cec5SDimitry Andric 
dumpArchive(const Archive * Arc)5000b57cec5SDimitry Andric static void dumpArchive(const Archive *Arc) {
5010b57cec5SDimitry Andric   Error Err = Error::success();
502bdd1243dSDimitry Andric   for (const auto &ArcC : Arc->children(Err)) {
5030b57cec5SDimitry Andric     Expected<std::unique_ptr<Binary>> ChildOrErr = ArcC.getAsBinary();
5040b57cec5SDimitry Andric     if (!ChildOrErr) {
5050b57cec5SDimitry Andric       // Ignore non-object files.
5060b57cec5SDimitry Andric       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
5070b57cec5SDimitry Andric         std::string Buf;
5080b57cec5SDimitry Andric         raw_string_ostream OS(Buf);
5090b57cec5SDimitry Andric         logAllUnhandledErrors(std::move(E), OS);
5100b57cec5SDimitry Andric         OS.flush();
5110b57cec5SDimitry Andric         reportError(Arc->getFileName(), Buf);
5120b57cec5SDimitry Andric       }
5130b57cec5SDimitry Andric       consumeError(ChildOrErr.takeError());
5140b57cec5SDimitry Andric       continue;
5150b57cec5SDimitry Andric     }
5160b57cec5SDimitry Andric 
5170b57cec5SDimitry Andric     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
5180b57cec5SDimitry Andric       dumpCXXData(Obj);
5190b57cec5SDimitry Andric     else
5200b57cec5SDimitry Andric       reportError(Arc->getFileName(), cxxdump_error::unrecognized_file_format);
5210b57cec5SDimitry Andric   }
5220b57cec5SDimitry Andric   if (Err)
5230b57cec5SDimitry Andric     error(std::move(Err));
5240b57cec5SDimitry Andric }
5250b57cec5SDimitry Andric 
dumpInput(StringRef File)5260b57cec5SDimitry Andric static void dumpInput(StringRef File) {
5270b57cec5SDimitry Andric   // Attempt to open the binary.
5280b57cec5SDimitry Andric   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
5290b57cec5SDimitry Andric   if (!BinaryOrErr) {
5300b57cec5SDimitry Andric     auto EC = errorToErrorCode(BinaryOrErr.takeError());
5310b57cec5SDimitry Andric     reportError(File, EC);
5320b57cec5SDimitry Andric     return;
5330b57cec5SDimitry Andric   }
5340b57cec5SDimitry Andric   Binary &Binary = *BinaryOrErr.get().getBinary();
5350b57cec5SDimitry Andric 
5360b57cec5SDimitry Andric   if (Archive *Arc = dyn_cast<Archive>(&Binary))
5370b57cec5SDimitry Andric     dumpArchive(Arc);
5380b57cec5SDimitry Andric   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
5390b57cec5SDimitry Andric     dumpCXXData(Obj);
5400b57cec5SDimitry Andric   else
5410b57cec5SDimitry Andric     reportError(File, cxxdump_error::unrecognized_file_format);
5420b57cec5SDimitry Andric }
5430b57cec5SDimitry Andric 
main(int argc,const char * argv[])5440b57cec5SDimitry Andric int main(int argc, const char *argv[]) {
5450b57cec5SDimitry Andric   InitLLVM X(argc, argv);
5460b57cec5SDimitry Andric 
5470b57cec5SDimitry Andric   // Initialize targets.
5480b57cec5SDimitry Andric   llvm::InitializeAllTargetInfos();
5490b57cec5SDimitry Andric 
5500b57cec5SDimitry Andric   // Register the target printer for --version.
5510b57cec5SDimitry Andric   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
5520b57cec5SDimitry Andric 
553fe6060f1SDimitry Andric   cl::HideUnrelatedOptions({&opts::CXXDumpCategory, &getColorCategory()});
5540b57cec5SDimitry Andric   cl::ParseCommandLineOptions(argc, argv, "LLVM C++ ABI Data Dumper\n");
5550b57cec5SDimitry Andric 
5560b57cec5SDimitry Andric   // Default to stdin if no filename is specified.
5570b57cec5SDimitry Andric   if (opts::InputFilenames.size() == 0)
5580b57cec5SDimitry Andric     opts::InputFilenames.push_back("-");
5590b57cec5SDimitry Andric 
5600b57cec5SDimitry Andric   llvm::for_each(opts::InputFilenames, dumpInput);
5610b57cec5SDimitry Andric 
5620b57cec5SDimitry Andric   return EXIT_SUCCESS;
5630b57cec5SDimitry Andric }
564