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