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