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 /// ExportEntry encapsulates the current-state-of-the-walk used when doing a
53 /// non-recursive walk of the trie data structure. This allows you to iterate
54 /// across all exported symbols using:
55 /// for (const llvm::object::ExportEntry &AnExport : Obj->exports()) {
59 ExportEntry(ArrayRef<uint8_t> Trie);
61 StringRef name() const;
62 uint64_t flags() const;
63 uint64_t address() const;
64 uint64_t other() const;
65 StringRef otherName() const;
66 uint32_t nodeOffset() const;
68 bool operator==(const ExportEntry &) const;
73 friend class MachOObjectFile;
76 uint64_t readULEB128(const uint8_t *&p);
77 void pushDownUntilBottom();
78 void pushNode(uint64_t Offset);
80 // Represents a node in the mach-o exports trie.
82 NodeState(const uint8_t *Ptr);
84 const uint8_t *Current;
88 const char *ImportName;
90 unsigned NextChildIndex;
91 unsigned ParentStringLength;
95 ArrayRef<uint8_t> Trie;
96 SmallString<256> CumulativeString;
97 SmallVector<NodeState, 16> Stack;
101 typedef content_iterator<ExportEntry> export_iterator;
103 /// MachORebaseEntry encapsulates the current state in the decompression of
104 /// rebasing opcodes. This allows you to iterate through the compressed table of
106 /// for (const llvm::object::MachORebaseEntry &Entry : Obj->rebaseTable()) {
108 class MachORebaseEntry {
110 MachORebaseEntry(ArrayRef<uint8_t> opcodes, bool is64Bit);
112 uint32_t segmentIndex() const;
113 uint64_t segmentOffset() const;
114 StringRef typeName() const;
116 bool operator==(const MachORebaseEntry &) const;
121 friend class MachOObjectFile;
124 uint64_t readULEB128();
126 ArrayRef<uint8_t> Opcodes;
128 uint64_t SegmentOffset;
129 uint32_t SegmentIndex;
130 uint64_t RemainingLoopCount;
131 uint64_t AdvanceAmount;
137 typedef content_iterator<MachORebaseEntry> rebase_iterator;
139 /// MachOBindEntry encapsulates the current state in the decompression of
140 /// binding opcodes. This allows you to iterate through the compressed table of
142 /// for (const llvm::object::MachOBindEntry &Entry : Obj->bindTable()) {
144 class MachOBindEntry {
146 enum class Kind { Regular, Lazy, Weak };
148 MachOBindEntry(ArrayRef<uint8_t> Opcodes, bool is64Bit, MachOBindEntry::Kind);
150 uint32_t segmentIndex() const;
151 uint64_t segmentOffset() const;
152 StringRef typeName() const;
153 StringRef symbolName() const;
154 uint32_t flags() const;
155 int64_t addend() const;
158 bool operator==(const MachOBindEntry &) const;
163 friend class MachOObjectFile;
166 uint64_t readULEB128();
167 int64_t readSLEB128();
169 ArrayRef<uint8_t> Opcodes;
171 uint64_t SegmentOffset;
172 uint32_t SegmentIndex;
173 StringRef SymbolName;
177 uint64_t RemainingLoopCount;
178 uint64_t AdvanceAmount;
185 typedef content_iterator<MachOBindEntry> bind_iterator;
187 class MachOObjectFile : public ObjectFile {
189 struct LoadCommandInfo {
190 const char *Ptr; // Where in memory the load command is.
191 MachO::load_command C; // The command itself.
193 typedef SmallVector<LoadCommandInfo, 4> LoadCommandList;
194 typedef LoadCommandList::const_iterator load_command_iterator;
196 MachOObjectFile(MemoryBufferRef Object, bool IsLittleEndian, bool Is64Bits,
197 std::error_code &EC);
199 void moveSymbolNext(DataRefImpl &Symb) const override;
201 uint64_t getNValue(DataRefImpl Sym) const;
202 std::error_code getSymbolName(DataRefImpl Symb,
203 StringRef &Res) const override;
206 std::error_code getIndirectName(DataRefImpl Symb, StringRef &Res) const;
207 unsigned getSectionType(SectionRef Sec) const;
209 std::error_code getSymbolAddress(DataRefImpl Symb,
210 uint64_t &Res) const override;
211 uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
212 uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
213 std::error_code getSymbolType(DataRefImpl Symb,
214 SymbolRef::Type &Res) const override;
215 uint32_t getSymbolFlags(DataRefImpl Symb) const override;
216 std::error_code getSymbolSection(DataRefImpl Symb,
217 section_iterator &Res) const override;
219 void moveSectionNext(DataRefImpl &Sec) const override;
220 std::error_code getSectionName(DataRefImpl Sec,
221 StringRef &Res) const override;
222 uint64_t getSectionAddress(DataRefImpl Sec) const override;
223 uint64_t getSectionSize(DataRefImpl Sec) const override;
224 std::error_code getSectionContents(DataRefImpl Sec,
225 StringRef &Res) const override;
226 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
227 bool isSectionText(DataRefImpl Sec) const override;
228 bool isSectionData(DataRefImpl Sec) const override;
229 bool isSectionBSS(DataRefImpl Sec) const override;
230 bool isSectionVirtual(DataRefImpl Sec) const override;
231 bool sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb) const override;
232 relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
233 relocation_iterator section_rel_end(DataRefImpl Sec) const override;
235 void moveRelocationNext(DataRefImpl &Rel) const override;
236 std::error_code getRelocationAddress(DataRefImpl Rel,
237 uint64_t &Res) const override;
238 std::error_code getRelocationOffset(DataRefImpl Rel,
239 uint64_t &Res) const override;
240 symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
241 section_iterator getRelocationSection(DataRefImpl Rel) const;
242 std::error_code getRelocationType(DataRefImpl Rel,
243 uint64_t &Res) const override;
245 getRelocationTypeName(DataRefImpl Rel,
246 SmallVectorImpl<char> &Result) const override;
247 std::error_code getRelocationHidden(DataRefImpl Rel,
248 bool &Result) const override;
249 uint8_t getRelocationLength(DataRefImpl Rel) const;
252 std::error_code getLibraryShortNameByIndex(unsigned Index, StringRef &) const;
254 // TODO: Would be useful to have an iterator based version
255 // of the load command interface too.
257 basic_symbol_iterator symbol_begin_impl() const override;
258 basic_symbol_iterator symbol_end_impl() const override;
261 basic_symbol_iterator getSymbolByIndex(unsigned Index) const;
263 section_iterator section_begin() const override;
264 section_iterator section_end() const override;
266 uint8_t getBytesInAddress() const override;
268 StringRef getFileFormatName() const override;
269 unsigned getArch() const override;
270 Triple getArch(const char **McpuDefault, Triple *ThumbTriple) const;
272 relocation_iterator section_rel_begin(unsigned Index) const;
273 relocation_iterator section_rel_end(unsigned Index) const;
275 dice_iterator begin_dices() const;
276 dice_iterator end_dices() const;
278 load_command_iterator begin_load_commands() const;
279 load_command_iterator end_load_commands() const;
280 iterator_range<load_command_iterator> load_commands() const;
282 /// For use iterating over all exported symbols.
283 iterator_range<export_iterator> exports() const;
285 /// For use examining a trie not in a MachOObjectFile.
286 static iterator_range<export_iterator> exports(ArrayRef<uint8_t> Trie);
288 /// For use iterating over all rebase table entries.
289 iterator_range<rebase_iterator> rebaseTable() const;
291 /// For use examining rebase opcodes not in a MachOObjectFile.
292 static iterator_range<rebase_iterator> rebaseTable(ArrayRef<uint8_t> Opcodes,
295 /// For use iterating over all bind table entries.
296 iterator_range<bind_iterator> bindTable() const;
298 /// For use iterating over all lazy bind table entries.
299 iterator_range<bind_iterator> lazyBindTable() const;
301 /// For use iterating over all lazy bind table entries.
302 iterator_range<bind_iterator> weakBindTable() const;
304 /// For use examining bind opcodes not in a MachOObjectFile.
305 static iterator_range<bind_iterator> bindTable(ArrayRef<uint8_t> Opcodes,
307 MachOBindEntry::Kind);
310 // In a MachO file, sections have a segment name. This is used in the .o
311 // files. They have a single segment, but this field specifies which segment
312 // a section should be put in in the final object.
313 StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;
315 // Names are stored as 16 bytes. These returns the raw 16 bytes without
316 // interpreting them as a C string.
317 ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;
318 ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;
320 // MachO specific Info about relocations.
321 bool isRelocationScattered(const MachO::any_relocation_info &RE) const;
322 unsigned getPlainRelocationSymbolNum(
323 const MachO::any_relocation_info &RE) const;
324 bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;
325 bool getScatteredRelocationScattered(
326 const MachO::any_relocation_info &RE) const;
327 uint32_t getScatteredRelocationValue(
328 const MachO::any_relocation_info &RE) const;
329 uint32_t getScatteredRelocationType(
330 const MachO::any_relocation_info &RE) const;
331 unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;
332 unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;
333 unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;
334 unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;
335 SectionRef getAnyRelocationSection(const MachO::any_relocation_info &RE) const;
337 // MachO specific structures.
338 MachO::section getSection(DataRefImpl DRI) const;
339 MachO::section_64 getSection64(DataRefImpl DRI) const;
340 MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;
341 MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;
342 MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;
343 MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;
345 MachO::linkedit_data_command
346 getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;
347 MachO::segment_command
348 getSegmentLoadCommand(const LoadCommandInfo &L) const;
349 MachO::segment_command_64
350 getSegment64LoadCommand(const LoadCommandInfo &L) const;
351 MachO::linker_option_command
352 getLinkerOptionLoadCommand(const LoadCommandInfo &L) const;
353 MachO::version_min_command
354 getVersionMinLoadCommand(const LoadCommandInfo &L) const;
356 getDylibIDLoadCommand(const LoadCommandInfo &L) const;
357 MachO::dyld_info_command
358 getDyldInfoLoadCommand(const LoadCommandInfo &L) const;
359 MachO::dylinker_command
360 getDylinkerCommand(const LoadCommandInfo &L) const;
362 getUuidCommand(const LoadCommandInfo &L) const;
364 getRpathCommand(const LoadCommandInfo &L) const;
365 MachO::source_version_command
366 getSourceVersionCommand(const LoadCommandInfo &L) const;
367 MachO::entry_point_command
368 getEntryPointCommand(const LoadCommandInfo &L) const;
369 MachO::encryption_info_command
370 getEncryptionInfoCommand(const LoadCommandInfo &L) const;
371 MachO::encryption_info_command_64
372 getEncryptionInfoCommand64(const LoadCommandInfo &L) const;
373 MachO::sub_framework_command
374 getSubFrameworkCommand(const LoadCommandInfo &L) const;
375 MachO::sub_umbrella_command
376 getSubUmbrellaCommand(const LoadCommandInfo &L) const;
377 MachO::sub_library_command
378 getSubLibraryCommand(const LoadCommandInfo &L) const;
379 MachO::sub_client_command
380 getSubClientCommand(const LoadCommandInfo &L) const;
381 MachO::routines_command
382 getRoutinesCommand(const LoadCommandInfo &L) const;
383 MachO::routines_command_64
384 getRoutinesCommand64(const LoadCommandInfo &L) const;
385 MachO::thread_command
386 getThreadCommand(const LoadCommandInfo &L) const;
388 MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;
389 MachO::data_in_code_entry getDice(DataRefImpl Rel) const;
390 const MachO::mach_header &getHeader() const;
391 const MachO::mach_header_64 &getHeader64() const;
393 getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,
394 unsigned Index) const;
395 MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,
396 unsigned Index) const;
397 MachO::symtab_command getSymtabLoadCommand() const;
398 MachO::dysymtab_command getDysymtabLoadCommand() const;
399 MachO::linkedit_data_command getDataInCodeLoadCommand() const;
400 MachO::linkedit_data_command getLinkOptHintsLoadCommand() const;
401 ArrayRef<uint8_t> getDyldInfoRebaseOpcodes() const;
402 ArrayRef<uint8_t> getDyldInfoBindOpcodes() const;
403 ArrayRef<uint8_t> getDyldInfoWeakBindOpcodes() const;
404 ArrayRef<uint8_t> getDyldInfoLazyBindOpcodes() const;
405 ArrayRef<uint8_t> getDyldInfoExportsTrie() const;
406 ArrayRef<uint8_t> getUuid() const;
408 StringRef getStringTableData() const;
409 bool is64Bit() const;
410 void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;
412 static StringRef guessLibraryShortName(StringRef Name, bool &isFramework,
415 static Triple::ArchType getArch(uint32_t CPUType);
416 static Triple getArch(uint32_t CPUType, uint32_t CPUSubType,
417 const char **McpuDefault = nullptr);
418 static Triple getThumbArch(uint32_t CPUType, uint32_t CPUSubType,
419 const char **McpuDefault = nullptr);
420 static Triple getArch(uint32_t CPUType, uint32_t CPUSubType,
421 const char **McpuDefault, Triple *ThumbTriple);
422 static bool isValidArch(StringRef ArchFlag);
423 static Triple getHostArch();
425 bool isRelocatableObject() const override;
427 bool hasPageZeroSegment() const { return HasPageZeroSegment; }
429 static bool classof(const Binary *v) {
435 MachO::mach_header_64 Header64;
436 MachO::mach_header Header;
438 typedef SmallVector<const char*, 1> SectionList;
439 SectionList Sections;
440 typedef SmallVector<const char*, 1> LibraryList;
441 LibraryList Libraries;
442 LoadCommandList LoadCommands;
443 typedef SmallVector<StringRef, 1> LibraryShortName;
444 mutable LibraryShortName LibrariesShortNames;
445 const char *SymtabLoadCmd;
446 const char *DysymtabLoadCmd;
447 const char *DataInCodeLoadCmd;
448 const char *LinkOptHintsLoadCmd;
449 const char *DyldInfoLoadCmd;
450 const char *UuidLoadCmd;
451 bool HasPageZeroSegment;
455 inline DiceRef::DiceRef(DataRefImpl DiceP, const ObjectFile *Owner)
456 : DicePimpl(DiceP) , OwningObject(Owner) {}
458 inline bool DiceRef::operator==(const DiceRef &Other) const {
459 return DicePimpl == Other.DicePimpl;
462 inline bool DiceRef::operator<(const DiceRef &Other) const {
463 return DicePimpl < Other.DicePimpl;
466 inline void DiceRef::moveNext() {
467 const MachO::data_in_code_entry *P =
468 reinterpret_cast<const MachO::data_in_code_entry *>(DicePimpl.p);
469 DicePimpl.p = reinterpret_cast<uintptr_t>(P + 1);
472 // Since a Mach-O data in code reference, a DiceRef, can only be created when
473 // the OwningObject ObjectFile is a MachOObjectFile a static_cast<> is used for
474 // the methods that get the values of the fields of the reference.
476 inline std::error_code DiceRef::getOffset(uint32_t &Result) const {
477 const MachOObjectFile *MachOOF =
478 static_cast<const MachOObjectFile *>(OwningObject);
479 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
480 Result = Dice.offset;
481 return std::error_code();
484 inline std::error_code DiceRef::getLength(uint16_t &Result) const {
485 const MachOObjectFile *MachOOF =
486 static_cast<const MachOObjectFile *>(OwningObject);
487 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
488 Result = Dice.length;
489 return std::error_code();
492 inline std::error_code DiceRef::getKind(uint16_t &Result) const {
493 const MachOObjectFile *MachOOF =
494 static_cast<const MachOObjectFile *>(OwningObject);
495 MachO::data_in_code_entry Dice = MachOOF->getDice(DicePimpl);
497 return std::error_code();
500 inline DataRefImpl DiceRef::getRawDataRefImpl() const {
504 inline const ObjectFile *DiceRef::getObjectFile() const {