1 /* BFD COFF object file private structure.
2 Copyright (C) 1990-2020 Free Software Foundation, Inc.
3 Written by Cygnus Support.
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. */
32 /* Object file tdata; access macros. */
34 #define coff_data(bfd) ((bfd)->tdata.coff_obj_data)
35 #define obj_pe(bfd) (coff_data (bfd)->pe)
36 #define obj_go32(bfd) (coff_data (bfd)->go32)
37 #define obj_symbols(bfd) (coff_data (bfd)->symbols)
38 #define obj_sym_filepos(bfd) (coff_data (bfd)->sym_filepos)
39 #define obj_relocbase(bfd) (coff_data (bfd)->relocbase)
40 #define obj_raw_syments(bfd) (coff_data (bfd)->raw_syments)
41 #define obj_raw_syment_count(bfd) (coff_data (bfd)->raw_syment_count)
42 #define obj_convert(bfd) (coff_data (bfd)->conversion_table)
43 #define obj_conv_table_size(bfd) (coff_data (bfd)->conv_table_size)
44 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
45 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
46 #define obj_coff_strings(bfd) (coff_data (bfd)->strings)
47 #define obj_coff_strings_len(bfd) (coff_data (bfd)->strings_len)
48 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
49 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
50 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
51 #define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
53 /* `Tdata' information kept for COFF files. */
55 typedef struct coff_tdata
57 struct coff_symbol_struct
*symbols
; /* Symtab for input bfd. */
58 unsigned int *conversion_table
;
62 struct coff_ptr_struct
*raw_syments
;
63 unsigned long raw_syment_count
;
65 /* These are only valid once writing has begun. */
66 unsigned long int relocbase
;
68 /* These members communicate important constants about the symbol table
69 to GDB's symbol-reading code. These `constants' unfortunately vary
70 from coff implementation to implementation... */
71 unsigned local_n_btmask
;
72 unsigned local_n_btshft
;
73 unsigned local_n_tmask
;
74 unsigned local_n_tshift
;
75 unsigned local_symesz
;
76 unsigned local_auxesz
;
77 unsigned local_linesz
;
79 /* The unswapped external symbols. May be NULL. Read by
80 _bfd_coff_get_external_symbols. */
82 /* If this is TRUE, the external_syms may not be freed. */
83 bfd_boolean keep_syms
;
85 /* The string table. May be NULL. Read by
86 _bfd_coff_read_string_table. */
88 /* The length of the strings table. For error checking. */
89 bfd_size_type strings_len
;
90 /* If this is TRUE, the strings may not be freed. */
91 bfd_boolean keep_strings
;
92 /* If this is TRUE, the strings have been written out already. */
93 bfd_boolean strings_written
;
95 /* Is this a PE format coff file? */
97 /* Used by the COFF backend linker. */
98 struct coff_link_hash_entry
**sym_hashes
;
100 /* Used by the pe linker for PowerPC. */
101 int *local_toc_sym_map
;
103 struct bfd_link_info
*link_info
;
105 /* Used by coff_find_nearest_line. */
108 /* A place to stash dwarf2 info for this bfd. */
109 void * dwarf2_find_line_info
;
111 /* The timestamp from the COFF file header. */
114 /* Copy of some of the f_flags bits in the COFF filehdr structure,
118 /* Is this a GO32 coff file? */
121 /* A stub (extra data prepended before the COFF image) and its size.
122 Used by coff-go32-exe, it contains executable data that loads the
123 COFF object into memory. */
125 bfd_size_type stub_size
;
128 /* Tdata for pe image files. */
129 typedef struct pe_tdata
132 struct internal_extra_pe_aouthdr pe_opthdr
;
134 int has_reloc_section
;
135 int dont_strip_reloc
;
137 /* The timestamp to insert into the output file.
138 If the timestamp is -1 then the current time is used. */
140 bfd_boolean (*in_reloc_p
) (bfd
*, reloc_howto_type
*);
146 bfd_boolean (*after_write_object_contents
) (bfd
*);
152 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
154 /* Tdata for XCOFF files. */
158 /* Basic COFF information. */
161 /* TRUE if this is an XCOFF64 file. */
164 /* TRUE if a large a.out header should be generated. */
165 bfd_boolean full_aouthdr
;
170 /* Index of section holding TOC. */
173 /* Index of section holding entry point. */
176 /* .text alignment from optional header. */
177 int text_align_power
;
179 /* .data alignment from optional header. */
180 int data_align_power
;
182 /* modtype from optional header. */
185 /* cputype from optional header. */
188 /* maxdata from optional header. */
191 /* maxstack from optional header. */
194 /* Used by the XCOFF backend linker. */
197 unsigned int *lineno_counts
;
198 unsigned int import_file_id
;
201 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
203 /* We take the address of the first element of an asymbol to ensure that the
204 macro is only ever applied to an asymbol. */
205 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
207 /* Tdata for sections in XCOFF files. This is used by the linker. */
209 struct xcoff_section_tdata
211 /* Used for XCOFF csects created by the linker; points to the real
212 XCOFF section which contains this csect. */
214 /* The lineno_count field for the enclosing section, because we are
215 going to clobber it there. */
216 unsigned int lineno_count
;
217 /* The first and last symbol indices for symbols used by this csect. */
218 unsigned long first_symndx
;
219 unsigned long last_symndx
;
222 /* An accessor macro the xcoff_section_tdata structure. */
223 #define xcoff_section_data(abfd, sec) \
224 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
226 /* Tdata for sections in PE files. */
228 struct pei_section_tdata
230 /* The virtual size of the section. */
231 bfd_size_type virt_size
;
232 /* The PE section flags. */
236 /* An accessor macro for the pei_section_tdata structure. */
237 #define pei_section_data(abfd, sec) \
238 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
240 /* COFF linker hash table entries. */
242 struct coff_link_hash_entry
244 struct bfd_link_hash_entry root
;
246 /* Symbol index in output file. Set to -1 initially. Set to -2 if
247 there is a reloc against this symbol. */
254 unsigned char symbol_class
;
256 /* Number of auxiliary entries. */
259 /* BFD to take auxiliary entries from. */
262 /* Pointer to array of auxiliary entries, if any. */
263 union internal_auxent
*aux
;
265 /* Flag word; legal values follow. */
266 unsigned short coff_link_hash_flags
;
267 /* Symbol is a PE section symbol. */
268 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
271 /* COFF linker hash table. */
273 struct coff_link_hash_table
275 struct bfd_link_hash_table root
;
276 /* A pointer to information used to link stabs in sections. */
277 struct stab_info stab_info
;
280 struct coff_reloc_cookie
282 struct internal_reloc
* rels
;
283 struct internal_reloc
* rel
;
284 struct internal_reloc
* relend
;
285 struct coff_symbol_struct
* symbols
; /* Symtab for input bfd. */
287 struct coff_link_hash_entry
** sym_hashes
;
290 /* Look up an entry in a COFF linker hash table. */
292 #define coff_link_hash_lookup(table, string, create, copy, follow) \
293 ((struct coff_link_hash_entry *) \
294 bfd_link_hash_lookup (&(table)->root, (string), (create), \
297 /* Traverse a COFF linker hash table. */
299 #define coff_link_hash_traverse(table, func, info) \
300 (bfd_link_hash_traverse \
302 (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
305 /* Get the COFF linker hash table from a link_info structure. */
307 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
309 /* Functions in coffgen.c. */
310 extern bfd_cleanup coff_object_p
312 extern struct bfd_section
*coff_section_from_bfd_index
314 extern long coff_get_symtab_upper_bound
316 extern long coff_canonicalize_symtab
318 extern int coff_count_linenumbers
320 extern bfd_boolean coff_renumber_symbols
322 extern void coff_mangle_symbols
324 extern bfd_boolean coff_write_symbols
326 extern bfd_boolean coff_write_alien_symbol
327 (bfd
*, asymbol
*, struct internal_syment
*, union internal_auxent
*,
328 bfd_vma
*, bfd_size_type
*, asection
**, bfd_size_type
*);
329 extern bfd_boolean coff_write_linenumbers
331 extern alent
*coff_get_lineno
333 extern asymbol
*coff_section_symbol
335 extern bfd_boolean _bfd_coff_get_external_symbols
337 extern const char *_bfd_coff_read_string_table
339 extern bfd_boolean _bfd_coff_free_symbols
341 extern struct coff_ptr_struct
*coff_get_normalized_symtab
343 extern long coff_get_reloc_upper_bound
345 extern asymbol
*coff_make_empty_symbol
347 extern void coff_print_symbol
348 (bfd
*, void * filep
, asymbol
*, bfd_print_symbol_type
);
349 extern void coff_get_symbol_info
350 (bfd
*, asymbol
*, symbol_info
*ret
);
351 #define coff_get_symbol_version_string \
352 _bfd_nosymbols_get_symbol_version_string
353 extern bfd_boolean _bfd_coff_is_local_label_name
354 (bfd
*, const char *);
355 extern asymbol
*coff_bfd_make_debug_symbol
356 (bfd
*, void *, unsigned long);
357 extern bfd_boolean coff_find_nearest_line
358 (bfd
*, asymbol
**, asection
*, bfd_vma
,
359 const char **, const char **, unsigned int *, unsigned int *);
360 #define coff_find_line _bfd_nosymbols_find_line
361 struct dwarf_debug_section
;
362 extern bfd_boolean coff_find_nearest_line_with_names
363 (bfd
*, asymbol
**, asection
*, bfd_vma
, const char **, const char **,
364 unsigned int *, const struct dwarf_debug_section
*);
365 extern bfd_boolean coff_find_inliner_info
366 (bfd
*, const char **, const char **, unsigned int *);
367 extern int coff_sizeof_headers
368 (bfd
*, struct bfd_link_info
*);
369 extern bfd_boolean bfd_coff_reloc16_relax_section
370 (bfd
*, asection
*, struct bfd_link_info
*, bfd_boolean
*);
371 extern bfd_byte
*bfd_coff_reloc16_get_relocated_section_contents
372 (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
373 bfd_byte
*, bfd_boolean
, asymbol
**);
374 extern bfd_vma bfd_coff_reloc16_get_value
375 (arelent
*, struct bfd_link_info
*, asection
*);
376 extern void bfd_perform_slip
377 (bfd
*, unsigned int, asection
*, bfd_vma
);
378 extern bfd_boolean _bfd_coff_close_and_cleanup
381 /* Functions and types in cofflink.c. */
383 #define STRING_SIZE_SIZE 4
385 /* We use a hash table to merge identical enum, struct, and union
386 definitions in the linker. */
388 /* Information we keep for a single element (an enum value, a
389 structure or union field) in the debug merge hash table. */
391 struct coff_debug_merge_element
394 struct coff_debug_merge_element
*next
;
402 /* Symbol index for complex type. */
406 /* A linked list of debug merge entries for a given name. */
408 struct coff_debug_merge_type
410 /* Next type with the same name. */
411 struct coff_debug_merge_type
*next
;
416 /* Symbol index where this type is defined. */
419 /* List of elements. */
420 struct coff_debug_merge_element
*elements
;
423 /* Information we store in the debug merge hash table. */
425 struct coff_debug_merge_hash_entry
427 struct bfd_hash_entry root
;
429 /* A list of types with this name. */
430 struct coff_debug_merge_type
*types
;
433 /* The debug merge hash table. */
435 struct coff_debug_merge_hash_table
437 struct bfd_hash_table root
;
440 /* Initialize a COFF debug merge hash table. */
442 #define coff_debug_merge_hash_table_init(table) \
443 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
444 sizeof (struct coff_debug_merge_hash_entry)))
446 /* Free a COFF debug merge hash table. */
448 #define coff_debug_merge_hash_table_free(table) \
449 (bfd_hash_table_free (&(table)->root))
451 /* Look up an entry in a COFF debug merge hash table. */
453 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
454 ((struct coff_debug_merge_hash_entry *) \
455 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
457 /* Information we keep for each section in the output file when doing
458 a relocatable link. */
460 struct coff_link_section_info
462 /* The relocs to be output. */
463 struct internal_reloc
*relocs
;
464 /* For each reloc against a global symbol whose index was not known
465 when the reloc was handled, the global hash table entry. */
466 struct coff_link_hash_entry
**rel_hashes
;
469 /* Information that we pass around while doing the final link step. */
471 struct coff_final_link_info
473 /* General link information. */
474 struct bfd_link_info
*info
;
477 /* Used to indicate failure in traversal routine. */
479 /* If doing "task linking" set only during the time when we want the
480 global symbol writer to convert the storage class of defined global
481 symbols from global to static. */
482 bfd_boolean global_to_static
;
483 /* Hash table for long symbol names. */
484 struct bfd_strtab_hash
*strtab
;
485 /* When doing a relocatable link, an array of information kept for
486 each output section, indexed by the target_index field. */
487 struct coff_link_section_info
*section_info
;
488 /* Symbol index of last C_FILE symbol (-1 if none). */
489 long last_file_index
;
490 /* Contents of last C_FILE symbol. */
491 struct internal_syment last_file
;
492 /* Symbol index of first aux entry of last .bf symbol with an empty
493 endndx field (-1 if none). */
495 /* Contents of last_bf_index aux entry. */
496 union internal_auxent last_bf
;
497 /* Hash table used to merge debug information. */
498 struct coff_debug_merge_hash_table debug_merge
;
499 /* Buffer large enough to hold swapped symbols of any input file. */
500 struct internal_syment
*internal_syms
;
501 /* Buffer large enough to hold sections of symbols of any input file. */
503 /* Buffer large enough to hold output indices of symbols of any
506 /* Buffer large enough to hold output symbols for any input file. */
508 /* Buffer large enough to hold external line numbers for any input
511 /* Buffer large enough to hold any input section. */
513 /* Buffer large enough to hold external relocs of any input section. */
514 bfd_byte
*external_relocs
;
515 /* Buffer large enough to hold swapped relocs of any input section. */
516 struct internal_reloc
*internal_relocs
;
519 /* Most COFF variants have no way to record the alignment of a
520 section. This struct is used to set a specific alignment based on
521 the name of the section. */
523 struct coff_section_alignment_entry
525 /* The section name. */
528 /* This is either (unsigned int) -1, indicating that the section
529 name must match exactly, or it is the number of letters which
530 must match at the start of the name. */
531 unsigned int comparison_length
;
533 /* These macros may be used to fill in the first two fields in a
534 structure initialization. */
535 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
536 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
538 /* Only use this entry if the default section alignment for this
539 target is at least that much (as a power of two). If this field
540 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
541 unsigned int default_alignment_min
;
543 /* Only use this entry if the default section alignment for this
544 target is no greater than this (as a power of two). If this
545 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
546 unsigned int default_alignment_max
;
548 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
550 /* The desired alignment for this section (as a power of two). */
551 unsigned int alignment_power
;
554 extern struct bfd_hash_entry
*_bfd_coff_link_hash_newfunc
555 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
556 extern bfd_boolean _bfd_coff_link_hash_table_init
557 (struct coff_link_hash_table
*, bfd
*,
558 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
559 struct bfd_hash_table
*,
562 extern struct bfd_link_hash_table
*_bfd_coff_link_hash_table_create
564 extern const char *_bfd_coff_internal_syment_name
565 (bfd
*, const struct internal_syment
*, char *);
566 extern bfd_boolean _bfd_coff_section_already_linked
567 (bfd
*, asection
*, struct bfd_link_info
*);
568 extern bfd_boolean _bfd_coff_link_add_symbols
569 (bfd
*, struct bfd_link_info
*);
570 extern bfd_boolean _bfd_coff_final_link
571 (bfd
*, struct bfd_link_info
*);
572 extern struct internal_reloc
*_bfd_coff_read_internal_relocs
573 (bfd
*, asection
*, bfd_boolean
, bfd_byte
*, bfd_boolean
,
574 struct internal_reloc
*);
575 extern bfd_boolean _bfd_coff_generic_relocate_section
576 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
577 struct internal_reloc
*, struct internal_syment
*, asection
**);
578 extern struct bfd_hash_entry
*_bfd_coff_debug_merge_hash_newfunc
579 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
580 extern bfd_boolean _bfd_coff_write_global_sym
581 (struct bfd_hash_entry
*, void *);
582 extern bfd_boolean _bfd_coff_write_task_globals
583 (struct coff_link_hash_entry
*, void *);
584 extern bfd_boolean _bfd_coff_link_input_bfd
585 (struct coff_final_link_info
*, bfd
*);
586 extern bfd_boolean _bfd_coff_reloc_link_order
587 (bfd
*, struct coff_final_link_info
*, asection
*,
588 struct bfd_link_order
*);
589 extern bfd_boolean bfd_coff_gc_sections
590 (bfd
*, struct bfd_link_info
*);
591 extern const char *bfd_coff_group_name
592 (bfd
*, const asection
*);
594 #define coff_get_section_contents_in_window \
595 _bfd_generic_get_section_contents_in_window
597 /* Functions in xcofflink.c. */
599 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
601 extern long _bfd_xcoff_canonicalize_dynamic_symtab
603 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
605 extern long _bfd_xcoff_canonicalize_dynamic_reloc
606 (bfd
*, arelent
**, asymbol
**);
607 extern struct bfd_link_hash_table
*_bfd_xcoff_bfd_link_hash_table_create
609 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
610 (bfd
*, struct bfd_link_info
*);
611 extern bfd_boolean _bfd_xcoff_bfd_final_link
612 (bfd
*, struct bfd_link_info
*);
613 extern bfd_boolean _bfd_xcoff_define_common_symbol
614 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*);
615 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
616 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
617 struct internal_reloc
*, struct internal_syment
*, asection
**);
619 /* Functions in coff-ppc.c. FIXME: These are called by pe.em in the
620 linker, and so should start with bfd and be declared in bfd.h. */
622 extern bfd_boolean ppc_allocate_toc_section
623 (struct bfd_link_info
*);
624 extern bfd_boolean ppc_process_before_allocation
625 (bfd
*, struct bfd_link_info
*);