Update the FSF address in the copyright/GPL notice
[external/binutils.git] / bfd / libecoff.h
1 /* BFD ECOFF object file private structure.
2    Copyright 1993, 1994, 1995, 1996, 1999, 2001, 2002, 2003, 2004,
3    2005 Free Software Foundation, Inc.
4    Written by Ian Lance Taylor, Cygnus Support.
5
6    This file is part of BFD, the Binary File Descriptor library.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02110-1301, USA.  */
21
22 #include "bfdlink.h"
23
24 #ifndef ECOFF_H
25 #include "coff/ecoff.h"
26 #endif
27
28 /* This is the backend information kept for ECOFF files.  This
29    structure is constant for a particular backend.  The first element
30    is the COFF backend data structure, so that ECOFF targets can use
31    the generic COFF code.  */
32
33 #define ecoff_backend(abfd) \
34   ((struct ecoff_backend_data *) (abfd)->xvec->backend_data)
35
36 struct ecoff_backend_data
37 {
38   /* COFF backend information.  This must be the first field.  */
39   bfd_coff_backend_data coff;
40   /* Supported architecture.  */
41   enum bfd_architecture arch;
42   /* Initial portion of armap string.  */
43   const char *armap_start;
44   /* The page boundary used to align sections in a demand-paged
45      executable file.  E.g., 0x1000.  */
46   bfd_vma round;
47   /* TRUE if the .rdata section is part of the text segment, as on the
48      Alpha.  FALSE if .rdata is part of the data segment, as on the
49      MIPS.  */
50   bfd_boolean rdata_in_text;
51   /* Bitsize of constructor entries.  */
52   unsigned int constructor_bitsize;
53   /* Reloc to use for constructor entries.  */
54   reloc_howto_type *constructor_reloc;
55   /* How to swap debugging information.  */
56   struct ecoff_debug_swap debug_swap;
57   /* External reloc size.  */
58   bfd_size_type external_reloc_size;
59   /* Reloc swapping functions.  */
60   void (*swap_reloc_in) (bfd *, void *, struct internal_reloc *);
61   void (*swap_reloc_out) (bfd *, const struct internal_reloc *, void *);
62   /* Backend reloc tweaking.  */
63   void (*adjust_reloc_in)
64     (bfd *, const struct internal_reloc *, arelent *);
65   void (*adjust_reloc_out)
66     (bfd *, const arelent *, struct internal_reloc *);
67   /* Relocate section contents while linking.  */
68   bfd_boolean (*relocate_section)
69     (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *, void *);
70   /* Do final adjustments to filehdr and aouthdr.  */
71   bfd_boolean (*adjust_headers)
72     (bfd *, struct internal_filehdr *, struct internal_aouthdr *);
73   /* Read an element from an archive at a given file position.  This
74      is needed because OSF/1 3.2 uses a weird archive format.  */
75   bfd *(*get_elt_at_filepos) (bfd *, file_ptr);
76 };
77
78 /* This is the target specific information kept for ECOFF files.  */
79
80 #define ecoff_data(abfd) ((abfd)->tdata.ecoff_obj_data)
81
82 typedef struct ecoff_tdata
83 {
84   /* The reloc file position, set by
85      ecoff_compute_section_file_positions.  */
86   file_ptr reloc_filepos;
87
88   /* The symbol table file position, set by _bfd_ecoff_mkobject_hook.  */
89   file_ptr sym_filepos;
90
91   /* The start and end of the text segment.  Only valid for an
92      existing file, not for one we are creating.  */
93   unsigned long text_start;
94   unsigned long text_end;
95
96   /* The cached gp value.  This is used when relocating.  */
97   bfd_vma gp;
98
99   /* The maximum size of objects to optimize using gp.  This is
100      typically set by the -G option to the compiler, assembler or
101      linker.  */
102   unsigned int gp_size;
103
104   /* The register masks.  When linking, all the masks found in the
105      input files are combined into the masks of the output file.
106      These are not all used for all targets, but that's OK, because
107      the relevant ones are the only ones swapped in and out.  */
108   unsigned long gprmask;
109   unsigned long fprmask;
110   unsigned long cprmask[4];
111
112   /* The ECOFF symbolic debugging information.  */
113   struct ecoff_debug_info debug_info;
114
115   /* The unswapped ECOFF symbolic information.  */
116   void * raw_syments;
117
118   /* The canonical BFD symbols.  */
119   struct ecoff_symbol_struct *canonical_symbols;
120
121   /* A mapping from external symbol numbers to entries in the linker
122      hash table, used when linking.  */
123   struct ecoff_link_hash_entry **sym_hashes;
124
125   /* A mapping from reloc symbol indices to sections, used when
126      linking.  */
127   asection **symndx_to_section;
128
129   /* TRUE if this BFD was written by the backend linker.  */
130   bfd_boolean linker;
131
132   /* TRUE if a warning that multiple global pointer values are
133      needed in the output binary was issued already.  */
134   bfd_boolean issued_multiple_gp_warning;
135
136   /* Used by find_nearest_line entry point.  The structure could be
137      included directly in this one, but there's no point to wasting
138      the memory just for the infrequently called find_nearest_line.  */
139   struct ecoff_find_line *find_line_info;
140
141   /* Whether the .rdata section is in the text segment for this
142      particular ECOFF file.  This is not valid until
143      ecoff_compute_section_file_positions is called.  */
144   bfd_boolean rdata_in_text;
145
146 } ecoff_data_type;
147
148 /* Each canonical asymbol really looks like this.  */
149
150 typedef struct ecoff_symbol_struct
151 {
152   /* The actual symbol which the rest of BFD works with */
153   asymbol symbol;
154
155   /* The fdr for this symbol.  */
156   FDR *fdr;
157
158   /* TRUE if this is a local symbol rather than an external one.  */
159   bfd_boolean local;
160
161   /* A pointer to the unswapped hidden information for this symbol.
162      This is either a struct sym_ext or a struct ext_ext, depending on
163      the value of the local field above.  */
164   void * native;
165 } ecoff_symbol_type;
166
167 /* We take the address of the first element of an asymbol to ensure that the
168    macro is only ever applied to an asymbol.  */
169 #define ecoffsymbol(asymbol) ((ecoff_symbol_type *) (&((asymbol)->the_bfd)))
170
171 /* We need to save the index of an external symbol when we write it
172    out so that can set the symbol index correctly when we write out
173    the relocs.  */
174 #define ecoff_get_sym_index(symbol) ((symbol)->udata.i)
175 #define ecoff_set_sym_index(symbol, idx) ((symbol)->udata.i = (idx))
176
177 /* A pointer to this structure is put in the used_by_bfd pointer of
178    a section to keep track of any per-section data.
179    The user_by_bfd pointer will be NULL if the information was not
180    needed.  */
181
182 struct ecoff_section_tdata
183 {
184   /* When producing an executable (i.e., final, non-relocatable link)
185      on the Alpha, we may need to use multiple global pointer values
186      to span the entire .lita section.  In essence, we allow each
187      input .lita section to have its own gp value.  To support this,
188      we need to keep track of the gp values that we picked for each
189      input .lita section . */
190   bfd_vma gp;
191 };
192
193 /* An accessor macro for the ecoff_section_tdata structure.  */
194 #define ecoff_section_data(abfd, sec) \
195   ((struct ecoff_section_tdata *) (sec)->used_by_bfd)
196
197 /* ECOFF linker hash table entries.  */
198
199 struct ecoff_link_hash_entry
200 {
201   struct bfd_link_hash_entry root;
202   /* Symbol index in output file.  */
203   long indx;
204   /* BFD that ext field value came from.  */
205   bfd *abfd;
206   /* ECOFF external symbol information.  */
207   EXTR esym;
208   /* Nonzero if this symbol has been written out.  */
209   char written;
210   /* Nonzero if this symbol was referred to as small undefined.  */
211   char small;
212 };
213
214 /* ECOFF linker hash table.  */
215
216 struct ecoff_link_hash_table
217 {
218   struct bfd_link_hash_table root;
219 };
220
221 /* Make an ECOFF object.  */
222 extern bfd_boolean _bfd_ecoff_mkobject (bfd *);
223
224 /* Read in the ECOFF symbolic debugging information.  */
225 extern bfd_boolean _bfd_ecoff_slurp_symbolic_info
226   (bfd *, asection *, struct ecoff_debug_info *);
227
228 /* Generic ECOFF BFD backend vectors.  */
229
230 extern bfd_boolean _bfd_ecoff_write_object_contents (bfd *);
231 extern const bfd_target *_bfd_ecoff_archive_p (bfd *);
232
233 #define _bfd_ecoff_close_and_cleanup _bfd_generic_close_and_cleanup
234 #define _bfd_ecoff_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
235 extern bfd_boolean _bfd_ecoff_new_section_hook
236   (bfd *, asection *);
237 extern bfd_boolean _bfd_ecoff_get_section_contents
238   (bfd *, asection *, void * location, file_ptr, bfd_size_type);
239
240 #define _bfd_ecoff_bfd_link_split_section _bfd_generic_link_split_section
241
242 extern bfd_boolean _bfd_ecoff_bfd_copy_private_bfd_data
243   (bfd *, bfd *);
244 #define _bfd_ecoff_bfd_copy_private_section_data \
245   _bfd_generic_bfd_copy_private_section_data
246
247 #define _bfd_ecoff_bfd_copy_private_symbol_data \
248   _bfd_generic_bfd_copy_private_symbol_data
249
250 #define _bfd_ecoff_bfd_copy_private_header_data \
251   _bfd_generic_bfd_copy_private_header_data
252
253 #define _bfd_ecoff_bfd_print_private_bfd_data \
254   _bfd_generic_bfd_print_private_bfd_data
255
256 #define _bfd_ecoff_bfd_merge_private_bfd_data \
257   _bfd_generic_bfd_merge_private_bfd_data
258
259 #define _bfd_ecoff_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
260 extern bfd_boolean _bfd_ecoff_slurp_armap (bfd *);
261 #define _bfd_ecoff_slurp_extended_name_table _bfd_slurp_extended_name_table
262 #define _bfd_ecoff_construct_extended_name_table \
263   _bfd_archive_bsd_construct_extended_name_table
264 #define _bfd_ecoff_truncate_arname bfd_dont_truncate_arname
265 extern bfd_boolean _bfd_ecoff_write_armap
266   (bfd *, unsigned int, struct orl *, unsigned int, int);
267 #define _bfd_ecoff_read_ar_hdr _bfd_generic_read_ar_hdr
268 #define _bfd_ecoff_openr_next_archived_file \
269   bfd_generic_openr_next_archived_file
270 #define _bfd_ecoff_get_elt_at_index _bfd_generic_get_elt_at_index
271 #define _bfd_ecoff_generic_stat_arch_elt bfd_generic_stat_arch_elt
272 #define _bfd_ecoff_update_armap_timestamp bfd_true
273 #define _bfd_ecoff_bfd_is_target_special_symbol  \
274   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
275
276 extern long _bfd_ecoff_get_symtab_upper_bound (bfd *);
277 extern long _bfd_ecoff_canonicalize_symtab (bfd *, asymbol **);
278 extern asymbol *_bfd_ecoff_make_empty_symbol (bfd *);
279 extern void _bfd_ecoff_print_symbol
280   (bfd *, void *, asymbol *, bfd_print_symbol_type);
281 extern void _bfd_ecoff_get_symbol_info
282   (bfd *, asymbol *, symbol_info *);
283 extern bfd_boolean _bfd_ecoff_bfd_is_local_label_name
284   (bfd *, const char *);
285 #define _bfd_ecoff_get_lineno _bfd_nosymbols_get_lineno
286 extern bfd_boolean _bfd_ecoff_find_nearest_line
287   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
288    unsigned int *);
289 #define _bfd_ecoff_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
290 #define _bfd_ecoff_read_minisymbols _bfd_generic_read_minisymbols
291 #define _bfd_ecoff_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
292
293 #define _bfd_ecoff_get_reloc_upper_bound coff_get_reloc_upper_bound
294 extern long _bfd_ecoff_canonicalize_reloc
295   (bfd *, asection *, arelent **, asymbol **symbols);
296 /* ecoff_bfd_reloc_type_lookup defined by backend. */
297
298 extern bfd_boolean _bfd_ecoff_set_arch_mach
299   (bfd *, enum bfd_architecture, unsigned long);
300 extern bfd_boolean _bfd_ecoff_set_section_contents
301   (bfd *, asection *, const void * location, file_ptr, bfd_size_type);
302
303 extern int _bfd_ecoff_sizeof_headers (bfd *, bfd_boolean);
304 /* ecoff_bfd_get_relocated_section_contents defined by backend.  */
305 /* ecoff_bfd_relax_section defined by backend.  */
306 extern struct bfd_link_hash_table *_bfd_ecoff_bfd_link_hash_table_create
307   (bfd *);
308 #define _bfd_ecoff_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
309 extern bfd_boolean _bfd_ecoff_bfd_link_add_symbols
310   (bfd *, struct bfd_link_info *);
311 #define _bfd_ecoff_bfd_link_just_syms _bfd_generic_link_just_syms
312 extern bfd_boolean _bfd_ecoff_bfd_final_link
313   (bfd *, struct bfd_link_info *);
314
315 /* Hook functions for the generic COFF section reading code.  */
316
317 extern void * _bfd_ecoff_mkobject_hook (bfd *, void *, void *);
318 #define _bfd_ecoff_set_alignment_hook \
319   ((void (*) (bfd *, asection *, void *)) bfd_void)
320 extern bfd_boolean _bfd_ecoff_set_arch_mach_hook
321   (bfd *, void *);
322 extern bfd_boolean _bfd_ecoff_styp_to_sec_flags
323   (bfd *, void *, const char *, asection *, flagword *);
324 extern bfd_boolean _bfd_ecoff_slurp_symbol_table (bfd *);
325
326 /* ECOFF auxiliary information swapping routines.  These are the same
327    for all ECOFF targets, so they are defined in ecofflink.c.  */
328
329 extern void _bfd_ecoff_swap_tir_in
330   (int, const struct tir_ext *, TIR *);
331 extern void _bfd_ecoff_swap_tir_out
332   (int, const TIR *, struct tir_ext *);
333 extern void _bfd_ecoff_swap_rndx_in
334   (int, const struct rndx_ext *, RNDXR *);
335 extern void _bfd_ecoff_swap_rndx_out
336   (int, const RNDXR *, struct rndx_ext *);