Merge bfd_find_nearest_line variants
[external/binutils.git] / bfd / libcoff-in.h
1 /* BFD COFF object file private structure.
2    Copyright (C) 1990-2014 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   unsigned 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
123   /* Build-id info.  */
124   struct
125   {
126     bfd_boolean (*after_write_object_contents) (bfd *);
127     const char *style;
128     asection *sec;
129   } build_id;
130 } pe_data_type;
131
132 #define pe_data(bfd)            ((bfd)->tdata.pe_obj_data)
133
134 /* Tdata for XCOFF files.  */
135
136 struct xcoff_tdata
137 {
138   /* Basic COFF information.  */
139   coff_data_type coff;
140
141   /* TRUE if this is an XCOFF64 file. */
142   bfd_boolean xcoff64;
143
144   /* TRUE if a large a.out header should be generated.  */
145   bfd_boolean full_aouthdr;
146
147   /* TOC value.  */
148   bfd_vma toc;
149
150   /* Index of section holding TOC.  */
151   int sntoc;
152
153   /* Index of section holding entry point.  */
154   int snentry;
155
156   /* .text alignment from optional header.  */
157   int text_align_power;
158
159   /* .data alignment from optional header.  */
160   int data_align_power;
161
162   /* modtype from optional header.  */
163   short modtype;
164
165   /* cputype from optional header.  */
166   short cputype;
167
168   /* maxdata from optional header.  */
169   bfd_vma maxdata;
170
171   /* maxstack from optional header.  */
172   bfd_vma maxstack;
173
174   /* Used by the XCOFF backend linker.  */
175   asection **csects;
176   long *debug_indices;
177   unsigned int *lineno_counts;
178   unsigned int import_file_id;
179 };
180
181 #define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
182
183 /* We take the address of the first element of an asymbol to ensure that the
184    macro is only ever applied to an asymbol.  */
185 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
186
187 /* The used_by_bfd field of a section may be set to a pointer to this
188    structure.  */
189
190 struct coff_section_tdata
191 {
192   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
193   struct internal_reloc *relocs;
194   /* If this is TRUE, the relocs entry may not be freed.  */
195   bfd_boolean keep_relocs;
196   /* The section contents.  This may be NULL.  */
197   bfd_byte *contents;
198   /* If this is TRUE, the contents entry may not be freed.  */
199   bfd_boolean keep_contents;
200   /* Information cached by coff_find_nearest_line.  */
201   bfd_vma offset;
202   unsigned int i;
203   const char *function;
204   /* Optional information about a COMDAT entry; NULL if not COMDAT. */
205   struct coff_comdat_info *comdat;
206   int line_base;
207   /* A pointer used for .stab linking optimizations.  */
208   void * stab_info;
209   /* Available for individual backends.  */
210   void * tdata;
211 };
212
213 /* An accessor macro for the coff_section_tdata structure.  */
214 #define coff_section_data(abfd, sec) \
215   ((struct coff_section_tdata *) (sec)->used_by_bfd)
216
217 /* Tdata for sections in XCOFF files.  This is used by the linker.  */
218
219 struct xcoff_section_tdata
220 {
221   /* Used for XCOFF csects created by the linker; points to the real
222      XCOFF section which contains this csect.  */
223   asection *enclosing;
224   /* The lineno_count field for the enclosing section, because we are
225      going to clobber it there.  */
226   unsigned int lineno_count;
227   /* The first and last symbol indices for symbols used by this csect.  */
228   unsigned long first_symndx;
229   unsigned long last_symndx;
230 };
231
232 /* An accessor macro the xcoff_section_tdata structure.  */
233 #define xcoff_section_data(abfd, sec) \
234   ((struct xcoff_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
235
236 /* Tdata for sections in PE files.  */
237
238 struct pei_section_tdata
239 {
240   /* The virtual size of the section.  */
241   bfd_size_type virt_size;
242   /* The PE section flags.  */
243   long pe_flags;
244 };
245
246 /* An accessor macro for the pei_section_tdata structure.  */
247 #define pei_section_data(abfd, sec) \
248   ((struct pei_section_tdata *) coff_section_data ((abfd), (sec))->tdata)
249
250 /* COFF linker hash table entries.  */
251
252 struct coff_link_hash_entry
253 {
254   struct bfd_link_hash_entry root;
255
256   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
257      there is a reloc against this symbol.  */
258   long indx;
259
260   /* Symbol type.  */
261   unsigned short type;
262
263   /* Symbol class.  */
264   unsigned char symbol_class;
265
266   /* Number of auxiliary entries.  */
267   char numaux;
268
269   /* BFD to take auxiliary entries from.  */
270   bfd *auxbfd;
271
272   /* Pointer to array of auxiliary entries, if any.  */
273   union internal_auxent *aux;
274
275   /* Flag word; legal values follow.  */
276   unsigned short coff_link_hash_flags;
277   /* Symbol is a PE section symbol.  */
278 #define COFF_LINK_HASH_PE_SECTION_SYMBOL (01)
279 };
280
281 /* COFF linker hash table.  */
282
283 struct coff_link_hash_table
284 {
285   struct bfd_link_hash_table root;
286   /* A pointer to information used to link stabs in sections.  */
287   struct stab_info stab_info;
288 };
289
290 /* Look up an entry in a COFF linker hash table.  */
291
292 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
293   ((struct coff_link_hash_entry *)                                      \
294    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
295                          (copy), (follow)))
296
297 /* Traverse a COFF linker hash table.  */
298
299 #define coff_link_hash_traverse(table, func, info)                      \
300   (bfd_link_hash_traverse                                               \
301    (&(table)->root,                                                     \
302     (bfd_boolean (*) (struct bfd_link_hash_entry *, void *)) (func), \
303     (info)))
304
305 /* Get the COFF linker hash table from a link_info structure.  */
306
307 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
308
309 /* Functions in coffgen.c.  */
310 extern const bfd_target *coff_object_p
311   (bfd *);
312 extern struct bfd_section *coff_section_from_bfd_index
313   (bfd *, int);
314 extern long coff_get_symtab_upper_bound
315   (bfd *);
316 extern long coff_canonicalize_symtab
317   (bfd *, asymbol **);
318 extern int coff_count_linenumbers
319   (bfd *);
320 extern struct coff_symbol_struct *coff_symbol_from
321   (bfd *, asymbol *);
322 extern bfd_boolean coff_renumber_symbols
323   (bfd *, int *);
324 extern void coff_mangle_symbols
325   (bfd *);
326 extern bfd_boolean coff_write_symbols
327   (bfd *);
328 extern bfd_boolean coff_write_alien_symbol
329   (bfd *, asymbol *, struct internal_syment *, bfd_vma *,
330    bfd_size_type *, asection **, bfd_size_type *);
331 extern bfd_boolean coff_write_linenumbers
332   (bfd *);
333 extern alent *coff_get_lineno
334   (bfd *, asymbol *);
335 extern asymbol *coff_section_symbol
336   (bfd *, char *);
337 extern bfd_boolean _bfd_coff_get_external_symbols
338   (bfd *);
339 extern const char *_bfd_coff_read_string_table
340   (bfd *);
341 extern bfd_boolean _bfd_coff_free_symbols
342   (bfd *);
343 extern struct coff_ptr_struct *coff_get_normalized_symtab
344   (bfd *);
345 extern long coff_get_reloc_upper_bound
346   (bfd *, sec_ptr);
347 extern asymbol *coff_make_empty_symbol
348   (bfd *);
349 extern void coff_print_symbol
350   (bfd *, void * filep, asymbol *, bfd_print_symbol_type);
351 extern void coff_get_symbol_info
352   (bfd *, asymbol *, symbol_info *ret);
353 extern bfd_boolean _bfd_coff_is_local_label_name
354   (bfd *, const char *);
355 extern asymbol *coff_bfd_make_debug_symbol
356   (bfd *, void *, unsigned long);
357 extern bfd_boolean coff_find_nearest_line
358   (bfd *, asymbol **, asection *, bfd_vma,
359    const char **, const char **, unsigned int *, unsigned int *);
360 #define coff_find_line _bfd_nosymbols_find_line
361 struct dwarf_debug_section;
362 extern bfd_boolean coff_find_nearest_line_with_names
363   (bfd *, asymbol **, asection *, bfd_vma, const char **, const char **,
364    unsigned int *, const struct dwarf_debug_section *);
365 extern bfd_boolean coff_find_inliner_info
366   (bfd *, const char **, const char **, unsigned int *);
367 extern int coff_sizeof_headers
368   (bfd *, struct bfd_link_info *);
369 extern bfd_boolean bfd_coff_reloc16_relax_section
370   (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
371 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
372   (bfd *, struct bfd_link_info *, struct bfd_link_order *,
373    bfd_byte *, bfd_boolean, asymbol **);
374 extern bfd_vma bfd_coff_reloc16_get_value
375   (arelent *, struct bfd_link_info *, asection *);
376 extern void bfd_perform_slip
377   (bfd *, unsigned int, asection *, bfd_vma);
378
379 /* Functions and types in cofflink.c.  */
380
381 #define STRING_SIZE_SIZE 4
382
383 /* We use a hash table to merge identical enum, struct, and union
384    definitions in the linker.  */
385
386 /* Information we keep for a single element (an enum value, a
387    structure or union field) in the debug merge hash table.  */
388
389 struct coff_debug_merge_element
390 {
391   /* Next element.  */
392   struct coff_debug_merge_element *next;
393
394   /* Name.  */
395   const char *name;
396
397   /* Type.  */
398   unsigned int type;
399
400   /* Symbol index for complex type.  */
401   long tagndx;
402 };
403
404 /* A linked list of debug merge entries for a given name.  */
405
406 struct coff_debug_merge_type
407 {
408   /* Next type with the same name.  */
409   struct coff_debug_merge_type *next;
410
411   /* Class of type.  */
412   int type_class;
413
414   /* Symbol index where this type is defined.  */
415   long indx;
416
417   /* List of elements.  */
418   struct coff_debug_merge_element *elements;
419 };
420
421 /* Information we store in the debug merge hash table.  */
422
423 struct coff_debug_merge_hash_entry
424 {
425   struct bfd_hash_entry root;
426
427   /* A list of types with this name.  */
428   struct coff_debug_merge_type *types;
429 };
430
431 /* The debug merge hash table.  */
432
433 struct coff_debug_merge_hash_table
434 {
435   struct bfd_hash_table root;
436 };
437
438 /* Initialize a COFF debug merge hash table.  */
439
440 #define coff_debug_merge_hash_table_init(table) \
441   (bfd_hash_table_init (&(table)->root, _bfd_coff_debug_merge_hash_newfunc, \
442                         sizeof (struct coff_debug_merge_hash_entry)))
443
444 /* Free a COFF debug merge hash table.  */
445
446 #define coff_debug_merge_hash_table_free(table) \
447   (bfd_hash_table_free (&(table)->root))
448
449 /* Look up an entry in a COFF debug merge hash table.  */
450
451 #define coff_debug_merge_hash_lookup(table, string, create, copy) \
452   ((struct coff_debug_merge_hash_entry *) \
453    bfd_hash_lookup (&(table)->root, (string), (create), (copy)))
454
455 /* Information we keep for each section in the output file when doing
456    a relocatable link.  */
457
458 struct coff_link_section_info
459 {
460   /* The relocs to be output.  */
461   struct internal_reloc *relocs;
462   /* For each reloc against a global symbol whose index was not known
463      when the reloc was handled, the global hash table entry.  */
464   struct coff_link_hash_entry **rel_hashes;
465 };
466
467 /* Information that we pass around while doing the final link step.  */
468
469 struct coff_final_link_info
470 {
471   /* General link information.  */
472   struct bfd_link_info *info;
473   /* Output BFD.  */
474   bfd *output_bfd;
475   /* Used to indicate failure in traversal routine.  */
476   bfd_boolean failed;
477   /* If doing "task linking" set only during the time when we want the
478      global symbol writer to convert the storage class of defined global
479      symbols from global to static. */
480   bfd_boolean global_to_static;
481   /* Hash table for long symbol names.  */
482   struct bfd_strtab_hash *strtab;
483   /* When doing a relocatable link, an array of information kept for
484      each output section, indexed by the target_index field.  */
485   struct coff_link_section_info *section_info;
486   /* Symbol index of last C_FILE symbol (-1 if none).  */
487   long last_file_index;
488   /* Contents of last C_FILE symbol.  */
489   struct internal_syment last_file;
490   /* Symbol index of first aux entry of last .bf symbol with an empty
491      endndx field (-1 if none).  */
492   long last_bf_index;
493   /* Contents of last_bf_index aux entry.  */
494   union internal_auxent last_bf;
495   /* Hash table used to merge debug information.  */
496   struct coff_debug_merge_hash_table debug_merge;
497   /* Buffer large enough to hold swapped symbols of any input file.  */
498   struct internal_syment *internal_syms;
499   /* Buffer large enough to hold sections of symbols of any input file.  */
500   asection **sec_ptrs;
501   /* Buffer large enough to hold output indices of symbols of any
502      input file.  */
503   long *sym_indices;
504   /* Buffer large enough to hold output symbols for any input file.  */
505   bfd_byte *outsyms;
506   /* Buffer large enough to hold external line numbers for any input
507      section.  */
508   bfd_byte *linenos;
509   /* Buffer large enough to hold any input section.  */
510   bfd_byte *contents;
511   /* Buffer large enough to hold external relocs of any input section.  */
512   bfd_byte *external_relocs;
513   /* Buffer large enough to hold swapped relocs of any input section.  */
514   struct internal_reloc *internal_relocs;
515 };
516
517 /* Most COFF variants have no way to record the alignment of a
518    section.  This struct is used to set a specific alignment based on
519    the name of the section.  */
520
521 struct coff_section_alignment_entry
522 {
523   /* The section name.  */
524   const char *name;
525
526   /* This is either (unsigned int) -1, indicating that the section
527      name must match exactly, or it is the number of letters which
528      must match at the start of the name.  */
529   unsigned int comparison_length;
530
531   /* These macros may be used to fill in the first two fields in a
532      structure initialization.  */
533 #define COFF_SECTION_NAME_EXACT_MATCH(name) (name), ((unsigned int) -1)
534 #define COFF_SECTION_NAME_PARTIAL_MATCH(name) (name), (sizeof (name) - 1)
535
536   /* Only use this entry if the default section alignment for this
537      target is at least that much (as a power of two).  If this field
538      is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
539   unsigned int default_alignment_min;
540
541   /* Only use this entry if the default section alignment for this
542      target is no greater than this (as a power of two).  If this
543      field is COFF_ALIGNMENT_FIELD_EMPTY, it should be ignored.  */
544   unsigned int default_alignment_max;
545
546 #define COFF_ALIGNMENT_FIELD_EMPTY ((unsigned int) -1)
547
548   /* The desired alignment for this section (as a power of two).  */
549   unsigned int alignment_power;
550 };
551
552 extern struct bfd_hash_entry *_bfd_coff_link_hash_newfunc
553   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
554 extern bfd_boolean _bfd_coff_link_hash_table_init
555   (struct coff_link_hash_table *, bfd *,
556    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
557                                struct bfd_hash_table *,
558                                const char *),
559    unsigned int);
560 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
561   (bfd *);
562 extern const char *_bfd_coff_internal_syment_name
563   (bfd *, const struct internal_syment *, char *);
564 extern bfd_boolean _bfd_coff_section_already_linked
565   (bfd *, asection *, struct bfd_link_info *);
566 extern bfd_boolean _bfd_coff_link_add_symbols
567   (bfd *, struct bfd_link_info *);
568 extern bfd_boolean _bfd_coff_final_link
569   (bfd *, struct bfd_link_info *);
570 extern struct internal_reloc *_bfd_coff_read_internal_relocs
571   (bfd *, asection *, bfd_boolean, bfd_byte *, bfd_boolean,
572    struct internal_reloc *);
573 extern bfd_boolean _bfd_coff_generic_relocate_section
574   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
575    struct internal_reloc *, struct internal_syment *, asection **);
576 extern struct bfd_hash_entry *_bfd_coff_debug_merge_hash_newfunc
577   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
578 extern bfd_boolean _bfd_coff_write_global_sym
579   (struct bfd_hash_entry *, void *);
580 extern bfd_boolean _bfd_coff_write_task_globals
581   (struct coff_link_hash_entry *, void *);
582 extern bfd_boolean _bfd_coff_link_input_bfd
583   (struct coff_final_link_info *, bfd *);
584 extern bfd_boolean _bfd_coff_reloc_link_order
585   (bfd *, struct coff_final_link_info *, asection *,
586    struct bfd_link_order *);
587
588
589 #define coff_get_section_contents_in_window \
590   _bfd_generic_get_section_contents_in_window
591
592 /* Functions in xcofflink.c.  */
593
594 extern long _bfd_xcoff_get_dynamic_symtab_upper_bound
595   (bfd *);
596 extern long _bfd_xcoff_canonicalize_dynamic_symtab
597   (bfd *, asymbol **);
598 extern long _bfd_xcoff_get_dynamic_reloc_upper_bound
599   (bfd *);
600 extern long _bfd_xcoff_canonicalize_dynamic_reloc
601   (bfd *, arelent **, asymbol **);
602 extern struct bfd_link_hash_table *_bfd_xcoff_bfd_link_hash_table_create
603   (bfd *);
604 extern bfd_boolean _bfd_xcoff_bfd_link_add_symbols
605   (bfd *, struct bfd_link_info *);
606 extern bfd_boolean _bfd_xcoff_bfd_final_link
607   (bfd *, struct bfd_link_info *);
608 extern bfd_boolean _bfd_xcoff_define_common_symbol
609   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
610 extern bfd_boolean _bfd_ppc_xcoff_relocate_section
611   (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
612    struct internal_reloc *, struct internal_syment *, asection **);
613
614 /* Functions in coff-ppc.c.  FIXME: These are called by pe.em in the
615    linker, and so should start with bfd and be declared in bfd.h.  */
616
617 extern bfd_boolean ppc_allocate_toc_section
618   (struct bfd_link_info *);
619 extern bfd_boolean ppc_process_before_allocation
620   (bfd *, struct bfd_link_info *);