1//===--- llvm-objdump.h -----------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_TOOLS_LLVM_OBJDUMP_LLVM_OBJDUMP_H
10#define LLVM_TOOLS_LLVM_OBJDUMP_LLVM_OBJDUMP_H
11
12#include "llvm/ADT/StringSet.h"
13#include "llvm/DebugInfo/DIContext.h"
14#include "llvm/MC/MCDisassembler/MCDisassembler.h"
15#include "llvm/MC/MCSubtargetInfo.h"
16#include "llvm/Object/Archive.h"
17#include "llvm/Object/ObjectFile.h"
18#include "llvm/Support/FormattedStream.h"
19#include <functional>
20#include <memory>
21
22namespace llvm {
23class StringRef;
24class Twine;
25
26namespace opt {
27class Arg;
28} // namespace opt
29
30namespace object {
31class RelocationRef;
32struct VersionEntry;
33
34class COFFObjectFile;
35class ELFObjectFileBase;
36class MachOObjectFile;
37class WasmObjectFile;
38class XCOFFObjectFile;
39} // namespace object
40
41namespace objdump {
42
43enum DebugVarsFormat { DVDisabled, DVUnicode, DVASCII, DVInvalid };
44
45extern bool ArchiveHeaders;
46extern int DbgIndent;
47extern DebugVarsFormat DbgVariables;
48extern bool Demangle;
49extern bool Disassemble;
50extern bool DisassembleAll;
51extern std::vector<std::string> DisassemblerOptions;
52extern DIDumpType DwarfDumpType;
53extern std::vector<std::string> FilterSections;
54extern bool LeadingAddr;
55extern std::vector<std::string> MAttrs;
56extern std::string MCPU;
57extern std::string Prefix;
58extern uint32_t PrefixStrip;
59extern bool PrintImmHex;
60extern bool PrintLines;
61extern bool PrintSource;
62extern bool PrivateHeaders;
63extern bool Relocations;
64extern bool SectionHeaders;
65extern bool SectionContents;
66extern bool ShowRawInsn;
67extern bool SymbolDescription;
68extern bool TracebackTable;
69extern bool SymbolTable;
70extern std::string TripleName;
71extern bool UnwindInfo;
72
73extern StringSet<> FoundSectionSet;
74
75class Dumper {
76 const object::ObjectFile &O;
77 StringSet<> Warnings;
78
79protected:
80 llvm::raw_ostream &OS;
81 std::function<Error(const Twine &Msg)> WarningHandler;
82
83public:
84 Dumper(const object::ObjectFile &O);
85 virtual ~Dumper() {}
86
87 void reportUniqueWarning(Error Err);
88 void reportUniqueWarning(const Twine &Msg);
89
90 virtual void printPrivateHeaders();
91 virtual void printDynamicRelocations() {}
92 void printSymbolTable(StringRef ArchiveName,
93 StringRef ArchitectureName = StringRef(),
94 bool DumpDynamic = false);
95 void printSymbol(const object::SymbolRef &Symbol,
96 ArrayRef<object::VersionEntry> SymbolVersions,
97 StringRef FileName, StringRef ArchiveName,
98 StringRef ArchitectureName, bool DumpDynamic);
99 void printRelocations();
100};
101
102std::unique_ptr<Dumper> createCOFFDumper(const object::COFFObjectFile &Obj);
103std::unique_ptr<Dumper> createELFDumper(const object::ELFObjectFileBase &Obj);
104std::unique_ptr<Dumper> createMachODumper(const object::MachOObjectFile &Obj);
105std::unique_ptr<Dumper> createWasmDumper(const object::WasmObjectFile &Obj);
106std::unique_ptr<Dumper> createXCOFFDumper(const object::XCOFFObjectFile &Obj);
107
108// Various helper functions.
109
110/// Creates a SectionFilter with a standard predicate that conditionally skips
111/// sections when the --section objdump flag is provided.
112///
113/// Idx is an optional output parameter that keeps track of which section index
114/// this is. This may be different than the actual section number, as some
115/// sections may be filtered (e.g. symbol tables).
116object::SectionFilter ToolSectionFilter(const llvm::object::ObjectFile &O,
117 uint64_t *Idx = nullptr);
118
119bool isRelocAddressLess(object::RelocationRef A, object::RelocationRef B);
120void printSectionHeaders(object::ObjectFile &O);
121void printSectionContents(const object::ObjectFile *O);
122[[noreturn]] void reportError(StringRef File, const Twine &Message);
123[[noreturn]] void reportError(Error E, StringRef FileName,
124 StringRef ArchiveName = "",
125 StringRef ArchitectureName = "");
126void reportWarning(const Twine &Message, StringRef File);
127
128template <typename T, typename... Ts>
129T unwrapOrError(Expected<T> EO, Ts &&... Args) {
130 if (EO)
131 return std::move(*EO);
132 reportError(EO.takeError(), std::forward<Ts>(Args)...);
133}
134
135void invalidArgValue(const opt::Arg *A);
136
137std::string getFileNameForError(const object::Archive::Child &C,
138 unsigned Index);
139SymbolInfoTy createSymbolInfo(const object::ObjectFile &Obj,
140 const object::SymbolRef &Symbol,
141 bool IsMappingSymbol = false);
142unsigned getInstStartColumn(const MCSubtargetInfo &STI);
143void printRawData(llvm::ArrayRef<uint8_t> Bytes, uint64_t Address,
144 llvm::formatted_raw_ostream &OS,
145 llvm::MCSubtargetInfo const &STI);
146
147} // namespace objdump
148} // end namespace llvm
149
150#endif
151