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->symbol_begin(), SE = O->symbol_end();
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->section_begin(), SE = O->section_end();
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->symbol_begin();
344 section_iterator SI = O->section_begin();
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 {
498 uint32_t flags = getSymbolFlags(DRI);
499 if (flags & SymbolRef::SF_Common) {
500 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
501 Result = 1 << MachO::GET_COMM_ALIGN(Entry.n_desc);
505 return object_error::success;
508 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
509 uint64_t &Result) const {
510 uint64_t BeginOffset;
511 uint64_t EndOffset = 0;
512 uint8_t SectionIndex;
514 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
516 getSymbolAddress(DRI, Value);
520 SectionIndex = Entry.n_sect;
522 uint32_t flags = getSymbolFlags(DRI);
523 if (flags & SymbolRef::SF_Common)
526 Result = UnknownAddressOrSize;
527 return object_error::success;
529 // Unfortunately symbols are unsorted so we need to touch all
530 // symbols from load command
531 for (symbol_iterator I = symbol_begin(), E = symbol_end(); I != E; ++I) {
532 DataRefImpl DRI = I->getRawDataRefImpl();
533 Entry = getSymbolTableEntryBase(this, DRI);
534 getSymbolAddress(DRI, Value);
535 if (Entry.n_sect == SectionIndex && Value > BeginOffset)
536 if (!EndOffset || Value < EndOffset)
542 Sec.d.a = SectionIndex-1;
543 getSectionSize(Sec, Size);
544 getSectionAddress(Sec, EndOffset);
547 Result = EndOffset - BeginOffset;
548 return object_error::success;
551 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
552 SymbolRef::Type &Res) const {
553 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
554 uint8_t n_type = Entry.n_type;
556 Res = SymbolRef::ST_Other;
558 // If this is a STAB debugging symbol, we can do nothing more.
559 if (n_type & MachO::N_STAB) {
560 Res = SymbolRef::ST_Debug;
561 return object_error::success;
564 switch (n_type & MachO::N_TYPE) {
566 Res = SymbolRef::ST_Unknown;
569 Res = SymbolRef::ST_Function;
572 return object_error::success;
575 uint32_t MachOObjectFile::getSymbolFlags(DataRefImpl DRI) const {
576 nlist_base Entry = getSymbolTableEntryBase(this, DRI);
578 uint8_t MachOType = Entry.n_type;
579 uint16_t MachOFlags = Entry.n_desc;
581 uint32_t Result = SymbolRef::SF_None;
583 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF)
584 Result |= SymbolRef::SF_Undefined;
586 if (MachOType & MachO::N_STAB)
587 Result |= SymbolRef::SF_FormatSpecific;
589 if (MachOType & MachO::N_EXT) {
590 Result |= SymbolRef::SF_Global;
591 if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF) {
593 getSymbolAddress(DRI, Value);
595 Result |= SymbolRef::SF_Common;
599 if (MachOFlags & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
600 Result |= SymbolRef::SF_Weak;
602 if ((MachOType & MachO::N_TYPE) == MachO::N_ABS)
603 Result |= SymbolRef::SF_Absolute;
609 MachOObjectFile::getSymbolSection(DataRefImpl Symb,
610 section_iterator &Res) const {
611 nlist_base Entry = getSymbolTableEntryBase(this, Symb);
612 uint8_t index = Entry.n_sect;
619 Res = section_iterator(SectionRef(DRI, this));
622 return object_error::success;
625 error_code MachOObjectFile::getSymbolValue(DataRefImpl Symb,
626 uint64_t &Val) const {
627 report_fatal_error("getSymbolValue unimplemented in MachOObjectFile");
630 void MachOObjectFile::moveSectionNext(DataRefImpl &Sec) const {
635 MachOObjectFile::getSectionName(DataRefImpl Sec, StringRef &Result) const {
636 ArrayRef<char> Raw = getSectionRawName(Sec);
637 Result = parseSegmentOrSectionName(Raw.data());
638 return object_error::success;
642 MachOObjectFile::getSectionAddress(DataRefImpl Sec, uint64_t &Res) const {
644 MachO::section_64 Sect = getSection64(Sec);
647 MachO::section Sect = getSection(Sec);
650 return object_error::success;
654 MachOObjectFile::getSectionSize(DataRefImpl Sec, uint64_t &Res) const {
656 MachO::section_64 Sect = getSection64(Sec);
659 MachO::section Sect = getSection(Sec);
663 return object_error::success;
667 MachOObjectFile::getSectionContents(DataRefImpl Sec, StringRef &Res) const {
672 MachO::section_64 Sect = getSection64(Sec);
673 Offset = Sect.offset;
676 MachO::section Sect = getSection(Sec);
677 Offset = Sect.offset;
681 Res = this->getData().substr(Offset, Size);
682 return object_error::success;
686 MachOObjectFile::getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const {
689 MachO::section_64 Sect = getSection64(Sec);
692 MachO::section Sect = getSection(Sec);
696 Res = uint64_t(1) << Align;
697 return object_error::success;
701 MachOObjectFile::isSectionText(DataRefImpl Sec, bool &Res) const {
702 uint32_t Flags = getSectionFlags(this, Sec);
703 Res = Flags & MachO::S_ATTR_PURE_INSTRUCTIONS;
704 return object_error::success;
707 error_code MachOObjectFile::isSectionData(DataRefImpl DRI, bool &Result) const {
708 // FIXME: Unimplemented.
710 return object_error::success;
713 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI, bool &Result) const {
714 // FIXME: Unimplemented.
716 return object_error::success;
720 MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
721 bool &Result) const {
722 // FIXME: Unimplemented.
724 return object_error::success;
727 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
728 bool &Result) const {
729 // FIXME: Unimplemented.
731 return object_error::success;
735 MachOObjectFile::isSectionZeroInit(DataRefImpl Sec, bool &Res) const {
736 uint32_t Flags = getSectionFlags(this, Sec);
737 unsigned SectionType = Flags & MachO::SECTION_TYPE;
738 Res = SectionType == MachO::S_ZEROFILL ||
739 SectionType == MachO::S_GB_ZEROFILL;
740 return object_error::success;
743 error_code MachOObjectFile::isSectionReadOnlyData(DataRefImpl Sec,
744 bool &Result) const {
745 // Consider using the code from isSectionText to look for __const sections.
746 // Alternately, emit S_ATTR_PURE_INSTRUCTIONS and/or S_ATTR_SOME_INSTRUCTIONS
747 // to use section attributes to distinguish code from data.
749 // FIXME: Unimplemented.
751 return object_error::success;
755 MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
756 bool &Result) const {
758 this->getSymbolType(Symb, ST);
759 if (ST == SymbolRef::ST_Unknown) {
761 return object_error::success;
764 uint64_t SectBegin, SectEnd;
765 getSectionAddress(Sec, SectBegin);
766 getSectionSize(Sec, SectEnd);
767 SectEnd += SectBegin;
770 getSymbolAddress(Symb, SymAddr);
771 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
773 return object_error::success;
776 relocation_iterator MachOObjectFile::section_rel_begin(DataRefImpl Sec) const {
779 MachO::section_64 Sect = getSection64(Sec);
780 Offset = Sect.reloff;
782 MachO::section Sect = getSection(Sec);
783 Offset = Sect.reloff;
787 Ret.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
788 return relocation_iterator(RelocationRef(Ret, this));
792 MachOObjectFile::section_rel_end(DataRefImpl Sec) const {
796 MachO::section_64 Sect = getSection64(Sec);
797 Offset = Sect.reloff;
800 MachO::section Sect = getSection(Sec);
801 Offset = Sect.reloff;
805 const MachO::any_relocation_info *P =
806 reinterpret_cast<const MachO::any_relocation_info *>(getPtr(this, Offset));
809 Ret.p = reinterpret_cast<uintptr_t>(P + Num);
810 return relocation_iterator(RelocationRef(Ret, this));
813 void MachOObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
814 const MachO::any_relocation_info *P =
815 reinterpret_cast<const MachO::any_relocation_info *>(Rel.p);
816 Rel.p = reinterpret_cast<uintptr_t>(P + 1);
820 MachOObjectFile::getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const {
821 report_fatal_error("getRelocationAddress not implemented in MachOObjectFile");
824 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
825 uint64_t &Res) const {
826 MachO::any_relocation_info RE = getRelocation(Rel);
827 Res = getAnyRelocationAddress(RE);
828 return object_error::success;
832 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
833 MachO::any_relocation_info RE = getRelocation(Rel);
834 uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
835 bool isExtern = getPlainRelocationExternal(RE);
839 MachO::symtab_command S = getSymtabLoadCommand();
840 unsigned SymbolTableEntrySize = is64Bit() ?
841 sizeof(MachO::nlist_64) :
842 sizeof(MachO::nlist);
843 uint64_t Offset = S.symoff + SymbolIdx * SymbolTableEntrySize;
845 Sym.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
846 return symbol_iterator(SymbolRef(Sym, this));
849 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
850 uint64_t &Res) const {
851 MachO::any_relocation_info RE = getRelocation(Rel);
852 Res = getAnyRelocationType(RE);
853 return object_error::success;
857 MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
858 SmallVectorImpl<char> &Result) const {
861 getRelocationType(Rel, RType);
863 unsigned Arch = this->getArch();
867 static const char *const Table[] = {
868 "GENERIC_RELOC_VANILLA",
869 "GENERIC_RELOC_PAIR",
870 "GENERIC_RELOC_SECTDIFF",
871 "GENERIC_RELOC_PB_LA_PTR",
872 "GENERIC_RELOC_LOCAL_SECTDIFF",
873 "GENERIC_RELOC_TLV" };
881 case Triple::x86_64: {
882 static const char *const Table[] = {
883 "X86_64_RELOC_UNSIGNED",
884 "X86_64_RELOC_SIGNED",
885 "X86_64_RELOC_BRANCH",
886 "X86_64_RELOC_GOT_LOAD",
888 "X86_64_RELOC_SUBTRACTOR",
889 "X86_64_RELOC_SIGNED_1",
890 "X86_64_RELOC_SIGNED_2",
891 "X86_64_RELOC_SIGNED_4",
892 "X86_64_RELOC_TLV" };
901 static const char *const Table[] = {
904 "ARM_RELOC_SECTDIFF",
905 "ARM_RELOC_LOCAL_SECTDIFF",
906 "ARM_RELOC_PB_LA_PTR",
908 "ARM_THUMB_RELOC_BR22",
909 "ARM_THUMB_32BIT_BRANCH",
911 "ARM_RELOC_HALF_SECTDIFF" };
920 static const char *const Table[] = {
929 "PPC_RELOC_SECTDIFF",
930 "PPC_RELOC_PB_LA_PTR",
931 "PPC_RELOC_HI16_SECTDIFF",
932 "PPC_RELOC_LO16_SECTDIFF",
933 "PPC_RELOC_HA16_SECTDIFF",
935 "PPC_RELOC_LO14_SECTDIFF",
936 "PPC_RELOC_LOCAL_SECTDIFF" };
944 case Triple::UnknownArch:
948 Result.append(res.begin(), res.end());
949 return object_error::success;
953 MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
954 SmallVectorImpl<char> &Result) const {
955 MachO::any_relocation_info RE = getRelocation(Rel);
957 unsigned Arch = this->getArch();
960 raw_string_ostream fmt(fmtbuf);
961 unsigned Type = this->getAnyRelocationType(RE);
962 bool IsPCRel = this->getAnyRelocationPCRel(RE);
964 // Determine any addends that should be displayed with the relocation.
965 // These require decoding the relocation type, which is triple-specific.
967 // X86_64 has entirely custom relocation types.
968 if (Arch == Triple::x86_64) {
969 bool isPCRel = getAnyRelocationPCRel(RE);
972 case MachO::X86_64_RELOC_GOT_LOAD:
973 case MachO::X86_64_RELOC_GOT: {
974 printRelocationTargetName(this, RE, fmt);
976 if (isPCRel) fmt << "PCREL";
979 case MachO::X86_64_RELOC_SUBTRACTOR: {
980 DataRefImpl RelNext = Rel;
982 MachO::any_relocation_info RENext = getRelocation(RelNext);
984 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
985 // X86_64_RELOC_UNSIGNED.
986 // NOTE: Scattered relocations don't exist on x86_64.
987 unsigned RType = getAnyRelocationType(RENext);
988 if (RType != MachO::X86_64_RELOC_UNSIGNED)
989 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
990 "X86_64_RELOC_SUBTRACTOR.");
992 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
993 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
994 printRelocationTargetName(this, RENext, fmt);
996 printRelocationTargetName(this, RE, fmt);
999 case MachO::X86_64_RELOC_TLV:
1000 printRelocationTargetName(this, RE, fmt);
1002 if (isPCRel) fmt << "P";
1004 case MachO::X86_64_RELOC_SIGNED_1:
1005 printRelocationTargetName(this, RE, fmt);
1008 case MachO::X86_64_RELOC_SIGNED_2:
1009 printRelocationTargetName(this, RE, fmt);
1012 case MachO::X86_64_RELOC_SIGNED_4:
1013 printRelocationTargetName(this, RE, fmt);
1017 printRelocationTargetName(this, RE, fmt);
1020 // X86 and ARM share some relocation types in common.
1021 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
1022 Arch == Triple::ppc) {
1023 // Generic relocation types...
1025 case MachO::GENERIC_RELOC_PAIR: // prints no info
1026 return object_error::success;
1027 case MachO::GENERIC_RELOC_SECTDIFF: {
1028 DataRefImpl RelNext = Rel;
1030 MachO::any_relocation_info 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 if (RType != MachO::GENERIC_RELOC_PAIR)
1037 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1038 "GENERIC_RELOC_SECTDIFF.");
1040 printRelocationTargetName(this, RE, fmt);
1042 printRelocationTargetName(this, RENext, fmt);
1047 if (Arch == Triple::x86 || Arch == Triple::ppc) {
1049 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
1050 DataRefImpl RelNext = Rel;
1052 MachO::any_relocation_info RENext = getRelocation(RelNext);
1054 // X86 sect diff's must be followed by a relocation of type
1055 // GENERIC_RELOC_PAIR.
1056 unsigned RType = getAnyRelocationType(RENext);
1057 if (RType != MachO::GENERIC_RELOC_PAIR)
1058 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1059 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1061 printRelocationTargetName(this, RE, fmt);
1063 printRelocationTargetName(this, RENext, fmt);
1066 case MachO::GENERIC_RELOC_TLV: {
1067 printRelocationTargetName(this, RE, fmt);
1069 if (IsPCRel) fmt << "P";
1073 printRelocationTargetName(this, RE, fmt);
1075 } else { // ARM-specific relocations
1077 case MachO::ARM_RELOC_HALF:
1078 case MachO::ARM_RELOC_HALF_SECTDIFF: {
1079 // Half relocations steal a bit from the length field to encode
1080 // whether this is an upper16 or a lower16 relocation.
1081 bool isUpper = getAnyRelocationLength(RE) >> 1;
1084 fmt << ":upper16:(";
1086 fmt << ":lower16:(";
1087 printRelocationTargetName(this, RE, fmt);
1089 DataRefImpl RelNext = Rel;
1091 MachO::any_relocation_info RENext = getRelocation(RelNext);
1093 // ARM half relocs must be followed by a relocation of type
1095 unsigned RType = getAnyRelocationType(RENext);
1096 if (RType != MachO::ARM_RELOC_PAIR)
1097 report_fatal_error("Expected ARM_RELOC_PAIR after "
1100 // NOTE: The half of the target virtual address is stashed in the
1101 // address field of the secondary relocation, but we can't reverse
1102 // engineer the constant offset from it without decoding the movw/movt
1103 // instruction to find the other half in its immediate field.
1105 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1106 // symbol/section pointer of the follow-on relocation.
1107 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
1109 printRelocationTargetName(this, RENext, fmt);
1116 printRelocationTargetName(this, RE, fmt);
1121 printRelocationTargetName(this, RE, fmt);
1124 Result.append(fmtbuf.begin(), fmtbuf.end());
1125 return object_error::success;
1129 MachOObjectFile::getRelocationHidden(DataRefImpl Rel, bool &Result) const {
1130 unsigned Arch = getArch();
1132 getRelocationType(Rel, Type);
1136 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1137 // is always hidden.
1138 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
1139 if (Type == MachO::GENERIC_RELOC_PAIR) Result = true;
1140 } else if (Arch == Triple::x86_64) {
1141 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1142 // an X86_64_RELOC_SUBTRACTOR.
1143 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
1144 DataRefImpl RelPrev = Rel;
1147 getRelocationType(RelPrev, PrevType);
1148 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
1153 return object_error::success;
1156 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1157 LibraryRef &Res) const {
1158 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1161 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1162 StringRef &Res) const {
1163 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1166 symbol_iterator MachOObjectFile::symbol_begin() const {
1169 return symbol_iterator(SymbolRef(DRI, this));
1171 MachO::symtab_command Symtab = getSymtabLoadCommand();
1172 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Symtab.symoff));
1173 return symbol_iterator(SymbolRef(DRI, this));
1176 symbol_iterator MachOObjectFile::symbol_end() const {
1179 return symbol_iterator(SymbolRef(DRI, this));
1181 MachO::symtab_command Symtab = getSymtabLoadCommand();
1182 unsigned SymbolTableEntrySize = is64Bit() ?
1183 sizeof(MachO::nlist_64) :
1184 sizeof(MachO::nlist);
1185 unsigned Offset = Symtab.symoff +
1186 Symtab.nsyms * SymbolTableEntrySize;
1187 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1188 return symbol_iterator(SymbolRef(DRI, this));
1191 section_iterator MachOObjectFile::section_begin() const {
1193 return section_iterator(SectionRef(DRI, this));
1196 section_iterator MachOObjectFile::section_end() const {
1198 DRI.d.a = Sections.size();
1199 return section_iterator(SectionRef(DRI, this));
1202 library_iterator MachOObjectFile::needed_library_begin() const {
1204 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1207 library_iterator MachOObjectFile::needed_library_end() const {
1209 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1212 uint8_t MachOObjectFile::getBytesInAddress() const {
1213 return is64Bit() ? 8 : 4;
1216 StringRef MachOObjectFile::getFileFormatName() const {
1217 unsigned CPUType = getCPUType(this);
1220 case llvm::MachO::CPU_TYPE_I386:
1221 return "Mach-O 32-bit i386";
1222 case llvm::MachO::CPU_TYPE_ARM:
1223 return "Mach-O arm";
1224 case llvm::MachO::CPU_TYPE_POWERPC:
1225 return "Mach-O 32-bit ppc";
1227 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64) == 0 &&
1228 "64-bit object file when we're not 64-bit?");
1229 return "Mach-O 32-bit unknown";
1233 // Make sure the cpu type has the correct mask.
1234 assert((CPUType & llvm::MachO::CPU_ARCH_ABI64)
1235 == llvm::MachO::CPU_ARCH_ABI64 &&
1236 "32-bit object file when we're 64-bit?");
1239 case llvm::MachO::CPU_TYPE_X86_64:
1240 return "Mach-O 64-bit x86-64";
1241 case llvm::MachO::CPU_TYPE_POWERPC64:
1242 return "Mach-O 64-bit ppc64";
1244 return "Mach-O 64-bit unknown";
1248 Triple::ArchType MachOObjectFile::getArch(uint32_t CPUType) {
1250 case llvm::MachO::CPU_TYPE_I386:
1252 case llvm::MachO::CPU_TYPE_X86_64:
1253 return Triple::x86_64;
1254 case llvm::MachO::CPU_TYPE_ARM:
1256 case llvm::MachO::CPU_TYPE_POWERPC:
1258 case llvm::MachO::CPU_TYPE_POWERPC64:
1259 return Triple::ppc64;
1261 return Triple::UnknownArch;
1265 unsigned MachOObjectFile::getArch() const {
1266 return getArch(getCPUType(this));
1269 StringRef MachOObjectFile::getLoadName() const {
1271 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
1274 relocation_iterator MachOObjectFile::section_rel_begin(unsigned Index) const {
1277 return section_rel_begin(DRI);
1280 relocation_iterator MachOObjectFile::section_rel_end(unsigned Index) const {
1283 return section_rel_end(DRI);
1286 dice_iterator MachOObjectFile::begin_dices() const {
1288 if (!DataInCodeLoadCmd)
1289 return dice_iterator(DiceRef(DRI, this));
1291 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1292 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, DicLC.dataoff));
1293 return dice_iterator(DiceRef(DRI, this));
1296 dice_iterator MachOObjectFile::end_dices() const {
1298 if (!DataInCodeLoadCmd)
1299 return dice_iterator(DiceRef(DRI, this));
1301 MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
1302 unsigned Offset = DicLC.dataoff + DicLC.datasize;
1303 DRI.p = reinterpret_cast<uintptr_t>(getPtr(this, Offset));
1304 return dice_iterator(DiceRef(DRI, this));
1308 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
1309 ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
1310 return parseSegmentOrSectionName(Raw.data());
1314 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
1315 const section_base *Base =
1316 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1317 return ArrayRef<char>(Base->sectname);
1321 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
1322 const section_base *Base =
1323 reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
1324 return ArrayRef<char>(Base->segname);
1328 MachOObjectFile::isRelocationScattered(const MachO::any_relocation_info &RE)
1330 if (getCPUType(this) == MachO::CPU_TYPE_X86_64)
1332 return getPlainRelocationAddress(RE) & MachO::R_SCATTERED;
1335 unsigned MachOObjectFile::getPlainRelocationSymbolNum(
1336 const MachO::any_relocation_info &RE) const {
1337 if (isLittleEndian())
1338 return RE.r_word1 & 0xffffff;
1339 return RE.r_word1 >> 8;
1342 bool MachOObjectFile::getPlainRelocationExternal(
1343 const MachO::any_relocation_info &RE) const {
1344 if (isLittleEndian())
1345 return (RE.r_word1 >> 27) & 1;
1346 return (RE.r_word1 >> 4) & 1;
1349 bool MachOObjectFile::getScatteredRelocationScattered(
1350 const MachO::any_relocation_info &RE) const {
1351 return RE.r_word0 >> 31;
1354 uint32_t MachOObjectFile::getScatteredRelocationValue(
1355 const MachO::any_relocation_info &RE) const {
1359 unsigned MachOObjectFile::getAnyRelocationAddress(
1360 const MachO::any_relocation_info &RE) const {
1361 if (isRelocationScattered(RE))
1362 return getScatteredRelocationAddress(RE);
1363 return getPlainRelocationAddress(RE);
1366 unsigned MachOObjectFile::getAnyRelocationPCRel(
1367 const MachO::any_relocation_info &RE) const {
1368 if (isRelocationScattered(RE))
1369 return getScatteredRelocationPCRel(this, RE);
1370 return getPlainRelocationPCRel(this, RE);
1373 unsigned MachOObjectFile::getAnyRelocationLength(
1374 const MachO::any_relocation_info &RE) const {
1375 if (isRelocationScattered(RE))
1376 return getScatteredRelocationLength(RE);
1377 return getPlainRelocationLength(this, RE);
1381 MachOObjectFile::getAnyRelocationType(
1382 const MachO::any_relocation_info &RE) const {
1383 if (isRelocationScattered(RE))
1384 return getScatteredRelocationType(RE);
1385 return getPlainRelocationType(this, RE);
1389 MachOObjectFile::getRelocationSection(
1390 const MachO::any_relocation_info &RE) const {
1391 if (isRelocationScattered(RE) || getPlainRelocationExternal(RE))
1392 return *section_end();
1393 unsigned SecNum = getPlainRelocationSymbolNum(RE) - 1;
1396 return SectionRef(DRI, this);
1399 MachOObjectFile::LoadCommandInfo
1400 MachOObjectFile::getFirstLoadCommandInfo() const {
1401 MachOObjectFile::LoadCommandInfo Load;
1403 unsigned HeaderSize = is64Bit() ? sizeof(MachO::mach_header_64) :
1404 sizeof(MachO::mach_header);
1405 Load.Ptr = getPtr(this, HeaderSize);
1406 Load.C = getStruct<MachO::load_command>(this, Load.Ptr);
1410 MachOObjectFile::LoadCommandInfo
1411 MachOObjectFile::getNextLoadCommandInfo(const LoadCommandInfo &L) const {
1412 MachOObjectFile::LoadCommandInfo Next;
1413 Next.Ptr = L.Ptr + L.C.cmdsize;
1414 Next.C = getStruct<MachO::load_command>(this, Next.Ptr);
1418 MachO::section MachOObjectFile::getSection(DataRefImpl DRI) const {
1419 return getStruct<MachO::section>(this, Sections[DRI.d.a]);
1422 MachO::section_64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
1423 return getStruct<MachO::section_64>(this, Sections[DRI.d.a]);
1426 MachO::section MachOObjectFile::getSection(const LoadCommandInfo &L,
1427 unsigned Index) const {
1428 const char *Sec = getSectionPtr(this, L, Index);
1429 return getStruct<MachO::section>(this, Sec);
1432 MachO::section_64 MachOObjectFile::getSection64(const LoadCommandInfo &L,
1433 unsigned Index) const {
1434 const char *Sec = getSectionPtr(this, L, Index);
1435 return getStruct<MachO::section_64>(this, Sec);
1439 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
1440 const char *P = reinterpret_cast<const char *>(DRI.p);
1441 return getStruct<MachO::nlist>(this, P);
1445 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
1446 const char *P = reinterpret_cast<const char *>(DRI.p);
1447 return getStruct<MachO::nlist_64>(this, P);
1450 MachO::linkedit_data_command
1451 MachOObjectFile::getLinkeditDataLoadCommand(const LoadCommandInfo &L) const {
1452 return getStruct<MachO::linkedit_data_command>(this, L.Ptr);
1455 MachO::segment_command
1456 MachOObjectFile::getSegmentLoadCommand(const LoadCommandInfo &L) const {
1457 return getStruct<MachO::segment_command>(this, L.Ptr);
1460 MachO::segment_command_64
1461 MachOObjectFile::getSegment64LoadCommand(const LoadCommandInfo &L) const {
1462 return getStruct<MachO::segment_command_64>(this, L.Ptr);
1465 MachO::linker_options_command
1466 MachOObjectFile::getLinkerOptionsLoadCommand(const LoadCommandInfo &L) const {
1467 return getStruct<MachO::linker_options_command>(this, L.Ptr);
1470 MachO::any_relocation_info
1471 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
1472 const char *P = reinterpret_cast<const char *>(Rel.p);
1473 return getStruct<MachO::any_relocation_info>(this, P);
1476 MachO::data_in_code_entry
1477 MachOObjectFile::getDice(DataRefImpl Rel) const {
1478 const char *P = reinterpret_cast<const char *>(Rel.p);
1479 return getStruct<MachO::data_in_code_entry>(this, P);
1482 MachO::mach_header MachOObjectFile::getHeader() const {
1483 return getStruct<MachO::mach_header>(this, getPtr(this, 0));
1486 MachO::mach_header_64 MachOObjectFile::getHeader64() const {
1487 return getStruct<MachO::mach_header_64>(this, getPtr(this, 0));
1490 uint32_t MachOObjectFile::getIndirectSymbolTableEntry(
1491 const MachO::dysymtab_command &DLC,
1492 unsigned Index) const {
1493 uint64_t Offset = DLC.indirectsymoff + Index * sizeof(uint32_t);
1494 return getStruct<uint32_t>(this, getPtr(this, Offset));
1497 MachO::data_in_code_entry
1498 MachOObjectFile::getDataInCodeTableEntry(uint32_t DataOffset,
1499 unsigned Index) const {
1500 uint64_t Offset = DataOffset + Index * sizeof(MachO::data_in_code_entry);
1501 return getStruct<MachO::data_in_code_entry>(this, getPtr(this, Offset));
1504 MachO::symtab_command MachOObjectFile::getSymtabLoadCommand() const {
1505 return getStruct<MachO::symtab_command>(this, SymtabLoadCmd);
1508 MachO::dysymtab_command MachOObjectFile::getDysymtabLoadCommand() const {
1509 return getStruct<MachO::dysymtab_command>(this, DysymtabLoadCmd);
1512 MachO::linkedit_data_command
1513 MachOObjectFile::getDataInCodeLoadCommand() const {
1514 if (DataInCodeLoadCmd)
1515 return getStruct<MachO::linkedit_data_command>(this, DataInCodeLoadCmd);
1517 // If there is no DataInCodeLoadCmd return a load command with zero'ed fields.
1518 MachO::linkedit_data_command Cmd;
1519 Cmd.cmd = MachO::LC_DATA_IN_CODE;
1520 Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
1526 StringRef MachOObjectFile::getStringTableData() const {
1527 MachO::symtab_command S = getSymtabLoadCommand();
1528 return getData().substr(S.stroff, S.strsize);
1531 bool MachOObjectFile::is64Bit() const {
1532 return getType() == getMachOType(false, true) ||
1533 getType() == getMachOType(true, true);
1536 void MachOObjectFile::ReadULEB128s(uint64_t Index,
1537 SmallVectorImpl<uint64_t> &Out) const {
1538 DataExtractor extractor(ObjectFile::getData(), true, 0);
1540 uint32_t offset = Index;
1542 while (uint64_t delta = extractor.getULEB128(&offset)) {
1544 Out.push_back(data);
1548 ErrorOr<ObjectFile *> ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer,
1550 StringRef Magic = Buffer->getBuffer().slice(0, 4);
1552 OwningPtr<MachOObjectFile> Ret;
1553 if (Magic == "\xFE\xED\xFA\xCE")
1554 Ret.reset(new MachOObjectFile(Buffer, false, false, EC, BufferOwned));
1555 else if (Magic == "\xCE\xFA\xED\xFE")
1556 Ret.reset(new MachOObjectFile(Buffer, true, false, EC, BufferOwned));
1557 else if (Magic == "\xFE\xED\xFA\xCF")
1558 Ret.reset(new MachOObjectFile(Buffer, false, true, EC, BufferOwned));
1559 else if (Magic == "\xCF\xFA\xED\xFE")
1560 Ret.reset(new MachOObjectFile(Buffer, true, true, EC, BufferOwned));
1563 return object_error::parse_failed;
1571 } // end namespace object
1572 } // end namespace llvm