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