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