1 //===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like traditional Unix "readelf",
11 // except that it can handle any type of object file recognized by lib/Object.
13 // It makes use of the generic ObjectFile interface.
15 // Caution: This utility is new, experimental, unsupported, and incomplete.
17 //===----------------------------------------------------------------------===//
19 #include "llvm/ADT/Triple.h"
20 #include "llvm/Analysis/Verifier.h"
21 #include "llvm/Object/ELF.h"
22 #include "llvm/Object/ObjectFile.h"
23 #include "llvm/Support/CommandLine.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/Format.h"
26 #include "llvm/Support/FormattedStream.h"
27 #include "llvm/Support/PrettyStackTrace.h"
28 #include "llvm/Support/Signals.h"
31 using namespace llvm::object;
33 static cl::opt<std::string>
34 InputFilename(cl::Positional, cl::desc("<input object>"), cl::init(""));
36 static void dumpSymbolHeader() {
37 outs() << format(" %-32s", (const char*)"Name")
38 << format(" %-4s", (const char*)"Type")
39 << format(" %-16s", (const char*)"Address")
40 << format(" %-16s", (const char*)"Size")
41 << format(" %-16s", (const char*)"FileOffset")
42 << format(" %-26s", (const char*)"Flags")
46 static void dumpSectionHeader() {
47 outs() << format(" %-24s", (const char*)"Name")
48 << format(" %-16s", (const char*)"Address")
49 << format(" %-16s", (const char*)"Size")
50 << format(" %-8s", (const char*)"Align")
51 << format(" %-26s", (const char*)"Flags")
55 static const char *getTypeStr(SymbolRef::Type Type) {
57 case SymbolRef::ST_Unknown: return "?";
58 case SymbolRef::ST_Data: return "DATA";
59 case SymbolRef::ST_Debug: return "DBG";
60 case SymbolRef::ST_File: return "FILE";
61 case SymbolRef::ST_Function: return "FUNC";
62 case SymbolRef::ST_Other: return "-";
67 static std::string getSymbolFlagStr(uint32_t Flags) {
69 if (Flags & SymbolRef::SF_Undefined)
71 if (Flags & SymbolRef::SF_Global)
73 if (Flags & SymbolRef::SF_Weak)
75 if (Flags & SymbolRef::SF_Absolute)
76 result += "absolute,";
77 if (Flags & SymbolRef::SF_ThreadLocal)
78 result += "threadlocal,";
79 if (Flags & SymbolRef::SF_Common)
81 if (Flags & SymbolRef::SF_FormatSpecific)
82 result += "formatspecific,";
84 // Remove trailing comma
85 if (result.size() > 0) {
86 result.erase(result.size() - 1);
91 static void checkError(error_code ec, const char *msg) {
93 report_fatal_error(std::string(msg) + ": " + ec.message());
96 static std::string getSectionFlagStr(const SectionRef &Section) {
98 error_code (SectionRef::*MemF)(bool &) const;
99 const char *FlagStr, *ErrorStr;
101 {{ &SectionRef::isText, "text,", "Section.isText() failed" },
102 { &SectionRef::isData, "data,", "Section.isData() failed" },
103 { &SectionRef::isBSS, "bss,", "Section.isBSS() failed" },
104 { &SectionRef::isRequiredForExecution, "required,",
105 "Section.isRequiredForExecution() failed" },
106 { &SectionRef::isVirtual, "virtual,", "Section.isVirtual() failed" },
107 { &SectionRef::isZeroInit, "zeroinit,", "Section.isZeroInit() failed" },
108 { &SectionRef::isReadOnlyData, "rodata,",
109 "Section.isReadOnlyData() failed" }};
112 for (uint32_t I = 0; I < sizeof(Work)/sizeof(*Work); ++I) {
114 checkError((Section.*Work[I].MemF)(B), Work[I].ErrorStr);
116 result += Work[I].FlagStr;
119 // Remove trailing comma
120 if (result.size() > 0) {
121 result.erase(result.size() - 1);
127 dumpSymbol(const SymbolRef &Sym, const ObjectFile *obj, bool IsDynamic) {
129 SymbolRef::Type Type;
134 checkError(Sym.getName(Name), "SymbolRef.getName() failed");
135 checkError(Sym.getAddress(Address), "SymbolRef.getAddress() failed");
136 checkError(Sym.getSize(Size), "SymbolRef.getSize() failed");
137 checkError(Sym.getFileOffset(FileOffset),
138 "SymbolRef.getFileOffset() failed");
139 checkError(Sym.getType(Type), "SymbolRef.getType() failed");
140 checkError(Sym.getFlags(Flags), "SymbolRef.getFlags() failed");
141 std::string FullName = Name;
143 // If this is a dynamic symbol from an ELF object, append
144 // the symbol's version to the name.
145 if (IsDynamic && obj->isELF()) {
148 GetELFSymbolVersion(obj, Sym, Version, IsDefault);
149 if (!Version.empty()) {
150 FullName += (IsDefault ? "@@" : "@");
155 // format() can't handle StringRefs
156 outs() << format(" %-32s", FullName.c_str())
157 << format(" %-4s", getTypeStr(Type))
158 << format(" %16" PRIx64, Address)
159 << format(" %16" PRIx64, Size)
160 << format(" %16" PRIx64, FileOffset)
161 << " " << getSymbolFlagStr(Flags)
165 // Iterate through the normal symbols in the ObjectFile
166 static void dumpSymbols(const ObjectFile *obj) {
169 outs() << "Symbols:\n";
171 symbol_iterator it = obj->begin_symbols();
172 symbol_iterator ie = obj->end_symbols();
174 dumpSymbol(*it, obj, false);
177 report_fatal_error("Symbol iteration failed");
180 outs() << " Total: " << count << "\n\n";
183 // Iterate through the dynamic symbols in the ObjectFile.
184 static void dumpDynamicSymbols(const ObjectFile *obj) {
187 outs() << "Dynamic Symbols:\n";
189 symbol_iterator it = obj->begin_dynamic_symbols();
190 symbol_iterator ie = obj->end_dynamic_symbols();
192 dumpSymbol(*it, obj, true);
195 report_fatal_error("Symbol iteration failed");
198 outs() << " Total: " << count << "\n\n";
201 static void dumpSection(const SectionRef &Section, const ObjectFile *obj) {
203 checkError(Section.getName(Name), "SectionRef::getName() failed");
204 uint64_t Addr, Size, Align;
205 checkError(Section.getAddress(Addr), "SectionRef::getAddress() failed");
206 checkError(Section.getSize(Size), "SectionRef::getSize() failed");
207 checkError(Section.getAlignment(Align), "SectionRef::getAlignment() failed");
208 outs() << format(" %-24s", std::string(Name).c_str())
209 << format(" %16" PRIx64, Addr)
210 << format(" %16" PRIx64, Size)
211 << format(" %8" PRIx64, Align)
212 << " " << getSectionFlagStr(Section)
216 static void dumpLibrary(const LibraryRef &lib) {
219 outs() << " " << path << "\n";
222 template<typename Iterator, typename Func>
223 static void dump(const ObjectFile *obj, Func f, Iterator begin, Iterator end,
224 const char *errStr) {
227 Iterator it = begin, ie = end;
232 report_fatal_error(errStr);
235 outs() << " Total: " << count << "\n\n";
238 // Iterate through needed libraries
239 static void dumpLibrariesNeeded(const ObjectFile *obj) {
242 library_iterator it = obj->begin_libraries_needed();
243 library_iterator ie = obj->end_libraries_needed();
244 outs() << "Libraries needed:\n";
249 report_fatal_error("Needed libraries iteration failed");
252 outs() << " Total: " << count << "\n\n";
255 static void dumpHeaders(const ObjectFile *obj) {
256 outs() << "File Format : " << obj->getFileFormatName() << "\n";
258 << Triple::getArchTypeName((llvm::Triple::ArchType)obj->getArch())
260 outs() << "Address Size: " << (8*obj->getBytesInAddress()) << " bits\n";
261 outs() << "Load Name : " << obj->getLoadName() << "\n";
265 int main(int argc, char** argv) {
267 sys::PrintStackTraceOnErrorSignal();
268 PrettyStackTraceProgram X(argc, argv);
270 cl::ParseCommandLineOptions(argc, argv,
271 "LLVM Object Reader\n");
273 if (InputFilename.empty()) {
274 errs() << "Please specify an input filename\n";
278 // Open the object file
279 OwningPtr<MemoryBuffer> File;
280 if (MemoryBuffer::getFile(InputFilename, File)) {
281 errs() << InputFilename << ": Open failed\n";
285 ObjectFile *obj = ObjectFile::createObjectFile(File.take());
287 errs() << InputFilename << ": Object type not recognized\n";
292 dumpDynamicSymbols(obj);
294 outs() << "Sections:\n";
296 dump(obj, &dumpSection, obj->begin_sections(), obj->end_sections(),
297 "Section iteration failed");
299 dumpLibrariesNeeded(obj);