1 //===- MachO.h - MachO object file implementation ---------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the MachOObjectFile class, which implement the ObjectFile
11 // interface for MachO files.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_OBJECT_MACHO_H
16 #define LLVM_OBJECT_MACHO_H
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"
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.
30 DataRefImpl DicePimpl;
31 const ObjectFile *OwningObject;
34 DiceRef() : OwningObject(nullptr) { }
36 DiceRef(DataRefImpl DiceP, const ObjectFile *Owner);
38 bool operator==(const DiceRef &Other) const;
39 bool operator<(const DiceRef &Other) const;
43 std::error_code getOffset(uint32_t &Result) const;
44 std::error_code getLength(uint16_t &Result) const;
45 std::error_code getKind(uint16_t &Result) const;
47 DataRefImpl getRawDataRefImpl() const;
48 const ObjectFile *getObjectFile() const;
50 typedef content_iterator<DiceRef> dice_iterator;
52 class MachOObjectFile : public ObjectFile {
54 struct LoadCommandInfo {
55 const char *Ptr; // Where in memory the load command is.
56 MachO::load_command C; // The command itself.
59 MachOObjectFile(std::unique_ptr<MemoryBuffer> Object, bool IsLittleEndian,
60 bool Is64Bits, std::error_code &EC);
62 void moveSymbolNext(DataRefImpl &Symb) const override;
63 std::error_code getSymbolName(DataRefImpl Symb,
64 StringRef &Res) const override;
67 std::error_code getIndirectName(DataRefImpl Symb, StringRef &Res) const;
69 std::error_code getSymbolAddress(DataRefImpl Symb,
70 uint64_t &Res) const override;
71 std::error_code getSymbolAlignment(DataRefImpl Symb,
72 uint32_t &Res) const override;
73 std::error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const override;
74 std::error_code getSymbolType(DataRefImpl Symb,
75 SymbolRef::Type &Res) const override;
76 uint32_t getSymbolFlags(DataRefImpl Symb) const override;
77 std::error_code getSymbolSection(DataRefImpl Symb,
78 section_iterator &Res) const override;
80 void moveSectionNext(DataRefImpl &Sec) const override;
81 std::error_code getSectionName(DataRefImpl Sec,
82 StringRef &Res) const override;
83 std::error_code getSectionAddress(DataRefImpl Sec,
84 uint64_t &Res) const override;
85 std::error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const override;
86 std::error_code getSectionContents(DataRefImpl Sec,
87 StringRef &Res) const override;
88 std::error_code getSectionAlignment(DataRefImpl Sec,
89 uint64_t &Res) const override;
90 std::error_code isSectionText(DataRefImpl Sec, bool &Res) const override;
91 std::error_code isSectionData(DataRefImpl Sec, bool &Res) const override;
92 std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const override;
93 std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
94 bool &Res) const override;
95 std::error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const override;
96 std::error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const override;
97 std::error_code isSectionReadOnlyData(DataRefImpl Sec,
98 bool &Res) const override;
99 std::error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
100 bool &Result) const override;
101 relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
102 relocation_iterator section_rel_end(DataRefImpl Sec) const override;
104 void moveRelocationNext(DataRefImpl &Rel) const override;
105 std::error_code getRelocationAddress(DataRefImpl Rel,
106 uint64_t &Res) const override;
107 std::error_code getRelocationOffset(DataRefImpl Rel,
108 uint64_t &Res) const override;
109 symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
110 std::error_code getRelocationType(DataRefImpl Rel,
111 uint64_t &Res) const override;
113 getRelocationTypeName(DataRefImpl Rel,
114 SmallVectorImpl<char> &Result) const override;
116 getRelocationValueString(DataRefImpl Rel,
117 SmallVectorImpl<char> &Result) const override;
118 std::error_code getRelocationHidden(DataRefImpl Rel,
119 bool &Result) const override;
122 std::error_code getLibraryShortNameByIndex(unsigned Index, StringRef &Res);
124 // TODO: Would be useful to have an iterator based version
125 // of the load command interface too.
127 basic_symbol_iterator symbol_begin_impl() const override;
128 basic_symbol_iterator symbol_end_impl() const override;
131 basic_symbol_iterator getSymbolByIndex(unsigned Index) const;
133 section_iterator section_begin() const override;
134 section_iterator section_end() const override;
136 uint8_t getBytesInAddress() const override;
138 StringRef getFileFormatName() const override;
139 unsigned getArch() const override;
141 relocation_iterator section_rel_begin(unsigned Index) const;
142 relocation_iterator section_rel_end(unsigned Index) const;
144 dice_iterator begin_dices() const;
145 dice_iterator end_dices() const;
147 // In a MachO file, sections have a segment name. This is used in the .o
148 // files. They have a single segment, but this field specifies which segment
149 // a section should be put in in the final object.
150 StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
152 // Names are stored as 16 bytes. These returns the raw 16 bytes without
153 // interpreting them as a C string.
154 ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
155 ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
157 // MachO specific Info about relocations.
158 bool isRelocationScattered(const MachO::any_relocation_info &RE) const;
159 unsigned getPlainRelocationSymbolNum(
160 const MachO::any_relocation_info &RE) const;
161 bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;
162 bool getScatteredRelocationScattered(
163 const MachO::any_relocation_info &RE) const;
164 uint32_t getScatteredRelocationValue(
165 const MachO::any_relocation_info &RE) const;
166 unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;
167 unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;
168 unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;
169 unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;
170 SectionRef getRelocationSection(const MachO::any_relocation_info &RE) const;
172 // Walk load commands.
173 LoadCommandInfo getFirstLoadCommandInfo() const;
174 LoadCommandInfo getNextLoadCommandInfo(const LoadCommandInfo &L) const;
176 // MachO specific structures.
177 MachO::section getSection(DataRefImpl DRI) const;
178 MachO::section_64 getSection64(DataRefImpl DRI) const;
179 MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;
180 MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;
181 MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;
182 MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;
184 MachO::linkedit_data_command
185 getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
186 MachO::segment_command
187 getSegmentLoadCommand(const LoadCommandInfo &L) const;
188 MachO::segment_command_64
189 getSegment64LoadCommand(const LoadCommandInfo &L) const;
190 MachO::linker_options_command
191 getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const;
192 MachO::version_min_command
193 getVersionMinLoadCommand(const LoadCommandInfo &L) const;
195 getDylibIDLoadCommand(const LoadCommandInfo &L) const;
197 MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;
198 MachO::data_in_code_entry getDice(DataRefImpl Rel) const;
199 MachO::mach_header getHeader() const;
200 MachO::mach_header_64 getHeader64() const;
202 getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,
203 unsigned Index) const;
204 MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,
205 unsigned Index) const;
206 MachO::symtab_command getSymtabLoadCommand() const;
207 MachO::dysymtab_command getDysymtabLoadCommand() const;
208 MachO::linkedit_data_command getDataInCodeLoadCommand() const;
210 StringRef getStringTableData() const;
211 bool is64Bit() const;
212 void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
214 static StringRef guessLibraryShortName(StringRef Name, bool &isFramework,
217 static Triple::ArchType getArch(uint32_t CPUType);
218 static Triple getArch(uint32_t CPUType, uint32_t CPUSubType);
219 static bool isValidArch(StringRef ArchFlag);
220 static Triple getHostArch();
222 static bool classof(const Binary *v) {
227 typedef SmallVector<const char*, 1> SectionList;
228 SectionList Sections;
229 typedef SmallVector<const char*, 1> LibraryList;
230 LibraryList Libraries;
231 typedef SmallVector<StringRef, 1> LibraryShortName;
232 LibraryShortName LibrariesShortNames;
233 const char *SymtabLoadCmd;
234 const char *DysymtabLoadCmd;
235 const char *DataInCodeLoadCmd;
239 inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
240 : DicePimpl(DiceP) , OwningObject(Owner) {}
242 inline bool DiceRef::operator==(const DiceRef &Other) const {
243 return DicePimpl == Other.DicePimpl;
246 inline bool DiceRef::operator<(const DiceRef &Other) const {
247 return DicePimpl < Other.DicePimpl;
250 inline void DiceRef::moveNext() {
251 const MachO::data_in_code_entry *P =
252 reinterpret_cast<const MachO::data_in_code_entry *>(DicePimpl.p);
253 DicePimpl.p = reinterpret_cast<uintptr_t>(P + 1);
256 // Since a Mach-O data in code reference, a DiceRef, can only be created when
257 // the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
258 // the methods that get the values of the fields of the reference.
260 inline std::error_code DiceRef::getOffset(uint32_t &Result) const {
261 const MachOObjectFile *MachOOF =
262 static_cast<const MachOObjectFile *>(OwningObject);
263 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
264 Result = Dice.offset;
265 return object_error::success;
268 inline std::error_code DiceRef::getLength(uint16_t &Result) const {
269 const MachOObjectFile *MachOOF =
270 static_cast<const MachOObjectFile *>(OwningObject);
271 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
272 Result = Dice.length;
273 return object_error::success;
276 inline std::error_code DiceRef::getKind(uint16_t &Result) const {
277 const MachOObjectFile *MachOOF =
278 static_cast<const MachOObjectFile *>(OwningObject);
279 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
281 return object_error::success;
284 inline DataRefImpl DiceRef::getRawDataRefImpl() const {
288 inline const ObjectFile *DiceRef::getObjectFile() const {