1 //===- MachOObjectFile.cpp - Mach-O object file binding ---------*- 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 defines the MachOObjectFile class, which binds the MachOObject
11 // class to the generic ObjectFile wrapper.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Object/MachO.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/Triple.h"
18 #include "llvm/Support/DataExtractor.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/Support/Host.h"
21 #include "llvm/Support/MemoryBuffer.h"
22 #include "llvm/Support/raw_ostream.h"
28 using namespace object;
46 static void SwapValue(T &Value) {
47 Value = sys::SwapByteOrder(Value);
51 static void SwapStruct(T &Value);
54 void SwapStruct(MachO::any_relocation_info &H) {
60 void SwapStruct(MachO::load_command &L) {
66 void SwapStruct(nlist_base &S) {
72 void SwapStruct(MachO::section &S) {
80 SwapValue(S.reserved1);
81 SwapValue(S.reserved2);
85 void SwapStruct(MachO::section_64 &S) {
93 SwapValue(S.reserved1);
94 SwapValue(S.reserved2);
95 SwapValue(S.reserved3);
99 void SwapStruct(MachO::nlist &S) {
102 SwapValue(S.n_value);
106 void SwapStruct(MachO::nlist_64 &S) {
109 SwapValue(S.n_value);
113 void SwapStruct(MachO::mach_header &H) {
115 SwapValue(H.cputype);
116 SwapValue(H.cpusubtype);
117 SwapValue(H.filetype);
119 SwapValue(H.sizeofcmds);
124 void SwapStruct(MachO::mach_header_64 &H) {
126 SwapValue(H.cputype);
127 SwapValue(H.cpusubtype);
128 SwapValue(H.filetype);
130 SwapValue(H.sizeofcmds);
132 SwapValue(H.reserved);
136 void SwapStruct(MachO::symtab_command &C) {
138 SwapValue(C.cmdsize);
142 SwapValue(C.strsize);
146 void SwapStruct(MachO::dysymtab_command &C) {
148 SwapValue(C.cmdsize);
149 SwapValue(C.ilocalsym);
150 SwapValue(C.nlocalsym);
151 SwapValue(C.iextdefsym);
152 SwapValue(C.nextdefsym);
153 SwapValue(C.iundefsym);
154 SwapValue(C.nundefsym);
157 SwapValue(C.modtaboff);
158 SwapValue(C.nmodtab);
159 SwapValue(C.extrefsymoff);
160 SwapValue(C.nextrefsyms);
161 SwapValue(C.indirectsymoff);
162 SwapValue(C.nindirectsyms);
163 SwapValue(C.extreloff);
164 SwapValue(C.nextrel);
165 SwapValue(C.locreloff);
166 SwapValue(C.nlocrel);
170 void SwapStruct(MachO::linkedit_data_command &C) {
172 SwapValue(C.cmdsize);
173 SwapValue(C.dataoff);
174 SwapValue(C.datasize);
178 void SwapStruct(MachO::segment_command &C) {
180 SwapValue(C.cmdsize);
183 SwapValue(C.fileoff);
184 SwapValue(C.filesize);
185 SwapValue(C.maxprot);
186 SwapValue(C.initprot);
192 void SwapStruct(MachO::segment_command_64 &C) {
194 SwapValue(C.cmdsize);
197 SwapValue(C.fileoff);
198 SwapValue(C.filesize);
199 SwapValue(C.maxprot);
200 SwapValue(C.initprot);
206 void SwapStruct(uint32_t &C) {
211 void SwapStruct(MachO::linker_options_command &C) {
213 SwapValue(C.cmdsize);
218 void SwapStruct(MachO::version_min_command&C) {
220 SwapValue(C.cmdsize);
221 SwapValue(C.version);
222 SwapValue(C.reserved);
226 void SwapStruct(MachO::data_in_code_entry &C) {
233 T getStruct(const MachOObjectFile *O, const char *P) {
235 memcpy(&Cmd, P, sizeof(T));
236 if (O->isLittleEndian() != sys::IsLittleEndianHost)
242 getSegmentLoadCommandNumSections(const MachOObjectFile *O,
243 const MachOObjectFile::LoadCommandInfo &L) {
245 MachO::segment_command_64 S = O->getSegment64LoadCommand(L);
248 MachO::segment_command S = O->getSegmentLoadCommand(L);
253 getSectionPtr(const MachOObjectFile *O, MachOObjectFile::LoadCommandInfo L,
255 uintptr_t CommandAddr = reinterpret_cast<uintptr_t>(L.Ptr);
257 bool Is64 = O->is64Bit();
258 unsigned SegmentLoadSize = Is64 ? sizeof(MachO::segment_command_64) :
259 sizeof(MachO::segment_command);
260 unsigned SectionSize = Is64 ? sizeof(MachO::section_64) :
261 sizeof(MachO::section);
263 uintptr_t SectionAddr = CommandAddr + SegmentLoadSize + Sec * SectionSize;
264 return reinterpret_cast<const char*>(SectionAddr);
267 static const char *getPtr(const MachOObjectFile *O, size_t Offset) {
268 return O->getData().substr(Offset, 1).data();
272 getSymbolTableEntryBase(const MachOObjectFile *O, DataRefImpl DRI) {
273 const char *P = reinterpret_cast<const char *>(DRI.p);
274 return getStruct<nlist_base>(O, P);
277 static StringRef parseSegmentOrSectionName(const char *P) {
281 // Not null terminated, so this is a 16 char string.
282 return StringRef(P, 16);
285 // Helper to advance a section or symbol iterator multiple increments at a time.
287 static void advance(T &it, size_t Val) {
292 static unsigned getCPUType(const MachOObjectFile *O) {
293 return O->getHeader().cputype;
296 static void printRelocationTargetName(const MachOObjectFile *O,
297 const MachO::any_relocation_info &RE,
298 raw_string_ostream &fmt) {
299 bool IsScattered = O->isRelocationScattered(RE);
301 // Target of a scattered relocation is an address. In the interest of
302 // generating pretty output, scan through the symbol table looking for a
303 // symbol that aligns with that address. If we find one, print it.
304 // Otherwise, we just print the hex address of the target.
306 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
308 for (const SymbolRef &Symbol : O->symbols()) {
313 if ((ec = Symbol.getAddress(Addr)))
314 report_fatal_error(ec.message());
317 if ((ec = Symbol.getName(Name)))
318 report_fatal_error(ec.message());
323 // If we couldn't find a symbol that this relocation refers to, try
324 // to find a section beginning instead.
325 for (const SectionRef &Section : O->sections()) {
330 if ((ec = Section.getAddress(Addr)))
331 report_fatal_error(ec.message());
334 if ((ec = Section.getName(Name)))
335 report_fatal_error(ec.message());
340 fmt << format("0x%x", Val);
345 bool isExtern = O->getPlainRelocationExternal(RE);
346 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
349 symbol_iterator SI = O->symbol_begin();
353 section_iterator SI = O->section_begin();
354 // Adjust for the fact that sections are 1-indexed.
355 advance(SI, Val - 1);
363 getPlainRelocationAddress(const MachO::any_relocation_info &RE) {
368 getScatteredRelocationAddress(const MachO::any_relocation_info &RE) {
369 return RE.r_word0 & 0xffffff;
372 static bool getPlainRelocationPCRel(const MachOObjectFile *O,
373 const MachO::any_relocation_info &RE) {
374 if (O->isLittleEndian())
375 return (RE.r_word1 >> 24) & 1;
376 return (RE.r_word1 >> 7) & 1;
380 getScatteredRelocationPCRel(const MachOObjectFile *O,
381 const MachO::any_relocation_info &RE) {
382 return (RE.r_word0 >> 30) & 1;
385 static unsigned getPlainRelocationLength(const MachOObjectFile *O,
386 const MachO::any_relocation_info &RE) {
387 if (O->isLittleEndian())
388 return (RE.r_word1 >> 25) & 3;
389 return (RE.r_word1 >> 5) & 3;
393 getScatteredRelocationLength(const MachO::any_relocation_info &RE) {
394 return (RE.r_word0 >> 28) & 3;
397 static unsigned getPlainRelocationType(const MachOObjectFile *O,
398 const MachO::any_relocation_info &RE) {
399 if (O->isLittleEndian())
400 return RE.r_word1 >> 28;
401 return RE.r_word1 & 0xf;
405 getScatteredRelocationType(const MachO::any_relocation_info &RE) {
406 return (RE.r_word0 >> 24) & 0xf;
409 static uint32_t getSectionFlags(const MachOObjectFile *O,
412 MachO::section_64 Sect = O->getSection64(Sec);
415 MachO::section Sect = O->getSection(Sec);
419 MachOObjectFile::MachOObjectFile(MemoryBuffer *Object, bool IsLittleEndian,
420 bool Is64bits, error_code &EC,
422 : ObjectFile(getMachOType(IsLittleEndian, Is64bits), Object, BufferOwned),
423 SymtabLoadCmd(NULL), DysymtabLoadCmd(NULL), DataInCodeLoadCmd(NULL) {
424 uint32_t LoadCommandCount = this->getHeader().ncmds;
425 MachO::LoadCommandType SegmentLoadType = is64Bit() ?
426 MachO::LC_SEGMENT_64 : MachO::LC_SEGMENT;
428 MachOObjectFile::LoadCommandInfo Load = getFirstLoadCommandInfo();
429 for (unsigned I = 0; ; ++I) {
430 if (Load.C.cmd == MachO::LC_SYMTAB) {
431 assert(!SymtabLoadCmd && "Multiple symbol tables");
432 SymtabLoadCmd = Load.Ptr;
433 } else if (Load.C.cmd == MachO::LC_DYSYMTAB) {
434 assert(!DysymtabLoadCmd && "Multiple dynamic symbol tables");
435 DysymtabLoadCmd = Load.Ptr;
436 } else if (Load.C.cmd == MachO::LC_DATA_IN_CODE) {
437 assert(!DataInCodeLoadCmd && "Multiple data in code tables");
438 DataInCodeLoadCmd = Load.Ptr;
439 } else if (Load.C.cmd == SegmentLoadType) {
440 uint32_t NumSections = getSegmentLoadCommandNumSections(this, Load);
441 for (unsigned J = 0; J < NumSections; ++J) {
442 const char *Sec = getSectionPtr(this, Load, J);
443 Sections.push_back(Sec);
447 if (I == LoadCommandCount - 1)
450 Load = getNextLoadCommandInfo(Load);
454 void MachOObjectFile::moveSymbolNext(DataRefImpl &Symb) const {
455 unsigned SymbolTableEntrySize = is64Bit() ?
456 sizeof(MachO::nlist_64) :
457 sizeof(MachO::nlist);
458 Symb.p += SymbolTableEntrySize;
461 error_code MachOObjectFile::getSymbolName(DataRefImpl Symb,
462 StringRef &Res) const {
463 StringRef StringTable = getStringTableData();
464 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
465 const char *Start = &StringTable.data()[Entry.n_strx];
466 Res = StringRef(Start);
467 return object_error::success;
470 error_code MachOObjectFile::getSymbolAddress(DataRefImpl Symb,
471 uint64_t &Res) const {
473 MachO::nlist_64 Entry = getSymbol64TableEntry(Symb);
476 MachO::nlist Entry = getSymbolTableEntry(Symb);
479 return object_error::success;
482 error_code MachOObjectFile::getSymbolAlignment(DataRefImpl DRI,
483 uint32_t &Result) const {
484 uint32_t flags = getSymbolFlags(DRI);
485 if (flags & SymbolRef::SF_Common) {
486 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
487 Result = 1 << MachO::GET_COMM_ALIGN(Entry.n_desc);
491 return object_error::success;
494 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
495 uint64_t &Result) const {
496 uint64_t BeginOffset;
497 uint64_t EndOffset = 0;
498 uint8_t SectionIndex;
500 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
502 getSymbolAddress(DRI, Value);
506 SectionIndex = Entry.n_sect;
508 uint32_t flags = getSymbolFlags(DRI);
509 if (flags & SymbolRef::SF_Common)
512 Result = UnknownAddressOrSize;
513 return object_error::success;
515 // Unfortunately symbols are unsorted so we need to touch all
516 // symbols from load command
517 for (const SymbolRef &Symbol : symbols()) {
518 DataRefImpl DRI = Symbol.getRawDataRefImpl();
519 Entry = getSymbolTableEntryBase(this, DRI);
520 getSymbolAddress(DRI, Value);
521 if (Entry.n_sect == SectionIndex && Value > BeginOffset)
522 if (!EndOffset || Value < EndOffset)
528 Sec.d.a = SectionIndex-1;
529 getSectionSize(Sec, Size);
530 getSectionAddress(Sec, EndOffset);
533 Result = EndOffset - BeginOffset;
534 return object_error::success;
537 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
538 SymbolRef::Type &Res) const {
539 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
540 uint8_t n_type = Entry.n_type;
542 Res = SymbolRef::ST_Other;
544 // If this is a STAB debugging symbol, we can do nothing more.
545 if (n_type & MachO::N_STAB) {
546 Res = SymbolRef::ST_Debug;
547 return object_error::success;
550 switch (n_type & MachO::N_TYPE) {
552 Res = SymbolRef::ST_Unknown;
555 Res = SymbolRef::ST_Function;
558 return object_error::success;
561 uint32_t MachOObjectFile::getSymbolFlags(DataRefImpl DRI) const {
562 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
564 uint8_t MachOType = Entry.n_type;
565 uint16_t MachOFlags = Entry.n_desc;
567 uint32_t Result = SymbolRef::SF_None;
569 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF)
570 Result |= SymbolRef::SF_Undefined;
572 if (MachOType & MachO::N_STAB)
573 Result |= SymbolRef::SF_FormatSpecific;
575 if (MachOType & MachO::N_EXT) {
576 Result |= SymbolRef::SF_Global;
577 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF) {
579 getSymbolAddress(DRI, Value);
581 Result |= SymbolRef::SF_Common;
585 if (MachOFlags & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
586 Result |= SymbolRef::SF_Weak;
588 if ((MachOType & MachO::N_TYPE) == MachO::N_ABS)
589 Result |= SymbolRef::SF_Absolute;
595 MachOObjectFile::getSymbolSection(DataRefImpl Symb,
596 section_iterator &Res) const {
597 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
598 uint8_t index = Entry.n_sect;
605 Res = section_iterator(SectionRef(DRI, this));
608 return object_error::success;
611 void MachOObjectFile::moveSectionNext(DataRefImpl &Sec) const {
616 MachOObjectFile::getSectionName(DataRefImpl Sec, StringRef &Result) const {
617 ArrayRef<char> Raw = getSectionRawName(Sec);
618 Result = parseSegmentOrSectionName(Raw.data());
619 return object_error::success;
623 MachOObjectFile::getSectionAddress(DataRefImpl Sec, uint64_t &Res) const {
625 MachO::section_64 Sect = getSection64(Sec);
628 MachO::section Sect = getSection(Sec);
631 return object_error::success;
635 MachOObjectFile::getSectionSize(DataRefImpl Sec, uint64_t &Res) const {
637 MachO::section_64 Sect = getSection64(Sec);
640 MachO::section Sect = getSection(Sec);
644 return object_error::success;
648 MachOObjectFile::getSectionContents(DataRefImpl Sec, StringRef &Res) const {
653 MachO::section_64 Sect = getSection64(Sec);
654 Offset = Sect.offset;
657 MachO::section Sect = getSection(Sec);
658 Offset = Sect.offset;
662 Res = this->getData().substr(Offset, Size);
663 return object_error::success;
667 MachOObjectFile::getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const {
670 MachO::section_64 Sect = getSection64(Sec);
673 MachO::section Sect = getSection(Sec);
677 Res = uint64_t(1) << Align;
678 return object_error::success;
682 MachOObjectFile::isSectionText(DataRefImpl Sec, bool &Res) const {
683 uint32_t Flags = getSectionFlags(this, Sec);
684 Res = Flags & MachO::S_ATTR_PURE_INSTRUCTIONS;
685 return object_error::success;
688 error_code MachOObjectFile::isSectionData(DataRefImpl DRI, bool &Result) const {
689 // FIXME: Unimplemented.
691 return object_error::success;
694 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI, bool &Result) const {
695 // FIXME: Unimplemented.
697 return object_error::success;
701 MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
702 bool &Result) const {
703 // FIXME: Unimplemented.
705 return object_error::success;
708 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
709 bool &Result) const {
710 // FIXME: Unimplemented.
712 return object_error::success;
716 MachOObjectFile::isSectionZeroInit(DataRefImpl Sec, bool &Res) const {
717 uint32_t Flags = getSectionFlags(this, Sec);
718 unsigned SectionType = Flags & MachO::SECTION_TYPE;
719 Res = SectionType == MachO::S_ZEROFILL ||
720 SectionType == MachO::S_GB_ZEROFILL;
721 return object_error::success;
724 error_code MachOObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
725 bool &Result) const {
726 // Consider using the code from isSectionText to look for __const sections.
727 // Alternately, emit S_ATTR_PURE_INSTRUCTIONS and/or S_ATTR_SOME_INSTRUCTIONS
728 // to use section attributes to distinguish code from data.
730 // FIXME: Unimplemented.
732 return object_error::success;
736 MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
737 bool &Result) const {
739 this->getSymbolType(Symb, ST);
740 if (ST == SymbolRef::ST_Unknown) {
742 return object_error::success;
745 uint64_t SectBegin, SectEnd;
746 getSectionAddress(Sec, SectBegin);
747 getSectionSize(Sec, SectEnd);
748 SectEnd += SectBegin;
751 getSymbolAddress(Symb, SymAddr);
752 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
754 return object_error::success;
757 relocation_iterator MachOObjectFile::section_rel_begin(DataRefImpl Sec) const {
761 return relocation_iterator(RelocationRef(Ret, this));
765 MachOObjectFile::section_rel_end(DataRefImpl Sec) const {
768 MachO::section_64 Sect = getSection64(Sec);
771 MachO::section Sect = getSection(Sec);
778 return relocation_iterator(RelocationRef(Ret, this));
781 void MachOObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
786 MachOObjectFile::getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const {
787 report_fatal_error("getRelocationAddress not implemented in MachOObjectFile");
790 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
791 uint64_t &Res) const {
792 MachO::any_relocation_info RE = getRelocation(Rel);
793 Res = getAnyRelocationAddress(RE);
794 return object_error::success;
798 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
799 MachO::any_relocation_info RE = getRelocation(Rel);
800 uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
801 bool isExtern = getPlainRelocationExternal(RE);
805 MachO::symtab_command S = getSymtabLoadCommand();
806 unsigned SymbolTableEntrySize = is64Bit() ?
807 sizeof(MachO::nlist_64) :
808 sizeof(MachO::nlist);
809 uint64_t Offset = S.symoff + SymbolIdx * SymbolTableEntrySize;
811 Sym.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
812 return symbol_iterator(SymbolRef(Sym, this));
815 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
816 uint64_t &Res) const {
817 MachO::any_relocation_info RE = getRelocation(Rel);
818 Res = getAnyRelocationType(RE);
819 return object_error::success;
823 MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
824 SmallVectorImpl<char> &Result) const {
827 getRelocationType(Rel, RType);
829 unsigned Arch = this->getArch();
833 static const char *const Table[] = {
834 "GENERIC_RELOC_VANILLA",
835 "GENERIC_RELOC_PAIR",
836 "GENERIC_RELOC_SECTDIFF",
837 "GENERIC_RELOC_PB_LA_PTR",
838 "GENERIC_RELOC_LOCAL_SECTDIFF",
839 "GENERIC_RELOC_TLV" };
847 case Triple::x86_64: {
848 static const char *const Table[] = {
849 "X86_64_RELOC_UNSIGNED",
850 "X86_64_RELOC_SIGNED",
851 "X86_64_RELOC_BRANCH",
852 "X86_64_RELOC_GOT_LOAD",
854 "X86_64_RELOC_SUBTRACTOR",
855 "X86_64_RELOC_SIGNED_1",
856 "X86_64_RELOC_SIGNED_2",
857 "X86_64_RELOC_SIGNED_4",
858 "X86_64_RELOC_TLV" };
867 static const char *const Table[] = {
870 "ARM_RELOC_SECTDIFF",
871 "ARM_RELOC_LOCAL_SECTDIFF",
872 "ARM_RELOC_PB_LA_PTR",
874 "ARM_THUMB_RELOC_BR22",
875 "ARM_THUMB_32BIT_BRANCH",
877 "ARM_RELOC_HALF_SECTDIFF" };
886 case Triple::aarch64: {
887 static const char *const Table[] = {
888 "ARM64_RELOC_UNSIGNED", "ARM64_RELOC_SUBTRACTOR",
889 "ARM64_RELOC_BRANCH26", "ARM64_RELOC_PAGE21",
890 "ARM64_RELOC_PAGEOFF12", "ARM64_RELOC_GOT_LOAD_PAGE21",
891 "ARM64_RELOC_GOT_LOAD_PAGEOFF12", "ARM64_RELOC_POINTER_TO_GOT",
892 "ARM64_RELOC_TLVP_LOAD_PAGE21", "ARM64_RELOC_TLVP_LOAD_PAGEOFF12",
896 if (RType >= array_lengthof(Table))
903 static const char *const Table[] = {
912 "PPC_RELOC_SECTDIFF",
913 "PPC_RELOC_PB_LA_PTR",
914 "PPC_RELOC_HI16_SECTDIFF",
915 "PPC_RELOC_LO16_SECTDIFF",
916 "PPC_RELOC_HA16_SECTDIFF",
918 "PPC_RELOC_LO14_SECTDIFF",
919 "PPC_RELOC_LOCAL_SECTDIFF" };
927 case Triple::UnknownArch:
931 Result.append(res.begin(), res.end());
932 return object_error::success;
936 MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
937 SmallVectorImpl<char> &Result) const {
938 MachO::any_relocation_info RE = getRelocation(Rel);
940 unsigned Arch = this->getArch();
943 raw_string_ostream fmt(fmtbuf);
944 unsigned Type = this->getAnyRelocationType(RE);
945 bool IsPCRel = this->getAnyRelocationPCRel(RE);
947 // Determine any addends that should be displayed with the relocation.
948 // These require decoding the relocation type, which is triple-specific.
950 // X86_64 has entirely custom relocation types.
951 if (Arch == Triple::x86_64) {
952 bool isPCRel = getAnyRelocationPCRel(RE);
955 case MachO::X86_64_RELOC_GOT_LOAD:
956 case MachO::X86_64_RELOC_GOT: {
957 printRelocationTargetName(this, RE, fmt);
959 if (isPCRel) fmt << "PCREL";
962 case MachO::X86_64_RELOC_SUBTRACTOR: {
963 DataRefImpl RelNext = Rel;
964 moveRelocationNext(RelNext);
965 MachO::any_relocation_info RENext = getRelocation(RelNext);
967 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
968 // X86_64_RELOC_UNSIGNED.
969 // NOTE: Scattered relocations don't exist on x86_64.
970 unsigned RType = getAnyRelocationType(RENext);
971 if (RType != MachO::X86_64_RELOC_UNSIGNED)
972 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
973 "X86_64_RELOC_SUBTRACTOR.");
975 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
976 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
977 printRelocationTargetName(this, RENext, fmt);
979 printRelocationTargetName(this, RE, fmt);
982 case MachO::X86_64_RELOC_TLV:
983 printRelocationTargetName(this, RE, fmt);
985 if (isPCRel) fmt << "P";
987 case MachO::X86_64_RELOC_SIGNED_1:
988 printRelocationTargetName(this, RE, fmt);
991 case MachO::X86_64_RELOC_SIGNED_2:
992 printRelocationTargetName(this, RE, fmt);
995 case MachO::X86_64_RELOC_SIGNED_4:
996 printRelocationTargetName(this, RE, fmt);
1000 printRelocationTargetName(this, RE, fmt);
1003 // X86 and ARM share some relocation types in common.
1004 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
1005 Arch == Triple::ppc) {
1006 // Generic relocation types...
1008 case MachO::GENERIC_RELOC_PAIR: // prints no info
1009 return object_error::success;
1010 case MachO::GENERIC_RELOC_SECTDIFF: {
1011 DataRefImpl RelNext = Rel;
1012 moveRelocationNext(RelNext);
1013 MachO::any_relocation_info RENext = getRelocation(RelNext);
1015 // X86 sect diff's must be followed by a relocation of type
1016 // GENERIC_RELOC_PAIR.
1017 unsigned RType = getAnyRelocationType(RENext);
1019 if (RType != MachO::GENERIC_RELOC_PAIR)
1020 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1021 "GENERIC_RELOC_SECTDIFF.");
1023 printRelocationTargetName(this, RE, fmt);
1025 printRelocationTargetName(this, RENext, fmt);
1030 if (Arch == Triple::x86 || Arch == Triple::ppc) {
1032 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
1033 DataRefImpl RelNext = Rel;
1034 moveRelocationNext(RelNext);
1035 MachO::any_relocation_info RENext = getRelocation(RelNext);
1037 // X86 sect diff's must be followed by a relocation of type
1038 // GENERIC_RELOC_PAIR.
1039 unsigned RType = getAnyRelocationType(RENext);
1040 if (RType != MachO::GENERIC_RELOC_PAIR)
1041 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1042 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1044 printRelocationTargetName(this, RE, fmt);
1046 printRelocationTargetName(this, RENext, fmt);
1049 case MachO::GENERIC_RELOC_TLV: {
1050 printRelocationTargetName(this, RE, fmt);
1052 if (IsPCRel) fmt << "P";
1056 printRelocationTargetName(this, RE, fmt);
1058 } else { // ARM-specific relocations
1060 case MachO::ARM_RELOC_HALF:
1061 case MachO::ARM_RELOC_HALF_SECTDIFF: {
1062 // Half relocations steal a bit from the length field to encode
1063 // whether this is an upper16 or a lower16 relocation.
1064 bool isUpper = getAnyRelocationLength(RE) >> 1;
1067 fmt << ":upper16:(";
1069 fmt << ":lower16:(";
1070 printRelocationTargetName(this, RE, fmt);
1072 DataRefImpl RelNext = Rel;
1073 moveRelocationNext(RelNext);
1074 MachO::any_relocation_info RENext = getRelocation(RelNext);
1076 // ARM half relocs must be followed by a relocation of type
1078 unsigned RType = getAnyRelocationType(RENext);
1079 if (RType != MachO::ARM_RELOC_PAIR)
1080 report_fatal_error("Expected ARM_RELOC_PAIR after "
1083 // NOTE: The half of the target virtual address is stashed in the
1084 // address field of the secondary relocation, but we can't reverse
1085 // engineer the constant offset from it without decoding the movw/movt
1086 // instruction to find the other half in its immediate field.
1088 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1089 // symbol/section pointer of the follow-on relocation.
1090 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
1092 printRelocationTargetName(this, RENext, fmt);
1099 printRelocationTargetName(this, RE, fmt);
1104 printRelocationTargetName(this, RE, fmt);
1107 Result.append(fmtbuf.begin(), fmtbuf.end());
1108 return object_error::success;
1112 MachOObjectFile::getRelocationHidden(DataRefImpl Rel, bool &Result) const {
1113 unsigned Arch = getArch();
1115 getRelocationType(Rel, Type);
1119 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1120 // is always hidden.
1121 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
1122 if (Type == MachO::GENERIC_RELOC_PAIR) Result = true;
1123 } else if (Arch == Triple::x86_64) {
1124 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1125 // an X86_64_RELOC_SUBTRACTOR.
1126 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
1127 DataRefImpl RelPrev = Rel;
1130 getRelocationType(RelPrev, PrevType);
1131 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
1136 return object_error::success;
1139 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1140 LibraryRef &Res) const {
1141 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1144 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1145 StringRef &Res) const {
1146 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1149 basic_symbol_iterator MachOObjectFile::symbol_begin_impl() const {
1152 return basic_symbol_iterator(SymbolRef(DRI, this));
1154 MachO::symtab_command Symtab = getSymtabLoadCommand();
1155 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Symtab.symoff));
1156 return basic_symbol_iterator(SymbolRef(DRI, this));
1159 basic_symbol_iterator MachOObjectFile::symbol_end_impl() const {
1162 return basic_symbol_iterator(SymbolRef(DRI, this));
1164 MachO::symtab_command Symtab = getSymtabLoadCommand();
1165 unsigned SymbolTableEntrySize = is64Bit() ?
1166 sizeof(MachO::nlist_64) :
1167 sizeof(MachO::nlist);
1168 unsigned Offset = Symtab.symoff +
1169 Symtab.nsyms * SymbolTableEntrySize;
1170 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1171 return basic_symbol_iterator(SymbolRef(DRI, this));
1174 section_iterator MachOObjectFile::section_begin() const {
1176 return section_iterator(SectionRef(DRI, this));
1179 section_iterator MachOObjectFile::section_end() const {
1181 DRI.d.a = Sections.size();
1182 return section_iterator(SectionRef(DRI, this));
1185 library_iterator MachOObjectFile::needed_library_begin() const {
1187 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1190 library_iterator MachOObjectFile::needed_library_end() const {
1192 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1195 uint8_t MachOObjectFile::getBytesInAddress() const {
1196 return is64Bit() ? 8 : 4;
1199 StringRef MachOObjectFile::getFileFormatName() const {
1200 unsigned CPUType = getCPUType(this);
1203 case llvm::MachO::CPU_TYPE_I386:
1204 return "Mach-O 32-bit i386";
1205 case llvm::MachO::CPU_TYPE_ARM:
1206 return "Mach-O arm";
1207 case llvm::MachO::CPU_TYPE_POWERPC:
1208 return "Mach-O 32-bit ppc";
1210 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64) == 0 &&
1211 "64-bit object file when we're not 64-bit?");
1212 return "Mach-O 32-bit unknown";
1216 // Make sure the cpu type has the correct mask.
1217 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64)
1218 == llvm::MachO::CPU_ARCH_ABI64 &&
1219 "32-bit object file when we're 64-bit?");
1222 case llvm::MachO::CPU_TYPE_X86_64:
1223 return "Mach-O 64-bit x86-64";
1224 case llvm::MachO::CPU_TYPE_ARM64:
1225 return "Mach-O arm64";
1226 case llvm::MachO::CPU_TYPE_POWERPC64:
1227 return "Mach-O 64-bit ppc64";
1229 return "Mach-O 64-bit unknown";
1233 Triple::ArchType MachOObjectFile::getArch(uint32_t CPUType) {
1235 case llvm::MachO::CPU_TYPE_I386:
1237 case llvm::MachO::CPU_TYPE_X86_64:
1238 return Triple::x86_64;
1239 case llvm::MachO::CPU_TYPE_ARM:
1241 case llvm::MachO::CPU_TYPE_ARM64:
1242 return Triple::arm64;
1243 case llvm::MachO::CPU_TYPE_POWERPC:
1245 case llvm::MachO::CPU_TYPE_POWERPC64:
1246 return Triple::ppc64;
1248 return Triple::UnknownArch;
1252 unsigned MachOObjectFile::getArch() const {
1253 return getArch(getCPUType(this));
1256 StringRef MachOObjectFile::getLoadName() const {
1258 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
1261 relocation_iterator MachOObjectFile::section_rel_begin(unsigned Index) const {
1264 return section_rel_begin(DRI);
1267 relocation_iterator MachOObjectFile::section_rel_end(unsigned Index) const {
1270 return section_rel_end(DRI);
1273 dice_iterator MachOObjectFile::begin_dices() const {
1275 if (!DataInCodeLoadCmd)
1276 return dice_iterator(DiceRef(DRI, this));
1278 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1279 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, DicLC.dataoff));
1280 return dice_iterator(DiceRef(DRI, this));
1283 dice_iterator MachOObjectFile::end_dices() const {
1285 if (!DataInCodeLoadCmd)
1286 return dice_iterator(DiceRef(DRI, this));
1288 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1289 unsigned Offset = DicLC.dataoff + DicLC.datasize;
1290 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1291 return dice_iterator(DiceRef(DRI, this));
1295 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
1296 ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
1297 return parseSegmentOrSectionName(Raw.data());
1301 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
1302 const section_base *Base =
1303 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1304 return ArrayRef<char>(Base->sectname);
1308 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
1309 const section_base *Base =
1310 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1311 return ArrayRef<char>(Base->segname);
1315 MachOObjectFile::isRelocationScattered(const MachO::any_relocation_info &RE)
1317 if (getCPUType(this) == MachO::CPU_TYPE_X86_64)
1319 return getPlainRelocationAddress(RE) & MachO::R_SCATTERED;
1322 unsigned MachOObjectFile::getPlainRelocationSymbolNum(
1323 const MachO::any_relocation_info &RE) const {
1324 if (isLittleEndian())
1325 return RE.r_word1 & 0xffffff;
1326 return RE.r_word1 >> 8;
1329 bool MachOObjectFile::getPlainRelocationExternal(
1330 const MachO::any_relocation_info &RE) const {
1331 if (isLittleEndian())
1332 return (RE.r_word1 >> 27) & 1;
1333 return (RE.r_word1 >> 4) & 1;
1336 bool MachOObjectFile::getScatteredRelocationScattered(
1337 const MachO::any_relocation_info &RE) const {
1338 return RE.r_word0 >> 31;
1341 uint32_t MachOObjectFile::getScatteredRelocationValue(
1342 const MachO::any_relocation_info &RE) const {
1346 unsigned MachOObjectFile::getAnyRelocationAddress(
1347 const MachO::any_relocation_info &RE) const {
1348 if (isRelocationScattered(RE))
1349 return getScatteredRelocationAddress(RE);
1350 return getPlainRelocationAddress(RE);
1353 unsigned MachOObjectFile::getAnyRelocationPCRel(
1354 const MachO::any_relocation_info &RE) const {
1355 if (isRelocationScattered(RE))
1356 return getScatteredRelocationPCRel(this, RE);
1357 return getPlainRelocationPCRel(this, RE);
1360 unsigned MachOObjectFile::getAnyRelocationLength(
1361 const MachO::any_relocation_info &RE) const {
1362 if (isRelocationScattered(RE))
1363 return getScatteredRelocationLength(RE);
1364 return getPlainRelocationLength(this, RE);
1368 MachOObjectFile::getAnyRelocationType(
1369 const MachO::any_relocation_info &RE) const {
1370 if (isRelocationScattered(RE))
1371 return getScatteredRelocationType(RE);
1372 return getPlainRelocationType(this, RE);
1376 MachOObjectFile::getRelocationSection(
1377 const MachO::any_relocation_info &RE) const {
1378 if (isRelocationScattered(RE) || getPlainRelocationExternal(RE))
1379 return *section_end();
1380 unsigned SecNum = getPlainRelocationSymbolNum(RE) - 1;
1383 return SectionRef(DRI, this);
1386 MachOObjectFile::LoadCommandInfo
1387 MachOObjectFile::getFirstLoadCommandInfo() const {
1388 MachOObjectFile::LoadCommandInfo Load;
1390 unsigned HeaderSize = is64Bit() ? sizeof(MachO::mach_header_64) :
1391 sizeof(MachO::mach_header);
1392 Load.Ptr = getPtr(this, HeaderSize);
1393 Load.C = getStruct<MachO::load_command>(this, Load.Ptr);
1397 MachOObjectFile::LoadCommandInfo
1398 MachOObjectFile::getNextLoadCommandInfo(const LoadCommandInfo &L) const {
1399 MachOObjectFile::LoadCommandInfo Next;
1400 Next.Ptr = L.Ptr + L.C.cmdsize;
1401 Next.C = getStruct<MachO::load_command>(this, Next.Ptr);
1405 MachO::section MachOObjectFile::getSection(DataRefImpl DRI) const {
1406 return getStruct<MachO::section>(this, Sections[DRI.d.a]);
1409 MachO::section_64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
1410 return getStruct<MachO::section_64>(this, Sections[DRI.d.a]);
1413 MachO::section MachOObjectFile::getSection(const LoadCommandInfo &L,
1414 unsigned Index) const {
1415 const char *Sec = getSectionPtr(this, L, Index);
1416 return getStruct<MachO::section>(this, Sec);
1419 MachO::section_64 MachOObjectFile::getSection64(const LoadCommandInfo &L,
1420 unsigned Index) const {
1421 const char *Sec = getSectionPtr(this, L, Index);
1422 return getStruct<MachO::section_64>(this, Sec);
1426 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
1427 const char *P = reinterpret_cast<const char *>(DRI.p);
1428 return getStruct<MachO::nlist>(this, P);
1432 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
1433 const char *P = reinterpret_cast<const char *>(DRI.p);
1434 return getStruct<MachO::nlist_64>(this, P);
1437 MachO::linkedit_data_command
1438 MachOObjectFile::getLinkeditDataLoadCommand(const LoadCommandInfo &L) const {
1439 return getStruct<MachO::linkedit_data_command>(this, L.Ptr);
1442 MachO::segment_command
1443 MachOObjectFile::getSegmentLoadCommand(const LoadCommandInfo &L) const {
1444 return getStruct<MachO::segment_command>(this, L.Ptr);
1447 MachO::segment_command_64
1448 MachOObjectFile::getSegment64LoadCommand(const LoadCommandInfo &L) const {
1449 return getStruct<MachO::segment_command_64>(this, L.Ptr);
1452 MachO::linker_options_command
1453 MachOObjectFile::getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const {
1454 return getStruct<MachO::linker_options_command>(this, L.Ptr);
1457 MachO::version_min_command
1458 MachOObjectFile::getVersionMinLoadCommand(const LoadCommandInfo &L) const {
1459 return getStruct<MachO::version_min_command>(this, L.Ptr);
1462 MachO::any_relocation_info
1463 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
1468 MachO::section_64 Sect = getSection64(Sec);
1469 Offset = Sect.reloff;
1471 MachO::section Sect = getSection(Sec);
1472 Offset = Sect.reloff;
1475 auto P = reinterpret_cast<const MachO::any_relocation_info *>(
1476 getPtr(this, Offset)) + Rel.d.b;
1477 return getStruct<MachO::any_relocation_info>(
1478 this, reinterpret_cast<const char *>(P));
1481 MachO::data_in_code_entry
1482 MachOObjectFile::getDice(DataRefImpl Rel) const {
1483 const char *P = reinterpret_cast<const char *>(Rel.p);
1484 return getStruct<MachO::data_in_code_entry>(this, P);
1487 MachO::mach_header MachOObjectFile::getHeader() const {
1488 return getStruct<MachO::mach_header>(this, getPtr(this, 0));
1491 MachO::mach_header_64 MachOObjectFile::getHeader64() const {
1492 return getStruct<MachO::mach_header_64>(this, getPtr(this, 0));
1495 uint32_t MachOObjectFile::getIndirectSymbolTableEntry(
1496 const MachO::dysymtab_command &DLC,
1497 unsigned Index) const {
1498 uint64_t Offset = DLC.indirectsymoff + Index * sizeof(uint32_t);
1499 return getStruct<uint32_t>(this, getPtr(this, Offset));
1502 MachO::data_in_code_entry
1503 MachOObjectFile::getDataInCodeTableEntry(uint32_t DataOffset,
1504 unsigned Index) const {
1505 uint64_t Offset = DataOffset + Index * sizeof(MachO::data_in_code_entry);
1506 return getStruct<MachO::data_in_code_entry>(this, getPtr(this, Offset));
1509 MachO::symtab_command MachOObjectFile::getSymtabLoadCommand() const {
1510 return getStruct<MachO::symtab_command>(this, SymtabLoadCmd);
1513 MachO::dysymtab_command MachOObjectFile::getDysymtabLoadCommand() const {
1514 return getStruct<MachO::dysymtab_command>(this, DysymtabLoadCmd);
1517 MachO::linkedit_data_command
1518 MachOObjectFile::getDataInCodeLoadCommand() const {
1519 if (DataInCodeLoadCmd)
1520 return getStruct<MachO::linkedit_data_command>(this, DataInCodeLoadCmd);
1522 // If there is no DataInCodeLoadCmd return a load command with zero'ed fields.
1523 MachO::linkedit_data_command Cmd;
1524 Cmd.cmd = MachO::LC_DATA_IN_CODE;
1525 Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
1531 StringRef MachOObjectFile::getStringTableData() const {
1532 MachO::symtab_command S = getSymtabLoadCommand();
1533 return getData().substr(S.stroff, S.strsize);
1536 bool MachOObjectFile::is64Bit() const {
1537 return getType() == getMachOType(false, true) ||
1538 getType() == getMachOType(true, true);
1541 void MachOObjectFile::ReadULEB128s(uint64_t Index,
1542 SmallVectorImpl<uint64_t> &Out) const {
1543 DataExtractor extractor(ObjectFile::getData(), true, 0);
1545 uint32_t offset = Index;
1547 while (uint64_t delta = extractor.getULEB128(&offset)) {
1549 Out.push_back(data);
1553 ErrorOr<ObjectFile *> ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer,
1555 StringRef Magic = Buffer->getBuffer().slice(0, 4);
1557 std::unique_ptr<MachOObjectFile> Ret;
1558 if (Magic == "\xFE\xED\xFA\xCE")
1559 Ret.reset(new MachOObjectFile(Buffer, false, false, EC, BufferOwned));
1560 else if (Magic == "\xCE\xFA\xED\xFE")
1561 Ret.reset(new MachOObjectFile(Buffer, true, false, EC, BufferOwned));
1562 else if (Magic == "\xFE\xED\xFA\xCF")
1563 Ret.reset(new MachOObjectFile(Buffer, false, true, EC, BufferOwned));
1564 else if (Magic == "\xCF\xFA\xED\xFE")
1565 Ret.reset(new MachOObjectFile(Buffer, true, true, EC, BufferOwned));
1568 return object_error::parse_failed;
1573 return Ret.release();
1576 } // end namespace object
1577 } // end namespace llvm