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 Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
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 */
317 This routine must be called before any other bfd function to initialize
318 magical internal data structures.
321 void EXFUN(bfd_init
,(void));
328 Opens the file supplied (using @code{fopen}) with the target supplied, it
329 returns a pointer to the created BFD.
331 If NULL is returned then an error has occured.
332 Possible errors are no_memory, invalid_target or system_call error.
334 PROTO(bfd
*, bfd_openr
, (CONST
char *filename
,CONST
char*target
));
339 bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a BFD on
340 a file already described by the @var{fd} supplied.
342 Possible errors are no_memory, invalid_target and system_call error.
344 PROTO(bfd
*, bfd_fdopenr
,
345 (CONST
char *filename
, CONST
char *target
, int fd
));
350 Creates a BFD, associated with file @var{filename}, using the file
351 format @var{target}, and returns a pointer to it.
353 Possible errors are system_call_error, no_memory, invalid_target.
355 PROTO(bfd
*, bfd_openw
, (CONST
char *filename
, CONST
char *target
));
360 This function closes a BFD. If the BFD was open for writing, then
361 pending operations are completed and the file written out and closed.
362 If the created file is executable, then @code{chmod} is called to mark
365 All memory attached to the BFD's obstacks is released.
367 @code{true} is returned if all is ok, otherwise @code{false}.
369 PROTO(boolean
, bfd_close
,(bfd
*));
374 This routine creates a new BFD in the manner of @code{bfd_openw}, but without
375 opening a file. The new BFD takes the target from the target used by
376 @var{template}. The format is always set to @code{bfd_object}.
379 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
384 Return the number of bytes in the obstacks connected to the supplied
387 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
396 These macros as used for reading and writing raw data in sections;
397 each access (except for bytes) is vectored through the target format
398 of the BFD and mangled accordingly. The mangling performs any
399 necessary endian translations and removes alignment restrictions.
401 #define bfd_put_8(abfd, val, ptr) \
402 (*((char *)ptr) = (char)val)
403 #define bfd_get_8(abfd, ptr) \
405 #define bfd_put_16(abfd, val, ptr) \
406 BFD_SEND(abfd, bfd_putx16, (val,ptr))
407 #define bfd_get_16(abfd, ptr) \
408 BFD_SEND(abfd, bfd_getx16, (ptr))
409 #define bfd_put_32(abfd, val, ptr) \
410 BFD_SEND(abfd, bfd_putx32, (val,ptr))
411 #define bfd_get_32(abfd, ptr) \
412 BFD_SEND(abfd, bfd_getx32, (ptr))
413 #define bfd_put_64(abfd, val, ptr) \
414 BFD_SEND(abfd, bfd_putx64, (val, ptr))
415 #define bfd_get_64(abfd, ptr) \
416 BFD_SEND(abfd, bfd_getx64, (ptr))
419 These macros have the same function as their @code{bfd_get_x}
420 bretherin, except that they are used for removing information for the
421 header records of object files. Believe it or not, some object files
422 keep their header records in big endian order, and their data in little
425 #define bfd_h_put_8(abfd, val, ptr) \
426 (*((char *)ptr) = (char)val)
427 #define bfd_h_get_8(abfd, ptr) \
429 #define bfd_h_put_16(abfd, val, ptr) \
430 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
431 #define bfd_h_get_16(abfd, ptr) \
432 BFD_SEND(abfd, bfd_h_getx16,(ptr))
433 #define bfd_h_put_32(abfd, val, ptr) \
434 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
435 #define bfd_h_get_32(abfd, ptr) \
436 BFD_SEND(abfd, bfd_h_getx32,(ptr))
437 #define bfd_h_put_64(abfd, val, ptr) \
438 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
439 #define bfd_h_get_64(abfd, ptr) \
440 BFD_SEND(abfd, bfd_h_getx64,(ptr))
443 /* The shape of a section struct:
449 The name of the section, the name isn't a copy, the pointer is
450 the same as that passed to bfd_make_section.
456 The next section in the list belonging to the BFD, or NULL.
462 The field flags contains attributes of the section. Some of these
463 flags are read in from the object file, and some are synthesized from
472 #define SEC_NO_FLAGS 0x000
475 Tells the OS to allocate space for this section when loaded.
476 This would clear for a section containing debug information only.
479 #define SEC_ALLOC 0x001
482 Tells the OS to load the section from the file when loading.
483 This would be clear for a .bss section
486 #define SEC_LOAD 0x002
489 The section contains data still to be relocated, so there will be some
490 relocation information too.
493 #define SEC_RELOC 0x004
499 #define SEC_BALIGN 0x008
502 A signal to the OS that the section contains read only data.
505 #define SEC_READONLY 0x010
508 The section contains code only.
511 #define SEC_CODE 0x020
514 The section contains data only.
517 #define SEC_DATA 0x040
520 The section will reside in ROM.
523 #define SEC_ROM 0x080
526 The section contains constructor information. This section type is
527 used by the linker to create lists of constructors and destructors
528 used by @code{g++}. When a back end sees a symbol which should be used
529 in a constructor list, it creates a new section for the type of name
530 (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a
531 relocation. To build the lists of constructors, all the linker has to
532 to is catenate all the sections called @code{__CTOR_LIST__} and
533 relocte the data contained within - exactly the operations it would
534 peform on standard data.
537 #define SEC_CONSTRUCTOR 0x100
540 The section is a constuctor, and should be placed at the end of the ..
543 #define SEC_CONSTRUCTOR_TEXT 0x1100
547 #define SEC_CONSTRUCTOR_DATA 0x2100
551 #define SEC_CONSTRUCTOR_BSS 0x3100
555 The section has contents - a bss section could be
556 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
557 @code{SEC_HAS_CONTENTS}
560 #define SEC_HAS_CONTENTS 0x200
563 An instruction to the linker not to output sections containing
564 this flag even if they have information which would normally be written.
567 #define SEC_NEVER_LOAD 0x400
571 The base address of the section in the address space of the target.
577 The size of the section in bytes of the loaded section. This contains
578 a value even if the section has no contents (eg, the size of @code{.bss}).
584 If this section is going to be output, then this value is the
585 offset into the output section of the first byte in the input
586 section. Eg, if this was going to start at the 100th byte in the
587 output section, this value would be 100.
590 bfd_vma output_offset
;
593 The output section through which to map on output.
596 struct sec
*output_section
;
599 The alignment requirement of the section, as an exponent - eg 3
603 unsigned int alignment_power
;
606 If an input section, a pointer to a vector of relocation records for
607 the data in this section.
610 struct reloc_cache_entry
*relocation
;
613 If an output section, a pointer to a vector of pointers to
614 relocation records for the data in this section.
617 struct reloc_cache_entry
**orelocation
;
620 The number of relocation records in one of the above
623 unsigned reloc_count
;
626 Which section is it 0..nth
632 Information below is back end specific - and not always used or
635 File position of section data
639 /* File position of relocation info
642 file_ptr rel_filepos
;
645 File position of line data
648 file_ptr line_filepos
;
651 Pointer to data for applications
658 struct lang_output_section
*otheruserdata
;
661 Attached line number information
665 /* Number of line number records
668 unsigned int lineno_count
;
671 When a section is being output, this value changes as more
672 linenumbers are written out
675 file_ptr moving_line_filepos
;
678 what the section number is in the target world
681 unsigned int target_index
;
688 If this is a constructor section then here is a list of the
689 relocations created to relocate items within it.
692 struct relent_chain
*constructor_chain
;
695 The BFD which owns the section.
706 bfd_get_section_by_name
707 Runs through the provided @var{abfd} and returns the @code{asection}
708 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
711 PROTO(asection
*, bfd_get_section_by_name
,
712 (bfd
*abfd
, CONST
char *name
));
717 This function creates a new empty section called @var{name} and attaches it
718 to the end of the chain of sections for the BFD supplied. An attempt to
719 create a section with a name which is already in use, returns the old
720 section by that name instead.
724 @item invalid_operation
725 If output has already started for this BFD.
727 If obstack alloc fails.
731 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
735 bfd_set_section_flags
736 Attempts to set the attributes of the section named in the BFD
737 supplied to the value. Returns true on success, false on error.
738 Possible error returns are:
740 @item invalid operation
741 The section cannot have one or more of the attributes requested. For
742 example, a .bss section in @code{a.out} may not have the
743 @code{SEC_HAS_CONTENTS} field set.
747 PROTO(boolean
, bfd_set_section_flags
,
748 (bfd
*, asection
*, flagword
));
752 bfd_map_over_sections
753 Calls the provided function @var{func} for each section attached to
754 the BFD @var{abfd}, passing @var{obj} as an argument. The function
755 will be called as if by
758 func(abfd, the_section, obj);
762 PROTO(void, bfd_map_over_sections
,
763 (bfd
*abfd
, void (*func
)(), PTR obj
));
767 This is the prefered method for iterating over sections, an
768 alternative would be to use a loop:
772 for (p = abfd->sections; p != NULL; p = p->next)
777 Sets @var{section} to the size @var{val}. If the operation is ok, then
778 @code{true} is returned, else @code{false}.
780 Possible error returns:
782 @item invalid_operation
783 Writing has started to the BFD, so setting the size is invalid
787 PROTO(boolean
, bfd_set_section_size
,
788 (bfd
*, asection
*, bfd_size_type val
));
792 bfd_set_section_contents
793 Sets the contents of the section @var{section} in BFD @var{abfd} to
794 the data starting in memory at @var{data}. The data is written to the
795 output section starting at offset @var{offset} for @var{count} bytes.
797 Normally @code{true} is returned, else @code{false}. Possible error
801 The output section does not have the @code{SEC_HAS_CONTENTS}
802 attribute, so nothing can be written to it.
803 @item and some more too
805 This routine is front end to the back end function @code{_bfd_set_section_contents}.
808 PROTO(boolean
, bfd_set_section_contents
,
813 bfd_size_type count
));
817 bfd_get_section_contents
818 This function reads data from @var{section} in BFD @var{abfd} into
819 memory starting at @var{location}. The data is read at an offset of
820 @var{offset} from the start of the input section, and is read for
823 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
824 set are requested, then the @var{location} is filled with zeroes.
826 If no errors occur, @code{true} is returned, else @code{false}.
834 PROTO(boolean
, bfd_get_section_contents
,
835 (bfd
*abfd
, asection
*section
, PTR location
,
836 file_ptr offset
, bfd_size_type count
));
845 This enum gives the object file's CPU
846 architecture, in a global sense. E.g. what processor family does it
847 belong to? There is another field, which indicates what processor
848 within the family is in use. The machine gives a number which
849 distingushes different versions of the architecture, containing for
850 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
851 Motorola 68020 and 68030.
854 enum bfd_architecture
856 bfd_arch_unknown
, /* File arch not known */
857 bfd_arch_obscure
, /* Arch known, not one of these */
858 bfd_arch_m68k
, /* Motorola 68xxx */
859 bfd_arch_vax
, /* DEC Vax */
860 bfd_arch_i960
, /* Intel 960 */
861 /* The order of the following is important.
862 lower number indicates a machine type that
863 only accepts a subset of the instructions
864 available to machines with higher numbers.
865 The exception is the "ca", which is
866 incompatible with all other machines except
869 #define bfd_mach_i960_core 1
870 #define bfd_mach_i960_ka_sa 2
871 #define bfd_mach_i960_kb_sb 3
872 #define bfd_mach_i960_mc 4
873 #define bfd_mach_i960_xa 5
874 #define bfd_mach_i960_ca 6
876 bfd_arch_a29k
, /* AMD 29000 */
877 bfd_arch_sparc
, /* SPARC */
878 bfd_arch_mips
, /* MIPS Rxxxx */
879 bfd_arch_i386
, /* Intel 386 */
880 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
881 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
882 bfd_arch_i860
, /* Intel 860 */
883 bfd_arch_romp
, /* IBM ROMP RS/6000 */
884 bfd_arch_alliant
, /* Alliant */
885 bfd_arch_convex
, /* Convex */
886 bfd_arch_m88k
, /* Motorola 88xxx */
887 bfd_arch_pyramid
, /* Pyramid Technology */
888 bfd_arch_h8300
, /* Hitachi H8/300 */
896 This structure contains information on architectures.
898 typedef int bfd_reloc_code_enum_type
;
900 typedef struct bfd_arch_info_struct
903 int bits_per_address
;
905 enum bfd_architecture arch
;
908 CONST
char *printable_name
;
909 /* true if this is the default machine for the architecture */
911 CONST
struct bfd_arch_info_struct
* EXFUN((*compatible
),(CONST
struct bfd_arch_info_struct
*a
,
912 CONST
struct bfd_arch_info_struct
*b
));
915 boolean
EXFUN((*scan
),(CONST
struct bfd_arch_info_struct
*,CONST
char *));
916 unsigned int EXFUN((*disassemble
),(bfd_vma addr
, CONST
char *data
,
918 CONST
struct reloc_howto_struct
*EXFUN((*reloc_type_lookup
), (bfd_reloc_code_enum_type code
));
920 struct bfd_arch_info_struct
*next
;
922 } bfd_arch_info_struct_type
;
925 bfd_printable_arch_mach
926 Return a printable string representing the architecture and machine
929 NB. The use of this routine is depreciated.
932 PROTO(CONST
char *,bfd_printable_arch_mach
,
933 (enum bfd_architecture arch
, unsigned long machine
));
939 Return a printable string representing the architecture and machine
940 from the pointer to the arch info structure
943 CONST
char *EXFUN(bfd_printable_name
,(bfd
*abfd
));
948 This routine is provided with a string and tries to work out if bfd
949 supports any cpu which could be described with the name provided. The
950 routine returns a pointer to an arch_info structure if a machine is
951 found, otherwise NULL.
954 bfd_arch_info_struct_type
*EXFUN(bfd_scan_arch
,(CONST
char *));
958 bfd_arch_get_compatible
959 This routine is used to determine whether two BFDs' architectures and
960 machine types are compatible. It calculates the lowest common
961 denominator between the two architectures and machine types implied by
962 the BFDs and returns a pointer to an arch_info structure describing
963 the compatible machine.
966 CONST bfd_arch_info_struct_type
*EXFUN(bfd_arch_get_compatible
,
975 void EXFUN(bfd_set_arch_info
,(bfd
*, bfd_arch_info_struct_type
*));
981 Returns the enumerated type which describes the supplied bfd's
985 enum bfd_architecture
EXFUN(bfd_get_arch
, (bfd
*abfd
));
991 Returns the long type which describes the supplied bfd's
995 unsigned long EXFUN(bfd_get_mach
, (bfd
*abfd
));
999 bfd_arch_bits_per_byte
1001 Returns the number of bits in one of the architectures bytes
1004 unsigned int EXFUN(bfd_arch_bits_per_byte
, (bfd
*abfd
));
1008 bfd_arch_bits_per_address
1010 Returns the number of bits in one of the architectures addresses
1013 unsigned int EXFUN(bfd_arch_bits_per_address
, (bfd
*abfd
));
1020 bfd_arch_info_struct_type
* EXFUN(bfd_get_arch_info
,(bfd
*));
1027 /* bfd_reloc_code_enum_type
1034 16 bits wide, simple reloc
1040 8 bits wide, but used to form an address like 0xffnn
1052 8 bits wide, pc relative
1056 } bfd_reloc_code_enum_real_type
;
1060 bfd_reloc_type_lookup
1061 This routine returns a pointer to a howto struct which when invoked,
1062 will perform the supplied relocation on data from the architecture
1065 [Note] This function will go away.
1068 PROTO(struct reloc_howto_struct
*,
1069 bfd_reloc_type_lookup
,
1070 (enum bfd_architecture arch
, bfd_reloc_code_enum_type code
));
1075 /* bfd_perform_relocation
1076 The relocation routine returns as a status an enumerated type:
1079 typedef enum bfd_reloc_status
{
1080 /* No errors detected
1086 The relocation was performed, but there was an overflow.
1092 The address to relocate was not within the section supplied
1095 bfd_reloc_outofrange
,
1098 Used by special functions
1107 bfd_reloc_notsupported
,
1110 Unsupported relocation size requested.
1116 The symbol to relocate against was undefined.
1119 bfd_reloc_undefined
,
1122 The relocation was performed, but may not be ok - presently generated
1123 only when linking i960 coff files with i960 b.out symbols.
1128 bfd_reloc_status_enum_type
;
1133 typedef struct reloc_cache_entry
1137 A pointer into the canonical table of pointers
1140 struct symbol_cache_entry
**sym_ptr_ptr
;
1146 rawdata_offset address
;
1149 addend for relocation value
1155 if sym is null this is the section
1158 struct sec
*section
;
1161 Pointer to how to perform the required relocation
1164 CONST
struct reloc_howto_struct
*howto
;
1170 The @code{reloc_howto_type} is a structure which contains all the
1171 information that BFD needs to know to tie up a back end's data.
1174 typedef CONST
struct reloc_howto_struct
1176 /* The type field has mainly a documetary use - the back end can to what
1177 it wants with it, though the normally the back end's external idea of
1178 what a reloc number would be would be stored in this field. For
1179 example, the a PC relative word relocation in a coff environment would
1180 have the type 023 - because that's what the outside world calls a
1187 The value the final relocation is shifted right by. This drops
1188 unwanted data from the relocation.
1191 unsigned int rightshift
;
1194 The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1204 unsigned int bitsize
;
1207 Notes that the relocation is relative to the location in the data
1208 section of the addend. The relocation function will subtract from the
1209 relocation value the address of the location being relocated.
1212 boolean pc_relative
;
1218 unsigned int bitpos
;
1227 Causes the relocation routine to return an error if overflow is
1228 detected when relocating.
1231 boolean complain_on_overflow
;
1234 If this field is non null, then the supplied function is called rather
1235 than the normal function. This allows really strange relocation
1236 methods to be accomodated (eg, i960 callj instructions).
1239 bfd_reloc_status_enum_type (*special_function
)();
1242 The textual name of the relocation type.
1248 When performing a partial link, some formats must modify the
1249 relocations rather than the data - this flag signals this.
1252 boolean partial_inplace
;
1255 The src_mask is used to select what parts of the read in data are to
1256 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1257 which we read and relocated, this would be 0x000000ff. When we have
1258 relocs which have an addend, such as sun4 extended relocs, the value
1259 in the offset part of a relocating field is garbage so we never use
1260 it. In this case the mask would be 0x00000000.
1264 /* The dst_mask is what parts of the instruction are replaced into the
1265 instruction. In most cases src_mask == dst_mask, except in the above
1266 special case, where dst_mask would be 0x000000ff, and src_mask would
1273 When some formats create PC relative instructions, they leave the
1274 value of the pc of the place being relocated in the offset slot of the
1275 instruction, so that a PC relative relocation can be made just by
1276 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1277 displacement part of an instruction empty (eg m88k bcs), this flag
1281 boolean pcrel_offset
;
1287 The HOWTO define is horrible and will go away.
1289 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1290 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1293 And will be replaced with the totally magic way. But for the moment,
1294 we are compatible, so do it this way..
1297 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,false)
1300 Helper routine to turn a symbol into a relocation value.
1304 #define HOWTO_PREPARE(relocation, symbol) \
1306 if (symbol != (asymbol *)NULL) { \
1307 if (symbol->flags & BSF_FORT_COMM) { \
1311 relocation = symbol->value; \
1314 if (symbol->section != (asection *)NULL) { \
1315 relocation += symbol->section->output_section->vma + \
1316 symbol->section->output_offset; \
1323 typedef unsigned char bfd_byte
;
1325 typedef struct relent_chain
{
1327 struct relent_chain
*next
;
1332 If an output_bfd is supplied to this function the generated image
1333 will be relocatable, the relocations are copied to the output file
1334 after they have been changed to reflect the new state of the world.
1335 There are two ways of reflecting the results of partial linkage in an
1336 output file; by modifying the output data in place, and by modifying
1337 the relocation record. Some native formats (eg basic a.out and basic
1338 coff) have no way of specifying an addend in the relocation type, so
1339 the addend has to go in the output data. This is no big deal since in
1340 these formats the output data slot will always be big enough for the
1341 addend. Complex reloc types with addends were invented to solve just
1344 PROTO(bfd_reloc_status_enum_type
,
1345 bfd_perform_relocation
,
1347 arelent
*reloc_entry
,
1349 asection
*input_section
,
1356 /* @subsection typedef asymbol
1357 An @code{asymbol} has the form:
1360 typedef struct symbol_cache_entry
1362 /* A pointer to the BFD which owns the symbol. This information is
1363 necessary so that a back end can work out what additional (invisible to
1364 the application writer) information is carried with the symbol.
1367 struct _bfd
*the_bfd
;
1370 The text of the symbol. The name is left alone, and not copied - the
1371 application may not alter it.
1377 The value of the symbol.
1383 Attributes of a symbol:
1386 #define BSF_NO_FLAGS 0x00
1389 The symbol has local scope; @code{static} in @code{C}. The value is
1390 the offset into the section of the data.
1393 #define BSF_LOCAL 0x01
1396 The symbol has global scope; initialized data in @code{C}. The value
1397 is the offset into the section of the data.
1400 #define BSF_GLOBAL 0x02
1406 #define BSF_IMPORT 0x04
1409 The symbol has global scope, and is exported. The value is the offset
1410 into the section of the data.
1413 #define BSF_EXPORT 0x08
1416 The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
1419 #define BSF_UNDEFINED 0x10
1422 The symbol is common, initialized to zero; default in @code{C}. The
1423 value is the size of the object in bytes.
1426 #define BSF_FORT_COMM 0x20
1429 A normal @code{C} symbol would be one of:
1430 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
1432 The symbol is a debugging record. The value has an arbitary meaning.
1435 #define BSF_DEBUGGING 0x40
1438 The symbol has no section attached, any value is the actual value and
1439 is not a relative offset to a section.
1442 #define BSF_ABSOLUTE 0x80
1448 #define BSF_KEEP 0x10000
1449 #define BSF_KEEP_G 0x80000
1455 #define BSF_WEAK 0x100000
1456 #define BSF_CTOR 0x200000
1457 #define BSF_FAKE 0x400000
1460 The symbol used to be a common symbol, but now it is allocated.
1463 #define BSF_OLD_COMMON 0x800000
1466 The default value for common data.
1469 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1472 In some files the type of a symbol sometimes alters its location
1473 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
1474 symbol appears where it was declared and not at the end of a section.
1475 This bit is set by the target BFD part to convey this information.
1478 #define BSF_NOT_AT_END 0x40000
1481 Signal that the symbol is the label of constructor section.
1484 #define BSF_CONSTRUCTOR 0x1000000
1487 Signal that the symbol is a warning symbol. If the symbol is a warning
1488 symbol, then the value field (I know this is tacky) will point to the
1489 asymbol which when referenced will cause the warning.
1492 #define BSF_WARNING 0x2000000
1495 Signal that the symbol is indirect. The value of the symbol is a
1496 pointer to an undefined asymbol which contains the name to use
1500 #define BSF_INDIRECT 0x4000000
1507 A pointer to the section to which this symbol is relative, or 0 if the
1508 symbol is absolute or undefined. Note that it is not sufficient to set
1509 this location to 0 to mark a symbol as absolute - the flag
1510 @code{BSF_ABSOLUTE} must be set also.
1513 struct sec
*section
;
1516 Back end special data. This is being phased out in favour of making
1525 get_symtab_upper_bound
1526 Returns the number of bytes required in a vector of pointers to
1527 @code{asymbols} for all the symbols in the supplied BFD, including a
1528 terminal NULL pointer. If there are no symbols in the BFD, then 0 is
1531 #define get_symtab_upper_bound(abfd) \
1532 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1536 bfd_canonicalize_symtab
1537 Supplied a BFD and a pointer to an uninitialized vector of pointers.
1538 This reads in the symbols from the BFD, and fills in the table with
1539 pointers to the symbols, and a trailing NULL. The routine returns the
1540 actual number of symbol pointers not including the NULL.
1543 #define bfd_canonicalize_symtab(abfd, location) \
1544 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1549 Provided a table of pointers to to symbols and a count, writes to the
1550 output BFD the symbols when closed.
1553 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
1557 bfd_print_symbol_vandf
1558 Prints the value and flags of the symbol supplied to the stream file.
1561 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
1565 bfd_make_empty_symbol
1566 This function creates a new @code{asymbol} structure for the BFD, and
1567 returns a pointer to it.
1569 This routine is necessary, since each back end has private information
1570 surrounding the @code{asymbol}. Building your own @code{asymbol} and
1571 pointing to it will not create the private information, and will cause
1574 #define bfd_make_empty_symbol(abfd) \
1575 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1578 /* @section @code{typedef bfd}
1580 A BFD is has type @code{bfd}; objects of this type are the cornerstone
1581 of any application using @code{libbfd}. References though the BFD and
1582 to data in the BFD give the entire BFD functionality.
1584 Here is the struct used to define the type @code{bfd}. This contains
1585 the major data about the file, and contains pointers to the rest of
1591 /* The filename the application opened the BFD with.
1594 CONST
char *filename
;
1597 A pointer to the target jump table.
1600 struct bfd_target
*xvec
;
1604 To avoid dragging too many header files into every file that
1605 includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME
1606 as a "long". Their correct types, to which they are cast when used,
1607 are "FILE *" and "time_t".
1609 The iostream is the result of an fopen on the filename.
1615 Is the file being cached @xref{File Caching}.
1621 Marks whether there was a default target specified when the BFD was
1622 opened. This is used to select what matching algorithm to use to chose
1626 boolean target_defaulted
;
1629 The caching routines use these to maintain a least-recently-used list of
1630 BFDs (@pxref{File Caching}).
1633 struct _bfd
*lru_prev
, *lru_next
;
1636 When a file is closed by the caching routines, BFD retains state
1637 information on the file here:
1646 boolean opened_once
;
1651 /* File modified time
1657 Reserved for an unimplemented file locking extension.
1663 The format which belongs to the BFD.
1669 The direction the BFD was opened with
1672 enum bfd_direction
{no_direction
= 0,
1674 write_direction
= 2,
1675 both_direction
= 3} direction
;
1678 Format_specific flags
1684 Currently my_archive is tested before adding origin to anything. I
1685 believe that this can become always an add of origin, with origin set
1686 to 0 for non archive files.
1692 Remember when output has begun, to stop strange things happening.
1695 boolean output_has_begun
;
1698 Pointer to linked list of sections
1701 struct sec
*sections
;
1704 The number of sections
1707 unsigned int section_count
;
1710 Stuff only useful for object files:
1714 bfd_vma start_address
;
1715 /* Used for input and output
1718 unsigned int symcount
;
1719 /* Symbol table for output BFD
1722 struct symbol_cache_entry
**outsymbols
;
1725 Pointer to structure which contains architecture information
1728 struct bfd_arch_info_struct
*arch_info
;
1731 Stuff only useful for archives:
1735 struct _bfd
*my_archive
;
1737 struct _bfd
*archive_head
;
1741 Used by the back end to hold private data.
1747 Used by the application to hold private data
1753 Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}).
1756 struct obstack memory
;
1761 bfd_set_start_address
1763 Marks the entry point of an output BFD. Returns @code{true} on
1764 success, @code{false} otherwise.
1767 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1773 Return cached file modification time (e.g. as read from archive header
1774 for archive members, or from file system if we have been called
1775 before); else determine modify time, cache it, and return it.
1778 PROTO(long, bfd_get_mtime
, (bfd
*));
1786 #define bfd_sizeof_headers(abfd, reloc) \
1787 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1789 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1790 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1792 #define bfd_debug_info_start(abfd) \
1793 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1795 #define bfd_debug_info_end(abfd) \
1796 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1798 #define bfd_debug_info_accumulate(abfd, section) \
1799 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1801 #define bfd_stat_arch_elt(abfd, stat) \
1802 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1804 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1805 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1807 #define bfd_coff_swap_sym_in(a,e,i) \
1808 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1810 #define bfd_coff_swap_lineno_in(a,e,i) \
1811 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1813 #define bfd_set_arch_mach(abfd, arch, mach)\
1814 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1820 /* bfd_get_next_mapent
1823 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1827 bfd_set_archive_head
1829 Used whilst processing archives. Sets the head of the chain of BFDs
1830 contained in an archive to @var{new_head}. (see chapter on archives)
1833 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1837 bfd_get_elt_at_index
1838 Return the sub bfd contained within the archive at archive index n.
1841 PROTO(bfd
*, bfd_get_elt_at_index
, (bfd
*, int));
1845 bfd_openr_next_archived_file
1846 Initially provided a BFD containing an archive and NULL, opens a BFD
1847 on the first contained element and returns that. Subsequent calls to
1848 bfd_openr_next_archived_file should pass the archive and the previous
1849 return value to return a created BFD to the next contained element.
1850 NULL is returned when there are no more.
1853 PROTO(bfd
*, bfd_openr_next_archived_file
,
1854 (bfd
*archive
, bfd
*previous
));
1861 /* bfd_core_file_failing_command
1862 Returns a read-only string explaining what program was running when
1863 it failed and produced the core file being read
1866 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1870 bfd_core_file_failing_signal
1871 Returns the signal number which caused the core dump which generated
1872 the file the BFD is attached to.
1875 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1879 core_file_matches_executable_p
1880 Returns @code{true} if the core file attached to @var{core_bfd} was
1881 generated by a run of the executable file attached to @var{exec_bfd},
1882 or else @code{false}.
1884 PROTO(boolean
, core_file_matches_executable_p
,
1885 (bfd
*core_bfd
, bfd
*exec_bfd
));
1893 @subsection bfd_target
1894 This structure contains everything that BFD knows about a target.
1895 It includes things like its byte order, name, what routines to call
1896 to do various operations, etc.
1898 Every BFD points to a target structure with its "xvec" member.
1900 Shortcut for declaring fields which are prototyped function pointers,
1901 while avoiding anguish on compilers that don't support protos.
1904 #define SDEF(ret, name, arglist) \
1905 PROTO(ret,(*name),arglist)
1906 #define SDEF_FMT(ret, name, arglist) \
1907 PROTO(ret,(*name[bfd_type_end]),arglist)
1910 These macros are used to dispatch to functions through the bfd_target
1911 vector. They are used in a number of macros further down in @file{bfd.h}, and
1912 are also used when calling various routines by hand inside the BFD
1913 implementation. The "arglist" argument must be parenthesized; it
1914 contains all the arguments to the called function.
1917 #define BFD_SEND(bfd, message, arglist) \
1918 ((*((bfd)->xvec->message)) arglist)
1921 For operations which index on the BFD format
1924 #define BFD_SEND_FMT(bfd, message, arglist) \
1925 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1928 This is the struct which defines the type of BFD this is. The
1929 "xvec" member of the struct @code{bfd} itself points here. Each module
1930 that implements access to a different target under BFD, defines
1933 FIXME, these names should be rationalised with the names of the
1934 entry points which call them. Too bad we can't have one macro to
1938 typedef struct bfd_target
1942 identifies the kind of target, eg SunOS4, Ultrix, etc
1948 The "flavour" of a back end is a general indication about the contents
1952 enum target_flavour_enum
{
1953 bfd_target_aout_flavour_enum
,
1954 bfd_target_coff_flavour_enum
,
1955 bfd_target_ieee_flavour_enum
,
1956 bfd_target_oasys_flavour_enum
,
1957 bfd_target_srec_flavour_enum
} flavour
;
1960 The order of bytes within the data area of a file.
1963 boolean byteorder_big_p
;
1966 The order of bytes within the header parts of a file.
1969 boolean header_byteorder_big_p
;
1972 This is a mask of all the flags which an executable may have set -
1973 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
1976 flagword object_flags
;
1979 This is a mask of all the flags which a section may have set - from
1980 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
1983 flagword section_flags
;
1986 The pad character for filenames within an archive header.
1992 The maximum number of characters in an archive header.
1995 unsigned short ar_max_namelen
;
1998 The minimum alignment restriction for any section.
2001 unsigned int align_power_min
;
2004 Entries for byte swapping for data. These are different to the other
2005 entry points, since they don't take BFD as first arg. Certain other handlers
2009 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
2010 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
2011 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
2012 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
2013 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
2014 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
2017 Byte swapping for the headers
2020 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
2021 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
2022 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
2023 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
2024 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
2025 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
2028 Format dependent routines, these turn into vectors of entry points
2029 within the target vector structure; one for each format to check.
2031 Check the format of a file being read. Return bfd_target * or zero.
2034 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
2037 Set the format of a file being written.
2040 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
2043 Write cached information into a file being written, at bfd_close.
2046 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
2049 The following functions are defined in @code{JUMP_TABLE}. The idea is
2050 that the back end writer of @code{foo} names all the routines
2051 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
2052 in this structure in the right order.
2054 Core file entry points
2057 SDEF (char *, _core_file_failing_command
, (bfd
*));
2058 SDEF (int, _core_file_failing_signal
, (bfd
*));
2059 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
2062 Archive entry points
2065 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
2066 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
2067 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
2068 SDEF (boolean
, write_armap
, (bfd
*arch
,
2069 unsigned int elength
,
2078 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
2079 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
2080 file_ptr
, bfd_size_type
));
2081 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
2082 file_ptr
, bfd_size_type
));
2083 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
2086 Symbols and reloctions
2089 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
2090 SDEF (unsigned int, _bfd_canonicalize_symtab
,
2091 (bfd
*, struct symbol_cache_entry
**));
2092 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
2093 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
2094 struct symbol_cache_entry
**));
2095 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
2096 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
2097 bfd_print_symbol_enum_type
));
2098 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2099 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
2101 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
2104 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
2105 SDEF (boolean
, _bfd_find_nearest_line
,
2106 (bfd
*abfd
, struct sec
*section
,
2107 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
2108 CONST
char **file
, CONST
char **func
, unsigned int *line
));
2109 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
2111 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
2113 SDEF (void, _bfd_debug_info_start
, (bfd
*));
2114 SDEF (void, _bfd_debug_info_end
, (bfd
*));
2115 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
2118 Special entry points for gdb to swap in coff symbol table parts
2121 SDEF(void, _bfd_coff_swap_aux_in
,(
2128 SDEF(void, _bfd_coff_swap_sym_in
,(
2133 SDEF(void, _bfd_coff_swap_lineno_in
, (
2143 Returns a pointer to the transfer vector for the object target
2144 named target_name. If target_name is NULL, chooses the one in the
2145 environment variable GNUTARGET; if that is null or not defined then
2146 the first entry in the target list is chosen. Passing in the
2147 string "default" or setting the environment variable to "default"
2148 will cause the first entry in the target list to be returned,
2149 and "target_defaulted" will be set in the BFD. This causes
2150 @code{bfd_check_format} to loop over all the targets to find the one
2151 that matches the file being read.
2153 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
2158 This function returns a freshly malloced NULL-terminated vector of the
2159 names of all the valid BFD targets. Do not modify the names
2161 PROTO(CONST
char **,bfd_target_list
,());
2168 /* *i bfd_check_format
2169 This routine is supplied a BFD and a format. It attempts to verify if
2170 the file attached to the BFD is indeed compatible with the format
2171 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
2174 If the BFD has been set to a specific @var{target} before the call,
2175 only the named target and format combination will be checked. If the
2176 target has not been set, or has been set to @code{default} then all
2177 the known target backends will be interrogated to determine a match.
2179 The function returns @code{true} on success, otherwise @code{false}
2180 with one of the following error codes:
2184 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
2186 @item system_call_error
2187 if an error occured during a read - even some file mismatches can
2188 cause system_call_errros
2189 @item file_not_recognised
2190 none of the backends recognised the file format
2191 @item file_ambiguously_recognized
2192 more than one backend recognised the file format.
2195 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
2200 This function sets the file format of the supplied BFD to the format
2201 requested. If the target set in the BFD does not support the format
2202 requested, the format is illegal or the BFD is not open for writing
2203 than an error occurs.
2205 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
2209 *i bfd_format_string
2210 This function takes one argument, and enumerated type (bfd_format) and
2211 returns a pointer to a const string "invalid", "object", "archive",
2212 "core" or "unknown" depending upon the value of the enumeration.
2214 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));