1 /* Mach-O support for BFD.
2 Copyright (C) 1999-2014 Free Software Foundation, Inc.
4 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
21 #ifndef _BFD_MACH_O_H_
22 #define _BFD_MACH_O_H_
25 #include "mach-o/loader.h"
27 typedef struct bfd_mach_o_header
30 unsigned long cputype;
31 unsigned long cpusubtype;
32 unsigned long filetype;
34 unsigned long sizeofcmds;
36 unsigned int reserved;
37 /* Version 1: 32 bits, version 2: 64 bits. */
39 enum bfd_endian byteorder;
43 typedef struct bfd_mach_o_asymbol
45 /* The actual symbol which the rest of BFD works with. */
48 /* Mach-O symbol fields. */
51 unsigned short n_desc;
55 #define BFD_MACH_O_SEGNAME_SIZE 16
56 #define BFD_MACH_O_SECTNAME_SIZE 16
58 typedef struct bfd_mach_o_section
60 /* Fields present in the file. */
61 char sectname[BFD_MACH_O_SECTNAME_SIZE + 1]; /* Always NUL padded. */
62 char segname[BFD_MACH_O_SEGNAME_SIZE + 1];
70 unsigned long reserved1;
71 unsigned long reserved2;
72 unsigned long reserved3;
74 /* Corresponding bfd section. */
77 /* An array holding the indirect symbols for this section.
78 NULL values indicate local symbols.
79 The number of symbols is determined from the section size and type. */
81 bfd_mach_o_asymbol **indirect_syms;
83 /* Simply linked list. */
84 struct bfd_mach_o_section *next;
88 typedef struct bfd_mach_o_segment_command
90 char segname[BFD_MACH_O_SEGNAME_SIZE + 1];
94 unsigned long filesize;
95 unsigned long maxprot; /* Maximum permitted protection. */
96 unsigned long initprot; /* Initial protection. */
100 /* Linked list of sections. */
101 bfd_mach_o_section *sect_head;
102 bfd_mach_o_section *sect_tail;
104 bfd_mach_o_segment_command;
106 /* Protection flags. */
107 #define BFD_MACH_O_PROT_READ 0x01
108 #define BFD_MACH_O_PROT_WRITE 0x02
109 #define BFD_MACH_O_PROT_EXECUTE 0x04
111 /* Expanded internal representation of a relocation entry. */
112 typedef struct bfd_mach_o_reloc_info
116 unsigned int r_scattered : 1;
117 unsigned int r_type : 4;
118 unsigned int r_pcrel : 1;
119 unsigned int r_length : 2;
120 unsigned int r_extern : 1;
122 bfd_mach_o_reloc_info;
124 /* The symbol table is sorted like this:
126 (otherwise in order of generation)
129 (3) external undefined / common
133 typedef struct bfd_mach_o_symtab_command
138 unsigned int strsize;
139 bfd_mach_o_asymbol *symbols;
142 bfd_mach_o_symtab_command;
144 /* This is the second set of the symbolic information which is used to support
145 the data structures for the dynamically link editor.
147 The original set of symbolic information in the symtab_command which contains
148 the symbol and string tables must also be present when this load command is
149 present. When this load command is present the symbol table is organized
150 into three groups of symbols:
151 local symbols (static and debugging symbols) - grouped by module
152 defined external symbols - grouped by module (sorted by name if not lib)
153 undefined external symbols (sorted by name)
154 In this load command there are offsets and counts to each of the three groups
157 This load command contains a the offsets and sizes of the following new
158 symbolic information tables:
161 reference symbol table
162 indirect symbol table
163 The first three tables above (the table of contents, module table and
164 reference symbol table) are only present if the file is a dynamically linked
165 shared library. For executable and object modules, which are files
166 containing only one module, the information that would be in these three
167 tables is determined as follows:
168 table of contents - the defined external symbols are sorted by name
169 module table - the file contains only one module so everything in the
170 file is part of the module.
171 reference symbol table - is the defined and undefined external symbols
173 For dynamically linked shared library files this load command also contains
174 offsets and sizes to the pool of relocation entries for all sections
175 separated into two groups:
176 external relocation entries
177 local relocation entries
178 For executable and object modules the relocation entries continue to hang
179 off the section structures. */
181 typedef struct bfd_mach_o_dylib_module
183 /* Index into the string table indicating the name of the module. */
184 unsigned long module_name_idx;
187 /* Index into the symbol table of the first defined external symbol provided
189 unsigned long iextdefsym;
191 /* Number of external symbols provided by this module. */
192 unsigned long nextdefsym;
194 /* Index into the external reference table of the first entry
195 provided by this module. */
196 unsigned long irefsym;
198 /* Number of external reference entries provided by this module. */
199 unsigned long nrefsym;
201 /* Index into the symbol table of the first local symbol provided by this
203 unsigned long ilocalsym;
205 /* Number of local symbols provided by this module. */
206 unsigned long nlocalsym;
208 /* Index into the external relocation table of the first entry provided
210 unsigned long iextrel;
212 /* Number of external relocation entries provided by this module. */
213 unsigned long nextrel;
215 /* Index in the module initialization section to the pointers for this
217 unsigned short iinit;
219 /* Index in the module termination section to the pointers for this
221 unsigned short iterm;
223 /* Number of pointers in the module initialization for this module. */
224 unsigned short ninit;
226 /* Number of pointers in the module termination for this module. */
227 unsigned short nterm;
229 /* Number of data byte for this module that are used in the __module_info
230 section of the __OBJC segment. */
231 unsigned long objc_module_info_size;
233 /* Statically linked address of the start of the data for this module
234 in the __module_info section of the __OBJC_segment. */
235 bfd_vma objc_module_info_addr;
237 bfd_mach_o_dylib_module;
239 typedef struct bfd_mach_o_dylib_table_of_content
241 /* Index into the symbol table to the defined external symbol. */
242 unsigned long symbol_index;
244 /* Index into the module table to the module for this entry. */
245 unsigned long module_index;
247 bfd_mach_o_dylib_table_of_content;
249 typedef struct bfd_mach_o_dylib_reference
251 /* Index into the symbol table for the symbol being referenced. */
254 /* Type of the reference being made (use REFERENCE_FLAGS constants). */
257 bfd_mach_o_dylib_reference;
258 #define BFD_MACH_O_REFERENCE_SIZE 4
260 typedef struct bfd_mach_o_dysymtab_command
262 /* The symbols indicated by symoff and nsyms of the LC_SYMTAB load command
263 are grouped into the following three groups:
264 local symbols (further grouped by the module they are from)
265 defined external symbols (further grouped by the module they are from)
268 The local symbols are used only for debugging. The dynamic binding
269 process may have to use them to indicate to the debugger the local
270 symbols for a module that is being bound.
272 The last two groups are used by the dynamic binding process to do the
273 binding (indirectly through the module table and the reference symbol
274 table when this is a dynamically linked shared library file). */
276 unsigned long ilocalsym; /* Index to local symbols. */
277 unsigned long nlocalsym; /* Number of local symbols. */
278 unsigned long iextdefsym; /* Index to externally defined symbols. */
279 unsigned long nextdefsym; /* Number of externally defined symbols. */
280 unsigned long iundefsym; /* Index to undefined symbols. */
281 unsigned long nundefsym; /* Number of undefined symbols. */
283 /* For the for the dynamic binding process to find which module a symbol
284 is defined in the table of contents is used (analogous to the ranlib
285 structure in an archive) which maps defined external symbols to modules
286 they are defined in. This exists only in a dynamically linked shared
287 library file. For executable and object modules the defined external
288 symbols are sorted by name and is use as the table of contents. */
290 unsigned long tocoff; /* File offset to table of contents. */
291 unsigned long ntoc; /* Number of entries in table of contents. */
293 /* To support dynamic binding of "modules" (whole object files) the symbol
294 table must reflect the modules that the file was created from. This is
295 done by having a module table that has indexes and counts into the merged
296 tables for each module. The module structure that these two entries
297 refer to is described below. This exists only in a dynamically linked
298 shared library file. For executable and object modules the file only
299 contains one module so everything in the file belongs to the module. */
301 unsigned long modtaboff; /* File offset to module table. */
302 unsigned long nmodtab; /* Number of module table entries. */
304 /* To support dynamic module binding the module structure for each module
305 indicates the external references (defined and undefined) each module
306 makes. For each module there is an offset and a count into the
307 reference symbol table for the symbols that the module references.
308 This exists only in a dynamically linked shared library file. For
309 executable and object modules the defined external symbols and the
310 undefined external symbols indicates the external references. */
312 unsigned long extrefsymoff; /* Offset to referenced symbol table. */
313 unsigned long nextrefsyms; /* Number of referenced symbol table entries. */
315 /* The sections that contain "symbol pointers" and "routine stubs" have
316 indexes and (implied counts based on the size of the section and fixed
317 size of the entry) into the "indirect symbol" table for each pointer
318 and stub. For every section of these two types the index into the
319 indirect symbol table is stored in the section header in the field
320 reserved1. An indirect symbol table entry is simply a 32bit index into
321 the symbol table to the symbol that the pointer or stub is referring to.
322 The indirect symbol table is ordered to match the entries in the section. */
324 unsigned long indirectsymoff; /* File offset to the indirect symbol table. */
325 unsigned long nindirectsyms; /* Number of indirect symbol table entries. */
327 /* To support relocating an individual module in a library file quickly the
328 external relocation entries for each module in the library need to be
329 accessed efficiently. Since the relocation entries can't be accessed
330 through the section headers for a library file they are separated into
331 groups of local and external entries further grouped by module. In this
332 case the presents of this load command who's extreloff, nextrel,
333 locreloff and nlocrel fields are non-zero indicates that the relocation
334 entries of non-merged sections are not referenced through the section
335 structures (and the reloff and nreloc fields in the section headers are
338 Since the relocation entries are not accessed through the section headers
339 this requires the r_address field to be something other than a section
340 offset to identify the item to be relocated. In this case r_address is
341 set to the offset from the vmaddr of the first LC_SEGMENT command.
343 The relocation entries are grouped by module and the module table
344 entries have indexes and counts into them for the group of external
345 relocation entries for that the module.
347 For sections that are merged across modules there must not be any
348 remaining external relocation entries for them (for merged sections
349 remaining relocation entries must be local). */
351 unsigned long extreloff; /* Offset to external relocation entries. */
352 unsigned long nextrel; /* Number of external relocation entries. */
354 /* All the local relocation entries are grouped together (they are not
355 grouped by their module since they are only used if the object is moved
356 from it statically link edited address). */
358 unsigned long locreloff; /* Offset to local relocation entries. */
359 unsigned long nlocrel; /* Number of local relocation entries. */
361 bfd_mach_o_dylib_module *dylib_module;
362 bfd_mach_o_dylib_table_of_content *dylib_toc;
363 unsigned int *indirect_syms;
364 bfd_mach_o_dylib_reference *ext_refs;
366 bfd_mach_o_dysymtab_command;
368 /* An indirect symbol table entry is simply a 32bit index into the symbol table
369 to the symbol that the pointer or stub is refering to. Unless it is for a
370 non-lazy symbol pointer section for a defined symbol which strip(1) has
371 removed. In which case it has the value INDIRECT_SYMBOL_LOCAL. If the
372 symbol was also absolute INDIRECT_SYMBOL_ABS is or'ed with that. */
374 #define BFD_MACH_O_INDIRECT_SYMBOL_LOCAL 0x80000000
375 #define BFD_MACH_O_INDIRECT_SYMBOL_ABS 0x40000000
376 #define BFD_MACH_O_INDIRECT_SYMBOL_SIZE 4
378 /* For LC_THREAD or LC_UNIXTHREAD. */
380 typedef struct bfd_mach_o_thread_flavour
382 unsigned long flavour;
383 unsigned long offset;
386 bfd_mach_o_thread_flavour;
388 typedef struct bfd_mach_o_thread_command
390 unsigned long nflavours;
391 bfd_mach_o_thread_flavour *flavours;
394 bfd_mach_o_thread_command;
396 /* For LC_LOAD_DYLINKER and LC_ID_DYLINKER. */
398 typedef struct bfd_mach_o_dylinker_command
400 unsigned long name_offset; /* Offset to library's path name. */
401 unsigned long name_len; /* Offset to library's path name. */
404 bfd_mach_o_dylinker_command;
406 /* For LC_LOAD_DYLIB, LC_LOAD_WEAK_DYLIB, LC_ID_DYLIB
407 or LC_REEXPORT_DYLIB. */
409 typedef struct bfd_mach_o_dylib_command
411 unsigned long name_offset; /* Offset to library's path name. */
412 unsigned long name_len; /* Offset to library's path name. */
413 unsigned long timestamp; /* Library's build time stamp. */
414 unsigned long current_version; /* Library's current version number. */
415 unsigned long compatibility_version; /* Library's compatibility vers number. */
418 bfd_mach_o_dylib_command;
420 /* For LC_PREBOUND_DYLIB. */
422 typedef struct bfd_mach_o_prebound_dylib_command
424 unsigned long name; /* Library's path name. */
425 unsigned long nmodules; /* Number of modules in library. */
426 unsigned long linked_modules; /* Bit vector of linked modules. */
428 bfd_mach_o_prebound_dylib_command;
432 typedef struct bfd_mach_o_uuid_command
434 unsigned char uuid[16];
436 bfd_mach_o_uuid_command;
438 /* For LC_CODE_SIGNATURE or LC_SEGMENT_SPLIT_INFO. */
440 typedef struct bfd_mach_o_linkedit_command
442 unsigned long dataoff;
443 unsigned long datasize;
445 bfd_mach_o_linkedit_command;
447 typedef struct bfd_mach_o_str_command
449 unsigned long stroff;
450 unsigned long str_len;
453 bfd_mach_o_str_command;
455 typedef struct bfd_mach_o_fvmlib_command
457 unsigned int name_offset;
458 unsigned int name_len;
460 unsigned int minor_version;
461 unsigned int header_addr;
463 bfd_mach_o_fvmlib_command;
465 typedef struct bfd_mach_o_dyld_info_command
467 /* File offset and size to rebase info. */
468 unsigned int rebase_off;
469 unsigned int rebase_size;
471 /* File offset and size of binding info. */
472 unsigned int bind_off;
473 unsigned int bind_size;
475 /* File offset and size of weak binding info. */
476 unsigned int weak_bind_off;
477 unsigned int weak_bind_size;
479 /* File offset and size of lazy binding info. */
480 unsigned int lazy_bind_off;
481 unsigned int lazy_bind_size;
483 /* File offset and size of export info. */
484 unsigned int export_off;
485 unsigned int export_size;
487 bfd_mach_o_dyld_info_command;
489 typedef struct bfd_mach_o_version_min_command
494 unsigned int reserved;
496 bfd_mach_o_version_min_command;
498 typedef struct bfd_mach_o_encryption_info_command
500 unsigned int cryptoff;
501 unsigned int cryptsize;
502 unsigned int cryptid;
504 bfd_mach_o_encryption_info_command;
506 typedef struct bfd_mach_o_main_command
508 bfd_uint64_t entryoff;
509 bfd_uint64_t stacksize;
511 bfd_mach_o_main_command;
513 typedef struct bfd_mach_o_source_version_command
521 bfd_mach_o_source_version_command;
523 typedef struct bfd_mach_o_load_command
525 bfd_mach_o_load_command_type type;
526 bfd_boolean type_required;
531 bfd_mach_o_segment_command segment;
532 bfd_mach_o_symtab_command symtab;
533 bfd_mach_o_dysymtab_command dysymtab;
534 bfd_mach_o_thread_command thread;
535 bfd_mach_o_dylib_command dylib;
536 bfd_mach_o_dylinker_command dylinker;
537 bfd_mach_o_prebound_dylib_command prebound_dylib;
538 bfd_mach_o_uuid_command uuid;
539 bfd_mach_o_linkedit_command linkedit;
540 bfd_mach_o_str_command str;
541 bfd_mach_o_dyld_info_command dyld_info;
542 bfd_mach_o_version_min_command version_min;
543 bfd_mach_o_encryption_info_command encryption_info;
544 bfd_mach_o_fvmlib_command fvmlib;
545 bfd_mach_o_main_command main;
546 bfd_mach_o_source_version_command source_version;
550 bfd_mach_o_load_command;
552 typedef struct mach_o_data_struct
555 bfd_mach_o_header header;
556 /* Array of load commands (length is given by header.ncmds). */
557 bfd_mach_o_load_command *commands;
559 /* Flatten array of sections. The array is 0-based. */
560 unsigned long nsects;
561 bfd_mach_o_section **sections;
563 /* Used while writing: current length of the output file. This is used
564 to allocate space in the file. */
567 /* As symtab is referenced by other load command, it is handy to have
568 a direct access to it. Although it is not clearly stated, only one symtab
570 bfd_mach_o_symtab_command *symtab;
571 bfd_mach_o_dysymtab_command *dysymtab;
573 /* A place to stash dwarf2 info for this bfd. */
574 void *dwarf2_find_line_info;
576 /* BFD of .dSYM file. */
579 /* Cache of dynamic relocs. */
580 arelent *dyn_reloc_cache;
582 bfd_mach_o_data_struct;
584 typedef struct bfd_mach_o_xlat_name
589 bfd_mach_o_xlat_name;
591 /* Target specific routines. */
593 #define bfd_mach_o_get_data(abfd) ((abfd)->tdata.mach_o_data)
594 #define bfd_mach_o_get_backend_data(abfd) \
595 ((bfd_mach_o_backend_data*)(abfd)->xvec->backend_data)
597 /* Get the Mach-O header for section SEC. */
598 #define bfd_mach_o_get_mach_o_section(sec) \
599 ((bfd_mach_o_section *)(sec)->used_by_bfd)
601 bfd_boolean bfd_mach_o_valid (bfd *);
602 bfd_boolean bfd_mach_o_mkobject_init (bfd *);
603 const bfd_target *bfd_mach_o_object_p (bfd *);
604 const bfd_target *bfd_mach_o_core_p (bfd *);
605 const bfd_target *bfd_mach_o_archive_p (bfd *);
606 bfd *bfd_mach_o_openr_next_archived_file (bfd *, bfd *);
607 bfd_boolean bfd_mach_o_set_arch_mach (bfd *, enum bfd_architecture,
609 int bfd_mach_o_lookup_command (bfd *, bfd_mach_o_load_command_type, bfd_mach_o_load_command **);
610 bfd_boolean bfd_mach_o_new_section_hook (bfd *, asection *);
611 bfd_boolean bfd_mach_o_write_contents (bfd *);
612 bfd_boolean bfd_mach_o_bfd_copy_private_symbol_data (bfd *, asymbol *,
614 bfd_boolean bfd_mach_o_bfd_copy_private_section_data (bfd *, asection *,
616 bfd_boolean bfd_mach_o_bfd_copy_private_bfd_data (bfd *, bfd *);
617 bfd_boolean bfd_mach_o_bfd_set_private_flags (bfd *, flagword);
618 long bfd_mach_o_get_symtab_upper_bound (bfd *);
619 long bfd_mach_o_canonicalize_symtab (bfd *, asymbol **);
620 long bfd_mach_o_get_synthetic_symtab (bfd *, long, asymbol **, long,
621 asymbol **, asymbol **ret);
622 long bfd_mach_o_get_reloc_upper_bound (bfd *, asection *);
623 long bfd_mach_o_canonicalize_reloc (bfd *, asection *, arelent **, asymbol **);
624 long bfd_mach_o_get_dynamic_reloc_upper_bound (bfd *);
625 long bfd_mach_o_canonicalize_dynamic_reloc (bfd *, arelent **, asymbol **);
626 asymbol *bfd_mach_o_make_empty_symbol (bfd *);
627 void bfd_mach_o_get_symbol_info (bfd *, asymbol *, symbol_info *);
628 void bfd_mach_o_print_symbol (bfd *, void *, asymbol *, bfd_print_symbol_type);
629 int bfd_mach_o_sizeof_headers (bfd *, struct bfd_link_info *);
630 unsigned long bfd_mach_o_stack_addr (enum bfd_mach_o_cpu_type);
631 int bfd_mach_o_core_fetch_environment (bfd *, unsigned char **, unsigned int *);
632 char *bfd_mach_o_core_file_failing_command (bfd *);
633 int bfd_mach_o_core_file_failing_signal (bfd *);
634 bfd_boolean bfd_mach_o_core_file_matches_executable_p (bfd *, bfd *);
635 bfd *bfd_mach_o_fat_extract (bfd *, bfd_format , const bfd_arch_info_type *);
636 const bfd_target *bfd_mach_o_header_p (bfd *, bfd_mach_o_filetype,
637 bfd_mach_o_cpu_type);
638 bfd_boolean bfd_mach_o_build_commands (bfd *);
639 bfd_boolean bfd_mach_o_set_section_contents (bfd *, asection *, const void *,
640 file_ptr, bfd_size_type);
641 unsigned int bfd_mach_o_version (bfd *);
643 unsigned int bfd_mach_o_get_section_type_from_name (bfd *, const char *);
644 unsigned int bfd_mach_o_get_section_attribute_from_name (const char *);
646 void bfd_mach_o_convert_section_name_to_bfd (bfd *, const char *, const char *,
647 const char **, flagword *);
648 bfd_boolean bfd_mach_o_find_nearest_line (bfd *, asection *, asymbol **,
649 bfd_vma, const char **,
650 const char **, unsigned int *);
651 bfd_boolean bfd_mach_o_close_and_cleanup (bfd *);
652 bfd_boolean bfd_mach_o_free_cached_info (bfd *);
654 unsigned int bfd_mach_o_section_get_nbr_indirect (bfd *, bfd_mach_o_section *);
655 unsigned int bfd_mach_o_section_get_entry_size (bfd *, bfd_mach_o_section *);
656 bfd_boolean bfd_mach_o_read_symtab_symbols (bfd *);
657 bfd_boolean bfd_mach_o_read_symtab_strtab (bfd *abfd);
659 bfd_vma bfd_mach_o_get_base_address (bfd *);
661 /* A placeholder in case we need to suppress emitting the dysymtab for some
662 reason (e.g. compatibility with older system versions). */
663 #define bfd_mach_o_should_emit_dysymtab(x) TRUE
665 extern const bfd_mach_o_xlat_name bfd_mach_o_section_attribute_name[];
666 extern const bfd_mach_o_xlat_name bfd_mach_o_section_type_name[];
668 extern const bfd_target mach_o_fat_vec;
670 /* Interfaces between BFD names and Mach-O names. */
672 typedef struct mach_o_section_name_xlat
674 const char *bfd_name;
675 const char *mach_o_name;
677 unsigned int macho_sectype;
678 unsigned int macho_secattr;
679 unsigned int sectalign;
680 } mach_o_section_name_xlat;
682 typedef struct mach_o_segment_name_xlat
685 const mach_o_section_name_xlat *sections;
686 } mach_o_segment_name_xlat;
688 const mach_o_section_name_xlat *
689 bfd_mach_o_section_data_for_mach_sect (bfd *, const char *, const char *);
690 const mach_o_section_name_xlat *
691 bfd_mach_o_section_data_for_bfd_name (bfd *, const char *, const char **);
693 typedef struct bfd_mach_o_backend_data
695 enum bfd_architecture arch;
696 bfd_boolean (*_bfd_mach_o_swap_reloc_in)(arelent *, bfd_mach_o_reloc_info *);
697 bfd_boolean (*_bfd_mach_o_swap_reloc_out)(arelent *, bfd_mach_o_reloc_info *);
698 bfd_boolean (*_bfd_mach_o_print_thread)(bfd *, bfd_mach_o_thread_flavour *,
700 const mach_o_segment_name_xlat *segsec_names_xlat;
701 bfd_boolean (*bfd_mach_o_section_type_valid_for_target) (unsigned long);
703 bfd_mach_o_backend_data;
705 /* Values used in symbol.udata.i, to signal that the mach-o-specific data in the
706 symbol are not yet set, or need validation (where this is possible). */
708 #define SYM_MACHO_FIELDS_UNSET ((bfd_vma) -1)
709 #define SYM_MACHO_FIELDS_NOT_VALIDATED ((bfd_vma) -2)
711 #endif /* _BFD_MACH_O_H_ */