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