12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057 |
- //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
- //
- // 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
- //
- //===----------------------------------------------------------------------===//
- //
- // This program is a utility that works like binutils "objdump", that is, it
- // dumps out a plethora of information about an object file depending on the
- // flags.
- //
- // The flags and output of this program should be near identical to those of
- // binutils objdump.
- //
- //===----------------------------------------------------------------------===//
- #include "llvm-objdump.h"
- #include "llvm/ADT/Optional.h"
- #include "llvm/ADT/STLExtras.h"
- #include "llvm/ADT/StringExtras.h"
- #include "llvm/ADT/StringSet.h"
- #include "llvm/ADT/Triple.h"
- #include "llvm/CodeGen/FaultMaps.h"
- #include "llvm/DebugInfo/DWARF/DWARFContext.h"
- #include "llvm/DebugInfo/Symbolize/Symbolize.h"
- #include "llvm/Demangle/Demangle.h"
- #include "llvm/MC/MCAsmInfo.h"
- #include "llvm/MC/MCContext.h"
- #include "llvm/MC/MCDisassembler/MCDisassembler.h"
- #include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
- #include "llvm/MC/MCInst.h"
- #include "llvm/MC/MCInstPrinter.h"
- #include "llvm/MC/MCInstrAnalysis.h"
- #include "llvm/MC/MCInstrInfo.h"
- #include "llvm/MC/MCObjectFileInfo.h"
- #include "llvm/MC/MCRegisterInfo.h"
- #include "llvm/MC/MCSubtargetInfo.h"
- #include "llvm/Object/Archive.h"
- #include "llvm/Object/COFF.h"
- #include "llvm/Object/COFFImportFile.h"
- #include "llvm/Object/ELFObjectFile.h"
- #include "llvm/Object/MachO.h"
- #include "llvm/Object/MachOUniversal.h"
- #include "llvm/Object/ObjectFile.h"
- #include "llvm/Object/Wasm.h"
- #include "llvm/Support/Casting.h"
- #include "llvm/Support/CommandLine.h"
- #include "llvm/Support/Debug.h"
- #include "llvm/Support/Errc.h"
- #include "llvm/Support/FileSystem.h"
- #include "llvm/Support/Format.h"
- #include "llvm/Support/GraphWriter.h"
- #include "llvm/Support/Host.h"
- #include "llvm/Support/InitLLVM.h"
- #include "llvm/Support/MemoryBuffer.h"
- #include "llvm/Support/SourceMgr.h"
- #include "llvm/Support/StringSaver.h"
- #include "llvm/Support/TargetRegistry.h"
- #include "llvm/Support/TargetSelect.h"
- #include "llvm/Support/WithColor.h"
- #include "llvm/Support/raw_ostream.h"
- #include <algorithm>
- #include <cctype>
- #include <cstring>
- #include <system_error>
- #include <unordered_map>
- #include <utility>
- using namespace llvm::object;
- namespace llvm {
- // MachO specific
- extern cl::opt<bool> Bind;
- extern cl::opt<bool> DataInCode;
- extern cl::opt<bool> DylibsUsed;
- extern cl::opt<bool> DylibId;
- extern cl::opt<bool> ExportsTrie;
- extern cl::opt<bool> FirstPrivateHeader;
- extern cl::opt<bool> IndirectSymbols;
- extern cl::opt<bool> InfoPlist;
- extern cl::opt<bool> LazyBind;
- extern cl::opt<bool> LinkOptHints;
- extern cl::opt<bool> ObjcMetaData;
- extern cl::opt<bool> Rebase;
- extern cl::opt<bool> UniversalHeaders;
- extern cl::opt<bool> WeakBind;
- static cl::opt<uint64_t> AdjustVMA(
- "adjust-vma",
- cl::desc("Increase the displayed address by the specified offset"),
- cl::value_desc("offset"), cl::init(0));
- static cl::opt<bool>
- AllHeaders("all-headers",
- cl::desc("Display all available header information"));
- static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(AllHeaders));
- static cl::opt<std::string>
- ArchName("arch-name", cl::desc("Target arch to disassemble for, "
- "see -version for available targets"));
- cl::opt<bool> ArchiveHeaders("archive-headers",
- cl::desc("Display archive header information"));
- static cl::alias ArchiveHeadersShort("a",
- cl::desc("Alias for --archive-headers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(ArchiveHeaders));
- cl::opt<bool> Demangle("demangle", cl::desc("Demangle symbols names"),
- cl::init(false));
- static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(Demangle));
- cl::opt<bool> Disassemble(
- "disassemble",
- cl::desc("Display assembler mnemonics for the machine instructions"));
- static cl::alias DisassembleShort("d", cl::desc("Alias for --disassemble"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(Disassemble));
- cl::opt<bool> DisassembleAll(
- "disassemble-all",
- cl::desc("Display assembler mnemonics for the machine instructions"));
- static cl::alias DisassembleAllShort("D",
- cl::desc("Alias for --disassemble-all"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(DisassembleAll));
- static cl::list<std::string>
- DisassembleFunctions("disassemble-functions",
- cl::CommaSeparated,
- cl::desc("List of functions to disassemble"));
- static cl::opt<bool> DisassembleZeroes(
- "disassemble-zeroes",
- cl::desc("Do not skip blocks of zeroes when disassembling"));
- static cl::alias
- DisassembleZeroesShort("z", cl::desc("Alias for --disassemble-zeroes"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(DisassembleZeroes));
- static cl::list<std::string>
- DisassemblerOptions("disassembler-options",
- cl::desc("Pass target specific disassembler options"),
- cl::value_desc("options"), cl::CommaSeparated);
- static cl::alias
- DisassemblerOptionsShort("M", cl::desc("Alias for --disassembler-options"),
- cl::NotHidden, cl::Grouping, cl::Prefix,
- cl::CommaSeparated,
- cl::aliasopt(DisassemblerOptions));
- cl::opt<DIDumpType> DwarfDumpType(
- "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
- cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
- static cl::opt<bool> DynamicRelocations(
- "dynamic-reloc",
- cl::desc("Display the dynamic relocation entries in the file"));
- static cl::alias DynamicRelocationShort("R",
- cl::desc("Alias for --dynamic-reloc"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(DynamicRelocations));
- static cl::opt<bool>
- FaultMapSection("fault-map-section",
- cl::desc("Display contents of faultmap section"));
- static cl::opt<bool>
- FileHeaders("file-headers",
- cl::desc("Display the contents of the overall file header"));
- static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(FileHeaders));
- cl::opt<bool> SectionContents("full-contents",
- cl::desc("Display the content of each section"));
- static cl::alias SectionContentsShort("s",
- cl::desc("Alias for --full-contents"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(SectionContents));
- static cl::list<std::string>
- InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
- static cl::opt<bool>
- PrintLines("line-numbers",
- cl::desc("Display source line numbers with "
- "disassembly. Implies disassemble object"));
- static cl::alias PrintLinesShort("l", cl::desc("Alias for --line-numbers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(PrintLines));
- static cl::opt<bool>
- MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
- static cl::alias MachOm("m", cl::desc("Alias for --macho"), cl::NotHidden,
- cl::Grouping, cl::aliasopt(MachOOpt));
- cl::opt<std::string>
- MCPU("mcpu",
- cl::desc("Target a specific cpu type (-mcpu=help for details)"),
- cl::value_desc("cpu-name"), cl::init(""));
- cl::list<std::string> MAttrs("mattr", cl::CommaSeparated,
- cl::desc("Target specific attributes"),
- cl::value_desc("a1,+a2,-a3,..."));
- cl::opt<bool> NoShowRawInsn("no-show-raw-insn",
- cl::desc("When disassembling "
- "instructions, do not print "
- "the instruction bytes."));
- cl::opt<bool> NoLeadingAddr("no-leading-addr",
- cl::desc("Print no leading address"));
- static cl::opt<bool> RawClangAST(
- "raw-clang-ast",
- cl::desc("Dump the raw binary contents of the clang AST section"));
- cl::opt<bool>
- Relocations("reloc",
- cl::desc("Display the relocation entries in the file"));
- static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(Relocations));
- cl::opt<bool>
- PrintImmHex("print-imm-hex",
- cl::desc("Use hex format for immediate values"));
- cl::opt<bool>
- PrivateHeaders("private-headers",
- cl::desc("Display format specific file headers"));
- static cl::alias PrivateHeadersShort("p",
- cl::desc("Alias for --private-headers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(PrivateHeaders));
- cl::list<std::string>
- FilterSections("section",
- cl::desc("Operate on the specified sections only. "
- "With -macho dump segment,section"));
- static cl::alias FilterSectionsj("j", cl::desc("Alias for --section"),
- cl::NotHidden, cl::Grouping, cl::Prefix,
- cl::aliasopt(FilterSections));
- cl::opt<bool> SectionHeaders("section-headers",
- cl::desc("Display summaries of the "
- "headers for each section."));
- static cl::alias SectionHeadersShort("headers",
- cl::desc("Alias for --section-headers"),
- cl::NotHidden,
- cl::aliasopt(SectionHeaders));
- static cl::alias SectionHeadersShorter("h",
- cl::desc("Alias for --section-headers"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(SectionHeaders));
- static cl::opt<bool>
- ShowLMA("show-lma",
- cl::desc("Display LMA column when dumping ELF section headers"));
- static cl::opt<bool> PrintSource(
- "source",
- cl::desc(
- "Display source inlined with disassembly. Implies disassemble object"));
- static cl::alias PrintSourceShort("S", cl::desc("Alias for -source"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(PrintSource));
- static cl::opt<uint64_t>
- StartAddress("start-address", cl::desc("Disassemble beginning at address"),
- cl::value_desc("address"), cl::init(0));
- static cl::opt<uint64_t> StopAddress("stop-address",
- cl::desc("Stop disassembly at address"),
- cl::value_desc("address"),
- cl::init(UINT64_MAX));
- cl::opt<bool> SymbolTable("syms", cl::desc("Display the symbol table"));
- static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(SymbolTable));
- cl::opt<std::string> TripleName("triple",
- cl::desc("Target triple to disassemble for, "
- "see -version for available targets"));
- cl::opt<bool> UnwindInfo("unwind-info",
- cl::desc("Display unwind information"));
- static cl::alias UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
- cl::NotHidden, cl::Grouping,
- cl::aliasopt(UnwindInfo));
- static cl::opt<bool>
- Wide("wide", cl::desc("Ignored for compatibility with GNU objdump"));
- static cl::alias WideShort("w", cl::Grouping, cl::aliasopt(Wide));
- static StringSet<> DisasmFuncsSet;
- static StringRef ToolName;
- typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
- SectionFilter ToolSectionFilter(object::ObjectFile const &O) {
- return SectionFilter(
- [](object::SectionRef const &S) {
- if (FilterSections.empty())
- return true;
- StringRef String;
- std::error_code error = S.getName(String);
- if (error)
- return false;
- return is_contained(FilterSections, String);
- },
- O);
- }
- void error(std::error_code EC) {
- if (!EC)
- return;
- WithColor::error(errs(), ToolName)
- << "reading file: " << EC.message() << ".\n";
- errs().flush();
- exit(1);
- }
- void error(Error E) {
- if (!E)
- return;
- WithColor::error(errs(), ToolName) << toString(std::move(E));
- exit(1);
- }
- LLVM_ATTRIBUTE_NORETURN void error(Twine Message) {
- WithColor::error(errs(), ToolName) << Message << ".\n";
- errs().flush();
- exit(1);
- }
- void warn(StringRef Message) {
- WithColor::warning(errs(), ToolName) << Message << ".\n";
- errs().flush();
- }
- LLVM_ATTRIBUTE_NORETURN void report_error(StringRef File, Twine Message) {
- WithColor::error(errs(), ToolName)
- << "'" << File << "': " << Message << ".\n";
- exit(1);
- }
- LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef File) {
- assert(E);
- std::string Buf;
- raw_string_ostream OS(Buf);
- logAllUnhandledErrors(std::move(E), OS);
- OS.flush();
- WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
- exit(1);
- }
- LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef ArchiveName,
- StringRef FileName,
- StringRef ArchitectureName) {
- assert(E);
- WithColor::error(errs(), ToolName);
- if (ArchiveName != "")
- errs() << ArchiveName << "(" << FileName << ")";
- else
- errs() << "'" << FileName << "'";
- if (!ArchitectureName.empty())
- errs() << " (for architecture " << ArchitectureName << ")";
- std::string Buf;
- raw_string_ostream OS(Buf);
- logAllUnhandledErrors(std::move(E), OS);
- OS.flush();
- errs() << ": " << Buf;
- exit(1);
- }
- LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef ArchiveName,
- const object::Archive::Child &C,
- StringRef ArchitectureName) {
- Expected<StringRef> NameOrErr = C.getName();
- // TODO: if we have a error getting the name then it would be nice to print
- // the index of which archive member this is and or its offset in the
- // archive instead of "???" as the name.
- if (!NameOrErr) {
- consumeError(NameOrErr.takeError());
- report_error(std::move(E), ArchiveName, "???", ArchitectureName);
- } else
- report_error(std::move(E), ArchiveName, NameOrErr.get(), ArchitectureName);
- }
- static const Target *getTarget(const ObjectFile *Obj = nullptr) {
- // Figure out the target triple.
- Triple TheTriple("unknown-unknown-unknown");
- if (TripleName.empty()) {
- if (Obj)
- TheTriple = Obj->makeTriple();
- } else {
- TheTriple.setTriple(Triple::normalize(TripleName));
- // Use the triple, but also try to combine with ARM build attributes.
- if (Obj) {
- auto Arch = Obj->getArch();
- if (Arch == Triple::arm || Arch == Triple::armeb)
- Obj->setARMSubArch(TheTriple);
- }
- }
- // Get the target specific parser.
- std::string Error;
- const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
- Error);
- if (!TheTarget) {
- if (Obj)
- report_error(Obj->getFileName(), "can't find target: " + Error);
- else
- error("can't find target: " + Error);
- }
- // Update the triple name and return the found target.
- TripleName = TheTriple.getTriple();
- return TheTarget;
- }
- bool isRelocAddressLess(RelocationRef A, RelocationRef B) {
- return A.getOffset() < B.getOffset();
- }
- static Error getRelocationValueString(const RelocationRef &Rel,
- SmallVectorImpl<char> &Result) {
- const ObjectFile *Obj = Rel.getObject();
- if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
- return getELFRelocationValueString(ELF, Rel, Result);
- if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
- return getCOFFRelocationValueString(COFF, Rel, Result);
- if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
- return getWasmRelocationValueString(Wasm, Rel, Result);
- if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
- return getMachORelocationValueString(MachO, Rel, Result);
- llvm_unreachable("unknown object file format");
- }
- /// Indicates whether this relocation should hidden when listing
- /// relocations, usually because it is the trailing part of a multipart
- /// relocation that will be printed as part of the leading relocation.
- static bool getHidden(RelocationRef RelRef) {
- auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
- if (!MachO)
- return false;
- unsigned Arch = MachO->getArch();
- DataRefImpl Rel = RelRef.getRawDataRefImpl();
- uint64_t Type = MachO->getRelocationType(Rel);
- // On arches that use the generic relocations, GENERIC_RELOC_PAIR
- // is always hidden.
- if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
- return Type == MachO::GENERIC_RELOC_PAIR;
- if (Arch == Triple::x86_64) {
- // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
- // an X86_64_RELOC_SUBTRACTOR.
- if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
- DataRefImpl RelPrev = Rel;
- RelPrev.d.a--;
- uint64_t PrevType = MachO->getRelocationType(RelPrev);
- if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
- return true;
- }
- }
- return false;
- }
- namespace {
- class SourcePrinter {
- protected:
- DILineInfo OldLineInfo;
- const ObjectFile *Obj = nullptr;
- std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
- // File name to file contents of source
- std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
- // Mark the line endings of the cached source
- std::unordered_map<std::string, std::vector<StringRef>> LineCache;
- private:
- bool cacheSource(const DILineInfo& LineInfoFile);
- public:
- SourcePrinter() = default;
- SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
- symbolize::LLVMSymbolizer::Options SymbolizerOpts(
- DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
- DefaultArch);
- Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
- }
- virtual ~SourcePrinter() = default;
- virtual void printSourceLine(raw_ostream &OS,
- object::SectionedAddress Address,
- StringRef Delimiter = "; ");
- };
- bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
- std::unique_ptr<MemoryBuffer> Buffer;
- if (LineInfo.Source) {
- Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
- } else {
- auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
- if (!BufferOrError)
- return false;
- Buffer = std::move(*BufferOrError);
- }
- // Chomp the file to get lines
- const char *BufferStart = Buffer->getBufferStart(),
- *BufferEnd = Buffer->getBufferEnd();
- std::vector<StringRef> &Lines = LineCache[LineInfo.FileName];
- const char *Start = BufferStart;
- for (const char *I = BufferStart; I != BufferEnd; ++I)
- if (*I == '\n') {
- Lines.emplace_back(Start, I - Start - (BufferStart < I && I[-1] == '\r'));
- Start = I + 1;
- }
- if (Start < BufferEnd)
- Lines.emplace_back(Start, BufferEnd - Start);
- SourceCache[LineInfo.FileName] = std::move(Buffer);
- return true;
- }
- void SourcePrinter::printSourceLine(raw_ostream &OS,
- object::SectionedAddress Address,
- StringRef Delimiter) {
- if (!Symbolizer)
- return;
- DILineInfo LineInfo = DILineInfo();
- auto ExpectedLineInfo =
- Symbolizer->symbolizeCode(Obj->getFileName(), Address);
- if (!ExpectedLineInfo)
- consumeError(ExpectedLineInfo.takeError());
- else
- LineInfo = *ExpectedLineInfo;
- if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
- LineInfo.Line == 0)
- return;
- if (PrintLines)
- OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
- if (PrintSource) {
- if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
- if (!cacheSource(LineInfo))
- return;
- auto LineBuffer = LineCache.find(LineInfo.FileName);
- if (LineBuffer != LineCache.end()) {
- if (LineInfo.Line > LineBuffer->second.size())
- return;
- // Vector begins at 0, line numbers are non-zero
- OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n';
- }
- }
- OldLineInfo = LineInfo;
- }
- static bool isArmElf(const ObjectFile *Obj) {
- return (Obj->isELF() &&
- (Obj->getArch() == Triple::aarch64 ||
- Obj->getArch() == Triple::aarch64_be ||
- Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
- Obj->getArch() == Triple::thumb ||
- Obj->getArch() == Triple::thumbeb));
- }
- static void printRelocation(const RelocationRef &Rel, uint64_t Address,
- uint8_t AddrSize) {
- StringRef Fmt =
- AddrSize > 4 ? "\t\t%016" PRIx64 ": " : "\t\t\t%08" PRIx64 ": ";
- SmallString<16> Name;
- SmallString<32> Val;
- Rel.getTypeName(Name);
- error(getRelocationValueString(Rel, Val));
- outs() << format(Fmt.data(), Address) << Name << "\t" << Val << "\n";
- }
- class PrettyPrinter {
- public:
- virtual ~PrettyPrinter() = default;
- virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
- ArrayRef<uint8_t> Bytes,
- object::SectionedAddress Address, raw_ostream &OS,
- StringRef Annot, MCSubtargetInfo const &STI,
- SourcePrinter *SP,
- std::vector<RelocationRef> *Rels = nullptr) {
- if (SP && (PrintSource || PrintLines))
- SP->printSourceLine(OS, Address);
- {
- formatted_raw_ostream FOS(OS);
- if (!NoLeadingAddr)
- FOS << format("%8" PRIx64 ":", Address.Address);
- if (!NoShowRawInsn) {
- FOS << ' ';
- dumpBytes(Bytes, FOS);
- }
- FOS.flush();
- // The output of printInst starts with a tab. Print some spaces so that
- // the tab has 1 column and advances to the target tab stop.
- unsigned TabStop = NoShowRawInsn ? 16 : 40;
- unsigned Column = FOS.getColumn();
- FOS.indent(Column < TabStop - 1 ? TabStop - 1 - Column : 7 - Column % 8);
- // The dtor calls flush() to ensure the indent comes before printInst().
- }
- if (MI)
- IP.printInst(MI, OS, "", STI);
- else
- OS << "\t<unknown>";
- }
- };
- PrettyPrinter PrettyPrinterInst;
- class HexagonPrettyPrinter : public PrettyPrinter {
- public:
- void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
- raw_ostream &OS) {
- uint32_t opcode =
- (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
- if (!NoLeadingAddr)
- OS << format("%8" PRIx64 ":", Address);
- if (!NoShowRawInsn) {
- OS << "\t";
- dumpBytes(Bytes.slice(0, 4), OS);
- OS << format("\t%08" PRIx32, opcode);
- }
- }
- void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
- object::SectionedAddress Address, raw_ostream &OS,
- StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
- std::vector<RelocationRef> *Rels) override {
- if (SP && (PrintSource || PrintLines))
- SP->printSourceLine(OS, Address, "");
- if (!MI) {
- printLead(Bytes, Address.Address, OS);
- OS << " <unknown>";
- return;
- }
- std::string Buffer;
- {
- raw_string_ostream TempStream(Buffer);
- IP.printInst(MI, TempStream, "", STI);
- }
- StringRef Contents(Buffer);
- // Split off bundle attributes
- auto PacketBundle = Contents.rsplit('\n');
- // Split off first instruction from the rest
- auto HeadTail = PacketBundle.first.split('\n');
- auto Preamble = " { ";
- auto Separator = "";
- // Hexagon's packets require relocations to be inline rather than
- // clustered at the end of the packet.
- std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
- std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
- auto PrintReloc = [&]() -> void {
- while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
- if (RelCur->getOffset() == Address.Address) {
- printRelocation(*RelCur, Address.Address, 4);
- return;
- }
- ++RelCur;
- }
- };
- while (!HeadTail.first.empty()) {
- OS << Separator;
- Separator = "\n";
- if (SP && (PrintSource || PrintLines))
- SP->printSourceLine(OS, Address, "");
- printLead(Bytes, Address.Address, OS);
- OS << Preamble;
- Preamble = " ";
- StringRef Inst;
- auto Duplex = HeadTail.first.split('\v');
- if (!Duplex.second.empty()) {
- OS << Duplex.first;
- OS << "; ";
- Inst = Duplex.second;
- }
- else
- Inst = HeadTail.first;
- OS << Inst;
- HeadTail = HeadTail.second.split('\n');
- if (HeadTail.first.empty())
- OS << " } " << PacketBundle.second;
- PrintReloc();
- Bytes = Bytes.slice(4);
- Address.Address += 4;
- }
- }
- };
- HexagonPrettyPrinter HexagonPrettyPrinterInst;
- class AMDGCNPrettyPrinter : public PrettyPrinter {
- public:
- void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
- object::SectionedAddress Address, raw_ostream &OS,
- StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
- std::vector<RelocationRef> *Rels) override {
- if (SP && (PrintSource || PrintLines))
- SP->printSourceLine(OS, Address);
- typedef support::ulittle32_t U32;
- if (MI) {
- SmallString<40> InstStr;
- raw_svector_ostream IS(InstStr);
- IP.printInst(MI, IS, "", STI);
- OS << left_justify(IS.str(), 60);
- } else {
- // an unrecognized encoding - this is probably data so represent it
- // using the .long directive, or .byte directive if fewer than 4 bytes
- // remaining
- if (Bytes.size() >= 4) {
- OS << format("\t.long 0x%08" PRIx32 " ",
- static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
- OS.indent(42);
- } else {
- OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
- for (unsigned int i = 1; i < Bytes.size(); i++)
- OS << format(", 0x%02" PRIx8, Bytes[i]);
- OS.indent(55 - (6 * Bytes.size()));
- }
- }
- OS << format("// %012" PRIX64 ": ", Address.Address);
- if (Bytes.size() >=4) {
- for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
- Bytes.size() / sizeof(U32)))
- // D should be explicitly casted to uint32_t here as it is passed
- // by format to snprintf as vararg.
- OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
- } else {
- for (unsigned int i = 0; i < Bytes.size(); i++)
- OS << format("%02" PRIX8 " ", Bytes[i]);
- }
- if (!Annot.empty())
- OS << "// " << Annot;
- }
- };
- AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
- class BPFPrettyPrinter : public PrettyPrinter {
- public:
- void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
- object::SectionedAddress Address, raw_ostream &OS,
- StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
- std::vector<RelocationRef> *Rels) override {
- if (SP && (PrintSource || PrintLines))
- SP->printSourceLine(OS, Address);
- if (!NoLeadingAddr)
- OS << format("%8" PRId64 ":", Address.Address / 8);
- if (!NoShowRawInsn) {
- OS << "\t";
- dumpBytes(Bytes, OS);
- }
- if (MI)
- IP.printInst(MI, OS, "", STI);
- else
- OS << "\t<unknown>";
- }
- };
- BPFPrettyPrinter BPFPrettyPrinterInst;
- PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
- switch(Triple.getArch()) {
- default:
- return PrettyPrinterInst;
- case Triple::hexagon:
- return HexagonPrettyPrinterInst;
- case Triple::amdgcn:
- return AMDGCNPrettyPrinterInst;
- case Triple::bpfel:
- case Triple::bpfeb:
- return BPFPrettyPrinterInst;
- }
- }
- }
- static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
- assert(Obj->isELF());
- if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
- return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
- if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
- return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
- if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
- return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
- if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
- return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
- llvm_unreachable("Unsupported binary format");
- }
- template <class ELFT> static void
- addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
- std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
- for (auto Symbol : Obj->getDynamicSymbolIterators()) {
- uint8_t SymbolType = Symbol.getELFType();
- if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
- continue;
- uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName());
- StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
- if (Name.empty())
- continue;
- section_iterator SecI =
- unwrapOrError(Symbol.getSection(), Obj->getFileName());
- if (SecI == Obj->section_end())
- continue;
- AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
- }
- }
- static void
- addDynamicElfSymbols(const ObjectFile *Obj,
- std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
- assert(Obj->isELF());
- if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
- addDynamicElfSymbols(Elf32LEObj, AllSymbols);
- else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
- addDynamicElfSymbols(Elf64LEObj, AllSymbols);
- else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
- addDynamicElfSymbols(Elf32BEObj, AllSymbols);
- else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
- addDynamicElfSymbols(Elf64BEObj, AllSymbols);
- else
- llvm_unreachable("Unsupported binary format");
- }
- static void addPltEntries(const ObjectFile *Obj,
- std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
- StringSaver &Saver) {
- Optional<SectionRef> Plt = None;
- for (const SectionRef &Section : Obj->sections()) {
- StringRef Name;
- if (Section.getName(Name))
- continue;
- if (Name == ".plt")
- Plt = Section;
- }
- if (!Plt)
- return;
- if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
- for (auto PltEntry : ElfObj->getPltAddresses()) {
- SymbolRef Symbol(PltEntry.first, ElfObj);
- uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
- StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
- if (!Name.empty())
- AllSymbols[*Plt].emplace_back(
- PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType);
- }
- }
- }
- // Normally the disassembly output will skip blocks of zeroes. This function
- // returns the number of zero bytes that can be skipped when dumping the
- // disassembly of the instructions in Buf.
- static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
- // Find the number of leading zeroes.
- size_t N = 0;
- while (N < Buf.size() && !Buf[N])
- ++N;
- // We may want to skip blocks of zero bytes, but unless we see
- // at least 8 of them in a row.
- if (N < 8)
- return 0;
- // We skip zeroes in multiples of 4 because do not want to truncate an
- // instruction if it starts with a zero byte.
- return N & ~0x3;
- }
- // Returns a map from sections to their relocations.
- static std::map<SectionRef, std::vector<RelocationRef>>
- getRelocsMap(object::ObjectFile const &Obj) {
- std::map<SectionRef, std::vector<RelocationRef>> Ret;
- for (const SectionRef &Section : ToolSectionFilter(Obj)) {
- section_iterator RelSec = Section.getRelocatedSection();
- if (RelSec == Obj.section_end())
- continue;
- std::vector<RelocationRef> &V = Ret[*RelSec];
- for (const RelocationRef &R : Section.relocations())
- V.push_back(R);
- // Sort relocations by address.
- llvm::sort(V, isRelocAddressLess);
- }
- return Ret;
- }
- // Used for --adjust-vma to check if address should be adjusted by the
- // specified value for a given section.
- // For ELF we do not adjust non-allocatable sections like debug ones,
- // because they are not loadable.
- // TODO: implement for other file formats.
- static bool shouldAdjustVA(const SectionRef &Section) {
- const ObjectFile *Obj = Section.getObject();
- if (isa<object::ELFObjectFileBase>(Obj))
- return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
- return false;
- }
- static uint64_t
- dumpARMELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
- const ObjectFile *Obj, ArrayRef<uint8_t> Bytes,
- const std::vector<uint64_t> &TextMappingSymsAddr) {
- support::endianness Endian =
- Obj->isLittleEndian() ? support::little : support::big;
- while (Index < End) {
- outs() << format("%8" PRIx64 ":", SectionAddr + Index);
- outs() << "\t";
- if (Index + 4 <= End) {
- dumpBytes(Bytes.slice(Index, 4), outs());
- outs() << "\t.word\t"
- << format_hex(
- support::endian::read32(Bytes.data() + Index, Endian), 10);
- Index += 4;
- } else if (Index + 2 <= End) {
- dumpBytes(Bytes.slice(Index, 2), outs());
- outs() << "\t\t.short\t"
- << format_hex(
- support::endian::read16(Bytes.data() + Index, Endian), 6);
- Index += 2;
- } else {
- dumpBytes(Bytes.slice(Index, 1), outs());
- outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4);
- ++Index;
- }
- outs() << "\n";
- if (std::binary_search(TextMappingSymsAddr.begin(),
- TextMappingSymsAddr.end(), Index))
- break;
- }
- return Index;
- }
- static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
- ArrayRef<uint8_t> Bytes) {
- // print out data up to 8 bytes at a time in hex and ascii
- uint8_t AsciiData[9] = {'\0'};
- uint8_t Byte;
- int NumBytes = 0;
- for (; Index < End; ++Index) {
- if (NumBytes == 0) {
- outs() << format("%8" PRIx64 ":", SectionAddr + Index);
- outs() << "\t";
- }
- Byte = Bytes.slice(Index)[0];
- outs() << format(" %02x", Byte);
- AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
- uint8_t IndentOffset = 0;
- NumBytes++;
- if (Index == End - 1 || NumBytes > 8) {
- // Indent the space for less than 8 bytes data.
- // 2 spaces for byte and one for space between bytes
- IndentOffset = 3 * (8 - NumBytes);
- for (int Excess = NumBytes; Excess < 8; Excess++)
- AsciiData[Excess] = '\0';
- NumBytes = 8;
- }
- if (NumBytes == 8) {
- AsciiData[8] = '\0';
- outs() << std::string(IndentOffset, ' ') << " ";
- outs() << reinterpret_cast<char *>(AsciiData);
- outs() << '\n';
- NumBytes = 0;
- }
- }
- }
- static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
- MCContext &Ctx, MCDisassembler *DisAsm,
- const MCInstrAnalysis *MIA, MCInstPrinter *IP,
- const MCSubtargetInfo *STI, PrettyPrinter &PIP,
- SourcePrinter &SP, bool InlineRelocs) {
- std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
- if (InlineRelocs)
- RelocMap = getRelocsMap(*Obj);
- // Create a mapping from virtual address to symbol name. This is used to
- // pretty print the symbols while disassembling.
- std::map<SectionRef, SectionSymbolsTy> AllSymbols;
- SectionSymbolsTy AbsoluteSymbols;
- const StringRef FileName = Obj->getFileName();
- for (const SymbolRef &Symbol : Obj->symbols()) {
- uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName);
- StringRef Name = unwrapOrError(Symbol.getName(), FileName);
- if (Name.empty())
- continue;
- uint8_t SymbolType = ELF::STT_NOTYPE;
- if (Obj->isELF()) {
- SymbolType = getElfSymbolType(Obj, Symbol);
- if (SymbolType == ELF::STT_SECTION)
- continue;
- }
- section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
- if (SecI != Obj->section_end())
- AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
- else
- AbsoluteSymbols.emplace_back(Address, Name, SymbolType);
- }
- if (AllSymbols.empty() && Obj->isELF())
- addDynamicElfSymbols(Obj, AllSymbols);
- BumpPtrAllocator A;
- StringSaver Saver(A);
- addPltEntries(Obj, AllSymbols, Saver);
- // Create a mapping from virtual address to section.
- std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
- for (SectionRef Sec : Obj->sections())
- SectionAddresses.emplace_back(Sec.getAddress(), Sec);
- array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
- // Linked executables (.exe and .dll files) typically don't include a real
- // symbol table but they might contain an export table.
- if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
- for (const auto &ExportEntry : COFFObj->export_directories()) {
- StringRef Name;
- error(ExportEntry.getSymbolName(Name));
- if (Name.empty())
- continue;
- uint32_t RVA;
- error(ExportEntry.getExportRVA(RVA));
- uint64_t VA = COFFObj->getImageBase() + RVA;
- auto Sec = llvm::bsearch(
- SectionAddresses, [VA](const std::pair<uint64_t, SectionRef> &RHS) {
- return VA < RHS.first;
- });
- if (Sec != SectionAddresses.begin()) {
- --Sec;
- AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
- } else
- AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
- }
- }
- // Sort all the symbols, this allows us to use a simple binary search to find
- // a symbol near an address.
- for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
- array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
- array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
- for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
- if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
- continue;
- uint64_t SectionAddr = Section.getAddress();
- uint64_t SectSize = Section.getSize();
- if (!SectSize)
- continue;
- // Get the list of all the symbols in this section.
- SectionSymbolsTy &Symbols = AllSymbols[Section];
- std::vector<uint64_t> DataMappingSymsAddr;
- std::vector<uint64_t> TextMappingSymsAddr;
- if (isArmElf(Obj)) {
- for (const auto &Symb : Symbols) {
- uint64_t Address = std::get<0>(Symb);
- StringRef Name = std::get<1>(Symb);
- if (Name.startswith("$d"))
- DataMappingSymsAddr.push_back(Address - SectionAddr);
- if (Name.startswith("$x"))
- TextMappingSymsAddr.push_back(Address - SectionAddr);
- if (Name.startswith("$a"))
- TextMappingSymsAddr.push_back(Address - SectionAddr);
- if (Name.startswith("$t"))
- TextMappingSymsAddr.push_back(Address - SectionAddr);
- }
- }
- llvm::sort(DataMappingSymsAddr);
- llvm::sort(TextMappingSymsAddr);
- if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
- // AMDGPU disassembler uses symbolizer for printing labels
- std::unique_ptr<MCRelocationInfo> RelInfo(
- TheTarget->createMCRelocationInfo(TripleName, Ctx));
- if (RelInfo) {
- std::unique_ptr<MCSymbolizer> Symbolizer(
- TheTarget->createMCSymbolizer(
- TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
- DisAsm->setSymbolizer(std::move(Symbolizer));
- }
- }
- StringRef SegmentName = "";
- if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
- DataRefImpl DR = Section.getRawDataRefImpl();
- SegmentName = MachO->getSectionFinalSegmentName(DR);
- }
- StringRef SectionName;
- error(Section.getName(SectionName));
- // If the section has no symbol at the start, just insert a dummy one.
- if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
- Symbols.insert(
- Symbols.begin(),
- std::make_tuple(SectionAddr, SectionName,
- Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
- }
- SmallString<40> Comments;
- raw_svector_ostream CommentStream(Comments);
- ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(
- unwrapOrError(Section.getContents(), Obj->getFileName()));
- uint64_t VMAAdjustment = 0;
- if (shouldAdjustVA(Section))
- VMAAdjustment = AdjustVMA;
- uint64_t Size;
- uint64_t Index;
- bool PrintedSection = false;
- std::vector<RelocationRef> Rels = RelocMap[Section];
- std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
- std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
- // Disassemble symbol by symbol.
- for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
- // Skip if --disassemble-functions is not empty and the symbol is not in
- // the list.
- if (!DisasmFuncsSet.empty() &&
- !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
- continue;
- uint64_t Start = std::get<0>(Symbols[SI]);
- if (Start < SectionAddr || StopAddress <= Start)
- continue;
- // The end is the section end, the beginning of the next symbol, or
- // --stop-address.
- uint64_t End = std::min<uint64_t>(SectionAddr + SectSize, StopAddress);
- if (SI + 1 < SE)
- End = std::min(End, std::get<0>(Symbols[SI + 1]));
- if (Start >= End || End <= StartAddress)
- continue;
- Start -= SectionAddr;
- End -= SectionAddr;
- if (!PrintedSection) {
- PrintedSection = true;
- outs() << "\nDisassembly of section ";
- if (!SegmentName.empty())
- outs() << SegmentName << ",";
- outs() << SectionName << ":\n";
- }
- if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
- if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
- // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
- Start += 256;
- }
- if (SI == SE - 1 ||
- std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
- // cut trailing zeroes at the end of kernel
- // cut up to 256 bytes
- const uint64_t EndAlign = 256;
- const auto Limit = End - (std::min)(EndAlign, End - Start);
- while (End > Limit &&
- *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
- End -= 4;
- }
- }
- outs() << '\n';
- if (!NoLeadingAddr)
- outs() << format("%016" PRIx64 " ",
- SectionAddr + Start + VMAAdjustment);
- StringRef SymbolName = std::get<1>(Symbols[SI]);
- if (Demangle)
- outs() << demangle(SymbolName) << ":\n";
- else
- outs() << SymbolName << ":\n";
- // Don't print raw contents of a virtual section. A virtual section
- // doesn't have any contents in the file.
- if (Section.isVirtual()) {
- outs() << "...\n";
- continue;
- }
- #ifndef NDEBUG
- raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
- #else
- raw_ostream &DebugOut = nulls();
- #endif
- // Some targets (like WebAssembly) have a special prelude at the start
- // of each symbol.
- DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
- SectionAddr + Start, DebugOut, CommentStream);
- Start += Size;
- Index = Start;
- if (SectionAddr < StartAddress)
- Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
- // If there is a data symbol inside an ELF text section and we are
- // only disassembling text (applicable all architectures), we are in a
- // situation where we must print the data and not disassemble it.
- if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
- !DisassembleAll && Section.isText()) {
- dumpELFData(SectionAddr, Index, End, Bytes);
- Index = End;
- }
- bool CheckARMELFData = isArmElf(Obj) &&
- std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
- !DisassembleAll;
- while (Index < End) {
- // AArch64 ELF binaries can interleave data and text in the same
- // section. We rely on the markers introduced to understand what we
- // need to dump. If the data marker is within a function, it is
- // denoted as a word/short etc.
- if (CheckARMELFData &&
- std::binary_search(DataMappingSymsAddr.begin(),
- DataMappingSymsAddr.end(), Index)) {
- Index = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
- TextMappingSymsAddr);
- continue;
- }
- // When -z or --disassemble-zeroes are given we always dissasemble
- // them. Otherwise we might want to skip zero bytes we see.
- if (!DisassembleZeroes) {
- uint64_t MaxOffset = End - Index;
- // For -reloc: print zero blocks patched by relocations, so that
- // relocations can be shown in the dump.
- if (RelCur != RelEnd)
- MaxOffset = RelCur->getOffset() - Index;
- if (size_t N =
- countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
- outs() << "\t\t..." << '\n';
- Index += N;
- continue;
- }
- }
- // Disassemble a real instruction or a data when disassemble all is
- // provided
- MCInst Inst;
- bool Disassembled = DisAsm->getInstruction(
- Inst, Size, Bytes.slice(Index), SectionAddr + Index, DebugOut,
- CommentStream);
- if (Size == 0)
- Size = 1;
- PIP.printInst(
- *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
- {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(),
- "", *STI, &SP, &Rels);
- outs() << CommentStream.str();
- Comments.clear();
- // Try to resolve the target of a call, tail call, etc. to a specific
- // symbol.
- if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
- MIA->isConditionalBranch(Inst))) {
- uint64_t Target;
- if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
- // In a relocatable object, the target's section must reside in
- // the same section as the call instruction or it is accessed
- // through a relocation.
- //
- // In a non-relocatable object, the target may be in any section.
- //
- // N.B. We don't walk the relocations in the relocatable case yet.
- auto *TargetSectionSymbols = &Symbols;
- if (!Obj->isRelocatableObject()) {
- auto It = llvm::bsearch(
- SectionAddresses,
- [=](const std::pair<uint64_t, SectionRef> &RHS) {
- return Target < RHS.first;
- });
- if (It != SectionAddresses.begin()) {
- --It;
- TargetSectionSymbols = &AllSymbols[It->second];
- } else {
- TargetSectionSymbols = &AbsoluteSymbols;
- }
- }
- // Find the last symbol in the section whose offset is less than
- // or equal to the target. If there isn't a section that contains
- // the target, find the nearest preceding absolute symbol.
- auto TargetSym = llvm::bsearch(
- *TargetSectionSymbols,
- [=](const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
- return Target < std::get<0>(RHS);
- });
- if (TargetSym == TargetSectionSymbols->begin()) {
- TargetSectionSymbols = &AbsoluteSymbols;
- TargetSym = llvm::bsearch(
- AbsoluteSymbols,
- [=](const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
- return Target < std::get<0>(RHS);
- });
- }
- if (TargetSym != TargetSectionSymbols->begin()) {
- --TargetSym;
- uint64_t TargetAddress = std::get<0>(*TargetSym);
- StringRef TargetName = std::get<1>(*TargetSym);
- outs() << " <" << TargetName;
- uint64_t Disp = Target - TargetAddress;
- if (Disp)
- outs() << "+0x" << Twine::utohexstr(Disp);
- outs() << '>';
- }
- }
- }
- outs() << "\n";
- // Hexagon does this in pretty printer
- if (Obj->getArch() != Triple::hexagon) {
- // Print relocation for instruction.
- while (RelCur != RelEnd) {
- uint64_t Offset = RelCur->getOffset();
- // If this relocation is hidden, skip it.
- if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
- ++RelCur;
- continue;
- }
- // Stop when RelCur's offset is past the current instruction.
- if (Offset >= Index + Size)
- break;
- // When --adjust-vma is used, update the address printed.
- if (RelCur->getSymbol() != Obj->symbol_end()) {
- Expected<section_iterator> SymSI =
- RelCur->getSymbol()->getSection();
- if (SymSI && *SymSI != Obj->section_end() &&
- shouldAdjustVA(**SymSI))
- Offset += AdjustVMA;
- }
- printRelocation(*RelCur, SectionAddr + Offset,
- Obj->getBytesInAddress());
- ++RelCur;
- }
- }
- Index += Size;
- }
- }
- }
- }
- static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
- if (StartAddress > StopAddress)
- error("Start address should be less than stop address");
- const Target *TheTarget = getTarget(Obj);
- // Package up features to be passed to target/subtarget
- SubtargetFeatures Features = Obj->getFeatures();
- if (!MAttrs.empty())
- for (unsigned I = 0; I != MAttrs.size(); ++I)
- Features.AddFeature(MAttrs[I]);
- std::unique_ptr<const MCRegisterInfo> MRI(
- TheTarget->createMCRegInfo(TripleName));
- if (!MRI)
- report_error(Obj->getFileName(),
- "no register info for target " + TripleName);
- // Set up disassembler.
- std::unique_ptr<const MCAsmInfo> AsmInfo(
- TheTarget->createMCAsmInfo(*MRI, TripleName));
- if (!AsmInfo)
- report_error(Obj->getFileName(),
- "no assembly info for target " + TripleName);
- std::unique_ptr<const MCSubtargetInfo> STI(
- TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
- if (!STI)
- report_error(Obj->getFileName(),
- "no subtarget info for target " + TripleName);
- std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
- if (!MII)
- report_error(Obj->getFileName(),
- "no instruction info for target " + TripleName);
- MCObjectFileInfo MOFI;
- MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
- // FIXME: for now initialize MCObjectFileInfo with default values
- MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
- std::unique_ptr<MCDisassembler> DisAsm(
- TheTarget->createMCDisassembler(*STI, Ctx));
- if (!DisAsm)
- report_error(Obj->getFileName(),
- "no disassembler for target " + TripleName);
- std::unique_ptr<const MCInstrAnalysis> MIA(
- TheTarget->createMCInstrAnalysis(MII.get()));
- int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
- std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
- Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
- if (!IP)
- report_error(Obj->getFileName(),
- "no instruction printer for target " + TripleName);
- IP->setPrintImmHex(PrintImmHex);
- PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
- SourcePrinter SP(Obj, TheTarget->getName());
- for (StringRef Opt : DisassemblerOptions)
- if (!IP->applyTargetSpecificCLOption(Opt))
- error("Unrecognized disassembler option: " + Opt);
- disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
- STI.get(), PIP, SP, InlineRelocs);
- }
- void printRelocations(const ObjectFile *Obj) {
- StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
- "%08" PRIx64;
- // Regular objdump doesn't print relocations in non-relocatable object
- // files.
- if (!Obj->isRelocatableObject())
- return;
- // Build a mapping from relocation target to a vector of relocation
- // sections. Usually, there is an only one relocation section for
- // each relocated section.
- MapVector<SectionRef, std::vector<SectionRef>> SecToRelSec;
- for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
- if (Section.relocation_begin() == Section.relocation_end())
- continue;
- const SectionRef TargetSec = *Section.getRelocatedSection();
- SecToRelSec[TargetSec].push_back(Section);
- }
- for (std::pair<SectionRef, std::vector<SectionRef>> &P : SecToRelSec) {
- StringRef SecName;
- error(P.first.getName(SecName));
- outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
- for (SectionRef Section : P.second) {
- for (const RelocationRef &Reloc : Section.relocations()) {
- uint64_t Address = Reloc.getOffset();
- SmallString<32> RelocName;
- SmallString<32> ValueStr;
- if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
- continue;
- Reloc.getTypeName(RelocName);
- error(getRelocationValueString(Reloc, ValueStr));
- outs() << format(Fmt.data(), Address) << " " << RelocName << " "
- << ValueStr << "\n";
- }
- }
- outs() << "\n";
- }
- }
- void printDynamicRelocations(const ObjectFile *Obj) {
- // For the moment, this option is for ELF only
- if (!Obj->isELF())
- return;
- const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
- if (!Elf || Elf->getEType() != ELF::ET_DYN) {
- error("not a dynamic object");
- return;
- }
- std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
- if (DynRelSec.empty())
- return;
- outs() << "DYNAMIC RELOCATION RECORDS\n";
- StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
- for (const SectionRef &Section : DynRelSec)
- for (const RelocationRef &Reloc : Section.relocations()) {
- uint64_t Address = Reloc.getOffset();
- SmallString<32> RelocName;
- SmallString<32> ValueStr;
- Reloc.getTypeName(RelocName);
- error(getRelocationValueString(Reloc, ValueStr));
- outs() << format(Fmt.data(), Address) << " " << RelocName << " "
- << ValueStr << "\n";
- }
- }
- // Returns true if we need to show LMA column when dumping section headers. We
- // show it only when the platform is ELF and either we have at least one section
- // whose VMA and LMA are different and/or when --show-lma flag is used.
- static bool shouldDisplayLMA(const ObjectFile *Obj) {
- if (!Obj->isELF())
- return false;
- for (const SectionRef &S : ToolSectionFilter(*Obj))
- if (S.getAddress() != getELFSectionLMA(S))
- return true;
- return ShowLMA;
- }
- void printSectionHeaders(const ObjectFile *Obj) {
- bool HasLMAColumn = shouldDisplayLMA(Obj);
- if (HasLMAColumn)
- outs() << "Sections:\n"
- "Idx Name Size VMA LMA "
- "Type\n";
- else
- outs() << "Sections:\n"
- "Idx Name Size VMA Type\n";
- for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
- StringRef Name;
- error(Section.getName(Name));
- uint64_t VMA = Section.getAddress();
- if (shouldAdjustVA(Section))
- VMA += AdjustVMA;
- uint64_t Size = Section.getSize();
- bool Text = Section.isText();
- bool Data = Section.isData();
- bool BSS = Section.isBSS();
- std::string Type = (std::string(Text ? "TEXT " : "") +
- (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
- if (HasLMAColumn)
- outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %016" PRIx64
- " %s\n",
- (unsigned)Section.getIndex(), Name.str().c_str(), Size,
- VMA, getELFSectionLMA(Section), Type.c_str());
- else
- outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
- (unsigned)Section.getIndex(), Name.str().c_str(), Size,
- VMA, Type.c_str());
- }
- outs() << "\n";
- }
- void printSectionContents(const ObjectFile *Obj) {
- for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
- StringRef Name;
- error(Section.getName(Name));
- uint64_t BaseAddr = Section.getAddress();
- uint64_t Size = Section.getSize();
- if (!Size)
- continue;
- outs() << "Contents of section " << Name << ":\n";
- if (Section.isBSS()) {
- outs() << format("<skipping contents of bss section at [%04" PRIx64
- ", %04" PRIx64 ")>\n",
- BaseAddr, BaseAddr + Size);
- continue;
- }
- StringRef Contents = unwrapOrError(Section.getContents(), Obj->getFileName());
- // Dump out the content as hex and printable ascii characters.
- for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
- outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
- // Dump line of hex.
- for (std::size_t I = 0; I < 16; ++I) {
- if (I != 0 && I % 4 == 0)
- outs() << ' ';
- if (Addr + I < End)
- outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
- << hexdigit(Contents[Addr + I] & 0xF, true);
- else
- outs() << " ";
- }
- // Print ascii.
- outs() << " ";
- for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
- if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
- outs() << Contents[Addr + I];
- else
- outs() << ".";
- }
- outs() << "\n";
- }
- }
- }
- void printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
- StringRef ArchitectureName) {
- outs() << "SYMBOL TABLE:\n";
- if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
- printCOFFSymbolTable(Coff);
- return;
- }
- const StringRef FileName = O->getFileName();
- for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
- // Skip printing the special zero symbol when dumping an ELF file.
- // This makes the output consistent with the GNU objdump.
- if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
- continue;
- const SymbolRef &Symbol = *I;
- uint64_t Address = unwrapOrError(Symbol.getAddress(), ArchiveName, FileName,
- ArchitectureName);
- if ((Address < StartAddress) || (Address > StopAddress))
- continue;
- SymbolRef::Type Type = unwrapOrError(Symbol.getType(), ArchiveName,
- FileName, ArchitectureName);
- uint32_t Flags = Symbol.getFlags();
- section_iterator Section = unwrapOrError(Symbol.getSection(), ArchiveName,
- FileName, ArchitectureName);
- StringRef Name;
- if (Type == SymbolRef::ST_Debug && Section != O->section_end())
- Section->getName(Name);
- else
- Name = unwrapOrError(Symbol.getName(), ArchiveName, FileName,
- ArchitectureName);
- bool Global = Flags & SymbolRef::SF_Global;
- bool Weak = Flags & SymbolRef::SF_Weak;
- bool Absolute = Flags & SymbolRef::SF_Absolute;
- bool Common = Flags & SymbolRef::SF_Common;
- bool Hidden = Flags & SymbolRef::SF_Hidden;
- char GlobLoc = ' ';
- if (Type != SymbolRef::ST_Unknown)
- GlobLoc = Global ? 'g' : 'l';
- char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
- ? 'd' : ' ';
- char FileFunc = ' ';
- if (Type == SymbolRef::ST_File)
- FileFunc = 'f';
- else if (Type == SymbolRef::ST_Function)
- FileFunc = 'F';
- else if (Type == SymbolRef::ST_Data)
- FileFunc = 'O';
- const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
- "%08" PRIx64;
- outs() << format(Fmt, Address) << " "
- << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
- << (Weak ? 'w' : ' ') // Weak?
- << ' ' // Constructor. Not supported yet.
- << ' ' // Warning. Not supported yet.
- << ' ' // Indirect reference to another symbol.
- << Debug // Debugging (d) or dynamic (D) symbol.
- << FileFunc // Name of function (F), file (f) or object (O).
- << ' ';
- if (Absolute) {
- outs() << "*ABS*";
- } else if (Common) {
- outs() << "*COM*";
- } else if (Section == O->section_end()) {
- outs() << "*UND*";
- } else {
- if (const MachOObjectFile *MachO =
- dyn_cast<const MachOObjectFile>(O)) {
- DataRefImpl DR = Section->getRawDataRefImpl();
- StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
- outs() << SegmentName << ",";
- }
- StringRef SectionName;
- error(Section->getName(SectionName));
- outs() << SectionName;
- }
- if (Common || isa<ELFObjectFileBase>(O)) {
- uint64_t Val =
- Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
- outs() << format("\t%08" PRIx64, Val);
- }
- if (isa<ELFObjectFileBase>(O)) {
- uint8_t Other = ELFSymbolRef(Symbol).getOther();
- switch (Other) {
- case ELF::STV_DEFAULT:
- break;
- case ELF::STV_INTERNAL:
- outs() << " .internal";
- break;
- case ELF::STV_HIDDEN:
- outs() << " .hidden";
- break;
- case ELF::STV_PROTECTED:
- outs() << " .protected";
- break;
- default:
- outs() << format(" 0x%02x", Other);
- break;
- }
- } else if (Hidden) {
- outs() << " .hidden";
- }
- if (Demangle)
- outs() << ' ' << demangle(Name) << '\n';
- else
- outs() << ' ' << Name << '\n';
- }
- }
- static void printUnwindInfo(const ObjectFile *O) {
- outs() << "Unwind info:\n\n";
- if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
- printCOFFUnwindInfo(Coff);
- else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
- printMachOUnwindInfo(MachO);
- else
- // TODO: Extract DWARF dump tool to objdump.
- WithColor::error(errs(), ToolName)
- << "This operation is only currently supported "
- "for COFF and MachO object files.\n";
- }
- /// Dump the raw contents of the __clangast section so the output can be piped
- /// into llvm-bcanalyzer.
- void printRawClangAST(const ObjectFile *Obj) {
- if (outs().is_displayed()) {
- WithColor::error(errs(), ToolName)
- << "The -raw-clang-ast option will dump the raw binary contents of "
- "the clang ast section.\n"
- "Please redirect the output to a file or another program such as "
- "llvm-bcanalyzer.\n";
- return;
- }
- StringRef ClangASTSectionName("__clangast");
- if (isa<COFFObjectFile>(Obj)) {
- ClangASTSectionName = "clangast";
- }
- Optional<object::SectionRef> ClangASTSection;
- for (auto Sec : ToolSectionFilter(*Obj)) {
- StringRef Name;
- Sec.getName(Name);
- if (Name == ClangASTSectionName) {
- ClangASTSection = Sec;
- break;
- }
- }
- if (!ClangASTSection)
- return;
- StringRef ClangASTContents = unwrapOrError(
- ClangASTSection.getValue().getContents(), Obj->getFileName());
- outs().write(ClangASTContents.data(), ClangASTContents.size());
- }
- static void printFaultMaps(const ObjectFile *Obj) {
- StringRef FaultMapSectionName;
- if (isa<ELFObjectFileBase>(Obj)) {
- FaultMapSectionName = ".llvm_faultmaps";
- } else if (isa<MachOObjectFile>(Obj)) {
- FaultMapSectionName = "__llvm_faultmaps";
- } else {
- WithColor::error(errs(), ToolName)
- << "This operation is only currently supported "
- "for ELF and Mach-O executable files.\n";
- return;
- }
- Optional<object::SectionRef> FaultMapSection;
- for (auto Sec : ToolSectionFilter(*Obj)) {
- StringRef Name;
- Sec.getName(Name);
- if (Name == FaultMapSectionName) {
- FaultMapSection = Sec;
- break;
- }
- }
- outs() << "FaultMap table:\n";
- if (!FaultMapSection.hasValue()) {
- outs() << "<not found>\n";
- return;
- }
- StringRef FaultMapContents =
- unwrapOrError(FaultMapSection.getValue().getContents(), Obj->getFileName());
- FaultMapParser FMP(FaultMapContents.bytes_begin(),
- FaultMapContents.bytes_end());
- outs() << FMP;
- }
- static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
- if (O->isELF()) {
- printELFFileHeader(O);
- printELFDynamicSection(O);
- printELFSymbolVersionInfo(O);
- return;
- }
- if (O->isCOFF())
- return printCOFFFileHeader(O);
- if (O->isWasm())
- return printWasmFileHeader(O);
- if (O->isMachO()) {
- printMachOFileHeader(O);
- if (!OnlyFirst)
- printMachOLoadCommands(O);
- return;
- }
- report_error(O->getFileName(), "Invalid/Unsupported object file format");
- }
- static void printFileHeaders(const ObjectFile *O) {
- if (!O->isELF() && !O->isCOFF())
- report_error(O->getFileName(), "Invalid/Unsupported object file format");
- Triple::ArchType AT = O->getArch();
- outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
- uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
- StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
- outs() << "start address: "
- << "0x" << format(Fmt.data(), Address) << "\n\n";
- }
- static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
- Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
- if (!ModeOrErr) {
- WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
- consumeError(ModeOrErr.takeError());
- return;
- }
- sys::fs::perms Mode = ModeOrErr.get();
- outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
- outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
- outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
- outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
- outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
- outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
- outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
- outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
- outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
- outs() << " ";
- outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
- unwrapOrError(C.getGID(), Filename),
- unwrapOrError(C.getRawSize(), Filename));
- StringRef RawLastModified = C.getRawLastModified();
- unsigned Seconds;
- if (RawLastModified.getAsInteger(10, Seconds))
- outs() << "(date: \"" << RawLastModified
- << "\" contains non-decimal chars) ";
- else {
- // Since ctime(3) returns a 26 character string of the form:
- // "Sun Sep 16 01:03:52 1973\n\0"
- // just print 24 characters.
- time_t t = Seconds;
- outs() << format("%.24s ", ctime(&t));
- }
- StringRef Name = "";
- Expected<StringRef> NameOrErr = C.getName();
- if (!NameOrErr) {
- consumeError(NameOrErr.takeError());
- Name = unwrapOrError(C.getRawName(), Filename);
- } else {
- Name = NameOrErr.get();
- }
- outs() << Name << "\n";
- }
- static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
- const Archive::Child *C = nullptr) {
- // Avoid other output when using a raw option.
- if (!RawClangAST) {
- outs() << '\n';
- if (A)
- outs() << A->getFileName() << "(" << O->getFileName() << ")";
- else
- outs() << O->getFileName();
- outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
- }
- StringRef ArchiveName = A ? A->getFileName() : "";
- if (FileHeaders)
- printFileHeaders(O);
- if (ArchiveHeaders && !MachOOpt && C)
- printArchiveChild(ArchiveName, *C);
- if (Disassemble)
- disassembleObject(O, Relocations);
- if (Relocations && !Disassemble)
- printRelocations(O);
- if (DynamicRelocations)
- printDynamicRelocations(O);
- if (SectionHeaders)
- printSectionHeaders(O);
- if (SectionContents)
- printSectionContents(O);
- if (SymbolTable)
- printSymbolTable(O, ArchiveName);
- if (UnwindInfo)
- printUnwindInfo(O);
- if (PrivateHeaders || FirstPrivateHeader)
- printPrivateFileHeaders(O, FirstPrivateHeader);
- if (ExportsTrie)
- printExportsTrie(O);
- if (Rebase)
- printRebaseTable(O);
- if (Bind)
- printBindTable(O);
- if (LazyBind)
- printLazyBindTable(O);
- if (WeakBind)
- printWeakBindTable(O);
- if (RawClangAST)
- printRawClangAST(O);
- if (FaultMapSection)
- printFaultMaps(O);
- if (DwarfDumpType != DIDT_Null) {
- std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
- // Dump the complete DWARF structure.
- DIDumpOptions DumpOpts;
- DumpOpts.DumpType = DwarfDumpType;
- DICtx->dump(outs(), DumpOpts);
- }
- }
- static void dumpObject(const COFFImportFile *I, const Archive *A,
- const Archive::Child *C = nullptr) {
- StringRef ArchiveName = A ? A->getFileName() : "";
- // Avoid other output when using a raw option.
- if (!RawClangAST)
- outs() << '\n'
- << ArchiveName << "(" << I->getFileName() << ")"
- << ":\tfile format COFF-import-file"
- << "\n\n";
- if (ArchiveHeaders && !MachOOpt && C)
- printArchiveChild(ArchiveName, *C);
- if (SymbolTable)
- printCOFFSymbolTable(I);
- }
- /// Dump each object file in \a a;
- static void dumpArchive(const Archive *A) {
- Error Err = Error::success();
- for (auto &C : A->children(Err)) {
- Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
- if (!ChildOrErr) {
- if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
- report_error(std::move(E), A->getFileName(), C);
- continue;
- }
- if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
- dumpObject(O, A, &C);
- else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
- dumpObject(I, A, &C);
- else
- report_error(errorCodeToError(object_error::invalid_file_type),
- A->getFileName());
- }
- if (Err)
- report_error(std::move(Err), A->getFileName());
- }
- /// Open file and figure out how to dump it.
- static void dumpInput(StringRef file) {
- // If we are using the Mach-O specific object file parser, then let it parse
- // the file and process the command line options. So the -arch flags can
- // be used to select specific slices, etc.
- if (MachOOpt) {
- parseInputMachO(file);
- return;
- }
- // Attempt to open the binary.
- OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
- Binary &Binary = *OBinary.getBinary();
- if (Archive *A = dyn_cast<Archive>(&Binary))
- dumpArchive(A);
- else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
- dumpObject(O);
- else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
- parseInputMachO(UB);
- else
- report_error(errorCodeToError(object_error::invalid_file_type), file);
- }
- } // namespace llvm
- int main(int argc, char **argv) {
- using namespace llvm;
- InitLLVM X(argc, argv);
- // Initialize targets and assembly printers/parsers.
- InitializeAllTargetInfos();
- InitializeAllTargetMCs();
- InitializeAllDisassemblers();
- // Register the target printer for --version.
- cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
- cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
- ToolName = argv[0];
- // Defaults to a.out if no filenames specified.
- if (InputFilenames.empty())
- InputFilenames.push_back("a.out");
- if (AllHeaders)
- ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
- SectionHeaders = SymbolTable = true;
- if (DisassembleAll || PrintSource || PrintLines)
- Disassemble = true;
- if (!ArchiveHeaders && !Disassemble && DwarfDumpType == DIDT_Null &&
- !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST &&
- !Relocations && !SectionHeaders && !SectionContents && !SymbolTable &&
- !UnwindInfo && !FaultMapSection &&
- !(MachOOpt &&
- (Bind || DataInCode || DylibId || DylibsUsed || ExportsTrie ||
- FirstPrivateHeader || IndirectSymbols || InfoPlist || LazyBind ||
- LinkOptHints || ObjcMetaData || Rebase || UniversalHeaders ||
- WeakBind || !FilterSections.empty()))) {
- cl::PrintHelpMessage();
- return 2;
- }
- DisasmFuncsSet.insert(DisassembleFunctions.begin(),
- DisassembleFunctions.end());
- llvm::for_each(InputFilenames, dumpInput);
- return EXIT_SUCCESS;
- }
|