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