tools/llvm-objdump/llvm-objdump.cpp

   1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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
  12 // flags.
  13 //
  14 // The flags and output of this program should be near identical to those of
  15 // binutils objdump.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm-objdump.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/ADT/StringExtras.h"
  22 #include "llvm/ADT/Triple.h"
  23 #include "llvm/MC/MCAsmInfo.h"
  24 #include "llvm/MC/MCAtom.h"
  25 #include "llvm/MC/MCContext.h"
  26 #include "llvm/MC/MCDisassembler.h"
  27 #include "llvm/MC/MCFunction.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/MCModule.h"
  33 #include "llvm/MC/MCModuleYAML.h"
  34 #include "llvm/MC/MCObjectDisassembler.h"
  35 #include "llvm/MC/MCObjectFileInfo.h"
  36 #include "llvm/MC/MCObjectSymbolizer.h"
  37 #include "llvm/MC/MCRegisterInfo.h"
  38 #include "llvm/MC/MCRelocationInfo.h"
  39 #include "llvm/MC/MCSubtargetInfo.h"
  40 #include "llvm/Object/Archive.h"
  41 #include "llvm/Object/COFF.h"
  42 #include "llvm/Object/MachO.h"
  43 #include "llvm/Object/ObjectFile.h"
  44 #include "llvm/Support/Casting.h"
  45 #include "llvm/Support/CommandLine.h"
  46 #include "llvm/Support/Debug.h"
  47 #include "llvm/Support/FileSystem.h"
  48 #include "llvm/Support/Format.h"
  49 #include "llvm/Support/GraphWriter.h"
  50 #include "llvm/Support/Host.h"
  51 #include "llvm/Support/ManagedStatic.h"
  52 #include "llvm/Support/MemoryBuffer.h"
  53 #include "llvm/Support/MemoryObject.h"
  54 #include "llvm/Support/PrettyStackTrace.h"
  55 #include "llvm/Support/Signals.h"
  56 #include "llvm/Support/SourceMgr.h"
  57 #include "llvm/Support/TargetRegistry.h"
  58 #include "llvm/Support/TargetSelect.h"
  59 #include "llvm/Support/raw_ostream.h"
  60 #include "llvm/Support/system_error.h"
  61 #include <algorithm>
  62 #include <cctype>
  63 #include <cstring>
  64
  65 using namespace llvm;
  66 using namespace object;
  67
  68 static cl::list<std::string>
  69 InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
  70
  71 static cl::opt<bool>
  72 Disassemble("disassemble",
  73   cl::desc("Display assembler mnemonics for the machine instructions"));
  74 static cl::alias
  75 Disassembled("d", cl::desc("Alias for --disassemble"),
  76              cl::aliasopt(Disassemble));
  77
  78 static cl::opt<bool>
  79 Relocations("r", cl::desc("Display the relocation entries in the file"));
  80
  81 static cl::opt<bool>
  82 SectionContents("s", cl::desc("Display the content of each section"));
  83
  84 static cl::opt<bool>
  85 SymbolTable("t", cl::desc("Display the symbol table"));
  86
  87 static cl::opt<bool>
  88 MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
  89 static cl::alias
  90 MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));
  91
  92 cl::opt<std::string>
  93 llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
  94                                     "see -version for available targets"));
  95
  96 cl::opt<std::string>
  97 llvm::ArchName("arch", cl::desc("Target arch to disassemble for, "
  98                                 "see -version for available targets"));
  99
 100 static cl::opt<bool>
 101 SectionHeaders("section-headers", cl::desc("Display summaries of the headers "
 102                                            "for each section."));
 103 static cl::alias
 104 SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
 105                     cl::aliasopt(SectionHeaders));
 106 static cl::alias
 107 SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
 108                       cl::aliasopt(SectionHeaders));
 109
 110 static cl::list<std::string>
 111 MAttrs("mattr",
 112   cl::CommaSeparated,
 113   cl::desc("Target specific attributes"),
 114   cl::value_desc("a1,+a2,-a3,..."));
 115
 116 static cl::opt<bool>
 117 NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling instructions, "
 118                                            "do not print the instruction bytes."));
 119
 120 static cl::opt<bool>
 121 UnwindInfo("unwind-info", cl::desc("Display unwind information"));
 122
 123 static cl::alias
 124 UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
 125                 cl::aliasopt(UnwindInfo));
 126
 127 static cl::opt<bool>
 128 PrivateHeaders("private-headers",
 129                cl::desc("Display format specific file headers"));
 130
 131 static cl::alias
 132 PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
 133                     cl::aliasopt(PrivateHeaders));
 134
 135 static cl::opt<bool>
 136 Symbolize("symbolize", cl::desc("When disassembling instructions, "
 137                                 "try to symbolize operands."));
 138
 139 static cl::opt<bool>
 140 CFG("cfg", cl::desc("Create a CFG for every function found in the object"
 141                       " and write it to a graphviz file"));
 142
 143 // FIXME: Does it make sense to have a dedicated tool for yaml cfg output?
 144 static cl::opt<std::string>
 145 YAMLCFG("yaml-cfg",
 146         cl::desc("Create a CFG and write it as a YAML MCModule."),
 147         cl::value_desc("yaml output file"));
 148
 149 static StringRef ToolName;
 150
 151 bool llvm::error(error_code EC) {
 152   if (!EC)
 153     return false;
 154
 155   outs() << ToolName << ": error reading file: " << EC.message() << ".\n";
 156   outs().flush();
 157   return true;
 158 }
 159
 160 static const Target *getTarget(const ObjectFile *Obj = NULL) {
 161   // Figure out the target triple.
 162   llvm::Triple TheTriple("unknown-unknown-unknown");
 163   if (TripleName.empty()) {
 164     if (Obj) {
 165       TheTriple.setArch(Triple::ArchType(Obj->getArch()));
 166       // TheTriple defaults to ELF, and COFF doesn't have an environment:
 167       // the best we can do here is indicate that it is mach-o.
 168       if (Obj->isMachO())
 169         TheTriple.setObjectFormat(Triple::MachO);
 170     }
 171   } else
 172     TheTriple.setTriple(Triple::normalize(TripleName));
 173
 174   // Get the target specific parser.
 175   std::string Error;
 176   const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
 177                                                          Error);
 178   if (!TheTarget) {
 179     errs() << ToolName << ": " << Error;
 180     return 0;
 181   }
 182
 183   // Update the triple name and return the found target.
 184   TripleName = TheTriple.getTriple();
 185   return TheTarget;
 186 }
 187
 188 // Write a graphviz file for the CFG inside an MCFunction.
 189 // FIXME: Use GraphWriter
 190 static void emitDOTFile(const char *FileName, const MCFunction &f,
 191                         MCInstPrinter *IP) {
 192   // Start a new dot file.
 193   std::string Error;
 194   raw_fd_ostream Out(FileName, Error, sys::fs::F_Text);
 195   if (!Error.empty()) {
 196     errs() << "llvm-objdump: warning: " << Error << '\n';
 197     return;
 198   }
 199
 200   Out << "digraph \"" << f.getName() << "\" {\n";
 201   Out << "graph [ rankdir = \"LR\" ];\n";
 202   for (MCFunction::const_iterator i = f.begin(), e = f.end(); i != e; ++i) {
 203     // Only print blocks that have predecessors.
 204     bool hasPreds = (*i)->pred_begin() != (*i)->pred_end();
 205
 206     if (!hasPreds && i != f.begin())
 207       continue;
 208
 209     Out << '"' << (*i)->getInsts()->getBeginAddr() << "\" [ label=\"<a>";
 210     // Print instructions.
 211     for (unsigned ii = 0, ie = (*i)->getInsts()->size(); ii != ie;
 212         ++ii) {
 213       if (ii != 0) // Not the first line, start a new row.
 214         Out << '|';
 215       if (ii + 1 == ie) // Last line, add an end id.
 216         Out << "<o>";
 217
 218       // Escape special chars and print the instruction in mnemonic form.
 219       std::string Str;
 220       raw_string_ostream OS(Str);
 221       IP->printInst(&(*i)->getInsts()->at(ii).Inst, OS, "");
 222       Out << DOT::EscapeString(OS.str());
 223     }
 224     Out << "\" shape=\"record\" ];\n";
 225
 226     // Add edges.
 227     for (MCBasicBlock::succ_const_iterator si = (*i)->succ_begin(),
 228         se = (*i)->succ_end(); si != se; ++si)
 229       Out << (*i)->getInsts()->getBeginAddr() << ":o -> "
 230           << (*si)->getInsts()->getBeginAddr() << ":a\n";
 231   }
 232   Out << "}\n";
 233 }
 234
 235 void llvm::DumpBytes(StringRef bytes) {
 236   static const char hex_rep[] = "0123456789abcdef";
 237   // FIXME: The real way to do this is to figure out the longest instruction
 238   //        and align to that size before printing. I'll fix this when I get
 239   //        around to outputting relocations.
 240   // 15 is the longest x86 instruction
 241   // 3 is for the hex rep of a byte + a space.
 242   // 1 is for the null terminator.
 243   enum { OutputSize = (15 * 3) + 1 };
 244   char output[OutputSize];
 245
 246   assert(bytes.size() <= 15
 247     && "DumpBytes only supports instructions of up to 15 bytes");
 248   memset(output, ' ', sizeof(output));
 249   unsigned index = 0;
 250   for (StringRef::iterator i = bytes.begin(),
 251                            e = bytes.end(); i != e; ++i) {
 252     output[index] = hex_rep[(*i & 0xF0) >> 4];
 253     output[index + 1] = hex_rep[*i & 0xF];
 254     index += 3;
 255   }
 256
 257   output[sizeof(output) - 1] = 0;
 258   outs() << output;
 259 }
 260
 261 bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
 262   uint64_t a_addr, b_addr;
 263   if (error(a.getOffset(a_addr))) return false;
 264   if (error(b.getOffset(b_addr))) return false;
 265   return a_addr < b_addr;
 266 }
 267
 268 static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
 269   const Target *TheTarget = getTarget(Obj);
 270   // getTarget() will have already issued a diagnostic if necessary, so
 271   // just bail here if it failed.
 272   if (!TheTarget)
 273     return;
 274
 275   // Package up features to be passed to target/subtarget
 276   std::string FeaturesStr;
 277   if (MAttrs.size()) {
 278     SubtargetFeatures Features;
 279     for (unsigned i = 0; i != MAttrs.size(); ++i)
 280       Features.AddFeature(MAttrs[i]);
 281     FeaturesStr = Features.getString();
 282   }
 283
 284   std::unique_ptr<const MCRegisterInfo> MRI(
 285       TheTarget->createMCRegInfo(TripleName));
 286   if (!MRI) {
 287     errs() << "error: no register info for target " << TripleName << "\n";
 288     return;
 289   }
 290
 291   // Set up disassembler.
 292   std::unique_ptr<const MCAsmInfo> AsmInfo(
 293       TheTarget->createMCAsmInfo(*MRI, TripleName));
 294   if (!AsmInfo) {
 295     errs() << "error: no assembly info for target " << TripleName << "\n";
 296     return;
 297   }
 298
 299   std::unique_ptr<const MCSubtargetInfo> STI(
 300       TheTarget->createMCSubtargetInfo(TripleName, "", FeaturesStr));
 301   if (!STI) {
 302     errs() << "error: no subtarget info for target " << TripleName << "\n";
 303     return;
 304   }
 305
 306   std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
 307   if (!MII) {
 308     errs() << "error: no instruction info for target " << TripleName << "\n";
 309     return;
 310   }
 311
 312   std::unique_ptr<const MCObjectFileInfo> MOFI(new MCObjectFileInfo);
 313   MCContext Ctx(AsmInfo.get(), MRI.get(), MOFI.get());
 314
 315   std::unique_ptr<MCDisassembler> DisAsm(
 316     TheTarget->createMCDisassembler(*STI, Ctx));
 317
 318   if (!DisAsm) {
 319     errs() << "error: no disassembler for target " << TripleName << "\n";
 320     return;
 321   }
 322
 323
 324   if (Symbolize) {
 325     std::unique_ptr<MCRelocationInfo> RelInfo(
 326         TheTarget->createMCRelocationInfo(TripleName, Ctx));
 327     if (RelInfo) {
 328       std::unique_ptr<MCSymbolizer> Symzer(
 329         MCObjectSymbolizer::createObjectSymbolizer(Ctx, std::move(RelInfo),
 330                                                    Obj));
 331       if (Symzer)
 332         DisAsm->setSymbolizer(std::move(Symzer));
 333     }
 334   }
 335
 336   std::unique_ptr<const MCInstrAnalysis> MIA(
 337       TheTarget->createMCInstrAnalysis(MII.get()));
 338
 339   int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
 340   std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
 341       AsmPrinterVariant, *AsmInfo, *MII, *MRI, *STI));
 342   if (!IP) {
 343     errs() << "error: no instruction printer for target " << TripleName
 344       << '\n';
 345     return;
 346   }
 347
 348   if (CFG || !YAMLCFG.empty()) {
 349     std::unique_ptr<MCObjectDisassembler> OD(
 350         new MCObjectDisassembler(*Obj, *DisAsm, *MIA));
 351     std::unique_ptr<MCModule> Mod(OD->buildModule(/* withCFG */ true));
 352     for (MCModule::const_atom_iterator AI = Mod->atom_begin(),
 353                                        AE = Mod->atom_end();
 354                                        AI != AE; ++AI) {
 355       outs() << "Atom " << (*AI)->getName() << ": \n";
 356       if (const MCTextAtom *TA = dyn_cast<MCTextAtom>(*AI)) {
 357         for (MCTextAtom::const_iterator II = TA->begin(), IE = TA->end();
 358              II != IE;
 359              ++II) {
 360           IP->printInst(&II->Inst, outs(), "");
 361           outs() << "\n";
 362         }
 363       }
 364     }
 365     if (CFG) {
 366       for (MCModule::const_func_iterator FI = Mod->func_begin(),
 367                                          FE = Mod->func_end();
 368                                          FI != FE; ++FI) {
 369         static int filenum = 0;
 370         emitDOTFile((Twine((*FI)->getName()) + "_" +
 371                      utostr(filenum) + ".dot").str().c_str(),
 372                       **FI, IP.get());
 373         ++filenum;
 374       }
 375     }
 376     if (!YAMLCFG.empty()) {
 377       std::string Error;
 378       raw_fd_ostream YAMLOut(YAMLCFG.c_str(), Error, sys::fs::F_Text);
 379       if (!Error.empty()) {
 380         errs() << ToolName << ": warning: " << Error << '\n';
 381         return;
 382       }
 383       mcmodule2yaml(YAMLOut, *Mod, *MII, *MRI);
 384     }
 385   }
 386
 387   StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ":  " :
 388                                                  "\t\t\t%08" PRIx64 ":  ";
 389
 390   // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
 391   // in RelocSecs contain the relocations for section S.
 392   error_code EC;
 393   std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
 394   for (const SectionRef &Section : Obj->sections()) {
 395     section_iterator Sec2 = Section.getRelocatedSection();
 396     if (Sec2 != Obj->section_end())
 397       SectionRelocMap[*Sec2].push_back(Section);
 398   }
 399
 400   for (const SectionRef &Section : Obj->sections()) {
 401     bool Text;
 402     if (error(Section.isText(Text)))
 403       break;
 404     if (!Text)
 405       continue;
 406
 407     uint64_t SectionAddr;
 408     if (error(Section.getAddress(SectionAddr)))
 409       break;
 410
 411     uint64_t SectSize;
 412     if (error(Section.getSize(SectSize)))
 413       break;
 414
 415     // Make a list of all the symbols in this section.
 416     std::vector<std::pair<uint64_t, StringRef>> Symbols;
 417     for (const SymbolRef &Symbol : Obj->symbols()) {
 418       bool contains;
 419       if (!error(Section.containsSymbol(Symbol, contains)) && contains) {
 420         uint64_t Address;
 421         if (error(Symbol.getAddress(Address)))
 422           break;
 423         if (Address == UnknownAddressOrSize)
 424           continue;
 425         Address -= SectionAddr;
 426         if (Address >= SectSize)
 427           continue;
 428
 429         StringRef Name;
 430         if (error(Symbol.getName(Name)))
 431           break;
 432         Symbols.push_back(std::make_pair(Address, Name));
 433       }
 434     }
 435
 436     // Sort the symbols by address, just in case they didn't come in that way.
 437     array_pod_sort(Symbols.begin(), Symbols.end());
 438
 439     // Make a list of all the relocations for this section.
 440     std::vector<RelocationRef> Rels;
 441     if (InlineRelocs) {
 442       for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
 443         for (const RelocationRef &Reloc : RelocSec.relocations()) {
 444           Rels.push_back(Reloc);
 445         }
 446       }
 447     }
 448
 449     // Sort relocations by address.
 450     std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
 451
 452     StringRef SegmentName = "";
 453     if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
 454       DataRefImpl DR = Section.getRawDataRefImpl();
 455       SegmentName = MachO->getSectionFinalSegmentName(DR);
 456     }
 457     StringRef name;
 458     if (error(Section.getName(name)))
 459       break;
 460     outs() << "Disassembly of section ";
 461     if (!SegmentName.empty())
 462       outs() << SegmentName << ",";
 463     outs() << name << ':';
 464
 465     // If the section has no symbols just insert a dummy one and disassemble
 466     // the whole section.
 467     if (Symbols.empty())
 468       Symbols.push_back(std::make_pair(0, name));
 469
 470
 471     SmallString<40> Comments;
 472     raw_svector_ostream CommentStream(Comments);
 473
 474     StringRef Bytes;
 475     if (error(Section.getContents(Bytes)))
 476       break;
 477     StringRefMemoryObject memoryObject(Bytes, SectionAddr);
 478     uint64_t Size;
 479     uint64_t Index;
 480
 481     std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
 482     std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
 483     // Disassemble symbol by symbol.
 484     for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
 485       uint64_t Start = Symbols[si].first;
 486       uint64_t End;
 487       // The end is either the size of the section or the beginning of the next
 488       // symbol.
 489       if (si == se - 1)
 490         End = SectSize;
 491       // Make sure this symbol takes up space.
 492       else if (Symbols[si + 1].first != Start)
 493         End = Symbols[si + 1].first - 1;
 494       else
 495         // This symbol has the same address as the next symbol. Skip it.
 496         continue;
 497
 498       outs() << '\n' << Symbols[si].second << ":\n";
 499
 500 #ifndef NDEBUG
 501       raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
 502 #else
 503       raw_ostream &DebugOut = nulls();
 504 #endif
 505
 506       for (Index = Start; Index < End; Index += Size) {
 507         MCInst Inst;
 508
 509         if (DisAsm->getInstruction(Inst, Size, memoryObject,
 510                                    SectionAddr + Index,
 511                                    DebugOut, CommentStream)) {
 512           outs() << format("%8" PRIx64 ":", SectionAddr + Index);
 513           if (!NoShowRawInsn) {
 514             outs() << "\t";
 515             DumpBytes(StringRef(Bytes.data() + Index, Size));
 516           }
 517           IP->printInst(&Inst, outs(), "");
 518           outs() << CommentStream.str();
 519           Comments.clear();
 520           outs() << "\n";
 521         } else {
 522           errs() << ToolName << ": warning: invalid instruction encoding\n";
 523           if (Size == 0)
 524             Size = 1; // skip illegible bytes
 525         }
 526
 527         // Print relocation for instruction.
 528         while (rel_cur != rel_end) {
 529           bool hidden = false;
 530           uint64_t addr;
 531           SmallString<16> name;
 532           SmallString<32> val;
 533
 534           // If this relocation is hidden, skip it.
 535           if (error(rel_cur->getHidden(hidden))) goto skip_print_rel;
 536           if (hidden) goto skip_print_rel;
 537
 538           if (error(rel_cur->getOffset(addr))) goto skip_print_rel;
 539           // Stop when rel_cur's address is past the current instruction.
 540           if (addr >= Index + Size) break;
 541           if (error(rel_cur->getTypeName(name))) goto skip_print_rel;
 542           if (error(rel_cur->getValueString(val))) goto skip_print_rel;
 543
 544           outs() << format(Fmt.data(), SectionAddr + addr) << name
 545                  << "\t" << val << "\n";
 546
 547         skip_print_rel:
 548           ++rel_cur;
 549         }
 550       }
 551     }
 552   }
 553 }
 554
 555 static void PrintRelocations(const ObjectFile *Obj) {
 556   StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
 557                                                  "%08" PRIx64;
 558   for (const SectionRef &Section : Obj->sections()) {
 559     if (Section.relocation_begin() == Section.relocation_end())
 560       continue;
 561     StringRef secname;
 562     if (error(Section.getName(secname)))
 563       continue;
 564     outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
 565     for (const RelocationRef &Reloc : Section.relocations()) {
 566       bool hidden;
 567       uint64_t address;
 568       SmallString<32> relocname;
 569       SmallString<32> valuestr;
 570       if (error(Reloc.getHidden(hidden)))
 571         continue;
 572       if (hidden)
 573         continue;
 574       if (error(Reloc.getTypeName(relocname)))
 575         continue;
 576       if (error(Reloc.getOffset(address)))
 577         continue;
 578       if (error(Reloc.getValueString(valuestr)))
 579         continue;
 580       outs() << format(Fmt.data(), address) << " " << relocname << " "
 581              << valuestr << "\n";
 582     }
 583     outs() << "\n";
 584   }
 585 }
 586
 587 static void PrintSectionHeaders(const ObjectFile *Obj) {
 588   outs() << "Sections:\n"
 589             "Idx Name          Size      Address          Type\n";
 590   unsigned i = 0;
 591   for (const SectionRef &Section : Obj->sections()) {
 592     StringRef Name;
 593     if (error(Section.getName(Name)))
 594       return;
 595     uint64_t Address;
 596     if (error(Section.getAddress(Address)))
 597       return;
 598     uint64_t Size;
 599     if (error(Section.getSize(Size)))
 600       return;
 601     bool Text, Data, BSS;
 602     if (error(Section.isText(Text)))
 603       return;
 604     if (error(Section.isData(Data)))
 605       return;
 606     if (error(Section.isBSS(BSS)))
 607       return;
 608     std::string Type = (std::string(Text ? "TEXT " : "") +
 609                         (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
 610     outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n", i,
 611                      Name.str().c_str(), Size, Address, Type.c_str());
 612     ++i;
 613   }
 614 }
 615
 616 static void PrintSectionContents(const ObjectFile *Obj) {
 617   error_code EC;
 618   for (const SectionRef &Section : Obj->sections()) {
 619     StringRef Name;
 620     StringRef Contents;
 621     uint64_t BaseAddr;
 622     bool BSS;
 623     if (error(Section.getName(Name)))
 624       continue;
 625     if (error(Section.getContents(Contents)))
 626       continue;
 627     if (error(Section.getAddress(BaseAddr)))
 628       continue;
 629     if (error(Section.isBSS(BSS)))
 630       continue;
 631
 632     outs() << "Contents of section " << Name << ":\n";
 633     if (BSS) {
 634       outs() << format("<skipping contents of bss section at [%04" PRIx64
 635                        ", %04" PRIx64 ")>\n", BaseAddr,
 636                        BaseAddr + Contents.size());
 637       continue;
 638     }
 639
 640     // Dump out the content as hex and printable ascii characters.
 641     for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
 642       outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
 643       // Dump line of hex.
 644       for (std::size_t i = 0; i < 16; ++i) {
 645         if (i != 0 && i % 4 == 0)
 646           outs() << ' ';
 647         if (addr + i < end)
 648           outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
 649                  << hexdigit(Contents[addr + i] & 0xF, true);
 650         else
 651           outs() << "  ";
 652       }
 653       // Print ascii.
 654       outs() << "  ";
 655       for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
 656         if (std::isprint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
 657           outs() << Contents[addr + i];
 658         else
 659           outs() << ".";
 660       }
 661       outs() << "\n";
 662     }
 663   }
 664 }
 665
 666 static void PrintCOFFSymbolTable(const COFFObjectFile *coff) {
 667   const coff_file_header *header;
 668   if (error(coff->getHeader(header)))
 669     return;
 670
 671   for (unsigned SI = 0, SE = header->NumberOfSymbols; SI != SE; ++SI) {
 672     const coff_symbol *Symbol;
 673     StringRef Name;
 674     if (error(coff->getSymbol(SI, Symbol)))
 675       return;
 676
 677     if (error(coff->getSymbolName(Symbol, Name)))
 678       return;
 679
 680     outs() << "[" << format("%2d", SI) << "]"
 681            << "(sec " << format("%2d", int(Symbol->SectionNumber)) << ")"
 682            << "(fl 0x00)" // Flag bits, which COFF doesn't have.
 683            << "(ty " << format("%3x", unsigned(Symbol->Type)) << ")"
 684            << "(scl " << format("%3x", unsigned(Symbol->StorageClass)) << ") "
 685            << "(nx " << unsigned(Symbol->NumberOfAuxSymbols) << ") "
 686            << "0x" << format("%08x", unsigned(Symbol->Value)) << " "
 687            << Name << "\n";
 688
 689     for (unsigned AI = 0, AE = Symbol->NumberOfAuxSymbols; AI < AE; ++AI, ++SI) {
 690       if (Symbol->isSectionDefinition()) {
 691         const coff_aux_section_definition *asd;
 692         if (error(coff->getAuxSymbol<coff_aux_section_definition>(SI + 1, asd)))
 693           return;
 694
 695         outs() << "AUX "
 696                << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
 697                          , unsigned(asd->Length)
 698                          , unsigned(asd->NumberOfRelocations)
 699                          , unsigned(asd->NumberOfLinenumbers)
 700                          , unsigned(asd->CheckSum))
 701                << format("assoc %d comdat %d\n"
 702                          , unsigned(asd->Number)
 703                          , unsigned(asd->Selection));
 704       } else if (Symbol->isFileRecord()) {
 705         const coff_aux_file *AF;
 706         if (error(coff->getAuxSymbol<coff_aux_file>(SI + 1, AF)))
 707           return;
 708
 709         StringRef Name(AF->FileName,
 710                        Symbol->NumberOfAuxSymbols * COFF::SymbolSize);
 711         outs() << "AUX " << Name.rtrim(StringRef("\0", 1))  << '\n';
 712
 713         SI = SI + Symbol->NumberOfAuxSymbols;
 714         break;
 715       } else {
 716         outs() << "AUX Unknown\n";
 717       }
 718     }
 719   }
 720 }
 721
 722 static void PrintSymbolTable(const ObjectFile *o) {
 723   outs() << "SYMBOL TABLE:\n";
 724
 725   if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
 726     PrintCOFFSymbolTable(coff);
 727     return;
 728   }
 729   for (const SymbolRef &Symbol : o->symbols()) {
 730     StringRef Name;
 731     uint64_t Address;
 732     SymbolRef::Type Type;
 733     uint64_t Size;
 734     uint32_t Flags = Symbol.getFlags();
 735     section_iterator Section = o->section_end();
 736     if (error(Symbol.getName(Name)))
 737       continue;
 738     if (error(Symbol.getAddress(Address)))
 739       continue;
 740     if (error(Symbol.getType(Type)))
 741       continue;
 742     if (error(Symbol.getSize(Size)))
 743       continue;
 744     if (error(Symbol.getSection(Section)))
 745       continue;
 746
 747     bool Global = Flags & SymbolRef::SF_Global;
 748     bool Weak = Flags & SymbolRef::SF_Weak;
 749     bool Absolute = Flags & SymbolRef::SF_Absolute;
 750
 751     if (Address == UnknownAddressOrSize)
 752       Address = 0;
 753     if (Size == UnknownAddressOrSize)
 754       Size = 0;
 755     char GlobLoc = ' ';
 756     if (Type != SymbolRef::ST_Unknown)
 757       GlobLoc = Global ? 'g' : 'l';
 758     char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
 759                  ? 'd' : ' ';
 760     char FileFunc = ' ';
 761     if (Type == SymbolRef::ST_File)
 762       FileFunc = 'f';
 763     else if (Type == SymbolRef::ST_Function)
 764       FileFunc = 'F';
 765
 766     const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
 767                                                    "%08" PRIx64;
 768
 769     outs() << format(Fmt, Address) << " "
 770            << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
 771            << (Weak ? 'w' : ' ') // Weak?
 772            << ' ' // Constructor. Not supported yet.
 773            << ' ' // Warning. Not supported yet.
 774            << ' ' // Indirect reference to another symbol.
 775            << Debug // Debugging (d) or dynamic (D) symbol.
 776            << FileFunc // Name of function (F), file (f) or object (O).
 777            << ' ';
 778     if (Absolute) {
 779       outs() << "*ABS*";
 780     } else if (Section == o->section_end()) {
 781       outs() << "*UND*";
 782     } else {
 783       if (const MachOObjectFile *MachO =
 784           dyn_cast<const MachOObjectFile>(o)) {
 785         DataRefImpl DR = Section->getRawDataRefImpl();
 786         StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
 787         outs() << SegmentName << ",";
 788       }
 789       StringRef SectionName;
 790       if (error(Section->getName(SectionName)))
 791         SectionName = "";
 792       outs() << SectionName;
 793     }
 794     outs() << '\t'
 795            << format("%08" PRIx64 " ", Size)
 796            << Name
 797            << '\n';
 798   }
 799 }
 800
 801 static void PrintUnwindInfo(const ObjectFile *o) {
 802   outs() << "Unwind info:\n\n";
 803
 804   if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
 805     printCOFFUnwindInfo(coff);
 806   } else {
 807     // TODO: Extract DWARF dump tool to objdump.
 808     errs() << "This operation is only currently supported "
 809               "for COFF object files.\n";
 810     return;
 811   }
 812 }
 813
 814 static void printPrivateFileHeader(const ObjectFile *o) {
 815   if (o->isELF()) {
 816     printELFFileHeader(o);
 817   } else if (o->isCOFF()) {
 818     printCOFFFileHeader(o);
 819   }
 820 }
 821
 822 static void DumpObject(const ObjectFile *o) {
 823   outs() << '\n';
 824   outs() << o->getFileName()
 825          << ":\tfile format " << o->getFileFormatName() << "\n\n";
 826
 827   if (Disassemble)
 828     DisassembleObject(o, Relocations);
 829   if (Relocations && !Disassemble)
 830     PrintRelocations(o);
 831   if (SectionHeaders)
 832     PrintSectionHeaders(o);
 833   if (SectionContents)
 834     PrintSectionContents(o);
 835   if (SymbolTable)
 836     PrintSymbolTable(o);
 837   if (UnwindInfo)
 838     PrintUnwindInfo(o);
 839   if (PrivateHeaders)
 840     printPrivateFileHeader(o);
 841 }
 842
 843 /// @brief Dump each object file in \a a;
 844 static void DumpArchive(const Archive *a) {
 845   for (Archive::child_iterator i = a->child_begin(), e = a->child_end(); i != e;
 846        ++i) {
 847     std::unique_ptr<Binary> child;
 848     if (error_code EC = i->getAsBinary(child)) {
 849       // Ignore non-object files.
 850       if (EC != object_error::invalid_file_type)
 851         errs() << ToolName << ": '" << a->getFileName() << "': " << EC.message()
 852                << ".\n";
 853       continue;
 854     }
 855     if (ObjectFile *o = dyn_cast<ObjectFile>(child.get()))
 856       DumpObject(o);
 857     else
 858       errs() << ToolName << ": '" << a->getFileName() << "': "
 859               << "Unrecognized file type.\n";
 860   }
 861 }
 862
 863 /// @brief Open file and figure out how to dump it.
 864 static void DumpInput(StringRef file) {
 865   // If file isn't stdin, check that it exists.
 866   if (file != "-" && !sys::fs::exists(file)) {
 867     errs() << ToolName << ": '" << file << "': " << "No such file\n";
 868     return;
 869   }
 870
 871   if (MachOOpt && Disassemble) {
 872     DisassembleInputMachO(file);
 873     return;
 874   }
 875
 876   // Attempt to open the binary.
 877   ErrorOr<Binary *> BinaryOrErr = createBinary(file);
 878   if (error_code EC = BinaryOrErr.getError()) {
 879     errs() << ToolName << ": '" << file << "': " << EC.message() << ".\n";
 880     return;
 881   }
 882   std::unique_ptr<Binary> binary(BinaryOrErr.get());
 883
 884   if (Archive *a = dyn_cast<Archive>(binary.get()))
 885     DumpArchive(a);
 886   else if (ObjectFile *o = dyn_cast<ObjectFile>(binary.get()))
 887     DumpObject(o);
 888   else
 889     errs() << ToolName << ": '" << file << "': " << "Unrecognized file type.\n";
 890 }
 891
 892 int main(int argc, char **argv) {
 893   // Print a stack trace if we signal out.
 894   sys::PrintStackTraceOnErrorSignal();
 895   PrettyStackTraceProgram X(argc, argv);
 896   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 897
 898   // Initialize targets and assembly printers/parsers.
 899   llvm::InitializeAllTargetInfos();
 900   llvm::InitializeAllTargetMCs();
 901   llvm::InitializeAllAsmParsers();
 902   llvm::InitializeAllDisassemblers();
 903
 904   // Register the target printer for --version.
 905   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 906
 907   cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
 908   TripleName = Triple::normalize(TripleName);
 909
 910   ToolName = argv[0];
 911
 912   // Defaults to a.out if no filenames specified.
 913   if (InputFilenames.size() == 0)
 914     InputFilenames.push_back("a.out");
 915
 916   if (!Disassemble
 917       && !Relocations
 918       && !SectionHeaders
 919       && !SectionContents
 920       && !SymbolTable
 921       && !UnwindInfo
 922       && !PrivateHeaders) {
 923     cl::PrintHelpMessage();
 924     return 2;
 925   }
 926
 927   std::for_each(InputFilenames.begin(), InputFilenames.end(),
 928                 DumpInput);
 929
 930   return 0;
 931 }