1/* BFD COFF object file private structure.
2   Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3   2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4   Free Software Foundation, Inc.
5   Written by Cygnus Support.
6
7   This file is part of BFD, the Binary File Descriptor library.
8
9   This program is free software; you can redistribute it and/or modify
10   it under the terms of the GNU General Public License as published by
11   the Free Software Foundation; either version 3 of the License, or
12   (at your option) any later version.
13
14   This program is distributed in the hope that it will be useful,
15   but WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   GNU General Public License for more details.
18
19   You should have received a copy of the GNU General Public License
20   along with this program; if not, write to the Free Software
21   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22   MA 02110-1301, USA.  */
23
24#include "bfdlink.h"
25
26/* Object file tdata; access macros.  */
27
28#define coff_data(bfd)		      ((bfd)->tdata.coff_obj_data)
29#define exec_hdr(bfd)		      (coff_data (bfd)->hdr)
30#define obj_pe(bfd)                   (coff_data (bfd)->pe)
31#define obj_symbols(bfd)	      (coff_data (bfd)->symbols)
32#define	obj_sym_filepos(bfd)	      (coff_data (bfd)->sym_filepos)
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#define obj_coff_external_syms(bfd)   (coff_data (bfd)->external_syms)
39#define obj_coff_keep_syms(bfd)	      (coff_data (bfd)->keep_syms)
40#define obj_coff_strings(bfd)	      (coff_data (bfd)->strings)
41#define obj_coff_keep_strings(bfd)    (coff_data (bfd)->keep_strings)
42#define obj_coff_sym_hashes(bfd)      (coff_data (bfd)->sym_hashes)
43#define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
44#define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
45
46/* `Tdata' information kept for COFF files.  */
47
48typedef struct coff_tdata
49{
50  struct coff_symbol_struct *symbols;	/* Symtab for input bfd.  */
51  unsigned int *conversion_table;
52  int conv_table_size;
53  file_ptr sym_filepos;
54
55  struct coff_ptr_struct *raw_syments;
56  unsigned long raw_syment_count;
57
58  /* These are only valid once writing has begun.  */
59  long int relocbase;
60
61  /* These members communicate important constants about the symbol table
62     to GDB's symbol-reading code.  These `constants' unfortunately vary
63     from coff implementation to implementation...  */
64  unsigned local_n_btmask;
65  unsigned local_n_btshft;
66  unsigned local_n_tmask;
67  unsigned local_n_tshift;
68  unsigned local_symesz;
69  unsigned local_auxesz;
70  unsigned local_linesz;
71
72  /* The unswapped external symbols.  May be NULL.  Read by
73     _bfd_coff_get_external_symbols.  */
74  void * external_syms;
75  /* If this is TRUE, the external_syms may not be freed.  */
76  bfd_boolean keep_syms;
77
78  /* The string table.  May be NULL.  Read by
79     _bfd_coff_read_string_table.  */
80  char *strings;
81  /* If this is TRUE, the strings may not be freed.  */
82  bfd_boolean keep_strings;
83  /* If this is TRUE, the strings have been written out already.  */
84  bfd_boolean strings_written;
85
86  /* Is this a PE format coff file?  */
87  int pe;
88  /* Used by the COFF backend linker.  */
89  struct coff_link_hash_entry **sym_hashes;
90
91  /* Used by the pe linker for PowerPC.  */
92  int *local_toc_sym_map;
93
94  struct bfd_link_info *link_info;
95
96  /* Used by coff_find_nearest_line.  */
97  void * line_info;
98
99  /* A place to stash dwarf2 info for this bfd.  */
100  void * dwarf2_find_line_info;
101
102  /* The timestamp from the COFF file header.  */
103  long timestamp;
104
105  /* Copy of some of the f_flags bits in the COFF filehdr structure,
106     used by ARM code.  */
107  flagword flags;
108
109} coff_data_type;
110
111/* Tdata for pe image files.  */
112typedef struct pe_tdata
113{
114  coff_data_type coff;
115  struct internal_extra_pe_aouthdr pe_opthdr;
116  int dll;
117  int has_reloc_section;
118  bfd_boolean (*in_reloc_p) (bfd *, reloc_howto_type *);
119  flagword real_flags;
120  int target_subsystem;
121  bfd_boolean force_minimum_alignment;
122} pe_data_type;
123
124#define pe_data(bfd)		((bfd)->tdata.pe_obj_data)
125
126/* Tdata for XCOFF files.  */
127
128struct xcoff_tdata
129{
130  /* Basic COFF information.  */
131  coff_data_type coff;
132
133  /* TRUE if this is an XCOFF64 file. */
134  bfd_boolean xcoff64;
135
136  /* TRUE if a large a.out header should be generated.  */
137  bfd_boolean full_aouthdr;
138
139  /* TOC value.  */
140  bfd_vma toc;
141
142  /* Index of section holding TOC.  */
143  int sntoc;
144
145  /* Index of section holding entry point.  */
146  int snentry;
147
148  /* .text alignment from optional header.  */
149  int text_align_power;
150
151  /* .data alignment from optional header.  */
152  int data_align_power;
153
154  /* modtype from optional header.  */
155  short modtype;
156
157  /* cputype from optional header.  */
158  short cputype;
159
160  /* maxdata from optional header.  */
161  bfd_vma maxdata;
162
163  /* maxstack from optional header.  */
164  bfd_vma maxstack;
165
166  /* Used by the XCOFF backend linker.  */
167  asection **csects;
168  unsigned long *debug_indices;
169  unsigned int import_file_id;
170};
171
172#define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
173
174/* We take the address of the first element of an asymbol to ensure that the
175   macro is only ever applied to an asymbol.  */
176#define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
177
178/* The used_by_bfd field of a section may be set to a pointer to this
179   structure.  */
180
181struct coff_section_tdata
182{
183  /* The relocs, swapped into COFF internal form.  This may be NULL.  */
184  struct internal_reloc *relocs;
185  /* If this is TRUE, the relocs entry may not be freed.  */
186  bfd_boolean keep_relocs;
187  /* The section contents.  This may be NULL.  */
188  bfd_byte *contents;
189  /* If this is TRUE, the contents entry may not be freed.  */
190  bfd_boolean keep_contents;
191  /* Information cached by coff_find_nearest_line.  */
192  bfd_vma offset;
193  unsigned int i;
194  const char *function;
195  /* Optional information about a COMDAT entry; NULL if not COMDAT. */
196  struct coff_comdat_info *comdat;
197  int line_base;
198  /* A pointer used for .stab linking optimizations.  */
199  void * stab_info;
200  /* Available for individual backends.  */
201  void * 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  struct stab_info 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    (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (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
303  (bfd *);
304extern struct bfd_section *coff_section_from_bfd_index
305  (bfd *, int);
306extern long coff_get_symtab_upper_bound
307  (bfd *);
308extern long coff_canonicalize_symtab
309  (bfd *, asymbol **);
310extern int coff_count_linenumbers
311  (bfd *);
312extern struct coff_symbol_struct *coff_symbol_from
313  (bfd *, asymbol *);
314extern bfd_boolean coff_renumber_symbols
315  (bfd *, int *);
316extern void coff_mangle_symbols
317  (bfd *);
318extern bfd_boolean coff_write_symbols
319  (bfd *);
320extern bfd_boolean coff_write_linenumbers
321  (bfd *);
322extern alent *coff_get_lineno
323  (bfd *, asymbol *);
324extern asymbol *coff_section_symbol
325  (bfd *, char *);
326extern bfd_boolean _bfd_coff_get_external_symbols
327  (bfd *);
328extern const char *_bfd_coff_read_string_table
329  (bfd *);
330extern bfd_boolean _bfd_coff_free_symbols
331  (bfd *);
332extern struct coff_ptr_struct *coff_get_normalized_symtab
333  (bfd *);
334extern long coff_get_reloc_upper_bound
335  (bfd *, sec_ptr);
336extern asymbol *coff_make_empty_symbol
337  (bfd *);
338extern void coff_print_symbol
339  (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
340extern void coff_get_symbol_info
341  (bfd *, asymbol *, symbol_info *ret);
342extern bfd_boolean _bfd_coff_is_local_label_name
343  (bfd *, const char *);
344extern asymbol *coff_bfd_make_debug_symbol
345  (bfd *, void *, unsigned long);
346extern bfd_boolean coff_find_nearest_line
347  (bfd *, asection *, asymbol **, bfd_vma, const char **,
348   const char **, unsigned int *);
349extern bfd_boolean coff_find_inliner_info
350  (bfd *, const char **, const char **, unsigned int *);
351extern int coff_sizeof_headers
352  (bfd *, struct bfd_link_info *);
353extern bfd_boolean bfd_coff_reloc16_relax_section
354  (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
355extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
356  (bfd *, struct bfd_link_info *, struct bfd_link_order *,
357   bfd_byte *, bfd_boolean, asymbol **);
358extern bfd_vma bfd_coff_reloc16_get_value
359  (arelent *, struct bfd_link_info *, asection *);
360extern void bfd_perform_slip
361  (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			sizeof (struct coff_debug_merge_hash_entry)))
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 relocatable link.  */
441
442struct 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
453struct 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  bfd_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  bfd_boolean global_to_static;
465  /* Hash table for long symbol names.  */
466  struct bfd_strtab_hash *strtab;
467  /* When doing a relocatable 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
505struct 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
536extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
537  (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
538extern bfd_boolean _bfd_coff_link_hash_table_init
539  (struct coff_link_hash_table *, bfd *,
540   struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
541			       struct bfd_hash_table *,
542			       const char *),
543   unsigned int);
544extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
545  (bfd *);
546extern const char *_bfd_coff_internal_syment_name
547  (bfd *, const struct internal_syment *, char *);
548extern bfd_boolean _bfd_coff_link_add_symbols
549  (bfd *, struct bfd_link_info *);
550extern bfd_boolean _bfd_coff_final_link
551  (bfd *, struct bfd_link_info *);
552extern struct internal_reloc *_bfd_coff_read_internal_relocs
553  (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
554   struct internal_reloc *);
555extern bfd_boolean _bfd_coff_generic_relocate_section
556  (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
557   struct internal_reloc *, struct internal_syment *, asection **);
558extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
559  (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
560extern bfd_boolean _bfd_coff_write_global_sym
561  (struct coff_link_hash_entry *, void *);
562extern bfd_boolean _bfd_coff_write_task_globals
563  (struct coff_link_hash_entry *, void *);
564extern bfd_boolean _bfd_coff_link_input_bfd
565  (struct coff_final_link_info *, bfd *);
566extern bfd_boolean _bfd_coff_reloc_link_order
567  (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
576extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
577  (bfd *);
578extern long _bfd_xcoff_canonicalize_dynamic_symtab
579  (bfd *, asymbol **);
580extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
581  (bfd *);
582extern long _bfd_xcoff_canonicalize_dynamic_reloc
583  (bfd *, arelent **, asymbol **);
584extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
585  (bfd *);
586extern void _bfd_xcoff_bfd_link_hash_table_free
587  (struct bfd_link_hash_table *);
588extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
589  (bfd *, struct bfd_link_info *);
590extern bfd_boolean _bfd_xcoff_bfd_final_link
591  (bfd *, struct bfd_link_info *);
592extern bfd_boolean _bfd_ppc_xcoff_relocate_section
593  (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
594   struct internal_reloc *, struct internal_syment *, asection **);
595
596/* Functions in coff-ppc.c.  FIXME: These are called be pe.em in the
597   linker, and so should start with bfd and be declared in bfd.h.  */
598
599extern bfd_boolean ppc_allocate_toc_section
600  (struct bfd_link_info *);
601extern bfd_boolean ppc_process_before_allocation
602  (bfd *, struct bfd_link_info *);
603
604