1 /* BFD COFF object file private structure.
2 Copyright (C) 1990, 91, 92, 93, 94, 95, 96, 97, 98, 1999, 2001
3 Free Software Foundation, Inc.
4 Written by Cygnus Support.
6 ** NOTE: libcoff.h is a GENERATED file. Don't change it; instead,
7 ** change libcoff-in.h or coffcode.h.
9 This file is part of BFD, the Binary File Descriptor library.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
27 /* Object file tdata; access macros */
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)
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)
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)
48 #define obj_coff_local_toc_table(bfd) (coff_data(bfd)->local_toc_sym_map)
50 /* `Tdata' information kept for COFF files. */
52 typedef struct coff_tdata
54 struct coff_symbol_struct *symbols; /* symtab for input bfd */
55 unsigned int *conversion_table;
59 struct coff_ptr_struct *raw_syments;
60 unsigned long raw_syment_count;
62 /* These are only valid once writing has begun */
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;
76 /* The unswapped external symbols. May be NULL. Read by
77 _bfd_coff_get_external_symbols. */
79 /* If this is true, the external_syms may not be freed. */
82 /* The string table. May be NULL. Read by
83 _bfd_coff_read_string_table. */
85 /* If this is true, the strings may not be freed. */
87 /* If this is true, the strings have been written out already. */
88 boolean strings_written;
90 /* is this a PE format coff file */
92 /* Used by the COFF backend linker. */
93 struct coff_link_hash_entry **sym_hashes;
95 /* used by the pe linker for PowerPC */
96 int *local_toc_sym_map;
98 struct bfd_link_info *link_info;
100 /* Used by coff_find_nearest_line. */
103 /* A place to stash dwarf2 info for this bfd. */
104 PTR dwarf2_find_line_info;
106 /* The timestamp from the COFF file header. */
109 /* Copy of some of the f_flags bits in the COFF filehdr structure,
115 /* Tdata for pe image files. */
116 typedef struct pe_tdata
119 struct internal_extra_pe_aouthdr pe_opthdr;
121 int has_reloc_section;
122 boolean (*in_reloc_p) PARAMS((bfd *, reloc_howto_type *));
124 int target_subsystem;
125 boolean force_minimum_alignment;
128 #define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
130 /* Tdata for XCOFF files. */
134 /* Basic COFF information. */
137 /* True if this is an XCOFF64 file. */
140 /* True if a large a.out header should be generated. */
141 boolean full_aouthdr;
146 /* Index of section holding TOC. */
149 /* Index of section holding entry point. */
152 /* .text alignment from optional header. */
153 int text_align_power;
155 /* .data alignment from optional header. */
156 int data_align_power;
158 /* modtype from optional header. */
161 /* cputype from optional header. */
164 /* maxdata from optional header. */
165 bfd_size_type maxdata;
167 /* maxstack from optional header. */
168 bfd_size_type maxstack;
170 /* Used by the XCOFF backend linker. */
172 unsigned long *debug_indices;
173 unsigned int import_file_id;
176 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
178 /* We take the address of the first element of a asymbol to ensure that the
179 * macro is only ever applied to an asymbol. */
180 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
182 /* The used_by_bfd field of a section may be set to a pointer to this
185 struct coff_section_tdata
187 /* The relocs, swapped into COFF internal form. This may be NULL. */
188 struct internal_reloc *relocs;
189 /* If this is true, the relocs entry may not be freed. */
191 /* The section contents. This may be NULL. */
193 /* If this is true, the contents entry may not be freed. */
194 boolean keep_contents;
195 /* Information cached by coff_find_nearest_line. */
198 const char *function;
200 /* A pointer used for .stab linking optimizations. */
202 /* Available for individual backends. */
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. */
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
222 unsigned long first_symndx;
223 unsigned long last_symndx;
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)
230 /* Tdata for sections in PE files. */
232 struct pei_section_tdata
234 /* The virtual size of the section. */
235 bfd_size_type virt_size;
236 /* The PE section flags. */
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)
244 /* COFF linker hash table entries. */
246 struct coff_link_hash_entry
248 struct bfd_link_hash_entry root;
250 /* Symbol index in output file. Set to -1 initially. Set to -2 if
251 there is a reloc against this symbol. */
260 /* Number of auxiliary entries. */
263 /* BFD to take auxiliary entries from. */
266 /* Pointer to array of auxiliary entries, if any. */
267 union internal_auxent *aux;
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)
275 /* COFF linker hash table. */
277 struct coff_link_hash_table
279 struct bfd_link_hash_table root;
280 /* A pointer to information used to link stabs in sections. */
284 /* Look up an entry in a COFF linker hash table. */
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), \
291 /* Traverse a COFF linker hash table. */
293 #define coff_link_hash_traverse(table, func, info) \
294 (bfd_link_hash_traverse \
296 (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func), \
299 /* Get the COFF linker hash table from a link_info structure. */
301 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
303 /* Functions in coffgen.c. */
304 extern const bfd_target *coff_object_p PARAMS ((bfd *));
305 extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int));
306 extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
307 extern long coff_get_symtab PARAMS ((bfd *, asymbol **));
308 extern int coff_count_linenumbers PARAMS ((bfd *));
309 extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *));
310 extern boolean coff_renumber_symbols PARAMS ((bfd *, int *));
311 extern void coff_mangle_symbols PARAMS ((bfd *));
312 extern boolean coff_write_symbols PARAMS ((bfd *));
313 extern boolean coff_write_linenumbers PARAMS ((bfd *));
314 extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *));
315 extern asymbol *coff_section_symbol PARAMS ((bfd *, char *));
316 extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
317 extern const char *_bfd_coff_read_string_table PARAMS ((bfd *));
318 extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
319 extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *));
320 extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
321 extern asymbol *coff_make_empty_symbol PARAMS ((bfd *));
322 extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *,
323 bfd_print_symbol_type how));
324 extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *,
326 extern boolean _bfd_coff_is_local_label_name PARAMS ((bfd *, const char *));
327 extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR,
329 extern boolean coff_find_nearest_line PARAMS ((bfd *,
333 CONST char **filename_ptr,
334 CONST char **functionname_ptr,
335 unsigned int *line_ptr));
336 extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
337 extern boolean bfd_coff_reloc16_relax_section
338 PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
339 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
340 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
341 bfd_byte *, boolean relocateable, asymbol **));
342 extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
343 struct bfd_link_info *,
345 extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
346 asection *input_section,
349 /* Functions and types in cofflink.c. */
351 #define STRING_SIZE_SIZE (4)
353 /* We use a hash table to merge identical enum, struct, and union
354 definitions in the linker. */
356 /* Information we keep for a single element (an enum value, a
357 structure or union field) in the debug merge hash table. */
359 struct coff_debug_merge_element
362 struct coff_debug_merge_element *next;
370 /* Symbol index for complex type. */
374 /* A linked list of debug merge entries for a given name. */
376 struct coff_debug_merge_type
378 /* Next type with the same name. */
379 struct coff_debug_merge_type *next;
384 /* Symbol index where this type is defined. */
387 /* List of elements. */
388 struct coff_debug_merge_element *elements;
391 /* Information we store in the debug merge hash table. */
393 struct coff_debug_merge_hash_entry
395 struct bfd_hash_entry root;
397 /* A list of types with this name. */
398 struct coff_debug_merge_type *types;
401 /* The debug merge hash table. */
403 struct coff_debug_merge_hash_table
405 struct bfd_hash_table root;
408 /* Initialize a COFF debug merge hash table. */
410 #define coff_debug_merge_hash_table_init(table) \
411 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc))
413 /* Free a COFF debug merge hash table. */
415 #define coff_debug_merge_hash_table_free(table) \
416 (bfd_hash_table_free (&(table)->root))
418 /* Look up an entry in a COFF debug merge hash table. */
420 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
421 ((struct coff_debug_merge_hash_entry *) \
422 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
424 /* Information we keep for each section in the output file when doing
425 a relocateable link. */
427 struct coff_link_section_info
429 /* The relocs to be output. */
430 struct internal_reloc *relocs;
431 /* For each reloc against a global symbol whose index was not known
432 when the reloc was handled, the global hash table entry. */
433 struct coff_link_hash_entry **rel_hashes;
436 /* Information that we pass around while doing the final link step. */
438 struct coff_final_link_info
440 /* General link information. */
441 struct bfd_link_info *info;
444 /* Used to indicate failure in traversal routine. */
446 /* If doing "task linking" set only during the time when we want the
447 global symbol writer to convert the storage class of defined global
448 symbols from global to static. */
449 boolean global_to_static;
450 /* Hash table for long symbol names. */
451 struct bfd_strtab_hash *strtab;
452 /* When doing a relocateable link, an array of information kept for
453 each output section, indexed by the target_index field. */
454 struct coff_link_section_info *section_info;
455 /* Symbol index of last C_FILE symbol (-1 if none). */
456 long last_file_index;
457 /* Contents of last C_FILE symbol. */
458 struct internal_syment last_file;
459 /* Symbol index of first aux entry of last .bf symbol with an empty
460 endndx field (-1 if none). */
462 /* Contents of last_bf_index aux entry. */
463 union internal_auxent last_bf;
464 /* Hash table used to merge debug information. */
465 struct coff_debug_merge_hash_table debug_merge;
466 /* Buffer large enough to hold swapped symbols of any input file. */
467 struct internal_syment *internal_syms;
468 /* Buffer large enough to hold sections of symbols of any input file. */
470 /* Buffer large enough to hold output indices of symbols of any
473 /* Buffer large enough to hold output symbols for any input file. */
475 /* Buffer large enough to hold external line numbers for any input
478 /* Buffer large enough to hold any input section. */
480 /* Buffer large enough to hold external relocs of any input section. */
481 bfd_byte *external_relocs;
482 /* Buffer large enough to hold swapped relocs of any input section. */
483 struct internal_reloc *internal_relocs;
486 /* Most COFF variants have no way to record the alignment of a
487 section. This struct is used to set a specific alignment based on
488 the name of the section. */
490 struct coff_section_alignment_entry
492 /* The section name. */
495 /* This is either (unsigned int) -1, indicating that the section
496 name must match exactly, or it is the number of letters which
497 must match at the start of the name. */
498 unsigned int comparison_length;
500 /* These macros may be used to fill in the first two fields in a
501 structure initialization. */
502 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
503 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
505 /* Only use this entry if the default section alignment for this
506 target is at least that much (as a power of two). If this field
507 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
508 unsigned int default_alignment_min;
510 /* Only use this entry if the default section alignment for this
511 target is no greater than this (as a power of two). If this
512 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
513 unsigned int default_alignment_max;
515 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
517 /* The desired alignment for this section (as a power of two). */
518 unsigned int alignment_power;
521 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
522 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
523 extern boolean _bfd_coff_link_hash_table_init
524 PARAMS ((struct coff_link_hash_table *, bfd *,
525 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
526 struct bfd_hash_table *,
528 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
530 extern const char *_bfd_coff_internal_syment_name
531 PARAMS ((bfd *, const struct internal_syment *, char *));
532 extern boolean _bfd_coff_link_add_symbols
533 PARAMS ((bfd *, struct bfd_link_info *));
534 extern boolean _bfd_coff_final_link
535 PARAMS ((bfd *, struct bfd_link_info *));
536 extern struct internal_reloc *_bfd_coff_read_internal_relocs
537 PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
538 struct internal_reloc *));
539 extern boolean _bfd_coff_generic_relocate_section
540 PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
541 struct internal_reloc *, struct internal_syment *, asection **));
543 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
544 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *, const char *));
545 extern boolean _bfd_coff_write_global_sym
546 PARAMS ((struct coff_link_hash_entry *, PTR));
547 extern boolean _bfd_coff_write_task_globals
548 PARAMS ((struct coff_link_hash_entry *, PTR));
549 extern boolean _bfd_coff_link_input_bfd
550 PARAMS ((struct coff_final_link_info *, bfd *));
551 extern boolean _bfd_coff_reloc_link_order
552 PARAMS ((bfd *, struct coff_final_link_info *, asection *,
553 struct bfd_link_order *));
556 #define coff_get_section_contents_in_window \
557 _bfd_generic_get_section_contents_in_window
559 /* Functions in xcofflink.c. */
561 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound PARAMS ((bfd *));
562 extern long _bfd_xcoff_canonicalize_dynamic_symtab
563 PARAMS ((bfd *, asymbol **));
564 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound PARAMS ((bfd *));
565 extern long _bfd_xcoff_canonicalize_dynamic_reloc
566 PARAMS ((bfd *, arelent **, asymbol **));
567 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
569 extern boolean _bfd_xcoff_bfd_link_add_symbols
570 PARAMS ((bfd *, struct bfd_link_info *));
571 extern boolean _bfd_xcoff_bfd_final_link
572 PARAMS ((bfd *, struct bfd_link_info *));
573 extern boolean _bfd_ppc_xcoff_relocate_section
574 PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
575 struct internal_reloc *, struct internal_syment *, asection **));
577 /* Functions in coff-ppc.c. FIXME: These are called be pe.em in the
578 linker, and so should start with bfd and be declared in bfd.h. */
580 extern boolean ppc_allocate_toc_section PARAMS ((struct bfd_link_info *));
581 extern boolean ppc_process_before_allocation
582 PARAMS ((bfd *, struct bfd_link_info *));
584 /* And more taken from the source .. */