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/ADT/Triple.h"
16 #include "llvm/Object/MachO.h"
17 #include "llvm/Object/MachOFormat.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/Support/MemoryBuffer.h"
26 using namespace object;
31 MachOObjectFile::MachOObjectFile(MemoryBuffer *Object, MachOObject *MOO,
33 : ObjectFile(Binary::ID_MachO, Object, ec),
35 RegisteredStringTable(std::numeric_limits<uint32_t>::max()) {
37 moveToNextSection(DRI);
38 uint32_t LoadCommandCount = MachOObj->getHeader().NumLoadCommands;
39 while (DRI.d.a < LoadCommandCount) {
40 Sections.push_back(DRI);
42 moveToNextSection(DRI);
47 ObjectFile *ObjectFile::createMachOObjectFile(MemoryBuffer *Buffer) {
50 MachOObject *MachOObj = MachOObject::LoadFromBuffer(Buffer, &Err);
53 return new MachOObjectFile(Buffer, MachOObj, ec);
56 /*===-- Symbols -----------------------------------------------------------===*/
58 void MachOObjectFile::moveToNextSymbol(DataRefImpl &DRI) const {
59 uint32_t LoadCommandCount = MachOObj->getHeader().NumLoadCommands;
60 while (DRI.d.a < LoadCommandCount) {
61 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
62 if (LCI.Command.Type == macho::LCT_Symtab) {
63 InMemoryStruct<macho::SymtabLoadCommand> SymtabLoadCmd;
64 MachOObj->ReadSymtabLoadCommand(LCI, SymtabLoadCmd);
65 if (DRI.d.b < SymtabLoadCmd->NumSymbolTableEntries)
74 void MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI,
75 InMemoryStruct<macho::SymbolTableEntry> &Res) const {
76 InMemoryStruct<macho::SymtabLoadCommand> SymtabLoadCmd;
77 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
78 MachOObj->ReadSymtabLoadCommand(LCI, SymtabLoadCmd);
80 if (RegisteredStringTable != DRI.d.a) {
81 MachOObj->RegisterStringTable(*SymtabLoadCmd);
82 RegisteredStringTable = DRI.d.a;
85 MachOObj->ReadSymbolTableEntry(SymtabLoadCmd->SymbolTableOffset, DRI.d.b,
89 void MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI,
90 InMemoryStruct<macho::Symbol64TableEntry> &Res) const {
91 InMemoryStruct<macho::SymtabLoadCommand> SymtabLoadCmd;
92 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
93 MachOObj->ReadSymtabLoadCommand(LCI, SymtabLoadCmd);
95 if (RegisteredStringTable != DRI.d.a) {
96 MachOObj->RegisterStringTable(*SymtabLoadCmd);
97 RegisteredStringTable = DRI.d.a;
100 MachOObj->ReadSymbol64TableEntry(SymtabLoadCmd->SymbolTableOffset, DRI.d.b,
105 error_code MachOObjectFile::getSymbolNext(DataRefImpl DRI,
106 SymbolRef &Result) const {
108 moveToNextSymbol(DRI);
109 Result = SymbolRef(DRI, this);
110 return object_error::success;
113 error_code MachOObjectFile::getSymbolName(DataRefImpl DRI,
114 StringRef &Result) const {
115 if (MachOObj->is64Bit()) {
116 InMemoryStruct<macho::Symbol64TableEntry> Entry;
117 getSymbol64TableEntry(DRI, Entry);
118 Result = MachOObj->getStringAtIndex(Entry->StringIndex);
120 InMemoryStruct<macho::SymbolTableEntry> Entry;
121 getSymbolTableEntry(DRI, Entry);
122 Result = MachOObj->getStringAtIndex(Entry->StringIndex);
124 return object_error::success;
127 error_code MachOObjectFile::getSymbolFileOffset(DataRefImpl DRI,
128 uint64_t &Result) const {
129 if (MachOObj->is64Bit()) {
130 InMemoryStruct<macho::Symbol64TableEntry> Entry;
131 getSymbol64TableEntry(DRI, Entry);
132 Result = Entry->Value;
133 if (Entry->SectionIndex) {
134 InMemoryStruct<macho::Section64> Section;
135 getSection64(Sections[Entry->SectionIndex-1], Section);
136 Result += Section->Offset - Section->Address;
139 InMemoryStruct<macho::SymbolTableEntry> Entry;
140 getSymbolTableEntry(DRI, Entry);
141 Result = Entry->Value;
142 if (Entry->SectionIndex) {
143 InMemoryStruct<macho::Section> Section;
144 getSection(Sections[Entry->SectionIndex-1], Section);
145 Result += Section->Offset - Section->Address;
149 return object_error::success;
152 error_code MachOObjectFile::getSymbolAddress(DataRefImpl DRI,
153 uint64_t &Result) const {
154 if (MachOObj->is64Bit()) {
155 InMemoryStruct<macho::Symbol64TableEntry> Entry;
156 getSymbol64TableEntry(DRI, Entry);
157 Result = Entry->Value;
159 InMemoryStruct<macho::SymbolTableEntry> Entry;
160 getSymbolTableEntry(DRI, Entry);
161 Result = Entry->Value;
163 return object_error::success;
166 error_code MachOObjectFile::getSymbolSize(DataRefImpl DRI,
167 uint64_t &Result) const {
168 uint32_t LoadCommandCount = MachOObj->getHeader().NumLoadCommands;
169 uint64_t BeginOffset;
170 uint64_t EndOffset = 0;
171 uint8_t SectionIndex;
172 if (MachOObj->is64Bit()) {
173 InMemoryStruct<macho::Symbol64TableEntry> Entry;
174 getSymbol64TableEntry(DRI, Entry);
175 BeginOffset = Entry->Value;
176 SectionIndex = Entry->SectionIndex;
178 uint32_t flags = SymbolRef::SF_None;
179 getSymbolFlags(DRI, flags);
180 if (flags & SymbolRef::SF_Common)
181 Result = Entry->Value;
183 Result = UnknownAddressOrSize;
184 return object_error::success;
186 // Unfortunately symbols are unsorted so we need to touch all
187 // symbols from load command
189 uint32_t Command = DRI.d.a;
190 while (Command == DRI.d.a) {
191 moveToNextSymbol(DRI);
192 if (DRI.d.a < LoadCommandCount) {
193 getSymbol64TableEntry(DRI, Entry);
194 if (Entry->SectionIndex == SectionIndex && Entry->Value > BeginOffset)
195 if (!EndOffset || Entry->Value < EndOffset)
196 EndOffset = Entry->Value;
201 InMemoryStruct<macho::SymbolTableEntry> Entry;
202 getSymbolTableEntry(DRI, Entry);
203 BeginOffset = Entry->Value;
204 SectionIndex = Entry->SectionIndex;
206 uint32_t flags = SymbolRef::SF_None;
207 getSymbolFlags(DRI, flags);
208 if (flags & SymbolRef::SF_Common)
209 Result = Entry->Value;
211 Result = UnknownAddressOrSize;
212 return object_error::success;
214 // Unfortunately symbols are unsorted so we need to touch all
215 // symbols from load command
217 uint32_t Command = DRI.d.a;
218 while (Command == DRI.d.a) {
219 moveToNextSymbol(DRI);
220 if (DRI.d.a < LoadCommandCount) {
221 getSymbolTableEntry(DRI, Entry);
222 if (Entry->SectionIndex == SectionIndex && Entry->Value > BeginOffset)
223 if (!EndOffset || Entry->Value < EndOffset)
224 EndOffset = Entry->Value;
231 getSectionSize(Sections[SectionIndex-1], Size);
232 getSectionAddress(Sections[SectionIndex-1], EndOffset);
235 Result = EndOffset - BeginOffset;
236 return object_error::success;
239 error_code MachOObjectFile::getSymbolNMTypeChar(DataRefImpl DRI,
240 char &Result) const {
242 if (MachOObj->is64Bit()) {
243 InMemoryStruct<macho::Symbol64TableEntry> Entry;
244 getSymbol64TableEntry(DRI, Entry);
246 Flags = Entry->Flags;
248 InMemoryStruct<macho::SymbolTableEntry> Entry;
249 getSymbolTableEntry(DRI, Entry);
251 Flags = Entry->Flags;
255 switch (Type & macho::STF_TypeMask) {
256 case macho::STT_Undefined:
259 case macho::STT_Absolute:
260 case macho::STT_Section:
268 if (Flags & (macho::STF_External | macho::STF_PrivateExtern))
269 Char = toupper(Char);
271 return object_error::success;
274 error_code MachOObjectFile::getSymbolFlags(DataRefImpl DRI,
275 uint32_t &Result) const {
278 if (MachOObj->is64Bit()) {
279 InMemoryStruct<macho::Symbol64TableEntry> Entry;
280 getSymbol64TableEntry(DRI, Entry);
281 MachOFlags = Entry->Flags;
282 MachOType = Entry->Type;
284 InMemoryStruct<macho::SymbolTableEntry> Entry;
285 getSymbolTableEntry(DRI, Entry);
286 MachOFlags = Entry->Flags;
287 MachOType = Entry->Type;
290 // TODO: Correctly set SF_ThreadLocal
291 Result = SymbolRef::SF_None;
293 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeUndefined)
294 Result |= SymbolRef::SF_Undefined;
296 if (MachOFlags & macho::STF_StabsEntryMask)
297 Result |= SymbolRef::SF_FormatSpecific;
299 if (MachOType & MachO::NlistMaskExternal) {
300 Result |= SymbolRef::SF_Global;
301 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeUndefined)
302 Result |= SymbolRef::SF_Common;
305 if (MachOFlags & (MachO::NListDescWeakRef | MachO::NListDescWeakDef))
306 Result |= SymbolRef::SF_Weak;
308 if ((MachOType & MachO::NlistMaskType) == MachO::NListTypeAbsolute)
309 Result |= SymbolRef::SF_Absolute;
311 return object_error::success;
314 error_code MachOObjectFile::getSymbolSection(DataRefImpl Symb,
315 section_iterator &Res) const {
317 if (MachOObj->is64Bit()) {
318 InMemoryStruct<macho::Symbol64TableEntry> Entry;
319 getSymbol64TableEntry(Symb, Entry);
320 index = Entry->SectionIndex;
322 InMemoryStruct<macho::SymbolTableEntry> Entry;
323 getSymbolTableEntry(Symb, Entry);
324 index = Entry->SectionIndex;
328 Res = end_sections();
330 Res = section_iterator(SectionRef(Sections[index-1], this));
332 return object_error::success;
335 error_code MachOObjectFile::getSymbolType(DataRefImpl Symb,
336 SymbolRef::Type &Res) const {
338 if (MachOObj->is64Bit()) {
339 InMemoryStruct<macho::Symbol64TableEntry> Entry;
340 getSymbol64TableEntry(Symb, Entry);
341 n_type = Entry->Type;
343 InMemoryStruct<macho::SymbolTableEntry> Entry;
344 getSymbolTableEntry(Symb, Entry);
345 n_type = Entry->Type;
347 Res = SymbolRef::ST_Other;
349 // If this is a STAB debugging symbol, we can do nothing more.
350 if (n_type & MachO::NlistMaskStab) {
351 Res = SymbolRef::ST_Debug;
352 return object_error::success;
355 switch (n_type & MachO::NlistMaskType) {
356 case MachO::NListTypeUndefined :
357 Res = SymbolRef::ST_Unknown;
359 case MachO::NListTypeSection :
360 Res = SymbolRef::ST_Function;
363 return object_error::success;
367 symbol_iterator MachOObjectFile::begin_symbols() const {
368 // DRI.d.a = segment number; DRI.d.b = symbol index.
370 moveToNextSymbol(DRI);
371 return symbol_iterator(SymbolRef(DRI, this));
374 symbol_iterator MachOObjectFile::end_symbols() const {
376 DRI.d.a = MachOObj->getHeader().NumLoadCommands;
377 return symbol_iterator(SymbolRef(DRI, this));
380 symbol_iterator MachOObjectFile::begin_dynamic_symbols() const {
382 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
385 symbol_iterator MachOObjectFile::end_dynamic_symbols() const {
387 report_fatal_error("Dynamic symbols unimplemented in MachOObjectFile");
390 library_iterator MachOObjectFile::begin_libraries_needed() const {
392 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
395 library_iterator MachOObjectFile::end_libraries_needed() const {
397 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
400 StringRef MachOObjectFile::getLoadName() const {
402 report_fatal_error("get_load_name() unimplemented in MachOObjectFile");
405 /*===-- Sections ----------------------------------------------------------===*/
407 void MachOObjectFile::moveToNextSection(DataRefImpl &DRI) const {
408 uint32_t LoadCommandCount = MachOObj->getHeader().NumLoadCommands;
409 while (DRI.d.a < LoadCommandCount) {
410 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
411 if (LCI.Command.Type == macho::LCT_Segment) {
412 InMemoryStruct<macho::SegmentLoadCommand> SegmentLoadCmd;
413 MachOObj->ReadSegmentLoadCommand(LCI, SegmentLoadCmd);
414 if (DRI.d.b < SegmentLoadCmd->NumSections)
416 } else if (LCI.Command.Type == macho::LCT_Segment64) {
417 InMemoryStruct<macho::Segment64LoadCommand> Segment64LoadCmd;
418 MachOObj->ReadSegment64LoadCommand(LCI, Segment64LoadCmd);
419 if (DRI.d.b < Segment64LoadCmd->NumSections)
428 error_code MachOObjectFile::getSectionNext(DataRefImpl DRI,
429 SectionRef &Result) const {
431 moveToNextSection(DRI);
432 Result = SectionRef(DRI, this);
433 return object_error::success;
437 MachOObjectFile::getSection(DataRefImpl DRI,
438 InMemoryStruct<macho::Section> &Res) const {
439 InMemoryStruct<macho::SegmentLoadCommand> SLC;
440 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
441 MachOObj->ReadSegmentLoadCommand(LCI, SLC);
442 MachOObj->ReadSection(LCI, DRI.d.b, Res);
445 std::size_t MachOObjectFile::getSectionIndex(DataRefImpl Sec) const {
446 SectionList::const_iterator loc =
447 std::find(Sections.begin(), Sections.end(), Sec);
448 assert(loc != Sections.end() && "Sec is not a valid section!");
449 return std::distance(Sections.begin(), loc);
453 MachOObjectFile::getSection64(DataRefImpl DRI,
454 InMemoryStruct<macho::Section64> &Res) const {
455 InMemoryStruct<macho::Segment64LoadCommand> SLC;
456 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
457 MachOObj->ReadSegment64LoadCommand(LCI, SLC);
458 MachOObj->ReadSection64(LCI, DRI.d.b, Res);
461 static bool is64BitLoadCommand(const MachOObject *MachOObj, DataRefImpl DRI) {
462 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
463 if (LCI.Command.Type == macho::LCT_Segment64)
465 assert(LCI.Command.Type == macho::LCT_Segment && "Unexpected Type.");
469 error_code MachOObjectFile::getSectionName(DataRefImpl DRI,
470 StringRef &Result) const {
471 // FIXME: thread safety.
472 static char result[34];
473 if (is64BitLoadCommand(MachOObj, DRI)) {
474 InMemoryStruct<macho::Segment64LoadCommand> SLC;
475 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
476 MachOObj->ReadSegment64LoadCommand(LCI, SLC);
477 InMemoryStruct<macho::Section64> Sect;
478 MachOObj->ReadSection64(LCI, DRI.d.b, Sect);
480 strcpy(result, Sect->SegmentName);
482 strcat(result, Sect->Name);
484 InMemoryStruct<macho::SegmentLoadCommand> SLC;
485 LoadCommandInfo LCI = MachOObj->getLoadCommandInfo(DRI.d.a);
486 MachOObj->ReadSegmentLoadCommand(LCI, SLC);
487 InMemoryStruct<macho::Section> Sect;
488 MachOObj->ReadSection(LCI, DRI.d.b, Sect);
490 strcpy(result, Sect->SegmentName);
492 strcat(result, Sect->Name);
494 Result = StringRef(result);
495 return object_error::success;
498 error_code MachOObjectFile::getSectionAddress(DataRefImpl DRI,
499 uint64_t &Result) const {
500 if (is64BitLoadCommand(MachOObj, DRI)) {
501 InMemoryStruct<macho::Section64> Sect;
502 getSection64(DRI, Sect);
503 Result = Sect->Address;
505 InMemoryStruct<macho::Section> Sect;
506 getSection(DRI, Sect);
507 Result = Sect->Address;
509 return object_error::success;
512 error_code MachOObjectFile::getSectionSize(DataRefImpl DRI,
513 uint64_t &Result) const {
514 if (is64BitLoadCommand(MachOObj, DRI)) {
515 InMemoryStruct<macho::Section64> Sect;
516 getSection64(DRI, Sect);
519 InMemoryStruct<macho::Section> Sect;
520 getSection(DRI, Sect);
523 return object_error::success;
526 error_code MachOObjectFile::getSectionContents(DataRefImpl DRI,
527 StringRef &Result) const {
528 if (is64BitLoadCommand(MachOObj, DRI)) {
529 InMemoryStruct<macho::Section64> Sect;
530 getSection64(DRI, Sect);
531 Result = MachOObj->getData(Sect->Offset, Sect->Size);
533 InMemoryStruct<macho::Section> Sect;
534 getSection(DRI, Sect);
535 Result = MachOObj->getData(Sect->Offset, Sect->Size);
537 return object_error::success;
540 error_code MachOObjectFile::getSectionAlignment(DataRefImpl DRI,
541 uint64_t &Result) const {
542 if (is64BitLoadCommand(MachOObj, DRI)) {
543 InMemoryStruct<macho::Section64> Sect;
544 getSection64(DRI, Sect);
545 Result = uint64_t(1) << Sect->Align;
547 InMemoryStruct<macho::Section> Sect;
548 getSection(DRI, Sect);
549 Result = uint64_t(1) << Sect->Align;
551 return object_error::success;
554 error_code MachOObjectFile::isSectionText(DataRefImpl DRI,
555 bool &Result) const {
556 if (is64BitLoadCommand(MachOObj, DRI)) {
557 InMemoryStruct<macho::Section64> Sect;
558 getSection64(DRI, Sect);
559 Result = !strcmp(Sect->Name, "__text");
561 InMemoryStruct<macho::Section> Sect;
562 getSection(DRI, Sect);
563 Result = !strcmp(Sect->Name, "__text");
565 return object_error::success;
568 error_code MachOObjectFile::isSectionData(DataRefImpl DRI,
569 bool &Result) const {
570 // FIXME: Unimplemented.
572 return object_error::success;
575 error_code MachOObjectFile::isSectionBSS(DataRefImpl DRI,
576 bool &Result) const {
577 // FIXME: Unimplemented.
579 return object_error::success;
582 error_code MachOObjectFile::isSectionRequiredForExecution(DataRefImpl Sec,
583 bool &Result) const {
584 // FIXME: Unimplemented
586 return object_error::success;
589 error_code MachOObjectFile::isSectionVirtual(DataRefImpl Sec,
590 bool &Result) const {
591 // FIXME: Unimplemented
593 return object_error::success;
596 error_code MachOObjectFile::isSectionZeroInit(DataRefImpl DRI,
597 bool &Result) const {
598 if (MachOObj->is64Bit()) {
599 InMemoryStruct<macho::Section64> Sect;
600 getSection64(DRI, Sect);
601 Result = (Sect->Flags & MachO::SectionTypeZeroFill ||
602 Sect->Flags & MachO::SectionTypeZeroFillLarge);
604 InMemoryStruct<macho::Section> Sect;
605 getSection(DRI, Sect);
606 Result = (Sect->Flags & MachO::SectionTypeZeroFill ||
607 Sect->Flags & MachO::SectionTypeZeroFillLarge);
610 return object_error::success;
613 error_code MachOObjectFile::sectionContainsSymbol(DataRefImpl Sec,
615 bool &Result) const {
617 getSymbolType(Symb, ST);
618 if (ST == SymbolRef::ST_Unknown) {
620 return object_error::success;
623 uint64_t SectBegin, SectEnd;
624 getSectionAddress(Sec, SectBegin);
625 getSectionSize(Sec, SectEnd);
626 SectEnd += SectBegin;
628 if (MachOObj->is64Bit()) {
629 InMemoryStruct<macho::Symbol64TableEntry> Entry;
630 getSymbol64TableEntry(Symb, Entry);
631 uint64_t SymAddr= Entry->Value;
632 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
634 InMemoryStruct<macho::SymbolTableEntry> Entry;
635 getSymbolTableEntry(Symb, Entry);
636 uint64_t SymAddr= Entry->Value;
637 Result = (SymAddr >= SectBegin) && (SymAddr < SectEnd);
640 return object_error::success;
643 relocation_iterator MachOObjectFile::getSectionRelBegin(DataRefImpl Sec) const {
645 ret.d.b = getSectionIndex(Sec);
646 return relocation_iterator(RelocationRef(ret, this));
648 relocation_iterator MachOObjectFile::getSectionRelEnd(DataRefImpl Sec) const {
650 if (is64BitLoadCommand(MachOObj, Sec)) {
651 InMemoryStruct<macho::Section64> Sect;
652 getSection64(Sec, Sect);
653 last_reloc = Sect->NumRelocationTableEntries;
655 InMemoryStruct<macho::Section> Sect;
656 getSection(Sec, Sect);
657 last_reloc = Sect->NumRelocationTableEntries;
660 ret.d.a = last_reloc;
661 ret.d.b = getSectionIndex(Sec);
662 return relocation_iterator(RelocationRef(ret, this));
665 section_iterator MachOObjectFile::begin_sections() const {
667 moveToNextSection(DRI);
668 return section_iterator(SectionRef(DRI, this));
671 section_iterator MachOObjectFile::end_sections() const {
673 DRI.d.a = MachOObj->getHeader().NumLoadCommands;
674 return section_iterator(SectionRef(DRI, this));
677 /*===-- Relocations -------------------------------------------------------===*/
679 void MachOObjectFile::
680 getRelocation(DataRefImpl Rel,
681 InMemoryStruct<macho::RelocationEntry> &Res) const {
683 if (MachOObj->is64Bit()) {
684 InMemoryStruct<macho::Section64> Sect;
685 getSection64(Sections[Rel.d.b], Sect);
686 relOffset = Sect->RelocationTableOffset;
688 InMemoryStruct<macho::Section> Sect;
689 getSection(Sections[Rel.d.b], Sect);
690 relOffset = Sect->RelocationTableOffset;
692 MachOObj->ReadRelocationEntry(relOffset, Rel.d.a, Res);
694 error_code MachOObjectFile::getRelocationNext(DataRefImpl Rel,
695 RelocationRef &Res) const {
697 Res = RelocationRef(Rel, this);
698 return object_error::success;
700 error_code MachOObjectFile::getRelocationAddress(DataRefImpl Rel,
701 uint64_t &Res) const {
702 const uint8_t* sectAddress = 0;
703 if (MachOObj->is64Bit()) {
704 InMemoryStruct<macho::Section64> Sect;
705 getSection64(Sections[Rel.d.b], Sect);
706 sectAddress += Sect->Address;
708 InMemoryStruct<macho::Section> Sect;
709 getSection(Sections[Rel.d.b], Sect);
710 sectAddress += Sect->Address;
712 InMemoryStruct<macho::RelocationEntry> RE;
713 getRelocation(Rel, RE);
715 unsigned Arch = getArch();
716 bool isScattered = (Arch != Triple::x86_64) &&
717 (RE->Word0 & macho::RF_Scattered);
718 uint64_t RelAddr = 0;
720 RelAddr = RE->Word0 & 0xFFFFFF;
724 Res = reinterpret_cast<uintptr_t>(sectAddress + RelAddr);
725 return object_error::success;
727 error_code MachOObjectFile::getRelocationOffset(DataRefImpl Rel,
728 uint64_t &Res) const {
729 InMemoryStruct<macho::RelocationEntry> RE;
730 getRelocation(Rel, RE);
732 unsigned Arch = getArch();
733 bool isScattered = (Arch != Triple::x86_64) &&
734 (RE->Word0 & macho::RF_Scattered);
736 Res = RE->Word0 & 0xFFFFFF;
739 return object_error::success;
741 error_code MachOObjectFile::getRelocationSymbol(DataRefImpl Rel,
742 SymbolRef &Res) const {
743 InMemoryStruct<macho::RelocationEntry> RE;
744 getRelocation(Rel, RE);
745 uint32_t SymbolIdx = RE->Word1 & 0xffffff;
746 bool isExtern = (RE->Word1 >> 27) & 1;
749 moveToNextSymbol(Sym);
751 for (unsigned i = 0; i < SymbolIdx; i++) {
753 moveToNextSymbol(Sym);
754 assert(Sym.d.a < MachOObj->getHeader().NumLoadCommands &&
755 "Relocation symbol index out of range!");
758 Res = SymbolRef(Sym, this);
759 return object_error::success;
761 error_code MachOObjectFile::getRelocationType(DataRefImpl Rel,
762 uint64_t &Res) const {
763 InMemoryStruct<macho::RelocationEntry> RE;
764 getRelocation(Rel, RE);
768 return object_error::success;
770 error_code MachOObjectFile::getRelocationTypeName(DataRefImpl Rel,
771 SmallVectorImpl<char> &Result) const {
772 // TODO: Support scattered relocations.
774 InMemoryStruct<macho::RelocationEntry> RE;
775 getRelocation(Rel, RE);
777 unsigned Arch = getArch();
778 bool isScattered = (Arch != Triple::x86_64) &&
779 (RE->Word0 & macho::RF_Scattered);
783 r_type = (RE->Word0 >> 24) & 0xF;
785 r_type = (RE->Word1 >> 28) & 0xF;
789 const char* Table[] = {
790 "GENERIC_RELOC_VANILLA",
791 "GENERIC_RELOC_PAIR",
792 "GENERIC_RELOC_SECTDIFF",
793 "GENERIC_RELOC_PB_LA_PTR",
794 "GENERIC_RELOC_LOCAL_SECTDIFF",
795 "GENERIC_RELOC_TLV" };
803 case Triple::x86_64: {
804 const char* Table[] = {
805 "X86_64_RELOC_UNSIGNED",
806 "X86_64_RELOC_SIGNED",
807 "X86_64_RELOC_BRANCH",
808 "X86_64_RELOC_GOT_LOAD",
810 "X86_64_RELOC_SUBTRACTOR",
811 "X86_64_RELOC_SIGNED_1",
812 "X86_64_RELOC_SIGNED_2",
813 "X86_64_RELOC_SIGNED_4",
814 "X86_64_RELOC_TLV" };
823 const char* Table[] = {
826 "ARM_RELOC_SECTDIFF",
827 "ARM_RELOC_LOCAL_SECTDIFF",
828 "ARM_RELOC_PB_LA_PTR",
830 "ARM_THUMB_RELOC_BR22",
831 "ARM_THUMB_32BIT_BRANCH",
833 "ARM_RELOC_HALF_SECTDIFF" };
842 const char* Table[] = {
851 "PPC_RELOC_SECTDIFF",
852 "PPC_RELOC_PB_LA_PTR",
853 "PPC_RELOC_HI16_SECTDIFF",
854 "PPC_RELOC_LO16_SECTDIFF",
855 "PPC_RELOC_HA16_SECTDIFF",
857 "PPC_RELOC_LO14_SECTDIFF",
858 "PPC_RELOC_LOCAL_SECTDIFF" };
863 case Triple::UnknownArch:
867 Result.append(res.begin(), res.end());
868 return object_error::success;
870 error_code MachOObjectFile::getRelocationAdditionalInfo(DataRefImpl Rel,
871 int64_t &Res) const {
872 InMemoryStruct<macho::RelocationEntry> RE;
873 getRelocation(Rel, RE);
874 bool isExtern = (RE->Word1 >> 27) & 1;
877 const uint8_t* sectAddress = base();
878 if (MachOObj->is64Bit()) {
879 InMemoryStruct<macho::Section64> Sect;
880 getSection64(Sections[Rel.d.b], Sect);
881 sectAddress += Sect->Offset;
883 InMemoryStruct<macho::Section> Sect;
884 getSection(Sections[Rel.d.b], Sect);
885 sectAddress += Sect->Offset;
887 Res = reinterpret_cast<uintptr_t>(sectAddress);
889 return object_error::success;
892 // Helper to advance a section or symbol iterator multiple increments at a time.
894 error_code advance(T &it, size_t Val) {
903 void advanceTo(T &it, size_t Val) {
904 if (error_code ec = advance(it, Val))
905 report_fatal_error(ec.message());
908 void MachOObjectFile::printRelocationTargetName(
909 InMemoryStruct<macho::RelocationEntry>& RE,
910 raw_string_ostream &fmt) const {
911 unsigned Arch = getArch();
912 bool isScattered = (Arch != Triple::x86_64) &&
913 (RE->Word0 & macho::RF_Scattered);
915 // Target of a scattered relocation is an address. In the interest of
916 // generating pretty output, scan through the symbol table looking for a
917 // symbol that aligns with that address. If we find one, print it.
918 // Otherwise, we just print the hex address of the target.
920 uint32_t Val = RE->Word1;
923 for (symbol_iterator SI = begin_symbols(), SE = end_symbols(); SI != SE;
925 if (ec) report_fatal_error(ec.message());
930 if ((ec = SI->getAddress(Addr)))
931 report_fatal_error(ec.message());
932 if (Addr != Val) continue;
933 if ((ec = SI->getName(Name)))
934 report_fatal_error(ec.message());
939 // If we couldn't find a symbol that this relocation refers to, try
940 // to find a section beginning instead.
941 for (section_iterator SI = begin_sections(), SE = end_sections(); SI != SE;
943 if (ec) report_fatal_error(ec.message());
948 if ((ec = SI->getAddress(Addr)))
949 report_fatal_error(ec.message());
950 if (Addr != Val) continue;
951 if ((ec = SI->getName(Name)))
952 report_fatal_error(ec.message());
957 fmt << format("0x%x", Val);
962 bool isExtern = (RE->Word1 >> 27) & 1;
963 uint32_t Val = RE->Word1 & 0xFFFFFF;
966 symbol_iterator SI = begin_symbols();
970 section_iterator SI = begin_sections();
978 error_code MachOObjectFile::getRelocationValueString(DataRefImpl Rel,
979 SmallVectorImpl<char> &Result) const {
980 InMemoryStruct<macho::RelocationEntry> RE;
981 getRelocation(Rel, RE);
983 unsigned Arch = getArch();
984 bool isScattered = (Arch != Triple::x86_64) &&
985 (RE->Word0 & macho::RF_Scattered);
988 raw_string_ostream fmt(fmtbuf);
992 Type = (RE->Word0 >> 24) & 0xF;
994 Type = (RE->Word1 >> 28) & 0xF;
998 isPCRel = ((RE->Word0 >> 30) & 1);
1000 isPCRel = ((RE->Word1 >> 24) & 1);
1002 // Determine any addends that should be displayed with the relocation.
1003 // These require decoding the relocation type, which is triple-specific.
1005 // X86_64 has entirely custom relocation types.
1006 if (Arch == Triple::x86_64) {
1007 bool isPCRel = ((RE->Word1 >> 24) & 1);
1010 case macho::RIT_X86_64_GOTLoad: // X86_64_RELOC_GOT_LOAD
1011 case macho::RIT_X86_64_GOT: { // X86_64_RELOC_GOT
1012 printRelocationTargetName(RE, fmt);
1014 if (isPCRel) fmt << "PCREL";
1017 case macho::RIT_X86_64_Subtractor: { // X86_64_RELOC_SUBTRACTOR
1018 InMemoryStruct<macho::RelocationEntry> RENext;
1019 DataRefImpl RelNext = Rel;
1021 getRelocation(RelNext, RENext);
1023 // X86_64_SUBTRACTOR must be followed by a relocation of type
1024 // X86_64_RELOC_UNSIGNED.
1025 // NOTE: Scattered relocations don't exist on x86_64.
1026 unsigned RType = (RENext->Word1 >> 28) & 0xF;
1028 report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
1029 "X86_64_RELOC_SUBTRACTOR.");
1031 // The X86_64_RELOC_UNSIGNED contains the minuend symbol,
1032 // X86_64_SUBTRACTOR contains to the subtrahend.
1033 printRelocationTargetName(RENext, fmt);
1035 printRelocationTargetName(RE, fmt);
1037 case macho::RIT_X86_64_TLV:
1038 printRelocationTargetName(RE, fmt);
1040 if (isPCRel) fmt << "P";
1042 case macho::RIT_X86_64_Signed1: // X86_64_RELOC_SIGNED1
1043 printRelocationTargetName(RE, fmt);
1046 case macho::RIT_X86_64_Signed2: // X86_64_RELOC_SIGNED2
1047 printRelocationTargetName(RE, fmt);
1050 case macho::RIT_X86_64_Signed4: // X86_64_RELOC_SIGNED4
1051 printRelocationTargetName(RE, fmt);
1055 printRelocationTargetName(RE, fmt);
1058 // X86 and ARM share some relocation types in common.
1059 } else if (Arch == Triple::x86 || Arch == Triple::arm) {
1060 // Generic relocation types...
1062 case macho::RIT_Pair: // GENERIC_RELOC_PAIR - prints no info
1063 return object_error::success;
1064 case macho::RIT_Difference: { // GENERIC_RELOC_SECTDIFF
1065 InMemoryStruct<macho::RelocationEntry> RENext;
1066 DataRefImpl RelNext = Rel;
1068 getRelocation(RelNext, RENext);
1070 // X86 sect diff's must be followed by a relocation of type
1071 // GENERIC_RELOC_PAIR.
1072 bool isNextScattered = (Arch != Triple::x86_64) &&
1073 (RENext->Word0 & macho::RF_Scattered);
1075 if (isNextScattered)
1076 RType = (RENext->Word0 >> 24) & 0xF;
1078 RType = (RENext->Word1 >> 28) & 0xF;
1080 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1081 "GENERIC_RELOC_SECTDIFF.");
1083 printRelocationTargetName(RE, fmt);
1085 printRelocationTargetName(RENext, fmt);
1090 if (Arch == Triple::x86) {
1091 // All X86 relocations that need special printing were already
1092 // handled in the generic code.
1094 case macho::RIT_Generic_LocalDifference:{// GENERIC_RELOC_LOCAL_SECTDIFF
1095 InMemoryStruct<macho::RelocationEntry> RENext;
1096 DataRefImpl RelNext = Rel;
1098 getRelocation(RelNext, RENext);
1100 // X86 sect diff's must be followed by a relocation of type
1101 // GENERIC_RELOC_PAIR.
1102 bool isNextScattered = (Arch != Triple::x86_64) &&
1103 (RENext->Word0 & macho::RF_Scattered);
1105 if (isNextScattered)
1106 RType = (RENext->Word0 >> 24) & 0xF;
1108 RType = (RENext->Word1 >> 28) & 0xF;
1110 report_fatal_error("Expected GENERIC_RELOC_PAIR after "
1111 "GENERIC_RELOC_LOCAL_SECTDIFF.");
1113 printRelocationTargetName(RE, fmt);
1115 printRelocationTargetName(RENext, fmt);
1118 case macho::RIT_Generic_TLV: {
1119 printRelocationTargetName(RE, fmt);
1121 if (isPCRel) fmt << "P";
1125 printRelocationTargetName(RE, fmt);
1127 } else { // ARM-specific relocations
1129 case macho::RIT_ARM_Half: // ARM_RELOC_HALF
1130 case macho::RIT_ARM_HalfDifference: { // ARM_RELOC_HALF_SECTDIFF
1131 // Half relocations steal a bit from the length field to encode
1132 // whether this is an upper16 or a lower16 relocation.
1135 isUpper = (RE->Word0 >> 28) & 1;
1137 isUpper = (RE->Word1 >> 25) & 1;
1140 fmt << ":upper16:(";
1142 fmt << ":lower16:(";
1143 printRelocationTargetName(RE, fmt);
1145 InMemoryStruct<macho::RelocationEntry> RENext;
1146 DataRefImpl RelNext = Rel;
1148 getRelocation(RelNext, RENext);
1150 // ARM half relocs must be followed by a relocation of type
1152 bool isNextScattered = (Arch != Triple::x86_64) &&
1153 (RENext->Word0 & macho::RF_Scattered);
1155 if (isNextScattered)
1156 RType = (RENext->Word0 >> 24) & 0xF;
1158 RType = (RENext->Word1 >> 28) & 0xF;
1161 report_fatal_error("Expected ARM_RELOC_PAIR after "
1162 "GENERIC_RELOC_HALF");
1164 // NOTE: The half of the target virtual address is stashed in the
1165 // address field of the secondary relocation, but we can't reverse
1166 // engineer the constant offset from it without decoding the movw/movt
1167 // instruction to find the other half in its immediate field.
1169 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
1170 // symbol/section pointer of the follow-on relocation.
1171 if (Type == macho::RIT_ARM_HalfDifference) {
1173 printRelocationTargetName(RENext, fmt);
1180 printRelocationTargetName(RE, fmt);
1185 printRelocationTargetName(RE, fmt);
1188 Result.append(fmtbuf.begin(), fmtbuf.end());
1189 return object_error::success;
1192 error_code MachOObjectFile::getRelocationHidden(DataRefImpl Rel,
1193 bool &Result) const {
1194 InMemoryStruct<macho::RelocationEntry> RE;
1195 getRelocation(Rel, RE);
1197 unsigned Arch = getArch();
1198 bool isScattered = (Arch != Triple::x86_64) &&
1199 (RE->Word0 & macho::RF_Scattered);
1202 Type = (RE->Word0 >> 24) & 0xF;
1204 Type = (RE->Word1 >> 28) & 0xF;
1208 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
1209 // is always hidden.
1210 if (Arch == Triple::x86 || Arch == Triple::arm) {
1211 if (Type == macho::RIT_Pair) Result = true;
1212 } else if (Arch == Triple::x86_64) {
1213 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
1214 // an X864_64_RELOC_SUBTRACTOR.
1215 if (Type == macho::RIT_X86_64_Unsigned && Rel.d.a > 0) {
1216 DataRefImpl RelPrev = Rel;
1218 InMemoryStruct<macho::RelocationEntry> REPrev;
1219 getRelocation(RelPrev, REPrev);
1221 unsigned PrevType = (REPrev->Word1 >> 28) & 0xF;
1223 if (PrevType == macho::RIT_X86_64_Subtractor) Result = true;
1227 return object_error::success;
1230 error_code MachOObjectFile::getLibraryNext(DataRefImpl LibData,
1231 LibraryRef &Res) const {
1232 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1235 error_code MachOObjectFile::getLibraryPath(DataRefImpl LibData,
1236 StringRef &Res) const {
1237 report_fatal_error("Needed libraries unimplemented in MachOObjectFile");
1241 /*===-- Miscellaneous -----------------------------------------------------===*/
1243 uint8_t MachOObjectFile::getBytesInAddress() const {
1244 return MachOObj->is64Bit() ? 8 : 4;
1247 StringRef MachOObjectFile::getFileFormatName() const {
1248 if (!MachOObj->is64Bit()) {
1249 switch (MachOObj->getHeader().CPUType) {
1250 case llvm::MachO::CPUTypeI386:
1251 return "Mach-O 32-bit i386";
1252 case llvm::MachO::CPUTypeARM:
1253 return "Mach-O arm";
1254 case llvm::MachO::CPUTypePowerPC:
1255 return "Mach-O 32-bit ppc";
1257 assert((MachOObj->getHeader().CPUType & llvm::MachO::CPUArchABI64) == 0 &&
1258 "64-bit object file when we're not 64-bit?");
1259 return "Mach-O 32-bit unknown";
1263 switch (MachOObj->getHeader().CPUType) {
1264 case llvm::MachO::CPUTypeX86_64:
1265 return "Mach-O 64-bit x86-64";
1266 case llvm::MachO::CPUTypePowerPC64:
1267 return "Mach-O 64-bit ppc64";
1269 assert((MachOObj->getHeader().CPUType & llvm::MachO::CPUArchABI64) == 1 &&
1270 "32-bit object file when we're 64-bit?");
1271 return "Mach-O 64-bit unknown";
1275 unsigned MachOObjectFile::getArch() const {
1276 switch (MachOObj->getHeader().CPUType) {
1277 case llvm::MachO::CPUTypeI386:
1279 case llvm::MachO::CPUTypeX86_64:
1280 return Triple::x86_64;
1281 case llvm::MachO::CPUTypeARM:
1283 case llvm::MachO::CPUTypePowerPC:
1285 case llvm::MachO::CPUTypePowerPC64:
1286 return Triple::ppc64;
1288 return Triple::UnknownArch;
1292 } // end namespace object
1293 } // end namespace llvm