109467b48Spatrick //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
209467b48Spatrick //
309467b48Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
409467b48Spatrick // See https://llvm.org/LICENSE.txt for license information.
509467b48Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
609467b48Spatrick //
709467b48Spatrick //===----------------------------------------------------------------------===//
809467b48Spatrick //
909467b48Spatrick // This program is a utility that works like binutils "objdump", that is, it
1009467b48Spatrick // dumps out a plethora of information about an object file depending on the
1109467b48Spatrick // flags.
1209467b48Spatrick //
1309467b48Spatrick // The flags and output of this program should be near identical to those of
1409467b48Spatrick // binutils objdump.
1509467b48Spatrick //
1609467b48Spatrick //===----------------------------------------------------------------------===//
1709467b48Spatrick
1809467b48Spatrick #include "llvm-objdump.h"
19097a140dSpatrick #include "COFFDump.h"
20097a140dSpatrick #include "ELFDump.h"
21097a140dSpatrick #include "MachODump.h"
2273471bf0Spatrick #include "ObjdumpOptID.h"
23*d415bd75Srobert #include "OffloadDump.h"
2473471bf0Spatrick #include "SourcePrinter.h"
25097a140dSpatrick #include "WasmDump.h"
26097a140dSpatrick #include "XCOFFDump.h"
27097a140dSpatrick #include "llvm/ADT/IndexedMap.h"
2809467b48Spatrick #include "llvm/ADT/STLExtras.h"
2909467b48Spatrick #include "llvm/ADT/SetOperations.h"
3073471bf0Spatrick #include "llvm/ADT/SmallSet.h"
3109467b48Spatrick #include "llvm/ADT/StringExtras.h"
3209467b48Spatrick #include "llvm/ADT/StringSet.h"
3309467b48Spatrick #include "llvm/ADT/Triple.h"
3473471bf0Spatrick #include "llvm/ADT/Twine.h"
3509467b48Spatrick #include "llvm/DebugInfo/DWARF/DWARFContext.h"
36*d415bd75Srobert #include "llvm/DebugInfo/Symbolize/SymbolizableModule.h"
3709467b48Spatrick #include "llvm/DebugInfo/Symbolize/Symbolize.h"
38*d415bd75Srobert #include "llvm/Debuginfod/BuildIDFetcher.h"
39*d415bd75Srobert #include "llvm/Debuginfod/Debuginfod.h"
40*d415bd75Srobert #include "llvm/Debuginfod/HTTPClient.h"
4109467b48Spatrick #include "llvm/Demangle/Demangle.h"
4209467b48Spatrick #include "llvm/MC/MCAsmInfo.h"
4309467b48Spatrick #include "llvm/MC/MCContext.h"
4409467b48Spatrick #include "llvm/MC/MCDisassembler/MCDisassembler.h"
4509467b48Spatrick #include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
4609467b48Spatrick #include "llvm/MC/MCInst.h"
4709467b48Spatrick #include "llvm/MC/MCInstPrinter.h"
4809467b48Spatrick #include "llvm/MC/MCInstrAnalysis.h"
4909467b48Spatrick #include "llvm/MC/MCInstrInfo.h"
5009467b48Spatrick #include "llvm/MC/MCObjectFileInfo.h"
5109467b48Spatrick #include "llvm/MC/MCRegisterInfo.h"
5209467b48Spatrick #include "llvm/MC/MCSubtargetInfo.h"
5309467b48Spatrick #include "llvm/MC/MCTargetOptions.h"
54*d415bd75Srobert #include "llvm/MC/TargetRegistry.h"
5509467b48Spatrick #include "llvm/Object/Archive.h"
56*d415bd75Srobert #include "llvm/Object/BuildID.h"
5709467b48Spatrick #include "llvm/Object/COFF.h"
5809467b48Spatrick #include "llvm/Object/COFFImportFile.h"
5909467b48Spatrick #include "llvm/Object/ELFObjectFile.h"
60*d415bd75Srobert #include "llvm/Object/ELFTypes.h"
6173471bf0Spatrick #include "llvm/Object/FaultMapParser.h"
6209467b48Spatrick #include "llvm/Object/MachO.h"
6309467b48Spatrick #include "llvm/Object/MachOUniversal.h"
6409467b48Spatrick #include "llvm/Object/ObjectFile.h"
65*d415bd75Srobert #include "llvm/Object/OffloadBinary.h"
6609467b48Spatrick #include "llvm/Object/Wasm.h"
6773471bf0Spatrick #include "llvm/Option/Arg.h"
6873471bf0Spatrick #include "llvm/Option/ArgList.h"
6973471bf0Spatrick #include "llvm/Option/Option.h"
7009467b48Spatrick #include "llvm/Support/Casting.h"
7109467b48Spatrick #include "llvm/Support/Debug.h"
7209467b48Spatrick #include "llvm/Support/Errc.h"
7309467b48Spatrick #include "llvm/Support/FileSystem.h"
7409467b48Spatrick #include "llvm/Support/Format.h"
7509467b48Spatrick #include "llvm/Support/FormatVariadic.h"
7609467b48Spatrick #include "llvm/Support/GraphWriter.h"
7709467b48Spatrick #include "llvm/Support/Host.h"
7809467b48Spatrick #include "llvm/Support/InitLLVM.h"
7909467b48Spatrick #include "llvm/Support/MemoryBuffer.h"
8009467b48Spatrick #include "llvm/Support/SourceMgr.h"
8109467b48Spatrick #include "llvm/Support/StringSaver.h"
8209467b48Spatrick #include "llvm/Support/TargetSelect.h"
8309467b48Spatrick #include "llvm/Support/WithColor.h"
8409467b48Spatrick #include "llvm/Support/raw_ostream.h"
8509467b48Spatrick #include <algorithm>
8609467b48Spatrick #include <cctype>
8709467b48Spatrick #include <cstring>
88*d415bd75Srobert #include <optional>
8909467b48Spatrick #include <system_error>
9009467b48Spatrick #include <unordered_map>
9109467b48Spatrick #include <utility>
9209467b48Spatrick
93097a140dSpatrick using namespace llvm;
9409467b48Spatrick using namespace llvm::object;
95097a140dSpatrick using namespace llvm::objdump;
9673471bf0Spatrick using namespace llvm::opt;
9773471bf0Spatrick
9873471bf0Spatrick namespace {
9973471bf0Spatrick
100*d415bd75Srobert class CommonOptTable : public opt::GenericOptTable {
10173471bf0Spatrick public:
CommonOptTable(ArrayRef<Info> OptionInfos,const char * Usage,const char * Description)10273471bf0Spatrick CommonOptTable(ArrayRef<Info> OptionInfos, const char *Usage,
10373471bf0Spatrick const char *Description)
104*d415bd75Srobert : opt::GenericOptTable(OptionInfos), Usage(Usage),
105*d415bd75Srobert Description(Description) {
10673471bf0Spatrick setGroupedShortOptions(true);
10773471bf0Spatrick }
10873471bf0Spatrick
printHelp(StringRef Argv0,bool ShowHidden=false) const10973471bf0Spatrick void printHelp(StringRef Argv0, bool ShowHidden = false) const {
11073471bf0Spatrick Argv0 = sys::path::filename(Argv0);
111*d415bd75Srobert opt::GenericOptTable::printHelp(outs(), (Argv0 + Usage).str().c_str(),
112*d415bd75Srobert Description, ShowHidden, ShowHidden);
11373471bf0Spatrick // TODO Replace this with OptTable API once it adds extrahelp support.
11473471bf0Spatrick outs() << "\nPass @FILE as argument to read options from FILE.\n";
11573471bf0Spatrick }
11673471bf0Spatrick
11773471bf0Spatrick private:
11873471bf0Spatrick const char *Usage;
11973471bf0Spatrick const char *Description;
12073471bf0Spatrick };
12173471bf0Spatrick
12273471bf0Spatrick // ObjdumpOptID is in ObjdumpOptID.h
123*d415bd75Srobert namespace objdump_opt {
124*d415bd75Srobert #define PREFIX(NAME, VALUE) \
125*d415bd75Srobert static constexpr StringLiteral NAME##_init[] = VALUE; \
126*d415bd75Srobert static constexpr ArrayRef<StringLiteral> NAME(NAME##_init, \
127*d415bd75Srobert std::size(NAME##_init) - 1);
12873471bf0Spatrick #include "ObjdumpOpts.inc"
12973471bf0Spatrick #undef PREFIX
13073471bf0Spatrick
13173471bf0Spatrick static constexpr opt::OptTable::Info ObjdumpInfoTable[] = {
13273471bf0Spatrick #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
13373471bf0Spatrick HELPTEXT, METAVAR, VALUES) \
134*d415bd75Srobert {PREFIX, NAME, HELPTEXT, \
13573471bf0Spatrick METAVAR, OBJDUMP_##ID, opt::Option::KIND##Class, \
13673471bf0Spatrick PARAM, FLAGS, OBJDUMP_##GROUP, \
13773471bf0Spatrick OBJDUMP_##ALIAS, ALIASARGS, VALUES},
13873471bf0Spatrick #include "ObjdumpOpts.inc"
13973471bf0Spatrick #undef OPTION
14073471bf0Spatrick };
141*d415bd75Srobert } // namespace objdump_opt
14273471bf0Spatrick
14373471bf0Spatrick class ObjdumpOptTable : public CommonOptTable {
14473471bf0Spatrick public:
ObjdumpOptTable()14573471bf0Spatrick ObjdumpOptTable()
146*d415bd75Srobert : CommonOptTable(objdump_opt::ObjdumpInfoTable,
147*d415bd75Srobert " [options] <input object files>",
14873471bf0Spatrick "llvm object file dumper") {}
14973471bf0Spatrick };
15073471bf0Spatrick
15173471bf0Spatrick enum OtoolOptID {
15273471bf0Spatrick OTOOL_INVALID = 0, // This is not an option ID.
15373471bf0Spatrick #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
15473471bf0Spatrick HELPTEXT, METAVAR, VALUES) \
15573471bf0Spatrick OTOOL_##ID,
15673471bf0Spatrick #include "OtoolOpts.inc"
15773471bf0Spatrick #undef OPTION
15873471bf0Spatrick };
15973471bf0Spatrick
160*d415bd75Srobert namespace otool {
161*d415bd75Srobert #define PREFIX(NAME, VALUE) \
162*d415bd75Srobert static constexpr StringLiteral NAME##_init[] = VALUE; \
163*d415bd75Srobert static constexpr ArrayRef<StringLiteral> NAME(NAME##_init, \
164*d415bd75Srobert std::size(NAME##_init) - 1);
16573471bf0Spatrick #include "OtoolOpts.inc"
16673471bf0Spatrick #undef PREFIX
16773471bf0Spatrick
16873471bf0Spatrick static constexpr opt::OptTable::Info OtoolInfoTable[] = {
16973471bf0Spatrick #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
17073471bf0Spatrick HELPTEXT, METAVAR, VALUES) \
171*d415bd75Srobert {PREFIX, NAME, HELPTEXT, \
17273471bf0Spatrick METAVAR, OTOOL_##ID, opt::Option::KIND##Class, \
17373471bf0Spatrick PARAM, FLAGS, OTOOL_##GROUP, \
17473471bf0Spatrick OTOOL_##ALIAS, ALIASARGS, VALUES},
17573471bf0Spatrick #include "OtoolOpts.inc"
17673471bf0Spatrick #undef OPTION
17773471bf0Spatrick };
178*d415bd75Srobert } // namespace otool
17973471bf0Spatrick
18073471bf0Spatrick class OtoolOptTable : public CommonOptTable {
18173471bf0Spatrick public:
OtoolOptTable()18273471bf0Spatrick OtoolOptTable()
183*d415bd75Srobert : CommonOptTable(otool::OtoolInfoTable, " [option...] [file...]",
18473471bf0Spatrick "Mach-O object file displaying tool") {}
18573471bf0Spatrick };
18673471bf0Spatrick
18773471bf0Spatrick } // namespace
18809467b48Spatrick
189097a140dSpatrick #define DEBUG_TYPE "objdump"
19009467b48Spatrick
19173471bf0Spatrick static uint64_t AdjustVMA;
19273471bf0Spatrick static bool AllHeaders;
19373471bf0Spatrick static std::string ArchName;
19473471bf0Spatrick bool objdump::ArchiveHeaders;
19573471bf0Spatrick bool objdump::Demangle;
19673471bf0Spatrick bool objdump::Disassemble;
19773471bf0Spatrick bool objdump::DisassembleAll;
19873471bf0Spatrick bool objdump::SymbolDescription;
19973471bf0Spatrick static std::vector<std::string> DisassembleSymbols;
20073471bf0Spatrick static bool DisassembleZeroes;
20173471bf0Spatrick static std::vector<std::string> DisassemblerOptions;
20273471bf0Spatrick DIDumpType objdump::DwarfDumpType;
20373471bf0Spatrick static bool DynamicRelocations;
20473471bf0Spatrick static bool FaultMapSection;
20573471bf0Spatrick static bool FileHeaders;
20673471bf0Spatrick bool objdump::SectionContents;
20773471bf0Spatrick static std::vector<std::string> InputFilenames;
20873471bf0Spatrick bool objdump::PrintLines;
20973471bf0Spatrick static bool MachOOpt;
21073471bf0Spatrick std::string objdump::MCPU;
21173471bf0Spatrick std::vector<std::string> objdump::MAttrs;
21273471bf0Spatrick bool objdump::ShowRawInsn;
21373471bf0Spatrick bool objdump::LeadingAddr;
214*d415bd75Srobert static bool Offloading;
21573471bf0Spatrick static bool RawClangAST;
21673471bf0Spatrick bool objdump::Relocations;
21773471bf0Spatrick bool objdump::PrintImmHex;
21873471bf0Spatrick bool objdump::PrivateHeaders;
21973471bf0Spatrick std::vector<std::string> objdump::FilterSections;
22073471bf0Spatrick bool objdump::SectionHeaders;
221*d415bd75Srobert static bool ShowAllSymbols;
22273471bf0Spatrick static bool ShowLMA;
22373471bf0Spatrick bool objdump::PrintSource;
22409467b48Spatrick
22573471bf0Spatrick static uint64_t StartAddress;
22673471bf0Spatrick static bool HasStartAddressFlag;
22773471bf0Spatrick static uint64_t StopAddress = UINT64_MAX;
22873471bf0Spatrick static bool HasStopAddressFlag;
22909467b48Spatrick
23073471bf0Spatrick bool objdump::SymbolTable;
23173471bf0Spatrick static bool SymbolizeOperands;
23273471bf0Spatrick static bool DynamicSymbolTable;
23373471bf0Spatrick std::string objdump::TripleName;
23473471bf0Spatrick bool objdump::UnwindInfo;
23573471bf0Spatrick static bool Wide;
23673471bf0Spatrick std::string objdump::Prefix;
23773471bf0Spatrick uint32_t objdump::PrefixStrip;
23809467b48Spatrick
23973471bf0Spatrick DebugVarsFormat objdump::DbgVariables = DVDisabled;
24009467b48Spatrick
24173471bf0Spatrick int objdump::DbgIndent = 52;
24209467b48Spatrick
243097a140dSpatrick static StringSet<> DisasmSymbolSet;
244097a140dSpatrick StringSet<> objdump::FoundSectionSet;
24509467b48Spatrick static StringRef ToolName;
24609467b48Spatrick
247*d415bd75Srobert std::unique_ptr<BuildIDFetcher> BIDFetcher;
248*d415bd75Srobert ExitOnError ExitOnErr;
249*d415bd75Srobert
25009467b48Spatrick namespace {
25109467b48Spatrick struct FilterResult {
25209467b48Spatrick // True if the section should not be skipped.
25309467b48Spatrick bool Keep;
25409467b48Spatrick
25509467b48Spatrick // True if the index counter should be incremented, even if the section should
25609467b48Spatrick // be skipped. For example, sections may be skipped if they are not included
25709467b48Spatrick // in the --section flag, but we still want those to count toward the section
25809467b48Spatrick // count.
25909467b48Spatrick bool IncrementIndex;
26009467b48Spatrick };
26109467b48Spatrick } // namespace
26209467b48Spatrick
checkSectionFilter(object::SectionRef S)26309467b48Spatrick static FilterResult checkSectionFilter(object::SectionRef S) {
26409467b48Spatrick if (FilterSections.empty())
26509467b48Spatrick return {/*Keep=*/true, /*IncrementIndex=*/true};
26609467b48Spatrick
26709467b48Spatrick Expected<StringRef> SecNameOrErr = S.getName();
26809467b48Spatrick if (!SecNameOrErr) {
26909467b48Spatrick consumeError(SecNameOrErr.takeError());
27009467b48Spatrick return {/*Keep=*/false, /*IncrementIndex=*/false};
27109467b48Spatrick }
27209467b48Spatrick StringRef SecName = *SecNameOrErr;
27309467b48Spatrick
27409467b48Spatrick // StringSet does not allow empty key so avoid adding sections with
27509467b48Spatrick // no name (such as the section with index 0) here.
27609467b48Spatrick if (!SecName.empty())
27709467b48Spatrick FoundSectionSet.insert(SecName);
27809467b48Spatrick
27909467b48Spatrick // Only show the section if it's in the FilterSections list, but always
28009467b48Spatrick // increment so the indexing is stable.
28109467b48Spatrick return {/*Keep=*/is_contained(FilterSections, SecName),
28209467b48Spatrick /*IncrementIndex=*/true};
28309467b48Spatrick }
28409467b48Spatrick
ToolSectionFilter(object::ObjectFile const & O,uint64_t * Idx)285097a140dSpatrick SectionFilter objdump::ToolSectionFilter(object::ObjectFile const &O,
286097a140dSpatrick uint64_t *Idx) {
28709467b48Spatrick // Start at UINT64_MAX so that the first index returned after an increment is
28809467b48Spatrick // zero (after the unsigned wrap).
28909467b48Spatrick if (Idx)
29009467b48Spatrick *Idx = UINT64_MAX;
29109467b48Spatrick return SectionFilter(
29209467b48Spatrick [Idx](object::SectionRef S) {
29309467b48Spatrick FilterResult Result = checkSectionFilter(S);
29409467b48Spatrick if (Idx != nullptr && Result.IncrementIndex)
29509467b48Spatrick *Idx += 1;
29609467b48Spatrick return Result.Keep;
29709467b48Spatrick },
29809467b48Spatrick O);
29909467b48Spatrick }
30009467b48Spatrick
getFileNameForError(const object::Archive::Child & C,unsigned Index)301097a140dSpatrick std::string objdump::getFileNameForError(const object::Archive::Child &C,
30209467b48Spatrick unsigned Index) {
30309467b48Spatrick Expected<StringRef> NameOrErr = C.getName();
30409467b48Spatrick if (NameOrErr)
305097a140dSpatrick return std::string(NameOrErr.get());
30609467b48Spatrick // If we have an error getting the name then we print the index of the archive
30709467b48Spatrick // member. Since we are already in an error state, we just ignore this error.
30809467b48Spatrick consumeError(NameOrErr.takeError());
30909467b48Spatrick return "<file index: " + std::to_string(Index) + ">";
31009467b48Spatrick }
31109467b48Spatrick
reportWarning(const Twine & Message,StringRef File)31273471bf0Spatrick void objdump::reportWarning(const Twine &Message, StringRef File) {
31309467b48Spatrick // Output order between errs() and outs() matters especially for archive
31409467b48Spatrick // files where the output is per member object.
31509467b48Spatrick outs().flush();
31609467b48Spatrick WithColor::warning(errs(), ToolName)
31709467b48Spatrick << "'" << File << "': " << Message << "\n";
31809467b48Spatrick }
31909467b48Spatrick
reportError(StringRef File,const Twine & Message)320*d415bd75Srobert [[noreturn]] void objdump::reportError(StringRef File, const Twine &Message) {
321097a140dSpatrick outs().flush();
32209467b48Spatrick WithColor::error(errs(), ToolName) << "'" << File << "': " << Message << "\n";
32309467b48Spatrick exit(1);
32409467b48Spatrick }
32509467b48Spatrick
reportError(Error E,StringRef FileName,StringRef ArchiveName,StringRef ArchitectureName)326*d415bd75Srobert [[noreturn]] void objdump::reportError(Error E, StringRef FileName,
32709467b48Spatrick StringRef ArchiveName,
32809467b48Spatrick StringRef ArchitectureName) {
32909467b48Spatrick assert(E);
330097a140dSpatrick outs().flush();
33109467b48Spatrick WithColor::error(errs(), ToolName);
33209467b48Spatrick if (ArchiveName != "")
33309467b48Spatrick errs() << ArchiveName << "(" << FileName << ")";
33409467b48Spatrick else
33509467b48Spatrick errs() << "'" << FileName << "'";
33609467b48Spatrick if (!ArchitectureName.empty())
33709467b48Spatrick errs() << " (for architecture " << ArchitectureName << ")";
338097a140dSpatrick errs() << ": ";
339097a140dSpatrick logAllUnhandledErrors(std::move(E), errs());
34009467b48Spatrick exit(1);
34109467b48Spatrick }
34209467b48Spatrick
reportCmdLineWarning(const Twine & Message)34373471bf0Spatrick static void reportCmdLineWarning(const Twine &Message) {
34409467b48Spatrick WithColor::warning(errs(), ToolName) << Message << "\n";
34509467b48Spatrick }
34609467b48Spatrick
reportCmdLineError(const Twine & Message)347*d415bd75Srobert [[noreturn]] static void reportCmdLineError(const Twine &Message) {
34809467b48Spatrick WithColor::error(errs(), ToolName) << Message << "\n";
34909467b48Spatrick exit(1);
35009467b48Spatrick }
35109467b48Spatrick
warnOnNoMatchForSections()35209467b48Spatrick static void warnOnNoMatchForSections() {
35309467b48Spatrick SetVector<StringRef> MissingSections;
35409467b48Spatrick for (StringRef S : FilterSections) {
35509467b48Spatrick if (FoundSectionSet.count(S))
35609467b48Spatrick return;
35709467b48Spatrick // User may specify a unnamed section. Don't warn for it.
35809467b48Spatrick if (!S.empty())
35909467b48Spatrick MissingSections.insert(S);
36009467b48Spatrick }
36109467b48Spatrick
36209467b48Spatrick // Warn only if no section in FilterSections is matched.
36309467b48Spatrick for (StringRef S : MissingSections)
36409467b48Spatrick reportCmdLineWarning("section '" + S +
36509467b48Spatrick "' mentioned in a -j/--section option, but not "
36609467b48Spatrick "found in any input file");
36709467b48Spatrick }
36809467b48Spatrick
getTarget(const ObjectFile * Obj)36909467b48Spatrick static const Target *getTarget(const ObjectFile *Obj) {
37009467b48Spatrick // Figure out the target triple.
37109467b48Spatrick Triple TheTriple("unknown-unknown-unknown");
37209467b48Spatrick if (TripleName.empty()) {
37309467b48Spatrick TheTriple = Obj->makeTriple();
37409467b48Spatrick } else {
37509467b48Spatrick TheTriple.setTriple(Triple::normalize(TripleName));
37609467b48Spatrick auto Arch = Obj->getArch();
37709467b48Spatrick if (Arch == Triple::arm || Arch == Triple::armeb)
37809467b48Spatrick Obj->setARMSubArch(TheTriple);
37909467b48Spatrick }
38009467b48Spatrick
38109467b48Spatrick // Get the target specific parser.
38209467b48Spatrick std::string Error;
38309467b48Spatrick const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
38409467b48Spatrick Error);
38509467b48Spatrick if (!TheTarget)
38609467b48Spatrick reportError(Obj->getFileName(), "can't find target: " + Error);
38709467b48Spatrick
38809467b48Spatrick // Update the triple name and return the found target.
38909467b48Spatrick TripleName = TheTriple.getTriple();
39009467b48Spatrick return TheTarget;
39109467b48Spatrick }
39209467b48Spatrick
isRelocAddressLess(RelocationRef A,RelocationRef B)393097a140dSpatrick bool objdump::isRelocAddressLess(RelocationRef A, RelocationRef B) {
39409467b48Spatrick return A.getOffset() < B.getOffset();
39509467b48Spatrick }
39609467b48Spatrick
getRelocationValueString(const RelocationRef & Rel,SmallVectorImpl<char> & Result)39709467b48Spatrick static Error getRelocationValueString(const RelocationRef &Rel,
39809467b48Spatrick SmallVectorImpl<char> &Result) {
39909467b48Spatrick const ObjectFile *Obj = Rel.getObject();
40009467b48Spatrick if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
40109467b48Spatrick return getELFRelocationValueString(ELF, Rel, Result);
40209467b48Spatrick if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
40309467b48Spatrick return getCOFFRelocationValueString(COFF, Rel, Result);
40409467b48Spatrick if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
40509467b48Spatrick return getWasmRelocationValueString(Wasm, Rel, Result);
40609467b48Spatrick if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
40709467b48Spatrick return getMachORelocationValueString(MachO, Rel, Result);
408097a140dSpatrick if (auto *XCOFF = dyn_cast<XCOFFObjectFile>(Obj))
409*d415bd75Srobert return getXCOFFRelocationValueString(*XCOFF, Rel, Result);
41009467b48Spatrick llvm_unreachable("unknown object file format");
41109467b48Spatrick }
41209467b48Spatrick
41309467b48Spatrick /// Indicates whether this relocation should hidden when listing
41409467b48Spatrick /// relocations, usually because it is the trailing part of a multipart
41509467b48Spatrick /// relocation that will be printed as part of the leading relocation.
getHidden(RelocationRef RelRef)41609467b48Spatrick static bool getHidden(RelocationRef RelRef) {
41709467b48Spatrick auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
41809467b48Spatrick if (!MachO)
41909467b48Spatrick return false;
42009467b48Spatrick
42109467b48Spatrick unsigned Arch = MachO->getArch();
42209467b48Spatrick DataRefImpl Rel = RelRef.getRawDataRefImpl();
42309467b48Spatrick uint64_t Type = MachO->getRelocationType(Rel);
42409467b48Spatrick
42509467b48Spatrick // On arches that use the generic relocations, GENERIC_RELOC_PAIR
42609467b48Spatrick // is always hidden.
42709467b48Spatrick if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
42809467b48Spatrick return Type == MachO::GENERIC_RELOC_PAIR;
42909467b48Spatrick
43009467b48Spatrick if (Arch == Triple::x86_64) {
43109467b48Spatrick // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
43209467b48Spatrick // an X86_64_RELOC_SUBTRACTOR.
43309467b48Spatrick if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
43409467b48Spatrick DataRefImpl RelPrev = Rel;
43509467b48Spatrick RelPrev.d.a--;
43609467b48Spatrick uint64_t PrevType = MachO->getRelocationType(RelPrev);
43709467b48Spatrick if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
43809467b48Spatrick return true;
43909467b48Spatrick }
44009467b48Spatrick }
44109467b48Spatrick
44209467b48Spatrick return false;
44309467b48Spatrick }
44409467b48Spatrick
44509467b48Spatrick namespace {
446097a140dSpatrick
447097a140dSpatrick /// Get the column at which we want to start printing the instruction
448097a140dSpatrick /// disassembly, taking into account anything which appears to the left of it.
getInstStartColumn(const MCSubtargetInfo & STI)449097a140dSpatrick unsigned getInstStartColumn(const MCSubtargetInfo &STI) {
45073471bf0Spatrick return !ShowRawInsn ? 16 : STI.getTargetTriple().isX86() ? 40 : 24;
45109467b48Spatrick }
45209467b48Spatrick
isAArch64Elf(const ObjectFile & Obj)453*d415bd75Srobert static bool isAArch64Elf(const ObjectFile &Obj) {
454*d415bd75Srobert const auto *Elf = dyn_cast<ELFObjectFileBase>(&Obj);
45509467b48Spatrick return Elf && Elf->getEMachine() == ELF::EM_AARCH64;
45609467b48Spatrick }
45709467b48Spatrick
isArmElf(const ObjectFile & Obj)458*d415bd75Srobert static bool isArmElf(const ObjectFile &Obj) {
459*d415bd75Srobert const auto *Elf = dyn_cast<ELFObjectFileBase>(&Obj);
46009467b48Spatrick return Elf && Elf->getEMachine() == ELF::EM_ARM;
46109467b48Spatrick }
46209467b48Spatrick
isCSKYElf(const ObjectFile & Obj)463*d415bd75Srobert static bool isCSKYElf(const ObjectFile &Obj) {
464*d415bd75Srobert const auto *Elf = dyn_cast<ELFObjectFileBase>(&Obj);
465*d415bd75Srobert return Elf && Elf->getEMachine() == ELF::EM_CSKY;
466*d415bd75Srobert }
467*d415bd75Srobert
hasMappingSymbols(const ObjectFile & Obj)468*d415bd75Srobert static bool hasMappingSymbols(const ObjectFile &Obj) {
469*d415bd75Srobert return isArmElf(Obj) || isAArch64Elf(Obj) || isCSKYElf(Obj) ;
470*d415bd75Srobert }
471*d415bd75Srobert
isMappingSymbol(const SymbolInfoTy & Sym)472*d415bd75Srobert static bool isMappingSymbol(const SymbolInfoTy &Sym) {
473*d415bd75Srobert return Sym.Name.startswith("$d") || Sym.Name.startswith("$x") ||
474*d415bd75Srobert Sym.Name.startswith("$a") || Sym.Name.startswith("$t");
47509467b48Spatrick }
47609467b48Spatrick
printRelocation(formatted_raw_ostream & OS,StringRef FileName,const RelocationRef & Rel,uint64_t Address,bool Is64Bits)477097a140dSpatrick static void printRelocation(formatted_raw_ostream &OS, StringRef FileName,
478097a140dSpatrick const RelocationRef &Rel, uint64_t Address,
479097a140dSpatrick bool Is64Bits) {
480*d415bd75Srobert StringRef Fmt = Is64Bits ? "%016" PRIx64 ": " : "%08" PRIx64 ": ";
48109467b48Spatrick SmallString<16> Name;
48209467b48Spatrick SmallString<32> Val;
48309467b48Spatrick Rel.getTypeName(Name);
48409467b48Spatrick if (Error E = getRelocationValueString(Rel, Val))
48509467b48Spatrick reportError(std::move(E), FileName);
486*d415bd75Srobert OS << (Is64Bits || !LeadingAddr ? "\t\t" : "\t\t\t");
487*d415bd75Srobert if (LeadingAddr)
488*d415bd75Srobert OS << format(Fmt.data(), Address);
489*d415bd75Srobert OS << Name << "\t" << Val;
490*d415bd75Srobert }
491*d415bd75Srobert
AlignToInstStartColumn(size_t Start,const MCSubtargetInfo & STI,raw_ostream & OS)492*d415bd75Srobert static void AlignToInstStartColumn(size_t Start, const MCSubtargetInfo &STI,
493*d415bd75Srobert raw_ostream &OS) {
494*d415bd75Srobert // The output of printInst starts with a tab. Print some spaces so that
495*d415bd75Srobert // the tab has 1 column and advances to the target tab stop.
496*d415bd75Srobert unsigned TabStop = getInstStartColumn(STI);
497*d415bd75Srobert unsigned Column = OS.tell() - Start;
498*d415bd75Srobert OS.indent(Column < TabStop - 1 ? TabStop - 1 - Column : 7 - Column % 8);
49909467b48Spatrick }
50009467b48Spatrick
50109467b48Spatrick class PrettyPrinter {
50209467b48Spatrick public:
50309467b48Spatrick virtual ~PrettyPrinter() = default;
504097a140dSpatrick virtual void
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)505097a140dSpatrick printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
506097a140dSpatrick object::SectionedAddress Address, formatted_raw_ostream &OS,
507097a140dSpatrick StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
508097a140dSpatrick StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
509097a140dSpatrick LiveVariablePrinter &LVP) {
51009467b48Spatrick if (SP && (PrintSource || PrintLines))
511097a140dSpatrick SP->printSourceLine(OS, Address, ObjectFilename, LVP);
512097a140dSpatrick LVP.printBetweenInsts(OS, false);
51309467b48Spatrick
51409467b48Spatrick size_t Start = OS.tell();
51573471bf0Spatrick if (LeadingAddr)
51609467b48Spatrick OS << format("%8" PRIx64 ":", Address.Address);
51773471bf0Spatrick if (ShowRawInsn) {
51809467b48Spatrick OS << ' ';
51909467b48Spatrick dumpBytes(Bytes, OS);
52009467b48Spatrick }
52109467b48Spatrick
522*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
52309467b48Spatrick
524097a140dSpatrick if (MI) {
525097a140dSpatrick // See MCInstPrinter::printInst. On targets where a PC relative immediate
526097a140dSpatrick // is relative to the next instruction and the length of a MCInst is
527097a140dSpatrick // difficult to measure (x86), this is the address of the next
528097a140dSpatrick // instruction.
529097a140dSpatrick uint64_t Addr =
530097a140dSpatrick Address.Address + (STI.getTargetTriple().isX86() ? Bytes.size() : 0);
531097a140dSpatrick IP.printInst(MI, Addr, "", STI, OS);
532097a140dSpatrick } else
53309467b48Spatrick OS << "\t<unknown>";
53409467b48Spatrick }
53509467b48Spatrick };
53609467b48Spatrick PrettyPrinter PrettyPrinterInst;
53709467b48Spatrick
53809467b48Spatrick class HexagonPrettyPrinter : public PrettyPrinter {
53909467b48Spatrick public:
printLead(ArrayRef<uint8_t> Bytes,uint64_t Address,formatted_raw_ostream & OS)54009467b48Spatrick void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
541097a140dSpatrick formatted_raw_ostream &OS) {
54209467b48Spatrick uint32_t opcode =
54309467b48Spatrick (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
54473471bf0Spatrick if (LeadingAddr)
54509467b48Spatrick OS << format("%8" PRIx64 ":", Address);
54673471bf0Spatrick if (ShowRawInsn) {
54709467b48Spatrick OS << "\t";
54809467b48Spatrick dumpBytes(Bytes.slice(0, 4), OS);
54909467b48Spatrick OS << format("\t%08" PRIx32, opcode);
55009467b48Spatrick }
55109467b48Spatrick }
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)55209467b48Spatrick void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
553097a140dSpatrick object::SectionedAddress Address, formatted_raw_ostream &OS,
55409467b48Spatrick StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
555097a140dSpatrick StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
556097a140dSpatrick LiveVariablePrinter &LVP) override {
55709467b48Spatrick if (SP && (PrintSource || PrintLines))
558097a140dSpatrick SP->printSourceLine(OS, Address, ObjectFilename, LVP, "");
55909467b48Spatrick if (!MI) {
56009467b48Spatrick printLead(Bytes, Address.Address, OS);
56109467b48Spatrick OS << " <unknown>";
56209467b48Spatrick return;
56309467b48Spatrick }
56409467b48Spatrick std::string Buffer;
56509467b48Spatrick {
56609467b48Spatrick raw_string_ostream TempStream(Buffer);
56709467b48Spatrick IP.printInst(MI, Address.Address, "", STI, TempStream);
56809467b48Spatrick }
56909467b48Spatrick StringRef Contents(Buffer);
57009467b48Spatrick // Split off bundle attributes
57109467b48Spatrick auto PacketBundle = Contents.rsplit('\n');
57209467b48Spatrick // Split off first instruction from the rest
57309467b48Spatrick auto HeadTail = PacketBundle.first.split('\n');
57409467b48Spatrick auto Preamble = " { ";
57509467b48Spatrick auto Separator = "";
57609467b48Spatrick
57709467b48Spatrick // Hexagon's packets require relocations to be inline rather than
57809467b48Spatrick // clustered at the end of the packet.
57909467b48Spatrick std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
58009467b48Spatrick std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
58109467b48Spatrick auto PrintReloc = [&]() -> void {
58209467b48Spatrick while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
58309467b48Spatrick if (RelCur->getOffset() == Address.Address) {
584097a140dSpatrick printRelocation(OS, ObjectFilename, *RelCur, Address.Address, false);
58509467b48Spatrick return;
58609467b48Spatrick }
58709467b48Spatrick ++RelCur;
58809467b48Spatrick }
58909467b48Spatrick };
59009467b48Spatrick
59109467b48Spatrick while (!HeadTail.first.empty()) {
59209467b48Spatrick OS << Separator;
59309467b48Spatrick Separator = "\n";
59409467b48Spatrick if (SP && (PrintSource || PrintLines))
595097a140dSpatrick SP->printSourceLine(OS, Address, ObjectFilename, LVP, "");
59609467b48Spatrick printLead(Bytes, Address.Address, OS);
59709467b48Spatrick OS << Preamble;
59809467b48Spatrick Preamble = " ";
59909467b48Spatrick StringRef Inst;
60009467b48Spatrick auto Duplex = HeadTail.first.split('\v');
60109467b48Spatrick if (!Duplex.second.empty()) {
60209467b48Spatrick OS << Duplex.first;
60309467b48Spatrick OS << "; ";
60409467b48Spatrick Inst = Duplex.second;
60509467b48Spatrick }
60609467b48Spatrick else
60709467b48Spatrick Inst = HeadTail.first;
60809467b48Spatrick OS << Inst;
60909467b48Spatrick HeadTail = HeadTail.second.split('\n');
61009467b48Spatrick if (HeadTail.first.empty())
61109467b48Spatrick OS << " } " << PacketBundle.second;
61209467b48Spatrick PrintReloc();
61309467b48Spatrick Bytes = Bytes.slice(4);
61409467b48Spatrick Address.Address += 4;
61509467b48Spatrick }
61609467b48Spatrick }
61709467b48Spatrick };
61809467b48Spatrick HexagonPrettyPrinter HexagonPrettyPrinterInst;
61909467b48Spatrick
62009467b48Spatrick class AMDGCNPrettyPrinter : public PrettyPrinter {
62109467b48Spatrick public:
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)62209467b48Spatrick void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
623097a140dSpatrick object::SectionedAddress Address, formatted_raw_ostream &OS,
62409467b48Spatrick StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
625097a140dSpatrick StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
626097a140dSpatrick LiveVariablePrinter &LVP) override {
62709467b48Spatrick if (SP && (PrintSource || PrintLines))
628097a140dSpatrick SP->printSourceLine(OS, Address, ObjectFilename, LVP);
62909467b48Spatrick
63009467b48Spatrick if (MI) {
63109467b48Spatrick SmallString<40> InstStr;
63209467b48Spatrick raw_svector_ostream IS(InstStr);
63309467b48Spatrick
63409467b48Spatrick IP.printInst(MI, Address.Address, "", STI, IS);
63509467b48Spatrick
63609467b48Spatrick OS << left_justify(IS.str(), 60);
63709467b48Spatrick } else {
63809467b48Spatrick // an unrecognized encoding - this is probably data so represent it
63909467b48Spatrick // using the .long directive, or .byte directive if fewer than 4 bytes
64009467b48Spatrick // remaining
64109467b48Spatrick if (Bytes.size() >= 4) {
64209467b48Spatrick OS << format("\t.long 0x%08" PRIx32 " ",
64309467b48Spatrick support::endian::read32<support::little>(Bytes.data()));
64409467b48Spatrick OS.indent(42);
64509467b48Spatrick } else {
64609467b48Spatrick OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
64709467b48Spatrick for (unsigned int i = 1; i < Bytes.size(); i++)
64809467b48Spatrick OS << format(", 0x%02" PRIx8, Bytes[i]);
64909467b48Spatrick OS.indent(55 - (6 * Bytes.size()));
65009467b48Spatrick }
65109467b48Spatrick }
65209467b48Spatrick
65309467b48Spatrick OS << format("// %012" PRIX64 ":", Address.Address);
65409467b48Spatrick if (Bytes.size() >= 4) {
65509467b48Spatrick // D should be casted to uint32_t here as it is passed by format to
65609467b48Spatrick // snprintf as vararg.
657*d415bd75Srobert for (uint32_t D :
658*d415bd75Srobert ArrayRef(reinterpret_cast<const support::little32_t *>(Bytes.data()),
65909467b48Spatrick Bytes.size() / 4))
66009467b48Spatrick OS << format(" %08" PRIX32, D);
66109467b48Spatrick } else {
66209467b48Spatrick for (unsigned char B : Bytes)
66309467b48Spatrick OS << format(" %02" PRIX8, B);
66409467b48Spatrick }
66509467b48Spatrick
66609467b48Spatrick if (!Annot.empty())
66709467b48Spatrick OS << " // " << Annot;
66809467b48Spatrick }
66909467b48Spatrick };
67009467b48Spatrick AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
67109467b48Spatrick
67209467b48Spatrick class BPFPrettyPrinter : public PrettyPrinter {
67309467b48Spatrick public:
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)67409467b48Spatrick void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
675097a140dSpatrick object::SectionedAddress Address, formatted_raw_ostream &OS,
67609467b48Spatrick StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
677097a140dSpatrick StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
678097a140dSpatrick LiveVariablePrinter &LVP) override {
67909467b48Spatrick if (SP && (PrintSource || PrintLines))
680097a140dSpatrick SP->printSourceLine(OS, Address, ObjectFilename, LVP);
68173471bf0Spatrick if (LeadingAddr)
68209467b48Spatrick OS << format("%8" PRId64 ":", Address.Address / 8);
68373471bf0Spatrick if (ShowRawInsn) {
68409467b48Spatrick OS << "\t";
68509467b48Spatrick dumpBytes(Bytes, OS);
68609467b48Spatrick }
68709467b48Spatrick if (MI)
68809467b48Spatrick IP.printInst(MI, Address.Address, "", STI, OS);
68909467b48Spatrick else
69009467b48Spatrick OS << "\t<unknown>";
69109467b48Spatrick }
69209467b48Spatrick };
69309467b48Spatrick BPFPrettyPrinter BPFPrettyPrinterInst;
69409467b48Spatrick
695*d415bd75Srobert class ARMPrettyPrinter : public PrettyPrinter {
696*d415bd75Srobert public:
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)697*d415bd75Srobert void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
698*d415bd75Srobert object::SectionedAddress Address, formatted_raw_ostream &OS,
699*d415bd75Srobert StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
700*d415bd75Srobert StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
701*d415bd75Srobert LiveVariablePrinter &LVP) override {
702*d415bd75Srobert if (SP && (PrintSource || PrintLines))
703*d415bd75Srobert SP->printSourceLine(OS, Address, ObjectFilename, LVP);
704*d415bd75Srobert LVP.printBetweenInsts(OS, false);
705*d415bd75Srobert
706*d415bd75Srobert size_t Start = OS.tell();
707*d415bd75Srobert if (LeadingAddr)
708*d415bd75Srobert OS << format("%8" PRIx64 ":", Address.Address);
709*d415bd75Srobert if (ShowRawInsn) {
710*d415bd75Srobert size_t Pos = 0, End = Bytes.size();
711*d415bd75Srobert if (STI.checkFeatures("+thumb-mode")) {
712*d415bd75Srobert for (; Pos + 2 <= End; Pos += 2)
713*d415bd75Srobert OS << ' '
714*d415bd75Srobert << format_hex_no_prefix(
715*d415bd75Srobert llvm::support::endian::read<uint16_t>(
716*d415bd75Srobert Bytes.data() + Pos, InstructionEndianness),
717*d415bd75Srobert 4);
718*d415bd75Srobert } else {
719*d415bd75Srobert for (; Pos + 4 <= End; Pos += 4)
720*d415bd75Srobert OS << ' '
721*d415bd75Srobert << format_hex_no_prefix(
722*d415bd75Srobert llvm::support::endian::read<uint32_t>(
723*d415bd75Srobert Bytes.data() + Pos, InstructionEndianness),
724*d415bd75Srobert 8);
725*d415bd75Srobert }
726*d415bd75Srobert if (Pos < End) {
727*d415bd75Srobert OS << ' ';
728*d415bd75Srobert dumpBytes(Bytes.slice(Pos), OS);
729*d415bd75Srobert }
730*d415bd75Srobert }
731*d415bd75Srobert
732*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
733*d415bd75Srobert
734*d415bd75Srobert if (MI) {
735*d415bd75Srobert IP.printInst(MI, Address.Address, "", STI, OS);
736*d415bd75Srobert } else
737*d415bd75Srobert OS << "\t<unknown>";
738*d415bd75Srobert }
739*d415bd75Srobert
setInstructionEndianness(llvm::support::endianness Endianness)740*d415bd75Srobert void setInstructionEndianness(llvm::support::endianness Endianness) {
741*d415bd75Srobert InstructionEndianness = Endianness;
742*d415bd75Srobert }
743*d415bd75Srobert
744*d415bd75Srobert private:
745*d415bd75Srobert llvm::support::endianness InstructionEndianness = llvm::support::little;
746*d415bd75Srobert };
747*d415bd75Srobert ARMPrettyPrinter ARMPrettyPrinterInst;
748*d415bd75Srobert
749*d415bd75Srobert class AArch64PrettyPrinter : public PrettyPrinter {
750*d415bd75Srobert public:
printInst(MCInstPrinter & IP,const MCInst * MI,ArrayRef<uint8_t> Bytes,object::SectionedAddress Address,formatted_raw_ostream & OS,StringRef Annot,MCSubtargetInfo const & STI,SourcePrinter * SP,StringRef ObjectFilename,std::vector<RelocationRef> * Rels,LiveVariablePrinter & LVP)751*d415bd75Srobert void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
752*d415bd75Srobert object::SectionedAddress Address, formatted_raw_ostream &OS,
753*d415bd75Srobert StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
754*d415bd75Srobert StringRef ObjectFilename, std::vector<RelocationRef> *Rels,
755*d415bd75Srobert LiveVariablePrinter &LVP) override {
756*d415bd75Srobert if (SP && (PrintSource || PrintLines))
757*d415bd75Srobert SP->printSourceLine(OS, Address, ObjectFilename, LVP);
758*d415bd75Srobert LVP.printBetweenInsts(OS, false);
759*d415bd75Srobert
760*d415bd75Srobert size_t Start = OS.tell();
761*d415bd75Srobert if (LeadingAddr)
762*d415bd75Srobert OS << format("%8" PRIx64 ":", Address.Address);
763*d415bd75Srobert if (ShowRawInsn) {
764*d415bd75Srobert size_t Pos = 0, End = Bytes.size();
765*d415bd75Srobert for (; Pos + 4 <= End; Pos += 4)
766*d415bd75Srobert OS << ' '
767*d415bd75Srobert << format_hex_no_prefix(
768*d415bd75Srobert llvm::support::endian::read<uint32_t>(Bytes.data() + Pos,
769*d415bd75Srobert llvm::support::little),
770*d415bd75Srobert 8);
771*d415bd75Srobert if (Pos < End) {
772*d415bd75Srobert OS << ' ';
773*d415bd75Srobert dumpBytes(Bytes.slice(Pos), OS);
774*d415bd75Srobert }
775*d415bd75Srobert }
776*d415bd75Srobert
777*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
778*d415bd75Srobert
779*d415bd75Srobert if (MI) {
780*d415bd75Srobert IP.printInst(MI, Address.Address, "", STI, OS);
781*d415bd75Srobert } else
782*d415bd75Srobert OS << "\t<unknown>";
783*d415bd75Srobert }
784*d415bd75Srobert };
785*d415bd75Srobert AArch64PrettyPrinter AArch64PrettyPrinterInst;
786*d415bd75Srobert
selectPrettyPrinter(Triple const & Triple)78709467b48Spatrick PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
78809467b48Spatrick switch(Triple.getArch()) {
78909467b48Spatrick default:
79009467b48Spatrick return PrettyPrinterInst;
79109467b48Spatrick case Triple::hexagon:
79209467b48Spatrick return HexagonPrettyPrinterInst;
79309467b48Spatrick case Triple::amdgcn:
79409467b48Spatrick return AMDGCNPrettyPrinterInst;
79509467b48Spatrick case Triple::bpfel:
79609467b48Spatrick case Triple::bpfeb:
79709467b48Spatrick return BPFPrettyPrinterInst;
798*d415bd75Srobert case Triple::arm:
799*d415bd75Srobert case Triple::armeb:
800*d415bd75Srobert case Triple::thumb:
801*d415bd75Srobert case Triple::thumbeb:
802*d415bd75Srobert return ARMPrettyPrinterInst;
803*d415bd75Srobert case Triple::aarch64:
804*d415bd75Srobert case Triple::aarch64_be:
805*d415bd75Srobert case Triple::aarch64_32:
806*d415bd75Srobert return AArch64PrettyPrinterInst;
80709467b48Spatrick }
80809467b48Spatrick }
80909467b48Spatrick }
81009467b48Spatrick
getElfSymbolType(const ObjectFile & Obj,const SymbolRef & Sym)811*d415bd75Srobert static uint8_t getElfSymbolType(const ObjectFile &Obj, const SymbolRef &Sym) {
812*d415bd75Srobert assert(Obj.isELF());
813*d415bd75Srobert if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(&Obj))
81473471bf0Spatrick return unwrapOrError(Elf32LEObj->getSymbol(Sym.getRawDataRefImpl()),
815*d415bd75Srobert Obj.getFileName())
81673471bf0Spatrick ->getType();
817*d415bd75Srobert if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(&Obj))
81873471bf0Spatrick return unwrapOrError(Elf64LEObj->getSymbol(Sym.getRawDataRefImpl()),
819*d415bd75Srobert Obj.getFileName())
82073471bf0Spatrick ->getType();
821*d415bd75Srobert if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(&Obj))
82273471bf0Spatrick return unwrapOrError(Elf32BEObj->getSymbol(Sym.getRawDataRefImpl()),
823*d415bd75Srobert Obj.getFileName())
82473471bf0Spatrick ->getType();
825*d415bd75Srobert if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(&Obj))
82673471bf0Spatrick return unwrapOrError(Elf64BEObj->getSymbol(Sym.getRawDataRefImpl()),
827*d415bd75Srobert Obj.getFileName())
82873471bf0Spatrick ->getType();
82909467b48Spatrick llvm_unreachable("Unsupported binary format");
83009467b48Spatrick }
83109467b48Spatrick
832*d415bd75Srobert template <class ELFT>
833*d415bd75Srobert static void
addDynamicElfSymbols(const ELFObjectFile<ELFT> & Obj,std::map<SectionRef,SectionSymbolsTy> & AllSymbols)834*d415bd75Srobert addDynamicElfSymbols(const ELFObjectFile<ELFT> &Obj,
83509467b48Spatrick std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
836*d415bd75Srobert for (auto Symbol : Obj.getDynamicSymbolIterators()) {
83709467b48Spatrick uint8_t SymbolType = Symbol.getELFType();
83809467b48Spatrick if (SymbolType == ELF::STT_SECTION)
83909467b48Spatrick continue;
84009467b48Spatrick
841*d415bd75Srobert uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj.getFileName());
84209467b48Spatrick // ELFSymbolRef::getAddress() returns size instead of value for common
84309467b48Spatrick // symbols which is not desirable for disassembly output. Overriding.
84409467b48Spatrick if (SymbolType == ELF::STT_COMMON)
845*d415bd75Srobert Address = unwrapOrError(Obj.getSymbol(Symbol.getRawDataRefImpl()),
846*d415bd75Srobert Obj.getFileName())
84773471bf0Spatrick ->st_value;
84809467b48Spatrick
849*d415bd75Srobert StringRef Name = unwrapOrError(Symbol.getName(), Obj.getFileName());
85009467b48Spatrick if (Name.empty())
85109467b48Spatrick continue;
85209467b48Spatrick
85309467b48Spatrick section_iterator SecI =
854*d415bd75Srobert unwrapOrError(Symbol.getSection(), Obj.getFileName());
855*d415bd75Srobert if (SecI == Obj.section_end())
85609467b48Spatrick continue;
85709467b48Spatrick
85809467b48Spatrick AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
85909467b48Spatrick }
86009467b48Spatrick }
86109467b48Spatrick
86209467b48Spatrick static void
addDynamicElfSymbols(const ELFObjectFileBase & Obj,std::map<SectionRef,SectionSymbolsTy> & AllSymbols)863*d415bd75Srobert addDynamicElfSymbols(const ELFObjectFileBase &Obj,
86409467b48Spatrick std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
865*d415bd75Srobert if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(&Obj))
866*d415bd75Srobert addDynamicElfSymbols(*Elf32LEObj, AllSymbols);
867*d415bd75Srobert else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(&Obj))
868*d415bd75Srobert addDynamicElfSymbols(*Elf64LEObj, AllSymbols);
869*d415bd75Srobert else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(&Obj))
870*d415bd75Srobert addDynamicElfSymbols(*Elf32BEObj, AllSymbols);
871*d415bd75Srobert else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(&Obj))
872*d415bd75Srobert addDynamicElfSymbols(*Elf64BEObj, AllSymbols);
87309467b48Spatrick else
87409467b48Spatrick llvm_unreachable("Unsupported binary format");
87509467b48Spatrick }
87609467b48Spatrick
getWasmCodeSection(const WasmObjectFile & Obj)877*d415bd75Srobert static std::optional<SectionRef> getWasmCodeSection(const WasmObjectFile &Obj) {
878*d415bd75Srobert for (auto SecI : Obj.sections()) {
879*d415bd75Srobert const WasmSection &Section = Obj.getWasmSection(SecI);
88073471bf0Spatrick if (Section.Type == wasm::WASM_SEC_CODE)
88173471bf0Spatrick return SecI;
88273471bf0Spatrick }
883*d415bd75Srobert return std::nullopt;
88473471bf0Spatrick }
88573471bf0Spatrick
88673471bf0Spatrick static void
addMissingWasmCodeSymbols(const WasmObjectFile & Obj,std::map<SectionRef,SectionSymbolsTy> & AllSymbols)887*d415bd75Srobert addMissingWasmCodeSymbols(const WasmObjectFile &Obj,
88873471bf0Spatrick std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
889*d415bd75Srobert std::optional<SectionRef> Section = getWasmCodeSection(Obj);
89073471bf0Spatrick if (!Section)
89173471bf0Spatrick return;
89273471bf0Spatrick SectionSymbolsTy &Symbols = AllSymbols[*Section];
89373471bf0Spatrick
89473471bf0Spatrick std::set<uint64_t> SymbolAddresses;
89573471bf0Spatrick for (const auto &Sym : Symbols)
89673471bf0Spatrick SymbolAddresses.insert(Sym.Addr);
89773471bf0Spatrick
898*d415bd75Srobert for (const wasm::WasmFunction &Function : Obj.functions()) {
89973471bf0Spatrick uint64_t Address = Function.CodeSectionOffset;
90073471bf0Spatrick // Only add fallback symbols for functions not already present in the symbol
90173471bf0Spatrick // table.
90273471bf0Spatrick if (SymbolAddresses.count(Address))
90373471bf0Spatrick continue;
90473471bf0Spatrick // This function has no symbol, so it should have no SymbolName.
90573471bf0Spatrick assert(Function.SymbolName.empty());
90673471bf0Spatrick // We use DebugName for the name, though it may be empty if there is no
90773471bf0Spatrick // "name" custom section, or that section is missing a name for this
90873471bf0Spatrick // function.
90973471bf0Spatrick StringRef Name = Function.DebugName;
91073471bf0Spatrick Symbols.emplace_back(Address, Name, ELF::STT_NOTYPE);
91173471bf0Spatrick }
91273471bf0Spatrick }
91373471bf0Spatrick
addPltEntries(const ObjectFile & Obj,std::map<SectionRef,SectionSymbolsTy> & AllSymbols,StringSaver & Saver)914*d415bd75Srobert static void addPltEntries(const ObjectFile &Obj,
91509467b48Spatrick std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
91609467b48Spatrick StringSaver &Saver) {
917*d415bd75Srobert std::optional<SectionRef> Plt;
918*d415bd75Srobert for (const SectionRef &Section : Obj.sections()) {
91909467b48Spatrick Expected<StringRef> SecNameOrErr = Section.getName();
92009467b48Spatrick if (!SecNameOrErr) {
92109467b48Spatrick consumeError(SecNameOrErr.takeError());
92209467b48Spatrick continue;
92309467b48Spatrick }
92409467b48Spatrick if (*SecNameOrErr == ".plt")
92509467b48Spatrick Plt = Section;
92609467b48Spatrick }
92709467b48Spatrick if (!Plt)
92809467b48Spatrick return;
929*d415bd75Srobert if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(&Obj)) {
93009467b48Spatrick for (auto PltEntry : ElfObj->getPltAddresses()) {
93173471bf0Spatrick if (PltEntry.first) {
93273471bf0Spatrick SymbolRef Symbol(*PltEntry.first, ElfObj);
93309467b48Spatrick uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
93473471bf0Spatrick if (Expected<StringRef> NameOrErr = Symbol.getName()) {
93573471bf0Spatrick if (!NameOrErr->empty())
93609467b48Spatrick AllSymbols[*Plt].emplace_back(
93773471bf0Spatrick PltEntry.second, Saver.save((*NameOrErr + "@plt").str()),
93873471bf0Spatrick SymbolType);
93973471bf0Spatrick continue;
94073471bf0Spatrick } else {
94173471bf0Spatrick // The warning has been reported in disassembleObject().
94273471bf0Spatrick consumeError(NameOrErr.takeError());
94373471bf0Spatrick }
94473471bf0Spatrick }
94573471bf0Spatrick reportWarning("PLT entry at 0x" + Twine::utohexstr(PltEntry.second) +
94673471bf0Spatrick " references an invalid symbol",
947*d415bd75Srobert Obj.getFileName());
94809467b48Spatrick }
94909467b48Spatrick }
95009467b48Spatrick }
95109467b48Spatrick
95209467b48Spatrick // Normally the disassembly output will skip blocks of zeroes. This function
95309467b48Spatrick // returns the number of zero bytes that can be skipped when dumping the
95409467b48Spatrick // disassembly of the instructions in Buf.
countSkippableZeroBytes(ArrayRef<uint8_t> Buf)95509467b48Spatrick static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
95609467b48Spatrick // Find the number of leading zeroes.
95709467b48Spatrick size_t N = 0;
95809467b48Spatrick while (N < Buf.size() && !Buf[N])
95909467b48Spatrick ++N;
96009467b48Spatrick
96109467b48Spatrick // We may want to skip blocks of zero bytes, but unless we see
96209467b48Spatrick // at least 8 of them in a row.
96309467b48Spatrick if (N < 8)
96409467b48Spatrick return 0;
96509467b48Spatrick
96609467b48Spatrick // We skip zeroes in multiples of 4 because do not want to truncate an
96709467b48Spatrick // instruction if it starts with a zero byte.
96809467b48Spatrick return N & ~0x3;
96909467b48Spatrick }
97009467b48Spatrick
97109467b48Spatrick // Returns a map from sections to their relocations.
97209467b48Spatrick static std::map<SectionRef, std::vector<RelocationRef>>
getRelocsMap(object::ObjectFile const & Obj)97309467b48Spatrick getRelocsMap(object::ObjectFile const &Obj) {
97409467b48Spatrick std::map<SectionRef, std::vector<RelocationRef>> Ret;
97509467b48Spatrick uint64_t I = (uint64_t)-1;
97609467b48Spatrick for (SectionRef Sec : Obj.sections()) {
97709467b48Spatrick ++I;
97809467b48Spatrick Expected<section_iterator> RelocatedOrErr = Sec.getRelocatedSection();
97909467b48Spatrick if (!RelocatedOrErr)
98009467b48Spatrick reportError(Obj.getFileName(),
98109467b48Spatrick "section (" + Twine(I) +
98209467b48Spatrick "): failed to get a relocated section: " +
98309467b48Spatrick toString(RelocatedOrErr.takeError()));
98409467b48Spatrick
98509467b48Spatrick section_iterator Relocated = *RelocatedOrErr;
98609467b48Spatrick if (Relocated == Obj.section_end() || !checkSectionFilter(*Relocated).Keep)
98709467b48Spatrick continue;
98809467b48Spatrick std::vector<RelocationRef> &V = Ret[*Relocated];
98973471bf0Spatrick append_range(V, Sec.relocations());
99009467b48Spatrick // Sort relocations by address.
99109467b48Spatrick llvm::stable_sort(V, isRelocAddressLess);
99209467b48Spatrick }
99309467b48Spatrick return Ret;
99409467b48Spatrick }
99509467b48Spatrick
99609467b48Spatrick // Used for --adjust-vma to check if address should be adjusted by the
99709467b48Spatrick // specified value for a given section.
99809467b48Spatrick // For ELF we do not adjust non-allocatable sections like debug ones,
99909467b48Spatrick // because they are not loadable.
100009467b48Spatrick // TODO: implement for other file formats.
shouldAdjustVA(const SectionRef & Section)100109467b48Spatrick static bool shouldAdjustVA(const SectionRef &Section) {
100209467b48Spatrick const ObjectFile *Obj = Section.getObject();
1003097a140dSpatrick if (Obj->isELF())
100409467b48Spatrick return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
100509467b48Spatrick return false;
100609467b48Spatrick }
100709467b48Spatrick
100809467b48Spatrick
100909467b48Spatrick typedef std::pair<uint64_t, char> MappingSymbolPair;
getMappingSymbolKind(ArrayRef<MappingSymbolPair> MappingSymbols,uint64_t Address)101009467b48Spatrick static char getMappingSymbolKind(ArrayRef<MappingSymbolPair> MappingSymbols,
101109467b48Spatrick uint64_t Address) {
101209467b48Spatrick auto It =
101309467b48Spatrick partition_point(MappingSymbols, [Address](const MappingSymbolPair &Val) {
101409467b48Spatrick return Val.first <= Address;
101509467b48Spatrick });
101609467b48Spatrick // Return zero for any address before the first mapping symbol; this means
101709467b48Spatrick // we should use the default disassembly mode, depending on the target.
101809467b48Spatrick if (It == MappingSymbols.begin())
101909467b48Spatrick return '\x00';
102009467b48Spatrick return (It - 1)->second;
102109467b48Spatrick }
102209467b48Spatrick
dumpARMELFData(uint64_t SectionAddr,uint64_t Index,uint64_t End,const ObjectFile & Obj,ArrayRef<uint8_t> Bytes,ArrayRef<MappingSymbolPair> MappingSymbols,const MCSubtargetInfo & STI,raw_ostream & OS)1023097a140dSpatrick static uint64_t dumpARMELFData(uint64_t SectionAddr, uint64_t Index,
1024*d415bd75Srobert uint64_t End, const ObjectFile &Obj,
1025097a140dSpatrick ArrayRef<uint8_t> Bytes,
1026097a140dSpatrick ArrayRef<MappingSymbolPair> MappingSymbols,
1027*d415bd75Srobert const MCSubtargetInfo &STI, raw_ostream &OS) {
102809467b48Spatrick support::endianness Endian =
1029*d415bd75Srobert Obj.isLittleEndian() ? support::little : support::big;
1030*d415bd75Srobert size_t Start = OS.tell();
1031*d415bd75Srobert OS << format("%8" PRIx64 ": ", SectionAddr + Index);
103209467b48Spatrick if (Index + 4 <= End) {
1033097a140dSpatrick dumpBytes(Bytes.slice(Index, 4), OS);
1034*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
1035097a140dSpatrick OS << "\t.word\t"
1036097a140dSpatrick << format_hex(support::endian::read32(Bytes.data() + Index, Endian),
1037097a140dSpatrick 10);
1038097a140dSpatrick return 4;
103909467b48Spatrick }
1040097a140dSpatrick if (Index + 2 <= End) {
1041097a140dSpatrick dumpBytes(Bytes.slice(Index, 2), OS);
1042*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
1043*d415bd75Srobert OS << "\t.short\t"
1044*d415bd75Srobert << format_hex(support::endian::read16(Bytes.data() + Index, Endian), 6);
1045097a140dSpatrick return 2;
104609467b48Spatrick }
1047097a140dSpatrick dumpBytes(Bytes.slice(Index, 1), OS);
1048*d415bd75Srobert AlignToInstStartColumn(Start, STI, OS);
1049*d415bd75Srobert OS << "\t.byte\t" << format_hex(Bytes[Index], 4);
1050097a140dSpatrick return 1;
105109467b48Spatrick }
105209467b48Spatrick
dumpELFData(uint64_t SectionAddr,uint64_t Index,uint64_t End,ArrayRef<uint8_t> Bytes)105309467b48Spatrick static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
105409467b48Spatrick ArrayRef<uint8_t> Bytes) {
105509467b48Spatrick // print out data up to 8 bytes at a time in hex and ascii
105609467b48Spatrick uint8_t AsciiData[9] = {'\0'};
105709467b48Spatrick uint8_t Byte;
105809467b48Spatrick int NumBytes = 0;
105909467b48Spatrick
106009467b48Spatrick for (; Index < End; ++Index) {
106109467b48Spatrick if (NumBytes == 0)
106209467b48Spatrick outs() << format("%8" PRIx64 ":", SectionAddr + Index);
106309467b48Spatrick Byte = Bytes.slice(Index)[0];
106409467b48Spatrick outs() << format(" %02x", Byte);
106509467b48Spatrick AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
106609467b48Spatrick
106709467b48Spatrick uint8_t IndentOffset = 0;
106809467b48Spatrick NumBytes++;
106909467b48Spatrick if (Index == End - 1 || NumBytes > 8) {
107009467b48Spatrick // Indent the space for less than 8 bytes data.
107109467b48Spatrick // 2 spaces for byte and one for space between bytes
107209467b48Spatrick IndentOffset = 3 * (8 - NumBytes);
107309467b48Spatrick for (int Excess = NumBytes; Excess < 8; Excess++)
107409467b48Spatrick AsciiData[Excess] = '\0';
107509467b48Spatrick NumBytes = 8;
107609467b48Spatrick }
107709467b48Spatrick if (NumBytes == 8) {
107809467b48Spatrick AsciiData[8] = '\0';
107909467b48Spatrick outs() << std::string(IndentOffset, ' ') << " ";
108009467b48Spatrick outs() << reinterpret_cast<char *>(AsciiData);
108109467b48Spatrick outs() << '\n';
108209467b48Spatrick NumBytes = 0;
108309467b48Spatrick }
108409467b48Spatrick }
108509467b48Spatrick }
108609467b48Spatrick
createSymbolInfo(const ObjectFile & Obj,const SymbolRef & Symbol)1087*d415bd75Srobert SymbolInfoTy objdump::createSymbolInfo(const ObjectFile &Obj,
1088097a140dSpatrick const SymbolRef &Symbol) {
1089*d415bd75Srobert const StringRef FileName = Obj.getFileName();
1090097a140dSpatrick const uint64_t Addr = unwrapOrError(Symbol.getAddress(), FileName);
1091097a140dSpatrick const StringRef Name = unwrapOrError(Symbol.getName(), FileName);
1092097a140dSpatrick
1093*d415bd75Srobert if (Obj.isXCOFF() && SymbolDescription) {
1094*d415bd75Srobert const auto &XCOFFObj = cast<XCOFFObjectFile>(Obj);
1095097a140dSpatrick DataRefImpl SymbolDRI = Symbol.getRawDataRefImpl();
1096097a140dSpatrick
1097*d415bd75Srobert const uint32_t SymbolIndex = XCOFFObj.getSymbolIndex(SymbolDRI.p);
1098*d415bd75Srobert std::optional<XCOFF::StorageMappingClass> Smc =
1099097a140dSpatrick getXCOFFSymbolCsectSMC(XCOFFObj, Symbol);
1100097a140dSpatrick return SymbolInfoTy(Addr, Name, Smc, SymbolIndex,
1101097a140dSpatrick isLabel(XCOFFObj, Symbol));
1102*d415bd75Srobert } else if (Obj.isXCOFF()) {
1103*d415bd75Srobert const SymbolRef::Type SymType = unwrapOrError(Symbol.getType(), FileName);
1104*d415bd75Srobert return SymbolInfoTy(Addr, Name, SymType, true);
1105097a140dSpatrick } else
1106097a140dSpatrick return SymbolInfoTy(Addr, Name,
1107*d415bd75Srobert Obj.isELF() ? getElfSymbolType(Obj, Symbol)
1108097a140dSpatrick : (uint8_t)ELF::STT_NOTYPE);
1109097a140dSpatrick }
1110097a140dSpatrick
createDummySymbolInfo(const ObjectFile & Obj,const uint64_t Addr,StringRef & Name,uint8_t Type)1111*d415bd75Srobert static SymbolInfoTy createDummySymbolInfo(const ObjectFile &Obj,
1112097a140dSpatrick const uint64_t Addr, StringRef &Name,
1113097a140dSpatrick uint8_t Type) {
1114*d415bd75Srobert if (Obj.isXCOFF() && SymbolDescription)
1115*d415bd75Srobert return SymbolInfoTy(Addr, Name, std::nullopt, std::nullopt, false);
1116097a140dSpatrick else
1117097a140dSpatrick return SymbolInfoTy(Addr, Name, Type);
1118097a140dSpatrick }
1119097a140dSpatrick
112073471bf0Spatrick static void
collectBBAddrMapLabels(const std::unordered_map<uint64_t,BBAddrMap> & AddrToBBAddrMap,uint64_t SectionAddr,uint64_t Start,uint64_t End,std::unordered_map<uint64_t,std::vector<std::string>> & Labels)1121*d415bd75Srobert collectBBAddrMapLabels(const std::unordered_map<uint64_t, BBAddrMap> &AddrToBBAddrMap,
1122*d415bd75Srobert uint64_t SectionAddr, uint64_t Start, uint64_t End,
1123*d415bd75Srobert std::unordered_map<uint64_t, std::vector<std::string>> &Labels) {
1124*d415bd75Srobert if (AddrToBBAddrMap.empty())
1125*d415bd75Srobert return;
1126*d415bd75Srobert Labels.clear();
1127*d415bd75Srobert uint64_t StartAddress = SectionAddr + Start;
1128*d415bd75Srobert uint64_t EndAddress = SectionAddr + End;
1129*d415bd75Srobert auto Iter = AddrToBBAddrMap.find(StartAddress);
1130*d415bd75Srobert if (Iter == AddrToBBAddrMap.end())
1131*d415bd75Srobert return;
1132*d415bd75Srobert for (unsigned I = 0, Size = Iter->second.BBEntries.size(); I < Size; ++I) {
1133*d415bd75Srobert uint64_t BBAddress = Iter->second.BBEntries[I].Offset + Iter->second.Addr;
1134*d415bd75Srobert if (BBAddress >= EndAddress)
1135*d415bd75Srobert continue;
1136*d415bd75Srobert Labels[BBAddress].push_back(("BB" + Twine(I)).str());
1137*d415bd75Srobert }
1138*d415bd75Srobert }
1139*d415bd75Srobert
collectLocalBranchTargets(ArrayRef<uint8_t> Bytes,const MCInstrAnalysis * MIA,MCDisassembler * DisAsm,MCInstPrinter * IP,const MCSubtargetInfo * STI,uint64_t SectionAddr,uint64_t Start,uint64_t End,std::unordered_map<uint64_t,std::string> & Labels)1140*d415bd75Srobert static void collectLocalBranchTargets(
1141*d415bd75Srobert ArrayRef<uint8_t> Bytes, const MCInstrAnalysis *MIA, MCDisassembler *DisAsm,
1142*d415bd75Srobert MCInstPrinter *IP, const MCSubtargetInfo *STI, uint64_t SectionAddr,
1143*d415bd75Srobert uint64_t Start, uint64_t End, std::unordered_map<uint64_t, std::string> &Labels) {
1144*d415bd75Srobert // So far only supports PowerPC and X86.
1145*d415bd75Srobert if (!STI->getTargetTriple().isPPC() && !STI->getTargetTriple().isX86())
114673471bf0Spatrick return;
114773471bf0Spatrick
114873471bf0Spatrick Labels.clear();
114973471bf0Spatrick unsigned LabelCount = 0;
115073471bf0Spatrick Start += SectionAddr;
115173471bf0Spatrick End += SectionAddr;
115273471bf0Spatrick uint64_t Index = Start;
115373471bf0Spatrick while (Index < End) {
115473471bf0Spatrick // Disassemble a real instruction and record function-local branch labels.
115573471bf0Spatrick MCInst Inst;
115673471bf0Spatrick uint64_t Size;
1157*d415bd75Srobert ArrayRef<uint8_t> ThisBytes = Bytes.slice(Index - SectionAddr);
1158*d415bd75Srobert bool Disassembled =
1159*d415bd75Srobert DisAsm->getInstruction(Inst, Size, ThisBytes, Index, nulls());
116073471bf0Spatrick if (Size == 0)
1161*d415bd75Srobert Size = std::min<uint64_t>(ThisBytes.size(),
1162*d415bd75Srobert DisAsm->suggestBytesToSkip(ThisBytes, Index));
116373471bf0Spatrick
116473471bf0Spatrick if (Disassembled && MIA) {
116573471bf0Spatrick uint64_t Target;
116673471bf0Spatrick bool TargetKnown = MIA->evaluateBranch(Inst, Index, Size, Target);
1167*d415bd75Srobert // On PowerPC, if the address of a branch is the same as the target, it
1168*d415bd75Srobert // means that it's a function call. Do not mark the label for this case.
116973471bf0Spatrick if (TargetKnown && (Target >= Start && Target < End) &&
1170*d415bd75Srobert !Labels.count(Target) &&
1171*d415bd75Srobert !(STI->getTargetTriple().isPPC() && Target == Index))
117273471bf0Spatrick Labels[Target] = ("L" + Twine(LabelCount++)).str();
117373471bf0Spatrick }
117473471bf0Spatrick Index += Size;
117573471bf0Spatrick }
117673471bf0Spatrick }
117773471bf0Spatrick
117873471bf0Spatrick // Create an MCSymbolizer for the target and add it to the MCDisassembler.
117973471bf0Spatrick // This is currently only used on AMDGPU, and assumes the format of the
118073471bf0Spatrick // void * argument passed to AMDGPU's createMCSymbolizer.
addSymbolizer(MCContext & Ctx,const Target * Target,StringRef TripleName,MCDisassembler * DisAsm,uint64_t SectionAddr,ArrayRef<uint8_t> Bytes,SectionSymbolsTy & Symbols,std::vector<std::unique_ptr<std::string>> & SynthesizedLabelNames)118173471bf0Spatrick static void addSymbolizer(
118273471bf0Spatrick MCContext &Ctx, const Target *Target, StringRef TripleName,
118373471bf0Spatrick MCDisassembler *DisAsm, uint64_t SectionAddr, ArrayRef<uint8_t> Bytes,
118473471bf0Spatrick SectionSymbolsTy &Symbols,
118573471bf0Spatrick std::vector<std::unique_ptr<std::string>> &SynthesizedLabelNames) {
118673471bf0Spatrick
118773471bf0Spatrick std::unique_ptr<MCRelocationInfo> RelInfo(
118873471bf0Spatrick Target->createMCRelocationInfo(TripleName, Ctx));
118973471bf0Spatrick if (!RelInfo)
119073471bf0Spatrick return;
119173471bf0Spatrick std::unique_ptr<MCSymbolizer> Symbolizer(Target->createMCSymbolizer(
119273471bf0Spatrick TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
119373471bf0Spatrick MCSymbolizer *SymbolizerPtr = &*Symbolizer;
119473471bf0Spatrick DisAsm->setSymbolizer(std::move(Symbolizer));
119573471bf0Spatrick
119673471bf0Spatrick if (!SymbolizeOperands)
119773471bf0Spatrick return;
119873471bf0Spatrick
119973471bf0Spatrick // Synthesize labels referenced by branch instructions by
120073471bf0Spatrick // disassembling, discarding the output, and collecting the referenced
120173471bf0Spatrick // addresses from the symbolizer.
120273471bf0Spatrick for (size_t Index = 0; Index != Bytes.size();) {
120373471bf0Spatrick MCInst Inst;
120473471bf0Spatrick uint64_t Size;
1205*d415bd75Srobert ArrayRef<uint8_t> ThisBytes = Bytes.slice(Index);
1206*d415bd75Srobert const uint64_t ThisAddr = SectionAddr + Index;
1207*d415bd75Srobert DisAsm->getInstruction(Inst, Size, ThisBytes, ThisAddr, nulls());
120873471bf0Spatrick if (Size == 0)
1209*d415bd75Srobert Size = std::min<uint64_t>(ThisBytes.size(),
1210*d415bd75Srobert DisAsm->suggestBytesToSkip(ThisBytes, Index));
121173471bf0Spatrick Index += Size;
121273471bf0Spatrick }
121373471bf0Spatrick ArrayRef<uint64_t> LabelAddrsRef = SymbolizerPtr->getReferencedAddresses();
121473471bf0Spatrick // Copy and sort to remove duplicates.
121573471bf0Spatrick std::vector<uint64_t> LabelAddrs;
121673471bf0Spatrick LabelAddrs.insert(LabelAddrs.end(), LabelAddrsRef.begin(),
121773471bf0Spatrick LabelAddrsRef.end());
121873471bf0Spatrick llvm::sort(LabelAddrs);
121973471bf0Spatrick LabelAddrs.resize(std::unique(LabelAddrs.begin(), LabelAddrs.end()) -
122073471bf0Spatrick LabelAddrs.begin());
122173471bf0Spatrick // Add the labels.
122273471bf0Spatrick for (unsigned LabelNum = 0; LabelNum != LabelAddrs.size(); ++LabelNum) {
122373471bf0Spatrick auto Name = std::make_unique<std::string>();
122473471bf0Spatrick *Name = (Twine("L") + Twine(LabelNum)).str();
122573471bf0Spatrick SynthesizedLabelNames.push_back(std::move(Name));
122673471bf0Spatrick Symbols.push_back(SymbolInfoTy(
122773471bf0Spatrick LabelAddrs[LabelNum], *SynthesizedLabelNames.back(), ELF::STT_NOTYPE));
122873471bf0Spatrick }
122973471bf0Spatrick llvm::stable_sort(Symbols);
123073471bf0Spatrick // Recreate the symbolizer with the new symbols list.
123173471bf0Spatrick RelInfo.reset(Target->createMCRelocationInfo(TripleName, Ctx));
123273471bf0Spatrick Symbolizer.reset(Target->createMCSymbolizer(
123373471bf0Spatrick TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
123473471bf0Spatrick DisAsm->setSymbolizer(std::move(Symbolizer));
123573471bf0Spatrick }
123673471bf0Spatrick
getSegmentName(const MachOObjectFile * MachO,const SectionRef & Section)123773471bf0Spatrick static StringRef getSegmentName(const MachOObjectFile *MachO,
123873471bf0Spatrick const SectionRef &Section) {
123973471bf0Spatrick if (MachO) {
124073471bf0Spatrick DataRefImpl DR = Section.getRawDataRefImpl();
124173471bf0Spatrick StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
124273471bf0Spatrick return SegmentName;
124373471bf0Spatrick }
124473471bf0Spatrick return "";
124573471bf0Spatrick }
124673471bf0Spatrick
emitPostInstructionInfo(formatted_raw_ostream & FOS,const MCAsmInfo & MAI,const MCSubtargetInfo & STI,StringRef Comments,LiveVariablePrinter & LVP)124773471bf0Spatrick static void emitPostInstructionInfo(formatted_raw_ostream &FOS,
124873471bf0Spatrick const MCAsmInfo &MAI,
124973471bf0Spatrick const MCSubtargetInfo &STI,
125073471bf0Spatrick StringRef Comments,
125173471bf0Spatrick LiveVariablePrinter &LVP) {
125273471bf0Spatrick do {
125373471bf0Spatrick if (!Comments.empty()) {
125473471bf0Spatrick // Emit a line of comments.
125573471bf0Spatrick StringRef Comment;
125673471bf0Spatrick std::tie(Comment, Comments) = Comments.split('\n');
125773471bf0Spatrick // MAI.getCommentColumn() assumes that instructions are printed at the
125873471bf0Spatrick // position of 8, while getInstStartColumn() returns the actual position.
125973471bf0Spatrick unsigned CommentColumn =
126073471bf0Spatrick MAI.getCommentColumn() - 8 + getInstStartColumn(STI);
126173471bf0Spatrick FOS.PadToColumn(CommentColumn);
126273471bf0Spatrick FOS << MAI.getCommentString() << ' ' << Comment;
126373471bf0Spatrick }
126473471bf0Spatrick LVP.printAfterInst(FOS);
126573471bf0Spatrick FOS << '\n';
126673471bf0Spatrick } while (!Comments.empty());
126773471bf0Spatrick FOS.flush();
126873471bf0Spatrick }
126973471bf0Spatrick
createFakeELFSections(ObjectFile & Obj)1270*d415bd75Srobert static void createFakeELFSections(ObjectFile &Obj) {
1271*d415bd75Srobert assert(Obj.isELF());
1272*d415bd75Srobert if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(&Obj))
1273*d415bd75Srobert Elf32LEObj->createFakeSections();
1274*d415bd75Srobert else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(&Obj))
1275*d415bd75Srobert Elf64LEObj->createFakeSections();
1276*d415bd75Srobert else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(&Obj))
1277*d415bd75Srobert Elf32BEObj->createFakeSections();
1278*d415bd75Srobert else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(&Obj))
1279*d415bd75Srobert Elf64BEObj->createFakeSections();
1280*d415bd75Srobert else
1281*d415bd75Srobert llvm_unreachable("Unsupported binary format");
1282*d415bd75Srobert }
1283*d415bd75Srobert
1284*d415bd75Srobert // Tries to fetch a more complete version of the given object file using its
1285*d415bd75Srobert // Build ID. Returns std::nullopt if nothing was found.
1286*d415bd75Srobert static std::optional<OwningBinary<Binary>>
fetchBinaryByBuildID(const ObjectFile & Obj)1287*d415bd75Srobert fetchBinaryByBuildID(const ObjectFile &Obj) {
1288*d415bd75Srobert std::optional<object::BuildIDRef> BuildID = getBuildID(&Obj);
1289*d415bd75Srobert if (!BuildID)
1290*d415bd75Srobert return std::nullopt;
1291*d415bd75Srobert std::optional<std::string> Path = BIDFetcher->fetch(*BuildID);
1292*d415bd75Srobert if (!Path)
1293*d415bd75Srobert return std::nullopt;
1294*d415bd75Srobert Expected<OwningBinary<Binary>> DebugBinary = createBinary(*Path);
1295*d415bd75Srobert if (!DebugBinary) {
1296*d415bd75Srobert reportWarning(toString(DebugBinary.takeError()), *Path);
1297*d415bd75Srobert return std::nullopt;
1298*d415bd75Srobert }
1299*d415bd75Srobert return std::move(*DebugBinary);
1300*d415bd75Srobert }
1301*d415bd75Srobert
disassembleObject(const Target * TheTarget,ObjectFile & Obj,const ObjectFile & DbgObj,MCContext & Ctx,MCDisassembler * PrimaryDisAsm,MCDisassembler * SecondaryDisAsm,const MCInstrAnalysis * MIA,MCInstPrinter * IP,const MCSubtargetInfo * PrimarySTI,const MCSubtargetInfo * SecondarySTI,PrettyPrinter & PIP,SourcePrinter & SP,bool InlineRelocs)1302*d415bd75Srobert static void disassembleObject(const Target *TheTarget, ObjectFile &Obj,
1303*d415bd75Srobert const ObjectFile &DbgObj, MCContext &Ctx,
1304*d415bd75Srobert MCDisassembler *PrimaryDisAsm,
130509467b48Spatrick MCDisassembler *SecondaryDisAsm,
130609467b48Spatrick const MCInstrAnalysis *MIA, MCInstPrinter *IP,
130709467b48Spatrick const MCSubtargetInfo *PrimarySTI,
130809467b48Spatrick const MCSubtargetInfo *SecondarySTI,
1309*d415bd75Srobert PrettyPrinter &PIP, SourcePrinter &SP,
1310*d415bd75Srobert bool InlineRelocs) {
131109467b48Spatrick const MCSubtargetInfo *STI = PrimarySTI;
131209467b48Spatrick MCDisassembler *DisAsm = PrimaryDisAsm;
131309467b48Spatrick bool PrimaryIsThumb = false;
131409467b48Spatrick if (isArmElf(Obj))
131509467b48Spatrick PrimaryIsThumb = STI->checkFeatures("+thumb-mode");
131609467b48Spatrick
131709467b48Spatrick std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
131809467b48Spatrick if (InlineRelocs)
1319*d415bd75Srobert RelocMap = getRelocsMap(Obj);
1320*d415bd75Srobert bool Is64Bits = Obj.getBytesInAddress() > 4;
132109467b48Spatrick
132209467b48Spatrick // Create a mapping from virtual address to symbol name. This is used to
132309467b48Spatrick // pretty print the symbols while disassembling.
132409467b48Spatrick std::map<SectionRef, SectionSymbolsTy> AllSymbols;
132509467b48Spatrick SectionSymbolsTy AbsoluteSymbols;
1326*d415bd75Srobert const StringRef FileName = Obj.getFileName();
1327*d415bd75Srobert const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(&Obj);
1328*d415bd75Srobert for (const SymbolRef &Symbol : Obj.symbols()) {
132973471bf0Spatrick Expected<StringRef> NameOrErr = Symbol.getName();
133073471bf0Spatrick if (!NameOrErr) {
133173471bf0Spatrick reportWarning(toString(NameOrErr.takeError()), FileName);
133273471bf0Spatrick continue;
133373471bf0Spatrick }
1334*d415bd75Srobert if (NameOrErr->empty() && !(Obj.isXCOFF() && SymbolDescription))
133509467b48Spatrick continue;
133609467b48Spatrick
1337*d415bd75Srobert if (Obj.isELF() && getElfSymbolType(Obj, Symbol) == ELF::STT_SECTION)
133809467b48Spatrick continue;
133909467b48Spatrick
134073471bf0Spatrick if (MachO) {
134173471bf0Spatrick // __mh_(execute|dylib|dylinker|bundle|preload|object)_header are special
134273471bf0Spatrick // symbols that support MachO header introspection. They do not bind to
134373471bf0Spatrick // code locations and are irrelevant for disassembly.
134473471bf0Spatrick if (NameOrErr->startswith("__mh_") && NameOrErr->endswith("_header"))
134573471bf0Spatrick continue;
134609467b48Spatrick // Don't ask a Mach-O STAB symbol for its section unless you know that
134709467b48Spatrick // STAB symbol's section field refers to a valid section index. Otherwise
134809467b48Spatrick // the symbol may error trying to load a section that does not exist.
134909467b48Spatrick DataRefImpl SymDRI = Symbol.getRawDataRefImpl();
135009467b48Spatrick uint8_t NType = (MachO->is64Bit() ?
135109467b48Spatrick MachO->getSymbol64TableEntry(SymDRI).n_type:
135209467b48Spatrick MachO->getSymbolTableEntry(SymDRI).n_type);
135309467b48Spatrick if (NType & MachO::N_STAB)
135409467b48Spatrick continue;
135509467b48Spatrick }
135609467b48Spatrick
135709467b48Spatrick section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
1358*d415bd75Srobert if (SecI != Obj.section_end())
1359097a140dSpatrick AllSymbols[*SecI].push_back(createSymbolInfo(Obj, Symbol));
136009467b48Spatrick else
1361097a140dSpatrick AbsoluteSymbols.push_back(createSymbolInfo(Obj, Symbol));
136209467b48Spatrick }
1363097a140dSpatrick
1364*d415bd75Srobert if (AllSymbols.empty() && Obj.isELF())
1365*d415bd75Srobert addDynamicElfSymbols(cast<ELFObjectFileBase>(Obj), AllSymbols);
136609467b48Spatrick
1367*d415bd75Srobert if (Obj.isWasm())
136873471bf0Spatrick addMissingWasmCodeSymbols(cast<WasmObjectFile>(Obj), AllSymbols);
136973471bf0Spatrick
1370*d415bd75Srobert if (Obj.isELF() && Obj.sections().empty())
1371*d415bd75Srobert createFakeELFSections(Obj);
1372*d415bd75Srobert
137309467b48Spatrick BumpPtrAllocator A;
137409467b48Spatrick StringSaver Saver(A);
137509467b48Spatrick addPltEntries(Obj, AllSymbols, Saver);
137609467b48Spatrick
1377097a140dSpatrick // Create a mapping from virtual address to section. An empty section can
1378097a140dSpatrick // cause more than one section at the same address. Sort such sections to be
1379097a140dSpatrick // before same-addressed non-empty sections so that symbol lookups prefer the
1380097a140dSpatrick // non-empty section.
138109467b48Spatrick std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1382*d415bd75Srobert for (SectionRef Sec : Obj.sections())
138309467b48Spatrick SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1384097a140dSpatrick llvm::stable_sort(SectionAddresses, [](const auto &LHS, const auto &RHS) {
1385097a140dSpatrick if (LHS.first != RHS.first)
1386097a140dSpatrick return LHS.first < RHS.first;
1387097a140dSpatrick return LHS.second.getSize() < RHS.second.getSize();
1388097a140dSpatrick });
138909467b48Spatrick
139009467b48Spatrick // Linked executables (.exe and .dll files) typically don't include a real
139109467b48Spatrick // symbol table but they might contain an export table.
1392*d415bd75Srobert if (const auto *COFFObj = dyn_cast<COFFObjectFile>(&Obj)) {
139309467b48Spatrick for (const auto &ExportEntry : COFFObj->export_directories()) {
139409467b48Spatrick StringRef Name;
1395097a140dSpatrick if (Error E = ExportEntry.getSymbolName(Name))
1396*d415bd75Srobert reportError(std::move(E), Obj.getFileName());
139709467b48Spatrick if (Name.empty())
139809467b48Spatrick continue;
139909467b48Spatrick
140009467b48Spatrick uint32_t RVA;
1401097a140dSpatrick if (Error E = ExportEntry.getExportRVA(RVA))
1402*d415bd75Srobert reportError(std::move(E), Obj.getFileName());
140309467b48Spatrick
140409467b48Spatrick uint64_t VA = COFFObj->getImageBase() + RVA;
140509467b48Spatrick auto Sec = partition_point(
140609467b48Spatrick SectionAddresses, [VA](const std::pair<uint64_t, SectionRef> &O) {
140709467b48Spatrick return O.first <= VA;
140809467b48Spatrick });
140909467b48Spatrick if (Sec != SectionAddresses.begin()) {
141009467b48Spatrick --Sec;
141109467b48Spatrick AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
141209467b48Spatrick } else
141309467b48Spatrick AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
141409467b48Spatrick }
141509467b48Spatrick }
141609467b48Spatrick
141709467b48Spatrick // Sort all the symbols, this allows us to use a simple binary search to find
1418097a140dSpatrick // Multiple symbols can have the same address. Use a stable sort to stabilize
1419097a140dSpatrick // the output.
1420097a140dSpatrick StringSet<> FoundDisasmSymbolSet;
142109467b48Spatrick for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
142273471bf0Spatrick llvm::stable_sort(SecSyms.second);
142373471bf0Spatrick llvm::stable_sort(AbsoluteSymbols);
1424097a140dSpatrick
1425097a140dSpatrick std::unique_ptr<DWARFContext> DICtx;
1426097a140dSpatrick LiveVariablePrinter LVP(*Ctx.getRegisterInfo(), *STI);
1427097a140dSpatrick
1428097a140dSpatrick if (DbgVariables != DVDisabled) {
1429*d415bd75Srobert DICtx = DWARFContext::create(DbgObj);
1430097a140dSpatrick for (const std::unique_ptr<DWARFUnit> &CU : DICtx->compile_units())
1431097a140dSpatrick LVP.addCompileUnit(CU->getUnitDIE(false));
1432097a140dSpatrick }
1433097a140dSpatrick
1434097a140dSpatrick LLVM_DEBUG(LVP.dump());
143509467b48Spatrick
1436*d415bd75Srobert std::unordered_map<uint64_t, BBAddrMap> AddrToBBAddrMap;
1437*d415bd75Srobert auto ReadBBAddrMap = [&](std::optional<unsigned> SectionIndex =
1438*d415bd75Srobert std::nullopt) {
1439*d415bd75Srobert AddrToBBAddrMap.clear();
1440*d415bd75Srobert if (const auto *Elf = dyn_cast<ELFObjectFileBase>(&Obj)) {
1441*d415bd75Srobert auto BBAddrMapsOrErr = Elf->readBBAddrMap(SectionIndex);
1442*d415bd75Srobert if (!BBAddrMapsOrErr)
1443*d415bd75Srobert reportWarning(toString(BBAddrMapsOrErr.takeError()), Obj.getFileName());
1444*d415bd75Srobert for (auto &FunctionBBAddrMap : *BBAddrMapsOrErr)
1445*d415bd75Srobert AddrToBBAddrMap.emplace(FunctionBBAddrMap.Addr,
1446*d415bd75Srobert std::move(FunctionBBAddrMap));
1447*d415bd75Srobert }
1448*d415bd75Srobert };
1449*d415bd75Srobert
1450*d415bd75Srobert // For non-relocatable objects, Read all LLVM_BB_ADDR_MAP sections into a
1451*d415bd75Srobert // single mapping, since they don't have any conflicts.
1452*d415bd75Srobert if (SymbolizeOperands && !Obj.isRelocatableObject())
1453*d415bd75Srobert ReadBBAddrMap();
1454*d415bd75Srobert
1455*d415bd75Srobert for (const SectionRef &Section : ToolSectionFilter(Obj)) {
145609467b48Spatrick if (FilterSections.empty() && !DisassembleAll &&
145709467b48Spatrick (!Section.isText() || Section.isVirtual()))
145809467b48Spatrick continue;
145909467b48Spatrick
146009467b48Spatrick uint64_t SectionAddr = Section.getAddress();
146109467b48Spatrick uint64_t SectSize = Section.getSize();
146209467b48Spatrick if (!SectSize)
146309467b48Spatrick continue;
146409467b48Spatrick
1465*d415bd75Srobert // For relocatable object files, read the LLVM_BB_ADDR_MAP section
1466*d415bd75Srobert // corresponding to this section, if present.
1467*d415bd75Srobert if (SymbolizeOperands && Obj.isRelocatableObject())
1468*d415bd75Srobert ReadBBAddrMap(Section.getIndex());
1469*d415bd75Srobert
147009467b48Spatrick // Get the list of all the symbols in this section.
147109467b48Spatrick SectionSymbolsTy &Symbols = AllSymbols[Section];
147209467b48Spatrick std::vector<MappingSymbolPair> MappingSymbols;
147309467b48Spatrick if (hasMappingSymbols(Obj)) {
147409467b48Spatrick for (const auto &Symb : Symbols) {
1475097a140dSpatrick uint64_t Address = Symb.Addr;
1476097a140dSpatrick StringRef Name = Symb.Name;
147709467b48Spatrick if (Name.startswith("$d"))
147809467b48Spatrick MappingSymbols.emplace_back(Address - SectionAddr, 'd');
147909467b48Spatrick if (Name.startswith("$x"))
148009467b48Spatrick MappingSymbols.emplace_back(Address - SectionAddr, 'x');
148109467b48Spatrick if (Name.startswith("$a"))
148209467b48Spatrick MappingSymbols.emplace_back(Address - SectionAddr, 'a');
148309467b48Spatrick if (Name.startswith("$t"))
148409467b48Spatrick MappingSymbols.emplace_back(Address - SectionAddr, 't');
148509467b48Spatrick }
148609467b48Spatrick }
148709467b48Spatrick
148809467b48Spatrick llvm::sort(MappingSymbols);
148909467b48Spatrick
149073471bf0Spatrick ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(
1491*d415bd75Srobert unwrapOrError(Section.getContents(), Obj.getFileName()));
149273471bf0Spatrick
149373471bf0Spatrick std::vector<std::unique_ptr<std::string>> SynthesizedLabelNames;
1494*d415bd75Srobert if (Obj.isELF() && Obj.getArch() == Triple::amdgcn) {
149509467b48Spatrick // AMDGPU disassembler uses symbolizer for printing labels
149673471bf0Spatrick addSymbolizer(Ctx, TheTarget, TripleName, DisAsm, SectionAddr, Bytes,
149773471bf0Spatrick Symbols, SynthesizedLabelNames);
149809467b48Spatrick }
149909467b48Spatrick
150073471bf0Spatrick StringRef SegmentName = getSegmentName(MachO, Section);
1501*d415bd75Srobert StringRef SectionName = unwrapOrError(Section.getName(), Obj.getFileName());
150209467b48Spatrick // If the section has no symbol at the start, just insert a dummy one.
1503097a140dSpatrick if (Symbols.empty() || Symbols[0].Addr != 0) {
1504097a140dSpatrick Symbols.insert(Symbols.begin(),
1505097a140dSpatrick createDummySymbolInfo(Obj, SectionAddr, SectionName,
1506097a140dSpatrick Section.isText() ? ELF::STT_FUNC
1507097a140dSpatrick : ELF::STT_OBJECT));
150809467b48Spatrick }
150909467b48Spatrick
151009467b48Spatrick SmallString<40> Comments;
151109467b48Spatrick raw_svector_ostream CommentStream(Comments);
151209467b48Spatrick
151309467b48Spatrick uint64_t VMAAdjustment = 0;
151409467b48Spatrick if (shouldAdjustVA(Section))
151509467b48Spatrick VMAAdjustment = AdjustVMA;
151609467b48Spatrick
151773471bf0Spatrick // In executable and shared objects, r_offset holds a virtual address.
151873471bf0Spatrick // Subtract SectionAddr from the r_offset field of a relocation to get
151973471bf0Spatrick // the section offset.
1520*d415bd75Srobert uint64_t RelAdjustment = Obj.isRelocatableObject() ? 0 : SectionAddr;
152109467b48Spatrick uint64_t Size;
152209467b48Spatrick uint64_t Index;
152309467b48Spatrick bool PrintedSection = false;
152409467b48Spatrick std::vector<RelocationRef> Rels = RelocMap[Section];
152509467b48Spatrick std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
152609467b48Spatrick std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
152709467b48Spatrick
1528*d415bd75Srobert // Loop over each chunk of code between two points where at least
1529*d415bd75Srobert // one symbol is defined.
1530*d415bd75Srobert for (size_t SI = 0, SE = Symbols.size(); SI != SE;) {
1531*d415bd75Srobert // Advance SI past all the symbols starting at the same address,
1532*d415bd75Srobert // and make an ArrayRef of them.
1533*d415bd75Srobert unsigned FirstSI = SI;
1534097a140dSpatrick uint64_t Start = Symbols[SI].Addr;
1535*d415bd75Srobert ArrayRef<SymbolInfoTy> SymbolsHere;
1536*d415bd75Srobert while (SI != SE && Symbols[SI].Addr == Start)
1537*d415bd75Srobert ++SI;
1538*d415bd75Srobert SymbolsHere = ArrayRef<SymbolInfoTy>(&Symbols[FirstSI], SI - FirstSI);
1539*d415bd75Srobert
1540*d415bd75Srobert // Get the demangled names of all those symbols. We end up with a vector
1541*d415bd75Srobert // of StringRef that holds the names we're going to use, and a vector of
1542*d415bd75Srobert // std::string that stores the new strings returned by demangle(), if
1543*d415bd75Srobert // any. If we don't call demangle() then that vector can stay empty.
1544*d415bd75Srobert std::vector<StringRef> SymNamesHere;
1545*d415bd75Srobert std::vector<std::string> DemangledSymNamesHere;
1546*d415bd75Srobert if (Demangle) {
1547*d415bd75Srobert // Fetch the demangled names and store them locally.
1548*d415bd75Srobert for (const SymbolInfoTy &Symbol : SymbolsHere)
1549*d415bd75Srobert DemangledSymNamesHere.push_back(demangle(Symbol.Name.str()));
1550*d415bd75Srobert // Now we've finished modifying that vector, it's safe to make
1551*d415bd75Srobert // a vector of StringRefs pointing into it.
1552*d415bd75Srobert SymNamesHere.insert(SymNamesHere.begin(), DemangledSymNamesHere.begin(),
1553*d415bd75Srobert DemangledSymNamesHere.end());
1554*d415bd75Srobert } else {
1555*d415bd75Srobert for (const SymbolInfoTy &Symbol : SymbolsHere)
1556*d415bd75Srobert SymNamesHere.push_back(Symbol.Name);
1557*d415bd75Srobert }
1558*d415bd75Srobert
1559*d415bd75Srobert // Distinguish ELF data from code symbols, which will be used later on to
1560*d415bd75Srobert // decide whether to 'disassemble' this chunk as a data declaration via
1561*d415bd75Srobert // dumpELFData(), or whether to treat it as code.
1562*d415bd75Srobert //
1563*d415bd75Srobert // If data _and_ code symbols are defined at the same address, the code
1564*d415bd75Srobert // takes priority, on the grounds that disassembling code is our main
1565*d415bd75Srobert // purpose here, and it would be a worse failure to _not_ interpret
1566*d415bd75Srobert // something that _was_ meaningful as code than vice versa.
1567*d415bd75Srobert //
1568*d415bd75Srobert // Any ELF symbol type that is not clearly data will be regarded as code.
1569*d415bd75Srobert // In particular, one of the uses of STT_NOTYPE is for branch targets
1570*d415bd75Srobert // inside functions, for which STT_FUNC would be inaccurate.
1571*d415bd75Srobert //
1572*d415bd75Srobert // So here, we spot whether there's any non-data symbol present at all,
1573*d415bd75Srobert // and only set the DisassembleAsData flag if there isn't. Also, we use
1574*d415bd75Srobert // this distinction to inform the decision of which symbol to print at
1575*d415bd75Srobert // the head of the section, so that if we're printing code, we print a
1576*d415bd75Srobert // code-related symbol name to go with it.
1577*d415bd75Srobert bool DisassembleAsData = false;
1578*d415bd75Srobert size_t DisplaySymIndex = SymbolsHere.size() - 1;
1579*d415bd75Srobert if (Obj.isELF() && !DisassembleAll && Section.isText()) {
1580*d415bd75Srobert DisassembleAsData = true; // unless we find a code symbol below
1581*d415bd75Srobert
1582*d415bd75Srobert for (size_t i = 0; i < SymbolsHere.size(); ++i) {
1583*d415bd75Srobert uint8_t SymTy = SymbolsHere[i].Type;
1584*d415bd75Srobert if (SymTy != ELF::STT_OBJECT && SymTy != ELF::STT_COMMON) {
1585*d415bd75Srobert DisassembleAsData = false;
1586*d415bd75Srobert DisplaySymIndex = i;
1587*d415bd75Srobert }
1588*d415bd75Srobert }
1589*d415bd75Srobert }
1590*d415bd75Srobert
1591*d415bd75Srobert // Decide which symbol(s) from this collection we're going to print.
1592*d415bd75Srobert std::vector<bool> SymsToPrint(SymbolsHere.size(), false);
1593*d415bd75Srobert // If the user has given the --disassemble-symbols option, then we must
1594*d415bd75Srobert // display every symbol in that set, and no others.
1595*d415bd75Srobert if (!DisasmSymbolSet.empty()) {
1596*d415bd75Srobert bool FoundAny = false;
1597*d415bd75Srobert for (size_t i = 0; i < SymbolsHere.size(); ++i) {
1598*d415bd75Srobert if (DisasmSymbolSet.count(SymNamesHere[i])) {
1599*d415bd75Srobert SymsToPrint[i] = true;
1600*d415bd75Srobert FoundAny = true;
1601*d415bd75Srobert }
1602*d415bd75Srobert }
1603*d415bd75Srobert
1604*d415bd75Srobert // And if none of the symbols here is one that the user asked for, skip
1605*d415bd75Srobert // disassembling this entire chunk of code.
1606*d415bd75Srobert if (!FoundAny)
1607*d415bd75Srobert continue;
1608*d415bd75Srobert } else {
1609*d415bd75Srobert // Otherwise, print whichever symbol at this location is last in the
1610*d415bd75Srobert // Symbols array, because that array is pre-sorted in a way intended to
1611*d415bd75Srobert // correlate with priority of which symbol to display.
1612*d415bd75Srobert SymsToPrint[DisplaySymIndex] = true;
1613*d415bd75Srobert }
1614*d415bd75Srobert
1615*d415bd75Srobert // Now that we know we're disassembling this section, override the choice
1616*d415bd75Srobert // of which symbols to display by printing _all_ of them at this address
1617*d415bd75Srobert // if the user asked for all symbols.
1618*d415bd75Srobert //
1619*d415bd75Srobert // That way, '--show-all-symbols --disassemble-symbol=foo' will print
1620*d415bd75Srobert // only the chunk of code headed by 'foo', but also show any other
1621*d415bd75Srobert // symbols defined at that address, such as aliases for 'foo', or the ARM
1622*d415bd75Srobert // mapping symbol preceding its code.
1623*d415bd75Srobert if (ShowAllSymbols) {
1624*d415bd75Srobert for (size_t i = 0; i < SymbolsHere.size(); ++i)
1625*d415bd75Srobert SymsToPrint[i] = true;
1626*d415bd75Srobert }
1627*d415bd75Srobert
162809467b48Spatrick if (Start < SectionAddr || StopAddress <= Start)
162909467b48Spatrick continue;
1630*d415bd75Srobert
1631*d415bd75Srobert for (size_t i = 0; i < SymbolsHere.size(); ++i)
1632*d415bd75Srobert FoundDisasmSymbolSet.insert(SymNamesHere[i]);
163309467b48Spatrick
163409467b48Spatrick // The end is the section end, the beginning of the next symbol, or
163509467b48Spatrick // --stop-address.
163609467b48Spatrick uint64_t End = std::min<uint64_t>(SectionAddr + SectSize, StopAddress);
1637*d415bd75Srobert if (SI < SE)
1638*d415bd75Srobert End = std::min(End, Symbols[SI].Addr);
163909467b48Spatrick if (Start >= End || End <= StartAddress)
164009467b48Spatrick continue;
164109467b48Spatrick Start -= SectionAddr;
164209467b48Spatrick End -= SectionAddr;
164309467b48Spatrick
164409467b48Spatrick if (!PrintedSection) {
164509467b48Spatrick PrintedSection = true;
164609467b48Spatrick outs() << "\nDisassembly of section ";
164709467b48Spatrick if (!SegmentName.empty())
164809467b48Spatrick outs() << SegmentName << ",";
164909467b48Spatrick outs() << SectionName << ":\n";
165009467b48Spatrick }
165109467b48Spatrick
165209467b48Spatrick outs() << '\n';
1653*d415bd75Srobert
1654*d415bd75Srobert for (size_t i = 0; i < SymbolsHere.size(); ++i) {
1655*d415bd75Srobert if (!SymsToPrint[i])
1656*d415bd75Srobert continue;
1657*d415bd75Srobert
1658*d415bd75Srobert const SymbolInfoTy &Symbol = SymbolsHere[i];
1659*d415bd75Srobert const StringRef SymbolName = SymNamesHere[i];
1660*d415bd75Srobert
166173471bf0Spatrick if (LeadingAddr)
166209467b48Spatrick outs() << format(Is64Bits ? "%016" PRIx64 " " : "%08" PRIx64 " ",
166309467b48Spatrick SectionAddr + Start + VMAAdjustment);
1664*d415bd75Srobert if (Obj.isXCOFF() && SymbolDescription) {
1665*d415bd75Srobert outs() << getXCOFFSymbolDescription(Symbol, SymbolName) << ":\n";
1666097a140dSpatrick } else
1667097a140dSpatrick outs() << '<' << SymbolName << ">:\n";
1668*d415bd75Srobert }
166909467b48Spatrick
167009467b48Spatrick // Don't print raw contents of a virtual section. A virtual section
167109467b48Spatrick // doesn't have any contents in the file.
167209467b48Spatrick if (Section.isVirtual()) {
167309467b48Spatrick outs() << "...\n";
167409467b48Spatrick continue;
167509467b48Spatrick }
167609467b48Spatrick
1677*d415bd75Srobert // See if any of the symbols defined at this location triggers target-
1678*d415bd75Srobert // specific disassembly behavior, e.g. of special descriptors or function
1679*d415bd75Srobert // prelude information.
1680*d415bd75Srobert //
1681*d415bd75Srobert // We stop this loop at the first symbol that triggers some kind of
1682*d415bd75Srobert // interesting behavior (if any), on the assumption that if two symbols
1683*d415bd75Srobert // defined at the same address trigger two conflicting symbol handlers,
1684*d415bd75Srobert // the object file is probably confused anyway, and it would make even
1685*d415bd75Srobert // less sense to present the output of _both_ handlers, because that
1686*d415bd75Srobert // would describe the same data twice.
1687*d415bd75Srobert for (size_t SHI = 0; SHI < SymbolsHere.size(); ++SHI) {
1688*d415bd75Srobert SymbolInfoTy Symbol = SymbolsHere[SHI];
1689*d415bd75Srobert
1690*d415bd75Srobert auto Status =
1691*d415bd75Srobert DisAsm->onSymbolStart(Symbol, Size, Bytes.slice(Start, End - Start),
169209467b48Spatrick SectionAddr + Start, CommentStream);
1693*d415bd75Srobert
1694*d415bd75Srobert if (!Status) {
1695*d415bd75Srobert // If onSymbolStart returns std::nullopt, that means it didn't trigger
1696*d415bd75Srobert // any interesting handling for this symbol. Try the other symbols
1697*d415bd75Srobert // defined at this address.
1698*d415bd75Srobert continue;
1699*d415bd75Srobert }
1700*d415bd75Srobert
1701*d415bd75Srobert if (*Status == MCDisassembler::Fail) {
1702*d415bd75Srobert // If onSymbolStart returns Fail, that means it identified some kind
1703*d415bd75Srobert // of special data at this address, but wasn't able to disassemble it
1704*d415bd75Srobert // meaningfully. So we fall back to disassembling the failed region
1705*d415bd75Srobert // as bytes, assuming that the target detected the failure before
1706*d415bd75Srobert // printing anything.
1707097a140dSpatrick //
1708*d415bd75Srobert // Return values Success or SoftFail (i.e no 'real' failure) are
1709*d415bd75Srobert // expected to mean that the target has emitted its own output.
1710097a140dSpatrick //
1711*d415bd75Srobert // Either way, 'Size' will have been set to the amount of data
1712*d415bd75Srobert // covered by whatever prologue the target identified. So we advance
1713*d415bd75Srobert // our own position to beyond that. Sometimes that will be the entire
1714*d415bd75Srobert // distance to the next symbol, and sometimes it will be just a
1715*d415bd75Srobert // prologue and we should start disassembling instructions from where
1716*d415bd75Srobert // it left off.
1717*d415bd75Srobert outs() << "// Error in decoding " << SymNamesHere[SHI]
1718097a140dSpatrick << " : Decoding failed region as bytes.\n";
1719097a140dSpatrick for (uint64_t I = 0; I < Size; ++I) {
1720097a140dSpatrick outs() << "\t.byte\t " << format_hex(Bytes[I], 1, /*Upper=*/true)
1721097a140dSpatrick << "\n";
1722097a140dSpatrick }
1723097a140dSpatrick }
172409467b48Spatrick Start += Size;
1725*d415bd75Srobert break;
1726*d415bd75Srobert }
172709467b48Spatrick
172809467b48Spatrick Index = Start;
172909467b48Spatrick if (SectionAddr < StartAddress)
173009467b48Spatrick Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
173109467b48Spatrick
1732*d415bd75Srobert if (DisassembleAsData) {
173309467b48Spatrick dumpELFData(SectionAddr, Index, End, Bytes);
173409467b48Spatrick Index = End;
1735*d415bd75Srobert continue;
173609467b48Spatrick }
173709467b48Spatrick
1738097a140dSpatrick bool DumpARMELFData = false;
1739097a140dSpatrick formatted_raw_ostream FOS(outs());
174073471bf0Spatrick
174173471bf0Spatrick std::unordered_map<uint64_t, std::string> AllLabels;
1742*d415bd75Srobert std::unordered_map<uint64_t, std::vector<std::string>> BBAddrMapLabels;
1743*d415bd75Srobert if (SymbolizeOperands) {
174473471bf0Spatrick collectLocalBranchTargets(Bytes, MIA, DisAsm, IP, PrimarySTI,
174573471bf0Spatrick SectionAddr, Index, End, AllLabels);
1746*d415bd75Srobert collectBBAddrMapLabels(AddrToBBAddrMap, SectionAddr, Index, End,
1747*d415bd75Srobert BBAddrMapLabels);
1748*d415bd75Srobert }
174973471bf0Spatrick
175009467b48Spatrick while (Index < End) {
175109467b48Spatrick // ARM and AArch64 ELF binaries can interleave data and text in the
175209467b48Spatrick // same section. We rely on the markers introduced to understand what
175309467b48Spatrick // we need to dump. If the data marker is within a function, it is
175409467b48Spatrick // denoted as a word/short etc.
1755*d415bd75Srobert if (!MappingSymbols.empty()) {
1756097a140dSpatrick char Kind = getMappingSymbolKind(MappingSymbols, Index);
1757097a140dSpatrick DumpARMELFData = Kind == 'd';
1758097a140dSpatrick if (SecondarySTI) {
1759097a140dSpatrick if (Kind == 'a') {
1760097a140dSpatrick STI = PrimaryIsThumb ? SecondarySTI : PrimarySTI;
1761097a140dSpatrick DisAsm = PrimaryIsThumb ? SecondaryDisAsm : PrimaryDisAsm;
1762097a140dSpatrick } else if (Kind == 't') {
1763097a140dSpatrick STI = PrimaryIsThumb ? PrimarySTI : SecondarySTI;
1764097a140dSpatrick DisAsm = PrimaryIsThumb ? PrimaryDisAsm : SecondaryDisAsm;
1765097a140dSpatrick }
1766097a140dSpatrick }
176709467b48Spatrick }
176809467b48Spatrick
1769097a140dSpatrick if (DumpARMELFData) {
1770097a140dSpatrick Size = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
1771*d415bd75Srobert MappingSymbols, *STI, FOS);
1772097a140dSpatrick } else {
177309467b48Spatrick // When -z or --disassemble-zeroes are given we always dissasemble
177409467b48Spatrick // them. Otherwise we might want to skip zero bytes we see.
177509467b48Spatrick if (!DisassembleZeroes) {
177609467b48Spatrick uint64_t MaxOffset = End - Index;
1777097a140dSpatrick // For --reloc: print zero blocks patched by relocations, so that
177809467b48Spatrick // relocations can be shown in the dump.
177909467b48Spatrick if (RelCur != RelEnd)
178073471bf0Spatrick MaxOffset = std::min(RelCur->getOffset() - RelAdjustment - Index,
178173471bf0Spatrick MaxOffset);
178209467b48Spatrick
178309467b48Spatrick if (size_t N =
178409467b48Spatrick countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
1785097a140dSpatrick FOS << "\t\t..." << '\n';
178609467b48Spatrick Index += N;
178709467b48Spatrick continue;
178809467b48Spatrick }
178909467b48Spatrick }
179009467b48Spatrick
179173471bf0Spatrick // Print local label if there's any.
1792*d415bd75Srobert auto Iter1 = BBAddrMapLabels.find(SectionAddr + Index);
1793*d415bd75Srobert if (Iter1 != BBAddrMapLabels.end()) {
1794*d415bd75Srobert for (StringRef Label : Iter1->second)
1795*d415bd75Srobert FOS << "<" << Label << ">:\n";
1796*d415bd75Srobert } else {
1797*d415bd75Srobert auto Iter2 = AllLabels.find(SectionAddr + Index);
1798*d415bd75Srobert if (Iter2 != AllLabels.end())
1799*d415bd75Srobert FOS << "<" << Iter2->second << ">:\n";
1800*d415bd75Srobert }
180173471bf0Spatrick
180209467b48Spatrick // Disassemble a real instruction or a data when disassemble all is
180309467b48Spatrick // provided
180409467b48Spatrick MCInst Inst;
1805*d415bd75Srobert ArrayRef<uint8_t> ThisBytes = Bytes.slice(Index);
1806*d415bd75Srobert uint64_t ThisAddr = SectionAddr + Index;
1807*d415bd75Srobert bool Disassembled = DisAsm->getInstruction(Inst, Size, ThisBytes,
1808*d415bd75Srobert ThisAddr, CommentStream);
180909467b48Spatrick if (Size == 0)
1810*d415bd75Srobert Size = std::min<uint64_t>(
1811*d415bd75Srobert ThisBytes.size(),
1812*d415bd75Srobert DisAsm->suggestBytesToSkip(ThisBytes, ThisAddr));
181309467b48Spatrick
1814097a140dSpatrick LVP.update({Index, Section.getIndex()},
1815097a140dSpatrick {Index + Size, Section.getIndex()}, Index + Size != End);
1816097a140dSpatrick
181773471bf0Spatrick IP->setCommentStream(CommentStream);
181873471bf0Spatrick
1819097a140dSpatrick PIP.printInst(
1820097a140dSpatrick *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
1821097a140dSpatrick {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, FOS,
1822*d415bd75Srobert "", *STI, &SP, Obj.getFileName(), &Rels, LVP);
182373471bf0Spatrick
182473471bf0Spatrick IP->setCommentStream(llvm::nulls());
182509467b48Spatrick
1826097a140dSpatrick // If disassembly has failed, avoid analysing invalid/incomplete
1827097a140dSpatrick // instruction information. Otherwise, try to resolve the target
1828097a140dSpatrick // address (jump target or memory operand address) and print it on the
1829097a140dSpatrick // right of the instruction.
1830097a140dSpatrick if (Disassembled && MIA) {
183173471bf0Spatrick // Branch targets are printed just after the instructions.
183273471bf0Spatrick llvm::raw_ostream *TargetOS = &FOS;
183309467b48Spatrick uint64_t Target;
1834097a140dSpatrick bool PrintTarget =
1835097a140dSpatrick MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target);
1836097a140dSpatrick if (!PrintTarget)
1837*d415bd75Srobert if (std::optional<uint64_t> MaybeTarget =
1838097a140dSpatrick MIA->evaluateMemoryOperandAddress(
1839*d415bd75Srobert Inst, STI, SectionAddr + Index, Size)) {
1840097a140dSpatrick Target = *MaybeTarget;
1841097a140dSpatrick PrintTarget = true;
184273471bf0Spatrick // Do not print real address when symbolizing.
184373471bf0Spatrick if (!SymbolizeOperands) {
184473471bf0Spatrick // Memory operand addresses are printed as comments.
184573471bf0Spatrick TargetOS = &CommentStream;
184673471bf0Spatrick *TargetOS << "0x" << Twine::utohexstr(Target);
184773471bf0Spatrick }
1848097a140dSpatrick }
1849097a140dSpatrick if (PrintTarget) {
185009467b48Spatrick // In a relocatable object, the target's section must reside in
185109467b48Spatrick // the same section as the call instruction or it is accessed
185209467b48Spatrick // through a relocation.
185309467b48Spatrick //
185409467b48Spatrick // In a non-relocatable object, the target may be in any section.
1855097a140dSpatrick // In that case, locate the section(s) containing the target
1856097a140dSpatrick // address and find the symbol in one of those, if possible.
185709467b48Spatrick //
185809467b48Spatrick // N.B. We don't walk the relocations in the relocatable case yet.
1859097a140dSpatrick std::vector<const SectionSymbolsTy *> TargetSectionSymbols;
1860*d415bd75Srobert if (!Obj.isRelocatableObject()) {
1861097a140dSpatrick auto It = llvm::partition_point(
186209467b48Spatrick SectionAddresses,
186309467b48Spatrick [=](const std::pair<uint64_t, SectionRef> &O) {
186409467b48Spatrick return O.first <= Target;
186509467b48Spatrick });
1866097a140dSpatrick uint64_t TargetSecAddr = 0;
1867097a140dSpatrick while (It != SectionAddresses.begin()) {
186809467b48Spatrick --It;
1869097a140dSpatrick if (TargetSecAddr == 0)
1870097a140dSpatrick TargetSecAddr = It->first;
1871097a140dSpatrick if (It->first != TargetSecAddr)
1872097a140dSpatrick break;
1873097a140dSpatrick TargetSectionSymbols.push_back(&AllSymbols[It->second]);
1874097a140dSpatrick }
187509467b48Spatrick } else {
1876097a140dSpatrick TargetSectionSymbols.push_back(&Symbols);
1877097a140dSpatrick }
1878097a140dSpatrick TargetSectionSymbols.push_back(&AbsoluteSymbols);
1879097a140dSpatrick
1880097a140dSpatrick // Find the last symbol in the first candidate section whose
1881097a140dSpatrick // offset is less than or equal to the target. If there are no
1882097a140dSpatrick // such symbols, try in the next section and so on, before finally
1883097a140dSpatrick // using the nearest preceding absolute symbol (if any), if there
1884097a140dSpatrick // are no other valid symbols.
1885097a140dSpatrick const SymbolInfoTy *TargetSym = nullptr;
1886097a140dSpatrick for (const SectionSymbolsTy *TargetSymbols :
1887097a140dSpatrick TargetSectionSymbols) {
1888097a140dSpatrick auto It = llvm::partition_point(
1889097a140dSpatrick *TargetSymbols,
1890097a140dSpatrick [=](const SymbolInfoTy &O) { return O.Addr <= Target; });
1891*d415bd75Srobert while (It != TargetSymbols->begin()) {
1892*d415bd75Srobert --It;
1893*d415bd75Srobert // Skip mapping symbols to avoid possible ambiguity as they
1894*d415bd75Srobert // do not allow uniquely identifying the target address.
1895*d415bd75Srobert if (!hasMappingSymbols(Obj) || !isMappingSymbol(*It)) {
1896*d415bd75Srobert TargetSym = &*It;
1897097a140dSpatrick break;
189809467b48Spatrick }
189909467b48Spatrick }
1900*d415bd75Srobert if (TargetSym)
1901*d415bd75Srobert break;
1902*d415bd75Srobert }
190309467b48Spatrick
190473471bf0Spatrick // Print the labels corresponding to the target if there's any.
1905*d415bd75Srobert bool BBAddrMapLabelAvailable = BBAddrMapLabels.count(Target);
190673471bf0Spatrick bool LabelAvailable = AllLabels.count(Target);
1907097a140dSpatrick if (TargetSym != nullptr) {
1908097a140dSpatrick uint64_t TargetAddress = TargetSym->Addr;
190973471bf0Spatrick uint64_t Disp = Target - TargetAddress;
1910097a140dSpatrick std::string TargetName = TargetSym->Name.str();
1911097a140dSpatrick if (Demangle)
1912097a140dSpatrick TargetName = demangle(TargetName);
1913097a140dSpatrick
191473471bf0Spatrick *TargetOS << " <";
191573471bf0Spatrick if (!Disp) {
191673471bf0Spatrick // Always Print the binary symbol precisely corresponding to
191773471bf0Spatrick // the target address.
191873471bf0Spatrick *TargetOS << TargetName;
1919*d415bd75Srobert } else if (BBAddrMapLabelAvailable) {
1920*d415bd75Srobert *TargetOS << BBAddrMapLabels[Target].front();
1921*d415bd75Srobert } else if (LabelAvailable) {
1922*d415bd75Srobert *TargetOS << AllLabels[Target];
1923*d415bd75Srobert } else {
192473471bf0Spatrick // Always Print the binary symbol plus an offset if there's no
192573471bf0Spatrick // local label corresponding to the target address.
192673471bf0Spatrick *TargetOS << TargetName << "+0x" << Twine::utohexstr(Disp);
192709467b48Spatrick }
192873471bf0Spatrick *TargetOS << ">";
1929*d415bd75Srobert } else if (BBAddrMapLabelAvailable) {
1930*d415bd75Srobert *TargetOS << " <" << BBAddrMapLabels[Target].front() << ">";
193173471bf0Spatrick } else if (LabelAvailable) {
193273471bf0Spatrick *TargetOS << " <" << AllLabels[Target] << ">";
193373471bf0Spatrick }
193473471bf0Spatrick // By convention, each record in the comment stream should be
193573471bf0Spatrick // terminated.
193673471bf0Spatrick if (TargetOS == &CommentStream)
193773471bf0Spatrick *TargetOS << "\n";
193809467b48Spatrick }
193909467b48Spatrick }
1940097a140dSpatrick }
1941097a140dSpatrick
194273471bf0Spatrick assert(Ctx.getAsmInfo());
194373471bf0Spatrick emitPostInstructionInfo(FOS, *Ctx.getAsmInfo(), *STI,
194473471bf0Spatrick CommentStream.str(), LVP);
194573471bf0Spatrick Comments.clear();
194609467b48Spatrick
194709467b48Spatrick // Hexagon does this in pretty printer
1948*d415bd75Srobert if (Obj.getArch() != Triple::hexagon) {
1949097a140dSpatrick // Print relocation for instruction and data.
195009467b48Spatrick while (RelCur != RelEnd) {
195173471bf0Spatrick uint64_t Offset = RelCur->getOffset() - RelAdjustment;
195209467b48Spatrick // If this relocation is hidden, skip it.
195309467b48Spatrick if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
195409467b48Spatrick ++RelCur;
195509467b48Spatrick continue;
195609467b48Spatrick }
195709467b48Spatrick
1958097a140dSpatrick // Stop when RelCur's offset is past the disassembled
1959097a140dSpatrick // instruction/data. Note that it's possible the disassembled data
1960097a140dSpatrick // is not the complete data: we might see the relocation printed in
1961097a140dSpatrick // the middle of the data, but this matches the binutils objdump
1962097a140dSpatrick // output.
196309467b48Spatrick if (Offset >= Index + Size)
196409467b48Spatrick break;
196509467b48Spatrick
196609467b48Spatrick // When --adjust-vma is used, update the address printed.
1967*d415bd75Srobert if (RelCur->getSymbol() != Obj.symbol_end()) {
196809467b48Spatrick Expected<section_iterator> SymSI =
196909467b48Spatrick RelCur->getSymbol()->getSection();
1970*d415bd75Srobert if (SymSI && *SymSI != Obj.section_end() &&
197109467b48Spatrick shouldAdjustVA(**SymSI))
197209467b48Spatrick Offset += AdjustVMA;
197309467b48Spatrick }
197409467b48Spatrick
1975*d415bd75Srobert printRelocation(FOS, Obj.getFileName(), *RelCur,
1976097a140dSpatrick SectionAddr + Offset, Is64Bits);
1977097a140dSpatrick LVP.printAfterOtherLine(FOS, true);
197809467b48Spatrick ++RelCur;
197909467b48Spatrick }
198009467b48Spatrick }
198109467b48Spatrick
198209467b48Spatrick Index += Size;
198309467b48Spatrick }
198409467b48Spatrick }
198509467b48Spatrick }
1986097a140dSpatrick StringSet<> MissingDisasmSymbolSet =
1987097a140dSpatrick set_difference(DisasmSymbolSet, FoundDisasmSymbolSet);
1988097a140dSpatrick for (StringRef Sym : MissingDisasmSymbolSet.keys())
1989097a140dSpatrick reportWarning("failed to disassemble missing symbol " + Sym, FileName);
199009467b48Spatrick }
199109467b48Spatrick
disassembleObject(ObjectFile * Obj,bool InlineRelocs)1992*d415bd75Srobert static void disassembleObject(ObjectFile *Obj, bool InlineRelocs) {
1993*d415bd75Srobert // If information useful for showing the disassembly is missing, try to find a
1994*d415bd75Srobert // more complete binary and disassemble that instead.
1995*d415bd75Srobert OwningBinary<Binary> FetchedBinary;
1996*d415bd75Srobert if (Obj->symbols().empty()) {
1997*d415bd75Srobert if (std::optional<OwningBinary<Binary>> FetchedBinaryOpt =
1998*d415bd75Srobert fetchBinaryByBuildID(*Obj)) {
1999*d415bd75Srobert if (auto *O = dyn_cast<ObjectFile>(FetchedBinaryOpt->getBinary())) {
2000*d415bd75Srobert if (!O->symbols().empty() ||
2001*d415bd75Srobert (!O->sections().empty() && Obj->sections().empty())) {
2002*d415bd75Srobert FetchedBinary = std::move(*FetchedBinaryOpt);
2003*d415bd75Srobert Obj = O;
2004*d415bd75Srobert }
2005*d415bd75Srobert }
2006*d415bd75Srobert }
2007*d415bd75Srobert }
2008*d415bd75Srobert
200909467b48Spatrick const Target *TheTarget = getTarget(Obj);
201009467b48Spatrick
201109467b48Spatrick // Package up features to be passed to target/subtarget
2012*d415bd75Srobert Expected<SubtargetFeatures> FeaturesValue = Obj->getFeatures();
2013*d415bd75Srobert if (!FeaturesValue)
2014*d415bd75Srobert reportError(FeaturesValue.takeError(), Obj->getFileName());
2015*d415bd75Srobert SubtargetFeatures Features = *FeaturesValue;
2016*d415bd75Srobert if (!MAttrs.empty()) {
201709467b48Spatrick for (unsigned I = 0; I != MAttrs.size(); ++I)
201809467b48Spatrick Features.AddFeature(MAttrs[I]);
2019*d415bd75Srobert } else if (MCPU.empty() && Obj->getArch() == llvm::Triple::aarch64) {
2020*d415bd75Srobert Features.AddFeature("+all");
2021*d415bd75Srobert }
202209467b48Spatrick
202309467b48Spatrick std::unique_ptr<const MCRegisterInfo> MRI(
202409467b48Spatrick TheTarget->createMCRegInfo(TripleName));
202509467b48Spatrick if (!MRI)
202609467b48Spatrick reportError(Obj->getFileName(),
202709467b48Spatrick "no register info for target " + TripleName);
202809467b48Spatrick
202909467b48Spatrick // Set up disassembler.
203009467b48Spatrick MCTargetOptions MCOptions;
203109467b48Spatrick std::unique_ptr<const MCAsmInfo> AsmInfo(
203209467b48Spatrick TheTarget->createMCAsmInfo(*MRI, TripleName, MCOptions));
203309467b48Spatrick if (!AsmInfo)
203409467b48Spatrick reportError(Obj->getFileName(),
203509467b48Spatrick "no assembly info for target " + TripleName);
203673471bf0Spatrick
203773471bf0Spatrick if (MCPU.empty())
2038*d415bd75Srobert MCPU = Obj->tryGetCPUName().value_or("").str();
2039*d415bd75Srobert
2040*d415bd75Srobert if (isArmElf(*Obj)) {
2041*d415bd75Srobert // When disassembling big-endian Arm ELF, the instruction endianness is
2042*d415bd75Srobert // determined in a complex way. In relocatable objects, AAELF32 mandates
2043*d415bd75Srobert // that instruction endianness matches the ELF file endianness; in
2044*d415bd75Srobert // executable images, that's true unless the file header has the EF_ARM_BE8
2045*d415bd75Srobert // flag, in which case instructions are little-endian regardless of data
2046*d415bd75Srobert // endianness.
2047*d415bd75Srobert //
2048*d415bd75Srobert // We must set the big-endian-instructions SubtargetFeature to make the
2049*d415bd75Srobert // disassembler read the instructions the right way round, and also tell
2050*d415bd75Srobert // our own prettyprinter to retrieve the encodings the same way to print in
2051*d415bd75Srobert // hex.
2052*d415bd75Srobert const auto *Elf32BE = dyn_cast<ELF32BEObjectFile>(Obj);
2053*d415bd75Srobert
2054*d415bd75Srobert if (Elf32BE && (Elf32BE->isRelocatableObject() ||
2055*d415bd75Srobert !(Elf32BE->getPlatformFlags() & ELF::EF_ARM_BE8))) {
2056*d415bd75Srobert Features.AddFeature("+big-endian-instructions");
2057*d415bd75Srobert ARMPrettyPrinterInst.setInstructionEndianness(llvm::support::big);
2058*d415bd75Srobert } else {
2059*d415bd75Srobert ARMPrettyPrinterInst.setInstructionEndianness(llvm::support::little);
2060*d415bd75Srobert }
2061*d415bd75Srobert }
206273471bf0Spatrick
206309467b48Spatrick std::unique_ptr<const MCSubtargetInfo> STI(
206409467b48Spatrick TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
206509467b48Spatrick if (!STI)
206609467b48Spatrick reportError(Obj->getFileName(),
206709467b48Spatrick "no subtarget info for target " + TripleName);
206809467b48Spatrick std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
206909467b48Spatrick if (!MII)
207009467b48Spatrick reportError(Obj->getFileName(),
207109467b48Spatrick "no instruction info for target " + TripleName);
207273471bf0Spatrick MCContext Ctx(Triple(TripleName), AsmInfo.get(), MRI.get(), STI.get());
207309467b48Spatrick // FIXME: for now initialize MCObjectFileInfo with default values
207473471bf0Spatrick std::unique_ptr<MCObjectFileInfo> MOFI(
207573471bf0Spatrick TheTarget->createMCObjectFileInfo(Ctx, /*PIC=*/false));
207673471bf0Spatrick Ctx.setObjectFileInfo(MOFI.get());
207709467b48Spatrick
207809467b48Spatrick std::unique_ptr<MCDisassembler> DisAsm(
207909467b48Spatrick TheTarget->createMCDisassembler(*STI, Ctx));
208009467b48Spatrick if (!DisAsm)
208109467b48Spatrick reportError(Obj->getFileName(), "no disassembler for target " + TripleName);
208209467b48Spatrick
208309467b48Spatrick // If we have an ARM object file, we need a second disassembler, because
208409467b48Spatrick // ARM CPUs have two different instruction sets: ARM mode, and Thumb mode.
208509467b48Spatrick // We use mapping symbols to switch between the two assemblers, where
208609467b48Spatrick // appropriate.
208709467b48Spatrick std::unique_ptr<MCDisassembler> SecondaryDisAsm;
208809467b48Spatrick std::unique_ptr<const MCSubtargetInfo> SecondarySTI;
2089*d415bd75Srobert if (isArmElf(*Obj) && !STI->checkFeatures("+mclass")) {
209009467b48Spatrick if (STI->checkFeatures("+thumb-mode"))
209109467b48Spatrick Features.AddFeature("-thumb-mode");
209209467b48Spatrick else
209309467b48Spatrick Features.AddFeature("+thumb-mode");
209409467b48Spatrick SecondarySTI.reset(TheTarget->createMCSubtargetInfo(TripleName, MCPU,
209509467b48Spatrick Features.getString()));
209609467b48Spatrick SecondaryDisAsm.reset(TheTarget->createMCDisassembler(*SecondarySTI, Ctx));
209709467b48Spatrick }
209809467b48Spatrick
209909467b48Spatrick std::unique_ptr<const MCInstrAnalysis> MIA(
210009467b48Spatrick TheTarget->createMCInstrAnalysis(MII.get()));
210109467b48Spatrick
210209467b48Spatrick int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
210309467b48Spatrick std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
210409467b48Spatrick Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
210509467b48Spatrick if (!IP)
210609467b48Spatrick reportError(Obj->getFileName(),
210709467b48Spatrick "no instruction printer for target " + TripleName);
210809467b48Spatrick IP->setPrintImmHex(PrintImmHex);
2109097a140dSpatrick IP->setPrintBranchImmAsAddress(true);
211073471bf0Spatrick IP->setSymbolizeOperands(SymbolizeOperands);
211173471bf0Spatrick IP->setMCInstrAnalysis(MIA.get());
211209467b48Spatrick
211309467b48Spatrick PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
2114*d415bd75Srobert
2115*d415bd75Srobert const ObjectFile *DbgObj = Obj;
2116*d415bd75Srobert if (!FetchedBinary.getBinary() && !Obj->hasDebugInfo()) {
2117*d415bd75Srobert if (std::optional<OwningBinary<Binary>> DebugBinaryOpt =
2118*d415bd75Srobert fetchBinaryByBuildID(*Obj)) {
2119*d415bd75Srobert if (auto *FetchedObj =
2120*d415bd75Srobert dyn_cast<const ObjectFile>(DebugBinaryOpt->getBinary())) {
2121*d415bd75Srobert if (FetchedObj->hasDebugInfo()) {
2122*d415bd75Srobert FetchedBinary = std::move(*DebugBinaryOpt);
2123*d415bd75Srobert DbgObj = FetchedObj;
2124*d415bd75Srobert }
2125*d415bd75Srobert }
2126*d415bd75Srobert }
2127*d415bd75Srobert }
2128*d415bd75Srobert
2129*d415bd75Srobert std::unique_ptr<object::Binary> DSYMBinary;
2130*d415bd75Srobert std::unique_ptr<MemoryBuffer> DSYMBuf;
2131*d415bd75Srobert if (!DbgObj->hasDebugInfo()) {
2132*d415bd75Srobert if (const MachOObjectFile *MachOOF = dyn_cast<MachOObjectFile>(&*Obj)) {
2133*d415bd75Srobert DbgObj = objdump::getMachODSymObject(MachOOF, Obj->getFileName(),
2134*d415bd75Srobert DSYMBinary, DSYMBuf);
2135*d415bd75Srobert if (!DbgObj)
2136*d415bd75Srobert return;
2137*d415bd75Srobert }
2138*d415bd75Srobert }
2139*d415bd75Srobert
2140*d415bd75Srobert SourcePrinter SP(DbgObj, TheTarget->getName());
214109467b48Spatrick
214209467b48Spatrick for (StringRef Opt : DisassemblerOptions)
214309467b48Spatrick if (!IP->applyTargetSpecificCLOption(Opt))
214409467b48Spatrick reportError(Obj->getFileName(),
214509467b48Spatrick "Unrecognized disassembler option: " + Opt);
214609467b48Spatrick
2147*d415bd75Srobert disassembleObject(TheTarget, *Obj, *DbgObj, Ctx, DisAsm.get(),
2148*d415bd75Srobert SecondaryDisAsm.get(), MIA.get(), IP.get(), STI.get(),
2149*d415bd75Srobert SecondarySTI.get(), PIP, SP, InlineRelocs);
215009467b48Spatrick }
215109467b48Spatrick
printRelocations(const ObjectFile * Obj)2152097a140dSpatrick void objdump::printRelocations(const ObjectFile *Obj) {
215309467b48Spatrick StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
215409467b48Spatrick "%08" PRIx64;
215509467b48Spatrick
215609467b48Spatrick // Build a mapping from relocation target to a vector of relocation
215709467b48Spatrick // sections. Usually, there is an only one relocation section for
215809467b48Spatrick // each relocated section.
215909467b48Spatrick MapVector<SectionRef, std::vector<SectionRef>> SecToRelSec;
216009467b48Spatrick uint64_t Ndx;
216109467b48Spatrick for (const SectionRef &Section : ToolSectionFilter(*Obj, &Ndx)) {
2162*d415bd75Srobert if (Obj->isELF() && (ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC))
2163*d415bd75Srobert continue;
216409467b48Spatrick if (Section.relocation_begin() == Section.relocation_end())
216509467b48Spatrick continue;
216609467b48Spatrick Expected<section_iterator> SecOrErr = Section.getRelocatedSection();
216709467b48Spatrick if (!SecOrErr)
216809467b48Spatrick reportError(Obj->getFileName(),
216909467b48Spatrick "section (" + Twine(Ndx) +
217009467b48Spatrick "): unable to get a relocation target: " +
217109467b48Spatrick toString(SecOrErr.takeError()));
217209467b48Spatrick SecToRelSec[**SecOrErr].push_back(Section);
217309467b48Spatrick }
217409467b48Spatrick
217509467b48Spatrick for (std::pair<SectionRef, std::vector<SectionRef>> &P : SecToRelSec) {
217609467b48Spatrick StringRef SecName = unwrapOrError(P.first.getName(), Obj->getFileName());
217773471bf0Spatrick outs() << "\nRELOCATION RECORDS FOR [" << SecName << "]:\n";
2178097a140dSpatrick uint32_t OffsetPadding = (Obj->getBytesInAddress() > 4 ? 16 : 8);
2179097a140dSpatrick uint32_t TypePadding = 24;
2180097a140dSpatrick outs() << left_justify("OFFSET", OffsetPadding) << " "
2181097a140dSpatrick << left_justify("TYPE", TypePadding) << " "
2182097a140dSpatrick << "VALUE\n";
218309467b48Spatrick
218409467b48Spatrick for (SectionRef Section : P.second) {
218509467b48Spatrick for (const RelocationRef &Reloc : Section.relocations()) {
218609467b48Spatrick uint64_t Address = Reloc.getOffset();
218709467b48Spatrick SmallString<32> RelocName;
218809467b48Spatrick SmallString<32> ValueStr;
218909467b48Spatrick if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
219009467b48Spatrick continue;
219109467b48Spatrick Reloc.getTypeName(RelocName);
219209467b48Spatrick if (Error E = getRelocationValueString(Reloc, ValueStr))
219309467b48Spatrick reportError(std::move(E), Obj->getFileName());
219409467b48Spatrick
2195097a140dSpatrick outs() << format(Fmt.data(), Address) << " "
2196097a140dSpatrick << left_justify(RelocName, TypePadding) << " " << ValueStr
2197097a140dSpatrick << "\n";
219809467b48Spatrick }
219909467b48Spatrick }
220009467b48Spatrick }
220109467b48Spatrick }
220209467b48Spatrick
printDynamicRelocations(const ObjectFile * Obj)2203097a140dSpatrick void objdump::printDynamicRelocations(const ObjectFile *Obj) {
220409467b48Spatrick // For the moment, this option is for ELF only
220509467b48Spatrick if (!Obj->isELF())
220609467b48Spatrick return;
220709467b48Spatrick
220809467b48Spatrick const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
2209*d415bd75Srobert if (!Elf || !any_of(Elf->sections(), [](const ELFSectionRef Sec) {
2210*d415bd75Srobert return Sec.getType() == ELF::SHT_DYNAMIC;
2211*d415bd75Srobert })) {
221209467b48Spatrick reportError(Obj->getFileName(), "not a dynamic object");
221309467b48Spatrick return;
221409467b48Spatrick }
221509467b48Spatrick
221609467b48Spatrick std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
221709467b48Spatrick if (DynRelSec.empty())
221809467b48Spatrick return;
221909467b48Spatrick
2220*d415bd75Srobert outs() << "\nDYNAMIC RELOCATION RECORDS\n";
2221*d415bd75Srobert const uint32_t OffsetPadding = (Obj->getBytesInAddress() > 4 ? 16 : 8);
2222*d415bd75Srobert const uint32_t TypePadding = 24;
2223*d415bd75Srobert outs() << left_justify("OFFSET", OffsetPadding) << ' '
2224*d415bd75Srobert << left_justify("TYPE", TypePadding) << " VALUE\n";
2225*d415bd75Srobert
222609467b48Spatrick StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
222709467b48Spatrick for (const SectionRef &Section : DynRelSec)
222809467b48Spatrick for (const RelocationRef &Reloc : Section.relocations()) {
222909467b48Spatrick uint64_t Address = Reloc.getOffset();
223009467b48Spatrick SmallString<32> RelocName;
223109467b48Spatrick SmallString<32> ValueStr;
223209467b48Spatrick Reloc.getTypeName(RelocName);
223309467b48Spatrick if (Error E = getRelocationValueString(Reloc, ValueStr))
223409467b48Spatrick reportError(std::move(E), Obj->getFileName());
2235*d415bd75Srobert outs() << format(Fmt.data(), Address) << ' '
2236*d415bd75Srobert << left_justify(RelocName, TypePadding) << ' ' << ValueStr << '\n';
223709467b48Spatrick }
223809467b48Spatrick }
223909467b48Spatrick
224009467b48Spatrick // Returns true if we need to show LMA column when dumping section headers. We
224109467b48Spatrick // show it only when the platform is ELF and either we have at least one section
224209467b48Spatrick // whose VMA and LMA are different and/or when --show-lma flag is used.
shouldDisplayLMA(const ObjectFile & Obj)2243*d415bd75Srobert static bool shouldDisplayLMA(const ObjectFile &Obj) {
2244*d415bd75Srobert if (!Obj.isELF())
224509467b48Spatrick return false;
2246*d415bd75Srobert for (const SectionRef &S : ToolSectionFilter(Obj))
224709467b48Spatrick if (S.getAddress() != getELFSectionLMA(S))
224809467b48Spatrick return true;
224909467b48Spatrick return ShowLMA;
225009467b48Spatrick }
225109467b48Spatrick
getMaxSectionNameWidth(const ObjectFile & Obj)2252*d415bd75Srobert static size_t getMaxSectionNameWidth(const ObjectFile &Obj) {
225309467b48Spatrick // Default column width for names is 13 even if no names are that long.
225409467b48Spatrick size_t MaxWidth = 13;
2255*d415bd75Srobert for (const SectionRef &Section : ToolSectionFilter(Obj)) {
2256*d415bd75Srobert StringRef Name = unwrapOrError(Section.getName(), Obj.getFileName());
225709467b48Spatrick MaxWidth = std::max(MaxWidth, Name.size());
225809467b48Spatrick }
225909467b48Spatrick return MaxWidth;
226009467b48Spatrick }
226109467b48Spatrick
printSectionHeaders(ObjectFile & Obj)2262*d415bd75Srobert void objdump::printSectionHeaders(ObjectFile &Obj) {
2263*d415bd75Srobert if (Obj.isELF() && Obj.sections().empty())
2264*d415bd75Srobert createFakeELFSections(Obj);
2265*d415bd75Srobert
226609467b48Spatrick size_t NameWidth = getMaxSectionNameWidth(Obj);
2267*d415bd75Srobert size_t AddressWidth = 2 * Obj.getBytesInAddress();
226809467b48Spatrick bool HasLMAColumn = shouldDisplayLMA(Obj);
226973471bf0Spatrick outs() << "\nSections:\n";
227009467b48Spatrick if (HasLMAColumn)
227173471bf0Spatrick outs() << "Idx " << left_justify("Name", NameWidth) << " Size "
227209467b48Spatrick << left_justify("VMA", AddressWidth) << " "
227309467b48Spatrick << left_justify("LMA", AddressWidth) << " Type\n";
227409467b48Spatrick else
227573471bf0Spatrick outs() << "Idx " << left_justify("Name", NameWidth) << " Size "
227609467b48Spatrick << left_justify("VMA", AddressWidth) << " Type\n";
227709467b48Spatrick
227809467b48Spatrick uint64_t Idx;
2279*d415bd75Srobert for (const SectionRef &Section : ToolSectionFilter(Obj, &Idx)) {
2280*d415bd75Srobert StringRef Name = unwrapOrError(Section.getName(), Obj.getFileName());
228109467b48Spatrick uint64_t VMA = Section.getAddress();
228209467b48Spatrick if (shouldAdjustVA(Section))
228309467b48Spatrick VMA += AdjustVMA;
228409467b48Spatrick
228509467b48Spatrick uint64_t Size = Section.getSize();
228609467b48Spatrick
228709467b48Spatrick std::string Type = Section.isText() ? "TEXT" : "";
228809467b48Spatrick if (Section.isData())
228973471bf0Spatrick Type += Type.empty() ? "DATA" : ", DATA";
229009467b48Spatrick if (Section.isBSS())
229173471bf0Spatrick Type += Type.empty() ? "BSS" : ", BSS";
229273471bf0Spatrick if (Section.isDebugSection())
229373471bf0Spatrick Type += Type.empty() ? "DEBUG" : ", DEBUG";
229409467b48Spatrick
229509467b48Spatrick if (HasLMAColumn)
229609467b48Spatrick outs() << format("%3" PRIu64 " %-*s %08" PRIx64 " ", Idx, NameWidth,
229709467b48Spatrick Name.str().c_str(), Size)
229809467b48Spatrick << format_hex_no_prefix(VMA, AddressWidth) << " "
229909467b48Spatrick << format_hex_no_prefix(getELFSectionLMA(Section), AddressWidth)
230009467b48Spatrick << " " << Type << "\n";
230109467b48Spatrick else
230209467b48Spatrick outs() << format("%3" PRIu64 " %-*s %08" PRIx64 " ", Idx, NameWidth,
230309467b48Spatrick Name.str().c_str(), Size)
230409467b48Spatrick << format_hex_no_prefix(VMA, AddressWidth) << " " << Type << "\n";
230509467b48Spatrick }
230609467b48Spatrick }
230709467b48Spatrick
printSectionContents(const ObjectFile * Obj)2308097a140dSpatrick void objdump::printSectionContents(const ObjectFile *Obj) {
230973471bf0Spatrick const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj);
231073471bf0Spatrick
231109467b48Spatrick for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
231209467b48Spatrick StringRef Name = unwrapOrError(Section.getName(), Obj->getFileName());
231309467b48Spatrick uint64_t BaseAddr = Section.getAddress();
231409467b48Spatrick uint64_t Size = Section.getSize();
231509467b48Spatrick if (!Size)
231609467b48Spatrick continue;
231709467b48Spatrick
231873471bf0Spatrick outs() << "Contents of section ";
231973471bf0Spatrick StringRef SegmentName = getSegmentName(MachO, Section);
232073471bf0Spatrick if (!SegmentName.empty())
232173471bf0Spatrick outs() << SegmentName << ",";
232273471bf0Spatrick outs() << Name << ":\n";
232309467b48Spatrick if (Section.isBSS()) {
232409467b48Spatrick outs() << format("<skipping contents of bss section at [%04" PRIx64
232509467b48Spatrick ", %04" PRIx64 ")>\n",
232609467b48Spatrick BaseAddr, BaseAddr + Size);
232709467b48Spatrick continue;
232809467b48Spatrick }
232909467b48Spatrick
233009467b48Spatrick StringRef Contents = unwrapOrError(Section.getContents(), Obj->getFileName());
233109467b48Spatrick
233209467b48Spatrick // Dump out the content as hex and printable ascii characters.
233309467b48Spatrick for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
233409467b48Spatrick outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
233509467b48Spatrick // Dump line of hex.
233609467b48Spatrick for (std::size_t I = 0; I < 16; ++I) {
233709467b48Spatrick if (I != 0 && I % 4 == 0)
233809467b48Spatrick outs() << ' ';
233909467b48Spatrick if (Addr + I < End)
234009467b48Spatrick outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
234109467b48Spatrick << hexdigit(Contents[Addr + I] & 0xF, true);
234209467b48Spatrick else
234309467b48Spatrick outs() << " ";
234409467b48Spatrick }
234509467b48Spatrick // Print ascii.
234609467b48Spatrick outs() << " ";
234709467b48Spatrick for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
234809467b48Spatrick if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
234909467b48Spatrick outs() << Contents[Addr + I];
235009467b48Spatrick else
235109467b48Spatrick outs() << ".";
235209467b48Spatrick }
235309467b48Spatrick outs() << "\n";
235409467b48Spatrick }
235509467b48Spatrick }
235609467b48Spatrick }
235709467b48Spatrick
printSymbolTable(const ObjectFile & O,StringRef ArchiveName,StringRef ArchitectureName,bool DumpDynamic)2358*d415bd75Srobert void objdump::printSymbolTable(const ObjectFile &O, StringRef ArchiveName,
2359097a140dSpatrick StringRef ArchitectureName, bool DumpDynamic) {
2360*d415bd75Srobert if (O.isCOFF() && !DumpDynamic) {
236173471bf0Spatrick outs() << "\nSYMBOL TABLE:\n";
2362097a140dSpatrick printCOFFSymbolTable(cast<const COFFObjectFile>(O));
236309467b48Spatrick return;
236409467b48Spatrick }
236509467b48Spatrick
2366*d415bd75Srobert const StringRef FileName = O.getFileName();
2367097a140dSpatrick
2368097a140dSpatrick if (!DumpDynamic) {
236973471bf0Spatrick outs() << "\nSYMBOL TABLE:\n";
2370*d415bd75Srobert for (auto I = O.symbol_begin(); I != O.symbol_end(); ++I)
2371*d415bd75Srobert printSymbol(O, *I, {}, FileName, ArchiveName, ArchitectureName,
2372*d415bd75Srobert DumpDynamic);
2373097a140dSpatrick return;
2374097a140dSpatrick }
2375097a140dSpatrick
237673471bf0Spatrick outs() << "\nDYNAMIC SYMBOL TABLE:\n";
2377*d415bd75Srobert if (!O.isELF()) {
2378097a140dSpatrick reportWarning(
2379097a140dSpatrick "this operation is not currently supported for this file format",
2380097a140dSpatrick FileName);
2381097a140dSpatrick return;
2382097a140dSpatrick }
2383097a140dSpatrick
2384*d415bd75Srobert const ELFObjectFileBase *ELF = cast<const ELFObjectFileBase>(&O);
2385*d415bd75Srobert auto Symbols = ELF->getDynamicSymbolIterators();
2386*d415bd75Srobert Expected<std::vector<VersionEntry>> SymbolVersionsOrErr =
2387*d415bd75Srobert ELF->readDynsymVersions();
2388*d415bd75Srobert if (!SymbolVersionsOrErr) {
2389*d415bd75Srobert reportWarning(toString(SymbolVersionsOrErr.takeError()), FileName);
2390*d415bd75Srobert SymbolVersionsOrErr = std::vector<VersionEntry>();
2391*d415bd75Srobert (void)!SymbolVersionsOrErr;
2392*d415bd75Srobert }
2393*d415bd75Srobert for (auto &Sym : Symbols)
2394*d415bd75Srobert printSymbol(O, Sym, *SymbolVersionsOrErr, FileName, ArchiveName,
2395*d415bd75Srobert ArchitectureName, DumpDynamic);
2396097a140dSpatrick }
2397097a140dSpatrick
printSymbol(const ObjectFile & O,const SymbolRef & Symbol,ArrayRef<VersionEntry> SymbolVersions,StringRef FileName,StringRef ArchiveName,StringRef ArchitectureName,bool DumpDynamic)2398*d415bd75Srobert void objdump::printSymbol(const ObjectFile &O, const SymbolRef &Symbol,
2399*d415bd75Srobert ArrayRef<VersionEntry> SymbolVersions,
2400097a140dSpatrick StringRef FileName, StringRef ArchiveName,
2401097a140dSpatrick StringRef ArchitectureName, bool DumpDynamic) {
2402*d415bd75Srobert const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(&O);
240309467b48Spatrick uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName, ArchiveName,
240409467b48Spatrick ArchitectureName);
240509467b48Spatrick if ((Address < StartAddress) || (Address > StopAddress))
2406097a140dSpatrick return;
2407097a140dSpatrick SymbolRef::Type Type =
2408097a140dSpatrick unwrapOrError(Symbol.getType(), FileName, ArchiveName, ArchitectureName);
2409097a140dSpatrick uint32_t Flags =
2410097a140dSpatrick unwrapOrError(Symbol.getFlags(), FileName, ArchiveName, ArchitectureName);
241109467b48Spatrick
241209467b48Spatrick // Don't ask a Mach-O STAB symbol for its section unless you know that
241309467b48Spatrick // STAB symbol's section field refers to a valid section index. Otherwise
241409467b48Spatrick // the symbol may error trying to load a section that does not exist.
2415097a140dSpatrick bool IsSTAB = false;
241609467b48Spatrick if (MachO) {
241709467b48Spatrick DataRefImpl SymDRI = Symbol.getRawDataRefImpl();
2418097a140dSpatrick uint8_t NType =
2419097a140dSpatrick (MachO->is64Bit() ? MachO->getSymbol64TableEntry(SymDRI).n_type
2420097a140dSpatrick : MachO->getSymbolTableEntry(SymDRI).n_type);
242109467b48Spatrick if (NType & MachO::N_STAB)
2422097a140dSpatrick IsSTAB = true;
242309467b48Spatrick }
2424097a140dSpatrick section_iterator Section = IsSTAB
2425*d415bd75Srobert ? O.section_end()
2426097a140dSpatrick : unwrapOrError(Symbol.getSection(), FileName,
242709467b48Spatrick ArchiveName, ArchitectureName);
242809467b48Spatrick
242909467b48Spatrick StringRef Name;
2430*d415bd75Srobert if (Type == SymbolRef::ST_Debug && Section != O.section_end()) {
243109467b48Spatrick if (Expected<StringRef> NameOrErr = Section->getName())
243209467b48Spatrick Name = *NameOrErr;
243309467b48Spatrick else
243409467b48Spatrick consumeError(NameOrErr.takeError());
243509467b48Spatrick
243609467b48Spatrick } else {
243709467b48Spatrick Name = unwrapOrError(Symbol.getName(), FileName, ArchiveName,
243809467b48Spatrick ArchitectureName);
243909467b48Spatrick }
244009467b48Spatrick
244109467b48Spatrick bool Global = Flags & SymbolRef::SF_Global;
244209467b48Spatrick bool Weak = Flags & SymbolRef::SF_Weak;
244309467b48Spatrick bool Absolute = Flags & SymbolRef::SF_Absolute;
244409467b48Spatrick bool Common = Flags & SymbolRef::SF_Common;
244509467b48Spatrick bool Hidden = Flags & SymbolRef::SF_Hidden;
244609467b48Spatrick
244709467b48Spatrick char GlobLoc = ' ';
2448*d415bd75Srobert if ((Section != O.section_end() || Absolute) && !Weak)
244909467b48Spatrick GlobLoc = Global ? 'g' : 'l';
2450097a140dSpatrick char IFunc = ' ';
2451*d415bd75Srobert if (O.isELF()) {
2452097a140dSpatrick if (ELFSymbolRef(Symbol).getELFType() == ELF::STT_GNU_IFUNC)
2453097a140dSpatrick IFunc = 'i';
2454097a140dSpatrick if (ELFSymbolRef(Symbol).getBinding() == ELF::STB_GNU_UNIQUE)
2455097a140dSpatrick GlobLoc = 'u';
2456097a140dSpatrick }
2457097a140dSpatrick
2458097a140dSpatrick char Debug = ' ';
2459097a140dSpatrick if (DumpDynamic)
2460097a140dSpatrick Debug = 'D';
2461097a140dSpatrick else if (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
2462097a140dSpatrick Debug = 'd';
2463097a140dSpatrick
246409467b48Spatrick char FileFunc = ' ';
246509467b48Spatrick if (Type == SymbolRef::ST_File)
246609467b48Spatrick FileFunc = 'f';
246709467b48Spatrick else if (Type == SymbolRef::ST_Function)
246809467b48Spatrick FileFunc = 'F';
246909467b48Spatrick else if (Type == SymbolRef::ST_Data)
247009467b48Spatrick FileFunc = 'O';
247109467b48Spatrick
2472*d415bd75Srobert const char *Fmt = O.getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
247309467b48Spatrick
247409467b48Spatrick outs() << format(Fmt, Address) << " "
247509467b48Spatrick << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
247609467b48Spatrick << (Weak ? 'w' : ' ') // Weak?
247709467b48Spatrick << ' ' // Constructor. Not supported yet.
247809467b48Spatrick << ' ' // Warning. Not supported yet.
2479097a140dSpatrick << IFunc // Indirect reference to another symbol.
248009467b48Spatrick << Debug // Debugging (d) or dynamic (D) symbol.
248109467b48Spatrick << FileFunc // Name of function (F), file (f) or object (O).
248209467b48Spatrick << ' ';
248309467b48Spatrick if (Absolute) {
248409467b48Spatrick outs() << "*ABS*";
248509467b48Spatrick } else if (Common) {
248609467b48Spatrick outs() << "*COM*";
2487*d415bd75Srobert } else if (Section == O.section_end()) {
2488*d415bd75Srobert if (O.isXCOFF()) {
2489*d415bd75Srobert XCOFFSymbolRef XCOFFSym = cast<const XCOFFObjectFile>(O).toSymbolRef(
2490*d415bd75Srobert Symbol.getRawDataRefImpl());
2491*d415bd75Srobert if (XCOFF::N_DEBUG == XCOFFSym.getSectionNumber())
2492*d415bd75Srobert outs() << "*DEBUG*";
2493*d415bd75Srobert else
2494*d415bd75Srobert outs() << "*UND*";
2495*d415bd75Srobert } else
249609467b48Spatrick outs() << "*UND*";
249709467b48Spatrick } else {
249873471bf0Spatrick StringRef SegmentName = getSegmentName(MachO, *Section);
249973471bf0Spatrick if (!SegmentName.empty())
250009467b48Spatrick outs() << SegmentName << ",";
2501097a140dSpatrick StringRef SectionName = unwrapOrError(Section->getName(), FileName);
250209467b48Spatrick outs() << SectionName;
2503*d415bd75Srobert if (O.isXCOFF()) {
2504*d415bd75Srobert std::optional<SymbolRef> SymRef =
2505*d415bd75Srobert getXCOFFSymbolContainingSymbolRef(cast<XCOFFObjectFile>(O), Symbol);
2506*d415bd75Srobert if (SymRef) {
2507*d415bd75Srobert
2508*d415bd75Srobert Expected<StringRef> NameOrErr = SymRef->getName();
2509*d415bd75Srobert
2510*d415bd75Srobert if (NameOrErr) {
2511*d415bd75Srobert outs() << " (csect:";
2512*d415bd75Srobert std::string SymName(NameOrErr.get());
2513*d415bd75Srobert
2514*d415bd75Srobert if (Demangle)
2515*d415bd75Srobert SymName = demangle(SymName);
2516*d415bd75Srobert
2517*d415bd75Srobert if (SymbolDescription)
2518*d415bd75Srobert SymName = getXCOFFSymbolDescription(createSymbolInfo(O, *SymRef),
2519*d415bd75Srobert SymName);
2520*d415bd75Srobert
2521*d415bd75Srobert outs() << ' ' << SymName;
2522*d415bd75Srobert outs() << ") ";
2523*d415bd75Srobert } else
2524*d415bd75Srobert reportWarning(toString(NameOrErr.takeError()), FileName);
2525*d415bd75Srobert }
2526*d415bd75Srobert }
252709467b48Spatrick }
252809467b48Spatrick
2529*d415bd75Srobert if (Common)
2530*d415bd75Srobert outs() << '\t' << format(Fmt, static_cast<uint64_t>(Symbol.getAlignment()));
2531*d415bd75Srobert else if (O.isXCOFF())
2532*d415bd75Srobert outs() << '\t'
2533*d415bd75Srobert << format(Fmt, cast<XCOFFObjectFile>(O).getSymbolSize(
2534*d415bd75Srobert Symbol.getRawDataRefImpl()));
2535*d415bd75Srobert else if (O.isELF())
2536*d415bd75Srobert outs() << '\t' << format(Fmt, ELFSymbolRef(Symbol).getSize());
2537*d415bd75Srobert
2538*d415bd75Srobert if (O.isELF()) {
2539*d415bd75Srobert if (!SymbolVersions.empty()) {
2540*d415bd75Srobert const VersionEntry &Ver =
2541*d415bd75Srobert SymbolVersions[Symbol.getRawDataRefImpl().d.b - 1];
2542*d415bd75Srobert std::string Str;
2543*d415bd75Srobert if (!Ver.Name.empty())
2544*d415bd75Srobert Str = Ver.IsVerDef ? ' ' + Ver.Name : '(' + Ver.Name + ')';
2545*d415bd75Srobert outs() << ' ' << left_justify(Str, 12);
254609467b48Spatrick }
254709467b48Spatrick
254809467b48Spatrick uint8_t Other = ELFSymbolRef(Symbol).getOther();
254909467b48Spatrick switch (Other) {
255009467b48Spatrick case ELF::STV_DEFAULT:
255109467b48Spatrick break;
255209467b48Spatrick case ELF::STV_INTERNAL:
255309467b48Spatrick outs() << " .internal";
255409467b48Spatrick break;
255509467b48Spatrick case ELF::STV_HIDDEN:
255609467b48Spatrick outs() << " .hidden";
255709467b48Spatrick break;
255809467b48Spatrick case ELF::STV_PROTECTED:
255909467b48Spatrick outs() << " .protected";
256009467b48Spatrick break;
256109467b48Spatrick default:
256209467b48Spatrick outs() << format(" 0x%02x", Other);
256309467b48Spatrick break;
256409467b48Spatrick }
256509467b48Spatrick } else if (Hidden) {
256609467b48Spatrick outs() << " .hidden";
256709467b48Spatrick }
256809467b48Spatrick
2569*d415bd75Srobert std::string SymName(Name);
257009467b48Spatrick if (Demangle)
2571*d415bd75Srobert SymName = demangle(SymName);
2572*d415bd75Srobert
2573*d415bd75Srobert if (O.isXCOFF() && SymbolDescription)
2574*d415bd75Srobert SymName = getXCOFFSymbolDescription(createSymbolInfo(O, Symbol), SymName);
2575*d415bd75Srobert
2576*d415bd75Srobert outs() << ' ' << SymName << '\n';
257709467b48Spatrick }
257809467b48Spatrick
printUnwindInfo(const ObjectFile * O)257909467b48Spatrick static void printUnwindInfo(const ObjectFile *O) {
258009467b48Spatrick outs() << "Unwind info:\n\n";
258109467b48Spatrick
258209467b48Spatrick if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
258309467b48Spatrick printCOFFUnwindInfo(Coff);
258409467b48Spatrick else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
258509467b48Spatrick printMachOUnwindInfo(MachO);
258609467b48Spatrick else
258709467b48Spatrick // TODO: Extract DWARF dump tool to objdump.
258809467b48Spatrick WithColor::error(errs(), ToolName)
258909467b48Spatrick << "This operation is only currently supported "
259009467b48Spatrick "for COFF and MachO object files.\n";
259109467b48Spatrick }
259209467b48Spatrick
259309467b48Spatrick /// Dump the raw contents of the __clangast section so the output can be piped
259409467b48Spatrick /// into llvm-bcanalyzer.
printRawClangAST(const ObjectFile * Obj)2595097a140dSpatrick static void printRawClangAST(const ObjectFile *Obj) {
259609467b48Spatrick if (outs().is_displayed()) {
259709467b48Spatrick WithColor::error(errs(), ToolName)
259809467b48Spatrick << "The -raw-clang-ast option will dump the raw binary contents of "
259909467b48Spatrick "the clang ast section.\n"
260009467b48Spatrick "Please redirect the output to a file or another program such as "
260109467b48Spatrick "llvm-bcanalyzer.\n";
260209467b48Spatrick return;
260309467b48Spatrick }
260409467b48Spatrick
260509467b48Spatrick StringRef ClangASTSectionName("__clangast");
2606097a140dSpatrick if (Obj->isCOFF()) {
260709467b48Spatrick ClangASTSectionName = "clangast";
260809467b48Spatrick }
260909467b48Spatrick
2610*d415bd75Srobert std::optional<object::SectionRef> ClangASTSection;
261109467b48Spatrick for (auto Sec : ToolSectionFilter(*Obj)) {
261209467b48Spatrick StringRef Name;
261309467b48Spatrick if (Expected<StringRef> NameOrErr = Sec.getName())
261409467b48Spatrick Name = *NameOrErr;
261509467b48Spatrick else
261609467b48Spatrick consumeError(NameOrErr.takeError());
261709467b48Spatrick
261809467b48Spatrick if (Name == ClangASTSectionName) {
261909467b48Spatrick ClangASTSection = Sec;
262009467b48Spatrick break;
262109467b48Spatrick }
262209467b48Spatrick }
262309467b48Spatrick if (!ClangASTSection)
262409467b48Spatrick return;
262509467b48Spatrick
2626*d415bd75Srobert StringRef ClangASTContents =
2627*d415bd75Srobert unwrapOrError(ClangASTSection->getContents(), Obj->getFileName());
262809467b48Spatrick outs().write(ClangASTContents.data(), ClangASTContents.size());
262909467b48Spatrick }
263009467b48Spatrick
printFaultMaps(const ObjectFile * Obj)263109467b48Spatrick static void printFaultMaps(const ObjectFile *Obj) {
263209467b48Spatrick StringRef FaultMapSectionName;
263309467b48Spatrick
2634097a140dSpatrick if (Obj->isELF()) {
263509467b48Spatrick FaultMapSectionName = ".llvm_faultmaps";
2636097a140dSpatrick } else if (Obj->isMachO()) {
263709467b48Spatrick FaultMapSectionName = "__llvm_faultmaps";
263809467b48Spatrick } else {
263909467b48Spatrick WithColor::error(errs(), ToolName)
264009467b48Spatrick << "This operation is only currently supported "
264109467b48Spatrick "for ELF and Mach-O executable files.\n";
264209467b48Spatrick return;
264309467b48Spatrick }
264409467b48Spatrick
2645*d415bd75Srobert std::optional<object::SectionRef> FaultMapSection;
264609467b48Spatrick
264709467b48Spatrick for (auto Sec : ToolSectionFilter(*Obj)) {
264809467b48Spatrick StringRef Name;
264909467b48Spatrick if (Expected<StringRef> NameOrErr = Sec.getName())
265009467b48Spatrick Name = *NameOrErr;
265109467b48Spatrick else
265209467b48Spatrick consumeError(NameOrErr.takeError());
265309467b48Spatrick
265409467b48Spatrick if (Name == FaultMapSectionName) {
265509467b48Spatrick FaultMapSection = Sec;
265609467b48Spatrick break;
265709467b48Spatrick }
265809467b48Spatrick }
265909467b48Spatrick
266009467b48Spatrick outs() << "FaultMap table:\n";
266109467b48Spatrick
2662*d415bd75Srobert if (!FaultMapSection) {
266309467b48Spatrick outs() << "<not found>\n";
266409467b48Spatrick return;
266509467b48Spatrick }
266609467b48Spatrick
266709467b48Spatrick StringRef FaultMapContents =
2668*d415bd75Srobert unwrapOrError(FaultMapSection->getContents(), Obj->getFileName());
266909467b48Spatrick FaultMapParser FMP(FaultMapContents.bytes_begin(),
267009467b48Spatrick FaultMapContents.bytes_end());
267109467b48Spatrick
267209467b48Spatrick outs() << FMP;
267309467b48Spatrick }
267409467b48Spatrick
printPrivateFileHeaders(const ObjectFile * O,bool OnlyFirst)267509467b48Spatrick static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
267609467b48Spatrick if (O->isELF()) {
267709467b48Spatrick printELFFileHeader(O);
267809467b48Spatrick printELFDynamicSection(O);
267909467b48Spatrick printELFSymbolVersionInfo(O);
268009467b48Spatrick return;
268109467b48Spatrick }
268209467b48Spatrick if (O->isCOFF())
2683*d415bd75Srobert return printCOFFFileHeader(cast<object::COFFObjectFile>(*O));
268409467b48Spatrick if (O->isWasm())
268509467b48Spatrick return printWasmFileHeader(O);
268609467b48Spatrick if (O->isMachO()) {
268709467b48Spatrick printMachOFileHeader(O);
268809467b48Spatrick if (!OnlyFirst)
268909467b48Spatrick printMachOLoadCommands(O);
269009467b48Spatrick return;
269109467b48Spatrick }
269209467b48Spatrick reportError(O->getFileName(), "Invalid/Unsupported object file format");
269309467b48Spatrick }
269409467b48Spatrick
printFileHeaders(const ObjectFile * O)269509467b48Spatrick static void printFileHeaders(const ObjectFile *O) {
269609467b48Spatrick if (!O->isELF() && !O->isCOFF())
269709467b48Spatrick reportError(O->getFileName(), "Invalid/Unsupported object file format");
269809467b48Spatrick
269909467b48Spatrick Triple::ArchType AT = O->getArch();
270009467b48Spatrick outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
270109467b48Spatrick uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
270209467b48Spatrick
270309467b48Spatrick StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
270409467b48Spatrick outs() << "start address: "
270573471bf0Spatrick << "0x" << format(Fmt.data(), Address) << "\n";
270609467b48Spatrick }
270709467b48Spatrick
printArchiveChild(StringRef Filename,const Archive::Child & C)270809467b48Spatrick static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
270909467b48Spatrick Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
271009467b48Spatrick if (!ModeOrErr) {
271109467b48Spatrick WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
271209467b48Spatrick consumeError(ModeOrErr.takeError());
271309467b48Spatrick return;
271409467b48Spatrick }
271509467b48Spatrick sys::fs::perms Mode = ModeOrErr.get();
271609467b48Spatrick outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
271709467b48Spatrick outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
271809467b48Spatrick outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
271909467b48Spatrick outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
272009467b48Spatrick outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
272109467b48Spatrick outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
272209467b48Spatrick outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
272309467b48Spatrick outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
272409467b48Spatrick outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
272509467b48Spatrick
272609467b48Spatrick outs() << " ";
272709467b48Spatrick
272809467b48Spatrick outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
272909467b48Spatrick unwrapOrError(C.getGID(), Filename),
273009467b48Spatrick unwrapOrError(C.getRawSize(), Filename));
273109467b48Spatrick
273209467b48Spatrick StringRef RawLastModified = C.getRawLastModified();
273309467b48Spatrick unsigned Seconds;
273409467b48Spatrick if (RawLastModified.getAsInteger(10, Seconds))
273509467b48Spatrick outs() << "(date: \"" << RawLastModified
273609467b48Spatrick << "\" contains non-decimal chars) ";
273709467b48Spatrick else {
273809467b48Spatrick // Since ctime(3) returns a 26 character string of the form:
273909467b48Spatrick // "Sun Sep 16 01:03:52 1973\n\0"
274009467b48Spatrick // just print 24 characters.
274109467b48Spatrick time_t t = Seconds;
274209467b48Spatrick outs() << format("%.24s ", ctime(&t));
274309467b48Spatrick }
274409467b48Spatrick
274509467b48Spatrick StringRef Name = "";
274609467b48Spatrick Expected<StringRef> NameOrErr = C.getName();
274709467b48Spatrick if (!NameOrErr) {
274809467b48Spatrick consumeError(NameOrErr.takeError());
274909467b48Spatrick Name = unwrapOrError(C.getRawName(), Filename);
275009467b48Spatrick } else {
275109467b48Spatrick Name = NameOrErr.get();
275209467b48Spatrick }
275309467b48Spatrick outs() << Name << "\n";
275409467b48Spatrick }
275509467b48Spatrick
275609467b48Spatrick // For ELF only now.
shouldWarnForInvalidStartStopAddress(ObjectFile * Obj)275709467b48Spatrick static bool shouldWarnForInvalidStartStopAddress(ObjectFile *Obj) {
275809467b48Spatrick if (const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj)) {
275909467b48Spatrick if (Elf->getEType() != ELF::ET_REL)
276009467b48Spatrick return true;
276109467b48Spatrick }
276209467b48Spatrick return false;
276309467b48Spatrick }
276409467b48Spatrick
checkForInvalidStartStopAddress(ObjectFile * Obj,uint64_t Start,uint64_t Stop)276509467b48Spatrick static void checkForInvalidStartStopAddress(ObjectFile *Obj,
276609467b48Spatrick uint64_t Start, uint64_t Stop) {
276709467b48Spatrick if (!shouldWarnForInvalidStartStopAddress(Obj))
276809467b48Spatrick return;
276909467b48Spatrick
277009467b48Spatrick for (const SectionRef &Section : Obj->sections())
277109467b48Spatrick if (ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC) {
277209467b48Spatrick uint64_t BaseAddr = Section.getAddress();
277309467b48Spatrick uint64_t Size = Section.getSize();
277409467b48Spatrick if ((Start < BaseAddr + Size) && Stop > BaseAddr)
277509467b48Spatrick return;
277609467b48Spatrick }
277709467b48Spatrick
277873471bf0Spatrick if (!HasStartAddressFlag)
277909467b48Spatrick reportWarning("no section has address less than 0x" +
278009467b48Spatrick Twine::utohexstr(Stop) + " specified by --stop-address",
278109467b48Spatrick Obj->getFileName());
278273471bf0Spatrick else if (!HasStopAddressFlag)
278309467b48Spatrick reportWarning("no section has address greater than or equal to 0x" +
278409467b48Spatrick Twine::utohexstr(Start) + " specified by --start-address",
278509467b48Spatrick Obj->getFileName());
278609467b48Spatrick else
278709467b48Spatrick reportWarning("no section overlaps the range [0x" +
278809467b48Spatrick Twine::utohexstr(Start) + ",0x" + Twine::utohexstr(Stop) +
278909467b48Spatrick ") specified by --start-address/--stop-address",
279009467b48Spatrick Obj->getFileName());
279109467b48Spatrick }
279209467b48Spatrick
dumpObject(ObjectFile * O,const Archive * A=nullptr,const Archive::Child * C=nullptr)279309467b48Spatrick static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
279409467b48Spatrick const Archive::Child *C = nullptr) {
279509467b48Spatrick // Avoid other output when using a raw option.
279609467b48Spatrick if (!RawClangAST) {
279709467b48Spatrick outs() << '\n';
279809467b48Spatrick if (A)
279909467b48Spatrick outs() << A->getFileName() << "(" << O->getFileName() << ")";
280009467b48Spatrick else
280109467b48Spatrick outs() << O->getFileName();
280273471bf0Spatrick outs() << ":\tfile format " << O->getFileFormatName().lower() << "\n";
280309467b48Spatrick }
280409467b48Spatrick
280573471bf0Spatrick if (HasStartAddressFlag || HasStopAddressFlag)
280609467b48Spatrick checkForInvalidStartStopAddress(O, StartAddress, StopAddress);
280709467b48Spatrick
280809467b48Spatrick // Note: the order here matches GNU objdump for compatability.
280909467b48Spatrick StringRef ArchiveName = A ? A->getFileName() : "";
281009467b48Spatrick if (ArchiveHeaders && !MachOOpt && C)
281109467b48Spatrick printArchiveChild(ArchiveName, *C);
281209467b48Spatrick if (FileHeaders)
281309467b48Spatrick printFileHeaders(O);
281409467b48Spatrick if (PrivateHeaders || FirstPrivateHeader)
281509467b48Spatrick printPrivateFileHeaders(O, FirstPrivateHeader);
281609467b48Spatrick if (SectionHeaders)
2817*d415bd75Srobert printSectionHeaders(*O);
281809467b48Spatrick if (SymbolTable)
2819*d415bd75Srobert printSymbolTable(*O, ArchiveName);
2820097a140dSpatrick if (DynamicSymbolTable)
2821*d415bd75Srobert printSymbolTable(*O, ArchiveName, /*ArchitectureName=*/"",
2822097a140dSpatrick /*DumpDynamic=*/true);
282309467b48Spatrick if (DwarfDumpType != DIDT_Null) {
282409467b48Spatrick std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
282509467b48Spatrick // Dump the complete DWARF structure.
282609467b48Spatrick DIDumpOptions DumpOpts;
282709467b48Spatrick DumpOpts.DumpType = DwarfDumpType;
282809467b48Spatrick DICtx->dump(outs(), DumpOpts);
282909467b48Spatrick }
283009467b48Spatrick if (Relocations && !Disassemble)
283109467b48Spatrick printRelocations(O);
283209467b48Spatrick if (DynamicRelocations)
283309467b48Spatrick printDynamicRelocations(O);
283409467b48Spatrick if (SectionContents)
283509467b48Spatrick printSectionContents(O);
283609467b48Spatrick if (Disassemble)
283709467b48Spatrick disassembleObject(O, Relocations);
283809467b48Spatrick if (UnwindInfo)
283909467b48Spatrick printUnwindInfo(O);
284009467b48Spatrick
284109467b48Spatrick // Mach-O specific options:
284209467b48Spatrick if (ExportsTrie)
284309467b48Spatrick printExportsTrie(O);
284409467b48Spatrick if (Rebase)
284509467b48Spatrick printRebaseTable(O);
284609467b48Spatrick if (Bind)
284709467b48Spatrick printBindTable(O);
284809467b48Spatrick if (LazyBind)
284909467b48Spatrick printLazyBindTable(O);
285009467b48Spatrick if (WeakBind)
285109467b48Spatrick printWeakBindTable(O);
285209467b48Spatrick
285309467b48Spatrick // Other special sections:
285409467b48Spatrick if (RawClangAST)
285509467b48Spatrick printRawClangAST(O);
285609467b48Spatrick if (FaultMapSection)
285709467b48Spatrick printFaultMaps(O);
2858*d415bd75Srobert if (Offloading)
2859*d415bd75Srobert dumpOffloadBinary(*O);
286009467b48Spatrick }
286109467b48Spatrick
dumpObject(const COFFImportFile * I,const Archive * A,const Archive::Child * C=nullptr)286209467b48Spatrick static void dumpObject(const COFFImportFile *I, const Archive *A,
286309467b48Spatrick const Archive::Child *C = nullptr) {
286409467b48Spatrick StringRef ArchiveName = A ? A->getFileName() : "";
286509467b48Spatrick
286609467b48Spatrick // Avoid other output when using a raw option.
286709467b48Spatrick if (!RawClangAST)
286809467b48Spatrick outs() << '\n'
286909467b48Spatrick << ArchiveName << "(" << I->getFileName() << ")"
287009467b48Spatrick << ":\tfile format COFF-import-file"
287109467b48Spatrick << "\n\n";
287209467b48Spatrick
287309467b48Spatrick if (ArchiveHeaders && !MachOOpt && C)
287409467b48Spatrick printArchiveChild(ArchiveName, *C);
287509467b48Spatrick if (SymbolTable)
2876*d415bd75Srobert printCOFFSymbolTable(*I);
287709467b48Spatrick }
287809467b48Spatrick
287909467b48Spatrick /// Dump each object file in \a a;
dumpArchive(const Archive * A)288009467b48Spatrick static void dumpArchive(const Archive *A) {
288109467b48Spatrick Error Err = Error::success();
288209467b48Spatrick unsigned I = -1;
288309467b48Spatrick for (auto &C : A->children(Err)) {
288409467b48Spatrick ++I;
288509467b48Spatrick Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
288609467b48Spatrick if (!ChildOrErr) {
288709467b48Spatrick if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
288809467b48Spatrick reportError(std::move(E), getFileNameForError(C, I), A->getFileName());
288909467b48Spatrick continue;
289009467b48Spatrick }
289109467b48Spatrick if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
289209467b48Spatrick dumpObject(O, A, &C);
289309467b48Spatrick else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
289409467b48Spatrick dumpObject(I, A, &C);
289509467b48Spatrick else
289609467b48Spatrick reportError(errorCodeToError(object_error::invalid_file_type),
289709467b48Spatrick A->getFileName());
289809467b48Spatrick }
289909467b48Spatrick if (Err)
290009467b48Spatrick reportError(std::move(Err), A->getFileName());
290109467b48Spatrick }
290209467b48Spatrick
290309467b48Spatrick /// Open file and figure out how to dump it.
dumpInput(StringRef file)290409467b48Spatrick static void dumpInput(StringRef file) {
290509467b48Spatrick // If we are using the Mach-O specific object file parser, then let it parse
290609467b48Spatrick // the file and process the command line options. So the -arch flags can
290709467b48Spatrick // be used to select specific slices, etc.
290809467b48Spatrick if (MachOOpt) {
290909467b48Spatrick parseInputMachO(file);
291009467b48Spatrick return;
291109467b48Spatrick }
291209467b48Spatrick
291309467b48Spatrick // Attempt to open the binary.
291409467b48Spatrick OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
291509467b48Spatrick Binary &Binary = *OBinary.getBinary();
291609467b48Spatrick
291709467b48Spatrick if (Archive *A = dyn_cast<Archive>(&Binary))
291809467b48Spatrick dumpArchive(A);
291909467b48Spatrick else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
292009467b48Spatrick dumpObject(O);
292109467b48Spatrick else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
292209467b48Spatrick parseInputMachO(UB);
2923*d415bd75Srobert else if (OffloadBinary *OB = dyn_cast<OffloadBinary>(&Binary))
2924*d415bd75Srobert dumpOffloadSections(*OB);
292509467b48Spatrick else
292609467b48Spatrick reportError(errorCodeToError(object_error::invalid_file_type), file);
292709467b48Spatrick }
292809467b48Spatrick
292973471bf0Spatrick template <typename T>
parseIntArg(const llvm::opt::InputArgList & InputArgs,int ID,T & Value)293073471bf0Spatrick static void parseIntArg(const llvm::opt::InputArgList &InputArgs, int ID,
293173471bf0Spatrick T &Value) {
293273471bf0Spatrick if (const opt::Arg *A = InputArgs.getLastArg(ID)) {
293373471bf0Spatrick StringRef V(A->getValue());
293473471bf0Spatrick if (!llvm::to_integer(V, Value, 0)) {
293573471bf0Spatrick reportCmdLineError(A->getSpelling() +
293673471bf0Spatrick ": expected a non-negative integer, but got '" + V +
293773471bf0Spatrick "'");
293873471bf0Spatrick }
293973471bf0Spatrick }
294073471bf0Spatrick }
294173471bf0Spatrick
parseBuildIDArg(const opt::Arg * A)2942*d415bd75Srobert static object::BuildID parseBuildIDArg(const opt::Arg *A) {
2943*d415bd75Srobert StringRef V(A->getValue());
2944*d415bd75Srobert std::string Bytes;
2945*d415bd75Srobert if (!tryGetFromHex(V, Bytes))
2946*d415bd75Srobert reportCmdLineError(A->getSpelling() + ": expected a build ID, but got '" +
2947*d415bd75Srobert V + "'");
2948*d415bd75Srobert ArrayRef<uint8_t> BuildID(reinterpret_cast<const uint8_t *>(Bytes.data()),
2949*d415bd75Srobert Bytes.size());
2950*d415bd75Srobert return object::BuildID(BuildID.begin(), BuildID.end());
2951*d415bd75Srobert }
2952*d415bd75Srobert
invalidArgValue(const opt::Arg * A)2953*d415bd75Srobert void objdump::invalidArgValue(const opt::Arg *A) {
2954*d415bd75Srobert reportCmdLineError("'" + StringRef(A->getValue()) +
2955*d415bd75Srobert "' is not a valid value for '" + A->getSpelling() + "'");
2956*d415bd75Srobert }
2957*d415bd75Srobert
295873471bf0Spatrick static std::vector<std::string>
commaSeparatedValues(const llvm::opt::InputArgList & InputArgs,int ID)295973471bf0Spatrick commaSeparatedValues(const llvm::opt::InputArgList &InputArgs, int ID) {
296073471bf0Spatrick std::vector<std::string> Values;
296173471bf0Spatrick for (StringRef Value : InputArgs.getAllArgValues(ID)) {
296273471bf0Spatrick llvm::SmallVector<StringRef, 2> SplitValues;
296373471bf0Spatrick llvm::SplitString(Value, SplitValues, ",");
296473471bf0Spatrick for (StringRef SplitValue : SplitValues)
296573471bf0Spatrick Values.push_back(SplitValue.str());
296673471bf0Spatrick }
296773471bf0Spatrick return Values;
296873471bf0Spatrick }
296973471bf0Spatrick
parseOtoolOptions(const llvm::opt::InputArgList & InputArgs)297073471bf0Spatrick static void parseOtoolOptions(const llvm::opt::InputArgList &InputArgs) {
297173471bf0Spatrick MachOOpt = true;
297273471bf0Spatrick FullLeadingAddr = true;
297373471bf0Spatrick PrintImmHex = true;
297473471bf0Spatrick
297573471bf0Spatrick ArchName = InputArgs.getLastArgValue(OTOOL_arch).str();
297673471bf0Spatrick LinkOptHints = InputArgs.hasArg(OTOOL_C);
297773471bf0Spatrick if (InputArgs.hasArg(OTOOL_d))
297873471bf0Spatrick FilterSections.push_back("__DATA,__data");
297973471bf0Spatrick DylibId = InputArgs.hasArg(OTOOL_D);
298073471bf0Spatrick UniversalHeaders = InputArgs.hasArg(OTOOL_f);
298173471bf0Spatrick DataInCode = InputArgs.hasArg(OTOOL_G);
298273471bf0Spatrick FirstPrivateHeader = InputArgs.hasArg(OTOOL_h);
298373471bf0Spatrick IndirectSymbols = InputArgs.hasArg(OTOOL_I);
298473471bf0Spatrick ShowRawInsn = InputArgs.hasArg(OTOOL_j);
298573471bf0Spatrick PrivateHeaders = InputArgs.hasArg(OTOOL_l);
298673471bf0Spatrick DylibsUsed = InputArgs.hasArg(OTOOL_L);
298773471bf0Spatrick MCPU = InputArgs.getLastArgValue(OTOOL_mcpu_EQ).str();
298873471bf0Spatrick ObjcMetaData = InputArgs.hasArg(OTOOL_o);
298973471bf0Spatrick DisSymName = InputArgs.getLastArgValue(OTOOL_p).str();
299073471bf0Spatrick InfoPlist = InputArgs.hasArg(OTOOL_P);
299173471bf0Spatrick Relocations = InputArgs.hasArg(OTOOL_r);
299273471bf0Spatrick if (const Arg *A = InputArgs.getLastArg(OTOOL_s)) {
299373471bf0Spatrick auto Filter = (A->getValue(0) + StringRef(",") + A->getValue(1)).str();
299473471bf0Spatrick FilterSections.push_back(Filter);
299573471bf0Spatrick }
299673471bf0Spatrick if (InputArgs.hasArg(OTOOL_t))
299773471bf0Spatrick FilterSections.push_back("__TEXT,__text");
299873471bf0Spatrick Verbose = InputArgs.hasArg(OTOOL_v) || InputArgs.hasArg(OTOOL_V) ||
299973471bf0Spatrick InputArgs.hasArg(OTOOL_o);
300073471bf0Spatrick SymbolicOperands = InputArgs.hasArg(OTOOL_V);
300173471bf0Spatrick if (InputArgs.hasArg(OTOOL_x))
300273471bf0Spatrick FilterSections.push_back(",__text");
300373471bf0Spatrick LeadingAddr = LeadingHeaders = !InputArgs.hasArg(OTOOL_X);
300473471bf0Spatrick
3005*d415bd75Srobert ChainedFixups = InputArgs.hasArg(OTOOL_chained_fixups);
3006*d415bd75Srobert DyldInfo = InputArgs.hasArg(OTOOL_dyld_info);
3007*d415bd75Srobert
300873471bf0Spatrick InputFilenames = InputArgs.getAllArgValues(OTOOL_INPUT);
300973471bf0Spatrick if (InputFilenames.empty())
301073471bf0Spatrick reportCmdLineError("no input file");
301173471bf0Spatrick
301273471bf0Spatrick for (const Arg *A : InputArgs) {
301373471bf0Spatrick const Option &O = A->getOption();
301473471bf0Spatrick if (O.getGroup().isValid() && O.getGroup().getID() == OTOOL_grp_obsolete) {
301573471bf0Spatrick reportCmdLineWarning(O.getPrefixedName() +
301673471bf0Spatrick " is obsolete and not implemented");
301773471bf0Spatrick }
301873471bf0Spatrick }
301973471bf0Spatrick }
302073471bf0Spatrick
parseObjdumpOptions(const llvm::opt::InputArgList & InputArgs)302173471bf0Spatrick static void parseObjdumpOptions(const llvm::opt::InputArgList &InputArgs) {
302273471bf0Spatrick parseIntArg(InputArgs, OBJDUMP_adjust_vma_EQ, AdjustVMA);
302373471bf0Spatrick AllHeaders = InputArgs.hasArg(OBJDUMP_all_headers);
302473471bf0Spatrick ArchName = InputArgs.getLastArgValue(OBJDUMP_arch_name_EQ).str();
302573471bf0Spatrick ArchiveHeaders = InputArgs.hasArg(OBJDUMP_archive_headers);
302673471bf0Spatrick Demangle = InputArgs.hasArg(OBJDUMP_demangle);
302773471bf0Spatrick Disassemble = InputArgs.hasArg(OBJDUMP_disassemble);
302873471bf0Spatrick DisassembleAll = InputArgs.hasArg(OBJDUMP_disassemble_all);
302973471bf0Spatrick SymbolDescription = InputArgs.hasArg(OBJDUMP_symbol_description);
303073471bf0Spatrick DisassembleSymbols =
303173471bf0Spatrick commaSeparatedValues(InputArgs, OBJDUMP_disassemble_symbols_EQ);
303273471bf0Spatrick DisassembleZeroes = InputArgs.hasArg(OBJDUMP_disassemble_zeroes);
303373471bf0Spatrick if (const opt::Arg *A = InputArgs.getLastArg(OBJDUMP_dwarf_EQ)) {
3034*d415bd75Srobert DwarfDumpType = StringSwitch<DIDumpType>(A->getValue())
3035*d415bd75Srobert .Case("frames", DIDT_DebugFrame)
3036*d415bd75Srobert .Default(DIDT_Null);
3037*d415bd75Srobert if (DwarfDumpType == DIDT_Null)
3038*d415bd75Srobert invalidArgValue(A);
303973471bf0Spatrick }
304073471bf0Spatrick DynamicRelocations = InputArgs.hasArg(OBJDUMP_dynamic_reloc);
304173471bf0Spatrick FaultMapSection = InputArgs.hasArg(OBJDUMP_fault_map_section);
3042*d415bd75Srobert Offloading = InputArgs.hasArg(OBJDUMP_offloading);
304373471bf0Spatrick FileHeaders = InputArgs.hasArg(OBJDUMP_file_headers);
304473471bf0Spatrick SectionContents = InputArgs.hasArg(OBJDUMP_full_contents);
304573471bf0Spatrick PrintLines = InputArgs.hasArg(OBJDUMP_line_numbers);
304673471bf0Spatrick InputFilenames = InputArgs.getAllArgValues(OBJDUMP_INPUT);
304773471bf0Spatrick MachOOpt = InputArgs.hasArg(OBJDUMP_macho);
304873471bf0Spatrick MCPU = InputArgs.getLastArgValue(OBJDUMP_mcpu_EQ).str();
304973471bf0Spatrick MAttrs = commaSeparatedValues(InputArgs, OBJDUMP_mattr_EQ);
305073471bf0Spatrick ShowRawInsn = !InputArgs.hasArg(OBJDUMP_no_show_raw_insn);
305173471bf0Spatrick LeadingAddr = !InputArgs.hasArg(OBJDUMP_no_leading_addr);
305273471bf0Spatrick RawClangAST = InputArgs.hasArg(OBJDUMP_raw_clang_ast);
305373471bf0Spatrick Relocations = InputArgs.hasArg(OBJDUMP_reloc);
305473471bf0Spatrick PrintImmHex =
3055*d415bd75Srobert InputArgs.hasFlag(OBJDUMP_print_imm_hex, OBJDUMP_no_print_imm_hex, true);
305673471bf0Spatrick PrivateHeaders = InputArgs.hasArg(OBJDUMP_private_headers);
305773471bf0Spatrick FilterSections = InputArgs.getAllArgValues(OBJDUMP_section_EQ);
305873471bf0Spatrick SectionHeaders = InputArgs.hasArg(OBJDUMP_section_headers);
3059*d415bd75Srobert ShowAllSymbols = InputArgs.hasArg(OBJDUMP_show_all_symbols);
306073471bf0Spatrick ShowLMA = InputArgs.hasArg(OBJDUMP_show_lma);
306173471bf0Spatrick PrintSource = InputArgs.hasArg(OBJDUMP_source);
306273471bf0Spatrick parseIntArg(InputArgs, OBJDUMP_start_address_EQ, StartAddress);
306373471bf0Spatrick HasStartAddressFlag = InputArgs.hasArg(OBJDUMP_start_address_EQ);
306473471bf0Spatrick parseIntArg(InputArgs, OBJDUMP_stop_address_EQ, StopAddress);
306573471bf0Spatrick HasStopAddressFlag = InputArgs.hasArg(OBJDUMP_stop_address_EQ);
306673471bf0Spatrick SymbolTable = InputArgs.hasArg(OBJDUMP_syms);
306773471bf0Spatrick SymbolizeOperands = InputArgs.hasArg(OBJDUMP_symbolize_operands);
306873471bf0Spatrick DynamicSymbolTable = InputArgs.hasArg(OBJDUMP_dynamic_syms);
306973471bf0Spatrick TripleName = InputArgs.getLastArgValue(OBJDUMP_triple_EQ).str();
307073471bf0Spatrick UnwindInfo = InputArgs.hasArg(OBJDUMP_unwind_info);
307173471bf0Spatrick Wide = InputArgs.hasArg(OBJDUMP_wide);
307273471bf0Spatrick Prefix = InputArgs.getLastArgValue(OBJDUMP_prefix).str();
307373471bf0Spatrick parseIntArg(InputArgs, OBJDUMP_prefix_strip, PrefixStrip);
307473471bf0Spatrick if (const opt::Arg *A = InputArgs.getLastArg(OBJDUMP_debug_vars_EQ)) {
307573471bf0Spatrick DbgVariables = StringSwitch<DebugVarsFormat>(A->getValue())
307673471bf0Spatrick .Case("ascii", DVASCII)
3077*d415bd75Srobert .Case("unicode", DVUnicode)
3078*d415bd75Srobert .Default(DVInvalid);
3079*d415bd75Srobert if (DbgVariables == DVInvalid)
3080*d415bd75Srobert invalidArgValue(A);
308173471bf0Spatrick }
308273471bf0Spatrick parseIntArg(InputArgs, OBJDUMP_debug_vars_indent_EQ, DbgIndent);
308373471bf0Spatrick
308473471bf0Spatrick parseMachOOptions(InputArgs);
308573471bf0Spatrick
308673471bf0Spatrick // Parse -M (--disassembler-options) and deprecated
308773471bf0Spatrick // --x86-asm-syntax={att,intel}.
308873471bf0Spatrick //
308973471bf0Spatrick // Note, for x86, the asm dialect (AssemblerDialect) is initialized when the
309073471bf0Spatrick // MCAsmInfo is constructed. MCInstPrinter::applyTargetSpecificCLOption is
309173471bf0Spatrick // called too late. For now we have to use the internal cl::opt option.
309273471bf0Spatrick const char *AsmSyntax = nullptr;
309373471bf0Spatrick for (const auto *A : InputArgs.filtered(OBJDUMP_disassembler_options_EQ,
309473471bf0Spatrick OBJDUMP_x86_asm_syntax_att,
309573471bf0Spatrick OBJDUMP_x86_asm_syntax_intel)) {
309673471bf0Spatrick switch (A->getOption().getID()) {
309773471bf0Spatrick case OBJDUMP_x86_asm_syntax_att:
309873471bf0Spatrick AsmSyntax = "--x86-asm-syntax=att";
309973471bf0Spatrick continue;
310073471bf0Spatrick case OBJDUMP_x86_asm_syntax_intel:
310173471bf0Spatrick AsmSyntax = "--x86-asm-syntax=intel";
310273471bf0Spatrick continue;
310373471bf0Spatrick }
310473471bf0Spatrick
310573471bf0Spatrick SmallVector<StringRef, 2> Values;
310673471bf0Spatrick llvm::SplitString(A->getValue(), Values, ",");
310773471bf0Spatrick for (StringRef V : Values) {
310873471bf0Spatrick if (V == "att")
310973471bf0Spatrick AsmSyntax = "--x86-asm-syntax=att";
311073471bf0Spatrick else if (V == "intel")
311173471bf0Spatrick AsmSyntax = "--x86-asm-syntax=intel";
311273471bf0Spatrick else
311373471bf0Spatrick DisassemblerOptions.push_back(V.str());
311473471bf0Spatrick }
311573471bf0Spatrick }
311673471bf0Spatrick if (AsmSyntax) {
311773471bf0Spatrick const char *Argv[] = {"llvm-objdump", AsmSyntax};
311873471bf0Spatrick llvm::cl::ParseCommandLineOptions(2, Argv);
311973471bf0Spatrick }
312073471bf0Spatrick
3121*d415bd75Srobert // Look up any provided build IDs, then append them to the input filenames.
3122*d415bd75Srobert for (const opt::Arg *A : InputArgs.filtered(OBJDUMP_build_id)) {
3123*d415bd75Srobert object::BuildID BuildID = parseBuildIDArg(A);
3124*d415bd75Srobert std::optional<std::string> Path = BIDFetcher->fetch(BuildID);
3125*d415bd75Srobert if (!Path) {
3126*d415bd75Srobert reportCmdLineError(A->getSpelling() + ": could not find build ID '" +
3127*d415bd75Srobert A->getValue() + "'");
3128*d415bd75Srobert }
3129*d415bd75Srobert InputFilenames.push_back(std::move(*Path));
3130*d415bd75Srobert }
3131*d415bd75Srobert
313273471bf0Spatrick // objdump defaults to a.out if no filenames specified.
313373471bf0Spatrick if (InputFilenames.empty())
313473471bf0Spatrick InputFilenames.push_back("a.out");
313573471bf0Spatrick }
313673471bf0Spatrick
main(int argc,char ** argv)313709467b48Spatrick int main(int argc, char **argv) {
313809467b48Spatrick using namespace llvm;
313909467b48Spatrick InitLLVM X(argc, argv);
314073471bf0Spatrick
314173471bf0Spatrick ToolName = argv[0];
314273471bf0Spatrick std::unique_ptr<CommonOptTable> T;
314373471bf0Spatrick OptSpecifier Unknown, HelpFlag, HelpHiddenFlag, VersionFlag;
314473471bf0Spatrick
314573471bf0Spatrick StringRef Stem = sys::path::stem(ToolName);
314673471bf0Spatrick auto Is = [=](StringRef Tool) {
314773471bf0Spatrick // We need to recognize the following filenames:
314873471bf0Spatrick //
314973471bf0Spatrick // llvm-objdump -> objdump
315073471bf0Spatrick // llvm-otool-10.exe -> otool
315173471bf0Spatrick // powerpc64-unknown-freebsd13-objdump -> objdump
315273471bf0Spatrick auto I = Stem.rfind_insensitive(Tool);
315373471bf0Spatrick return I != StringRef::npos &&
315473471bf0Spatrick (I + Tool.size() == Stem.size() || !isAlnum(Stem[I + Tool.size()]));
315573471bf0Spatrick };
315673471bf0Spatrick if (Is("otool")) {
315773471bf0Spatrick T = std::make_unique<OtoolOptTable>();
315873471bf0Spatrick Unknown = OTOOL_UNKNOWN;
315973471bf0Spatrick HelpFlag = OTOOL_help;
316073471bf0Spatrick HelpHiddenFlag = OTOOL_help_hidden;
316173471bf0Spatrick VersionFlag = OTOOL_version;
316273471bf0Spatrick } else {
316373471bf0Spatrick T = std::make_unique<ObjdumpOptTable>();
316473471bf0Spatrick Unknown = OBJDUMP_UNKNOWN;
316573471bf0Spatrick HelpFlag = OBJDUMP_help;
316673471bf0Spatrick HelpHiddenFlag = OBJDUMP_help_hidden;
316773471bf0Spatrick VersionFlag = OBJDUMP_version;
316873471bf0Spatrick }
316973471bf0Spatrick
317073471bf0Spatrick BumpPtrAllocator A;
317173471bf0Spatrick StringSaver Saver(A);
317273471bf0Spatrick opt::InputArgList InputArgs =
317373471bf0Spatrick T->parseArgs(argc, argv, Unknown, Saver,
317473471bf0Spatrick [&](StringRef Msg) { reportCmdLineError(Msg); });
317573471bf0Spatrick
317673471bf0Spatrick if (InputArgs.size() == 0 || InputArgs.hasArg(HelpFlag)) {
317773471bf0Spatrick T->printHelp(ToolName);
317873471bf0Spatrick return 0;
317973471bf0Spatrick }
318073471bf0Spatrick if (InputArgs.hasArg(HelpHiddenFlag)) {
3181*d415bd75Srobert T->printHelp(ToolName, /*ShowHidden=*/true);
318273471bf0Spatrick return 0;
318373471bf0Spatrick }
318409467b48Spatrick
318509467b48Spatrick // Initialize targets and assembly printers/parsers.
318609467b48Spatrick InitializeAllTargetInfos();
318709467b48Spatrick InitializeAllTargetMCs();
318809467b48Spatrick InitializeAllDisassemblers();
318909467b48Spatrick
319073471bf0Spatrick if (InputArgs.hasArg(VersionFlag)) {
319173471bf0Spatrick cl::PrintVersionMessage();
319273471bf0Spatrick if (!Is("otool")) {
319373471bf0Spatrick outs() << '\n';
319473471bf0Spatrick TargetRegistry::printRegisteredTargetsForVersion(outs());
319573471bf0Spatrick }
319673471bf0Spatrick return 0;
319773471bf0Spatrick }
319809467b48Spatrick
3199*d415bd75Srobert // Initialize debuginfod.
3200*d415bd75Srobert const bool ShouldUseDebuginfodByDefault =
3201*d415bd75Srobert InputArgs.hasArg(OBJDUMP_build_id) || canUseDebuginfod();
3202*d415bd75Srobert std::vector<std::string> DebugFileDirectories =
3203*d415bd75Srobert InputArgs.getAllArgValues(OBJDUMP_debug_file_directory);
3204*d415bd75Srobert if (InputArgs.hasFlag(OBJDUMP_debuginfod, OBJDUMP_no_debuginfod,
3205*d415bd75Srobert ShouldUseDebuginfodByDefault)) {
3206*d415bd75Srobert HTTPClient::initialize();
3207*d415bd75Srobert BIDFetcher =
3208*d415bd75Srobert std::make_unique<DebuginfodFetcher>(std::move(DebugFileDirectories));
3209*d415bd75Srobert } else {
3210*d415bd75Srobert BIDFetcher =
3211*d415bd75Srobert std::make_unique<BuildIDFetcher>(std::move(DebugFileDirectories));
3212*d415bd75Srobert }
3213*d415bd75Srobert
321473471bf0Spatrick if (Is("otool"))
321573471bf0Spatrick parseOtoolOptions(InputArgs);
321673471bf0Spatrick else
321773471bf0Spatrick parseObjdumpOptions(InputArgs);
321809467b48Spatrick
321909467b48Spatrick if (StartAddress >= StopAddress)
322009467b48Spatrick reportCmdLineError("start address should be less than stop address");
322109467b48Spatrick
322273471bf0Spatrick // Removes trailing separators from prefix.
322373471bf0Spatrick while (!Prefix.empty() && sys::path::is_separator(Prefix.back()))
322473471bf0Spatrick Prefix.pop_back();
322509467b48Spatrick
322609467b48Spatrick if (AllHeaders)
322709467b48Spatrick ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
322809467b48Spatrick SectionHeaders = SymbolTable = true;
322909467b48Spatrick
323009467b48Spatrick if (DisassembleAll || PrintSource || PrintLines ||
3231097a140dSpatrick !DisassembleSymbols.empty())
323209467b48Spatrick Disassemble = true;
323309467b48Spatrick
323409467b48Spatrick if (!ArchiveHeaders && !Disassemble && DwarfDumpType == DIDT_Null &&
323509467b48Spatrick !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST &&
323609467b48Spatrick !Relocations && !SectionHeaders && !SectionContents && !SymbolTable &&
3237*d415bd75Srobert !DynamicSymbolTable && !UnwindInfo && !FaultMapSection && !Offloading &&
323809467b48Spatrick !(MachOOpt &&
3239*d415bd75Srobert (Bind || DataInCode || ChainedFixups || DyldInfo || DylibId ||
3240*d415bd75Srobert DylibsUsed || ExportsTrie || FirstPrivateHeader ||
3241*d415bd75Srobert FunctionStartsType != FunctionStartsMode::None || IndirectSymbols ||
3242*d415bd75Srobert InfoPlist || LazyBind || LinkOptHints || ObjcMetaData || Rebase ||
3243*d415bd75Srobert Rpaths || UniversalHeaders || WeakBind || !FilterSections.empty()))) {
324473471bf0Spatrick T->printHelp(ToolName);
324509467b48Spatrick return 2;
324609467b48Spatrick }
324709467b48Spatrick
3248097a140dSpatrick DisasmSymbolSet.insert(DisassembleSymbols.begin(), DisassembleSymbols.end());
324909467b48Spatrick
325009467b48Spatrick llvm::for_each(InputFilenames, dumpInput);
325109467b48Spatrick
325209467b48Spatrick warnOnNoMatchForSections();
325309467b48Spatrick
325409467b48Spatrick return EXIT_SUCCESS;
325509467b48Spatrick }
3256