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