bfd/
[deliverable/binutils-gdb.git] / bfd / libcoff-in.h
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.
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
48 typedef 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. */
112 typedef 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
128 struct 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
181 struct 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
210 struct 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 last symbol indices for symbols used by this csect. */
219 unsigned long first_symndx;
220 unsigned long last_symndx;
221 };
222
223 /* An accessor macro the xcoff_section_tdata structure. */
224 #define xcoff_section_data(abfd, sec) \
225 ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
226
227 /* Tdata for sections in PE files. */
228
229 struct pei_section_tdata
230 {
231 /* The virtual size of the section. */
232 bfd_size_type virt_size;
233 /* The PE section flags. */
234 long pe_flags;
235 };
236
237 /* An accessor macro for the pei_section_tdata structure. */
238 #define pei_section_data(abfd, sec) \
239 ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
240
241 /* COFF linker hash table entries. */
242
243 struct coff_link_hash_entry
244 {
245 struct bfd_link_hash_entry root;
246
247 /* Symbol index in output file. Set to -1 initially. Set to -2 if
248 there is a reloc against this symbol. */
249 long indx;
250
251 /* Symbol type. */
252 unsigned short type;
253
254 /* Symbol class. */
255 unsigned char class;
256
257 /* Number of auxiliary entries. */
258 char numaux;
259
260 /* BFD to take auxiliary entries from. */
261 bfd *auxbfd;
262
263 /* Pointer to array of auxiliary entries, if any. */
264 union internal_auxent *aux;
265
266 /* Flag word; legal values follow. */
267 unsigned short coff_link_hash_flags;
268 /* Symbol is a PE section symbol. */
269 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
270 };
271
272 /* COFF linker hash table. */
273
274 struct coff_link_hash_table
275 {
276 struct bfd_link_hash_table root;
277 /* A pointer to information used to link stabs in sections. */
278 struct stab_info stab_info;
279 };
280
281 /* Look up an entry in a COFF linker hash table. */
282
283 #define coff_link_hash_lookup(table, string, create, copy, follow) \
284 ((struct coff_link_hash_entry *) \
285 bfd_link_hash_lookup (&(table)->root, (string), (create), \
286 (copy), (follow)))
287
288 /* Traverse a COFF linker hash table. */
289
290 #define coff_link_hash_traverse(table, func, info) \
291 (bfd_link_hash_traverse \
292 (&(table)->root, \
293 (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
294 (info)))
295
296 /* Get the COFF linker hash table from a link_info structure. */
297
298 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
299
300 /* Functions in coffgen.c. */
301 extern const bfd_target *coff_object_p
302 (bfd *);
303 extern struct bfd_section *coff_section_from_bfd_index
304 (bfd *, int);
305 extern long coff_get_symtab_upper_bound
306 (bfd *);
307 extern long coff_canonicalize_symtab
308 (bfd *, asymbol **);
309 extern int coff_count_linenumbers
310 (bfd *);
311 extern struct coff_symbol_struct *coff_symbol_from
312 (bfd *, asymbol *);
313 extern bfd_boolean coff_renumber_symbols
314 (bfd *, int *);
315 extern void coff_mangle_symbols
316 (bfd *);
317 extern bfd_boolean coff_write_symbols
318 (bfd *);
319 extern bfd_boolean coff_write_linenumbers
320 (bfd *);
321 extern alent *coff_get_lineno
322 (bfd *, asymbol *);
323 extern asymbol *coff_section_symbol
324 (bfd *, char *);
325 extern bfd_boolean _bfd_coff_get_external_symbols
326 (bfd *);
327 extern const char *_bfd_coff_read_string_table
328 (bfd *);
329 extern bfd_boolean _bfd_coff_free_symbols
330 (bfd *);
331 extern struct coff_ptr_struct *coff_get_normalized_symtab
332 (bfd *);
333 extern long coff_get_reloc_upper_bound
334 (bfd *, sec_ptr);
335 extern asymbol *coff_make_empty_symbol
336 (bfd *);
337 extern void coff_print_symbol
338 (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
339 extern void coff_get_symbol_info
340 (bfd *, asymbol *, symbol_info *ret);
341 extern bfd_boolean _bfd_coff_is_local_label_name
342 (bfd *, const char *);
343 extern asymbol *coff_bfd_make_debug_symbol
344 (bfd *, void *, unsigned long);
345 extern bfd_boolean coff_find_nearest_line
346 (bfd *, asection *, asymbol **, bfd_vma, const char **,
347 const char **, unsigned int *);
348 extern bfd_boolean coff_find_inliner_info
349 (bfd *, const char **, const char **, unsigned int *);
350 extern int coff_sizeof_headers
351 (bfd *, struct bfd_link_info *);
352 extern bfd_boolean bfd_coff_reloc16_relax_section
353 (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
354 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
355 (bfd *, struct bfd_link_info *, struct bfd_link_order *,
356 bfd_byte *, bfd_boolean, asymbol **);
357 extern bfd_vma bfd_coff_reloc16_get_value
358 (arelent *, struct bfd_link_info *, asection *);
359 extern void bfd_perform_slip
360 (bfd *, unsigned int, asection *, bfd_vma);
361
362 /* Functions and types in cofflink.c. */
363
364 #define STRING_SIZE_SIZE 4
365
366 /* We use a hash table to merge identical enum, struct, and union
367 definitions in the linker. */
368
369 /* Information we keep for a single element (an enum value, a
370 structure or union field) in the debug merge hash table. */
371
372 struct coff_debug_merge_element
373 {
374 /* Next element. */
375 struct coff_debug_merge_element *next;
376
377 /* Name. */
378 const char *name;
379
380 /* Type. */
381 unsigned int type;
382
383 /* Symbol index for complex type. */
384 long tagndx;
385 };
386
387 /* A linked list of debug merge entries for a given name. */
388
389 struct coff_debug_merge_type
390 {
391 /* Next type with the same name. */
392 struct coff_debug_merge_type *next;
393
394 /* Class of type. */
395 int class;
396
397 /* Symbol index where this type is defined. */
398 long indx;
399
400 /* List of elements. */
401 struct coff_debug_merge_element *elements;
402 };
403
404 /* Information we store in the debug merge hash table. */
405
406 struct coff_debug_merge_hash_entry
407 {
408 struct bfd_hash_entry root;
409
410 /* A list of types with this name. */
411 struct coff_debug_merge_type *types;
412 };
413
414 /* The debug merge hash table. */
415
416 struct coff_debug_merge_hash_table
417 {
418 struct bfd_hash_table root;
419 };
420
421 /* Initialize a COFF debug merge hash table. */
422
423 #define coff_debug_merge_hash_table_init(table) \
424 (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
425 sizeof (struct coff_debug_merge_hash_entry)))
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
441 struct 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
452 struct 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
504 struct 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
535 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
536 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
537 extern bfd_boolean _bfd_coff_link_hash_table_init
538 (struct coff_link_hash_table *, bfd *,
539 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
540 struct bfd_hash_table *,
541 const char *),
542 unsigned int);
543 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
544 (bfd *);
545 extern const char *_bfd_coff_internal_syment_name
546 (bfd *, const struct internal_syment *, char *);
547 extern bfd_boolean _bfd_coff_link_add_symbols
548 (bfd *, struct bfd_link_info *);
549 extern bfd_boolean _bfd_coff_final_link
550 (bfd *, struct bfd_link_info *);
551 extern struct internal_reloc *_bfd_coff_read_internal_relocs
552 (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
553 struct internal_reloc *);
554 extern bfd_boolean _bfd_coff_generic_relocate_section
555 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
556 struct internal_reloc *, struct internal_syment *, asection **);
557 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
558 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
559 extern bfd_boolean _bfd_coff_write_global_sym
560 (struct coff_link_hash_entry *, void *);
561 extern bfd_boolean _bfd_coff_write_task_globals
562 (struct coff_link_hash_entry *, void *);
563 extern bfd_boolean _bfd_coff_link_input_bfd
564 (struct coff_final_link_info *, bfd *);
565 extern bfd_boolean _bfd_coff_reloc_link_order
566 (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
575 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
576 (bfd *);
577 extern long _bfd_xcoff_canonicalize_dynamic_symtab
578 (bfd *, asymbol **);
579 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
580 (bfd *);
581 extern long _bfd_xcoff_canonicalize_dynamic_reloc
582 (bfd *, arelent **, asymbol **);
583 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
584 (bfd *);
585 extern void _bfd_xcoff_bfd_link_hash_table_free
586 (struct bfd_link_hash_table *);
587 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
588 (bfd *, struct bfd_link_info *);
589 extern bfd_boolean _bfd_xcoff_bfd_final_link
590 (bfd *, struct bfd_link_info *);
591 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
592 (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 by pe.em in the
596 linker, and so should start with bfd and be declared in bfd.h. */
597
598 extern bfd_boolean ppc_allocate_toc_section
599 (struct bfd_link_info *);
600 extern bfd_boolean ppc_process_before_allocation
601 (bfd *, struct bfd_link_info *);
602
This page took 0.060417 seconds and 4 git commands to generate.