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