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 error_code advance(T &it, size_t Val) {
287 static void advanceTo(T &it, size_t Val) {
288 if (error_code ec = advance(it, Val))
289 report_fatal_error(ec.message());
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);
309 for (symbol_iterator SI = O->begin_symbols(), SE = O->end_symbols();
310 SI != SE; SI.increment(ec)) {
311 if (ec) report_fatal_error(ec.message());
316 if ((ec = SI->getAddress(Addr)))
317 report_fatal_error(ec.message());
318 if (Addr != Val) continue;
319 if ((ec = SI->getName(Name)))
320 report_fatal_error(ec.message());
325 // If we couldn't find a symbol that this relocation refers to, try
326 // to find a section beginning instead.
327 for (section_iterator SI = O->begin_sections(), SE = O->end_sections();
328 SI != SE; SI.increment(ec)) {
329 if (ec) report_fatal_error(ec.message());
334 if ((ec = SI->getAddress(Addr)))
335 report_fatal_error(ec.message());
336 if (Addr != Val) continue;
337 if ((ec = SI->getName(Name)))
338 report_fatal_error(ec.message());
343 fmt << format("0x%x", Val);
348 bool isExtern = O->getPlainRelocationExternal(RE);
349 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
352 symbol_iterator SI = O->begin_symbols();
356 section_iterator SI = O->begin_sections();
357 // Adjust for the fact that sections are 1-indexed.
358 advanceTo(SI, Val - 1);
366 getPlainRelocationAddress(const MachO::any_relocation_info &RE) {
371 getScatteredRelocationAddress(const MachO::any_relocation_info &RE) {
372 return RE.r_word0 & 0xffffff;
375 static bool getPlainRelocationPCRel(const MachOObjectFile *O,
376 const MachO::any_relocation_info &RE) {
377 if (O->isLittleEndian())
378 return (RE.r_word1 >> 24) & 1;
379 return (RE.r_word1 >> 7) & 1;
383 getScatteredRelocationPCRel(const MachOObjectFile *O,
384 const MachO::any_relocation_info &RE) {
385 return (RE.r_word0 >> 30) & 1;
388 static unsigned getPlainRelocationLength(const MachOObjectFile *O,
389 const MachO::any_relocation_info &RE) {
390 if (O->isLittleEndian())
391 return (RE.r_word1 >> 25) & 3;
392 return (RE.r_word1 >> 5) & 3;
396 getScatteredRelocationLength(const MachO::any_relocation_info &RE) {
397 return (RE.r_word0 >> 28) & 3;
400 static unsigned getPlainRelocationType(const MachOObjectFile *O,
401 const MachO::any_relocation_info &RE) {
402 if (O->isLittleEndian())
403 return RE.r_word1 >> 28;
404 return RE.r_word1 & 0xf;
408 getScatteredRelocationType(const MachO::any_relocation_info &RE) {
409 return (RE.r_word0 >> 24) & 0xf;
412 static uint32_t getSectionFlags(const MachOObjectFile *O,
415 MachO::section_64 Sect = O->getSection64(Sec);
418 MachO::section Sect = O->getSection(Sec);
422 MachOObjectFile::MachOObjectFile(MemoryBuffer *Object,
423 bool IsLittleEndian, bool Is64bits,
425 : ObjectFile(getMachOType(IsLittleEndian, Is64bits), Object),
426 SymtabLoadCmd(NULL), DysymtabLoadCmd(NULL), DataInCodeLoadCmd(NULL) {
427 uint32_t LoadCommandCount = this->getHeader().ncmds;
428 MachO::LoadCommandType SegmentLoadType = is64Bit() ?
429 MachO::LC_SEGMENT_64 : MachO::LC_SEGMENT;
431 MachOObjectFile::LoadCommandInfo Load = getFirstLoadCommandInfo();
432 for (unsigned I = 0; ; ++I) {
433 if (Load.C.cmd == MachO::LC_SYMTAB) {
434 assert(!SymtabLoadCmd && "Multiple symbol tables");
435 SymtabLoadCmd = Load.Ptr;
436 } else if (Load.C.cmd == MachO::LC_DYSYMTAB) {
437 assert(!DysymtabLoadCmd && "Multiple dynamic symbol tables");
438 DysymtabLoadCmd = Load.Ptr;
439 } else if (Load.C.cmd == MachO::LC_DATA_IN_CODE) {
440 assert(!DataInCodeLoadCmd && "Multiple data in code tables");
441 DataInCodeLoadCmd = Load.Ptr;
442 } else if (Load.C.cmd == SegmentLoadType) {
443 uint32_t NumSections = getSegmentLoadCommandNumSections(this, Load);
444 for (unsigned J = 0; J < NumSections; ++J) {
445 const char *Sec = getSectionPtr(this, Load, J);
446 Sections.push_back(Sec);
450 if (I == LoadCommandCount - 1)
453 Load = getNextLoadCommandInfo(Load);
457 error_code MachOObjectFile::getSymbolNext(DataRefImpl Symb,
458 SymbolRef &Res) const {
459 unsigned SymbolTableEntrySize = is64Bit() ?
460 sizeof(MachO::nlist_64) :
461 sizeof(MachO::nlist);
462 Symb.p += SymbolTableEntrySize;
463 Res = SymbolRef(Symb, this);
464 return object_error::success;
467 error_code MachOObjectFile::getSymbolName(DataRefImpl Symb,
468 StringRef &Res) const {
469 StringRef StringTable = getStringTableData();
470 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
471 const char *Start = &StringTable.data()[Entry.n_strx];
472 Res = StringRef(Start);
473 return object_error::success;
476 error_code MachOObjectFile::getSymbolAddress(DataRefImpl Symb,
477 uint64_t &Res) const {
479 MachO::nlist_64 Entry = getSymbol64TableEntry(Symb);
482 MachO::nlist Entry = getSymbolTableEntry(Symb);
485 return object_error::success;
489 MachOObjectFile::getSymbolFileOffset(DataRefImpl Symb,
490 uint64_t &Res) const {
491 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
492 getSymbolAddress(Symb, Res);
496 SecRel.d.a = Entry.n_sect-1;
498 MachO::section_64 Sec = getSection64(SecRel);
499 Delta = Sec.offset - Sec.addr;
501 MachO::section Sec = getSection(SecRel);
502 Delta = Sec.offset - Sec.addr;
508 return object_error::success;
511 error_code MachOObjectFile::getSymbolAlignment(DataRefImpl DRI,
512 uint32_t &Result) const {
514 this->getSymbolFlags(DRI, flags);
515 if (flags & SymbolRef::SF_Common) {
516 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
517 Result = 1 << MachO::GET_COMM_ALIGN(Entry.n_desc);
521 return object_error::success;
524 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
525 uint64_t &Result) const {
526 uint64_t BeginOffset;
527 uint64_t EndOffset = 0;
528 uint8_t SectionIndex;
530 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
532 getSymbolAddress(DRI, Value);
536 SectionIndex = Entry.n_sect;
538 uint32_t flags = SymbolRef::SF_None;
539 this->getSymbolFlags(DRI, flags);
540 if (flags & SymbolRef::SF_Common)
543 Result = UnknownAddressOrSize;
544 return object_error::success;
546 // Unfortunately symbols are unsorted so we need to touch all
547 // symbols from load command
549 for (symbol_iterator I = begin_symbols(), E = end_symbols(); I != E;
551 DataRefImpl DRI = I->getRawDataRefImpl();
552 Entry = getSymbolTableEntryBase(this, DRI);
553 getSymbolAddress(DRI, Value);
554 if (Entry.n_sect == SectionIndex && Value > BeginOffset)
555 if (!EndOffset || Value < EndOffset)
561 Sec.d.a = SectionIndex-1;
562 getSectionSize(Sec, Size);
563 getSectionAddress(Sec, EndOffset);
566 Result = EndOffset - BeginOffset;
567 return object_error::success;
570 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
571 SymbolRef::Type &Res) const {
572 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
573 uint8_t n_type = Entry.n_type;
575 Res = SymbolRef::ST_Other;
577 // If this is a STAB debugging symbol, we can do nothing more.
578 if (n_type & MachO::N_STAB) {
579 Res = SymbolRef::ST_Debug;
580 return object_error::success;
583 switch (n_type & MachO::N_TYPE) {
585 Res = SymbolRef::ST_Unknown;
588 Res = SymbolRef::ST_Function;
591 return object_error::success;
594 error_code MachOObjectFile::getSymbolNMTypeChar(DataRefImpl Symb,
596 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
597 uint8_t Type = Entry.n_type;
598 uint16_t Flags = Entry.n_desc;
601 switch (Type & MachO::N_TYPE) {
614 if (Flags & (MachO::N_EXT | MachO::N_PEXT))
615 Char = toupper(static_cast<unsigned char>(Char));
617 return object_error::success;
620 error_code MachOObjectFile::getSymbolFlags(DataRefImpl DRI,
621 uint32_t &Result) const {
622 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
624 uint8_t MachOType = Entry.n_type;
625 uint16_t MachOFlags = Entry.n_desc;
627 // TODO: Correctly set SF_ThreadLocal
628 Result = SymbolRef::SF_None;
630 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF)
631 Result |= SymbolRef::SF_Undefined;
633 if (MachOFlags & MachO::N_STAB)
634 Result |= SymbolRef::SF_FormatSpecific;
636 if (MachOType & MachO::N_EXT) {
637 Result |= SymbolRef::SF_Global;
638 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF) {
640 getSymbolAddress(DRI, Value);
642 Result |= SymbolRef::SF_Common;
646 if (MachOFlags & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
647 Result |= SymbolRef::SF_Weak;
649 if ((MachOType & MachO::N_TYPE) == MachO::N_ABS)
650 Result |= SymbolRef::SF_Absolute;
652 return object_error::success;
656 MachOObjectFile::getSymbolSection(DataRefImpl Symb,
657 section_iterator &Res) const {
658 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
659 uint8_t index = Entry.n_sect;
662 Res = end_sections();
666 Res = section_iterator(SectionRef(DRI, this));
669 return object_error::success;
672 error_code MachOObjectFile::getSymbolValue(DataRefImpl Symb,
673 uint64_t &Val) const {
674 report_fatal_error("getSymbolValue unimplemented in MachOObjectFile");
677 error_code MachOObjectFile::getSectionNext(DataRefImpl Sec,
678 SectionRef &Res) const {
680 Res = SectionRef(Sec, this);
681 return object_error::success;
685 MachOObjectFile::getSectionName(DataRefImpl Sec, StringRef &Result) const {
686 ArrayRef<char> Raw = getSectionRawName(Sec);
687 Result = parseSegmentOrSectionName(Raw.data());
688 return object_error::success;
692 MachOObjectFile::getSectionAddress(DataRefImpl Sec, uint64_t &Res) const {
694 MachO::section_64 Sect = getSection64(Sec);
697 MachO::section Sect = getSection(Sec);
700 return object_error::success;
704 MachOObjectFile::getSectionSize(DataRefImpl Sec, uint64_t &Res) const {
706 MachO::section_64 Sect = getSection64(Sec);
709 MachO::section Sect = getSection(Sec);
713 return object_error::success;
717 MachOObjectFile::getSectionContents(DataRefImpl Sec, StringRef &Res) const {
722 MachO::section_64 Sect = getSection64(Sec);
723 Offset = Sect.offset;
726 MachO::section Sect = getSection(Sec);
727 Offset = Sect.offset;
731 Res = this->getData().substr(Offset, Size);
732 return object_error::success;
736 MachOObjectFile::getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const {
739 MachO::section_64 Sect = getSection64(Sec);
742 MachO::section Sect = getSection(Sec);
746 Res = uint64_t(1) << Align;
747 return object_error::success;
751 MachOObjectFile::isSectionText(DataRefImpl Sec, bool &Res) const {
752 uint32_t Flags = getSectionFlags(this, Sec);
753 Res = Flags & MachO::S_ATTR_PURE_INSTRUCTIONS;
754 return object_error::success;
757 error_code MachOObjectFile::isSectionData(DataRefImpl DRI, bool &Result) const {
758 // FIXME: Unimplemented.
760 return object_error::success;
763 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI, bool &Result) const {
764 // FIXME: Unimplemented.
766 return object_error::success;
770 MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
771 bool &Result) const {
772 // FIXME: Unimplemented.
774 return object_error::success;
777 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
778 bool &Result) const {
779 // FIXME: Unimplemented.
781 return object_error::success;
785 MachOObjectFile::isSectionZeroInit(DataRefImpl Sec, bool &Res) const {
786 uint32_t Flags = getSectionFlags(this, Sec);
787 unsigned SectionType = Flags & MachO::SECTION_TYPE;
788 Res = SectionType == MachO::S_ZEROFILL ||
789 SectionType == MachO::S_GB_ZEROFILL;
790 return object_error::success;
793 error_code MachOObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
794 bool &Result) const {
795 // Consider using the code from isSectionText to look for __const sections.
796 // Alternately, emit S_ATTR_PURE_INSTRUCTIONS and/or S_ATTR_SOME_INSTRUCTIONS
797 // to use section attributes to distinguish code from data.
799 // FIXME: Unimplemented.
801 return object_error::success;
805 MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
806 bool &Result) const {
808 this->getSymbolType(Symb, ST);
809 if (ST == SymbolRef::ST_Unknown) {
811 return object_error::success;
814 uint64_t SectBegin, SectEnd;
815 getSectionAddress(Sec, SectBegin);
816 getSectionSize(Sec, SectEnd);
817 SectEnd += SectBegin;
820 getSymbolAddress(Symb, SymAddr);
821 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
823 return object_error::success;
826 relocation_iterator MachOObjectFile::section_rel_begin(DataRefImpl Sec) const {
829 MachO::section_64 Sect = getSection64(Sec);
830 Offset = Sect.reloff;
832 MachO::section Sect = getSection(Sec);
833 Offset = Sect.reloff;
837 Ret.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
838 return relocation_iterator(RelocationRef(Ret, this));
842 MachOObjectFile::section_rel_end(DataRefImpl Sec) const {
846 MachO::section_64 Sect = getSection64(Sec);
847 Offset = Sect.reloff;
850 MachO::section Sect = getSection(Sec);
851 Offset = Sect.reloff;
855 const MachO::any_relocation_info *P =
856 reinterpret_cast<const MachO::any_relocation_info *>(getPtr(this, Offset));
859 Ret.p = reinterpret_cast<uintptr_t>(P + Num);
860 return relocation_iterator(RelocationRef(Ret, this));
863 error_code MachOObjectFile::getRelocationNext(DataRefImpl Rel,
864 RelocationRef &Res) const {
865 const MachO::any_relocation_info *P =
866 reinterpret_cast<const MachO::any_relocation_info *>(Rel.p);
867 Rel.p = reinterpret_cast<uintptr_t>(P + 1);
868 Res = RelocationRef(Rel, this);
869 return object_error::success;
873 MachOObjectFile::getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const {
874 report_fatal_error("getRelocationAddress not implemented in MachOObjectFile");
877 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
878 uint64_t &Res) const {
879 MachO::any_relocation_info RE = getRelocation(Rel);
880 Res = getAnyRelocationAddress(RE);
881 return object_error::success;
885 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
886 MachO::any_relocation_info RE = getRelocation(Rel);
887 uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
888 bool isExtern = getPlainRelocationExternal(RE);
890 return end_symbols();
892 MachO::symtab_command S = getSymtabLoadCommand();
893 unsigned SymbolTableEntrySize = is64Bit() ?
894 sizeof(MachO::nlist_64) :
895 sizeof(MachO::nlist);
896 uint64_t Offset = S.symoff + SymbolIdx * SymbolTableEntrySize;
898 Sym.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
899 return symbol_iterator(SymbolRef(Sym, this));
902 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
903 uint64_t &Res) const {
904 MachO::any_relocation_info RE = getRelocation(Rel);
905 Res = getAnyRelocationType(RE);
906 return object_error::success;
910 MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
911 SmallVectorImpl<char> &Result) const {
914 getRelocationType(Rel, RType);
916 unsigned Arch = this->getArch();
920 static const char *const Table[] = {
921 "GENERIC_RELOC_VANILLA",
922 "GENERIC_RELOC_PAIR",
923 "GENERIC_RELOC_SECTDIFF",
924 "GENERIC_RELOC_PB_LA_PTR",
925 "GENERIC_RELOC_LOCAL_SECTDIFF",
926 "GENERIC_RELOC_TLV" };
934 case Triple::x86_64: {
935 static const char *const Table[] = {
936 "X86_64_RELOC_UNSIGNED",
937 "X86_64_RELOC_SIGNED",
938 "X86_64_RELOC_BRANCH",
939 "X86_64_RELOC_GOT_LOAD",
941 "X86_64_RELOC_SUBTRACTOR",
942 "X86_64_RELOC_SIGNED_1",
943 "X86_64_RELOC_SIGNED_2",
944 "X86_64_RELOC_SIGNED_4",
945 "X86_64_RELOC_TLV" };
954 static const char *const Table[] = {
957 "ARM_RELOC_SECTDIFF",
958 "ARM_RELOC_LOCAL_SECTDIFF",
959 "ARM_RELOC_PB_LA_PTR",
961 "ARM_THUMB_RELOC_BR22",
962 "ARM_THUMB_32BIT_BRANCH",
964 "ARM_RELOC_HALF_SECTDIFF" };
973 static const char *const Table[] = {
982 "PPC_RELOC_SECTDIFF",
983 "PPC_RELOC_PB_LA_PTR",
984 "PPC_RELOC_HI16_SECTDIFF",
985 "PPC_RELOC_LO16_SECTDIFF",
986 "PPC_RELOC_HA16_SECTDIFF",
988 "PPC_RELOC_LO14_SECTDIFF",
989 "PPC_RELOC_LOCAL_SECTDIFF" };
994 case Triple::UnknownArch:
998 Result.append(res.begin(), res.end());
999 return object_error::success;
1003 MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
1004 SmallVectorImpl<char> &Result) const {
1005 MachO::any_relocation_info RE = getRelocation(Rel);
1007 unsigned Arch = this->getArch();
1010 raw_string_ostream fmt(fmtbuf);
1011 unsigned Type = this->getAnyRelocationType(RE);
1012 bool IsPCRel = this->getAnyRelocationPCRel(RE);
1014 // Determine any addends that should be displayed with the relocation.
1015 // These require decoding the relocation type, which is triple-specific.
1017 // X86_64 has entirely custom relocation types.
1018 if (Arch == Triple::x86_64) {
1019 bool isPCRel = getAnyRelocationPCRel(RE);
1022 case MachO::X86_64_RELOC_GOT_LOAD:
1023 case MachO::X86_64_RELOC_GOT: {
1024 printRelocationTargetName(this, RE, fmt);
1026 if (isPCRel) fmt << "PCREL";
1029 case MachO::X86_64_RELOC_SUBTRACTOR: {
1030 DataRefImpl RelNext = Rel;
1032 MachO::any_relocation_info RENext = getRelocation(RelNext);
1034 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
1035 // X86_64_RELOC_UNSIGNED.
1036 // NOTE: Scattered relocations don't exist on x86_64.
1037 unsigned RType = getAnyRelocationType(RENext);
1038 if (RType != MachO::X86_64_RELOC_UNSIGNED)
1039 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
1040 "X86_64_RELOC_SUBTRACTOR.");
1042 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
1043 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
1044 printRelocationTargetName(this, RENext, fmt);
1046 printRelocationTargetName(this, RE, fmt);
1049 case MachO::X86_64_RELOC_TLV:
1050 printRelocationTargetName(this, RE, fmt);
1052 if (isPCRel) fmt << "P";
1054 case MachO::X86_64_RELOC_SIGNED_1:
1055 printRelocationTargetName(this, RE, fmt);
1058 case MachO::X86_64_RELOC_SIGNED_2:
1059 printRelocationTargetName(this, RE, fmt);
1062 case MachO::X86_64_RELOC_SIGNED_4:
1063 printRelocationTargetName(this, RE, fmt);
1067 printRelocationTargetName(this, RE, fmt);
1070 // X86 and ARM share some relocation types in common.
1071 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
1072 Arch == Triple::ppc) {
1073 // Generic relocation types...
1075 case MachO::GENERIC_RELOC_PAIR: // prints no info
1076 return object_error::success;
1077 case MachO::GENERIC_RELOC_SECTDIFF: {
1078 DataRefImpl RelNext = Rel;
1080 MachO::any_relocation_info RENext = getRelocation(RelNext);
1082 // X86 sect diff's must be followed by a relocation of type
1083 // GENERIC_RELOC_PAIR.
1084 unsigned RType = getAnyRelocationType(RENext);
1086 if (RType != MachO::GENERIC_RELOC_PAIR)
1087 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1088 "GENERIC_RELOC_SECTDIFF.");
1090 printRelocationTargetName(this, RE, fmt);
1092 printRelocationTargetName(this, RENext, fmt);
1097 if (Arch == Triple::x86 || Arch == Triple::ppc) {
1099 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
1100 DataRefImpl RelNext = Rel;
1102 MachO::any_relocation_info RENext = getRelocation(RelNext);
1104 // X86 sect diff's must be followed by a relocation of type
1105 // GENERIC_RELOC_PAIR.
1106 unsigned RType = getAnyRelocationType(RENext);
1107 if (RType != MachO::GENERIC_RELOC_PAIR)
1108 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1109 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1111 printRelocationTargetName(this, RE, fmt);
1113 printRelocationTargetName(this, RENext, fmt);
1116 case MachO::GENERIC_RELOC_TLV: {
1117 printRelocationTargetName(this, RE, fmt);
1119 if (IsPCRel) fmt << "P";
1123 printRelocationTargetName(this, RE, fmt);
1125 } else { // ARM-specific relocations
1127 case MachO::ARM_RELOC_HALF:
1128 case MachO::ARM_RELOC_HALF_SECTDIFF: {
1129 // Half relocations steal a bit from the length field to encode
1130 // whether this is an upper16 or a lower16 relocation.
1131 bool isUpper = getAnyRelocationLength(RE) >> 1;
1134 fmt << ":upper16:(";
1136 fmt << ":lower16:(";
1137 printRelocationTargetName(this, RE, fmt);
1139 DataRefImpl RelNext = Rel;
1141 MachO::any_relocation_info RENext = getRelocation(RelNext);
1143 // ARM half relocs must be followed by a relocation of type
1145 unsigned RType = getAnyRelocationType(RENext);
1146 if (RType != MachO::ARM_RELOC_PAIR)
1147 report_fatal_error("Expected ARM_RELOC_PAIR after "
1150 // NOTE: The half of the target virtual address is stashed in the
1151 // address field of the secondary relocation, but we can't reverse
1152 // engineer the constant offset from it without decoding the movw/movt
1153 // instruction to find the other half in its immediate field.
1155 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1156 // symbol/section pointer of the follow-on relocation.
1157 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
1159 printRelocationTargetName(this, RENext, fmt);
1166 printRelocationTargetName(this, RE, fmt);
1171 printRelocationTargetName(this, RE, fmt);
1174 Result.append(fmtbuf.begin(), fmtbuf.end());
1175 return object_error::success;
1179 MachOObjectFile::getRelocationHidden(DataRefImpl Rel, bool &Result) const {
1180 unsigned Arch = getArch();
1182 getRelocationType(Rel, Type);
1186 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1187 // is always hidden.
1188 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
1189 if (Type == MachO::GENERIC_RELOC_PAIR) Result = true;
1190 } else if (Arch == Triple::x86_64) {
1191 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1192 // an X86_64_RELOC_SUBTRACTOR.
1193 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
1194 DataRefImpl RelPrev = Rel;
1197 getRelocationType(RelPrev, PrevType);
1198 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
1203 return object_error::success;
1206 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1207 LibraryRef &Res) const {
1208 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1211 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1212 StringRef &Res) const {
1213 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1216 symbol_iterator MachOObjectFile::begin_symbols() const {
1219 return symbol_iterator(SymbolRef(DRI, this));
1221 MachO::symtab_command Symtab = getSymtabLoadCommand();
1222 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Symtab.symoff));
1223 return symbol_iterator(SymbolRef(DRI, this));
1226 symbol_iterator MachOObjectFile::end_symbols() const {
1229 return symbol_iterator(SymbolRef(DRI, this));
1231 MachO::symtab_command Symtab = getSymtabLoadCommand();
1232 unsigned SymbolTableEntrySize = is64Bit() ?
1233 sizeof(MachO::nlist_64) :
1234 sizeof(MachO::nlist);
1235 unsigned Offset = Symtab.symoff +
1236 Symtab.nsyms * SymbolTableEntrySize;
1237 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1238 return symbol_iterator(SymbolRef(DRI, this));
1241 symbol_iterator MachOObjectFile::begin_dynamic_symbols() const {
1243 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
1246 symbol_iterator MachOObjectFile::end_dynamic_symbols() const {
1248 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
1251 section_iterator MachOObjectFile::begin_sections() const {
1253 return section_iterator(SectionRef(DRI, this));
1256 section_iterator MachOObjectFile::end_sections() const {
1258 DRI.d.a = Sections.size();
1259 return section_iterator(SectionRef(DRI, this));
1262 library_iterator MachOObjectFile::begin_libraries_needed() const {
1264 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1267 library_iterator MachOObjectFile::end_libraries_needed() const {
1269 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1272 uint8_t MachOObjectFile::getBytesInAddress() const {
1273 return is64Bit() ? 8 : 4;
1276 StringRef MachOObjectFile::getFileFormatName() const {
1277 unsigned CPUType = getCPUType(this);
1280 case llvm::MachO::CPU_TYPE_I386:
1281 return "Mach-O 32-bit i386";
1282 case llvm::MachO::CPU_TYPE_ARM:
1283 return "Mach-O arm";
1284 case llvm::MachO::CPU_TYPE_POWERPC:
1285 return "Mach-O 32-bit ppc";
1287 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64) == 0 &&
1288 "64-bit object file when we're not 64-bit?");
1289 return "Mach-O 32-bit unknown";
1293 // Make sure the cpu type has the correct mask.
1294 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64)
1295 == llvm::MachO::CPU_ARCH_ABI64 &&
1296 "32-bit object file when we're 64-bit?");
1299 case llvm::MachO::CPU_TYPE_X86_64:
1300 return "Mach-O 64-bit x86-64";
1301 case llvm::MachO::CPU_TYPE_POWERPC64:
1302 return "Mach-O 64-bit ppc64";
1304 return "Mach-O 64-bit unknown";
1308 Triple::ArchType MachOObjectFile::getArch(uint32_t CPUType) {
1310 case llvm::MachO::CPU_TYPE_I386:
1312 case llvm::MachO::CPU_TYPE_X86_64:
1313 return Triple::x86_64;
1314 case llvm::MachO::CPU_TYPE_ARM:
1316 case llvm::MachO::CPU_TYPE_POWERPC:
1318 case llvm::MachO::CPU_TYPE_POWERPC64:
1319 return Triple::ppc64;
1321 return Triple::UnknownArch;
1325 unsigned MachOObjectFile::getArch() const {
1326 return getArch(getCPUType(this));
1329 StringRef MachOObjectFile::getLoadName() const {
1331 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
1334 relocation_iterator MachOObjectFile::section_rel_begin(unsigned Index) const {
1337 return section_rel_begin(DRI);
1340 relocation_iterator MachOObjectFile::section_rel_end(unsigned Index) const {
1343 return section_rel_end(DRI);
1346 dice_iterator MachOObjectFile::begin_dices() const {
1348 if (!DataInCodeLoadCmd)
1349 return dice_iterator(DiceRef(DRI, this));
1351 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1352 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, DicLC.dataoff));
1353 return dice_iterator(DiceRef(DRI, this));
1356 dice_iterator MachOObjectFile::end_dices() const {
1358 if (!DataInCodeLoadCmd)
1359 return dice_iterator(DiceRef(DRI, this));
1361 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1362 unsigned Offset = DicLC.dataoff + DicLC.datasize;
1363 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1364 return dice_iterator(DiceRef(DRI, this));
1368 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
1369 ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
1370 return parseSegmentOrSectionName(Raw.data());
1374 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
1375 const section_base *Base =
1376 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1377 return ArrayRef<char>(Base->sectname);
1381 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
1382 const section_base *Base =
1383 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1384 return ArrayRef<char>(Base->segname);
1388 MachOObjectFile::isRelocationScattered(const MachO::any_relocation_info &RE)
1390 if (getCPUType(this) == MachO::CPU_TYPE_X86_64)
1392 return getPlainRelocationAddress(RE) & MachO::R_SCATTERED;
1395 unsigned MachOObjectFile::getPlainRelocationSymbolNum(
1396 const MachO::any_relocation_info &RE) const {
1397 if (isLittleEndian())
1398 return RE.r_word1 & 0xffffff;
1399 return RE.r_word1 >> 8;
1402 bool MachOObjectFile::getPlainRelocationExternal(
1403 const MachO::any_relocation_info &RE) const {
1404 if (isLittleEndian())
1405 return (RE.r_word1 >> 27) & 1;
1406 return (RE.r_word1 >> 4) & 1;
1409 bool MachOObjectFile::getScatteredRelocationScattered(
1410 const MachO::any_relocation_info &RE) const {
1411 return RE.r_word0 >> 31;
1414 uint32_t MachOObjectFile::getScatteredRelocationValue(
1415 const MachO::any_relocation_info &RE) const {
1419 unsigned MachOObjectFile::getAnyRelocationAddress(
1420 const MachO::any_relocation_info &RE) const {
1421 if (isRelocationScattered(RE))
1422 return getScatteredRelocationAddress(RE);
1423 return getPlainRelocationAddress(RE);
1426 unsigned MachOObjectFile::getAnyRelocationPCRel(
1427 const MachO::any_relocation_info &RE) const {
1428 if (isRelocationScattered(RE))
1429 return getScatteredRelocationPCRel(this, RE);
1430 return getPlainRelocationPCRel(this, RE);
1433 unsigned MachOObjectFile::getAnyRelocationLength(
1434 const MachO::any_relocation_info &RE) const {
1435 if (isRelocationScattered(RE))
1436 return getScatteredRelocationLength(RE);
1437 return getPlainRelocationLength(this, RE);
1441 MachOObjectFile::getAnyRelocationType(
1442 const MachO::any_relocation_info &RE) const {
1443 if (isRelocationScattered(RE))
1444 return getScatteredRelocationType(RE);
1445 return getPlainRelocationType(this, RE);
1449 MachOObjectFile::getRelocationSection(
1450 const MachO::any_relocation_info &RE) const {
1451 if (isRelocationScattered(RE) || getPlainRelocationExternal(RE))
1452 return *end_sections();
1453 unsigned SecNum = getPlainRelocationSymbolNum(RE) - 1;
1456 return SectionRef(DRI, this);
1459 MachOObjectFile::LoadCommandInfo
1460 MachOObjectFile::getFirstLoadCommandInfo() const {
1461 MachOObjectFile::LoadCommandInfo Load;
1463 unsigned HeaderSize = is64Bit() ? sizeof(MachO::mach_header_64) :
1464 sizeof(MachO::mach_header);
1465 Load.Ptr = getPtr(this, HeaderSize);
1466 Load.C = getStruct<MachO::load_command>(this, Load.Ptr);
1470 MachOObjectFile::LoadCommandInfo
1471 MachOObjectFile::getNextLoadCommandInfo(const LoadCommandInfo &L) const {
1472 MachOObjectFile::LoadCommandInfo Next;
1473 Next.Ptr = L.Ptr + L.C.cmdsize;
1474 Next.C = getStruct<MachO::load_command>(this, Next.Ptr);
1478 MachO::section MachOObjectFile::getSection(DataRefImpl DRI) const {
1479 return getStruct<MachO::section>(this, Sections[DRI.d.a]);
1482 MachO::section_64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
1483 return getStruct<MachO::section_64>(this, Sections[DRI.d.a]);
1486 MachO::section MachOObjectFile::getSection(const LoadCommandInfo &L,
1487 unsigned Index) const {
1488 const char *Sec = getSectionPtr(this, L, Index);
1489 return getStruct<MachO::section>(this, Sec);
1492 MachO::section_64 MachOObjectFile::getSection64(const LoadCommandInfo &L,
1493 unsigned Index) const {
1494 const char *Sec = getSectionPtr(this, L, Index);
1495 return getStruct<MachO::section_64>(this, Sec);
1499 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
1500 const char *P = reinterpret_cast<const char *>(DRI.p);
1501 return getStruct<MachO::nlist>(this, P);
1505 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
1506 const char *P = reinterpret_cast<const char *>(DRI.p);
1507 return getStruct<MachO::nlist_64>(this, P);
1510 MachO::linkedit_data_command
1511 MachOObjectFile::getLinkeditDataLoadCommand(const LoadCommandInfo &L) const {
1512 return getStruct<MachO::linkedit_data_command>(this, L.Ptr);
1515 MachO::segment_command
1516 MachOObjectFile::getSegmentLoadCommand(const LoadCommandInfo &L) const {
1517 return getStruct<MachO::segment_command>(this, L.Ptr);
1520 MachO::segment_command_64
1521 MachOObjectFile::getSegment64LoadCommand(const LoadCommandInfo &L) const {
1522 return getStruct<MachO::segment_command_64>(this, L.Ptr);
1525 MachO::linker_options_command
1526 MachOObjectFile::getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const {
1527 return getStruct<MachO::linker_options_command>(this, L.Ptr);
1530 MachO::any_relocation_info
1531 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
1532 const char *P = reinterpret_cast<const char *>(Rel.p);
1533 return getStruct<MachO::any_relocation_info>(this, P);
1536 MachO::data_in_code_entry
1537 MachOObjectFile::getDice(DataRefImpl Rel) const {
1538 const char *P = reinterpret_cast<const char *>(Rel.p);
1539 return getStruct<MachO::data_in_code_entry>(this, P);
1542 MachO::mach_header MachOObjectFile::getHeader() const {
1543 return getStruct<MachO::mach_header>(this, getPtr(this, 0));
1546 MachO::mach_header_64 MachOObjectFile::getHeader64() const {
1547 return getStruct<MachO::mach_header_64>(this, getPtr(this, 0));
1550 uint32_t MachOObjectFile::getIndirectSymbolTableEntry(
1551 const MachO::dysymtab_command &DLC,
1552 unsigned Index) const {
1553 uint64_t Offset = DLC.indirectsymoff + Index * sizeof(uint32_t);
1554 return getStruct<uint32_t>(this, getPtr(this, Offset));
1557 MachO::data_in_code_entry
1558 MachOObjectFile::getDataInCodeTableEntry(uint32_t DataOffset,
1559 unsigned Index) const {
1560 uint64_t Offset = DataOffset + Index * sizeof(MachO::data_in_code_entry);
1561 return getStruct<MachO::data_in_code_entry>(this, getPtr(this, Offset));
1564 MachO::symtab_command MachOObjectFile::getSymtabLoadCommand() const {
1565 return getStruct<MachO::symtab_command>(this, SymtabLoadCmd);
1568 MachO::dysymtab_command MachOObjectFile::getDysymtabLoadCommand() const {
1569 return getStruct<MachO::dysymtab_command>(this, DysymtabLoadCmd);
1572 MachO::linkedit_data_command
1573 MachOObjectFile::getDataInCodeLoadCommand() const {
1574 if (DataInCodeLoadCmd)
1575 return getStruct<MachO::linkedit_data_command>(this, DataInCodeLoadCmd);
1577 // If there is no DataInCodeLoadCmd return a load command with zero'ed fields.
1578 MachO::linkedit_data_command Cmd;
1579 Cmd.cmd = MachO::LC_DATA_IN_CODE;
1580 Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
1586 StringRef MachOObjectFile::getStringTableData() const {
1587 MachO::symtab_command S = getSymtabLoadCommand();
1588 return getData().substr(S.stroff, S.strsize);
1591 bool MachOObjectFile::is64Bit() const {
1592 return getType() == getMachOType(false, true) ||
1593 getType() == getMachOType(true, true);
1596 void MachOObjectFile::ReadULEB128s(uint64_t Index,
1597 SmallVectorImpl<uint64_t> &Out) const {
1598 DataExtractor extractor(ObjectFile::getData(), true, 0);
1600 uint32_t offset = Index;
1602 while (uint64_t delta = extractor.getULEB128(&offset)) {
1604 Out.push_back(data);
1608 ObjectFile *ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer) {
1609 StringRef Magic = Buffer->getBuffer().slice(0, 4);
1611 OwningPtr<ObjectFile> Ret;
1612 if (Magic == "\xFE\xED\xFA\xCE")
1613 Ret.reset(new MachOObjectFile(Buffer, false, false, ec));
1614 else if (Magic == "\xCE\xFA\xED\xFE")
1615 Ret.reset(new MachOObjectFile(Buffer, true, false, ec));
1616 else if (Magic == "\xFE\xED\xFA\xCF")
1617 Ret.reset(new MachOObjectFile(Buffer, false, true, ec));
1618 else if (Magic == "\xCF\xFA\xED\xFE")
1619 Ret.reset(new MachOObjectFile(Buffer, true, true, ec));
1630 } // end namespace object
1631 } // end namespace llvm