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/Triple.h"
17 #include "llvm/Object/MachOFormat.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"
27 using namespace object;
32 struct SymbolTableEntryBase {
45 static void SwapValue(T &Value) {
46 Value = sys::SwapByteOrder(Value);
50 static void SwapStruct(T &Value);
53 void SwapStruct(macho::RelocationEntry &H) {
59 void SwapStruct(macho::LoadCommand &L) {
65 void SwapStruct(SymbolTableEntryBase &S) {
66 SwapValue(S.StringIndex);
71 void SwapStruct(macho::Section &S) {
76 SwapValue(S.RelocationTableOffset);
77 SwapValue(S.NumRelocationTableEntries);
79 SwapValue(S.Reserved1);
80 SwapValue(S.Reserved2);
84 void SwapStruct(macho::Section64 &S) {
89 SwapValue(S.RelocationTableOffset);
90 SwapValue(S.NumRelocationTableEntries);
92 SwapValue(S.Reserved1);
93 SwapValue(S.Reserved2);
94 SwapValue(S.Reserved3);
98 void SwapStruct(macho::SymbolTableEntry &S) {
99 SwapValue(S.StringIndex);
105 void SwapStruct(macho::Symbol64TableEntry &S) {
106 SwapValue(S.StringIndex);
112 void SwapStruct(macho::Header &H) {
114 SwapValue(H.CPUType);
115 SwapValue(H.CPUSubtype);
116 SwapValue(H.FileType);
117 SwapValue(H.NumLoadCommands);
118 SwapValue(H.SizeOfLoadCommands);
123 void SwapStruct(macho::SymtabLoadCommand &C) {
126 SwapValue(C.SymbolTableOffset);
127 SwapValue(C.NumSymbolTableEntries);
128 SwapValue(C.StringTableOffset);
129 SwapValue(C.StringTableSize);
133 void SwapStruct(macho::LinkeditDataLoadCommand &C) {
136 SwapValue(C.DataOffset);
137 SwapValue(C.DataSize);
141 void SwapStruct(macho::SegmentLoadCommand &C) {
144 SwapValue(C.VMAddress);
146 SwapValue(C.FileOffset);
147 SwapValue(C.FileSize);
148 SwapValue(C.MaxVMProtection);
149 SwapValue(C.InitialVMProtection);
150 SwapValue(C.NumSections);
155 void SwapStruct(macho::Segment64LoadCommand &C) {
158 SwapValue(C.VMAddress);
160 SwapValue(C.FileOffset);
161 SwapValue(C.FileSize);
162 SwapValue(C.MaxVMProtection);
163 SwapValue(C.InitialVMProtection);
164 SwapValue(C.NumSections);
169 T getStruct(const MachOObjectFile *O, const char *P) {
171 memcpy(&Cmd, P, sizeof(T));
172 if (O->isLittleEndian() != sys::IsLittleEndianHost)
177 static macho::SegmentLoadCommand
178 getSegmentLoadCommand(const MachOObjectFile *O,
179 const MachOObjectFile::LoadCommandInfo &L) {
180 return getStruct<macho::SegmentLoadCommand>(O, L.Ptr);
183 static macho::Segment64LoadCommand
184 getSegment64LoadCommand(const MachOObjectFile *O,
185 const MachOObjectFile::LoadCommandInfo &L) {
186 return getStruct<macho::Segment64LoadCommand>(O, L.Ptr);
190 getSegmentLoadCommandNumSections(const MachOObjectFile *O,
191 const MachOObjectFile::LoadCommandInfo &L) {
193 macho::Segment64LoadCommand S = getSegment64LoadCommand(O, L);
194 return S.NumSections;
196 macho::SegmentLoadCommand S = getSegmentLoadCommand(O, L);
197 return S.NumSections;
200 static const SectionBase *
201 getSectionBase(const MachOObjectFile *O, MachOObjectFile::LoadCommandInfo L,
203 uintptr_t CommandAddr = reinterpret_cast<uintptr_t>(L.Ptr);
205 bool Is64 = O->is64Bit();
206 unsigned SegmentLoadSize = Is64 ? sizeof(macho::Segment64LoadCommand) :
207 sizeof(macho::SegmentLoadCommand);
208 unsigned SectionSize = Is64 ? sizeof(macho::Section64) :
209 sizeof(macho::Section);
211 uintptr_t SectionAddr = CommandAddr + SegmentLoadSize + Sec * SectionSize;
212 return reinterpret_cast<const SectionBase*>(SectionAddr);
215 static const char *getPtr(const MachOObjectFile *O, size_t Offset) {
216 return O->getData().substr(Offset, 1).data();
219 static SymbolTableEntryBase
220 getSymbolTableEntryBase(const MachOObjectFile *O, DataRefImpl DRI) {
221 const char *P = reinterpret_cast<const char *>(DRI.p);
222 return getStruct<SymbolTableEntryBase>(O, P);
225 static StringRef parseSegmentOrSectionName(const char *P) {
229 // Not null terminated, so this is a 16 char string.
230 return StringRef(P, 16);
233 // Helper to advance a section or symbol iterator multiple increments at a time.
235 static error_code advance(T &it, size_t Val) {
244 static void advanceTo(T &it, size_t Val) {
245 if (error_code ec = advance(it, Val))
246 report_fatal_error(ec.message());
249 static unsigned getCPUType(const MachOObjectFile *O) {
250 return O->getHeader().CPUType;
253 static void printRelocationTargetName(const MachOObjectFile *O,
254 const macho::RelocationEntry &RE,
255 raw_string_ostream &fmt) {
256 bool IsScattered = O->isRelocationScattered(RE);
258 // Target of a scattered relocation is an address. In the interest of
259 // generating pretty output, scan through the symbol table looking for a
260 // symbol that aligns with that address. If we find one, print it.
261 // Otherwise, we just print the hex address of the target.
263 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
266 for (symbol_iterator SI = O->begin_symbols(), SE = O->end_symbols();
267 SI != SE; SI.increment(ec)) {
268 if (ec) report_fatal_error(ec.message());
273 if ((ec = SI->getAddress(Addr)))
274 report_fatal_error(ec.message());
275 if (Addr != Val) continue;
276 if ((ec = SI->getName(Name)))
277 report_fatal_error(ec.message());
282 // If we couldn't find a symbol that this relocation refers to, try
283 // to find a section beginning instead.
284 for (section_iterator SI = O->begin_sections(), SE = O->end_sections();
285 SI != SE; SI.increment(ec)) {
286 if (ec) report_fatal_error(ec.message());
291 if ((ec = SI->getAddress(Addr)))
292 report_fatal_error(ec.message());
293 if (Addr != Val) continue;
294 if ((ec = SI->getName(Name)))
295 report_fatal_error(ec.message());
300 fmt << format("0x%x", Val);
305 bool isExtern = O->getPlainRelocationExternal(RE);
306 uint64_t Val = O->getAnyRelocationAddress(RE);
309 symbol_iterator SI = O->begin_symbols();
313 section_iterator SI = O->begin_sections();
321 static uint32_t getPlainRelocationAddress(const macho::RelocationEntry &RE) {
326 getScatteredRelocationAddress(const macho::RelocationEntry &RE) {
327 return RE.Word0 & 0xffffff;
330 static bool getPlainRelocationPCRel(const MachOObjectFile *O,
331 const macho::RelocationEntry &RE) {
332 if (O->isLittleEndian())
333 return (RE.Word1 >> 24) & 1;
334 return (RE.Word1 >> 7) & 1;
338 getScatteredRelocationPCRel(const MachOObjectFile *O,
339 const macho::RelocationEntry &RE) {
340 return (RE.Word0 >> 30) & 1;
343 static unsigned getPlainRelocationLength(const MachOObjectFile *O,
344 const macho::RelocationEntry &RE) {
345 if (O->isLittleEndian())
346 return (RE.Word1 >> 25) & 3;
347 return (RE.Word1 >> 5) & 3;
351 getScatteredRelocationLength(const macho::RelocationEntry &RE) {
352 return (RE.Word0 >> 28) & 3;
355 static unsigned getPlainRelocationType(const MachOObjectFile *O,
356 const macho::RelocationEntry &RE) {
357 if (O->isLittleEndian())
358 return RE.Word1 >> 28;
359 return RE.Word1 & 0xf;
362 static unsigned getScatteredRelocationType(const macho::RelocationEntry &RE) {
363 return (RE.Word0 >> 24) & 0xf;
366 static uint32_t getSectionFlags(const MachOObjectFile *O,
369 macho::Section64 Sect = O->getSection64(Sec);
372 macho::Section Sect = O->getSection(Sec);
376 MachOObjectFile::MachOObjectFile(MemoryBuffer *Object,
377 bool IsLittleEndian, bool Is64bits,
379 : ObjectFile(getMachOType(IsLittleEndian, Is64bits), Object),
380 SymtabLoadCmd(NULL) {
381 uint32_t LoadCommandCount = this->getHeader().NumLoadCommands;
382 macho::LoadCommandType SegmentLoadType = is64Bit() ?
383 macho::LCT_Segment64 : macho::LCT_Segment;
385 MachOObjectFile::LoadCommandInfo Load = getFirstLoadCommandInfo();
386 for (unsigned I = 0; ; ++I) {
387 if (Load.C.Type == macho::LCT_Symtab) {
388 assert(!SymtabLoadCmd && "Multiple symbol tables");
389 SymtabLoadCmd = Load.Ptr;
392 if (Load.C.Type == SegmentLoadType) {
393 uint32_t NumSections = getSegmentLoadCommandNumSections(this, Load);
394 for (unsigned J = 0; J < NumSections; ++J) {
395 const SectionBase *Sec = getSectionBase(this, Load, J);
396 Sections.push_back(reinterpret_cast<const char*>(Sec));
400 if (I == LoadCommandCount - 1)
403 Load = getNextLoadCommandInfo(Load);
407 error_code MachOObjectFile::getSymbolNext(DataRefImpl Symb,
408 SymbolRef &Res) const {
409 unsigned SymbolTableEntrySize = is64Bit() ?
410 sizeof(macho::Symbol64TableEntry) :
411 sizeof(macho::SymbolTableEntry);
412 Symb.p += SymbolTableEntrySize;
413 Res = SymbolRef(Symb, this);
414 return object_error::success;
417 error_code MachOObjectFile::getSymbolName(DataRefImpl Symb,
418 StringRef &Res) const {
419 macho::SymtabLoadCommand S = getSymtabLoadCommand();
420 const char *StringTable = getPtr(this, S.StringTableOffset);
421 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, Symb);
422 const char *Start = &StringTable[Entry.StringIndex];
423 Res = StringRef(Start);
424 return object_error::success;
427 error_code MachOObjectFile::getSymbolAddress(DataRefImpl Symb,
428 uint64_t &Res) const {
430 macho::Symbol64TableEntry Entry = getSymbol64TableEntry(Symb);
433 macho::SymbolTableEntry Entry = getSymbolTableEntry(Symb);
436 return object_error::success;
440 MachOObjectFile::getSymbolFileOffset(DataRefImpl Symb,
441 uint64_t &Res) const {
442 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, Symb);
443 getSymbolAddress(Symb, Res);
444 if (Entry.SectionIndex) {
447 SecRel.d.a = Entry.SectionIndex-1;
449 macho::Section64 Sec = getSection64(SecRel);
450 Delta = Sec.Offset - Sec.Address;
452 macho::Section Sec = getSection(SecRel);
453 Delta = Sec.Offset - Sec.Address;
459 return object_error::success;
462 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
463 uint64_t &Result) const {
464 uint64_t BeginOffset;
465 uint64_t EndOffset = 0;
466 uint8_t SectionIndex;
468 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, DRI);
470 getSymbolAddress(DRI, Value);
474 SectionIndex = Entry.SectionIndex;
476 uint32_t flags = SymbolRef::SF_None;
477 this->getSymbolFlags(DRI, flags);
478 if (flags & SymbolRef::SF_Common)
481 Result = UnknownAddressOrSize;
482 return object_error::success;
484 // Unfortunately symbols are unsorted so we need to touch all
485 // symbols from load command
487 for (symbol_iterator I = begin_symbols(), E = end_symbols(); I != E;
489 DataRefImpl DRI = I->getRawDataRefImpl();
490 Entry = getSymbolTableEntryBase(this, DRI);
491 getSymbolAddress(DRI, Value);
492 if (Entry.SectionIndex == SectionIndex && Value > BeginOffset)
493 if (!EndOffset || Value < EndOffset)
499 Sec.d.a = SectionIndex-1;
500 getSectionSize(Sec, Size);
501 getSectionAddress(Sec, EndOffset);
504 Result = EndOffset - BeginOffset;
505 return object_error::success;
508 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
509 SymbolRef::Type &Res) const {
510 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, Symb);
511 uint8_t n_type = Entry.Type;
513 Res = SymbolRef::ST_Other;
515 // If this is a STAB debugging symbol, we can do nothing more.
516 if (n_type & MachO::NlistMaskStab) {
517 Res = SymbolRef::ST_Debug;
518 return object_error::success;
521 switch (n_type & MachO::NlistMaskType) {
522 case MachO::NListTypeUndefined :
523 Res = SymbolRef::ST_Unknown;
525 case MachO::NListTypeSection :
526 Res = SymbolRef::ST_Function;
529 return object_error::success;
532 error_code MachOObjectFile::getSymbolNMTypeChar(DataRefImpl Symb,
534 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, Symb);
535 uint8_t Type = Entry.Type;
536 uint16_t Flags = Entry.Flags;
539 switch (Type & macho::STF_TypeMask) {
540 case macho::STT_Undefined:
543 case macho::STT_Absolute:
544 case macho::STT_Section:
552 if (Flags & (macho::STF_External | macho::STF_PrivateExtern))
553 Char = toupper(static_cast<unsigned char>(Char));
555 return object_error::success;
558 error_code MachOObjectFile::getSymbolFlags(DataRefImpl DRI,
559 uint32_t &Result) const {
560 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, DRI);
562 uint8_t MachOType = Entry.Type;
563 uint16_t MachOFlags = Entry.Flags;
565 // TODO: Correctly set SF_ThreadLocal
566 Result = SymbolRef::SF_None;
568 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeUndefined)
569 Result |= SymbolRef::SF_Undefined;
571 if (MachOFlags & macho::STF_StabsEntryMask)
572 Result |= SymbolRef::SF_FormatSpecific;
574 if (MachOType & MachO::NlistMaskExternal) {
575 Result |= SymbolRef::SF_Global;
576 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeUndefined)
577 Result |= SymbolRef::SF_Common;
580 if (MachOFlags & (MachO::NListDescWeakRef | MachO::NListDescWeakDef))
581 Result |= SymbolRef::SF_Weak;
583 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeAbsolute)
584 Result |= SymbolRef::SF_Absolute;
586 return object_error::success;
590 MachOObjectFile::getSymbolSection(DataRefImpl Symb,
591 section_iterator &Res) const {
592 SymbolTableEntryBase Entry = getSymbolTableEntryBase(this, Symb);
593 uint8_t index = Entry.SectionIndex;
596 Res = end_sections();
600 Res = section_iterator(SectionRef(DRI, this));
603 return object_error::success;
606 error_code MachOObjectFile::getSymbolValue(DataRefImpl Symb,
607 uint64_t &Val) const {
608 report_fatal_error("getSymbolValue unimplemented in MachOObjectFile");
611 error_code MachOObjectFile::getSectionNext(DataRefImpl Sec,
612 SectionRef &Res) const {
614 Res = SectionRef(Sec, this);
615 return object_error::success;
619 MachOObjectFile::getSectionName(DataRefImpl Sec, StringRef &Result) const {
620 ArrayRef<char> Raw = getSectionRawName(Sec);
621 Result = parseSegmentOrSectionName(Raw.data());
622 return object_error::success;
626 MachOObjectFile::getSectionAddress(DataRefImpl Sec, uint64_t &Res) const {
628 macho::Section64 Sect = getSection64(Sec);
631 macho::Section Sect = getSection(Sec);
634 return object_error::success;
638 MachOObjectFile::getSectionSize(DataRefImpl Sec, uint64_t &Res) const {
640 macho::Section64 Sect = getSection64(Sec);
643 macho::Section Sect = getSection(Sec);
647 return object_error::success;
651 MachOObjectFile::getSectionContents(DataRefImpl Sec, StringRef &Res) const {
656 macho::Section64 Sect = getSection64(Sec);
657 Offset = Sect.Offset;
660 macho::Section Sect =getSection(Sec);
661 Offset = Sect.Offset;
665 Res = this->getData().substr(Offset, Size);
666 return object_error::success;
670 MachOObjectFile::getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const {
673 macho::Section64 Sect = getSection64(Sec);
676 macho::Section Sect = getSection(Sec);
680 Res = uint64_t(1) << Align;
681 return object_error::success;
685 MachOObjectFile::isSectionText(DataRefImpl Sec, bool &Res) const {
686 uint32_t Flags = getSectionFlags(this, Sec);
687 Res = Flags & macho::SF_PureInstructions;
688 return object_error::success;
691 error_code MachOObjectFile::isSectionData(DataRefImpl DRI, bool &Result) const {
692 // FIXME: Unimplemented.
694 return object_error::success;
697 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI, bool &Result) const {
698 // FIXME: Unimplemented.
700 return object_error::success;
704 MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
705 bool &Result) const {
706 // FIXME: Unimplemented.
708 return object_error::success;
711 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
712 bool &Result) const {
713 // FIXME: Unimplemented.
715 return object_error::success;
719 MachOObjectFile::isSectionZeroInit(DataRefImpl Sec, bool &Res) const {
720 uint32_t Flags = getSectionFlags(this, Sec);
721 unsigned SectionType = Flags & MachO::SectionFlagMaskSectionType;
722 Res = SectionType == MachO::SectionTypeZeroFill ||
723 SectionType == MachO::SectionTypeZeroFillLarge;
724 return object_error::success;
727 error_code MachOObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
728 bool &Result) const {
729 // Consider using the code from isSectionText to look for __const sections.
730 // Alternately, emit S_ATTR_PURE_INSTRUCTIONS and/or S_ATTR_SOME_INSTRUCTIONS
731 // to use section attributes to distinguish code from data.
733 // FIXME: Unimplemented.
735 return object_error::success;
739 MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
740 bool &Result) const {
742 this->getSymbolType(Symb, ST);
743 if (ST == SymbolRef::ST_Unknown) {
745 return object_error::success;
748 uint64_t SectBegin, SectEnd;
749 getSectionAddress(Sec, SectBegin);
750 getSectionSize(Sec, SectEnd);
751 SectEnd += SectBegin;
754 getSymbolAddress(Symb, SymAddr);
755 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
757 return object_error::success;
760 relocation_iterator MachOObjectFile::getSectionRelBegin(DataRefImpl Sec) const {
763 return relocation_iterator(RelocationRef(ret, this));
767 MachOObjectFile::getSectionRelEnd(DataRefImpl Sec) const {
770 macho::Section64 Sect = getSection64(Sec);
771 LastReloc = Sect.NumRelocationTableEntries;
773 macho::Section Sect = getSection(Sec);
774 LastReloc = Sect.NumRelocationTableEntries;
780 return relocation_iterator(RelocationRef(Ret, this));
783 error_code MachOObjectFile::getRelocationNext(DataRefImpl Rel,
784 RelocationRef &Res) const {
786 Res = RelocationRef(Rel, this);
787 return object_error::success;
791 MachOObjectFile::getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const {
792 report_fatal_error("getRelocationAddress not implemented in MachOObjectFile");
795 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
796 uint64_t &Res) const {
797 macho::RelocationEntry RE = getRelocation(Rel);
798 Res = getAnyRelocationAddress(RE);
799 return object_error::success;
803 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel, SymbolRef &Res) const {
804 macho::RelocationEntry RE = getRelocation(Rel);
805 uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
806 bool isExtern = getPlainRelocationExternal(RE);
808 Res = *end_symbols();
809 return object_error::success;
812 macho::SymtabLoadCommand S = getSymtabLoadCommand();
813 unsigned SymbolTableEntrySize = is64Bit() ?
814 sizeof(macho::Symbol64TableEntry) :
815 sizeof(macho::SymbolTableEntry);
816 uint64_t Offset = S.SymbolTableOffset + SymbolIdx * SymbolTableEntrySize;
818 Sym.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
819 Res = SymbolRef(Sym, this);
820 return object_error::success;
823 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
824 uint64_t &Res) const {
825 macho::RelocationEntry RE = getRelocation(Rel);
826 Res = getAnyRelocationType(RE);
827 return object_error::success;
831 MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
832 SmallVectorImpl<char> &Result) const {
835 getRelocationType(Rel, RType);
837 unsigned Arch = this->getArch();
841 static const char *const Table[] = {
842 "GENERIC_RELOC_VANILLA",
843 "GENERIC_RELOC_PAIR",
844 "GENERIC_RELOC_SECTDIFF",
845 "GENERIC_RELOC_PB_LA_PTR",
846 "GENERIC_RELOC_LOCAL_SECTDIFF",
847 "GENERIC_RELOC_TLV" };
855 case Triple::x86_64: {
856 static const char *const Table[] = {
857 "X86_64_RELOC_UNSIGNED",
858 "X86_64_RELOC_SIGNED",
859 "X86_64_RELOC_BRANCH",
860 "X86_64_RELOC_GOT_LOAD",
862 "X86_64_RELOC_SUBTRACTOR",
863 "X86_64_RELOC_SIGNED_1",
864 "X86_64_RELOC_SIGNED_2",
865 "X86_64_RELOC_SIGNED_4",
866 "X86_64_RELOC_TLV" };
875 static const char *const Table[] = {
878 "ARM_RELOC_SECTDIFF",
879 "ARM_RELOC_LOCAL_SECTDIFF",
880 "ARM_RELOC_PB_LA_PTR",
882 "ARM_THUMB_RELOC_BR22",
883 "ARM_THUMB_32BIT_BRANCH",
885 "ARM_RELOC_HALF_SECTDIFF" };
894 static const char *const Table[] = {
903 "PPC_RELOC_SECTDIFF",
904 "PPC_RELOC_PB_LA_PTR",
905 "PPC_RELOC_HI16_SECTDIFF",
906 "PPC_RELOC_LO16_SECTDIFF",
907 "PPC_RELOC_HA16_SECTDIFF",
909 "PPC_RELOC_LO14_SECTDIFF",
910 "PPC_RELOC_LOCAL_SECTDIFF" };
915 case Triple::UnknownArch:
919 Result.append(res.begin(), res.end());
920 return object_error::success;
923 error_code MachOObjectFile::getRelocationAdditionalInfo(DataRefImpl Rel,
924 int64_t &Res) const {
926 return object_error::success;
930 MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
931 SmallVectorImpl<char> &Result) const {
932 macho::RelocationEntry RE = getRelocation(Rel);
934 unsigned Arch = this->getArch();
937 raw_string_ostream fmt(fmtbuf);
938 unsigned Type = this->getAnyRelocationType(RE);
939 bool IsPCRel = this->getAnyRelocationPCRel(RE);
941 // Determine any addends that should be displayed with the relocation.
942 // These require decoding the relocation type, which is triple-specific.
944 // X86_64 has entirely custom relocation types.
945 if (Arch == Triple::x86_64) {
946 bool isPCRel = getAnyRelocationPCRel(RE);
949 case macho::RIT_X86_64_GOTLoad: // X86_64_RELOC_GOT_LOAD
950 case macho::RIT_X86_64_GOT: { // X86_64_RELOC_GOT
951 printRelocationTargetName(this, RE, fmt);
953 if (isPCRel) fmt << "PCREL";
956 case macho::RIT_X86_64_Subtractor: { // X86_64_RELOC_SUBTRACTOR
957 DataRefImpl RelNext = Rel;
959 macho::RelocationEntry RENext = getRelocation(RelNext);
961 // X86_64_SUBTRACTOR must be followed by a relocation of type
962 // X86_64_RELOC_UNSIGNED.
963 // NOTE: Scattered relocations don't exist on x86_64.
964 unsigned RType = getAnyRelocationType(RENext);
966 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
967 "X86_64_RELOC_SUBTRACTOR.");
969 // The X86_64_RELOC_UNSIGNED contains the minuend symbol,
970 // X86_64_SUBTRACTOR contains to the subtrahend.
971 printRelocationTargetName(this, RENext, fmt);
973 printRelocationTargetName(this, RE, fmt);
976 case macho::RIT_X86_64_TLV:
977 printRelocationTargetName(this, RE, fmt);
979 if (isPCRel) fmt << "P";
981 case macho::RIT_X86_64_Signed1: // X86_64_RELOC_SIGNED1
982 printRelocationTargetName(this, RE, fmt);
985 case macho::RIT_X86_64_Signed2: // X86_64_RELOC_SIGNED2
986 printRelocationTargetName(this, RE, fmt);
989 case macho::RIT_X86_64_Signed4: // X86_64_RELOC_SIGNED4
990 printRelocationTargetName(this, RE, fmt);
994 printRelocationTargetName(this, RE, fmt);
997 // X86 and ARM share some relocation types in common.
998 } else if (Arch == Triple::x86 || Arch == Triple::arm) {
999 // Generic relocation types...
1001 case macho::RIT_Pair: // GENERIC_RELOC_PAIR - prints no info
1002 return object_error::success;
1003 case macho::RIT_Difference: { // GENERIC_RELOC_SECTDIFF
1004 DataRefImpl RelNext = Rel;
1006 macho::RelocationEntry RENext = getRelocation(RelNext);
1008 // X86 sect diff's must be followed by a relocation of type
1009 // GENERIC_RELOC_PAIR.
1010 unsigned RType = getAnyRelocationType(RENext);
1013 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1014 "GENERIC_RELOC_SECTDIFF.");
1016 printRelocationTargetName(this, RE, fmt);
1018 printRelocationTargetName(this, RENext, fmt);
1023 if (Arch == Triple::x86) {
1024 // All X86 relocations that need special printing were already
1025 // handled in the generic code.
1027 case macho::RIT_Generic_LocalDifference:{// GENERIC_RELOC_LOCAL_SECTDIFF
1028 DataRefImpl RelNext = Rel;
1030 macho::RelocationEntry RENext = getRelocation(RelNext);
1032 // X86 sect diff's must be followed by a relocation of type
1033 // GENERIC_RELOC_PAIR.
1034 unsigned RType = getAnyRelocationType(RENext);
1036 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1037 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1039 printRelocationTargetName(this, RE, fmt);
1041 printRelocationTargetName(this, RENext, fmt);
1044 case macho::RIT_Generic_TLV: {
1045 printRelocationTargetName(this, RE, fmt);
1047 if (IsPCRel) fmt << "P";
1051 printRelocationTargetName(this, RE, fmt);
1053 } else { // ARM-specific relocations
1055 case macho::RIT_ARM_Half: // ARM_RELOC_HALF
1056 case macho::RIT_ARM_HalfDifference: { // ARM_RELOC_HALF_SECTDIFF
1057 // Half relocations steal a bit from the length field to encode
1058 // whether this is an upper16 or a lower16 relocation.
1059 bool isUpper = getAnyRelocationLength(RE) >> 1;
1062 fmt << ":upper16:(";
1064 fmt << ":lower16:(";
1065 printRelocationTargetName(this, RE, fmt);
1067 DataRefImpl RelNext = Rel;
1069 macho::RelocationEntry RENext = getRelocation(RelNext);
1071 // ARM half relocs must be followed by a relocation of type
1073 unsigned RType = getAnyRelocationType(RENext);
1075 report_fatal_error("Expected ARM_RELOC_PAIR after "
1076 "GENERIC_RELOC_HALF");
1078 // NOTE: The half of the target virtual address is stashed in the
1079 // address field of the secondary relocation, but we can't reverse
1080 // engineer the constant offset from it without decoding the movw/movt
1081 // instruction to find the other half in its immediate field.
1083 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1084 // symbol/section pointer of the follow-on relocation.
1085 if (Type == macho::RIT_ARM_HalfDifference) {
1087 printRelocationTargetName(this, RENext, fmt);
1094 printRelocationTargetName(this, RE, fmt);
1099 printRelocationTargetName(this, RE, fmt);
1102 Result.append(fmtbuf.begin(), fmtbuf.end());
1103 return object_error::success;
1107 MachOObjectFile::getRelocationHidden(DataRefImpl Rel, bool &Result) const {
1108 unsigned Arch = getArch();
1110 getRelocationType(Rel, Type);
1114 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1115 // is always hidden.
1116 if (Arch == Triple::x86 || Arch == Triple::arm) {
1117 if (Type == macho::RIT_Pair) Result = true;
1118 } else if (Arch == Triple::x86_64) {
1119 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1120 // an X864_64_RELOC_SUBTRACTOR.
1121 if (Type == macho::RIT_X86_64_Unsigned && Rel.d.a > 0) {
1122 DataRefImpl RelPrev = Rel;
1125 getRelocationType(RelPrev, PrevType);
1126 if (PrevType == macho::RIT_X86_64_Subtractor)
1131 return object_error::success;
1134 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1135 LibraryRef &Res) const {
1136 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1139 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1140 StringRef &Res) const {
1141 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1144 symbol_iterator MachOObjectFile::begin_symbols() const {
1147 return symbol_iterator(SymbolRef(DRI, this));
1149 macho::SymtabLoadCommand Symtab = getSymtabLoadCommand();
1150 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Symtab.SymbolTableOffset));
1151 return symbol_iterator(SymbolRef(DRI, this));
1154 symbol_iterator MachOObjectFile::end_symbols() const {
1157 return symbol_iterator(SymbolRef(DRI, this));
1159 macho::SymtabLoadCommand Symtab = getSymtabLoadCommand();
1160 unsigned SymbolTableEntrySize = is64Bit() ?
1161 sizeof(macho::Symbol64TableEntry) :
1162 sizeof(macho::SymbolTableEntry);
1163 unsigned Offset = Symtab.SymbolTableOffset +
1164 Symtab.NumSymbolTableEntries * SymbolTableEntrySize;
1165 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1166 return symbol_iterator(SymbolRef(DRI, this));
1169 symbol_iterator MachOObjectFile::begin_dynamic_symbols() const {
1171 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
1174 symbol_iterator MachOObjectFile::end_dynamic_symbols() const {
1176 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
1179 section_iterator MachOObjectFile::begin_sections() const {
1181 return section_iterator(SectionRef(DRI, this));
1184 section_iterator MachOObjectFile::end_sections() const {
1186 DRI.d.a = Sections.size();
1187 return section_iterator(SectionRef(DRI, this));
1190 library_iterator MachOObjectFile::begin_libraries_needed() const {
1192 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1195 library_iterator MachOObjectFile::end_libraries_needed() const {
1197 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1200 uint8_t MachOObjectFile::getBytesInAddress() const {
1201 return is64Bit() ? 8 : 4;
1204 StringRef MachOObjectFile::getFileFormatName() const {
1205 unsigned CPUType = getCPUType(this);
1208 case llvm::MachO::CPUTypeI386:
1209 return "Mach-O 32-bit i386";
1210 case llvm::MachO::CPUTypeARM:
1211 return "Mach-O arm";
1212 case llvm::MachO::CPUTypePowerPC:
1213 return "Mach-O 32-bit ppc";
1215 assert((CPUType & llvm::MachO::CPUArchABI64) == 0 &&
1216 "64-bit object file when we're not 64-bit?");
1217 return "Mach-O 32-bit unknown";
1221 // Make sure the cpu type has the correct mask.
1222 assert((CPUType & llvm::MachO::CPUArchABI64)
1223 == llvm::MachO::CPUArchABI64 &&
1224 "32-bit object file when we're 64-bit?");
1227 case llvm::MachO::CPUTypeX86_64:
1228 return "Mach-O 64-bit x86-64";
1229 case llvm::MachO::CPUTypePowerPC64:
1230 return "Mach-O 64-bit ppc64";
1232 return "Mach-O 64-bit unknown";
1236 unsigned MachOObjectFile::getArch() const {
1237 switch (getCPUType(this)) {
1238 case llvm::MachO::CPUTypeI386:
1240 case llvm::MachO::CPUTypeX86_64:
1241 return Triple::x86_64;
1242 case llvm::MachO::CPUTypeARM:
1244 case llvm::MachO::CPUTypePowerPC:
1246 case llvm::MachO::CPUTypePowerPC64:
1247 return Triple::ppc64;
1249 return Triple::UnknownArch;
1253 StringRef MachOObjectFile::getLoadName() const {
1255 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
1259 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
1260 ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
1261 return parseSegmentOrSectionName(Raw.data());
1265 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
1266 const SectionBase *Base =
1267 reinterpret_cast<const SectionBase*>(Sections[Sec.d.a]);
1268 return ArrayRef<char>(Base->Name);
1272 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
1273 const SectionBase *Base =
1274 reinterpret_cast<const SectionBase*>(Sections[Sec.d.a]);
1275 return ArrayRef<char>(Base->SegmentName);
1279 MachOObjectFile::isRelocationScattered(const macho::RelocationEntry &RE)
1281 if (getCPUType(this) == llvm::MachO::CPUTypeX86_64)
1283 return getPlainRelocationAddress(RE) & macho::RF_Scattered;
1286 unsigned MachOObjectFile::getPlainRelocationSymbolNum(const macho::RelocationEntry &RE) const {
1287 if (isLittleEndian())
1288 return RE.Word1 & 0xffffff;
1289 return RE.Word1 >> 8;
1292 bool MachOObjectFile::getPlainRelocationExternal(const macho::RelocationEntry &RE) const {
1293 if (isLittleEndian())
1294 return (RE.Word1 >> 27) & 1;
1295 return (RE.Word1 >> 4) & 1;
1299 MachOObjectFile::getScatteredRelocationScattered(const macho::RelocationEntry &RE) const {
1300 return RE.Word0 >> 31;
1304 MachOObjectFile::getScatteredRelocationValue(const macho::RelocationEntry &RE) const {
1309 MachOObjectFile::getAnyRelocationAddress(const macho::RelocationEntry &RE) const {
1310 if (isRelocationScattered(RE))
1311 return getScatteredRelocationAddress(RE);
1312 return getPlainRelocationAddress(RE);
1316 MachOObjectFile::getAnyRelocationPCRel(const macho::RelocationEntry &RE) const {
1317 if (isRelocationScattered(RE))
1318 return getScatteredRelocationPCRel(this, RE);
1319 return getPlainRelocationPCRel(this, RE);
1323 MachOObjectFile::getAnyRelocationLength(const macho::RelocationEntry &RE) const {
1324 if (isRelocationScattered(RE))
1325 return getScatteredRelocationLength(RE);
1326 return getPlainRelocationLength(this, RE);
1330 MachOObjectFile::getAnyRelocationType(const macho::RelocationEntry &RE) const {
1331 if (isRelocationScattered(RE))
1332 return getScatteredRelocationType(RE);
1333 return getPlainRelocationType(this, RE);
1336 MachOObjectFile::LoadCommandInfo
1337 MachOObjectFile::getFirstLoadCommandInfo() const {
1338 MachOObjectFile::LoadCommandInfo Load;
1340 unsigned HeaderSize = is64Bit() ? macho::Header64Size : macho::Header32Size;
1341 Load.Ptr = getPtr(this, HeaderSize);
1342 Load.C = getStruct<macho::LoadCommand>(this, Load.Ptr);
1346 MachOObjectFile::LoadCommandInfo
1347 MachOObjectFile::getNextLoadCommandInfo(const LoadCommandInfo &L) const {
1348 MachOObjectFile::LoadCommandInfo Next;
1349 Next.Ptr = L.Ptr + L.C.Size;
1350 Next.C = getStruct<macho::LoadCommand>(this, Next.Ptr);
1354 macho::Section MachOObjectFile::getSection(DataRefImpl DRI) const {
1355 return getStruct<macho::Section>(this, Sections[DRI.d.a]);
1358 macho::Section64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
1359 return getStruct<macho::Section64>(this, Sections[DRI.d.a]);
1362 macho::SymbolTableEntry
1363 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
1364 const char *P = reinterpret_cast<const char *>(DRI.p);
1365 return getStruct<macho::SymbolTableEntry>(this, P);
1368 macho::Symbol64TableEntry
1369 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
1370 const char *P = reinterpret_cast<const char *>(DRI.p);
1371 return getStruct<macho::Symbol64TableEntry>(this, P);
1374 macho::LinkeditDataLoadCommand
1375 MachOObjectFile::getLinkeditDataLoadCommand(const MachOObjectFile::LoadCommandInfo &L) const {
1376 return getStruct<macho::LinkeditDataLoadCommand>(this, L.Ptr);
1379 macho::RelocationEntry
1380 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
1385 macho::Section64 Sect = getSection64(Sec);
1386 RelOffset = Sect.RelocationTableOffset;
1388 macho::Section Sect = getSection(Sec);
1389 RelOffset = Sect.RelocationTableOffset;
1392 uint64_t Offset = RelOffset + Rel.d.a * sizeof(macho::RelocationEntry);
1393 return getStruct<macho::RelocationEntry>(this, getPtr(this, Offset));
1396 macho::Header MachOObjectFile::getHeader() const {
1397 return getStruct<macho::Header>(this, getPtr(this, 0));
1400 macho::SymtabLoadCommand
1401 MachOObjectFile::getSymtabLoadCommand() const {
1402 return getStruct<macho::SymtabLoadCommand>(this, SymtabLoadCmd);
1405 bool MachOObjectFile::is64Bit() const {
1406 return getType() == getMachOType(false, true) ||
1407 getType() == getMachOType(true, true);
1410 void MachOObjectFile::ReadULEB128s(uint64_t Index,
1411 SmallVectorImpl<uint64_t> &Out) const {
1412 DataExtractor extractor(ObjectFile::getData(), true, 0);
1414 uint32_t offset = Index;
1416 while (uint64_t delta = extractor.getULEB128(&offset)) {
1418 Out.push_back(data);
1422 ObjectFile *ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer) {
1423 StringRef Magic = Buffer->getBuffer().slice(0, 4);
1426 if (Magic == "\xFE\xED\xFA\xCE")
1427 Ret = new MachOObjectFile(Buffer, false, false, ec);
1428 else if (Magic == "\xCE\xFA\xED\xFE")
1429 Ret = new MachOObjectFile(Buffer, true, false, ec);
1430 else if (Magic == "\xFE\xED\xFA\xCF")
1431 Ret = new MachOObjectFile(Buffer, false, true, ec);
1432 else if (Magic == "\xCF\xFA\xED\xFE")
1433 Ret = new MachOObjectFile(Buffer, true, true, ec);
1442 } // end namespace object
1443 } // end namespace llvm