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