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