1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like binutils "objdump", that is, it
11 // dumps out a plethora of information about an object file depending on the
14 //===----------------------------------------------------------------------===//
16 #include "llvm-objdump.h"
17 #include "MCFunction.h"
18 #include "llvm/Object/Archive.h"
19 #include "llvm/Object/COFF.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/ADT/OwningPtr.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/Triple.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/MC/MCAsmInfo.h"
26 #include "llvm/MC/MCDisassembler.h"
27 #include "llvm/MC/MCInst.h"
28 #include "llvm/MC/MCInstPrinter.h"
29 #include "llvm/MC/MCSubtargetInfo.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/Support/FileSystem.h"
34 #include "llvm/Support/Format.h"
35 #include "llvm/Support/GraphWriter.h"
36 #include "llvm/Support/Host.h"
37 #include "llvm/Support/ManagedStatic.h"
38 #include "llvm/Support/MemoryBuffer.h"
39 #include "llvm/Support/MemoryObject.h"
40 #include "llvm/Support/PrettyStackTrace.h"
41 #include "llvm/Support/Signals.h"
42 #include "llvm/Support/SourceMgr.h"
43 #include "llvm/Support/TargetRegistry.h"
44 #include "llvm/Support/TargetSelect.h"
45 #include "llvm/Support/raw_ostream.h"
46 #include "llvm/Support/system_error.h"
50 using namespace object;
52 static cl::list<std::string>
53 InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
56 Disassemble("disassemble",
57 cl::desc("Display assembler mnemonics for the machine instructions"));
59 Disassembled("d", cl::desc("Alias for --disassemble"),
60 cl::aliasopt(Disassemble));
63 Relocations("r", cl::desc("Display the relocation entries in the file"));
66 SectionContents("s", cl::desc("Display the content of each section"));
69 SymbolTable("t", cl::desc("Display the symbol table"));
72 MachO("macho", cl::desc("Use MachO specific object file parser"));
74 MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachO));
77 llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
78 "see -version for available targets"));
81 llvm::ArchName("arch", cl::desc("Target arch to disassemble for, "
82 "see -version for available targets"));
85 SectionHeaders("section-headers", cl::desc("Display summaries of the headers "
86 "for each section."));
88 SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
89 cl::aliasopt(SectionHeaders));
91 SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
92 cl::aliasopt(SectionHeaders));
94 static StringRef ToolName;
96 static bool error(error_code ec) {
97 if (!ec) return false;
99 outs() << ToolName << ": error reading file: " << ec.message() << ".\n";
104 static const Target *GetTarget(const ObjectFile *Obj = NULL) {
105 // Figure out the target triple.
106 llvm::Triple TT("unknown-unknown-unknown");
107 if (TripleName.empty()) {
109 TT.setArch(Triple::ArchType(Obj->getArch()));
111 TT.setTriple(Triple::normalize(TripleName));
113 if (!ArchName.empty())
114 TT.setArchName(ArchName);
116 TripleName = TT.str();
118 // Get the target specific parser.
120 const Target *TheTarget = TargetRegistry::lookupTarget(TripleName, Error);
124 errs() << ToolName << ": error: unable to get target for '" << TripleName
125 << "', see --version and --triple.\n";
129 void llvm::StringRefMemoryObject::anchor() { }
131 void llvm::DumpBytes(StringRef bytes) {
132 static const char hex_rep[] = "0123456789abcdef";
133 // FIXME: The real way to do this is to figure out the longest instruction
134 // and align to that size before printing. I'll fix this when I get
135 // around to outputting relocations.
136 // 15 is the longest x86 instruction
137 // 3 is for the hex rep of a byte + a space.
138 // 1 is for the null terminator.
139 enum { OutputSize = (15 * 3) + 1 };
140 char output[OutputSize];
142 assert(bytes.size() <= 15
143 && "DumpBytes only supports instructions of up to 15 bytes");
144 memset(output, ' ', sizeof(output));
146 for (StringRef::iterator i = bytes.begin(),
147 e = bytes.end(); i != e; ++i) {
148 output[index] = hex_rep[(*i & 0xF0) >> 4];
149 output[index + 1] = hex_rep[*i & 0xF];
153 output[sizeof(output) - 1] = 0;
157 static bool RelocAddressLess(RelocationRef a, RelocationRef b) {
158 uint64_t a_addr, b_addr;
159 if (error(a.getAddress(a_addr))) return false;
160 if (error(b.getAddress(b_addr))) return false;
161 return a_addr < b_addr;
164 static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
165 const Target *TheTarget = GetTarget(Obj);
167 // GetTarget prints out stuff.
172 for (section_iterator i = Obj->begin_sections(),
173 e = Obj->end_sections();
174 i != e; i.increment(ec)) {
175 if (error(ec)) break;
177 if (error(i->isText(text))) break;
180 uint64_t SectionAddr;
181 if (error(i->getAddress(SectionAddr))) break;
183 // Make a list of all the symbols in this section.
184 std::vector<std::pair<uint64_t, StringRef> > Symbols;
185 for (symbol_iterator si = Obj->begin_symbols(),
186 se = Obj->end_symbols();
187 si != se; si.increment(ec)) {
189 if (!error(i->containsSymbol(*si, contains)) && contains) {
191 if (error(si->getAddress(Address))) break;
193 if (error(si->getName(Name))) break;
194 Symbols.push_back(std::make_pair(Address, Name));
198 // Sort the symbols by address, just in case they didn't come in that way.
199 array_pod_sort(Symbols.begin(), Symbols.end());
201 // Make a list of all the relocations for this section.
202 std::vector<RelocationRef> Rels;
204 for (relocation_iterator ri = i->begin_relocations(),
205 re = i->end_relocations();
206 ri != re; ri.increment(ec)) {
207 if (error(ec)) break;
212 // Sort relocations by address.
213 std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
216 if (error(i->getName(name))) break;
217 outs() << "Disassembly of section " << name << ':';
219 // If the section has no symbols just insert a dummy one and disassemble
220 // the whole section.
222 Symbols.push_back(std::make_pair(0, name));
224 // Set up disassembler.
225 OwningPtr<const MCAsmInfo> AsmInfo(TheTarget->createMCAsmInfo(TripleName));
228 errs() << "error: no assembly info for target " << TripleName << "\n";
232 OwningPtr<const MCSubtargetInfo> STI(
233 TheTarget->createMCSubtargetInfo(TripleName, "", ""));
236 errs() << "error: no subtarget info for target " << TripleName << "\n";
240 OwningPtr<const MCDisassembler> DisAsm(
241 TheTarget->createMCDisassembler(*STI));
243 errs() << "error: no disassembler for target " << TripleName << "\n";
247 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
248 OwningPtr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
249 AsmPrinterVariant, *AsmInfo, *STI));
251 errs() << "error: no instruction printer for target " << TripleName
257 if (error(i->getContents(Bytes))) break;
258 StringRefMemoryObject memoryObject(Bytes);
262 if (error(i->getSize(SectSize))) break;
264 std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
265 std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
266 // Disassemble symbol by symbol.
267 for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
268 uint64_t Start = Symbols[si].first;
270 // The end is either the size of the section or the beginning of the next
274 // Make sure this symbol takes up space.
275 else if (Symbols[si + 1].first != Start)
276 End = Symbols[si + 1].first - 1;
278 // This symbol has the same address as the next symbol. Skip it.
281 outs() << '\n' << Symbols[si].second << ":\n";
284 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
286 raw_ostream &DebugOut = nulls();
289 for (Index = Start; Index < End; Index += Size) {
292 if (DisAsm->getInstruction(Inst, Size, memoryObject, Index,
293 DebugOut, nulls())) {
294 outs() << format("%8"PRIx64":\t", SectionAddr + Index);
295 DumpBytes(StringRef(Bytes.data() + Index, Size));
296 IP->printInst(&Inst, outs(), "");
299 errs() << ToolName << ": warning: invalid instruction encoding\n";
301 Size = 1; // skip illegible bytes
304 // Print relocation for instruction.
305 while (rel_cur != rel_end) {
308 SmallString<16> name;
311 // If this relocation is hidden, skip it.
312 if (error(rel_cur->getHidden(hidden))) goto skip_print_rel;
313 if (hidden) goto skip_print_rel;
315 if (error(rel_cur->getAddress(addr))) goto skip_print_rel;
316 // Stop when rel_cur's address is past the current instruction.
317 if (addr >= Index + Size) break;
318 if (error(rel_cur->getTypeName(name))) goto skip_print_rel;
319 if (error(rel_cur->getValueString(val))) goto skip_print_rel;
321 outs() << format("\t\t\t%8"PRIx64": ", SectionAddr + addr) << name << "\t"
332 static void PrintRelocations(const ObjectFile *o) {
334 for (section_iterator si = o->begin_sections(), se = o->end_sections();
335 si != se; si.increment(ec)){
336 if (error(ec)) return;
337 if (si->begin_relocations() == si->end_relocations())
340 if (error(si->getName(secname))) continue;
341 outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
342 for (relocation_iterator ri = si->begin_relocations(),
343 re = si->end_relocations();
344 ri != re; ri.increment(ec)) {
345 if (error(ec)) return;
349 SmallString<32> relocname;
350 SmallString<32> valuestr;
351 if (error(ri->getHidden(hidden))) continue;
352 if (hidden) continue;
353 if (error(ri->getTypeName(relocname))) continue;
354 if (error(ri->getAddress(address))) continue;
355 if (error(ri->getValueString(valuestr))) continue;
356 outs() << address << " " << relocname << " " << valuestr << "\n";
362 static void PrintSectionHeaders(const ObjectFile *o) {
363 outs() << "Sections:\n"
364 "Idx Name Size Address Type\n";
367 for (section_iterator si = o->begin_sections(), se = o->end_sections();
368 si != se; si.increment(ec)) {
369 if (error(ec)) return;
371 if (error(si->getName(Name))) return;
373 if (error(si->getAddress(Address))) return;
375 if (error(si->getSize(Size))) return;
376 bool Text, Data, BSS;
377 if (error(si->isText(Text))) return;
378 if (error(si->isData(Data))) return;
379 if (error(si->isBSS(BSS))) return;
380 std::string Type = (std::string(Text ? "TEXT " : "") +
381 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
382 outs() << format("%3d %-13s %09"PRIx64" %017"PRIx64" %s\n", i, Name.str().c_str(), Size,
383 Address, Type.c_str());
388 static void PrintSectionContents(const ObjectFile *o) {
390 for (section_iterator si = o->begin_sections(),
391 se = o->end_sections();
392 si != se; si.increment(ec)) {
393 if (error(ec)) return;
397 if (error(si->getName(Name))) continue;
398 if (error(si->getContents(Contents))) continue;
399 if (error(si->getAddress(BaseAddr))) continue;
401 outs() << "Contents of section " << Name << ":\n";
403 // Dump out the content as hex and printable ascii characters.
404 for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
405 outs() << format(" %04"PRIx64" ", BaseAddr + addr);
407 for (std::size_t i = 0; i < 16; ++i) {
408 if (i != 0 && i % 4 == 0)
411 outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
412 << hexdigit(Contents[addr + i] & 0xF, true);
418 for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
419 if (std::isprint(Contents[addr + i] & 0xFF))
420 outs() << Contents[addr + i];
429 static void PrintCOFFSymbolTable(const COFFObjectFile *coff) {
430 const coff_file_header *header;
431 if (error(coff->getHeader(header))) return;
433 const coff_symbol *symbol = 0;
434 for (int i = 0, e = header->NumberOfSymbols; i != e; ++i) {
436 // Figure out which type of aux this is.
437 if (symbol->StorageClass == COFF::IMAGE_SYM_CLASS_STATIC
438 && symbol->Value == 0) { // Section definition.
439 const coff_aux_section_definition *asd;
440 if (error(coff->getAuxSymbol<coff_aux_section_definition>(i, asd)))
443 << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
444 , unsigned(asd->Length)
445 , unsigned(asd->NumberOfRelocations)
446 , unsigned(asd->NumberOfLinenumbers)
447 , unsigned(asd->CheckSum))
448 << format("assoc %d comdat %d\n"
449 , unsigned(asd->Number)
450 , unsigned(asd->Selection));
452 outs() << "AUX Unknown\n";
456 if (error(coff->getSymbol(i, symbol))) return;
457 if (error(coff->getSymbolName(symbol, name))) return;
458 outs() << "[" << format("%2d", i) << "]"
459 << "(sec " << format("%2d", int(symbol->SectionNumber)) << ")"
460 << "(fl 0x00)" // Flag bits, which COFF doesn't have.
461 << "(ty " << format("%3x", unsigned(symbol->Type)) << ")"
462 << "(scl " << format("%3x", unsigned(symbol->StorageClass)) << ") "
463 << "(nx " << unsigned(symbol->NumberOfAuxSymbols) << ") "
464 << "0x" << format("%08x", unsigned(symbol->Value)) << " "
466 aux_count = symbol->NumberOfAuxSymbols;
471 static void PrintSymbolTable(const ObjectFile *o) {
472 outs() << "SYMBOL TABLE:\n";
474 if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o))
475 PrintCOFFSymbolTable(coff);
478 for (symbol_iterator si = o->begin_symbols(),
479 se = o->end_symbols(); si != se; si.increment(ec)) {
480 if (error(ec)) return;
484 SymbolRef::Type Type;
488 section_iterator Section = o->end_sections();
489 if (error(si->getName(Name))) continue;
490 if (error(si->getAddress(Address))) continue;
491 if (error(si->isGlobal(Global))) continue;
492 if (error(si->getType(Type))) continue;
493 if (error(si->isWeak(Weak))) continue;
494 if (error(si->isAbsolute(Absolute))) continue;
495 if (error(si->getSize(Size))) continue;
496 if (error(si->getSection(Section))) continue;
498 if (Address == UnknownAddressOrSize)
500 if (Size == UnknownAddressOrSize)
503 if (Type != SymbolRef::ST_External)
504 GlobLoc = Global ? 'g' : 'l';
505 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
508 if (Type == SymbolRef::ST_File)
510 else if (Type == SymbolRef::ST_Function)
513 outs() << format("%08"PRIx64, Address) << " "
514 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
515 << (Weak ? 'w' : ' ') // Weak?
516 << ' ' // Constructor. Not supported yet.
517 << ' ' // Warning. Not supported yet.
518 << ' ' // Indirect reference to another symbol.
519 << Debug // Debugging (d) or dynamic (D) symbol.
520 << FileFunc // Name of function (F), file (f) or object (O).
524 else if (Section == o->end_sections())
527 StringRef SectionName;
528 if (error(Section->getName(SectionName)))
530 outs() << SectionName;
533 << format("%08"PRIx64" ", Size)
540 static void DumpObject(const ObjectFile *o) {
542 outs() << o->getFileName()
543 << ":\tfile format " << o->getFileFormatName() << "\n\n";
546 DisassembleObject(o, Relocations);
547 if (Relocations && !Disassemble)
550 PrintSectionHeaders(o);
552 PrintSectionContents(o);
557 /// @brief Dump each object file in \a a;
558 static void DumpArchive(const Archive *a) {
559 for (Archive::child_iterator i = a->begin_children(),
560 e = a->end_children(); i != e; ++i) {
561 OwningPtr<Binary> child;
562 if (error_code ec = i->getAsBinary(child)) {
563 // Ignore non-object files.
564 if (ec != object_error::invalid_file_type)
565 errs() << ToolName << ": '" << a->getFileName() << "': " << ec.message()
569 if (ObjectFile *o = dyn_cast<ObjectFile>(child.get()))
572 errs() << ToolName << ": '" << a->getFileName() << "': "
573 << "Unrecognized file type.\n";
577 /// @brief Open file and figure out how to dump it.
578 static void DumpInput(StringRef file) {
579 // If file isn't stdin, check that it exists.
580 if (file != "-" && !sys::fs::exists(file)) {
581 errs() << ToolName << ": '" << file << "': " << "No such file\n";
585 if (MachO && Disassemble) {
586 DisassembleInputMachO(file);
590 // Attempt to open the binary.
591 OwningPtr<Binary> binary;
592 if (error_code ec = createBinary(file, binary)) {
593 errs() << ToolName << ": '" << file << "': " << ec.message() << ".\n";
597 if (Archive *a = dyn_cast<Archive>(binary.get())) {
599 } else if (ObjectFile *o = dyn_cast<ObjectFile>(binary.get())) {
602 errs() << ToolName << ": '" << file << "': " << "Unrecognized file type.\n";
606 int main(int argc, char **argv) {
607 // Print a stack trace if we signal out.
608 sys::PrintStackTraceOnErrorSignal();
609 PrettyStackTraceProgram X(argc, argv);
610 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
612 // Initialize targets and assembly printers/parsers.
613 llvm::InitializeAllTargetInfos();
614 llvm::InitializeAllTargetMCs();
615 llvm::InitializeAllAsmParsers();
616 llvm::InitializeAllDisassemblers();
618 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
619 TripleName = Triple::normalize(TripleName);
623 // Defaults to a.out if no filenames specified.
624 if (InputFilenames.size() == 0)
625 InputFilenames.push_back("a.out");
632 cl::PrintHelpMessage();
636 std::for_each(InputFilenames.begin(), InputFilenames.end(),