1 /* Generic target-file-type support for the BFD library.
2 Copyright 1990, 91, 92, 93, 1994 Free Software Foundation, Inc.
3 Written by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
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 2 of the License, or
10 (at your option) any later version.
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.
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., 675 Mass Ave, Cambridge, MA 02139, USA. */
30 Each port of BFD to a different machine requries the creation
31 of a target back end. All the back end provides to the root
32 part of BFD is a structure containing pointers to functions
33 which perform certain low level operations on files. BFD
34 translates the applications's requests through a pointer into
35 calls to the back end routines.
37 When a file is opened with <<bfd_openr>>, its format and
38 target are unknown. BFD uses various mechanisms to determine
39 how to interpret the file. The operations performed are:
41 o Create a BFD by calling the internal routine
42 <<_bfd_new_bfd>>, then call <<bfd_find_target>> with the
43 target string supplied to <<bfd_openr>> and the new BFD pointer.
45 o If a null target string was provided to <<bfd_find_target>>,
46 look up the environment variable <<GNUTARGET>> and use
47 that as the target string.
49 o If the target string is still <<NULL>>, or the target string is
50 <<default>>, then use the first item in the target vector
51 as the target type, and set <<target_defaulted>> in the BFD to
52 cause <<bfd_check_format>> to loop through all the targets.
53 @xref{bfd_target}. @xref{Formats}.
55 o Otherwise, inspect the elements in the target vector
56 one by one, until a match on target name is found. When found,
59 o Otherwise return the error <<bfd_error_invalid_target>> to
62 o <<bfd_openr>> attempts to open the file using
63 <<bfd_open_file>>, and returns the BFD.
65 Once the BFD has been opened and the target selected, the file
66 format may be determined. This is done by calling
67 <<bfd_check_format>> on the BFD with a suggested format.
68 If <<target_defaulted>> has been set, each possible target
69 type is tried to see if it recognizes the specified format.
70 <<bfd_check_format>> returns <<true>> when the caller guesses right.
80 bfd_target, , Targets, Targets
86 This structure contains everything that BFD knows about a
87 target. It includes things like its byte order, name, and which
88 routines to call to do various operations.
90 Every BFD points to a target structure with its <<xvec>>
93 The macros below are used to dispatch to functions through the
94 <<bfd_target>> vector. They are used in a number of macros further
95 down in @file{bfd.h}, and are also used when calling various
96 routines by hand inside the BFD implementation. The @var{arglist}
97 argument must be parenthesized; it contains all the arguments
98 to the called function.
100 They make the documentation (more) unpleasant to read, so if
101 someone wants to fix this and not break the above, please do.
103 .#define BFD_SEND(bfd, message, arglist) \
104 . ((*((bfd)->xvec->message)) arglist)
106 .#ifdef DEBUG_BFD_SEND
108 .#define BFD_SEND(bfd, message, arglist) \
109 . (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
110 . ((*((bfd)->xvec->message)) arglist) : \
111 . (bfd_assert (__FILE__,__LINE__), NULL))
114 For operations which index on the BFD format:
116 .#define BFD_SEND_FMT(bfd, message, arglist) \
117 . (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
119 .#ifdef DEBUG_BFD_SEND
121 .#define BFD_SEND_FMT(bfd, message, arglist) \
122 . (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
123 . (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) : \
124 . (bfd_assert (__FILE__,__LINE__), NULL))
127 This is the structure which defines the type of BFD this is. The
128 <<xvec>> member of the struct <<bfd>> itself points here. Each
129 module that implements access to a different target under BFD,
130 defines one of these.
133 FIXME, these names should be rationalised with the names of
134 the entry points which call them. Too bad we can't have one
135 macro to define them both!
138 . bfd_target_unknown_flavour,
139 . bfd_target_aout_flavour,
140 . bfd_target_coff_flavour,
141 . bfd_target_ecoff_flavour,
142 . bfd_target_elf_flavour,
143 . bfd_target_ieee_flavour,
144 . bfd_target_nlm_flavour,
145 . bfd_target_oasys_flavour,
146 . bfd_target_tekhex_flavour,
147 . bfd_target_srec_flavour,
148 . bfd_target_som_flavour,
149 . bfd_target_os9k_flavour};
151 .{* Forward declaration. *}
152 .typedef struct bfd_link_info _bfd_link_info;
154 .typedef struct bfd_target
157 Identifies the kind of target, e.g., SunOS4, Ultrix, etc.
161 The "flavour" of a back end is a general indication about the contents
164 . enum bfd_flavour flavour;
166 The order of bytes within the data area of a file.
168 . boolean byteorder_big_p;
170 The order of bytes within the header parts of a file.
172 . boolean header_byteorder_big_p;
174 A mask of all the flags which an executable may have set -
175 from the set <<NO_FLAGS>>, <<HAS_RELOC>>, ...<<D_PAGED>>.
177 . flagword object_flags;
179 A mask of all the flags which a section may have set - from
180 the set <<SEC_NO_FLAGS>>, <<SEC_ALLOC>>, ...<<SET_NEVER_LOAD>>.
182 . flagword section_flags;
184 The character normally found at the front of a symbol
185 (if any), perhaps `_'.
187 . char symbol_leading_char;
189 The pad character for file names within an archive header.
193 The maximum number of characters in an archive header.
195 . unsigned short ar_max_namelen;
197 The minimum alignment restriction for any section.
199 . unsigned int align_power_min;
201 Entries for byte swapping for data. These are different from the other
202 entry points, since they don't take a BFD asthe first argument.
203 Certain other handlers could do the same.
205 . bfd_vma (*bfd_getx64) PARAMS ((const bfd_byte *));
206 . bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
207 . void (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
208 . bfd_vma (*bfd_getx32) PARAMS ((const bfd_byte *));
209 . bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
210 . void (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
211 . bfd_vma (*bfd_getx16) PARAMS ((const bfd_byte *));
212 . bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
213 . void (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
215 Byte swapping for the headers
217 . bfd_vma (*bfd_h_getx64) PARAMS ((const bfd_byte *));
218 . bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
219 . void (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
220 . bfd_vma (*bfd_h_getx32) PARAMS ((const bfd_byte *));
221 . bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
222 . void (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
223 . bfd_vma (*bfd_h_getx16) PARAMS ((const bfd_byte *));
224 . bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
225 . void (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
227 Format dependent routines: these are vectors of entry points
228 within the target vector structure, one for each format to check.
230 Check the format of a file being read. Return a <<bfd_target *>> or zero.
232 . struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
234 Set the format of a file being written.
236 . boolean (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
238 Write cached information into a file being written, at <<bfd_close>>.
240 . boolean (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
242 The following functions are defined in <<JUMP_TABLE>>. The idea is
243 that the back end writer of <<foo>> names all the routines
244 <<foo_>>@var{entry_point}; <<JUMP_TABLE>> will build the entries
245 in this structure in the right order.
247 Core file entry points.
249 . char * (*_core_file_failing_command) PARAMS ((bfd *));
250 . int (*_core_file_failing_signal) PARAMS ((bfd *));
251 . boolean (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
253 Archive entry points.
255 . boolean (*_bfd_slurp_armap) PARAMS ((bfd *));
256 . boolean (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
257 . void (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
258 . boolean (*write_armap) PARAMS ((bfd *arch,
259 . unsigned int elength,
261 . unsigned int orl_count,
266 . boolean (*_close_and_cleanup) PARAMS ((bfd *));
267 . boolean (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
268 . file_ptr, bfd_size_type));
269 . boolean (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
270 . file_ptr, bfd_size_type));
271 . boolean (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
273 Symbols and relocations.
275 . unsigned int (*_get_symtab_upper_bound) PARAMS ((bfd *));
276 . unsigned int (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
277 . struct symbol_cache_entry **));
278 . unsigned int (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
279 . unsigned int (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
280 . struct symbol_cache_entry **));
281 . struct symbol_cache_entry *
282 . (*_bfd_make_empty_symbol) PARAMS ((bfd *));
283 . void (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
284 . struct symbol_cache_entry *,
285 . bfd_print_symbol_type));
286 .#define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
287 . void (*_bfd_get_symbol_info) PARAMS ((bfd *,
288 . struct symbol_cache_entry *,
290 .#define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
292 . alent * (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
294 . boolean (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
297 . bfd * (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
299 . boolean (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
300 . struct sec *section, struct symbol_cache_entry **symbols,
301 . bfd_vma offset, CONST char **file, CONST char **func,
302 . unsigned int *line));
304 . int (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
306 . int (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
308 . void (*_bfd_debug_info_start) PARAMS ((bfd *));
309 . void (*_bfd_debug_info_end) PARAMS ((bfd *));
310 . void (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
312 . bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
313 . struct bfd_link_info *, struct bfd_link_order *,
314 . bfd_byte *data, boolean relocateable,
315 . struct symbol_cache_entry **));
317 . boolean (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
318 . struct bfd_link_info *, struct symbol_cache_entry **));
320 . {* See documentation on reloc types. *}
321 . CONST struct reloc_howto_struct *
322 . (*reloc_type_lookup) PARAMS ((bfd *abfd,
323 . bfd_reloc_code_real_type code));
325 . {* Back-door to allow format-aware applications to create debug symbols
326 . while using BFD for everything else. Currently used by the assembler
327 . when creating COFF files. *}
328 . asymbol * (*_bfd_make_debug_symbol) PARAMS ((
331 . unsigned long size));
333 . {* Create a hash table for the linker. Different backends store
334 . different information in this table. *}
335 . struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
337 . {* Add symbols from this object file into the hash table. *}
338 . boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
340 . {* Do a link based on the link_order structures attached to each
341 . section of the BFD. *}
342 . boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
345 Data for use by back-end routines, which isn't generic enough to belong
353 /* All known xvecs (even those that don't compile on all systems).
354 Alphabetized for easy reference.
355 They are listed a second time below, since
356 we can't intermix extern's and initializers. */
357 extern bfd_target a29kcoff_big_vec;
358 extern bfd_target a_out_adobe_vec;
359 extern bfd_target aout_mips_big_vec;
360 extern bfd_target aout_mips_little_vec;
361 extern bfd_target apollocoff_vec;
362 extern bfd_target b_out_vec_big_host;
363 extern bfd_target b_out_vec_little_host;
364 extern bfd_target bfd_elf32_big_generic_vec;
365 extern bfd_target bfd_elf32_bigmips_vec;
366 extern bfd_target bfd_elf32_hppa_vec;
367 extern bfd_target bfd_elf32_i386_vec;
368 extern bfd_target bfd_elf32_i860_vec;
369 extern bfd_target bfd_elf32_little_generic_vec;
370 extern bfd_target bfd_elf32_littlemips_vec;
371 extern bfd_target bfd_elf32_m68k_vec;
372 extern bfd_target bfd_elf32_m88k_vec;
373 extern bfd_target bfd_elf32_powerpc_vec;
374 extern bfd_target bfd_elf32_sparc_vec;
375 extern bfd_target bfd_elf64_big_generic_vec;
376 extern bfd_target bfd_elf64_little_generic_vec;
377 /* start-sanitize-v9 */
378 extern bfd_target bfd_elf64_sparc_vec;
379 /* end-sanitize-v9 */
380 extern bfd_target demo_64_vec;
381 extern bfd_target ecoff_big_vec;
382 extern bfd_target ecoff_little_vec;
383 extern bfd_target ecoffalpha_little_vec;
384 extern bfd_target h8300coff_vec;
385 extern bfd_target h8500coff_vec;
386 extern bfd_target host_aout_vec;
387 extern bfd_target hp300bsd_vec;
388 extern bfd_target hp300hpux_vec;
389 extern bfd_target som_vec;
390 extern bfd_target i386aout_vec;
391 extern bfd_target i386bsd_vec;
392 extern bfd_target i386os9k_vec;
393 extern bfd_target netbsd386_vec;
394 extern bfd_target i386coff_vec;
395 extern bfd_target i386linux_vec;
396 extern bfd_target i386lynx_aout_vec;
397 extern bfd_target i386lynx_coff_vec;
398 extern bfd_target i386mach3_vec;
399 extern bfd_target icoff_big_vec;
400 extern bfd_target icoff_little_vec;
401 extern bfd_target ieee_vec;
402 extern bfd_target m68kcoff_vec;
403 extern bfd_target m68kcoffun_vec;
404 extern bfd_target m68klynx_aout_vec;
405 extern bfd_target m68klynx_coff_vec;
406 extern bfd_target m88kbcs_vec;
407 extern bfd_target newsos3_vec;
408 extern bfd_target nlm32_i386_vec;
409 extern bfd_target nlm32_sparc_vec;
410 extern bfd_target nlm32_alpha_vec;
411 /*start-sanitize-powerpc-netware*/
412 extern bfd_target nlm32_powerpc_vec;
413 /*end-sanitize-powerpc-netware*/
414 extern bfd_target oasys_vec;
415 extern bfd_target rs6000coff_vec;
416 extern bfd_target shcoff_vec;
417 extern bfd_target sparclynx_aout_vec;
418 extern bfd_target sparclynx_coff_vec;
419 extern bfd_target sparccoff_vec;
420 extern bfd_target sunos_big_vec;
421 extern bfd_target tekhex_vec;
422 extern bfd_target we32kcoff_vec;
423 extern bfd_target z8kcoff_vec;
425 /* srec is always included. */
426 extern bfd_target srec_vec;
427 extern bfd_target symbolsrec_vec;
429 /* All of the xvecs for core files. */
430 extern bfd_target aix386_core_vec;
431 extern bfd_target hpux_core_vec;
432 extern bfd_target hppabsd_core_vec;
433 extern bfd_target irix_core_vec;
434 extern bfd_target osf_core_vec;
435 extern bfd_target sco_core_vec;
436 extern bfd_target trad_core_vec;
437 extern bfd_target ptrace_core_vec;
439 bfd_target *bfd_target_vector[] = {
445 #else /* not SELECT_VECS */
447 #ifdef DEFAULT_VECTOR
450 /* This list is alphabetized to make it easy to compare
451 with other vector lists -- the decls above and
452 the case statement in configure.in.
453 Vectors that don't compile on all systems, or aren't finished,
454 should have an entry here with #if 0 around it, to show that
455 it wasn't omitted by mistake. */
458 #if 0 /* No one seems to use this. */
461 &aout_mips_little_vec,
463 &b_out_vec_little_host,
465 /* This, and other vectors, may not be used in any *.mt configuration.
466 But that does not mean they are unnecessary. If configured
467 --with-targets=all, objdump or gdb should be able to examine
468 the file even if we don't recognize the machine type. */
469 &bfd_elf32_big_generic_vec,
470 &bfd_elf32_bigmips_vec,
474 &bfd_elf32_little_generic_vec,
475 &bfd_elf32_littlemips_vec,
478 &bfd_elf32_sparc_vec,
479 #ifdef BFD64 /* No one seems to use this. */
480 &bfd_elf64_big_generic_vec,
481 &bfd_elf64_little_generic_vec,
483 /* start-sanitize-v9 */
485 &bfd_elf64_sparc_vec,
487 /* end-sanitize-v9 */
489 &demo_64_vec, /* Only compiled if host has long-long support */
494 &ecoffalpha_little_vec,
499 /* Since a.out files lack decent magic numbers, no way to recognize
500 which kind of a.out file it is. */
503 #if 0 /* Clashes with sunos_big_vec magic no. */
507 #if defined (HOST_HPPAHPUX) || defined (HOST_HPPABSD) || defined (HOST_HPPAOSF)
515 /* Since a.out files lack decent magic numbers, no way to recognize
516 which kind of a.out file it is. */
537 /* We have no oasys tools anymore, so we can't test any of this
538 anymore. If you want to test the stuff yourself, go ahead...
540 Worse, since there is no magic number for archives, there
541 can be annoying target mis-matches. */
555 #endif /* not SELECT_VECS */
557 /* Always support S-records, for convenience. */
561 /* Add any required traditional-core-file-handler. */
586 NULL /* end of list marker */
589 /* bfd_default_vector[0] contains either the address of the default vector,
590 if there is one, or zero if there isn't. */
592 bfd_target *bfd_default_vector[] = {
593 #ifdef DEFAULT_VECTOR
599 /* When there is an ambiguous match, bfd_check_format_matches puts the
600 names of the matching targets in an array. This variable is the maximum
601 number of entries that the array could possibly need. */
602 CONST size_t _bfd_target_vector_entries = sizeof(bfd_target_vector)/sizeof(*bfd_target_vector);
609 bfd_target *bfd_find_target(CONST char *target_name, bfd *abfd);
612 Return a pointer to the transfer vector for the object target
613 named @var{target_name}. If @var{target_name} is <<NULL>>, choose the
614 one in the environment variable <<GNUTARGET>>; if that is null or not
615 defined, then choose the first entry in the target list.
616 Passing in the string "default" or setting the environment
617 variable to "default" will cause the first entry in the target
618 list to be returned, and "target_defaulted" will be set in the
619 BFD. This causes <<bfd_check_format>> to loop over all the
620 targets to find the one that matches the file being read.
624 bfd_find_target (target_name, abfd)
625 CONST char *target_name;
629 extern char *getenv ();
630 CONST char *targname = (target_name ? target_name :
631 (CONST char *) getenv ("GNUTARGET"));
633 /* This is safe; the vector cannot be null */
634 if (targname == NULL || !strcmp (targname, "default")) {
635 abfd->target_defaulted = true;
636 return abfd->xvec = bfd_target_vector[0];
639 abfd->target_defaulted = false;
641 for (target = &bfd_target_vector[0]; *target != NULL; target++) {
642 if (!strcmp (targname, (*target)->name))
643 return abfd->xvec = *target;
646 bfd_set_error (bfd_error_invalid_target);
656 CONST char **bfd_target_list(void);
659 Return a freshly malloced NULL-terminated
660 vector of the names of all the valid BFD targets. Do not
669 #ifdef NATIVE_HPPAHPUX_COMPILER
670 /* The native compiler on the HP9000/700 has a bug which causes it
671 to loop endlessly when compiling this file. This avoids it. */
675 CONST char **name_list, **name_ptr;
677 for (target = &bfd_target_vector[0]; *target != NULL; target++)
680 name_ptr = name_list = (CONST char **)
681 bfd_zmalloc ((vec_length + 1) * sizeof (char **));
683 if (name_list == NULL) {
684 bfd_set_error (bfd_error_no_memory);
688 for (target = &bfd_target_vector[0]; *target != NULL; target++)
689 *(name_ptr++) = (*target)->name;