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