MachODumper.cpp revision 1efa60453be658242f468f4be4f8d4855ace60d1
1//===-- MachODump.cpp - Object file dumping utility for llvm --------------===// 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 file implements the MachO-specific dumper for llvm-readobj. 11// 12//===----------------------------------------------------------------------===// 13 14#include "llvm-readobj.h" 15#include "Error.h" 16#include "ObjDumper.h" 17#include "StreamWriter.h" 18 19#include "llvm/ADT/SmallString.h" 20#include "llvm/Object/MachO.h" 21#include "llvm/Support/Casting.h" 22 23using namespace llvm; 24using namespace object; 25 26namespace { 27 28class MachODumper : public ObjDumper { 29public: 30 MachODumper(const llvm::object::MachOObjectFile *Obj, StreamWriter& Writer) 31 : ObjDumper(Writer) 32 , Obj(Obj) { } 33 34 virtual void printFileHeaders() LLVM_OVERRIDE; 35 virtual void printSections() LLVM_OVERRIDE; 36 virtual void printRelocations() LLVM_OVERRIDE; 37 virtual void printSymbols() LLVM_OVERRIDE; 38 virtual void printDynamicSymbols() LLVM_OVERRIDE; 39 virtual void printUnwindInfo() LLVM_OVERRIDE; 40 41private: 42 void printSymbol(symbol_iterator SymI); 43 44 void printRelocation(section_iterator SecI, relocation_iterator RelI); 45 46 const llvm::object::MachOObjectFile *Obj; 47}; 48 49} // namespace 50 51 52namespace llvm { 53 54error_code createMachODumper(const object::ObjectFile *Obj, 55 StreamWriter& Writer, 56 OwningPtr<ObjDumper> &Result) { 57 const MachOObjectFile *MachOObj = dyn_cast<MachOObjectFile>(Obj); 58 if (!MachOObj) 59 return readobj_error::unsupported_obj_file_format; 60 61 Result.reset(new MachODumper(MachOObj, Writer)); 62 return readobj_error::success; 63} 64 65} // namespace llvm 66 67 68static const EnumEntry<unsigned> MachOSectionTypes[] = { 69 { "Regular" , 0x00 }, 70 { "ZeroFill" , 0x01 }, 71 { "CStringLiterals" , 0x02 }, 72 { "4ByteLiterals" , 0x03 }, 73 { "8ByteLiterals" , 0x04 }, 74 { "LiteralPointers" , 0x05 }, 75 { "NonLazySymbolPointers" , 0x06 }, 76 { "LazySymbolPointers" , 0x07 }, 77 { "SymbolStubs" , 0x08 }, 78 { "ModInitFuncs" , 0x09 }, 79 { "ModTermFuncs" , 0x0A }, 80 { "Coalesced" , 0x0B }, 81 { "GBZeroFill" , 0x0C }, 82 { "Interposing" , 0x0D }, 83 { "16ByteLiterals" , 0x0E }, 84 { "DTraceDOF" , 0x0F }, 85 { "LazyDylibSymbolPoints" , 0x10 }, 86 { "ThreadLocalRegular" , 0x11 }, 87 { "ThreadLocalZerofill" , 0x12 }, 88 { "ThreadLocalVariables" , 0x13 }, 89 { "ThreadLocalVariablePointers" , 0x14 }, 90 { "ThreadLocalInitFunctionPointers", 0x15 } 91}; 92 93static const EnumEntry<unsigned> MachOSectionAttributes[] = { 94 { "LocReloc" , 1 << 0 /*S_ATTR_LOC_RELOC */ }, 95 { "ExtReloc" , 1 << 1 /*S_ATTR_EXT_RELOC */ }, 96 { "SomeInstructions" , 1 << 2 /*S_ATTR_SOME_INSTRUCTIONS */ }, 97 { "Debug" , 1 << 17 /*S_ATTR_DEBUG */ }, 98 { "SelfModifyingCode", 1 << 18 /*S_ATTR_SELF_MODIFYING_CODE*/ }, 99 { "LiveSupport" , 1 << 19 /*S_ATTR_LIVE_SUPPORT */ }, 100 { "NoDeadStrip" , 1 << 20 /*S_ATTR_NO_DEAD_STRIP */ }, 101 { "StripStaticSyms" , 1 << 21 /*S_ATTR_STRIP_STATIC_SYMS */ }, 102 { "NoTOC" , 1 << 22 /*S_ATTR_NO_TOC */ }, 103 { "PureInstructions" , 1 << 23 /*S_ATTR_PURE_INSTRUCTIONS */ }, 104}; 105 106static const EnumEntry<unsigned> MachOSymbolRefTypes[] = { 107 { "UndefinedNonLazy", 0 }, 108 { "ReferenceFlagUndefinedLazy", 1 }, 109 { "ReferenceFlagDefined", 2 }, 110 { "ReferenceFlagPrivateDefined", 3 }, 111 { "ReferenceFlagPrivateUndefinedNonLazy", 4 }, 112 { "ReferenceFlagPrivateUndefinedLazy", 5 } 113}; 114 115static const EnumEntry<unsigned> MachOSymbolFlags[] = { 116 { "ReferencedDynamically", 0x10 }, 117 { "NoDeadStrip", 0x20 }, 118 { "WeakRef", 0x40 }, 119 { "WeakDef", 0x80 } 120}; 121 122static const EnumEntry<unsigned> MachOSymbolTypes[] = { 123 { "Undef", 0x0 }, 124 { "External", 0x1 }, 125 { "Abs", 0x2 }, 126 { "Indirect", 0xA }, 127 { "PreboundUndef", 0xC }, 128 { "Section", 0xE }, 129 { "PrivateExternal", 0x10 } 130}; 131 132namespace { 133 enum { 134 N_STAB = 0xE0 135 }; 136 137 struct MachOSection { 138 ArrayRef<char> Name; 139 ArrayRef<char> SegmentName; 140 uint64_t Address; 141 uint64_t Size; 142 uint32_t Offset; 143 uint32_t Alignment; 144 uint32_t RelocationTableOffset; 145 uint32_t NumRelocationTableEntries; 146 uint32_t Flags; 147 uint32_t Reserved1; 148 uint32_t Reserved2; 149 }; 150 151 struct MachOSymbol { 152 uint32_t StringIndex; 153 uint8_t Type; 154 uint8_t SectionIndex; 155 uint16_t Flags; 156 uint64_t Value; 157 }; 158} 159 160static bool is64BitLoadCommand(const MachOObject *MachOObj, DataRefImpl DRI) { 161 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a); 162 if (LCI.Command.Type == macho::LCT_Segment64) 163 return true; 164 assert(LCI.Command.Type == macho::LCT_Segment && "Unexpected Type."); 165 return false; 166} 167 168static void getSection(const MachOObjectFile *Obj, 169 DataRefImpl DRI, 170 MachOSection &Section) { 171 const MachOObject *MachOObj = Obj->getObject(); 172 173 if (is64BitLoadCommand(MachOObj, DRI)) { 174 const MachOFormat::Section64 *Sect = Obj->getSection64(DRI); 175 176 Section.Address = Sect->Address; 177 Section.Size = Sect->Size; 178 Section.Offset = Sect->Offset; 179 Section.Alignment = Sect->Align; 180 Section.RelocationTableOffset = Sect->RelocationTableOffset; 181 Section.NumRelocationTableEntries = Sect->NumRelocationTableEntries; 182 Section.Flags = Sect->Flags; 183 Section.Reserved1 = Sect->Reserved1; 184 Section.Reserved2 = Sect->Reserved2; 185 } else { 186 const MachOFormat::Section *Sect = Obj->getSection(DRI); 187 188 Section.Address = Sect->Address; 189 Section.Size = Sect->Size; 190 Section.Offset = Sect->Offset; 191 Section.Alignment = Sect->Align; 192 Section.RelocationTableOffset = Sect->RelocationTableOffset; 193 Section.NumRelocationTableEntries = Sect->NumRelocationTableEntries; 194 Section.Flags = Sect->Flags; 195 Section.Reserved1 = Sect->Reserved1; 196 Section.Reserved2 = Sect->Reserved2; 197 } 198} 199 200static void getSymbol(const MachOObjectFile *Obj, 201 DataRefImpl DRI, 202 MachOSymbol &Symbol) { 203 const MachOObject *MachOObj = Obj->getObject(); 204 if (MachOObj->is64Bit()) { 205 const MachOFormat::Symbol64TableEntry *Entry = 206 Obj->getSymbol64TableEntry( DRI); 207 Symbol.StringIndex = Entry->StringIndex; 208 Symbol.Type = Entry->Type; 209 Symbol.SectionIndex = Entry->SectionIndex; 210 Symbol.Flags = Entry->Flags; 211 Symbol.Value = Entry->Value; 212 } else { 213 const MachOFormat::SymbolTableEntry *Entry = Obj->getSymbolTableEntry(DRI); 214 Symbol.StringIndex = Entry->StringIndex; 215 Symbol.Type = Entry->Type; 216 Symbol.SectionIndex = Entry->SectionIndex; 217 Symbol.Flags = Entry->Flags; 218 Symbol.Value = Entry->Value; 219 } 220} 221 222void MachODumper::printFileHeaders() { 223 W.startLine() << "FileHeaders not implemented.\n"; 224} 225 226void MachODumper::printSections() { 227 ListScope Group(W, "Sections"); 228 229 int SectionIndex = -1; 230 error_code EC; 231 for (section_iterator SecI = Obj->begin_sections(), 232 SecE = Obj->end_sections(); 233 SecI != SecE; SecI.increment(EC)) { 234 if (error(EC)) break; 235 236 ++SectionIndex; 237 238 MachOSection Section; 239 getSection(Obj, SecI->getRawDataRefImpl(), Section); 240 DataRefImpl DR = SecI->getRawDataRefImpl(); 241 242 StringRef Name; 243 if (error(SecI->getName(Name))) 244 Name = ""; 245 246 ArrayRef<char> RawName = Obj->getSectionRawName(DR); 247 StringRef SegmentName = Obj->getSectionFinalSegmentName(DR); 248 ArrayRef<char> RawSegmentName = Obj->getSectionRawFinalSegmentName(DR); 249 250 DictScope SectionD(W, "Section"); 251 W.printNumber("Index", SectionIndex); 252 W.printBinary("Name", Name, RawName); 253 W.printBinary("Segment", SegmentName, RawSegmentName); 254 W.printHex ("Address", Section.Address); 255 W.printHex ("Size", Section.Size); 256 W.printNumber("Offset", Section.Offset); 257 W.printNumber("Alignment", Section.Alignment); 258 W.printHex ("RelocationOffset", Section.RelocationTableOffset); 259 W.printNumber("RelocationCount", Section.NumRelocationTableEntries); 260 W.printEnum ("Type", Section.Flags & 0xFF, 261 makeArrayRef(MachOSectionAttributes)); 262 W.printFlags ("Attributes", Section.Flags >> 8, 263 makeArrayRef(MachOSectionAttributes)); 264 W.printHex ("Reserved1", Section.Reserved1); 265 W.printHex ("Reserved2", Section.Reserved2); 266 267 if (opts::SectionRelocations) { 268 ListScope D(W, "Relocations"); 269 for (relocation_iterator RelI = SecI->begin_relocations(), 270 RelE = SecI->end_relocations(); 271 RelI != RelE; RelI.increment(EC)) { 272 if (error(EC)) break; 273 274 printRelocation(SecI, RelI); 275 } 276 } 277 278 if (opts::SectionSymbols) { 279 ListScope D(W, "Symbols"); 280 for (symbol_iterator SymI = Obj->begin_symbols(), 281 SymE = Obj->end_symbols(); 282 SymI != SymE; SymI.increment(EC)) { 283 if (error(EC)) break; 284 285 bool Contained = false; 286 if (SecI->containsSymbol(*SymI, Contained) || !Contained) 287 continue; 288 289 printSymbol(SymI); 290 } 291 } 292 293 if (opts::SectionData) { 294 StringRef Data; 295 if (error(SecI->getContents(Data))) break; 296 297 W.printBinaryBlock("SectionData", Data); 298 } 299 } 300} 301 302void MachODumper::printRelocations() { 303 ListScope D(W, "Relocations"); 304 305 error_code EC; 306 for (section_iterator SecI = Obj->begin_sections(), 307 SecE = Obj->end_sections(); 308 SecI != SecE; SecI.increment(EC)) { 309 if (error(EC)) break; 310 311 StringRef Name; 312 if (error(SecI->getName(Name))) 313 continue; 314 315 bool PrintedGroup = false; 316 for (relocation_iterator RelI = SecI->begin_relocations(), 317 RelE = SecI->end_relocations(); 318 RelI != RelE; RelI.increment(EC)) { 319 if (error(EC)) break; 320 321 if (!PrintedGroup) { 322 W.startLine() << "Section " << Name << " {\n"; 323 W.indent(); 324 PrintedGroup = true; 325 } 326 327 printRelocation(SecI, RelI); 328 } 329 330 if (PrintedGroup) { 331 W.unindent(); 332 W.startLine() << "}\n"; 333 } 334 } 335} 336 337void MachODumper::printRelocation(section_iterator SecI, 338 relocation_iterator RelI) { 339 uint64_t Offset; 340 SmallString<32> RelocName; 341 int64_t Info; 342 StringRef SymbolName; 343 SymbolRef Symbol; 344 if (error(RelI->getOffset(Offset))) return; 345 if (error(RelI->getTypeName(RelocName))) return; 346 if (error(RelI->getAdditionalInfo(Info))) return; 347 if (error(RelI->getSymbol(Symbol))) return; 348 if (error(Symbol.getName(SymbolName))) return; 349 350 raw_ostream& OS = W.startLine(); 351 OS << W.hex(Offset) 352 << " " << RelocName 353 << " " << (SymbolName.size() > 0 ? SymbolName : "-") 354 << " " << W.hex(Info) 355 << "\n"; 356} 357 358void MachODumper::printSymbols() { 359 ListScope Group(W, "Symbols"); 360 361 error_code EC; 362 for (symbol_iterator SymI = Obj->begin_symbols(), 363 SymE = Obj->end_symbols(); 364 SymI != SymE; SymI.increment(EC)) { 365 if (error(EC)) break; 366 367 printSymbol(SymI); 368 } 369} 370 371void MachODumper::printDynamicSymbols() { 372 ListScope Group(W, "DynamicSymbols"); 373} 374 375void MachODumper::printSymbol(symbol_iterator SymI) { 376 error_code EC; 377 378 StringRef SymbolName; 379 if (SymI->getName(SymbolName)) 380 SymbolName = ""; 381 382 MachOSymbol Symbol; 383 getSymbol(Obj, SymI->getRawDataRefImpl(), Symbol); 384 385 StringRef SectionName; 386 section_iterator SecI(Obj->end_sections()); 387 if (error(SymI->getSection(SecI)) || 388 error(SecI->getName(SectionName))) 389 SectionName = ""; 390 391 DictScope D(W, "Symbol"); 392 W.printNumber("Name", SymbolName, Symbol.StringIndex); 393 if (Symbol.Type & N_STAB) { 394 W.printHex ("Type", "SymDebugTable", Symbol.Type); 395 } else { 396 W.printEnum("Type", Symbol.Type, makeArrayRef(MachOSymbolTypes)); 397 } 398 W.printHex ("Section", SectionName, Symbol.SectionIndex); 399 W.printEnum ("RefType", static_cast<uint16_t>(Symbol.Flags & 0xF), 400 makeArrayRef(MachOSymbolRefTypes)); 401 W.printFlags ("Flags", static_cast<uint16_t>(Symbol.Flags & ~0xF), 402 makeArrayRef(MachOSymbolFlags)); 403 W.printHex ("Value", Symbol.Value); 404} 405 406void MachODumper::printUnwindInfo() { 407 W.startLine() << "UnwindInfo not implemented.\n"; 408} 409