include/mach-o/loader.h

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