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/COFFImportFile.h" 28 #include "llvm/Object/ELFObjectFile.h" 29 #include "llvm/Object/MachOUniversal.h" 30 #include "llvm/Object/ObjectFile.h" 31 #include "llvm/Support/Casting.h" 32 #include "llvm/Support/CommandLine.h" 33 #include "llvm/Support/DataTypes.h" 34 #include "llvm/Support/Debug.h" 35 #include "llvm/Support/FileSystem.h" 36 #include "llvm/Support/ManagedStatic.h" 37 #include "llvm/Support/PrettyStackTrace.h" 38 #include "llvm/Support/Signals.h" 39 #include "llvm/Support/TargetRegistry.h" 40 #include "llvm/Support/TargetSelect.h" 41 #include <string> 42 #include <system_error> 43 44 using namespace llvm; 45 using namespace llvm::object; 46 47 namespace opts { 48 cl::list<std::string> InputFilenames(cl::Positional, 49 cl::desc("<input object files>"), 50 cl::ZeroOrMore); 51 52 // -file-headers, -h 53 cl::opt<bool> FileHeaders("file-headers", 54 cl::desc("Display file headers ")); 55 cl::alias FileHeadersShort("h", 56 cl::desc("Alias for --file-headers"), 57 cl::aliasopt(FileHeaders)); 58 59 // -sections, -s 60 cl::opt<bool> Sections("sections", 61 cl::desc("Display all sections.")); 62 cl::alias SectionsShort("s", 63 cl::desc("Alias for --sections"), 64 cl::aliasopt(Sections)); 65 66 // -section-relocations, -sr 67 cl::opt<bool> SectionRelocations("section-relocations", 68 cl::desc("Display relocations for each section shown.")); 69 cl::alias SectionRelocationsShort("sr", 70 cl::desc("Alias for --section-relocations"), 71 cl::aliasopt(SectionRelocations)); 72 73 // -section-symbols, -st 74 cl::opt<bool> SectionSymbols("section-symbols", 75 cl::desc("Display symbols for each section shown.")); 76 cl::alias SectionSymbolsShort("st", 77 cl::desc("Alias for --section-symbols"), 78 cl::aliasopt(SectionSymbols)); 79 80 // -section-data, -sd 81 cl::opt<bool> SectionData("section-data", 82 cl::desc("Display section data for each section shown.")); 83 cl::alias SectionDataShort("sd", 84 cl::desc("Alias for --section-data"), 85 cl::aliasopt(SectionData)); 86 87 // -relocations, -r 88 cl::opt<bool> Relocations("relocations", 89 cl::desc("Display the relocation entries in the file")); 90 cl::alias RelocationsShort("r", 91 cl::desc("Alias for --relocations"), 92 cl::aliasopt(Relocations)); 93 94 // -dyn-relocations 95 cl::opt<bool> DynRelocs("dyn-relocations", 96 cl::desc("Display the dynamic relocation entries in the file")); 97 98 // -symbols, -t 99 cl::opt<bool> Symbols("symbols", 100 cl::desc("Display the symbol table")); 101 cl::alias SymbolsShort("t", 102 cl::desc("Alias for --symbols"), 103 cl::aliasopt(Symbols)); 104 105 // -dyn-symbols, -dt 106 cl::opt<bool> DynamicSymbols("dyn-symbols", 107 cl::desc("Display the dynamic symbol table")); 108 cl::alias DynamicSymbolsShort("dt", 109 cl::desc("Alias for --dyn-symbols"), 110 cl::aliasopt(DynamicSymbols)); 111 112 // -unwind, -u 113 cl::opt<bool> UnwindInfo("unwind", 114 cl::desc("Display unwind information")); 115 cl::alias UnwindInfoShort("u", 116 cl::desc("Alias for --unwind"), 117 cl::aliasopt(UnwindInfo)); 118 119 // -dynamic-table 120 cl::opt<bool> DynamicTable("dynamic-table", 121 cl::desc("Display the ELF .dynamic section table")); 122 123 // -needed-libs 124 cl::opt<bool> NeededLibraries("needed-libs", 125 cl::desc("Display the needed libraries")); 126 127 // -program-headers 128 cl::opt<bool> ProgramHeaders("program-headers", 129 cl::desc("Display ELF program headers")); 130 131 // -hash-table 132 cl::opt<bool> HashTable("hash-table", 133 cl::desc("Display ELF hash table")); 134 135 // -expand-relocs 136 cl::opt<bool> ExpandRelocs("expand-relocs", 137 cl::desc("Expand each shown relocation to multiple lines")); 138 139 // -codeview 140 cl::opt<bool> CodeView("codeview", 141 cl::desc("Display CodeView debug information")); 142 143 // -codeview-subsection-bytes 144 cl::opt<bool> CodeViewSubsectionBytes( 145 "codeview-subsection-bytes", 146 cl::desc("Dump raw contents of codeview debug sections and records")); 147 148 // -arm-attributes, -a 149 cl::opt<bool> ARMAttributes("arm-attributes", 150 cl::desc("Display the ARM attributes section")); 151 cl::alias ARMAttributesShort("-a", cl::desc("Alias for --arm-attributes"), 152 cl::aliasopt(ARMAttributes)); 153 154 // -mips-plt-got 155 cl::opt<bool> 156 MipsPLTGOT("mips-plt-got", 157 cl::desc("Display the MIPS GOT and PLT GOT sections")); 158 159 // -mips-abi-flags 160 cl::opt<bool> MipsABIFlags("mips-abi-flags", 161 cl::desc("Display the MIPS.abiflags section")); 162 163 // -mips-reginfo 164 cl::opt<bool> MipsReginfo("mips-reginfo", 165 cl::desc("Display the MIPS .reginfo section")); 166 167 // -coff-imports 168 cl::opt<bool> 169 COFFImports("coff-imports", cl::desc("Display the PE/COFF import table")); 170 171 // -coff-exports 172 cl::opt<bool> 173 COFFExports("coff-exports", cl::desc("Display the PE/COFF export table")); 174 175 // -coff-directives 176 cl::opt<bool> 177 COFFDirectives("coff-directives", 178 cl::desc("Display the PE/COFF .drectve section")); 179 180 // -coff-basereloc 181 cl::opt<bool> 182 COFFBaseRelocs("coff-basereloc", 183 cl::desc("Display the PE/COFF .reloc section")); 184 185 // -macho-data-in-code 186 cl::opt<bool> 187 MachODataInCode("macho-data-in-code", 188 cl::desc("Display MachO Data in Code command")); 189 190 // -macho-version-min 191 cl::opt<bool> 192 MachOVersionMin("macho-version-min", 193 cl::desc("Display MachO version min command")); 194 // -stackmap 195 cl::opt<bool> 196 PrintStackMap("stackmap", 197 cl::desc("Display contents of stackmap section")); 198 199 } // namespace opts 200 201 namespace llvm { 202 203 void reportError(Twine Msg) { 204 outs() << "\nError reading file: " << Msg << ".\n"; 205 outs().flush(); 206 exit(1); 207 } 208 209 void error(std::error_code EC) { 210 if (!EC) 211 return; 212 213 reportError(EC.message()); 214 } 215 216 bool relocAddressLess(RelocationRef a, RelocationRef b) { 217 return a.getOffset() < b.getOffset(); 218 } 219 220 } // namespace llvm 221 222 static void reportError(StringRef Input, std::error_code EC) { 223 if (Input == "-") 224 Input = "<stdin>"; 225 226 reportError(Twine(Input) + ": " + EC.message()); 227 } 228 229 static void reportError(StringRef Input, StringRef Message) { 230 if (Input == "-") 231 Input = "<stdin>"; 232 233 reportError(Twine(Input) + ": " + Message); 234 } 235 236 static bool isMipsArch(unsigned Arch) { 237 switch (Arch) { 238 case llvm::Triple::mips: 239 case llvm::Triple::mipsel: 240 case llvm::Triple::mips64: 241 case llvm::Triple::mips64el: 242 return true; 243 default: 244 return false; 245 } 246 } 247 248 /// @brief Creates an format-specific object file dumper. 249 static std::error_code createDumper(const ObjectFile *Obj, StreamWriter &Writer, 250 std::unique_ptr<ObjDumper> &Result) { 251 if (!Obj) 252 return readobj_error::unsupported_file_format; 253 254 if (Obj->isCOFF()) 255 return createCOFFDumper(Obj, Writer, Result); 256 if (Obj->isELF()) 257 return createELFDumper(Obj, Writer, Result); 258 if (Obj->isMachO()) 259 return createMachODumper(Obj, Writer, Result); 260 261 return readobj_error::unsupported_obj_file_format; 262 } 263 264 /// @brief Dumps the specified object file. 265 static void dumpObject(const ObjectFile *Obj) { 266 StreamWriter Writer(outs()); 267 std::unique_ptr<ObjDumper> Dumper; 268 if (std::error_code EC = createDumper(Obj, Writer, Dumper)) { 269 reportError(Obj->getFileName(), EC); 270 return; 271 } 272 273 outs() << '\n'; 274 outs() << "File: " << Obj->getFileName() << "\n"; 275 outs() << "Format: " << Obj->getFileFormatName() << "\n"; 276 outs() << "Arch: " 277 << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch()) 278 << "\n"; 279 outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n"; 280 Dumper->printLoadName(); 281 282 if (opts::FileHeaders) 283 Dumper->printFileHeaders(); 284 if (opts::Sections) 285 Dumper->printSections(); 286 if (opts::Relocations) 287 Dumper->printRelocations(); 288 if (opts::DynRelocs) 289 Dumper->printDynamicRelocations(); 290 if (opts::Symbols) 291 Dumper->printSymbols(); 292 if (opts::DynamicSymbols) 293 Dumper->printDynamicSymbols(); 294 if (opts::UnwindInfo) 295 Dumper->printUnwindInfo(); 296 if (opts::DynamicTable) 297 Dumper->printDynamicTable(); 298 if (opts::NeededLibraries) 299 Dumper->printNeededLibraries(); 300 if (opts::ProgramHeaders) 301 Dumper->printProgramHeaders(); 302 if (opts::HashTable) 303 Dumper->printHashTable(); 304 if (Obj->getArch() == llvm::Triple::arm && Obj->isELF()) 305 if (opts::ARMAttributes) 306 Dumper->printAttributes(); 307 if (isMipsArch(Obj->getArch()) && Obj->isELF()) { 308 if (opts::MipsPLTGOT) 309 Dumper->printMipsPLTGOT(); 310 if (opts::MipsABIFlags) 311 Dumper->printMipsABIFlags(); 312 if (opts::MipsReginfo) 313 Dumper->printMipsReginfo(); 314 } 315 if (Obj->isCOFF()) { 316 if (opts::COFFImports) 317 Dumper->printCOFFImports(); 318 if (opts::COFFExports) 319 Dumper->printCOFFExports(); 320 if (opts::COFFDirectives) 321 Dumper->printCOFFDirectives(); 322 if (opts::COFFBaseRelocs) 323 Dumper->printCOFFBaseReloc(); 324 } 325 if (Obj->isMachO()) { 326 if (opts::MachODataInCode) 327 Dumper->printMachODataInCode(); 328 if (opts::MachOVersionMin) 329 Dumper->printMachOVersionMin(); 330 } 331 if (opts::PrintStackMap) 332 Dumper->printStackMap(); 333 } 334 335 /// @brief Dumps each object file in \a Arc; 336 static void dumpArchive(const Archive *Arc) { 337 for (const auto &Child : Arc->children()) { 338 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary(); 339 if (std::error_code EC = ChildOrErr.getError()) { 340 // Ignore non-object files. 341 if (EC != object_error::invalid_file_type) 342 reportError(Arc->getFileName(), EC.message()); 343 continue; 344 } 345 346 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get())) 347 dumpObject(Obj); 348 else 349 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format); 350 } 351 } 352 353 /// @brief Dumps each object file in \a MachO Universal Binary; 354 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) { 355 for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) { 356 ErrorOr<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile(); 357 if (ObjOrErr) 358 dumpObject(&*ObjOrErr.get()); 359 else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive()) 360 dumpArchive(&*AOrErr.get()); 361 else 362 reportError(UBinary->getFileName(), ObjOrErr.getError().message()); 363 } 364 } 365 366 /// @brief Opens \a File and dumps it. 367 static void dumpInput(StringRef File) { 368 // If file isn't stdin, check that it exists. 369 if (File != "-" && !sys::fs::exists(File)) { 370 reportError(File, readobj_error::file_not_found); 371 return; 372 } 373 374 // Attempt to open the binary. 375 ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File); 376 if (std::error_code EC = BinaryOrErr.getError()) { 377 reportError(File, EC); 378 return; 379 } 380 Binary &Binary = *BinaryOrErr.get().getBinary(); 381 382 if (Archive *Arc = dyn_cast<Archive>(&Binary)) 383 dumpArchive(Arc); 384 else if (MachOUniversalBinary *UBinary = 385 dyn_cast<MachOUniversalBinary>(&Binary)) 386 dumpMachOUniversalBinary(UBinary); 387 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary)) 388 dumpObject(Obj); 389 else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary)) 390 dumpCOFFImportFile(Import); 391 else 392 reportError(File, readobj_error::unrecognized_file_format); 393 } 394 395 int main(int argc, const char *argv[]) { 396 sys::PrintStackTraceOnErrorSignal(); 397 PrettyStackTraceProgram X(argc, argv); 398 llvm_shutdown_obj Y; 399 400 // Register the target printer for --version. 401 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion); 402 403 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n"); 404 405 // Default to stdin if no filename is specified. 406 if (opts::InputFilenames.size() == 0) 407 opts::InputFilenames.push_back("-"); 408 409 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(), 410 dumpInput); 411 412 return 0; 413 } 414