1 /* BFD COFF object file private structure.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22 MA 02110-1301, USA. */
26 /* Object file tdata; access macros. */
28 #define coff_data(bfd) ((bfd)->tdata.coff_obj_data)
29 #define obj_pe(bfd) (coff_data (bfd)->pe)
30 #define obj_symbols(bfd) (coff_data (bfd)->symbols)
31 #define obj_sym_filepos(bfd) (coff_data (bfd)->sym_filepos)
32 #define obj_relocbase(bfd) (coff_data (bfd)->relocbase)
33 #define obj_raw_syments(bfd) (coff_data (bfd)->raw_syments)
34 #define obj_raw_syment_count(bfd) (coff_data (bfd)->raw_syment_count)
35 #define obj_convert(bfd) (coff_data (bfd)->conversion_table)
36 #define obj_conv_table_size(bfd) (coff_data (bfd)->conv_table_size)
37 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
38 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
39 #define obj_coff_strings(bfd) (coff_data (bfd)->strings)
40 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
41 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
42 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
43 #define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
45 /* `Tdata' information kept for COFF files. */
47 typedef struct coff_tdata
49 struct coff_symbol_struct
*symbols
; /* Symtab for input bfd. */
50 unsigned int *conversion_table
;
54 struct coff_ptr_struct
*raw_syments
;
55 unsigned long raw_syment_count
;
57 /* These are only valid once writing has begun. */
60 /* These members communicate important constants about the symbol table
61 to GDB's symbol-reading code. These `constants' unfortunately vary
62 from coff implementation to implementation... */
63 unsigned local_n_btmask
;
64 unsigned local_n_btshft
;
65 unsigned local_n_tmask
;
66 unsigned local_n_tshift
;
67 unsigned local_symesz
;
68 unsigned local_auxesz
;
69 unsigned local_linesz
;
71 /* The unswapped external symbols. May be NULL. Read by
72 _bfd_coff_get_external_symbols. */
74 /* If this is TRUE, the external_syms may not be freed. */
75 bfd_boolean keep_syms
;
77 /* The string table. May be NULL. Read by
78 _bfd_coff_read_string_table. */
80 /* If this is TRUE, the strings may not be freed. */
81 bfd_boolean keep_strings
;
82 /* If this is TRUE, the strings have been written out already. */
83 bfd_boolean strings_written
;
85 /* Is this a PE format coff file? */
87 /* Used by the COFF backend linker. */
88 struct coff_link_hash_entry
**sym_hashes
;
90 /* Used by the pe linker for PowerPC. */
91 int *local_toc_sym_map
;
93 struct bfd_link_info
*link_info
;
95 /* Used by coff_find_nearest_line. */
98 /* A place to stash dwarf2 info for this bfd. */
99 void * dwarf2_find_line_info
;
101 /* The timestamp from the COFF file header. */
104 /* Copy of some of the f_flags bits in the COFF filehdr structure,
108 /* coff-stgo32 EXE stub header after BFD tdata has been allocated. Its data
109 is kept in internal_filehdr.go32stub beforehand. */
113 /* Tdata for pe image files. */
114 typedef struct pe_tdata
117 struct internal_extra_pe_aouthdr pe_opthdr
;
119 int has_reloc_section
;
120 int dont_strip_reloc
;
121 bfd_boolean (*in_reloc_p
) (bfd
*, reloc_howto_type
*);
125 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
127 /* Tdata for XCOFF files. */
131 /* Basic COFF information. */
134 /* TRUE if this is an XCOFF64 file. */
137 /* TRUE if a large a.out header should be generated. */
138 bfd_boolean full_aouthdr
;
143 /* Index of section holding TOC. */
146 /* Index of section holding entry point. */
149 /* .text alignment from optional header. */
150 int text_align_power
;
152 /* .data alignment from optional header. */
153 int data_align_power
;
155 /* modtype from optional header. */
158 /* cputype from optional header. */
161 /* maxdata from optional header. */
164 /* maxstack from optional header. */
167 /* Used by the XCOFF backend linker. */
170 unsigned int *lineno_counts
;
171 unsigned int import_file_id
;
174 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
176 /* We take the address of the first element of an asymbol to ensure that the
177 macro is only ever applied to an asymbol. */
178 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
180 /* The used_by_bfd field of a section may be set to a pointer to this
183 struct coff_section_tdata
185 /* The relocs, swapped into COFF internal form. This may be NULL. */
186 struct internal_reloc
*relocs
;
187 /* If this is TRUE, the relocs entry may not be freed. */
188 bfd_boolean keep_relocs
;
189 /* The section contents. This may be NULL. */
191 /* If this is TRUE, the contents entry may not be freed. */
192 bfd_boolean keep_contents
;
193 /* Information cached by coff_find_nearest_line. */
196 const char *function
;
197 /* Optional information about a COMDAT entry; NULL if not COMDAT. */
198 struct coff_comdat_info
*comdat
;
200 /* A pointer used for .stab linking optimizations. */
202 /* Available for individual backends. */
206 /* An accessor macro for the coff_section_tdata structure. */
207 #define coff_section_data(abfd, sec) \
208 ((struct coff_section_tdata *) (sec)->used_by_bfd)
210 /* Tdata for sections in XCOFF files. This is used by the linker. */
212 struct xcoff_section_tdata
214 /* Used for XCOFF csects created by the linker; points to the real
215 XCOFF section which contains this csect. */
217 /* The lineno_count field for the enclosing section, because we are
218 going to clobber it there. */
219 unsigned int lineno_count
;
220 /* The first and last symbol indices for symbols used by this csect. */
221 unsigned long first_symndx
;
222 unsigned long last_symndx
;
225 /* An accessor macro the xcoff_section_tdata structure. */
226 #define xcoff_section_data(abfd, sec) \
227 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
229 /* Tdata for sections in PE files. */
231 struct pei_section_tdata
233 /* The virtual size of the section. */
234 bfd_size_type virt_size
;
235 /* The PE section flags. */
239 /* An accessor macro for the pei_section_tdata structure. */
240 #define pei_section_data(abfd, sec) \
241 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
243 /* COFF linker hash table entries. */
245 struct coff_link_hash_entry
247 struct bfd_link_hash_entry root
;
249 /* Symbol index in output file. Set to -1 initially. Set to -2 if
250 there is a reloc against this symbol. */
257 unsigned char symbol_class
;
259 /* Number of auxiliary entries. */
262 /* BFD to take auxiliary entries from. */
265 /* Pointer to array of auxiliary entries, if any. */
266 union internal_auxent
*aux
;
268 /* Flag word; legal values follow. */
269 unsigned short coff_link_hash_flags
;
270 /* Symbol is a PE section symbol. */
271 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
274 /* COFF linker hash table. */
276 struct coff_link_hash_table
278 struct bfd_link_hash_table root
;
279 /* A pointer to information used to link stabs in sections. */
280 struct stab_info stab_info
;
283 /* Look up an entry in a COFF linker hash table. */
285 #define coff_link_hash_lookup(table, string, create, copy, follow) \
286 ((struct coff_link_hash_entry *) \
287 bfd_link_hash_lookup (&(table)->root, (string), (create), \
290 /* Traverse a COFF linker hash table. */
292 #define coff_link_hash_traverse(table, func, info) \
293 (bfd_link_hash_traverse \
295 (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
298 /* Get the COFF linker hash table from a link_info structure. */
300 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
302 /* Functions in coffgen.c. */
303 extern const bfd_target
*coff_object_p
305 extern struct bfd_section
*coff_section_from_bfd_index
307 extern long coff_get_symtab_upper_bound
309 extern long coff_canonicalize_symtab
311 extern int coff_count_linenumbers
313 extern struct coff_symbol_struct
*coff_symbol_from
315 extern bfd_boolean coff_renumber_symbols
317 extern void coff_mangle_symbols
319 extern bfd_boolean coff_write_symbols
321 extern bfd_boolean coff_write_alien_symbol
322 (bfd
*, asymbol
*, struct internal_syment
*, bfd_vma
*,
323 bfd_size_type
*, asection
**, bfd_size_type
*);
324 extern bfd_boolean coff_write_linenumbers
326 extern alent
*coff_get_lineno
328 extern asymbol
*coff_section_symbol
330 extern bfd_boolean _bfd_coff_get_external_symbols
332 extern const char *_bfd_coff_read_string_table
334 extern bfd_boolean _bfd_coff_free_symbols
336 extern struct coff_ptr_struct
*coff_get_normalized_symtab
338 extern long coff_get_reloc_upper_bound
340 extern asymbol
*coff_make_empty_symbol
342 extern void coff_print_symbol
343 (bfd
*, void * filep
, asymbol
*, bfd_print_symbol_type
);
344 extern void coff_get_symbol_info
345 (bfd
*, asymbol
*, symbol_info
*ret
);
346 extern bfd_boolean _bfd_coff_is_local_label_name
347 (bfd
*, const char *);
348 extern asymbol
*coff_bfd_make_debug_symbol
349 (bfd
*, void *, unsigned long);
350 extern bfd_boolean coff_find_nearest_line
351 (bfd
*, asection
*, asymbol
**, bfd_vma
, const char **,
352 const char **, unsigned int *);
353 extern bfd_boolean coff_find_nearest_line_discriminator
354 (bfd
*, asection
*, asymbol
**, bfd_vma
, const char **,
355 const char **, unsigned int *, unsigned int *);
356 struct dwarf_debug_section
;
357 extern bfd_boolean coff_find_nearest_line_with_names
358 (bfd
*, const struct dwarf_debug_section
*, asection
*, asymbol
**,
359 bfd_vma
, const char **, const char **, unsigned int *);
360 extern bfd_boolean coff_find_inliner_info
361 (bfd
*, const char **, const char **, unsigned int *);
362 extern int coff_sizeof_headers
363 (bfd
*, struct bfd_link_info
*);
364 extern bfd_boolean bfd_coff_reloc16_relax_section
365 (bfd
*, asection
*, struct bfd_link_info
*, bfd_boolean
*);
366 extern bfd_byte
*bfd_coff_reloc16_get_relocated_section_contents
367 (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
368 bfd_byte
*, bfd_boolean
, asymbol
**);
369 extern bfd_vma bfd_coff_reloc16_get_value
370 (arelent
*, struct bfd_link_info
*, asection
*);
371 extern void bfd_perform_slip
372 (bfd
*, unsigned int, asection
*, bfd_vma
);
374 /* Functions and types in cofflink.c. */
376 #define STRING_SIZE_SIZE 4
378 /* We use a hash table to merge identical enum, struct, and union
379 definitions in the linker. */
381 /* Information we keep for a single element (an enum value, a
382 structure or union field) in the debug merge hash table. */
384 struct coff_debug_merge_element
387 struct coff_debug_merge_element
*next
;
395 /* Symbol index for complex type. */
399 /* A linked list of debug merge entries for a given name. */
401 struct coff_debug_merge_type
403 /* Next type with the same name. */
404 struct coff_debug_merge_type
*next
;
409 /* Symbol index where this type is defined. */
412 /* List of elements. */
413 struct coff_debug_merge_element
*elements
;
416 /* Information we store in the debug merge hash table. */
418 struct coff_debug_merge_hash_entry
420 struct bfd_hash_entry root
;
422 /* A list of types with this name. */
423 struct coff_debug_merge_type
*types
;
426 /* The debug merge hash table. */
428 struct coff_debug_merge_hash_table
430 struct bfd_hash_table root
;
433 /* Initialize a COFF debug merge hash table. */
435 #define coff_debug_merge_hash_table_init(table) \
436 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
437 sizeof (struct coff_debug_merge_hash_entry)))
439 /* Free a COFF debug merge hash table. */
441 #define coff_debug_merge_hash_table_free(table) \
442 (bfd_hash_table_free (&(table)->root))
444 /* Look up an entry in a COFF debug merge hash table. */
446 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
447 ((struct coff_debug_merge_hash_entry *) \
448 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
450 /* Information we keep for each section in the output file when doing
451 a relocatable link. */
453 struct coff_link_section_info
455 /* The relocs to be output. */
456 struct internal_reloc
*relocs
;
457 /* For each reloc against a global symbol whose index was not known
458 when the reloc was handled, the global hash table entry. */
459 struct coff_link_hash_entry
**rel_hashes
;
462 /* Information that we pass around while doing the final link step. */
464 struct coff_final_link_info
466 /* General link information. */
467 struct bfd_link_info
*info
;
470 /* Used to indicate failure in traversal routine. */
472 /* If doing "task linking" set only during the time when we want the
473 global symbol writer to convert the storage class of defined global
474 symbols from global to static. */
475 bfd_boolean global_to_static
;
476 /* Hash table for long symbol names. */
477 struct bfd_strtab_hash
*strtab
;
478 /* When doing a relocatable link, an array of information kept for
479 each output section, indexed by the target_index field. */
480 struct coff_link_section_info
*section_info
;
481 /* Symbol index of last C_FILE symbol (-1 if none). */
482 long last_file_index
;
483 /* Contents of last C_FILE symbol. */
484 struct internal_syment last_file
;
485 /* Symbol index of first aux entry of last .bf symbol with an empty
486 endndx field (-1 if none). */
488 /* Contents of last_bf_index aux entry. */
489 union internal_auxent last_bf
;
490 /* Hash table used to merge debug information. */
491 struct coff_debug_merge_hash_table debug_merge
;
492 /* Buffer large enough to hold swapped symbols of any input file. */
493 struct internal_syment
*internal_syms
;
494 /* Buffer large enough to hold sections of symbols of any input file. */
496 /* Buffer large enough to hold output indices of symbols of any
499 /* Buffer large enough to hold output symbols for any input file. */
501 /* Buffer large enough to hold external line numbers for any input
504 /* Buffer large enough to hold any input section. */
506 /* Buffer large enough to hold external relocs of any input section. */
507 bfd_byte
*external_relocs
;
508 /* Buffer large enough to hold swapped relocs of any input section. */
509 struct internal_reloc
*internal_relocs
;
512 /* Most COFF variants have no way to record the alignment of a
513 section. This struct is used to set a specific alignment based on
514 the name of the section. */
516 struct coff_section_alignment_entry
518 /* The section name. */
521 /* This is either (unsigned int) -1, indicating that the section
522 name must match exactly, or it is the number of letters which
523 must match at the start of the name. */
524 unsigned int comparison_length
;
526 /* These macros may be used to fill in the first two fields in a
527 structure initialization. */
528 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
529 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
531 /* Only use this entry if the default section alignment for this
532 target is at least that much (as a power of two). If this field
533 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
534 unsigned int default_alignment_min
;
536 /* Only use this entry if the default section alignment for this
537 target is no greater than this (as a power of two). If this
538 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
539 unsigned int default_alignment_max
;
541 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
543 /* The desired alignment for this section (as a power of two). */
544 unsigned int alignment_power
;
547 extern struct bfd_hash_entry
*_bfd_coff_link_hash_newfunc
548 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
549 extern bfd_boolean _bfd_coff_link_hash_table_init
550 (struct coff_link_hash_table
*, bfd
*,
551 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
552 struct bfd_hash_table
*,
555 extern struct bfd_link_hash_table
*_bfd_coff_link_hash_table_create
557 extern const char *_bfd_coff_internal_syment_name
558 (bfd
*, const struct internal_syment
*, char *);
559 extern bfd_boolean _bfd_coff_section_already_linked
560 (bfd
*, asection
*, struct bfd_link_info
*);
561 extern bfd_boolean _bfd_coff_link_add_symbols
562 (bfd
*, struct bfd_link_info
*);
563 extern bfd_boolean _bfd_coff_final_link
564 (bfd
*, struct bfd_link_info
*);
565 extern struct internal_reloc
*_bfd_coff_read_internal_relocs
566 (bfd
*, asection
*, bfd_boolean
, bfd_byte
*, bfd_boolean
,
567 struct internal_reloc
*);
568 extern bfd_boolean _bfd_coff_generic_relocate_section
569 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
570 struct internal_reloc
*, struct internal_syment
*, asection
**);
571 extern struct bfd_hash_entry
*_bfd_coff_debug_merge_hash_newfunc
572 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
573 extern bfd_boolean _bfd_coff_write_global_sym
574 (struct bfd_hash_entry
*, void *);
575 extern bfd_boolean _bfd_coff_write_task_globals
576 (struct coff_link_hash_entry
*, void *);
577 extern bfd_boolean _bfd_coff_link_input_bfd
578 (struct coff_final_link_info
*, bfd
*);
579 extern bfd_boolean _bfd_coff_reloc_link_order
580 (bfd
*, struct coff_final_link_info
*, asection
*,
581 struct bfd_link_order
*);
584 #define coff_get_section_contents_in_window \
585 _bfd_generic_get_section_contents_in_window
587 /* Functions in xcofflink.c. */
589 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
591 extern long _bfd_xcoff_canonicalize_dynamic_symtab
593 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
595 extern long _bfd_xcoff_canonicalize_dynamic_reloc
596 (bfd
*, arelent
**, asymbol
**);
597 extern struct bfd_link_hash_table
*_bfd_xcoff_bfd_link_hash_table_create
599 extern void _bfd_xcoff_bfd_link_hash_table_free
600 (struct bfd_link_hash_table
*);
601 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
602 (bfd
*, struct bfd_link_info
*);
603 extern bfd_boolean _bfd_xcoff_bfd_final_link
604 (bfd
*, struct bfd_link_info
*);
605 extern bfd_boolean _bfd_xcoff_define_common_symbol
606 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*);
607 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
608 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
609 struct internal_reloc
*, struct internal_syment
*, asection
**);
611 /* Functions in coff-ppc.c. FIXME: These are called by pe.em in the
612 linker, and so should start with bfd and be declared in bfd.h. */
614 extern bfd_boolean ppc_allocate_toc_section
615 (struct bfd_link_info
*);
616 extern bfd_boolean ppc_process_before_allocation
617 (bfd
*, struct bfd_link_info
*);