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