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