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 binds the MachOObject
11// class to the generic ObjectFile wrapper.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_OBJECT_MACHO_H
16#define LLVM_OBJECT_MACHO_H
17
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/Object/MachOObject.h"
20#include "llvm/Object/ObjectFile.h"
21#include "llvm/Support/MachO.h"
22#include "llvm/Support/raw_ostream.h"
23
24namespace llvm {
25namespace object {
26
27typedef MachOObject::LoadCommandInfo LoadCommandInfo;
28
29class MachOObjectFile : public ObjectFile {
30public:
31  MachOObjectFile(MemoryBuffer *Object, MachOObject *MOO, error_code &ec);
32
33  virtual symbol_iterator begin_symbols() const;
34  virtual symbol_iterator end_symbols() const;
35  virtual symbol_iterator begin_dynamic_symbols() const;
36  virtual symbol_iterator end_dynamic_symbols() const;
37  virtual library_iterator begin_libraries_needed() const;
38  virtual library_iterator end_libraries_needed() const;
39  virtual section_iterator begin_sections() const;
40  virtual section_iterator end_sections() const;
41
42  virtual uint8_t getBytesInAddress() const;
43  virtual StringRef getFileFormatName() const;
44  virtual unsigned getArch() const;
45  virtual StringRef getLoadName() const;
46
47  // In a MachO file, sections have a segment name. This is used in the .o
48  // files. They have a single segment, but this field specifies which segment
49  // a section should be put in in the final object.
50  error_code getSectionFinalSegmentName(DataRefImpl Sec, StringRef &Res) const;
51
52  MachOObject *getObject() { return MachOObj.get(); }
53
54  static inline bool classof(const Binary *v) {
55    return v->isMachO();
56  }
57
58protected:
59  virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
60  virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
61  virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
62  virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
63  virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
64  virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
65  virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
66  virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
67  virtual error_code getSymbolSection(DataRefImpl Symb,
68                                      section_iterator &Res) const;
69  virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
70
71  virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
72  virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
73  virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
74  virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
75  virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
76  virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
77  virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
78  virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
79  virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
80  virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
81                                                   bool &Res) const;
82  virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
83  virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
84  virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
85  virtual error_code sectionContainsSymbol(DataRefImpl DRI, DataRefImpl S,
86                                           bool &Result) const;
87  virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
88  virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
89
90  virtual error_code getRelocationNext(DataRefImpl Rel,
91                                       RelocationRef &Res) const;
92  virtual error_code getRelocationAddress(DataRefImpl Rel,
93                                          uint64_t &Res) const;
94  virtual error_code getRelocationOffset(DataRefImpl Rel,
95                                         uint64_t &Res) const;
96  virtual error_code getRelocationSymbol(DataRefImpl Rel,
97                                         SymbolRef &Res) const;
98  virtual error_code getRelocationType(DataRefImpl Rel,
99                                       uint64_t &Res) const;
100  virtual error_code getRelocationTypeName(DataRefImpl Rel,
101                                           SmallVectorImpl<char> &Result) const;
102  virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
103                                                 int64_t &Res) const;
104  virtual error_code getRelocationValueString(DataRefImpl Rel,
105                                           SmallVectorImpl<char> &Result) const;
106  virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const;
107
108  virtual error_code getLibraryNext(DataRefImpl LibData, LibraryRef &Res) const;
109  virtual error_code getLibraryPath(DataRefImpl LibData, StringRef &Res) const;
110
111private:
112  OwningPtr<MachOObject> MachOObj;
113  mutable uint32_t RegisteredStringTable;
114  typedef SmallVector<DataRefImpl, 1> SectionList;
115  SectionList Sections;
116
117
118  void moveToNextSection(DataRefImpl &DRI) const;
119  void getSymbolTableEntry(DataRefImpl DRI,
120                           InMemoryStruct<macho::SymbolTableEntry> &Res) const;
121  void getSymbol64TableEntry(DataRefImpl DRI,
122                          InMemoryStruct<macho::Symbol64TableEntry> &Res) const;
123  void moveToNextSymbol(DataRefImpl &DRI) const;
124  void getSection(DataRefImpl DRI, InMemoryStruct<macho::Section> &Res) const;
125  void getSection64(DataRefImpl DRI,
126                    InMemoryStruct<macho::Section64> &Res) const;
127  void getRelocation(DataRefImpl Rel,
128                     InMemoryStruct<macho::RelocationEntry> &Res) const;
129  std::size_t getSectionIndex(DataRefImpl Sec) const;
130
131  void printRelocationTargetName(InMemoryStruct<macho::RelocationEntry>& RE,
132                                 raw_string_ostream &fmt) const;
133};
134
135}
136}
137
138#endif
139
140