include/llvm/Object/MachO.h

   1 //===- MachO.h - MachO object file implementation ---------------*- C++ -*-===//
   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 declares the MachOObjectFile class, which implement the ObjectFile
  11 // interface for MachO files.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_OBJECT_MACHO_H
  16 #define LLVM_OBJECT_MACHO_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/ADT/Triple.h"
  21 #include "llvm/Object/ObjectFile.h"
  22 #include "llvm/Support/MachO.h"
  23
  24 namespace llvm {
  25 namespace object {
  26
  27 /// DiceRef - This is a value type class that represents a single
  28 /// data in code entry in the table in a Mach-O object file.
  29 class DiceRef {
  30   DataRefImpl DicePimpl;
  31   const ObjectFile *OwningObject;
  32
  33 public:
  34   DiceRef() : OwningObject(nullptr) { }
  35
  36   DiceRef(DataRefImpl DiceP, const ObjectFile *Owner);
  37
  38   bool operator==(const DiceRef &Other) const;
  39   bool operator<(const DiceRef &Other) const;
  40
  41   void moveNext();
  42
  43   std::error_code getOffset(uint32_t &Result) const;
  44   std::error_code getLength(uint16_t &Result) const;
  45   std::error_code getKind(uint16_t &Result) const;
  46
  47   DataRefImpl getRawDataRefImpl() const;
  48   const ObjectFile *getObjectFile() const;
  49 };
  50 typedef content_iterator<DiceRef> dice_iterator;
  51
  52 /// ExportEntry encapsulates the current-state-of-the-walk used when doing a
  53 /// non-recursive walk of the trie data structure.  This allows you to iterate
  54 /// across all exported symbols using:
  55 ///      for (const llvm::object::ExportEntry &AnExport : Obj->exports()) {
  56 ///      }
  57 class ExportEntry {
  58 public:
  59   ExportEntry(ArrayRef<uint8_t> Trie);
  60
  61   StringRef name() const;
  62   uint64_t flags() const;
  63   uint64_t address() const;
  64   uint64_t other() const;
  65   StringRef otherName() const;
  66   uint32_t nodeOffset() const;
  67
  68   bool operator==(const ExportEntry &) const;
  69
  70   void moveNext();
  71
  72 private:
  73   friend class MachOObjectFile;
  74   void moveToFirst();
  75   void moveToEnd();
  76   uint64_t readULEB128(const uint8_t *&p);
  77   void pushDownUntilBottom();
  78   void pushNode(uint64_t Offset);
  79
  80   // Represents a node in the mach-o exports trie.
  81   struct NodeState {
  82     NodeState(const uint8_t *Ptr);
  83     const uint8_t *Start;
  84     const uint8_t *Current;
  85     uint64_t Flags;
  86     uint64_t Address;
  87     uint64_t Other;
  88     const char *ImportName;
  89     unsigned ChildCount;
  90     unsigned NextChildIndex;
  91     unsigned ParentStringLength;
  92     bool IsExportNode;
  93   };
  94
  95   ArrayRef<uint8_t> Trie;
  96   SmallString<256> CumulativeString;
  97   SmallVector<NodeState, 16> Stack;
  98   bool Malformed;
  99   bool Done;
 100 };
 101 typedef content_iterator<ExportEntry> export_iterator;
 102
 103 /// MachORebaseEntry encapsulates the current state in the decompression of
 104 /// rebasing opcodes. This allows you to iterate through the compressed table of
 105 /// rebasing using:
 106 ///    for (const llvm::object::MachORebaseEntry &Entry : Obj->rebaseTable()) {
 107 ///    }
 108 class MachORebaseEntry {
 109 public:
 110   MachORebaseEntry(ArrayRef<uint8_t> opcodes, bool is64Bit);
 111
 112   uint32_t segmentIndex() const;
 113   uint64_t segmentOffset() const;
 114   StringRef typeName() const;
 115
 116   bool operator==(const MachORebaseEntry &) const;
 117
 118   void moveNext();
 119
 120 private:
 121   friend class MachOObjectFile;
 122   void moveToFirst();
 123   void moveToEnd();
 124   uint64_t readULEB128();
 125
 126   ArrayRef<uint8_t> Opcodes;
 127   const uint8_t *Ptr;
 128   uint64_t SegmentOffset;
 129   uint32_t SegmentIndex;
 130   uint64_t RemainingLoopCount;
 131   uint64_t AdvanceAmount;
 132   uint8_t  RebaseType;
 133   uint8_t  PointerSize;
 134   bool     Malformed;
 135   bool     Done;
 136 };
 137 typedef content_iterator<MachORebaseEntry> rebase_iterator;
 138
 139 /// MachOBindEntry encapsulates the current state in the decompression of
 140 /// binding opcodes. This allows you to iterate through the compressed table of
 141 /// bindings using:
 142 ///    for (const llvm::object::MachOBindEntry &Entry : Obj->bindTable()) {
 143 ///    }
 144 class MachOBindEntry {
 145 public:
 146   enum class Kind { Regular, Lazy, Weak };
 147
 148   MachOBindEntry(ArrayRef<uint8_t> Opcodes, bool is64Bit, MachOBindEntry::Kind);
 149
 150   uint32_t segmentIndex() const;
 151   uint64_t segmentOffset() const;
 152   StringRef typeName() const;
 153   StringRef symbolName() const;
 154   uint32_t flags() const;
 155   int64_t addend() const;
 156   int ordinal() const;
 157
 158   bool operator==(const MachOBindEntry &) const;
 159
 160   void moveNext();
 161
 162 private:
 163   friend class MachOObjectFile;
 164   void moveToFirst();
 165   void moveToEnd();
 166   uint64_t readULEB128();
 167   int64_t readSLEB128();
 168
 169   ArrayRef<uint8_t> Opcodes;
 170   const uint8_t *Ptr;
 171   uint64_t SegmentOffset;
 172   uint32_t SegmentIndex;
 173   StringRef SymbolName;
 174   int      Ordinal;
 175   uint32_t Flags;
 176   int64_t  Addend;
 177   uint64_t RemainingLoopCount;
 178   uint64_t AdvanceAmount;
 179   uint8_t  BindType;
 180   uint8_t  PointerSize;
 181   Kind     TableKind;
 182   bool     Malformed;
 183   bool     Done;
 184 };
 185 typedef content_iterator<MachOBindEntry> bind_iterator;
 186
 187 class MachOObjectFile : public ObjectFile {
 188 public:
 189   struct LoadCommandInfo {
 190     const char *Ptr;      // Where in memory the load command is.
 191     MachO::load_command C; // The command itself.
 192   };
 193   typedef SmallVector<LoadCommandInfo, 4> LoadCommandList;
 194   typedef LoadCommandList::const_iterator load_command_iterator;
 195
 196   MachOObjectFile(MemoryBufferRef Object, bool IsLittleEndian, bool Is64Bits,
 197                   std::error_code &EC);
 198
 199   void moveSymbolNext(DataRefImpl &Symb) const override;
 200
 201   uint64_t getNValue(DataRefImpl Sym) const;
 202   std::error_code getSymbolName(DataRefImpl Symb,
 203                                 StringRef &Res) const override;
 204
 205   // MachO specific.
 206   std::error_code getIndirectName(DataRefImpl Symb, StringRef &Res) const;
 207   unsigned getSectionType(SectionRef Sec) const;
 208
 209   std::error_code getSymbolAddress(DataRefImpl Symb,
 210                                    uint64_t &Res) const override;
 211   uint64_t getSymbolValue(DataRefImpl Symb) const override;
 212   uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
 213   uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
 214   SymbolRef::Type getSymbolType(DataRefImpl Symb) const override;
 215   uint32_t getSymbolFlags(DataRefImpl Symb) const override;
 216   std::error_code getSymbolSection(DataRefImpl Symb,
 217                                    section_iterator &Res) const override;
 218   unsigned getSymbolSectionID(SymbolRef Symb) const;
 219   unsigned getSectionID(SectionRef Sec) const;
 220
 221   void moveSectionNext(DataRefImpl &Sec) const override;
 222   std::error_code getSectionName(DataRefImpl Sec,
 223                                  StringRef &Res) const override;
 224   uint64_t getSectionAddress(DataRefImpl Sec) const override;
 225   uint64_t getSectionSize(DataRefImpl Sec) const override;
 226   std::error_code getSectionContents(DataRefImpl Sec,
 227                                      StringRef &Res) const override;
 228   uint64_t getSectionAlignment(DataRefImpl Sec) const override;
 229   bool isSectionText(DataRefImpl Sec) const override;
 230   bool isSectionData(DataRefImpl Sec) const override;
 231   bool isSectionBSS(DataRefImpl Sec) const override;
 232   bool isSectionVirtual(DataRefImpl Sec) const override;
 233   relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
 234   relocation_iterator section_rel_end(DataRefImpl Sec) const override;
 235
 236   void moveRelocationNext(DataRefImpl &Rel) const override;
 237   ErrorOr<uint64_t> getRelocationAddress(DataRefImpl Rel) const override;
 238   uint64_t getRelocationOffset(DataRefImpl Rel) const override;
 239   symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
 240   section_iterator getRelocationSection(DataRefImpl Rel) const;
 241   uint64_t getRelocationType(DataRefImpl Rel) const override;
 242   void getRelocationTypeName(DataRefImpl Rel,
 243                              SmallVectorImpl<char> &Result) const override;
 244   uint8_t getRelocationLength(DataRefImpl Rel) const;
 245
 246   // MachO specific.
 247   std::error_code getLibraryShortNameByIndex(unsigned Index, StringRef &) const;
 248
 249   // TODO: Would be useful to have an iterator based version
 250   // of the load command interface too.
 251
 252   basic_symbol_iterator symbol_begin_impl() const override;
 253   basic_symbol_iterator symbol_end_impl() const override;
 254
 255   // MachO specific.
 256   basic_symbol_iterator getSymbolByIndex(unsigned Index) const;
 257
 258   section_iterator section_begin() const override;
 259   section_iterator section_end() const override;
 260
 261   uint8_t getBytesInAddress() const override;
 262
 263   StringRef getFileFormatName() const override;
 264   unsigned getArch() const override;
 265   Triple getArch(const char **McpuDefault, Triple *ThumbTriple) const;
 266
 267   relocation_iterator section_rel_begin(unsigned Index) const;
 268   relocation_iterator section_rel_end(unsigned Index) const;
 269
 270   dice_iterator begin_dices() const;
 271   dice_iterator end_dices() const;
 272
 273   load_command_iterator begin_load_commands() const;
 274   load_command_iterator end_load_commands() const;
 275   iterator_range<load_command_iterator> load_commands() const;
 276
 277   /// For use iterating over all exported symbols.
 278   iterator_range<export_iterator> exports() const;
 279
 280   /// For use examining a trie not in a MachOObjectFile.
 281   static iterator_range<export_iterator> exports(ArrayRef<uint8_t> Trie);
 282
 283   /// For use iterating over all rebase table entries.
 284   iterator_range<rebase_iterator> rebaseTable() const;
 285
 286   /// For use examining rebase opcodes not in a MachOObjectFile.
 287   static iterator_range<rebase_iterator> rebaseTable(ArrayRef<uint8_t> Opcodes,
 288                                                      bool is64);
 289
 290   /// For use iterating over all bind table entries.
 291   iterator_range<bind_iterator> bindTable() const;
 292
 293   /// For use iterating over all lazy bind table entries.
 294   iterator_range<bind_iterator> lazyBindTable() const;
 295
 296   /// For use iterating over all lazy bind table entries.
 297   iterator_range<bind_iterator> weakBindTable() const;
 298
 299   /// For use examining bind opcodes not in a MachOObjectFile.
 300   static iterator_range<bind_iterator> bindTable(ArrayRef<uint8_t> Opcodes,
 301                                                  bool is64,
 302                                                  MachOBindEntry::Kind);
 303
 304
 305   // In a MachO file, sections have a segment name. This is used in the .o
 306   // files. They have a single segment, but this field specifies which segment
 307   // a section should be put in in the final object.
 308   StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
 309
 310   // Names are stored as 16 bytes. These returns the raw 16 bytes without
 311   // interpreting them as a C string.
 312   ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
 313   ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
 314
 315   // MachO specific Info about relocations.
 316   bool isRelocationScattered(const MachO::any_relocation_info &RE) const;
 317   unsigned getPlainRelocationSymbolNum(
 318                                     const MachO::any_relocation_info &RE) const;
 319   bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;
 320   bool getScatteredRelocationScattered(
 321                                     const MachO::any_relocation_info &RE) const;
 322   uint32_t getScatteredRelocationValue(
 323                                     const MachO::any_relocation_info &RE) const;
 324   uint32_t getScatteredRelocationType(
 325                                     const MachO::any_relocation_info &RE) const;
 326   unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;
 327   unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;
 328   unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;
 329   unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;
 330   SectionRef getAnyRelocationSection(const MachO::any_relocation_info &RE) const;
 331
 332   // MachO specific structures.
 333   MachO::section getSection(DataRefImpl DRI) const;
 334   MachO::section_64 getSection64(DataRefImpl DRI) const;
 335   MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;
 336   MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;
 337   MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;
 338   MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;
 339
 340   MachO::linkedit_data_command
 341   getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
 342   MachO::segment_command
 343   getSegmentLoadCommand(const LoadCommandInfo &L) const;
 344   MachO::segment_command_64
 345   getSegment64LoadCommand(const LoadCommandInfo &L) const;
 346   MachO::linker_option_command
 347   getLinkerOptionLoadCommand(const LoadCommandInfo &L) const;
 348   MachO::version_min_command
 349   getVersionMinLoadCommand(const LoadCommandInfo &L) const;
 350   MachO::dylib_command
 351   getDylibIDLoadCommand(const LoadCommandInfo &L) const;
 352   MachO::dyld_info_command
 353   getDyldInfoLoadCommand(const LoadCommandInfo &L) const;
 354   MachO::dylinker_command
 355   getDylinkerCommand(const LoadCommandInfo &L) const;
 356   MachO::uuid_command
 357   getUuidCommand(const LoadCommandInfo &L) const;
 358   MachO::rpath_command
 359   getRpathCommand(const LoadCommandInfo &L) const;
 360   MachO::source_version_command
 361   getSourceVersionCommand(const LoadCommandInfo &L) const;
 362   MachO::entry_point_command
 363   getEntryPointCommand(const LoadCommandInfo &L) const;
 364   MachO::encryption_info_command
 365   getEncryptionInfoCommand(const LoadCommandInfo &L) const;
 366   MachO::encryption_info_command_64
 367   getEncryptionInfoCommand64(const LoadCommandInfo &L) const;
 368   MachO::sub_framework_command
 369   getSubFrameworkCommand(const LoadCommandInfo &L) const;
 370   MachO::sub_umbrella_command
 371   getSubUmbrellaCommand(const LoadCommandInfo &L) const;
 372   MachO::sub_library_command
 373   getSubLibraryCommand(const LoadCommandInfo &L) const;
 374   MachO::sub_client_command
 375   getSubClientCommand(const LoadCommandInfo &L) const;
 376   MachO::routines_command
 377   getRoutinesCommand(const LoadCommandInfo &L) const;
 378   MachO::routines_command_64
 379   getRoutinesCommand64(const LoadCommandInfo &L) const;
 380   MachO::thread_command
 381   getThreadCommand(const LoadCommandInfo &L) const;
 382
 383   MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;
 384   MachO::data_in_code_entry getDice(DataRefImpl Rel) const;
 385   const MachO::mach_header &getHeader() const;
 386   const MachO::mach_header_64 &getHeader64() const;
 387   uint32_t
 388   getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,
 389                               unsigned Index) const;
 390   MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,
 391                                                     unsigned Index) const;
 392   MachO::symtab_command getSymtabLoadCommand() const;
 393   MachO::dysymtab_command getDysymtabLoadCommand() const;
 394   MachO::linkedit_data_command getDataInCodeLoadCommand() const;
 395   MachO::linkedit_data_command getLinkOptHintsLoadCommand() const;
 396   ArrayRef<uint8_t> getDyldInfoRebaseOpcodes() const;
 397   ArrayRef<uint8_t> getDyldInfoBindOpcodes() const;
 398   ArrayRef<uint8_t> getDyldInfoWeakBindOpcodes() const;
 399   ArrayRef<uint8_t> getDyldInfoLazyBindOpcodes() const;
 400   ArrayRef<uint8_t> getDyldInfoExportsTrie() const;
 401   ArrayRef<uint8_t> getUuid() const;
 402
 403   StringRef getStringTableData() const;
 404   bool is64Bit() const;
 405   void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
 406
 407   static StringRef guessLibraryShortName(StringRef Name, bool &isFramework,
 408                                          StringRef &Suffix);
 409
 410   static Triple::ArchType getArch(uint32_t CPUType);
 411   static Triple getArch(uint32_t CPUType, uint32_t CPUSubType,
 412                         const char **McpuDefault = nullptr);
 413   static Triple getThumbArch(uint32_t CPUType, uint32_t CPUSubType,
 414                              const char **McpuDefault = nullptr);
 415   static Triple getArch(uint32_t CPUType, uint32_t CPUSubType,
 416                         const char **McpuDefault, Triple *ThumbTriple);
 417   static bool isValidArch(StringRef ArchFlag);
 418   static Triple getHostArch();
 419
 420   bool isRelocatableObject() const override;
 421
 422   bool hasPageZeroSegment() const { return HasPageZeroSegment; }
 423
 424   static bool classof(const Binary *v) {
 425     return v->isMachO();
 426   }
 427
 428 private:
 429   union {
 430     MachO::mach_header_64 Header64;
 431     MachO::mach_header Header;
 432   };
 433   typedef SmallVector<const char*, 1> SectionList;
 434   SectionList Sections;
 435   typedef SmallVector<const char*, 1> LibraryList;
 436   LibraryList Libraries;
 437   LoadCommandList LoadCommands;
 438   typedef SmallVector<StringRef, 1> LibraryShortName;
 439   mutable LibraryShortName LibrariesShortNames;
 440   const char *SymtabLoadCmd;
 441   const char *DysymtabLoadCmd;
 442   const char *DataInCodeLoadCmd;
 443   const char *LinkOptHintsLoadCmd;
 444   const char *DyldInfoLoadCmd;
 445   const char *UuidLoadCmd;
 446   bool HasPageZeroSegment;
 447 };
 448
 449 /// DiceRef
 450 inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
 451   : DicePimpl(DiceP) , OwningObject(Owner) {}
 452
 453 inline bool DiceRef::operator==(const DiceRef &Other) const {
 454   return DicePimpl == Other.DicePimpl;
 455 }
 456
 457 inline bool DiceRef::operator<(const DiceRef &Other) const {
 458   return DicePimpl < Other.DicePimpl;
 459 }
 460
 461 inline void DiceRef::moveNext() {
 462   const MachO::data_in_code_entry *P =
 463     reinterpret_cast<const MachO::data_in_code_entry *>(DicePimpl.p);
 464   DicePimpl.p = reinterpret_cast<uintptr_t>(P + 1);
 465 }
 466
 467 // Since a Mach-O data in code reference, a DiceRef, can only be created when
 468 // the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
 469 // the methods that get the values of the fields of the reference.
 470
 471 inline std::error_code DiceRef::getOffset(uint32_t &Result) const {
 472   const MachOObjectFile *MachOOF =
 473     static_cast<const MachOObjectFile *>(OwningObject);
 474   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 475   Result = Dice.offset;
 476   return std::error_code();
 477 }
 478
 479 inline std::error_code DiceRef::getLength(uint16_t &Result) const {
 480   const MachOObjectFile *MachOOF =
 481     static_cast<const MachOObjectFile *>(OwningObject);
 482   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 483   Result = Dice.length;
 484   return std::error_code();
 485 }
 486
 487 inline std::error_code DiceRef::getKind(uint16_t &Result) const {
 488   const MachOObjectFile *MachOOF =
 489     static_cast<const MachOObjectFile *>(OwningObject);
 490   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 491   Result = Dice.kind;
 492   return std::error_code();
 493 }
 494
 495 inline DataRefImpl DiceRef::getRawDataRefImpl() const {
 496   return DicePimpl;
 497 }
 498
 499 inline const ObjectFile *DiceRef::getObjectFile() const {
 500   return OwningObject;
 501 }
 502
 503 }
 504 }
 505
 506 #endif
 507