1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This program is a utility that works like binutils "objdump", that is, it 10 // dumps out a plethora of information about an object file depending on the 11 // flags. 12 // 13 // The flags and output of this program should be near identical to those of 14 // binutils objdump. 15 // 16 //===----------------------------------------------------------------------===// 17 18 #include "llvm-objdump.h" 19 #include "COFFDump.h" 20 #include "ELFDump.h" 21 #include "MachODump.h" 22 #include "WasmDump.h" 23 #include "XCOFFDump.h" 24 #include "llvm/ADT/Optional.h" 25 #include "llvm/ADT/STLExtras.h" 26 #include "llvm/ADT/SetOperations.h" 27 #include "llvm/ADT/StringExtras.h" 28 #include "llvm/ADT/StringSet.h" 29 #include "llvm/ADT/Triple.h" 30 #include "llvm/CodeGen/FaultMaps.h" 31 #include "llvm/DebugInfo/DWARF/DWARFContext.h" 32 #include "llvm/DebugInfo/Symbolize/Symbolize.h" 33 #include "llvm/Demangle/Demangle.h" 34 #include "llvm/MC/MCAsmInfo.h" 35 #include "llvm/MC/MCContext.h" 36 #include "llvm/MC/MCDisassembler/MCDisassembler.h" 37 #include "llvm/MC/MCDisassembler/MCRelocationInfo.h" 38 #include "llvm/MC/MCInst.h" 39 #include "llvm/MC/MCInstPrinter.h" 40 #include "llvm/MC/MCInstrAnalysis.h" 41 #include "llvm/MC/MCInstrInfo.h" 42 #include "llvm/MC/MCObjectFileInfo.h" 43 #include "llvm/MC/MCRegisterInfo.h" 44 #include "llvm/MC/MCSubtargetInfo.h" 45 #include "llvm/MC/MCTargetOptions.h" 46 #include "llvm/Object/Archive.h" 47 #include "llvm/Object/COFF.h" 48 #include "llvm/Object/COFFImportFile.h" 49 #include "llvm/Object/ELFObjectFile.h" 50 #include "llvm/Object/MachO.h" 51 #include "llvm/Object/MachOUniversal.h" 52 #include "llvm/Object/ObjectFile.h" 53 #include "llvm/Object/Wasm.h" 54 #include "llvm/Support/Casting.h" 55 #include "llvm/Support/CommandLine.h" 56 #include "llvm/Support/Debug.h" 57 #include "llvm/Support/Errc.h" 58 #include "llvm/Support/FileSystem.h" 59 #include "llvm/Support/Format.h" 60 #include "llvm/Support/FormatVariadic.h" 61 #include "llvm/Support/GraphWriter.h" 62 #include "llvm/Support/Host.h" 63 #include "llvm/Support/InitLLVM.h" 64 #include "llvm/Support/MemoryBuffer.h" 65 #include "llvm/Support/SourceMgr.h" 66 #include "llvm/Support/StringSaver.h" 67 #include "llvm/Support/TargetRegistry.h" 68 #include "llvm/Support/TargetSelect.h" 69 #include "llvm/Support/WithColor.h" 70 #include "llvm/Support/raw_ostream.h" 71 #include <algorithm> 72 #include <cctype> 73 #include <cstring> 74 #include <system_error> 75 #include <unordered_map> 76 #include <utility> 77 78 using namespace llvm; 79 using namespace llvm::object; 80 using namespace llvm::objdump; 81 82 static cl::OptionCategory ObjdumpCat("llvm-objdump Options"); 83 84 static cl::opt<uint64_t> AdjustVMA( 85 "adjust-vma", 86 cl::desc("Increase the displayed address by the specified offset"), 87 cl::value_desc("offset"), cl::init(0), cl::cat(ObjdumpCat)); 88 89 static cl::opt<bool> 90 AllHeaders("all-headers", 91 cl::desc("Display all available header information"), 92 cl::cat(ObjdumpCat)); 93 static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"), 94 cl::NotHidden, cl::Grouping, 95 cl::aliasopt(AllHeaders)); 96 97 static cl::opt<std::string> 98 ArchName("arch-name", 99 cl::desc("Target arch to disassemble for, " 100 "see -version for available targets"), 101 cl::cat(ObjdumpCat)); 102 103 cl::opt<bool> 104 objdump::ArchiveHeaders("archive-headers", 105 cl::desc("Display archive header information"), 106 cl::cat(ObjdumpCat)); 107 static cl::alias ArchiveHeadersShort("a", 108 cl::desc("Alias for --archive-headers"), 109 cl::NotHidden, cl::Grouping, 110 cl::aliasopt(ArchiveHeaders)); 111 112 cl::opt<bool> objdump::Demangle("demangle", cl::desc("Demangle symbols names"), 113 cl::init(false), cl::cat(ObjdumpCat)); 114 static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"), 115 cl::NotHidden, cl::Grouping, 116 cl::aliasopt(Demangle)); 117 118 cl::opt<bool> objdump::Disassemble( 119 "disassemble", 120 cl::desc("Display assembler mnemonics for the machine instructions"), 121 cl::cat(ObjdumpCat)); 122 static cl::alias DisassembleShort("d", cl::desc("Alias for --disassemble"), 123 cl::NotHidden, cl::Grouping, 124 cl::aliasopt(Disassemble)); 125 126 cl::opt<bool> objdump::DisassembleAll( 127 "disassemble-all", 128 cl::desc("Display assembler mnemonics for the machine instructions"), 129 cl::cat(ObjdumpCat)); 130 static cl::alias DisassembleAllShort("D", 131 cl::desc("Alias for --disassemble-all"), 132 cl::NotHidden, cl::Grouping, 133 cl::aliasopt(DisassembleAll)); 134 135 cl::opt<bool> objdump::SymbolDescription( 136 "symbol-description", 137 cl::desc("Add symbol description for disassembly. This " 138 "option is for XCOFF files only"), 139 cl::init(false), cl::cat(ObjdumpCat)); 140 141 static cl::list<std::string> 142 DisassembleSymbols("disassemble-symbols", cl::CommaSeparated, 143 cl::desc("List of symbols to disassemble. " 144 "Accept demangled names when --demangle is " 145 "specified, otherwise accept mangled names"), 146 cl::cat(ObjdumpCat)); 147 148 static cl::opt<bool> DisassembleZeroes( 149 "disassemble-zeroes", 150 cl::desc("Do not skip blocks of zeroes when disassembling"), 151 cl::cat(ObjdumpCat)); 152 static cl::alias 153 DisassembleZeroesShort("z", cl::desc("Alias for --disassemble-zeroes"), 154 cl::NotHidden, cl::Grouping, 155 cl::aliasopt(DisassembleZeroes)); 156 157 static cl::list<std::string> 158 DisassemblerOptions("disassembler-options", 159 cl::desc("Pass target specific disassembler options"), 160 cl::value_desc("options"), cl::CommaSeparated, 161 cl::cat(ObjdumpCat)); 162 static cl::alias 163 DisassemblerOptionsShort("M", cl::desc("Alias for --disassembler-options"), 164 cl::NotHidden, cl::Grouping, cl::Prefix, 165 cl::CommaSeparated, 166 cl::aliasopt(DisassemblerOptions)); 167 168 cl::opt<DIDumpType> objdump::DwarfDumpType( 169 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"), 170 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")), 171 cl::cat(ObjdumpCat)); 172 173 static cl::opt<bool> DynamicRelocations( 174 "dynamic-reloc", 175 cl::desc("Display the dynamic relocation entries in the file"), 176 cl::cat(ObjdumpCat)); 177 static cl::alias DynamicRelocationShort("R", 178 cl::desc("Alias for --dynamic-reloc"), 179 cl::NotHidden, cl::Grouping, 180 cl::aliasopt(DynamicRelocations)); 181 182 static cl::opt<bool> 183 FaultMapSection("fault-map-section", 184 cl::desc("Display contents of faultmap section"), 185 cl::cat(ObjdumpCat)); 186 187 static cl::opt<bool> 188 FileHeaders("file-headers", 189 cl::desc("Display the contents of the overall file header"), 190 cl::cat(ObjdumpCat)); 191 static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"), 192 cl::NotHidden, cl::Grouping, 193 cl::aliasopt(FileHeaders)); 194 195 cl::opt<bool> 196 objdump::SectionContents("full-contents", 197 cl::desc("Display the content of each section"), 198 cl::cat(ObjdumpCat)); 199 static cl::alias SectionContentsShort("s", 200 cl::desc("Alias for --full-contents"), 201 cl::NotHidden, cl::Grouping, 202 cl::aliasopt(SectionContents)); 203 204 static cl::list<std::string> InputFilenames(cl::Positional, 205 cl::desc("<input object files>"), 206 cl::ZeroOrMore, 207 cl::cat(ObjdumpCat)); 208 209 static cl::opt<bool> 210 PrintLines("line-numbers", 211 cl::desc("Display source line numbers with " 212 "disassembly. Implies disassemble object"), 213 cl::cat(ObjdumpCat)); 214 static cl::alias PrintLinesShort("l", cl::desc("Alias for --line-numbers"), 215 cl::NotHidden, cl::Grouping, 216 cl::aliasopt(PrintLines)); 217 218 static cl::opt<bool> MachOOpt("macho", 219 cl::desc("Use MachO specific object file parser"), 220 cl::cat(ObjdumpCat)); 221 static cl::alias MachOm("m", cl::desc("Alias for --macho"), cl::NotHidden, 222 cl::Grouping, cl::aliasopt(MachOOpt)); 223 224 cl::opt<std::string> objdump::MCPU( 225 "mcpu", cl::desc("Target a specific cpu type (-mcpu=help for details)"), 226 cl::value_desc("cpu-name"), cl::init(""), cl::cat(ObjdumpCat)); 227 228 cl::list<std::string> objdump::MAttrs("mattr", cl::CommaSeparated, 229 cl::desc("Target specific attributes"), 230 cl::value_desc("a1,+a2,-a3,..."), 231 cl::cat(ObjdumpCat)); 232 233 cl::opt<bool> objdump::NoShowRawInsn( 234 "no-show-raw-insn", 235 cl::desc( 236 "When disassembling instructions, do not print the instruction bytes."), 237 cl::cat(ObjdumpCat)); 238 239 cl::opt<bool> objdump::NoLeadingAddr("no-leading-addr", 240 cl::desc("Print no leading address"), 241 cl::cat(ObjdumpCat)); 242 243 static cl::opt<bool> RawClangAST( 244 "raw-clang-ast", 245 cl::desc("Dump the raw binary contents of the clang AST section"), 246 cl::cat(ObjdumpCat)); 247 248 cl::opt<bool> 249 objdump::Relocations("reloc", 250 cl::desc("Display the relocation entries in the file"), 251 cl::cat(ObjdumpCat)); 252 static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"), 253 cl::NotHidden, cl::Grouping, 254 cl::aliasopt(Relocations)); 255 256 cl::opt<bool> 257 objdump::PrintImmHex("print-imm-hex", 258 cl::desc("Use hex format for immediate values"), 259 cl::cat(ObjdumpCat)); 260 261 cl::opt<bool> 262 objdump::PrivateHeaders("private-headers", 263 cl::desc("Display format specific file headers"), 264 cl::cat(ObjdumpCat)); 265 static cl::alias PrivateHeadersShort("p", 266 cl::desc("Alias for --private-headers"), 267 cl::NotHidden, cl::Grouping, 268 cl::aliasopt(PrivateHeaders)); 269 270 cl::list<std::string> 271 objdump::FilterSections("section", 272 cl::desc("Operate on the specified sections only. " 273 "With -macho dump segment,section"), 274 cl::cat(ObjdumpCat)); 275 static cl::alias FilterSectionsj("j", cl::desc("Alias for --section"), 276 cl::NotHidden, cl::Grouping, cl::Prefix, 277 cl::aliasopt(FilterSections)); 278 279 cl::opt<bool> objdump::SectionHeaders( 280 "section-headers", 281 cl::desc("Display summaries of the headers for each section."), 282 cl::cat(ObjdumpCat)); 283 static cl::alias SectionHeadersShort("headers", 284 cl::desc("Alias for --section-headers"), 285 cl::NotHidden, 286 cl::aliasopt(SectionHeaders)); 287 static cl::alias SectionHeadersShorter("h", 288 cl::desc("Alias for --section-headers"), 289 cl::NotHidden, cl::Grouping, 290 cl::aliasopt(SectionHeaders)); 291 292 static cl::opt<bool> 293 ShowLMA("show-lma", 294 cl::desc("Display LMA column when dumping ELF section headers"), 295 cl::cat(ObjdumpCat)); 296 297 static cl::opt<bool> PrintSource( 298 "source", 299 cl::desc( 300 "Display source inlined with disassembly. Implies disassemble object"), 301 cl::cat(ObjdumpCat)); 302 static cl::alias PrintSourceShort("S", cl::desc("Alias for -source"), 303 cl::NotHidden, cl::Grouping, 304 cl::aliasopt(PrintSource)); 305 306 static cl::opt<uint64_t> 307 StartAddress("start-address", cl::desc("Disassemble beginning at address"), 308 cl::value_desc("address"), cl::init(0), cl::cat(ObjdumpCat)); 309 static cl::opt<uint64_t> StopAddress("stop-address", 310 cl::desc("Stop disassembly at address"), 311 cl::value_desc("address"), 312 cl::init(UINT64_MAX), cl::cat(ObjdumpCat)); 313 314 cl::opt<bool> objdump::SymbolTable("syms", cl::desc("Display the symbol table"), 315 cl::cat(ObjdumpCat)); 316 static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"), 317 cl::NotHidden, cl::Grouping, 318 cl::aliasopt(SymbolTable)); 319 320 static cl::opt<bool> DynamicSymbolTable( 321 "dynamic-syms", 322 cl::desc("Display the contents of the dynamic symbol table"), 323 cl::cat(ObjdumpCat)); 324 static cl::alias DynamicSymbolTableShort("T", 325 cl::desc("Alias for --dynamic-syms"), 326 cl::NotHidden, cl::Grouping, 327 cl::aliasopt(DynamicSymbolTable)); 328 329 cl::opt<std::string> objdump::TripleName( 330 "triple", 331 cl::desc( 332 "Target triple to disassemble for, see -version for available targets"), 333 cl::cat(ObjdumpCat)); 334 335 cl::opt<bool> objdump::UnwindInfo("unwind-info", 336 cl::desc("Display unwind information"), 337 cl::cat(ObjdumpCat)); 338 static cl::alias UnwindInfoShort("u", cl::desc("Alias for --unwind-info"), 339 cl::NotHidden, cl::Grouping, 340 cl::aliasopt(UnwindInfo)); 341 342 static cl::opt<bool> 343 Wide("wide", cl::desc("Ignored for compatibility with GNU objdump"), 344 cl::cat(ObjdumpCat)); 345 static cl::alias WideShort("w", cl::Grouping, cl::aliasopt(Wide)); 346 347 static cl::extrahelp 348 HelpResponse("\nPass @FILE as argument to read options from FILE.\n"); 349 350 static StringSet<> DisasmSymbolSet; 351 StringSet<> objdump::FoundSectionSet; 352 static StringRef ToolName; 353 354 namespace { 355 struct FilterResult { 356 // True if the section should not be skipped. 357 bool Keep; 358 359 // True if the index counter should be incremented, even if the section should 360 // be skipped. For example, sections may be skipped if they are not included 361 // in the --section flag, but we still want those to count toward the section 362 // count. 363 bool IncrementIndex; 364 }; 365 } // namespace 366 367 static FilterResult checkSectionFilter(object::SectionRef S) { 368 if (FilterSections.empty()) 369 return {/*Keep=*/true, /*IncrementIndex=*/true}; 370 371 Expected<StringRef> SecNameOrErr = S.getName(); 372 if (!SecNameOrErr) { 373 consumeError(SecNameOrErr.takeError()); 374 return {/*Keep=*/false, /*IncrementIndex=*/false}; 375 } 376 StringRef SecName = *SecNameOrErr; 377 378 // StringSet does not allow empty key so avoid adding sections with 379 // no name (such as the section with index 0) here. 380 if (!SecName.empty()) 381 FoundSectionSet.insert(SecName); 382 383 // Only show the section if it's in the FilterSections list, but always 384 // increment so the indexing is stable. 385 return {/*Keep=*/is_contained(FilterSections, SecName), 386 /*IncrementIndex=*/true}; 387 } 388 389 SectionFilter objdump::ToolSectionFilter(object::ObjectFile const &O, 390 uint64_t *Idx) { 391 // Start at UINT64_MAX so that the first index returned after an increment is 392 // zero (after the unsigned wrap). 393 if (Idx) 394 *Idx = UINT64_MAX; 395 return SectionFilter( 396 [Idx](object::SectionRef S) { 397 FilterResult Result = checkSectionFilter(S); 398 if (Idx != nullptr && Result.IncrementIndex) 399 *Idx += 1; 400 return Result.Keep; 401 }, 402 O); 403 } 404 405 std::string objdump::getFileNameForError(const object::Archive::Child &C, 406 unsigned Index) { 407 Expected<StringRef> NameOrErr = C.getName(); 408 if (NameOrErr) 409 return std::string(NameOrErr.get()); 410 // If we have an error getting the name then we print the index of the archive 411 // member. Since we are already in an error state, we just ignore this error. 412 consumeError(NameOrErr.takeError()); 413 return "<file index: " + std::to_string(Index) + ">"; 414 } 415 416 void objdump::reportWarning(Twine Message, StringRef File) { 417 // Output order between errs() and outs() matters especially for archive 418 // files where the output is per member object. 419 outs().flush(); 420 WithColor::warning(errs(), ToolName) 421 << "'" << File << "': " << Message << "\n"; 422 } 423 424 LLVM_ATTRIBUTE_NORETURN void objdump::reportError(StringRef File, 425 Twine Message) { 426 outs().flush(); 427 WithColor::error(errs(), ToolName) << "'" << File << "': " << Message << "\n"; 428 exit(1); 429 } 430 431 LLVM_ATTRIBUTE_NORETURN void objdump::reportError(Error E, StringRef FileName, 432 StringRef ArchiveName, 433 StringRef ArchitectureName) { 434 assert(E); 435 outs().flush(); 436 WithColor::error(errs(), ToolName); 437 if (ArchiveName != "") 438 errs() << ArchiveName << "(" << FileName << ")"; 439 else 440 errs() << "'" << FileName << "'"; 441 if (!ArchitectureName.empty()) 442 errs() << " (for architecture " << ArchitectureName << ")"; 443 errs() << ": "; 444 logAllUnhandledErrors(std::move(E), errs()); 445 exit(1); 446 } 447 448 static void reportCmdLineWarning(Twine Message) { 449 WithColor::warning(errs(), ToolName) << Message << "\n"; 450 } 451 452 LLVM_ATTRIBUTE_NORETURN static void reportCmdLineError(Twine Message) { 453 WithColor::error(errs(), ToolName) << Message << "\n"; 454 exit(1); 455 } 456 457 static void warnOnNoMatchForSections() { 458 SetVector<StringRef> MissingSections; 459 for (StringRef S : FilterSections) { 460 if (FoundSectionSet.count(S)) 461 return; 462 // User may specify a unnamed section. Don't warn for it. 463 if (!S.empty()) 464 MissingSections.insert(S); 465 } 466 467 // Warn only if no section in FilterSections is matched. 468 for (StringRef S : MissingSections) 469 reportCmdLineWarning("section '" + S + 470 "' mentioned in a -j/--section option, but not " 471 "found in any input file"); 472 } 473 474 static const Target *getTarget(const ObjectFile *Obj) { 475 // Figure out the target triple. 476 Triple TheTriple("unknown-unknown-unknown"); 477 if (TripleName.empty()) { 478 TheTriple = Obj->makeTriple(); 479 } else { 480 TheTriple.setTriple(Triple::normalize(TripleName)); 481 auto Arch = Obj->getArch(); 482 if (Arch == Triple::arm || Arch == Triple::armeb) 483 Obj->setARMSubArch(TheTriple); 484 } 485 486 // Get the target specific parser. 487 std::string Error; 488 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple, 489 Error); 490 if (!TheTarget) 491 reportError(Obj->getFileName(), "can't find target: " + Error); 492 493 // Update the triple name and return the found target. 494 TripleName = TheTriple.getTriple(); 495 return TheTarget; 496 } 497 498 bool objdump::isRelocAddressLess(RelocationRef A, RelocationRef B) { 499 return A.getOffset() < B.getOffset(); 500 } 501 502 static Error getRelocationValueString(const RelocationRef &Rel, 503 SmallVectorImpl<char> &Result) { 504 const ObjectFile *Obj = Rel.getObject(); 505 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj)) 506 return getELFRelocationValueString(ELF, Rel, Result); 507 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj)) 508 return getCOFFRelocationValueString(COFF, Rel, Result); 509 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj)) 510 return getWasmRelocationValueString(Wasm, Rel, Result); 511 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj)) 512 return getMachORelocationValueString(MachO, Rel, Result); 513 if (auto *XCOFF = dyn_cast<XCOFFObjectFile>(Obj)) 514 return getXCOFFRelocationValueString(XCOFF, Rel, Result); 515 llvm_unreachable("unknown object file format"); 516 } 517 518 /// Indicates whether this relocation should hidden when listing 519 /// relocations, usually because it is the trailing part of a multipart 520 /// relocation that will be printed as part of the leading relocation. 521 static bool getHidden(RelocationRef RelRef) { 522 auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject()); 523 if (!MachO) 524 return false; 525 526 unsigned Arch = MachO->getArch(); 527 DataRefImpl Rel = RelRef.getRawDataRefImpl(); 528 uint64_t Type = MachO->getRelocationType(Rel); 529 530 // On arches that use the generic relocations, GENERIC_RELOC_PAIR 531 // is always hidden. 532 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) 533 return Type == MachO::GENERIC_RELOC_PAIR; 534 535 if (Arch == Triple::x86_64) { 536 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows 537 // an X86_64_RELOC_SUBTRACTOR. 538 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) { 539 DataRefImpl RelPrev = Rel; 540 RelPrev.d.a--; 541 uint64_t PrevType = MachO->getRelocationType(RelPrev); 542 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR) 543 return true; 544 } 545 } 546 547 return false; 548 } 549 550 namespace { 551 class SourcePrinter { 552 protected: 553 DILineInfo OldLineInfo; 554 const ObjectFile *Obj = nullptr; 555 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer; 556 // File name to file contents of source. 557 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache; 558 // Mark the line endings of the cached source. 559 std::unordered_map<std::string, std::vector<StringRef>> LineCache; 560 // Keep track of missing sources. 561 StringSet<> MissingSources; 562 // Only emit 'no debug info' warning once. 563 bool WarnedNoDebugInfo; 564 565 private: 566 bool cacheSource(const DILineInfo& LineInfoFile); 567 568 void printLines(raw_ostream &OS, const DILineInfo &LineInfo, 569 StringRef Delimiter); 570 571 void printSources(raw_ostream &OS, const DILineInfo &LineInfo, 572 StringRef ObjectFilename, StringRef Delimiter); 573 574 public: 575 SourcePrinter() = default; 576 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) 577 : Obj(Obj), WarnedNoDebugInfo(false) { 578 symbolize::LLVMSymbolizer::Options SymbolizerOpts; 579 SymbolizerOpts.PrintFunctions = 580 DILineInfoSpecifier::FunctionNameKind::LinkageName; 581 SymbolizerOpts.Demangle = Demangle; 582 SymbolizerOpts.DefaultArch = std::string(DefaultArch); 583 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts)); 584 } 585 virtual ~SourcePrinter() = default; 586 virtual void printSourceLine(raw_ostream &OS, 587 object::SectionedAddress Address, 588 StringRef ObjectFilename, 589 StringRef Delimiter = "; "); 590 }; 591 592 bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) { 593 std::unique_ptr<MemoryBuffer> Buffer; 594 if (LineInfo.Source) { 595 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source); 596 } else { 597 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName); 598 if (!BufferOrError) { 599 if (MissingSources.insert(LineInfo.FileName).second) 600 reportWarning("failed to find source " + LineInfo.FileName, 601 Obj->getFileName()); 602 return false; 603 } 604 Buffer = std::move(*BufferOrError); 605 } 606 // Chomp the file to get lines 607 const char *BufferStart = Buffer->getBufferStart(), 608 *BufferEnd = Buffer->getBufferEnd(); 609 std::vector<StringRef> &Lines = LineCache[LineInfo.FileName]; 610 const char *Start = BufferStart; 611 for (const char *I = BufferStart; I != BufferEnd; ++I) 612 if (*I == '\n') { 613 Lines.emplace_back(Start, I - Start - (BufferStart < I && I[-1] == '\r')); 614 Start = I + 1; 615 } 616 if (Start < BufferEnd) 617 Lines.emplace_back(Start, BufferEnd - Start); 618 SourceCache[LineInfo.FileName] = std::move(Buffer); 619 return true; 620 } 621 622 void SourcePrinter::printSourceLine(raw_ostream &OS, 623 object::SectionedAddress Address, 624 StringRef ObjectFilename, 625 StringRef Delimiter) { 626 if (!Symbolizer) 627 return; 628 629 DILineInfo LineInfo = DILineInfo(); 630 auto ExpectedLineInfo = Symbolizer->symbolizeCode(*Obj, Address); 631 std::string ErrorMessage; 632 if (!ExpectedLineInfo) 633 ErrorMessage = toString(ExpectedLineInfo.takeError()); 634 else 635 LineInfo = *ExpectedLineInfo; 636 637 if (LineInfo.FileName == DILineInfo::BadString) { 638 if (!WarnedNoDebugInfo) { 639 std::string Warning = 640 "failed to parse debug information for " + ObjectFilename.str(); 641 if (!ErrorMessage.empty()) 642 Warning += ": " + ErrorMessage; 643 reportWarning(Warning, ObjectFilename); 644 WarnedNoDebugInfo = true; 645 } 646 } 647 648 if (PrintLines) 649 printLines(OS, LineInfo, Delimiter); 650 if (PrintSource) 651 printSources(OS, LineInfo, ObjectFilename, Delimiter); 652 OldLineInfo = LineInfo; 653 } 654 655 void SourcePrinter::printLines(raw_ostream &OS, const DILineInfo &LineInfo, 656 StringRef Delimiter) { 657 bool PrintFunctionName = LineInfo.FunctionName != DILineInfo::BadString && 658 LineInfo.FunctionName != OldLineInfo.FunctionName; 659 if (PrintFunctionName) { 660 OS << Delimiter << LineInfo.FunctionName; 661 // If demangling is successful, FunctionName will end with "()". Print it 662 // only if demangling did not run or was unsuccessful. 663 if (!StringRef(LineInfo.FunctionName).endswith("()")) 664 OS << "()"; 665 OS << ":\n"; 666 } 667 if (LineInfo.FileName != DILineInfo::BadString && LineInfo.Line != 0 && 668 (OldLineInfo.Line != LineInfo.Line || 669 OldLineInfo.FileName != LineInfo.FileName || PrintFunctionName)) 670 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n"; 671 } 672 673 void SourcePrinter::printSources(raw_ostream &OS, const DILineInfo &LineInfo, 674 StringRef ObjectFilename, 675 StringRef Delimiter) { 676 if (LineInfo.FileName == DILineInfo::BadString || LineInfo.Line == 0 || 677 (OldLineInfo.Line == LineInfo.Line && 678 OldLineInfo.FileName == LineInfo.FileName)) 679 return; 680 681 if (SourceCache.find(LineInfo.FileName) == SourceCache.end()) 682 if (!cacheSource(LineInfo)) 683 return; 684 auto LineBuffer = LineCache.find(LineInfo.FileName); 685 if (LineBuffer != LineCache.end()) { 686 if (LineInfo.Line > LineBuffer->second.size()) { 687 reportWarning( 688 formatv( 689 "debug info line number {0} exceeds the number of lines in {1}", 690 LineInfo.Line, LineInfo.FileName), 691 ObjectFilename); 692 return; 693 } 694 // Vector begins at 0, line numbers are non-zero 695 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n'; 696 } 697 } 698 699 static bool isAArch64Elf(const ObjectFile *Obj) { 700 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj); 701 return Elf && Elf->getEMachine() == ELF::EM_AARCH64; 702 } 703 704 static bool isArmElf(const ObjectFile *Obj) { 705 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj); 706 return Elf && Elf->getEMachine() == ELF::EM_ARM; 707 } 708 709 static bool hasMappingSymbols(const ObjectFile *Obj) { 710 return isArmElf(Obj) || isAArch64Elf(Obj); 711 } 712 713 static void printRelocation(StringRef FileName, const RelocationRef &Rel, 714 uint64_t Address, bool Is64Bits) { 715 StringRef Fmt = Is64Bits ? "\t\t%016" PRIx64 ": " : "\t\t\t%08" PRIx64 ": "; 716 SmallString<16> Name; 717 SmallString<32> Val; 718 Rel.getTypeName(Name); 719 if (Error E = getRelocationValueString(Rel, Val)) 720 reportError(std::move(E), FileName); 721 outs() << format(Fmt.data(), Address) << Name << "\t" << Val << "\n"; 722 } 723 724 class PrettyPrinter { 725 public: 726 virtual ~PrettyPrinter() = default; 727 virtual void printInst(MCInstPrinter &IP, const MCInst *MI, 728 ArrayRef<uint8_t> Bytes, 729 object::SectionedAddress Address, raw_ostream &OS, 730 StringRef Annot, MCSubtargetInfo const &STI, 731 SourcePrinter *SP, StringRef ObjectFilename, 732 std::vector<RelocationRef> *Rels = nullptr) { 733 if (SP && (PrintSource || PrintLines)) 734 SP->printSourceLine(OS, Address, ObjectFilename); 735 736 size_t Start = OS.tell(); 737 if (!NoLeadingAddr) 738 OS << format("%8" PRIx64 ":", Address.Address); 739 if (!NoShowRawInsn) { 740 OS << ' '; 741 dumpBytes(Bytes, OS); 742 } 743 744 // The output of printInst starts with a tab. Print some spaces so that the 745 // tab has 1 column and advances to the target tab stop. Give more columns 746 // to x86 which may encode an instruction with many bytes. 747 unsigned TabStop = 748 NoShowRawInsn ? 16 : STI.getTargetTriple().isX86() ? 40 : 24; 749 unsigned Column = OS.tell() - Start; 750 OS.indent(Column < TabStop - 1 ? TabStop - 1 - Column : 7 - Column % 8); 751 752 if (MI) { 753 // See MCInstPrinter::printInst. On targets where a PC relative immediate 754 // is relative to the next instruction and the length of a MCInst is 755 // difficult to measure (x86), this is the address of the next 756 // instruction. 757 uint64_t Addr = 758 Address.Address + (STI.getTargetTriple().isX86() ? Bytes.size() : 0); 759 IP.printInst(MI, Addr, "", STI, OS); 760 } else 761 OS << "\t<unknown>"; 762 } 763 }; 764 PrettyPrinter PrettyPrinterInst; 765 766 class HexagonPrettyPrinter : public PrettyPrinter { 767 public: 768 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address, 769 raw_ostream &OS) { 770 uint32_t opcode = 771 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0]; 772 if (!NoLeadingAddr) 773 OS << format("%8" PRIx64 ":", Address); 774 if (!NoShowRawInsn) { 775 OS << "\t"; 776 dumpBytes(Bytes.slice(0, 4), OS); 777 OS << format("\t%08" PRIx32, opcode); 778 } 779 } 780 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes, 781 object::SectionedAddress Address, raw_ostream &OS, 782 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, 783 StringRef ObjectFilename, 784 std::vector<RelocationRef> *Rels) override { 785 if (SP && (PrintSource || PrintLines)) 786 SP->printSourceLine(OS, Address, ObjectFilename, ""); 787 if (!MI) { 788 printLead(Bytes, Address.Address, OS); 789 OS << " <unknown>"; 790 return; 791 } 792 std::string Buffer; 793 { 794 raw_string_ostream TempStream(Buffer); 795 IP.printInst(MI, Address.Address, "", STI, TempStream); 796 } 797 StringRef Contents(Buffer); 798 // Split off bundle attributes 799 auto PacketBundle = Contents.rsplit('\n'); 800 // Split off first instruction from the rest 801 auto HeadTail = PacketBundle.first.split('\n'); 802 auto Preamble = " { "; 803 auto Separator = ""; 804 805 // Hexagon's packets require relocations to be inline rather than 806 // clustered at the end of the packet. 807 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin(); 808 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end(); 809 auto PrintReloc = [&]() -> void { 810 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) { 811 if (RelCur->getOffset() == Address.Address) { 812 printRelocation(ObjectFilename, *RelCur, Address.Address, false); 813 return; 814 } 815 ++RelCur; 816 } 817 }; 818 819 while (!HeadTail.first.empty()) { 820 OS << Separator; 821 Separator = "\n"; 822 if (SP && (PrintSource || PrintLines)) 823 SP->printSourceLine(OS, Address, ObjectFilename, ""); 824 printLead(Bytes, Address.Address, OS); 825 OS << Preamble; 826 Preamble = " "; 827 StringRef Inst; 828 auto Duplex = HeadTail.first.split('\v'); 829 if (!Duplex.second.empty()) { 830 OS << Duplex.first; 831 OS << "; "; 832 Inst = Duplex.second; 833 } 834 else 835 Inst = HeadTail.first; 836 OS << Inst; 837 HeadTail = HeadTail.second.split('\n'); 838 if (HeadTail.first.empty()) 839 OS << " } " << PacketBundle.second; 840 PrintReloc(); 841 Bytes = Bytes.slice(4); 842 Address.Address += 4; 843 } 844 } 845 }; 846 HexagonPrettyPrinter HexagonPrettyPrinterInst; 847 848 class AMDGCNPrettyPrinter : public PrettyPrinter { 849 public: 850 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes, 851 object::SectionedAddress Address, raw_ostream &OS, 852 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, 853 StringRef ObjectFilename, 854 std::vector<RelocationRef> *Rels) override { 855 if (SP && (PrintSource || PrintLines)) 856 SP->printSourceLine(OS, Address, ObjectFilename); 857 858 if (MI) { 859 SmallString<40> InstStr; 860 raw_svector_ostream IS(InstStr); 861 862 IP.printInst(MI, Address.Address, "", STI, IS); 863 864 OS << left_justify(IS.str(), 60); 865 } else { 866 // an unrecognized encoding - this is probably data so represent it 867 // using the .long directive, or .byte directive if fewer than 4 bytes 868 // remaining 869 if (Bytes.size() >= 4) { 870 OS << format("\t.long 0x%08" PRIx32 " ", 871 support::endian::read32<support::little>(Bytes.data())); 872 OS.indent(42); 873 } else { 874 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]); 875 for (unsigned int i = 1; i < Bytes.size(); i++) 876 OS << format(", 0x%02" PRIx8, Bytes[i]); 877 OS.indent(55 - (6 * Bytes.size())); 878 } 879 } 880 881 OS << format("// %012" PRIX64 ":", Address.Address); 882 if (Bytes.size() >= 4) { 883 // D should be casted to uint32_t here as it is passed by format to 884 // snprintf as vararg. 885 for (uint32_t D : makeArrayRef( 886 reinterpret_cast<const support::little32_t *>(Bytes.data()), 887 Bytes.size() / 4)) 888 OS << format(" %08" PRIX32, D); 889 } else { 890 for (unsigned char B : Bytes) 891 OS << format(" %02" PRIX8, B); 892 } 893 894 if (!Annot.empty()) 895 OS << " // " << Annot; 896 } 897 }; 898 AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst; 899 900 class BPFPrettyPrinter : public PrettyPrinter { 901 public: 902 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes, 903 object::SectionedAddress Address, raw_ostream &OS, 904 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP, 905 StringRef ObjectFilename, 906 std::vector<RelocationRef> *Rels) override { 907 if (SP && (PrintSource || PrintLines)) 908 SP->printSourceLine(OS, Address, ObjectFilename); 909 if (!NoLeadingAddr) 910 OS << format("%8" PRId64 ":", Address.Address / 8); 911 if (!NoShowRawInsn) { 912 OS << "\t"; 913 dumpBytes(Bytes, OS); 914 } 915 if (MI) 916 IP.printInst(MI, Address.Address, "", STI, OS); 917 else 918 OS << "\t<unknown>"; 919 } 920 }; 921 BPFPrettyPrinter BPFPrettyPrinterInst; 922 923 PrettyPrinter &selectPrettyPrinter(Triple const &Triple) { 924 switch(Triple.getArch()) { 925 default: 926 return PrettyPrinterInst; 927 case Triple::hexagon: 928 return HexagonPrettyPrinterInst; 929 case Triple::amdgcn: 930 return AMDGCNPrettyPrinterInst; 931 case Triple::bpfel: 932 case Triple::bpfeb: 933 return BPFPrettyPrinterInst; 934 } 935 } 936 } 937 938 static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) { 939 assert(Obj->isELF()); 940 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj)) 941 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType(); 942 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj)) 943 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType(); 944 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj)) 945 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType(); 946 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj)) 947 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType(); 948 llvm_unreachable("Unsupported binary format"); 949 } 950 951 template <class ELFT> static void 952 addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj, 953 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) { 954 for (auto Symbol : Obj->getDynamicSymbolIterators()) { 955 uint8_t SymbolType = Symbol.getELFType(); 956 if (SymbolType == ELF::STT_SECTION) 957 continue; 958 959 uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName()); 960 // ELFSymbolRef::getAddress() returns size instead of value for common 961 // symbols which is not desirable for disassembly output. Overriding. 962 if (SymbolType == ELF::STT_COMMON) 963 Address = Obj->getSymbol(Symbol.getRawDataRefImpl())->st_value; 964 965 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName()); 966 if (Name.empty()) 967 continue; 968 969 section_iterator SecI = 970 unwrapOrError(Symbol.getSection(), Obj->getFileName()); 971 if (SecI == Obj->section_end()) 972 continue; 973 974 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType); 975 } 976 } 977 978 static void 979 addDynamicElfSymbols(const ObjectFile *Obj, 980 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) { 981 assert(Obj->isELF()); 982 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj)) 983 addDynamicElfSymbols(Elf32LEObj, AllSymbols); 984 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj)) 985 addDynamicElfSymbols(Elf64LEObj, AllSymbols); 986 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj)) 987 addDynamicElfSymbols(Elf32BEObj, AllSymbols); 988 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj)) 989 addDynamicElfSymbols(Elf64BEObj, AllSymbols); 990 else 991 llvm_unreachable("Unsupported binary format"); 992 } 993 994 static void addPltEntries(const ObjectFile *Obj, 995 std::map<SectionRef, SectionSymbolsTy> &AllSymbols, 996 StringSaver &Saver) { 997 Optional<SectionRef> Plt = None; 998 for (const SectionRef &Section : Obj->sections()) { 999 Expected<StringRef> SecNameOrErr = Section.getName(); 1000 if (!SecNameOrErr) { 1001 consumeError(SecNameOrErr.takeError()); 1002 continue; 1003 } 1004 if (*SecNameOrErr == ".plt") 1005 Plt = Section; 1006 } 1007 if (!Plt) 1008 return; 1009 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) { 1010 for (auto PltEntry : ElfObj->getPltAddresses()) { 1011 SymbolRef Symbol(PltEntry.first, ElfObj); 1012 uint8_t SymbolType = getElfSymbolType(Obj, Symbol); 1013 1014 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName()); 1015 if (!Name.empty()) 1016 AllSymbols[*Plt].emplace_back( 1017 PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType); 1018 } 1019 } 1020 } 1021 1022 // Normally the disassembly output will skip blocks of zeroes. This function 1023 // returns the number of zero bytes that can be skipped when dumping the 1024 // disassembly of the instructions in Buf. 1025 static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) { 1026 // Find the number of leading zeroes. 1027 size_t N = 0; 1028 while (N < Buf.size() && !Buf[N]) 1029 ++N; 1030 1031 // We may want to skip blocks of zero bytes, but unless we see 1032 // at least 8 of them in a row. 1033 if (N < 8) 1034 return 0; 1035 1036 // We skip zeroes in multiples of 4 because do not want to truncate an 1037 // instruction if it starts with a zero byte. 1038 return N & ~0x3; 1039 } 1040 1041 // Returns a map from sections to their relocations. 1042 static std::map<SectionRef, std::vector<RelocationRef>> 1043 getRelocsMap(object::ObjectFile const &Obj) { 1044 std::map<SectionRef, std::vector<RelocationRef>> Ret; 1045 uint64_t I = (uint64_t)-1; 1046 for (SectionRef Sec : Obj.sections()) { 1047 ++I; 1048 Expected<section_iterator> RelocatedOrErr = Sec.getRelocatedSection(); 1049 if (!RelocatedOrErr) 1050 reportError(Obj.getFileName(), 1051 "section (" + Twine(I) + 1052 "): failed to get a relocated section: " + 1053 toString(RelocatedOrErr.takeError())); 1054 1055 section_iterator Relocated = *RelocatedOrErr; 1056 if (Relocated == Obj.section_end() || !checkSectionFilter(*Relocated).Keep) 1057 continue; 1058 std::vector<RelocationRef> &V = Ret[*Relocated]; 1059 for (const RelocationRef &R : Sec.relocations()) 1060 V.push_back(R); 1061 // Sort relocations by address. 1062 llvm::stable_sort(V, isRelocAddressLess); 1063 } 1064 return Ret; 1065 } 1066 1067 // Used for --adjust-vma to check if address should be adjusted by the 1068 // specified value for a given section. 1069 // For ELF we do not adjust non-allocatable sections like debug ones, 1070 // because they are not loadable. 1071 // TODO: implement for other file formats. 1072 static bool shouldAdjustVA(const SectionRef &Section) { 1073 const ObjectFile *Obj = Section.getObject(); 1074 if (Obj->isELF()) 1075 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC; 1076 return false; 1077 } 1078 1079 1080 typedef std::pair<uint64_t, char> MappingSymbolPair; 1081 static char getMappingSymbolKind(ArrayRef<MappingSymbolPair> MappingSymbols, 1082 uint64_t Address) { 1083 auto It = 1084 partition_point(MappingSymbols, [Address](const MappingSymbolPair &Val) { 1085 return Val.first <= Address; 1086 }); 1087 // Return zero for any address before the first mapping symbol; this means 1088 // we should use the default disassembly mode, depending on the target. 1089 if (It == MappingSymbols.begin()) 1090 return '\x00'; 1091 return (It - 1)->second; 1092 } 1093 1094 static uint64_t dumpARMELFData(uint64_t SectionAddr, uint64_t Index, 1095 uint64_t End, const ObjectFile *Obj, 1096 ArrayRef<uint8_t> Bytes, 1097 ArrayRef<MappingSymbolPair> MappingSymbols) { 1098 support::endianness Endian = 1099 Obj->isLittleEndian() ? support::little : support::big; 1100 outs() << format("%8" PRIx64 ":\t", SectionAddr + Index); 1101 if (Index + 4 <= End) { 1102 dumpBytes(Bytes.slice(Index, 4), outs()); 1103 outs() << "\t.word\t" 1104 << format_hex(support::endian::read32(Bytes.data() + Index, Endian), 1105 10); 1106 return 4; 1107 } 1108 if (Index + 2 <= End) { 1109 dumpBytes(Bytes.slice(Index, 2), outs()); 1110 outs() << "\t\t.short\t" 1111 << format_hex(support::endian::read16(Bytes.data() + Index, Endian), 1112 6); 1113 return 2; 1114 } 1115 dumpBytes(Bytes.slice(Index, 1), outs()); 1116 outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4); 1117 return 1; 1118 } 1119 1120 static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End, 1121 ArrayRef<uint8_t> Bytes) { 1122 // print out data up to 8 bytes at a time in hex and ascii 1123 uint8_t AsciiData[9] = {'\0'}; 1124 uint8_t Byte; 1125 int NumBytes = 0; 1126 1127 for (; Index < End; ++Index) { 1128 if (NumBytes == 0) 1129 outs() << format("%8" PRIx64 ":", SectionAddr + Index); 1130 Byte = Bytes.slice(Index)[0]; 1131 outs() << format(" %02x", Byte); 1132 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.'; 1133 1134 uint8_t IndentOffset = 0; 1135 NumBytes++; 1136 if (Index == End - 1 || NumBytes > 8) { 1137 // Indent the space for less than 8 bytes data. 1138 // 2 spaces for byte and one for space between bytes 1139 IndentOffset = 3 * (8 - NumBytes); 1140 for (int Excess = NumBytes; Excess < 8; Excess++) 1141 AsciiData[Excess] = '\0'; 1142 NumBytes = 8; 1143 } 1144 if (NumBytes == 8) { 1145 AsciiData[8] = '\0'; 1146 outs() << std::string(IndentOffset, ' ') << " "; 1147 outs() << reinterpret_cast<char *>(AsciiData); 1148 outs() << '\n'; 1149 NumBytes = 0; 1150 } 1151 } 1152 } 1153 1154 SymbolInfoTy objdump::createSymbolInfo(const ObjectFile *Obj, 1155 const SymbolRef &Symbol) { 1156 const StringRef FileName = Obj->getFileName(); 1157 const uint64_t Addr = unwrapOrError(Symbol.getAddress(), FileName); 1158 const StringRef Name = unwrapOrError(Symbol.getName(), FileName); 1159 1160 if (Obj->isXCOFF() && SymbolDescription) { 1161 const auto *XCOFFObj = cast<XCOFFObjectFile>(Obj); 1162 DataRefImpl SymbolDRI = Symbol.getRawDataRefImpl(); 1163 1164 const uint32_t SymbolIndex = XCOFFObj->getSymbolIndex(SymbolDRI.p); 1165 Optional<XCOFF::StorageMappingClass> Smc = 1166 getXCOFFSymbolCsectSMC(XCOFFObj, Symbol); 1167 return SymbolInfoTy(Addr, Name, Smc, SymbolIndex, 1168 isLabel(XCOFFObj, Symbol)); 1169 } else 1170 return SymbolInfoTy(Addr, Name, 1171 Obj->isELF() ? getElfSymbolType(Obj, Symbol) 1172 : (uint8_t)ELF::STT_NOTYPE); 1173 } 1174 1175 static SymbolInfoTy createDummySymbolInfo(const ObjectFile *Obj, 1176 const uint64_t Addr, StringRef &Name, 1177 uint8_t Type) { 1178 if (Obj->isXCOFF() && SymbolDescription) 1179 return SymbolInfoTy(Addr, Name, None, None, false); 1180 else 1181 return SymbolInfoTy(Addr, Name, Type); 1182 } 1183 1184 static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj, 1185 MCContext &Ctx, MCDisassembler *PrimaryDisAsm, 1186 MCDisassembler *SecondaryDisAsm, 1187 const MCInstrAnalysis *MIA, MCInstPrinter *IP, 1188 const MCSubtargetInfo *PrimarySTI, 1189 const MCSubtargetInfo *SecondarySTI, 1190 PrettyPrinter &PIP, 1191 SourcePrinter &SP, bool InlineRelocs) { 1192 const MCSubtargetInfo *STI = PrimarySTI; 1193 MCDisassembler *DisAsm = PrimaryDisAsm; 1194 bool PrimaryIsThumb = false; 1195 if (isArmElf(Obj)) 1196 PrimaryIsThumb = STI->checkFeatures("+thumb-mode"); 1197 1198 std::map<SectionRef, std::vector<RelocationRef>> RelocMap; 1199 if (InlineRelocs) 1200 RelocMap = getRelocsMap(*Obj); 1201 bool Is64Bits = Obj->getBytesInAddress() > 4; 1202 1203 // Create a mapping from virtual address to symbol name. This is used to 1204 // pretty print the symbols while disassembling. 1205 std::map<SectionRef, SectionSymbolsTy> AllSymbols; 1206 SectionSymbolsTy AbsoluteSymbols; 1207 const StringRef FileName = Obj->getFileName(); 1208 const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj); 1209 for (const SymbolRef &Symbol : Obj->symbols()) { 1210 StringRef Name = unwrapOrError(Symbol.getName(), FileName); 1211 if (Name.empty() && !(Obj->isXCOFF() && SymbolDescription)) 1212 continue; 1213 1214 if (Obj->isELF() && getElfSymbolType(Obj, Symbol) == ELF::STT_SECTION) 1215 continue; 1216 1217 // Don't ask a Mach-O STAB symbol for its section unless you know that 1218 // STAB symbol's section field refers to a valid section index. Otherwise 1219 // the symbol may error trying to load a section that does not exist. 1220 if (MachO) { 1221 DataRefImpl SymDRI = Symbol.getRawDataRefImpl(); 1222 uint8_t NType = (MachO->is64Bit() ? 1223 MachO->getSymbol64TableEntry(SymDRI).n_type: 1224 MachO->getSymbolTableEntry(SymDRI).n_type); 1225 if (NType & MachO::N_STAB) 1226 continue; 1227 } 1228 1229 section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName); 1230 if (SecI != Obj->section_end()) 1231 AllSymbols[*SecI].push_back(createSymbolInfo(Obj, Symbol)); 1232 else 1233 AbsoluteSymbols.push_back(createSymbolInfo(Obj, Symbol)); 1234 } 1235 1236 if (AllSymbols.empty() && Obj->isELF()) 1237 addDynamicElfSymbols(Obj, AllSymbols); 1238 1239 BumpPtrAllocator A; 1240 StringSaver Saver(A); 1241 addPltEntries(Obj, AllSymbols, Saver); 1242 1243 // Create a mapping from virtual address to section. An empty section can 1244 // cause more than one section at the same address. Sort such sections to be 1245 // before same-addressed non-empty sections so that symbol lookups prefer the 1246 // non-empty section. 1247 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses; 1248 for (SectionRef Sec : Obj->sections()) 1249 SectionAddresses.emplace_back(Sec.getAddress(), Sec); 1250 llvm::stable_sort(SectionAddresses, [](const auto &LHS, const auto &RHS) { 1251 if (LHS.first != RHS.first) 1252 return LHS.first < RHS.first; 1253 return LHS.second.getSize() < RHS.second.getSize(); 1254 }); 1255 1256 // Linked executables (.exe and .dll files) typically don't include a real 1257 // symbol table but they might contain an export table. 1258 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) { 1259 for (const auto &ExportEntry : COFFObj->export_directories()) { 1260 StringRef Name; 1261 if (Error E = ExportEntry.getSymbolName(Name)) 1262 reportError(std::move(E), Obj->getFileName()); 1263 if (Name.empty()) 1264 continue; 1265 1266 uint32_t RVA; 1267 if (Error E = ExportEntry.getExportRVA(RVA)) 1268 reportError(std::move(E), Obj->getFileName()); 1269 1270 uint64_t VA = COFFObj->getImageBase() + RVA; 1271 auto Sec = partition_point( 1272 SectionAddresses, [VA](const std::pair<uint64_t, SectionRef> &O) { 1273 return O.first <= VA; 1274 }); 1275 if (Sec != SectionAddresses.begin()) { 1276 --Sec; 1277 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE); 1278 } else 1279 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE); 1280 } 1281 } 1282 1283 // Sort all the symbols, this allows us to use a simple binary search to find 1284 // Multiple symbols can have the same address. Use a stable sort to stabilize 1285 // the output. 1286 StringSet<> FoundDisasmSymbolSet; 1287 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols) 1288 stable_sort(SecSyms.second); 1289 stable_sort(AbsoluteSymbols); 1290 1291 for (const SectionRef &Section : ToolSectionFilter(*Obj)) { 1292 if (FilterSections.empty() && !DisassembleAll && 1293 (!Section.isText() || Section.isVirtual())) 1294 continue; 1295 1296 uint64_t SectionAddr = Section.getAddress(); 1297 uint64_t SectSize = Section.getSize(); 1298 if (!SectSize) 1299 continue; 1300 1301 // Get the list of all the symbols in this section. 1302 SectionSymbolsTy &Symbols = AllSymbols[Section]; 1303 std::vector<MappingSymbolPair> MappingSymbols; 1304 if (hasMappingSymbols(Obj)) { 1305 for (const auto &Symb : Symbols) { 1306 uint64_t Address = Symb.Addr; 1307 StringRef Name = Symb.Name; 1308 if (Name.startswith("$d")) 1309 MappingSymbols.emplace_back(Address - SectionAddr, 'd'); 1310 if (Name.startswith("$x")) 1311 MappingSymbols.emplace_back(Address - SectionAddr, 'x'); 1312 if (Name.startswith("$a")) 1313 MappingSymbols.emplace_back(Address - SectionAddr, 'a'); 1314 if (Name.startswith("$t")) 1315 MappingSymbols.emplace_back(Address - SectionAddr, 't'); 1316 } 1317 } 1318 1319 llvm::sort(MappingSymbols); 1320 1321 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) { 1322 // AMDGPU disassembler uses symbolizer for printing labels 1323 std::unique_ptr<MCRelocationInfo> RelInfo( 1324 TheTarget->createMCRelocationInfo(TripleName, Ctx)); 1325 if (RelInfo) { 1326 std::unique_ptr<MCSymbolizer> Symbolizer( 1327 TheTarget->createMCSymbolizer( 1328 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo))); 1329 DisAsm->setSymbolizer(std::move(Symbolizer)); 1330 } 1331 } 1332 1333 StringRef SegmentName = ""; 1334 if (MachO) { 1335 DataRefImpl DR = Section.getRawDataRefImpl(); 1336 SegmentName = MachO->getSectionFinalSegmentName(DR); 1337 } 1338 1339 StringRef SectionName = unwrapOrError(Section.getName(), Obj->getFileName()); 1340 // If the section has no symbol at the start, just insert a dummy one. 1341 if (Symbols.empty() || Symbols[0].Addr != 0) { 1342 Symbols.insert(Symbols.begin(), 1343 createDummySymbolInfo(Obj, SectionAddr, SectionName, 1344 Section.isText() ? ELF::STT_FUNC 1345 : ELF::STT_OBJECT)); 1346 } 1347 1348 SmallString<40> Comments; 1349 raw_svector_ostream CommentStream(Comments); 1350 1351 ArrayRef<uint8_t> Bytes = arrayRefFromStringRef( 1352 unwrapOrError(Section.getContents(), Obj->getFileName())); 1353 1354 uint64_t VMAAdjustment = 0; 1355 if (shouldAdjustVA(Section)) 1356 VMAAdjustment = AdjustVMA; 1357 1358 uint64_t Size; 1359 uint64_t Index; 1360 bool PrintedSection = false; 1361 std::vector<RelocationRef> Rels = RelocMap[Section]; 1362 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin(); 1363 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end(); 1364 // Disassemble symbol by symbol. 1365 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) { 1366 std::string SymbolName = Symbols[SI].Name.str(); 1367 if (Demangle) 1368 SymbolName = demangle(SymbolName); 1369 1370 // Skip if --disassemble-symbols is not empty and the symbol is not in 1371 // the list. 1372 if (!DisasmSymbolSet.empty() && !DisasmSymbolSet.count(SymbolName)) 1373 continue; 1374 1375 uint64_t Start = Symbols[SI].Addr; 1376 if (Start < SectionAddr || StopAddress <= Start) 1377 continue; 1378 else 1379 FoundDisasmSymbolSet.insert(SymbolName); 1380 1381 // The end is the section end, the beginning of the next symbol, or 1382 // --stop-address. 1383 uint64_t End = std::min<uint64_t>(SectionAddr + SectSize, StopAddress); 1384 if (SI + 1 < SE) 1385 End = std::min(End, Symbols[SI + 1].Addr); 1386 if (Start >= End || End <= StartAddress) 1387 continue; 1388 Start -= SectionAddr; 1389 End -= SectionAddr; 1390 1391 if (!PrintedSection) { 1392 PrintedSection = true; 1393 outs() << "\nDisassembly of section "; 1394 if (!SegmentName.empty()) 1395 outs() << SegmentName << ","; 1396 outs() << SectionName << ":\n"; 1397 } 1398 1399 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) { 1400 if (Symbols[SI].Type == ELF::STT_AMDGPU_HSA_KERNEL) { 1401 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes) 1402 Start += 256; 1403 } 1404 if (SI == SE - 1 || 1405 Symbols[SI + 1].Type == ELF::STT_AMDGPU_HSA_KERNEL) { 1406 // cut trailing zeroes at the end of kernel 1407 // cut up to 256 bytes 1408 const uint64_t EndAlign = 256; 1409 const auto Limit = End - (std::min)(EndAlign, End - Start); 1410 while (End > Limit && 1411 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0) 1412 End -= 4; 1413 } 1414 } 1415 1416 outs() << '\n'; 1417 if (!NoLeadingAddr) 1418 outs() << format(Is64Bits ? "%016" PRIx64 " " : "%08" PRIx64 " ", 1419 SectionAddr + Start + VMAAdjustment); 1420 if (Obj->isXCOFF() && SymbolDescription) { 1421 outs() << getXCOFFSymbolDescription(Symbols[SI], SymbolName) << ":\n"; 1422 } else 1423 outs() << '<' << SymbolName << ">:\n"; 1424 1425 // Don't print raw contents of a virtual section. A virtual section 1426 // doesn't have any contents in the file. 1427 if (Section.isVirtual()) { 1428 outs() << "...\n"; 1429 continue; 1430 } 1431 1432 // Some targets (like WebAssembly) have a special prelude at the start 1433 // of each symbol. 1434 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start), 1435 SectionAddr + Start, CommentStream); 1436 Start += Size; 1437 1438 Index = Start; 1439 if (SectionAddr < StartAddress) 1440 Index = std::max<uint64_t>(Index, StartAddress - SectionAddr); 1441 1442 // If there is a data/common symbol inside an ELF text section and we are 1443 // only disassembling text (applicable all architectures), we are in a 1444 // situation where we must print the data and not disassemble it. 1445 if (Obj->isELF() && !DisassembleAll && Section.isText()) { 1446 uint8_t SymTy = Symbols[SI].Type; 1447 if (SymTy == ELF::STT_OBJECT || SymTy == ELF::STT_COMMON) { 1448 dumpELFData(SectionAddr, Index, End, Bytes); 1449 Index = End; 1450 } 1451 } 1452 1453 bool CheckARMELFData = hasMappingSymbols(Obj) && 1454 Symbols[SI].Type != ELF::STT_OBJECT && 1455 !DisassembleAll; 1456 bool DumpARMELFData = false; 1457 while (Index < End) { 1458 // ARM and AArch64 ELF binaries can interleave data and text in the 1459 // same section. We rely on the markers introduced to understand what 1460 // we need to dump. If the data marker is within a function, it is 1461 // denoted as a word/short etc. 1462 if (CheckARMELFData) { 1463 char Kind = getMappingSymbolKind(MappingSymbols, Index); 1464 DumpARMELFData = Kind == 'd'; 1465 if (SecondarySTI) { 1466 if (Kind == 'a') { 1467 STI = PrimaryIsThumb ? SecondarySTI : PrimarySTI; 1468 DisAsm = PrimaryIsThumb ? SecondaryDisAsm : PrimaryDisAsm; 1469 } else if (Kind == 't') { 1470 STI = PrimaryIsThumb ? PrimarySTI : SecondarySTI; 1471 DisAsm = PrimaryIsThumb ? PrimaryDisAsm : SecondaryDisAsm; 1472 } 1473 } 1474 } 1475 1476 if (DumpARMELFData) { 1477 Size = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes, 1478 MappingSymbols); 1479 } else { 1480 // When -z or --disassemble-zeroes are given we always dissasemble 1481 // them. Otherwise we might want to skip zero bytes we see. 1482 if (!DisassembleZeroes) { 1483 uint64_t MaxOffset = End - Index; 1484 // For --reloc: print zero blocks patched by relocations, so that 1485 // relocations can be shown in the dump. 1486 if (RelCur != RelEnd) 1487 MaxOffset = RelCur->getOffset() - Index; 1488 1489 if (size_t N = 1490 countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) { 1491 outs() << "\t\t..." << '\n'; 1492 Index += N; 1493 continue; 1494 } 1495 } 1496 1497 // Disassemble a real instruction or a data when disassemble all is 1498 // provided 1499 MCInst Inst; 1500 bool Disassembled = 1501 DisAsm->getInstruction(Inst, Size, Bytes.slice(Index), 1502 SectionAddr + Index, CommentStream); 1503 if (Size == 0) 1504 Size = 1; 1505 1506 PIP.printInst( 1507 *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size), 1508 {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(), 1509 "", *STI, &SP, Obj->getFileName(), &Rels); 1510 outs() << CommentStream.str(); 1511 Comments.clear(); 1512 1513 // If disassembly has failed, avoid analysing invalid/incomplete 1514 // instruction information. Otherwise, try to resolve the target 1515 // address (jump target or memory operand address) and print it on the 1516 // right of the instruction. 1517 if (Disassembled && MIA) { 1518 uint64_t Target; 1519 bool PrintTarget = 1520 MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target); 1521 if (!PrintTarget) 1522 if (Optional<uint64_t> MaybeTarget = 1523 MIA->evaluateMemoryOperandAddress( 1524 Inst, SectionAddr + Index, Size)) { 1525 Target = *MaybeTarget; 1526 PrintTarget = true; 1527 outs() << " # " << Twine::utohexstr(Target); 1528 } 1529 if (PrintTarget) { 1530 // In a relocatable object, the target's section must reside in 1531 // the same section as the call instruction or it is accessed 1532 // through a relocation. 1533 // 1534 // In a non-relocatable object, the target may be in any section. 1535 // In that case, locate the section(s) containing the target 1536 // address and find the symbol in one of those, if possible. 1537 // 1538 // N.B. We don't walk the relocations in the relocatable case yet. 1539 std::vector<const SectionSymbolsTy *> TargetSectionSymbols; 1540 if (!Obj->isRelocatableObject()) { 1541 auto It = llvm::partition_point( 1542 SectionAddresses, 1543 [=](const std::pair<uint64_t, SectionRef> &O) { 1544 return O.first <= Target; 1545 }); 1546 uint64_t TargetSecAddr = 0; 1547 while (It != SectionAddresses.begin()) { 1548 --It; 1549 if (TargetSecAddr == 0) 1550 TargetSecAddr = It->first; 1551 if (It->first != TargetSecAddr) 1552 break; 1553 TargetSectionSymbols.push_back(&AllSymbols[It->second]); 1554 } 1555 } else { 1556 TargetSectionSymbols.push_back(&Symbols); 1557 } 1558 TargetSectionSymbols.push_back(&AbsoluteSymbols); 1559 1560 // Find the last symbol in the first candidate section whose 1561 // offset is less than or equal to the target. If there are no 1562 // such symbols, try in the next section and so on, before finally 1563 // using the nearest preceding absolute symbol (if any), if there 1564 // are no other valid symbols. 1565 const SymbolInfoTy *TargetSym = nullptr; 1566 for (const SectionSymbolsTy *TargetSymbols : 1567 TargetSectionSymbols) { 1568 auto It = llvm::partition_point( 1569 *TargetSymbols, 1570 [=](const SymbolInfoTy &O) { return O.Addr <= Target; }); 1571 if (It != TargetSymbols->begin()) { 1572 TargetSym = &*(It - 1); 1573 break; 1574 } 1575 } 1576 1577 if (TargetSym != nullptr) { 1578 uint64_t TargetAddress = TargetSym->Addr; 1579 std::string TargetName = TargetSym->Name.str(); 1580 if (Demangle) 1581 TargetName = demangle(TargetName); 1582 1583 outs() << " <" << TargetName; 1584 uint64_t Disp = Target - TargetAddress; 1585 if (Disp) 1586 outs() << "+0x" << Twine::utohexstr(Disp); 1587 outs() << '>'; 1588 } 1589 } 1590 } 1591 } 1592 outs() << "\n"; 1593 1594 // Hexagon does this in pretty printer 1595 if (Obj->getArch() != Triple::hexagon) { 1596 // Print relocation for instruction and data. 1597 while (RelCur != RelEnd) { 1598 uint64_t Offset = RelCur->getOffset(); 1599 // If this relocation is hidden, skip it. 1600 if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) { 1601 ++RelCur; 1602 continue; 1603 } 1604 1605 // Stop when RelCur's offset is past the disassembled 1606 // instruction/data. Note that it's possible the disassembled data 1607 // is not the complete data: we might see the relocation printed in 1608 // the middle of the data, but this matches the binutils objdump 1609 // output. 1610 if (Offset >= Index + Size) 1611 break; 1612 1613 // When --adjust-vma is used, update the address printed. 1614 if (RelCur->getSymbol() != Obj->symbol_end()) { 1615 Expected<section_iterator> SymSI = 1616 RelCur->getSymbol()->getSection(); 1617 if (SymSI && *SymSI != Obj->section_end() && 1618 shouldAdjustVA(**SymSI)) 1619 Offset += AdjustVMA; 1620 } 1621 1622 printRelocation(Obj->getFileName(), *RelCur, SectionAddr + Offset, 1623 Is64Bits); 1624 ++RelCur; 1625 } 1626 } 1627 1628 Index += Size; 1629 } 1630 } 1631 } 1632 StringSet<> MissingDisasmSymbolSet = 1633 set_difference(DisasmSymbolSet, FoundDisasmSymbolSet); 1634 for (StringRef Sym : MissingDisasmSymbolSet.keys()) 1635 reportWarning("failed to disassemble missing symbol " + Sym, FileName); 1636 } 1637 1638 static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) { 1639 const Target *TheTarget = getTarget(Obj); 1640 1641 // Package up features to be passed to target/subtarget 1642 SubtargetFeatures Features = Obj->getFeatures(); 1643 if (!MAttrs.empty()) 1644 for (unsigned I = 0; I != MAttrs.size(); ++I) 1645 Features.AddFeature(MAttrs[I]); 1646 1647 std::unique_ptr<const MCRegisterInfo> MRI( 1648 TheTarget->createMCRegInfo(TripleName)); 1649 if (!MRI) 1650 reportError(Obj->getFileName(), 1651 "no register info for target " + TripleName); 1652 1653 // Set up disassembler. 1654 MCTargetOptions MCOptions; 1655 std::unique_ptr<const MCAsmInfo> AsmInfo( 1656 TheTarget->createMCAsmInfo(*MRI, TripleName, MCOptions)); 1657 if (!AsmInfo) 1658 reportError(Obj->getFileName(), 1659 "no assembly info for target " + TripleName); 1660 std::unique_ptr<const MCSubtargetInfo> STI( 1661 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString())); 1662 if (!STI) 1663 reportError(Obj->getFileName(), 1664 "no subtarget info for target " + TripleName); 1665 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo()); 1666 if (!MII) 1667 reportError(Obj->getFileName(), 1668 "no instruction info for target " + TripleName); 1669 MCObjectFileInfo MOFI; 1670 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI); 1671 // FIXME: for now initialize MCObjectFileInfo with default values 1672 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx); 1673 1674 std::unique_ptr<MCDisassembler> DisAsm( 1675 TheTarget->createMCDisassembler(*STI, Ctx)); 1676 if (!DisAsm) 1677 reportError(Obj->getFileName(), "no disassembler for target " + TripleName); 1678 1679 // If we have an ARM object file, we need a second disassembler, because 1680 // ARM CPUs have two different instruction sets: ARM mode, and Thumb mode. 1681 // We use mapping symbols to switch between the two assemblers, where 1682 // appropriate. 1683 std::unique_ptr<MCDisassembler> SecondaryDisAsm; 1684 std::unique_ptr<const MCSubtargetInfo> SecondarySTI; 1685 if (isArmElf(Obj) && !STI->checkFeatures("+mclass")) { 1686 if (STI->checkFeatures("+thumb-mode")) 1687 Features.AddFeature("-thumb-mode"); 1688 else 1689 Features.AddFeature("+thumb-mode"); 1690 SecondarySTI.reset(TheTarget->createMCSubtargetInfo(TripleName, MCPU, 1691 Features.getString())); 1692 SecondaryDisAsm.reset(TheTarget->createMCDisassembler(*SecondarySTI, Ctx)); 1693 } 1694 1695 std::unique_ptr<const MCInstrAnalysis> MIA( 1696 TheTarget->createMCInstrAnalysis(MII.get())); 1697 1698 int AsmPrinterVariant = AsmInfo->getAssemblerDialect(); 1699 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter( 1700 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI)); 1701 if (!IP) 1702 reportError(Obj->getFileName(), 1703 "no instruction printer for target " + TripleName); 1704 IP->setPrintImmHex(PrintImmHex); 1705 IP->setPrintBranchImmAsAddress(true); 1706 1707 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName)); 1708 SourcePrinter SP(Obj, TheTarget->getName()); 1709 1710 for (StringRef Opt : DisassemblerOptions) 1711 if (!IP->applyTargetSpecificCLOption(Opt)) 1712 reportError(Obj->getFileName(), 1713 "Unrecognized disassembler option: " + Opt); 1714 1715 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), SecondaryDisAsm.get(), 1716 MIA.get(), IP.get(), STI.get(), SecondarySTI.get(), PIP, 1717 SP, InlineRelocs); 1718 } 1719 1720 void objdump::printRelocations(const ObjectFile *Obj) { 1721 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : 1722 "%08" PRIx64; 1723 // Regular objdump doesn't print relocations in non-relocatable object 1724 // files. 1725 if (!Obj->isRelocatableObject()) 1726 return; 1727 1728 // Build a mapping from relocation target to a vector of relocation 1729 // sections. Usually, there is an only one relocation section for 1730 // each relocated section. 1731 MapVector<SectionRef, std::vector<SectionRef>> SecToRelSec; 1732 uint64_t Ndx; 1733 for (const SectionRef &Section : ToolSectionFilter(*Obj, &Ndx)) { 1734 if (Section.relocation_begin() == Section.relocation_end()) 1735 continue; 1736 Expected<section_iterator> SecOrErr = Section.getRelocatedSection(); 1737 if (!SecOrErr) 1738 reportError(Obj->getFileName(), 1739 "section (" + Twine(Ndx) + 1740 "): unable to get a relocation target: " + 1741 toString(SecOrErr.takeError())); 1742 SecToRelSec[**SecOrErr].push_back(Section); 1743 } 1744 1745 for (std::pair<SectionRef, std::vector<SectionRef>> &P : SecToRelSec) { 1746 StringRef SecName = unwrapOrError(P.first.getName(), Obj->getFileName()); 1747 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n"; 1748 uint32_t OffsetPadding = (Obj->getBytesInAddress() > 4 ? 16 : 8); 1749 uint32_t TypePadding = 24; 1750 outs() << left_justify("OFFSET", OffsetPadding) << " " 1751 << left_justify("TYPE", TypePadding) << " " 1752 << "VALUE\n"; 1753 1754 for (SectionRef Section : P.second) { 1755 for (const RelocationRef &Reloc : Section.relocations()) { 1756 uint64_t Address = Reloc.getOffset(); 1757 SmallString<32> RelocName; 1758 SmallString<32> ValueStr; 1759 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc)) 1760 continue; 1761 Reloc.getTypeName(RelocName); 1762 if (Error E = getRelocationValueString(Reloc, ValueStr)) 1763 reportError(std::move(E), Obj->getFileName()); 1764 1765 outs() << format(Fmt.data(), Address) << " " 1766 << left_justify(RelocName, TypePadding) << " " << ValueStr 1767 << "\n"; 1768 } 1769 } 1770 outs() << "\n"; 1771 } 1772 } 1773 1774 void objdump::printDynamicRelocations(const ObjectFile *Obj) { 1775 // For the moment, this option is for ELF only 1776 if (!Obj->isELF()) 1777 return; 1778 1779 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj); 1780 if (!Elf || Elf->getEType() != ELF::ET_DYN) { 1781 reportError(Obj->getFileName(), "not a dynamic object"); 1782 return; 1783 } 1784 1785 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections(); 1786 if (DynRelSec.empty()) 1787 return; 1788 1789 outs() << "DYNAMIC RELOCATION RECORDS\n"; 1790 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64; 1791 for (const SectionRef &Section : DynRelSec) 1792 for (const RelocationRef &Reloc : Section.relocations()) { 1793 uint64_t Address = Reloc.getOffset(); 1794 SmallString<32> RelocName; 1795 SmallString<32> ValueStr; 1796 Reloc.getTypeName(RelocName); 1797 if (Error E = getRelocationValueString(Reloc, ValueStr)) 1798 reportError(std::move(E), Obj->getFileName()); 1799 outs() << format(Fmt.data(), Address) << " " << RelocName << " " 1800 << ValueStr << "\n"; 1801 } 1802 } 1803 1804 // Returns true if we need to show LMA column when dumping section headers. We 1805 // show it only when the platform is ELF and either we have at least one section 1806 // whose VMA and LMA are different and/or when --show-lma flag is used. 1807 static bool shouldDisplayLMA(const ObjectFile *Obj) { 1808 if (!Obj->isELF()) 1809 return false; 1810 for (const SectionRef &S : ToolSectionFilter(*Obj)) 1811 if (S.getAddress() != getELFSectionLMA(S)) 1812 return true; 1813 return ShowLMA; 1814 } 1815 1816 static size_t getMaxSectionNameWidth(const ObjectFile *Obj) { 1817 // Default column width for names is 13 even if no names are that long. 1818 size_t MaxWidth = 13; 1819 for (const SectionRef &Section : ToolSectionFilter(*Obj)) { 1820 StringRef Name = unwrapOrError(Section.getName(), Obj->getFileName()); 1821 MaxWidth = std::max(MaxWidth, Name.size()); 1822 } 1823 return MaxWidth; 1824 } 1825 1826 void objdump::printSectionHeaders(const ObjectFile *Obj) { 1827 size_t NameWidth = getMaxSectionNameWidth(Obj); 1828 size_t AddressWidth = 2 * Obj->getBytesInAddress(); 1829 bool HasLMAColumn = shouldDisplayLMA(Obj); 1830 if (HasLMAColumn) 1831 outs() << "Sections:\n" 1832 "Idx " 1833 << left_justify("Name", NameWidth) << " Size " 1834 << left_justify("VMA", AddressWidth) << " " 1835 << left_justify("LMA", AddressWidth) << " Type\n"; 1836 else 1837 outs() << "Sections:\n" 1838 "Idx " 1839 << left_justify("Name", NameWidth) << " Size " 1840 << left_justify("VMA", AddressWidth) << " Type\n"; 1841 1842 uint64_t Idx; 1843 for (const SectionRef &Section : ToolSectionFilter(*Obj, &Idx)) { 1844 StringRef Name = unwrapOrError(Section.getName(), Obj->getFileName()); 1845 uint64_t VMA = Section.getAddress(); 1846 if (shouldAdjustVA(Section)) 1847 VMA += AdjustVMA; 1848 1849 uint64_t Size = Section.getSize(); 1850 1851 std::string Type = Section.isText() ? "TEXT" : ""; 1852 if (Section.isData()) 1853 Type += Type.empty() ? "DATA" : " DATA"; 1854 if (Section.isBSS()) 1855 Type += Type.empty() ? "BSS" : " BSS"; 1856 1857 if (HasLMAColumn) 1858 outs() << format("%3" PRIu64 " %-*s %08" PRIx64 " ", Idx, NameWidth, 1859 Name.str().c_str(), Size) 1860 << format_hex_no_prefix(VMA, AddressWidth) << " " 1861 << format_hex_no_prefix(getELFSectionLMA(Section), AddressWidth) 1862 << " " << Type << "\n"; 1863 else 1864 outs() << format("%3" PRIu64 " %-*s %08" PRIx64 " ", Idx, NameWidth, 1865 Name.str().c_str(), Size) 1866 << format_hex_no_prefix(VMA, AddressWidth) << " " << Type << "\n"; 1867 } 1868 outs() << "\n"; 1869 } 1870 1871 void objdump::printSectionContents(const ObjectFile *Obj) { 1872 for (const SectionRef &Section : ToolSectionFilter(*Obj)) { 1873 StringRef Name = unwrapOrError(Section.getName(), Obj->getFileName()); 1874 uint64_t BaseAddr = Section.getAddress(); 1875 uint64_t Size = Section.getSize(); 1876 if (!Size) 1877 continue; 1878 1879 outs() << "Contents of section " << Name << ":\n"; 1880 if (Section.isBSS()) { 1881 outs() << format("<skipping contents of bss section at [%04" PRIx64 1882 ", %04" PRIx64 ")>\n", 1883 BaseAddr, BaseAddr + Size); 1884 continue; 1885 } 1886 1887 StringRef Contents = unwrapOrError(Section.getContents(), Obj->getFileName()); 1888 1889 // Dump out the content as hex and printable ascii characters. 1890 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) { 1891 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr); 1892 // Dump line of hex. 1893 for (std::size_t I = 0; I < 16; ++I) { 1894 if (I != 0 && I % 4 == 0) 1895 outs() << ' '; 1896 if (Addr + I < End) 1897 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true) 1898 << hexdigit(Contents[Addr + I] & 0xF, true); 1899 else 1900 outs() << " "; 1901 } 1902 // Print ascii. 1903 outs() << " "; 1904 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) { 1905 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF)) 1906 outs() << Contents[Addr + I]; 1907 else 1908 outs() << "."; 1909 } 1910 outs() << "\n"; 1911 } 1912 } 1913 } 1914 1915 void objdump::printSymbolTable(const ObjectFile *O, StringRef ArchiveName, 1916 StringRef ArchitectureName, bool DumpDynamic) { 1917 if (O->isCOFF() && !DumpDynamic) { 1918 outs() << "SYMBOL TABLE:\n"; 1919 printCOFFSymbolTable(cast<const COFFObjectFile>(O)); 1920 return; 1921 } 1922 1923 const StringRef FileName = O->getFileName(); 1924 1925 if (!DumpDynamic) { 1926 outs() << "SYMBOL TABLE:\n"; 1927 for (auto I = O->symbol_begin(); I != O->symbol_end(); ++I) 1928 printSymbol(O, *I, FileName, ArchiveName, ArchitectureName, DumpDynamic); 1929 return; 1930 } 1931 1932 outs() << "DYNAMIC SYMBOL TABLE:\n"; 1933 if (!O->isELF()) { 1934 reportWarning( 1935 "this operation is not currently supported for this file format", 1936 FileName); 1937 return; 1938 } 1939 1940 const ELFObjectFileBase *ELF = cast<const ELFObjectFileBase>(O); 1941 for (auto I = ELF->getDynamicSymbolIterators().begin(); 1942 I != ELF->getDynamicSymbolIterators().end(); ++I) 1943 printSymbol(O, *I, FileName, ArchiveName, ArchitectureName, DumpDynamic); 1944 } 1945 1946 void objdump::printSymbol(const ObjectFile *O, const SymbolRef &Symbol, 1947 StringRef FileName, StringRef ArchiveName, 1948 StringRef ArchitectureName, bool DumpDynamic) { 1949 const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(O); 1950 uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName, ArchiveName, 1951 ArchitectureName); 1952 if ((Address < StartAddress) || (Address > StopAddress)) 1953 return; 1954 SymbolRef::Type Type = 1955 unwrapOrError(Symbol.getType(), FileName, ArchiveName, ArchitectureName); 1956 uint32_t Flags = 1957 unwrapOrError(Symbol.getFlags(), FileName, ArchiveName, ArchitectureName); 1958 1959 // Don't ask a Mach-O STAB symbol for its section unless you know that 1960 // STAB symbol's section field refers to a valid section index. Otherwise 1961 // the symbol may error trying to load a section that does not exist. 1962 bool IsSTAB = false; 1963 if (MachO) { 1964 DataRefImpl SymDRI = Symbol.getRawDataRefImpl(); 1965 uint8_t NType = 1966 (MachO->is64Bit() ? MachO->getSymbol64TableEntry(SymDRI).n_type 1967 : MachO->getSymbolTableEntry(SymDRI).n_type); 1968 if (NType & MachO::N_STAB) 1969 IsSTAB = true; 1970 } 1971 section_iterator Section = IsSTAB 1972 ? O->section_end() 1973 : unwrapOrError(Symbol.getSection(), FileName, 1974 ArchiveName, ArchitectureName); 1975 1976 StringRef Name; 1977 if (Type == SymbolRef::ST_Debug && Section != O->section_end()) { 1978 if (Expected<StringRef> NameOrErr = Section->getName()) 1979 Name = *NameOrErr; 1980 else 1981 consumeError(NameOrErr.takeError()); 1982 1983 } else { 1984 Name = unwrapOrError(Symbol.getName(), FileName, ArchiveName, 1985 ArchitectureName); 1986 } 1987 1988 bool Global = Flags & SymbolRef::SF_Global; 1989 bool Weak = Flags & SymbolRef::SF_Weak; 1990 bool Absolute = Flags & SymbolRef::SF_Absolute; 1991 bool Common = Flags & SymbolRef::SF_Common; 1992 bool Hidden = Flags & SymbolRef::SF_Hidden; 1993 1994 char GlobLoc = ' '; 1995 if ((Section != O->section_end() || Absolute) && !Weak) 1996 GlobLoc = Global ? 'g' : 'l'; 1997 char IFunc = ' '; 1998 if (O->isELF()) { 1999 if (ELFSymbolRef(Symbol).getELFType() == ELF::STT_GNU_IFUNC) 2000 IFunc = 'i'; 2001 if (ELFSymbolRef(Symbol).getBinding() == ELF::STB_GNU_UNIQUE) 2002 GlobLoc = 'u'; 2003 } 2004 2005 char Debug = ' '; 2006 if (DumpDynamic) 2007 Debug = 'D'; 2008 else if (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File) 2009 Debug = 'd'; 2010 2011 char FileFunc = ' '; 2012 if (Type == SymbolRef::ST_File) 2013 FileFunc = 'f'; 2014 else if (Type == SymbolRef::ST_Function) 2015 FileFunc = 'F'; 2016 else if (Type == SymbolRef::ST_Data) 2017 FileFunc = 'O'; 2018 2019 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64; 2020 2021 outs() << format(Fmt, Address) << " " 2022 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' ' 2023 << (Weak ? 'w' : ' ') // Weak? 2024 << ' ' // Constructor. Not supported yet. 2025 << ' ' // Warning. Not supported yet. 2026 << IFunc // Indirect reference to another symbol. 2027 << Debug // Debugging (d) or dynamic (D) symbol. 2028 << FileFunc // Name of function (F), file (f) or object (O). 2029 << ' '; 2030 if (Absolute) { 2031 outs() << "*ABS*"; 2032 } else if (Common) { 2033 outs() << "*COM*"; 2034 } else if (Section == O->section_end()) { 2035 outs() << "*UND*"; 2036 } else { 2037 if (MachO) { 2038 DataRefImpl DR = Section->getRawDataRefImpl(); 2039 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR); 2040 outs() << SegmentName << ","; 2041 } 2042 StringRef SectionName = unwrapOrError(Section->getName(), FileName); 2043 outs() << SectionName; 2044 } 2045 2046 if (Common || O->isELF()) { 2047 uint64_t Val = 2048 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize(); 2049 outs() << '\t' << format(Fmt, Val); 2050 } 2051 2052 if (O->isELF()) { 2053 uint8_t Other = ELFSymbolRef(Symbol).getOther(); 2054 switch (Other) { 2055 case ELF::STV_DEFAULT: 2056 break; 2057 case ELF::STV_INTERNAL: 2058 outs() << " .internal"; 2059 break; 2060 case ELF::STV_HIDDEN: 2061 outs() << " .hidden"; 2062 break; 2063 case ELF::STV_PROTECTED: 2064 outs() << " .protected"; 2065 break; 2066 default: 2067 outs() << format(" 0x%02x", Other); 2068 break; 2069 } 2070 } else if (Hidden) { 2071 outs() << " .hidden"; 2072 } 2073 2074 if (Demangle) 2075 outs() << ' ' << demangle(std::string(Name)) << '\n'; 2076 else 2077 outs() << ' ' << Name << '\n'; 2078 } 2079 2080 static void printUnwindInfo(const ObjectFile *O) { 2081 outs() << "Unwind info:\n\n"; 2082 2083 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O)) 2084 printCOFFUnwindInfo(Coff); 2085 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O)) 2086 printMachOUnwindInfo(MachO); 2087 else 2088 // TODO: Extract DWARF dump tool to objdump. 2089 WithColor::error(errs(), ToolName) 2090 << "This operation is only currently supported " 2091 "for COFF and MachO object files.\n"; 2092 } 2093 2094 /// Dump the raw contents of the __clangast section so the output can be piped 2095 /// into llvm-bcanalyzer. 2096 static void printRawClangAST(const ObjectFile *Obj) { 2097 if (outs().is_displayed()) { 2098 WithColor::error(errs(), ToolName) 2099 << "The -raw-clang-ast option will dump the raw binary contents of " 2100 "the clang ast section.\n" 2101 "Please redirect the output to a file or another program such as " 2102 "llvm-bcanalyzer.\n"; 2103 return; 2104 } 2105 2106 StringRef ClangASTSectionName("__clangast"); 2107 if (Obj->isCOFF()) { 2108 ClangASTSectionName = "clangast"; 2109 } 2110 2111 Optional<object::SectionRef> ClangASTSection; 2112 for (auto Sec : ToolSectionFilter(*Obj)) { 2113 StringRef Name; 2114 if (Expected<StringRef> NameOrErr = Sec.getName()) 2115 Name = *NameOrErr; 2116 else 2117 consumeError(NameOrErr.takeError()); 2118 2119 if (Name == ClangASTSectionName) { 2120 ClangASTSection = Sec; 2121 break; 2122 } 2123 } 2124 if (!ClangASTSection) 2125 return; 2126 2127 StringRef ClangASTContents = unwrapOrError( 2128 ClangASTSection.getValue().getContents(), Obj->getFileName()); 2129 outs().write(ClangASTContents.data(), ClangASTContents.size()); 2130 } 2131 2132 static void printFaultMaps(const ObjectFile *Obj) { 2133 StringRef FaultMapSectionName; 2134 2135 if (Obj->isELF()) { 2136 FaultMapSectionName = ".llvm_faultmaps"; 2137 } else if (Obj->isMachO()) { 2138 FaultMapSectionName = "__llvm_faultmaps"; 2139 } else { 2140 WithColor::error(errs(), ToolName) 2141 << "This operation is only currently supported " 2142 "for ELF and Mach-O executable files.\n"; 2143 return; 2144 } 2145 2146 Optional<object::SectionRef> FaultMapSection; 2147 2148 for (auto Sec : ToolSectionFilter(*Obj)) { 2149 StringRef Name; 2150 if (Expected<StringRef> NameOrErr = Sec.getName()) 2151 Name = *NameOrErr; 2152 else 2153 consumeError(NameOrErr.takeError()); 2154 2155 if (Name == FaultMapSectionName) { 2156 FaultMapSection = Sec; 2157 break; 2158 } 2159 } 2160 2161 outs() << "FaultMap table:\n"; 2162 2163 if (!FaultMapSection.hasValue()) { 2164 outs() << "<not found>\n"; 2165 return; 2166 } 2167 2168 StringRef FaultMapContents = 2169 unwrapOrError(FaultMapSection.getValue().getContents(), Obj->getFileName()); 2170 FaultMapParser FMP(FaultMapContents.bytes_begin(), 2171 FaultMapContents.bytes_end()); 2172 2173 outs() << FMP; 2174 } 2175 2176 static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) { 2177 if (O->isELF()) { 2178 printELFFileHeader(O); 2179 printELFDynamicSection(O); 2180 printELFSymbolVersionInfo(O); 2181 return; 2182 } 2183 if (O->isCOFF()) 2184 return printCOFFFileHeader(O); 2185 if (O->isWasm()) 2186 return printWasmFileHeader(O); 2187 if (O->isMachO()) { 2188 printMachOFileHeader(O); 2189 if (!OnlyFirst) 2190 printMachOLoadCommands(O); 2191 return; 2192 } 2193 reportError(O->getFileName(), "Invalid/Unsupported object file format"); 2194 } 2195 2196 static void printFileHeaders(const ObjectFile *O) { 2197 if (!O->isELF() && !O->isCOFF()) 2198 reportError(O->getFileName(), "Invalid/Unsupported object file format"); 2199 2200 Triple::ArchType AT = O->getArch(); 2201 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n"; 2202 uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName()); 2203 2204 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64; 2205 outs() << "start address: " 2206 << "0x" << format(Fmt.data(), Address) << "\n\n"; 2207 } 2208 2209 static void printArchiveChild(StringRef Filename, const Archive::Child &C) { 2210 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode(); 2211 if (!ModeOrErr) { 2212 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n"; 2213 consumeError(ModeOrErr.takeError()); 2214 return; 2215 } 2216 sys::fs::perms Mode = ModeOrErr.get(); 2217 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-"); 2218 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-"); 2219 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-"); 2220 outs() << ((Mode & sys::fs::group_read) ? "r" : "-"); 2221 outs() << ((Mode & sys::fs::group_write) ? "w" : "-"); 2222 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-"); 2223 outs() << ((Mode & sys::fs::others_read) ? "r" : "-"); 2224 outs() << ((Mode & sys::fs::others_write) ? "w" : "-"); 2225 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-"); 2226 2227 outs() << " "; 2228 2229 outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename), 2230 unwrapOrError(C.getGID(), Filename), 2231 unwrapOrError(C.getRawSize(), Filename)); 2232 2233 StringRef RawLastModified = C.getRawLastModified(); 2234 unsigned Seconds; 2235 if (RawLastModified.getAsInteger(10, Seconds)) 2236 outs() << "(date: \"" << RawLastModified 2237 << "\" contains non-decimal chars) "; 2238 else { 2239 // Since ctime(3) returns a 26 character string of the form: 2240 // "Sun Sep 16 01:03:52 1973\n\0" 2241 // just print 24 characters. 2242 time_t t = Seconds; 2243 outs() << format("%.24s ", ctime(&t)); 2244 } 2245 2246 StringRef Name = ""; 2247 Expected<StringRef> NameOrErr = C.getName(); 2248 if (!NameOrErr) { 2249 consumeError(NameOrErr.takeError()); 2250 Name = unwrapOrError(C.getRawName(), Filename); 2251 } else { 2252 Name = NameOrErr.get(); 2253 } 2254 outs() << Name << "\n"; 2255 } 2256 2257 // For ELF only now. 2258 static bool shouldWarnForInvalidStartStopAddress(ObjectFile *Obj) { 2259 if (const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj)) { 2260 if (Elf->getEType() != ELF::ET_REL) 2261 return true; 2262 } 2263 return false; 2264 } 2265 2266 static void checkForInvalidStartStopAddress(ObjectFile *Obj, 2267 uint64_t Start, uint64_t Stop) { 2268 if (!shouldWarnForInvalidStartStopAddress(Obj)) 2269 return; 2270 2271 for (const SectionRef &Section : Obj->sections()) 2272 if (ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC) { 2273 uint64_t BaseAddr = Section.getAddress(); 2274 uint64_t Size = Section.getSize(); 2275 if ((Start < BaseAddr + Size) && Stop > BaseAddr) 2276 return; 2277 } 2278 2279 if (StartAddress.getNumOccurrences() == 0) 2280 reportWarning("no section has address less than 0x" + 2281 Twine::utohexstr(Stop) + " specified by --stop-address", 2282 Obj->getFileName()); 2283 else if (StopAddress.getNumOccurrences() == 0) 2284 reportWarning("no section has address greater than or equal to 0x" + 2285 Twine::utohexstr(Start) + " specified by --start-address", 2286 Obj->getFileName()); 2287 else 2288 reportWarning("no section overlaps the range [0x" + 2289 Twine::utohexstr(Start) + ",0x" + Twine::utohexstr(Stop) + 2290 ") specified by --start-address/--stop-address", 2291 Obj->getFileName()); 2292 } 2293 2294 static void dumpObject(ObjectFile *O, const Archive *A = nullptr, 2295 const Archive::Child *C = nullptr) { 2296 // Avoid other output when using a raw option. 2297 if (!RawClangAST) { 2298 outs() << '\n'; 2299 if (A) 2300 outs() << A->getFileName() << "(" << O->getFileName() << ")"; 2301 else 2302 outs() << O->getFileName(); 2303 outs() << ":\tfile format " << O->getFileFormatName().lower() << "\n\n"; 2304 } 2305 2306 if (StartAddress.getNumOccurrences() || StopAddress.getNumOccurrences()) 2307 checkForInvalidStartStopAddress(O, StartAddress, StopAddress); 2308 2309 // Note: the order here matches GNU objdump for compatability. 2310 StringRef ArchiveName = A ? A->getFileName() : ""; 2311 if (ArchiveHeaders && !MachOOpt && C) 2312 printArchiveChild(ArchiveName, *C); 2313 if (FileHeaders) 2314 printFileHeaders(O); 2315 if (PrivateHeaders || FirstPrivateHeader) 2316 printPrivateFileHeaders(O, FirstPrivateHeader); 2317 if (SectionHeaders) 2318 printSectionHeaders(O); 2319 if (SymbolTable) 2320 printSymbolTable(O, ArchiveName); 2321 if (DynamicSymbolTable) 2322 printSymbolTable(O, ArchiveName, /*ArchitectureName=*/"", 2323 /*DumpDynamic=*/true); 2324 if (DwarfDumpType != DIDT_Null) { 2325 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O); 2326 // Dump the complete DWARF structure. 2327 DIDumpOptions DumpOpts; 2328 DumpOpts.DumpType = DwarfDumpType; 2329 DICtx->dump(outs(), DumpOpts); 2330 } 2331 if (Relocations && !Disassemble) 2332 printRelocations(O); 2333 if (DynamicRelocations) 2334 printDynamicRelocations(O); 2335 if (SectionContents) 2336 printSectionContents(O); 2337 if (Disassemble) 2338 disassembleObject(O, Relocations); 2339 if (UnwindInfo) 2340 printUnwindInfo(O); 2341 2342 // Mach-O specific options: 2343 if (ExportsTrie) 2344 printExportsTrie(O); 2345 if (Rebase) 2346 printRebaseTable(O); 2347 if (Bind) 2348 printBindTable(O); 2349 if (LazyBind) 2350 printLazyBindTable(O); 2351 if (WeakBind) 2352 printWeakBindTable(O); 2353 2354 // Other special sections: 2355 if (RawClangAST) 2356 printRawClangAST(O); 2357 if (FaultMapSection) 2358 printFaultMaps(O); 2359 } 2360 2361 static void dumpObject(const COFFImportFile *I, const Archive *A, 2362 const Archive::Child *C = nullptr) { 2363 StringRef ArchiveName = A ? A->getFileName() : ""; 2364 2365 // Avoid other output when using a raw option. 2366 if (!RawClangAST) 2367 outs() << '\n' 2368 << ArchiveName << "(" << I->getFileName() << ")" 2369 << ":\tfile format COFF-import-file" 2370 << "\n\n"; 2371 2372 if (ArchiveHeaders && !MachOOpt && C) 2373 printArchiveChild(ArchiveName, *C); 2374 if (SymbolTable) 2375 printCOFFSymbolTable(I); 2376 } 2377 2378 /// Dump each object file in \a a; 2379 static void dumpArchive(const Archive *A) { 2380 Error Err = Error::success(); 2381 unsigned I = -1; 2382 for (auto &C : A->children(Err)) { 2383 ++I; 2384 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary(); 2385 if (!ChildOrErr) { 2386 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) 2387 reportError(std::move(E), getFileNameForError(C, I), A->getFileName()); 2388 continue; 2389 } 2390 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get())) 2391 dumpObject(O, A, &C); 2392 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get())) 2393 dumpObject(I, A, &C); 2394 else 2395 reportError(errorCodeToError(object_error::invalid_file_type), 2396 A->getFileName()); 2397 } 2398 if (Err) 2399 reportError(std::move(Err), A->getFileName()); 2400 } 2401 2402 /// Open file and figure out how to dump it. 2403 static void dumpInput(StringRef file) { 2404 // If we are using the Mach-O specific object file parser, then let it parse 2405 // the file and process the command line options. So the -arch flags can 2406 // be used to select specific slices, etc. 2407 if (MachOOpt) { 2408 parseInputMachO(file); 2409 return; 2410 } 2411 2412 // Attempt to open the binary. 2413 OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file); 2414 Binary &Binary = *OBinary.getBinary(); 2415 2416 if (Archive *A = dyn_cast<Archive>(&Binary)) 2417 dumpArchive(A); 2418 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary)) 2419 dumpObject(O); 2420 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary)) 2421 parseInputMachO(UB); 2422 else 2423 reportError(errorCodeToError(object_error::invalid_file_type), file); 2424 } 2425 2426 int main(int argc, char **argv) { 2427 using namespace llvm; 2428 InitLLVM X(argc, argv); 2429 const cl::OptionCategory *OptionFilters[] = {&ObjdumpCat, &MachOCat}; 2430 cl::HideUnrelatedOptions(OptionFilters); 2431 2432 // Initialize targets and assembly printers/parsers. 2433 InitializeAllTargetInfos(); 2434 InitializeAllTargetMCs(); 2435 InitializeAllDisassemblers(); 2436 2437 // Register the target printer for --version. 2438 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion); 2439 2440 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n", nullptr, 2441 /*EnvVar=*/nullptr, 2442 /*LongOptionsUseDoubleDash=*/true); 2443 2444 if (StartAddress >= StopAddress) 2445 reportCmdLineError("start address should be less than stop address"); 2446 2447 ToolName = argv[0]; 2448 2449 // Defaults to a.out if no filenames specified. 2450 if (InputFilenames.empty()) 2451 InputFilenames.push_back("a.out"); 2452 2453 if (AllHeaders) 2454 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations = 2455 SectionHeaders = SymbolTable = true; 2456 2457 if (DisassembleAll || PrintSource || PrintLines || 2458 !DisassembleSymbols.empty()) 2459 Disassemble = true; 2460 2461 if (!ArchiveHeaders && !Disassemble && DwarfDumpType == DIDT_Null && 2462 !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST && 2463 !Relocations && !SectionHeaders && !SectionContents && !SymbolTable && 2464 !DynamicSymbolTable && !UnwindInfo && !FaultMapSection && 2465 !(MachOOpt && 2466 (Bind || DataInCode || DylibId || DylibsUsed || ExportsTrie || 2467 FirstPrivateHeader || IndirectSymbols || InfoPlist || LazyBind || 2468 LinkOptHints || ObjcMetaData || Rebase || UniversalHeaders || 2469 WeakBind || !FilterSections.empty()))) { 2470 cl::PrintHelpMessage(); 2471 return 2; 2472 } 2473 2474 DisasmSymbolSet.insert(DisassembleSymbols.begin(), DisassembleSymbols.end()); 2475 2476 llvm::for_each(InputFilenames, dumpInput); 2477 2478 warnOnNoMatchForSections(); 2479 2480 return EXIT_SUCCESS; 2481 } 2482