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