targets.texi revision 1.1.1.4
1@section Targets
2
3
4@strong{Description}@*
5Each port of BFD to a different machine requires the creation
6of a target back end. All the back end provides to the root
7part of BFD is a structure containing pointers to functions
8which perform certain low level operations on files. BFD
9translates the applications's requests through a pointer into
10calls to the back end routines.
11
12When a file is opened with @code{bfd_openr}, its format and
13target are unknown. BFD uses various mechanisms to determine
14how to interpret the file. The operations performed are:
15
16@itemize @bullet
17
18@item
19Create a BFD by calling the internal routine
20@code{_bfd_new_bfd}, then call @code{bfd_find_target} with the
21target string supplied to @code{bfd_openr} and the new BFD pointer.
22
23@item
24If a null target string was provided to @code{bfd_find_target},
25look up the environment variable @code{GNUTARGET} and use
26that as the target string.
27
28@item
29If the target string is still @code{NULL}, or the target string is
30@code{default}, then use the first item in the target vector
31as the target type, and set @code{target_defaulted} in the BFD to
32cause @code{bfd_check_format} to loop through all the targets.
33@xref{bfd_target}.  @xref{Formats}.
34
35@item
36Otherwise, inspect the elements in the target vector
37one by one, until a match on target name is found. When found,
38use it.
39
40@item
41Otherwise return the error @code{bfd_error_invalid_target} to
42@code{bfd_openr}.
43
44@item
45@code{bfd_openr} attempts to open the file using
46@code{bfd_open_file}, and returns the BFD.
47@end itemize
48Once the BFD has been opened and the target selected, the file
49format may be determined. This is done by calling
50@code{bfd_check_format} on the BFD with a suggested format.
51If @code{target_defaulted} has been set, each possible target
52type is tried to see if it recognizes the specified format.
53@code{bfd_check_format} returns @code{TRUE} when the caller guesses right.
54@menu
55* bfd_target::
56@end menu
57
58@node bfd_target,  , Targets, Targets
59
60@subsection bfd_target
61
62
63@strong{Description}@*
64This structure contains everything that BFD knows about a
65target. It includes things like its byte order, name, and which
66routines to call to do various operations.
67
68Every BFD points to a target structure with its @code{xvec}
69member.
70
71The macros below are used to dispatch to functions through the
72@code{bfd_target} vector. They are used in a number of macros further
73down in @file{bfd.h}, and are also used when calling various
74routines by hand inside the BFD implementation.  The @var{arglist}
75argument must be parenthesized; it contains all the arguments
76to the called function.
77
78They make the documentation (more) unpleasant to read, so if
79someone wants to fix this and not break the above, please do.
80@example
81#define BFD_SEND(bfd, message, arglist) \
82  ((*((bfd)->xvec->message)) arglist)
83
84#ifdef DEBUG_BFD_SEND
85#undef BFD_SEND
86#define BFD_SEND(bfd, message, arglist) \
87  (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
88    ((*((bfd)->xvec->message)) arglist) : \
89    (bfd_assert (__FILE__,__LINE__), NULL))
90#endif
91@end example
92For operations which index on the BFD format:
93@example
94#define BFD_SEND_FMT(bfd, message, arglist) \
95  (((bfd)->xvec->message[(int) ((bfd)->format)]) arglist)
96
97#ifdef DEBUG_BFD_SEND
98#undef BFD_SEND_FMT
99#define BFD_SEND_FMT(bfd, message, arglist) \
100  (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
101   (((bfd)->xvec->message[(int) ((bfd)->format)]) arglist) : \
102   (bfd_assert (__FILE__,__LINE__), NULL))
103#endif
104
105@end example
106This is the structure which defines the type of BFD this is.  The
107@code{xvec} member of the struct @code{bfd} itself points here.  Each
108module that implements access to a different target under BFD,
109defines one of these.
110
111FIXME, these names should be rationalised with the names of
112the entry points which call them. Too bad we can't have one
113macro to define them both!
114@example
115enum bfd_flavour
116@{
117  /* N.B. Update bfd_flavour_name if you change this.  */
118  bfd_target_unknown_flavour,
119  bfd_target_aout_flavour,
120  bfd_target_coff_flavour,
121  bfd_target_ecoff_flavour,
122  bfd_target_xcoff_flavour,
123  bfd_target_elf_flavour,
124  bfd_target_ieee_flavour,
125  bfd_target_nlm_flavour,
126  bfd_target_oasys_flavour,
127  bfd_target_tekhex_flavour,
128  bfd_target_srec_flavour,
129  bfd_target_verilog_flavour,
130  bfd_target_ihex_flavour,
131  bfd_target_som_flavour,
132  bfd_target_os9k_flavour,
133  bfd_target_versados_flavour,
134  bfd_target_msdos_flavour,
135  bfd_target_ovax_flavour,
136  bfd_target_evax_flavour,
137  bfd_target_mmo_flavour,
138  bfd_target_mach_o_flavour,
139  bfd_target_pef_flavour,
140  bfd_target_pef_xlib_flavour,
141  bfd_target_sym_flavour
142@};
143
144enum bfd_endian @{ BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN @};
145
146/* Forward declaration.  */
147typedef struct bfd_link_info _bfd_link_info;
148
149/* Forward declaration.  */
150typedef struct flag_info flag_info;
151
152typedef struct bfd_target
153@{
154  /* Identifies the kind of target, e.g., SunOS4, Ultrix, etc.  */
155  char *name;
156
157 /* The "flavour" of a back end is a general indication about
158    the contents of a file.  */
159  enum bfd_flavour flavour;
160
161  /* The order of bytes within the data area of a file.  */
162  enum bfd_endian byteorder;
163
164 /* The order of bytes within the header parts of a file.  */
165  enum bfd_endian header_byteorder;
166
167  /* A mask of all the flags which an executable may have set -
168     from the set @code{BFD_NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.  */
169  flagword object_flags;
170
171 /* A mask of all the flags which a section may have set - from
172    the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.  */
173  flagword section_flags;
174
175 /* The character normally found at the front of a symbol.
176    (if any), perhaps `_'.  */
177  char symbol_leading_char;
178
179 /* The pad character for file names within an archive header.  */
180  char ar_pad_char;
181
182  /* The maximum number of characters in an archive header.  */
183  unsigned char ar_max_namelen;
184
185  /* How well this target matches, used to select between various
186     possible targets when more than one target matches.  */
187  unsigned char match_priority;
188
189  /* Entries for byte swapping for data. These are different from the
190     other entry points, since they don't take a BFD as the first argument.
191     Certain other handlers could do the same.  */
192  bfd_uint64_t   (*bfd_getx64) (const void *);
193  bfd_int64_t    (*bfd_getx_signed_64) (const void *);
194  void           (*bfd_putx64) (bfd_uint64_t, void *);
195  bfd_vma        (*bfd_getx32) (const void *);
196  bfd_signed_vma (*bfd_getx_signed_32) (const void *);
197  void           (*bfd_putx32) (bfd_vma, void *);
198  bfd_vma        (*bfd_getx16) (const void *);
199  bfd_signed_vma (*bfd_getx_signed_16) (const void *);
200  void           (*bfd_putx16) (bfd_vma, void *);
201
202  /* Byte swapping for the headers.  */
203  bfd_uint64_t   (*bfd_h_getx64) (const void *);
204  bfd_int64_t    (*bfd_h_getx_signed_64) (const void *);
205  void           (*bfd_h_putx64) (bfd_uint64_t, void *);
206  bfd_vma        (*bfd_h_getx32) (const void *);
207  bfd_signed_vma (*bfd_h_getx_signed_32) (const void *);
208  void           (*bfd_h_putx32) (bfd_vma, void *);
209  bfd_vma        (*bfd_h_getx16) (const void *);
210  bfd_signed_vma (*bfd_h_getx_signed_16) (const void *);
211  void           (*bfd_h_putx16) (bfd_vma, void *);
212
213  /* Format dependent routines: these are vectors of entry points
214     within the target vector structure, one for each format to check.  */
215
216  /* Check the format of a file being read.  Return a @code{bfd_target *} or zero.  */
217  const struct bfd_target *(*_bfd_check_format[bfd_type_end]) (bfd *);
218
219  /* Set the format of a file being written.  */
220  bfd_boolean (*_bfd_set_format[bfd_type_end]) (bfd *);
221
222  /* Write cached information into a file being written, at @code{bfd_close}.  */
223  bfd_boolean (*_bfd_write_contents[bfd_type_end]) (bfd *);
224
225@end example
226The general target vector.  These vectors are initialized using the
227BFD_JUMP_TABLE macros.
228@example
229
230  /* Generic entry points.  */
231#define BFD_JUMP_TABLE_GENERIC(NAME) \
232  NAME##_close_and_cleanup, \
233  NAME##_bfd_free_cached_info, \
234  NAME##_new_section_hook, \
235  NAME##_get_section_contents, \
236  NAME##_get_section_contents_in_window
237
238  /* Called when the BFD is being closed to do any necessary cleanup.  */
239  bfd_boolean (*_close_and_cleanup) (bfd *);
240  /* Ask the BFD to free all cached information.  */
241  bfd_boolean (*_bfd_free_cached_info) (bfd *);
242  /* Called when a new section is created.  */
243  bfd_boolean (*_new_section_hook) (bfd *, sec_ptr);
244  /* Read the contents of a section.  */
245  bfd_boolean (*_bfd_get_section_contents)
246    (bfd *, sec_ptr, void *, file_ptr, bfd_size_type);
247  bfd_boolean (*_bfd_get_section_contents_in_window)
248    (bfd *, sec_ptr, bfd_window *, file_ptr, bfd_size_type);
249
250  /* Entry points to copy private data.  */
251#define BFD_JUMP_TABLE_COPY(NAME) \
252  NAME##_bfd_copy_private_bfd_data, \
253  NAME##_bfd_merge_private_bfd_data, \
254  _bfd_generic_init_private_section_data, \
255  NAME##_bfd_copy_private_section_data, \
256  NAME##_bfd_copy_private_symbol_data, \
257  NAME##_bfd_copy_private_header_data, \
258  NAME##_bfd_set_private_flags, \
259  NAME##_bfd_print_private_bfd_data
260
261  /* Called to copy BFD general private data from one object file
262     to another.  */
263  bfd_boolean (*_bfd_copy_private_bfd_data) (bfd *, bfd *);
264  /* Called to merge BFD general private data from one object file
265     to a common output file when linking.  */
266  bfd_boolean (*_bfd_merge_private_bfd_data) (bfd *, bfd *);
267  /* Called to initialize BFD private section data from one object file
268     to another.  */
269#define bfd_init_private_section_data(ibfd, isec, obfd, osec, link_info) \
270  BFD_SEND (obfd, _bfd_init_private_section_data, (ibfd, isec, obfd, osec, link_info))
271  bfd_boolean (*_bfd_init_private_section_data)
272    (bfd *, sec_ptr, bfd *, sec_ptr, struct bfd_link_info *);
273  /* Called to copy BFD private section data from one object file
274     to another.  */
275  bfd_boolean (*_bfd_copy_private_section_data)
276    (bfd *, sec_ptr, bfd *, sec_ptr);
277  /* Called to copy BFD private symbol data from one symbol
278     to another.  */
279  bfd_boolean (*_bfd_copy_private_symbol_data)
280    (bfd *, asymbol *, bfd *, asymbol *);
281  /* Called to copy BFD private header data from one object file
282     to another.  */
283  bfd_boolean (*_bfd_copy_private_header_data)
284    (bfd *, bfd *);
285  /* Called to set private backend flags.  */
286  bfd_boolean (*_bfd_set_private_flags) (bfd *, flagword);
287
288  /* Called to print private BFD data.  */
289  bfd_boolean (*_bfd_print_private_bfd_data) (bfd *, void *);
290
291  /* Core file entry points.  */
292#define BFD_JUMP_TABLE_CORE(NAME) \
293  NAME##_core_file_failing_command, \
294  NAME##_core_file_failing_signal, \
295  NAME##_core_file_matches_executable_p, \
296  NAME##_core_file_pid
297
298  char *      (*_core_file_failing_command) (bfd *);
299  int         (*_core_file_failing_signal) (bfd *);
300  bfd_boolean (*_core_file_matches_executable_p) (bfd *, bfd *);
301  int         (*_core_file_pid) (bfd *);
302
303  /* Archive entry points.  */
304#define BFD_JUMP_TABLE_ARCHIVE(NAME) \
305  NAME##_slurp_armap, \
306  NAME##_slurp_extended_name_table, \
307  NAME##_construct_extended_name_table, \
308  NAME##_truncate_arname, \
309  NAME##_write_armap, \
310  NAME##_read_ar_hdr, \
311  NAME##_write_ar_hdr, \
312  NAME##_openr_next_archived_file, \
313  NAME##_get_elt_at_index, \
314  NAME##_generic_stat_arch_elt, \
315  NAME##_update_armap_timestamp
316
317  bfd_boolean (*_bfd_slurp_armap) (bfd *);
318  bfd_boolean (*_bfd_slurp_extended_name_table) (bfd *);
319  bfd_boolean (*_bfd_construct_extended_name_table)
320    (bfd *, char **, bfd_size_type *, const char **);
321  void        (*_bfd_truncate_arname) (bfd *, const char *, char *);
322  bfd_boolean (*write_armap)
323    (bfd *, unsigned int, struct orl *, unsigned int, int);
324  void *      (*_bfd_read_ar_hdr_fn) (bfd *);
325  bfd_boolean (*_bfd_write_ar_hdr_fn) (bfd *, bfd *);
326  bfd *       (*openr_next_archived_file) (bfd *, bfd *);
327#define bfd_get_elt_at_index(b,i) BFD_SEND (b, _bfd_get_elt_at_index, (b,i))
328  bfd *       (*_bfd_get_elt_at_index) (bfd *, symindex);
329  int         (*_bfd_stat_arch_elt) (bfd *, struct stat *);
330  bfd_boolean (*_bfd_update_armap_timestamp) (bfd *);
331
332  /* Entry points used for symbols.  */
333#define BFD_JUMP_TABLE_SYMBOLS(NAME) \
334  NAME##_get_symtab_upper_bound, \
335  NAME##_canonicalize_symtab, \
336  NAME##_make_empty_symbol, \
337  NAME##_print_symbol, \
338  NAME##_get_symbol_info, \
339  NAME##_get_symbol_version_string, \
340  NAME##_bfd_is_local_label_name, \
341  NAME##_bfd_is_target_special_symbol, \
342  NAME##_get_lineno, \
343  NAME##_find_nearest_line, \
344  NAME##_find_line, \
345  NAME##_find_inliner_info, \
346  NAME##_bfd_make_debug_symbol, \
347  NAME##_read_minisymbols, \
348  NAME##_minisymbol_to_symbol
349
350  long        (*_bfd_get_symtab_upper_bound) (bfd *);
351  long        (*_bfd_canonicalize_symtab)
352    (bfd *, struct bfd_symbol **);
353  struct bfd_symbol *
354              (*_bfd_make_empty_symbol) (bfd *);
355  void        (*_bfd_print_symbol)
356    (bfd *, void *, struct bfd_symbol *, bfd_print_symbol_type);
357#define bfd_print_symbol(b,p,s,e) BFD_SEND (b, _bfd_print_symbol, (b,p,s,e))
358  void        (*_bfd_get_symbol_info)
359    (bfd *, struct bfd_symbol *, symbol_info *);
360#define bfd_get_symbol_info(b,p,e) BFD_SEND (b, _bfd_get_symbol_info, (b,p,e))
361  const char *(*_bfd_get_symbol_version_string)
362    (bfd *, struct bfd_symbol *, bfd_boolean *);
363#define bfd_get_symbol_version_string(b,s,h) BFD_SEND (b, _bfd_get_symbol_version_string, (b,s,h))
364  bfd_boolean (*_bfd_is_local_label_name) (bfd *, const char *);
365  bfd_boolean (*_bfd_is_target_special_symbol) (bfd *, asymbol *);
366  alent *     (*_get_lineno) (bfd *, struct bfd_symbol *);
367  bfd_boolean (*_bfd_find_nearest_line)
368    (bfd *, struct bfd_symbol **, struct bfd_section *, bfd_vma,
369     const char **, const char **, unsigned int *, unsigned int *);
370  bfd_boolean (*_bfd_find_line)
371    (bfd *, struct bfd_symbol **, struct bfd_symbol *,
372     const char **, unsigned int *);
373  bfd_boolean (*_bfd_find_inliner_info)
374    (bfd *, const char **, const char **, unsigned int *);
375 /* Back-door to allow format-aware applications to create debug symbols
376    while using BFD for everything else.  Currently used by the assembler
377    when creating COFF files.  */
378  asymbol *   (*_bfd_make_debug_symbol)
379    (bfd *, void *, unsigned long size);
380#define bfd_read_minisymbols(b, d, m, s) \
381  BFD_SEND (b, _read_minisymbols, (b, d, m, s))
382  long        (*_read_minisymbols)
383    (bfd *, bfd_boolean, void **, unsigned int *);
384#define bfd_minisymbol_to_symbol(b, d, m, f) \
385  BFD_SEND (b, _minisymbol_to_symbol, (b, d, m, f))
386  asymbol *   (*_minisymbol_to_symbol)
387    (bfd *, bfd_boolean, const void *, asymbol *);
388
389  /* Routines for relocs.  */
390#define BFD_JUMP_TABLE_RELOCS(NAME) \
391  NAME##_get_reloc_upper_bound, \
392  NAME##_canonicalize_reloc, \
393  NAME##_bfd_reloc_type_lookup, \
394  NAME##_bfd_reloc_name_lookup
395
396  long        (*_get_reloc_upper_bound) (bfd *, sec_ptr);
397  long        (*_bfd_canonicalize_reloc)
398    (bfd *, sec_ptr, arelent **, struct bfd_symbol **);
399  /* See documentation on reloc types.  */
400  reloc_howto_type *
401              (*reloc_type_lookup) (bfd *, bfd_reloc_code_real_type);
402  reloc_howto_type *
403              (*reloc_name_lookup) (bfd *, const char *);
404
405
406  /* Routines used when writing an object file.  */
407#define BFD_JUMP_TABLE_WRITE(NAME) \
408  NAME##_set_arch_mach, \
409  NAME##_set_section_contents
410
411  bfd_boolean (*_bfd_set_arch_mach)
412    (bfd *, enum bfd_architecture, unsigned long);
413  bfd_boolean (*_bfd_set_section_contents)
414    (bfd *, sec_ptr, const void *, file_ptr, bfd_size_type);
415
416  /* Routines used by the linker.  */
417#define BFD_JUMP_TABLE_LINK(NAME) \
418  NAME##_sizeof_headers, \
419  NAME##_bfd_get_relocated_section_contents, \
420  NAME##_bfd_relax_section, \
421  NAME##_bfd_link_hash_table_create, \
422  NAME##_bfd_link_add_symbols, \
423  NAME##_bfd_link_just_syms, \
424  NAME##_bfd_copy_link_hash_symbol_type, \
425  NAME##_bfd_final_link, \
426  NAME##_bfd_link_split_section, \
427  NAME##_bfd_gc_sections, \
428  NAME##_bfd_lookup_section_flags, \
429  NAME##_bfd_merge_sections, \
430  NAME##_bfd_is_group_section, \
431  NAME##_bfd_discard_group, \
432  NAME##_section_already_linked, \
433  NAME##_bfd_define_common_symbol
434
435  int         (*_bfd_sizeof_headers) (bfd *, struct bfd_link_info *);
436  bfd_byte *  (*_bfd_get_relocated_section_contents)
437    (bfd *, struct bfd_link_info *, struct bfd_link_order *,
438     bfd_byte *, bfd_boolean, struct bfd_symbol **);
439
440  bfd_boolean (*_bfd_relax_section)
441    (bfd *, struct bfd_section *, struct bfd_link_info *, bfd_boolean *);
442
443  /* Create a hash table for the linker.  Different backends store
444     different information in this table.  */
445  struct bfd_link_hash_table *
446              (*_bfd_link_hash_table_create) (bfd *);
447
448  /* Add symbols from this object file into the hash table.  */
449  bfd_boolean (*_bfd_link_add_symbols) (bfd *, struct bfd_link_info *);
450
451  /* Indicate that we are only retrieving symbol values from this section.  */
452  void        (*_bfd_link_just_syms) (asection *, struct bfd_link_info *);
453
454  /* Copy the symbol type and other attributes for a linker script
455     assignment of one symbol to another.  */
456#define bfd_copy_link_hash_symbol_type(b, t, f) \
457  BFD_SEND (b, _bfd_copy_link_hash_symbol_type, (b, t, f))
458  void (*_bfd_copy_link_hash_symbol_type)
459    (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
460
461  /* Do a link based on the link_order structures attached to each
462     section of the BFD.  */
463  bfd_boolean (*_bfd_final_link) (bfd *, struct bfd_link_info *);
464
465  /* Should this section be split up into smaller pieces during linking.  */
466  bfd_boolean (*_bfd_link_split_section) (bfd *, struct bfd_section *);
467
468  /* Remove sections that are not referenced from the output.  */
469  bfd_boolean (*_bfd_gc_sections) (bfd *, struct bfd_link_info *);
470
471  /* Sets the bitmask of allowed and disallowed section flags.  */
472  bfd_boolean (*_bfd_lookup_section_flags) (struct bfd_link_info *,
473                                            struct flag_info *,
474                                            asection *);
475
476  /* Attempt to merge SEC_MERGE sections.  */
477  bfd_boolean (*_bfd_merge_sections) (bfd *, struct bfd_link_info *);
478
479  /* Is this section a member of a group?  */
480  bfd_boolean (*_bfd_is_group_section) (bfd *, const struct bfd_section *);
481
482  /* Discard members of a group.  */
483  bfd_boolean (*_bfd_discard_group) (bfd *, struct bfd_section *);
484
485  /* Check if SEC has been already linked during a reloceatable or
486     final link.  */
487  bfd_boolean (*_section_already_linked) (bfd *, asection *,
488                                          struct bfd_link_info *);
489
490  /* Define a common symbol.  */
491  bfd_boolean (*_bfd_define_common_symbol) (bfd *, struct bfd_link_info *,
492                                            struct bfd_link_hash_entry *);
493
494  /* Routines to handle dynamic symbols and relocs.  */
495#define BFD_JUMP_TABLE_DYNAMIC(NAME) \
496  NAME##_get_dynamic_symtab_upper_bound, \
497  NAME##_canonicalize_dynamic_symtab, \
498  NAME##_get_synthetic_symtab, \
499  NAME##_get_dynamic_reloc_upper_bound, \
500  NAME##_canonicalize_dynamic_reloc
501
502  /* Get the amount of memory required to hold the dynamic symbols.  */
503  long        (*_bfd_get_dynamic_symtab_upper_bound) (bfd *);
504  /* Read in the dynamic symbols.  */
505  long        (*_bfd_canonicalize_dynamic_symtab)
506    (bfd *, struct bfd_symbol **);
507  /* Create synthetized symbols.  */
508  long        (*_bfd_get_synthetic_symtab)
509    (bfd *, long, struct bfd_symbol **, long, struct bfd_symbol **,
510     struct bfd_symbol **);
511  /* Get the amount of memory required to hold the dynamic relocs.  */
512  long        (*_bfd_get_dynamic_reloc_upper_bound) (bfd *);
513  /* Read in the dynamic relocs.  */
514  long        (*_bfd_canonicalize_dynamic_reloc)
515    (bfd *, arelent **, struct bfd_symbol **);
516
517@end example
518A pointer to an alternative bfd_target in case the current one is not
519satisfactory.  This can happen when the target cpu supports both big
520and little endian code, and target chosen by the linker has the wrong
521endianness.  The function open_output() in ld/ldlang.c uses this field
522to find an alternative output format that is suitable.
523@example
524  /* Opposite endian version of this target.  */
525  const struct bfd_target * alternative_target;
526
527  /* Data for use by back-end routines, which isn't
528     generic enough to belong in this structure.  */
529  const void *backend_data;
530
531@} bfd_target;
532
533@end example
534
535@findex bfd_set_default_target
536@subsubsection @code{bfd_set_default_target}
537@strong{Synopsis}
538@example
539bfd_boolean bfd_set_default_target (const char *name);
540@end example
541@strong{Description}@*
542Set the default target vector to use when recognizing a BFD.
543This takes the name of the target, which may be a BFD target
544name or a configuration triplet.
545
546@findex bfd_find_target
547@subsubsection @code{bfd_find_target}
548@strong{Synopsis}
549@example
550const bfd_target *bfd_find_target (const char *target_name, bfd *abfd);
551@end example
552@strong{Description}@*
553Return a pointer to the transfer vector for the object target
554named @var{target_name}.  If @var{target_name} is @code{NULL},
555choose the one in the environment variable @code{GNUTARGET}; if
556that is null or not defined, then choose the first entry in the
557target list.  Passing in the string "default" or setting the
558environment variable to "default" will cause the first entry in
559the target list to be returned, and "target_defaulted" will be
560set in the BFD if @var{abfd} isn't @code{NULL}.  This causes
561@code{bfd_check_format} to loop over all the targets to find the
562one that matches the file being read.
563
564@findex bfd_get_target_info
565@subsubsection @code{bfd_get_target_info}
566@strong{Synopsis}
567@example
568const bfd_target *bfd_get_target_info (const char *target_name,
569    bfd *abfd,
570    bfd_boolean *is_bigendian,
571    int *underscoring,
572    const char **def_target_arch);
573@end example
574@strong{Description}@*
575Return a pointer to the transfer vector for the object target
576named @var{target_name}.  If @var{target_name} is @code{NULL},
577choose the one in the environment variable @code{GNUTARGET}; if
578that is null or not defined, then choose the first entry in the
579target list.  Passing in the string "default" or setting the
580environment variable to "default" will cause the first entry in
581the target list to be returned, and "target_defaulted" will be
582set in the BFD if @var{abfd} isn't @code{NULL}.  This causes
583@code{bfd_check_format} to loop over all the targets to find the
584one that matches the file being read.
585If @var{is_bigendian} is not @code{NULL}, then set this value to target's
586endian mode. True for big-endian, FALSE for little-endian or for
587invalid target.
588If @var{underscoring} is not @code{NULL}, then set this value to target's
589underscoring mode. Zero for none-underscoring, -1 for invalid target,
590else the value of target vector's symbol underscoring.
591If @var{def_target_arch} is not @code{NULL}, then set it to the architecture
592string specified by the target_name.
593
594@findex bfd_target_list
595@subsubsection @code{bfd_target_list}
596@strong{Synopsis}
597@example
598const char ** bfd_target_list (void);
599@end example
600@strong{Description}@*
601Return a freshly malloced NULL-terminated
602vector of the names of all the valid BFD targets. Do not
603modify the names.
604
605@findex bfd_seach_for_target
606@subsubsection @code{bfd_seach_for_target}
607@strong{Synopsis}
608@example
609const bfd_target *bfd_search_for_target
610   (int (*search_func) (const bfd_target *, void *),
611    void *);
612@end example
613@strong{Description}@*
614Return a pointer to the first transfer vector in the list of
615transfer vectors maintained by BFD that produces a non-zero
616result when passed to the function @var{search_func}.  The
617parameter @var{data} is passed, unexamined, to the search
618function.
619
620@findex bfd_flavour_name
621@subsubsection @code{bfd_flavour_name}
622@strong{Synopsis}
623@example
624const char *bfd_flavour_name (enum bfd_flavour flavour);
625@end example
626@strong{Description}@*
627Return the string form of @var{flavour}.
628
629