1 /* A -*- C -*- header file for the bfd library */
3 /* bfd.h -- The only header file required by users of the bfd library
7 This file is generated from various .c files, if you change it, your
11 /* Copyright (C) 1990, 1991 Free Software Foundation, Inc.
13 This file is part of BFD, the Binary File Diddler.
15 BFD is free software; you can redistribute it and/or modify
16 it under the terms of the GNU General Public License as published by
17 the Free Software Foundation; either version 1, or (at your option)
20 BFD is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU General Public License for more details.
25 You should have received a copy of the GNU General Public License
26 along with BFD; see the file COPYING. If not, write to
27 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
29 #ifndef __BFD_H_SEEN__
30 #define __BFD_H_SEEN__
35 /* Make it easier to declare prototypes (puts conditional here) */
38 # define PROTO(type, name, arglist) type name arglist
40 # define PROTO(type, name, arglist) type name ()
44 #define BFD_VERSION "1.15"
46 /* forward declaration */
47 typedef struct _bfd bfd
;
49 /* General rules: functions which are boolean return true on success
50 and false on failure (unless they're a predicate). -- bfd.doc */
51 /* I'm sure this is going to break something and someone is going to
52 force me to change it. */
53 typedef enum boolean
{false, true} boolean
;
55 /* Try to avoid breaking stuff */
56 typedef long int file_ptr
;
58 /* Support for different sizes of target format ints and addresses */
61 typedef HOST_64_BIT rawdata_offset
;
62 typedef HOST_64_BIT bfd_vma
;
63 typedef HOST_64_BIT bfd_word
;
64 typedef HOST_64_BIT bfd_offset
;
65 typedef HOST_64_BIT bfd_size_type
;
66 typedef HOST_64_BIT symvalue
;
67 typedef HOST_64_BIT bfd_64_type
;
68 #define fprintf_vma(s,x) \
69 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
70 #define printf_vma(x) \
71 printf( "%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
73 typedef struct {int a
,b
;} bfd_64_type
;
74 typedef unsigned long rawdata_offset
;
75 typedef unsigned long bfd_vma
;
76 typedef unsigned long bfd_offset
;
77 typedef unsigned long bfd_word
;
78 typedef unsigned long bfd_size
;
79 typedef unsigned long symvalue
;
80 typedef unsigned long bfd_size_type
;
81 #define printf_vma(x) printf( "%08lx", x)
82 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
85 typedef unsigned int flagword
; /* 32 bits of flags */
89 typedef enum bfd_format
{
90 bfd_unknown
= 0, /* file format is unknown */
91 bfd_object
, /* linker/assember/compiler output */
92 bfd_archive
, /* object archive file */
93 bfd_core
, /* core dump */
94 bfd_type_end
} /* marks the end; don't use it! */
97 /* Object file flag values */
101 #define HAS_LINENO 004
102 #define HAS_DEBUG 010
104 #define HAS_LOCALS 040
110 /* symbols and relocation */
112 typedef unsigned long symindex
;
114 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
116 typedef enum bfd_symclass
{
117 bfd_symclass_unknown
= 0,
118 bfd_symclass_fcommon
, /* fortran common symbols */
119 bfd_symclass_global
, /* global symbol, what a surprise */
120 bfd_symclass_debugger
, /* some debugger symbol */
121 bfd_symclass_undefined
/* none known */
125 typedef int symtype
; /* Who knows, yet? */
128 /* general purpose part of a symbol;
129 target specific parts will be found in libcoff.h, liba.out.h etc */
132 #define bfd_get_section(x) ((x)->section)
133 #define bfd_get_output_section(x) ((x)->section->output_section)
134 #define bfd_set_section(x,y) ((x)->section) = (y)
135 #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0)
136 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value)
137 #define bfd_asymbol_name(x) ((x)->name)
139 /* This is a type pun with struct ranlib on purpose! */
140 typedef struct carsym
{
142 file_ptr file_offset
; /* look here to find the file */
143 } carsym
; /* to make these you call a carsymogen */
146 /* Used in generating armaps. Perhaps just a forward definition would do? */
147 struct orl
{ /* output ranlib */
148 char **name
; /* symbol name */
149 file_ptr pos
; /* bfd* or file position */
150 int namidx
; /* index into string table */
155 /* Linenumber stuff */
156 typedef struct lineno_cache_entry
{
157 unsigned int line_number
; /* Linenumber from start of function*/
159 struct symbol_cache_entry
*sym
; /* Function name */
160 unsigned long offset
; /* Offset into section */
164 /* object and core file sections */
167 #define align_power(addr, align) \
168 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
170 typedef struct sec
*sec_ptr
;
172 #define bfd_section_name(bfd, ptr) ((ptr)->name)
173 #define bfd_section_size(bfd, ptr) ((ptr)->size)
174 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
175 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
176 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags)
177 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
179 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true)
180 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
181 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
183 typedef struct stat stat_type
;
185 /** Error handling */
187 typedef enum bfd_error
{
188 no_error
= 0, system_call_error
, invalid_target
,
189 wrong_format
, invalid_operation
, no_memory
,
190 no_symbols
, no_relocation_info
,
191 no_more_archived_files
, malformed_archive
,
192 symbol_not_found
, file_not_recognized
,
193 file_ambiguously_recognized
, no_contents
,
194 bfd_error_nonrepresentable_section
,
195 invalid_error_code
} bfd_ec
;
197 extern bfd_ec bfd_error
;
199 typedef struct bfd_error_vector
{
200 PROTO(void,(* nonrepresentable_section
),(CONST bfd
*CONST abfd
,
201 CONST
char *CONST name
));
202 } bfd_error_vector_type
;
204 PROTO (char *, bfd_errmsg
, ());
205 PROTO (void, bfd_perror
, (CONST
char *message
));
208 typedef enum bfd_print_symbol
210 bfd_print_symbol_name_enum
,
211 bfd_print_symbol_type_enum
,
212 bfd_print_symbol_all_enum
213 } bfd_print_symbol_enum_type
;
217 /* The code that implements targets can initialize a jump table with this
218 macro. It must name all its routines the same way (a prefix plus
219 the standard routine suffix), or it must #define the routines that
220 are not so named, before calling JUMP_TABLE in the initializer. */
222 /* Semi-portable string concatenation in cpp */
225 #define CAT(a,b) a##b
227 #define CAT(a,b) a/**/b
231 #define JUMP_TABLE(NAME)\
232 CAT(NAME,_core_file_failing_command),\
233 CAT(NAME,_core_file_failing_signal),\
234 CAT(NAME,_core_file_matches_executable_p),\
235 CAT(NAME,_slurp_armap),\
236 CAT(NAME,_slurp_extended_name_table),\
237 CAT(NAME,_truncate_arname),\
238 CAT(NAME,_write_armap),\
239 CAT(NAME,_close_and_cleanup), \
240 CAT(NAME,_set_section_contents),\
241 CAT(NAME,_get_section_contents),\
242 CAT(NAME,_new_section_hook),\
243 CAT(NAME,_get_symtab_upper_bound),\
244 CAT(NAME,_get_symtab),\
245 CAT(NAME,_get_reloc_upper_bound),\
246 CAT(NAME,_canonicalize_reloc),\
247 CAT(NAME,_make_empty_symbol),\
248 CAT(NAME,_print_symbol),\
249 CAT(NAME,_get_lineno),\
250 CAT(NAME,_set_arch_mach),\
251 CAT(NAME,_openr_next_archived_file),\
252 CAT(NAME,_find_nearest_line),\
253 CAT(NAME,_generic_stat_arch_elt),\
254 CAT(NAME,_sizeof_headers),\
255 CAT(NAME,_bfd_debug_info_start),\
256 CAT(NAME,_bfd_debug_info_end),\
257 CAT(NAME,_bfd_debug_info_accumulate)
259 #define COFF_SWAP_TABLE coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in,
261 /* User program access to BFD facilities */
263 extern CONST
short _bfd_host_big_endian
;
264 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
268 /* Cast from const char * to char * so that caller can assign to
269 a char * without a warning. */
270 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
271 #define bfd_get_format(abfd) ((abfd)->format)
272 #define bfd_get_target(abfd) ((abfd)->xvec->name)
273 #define bfd_get_file_flags(abfd) ((abfd)->flags)
274 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
275 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
276 #define bfd_my_archive(abfd) ((abfd)->my_archive);
277 #define bfd_has_map(abfd) ((abfd)->has_armap)
278 #define bfd_header_twiddle_required(abfd) \
279 ((((abfd)->xvec->header_byteorder_big_p) \
280 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
282 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
283 #define bfd_usrdata(abfd) ((abfd)->usrdata)
285 #define bfd_get_start_address(abfd) ((abfd)->start_address)
286 #define bfd_get_symcount(abfd) ((abfd)->symcount)
287 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
288 #define bfd_count_sections(abfd) ((abfd)->section_count)
289 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
290 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
300 /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */
302 /* Opens the file supplied (using fopen) with the target supplied, it
303 returns a pointer to the created bfd.
305 If NULL is returned then an error has occured.
306 Possible errors are no_memory, invalid_target or system_call error.
308 PROTO(bfd
*, bfd_openr
, (CONST
char *filename
,CONST
char*target
));
309 /* bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a bfd on
310 a file already described by the @var{fd} supplied.
312 Possible errors are no_memory, invalid_target and system_call error.
314 PROTO(bfd
*, bfd_fdopenr
,
315 (CONST
char *filename
, CONST
char *target
, int fd
));
316 /* Creates a bfd, associated with file @var{filename}, using the file
317 format @var{target}, and returns a pointer to it.
319 Possible errors are system_call_error, no_memory, invalid_target.
321 PROTO(bfd
*, bfd_openw
, (CONST
char *filename
, CONST
char *target
));
322 /* This function closes a bfd. If the bfd was open for writing, then
323 pending operations are completed and the file written out and closed.
324 If the created file is executable, then @code{chmod} is called to mark
327 All memory attatched to the bfd's obstacks is released.
329 @code{true} is returned if all is ok, otherwise @code{false}.
331 PROTO(boolean
, bfd_close
,(bfd
*));
332 /* This routine creates a new bfd in the manner of bfd_openw, but without
333 opening a file. The new bfd takes the target from the target used by
334 @var{template}. The format is always set to @code{bfd_object}.
337 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
338 /* Return the number of bytes in the obstacks connected to the supplied
341 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
342 /* This enum gives the object file's CPU
343 architecture, in a global sense. E.g. what processor family does it
344 belong to? There is another field, which indicates what processor
345 within the family is in use. The machine gives a number which
346 distingushes different versions of the architecture, containing for
347 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
348 Motorola 68020 and 68030.
351 enum bfd_architecture
353 bfd_arch_unknown
, /* File arch not known */
354 bfd_arch_obscure
, /* Arch known, not one of these */
355 bfd_arch_m68k
, /* Motorola 68xxx */
356 bfd_arch_vax
, /* DEC Vax */
357 bfd_arch_i960
, /* Intel 960 */
358 /* The order of the following is important.
359 lower number indicates a machine type that
360 only accepts a subset of the instructions
361 available to machines with higher numbers.
362 The exception is the "ca", which is
363 incompatible with all other machines except
366 #define bfd_mach_i960_core 1
367 #define bfd_mach_i960_ka_sa 2
368 #define bfd_mach_i960_kb_sb 3
369 #define bfd_mach_i960_mc 4
370 #define bfd_mach_i960_xa 5
371 #define bfd_mach_i960_ca 6
373 bfd_arch_a29k
, /* AMD 29000 */
374 bfd_arch_sparc
, /* SPARC */
375 bfd_arch_mips
, /* MIPS Rxxxx */
376 bfd_arch_i386
, /* Intel 386 */
377 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
378 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
379 bfd_arch_i860
, /* Intel 860 */
380 bfd_arch_romp
, /* IBM ROMP RS/6000 */
381 bfd_arch_alliant
, /* Alliant */
382 bfd_arch_convex
, /* Convex */
383 bfd_arch_m88k
, /* Motorola 88xxx */
384 bfd_arch_pyramid
, /* Pyramid Technology */
385 bfd_arch_h8_300
, /* Hitachi H8/300 */
392 /* Return a printable string representing the architecture and machine
393 type. The result is only good until the next call to
394 bfd_printable_arch_mach.
396 PROTO(CONST
char *,bfd_printable_arch_mach
,
397 (enum bfd_architecture arch
, unsigned long machine
));
398 /* Scan a string and attempt to turn it into an archive and machine type combination.
400 PROTO(boolean
, bfd_scan_arch_mach
,
401 (CONST
char *, enum bfd_architecture
*, unsigned long *));
402 /* This routine is used to determine whether two BFDs' architectures and machine types are
403 compatible. It calculates the lowest common denominator between the
404 two architectures and machine types implied by the bfds and sets the
405 objects pointed at by @var{archp} and @var{machine} if non NULL.
407 This routine returns @code{true} if the bfds are of compatible type,
408 otherwise @code{false}.
410 PROTO(boolean
, bfd_arch_compatible
,
413 enum bfd_architecture
*archp
,
414 unsigned long *machinep
));
417 #define bfd_set_arch_mach(abfd, arch, mach) \
418 BFD_SEND (abfd, _bfd_set_arch_mach,\
421 /* These macros as used for reading and writing raw data in sections;
422 each access (except for bytes) is vectored through the target format
423 of the bfd and mangled accordingly. The mangling performs any
424 necessary endian translations and removes alignment restrictions.
426 #define bfd_put_8(abfd, val, ptr) \
427 (*((char *)ptr) = (char)val)
428 #define bfd_get_8(abfd, ptr) \
430 #define bfd_put_16(abfd, val, ptr) \
431 BFD_SEND(abfd, bfd_putx16, (val,ptr))
432 #define bfd_get_16(abfd, ptr) \
433 BFD_SEND(abfd, bfd_getx16, (ptr))
434 #define bfd_put_32(abfd, val, ptr) \
435 BFD_SEND(abfd, bfd_putx32, (val,ptr))
436 #define bfd_get_32(abfd, ptr) \
437 BFD_SEND(abfd, bfd_getx32, (ptr))
438 #define bfd_put_64(abfd, val, ptr) \
439 BFD_SEND(abfd, bfd_putx64, (val, ptr))
440 #define bfd_get_64(abfd, ptr) \
441 BFD_SEND(abfd, bfd_getx64, (ptr))
443 /* These macros have the same function as their @code{bfd_get_x}
444 bretherin, except that they are used for removing information for the
445 header records of object files. Believe it or not, some object files
446 keep their header records in big endian order, and their data in little
449 #define bfd_h_put_8(abfd, val, ptr) \
450 (*((char *)ptr) = (char)val)
451 #define bfd_h_get_8(abfd, ptr) \
453 #define bfd_h_put_16(abfd, val, ptr) \
454 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
455 #define bfd_h_get_16(abfd, ptr) \
456 BFD_SEND(abfd, bfd_h_getx16,(ptr))
457 #define bfd_h_put_32(abfd, val, ptr) \
458 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
459 #define bfd_h_get_32(abfd, ptr) \
460 BFD_SEND(abfd, bfd_h_getx32,(ptr))
461 #define bfd_h_put_64(abfd, val, ptr) \
462 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
463 #define bfd_h_get_64(abfd, ptr) \
464 BFD_SEND(abfd, bfd_h_getx64,(ptr))
466 /* The shape of a section struct:
471 /* The name of the section, the name isn't a copy, the pointer is
472 the same as that passed to bfd_make_section.
476 /* The next section in the list belonging to the bfd, or NULL.
480 /* The field flags contains attributes of the section. Some of these
481 flags are read in from the object file, and some are synthesized from
485 #define SEC_NO_FLAGS 0x000
487 /* Tells the OS to allocate space for this section when loaded.
488 This would clear for a section containing debug information only.
490 #define SEC_ALLOC 0x001
492 /* Tells the OS to load the section from the file when loading.
493 This would be clear for a .bss section
495 #define SEC_LOAD 0x002
497 /* The section contains data still to be relocated, so there will be some
498 relocation information too.
500 #define SEC_RELOC 0x004
504 #define SEC_BALIGN 0x008
506 /* A signal to the OS that the section contains read only data.
508 #define SEC_READONLY 0x010
510 /* The section contains code only.
512 #define SEC_CODE 0x020
514 /* The section contains data only.
516 #define SEC_DATA 0x040
518 /* The section will reside in ROM.
520 #define SEC_ROM 0x080
522 /* The section contains constructor information. This section type is
523 used by the linker to create lists of constructors and destructors
524 used by @code{g++}. When a back end sees a symbol which should be used
525 in a constructor list, it creates a new section for the type of name
526 (eg @code{__CTOR_LIST__}), attatches the symbol to it and builds a
527 relocation. To build the lists of constructors, all the linker has to
528 to is catenate all the sections called @code{__CTOR_LIST__} and
529 relocte the data contained within - exactly the operations it would
530 peform on standard data.
532 #define SEC_CONSTRUCTOR 0x100
534 /* The section has contents - a bss section could be
535 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
536 @code{SEC_HAS_CONTENTS}
538 #define SEC_HAS_CONTENTS 0x200
540 /* An instruction to the linker not to output sections containing
541 this flag even if they have information which would normally be written.
543 #define SEC_NEVER_LOAD 0x400
545 /* The base address of the section in the address space of the target.
549 /* The size of the section in bytes of the loaded section. This contains
550 a value even if the section has no contents (eg, the size of @code{.bss}).
554 /* If this section is going to be output, then this value is the
555 offset into the output section of the first byte in the input
556 section. Eg, if this was going to start at the 100th byte in the
557 output section, this value would be 100.
559 bfd_vma output_offset
;
561 /* The output section through which to map on output.
563 struct sec
*output_section
;
565 /* The alignment requirement of the section, as an exponent - eg 3
568 unsigned int alignment_power
;
570 /* If an input section, a pointer to a vector of relocation records for
571 the data in this section.
573 struct reloc_cache_entry
*relocation
;
575 /* If an output section, a pointer to a vector of pointers to
576 relocation records for the data in this section.
578 struct reloc_cache_entry
**orelocation
;
580 /* The number of relocation records in one of the above
582 unsigned reloc_count
;
584 /* Which section is it 0..nth
588 /* Information below is back end specific - and not always used or
591 File position of section data
595 /* File position of relocation info
597 file_ptr rel_filepos
;
599 /* File position of line data
601 file_ptr line_filepos
;
603 /* Pointer to data for applications
606 struct lang_output_section
*otheruserdata
;
608 /* Attached line number information
612 /* Number of line number records
614 unsigned int lineno_count
;
616 /* When a section is being output, this value changes as more
617 linenumbers are written out
619 file_ptr moving_line_filepos
;
621 /* what the section number is in the target world
623 unsigned int target_index
;
626 /* If this is a constructor section then here is a list of the
627 relocations created to relocate items within it.
629 struct relent_chain
*constructor_chain
;
631 /* The bfd which owns the section.
636 /* Runs through the provided @var{abfd} and returns the @code{asection}
637 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
640 PROTO(asection
*, bfd_get_section_by_name
,
641 (bfd
*abfd
, CONST
char *name
));
642 /* This function creates a new empty section called @var{name} and attatches it
643 to the end of the chain of sections for @var{bfd}. An attempt to
644 create a section with a name which is already in use, returns the old
645 section by that name instead.
649 @item invalid_operation
650 If output has already started for this bfd.
652 If obstack alloc fails.
656 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
657 /* Attempts to set the attributes of the section named in the bfd
658 supplied to the value. Returns true on success, false on error.
659 Possible error returns are:
661 @item invalid operation
662 The section cannot have one or more of the attributes requested. For
663 example, a .bss section in @code{a.out} may not have the
664 @code{SEC_HAS_CONTENTS} field set.
668 PROTO(boolean
, bfd_set_section_flags
,
669 (bfd
*, asection
*, flagword
));
670 /* Calls the provided function @var{func} for each section attatched to
671 the bfd @var{abfd}, passing @var{obj} as an argument. The function
672 will be called as if by
675 func(abfd, the_section, obj);
680 PROTO(void, bfd_map_over_sections
,
681 (bfd
*abfd
, void (*func
)(), PTR obj
));
682 /* This is the prefered method for iterating over sections, an
683 alternative would be to use a loop:
687 for (p = abfd->sections; p != NULL; p = p->next)
691 /* Sets @var{section} to the size @var{val}. If the operation is ok, then
692 @code{true} is returned, else @code{false}.
694 Possible error returns:
696 @item invalid_operation
697 Writing has started to the bfd, so setting the size is invalid
701 PROTO(boolean
, bfd_set_section_size
,
702 (bfd
*, asection
*, bfd_size_type val
));
703 /* Sets the contents of the section @var{section} in bfd @var{abfd} to
704 the data starting in memory at @var{data}. The data is written to the
705 output section starting at offset @var{offset} for @var{count} bytes.
707 Normally @code{true} is returned, else @code{false}. Possible error
711 The output section does not have the @code{SEC_HAS_CONTENTS}
712 attribute, so nothing can be written to it.
713 @item and some more too
715 This routine is front end to the back end function @code{_bfd_set_section_contents}.
718 PROTO(boolean
, bfd_set_section_contents
,
723 bfd_size_type count
));
724 /* This function reads data from @var{section} in bfd @var{abfd} into
725 memory starting at @var{location}. The data is read at an offset of
726 @var{offset} from the start of the input section, and is read for
729 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
730 set are requested, then the @var{location} is filled with zeroes.
732 If no errors occur, @code{true} is returned, else @code{false}.
740 PROTO(boolean
, bfd_get_section_contents
,
741 (bfd
*abfd
, asection
*section
, PTR location
,
742 file_ptr offset
, bfd_size_type count
));
743 /* @subsection typedef asymbol
744 An @code{asymbol} has the form:
747 typedef struct symbol_cache_entry
750 /* A pointer to the bfd which owns the symbol. This information is
751 necessary so that a back end can work out what additional (invisible to
752 the application writer) information is carried with the symbol.
754 struct _bfd
*the_bfd
;
756 /* The text of the symbol. The name is left alone, and not copied - the
757 application may not alter it.
761 /* The value of the symbol.
765 /* Attributes of a symbol:
767 #define BSF_NO_FLAGS 0x00
769 /* The symbol has local scope; @code{static} in @code{C}. The value is
770 the offset into the section of the data.
772 #define BSF_LOCAL 0x01
774 /* The symbol has global scope; initialized data in @code{C}. The value
775 is the offset into the section of the data.
777 #define BSF_GLOBAL 0x02
781 #define BSF_IMPORT 0x04
783 /* The symbol has global scope, and is exported. The value is the offset
784 into the section of the data.
786 #define BSF_EXPORT 0x08
788 /* The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
790 #define BSF_UNDEFINED 0x10
792 /* The symbol is common, initialized to zero; default in @code{C}. The
793 value is the size of the object in bytes.
795 #define BSF_FORT_COMM 0x20
797 /* A normal @code{C} symbol would be one of:
798 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
800 The symbol is a debugging record. The value has an arbitary meaning.
802 #define BSF_DEBUGGING 0x40
804 /* The symbol has no section attached, any value is the actual value and
805 is not a relative offset to a section.
807 #define BSF_ABSOLUTE 0x80
809 /* Used by the linker
811 #define BSF_KEEP 0x10000
812 #define BSF_WARNING 0x20000
813 #define BSF_KEEP_G 0x80000
817 #define BSF_WEAK 0x100000
818 #define BSF_CTOR 0x200000
819 #define BSF_FAKE 0x400000
821 /* The symbol used to be a common symbol, but now it is allocated.
823 #define BSF_OLD_COMMON 0x800000
825 /* The default value for common data.
827 #define BFD_FORT_COMM_DEFAULT_VALUE 0
829 /* In some files the type of a symbol sometimes alters its location
830 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
831 symbol appears where it was declared and not at the end of a section.
832 This bit is set by the target bfd part to convey this information.
834 #define BSF_NOT_AT_END 0x40000
837 /* Aointer to the section to which this symbol is relative, or 0 if the
838 symbol is absolute or undefined. Note that it is not sufficient to set
839 this location to 0 to mark a symbol as absolute - the flag
840 @code{BSF_ABSOLUTE} must be set also.
844 /* Back end special data. This is being phased out in favour of making
850 /* Returns the number of bytes required in a vector of pointers to
851 @code{asymbols} for all the symbols in the supplied bfd, including a
852 terminal NULL pointer. If there are no symbols in the bfd, then 0 is
855 #define get_symtab_upper_bound(abfd) \
856 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
858 /* Supplied a bfd and a pointer to an uninitialized vector of pointers.
859 This reads in the symbols from the bfd, and fills in the table with
860 pointers to the symbols, and a trailing NULL. The routine returns the
861 actual number of symbol pointers not including the NULL.
864 #define bfd_canonicalize_symtab(abfd, location) \
865 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
869 /* Provided a table of pointers to to symbols and a count, writes to the
870 output bfd the symbols when closed.
873 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
874 /* Prints the value and flags of the symbol supplied to the stream file.
877 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
878 /* This function creates a new @code{asymbol} structure for the bfd, and
879 returns a pointer to it.
881 This routine is necessary, since each back end has private information
882 surrounding the @code{asymbol}. Building your own @code{asymbol} and
883 pointing to it will not create the private information, and will cause
886 #define bfd_make_empty_symbol(abfd) \
887 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
889 /* @section typedef bfd
891 Pointers to bfd structs are the cornerstone of any application using
892 libbfd. References though the bfd and to data in the bfd give the
893 entire bfd functionality.
895 Finally! The BFD struct itself. This contains the major data about
896 the file, and contains pointers to the rest of the data.
902 /* The filename the application opened the bfd with.
904 CONST
char *filename
;
906 /* A pointer to the target jump table.
908 struct bfd_target
*xvec
;
910 /* To avoid dragging too many header files into every file that
911 includes bfd.h, IOSTREAM has been declared as a "char *", and MTIME
912 as a "long". Their correct types, to which they are cast when used,
913 are "FILE *" and "time_t".
915 The iostream is the result of an fopen on the filename.
919 /* Is the file being cached @xref{File Caching}.
923 /* Marks whether there was a default target specified when the bfd was
924 opened. This is used to select what matching algorithm to use to chose
927 boolean target_defaulted
;
929 /* The caching routines use these to maintain an LRU list of bfds.
931 struct _bfd
*lru_prev
, *lru_next
;
933 /* When a file is closed by the caching routines, it retains the state
943 /* File modified time
947 /* For output files, channel we locked (is this used?).
951 /* The format which belongs to the bfd.
955 /* The direction the bfd was opened with
957 enum bfd_direction
{no_direction
= 0,
960 both_direction
= 3} direction
;
962 /* Format_specific flags
966 /* Currently my_archive is tested before adding origin to anything. I
967 believe that this can become always an add of origin, with origin set
968 to 0 for non archive files.
972 /* Remember when output has begun, to stop strange things happening.
974 boolean output_has_begun
;
976 /* Pointer to linked list of sections
978 struct sec
*sections
;
980 /* The number of sections
982 unsigned int section_count
;
984 /* Stuff only usefull for object files:
987 bfd_vma start_address
;
989 /* Used for input and output
991 unsigned int symcount
;
993 /* Symtab for output bfd
995 struct symbol_cache_entry
**outsymbols
;
997 /* Architecture of object machine, eg m68k
999 enum bfd_architecture obj_arch
;
1001 /* Particular machine within arch, e.g. 68010
1003 unsigned long obj_machine
;
1005 /* Stuff only usefull for archives:
1008 struct _bfd
*my_archive
;
1010 struct _bfd
*archive_head
;
1013 /* Used by the back end to hold private data.
1017 /* Used by the application to hold private data
1021 /* Where all the allocated stuff under this BFD goes
1023 struct obstack memory
;
1026 /* Marks the entry point of an output bfd. Returns @code{true} on
1027 success, @code{false} otherwise.
1030 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1031 /* Return cached file modification time (e.g. as read from archive header
1032 for archive members, or from file system if we have been called
1033 before); else determine modify time, cache it, and return it.
1036 PROTO(long, bfd_get_mtime
, (bfd
*));
1037 #define bfd_sizeof_headers(abfd, reloc) \
1038 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1040 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1041 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1043 #define bfd_debug_info_start(abfd) \
1044 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1046 #define bfd_debug_info_end(abfd) \
1047 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1049 #define bfd_debug_info_accumulate(abfd, section) \
1050 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1052 #define bfd_stat_arch_elt(abfd, stat) \
1053 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1055 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1056 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1058 #define bfd_coff_swap_sym_in(a,e,i) \
1059 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1061 #define bfd_coff_swap_lineno_in(a,e,i) \
1062 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1066 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1067 /* Used whilst processing archives. Sets the head of the chain of bfds
1068 contained in an archive to @var{new_head}. (see chapter on archives)
1070 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1071 /* *;PROTO(bfd *, bfd_get_elt_at_index, (bfd *, int));*/
1073 /* Initially provided a bfd containing an archive and NULL, opens a bfd
1074 on the first contained element and returns that. Subsequent calls to
1075 bfd_openr_next_archived_file should pass the archive and the previous
1076 return value to return a created bfd to the next contained element.
1077 NULL is returned when there are no more.
1080 PROTO(bfd
*, bfd_openr_next_archived_file
,
1081 (bfd
*archive
, bfd
*previous
));
1082 /* Returns a read-only string explaining what program was running when
1083 it failed and produced the core file being read
1086 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1087 /* Returns the signal number which caused the core dump which generated
1088 the file the bfd is attatched to.
1091 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1092 /* Returns @code{true} if the core file attatched to @var{core_bfd} was
1093 generated by a run of the executable file attatched to @var{exec_bfd},
1094 or else @code{false}.
1096 PROTO(boolean
, core_file_matches_executable_p
,
1097 (bfd
*core_bfd
, bfd
*exec_bfd
));
1098 /* The relocation routine returns as a status an enumerated type:
1101 typedef enum bfd_reloc_status
{
1103 /* No errors detected
1107 /* The relocation was performed, but there was an overflow.
1111 /* The address to relocate was not within the section supplied
1113 bfd_reloc_outofrange
,
1115 /* Used by special functions
1121 bfd_reloc_notsupported
,
1123 /* Unsupported relocation size requested.
1127 /* The symbol to relocate against was undefined.
1129 bfd_reloc_undefined
,
1131 /* The relocaction was performed, but may not be ok - presently generated
1132 only when linking i960 coff files with i960 b.out symbols.
1136 bfd_reloc_status_enum_type
;
1137 typedef struct reloc_cache_entry
1140 /* A pointer into the canonical table of pointers
1142 struct symbol_cache_entry
**sym_ptr_ptr
;
1144 /* offset in section
1146 rawdata_offset address
;
1148 /* addend for relocation value
1152 /* if sym is null this is the section
1154 struct sec
*section
;
1156 /* Pointer to how to perform the required relocation
1158 CONST
struct reloc_howto_struct
*howto
;
1161 /* The @code{reloc_howto_type} is a structure which contains all the
1162 information that bfd needs to know to tie up a back end's data.
1165 typedef CONST
struct reloc_howto_struct
1168 /* The type field has mainly a documetary use - the back end can to what
1169 it wants with it, though the normally the back end's external idea of
1170 what a reloc number would be would be stored in this field. For
1171 example, the a PC relative word relocation in a coff environment would
1172 have the type 023 - because that's what the outside world calls a
1177 /* The value the final relocation is shifted right by. This drops
1178 unwanted data from the relocation.
1180 unsigned int rightshift
;
1182 /* The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1189 unsigned int bitsize
;
1191 /* Notes that the relocation is relative to the location in the data
1192 section of the addend. The relocation function will subtract from the
1193 relocation value the address of the location being relocated.
1195 boolean pc_relative
;
1199 unsigned int bitpos
;
1205 /* Causes the relocation routine to return an error if overflow is
1206 detected when relocating.
1208 boolean complain_on_overflow
;
1210 /* If this field is non null, then the supplied function is called rather
1211 than the normal function. This allows really strange relocation
1212 methods to be accomodated (eg, i960 callj instructions).
1214 bfd_reloc_status_enum_type (*special_function
)();
1216 /* The textual name of the relocation type.
1220 /* When performing a partial link, some formats must modify the
1221 relocations rather than the data - this flag signals this.
1223 boolean partial_inplace
;
1225 /* The src_mask is used to select what parts of the read in data are to
1226 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1227 which we read and relocated, this would be 0x000000ff. When we have
1228 relocs which have an addend, such as sun4 extended relocs, the value
1229 in the offset part of a relocating field is garbage so we never use
1230 it. In this case the mask would be 0x00000000.
1234 /* The dst_mask is what parts of the instruction are replaced into the
1235 instruction. In most cases src_mask == dst_mask, except in the above
1236 special case, where dst_mask would be 0x000000ff, and src_mask would
1241 /* When some formats create PC relative instructions, they leave the
1242 value of the pc of the place being relocated in the offset slot of the
1243 instruction, so that a PC relative relocation can be made just by
1244 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1245 displacement part of an instruction empty (eg m88k bcs), this flag
1248 boolean pcrel_offset
;
1251 /* The HOWTO define is horrible and will go away.
1253 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1254 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1255 typedef unsigned char bfd_byte
;
1257 typedef struct relent_chain
{
1259 struct relent_chain
*next
;
1263 /* If an output_bfd is supplied to this function the generated image
1264 will be relocatable, the relocations are copied to the output file
1265 after they have been changed to reflect the new state of the world.
1266 There are two ways of reflecting the results of partial linkage in an
1267 output file; by modifying the output data in place, and by modifying
1268 the relocation record. Some native formats (eg basic a.out and basic
1269 coff) have no way of specifying an addend in the relocation type, so
1270 the addend has to go in the output data. This is no big deal since in
1271 these formats the output data slot will always be big enough for the
1272 addend. Complex reloc types with addends were invented to solve just
1275 PROTO(bfd_reloc_status_enum_type
,
1276 bfd_perform_relocation
,
1278 arelent
*reloc_entry
,
1280 asection
*input_section
,
1283 @subsection bfd_target
1284 This structure contains everything that BFD knows about a target.
1285 It includes things like its byte order, name, what routines to call
1286 to do various operations, etc.
1288 Every BFD points to a target structure with its "xvec" member.
1291 Shortcut for declaring fields which are prototyped function pointers,
1292 while avoiding anguish on compilers that don't support protos.
1294 #define SDEF(ret, name, arglist) \
1295 PROTO(ret,(*name),arglist)
1296 #define SDEF_FMT(ret, name, arglist) \
1297 PROTO(ret,(*name[bfd_type_end]),arglist)
1299 /* These macros are used to dispatch to functions through the bfd_target
1300 vector. They are used in a number of macros further down in bfd.h, and
1301 are also used when calling various routines by hand inside the bfd
1302 implementation. The "arglist" argument must be parenthesized; it
1303 contains all the arguments to the called function.
1305 #define BFD_SEND(bfd, message, arglist) \
1306 ((*((bfd)->xvec->message)) arglist)
1308 /* For operations which index on the bfd format
1310 #define BFD_SEND_FMT(bfd, message, arglist) \
1311 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1313 /* This is the struct which defines the type of BFD this is. The
1314 "xvec" member of the struct bfd itself points here. Each module
1315 that implements access to a different target under BFD, defines
1318 FIXME, these names should be rationalised with the names of the
1319 entry points which call them. Too bad we can't have one macro to
1323 typedef struct bfd_target
1326 /* identifies the kind of target, eg SunOS4, Ultrix, etc
1330 /* The "flavour" of a back end is a general indication about the contents
1333 enum target_flavour_enum
{
1334 bfd_target_aout_flavour_enum
,
1335 bfd_target_coff_flavour_enum
,
1336 bfd_target_ieee_flavour_enum
,
1337 bfd_target_oasys_flavour_enum
,
1338 bfd_target_srec_flavour_enum
} flavour
;
1340 /* The order of bytes within the data area of a file.
1342 boolean byteorder_big_p
;
1344 /* The order of bytes within the header parts of a file.
1346 boolean header_byteorder_big_p
;
1348 /* This is a mask of all the flags which an executable may have set -
1349 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
1351 flagword object_flags
;
1353 /* This is a mask of all the flags which a section may have set - from
1354 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
1356 flagword section_flags
;
1358 /* The pad character for filenames within an archive header.
1362 /* The maximum number of characters in an archive header.
1364 unsigned short ar_max_namelen
;
1366 /* The minimum alignment restriction for any section.
1368 unsigned int align_power_min
;
1370 /* Entries for byte swapping for data. These are different to the other
1371 entry points, since they don't take bfd as first arg. Certain other handlers
1374 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
1375 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
1376 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
1377 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
1378 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
1379 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
1381 /* Byte swapping for the headers
1383 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
1384 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
1385 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
1386 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
1387 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
1388 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
1390 /* Format dependent routines, these turn into vectors of entry points
1391 within the target vector structure; one for each format to check.
1393 Check the format of a file being read. Return bfd_target * or zero.
1395 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
1397 /* Set the format of a file being written.
1399 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
1401 /* Write cached information into a file being written, at bfd_close.
1403 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
1405 /* The following functions are defined in @code{JUMP_TABLE}. The idea is
1406 that the back end writer of @code{foo} names all the routines
1407 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
1408 in this structure in the right order.
1410 Core file entry points
1412 SDEF (char *, _core_file_failing_command
, (bfd
*));
1413 SDEF (int, _core_file_failing_signal
, (bfd
*));
1414 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
1416 /* Archive entry points
1418 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
1419 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
1420 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
1421 SDEF (boolean
, write_armap
, (bfd
*arch
,
1422 unsigned int elength
,
1429 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
1430 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
1431 file_ptr
, bfd_size_type
));
1432 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
1433 file_ptr
, bfd_size_type
));
1434 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
1436 /* Symbols and reloctions
1438 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
1439 SDEF (unsigned int, _bfd_canonicalize_symtab
,
1440 (bfd
*, struct symbol_cache_entry
**));
1441 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
1442 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
1443 struct symbol_cache_entry
**));
1444 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
1445 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
1446 bfd_print_symbol_enum_type
));
1447 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1448 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
1450 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
1453 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
1454 SDEF (boolean
, _bfd_find_nearest_line
,
1455 (bfd
*abfd
, struct sec
*section
,
1456 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
1457 CONST
char **file
, CONST
char **func
, unsigned int *line
));
1458 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
1460 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
1462 SDEF (void, _bfd_debug_info_start
, (bfd
*));
1463 SDEF (void, _bfd_debug_info_end
, (bfd
*));
1464 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
1466 /* Special entry points for gdb to swap in coff symbol table parts
1468 SDEF(void, _bfd_coff_swap_aux_in
,(
1475 SDEF(void, _bfd_coff_swap_sym_in
,(
1480 SDEF(void, _bfd_coff_swap_lineno_in
, (
1487 /* Returns a pointer to the transfer vector for the object target
1488 named target_name. If target_name is NULL, chooses the one in the
1489 environment variable GNUTARGET; if that is null or not defined then
1490 the first entry in the target list is chosen. Passing in the
1491 string "default" or setting the environment variable to "default"
1492 will cause the first entry in the target list to be returned,
1493 and "target_defaulted" will be set in the bfd. This causes
1494 bfd_check_format to loop over all the targets to find the one
1495 that matches the file being read.
1497 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
1498 /* This function returns a freshly malloced NULL-terminated vector of the
1499 names of all the valid bfd targets. Do not modify the names
1501 PROTO(CONST
char **,bfd_target_list
,());
1502 /* This routine is supplied a bfd and a format. It attempts to verify if
1503 the file attatched to the bfd is indeed compatible with the format
1504 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
1507 If the bfd has been set to a specific @var{target} before the call,
1508 only the named target and format combination will be checked. If the
1509 target has not been set, or has been set to @code{default} then all
1510 the known target backends will be interrogated to determine a match.
1512 The function returns @code{true} on success, otherwise @code{false}
1513 with one of the following error codes:
1517 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
1519 @item system_call_error
1520 if an error occured during a read - even some file mismatches can
1521 cause system_call_errros
1522 @item file_not_recognised
1523 none of the backends recognised the file format
1524 @item file_ambiguously_recognized
1525 more than one backend recognised the file format.
1528 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
1529 /* This function sets the file format of the supplied bfd to the format
1530 requested. If the target set in the bfd does not support the format
1531 requested, the format is illegal or the bfd is not open for writing
1532 than an error occurs.
1534 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
1535 /* This function takes one argument, and enumerated type (bfd_format) and
1536 returns a pointer to a const string "invalid", "object", "archive",
1537 "core" or "unknown" depending upon the value of the enumeration.
1539 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));