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