daily update
[platform/upstream/binutils.git] / bfd / libcoff-in.h
1 /* BFD COFF object file private structure.
2    Copyright 1990-2013 Free Software Foundation, Inc.
3    Written by Cygnus Support.
4
5    This file is part of BFD, the Binary File Descriptor library.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20    MA 02110-1301, USA.  */
21
22 #include "bfdlink.h"
23
24 /* Object file tdata; access macros.  */
25
26 #define coff_data(bfd)                ((bfd)->tdata.coff_obj_data)
27 #define obj_pe(bfd)                   (coff_data (bfd)->pe)
28 #define obj_symbols(bfd)              (coff_data (bfd)->symbols)
29 #define obj_sym_filepos(bfd)          (coff_data (bfd)->sym_filepos)
30 #define obj_relocbase(bfd)            (coff_data (bfd)->relocbase)
31 #define obj_raw_syments(bfd)          (coff_data (bfd)->raw_syments)
32 #define obj_raw_syment_count(bfd)     (coff_data (bfd)->raw_syment_count)
33 #define obj_convert(bfd)              (coff_data (bfd)->conversion_table)
34 #define obj_conv_table_size(bfd)      (coff_data (bfd)->conv_table_size)
35 #define obj_coff_external_syms(bfd)   (coff_data (bfd)->external_syms)
36 #define obj_coff_keep_syms(bfd)       (coff_data (bfd)->keep_syms)
37 #define obj_coff_strings(bfd)         (coff_data (bfd)->strings)
38 #define obj_coff_keep_strings(bfd)    (coff_data (bfd)->keep_strings)
39 #define obj_coff_sym_hashes(bfd)      (coff_data (bfd)->sym_hashes)
40 #define obj_coff_strings_written(bfd) (coff_data (bfd)->strings_written)
41 #define obj_coff_local_toc_table(bfd) (coff_data (bfd)->local_toc_sym_map)
42
43 /* `Tdata' information kept for COFF files.  */
44
45 typedef struct coff_tdata
46 {
47   struct coff_symbol_struct *symbols;   /* Symtab for input bfd.  */
48   unsigned int *conversion_table;
49   int conv_table_size;
50   file_ptr sym_filepos;
51
52   struct coff_ptr_struct *raw_syments;
53   unsigned long raw_syment_count;
54
55   /* These are only valid once writing has begun.  */
56   long int relocbase;
57
58   /* These members communicate important constants about the symbol table
59      to GDB's symbol-reading code.  These `constants' unfortunately vary
60      from coff implementation to implementation...  */
61   unsigned local_n_btmask;
62   unsigned local_n_btshft;
63   unsigned local_n_tmask;
64   unsigned local_n_tshift;
65   unsigned local_symesz;
66   unsigned local_auxesz;
67   unsigned local_linesz;
68
69   /* The unswapped external symbols.  May be NULL.  Read by
70      _bfd_coff_get_external_symbols.  */
71   void * external_syms;
72   /* If this is TRUE, the external_syms may not be freed.  */
73   bfd_boolean keep_syms;
74
75   /* The string table.  May be NULL.  Read by
76      _bfd_coff_read_string_table.  */
77   char *strings;
78   /* If this is TRUE, the strings may not be freed.  */
79   bfd_boolean keep_strings;
80   /* If this is TRUE, the strings have been written out already.  */
81   bfd_boolean strings_written;
82
83   /* Is this a PE format coff file?  */
84   int pe;
85   /* Used by the COFF backend linker.  */
86   struct coff_link_hash_entry **sym_hashes;
87
88   /* Used by the pe linker for PowerPC.  */
89   int *local_toc_sym_map;
90
91   struct bfd_link_info *link_info;
92
93   /* Used by coff_find_nearest_line.  */
94   void * line_info;
95
96   /* A place to stash dwarf2 info for this bfd.  */
97   void * dwarf2_find_line_info;
98
99   /* The timestamp from the COFF file header.  */
100   long timestamp;
101
102   /* Copy of some of the f_flags bits in the COFF filehdr structure,
103      used by ARM code.  */
104   flagword flags;
105
106   /* coff-stgo32 EXE stub header after BFD tdata has been allocated.  Its data
107      is kept in internal_filehdr.go32stub beforehand.  */
108   char *go32stub;
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   int dont_strip_reloc;
119   bfd_boolean insert_timestamp;
120   bfd_boolean (*in_reloc_p) (bfd *, reloc_howto_type *);
121   flagword real_flags;
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   long *debug_indices;
169   unsigned int *lineno_counts;
170   unsigned int import_file_id;
171 };
172
173 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
174
175 /* We take the address of the first element of an asymbol to ensure that the
176    macro is only ever applied to an asymbol.  */
177 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
178
179 /* The used_by_bfd field of a section may be set to a pointer to this
180    structure.  */
181
182 struct coff_section_tdata
183 {
184   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
185   struct internal_reloc *relocs;
186   /* If this is TRUE, the relocs entry may not be freed.  */
187   bfd_boolean keep_relocs;
188   /* The section contents.  This may be NULL.  */
189   bfd_byte *contents;
190   /* If this is TRUE, the contents entry may not be freed.  */
191   bfd_boolean keep_contents;
192   /* Information cached by coff_find_nearest_line.  */
193   bfd_vma offset;
194   unsigned int i;
195   const char *function;
196   /* Optional information about a COMDAT entry; NULL if not COMDAT. */
197   struct coff_comdat_info *comdat;
198   int line_base;
199   /* A pointer used for .stab linking optimizations.  */
200   void * stab_info;
201   /* Available for individual backends.  */
202   void * tdata;
203 };
204
205 /* An accessor macro for the coff_section_tdata structure.  */
206 #define coff_section_data(abfd, sec) \
207   ((struct coff_section_tdata *) (sec)->used_by_bfd)
208
209 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
210
211 struct xcoff_section_tdata
212 {
213   /* Used for XCOFF csects created by the linker; points to the real
214      XCOFF section which contains this csect.  */
215   asection *enclosing;
216   /* The lineno_count field for the enclosing section, because we are
217      going to clobber it there.  */
218   unsigned int lineno_count;
219   /* The first and last symbol indices for symbols used 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
230 struct 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
244 struct 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 symbol_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
275 struct 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.  */
302 extern const bfd_target *coff_object_p
303   (bfd *);
304 extern struct bfd_section *coff_section_from_bfd_index
305   (bfd *, int);
306 extern long coff_get_symtab_upper_bound
307   (bfd *);
308 extern long coff_canonicalize_symtab
309   (bfd *, asymbol **);
310 extern int coff_count_linenumbers
311   (bfd *);
312 extern struct coff_symbol_struct *coff_symbol_from
313   (bfd *, asymbol *);
314 extern bfd_boolean coff_renumber_symbols
315   (bfd *, int *);
316 extern void coff_mangle_symbols
317   (bfd *);
318 extern bfd_boolean coff_write_symbols
319   (bfd *);
320 extern bfd_boolean coff_write_alien_symbol
321   (bfd *, asymbol *, struct internal_syment *, bfd_vma *,
322    bfd_size_type *, asection **, bfd_size_type *);
323 extern bfd_boolean coff_write_linenumbers
324   (bfd *);
325 extern alent *coff_get_lineno
326   (bfd *, asymbol *);
327 extern asymbol *coff_section_symbol
328   (bfd *, char *);
329 extern bfd_boolean _bfd_coff_get_external_symbols
330   (bfd *);
331 extern const char *_bfd_coff_read_string_table
332   (bfd *);
333 extern bfd_boolean _bfd_coff_free_symbols
334   (bfd *);
335 extern struct coff_ptr_struct *coff_get_normalized_symtab
336   (bfd *);
337 extern long coff_get_reloc_upper_bound
338   (bfd *, sec_ptr);
339 extern asymbol *coff_make_empty_symbol
340   (bfd *);
341 extern void coff_print_symbol
342   (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
343 extern void coff_get_symbol_info
344   (bfd *, asymbol *, symbol_info *ret);
345 extern bfd_boolean _bfd_coff_is_local_label_name
346   (bfd *, const char *);
347 extern asymbol *coff_bfd_make_debug_symbol
348   (bfd *, void *, unsigned long);
349 extern bfd_boolean coff_find_nearest_line
350   (bfd *, asection *, asymbol **, bfd_vma, const char **,
351    const char **, unsigned int *);
352 extern bfd_boolean coff_find_nearest_line_discriminator
353   (bfd *, asection *, asymbol **, bfd_vma, const char **,
354    const char **, unsigned int *, unsigned int *);
355 struct dwarf_debug_section;
356 extern bfd_boolean coff_find_nearest_line_with_names
357   (bfd *, const struct dwarf_debug_section *, asection *, asymbol **,
358    bfd_vma, const char **, const char **, unsigned int *);
359 extern bfd_boolean coff_find_inliner_info
360   (bfd *, const char **, const char **, unsigned int *);
361 extern int coff_sizeof_headers
362   (bfd *, struct bfd_link_info *);
363 extern bfd_boolean bfd_coff_reloc16_relax_section
364   (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
365 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
366   (bfd *, struct bfd_link_info *, struct bfd_link_order *,
367    bfd_byte *, bfd_boolean, asymbol **);
368 extern bfd_vma bfd_coff_reloc16_get_value
369   (arelent *, struct bfd_link_info *, asection *);
370 extern void bfd_perform_slip
371   (bfd *, unsigned int, asection *, bfd_vma);
372
373 /* Functions and types in cofflink.c.  */
374
375 #define STRING_SIZE_SIZE 4
376
377 /* We use a hash table to merge identical enum, struct, and union
378    definitions in the linker.  */
379
380 /* Information we keep for a single element (an enum value, a
381    structure or union field) in the debug merge hash table.  */
382
383 struct coff_debug_merge_element
384 {
385   /* Next element.  */
386   struct coff_debug_merge_element *next;
387
388   /* Name.  */
389   const char *name;
390
391   /* Type.  */
392   unsigned int type;
393
394   /* Symbol index for complex type.  */
395   long tagndx;
396 };
397
398 /* A linked list of debug merge entries for a given name.  */
399
400 struct coff_debug_merge_type
401 {
402   /* Next type with the same name.  */
403   struct coff_debug_merge_type *next;
404
405   /* Class of type.  */
406   int type_class;
407
408   /* Symbol index where this type is defined.  */
409   long indx;
410
411   /* List of elements.  */
412   struct coff_debug_merge_element *elements;
413 };
414
415 /* Information we store in the debug merge hash table.  */
416
417 struct coff_debug_merge_hash_entry
418 {
419   struct bfd_hash_entry root;
420
421   /* A list of types with this name.  */
422   struct coff_debug_merge_type *types;
423 };
424
425 /* The debug merge hash table.  */
426
427 struct coff_debug_merge_hash_table
428 {
429   struct bfd_hash_table root;
430 };
431
432 /* Initialize a COFF debug merge hash table.  */
433
434 #define coff_debug_merge_hash_table_init(table) \
435   (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
436                         sizeof (struct coff_debug_merge_hash_entry)))
437
438 /* Free a COFF debug merge hash table.  */
439
440 #define coff_debug_merge_hash_table_free(table) \
441   (bfd_hash_table_free (&(table)->root))
442
443 /* Look up an entry in a COFF debug merge hash table.  */
444
445 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
446   ((struct coff_debug_merge_hash_entry *) \
447    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
448
449 /* Information we keep for each section in the output file when doing
450    a relocatable link.  */
451
452 struct coff_link_section_info
453 {
454   /* The relocs to be output.  */
455   struct internal_reloc *relocs;
456   /* For each reloc against a global symbol whose index was not known
457      when the reloc was handled, the global hash table entry.  */
458   struct coff_link_hash_entry **rel_hashes;
459 };
460
461 /* Information that we pass around while doing the final link step.  */
462
463 struct coff_final_link_info
464 {
465   /* General link information.  */
466   struct bfd_link_info *info;
467   /* Output BFD.  */
468   bfd *output_bfd;
469   /* Used to indicate failure in traversal routine.  */
470   bfd_boolean failed;
471   /* If doing "task linking" set only during the time when we want the
472      global symbol writer to convert the storage class of defined global
473      symbols from global to static. */
474   bfd_boolean global_to_static;
475   /* Hash table for long symbol names.  */
476   struct bfd_strtab_hash *strtab;
477   /* When doing a relocatable link, an array of information kept for
478      each output section, indexed by the target_index field.  */
479   struct coff_link_section_info *section_info;
480   /* Symbol index of last C_FILE symbol (-1 if none).  */
481   long last_file_index;
482   /* Contents of last C_FILE symbol.  */
483   struct internal_syment last_file;
484   /* Symbol index of first aux entry of last .bf symbol with an empty
485      endndx field (-1 if none).  */
486   long last_bf_index;
487   /* Contents of last_bf_index aux entry.  */
488   union internal_auxent last_bf;
489   /* Hash table used to merge debug information.  */
490   struct coff_debug_merge_hash_table debug_merge;
491   /* Buffer large enough to hold swapped symbols of any input file.  */
492   struct internal_syment *internal_syms;
493   /* Buffer large enough to hold sections of symbols of any input file.  */
494   asection **sec_ptrs;
495   /* Buffer large enough to hold output indices of symbols of any
496      input file.  */
497   long *sym_indices;
498   /* Buffer large enough to hold output symbols for any input file.  */
499   bfd_byte *outsyms;
500   /* Buffer large enough to hold external line numbers for any input
501      section.  */
502   bfd_byte *linenos;
503   /* Buffer large enough to hold any input section.  */
504   bfd_byte *contents;
505   /* Buffer large enough to hold external relocs of any input section.  */
506   bfd_byte *external_relocs;
507   /* Buffer large enough to hold swapped relocs of any input section.  */
508   struct internal_reloc *internal_relocs;
509 };
510
511 /* Most COFF variants have no way to record the alignment of a
512    section.  This struct is used to set a specific alignment based on
513    the name of the section.  */
514
515 struct coff_section_alignment_entry
516 {
517   /* The section name.  */
518   const char *name;
519
520   /* This is either (unsigned int) -1, indicating that the section
521      name must match exactly, or it is the number of letters which
522      must match at the start of the name.  */
523   unsigned int comparison_length;
524
525   /* These macros may be used to fill in the first two fields in a
526      structure initialization.  */
527 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
528 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
529
530   /* Only use this entry if the default section alignment for this
531      target is at least that much (as a power of two).  If this field
532      is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
533   unsigned int default_alignment_min;
534
535   /* Only use this entry if the default section alignment for this
536      target is no greater than this (as a power of two).  If this
537      field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
538   unsigned int default_alignment_max;
539
540 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
541
542   /* The desired alignment for this section (as a power of two).  */
543   unsigned int alignment_power;
544 };
545
546 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
547   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
548 extern bfd_boolean _bfd_coff_link_hash_table_init
549   (struct coff_link_hash_table *, bfd *,
550    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
551                                struct bfd_hash_table *,
552                                const char *),
553    unsigned int);
554 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
555   (bfd *);
556 extern const char *_bfd_coff_internal_syment_name
557   (bfd *, const struct internal_syment *, char *);
558 extern bfd_boolean _bfd_coff_section_already_linked
559   (bfd *, asection *, struct bfd_link_info *);
560 extern bfd_boolean _bfd_coff_link_add_symbols
561   (bfd *, struct bfd_link_info *);
562 extern bfd_boolean _bfd_coff_final_link
563   (bfd *, struct bfd_link_info *);
564 extern struct internal_reloc *_bfd_coff_read_internal_relocs
565   (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
566    struct internal_reloc *);
567 extern bfd_boolean _bfd_coff_generic_relocate_section
568   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
569    struct internal_reloc *, struct internal_syment *, asection **);
570 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
571   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
572 extern bfd_boolean _bfd_coff_write_global_sym
573   (struct bfd_hash_entry *, void *);
574 extern bfd_boolean _bfd_coff_write_task_globals
575   (struct coff_link_hash_entry *, void *);
576 extern bfd_boolean _bfd_coff_link_input_bfd
577   (struct coff_final_link_info *, bfd *);
578 extern bfd_boolean _bfd_coff_reloc_link_order
579   (bfd *, struct coff_final_link_info *, asection *,
580    struct bfd_link_order *);
581
582
583 #define coff_get_section_contents_in_window \
584   _bfd_generic_get_section_contents_in_window
585
586 /* Functions in xcofflink.c.  */
587
588 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
589   (bfd *);
590 extern long _bfd_xcoff_canonicalize_dynamic_symtab
591   (bfd *, asymbol **);
592 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
593   (bfd *);
594 extern long _bfd_xcoff_canonicalize_dynamic_reloc
595   (bfd *, arelent **, asymbol **);
596 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
597   (bfd *);
598 extern void _bfd_xcoff_bfd_link_hash_table_free
599   (struct bfd_link_hash_table *);
600 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
601   (bfd *, struct bfd_link_info *);
602 extern bfd_boolean _bfd_xcoff_bfd_final_link
603   (bfd *, struct bfd_link_info *);
604 extern bfd_boolean _bfd_xcoff_define_common_symbol
605   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
606 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
607   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
608    struct internal_reloc *, struct internal_syment *, asection **);
609
610 /* Functions in coff-ppc.c.  FIXME: These are called by pe.em in the
611    linker, and so should start with bfd and be declared in bfd.h.  */
612
613 extern bfd_boolean ppc_allocate_toc_section
614   (struct bfd_link_info *);
615 extern bfd_boolean ppc_process_before_allocation
616   (bfd *, struct bfd_link_info *);