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(NULL) { }
  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   error_code getOffset(uint32_t &Result) const;
  44   error_code getLength(uint16_t &Result) const;
  45   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 class MachOObjectFile : public ObjectFile {
  53 public:
  54   struct LoadCommandInfo {
  55     const char *Ptr;      // Where in memory the load command is.
  56     MachO::load_command C; // The command itself.
  57   };
  58
  59   MachOObjectFile(MemoryBuffer *Object, bool IsLittleEndian, bool Is64Bits,
  60                   error_code &EC, bool BufferOwned = true);
  61
  62   void moveSymbolNext(DataRefImpl &Symb) const LLVM_OVERRIDE;
  63   error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const
  64       LLVM_OVERRIDE;
  65   error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const
  66       LLVM_OVERRIDE;
  67   error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const
  68       LLVM_OVERRIDE;
  69   error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const
  70       LLVM_OVERRIDE;
  71   error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const LLVM_OVERRIDE;
  72   error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const
  73       LLVM_OVERRIDE;
  74   error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const
  75       LLVM_OVERRIDE;
  76   error_code getSymbolSection(DataRefImpl Symb, section_iterator &Res) const
  77       LLVM_OVERRIDE;
  78   error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const
  79       LLVM_OVERRIDE;
  80
  81   void moveSectionNext(DataRefImpl &Sec) const LLVM_OVERRIDE;
  82   error_code getSectionName(DataRefImpl Sec, StringRef &Res) const
  83       LLVM_OVERRIDE;
  84   error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const
  85       LLVM_OVERRIDE;
  86   error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const LLVM_OVERRIDE;
  87   error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const
  88       LLVM_OVERRIDE;
  89   error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const
  90       LLVM_OVERRIDE;
  91   error_code isSectionText(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  92   error_code isSectionData(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  93   error_code isSectionBSS(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  94   error_code isSectionRequiredForExecution(DataRefImpl Sec, bool &Res) const
  95       LLVM_OVERRIDE;
  96   error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  97   error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  98   error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const
  99       LLVM_OVERRIDE;
 100   error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 101                                    bool &Result) const LLVM_OVERRIDE;
 102   relocation_iterator section_rel_begin(DataRefImpl Sec) const LLVM_OVERRIDE;
 103   relocation_iterator section_rel_end(DataRefImpl Sec) const LLVM_OVERRIDE;
 104
 105   void moveRelocationNext(DataRefImpl &Rel) const LLVM_OVERRIDE;
 106   error_code getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const
 107       LLVM_OVERRIDE;
 108   error_code getRelocationOffset(DataRefImpl Rel, uint64_t &Res) const
 109       LLVM_OVERRIDE;
 110   symbol_iterator getRelocationSymbol(DataRefImpl Rel) const LLVM_OVERRIDE;
 111   error_code getRelocationType(DataRefImpl Rel, uint64_t &Res) const
 112       LLVM_OVERRIDE;
 113   error_code getRelocationTypeName(DataRefImpl Rel,
 114                                    SmallVectorImpl<char> &Result) const
 115       LLVM_OVERRIDE;
 116   error_code getRelocationValueString(DataRefImpl Rel,
 117                                       SmallVectorImpl<char> &Result) const
 118       LLVM_OVERRIDE;
 119   error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const
 120       LLVM_OVERRIDE;
 121
 122   error_code getLibraryNext(DataRefImpl LibData, LibraryRef &Res) const
 123       LLVM_OVERRIDE;
 124   error_code getLibraryPath(DataRefImpl LibData, StringRef &Res) const
 125       LLVM_OVERRIDE;
 126
 127   // TODO: Would be useful to have an iterator based version
 128   // of the load command interface too.
 129
 130   symbol_iterator begin_symbols() const LLVM_OVERRIDE;
 131   symbol_iterator end_symbols() const LLVM_OVERRIDE;
 132
 133   symbol_iterator begin_dynamic_symbols() const LLVM_OVERRIDE;
 134   symbol_iterator end_dynamic_symbols() const LLVM_OVERRIDE;
 135
 136   section_iterator begin_sections() const LLVM_OVERRIDE;
 137   section_iterator end_sections() const LLVM_OVERRIDE;
 138
 139   library_iterator begin_libraries_needed() const LLVM_OVERRIDE;
 140   library_iterator end_libraries_needed() const LLVM_OVERRIDE;
 141
 142   uint8_t getBytesInAddress() const LLVM_OVERRIDE;
 143
 144   StringRef getFileFormatName() const LLVM_OVERRIDE;
 145   unsigned getArch() const LLVM_OVERRIDE;
 146
 147   StringRef getLoadName() const LLVM_OVERRIDE;
 148
 149   relocation_iterator section_rel_begin(unsigned Index) const;
 150   relocation_iterator section_rel_end(unsigned Index) const;
 151
 152   dice_iterator begin_dices() const;
 153   dice_iterator end_dices() const;
 154
 155   // In a MachO file, sections have a segment name. This is used in the .o
 156   // files. They have a single segment, but this field specifies which segment
 157   // a section should be put in in the final object.
 158   StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
 159
 160   // Names are stored as 16 bytes. These returns the raw 16 bytes without
 161   // interpreting them as a C string.
 162   ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
 163   ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
 164
 165   // MachO specific Info about relocations.
 166   bool isRelocationScattered(const MachO::any_relocation_info &RE) const;
 167   unsigned getPlainRelocationSymbolNum(
 168                                     const MachO::any_relocation_info &RE) const;
 169   bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;
 170   bool getScatteredRelocationScattered(
 171                                     const MachO::any_relocation_info &RE) const;
 172   uint32_t getScatteredRelocationValue(
 173                                     const MachO::any_relocation_info &RE) const;
 174   unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;
 175   unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;
 176   unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;
 177   unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;
 178   SectionRef getRelocationSection(const MachO::any_relocation_info &RE) const;
 179
 180   // Walk load commands.
 181   LoadCommandInfo getFirstLoadCommandInfo() const;
 182   LoadCommandInfo getNextLoadCommandInfo(const LoadCommandInfo &L) const;
 183
 184   // MachO specific structures.
 185   MachO::section getSection(DataRefImpl DRI) const;
 186   MachO::section_64 getSection64(DataRefImpl DRI) const;
 187   MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;
 188   MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;
 189   MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;
 190   MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;
 191
 192   MachO::linkedit_data_command
 193   getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
 194   MachO::segment_command
 195   getSegmentLoadCommand(const LoadCommandInfo &L) const;
 196   MachO::segment_command_64
 197   getSegment64LoadCommand(const LoadCommandInfo &L) const;
 198   MachO::linker_options_command
 199   getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const;
 200
 201   MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;
 202   MachO::data_in_code_entry getDice(DataRefImpl Rel) const;
 203   MachO::mach_header getHeader() const;
 204   MachO::mach_header_64 getHeader64() const;
 205   uint32_t
 206   getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,
 207                               unsigned Index) const;
 208   MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,
 209                                                     unsigned Index) const;
 210   MachO::symtab_command getSymtabLoadCommand() const;
 211   MachO::dysymtab_command getDysymtabLoadCommand() const;
 212   MachO::linkedit_data_command getDataInCodeLoadCommand() const;
 213
 214   StringRef getStringTableData() const;
 215   bool is64Bit() const;
 216   void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
 217
 218   static Triple::ArchType getArch(uint32_t CPUType);
 219
 220   static bool classof(const Binary *v) {
 221     return v->isMachO();
 222   }
 223
 224 private:
 225   typedef SmallVector<const char*, 1> SectionList;
 226   SectionList Sections;
 227   const char *SymtabLoadCmd;
 228   const char *DysymtabLoadCmd;
 229   const char *DataInCodeLoadCmd;
 230 };
 231
 232 /// DiceRef
 233 inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
 234   : DicePimpl(DiceP) , OwningObject(Owner) {}
 235
 236 inline bool DiceRef::operator==(const DiceRef &Other) const {
 237   return DicePimpl == Other.DicePimpl;
 238 }
 239
 240 inline bool DiceRef::operator<(const DiceRef &Other) const {
 241   return DicePimpl < Other.DicePimpl;
 242 }
 243
 244 inline void DiceRef::moveNext() {
 245   const MachO::data_in_code_entry *P =
 246     reinterpret_cast<const MachO::data_in_code_entry *>(DicePimpl.p);
 247   DicePimpl.p = reinterpret_cast<uintptr_t>(P + 1);
 248 }
 249
 250 // Since a Mach-O data in code reference, a DiceRef, can only be created when
 251 // the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
 252 // the methods that get the values of the fields of the reference.
 253
 254 inline error_code DiceRef::getOffset(uint32_t &Result) const {
 255   const MachOObjectFile *MachOOF =
 256     static_cast<const MachOObjectFile *>(OwningObject);
 257   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 258   Result = Dice.offset;
 259   return object_error::success;
 260 }
 261
 262 inline error_code DiceRef::getLength(uint16_t &Result) const {
 263   const MachOObjectFile *MachOOF =
 264     static_cast<const MachOObjectFile *>(OwningObject);
 265   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 266   Result = Dice.length;
 267   return object_error::success;
 268 }
 269
 270 inline error_code DiceRef::getKind(uint16_t &Result) const {
 271   const MachOObjectFile *MachOOF =
 272     static_cast<const MachOObjectFile *>(OwningObject);
 273   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 274   Result = Dice.kind;
 275   return object_error::success;
 276 }
 277
 278 inline DataRefImpl DiceRef::getRawDataRefImpl() const {
 279   return DicePimpl;
 280 }
 281
 282 inline const ObjectFile *DiceRef::getObjectFile() const {
 283   return OwningObject;
 284 }
 285
 286 }
 287 }
 288
 289 #endif
 290