1 /* BFD ECOFF object file private structure.
2 Copyright (C) 1993-2023 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor, 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 #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 bool 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 bool (*relocate_section)
69 (bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *, void *);
70 /* Do final adjustments to filehdr and aouthdr. */
71 bool (*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, struct bfd_link_info *);
76 };
77
78 /* ECOFF targets don't support COFF long section names, so this
79 macro is provided to use as an initialiser for the related
80 members of the embedded bfd_coff_backend_data struct. */
81 #define ECOFF_NO_LONG_SECTION_NAMES (false), _bfd_ecoff_no_long_sections
82
83 struct mips_hi
84 {
85 struct mips_hi *next;
86 bfd_byte *addr;
87 bfd_vma addend;
88 };
89
90 /* This is the target specific information kept for ECOFF files. */
91
92 #define ecoff_data(abfd) ((abfd)->tdata.ecoff_obj_data)
93
94 typedef struct ecoff_tdata
95 {
96 /* The reloc file position, set by
97 ecoff_compute_section_file_positions. */
98 file_ptr reloc_filepos;
99
100 /* The symbol table file position, set by _bfd_ecoff_mkobject_hook. */
101 file_ptr sym_filepos;
102
103 /* The start and end of the text segment. Only valid for an
104 existing file, not for one we are creating. */
105 unsigned long text_start;
106 unsigned long text_end;
107
108 /* The cached gp value. This is used when relocating. */
109 bfd_vma gp;
110
111 /* The maximum size of objects to optimize using gp. This is
112 typically set by the -G option to the compiler, assembler or
113 linker. */
114 unsigned int gp_size;
115
116 /* The register masks. When linking, all the masks found in the
117 input files are combined into the masks of the output file.
118 These are not all used for all targets, but that's OK, because
119 the relevant ones are the only ones swapped in and out. */
120 unsigned long gprmask;
121 unsigned long fprmask;
122 unsigned long cprmask[4];
123
124 /* The ECOFF symbolic debugging information. */
125 struct ecoff_debug_info debug_info;
126
127 /* The canonical BFD symbols. */
128 struct ecoff_symbol_struct *canonical_symbols;
129
130 /* A mapping from external symbol numbers to entries in the linker
131 hash table, used when linking. */
132 struct ecoff_link_hash_entry **sym_hashes;
133
134 /* A mapping from reloc symbol indices to sections, used when
135 linking. */
136 asection **symndx_to_section;
137
138 /* TRUE if this BFD was written by the backend linker. */
139 bool linker;
140
141 /* TRUE if a warning that multiple global pointer values are
142 needed in the output binary was issued already. */
143 bool issued_multiple_gp_warning;
144
145 /* Used by find_nearest_line entry point. The structure could be
146 included directly in this one, but there's no point to wasting
147 the memory just for the infrequently called find_nearest_line. */
148 struct ecoff_find_line *find_line_info;
149
150 /* Whether the .rdata section is in the text segment for this
151 particular ECOFF file. This is not valid until
152 ecoff_compute_section_file_positions is called. */
153 bool rdata_in_text;
154
155 /* Used by coff-mips.c to track REFHI relocs for pairing with REFLO. */
156 struct mips_hi *mips_refhi_list;
157 } ecoff_data_type;
158
159 /* Each canonical asymbol really looks like this. */
160
161 typedef struct ecoff_symbol_struct
162 {
163 /* The actual symbol which the rest of BFD works with */
164 asymbol symbol;
165
166 /* The fdr for this symbol. */
167 FDR *fdr;
168
169 /* TRUE if this is a local symbol rather than an external one. */
170 bool local;
171
172 /* A pointer to the unswapped hidden information for this symbol.
173 This is either a struct sym_ext or a struct ext_ext, depending on
174 the value of the local field above. */
175 void * native;
176 } ecoff_symbol_type;
177
178 /* We take the address of the first element of an asymbol to ensure that the
179 macro is only ever applied to an asymbol. */
180 #define ecoffsymbol(asymbol) ((ecoff_symbol_type *) (&((asymbol)->the_bfd)))
181
182 /* We need to save the index of an external symbol when we write it
183 out so that can set the symbol index correctly when we write out
184 the relocs. */
185 #define ecoff_get_sym_index(symbol) ((symbol)->udata.i)
186 #define ecoff_set_sym_index(symbol, idx) ((symbol)->udata.i = (idx))
187
188 /* A pointer to this structure is put in the used_by_bfd pointer of
189 a section to keep track of any per-section data.
190 The user_by_bfd pointer will be NULL if the information was not
191 needed. */
192
193 struct ecoff_section_tdata
194 {
195 /* When producing an executable (i.e., final, non-relocatable link)
196 on the Alpha, we may need to use multiple global pointer values
197 to span the entire .lita section. In essence, we allow each
198 input .lita section to have its own gp value. To support this,
199 we need to keep track of the gp values that we picked for each
200 input .lita section . */
201 bfd_vma gp;
202 };
203
204 /* An accessor macro for the ecoff_section_tdata structure. */
205 #define ecoff_section_data(abfd, sec) \
206 ((struct ecoff_section_tdata *) (sec)->used_by_bfd)
207
208 /* ECOFF linker hash table entries. */
209
210 struct ecoff_link_hash_entry
211 {
212 struct bfd_link_hash_entry root;
213 /* Symbol index in output file. */
214 long indx;
215 /* BFD that ext field value came from. */
216 bfd *abfd;
217 /* ECOFF external symbol information. */
218 EXTR esym;
219 /* Nonzero if this symbol has been written out. */
220 char written;
221 /* Nonzero if this symbol was referred to as small undefined. */
222 char small;
223 };
224
225 /* ECOFF linker hash table. */
226
227 struct ecoff_link_hash_table
228 {
229 struct bfd_link_hash_table root;
230 };
231
232 /* Make an ECOFF object. */
233 extern bool _bfd_ecoff_mkobject (bfd *);
234
235 /* Read in the ECOFF symbolic debugging information. */
236 extern bool _bfd_ecoff_slurp_symbolic_info
237 (bfd *, asection *, struct ecoff_debug_info *);
238
239 /* Generic ECOFF BFD backend vectors. */
240
241 extern bool _bfd_ecoff_write_object_contents (bfd *);
242
243 #define _bfd_ecoff_close_and_cleanup _bfd_generic_close_and_cleanup
244 extern bool _bfd_ecoff_bfd_free_cached_info (bfd *);
245 extern bool _bfd_ecoff_new_section_hook
246 (bfd *, asection *);
247 extern bool _bfd_ecoff_get_section_contents
248 (bfd *, asection *, void * location, file_ptr, bfd_size_type);
249
250 #define _bfd_ecoff_bfd_link_split_section _bfd_generic_link_split_section
251 #define _bfd_ecoff_bfd_link_check_relocs _bfd_generic_link_check_relocs
252
253 extern bool _bfd_ecoff_bfd_copy_private_bfd_data
254 (bfd *, bfd *);
255 #define _bfd_ecoff_bfd_copy_private_section_data \
256 _bfd_generic_bfd_copy_private_section_data
257
258 #define _bfd_ecoff_bfd_copy_private_symbol_data \
259 _bfd_generic_bfd_copy_private_symbol_data
260
261 #define _bfd_ecoff_bfd_copy_private_header_data \
262 _bfd_generic_bfd_copy_private_header_data
263
264 #define _bfd_ecoff_bfd_print_private_bfd_data \
265 _bfd_generic_bfd_print_private_bfd_data
266
267 #define _bfd_ecoff_bfd_merge_private_bfd_data \
268 _bfd_generic_bfd_merge_private_bfd_data
269
270 #define _bfd_ecoff_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
271 extern bool _bfd_ecoff_slurp_armap (bfd *);
272 #define _bfd_ecoff_slurp_extended_name_table _bfd_slurp_extended_name_table
273 #define _bfd_ecoff_construct_extended_name_table \
274 _bfd_archive_bsd_construct_extended_name_table
275 #define _bfd_ecoff_truncate_arname bfd_dont_truncate_arname
276 extern bool _bfd_ecoff_write_armap
277 (bfd *, unsigned int, struct orl *, unsigned int, int);
278 #define _bfd_ecoff_read_ar_hdr _bfd_generic_read_ar_hdr
279 #define _bfd_ecoff_write_ar_hdr _bfd_generic_write_ar_hdr
280 #define _bfd_ecoff_openr_next_archived_file \
281 bfd_generic_openr_next_archived_file
282 #define _bfd_ecoff_get_elt_at_index _bfd_generic_get_elt_at_index
283 #define _bfd_ecoff_generic_stat_arch_elt bfd_generic_stat_arch_elt
284 #define _bfd_ecoff_update_armap_timestamp _bfd_bool_bfd_true
285 #define _bfd_ecoff_bfd_is_target_special_symbol _bfd_bool_bfd_asymbol_false
286
287 extern long _bfd_ecoff_get_symtab_upper_bound (bfd *);
288 extern long _bfd_ecoff_canonicalize_symtab (bfd *, asymbol **);
289 extern asymbol *_bfd_ecoff_make_empty_symbol (bfd *);
290 extern void _bfd_ecoff_print_symbol
291 (bfd *, void *, asymbol *, bfd_print_symbol_type);
292 extern void _bfd_ecoff_get_symbol_info
293 (bfd *, asymbol *, symbol_info *);
294 #define _bfd_ecoff_get_symbol_version_string \
295 _bfd_nosymbols_get_symbol_version_string
296 extern bool _bfd_ecoff_bfd_is_local_label_name
297 (bfd *, const char *);
298 #define _bfd_ecoff_get_lineno _bfd_nosymbols_get_lineno
299 extern bool _bfd_ecoff_find_nearest_line
300 (bfd *, asymbol **, asection *, bfd_vma,
301 const char **, const char **, unsigned int *, unsigned int *);
302 #define _bfd_ecoff_find_nearest_line_with_alt \
303 _bfd_nosymbols_find_nearest_line_with_alt
304 #define _bfd_ecoff_find_line _bfd_nosymbols_find_line
305 #define _bfd_ecoff_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
306 #define _bfd_ecoff_read_minisymbols _bfd_generic_read_minisymbols
307 #define _bfd_ecoff_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
308 #define _bfd_ecoff_find_inliner_info _bfd_nosymbols_find_inliner_info
309
310 #define _bfd_ecoff_get_reloc_upper_bound coff_get_reloc_upper_bound
311 extern long _bfd_ecoff_canonicalize_reloc
312 (bfd *, asection *, arelent **, asymbol **);
313 /* ecoff_bfd_reloc_type_lookup defined by backend. */
314
315 extern bool _bfd_ecoff_set_arch_mach
316 (bfd *, enum bfd_architecture, unsigned long);
317 extern bool _bfd_ecoff_set_section_contents
318 (bfd *, asection *, const void * location, file_ptr, bfd_size_type);
319
320 extern int _bfd_ecoff_sizeof_headers (bfd *, struct bfd_link_info *);
321 /* ecoff_bfd_get_relocated_section_contents defined by backend. */
322 /* ecoff_bfd_relax_section defined by backend. */
323 extern struct bfd_link_hash_table *_bfd_ecoff_bfd_link_hash_table_create
324 (bfd *);
325 extern bool _bfd_ecoff_bfd_link_add_symbols
326 (bfd *, struct bfd_link_info *);
327 #define _bfd_ecoff_bfd_link_just_syms _bfd_generic_link_just_syms
328 #define _bfd_ecoff_bfd_copy_link_hash_symbol_type \
329 _bfd_generic_copy_link_hash_symbol_type
330 extern bool _bfd_ecoff_bfd_final_link
331 (bfd *, struct bfd_link_info *);
332
333 /* Hook functions for the generic COFF section reading code. */
334
335 extern void * _bfd_ecoff_mkobject_hook (bfd *, void *, void *);
336 extern void _bfd_ecoff_set_alignment_hook
337 (bfd *, asection *, void *);
338 extern bool _bfd_ecoff_set_arch_mach_hook
339 (bfd *, void *);
340 extern bool _bfd_ecoff_no_long_sections
341 (bfd *abfd, int enable);
342 extern bool _bfd_ecoff_styp_to_sec_flags
343 (bfd *, void *, const char *, asection *, flagword *);
344 extern bool _bfd_ecoff_slurp_symbol_table (bfd *);
345
346 /* ECOFF auxiliary information swapping routines. These are the same
347 for all ECOFF targets, so they are defined in ecofflink.c. */
348
349 extern void _bfd_ecoff_swap_tir_in
350 (int, const struct tir_ext *, TIR *);
351 extern void _bfd_ecoff_swap_tir_out
352 (int, const TIR *, struct tir_ext *);
353 extern void _bfd_ecoff_swap_rndx_in
354 (int, const struct rndx_ext *, RNDXR *);
355 extern void _bfd_ecoff_swap_rndx_out
356 (int, const RNDXR *, struct rndx_ext *);