1 //===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is a tool similar to readelf, except it works on multiple object file
11 // formats. The main purpose of this tool is to provide detailed output suitable
12 // for FileCheck.
13 //
14 // Flags should be similar to readelf where supported, but the output format
15 // does not need to be identical. The point is to not make users learn yet
16 // another set of flags.
17 //
18 // Output should be specialized for each format where appropriate.
19 //
20 //===----------------------------------------------------------------------===//
21
22 #include "llvm-readobj.h"
23
24 #include "Error.h"
25 #include "ObjDumper.h"
26 #include "StreamWriter.h"
27
28 #include "llvm/Object/Archive.h"
29 #include "llvm/Object/ObjectFile.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/DataTypes.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/FileSystem.h"
35 #include "llvm/Support/ManagedStatic.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Signals.h"
38 #include "llvm/Support/TargetRegistry.h"
39 #include "llvm/Support/TargetSelect.h"
40 #include "llvm/Support/system_error.h"
41
42 #include <string>
43
44
45 using namespace llvm;
46 using namespace llvm::object;
47
48 namespace opts {
49 cl::list<std::string> InputFilenames(cl::Positional,
50 cl::desc("<input object files>"),
51 cl::ZeroOrMore);
52
53 // -file-headers, -h
54 cl::opt<bool> FileHeaders("file-headers",
55 cl::desc("Display file headers "));
56 cl::alias FileHeadersShort("h",
57 cl::desc("Alias for --file-headers"),
58 cl::aliasopt(FileHeaders));
59
60 // -sections, -s
61 cl::opt<bool> Sections("sections",
62 cl::desc("Display all sections."));
63 cl::alias SectionsShort("s",
64 cl::desc("Alias for --sections"),
65 cl::aliasopt(Sections));
66
67 // -section-relocations, -sr
68 cl::opt<bool> SectionRelocations("section-relocations",
69 cl::desc("Display relocations for each section shown."));
70 cl::alias SectionRelocationsShort("sr",
71 cl::desc("Alias for --section-relocations"),
72 cl::aliasopt(SectionRelocations));
73
74 // -section-symbols, -st
75 cl::opt<bool> SectionSymbols("section-symbols",
76 cl::desc("Display symbols for each section shown."));
77 cl::alias SectionSymbolsShort("st",
78 cl::desc("Alias for --section-symbols"),
79 cl::aliasopt(SectionSymbols));
80
81 // -section-data, -sd
82 cl::opt<bool> SectionData("section-data",
83 cl::desc("Display section data for each section shown."));
84 cl::alias SectionDataShort("sd",
85 cl::desc("Alias for --section-data"),
86 cl::aliasopt(SectionData));
87
88 // -relocations, -r
89 cl::opt<bool> Relocations("relocations",
90 cl::desc("Display the relocation entries in the file"));
91 cl::alias RelocationsShort("r",
92 cl::desc("Alias for --relocations"),
93 cl::aliasopt(Relocations));
94
95 // -symbols, -t
96 cl::opt<bool> Symbols("symbols",
97 cl::desc("Display the symbol table"));
98 cl::alias SymbolsShort("t",
99 cl::desc("Alias for --symbols"),
100 cl::aliasopt(Symbols));
101
102 // -dyn-symbols, -dt
103 cl::opt<bool> DynamicSymbols("dyn-symbols",
104 cl::desc("Display the dynamic symbol table"));
105 cl::alias DynamicSymbolsShort("dt",
106 cl::desc("Alias for --dyn-symbols"),
107 cl::aliasopt(DynamicSymbols));
108
109 // -unwind, -u
110 cl::opt<bool> UnwindInfo("unwind",
111 cl::desc("Display unwind information"));
112 cl::alias UnwindInfoShort("u",
113 cl::desc("Alias for --unwind"),
114 cl::aliasopt(UnwindInfo));
115
116 // -dynamic-table
117 cl::opt<bool> DynamicTable("dynamic-table",
118 cl::desc("Display the ELF .dynamic section table"));
119
120 // -needed-libs
121 cl::opt<bool> NeededLibraries("needed-libs",
122 cl::desc("Display the needed libraries"));
123
124 // -program-headers
125 cl::opt<bool> ProgramHeaders("program-headers",
126 cl::desc("Display ELF program headers"));
127
128 // -expand-relocs
129 cl::opt<bool> ExpandRelocs("expand-relocs",
130 cl::desc("Expand each shown relocation to multiple lines"));
131 } // namespace opts
132
133 static int ReturnValue = EXIT_SUCCESS;
134
135 namespace llvm {
136
error(error_code EC)137 bool error(error_code EC) {
138 if (!EC)
139 return false;
140
141 ReturnValue = EXIT_FAILURE;
142 outs() << "\nError reading file: " << EC.message() << ".\n";
143 outs().flush();
144 return true;
145 }
146
relocAddressLess(RelocationRef a,RelocationRef b)147 bool relocAddressLess(RelocationRef a, RelocationRef b) {
148 uint64_t a_addr, b_addr;
149 if (error(a.getOffset(a_addr))) return false;
150 if (error(b.getOffset(b_addr))) return false;
151 return a_addr < b_addr;
152 }
153
154 } // namespace llvm
155
156
reportError(StringRef Input,error_code EC)157 static void reportError(StringRef Input, error_code EC) {
158 if (Input == "-")
159 Input = "<stdin>";
160
161 errs() << Input << ": " << EC.message() << "\n";
162 errs().flush();
163 ReturnValue = EXIT_FAILURE;
164 }
165
reportError(StringRef Input,StringRef Message)166 static void reportError(StringRef Input, StringRef Message) {
167 if (Input == "-")
168 Input = "<stdin>";
169
170 errs() << Input << ": " << Message << "\n";
171 ReturnValue = EXIT_FAILURE;
172 }
173
174 /// @brief Creates an format-specific object file dumper.
createDumper(const ObjectFile * Obj,StreamWriter & Writer,OwningPtr<ObjDumper> & Result)175 static error_code createDumper(const ObjectFile *Obj,
176 StreamWriter &Writer,
177 OwningPtr<ObjDumper> &Result) {
178 if (!Obj)
179 return readobj_error::unsupported_file_format;
180
181 if (Obj->isCOFF())
182 return createCOFFDumper(Obj, Writer, Result);
183 if (Obj->isELF())
184 return createELFDumper(Obj, Writer, Result);
185 if (Obj->isMachO())
186 return createMachODumper(Obj, Writer, Result);
187
188 return readobj_error::unsupported_obj_file_format;
189 }
190
191
192 /// @brief Dumps the specified object file.
dumpObject(const ObjectFile * Obj)193 static void dumpObject(const ObjectFile *Obj) {
194 StreamWriter Writer(outs());
195 OwningPtr<ObjDumper> Dumper;
196 if (error_code EC = createDumper(Obj, Writer, Dumper)) {
197 reportError(Obj->getFileName(), EC);
198 return;
199 }
200
201 outs() << '\n';
202 outs() << "File: " << Obj->getFileName() << "\n";
203 outs() << "Format: " << Obj->getFileFormatName() << "\n";
204 outs() << "Arch: "
205 << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch())
206 << "\n";
207 outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n";
208 if (Obj->isELF())
209 outs() << "LoadName: " << Obj->getLoadName() << "\n";
210
211 if (opts::FileHeaders)
212 Dumper->printFileHeaders();
213 if (opts::Sections)
214 Dumper->printSections();
215 if (opts::Relocations)
216 Dumper->printRelocations();
217 if (opts::Symbols)
218 Dumper->printSymbols();
219 if (opts::DynamicSymbols)
220 Dumper->printDynamicSymbols();
221 if (opts::UnwindInfo)
222 Dumper->printUnwindInfo();
223 if (opts::DynamicTable)
224 Dumper->printDynamicTable();
225 if (opts::NeededLibraries)
226 Dumper->printNeededLibraries();
227 if (opts::ProgramHeaders)
228 Dumper->printProgramHeaders();
229 }
230
231
232 /// @brief Dumps each object file in \a Arc;
dumpArchive(const Archive * Arc)233 static void dumpArchive(const Archive *Arc) {
234 for (Archive::child_iterator ArcI = Arc->begin_children(),
235 ArcE = Arc->end_children();
236 ArcI != ArcE; ++ArcI) {
237 OwningPtr<Binary> child;
238 if (error_code EC = ArcI->getAsBinary(child)) {
239 // Ignore non-object files.
240 if (EC != object_error::invalid_file_type)
241 reportError(Arc->getFileName(), EC.message());
242 continue;
243 }
244
245 if (ObjectFile *Obj = dyn_cast<ObjectFile>(child.get()))
246 dumpObject(Obj);
247 else
248 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
249 }
250 }
251
252
253 /// @brief Opens \a File and dumps it.
dumpInput(StringRef File)254 static void dumpInput(StringRef File) {
255 // If file isn't stdin, check that it exists.
256 if (File != "-" && !sys::fs::exists(File)) {
257 reportError(File, readobj_error::file_not_found);
258 return;
259 }
260
261 // Attempt to open the binary.
262 OwningPtr<Binary> Binary;
263 if (error_code EC = createBinary(File, Binary)) {
264 reportError(File, EC);
265 return;
266 }
267
268 if (Archive *Arc = dyn_cast<Archive>(Binary.get()))
269 dumpArchive(Arc);
270 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(Binary.get()))
271 dumpObject(Obj);
272 else
273 reportError(File, readobj_error::unrecognized_file_format);
274 }
275
276
main(int argc,const char * argv[])277 int main(int argc, const char *argv[]) {
278 sys::PrintStackTraceOnErrorSignal();
279 PrettyStackTraceProgram X(argc, argv);
280 llvm_shutdown_obj Y;
281
282 // Initialize targets.
283 llvm::InitializeAllTargetInfos();
284
285 // Register the target printer for --version.
286 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
287
288 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
289
290 // Default to stdin if no filename is specified.
291 if (opts::InputFilenames.size() == 0)
292 opts::InputFilenames.push_back("-");
293
294 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
295 dumpInput);
296
297 return ReturnValue;
298 }
299