daily update
[binutils.git] / bfd / mach-o.h
bloba5045396aa0863e37b407a544fd035c37721aabe
1 /* Mach-O support for BFD.
2 Copyright 1999, 2000, 2001, 2002, 2003, 2005, 2007
3 Free Software Foundation, Inc.
5 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
22 #ifndef _BFD_MACH_O_H_
23 #define _BFD_MACH_O_H_
25 #include "bfd.h"
27 #define BFD_MACH_O_N_STAB 0xe0 /* If any of these bits set, a symbolic debugging entry. */
28 #define BFD_MACH_O_N_PEXT 0x10 /* Private external symbol bit. */
29 #define BFD_MACH_O_N_TYPE 0x0e /* Mask for the type bits. */
30 #define BFD_MACH_O_N_EXT 0x01 /* External symbol bit, set for external symbols. */
31 #define BFD_MACH_O_N_UNDF 0x00 /* Undefined, n_sect == NO_SECT. */
32 #define BFD_MACH_O_N_ABS 0x02 /* Absolute, n_sect == NO_SECT. */
33 #define BFD_MACH_O_N_SECT 0x0e /* Defined in section number n_sect. */
34 #define BFD_MACH_O_N_PBUD 0x0c /* Prebound undefined (defined in a dylib). */
35 #define BFD_MACH_O_N_INDR 0x0a /* Indirect. */
37 typedef enum bfd_mach_o_ppc_thread_flavour
39 BFD_MACH_O_PPC_THREAD_STATE = 1,
40 BFD_MACH_O_PPC_FLOAT_STATE = 2,
41 BFD_MACH_O_PPC_EXCEPTION_STATE = 3,
42 BFD_MACH_O_PPC_VECTOR_STATE = 4
44 bfd_mach_o_ppc_thread_flavour;
46 typedef enum bfd_mach_o_i386_thread_flavour
48 BFD_MACH_O_i386_NEW_THREAD_STATE = 1,
49 BFD_MACH_O_i386_FLOAT_STATE = 2,
50 BFD_MACH_O_i386_ISA_PORT_MAP_STATE = 3,
51 BFD_MACH_O_i386_V86_ASSIST_STATE = 4,
52 BFD_MACH_O_i386_REGS_SEGS_STATE = 5,
53 BFD_MACH_O_i386_THREAD_SYSCALL_STATE = 6,
54 BFD_MACH_O_i386_THREAD_STATE_NONE = 7,
55 BFD_MACH_O_i386_SAVED_STATE = 8,
56 BFD_MACH_O_i386_THREAD_STATE = -1,
57 BFD_MACH_O_i386_THREAD_FPSTATE = -2,
58 BFD_MACH_O_i386_THREAD_EXCEPTSTATE = -3,
59 BFD_MACH_O_i386_THREAD_CTHREADSTATE = -4,
61 bfd_mach_o_i386_thread_flavour;
63 #define BFD_MACH_O_LC_REQ_DYLD 0x80000000
65 typedef enum bfd_mach_o_load_command_type
67 BFD_MACH_O_LC_SEGMENT = 0x1, /* File segment to be mapped. */
68 BFD_MACH_O_LC_SYMTAB = 0x2, /* Link-edit stab symbol table info (obsolete). */
69 BFD_MACH_O_LC_SYMSEG = 0x3, /* Link-edit gdb symbol table info. */
70 BFD_MACH_O_LC_THREAD = 0x4, /* Thread. */
71 BFD_MACH_O_LC_UNIXTHREAD = 0x5, /* UNIX thread (includes a stack). */
72 BFD_MACH_O_LC_LOADFVMLIB = 0x6, /* Load a fixed VM shared library. */
73 BFD_MACH_O_LC_IDFVMLIB = 0x7, /* Fixed VM shared library id. */
74 BFD_MACH_O_LC_IDENT = 0x8, /* Object identification information (obsolete). */
75 BFD_MACH_O_LC_FVMFILE = 0x9, /* Fixed VM file inclusion. */
76 BFD_MACH_O_LC_PREPAGE = 0xa, /* Prepage command (internal use). */
77 BFD_MACH_O_LC_DYSYMTAB = 0xb, /* Dynamic link-edit symbol table info. */
78 BFD_MACH_O_LC_LOAD_DYLIB = 0xc, /* Load a dynamically linked shared library. */
79 BFD_MACH_O_LC_ID_DYLIB = 0xd, /* Dynamically linked shared lib identification. */
80 BFD_MACH_O_LC_LOAD_DYLINKER = 0xe, /* Load a dynamic linker. */
81 BFD_MACH_O_LC_ID_DYLINKER = 0xf, /* Dynamic linker identification. */
82 BFD_MACH_O_LC_PREBOUND_DYLIB = 0x10, /* Modules prebound for a dynamically. */
83 BFD_MACH_O_LC_ROUTINES = 0x11, /* Image routines. */
84 BFD_MACH_O_LC_SUB_FRAMEWORK = 0x12, /* Sub framework. */
85 BFD_MACH_O_LC_SUB_UMBRELLA = 0x13, /* Sub umbrella. */
86 BFD_MACH_O_LC_SUB_CLIENT = 0x14, /* Sub client. */
87 BFD_MACH_O_LC_SUB_LIBRARY = 0x15, /* Sub library. */
88 BFD_MACH_O_LC_TWOLEVEL_HINTS = 0x16, /* Two-level namespace lookup hints. */
89 BFD_MACH_O_LC_PREBIND_CKSUM = 0x17, /* Prebind checksum. */
90 /* Load a dynamically linked shared library that is allowed to be
91 missing (weak). */
92 BFD_MACH_O_LC_LOAD_WEAK_DYLIB = 0x18
94 bfd_mach_o_load_command_type;
96 typedef enum bfd_mach_o_cpu_type
98 BFD_MACH_O_CPU_TYPE_VAX = 1,
99 BFD_MACH_O_CPU_TYPE_MC680x0 = 6,
100 BFD_MACH_O_CPU_TYPE_I386 = 7,
101 BFD_MACH_O_CPU_TYPE_MIPS = 8,
102 BFD_MACH_O_CPU_TYPE_MC98000 = 10,
103 BFD_MACH_O_CPU_TYPE_HPPA = 11,
104 BFD_MACH_O_CPU_TYPE_ARM = 12,
105 BFD_MACH_O_CPU_TYPE_MC88000 = 13,
106 BFD_MACH_O_CPU_TYPE_SPARC = 14,
107 BFD_MACH_O_CPU_TYPE_I860 = 15,
108 BFD_MACH_O_CPU_TYPE_ALPHA = 16,
109 BFD_MACH_O_CPU_TYPE_POWERPC = 18
111 bfd_mach_o_cpu_type;
113 typedef enum bfd_mach_o_filetype
115 BFD_MACH_O_MH_OBJECT = 1,
116 BFD_MACH_O_MH_EXECUTE = 2,
117 BFD_MACH_O_MH_FVMLIB = 3,
118 BFD_MACH_O_MH_CORE = 4,
119 BFD_MACH_O_MH_PRELOAD = 5,
120 BFD_MACH_O_MH_DYLIB = 6,
121 BFD_MACH_O_MH_DYLINKER = 7,
122 BFD_MACH_O_MH_BUNDLE = 8
124 bfd_mach_o_filetype;
126 /* Constants for the type of a section. */
128 typedef enum bfd_mach_o_section_type
130 /* Regular section. */
131 BFD_MACH_O_S_REGULAR = 0x0,
133 /* Zero fill on demand section. */
134 BFD_MACH_O_S_ZEROFILL = 0x1,
136 /* Section with only literal C strings. */
137 BFD_MACH_O_S_CSTRING_LITERALS = 0x2,
139 /* Section with only 4 byte literals. */
140 BFD_MACH_O_S_4BYTE_LITERALS = 0x3,
142 /* Section with only 8 byte literals. */
143 BFD_MACH_O_S_8BYTE_LITERALS = 0x4,
145 /* Section with only pointers to literals. */
146 BFD_MACH_O_S_LITERAL_POINTERS = 0x5,
148 /* For the two types of symbol pointers sections and the symbol stubs
149 section they have indirect symbol table entries. For each of the
150 entries in the section the indirect symbol table entries, in
151 corresponding order in the indirect symbol table, start at the index
152 stored in the reserved1 field of the section structure. Since the
153 indirect symbol table entries correspond to the entries in the
154 section the number of indirect symbol table entries is inferred from
155 the size of the section divided by the size of the entries in the
156 section. For symbol pointers sections the size of the entries in
157 the section is 4 bytes and for symbol stubs sections the byte size
158 of the stubs is stored in the reserved2 field of the section
159 structure. */
161 /* Section with only non-lazy symbol pointers. */
162 BFD_MACH_O_S_NON_LAZY_SYMBOL_POINTERS = 0x6,
164 /* Section with only lazy symbol pointers. */
165 BFD_MACH_O_S_LAZY_SYMBOL_POINTERS = 0x7,
167 /* Section with only symbol stubs, byte size of stub in the reserved2 field. */
168 BFD_MACH_O_S_SYMBOL_STUBS = 0x8,
170 /* Section with only function pointers for initialization. */
171 BFD_MACH_O_S_MOD_INIT_FUNC_POINTERS = 0x9
173 bfd_mach_o_section_type;
175 typedef unsigned long bfd_mach_o_cpu_subtype;
177 typedef struct bfd_mach_o_header
179 unsigned long magic;
180 unsigned long cputype;
181 unsigned long cpusubtype;
182 unsigned long filetype;
183 unsigned long ncmds;
184 unsigned long sizeofcmds;
185 unsigned long flags;
186 enum bfd_endian byteorder;
188 bfd_mach_o_header;
190 typedef struct bfd_mach_o_section
192 asection *bfdsection;
193 char sectname[16 + 1];
194 char segname[16 + 1];
195 bfd_vma addr;
196 bfd_vma size;
197 bfd_vma offset;
198 unsigned long align;
199 bfd_vma reloff;
200 unsigned long nreloc;
201 unsigned long flags;
202 unsigned long reserved1;
203 unsigned long reserved2;
205 bfd_mach_o_section;
207 typedef struct bfd_mach_o_segment_command
209 char segname[16];
210 bfd_vma vmaddr;
211 bfd_vma vmsize;
212 bfd_vma fileoff;
213 unsigned long filesize;
214 unsigned long nsects;
215 unsigned long flags;
216 bfd_mach_o_section *sections;
217 asection *segment;
219 bfd_mach_o_segment_command;
221 typedef struct bfd_mach_o_symtab_command
223 unsigned long symoff;
224 unsigned long nsyms;
225 unsigned long stroff;
226 unsigned long strsize;
227 asymbol *symbols;
228 char *strtab;
229 asection *stabs_segment;
230 asection *stabstr_segment;
232 bfd_mach_o_symtab_command;
234 /* This is the second set of the symbolic information which is used to support
235 the data structures for the dynamically link editor.
237 The original set of symbolic information in the symtab_command which contains
238 the symbol and string tables must also be present when this load command is
239 present. When this load command is present the symbol table is organized
240 into three groups of symbols:
241 local symbols (static and debugging symbols) - grouped by module
242 defined external symbols - grouped by module (sorted by name if not lib)
243 undefined external symbols (sorted by name)
244 In this load command there are offsets and counts to each of the three groups
245 of symbols.
247 This load command contains a the offsets and sizes of the following new
248 symbolic information tables:
249 table of contents
250 module table
251 reference symbol table
252 indirect symbol table
253 The first three tables above (the table of contents, module table and
254 reference symbol table) are only present if the file is a dynamically linked
255 shared library. For executable and object modules, which are files
256 containing only one module, the information that would be in these three
257 tables is determined as follows:
258 table of contents - the defined external symbols are sorted by name
259 module table - the file contains only one module so everything in the
260 file is part of the module.
261 reference symbol table - is the defined and undefined external symbols
263 For dynamically linked shared library files this load command also contains
264 offsets and sizes to the pool of relocation entries for all sections
265 separated into two groups:
266 external relocation entries
267 local relocation entries
268 For executable and object modules the relocation entries continue to hang
269 off the section structures. */
271 typedef struct bfd_mach_o_dysymtab_command
273 /* The symbols indicated by symoff and nsyms of the LC_SYMTAB load command
274 are grouped into the following three groups:
275 local symbols (further grouped by the module they are from)
276 defined external symbols (further grouped by the module they are from)
277 undefined symbols
279 The local symbols are used only for debugging. The dynamic binding
280 process may have to use them to indicate to the debugger the local
281 symbols for a module that is being bound.
283 The last two groups are used by the dynamic binding process to do the
284 binding (indirectly through the module table and the reference symbol
285 table when this is a dynamically linked shared library file). */
287 unsigned long ilocalsym; /* Index to local symbols. */
288 unsigned long nlocalsym; /* Number of local symbols. */
289 unsigned long iextdefsym; /* Index to externally defined symbols. */
290 unsigned long nextdefsym; /* Number of externally defined symbols. */
291 unsigned long iundefsym; /* Index to undefined symbols. */
292 unsigned long nundefsym; /* Number of undefined symbols. */
294 /* For the for the dynamic binding process to find which module a symbol
295 is defined in the table of contents is used (analogous to the ranlib
296 structure in an archive) which maps defined external symbols to modules
297 they are defined in. This exists only in a dynamically linked shared
298 library file. For executable and object modules the defined external
299 symbols are sorted by name and is use as the table of contents. */
301 unsigned long tocoff; /* File offset to table of contents. */
302 unsigned long ntoc; /* Number of entries in table of contents. */
304 /* To support dynamic binding of "modules" (whole object files) the symbol
305 table must reflect the modules that the file was created from. This is
306 done by having a module table that has indexes and counts into the merged
307 tables for each module. The module structure that these two entries
308 refer to is described below. This exists only in a dynamically linked
309 shared library file. For executable and object modules the file only
310 contains one module so everything in the file belongs to the module. */
312 unsigned long modtaboff; /* File offset to module table. */
313 unsigned long nmodtab; /* Number of module table entries. */
315 /* To support dynamic module binding the module structure for each module
316 indicates the external references (defined and undefined) each module
317 makes. For each module there is an offset and a count into the
318 reference symbol table for the symbols that the module references.
319 This exists only in a dynamically linked shared library file. For
320 executable and object modules the defined external symbols and the
321 undefined external symbols indicates the external references. */
323 unsigned long extrefsymoff; /* Offset to referenced symbol table. */
324 unsigned long nextrefsyms; /* Number of referenced symbol table entries. */
326 /* The sections that contain "symbol pointers" and "routine stubs" have
327 indexes and (implied counts based on the size of the section and fixed
328 size of the entry) into the "indirect symbol" table for each pointer
329 and stub. For every section of these two types the index into the
330 indirect symbol table is stored in the section header in the field
331 reserved1. An indirect symbol table entry is simply a 32bit index into
332 the symbol table to the symbol that the pointer or stub is referring to.
333 The indirect symbol table is ordered to match the entries in the section. */
335 unsigned long indirectsymoff; /* File offset to the indirect symbol table. */
336 unsigned long nindirectsyms; /* Number of indirect symbol table entries. */
338 /* To support relocating an individual module in a library file quickly the
339 external relocation entries for each module in the library need to be
340 accessed efficiently. Since the relocation entries can't be accessed
341 through the section headers for a library file they are separated into
342 groups of local and external entries further grouped by module. In this
343 case the presents of this load command who's extreloff, nextrel,
344 locreloff and nlocrel fields are non-zero indicates that the relocation
345 entries of non-merged sections are not referenced through the section
346 structures (and the reloff and nreloc fields in the section headers are
347 set to zero).
349 Since the relocation entries are not accessed through the section headers
350 this requires the r_address field to be something other than a section
351 offset to identify the item to be relocated. In this case r_address is
352 set to the offset from the vmaddr of the first LC_SEGMENT command.
354 The relocation entries are grouped by module and the module table
355 entries have indexes and counts into them for the group of external
356 relocation entries for that the module.
358 For sections that are merged across modules there must not be any
359 remaining external relocation entries for them (for merged sections
360 remaining relocation entries must be local). */
362 unsigned long extreloff; /* Offset to external relocation entries. */
363 unsigned long nextrel; /* Number of external relocation entries. */
365 /* All the local relocation entries are grouped together (they are not
366 grouped by their module since they are only used if the object is moved
367 from it statically link edited address). */
369 unsigned long locreloff; /* Offset to local relocation entries. */
370 unsigned long nlocrel; /* Number of local relocation entries. */
372 bfd_mach_o_dysymtab_command;
374 /* An indirect symbol table entry is simply a 32bit index into the symbol table
375 to the symbol that the pointer or stub is refering to. Unless it is for a
376 non-lazy symbol pointer section for a defined symbol which strip(1) as
377 removed. In which case it has the value INDIRECT_SYMBOL_LOCAL. If the
378 symbol was also absolute INDIRECT_SYMBOL_ABS is or'ed with that. */
380 #define INDIRECT_SYMBOL_LOCAL 0x80000000
381 #define INDIRECT_SYMBOL_ABS 0x40000000
383 typedef struct bfd_mach_o_thread_flavour
385 unsigned long flavour;
386 bfd_vma offset;
387 unsigned long size;
389 bfd_mach_o_thread_flavour;
391 typedef struct bfd_mach_o_thread_command
393 unsigned long nflavours;
394 bfd_mach_o_thread_flavour *flavours;
395 asection *section;
397 bfd_mach_o_thread_command;
399 typedef struct bfd_mach_o_dylinker_command
401 unsigned long cmd; /* LC_ID_DYLIB or LC_LOAD_DYLIB. */
402 unsigned long cmdsize; /* Includes pathname string. */
403 unsigned long name_offset; /* Offset to library's path name. */
404 unsigned long name_len; /* Offset to library's path name. */
405 asection *section;
407 bfd_mach_o_dylinker_command;
409 typedef struct bfd_mach_o_dylib_command
411 unsigned long cmd; /* LC_ID_DYLIB or LC_LOAD_DYLIB. */
412 unsigned long cmdsize; /* Includes pathname string. */
413 unsigned long name_offset; /* Offset to library's path name. */
414 unsigned long name_len; /* Offset to library's path name. */
415 unsigned long timestamp; /* Library's build time stamp. */
416 unsigned long current_version; /* Library's current version number. */
417 unsigned long compatibility_version; /* Library's compatibility vers number. */
418 asection *section;
420 bfd_mach_o_dylib_command;
422 typedef struct bfd_mach_o_prebound_dylib_command
424 unsigned long cmd; /* LC_PREBOUND_DYLIB. */
425 unsigned long cmdsize; /* Includes strings. */
426 unsigned long name; /* Library's path name. */
427 unsigned long nmodules; /* Number of modules in library. */
428 unsigned long linked_modules; /* Bit vector of linked modules. */
429 asection *section;
431 bfd_mach_o_prebound_dylib_command;
433 typedef struct bfd_mach_o_load_command
435 bfd_mach_o_load_command_type type;
436 unsigned int type_required;
437 bfd_vma offset;
438 bfd_vma len;
439 union
441 bfd_mach_o_segment_command segment;
442 bfd_mach_o_symtab_command symtab;
443 bfd_mach_o_dysymtab_command dysymtab;
444 bfd_mach_o_thread_command thread;
445 bfd_mach_o_dylib_command dylib;
446 bfd_mach_o_dylinker_command dylinker;
447 bfd_mach_o_prebound_dylib_command prebound_dylib;
449 command;
451 bfd_mach_o_load_command;
453 typedef struct mach_o_data_struct
455 bfd_mach_o_header header;
456 bfd_mach_o_load_command *commands;
457 unsigned long nsymbols;
458 asymbol *symbols;
459 unsigned long nsects;
460 bfd_mach_o_section **sections;
461 bfd *ibfd;
463 mach_o_data_struct;
465 typedef struct mach_o_data_struct bfd_mach_o_data_struct;
467 bfd_boolean bfd_mach_o_valid (bfd *);
468 int bfd_mach_o_scan_read_symtab_symbol (bfd *, bfd_mach_o_symtab_command *, asymbol *, unsigned long);
469 int bfd_mach_o_scan_read_symtab_strtab (bfd *, bfd_mach_o_symtab_command *);
470 int bfd_mach_o_scan_read_symtab_symbols (bfd *, bfd_mach_o_symtab_command *);
471 int bfd_mach_o_scan_read_dysymtab_symbol (bfd *, bfd_mach_o_dysymtab_command *, bfd_mach_o_symtab_command *, asymbol *, unsigned long);
472 int bfd_mach_o_scan_start_address (bfd *);
473 int bfd_mach_o_scan (bfd *, bfd_mach_o_header *, bfd_mach_o_data_struct *);
474 bfd_boolean bfd_mach_o_mkobject (bfd *);
475 const bfd_target * bfd_mach_o_object_p (bfd *);
476 const bfd_target * bfd_mach_o_core_p (bfd *);
477 const bfd_target * bfd_mach_o_archive_p (bfd *);
478 bfd * bfd_mach_o_openr_next_archived_file (bfd *, bfd *);
479 int bfd_mach_o_lookup_section (bfd *, asection *, bfd_mach_o_load_command **, bfd_mach_o_section **);
480 int bfd_mach_o_lookup_command (bfd *, bfd_mach_o_load_command_type, bfd_mach_o_load_command **);
481 unsigned long bfd_mach_o_stack_addr (enum bfd_mach_o_cpu_type);
482 int bfd_mach_o_core_fetch_environment (bfd *, unsigned char **, unsigned int *);
483 char * bfd_mach_o_core_file_failing_command (bfd *);
484 int bfd_mach_o_core_file_failing_signal (bfd *);
485 bfd_boolean bfd_mach_o_core_file_matches_executable_p (bfd *, bfd *);
487 extern const bfd_target mach_o_be_vec;
488 extern const bfd_target mach_o_le_vec;
489 extern const bfd_target mach_o_fat_vec;
491 #endif /* _BFD_MACH_O_H_ */