1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like binutils "objdump", that is, it
11 // dumps out a plethora of information about an object file depending on the
14 // The flags and output of this program should be near identical to those of
17 //===----------------------------------------------------------------------===//
19 #include "llvm-objdump.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/Triple.h"
24 #include "llvm/CodeGen/FaultMaps.h"
25 #include "llvm/MC/MCAsmInfo.h"
26 #include "llvm/MC/MCContext.h"
27 #include "llvm/MC/MCDisassembler.h"
28 #include "llvm/MC/MCInst.h"
29 #include "llvm/MC/MCInstPrinter.h"
30 #include "llvm/MC/MCInstrAnalysis.h"
31 #include "llvm/MC/MCInstrInfo.h"
32 #include "llvm/MC/MCObjectFileInfo.h"
33 #include "llvm/MC/MCRegisterInfo.h"
34 #include "llvm/MC/MCRelocationInfo.h"
35 #include "llvm/MC/MCSubtargetInfo.h"
36 #include "llvm/Object/Archive.h"
37 #include "llvm/Object/ELFObjectFile.h"
38 #include "llvm/Object/COFF.h"
39 #include "llvm/Object/MachO.h"
40 #include "llvm/Object/ObjectFile.h"
41 #include "llvm/Support/Casting.h"
42 #include "llvm/Support/CommandLine.h"
43 #include "llvm/Support/Debug.h"
44 #include "llvm/Support/Errc.h"
45 #include "llvm/Support/FileSystem.h"
46 #include "llvm/Support/Format.h"
47 #include "llvm/Support/GraphWriter.h"
48 #include "llvm/Support/Host.h"
49 #include "llvm/Support/ManagedStatic.h"
50 #include "llvm/Support/MemoryBuffer.h"
51 #include "llvm/Support/PrettyStackTrace.h"
52 #include "llvm/Support/Signals.h"
53 #include "llvm/Support/SourceMgr.h"
54 #include "llvm/Support/TargetRegistry.h"
55 #include "llvm/Support/TargetSelect.h"
56 #include "llvm/Support/raw_ostream.h"
60 #include <system_error>
63 using namespace object;
65 static cl::list<std::string>
66 InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
69 llvm::Disassemble("disassemble",
70 cl::desc("Display assembler mnemonics for the machine instructions"));
72 Disassembled("d", cl::desc("Alias for --disassemble"),
73 cl::aliasopt(Disassemble));
76 llvm::Relocations("r", cl::desc("Display the relocation entries in the file"));
79 llvm::SectionContents("s", cl::desc("Display the content of each section"));
82 llvm::SymbolTable("t", cl::desc("Display the symbol table"));
85 llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
88 llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
91 llvm::Bind("bind", cl::desc("Display mach-o binding info"));
94 llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
97 llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
100 MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
102 MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));
105 llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
106 "see -version for available targets"));
110 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
111 cl::value_desc("cpu-name"),
115 llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
116 "see -version for available targets"));
119 llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
120 "headers for each section."));
122 SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
123 cl::aliasopt(SectionHeaders));
125 SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
126 cl::aliasopt(SectionHeaders));
128 cl::list<std::string>
129 llvm::MAttrs("mattr",
131 cl::desc("Target specific attributes"),
132 cl::value_desc("a1,+a2,-a3,..."));
135 llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
136 "instructions, do not print "
137 "the instruction bytes."));
140 llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
143 UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
144 cl::aliasopt(UnwindInfo));
147 llvm::PrivateHeaders("private-headers",
148 cl::desc("Display format specific file headers"));
151 PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
152 cl::aliasopt(PrivateHeaders));
155 llvm::PrintImmHex("print-imm-hex",
156 cl::desc("Use hex format for immediate values"));
158 cl::opt<bool> PrintFaultMaps("fault-map-section",
159 cl::desc("Display contents of faultmap section"));
161 static StringRef ToolName;
162 static int ReturnValue = EXIT_SUCCESS;
164 bool llvm::error(std::error_code EC) {
168 outs() << ToolName << ": error reading file: " << EC.message() << ".\n";
170 ReturnValue = EXIT_FAILURE;
174 static void report_error(StringRef File, std::error_code EC) {
176 errs() << ToolName << ": '" << File << "': " << EC.message() << ".\n";
177 ReturnValue = EXIT_FAILURE;
180 static const Target *getTarget(const ObjectFile *Obj = nullptr) {
181 // Figure out the target triple.
182 llvm::Triple TheTriple("unknown-unknown-unknown");
183 if (TripleName.empty()) {
185 TheTriple.setArch(Triple::ArchType(Obj->getArch()));
186 // TheTriple defaults to ELF, and COFF doesn't have an environment:
187 // the best we can do here is indicate that it is mach-o.
189 TheTriple.setObjectFormat(Triple::MachO);
192 const auto COFFObj = dyn_cast<COFFObjectFile>(Obj);
193 if (COFFObj->getArch() == Triple::thumb)
194 TheTriple.setTriple("thumbv7-windows");
198 TheTriple.setTriple(Triple::normalize(TripleName));
200 // Get the target specific parser.
202 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
205 errs() << ToolName << ": " << Error;
209 // Update the triple name and return the found target.
210 TripleName = TheTriple.getTriple();
214 bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
215 uint64_t a_addr = a.getOffset();
216 uint64_t b_addr = b.getOffset();
217 return a_addr < b_addr;
221 class PrettyPrinter {
223 virtual ~PrettyPrinter(){}
224 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
225 ArrayRef<uint8_t> Bytes, uint64_t Address,
226 raw_ostream &OS, StringRef Annot,
227 MCSubtargetInfo const &STI) {
228 outs() << format("%8" PRIx64 ":", Address);
229 if (!NoShowRawInsn) {
231 dumpBytes(Bytes, outs());
233 IP.printInst(MI, outs(), "", STI);
236 PrettyPrinter PrettyPrinterInst;
237 class HexagonPrettyPrinter : public PrettyPrinter {
239 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
242 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
243 OS << format("%8" PRIx64 ":", Address);
244 if (!NoShowRawInsn) {
246 dumpBytes(Bytes.slice(0, 4), OS);
247 OS << format("%08" PRIx32, opcode);
250 void printInst(MCInstPrinter &IP, const MCInst *MI,
251 ArrayRef<uint8_t> Bytes, uint64_t Address,
252 raw_ostream &OS, StringRef Annot,
253 MCSubtargetInfo const &STI) override {
256 raw_string_ostream TempStream(Buffer);
257 IP.printInst(MI, TempStream, "", STI);
259 StringRef Contents(Buffer);
260 // Split off bundle attributes
261 auto PacketBundle = Contents.rsplit('\n');
262 // Split off first instruction from the rest
263 auto HeadTail = PacketBundle.first.split('\n');
264 auto Preamble = " { ";
266 while(!HeadTail.first.empty()) {
269 printLead(Bytes, Address, OS);
273 auto Duplex = HeadTail.first.split('\v');
274 if(!Duplex.second.empty()){
277 Inst = Duplex.second;
280 Inst = HeadTail.first;
282 Bytes = Bytes.slice(4);
284 HeadTail = HeadTail.second.split('\n');
286 OS << " } " << PacketBundle.second;
289 HexagonPrettyPrinter HexagonPrettyPrinterInst;
290 PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
291 switch(Triple.getArch()) {
293 return PrettyPrinterInst;
294 case Triple::hexagon:
295 return HexagonPrettyPrinterInst;
300 template <class ELFT>
301 static const typename ELFObjectFile<ELFT>::Elf_Rel *
302 getRel(const ELFFile<ELFT> &EF, DataRefImpl Rel) {
303 typedef typename ELFObjectFile<ELFT>::Elf_Rel Elf_Rel;
304 return EF.template getEntry<Elf_Rel>(Rel.d.a, Rel.d.b);
307 template <class ELFT>
308 static const typename ELFObjectFile<ELFT>::Elf_Rela *
309 getRela(const ELFFile<ELFT> &EF, DataRefImpl Rela) {
310 typedef typename ELFObjectFile<ELFT>::Elf_Rela Elf_Rela;
311 return EF.template getEntry<Elf_Rela>(Rela.d.a, Rela.d.b);
314 template <class ELFT>
315 static std::error_code getRelocationValueString(const ELFObjectFile<ELFT> *Obj,
317 SmallVectorImpl<char> &Result) {
318 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
319 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
320 const ELFFile<ELFT> &EF = *Obj->getELFFile();
322 const Elf_Shdr *sec = EF.getSection(Rel.d.a);
323 const Elf_Shdr *SymTab = EF.getSection(sec->sh_link);
324 assert(SymTab->sh_type == ELF::SHT_SYMTAB ||
325 SymTab->sh_type == ELF::SHT_DYNSYM);
326 const Elf_Shdr *StrTabSec = EF.getSection(SymTab->sh_link);
327 ErrorOr<StringRef> StrTabOrErr = EF.getStringTable(StrTabSec);
328 if (std::error_code EC = StrTabOrErr.getError())
330 StringRef StrTab = *StrTabOrErr;
334 uint16_t symbol_index = 0;
335 switch (sec->sh_type) {
337 return object_error::parse_failed;
339 type = getRel(EF, Rel)->getType(EF.isMips64EL());
340 symbol_index = getRel(EF, Rel)->getSymbol(EF.isMips64EL());
341 // TODO: Read implicit addend from section data.
344 case ELF::SHT_RELA: {
345 type = getRela(EF, Rel)->getType(EF.isMips64EL());
346 symbol_index = getRela(EF, Rel)->getSymbol(EF.isMips64EL());
347 addend = getRela(EF, Rel)->r_addend;
351 const Elf_Sym *symb =
352 EF.template getEntry<Elf_Sym>(sec->sh_link, symbol_index);
354 const Elf_Shdr *SymSec = EF.getSection(symb);
355 if (symb->getType() == ELF::STT_SECTION) {
356 ErrorOr<StringRef> SecName = EF.getSectionName(SymSec);
357 if (std::error_code EC = SecName.getError())
361 ErrorOr<StringRef> SymName = symb->getName(StrTab);
363 return SymName.getError();
366 switch (EF.getHeader()->e_machine) {
369 case ELF::R_X86_64_PC8:
370 case ELF::R_X86_64_PC16:
371 case ELF::R_X86_64_PC32: {
373 raw_string_ostream fmt(fmtbuf);
374 fmt << Target << (addend < 0 ? "" : "+") << addend << "-P";
376 Result.append(fmtbuf.begin(), fmtbuf.end());
378 case ELF::R_X86_64_8:
379 case ELF::R_X86_64_16:
380 case ELF::R_X86_64_32:
381 case ELF::R_X86_64_32S:
382 case ELF::R_X86_64_64: {
384 raw_string_ostream fmt(fmtbuf);
385 fmt << Target << (addend < 0 ? "" : "+") << addend;
387 Result.append(fmtbuf.begin(), fmtbuf.end());
393 case ELF::EM_AARCH64: {
395 raw_string_ostream fmt(fmtbuf);
398 fmt << (addend < 0 ? "" : "+") << addend;
400 Result.append(fmtbuf.begin(), fmtbuf.end());
405 case ELF::EM_HEXAGON:
413 Result.append(res.begin(), res.end());
414 return std::error_code();
417 static std::error_code getRelocationValueString(const ELFObjectFileBase *Obj,
418 const RelocationRef &RelRef,
419 SmallVectorImpl<char> &Result) {
420 DataRefImpl Rel = RelRef.getRawDataRefImpl();
421 if (auto *ELF32LE = dyn_cast<ELF32LEObjectFile>(Obj))
422 return getRelocationValueString(ELF32LE, Rel, Result);
423 if (auto *ELF64LE = dyn_cast<ELF64LEObjectFile>(Obj))
424 return getRelocationValueString(ELF64LE, Rel, Result);
425 if (auto *ELF32BE = dyn_cast<ELF32BEObjectFile>(Obj))
426 return getRelocationValueString(ELF32BE, Rel, Result);
427 auto *ELF64BE = cast<ELF64BEObjectFile>(Obj);
428 return getRelocationValueString(ELF64BE, Rel, Result);
431 static std::error_code getRelocationValueString(const COFFObjectFile *Obj,
432 const RelocationRef &Rel,
433 SmallVectorImpl<char> &Result) {
434 symbol_iterator SymI = Rel.getSymbol();
436 if (std::error_code EC = SymI->getName(SymName))
438 Result.append(SymName.begin(), SymName.end());
439 return std::error_code();
442 static void printRelocationTargetName(const MachOObjectFile *O,
443 const MachO::any_relocation_info &RE,
444 raw_string_ostream &fmt) {
445 bool IsScattered = O->isRelocationScattered(RE);
447 // Target of a scattered relocation is an address. In the interest of
448 // generating pretty output, scan through the symbol table looking for a
449 // symbol that aligns with that address. If we find one, print it.
450 // Otherwise, we just print the hex address of the target.
452 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
454 for (const SymbolRef &Symbol : O->symbols()) {
459 if ((ec = Symbol.getAddress(Addr)))
460 report_fatal_error(ec.message());
463 if ((ec = Symbol.getName(Name)))
464 report_fatal_error(ec.message());
469 // If we couldn't find a symbol that this relocation refers to, try
470 // to find a section beginning instead.
471 for (const SectionRef &Section : O->sections()) {
475 uint64_t Addr = Section.getAddress();
478 if ((ec = Section.getName(Name)))
479 report_fatal_error(ec.message());
484 fmt << format("0x%x", Val);
489 bool isExtern = O->getPlainRelocationExternal(RE);
490 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
493 symbol_iterator SI = O->symbol_begin();
497 section_iterator SI = O->section_begin();
498 // Adjust for the fact that sections are 1-indexed.
499 advance(SI, Val - 1);
506 static std::error_code getRelocationValueString(const MachOObjectFile *Obj,
507 const RelocationRef &RelRef,
508 SmallVectorImpl<char> &Result) {
509 DataRefImpl Rel = RelRef.getRawDataRefImpl();
510 MachO::any_relocation_info RE = Obj->getRelocation(Rel);
512 unsigned Arch = Obj->getArch();
515 raw_string_ostream fmt(fmtbuf);
516 unsigned Type = Obj->getAnyRelocationType(RE);
517 bool IsPCRel = Obj->getAnyRelocationPCRel(RE);
519 // Determine any addends that should be displayed with the relocation.
520 // These require decoding the relocation type, which is triple-specific.
522 // X86_64 has entirely custom relocation types.
523 if (Arch == Triple::x86_64) {
524 bool isPCRel = Obj->getAnyRelocationPCRel(RE);
527 case MachO::X86_64_RELOC_GOT_LOAD:
528 case MachO::X86_64_RELOC_GOT: {
529 printRelocationTargetName(Obj, RE, fmt);
535 case MachO::X86_64_RELOC_SUBTRACTOR: {
536 DataRefImpl RelNext = Rel;
537 Obj->moveRelocationNext(RelNext);
538 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
540 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
541 // X86_64_RELOC_UNSIGNED.
542 // NOTE: Scattered relocations don't exist on x86_64.
543 unsigned RType = Obj->getAnyRelocationType(RENext);
544 if (RType != MachO::X86_64_RELOC_UNSIGNED)
545 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
546 "X86_64_RELOC_SUBTRACTOR.");
548 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
549 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
550 printRelocationTargetName(Obj, RENext, fmt);
552 printRelocationTargetName(Obj, RE, fmt);
555 case MachO::X86_64_RELOC_TLV:
556 printRelocationTargetName(Obj, RE, fmt);
561 case MachO::X86_64_RELOC_SIGNED_1:
562 printRelocationTargetName(Obj, RE, fmt);
565 case MachO::X86_64_RELOC_SIGNED_2:
566 printRelocationTargetName(Obj, RE, fmt);
569 case MachO::X86_64_RELOC_SIGNED_4:
570 printRelocationTargetName(Obj, RE, fmt);
574 printRelocationTargetName(Obj, RE, fmt);
577 // X86 and ARM share some relocation types in common.
578 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
579 Arch == Triple::ppc) {
580 // Generic relocation types...
582 case MachO::GENERIC_RELOC_PAIR: // prints no info
583 return std::error_code();
584 case MachO::GENERIC_RELOC_SECTDIFF: {
585 DataRefImpl RelNext = Rel;
586 Obj->moveRelocationNext(RelNext);
587 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
589 // X86 sect diff's must be followed by a relocation of type
590 // GENERIC_RELOC_PAIR.
591 unsigned RType = Obj->getAnyRelocationType(RENext);
593 if (RType != MachO::GENERIC_RELOC_PAIR)
594 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
595 "GENERIC_RELOC_SECTDIFF.");
597 printRelocationTargetName(Obj, RE, fmt);
599 printRelocationTargetName(Obj, RENext, fmt);
604 if (Arch == Triple::x86 || Arch == Triple::ppc) {
606 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
607 DataRefImpl RelNext = Rel;
608 Obj->moveRelocationNext(RelNext);
609 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
611 // X86 sect diff's must be followed by a relocation of type
612 // GENERIC_RELOC_PAIR.
613 unsigned RType = Obj->getAnyRelocationType(RENext);
614 if (RType != MachO::GENERIC_RELOC_PAIR)
615 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
616 "GENERIC_RELOC_LOCAL_SECTDIFF.");
618 printRelocationTargetName(Obj, RE, fmt);
620 printRelocationTargetName(Obj, RENext, fmt);
623 case MachO::GENERIC_RELOC_TLV: {
624 printRelocationTargetName(Obj, RE, fmt);
631 printRelocationTargetName(Obj, RE, fmt);
633 } else { // ARM-specific relocations
635 case MachO::ARM_RELOC_HALF:
636 case MachO::ARM_RELOC_HALF_SECTDIFF: {
637 // Half relocations steal a bit from the length field to encode
638 // whether this is an upper16 or a lower16 relocation.
639 bool isUpper = Obj->getAnyRelocationLength(RE) >> 1;
645 printRelocationTargetName(Obj, RE, fmt);
647 DataRefImpl RelNext = Rel;
648 Obj->moveRelocationNext(RelNext);
649 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
651 // ARM half relocs must be followed by a relocation of type
653 unsigned RType = Obj->getAnyRelocationType(RENext);
654 if (RType != MachO::ARM_RELOC_PAIR)
655 report_fatal_error("Expected ARM_RELOC_PAIR after "
658 // NOTE: The half of the target virtual address is stashed in the
659 // address field of the secondary relocation, but we can't reverse
660 // engineer the constant offset from it without decoding the movw/movt
661 // instruction to find the other half in its immediate field.
663 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
664 // symbol/section pointer of the follow-on relocation.
665 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
667 printRelocationTargetName(Obj, RENext, fmt);
673 default: { printRelocationTargetName(Obj, RE, fmt); }
677 printRelocationTargetName(Obj, RE, fmt);
680 Result.append(fmtbuf.begin(), fmtbuf.end());
681 return std::error_code();
684 static std::error_code getRelocationValueString(const RelocationRef &Rel,
685 SmallVectorImpl<char> &Result) {
686 const ObjectFile *Obj = Rel.getObject();
687 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
688 return getRelocationValueString(ELF, Rel, Result);
689 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
690 return getRelocationValueString(COFF, Rel, Result);
691 auto *MachO = cast<MachOObjectFile>(Obj);
692 return getRelocationValueString(MachO, Rel, Result);
695 static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
696 const Target *TheTarget = getTarget(Obj);
697 // getTarget() will have already issued a diagnostic if necessary, so
698 // just bail here if it failed.
702 // Package up features to be passed to target/subtarget
703 std::string FeaturesStr;
705 SubtargetFeatures Features;
706 for (unsigned i = 0; i != MAttrs.size(); ++i)
707 Features.AddFeature(MAttrs[i]);
708 FeaturesStr = Features.getString();
711 std::unique_ptr<const MCRegisterInfo> MRI(
712 TheTarget->createMCRegInfo(TripleName));
714 errs() << "error: no register info for target " << TripleName << "\n";
718 // Set up disassembler.
719 std::unique_ptr<const MCAsmInfo> AsmInfo(
720 TheTarget->createMCAsmInfo(*MRI, TripleName));
722 errs() << "error: no assembly info for target " << TripleName << "\n";
726 std::unique_ptr<const MCSubtargetInfo> STI(
727 TheTarget->createMCSubtargetInfo(TripleName, MCPU, FeaturesStr));
729 errs() << "error: no subtarget info for target " << TripleName << "\n";
733 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
735 errs() << "error: no instruction info for target " << TripleName << "\n";
739 std::unique_ptr<const MCObjectFileInfo> MOFI(new MCObjectFileInfo);
740 MCContext Ctx(AsmInfo.get(), MRI.get(), MOFI.get());
742 std::unique_ptr<MCDisassembler> DisAsm(
743 TheTarget->createMCDisassembler(*STI, Ctx));
746 errs() << "error: no disassembler for target " << TripleName << "\n";
750 std::unique_ptr<const MCInstrAnalysis> MIA(
751 TheTarget->createMCInstrAnalysis(MII.get()));
753 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
754 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
755 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
757 errs() << "error: no instruction printer for target " << TripleName
761 IP->setPrintImmHex(PrintImmHex);
762 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
764 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ": " :
765 "\t\t\t%08" PRIx64 ": ";
767 // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
768 // in RelocSecs contain the relocations for section S.
770 std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
771 for (const SectionRef &Section : Obj->sections()) {
772 section_iterator Sec2 = Section.getRelocatedSection();
773 if (Sec2 != Obj->section_end())
774 SectionRelocMap[*Sec2].push_back(Section);
777 for (const SectionRef &Section : Obj->sections()) {
778 if (!Section.isText() || Section.isVirtual())
781 uint64_t SectionAddr = Section.getAddress();
782 uint64_t SectSize = Section.getSize();
786 // Make a list of all the symbols in this section.
787 std::vector<std::pair<uint64_t, StringRef>> Symbols;
788 for (const SymbolRef &Symbol : Obj->symbols()) {
789 if (Section.containsSymbol(Symbol)) {
791 if (error(Symbol.getAddress(Address)))
793 if (Address == UnknownAddress)
795 Address -= SectionAddr;
796 if (Address >= SectSize)
800 if (error(Symbol.getName(Name)))
802 Symbols.push_back(std::make_pair(Address, Name));
806 // Sort the symbols by address, just in case they didn't come in that way.
807 array_pod_sort(Symbols.begin(), Symbols.end());
809 // Make a list of all the relocations for this section.
810 std::vector<RelocationRef> Rels;
812 for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
813 for (const RelocationRef &Reloc : RelocSec.relocations()) {
814 Rels.push_back(Reloc);
819 // Sort relocations by address.
820 std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
822 StringRef SegmentName = "";
823 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
824 DataRefImpl DR = Section.getRawDataRefImpl();
825 SegmentName = MachO->getSectionFinalSegmentName(DR);
828 if (error(Section.getName(name)))
830 outs() << "Disassembly of section ";
831 if (!SegmentName.empty())
832 outs() << SegmentName << ",";
833 outs() << name << ':';
835 // If the section has no symbol at the start, just insert a dummy one.
836 if (Symbols.empty() || Symbols[0].first != 0)
837 Symbols.insert(Symbols.begin(), std::make_pair(0, name));
839 SmallString<40> Comments;
840 raw_svector_ostream CommentStream(Comments);
843 if (error(Section.getContents(BytesStr)))
845 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
851 std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
852 std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
853 // Disassemble symbol by symbol.
854 for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
856 uint64_t Start = Symbols[si].first;
857 // The end is either the section end or the beginning of the next symbol.
858 uint64_t End = (si == se - 1) ? SectSize : Symbols[si + 1].first;
859 // If this symbol has the same address as the next symbol, then skip it.
863 outs() << '\n' << Symbols[si].second << ":\n";
866 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
868 raw_ostream &DebugOut = nulls();
871 for (Index = Start; Index < End; Index += Size) {
874 if (DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
875 SectionAddr + Index, DebugOut,
877 PIP.printInst(*IP, &Inst,
878 Bytes.slice(Index, Size),
879 SectionAddr + Index, outs(), "", *STI);
880 outs() << CommentStream.str();
884 errs() << ToolName << ": warning: invalid instruction encoding\n";
886 Size = 1; // skip illegible bytes
889 // Print relocation for instruction.
890 while (rel_cur != rel_end) {
892 uint64_t addr = rel_cur->getOffset();
893 SmallString<16> name;
896 // If this relocation is hidden, skip it.
897 if (error(rel_cur->getHidden(hidden))) goto skip_print_rel;
898 if (hidden) goto skip_print_rel;
900 // Stop when rel_cur's address is past the current instruction.
901 if (addr >= Index + Size) break;
902 if (error(rel_cur->getTypeName(name))) goto skip_print_rel;
903 if (error(getRelocationValueString(*rel_cur, val)))
905 outs() << format(Fmt.data(), SectionAddr + addr) << name
906 << "\t" << val << "\n";
916 void llvm::PrintRelocations(const ObjectFile *Obj) {
917 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
919 // Regular objdump doesn't print relocations in non-relocatable object
921 if (!Obj->isRelocatableObject())
924 for (const SectionRef &Section : Obj->sections()) {
925 if (Section.relocation_begin() == Section.relocation_end())
928 if (error(Section.getName(secname)))
930 outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
931 for (const RelocationRef &Reloc : Section.relocations()) {
933 uint64_t address = Reloc.getOffset();
934 SmallString<32> relocname;
935 SmallString<32> valuestr;
936 if (error(Reloc.getHidden(hidden)))
940 if (error(Reloc.getTypeName(relocname)))
942 if (error(getRelocationValueString(Reloc, valuestr)))
944 outs() << format(Fmt.data(), address) << " " << relocname << " "
951 void llvm::PrintSectionHeaders(const ObjectFile *Obj) {
952 outs() << "Sections:\n"
953 "Idx Name Size Address Type\n";
955 for (const SectionRef &Section : Obj->sections()) {
957 if (error(Section.getName(Name)))
959 uint64_t Address = Section.getAddress();
960 uint64_t Size = Section.getSize();
961 bool Text = Section.isText();
962 bool Data = Section.isData();
963 bool BSS = Section.isBSS();
964 std::string Type = (std::string(Text ? "TEXT " : "") +
965 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
966 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n", i,
967 Name.str().c_str(), Size, Address, Type.c_str());
972 void llvm::PrintSectionContents(const ObjectFile *Obj) {
974 for (const SectionRef &Section : Obj->sections()) {
977 if (error(Section.getName(Name)))
979 uint64_t BaseAddr = Section.getAddress();
980 uint64_t Size = Section.getSize();
984 outs() << "Contents of section " << Name << ":\n";
985 if (Section.isBSS()) {
986 outs() << format("<skipping contents of bss section at [%04" PRIx64
987 ", %04" PRIx64 ")>\n",
988 BaseAddr, BaseAddr + Size);
992 if (error(Section.getContents(Contents)))
995 // Dump out the content as hex and printable ascii characters.
996 for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
997 outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
999 for (std::size_t i = 0; i < 16; ++i) {
1000 if (i != 0 && i % 4 == 0)
1003 outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
1004 << hexdigit(Contents[addr + i] & 0xF, true);
1010 for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
1011 if (std::isprint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
1012 outs() << Contents[addr + i];
1021 static void PrintCOFFSymbolTable(const COFFObjectFile *coff) {
1022 for (unsigned SI = 0, SE = coff->getNumberOfSymbols(); SI != SE; ++SI) {
1023 ErrorOr<COFFSymbolRef> Symbol = coff->getSymbol(SI);
1025 if (error(Symbol.getError()))
1028 if (error(coff->getSymbolName(*Symbol, Name)))
1031 outs() << "[" << format("%2d", SI) << "]"
1032 << "(sec " << format("%2d", int(Symbol->getSectionNumber())) << ")"
1033 << "(fl 0x00)" // Flag bits, which COFF doesn't have.
1034 << "(ty " << format("%3x", unsigned(Symbol->getType())) << ")"
1035 << "(scl " << format("%3x", unsigned(Symbol->getStorageClass())) << ") "
1036 << "(nx " << unsigned(Symbol->getNumberOfAuxSymbols()) << ") "
1037 << "0x" << format("%08x", unsigned(Symbol->getValue())) << " "
1040 for (unsigned AI = 0, AE = Symbol->getNumberOfAuxSymbols(); AI < AE; ++AI, ++SI) {
1041 if (Symbol->isSectionDefinition()) {
1042 const coff_aux_section_definition *asd;
1043 if (error(coff->getAuxSymbol<coff_aux_section_definition>(SI + 1, asd)))
1046 int32_t AuxNumber = asd->getNumber(Symbol->isBigObj());
1049 << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
1050 , unsigned(asd->Length)
1051 , unsigned(asd->NumberOfRelocations)
1052 , unsigned(asd->NumberOfLinenumbers)
1053 , unsigned(asd->CheckSum))
1054 << format("assoc %d comdat %d\n"
1055 , unsigned(AuxNumber)
1056 , unsigned(asd->Selection));
1057 } else if (Symbol->isFileRecord()) {
1058 const char *FileName;
1059 if (error(coff->getAuxSymbol<char>(SI + 1, FileName)))
1062 StringRef Name(FileName, Symbol->getNumberOfAuxSymbols() *
1063 coff->getSymbolTableEntrySize());
1064 outs() << "AUX " << Name.rtrim(StringRef("\0", 1)) << '\n';
1066 SI = SI + Symbol->getNumberOfAuxSymbols();
1069 outs() << "AUX Unknown\n";
1075 void llvm::PrintSymbolTable(const ObjectFile *o) {
1076 outs() << "SYMBOL TABLE:\n";
1078 if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
1079 PrintCOFFSymbolTable(coff);
1082 for (const SymbolRef &Symbol : o->symbols()) {
1084 SymbolRef::Type Type = Symbol.getType();
1085 uint32_t Flags = Symbol.getFlags();
1086 section_iterator Section = o->section_end();
1087 if (error(Symbol.getAddress(Address)))
1089 if (error(Symbol.getSection(Section)))
1092 if (Type == SymbolRef::ST_Debug && Section != o->section_end()) {
1093 Section->getName(Name);
1094 } else if (error(Symbol.getName(Name))) {
1098 bool Global = Flags & SymbolRef::SF_Global;
1099 bool Weak = Flags & SymbolRef::SF_Weak;
1100 bool Absolute = Flags & SymbolRef::SF_Absolute;
1101 bool Common = Flags & SymbolRef::SF_Common;
1102 bool Hidden = Flags & SymbolRef::SF_Hidden;
1105 Address = Symbol.getCommonSize();
1107 if (Address == UnknownAddress)
1110 if (Type != SymbolRef::ST_Unknown)
1111 GlobLoc = Global ? 'g' : 'l';
1112 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1114 char FileFunc = ' ';
1115 if (Type == SymbolRef::ST_File)
1117 else if (Type == SymbolRef::ST_Function)
1120 const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
1123 outs() << format(Fmt, Address) << " "
1124 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1125 << (Weak ? 'w' : ' ') // Weak?
1126 << ' ' // Constructor. Not supported yet.
1127 << ' ' // Warning. Not supported yet.
1128 << ' ' // Indirect reference to another symbol.
1129 << Debug // Debugging (d) or dynamic (D) symbol.
1130 << FileFunc // Name of function (F), file (f) or object (O).
1134 } else if (Common) {
1136 } else if (Section == o->section_end()) {
1139 if (const MachOObjectFile *MachO =
1140 dyn_cast<const MachOObjectFile>(o)) {
1141 DataRefImpl DR = Section->getRawDataRefImpl();
1142 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1143 outs() << SegmentName << ",";
1145 StringRef SectionName;
1146 if (error(Section->getName(SectionName)))
1148 outs() << SectionName;
1152 if (Common || isa<ELFObjectFileBase>(o)) {
1154 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
1155 outs() << format("\t %08" PRIx64 " ", Val);
1159 outs() << ".hidden ";
1166 static void PrintUnwindInfo(const ObjectFile *o) {
1167 outs() << "Unwind info:\n\n";
1169 if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
1170 printCOFFUnwindInfo(coff);
1171 } else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1172 printMachOUnwindInfo(MachO);
1174 // TODO: Extract DWARF dump tool to objdump.
1175 errs() << "This operation is only currently supported "
1176 "for COFF and MachO object files.\n";
1181 void llvm::printExportsTrie(const ObjectFile *o) {
1182 outs() << "Exports trie:\n";
1183 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1184 printMachOExportsTrie(MachO);
1186 errs() << "This operation is only currently supported "
1187 "for Mach-O executable files.\n";
1192 void llvm::printRebaseTable(const ObjectFile *o) {
1193 outs() << "Rebase table:\n";
1194 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1195 printMachORebaseTable(MachO);
1197 errs() << "This operation is only currently supported "
1198 "for Mach-O executable files.\n";
1203 void llvm::printBindTable(const ObjectFile *o) {
1204 outs() << "Bind table:\n";
1205 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1206 printMachOBindTable(MachO);
1208 errs() << "This operation is only currently supported "
1209 "for Mach-O executable files.\n";
1214 void llvm::printLazyBindTable(const ObjectFile *o) {
1215 outs() << "Lazy bind table:\n";
1216 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1217 printMachOLazyBindTable(MachO);
1219 errs() << "This operation is only currently supported "
1220 "for Mach-O executable files.\n";
1225 void llvm::printWeakBindTable(const ObjectFile *o) {
1226 outs() << "Weak bind table:\n";
1227 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1228 printMachOWeakBindTable(MachO);
1230 errs() << "This operation is only currently supported "
1231 "for Mach-O executable files.\n";
1236 static void printFaultMaps(const ObjectFile *Obj) {
1237 const char *FaultMapSectionName = nullptr;
1239 if (isa<ELFObjectFileBase>(Obj)) {
1240 FaultMapSectionName = ".llvm_faultmaps";
1241 } else if (isa<MachOObjectFile>(Obj)) {
1242 FaultMapSectionName = "__llvm_faultmaps";
1244 errs() << "This operation is only currently supported "
1245 "for ELF and Mach-O executable files.\n";
1249 Optional<object::SectionRef> FaultMapSection;
1251 for (auto Sec : Obj->sections()) {
1254 if (Name == FaultMapSectionName) {
1255 FaultMapSection = Sec;
1260 outs() << "FaultMap table:\n";
1262 if (!FaultMapSection.hasValue()) {
1263 outs() << "<not found>\n";
1267 StringRef FaultMapContents;
1268 if (error(FaultMapSection.getValue().getContents(FaultMapContents))) {
1269 errs() << "Could not read the " << FaultMapContents << " section!\n";
1273 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1274 FaultMapContents.bytes_end());
1279 static void printPrivateFileHeader(const ObjectFile *o) {
1281 printELFFileHeader(o);
1282 } else if (o->isCOFF()) {
1283 printCOFFFileHeader(o);
1284 } else if (o->isMachO()) {
1285 printMachOFileHeader(o);
1289 static void DumpObject(const ObjectFile *o) {
1291 outs() << o->getFileName()
1292 << ":\tfile format " << o->getFileFormatName() << "\n\n";
1295 DisassembleObject(o, Relocations);
1296 if (Relocations && !Disassemble)
1297 PrintRelocations(o);
1299 PrintSectionHeaders(o);
1300 if (SectionContents)
1301 PrintSectionContents(o);
1303 PrintSymbolTable(o);
1307 printPrivateFileHeader(o);
1309 printExportsTrie(o);
1311 printRebaseTable(o);
1315 printLazyBindTable(o);
1317 printWeakBindTable(o);
1322 /// @brief Dump each object file in \a a;
1323 static void DumpArchive(const Archive *a) {
1324 for (Archive::child_iterator i = a->child_begin(), e = a->child_end(); i != e;
1326 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = i->getAsBinary();
1327 if (std::error_code EC = ChildOrErr.getError()) {
1328 // Ignore non-object files.
1329 if (EC != object_error::invalid_file_type)
1330 report_error(a->getFileName(), EC);
1333 if (ObjectFile *o = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
1336 report_error(a->getFileName(), object_error::invalid_file_type);
1340 /// @brief Open file and figure out how to dump it.
1341 static void DumpInput(StringRef file) {
1342 // If file isn't stdin, check that it exists.
1343 if (file != "-" && !sys::fs::exists(file)) {
1344 report_error(file, errc::no_such_file_or_directory);
1348 // If we are using the Mach-O specific object file parser, then let it parse
1349 // the file and process the command line options. So the -arch flags can
1350 // be used to select specific slices, etc.
1352 ParseInputMachO(file);
1356 // Attempt to open the binary.
1357 ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
1358 if (std::error_code EC = BinaryOrErr.getError()) {
1359 report_error(file, EC);
1362 Binary &Binary = *BinaryOrErr.get().getBinary();
1364 if (Archive *a = dyn_cast<Archive>(&Binary))
1366 else if (ObjectFile *o = dyn_cast<ObjectFile>(&Binary))
1369 report_error(file, object_error::invalid_file_type);
1372 int main(int argc, char **argv) {
1373 // Print a stack trace if we signal out.
1374 sys::PrintStackTraceOnErrorSignal();
1375 PrettyStackTraceProgram X(argc, argv);
1376 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
1378 // Initialize targets and assembly printers/parsers.
1379 llvm::InitializeAllTargetInfos();
1380 llvm::InitializeAllTargetMCs();
1381 llvm::InitializeAllAsmParsers();
1382 llvm::InitializeAllDisassemblers();
1384 // Register the target printer for --version.
1385 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
1387 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
1388 TripleName = Triple::normalize(TripleName);
1392 // Defaults to a.out if no filenames specified.
1393 if (InputFilenames.size() == 0)
1394 InputFilenames.push_back("a.out");
1408 && !(UniversalHeaders && MachOOpt)
1409 && !(ArchiveHeaders && MachOOpt)
1410 && !(IndirectSymbols && MachOOpt)
1411 && !(DataInCode && MachOOpt)
1412 && !(LinkOptHints && MachOOpt)
1413 && !(InfoPlist && MachOOpt)
1414 && !(DylibsUsed && MachOOpt)
1415 && !(DylibId && MachOOpt)
1416 && !(ObjcMetaData && MachOOpt)
1417 && !(DumpSections.size() != 0 && MachOOpt)
1418 && !PrintFaultMaps) {
1419 cl::PrintHelpMessage();
1423 std::for_each(InputFilenames.begin(), InputFilenames.end(),