1/* DO NOT EDIT!  -*- buffer-read-only: t -*-  This file is automatically
2   generated from "libcoff-in.h" and "coffcode.h".
3   Run "make headers" in your build bfd/ to regenerate.  */
4
5/* BFD COFF object file private structure.
6   Copyright (C) 1990-2022 Free Software Foundation, Inc.
7   Written by Cygnus Support.
8
9   This file is part of BFD, the Binary File Descriptor library.
10
11   This program is free software; you can redistribute it and/or modify
12   it under the terms of the GNU General Public License as published by
13   the Free Software Foundation; either version 3 of the License, or
14   (at your option) any later version.
15
16   This program is distributed in the hope that it will be useful,
17   but WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19   GNU General Public License for more details.
20
21   You should have received a copy of the GNU General Public License
22   along with this program; if not, write to the Free Software
23   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
24   MA 02110-1301, USA.  */
25
26#ifndef _LIBCOFF_H
27#define _LIBCOFF_H 1
28
29#include "bfdlink.h"
30#include "coff-bfd.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/* Object file tdata; access macros.  */
37
38#define coff_data(bfd)		      ((bfd)->tdata.coff_obj_data)
39#define obj_pe(bfd)		      (coff_data (bfd)->pe)
40#define obj_go32(bfd)		      (coff_data (bfd)->go32)
41#define obj_symbols(bfd)	      (coff_data (bfd)->symbols)
42#define obj_sym_filepos(bfd)	      (coff_data (bfd)->sym_filepos)
43#define obj_relocbase(bfd)	      (coff_data (bfd)->relocbase)
44#define obj_raw_syments(bfd)	      (coff_data (bfd)->raw_syments)
45#define obj_raw_syment_count(bfd)     (coff_data (bfd)->raw_syment_count)
46#define obj_convert(bfd)	      (coff_data (bfd)->conversion_table)
47#define obj_conv_table_size(bfd)      (coff_data (bfd)->conv_table_size)
48#define obj_coff_external_syms(bfd)   (coff_data (bfd)->external_syms)
49#define obj_coff_keep_syms(bfd)	      (coff_data (bfd)->keep_syms)
50#define obj_coff_strings(bfd)	      (coff_data (bfd)->strings)
51#define obj_coff_strings_len(bfd)     (coff_data (bfd)->strings_len)
52#define obj_coff_keep_strings(bfd)    (coff_data (bfd)->keep_strings)
53#define obj_coff_sym_hashes(bfd)      (coff_data (bfd)->sym_hashes)
54#define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
55#define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
56
57/* `Tdata' information kept for COFF files.  */
58
59typedef struct coff_tdata
60{
61  struct coff_symbol_struct *symbols;	/* Symtab for input bfd.  */
62  unsigned int *conversion_table;
63  int conv_table_size;
64  file_ptr sym_filepos;
65
66  struct coff_ptr_struct *raw_syments;
67  unsigned long raw_syment_count;
68
69  /* These are only valid once writing has begun.  */
70  unsigned long int relocbase;
71
72  /* These members communicate important constants about the symbol table
73     to GDB's symbol-reading code.  These `constants' unfortunately vary
74     from coff implementation to implementation...  */
75  unsigned local_n_btmask;
76  unsigned local_n_btshft;
77  unsigned local_n_tmask;
78  unsigned local_n_tshift;
79  unsigned local_symesz;
80  unsigned local_auxesz;
81  unsigned local_linesz;
82
83  /* The unswapped external symbols.  May be NULL.  Read by
84     _bfd_coff_get_external_symbols.  */
85  void * external_syms;
86  /* If this is TRUE, the external_syms may not be freed.  */
87  bool keep_syms;
88
89  /* The string table.  May be NULL.  Read by
90     _bfd_coff_read_string_table.  */
91  char *strings;
92  /* The length of the strings table.  For error checking.  */
93  bfd_size_type strings_len;
94  /* If this is TRUE, the strings may not be freed.  */
95  bool keep_strings;
96  /* If this is TRUE, the strings have been written out already.  */
97  bool strings_written;
98
99  /* Is this a PE format coff file?  */
100  int pe;
101  /* Used by the COFF backend linker.  */
102  struct coff_link_hash_entry **sym_hashes;
103
104  /* Used by the pe linker for PowerPC.  */
105  int *local_toc_sym_map;
106
107  struct bfd_link_info *link_info;
108
109  /* Used by coff_find_nearest_line.  */
110  void * line_info;
111
112  /* A place to stash dwarf2 info for this bfd.  */
113  void * dwarf2_find_line_info;
114
115  /* The timestamp from the COFF file header.  */
116  long timestamp;
117
118  /* Copy of some of the f_flags bits in the COFF filehdr structure,
119     used by ARM code.  */
120  flagword flags;
121
122  /* Is this a GO32 coff file?  */
123  bool go32;
124
125  /* A stub (extra data prepended before the COFF image) and its size.
126     Used by coff-go32-exe, it contains executable data that loads the
127     COFF object into memory.  */
128  char * stub;
129  bfd_size_type stub_size;
130} coff_data_type;
131
132/* Tdata for pe image files.  */
133typedef struct pe_tdata
134{
135  coff_data_type coff;
136  struct internal_extra_pe_aouthdr pe_opthdr;
137  int dll;
138  int has_reloc_section;
139  int dont_strip_reloc;
140  int dos_message[16];
141  /* The timestamp to insert into the output file.
142     If the timestamp is -1 then the current time is used.  */
143  int timestamp;
144  bool (*in_reloc_p) (bfd *, reloc_howto_type *);
145  flagword real_flags;
146
147  /* Build-id info.  */
148  struct
149  {
150    bool (*after_write_object_contents) (bfd *);
151    const char *style;
152    asection *sec;
153  } build_id;
154} pe_data_type;
155
156#define pe_data(bfd)		((bfd)->tdata.pe_obj_data)
157
158/* Tdata for XCOFF files.  */
159
160struct xcoff_tdata
161{
162  /* Basic COFF information.  */
163  coff_data_type coff;
164
165  /* TRUE if this is an XCOFF64 file. */
166  bool xcoff64;
167
168  /* TRUE if a large a.out header should be generated.  */
169  bool full_aouthdr;
170
171  /* TOC value.  */
172  bfd_vma toc;
173
174  /* Index of section holding TOC.  */
175  int sntoc;
176
177  /* Index of section holding entry point.  */
178  int snentry;
179
180  /* .text alignment from optional header.  */
181  int text_align_power;
182
183  /* .data alignment from optional header.  */
184  int data_align_power;
185
186  /* modtype from optional header.  */
187  short modtype;
188
189  /* cputype from optional header.  */
190  short cputype;
191
192  /* maxdata from optional header.  */
193  bfd_vma maxdata;
194
195  /* maxstack from optional header.  */
196  bfd_vma maxstack;
197
198  /* Used by the XCOFF backend linker.  */
199  asection **csects;
200  long *debug_indices;
201  unsigned int *lineno_counts;
202  unsigned int import_file_id;
203};
204
205#define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
206
207/* We take the address of the first element of an asymbol to ensure that the
208   macro is only ever applied to an asymbol.  */
209#define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
210
211/* Tdata for sections in XCOFF files.  This is used by the linker.  */
212
213struct xcoff_section_tdata
214{
215  /* Used for XCOFF csects created by the linker; points to the real
216     XCOFF section which contains this csect.  */
217  asection *enclosing;
218  /* The lineno_count field for the enclosing section, because we are
219     going to clobber it there.  */
220  unsigned int lineno_count;
221  /* The first and last symbol indices for symbols used by this csect.  */
222  unsigned long first_symndx;
223  unsigned long last_symndx;
224};
225
226/* An accessor macro the xcoff_section_tdata structure.  */
227#define xcoff_section_data(abfd, sec) \
228  ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
229
230/* Tdata for sections in PE files.  */
231
232struct pei_section_tdata
233{
234  /* The virtual size of the section.  */
235  bfd_size_type virt_size;
236  /* The PE section flags.  */
237  long pe_flags;
238};
239
240/* An accessor macro for the pei_section_tdata structure.  */
241#define pei_section_data(abfd, sec) \
242  ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
243
244/* COFF linker hash table entries.  */
245
246struct coff_link_hash_entry
247{
248  struct bfd_link_hash_entry root;
249
250  /* Symbol index in output file.  This is initialized to -1.  It is
251     set to -2 if the symbol is used by a reloc.  It is set to -3 if
252     this symbol is defined in a discarded section.  */
253  long indx;
254
255  /* Symbol type.  */
256  unsigned short type;
257
258  /* Symbol class.  */
259  unsigned char symbol_class;
260
261  /* Number of auxiliary entries.  */
262  char numaux;
263
264  /* BFD to take auxiliary entries from.  */
265  bfd *auxbfd;
266
267  /* Pointer to array of auxiliary entries, if any.  */
268  union internal_auxent *aux;
269
270  /* Flag word; legal values follow.  */
271  unsigned short coff_link_hash_flags;
272  /* Symbol is a PE section symbol.  */
273#define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
274};
275
276/* COFF linker hash table.  */
277
278struct coff_link_hash_table
279{
280  struct bfd_link_hash_table root;
281  /* A pointer to information used to link stabs in sections.  */
282  struct stab_info stab_info;
283};
284
285struct coff_reloc_cookie
286{
287  struct internal_reloc *	  rels;
288  struct internal_reloc *	  rel;
289  struct internal_reloc *	  relend;
290  struct coff_symbol_struct *	  symbols;	/* Symtab for input bfd.  */
291  bfd *				  abfd;
292  struct coff_link_hash_entry **  sym_hashes;
293};
294
295/* Look up an entry in a COFF linker hash table.  */
296
297#define coff_link_hash_lookup(table, string, create, copy, follow)	\
298  ((struct coff_link_hash_entry *)					\
299   bfd_link_hash_lookup (&(table)->root, (string), (create),		\
300			 (copy), (follow)))
301
302/* Traverse a COFF linker hash table.  */
303
304#define coff_link_hash_traverse(table, func, info)			\
305  (bfd_link_hash_traverse						\
306   (&(table)->root,							\
307    (bool (*) (struct bfd_link_hash_entry *, void *)) (func),		\
308    (info)))
309
310/* Get the COFF linker hash table from a link_info structure.  */
311
312#define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
313
314/* Functions in coffgen.c.  */
315extern bfd_cleanup coff_object_p
316  (bfd *);
317extern struct bfd_section *coff_section_from_bfd_index
318  (bfd *, int);
319extern long coff_get_symtab_upper_bound
320  (bfd *);
321extern long coff_canonicalize_symtab
322  (bfd *, asymbol **);
323extern int coff_count_linenumbers
324  (bfd *);
325extern bool coff_renumber_symbols
326  (bfd *, int *);
327extern void coff_mangle_symbols
328  (bfd *);
329extern bool coff_write_symbols
330  (bfd *);
331extern bool coff_write_alien_symbol
332  (bfd *, asymbol *, struct internal_syment *, bfd_vma *,
333   struct bfd_strtab_hash *, bool, asection **, bfd_size_type *);
334extern bool coff_write_linenumbers
335  (bfd *);
336extern alent *coff_get_lineno
337  (bfd *, asymbol *);
338extern asymbol *coff_section_symbol
339  (bfd *, char *);
340extern bool _bfd_coff_get_external_symbols
341  (bfd *);
342extern const char *_bfd_coff_read_string_table
343  (bfd *);
344extern bool _bfd_coff_free_symbols
345  (bfd *);
346extern struct coff_ptr_struct *coff_get_normalized_symtab
347  (bfd *);
348extern long coff_get_reloc_upper_bound
349  (bfd *, sec_ptr);
350extern asymbol *coff_make_empty_symbol
351  (bfd *);
352extern void coff_print_symbol
353  (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
354extern void coff_get_symbol_info
355  (bfd *, asymbol *, symbol_info *ret);
356#define coff_get_symbol_version_string \
357  _bfd_nosymbols_get_symbol_version_string
358extern bool _bfd_coff_is_local_label_name
359  (bfd *, const char *);
360extern asymbol *coff_bfd_make_debug_symbol
361  (bfd *, void *, unsigned long);
362extern bool coff_find_nearest_line
363  (bfd *, asymbol **, asection *, bfd_vma,
364   const char **, const char **, unsigned int *, unsigned int *);
365#define coff_find_nearest_line_with_alt \
366  _bfd_nosymbols_find_nearest_line_with_alt
367#define coff_find_line _bfd_nosymbols_find_line
368struct dwarf_debug_section;
369extern bool coff_find_nearest_line_with_names
370  (bfd *, asymbol **, asection *, bfd_vma, const char **, const char **,
371   unsigned int *, const struct dwarf_debug_section *);
372extern bool coff_find_inliner_info
373  (bfd *, const char **, const char **, unsigned int *);
374extern int coff_sizeof_headers
375  (bfd *, struct bfd_link_info *);
376extern bool bfd_coff_reloc16_relax_section
377  (bfd *, asection *, struct bfd_link_info *, bool *);
378extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
379  (bfd *, struct bfd_link_info *, struct bfd_link_order *,
380   bfd_byte *, bool, asymbol **);
381extern bfd_vma bfd_coff_reloc16_get_value
382  (arelent *, struct bfd_link_info *, asection *);
383extern void bfd_perform_slip
384  (bfd *, unsigned int, asection *, bfd_vma);
385extern bool _bfd_coff_close_and_cleanup
386  (bfd *);
387
388/* Functions and types in cofflink.c.  */
389
390#define STRING_SIZE_SIZE 4
391
392/* We use a hash table to merge identical enum, struct, and union
393   definitions in the linker.  */
394
395/* Information we keep for a single element (an enum value, a
396   structure or union field) in the debug merge hash table.  */
397
398struct coff_debug_merge_element
399{
400  /* Next element.  */
401  struct coff_debug_merge_element *next;
402
403  /* Name.  */
404  const char *name;
405
406  /* Type.  */
407  unsigned int type;
408
409  /* Symbol index for complex type.  */
410  long tagndx;
411};
412
413/* A linked list of debug merge entries for a given name.  */
414
415struct coff_debug_merge_type
416{
417  /* Next type with the same name.  */
418  struct coff_debug_merge_type *next;
419
420  /* Class of type.  */
421  int type_class;
422
423  /* Symbol index where this type is defined.  */
424  long indx;
425
426  /* List of elements.  */
427  struct coff_debug_merge_element *elements;
428};
429
430/* Information we store in the debug merge hash table.  */
431
432struct coff_debug_merge_hash_entry
433{
434  struct bfd_hash_entry root;
435
436  /* A list of types with this name.  */
437  struct coff_debug_merge_type *types;
438};
439
440/* The debug merge hash table.  */
441
442struct coff_debug_merge_hash_table
443{
444  struct bfd_hash_table root;
445};
446
447/* Initialize a COFF debug merge hash table.  */
448
449#define coff_debug_merge_hash_table_init(table) \
450  (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
451			sizeof (struct coff_debug_merge_hash_entry)))
452
453/* Free a COFF debug merge hash table.  */
454
455#define coff_debug_merge_hash_table_free(table) \
456  (bfd_hash_table_free (&(table)->root))
457
458/* Look up an entry in a COFF debug merge hash table.  */
459
460#define coff_debug_merge_hash_lookup(table, string, create, copy) \
461  ((struct coff_debug_merge_hash_entry *) \
462   bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
463
464/* Information we keep for each section in the output file when doing
465   a relocatable link.  */
466
467struct coff_link_section_info
468{
469  /* The relocs to be output.  */
470  struct internal_reloc *relocs;
471  /* For each reloc against a global symbol whose index was not known
472     when the reloc was handled, the global hash table entry.  */
473  struct coff_link_hash_entry **rel_hashes;
474};
475
476/* Information that we pass around while doing the final link step.  */
477
478struct coff_final_link_info
479{
480  /* General link information.  */
481  struct bfd_link_info *info;
482  /* Output BFD.  */
483  bfd *output_bfd;
484  /* Used to indicate failure in traversal routine.  */
485  bool failed;
486  /* If doing "task linking" set only during the time when we want the
487     global symbol writer to convert the storage class of defined global
488     symbols from global to static. */
489  bool global_to_static;
490  /* Hash table for long symbol names.  */
491  struct bfd_strtab_hash *strtab;
492  /* When doing a relocatable link, an array of information kept for
493     each output section, indexed by the target_index field.  */
494  struct coff_link_section_info *section_info;
495  /* Symbol index of last C_FILE symbol (-1 if none).  */
496  long last_file_index;
497  /* Contents of last C_FILE symbol.  */
498  struct internal_syment last_file;
499  /* Symbol index of first aux entry of last .bf symbol with an empty
500     endndx field (-1 if none).  */
501  long last_bf_index;
502  /* Contents of last_bf_index aux entry.  */
503  union internal_auxent last_bf;
504  /* Hash table used to merge debug information.  */
505  struct coff_debug_merge_hash_table debug_merge;
506  /* Buffer large enough to hold swapped symbols of any input file.  */
507  struct internal_syment *internal_syms;
508  /* Buffer large enough to hold sections of symbols of any input file.  */
509  asection **sec_ptrs;
510  /* Buffer large enough to hold output indices of symbols of any
511     input file.  */
512  long *sym_indices;
513  /* Buffer large enough to hold output symbols for any input file.  */
514  bfd_byte *outsyms;
515  /* Buffer large enough to hold external line numbers for any input
516     section.  */
517  bfd_byte *linenos;
518  /* Buffer large enough to hold any input section.  */
519  bfd_byte *contents;
520  /* Buffer large enough to hold external relocs of any input section.  */
521  bfd_byte *external_relocs;
522  /* Buffer large enough to hold swapped relocs of any input section.  */
523  struct internal_reloc *internal_relocs;
524};
525
526/* Most COFF variants have no way to record the alignment of a
527   section.  This struct is used to set a specific alignment based on
528   the name of the section.  */
529
530struct coff_section_alignment_entry
531{
532  /* The section name.  */
533  const char *name;
534
535  /* This is either (unsigned int) -1, indicating that the section
536     name must match exactly, or it is the number of letters which
537     must match at the start of the name.  */
538  unsigned int comparison_length;
539
540  /* These macros may be used to fill in the first two fields in a
541     structure initialization.  */
542#define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
543#define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
544
545  /* Only use this entry if the default section alignment for this
546     target is at least that much (as a power of two).  If this field
547     is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
548  unsigned int default_alignment_min;
549
550  /* Only use this entry if the default section alignment for this
551     target is no greater than this (as a power of two).  If this
552     field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
553  unsigned int default_alignment_max;
554
555#define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
556
557  /* The desired alignment for this section (as a power of two).  */
558  unsigned int alignment_power;
559};
560
561extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
562  (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
563extern bool _bfd_coff_link_hash_table_init
564  (struct coff_link_hash_table *, bfd *,
565   struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
566			       struct bfd_hash_table *,
567			       const char *),
568   unsigned int);
569extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
570  (bfd *);
571extern const char *_bfd_coff_internal_syment_name
572  (bfd *, const struct internal_syment *, char *);
573extern bool _bfd_coff_section_already_linked
574  (bfd *, asection *, struct bfd_link_info *);
575extern bool _bfd_coff_link_add_symbols
576  (bfd *, struct bfd_link_info *);
577extern bool _bfd_coff_final_link
578  (bfd *, struct bfd_link_info *);
579extern struct internal_reloc *_bfd_coff_read_internal_relocs
580  (bfd *, asection *, bool, bfd_byte *, bool,
581   struct internal_reloc *);
582extern bool _bfd_coff_generic_relocate_section
583  (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
584   struct internal_reloc *, struct internal_syment *, asection **);
585extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
586  (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
587extern bool _bfd_coff_write_global_sym
588  (struct bfd_hash_entry *, void *);
589extern bool _bfd_coff_write_task_globals
590  (struct coff_link_hash_entry *, void *);
591extern bool _bfd_coff_link_input_bfd
592  (struct coff_final_link_info *, bfd *);
593extern bool _bfd_coff_reloc_link_order
594  (bfd *, struct coff_final_link_info *, asection *,
595   struct bfd_link_order *);
596extern bool bfd_coff_gc_sections
597  (bfd *, struct bfd_link_info *);
598extern const char *bfd_coff_group_name
599  (bfd *, const asection *);
600
601#define coff_get_section_contents_in_window \
602  _bfd_generic_get_section_contents_in_window
603
604/* Functions in xcofflink.c.  */
605
606extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
607  (bfd *);
608extern long _bfd_xcoff_canonicalize_dynamic_symtab
609  (bfd *, asymbol **);
610extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
611  (bfd *);
612extern long _bfd_xcoff_canonicalize_dynamic_reloc
613  (bfd *, arelent **, asymbol **);
614extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
615  (bfd *);
616extern bool _bfd_xcoff_bfd_link_add_symbols
617  (bfd *, struct bfd_link_info *);
618extern bool _bfd_xcoff_bfd_final_link
619  (bfd *, struct bfd_link_info *);
620extern bool _bfd_xcoff_define_common_symbol
621  (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
622extern bool _bfd_ppc_xcoff_relocate_section
623  (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
624   struct internal_reloc *, struct internal_syment *, asection **);
625/* Extracted from coffcode.h.  */
626
627typedef struct coff_ptr_struct
628{
629  /* Remembers the offset from the first symbol in the file for
630     this symbol. Generated by coff_renumber_symbols.  */
631  unsigned int offset;
632
633  /* Should the value of this symbol be renumbered.  Used for
634     XCOFF C_BSTAT symbols.  Set by coff_slurp_symbol_table.  */
635  unsigned int fix_value : 1;
636
637  /* Should the tag field of this symbol be renumbered.
638     Created by coff_pointerize_aux.  */
639  unsigned int fix_tag : 1;
640
641  /* Should the endidx field of this symbol be renumbered.
642     Created by coff_pointerize_aux.  */
643  unsigned int fix_end : 1;
644
645  /* Should the x_csect.x_scnlen field be renumbered.
646     Created by coff_pointerize_aux.  */
647  unsigned int fix_scnlen : 1;
648
649  /* Fix up an XCOFF C_BINCL/C_EINCL symbol.  The value is the
650     index into the line number entries.  Set by coff_slurp_symbol_table.  */
651  unsigned int fix_line : 1;
652
653  /* The container for the symbol structure as read and translated
654     from the file.  */
655  union
656  {
657    union internal_auxent auxent;
658    struct internal_syment syment;
659  } u;
660
661 /* Selector for the union above.  */
662 bool is_sym;
663
664 /* An extra pointer which can used by format based on COFF (like XCOFF)
665    to provide extra information to their backend.  */
666 void *extrap;
667} combined_entry_type;
668
669
670/* Each canonical asymbol really looks like this: */
671
672typedef struct coff_symbol_struct
673{
674  /* The actual symbol which the rest of BFD works with */
675  asymbol symbol;
676
677  /* A pointer to the hidden information for this symbol */
678  combined_entry_type *native;
679
680  /* A pointer to the linenumber information for this symbol */
681  struct lineno_cache_entry *lineno;
682
683  /* Have the line numbers been relocated yet ? */
684  bool done_lineno;
685} coff_symbol_type;
686/* COFF symbol classifications.  */
687
688enum coff_symbol_classification
689{
690  /* Global symbol.  */
691  COFF_SYMBOL_GLOBAL,
692  /* Common symbol.  */
693  COFF_SYMBOL_COMMON,
694  /* Undefined symbol.  */
695  COFF_SYMBOL_UNDEFINED,
696  /* Local symbol.  */
697  COFF_SYMBOL_LOCAL,
698  /* PE section symbol.  */
699  COFF_SYMBOL_PE_SECTION
700};
701
702typedef asection * (*coff_gc_mark_hook_fn)
703  (asection *, struct bfd_link_info *, struct internal_reloc *,
704   struct coff_link_hash_entry *, struct internal_syment *);
705
706typedef struct
707{
708  void (*_bfd_coff_swap_aux_in)
709    (bfd *, void *, int, int, int, int, void *);
710
711  void (*_bfd_coff_swap_sym_in)
712    (bfd *, void *, void *);
713
714  void (*_bfd_coff_swap_lineno_in)
715    (bfd *, void *, void *);
716
717  unsigned int (*_bfd_coff_swap_aux_out)
718    (bfd *, void *, int, int, int, int, void *);
719
720  unsigned int (*_bfd_coff_swap_sym_out)
721    (bfd *, void *, void *);
722
723  unsigned int (*_bfd_coff_swap_lineno_out)
724    (bfd *, void *, void *);
725
726  unsigned int (*_bfd_coff_swap_reloc_out)
727    (bfd *, void *, void *);
728
729  unsigned int (*_bfd_coff_swap_filehdr_out)
730    (bfd *, void *, void *);
731
732  unsigned int (*_bfd_coff_swap_aouthdr_out)
733    (bfd *, void *, void *);
734
735  unsigned int (*_bfd_coff_swap_scnhdr_out)
736    (bfd *, void *, void *);
737
738  unsigned int _bfd_filhsz;
739  unsigned int _bfd_aoutsz;
740  unsigned int _bfd_scnhsz;
741  unsigned int _bfd_symesz;
742  unsigned int _bfd_auxesz;
743  unsigned int _bfd_relsz;
744  unsigned int _bfd_linesz;
745  unsigned int _bfd_filnmlen;
746  bool _bfd_coff_long_filenames;
747
748  bool _bfd_coff_long_section_names;
749  bool (*_bfd_coff_set_long_section_names)
750    (bfd *, int);
751
752  unsigned int _bfd_coff_default_section_alignment_power;
753  bool _bfd_coff_force_symnames_in_strings;
754  unsigned int _bfd_coff_debug_string_prefix_length;
755  unsigned int _bfd_coff_max_nscns;
756
757  void (*_bfd_coff_swap_filehdr_in)
758    (bfd *, void *, void *);
759
760  void (*_bfd_coff_swap_aouthdr_in)
761    (bfd *, void *, void *);
762
763  void (*_bfd_coff_swap_scnhdr_in)
764    (bfd *, void *, void *);
765
766  void (*_bfd_coff_swap_reloc_in)
767    (bfd *abfd, void *, void *);
768
769  bool (*_bfd_coff_bad_format_hook)
770    (bfd *, void *);
771
772  bool (*_bfd_coff_set_arch_mach_hook)
773    (bfd *, void *);
774
775  void * (*_bfd_coff_mkobject_hook)
776    (bfd *, void *, void *);
777
778  bool (*_bfd_styp_to_sec_flags_hook)
779    (bfd *, void *, const char *, asection *, flagword *);
780
781  void (*_bfd_set_alignment_hook)
782    (bfd *, asection *, void *);
783
784  bool (*_bfd_coff_slurp_symbol_table)
785    (bfd *);
786
787  bool (*_bfd_coff_symname_in_debug)
788    (bfd *, struct internal_syment *);
789
790  bool (*_bfd_coff_pointerize_aux_hook)
791    (bfd *, combined_entry_type *, combined_entry_type *,
792     unsigned int, combined_entry_type *);
793
794  bool (*_bfd_coff_print_aux)
795    (bfd *, FILE *, combined_entry_type *, combined_entry_type *,
796     combined_entry_type *, unsigned int);
797
798  void (*_bfd_coff_reloc16_extra_cases)
799    (bfd *, struct bfd_link_info *, struct bfd_link_order *, arelent *,
800     bfd_byte *, unsigned int *, unsigned int *);
801
802  int (*_bfd_coff_reloc16_estimate)
803    (bfd *, asection *, arelent *, unsigned int,
804     struct bfd_link_info *);
805
806  enum coff_symbol_classification (*_bfd_coff_classify_symbol)
807    (bfd *, struct internal_syment *);
808
809  bool (*_bfd_coff_compute_section_file_positions)
810    (bfd *);
811
812  bool (*_bfd_coff_start_final_link)
813    (bfd *, struct bfd_link_info *);
814
815  bool (*_bfd_coff_relocate_section)
816    (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
817     struct internal_reloc *, struct internal_syment *, asection **);
818
819  reloc_howto_type *(*_bfd_coff_rtype_to_howto)
820    (bfd *, asection *, struct internal_reloc *,
821     struct coff_link_hash_entry *, struct internal_syment *, bfd_vma *);
822
823  bool (*_bfd_coff_adjust_symndx)
824    (bfd *, struct bfd_link_info *, bfd *, asection *,
825     struct internal_reloc *, bool *);
826
827  bool (*_bfd_coff_link_add_one_symbol)
828    (struct bfd_link_info *, bfd *, const char *, flagword,
829     asection *, bfd_vma, const char *, bool, bool,
830     struct bfd_link_hash_entry **);
831
832  bool (*_bfd_coff_link_output_has_begun)
833    (bfd *, struct coff_final_link_info *);
834
835  bool (*_bfd_coff_final_link_postscript)
836    (bfd *, struct coff_final_link_info *);
837
838  bool (*_bfd_coff_print_pdata)
839    (bfd *, void *);
840
841} bfd_coff_backend_data;
842
843#define coff_backend_info(abfd) \
844  ((bfd_coff_backend_data *) (abfd)->xvec->backend_data)
845
846#define bfd_coff_swap_aux_in(a,e,t,c,ind,num,i) \
847  ((coff_backend_info (a)->_bfd_coff_swap_aux_in) (a,e,t,c,ind,num,i))
848
849#define bfd_coff_swap_sym_in(a,e,i) \
850  ((coff_backend_info (a)->_bfd_coff_swap_sym_in) (a,e,i))
851
852#define bfd_coff_swap_lineno_in(a,e,i) \
853  ((coff_backend_info ( a)->_bfd_coff_swap_lineno_in) (a,e,i))
854
855#define bfd_coff_swap_reloc_out(abfd, i, o) \
856  ((coff_backend_info (abfd)->_bfd_coff_swap_reloc_out) (abfd, i, o))
857
858#define bfd_coff_swap_lineno_out(abfd, i, o) \
859  ((coff_backend_info (abfd)->_bfd_coff_swap_lineno_out) (abfd, i, o))
860
861#define bfd_coff_swap_aux_out(a,i,t,c,ind,num,o) \
862  ((coff_backend_info (a)->_bfd_coff_swap_aux_out) (a,i,t,c,ind,num,o))
863
864#define bfd_coff_swap_sym_out(abfd, i,o) \
865  ((coff_backend_info (abfd)->_bfd_coff_swap_sym_out) (abfd, i, o))
866
867#define bfd_coff_swap_scnhdr_out(abfd, i,o) \
868  ((coff_backend_info (abfd)->_bfd_coff_swap_scnhdr_out) (abfd, i, o))
869
870#define bfd_coff_swap_filehdr_out(abfd, i,o) \
871  ((coff_backend_info (abfd)->_bfd_coff_swap_filehdr_out) (abfd, i, o))
872
873#define bfd_coff_swap_aouthdr_out(abfd, i,o) \
874  ((coff_backend_info (abfd)->_bfd_coff_swap_aouthdr_out) (abfd, i, o))
875
876#define bfd_coff_filhsz(abfd) (coff_backend_info (abfd)->_bfd_filhsz)
877#define bfd_coff_aoutsz(abfd) (coff_backend_info (abfd)->_bfd_aoutsz)
878#define bfd_coff_scnhsz(abfd) (coff_backend_info (abfd)->_bfd_scnhsz)
879#define bfd_coff_symesz(abfd) (coff_backend_info (abfd)->_bfd_symesz)
880#define bfd_coff_auxesz(abfd) (coff_backend_info (abfd)->_bfd_auxesz)
881#define bfd_coff_relsz(abfd)  (coff_backend_info (abfd)->_bfd_relsz)
882#define bfd_coff_linesz(abfd) (coff_backend_info (abfd)->_bfd_linesz)
883#define bfd_coff_filnmlen(abfd) (coff_backend_info (abfd)->_bfd_filnmlen)
884#define bfd_coff_long_filenames(abfd) \
885  (coff_backend_info (abfd)->_bfd_coff_long_filenames)
886#define bfd_coff_long_section_names(abfd) \
887  (coff_backend_info (abfd)->_bfd_coff_long_section_names)
888#define bfd_coff_set_long_section_names(abfd, enable) \
889  ((coff_backend_info (abfd)->_bfd_coff_set_long_section_names) (abfd, enable))
890#define bfd_coff_default_section_alignment_power(abfd) \
891  (coff_backend_info (abfd)->_bfd_coff_default_section_alignment_power)
892#define bfd_coff_max_nscns(abfd) \
893  (coff_backend_info (abfd)->_bfd_coff_max_nscns)
894
895#define bfd_coff_swap_filehdr_in(abfd, i,o) \
896  ((coff_backend_info (abfd)->_bfd_coff_swap_filehdr_in) (abfd, i, o))
897
898#define bfd_coff_swap_aouthdr_in(abfd, i,o) \
899  ((coff_backend_info (abfd)->_bfd_coff_swap_aouthdr_in) (abfd, i, o))
900
901#define bfd_coff_swap_scnhdr_in(abfd, i,o) \
902  ((coff_backend_info (abfd)->_bfd_coff_swap_scnhdr_in) (abfd, i, o))
903
904#define bfd_coff_swap_reloc_in(abfd, i, o) \
905  ((coff_backend_info (abfd)->_bfd_coff_swap_reloc_in) (abfd, i, o))
906
907#define bfd_coff_bad_format_hook(abfd, filehdr) \
908  ((coff_backend_info (abfd)->_bfd_coff_bad_format_hook) (abfd, filehdr))
909
910#define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
911  ((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
912#define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
913  ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook)\
914   (abfd, filehdr, aouthdr))
915
916#define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name, section, flags_ptr)\
917  ((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook)\
918   (abfd, scnhdr, name, section, flags_ptr))
919
920#define bfd_coff_set_alignment_hook(abfd, sec, scnhdr)\
921  ((coff_backend_info (abfd)->_bfd_set_alignment_hook) (abfd, sec, scnhdr))
922
923#define bfd_coff_slurp_symbol_table(abfd)\
924  ((coff_backend_info (abfd)->_bfd_coff_slurp_symbol_table) (abfd))
925
926#define bfd_coff_symname_in_debug(abfd, sym)\
927  ((coff_backend_info (abfd)->_bfd_coff_symname_in_debug) (abfd, sym))
928
929#define bfd_coff_force_symnames_in_strings(abfd)\
930  (coff_backend_info (abfd)->_bfd_coff_force_symnames_in_strings)
931
932#define bfd_coff_debug_string_prefix_length(abfd)\
933  (coff_backend_info (abfd)->_bfd_coff_debug_string_prefix_length)
934
935#define bfd_coff_print_aux(abfd, file, base, symbol, aux, indaux)\
936  ((coff_backend_info (abfd)->_bfd_coff_print_aux)\
937   (abfd, file, base, symbol, aux, indaux))
938
939#define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order,\
940                                     reloc, data, src_ptr, dst_ptr)\
941  ((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
942   (abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
943
944#define bfd_coff_reloc16_estimate(abfd, section, reloc, shrink, link_info)\
945  ((coff_backend_info (abfd)->_bfd_coff_reloc16_estimate)\
946   (abfd, section, reloc, shrink, link_info))
947
948#define bfd_coff_classify_symbol(abfd, sym)\
949  ((coff_backend_info (abfd)->_bfd_coff_classify_symbol)\
950   (abfd, sym))
951
952#define bfd_coff_compute_section_file_positions(abfd)\
953  ((coff_backend_info (abfd)->_bfd_coff_compute_section_file_positions)\
954   (abfd))
955
956#define bfd_coff_start_final_link(obfd, info)\
957  ((coff_backend_info (obfd)->_bfd_coff_start_final_link)\
958   (obfd, info))
959#define bfd_coff_relocate_section(obfd,info,ibfd,o,con,rel,isyms,secs)\
960  ((coff_backend_info (ibfd)->_bfd_coff_relocate_section)\
961   (obfd, info, ibfd, o, con, rel, isyms, secs))
962#define bfd_coff_rtype_to_howto(abfd, sec, rel, h, sym, addendp)\
963  ((coff_backend_info (abfd)->_bfd_coff_rtype_to_howto)\
964   (abfd, sec, rel, h, sym, addendp))
965#define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
966  ((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
967   (obfd, info, ibfd, sec, rel, adjustedp))
968#define bfd_coff_link_add_one_symbol(info, abfd, name, flags, section,\
969                                     value, string, cp, coll, hashp)\
970  ((coff_backend_info (abfd)->_bfd_coff_link_add_one_symbol)\
971   (info, abfd, name, flags, section, value, string, cp, coll, hashp))
972
973#define bfd_coff_link_output_has_begun(a,p) \
974  ((coff_backend_info (a)->_bfd_coff_link_output_has_begun) (a, p))
975#define bfd_coff_final_link_postscript(a,p) \
976  ((coff_backend_info (a)->_bfd_coff_final_link_postscript) (a, p))
977
978#define bfd_coff_have_print_pdata(a) \
979  (coff_backend_info (a)->_bfd_coff_print_pdata)
980#define bfd_coff_print_pdata(a,p) \
981  ((coff_backend_info (a)->_bfd_coff_print_pdata) (a, p))
982
983/* Macro: Returns true if the bfd is a PE executable as opposed to a
984   PE object file.  */
985#define bfd_pei_p(abfd) \
986  (startswith ((abfd)->xvec->name, "pei-"))
987#ifdef __cplusplus
988}
989#endif
990#endif
991