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_symbols(bfd) (coff_data (bfd)->symbols)
37 #define obj_sym_filepos(bfd) (coff_data (bfd)->sym_filepos)
38 #define obj_relocbase(bfd) (coff_data (bfd)->relocbase)
39 #define obj_raw_syments(bfd) (coff_data (bfd)->raw_syments)
40 #define obj_raw_syment_count(bfd) (coff_data (bfd)->raw_syment_count)
41 #define obj_convert(bfd) (coff_data (bfd)->conversion_table)
42 #define obj_conv_table_size(bfd) (coff_data (bfd)->conv_table_size)
43 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
44 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
45 #define obj_coff_strings(bfd) (coff_data (bfd)->strings)
46 #define obj_coff_strings_len(bfd) (coff_data (bfd)->strings_len)
47 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
48 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
49 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
50 #define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
52 /* `Tdata' information kept for COFF files. */
54 typedef struct coff_tdata
56 struct coff_symbol_struct
*symbols
; /* Symtab for input bfd. */
57 unsigned int *conversion_table
;
61 struct coff_ptr_struct
*raw_syments
;
62 unsigned long raw_syment_count
;
64 /* These are only valid once writing has begun. */
65 unsigned long int relocbase
;
67 /* These members communicate important constants about the symbol table
68 to GDB's symbol-reading code. These `constants' unfortunately vary
69 from coff implementation to implementation... */
70 unsigned local_n_btmask
;
71 unsigned local_n_btshft
;
72 unsigned local_n_tmask
;
73 unsigned local_n_tshift
;
74 unsigned local_symesz
;
75 unsigned local_auxesz
;
76 unsigned local_linesz
;
78 /* The unswapped external symbols. May be NULL. Read by
79 _bfd_coff_get_external_symbols. */
81 /* If this is TRUE, the external_syms may not be freed. */
82 bfd_boolean keep_syms
;
84 /* The string table. May be NULL. Read by
85 _bfd_coff_read_string_table. */
87 /* The length of the strings table. For error checking. */
88 bfd_size_type strings_len
;
89 /* If this is TRUE, the strings may not be freed. */
90 bfd_boolean keep_strings
;
91 /* If this is TRUE, the strings have been written out already. */
92 bfd_boolean strings_written
;
94 /* Is this a PE format coff file? */
96 /* Used by the COFF backend linker. */
97 struct coff_link_hash_entry
**sym_hashes
;
99 /* Used by the pe linker for PowerPC. */
100 int *local_toc_sym_map
;
102 struct bfd_link_info
*link_info
;
104 /* Used by coff_find_nearest_line. */
107 /* A place to stash dwarf2 info for this bfd. */
108 void * dwarf2_find_line_info
;
110 /* The timestamp from the COFF file header. */
113 /* Copy of some of the f_flags bits in the COFF filehdr structure,
117 /* coff-stgo32 EXE stub header after BFD tdata has been allocated. Its data
118 is kept in internal_filehdr.go32stub beforehand. */
122 /* Tdata for pe image files. */
123 typedef struct pe_tdata
126 struct internal_extra_pe_aouthdr pe_opthdr
;
128 int has_reloc_section
;
129 int dont_strip_reloc
;
131 /* The timestamp to insert into the output file.
132 If the timestamp is -1 then the current time is used. */
134 bfd_boolean (*in_reloc_p
) (bfd
*, reloc_howto_type
*);
140 bfd_boolean (*after_write_object_contents
) (bfd
*);
146 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
148 /* Tdata for XCOFF files. */
152 /* Basic COFF information. */
155 /* TRUE if this is an XCOFF64 file. */
158 /* TRUE if a large a.out header should be generated. */
159 bfd_boolean full_aouthdr
;
164 /* Index of section holding TOC. */
167 /* Index of section holding entry point. */
170 /* .text alignment from optional header. */
171 int text_align_power
;
173 /* .data alignment from optional header. */
174 int data_align_power
;
176 /* modtype from optional header. */
179 /* cputype from optional header. */
182 /* maxdata from optional header. */
185 /* maxstack from optional header. */
188 /* Used by the XCOFF backend linker. */
191 unsigned int *lineno_counts
;
192 unsigned int import_file_id
;
195 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
197 /* We take the address of the first element of an asymbol to ensure that the
198 macro is only ever applied to an asymbol. */
199 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
201 /* Tdata for sections in XCOFF files. This is used by the linker. */
203 struct xcoff_section_tdata
205 /* Used for XCOFF csects created by the linker; points to the real
206 XCOFF section which contains this csect. */
208 /* The lineno_count field for the enclosing section, because we are
209 going to clobber it there. */
210 unsigned int lineno_count
;
211 /* The first and last symbol indices for symbols used by this csect. */
212 unsigned long first_symndx
;
213 unsigned long last_symndx
;
216 /* An accessor macro the xcoff_section_tdata structure. */
217 #define xcoff_section_data(abfd, sec) \
218 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
220 /* Tdata for sections in PE files. */
222 struct pei_section_tdata
224 /* The virtual size of the section. */
225 bfd_size_type virt_size
;
226 /* The PE section flags. */
230 /* An accessor macro for the pei_section_tdata structure. */
231 #define pei_section_data(abfd, sec) \
232 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
234 /* COFF linker hash table entries. */
236 struct coff_link_hash_entry
238 struct bfd_link_hash_entry root
;
240 /* Symbol index in output file. Set to -1 initially. Set to -2 if
241 there is a reloc against this symbol. */
248 unsigned char symbol_class
;
250 /* Number of auxiliary entries. */
253 /* BFD to take auxiliary entries from. */
256 /* Pointer to array of auxiliary entries, if any. */
257 union internal_auxent
*aux
;
259 /* Flag word; legal values follow. */
260 unsigned short coff_link_hash_flags
;
261 /* Symbol is a PE section symbol. */
262 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
265 /* COFF linker hash table. */
267 struct coff_link_hash_table
269 struct bfd_link_hash_table root
;
270 /* A pointer to information used to link stabs in sections. */
271 struct stab_info stab_info
;
274 struct coff_reloc_cookie
276 struct internal_reloc
* rels
;
277 struct internal_reloc
* rel
;
278 struct internal_reloc
* relend
;
279 struct coff_symbol_struct
* symbols
; /* Symtab for input bfd. */
281 struct coff_link_hash_entry
** sym_hashes
;
284 /* Look up an entry in a COFF linker hash table. */
286 #define coff_link_hash_lookup(table, string, create, copy, follow) \
287 ((struct coff_link_hash_entry *) \
288 bfd_link_hash_lookup (&(table)->root, (string), (create), \
291 /* Traverse a COFF linker hash table. */
293 #define coff_link_hash_traverse(table, func, info) \
294 (bfd_link_hash_traverse \
296 (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
299 /* Get the COFF linker hash table from a link_info structure. */
301 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
303 /* Functions in coffgen.c. */
304 extern bfd_cleanup coff_object_p
306 extern struct bfd_section
*coff_section_from_bfd_index
308 extern long coff_get_symtab_upper_bound
310 extern long coff_canonicalize_symtab
312 extern int coff_count_linenumbers
314 extern bfd_boolean coff_renumber_symbols
316 extern void coff_mangle_symbols
318 extern bfd_boolean coff_write_symbols
320 extern bfd_boolean coff_write_alien_symbol
321 (bfd
*, asymbol
*, struct internal_syment
*, union internal_auxent
*,
322 bfd_vma
*, bfd_size_type
*, asection
**, bfd_size_type
*);
323 extern bfd_boolean coff_write_linenumbers
325 extern alent
*coff_get_lineno
327 extern asymbol
*coff_section_symbol
329 extern bfd_boolean _bfd_coff_get_external_symbols
331 extern const char *_bfd_coff_read_string_table
333 extern bfd_boolean _bfd_coff_free_symbols
335 extern struct coff_ptr_struct
*coff_get_normalized_symtab
337 extern long coff_get_reloc_upper_bound
339 extern asymbol
*coff_make_empty_symbol
341 extern void coff_print_symbol
342 (bfd
*, void * filep
, asymbol
*, bfd_print_symbol_type
);
343 extern void coff_get_symbol_info
344 (bfd
*, asymbol
*, symbol_info
*ret
);
345 #define coff_get_symbol_version_string \
346 _bfd_nosymbols_get_symbol_version_string
347 extern bfd_boolean _bfd_coff_is_local_label_name
348 (bfd
*, const char *);
349 extern asymbol
*coff_bfd_make_debug_symbol
350 (bfd
*, void *, unsigned long);
351 extern bfd_boolean coff_find_nearest_line
352 (bfd
*, asymbol
**, asection
*, bfd_vma
,
353 const char **, const char **, unsigned int *, unsigned int *);
354 #define coff_find_line _bfd_nosymbols_find_line
355 struct dwarf_debug_section
;
356 extern bfd_boolean coff_find_nearest_line_with_names
357 (bfd
*, asymbol
**, asection
*, bfd_vma
, const char **, const char **,
358 unsigned int *, const struct dwarf_debug_section
*);
359 extern bfd_boolean coff_find_inliner_info
360 (bfd
*, const char **, const char **, unsigned int *);
361 extern int coff_sizeof_headers
362 (bfd
*, struct bfd_link_info
*);
363 extern bfd_boolean bfd_coff_reloc16_relax_section
364 (bfd
*, asection
*, struct bfd_link_info
*, bfd_boolean
*);
365 extern bfd_byte
*bfd_coff_reloc16_get_relocated_section_contents
366 (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
367 bfd_byte
*, bfd_boolean
, asymbol
**);
368 extern bfd_vma bfd_coff_reloc16_get_value
369 (arelent
*, struct bfd_link_info
*, asection
*);
370 extern void bfd_perform_slip
371 (bfd
*, unsigned int, asection
*, bfd_vma
);
372 extern bfd_boolean _bfd_coff_close_and_cleanup
375 /* Functions and types in cofflink.c. */
377 #define STRING_SIZE_SIZE 4
379 /* We use a hash table to merge identical enum, struct, and union
380 definitions in the linker. */
382 /* Information we keep for a single element (an enum value, a
383 structure or union field) in the debug merge hash table. */
385 struct coff_debug_merge_element
388 struct coff_debug_merge_element
*next
;
396 /* Symbol index for complex type. */
400 /* A linked list of debug merge entries for a given name. */
402 struct coff_debug_merge_type
404 /* Next type with the same name. */
405 struct coff_debug_merge_type
*next
;
410 /* Symbol index where this type is defined. */
413 /* List of elements. */
414 struct coff_debug_merge_element
*elements
;
417 /* Information we store in the debug merge hash table. */
419 struct coff_debug_merge_hash_entry
421 struct bfd_hash_entry root
;
423 /* A list of types with this name. */
424 struct coff_debug_merge_type
*types
;
427 /* The debug merge hash table. */
429 struct coff_debug_merge_hash_table
431 struct bfd_hash_table root
;
434 /* Initialize a COFF debug merge hash table. */
436 #define coff_debug_merge_hash_table_init(table) \
437 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
438 sizeof (struct coff_debug_merge_hash_entry)))
440 /* Free a COFF debug merge hash table. */
442 #define coff_debug_merge_hash_table_free(table) \
443 (bfd_hash_table_free (&(table)->root))
445 /* Look up an entry in a COFF debug merge hash table. */
447 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
448 ((struct coff_debug_merge_hash_entry *) \
449 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
451 /* Information we keep for each section in the output file when doing
452 a relocatable link. */
454 struct coff_link_section_info
456 /* The relocs to be output. */
457 struct internal_reloc
*relocs
;
458 /* For each reloc against a global symbol whose index was not known
459 when the reloc was handled, the global hash table entry. */
460 struct coff_link_hash_entry
**rel_hashes
;
463 /* Information that we pass around while doing the final link step. */
465 struct coff_final_link_info
467 /* General link information. */
468 struct bfd_link_info
*info
;
471 /* Used to indicate failure in traversal routine. */
473 /* If doing "task linking" set only during the time when we want the
474 global symbol writer to convert the storage class of defined global
475 symbols from global to static. */
476 bfd_boolean global_to_static
;
477 /* Hash table for long symbol names. */
478 struct bfd_strtab_hash
*strtab
;
479 /* When doing a relocatable link, an array of information kept for
480 each output section, indexed by the target_index field. */
481 struct coff_link_section_info
*section_info
;
482 /* Symbol index of last C_FILE symbol (-1 if none). */
483 long last_file_index
;
484 /* Contents of last C_FILE symbol. */
485 struct internal_syment last_file
;
486 /* Symbol index of first aux entry of last .bf symbol with an empty
487 endndx field (-1 if none). */
489 /* Contents of last_bf_index aux entry. */
490 union internal_auxent last_bf
;
491 /* Hash table used to merge debug information. */
492 struct coff_debug_merge_hash_table debug_merge
;
493 /* Buffer large enough to hold swapped symbols of any input file. */
494 struct internal_syment
*internal_syms
;
495 /* Buffer large enough to hold sections of symbols of any input file. */
497 /* Buffer large enough to hold output indices of symbols of any
500 /* Buffer large enough to hold output symbols for any input file. */
502 /* Buffer large enough to hold external line numbers for any input
505 /* Buffer large enough to hold any input section. */
507 /* Buffer large enough to hold external relocs of any input section. */
508 bfd_byte
*external_relocs
;
509 /* Buffer large enough to hold swapped relocs of any input section. */
510 struct internal_reloc
*internal_relocs
;
513 /* Most COFF variants have no way to record the alignment of a
514 section. This struct is used to set a specific alignment based on
515 the name of the section. */
517 struct coff_section_alignment_entry
519 /* The section name. */
522 /* This is either (unsigned int) -1, indicating that the section
523 name must match exactly, or it is the number of letters which
524 must match at the start of the name. */
525 unsigned int comparison_length
;
527 /* These macros may be used to fill in the first two fields in a
528 structure initialization. */
529 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
530 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
532 /* Only use this entry if the default section alignment for this
533 target is at least that much (as a power of two). If this field
534 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
535 unsigned int default_alignment_min
;
537 /* Only use this entry if the default section alignment for this
538 target is no greater than this (as a power of two). If this
539 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
540 unsigned int default_alignment_max
;
542 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
544 /* The desired alignment for this section (as a power of two). */
545 unsigned int alignment_power
;
548 extern struct bfd_hash_entry
*_bfd_coff_link_hash_newfunc
549 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
550 extern bfd_boolean _bfd_coff_link_hash_table_init
551 (struct coff_link_hash_table
*, bfd
*,
552 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
553 struct bfd_hash_table
*,
556 extern struct bfd_link_hash_table
*_bfd_coff_link_hash_table_create
558 extern const char *_bfd_coff_internal_syment_name
559 (bfd
*, const struct internal_syment
*, char *);
560 extern bfd_boolean _bfd_coff_section_already_linked
561 (bfd
*, asection
*, struct bfd_link_info
*);
562 extern bfd_boolean _bfd_coff_link_add_symbols
563 (bfd
*, struct bfd_link_info
*);
564 extern bfd_boolean _bfd_coff_final_link
565 (bfd
*, struct bfd_link_info
*);
566 extern struct internal_reloc
*_bfd_coff_read_internal_relocs
567 (bfd
*, asection
*, bfd_boolean
, bfd_byte
*, bfd_boolean
,
568 struct internal_reloc
*);
569 extern bfd_boolean _bfd_coff_generic_relocate_section
570 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
571 struct internal_reloc
*, struct internal_syment
*, asection
**);
572 extern struct bfd_hash_entry
*_bfd_coff_debug_merge_hash_newfunc
573 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
574 extern bfd_boolean _bfd_coff_write_global_sym
575 (struct bfd_hash_entry
*, void *);
576 extern bfd_boolean _bfd_coff_write_task_globals
577 (struct coff_link_hash_entry
*, void *);
578 extern bfd_boolean _bfd_coff_link_input_bfd
579 (struct coff_final_link_info
*, bfd
*);
580 extern bfd_boolean _bfd_coff_reloc_link_order
581 (bfd
*, struct coff_final_link_info
*, asection
*,
582 struct bfd_link_order
*);
583 extern bfd_boolean bfd_coff_gc_sections
584 (bfd
*, struct bfd_link_info
*);
585 extern const char *bfd_coff_group_name
586 (bfd
*, const asection
*);
588 #define coff_get_section_contents_in_window \
589 _bfd_generic_get_section_contents_in_window
591 /* Functions in xcofflink.c. */
593 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
595 extern long _bfd_xcoff_canonicalize_dynamic_symtab
597 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
599 extern long _bfd_xcoff_canonicalize_dynamic_reloc
600 (bfd
*, arelent
**, asymbol
**);
601 extern struct bfd_link_hash_table
*_bfd_xcoff_bfd_link_hash_table_create
603 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
604 (bfd
*, struct bfd_link_info
*);
605 extern bfd_boolean _bfd_xcoff_bfd_final_link
606 (bfd
*, struct bfd_link_info
*);
607 extern bfd_boolean _bfd_xcoff_define_common_symbol
608 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*);
609 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
610 (bfd
*, struct bfd_link_info
*, bfd
*, asection
*, bfd_byte
*,
611 struct internal_reloc
*, struct internal_syment
*, asection
**);
613 /* Functions in coff-ppc.c. FIXME: These are called by pe.em in the
614 linker, and so should start with bfd and be declared in bfd.h. */
616 extern bfd_boolean ppc_allocate_toc_section
617 (struct bfd_link_info
*);
618 extern bfd_boolean ppc_process_before_allocation
619 (bfd
*, struct bfd_link_info
*);