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   section_iterator begin_sections() const LLVM_OVERRIDE;
 134   section_iterator end_sections() const LLVM_OVERRIDE;
 135
 136   library_iterator begin_libraries_needed() const LLVM_OVERRIDE;
 137   library_iterator end_libraries_needed() const LLVM_OVERRIDE;
 138
 139   uint8_t getBytesInAddress() const LLVM_OVERRIDE;
 140
 141   StringRef getFileFormatName() const LLVM_OVERRIDE;
 142   unsigned getArch() const LLVM_OVERRIDE;
 143
 144   StringRef getLoadName() const LLVM_OVERRIDE;
 145
 146   relocation_iterator section_rel_begin(unsigned Index) const;
 147   relocation_iterator section_rel_end(unsigned Index) const;
 148
 149   dice_iterator begin_dices() const;
 150   dice_iterator end_dices() const;
 151
 152   // In a MachO file, sections have a segment name. This is used in the .o
 153   // files. They have a single segment, but this field specifies which segment
 154   // a section should be put in in the final object.
 155   StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
 156
 157   // Names are stored as 16 bytes. These returns the raw 16 bytes without
 158   // interpreting them as a C string.
 159   ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
 160   ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
 161
 162   // MachO specific Info about relocations.
 163   bool isRelocationScattered(const MachO::any_relocation_info &RE) const;
 164   unsigned getPlainRelocationSymbolNum(
 165                                     const MachO::any_relocation_info &RE) const;
 166   bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;
 167   bool getScatteredRelocationScattered(
 168                                     const MachO::any_relocation_info &RE) const;
 169   uint32_t getScatteredRelocationValue(
 170                                     const MachO::any_relocation_info &RE) const;
 171   unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;
 172   unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;
 173   unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;
 174   unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;
 175   SectionRef getRelocationSection(const MachO::any_relocation_info &RE) const;
 176
 177   // Walk load commands.
 178   LoadCommandInfo getFirstLoadCommandInfo() const;
 179   LoadCommandInfo getNextLoadCommandInfo(const LoadCommandInfo &L) const;
 180
 181   // MachO specific structures.
 182   MachO::section getSection(DataRefImpl DRI) const;
 183   MachO::section_64 getSection64(DataRefImpl DRI) const;
 184   MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;
 185   MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;
 186   MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;
 187   MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;
 188
 189   MachO::linkedit_data_command
 190   getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
 191   MachO::segment_command
 192   getSegmentLoadCommand(const LoadCommandInfo &L) const;
 193   MachO::segment_command_64
 194   getSegment64LoadCommand(const LoadCommandInfo &L) const;
 195   MachO::linker_options_command
 196   getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const;
 197
 198   MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;
 199   MachO::data_in_code_entry getDice(DataRefImpl Rel) const;
 200   MachO::mach_header getHeader() const;
 201   MachO::mach_header_64 getHeader64() const;
 202   uint32_t
 203   getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,
 204                               unsigned Index) const;
 205   MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,
 206                                                     unsigned Index) const;
 207   MachO::symtab_command getSymtabLoadCommand() const;
 208   MachO::dysymtab_command getDysymtabLoadCommand() const;
 209   MachO::linkedit_data_command getDataInCodeLoadCommand() const;
 210
 211   StringRef getStringTableData() const;
 212   bool is64Bit() const;
 213   void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
 214
 215   static Triple::ArchType getArch(uint32_t CPUType);
 216
 217   static bool classof(const Binary *v) {
 218     return v->isMachO();
 219   }
 220
 221 private:
 222   typedef SmallVector<const char*, 1> SectionList;
 223   SectionList Sections;
 224   const char *SymtabLoadCmd;
 225   const char *DysymtabLoadCmd;
 226   const char *DataInCodeLoadCmd;
 227 };
 228
 229 /// DiceRef
 230 inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
 231   : DicePimpl(DiceP) , OwningObject(Owner) {}
 232
 233 inline bool DiceRef::operator==(const DiceRef &Other) const {
 234   return DicePimpl == Other.DicePimpl;
 235 }
 236
 237 inline bool DiceRef::operator<(const DiceRef &Other) const {
 238   return DicePimpl < Other.DicePimpl;
 239 }
 240
 241 inline void DiceRef::moveNext() {
 242   const MachO::data_in_code_entry *P =
 243     reinterpret_cast<const MachO::data_in_code_entry *>(DicePimpl.p);
 244   DicePimpl.p = reinterpret_cast<uintptr_t>(P + 1);
 245 }
 246
 247 // Since a Mach-O data in code reference, a DiceRef, can only be created when
 248 // the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
 249 // the methods that get the values of the fields of the reference.
 250
 251 inline error_code DiceRef::getOffset(uint32_t &Result) const {
 252   const MachOObjectFile *MachOOF =
 253     static_cast<const MachOObjectFile *>(OwningObject);
 254   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 255   Result = Dice.offset;
 256   return object_error::success;
 257 }
 258
 259 inline error_code DiceRef::getLength(uint16_t &Result) const {
 260   const MachOObjectFile *MachOOF =
 261     static_cast<const MachOObjectFile *>(OwningObject);
 262   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 263   Result = Dice.length;
 264   return object_error::success;
 265 }
 266
 267 inline error_code DiceRef::getKind(uint16_t &Result) const {
 268   const MachOObjectFile *MachOOF =
 269     static_cast<const MachOObjectFile *>(OwningObject);
 270   MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
 271   Result = Dice.kind;
 272   return object_error::success;
 273 }
 274
 275 inline DataRefImpl DiceRef::getRawDataRefImpl() const {
 276   return DicePimpl;
 277 }
 278
 279 inline const ObjectFile *DiceRef::getObjectFile() const {
 280   return OwningObject;
 281 }
 282
 283 }
 284 }
 285
 286 #endif
 287