1 /* A -*- C -*- header file for the bfd library
2 Copyright 1990, 1991 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of BFD, the Binary File Diddler.
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. */
21 /* bfd.h -- The only header file required by users of the bfd library
23 This file is generated from various .c files, if you change it, your
26 All the prototypes and definitions following the comment "THE FOLLOWING
27 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
28 BFD. If you change it, someone oneday will extract it from the source
29 again, and your changes will be lost. To save yourself from this bind,
30 change the definitions in the source in the bfd directory. Type "make
31 docs" and then "make headers" in that directory, and magically this file
32 will change to reflect your changes.
34 If you don't have the tools to perform the extraction, then you are
35 safe from someone on your system trampling over your header files.
36 You should still maintain the equivalence between the source and this
37 file though; every change you make to the .c file should be reflected
40 #ifndef __BFD_H_SEEN__
41 #define __BFD_H_SEEN__
46 /* Make it easier to declare prototypes (puts conditional here) */
49 # define PROTO(type, name, arglist) type name arglist
51 # define PROTO(type, name, arglist) type name ()
55 #define BFD_VERSION "1.15"
57 /* forward declaration */
58 typedef struct _bfd bfd
;
60 /* General rules: functions which are boolean return true on success
61 and false on failure (unless they're a predicate). -- bfd.doc */
62 /* I'm sure this is going to break something and someone is going to
63 force me to change it. */
64 typedef enum boolean
{false, true} boolean
;
66 /* Try to avoid breaking stuff */
67 typedef long int file_ptr
;
69 /* Support for different sizes of target format ints and addresses */
72 typedef HOST_64_BIT rawdata_offset
;
73 typedef HOST_64_BIT bfd_vma
;
74 typedef HOST_64_BIT bfd_word
;
75 typedef HOST_64_BIT bfd_offset
;
76 typedef HOST_64_BIT bfd_size_type
;
77 typedef HOST_64_BIT symvalue
;
78 typedef HOST_64_BIT bfd_64_type
;
79 #define fprintf_vma(s,x) \
80 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
81 #define printf_vma(x) \
82 printf( "%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
84 typedef struct {int a
,b
;} bfd_64_type
;
85 typedef unsigned long rawdata_offset
;
86 typedef unsigned long bfd_vma
;
87 typedef unsigned long bfd_offset
;
88 typedef unsigned long bfd_word
;
89 typedef unsigned long bfd_size
;
90 typedef unsigned long symvalue
;
91 typedef unsigned long bfd_size_type
;
92 #define printf_vma(x) printf( "%08lx", x)
93 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
96 typedef unsigned int flagword
; /* 32 bits of flags */
100 typedef enum bfd_format
{
101 bfd_unknown
= 0, /* file format is unknown */
102 bfd_object
, /* linker/assember/compiler output */
103 bfd_archive
, /* object archive file */
104 bfd_core
, /* core dump */
105 bfd_type_end
} /* marks the end; don't use it! */
108 /* Object file flag values */
110 #define HAS_RELOC 001
112 #define HAS_LINENO 004
113 #define HAS_DEBUG 010
115 #define HAS_LOCALS 040
121 /* symbols and relocation */
123 typedef unsigned long symindex
;
125 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
127 typedef enum bfd_symclass
{
128 bfd_symclass_unknown
= 0,
129 bfd_symclass_fcommon
, /* fortran common symbols */
130 bfd_symclass_global
, /* global symbol, what a surprise */
131 bfd_symclass_debugger
, /* some debugger symbol */
132 bfd_symclass_undefined
/* none known */
136 typedef int symtype
; /* Who knows, yet? */
139 /* general purpose part of a symbol;
140 target specific parts will be found in libcoff.h, liba.out.h etc */
143 #define bfd_get_section(x) ((x)->section)
144 #define bfd_get_output_section(x) ((x)->section->output_section)
145 #define bfd_set_section(x,y) ((x)->section) = (y)
146 #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0)
147 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value)
148 #define bfd_asymbol_name(x) ((x)->name)
150 /* This is a type pun with struct ranlib on purpose! */
151 typedef struct carsym
{
153 file_ptr file_offset
; /* look here to find the file */
154 } carsym
; /* to make these you call a carsymogen */
157 /* Used in generating armaps. Perhaps just a forward definition would do? */
158 struct orl
{ /* output ranlib */
159 char **name
; /* symbol name */
160 file_ptr pos
; /* bfd* or file position */
161 int namidx
; /* index into string table */
166 /* Linenumber stuff */
167 typedef struct lineno_cache_entry
{
168 unsigned int line_number
; /* Linenumber from start of function*/
170 struct symbol_cache_entry
*sym
; /* Function name */
171 unsigned long offset
; /* Offset into section */
175 /* object and core file sections */
178 #define align_power(addr, align) \
179 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
181 typedef struct sec
*sec_ptr
;
183 #define bfd_section_name(bfd, ptr) ((ptr)->name)
184 #define bfd_section_size(bfd, ptr) ((ptr)->size)
185 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
186 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
187 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags)
188 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
190 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true)
191 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
192 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
194 typedef struct stat stat_type
;
196 /** Error handling */
198 typedef enum bfd_error
{
199 no_error
= 0, system_call_error
, invalid_target
,
200 wrong_format
, invalid_operation
, no_memory
,
201 no_symbols
, no_relocation_info
,
202 no_more_archived_files
, malformed_archive
,
203 symbol_not_found
, file_not_recognized
,
204 file_ambiguously_recognized
, no_contents
,
205 bfd_error_nonrepresentable_section
,
206 invalid_error_code
} bfd_ec
;
208 extern bfd_ec bfd_error
;
210 typedef struct bfd_error_vector
{
211 PROTO(void,(* nonrepresentable_section
),(CONST bfd
*CONST abfd
,
212 CONST
char *CONST name
));
213 } bfd_error_vector_type
;
215 PROTO (char *, bfd_errmsg
, ());
216 PROTO (void, bfd_perror
, (CONST
char *message
));
219 typedef enum bfd_print_symbol
221 bfd_print_symbol_name_enum
,
222 bfd_print_symbol_type_enum
,
223 bfd_print_symbol_all_enum
224 } bfd_print_symbol_enum_type
;
228 /* The code that implements targets can initialize a jump table with this
229 macro. It must name all its routines the same way (a prefix plus
230 the standard routine suffix), or it must #define the routines that
231 are not so named, before calling JUMP_TABLE in the initializer. */
233 /* Semi-portable string concatenation in cpp */
236 #define CAT(a,b) a##b
238 #define CAT(a,b) a/**/b
242 #define JUMP_TABLE(NAME)\
243 CAT(NAME,_core_file_failing_command),\
244 CAT(NAME,_core_file_failing_signal),\
245 CAT(NAME,_core_file_matches_executable_p),\
246 CAT(NAME,_slurp_armap),\
247 CAT(NAME,_slurp_extended_name_table),\
248 CAT(NAME,_truncate_arname),\
249 CAT(NAME,_write_armap),\
250 CAT(NAME,_close_and_cleanup), \
251 CAT(NAME,_set_section_contents),\
252 CAT(NAME,_get_section_contents),\
253 CAT(NAME,_new_section_hook),\
254 CAT(NAME,_get_symtab_upper_bound),\
255 CAT(NAME,_get_symtab),\
256 CAT(NAME,_get_reloc_upper_bound),\
257 CAT(NAME,_canonicalize_reloc),\
258 CAT(NAME,_make_empty_symbol),\
259 CAT(NAME,_print_symbol),\
260 CAT(NAME,_get_lineno),\
261 CAT(NAME,_set_arch_mach),\
262 CAT(NAME,_openr_next_archived_file),\
263 CAT(NAME,_find_nearest_line),\
264 CAT(NAME,_generic_stat_arch_elt),\
265 CAT(NAME,_sizeof_headers),\
266 CAT(NAME,_bfd_debug_info_start),\
267 CAT(NAME,_bfd_debug_info_end),\
268 CAT(NAME,_bfd_debug_info_accumulate)
270 #define COFF_SWAP_TABLE coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in,
272 /* User program access to BFD facilities */
274 extern CONST
short _bfd_host_big_endian
;
275 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
279 /* Cast from const char * to char * so that caller can assign to
280 a char * without a warning. */
281 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
282 #define bfd_get_format(abfd) ((abfd)->format)
283 #define bfd_get_target(abfd) ((abfd)->xvec->name)
284 #define bfd_get_file_flags(abfd) ((abfd)->flags)
285 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
286 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
287 #define bfd_my_archive(abfd) ((abfd)->my_archive);
288 #define bfd_has_map(abfd) ((abfd)->has_armap)
289 #define bfd_header_twiddle_required(abfd) \
290 ((((abfd)->xvec->header_byteorder_big_p) \
291 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
293 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
294 #define bfd_usrdata(abfd) ((abfd)->usrdata)
296 #define bfd_get_start_address(abfd) ((abfd)->start_address)
297 #define bfd_get_symcount(abfd) ((abfd)->symcount)
298 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
299 #define bfd_count_sections(abfd) ((abfd)->section_count)
300 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
301 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
311 /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */
313 /* Opens the file supplied (using fopen) with the target supplied, it
314 returns a pointer to the created bfd.
316 If NULL is returned then an error has occured.
317 Possible errors are no_memory, invalid_target or system_call error.
319 PROTO(bfd
*, bfd_openr
, (CONST
char *filename
,CONST
char*target
));
320 /* bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a bfd on
321 a file already described by the @var{fd} supplied.
323 Possible errors are no_memory, invalid_target and system_call error.
325 PROTO(bfd
*, bfd_fdopenr
,
326 (CONST
char *filename
, CONST
char *target
, int fd
));
327 /* Creates a bfd, associated with file @var{filename}, using the file
328 format @var{target}, and returns a pointer to it.
330 Possible errors are system_call_error, no_memory, invalid_target.
332 PROTO(bfd
*, bfd_openw
, (CONST
char *filename
, CONST
char *target
));
333 /* This function closes a bfd. If the bfd was open for writing, then
334 pending operations are completed and the file written out and closed.
335 If the created file is executable, then @code{chmod} is called to mark
338 All memory attatched to the bfd's obstacks is released.
340 @code{true} is returned if all is ok, otherwise @code{false}.
342 PROTO(boolean
, bfd_close
,(bfd
*));
343 /* This routine creates a new bfd in the manner of bfd_openw, but without
344 opening a file. The new bfd takes the target from the target used by
345 @var{template}. The format is always set to @code{bfd_object}.
348 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
349 /* Return the number of bytes in the obstacks connected to the supplied
352 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
353 /* This enum gives the object file's CPU
354 architecture, in a global sense. E.g. what processor family does it
355 belong to? There is another field, which indicates what processor
356 within the family is in use. The machine gives a number which
357 distingushes different versions of the architecture, containing for
358 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
359 Motorola 68020 and 68030.
362 enum bfd_architecture
364 bfd_arch_unknown
, /* File arch not known */
365 bfd_arch_obscure
, /* Arch known, not one of these */
366 bfd_arch_m68k
, /* Motorola 68xxx */
367 bfd_arch_vax
, /* DEC Vax */
368 bfd_arch_i960
, /* Intel 960 */
369 /* The order of the following is important.
370 lower number indicates a machine type that
371 only accepts a subset of the instructions
372 available to machines with higher numbers.
373 The exception is the "ca", which is
374 incompatible with all other machines except
377 #define bfd_mach_i960_core 1
378 #define bfd_mach_i960_ka_sa 2
379 #define bfd_mach_i960_kb_sb 3
380 #define bfd_mach_i960_mc 4
381 #define bfd_mach_i960_xa 5
382 #define bfd_mach_i960_ca 6
384 bfd_arch_a29k
, /* AMD 29000 */
385 bfd_arch_sparc
, /* SPARC */
386 bfd_arch_mips
, /* MIPS Rxxxx */
387 bfd_arch_i386
, /* Intel 386 */
388 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
389 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
390 bfd_arch_i860
, /* Intel 860 */
391 bfd_arch_romp
, /* IBM ROMP RS/6000 */
392 bfd_arch_alliant
, /* Alliant */
393 bfd_arch_convex
, /* Convex */
394 bfd_arch_m88k
, /* Motorola 88xxx */
395 bfd_arch_pyramid
, /* Pyramid Technology */
396 bfd_arch_h8_300
, /* Hitachi H8/300 */
403 /* Return a printable string representing the architecture and machine
404 type. The result is only good until the next call to
405 bfd_printable_arch_mach.
407 PROTO(CONST
char *,bfd_printable_arch_mach
,
408 (enum bfd_architecture arch
, unsigned long machine
));
409 /* Scan a string and attempt to turn it into an archive and machine type combination.
411 PROTO(boolean
, bfd_scan_arch_mach
,
412 (CONST
char *, enum bfd_architecture
*, unsigned long *));
413 /* This routine is used to determine whether two BFDs' architectures and machine types are
414 compatible. It calculates the lowest common denominator between the
415 two architectures and machine types implied by the bfds and sets the
416 objects pointed at by @var{archp} and @var{machine} if non NULL.
418 This routine returns @code{true} if the bfds are of compatible type,
419 otherwise @code{false}.
421 PROTO(boolean
, bfd_arch_compatible
,
424 enum bfd_architecture
*archp
,
425 unsigned long *machinep
));
428 #define bfd_set_arch_mach(abfd, arch, mach) \
429 BFD_SEND (abfd, _bfd_set_arch_mach,\
432 /* These macros as used for reading and writing raw data in sections;
433 each access (except for bytes) is vectored through the target format
434 of the bfd and mangled accordingly. The mangling performs any
435 necessary endian translations and removes alignment restrictions.
437 #define bfd_put_8(abfd, val, ptr) \
438 (*((char *)ptr) = (char)val)
439 #define bfd_get_8(abfd, ptr) \
441 #define bfd_put_16(abfd, val, ptr) \
442 BFD_SEND(abfd, bfd_putx16, (val,ptr))
443 #define bfd_get_16(abfd, ptr) \
444 BFD_SEND(abfd, bfd_getx16, (ptr))
445 #define bfd_put_32(abfd, val, ptr) \
446 BFD_SEND(abfd, bfd_putx32, (val,ptr))
447 #define bfd_get_32(abfd, ptr) \
448 BFD_SEND(abfd, bfd_getx32, (ptr))
449 #define bfd_put_64(abfd, val, ptr) \
450 BFD_SEND(abfd, bfd_putx64, (val, ptr))
451 #define bfd_get_64(abfd, ptr) \
452 BFD_SEND(abfd, bfd_getx64, (ptr))
454 /* These macros have the same function as their @code{bfd_get_x}
455 bretherin, except that they are used for removing information for the
456 header records of object files. Believe it or not, some object files
457 keep their header records in big endian order, and their data in little
460 #define bfd_h_put_8(abfd, val, ptr) \
461 (*((char *)ptr) = (char)val)
462 #define bfd_h_get_8(abfd, ptr) \
464 #define bfd_h_put_16(abfd, val, ptr) \
465 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
466 #define bfd_h_get_16(abfd, ptr) \
467 BFD_SEND(abfd, bfd_h_getx16,(ptr))
468 #define bfd_h_put_32(abfd, val, ptr) \
469 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
470 #define bfd_h_get_32(abfd, ptr) \
471 BFD_SEND(abfd, bfd_h_getx32,(ptr))
472 #define bfd_h_put_64(abfd, val, ptr) \
473 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
474 #define bfd_h_get_64(abfd, ptr) \
475 BFD_SEND(abfd, bfd_h_getx64,(ptr))
477 /* The shape of a section struct:
482 /* The name of the section, the name isn't a copy, the pointer is
483 the same as that passed to bfd_make_section.
487 /* The next section in the list belonging to the bfd, or NULL.
491 /* The field flags contains attributes of the section. Some of these
492 flags are read in from the object file, and some are synthesized from
496 #define SEC_NO_FLAGS 0x000
498 /* Tells the OS to allocate space for this section when loaded.
499 This would clear for a section containing debug information only.
501 #define SEC_ALLOC 0x001
503 /* Tells the OS to load the section from the file when loading.
504 This would be clear for a .bss section
506 #define SEC_LOAD 0x002
508 /* The section contains data still to be relocated, so there will be some
509 relocation information too.
511 #define SEC_RELOC 0x004
515 #define SEC_BALIGN 0x008
517 /* A signal to the OS that the section contains read only data.
519 #define SEC_READONLY 0x010
521 /* The section contains code only.
523 #define SEC_CODE 0x020
525 /* The section contains data only.
527 #define SEC_DATA 0x040
529 /* The section will reside in ROM.
531 #define SEC_ROM 0x080
533 /* The section contains constructor information. This section type is
534 used by the linker to create lists of constructors and destructors
535 used by @code{g++}. When a back end sees a symbol which should be used
536 in a constructor list, it creates a new section for the type of name
537 (eg @code{__CTOR_LIST__}), attatches the symbol to it and builds a
538 relocation. To build the lists of constructors, all the linker has to
539 to is catenate all the sections called @code{__CTOR_LIST__} and
540 relocte the data contained within - exactly the operations it would
541 peform on standard data.
543 #define SEC_CONSTRUCTOR 0x100
545 /* The section has contents - a bss section could be
546 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
547 @code{SEC_HAS_CONTENTS}
549 #define SEC_HAS_CONTENTS 0x200
551 /* An instruction to the linker not to output sections containing
552 this flag even if they have information which would normally be written.
554 #define SEC_NEVER_LOAD 0x400
556 /* The base address of the section in the address space of the target.
560 /* The size of the section in bytes of the loaded section. This contains
561 a value even if the section has no contents (eg, the size of @code{.bss}).
565 /* If this section is going to be output, then this value is the
566 offset into the output section of the first byte in the input
567 section. Eg, if this was going to start at the 100th byte in the
568 output section, this value would be 100.
570 bfd_vma output_offset
;
572 /* The output section through which to map on output.
574 struct sec
*output_section
;
576 /* The alignment requirement of the section, as an exponent - eg 3
579 unsigned int alignment_power
;
581 /* If an input section, a pointer to a vector of relocation records for
582 the data in this section.
584 struct reloc_cache_entry
*relocation
;
586 /* If an output section, a pointer to a vector of pointers to
587 relocation records for the data in this section.
589 struct reloc_cache_entry
**orelocation
;
591 /* The number of relocation records in one of the above
593 unsigned reloc_count
;
595 /* Which section is it 0..nth
599 /* Information below is back end specific - and not always used or
602 File position of section data
606 /* File position of relocation info
608 file_ptr rel_filepos
;
610 /* File position of line data
612 file_ptr line_filepos
;
614 /* Pointer to data for applications
617 struct lang_output_section
*otheruserdata
;
619 /* Attached line number information
623 /* Number of line number records
625 unsigned int lineno_count
;
627 /* When a section is being output, this value changes as more
628 linenumbers are written out
630 file_ptr moving_line_filepos
;
632 /* what the section number is in the target world
634 unsigned int target_index
;
637 /* If this is a constructor section then here is a list of the
638 relocations created to relocate items within it.
640 struct relent_chain
*constructor_chain
;
642 /* The bfd which owns the section.
647 /* Runs through the provided @var{abfd} and returns the @code{asection}
648 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
651 PROTO(asection
*, bfd_get_section_by_name
,
652 (bfd
*abfd
, CONST
char *name
));
653 /* This function creates a new empty section called @var{name} and attatches it
654 to the end of the chain of sections for @var{bfd}. An attempt to
655 create a section with a name which is already in use, returns the old
656 section by that name instead.
660 @item invalid_operation
661 If output has already started for this bfd.
663 If obstack alloc fails.
667 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
668 /* Attempts to set the attributes of the section named in the bfd
669 supplied to the value. Returns true on success, false on error.
670 Possible error returns are:
672 @item invalid operation
673 The section cannot have one or more of the attributes requested. For
674 example, a .bss section in @code{a.out} may not have the
675 @code{SEC_HAS_CONTENTS} field set.
679 PROTO(boolean
, bfd_set_section_flags
,
680 (bfd
*, asection
*, flagword
));
681 /* Calls the provided function @var{func} for each section attatched to
682 the bfd @var{abfd}, passing @var{obj} as an argument. The function
683 will be called as if by
686 func(abfd, the_section, obj);
691 PROTO(void, bfd_map_over_sections
,
692 (bfd
*abfd
, void (*func
)(), PTR obj
));
693 /* This is the prefered method for iterating over sections, an
694 alternative would be to use a loop:
698 for (p = abfd->sections; p != NULL; p = p->next)
702 /* Sets @var{section} to the size @var{val}. If the operation is ok, then
703 @code{true} is returned, else @code{false}.
705 Possible error returns:
707 @item invalid_operation
708 Writing has started to the bfd, so setting the size is invalid
712 PROTO(boolean
, bfd_set_section_size
,
713 (bfd
*, asection
*, bfd_size_type val
));
714 /* Sets the contents of the section @var{section} in bfd @var{abfd} to
715 the data starting in memory at @var{data}. The data is written to the
716 output section starting at offset @var{offset} for @var{count} bytes.
718 Normally @code{true} is returned, else @code{false}. Possible error
722 The output section does not have the @code{SEC_HAS_CONTENTS}
723 attribute, so nothing can be written to it.
724 @item and some more too
726 This routine is front end to the back end function @code{_bfd_set_section_contents}.
729 PROTO(boolean
, bfd_set_section_contents
,
734 bfd_size_type count
));
735 /* This function reads data from @var{section} in bfd @var{abfd} into
736 memory starting at @var{location}. The data is read at an offset of
737 @var{offset} from the start of the input section, and is read for
740 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
741 set are requested, then the @var{location} is filled with zeroes.
743 If no errors occur, @code{true} is returned, else @code{false}.
751 PROTO(boolean
, bfd_get_section_contents
,
752 (bfd
*abfd
, asection
*section
, PTR location
,
753 file_ptr offset
, bfd_size_type count
));
754 /* @subsection typedef asymbol
755 An @code{asymbol} has the form:
758 typedef struct symbol_cache_entry
761 /* A pointer to the bfd which owns the symbol. This information is
762 necessary so that a back end can work out what additional (invisible to
763 the application writer) information is carried with the symbol.
765 struct _bfd
*the_bfd
;
767 /* The text of the symbol. The name is left alone, and not copied - the
768 application may not alter it.
772 /* The value of the symbol.
776 /* Attributes of a symbol:
778 #define BSF_NO_FLAGS 0x00
780 /* The symbol has local scope; @code{static} in @code{C}. The value is
781 the offset into the section of the data.
783 #define BSF_LOCAL 0x01
785 /* The symbol has global scope; initialized data in @code{C}. The value
786 is the offset into the section of the data.
788 #define BSF_GLOBAL 0x02
792 #define BSF_IMPORT 0x04
794 /* The symbol has global scope, and is exported. The value is the offset
795 into the section of the data.
797 #define BSF_EXPORT 0x08
799 /* The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
801 #define BSF_UNDEFINED 0x10
803 /* The symbol is common, initialized to zero; default in @code{C}. The
804 value is the size of the object in bytes.
806 #define BSF_FORT_COMM 0x20
808 /* A normal @code{C} symbol would be one of:
809 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
811 The symbol is a debugging record. The value has an arbitary meaning.
813 #define BSF_DEBUGGING 0x40
815 /* The symbol has no section attached, any value is the actual value and
816 is not a relative offset to a section.
818 #define BSF_ABSOLUTE 0x80
820 /* Used by the linker
822 #define BSF_KEEP 0x10000
823 #define BSF_WARNING 0x20000
824 #define BSF_KEEP_G 0x80000
828 #define BSF_WEAK 0x100000
829 #define BSF_CTOR 0x200000
830 #define BSF_FAKE 0x400000
832 /* The symbol used to be a common symbol, but now it is allocated.
834 #define BSF_OLD_COMMON 0x800000
836 /* The default value for common data.
838 #define BFD_FORT_COMM_DEFAULT_VALUE 0
840 /* In some files the type of a symbol sometimes alters its location
841 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
842 symbol appears where it was declared and not at the end of a section.
843 This bit is set by the target bfd part to convey this information.
845 #define BSF_NOT_AT_END 0x40000
848 /* Aointer to the section to which this symbol is relative, or 0 if the
849 symbol is absolute or undefined. Note that it is not sufficient to set
850 this location to 0 to mark a symbol as absolute - the flag
851 @code{BSF_ABSOLUTE} must be set also.
855 /* Back end special data. This is being phased out in favour of making
861 /* Returns the number of bytes required in a vector of pointers to
862 @code{asymbols} for all the symbols in the supplied bfd, including a
863 terminal NULL pointer. If there are no symbols in the bfd, then 0 is
866 #define get_symtab_upper_bound(abfd) \
867 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
869 /* Supplied a bfd and a pointer to an uninitialized vector of pointers.
870 This reads in the symbols from the bfd, and fills in the table with
871 pointers to the symbols, and a trailing NULL. The routine returns the
872 actual number of symbol pointers not including the NULL.
875 #define bfd_canonicalize_symtab(abfd, location) \
876 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
880 /* Provided a table of pointers to to symbols and a count, writes to the
881 output bfd the symbols when closed.
884 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
885 /* Prints the value and flags of the symbol supplied to the stream file.
888 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
889 /* This function creates a new @code{asymbol} structure for the bfd, and
890 returns a pointer to it.
892 This routine is necessary, since each back end has private information
893 surrounding the @code{asymbol}. Building your own @code{asymbol} and
894 pointing to it will not create the private information, and will cause
897 #define bfd_make_empty_symbol(abfd) \
898 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
900 /* @section typedef bfd
902 Pointers to bfd structs are the cornerstone of any application using
903 libbfd. References though the bfd and to data in the bfd give the
904 entire bfd functionality.
906 Finally! The BFD struct itself. This contains the major data about
907 the file, and contains pointers to the rest of the data.
913 /* The filename the application opened the bfd with.
915 CONST
char *filename
;
917 /* A pointer to the target jump table.
919 struct bfd_target
*xvec
;
921 /* To avoid dragging too many header files into every file that
922 includes bfd.h, IOSTREAM has been declared as a "char *", and MTIME
923 as a "long". Their correct types, to which they are cast when used,
924 are "FILE *" and "time_t".
926 The iostream is the result of an fopen on the filename.
930 /* Is the file being cached @xref{File Caching}.
934 /* Marks whether there was a default target specified when the bfd was
935 opened. This is used to select what matching algorithm to use to chose
938 boolean target_defaulted
;
940 /* The caching routines use these to maintain an LRU list of bfds.
942 struct _bfd
*lru_prev
, *lru_next
;
944 /* When a file is closed by the caching routines, it retains the state
954 /* File modified time
958 /* For output files, channel we locked (is this used?).
962 /* The format which belongs to the bfd.
966 /* The direction the bfd was opened with
968 enum bfd_direction
{no_direction
= 0,
971 both_direction
= 3} direction
;
973 /* Format_specific flags
977 /* Currently my_archive is tested before adding origin to anything. I
978 believe that this can become always an add of origin, with origin set
979 to 0 for non archive files.
983 /* Remember when output has begun, to stop strange things happening.
985 boolean output_has_begun
;
987 /* Pointer to linked list of sections
989 struct sec
*sections
;
991 /* The number of sections
993 unsigned int section_count
;
995 /* Stuff only usefull for object files:
998 bfd_vma start_address
;
1000 /* Used for input and output
1002 unsigned int symcount
;
1004 /* Symtab for output bfd
1006 struct symbol_cache_entry
**outsymbols
;
1008 /* Architecture of object machine, eg m68k
1010 enum bfd_architecture obj_arch
;
1012 /* Particular machine within arch, e.g. 68010
1014 unsigned long obj_machine
;
1016 /* Stuff only usefull for archives:
1019 struct _bfd
*my_archive
;
1021 struct _bfd
*archive_head
;
1024 /* Used by the back end to hold private data.
1028 /* Used by the application to hold private data
1032 /* Where all the allocated stuff under this BFD goes
1034 struct obstack memory
;
1037 /* Marks the entry point of an output bfd. Returns @code{true} on
1038 success, @code{false} otherwise.
1041 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1042 /* Return cached file modification time (e.g. as read from archive header
1043 for archive members, or from file system if we have been called
1044 before); else determine modify time, cache it, and return it.
1047 PROTO(long, bfd_get_mtime
, (bfd
*));
1048 #define bfd_sizeof_headers(abfd, reloc) \
1049 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1051 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1052 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1054 #define bfd_debug_info_start(abfd) \
1055 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1057 #define bfd_debug_info_end(abfd) \
1058 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1060 #define bfd_debug_info_accumulate(abfd, section) \
1061 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1063 #define bfd_stat_arch_elt(abfd, stat) \
1064 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1066 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1067 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1069 #define bfd_coff_swap_sym_in(a,e,i) \
1070 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1072 #define bfd_coff_swap_lineno_in(a,e,i) \
1073 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1077 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1078 /* Used whilst processing archives. Sets the head of the chain of bfds
1079 contained in an archive to @var{new_head}. (see chapter on archives)
1081 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1083 PROTO(bfd
*, bfd_get_elt_at_index
, (bfd
*, int));
1086 /* Initially provided a bfd containing an archive and NULL, opens a bfd
1087 on the first contained element and returns that. Subsequent calls to
1088 bfd_openr_next_archived_file should pass the archive and the previous
1089 return value to return a created bfd to the next contained element.
1090 NULL is returned when there are no more.
1093 PROTO(bfd
*, bfd_openr_next_archived_file
,
1094 (bfd
*archive
, bfd
*previous
));
1095 /* Returns a read-only string explaining what program was running when
1096 it failed and produced the core file being read
1099 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1100 /* Returns the signal number which caused the core dump which generated
1101 the file the bfd is attatched to.
1104 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1105 /* Returns @code{true} if the core file attatched to @var{core_bfd} was
1106 generated by a run of the executable file attatched to @var{exec_bfd},
1107 or else @code{false}.
1109 PROTO(boolean
, core_file_matches_executable_p
,
1110 (bfd
*core_bfd
, bfd
*exec_bfd
));
1111 /* The relocation routine returns as a status an enumerated type:
1114 typedef enum bfd_reloc_status
{
1116 /* No errors detected
1120 /* The relocation was performed, but there was an overflow.
1124 /* The address to relocate was not within the section supplied
1126 bfd_reloc_outofrange
,
1128 /* Used by special functions
1134 bfd_reloc_notsupported
,
1136 /* Unsupported relocation size requested.
1140 /* The symbol to relocate against was undefined.
1142 bfd_reloc_undefined
,
1144 /* The relocaction was performed, but may not be ok - presently generated
1145 only when linking i960 coff files with i960 b.out symbols.
1149 bfd_reloc_status_enum_type
;
1150 typedef struct reloc_cache_entry
1153 /* A pointer into the canonical table of pointers
1155 struct symbol_cache_entry
**sym_ptr_ptr
;
1157 /* offset in section
1159 rawdata_offset address
;
1161 /* addend for relocation value
1165 /* if sym is null this is the section
1167 struct sec
*section
;
1169 /* Pointer to how to perform the required relocation
1171 CONST
struct reloc_howto_struct
*howto
;
1174 /* The @code{reloc_howto_type} is a structure which contains all the
1175 information that bfd needs to know to tie up a back end's data.
1178 typedef CONST
struct reloc_howto_struct
1181 /* The type field has mainly a documetary use - the back end can to what
1182 it wants with it, though the normally the back end's external idea of
1183 what a reloc number would be would be stored in this field. For
1184 example, the a PC relative word relocation in a coff environment would
1185 have the type 023 - because that's what the outside world calls a
1190 /* The value the final relocation is shifted right by. This drops
1191 unwanted data from the relocation.
1193 unsigned int rightshift
;
1195 /* The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1202 unsigned int bitsize
;
1204 /* Notes that the relocation is relative to the location in the data
1205 section of the addend. The relocation function will subtract from the
1206 relocation value the address of the location being relocated.
1208 boolean pc_relative
;
1212 unsigned int bitpos
;
1218 /* Causes the relocation routine to return an error if overflow is
1219 detected when relocating.
1221 boolean complain_on_overflow
;
1223 /* If this field is non null, then the supplied function is called rather
1224 than the normal function. This allows really strange relocation
1225 methods to be accomodated (eg, i960 callj instructions).
1227 bfd_reloc_status_enum_type (*special_function
)();
1229 /* The textual name of the relocation type.
1233 /* When performing a partial link, some formats must modify the
1234 relocations rather than the data - this flag signals this.
1236 boolean partial_inplace
;
1238 /* The src_mask is used to select what parts of the read in data are to
1239 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1240 which we read and relocated, this would be 0x000000ff. When we have
1241 relocs which have an addend, such as sun4 extended relocs, the value
1242 in the offset part of a relocating field is garbage so we never use
1243 it. In this case the mask would be 0x00000000.
1247 /* The dst_mask is what parts of the instruction are replaced into the
1248 instruction. In most cases src_mask == dst_mask, except in the above
1249 special case, where dst_mask would be 0x000000ff, and src_mask would
1254 /* When some formats create PC relative instructions, they leave the
1255 value of the pc of the place being relocated in the offset slot of the
1256 instruction, so that a PC relative relocation can be made just by
1257 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1258 displacement part of an instruction empty (eg m88k bcs), this flag
1261 boolean pcrel_offset
;
1264 /* The HOWTO define is horrible and will go away.
1266 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1267 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1268 typedef unsigned char bfd_byte
;
1270 typedef struct relent_chain
{
1272 struct relent_chain
*next
;
1276 /* If an output_bfd is supplied to this function the generated image
1277 will be relocatable, the relocations are copied to the output file
1278 after they have been changed to reflect the new state of the world.
1279 There are two ways of reflecting the results of partial linkage in an
1280 output file; by modifying the output data in place, and by modifying
1281 the relocation record. Some native formats (eg basic a.out and basic
1282 coff) have no way of specifying an addend in the relocation type, so
1283 the addend has to go in the output data. This is no big deal since in
1284 these formats the output data slot will always be big enough for the
1285 addend. Complex reloc types with addends were invented to solve just
1288 PROTO(bfd_reloc_status_enum_type
,
1289 bfd_perform_relocation
,
1291 arelent
*reloc_entry
,
1293 asection
*input_section
,
1296 @subsection bfd_target
1297 This structure contains everything that BFD knows about a target.
1298 It includes things like its byte order, name, what routines to call
1299 to do various operations, etc.
1301 Every BFD points to a target structure with its "xvec" member.
1304 Shortcut for declaring fields which are prototyped function pointers,
1305 while avoiding anguish on compilers that don't support protos.
1307 #define SDEF(ret, name, arglist) \
1308 PROTO(ret,(*name),arglist)
1309 #define SDEF_FMT(ret, name, arglist) \
1310 PROTO(ret,(*name[bfd_type_end]),arglist)
1312 /* These macros are used to dispatch to functions through the bfd_target
1313 vector. They are used in a number of macros further down in bfd.h, and
1314 are also used when calling various routines by hand inside the bfd
1315 implementation. The "arglist" argument must be parenthesized; it
1316 contains all the arguments to the called function.
1318 #define BFD_SEND(bfd, message, arglist) \
1319 ((*((bfd)->xvec->message)) arglist)
1321 /* For operations which index on the bfd format
1323 #define BFD_SEND_FMT(bfd, message, arglist) \
1324 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1326 /* This is the struct which defines the type of BFD this is. The
1327 "xvec" member of the struct bfd itself points here. Each module
1328 that implements access to a different target under BFD, defines
1331 FIXME, these names should be rationalised with the names of the
1332 entry points which call them. Too bad we can't have one macro to
1336 typedef struct bfd_target
1339 /* identifies the kind of target, eg SunOS4, Ultrix, etc
1343 /* The "flavour" of a back end is a general indication about the contents
1346 enum target_flavour_enum
{
1347 bfd_target_aout_flavour_enum
,
1348 bfd_target_coff_flavour_enum
,
1349 bfd_target_ieee_flavour_enum
,
1350 bfd_target_oasys_flavour_enum
,
1351 bfd_target_srec_flavour_enum
} flavour
;
1353 /* The order of bytes within the data area of a file.
1355 boolean byteorder_big_p
;
1357 /* The order of bytes within the header parts of a file.
1359 boolean header_byteorder_big_p
;
1361 /* This is a mask of all the flags which an executable may have set -
1362 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
1364 flagword object_flags
;
1366 /* This is a mask of all the flags which a section may have set - from
1367 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
1369 flagword section_flags
;
1371 /* The pad character for filenames within an archive header.
1375 /* The maximum number of characters in an archive header.
1377 unsigned short ar_max_namelen
;
1379 /* The minimum alignment restriction for any section.
1381 unsigned int align_power_min
;
1383 /* Entries for byte swapping for data. These are different to the other
1384 entry points, since they don't take bfd as first arg. Certain other handlers
1387 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
1388 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
1389 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
1390 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
1391 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
1392 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
1394 /* Byte swapping for the headers
1396 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
1397 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
1398 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
1399 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
1400 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
1401 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
1403 /* Format dependent routines, these turn into vectors of entry points
1404 within the target vector structure; one for each format to check.
1406 Check the format of a file being read. Return bfd_target * or zero.
1408 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
1410 /* Set the format of a file being written.
1412 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
1414 /* Write cached information into a file being written, at bfd_close.
1416 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
1418 /* The following functions are defined in @code{JUMP_TABLE}. The idea is
1419 that the back end writer of @code{foo} names all the routines
1420 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
1421 in this structure in the right order.
1423 Core file entry points
1425 SDEF (char *, _core_file_failing_command
, (bfd
*));
1426 SDEF (int, _core_file_failing_signal
, (bfd
*));
1427 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
1429 /* Archive entry points
1431 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
1432 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
1433 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
1434 SDEF (boolean
, write_armap
, (bfd
*arch
,
1435 unsigned int elength
,
1442 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
1443 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
1444 file_ptr
, bfd_size_type
));
1445 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
1446 file_ptr
, bfd_size_type
));
1447 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
1449 /* Symbols and reloctions
1451 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
1452 SDEF (unsigned int, _bfd_canonicalize_symtab
,
1453 (bfd
*, struct symbol_cache_entry
**));
1454 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
1455 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
1456 struct symbol_cache_entry
**));
1457 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
1458 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
1459 bfd_print_symbol_enum_type
));
1460 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1461 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
1463 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
1466 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
1467 SDEF (boolean
, _bfd_find_nearest_line
,
1468 (bfd
*abfd
, struct sec
*section
,
1469 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
1470 CONST
char **file
, CONST
char **func
, unsigned int *line
));
1471 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
1473 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
1475 SDEF (void, _bfd_debug_info_start
, (bfd
*));
1476 SDEF (void, _bfd_debug_info_end
, (bfd
*));
1477 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
1479 /* Special entry points for gdb to swap in coff symbol table parts
1481 SDEF(void, _bfd_coff_swap_aux_in
,(
1488 SDEF(void, _bfd_coff_swap_sym_in
,(
1493 SDEF(void, _bfd_coff_swap_lineno_in
, (
1500 /* Returns a pointer to the transfer vector for the object target
1501 named target_name. If target_name is NULL, chooses the one in the
1502 environment variable GNUTARGET; if that is null or not defined then
1503 the first entry in the target list is chosen. Passing in the
1504 string "default" or setting the environment variable to "default"
1505 will cause the first entry in the target list to be returned,
1506 and "target_defaulted" will be set in the bfd. This causes
1507 bfd_check_format to loop over all the targets to find the one
1508 that matches the file being read.
1510 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
1511 /* This function returns a freshly malloced NULL-terminated vector of the
1512 names of all the valid bfd targets. Do not modify the names
1514 PROTO(CONST
char **,bfd_target_list
,());
1515 /* This routine is supplied a bfd and a format. It attempts to verify if
1516 the file attatched to the bfd is indeed compatible with the format
1517 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
1520 If the bfd has been set to a specific @var{target} before the call,
1521 only the named target and format combination will be checked. If the
1522 target has not been set, or has been set to @code{default} then all
1523 the known target backends will be interrogated to determine a match.
1525 The function returns @code{true} on success, otherwise @code{false}
1526 with one of the following error codes:
1530 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
1532 @item system_call_error
1533 if an error occured during a read - even some file mismatches can
1534 cause system_call_errros
1535 @item file_not_recognised
1536 none of the backends recognised the file format
1537 @item file_ambiguously_recognized
1538 more than one backend recognised the file format.
1541 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
1542 /* This function sets the file format of the supplied bfd to the format
1543 requested. If the target set in the bfd does not support the format
1544 requested, the format is illegal or the bfd is not open for writing
1545 than an error occurs.
1547 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
1548 /* This function takes one argument, and enumerated type (bfd_format) and
1549 returns a pointer to a const string "invalid", "object", "archive",
1550 "core" or "unknown" depending upon the value of the enumeration.
1552 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));