* po/sr.po: New Serbian translation.
[binutils.git] / bfd / libcoff-in.h
blob0cd8de5d3b2fe3631e122a1eb0f5e45139787f47
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, 2010, 2011
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 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 #define obj_relocbase(bfd) (coff_data (bfd)->relocbase)
33 #define obj_raw_syments(bfd) (coff_data (bfd)->raw_syments)
34 #define obj_raw_syment_count(bfd) (coff_data (bfd)->raw_syment_count)
35 #define obj_convert(bfd) (coff_data (bfd)->conversion_table)
36 #define obj_conv_table_size(bfd) (coff_data (bfd)->conv_table_size)
37 #define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
38 #define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
39 #define obj_coff_strings(bfd) (coff_data (bfd)->strings)
40 #define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
41 #define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
42 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
43 #define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
45 /* `Tdata' information kept for COFF files. */
47 typedef struct coff_tdata
49 struct coff_symbol_struct *symbols; /* Symtab for input bfd. */
50 unsigned int *conversion_table;
51 int conv_table_size;
52 file_ptr sym_filepos;
54 struct coff_ptr_struct *raw_syments;
55 unsigned long raw_syment_count;
57 /* These are only valid once writing has begun. */
58 long int relocbase;
60 /* These members communicate important constants about the symbol table
61 to GDB's symbol-reading code. These `constants' unfortunately vary
62 from coff implementation to implementation... */
63 unsigned local_n_btmask;
64 unsigned local_n_btshft;
65 unsigned local_n_tmask;
66 unsigned local_n_tshift;
67 unsigned local_symesz;
68 unsigned local_auxesz;
69 unsigned local_linesz;
71 /* The unswapped external symbols. May be NULL. Read by
72 _bfd_coff_get_external_symbols. */
73 void * external_syms;
74 /* If this is TRUE, the external_syms may not be freed. */
75 bfd_boolean keep_syms;
77 /* The string table. May be NULL. Read by
78 _bfd_coff_read_string_table. */
79 char *strings;
80 /* If this is TRUE, the strings may not be freed. */
81 bfd_boolean keep_strings;
82 /* If this is TRUE, the strings have been written out already. */
83 bfd_boolean strings_written;
85 /* Is this a PE format coff file? */
86 int pe;
87 /* Used by the COFF backend linker. */
88 struct coff_link_hash_entry **sym_hashes;
90 /* Used by the pe linker for PowerPC. */
91 int *local_toc_sym_map;
93 struct bfd_link_info *link_info;
95 /* Used by coff_find_nearest_line. */
96 void * line_info;
98 /* A place to stash dwarf2 info for this bfd. */
99 void * dwarf2_find_line_info;
101 /* The timestamp from the COFF file header. */
102 long timestamp;
104 /* Copy of some of the f_flags bits in the COFF filehdr structure,
105 used by ARM code. */
106 flagword flags;
108 /* coff-stgo32 EXE stub header after BFD tdata has been allocated. Its data
109 is kept in internal_filehdr.go32stub beforehand. */
110 char *go32stub;
111 } coff_data_type;
113 /* Tdata for pe image files. */
114 typedef struct pe_tdata
116 coff_data_type coff;
117 struct internal_extra_pe_aouthdr pe_opthdr;
118 int dll;
119 int has_reloc_section;
120 int dont_strip_reloc;
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_alien_symbol
322 (bfd *, asymbol *, struct internal_syment *, bfd_vma *,
323 bfd_size_type *, asection **, bfd_size_type *);
324 extern bfd_boolean coff_write_linenumbers
325 (bfd *);
326 extern alent *coff_get_lineno
327 (bfd *, asymbol *);
328 extern asymbol *coff_section_symbol
329 (bfd *, char *);
330 extern bfd_boolean _bfd_coff_get_external_symbols
331 (bfd *);
332 extern const char *_bfd_coff_read_string_table
333 (bfd *);
334 extern bfd_boolean _bfd_coff_free_symbols
335 (bfd *);
336 extern struct coff_ptr_struct *coff_get_normalized_symtab
337 (bfd *);
338 extern long coff_get_reloc_upper_bound
339 (bfd *, sec_ptr);
340 extern asymbol *coff_make_empty_symbol
341 (bfd *);
342 extern void coff_print_symbol
343 (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
344 extern void coff_get_symbol_info
345 (bfd *, asymbol *, symbol_info *ret);
346 extern bfd_boolean _bfd_coff_is_local_label_name
347 (bfd *, const char *);
348 extern asymbol *coff_bfd_make_debug_symbol
349 (bfd *, void *, unsigned long);
350 extern bfd_boolean coff_find_nearest_line
351 (bfd *, asection *, asymbol **, bfd_vma, const char **,
352 const char **, unsigned int *);
353 struct dwarf_debug_section;
354 extern bfd_boolean coff_find_nearest_line_with_names
355 (bfd *, const struct dwarf_debug_section *, asection *, asymbol **,
356 bfd_vma, const char **, const char **, unsigned int *);
357 extern bfd_boolean coff_find_inliner_info
358 (bfd *, const char **, const char **, unsigned int *);
359 extern int coff_sizeof_headers
360 (bfd *, struct bfd_link_info *);
361 extern bfd_boolean bfd_coff_reloc16_relax_section
362 (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
363 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
364 (bfd *, struct bfd_link_info *, struct bfd_link_order *,
365 bfd_byte *, bfd_boolean, asymbol **);
366 extern bfd_vma bfd_coff_reloc16_get_value
367 (arelent *, struct bfd_link_info *, asection *);
368 extern void bfd_perform_slip
369 (bfd *, unsigned int, asection *, bfd_vma);
371 /* Functions and types in cofflink.c. */
373 #define STRING_SIZE_SIZE 4
375 /* We use a hash table to merge identical enum, struct, and union
376 definitions in the linker. */
378 /* Information we keep for a single element (an enum value, a
379 structure or union field) in the debug merge hash table. */
381 struct coff_debug_merge_element
383 /* Next element. */
384 struct coff_debug_merge_element *next;
386 /* Name. */
387 const char *name;
389 /* Type. */
390 unsigned int type;
392 /* Symbol index for complex type. */
393 long tagndx;
396 /* A linked list of debug merge entries for a given name. */
398 struct coff_debug_merge_type
400 /* Next type with the same name. */
401 struct coff_debug_merge_type *next;
403 /* Class of type. */
404 int type_class;
406 /* Symbol index where this type is defined. */
407 long indx;
409 /* List of elements. */
410 struct coff_debug_merge_element *elements;
413 /* Information we store in the debug merge hash table. */
415 struct coff_debug_merge_hash_entry
417 struct bfd_hash_entry root;
419 /* A list of types with this name. */
420 struct coff_debug_merge_type *types;
423 /* The debug merge hash table. */
425 struct coff_debug_merge_hash_table
427 struct bfd_hash_table root;
430 /* Initialize a COFF debug merge hash table. */
432 #define coff_debug_merge_hash_table_init(table) \
433 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
434 sizeof (struct coff_debug_merge_hash_entry)))
436 /* Free a COFF debug merge hash table. */
438 #define coff_debug_merge_hash_table_free(table) \
439 (bfd_hash_table_free (&(table)->root))
441 /* Look up an entry in a COFF debug merge hash table. */
443 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
444 ((struct coff_debug_merge_hash_entry *) \
445 bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
447 /* Information we keep for each section in the output file when doing
448 a relocatable link. */
450 struct coff_link_section_info
452 /* The relocs to be output. */
453 struct internal_reloc *relocs;
454 /* For each reloc against a global symbol whose index was not known
455 when the reloc was handled, the global hash table entry. */
456 struct coff_link_hash_entry **rel_hashes;
459 /* Information that we pass around while doing the final link step. */
461 struct coff_final_link_info
463 /* General link information. */
464 struct bfd_link_info *info;
465 /* Output BFD. */
466 bfd *output_bfd;
467 /* Used to indicate failure in traversal routine. */
468 bfd_boolean failed;
469 /* If doing "task linking" set only during the time when we want the
470 global symbol writer to convert the storage class of defined global
471 symbols from global to static. */
472 bfd_boolean global_to_static;
473 /* Hash table for long symbol names. */
474 struct bfd_strtab_hash *strtab;
475 /* When doing a relocatable link, an array of information kept for
476 each output section, indexed by the target_index field. */
477 struct coff_link_section_info *section_info;
478 /* Symbol index of last C_FILE symbol (-1 if none). */
479 long last_file_index;
480 /* Contents of last C_FILE symbol. */
481 struct internal_syment last_file;
482 /* Symbol index of first aux entry of last .bf symbol with an empty
483 endndx field (-1 if none). */
484 long last_bf_index;
485 /* Contents of last_bf_index aux entry. */
486 union internal_auxent last_bf;
487 /* Hash table used to merge debug information. */
488 struct coff_debug_merge_hash_table debug_merge;
489 /* Buffer large enough to hold swapped symbols of any input file. */
490 struct internal_syment *internal_syms;
491 /* Buffer large enough to hold sections of symbols of any input file. */
492 asection **sec_ptrs;
493 /* Buffer large enough to hold output indices of symbols of any
494 input file. */
495 long *sym_indices;
496 /* Buffer large enough to hold output symbols for any input file. */
497 bfd_byte *outsyms;
498 /* Buffer large enough to hold external line numbers for any input
499 section. */
500 bfd_byte *linenos;
501 /* Buffer large enough to hold any input section. */
502 bfd_byte *contents;
503 /* Buffer large enough to hold external relocs of any input section. */
504 bfd_byte *external_relocs;
505 /* Buffer large enough to hold swapped relocs of any input section. */
506 struct internal_reloc *internal_relocs;
509 /* Most COFF variants have no way to record the alignment of a
510 section. This struct is used to set a specific alignment based on
511 the name of the section. */
513 struct coff_section_alignment_entry
515 /* The section name. */
516 const char *name;
518 /* This is either (unsigned int) -1, indicating that the section
519 name must match exactly, or it is the number of letters which
520 must match at the start of the name. */
521 unsigned int comparison_length;
523 /* These macros may be used to fill in the first two fields in a
524 structure initialization. */
525 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
526 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
528 /* Only use this entry if the default section alignment for this
529 target is at least that much (as a power of two). If this field
530 is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
531 unsigned int default_alignment_min;
533 /* Only use this entry if the default section alignment for this
534 target is no greater than this (as a power of two). If this
535 field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored. */
536 unsigned int default_alignment_max;
538 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
540 /* The desired alignment for this section (as a power of two). */
541 unsigned int alignment_power;
544 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
545 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
546 extern bfd_boolean _bfd_coff_link_hash_table_init
547 (struct coff_link_hash_table *, bfd *,
548 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
549 struct bfd_hash_table *,
550 const char *),
551 unsigned int);
552 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
553 (bfd *);
554 extern const char *_bfd_coff_internal_syment_name
555 (bfd *, const struct internal_syment *, char *);
556 extern bfd_boolean _bfd_coff_section_already_linked
557 (bfd *, asection *, struct bfd_link_info *);
558 extern bfd_boolean _bfd_coff_link_add_symbols
559 (bfd *, struct bfd_link_info *);
560 extern bfd_boolean _bfd_coff_final_link
561 (bfd *, struct bfd_link_info *);
562 extern struct internal_reloc *_bfd_coff_read_internal_relocs
563 (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
564 struct internal_reloc *);
565 extern bfd_boolean _bfd_coff_generic_relocate_section
566 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
567 struct internal_reloc *, struct internal_syment *, asection **);
568 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
569 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
570 extern bfd_boolean _bfd_coff_write_global_sym
571 (struct bfd_hash_entry *, void *);
572 extern bfd_boolean _bfd_coff_write_task_globals
573 (struct coff_link_hash_entry *, void *);
574 extern bfd_boolean _bfd_coff_link_input_bfd
575 (struct coff_final_link_info *, bfd *);
576 extern bfd_boolean _bfd_coff_reloc_link_order
577 (bfd *, struct coff_final_link_info *, asection *,
578 struct bfd_link_order *);
581 #define coff_get_section_contents_in_window \
582 _bfd_generic_get_section_contents_in_window
584 /* Functions in xcofflink.c. */
586 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
587 (bfd *);
588 extern long _bfd_xcoff_canonicalize_dynamic_symtab
589 (bfd *, asymbol **);
590 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
591 (bfd *);
592 extern long _bfd_xcoff_canonicalize_dynamic_reloc
593 (bfd *, arelent **, asymbol **);
594 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
595 (bfd *);
596 extern void _bfd_xcoff_bfd_link_hash_table_free
597 (struct bfd_link_hash_table *);
598 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
599 (bfd *, struct bfd_link_info *);
600 extern bfd_boolean _bfd_xcoff_bfd_final_link
601 (bfd *, struct bfd_link_info *);
602 extern bfd_boolean _bfd_xcoff_define_common_symbol
603 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
604 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
605 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
606 struct internal_reloc *, struct internal_syment *, asection **);
608 /* Functions in coff-ppc.c. FIXME: These are called by pe.em in the
609 linker, and so should start with bfd and be declared in bfd.h. */
611 extern bfd_boolean ppc_allocate_toc_section
612 (struct bfd_link_info *);
613 extern bfd_boolean ppc_process_before_allocation
614 (bfd *, struct bfd_link_info *);