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<MCDisassembler> DisAsm(TheTarget->createMCDisassembler(*STI));
 313   if (!DisAsm) {
 314     errs() << "error: no disassembler for target " << TripleName << "\n";
 315     return;
 316   }
 317
 318   std::unique_ptr<const MCObjectFileInfo> MOFI;
 319   std::unique_ptr<MCContext> Ctx;
 320
 321   if (Symbolize) {
 322     MOFI.reset(new MCObjectFileInfo);
 323     Ctx.reset(new MCContext(AsmInfo.get(), MRI.get(), MOFI.get()));
 324     std::unique_ptr<MCRelocationInfo> RelInfo(
 325         TheTarget->createMCRelocationInfo(TripleName, *Ctx.get()));
 326     if (RelInfo) {
 327       std::unique_ptr<MCSymbolizer> Symzer(
 328           MCObjectSymbolizer::createObjectSymbolizer(*Ctx.get(), RelInfo, Obj));
 329       if (Symzer)
 330         DisAsm->setSymbolizer(std::move(Symzer));
 331     }
 332   }
 333
 334   std::unique_ptr<const MCInstrAnalysis> MIA(
 335       TheTarget->createMCInstrAnalysis(MII.get()));
 336
 337   int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
 338   std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
 339       AsmPrinterVariant, *AsmInfo, *MII, *MRI, *STI));
 340   if (!IP) {
 341     errs() << "error: no instruction printer for target " << TripleName
 342       << '\n';
 343     return;
 344   }
 345
 346   if (CFG || !YAMLCFG.empty()) {
 347     std::unique_ptr<MCObjectDisassembler> OD(
 348         new MCObjectDisassembler(*Obj, *DisAsm, *MIA));
 349     std::unique_ptr<MCModule> Mod(OD->buildModule(/* withCFG */ true));
 350     for (MCModule::const_atom_iterator AI = Mod->atom_begin(),
 351                                        AE = Mod->atom_end();
 352                                        AI != AE; ++AI) {
 353       outs() << "Atom " << (*AI)->getName() << ": \n";
 354       if (const MCTextAtom *TA = dyn_cast<MCTextAtom>(*AI)) {
 355         for (MCTextAtom::const_iterator II = TA->begin(), IE = TA->end();
 356              II != IE;
 357              ++II) {
 358           IP->printInst(&II->Inst, outs(), "");
 359           outs() << "\n";
 360         }
 361       }
 362     }
 363     if (CFG) {
 364       for (MCModule::const_func_iterator FI = Mod->func_begin(),
 365                                          FE = Mod->func_end();
 366                                          FI != FE; ++FI) {
 367         static int filenum = 0;
 368         emitDOTFile((Twine((*FI)->getName()) + "_" +
 369                      utostr(filenum) + ".dot").str().c_str(),
 370                       **FI, IP.get());
 371         ++filenum;
 372       }
 373     }
 374     if (!YAMLCFG.empty()) {
 375       std::string Error;
 376       raw_fd_ostream YAMLOut(YAMLCFG.c_str(), Error, sys::fs::F_Text);
 377       if (!Error.empty()) {
 378         errs() << ToolName << ": warning: " << Error << '\n';
 379         return;
 380       }
 381       mcmodule2yaml(YAMLOut, *Mod, *MII, *MRI);
 382     }
 383   }
 384
 385   // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
 386   // in RelocSecs contain the relocations for section S.
 387   error_code EC;
 388   std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
 389   for (const SectionRef &Section : Obj->sections()) {
 390     section_iterator Sec2 = Section.getRelocatedSection();
 391     if (Sec2 != Obj->section_end())
 392       SectionRelocMap[*Sec2].push_back(Section);
 393   }
 394
 395   for (const SectionRef &Section : Obj->sections()) {
 396     bool Text;
 397     if (error(Section.isText(Text)))
 398       break;
 399     if (!Text)
 400       continue;
 401
 402     uint64_t SectionAddr;
 403     if (error(Section.getAddress(SectionAddr)))
 404       break;
 405
 406     uint64_t SectSize;
 407     if (error(Section.getSize(SectSize)))
 408       break;
 409
 410     // Make a list of all the symbols in this section.
 411     std::vector<std::pair<uint64_t, StringRef>> Symbols;
 412     for (const SymbolRef &Symbol : Obj->symbols()) {
 413       bool contains;
 414       if (!error(Section.containsSymbol(Symbol, contains)) && contains) {
 415         uint64_t Address;
 416         if (error(Symbol.getAddress(Address)))
 417           break;
 418         if (Address == UnknownAddressOrSize)
 419           continue;
 420         Address -= SectionAddr;
 421         if (Address >= SectSize)
 422           continue;
 423
 424         StringRef Name;
 425         if (error(Symbol.getName(Name)))
 426           break;
 427         Symbols.push_back(std::make_pair(Address, Name));
 428       }
 429     }
 430
 431     // Sort the symbols by address, just in case they didn't come in that way.
 432     array_pod_sort(Symbols.begin(), Symbols.end());
 433
 434     // Make a list of all the relocations for this section.
 435     std::vector<RelocationRef> Rels;
 436     if (InlineRelocs) {
 437       for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
 438         for (const RelocationRef &Reloc : RelocSec.relocations()) {
 439           Rels.push_back(Reloc);
 440         }
 441       }
 442     }
 443
 444     // Sort relocations by address.
 445     std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
 446
 447     StringRef SegmentName = "";
 448     if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
 449       DataRefImpl DR = Section.getRawDataRefImpl();
 450       SegmentName = MachO->getSectionFinalSegmentName(DR);
 451     }
 452     StringRef name;
 453     if (error(Section.getName(name)))
 454       break;
 455     outs() << "Disassembly of section ";
 456     if (!SegmentName.empty())
 457       outs() << SegmentName << ",";
 458     outs() << name << ':';
 459
 460     // If the section has no symbols just insert a dummy one and disassemble
 461     // the whole section.
 462     if (Symbols.empty())
 463       Symbols.push_back(std::make_pair(0, name));
 464
 465
 466     SmallString<40> Comments;
 467     raw_svector_ostream CommentStream(Comments);
 468
 469     StringRef Bytes;
 470     if (error(Section.getContents(Bytes)))
 471       break;
 472     StringRefMemoryObject memoryObject(Bytes, SectionAddr);
 473     uint64_t Size;
 474     uint64_t Index;
 475
 476     std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
 477     std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
 478     // Disassemble symbol by symbol.
 479     for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
 480       uint64_t Start = Symbols[si].first;
 481       uint64_t End;
 482       // The end is either the size of the section or the beginning of the next
 483       // symbol.
 484       if (si == se - 1)
 485         End = SectSize;
 486       // Make sure this symbol takes up space.
 487       else if (Symbols[si + 1].first != Start)
 488         End = Symbols[si + 1].first - 1;
 489       else
 490         // This symbol has the same address as the next symbol. Skip it.
 491         continue;
 492
 493       outs() << '\n' << Symbols[si].second << ":\n";
 494
 495 #ifndef NDEBUG
 496       raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
 497 #else
 498       raw_ostream &DebugOut = nulls();
 499 #endif
 500
 501       for (Index = Start; Index < End; Index += Size) {
 502         MCInst Inst;
 503
 504         if (DisAsm->getInstruction(Inst, Size, memoryObject,
 505                                    SectionAddr + Index,
 506                                    DebugOut, CommentStream)) {
 507           outs() << format("%8" PRIx64 ":", SectionAddr + Index);
 508           if (!NoShowRawInsn) {
 509             outs() << "\t";
 510             DumpBytes(StringRef(Bytes.data() + Index, Size));
 511           }
 512           IP->printInst(&Inst, outs(), "");
 513           outs() << CommentStream.str();
 514           Comments.clear();
 515           outs() << "\n";
 516         } else {
 517           errs() << ToolName << ": warning: invalid instruction encoding\n";
 518           if (Size == 0)
 519             Size = 1; // skip illegible bytes
 520         }
 521
 522         // Print relocation for instruction.
 523         while (rel_cur != rel_end) {
 524           bool hidden = false;
 525           uint64_t addr;
 526           SmallString<16> name;
 527           SmallString<32> val;
 528
 529           // If this relocation is hidden, skip it.
 530           if (error(rel_cur->getHidden(hidden))) goto skip_print_rel;
 531           if (hidden) goto skip_print_rel;
 532
 533           if (error(rel_cur->getOffset(addr))) goto skip_print_rel;
 534           // Stop when rel_cur's address is past the current instruction.
 535           if (addr >= Index + Size) break;
 536           if (error(rel_cur->getTypeName(name))) goto skip_print_rel;
 537           if (error(rel_cur->getValueString(val))) goto skip_print_rel;
 538
 539           outs() << format("\t\t\t%8" PRIx64 ": ", SectionAddr + addr) << name
 540                  << "\t" << val << "\n";
 541
 542         skip_print_rel:
 543           ++rel_cur;
 544         }
 545       }
 546     }
 547   }
 548 }
 549
 550 static void PrintRelocations(const ObjectFile *Obj) {
 551   for (const SectionRef &Section : Obj->sections()) {
 552     if (Section.relocation_begin() == Section.relocation_end())
 553       continue;
 554     StringRef secname;
 555     if (error(Section.getName(secname)))
 556       continue;
 557     outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
 558     for (const RelocationRef &Reloc : Section.relocations()) {
 559       bool hidden;
 560       uint64_t address;
 561       SmallString<32> relocname;
 562       SmallString<32> valuestr;
 563       if (error(Reloc.getHidden(hidden)))
 564         continue;
 565       if (hidden)
 566         continue;
 567       if (error(Reloc.getTypeName(relocname)))
 568         continue;
 569       if (error(Reloc.getOffset(address)))
 570         continue;
 571       if (error(Reloc.getValueString(valuestr)))
 572         continue;
 573       outs() << address << " " << relocname << " " << valuestr << "\n";
 574     }
 575     outs() << "\n";
 576   }
 577 }
 578
 579 static void PrintSectionHeaders(const ObjectFile *Obj) {
 580   outs() << "Sections:\n"
 581             "Idx Name          Size      Address          Type\n";
 582   unsigned i = 0;
 583   for (const SectionRef &Section : Obj->sections()) {
 584     StringRef Name;
 585     if (error(Section.getName(Name)))
 586       return;
 587     uint64_t Address;
 588     if (error(Section.getAddress(Address)))
 589       return;
 590     uint64_t Size;
 591     if (error(Section.getSize(Size)))
 592       return;
 593     bool Text, Data, BSS;
 594     if (error(Section.isText(Text)))
 595       return;
 596     if (error(Section.isData(Data)))
 597       return;
 598     if (error(Section.isBSS(BSS)))
 599       return;
 600     std::string Type = (std::string(Text ? "TEXT " : "") +
 601                         (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
 602     outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n", i,
 603                      Name.str().c_str(), Size, Address, Type.c_str());
 604     ++i;
 605   }
 606 }
 607
 608 static void PrintSectionContents(const ObjectFile *Obj) {
 609   error_code EC;
 610   for (const SectionRef &Section : Obj->sections()) {
 611     StringRef Name;
 612     StringRef Contents;
 613     uint64_t BaseAddr;
 614     bool BSS;
 615     if (error(Section.getName(Name)))
 616       continue;
 617     if (error(Section.getContents(Contents)))
 618       continue;
 619     if (error(Section.getAddress(BaseAddr)))
 620       continue;
 621     if (error(Section.isBSS(BSS)))
 622       continue;
 623
 624     outs() << "Contents of section " << Name << ":\n";
 625     if (BSS) {
 626       outs() << format("<skipping contents of bss section at [%04" PRIx64
 627                        ", %04" PRIx64 ")>\n", BaseAddr,
 628                        BaseAddr + Contents.size());
 629       continue;
 630     }
 631
 632     // Dump out the content as hex and printable ascii characters.
 633     for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
 634       outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
 635       // Dump line of hex.
 636       for (std::size_t i = 0; i < 16; ++i) {
 637         if (i != 0 && i % 4 == 0)
 638           outs() << ' ';
 639         if (addr + i < end)
 640           outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
 641                  << hexdigit(Contents[addr + i] & 0xF, true);
 642         else
 643           outs() << "  ";
 644       }
 645       // Print ascii.
 646       outs() << "  ";
 647       for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
 648         if (std::isprint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
 649           outs() << Contents[addr + i];
 650         else
 651           outs() << ".";
 652       }
 653       outs() << "\n";
 654     }
 655   }
 656 }
 657
 658 static void PrintCOFFSymbolTable(const COFFObjectFile *coff) {
 659   const coff_file_header *header;
 660   if (error(coff->getHeader(header))) return;
 661   int aux_count = 0;
 662   const coff_symbol *symbol = 0;
 663   for (int i = 0, e = header->NumberOfSymbols; i != e; ++i) {
 664     if (aux_count--) {
 665       // Figure out which type of aux this is.
 666       if (symbol->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC
 667           && symbol->Value == 0) { // Section definition.
 668         const coff_aux_section_definition *asd;
 669         if (error(coff->getAuxSymbol<coff_aux_section_definition>(i, asd)))
 670           return;
 671         outs() << "AUX "
 672                << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
 673                          , unsigned(asd->Length)
 674                          , unsigned(asd->NumberOfRelocations)
 675                          , unsigned(asd->NumberOfLinenumbers)
 676                          , unsigned(asd->CheckSum))
 677                << format("assoc %d comdat %d\n"
 678                          , unsigned(asd->Number)
 679                          , unsigned(asd->Selection));
 680       } else
 681         outs() << "AUX Unknown\n";
 682     } else {
 683       StringRef name;
 684       if (error(coff->getSymbol(i, symbol))) return;
 685       if (error(coff->getSymbolName(symbol, name))) return;
 686       outs() << "[" << format("%2d", i) << "]"
 687              << "(sec " << format("%2d", int(symbol->SectionNumber)) << ")"
 688              << "(fl 0x00)" // Flag bits, which COFF doesn't have.
 689              << "(ty " << format("%3x", unsigned(symbol->Type)) << ")"
 690              << "(scl " << format("%3x", unsigned(symbol->StorageClass)) << ") "
 691              << "(nx " << unsigned(symbol->NumberOfAuxSymbols) << ") "
 692              << "0x" << format("%08x", unsigned(symbol->Value)) << " "
 693              << name << "\n";
 694       aux_count = symbol->NumberOfAuxSymbols;
 695     }
 696   }
 697 }
 698
 699 static void PrintSymbolTable(const ObjectFile *o) {
 700   outs() << "SYMBOL TABLE:\n";
 701
 702   if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o))
 703     PrintCOFFSymbolTable(coff);
 704   else {
 705     for (const SymbolRef &Symbol : o->symbols()) {
 706       StringRef Name;
 707       uint64_t Address;
 708       SymbolRef::Type Type;
 709       uint64_t Size;
 710       uint32_t Flags = Symbol.getFlags();
 711       section_iterator Section = o->section_end();
 712       if (error(Symbol.getName(Name)))
 713         continue;
 714       if (error(Symbol.getAddress(Address)))
 715         continue;
 716       if (error(Symbol.getType(Type)))
 717         continue;
 718       if (error(Symbol.getSize(Size)))
 719         continue;
 720       if (error(Symbol.getSection(Section)))
 721         continue;
 722
 723       bool Global = Flags & SymbolRef::SF_Global;
 724       bool Weak = Flags & SymbolRef::SF_Weak;
 725       bool Absolute = Flags & SymbolRef::SF_Absolute;
 726
 727       if (Address == UnknownAddressOrSize)
 728         Address = 0;
 729       if (Size == UnknownAddressOrSize)
 730         Size = 0;
 731       char GlobLoc = ' ';
 732       if (Type != SymbolRef::ST_Unknown)
 733         GlobLoc = Global ? 'g' : 'l';
 734       char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
 735                    ? 'd' : ' ';
 736       char FileFunc = ' ';
 737       if (Type == SymbolRef::ST_File)
 738         FileFunc = 'f';
 739       else if (Type == SymbolRef::ST_Function)
 740         FileFunc = 'F';
 741
 742       const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
 743                                                      "%08" PRIx64;
 744
 745       outs() << format(Fmt, Address) << " "
 746              << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
 747              << (Weak ? 'w' : ' ') // Weak?
 748              << ' ' // Constructor. Not supported yet.
 749              << ' ' // Warning. Not supported yet.
 750              << ' ' // Indirect reference to another symbol.
 751              << Debug // Debugging (d) or dynamic (D) symbol.
 752              << FileFunc // Name of function (F), file (f) or object (O).
 753              << ' ';
 754       if (Absolute)
 755         outs() << "*ABS*";
 756       else if (Section == o->section_end())
 757         outs() << "*UND*";
 758       else {
 759         if (const MachOObjectFile *MachO =
 760             dyn_cast<const MachOObjectFile>(o)) {
 761           DataRefImpl DR = Section->getRawDataRefImpl();
 762           StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
 763           outs() << SegmentName << ",";
 764         }
 765         StringRef SectionName;
 766         if (error(Section->getName(SectionName)))
 767           SectionName = "";
 768         outs() << SectionName;
 769       }
 770       outs() << '\t'
 771              << format("%08" PRIx64 " ", Size)
 772              << Name
 773              << '\n';
 774     }
 775   }
 776 }
 777
 778 static void PrintUnwindInfo(const ObjectFile *o) {
 779   outs() << "Unwind info:\n\n";
 780
 781   if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
 782     printCOFFUnwindInfo(coff);
 783   } else {
 784     // TODO: Extract DWARF dump tool to objdump.
 785     errs() << "This operation is only currently supported "
 786               "for COFF object files.\n";
 787     return;
 788   }
 789 }
 790
 791 static void printPrivateFileHeader(const ObjectFile *o) {
 792   if (o->isELF()) {
 793     printELFFileHeader(o);
 794   } else if (o->isCOFF()) {
 795     printCOFFFileHeader(o);
 796   }
 797 }
 798
 799 static void DumpObject(const ObjectFile *o) {
 800   outs() << '\n';
 801   outs() << o->getFileName()
 802          << ":\tfile format " << o->getFileFormatName() << "\n\n";
 803
 804   if (Disassemble)
 805     DisassembleObject(o, Relocations);
 806   if (Relocations && !Disassemble)
 807     PrintRelocations(o);
 808   if (SectionHeaders)
 809     PrintSectionHeaders(o);
 810   if (SectionContents)
 811     PrintSectionContents(o);
 812   if (SymbolTable)
 813     PrintSymbolTable(o);
 814   if (UnwindInfo)
 815     PrintUnwindInfo(o);
 816   if (PrivateHeaders)
 817     printPrivateFileHeader(o);
 818 }
 819
 820 /// @brief Dump each object file in \a a;
 821 static void DumpArchive(const Archive *a) {
 822   for (Archive::child_iterator i = a->child_begin(), e = a->child_end(); i != e;
 823        ++i) {
 824     std::unique_ptr<Binary> child;
 825     if (error_code EC = i->getAsBinary(child)) {
 826       // Ignore non-object files.
 827       if (EC != object_error::invalid_file_type)
 828         errs() << ToolName << ": '" << a->getFileName() << "': " << EC.message()
 829                << ".\n";
 830       continue;
 831     }
 832     if (ObjectFile *o = dyn_cast<ObjectFile>(child.get()))
 833       DumpObject(o);
 834     else
 835       errs() << ToolName << ": '" << a->getFileName() << "': "
 836               << "Unrecognized file type.\n";
 837   }
 838 }
 839
 840 /// @brief Open file and figure out how to dump it.
 841 static void DumpInput(StringRef file) {
 842   // If file isn't stdin, check that it exists.
 843   if (file != "-" && !sys::fs::exists(file)) {
 844     errs() << ToolName << ": '" << file << "': " << "No such file\n";
 845     return;
 846   }
 847
 848   if (MachOOpt && Disassemble) {
 849     DisassembleInputMachO(file);
 850     return;
 851   }
 852
 853   // Attempt to open the binary.
 854   ErrorOr<Binary *> BinaryOrErr = createBinary(file);
 855   if (error_code EC = BinaryOrErr.getError()) {
 856     errs() << ToolName << ": '" << file << "': " << EC.message() << ".\n";
 857     return;
 858   }
 859   std::unique_ptr<Binary> binary(BinaryOrErr.get());
 860
 861   if (Archive *a = dyn_cast<Archive>(binary.get()))
 862     DumpArchive(a);
 863   else if (ObjectFile *o = dyn_cast<ObjectFile>(binary.get()))
 864     DumpObject(o);
 865   else
 866     errs() << ToolName << ": '" << file << "': " << "Unrecognized file type.\n";
 867 }
 868
 869 int main(int argc, char **argv) {
 870   // Print a stack trace if we signal out.
 871   sys::PrintStackTraceOnErrorSignal();
 872   PrettyStackTraceProgram X(argc, argv);
 873   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 874
 875   // Initialize targets and assembly printers/parsers.
 876   llvm::InitializeAllTargetInfos();
 877   llvm::InitializeAllTargetMCs();
 878   llvm::InitializeAllAsmParsers();
 879   llvm::InitializeAllDisassemblers();
 880
 881   // Register the target printer for --version.
 882   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 883
 884   cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
 885   TripleName = Triple::normalize(TripleName);
 886
 887   ToolName = argv[0];
 888
 889   // Defaults to a.out if no filenames specified.
 890   if (InputFilenames.size() == 0)
 891     InputFilenames.push_back("a.out");
 892
 893   if (!Disassemble
 894       && !Relocations
 895       && !SectionHeaders
 896       && !SectionContents
 897       && !SymbolTable
 898       && !UnwindInfo
 899       && !PrivateHeaders) {
 900     cl::PrintHelpMessage();
 901     return 2;
 902   }
 903
 904   std::for_each(InputFilenames.begin(), InputFilenames.end(),
 905                 DumpInput);
 906
 907   return 0;
 908 }