1999-09-04 Steve Chamberlain <sac@pobox.com>
[external/binutils.git] / bfd / targets.c
1 /* Generic target-file-type support for the BFD library.
2    Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 98, 1999
3    Free Software Foundation, Inc.
4    Written by 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 02111-1307, USA.  */
21
22 #include "bfd.h"
23 #include "sysdep.h"
24 #include "libbfd.h"
25 #include "fnmatch.h"
26
27 /*
28 SECTION 
29         Targets
30
31 DESCRIPTION
32         Each port of BFD to a different machine requries the creation
33         of a target back end. All the back end provides to the root
34         part of BFD is a structure containing pointers to functions
35         which perform certain low level operations on files. BFD
36         translates the applications's requests through a pointer into
37         calls to the back end routines. 
38
39         When a file is opened with <<bfd_openr>>, its format and
40         target are unknown. BFD uses various mechanisms to determine
41         how to interpret the file. The operations performed are:
42
43         o Create a BFD by calling the internal routine
44         <<_bfd_new_bfd>>, then call <<bfd_find_target>> with the
45         target string supplied to <<bfd_openr>> and the new BFD pointer. 
46
47         o If a null target string was provided to <<bfd_find_target>>,
48         look up the environment variable <<GNUTARGET>> and use
49         that as the target string. 
50
51         o If the target string is still <<NULL>>, or the target string is
52         <<default>>, then use the first item in the target vector
53         as the target type, and set <<target_defaulted>> in the BFD to
54         cause <<bfd_check_format>> to loop through all the targets.
55         @xref{bfd_target}.  @xref{Formats}.
56
57         o Otherwise, inspect the elements in the target vector
58         one by one, until a match on target name is found. When found,
59         use it. 
60
61         o Otherwise return the error <<bfd_error_invalid_target>> to
62         <<bfd_openr>>.
63
64         o <<bfd_openr>> attempts to open the file using
65         <<bfd_open_file>>, and returns the BFD.
66
67         Once the BFD has been opened and the target selected, the file
68         format may be determined. This is done by calling
69         <<bfd_check_format>> on the BFD with a suggested format. 
70         If <<target_defaulted>> has been set, each possible target
71         type is tried to see if it recognizes the specified format.
72         <<bfd_check_format>> returns <<true>> when the caller guesses right.
73 @menu
74 @* bfd_target::
75 @end menu
76 */
77
78
79 /*
80
81 INODE
82         bfd_target,  , Targets, Targets
83 DOCDD
84 SUBSECTION
85         bfd_target
86
87 DESCRIPTION
88         This structure contains everything that BFD knows about a
89         target. It includes things like its byte order, name, and which
90         routines to call to do various operations.   
91
92         Every BFD points to a target structure with its <<xvec>>
93         member. 
94
95         The macros below are used to dispatch to functions through the
96         <<bfd_target>> vector. They are used in a number of macros further
97         down in @file{bfd.h}, and are also used when calling various
98         routines by hand inside the BFD implementation.  The @var{arglist}
99         argument must be parenthesized; it contains all the arguments
100         to the called function. 
101
102         They make the documentation (more) unpleasant to read, so if
103         someone wants to fix this and not break the above, please do.
104
105 .#define BFD_SEND(bfd, message, arglist) \
106 .               ((*((bfd)->xvec->message)) arglist)
107 .
108 .#ifdef DEBUG_BFD_SEND
109 .#undef BFD_SEND
110 .#define BFD_SEND(bfd, message, arglist) \
111 .  (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
112 .    ((*((bfd)->xvec->message)) arglist) : \
113 .    (bfd_assert (__FILE__,__LINE__), NULL))
114 .#endif
115
116         For operations which index on the BFD format:
117
118 .#define BFD_SEND_FMT(bfd, message, arglist) \
119 .            (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
120 .
121 .#ifdef DEBUG_BFD_SEND
122 .#undef BFD_SEND_FMT
123 .#define BFD_SEND_FMT(bfd, message, arglist) \
124 .  (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
125 .   (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) : \
126 .   (bfd_assert (__FILE__,__LINE__), NULL))
127 .#endif
128
129         This is the structure which defines the type of BFD this is.  The
130         <<xvec>> member of the struct <<bfd>> itself points here.  Each
131         module that implements access to a different target under BFD,
132         defines one of these.
133
134
135         FIXME, these names should be rationalised with the names of
136         the entry points which call them. Too bad we can't have one
137         macro to define them both! 
138
139 .enum bfd_flavour {
140 .  bfd_target_unknown_flavour,
141 .  bfd_target_aout_flavour,
142 .  bfd_target_coff_flavour,
143 .  bfd_target_ecoff_flavour,
144 .  bfd_target_elf_flavour,
145 .  bfd_target_ieee_flavour,
146 .  bfd_target_nlm_flavour,
147 .  bfd_target_oasys_flavour,
148 .  bfd_target_tekhex_flavour,
149 .  bfd_target_srec_flavour,
150 .  bfd_target_ihex_flavour,
151 .  bfd_target_som_flavour,
152 .  bfd_target_os9k_flavour,
153 .  bfd_target_versados_flavour,
154 .  bfd_target_msdos_flavour,
155 .  bfd_target_ovax_flavour,
156 .  bfd_target_evax_flavour
157 .};
158 .
159 .enum bfd_endian { BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN };
160 .
161 .{* Forward declaration.  *}
162 .typedef struct bfd_link_info _bfd_link_info;
163 .
164 .typedef struct bfd_target
165 .{
166
167 Identifies the kind of target, e.g., SunOS4, Ultrix, etc.
168
169 .  char *name;
170
171 The "flavour" of a back end is a general indication about the contents
172 of a file.
173
174 .  enum bfd_flavour flavour;
175
176 The order of bytes within the data area of a file.
177
178 .  enum bfd_endian byteorder;
179
180 The order of bytes within the header parts of a file.
181
182 .  enum bfd_endian header_byteorder;
183
184 A mask of all the flags which an executable may have set -
185 from the set <<BFD_NO_FLAGS>>, <<HAS_RELOC>>, ...<<D_PAGED>>.
186
187 .  flagword object_flags;       
188
189 A mask of all the flags which a section may have set - from
190 the set <<SEC_NO_FLAGS>>, <<SEC_ALLOC>>, ...<<SET_NEVER_LOAD>>.
191
192 .  flagword section_flags;
193
194 The character normally found at the front of a symbol 
195 (if any), perhaps `_'.
196
197 .  char symbol_leading_char;
198
199 The pad character for file names within an archive header.
200
201 .  char ar_pad_char;            
202
203 The maximum number of characters in an archive header.
204
205 .  unsigned short ar_max_namelen;
206
207 Entries for byte swapping for data. These are different from the other
208 entry points, since they don't take a BFD asthe first argument.
209 Certain other handlers could do the same.
210
211 .  bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
212 .  bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
213 .  void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
214 .  bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
215 .  bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
216 .  void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
217 .  bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
218 .  bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
219 .  void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
220
221 Byte swapping for the headers
222
223 .  bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
224 .  bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
225 .  void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
226 .  bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
227 .  bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
228 .  void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
229 .  bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
230 .  bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
231 .  void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
232
233 Format dependent routines: these are vectors of entry points
234 within the target vector structure, one for each format to check.
235
236 Check the format of a file being read.  Return a <<bfd_target *>> or zero. 
237
238 .  const struct bfd_target *(*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
239
240 Set the format of a file being written.  
241
242 .  boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
243
244 Write cached information into a file being written, at <<bfd_close>>. 
245
246 .  boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
247
248 The general target vector.  These vectors are initialized using the
249 BFD_JUMP_TABLE macros.
250
251 .
252 .  {* Generic entry points.  *}
253 .#define BFD_JUMP_TABLE_GENERIC(NAME)\
254 .CAT(NAME,_close_and_cleanup),\
255 .CAT(NAME,_bfd_free_cached_info),\
256 .CAT(NAME,_new_section_hook),\
257 .CAT(NAME,_get_section_contents),\
258 .CAT(NAME,_get_section_contents_in_window)
259 .
260 .  {* Called when the BFD is being closed to do any necessary cleanup.  *}
261 .  boolean       (*_close_and_cleanup) PARAMS ((bfd *));
262 .  {* Ask the BFD to free all cached information.  *}
263 .  boolean (*_bfd_free_cached_info) PARAMS ((bfd *));
264 .  {* Called when a new section is created.  *}
265 .  boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
266 .  {* Read the contents of a section.  *}
267 .  boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR, 
268 .                                            file_ptr, bfd_size_type));
269 .  boolean       (*_bfd_get_section_contents_in_window)
270 .                          PARAMS ((bfd *, sec_ptr, bfd_window *,
271 .                                   file_ptr, bfd_size_type));
272 .
273 .  {* Entry points to copy private data.  *}
274 .#define BFD_JUMP_TABLE_COPY(NAME)\
275 .CAT(NAME,_bfd_copy_private_bfd_data),\
276 .CAT(NAME,_bfd_merge_private_bfd_data),\
277 .CAT(NAME,_bfd_copy_private_section_data),\
278 .CAT(NAME,_bfd_copy_private_symbol_data),\
279 .CAT(NAME,_bfd_set_private_flags),\
280 .CAT(NAME,_bfd_print_private_bfd_data)\
281 .  {* Called to copy BFD general private data from one object file
282 .     to another.  *}
283 .  boolean       (*_bfd_copy_private_bfd_data) PARAMS ((bfd *, bfd *));
284 .  {* Called to merge BFD general private data from one object file
285 .     to a common output file when linking.  *}
286 .  boolean       (*_bfd_merge_private_bfd_data) PARAMS ((bfd *, bfd *));
287 .  {* Called to copy BFD private section data from one object file
288 .     to another.  *}
289 .  boolean       (*_bfd_copy_private_section_data) PARAMS ((bfd *, sec_ptr,
290 .                                                       bfd *, sec_ptr));
291 .  {* Called to copy BFD private symbol data from one symbol 
292 .     to another.  *}
293 .  boolean       (*_bfd_copy_private_symbol_data) PARAMS ((bfd *, asymbol *,
294 .                                                          bfd *, asymbol *));
295 .  {* Called to set private backend flags *}
296 .  boolean       (*_bfd_set_private_flags) PARAMS ((bfd *, flagword));
297 .
298 .  {* Called to print private BFD data *}
299 .  boolean       (*_bfd_print_private_bfd_data) PARAMS ((bfd *, PTR));
300 .
301 .  {* Core file entry points.  *}
302 .#define BFD_JUMP_TABLE_CORE(NAME)\
303 .CAT(NAME,_core_file_failing_command),\
304 .CAT(NAME,_core_file_failing_signal),\
305 .CAT(NAME,_core_file_matches_executable_p)
306 .  char *   (*_core_file_failing_command) PARAMS ((bfd *));
307 .  int      (*_core_file_failing_signal) PARAMS ((bfd *));
308 .  boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
309 .
310 .  {* Archive entry points.  *}
311 .#define BFD_JUMP_TABLE_ARCHIVE(NAME)\
312 .CAT(NAME,_slurp_armap),\
313 .CAT(NAME,_slurp_extended_name_table),\
314 .CAT(NAME,_construct_extended_name_table),\
315 .CAT(NAME,_truncate_arname),\
316 .CAT(NAME,_write_armap),\
317 .CAT(NAME,_read_ar_hdr),\
318 .CAT(NAME,_openr_next_archived_file),\
319 .CAT(NAME,_get_elt_at_index),\
320 .CAT(NAME,_generic_stat_arch_elt),\
321 .CAT(NAME,_update_armap_timestamp)
322 .  boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
323 .  boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
324 .  boolean  (*_bfd_construct_extended_name_table)
325 .             PARAMS ((bfd *, char **, bfd_size_type *, const char **));
326 .  void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
327 .  boolean  (*write_armap) PARAMS ((bfd *arch, 
328 .                              unsigned int elength,
329 .                              struct orl *map,
330 .                              unsigned int orl_count, 
331 .                              int stridx));
332 .  PTR (*_bfd_read_ar_hdr_fn) PARAMS ((bfd *));
333 .  bfd *    (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
334 .#define bfd_get_elt_at_index(b,i) BFD_SEND(b, _bfd_get_elt_at_index, (b,i))
335 .  bfd *    (*_bfd_get_elt_at_index) PARAMS ((bfd *, symindex));
336 .  int      (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
337 .  boolean  (*_bfd_update_armap_timestamp) PARAMS ((bfd *));
338 .
339 .  {* Entry points used for symbols.  *}
340 .#define BFD_JUMP_TABLE_SYMBOLS(NAME)\
341 .CAT(NAME,_get_symtab_upper_bound),\
342 .CAT(NAME,_get_symtab),\
343 .CAT(NAME,_make_empty_symbol),\
344 .CAT(NAME,_print_symbol),\
345 .CAT(NAME,_get_symbol_info),\
346 .CAT(NAME,_bfd_is_local_label_name),\
347 .CAT(NAME,_get_lineno),\
348 .CAT(NAME,_find_nearest_line),\
349 .CAT(NAME,_bfd_make_debug_symbol),\
350 .CAT(NAME,_read_minisymbols),\
351 .CAT(NAME,_minisymbol_to_symbol)
352 .  long  (*_bfd_get_symtab_upper_bound) PARAMS ((bfd *));
353 .  long  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
354 .                                             struct symbol_cache_entry **));
355 .  struct symbol_cache_entry  *
356 .                (*_bfd_make_empty_symbol) PARAMS ((bfd *));
357 .  void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
358 .                                      struct symbol_cache_entry *,
359 .                                      bfd_print_symbol_type));
360 .#define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
361 .  void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
362 .                                      struct symbol_cache_entry *,
363 .                                      symbol_info *));
364 .#define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
365 .  boolean       (*_bfd_is_local_label_name) PARAMS ((bfd *, const char *));
366 .
367 .  alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
368 .  boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
369 .                    struct sec *section, struct symbol_cache_entry **symbols,
370 .                    bfd_vma offset, CONST char **file, CONST char **func,
371 .                    unsigned int *line));
372 . {* Back-door to allow format-aware applications to create debug symbols
373 .    while using BFD for everything else.  Currently used by the assembler
374 .    when creating COFF files.  *}
375 .  asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
376 .       bfd *abfd,
377 .       void *ptr,
378 .       unsigned long size));
379 .#define bfd_read_minisymbols(b, d, m, s) \
380 .  BFD_SEND (b, _read_minisymbols, (b, d, m, s))
381 .  long  (*_read_minisymbols) PARAMS ((bfd *, boolean, PTR *,
382 .                                      unsigned int *));
383 .#define bfd_minisymbol_to_symbol(b, d, m, f) \
384 .  BFD_SEND (b, _minisymbol_to_symbol, (b, d, m, f))
385 .  asymbol *(*_minisymbol_to_symbol) PARAMS ((bfd *, boolean, const PTR,
386 .                                             asymbol *));
387 .
388 .  {* Routines for relocs.  *}
389 .#define BFD_JUMP_TABLE_RELOCS(NAME)\
390 .CAT(NAME,_get_reloc_upper_bound),\
391 .CAT(NAME,_canonicalize_reloc),\
392 .CAT(NAME,_bfd_reloc_type_lookup)
393 .  long  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
394 .  long  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
395 .                                            struct symbol_cache_entry **));
396 .  {* See documentation on reloc types.  *}
397 .  reloc_howto_type *
398 .       (*reloc_type_lookup) PARAMS ((bfd *abfd,
399 .                                     bfd_reloc_code_real_type code));
400 .
401 .  {* Routines used when writing an object file.  *}
402 .#define BFD_JUMP_TABLE_WRITE(NAME)\
403 .CAT(NAME,_set_arch_mach),\
404 .CAT(NAME,_set_section_contents)
405 .  boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
406 .                    unsigned long));
407 .  boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
408 .                                            file_ptr, bfd_size_type));
409 .
410 .  {* Routines used by the linker.  *}
411 .#define BFD_JUMP_TABLE_LINK(NAME)\
412 .CAT(NAME,_sizeof_headers),\
413 .CAT(NAME,_bfd_get_relocated_section_contents),\
414 .CAT(NAME,_bfd_relax_section),\
415 .CAT(NAME,_bfd_link_hash_table_create),\
416 .CAT(NAME,_bfd_link_add_symbols),\
417 .CAT(NAME,_bfd_final_link),\
418 .CAT(NAME,_bfd_link_split_section),\
419 .CAT(NAME,_bfd_gc_sections)
420 .  int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
421 .  bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
422 .                    struct bfd_link_info *, struct bfd_link_order *,
423 .                    bfd_byte *data, boolean relocateable,
424 .                    struct symbol_cache_entry **));
425 .
426 .  boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
427 .                    struct bfd_link_info *, boolean *again));
428 .
429 .  {* Create a hash table for the linker.  Different backends store
430 .     different information in this table.  *}
431 .  struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
432 .
433 .  {* Add symbols from this object file into the hash table.  *}
434 .  boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
435 .
436 .  {* Do a link based on the link_order structures attached to each
437 .     section of the BFD.  *}
438 .  boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
439 .
440 .  {* Should this section be split up into smaller pieces during linking.  *}
441 .  boolean (*_bfd_link_split_section) PARAMS ((bfd *, struct sec *));
442 .
443 .  {* Remove sections that are not referenced from the output.  *}
444 .  boolean (*_bfd_gc_sections) PARAMS ((bfd *, struct bfd_link_info *));
445 .
446 .  {* Routines to handle dynamic symbols and relocs.  *}
447 .#define BFD_JUMP_TABLE_DYNAMIC(NAME)\
448 .CAT(NAME,_get_dynamic_symtab_upper_bound),\
449 .CAT(NAME,_canonicalize_dynamic_symtab),\
450 .CAT(NAME,_get_dynamic_reloc_upper_bound),\
451 .CAT(NAME,_canonicalize_dynamic_reloc)
452 .  {* Get the amount of memory required to hold the dynamic symbols. *}
453 .  long  (*_bfd_get_dynamic_symtab_upper_bound) PARAMS ((bfd *));
454 .  {* Read in the dynamic symbols.  *}
455 .  long  (*_bfd_canonicalize_dynamic_symtab)
456 .    PARAMS ((bfd *, struct symbol_cache_entry **));
457 .  {* Get the amount of memory required to hold the dynamic relocs.  *}
458 .  long  (*_bfd_get_dynamic_reloc_upper_bound) PARAMS ((bfd *));
459 .  {* Read in the dynamic relocs.  *}
460 .  long  (*_bfd_canonicalize_dynamic_reloc)
461 .    PARAMS ((bfd *, arelent **, struct symbol_cache_entry **));
462 .
463
464 A pointer to an alternative bfd_target in case the current one is not
465 satisfactory.  This can happen when the target cpu supports both big
466 and little endian code, and target chosen by the linker has the wrong
467 endianness.  The function open_output() in ld/ldlang.c uses this field
468 to find an alternative output format that is suitable.
469
470 . {* Opposite endian version of this target.  *}  
471 . const struct bfd_target * alternative_target;
472
473
474 Data for use by back-end routines, which isn't generic enough to belong
475 in this structure.
476
477 . PTR backend_data;
478
479 .} bfd_target;
480
481 */
482
483 /* All known xvecs (even those that don't compile on all systems).
484    Alphabetized for easy reference.
485    They are listed a second time below, since
486    we can't intermix extern's and initializers.  */
487 extern const bfd_target a29kcoff_big_vec;
488 extern const bfd_target a_out_adobe_vec;
489 extern const bfd_target aout_arm_big_vec;
490 extern const bfd_target aout_arm_little_vec;
491 extern const bfd_target aout_mips_big_vec;
492 extern const bfd_target aout_mips_little_vec;
493 extern const bfd_target aout0_big_vec;
494 extern const bfd_target apollocoff_vec;
495 extern const bfd_target armcoff_little_vec;
496 extern const bfd_target armcoff_big_vec;
497 extern const bfd_target armnetbsd_vec;
498 extern const bfd_target armpe_little_vec;
499 extern const bfd_target armpe_big_vec;
500 extern const bfd_target armpei_little_vec;
501 extern const bfd_target armpei_big_vec;
502 extern const bfd_target arm_epoc_pe_little_vec;
503 extern const bfd_target arm_epoc_pe_big_vec;
504 extern const bfd_target arm_epoc_pei_little_vec;
505 extern const bfd_target arm_epoc_pei_big_vec;
506 extern const bfd_target b_out_vec_big_host;
507 extern const bfd_target b_out_vec_little_host;
508 extern const bfd_target bfd_elf64_alpha_vec;
509 extern const bfd_target bfd_elf32_bigarc_vec;
510 extern const bfd_target bfd_elf32_bigarm_vec;
511 extern const bfd_target bfd_elf32_bigarm_oabi_vec;
512 extern const bfd_target bfd_elf32_littlearc_vec;
513 extern const bfd_target bfd_elf32_littlearm_vec;
514 extern const bfd_target bfd_elf32_littlearm_oabi_vec;
515 extern const bfd_target bfd_elf32_big_generic_vec;
516 extern const bfd_target bfd_elf32_bigmips_vec;
517 extern const bfd_target bfd_elf64_bigmips_vec;
518 extern const bfd_target bfd_elf32_d10v_vec;
519 extern const bfd_target bfd_elf32_d30v_vec;
520 extern const bfd_target bfd_elf32_hppa_vec;
521 extern const bfd_target bfd_elf32_i386_vec;
522 extern const bfd_target bfd_elf32_i860_vec;
523 extern const bfd_target bfd_elf32_i960_vec;
524 extern const bfd_target bfd_elf32_little_generic_vec;
525 extern const bfd_target bfd_elf32_littlemips_vec;
526 extern const bfd_target bfd_elf64_littlemips_vec;
527 extern const bfd_target bfd_elf32_m32r_vec;
528 extern const bfd_target bfd_elf32_m68k_vec;
529 extern const bfd_target bfd_elf32_m88k_vec;
530 extern const bfd_target bfd_elf32_mn10200_vec;
531 extern const bfd_target bfd_elf32_mn10300_vec;
532 extern const bfd_target bfd_elf32_pj_vec;
533 extern const bfd_target bfd_elf32_pjl_vec;
534 extern const bfd_target bfd_elf32_powerpc_vec;
535 extern const bfd_target bfd_elf32_powerpcle_vec;
536 extern const bfd_target bfd_elf32_sh_vec;
537 extern const bfd_target bfd_elf32_shl_vec;
538 extern const bfd_target bfd_elf32_sparc_vec;
539 extern const bfd_target bfd_elf32_v850_vec;
540 extern const bfd_target bfd_elf32_fr30_vec;
541 extern const bfd_target bfd_elf32_mcore_big_vec;
542 extern const bfd_target bfd_elf32_mcore_little_vec;
543 extern const bfd_target bfd_elf64_big_generic_vec;
544 extern const bfd_target bfd_elf64_little_generic_vec;
545 extern const bfd_target bfd_elf64_sparc_vec;
546 extern const bfd_target demo_64_vec;
547 extern const bfd_target ecoff_big_vec;
548 extern const bfd_target ecoff_little_vec;
549 extern const bfd_target ecoff_biglittle_vec;
550 extern const bfd_target ecoffalpha_little_vec;
551 extern const bfd_target h8300coff_vec;
552 extern const bfd_target h8500coff_vec;
553 extern const bfd_target host_aout_vec;
554 extern const bfd_target hp300bsd_vec;
555 extern const bfd_target hp300hpux_vec;
556 extern const bfd_target som_vec;
557 extern const bfd_target i386aout_vec;
558 extern const bfd_target i386bsd_vec;
559 extern const bfd_target i386dynix_vec;
560 extern const bfd_target i386freebsd_vec;
561 extern const bfd_target i386os9k_vec;
562 extern const bfd_target i386coff_vec;
563 extern const bfd_target bfd_powerpc_pe_vec;
564 extern const bfd_target bfd_powerpcle_pe_vec;
565 extern const bfd_target bfd_powerpc_pei_vec;
566 extern const bfd_target bfd_powerpcle_pei_vec;
567 extern const bfd_target i386pe_vec;
568 extern const bfd_target i386pei_vec;
569 extern const bfd_target go32coff_vec;
570 extern const bfd_target go32stubbedcoff_vec;
571 extern const bfd_target i386linux_vec;
572 extern const bfd_target i386lynx_aout_vec;
573 extern const bfd_target i386lynx_coff_vec;
574 extern const bfd_target i386mach3_vec;
575 extern const bfd_target i386msdos_vec;
576 extern const bfd_target i386netbsd_vec;
577 extern const bfd_target i860coff_vec;
578 extern const bfd_target icoff_big_vec;
579 extern const bfd_target icoff_little_vec;
580 extern const bfd_target ieee_vec;
581 extern const bfd_target m68kaux_coff_vec;
582 extern const bfd_target m68kcoff_vec;
583 extern const bfd_target m68kcoffun_vec;
584 extern const bfd_target m68klinux_vec;
585 extern const bfd_target m68klynx_aout_vec;
586 extern const bfd_target m68klynx_coff_vec;
587 extern const bfd_target m68knetbsd_vec;
588 extern const bfd_target m68ksysvcoff_vec;
589 extern const bfd_target m68k4knetbsd_vec;
590 extern const bfd_target m88kbcs_vec;
591 extern const bfd_target m88kmach3_vec;
592 extern const bfd_target mcore_pe_big_vec;
593 extern const bfd_target mcore_pe_little_vec;
594 extern const bfd_target mcore_pei_big_vec;
595 extern const bfd_target mcore_pei_little_vec;
596 extern const bfd_target newsos3_vec;
597 extern const bfd_target nlm32_i386_vec;
598 extern const bfd_target nlm32_sparc_vec;
599 extern const bfd_target nlm32_alpha_vec;
600 extern const bfd_target nlm32_powerpc_vec;
601 extern const bfd_target pc532netbsd_vec;
602 extern const bfd_target oasys_vec;
603 extern const bfd_target pc532machaout_vec;
604 extern const bfd_target ppcboot_vec;
605 extern const bfd_target riscix_vec;
606 extern const bfd_target pmac_xcoff_vec;
607 extern const bfd_target rs6000coff_vec;
608 extern const bfd_target shcoff_vec;
609 extern const bfd_target shlcoff_vec;
610 extern const bfd_target shcoff_small_vec;
611 extern const bfd_target shlcoff_small_vec;
612 extern const bfd_target sparcle_aout_vec;
613 extern const bfd_target sparclinux_vec;
614 extern const bfd_target sparclynx_aout_vec;
615 extern const bfd_target sparclynx_coff_vec;
616 extern const bfd_target sparcnetbsd_vec;
617 extern const bfd_target sparccoff_vec;
618 extern const bfd_target sunos_big_vec;
619 extern const bfd_target tekhex_vec;
620 extern const bfd_target tic30_aout_vec;
621 extern const bfd_target tic30_coff_vec;
622 extern const bfd_target tic80coff_vec;
623 extern const bfd_target vaxnetbsd_vec;
624 extern const bfd_target versados_vec;
625 extern const bfd_target vms_alpha_vec;
626 extern const bfd_target vms_vax_vec;
627 extern const bfd_target we32kcoff_vec;
628 extern const bfd_target w65_vec;
629 extern const bfd_target z8kcoff_vec;
630
631 /* srec is always included.  */
632 extern const bfd_target srec_vec;
633 extern const bfd_target symbolsrec_vec;
634
635 /* binary is always included.  */
636 extern const bfd_target binary_vec;
637
638 /* ihex is always included.  */
639 extern const bfd_target ihex_vec;
640
641 /* All of the xvecs for core files.  */
642 extern const bfd_target aix386_core_vec;
643 extern const bfd_target cisco_core_vec;
644 extern const bfd_target hpux_core_vec;
645 extern const bfd_target hppabsd_core_vec;
646 extern const bfd_target irix_core_vec;
647 extern const bfd_target netbsd_core_vec;
648 extern const bfd_target osf_core_vec;
649 extern const bfd_target sco5_core_vec;
650 extern const bfd_target trad_core_vec;
651 extern const bfd_target ptrace_core_vec;
652
653 const bfd_target * const bfd_target_vector[] = {
654
655 #ifdef SELECT_VECS
656
657         SELECT_VECS,
658
659 #else /* not SELECT_VECS */
660
661 #ifdef DEFAULT_VECTOR
662         &DEFAULT_VECTOR,
663 #endif
664         /* This list is alphabetized to make it easy to compare
665            with other vector lists -- the decls above and
666            the case statement in configure.in.
667            Vectors that don't compile on all systems, or aren't finished,
668            should have an entry here with #if 0 around it, to show that
669            it wasn't omitted by mistake.  */
670         &a29kcoff_big_vec,
671         &a_out_adobe_vec,
672 #if 0                           /* No one seems to use this.  */
673         &aout_mips_big_vec,
674 #endif
675         &aout_mips_little_vec,
676         &b_out_vec_big_host,
677         &b_out_vec_little_host,
678
679         /* This, and other vectors, may not be used in any *.mt configuration.
680            But that does not mean they are unnecessary.  If configured with
681            --enable-targets=all, objdump or gdb should be able to examine
682            the file even if we don't recognize the machine type.  */
683         &bfd_elf32_big_generic_vec,
684 #ifdef BFD64
685         &bfd_elf64_alpha_vec,
686 #endif
687         &bfd_elf32_bigarc_vec,
688         &bfd_elf32_bigarm_vec,
689         &bfd_elf32_bigarm_oabi_vec,
690         &bfd_elf32_bigmips_vec,
691 #ifdef BFD64
692         &bfd_elf64_bigmips_vec,
693 #endif
694         &bfd_elf32_d10v_vec,
695         &bfd_elf32_d30v_vec,
696         &bfd_elf32_hppa_vec,
697         &bfd_elf32_i386_vec,
698         &bfd_elf32_i860_vec,
699         &bfd_elf32_i960_vec,
700         &bfd_elf32_little_generic_vec,
701         &bfd_elf32_littlearc_vec,
702         &bfd_elf32_littlearm_vec,
703         &bfd_elf32_littlearm_oabi_vec,
704         &bfd_elf32_littlemips_vec,
705 #ifdef BFD64
706         &bfd_elf64_littlemips_vec,
707 #endif
708         &bfd_elf32_m32r_vec,
709         &bfd_elf32_mn10200_vec,
710         &bfd_elf32_mn10300_vec,
711         &bfd_elf32_m68k_vec,
712         &bfd_elf32_m88k_vec,
713         &bfd_elf32_sparc_vec,
714         &bfd_elf32_pj_vec,
715         &bfd_elf32_pjl_vec,
716         &bfd_elf32_powerpc_vec,
717         &bfd_elf32_powerpcle_vec,
718         &bfd_elf32_v850_vec,
719         &bfd_elf32_fr30_vec,
720         &bfd_elf32_mcore_big_vec,
721         &bfd_elf32_mcore_little_vec,
722 #ifdef BFD64                    /* No one seems to use this.  */
723         &bfd_elf64_big_generic_vec,
724         &bfd_elf64_little_generic_vec,
725 #endif
726 #if 0
727         &bfd_elf64_sparc_vec,
728 #endif
729         /* We don't include cisco_core_vec.  Although it has a magic number,
730            the magic number isn't at the beginning of the file, and thus
731            might spuriously match other kinds of files.  */
732 #ifdef BFD64
733         &demo_64_vec,   /* Only compiled if host has long-long support */
734 #endif
735         &ecoff_big_vec,
736         &ecoff_little_vec,
737         &ecoff_biglittle_vec,
738 #ifdef BFD64
739         &ecoffalpha_little_vec,
740 #endif
741         &h8300coff_vec,
742         &h8500coff_vec,
743 #if 0
744         /* Since a.out files lack decent magic numbers, no way to recognize
745            which kind of a.out file it is.  */
746         &host_aout_vec,
747 #endif
748 #if 0                           /* Clashes with sunos_big_vec magic no.  */
749         &hp300bsd_vec,
750 #endif
751         &hp300hpux_vec,
752 #if defined (HOST_HPPAHPUX) || defined (HOST_HPPABSD) || defined (HOST_HPPAOSF)
753         &som_vec,
754 #endif
755         &i386aout_vec,
756         &i386bsd_vec,
757         &i386coff_vec,
758         &i386freebsd_vec,
759         &i860coff_vec,
760         &bfd_powerpc_pe_vec,
761         &bfd_powerpcle_pe_vec,
762         &bfd_powerpc_pei_vec,
763         &bfd_powerpcle_pei_vec,
764         &go32coff_vec,
765         &go32stubbedcoff_vec,
766 #if 0
767         /* Since a.out files lack decent magic numbers, no way to recognize
768            which kind of a.out file it is.  */
769         &i386linux_vec,
770 #endif
771         &i386lynx_aout_vec,
772         &i386lynx_coff_vec,
773 #if 0
774         /* No distinguishing features for Mach 3 executables.  */
775         &i386mach3_vec,
776 #endif
777         &i386msdos_vec,
778         &i386netbsd_vec,
779         &i386os9k_vec,
780         &i386pe_vec,
781         &i386pei_vec,
782         &armcoff_little_vec,
783         &armcoff_big_vec,
784         &armnetbsd_vec,
785         &armpe_little_vec,
786         &armpe_big_vec,
787         &armpei_little_vec,
788         &armpei_big_vec,
789         &arm_epoc_pe_little_vec,
790         &arm_epoc_pe_big_vec,
791         &arm_epoc_pei_little_vec,
792         &arm_epoc_pei_big_vec,
793         &icoff_big_vec,
794         &icoff_little_vec,
795         &ieee_vec,
796         &m68kcoff_vec,
797         &m68kcoffun_vec,
798 #if 0
799         /* Since a.out files lack decent magic numbers, no way to recognize
800            which kind of a.out file it is.  */
801         &m68klinux_vec,
802 #endif
803         &m68klynx_aout_vec,
804         &m68klynx_coff_vec,
805         &m68knetbsd_vec,
806         &m68ksysvcoff_vec,
807         &m88kbcs_vec,
808         &m88kmach3_vec,
809         &mcore_pe_big_vec,
810         &mcore_pe_little_vec,
811         &mcore_pei_big_vec,
812         &mcore_pei_little_vec,
813         &newsos3_vec,
814         &nlm32_i386_vec,
815         &nlm32_sparc_vec,
816 #ifdef BFD64
817         &nlm32_alpha_vec,
818 #endif
819         &pc532netbsd_vec,
820 #if 0
821         /* We have no oasys tools anymore, so we can't test any of this
822            anymore. If you want to test the stuff yourself, go ahead...
823            steve@cygnus.com
824            Worse, since there is no magic number for archives, there
825            can be annoying target mis-matches.  */
826         &oasys_vec,
827 #endif
828         &pc532machaout_vec,
829 #if 0
830         /* We have no way of distinguishing these from other a.out variants */
831         &aout_arm_big_vec,
832         &aout_arm_little_vec,
833         &riscix_vec,
834 #endif
835 #if 0
836         /* This has the same magic number as RS/6000. */
837         &pmac_xcoff_vec,
838 #endif
839         &rs6000coff_vec,
840         &ppcboot_vec,
841         &shcoff_vec,
842         &shlcoff_vec,
843         &shcoff_small_vec,
844         &shlcoff_small_vec,
845         &sparcle_aout_vec,
846         &sparclinux_vec,
847         &sparclynx_aout_vec,
848         &sparclynx_coff_vec,
849         &sparcnetbsd_vec,
850         &sunos_big_vec,
851         &aout0_big_vec,
852         &tic30_aout_vec,
853         &tic30_coff_vec,
854         &tic80coff_vec,
855         &vaxnetbsd_vec,
856         &versados_vec,
857 #ifdef BFD64
858         &vms_alpha_vec,
859 #endif
860         &vms_vax_vec,
861         &we32kcoff_vec,
862         &z8kcoff_vec,
863
864 #endif /* not SELECT_VECS */
865
866 /* Always support S-records, for convenience.  */
867         &srec_vec,
868         &symbolsrec_vec,
869 /* And tekhex */
870         &tekhex_vec,
871 /* Likewise for binary output.  */
872         &binary_vec,
873 /* Likewise for ihex.  */
874         &ihex_vec,
875
876 /* Add any required traditional-core-file-handler.  */
877
878 #ifdef AIX386_CORE
879         &aix386_core_vec,
880 #endif
881 #ifdef HPUX_CORE
882         &hpux_core_vec,
883 #endif
884 #ifdef HPPABSD_CORE
885         &hppabsd_core_vec,
886 #endif
887 #ifdef IRIX_CORE
888         &irix_core_vec,
889 #endif
890 #ifdef NETBSD_CORE
891         &netbsd_core_vec,
892 #endif
893 #ifdef OSF_CORE
894         &osf_core_vec,
895 #endif
896 #ifdef SCO5_CORE
897         &sco5_core_vec,
898 #endif
899 #ifdef  TRAD_CORE
900         &trad_core_vec,
901 #endif
902
903 #ifdef  PTRACE_CORE
904         &ptrace_core_vec,
905 #endif
906
907         NULL /* end of list marker */
908 };
909
910 /* bfd_default_vector[0] contains either the address of the default vector,
911    if there is one, or zero if there isn't.  */
912
913 const bfd_target *bfd_default_vector[] = {
914 #ifdef DEFAULT_VECTOR
915         &DEFAULT_VECTOR,
916 #endif
917         NULL
918 };
919
920 /* When there is an ambiguous match, bfd_check_format_matches puts the
921    names of the matching targets in an array.  This variable is the maximum
922    number of entries that the array could possibly need.  */
923 const size_t _bfd_target_vector_entries = sizeof(bfd_target_vector)/sizeof(*bfd_target_vector);
924 \f
925 /* This array maps configuration triplets onto BFD vectors.  */
926
927 struct targmatch
928 {
929   /* The configuration triplet.  */
930   const char *triplet;
931   /* The BFD vector.  If this is NULL, then the vector is found by
932      searching forward for the next structure with a non NULL vector
933      field.  */
934   const bfd_target *vector;
935 };
936
937 /* targmatch.h is built by Makefile out of config.bfd.  */
938 static const struct targmatch bfd_target_match[] = {
939 #include "targmatch.h"
940   { NULL, NULL }
941 };
942
943 static const bfd_target *find_target PARAMS ((const char *));
944
945 /* Find a target vector, given a name or configuration triplet.  */
946
947 static const bfd_target *
948 find_target (name)
949      const char *name;
950 {
951   const bfd_target * const *target;
952   const struct targmatch *match;
953
954   for (target = &bfd_target_vector[0]; *target != NULL; target++)
955     if (strcmp (name, (*target)->name) == 0)
956       return *target;
957
958   /* If we couldn't match on the exact name, try matching on the
959      configuration triplet.  FIXME: We should run the triplet through
960      config.sub first, but that is hard.  */
961   for (match = &bfd_target_match[0]; match->triplet != NULL; match++)
962     {
963       if (fnmatch (match->triplet, name, 0) == 0)
964         {
965           while (match->vector == NULL)
966             ++match;
967           return match->vector;
968           break;
969         }
970     }
971
972   bfd_set_error (bfd_error_invalid_target);
973   return NULL;
974 }
975
976 /*
977 FUNCTION
978         bfd_set_default_target
979
980 SYNOPSIS
981         boolean bfd_set_default_target (const char *name);
982
983 DESCRIPTION
984         Set the default target vector to use when recognizing a BFD.
985         This takes the name of the target, which may be a BFD target
986         name or a configuration triplet.
987 */
988
989 boolean
990 bfd_set_default_target (name)
991      const char *name;
992 {
993   const bfd_target *target;
994
995   if (bfd_default_vector[0] != NULL
996       && strcmp (name, bfd_default_vector[0]->name) == 0)
997     return true;
998
999   target = find_target (name);
1000   if (target == NULL)
1001     return false;
1002
1003   bfd_default_vector[0] = target;
1004   return true;
1005 }
1006
1007 /*
1008 FUNCTION
1009         bfd_find_target
1010
1011 SYNOPSIS
1012         const bfd_target *bfd_find_target(CONST char *target_name, bfd *abfd);
1013
1014 DESCRIPTION
1015         Return a pointer to the transfer vector for the object target
1016         named @var{target_name}.  If @var{target_name} is <<NULL>>, choose the
1017         one in the environment variable <<GNUTARGET>>; if that is null or not
1018         defined, then choose the first entry in the target list.
1019         Passing in the string "default" or setting the environment
1020         variable to "default" will cause the first entry in the target
1021         list to be returned, and "target_defaulted" will be set in the
1022         BFD.  This causes <<bfd_check_format>> to loop over all the
1023         targets to find the one that matches the file being read.   
1024 */
1025
1026 const bfd_target *
1027 bfd_find_target (target_name, abfd)
1028      const char *target_name;
1029      bfd *abfd;
1030 {
1031   const char *targname;
1032   const bfd_target *target;
1033
1034   if (target_name != NULL)
1035     targname = target_name;
1036   else
1037     targname = getenv ("GNUTARGET");
1038
1039   /* This is safe; the vector cannot be null */
1040   if (targname == NULL || strcmp (targname, "default") == 0)
1041     {
1042       abfd->target_defaulted = true;
1043       if (bfd_default_vector[0] != NULL)
1044         abfd->xvec = bfd_default_vector[0];
1045       else
1046         abfd->xvec = bfd_target_vector[0];
1047       return abfd->xvec;
1048     }
1049
1050   abfd->target_defaulted = false;
1051
1052   target = find_target (targname);
1053   if (target == NULL)
1054     return NULL;
1055
1056   abfd->xvec = target;
1057   return target;
1058 }
1059
1060 /*
1061 FUNCTION
1062         bfd_target_list
1063
1064 SYNOPSIS
1065         const char **bfd_target_list(void);
1066
1067 DESCRIPTION
1068         Return a freshly malloced NULL-terminated
1069         vector of the names of all the valid BFD targets. Do not
1070         modify the names.
1071
1072 */
1073
1074 const char **
1075 bfd_target_list ()
1076 {
1077   int vec_length= 0;
1078 #if defined (HOST_HPPAHPUX) && ! defined (__STDC__)
1079   /* The native compiler on the HP9000/700 has a bug which causes it
1080      to loop endlessly when compiling this file.  This avoids it.  */
1081   volatile
1082 #endif
1083     const bfd_target * const *target;
1084   CONST  char **name_list, **name_ptr;
1085
1086   for (target = &bfd_target_vector[0]; *target != NULL; target++)
1087     vec_length++;
1088
1089   name_ptr = name_list = (CONST char **)
1090     bfd_zmalloc ((vec_length + 1) * sizeof (char **));
1091
1092   if (name_list == NULL)
1093     return NULL;
1094
1095   for (target = &bfd_target_vector[0]; *target != NULL; target++)
1096     *(name_ptr++) = (*target)->name;
1097
1098   return name_list;
1099 }
1100
1101 /*
1102 FUNCTION
1103         bfd_seach_for_target
1104
1105 SYNOPSIS
1106         const bfd_target * bfd_search_for_target (int (* search_func)(const bfd_target *, void *), void *);
1107
1108 DESCRIPTION
1109         Return a pointer to the first transfer vector in the list of
1110         transfer vectors maintained by BFD that produces a non-zero
1111         result when passed to the function @var{search_func}.  The
1112         parameter @var{data} is passed, unexamined, to the search
1113         function.
1114 */
1115
1116 const bfd_target *
1117 bfd_search_for_target (search_func, data)
1118      int (* search_func) PARAMS ((const bfd_target * target, void * data));
1119      void * data;
1120 {
1121   const bfd_target * const * target;
1122
1123   for (target = bfd_target_vector; * target != NULL; target ++)
1124     if (search_func (* target, data))
1125       return * target;
1126
1127   return NULL;
1128 }