xref: /llvm-project/llvm/lib/Object/MachOObjectFile.cpp (revision db3dba52caa8cd8bb37fa1c7cd2a0bc1ddb214eb)
1 //===- MachOObjectFile.cpp - Mach-O object file binding -------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the MachOObjectFile class, which binds the MachOObject
10 // class to the generic ObjectFile wrapper.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/ADT/ArrayRef.h"
15 #include "llvm/ADT/None.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/StringSwitch.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/ADT/Twine.h"
22 #include "llvm/BinaryFormat/MachO.h"
23 #include "llvm/Object/Error.h"
24 #include "llvm/Object/MachO.h"
25 #include "llvm/Object/ObjectFile.h"
26 #include "llvm/Object/SymbolicFile.h"
27 #include "llvm/Support/DataExtractor.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/Error.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/Format.h"
32 #include "llvm/Support/Host.h"
33 #include "llvm/Support/LEB128.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 #include "llvm/Support/SwapByteOrder.h"
36 #include "llvm/Support/raw_ostream.h"
37 #include <algorithm>
38 #include <cassert>
39 #include <cstddef>
40 #include <cstdint>
41 #include <cstring>
42 #include <limits>
43 #include <list>
44 #include <memory>
45 #include <string>
46 #include <system_error>
47 
48 using namespace llvm;
49 using namespace object;
50 
51 namespace {
52 
53   struct section_base {
54     char sectname[16];
55     char segname[16];
56   };
57 
58 } // end anonymous namespace
59 
60 static Error malformedError(const Twine &Msg) {
61   return make_error<GenericBinaryError>("truncated or malformed object (" +
62                                             Msg + ")",
63                                         object_error::parse_failed);
64 }
65 
66 // FIXME: Replace all uses of this function with getStructOrErr.
67 template <typename T>
68 static T getStruct(const MachOObjectFile &O, const char *P) {
69   // Don't read before the beginning or past the end of the file
70   if (P < O.getData().begin() || P + sizeof(T) > O.getData().end())
71     report_fatal_error("Malformed MachO file.");
72 
73   T Cmd;
74   memcpy(&Cmd, P, sizeof(T));
75   if (O.isLittleEndian() != sys::IsLittleEndianHost)
76     MachO::swapStruct(Cmd);
77   return Cmd;
78 }
79 
80 template <typename T>
81 static Expected<T> getStructOrErr(const MachOObjectFile &O, const char *P) {
82   // Don't read before the beginning or past the end of the file
83   if (P < O.getData().begin() || P + sizeof(T) > O.getData().end())
84     return malformedError("Structure read out-of-range");
85 
86   T Cmd;
87   memcpy(&Cmd, P, sizeof(T));
88   if (O.isLittleEndian() != sys::IsLittleEndianHost)
89     MachO::swapStruct(Cmd);
90   return Cmd;
91 }
92 
93 static const char *
94 getSectionPtr(const MachOObjectFile &O, MachOObjectFile::LoadCommandInfo L,
95               unsigned Sec) {
96   uintptr_t CommandAddr = reinterpret_cast<uintptr_t>(L.Ptr);
97 
98   bool Is64 = O.is64Bit();
99   unsigned SegmentLoadSize = Is64 ? sizeof(MachO::segment_command_64) :
100                                     sizeof(MachO::segment_command);
101   unsigned SectionSize = Is64 ? sizeof(MachO::section_64) :
102                                 sizeof(MachO::section);
103 
104   uintptr_t SectionAddr = CommandAddr + SegmentLoadSize + Sec * SectionSize;
105   return reinterpret_cast<const char*>(SectionAddr);
106 }
107 
108 static const char *getPtr(const MachOObjectFile &O, size_t Offset) {
109   assert(Offset <= O.getData().size());
110   return O.getData().data() + Offset;
111 }
112 
113 static MachO::nlist_base
114 getSymbolTableEntryBase(const MachOObjectFile &O, DataRefImpl DRI) {
115   const char *P = reinterpret_cast<const char *>(DRI.p);
116   return getStruct<MachO::nlist_base>(O, P);
117 }
118 
119 static StringRef parseSegmentOrSectionName(const char *P) {
120   if (P[15] == 0)
121     // Null terminated.
122     return P;
123   // Not null terminated, so this is a 16 char string.
124   return StringRef(P, 16);
125 }
126 
127 static unsigned getCPUType(const MachOObjectFile &O) {
128   return O.getHeader().cputype;
129 }
130 
131 static unsigned getCPUSubType(const MachOObjectFile &O) {
132   return O.getHeader().cpusubtype;
133 }
134 
135 static uint32_t
136 getPlainRelocationAddress(const MachO::any_relocation_info &RE) {
137   return RE.r_word0;
138 }
139 
140 static unsigned
141 getScatteredRelocationAddress(const MachO::any_relocation_info &RE) {
142   return RE.r_word0 & 0xffffff;
143 }
144 
145 static bool getPlainRelocationPCRel(const MachOObjectFile &O,
146                                     const MachO::any_relocation_info &RE) {
147   if (O.isLittleEndian())
148     return (RE.r_word1 >> 24) & 1;
149   return (RE.r_word1 >> 7) & 1;
150 }
151 
152 static bool
153 getScatteredRelocationPCRel(const MachO::any_relocation_info &RE) {
154   return (RE.r_word0 >> 30) & 1;
155 }
156 
157 static unsigned getPlainRelocationLength(const MachOObjectFile &O,
158                                          const MachO::any_relocation_info &RE) {
159   if (O.isLittleEndian())
160     return (RE.r_word1 >> 25) & 3;
161   return (RE.r_word1 >> 5) & 3;
162 }
163 
164 static unsigned
165 getScatteredRelocationLength(const MachO::any_relocation_info &RE) {
166   return (RE.r_word0 >> 28) & 3;
167 }
168 
169 static unsigned getPlainRelocationType(const MachOObjectFile &O,
170                                        const MachO::any_relocation_info &RE) {
171   if (O.isLittleEndian())
172     return RE.r_word1 >> 28;
173   return RE.r_word1 & 0xf;
174 }
175 
176 static uint32_t getSectionFlags(const MachOObjectFile &O,
177                                 DataRefImpl Sec) {
178   if (O.is64Bit()) {
179     MachO::section_64 Sect = O.getSection64(Sec);
180     return Sect.flags;
181   }
182   MachO::section Sect = O.getSection(Sec);
183   return Sect.flags;
184 }
185 
186 static Expected<MachOObjectFile::LoadCommandInfo>
187 getLoadCommandInfo(const MachOObjectFile &Obj, const char *Ptr,
188                    uint32_t LoadCommandIndex) {
189   if (auto CmdOrErr = getStructOrErr<MachO::load_command>(Obj, Ptr)) {
190     if (CmdOrErr->cmdsize + Ptr > Obj.getData().end())
191       return malformedError("load command " + Twine(LoadCommandIndex) +
192                             " extends past end of file");
193     if (CmdOrErr->cmdsize < 8)
194       return malformedError("load command " + Twine(LoadCommandIndex) +
195                             " with size less than 8 bytes");
196     return MachOObjectFile::LoadCommandInfo({Ptr, *CmdOrErr});
197   } else
198     return CmdOrErr.takeError();
199 }
200 
201 static Expected<MachOObjectFile::LoadCommandInfo>
202 getFirstLoadCommandInfo(const MachOObjectFile &Obj) {
203   unsigned HeaderSize = Obj.is64Bit() ? sizeof(MachO::mach_header_64)
204                                       : sizeof(MachO::mach_header);
205   if (sizeof(MachO::load_command) > Obj.getHeader().sizeofcmds)
206     return malformedError("load command 0 extends past the end all load "
207                           "commands in the file");
208   return getLoadCommandInfo(Obj, getPtr(Obj, HeaderSize), 0);
209 }
210 
211 static Expected<MachOObjectFile::LoadCommandInfo>
212 getNextLoadCommandInfo(const MachOObjectFile &Obj, uint32_t LoadCommandIndex,
213                        const MachOObjectFile::LoadCommandInfo &L) {
214   unsigned HeaderSize = Obj.is64Bit() ? sizeof(MachO::mach_header_64)
215                                       : sizeof(MachO::mach_header);
216   if (L.Ptr + L.C.cmdsize + sizeof(MachO::load_command) >
217       Obj.getData().data() + HeaderSize + Obj.getHeader().sizeofcmds)
218     return malformedError("load command " + Twine(LoadCommandIndex + 1) +
219                           " extends past the end all load commands in the file");
220   return getLoadCommandInfo(Obj, L.Ptr + L.C.cmdsize, LoadCommandIndex + 1);
221 }
222 
223 template <typename T>
224 static void parseHeader(const MachOObjectFile &Obj, T &Header,
225                         Error &Err) {
226   if (sizeof(T) > Obj.getData().size()) {
227     Err = malformedError("the mach header extends past the end of the "
228                          "file");
229     return;
230   }
231   if (auto HeaderOrErr = getStructOrErr<T>(Obj, getPtr(Obj, 0)))
232     Header = *HeaderOrErr;
233   else
234     Err = HeaderOrErr.takeError();
235 }
236 
237 // This is used to check for overlapping of Mach-O elements.
238 struct MachOElement {
239   uint64_t Offset;
240   uint64_t Size;
241   const char *Name;
242 };
243 
244 static Error checkOverlappingElement(std::list<MachOElement> &Elements,
245                                      uint64_t Offset, uint64_t Size,
246                                      const char *Name) {
247   if (Size == 0)
248     return Error::success();
249 
250   for (auto it=Elements.begin() ; it != Elements.end(); ++it) {
251     auto E = *it;
252     if ((Offset >= E.Offset && Offset < E.Offset + E.Size) ||
253         (Offset + Size > E.Offset && Offset + Size < E.Offset + E.Size) ||
254         (Offset <= E.Offset && Offset + Size >= E.Offset + E.Size))
255       return malformedError(Twine(Name) + " at offset " + Twine(Offset) +
256                             " with a size of " + Twine(Size) + ", overlaps " +
257                             E.Name + " at offset " + Twine(E.Offset) + " with "
258                             "a size of " + Twine(E.Size));
259     auto nt = it;
260     nt++;
261     if (nt != Elements.end()) {
262       auto N = *nt;
263       if (Offset + Size <= N.Offset) {
264         Elements.insert(nt, {Offset, Size, Name});
265         return Error::success();
266       }
267     }
268   }
269   Elements.push_back({Offset, Size, Name});
270   return Error::success();
271 }
272 
273 // Parses LC_SEGMENT or LC_SEGMENT_64 load command, adds addresses of all
274 // sections to \param Sections, and optionally sets
275 // \param IsPageZeroSegment to true.
276 template <typename Segment, typename Section>
277 static Error parseSegmentLoadCommand(
278     const MachOObjectFile &Obj, const MachOObjectFile::LoadCommandInfo &Load,
279     SmallVectorImpl<const char *> &Sections, bool &IsPageZeroSegment,
280     uint32_t LoadCommandIndex, const char *CmdName, uint64_t SizeOfHeaders,
281     std::list<MachOElement> &Elements) {
282   const unsigned SegmentLoadSize = sizeof(Segment);
283   if (Load.C.cmdsize < SegmentLoadSize)
284     return malformedError("load command " + Twine(LoadCommandIndex) +
285                           " " + CmdName + " cmdsize too small");
286   if (auto SegOrErr = getStructOrErr<Segment>(Obj, Load.Ptr)) {
287     Segment S = SegOrErr.get();
288     const unsigned SectionSize = sizeof(Section);
289     uint64_t FileSize = Obj.getData().size();
290     if (S.nsects > std::numeric_limits<uint32_t>::max() / SectionSize ||
291         S.nsects * SectionSize > Load.C.cmdsize - SegmentLoadSize)
292       return malformedError("load command " + Twine(LoadCommandIndex) +
293                             " inconsistent cmdsize in " + CmdName +
294                             " for the number of sections");
295     for (unsigned J = 0; J < S.nsects; ++J) {
296       const char *Sec = getSectionPtr(Obj, Load, J);
297       Sections.push_back(Sec);
298       auto SectionOrErr = getStructOrErr<Section>(Obj, Sec);
299       if (!SectionOrErr)
300         return SectionOrErr.takeError();
301       Section s = SectionOrErr.get();
302       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
303           Obj.getHeader().filetype != MachO::MH_DSYM &&
304           s.flags != MachO::S_ZEROFILL &&
305           s.flags != MachO::S_THREAD_LOCAL_ZEROFILL &&
306           s.offset > FileSize)
307         return malformedError("offset field of section " + Twine(J) + " in " +
308                               CmdName + " command " + Twine(LoadCommandIndex) +
309                               " extends past the end of the file");
310       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
311           Obj.getHeader().filetype != MachO::MH_DSYM &&
312           s.flags != MachO::S_ZEROFILL &&
313           s.flags != MachO::S_THREAD_LOCAL_ZEROFILL && S.fileoff == 0 &&
314           s.offset < SizeOfHeaders && s.size != 0)
315         return malformedError("offset field of section " + Twine(J) + " in " +
316                               CmdName + " command " + Twine(LoadCommandIndex) +
317                               " not past the headers of the file");
318       uint64_t BigSize = s.offset;
319       BigSize += s.size;
320       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
321           Obj.getHeader().filetype != MachO::MH_DSYM &&
322           s.flags != MachO::S_ZEROFILL &&
323           s.flags != MachO::S_THREAD_LOCAL_ZEROFILL &&
324           BigSize > FileSize)
325         return malformedError("offset field plus size field of section " +
326                               Twine(J) + " in " + CmdName + " command " +
327                               Twine(LoadCommandIndex) +
328                               " extends past the end of the file");
329       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
330           Obj.getHeader().filetype != MachO::MH_DSYM &&
331           s.flags != MachO::S_ZEROFILL &&
332           s.flags != MachO::S_THREAD_LOCAL_ZEROFILL &&
333           s.size > S.filesize)
334         return malformedError("size field of section " +
335                               Twine(J) + " in " + CmdName + " command " +
336                               Twine(LoadCommandIndex) +
337                               " greater than the segment");
338       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
339           Obj.getHeader().filetype != MachO::MH_DSYM && s.size != 0 &&
340           s.addr < S.vmaddr)
341         return malformedError("addr field of section " + Twine(J) + " in " +
342                               CmdName + " command " + Twine(LoadCommandIndex) +
343                               " less than the segment's vmaddr");
344       BigSize = s.addr;
345       BigSize += s.size;
346       uint64_t BigEnd = S.vmaddr;
347       BigEnd += S.vmsize;
348       if (S.vmsize != 0 && s.size != 0 && BigSize > BigEnd)
349         return malformedError("addr field plus size of section " + Twine(J) +
350                               " in " + CmdName + " command " +
351                               Twine(LoadCommandIndex) +
352                               " greater than than "
353                               "the segment's vmaddr plus vmsize");
354       if (Obj.getHeader().filetype != MachO::MH_DYLIB_STUB &&
355           Obj.getHeader().filetype != MachO::MH_DSYM &&
356           s.flags != MachO::S_ZEROFILL &&
357           s.flags != MachO::S_THREAD_LOCAL_ZEROFILL)
358         if (Error Err = checkOverlappingElement(Elements, s.offset, s.size,
359                                                 "section contents"))
360           return Err;
361       if (s.reloff > FileSize)
362         return malformedError("reloff field of section " + Twine(J) + " in " +
363                               CmdName + " command " + Twine(LoadCommandIndex) +
364                               " extends past the end of the file");
365       BigSize = s.nreloc;
366       BigSize *= sizeof(struct MachO::relocation_info);
367       BigSize += s.reloff;
368       if (BigSize > FileSize)
369         return malformedError("reloff field plus nreloc field times sizeof("
370                               "struct relocation_info) of section " +
371                               Twine(J) + " in " + CmdName + " command " +
372                               Twine(LoadCommandIndex) +
373                               " extends past the end of the file");
374       if (Error Err = checkOverlappingElement(Elements, s.reloff, s.nreloc *
375                                               sizeof(struct
376                                               MachO::relocation_info),
377                                               "section relocation entries"))
378         return Err;
379     }
380     if (S.fileoff > FileSize)
381       return malformedError("load command " + Twine(LoadCommandIndex) +
382                             " fileoff field in " + CmdName +
383                             " extends past the end of the file");
384     uint64_t BigSize = S.fileoff;
385     BigSize += S.filesize;
386     if (BigSize > FileSize)
387       return malformedError("load command " + Twine(LoadCommandIndex) +
388                             " fileoff field plus filesize field in " +
389                             CmdName + " extends past the end of the file");
390     if (S.vmsize != 0 && S.filesize > S.vmsize)
391       return malformedError("load command " + Twine(LoadCommandIndex) +
392                             " filesize field in " + CmdName +
393                             " greater than vmsize field");
394     IsPageZeroSegment |= StringRef("__PAGEZERO").equals(S.segname);
395   } else
396     return SegOrErr.takeError();
397 
398   return Error::success();
399 }
400 
401 static Error checkSymtabCommand(const MachOObjectFile &Obj,
402                                 const MachOObjectFile::LoadCommandInfo &Load,
403                                 uint32_t LoadCommandIndex,
404                                 const char **SymtabLoadCmd,
405                                 std::list<MachOElement> &Elements) {
406   if (Load.C.cmdsize < sizeof(MachO::symtab_command))
407     return malformedError("load command " + Twine(LoadCommandIndex) +
408                           " LC_SYMTAB cmdsize too small");
409   if (*SymtabLoadCmd != nullptr)
410     return malformedError("more than one LC_SYMTAB command");
411   auto SymtabOrErr = getStructOrErr<MachO::symtab_command>(Obj, Load.Ptr);
412   if (!SymtabOrErr)
413     return SymtabOrErr.takeError();
414   MachO::symtab_command Symtab = SymtabOrErr.get();
415   if (Symtab.cmdsize != sizeof(MachO::symtab_command))
416     return malformedError("LC_SYMTAB command " + Twine(LoadCommandIndex) +
417                           " has incorrect cmdsize");
418   uint64_t FileSize = Obj.getData().size();
419   if (Symtab.symoff > FileSize)
420     return malformedError("symoff field of LC_SYMTAB command " +
421                           Twine(LoadCommandIndex) + " extends past the end "
422                           "of the file");
423   uint64_t SymtabSize = Symtab.nsyms;
424   const char *struct_nlist_name;
425   if (Obj.is64Bit()) {
426     SymtabSize *= sizeof(MachO::nlist_64);
427     struct_nlist_name = "struct nlist_64";
428   } else {
429     SymtabSize *= sizeof(MachO::nlist);
430     struct_nlist_name = "struct nlist";
431   }
432   uint64_t BigSize = SymtabSize;
433   BigSize += Symtab.symoff;
434   if (BigSize > FileSize)
435     return malformedError("symoff field plus nsyms field times sizeof(" +
436                           Twine(struct_nlist_name) + ") of LC_SYMTAB command " +
437                           Twine(LoadCommandIndex) + " extends past the end "
438                           "of the file");
439   if (Error Err = checkOverlappingElement(Elements, Symtab.symoff, SymtabSize,
440                                           "symbol table"))
441     return Err;
442   if (Symtab.stroff > FileSize)
443     return malformedError("stroff field of LC_SYMTAB command " +
444                           Twine(LoadCommandIndex) + " extends past the end "
445                           "of the file");
446   BigSize = Symtab.stroff;
447   BigSize += Symtab.strsize;
448   if (BigSize > FileSize)
449     return malformedError("stroff field plus strsize field of LC_SYMTAB "
450                           "command " + Twine(LoadCommandIndex) + " extends "
451                           "past the end of the file");
452   if (Error Err = checkOverlappingElement(Elements, Symtab.stroff,
453                                           Symtab.strsize, "string table"))
454     return Err;
455   *SymtabLoadCmd = Load.Ptr;
456   return Error::success();
457 }
458 
459 static Error checkDysymtabCommand(const MachOObjectFile &Obj,
460                                   const MachOObjectFile::LoadCommandInfo &Load,
461                                   uint32_t LoadCommandIndex,
462                                   const char **DysymtabLoadCmd,
463                                   std::list<MachOElement> &Elements) {
464   if (Load.C.cmdsize < sizeof(MachO::dysymtab_command))
465     return malformedError("load command " + Twine(LoadCommandIndex) +
466                           " LC_DYSYMTAB cmdsize too small");
467   if (*DysymtabLoadCmd != nullptr)
468     return malformedError("more than one LC_DYSYMTAB command");
469   auto DysymtabOrErr =
470     getStructOrErr<MachO::dysymtab_command>(Obj, Load.Ptr);
471   if (!DysymtabOrErr)
472     return DysymtabOrErr.takeError();
473   MachO::dysymtab_command Dysymtab = DysymtabOrErr.get();
474   if (Dysymtab.cmdsize != sizeof(MachO::dysymtab_command))
475     return malformedError("LC_DYSYMTAB command " + Twine(LoadCommandIndex) +
476                           " has incorrect cmdsize");
477   uint64_t FileSize = Obj.getData().size();
478   if (Dysymtab.tocoff > FileSize)
479     return malformedError("tocoff field of LC_DYSYMTAB command " +
480                           Twine(LoadCommandIndex) + " extends past the end of "
481                           "the file");
482   uint64_t BigSize = Dysymtab.ntoc;
483   BigSize *= sizeof(MachO::dylib_table_of_contents);
484   BigSize += Dysymtab.tocoff;
485   if (BigSize > FileSize)
486     return malformedError("tocoff field plus ntoc field times sizeof(struct "
487                           "dylib_table_of_contents) of LC_DYSYMTAB command " +
488                           Twine(LoadCommandIndex) + " extends past the end of "
489                           "the file");
490   if (Error Err = checkOverlappingElement(Elements, Dysymtab.tocoff,
491                                           Dysymtab.ntoc * sizeof(struct
492                                           MachO::dylib_table_of_contents),
493                                           "table of contents"))
494     return Err;
495   if (Dysymtab.modtaboff > FileSize)
496     return malformedError("modtaboff field of LC_DYSYMTAB command " +
497                           Twine(LoadCommandIndex) + " extends past the end of "
498                           "the file");
499   BigSize = Dysymtab.nmodtab;
500   const char *struct_dylib_module_name;
501   uint64_t sizeof_modtab;
502   if (Obj.is64Bit()) {
503     sizeof_modtab = sizeof(MachO::dylib_module_64);
504     struct_dylib_module_name = "struct dylib_module_64";
505   } else {
506     sizeof_modtab = sizeof(MachO::dylib_module);
507     struct_dylib_module_name = "struct dylib_module";
508   }
509   BigSize *= sizeof_modtab;
510   BigSize += Dysymtab.modtaboff;
511   if (BigSize > FileSize)
512     return malformedError("modtaboff field plus nmodtab field times sizeof(" +
513                           Twine(struct_dylib_module_name) + ") of LC_DYSYMTAB "
514                           "command " + Twine(LoadCommandIndex) + " extends "
515                           "past the end of the file");
516   if (Error Err = checkOverlappingElement(Elements, Dysymtab.modtaboff,
517                                           Dysymtab.nmodtab * sizeof_modtab,
518                                           "module table"))
519     return Err;
520   if (Dysymtab.extrefsymoff > FileSize)
521     return malformedError("extrefsymoff field of LC_DYSYMTAB command " +
522                           Twine(LoadCommandIndex) + " extends past the end of "
523                           "the file");
524   BigSize = Dysymtab.nextrefsyms;
525   BigSize *= sizeof(MachO::dylib_reference);
526   BigSize += Dysymtab.extrefsymoff;
527   if (BigSize > FileSize)
528     return malformedError("extrefsymoff field plus nextrefsyms field times "
529                           "sizeof(struct dylib_reference) of LC_DYSYMTAB "
530                           "command " + Twine(LoadCommandIndex) + " extends "
531                           "past the end of the file");
532   if (Error Err = checkOverlappingElement(Elements, Dysymtab.extrefsymoff,
533                                           Dysymtab.nextrefsyms *
534                                               sizeof(MachO::dylib_reference),
535                                           "reference table"))
536     return Err;
537   if (Dysymtab.indirectsymoff > FileSize)
538     return malformedError("indirectsymoff field of LC_DYSYMTAB command " +
539                           Twine(LoadCommandIndex) + " extends past the end of "
540                           "the file");
541   BigSize = Dysymtab.nindirectsyms;
542   BigSize *= sizeof(uint32_t);
543   BigSize += Dysymtab.indirectsymoff;
544   if (BigSize > FileSize)
545     return malformedError("indirectsymoff field plus nindirectsyms field times "
546                           "sizeof(uint32_t) of LC_DYSYMTAB command " +
547                           Twine(LoadCommandIndex) + " extends past the end of "
548                           "the file");
549   if (Error Err = checkOverlappingElement(Elements, Dysymtab.indirectsymoff,
550                                           Dysymtab.nindirectsyms *
551                                           sizeof(uint32_t),
552                                           "indirect table"))
553     return Err;
554   if (Dysymtab.extreloff > FileSize)
555     return malformedError("extreloff field of LC_DYSYMTAB command " +
556                           Twine(LoadCommandIndex) + " extends past the end of "
557                           "the file");
558   BigSize = Dysymtab.nextrel;
559   BigSize *= sizeof(MachO::relocation_info);
560   BigSize += Dysymtab.extreloff;
561   if (BigSize > FileSize)
562     return malformedError("extreloff field plus nextrel field times sizeof"
563                           "(struct relocation_info) of LC_DYSYMTAB command " +
564                           Twine(LoadCommandIndex) + " extends past the end of "
565                           "the file");
566   if (Error Err = checkOverlappingElement(Elements, Dysymtab.extreloff,
567                                           Dysymtab.nextrel *
568                                               sizeof(MachO::relocation_info),
569                                           "external relocation table"))
570     return Err;
571   if (Dysymtab.locreloff > FileSize)
572     return malformedError("locreloff field of LC_DYSYMTAB command " +
573                           Twine(LoadCommandIndex) + " extends past the end of "
574                           "the file");
575   BigSize = Dysymtab.nlocrel;
576   BigSize *= sizeof(MachO::relocation_info);
577   BigSize += Dysymtab.locreloff;
578   if (BigSize > FileSize)
579     return malformedError("locreloff field plus nlocrel field times sizeof"
580                           "(struct relocation_info) of LC_DYSYMTAB command " +
581                           Twine(LoadCommandIndex) + " extends past the end of "
582                           "the file");
583   if (Error Err = checkOverlappingElement(Elements, Dysymtab.locreloff,
584                                           Dysymtab.nlocrel *
585                                               sizeof(MachO::relocation_info),
586                                           "local relocation table"))
587     return Err;
588   *DysymtabLoadCmd = Load.Ptr;
589   return Error::success();
590 }
591 
592 static Error checkLinkeditDataCommand(const MachOObjectFile &Obj,
593                                  const MachOObjectFile::LoadCommandInfo &Load,
594                                  uint32_t LoadCommandIndex,
595                                  const char **LoadCmd, const char *CmdName,
596                                  std::list<MachOElement> &Elements,
597                                  const char *ElementName) {
598   if (Load.C.cmdsize < sizeof(MachO::linkedit_data_command))
599     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
600                           CmdName + " cmdsize too small");
601   if (*LoadCmd != nullptr)
602     return malformedError("more than one " + Twine(CmdName) + " command");
603   auto LinkDataOrError =
604     getStructOrErr<MachO::linkedit_data_command>(Obj, Load.Ptr);
605   if (!LinkDataOrError)
606     return LinkDataOrError.takeError();
607   MachO::linkedit_data_command LinkData = LinkDataOrError.get();
608   if (LinkData.cmdsize != sizeof(MachO::linkedit_data_command))
609     return malformedError(Twine(CmdName) + " command " +
610                           Twine(LoadCommandIndex) + " has incorrect cmdsize");
611   uint64_t FileSize = Obj.getData().size();
612   if (LinkData.dataoff > FileSize)
613     return malformedError("dataoff field of " + Twine(CmdName) + " command " +
614                           Twine(LoadCommandIndex) + " extends past the end of "
615                           "the file");
616   uint64_t BigSize = LinkData.dataoff;
617   BigSize += LinkData.datasize;
618   if (BigSize > FileSize)
619     return malformedError("dataoff field plus datasize field of " +
620                           Twine(CmdName) + " command " +
621                           Twine(LoadCommandIndex) + " extends past the end of "
622                           "the file");
623   if (Error Err = checkOverlappingElement(Elements, LinkData.dataoff,
624                                           LinkData.datasize, ElementName))
625     return Err;
626   *LoadCmd = Load.Ptr;
627   return Error::success();
628 }
629 
630 static Error checkDyldInfoCommand(const MachOObjectFile &Obj,
631                                   const MachOObjectFile::LoadCommandInfo &Load,
632                                   uint32_t LoadCommandIndex,
633                                   const char **LoadCmd, const char *CmdName,
634                                   std::list<MachOElement> &Elements) {
635   if (Load.C.cmdsize < sizeof(MachO::dyld_info_command))
636     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
637                           CmdName + " cmdsize too small");
638   if (*LoadCmd != nullptr)
639     return malformedError("more than one LC_DYLD_INFO and or LC_DYLD_INFO_ONLY "
640                           "command");
641   auto DyldInfoOrErr =
642     getStructOrErr<MachO::dyld_info_command>(Obj, Load.Ptr);
643   if (!DyldInfoOrErr)
644     return DyldInfoOrErr.takeError();
645   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
646   if (DyldInfo.cmdsize != sizeof(MachO::dyld_info_command))
647     return malformedError(Twine(CmdName) + " command " +
648                           Twine(LoadCommandIndex) + " has incorrect cmdsize");
649   uint64_t FileSize = Obj.getData().size();
650   if (DyldInfo.rebase_off > FileSize)
651     return malformedError("rebase_off field of " + Twine(CmdName) +
652                           " command " + Twine(LoadCommandIndex) + " extends "
653                           "past the end of the file");
654   uint64_t BigSize = DyldInfo.rebase_off;
655   BigSize += DyldInfo.rebase_size;
656   if (BigSize > FileSize)
657     return malformedError("rebase_off field plus rebase_size field of " +
658                           Twine(CmdName) + " command " +
659                           Twine(LoadCommandIndex) + " extends past the end of "
660                           "the file");
661   if (Error Err = checkOverlappingElement(Elements, DyldInfo.rebase_off,
662                                           DyldInfo.rebase_size,
663                                           "dyld rebase info"))
664     return Err;
665   if (DyldInfo.bind_off > FileSize)
666     return malformedError("bind_off field of " + Twine(CmdName) +
667                           " command " + Twine(LoadCommandIndex) + " extends "
668                           "past the end of the file");
669   BigSize = DyldInfo.bind_off;
670   BigSize += DyldInfo.bind_size;
671   if (BigSize > FileSize)
672     return malformedError("bind_off field plus bind_size field of " +
673                           Twine(CmdName) + " command " +
674                           Twine(LoadCommandIndex) + " extends past the end of "
675                           "the file");
676   if (Error Err = checkOverlappingElement(Elements, DyldInfo.bind_off,
677                                           DyldInfo.bind_size,
678                                           "dyld bind info"))
679     return Err;
680   if (DyldInfo.weak_bind_off > FileSize)
681     return malformedError("weak_bind_off field of " + Twine(CmdName) +
682                           " command " + Twine(LoadCommandIndex) + " extends "
683                           "past the end of the file");
684   BigSize = DyldInfo.weak_bind_off;
685   BigSize += DyldInfo.weak_bind_size;
686   if (BigSize > FileSize)
687     return malformedError("weak_bind_off field plus weak_bind_size field of " +
688                           Twine(CmdName) + " command " +
689                           Twine(LoadCommandIndex) + " extends past the end of "
690                           "the file");
691   if (Error Err = checkOverlappingElement(Elements, DyldInfo.weak_bind_off,
692                                           DyldInfo.weak_bind_size,
693                                           "dyld weak bind info"))
694     return Err;
695   if (DyldInfo.lazy_bind_off > FileSize)
696     return malformedError("lazy_bind_off field of " + Twine(CmdName) +
697                           " command " + Twine(LoadCommandIndex) + " extends "
698                           "past the end of the file");
699   BigSize = DyldInfo.lazy_bind_off;
700   BigSize += DyldInfo.lazy_bind_size;
701   if (BigSize > FileSize)
702     return malformedError("lazy_bind_off field plus lazy_bind_size field of " +
703                           Twine(CmdName) + " command " +
704                           Twine(LoadCommandIndex) + " extends past the end of "
705                           "the file");
706   if (Error Err = checkOverlappingElement(Elements, DyldInfo.lazy_bind_off,
707                                           DyldInfo.lazy_bind_size,
708                                           "dyld lazy bind info"))
709     return Err;
710   if (DyldInfo.export_off > FileSize)
711     return malformedError("export_off field of " + Twine(CmdName) +
712                           " command " + Twine(LoadCommandIndex) + " extends "
713                           "past the end of the file");
714   BigSize = DyldInfo.export_off;
715   BigSize += DyldInfo.export_size;
716   if (BigSize > FileSize)
717     return malformedError("export_off field plus export_size field of " +
718                           Twine(CmdName) + " command " +
719                           Twine(LoadCommandIndex) + " extends past the end of "
720                           "the file");
721   if (Error Err = checkOverlappingElement(Elements, DyldInfo.export_off,
722                                           DyldInfo.export_size,
723                                           "dyld export info"))
724     return Err;
725   *LoadCmd = Load.Ptr;
726   return Error::success();
727 }
728 
729 static Error checkDylibCommand(const MachOObjectFile &Obj,
730                                const MachOObjectFile::LoadCommandInfo &Load,
731                                uint32_t LoadCommandIndex, const char *CmdName) {
732   if (Load.C.cmdsize < sizeof(MachO::dylib_command))
733     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
734                           CmdName + " cmdsize too small");
735   auto CommandOrErr = getStructOrErr<MachO::dylib_command>(Obj, Load.Ptr);
736   if (!CommandOrErr)
737     return CommandOrErr.takeError();
738   MachO::dylib_command D = CommandOrErr.get();
739   if (D.dylib.name < sizeof(MachO::dylib_command))
740     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
741                           CmdName + " name.offset field too small, not past "
742                           "the end of the dylib_command struct");
743   if (D.dylib.name >= D.cmdsize)
744     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
745                           CmdName + " name.offset field extends past the end "
746                           "of the load command");
747   // Make sure there is a null between the starting offset of the name and
748   // the end of the load command.
749   uint32_t i;
750   const char *P = (const char *)Load.Ptr;
751   for (i = D.dylib.name; i < D.cmdsize; i++)
752     if (P[i] == '\0')
753       break;
754   if (i >= D.cmdsize)
755     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
756                           CmdName + " library name extends past the end of the "
757                           "load command");
758   return Error::success();
759 }
760 
761 static Error checkDylibIdCommand(const MachOObjectFile &Obj,
762                                  const MachOObjectFile::LoadCommandInfo &Load,
763                                  uint32_t LoadCommandIndex,
764                                  const char **LoadCmd) {
765   if (Error Err = checkDylibCommand(Obj, Load, LoadCommandIndex,
766                                      "LC_ID_DYLIB"))
767     return Err;
768   if (*LoadCmd != nullptr)
769     return malformedError("more than one LC_ID_DYLIB command");
770   if (Obj.getHeader().filetype != MachO::MH_DYLIB &&
771       Obj.getHeader().filetype != MachO::MH_DYLIB_STUB)
772     return malformedError("LC_ID_DYLIB load command in non-dynamic library "
773                           "file type");
774   *LoadCmd = Load.Ptr;
775   return Error::success();
776 }
777 
778 static Error checkDyldCommand(const MachOObjectFile &Obj,
779                               const MachOObjectFile::LoadCommandInfo &Load,
780                               uint32_t LoadCommandIndex, const char *CmdName) {
781   if (Load.C.cmdsize < sizeof(MachO::dylinker_command))
782     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
783                           CmdName + " cmdsize too small");
784   auto CommandOrErr = getStructOrErr<MachO::dylinker_command>(Obj, Load.Ptr);
785   if (!CommandOrErr)
786     return CommandOrErr.takeError();
787   MachO::dylinker_command D = CommandOrErr.get();
788   if (D.name < sizeof(MachO::dylinker_command))
789     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
790                           CmdName + " name.offset field too small, not past "
791                           "the end of the dylinker_command struct");
792   if (D.name >= D.cmdsize)
793     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
794                           CmdName + " name.offset field extends past the end "
795                           "of the load command");
796   // Make sure there is a null between the starting offset of the name and
797   // the end of the load command.
798   uint32_t i;
799   const char *P = (const char *)Load.Ptr;
800   for (i = D.name; i < D.cmdsize; i++)
801     if (P[i] == '\0')
802       break;
803   if (i >= D.cmdsize)
804     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
805                           CmdName + " dyld name extends past the end of the "
806                           "load command");
807   return Error::success();
808 }
809 
810 static Error checkVersCommand(const MachOObjectFile &Obj,
811                               const MachOObjectFile::LoadCommandInfo &Load,
812                               uint32_t LoadCommandIndex,
813                               const char **LoadCmd, const char *CmdName) {
814   if (Load.C.cmdsize != sizeof(MachO::version_min_command))
815     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
816                           CmdName + " has incorrect cmdsize");
817   if (*LoadCmd != nullptr)
818     return malformedError("more than one LC_VERSION_MIN_MACOSX, "
819                           "LC_VERSION_MIN_IPHONEOS, LC_VERSION_MIN_TVOS or "
820                           "LC_VERSION_MIN_WATCHOS command");
821   *LoadCmd = Load.Ptr;
822   return Error::success();
823 }
824 
825 static Error checkNoteCommand(const MachOObjectFile &Obj,
826                               const MachOObjectFile::LoadCommandInfo &Load,
827                               uint32_t LoadCommandIndex,
828                               std::list<MachOElement> &Elements) {
829   if (Load.C.cmdsize != sizeof(MachO::note_command))
830     return malformedError("load command " + Twine(LoadCommandIndex) +
831                           " LC_NOTE has incorrect cmdsize");
832   auto NoteCmdOrErr = getStructOrErr<MachO::note_command>(Obj, Load.Ptr);
833   if (!NoteCmdOrErr)
834     return NoteCmdOrErr.takeError();
835   MachO::note_command Nt = NoteCmdOrErr.get();
836   uint64_t FileSize = Obj.getData().size();
837   if (Nt.offset > FileSize)
838     return malformedError("offset field of LC_NOTE command " +
839                           Twine(LoadCommandIndex) + " extends "
840                           "past the end of the file");
841   uint64_t BigSize = Nt.offset;
842   BigSize += Nt.size;
843   if (BigSize > FileSize)
844     return malformedError("size field plus offset field of LC_NOTE command " +
845                           Twine(LoadCommandIndex) + " extends past the end of "
846                           "the file");
847   if (Error Err = checkOverlappingElement(Elements, Nt.offset, Nt.size,
848                                           "LC_NOTE data"))
849     return Err;
850   return Error::success();
851 }
852 
853 static Error
854 parseBuildVersionCommand(const MachOObjectFile &Obj,
855                          const MachOObjectFile::LoadCommandInfo &Load,
856                          SmallVectorImpl<const char*> &BuildTools,
857                          uint32_t LoadCommandIndex) {
858   auto BVCOrErr =
859     getStructOrErr<MachO::build_version_command>(Obj, Load.Ptr);
860   if (!BVCOrErr)
861     return BVCOrErr.takeError();
862   MachO::build_version_command BVC = BVCOrErr.get();
863   if (Load.C.cmdsize !=
864       sizeof(MachO::build_version_command) +
865           BVC.ntools * sizeof(MachO::build_tool_version))
866     return malformedError("load command " + Twine(LoadCommandIndex) +
867                           " LC_BUILD_VERSION_COMMAND has incorrect cmdsize");
868 
869   auto Start = Load.Ptr + sizeof(MachO::build_version_command);
870   BuildTools.resize(BVC.ntools);
871   for (unsigned i = 0; i < BVC.ntools; ++i)
872     BuildTools[i] = Start + i * sizeof(MachO::build_tool_version);
873 
874   return Error::success();
875 }
876 
877 static Error checkRpathCommand(const MachOObjectFile &Obj,
878                                const MachOObjectFile::LoadCommandInfo &Load,
879                                uint32_t LoadCommandIndex) {
880   if (Load.C.cmdsize < sizeof(MachO::rpath_command))
881     return malformedError("load command " + Twine(LoadCommandIndex) +
882                           " LC_RPATH cmdsize too small");
883   auto ROrErr = getStructOrErr<MachO::rpath_command>(Obj, Load.Ptr);
884   if (!ROrErr)
885     return ROrErr.takeError();
886   MachO::rpath_command R = ROrErr.get();
887   if (R.path < sizeof(MachO::rpath_command))
888     return malformedError("load command " + Twine(LoadCommandIndex) +
889                           " LC_RPATH path.offset field too small, not past "
890                           "the end of the rpath_command struct");
891   if (R.path >= R.cmdsize)
892     return malformedError("load command " + Twine(LoadCommandIndex) +
893                           " LC_RPATH path.offset field extends past the end "
894                           "of the load command");
895   // Make sure there is a null between the starting offset of the path and
896   // the end of the load command.
897   uint32_t i;
898   const char *P = (const char *)Load.Ptr;
899   for (i = R.path; i < R.cmdsize; i++)
900     if (P[i] == '\0')
901       break;
902   if (i >= R.cmdsize)
903     return malformedError("load command " + Twine(LoadCommandIndex) +
904                           " LC_RPATH library name extends past the end of the "
905                           "load command");
906   return Error::success();
907 }
908 
909 static Error checkEncryptCommand(const MachOObjectFile &Obj,
910                                  const MachOObjectFile::LoadCommandInfo &Load,
911                                  uint32_t LoadCommandIndex,
912                                  uint64_t cryptoff, uint64_t cryptsize,
913                                  const char **LoadCmd, const char *CmdName) {
914   if (*LoadCmd != nullptr)
915     return malformedError("more than one LC_ENCRYPTION_INFO and or "
916                           "LC_ENCRYPTION_INFO_64 command");
917   uint64_t FileSize = Obj.getData().size();
918   if (cryptoff > FileSize)
919     return malformedError("cryptoff field of " + Twine(CmdName) +
920                           " command " + Twine(LoadCommandIndex) + " extends "
921                           "past the end of the file");
922   uint64_t BigSize = cryptoff;
923   BigSize += cryptsize;
924   if (BigSize > FileSize)
925     return malformedError("cryptoff field plus cryptsize field of " +
926                           Twine(CmdName) + " command " +
927                           Twine(LoadCommandIndex) + " extends past the end of "
928                           "the file");
929   *LoadCmd = Load.Ptr;
930   return Error::success();
931 }
932 
933 static Error checkLinkerOptCommand(const MachOObjectFile &Obj,
934                                    const MachOObjectFile::LoadCommandInfo &Load,
935                                    uint32_t LoadCommandIndex) {
936   if (Load.C.cmdsize < sizeof(MachO::linker_option_command))
937     return malformedError("load command " + Twine(LoadCommandIndex) +
938                           " LC_LINKER_OPTION cmdsize too small");
939   auto LinkOptionOrErr =
940     getStructOrErr<MachO::linker_option_command>(Obj, Load.Ptr);
941   if (!LinkOptionOrErr)
942     return LinkOptionOrErr.takeError();
943   MachO::linker_option_command L = LinkOptionOrErr.get();
944   // Make sure the count of strings is correct.
945   const char *string = (const char *)Load.Ptr +
946                        sizeof(struct MachO::linker_option_command);
947   uint32_t left = L.cmdsize - sizeof(struct MachO::linker_option_command);
948   uint32_t i = 0;
949   while (left > 0) {
950     while (*string == '\0' && left > 0) {
951       string++;
952       left--;
953     }
954     if (left > 0) {
955       i++;
956       uint32_t NullPos = StringRef(string, left).find('\0');
957       if (0xffffffff == NullPos)
958         return malformedError("load command " + Twine(LoadCommandIndex) +
959                               " LC_LINKER_OPTION string #" + Twine(i) +
960                               " is not NULL terminated");
961       uint32_t len = std::min(NullPos, left) + 1;
962       string += len;
963       left -= len;
964     }
965   }
966   if (L.count != i)
967     return malformedError("load command " + Twine(LoadCommandIndex) +
968                           " LC_LINKER_OPTION string count " + Twine(L.count) +
969                           " does not match number of strings");
970   return Error::success();
971 }
972 
973 static Error checkSubCommand(const MachOObjectFile &Obj,
974                              const MachOObjectFile::LoadCommandInfo &Load,
975                              uint32_t LoadCommandIndex, const char *CmdName,
976                              size_t SizeOfCmd, const char *CmdStructName,
977                              uint32_t PathOffset, const char *PathFieldName) {
978   if (PathOffset < SizeOfCmd)
979     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
980                           CmdName + " " + PathFieldName + ".offset field too "
981                           "small, not past the end of the " + CmdStructName);
982   if (PathOffset >= Load.C.cmdsize)
983     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
984                           CmdName + " " + PathFieldName + ".offset field "
985                           "extends past the end of the load command");
986   // Make sure there is a null between the starting offset of the path and
987   // the end of the load command.
988   uint32_t i;
989   const char *P = (const char *)Load.Ptr;
990   for (i = PathOffset; i < Load.C.cmdsize; i++)
991     if (P[i] == '\0')
992       break;
993   if (i >= Load.C.cmdsize)
994     return malformedError("load command " + Twine(LoadCommandIndex) + " " +
995                           CmdName + " " + PathFieldName + " name extends past "
996                           "the end of the load command");
997   return Error::success();
998 }
999 
1000 static Error checkThreadCommand(const MachOObjectFile &Obj,
1001                                 const MachOObjectFile::LoadCommandInfo &Load,
1002                                 uint32_t LoadCommandIndex,
1003                                 const char *CmdName) {
1004   if (Load.C.cmdsize < sizeof(MachO::thread_command))
1005     return malformedError("load command " + Twine(LoadCommandIndex) +
1006                           CmdName + " cmdsize too small");
1007   auto ThreadCommandOrErr =
1008     getStructOrErr<MachO::thread_command>(Obj, Load.Ptr);
1009   if (!ThreadCommandOrErr)
1010     return ThreadCommandOrErr.takeError();
1011   MachO::thread_command T = ThreadCommandOrErr.get();
1012   const char *state = Load.Ptr + sizeof(MachO::thread_command);
1013   const char *end = Load.Ptr + T.cmdsize;
1014   uint32_t nflavor = 0;
1015   uint32_t cputype = getCPUType(Obj);
1016   while (state < end) {
1017     if(state + sizeof(uint32_t) > end)
1018       return malformedError("load command " + Twine(LoadCommandIndex) +
1019                             "flavor in " + CmdName + " extends past end of "
1020                             "command");
1021     uint32_t flavor;
1022     memcpy(&flavor, state, sizeof(uint32_t));
1023     if (Obj.isLittleEndian() != sys::IsLittleEndianHost)
1024       sys::swapByteOrder(flavor);
1025     state += sizeof(uint32_t);
1026 
1027     if(state + sizeof(uint32_t) > end)
1028       return malformedError("load command " + Twine(LoadCommandIndex) +
1029                             " count in " + CmdName + " extends past end of "
1030                             "command");
1031     uint32_t count;
1032     memcpy(&count, state, sizeof(uint32_t));
1033     if (Obj.isLittleEndian() != sys::IsLittleEndianHost)
1034       sys::swapByteOrder(count);
1035     state += sizeof(uint32_t);
1036 
1037     if (cputype == MachO::CPU_TYPE_I386) {
1038       if (flavor == MachO::x86_THREAD_STATE32) {
1039         if (count != MachO::x86_THREAD_STATE32_COUNT)
1040           return malformedError("load command " + Twine(LoadCommandIndex) +
1041                                 " count not x86_THREAD_STATE32_COUNT for "
1042                                 "flavor number " + Twine(nflavor) + " which is "
1043                                 "a x86_THREAD_STATE32 flavor in " + CmdName +
1044                                 " command");
1045         if (state + sizeof(MachO::x86_thread_state32_t) > end)
1046           return malformedError("load command " + Twine(LoadCommandIndex) +
1047                                 " x86_THREAD_STATE32 extends past end of "
1048                                 "command in " + CmdName + " command");
1049         state += sizeof(MachO::x86_thread_state32_t);
1050       } else {
1051         return malformedError("load command " + Twine(LoadCommandIndex) +
1052                               " unknown flavor (" + Twine(flavor) + ") for "
1053                               "flavor number " + Twine(nflavor) + " in " +
1054                               CmdName + " command");
1055       }
1056     } else if (cputype == MachO::CPU_TYPE_X86_64) {
1057       if (flavor == MachO::x86_THREAD_STATE) {
1058         if (count != MachO::x86_THREAD_STATE_COUNT)
1059           return malformedError("load command " + Twine(LoadCommandIndex) +
1060                                 " count not x86_THREAD_STATE_COUNT for "
1061                                 "flavor number " + Twine(nflavor) + " which is "
1062                                 "a x86_THREAD_STATE flavor in " + CmdName +
1063                                 " command");
1064         if (state + sizeof(MachO::x86_thread_state_t) > end)
1065           return malformedError("load command " + Twine(LoadCommandIndex) +
1066                                 " x86_THREAD_STATE extends past end of "
1067                                 "command in " + CmdName + " command");
1068         state += sizeof(MachO::x86_thread_state_t);
1069       } else if (flavor == MachO::x86_FLOAT_STATE) {
1070         if (count != MachO::x86_FLOAT_STATE_COUNT)
1071           return malformedError("load command " + Twine(LoadCommandIndex) +
1072                                 " count not x86_FLOAT_STATE_COUNT for "
1073                                 "flavor number " + Twine(nflavor) + " which is "
1074                                 "a x86_FLOAT_STATE flavor in " + CmdName +
1075                                 " command");
1076         if (state + sizeof(MachO::x86_float_state_t) > end)
1077           return malformedError("load command " + Twine(LoadCommandIndex) +
1078                                 " x86_FLOAT_STATE extends past end of "
1079                                 "command in " + CmdName + " command");
1080         state += sizeof(MachO::x86_float_state_t);
1081       } else if (flavor == MachO::x86_EXCEPTION_STATE) {
1082         if (count != MachO::x86_EXCEPTION_STATE_COUNT)
1083           return malformedError("load command " + Twine(LoadCommandIndex) +
1084                                 " count not x86_EXCEPTION_STATE_COUNT for "
1085                                 "flavor number " + Twine(nflavor) + " which is "
1086                                 "a x86_EXCEPTION_STATE flavor in " + CmdName +
1087                                 " command");
1088         if (state + sizeof(MachO::x86_exception_state_t) > end)
1089           return malformedError("load command " + Twine(LoadCommandIndex) +
1090                                 " x86_EXCEPTION_STATE extends past end of "
1091                                 "command in " + CmdName + " command");
1092         state += sizeof(MachO::x86_exception_state_t);
1093       } else if (flavor == MachO::x86_THREAD_STATE64) {
1094         if (count != MachO::x86_THREAD_STATE64_COUNT)
1095           return malformedError("load command " + Twine(LoadCommandIndex) +
1096                                 " count not x86_THREAD_STATE64_COUNT for "
1097                                 "flavor number " + Twine(nflavor) + " which is "
1098                                 "a x86_THREAD_STATE64 flavor in " + CmdName +
1099                                 " command");
1100         if (state + sizeof(MachO::x86_thread_state64_t) > end)
1101           return malformedError("load command " + Twine(LoadCommandIndex) +
1102                                 " x86_THREAD_STATE64 extends past end of "
1103                                 "command in " + CmdName + " command");
1104         state += sizeof(MachO::x86_thread_state64_t);
1105       } else if (flavor == MachO::x86_EXCEPTION_STATE64) {
1106         if (count != MachO::x86_EXCEPTION_STATE64_COUNT)
1107           return malformedError("load command " + Twine(LoadCommandIndex) +
1108                                 " count not x86_EXCEPTION_STATE64_COUNT for "
1109                                 "flavor number " + Twine(nflavor) + " which is "
1110                                 "a x86_EXCEPTION_STATE64 flavor in " + CmdName +
1111                                 " command");
1112         if (state + sizeof(MachO::x86_exception_state64_t) > end)
1113           return malformedError("load command " + Twine(LoadCommandIndex) +
1114                                 " x86_EXCEPTION_STATE64 extends past end of "
1115                                 "command in " + CmdName + " command");
1116         state += sizeof(MachO::x86_exception_state64_t);
1117       } else {
1118         return malformedError("load command " + Twine(LoadCommandIndex) +
1119                               " unknown flavor (" + Twine(flavor) + ") for "
1120                               "flavor number " + Twine(nflavor) + " in " +
1121                               CmdName + " command");
1122       }
1123     } else if (cputype == MachO::CPU_TYPE_ARM) {
1124       if (flavor == MachO::ARM_THREAD_STATE) {
1125         if (count != MachO::ARM_THREAD_STATE_COUNT)
1126           return malformedError("load command " + Twine(LoadCommandIndex) +
1127                                 " count not ARM_THREAD_STATE_COUNT for "
1128                                 "flavor number " + Twine(nflavor) + " which is "
1129                                 "a ARM_THREAD_STATE flavor in " + CmdName +
1130                                 " command");
1131         if (state + sizeof(MachO::arm_thread_state32_t) > end)
1132           return malformedError("load command " + Twine(LoadCommandIndex) +
1133                                 " ARM_THREAD_STATE extends past end of "
1134                                 "command in " + CmdName + " command");
1135         state += sizeof(MachO::arm_thread_state32_t);
1136       } else {
1137         return malformedError("load command " + Twine(LoadCommandIndex) +
1138                               " unknown flavor (" + Twine(flavor) + ") for "
1139                               "flavor number " + Twine(nflavor) + " in " +
1140                               CmdName + " command");
1141       }
1142     } else if (cputype == MachO::CPU_TYPE_ARM64 ||
1143                cputype == MachO::CPU_TYPE_ARM64_32) {
1144       if (flavor == MachO::ARM_THREAD_STATE64) {
1145         if (count != MachO::ARM_THREAD_STATE64_COUNT)
1146           return malformedError("load command " + Twine(LoadCommandIndex) +
1147                                 " count not ARM_THREAD_STATE64_COUNT for "
1148                                 "flavor number " + Twine(nflavor) + " which is "
1149                                 "a ARM_THREAD_STATE64 flavor in " + CmdName +
1150                                 " command");
1151         if (state + sizeof(MachO::arm_thread_state64_t) > end)
1152           return malformedError("load command " + Twine(LoadCommandIndex) +
1153                                 " ARM_THREAD_STATE64 extends past end of "
1154                                 "command in " + CmdName + " command");
1155         state += sizeof(MachO::arm_thread_state64_t);
1156       } else {
1157         return malformedError("load command " + Twine(LoadCommandIndex) +
1158                               " unknown flavor (" + Twine(flavor) + ") for "
1159                               "flavor number " + Twine(nflavor) + " in " +
1160                               CmdName + " command");
1161       }
1162     } else if (cputype == MachO::CPU_TYPE_POWERPC) {
1163       if (flavor == MachO::PPC_THREAD_STATE) {
1164         if (count != MachO::PPC_THREAD_STATE_COUNT)
1165           return malformedError("load command " + Twine(LoadCommandIndex) +
1166                                 " count not PPC_THREAD_STATE_COUNT for "
1167                                 "flavor number " + Twine(nflavor) + " which is "
1168                                 "a PPC_THREAD_STATE flavor in " + CmdName +
1169                                 " command");
1170         if (state + sizeof(MachO::ppc_thread_state32_t) > end)
1171           return malformedError("load command " + Twine(LoadCommandIndex) +
1172                                 " PPC_THREAD_STATE extends past end of "
1173                                 "command in " + CmdName + " command");
1174         state += sizeof(MachO::ppc_thread_state32_t);
1175       } else {
1176         return malformedError("load command " + Twine(LoadCommandIndex) +
1177                               " unknown flavor (" + Twine(flavor) + ") for "
1178                               "flavor number " + Twine(nflavor) + " in " +
1179                               CmdName + " command");
1180       }
1181     } else {
1182       return malformedError("unknown cputype (" + Twine(cputype) + ") load "
1183                             "command " + Twine(LoadCommandIndex) + " for " +
1184                             CmdName + " command can't be checked");
1185     }
1186     nflavor++;
1187   }
1188   return Error::success();
1189 }
1190 
1191 static Error checkTwoLevelHintsCommand(const MachOObjectFile &Obj,
1192                                        const MachOObjectFile::LoadCommandInfo
1193                                          &Load,
1194                                        uint32_t LoadCommandIndex,
1195                                        const char **LoadCmd,
1196                                        std::list<MachOElement> &Elements) {
1197   if (Load.C.cmdsize != sizeof(MachO::twolevel_hints_command))
1198     return malformedError("load command " + Twine(LoadCommandIndex) +
1199                           " LC_TWOLEVEL_HINTS has incorrect cmdsize");
1200   if (*LoadCmd != nullptr)
1201     return malformedError("more than one LC_TWOLEVEL_HINTS command");
1202   auto HintsOrErr = getStructOrErr<MachO::twolevel_hints_command>(Obj, Load.Ptr);
1203   if(!HintsOrErr)
1204     return HintsOrErr.takeError();
1205   MachO::twolevel_hints_command Hints = HintsOrErr.get();
1206   uint64_t FileSize = Obj.getData().size();
1207   if (Hints.offset > FileSize)
1208     return malformedError("offset field of LC_TWOLEVEL_HINTS command " +
1209                           Twine(LoadCommandIndex) + " extends past the end of "
1210                           "the file");
1211   uint64_t BigSize = Hints.nhints;
1212   BigSize *= sizeof(MachO::twolevel_hint);
1213   BigSize += Hints.offset;
1214   if (BigSize > FileSize)
1215     return malformedError("offset field plus nhints times sizeof(struct "
1216                           "twolevel_hint) field of LC_TWOLEVEL_HINTS command " +
1217                           Twine(LoadCommandIndex) + " extends past the end of "
1218                           "the file");
1219   if (Error Err = checkOverlappingElement(Elements, Hints.offset, Hints.nhints *
1220                                           sizeof(MachO::twolevel_hint),
1221                                           "two level hints"))
1222     return Err;
1223   *LoadCmd = Load.Ptr;
1224   return Error::success();
1225 }
1226 
1227 // Returns true if the libObject code does not support the load command and its
1228 // contents.  The cmd value it is treated as an unknown load command but with
1229 // an error message that says the cmd value is obsolete.
1230 static bool isLoadCommandObsolete(uint32_t cmd) {
1231   if (cmd == MachO::LC_SYMSEG ||
1232       cmd == MachO::LC_LOADFVMLIB ||
1233       cmd == MachO::LC_IDFVMLIB ||
1234       cmd == MachO::LC_IDENT ||
1235       cmd == MachO::LC_FVMFILE ||
1236       cmd == MachO::LC_PREPAGE ||
1237       cmd == MachO::LC_PREBOUND_DYLIB ||
1238       cmd == MachO::LC_TWOLEVEL_HINTS ||
1239       cmd == MachO::LC_PREBIND_CKSUM)
1240     return true;
1241   return false;
1242 }
1243 
1244 Expected<std::unique_ptr<MachOObjectFile>>
1245 MachOObjectFile::create(MemoryBufferRef Object, bool IsLittleEndian,
1246                         bool Is64Bits, uint32_t UniversalCputype,
1247                         uint32_t UniversalIndex) {
1248   Error Err = Error::success();
1249   std::unique_ptr<MachOObjectFile> Obj(
1250       new MachOObjectFile(std::move(Object), IsLittleEndian,
1251                           Is64Bits, Err, UniversalCputype,
1252                           UniversalIndex));
1253   if (Err)
1254     return std::move(Err);
1255   return std::move(Obj);
1256 }
1257 
1258 MachOObjectFile::MachOObjectFile(MemoryBufferRef Object, bool IsLittleEndian,
1259                                  bool Is64bits, Error &Err,
1260                                  uint32_t UniversalCputype,
1261                                  uint32_t UniversalIndex)
1262     : ObjectFile(getMachOType(IsLittleEndian, Is64bits), Object) {
1263   ErrorAsOutParameter ErrAsOutParam(&Err);
1264   uint64_t SizeOfHeaders;
1265   uint32_t cputype;
1266   if (is64Bit()) {
1267     parseHeader(*this, Header64, Err);
1268     SizeOfHeaders = sizeof(MachO::mach_header_64);
1269     cputype = Header64.cputype;
1270   } else {
1271     parseHeader(*this, Header, Err);
1272     SizeOfHeaders = sizeof(MachO::mach_header);
1273     cputype = Header.cputype;
1274   }
1275   if (Err)
1276     return;
1277   SizeOfHeaders += getHeader().sizeofcmds;
1278   if (getData().data() + SizeOfHeaders > getData().end()) {
1279     Err = malformedError("load commands extend past the end of the file");
1280     return;
1281   }
1282   if (UniversalCputype != 0 && cputype != UniversalCputype) {
1283     Err = malformedError("universal header architecture: " +
1284                          Twine(UniversalIndex) + "'s cputype does not match "
1285                          "object file's mach header");
1286     return;
1287   }
1288   std::list<MachOElement> Elements;
1289   Elements.push_back({0, SizeOfHeaders, "Mach-O headers"});
1290 
1291   uint32_t LoadCommandCount = getHeader().ncmds;
1292   LoadCommandInfo Load;
1293   if (LoadCommandCount != 0) {
1294     if (auto LoadOrErr = getFirstLoadCommandInfo(*this))
1295       Load = *LoadOrErr;
1296     else {
1297       Err = LoadOrErr.takeError();
1298       return;
1299     }
1300   }
1301 
1302   const char *DyldIdLoadCmd = nullptr;
1303   const char *FuncStartsLoadCmd = nullptr;
1304   const char *SplitInfoLoadCmd = nullptr;
1305   const char *CodeSignDrsLoadCmd = nullptr;
1306   const char *CodeSignLoadCmd = nullptr;
1307   const char *VersLoadCmd = nullptr;
1308   const char *SourceLoadCmd = nullptr;
1309   const char *EntryPointLoadCmd = nullptr;
1310   const char *EncryptLoadCmd = nullptr;
1311   const char *RoutinesLoadCmd = nullptr;
1312   const char *UnixThreadLoadCmd = nullptr;
1313   const char *TwoLevelHintsLoadCmd = nullptr;
1314   for (unsigned I = 0; I < LoadCommandCount; ++I) {
1315     if (is64Bit()) {
1316       if (Load.C.cmdsize % 8 != 0) {
1317         // We have a hack here to allow 64-bit Mach-O core files to have
1318         // LC_THREAD commands that are only a multiple of 4 and not 8 to be
1319         // allowed since the macOS kernel produces them.
1320         if (getHeader().filetype != MachO::MH_CORE ||
1321             Load.C.cmd != MachO::LC_THREAD || Load.C.cmdsize % 4) {
1322           Err = malformedError("load command " + Twine(I) + " cmdsize not a "
1323                                "multiple of 8");
1324           return;
1325         }
1326       }
1327     } else {
1328       if (Load.C.cmdsize % 4 != 0) {
1329         Err = malformedError("load command " + Twine(I) + " cmdsize not a "
1330                              "multiple of 4");
1331         return;
1332       }
1333     }
1334     LoadCommands.push_back(Load);
1335     if (Load.C.cmd == MachO::LC_SYMTAB) {
1336       if ((Err = checkSymtabCommand(*this, Load, I, &SymtabLoadCmd, Elements)))
1337         return;
1338     } else if (Load.C.cmd == MachO::LC_DYSYMTAB) {
1339       if ((Err = checkDysymtabCommand(*this, Load, I, &DysymtabLoadCmd,
1340                                       Elements)))
1341         return;
1342     } else if (Load.C.cmd == MachO::LC_DATA_IN_CODE) {
1343       if ((Err = checkLinkeditDataCommand(*this, Load, I, &DataInCodeLoadCmd,
1344                                           "LC_DATA_IN_CODE", Elements,
1345                                           "data in code info")))
1346         return;
1347     } else if (Load.C.cmd == MachO::LC_LINKER_OPTIMIZATION_HINT) {
1348       if ((Err = checkLinkeditDataCommand(*this, Load, I, &LinkOptHintsLoadCmd,
1349                                           "LC_LINKER_OPTIMIZATION_HINT",
1350                                           Elements, "linker optimization "
1351                                           "hints")))
1352         return;
1353     } else if (Load.C.cmd == MachO::LC_FUNCTION_STARTS) {
1354       if ((Err = checkLinkeditDataCommand(*this, Load, I, &FuncStartsLoadCmd,
1355                                           "LC_FUNCTION_STARTS", Elements,
1356                                           "function starts data")))
1357         return;
1358     } else if (Load.C.cmd == MachO::LC_SEGMENT_SPLIT_INFO) {
1359       if ((Err = checkLinkeditDataCommand(*this, Load, I, &SplitInfoLoadCmd,
1360                                           "LC_SEGMENT_SPLIT_INFO", Elements,
1361                                           "split info data")))
1362         return;
1363     } else if (Load.C.cmd == MachO::LC_DYLIB_CODE_SIGN_DRS) {
1364       if ((Err = checkLinkeditDataCommand(*this, Load, I, &CodeSignDrsLoadCmd,
1365                                           "LC_DYLIB_CODE_SIGN_DRS", Elements,
1366                                           "code signing RDs data")))
1367         return;
1368     } else if (Load.C.cmd == MachO::LC_CODE_SIGNATURE) {
1369       if ((Err = checkLinkeditDataCommand(*this, Load, I, &CodeSignLoadCmd,
1370                                           "LC_CODE_SIGNATURE", Elements,
1371                                           "code signature data")))
1372         return;
1373     } else if (Load.C.cmd == MachO::LC_DYLD_INFO) {
1374       if ((Err = checkDyldInfoCommand(*this, Load, I, &DyldInfoLoadCmd,
1375                                       "LC_DYLD_INFO", Elements)))
1376         return;
1377     } else if (Load.C.cmd == MachO::LC_DYLD_INFO_ONLY) {
1378       if ((Err = checkDyldInfoCommand(*this, Load, I, &DyldInfoLoadCmd,
1379                                       "LC_DYLD_INFO_ONLY", Elements)))
1380         return;
1381     } else if (Load.C.cmd == MachO::LC_UUID) {
1382       if (Load.C.cmdsize != sizeof(MachO::uuid_command)) {
1383         Err = malformedError("LC_UUID command " + Twine(I) + " has incorrect "
1384                              "cmdsize");
1385         return;
1386       }
1387       if (UuidLoadCmd) {
1388         Err = malformedError("more than one LC_UUID command");
1389         return;
1390       }
1391       UuidLoadCmd = Load.Ptr;
1392     } else if (Load.C.cmd == MachO::LC_SEGMENT_64) {
1393       if ((Err = parseSegmentLoadCommand<MachO::segment_command_64,
1394                                          MachO::section_64>(
1395                    *this, Load, Sections, HasPageZeroSegment, I,
1396                    "LC_SEGMENT_64", SizeOfHeaders, Elements)))
1397         return;
1398     } else if (Load.C.cmd == MachO::LC_SEGMENT) {
1399       if ((Err = parseSegmentLoadCommand<MachO::segment_command,
1400                                          MachO::section>(
1401                    *this, Load, Sections, HasPageZeroSegment, I,
1402                    "LC_SEGMENT", SizeOfHeaders, Elements)))
1403         return;
1404     } else if (Load.C.cmd == MachO::LC_ID_DYLIB) {
1405       if ((Err = checkDylibIdCommand(*this, Load, I, &DyldIdLoadCmd)))
1406         return;
1407     } else if (Load.C.cmd == MachO::LC_LOAD_DYLIB) {
1408       if ((Err = checkDylibCommand(*this, Load, I, "LC_LOAD_DYLIB")))
1409         return;
1410       Libraries.push_back(Load.Ptr);
1411     } else if (Load.C.cmd == MachO::LC_LOAD_WEAK_DYLIB) {
1412       if ((Err = checkDylibCommand(*this, Load, I, "LC_LOAD_WEAK_DYLIB")))
1413         return;
1414       Libraries.push_back(Load.Ptr);
1415     } else if (Load.C.cmd == MachO::LC_LAZY_LOAD_DYLIB) {
1416       if ((Err = checkDylibCommand(*this, Load, I, "LC_LAZY_LOAD_DYLIB")))
1417         return;
1418       Libraries.push_back(Load.Ptr);
1419     } else if (Load.C.cmd == MachO::LC_REEXPORT_DYLIB) {
1420       if ((Err = checkDylibCommand(*this, Load, I, "LC_REEXPORT_DYLIB")))
1421         return;
1422       Libraries.push_back(Load.Ptr);
1423     } else if (Load.C.cmd == MachO::LC_LOAD_UPWARD_DYLIB) {
1424       if ((Err = checkDylibCommand(*this, Load, I, "LC_LOAD_UPWARD_DYLIB")))
1425         return;
1426       Libraries.push_back(Load.Ptr);
1427     } else if (Load.C.cmd == MachO::LC_ID_DYLINKER) {
1428       if ((Err = checkDyldCommand(*this, Load, I, "LC_ID_DYLINKER")))
1429         return;
1430     } else if (Load.C.cmd == MachO::LC_LOAD_DYLINKER) {
1431       if ((Err = checkDyldCommand(*this, Load, I, "LC_LOAD_DYLINKER")))
1432         return;
1433     } else if (Load.C.cmd == MachO::LC_DYLD_ENVIRONMENT) {
1434       if ((Err = checkDyldCommand(*this, Load, I, "LC_DYLD_ENVIRONMENT")))
1435         return;
1436     } else if (Load.C.cmd == MachO::LC_VERSION_MIN_MACOSX) {
1437       if ((Err = checkVersCommand(*this, Load, I, &VersLoadCmd,
1438                                   "LC_VERSION_MIN_MACOSX")))
1439         return;
1440     } else if (Load.C.cmd == MachO::LC_VERSION_MIN_IPHONEOS) {
1441       if ((Err = checkVersCommand(*this, Load, I, &VersLoadCmd,
1442                                   "LC_VERSION_MIN_IPHONEOS")))
1443         return;
1444     } else if (Load.C.cmd == MachO::LC_VERSION_MIN_TVOS) {
1445       if ((Err = checkVersCommand(*this, Load, I, &VersLoadCmd,
1446                                   "LC_VERSION_MIN_TVOS")))
1447         return;
1448     } else if (Load.C.cmd == MachO::LC_VERSION_MIN_WATCHOS) {
1449       if ((Err = checkVersCommand(*this, Load, I, &VersLoadCmd,
1450                                   "LC_VERSION_MIN_WATCHOS")))
1451         return;
1452     } else if (Load.C.cmd == MachO::LC_NOTE) {
1453       if ((Err = checkNoteCommand(*this, Load, I, Elements)))
1454         return;
1455     } else if (Load.C.cmd == MachO::LC_BUILD_VERSION) {
1456       if ((Err = parseBuildVersionCommand(*this, Load, BuildTools, I)))
1457         return;
1458     } else if (Load.C.cmd == MachO::LC_RPATH) {
1459       if ((Err = checkRpathCommand(*this, Load, I)))
1460         return;
1461     } else if (Load.C.cmd == MachO::LC_SOURCE_VERSION) {
1462       if (Load.C.cmdsize != sizeof(MachO::source_version_command)) {
1463         Err = malformedError("LC_SOURCE_VERSION command " + Twine(I) +
1464                              " has incorrect cmdsize");
1465         return;
1466       }
1467       if (SourceLoadCmd) {
1468         Err = malformedError("more than one LC_SOURCE_VERSION command");
1469         return;
1470       }
1471       SourceLoadCmd = Load.Ptr;
1472     } else if (Load.C.cmd == MachO::LC_MAIN) {
1473       if (Load.C.cmdsize != sizeof(MachO::entry_point_command)) {
1474         Err = malformedError("LC_MAIN command " + Twine(I) +
1475                              " has incorrect cmdsize");
1476         return;
1477       }
1478       if (EntryPointLoadCmd) {
1479         Err = malformedError("more than one LC_MAIN command");
1480         return;
1481       }
1482       EntryPointLoadCmd = Load.Ptr;
1483     } else if (Load.C.cmd == MachO::LC_ENCRYPTION_INFO) {
1484       if (Load.C.cmdsize != sizeof(MachO::encryption_info_command)) {
1485         Err = malformedError("LC_ENCRYPTION_INFO command " + Twine(I) +
1486                              " has incorrect cmdsize");
1487         return;
1488       }
1489       MachO::encryption_info_command E =
1490         getStruct<MachO::encryption_info_command>(*this, Load.Ptr);
1491       if ((Err = checkEncryptCommand(*this, Load, I, E.cryptoff, E.cryptsize,
1492                                      &EncryptLoadCmd, "LC_ENCRYPTION_INFO")))
1493         return;
1494     } else if (Load.C.cmd == MachO::LC_ENCRYPTION_INFO_64) {
1495       if (Load.C.cmdsize != sizeof(MachO::encryption_info_command_64)) {
1496         Err = malformedError("LC_ENCRYPTION_INFO_64 command " + Twine(I) +
1497                              " has incorrect cmdsize");
1498         return;
1499       }
1500       MachO::encryption_info_command_64 E =
1501         getStruct<MachO::encryption_info_command_64>(*this, Load.Ptr);
1502       if ((Err = checkEncryptCommand(*this, Load, I, E.cryptoff, E.cryptsize,
1503                                      &EncryptLoadCmd, "LC_ENCRYPTION_INFO_64")))
1504         return;
1505     } else if (Load.C.cmd == MachO::LC_LINKER_OPTION) {
1506       if ((Err = checkLinkerOptCommand(*this, Load, I)))
1507         return;
1508     } else if (Load.C.cmd == MachO::LC_SUB_FRAMEWORK) {
1509       if (Load.C.cmdsize < sizeof(MachO::sub_framework_command)) {
1510         Err =  malformedError("load command " + Twine(I) +
1511                               " LC_SUB_FRAMEWORK cmdsize too small");
1512         return;
1513       }
1514       MachO::sub_framework_command S =
1515         getStruct<MachO::sub_framework_command>(*this, Load.Ptr);
1516       if ((Err = checkSubCommand(*this, Load, I, "LC_SUB_FRAMEWORK",
1517                                  sizeof(MachO::sub_framework_command),
1518                                  "sub_framework_command", S.umbrella,
1519                                  "umbrella")))
1520         return;
1521     } else if (Load.C.cmd == MachO::LC_SUB_UMBRELLA) {
1522       if (Load.C.cmdsize < sizeof(MachO::sub_umbrella_command)) {
1523         Err =  malformedError("load command " + Twine(I) +
1524                               " LC_SUB_UMBRELLA cmdsize too small");
1525         return;
1526       }
1527       MachO::sub_umbrella_command S =
1528         getStruct<MachO::sub_umbrella_command>(*this, Load.Ptr);
1529       if ((Err = checkSubCommand(*this, Load, I, "LC_SUB_UMBRELLA",
1530                                  sizeof(MachO::sub_umbrella_command),
1531                                  "sub_umbrella_command", S.sub_umbrella,
1532                                  "sub_umbrella")))
1533         return;
1534     } else if (Load.C.cmd == MachO::LC_SUB_LIBRARY) {
1535       if (Load.C.cmdsize < sizeof(MachO::sub_library_command)) {
1536         Err =  malformedError("load command " + Twine(I) +
1537                               " LC_SUB_LIBRARY cmdsize too small");
1538         return;
1539       }
1540       MachO::sub_library_command S =
1541         getStruct<MachO::sub_library_command>(*this, Load.Ptr);
1542       if ((Err = checkSubCommand(*this, Load, I, "LC_SUB_LIBRARY",
1543                                  sizeof(MachO::sub_library_command),
1544                                  "sub_library_command", S.sub_library,
1545                                  "sub_library")))
1546         return;
1547     } else if (Load.C.cmd == MachO::LC_SUB_CLIENT) {
1548       if (Load.C.cmdsize < sizeof(MachO::sub_client_command)) {
1549         Err =  malformedError("load command " + Twine(I) +
1550                               " LC_SUB_CLIENT cmdsize too small");
1551         return;
1552       }
1553       MachO::sub_client_command S =
1554         getStruct<MachO::sub_client_command>(*this, Load.Ptr);
1555       if ((Err = checkSubCommand(*this, Load, I, "LC_SUB_CLIENT",
1556                                  sizeof(MachO::sub_client_command),
1557                                  "sub_client_command", S.client, "client")))
1558         return;
1559     } else if (Load.C.cmd == MachO::LC_ROUTINES) {
1560       if (Load.C.cmdsize != sizeof(MachO::routines_command)) {
1561         Err = malformedError("LC_ROUTINES command " + Twine(I) +
1562                              " has incorrect cmdsize");
1563         return;
1564       }
1565       if (RoutinesLoadCmd) {
1566         Err = malformedError("more than one LC_ROUTINES and or LC_ROUTINES_64 "
1567                              "command");
1568         return;
1569       }
1570       RoutinesLoadCmd = Load.Ptr;
1571     } else if (Load.C.cmd == MachO::LC_ROUTINES_64) {
1572       if (Load.C.cmdsize != sizeof(MachO::routines_command_64)) {
1573         Err = malformedError("LC_ROUTINES_64 command " + Twine(I) +
1574                              " has incorrect cmdsize");
1575         return;
1576       }
1577       if (RoutinesLoadCmd) {
1578         Err = malformedError("more than one LC_ROUTINES_64 and or LC_ROUTINES "
1579                              "command");
1580         return;
1581       }
1582       RoutinesLoadCmd = Load.Ptr;
1583     } else if (Load.C.cmd == MachO::LC_UNIXTHREAD) {
1584       if ((Err = checkThreadCommand(*this, Load, I, "LC_UNIXTHREAD")))
1585         return;
1586       if (UnixThreadLoadCmd) {
1587         Err = malformedError("more than one LC_UNIXTHREAD command");
1588         return;
1589       }
1590       UnixThreadLoadCmd = Load.Ptr;
1591     } else if (Load.C.cmd == MachO::LC_THREAD) {
1592       if ((Err = checkThreadCommand(*this, Load, I, "LC_THREAD")))
1593         return;
1594     // Note: LC_TWOLEVEL_HINTS is really obsolete and is not supported.
1595     } else if (Load.C.cmd == MachO::LC_TWOLEVEL_HINTS) {
1596        if ((Err = checkTwoLevelHintsCommand(*this, Load, I,
1597                                             &TwoLevelHintsLoadCmd, Elements)))
1598          return;
1599     } else if (isLoadCommandObsolete(Load.C.cmd)) {
1600       Err = malformedError("load command " + Twine(I) + " for cmd value of: " +
1601                            Twine(Load.C.cmd) + " is obsolete and not "
1602                            "supported");
1603       return;
1604     }
1605     // TODO: generate a error for unknown load commands by default.  But still
1606     // need work out an approach to allow or not allow unknown values like this
1607     // as an option for some uses like lldb.
1608     if (I < LoadCommandCount - 1) {
1609       if (auto LoadOrErr = getNextLoadCommandInfo(*this, I, Load))
1610         Load = *LoadOrErr;
1611       else {
1612         Err = LoadOrErr.takeError();
1613         return;
1614       }
1615     }
1616   }
1617   if (!SymtabLoadCmd) {
1618     if (DysymtabLoadCmd) {
1619       Err = malformedError("contains LC_DYSYMTAB load command without a "
1620                            "LC_SYMTAB load command");
1621       return;
1622     }
1623   } else if (DysymtabLoadCmd) {
1624     MachO::symtab_command Symtab =
1625       getStruct<MachO::symtab_command>(*this, SymtabLoadCmd);
1626     MachO::dysymtab_command Dysymtab =
1627       getStruct<MachO::dysymtab_command>(*this, DysymtabLoadCmd);
1628     if (Dysymtab.nlocalsym != 0 && Dysymtab.ilocalsym > Symtab.nsyms) {
1629       Err = malformedError("ilocalsym in LC_DYSYMTAB load command "
1630                            "extends past the end of the symbol table");
1631       return;
1632     }
1633     uint64_t BigSize = Dysymtab.ilocalsym;
1634     BigSize += Dysymtab.nlocalsym;
1635     if (Dysymtab.nlocalsym != 0 && BigSize > Symtab.nsyms) {
1636       Err = malformedError("ilocalsym plus nlocalsym in LC_DYSYMTAB load "
1637                            "command extends past the end of the symbol table");
1638       return;
1639     }
1640     if (Dysymtab.nextdefsym != 0 && Dysymtab.iextdefsym > Symtab.nsyms) {
1641       Err = malformedError("iextdefsym in LC_DYSYMTAB load command "
1642                            "extends past the end of the symbol table");
1643       return;
1644     }
1645     BigSize = Dysymtab.iextdefsym;
1646     BigSize += Dysymtab.nextdefsym;
1647     if (Dysymtab.nextdefsym != 0 && BigSize > Symtab.nsyms) {
1648       Err = malformedError("iextdefsym plus nextdefsym in LC_DYSYMTAB "
1649                            "load command extends past the end of the symbol "
1650                            "table");
1651       return;
1652     }
1653     if (Dysymtab.nundefsym != 0 && Dysymtab.iundefsym > Symtab.nsyms) {
1654       Err = malformedError("iundefsym in LC_DYSYMTAB load command "
1655                            "extends past the end of the symbol table");
1656       return;
1657     }
1658     BigSize = Dysymtab.iundefsym;
1659     BigSize += Dysymtab.nundefsym;
1660     if (Dysymtab.nundefsym != 0 && BigSize > Symtab.nsyms) {
1661       Err = malformedError("iundefsym plus nundefsym in LC_DYSYMTAB load "
1662                            " command extends past the end of the symbol table");
1663       return;
1664     }
1665   }
1666   if ((getHeader().filetype == MachO::MH_DYLIB ||
1667        getHeader().filetype == MachO::MH_DYLIB_STUB) &&
1668        DyldIdLoadCmd == nullptr) {
1669     Err = malformedError("no LC_ID_DYLIB load command in dynamic library "
1670                          "filetype");
1671     return;
1672   }
1673   assert(LoadCommands.size() == LoadCommandCount);
1674 
1675   Err = Error::success();
1676 }
1677 
1678 Error MachOObjectFile::checkSymbolTable() const {
1679   uint32_t Flags = 0;
1680   if (is64Bit()) {
1681     MachO::mach_header_64 H_64 = MachOObjectFile::getHeader64();
1682     Flags = H_64.flags;
1683   } else {
1684     MachO::mach_header H = MachOObjectFile::getHeader();
1685     Flags = H.flags;
1686   }
1687   uint8_t NType = 0;
1688   uint8_t NSect = 0;
1689   uint16_t NDesc = 0;
1690   uint32_t NStrx = 0;
1691   uint64_t NValue = 0;
1692   uint32_t SymbolIndex = 0;
1693   MachO::symtab_command S = getSymtabLoadCommand();
1694   for (const SymbolRef &Symbol : symbols()) {
1695     DataRefImpl SymDRI = Symbol.getRawDataRefImpl();
1696     if (is64Bit()) {
1697       MachO::nlist_64 STE_64 = getSymbol64TableEntry(SymDRI);
1698       NType = STE_64.n_type;
1699       NSect = STE_64.n_sect;
1700       NDesc = STE_64.n_desc;
1701       NStrx = STE_64.n_strx;
1702       NValue = STE_64.n_value;
1703     } else {
1704       MachO::nlist STE = getSymbolTableEntry(SymDRI);
1705       NType = STE.n_type;
1706       NSect = STE.n_sect;
1707       NDesc = STE.n_desc;
1708       NStrx = STE.n_strx;
1709       NValue = STE.n_value;
1710     }
1711     if ((NType & MachO::N_STAB) == 0) {
1712       if ((NType & MachO::N_TYPE) == MachO::N_SECT) {
1713         if (NSect == 0 || NSect > Sections.size())
1714           return malformedError("bad section index: " + Twine((int)NSect) +
1715                                 " for symbol at index " + Twine(SymbolIndex));
1716       }
1717       if ((NType & MachO::N_TYPE) == MachO::N_INDR) {
1718         if (NValue >= S.strsize)
1719           return malformedError("bad n_value: " + Twine((int)NValue) + " past "
1720                                 "the end of string table, for N_INDR symbol at "
1721                                 "index " + Twine(SymbolIndex));
1722       }
1723       if ((Flags & MachO::MH_TWOLEVEL) == MachO::MH_TWOLEVEL &&
1724           (((NType & MachO::N_TYPE) == MachO::N_UNDF && NValue == 0) ||
1725            (NType & MachO::N_TYPE) == MachO::N_PBUD)) {
1726             uint32_t LibraryOrdinal = MachO::GET_LIBRARY_ORDINAL(NDesc);
1727             if (LibraryOrdinal != 0 &&
1728                 LibraryOrdinal != MachO::EXECUTABLE_ORDINAL &&
1729                 LibraryOrdinal != MachO::DYNAMIC_LOOKUP_ORDINAL &&
1730                 LibraryOrdinal - 1 >= Libraries.size() ) {
1731               return malformedError("bad library ordinal: " + Twine(LibraryOrdinal) +
1732                                     " for symbol at index " + Twine(SymbolIndex));
1733             }
1734           }
1735     }
1736     if (NStrx >= S.strsize)
1737       return malformedError("bad string table index: " + Twine((int)NStrx) +
1738                             " past the end of string table, for symbol at "
1739                             "index " + Twine(SymbolIndex));
1740     SymbolIndex++;
1741   }
1742   return Error::success();
1743 }
1744 
1745 void MachOObjectFile::moveSymbolNext(DataRefImpl &Symb) const {
1746   unsigned SymbolTableEntrySize = is64Bit() ?
1747     sizeof(MachO::nlist_64) :
1748     sizeof(MachO::nlist);
1749   Symb.p += SymbolTableEntrySize;
1750 }
1751 
1752 Expected<StringRef> MachOObjectFile::getSymbolName(DataRefImpl Symb) const {
1753   StringRef StringTable = getStringTableData();
1754   MachO::nlist_base Entry = getSymbolTableEntryBase(*this, Symb);
1755   if (Entry.n_strx == 0)
1756     // A n_strx value of 0 indicates that no name is associated with a
1757     // particular symbol table entry.
1758     return StringRef();
1759   const char *Start = &StringTable.data()[Entry.n_strx];
1760   if (Start < getData().begin() || Start >= getData().end()) {
1761     return malformedError("bad string index: " + Twine(Entry.n_strx) +
1762                           " for symbol at index " + Twine(getSymbolIndex(Symb)));
1763   }
1764   return StringRef(Start);
1765 }
1766 
1767 unsigned MachOObjectFile::getSectionType(SectionRef Sec) const {
1768   DataRefImpl DRI = Sec.getRawDataRefImpl();
1769   uint32_t Flags = getSectionFlags(*this, DRI);
1770   return Flags & MachO::SECTION_TYPE;
1771 }
1772 
1773 uint64_t MachOObjectFile::getNValue(DataRefImpl Sym) const {
1774   if (is64Bit()) {
1775     MachO::nlist_64 Entry = getSymbol64TableEntry(Sym);
1776     return Entry.n_value;
1777   }
1778   MachO::nlist Entry = getSymbolTableEntry(Sym);
1779   return Entry.n_value;
1780 }
1781 
1782 // getIndirectName() returns the name of the alias'ed symbol who's string table
1783 // index is in the n_value field.
1784 std::error_code MachOObjectFile::getIndirectName(DataRefImpl Symb,
1785                                                  StringRef &Res) const {
1786   StringRef StringTable = getStringTableData();
1787   MachO::nlist_base Entry = getSymbolTableEntryBase(*this, Symb);
1788   if ((Entry.n_type & MachO::N_TYPE) != MachO::N_INDR)
1789     return object_error::parse_failed;
1790   uint64_t NValue = getNValue(Symb);
1791   if (NValue >= StringTable.size())
1792     return object_error::parse_failed;
1793   const char *Start = &StringTable.data()[NValue];
1794   Res = StringRef(Start);
1795   return std::error_code();
1796 }
1797 
1798 uint64_t MachOObjectFile::getSymbolValueImpl(DataRefImpl Sym) const {
1799   return getNValue(Sym);
1800 }
1801 
1802 Expected<uint64_t> MachOObjectFile::getSymbolAddress(DataRefImpl Sym) const {
1803   return getSymbolValue(Sym);
1804 }
1805 
1806 uint32_t MachOObjectFile::getSymbolAlignment(DataRefImpl DRI) const {
1807   uint32_t Flags = cantFail(getSymbolFlags(DRI));
1808   if (Flags & SymbolRef::SF_Common) {
1809     MachO::nlist_base Entry = getSymbolTableEntryBase(*this, DRI);
1810     return 1 << MachO::GET_COMM_ALIGN(Entry.n_desc);
1811   }
1812   return 0;
1813 }
1814 
1815 uint64_t MachOObjectFile::getCommonSymbolSizeImpl(DataRefImpl DRI) const {
1816   return getNValue(DRI);
1817 }
1818 
1819 Expected<SymbolRef::Type>
1820 MachOObjectFile::getSymbolType(DataRefImpl Symb) const {
1821   MachO::nlist_base Entry = getSymbolTableEntryBase(*this, Symb);
1822   uint8_t n_type = Entry.n_type;
1823 
1824   // If this is a STAB debugging symbol, we can do nothing more.
1825   if (n_type & MachO::N_STAB)
1826     return SymbolRef::ST_Debug;
1827 
1828   switch (n_type & MachO::N_TYPE) {
1829     case MachO::N_UNDF :
1830       return SymbolRef::ST_Unknown;
1831     case MachO::N_SECT :
1832       Expected<section_iterator> SecOrError = getSymbolSection(Symb);
1833       if (!SecOrError)
1834         return SecOrError.takeError();
1835       section_iterator Sec = *SecOrError;
1836       if (Sec->isData() || Sec->isBSS())
1837         return SymbolRef::ST_Data;
1838       return SymbolRef::ST_Function;
1839   }
1840   return SymbolRef::ST_Other;
1841 }
1842 
1843 Expected<uint32_t> MachOObjectFile::getSymbolFlags(DataRefImpl DRI) const {
1844   MachO::nlist_base Entry = getSymbolTableEntryBase(*this, DRI);
1845 
1846   uint8_t MachOType = Entry.n_type;
1847   uint16_t MachOFlags = Entry.n_desc;
1848 
1849   uint32_t Result = SymbolRef::SF_None;
1850 
1851   if ((MachOType & MachO::N_TYPE) == MachO::N_INDR)
1852     Result |= SymbolRef::SF_Indirect;
1853 
1854   if (MachOType & MachO::N_STAB)
1855     Result |= SymbolRef::SF_FormatSpecific;
1856 
1857   if (MachOType & MachO::N_EXT) {
1858     Result |= SymbolRef::SF_Global;
1859     if ((MachOType & MachO::N_TYPE) == MachO::N_UNDF) {
1860       if (getNValue(DRI))
1861         Result |= SymbolRef::SF_Common;
1862       else
1863         Result |= SymbolRef::SF_Undefined;
1864     }
1865 
1866     if (!(MachOType & MachO::N_PEXT))
1867       Result |= SymbolRef::SF_Exported;
1868   }
1869 
1870   if (MachOFlags & (MachO::N_WEAK_REF | MachO::N_WEAK_DEF))
1871     Result |= SymbolRef::SF_Weak;
1872 
1873   if (MachOFlags & (MachO::N_ARM_THUMB_DEF))
1874     Result |= SymbolRef::SF_Thumb;
1875 
1876   if ((MachOType & MachO::N_TYPE) == MachO::N_ABS)
1877     Result |= SymbolRef::SF_Absolute;
1878 
1879   return Result;
1880 }
1881 
1882 Expected<section_iterator>
1883 MachOObjectFile::getSymbolSection(DataRefImpl Symb) const {
1884   MachO::nlist_base Entry = getSymbolTableEntryBase(*this, Symb);
1885   uint8_t index = Entry.n_sect;
1886 
1887   if (index == 0)
1888     return section_end();
1889   DataRefImpl DRI;
1890   DRI.d.a = index - 1;
1891   if (DRI.d.a >= Sections.size()){
1892     return malformedError("bad section index: " + Twine((int)index) +
1893                           " for symbol at index " + Twine(getSymbolIndex(Symb)));
1894   }
1895   return section_iterator(SectionRef(DRI, this));
1896 }
1897 
1898 unsigned MachOObjectFile::getSymbolSectionID(SymbolRef Sym) const {
1899   MachO::nlist_base Entry =
1900       getSymbolTableEntryBase(*this, Sym.getRawDataRefImpl());
1901   return Entry.n_sect - 1;
1902 }
1903 
1904 void MachOObjectFile::moveSectionNext(DataRefImpl &Sec) const {
1905   Sec.d.a++;
1906 }
1907 
1908 Expected<StringRef> MachOObjectFile::getSectionName(DataRefImpl Sec) const {
1909   ArrayRef<char> Raw = getSectionRawName(Sec);
1910   return parseSegmentOrSectionName(Raw.data());
1911 }
1912 
1913 uint64_t MachOObjectFile::getSectionAddress(DataRefImpl Sec) const {
1914   if (is64Bit())
1915     return getSection64(Sec).addr;
1916   return getSection(Sec).addr;
1917 }
1918 
1919 uint64_t MachOObjectFile::getSectionIndex(DataRefImpl Sec) const {
1920   return Sec.d.a;
1921 }
1922 
1923 uint64_t MachOObjectFile::getSectionSize(DataRefImpl Sec) const {
1924   // In the case if a malformed Mach-O file where the section offset is past
1925   // the end of the file or some part of the section size is past the end of
1926   // the file return a size of zero or a size that covers the rest of the file
1927   // but does not extend past the end of the file.
1928   uint32_t SectOffset, SectType;
1929   uint64_t SectSize;
1930 
1931   if (is64Bit()) {
1932     MachO::section_64 Sect = getSection64(Sec);
1933     SectOffset = Sect.offset;
1934     SectSize = Sect.size;
1935     SectType = Sect.flags & MachO::SECTION_TYPE;
1936   } else {
1937     MachO::section Sect = getSection(Sec);
1938     SectOffset = Sect.offset;
1939     SectSize = Sect.size;
1940     SectType = Sect.flags & MachO::SECTION_TYPE;
1941   }
1942   if (SectType == MachO::S_ZEROFILL || SectType == MachO::S_GB_ZEROFILL)
1943     return SectSize;
1944   uint64_t FileSize = getData().size();
1945   if (SectOffset > FileSize)
1946     return 0;
1947   if (FileSize - SectOffset < SectSize)
1948     return FileSize - SectOffset;
1949   return SectSize;
1950 }
1951 
1952 ArrayRef<uint8_t> MachOObjectFile::getSectionContents(uint32_t Offset,
1953                                                       uint64_t Size) const {
1954   return arrayRefFromStringRef(getData().substr(Offset, Size));
1955 }
1956 
1957 Expected<ArrayRef<uint8_t>>
1958 MachOObjectFile::getSectionContents(DataRefImpl Sec) const {
1959   uint32_t Offset;
1960   uint64_t Size;
1961 
1962   if (is64Bit()) {
1963     MachO::section_64 Sect = getSection64(Sec);
1964     Offset = Sect.offset;
1965     Size = Sect.size;
1966   } else {
1967     MachO::section Sect = getSection(Sec);
1968     Offset = Sect.offset;
1969     Size = Sect.size;
1970   }
1971 
1972   return getSectionContents(Offset, Size);
1973 }
1974 
1975 uint64_t MachOObjectFile::getSectionAlignment(DataRefImpl Sec) const {
1976   uint32_t Align;
1977   if (is64Bit()) {
1978     MachO::section_64 Sect = getSection64(Sec);
1979     Align = Sect.align;
1980   } else {
1981     MachO::section Sect = getSection(Sec);
1982     Align = Sect.align;
1983   }
1984 
1985   return uint64_t(1) << Align;
1986 }
1987 
1988 Expected<SectionRef> MachOObjectFile::getSection(unsigned SectionIndex) const {
1989   if (SectionIndex < 1 || SectionIndex > Sections.size())
1990     return malformedError("bad section index: " + Twine((int)SectionIndex));
1991 
1992   DataRefImpl DRI;
1993   DRI.d.a = SectionIndex - 1;
1994   return SectionRef(DRI, this);
1995 }
1996 
1997 Expected<SectionRef> MachOObjectFile::getSection(StringRef SectionName) const {
1998   for (const SectionRef &Section : sections()) {
1999     auto NameOrErr = Section.getName();
2000     if (!NameOrErr)
2001       return NameOrErr.takeError();
2002     if (*NameOrErr == SectionName)
2003       return Section;
2004   }
2005   return errorCodeToError(object_error::parse_failed);
2006 }
2007 
2008 bool MachOObjectFile::isSectionCompressed(DataRefImpl Sec) const {
2009   return false;
2010 }
2011 
2012 bool MachOObjectFile::isSectionText(DataRefImpl Sec) const {
2013   uint32_t Flags = getSectionFlags(*this, Sec);
2014   return Flags & MachO::S_ATTR_PURE_INSTRUCTIONS;
2015 }
2016 
2017 bool MachOObjectFile::isSectionData(DataRefImpl Sec) const {
2018   uint32_t Flags = getSectionFlags(*this, Sec);
2019   unsigned SectionType = Flags & MachO::SECTION_TYPE;
2020   return !(Flags & MachO::S_ATTR_PURE_INSTRUCTIONS) &&
2021          !(SectionType == MachO::S_ZEROFILL ||
2022            SectionType == MachO::S_GB_ZEROFILL);
2023 }
2024 
2025 bool MachOObjectFile::isSectionBSS(DataRefImpl Sec) const {
2026   uint32_t Flags = getSectionFlags(*this, Sec);
2027   unsigned SectionType = Flags & MachO::SECTION_TYPE;
2028   return !(Flags & MachO::S_ATTR_PURE_INSTRUCTIONS) &&
2029          (SectionType == MachO::S_ZEROFILL ||
2030           SectionType == MachO::S_GB_ZEROFILL);
2031 }
2032 
2033 bool MachOObjectFile::isDebugSection(StringRef SectionName) const {
2034   return SectionName.startswith("__debug") ||
2035          SectionName.startswith("__zdebug") ||
2036          SectionName.startswith("__apple") || SectionName == "__gdb_index";
2037 }
2038 
2039 unsigned MachOObjectFile::getSectionID(SectionRef Sec) const {
2040   return Sec.getRawDataRefImpl().d.a;
2041 }
2042 
2043 bool MachOObjectFile::isSectionVirtual(DataRefImpl Sec) const {
2044   uint32_t Flags = getSectionFlags(*this, Sec);
2045   unsigned SectionType = Flags & MachO::SECTION_TYPE;
2046   return SectionType == MachO::S_ZEROFILL ||
2047          SectionType == MachO::S_GB_ZEROFILL;
2048 }
2049 
2050 bool MachOObjectFile::isSectionBitcode(DataRefImpl Sec) const {
2051   StringRef SegmentName = getSectionFinalSegmentName(Sec);
2052   if (Expected<StringRef> NameOrErr = getSectionName(Sec))
2053     return (SegmentName == "__LLVM" && *NameOrErr == "__bitcode");
2054   return false;
2055 }
2056 
2057 bool MachOObjectFile::isSectionStripped(DataRefImpl Sec) const {
2058   if (is64Bit())
2059     return getSection64(Sec).offset == 0;
2060   return getSection(Sec).offset == 0;
2061 }
2062 
2063 relocation_iterator MachOObjectFile::section_rel_begin(DataRefImpl Sec) const {
2064   DataRefImpl Ret;
2065   Ret.d.a = Sec.d.a;
2066   Ret.d.b = 0;
2067   return relocation_iterator(RelocationRef(Ret, this));
2068 }
2069 
2070 relocation_iterator
2071 MachOObjectFile::section_rel_end(DataRefImpl Sec) const {
2072   uint32_t Num;
2073   if (is64Bit()) {
2074     MachO::section_64 Sect = getSection64(Sec);
2075     Num = Sect.nreloc;
2076   } else {
2077     MachO::section Sect = getSection(Sec);
2078     Num = Sect.nreloc;
2079   }
2080 
2081   DataRefImpl Ret;
2082   Ret.d.a = Sec.d.a;
2083   Ret.d.b = Num;
2084   return relocation_iterator(RelocationRef(Ret, this));
2085 }
2086 
2087 relocation_iterator MachOObjectFile::extrel_begin() const {
2088   DataRefImpl Ret;
2089   // for DYSYMTAB symbols, Ret.d.a == 0 for external relocations
2090   Ret.d.a = 0; // Would normally be a section index.
2091   Ret.d.b = 0; // Index into the external relocations
2092   return relocation_iterator(RelocationRef(Ret, this));
2093 }
2094 
2095 relocation_iterator MachOObjectFile::extrel_end() const {
2096   MachO::dysymtab_command DysymtabLoadCmd = getDysymtabLoadCommand();
2097   DataRefImpl Ret;
2098   // for DYSYMTAB symbols, Ret.d.a == 0 for external relocations
2099   Ret.d.a = 0; // Would normally be a section index.
2100   Ret.d.b = DysymtabLoadCmd.nextrel; // Index into the external relocations
2101   return relocation_iterator(RelocationRef(Ret, this));
2102 }
2103 
2104 relocation_iterator MachOObjectFile::locrel_begin() const {
2105   DataRefImpl Ret;
2106   // for DYSYMTAB symbols, Ret.d.a == 1 for local relocations
2107   Ret.d.a = 1; // Would normally be a section index.
2108   Ret.d.b = 0; // Index into the local relocations
2109   return relocation_iterator(RelocationRef(Ret, this));
2110 }
2111 
2112 relocation_iterator MachOObjectFile::locrel_end() const {
2113   MachO::dysymtab_command DysymtabLoadCmd = getDysymtabLoadCommand();
2114   DataRefImpl Ret;
2115   // for DYSYMTAB symbols, Ret.d.a == 1 for local relocations
2116   Ret.d.a = 1; // Would normally be a section index.
2117   Ret.d.b = DysymtabLoadCmd.nlocrel; // Index into the local relocations
2118   return relocation_iterator(RelocationRef(Ret, this));
2119 }
2120 
2121 void MachOObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
2122   ++Rel.d.b;
2123 }
2124 
2125 uint64_t MachOObjectFile::getRelocationOffset(DataRefImpl Rel) const {
2126   assert((getHeader().filetype == MachO::MH_OBJECT ||
2127           getHeader().filetype == MachO::MH_KEXT_BUNDLE) &&
2128          "Only implemented for MH_OBJECT && MH_KEXT_BUNDLE");
2129   MachO::any_relocation_info RE = getRelocation(Rel);
2130   return getAnyRelocationAddress(RE);
2131 }
2132 
2133 symbol_iterator
2134 MachOObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
2135   MachO::any_relocation_info RE = getRelocation(Rel);
2136   if (isRelocationScattered(RE))
2137     return symbol_end();
2138 
2139   uint32_t SymbolIdx = getPlainRelocationSymbolNum(RE);
2140   bool isExtern = getPlainRelocationExternal(RE);
2141   if (!isExtern)
2142     return symbol_end();
2143 
2144   MachO::symtab_command S = getSymtabLoadCommand();
2145   unsigned SymbolTableEntrySize = is64Bit() ?
2146     sizeof(MachO::nlist_64) :
2147     sizeof(MachO::nlist);
2148   uint64_t Offset = S.symoff + SymbolIdx * SymbolTableEntrySize;
2149   DataRefImpl Sym;
2150   Sym.p = reinterpret_cast<uintptr_t>(getPtr(*this, Offset));
2151   return symbol_iterator(SymbolRef(Sym, this));
2152 }
2153 
2154 section_iterator
2155 MachOObjectFile::getRelocationSection(DataRefImpl Rel) const {
2156   return section_iterator(getAnyRelocationSection(getRelocation(Rel)));
2157 }
2158 
2159 uint64_t MachOObjectFile::getRelocationType(DataRefImpl Rel) const {
2160   MachO::any_relocation_info RE = getRelocation(Rel);
2161   return getAnyRelocationType(RE);
2162 }
2163 
2164 void MachOObjectFile::getRelocationTypeName(
2165     DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
2166   StringRef res;
2167   uint64_t RType = getRelocationType(Rel);
2168 
2169   unsigned Arch = this->getArch();
2170 
2171   switch (Arch) {
2172     case Triple::x86: {
2173       static const char *const Table[] =  {
2174         "GENERIC_RELOC_VANILLA",
2175         "GENERIC_RELOC_PAIR",
2176         "GENERIC_RELOC_SECTDIFF",
2177         "GENERIC_RELOC_PB_LA_PTR",
2178         "GENERIC_RELOC_LOCAL_SECTDIFF",
2179         "GENERIC_RELOC_TLV" };
2180 
2181       if (RType > 5)
2182         res = "Unknown";
2183       else
2184         res = Table[RType];
2185       break;
2186     }
2187     case Triple::x86_64: {
2188       static const char *const Table[] =  {
2189         "X86_64_RELOC_UNSIGNED",
2190         "X86_64_RELOC_SIGNED",
2191         "X86_64_RELOC_BRANCH",
2192         "X86_64_RELOC_GOT_LOAD",
2193         "X86_64_RELOC_GOT",
2194         "X86_64_RELOC_SUBTRACTOR",
2195         "X86_64_RELOC_SIGNED_1",
2196         "X86_64_RELOC_SIGNED_2",
2197         "X86_64_RELOC_SIGNED_4",
2198         "X86_64_RELOC_TLV" };
2199 
2200       if (RType > 9)
2201         res = "Unknown";
2202       else
2203         res = Table[RType];
2204       break;
2205     }
2206     case Triple::arm: {
2207       static const char *const Table[] =  {
2208         "ARM_RELOC_VANILLA",
2209         "ARM_RELOC_PAIR",
2210         "ARM_RELOC_SECTDIFF",
2211         "ARM_RELOC_LOCAL_SECTDIFF",
2212         "ARM_RELOC_PB_LA_PTR",
2213         "ARM_RELOC_BR24",
2214         "ARM_THUMB_RELOC_BR22",
2215         "ARM_THUMB_32BIT_BRANCH",
2216         "ARM_RELOC_HALF",
2217         "ARM_RELOC_HALF_SECTDIFF" };
2218 
2219       if (RType > 9)
2220         res = "Unknown";
2221       else
2222         res = Table[RType];
2223       break;
2224     }
2225     case Triple::aarch64:
2226     case Triple::aarch64_32: {
2227       static const char *const Table[] = {
2228         "ARM64_RELOC_UNSIGNED",           "ARM64_RELOC_SUBTRACTOR",
2229         "ARM64_RELOC_BRANCH26",           "ARM64_RELOC_PAGE21",
2230         "ARM64_RELOC_PAGEOFF12",          "ARM64_RELOC_GOT_LOAD_PAGE21",
2231         "ARM64_RELOC_GOT_LOAD_PAGEOFF12", "ARM64_RELOC_POINTER_TO_GOT",
2232         "ARM64_RELOC_TLVP_LOAD_PAGE21",   "ARM64_RELOC_TLVP_LOAD_PAGEOFF12",
2233         "ARM64_RELOC_ADDEND"
2234       };
2235 
2236       if (RType >= array_lengthof(Table))
2237         res = "Unknown";
2238       else
2239         res = Table[RType];
2240       break;
2241     }
2242     case Triple::ppc: {
2243       static const char *const Table[] =  {
2244         "PPC_RELOC_VANILLA",
2245         "PPC_RELOC_PAIR",
2246         "PPC_RELOC_BR14",
2247         "PPC_RELOC_BR24",
2248         "PPC_RELOC_HI16",
2249         "PPC_RELOC_LO16",
2250         "PPC_RELOC_HA16",
2251         "PPC_RELOC_LO14",
2252         "PPC_RELOC_SECTDIFF",
2253         "PPC_RELOC_PB_LA_PTR",
2254         "PPC_RELOC_HI16_SECTDIFF",
2255         "PPC_RELOC_LO16_SECTDIFF",
2256         "PPC_RELOC_HA16_SECTDIFF",
2257         "PPC_RELOC_JBSR",
2258         "PPC_RELOC_LO14_SECTDIFF",
2259         "PPC_RELOC_LOCAL_SECTDIFF" };
2260 
2261       if (RType > 15)
2262         res = "Unknown";
2263       else
2264         res = Table[RType];
2265       break;
2266     }
2267     case Triple::UnknownArch:
2268       res = "Unknown";
2269       break;
2270   }
2271   Result.append(res.begin(), res.end());
2272 }
2273 
2274 uint8_t MachOObjectFile::getRelocationLength(DataRefImpl Rel) const {
2275   MachO::any_relocation_info RE = getRelocation(Rel);
2276   return getAnyRelocationLength(RE);
2277 }
2278 
2279 //
2280 // guessLibraryShortName() is passed a name of a dynamic library and returns a
2281 // guess on what the short name is.  Then name is returned as a substring of the
2282 // StringRef Name passed in.  The name of the dynamic library is recognized as
2283 // a framework if it has one of the two following forms:
2284 //      Foo.framework/Versions/A/Foo
2285 //      Foo.framework/Foo
2286 // Where A and Foo can be any string.  And may contain a trailing suffix
2287 // starting with an underbar.  If the Name is recognized as a framework then
2288 // isFramework is set to true else it is set to false.  If the Name has a
2289 // suffix then Suffix is set to the substring in Name that contains the suffix
2290 // else it is set to a NULL StringRef.
2291 //
2292 // The Name of the dynamic library is recognized as a library name if it has
2293 // one of the two following forms:
2294 //      libFoo.A.dylib
2295 //      libFoo.dylib
2296 //
2297 // The library may have a suffix trailing the name Foo of the form:
2298 //      libFoo_profile.A.dylib
2299 //      libFoo_profile.dylib
2300 // These dyld image suffixes are separated from the short name by a '_'
2301 // character. Because the '_' character is commonly used to separate words in
2302 // filenames guessLibraryShortName() cannot reliably separate a dylib's short
2303 // name from an arbitrary image suffix; imagine if both the short name and the
2304 // suffix contains an '_' character! To better deal with this ambiguity,
2305 // guessLibraryShortName() will recognize only "_debug" and "_profile" as valid
2306 // Suffix values. Calling code needs to be tolerant of guessLibraryShortName()
2307 // guessing incorrectly.
2308 //
2309 // The Name of the dynamic library is also recognized as a library name if it
2310 // has the following form:
2311 //      Foo.qtx
2312 //
2313 // If the Name of the dynamic library is none of the forms above then a NULL
2314 // StringRef is returned.
2315 StringRef MachOObjectFile::guessLibraryShortName(StringRef Name,
2316                                                  bool &isFramework,
2317                                                  StringRef &Suffix) {
2318   StringRef Foo, F, DotFramework, V, Dylib, Lib, Dot, Qtx;
2319   size_t a, b, c, d, Idx;
2320 
2321   isFramework = false;
2322   Suffix = StringRef();
2323 
2324   // Pull off the last component and make Foo point to it
2325   a = Name.rfind('/');
2326   if (a == Name.npos || a == 0)
2327     goto guess_library;
2328   Foo = Name.slice(a+1, Name.npos);
2329 
2330   // Look for a suffix starting with a '_'
2331   Idx = Foo.rfind('_');
2332   if (Idx != Foo.npos && Foo.size() >= 2) {
2333     Suffix = Foo.slice(Idx, Foo.npos);
2334     if (Suffix != "_debug" && Suffix != "_profile")
2335       Suffix = StringRef();
2336     else
2337       Foo = Foo.slice(0, Idx);
2338   }
2339 
2340   // First look for the form Foo.framework/Foo
2341   b = Name.rfind('/', a);
2342   if (b == Name.npos)
2343     Idx = 0;
2344   else
2345     Idx = b+1;
2346   F = Name.slice(Idx, Idx + Foo.size());
2347   DotFramework = Name.slice(Idx + Foo.size(),
2348                             Idx + Foo.size() + sizeof(".framework/")-1);
2349   if (F == Foo && DotFramework == ".framework/") {
2350     isFramework = true;
2351     return Foo;
2352   }
2353 
2354   // Next look for the form Foo.framework/Versions/A/Foo
2355   if (b == Name.npos)
2356     goto guess_library;
2357   c =  Name.rfind('/', b);
2358   if (c == Name.npos || c == 0)
2359     goto guess_library;
2360   V = Name.slice(c+1, Name.npos);
2361   if (!V.startswith("Versions/"))
2362     goto guess_library;
2363   d =  Name.rfind('/', c);
2364   if (d == Name.npos)
2365     Idx = 0;
2366   else
2367     Idx = d+1;
2368   F = Name.slice(Idx, Idx + Foo.size());
2369   DotFramework = Name.slice(Idx + Foo.size(),
2370                             Idx + Foo.size() + sizeof(".framework/")-1);
2371   if (F == Foo && DotFramework == ".framework/") {
2372     isFramework = true;
2373     return Foo;
2374   }
2375 
2376 guess_library:
2377   // pull off the suffix after the "." and make a point to it
2378   a = Name.rfind('.');
2379   if (a == Name.npos || a == 0)
2380     return StringRef();
2381   Dylib = Name.slice(a, Name.npos);
2382   if (Dylib != ".dylib")
2383     goto guess_qtx;
2384 
2385   // First pull off the version letter for the form Foo.A.dylib if any.
2386   if (a >= 3) {
2387     Dot = Name.slice(a-2, a-1);
2388     if (Dot == ".")
2389       a = a - 2;
2390   }
2391 
2392   b = Name.rfind('/', a);
2393   if (b == Name.npos)
2394     b = 0;
2395   else
2396     b = b+1;
2397   // ignore any suffix after an underbar like Foo_profile.A.dylib
2398   Idx = Name.rfind('_');
2399   if (Idx != Name.npos && Idx != b) {
2400     Lib = Name.slice(b, Idx);
2401     Suffix = Name.slice(Idx, a);
2402     if (Suffix != "_debug" && Suffix != "_profile") {
2403       Suffix = StringRef();
2404       Lib = Name.slice(b, a);
2405     }
2406   }
2407   else
2408     Lib = Name.slice(b, a);
2409   // There are incorrect library names of the form:
2410   // libATS.A_profile.dylib so check for these.
2411   if (Lib.size() >= 3) {
2412     Dot = Lib.slice(Lib.size()-2, Lib.size()-1);
2413     if (Dot == ".")
2414       Lib = Lib.slice(0, Lib.size()-2);
2415   }
2416   return Lib;
2417 
2418 guess_qtx:
2419   Qtx = Name.slice(a, Name.npos);
2420   if (Qtx != ".qtx")
2421     return StringRef();
2422   b = Name.rfind('/', a);
2423   if (b == Name.npos)
2424     Lib = Name.slice(0, a);
2425   else
2426     Lib = Name.slice(b+1, a);
2427   // There are library names of the form: QT.A.qtx so check for these.
2428   if (Lib.size() >= 3) {
2429     Dot = Lib.slice(Lib.size()-2, Lib.size()-1);
2430     if (Dot == ".")
2431       Lib = Lib.slice(0, Lib.size()-2);
2432   }
2433   return Lib;
2434 }
2435 
2436 // getLibraryShortNameByIndex() is used to get the short name of the library
2437 // for an undefined symbol in a linked Mach-O binary that was linked with the
2438 // normal two-level namespace default (that is MH_TWOLEVEL in the header).
2439 // It is passed the index (0 - based) of the library as translated from
2440 // GET_LIBRARY_ORDINAL (1 - based).
2441 std::error_code MachOObjectFile::getLibraryShortNameByIndex(unsigned Index,
2442                                                          StringRef &Res) const {
2443   if (Index >= Libraries.size())
2444     return object_error::parse_failed;
2445 
2446   // If the cache of LibrariesShortNames is not built up do that first for
2447   // all the Libraries.
2448   if (LibrariesShortNames.size() == 0) {
2449     for (unsigned i = 0; i < Libraries.size(); i++) {
2450       auto CommandOrErr =
2451         getStructOrErr<MachO::dylib_command>(*this, Libraries[i]);
2452       if (!CommandOrErr)
2453         return object_error::parse_failed;
2454       MachO::dylib_command D = CommandOrErr.get();
2455       if (D.dylib.name >= D.cmdsize)
2456         return object_error::parse_failed;
2457       const char *P = (const char *)(Libraries[i]) + D.dylib.name;
2458       StringRef Name = StringRef(P);
2459       if (D.dylib.name+Name.size() >= D.cmdsize)
2460         return object_error::parse_failed;
2461       StringRef Suffix;
2462       bool isFramework;
2463       StringRef shortName = guessLibraryShortName(Name, isFramework, Suffix);
2464       if (shortName.empty())
2465         LibrariesShortNames.push_back(Name);
2466       else
2467         LibrariesShortNames.push_back(shortName);
2468     }
2469   }
2470 
2471   Res = LibrariesShortNames[Index];
2472   return std::error_code();
2473 }
2474 
2475 uint32_t MachOObjectFile::getLibraryCount() const {
2476   return Libraries.size();
2477 }
2478 
2479 section_iterator
2480 MachOObjectFile::getRelocationRelocatedSection(relocation_iterator Rel) const {
2481   DataRefImpl Sec;
2482   Sec.d.a = Rel->getRawDataRefImpl().d.a;
2483   return section_iterator(SectionRef(Sec, this));
2484 }
2485 
2486 basic_symbol_iterator MachOObjectFile::symbol_begin() const {
2487   DataRefImpl DRI;
2488   MachO::symtab_command Symtab = getSymtabLoadCommand();
2489   if (!SymtabLoadCmd || Symtab.nsyms == 0)
2490     return basic_symbol_iterator(SymbolRef(DRI, this));
2491 
2492   return getSymbolByIndex(0);
2493 }
2494 
2495 basic_symbol_iterator MachOObjectFile::symbol_end() const {
2496   DataRefImpl DRI;
2497   MachO::symtab_command Symtab = getSymtabLoadCommand();
2498   if (!SymtabLoadCmd || Symtab.nsyms == 0)
2499     return basic_symbol_iterator(SymbolRef(DRI, this));
2500 
2501   unsigned SymbolTableEntrySize = is64Bit() ?
2502     sizeof(MachO::nlist_64) :
2503     sizeof(MachO::nlist);
2504   unsigned Offset = Symtab.symoff +
2505     Symtab.nsyms * SymbolTableEntrySize;
2506   DRI.p = reinterpret_cast<uintptr_t>(getPtr(*this, Offset));
2507   return basic_symbol_iterator(SymbolRef(DRI, this));
2508 }
2509 
2510 symbol_iterator MachOObjectFile::getSymbolByIndex(unsigned Index) const {
2511   MachO::symtab_command Symtab = getSymtabLoadCommand();
2512   if (!SymtabLoadCmd || Index >= Symtab.nsyms)
2513     report_fatal_error("Requested symbol index is out of range.");
2514   unsigned SymbolTableEntrySize =
2515     is64Bit() ? sizeof(MachO::nlist_64) : sizeof(MachO::nlist);
2516   DataRefImpl DRI;
2517   DRI.p = reinterpret_cast<uintptr_t>(getPtr(*this, Symtab.symoff));
2518   DRI.p += Index * SymbolTableEntrySize;
2519   return basic_symbol_iterator(SymbolRef(DRI, this));
2520 }
2521 
2522 uint64_t MachOObjectFile::getSymbolIndex(DataRefImpl Symb) const {
2523   MachO::symtab_command Symtab = getSymtabLoadCommand();
2524   if (!SymtabLoadCmd)
2525     report_fatal_error("getSymbolIndex() called with no symbol table symbol");
2526   unsigned SymbolTableEntrySize =
2527     is64Bit() ? sizeof(MachO::nlist_64) : sizeof(MachO::nlist);
2528   DataRefImpl DRIstart;
2529   DRIstart.p = reinterpret_cast<uintptr_t>(getPtr(*this, Symtab.symoff));
2530   uint64_t Index = (Symb.p - DRIstart.p) / SymbolTableEntrySize;
2531   return Index;
2532 }
2533 
2534 section_iterator MachOObjectFile::section_begin() const {
2535   DataRefImpl DRI;
2536   return section_iterator(SectionRef(DRI, this));
2537 }
2538 
2539 section_iterator MachOObjectFile::section_end() const {
2540   DataRefImpl DRI;
2541   DRI.d.a = Sections.size();
2542   return section_iterator(SectionRef(DRI, this));
2543 }
2544 
2545 uint8_t MachOObjectFile::getBytesInAddress() const {
2546   return is64Bit() ? 8 : 4;
2547 }
2548 
2549 StringRef MachOObjectFile::getFileFormatName() const {
2550   unsigned CPUType = getCPUType(*this);
2551   if (!is64Bit()) {
2552     switch (CPUType) {
2553     case MachO::CPU_TYPE_I386:
2554       return "Mach-O 32-bit i386";
2555     case MachO::CPU_TYPE_ARM:
2556       return "Mach-O arm";
2557     case MachO::CPU_TYPE_ARM64_32:
2558       return "Mach-O arm64 (ILP32)";
2559     case MachO::CPU_TYPE_POWERPC:
2560       return "Mach-O 32-bit ppc";
2561     default:
2562       return "Mach-O 32-bit unknown";
2563     }
2564   }
2565 
2566   switch (CPUType) {
2567   case MachO::CPU_TYPE_X86_64:
2568     return "Mach-O 64-bit x86-64";
2569   case MachO::CPU_TYPE_ARM64:
2570     return "Mach-O arm64";
2571   case MachO::CPU_TYPE_POWERPC64:
2572     return "Mach-O 64-bit ppc64";
2573   default:
2574     return "Mach-O 64-bit unknown";
2575   }
2576 }
2577 
2578 Triple::ArchType MachOObjectFile::getArch(uint32_t CPUType, uint32_t CPUSubType) {
2579   switch (CPUType) {
2580   case MachO::CPU_TYPE_I386:
2581     return Triple::x86;
2582   case MachO::CPU_TYPE_X86_64:
2583     return Triple::x86_64;
2584   case MachO::CPU_TYPE_ARM:
2585     return Triple::arm;
2586   case MachO::CPU_TYPE_ARM64:
2587     return Triple::aarch64;
2588   case MachO::CPU_TYPE_ARM64_32:
2589     return Triple::aarch64_32;
2590   case MachO::CPU_TYPE_POWERPC:
2591     return Triple::ppc;
2592   case MachO::CPU_TYPE_POWERPC64:
2593     return Triple::ppc64;
2594   default:
2595     return Triple::UnknownArch;
2596   }
2597 }
2598 
2599 Triple MachOObjectFile::getArchTriple(uint32_t CPUType, uint32_t CPUSubType,
2600                                       const char **McpuDefault,
2601                                       const char **ArchFlag) {
2602   if (McpuDefault)
2603     *McpuDefault = nullptr;
2604   if (ArchFlag)
2605     *ArchFlag = nullptr;
2606 
2607   switch (CPUType) {
2608   case MachO::CPU_TYPE_I386:
2609     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2610     case MachO::CPU_SUBTYPE_I386_ALL:
2611       if (ArchFlag)
2612         *ArchFlag = "i386";
2613       return Triple("i386-apple-darwin");
2614     default:
2615       return Triple();
2616     }
2617   case MachO::CPU_TYPE_X86_64:
2618     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2619     case MachO::CPU_SUBTYPE_X86_64_ALL:
2620       if (ArchFlag)
2621         *ArchFlag = "x86_64";
2622       return Triple("x86_64-apple-darwin");
2623     case MachO::CPU_SUBTYPE_X86_64_H:
2624       if (ArchFlag)
2625         *ArchFlag = "x86_64h";
2626       return Triple("x86_64h-apple-darwin");
2627     default:
2628       return Triple();
2629     }
2630   case MachO::CPU_TYPE_ARM:
2631     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2632     case MachO::CPU_SUBTYPE_ARM_V4T:
2633       if (ArchFlag)
2634         *ArchFlag = "armv4t";
2635       return Triple("armv4t-apple-darwin");
2636     case MachO::CPU_SUBTYPE_ARM_V5TEJ:
2637       if (ArchFlag)
2638         *ArchFlag = "armv5e";
2639       return Triple("armv5e-apple-darwin");
2640     case MachO::CPU_SUBTYPE_ARM_XSCALE:
2641       if (ArchFlag)
2642         *ArchFlag = "xscale";
2643       return Triple("xscale-apple-darwin");
2644     case MachO::CPU_SUBTYPE_ARM_V6:
2645       if (ArchFlag)
2646         *ArchFlag = "armv6";
2647       return Triple("armv6-apple-darwin");
2648     case MachO::CPU_SUBTYPE_ARM_V6M:
2649       if (McpuDefault)
2650         *McpuDefault = "cortex-m0";
2651       if (ArchFlag)
2652         *ArchFlag = "armv6m";
2653       return Triple("armv6m-apple-darwin");
2654     case MachO::CPU_SUBTYPE_ARM_V7:
2655       if (ArchFlag)
2656         *ArchFlag = "armv7";
2657       return Triple("armv7-apple-darwin");
2658     case MachO::CPU_SUBTYPE_ARM_V7EM:
2659       if (McpuDefault)
2660         *McpuDefault = "cortex-m4";
2661       if (ArchFlag)
2662         *ArchFlag = "armv7em";
2663       return Triple("thumbv7em-apple-darwin");
2664     case MachO::CPU_SUBTYPE_ARM_V7K:
2665       if (McpuDefault)
2666         *McpuDefault = "cortex-a7";
2667       if (ArchFlag)
2668         *ArchFlag = "armv7k";
2669       return Triple("armv7k-apple-darwin");
2670     case MachO::CPU_SUBTYPE_ARM_V7M:
2671       if (McpuDefault)
2672         *McpuDefault = "cortex-m3";
2673       if (ArchFlag)
2674         *ArchFlag = "armv7m";
2675       return Triple("thumbv7m-apple-darwin");
2676     case MachO::CPU_SUBTYPE_ARM_V7S:
2677       if (McpuDefault)
2678         *McpuDefault = "cortex-a7";
2679       if (ArchFlag)
2680         *ArchFlag = "armv7s";
2681       return Triple("armv7s-apple-darwin");
2682     default:
2683       return Triple();
2684     }
2685   case MachO::CPU_TYPE_ARM64:
2686     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2687     case MachO::CPU_SUBTYPE_ARM64_ALL:
2688       if (McpuDefault)
2689         *McpuDefault = "cyclone";
2690       if (ArchFlag)
2691         *ArchFlag = "arm64";
2692       return Triple("arm64-apple-darwin");
2693     default:
2694       return Triple();
2695     }
2696   case MachO::CPU_TYPE_ARM64_32:
2697     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2698     case MachO::CPU_SUBTYPE_ARM64_32_V8:
2699       if (McpuDefault)
2700         *McpuDefault = "cyclone";
2701       if (ArchFlag)
2702         *ArchFlag = "arm64_32";
2703       return Triple("arm64_32-apple-darwin");
2704     default:
2705       return Triple();
2706     }
2707   case MachO::CPU_TYPE_POWERPC:
2708     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2709     case MachO::CPU_SUBTYPE_POWERPC_ALL:
2710       if (ArchFlag)
2711         *ArchFlag = "ppc";
2712       return Triple("ppc-apple-darwin");
2713     default:
2714       return Triple();
2715     }
2716   case MachO::CPU_TYPE_POWERPC64:
2717     switch (CPUSubType & ~MachO::CPU_SUBTYPE_MASK) {
2718     case MachO::CPU_SUBTYPE_POWERPC_ALL:
2719       if (ArchFlag)
2720         *ArchFlag = "ppc64";
2721       return Triple("ppc64-apple-darwin");
2722     default:
2723       return Triple();
2724     }
2725   default:
2726     return Triple();
2727   }
2728 }
2729 
2730 Triple MachOObjectFile::getHostArch() {
2731   return Triple(sys::getDefaultTargetTriple());
2732 }
2733 
2734 bool MachOObjectFile::isValidArch(StringRef ArchFlag) {
2735   auto validArchs = getValidArchs();
2736   return llvm::find(validArchs, ArchFlag) != validArchs.end();
2737 }
2738 
2739 ArrayRef<StringRef> MachOObjectFile::getValidArchs() {
2740   static const std::array<StringRef, 17> validArchs = {{
2741       "i386",   "x86_64", "x86_64h",  "armv4t",  "arm",    "armv5e",
2742       "armv6",  "armv6m", "armv7",    "armv7em", "armv7k", "armv7m",
2743       "armv7s", "arm64",  "arm64_32", "ppc",     "ppc64",
2744   }};
2745 
2746   return validArchs;
2747 }
2748 
2749 Triple::ArchType MachOObjectFile::getArch() const {
2750   return getArch(getCPUType(*this), getCPUSubType(*this));
2751 }
2752 
2753 Triple MachOObjectFile::getArchTriple(const char **McpuDefault) const {
2754   return getArchTriple(Header.cputype, Header.cpusubtype, McpuDefault);
2755 }
2756 
2757 relocation_iterator MachOObjectFile::section_rel_begin(unsigned Index) const {
2758   DataRefImpl DRI;
2759   DRI.d.a = Index;
2760   return section_rel_begin(DRI);
2761 }
2762 
2763 relocation_iterator MachOObjectFile::section_rel_end(unsigned Index) const {
2764   DataRefImpl DRI;
2765   DRI.d.a = Index;
2766   return section_rel_end(DRI);
2767 }
2768 
2769 dice_iterator MachOObjectFile::begin_dices() const {
2770   DataRefImpl DRI;
2771   if (!DataInCodeLoadCmd)
2772     return dice_iterator(DiceRef(DRI, this));
2773 
2774   MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
2775   DRI.p = reinterpret_cast<uintptr_t>(getPtr(*this, DicLC.dataoff));
2776   return dice_iterator(DiceRef(DRI, this));
2777 }
2778 
2779 dice_iterator MachOObjectFile::end_dices() const {
2780   DataRefImpl DRI;
2781   if (!DataInCodeLoadCmd)
2782     return dice_iterator(DiceRef(DRI, this));
2783 
2784   MachO::linkedit_data_command DicLC = getDataInCodeLoadCommand();
2785   unsigned Offset = DicLC.dataoff + DicLC.datasize;
2786   DRI.p = reinterpret_cast<uintptr_t>(getPtr(*this, Offset));
2787   return dice_iterator(DiceRef(DRI, this));
2788 }
2789 
2790 ExportEntry::ExportEntry(Error *E, const MachOObjectFile *O,
2791                          ArrayRef<uint8_t> T) : E(E), O(O), Trie(T) {}
2792 
2793 void ExportEntry::moveToFirst() {
2794   ErrorAsOutParameter ErrAsOutParam(E);
2795   pushNode(0);
2796   if (*E)
2797     return;
2798   pushDownUntilBottom();
2799 }
2800 
2801 void ExportEntry::moveToEnd() {
2802   Stack.clear();
2803   Done = true;
2804 }
2805 
2806 bool ExportEntry::operator==(const ExportEntry &Other) const {
2807   // Common case, one at end, other iterating from begin.
2808   if (Done || Other.Done)
2809     return (Done == Other.Done);
2810   // Not equal if different stack sizes.
2811   if (Stack.size() != Other.Stack.size())
2812     return false;
2813   // Not equal if different cumulative strings.
2814   if (!CumulativeString.equals(Other.CumulativeString))
2815     return false;
2816   // Equal if all nodes in both stacks match.
2817   for (unsigned i=0; i < Stack.size(); ++i) {
2818     if (Stack[i].Start != Other.Stack[i].Start)
2819       return false;
2820   }
2821   return true;
2822 }
2823 
2824 uint64_t ExportEntry::readULEB128(const uint8_t *&Ptr, const char **error) {
2825   unsigned Count;
2826   uint64_t Result = decodeULEB128(Ptr, &Count, Trie.end(), error);
2827   Ptr += Count;
2828   if (Ptr > Trie.end())
2829     Ptr = Trie.end();
2830   return Result;
2831 }
2832 
2833 StringRef ExportEntry::name() const {
2834   return CumulativeString;
2835 }
2836 
2837 uint64_t ExportEntry::flags() const {
2838   return Stack.back().Flags;
2839 }
2840 
2841 uint64_t ExportEntry::address() const {
2842   return Stack.back().Address;
2843 }
2844 
2845 uint64_t ExportEntry::other() const {
2846   return Stack.back().Other;
2847 }
2848 
2849 StringRef ExportEntry::otherName() const {
2850   const char* ImportName = Stack.back().ImportName;
2851   if (ImportName)
2852     return StringRef(ImportName);
2853   return StringRef();
2854 }
2855 
2856 uint32_t ExportEntry::nodeOffset() const {
2857   return Stack.back().Start - Trie.begin();
2858 }
2859 
2860 ExportEntry::NodeState::NodeState(const uint8_t *Ptr)
2861     : Start(Ptr), Current(Ptr) {}
2862 
2863 void ExportEntry::pushNode(uint64_t offset) {
2864   ErrorAsOutParameter ErrAsOutParam(E);
2865   const uint8_t *Ptr = Trie.begin() + offset;
2866   NodeState State(Ptr);
2867   const char *error;
2868   uint64_t ExportInfoSize = readULEB128(State.Current, &error);
2869   if (error) {
2870     *E = malformedError("export info size " + Twine(error) +
2871                         " in export trie data at node: 0x" +
2872                         Twine::utohexstr(offset));
2873     moveToEnd();
2874     return;
2875   }
2876   State.IsExportNode = (ExportInfoSize != 0);
2877   const uint8_t* Children = State.Current + ExportInfoSize;
2878   if (Children > Trie.end()) {
2879     *E = malformedError(
2880         "export info size: 0x" + Twine::utohexstr(ExportInfoSize) +
2881         " in export trie data at node: 0x" + Twine::utohexstr(offset) +
2882         " too big and extends past end of trie data");
2883     moveToEnd();
2884     return;
2885   }
2886   if (State.IsExportNode) {
2887     const uint8_t *ExportStart = State.Current;
2888     State.Flags = readULEB128(State.Current, &error);
2889     if (error) {
2890       *E = malformedError("flags " + Twine(error) +
2891                           " in export trie data at node: 0x" +
2892                           Twine::utohexstr(offset));
2893       moveToEnd();
2894       return;
2895     }
2896     uint64_t Kind = State.Flags & MachO::EXPORT_SYMBOL_FLAGS_KIND_MASK;
2897     if (State.Flags != 0 &&
2898         (Kind != MachO::EXPORT_SYMBOL_FLAGS_KIND_REGULAR &&
2899          Kind != MachO::EXPORT_SYMBOL_FLAGS_KIND_ABSOLUTE &&
2900          Kind != MachO::EXPORT_SYMBOL_FLAGS_KIND_THREAD_LOCAL)) {
2901       *E = malformedError(
2902           "unsupported exported symbol kind: " + Twine((int)Kind) +
2903           " in flags: 0x" + Twine::utohexstr(State.Flags) +
2904           " in export trie data at node: 0x" + Twine::utohexstr(offset));
2905       moveToEnd();
2906       return;
2907     }
2908     if (State.Flags & MachO::EXPORT_SYMBOL_FLAGS_REEXPORT) {
2909       State.Address = 0;
2910       State.Other = readULEB128(State.Current, &error); // dylib ordinal
2911       if (error) {
2912         *E = malformedError("dylib ordinal of re-export " + Twine(error) +
2913                             " in export trie data at node: 0x" +
2914                             Twine::utohexstr(offset));
2915         moveToEnd();
2916         return;
2917       }
2918       if (O != nullptr) {
2919         if (State.Other > O->getLibraryCount()) {
2920           *E = malformedError(
2921               "bad library ordinal: " + Twine((int)State.Other) + " (max " +
2922               Twine((int)O->getLibraryCount()) +
2923               ") in export trie data at node: 0x" + Twine::utohexstr(offset));
2924           moveToEnd();
2925           return;
2926         }
2927       }
2928       State.ImportName = reinterpret_cast<const char*>(State.Current);
2929       if (*State.ImportName == '\0') {
2930         State.Current++;
2931       } else {
2932         const uint8_t *End = State.Current + 1;
2933         if (End >= Trie.end()) {
2934           *E = malformedError("import name of re-export in export trie data at "
2935                               "node: 0x" +
2936                               Twine::utohexstr(offset) +
2937                               " starts past end of trie data");
2938           moveToEnd();
2939           return;
2940         }
2941         while(*End != '\0' && End < Trie.end())
2942           End++;
2943         if (*End != '\0') {
2944           *E = malformedError("import name of re-export in export trie data at "
2945                               "node: 0x" +
2946                               Twine::utohexstr(offset) +
2947                               " extends past end of trie data");
2948           moveToEnd();
2949           return;
2950         }
2951         State.Current = End + 1;
2952       }
2953     } else {
2954       State.Address = readULEB128(State.Current, &error);
2955       if (error) {
2956         *E = malformedError("address " + Twine(error) +
2957                             " in export trie data at node: 0x" +
2958                             Twine::utohexstr(offset));
2959         moveToEnd();
2960         return;
2961       }
2962       if (State.Flags & MachO::EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER) {
2963         State.Other = readULEB128(State.Current, &error);
2964         if (error) {
2965           *E = malformedError("resolver of stub and resolver " + Twine(error) +
2966                               " in export trie data at node: 0x" +
2967                               Twine::utohexstr(offset));
2968           moveToEnd();
2969           return;
2970         }
2971       }
2972     }
2973     if(ExportStart + ExportInfoSize != State.Current) {
2974       *E = malformedError(
2975           "inconsistant export info size: 0x" +
2976           Twine::utohexstr(ExportInfoSize) + " where actual size was: 0x" +
2977           Twine::utohexstr(State.Current - ExportStart) +
2978           " in export trie data at node: 0x" + Twine::utohexstr(offset));
2979       moveToEnd();
2980       return;
2981     }
2982   }
2983   State.ChildCount = *Children;
2984   if (State.ChildCount != 0 && Children + 1 >= Trie.end()) {
2985     *E = malformedError("byte for count of childern in export trie data at "
2986                         "node: 0x" +
2987                         Twine::utohexstr(offset) +
2988                         " extends past end of trie data");
2989     moveToEnd();
2990     return;
2991   }
2992   State.Current = Children + 1;
2993   State.NextChildIndex = 0;
2994   State.ParentStringLength = CumulativeString.size();
2995   Stack.push_back(State);
2996 }
2997 
2998 void ExportEntry::pushDownUntilBottom() {
2999   ErrorAsOutParameter ErrAsOutParam(E);
3000   const char *error;
3001   while (Stack.back().NextChildIndex < Stack.back().ChildCount) {
3002     NodeState &Top = Stack.back();
3003     CumulativeString.resize(Top.ParentStringLength);
3004     for (;*Top.Current != 0 && Top.Current < Trie.end(); Top.Current++) {
3005       char C = *Top.Current;
3006       CumulativeString.push_back(C);
3007     }
3008     if (Top.Current >= Trie.end()) {
3009       *E = malformedError("edge sub-string in export trie data at node: 0x" +
3010                           Twine::utohexstr(Top.Start - Trie.begin()) +
3011                           " for child #" + Twine((int)Top.NextChildIndex) +
3012                           " extends past end of trie data");
3013       moveToEnd();
3014       return;
3015     }
3016     Top.Current += 1;
3017     uint64_t childNodeIndex = readULEB128(Top.Current, &error);
3018     if (error) {
3019       *E = malformedError("child node offset " + Twine(error) +
3020                           " in export trie data at node: 0x" +
3021                           Twine::utohexstr(Top.Start - Trie.begin()));
3022       moveToEnd();
3023       return;
3024     }
3025     for (const NodeState &node : nodes()) {
3026       if (node.Start == Trie.begin() + childNodeIndex){
3027         *E = malformedError("loop in childern in export trie data at node: 0x" +
3028                             Twine::utohexstr(Top.Start - Trie.begin()) +
3029                             " back to node: 0x" +
3030                             Twine::utohexstr(childNodeIndex));
3031         moveToEnd();
3032         return;
3033       }
3034     }
3035     Top.NextChildIndex += 1;
3036     pushNode(childNodeIndex);
3037     if (*E)
3038       return;
3039   }
3040   if (!Stack.back().IsExportNode) {
3041     *E = malformedError("node is not an export node in export trie data at "
3042                         "node: 0x" +
3043                         Twine::utohexstr(Stack.back().Start - Trie.begin()));
3044     moveToEnd();
3045     return;
3046   }
3047 }
3048 
3049 // We have a trie data structure and need a way to walk it that is compatible
3050 // with the C++ iterator model. The solution is a non-recursive depth first
3051 // traversal where the iterator contains a stack of parent nodes along with a
3052 // string that is the accumulation of all edge strings along the parent chain
3053 // to this point.
3054 //
3055 // There is one "export" node for each exported symbol.  But because some
3056 // symbols may be a prefix of another symbol (e.g. _dup and _dup2), an export
3057 // node may have child nodes too.
3058 //
3059 // The algorithm for moveNext() is to keep moving down the leftmost unvisited
3060 // child until hitting a node with no children (which is an export node or
3061 // else the trie is malformed). On the way down, each node is pushed on the
3062 // stack ivar.  If there is no more ways down, it pops up one and tries to go
3063 // down a sibling path until a childless node is reached.
3064 void ExportEntry::moveNext() {
3065   assert(!Stack.empty() && "ExportEntry::moveNext() with empty node stack");
3066   if (!Stack.back().IsExportNode) {
3067     *E = malformedError("node is not an export node in export trie data at "
3068                         "node: 0x" +
3069                         Twine::utohexstr(Stack.back().Start - Trie.begin()));
3070     moveToEnd();
3071     return;
3072   }
3073 
3074   Stack.pop_back();
3075   while (!Stack.empty()) {
3076     NodeState &Top = Stack.back();
3077     if (Top.NextChildIndex < Top.ChildCount) {
3078       pushDownUntilBottom();
3079       // Now at the next export node.
3080       return;
3081     } else {
3082       if (Top.IsExportNode) {
3083         // This node has no children but is itself an export node.
3084         CumulativeString.resize(Top.ParentStringLength);
3085         return;
3086       }
3087       Stack.pop_back();
3088     }
3089   }
3090   Done = true;
3091 }
3092 
3093 iterator_range<export_iterator>
3094 MachOObjectFile::exports(Error &E, ArrayRef<uint8_t> Trie,
3095                          const MachOObjectFile *O) {
3096   ExportEntry Start(&E, O, Trie);
3097   if (Trie.empty())
3098     Start.moveToEnd();
3099   else
3100     Start.moveToFirst();
3101 
3102   ExportEntry Finish(&E, O, Trie);
3103   Finish.moveToEnd();
3104 
3105   return make_range(export_iterator(Start), export_iterator(Finish));
3106 }
3107 
3108 iterator_range<export_iterator> MachOObjectFile::exports(Error &Err) const {
3109   return exports(Err, getDyldInfoExportsTrie(), this);
3110 }
3111 
3112 MachORebaseEntry::MachORebaseEntry(Error *E, const MachOObjectFile *O,
3113                                    ArrayRef<uint8_t> Bytes, bool is64Bit)
3114     : E(E), O(O), Opcodes(Bytes), Ptr(Bytes.begin()),
3115       PointerSize(is64Bit ? 8 : 4) {}
3116 
3117 void MachORebaseEntry::moveToFirst() {
3118   Ptr = Opcodes.begin();
3119   moveNext();
3120 }
3121 
3122 void MachORebaseEntry::moveToEnd() {
3123   Ptr = Opcodes.end();
3124   RemainingLoopCount = 0;
3125   Done = true;
3126 }
3127 
3128 void MachORebaseEntry::moveNext() {
3129   ErrorAsOutParameter ErrAsOutParam(E);
3130   // If in the middle of some loop, move to next rebasing in loop.
3131   SegmentOffset += AdvanceAmount;
3132   if (RemainingLoopCount) {
3133     --RemainingLoopCount;
3134     return;
3135   }
3136   // REBASE_OPCODE_DONE is only used for padding if we are not aligned to
3137   // pointer size. Therefore it is possible to reach the end without ever having
3138   // seen REBASE_OPCODE_DONE.
3139   if (Ptr == Opcodes.end()) {
3140     Done = true;
3141     return;
3142   }
3143   bool More = true;
3144   while (More) {
3145     // Parse next opcode and set up next loop.
3146     const uint8_t *OpcodeStart = Ptr;
3147     uint8_t Byte = *Ptr++;
3148     uint8_t ImmValue = Byte & MachO::REBASE_IMMEDIATE_MASK;
3149     uint8_t Opcode = Byte & MachO::REBASE_OPCODE_MASK;
3150     uint32_t Count, Skip;
3151     const char *error = nullptr;
3152     switch (Opcode) {
3153     case MachO::REBASE_OPCODE_DONE:
3154       More = false;
3155       Done = true;
3156       moveToEnd();
3157       DEBUG_WITH_TYPE("mach-o-rebase", dbgs() << "REBASE_OPCODE_DONE\n");
3158       break;
3159     case MachO::REBASE_OPCODE_SET_TYPE_IMM:
3160       RebaseType = ImmValue;
3161       if (RebaseType > MachO::REBASE_TYPE_TEXT_PCREL32) {
3162         *E = malformedError("for REBASE_OPCODE_SET_TYPE_IMM bad bind type: " +
3163                             Twine((int)RebaseType) + " for opcode at: 0x" +
3164                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3165         moveToEnd();
3166         return;
3167       }
3168       DEBUG_WITH_TYPE(
3169           "mach-o-rebase",
3170           dbgs() << "REBASE_OPCODE_SET_TYPE_IMM: "
3171                  << "RebaseType=" << (int) RebaseType << "\n");
3172       break;
3173     case MachO::REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB:
3174       SegmentIndex = ImmValue;
3175       SegmentOffset = readULEB128(&error);
3176       if (error) {
3177         *E = malformedError("for REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB " +
3178                             Twine(error) + " for opcode at: 0x" +
3179                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3180         moveToEnd();
3181         return;
3182       }
3183       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3184                                                PointerSize);
3185       if (error) {
3186         *E = malformedError("for REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB " +
3187                             Twine(error) + " for opcode at: 0x" +
3188                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3189         moveToEnd();
3190         return;
3191       }
3192       DEBUG_WITH_TYPE(
3193           "mach-o-rebase",
3194           dbgs() << "REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB: "
3195                  << "SegmentIndex=" << SegmentIndex << ", "
3196                  << format("SegmentOffset=0x%06X", SegmentOffset)
3197                  << "\n");
3198       break;
3199     case MachO::REBASE_OPCODE_ADD_ADDR_ULEB:
3200       SegmentOffset += readULEB128(&error);
3201       if (error) {
3202         *E = malformedError("for REBASE_OPCODE_ADD_ADDR_ULEB " + Twine(error) +
3203                             " for opcode at: 0x" +
3204                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3205         moveToEnd();
3206         return;
3207       }
3208       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3209                                                PointerSize);
3210       if (error) {
3211         *E = malformedError("for REBASE_OPCODE_ADD_ADDR_ULEB " + Twine(error) +
3212                             " for opcode at: 0x" +
3213                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3214         moveToEnd();
3215         return;
3216       }
3217       DEBUG_WITH_TYPE("mach-o-rebase",
3218                       dbgs() << "REBASE_OPCODE_ADD_ADDR_ULEB: "
3219                              << format("SegmentOffset=0x%06X",
3220                                        SegmentOffset) << "\n");
3221       break;
3222     case MachO::REBASE_OPCODE_ADD_ADDR_IMM_SCALED:
3223       SegmentOffset += ImmValue * PointerSize;
3224       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3225                                                PointerSize);
3226       if (error) {
3227         *E = malformedError("for REBASE_OPCODE_ADD_ADDR_IMM_SCALED " +
3228                             Twine(error) + " for opcode at: 0x" +
3229                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3230         moveToEnd();
3231         return;
3232       }
3233       DEBUG_WITH_TYPE("mach-o-rebase",
3234                       dbgs() << "REBASE_OPCODE_ADD_ADDR_IMM_SCALED: "
3235                              << format("SegmentOffset=0x%06X",
3236                                        SegmentOffset) << "\n");
3237       break;
3238     case MachO::REBASE_OPCODE_DO_REBASE_IMM_TIMES:
3239       AdvanceAmount = PointerSize;
3240       Skip = 0;
3241       Count = ImmValue;
3242       if (ImmValue != 0)
3243         RemainingLoopCount = ImmValue - 1;
3244       else
3245         RemainingLoopCount = 0;
3246       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3247                                                PointerSize, Count, Skip);
3248       if (error) {
3249         *E = malformedError("for REBASE_OPCODE_DO_REBASE_IMM_TIMES " +
3250                             Twine(error) + " for opcode at: 0x" +
3251                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3252         moveToEnd();
3253         return;
3254       }
3255       DEBUG_WITH_TYPE(
3256           "mach-o-rebase",
3257           dbgs() << "REBASE_OPCODE_DO_REBASE_IMM_TIMES: "
3258                  << format("SegmentOffset=0x%06X", SegmentOffset)
3259                  << ", AdvanceAmount=" << AdvanceAmount
3260                  << ", RemainingLoopCount=" << RemainingLoopCount
3261                  << "\n");
3262       return;
3263     case MachO::REBASE_OPCODE_DO_REBASE_ULEB_TIMES:
3264       AdvanceAmount = PointerSize;
3265       Skip = 0;
3266       Count = readULEB128(&error);
3267       if (error) {
3268         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ULEB_TIMES " +
3269                             Twine(error) + " for opcode at: 0x" +
3270                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3271         moveToEnd();
3272         return;
3273       }
3274       if (Count != 0)
3275         RemainingLoopCount = Count - 1;
3276       else
3277         RemainingLoopCount = 0;
3278       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3279                                                PointerSize, Count, Skip);
3280       if (error) {
3281         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ULEB_TIMES " +
3282                             Twine(error) + " for opcode at: 0x" +
3283                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3284         moveToEnd();
3285         return;
3286       }
3287       DEBUG_WITH_TYPE(
3288           "mach-o-rebase",
3289           dbgs() << "REBASE_OPCODE_DO_REBASE_ULEB_TIMES: "
3290                  << format("SegmentOffset=0x%06X", SegmentOffset)
3291                  << ", AdvanceAmount=" << AdvanceAmount
3292                  << ", RemainingLoopCount=" << RemainingLoopCount
3293                  << "\n");
3294       return;
3295     case MachO::REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB:
3296       Skip = readULEB128(&error);
3297       if (error) {
3298         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB " +
3299                             Twine(error) + " for opcode at: 0x" +
3300                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3301         moveToEnd();
3302         return;
3303       }
3304       AdvanceAmount = Skip + PointerSize;
3305       Count = 1;
3306       RemainingLoopCount = 0;
3307       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3308                                                PointerSize, Count, Skip);
3309       if (error) {
3310         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB " +
3311                             Twine(error) + " for opcode at: 0x" +
3312                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3313         moveToEnd();
3314         return;
3315       }
3316       DEBUG_WITH_TYPE(
3317           "mach-o-rebase",
3318           dbgs() << "REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB: "
3319                  << format("SegmentOffset=0x%06X", SegmentOffset)
3320                  << ", AdvanceAmount=" << AdvanceAmount
3321                  << ", RemainingLoopCount=" << RemainingLoopCount
3322                  << "\n");
3323       return;
3324     case MachO::REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_ULEB:
3325       Count = readULEB128(&error);
3326       if (error) {
3327         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_"
3328                             "ULEB " +
3329                             Twine(error) + " for opcode at: 0x" +
3330                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3331         moveToEnd();
3332         return;
3333       }
3334       if (Count != 0)
3335         RemainingLoopCount = Count - 1;
3336       else
3337         RemainingLoopCount = 0;
3338       Skip = readULEB128(&error);
3339       if (error) {
3340         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_"
3341                             "ULEB " +
3342                             Twine(error) + " for opcode at: 0x" +
3343                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3344         moveToEnd();
3345         return;
3346       }
3347       AdvanceAmount = Skip + PointerSize;
3348 
3349       error = O->RebaseEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3350                                                PointerSize, Count, Skip);
3351       if (error) {
3352         *E = malformedError("for REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_"
3353                             "ULEB " +
3354                             Twine(error) + " for opcode at: 0x" +
3355                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3356         moveToEnd();
3357         return;
3358       }
3359       DEBUG_WITH_TYPE(
3360           "mach-o-rebase",
3361           dbgs() << "REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_ULEB: "
3362                  << format("SegmentOffset=0x%06X", SegmentOffset)
3363                  << ", AdvanceAmount=" << AdvanceAmount
3364                  << ", RemainingLoopCount=" << RemainingLoopCount
3365                  << "\n");
3366       return;
3367     default:
3368       *E = malformedError("bad rebase info (bad opcode value 0x" +
3369                           Twine::utohexstr(Opcode) + " for opcode at: 0x" +
3370                           Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3371       moveToEnd();
3372       return;
3373     }
3374   }
3375 }
3376 
3377 uint64_t MachORebaseEntry::readULEB128(const char **error) {
3378   unsigned Count;
3379   uint64_t Result = decodeULEB128(Ptr, &Count, Opcodes.end(), error);
3380   Ptr += Count;
3381   if (Ptr > Opcodes.end())
3382     Ptr = Opcodes.end();
3383   return Result;
3384 }
3385 
3386 int32_t MachORebaseEntry::segmentIndex() const { return SegmentIndex; }
3387 
3388 uint64_t MachORebaseEntry::segmentOffset() const { return SegmentOffset; }
3389 
3390 StringRef MachORebaseEntry::typeName() const {
3391   switch (RebaseType) {
3392   case MachO::REBASE_TYPE_POINTER:
3393     return "pointer";
3394   case MachO::REBASE_TYPE_TEXT_ABSOLUTE32:
3395     return "text abs32";
3396   case MachO::REBASE_TYPE_TEXT_PCREL32:
3397     return "text rel32";
3398   }
3399   return "unknown";
3400 }
3401 
3402 // For use with the SegIndex of a checked Mach-O Rebase entry
3403 // to get the segment name.
3404 StringRef MachORebaseEntry::segmentName() const {
3405   return O->BindRebaseSegmentName(SegmentIndex);
3406 }
3407 
3408 // For use with a SegIndex,SegOffset pair from a checked Mach-O Rebase entry
3409 // to get the section name.
3410 StringRef MachORebaseEntry::sectionName() const {
3411   return O->BindRebaseSectionName(SegmentIndex, SegmentOffset);
3412 }
3413 
3414 // For use with a SegIndex,SegOffset pair from a checked Mach-O Rebase entry
3415 // to get the address.
3416 uint64_t MachORebaseEntry::address() const {
3417   return O->BindRebaseAddress(SegmentIndex, SegmentOffset);
3418 }
3419 
3420 bool MachORebaseEntry::operator==(const MachORebaseEntry &Other) const {
3421 #ifdef EXPENSIVE_CHECKS
3422   assert(Opcodes == Other.Opcodes && "compare iterators of different files");
3423 #else
3424   assert(Opcodes.data() == Other.Opcodes.data() && "compare iterators of different files");
3425 #endif
3426   return (Ptr == Other.Ptr) &&
3427          (RemainingLoopCount == Other.RemainingLoopCount) &&
3428          (Done == Other.Done);
3429 }
3430 
3431 iterator_range<rebase_iterator>
3432 MachOObjectFile::rebaseTable(Error &Err, MachOObjectFile *O,
3433                              ArrayRef<uint8_t> Opcodes, bool is64) {
3434   if (O->BindRebaseSectionTable == nullptr)
3435     O->BindRebaseSectionTable = std::make_unique<BindRebaseSegInfo>(O);
3436   MachORebaseEntry Start(&Err, O, Opcodes, is64);
3437   Start.moveToFirst();
3438 
3439   MachORebaseEntry Finish(&Err, O, Opcodes, is64);
3440   Finish.moveToEnd();
3441 
3442   return make_range(rebase_iterator(Start), rebase_iterator(Finish));
3443 }
3444 
3445 iterator_range<rebase_iterator> MachOObjectFile::rebaseTable(Error &Err) {
3446   return rebaseTable(Err, this, getDyldInfoRebaseOpcodes(), is64Bit());
3447 }
3448 
3449 MachOBindEntry::MachOBindEntry(Error *E, const MachOObjectFile *O,
3450                                ArrayRef<uint8_t> Bytes, bool is64Bit, Kind BK)
3451     : E(E), O(O), Opcodes(Bytes), Ptr(Bytes.begin()),
3452       PointerSize(is64Bit ? 8 : 4), TableKind(BK) {}
3453 
3454 void MachOBindEntry::moveToFirst() {
3455   Ptr = Opcodes.begin();
3456   moveNext();
3457 }
3458 
3459 void MachOBindEntry::moveToEnd() {
3460   Ptr = Opcodes.end();
3461   RemainingLoopCount = 0;
3462   Done = true;
3463 }
3464 
3465 void MachOBindEntry::moveNext() {
3466   ErrorAsOutParameter ErrAsOutParam(E);
3467   // If in the middle of some loop, move to next binding in loop.
3468   SegmentOffset += AdvanceAmount;
3469   if (RemainingLoopCount) {
3470     --RemainingLoopCount;
3471     return;
3472   }
3473   // BIND_OPCODE_DONE is only used for padding if we are not aligned to
3474   // pointer size. Therefore it is possible to reach the end without ever having
3475   // seen BIND_OPCODE_DONE.
3476   if (Ptr == Opcodes.end()) {
3477     Done = true;
3478     return;
3479   }
3480   bool More = true;
3481   while (More) {
3482     // Parse next opcode and set up next loop.
3483     const uint8_t *OpcodeStart = Ptr;
3484     uint8_t Byte = *Ptr++;
3485     uint8_t ImmValue = Byte & MachO::BIND_IMMEDIATE_MASK;
3486     uint8_t Opcode = Byte & MachO::BIND_OPCODE_MASK;
3487     int8_t SignExtended;
3488     const uint8_t *SymStart;
3489     uint32_t Count, Skip;
3490     const char *error = nullptr;
3491     switch (Opcode) {
3492     case MachO::BIND_OPCODE_DONE:
3493       if (TableKind == Kind::Lazy) {
3494         // Lazying bindings have a DONE opcode between entries.  Need to ignore
3495         // it to advance to next entry.  But need not if this is last entry.
3496         bool NotLastEntry = false;
3497         for (const uint8_t *P = Ptr; P < Opcodes.end(); ++P) {
3498           if (*P) {
3499             NotLastEntry = true;
3500           }
3501         }
3502         if (NotLastEntry)
3503           break;
3504       }
3505       More = false;
3506       moveToEnd();
3507       DEBUG_WITH_TYPE("mach-o-bind", dbgs() << "BIND_OPCODE_DONE\n");
3508       break;
3509     case MachO::BIND_OPCODE_SET_DYLIB_ORDINAL_IMM:
3510       if (TableKind == Kind::Weak) {
3511         *E = malformedError("BIND_OPCODE_SET_DYLIB_ORDINAL_IMM not allowed in "
3512                             "weak bind table for opcode at: 0x" +
3513                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3514         moveToEnd();
3515         return;
3516       }
3517       Ordinal = ImmValue;
3518       LibraryOrdinalSet = true;
3519       if (ImmValue > O->getLibraryCount()) {
3520         *E = malformedError("for BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB bad "
3521                             "library ordinal: " +
3522                             Twine((int)ImmValue) + " (max " +
3523                             Twine((int)O->getLibraryCount()) +
3524                             ") for opcode at: 0x" +
3525                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3526         moveToEnd();
3527         return;
3528       }
3529       DEBUG_WITH_TYPE(
3530           "mach-o-bind",
3531           dbgs() << "BIND_OPCODE_SET_DYLIB_ORDINAL_IMM: "
3532                  << "Ordinal=" << Ordinal << "\n");
3533       break;
3534     case MachO::BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB:
3535       if (TableKind == Kind::Weak) {
3536         *E = malformedError("BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB not allowed in "
3537                             "weak bind table for opcode at: 0x" +
3538                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3539         moveToEnd();
3540         return;
3541       }
3542       Ordinal = readULEB128(&error);
3543       LibraryOrdinalSet = true;
3544       if (error) {
3545         *E = malformedError("for BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB " +
3546                             Twine(error) + " for opcode at: 0x" +
3547                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3548         moveToEnd();
3549         return;
3550       }
3551       if (Ordinal > (int)O->getLibraryCount()) {
3552         *E = malformedError("for BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB bad "
3553                             "library ordinal: " +
3554                             Twine((int)Ordinal) + " (max " +
3555                             Twine((int)O->getLibraryCount()) +
3556                             ") for opcode at: 0x" +
3557                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3558         moveToEnd();
3559         return;
3560       }
3561       DEBUG_WITH_TYPE(
3562           "mach-o-bind",
3563           dbgs() << "BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB: "
3564                  << "Ordinal=" << Ordinal << "\n");
3565       break;
3566     case MachO::BIND_OPCODE_SET_DYLIB_SPECIAL_IMM:
3567       if (TableKind == Kind::Weak) {
3568         *E = malformedError("BIND_OPCODE_SET_DYLIB_SPECIAL_IMM not allowed in "
3569                             "weak bind table for opcode at: 0x" +
3570                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3571         moveToEnd();
3572         return;
3573       }
3574       if (ImmValue) {
3575         SignExtended = MachO::BIND_OPCODE_MASK | ImmValue;
3576         Ordinal = SignExtended;
3577         if (Ordinal < MachO::BIND_SPECIAL_DYLIB_FLAT_LOOKUP) {
3578           *E = malformedError("for BIND_OPCODE_SET_DYLIB_SPECIAL_IMM unknown "
3579                               "special ordinal: " +
3580                               Twine((int)Ordinal) + " for opcode at: 0x" +
3581                               Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3582           moveToEnd();
3583           return;
3584         }
3585       } else
3586         Ordinal = 0;
3587       LibraryOrdinalSet = true;
3588       DEBUG_WITH_TYPE(
3589           "mach-o-bind",
3590           dbgs() << "BIND_OPCODE_SET_DYLIB_SPECIAL_IMM: "
3591                  << "Ordinal=" << Ordinal << "\n");
3592       break;
3593     case MachO::BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM:
3594       Flags = ImmValue;
3595       SymStart = Ptr;
3596       while (*Ptr && (Ptr < Opcodes.end())) {
3597         ++Ptr;
3598       }
3599       if (Ptr == Opcodes.end()) {
3600         *E = malformedError(
3601             "for BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM "
3602             "symbol name extends past opcodes for opcode at: 0x" +
3603             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3604         moveToEnd();
3605         return;
3606       }
3607       SymbolName = StringRef(reinterpret_cast<const char*>(SymStart),
3608                              Ptr-SymStart);
3609       ++Ptr;
3610       DEBUG_WITH_TYPE(
3611           "mach-o-bind",
3612           dbgs() << "BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM: "
3613                  << "SymbolName=" << SymbolName << "\n");
3614       if (TableKind == Kind::Weak) {
3615         if (ImmValue & MachO::BIND_SYMBOL_FLAGS_NON_WEAK_DEFINITION)
3616           return;
3617       }
3618       break;
3619     case MachO::BIND_OPCODE_SET_TYPE_IMM:
3620       BindType = ImmValue;
3621       if (ImmValue > MachO::BIND_TYPE_TEXT_PCREL32) {
3622         *E = malformedError("for BIND_OPCODE_SET_TYPE_IMM bad bind type: " +
3623                             Twine((int)ImmValue) + " for opcode at: 0x" +
3624                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3625         moveToEnd();
3626         return;
3627       }
3628       DEBUG_WITH_TYPE(
3629           "mach-o-bind",
3630           dbgs() << "BIND_OPCODE_SET_TYPE_IMM: "
3631                  << "BindType=" << (int)BindType << "\n");
3632       break;
3633     case MachO::BIND_OPCODE_SET_ADDEND_SLEB:
3634       Addend = readSLEB128(&error);
3635       if (error) {
3636         *E = malformedError("for BIND_OPCODE_SET_ADDEND_SLEB " + Twine(error) +
3637                             " for opcode at: 0x" +
3638                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3639         moveToEnd();
3640         return;
3641       }
3642       DEBUG_WITH_TYPE(
3643           "mach-o-bind",
3644           dbgs() << "BIND_OPCODE_SET_ADDEND_SLEB: "
3645                  << "Addend=" << Addend << "\n");
3646       break;
3647     case MachO::BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB:
3648       SegmentIndex = ImmValue;
3649       SegmentOffset = readULEB128(&error);
3650       if (error) {
3651         *E = malformedError("for BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB " +
3652                             Twine(error) + " for opcode at: 0x" +
3653                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3654         moveToEnd();
3655         return;
3656       }
3657       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3658                                              PointerSize);
3659       if (error) {
3660         *E = malformedError("for BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB " +
3661                             Twine(error) + " for opcode at: 0x" +
3662                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3663         moveToEnd();
3664         return;
3665       }
3666       DEBUG_WITH_TYPE(
3667           "mach-o-bind",
3668           dbgs() << "BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB: "
3669                  << "SegmentIndex=" << SegmentIndex << ", "
3670                  << format("SegmentOffset=0x%06X", SegmentOffset)
3671                  << "\n");
3672       break;
3673     case MachO::BIND_OPCODE_ADD_ADDR_ULEB:
3674       SegmentOffset += readULEB128(&error);
3675       if (error) {
3676         *E = malformedError("for BIND_OPCODE_ADD_ADDR_ULEB " + Twine(error) +
3677                             " for opcode at: 0x" +
3678                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3679         moveToEnd();
3680         return;
3681       }
3682       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3683                                              PointerSize);
3684       if (error) {
3685         *E = malformedError("for BIND_OPCODE_ADD_ADDR_ULEB " + Twine(error) +
3686                             " for opcode at: 0x" +
3687                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3688         moveToEnd();
3689         return;
3690       }
3691       DEBUG_WITH_TYPE("mach-o-bind",
3692                       dbgs() << "BIND_OPCODE_ADD_ADDR_ULEB: "
3693                              << format("SegmentOffset=0x%06X",
3694                                        SegmentOffset) << "\n");
3695       break;
3696     case MachO::BIND_OPCODE_DO_BIND:
3697       AdvanceAmount = PointerSize;
3698       RemainingLoopCount = 0;
3699       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3700                                              PointerSize);
3701       if (error) {
3702         *E = malformedError("for BIND_OPCODE_DO_BIND " + Twine(error) +
3703                             " for opcode at: 0x" +
3704                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3705         moveToEnd();
3706         return;
3707       }
3708       if (SymbolName == StringRef()) {
3709         *E = malformedError(
3710             "for BIND_OPCODE_DO_BIND missing preceding "
3711             "BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM for opcode at: 0x" +
3712             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3713         moveToEnd();
3714         return;
3715       }
3716       if (!LibraryOrdinalSet && TableKind != Kind::Weak) {
3717         *E =
3718             malformedError("for BIND_OPCODE_DO_BIND missing preceding "
3719                            "BIND_OPCODE_SET_DYLIB_ORDINAL_* for opcode at: 0x" +
3720                            Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3721         moveToEnd();
3722         return;
3723       }
3724       DEBUG_WITH_TYPE("mach-o-bind",
3725                       dbgs() << "BIND_OPCODE_DO_BIND: "
3726                              << format("SegmentOffset=0x%06X",
3727                                        SegmentOffset) << "\n");
3728       return;
3729      case MachO::BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB:
3730       if (TableKind == Kind::Lazy) {
3731         *E = malformedError("BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB not allowed in "
3732                             "lazy bind table for opcode at: 0x" +
3733                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3734         moveToEnd();
3735         return;
3736       }
3737       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3738                                              PointerSize);
3739       if (error) {
3740         *E = malformedError("for BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB " +
3741                             Twine(error) + " for opcode at: 0x" +
3742                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3743         moveToEnd();
3744         return;
3745       }
3746       if (SymbolName == StringRef()) {
3747         *E = malformedError(
3748             "for BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB missing "
3749             "preceding BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM for opcode "
3750             "at: 0x" +
3751             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3752         moveToEnd();
3753         return;
3754       }
3755       if (!LibraryOrdinalSet && TableKind != Kind::Weak) {
3756         *E = malformedError(
3757             "for BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB missing "
3758             "preceding BIND_OPCODE_SET_DYLIB_ORDINAL_* for opcode at: 0x" +
3759             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3760         moveToEnd();
3761         return;
3762       }
3763       AdvanceAmount = readULEB128(&error) + PointerSize;
3764       if (error) {
3765         *E = malformedError("for BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB " +
3766                             Twine(error) + " for opcode at: 0x" +
3767                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3768         moveToEnd();
3769         return;
3770       }
3771       // Note, this is not really an error until the next bind but make no sense
3772       // for a BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB to not be followed by another
3773       // bind operation.
3774       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset +
3775                                             AdvanceAmount, PointerSize);
3776       if (error) {
3777         *E = malformedError("for BIND_OPCODE_ADD_ADDR_ULEB (after adding "
3778                             "ULEB) " +
3779                             Twine(error) + " for opcode at: 0x" +
3780                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3781         moveToEnd();
3782         return;
3783       }
3784       RemainingLoopCount = 0;
3785       DEBUG_WITH_TYPE(
3786           "mach-o-bind",
3787           dbgs() << "BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB: "
3788                  << format("SegmentOffset=0x%06X", SegmentOffset)
3789                  << ", AdvanceAmount=" << AdvanceAmount
3790                  << ", RemainingLoopCount=" << RemainingLoopCount
3791                  << "\n");
3792       return;
3793     case MachO::BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED:
3794       if (TableKind == Kind::Lazy) {
3795         *E = malformedError("BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED not "
3796                             "allowed in lazy bind table for opcode at: 0x" +
3797                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3798         moveToEnd();
3799         return;
3800       }
3801       if (SymbolName == StringRef()) {
3802         *E = malformedError(
3803             "for BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED "
3804             "missing preceding BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM for "
3805             "opcode at: 0x" +
3806             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3807         moveToEnd();
3808         return;
3809       }
3810       if (!LibraryOrdinalSet && TableKind != Kind::Weak) {
3811         *E = malformedError(
3812             "for BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED "
3813             "missing preceding BIND_OPCODE_SET_DYLIB_ORDINAL_* for opcode "
3814             "at: 0x" +
3815             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3816         moveToEnd();
3817         return;
3818       }
3819       AdvanceAmount = ImmValue * PointerSize + PointerSize;
3820       RemainingLoopCount = 0;
3821       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset +
3822                                              AdvanceAmount, PointerSize);
3823       if (error) {
3824         *E = malformedError("for BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED " +
3825                             Twine(error) + " for opcode at: 0x" +
3826                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3827         moveToEnd();
3828         return;
3829       }
3830       DEBUG_WITH_TYPE("mach-o-bind",
3831                       dbgs()
3832                       << "BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED: "
3833                       << format("SegmentOffset=0x%06X", SegmentOffset) << "\n");
3834       return;
3835     case MachO::BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB:
3836       if (TableKind == Kind::Lazy) {
3837         *E = malformedError("BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB not "
3838                             "allowed in lazy bind table for opcode at: 0x" +
3839                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3840         moveToEnd();
3841         return;
3842       }
3843       Count = readULEB128(&error);
3844       if (Count != 0)
3845         RemainingLoopCount = Count - 1;
3846       else
3847         RemainingLoopCount = 0;
3848       if (error) {
3849         *E = malformedError("for BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB "
3850                             " (count value) " +
3851                             Twine(error) + " for opcode at: 0x" +
3852                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3853         moveToEnd();
3854         return;
3855       }
3856       Skip = readULEB128(&error);
3857       AdvanceAmount = Skip + PointerSize;
3858       if (error) {
3859         *E = malformedError("for BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB "
3860                             " (skip value) " +
3861                             Twine(error) + " for opcode at: 0x" +
3862                             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3863         moveToEnd();
3864         return;
3865       }
3866       if (SymbolName == StringRef()) {
3867         *E = malformedError(
3868             "for BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB "
3869             "missing preceding BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM for "
3870             "opcode at: 0x" +
3871             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3872         moveToEnd();
3873         return;
3874       }
3875       if (!LibraryOrdinalSet && TableKind != Kind::Weak) {
3876         *E = malformedError(
3877             "for BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB "
3878             "missing preceding BIND_OPCODE_SET_DYLIB_ORDINAL_* for opcode "
3879             "at: 0x" +
3880             Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3881         moveToEnd();
3882         return;
3883       }
3884       error = O->BindEntryCheckSegAndOffsets(SegmentIndex, SegmentOffset,
3885                                              PointerSize, Count, Skip);
3886       if (error) {
3887         *E =
3888             malformedError("for BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB " +
3889                            Twine(error) + " for opcode at: 0x" +
3890                            Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3891         moveToEnd();
3892         return;
3893       }
3894       DEBUG_WITH_TYPE(
3895           "mach-o-bind",
3896           dbgs() << "BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB: "
3897                  << format("SegmentOffset=0x%06X", SegmentOffset)
3898                  << ", AdvanceAmount=" << AdvanceAmount
3899                  << ", RemainingLoopCount=" << RemainingLoopCount
3900                  << "\n");
3901       return;
3902     default:
3903       *E = malformedError("bad bind info (bad opcode value 0x" +
3904                           Twine::utohexstr(Opcode) + " for opcode at: 0x" +
3905                           Twine::utohexstr(OpcodeStart - Opcodes.begin()));
3906       moveToEnd();
3907       return;
3908     }
3909   }
3910 }
3911 
3912 uint64_t MachOBindEntry::readULEB128(const char **error) {
3913   unsigned Count;
3914   uint64_t Result = decodeULEB128(Ptr, &Count, Opcodes.end(), error);
3915   Ptr += Count;
3916   if (Ptr > Opcodes.end())
3917     Ptr = Opcodes.end();
3918   return Result;
3919 }
3920 
3921 int64_t MachOBindEntry::readSLEB128(const char **error) {
3922   unsigned Count;
3923   int64_t Result = decodeSLEB128(Ptr, &Count, Opcodes.end(), error);
3924   Ptr += Count;
3925   if (Ptr > Opcodes.end())
3926     Ptr = Opcodes.end();
3927   return Result;
3928 }
3929 
3930 int32_t MachOBindEntry::segmentIndex() const { return SegmentIndex; }
3931 
3932 uint64_t MachOBindEntry::segmentOffset() const { return SegmentOffset; }
3933 
3934 StringRef MachOBindEntry::typeName() const {
3935   switch (BindType) {
3936   case MachO::BIND_TYPE_POINTER:
3937     return "pointer";
3938   case MachO::BIND_TYPE_TEXT_ABSOLUTE32:
3939     return "text abs32";
3940   case MachO::BIND_TYPE_TEXT_PCREL32:
3941     return "text rel32";
3942   }
3943   return "unknown";
3944 }
3945 
3946 StringRef MachOBindEntry::symbolName() const { return SymbolName; }
3947 
3948 int64_t MachOBindEntry::addend() const { return Addend; }
3949 
3950 uint32_t MachOBindEntry::flags() const { return Flags; }
3951 
3952 int MachOBindEntry::ordinal() const { return Ordinal; }
3953 
3954 // For use with the SegIndex of a checked Mach-O Bind entry
3955 // to get the segment name.
3956 StringRef MachOBindEntry::segmentName() const {
3957   return O->BindRebaseSegmentName(SegmentIndex);
3958 }
3959 
3960 // For use with a SegIndex,SegOffset pair from a checked Mach-O Bind entry
3961 // to get the section name.
3962 StringRef MachOBindEntry::sectionName() const {
3963   return O->BindRebaseSectionName(SegmentIndex, SegmentOffset);
3964 }
3965 
3966 // For use with a SegIndex,SegOffset pair from a checked Mach-O Bind entry
3967 // to get the address.
3968 uint64_t MachOBindEntry::address() const {
3969   return O->BindRebaseAddress(SegmentIndex, SegmentOffset);
3970 }
3971 
3972 bool MachOBindEntry::operator==(const MachOBindEntry &Other) const {
3973 #ifdef EXPENSIVE_CHECKS
3974   assert(Opcodes == Other.Opcodes && "compare iterators of different files");
3975 #else
3976   assert(Opcodes.data() == Other.Opcodes.data() && "compare iterators of different files");
3977 #endif
3978   return (Ptr == Other.Ptr) &&
3979          (RemainingLoopCount == Other.RemainingLoopCount) &&
3980          (Done == Other.Done);
3981 }
3982 
3983 // Build table of sections so SegIndex/SegOffset pairs can be translated.
3984 BindRebaseSegInfo::BindRebaseSegInfo(const object::MachOObjectFile *Obj) {
3985   uint32_t CurSegIndex = Obj->hasPageZeroSegment() ? 1 : 0;
3986   StringRef CurSegName;
3987   uint64_t CurSegAddress;
3988   for (const SectionRef &Section : Obj->sections()) {
3989     SectionInfo Info;
3990     Expected<StringRef> NameOrErr = Section.getName();
3991     if (!NameOrErr)
3992       consumeError(NameOrErr.takeError());
3993     else
3994       Info.SectionName = *NameOrErr;
3995     Info.Address = Section.getAddress();
3996     Info.Size = Section.getSize();
3997     Info.SegmentName =
3998         Obj->getSectionFinalSegmentName(Section.getRawDataRefImpl());
3999     if (!Info.SegmentName.equals(CurSegName)) {
4000       ++CurSegIndex;
4001       CurSegName = Info.SegmentName;
4002       CurSegAddress = Info.Address;
4003     }
4004     Info.SegmentIndex = CurSegIndex - 1;
4005     Info.OffsetInSegment = Info.Address - CurSegAddress;
4006     Info.SegmentStartAddress = CurSegAddress;
4007     Sections.push_back(Info);
4008   }
4009   MaxSegIndex = CurSegIndex;
4010 }
4011 
4012 // For use with a SegIndex, SegOffset, and PointerSize triple in
4013 // MachOBindEntry::moveNext() to validate a MachOBindEntry or MachORebaseEntry.
4014 //
4015 // Given a SegIndex, SegOffset, and PointerSize, verify a valid section exists
4016 // that fully contains a pointer at that location. Multiple fixups in a bind
4017 // (such as with the BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB opcode) can
4018 // be tested via the Count and Skip parameters.
4019 const char * BindRebaseSegInfo::checkSegAndOffsets(int32_t SegIndex,
4020                                                    uint64_t SegOffset,
4021                                                    uint8_t PointerSize,
4022                                                    uint32_t Count,
4023                                                    uint32_t Skip) {
4024   if (SegIndex == -1)
4025     return "missing preceding *_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB";
4026   if (SegIndex >= MaxSegIndex)
4027     return "bad segIndex (too large)";
4028   for (uint32_t i = 0; i < Count; ++i) {
4029     uint32_t Start = SegOffset + i * (PointerSize + Skip);
4030     uint32_t End = Start + PointerSize;
4031     bool Found = false;
4032     for (const SectionInfo &SI : Sections) {
4033       if (SI.SegmentIndex != SegIndex)
4034         continue;
4035       if ((SI.OffsetInSegment<=Start) && (Start<(SI.OffsetInSegment+SI.Size))) {
4036         if (End <= SI.OffsetInSegment + SI.Size) {
4037           Found = true;
4038           break;
4039         }
4040         else
4041           return "bad offset, extends beyond section boundary";
4042       }
4043     }
4044     if (!Found)
4045       return "bad offset, not in section";
4046   }
4047   return nullptr;
4048 }
4049 
4050 // For use with the SegIndex of a checked Mach-O Bind or Rebase entry
4051 // to get the segment name.
4052 StringRef BindRebaseSegInfo::segmentName(int32_t SegIndex) {
4053   for (const SectionInfo &SI : Sections) {
4054     if (SI.SegmentIndex == SegIndex)
4055       return SI.SegmentName;
4056   }
4057   llvm_unreachable("invalid SegIndex");
4058 }
4059 
4060 // For use with a SegIndex,SegOffset pair from a checked Mach-O Bind or Rebase
4061 // to get the SectionInfo.
4062 const BindRebaseSegInfo::SectionInfo &BindRebaseSegInfo::findSection(
4063                                      int32_t SegIndex, uint64_t SegOffset) {
4064   for (const SectionInfo &SI : Sections) {
4065     if (SI.SegmentIndex != SegIndex)
4066       continue;
4067     if (SI.OffsetInSegment > SegOffset)
4068       continue;
4069     if (SegOffset >= (SI.OffsetInSegment + SI.Size))
4070       continue;
4071     return SI;
4072   }
4073   llvm_unreachable("SegIndex and SegOffset not in any section");
4074 }
4075 
4076 // For use with a SegIndex,SegOffset pair from a checked Mach-O Bind or Rebase
4077 // entry to get the section name.
4078 StringRef BindRebaseSegInfo::sectionName(int32_t SegIndex,
4079                                          uint64_t SegOffset) {
4080   return findSection(SegIndex, SegOffset).SectionName;
4081 }
4082 
4083 // For use with a SegIndex,SegOffset pair from a checked Mach-O Bind or Rebase
4084 // entry to get the address.
4085 uint64_t BindRebaseSegInfo::address(uint32_t SegIndex, uint64_t OffsetInSeg) {
4086   const SectionInfo &SI = findSection(SegIndex, OffsetInSeg);
4087   return SI.SegmentStartAddress + OffsetInSeg;
4088 }
4089 
4090 iterator_range<bind_iterator>
4091 MachOObjectFile::bindTable(Error &Err, MachOObjectFile *O,
4092                            ArrayRef<uint8_t> Opcodes, bool is64,
4093                            MachOBindEntry::Kind BKind) {
4094   if (O->BindRebaseSectionTable == nullptr)
4095     O->BindRebaseSectionTable = std::make_unique<BindRebaseSegInfo>(O);
4096   MachOBindEntry Start(&Err, O, Opcodes, is64, BKind);
4097   Start.moveToFirst();
4098 
4099   MachOBindEntry Finish(&Err, O, Opcodes, is64, BKind);
4100   Finish.moveToEnd();
4101 
4102   return make_range(bind_iterator(Start), bind_iterator(Finish));
4103 }
4104 
4105 iterator_range<bind_iterator> MachOObjectFile::bindTable(Error &Err) {
4106   return bindTable(Err, this, getDyldInfoBindOpcodes(), is64Bit(),
4107                    MachOBindEntry::Kind::Regular);
4108 }
4109 
4110 iterator_range<bind_iterator> MachOObjectFile::lazyBindTable(Error &Err) {
4111   return bindTable(Err, this, getDyldInfoLazyBindOpcodes(), is64Bit(),
4112                    MachOBindEntry::Kind::Lazy);
4113 }
4114 
4115 iterator_range<bind_iterator> MachOObjectFile::weakBindTable(Error &Err) {
4116   return bindTable(Err, this, getDyldInfoWeakBindOpcodes(), is64Bit(),
4117                    MachOBindEntry::Kind::Weak);
4118 }
4119 
4120 MachOObjectFile::load_command_iterator
4121 MachOObjectFile::begin_load_commands() const {
4122   return LoadCommands.begin();
4123 }
4124 
4125 MachOObjectFile::load_command_iterator
4126 MachOObjectFile::end_load_commands() const {
4127   return LoadCommands.end();
4128 }
4129 
4130 iterator_range<MachOObjectFile::load_command_iterator>
4131 MachOObjectFile::load_commands() const {
4132   return make_range(begin_load_commands(), end_load_commands());
4133 }
4134 
4135 StringRef
4136 MachOObjectFile::getSectionFinalSegmentName(DataRefImpl Sec) const {
4137   ArrayRef<char> Raw = getSectionRawFinalSegmentName(Sec);
4138   return parseSegmentOrSectionName(Raw.data());
4139 }
4140 
4141 ArrayRef<char>
4142 MachOObjectFile::getSectionRawName(DataRefImpl Sec) const {
4143   assert(Sec.d.a < Sections.size() && "Should have detected this earlier");
4144   const section_base *Base =
4145     reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
4146   return makeArrayRef(Base->sectname);
4147 }
4148 
4149 ArrayRef<char>
4150 MachOObjectFile::getSectionRawFinalSegmentName(DataRefImpl Sec) const {
4151   assert(Sec.d.a < Sections.size() && "Should have detected this earlier");
4152   const section_base *Base =
4153     reinterpret_cast<const section_base *>(Sections[Sec.d.a]);
4154   return makeArrayRef(Base->segname);
4155 }
4156 
4157 bool
4158 MachOObjectFile::isRelocationScattered(const MachO::any_relocation_info &RE)
4159   const {
4160   if (getCPUType(*this) == MachO::CPU_TYPE_X86_64)
4161     return false;
4162   return getPlainRelocationAddress(RE) & MachO::R_SCATTERED;
4163 }
4164 
4165 unsigned MachOObjectFile::getPlainRelocationSymbolNum(
4166     const MachO::any_relocation_info &RE) const {
4167   if (isLittleEndian())
4168     return RE.r_word1 & 0xffffff;
4169   return RE.r_word1 >> 8;
4170 }
4171 
4172 bool MachOObjectFile::getPlainRelocationExternal(
4173     const MachO::any_relocation_info &RE) const {
4174   if (isLittleEndian())
4175     return (RE.r_word1 >> 27) & 1;
4176   return (RE.r_word1 >> 4) & 1;
4177 }
4178 
4179 bool MachOObjectFile::getScatteredRelocationScattered(
4180     const MachO::any_relocation_info &RE) const {
4181   return RE.r_word0 >> 31;
4182 }
4183 
4184 uint32_t MachOObjectFile::getScatteredRelocationValue(
4185     const MachO::any_relocation_info &RE) const {
4186   return RE.r_word1;
4187 }
4188 
4189 uint32_t MachOObjectFile::getScatteredRelocationType(
4190     const MachO::any_relocation_info &RE) const {
4191   return (RE.r_word0 >> 24) & 0xf;
4192 }
4193 
4194 unsigned MachOObjectFile::getAnyRelocationAddress(
4195     const MachO::any_relocation_info &RE) const {
4196   if (isRelocationScattered(RE))
4197     return getScatteredRelocationAddress(RE);
4198   return getPlainRelocationAddress(RE);
4199 }
4200 
4201 unsigned MachOObjectFile::getAnyRelocationPCRel(
4202     const MachO::any_relocation_info &RE) const {
4203   if (isRelocationScattered(RE))
4204     return getScatteredRelocationPCRel(RE);
4205   return getPlainRelocationPCRel(*this, RE);
4206 }
4207 
4208 unsigned MachOObjectFile::getAnyRelocationLength(
4209     const MachO::any_relocation_info &RE) const {
4210   if (isRelocationScattered(RE))
4211     return getScatteredRelocationLength(RE);
4212   return getPlainRelocationLength(*this, RE);
4213 }
4214 
4215 unsigned
4216 MachOObjectFile::getAnyRelocationType(
4217                                    const MachO::any_relocation_info &RE) const {
4218   if (isRelocationScattered(RE))
4219     return getScatteredRelocationType(RE);
4220   return getPlainRelocationType(*this, RE);
4221 }
4222 
4223 SectionRef
4224 MachOObjectFile::getAnyRelocationSection(
4225                                    const MachO::any_relocation_info &RE) const {
4226   if (isRelocationScattered(RE) || getPlainRelocationExternal(RE))
4227     return *section_end();
4228   unsigned SecNum = getPlainRelocationSymbolNum(RE);
4229   if (SecNum == MachO::R_ABS || SecNum > Sections.size())
4230     return *section_end();
4231   DataRefImpl DRI;
4232   DRI.d.a = SecNum - 1;
4233   return SectionRef(DRI, this);
4234 }
4235 
4236 MachO::section MachOObjectFile::getSection(DataRefImpl DRI) const {
4237   assert(DRI.d.a < Sections.size() && "Should have detected this earlier");
4238   return getStruct<MachO::section>(*this, Sections[DRI.d.a]);
4239 }
4240 
4241 MachO::section_64 MachOObjectFile::getSection64(DataRefImpl DRI) const {
4242   assert(DRI.d.a < Sections.size() && "Should have detected this earlier");
4243   return getStruct<MachO::section_64>(*this, Sections[DRI.d.a]);
4244 }
4245 
4246 MachO::section MachOObjectFile::getSection(const LoadCommandInfo &L,
4247                                            unsigned Index) const {
4248   const char *Sec = getSectionPtr(*this, L, Index);
4249   return getStruct<MachO::section>(*this, Sec);
4250 }
4251 
4252 MachO::section_64 MachOObjectFile::getSection64(const LoadCommandInfo &L,
4253                                                 unsigned Index) const {
4254   const char *Sec = getSectionPtr(*this, L, Index);
4255   return getStruct<MachO::section_64>(*this, Sec);
4256 }
4257 
4258 MachO::nlist
4259 MachOObjectFile::getSymbolTableEntry(DataRefImpl DRI) const {
4260   const char *P = reinterpret_cast<const char *>(DRI.p);
4261   return getStruct<MachO::nlist>(*this, P);
4262 }
4263 
4264 MachO::nlist_64
4265 MachOObjectFile::getSymbol64TableEntry(DataRefImpl DRI) const {
4266   const char *P = reinterpret_cast<const char *>(DRI.p);
4267   return getStruct<MachO::nlist_64>(*this, P);
4268 }
4269 
4270 MachO::linkedit_data_command
4271 MachOObjectFile::getLinkeditDataLoadCommand(const LoadCommandInfo &L) const {
4272   return getStruct<MachO::linkedit_data_command>(*this, L.Ptr);
4273 }
4274 
4275 MachO::segment_command
4276 MachOObjectFile::getSegmentLoadCommand(const LoadCommandInfo &L) const {
4277   return getStruct<MachO::segment_command>(*this, L.Ptr);
4278 }
4279 
4280 MachO::segment_command_64
4281 MachOObjectFile::getSegment64LoadCommand(const LoadCommandInfo &L) const {
4282   return getStruct<MachO::segment_command_64>(*this, L.Ptr);
4283 }
4284 
4285 MachO::linker_option_command
4286 MachOObjectFile::getLinkerOptionLoadCommand(const LoadCommandInfo &L) const {
4287   return getStruct<MachO::linker_option_command>(*this, L.Ptr);
4288 }
4289 
4290 MachO::version_min_command
4291 MachOObjectFile::getVersionMinLoadCommand(const LoadCommandInfo &L) const {
4292   return getStruct<MachO::version_min_command>(*this, L.Ptr);
4293 }
4294 
4295 MachO::note_command
4296 MachOObjectFile::getNoteLoadCommand(const LoadCommandInfo &L) const {
4297   return getStruct<MachO::note_command>(*this, L.Ptr);
4298 }
4299 
4300 MachO::build_version_command
4301 MachOObjectFile::getBuildVersionLoadCommand(const LoadCommandInfo &L) const {
4302   return getStruct<MachO::build_version_command>(*this, L.Ptr);
4303 }
4304 
4305 MachO::build_tool_version
4306 MachOObjectFile::getBuildToolVersion(unsigned index) const {
4307   return getStruct<MachO::build_tool_version>(*this, BuildTools[index]);
4308 }
4309 
4310 MachO::dylib_command
4311 MachOObjectFile::getDylibIDLoadCommand(const LoadCommandInfo &L) const {
4312   return getStruct<MachO::dylib_command>(*this, L.Ptr);
4313 }
4314 
4315 MachO::dyld_info_command
4316 MachOObjectFile::getDyldInfoLoadCommand(const LoadCommandInfo &L) const {
4317   return getStruct<MachO::dyld_info_command>(*this, L.Ptr);
4318 }
4319 
4320 MachO::dylinker_command
4321 MachOObjectFile::getDylinkerCommand(const LoadCommandInfo &L) const {
4322   return getStruct<MachO::dylinker_command>(*this, L.Ptr);
4323 }
4324 
4325 MachO::uuid_command
4326 MachOObjectFile::getUuidCommand(const LoadCommandInfo &L) const {
4327   return getStruct<MachO::uuid_command>(*this, L.Ptr);
4328 }
4329 
4330 MachO::rpath_command
4331 MachOObjectFile::getRpathCommand(const LoadCommandInfo &L) const {
4332   return getStruct<MachO::rpath_command>(*this, L.Ptr);
4333 }
4334 
4335 MachO::source_version_command
4336 MachOObjectFile::getSourceVersionCommand(const LoadCommandInfo &L) const {
4337   return getStruct<MachO::source_version_command>(*this, L.Ptr);
4338 }
4339 
4340 MachO::entry_point_command
4341 MachOObjectFile::getEntryPointCommand(const LoadCommandInfo &L) const {
4342   return getStruct<MachO::entry_point_command>(*this, L.Ptr);
4343 }
4344 
4345 MachO::encryption_info_command
4346 MachOObjectFile::getEncryptionInfoCommand(const LoadCommandInfo &L) const {
4347   return getStruct<MachO::encryption_info_command>(*this, L.Ptr);
4348 }
4349 
4350 MachO::encryption_info_command_64
4351 MachOObjectFile::getEncryptionInfoCommand64(const LoadCommandInfo &L) const {
4352   return getStruct<MachO::encryption_info_command_64>(*this, L.Ptr);
4353 }
4354 
4355 MachO::sub_framework_command
4356 MachOObjectFile::getSubFrameworkCommand(const LoadCommandInfo &L) const {
4357   return getStruct<MachO::sub_framework_command>(*this, L.Ptr);
4358 }
4359 
4360 MachO::sub_umbrella_command
4361 MachOObjectFile::getSubUmbrellaCommand(const LoadCommandInfo &L) const {
4362   return getStruct<MachO::sub_umbrella_command>(*this, L.Ptr);
4363 }
4364 
4365 MachO::sub_library_command
4366 MachOObjectFile::getSubLibraryCommand(const LoadCommandInfo &L) const {
4367   return getStruct<MachO::sub_library_command>(*this, L.Ptr);
4368 }
4369 
4370 MachO::sub_client_command
4371 MachOObjectFile::getSubClientCommand(const LoadCommandInfo &L) const {
4372   return getStruct<MachO::sub_client_command>(*this, L.Ptr);
4373 }
4374 
4375 MachO::routines_command
4376 MachOObjectFile::getRoutinesCommand(const LoadCommandInfo &L) const {
4377   return getStruct<MachO::routines_command>(*this, L.Ptr);
4378 }
4379 
4380 MachO::routines_command_64
4381 MachOObjectFile::getRoutinesCommand64(const LoadCommandInfo &L) const {
4382   return getStruct<MachO::routines_command_64>(*this, L.Ptr);
4383 }
4384 
4385 MachO::thread_command
4386 MachOObjectFile::getThreadCommand(const LoadCommandInfo &L) const {
4387   return getStruct<MachO::thread_command>(*this, L.Ptr);
4388 }
4389 
4390 MachO::any_relocation_info
4391 MachOObjectFile::getRelocation(DataRefImpl Rel) const {
4392   uint32_t Offset;
4393   if (getHeader().filetype == MachO::MH_OBJECT) {
4394     DataRefImpl Sec;
4395     Sec.d.a = Rel.d.a;
4396     if (is64Bit()) {
4397       MachO::section_64 Sect = getSection64(Sec);
4398       Offset = Sect.reloff;
4399     } else {
4400       MachO::section Sect = getSection(Sec);
4401       Offset = Sect.reloff;
4402     }
4403   } else {
4404     MachO::dysymtab_command DysymtabLoadCmd = getDysymtabLoadCommand();
4405     if (Rel.d.a == 0)
4406       Offset = DysymtabLoadCmd.extreloff; // Offset to the external relocations
4407     else
4408       Offset = DysymtabLoadCmd.locreloff; // Offset to the local relocations
4409   }
4410 
4411   auto P = reinterpret_cast<const MachO::any_relocation_info *>(
4412       getPtr(*this, Offset)) + Rel.d.b;
4413   return getStruct<MachO::any_relocation_info>(
4414       *this, reinterpret_cast<const char *>(P));
4415 }
4416 
4417 MachO::data_in_code_entry
4418 MachOObjectFile::getDice(DataRefImpl Rel) const {
4419   const char *P = reinterpret_cast<const char *>(Rel.p);
4420   return getStruct<MachO::data_in_code_entry>(*this, P);
4421 }
4422 
4423 const MachO::mach_header &MachOObjectFile::getHeader() const {
4424   return Header;
4425 }
4426 
4427 const MachO::mach_header_64 &MachOObjectFile::getHeader64() const {
4428   assert(is64Bit());
4429   return Header64;
4430 }
4431 
4432 uint32_t MachOObjectFile::getIndirectSymbolTableEntry(
4433                                              const MachO::dysymtab_command &DLC,
4434                                              unsigned Index) const {
4435   uint64_t Offset = DLC.indirectsymoff + Index * sizeof(uint32_t);
4436   return getStruct<uint32_t>(*this, getPtr(*this, Offset));
4437 }
4438 
4439 MachO::data_in_code_entry
4440 MachOObjectFile::getDataInCodeTableEntry(uint32_t DataOffset,
4441                                          unsigned Index) const {
4442   uint64_t Offset = DataOffset + Index * sizeof(MachO::data_in_code_entry);
4443   return getStruct<MachO::data_in_code_entry>(*this, getPtr(*this, Offset));
4444 }
4445 
4446 MachO::symtab_command MachOObjectFile::getSymtabLoadCommand() const {
4447   if (SymtabLoadCmd)
4448     return getStruct<MachO::symtab_command>(*this, SymtabLoadCmd);
4449 
4450   // If there is no SymtabLoadCmd return a load command with zero'ed fields.
4451   MachO::symtab_command Cmd;
4452   Cmd.cmd = MachO::LC_SYMTAB;
4453   Cmd.cmdsize = sizeof(MachO::symtab_command);
4454   Cmd.symoff = 0;
4455   Cmd.nsyms = 0;
4456   Cmd.stroff = 0;
4457   Cmd.strsize = 0;
4458   return Cmd;
4459 }
4460 
4461 MachO::dysymtab_command MachOObjectFile::getDysymtabLoadCommand() const {
4462   if (DysymtabLoadCmd)
4463     return getStruct<MachO::dysymtab_command>(*this, DysymtabLoadCmd);
4464 
4465   // If there is no DysymtabLoadCmd return a load command with zero'ed fields.
4466   MachO::dysymtab_command Cmd;
4467   Cmd.cmd = MachO::LC_DYSYMTAB;
4468   Cmd.cmdsize = sizeof(MachO::dysymtab_command);
4469   Cmd.ilocalsym = 0;
4470   Cmd.nlocalsym = 0;
4471   Cmd.iextdefsym = 0;
4472   Cmd.nextdefsym = 0;
4473   Cmd.iundefsym = 0;
4474   Cmd.nundefsym = 0;
4475   Cmd.tocoff = 0;
4476   Cmd.ntoc = 0;
4477   Cmd.modtaboff = 0;
4478   Cmd.nmodtab = 0;
4479   Cmd.extrefsymoff = 0;
4480   Cmd.nextrefsyms = 0;
4481   Cmd.indirectsymoff = 0;
4482   Cmd.nindirectsyms = 0;
4483   Cmd.extreloff = 0;
4484   Cmd.nextrel = 0;
4485   Cmd.locreloff = 0;
4486   Cmd.nlocrel = 0;
4487   return Cmd;
4488 }
4489 
4490 MachO::linkedit_data_command
4491 MachOObjectFile::getDataInCodeLoadCommand() const {
4492   if (DataInCodeLoadCmd)
4493     return getStruct<MachO::linkedit_data_command>(*this, DataInCodeLoadCmd);
4494 
4495   // If there is no DataInCodeLoadCmd return a load command with zero'ed fields.
4496   MachO::linkedit_data_command Cmd;
4497   Cmd.cmd = MachO::LC_DATA_IN_CODE;
4498   Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
4499   Cmd.dataoff = 0;
4500   Cmd.datasize = 0;
4501   return Cmd;
4502 }
4503 
4504 MachO::linkedit_data_command
4505 MachOObjectFile::getLinkOptHintsLoadCommand() const {
4506   if (LinkOptHintsLoadCmd)
4507     return getStruct<MachO::linkedit_data_command>(*this, LinkOptHintsLoadCmd);
4508 
4509   // If there is no LinkOptHintsLoadCmd return a load command with zero'ed
4510   // fields.
4511   MachO::linkedit_data_command Cmd;
4512   Cmd.cmd = MachO::LC_LINKER_OPTIMIZATION_HINT;
4513   Cmd.cmdsize = sizeof(MachO::linkedit_data_command);
4514   Cmd.dataoff = 0;
4515   Cmd.datasize = 0;
4516   return Cmd;
4517 }
4518 
4519 ArrayRef<uint8_t> MachOObjectFile::getDyldInfoRebaseOpcodes() const {
4520   if (!DyldInfoLoadCmd)
4521     return None;
4522 
4523   auto DyldInfoOrErr =
4524     getStructOrErr<MachO::dyld_info_command>(*this, DyldInfoLoadCmd);
4525   if (!DyldInfoOrErr)
4526     return None;
4527   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
4528   const uint8_t *Ptr =
4529       reinterpret_cast<const uint8_t *>(getPtr(*this, DyldInfo.rebase_off));
4530   return makeArrayRef(Ptr, DyldInfo.rebase_size);
4531 }
4532 
4533 ArrayRef<uint8_t> MachOObjectFile::getDyldInfoBindOpcodes() const {
4534   if (!DyldInfoLoadCmd)
4535     return None;
4536 
4537   auto DyldInfoOrErr =
4538     getStructOrErr<MachO::dyld_info_command>(*this, DyldInfoLoadCmd);
4539   if (!DyldInfoOrErr)
4540     return None;
4541   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
4542   const uint8_t *Ptr =
4543       reinterpret_cast<const uint8_t *>(getPtr(*this, DyldInfo.bind_off));
4544   return makeArrayRef(Ptr, DyldInfo.bind_size);
4545 }
4546 
4547 ArrayRef<uint8_t> MachOObjectFile::getDyldInfoWeakBindOpcodes() const {
4548   if (!DyldInfoLoadCmd)
4549     return None;
4550 
4551   auto DyldInfoOrErr =
4552     getStructOrErr<MachO::dyld_info_command>(*this, DyldInfoLoadCmd);
4553   if (!DyldInfoOrErr)
4554     return None;
4555   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
4556   const uint8_t *Ptr =
4557       reinterpret_cast<const uint8_t *>(getPtr(*this, DyldInfo.weak_bind_off));
4558   return makeArrayRef(Ptr, DyldInfo.weak_bind_size);
4559 }
4560 
4561 ArrayRef<uint8_t> MachOObjectFile::getDyldInfoLazyBindOpcodes() const {
4562   if (!DyldInfoLoadCmd)
4563     return None;
4564 
4565   auto DyldInfoOrErr =
4566     getStructOrErr<MachO::dyld_info_command>(*this, DyldInfoLoadCmd);
4567   if (!DyldInfoOrErr)
4568     return None;
4569   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
4570   const uint8_t *Ptr =
4571       reinterpret_cast<const uint8_t *>(getPtr(*this, DyldInfo.lazy_bind_off));
4572   return makeArrayRef(Ptr, DyldInfo.lazy_bind_size);
4573 }
4574 
4575 ArrayRef<uint8_t> MachOObjectFile::getDyldInfoExportsTrie() const {
4576   if (!DyldInfoLoadCmd)
4577     return None;
4578 
4579   auto DyldInfoOrErr =
4580     getStructOrErr<MachO::dyld_info_command>(*this, DyldInfoLoadCmd);
4581   if (!DyldInfoOrErr)
4582     return None;
4583   MachO::dyld_info_command DyldInfo = DyldInfoOrErr.get();
4584   const uint8_t *Ptr =
4585       reinterpret_cast<const uint8_t *>(getPtr(*this, DyldInfo.export_off));
4586   return makeArrayRef(Ptr, DyldInfo.export_size);
4587 }
4588 
4589 ArrayRef<uint8_t> MachOObjectFile::getUuid() const {
4590   if (!UuidLoadCmd)
4591     return None;
4592   // Returning a pointer is fine as uuid doesn't need endian swapping.
4593   const char *Ptr = UuidLoadCmd + offsetof(MachO::uuid_command, uuid);
4594   return makeArrayRef(reinterpret_cast<const uint8_t *>(Ptr), 16);
4595 }
4596 
4597 StringRef MachOObjectFile::getStringTableData() const {
4598   MachO::symtab_command S = getSymtabLoadCommand();
4599   return getData().substr(S.stroff, S.strsize);
4600 }
4601 
4602 bool MachOObjectFile::is64Bit() const {
4603   return getType() == getMachOType(false, true) ||
4604     getType() == getMachOType(true, true);
4605 }
4606 
4607 void MachOObjectFile::ReadULEB128s(uint64_t Index,
4608                                    SmallVectorImpl<uint64_t> &Out) const {
4609   DataExtractor extractor(ObjectFile::getData(), true, 0);
4610 
4611   uint64_t offset = Index;
4612   uint64_t data = 0;
4613   while (uint64_t delta = extractor.getULEB128(&offset)) {
4614     data += delta;
4615     Out.push_back(data);
4616   }
4617 }
4618 
4619 bool MachOObjectFile::isRelocatableObject() const {
4620   return getHeader().filetype == MachO::MH_OBJECT;
4621 }
4622 
4623 Expected<std::unique_ptr<MachOObjectFile>>
4624 ObjectFile::createMachOObjectFile(MemoryBufferRef Buffer,
4625                                   uint32_t UniversalCputype,
4626                                   uint32_t UniversalIndex) {
4627   StringRef Magic = Buffer.getBuffer().slice(0, 4);
4628   if (Magic == "\xFE\xED\xFA\xCE")
4629     return MachOObjectFile::create(Buffer, false, false,
4630                                    UniversalCputype, UniversalIndex);
4631   if (Magic == "\xCE\xFA\xED\xFE")
4632     return MachOObjectFile::create(Buffer, true, false,
4633                                    UniversalCputype, UniversalIndex);
4634   if (Magic == "\xFE\xED\xFA\xCF")
4635     return MachOObjectFile::create(Buffer, false, true,
4636                                    UniversalCputype, UniversalIndex);
4637   if (Magic == "\xCF\xFA\xED\xFE")
4638     return MachOObjectFile::create(Buffer, true, true,
4639                                    UniversalCputype, UniversalIndex);
4640   return make_error<GenericBinaryError>("Unrecognized MachO magic number",
4641                                         object_error::invalid_file_type);
4642 }
4643 
4644 StringRef MachOObjectFile::mapDebugSectionName(StringRef Name) const {
4645   return StringSwitch<StringRef>(Name)
4646       .Case("debug_str_offs", "debug_str_offsets")
4647       .Default(Name);
4648 }
4649