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