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 */
315 Opens the file supplied (using @code{fopen}) with the target supplied, it
316 returns a pointer to the created BFD.
318 If NULL is returned then an error has occured.
319 Possible errors are no_memory, invalid_target or system_call error.
321 PROTO(bfd
*, bfd_openr
, (CONST
char *filename
,CONST
char*target
));
326 bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a BFD on
327 a file already described by the @var{fd} supplied.
329 Possible errors are no_memory, invalid_target and system_call error.
331 PROTO(bfd
*, bfd_fdopenr
,
332 (CONST
char *filename
, CONST
char *target
, int fd
));
337 Creates a BFD, associated with file @var{filename}, using the file
338 format @var{target}, and returns a pointer to it.
340 Possible errors are system_call_error, no_memory, invalid_target.
342 PROTO(bfd
*, bfd_openw
, (CONST
char *filename
, CONST
char *target
));
347 This function closes a BFD. If the BFD was open for writing, then
348 pending operations are completed and the file written out and closed.
349 If the created file is executable, then @code{chmod} is called to mark
352 All memory attached to the BFD's obstacks is released.
354 @code{true} is returned if all is ok, otherwise @code{false}.
356 PROTO(boolean
, bfd_close
,(bfd
*));
361 This routine creates a new BFD in the manner of @code{bfd_openw}, but without
362 opening a file. The new BFD takes the target from the target used by
363 @var{template}. The format is always set to @code{bfd_object}.
366 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
371 Return the number of bytes in the obstacks connected to the supplied
374 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
381 This enum gives the object file's CPU
382 architecture, in a global sense. E.g. what processor family does it
383 belong to? There is another field, which indicates what processor
384 within the family is in use. The machine gives a number which
385 distingushes different versions of the architecture, containing for
386 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
387 Motorola 68020 and 68030.
390 enum bfd_architecture
392 bfd_arch_unknown
, /* File arch not known */
393 bfd_arch_obscure
, /* Arch known, not one of these */
394 bfd_arch_m68k
, /* Motorola 68xxx */
395 bfd_arch_vax
, /* DEC Vax */
396 bfd_arch_i960
, /* Intel 960 */
397 /* The order of the following is important.
398 lower number indicates a machine type that
399 only accepts a subset of the instructions
400 available to machines with higher numbers.
401 The exception is the "ca", which is
402 incompatible with all other machines except
405 #define bfd_mach_i960_core 1
406 #define bfd_mach_i960_ka_sa 2
407 #define bfd_mach_i960_kb_sb 3
408 #define bfd_mach_i960_mc 4
409 #define bfd_mach_i960_xa 5
410 #define bfd_mach_i960_ca 6
412 bfd_arch_a29k
, /* AMD 29000 */
413 bfd_arch_sparc
, /* SPARC */
414 bfd_arch_mips
, /* MIPS Rxxxx */
415 bfd_arch_i386
, /* Intel 386 */
416 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
417 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
418 bfd_arch_i860
, /* Intel 860 */
419 bfd_arch_romp
, /* IBM ROMP RS/6000 */
420 bfd_arch_alliant
, /* Alliant */
421 bfd_arch_convex
, /* Convex */
422 bfd_arch_m88k
, /* Motorola 88xxx */
423 bfd_arch_pyramid
, /* Pyramid Technology */
424 bfd_arch_h8_300
, /* Hitachi H8/300 */
431 bfd_prinable_arch_mach
432 Return a printable string representing the architecture and machine
433 type. The result is only good until the next call to
434 @code{bfd_printable_arch_mach}.
436 PROTO(CONST
char *,bfd_printable_arch_mach
,
437 (enum bfd_architecture arch
, unsigned long machine
));
441 *i bfd_scan_arch_mach
442 Scan a string and attempt to turn it into an archive and machine type combination.
444 PROTO(boolean
, bfd_scan_arch_mach
,
445 (CONST
char *, enum bfd_architecture
*, unsigned long *));
449 *i bfd_arch_compatible
450 This routine is used to determine whether two BFDs' architectures and machine types are
451 compatible. It calculates the lowest common denominator between the
452 two architectures and machine types implied by the BFDs and sets the
453 objects pointed at by @var{archp} and @var{machine} if non NULL.
455 This routine returns @code{true} if the BFDs are of compatible type,
456 otherwise @code{false}.
458 PROTO(boolean
, bfd_arch_compatible
,
461 enum bfd_architecture
*archp
,
462 unsigned long *machinep
));
469 #define bfd_set_arch_mach(abfd, arch, mach) \
470 BFD_SEND (abfd, _bfd_set_arch_mach,\
476 These macros as used for reading and writing raw data in sections;
477 each access (except for bytes) is vectored through the target format
478 of the BFD and mangled accordingly. The mangling performs any
479 necessary endian translations and removes alignment restrictions.
481 #define bfd_put_8(abfd, val, ptr) \
482 (*((char *)ptr) = (char)val)
483 #define bfd_get_8(abfd, ptr) \
485 #define bfd_put_16(abfd, val, ptr) \
486 BFD_SEND(abfd, bfd_putx16, (val,ptr))
487 #define bfd_get_16(abfd, ptr) \
488 BFD_SEND(abfd, bfd_getx16, (ptr))
489 #define bfd_put_32(abfd, val, ptr) \
490 BFD_SEND(abfd, bfd_putx32, (val,ptr))
491 #define bfd_get_32(abfd, ptr) \
492 BFD_SEND(abfd, bfd_getx32, (ptr))
493 #define bfd_put_64(abfd, val, ptr) \
494 BFD_SEND(abfd, bfd_putx64, (val, ptr))
495 #define bfd_get_64(abfd, ptr) \
496 BFD_SEND(abfd, bfd_getx64, (ptr))
499 These macros have the same function as their @code{bfd_get_x}
500 bretherin, except that they are used for removing information for the
501 header records of object files. Believe it or not, some object files
502 keep their header records in big endian order, and their data in little
505 #define bfd_h_put_8(abfd, val, ptr) \
506 (*((char *)ptr) = (char)val)
507 #define bfd_h_get_8(abfd, ptr) \
509 #define bfd_h_put_16(abfd, val, ptr) \
510 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
511 #define bfd_h_get_16(abfd, ptr) \
512 BFD_SEND(abfd, bfd_h_getx16,(ptr))
513 #define bfd_h_put_32(abfd, val, ptr) \
514 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
515 #define bfd_h_get_32(abfd, ptr) \
516 BFD_SEND(abfd, bfd_h_getx32,(ptr))
517 #define bfd_h_put_64(abfd, val, ptr) \
518 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
519 #define bfd_h_get_64(abfd, ptr) \
520 BFD_SEND(abfd, bfd_h_getx64,(ptr))
523 /* The shape of a section struct:
529 The name of the section, the name isn't a copy, the pointer is
530 the same as that passed to bfd_make_section.
536 The next section in the list belonging to the BFD, or NULL.
542 The field flags contains attributes of the section. Some of these
543 flags are read in from the object file, and some are synthesized from
552 #define SEC_NO_FLAGS 0x000
555 Tells the OS to allocate space for this section when loaded.
556 This would clear for a section containing debug information only.
559 #define SEC_ALLOC 0x001
562 Tells the OS to load the section from the file when loading.
563 This would be clear for a .bss section
566 #define SEC_LOAD 0x002
569 The section contains data still to be relocated, so there will be some
570 relocation information too.
573 #define SEC_RELOC 0x004
579 #define SEC_BALIGN 0x008
582 A signal to the OS that the section contains read only data.
585 #define SEC_READONLY 0x010
588 The section contains code only.
591 #define SEC_CODE 0x020
594 The section contains data only.
597 #define SEC_DATA 0x040
600 The section will reside in ROM.
603 #define SEC_ROM 0x080
606 The section contains constructor information. This section type is
607 used by the linker to create lists of constructors and destructors
608 used by @code{g++}. When a back end sees a symbol which should be used
609 in a constructor list, it creates a new section for the type of name
610 (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a
611 relocation. To build the lists of constructors, all the linker has to
612 to is catenate all the sections called @code{__CTOR_LIST__} and
613 relocte the data contained within - exactly the operations it would
614 peform on standard data.
617 #define SEC_CONSTRUCTOR 0x100
620 The section is a constuctor, and should be placed at the end of the ..
623 #define SEC_CONSTRUCTOR_TEXT 0x1100
627 #define SEC_CONSTRUCTOR_DATA 0x2100
631 #define SEC_CONSTRUCTOR_BSS 0x3100
635 The section has contents - a bss section could be
636 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
637 @code{SEC_HAS_CONTENTS}
640 #define SEC_HAS_CONTENTS 0x200
643 An instruction to the linker not to output sections containing
644 this flag even if they have information which would normally be written.
647 #define SEC_NEVER_LOAD 0x400
651 The base address of the section in the address space of the target.
657 The size of the section in bytes of the loaded section. This contains
658 a value even if the section has no contents (eg, the size of @code{.bss}).
664 If this section is going to be output, then this value is the
665 offset into the output section of the first byte in the input
666 section. Eg, if this was going to start at the 100th byte in the
667 output section, this value would be 100.
670 bfd_vma output_offset
;
673 The output section through which to map on output.
676 struct sec
*output_section
;
679 The alignment requirement of the section, as an exponent - eg 3
683 unsigned int alignment_power
;
686 If an input section, a pointer to a vector of relocation records for
687 the data in this section.
690 struct reloc_cache_entry
*relocation
;
693 If an output section, a pointer to a vector of pointers to
694 relocation records for the data in this section.
697 struct reloc_cache_entry
**orelocation
;
700 The number of relocation records in one of the above
703 unsigned reloc_count
;
706 Which section is it 0..nth
712 Information below is back end specific - and not always used or
715 File position of section data
719 /* File position of relocation info
722 file_ptr rel_filepos
;
725 File position of line data
728 file_ptr line_filepos
;
731 Pointer to data for applications
738 struct lang_output_section
*otheruserdata
;
741 Attached line number information
745 /* Number of line number records
748 unsigned int lineno_count
;
751 When a section is being output, this value changes as more
752 linenumbers are written out
755 file_ptr moving_line_filepos
;
758 what the section number is in the target world
761 unsigned int target_index
;
768 If this is a constructor section then here is a list of the
769 relocations created to relocate items within it.
772 struct relent_chain
*constructor_chain
;
775 The BFD which owns the section.
786 bfd_get_section_by_name
787 Runs through the provided @var{abfd} and returns the @code{asection}
788 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
791 PROTO(asection
*, bfd_get_section_by_name
,
792 (bfd
*abfd
, CONST
char *name
));
797 This function creates a new empty section called @var{name} and attaches it
798 to the end of the chain of sections for the BFD supplied. An attempt to
799 create a section with a name which is already in use, returns the old
800 section by that name instead.
804 @item invalid_operation
805 If output has already started for this BFD.
807 If obstack alloc fails.
811 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
815 bfd_set_section_flags
816 Attempts to set the attributes of the section named in the BFD
817 supplied to the value. Returns true on success, false on error.
818 Possible error returns are:
820 @item invalid operation
821 The section cannot have one or more of the attributes requested. For
822 example, a .bss section in @code{a.out} may not have the
823 @code{SEC_HAS_CONTENTS} field set.
827 PROTO(boolean
, bfd_set_section_flags
,
828 (bfd
*, asection
*, flagword
));
832 bfd_map_over_sections
833 Calls the provided function @var{func} for each section attached to
834 the BFD @var{abfd}, passing @var{obj} as an argument. The function
835 will be called as if by
838 func(abfd, the_section, obj);
842 PROTO(void, bfd_map_over_sections
,
843 (bfd
*abfd
, void (*func
)(), PTR obj
));
847 This is the prefered method for iterating over sections, an
848 alternative would be to use a loop:
852 for (p = abfd->sections; p != NULL; p = p->next)
857 Sets @var{section} to the size @var{val}. If the operation is ok, then
858 @code{true} is returned, else @code{false}.
860 Possible error returns:
862 @item invalid_operation
863 Writing has started to the BFD, so setting the size is invalid
867 PROTO(boolean
, bfd_set_section_size
,
868 (bfd
*, asection
*, bfd_size_type val
));
872 bfd_set_section_contents
873 Sets the contents of the section @var{section} in BFD @var{abfd} to
874 the data starting in memory at @var{data}. The data is written to the
875 output section starting at offset @var{offset} for @var{count} bytes.
877 Normally @code{true} is returned, else @code{false}. Possible error
881 The output section does not have the @code{SEC_HAS_CONTENTS}
882 attribute, so nothing can be written to it.
883 @item and some more too
885 This routine is front end to the back end function @code{_bfd_set_section_contents}.
888 PROTO(boolean
, bfd_set_section_contents
,
893 bfd_size_type count
));
897 bfd_get_section_contents
898 This function reads data from @var{section} in BFD @var{abfd} into
899 memory starting at @var{location}. The data is read at an offset of
900 @var{offset} from the start of the input section, and is read for
903 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
904 set are requested, then the @var{location} is filled with zeroes.
906 If no errors occur, @code{true} is returned, else @code{false}.
914 PROTO(boolean
, bfd_get_section_contents
,
915 (bfd
*abfd
, asection
*section
, PTR location
,
916 file_ptr offset
, bfd_size_type count
));
923 /* @subsection typedef asymbol
924 An @code{asymbol} has the form:
927 typedef struct symbol_cache_entry
929 /* A pointer to the BFD which owns the symbol. This information is
930 necessary so that a back end can work out what additional (invisible to
931 the application writer) information is carried with the symbol.
934 struct _bfd
*the_bfd
;
937 The text of the symbol. The name is left alone, and not copied - the
938 application may not alter it.
944 The value of the symbol.
950 Attributes of a symbol:
953 #define BSF_NO_FLAGS 0x00
956 The symbol has local scope; @code{static} in @code{C}. The value is
957 the offset into the section of the data.
960 #define BSF_LOCAL 0x01
963 The symbol has global scope; initialized data in @code{C}. The value
964 is the offset into the section of the data.
967 #define BSF_GLOBAL 0x02
973 #define BSF_IMPORT 0x04
976 The symbol has global scope, and is exported. The value is the offset
977 into the section of the data.
980 #define BSF_EXPORT 0x08
983 The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
986 #define BSF_UNDEFINED 0x10
989 The symbol is common, initialized to zero; default in @code{C}. The
990 value is the size of the object in bytes.
993 #define BSF_FORT_COMM 0x20
996 A normal @code{C} symbol would be one of:
997 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
999 The symbol is a debugging record. The value has an arbitary meaning.
1002 #define BSF_DEBUGGING 0x40
1005 The symbol has no section attached, any value is the actual value and
1006 is not a relative offset to a section.
1009 #define BSF_ABSOLUTE 0x80
1015 #define BSF_KEEP 0x10000
1016 #define BSF_KEEP_G 0x80000
1022 #define BSF_WEAK 0x100000
1023 #define BSF_CTOR 0x200000
1024 #define BSF_FAKE 0x400000
1027 The symbol used to be a common symbol, but now it is allocated.
1030 #define BSF_OLD_COMMON 0x800000
1033 The default value for common data.
1036 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1039 In some files the type of a symbol sometimes alters its location
1040 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
1041 symbol appears where it was declared and not at the end of a section.
1042 This bit is set by the target BFD part to convey this information.
1045 #define BSF_NOT_AT_END 0x40000
1048 Signal that the symbol is the label of constructor section.
1051 #define BSF_CONSTRUCTOR 0x1000000
1054 Signal that the symbol is a warning symbol. If the symbol is a warning
1055 symbol, then the value field (I know this is tacky) will point to the
1056 asymbol which when referenced will cause the warning.
1059 #define BSF_WARNING 0x2000000
1062 Signal that the symbol is indirect. The value of the symbol is a
1063 pointer to an undefined asymbol which contains the name to use
1067 #define BSF_INDIRECT 0x4000000
1074 Aointer to the section to which this symbol is relative, or 0 if the
1075 symbol is absolute or undefined. Note that it is not sufficient to set
1076 this location to 0 to mark a symbol as absolute - the flag
1077 @code{BSF_ABSOLUTE} must be set also.
1080 struct sec
*section
;
1083 Back end special data. This is being phased out in favour of making
1092 get_symtab_upper_bound
1093 Returns the number of bytes required in a vector of pointers to
1094 @code{asymbols} for all the symbols in the supplied BFD, including a
1095 terminal NULL pointer. If there are no symbols in the BFD, then 0 is
1098 #define get_symtab_upper_bound(abfd) \
1099 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1103 bfd_canonicalize_symtab
1104 Supplied a BFD and a pointer to an uninitialized vector of pointers.
1105 This reads in the symbols from the BFD, and fills in the table with
1106 pointers to the symbols, and a trailing NULL. The routine returns the
1107 actual number of symbol pointers not including the NULL.
1110 #define bfd_canonicalize_symtab(abfd, location) \
1111 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1116 Provided a table of pointers to to symbols and a count, writes to the
1117 output BFD the symbols when closed.
1120 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
1124 bfd_print_symbol_vandf
1125 Prints the value and flags of the symbol supplied to the stream file.
1128 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
1132 bfd_make_empty_symbol
1133 This function creates a new @code{asymbol} structure for the BFD, and
1134 returns a pointer to it.
1136 This routine is necessary, since each back end has private information
1137 surrounding the @code{asymbol}. Building your own @code{asymbol} and
1138 pointing to it will not create the private information, and will cause
1141 #define bfd_make_empty_symbol(abfd) \
1142 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1145 /* @section typedef bfd
1147 Pointers to bfd structs are the cornerstone of any application using
1148 @code{libbfd}. References though the BFD and to data in the BFD give the
1149 entire BFD functionality.
1151 Here is the BFD struct itself. This contains the major data about
1152 the file, and contains pointers to the rest of the data.
1157 /* The filename the application opened the BFD with.
1160 CONST
char *filename
;
1163 A pointer to the target jump table.
1166 struct bfd_target
*xvec
;
1170 To avoid dragging too many header files into every file that
1171 includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME
1172 as a "long". Their correct types, to which they are cast when used,
1173 are "FILE *" and "time_t".
1175 The iostream is the result of an fopen on the filename.
1181 Is the file being cached @xref{File Caching}.
1187 Marks whether there was a default target specified when the BFD was
1188 opened. This is used to select what matching algorithm to use to chose
1192 boolean target_defaulted
;
1195 The caching routines use these to maintain a least-recently-used list of
1196 BFDs (@pxref{File Caching}).
1199 struct _bfd
*lru_prev
, *lru_next
;
1202 When a file is closed by the caching routines, BFD retains state
1203 information on the file here:
1212 boolean opened_once
;
1217 /* File modified time
1223 For output files, channel we locked (is this used?).
1229 The format which belongs to the BFD.
1235 The direction the BFD was opened with
1238 enum bfd_direction
{no_direction
= 0,
1240 write_direction
= 2,
1241 both_direction
= 3} direction
;
1244 Format_specific flags
1250 Currently my_archive is tested before adding origin to anything. I
1251 believe that this can become always an add of origin, with origin set
1252 to 0 for non archive files.
1258 Remember when output has begun, to stop strange things happening.
1261 boolean output_has_begun
;
1264 Pointer to linked list of sections
1267 struct sec
*sections
;
1270 The number of sections
1273 unsigned int section_count
;
1276 Stuff only useful for object files:
1280 bfd_vma start_address
;
1281 /* Used for input and output
1284 unsigned int symcount
;
1285 /* Symbol table for output BFD
1288 struct symbol_cache_entry
**outsymbols
;
1291 Architecture of object machine, eg m68k
1294 enum bfd_architecture obj_arch
;
1297 Particular machine within arch, e.g. 68010
1300 unsigned long obj_machine
;
1303 Stuff only useful for archives:
1307 struct _bfd
*my_archive
;
1309 struct _bfd
*archive_head
;
1313 Used by the back end to hold private data.
1319 Used by the application to hold private data
1325 Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}).
1328 struct obstack memory
;
1333 bfd_set_start_address
1335 Marks the entry point of an output BFD. Returns @code{true} on
1336 success, @code{false} otherwise.
1339 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1345 Return cached file modification time (e.g. as read from archive header
1346 for archive members, or from file system if we have been called
1347 before); else determine modify time, cache it, and return it.
1350 PROTO(long, bfd_get_mtime
, (bfd
*));
1358 #define bfd_sizeof_headers(abfd, reloc) \
1359 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1361 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1362 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1364 #define bfd_debug_info_start(abfd) \
1365 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1367 #define bfd_debug_info_end(abfd) \
1368 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1370 #define bfd_debug_info_accumulate(abfd, section) \
1371 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1373 #define bfd_stat_arch_elt(abfd, stat) \
1374 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1376 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1377 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1379 #define bfd_coff_swap_sym_in(a,e,i) \
1380 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1382 #define bfd_coff_swap_lineno_in(a,e,i) \
1383 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1389 /* bfd_get_next_mapent
1392 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1396 bfd_set_archive_head
1397 Used whilst processing archives. Sets the head of the chain of BFDs
1398 contained in an archive to @var{new_head}. (see chapter on archives)
1400 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1404 bfd_get_elt_at_index
1407 PROTO(bfd
*, bfd_get_elt_at_index
, (bfd
*, int));
1411 bfd_openr_next_archived_file
1412 Initially provided a BFD containing an archive and NULL, opens a BFD
1413 on the first contained element and returns that. Subsequent calls to
1414 bfd_openr_next_archived_file should pass the archive and the previous
1415 return value to return a created BFD to the next contained element.
1416 NULL is returned when there are no more.
1419 PROTO(bfd
*, bfd_openr_next_archived_file
,
1420 (bfd
*archive
, bfd
*previous
));
1427 /* bfd_core_file_failing_command
1428 Returns a read-only string explaining what program was running when
1429 it failed and produced the core file being read
1432 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1436 bfd_core_file_failing_signal
1437 Returns the signal number which caused the core dump which generated
1438 the file the BFD is attached to.
1441 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1445 core_file_matches_executable_p
1446 Returns @code{true} if the core file attached to @var{core_bfd} was
1447 generated by a run of the executable file attached to @var{exec_bfd},
1448 or else @code{false}.
1450 PROTO(boolean
, core_file_matches_executable_p
,
1451 (bfd
*core_bfd
, bfd
*exec_bfd
));
1457 /* bfd_perform_relocation
1458 The relocation routine returns as a status an enumerated type:
1461 typedef enum bfd_reloc_status
{
1462 /* No errors detected
1468 The relocation was performed, but there was an overflow.
1474 The address to relocate was not within the section supplied
1477 bfd_reloc_outofrange
,
1480 Used by special functions
1489 bfd_reloc_notsupported
,
1492 Unsupported relocation size requested.
1498 The symbol to relocate against was undefined.
1501 bfd_reloc_undefined
,
1504 The relocaction was performed, but may not be ok - presently generated
1505 only when linking i960 coff files with i960 b.out symbols.
1510 bfd_reloc_status_enum_type
;
1515 typedef struct reloc_cache_entry
1519 A pointer into the canonical table of pointers
1522 struct symbol_cache_entry
**sym_ptr_ptr
;
1528 rawdata_offset address
;
1531 addend for relocation value
1537 if sym is null this is the section
1540 struct sec
*section
;
1543 Pointer to how to perform the required relocation
1546 CONST
struct reloc_howto_struct
*howto
;
1552 The @code{reloc_howto_type} is a structure which contains all the
1553 information that BFD needs to know to tie up a back end's data.
1556 typedef CONST
struct reloc_howto_struct
1558 /* The type field has mainly a documetary use - the back end can to what
1559 it wants with it, though the normally the back end's external idea of
1560 what a reloc number would be would be stored in this field. For
1561 example, the a PC relative word relocation in a coff environment would
1562 have the type 023 - because that's what the outside world calls a
1569 The value the final relocation is shifted right by. This drops
1570 unwanted data from the relocation.
1573 unsigned int rightshift
;
1576 The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1586 unsigned int bitsize
;
1589 Notes that the relocation is relative to the location in the data
1590 section of the addend. The relocation function will subtract from the
1591 relocation value the address of the location being relocated.
1594 boolean pc_relative
;
1600 unsigned int bitpos
;
1609 Causes the relocation routine to return an error if overflow is
1610 detected when relocating.
1613 boolean complain_on_overflow
;
1616 If this field is non null, then the supplied function is called rather
1617 than the normal function. This allows really strange relocation
1618 methods to be accomodated (eg, i960 callj instructions).
1621 bfd_reloc_status_enum_type (*special_function
)();
1624 The textual name of the relocation type.
1630 When performing a partial link, some formats must modify the
1631 relocations rather than the data - this flag signals this.
1634 boolean partial_inplace
;
1637 The src_mask is used to select what parts of the read in data are to
1638 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1639 which we read and relocated, this would be 0x000000ff. When we have
1640 relocs which have an addend, such as sun4 extended relocs, the value
1641 in the offset part of a relocating field is garbage so we never use
1642 it. In this case the mask would be 0x00000000.
1646 /* The dst_mask is what parts of the instruction are replaced into the
1647 instruction. In most cases src_mask == dst_mask, except in the above
1648 special case, where dst_mask would be 0x000000ff, and src_mask would
1655 When some formats create PC relative instructions, they leave the
1656 value of the pc of the place being relocated in the offset slot of the
1657 instruction, so that a PC relative relocation can be made just by
1658 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1659 displacement part of an instruction empty (eg m88k bcs), this flag
1663 boolean pcrel_offset
;
1669 The HOWTO define is horrible and will go away.
1671 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1672 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1678 typedef unsigned char bfd_byte
;
1680 typedef struct relent_chain
{
1682 struct relent_chain
*next
;
1687 If an output_bfd is supplied to this function the generated image
1688 will be relocatable, the relocations are copied to the output file
1689 after they have been changed to reflect the new state of the world.
1690 There are two ways of reflecting the results of partial linkage in an
1691 output file; by modifying the output data in place, and by modifying
1692 the relocation record. Some native formats (eg basic a.out and basic
1693 coff) have no way of specifying an addend in the relocation type, so
1694 the addend has to go in the output data. This is no big deal since in
1695 these formats the output data slot will always be big enough for the
1696 addend. Complex reloc types with addends were invented to solve just
1699 PROTO(bfd_reloc_status_enum_type
,
1700 bfd_perform_relocation
,
1702 arelent
*reloc_entry
,
1704 asection
*input_section
,
1713 @subsection bfd_target
1714 This structure contains everything that BFD knows about a target.
1715 It includes things like its byte order, name, what routines to call
1716 to do various operations, etc.
1718 Every BFD points to a target structure with its "xvec" member.
1720 Shortcut for declaring fields which are prototyped function pointers,
1721 while avoiding anguish on compilers that don't support protos.
1724 #define SDEF(ret, name, arglist) \
1725 PROTO(ret,(*name),arglist)
1726 #define SDEF_FMT(ret, name, arglist) \
1727 PROTO(ret,(*name[bfd_type_end]),arglist)
1730 These macros are used to dispatch to functions through the bfd_target
1731 vector. They are used in a number of macros further down in @file{bfd.h}, and
1732 are also used when calling various routines by hand inside the BFD
1733 implementation. The "arglist" argument must be parenthesized; it
1734 contains all the arguments to the called function.
1737 #define BFD_SEND(bfd, message, arglist) \
1738 ((*((bfd)->xvec->message)) arglist)
1741 For operations which index on the BFD format
1744 #define BFD_SEND_FMT(bfd, message, arglist) \
1745 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1748 This is the struct which defines the type of BFD this is. The
1749 "xvec" member of the struct @code{bfd} itself points here. Each module
1750 that implements access to a different target under BFD, defines
1753 FIXME, these names should be rationalised with the names of the
1754 entry points which call them. Too bad we can't have one macro to
1758 typedef struct bfd_target
1762 identifies the kind of target, eg SunOS4, Ultrix, etc
1768 The "flavour" of a back end is a general indication about the contents
1772 enum target_flavour_enum
{
1773 bfd_target_aout_flavour_enum
,
1774 bfd_target_coff_flavour_enum
,
1775 bfd_target_ieee_flavour_enum
,
1776 bfd_target_oasys_flavour_enum
,
1777 bfd_target_srec_flavour_enum
} flavour
;
1780 The order of bytes within the data area of a file.
1783 boolean byteorder_big_p
;
1786 The order of bytes within the header parts of a file.
1789 boolean header_byteorder_big_p
;
1792 This is a mask of all the flags which an executable may have set -
1793 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
1796 flagword object_flags
;
1799 This is a mask of all the flags which a section may have set - from
1800 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
1803 flagword section_flags
;
1806 The pad character for filenames within an archive header.
1812 The maximum number of characters in an archive header.
1815 unsigned short ar_max_namelen
;
1818 The minimum alignment restriction for any section.
1821 unsigned int align_power_min
;
1824 Entries for byte swapping for data. These are different to the other
1825 entry points, since they don't take BFD as first arg. Certain other handlers
1829 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
1830 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
1831 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
1832 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
1833 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
1834 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
1837 Byte swapping for the headers
1840 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
1841 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
1842 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
1843 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
1844 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
1845 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
1848 Format dependent routines, these turn into vectors of entry points
1849 within the target vector structure; one for each format to check.
1851 Check the format of a file being read. Return bfd_target * or zero.
1854 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
1857 Set the format of a file being written.
1860 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
1863 Write cached information into a file being written, at bfd_close.
1866 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
1869 The following functions are defined in @code{JUMP_TABLE}. The idea is
1870 that the back end writer of @code{foo} names all the routines
1871 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
1872 in this structure in the right order.
1874 Core file entry points
1877 SDEF (char *, _core_file_failing_command
, (bfd
*));
1878 SDEF (int, _core_file_failing_signal
, (bfd
*));
1879 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
1882 Archive entry points
1885 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
1886 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
1887 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
1888 SDEF (boolean
, write_armap
, (bfd
*arch
,
1889 unsigned int elength
,
1898 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
1899 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
1900 file_ptr
, bfd_size_type
));
1901 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
1902 file_ptr
, bfd_size_type
));
1903 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
1906 Symbols and reloctions
1909 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
1910 SDEF (unsigned int, _bfd_canonicalize_symtab
,
1911 (bfd
*, struct symbol_cache_entry
**));
1912 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
1913 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
1914 struct symbol_cache_entry
**));
1915 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
1916 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
1917 bfd_print_symbol_enum_type
));
1918 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1919 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
1921 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
1924 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
1925 SDEF (boolean
, _bfd_find_nearest_line
,
1926 (bfd
*abfd
, struct sec
*section
,
1927 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
1928 CONST
char **file
, CONST
char **func
, unsigned int *line
));
1929 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
1931 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
1933 SDEF (void, _bfd_debug_info_start
, (bfd
*));
1934 SDEF (void, _bfd_debug_info_end
, (bfd
*));
1935 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
1938 Special entry points for gdb to swap in coff symbol table parts
1941 SDEF(void, _bfd_coff_swap_aux_in
,(
1948 SDEF(void, _bfd_coff_swap_sym_in
,(
1953 SDEF(void, _bfd_coff_swap_lineno_in
, (
1963 Returns a pointer to the transfer vector for the object target
1964 named target_name. If target_name is NULL, chooses the one in the
1965 environment variable GNUTARGET; if that is null or not defined then
1966 the first entry in the target list is chosen. Passing in the
1967 string "default" or setting the environment variable to "default"
1968 will cause the first entry in the target list to be returned,
1969 and "target_defaulted" will be set in the BFD. This causes
1970 @code{bfd_check_format} to loop over all the targets to find the one
1971 that matches the file being read.
1973 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
1978 This function returns a freshly malloced NULL-terminated vector of the
1979 names of all the valid BFD targets. Do not modify the names
1981 PROTO(CONST
char **,bfd_target_list
,());
1988 /* *i bfd_check_format
1989 This routine is supplied a BFD and a format. It attempts to verify if
1990 the file attached to the BFD is indeed compatible with the format
1991 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
1994 If the BFD has been set to a specific @var{target} before the call,
1995 only the named target and format combination will be checked. If the
1996 target has not been set, or has been set to @code{default} then all
1997 the known target backends will be interrogated to determine a match.
1999 The function returns @code{true} on success, otherwise @code{false}
2000 with one of the following error codes:
2004 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
2006 @item system_call_error
2007 if an error occured during a read - even some file mismatches can
2008 cause system_call_errros
2009 @item file_not_recognised
2010 none of the backends recognised the file format
2011 @item file_ambiguously_recognized
2012 more than one backend recognised the file format.
2015 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
2020 This function sets the file format of the supplied BFD to the format
2021 requested. If the target set in the BFD does not support the format
2022 requested, the format is illegal or the BFD is not open for writing
2023 than an error occurs.
2025 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
2029 *i bfd_format_string
2030 This function takes one argument, and enumerated type (bfd_format) and
2031 returns a pointer to a const string "invalid", "object", "archive",
2032 "core" or "unknown" depending upon the value of the enumeration.
2034 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));