llvm-readobj.cpp revision 5d446e61d992f105a05aade62d5305fd8a346081
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 45using namespace llvm; 46using namespace llvm::object; 47 48namespace 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 132 // -arm-buildattrs 133 cl::opt<bool> ArmBuildAttrs("arm-buildattrs", 134 cl::desc("Display ARM ELF build attributes")); 135} // namespace opts 136 137namespace llvm { 138 139bool error(error_code EC) { 140 if (!EC) 141 return false; 142 143 outs() << "\nError reading file: " << EC.message() << ".\n"; 144 outs().flush(); 145 return true; 146} 147 148bool relocAddressLess(RelocationRef a, RelocationRef b) { 149 uint64_t a_addr, b_addr; 150 if (error(a.getOffset(a_addr))) return false; 151 if (error(b.getOffset(b_addr))) return false; 152 return a_addr < b_addr; 153} 154 155} // namespace llvm 156 157 158static void reportError(StringRef Input, error_code EC) { 159 if (Input == "-") 160 Input = "<stdin>"; 161 162 errs() << Input << ": " << EC.message() << "\n"; 163 errs().flush(); 164} 165 166static void reportError(StringRef Input, StringRef Message) { 167 if (Input == "-") 168 Input = "<stdin>"; 169 170 errs() << Input << ": " << Message << "\n"; 171} 172 173/// @brief Creates an format-specific object file dumper. 174static error_code createDumper(const ObjectFile *Obj, 175 StreamWriter &Writer, 176 OwningPtr<ObjDumper> &Result) { 177 if (!Obj) 178 return readobj_error::unsupported_file_format; 179 180 if (Obj->isCOFF()) 181 return createCOFFDumper(Obj, Writer, Result); 182 if (Obj->isELF()) 183 return createELFDumper(Obj, Writer, Result); 184 if (Obj->isMachO()) 185 return createMachODumper(Obj, Writer, Result); 186 187 return readobj_error::unsupported_obj_file_format; 188} 189 190 191/// @brief Dumps the specified object file. 192static void dumpObject(const ObjectFile *Obj) { 193 StreamWriter Writer(outs()); 194 OwningPtr<ObjDumper> Dumper; 195 if (error_code EC = createDumper(Obj, Writer, Dumper)) { 196 reportError(Obj->getFileName(), EC); 197 return; 198 } 199 200 outs() << '\n'; 201 outs() << "File: " << Obj->getFileName() << "\n"; 202 outs() << "Format: " << Obj->getFileFormatName() << "\n"; 203 outs() << "Arch: " 204 << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch()) 205 << "\n"; 206 outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n"; 207 if (Obj->isELF()) 208 outs() << "LoadName: " << Obj->getLoadName() << "\n"; 209 210 if (opts::FileHeaders) 211 Dumper->printFileHeaders(); 212 if (opts::Sections) 213 Dumper->printSections(); 214 if (opts::Relocations) 215 Dumper->printRelocations(); 216 if (opts::Symbols) 217 Dumper->printSymbols(); 218 if (opts::DynamicSymbols) 219 Dumper->printDynamicSymbols(); 220 if (opts::UnwindInfo) 221 Dumper->printUnwindInfo(); 222 if (opts::DynamicTable) 223 Dumper->printDynamicTable(); 224 if (opts::NeededLibraries) 225 Dumper->printNeededLibraries(); 226 if (opts::ProgramHeaders) 227 Dumper->printProgramHeaders(); 228 if (opts::ArmBuildAttrs) 229 Dumper->printARMBuildAttributes(); 230} 231 232 233/// @brief Dumps each object file in \a Arc; 234static void dumpArchive(const Archive *Arc) { 235 for (Archive::child_iterator ArcI = Arc->begin_children(), 236 ArcE = Arc->end_children(); 237 ArcI != ArcE; ++ArcI) { 238 OwningPtr<Binary> child; 239 if (error_code EC = ArcI->getAsBinary(child)) { 240 // Ignore non-object files. 241 if (EC != object_error::invalid_file_type) 242 reportError(Arc->getFileName(), EC.message()); 243 continue; 244 } 245 246 if (ObjectFile *Obj = dyn_cast<ObjectFile>(child.get())) 247 dumpObject(Obj); 248 else 249 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format); 250 } 251} 252 253 254/// @brief Opens \a File and dumps it. 255static void dumpInput(StringRef File) { 256 // If file isn't stdin, check that it exists. 257 if (File != "-" && !sys::fs::exists(File)) { 258 reportError(File, readobj_error::file_not_found); 259 return; 260 } 261 262 // Attempt to open the binary. 263 OwningPtr<Binary> Binary; 264 if (error_code EC = createBinary(File, Binary)) { 265 reportError(File, EC); 266 return; 267 } 268 269 if (Archive *Arc = dyn_cast<Archive>(Binary.get())) 270 dumpArchive(Arc); 271 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(Binary.get())) 272 dumpObject(Obj); 273 else 274 reportError(File, readobj_error::unrecognized_file_format); 275} 276 277 278int main(int argc, const char *argv[]) { 279 sys::PrintStackTraceOnErrorSignal(); 280 PrettyStackTraceProgram X(argc, argv); 281 llvm_shutdown_obj Y; 282 283 // Initialize targets. 284 llvm::InitializeAllTargetInfos(); 285 286 // Register the target printer for --version. 287 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion); 288 289 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n"); 290 291 // Default to stdin if no filename is specified. 292 if (opts::InputFilenames.size() == 0) 293 opts::InputFilenames.push_back("-"); 294 295 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(), 296 dumpInput); 297 298 return 0; 299} 300