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/Support/DataExtractor.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/Support/Host.h"
20 #include "llvm/Support/MemoryBuffer.h"
21 #include "llvm/Support/raw_ostream.h"
27 using namespace object;
45 static void SwapValue(T &Value) {
46 Value = sys::SwapByteOrder(Value);
50 static void SwapStruct(T &Value);
53 void SwapStruct(MachO::any_relocation_info &H) {
59 void SwapStruct(MachO::load_command &L) {
65 void SwapStruct(nlist_base &S) {
71 void SwapStruct(MachO::section &S) {
79 SwapValue(S.reserved1);
80 SwapValue(S.reserved2);
84 void SwapStruct(MachO::section_64 &S) {
92 SwapValue(S.reserved1);
93 SwapValue(S.reserved2);
94 SwapValue(S.reserved3);
98 void SwapStruct(MachO::nlist &S) {
101 SwapValue(S.n_value);
105 void SwapStruct(MachO::nlist_64 &S) {
108 SwapValue(S.n_value);
112 void SwapStruct(MachO::mach_header &H) {
114 SwapValue(H.cputype);
115 SwapValue(H.cpusubtype);
116 SwapValue(H.filetype);
118 SwapValue(H.sizeofcmds);
123 void SwapStruct(MachO::mach_header_64 &H) {
125 SwapValue(H.cputype);
126 SwapValue(H.cpusubtype);
127 SwapValue(H.filetype);
129 SwapValue(H.sizeofcmds);
131 SwapValue(H.reserved);
135 void SwapStruct(MachO::symtab_command &C) {
137 SwapValue(C.cmdsize);
141 SwapValue(C.strsize);
145 void SwapStruct(MachO::dysymtab_command &C) {
147 SwapValue(C.cmdsize);
148 SwapValue(C.ilocalsym);
149 SwapValue(C.nlocalsym);
150 SwapValue(C.iextdefsym);
151 SwapValue(C.nextdefsym);
152 SwapValue(C.iundefsym);
153 SwapValue(C.nundefsym);
156 SwapValue(C.modtaboff);
157 SwapValue(C.nmodtab);
158 SwapValue(C.extrefsymoff);
159 SwapValue(C.nextrefsyms);
160 SwapValue(C.indirectsymoff);
161 SwapValue(C.nindirectsyms);
162 SwapValue(C.extreloff);
163 SwapValue(C.nextrel);
164 SwapValue(C.locreloff);
165 SwapValue(C.nlocrel);
169 void SwapStruct(MachO::linkedit_data_command &C) {
171 SwapValue(C.cmdsize);
172 SwapValue(C.dataoff);
173 SwapValue(C.datasize);
177 void SwapStruct(MachO::segment_command &C) {
179 SwapValue(C.cmdsize);
182 SwapValue(C.fileoff);
183 SwapValue(C.filesize);
184 SwapValue(C.maxprot);
185 SwapValue(C.initprot);
191 void SwapStruct(MachO::segment_command_64 &C) {
193 SwapValue(C.cmdsize);
196 SwapValue(C.fileoff);
197 SwapValue(C.filesize);
198 SwapValue(C.maxprot);
199 SwapValue(C.initprot);
205 void SwapStruct(uint32_t &C) {
210 void SwapStruct(MachO::linker_options_command &C) {
212 SwapValue(C.cmdsize);
217 void SwapStruct(MachO::data_in_code_entry &C) {
224 T getStruct(const MachOObjectFile *O, const char *P) {
226 memcpy(&Cmd, P, sizeof(T));
227 if (O->isLittleEndian() != sys::IsLittleEndianHost)
233 getSegmentLoadCommandNumSections(const MachOObjectFile *O,
234 const MachOObjectFile::LoadCommandInfo &L) {
236 MachO::segment_command_64 S = O->getSegment64LoadCommand(L);
239 MachO::segment_command S = O->getSegmentLoadCommand(L);
244 getSectionPtr(const MachOObjectFile *O, MachOObjectFile::LoadCommandInfo L,
246 uintptr_t CommandAddr = reinterpret_cast<uintptr_t>(L.Ptr);
248 bool Is64 = O->is64Bit();
249 unsigned SegmentLoadSize = Is64 ? sizeof(MachO::segment_command_64) :
250 sizeof(MachO::segment_command);
251 unsigned SectionSize = Is64 ? sizeof(MachO::section_64) :
252 sizeof(MachO::section);
254 uintptr_t SectionAddr = CommandAddr + SegmentLoadSize + Sec * SectionSize;
255 return reinterpret_cast<const char*>(SectionAddr);
258 static const char *getPtr(const MachOObjectFile *O, size_t Offset) {
259 return O->getData().substr(Offset, 1).data();
263 getSymbolTableEntryBase(const MachOObjectFile *O, DataRefImpl DRI) {
264 const char *P = reinterpret_cast<const char *>(DRI.p);
265 return getStruct<nlist_base>(O, P);
268 static StringRef parseSegmentOrSectionName(const char *P) {
272 // Not null terminated, so this is a 16 char string.
273 return StringRef(P, 16);
276 // Helper to advance a section or symbol iterator multiple increments at a time.
278 static void advance(T &it, size_t Val) {
283 static unsigned getCPUType(const MachOObjectFile *O) {
284 return O->getHeader().cputype;
287 static void printRelocationTargetName(const MachOObjectFile *O,
288 const MachO::any_relocation_info &RE,
289 raw_string_ostream &fmt) {
290 bool IsScattered = O->isRelocationScattered(RE);
292 // Target of a scattered relocation is an address. In the interest of
293 // generating pretty output, scan through the symbol table looking for a
294 // symbol that aligns with that address. If we find one, print it.
295 // Otherwise, we just print the hex address of the target.
297 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
299 for (symbol_iterator SI = O->begin_symbols(), SE = O->end_symbols();
305 if ((ec = SI->getAddress(Addr)))
306 report_fatal_error(ec.message());
307 if (Addr != Val) continue;
308 if ((ec = SI->getName(Name)))
309 report_fatal_error(ec.message());
314 // If we couldn't find a symbol that this relocation refers to, try
315 // to find a section beginning instead.
316 for (section_iterator SI = O->begin_sections(), SE = O->end_sections();
322 if ((ec = SI->getAddress(Addr)))
323 report_fatal_error(ec.message());
324 if (Addr != Val) continue;
325 if ((ec = SI->getName(Name)))
326 report_fatal_error(ec.message());
331 fmt << format("0x%x", Val);
336 bool isExtern = O->getPlainRelocationExternal(RE);
337 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
340 symbol_iterator SI = O->begin_symbols();
344 section_iterator SI = O->begin_sections();
345 // Adjust for the fact that sections are 1-indexed.
346 advance(SI, Val - 1);
354 getPlainRelocationAddress(const MachO::any_relocation_info &RE) {
359 getScatteredRelocationAddress(const MachO::any_relocation_info &RE) {
360 return RE.r_word0 & 0xffffff;
363 static bool getPlainRelocationPCRel(const MachOObjectFile *O,
364 const MachO::any_relocation_info &RE) {
365 if (O->isLittleEndian())
366 return (RE.r_word1 >> 24) & 1;
367 return (RE.r_word1 >> 7) & 1;
371 getScatteredRelocationPCRel(const MachOObjectFile *O,
372 const MachO::any_relocation_info &RE) {
373 return (RE.r_word0 >> 30) & 1;
376 static unsigned getPlainRelocationLength(const MachOObjectFile *O,
377 const MachO::any_relocation_info &RE) {
378 if (O->isLittleEndian())
379 return (RE.r_word1 >> 25) & 3;
380 return (RE.r_word1 >> 5) & 3;
384 getScatteredRelocationLength(const MachO::any_relocation_info &RE) {
385 return (RE.r_word0 >> 28) & 3;
388 static unsigned getPlainRelocationType(const MachOObjectFile *O,
389 const MachO::any_relocation_info &RE) {
390 if (O->isLittleEndian())
391 return RE.r_word1 >> 28;
392 return RE.r_word1 & 0xf;
396 getScatteredRelocationType(const MachO::any_relocation_info &RE) {
397 return (RE.r_word0 >> 24) & 0xf;
400 static uint32_t getSectionFlags(const MachOObjectFile *O,
403 MachO::section_64 Sect = O->getSection64(Sec);
406 MachO::section Sect = O->getSection(Sec);
410 MachOObjectFile::MachOObjectFile(MemoryBuffer *Object, bool IsLittleEndian,
411 bool Is64bits, error_code &EC,
413 : ObjectFile(getMachOType(IsLittleEndian, Is64bits), Object, BufferOwned),
414 SymtabLoadCmd(NULL), DysymtabLoadCmd(NULL), DataInCodeLoadCmd(NULL) {
415 uint32_t LoadCommandCount = this->getHeader().ncmds;
416 MachO::LoadCommandType SegmentLoadType = is64Bit() ?
417 MachO::LC_SEGMENT_64 : MachO::LC_SEGMENT;
419 MachOObjectFile::LoadCommandInfo Load = getFirstLoadCommandInfo();
420 for (unsigned I = 0; ; ++I) {
421 if (Load.C.cmd == MachO::LC_SYMTAB) {
422 assert(!SymtabLoadCmd && "Multiple symbol tables");
423 SymtabLoadCmd = Load.Ptr;
424 } else if (Load.C.cmd == MachO::LC_DYSYMTAB) {
425 assert(!DysymtabLoadCmd && "Multiple dynamic symbol tables");
426 DysymtabLoadCmd = Load.Ptr;
427 } else if (Load.C.cmd == MachO::LC_DATA_IN_CODE) {
428 assert(!DataInCodeLoadCmd && "Multiple data in code tables");
429 DataInCodeLoadCmd = Load.Ptr;
430 } else if (Load.C.cmd == SegmentLoadType) {
431 uint32_t NumSections = getSegmentLoadCommandNumSections(this, Load);
432 for (unsigned J = 0; J < NumSections; ++J) {
433 const char *Sec = getSectionPtr(this, Load, J);
434 Sections.push_back(Sec);
438 if (I == LoadCommandCount - 1)
441 Load = getNextLoadCommandInfo(Load);
445 void MachOObjectFile::moveSymbolNext(DataRefImpl &Symb) const {
446 unsigned SymbolTableEntrySize = is64Bit() ?
447 sizeof(MachO::nlist_64) :
448 sizeof(MachO::nlist);
449 Symb.p += SymbolTableEntrySize;
452 error_code MachOObjectFile::getSymbolName(DataRefImpl Symb,
453 StringRef &Res) const {
454 StringRef StringTable = getStringTableData();
455 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
456 const char *Start = &StringTable.data()[Entry.n_strx];
457 Res = StringRef(Start);
458 return object_error::success;
461 error_code MachOObjectFile::getSymbolAddress(DataRefImpl Symb,
462 uint64_t &Res) const {
464 MachO::nlist_64 Entry = getSymbol64TableEntry(Symb);
467 MachO::nlist Entry = getSymbolTableEntry(Symb);
470 return object_error::success;
474 MachOObjectFile::getSymbolFileOffset(DataRefImpl Symb,
475 uint64_t &Res) const {
476 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
477 getSymbolAddress(Symb, Res);
481 SecRel.d.a = Entry.n_sect-1;
483 MachO::section_64 Sec = getSection64(SecRel);
484 Delta = Sec.offset - Sec.addr;
486 MachO::section Sec = getSection(SecRel);
487 Delta = Sec.offset - Sec.addr;
493 return object_error::success;
496 error_code MachOObjectFile::getSymbolAlignment(DataRefImpl DRI,
497 uint32_t &Result) const {
499 this->getSymbolFlags(DRI, flags);
500 if (flags & SymbolRef::SF_Common) {
501 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
502 Result = 1 << MachO::GET_COMM_ALIGN(Entry.n_desc);
506 return object_error::success;
509 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
510 uint64_t &Result) const {
511 uint64_t BeginOffset;
512 uint64_t EndOffset = 0;
513 uint8_t SectionIndex;
515 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
517 getSymbolAddress(DRI, Value);
521 SectionIndex = Entry.n_sect;
523 uint32_t flags = SymbolRef::SF_None;
524 this->getSymbolFlags(DRI, flags);
525 if (flags & SymbolRef::SF_Common)
528 Result = UnknownAddressOrSize;
529 return object_error::success;
531 // Unfortunately symbols are unsorted so we need to touch all
532 // symbols from load command
533 for (symbol_iterator I = begin_symbols(), E = end_symbols(); I != E; ++I) {
534 DataRefImpl DRI = I->getRawDataRefImpl();
535 Entry = getSymbolTableEntryBase(this, DRI);
536 getSymbolAddress(DRI, Value);
537 if (Entry.n_sect == SectionIndex && Value > BeginOffset)
538 if (!EndOffset || Value < EndOffset)
544 Sec.d.a = SectionIndex-1;
545 getSectionSize(Sec, Size);
546 getSectionAddress(Sec, EndOffset);
549 Result = EndOffset - BeginOffset;
550 return object_error::success;
553 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
554 SymbolRef::Type &Res) const {
555 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
556 uint8_t n_type = Entry.n_type;
558 Res = SymbolRef::ST_Other;
560 // If this is a STAB debugging symbol, we can do nothing more.
561 if (n_type & MachO::N_STAB) {
562 Res = SymbolRef::ST_Debug;
563 return object_error::success;
566 switch (n_type & MachO::N_TYPE) {
568 Res = SymbolRef::ST_Unknown;
571 Res = SymbolRef::ST_Function;
574 return object_error::success;
577 error_code MachOObjectFile::getSymbolFlags(DataRefImpl DRI,
578 uint32_t &Result) const {
579 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
581 uint8_t MachOType = Entry.n_type;
582 uint16_t MachOFlags = Entry.n_desc;
584 // TODO: Correctly set SF_ThreadLocal
585 Result = SymbolRef::SF_None;
587 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF)
588 Result |= SymbolRef::SF_Undefined;
590 if (MachOType & MachO::N_STAB)
591 Result |= SymbolRef::SF_FormatSpecific;
593 if (MachOType & MachO::N_EXT) {
594 Result |= SymbolRef::SF_Global;
595 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF) {
597 getSymbolAddress(DRI, Value);
599 Result |= SymbolRef::SF_Common;
603 if (MachOFlags & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
604 Result |= SymbolRef::SF_Weak;
606 if ((MachOType & MachO::N_TYPE) == MachO::N_ABS)
607 Result |= SymbolRef::SF_Absolute;
609 return object_error::success;
613 MachOObjectFile::getSymbolSection(DataRefImpl Symb,
614 section_iterator &Res) const {
615 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
616 uint8_t index = Entry.n_sect;
619 Res = end_sections();
623 Res = section_iterator(SectionRef(DRI, this));
626 return object_error::success;
629 error_code MachOObjectFile::getSymbolValue(DataRefImpl Symb,
630 uint64_t &Val) const {
631 report_fatal_error("getSymbolValue unimplemented in MachOObjectFile");
634 void MachOObjectFile::moveSectionNext(DataRefImpl &Sec) const {
639 MachOObjectFile::getSectionName(DataRefImpl Sec, StringRef &Result) const {
640 ArrayRef<char> Raw = getSectionRawName(Sec);
641 Result = parseSegmentOrSectionName(Raw.data());
642 return object_error::success;
646 MachOObjectFile::getSectionAddress(DataRefImpl Sec, uint64_t &Res) const {
648 MachO::section_64 Sect = getSection64(Sec);
651 MachO::section Sect = getSection(Sec);
654 return object_error::success;
658 MachOObjectFile::getSectionSize(DataRefImpl Sec, uint64_t &Res) const {
660 MachO::section_64 Sect = getSection64(Sec);
663 MachO::section Sect = getSection(Sec);
667 return object_error::success;
671 MachOObjectFile::getSectionContents(DataRefImpl Sec, StringRef &Res) const {
676 MachO::section_64 Sect = getSection64(Sec);
677 Offset = Sect.offset;
680 MachO::section Sect = getSection(Sec);
681 Offset = Sect.offset;
685 Res = this->getData().substr(Offset, Size);
686 return object_error::success;
690 MachOObjectFile::getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const {
693 MachO::section_64 Sect = getSection64(Sec);
696 MachO::section Sect = getSection(Sec);
700 Res = uint64_t(1) << Align;
701 return object_error::success;
705 MachOObjectFile::isSectionText(DataRefImpl Sec, bool &Res) const {
706 uint32_t Flags = getSectionFlags(this, Sec);
707 Res = Flags & MachO::S_ATTR_PURE_INSTRUCTIONS;
708 return object_error::success;
711 error_code MachOObjectFile::isSectionData(DataRefImpl DRI, bool &Result) const {
712 // FIXME: Unimplemented.
714 return object_error::success;
717 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI, bool &Result) const {
718 // FIXME: Unimplemented.
720 return object_error::success;
724 MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
725 bool &Result) const {
726 // FIXME: Unimplemented.
728 return object_error::success;
731 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
732 bool &Result) const {
733 // FIXME: Unimplemented.
735 return object_error::success;
739 MachOObjectFile::isSectionZeroInit(DataRefImpl Sec, bool &Res) const {
740 uint32_t Flags = getSectionFlags(this, Sec);
741 unsigned SectionType = Flags & MachO::SECTION_TYPE;
742 Res = SectionType == MachO::S_ZEROFILL ||
743 SectionType == MachO::S_GB_ZEROFILL;
744 return object_error::success;
747 error_code MachOObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
748 bool &Result) const {
749 // Consider using the code from isSectionText to look for __const sections.
750 // Alternately, emit S_ATTR_PURE_INSTRUCTIONS and/or S_ATTR_SOME_INSTRUCTIONS
751 // to use section attributes to distinguish code from data.
753 // FIXME: Unimplemented.
755 return object_error::success;
759 MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
760 bool &Result) const {
762 this->getSymbolType(Symb, ST);
763 if (ST == SymbolRef::ST_Unknown) {
765 return object_error::success;
768 uint64_t SectBegin, SectEnd;
769 getSectionAddress(Sec, SectBegin);
770 getSectionSize(Sec, SectEnd);
771 SectEnd += SectBegin;
774 getSymbolAddress(Symb, SymAddr);
775 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
777 return object_error::success;
780 relocation_iterator MachOObjectFile::section_rel_begin(DataRefImpl Sec) const {
783 MachO::section_64 Sect = getSection64(Sec);
784 Offset = Sect.reloff;
786 MachO::section Sect = getSection(Sec);
787 Offset = Sect.reloff;
791 Ret.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
792 return relocation_iterator(RelocationRef(Ret, this));
796 MachOObjectFile::section_rel_end(DataRefImpl Sec) const {
800 MachO::section_64 Sect = getSection64(Sec);
801 Offset = Sect.reloff;
804 MachO::section Sect = getSection(Sec);
805 Offset = Sect.reloff;
809 const MachO::any_relocation_info *P =
810 reinterpret_cast<const MachO::any_relocation_info *>(getPtr(this, Offset));
813 Ret.p = reinterpret_cast<uintptr_t>(P + Num);
814 return relocation_iterator(RelocationRef(Ret, this));
817 void MachOObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
818 const MachO::any_relocation_info *P =
819 reinterpret_cast<const MachO::any_relocation_info *>(Rel.p);
820 Rel.p = reinterpret_cast<uintptr_t>(P + 1);
824 MachOObjectFile::getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const {
825 report_fatal_error("getRelocationAddress not implemented in MachOObjectFile");
828 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
829 uint64_t &Res) const {
830 MachO::any_relocation_info RE = getRelocation(Rel);
831 Res = getAnyRelocationAddress(RE);
832 return object_error::success;
836 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
837 MachO::any_relocation_info RE = getRelocation(Rel);
838 uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
839 bool isExtern = getPlainRelocationExternal(RE);
841 return end_symbols();
843 MachO::symtab_command S = getSymtabLoadCommand();
844 unsigned SymbolTableEntrySize = is64Bit() ?
845 sizeof(MachO::nlist_64) :
846 sizeof(MachO::nlist);
847 uint64_t Offset = S.symoff + SymbolIdx * SymbolTableEntrySize;
849 Sym.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
850 return symbol_iterator(SymbolRef(Sym, this));
853 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
854 uint64_t &Res) const {
855 MachO::any_relocation_info RE = getRelocation(Rel);
856 Res = getAnyRelocationType(RE);
857 return object_error::success;
861 MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
862 SmallVectorImpl<char> &Result) const {
865 getRelocationType(Rel, RType);
867 unsigned Arch = this->getArch();
871 static const char *const Table[] = {
872 "GENERIC_RELOC_VANILLA",
873 "GENERIC_RELOC_PAIR",
874 "GENERIC_RELOC_SECTDIFF",
875 "GENERIC_RELOC_PB_LA_PTR",
876 "GENERIC_RELOC_LOCAL_SECTDIFF",
877 "GENERIC_RELOC_TLV" };
885 case Triple::x86_64: {
886 static const char *const Table[] = {
887 "X86_64_RELOC_UNSIGNED",
888 "X86_64_RELOC_SIGNED",
889 "X86_64_RELOC_BRANCH",
890 "X86_64_RELOC_GOT_LOAD",
892 "X86_64_RELOC_SUBTRACTOR",
893 "X86_64_RELOC_SIGNED_1",
894 "X86_64_RELOC_SIGNED_2",
895 "X86_64_RELOC_SIGNED_4",
896 "X86_64_RELOC_TLV" };
905 static const char *const Table[] = {
908 "ARM_RELOC_SECTDIFF",
909 "ARM_RELOC_LOCAL_SECTDIFF",
910 "ARM_RELOC_PB_LA_PTR",
912 "ARM_THUMB_RELOC_BR22",
913 "ARM_THUMB_32BIT_BRANCH",
915 "ARM_RELOC_HALF_SECTDIFF" };
924 static const char *const Table[] = {
933 "PPC_RELOC_SECTDIFF",
934 "PPC_RELOC_PB_LA_PTR",
935 "PPC_RELOC_HI16_SECTDIFF",
936 "PPC_RELOC_LO16_SECTDIFF",
937 "PPC_RELOC_HA16_SECTDIFF",
939 "PPC_RELOC_LO14_SECTDIFF",
940 "PPC_RELOC_LOCAL_SECTDIFF" };
948 case Triple::UnknownArch:
952 Result.append(res.begin(), res.end());
953 return object_error::success;
957 MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
958 SmallVectorImpl<char> &Result) const {
959 MachO::any_relocation_info RE = getRelocation(Rel);
961 unsigned Arch = this->getArch();
964 raw_string_ostream fmt(fmtbuf);
965 unsigned Type = this->getAnyRelocationType(RE);
966 bool IsPCRel = this->getAnyRelocationPCRel(RE);
968 // Determine any addends that should be displayed with the relocation.
969 // These require decoding the relocation type, which is triple-specific.
971 // X86_64 has entirely custom relocation types.
972 if (Arch == Triple::x86_64) {
973 bool isPCRel = getAnyRelocationPCRel(RE);
976 case MachO::X86_64_RELOC_GOT_LOAD:
977 case MachO::X86_64_RELOC_GOT: {
978 printRelocationTargetName(this, RE, fmt);
980 if (isPCRel) fmt << "PCREL";
983 case MachO::X86_64_RELOC_SUBTRACTOR: {
984 DataRefImpl RelNext = Rel;
986 MachO::any_relocation_info RENext = getRelocation(RelNext);
988 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
989 // X86_64_RELOC_UNSIGNED.
990 // NOTE: Scattered relocations don't exist on x86_64.
991 unsigned RType = getAnyRelocationType(RENext);
992 if (RType != MachO::X86_64_RELOC_UNSIGNED)
993 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
994 "X86_64_RELOC_SUBTRACTOR.");
996 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
997 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
998 printRelocationTargetName(this, RENext, fmt);
1000 printRelocationTargetName(this, RE, fmt);
1003 case MachO::X86_64_RELOC_TLV:
1004 printRelocationTargetName(this, RE, fmt);
1006 if (isPCRel) fmt << "P";
1008 case MachO::X86_64_RELOC_SIGNED_1:
1009 printRelocationTargetName(this, RE, fmt);
1012 case MachO::X86_64_RELOC_SIGNED_2:
1013 printRelocationTargetName(this, RE, fmt);
1016 case MachO::X86_64_RELOC_SIGNED_4:
1017 printRelocationTargetName(this, RE, fmt);
1021 printRelocationTargetName(this, RE, fmt);
1024 // X86 and ARM share some relocation types in common.
1025 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
1026 Arch == Triple::ppc) {
1027 // Generic relocation types...
1029 case MachO::GENERIC_RELOC_PAIR: // prints no info
1030 return object_error::success;
1031 case MachO::GENERIC_RELOC_SECTDIFF: {
1032 DataRefImpl RelNext = Rel;
1034 MachO::any_relocation_info RENext = getRelocation(RelNext);
1036 // X86 sect diff's must be followed by a relocation of type
1037 // GENERIC_RELOC_PAIR.
1038 unsigned RType = getAnyRelocationType(RENext);
1040 if (RType != MachO::GENERIC_RELOC_PAIR)
1041 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1042 "GENERIC_RELOC_SECTDIFF.");
1044 printRelocationTargetName(this, RE, fmt);
1046 printRelocationTargetName(this, RENext, fmt);
1051 if (Arch == Triple::x86 || Arch == Triple::ppc) {
1053 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
1054 DataRefImpl RelNext = Rel;
1056 MachO::any_relocation_info RENext = getRelocation(RelNext);
1058 // X86 sect diff's must be followed by a relocation of type
1059 // GENERIC_RELOC_PAIR.
1060 unsigned RType = getAnyRelocationType(RENext);
1061 if (RType != MachO::GENERIC_RELOC_PAIR)
1062 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1063 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1065 printRelocationTargetName(this, RE, fmt);
1067 printRelocationTargetName(this, RENext, fmt);
1070 case MachO::GENERIC_RELOC_TLV: {
1071 printRelocationTargetName(this, RE, fmt);
1073 if (IsPCRel) fmt << "P";
1077 printRelocationTargetName(this, RE, fmt);
1079 } else { // ARM-specific relocations
1081 case MachO::ARM_RELOC_HALF:
1082 case MachO::ARM_RELOC_HALF_SECTDIFF: {
1083 // Half relocations steal a bit from the length field to encode
1084 // whether this is an upper16 or a lower16 relocation.
1085 bool isUpper = getAnyRelocationLength(RE) >> 1;
1088 fmt << ":upper16:(";
1090 fmt << ":lower16:(";
1091 printRelocationTargetName(this, RE, fmt);
1093 DataRefImpl RelNext = Rel;
1095 MachO::any_relocation_info RENext = getRelocation(RelNext);
1097 // ARM half relocs must be followed by a relocation of type
1099 unsigned RType = getAnyRelocationType(RENext);
1100 if (RType != MachO::ARM_RELOC_PAIR)
1101 report_fatal_error("Expected ARM_RELOC_PAIR after "
1104 // NOTE: The half of the target virtual address is stashed in the
1105 // address field of the secondary relocation, but we can't reverse
1106 // engineer the constant offset from it without decoding the movw/movt
1107 // instruction to find the other half in its immediate field.
1109 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1110 // symbol/section pointer of the follow-on relocation.
1111 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
1113 printRelocationTargetName(this, RENext, fmt);
1120 printRelocationTargetName(this, RE, fmt);
1125 printRelocationTargetName(this, RE, fmt);
1128 Result.append(fmtbuf.begin(), fmtbuf.end());
1129 return object_error::success;
1133 MachOObjectFile::getRelocationHidden(DataRefImpl Rel, bool &Result) const {
1134 unsigned Arch = getArch();
1136 getRelocationType(Rel, Type);
1140 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1141 // is always hidden.
1142 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
1143 if (Type == MachO::GENERIC_RELOC_PAIR) Result = true;
1144 } else if (Arch == Triple::x86_64) {
1145 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1146 // an X86_64_RELOC_SUBTRACTOR.
1147 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
1148 DataRefImpl RelPrev = Rel;
1151 getRelocationType(RelPrev, PrevType);
1152 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
1157 return object_error::success;
1160 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1161 LibraryRef &Res) const {
1162 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1165 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1166 StringRef &Res) const {
1167 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1170 symbol_iterator MachOObjectFile::begin_symbols() const {
1173 return symbol_iterator(SymbolRef(DRI, this));
1175 MachO::symtab_command Symtab = getSymtabLoadCommand();
1176 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Symtab.symoff));
1177 return symbol_iterator(SymbolRef(DRI, this));
1180 symbol_iterator MachOObjectFile::end_symbols() const {
1183 return symbol_iterator(SymbolRef(DRI, this));
1185 MachO::symtab_command Symtab = getSymtabLoadCommand();
1186 unsigned SymbolTableEntrySize = is64Bit() ?
1187 sizeof(MachO::nlist_64) :
1188 sizeof(MachO::nlist);
1189 unsigned Offset = Symtab.symoff +
1190 Symtab.nsyms * SymbolTableEntrySize;
1191 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1192 return symbol_iterator(SymbolRef(DRI, this));
1195 section_iterator MachOObjectFile::begin_sections() const {
1197 return section_iterator(SectionRef(DRI, this));
1200 section_iterator MachOObjectFile::end_sections() const {
1202 DRI.d.a = Sections.size();
1203 return section_iterator(SectionRef(DRI, this));
1206 library_iterator MachOObjectFile::begin_libraries_needed() const {
1208 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1211 library_iterator MachOObjectFile::end_libraries_needed() const {
1213 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1216 uint8_t MachOObjectFile::getBytesInAddress() const {
1217 return is64Bit() ? 8 : 4;
1220 StringRef MachOObjectFile::getFileFormatName() const {
1221 unsigned CPUType = getCPUType(this);
1224 case llvm::MachO::CPU_TYPE_I386:
1225 return "Mach-O 32-bit i386";
1226 case llvm::MachO::CPU_TYPE_ARM:
1227 return "Mach-O arm";
1228 case llvm::MachO::CPU_TYPE_POWERPC:
1229 return "Mach-O 32-bit ppc";
1231 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64) == 0 &&
1232 "64-bit object file when we're not 64-bit?");
1233 return "Mach-O 32-bit unknown";
1237 // Make sure the cpu type has the correct mask.
1238 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64)
1239 == llvm::MachO::CPU_ARCH_ABI64 &&
1240 "32-bit object file when we're 64-bit?");
1243 case llvm::MachO::CPU_TYPE_X86_64:
1244 return "Mach-O 64-bit x86-64";
1245 case llvm::MachO::CPU_TYPE_POWERPC64:
1246 return "Mach-O 64-bit ppc64";
1248 return "Mach-O 64-bit unknown";
1252 Triple::ArchType MachOObjectFile::getArch(uint32_t CPUType) {
1254 case llvm::MachO::CPU_TYPE_I386:
1256 case llvm::MachO::CPU_TYPE_X86_64:
1257 return Triple::x86_64;
1258 case llvm::MachO::CPU_TYPE_ARM:
1260 case llvm::MachO::CPU_TYPE_POWERPC:
1262 case llvm::MachO::CPU_TYPE_POWERPC64:
1263 return Triple::ppc64;
1265 return Triple::UnknownArch;
1269 unsigned MachOObjectFile::getArch() const {
1270 return getArch(getCPUType(this));
1273 StringRef MachOObjectFile::getLoadName() const {
1275 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
1278 relocation_iterator MachOObjectFile::section_rel_begin(unsigned Index) const {
1281 return section_rel_begin(DRI);
1284 relocation_iterator MachOObjectFile::section_rel_end(unsigned Index) const {
1287 return section_rel_end(DRI);
1290 dice_iterator MachOObjectFile::begin_dices() const {
1292 if (!DataInCodeLoadCmd)
1293 return dice_iterator(DiceRef(DRI, this));
1295 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1296 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, DicLC.dataoff));
1297 return dice_iterator(DiceRef(DRI, this));
1300 dice_iterator MachOObjectFile::end_dices() const {
1302 if (!DataInCodeLoadCmd)
1303 return dice_iterator(DiceRef(DRI, this));
1305 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1306 unsigned Offset = DicLC.dataoff + DicLC.datasize;
1307 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1308 return dice_iterator(DiceRef(DRI, this));
1312 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
1313 ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
1314 return parseSegmentOrSectionName(Raw.data());
1318 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
1319 const section_base *Base =
1320 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1321 return ArrayRef<char>(Base->sectname);
1325 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
1326 const section_base *Base =
1327 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1328 return ArrayRef<char>(Base->segname);
1332 MachOObjectFile::isRelocationScattered(const MachO::any_relocation_info &RE)
1334 if (getCPUType(this) == MachO::CPU_TYPE_X86_64)
1336 return getPlainRelocationAddress(RE) & MachO::R_SCATTERED;
1339 unsigned MachOObjectFile::getPlainRelocationSymbolNum(
1340 const MachO::any_relocation_info &RE) const {
1341 if (isLittleEndian())
1342 return RE.r_word1 & 0xffffff;
1343 return RE.r_word1 >> 8;
1346 bool MachOObjectFile::getPlainRelocationExternal(
1347 const MachO::any_relocation_info &RE) const {
1348 if (isLittleEndian())
1349 return (RE.r_word1 >> 27) & 1;
1350 return (RE.r_word1 >> 4) & 1;
1353 bool MachOObjectFile::getScatteredRelocationScattered(
1354 const MachO::any_relocation_info &RE) const {
1355 return RE.r_word0 >> 31;
1358 uint32_t MachOObjectFile::getScatteredRelocationValue(
1359 const MachO::any_relocation_info &RE) const {
1363 unsigned MachOObjectFile::getAnyRelocationAddress(
1364 const MachO::any_relocation_info &RE) const {
1365 if (isRelocationScattered(RE))
1366 return getScatteredRelocationAddress(RE);
1367 return getPlainRelocationAddress(RE);
1370 unsigned MachOObjectFile::getAnyRelocationPCRel(
1371 const MachO::any_relocation_info &RE) const {
1372 if (isRelocationScattered(RE))
1373 return getScatteredRelocationPCRel(this, RE);
1374 return getPlainRelocationPCRel(this, RE);
1377 unsigned MachOObjectFile::getAnyRelocationLength(
1378 const MachO::any_relocation_info &RE) const {
1379 if (isRelocationScattered(RE))
1380 return getScatteredRelocationLength(RE);
1381 return getPlainRelocationLength(this, RE);
1385 MachOObjectFile::getAnyRelocationType(
1386 const MachO::any_relocation_info &RE) const {
1387 if (isRelocationScattered(RE))
1388 return getScatteredRelocationType(RE);
1389 return getPlainRelocationType(this, RE);
1393 MachOObjectFile::getRelocationSection(
1394 const MachO::any_relocation_info &RE) const {
1395 if (isRelocationScattered(RE) || getPlainRelocationExternal(RE))
1396 return *end_sections();
1397 unsigned SecNum = getPlainRelocationSymbolNum(RE) - 1;
1400 return SectionRef(DRI, this);
1403 MachOObjectFile::LoadCommandInfo
1404 MachOObjectFile::getFirstLoadCommandInfo() const {
1405 MachOObjectFile::LoadCommandInfo Load;
1407 unsigned HeaderSize = is64Bit() ? sizeof(MachO::mach_header_64) :
1408 sizeof(MachO::mach_header);
1409 Load.Ptr = getPtr(this, HeaderSize);
1410 Load.C = getStruct<MachO::load_command>(this, Load.Ptr);
1414 MachOObjectFile::LoadCommandInfo
1415 MachOObjectFile::getNextLoadCommandInfo(const LoadCommandInfo &L) const {
1416 MachOObjectFile::LoadCommandInfo Next;
1417 Next.Ptr = L.Ptr + L.C.cmdsize;
1418 Next.C = getStruct<MachO::load_command>(this, Next.Ptr);
1422 MachO::section MachOObjectFile::getSection(DataRefImpl DRI) const {
1423 return getStruct<MachO::section>(this, Sections[DRI.d.a]);
1426 MachO::section_64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
1427 return getStruct<MachO::section_64>(this, Sections[DRI.d.a]);
1430 MachO::section MachOObjectFile::getSection(const LoadCommandInfo &L,
1431 unsigned Index) const {
1432 const char *Sec = getSectionPtr(this, L, Index);
1433 return getStruct<MachO::section>(this, Sec);
1436 MachO::section_64 MachOObjectFile::getSection64(const LoadCommandInfo &L,
1437 unsigned Index) const {
1438 const char *Sec = getSectionPtr(this, L, Index);
1439 return getStruct<MachO::section_64>(this, Sec);
1443 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
1444 const char *P = reinterpret_cast<const char *>(DRI.p);
1445 return getStruct<MachO::nlist>(this, P);
1449 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
1450 const char *P = reinterpret_cast<const char *>(DRI.p);
1451 return getStruct<MachO::nlist_64>(this, P);
1454 MachO::linkedit_data_command
1455 MachOObjectFile::getLinkeditDataLoadCommand(const LoadCommandInfo &L) const {
1456 return getStruct<MachO::linkedit_data_command>(this, L.Ptr);
1459 MachO::segment_command
1460 MachOObjectFile::getSegmentLoadCommand(const LoadCommandInfo &L) const {
1461 return getStruct<MachO::segment_command>(this, L.Ptr);
1464 MachO::segment_command_64
1465 MachOObjectFile::getSegment64LoadCommand(const LoadCommandInfo &L) const {
1466 return getStruct<MachO::segment_command_64>(this, L.Ptr);
1469 MachO::linker_options_command
1470 MachOObjectFile::getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const {
1471 return getStruct<MachO::linker_options_command>(this, L.Ptr);
1474 MachO::any_relocation_info
1475 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
1476 const char *P = reinterpret_cast<const char *>(Rel.p);
1477 return getStruct<MachO::any_relocation_info>(this, P);
1480 MachO::data_in_code_entry
1481 MachOObjectFile::getDice(DataRefImpl Rel) const {
1482 const char *P = reinterpret_cast<const char *>(Rel.p);
1483 return getStruct<MachO::data_in_code_entry>(this, P);
1486 MachO::mach_header MachOObjectFile::getHeader() const {
1487 return getStruct<MachO::mach_header>(this, getPtr(this, 0));
1490 MachO::mach_header_64 MachOObjectFile::getHeader64() const {
1491 return getStruct<MachO::mach_header_64>(this, getPtr(this, 0));
1494 uint32_t MachOObjectFile::getIndirectSymbolTableEntry(
1495 const MachO::dysymtab_command &DLC,
1496 unsigned Index) const {
1497 uint64_t Offset = DLC.indirectsymoff + Index * sizeof(uint32_t);
1498 return getStruct<uint32_t>(this, getPtr(this, Offset));
1501 MachO::data_in_code_entry
1502 MachOObjectFile::getDataInCodeTableEntry(uint32_t DataOffset,
1503 unsigned Index) const {
1504 uint64_t Offset = DataOffset + Index * sizeof(MachO::data_in_code_entry);
1505 return getStruct<MachO::data_in_code_entry>(this, getPtr(this, Offset));
1508 MachO::symtab_command MachOObjectFile::getSymtabLoadCommand() const {
1509 return getStruct<MachO::symtab_command>(this, SymtabLoadCmd);
1512 MachO::dysymtab_command MachOObjectFile::getDysymtabLoadCommand() const {
1513 return getStruct<MachO::dysymtab_command>(this, DysymtabLoadCmd);
1516 MachO::linkedit_data_command
1517 MachOObjectFile::getDataInCodeLoadCommand() const {
1518 if (DataInCodeLoadCmd)
1519 return getStruct<MachO::linkedit_data_command>(this, DataInCodeLoadCmd);
1521 // If there is no DataInCodeLoadCmd return a load command with zero'ed fields.
1522 MachO::linkedit_data_command Cmd;
1523 Cmd.cmd = MachO::LC_DATA_IN_CODE;
1524 Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
1530 StringRef MachOObjectFile::getStringTableData() const {
1531 MachO::symtab_command S = getSymtabLoadCommand();
1532 return getData().substr(S.stroff, S.strsize);
1535 bool MachOObjectFile::is64Bit() const {
1536 return getType() == getMachOType(false, true) ||
1537 getType() == getMachOType(true, true);
1540 void MachOObjectFile::ReadULEB128s(uint64_t Index,
1541 SmallVectorImpl<uint64_t> &Out) const {
1542 DataExtractor extractor(ObjectFile::getData(), true, 0);
1544 uint32_t offset = Index;
1546 while (uint64_t delta = extractor.getULEB128(&offset)) {
1548 Out.push_back(data);
1552 ErrorOr<ObjectFile *> ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer,
1554 StringRef Magic = Buffer->getBuffer().slice(0, 4);
1556 OwningPtr<MachOObjectFile> Ret;
1557 if (Magic == "\xFE\xED\xFA\xCE")
1558 Ret.reset(new MachOObjectFile(Buffer, false, false, EC, BufferOwned));
1559 else if (Magic == "\xCE\xFA\xED\xFE")
1560 Ret.reset(new MachOObjectFile(Buffer, true, false, EC, BufferOwned));
1561 else if (Magic == "\xFE\xED\xFA\xCF")
1562 Ret.reset(new MachOObjectFile(Buffer, false, true, EC, BufferOwned));
1563 else if (Magic == "\xCF\xFA\xED\xFE")
1564 Ret.reset(new MachOObjectFile(Buffer, true, true, EC, BufferOwned));
1567 return object_error::parse_failed;
1575 } // end namespace object
1576 } // end namespace llvm