RISC-V: test for expected / no unexpected symbols
[binutils-gdb.git] / bfd / libcoff-in.h
bloba0d286d37f4a960ffc5c63dae13156df0ef9e9a7
1 /* BFD COFF object file private structure.
2 Copyright (C) 1990-2023 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. */
22 #ifndef _LIBCOFF_H
23 #define _LIBCOFF_H 1
25 #include "bfdlink.h"
26 #include "coff-bfd.h"
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
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;
59 int conv_table_size;
60 file_ptr sym_filepos;
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. */
81 void * external_syms;
83 /* The string table. May be NULL. Read by
84 _bfd_coff_read_string_table. */
85 char *strings;
86 /* The length of the strings table. For error checking. */
87 bfd_size_type strings_len;
89 /* Set if long section names are supported. A writable copy of the COFF
90 backend flag _bfd_coff_long_section_names. */
91 bool long_section_names;
93 /* If this is TRUE, the external_syms may not be freed. */
94 bool keep_syms;
95 /* If this is TRUE, the strings may not be freed. */
96 bool keep_strings;
97 /* If this is TRUE, the strings have been written out already. */
98 bool strings_written;
100 /* Is this a GO32 coff file? */
101 bool go32;
103 /* Is this a PE format coff file? */
104 bool pe;
106 /* Copy of some of the f_flags bits in the COFF filehdr structure,
107 used by ARM code. */
108 flagword flags;
110 /* Used by the COFF backend linker. */
111 struct coff_link_hash_entry **sym_hashes;
113 /* Used by the pe linker for PowerPC. */
114 int *local_toc_sym_map;
116 struct bfd_link_info *link_info;
118 /* Used by coff_find_nearest_line. */
119 void * line_info;
121 /* A place to stash dwarf2 info for this bfd. */
122 void * dwarf2_find_line_info;
124 /* The timestamp from the COFF file header. */
125 long timestamp;
127 /* A stub (extra data prepended before the COFF image) and its size.
128 Used by coff-go32-exe, it contains executable data that loads the
129 COFF object into memory. */
130 char * stub;
131 bfd_size_type stub_size;
132 } coff_data_type;
134 /* Tdata for pe image files. */
135 typedef struct pe_tdata
137 coff_data_type coff;
138 struct internal_extra_pe_aouthdr pe_opthdr;
139 int dll;
140 int has_reloc_section;
141 int dont_strip_reloc;
142 int dos_message[16];
143 /* The timestamp to insert into the output file.
144 If the timestamp is -1 then the current time is used. */
145 int timestamp;
146 bool (*in_reloc_p) (bfd *, reloc_howto_type *);
147 flagword real_flags;
149 /* Build-id info. */
150 struct
152 bool (*after_write_object_contents) (bfd *);
153 const char *style;
154 asection *sec;
155 } build_id;
156 } pe_data_type;
158 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
160 /* Tdata for XCOFF files. */
162 struct xcoff_tdata
164 /* Basic COFF information. */
165 coff_data_type coff;
167 /* TRUE if this is an XCOFF64 file. */
168 bool xcoff64;
170 /* TRUE if a large a.out header should be generated. */
171 bool full_aouthdr;
173 /* TOC value. */
174 bfd_vma toc;
176 /* Index of section holding TOC. */
177 int sntoc;
179 /* Index of section holding entry point. */
180 int snentry;
182 /* .text alignment from optional header. */
183 int text_align_power;
185 /* .data alignment from optional header. */
186 int data_align_power;
188 /* modtype from optional header. */
189 short modtype;
191 /* cputype from optional header. */
192 short cputype;
194 /* maxdata from optional header. */
195 bfd_vma maxdata;
197 /* maxstack from optional header. */
198 bfd_vma maxstack;
200 /* Used by the XCOFF backend linker. */
201 asection **csects;
202 long *debug_indices;
203 unsigned int *lineno_counts;
204 unsigned int import_file_id;
207 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
209 /* We take the address of the first element of an asymbol to ensure that the
210 macro is only ever applied to an asymbol. */
211 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
213 /* Tdata for sections in XCOFF files. This is used by the linker. */
215 struct xcoff_section_tdata
217 /* Used for XCOFF csects created by the linker; points to the real
218 XCOFF section which contains this csect. */
219 asection *enclosing;
220 /* The lineno_count field for the enclosing section, because we are
221 going to clobber it there. */
222 unsigned int lineno_count;
223 /* The first and last symbol indices for symbols used by this csect. */
224 unsigned long first_symndx;
225 unsigned long last_symndx;
228 /* An accessor macro the xcoff_section_tdata structure. */
229 #define xcoff_section_data(abfd, sec) \
230 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
232 /* Tdata for sections in PE files. */
234 struct pei_section_tdata
236 /* The virtual size of the section. */
237 bfd_size_type virt_size;
238 /* The PE section flags. */
239 long pe_flags;
242 /* An accessor macro for the pei_section_tdata structure. */
243 #define pei_section_data(abfd, sec) \
244 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
246 /* COFF linker hash table entries. */
248 struct coff_link_hash_entry
250 struct bfd_link_hash_entry root;
252 /* Symbol index in output file. This is initialized to -1. It is
253 set to -2 if the symbol is used by a reloc. It is set to -3 if
254 this symbol is defined in a discarded section. */
255 long indx;
257 /* Symbol type. */
258 unsigned short type;
260 /* Symbol class. */
261 unsigned char symbol_class;
263 /* Number of auxiliary entries. */
264 char numaux;
266 /* BFD to take auxiliary entries from. */
267 bfd *auxbfd;
269 /* Pointer to array of auxiliary entries, if any. */
270 union internal_auxent *aux;
272 /* Flag word; legal values follow. */
273 unsigned short coff_link_hash_flags;
274 /* Symbol is a PE section symbol. */
275 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
278 /* COFF linker hash table. */
280 struct coff_link_hash_table
282 struct bfd_link_hash_table root;
283 /* A pointer to information used to link stabs in sections. */
284 struct stab_info stab_info;
287 struct coff_reloc_cookie
289 struct internal_reloc * rels;
290 struct internal_reloc * rel;
291 struct internal_reloc * relend;
292 struct coff_symbol_struct * symbols; /* Symtab for input bfd. */
293 bfd * abfd;
294 struct coff_link_hash_entry ** sym_hashes;
297 /* Look up an entry in a COFF linker hash table. */
299 #define coff_link_hash_lookup(table, string, create, copy, follow) \
300 ((struct coff_link_hash_entry *) \
301 bfd_link_hash_lookup (&(table)->root, (string), (create), \
302 (copy), (follow)))
304 /* Traverse a COFF linker hash table. */
306 #define coff_link_hash_traverse(table, func, info) \
307 (bfd_link_hash_traverse \
308 (&(table)->root, \
309 (bool (*) (struct bfd_link_hash_entry *, void *)) (func), \
310 (info)))
312 /* Get the COFF linker hash table from a link_info structure. */
314 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
316 /* Functions in coffgen.c. */
317 extern bfd_cleanup coff_object_p
318 (bfd *);
319 extern struct bfd_section *coff_section_from_bfd_index
320 (bfd *, int);
321 extern long coff_get_symtab_upper_bound
322 (bfd *);
323 extern long coff_canonicalize_symtab
324 (bfd *, asymbol **);
325 extern int coff_count_linenumbers
326 (bfd *);
327 extern bool coff_renumber_symbols
328 (bfd *, int *);
329 extern void coff_mangle_symbols
330 (bfd *);
331 extern bool coff_write_symbols
332 (bfd *);
333 extern bool coff_write_alien_symbol
334 (bfd *, asymbol *, struct internal_syment *, bfd_vma *,
335 struct bfd_strtab_hash *, bool, asection **, bfd_size_type *);
336 extern bool coff_write_linenumbers
337 (bfd *);
338 extern alent *coff_get_lineno
339 (bfd *, asymbol *);
340 extern asymbol *coff_section_symbol
341 (bfd *, char *);
342 extern bool _bfd_coff_get_external_symbols
343 (bfd *);
344 extern const char *_bfd_coff_read_string_table
345 (bfd *);
346 extern bool _bfd_coff_free_symbols
347 (bfd *);
348 extern struct coff_ptr_struct *coff_get_normalized_symtab
349 (bfd *);
350 extern long coff_get_reloc_upper_bound
351 (bfd *, sec_ptr);
352 extern asymbol *coff_make_empty_symbol
353 (bfd *);
354 extern void coff_print_symbol
355 (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
356 extern void coff_get_symbol_info
357 (bfd *, asymbol *, symbol_info *ret);
358 #define coff_get_symbol_version_string \
359 _bfd_nosymbols_get_symbol_version_string
360 extern bool _bfd_coff_is_local_label_name
361 (bfd *, const char *);
362 extern asymbol *coff_bfd_make_debug_symbol
363 (bfd *, void *, unsigned long);
364 extern bool coff_find_nearest_line
365 (bfd *, asymbol **, asection *, bfd_vma,
366 const char **, const char **, unsigned int *, unsigned int *);
367 #define coff_find_nearest_line_with_alt \
368 _bfd_nosymbols_find_nearest_line_with_alt
369 #define coff_find_line _bfd_nosymbols_find_line
370 struct dwarf_debug_section;
371 extern bool coff_find_nearest_line_with_names
372 (bfd *, asymbol **, asection *, bfd_vma, const char **, const char **,
373 unsigned int *, const struct dwarf_debug_section *);
374 extern bool coff_find_inliner_info
375 (bfd *, const char **, const char **, unsigned int *);
376 extern int coff_sizeof_headers
377 (bfd *, struct bfd_link_info *);
378 extern bool bfd_coff_reloc16_relax_section
379 (bfd *, asection *, struct bfd_link_info *, bool *);
380 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
381 (bfd *, struct bfd_link_info *, struct bfd_link_order *,
382 bfd_byte *, bool, asymbol **);
383 extern bfd_vma bfd_coff_reloc16_get_value
384 (arelent *, struct bfd_link_info *, asection *);
385 extern void bfd_perform_slip
386 (bfd *, unsigned int, asection *, bfd_vma);
387 extern bool _bfd_coff_close_and_cleanup
388 (bfd *);
390 /* Functions and types in cofflink.c. */
392 #define STRING_SIZE_SIZE 4
394 /* We use a hash table to merge identical enum, struct, and union
395 definitions in the linker. */
397 /* Information we keep for a single element (an enum value, a
398 structure or union field) in the debug merge hash table. */
400 struct coff_debug_merge_element
402 /* Next element. */
403 struct coff_debug_merge_element *next;
405 /* Name. */
406 const char *name;
408 /* Type. */
409 unsigned int type;
411 /* Symbol index for complex type. */
412 long tagndx;
415 /* A linked list of debug merge entries for a given name. */
417 struct coff_debug_merge_type
419 /* Next type with the same name. */
420 struct coff_debug_merge_type *next;
422 /* Class of type. */
423 int type_class;
425 /* Symbol index where this type is defined. */
426 long indx;
428 /* List of elements. */
429 struct coff_debug_merge_element *elements;
432 /* Information we store in the debug merge hash table. */
434 struct coff_debug_merge_hash_entry
436 struct bfd_hash_entry root;
438 /* A list of types with this name. */
439 struct coff_debug_merge_type *types;
442 /* The debug merge hash table. */
444 struct coff_debug_merge_hash_table
446 struct bfd_hash_table root;
449 /* Initialize a COFF debug merge hash table. */
451 #define coff_debug_merge_hash_table_init(table) \
452 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
453 sizeof (struct coff_debug_merge_hash_entry)))
455 /* Free a COFF debug merge hash table. */
457 #define coff_debug_merge_hash_table_free(table) \
458 (bfd_hash_table_free (&(table)->root))
460 /* Look up an entry in a COFF debug merge hash table. */
462 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
463 ((struct coff_debug_merge_hash_entry *) \
464 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
466 /* Information we keep for each section in the output file when doing
467 a relocatable link. */
469 struct coff_link_section_info
471 /* The relocs to be output. */
472 struct internal_reloc *relocs;
473 /* For each reloc against a global symbol whose index was not known
474 when the reloc was handled, the global hash table entry. */
475 struct coff_link_hash_entry **rel_hashes;
478 /* Information that we pass around while doing the final link step. */
480 struct coff_final_link_info
482 /* General link information. */
483 struct bfd_link_info *info;
484 /* Output BFD. */
485 bfd *output_bfd;
486 /* Used to indicate failure in traversal routine. */
487 bool failed;
488 /* If doing "task linking" set only during the time when we want the
489 global symbol writer to convert the storage class of defined global
490 symbols from global to static. */
491 bool global_to_static;
492 /* Hash table for long symbol names. */
493 struct bfd_strtab_hash *strtab;
494 /* When doing a relocatable link, an array of information kept for
495 each output section, indexed by the target_index field. */
496 struct coff_link_section_info *section_info;
497 /* Symbol index of last C_FILE symbol (-1 if none). */
498 long last_file_index;
499 /* Contents of last C_FILE symbol. */
500 struct internal_syment last_file;
501 /* Symbol index of first aux entry of last .bf symbol with an empty
502 endndx field (-1 if none). */
503 long last_bf_index;
504 /* Contents of last_bf_index aux entry. */
505 union internal_auxent last_bf;
506 /* Hash table used to merge debug information. */
507 struct coff_debug_merge_hash_table debug_merge;
508 /* Buffer large enough to hold swapped symbols of any input file. */
509 struct internal_syment *internal_syms;
510 /* Buffer large enough to hold sections of symbols of any input file. */
511 asection **sec_ptrs;
512 /* Buffer large enough to hold output indices of symbols of any
513 input file. */
514 long *sym_indices;
515 /* Buffer large enough to hold output symbols for any input file. */
516 bfd_byte *outsyms;
517 /* Buffer large enough to hold external line numbers for any input
518 section. */
519 bfd_byte *linenos;
520 /* Buffer large enough to hold any input section. */
521 bfd_byte *contents;
522 /* Buffer large enough to hold external relocs of any input section. */
523 bfd_byte *external_relocs;
524 /* Buffer large enough to hold swapped relocs of any input section. */
525 struct internal_reloc *internal_relocs;
528 /* Most COFF variants have no way to record the alignment of a
529 section. This struct is used to set a specific alignment based on
530 the name of the section. */
532 struct coff_section_alignment_entry
534 /* The section name. */
535 const char *name;
537 /* This is either (unsigned int) -1, indicating that the section
538 name must match exactly, or it is the number of letters which
539 must match at the start of the name. */
540 unsigned int comparison_length;
542 /* These macros may be used to fill in the first two fields in a
543 structure initialization. */
544 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
545 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
547 /* Only use this entry if the default section alignment for this
548 target is at least that much (as a power of two). If this field
549 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
550 unsigned int default_alignment_min;
552 /* Only use this entry if the default section alignment for this
553 target is no greater than this (as a power of two). If this
554 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
555 unsigned int default_alignment_max;
557 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
559 /* The desired alignment for this section (as a power of two). */
560 unsigned int alignment_power;
563 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
564 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
565 extern bool _bfd_coff_link_hash_table_init
566 (struct coff_link_hash_table *, bfd *,
567 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
568 struct bfd_hash_table *,
569 const char *),
570 unsigned int);
571 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
572 (bfd *);
573 extern const char *_bfd_coff_internal_syment_name
574 (bfd *, const struct internal_syment *, char *);
575 extern bool _bfd_coff_section_already_linked
576 (bfd *, asection *, struct bfd_link_info *);
577 extern bool _bfd_coff_link_add_symbols
578 (bfd *, struct bfd_link_info *);
579 extern bool _bfd_coff_final_link
580 (bfd *, struct bfd_link_info *);
581 extern struct internal_reloc *_bfd_coff_read_internal_relocs
582 (bfd *, asection *, bool, bfd_byte *, bool,
583 struct internal_reloc *);
584 extern bool _bfd_coff_generic_relocate_section
585 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
586 struct internal_reloc *, struct internal_syment *, asection **);
587 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
588 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
589 extern bool _bfd_coff_write_global_sym
590 (struct bfd_hash_entry *, void *);
591 extern bool _bfd_coff_write_task_globals
592 (struct coff_link_hash_entry *, void *);
593 extern bool _bfd_coff_link_input_bfd
594 (struct coff_final_link_info *, bfd *);
595 extern bool _bfd_coff_reloc_link_order
596 (bfd *, struct coff_final_link_info *, asection *,
597 struct bfd_link_order *);
598 extern bool bfd_coff_gc_sections
599 (bfd *, struct bfd_link_info *);
600 extern const char *bfd_coff_group_name
601 (bfd *, const asection *);
603 #define coff_get_section_contents_in_window \
604 _bfd_generic_get_section_contents_in_window
606 /* Functions in xcofflink.c. */
608 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
609 (bfd *);
610 extern long _bfd_xcoff_canonicalize_dynamic_symtab
611 (bfd *, asymbol **);
612 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
613 (bfd *);
614 extern long _bfd_xcoff_canonicalize_dynamic_reloc
615 (bfd *, arelent **, asymbol **);
616 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
617 (bfd *);
618 extern bool _bfd_xcoff_bfd_link_add_symbols
619 (bfd *, struct bfd_link_info *);
620 extern bool _bfd_xcoff_bfd_final_link
621 (bfd *, struct bfd_link_info *);
622 extern bool _bfd_xcoff_define_common_symbol
623 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
624 extern bool _bfd_ppc_xcoff_relocate_section
625 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
626 struct internal_reloc *, struct internal_syment *, asection **);