Thu Sep 7 12:45:34 1995 steve chamberlain <sac@slash.cygnus.com>
[external/binutils.git] / bfd / libcoff.h
1 /* BFD COFF object file private structure.
2    Copyright (C) 1990, 91, 92, 93, 94, 1995 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 2 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #include "bfdlink.h"
22
23 /* Object file tdata; access macros */
24
25 #define coff_data(bfd)          ((bfd)->tdata.coff_obj_data)
26 #define exec_hdr(bfd)           (coff_data(bfd)->hdr)
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
31 #define obj_relocbase(bfd)      (coff_data(bfd)->relocbase)
32 #define obj_raw_syments(bfd)    (coff_data(bfd)->raw_syments)
33 #define obj_raw_syment_count(bfd)       (coff_data(bfd)->raw_syment_count)
34 #define obj_convert(bfd)        (coff_data(bfd)->conversion_table)
35 #define obj_conv_table_size(bfd) (coff_data(bfd)->conv_table_size)
36
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
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 int 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   PTR external_syms;
72   /* If this is true, the external_syms may not be freed.  */
73   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   boolean keep_strings;
80
81   /* is this a PE format coff file */
82   int pe;
83   /* Used by the COFF backend linker.  */
84   struct coff_link_hash_entry **sym_hashes;
85
86   struct bfd_link_info *link_info;
87 } coff_data_type;
88
89 /* Tdata for pe image files. */
90 typedef struct pe_tdata
91 {
92   coff_data_type coff;
93   struct internal_extra_pe_aouthdr pe_opthdr;
94   int dll;
95   int has_reloc_section;
96 } pe_data_type;
97
98 #define pe_data(bfd)            ((bfd)->tdata.pe_obj_data)
99
100
101 /* We take the address of the first element of a asymbol to ensure that the
102  * macro is only ever applied to an asymbol.  */
103 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
104
105 /* The used_by_bfd field of a section may be set to a pointer to this
106    structure.  */
107
108 struct coff_section_tdata
109 {
110   /* The relocs, swapped into COFF internal form.  This may be NULL.  */
111   struct internal_reloc *relocs;
112   /* If this is true, the relocs entry may not be freed.  */
113   boolean keep_relocs;
114   /* The section contents.  This may be NULL.  */
115   bfd_byte *contents;
116   /* If this is true, the contents entry may not be freed.  */
117   boolean keep_contents;
118 };
119
120 /* An accessor macro for the coff_section_tdata structure.  */
121 #define coff_section_data(abfd, sec) \
122   ((struct coff_section_tdata *) (sec)->used_by_bfd)
123
124 /* COFF linker hash table entries.  */
125
126 struct coff_link_hash_entry
127 {
128   struct bfd_link_hash_entry root;
129
130   /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
131      there is a reloc against this symbol.  */
132   long indx;
133
134   /* Symbol type.  */
135   unsigned short type;
136
137   /* Symbol class.  */
138   unsigned char class;
139
140   /* Number of auxiliary entries.  */
141   char numaux;
142
143   /* BFD to take auxiliary entries from.  */
144   bfd *auxbfd;
145
146   /* Pointer to array of auxiliary entries, if any.  */
147   union internal_auxent *aux;
148 };
149
150 /* COFF linker hash table.  */
151
152 struct coff_link_hash_table
153 {
154   struct bfd_link_hash_table root;
155 };
156
157 /* Look up an entry in a COFF linker hash table.  */
158
159 #define coff_link_hash_lookup(table, string, create, copy, follow)      \
160   ((struct coff_link_hash_entry *)                                      \
161    bfd_link_hash_lookup (&(table)->root, (string), (create),            \
162                          (copy), (follow)))
163
164 /* Traverse a COFF linker hash table.  */
165
166 #define coff_link_hash_traverse(table, func, info)                      \
167   (bfd_link_hash_traverse                                               \
168    (&(table)->root,                                                     \
169     (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),  \
170     (info)))
171
172 /* Get the COFF linker hash table from a link_info structure.  */
173
174 #define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
175
176 /* Functions in coffgen.c.  */
177 extern const bfd_target *coff_object_p PARAMS ((bfd *));
178 extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int));
179 extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
180 extern long coff_get_symtab PARAMS ((bfd *, asymbol **));
181 extern int coff_count_linenumbers PARAMS ((bfd *));
182 extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *));
183 extern boolean coff_renumber_symbols PARAMS ((bfd *, int *));
184 extern void coff_mangle_symbols PARAMS ((bfd *));
185 extern boolean coff_write_symbols PARAMS ((bfd *));
186 extern boolean coff_write_linenumbers PARAMS ((bfd *));
187 extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *));
188 extern asymbol *coff_section_symbol PARAMS ((bfd *, char *));
189 extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
190 extern const char *_bfd_coff_read_string_table PARAMS ((bfd *));
191 extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
192 extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *));
193 extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
194 extern asymbol *coff_make_empty_symbol PARAMS ((bfd *));
195 extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *,
196                                        bfd_print_symbol_type how));
197 extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *,
198                                           symbol_info *ret));
199 extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR,
200                                                     unsigned long));
201 extern boolean coff_find_nearest_line PARAMS ((bfd *,
202                                                asection *,
203                                                asymbol **,
204                                                bfd_vma offset,
205                                                CONST char **filename_ptr,
206                                                CONST char **functionname_ptr,
207                                                unsigned int *line_ptr));
208 extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
209 extern boolean bfd_coff_reloc16_relax_section
210   PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
211 extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
212   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
213            bfd_byte *, boolean relocateable, asymbol **));
214 extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
215                                                    struct bfd_link_info *,
216                                                    asection *));
217 extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
218                                       asection *input_section,
219                                       bfd_vma val));
220
221 /* Functions in cofflink.c.  */
222
223 extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
224   PARAMS ((bfd *));
225 extern boolean _bfd_coff_link_add_symbols
226   PARAMS ((bfd *, struct bfd_link_info *));
227 extern boolean _bfd_coff_final_link
228   PARAMS ((bfd *, struct bfd_link_info *));
229 extern struct internal_reloc *_bfd_coff_read_internal_relocs
230   PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
231            struct internal_reloc *));
232 extern boolean _bfd_coff_generic_relocate_section
233   PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
234            struct internal_reloc *, struct internal_syment *, asection **));
235
236 /* And more taken from the source .. */
237
238 typedef struct coff_ptr_struct
239 {
240
241         /* Remembers the offset from the first symbol in the file for
242           this symbol. Generated by coff_renumber_symbols. */
243 unsigned int offset;
244
245         /* Should the value of this symbol be renumbered.  Used for
246           XCOFF C_BSTAT symbols.  Set by coff_slurp_symbol_table.  */
247 unsigned int fix_value : 1;
248
249         /* Should the tag field of this symbol be renumbered.
250           Created by coff_pointerize_aux. */
251 unsigned int fix_tag : 1;
252
253         /* Should the endidx field of this symbol be renumbered.
254           Created by coff_pointerize_aux. */
255 unsigned int fix_end : 1;
256
257         /* Should the x_csect.x_scnlen field be renumbered.
258           Created by coff_slurp_symbol_table. */
259 unsigned int fix_scnlen : 1;
260
261         /* The container for the symbol structure as read and translated
262            from the file. */
263
264 union {
265    union internal_auxent auxent;
266    struct internal_syment syment;
267  } u;
268 } combined_entry_type;
269
270
271  /* Each canonical asymbol really looks like this: */
272
273 typedef struct coff_symbol_struct
274 {
275     /* The actual symbol which the rest of BFD works with */
276 asymbol symbol;
277
278     /* A pointer to the hidden information for this symbol */
279 combined_entry_type *native;
280
281     /* A pointer to the linenumber information for this symbol */
282 struct lineno_cache_entry *lineno;
283
284     /* Have the line numbers been relocated yet ? */
285 boolean done_lineno;
286 } coff_symbol_type;
287 typedef struct
288 {
289   void (*_bfd_coff_swap_aux_in) PARAMS ((
290        bfd            *abfd,
291        PTR             ext,
292        int             type,
293        int             class,
294        int             indaux,
295        int             numaux,
296        PTR             in));
297
298   void (*_bfd_coff_swap_sym_in) PARAMS ((
299        bfd            *abfd ,
300        PTR             ext,
301        PTR             in));
302
303   void (*_bfd_coff_swap_lineno_in) PARAMS ((
304        bfd            *abfd,
305        PTR            ext,
306        PTR             in));
307
308  unsigned int (*_bfd_coff_swap_aux_out) PARAMS ((
309        bfd      *abfd,
310        PTR      in,
311        int      type,
312        int      class,
313        int     indaux,
314        int     numaux,
315        PTR      ext));
316
317  unsigned int (*_bfd_coff_swap_sym_out) PARAMS ((
318       bfd      *abfd,
319       PTR       in,
320       PTR       ext));
321
322  unsigned int (*_bfd_coff_swap_lineno_out) PARAMS ((
323         bfd     *abfd,
324         PTR     in,
325         PTR     ext));
326
327  unsigned int (*_bfd_coff_swap_reloc_out) PARAMS ((
328         bfd     *abfd,
329         PTR     src,
330         PTR     dst));
331
332  unsigned int (*_bfd_coff_swap_filehdr_out) PARAMS ((
333         bfd     *abfd,
334         PTR     in,
335         PTR     out));
336
337  unsigned int (*_bfd_coff_swap_aouthdr_out) PARAMS ((
338         bfd     *abfd,
339         PTR     in,
340         PTR     out));
341
342  unsigned int (*_bfd_coff_swap_scnhdr_out) PARAMS ((
343         bfd     *abfd,
344         PTR     in,
345         PTR     out));
346
347  unsigned int _bfd_filhsz;
348  unsigned int _bfd_aoutsz;
349  unsigned int _bfd_scnhsz;
350  unsigned int _bfd_symesz;
351  unsigned int _bfd_auxesz;
352  unsigned int _bfd_relsz;
353  unsigned int _bfd_linesz;
354  boolean _bfd_coff_long_filenames;
355  void (*_bfd_coff_swap_filehdr_in) PARAMS ((
356        bfd     *abfd,
357        PTR     ext,
358        PTR     in));
359  void (*_bfd_coff_swap_aouthdr_in) PARAMS ((
360        bfd     *abfd,
361        PTR     ext,
362        PTR     in));
363  void (*_bfd_coff_swap_scnhdr_in) PARAMS ((
364        bfd     *abfd,
365        PTR     ext,
366        PTR     in));
367  void (*_bfd_coff_swap_reloc_in) PARAMS ((
368        bfd     *abfd,
369        PTR     ext,
370        PTR     in));
371  boolean (*_bfd_coff_bad_format_hook) PARAMS ((
372        bfd     *abfd,
373        PTR     internal_filehdr));
374  boolean (*_bfd_coff_set_arch_mach_hook) PARAMS ((
375        bfd     *abfd,
376        PTR     internal_filehdr));
377  PTR (*_bfd_coff_mkobject_hook) PARAMS ((
378        bfd     *abfd,
379        PTR     internal_filehdr,
380        PTR     internal_aouthdr));
381  flagword (*_bfd_styp_to_sec_flags_hook) PARAMS ((
382        bfd     *abfd,
383        PTR     internal_scnhdr,
384        const char *name));
385  asection *(*_bfd_make_section_hook) PARAMS ((
386        bfd     *abfd,
387        char    *name));
388  void (*_bfd_set_alignment_hook) PARAMS ((
389        bfd     *abfd,
390        asection *sec,
391        PTR     internal_scnhdr));
392  boolean (*_bfd_coff_slurp_symbol_table) PARAMS ((
393        bfd     *abfd));
394  boolean (*_bfd_coff_symname_in_debug) PARAMS ((
395        bfd     *abfd,
396        struct internal_syment *sym));
397  void (*_bfd_coff_reloc16_extra_cases) PARAMS ((
398        bfd     *abfd,
399        struct bfd_link_info *link_info,
400        struct bfd_link_order *link_order,
401        arelent *reloc,
402        bfd_byte *data,
403        unsigned int *src_ptr,
404        unsigned int *dst_ptr));
405  int (*_bfd_coff_reloc16_estimate) PARAMS ((
406        bfd *abfd,
407        asection *input_section,
408        arelent *r,
409        unsigned int shrink,
410        struct bfd_link_info *link_info));
411  boolean (*_bfd_coff_sym_is_global) PARAMS ((
412        bfd *abfd,
413        struct internal_syment *));
414  void (*_bfd_coff_compute_section_file_positions) PARAMS ((
415        bfd *abfd));
416  boolean (*_bfd_coff_relocate_section) PARAMS ((
417        bfd *output_bfd,
418        struct bfd_link_info *info,
419        bfd *input_bfd,
420        asection *input_section,
421        bfd_byte *contents,
422        struct internal_reloc *relocs,
423        struct internal_syment *syms,
424        asection **sections));
425  reloc_howto_type *(*_bfd_coff_rtype_to_howto) PARAMS ((
426        bfd *abfd,
427        asection *sec,
428        struct internal_reloc *rel,
429        struct coff_link_hash_entry *h,
430        struct internal_syment *sym,
431        bfd_vma *addendp));
432  boolean (*_bfd_coff_adjust_symndx) PARAMS ((
433        bfd *obfd,
434        struct bfd_link_info *info,
435        bfd *ibfd,
436        asection *sec,
437        struct internal_reloc *reloc,
438        boolean *adjustedp));
439
440 } bfd_coff_backend_data;
441
442 #define coff_backend_info(abfd) ((bfd_coff_backend_data *) (abfd)->xvec->backend_data)
443
444 #define bfd_coff_swap_aux_in(a,e,t,c,ind,num,i) \
445         ((coff_backend_info (a)->_bfd_coff_swap_aux_in) (a,e,t,c,ind,num,i))
446
447 #define bfd_coff_swap_sym_in(a,e,i) \
448         ((coff_backend_info (a)->_bfd_coff_swap_sym_in) (a,e,i))
449
450 #define bfd_coff_swap_lineno_in(a,e,i) \
451         ((coff_backend_info ( a)->_bfd_coff_swap_lineno_in) (a,e,i))
452
453 #define bfd_coff_swap_reloc_out(abfd, i, o) \
454         ((coff_backend_info (abfd)->_bfd_coff_swap_reloc_out) (abfd, i, o))
455
456 #define bfd_coff_swap_lineno_out(abfd, i, o) \
457         ((coff_backend_info (abfd)->_bfd_coff_swap_lineno_out) (abfd, i, o))
458
459 #define bfd_coff_swap_aux_out(a,i,t,c,ind,num,o) \
460         ((coff_backend_info (a)->_bfd_coff_swap_aux_out) (a,i,t,c,ind,num,o))
461
462 #define bfd_coff_swap_sym_out(abfd, i,o) \
463         ((coff_backend_info (abfd)->_bfd_coff_swap_sym_out) (abfd, i, o))
464
465 #define bfd_coff_swap_scnhdr_out(abfd, i,o) \
466         ((coff_backend_info (abfd)->_bfd_coff_swap_scnhdr_out) (abfd, i, o))
467
468 #define bfd_coff_swap_filehdr_out(abfd, i,o) \
469         ((coff_backend_info (abfd)->_bfd_coff_swap_filehdr_out) (abfd, i, o))
470
471 #define bfd_coff_swap_aouthdr_out(abfd, i,o) \
472         ((coff_backend_info (abfd)->_bfd_coff_swap_aouthdr_out) (abfd, i, o))
473
474 #define bfd_coff_filhsz(abfd) (coff_backend_info (abfd)->_bfd_filhsz)
475 #define bfd_coff_aoutsz(abfd) (coff_backend_info (abfd)->_bfd_aoutsz)
476 #define bfd_coff_scnhsz(abfd) (coff_backend_info (abfd)->_bfd_scnhsz)
477 #define bfd_coff_symesz(abfd) (coff_backend_info (abfd)->_bfd_symesz)
478 #define bfd_coff_auxesz(abfd) (coff_backend_info (abfd)->_bfd_auxesz)
479 #define bfd_coff_relsz(abfd)  (coff_backend_info (abfd)->_bfd_relsz)
480 #define bfd_coff_linesz(abfd) (coff_backend_info (abfd)->_bfd_linesz)
481 #define bfd_coff_long_filenames(abfd) (coff_backend_info (abfd)->_bfd_coff_long_filenames)
482 #define bfd_coff_swap_filehdr_in(abfd, i,o) \
483         ((coff_backend_info (abfd)->_bfd_coff_swap_filehdr_in) (abfd, i, o))
484
485 #define bfd_coff_swap_aouthdr_in(abfd, i,o) \
486         ((coff_backend_info (abfd)->_bfd_coff_swap_aouthdr_in) (abfd, i, o))
487
488 #define bfd_coff_swap_scnhdr_in(abfd, i,o) \
489         ((coff_backend_info (abfd)->_bfd_coff_swap_scnhdr_in) (abfd, i, o))
490
491 #define bfd_coff_swap_reloc_in(abfd, i, o) \
492         ((coff_backend_info (abfd)->_bfd_coff_swap_reloc_in) (abfd, i, o))
493
494 #define bfd_coff_bad_format_hook(abfd, filehdr) \
495         ((coff_backend_info (abfd)->_bfd_coff_bad_format_hook) (abfd, filehdr))
496
497 #define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
498         ((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
499 #define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
500         ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook) (abfd, filehdr, aouthdr))
501
502 #define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name)\
503         ((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook) (abfd, scnhdr, name))
504
505 #define bfd_coff_make_section_hook(abfd, name)\
506         ((coff_backend_info (abfd)->_bfd_make_section_hook) (abfd, name))
507
508 #define bfd_coff_set_alignment_hook(abfd, sec, scnhdr)\
509         ((coff_backend_info (abfd)->_bfd_set_alignment_hook) (abfd, sec, scnhdr))
510
511 #define bfd_coff_slurp_symbol_table(abfd)\
512         ((coff_backend_info (abfd)->_bfd_coff_slurp_symbol_table) (abfd))
513
514 #define bfd_coff_symname_in_debug(abfd, sym)\
515         ((coff_backend_info (abfd)->_bfd_coff_symname_in_debug) (abfd, sym))
516
517 #define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr)\
518         ((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
519          (abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
520
521 #define bfd_coff_reloc16_estimate(abfd, section, reloc, shrink, link_info)\
522         ((coff_backend_info (abfd)->_bfd_coff_reloc16_estimate)\
523          (abfd, section, reloc, shrink, link_info))
524
525 #define bfd_coff_sym_is_global(abfd, sym)\
526         ((coff_backend_info (abfd)->_bfd_coff_sym_is_global)\
527          (abfd, sym))
528
529 #define bfd_coff_compute_section_file_positions(abfd)\
530         ((coff_backend_info (abfd)->_bfd_coff_compute_section_file_positions)\
531          (abfd))
532
533 #define bfd_coff_relocate_section(obfd,info,ibfd,o,con,rel,isyms,secs)\
534         ((coff_backend_info (ibfd)->_bfd_coff_relocate_section)\
535          (obfd, info, ibfd, o, con, rel, isyms, secs))
536 #define bfd_coff_rtype_to_howto(abfd, sec, rel, h, sym, addendp)\
537         ((coff_backend_info (abfd)->_bfd_coff_rtype_to_howto)\
538          (abfd, sec, rel, h, sym, addendp))
539 #define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
540         ((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
541          (obfd, info, ibfd, sec, rel, adjustedp))
542