Touches most files in bfd/, so likely will be blamed for everything..
[external/binutils.git] / bfd / libcoff-in.h
1 /* BFD COFF object file private structure.
2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3    2000, 2001
4    Free Software Foundation, Inc.
5    Written by Cygnus Support.
6
7 ** NOTE: libcoff.h is a GENERATED file.  Don't change it; instead,
8 ** change libcoff-in.h or coffcode.h.
9
10 This file is part of BFD, the Binary File Descriptor library.
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 GNU General Public License for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 exec_hdr(bfd)           (coff_data(bfd)->hdr)
32 #define obj_pe(bfd)             (coff_data(bfd)->pe)
33 #define obj_symbols(bfd)        (coff_data(bfd)->symbols)
34 #define obj_sym_filepos(bfd)    (coff_data(bfd)->sym_filepos)
35
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
42 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
43 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
44 #define obj_coff_strings(bfd)   (coff_data (bfd)->strings)
45 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
46 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
47 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
48
49 #define obj_coff_local_toc_table(bfd) (coff_data(bfd)->local_toc_sym_map)
50
51 /* `Tdata' information kept for COFF files.  */
52
53 typedef struct coff_tdata
54 {
55   struct   coff_symbol_struct *symbols; /* symtab for input bfd */
56   unsigned int *conversion_table;
57   int conv_table_size;
58   file_ptr sym_filepos;
59
60   struct coff_ptr_struct *raw_syments;
61   unsigned long raw_syment_count;
62
63   /* These are only valid once writing has begun */
64   long int relocbase;
65
66   /* These members communicate important constants about the symbol table
67      to GDB's symbol-reading code.  These `constants' unfortunately vary
68      from coff implementation to implementation...  */
69   unsigned local_n_btmask;
70   unsigned local_n_btshft;
71   unsigned local_n_tmask;
72   unsigned local_n_tshift;
73   unsigned local_symesz;
74   unsigned local_auxesz;
75   unsigned local_linesz;
76
77   /* The unswapped external symbols.  May be NULL.  Read by
78      _bfd_coff_get_external_symbols.  */
79   PTR external_syms;
80   /* If this is true, the external_syms may not be freed.  */
81   boolean keep_syms;
82
83   /* The string table.  May be NULL.  Read by
84      _bfd_coff_read_string_table.  */
85   char *strings;
86   /* If this is true, the strings may not be freed.  */
87   boolean keep_strings;
88   /* If this is true, the strings have been written out already.  */
89   boolean strings_written;
90
91   /* is this a PE format coff file */
92   int pe;
93   /* Used by the COFF backend linker.  */
94   struct coff_link_hash_entry **sym_hashes;
95
96   /* used by the pe linker for PowerPC */
97   int *local_toc_sym_map;
98
99   struct bfd_link_info *link_info;
100
101   /* Used by coff_find_nearest_line.  */
102   PTR line_info;
103
104   /* A place to stash dwarf2 info for this bfd. */
105   PTR dwarf2_find_line_info;
106
107   /* The timestamp from the COFF file header.  */
108   long timestamp;
109
110   /* Copy of some of the f_flags bits in the COFF filehdr structure,
111      used by ARM code.  */
112   flagword flags;
113
114 } coff_data_type;
115
116 /* Tdata for pe image files. */
117 typedef struct pe_tdata
118 {
119   coff_data_type coff;
120   struct internal_extra_pe_aouthdr pe_opthdr;
121   int dll;
122   int has_reloc_section;
123   boolean (*in_reloc_p) PARAMS((bfd *, reloc_howto_type *));
124   flagword real_flags;
125   int target_subsystem;
126   boolean force_minimum_alignment;
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   boolean xcoff64;
140
141   /* True if a large a.out header should be generated.  */
142   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   unsigned long *debug_indices;
174   unsigned int import_file_id;
175 };
176
177 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
178
179 /* We take the address of the first element of a asymbol to ensure that the
180  * macro is only ever applied to an asymbol.  */
181 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
182
183 /* The used_by_bfd field of a section may be set to a pointer to this
184    structure.  */
185
186 struct coff_section_tdata
187 {
188   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
189   struct internal_reloc *relocs;
190   /* If this is true, the relocs entry may not be freed.  */
191   boolean keep_relocs;
192   /* The section contents.  This may be NULL.  */
193   bfd_byte *contents;
194   /* If this is true, the contents entry may not be freed.  */
195   boolean keep_contents;
196   /* Information cached by coff_find_nearest_line.  */
197   bfd_vma offset;
198   unsigned int i;
199   const char *function;
200   int line_base;
201   /* A pointer used for .stab linking optimizations.  */
202   PTR stab_info;
203   /* Available for individual backends.  */
204   PTR tdata;
205 };
206
207 /* An accessor macro for the coff_section_tdata structure.  */
208 #define coff_section_data(abfd, sec) \
209   ((struct coff_section_tdata *) (sec)->used_by_bfd)
210
211 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
212
213 struct xcoff_section_tdata
214 {
215   /* Used for XCOFF csects created by the linker; points to the real
216      XCOFF section which contains this csect.  */
217   asection *enclosing;
218   /* The lineno_count field for the enclosing section, because we are
219      going to clobber it there.  */
220   unsigned int lineno_count;
221   /* The first and one past the last symbol indices for symbols used
222      by this csect.  */
223   unsigned long first_symndx;
224   unsigned long last_symndx;
225 };
226
227 /* An accessor macro the xcoff_section_tdata structure.  */
228 #define xcoff_section_data(abfd, sec) \
229   ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
230
231 /* Tdata for sections in PE files.  */
232
233 struct pei_section_tdata
234 {
235   /* The virtual size of the section.  */
236   bfd_size_type virt_size;
237   /* The PE section flags.  */
238   long pe_flags;
239 };
240
241 /* An accessor macro for the pei_section_tdata structure.  */
242 #define pei_section_data(abfd, sec) \
243   ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
244
245 /* COFF linker hash table entries.  */
246
247 struct coff_link_hash_entry
248 {
249   struct bfd_link_hash_entry root;
250
251   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
252      there is a reloc against this symbol.  */
253   long indx;
254
255   /* Symbol type.  */
256   unsigned short type;
257
258   /* Symbol class.  */
259   unsigned char class;
260
261   /* Number of auxiliary entries.  */
262   char numaux;
263
264   /* BFD to take auxiliary entries from.  */
265   bfd *auxbfd;
266
267   /* Pointer to array of auxiliary entries, if any.  */
268   union internal_auxent *aux;
269
270   /* Flag word; legal values follow.  */
271   unsigned short coff_link_hash_flags;
272   /* Symbol is a PE section symbol.  */
273 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
274 };
275
276 /* COFF linker hash table.  */
277
278 struct coff_link_hash_table
279 {
280   struct bfd_link_hash_table root;
281   /* A pointer to information used to link stabs in sections.  */
282   PTR stab_info;
283 };
284
285 /* Look up an entry in a COFF linker hash table.  */
286
287 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
288   ((struct coff_link_hash_entry *)                                      \
289    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
290                          (copy), (follow)))
291
292 /* Traverse a COFF linker hash table.  */
293
294 #define coff_link_hash_traverse(table, func, info)                      \
295   (bfd_link_hash_traverse                                               \
296    (&(table)->root,                                                     \
297     (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),  \
298     (info)))
299
300 /* Get the COFF linker hash table from a link_info structure.  */
301
302 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
303
304 /* Functions in coffgen.c.  */
305 extern const bfd_target *coff_object_p
306   PARAMS ((bfd *));
307 extern struct sec *coff_section_from_bfd_index
308   PARAMS ((bfd *, int));
309 extern long coff_get_symtab_upper_bound
310   PARAMS ((bfd *));
311 extern long coff_get_symtab
312   PARAMS ((bfd *, asymbol **));
313 extern int coff_count_linenumbers
314   PARAMS ((bfd *));
315 extern struct coff_symbol_struct *coff_symbol_from
316   PARAMS ((bfd *, asymbol *));
317 extern boolean coff_renumber_symbols
318   PARAMS ((bfd *, int *));
319 extern void coff_mangle_symbols
320   PARAMS ((bfd *));
321 extern boolean coff_write_symbols
322   PARAMS ((bfd *));
323 extern boolean coff_write_linenumbers
324   PARAMS ((bfd *));
325 extern alent *coff_get_lineno
326   PARAMS ((bfd *, asymbol *));
327 extern asymbol *coff_section_symbol
328   PARAMS ((bfd *, char *));
329 extern boolean _bfd_coff_get_external_symbols
330   PARAMS ((bfd *));
331 extern const char *_bfd_coff_read_string_table
332   PARAMS ((bfd *));
333 extern boolean _bfd_coff_free_symbols
334   PARAMS ((bfd *));
335 extern struct coff_ptr_struct *coff_get_normalized_symtab
336   PARAMS ((bfd *));
337 extern long coff_get_reloc_upper_bound
338   PARAMS ((bfd *, sec_ptr));
339 extern asymbol *coff_make_empty_symbol
340   PARAMS ((bfd *));
341 extern void coff_print_symbol
342   PARAMS ((bfd *, PTR filep, asymbol *, bfd_print_symbol_type));
343 extern void coff_get_symbol_info
344   PARAMS ((bfd *, asymbol *, symbol_info *ret));
345 extern boolean _bfd_coff_is_local_label_name
346   PARAMS ((bfd *, const char *));
347 extern asymbol *coff_bfd_make_debug_symbol
348   PARAMS ((bfd *, PTR, unsigned long));
349 extern boolean coff_find_nearest_line
350   PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **,
351            const char **, unsigned int *));
352 extern int coff_sizeof_headers
353   PARAMS ((bfd *, boolean));
354 extern boolean bfd_coff_reloc16_relax_section
355   PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
356 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
357   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
358            bfd_byte *, boolean, asymbol **));
359 extern bfd_vma bfd_coff_reloc16_get_value
360    PARAMS ((arelent *, struct bfd_link_info *, asection *));
361 extern void bfd_perform_slip
362   PARAMS ((bfd *, unsigned int, asection *, bfd_vma));
363
364 /* Functions and types in cofflink.c.  */
365
366 #define STRING_SIZE_SIZE (4)
367
368 /* We use a hash table to merge identical enum, struct, and union
369    definitions in the linker.  */
370
371 /* Information we keep for a single element (an enum value, a
372    structure or union field) in the debug merge hash table.  */
373
374 struct coff_debug_merge_element
375 {
376   /* Next element.  */
377   struct coff_debug_merge_element *next;
378
379   /* Name.  */
380   const char *name;
381
382   /* Type.  */
383   unsigned int type;
384
385   /* Symbol index for complex type.  */
386   long tagndx;
387 };
388
389 /* A linked list of debug merge entries for a given name.  */
390
391 struct coff_debug_merge_type
392 {
393   /* Next type with the same name.  */
394   struct coff_debug_merge_type *next;
395
396   /* Class of type.  */
397   int class;
398
399   /* Symbol index where this type is defined.  */
400   long indx;
401
402   /* List of elements.  */
403   struct coff_debug_merge_element *elements;
404 };
405
406 /* Information we store in the debug merge hash table.  */
407
408 struct coff_debug_merge_hash_entry
409 {
410   struct bfd_hash_entry root;
411
412   /* A list of types with this name.  */
413   struct coff_debug_merge_type *types;
414 };
415
416 /* The debug merge hash table.  */
417
418 struct coff_debug_merge_hash_table
419 {
420   struct bfd_hash_table root;
421 };
422
423 /* Initialize a COFF debug merge hash table.  */
424
425 #define coff_debug_merge_hash_table_init(table) \
426   (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc))
427
428 /* Free a COFF debug merge hash table.  */
429
430 #define coff_debug_merge_hash_table_free(table) \
431   (bfd_hash_table_free (&(table)->root))
432
433 /* Look up an entry in a COFF debug merge hash table.  */
434
435 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
436   ((struct coff_debug_merge_hash_entry *) \
437    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
438
439 /* Information we keep for each section in the output file when doing
440    a relocateable link.  */
441
442 struct coff_link_section_info
443 {
444   /* The relocs to be output.  */
445   struct internal_reloc *relocs;
446   /* For each reloc against a global symbol whose index was not known
447      when the reloc was handled, the global hash table entry.  */
448   struct coff_link_hash_entry **rel_hashes;
449 };
450
451 /* Information that we pass around while doing the final link step.  */
452
453 struct coff_final_link_info
454 {
455   /* General link information.  */
456   struct bfd_link_info *info;
457   /* Output BFD.  */
458   bfd *output_bfd;
459   /* Used to indicate failure in traversal routine.  */
460   boolean failed;
461   /* If doing "task linking" set only during the time when we want the
462      global symbol writer to convert the storage class of defined global
463      symbols from global to static. */
464   boolean global_to_static;
465   /* Hash table for long symbol names.  */
466   struct bfd_strtab_hash *strtab;
467   /* When doing a relocateable link, an array of information kept for
468      each output section, indexed by the target_index field.  */
469   struct coff_link_section_info *section_info;
470   /* Symbol index of last C_FILE symbol (-1 if none).  */
471   long last_file_index;
472   /* Contents of last C_FILE symbol.  */
473   struct internal_syment last_file;
474   /* Symbol index of first aux entry of last .bf symbol with an empty
475      endndx field (-1 if none).  */
476   long last_bf_index;
477   /* Contents of last_bf_index aux entry.  */
478   union internal_auxent last_bf;
479   /* Hash table used to merge debug information.  */
480   struct coff_debug_merge_hash_table debug_merge;
481   /* Buffer large enough to hold swapped symbols of any input file.  */
482   struct internal_syment *internal_syms;
483   /* Buffer large enough to hold sections of symbols of any input file.  */
484   asection **sec_ptrs;
485   /* Buffer large enough to hold output indices of symbols of any
486      input file.  */
487   long *sym_indices;
488   /* Buffer large enough to hold output symbols for any input file.  */
489   bfd_byte *outsyms;
490   /* Buffer large enough to hold external line numbers for any input
491      section.  */
492   bfd_byte *linenos;
493   /* Buffer large enough to hold any input section.  */
494   bfd_byte *contents;
495   /* Buffer large enough to hold external relocs of any input section.  */
496   bfd_byte *external_relocs;
497   /* Buffer large enough to hold swapped relocs of any input section.  */
498   struct internal_reloc *internal_relocs;
499 };
500
501 /* Most COFF variants have no way to record the alignment of a
502    section.  This struct is used to set a specific alignment based on
503    the name of the section.  */
504
505 struct coff_section_alignment_entry
506 {
507   /* The section name.  */
508   const char *name;
509
510   /* This is either (unsigned int) -1, indicating that the section
511      name must match exactly, or it is the number of letters which
512      must match at the start of the name.  */
513   unsigned int comparison_length;
514
515   /* These macros may be used to fill in the first two fields in a
516      structure initialization.  */
517 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
518 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
519
520   /* Only use this entry if the default section alignment for this
521      target is at least that much (as a power of two).  If this field
522      is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
523   unsigned int default_alignment_min;
524
525   /* Only use this entry if the default section alignment for this
526      target is no greater than this (as a power of two).  If this
527      field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
528   unsigned int default_alignment_max;
529
530 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
531
532   /* The desired alignment for this section (as a power of two).  */
533   unsigned int alignment_power;
534 };
535
536 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
537   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
538 extern boolean _bfd_coff_link_hash_table_init
539   PARAMS ((struct coff_link_hash_table *, bfd *,
540            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
541                                        struct bfd_hash_table *,
542                                        const char *)));
543 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
544   PARAMS ((bfd *));
545 extern const char *_bfd_coff_internal_syment_name
546   PARAMS ((bfd *, const struct internal_syment *, char *));
547 extern boolean _bfd_coff_link_add_symbols
548   PARAMS ((bfd *, struct bfd_link_info *));
549 extern boolean _bfd_coff_final_link
550   PARAMS ((bfd *, struct bfd_link_info *));
551 extern struct internal_reloc *_bfd_coff_read_internal_relocs
552   PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
553            struct internal_reloc *));
554 extern boolean _bfd_coff_generic_relocate_section
555   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
556            struct internal_reloc *, struct internal_syment *, asection **));
557
558 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
559   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
560 extern boolean _bfd_coff_write_global_sym
561   PARAMS ((struct coff_link_hash_entry *, PTR));
562 extern boolean _bfd_coff_write_task_globals
563   PARAMS ((struct coff_link_hash_entry *, PTR));
564 extern boolean _bfd_coff_link_input_bfd
565   PARAMS ((struct coff_final_link_info *, bfd *));
566 extern boolean _bfd_coff_reloc_link_order
567   PARAMS ((bfd *, struct coff_final_link_info *, asection *,
568            struct bfd_link_order *));
569
570
571 #define coff_get_section_contents_in_window \
572   _bfd_generic_get_section_contents_in_window
573
574 /* Functions in xcofflink.c.  */
575
576 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
577   PARAMS ((bfd *));
578 extern long _bfd_xcoff_canonicalize_dynamic_symtab
579   PARAMS ((bfd *, asymbol **));
580 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
581   PARAMS ((bfd *));
582 extern long _bfd_xcoff_canonicalize_dynamic_reloc
583   PARAMS ((bfd *, arelent **, asymbol **));
584 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
585   PARAMS ((bfd *));
586 extern boolean _bfd_xcoff_bfd_link_add_symbols
587   PARAMS ((bfd *, struct bfd_link_info *));
588 extern boolean _bfd_xcoff_bfd_final_link
589   PARAMS ((bfd *, struct bfd_link_info *));
590 extern boolean _bfd_ppc_xcoff_relocate_section
591   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
592            struct internal_reloc *, struct internal_syment *, asection **));
593
594 /* Functions in coff-ppc.c.  FIXME: These are called be pe.em in the
595    linker, and so should start with bfd and be declared in bfd.h.  */
596
597 extern boolean ppc_allocate_toc_section
598   PARAMS ((struct bfd_link_info *));
599 extern boolean ppc_process_before_allocation
600   PARAMS ((bfd *, struct bfd_link_info *));
601
602 /* And more taken from the source .. */
603