C++ style comments
[oota-llvm.git] / include / llvm / Support / MachO.h
1 //===-- llvm/Support/MachO.h - The MachO file format ------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines manifest constants for the MachO object file format.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_SUPPORT_MACHO_H
15 #define LLVM_SUPPORT_MACHO_H
16
17 #include "llvm/Support/Compiler.h"
18 #include "llvm/Support/DataTypes.h"
19 #include "llvm/Support/Host.h"
20
21 namespace llvm {
22   namespace MachO {
23     // Enums from <mach-o/loader.h>
24     enum : uint32_t {
25       // Constants for the "magic" field in llvm::MachO::mach_header and
26       // llvm::MachO::mach_header_64
27       MH_MAGIC    = 0xFEEDFACEu,
28       MH_CIGAM    = 0xCEFAEDFEu,
29       MH_MAGIC_64 = 0xFEEDFACFu,
30       MH_CIGAM_64 = 0xCFFAEDFEu,
31       FAT_MAGIC   = 0xCAFEBABEu,
32       FAT_CIGAM   = 0xBEBAFECAu
33     };
34
35     enum HeaderFileType {
36       // Constants for the "filetype" field in llvm::MachO::mach_header and
37       // llvm::MachO::mach_header_64
38       MH_OBJECT      = 0x1u,
39       MH_EXECUTE     = 0x2u,
40       MH_FVMLIB      = 0x3u,
41       MH_CORE        = 0x4u,
42       MH_PRELOAD     = 0x5u,
43       MH_DYLIB       = 0x6u,
44       MH_DYLINKER    = 0x7u,
45       MH_BUNDLE      = 0x8u,
46       MH_DYLIB_STUB  = 0x9u,
47       MH_DSYM        = 0xAu,
48       MH_KEXT_BUNDLE = 0xBu
49     };
50
51     enum {
52       // Constant bits for the "flags" field in llvm::MachO::mach_header and
53       // llvm::MachO::mach_header_64
54       MH_NOUNDEFS                = 0x00000001u,
55       MH_INCRLINK                = 0x00000002u,
56       MH_DYLDLINK                = 0x00000004u,
57       MH_BINDATLOAD              = 0x00000008u,
58       MH_PREBOUND                = 0x00000010u,
59       MH_SPLIT_SEGS              = 0x00000020u,
60       MH_LAZY_INIT               = 0x00000040u,
61       MH_TWOLEVEL                = 0x00000080u,
62       MH_FORCE_FLAT              = 0x00000100u,
63       MH_NOMULTIDEFS             = 0x00000200u,
64       MH_NOFIXPREBINDING         = 0x00000400u,
65       MH_PREBINDABLE             = 0x00000800u,
66       MH_ALLMODSBOUND            = 0x00001000u,
67       MH_SUBSECTIONS_VIA_SYMBOLS = 0x00002000u,
68       MH_CANONICAL               = 0x00004000u,
69       MH_WEAK_DEFINES            = 0x00008000u,
70       MH_BINDS_TO_WEAK           = 0x00010000u,
71       MH_ALLOW_STACK_EXECUTION   = 0x00020000u,
72       MH_ROOT_SAFE               = 0x00040000u,
73       MH_SETUID_SAFE             = 0x00080000u,
74       MH_NO_REEXPORTED_DYLIBS    = 0x00100000u,
75       MH_PIE                     = 0x00200000u,
76       MH_DEAD_STRIPPABLE_DYLIB   = 0x00400000u
77     };
78
79     enum : uint32_t {
80       // Flags for the "cmd" field in llvm::MachO::load_command
81       LC_REQ_DYLD    = 0x80000000u
82     };
83
84     enum LoadCommandType : uint32_t {
85       // Constants for the "cmd" field in llvm::MachO::load_command
86       LC_SEGMENT              = 0x00000001u,
87       LC_SYMTAB               = 0x00000002u,
88       LC_SYMSEG               = 0x00000003u,
89       LC_THREAD               = 0x00000004u,
90       LC_UNIXTHREAD           = 0x00000005u,
91       LC_LOADFVMLIB           = 0x00000006u,
92       LC_IDFVMLIB             = 0x00000007u,
93       LC_IDENT                = 0x00000008u,
94       LC_FVMFILE              = 0x00000009u,
95       LC_PREPAGE              = 0x0000000Au,
96       LC_DYSYMTAB             = 0x0000000Bu,
97       LC_LOAD_DYLIB           = 0x0000000Cu,
98       LC_ID_DYLIB             = 0x0000000Du,
99       LC_LOAD_DYLINKER        = 0x0000000Eu,
100       LC_ID_DYLINKER          = 0x0000000Fu,
101       LC_PREBOUND_DYLIB       = 0x00000010u,
102       LC_ROUTINES             = 0x00000011u,
103       LC_SUB_FRAMEWORK        = 0x00000012u,
104       LC_SUB_UMBRELLA         = 0x00000013u,
105       LC_SUB_CLIENT           = 0x00000014u,
106       LC_SUB_LIBRARY          = 0x00000015u,
107       LC_TWOLEVEL_HINTS       = 0x00000016u,
108       LC_PREBIND_CKSUM        = 0x00000017u,
109       LC_LOAD_WEAK_DYLIB      = 0x80000018u,
110       LC_SEGMENT_64           = 0x00000019u,
111       LC_ROUTINES_64          = 0x0000001Au,
112       LC_UUID                 = 0x0000001Bu,
113       LC_RPATH                = 0x8000001Cu,
114       LC_CODE_SIGNATURE       = 0x0000001Du,
115       LC_SEGMENT_SPLIT_INFO   = 0x0000001Eu,
116       LC_REEXPORT_DYLIB       = 0x8000001Fu,
117       LC_LAZY_LOAD_DYLIB      = 0x00000020u,
118       LC_ENCRYPTION_INFO      = 0x00000021u,
119       LC_DYLD_INFO            = 0x00000022u,
120       LC_DYLD_INFO_ONLY       = 0x80000022u,
121       LC_LOAD_UPWARD_DYLIB    = 0x80000023u,
122       LC_VERSION_MIN_MACOSX   = 0x00000024u,
123       LC_VERSION_MIN_IPHONEOS = 0x00000025u,
124       LC_FUNCTION_STARTS      = 0x00000026u,
125       LC_DYLD_ENVIRONMENT     = 0x00000027u,
126       LC_MAIN                 = 0x80000028u,
127       LC_DATA_IN_CODE         = 0x00000029u,
128       LC_SOURCE_VERSION       = 0x0000002Au,
129       LC_DYLIB_CODE_SIGN_DRS  = 0x0000002Bu,
130       //                        0x0000002Cu,
131       LC_LINKER_OPTIONS       = 0x0000002Du
132     };
133
134     enum : uint32_t {
135       // Constant bits for the "flags" field in llvm::MachO::segment_command
136       SG_HIGHVM              = 0x1u,
137       SG_FVMLIB              = 0x2u,
138       SG_NORELOC             = 0x4u,
139       SG_PROTECTED_VERSION_1 = 0x8u,
140
141
142       // Constant masks for the "flags" field in llvm::MachO::section and
143       // llvm::MachO::section_64
144       SECTION_TYPE           = 0x000000ffu, // SECTION_TYPE
145       SECTION_ATTRIBUTES     = 0xffffff00u, // SECTION_ATTRIBUTES
146       SECTION_ATTRIBUTES_USR = 0xff000000u, // SECTION_ATTRIBUTES_USR
147       SECTION_ATTRIBUTES_SYS = 0x00ffff00u  // SECTION_ATTRIBUTES_SYS
148     };
149
150     /// These are the section type and attributes fields.  A MachO section can
151     /// have only one Type, but can have any of the attributes specified.
152     enum SectionType : uint32_t {
153       // Constant masks for the "flags[7:0]" field in llvm::MachO::section and
154       // llvm::MachO::section_64 (mask "flags" with SECTION_TYPE)
155       S_REGULAR                             = 0x00u,
156       S_ZEROFILL                            = 0x01u,
157       S_CSTRING_LITERALS                    = 0x02u,
158       S_4BYTE_LITERALS                      = 0x03u,
159       S_8BYTE_LITERALS                      = 0x04u,
160       S_LITERAL_POINTERS                    = 0x05u,
161       S_NON_LAZY_SYMBOL_POINTERS            = 0x06u,
162       S_LAZY_SYMBOL_POINTERS                = 0x07u,
163       S_SYMBOL_STUBS                        = 0x08u,
164       S_MOD_INIT_FUNC_POINTERS              = 0x09u,
165       S_MOD_TERM_FUNC_POINTERS              = 0x0au,
166       S_COALESCED                           = 0x0bu,
167       S_GB_ZEROFILL                         = 0x0cu,
168       S_INTERPOSING                         = 0x0du,
169       S_16BYTE_LITERALS                     = 0x0eu,
170       S_DTRACE_DOF                          = 0x0fu,
171       S_LAZY_DYLIB_SYMBOL_POINTERS          = 0x10u,
172       S_THREAD_LOCAL_REGULAR                = 0x11u,
173       S_THREAD_LOCAL_ZEROFILL               = 0x12u,
174       S_THREAD_LOCAL_VARIABLES              = 0x13u,
175       S_THREAD_LOCAL_VARIABLE_POINTERS      = 0x14u,
176       S_THREAD_LOCAL_INIT_FUNCTION_POINTERS = 0x15u,
177
178       LAST_KNOWN_SECTION_TYPE = S_THREAD_LOCAL_INIT_FUNCTION_POINTERS
179     };
180
181     enum : uint32_t {
182       // Constant masks for the "flags[31:24]" field in llvm::MachO::section and
183       // llvm::MachO::section_64 (mask "flags" with SECTION_ATTRIBUTES_USR)
184       S_ATTR_PURE_INSTRUCTIONS   = 0x80000000u,
185       S_ATTR_NO_TOC              = 0x40000000u,
186       S_ATTR_STRIP_STATIC_SYMS   = 0x20000000u,
187       S_ATTR_NO_DEAD_STRIP       = 0x10000000u,
188       S_ATTR_LIVE_SUPPORT        = 0x08000000u,
189       S_ATTR_SELF_MODIFYING_CODE = 0x04000000u,
190       S_ATTR_DEBUG               = 0x02000000u,
191
192       // Constant masks for the "flags[23:8]" field in llvm::MachO::section and
193       // llvm::MachO::section_64 (mask "flags" with SECTION_ATTRIBUTES_SYS)
194       S_ATTR_SOME_INSTRUCTIONS   = 0x00000400u,
195       S_ATTR_EXT_RELOC           = 0x00000200u,
196       S_ATTR_LOC_RELOC           = 0x00000100u,
197
198       // Constant masks for the value of an indirect symbol in an indirect
199       // symbol table
200       INDIRECT_SYMBOL_LOCAL = 0x80000000u,
201       INDIRECT_SYMBOL_ABS   = 0x40000000u
202     };
203
204     enum DataRegionType {
205       // Constants for the "kind" field in a data_in_code_entry structure
206       DICE_KIND_DATA             = 1u,
207       DICE_KIND_JUMP_TABLE8      = 2u,
208       DICE_KIND_JUMP_TABLE16     = 3u,
209       DICE_KIND_JUMP_TABLE32     = 4u,
210       DICE_KIND_ABS_JUMP_TABLE32 = 5u
211     };
212
213     enum RebaseType {
214       REBASE_TYPE_POINTER         = 1u,
215       REBASE_TYPE_TEXT_ABSOLUTE32 = 2u,
216       REBASE_TYPE_TEXT_PCREL32    = 3u
217     };
218
219     enum {
220       REBASE_OPCODE_MASK    = 0xF0u,
221       REBASE_IMMEDIATE_MASK = 0x0Fu
222     };
223
224     enum RebaseOpcode {
225       REBASE_OPCODE_DONE                               = 0x00u,
226       REBASE_OPCODE_SET_TYPE_IMM                       = 0x10u,
227       REBASE_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB        = 0x20u,
228       REBASE_OPCODE_ADD_ADDR_ULEB                      = 0x30u,
229       REBASE_OPCODE_ADD_ADDR_IMM_SCALED                = 0x40u,
230       REBASE_OPCODE_DO_REBASE_IMM_TIMES                = 0x50u,
231       REBASE_OPCODE_DO_REBASE_ULEB_TIMES               = 0x60u,
232       REBASE_OPCODE_DO_REBASE_ADD_ADDR_ULEB            = 0x70u,
233       REBASE_OPCODE_DO_REBASE_ULEB_TIMES_SKIPPING_ULEB = 0x80u
234     };
235
236     enum BindType {
237       BIND_TYPE_POINTER         = 1u,
238       BIND_TYPE_TEXT_ABSOLUTE32 = 2u,
239       BIND_TYPE_TEXT_PCREL32    = 3u
240     };
241
242     enum BindSpecialDylib {
243       BIND_SPECIAL_DYLIB_SELF            =  0,
244       BIND_SPECIAL_DYLIB_MAIN_EXECUTABLE = -1,
245       BIND_SPECIAL_DYLIB_FLAT_LOOKUP     = -2
246     };
247
248     enum {
249       BIND_SYMBOL_FLAGS_WEAK_IMPORT         = 0x1u,
250       BIND_SYMBOL_FLAGS_NON_WEAK_DEFINITION = 0x8u,
251
252       BIND_OPCODE_MASK                      = 0xF0u,
253       BIND_IMMEDIATE_MASK                   = 0x0Fu
254     };
255
256     enum BindOpcode {
257       BIND_OPCODE_DONE                             = 0x00u,
258       BIND_OPCODE_SET_DYLIB_ORDINAL_IMM            = 0x10u,
259       BIND_OPCODE_SET_DYLIB_ORDINAL_ULEB           = 0x20u,
260       BIND_OPCODE_SET_DYLIB_SPECIAL_IMM            = 0x30u,
261       BIND_OPCODE_SET_SYMBOL_TRAILING_FLAGS_IMM    = 0x40u,
262       BIND_OPCODE_SET_TYPE_IMM                     = 0x50u,
263       BIND_OPCODE_SET_ADDEND_SLEB                  = 0x60u,
264       BIND_OPCODE_SET_SEGMENT_AND_OFFSET_ULEB      = 0x70u,
265       BIND_OPCODE_ADD_ADDR_ULEB                    = 0x80u,
266       BIND_OPCODE_DO_BIND                          = 0x90u,
267       BIND_OPCODE_DO_BIND_ADD_ADDR_ULEB            = 0xA0u,
268       BIND_OPCODE_DO_BIND_ADD_ADDR_IMM_SCALED      = 0xB0u,
269       BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB = 0xC0u
270     };
271
272     enum {
273       EXPORT_SYMBOL_FLAGS_KIND_MASK           = 0x03u,
274       EXPORT_SYMBOL_FLAGS_WEAK_DEFINITION     = 0x04u,
275       EXPORT_SYMBOL_FLAGS_REEXPORT            = 0x08u,
276       EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER   = 0x10u
277     };
278
279     enum ExportSymbolKind {
280       EXPORT_SYMBOL_FLAGS_KIND_REGULAR        = 0x00u,
281       EXPORT_SYMBOL_FLAGS_KIND_THREAD_LOCAL   = 0x01u
282     };
283
284
285     enum {
286       // Constant masks for the "n_type" field in llvm::MachO::nlist and
287       // llvm::MachO::nlist_64
288       N_STAB = 0xe0,
289       N_PEXT = 0x10,
290       N_TYPE = 0x0e,
291       N_EXT  = 0x01
292     };
293
294     enum NListType {
295       // Constants for the "n_type & N_TYPE" llvm::MachO::nlist and
296       // llvm::MachO::nlist_64
297       N_UNDF = 0x0u,
298       N_ABS  = 0x2u,
299       N_SECT = 0xeu,
300       N_PBUD = 0xcu,
301       N_INDR = 0xau
302     };
303
304     enum SectionOrdinal {
305       // Constants for the "n_sect" field in llvm::MachO::nlist and
306       // llvm::MachO::nlist_64
307       NO_SECT  = 0u,
308       MAX_SECT = 0xffu
309     };
310
311     enum {
312       // Constant masks for the "n_desc" field in llvm::MachO::nlist and
313       // llvm::MachO::nlist_64
314       N_ARM_THUMB_DEF   = 0x0008u,
315       N_NO_DEAD_STRIP   = 0x0020u,
316       N_WEAK_REF        = 0x0040u,
317       N_WEAK_DEF        = 0x0080u,
318       N_SYMBOL_RESOLVER = 0x0100u
319     };
320
321     enum StabType {
322       // Constant values for the "n_type" field in llvm::MachO::nlist and
323       // llvm::MachO::nlist_64 when "(n_type & NlistMaskStab) != 0"
324       N_GSYM    = 0x20u,
325       N_FNAME   = 0x22u,
326       N_FUN     = 0x24u,
327       N_STSYM   = 0x26u,
328       N_LCSYM   = 0x28u,
329       N_BNSYM   = 0x2Eu,
330       N_OPT     = 0x3Cu,
331       N_RSYM    = 0x40u,
332       N_SLINE   = 0x44u,
333       N_ENSYM   = 0x4Eu,
334       N_SSYM    = 0x60u,
335       N_SO      = 0x64u,
336       N_OSO     = 0x66u,
337       N_LSYM    = 0x80u,
338       N_BINCL   = 0x82u,
339       N_SOL     = 0x84u,
340       N_PARAMS  = 0x86u,
341       N_VERSION = 0x88u,
342       N_OLEVEL  = 0x8Au,
343       N_PSYM    = 0xA0u,
344       N_EINCL   = 0xA2u,
345       N_ENTRY   = 0xA4u,
346       N_LBRAC   = 0xC0u,
347       N_EXCL    = 0xC2u,
348       N_RBRAC   = 0xE0u,
349       N_BCOMM   = 0xE2u,
350       N_ECOMM   = 0xE4u,
351       N_ECOML   = 0xE8u,
352       N_LENG    = 0xFEu
353     };
354
355     enum : uint32_t {
356       // Constant values for the r_symbolnum field in an
357       // llvm::MachO::relocation_info structure when r_extern is 0.
358       R_ABS = 0,
359
360       // Constant bits for the r_address field in an
361       // llvm::MachO::relocation_info structure.
362       R_SCATTERED = 0x80000000
363     };
364
365     enum RelocationInfoType {
366       // Constant values for the r_type field in an
367       // llvm::MachO::relocation_info or llvm::MachO::scattered_relocation_info
368       // structure.
369       GENERIC_RELOC_VANILLA        = 0,
370       GENERIC_RELOC_PAIR           = 1,
371       GENERIC_RELOC_SECTDIFF       = 2,
372       GENERIC_RELOC_PB_LA_PTR      = 3,
373       GENERIC_RELOC_LOCAL_SECTDIFF = 4,
374       GENERIC_RELOC_TLV            = 5,
375
376       // Constant values for the r_type field in a PowerPC architecture
377       // llvm::MachO::relocation_info or llvm::MachO::scattered_relocation_info
378       // structure.
379       PPC_RELOC_VANILLA            = GENERIC_RELOC_VANILLA,
380       PPC_RELOC_PAIR               = GENERIC_RELOC_PAIR,
381       PPC_RELOC_BR14               = 2,
382       PPC_RELOC_BR24               = 3,
383       PPC_RELOC_HI16               = 4,
384       PPC_RELOC_LO16               = 5,
385       PPC_RELOC_HA16               = 6,
386       PPC_RELOC_LO14               = 7,
387       PPC_RELOC_SECTDIFF           = 8,
388       PPC_RELOC_PB_LA_PTR          = 9,
389       PPC_RELOC_HI16_SECTDIFF      = 10,
390       PPC_RELOC_LO16_SECTDIFF      = 11,
391       PPC_RELOC_HA16_SECTDIFF      = 12,
392       PPC_RELOC_JBSR               = 13,
393       PPC_RELOC_LO14_SECTDIFF      = 14,
394       PPC_RELOC_LOCAL_SECTDIFF     = 15,
395
396       // Constant values for the r_type field in an ARM architecture
397       // llvm::MachO::relocation_info or llvm::MachO::scattered_relocation_info
398       // structure.
399       ARM_RELOC_VANILLA            = GENERIC_RELOC_VANILLA,
400       ARM_RELOC_PAIR               = GENERIC_RELOC_PAIR,
401       ARM_RELOC_SECTDIFF           = GENERIC_RELOC_SECTDIFF,
402       ARM_RELOC_LOCAL_SECTDIFF     = 3,
403       ARM_RELOC_PB_LA_PTR          = 4,
404       ARM_RELOC_BR24               = 5,
405       ARM_THUMB_RELOC_BR22         = 6,
406       ARM_THUMB_32BIT_BRANCH       = 7, // obsolete
407       ARM_RELOC_HALF               = 8,
408       ARM_RELOC_HALF_SECTDIFF      = 9,
409
410       // Constant values for the r_type field in an x86_64 architecture
411       // llvm::MachO::relocation_info or llvm::MachO::scattered_relocation_info
412       // structure
413       X86_64_RELOC_UNSIGNED        = 0,
414       X86_64_RELOC_SIGNED          = 1,
415       X86_64_RELOC_BRANCH          = 2,
416       X86_64_RELOC_GOT_LOAD        = 3,
417       X86_64_RELOC_GOT             = 4,
418       X86_64_RELOC_SUBTRACTOR      = 5,
419       X86_64_RELOC_SIGNED_1        = 6,
420       X86_64_RELOC_SIGNED_2        = 7,
421       X86_64_RELOC_SIGNED_4        = 8,
422       X86_64_RELOC_TLV             = 9
423     };
424
425     // Values for segment_command.initprot.
426     // From <mach/vm_prot.h>
427     enum {
428       VM_PROT_READ    = 0x1,
429       VM_PROT_WRITE   = 0x2,
430       VM_PROT_EXECUTE = 0x4
431     };
432
433
434     // Structs from <mach-o/loader.h>
435
436     struct mach_header {
437       uint32_t magic;
438       uint32_t cputype;
439       uint32_t cpusubtype;
440       uint32_t filetype;
441       uint32_t ncmds;
442       uint32_t sizeofcmds;
443       uint32_t flags;
444     };
445
446     struct mach_header_64 {
447       uint32_t magic;
448       uint32_t cputype;
449       uint32_t cpusubtype;
450       uint32_t filetype;
451       uint32_t ncmds;
452       uint32_t sizeofcmds;
453       uint32_t flags;
454       uint32_t reserved;
455     };
456
457     struct load_command {
458       uint32_t cmd;
459       uint32_t cmdsize;
460     };
461
462     struct segment_command {
463       uint32_t cmd;
464       uint32_t cmdsize;
465       char segname[16];
466       uint32_t vmaddr;
467       uint32_t vmsize;
468       uint32_t fileoff;
469       uint32_t filesize;
470       uint32_t maxprot;
471       uint32_t initprot;
472       uint32_t nsects;
473       uint32_t flags;
474     };
475
476     struct segment_command_64 {
477       uint32_t cmd;
478       uint32_t cmdsize;
479       char segname[16];
480       uint64_t vmaddr;
481       uint64_t vmsize;
482       uint64_t fileoff;
483       uint64_t filesize;
484       uint32_t maxprot;
485       uint32_t initprot;
486       uint32_t nsects;
487       uint32_t flags;
488     };
489
490     struct section {
491       char sectname[16];
492       char segname[16];
493       uint32_t addr;
494       uint32_t size;
495       uint32_t offset;
496       uint32_t align;
497       uint32_t reloff;
498       uint32_t nreloc;
499       uint32_t flags;
500       uint32_t reserved1;
501       uint32_t reserved2;
502     };
503
504     struct section_64 {
505       char sectname[16];
506       char segname[16];
507       uint64_t addr;
508       uint64_t size;
509       uint32_t offset;
510       uint32_t align;
511       uint32_t reloff;
512       uint32_t nreloc;
513       uint32_t flags;
514       uint32_t reserved1;
515       uint32_t reserved2;
516       uint32_t reserved3;
517     };
518
519     struct fvmlib {
520       uint32_t name;
521       uint32_t minor_version;
522       uint32_t header_addr;
523     };
524
525     struct fvmlib_command {
526       uint32_t  cmd;
527       uint32_t cmdsize;
528       struct fvmlib fvmlib;
529     };
530
531     struct dylib {
532       uint32_t name;
533       uint32_t timestamp;
534       uint32_t current_version;
535       uint32_t compatibility_version;
536     };
537
538     struct dylib_command {
539       uint32_t cmd;
540       uint32_t cmdsize;
541       struct dylib dylib;
542     };
543
544     struct sub_framework_command {
545       uint32_t cmd;
546       uint32_t cmdsize;
547       uint32_t umbrella;
548     };
549
550     struct sub_client_command {
551       uint32_t cmd;
552       uint32_t cmdsize;
553       uint32_t client;
554     };
555
556     struct sub_umbrella_command {
557       uint32_t cmd;
558       uint32_t cmdsize;
559       uint32_t sub_umbrella;
560     };
561
562     struct sub_library_command {
563       uint32_t cmd;
564       uint32_t cmdsize;
565       uint32_t sub_library;
566     };
567
568     struct prebound_dylib_command {
569       uint32_t cmd;
570       uint32_t cmdsize;
571       uint32_t name;
572       uint32_t nmodules;
573       uint32_t linked_modules;
574     };
575
576     struct dylinker_command {
577       uint32_t cmd;
578       uint32_t cmdsize;
579       uint32_t name;
580     };
581
582     struct thread_command {
583       uint32_t cmd;
584       uint32_t cmdsize;
585     };
586
587     struct routines_command {
588       uint32_t cmd;
589       uint32_t cmdsize;
590       uint32_t init_address;
591       uint32_t init_module;
592       uint32_t reserved1;
593       uint32_t reserved2;
594       uint32_t reserved3;
595       uint32_t reserved4;
596       uint32_t reserved5;
597       uint32_t reserved6;
598     };
599
600     struct routines_command_64 {
601       uint32_t cmd;
602       uint32_t cmdsize;
603       uint64_t init_address;
604       uint64_t init_module;
605       uint64_t reserved1;
606       uint64_t reserved2;
607       uint64_t reserved3;
608       uint64_t reserved4;
609       uint64_t reserved5;
610       uint64_t reserved6;
611     };
612
613     struct symtab_command {
614       uint32_t cmd;
615       uint32_t cmdsize;
616       uint32_t symoff;
617       uint32_t nsyms;
618       uint32_t stroff;
619       uint32_t strsize;
620     };
621
622     struct dysymtab_command {
623       uint32_t cmd;
624       uint32_t cmdsize;
625       uint32_t ilocalsym;
626       uint32_t nlocalsym;
627       uint32_t iextdefsym;
628       uint32_t nextdefsym;
629       uint32_t iundefsym;
630       uint32_t nundefsym;
631       uint32_t tocoff;
632       uint32_t ntoc;
633       uint32_t modtaboff;
634       uint32_t nmodtab;
635       uint32_t extrefsymoff;
636       uint32_t nextrefsyms;
637       uint32_t indirectsymoff;
638       uint32_t nindirectsyms;
639       uint32_t extreloff;
640       uint32_t nextrel;
641       uint32_t locreloff;
642       uint32_t nlocrel;
643     };
644
645     struct dylib_table_of_contents {
646       uint32_t symbol_index;
647       uint32_t module_index;
648     };
649
650     struct dylib_module {
651       uint32_t module_name;
652       uint32_t iextdefsym;
653       uint32_t nextdefsym;
654       uint32_t irefsym;
655       uint32_t nrefsym;
656       uint32_t ilocalsym;
657       uint32_t nlocalsym;
658       uint32_t iextrel;
659       uint32_t nextrel;
660       uint32_t iinit_iterm;
661       uint32_t ninit_nterm;
662       uint32_t objc_module_info_addr;
663       uint32_t objc_module_info_size;
664     };
665
666     struct dylib_module_64 {
667       uint32_t module_name;
668       uint32_t iextdefsym;
669       uint32_t nextdefsym;
670       uint32_t irefsym;
671       uint32_t nrefsym;
672       uint32_t ilocalsym;
673       uint32_t nlocalsym;
674       uint32_t iextrel;
675       uint32_t nextrel;
676       uint32_t iinit_iterm;
677       uint32_t ninit_nterm;
678       uint32_t objc_module_info_size;
679       uint64_t objc_module_info_addr;
680     };
681
682     struct dylib_reference {
683       uint32_t isym:24,
684                flags:8;
685     };
686
687
688     struct twolevel_hints_command {
689       uint32_t cmd;
690       uint32_t cmdsize;
691       uint32_t offset;
692       uint32_t nhints;
693     };
694
695     struct twolevel_hint {
696       uint32_t isub_image:8,
697                itoc:24;
698     };
699
700     struct prebind_cksum_command {
701       uint32_t cmd;
702       uint32_t cmdsize;
703       uint32_t cksum;
704     };
705
706     struct uuid_command {
707       uint32_t cmd;
708       uint32_t cmdsize;
709       uint8_t uuid[16];
710     };
711
712     struct rpath_command {
713       uint32_t cmd;
714       uint32_t cmdsize;
715       uint32_t path;
716     };
717
718     struct linkedit_data_command {
719       uint32_t cmd;
720       uint32_t cmdsize;
721       uint32_t dataoff;
722       uint32_t datasize;
723     };
724
725     struct data_in_code_entry {
726       uint32_t offset;
727       uint16_t length;
728       uint16_t kind;
729     };
730
731     struct source_version_command {
732       uint32_t cmd;
733       uint32_t cmdsize;
734       uint64_t version;
735     };
736
737     struct encryption_info_command {
738       uint32_t cmd;
739       uint32_t cmdsize;
740       uint32_t cryptoff;
741       uint32_t cryptsize;
742       uint32_t cryptid;
743     };
744
745     struct version_min_command {
746       uint32_t cmd;       // LC_VERSION_MIN_MACOSX or
747                           // LC_VERSION_MIN_IPHONEOS
748       uint32_t cmdsize;   // sizeof(struct version_min_command)
749       uint32_t version;   // X.Y.Z is encoded in nibbles xxxx.yy.zz
750       uint32_t reserved;
751     };
752
753     struct dyld_info_command {
754       uint32_t cmd;
755       uint32_t cmdsize;
756       uint32_t rebase_off;
757       uint32_t rebase_size;
758       uint32_t bind_off;
759       uint32_t bind_size;
760       uint32_t weak_bind_off;
761       uint32_t weak_bind_size;
762       uint32_t lazy_bind_off;
763       uint32_t lazy_bind_size;
764       uint32_t export_off;
765       uint32_t export_size;
766     };
767
768     struct linker_options_command {
769       uint32_t cmd;
770       uint32_t cmdsize;
771       uint32_t count;
772     };
773
774     struct symseg_command {
775       uint32_t cmd;
776       uint32_t cmdsize;
777       uint32_t offset;
778       uint32_t size;
779     };
780
781     struct ident_command {
782       uint32_t cmd;
783       uint32_t cmdsize;
784     };
785
786     struct fvmfile_command {
787       uint32_t cmd;
788       uint32_t cmdsize;
789       uint32_t name;
790       uint32_t header_addr;
791     };
792
793     struct tlv_descriptor_32 {
794       uint32_t thunk;
795       uint32_t key;
796       uint32_t offset;
797     };
798
799     struct tlv_descriptor_64 {
800       uint64_t thunk;
801       uint64_t key;
802       uint64_t offset;
803     };
804
805     struct tlv_descriptor {
806       uintptr_t thunk;
807       uintptr_t key;
808       uintptr_t offset;
809     };
810
811     struct entry_point_command {
812       uint32_t cmd;
813       uint32_t cmdsize;
814       uint64_t entryoff;
815       uint64_t stacksize;
816     };
817
818
819     // Structs from <mach-o/fat.h>
820     struct fat_header {
821       uint32_t magic;
822       uint32_t nfat_arch;
823     };
824
825     struct fat_arch {
826       uint32_t cputype;
827       uint32_t cpusubtype;
828       uint32_t offset;
829       uint32_t size;
830       uint32_t align;
831     };
832
833     // Structs from <mach-o/reloc.h>
834     struct relocation_info {
835       int32_t r_address;
836       uint32_t r_symbolnum:24,
837                r_pcrel:1,
838                r_length:2,
839                r_extern:1,
840                r_type:4;
841     };
842
843     struct scattered_relocation_info {
844 #if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && (BYTE_ORDER == BIG_ENDIAN)
845       uint32_t r_scattered:1,
846                r_pcrel:1,
847                r_length:2,
848                r_type:4,
849                r_address:24;
850 #else
851       uint32_t r_address:24,
852                r_type:4,
853                r_length:2,
854                r_pcrel:1,
855                r_scattered:1;
856 #endif
857       int32_t r_value;
858     };
859
860     // Structs NOT from <mach-o/reloc.h>, but that make LLVM's life easier
861     struct any_relocation_info {
862       uint32_t r_word0, r_word1;
863     };
864
865     // Structs from <mach-o/nlist.h>
866     struct nlist {
867       uint32_t n_strx;
868       uint8_t n_type;
869       uint8_t n_sect;
870       int16_t n_desc;
871       uint32_t n_value;
872     };
873
874     struct nlist_64 {
875       uint32_t n_strx;
876       uint8_t n_type;
877       uint8_t n_sect;
878       uint16_t n_desc;
879       uint64_t n_value;
880     };
881
882     // Get/Set functions from <mach-o/nlist.h>
883
884     static inline uint16_t GET_LIBRARY_ORDINAL(uint16_t n_desc) {
885       return (((n_desc) >> 8u) & 0xffu);
886     }
887
888     static inline void SET_LIBRARY_ORDINAL(uint16_t &n_desc, uint8_t ordinal) {
889       n_desc = (((n_desc) & 0x00ff) | (((ordinal) & 0xff) << 8));
890     }
891
892     static inline uint8_t GET_COMM_ALIGN (uint16_t n_desc) {
893       return (n_desc >> 8u) & 0x0fu;
894     }
895
896     static inline void SET_COMM_ALIGN (uint16_t &n_desc, uint8_t align) {
897       n_desc = ((n_desc & 0xf0ffu) | ((align & 0x0fu) << 8u));
898     }
899
900     // Enums from <mach/machine.h>
901     enum : uint32_t {
902       // Capability bits used in the definition of cpu_type.
903       CPU_ARCH_MASK  = 0xff000000,   // Mask for architecture bits
904       CPU_ARCH_ABI64 = 0x01000000    // 64 bit ABI
905     };
906
907     // Constants for the cputype field.
908     enum CPUType {
909       CPU_TYPE_ANY       = -1,
910       CPU_TYPE_X86       = 7,
911       CPU_TYPE_I386      = CPU_TYPE_X86,
912       CPU_TYPE_X86_64    = CPU_TYPE_X86 | CPU_ARCH_ABI64,
913    /* CPU_TYPE_MIPS      = 8, */
914       CPU_TYPE_MC98000   = 10, // Old Motorola PowerPC
915       CPU_TYPE_ARM       = 12,
916       CPU_TYPE_SPARC     = 14,
917       CPU_TYPE_POWERPC   = 18,
918       CPU_TYPE_POWERPC64 = CPU_TYPE_POWERPC | CPU_ARCH_ABI64
919     };
920
921     enum : uint32_t {
922       // Capability bits used in the definition of cpusubtype.
923       CPU_SUB_TYPE_MASK  = 0xff000000,   // Mask for architecture bits
924       CPU_SUB_TYPE_LIB64 = 0x80000000,   // 64 bit libraries
925
926       // Special CPU subtype constants.
927       CPU_SUBTYPE_MULTIPLE = ~0u
928     };
929
930     // Constants for the cpusubtype field.
931     enum CPUSubTypeX86 {
932       CPU_SUBTYPE_I386_ALL       = 3,
933       CPU_SUBTYPE_386            = 3,
934       CPU_SUBTYPE_486            = 4,
935       CPU_SUBTYPE_486SX          = 0x84,
936       CPU_SUBTYPE_586            = 5,
937       CPU_SUBTYPE_PENT           = CPU_SUBTYPE_586,
938       CPU_SUBTYPE_PENTPRO        = 0x16,
939       CPU_SUBTYPE_PENTII_M3      = 0x36,
940       CPU_SUBTYPE_PENTII_M5      = 0x56,
941       CPU_SUBTYPE_CELERON        = 0x67,
942       CPU_SUBTYPE_CELERON_MOBILE = 0x77,
943       CPU_SUBTYPE_PENTIUM_3      = 0x08,
944       CPU_SUBTYPE_PENTIUM_3_M    = 0x18,
945       CPU_SUBTYPE_PENTIUM_3_XEON = 0x28,
946       CPU_SUBTYPE_PENTIUM_M      = 0x09,
947       CPU_SUBTYPE_PENTIUM_4      = 0x0a,
948       CPU_SUBTYPE_PENTIUM_4_M    = 0x1a,
949       CPU_SUBTYPE_ITANIUM        = 0x0b,
950       CPU_SUBTYPE_ITANIUM_2      = 0x1b,
951       CPU_SUBTYPE_XEON           = 0x0c,
952       CPU_SUBTYPE_XEON_MP        = 0x1c,
953
954       CPU_SUBTYPE_X86_ALL     = 3,
955       CPU_SUBTYPE_X86_64_ALL  = 3,
956       CPU_SUBTYPE_X86_ARCH1   = 4,
957       CPU_SUBTYPE_X86_64_H    = 8
958     };
959     static inline int CPU_SUBTYPE_INTEL(int Family, int Model) {
960       return Family | (Model << 4);
961     }
962     static inline int CPU_SUBTYPE_INTEL_FAMILY(CPUSubTypeX86 ST) {
963       return ((int)ST) & 0x0f;
964     }
965     static inline int CPU_SUBTYPE_INTEL_MODEL(CPUSubTypeX86 ST) {
966       return ((int)ST) >> 4;
967     }
968     enum {
969       CPU_SUBTYPE_INTEL_FAMILY_MAX = 15,
970       CPU_SUBTYPE_INTEL_MODEL_ALL  = 0
971     };
972
973     enum CPUSubTypeARM {
974       CPU_SUBTYPE_ARM_ALL     = 0,
975       CPU_SUBTYPE_ARM_V4T     = 5,
976       CPU_SUBTYPE_ARM_V6      = 6,
977       CPU_SUBTYPE_ARM_V5      = 7,
978       CPU_SUBTYPE_ARM_V5TEJ   = 7,
979       CPU_SUBTYPE_ARM_XSCALE  = 8,
980       CPU_SUBTYPE_ARM_V7      = 9,
981       //  unused  ARM_V7F     = 10,
982       CPU_SUBTYPE_ARM_V7S     = 11,
983       CPU_SUBTYPE_ARM_V7K     = 12,
984       CPU_SUBTYPE_ARM_V6M     = 14,
985       CPU_SUBTYPE_ARM_V7M     = 15,
986       CPU_SUBTYPE_ARM_V7EM    = 16
987     };
988
989     enum CPUSubTypeSPARC {
990       CPU_SUBTYPE_SPARC_ALL   = 0
991     };
992
993     enum CPUSubTypePowerPC {
994       CPU_SUBTYPE_POWERPC_ALL   = 0,
995       CPU_SUBTYPE_POWERPC_601   = 1,
996       CPU_SUBTYPE_POWERPC_602   = 2,
997       CPU_SUBTYPE_POWERPC_603   = 3,
998       CPU_SUBTYPE_POWERPC_603e  = 4,
999       CPU_SUBTYPE_POWERPC_603ev = 5,
1000       CPU_SUBTYPE_POWERPC_604   = 6,
1001       CPU_SUBTYPE_POWERPC_604e  = 7,
1002       CPU_SUBTYPE_POWERPC_620   = 8,
1003       CPU_SUBTYPE_POWERPC_750   = 9,
1004       CPU_SUBTYPE_POWERPC_7400  = 10,
1005       CPU_SUBTYPE_POWERPC_7450  = 11,
1006       CPU_SUBTYPE_POWERPC_970   = 100,
1007
1008       CPU_SUBTYPE_MC980000_ALL  = CPU_SUBTYPE_POWERPC_ALL,
1009       CPU_SUBTYPE_MC98601       = CPU_SUBTYPE_POWERPC_601
1010     };
1011   } // end namespace MachO
1012 } // end namespace llvm
1013
1014 #endif