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