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