Link with -rdynamic instead of -Wl,-export-dynamic.
[oota-llvm.git] / include / llvm / Object / MachO.h
index 2e504155ace3eda7f9ed3844353534e3366cf646..50435d6fe227d9b5c74fe901f4078bf609ad5cc0 100644 (file)
@@ -7,8 +7,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This file declares the MachOObjectFile class, which binds the MachOObject
-// class to the generic ObjectFile wrapper.
+// This file declares the MachOObjectFile class, which implement the ObjectFile
+// interface for MachO files.
 //
 //===----------------------------------------------------------------------===//
 
 
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallVector.h"
-#include "llvm/Object/MachOObject.h"
+#include "llvm/ADT/Triple.h"
+#include "llvm/Object/MachOFormat.h"
 #include "llvm/Object/ObjectFile.h"
-#include "llvm/Support/Endian.h"
 #include "llvm/Support/MachO.h"
 #include "llvm/Support/raw_ostream.h"
 
 namespace llvm {
 namespace object {
 
-namespace MachOFormat {
-  struct Section {
-    char Name[16];
-    char SegmentName[16];
-    support::ulittle32_t Address;
-    support::ulittle32_t Size;
-    support::ulittle32_t Offset;
-    support::ulittle32_t Align;
-    support::ulittle32_t RelocationTableOffset;
-    support::ulittle32_t NumRelocationTableEntries;
-    support::ulittle32_t Flags;
-    support::ulittle32_t Reserved1;
-    support::ulittle32_t Reserved2;
-  };
-
-  struct Section64 {
-    char Name[16];
-    char SegmentName[16];
-    support::ulittle64_t Address;
-    support::ulittle64_t Size;
-    support::ulittle32_t Offset;
-    support::ulittle32_t Align;
-    support::ulittle32_t RelocationTableOffset;
-    support::ulittle32_t NumRelocationTableEntries;
-    support::ulittle32_t Flags;
-    support::ulittle32_t Reserved1;
-    support::ulittle32_t Reserved2;
-    support::ulittle32_t Reserved3;
-  };
-
-  struct RelocationEntry {
-    support::ulittle32_t Word0;
-    support::ulittle32_t Word1;
-  };
-
-  struct SymbolTableEntry {
-    support::ulittle32_t StringIndex;
-    uint8_t Type;
-    uint8_t SectionIndex;
-    support::ulittle16_t Flags;
-    support::ulittle32_t Value;
-  };
+/// DiceRef - This is a value type class that represents a single
+/// data in code entry in the table in a Mach-O object file.
+class DiceRef {
+  DataRefImpl DicePimpl;
+  const ObjectFile *OwningObject;
 
-  struct Symbol64TableEntry {
-    support::ulittle32_t StringIndex;
-    uint8_t Type;
-    uint8_t SectionIndex;
-    support::ulittle16_t Flags;
-    support::ulittle64_t Value;
-  };
+public:
+  DiceRef() : OwningObject(NULL) { }
 
-  struct SymtabLoadCommand {
-    support::ulittle32_t Type;
-    support::ulittle32_t Size;
-    support::ulittle32_t SymbolTableOffset;
-    support::ulittle32_t NumSymbolTableEntries;
-    support::ulittle32_t StringTableOffset;
-    support::ulittle32_t StringTableSize;
-  };
+  DiceRef(DataRefImpl DiceP, const ObjectFile *Owner);
 
-  struct SegmentLoadCommand {
-    support::ulittle32_t Type;
-    support::ulittle32_t Size;
-    char Name[16];
-    support::ulittle32_t VMAddress;
-    support::ulittle32_t VMSize;
-    support::ulittle32_t FileOffset;
-    support::ulittle32_t FileSize;
-    support::ulittle32_t MaxVMProtection;
-    support::ulittle32_t InitialVMProtection;
-    support::ulittle32_t NumSections;
-    support::ulittle32_t Flags;
-  };
+  bool operator==(const DiceRef &Other) const;
+  bool operator<(const DiceRef &Other) const;
 
-  struct Segment64LoadCommand {
-    support::ulittle32_t Type;
-    support::ulittle32_t Size;
-    char Name[16];
-    support::ulittle64_t VMAddress;
-    support::ulittle64_t VMSize;
-    support::ulittle64_t FileOffset;
-    support::ulittle64_t FileSize;
-    support::ulittle32_t MaxVMProtection;
-    support::ulittle32_t InitialVMProtection;
-    support::ulittle32_t NumSections;
-    support::ulittle32_t Flags;
-  };
+  error_code getNext(DiceRef &Result) const;
 
-  struct LinkeditDataLoadCommand {
-    support::ulittle32_t Type;
-    support::ulittle32_t Size;
-    support::ulittle32_t DataOffset;
-    support::ulittle32_t DataSize;
-  };
-}
+  error_code getOffset(uint32_t &Result) const;
+  error_code getLength(uint16_t &Result) const;
+  error_code getKind(uint16_t &Result) const;
 
-typedef MachOObject::LoadCommandInfo LoadCommandInfo;
+  DataRefImpl getRawDataRefImpl() const;
+  const ObjectFile *getObjectFile() const;
+};
+typedef content_iterator<DiceRef> dice_iterator;
 
 class MachOObjectFile : public ObjectFile {
 public:
-  MachOObjectFile(MemoryBuffer *Object, MachOObject *MOO, error_code &ec);
-
-  virtual symbol_iterator begin_symbols() const;
-  virtual symbol_iterator end_symbols() const;
-  virtual symbol_iterator begin_dynamic_symbols() const;
-  virtual symbol_iterator end_dynamic_symbols() const;
-  virtual library_iterator begin_libraries_needed() const;
-  virtual library_iterator end_libraries_needed() const;
-  virtual section_iterator begin_sections() const;
-  virtual section_iterator end_sections() const;
-
-  virtual uint8_t getBytesInAddress() const;
-  virtual StringRef getFileFormatName() const;
-  virtual unsigned getArch() const;
-  virtual StringRef getLoadName() const;
-
-  // In a MachO file, sections have a segment name. This is used in the .o
-  // files. They have a single segment, but this field specifies which segment
-  // a section should be put in in the final object.
-  StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
-
-  // Names are stored as 16 bytes. These returns the raw 16 bytes without
-  // interpreting them as a C string.
-  ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
-  ArrayRef<char>getSectionRawFinalSegmentName(DataRefImpl Sec) const;
-
-  const MachOFormat::LinkeditDataLoadCommand *
-    getLinkeditDataLoadCommand(LoadCommandInfo LCI) const;
-  const MachOFormat::Section64 *getSection64(DataRefImpl DRI) const;
-  const MachOFormat::Section *getSection(DataRefImpl DRI) const;
-  const MachOFormat::Symbol64TableEntry *
-    getSymbol64TableEntry(DataRefImpl DRI) const;
-  const MachOFormat::SymbolTableEntry *
-    getSymbolTableEntry(DataRefImpl DRI) const;
-  bool is64Bit() const;
-
-  const MachOObject *getObject() const { return MachOObj.get(); }
+  struct LoadCommandInfo {
+    const char *Ptr;      // Where in memory the load command is.
+    macho::LoadCommand C; // The command itself.
+  };
 
-  static inline bool classof(const Binary *v) {
-    return v->isMachO();
-  }
+  MachOObjectFile(MemoryBuffer *Object, bool IsLittleEndian, bool Is64Bits,
+                  error_code &ec);
 
-protected:
   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
-  virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
+  virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
+  virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
+  virtual error_code getSymbolType(DataRefImpl Symb,
+                                   SymbolRef::Type &Res) const;
   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
   virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
-  virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
   virtual error_code getSymbolSection(DataRefImpl Symb,
                                       section_iterator &Res) const;
   virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
@@ -195,25 +89,19 @@ protected:
   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
-  virtual error_code sectionContainsSymbol(DataRefImpl DRI, DataRefImpl S,
+  virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
                                            bool &Result) const;
   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
 
   virtual error_code getRelocationNext(DataRefImpl Rel,
                                        RelocationRef &Res) const;
-  virtual error_code getRelocationAddress(DataRefImpl Rel,
-                                          uint64_t &Res) const;
-  virtual error_code getRelocationOffset(DataRefImpl Rel,
-                                         uint64_t &Res) const;
-  virtual error_code getRelocationSymbol(DataRefImpl Rel,
-                                         SymbolRef &Res) const;
-  virtual error_code getRelocationType(DataRefImpl Rel,
-                                       uint64_t &Res) const;
+  virtual error_code getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const;
+  virtual error_code getRelocationOffset(DataRefImpl Rel, uint64_t &Res) const;
+  virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const;
+  virtual error_code getRelocationType(DataRefImpl Rel, uint64_t &Res) const;
   virtual error_code getRelocationTypeName(DataRefImpl Rel,
                                            SmallVectorImpl<char> &Result) const;
-  virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
-                                                 int64_t &Res) const;
   virtual error_code getRelocationValueString(DataRefImpl Rel,
                                            SmallVectorImpl<char> &Result) const;
   virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const;
@@ -221,35 +109,164 @@ protected:
   virtual error_code getLibraryNext(DataRefImpl LibData, LibraryRef &Res) const;
   virtual error_code getLibraryPath(DataRefImpl LibData, StringRef &Res) const;
 
+  // TODO: Would be useful to have an iterator based version
+  // of the load command interface too.
+
+  virtual symbol_iterator begin_symbols() const;
+  virtual symbol_iterator end_symbols() const;
+
+  virtual symbol_iterator begin_dynamic_symbols() const;
+  virtual symbol_iterator end_dynamic_symbols() const;
+
+  virtual section_iterator begin_sections() const;
+  virtual section_iterator end_sections() const;
+
+  virtual library_iterator begin_libraries_needed() const;
+  virtual library_iterator end_libraries_needed() const;
+
+  virtual uint8_t getBytesInAddress() const;
+
+  virtual StringRef getFileFormatName() const;
+  virtual unsigned getArch() const;
+
+  virtual StringRef getLoadName() const;
+
+  relocation_iterator getSectionRelBegin(unsigned Index) const;
+  relocation_iterator getSectionRelEnd(unsigned Index) const;
+
+  dice_iterator begin_dices() const;
+  dice_iterator end_dices() const;
+
+  // In a MachO file, sections have a segment name. This is used in the .o
+  // files. They have a single segment, but this field specifies which segment
+  // a section should be put in in the final object.
+  StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
+
+  // Names are stored as 16 bytes. These returns the raw 16 bytes without
+  // interpreting them as a C string.
+  ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
+  ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
+
+  // MachO specific Info about relocations.
+  bool isRelocationScattered(const macho::RelocationEntry &RE) const;
+  unsigned getPlainRelocationSymbolNum(const macho::RelocationEntry &RE) const;
+  bool getPlainRelocationExternal(const macho::RelocationEntry &RE) const;
+  bool getScatteredRelocationScattered(const macho::RelocationEntry &RE) const;
+  uint32_t getScatteredRelocationValue(const macho::RelocationEntry &RE) const;
+  unsigned getAnyRelocationAddress(const macho::RelocationEntry &RE) const;
+  unsigned getAnyRelocationPCRel(const macho::RelocationEntry &RE) const;
+  unsigned getAnyRelocationLength(const macho::RelocationEntry &RE) const;
+  unsigned getAnyRelocationType(const macho::RelocationEntry &RE) const;
+  SectionRef getRelocationSection(const macho::RelocationEntry &RE) const;
+
+  // Walk load commands.
+  LoadCommandInfo getFirstLoadCommandInfo() const;
+  LoadCommandInfo getNextLoadCommandInfo(const LoadCommandInfo &L) const;
+
+  // MachO specific structures.
+  macho::Section getSection(DataRefImpl DRI) const;
+  macho::Section64 getSection64(DataRefImpl DRI) const;
+  macho::Section getSection(const LoadCommandInfo &L, unsigned Index) const;
+  macho::Section64 getSection64(const LoadCommandInfo &L, unsigned Index) const;
+  macho::SymbolTableEntry getSymbolTableEntry(DataRefImpl DRI) const;
+  macho::Symbol64TableEntry getSymbol64TableEntry(DataRefImpl DRI) const;
+
+  macho::LinkeditDataLoadCommand
+  getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
+  macho::SegmentLoadCommand
+  getSegmentLoadCommand(const LoadCommandInfo &L) const;
+  macho::Segment64LoadCommand
+  getSegment64LoadCommand(const LoadCommandInfo &L) const;
+  macho::LinkerOptionsLoadCommand
+  getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const;
+
+  macho::RelocationEntry getRelocation(DataRefImpl Rel) const;
+  macho::DataInCodeTableEntry getDice(DataRefImpl Rel) const;
+  macho::Header getHeader() const;
+  macho::Header64Ext getHeader64Ext() const;
+  macho::IndirectSymbolTableEntry
+  getIndirectSymbolTableEntry(const macho::DysymtabLoadCommand &DLC,
+                              unsigned Index) const;
+  macho::DataInCodeTableEntry getDataInCodeTableEntry(uint32_t DataOffset,
+                                                      unsigned Index) const;
+  macho::SymtabLoadCommand getSymtabLoadCommand() const;
+  macho::DysymtabLoadCommand getDysymtabLoadCommand() const;
+  macho::LinkeditDataLoadCommand getDataInCodeLoadCommand() const;
+
+  StringRef getStringTableData() const;
+  bool is64Bit() const;
+  void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
+
+  static Triple::ArchType getArch(uint32_t CPUType);
+
+  static bool classof(const Binary *v) {
+    return v->isMachO();
+  }
+
 private:
-  OwningPtr<MachOObject> MachOObj;
-  typedef SmallVector<DataRefImpl, 1> SectionList;
+  typedef SmallVector<const char*, 1> SectionList;
   SectionList Sections;
+  const char *SymtabLoadCmd;
+  const char *DysymtabLoadCmd;
+  const char *DataInCodeLoadCmd;
+};
 
+/// DiceRef
+inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
+  : DicePimpl(DiceP) , OwningObject(Owner) {}
 
-  void moveToNextSection(DataRefImpl &DRI) const;
+inline bool DiceRef::operator==(const DiceRef &Other) const {
+  return DicePimpl == Other.DicePimpl;
+}
 
-  const MachOFormat::SymbolTableEntry *
-  getSymbolTableEntry(DataRefImpl DRI,
-                     const MachOFormat::SymtabLoadCommand *SymtabLoadCmd) const;
+inline bool DiceRef::operator<(const DiceRef &Other) const {
+  return DicePimpl < Other.DicePimpl;
+}
 
-  const MachOFormat::Symbol64TableEntry *
-  getSymbol64TableEntry(DataRefImpl DRI,
-                     const MachOFormat::SymtabLoadCommand *SymtabLoadCmd) const;
+inline error_code DiceRef::getNext(DiceRef &Result) const {
+  DataRefImpl Rel = DicePimpl;
+  const macho::DataInCodeTableEntry *P =
+    reinterpret_cast<const macho::DataInCodeTableEntry *>(Rel.p);
+  Rel.p = reinterpret_cast<uintptr_t>(P + 1);
+  Result = DiceRef(Rel, OwningObject);
+  return object_error::success;
+}
 
-  void moveToNextSymbol(DataRefImpl &DRI) const;
-  const MachOFormat::RelocationEntry *getRelocation(DataRefImpl Rel) const;
-  const MachOFormat::SymtabLoadCommand *
-    getSymtabLoadCommand(LoadCommandInfo LCI) const;
-  const MachOFormat::SegmentLoadCommand *
-    getSegmentLoadCommand(LoadCommandInfo LCI) const;
-  const MachOFormat::Segment64LoadCommand *
-    getSegment64LoadCommand(LoadCommandInfo LCI) const;
-  std::size_t getSectionIndex(DataRefImpl Sec) const;
+// Since a Mach-O data in code reference, a DiceRef, can only be created when
+// the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
+// the methods that get the values of the fields of the reference.
 
-  void printRelocationTargetName(const MachOFormat::RelocationEntry *RE,
-                                 raw_string_ostream &fmt) const;
-};
+inline error_code DiceRef::getOffset(uint32_t &Result) const {
+  const MachOObjectFile *MachOOF =
+    static_cast<const MachOObjectFile *>(OwningObject);
+  macho::DataInCodeTableEntry Dice = MachOOF->getDice(DicePimpl);
+  Result = Dice.Offset;
+  return object_error::success;
+}
+
+inline error_code DiceRef::getLength(uint16_t &Result) const {
+  const MachOObjectFile *MachOOF =
+    static_cast<const MachOObjectFile *>(OwningObject);
+  macho::DataInCodeTableEntry Dice = MachOOF->getDice(DicePimpl);
+  Result = Dice.Length;
+  return object_error::success;
+}
+
+inline error_code DiceRef::getKind(uint16_t &Result) const {
+  const MachOObjectFile *MachOOF =
+    static_cast<const MachOObjectFile *>(OwningObject);
+  macho::DataInCodeTableEntry Dice = MachOOF->getDice(DicePimpl);
+  Result = Dice.Kind;
+  return object_error::success;
+}
+
+inline DataRefImpl DiceRef::getRawDataRefImpl() const {
+  return DicePimpl;
+}
+
+inline const ObjectFile *DiceRef::getObjectFile() const {
+  return OwningObject;
+}
 
 }
 }