Implement a new BFD API function: bfd_is_target_special_symbol. Use this in nm
[binutils.git] / bfd / libecoff.h
blob495be6363851e9596d6c52d49e1887d994a92c67
1 /* BFD ECOFF object file private structure.
2 Copyright 1993, 1994, 1995, 1996, 1999, 2001, 2002, 2003, 2004
3 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor, Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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 02111-1307, USA. */
22 #include "bfdlink.h"
24 #ifndef ECOFF_H
25 #include "coff/ecoff.h"
26 #endif
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. */
33 #define ecoff_backend(abfd) \
34 ((struct ecoff_backend_data *) (abfd)->xvec->backend_data)
36 struct ecoff_backend_data
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) PARAMS ((bfd *, PTR, struct internal_reloc *));
61 void (*swap_reloc_out) PARAMS ((bfd *, const struct internal_reloc *, PTR));
62 /* Backend reloc tweaking. */
63 void (*adjust_reloc_in)
64 PARAMS ((bfd *, const struct internal_reloc *, arelent *));
65 void (*adjust_reloc_out)
66 PARAMS ((bfd *, const arelent *, struct internal_reloc *));
67 /* Relocate section contents while linking. */
68 bfd_boolean (*relocate_section)
69 PARAMS ((bfd *output_bfd, struct bfd_link_info *, bfd *input_bfd,
70 asection *input_section, bfd_byte *contents,
71 PTR external_relocs));
72 /* Do final adjustments to filehdr and aouthdr. */
73 bfd_boolean (*adjust_headers)
74 PARAMS ((bfd *, struct internal_filehdr *, struct internal_aouthdr *));
75 /* Read an element from an archive at a given file position. This
76 is needed because OSF/1 3.2 uses a weird archive format. */
77 bfd *(*get_elt_at_filepos) PARAMS ((bfd *, file_ptr));
80 /* This is the target specific information kept for ECOFF files. */
82 #define ecoff_data(abfd) ((abfd)->tdata.ecoff_obj_data)
84 typedef struct ecoff_tdata
86 /* The reloc file position, set by
87 ecoff_compute_section_file_positions. */
88 file_ptr reloc_filepos;
90 /* The symbol table file position, set by _bfd_ecoff_mkobject_hook. */
91 file_ptr sym_filepos;
93 /* The start and end of the text segment. Only valid for an
94 existing file, not for one we are creating. */
95 unsigned long text_start;
96 unsigned long text_end;
98 /* The cached gp value. This is used when relocating. */
99 bfd_vma gp;
101 /* The maximum size of objects to optimize using gp. This is
102 typically set by the -G option to the compiler, assembler or
103 linker. */
104 unsigned int gp_size;
106 /* The register masks. When linking, all the masks found in the
107 input files are combined into the masks of the output file.
108 These are not all used for all targets, but that's OK, because
109 the relevant ones are the only ones swapped in and out. */
110 unsigned long gprmask;
111 unsigned long fprmask;
112 unsigned long cprmask[4];
114 /* The ECOFF symbolic debugging information. */
115 struct ecoff_debug_info debug_info;
117 /* The unswapped ECOFF symbolic information. */
118 PTR raw_syments;
120 /* The canonical BFD symbols. */
121 struct ecoff_symbol_struct *canonical_symbols;
123 /* A mapping from external symbol numbers to entries in the linker
124 hash table, used when linking. */
125 struct ecoff_link_hash_entry **sym_hashes;
127 /* A mapping from reloc symbol indices to sections, used when
128 linking. */
129 asection **symndx_to_section;
131 /* TRUE if this BFD was written by the backend linker. */
132 bfd_boolean linker;
134 /* TRUE if a warning that multiple global pointer values are
135 needed in the output binary was issued already. */
136 bfd_boolean issued_multiple_gp_warning;
138 /* Used by find_nearest_line entry point. The structure could be
139 included directly in this one, but there's no point to wasting
140 the memory just for the infrequently called find_nearest_line. */
141 struct ecoff_find_line *find_line_info;
143 /* Whether the .rdata section is in the text segment for this
144 particular ECOFF file. This is not valid until
145 ecoff_compute_section_file_positions is called. */
146 bfd_boolean rdata_in_text;
148 } ecoff_data_type;
150 /* Each canonical asymbol really looks like this. */
152 typedef struct ecoff_symbol_struct
154 /* The actual symbol which the rest of BFD works with */
155 asymbol symbol;
157 /* The fdr for this symbol. */
158 FDR *fdr;
160 /* TRUE if this is a local symbol rather than an external one. */
161 bfd_boolean local;
163 /* A pointer to the unswapped hidden information for this symbol.
164 This is either a struct sym_ext or a struct ext_ext, depending on
165 the value of the local field above. */
166 PTR native;
167 } ecoff_symbol_type;
169 /* We take the address of the first element of an asymbol to ensure that the
170 macro is only ever applied to an asymbol. */
171 #define ecoffsymbol(asymbol) ((ecoff_symbol_type *) (&((asymbol)->the_bfd)))
173 /* We need to save the index of an external symbol when we write it
174 out so that can set the symbol index correctly when we write out
175 the relocs. */
176 #define ecoff_get_sym_index(symbol) ((symbol)->udata.i)
177 #define ecoff_set_sym_index(symbol, idx) ((symbol)->udata.i = (idx))
179 /* A pointer to this structure is put in the used_by_bfd pointer of
180 a section to keep track of any per-section data.
181 The user_by_bfd pointer will be NULL if the information was not
182 needed. */
184 struct ecoff_section_tdata
186 /* When producing an executable (i.e., final, non-relocatable link)
187 on the Alpha, we may need to use multiple global pointer values
188 to span the entire .lita section. In essence, we allow each
189 input .lita section to have its own gp value. To support this,
190 we need to keep track of the gp values that we picked for each
191 input .lita section . */
192 bfd_vma gp;
195 /* An accessor macro for the ecoff_section_tdata structure. */
196 #define ecoff_section_data(abfd, sec) \
197 ((struct ecoff_section_tdata *) (sec)->used_by_bfd)
199 /* ECOFF linker hash table entries. */
201 struct ecoff_link_hash_entry
203 struct bfd_link_hash_entry root;
204 /* Symbol index in output file. */
205 long indx;
206 /* BFD that ext field value came from. */
207 bfd *abfd;
208 /* ECOFF external symbol information. */
209 EXTR esym;
210 /* Nonzero if this symbol has been written out. */
211 char written;
212 /* Nonzero if this symbol was referred to as small undefined. */
213 char small;
216 /* ECOFF linker hash table. */
218 struct ecoff_link_hash_table
220 struct bfd_link_hash_table root;
223 /* Make an ECOFF object. */
224 extern bfd_boolean _bfd_ecoff_mkobject PARAMS ((bfd *));
226 /* Read in the ECOFF symbolic debugging information. */
227 extern bfd_boolean _bfd_ecoff_slurp_symbolic_info
228 PARAMS ((bfd *, asection *, struct ecoff_debug_info *));
230 /* Generic ECOFF BFD backend vectors. */
232 extern bfd_boolean _bfd_ecoff_write_object_contents PARAMS ((bfd *abfd));
233 extern const bfd_target *_bfd_ecoff_archive_p PARAMS ((bfd *abfd));
235 #define _bfd_ecoff_close_and_cleanup _bfd_generic_close_and_cleanup
236 #define _bfd_ecoff_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
237 extern bfd_boolean _bfd_ecoff_new_section_hook
238 PARAMS ((bfd *, asection *));
239 extern bfd_boolean _bfd_ecoff_get_section_contents
240 PARAMS ((bfd *, asection *, PTR location, file_ptr, bfd_size_type));
242 #define _bfd_ecoff_bfd_link_split_section _bfd_generic_link_split_section
244 extern bfd_boolean _bfd_ecoff_bfd_copy_private_bfd_data
245 PARAMS ((bfd *, bfd *));
246 #define _bfd_ecoff_bfd_copy_private_section_data \
247 _bfd_generic_bfd_copy_private_section_data
249 #define _bfd_ecoff_bfd_copy_private_symbol_data \
250 _bfd_generic_bfd_copy_private_symbol_data
252 #define _bfd_ecoff_bfd_copy_private_header_data \
253 _bfd_generic_bfd_copy_private_header_data
255 #define _bfd_ecoff_bfd_print_private_bfd_data \
256 _bfd_generic_bfd_print_private_bfd_data
258 #define _bfd_ecoff_bfd_merge_private_bfd_data \
259 _bfd_generic_bfd_merge_private_bfd_data
261 #define _bfd_ecoff_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
262 extern bfd_boolean _bfd_ecoff_slurp_armap PARAMS ((bfd *abfd));
263 #define _bfd_ecoff_slurp_extended_name_table _bfd_slurp_extended_name_table
264 #define _bfd_ecoff_construct_extended_name_table \
265 _bfd_archive_bsd_construct_extended_name_table
266 #define _bfd_ecoff_truncate_arname bfd_dont_truncate_arname
267 extern bfd_boolean _bfd_ecoff_write_armap
268 PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int));
269 #define _bfd_ecoff_read_ar_hdr _bfd_generic_read_ar_hdr
270 #define _bfd_ecoff_openr_next_archived_file \
271 bfd_generic_openr_next_archived_file
272 #define _bfd_ecoff_get_elt_at_index _bfd_generic_get_elt_at_index
273 #define _bfd_ecoff_generic_stat_arch_elt bfd_generic_stat_arch_elt
274 #define _bfd_ecoff_update_armap_timestamp bfd_true
275 #define _bfd_ecoff_bfd_is_target_special_symbol \
276 ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
278 extern long _bfd_ecoff_get_symtab_upper_bound PARAMS ((bfd *abfd));
279 extern long _bfd_ecoff_canonicalize_symtab PARAMS ((bfd *abfd, asymbol **alocation));
280 extern asymbol *_bfd_ecoff_make_empty_symbol PARAMS ((bfd *abfd));
281 extern void _bfd_ecoff_print_symbol
282 PARAMS ((bfd *, PTR filep, asymbol *, bfd_print_symbol_type));
283 extern void _bfd_ecoff_get_symbol_info
284 PARAMS ((bfd *, asymbol *, symbol_info *));
285 extern bfd_boolean _bfd_ecoff_bfd_is_local_label_name
286 PARAMS ((bfd *, const char *));
287 #define _bfd_ecoff_get_lineno _bfd_nosymbols_get_lineno
288 extern bfd_boolean _bfd_ecoff_find_nearest_line
289 PARAMS ((bfd *, asection *, asymbol **, bfd_vma offset,
290 const char **filename_ptr, const char **fnname_ptr,
291 unsigned int *retline_ptr));
292 #define _bfd_ecoff_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
293 #define _bfd_ecoff_read_minisymbols _bfd_generic_read_minisymbols
294 #define _bfd_ecoff_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
296 #define _bfd_ecoff_get_reloc_upper_bound coff_get_reloc_upper_bound
297 extern long _bfd_ecoff_canonicalize_reloc
298 PARAMS ((bfd *, asection *, arelent **, asymbol **symbols));
299 /* ecoff_bfd_reloc_type_lookup defined by backend. */
301 extern bfd_boolean _bfd_ecoff_set_arch_mach
302 PARAMS ((bfd *, enum bfd_architecture, unsigned long));
303 extern bfd_boolean _bfd_ecoff_set_section_contents
304 PARAMS ((bfd *, asection *, const PTR location, file_ptr, bfd_size_type));
306 extern int _bfd_ecoff_sizeof_headers PARAMS ((bfd *abfd, bfd_boolean reloc));
307 /* ecoff_bfd_get_relocated_section_contents defined by backend. */
308 /* ecoff_bfd_relax_section defined by backend. */
309 extern struct bfd_link_hash_table *_bfd_ecoff_bfd_link_hash_table_create
310 PARAMS ((bfd *));
311 #define _bfd_ecoff_bfd_link_hash_table_free _bfd_generic_link_hash_table_free
312 extern bfd_boolean _bfd_ecoff_bfd_link_add_symbols
313 PARAMS ((bfd *, struct bfd_link_info *));
314 #define _bfd_ecoff_bfd_link_just_syms _bfd_generic_link_just_syms
315 extern bfd_boolean _bfd_ecoff_bfd_final_link
316 PARAMS ((bfd *, struct bfd_link_info *));
318 /* Hook functions for the generic COFF section reading code. */
320 extern PTR _bfd_ecoff_mkobject_hook PARAMS ((bfd *, PTR filehdr, PTR aouthdr));
321 #define _bfd_ecoff_set_alignment_hook \
322 ((void (*) PARAMS ((bfd *, asection *, PTR))) bfd_void)
323 extern bfd_boolean _bfd_ecoff_set_arch_mach_hook
324 PARAMS ((bfd *abfd, PTR filehdr));
325 extern bfd_boolean _bfd_ecoff_styp_to_sec_flags
326 PARAMS ((bfd *, PTR, const char *, asection *, flagword *));
327 extern bfd_boolean _bfd_ecoff_slurp_symbol_table PARAMS ((bfd *abfd));
329 /* ECOFF auxiliary information swapping routines. These are the same
330 for all ECOFF targets, so they are defined in ecofflink.c. */
332 extern void _bfd_ecoff_swap_tir_in
333 PARAMS ((int, const struct tir_ext *, TIR *));
334 extern void _bfd_ecoff_swap_tir_out
335 PARAMS ((int, const TIR *, struct tir_ext *));
336 extern void _bfd_ecoff_swap_rndx_in
337 PARAMS ((int, const struct rndx_ext *, RNDXR *));
338 extern void _bfd_ecoff_swap_rndx_out
339 PARAMS ((int, const RNDXR *, struct rndx_ext *));