Remove trailing "(bad)" entries and replace { "(bad)", { XX } }
[binutils.git] / bfd / libcoff-in.h
blobcf0a31907b6962e591dad156fb5216d1181649d0
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, 2008, 2009
4 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
24 #include "bfdlink.h"
26 /* Object file tdata; access macros. */
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)
46 /* `Tdata' information kept for COFF files. */
48 typedef struct coff_tdata
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;
55 struct coff_ptr_struct *raw_syments;
56 unsigned long raw_syment_count;
58 /* These are only valid once writing has begun. */
59 long int relocbase;
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;
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;
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;
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;
91 /* Used by the pe linker for PowerPC. */
92 int *local_toc_sym_map;
94 struct bfd_link_info *link_info;
96 /* Used by coff_find_nearest_line. */
97 void * line_info;
99 /* A place to stash dwarf2 info for this bfd. */
100 void * dwarf2_find_line_info;
102 /* The timestamp from the COFF file header. */
103 long timestamp;
105 /* Copy of some of the f_flags bits in the COFF filehdr structure,
106 used by ARM code. */
107 flagword flags;
109 /* coff-stgo32 EXE stub header after BFD tdata has been allocated. Its data
110 is kept in internal_filehdr.go32stub beforehand. */
111 char *go32stub;
112 } coff_data_type;
114 /* Tdata for pe image files. */
115 typedef struct pe_tdata
117 coff_data_type coff;
118 struct internal_extra_pe_aouthdr pe_opthdr;
119 int dll;
120 int has_reloc_section;
121 bfd_boolean (*in_reloc_p) (bfd *, reloc_howto_type *);
122 flagword real_flags;
123 } pe_data_type;
125 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
127 /* Tdata for XCOFF files. */
129 struct xcoff_tdata
131 /* Basic COFF information. */
132 coff_data_type coff;
134 /* TRUE if this is an XCOFF64 file. */
135 bfd_boolean xcoff64;
137 /* TRUE if a large a.out header should be generated. */
138 bfd_boolean full_aouthdr;
140 /* TOC value. */
141 bfd_vma toc;
143 /* Index of section holding TOC. */
144 int sntoc;
146 /* Index of section holding entry point. */
147 int snentry;
149 /* .text alignment from optional header. */
150 int text_align_power;
152 /* .data alignment from optional header. */
153 int data_align_power;
155 /* modtype from optional header. */
156 short modtype;
158 /* cputype from optional header. */
159 short cputype;
161 /* maxdata from optional header. */
162 bfd_vma maxdata;
164 /* maxstack from optional header. */
165 bfd_vma maxstack;
167 /* Used by the XCOFF backend linker. */
168 asection **csects;
169 long *debug_indices;
170 unsigned int *lineno_counts;
171 unsigned int import_file_id;
174 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
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)))
180 /* The used_by_bfd field of a section may be set to a pointer to this
181 structure. */
183 struct coff_section_tdata
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 void * stab_info;
202 /* Available for individual backends. */
203 void * tdata;
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)
210 /* Tdata for sections in XCOFF files. This is used by the linker. */
212 struct xcoff_section_tdata
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 last symbol indices for symbols used by this csect. */
221 unsigned long first_symndx;
222 unsigned long last_symndx;
225 /* An accessor macro the xcoff_section_tdata structure. */
226 #define xcoff_section_data(abfd, sec) \
227 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
229 /* Tdata for sections in PE files. */
231 struct pei_section_tdata
233 /* The virtual size of the section. */
234 bfd_size_type virt_size;
235 /* The PE section flags. */
236 long pe_flags;
239 /* An accessor macro for the pei_section_tdata structure. */
240 #define pei_section_data(abfd, sec) \
241 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
243 /* COFF linker hash table entries. */
245 struct coff_link_hash_entry
247 struct bfd_link_hash_entry root;
249 /* Symbol index in output file. Set to -1 initially. Set to -2 if
250 there is a reloc against this symbol. */
251 long indx;
253 /* Symbol type. */
254 unsigned short type;
256 /* Symbol class. */
257 unsigned char symbol_class;
259 /* Number of auxiliary entries. */
260 char numaux;
262 /* BFD to take auxiliary entries from. */
263 bfd *auxbfd;
265 /* Pointer to array of auxiliary entries, if any. */
266 union internal_auxent *aux;
268 /* Flag word; legal values follow. */
269 unsigned short coff_link_hash_flags;
270 /* Symbol is a PE section symbol. */
271 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
274 /* COFF linker hash table. */
276 struct coff_link_hash_table
278 struct bfd_link_hash_table root;
279 /* A pointer to information used to link stabs in sections. */
280 struct stab_info stab_info;
283 /* Look up an entry in a COFF linker hash table. */
285 #define coff_link_hash_lookup(table, string, create, copy, follow) \
286 ((struct coff_link_hash_entry *) \
287 bfd_link_hash_lookup (&(table)->root, (string), (create), \
288 (copy), (follow)))
290 /* Traverse a COFF linker hash table. */
292 #define coff_link_hash_traverse(table, func, info) \
293 (bfd_link_hash_traverse \
294 (&(table)->root, \
295 (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
296 (info)))
298 /* Get the COFF linker hash table from a link_info structure. */
300 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
302 /* Functions in coffgen.c. */
303 extern const bfd_target *coff_object_p
304 (bfd *);
305 extern struct bfd_section *coff_section_from_bfd_index
306 (bfd *, int);
307 extern long coff_get_symtab_upper_bound
308 (bfd *);
309 extern long coff_canonicalize_symtab
310 (bfd *, asymbol **);
311 extern int coff_count_linenumbers
312 (bfd *);
313 extern struct coff_symbol_struct *coff_symbol_from
314 (bfd *, asymbol *);
315 extern bfd_boolean coff_renumber_symbols
316 (bfd *, int *);
317 extern void coff_mangle_symbols
318 (bfd *);
319 extern bfd_boolean coff_write_symbols
320 (bfd *);
321 extern bfd_boolean coff_write_linenumbers
322 (bfd *);
323 extern alent *coff_get_lineno
324 (bfd *, asymbol *);
325 extern asymbol *coff_section_symbol
326 (bfd *, char *);
327 extern bfd_boolean _bfd_coff_get_external_symbols
328 (bfd *);
329 extern const char *_bfd_coff_read_string_table
330 (bfd *);
331 extern bfd_boolean _bfd_coff_free_symbols
332 (bfd *);
333 extern struct coff_ptr_struct *coff_get_normalized_symtab
334 (bfd *);
335 extern long coff_get_reloc_upper_bound
336 (bfd *, sec_ptr);
337 extern asymbol *coff_make_empty_symbol
338 (bfd *);
339 extern void coff_print_symbol
340 (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
341 extern void coff_get_symbol_info
342 (bfd *, asymbol *, symbol_info *ret);
343 extern bfd_boolean _bfd_coff_is_local_label_name
344 (bfd *, const char *);
345 extern asymbol *coff_bfd_make_debug_symbol
346 (bfd *, void *, unsigned long);
347 extern bfd_boolean coff_find_nearest_line
348 (bfd *, asection *, asymbol **, bfd_vma, const char **,
349 const char **, unsigned int *);
350 extern bfd_boolean coff_find_inliner_info
351 (bfd *, const char **, const char **, unsigned int *);
352 extern int coff_sizeof_headers
353 (bfd *, struct bfd_link_info *);
354 extern bfd_boolean bfd_coff_reloc16_relax_section
355 (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
356 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
357 (bfd *, struct bfd_link_info *, struct bfd_link_order *,
358 bfd_byte *, bfd_boolean, asymbol **);
359 extern bfd_vma bfd_coff_reloc16_get_value
360 (arelent *, struct bfd_link_info *, asection *);
361 extern void bfd_perform_slip
362 (bfd *, unsigned int, asection *, bfd_vma);
364 /* Functions and types in cofflink.c. */
366 #define STRING_SIZE_SIZE 4
368 /* We use a hash table to merge identical enum, struct, and union
369 definitions in the linker. */
371 /* Information we keep for a single element (an enum value, a
372 structure or union field) in the debug merge hash table. */
374 struct coff_debug_merge_element
376 /* Next element. */
377 struct coff_debug_merge_element *next;
379 /* Name. */
380 const char *name;
382 /* Type. */
383 unsigned int type;
385 /* Symbol index for complex type. */
386 long tagndx;
389 /* A linked list of debug merge entries for a given name. */
391 struct coff_debug_merge_type
393 /* Next type with the same name. */
394 struct coff_debug_merge_type *next;
396 /* Class of type. */
397 int type_class;
399 /* Symbol index where this type is defined. */
400 long indx;
402 /* List of elements. */
403 struct coff_debug_merge_element *elements;
406 /* Information we store in the debug merge hash table. */
408 struct coff_debug_merge_hash_entry
410 struct bfd_hash_entry root;
412 /* A list of types with this name. */
413 struct coff_debug_merge_type *types;
416 /* The debug merge hash table. */
418 struct coff_debug_merge_hash_table
420 struct bfd_hash_table root;
423 /* Initialize a COFF debug merge hash table. */
425 #define coff_debug_merge_hash_table_init(table) \
426 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
427 sizeof (struct coff_debug_merge_hash_entry)))
429 /* Free a COFF debug merge hash table. */
431 #define coff_debug_merge_hash_table_free(table) \
432 (bfd_hash_table_free (&(table)->root))
434 /* Look up an entry in a COFF debug merge hash table. */
436 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
437 ((struct coff_debug_merge_hash_entry *) \
438 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
440 /* Information we keep for each section in the output file when doing
441 a relocatable link. */
443 struct coff_link_section_info
445 /* The relocs to be output. */
446 struct internal_reloc *relocs;
447 /* For each reloc against a global symbol whose index was not known
448 when the reloc was handled, the global hash table entry. */
449 struct coff_link_hash_entry **rel_hashes;
452 /* Information that we pass around while doing the final link step. */
454 struct coff_final_link_info
456 /* General link information. */
457 struct bfd_link_info *info;
458 /* Output BFD. */
459 bfd *output_bfd;
460 /* Used to indicate failure in traversal routine. */
461 bfd_boolean failed;
462 /* If doing "task linking" set only during the time when we want the
463 global symbol writer to convert the storage class of defined global
464 symbols from global to static. */
465 bfd_boolean global_to_static;
466 /* Hash table for long symbol names. */
467 struct bfd_strtab_hash *strtab;
468 /* When doing a relocatable link, an array of information kept for
469 each output section, indexed by the target_index field. */
470 struct coff_link_section_info *section_info;
471 /* Symbol index of last C_FILE symbol (-1 if none). */
472 long last_file_index;
473 /* Contents of last C_FILE symbol. */
474 struct internal_syment last_file;
475 /* Symbol index of first aux entry of last .bf symbol with an empty
476 endndx field (-1 if none). */
477 long last_bf_index;
478 /* Contents of last_bf_index aux entry. */
479 union internal_auxent last_bf;
480 /* Hash table used to merge debug information. */
481 struct coff_debug_merge_hash_table debug_merge;
482 /* Buffer large enough to hold swapped symbols of any input file. */
483 struct internal_syment *internal_syms;
484 /* Buffer large enough to hold sections of symbols of any input file. */
485 asection **sec_ptrs;
486 /* Buffer large enough to hold output indices of symbols of any
487 input file. */
488 long *sym_indices;
489 /* Buffer large enough to hold output symbols for any input file. */
490 bfd_byte *outsyms;
491 /* Buffer large enough to hold external line numbers for any input
492 section. */
493 bfd_byte *linenos;
494 /* Buffer large enough to hold any input section. */
495 bfd_byte *contents;
496 /* Buffer large enough to hold external relocs of any input section. */
497 bfd_byte *external_relocs;
498 /* Buffer large enough to hold swapped relocs of any input section. */
499 struct internal_reloc *internal_relocs;
502 /* Most COFF variants have no way to record the alignment of a
503 section. This struct is used to set a specific alignment based on
504 the name of the section. */
506 struct coff_section_alignment_entry
508 /* The section name. */
509 const char *name;
511 /* This is either (unsigned int) -1, indicating that the section
512 name must match exactly, or it is the number of letters which
513 must match at the start of the name. */
514 unsigned int comparison_length;
516 /* These macros may be used to fill in the first two fields in a
517 structure initialization. */
518 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
519 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
521 /* Only use this entry if the default section alignment for this
522 target is at least that much (as a power of two). If this field
523 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
524 unsigned int default_alignment_min;
526 /* Only use this entry if the default section alignment for this
527 target is no greater than this (as a power of two). If this
528 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
529 unsigned int default_alignment_max;
531 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
533 /* The desired alignment for this section (as a power of two). */
534 unsigned int alignment_power;
537 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
538 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
539 extern bfd_boolean _bfd_coff_link_hash_table_init
540 (struct coff_link_hash_table *, bfd *,
541 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
542 struct bfd_hash_table *,
543 const char *),
544 unsigned int);
545 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
546 (bfd *);
547 extern const char *_bfd_coff_internal_syment_name
548 (bfd *, const struct internal_syment *, char *);
549 extern bfd_boolean _bfd_coff_link_add_symbols
550 (bfd *, struct bfd_link_info *);
551 extern bfd_boolean _bfd_coff_final_link
552 (bfd *, struct bfd_link_info *);
553 extern struct internal_reloc *_bfd_coff_read_internal_relocs
554 (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
555 struct internal_reloc *);
556 extern bfd_boolean _bfd_coff_generic_relocate_section
557 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
558 struct internal_reloc *, struct internal_syment *, asection **);
559 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
560 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
561 extern bfd_boolean _bfd_coff_write_global_sym
562 (struct coff_link_hash_entry *, void *);
563 extern bfd_boolean _bfd_coff_write_task_globals
564 (struct coff_link_hash_entry *, void *);
565 extern bfd_boolean _bfd_coff_link_input_bfd
566 (struct coff_final_link_info *, bfd *);
567 extern bfd_boolean _bfd_coff_reloc_link_order
568 (bfd *, struct coff_final_link_info *, asection *,
569 struct bfd_link_order *);
572 #define coff_get_section_contents_in_window \
573 _bfd_generic_get_section_contents_in_window
575 /* Functions in xcofflink.c. */
577 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
578 (bfd *);
579 extern long _bfd_xcoff_canonicalize_dynamic_symtab
580 (bfd *, asymbol **);
581 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
582 (bfd *);
583 extern long _bfd_xcoff_canonicalize_dynamic_reloc
584 (bfd *, arelent **, asymbol **);
585 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
586 (bfd *);
587 extern void _bfd_xcoff_bfd_link_hash_table_free
588 (struct bfd_link_hash_table *);
589 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
590 (bfd *, struct bfd_link_info *);
591 extern bfd_boolean _bfd_xcoff_bfd_final_link
592 (bfd *, struct bfd_link_info *);
593 extern bfd_boolean _bfd_xcoff_define_common_symbol
594 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
595 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
596 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
597 struct internal_reloc *, struct internal_syment *, asection **);
599 /* Functions in coff-ppc.c. FIXME: These are called by pe.em in the
600 linker, and so should start with bfd and be declared in bfd.h. */
602 extern bfd_boolean ppc_allocate_toc_section
603 (struct bfd_link_info *);
604 extern bfd_boolean ppc_process_before_allocation
605 (bfd *, struct bfd_link_info *);