include/mach-o/loader.h

   1 /* Mach-O support for BFD.
   2    Copyright (C) 2011-2014 Free Software Foundation, Inc.
   3
   4    This file is part of BFD, the Binary File Descriptor library.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 #ifndef _MACH_O_LOADER_H
  22 #define _MACH_O_LOADER_H
  23
  24 /* Constants for header. */
  25
  26 typedef enum bfd_mach_o_mach_header_magic
  27 {
  28   BFD_MACH_O_MH_MAGIC    = 0xfeedface,
  29   BFD_MACH_O_MH_CIGAM    = 0xcefaedfe,
  30   BFD_MACH_O_MH_MAGIC_64 = 0xfeedfacf,
  31   BFD_MACH_O_MH_CIGAM_64 = 0xcffaedfe
  32 }
  33 bfd_mach_o_mach_header_magic;
  34
  35 /* Capability bits in cpu type.  */
  36 #define BFD_MACH_O_CPU_ARCH_MASK  0xff000000
  37 #define BFD_MACH_O_CPU_ARCH_ABI64 0x01000000
  38 #define BFD_MACH_O_CPU_IS64BIT    0x01000000
  39
  40 typedef enum bfd_mach_o_cpu_type
  41 {
  42   BFD_MACH_O_CPU_TYPE_VAX = 1,
  43   BFD_MACH_O_CPU_TYPE_MC680x0 = 6,
  44   BFD_MACH_O_CPU_TYPE_I386 = 7,
  45   BFD_MACH_O_CPU_TYPE_MIPS = 8,
  46   BFD_MACH_O_CPU_TYPE_MC98000 = 10,
  47   BFD_MACH_O_CPU_TYPE_HPPA = 11,
  48   BFD_MACH_O_CPU_TYPE_ARM = 12,
  49   BFD_MACH_O_CPU_TYPE_MC88000 = 13,
  50   BFD_MACH_O_CPU_TYPE_SPARC = 14,
  51   BFD_MACH_O_CPU_TYPE_I860 = 15,
  52   BFD_MACH_O_CPU_TYPE_ALPHA = 16,
  53   BFD_MACH_O_CPU_TYPE_POWERPC = 18,
  54   BFD_MACH_O_CPU_TYPE_POWERPC_64 =
  55     (BFD_MACH_O_CPU_TYPE_POWERPC | BFD_MACH_O_CPU_IS64BIT),
  56   BFD_MACH_O_CPU_TYPE_X86_64 =
  57     (BFD_MACH_O_CPU_TYPE_I386 | BFD_MACH_O_CPU_IS64BIT),
  58   BFD_MACH_O_CPU_TYPE_ARM64 =
  59     (BFD_MACH_O_CPU_TYPE_ARM | BFD_MACH_O_CPU_IS64BIT)
  60 }
  61 bfd_mach_o_cpu_type;
  62
  63 /* Capability bits in cpu subtype.  */
  64 #define BFD_MACH_O_CPU_SUBTYPE_MASK  0xff000000
  65 #define BFD_MACH_O_CPU_SUBTYPE_LIB64 0x80000000
  66
  67 typedef enum bfd_mach_o_cpu_subtype
  68 {
  69   /* i386.  */
  70   BFD_MACH_O_CPU_SUBTYPE_X86_ALL = 3,
  71
  72   /* arm.  */
  73   BFD_MACH_O_CPU_SUBTYPE_ARM_ALL = 0,
  74   BFD_MACH_O_CPU_SUBTYPE_ARM_V4T = 5,
  75   BFD_MACH_O_CPU_SUBTYPE_ARM_V6 = 6,
  76   BFD_MACH_O_CPU_SUBTYPE_ARM_V5TEJ = 7,
  77   BFD_MACH_O_CPU_SUBTYPE_ARM_XSCALE = 8,
  78   BFD_MACH_O_CPU_SUBTYPE_ARM_V7 = 9
  79 }
  80 bfd_mach_o_cpu_subtype;
  81
  82 typedef enum bfd_mach_o_filetype
  83 {
  84   BFD_MACH_O_MH_OBJECT      = 0x01,
  85   BFD_MACH_O_MH_EXECUTE     = 0x02,
  86   BFD_MACH_O_MH_FVMLIB      = 0x03,
  87   BFD_MACH_O_MH_CORE        = 0x04,
  88   BFD_MACH_O_MH_PRELOAD     = 0x05,
  89   BFD_MACH_O_MH_DYLIB       = 0x06,
  90   BFD_MACH_O_MH_DYLINKER    = 0x07,
  91   BFD_MACH_O_MH_BUNDLE      = 0x08,
  92   BFD_MACH_O_MH_DYLIB_STUB  = 0x09,
  93   BFD_MACH_O_MH_DSYM        = 0x0a,
  94   BFD_MACH_O_MH_KEXT_BUNDLE = 0x0b
  95 }
  96 bfd_mach_o_filetype;
  97
  98 typedef enum bfd_mach_o_header_flags
  99 {
 100   BFD_MACH_O_MH_NOUNDEFS                = 0x0000001,
 101   BFD_MACH_O_MH_INCRLINK                = 0x0000002,
 102   BFD_MACH_O_MH_DYLDLINK                = 0x0000004,
 103   BFD_MACH_O_MH_BINDATLOAD              = 0x0000008,
 104   BFD_MACH_O_MH_PREBOUND                = 0x0000010,
 105   BFD_MACH_O_MH_SPLIT_SEGS              = 0x0000020,
 106   BFD_MACH_O_MH_LAZY_INIT               = 0x0000040,
 107   BFD_MACH_O_MH_TWOLEVEL                = 0x0000080,
 108   BFD_MACH_O_MH_FORCE_FLAT              = 0x0000100,
 109   BFD_MACH_O_MH_NOMULTIDEFS             = 0x0000200,
 110   BFD_MACH_O_MH_NOFIXPREBINDING         = 0x0000400,
 111   BFD_MACH_O_MH_PREBINDABLE             = 0x0000800,
 112   BFD_MACH_O_MH_ALLMODSBOUND            = 0x0001000,
 113   BFD_MACH_O_MH_SUBSECTIONS_VIA_SYMBOLS = 0x0002000,
 114   BFD_MACH_O_MH_CANONICAL               = 0x0004000,
 115   BFD_MACH_O_MH_WEAK_DEFINES            = 0x0008000,
 116   BFD_MACH_O_MH_BINDS_TO_WEAK           = 0x0010000,
 117   BFD_MACH_O_MH_ALLOW_STACK_EXECUTION   = 0x0020000,
 118   BFD_MACH_O_MH_ROOT_SAFE               = 0x0040000,
 119   BFD_MACH_O_MH_SETUID_SAFE             = 0x0080000,
 120   BFD_MACH_O_MH_NO_REEXPORTED_DYLIBS    = 0x0100000,
 121   BFD_MACH_O_MH_PIE                     = 0x0200000,
 122   BFD_MACH_O_MH_DEAD_STRIPPABLE_DYLIB   = 0x0400000,
 123   BFD_MACH_O_MH_HAS_TLV_DESCRIPTORS     = 0x0800000,
 124   BFD_MACH_O_MH_NO_HEAP_EXECUTION       = 0x1000000
 125 }
 126 bfd_mach_o_header_flags;
 127 \f
 128 /* Load command constants.  */
 129 #define BFD_MACH_O_LC_REQ_DYLD 0x80000000
 130
 131 typedef enum bfd_mach_o_load_command_type
 132 {
 133   BFD_MACH_O_LC_SEGMENT = 0x1,          /* File segment to be mapped.  */
 134   BFD_MACH_O_LC_SYMTAB = 0x2,           /* Link-edit stab symbol table info (obsolete).  */
 135   BFD_MACH_O_LC_SYMSEG = 0x3,           /* Link-edit gdb symbol table info.  */
 136   BFD_MACH_O_LC_THREAD = 0x4,           /* Thread.  */
 137   BFD_MACH_O_LC_UNIXTHREAD = 0x5,       /* UNIX thread (includes a stack).  */
 138   BFD_MACH_O_LC_LOADFVMLIB = 0x6,       /* Load a fixed VM shared library.  */
 139   BFD_MACH_O_LC_IDFVMLIB = 0x7,         /* Fixed VM shared library id.  */
 140   BFD_MACH_O_LC_IDENT = 0x8,            /* Object identification information (obsolete).  */
 141   BFD_MACH_O_LC_FVMFILE = 0x9,          /* Fixed VM file inclusion.  */
 142   BFD_MACH_O_LC_PREPAGE = 0xa,          /* Prepage command (internal use).  */
 143   BFD_MACH_O_LC_DYSYMTAB = 0xb,         /* Dynamic link-edit symbol table info.  */
 144   BFD_MACH_O_LC_LOAD_DYLIB = 0xc,       /* Load a dynamically linked shared library.  */
 145   BFD_MACH_O_LC_ID_DYLIB = 0xd,         /* Dynamically linked shared lib identification.  */
 146   BFD_MACH_O_LC_LOAD_DYLINKER = 0xe,    /* Load a dynamic linker.  */
 147   BFD_MACH_O_LC_ID_DYLINKER = 0xf,      /* Dynamic linker identification.  */
 148   BFD_MACH_O_LC_PREBOUND_DYLIB = 0x10,  /* Modules prebound for a dynamically.  */
 149   BFD_MACH_O_LC_ROUTINES = 0x11,        /* Image routines.  */
 150   BFD_MACH_O_LC_SUB_FRAMEWORK = 0x12,   /* Sub framework.  */
 151   BFD_MACH_O_LC_SUB_UMBRELLA = 0x13,    /* Sub umbrella.  */
 152   BFD_MACH_O_LC_SUB_CLIENT = 0x14,      /* Sub client.  */
 153   BFD_MACH_O_LC_SUB_LIBRARY = 0x15,     /* Sub library.  */
 154   BFD_MACH_O_LC_TWOLEVEL_HINTS = 0x16,  /* Two-level namespace lookup hints.  */
 155   BFD_MACH_O_LC_PREBIND_CKSUM = 0x17,   /* Prebind checksum.  */
 156   /* Load a dynamically linked shared library that is allowed to be
 157        missing (weak).  */
 158   BFD_MACH_O_LC_LOAD_WEAK_DYLIB = 0x18,
 159   BFD_MACH_O_LC_SEGMENT_64 = 0x19,      /* 64-bit segment of this file to be
 160                                            mapped.  */
 161   BFD_MACH_O_LC_ROUTINES_64 = 0x1a,     /* Address of the dyld init routine
 162                                            in a dylib.  */
 163   BFD_MACH_O_LC_UUID = 0x1b,            /* 128-bit UUID of the executable.  */
 164   BFD_MACH_O_LC_RPATH = 0x1c,           /* Run path addiions.  */
 165   BFD_MACH_O_LC_CODE_SIGNATURE = 0x1d,  /* Local of code signature.  */
 166   BFD_MACH_O_LC_SEGMENT_SPLIT_INFO = 0x1e, /* Local of info to split seg.  */
 167   BFD_MACH_O_LC_REEXPORT_DYLIB = 0x1f,  /* Load and re-export lib.  */
 168   BFD_MACH_O_LC_LAZY_LOAD_DYLIB = 0x20, /* Delay load of lib until use.  */
 169   BFD_MACH_O_LC_ENCRYPTION_INFO = 0x21, /* Encrypted segment info.  */
 170   BFD_MACH_O_LC_DYLD_INFO = 0x22,       /* Compressed dyld information.  */
 171   BFD_MACH_O_LC_LOAD_UPWARD_DYLIB = 0x23, /* Load upward dylib.  */
 172   BFD_MACH_O_LC_VERSION_MIN_MACOSX = 0x24,   /* Minimal MacOSX version.  */
 173   BFD_MACH_O_LC_VERSION_MIN_IPHONEOS = 0x25, /* Minimal IOS version.  */
 174   BFD_MACH_O_LC_FUNCTION_STARTS = 0x26,  /* Compressed table of func start.  */
 175   BFD_MACH_O_LC_DYLD_ENVIRONMENT = 0x27, /* Env variable string for dyld.  */
 176   BFD_MACH_O_LC_MAIN = 0x28,             /* Entry point.  */
 177   BFD_MACH_O_LC_DATA_IN_CODE = 0x29,     /* Table of non-instructions.  */
 178   BFD_MACH_O_LC_SOURCE_VERSION = 0x2a,   /* Source version.  */
 179   BFD_MACH_O_LC_DYLIB_CODE_SIGN_DRS = 0x2b /* DRs from dylibs.  */
 180 }
 181 bfd_mach_o_load_command_type;
 182 \f
 183 /* Section constants.  */
 184 /* Constants for the type of a section.  */
 185
 186 typedef enum bfd_mach_o_section_type
 187 {
 188   /* Regular section.  */
 189   BFD_MACH_O_S_REGULAR = 0x0,
 190
 191   /* Zero fill on demand section.  */
 192   BFD_MACH_O_S_ZEROFILL = 0x1,
 193
 194   /* Section with only literal C strings.  */
 195   BFD_MACH_O_S_CSTRING_LITERALS = 0x2,
 196
 197   /* Section with only 4 byte literals.  */
 198   BFD_MACH_O_S_4BYTE_LITERALS = 0x3,
 199
 200   /* Section with only 8 byte literals.  */
 201   BFD_MACH_O_S_8BYTE_LITERALS = 0x4,
 202
 203   /* Section with only pointers to literals.  */
 204   BFD_MACH_O_S_LITERAL_POINTERS = 0x5,
 205
 206   /* For the two types of symbol pointers sections and the symbol stubs
 207      section they have indirect symbol table entries.  For each of the
 208      entries in the section the indirect symbol table entries, in
 209      corresponding order in the indirect symbol table, start at the index
 210      stored in the reserved1 field of the section structure.  Since the
 211      indirect symbol table entries correspond to the entries in the
 212      section the number of indirect symbol table entries is inferred from
 213      the size of the section divided by the size of the entries in the
 214      section.  For symbol pointers sections the size of the entries in
 215      the section is 4 bytes and for symbol stubs sections the byte size
 216      of the stubs is stored in the reserved2 field of the section
 217      structure.  */
 218
 219   /* Section with only non-lazy symbol pointers.  */
 220   BFD_MACH_O_S_NON_LAZY_SYMBOL_POINTERS = 0x6,
 221
 222   /* Section with only lazy symbol pointers.  */
 223   BFD_MACH_O_S_LAZY_SYMBOL_POINTERS = 0x7,
 224
 225   /* Section with only symbol stubs, byte size of stub in the reserved2
 226      field.  */
 227   BFD_MACH_O_S_SYMBOL_STUBS = 0x8,
 228
 229   /* Section with only function pointers for initialization.  */
 230   BFD_MACH_O_S_MOD_INIT_FUNC_POINTERS = 0x9,
 231
 232   /* Section with only function pointers for termination.  */
 233   BFD_MACH_O_S_MOD_FINI_FUNC_POINTERS = 0xa,
 234
 235   /* Section contains symbols that are coalesced by the linkers.  */
 236   BFD_MACH_O_S_COALESCED = 0xb,
 237
 238   /* Zero fill on demand section (possibly larger than 4 GB).  */
 239   BFD_MACH_O_S_GB_ZEROFILL = 0xc,
 240
 241   /* Section with only pairs of function pointers for interposing.  */
 242   BFD_MACH_O_S_INTERPOSING = 0xd,
 243
 244   /* Section with only 16 byte literals.  */
 245   BFD_MACH_O_S_16BYTE_LITERALS = 0xe,
 246
 247   /* Section contains DTrace Object Format.  */
 248   BFD_MACH_O_S_DTRACE_DOF = 0xf,
 249
 250   /* Section with only lazy symbol pointers to lazy loaded dylibs.  */
 251   BFD_MACH_O_S_LAZY_DYLIB_SYMBOL_POINTERS = 0x10
 252 }
 253 bfd_mach_o_section_type;
 254
 255 /* The flags field of a section structure is separated into two parts a section
 256    type and section attributes.  The section types are mutually exclusive (it
 257    can only have one type) but the section attributes are not (it may have more
 258    than one attribute).  */
 259
 260 #define BFD_MACH_O_SECTION_TYPE_MASK        0x000000ff
 261
 262 /* Constants for the section attributes part of the flags field of a section
 263    structure.  */
 264 #define BFD_MACH_O_SECTION_ATTRIBUTES_MASK  0xffffff00
 265 /* System setable attributes.  */
 266 #define BFD_MACH_O_SECTION_ATTRIBUTES_SYS   0x00ffff00
 267 /* User attributes.  */
 268 #define BFD_MACH_O_SECTION_ATTRIBUTES_USR   0xff000000
 269
 270 typedef enum bfd_mach_o_section_attribute
 271 {
 272   /* Section has no specified attibutes.  */
 273   BFD_MACH_O_S_ATTR_NONE              = 0,
 274
 275   /* Section has local relocation entries.  */
 276   BFD_MACH_O_S_ATTR_LOC_RELOC         = 0x00000100,
 277
 278   /* Section has external relocation entries.  */
 279   BFD_MACH_O_S_ATTR_EXT_RELOC         = 0x00000200,
 280
 281   /* Section contains some machine instructions.  */
 282   BFD_MACH_O_S_ATTR_SOME_INSTRUCTIONS = 0x00000400,
 283
 284   /* A debug section.  */
 285   BFD_MACH_O_S_ATTR_DEBUG             = 0x02000000,
 286
 287   /* Used with i386 stubs.  */
 288   BFD_MACH_O_S_SELF_MODIFYING_CODE    = 0x04000000,
 289
 290   /* Blocks are live if they reference live blocks.  */
 291   BFD_MACH_O_S_ATTR_LIVE_SUPPORT      = 0x08000000,
 292
 293   /* No dead stripping.  */
 294   BFD_MACH_O_S_ATTR_NO_DEAD_STRIP     = 0x10000000,
 295
 296   /* Section symbols can be stripped in files with MH_DYLDLINK flag.  */
 297   BFD_MACH_O_S_ATTR_STRIP_STATIC_SYMS = 0x20000000,
 298
 299   /* Section contains coalesced symbols that are not to be in the TOC of an
 300      archive.  */
 301   BFD_MACH_O_S_ATTR_NO_TOC            = 0x40000000,
 302
 303   /* Section contains only true machine instructions.  */
 304   BFD_MACH_O_S_ATTR_PURE_INSTRUCTIONS = 0x80000000
 305 }
 306 bfd_mach_o_section_attribute;
 307 \f
 308 /* Symbol constants.  */
 309
 310 /* Symbol n_type values.  */
 311 #define BFD_MACH_O_N_STAB  0xe0 /* If any of these bits set, a symbolic debugging entry.  */
 312 #define BFD_MACH_O_N_PEXT  0x10 /* Private external symbol bit.  */
 313 #define BFD_MACH_O_N_TYPE  0x0e /* Mask for the type bits.  */
 314 #define BFD_MACH_O_N_EXT   0x01 /* External symbol bit, set for external symbols.  */
 315 #define BFD_MACH_O_N_UNDF  0x00 /* Undefined, n_sect == NO_SECT.  */
 316 #define BFD_MACH_O_N_ABS   0x02 /* Absolute, n_sect == NO_SECT.  */
 317 #define BFD_MACH_O_N_INDR  0x0a /* Indirect.  */
 318 #define BFD_MACH_O_N_PBUD  0x0c /* Prebound undefined (defined in a dylib).  */
 319 #define BFD_MACH_O_N_SECT  0x0e /* Defined in section number n_sect.  */
 320
 321 #define BFD_MACH_O_NO_SECT 0    /* Symbol not in any section of the image.  */
 322
 323 /* Symbol n_desc reference flags.  */
 324 #define BFD_MACH_O_REFERENCE_MASK                               0x07
 325 #define BFD_MACH_O_REFERENCE_FLAG_UNDEFINED_NON_LAZY            0x00
 326 #define BFD_MACH_O_REFERENCE_FLAG_UNDEFINED_LAZY                0x01
 327 #define BFD_MACH_O_REFERENCE_FLAG_DEFINED                       0x02
 328 #define BFD_MACH_O_REFERENCE_FLAG_PRIVATE_DEFINED               0x03
 329 #define BFD_MACH_O_REFERENCE_FLAG_PRIVATE_UNDEFINED_NON_LAZY    0x04
 330 #define BFD_MACH_O_REFERENCE_FLAG_PRIVATE_UNDEFINED_LAZY        0x05
 331
 332 #define BFD_MACH_O_REFERENCED_DYNAMICALLY                       0x10
 333 #define BFD_MACH_O_N_DESC_DISCARDED                             0x20
 334 #define BFD_MACH_O_N_NO_DEAD_STRIP                              0x20
 335 #define BFD_MACH_O_N_WEAK_REF                                   0x40
 336 #define BFD_MACH_O_N_WEAK_DEF                                   0x80
 337 #define BFD_MACH_O_N_REF_TO_WEAK                                0x80
 338
 339 #define BFD_MACH_O_N_ARM_THUMB_DEF                              0x08
 340 #define BFD_MACH_O_N_SYMBOL_RESOLVER                            0x100
 341
 342 #define BFD_MACH_O_INDIRECT_SYM_LOCAL                   0x80000000
 343 #define BFD_MACH_O_INDIRECT_SYM_ABS                     0x40000000
 344 \f
 345 /* Constants for DATA_IN_CODE entries.  */
 346 typedef enum bfd_mach_o_data_in_code_entry_kind
 347 {
 348   BFD_MACH_O_DICE_KIND_DATA         = 0x0001, /* Data */
 349   BFD_MACH_O_DICE_JUMP_TABLES8      = 0x0002, /* 1 byte jump tables.  */
 350   BFD_MACH_O_DICE_JUMP_TABLES16     = 0x0003, /* 2 bytes.  */
 351   BFD_MACH_O_DICE_JUMP_TABLES32     = 0x0004, /* 4 bytes.  */
 352   BFD_MACH_O_DICE_ABS_JUMP_TABLES32 = 0x0005  /* Absolute jump table.  */
 353 } bfd_mach_o_data_in_code_entry_kind;
 354
 355 /* Thread constants.  */
 356
 357 typedef enum bfd_mach_o_ppc_thread_flavour
 358 {
 359   BFD_MACH_O_PPC_THREAD_STATE      = 1,
 360   BFD_MACH_O_PPC_FLOAT_STATE       = 2,
 361   BFD_MACH_O_PPC_EXCEPTION_STATE   = 3,
 362   BFD_MACH_O_PPC_VECTOR_STATE      = 4,
 363   BFD_MACH_O_PPC_THREAD_STATE64    = 5,
 364   BFD_MACH_O_PPC_EXCEPTION_STATE64 = 6,
 365   BFD_MACH_O_PPC_THREAD_STATE_NONE = 7
 366 }
 367 bfd_mach_o_ppc_thread_flavour;
 368
 369 /* Defined in <mach/i386/thread_status.h> */
 370 typedef enum bfd_mach_o_i386_thread_flavour
 371 {
 372   BFD_MACH_O_x86_THREAD_STATE32    = 1,
 373   BFD_MACH_O_x86_FLOAT_STATE32     = 2,
 374   BFD_MACH_O_x86_EXCEPTION_STATE32 = 3,
 375   BFD_MACH_O_x86_THREAD_STATE64    = 4,
 376   BFD_MACH_O_x86_FLOAT_STATE64     = 5,
 377   BFD_MACH_O_x86_EXCEPTION_STATE64 = 6,
 378   BFD_MACH_O_x86_THREAD_STATE      = 7,
 379   BFD_MACH_O_x86_FLOAT_STATE       = 8,
 380   BFD_MACH_O_x86_EXCEPTION_STATE   = 9,
 381   BFD_MACH_O_x86_DEBUG_STATE32     = 10,
 382   BFD_MACH_O_x86_DEBUG_STATE64     = 11,
 383   BFD_MACH_O_x86_DEBUG_STATE       = 12,
 384   BFD_MACH_O_x86_THREAD_STATE_NONE = 13
 385 }
 386 bfd_mach_o_i386_thread_flavour;
 387
 388 #endif /* _MACH_O_LOADER_H */