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 "0.18"
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; */
65 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */
66 typedef enum bfd_boolean
{false, true} boolean
;
68 /* Try to avoid breaking stuff */
69 typedef long int file_ptr
;
71 /* Support for different sizes of target format ints and addresses */
74 typedef HOST_64_BIT rawdata_offset
;
75 typedef HOST_64_BIT bfd_vma
;
76 typedef HOST_64_BIT bfd_word
;
77 typedef HOST_64_BIT bfd_offset
;
78 typedef HOST_64_BIT bfd_size_type
;
79 typedef HOST_64_BIT symvalue
;
80 typedef HOST_64_BIT bfd_64_type
;
81 #define fprintf_vma(s,x) \
82 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
83 #define printf_vma(x) \
84 printf( "%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
86 typedef struct {int a
,b
;} bfd_64_type
;
87 typedef unsigned long rawdata_offset
;
88 typedef unsigned long bfd_vma
;
89 typedef unsigned long bfd_offset
;
90 typedef unsigned long bfd_word
;
91 typedef unsigned long bfd_size
;
92 typedef unsigned long symvalue
;
93 typedef unsigned long bfd_size_type
;
94 #define printf_vma(x) printf( "%08lx", x)
95 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
98 typedef unsigned int flagword
; /* 32 bits of flags */
102 typedef enum bfd_format
{
103 bfd_unknown
= 0, /* file format is unknown */
104 bfd_object
, /* linker/assember/compiler output */
105 bfd_archive
, /* object archive file */
106 bfd_core
, /* core dump */
107 bfd_type_end
} /* marks the end; don't use it! */
110 /* Object file flag values */
112 #define HAS_RELOC 001
114 #define HAS_LINENO 004
115 #define HAS_DEBUG 010
117 #define HAS_LOCALS 040
123 /* symbols and relocation */
125 typedef unsigned long symindex
;
127 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
129 typedef enum bfd_symclass
{
130 bfd_symclass_unknown
= 0,
131 bfd_symclass_fcommon
, /* fortran common symbols */
132 bfd_symclass_global
, /* global symbol, what a surprise */
133 bfd_symclass_debugger
, /* some debugger symbol */
134 bfd_symclass_undefined
/* none known */
138 typedef int symtype
; /* Who knows, yet? */
141 /* general purpose part of a symbol;
142 target specific parts will be found in libcoff.h, liba.out.h etc */
145 #define bfd_get_section(x) ((x)->section)
146 #define bfd_get_output_section(x) ((x)->section->output_section)
147 #define bfd_set_section(x,y) ((x)->section) = (y)
148 #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0)
149 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value)
150 #define bfd_asymbol_name(x) ((x)->name)
152 /* This is a type pun with struct ranlib on purpose! */
153 typedef struct carsym
{
155 file_ptr file_offset
; /* look here to find the file */
156 } carsym
; /* to make these you call a carsymogen */
159 /* Used in generating armaps. Perhaps just a forward definition would do? */
160 struct orl
{ /* output ranlib */
161 char **name
; /* symbol name */
162 file_ptr pos
; /* bfd* or file position */
163 int namidx
; /* index into string table */
168 /* Linenumber stuff */
169 typedef struct lineno_cache_entry
{
170 unsigned int line_number
; /* Linenumber from start of function*/
172 struct symbol_cache_entry
*sym
; /* Function name */
173 unsigned long offset
; /* Offset into section */
177 /* object and core file sections */
180 #define align_power(addr, align) \
181 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
183 typedef struct sec
*sec_ptr
;
185 #define bfd_section_name(bfd, ptr) ((ptr)->name)
186 #define bfd_section_size(bfd, ptr) ((ptr)->size)
187 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
188 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
189 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags)
190 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
192 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true)
193 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
194 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
196 typedef struct stat stat_type
;
198 /** Error handling */
200 typedef enum bfd_error
{
201 no_error
= 0, system_call_error
, invalid_target
,
202 wrong_format
, invalid_operation
, no_memory
,
203 no_symbols
, no_relocation_info
,
204 no_more_archived_files
, malformed_archive
,
205 symbol_not_found
, file_not_recognized
,
206 file_ambiguously_recognized
, no_contents
,
207 bfd_error_nonrepresentable_section
,
208 invalid_error_code
} bfd_ec
;
210 extern bfd_ec bfd_error
;
212 typedef struct bfd_error_vector
{
213 PROTO(void,(* nonrepresentable_section
),(CONST bfd
*CONST abfd
,
214 CONST
char *CONST name
));
215 } bfd_error_vector_type
;
217 PROTO (char *, bfd_errmsg
, ());
218 PROTO (void, bfd_perror
, (CONST
char *message
));
221 typedef enum bfd_print_symbol
223 bfd_print_symbol_name
,
224 bfd_print_symbol_more
,
226 } bfd_print_symbol_type
;
230 /* The code that implements targets can initialize a jump table with this
231 macro. It must name all its routines the same way (a prefix plus
232 the standard routine suffix), or it must #define the routines that
233 are not so named, before calling JUMP_TABLE in the initializer. */
235 /* Semi-portable string concatenation in cpp */
238 #define CAT(a,b) a##b
240 #define CAT(a,b) a/**/b
244 #define JUMP_TABLE(NAME)\
245 CAT(NAME,_core_file_failing_command),\
246 CAT(NAME,_core_file_failing_signal),\
247 CAT(NAME,_core_file_matches_executable_p),\
248 CAT(NAME,_slurp_armap),\
249 CAT(NAME,_slurp_extended_name_table),\
250 CAT(NAME,_truncate_arname),\
251 CAT(NAME,_write_armap),\
252 CAT(NAME,_close_and_cleanup), \
253 CAT(NAME,_set_section_contents),\
254 CAT(NAME,_get_section_contents),\
255 CAT(NAME,_new_section_hook),\
256 CAT(NAME,_get_symtab_upper_bound),\
257 CAT(NAME,_get_symtab),\
258 CAT(NAME,_get_reloc_upper_bound),\
259 CAT(NAME,_canonicalize_reloc),\
260 CAT(NAME,_make_empty_symbol),\
261 CAT(NAME,_print_symbol),\
262 CAT(NAME,_get_lineno),\
263 CAT(NAME,_set_arch_mach),\
264 CAT(NAME,_openr_next_archived_file),\
265 CAT(NAME,_find_nearest_line),\
266 CAT(NAME,_generic_stat_arch_elt),\
267 CAT(NAME,_sizeof_headers),\
268 CAT(NAME,_bfd_debug_info_start),\
269 CAT(NAME,_bfd_debug_info_end),\
270 CAT(NAME,_bfd_debug_info_accumulate)
272 #define COFF_SWAP_TABLE \
273 coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, \
274 coff_swap_aux_out, coff_swap_sym_out, \
275 coff_swap_lineno_out, coff_swap_reloc_out, \
276 coff_swap_filehdr_out, coff_swap_aouthdr_out, \
281 /* User program access to BFD facilities */
283 extern CONST
short _bfd_host_big_endian
;
284 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
288 /* Cast from const char * to char * so that caller can assign to
289 a char * without a warning. */
290 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
291 #define bfd_get_format(abfd) ((abfd)->format)
292 #define bfd_get_target(abfd) ((abfd)->xvec->name)
293 #define bfd_get_file_flags(abfd) ((abfd)->flags)
294 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
295 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
296 #define bfd_my_archive(abfd) ((abfd)->my_archive);
297 #define bfd_has_map(abfd) ((abfd)->has_armap)
298 #define bfd_header_twiddle_required(abfd) \
299 ((((abfd)->xvec->header_byteorder_big_p) \
300 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
302 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
303 #define bfd_usrdata(abfd) ((abfd)->usrdata)
305 #define bfd_get_start_address(abfd) ((abfd)->start_address)
306 #define bfd_get_symcount(abfd) ((abfd)->symcount)
307 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
308 #define bfd_count_sections(abfd) ((abfd)->section_count)
309 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
310 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
320 /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */
326 This routine must be called before any other bfd function to initialize
327 magical internal data structures.
330 void EXFUN(bfd_init
,(void));
337 Opens the file supplied (using @code{fopen}) with the target supplied, it
338 returns a pointer to the created BFD.
340 If NULL is returned then an error has occured.
341 Possible errors are no_memory, invalid_target or system_call error.
343 PROTO(bfd
*, bfd_openr
, (CONST
char *filename
,CONST
char*target
));
348 bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a BFD on
349 a file already described by the @var{fd} supplied.
351 Possible errors are no_memory, invalid_target and system_call error.
353 PROTO(bfd
*, bfd_fdopenr
,
354 (CONST
char *filename
, CONST
char *target
, int fd
));
359 Creates a BFD, associated with file @var{filename}, using the file
360 format @var{target}, and returns a pointer to it.
362 Possible errors are system_call_error, no_memory, invalid_target.
364 PROTO(bfd
*, bfd_openw
, (CONST
char *filename
, CONST
char *target
));
369 This function closes a BFD. If the BFD was open for writing, then
370 pending operations are completed and the file written out and closed.
371 If the created file is executable, then @code{chmod} is called to mark
374 All memory attached to the BFD's obstacks is released.
376 @code{true} is returned if all is ok, otherwise @code{false}.
378 PROTO(boolean
, bfd_close
,(bfd
*));
383 This routine creates a new BFD in the manner of @code{bfd_openw}, but without
384 opening a file. The new BFD takes the target from the target used by
385 @var{template}. The format is always set to @code{bfd_object}.
388 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
393 Return the number of bytes in the obstacks connected to the supplied
396 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
405 These macros as used for reading and writing raw data in sections;
406 each access (except for bytes) is vectored through the target format
407 of the BFD and mangled accordingly. The mangling performs any
408 necessary endian translations and removes alignment restrictions.
410 #define bfd_put_8(abfd, val, ptr) \
411 (*((char *)ptr) = (char)val)
412 #define bfd_get_8(abfd, ptr) \
414 #define bfd_put_16(abfd, val, ptr) \
415 BFD_SEND(abfd, bfd_putx16, (val,ptr))
416 #define bfd_get_16(abfd, ptr) \
417 BFD_SEND(abfd, bfd_getx16, (ptr))
418 #define bfd_put_32(abfd, val, ptr) \
419 BFD_SEND(abfd, bfd_putx32, (val,ptr))
420 #define bfd_get_32(abfd, ptr) \
421 BFD_SEND(abfd, bfd_getx32, (ptr))
422 #define bfd_put_64(abfd, val, ptr) \
423 BFD_SEND(abfd, bfd_putx64, (val, ptr))
424 #define bfd_get_64(abfd, ptr) \
425 BFD_SEND(abfd, bfd_getx64, (ptr))
428 These macros have the same function as their @code{bfd_get_x}
429 bretherin, except that they are used for removing information for the
430 header records of object files. Believe it or not, some object files
431 keep their header records in big endian order, and their data in little
434 #define bfd_h_put_8(abfd, val, ptr) \
435 (*((char *)ptr) = (char)val)
436 #define bfd_h_get_8(abfd, ptr) \
438 #define bfd_h_put_16(abfd, val, ptr) \
439 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
440 #define bfd_h_get_16(abfd, ptr) \
441 BFD_SEND(abfd, bfd_h_getx16,(ptr))
442 #define bfd_h_put_32(abfd, val, ptr) \
443 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
444 #define bfd_h_get_32(abfd, ptr) \
445 BFD_SEND(abfd, bfd_h_getx32,(ptr))
446 #define bfd_h_put_64(abfd, val, ptr) \
447 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
448 #define bfd_h_get_64(abfd, ptr) \
449 BFD_SEND(abfd, bfd_h_getx64,(ptr))
452 /* The shape of a section struct:
458 The name of the section, the name isn't a copy, the pointer is
459 the same as that passed to bfd_make_section.
465 The next section in the list belonging to the BFD, or NULL.
471 The field flags contains attributes of the section. Some of these
472 flags are read in from the object file, and some are synthesized from
481 #define SEC_NO_FLAGS 0x000
484 Tells the OS to allocate space for this section when loaded.
485 This would clear for a section containing debug information only.
488 #define SEC_ALLOC 0x001
491 Tells the OS to load the section from the file when loading.
492 This would be clear for a .bss section
495 #define SEC_LOAD 0x002
498 The section contains data still to be relocated, so there will be some
499 relocation information too.
502 #define SEC_RELOC 0x004
508 #define SEC_BALIGN 0x008
511 A signal to the OS that the section contains read only data.
514 #define SEC_READONLY 0x010
517 The section contains code only.
520 #define SEC_CODE 0x020
523 The section contains data only.
526 #define SEC_DATA 0x040
529 The section will reside in ROM.
532 #define SEC_ROM 0x080
535 The section contains constructor information. This section type is
536 used by the linker to create lists of constructors and destructors
537 used by @code{g++}. When a back end sees a symbol which should be used
538 in a constructor list, it creates a new section for the type of name
539 (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a
540 relocation. To build the lists of constructors, all the linker has to
541 to is catenate all the sections called @code{__CTOR_LIST__} and
542 relocte the data contained within - exactly the operations it would
543 peform on standard data.
546 #define SEC_CONSTRUCTOR 0x100
549 The section is a constuctor, and should be placed at the end of the ..
552 #define SEC_CONSTRUCTOR_TEXT 0x1100
556 #define SEC_CONSTRUCTOR_DATA 0x2100
560 #define SEC_CONSTRUCTOR_BSS 0x3100
564 The section has contents - a bss section could be
565 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
566 @code{SEC_HAS_CONTENTS}
569 #define SEC_HAS_CONTENTS 0x200
572 An instruction to the linker not to output sections containing
573 this flag even if they have information which would normally be written.
576 #define SEC_NEVER_LOAD 0x400
580 The base address of the section in the address space of the target.
586 The size of the section in bytes of the loaded section. This contains
587 a value even if the section has no contents (eg, the size of @code{.bss}).
593 If this section is going to be output, then this value is the
594 offset into the output section of the first byte in the input
595 section. Eg, if this was going to start at the 100th byte in the
596 output section, this value would be 100.
599 bfd_vma output_offset
;
602 The output section through which to map on output.
605 struct sec
*output_section
;
608 The alignment requirement of the section, as an exponent - eg 3
612 unsigned int alignment_power
;
615 If an input section, a pointer to a vector of relocation records for
616 the data in this section.
619 struct reloc_cache_entry
*relocation
;
622 If an output section, a pointer to a vector of pointers to
623 relocation records for the data in this section.
626 struct reloc_cache_entry
**orelocation
;
629 The number of relocation records in one of the above
632 unsigned reloc_count
;
635 Which section is it 0..nth
641 Information below is back end specific - and not always used or
644 File position of section data
648 /* File position of relocation info
651 file_ptr rel_filepos
;
654 File position of line data
657 file_ptr line_filepos
;
660 Pointer to data for applications
667 struct lang_output_section
*otheruserdata
;
670 Attached line number information
674 /* Number of line number records
677 unsigned int lineno_count
;
680 When a section is being output, this value changes as more
681 linenumbers are written out
684 file_ptr moving_line_filepos
;
687 what the section number is in the target world
690 unsigned int target_index
;
697 If this is a constructor section then here is a list of the
698 relocations created to relocate items within it.
701 struct relent_chain
*constructor_chain
;
704 The BFD which owns the section.
715 bfd_get_section_by_name
716 Runs through the provided @var{abfd} and returns the @code{asection}
717 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
720 PROTO(asection
*, bfd_get_section_by_name
,
721 (bfd
*abfd
, CONST
char *name
));
726 This function creates a new empty section called @var{name} and attaches it
727 to the end of the chain of sections for the BFD supplied. An attempt to
728 create a section with a name which is already in use, returns the old
729 section by that name instead.
733 @item invalid_operation
734 If output has already started for this BFD.
736 If obstack alloc fails.
740 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
744 bfd_set_section_flags
745 Attempts to set the attributes of the section named in the BFD
746 supplied to the value. Returns true on success, false on error.
747 Possible error returns are:
749 @item invalid operation
750 The section cannot have one or more of the attributes requested. For
751 example, a .bss section in @code{a.out} may not have the
752 @code{SEC_HAS_CONTENTS} field set.
756 PROTO(boolean
, bfd_set_section_flags
,
757 (bfd
*, asection
*, flagword
));
761 bfd_map_over_sections
762 Calls the provided function @var{func} for each section attached to
763 the BFD @var{abfd}, passing @var{obj} as an argument. The function
764 will be called as if by
767 func(abfd, the_section, obj);
771 PROTO(void, bfd_map_over_sections
,
772 (bfd
*abfd
, void (*func
)(), PTR obj
));
776 This is the prefered method for iterating over sections, an
777 alternative would be to use a loop:
781 for (p = abfd->sections; p != NULL; p = p->next)
786 Sets @var{section} to the size @var{val}. If the operation is ok, then
787 @code{true} is returned, else @code{false}.
789 Possible error returns:
791 @item invalid_operation
792 Writing has started to the BFD, so setting the size is invalid
796 PROTO(boolean
, bfd_set_section_size
,
797 (bfd
*, asection
*, bfd_size_type val
));
801 bfd_set_section_contents
802 Sets the contents of the section @var{section} in BFD @var{abfd} to
803 the data starting in memory at @var{data}. The data is written to the
804 output section starting at offset @var{offset} for @var{count} bytes.
806 Normally @code{true} is returned, else @code{false}. Possible error
810 The output section does not have the @code{SEC_HAS_CONTENTS}
811 attribute, so nothing can be written to it.
812 @item and some more too
814 This routine is front end to the back end function @code{_bfd_set_section_contents}.
817 PROTO(boolean
, bfd_set_section_contents
,
822 bfd_size_type count
));
826 bfd_get_section_contents
827 This function reads data from @var{section} in BFD @var{abfd} into
828 memory starting at @var{location}. The data is read at an offset of
829 @var{offset} from the start of the input section, and is read for
832 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
833 set are requested, then the @var{location} is filled with zeroes.
835 If no errors occur, @code{true} is returned, else @code{false}.
843 PROTO(boolean
, bfd_get_section_contents
,
844 (bfd
*abfd
, asection
*section
, PTR location
,
845 file_ptr offset
, bfd_size_type count
));
854 This enum gives the object file's CPU
855 architecture, in a global sense. E.g. what processor family does it
856 belong to? There is another field, which indicates what processor
857 within the family is in use. The machine gives a number which
858 distingushes different versions of the architecture, containing for
859 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
860 Motorola 68020 and 68030.
863 enum bfd_architecture
865 bfd_arch_unknown
, /* File arch not known */
866 bfd_arch_obscure
, /* Arch known, not one of these */
867 bfd_arch_m68k
, /* Motorola 68xxx */
868 bfd_arch_vax
, /* DEC Vax */
869 bfd_arch_i960
, /* Intel 960 */
870 /* The order of the following is important.
871 lower number indicates a machine type that
872 only accepts a subset of the instructions
873 available to machines with higher numbers.
874 The exception is the "ca", which is
875 incompatible with all other machines except
878 #define bfd_mach_i960_core 1
879 #define bfd_mach_i960_ka_sa 2
880 #define bfd_mach_i960_kb_sb 3
881 #define bfd_mach_i960_mc 4
882 #define bfd_mach_i960_xa 5
883 #define bfd_mach_i960_ca 6
885 bfd_arch_a29k
, /* AMD 29000 */
886 bfd_arch_sparc
, /* SPARC */
887 bfd_arch_mips
, /* MIPS Rxxxx */
888 bfd_arch_i386
, /* Intel 386 */
889 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
890 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
891 bfd_arch_i860
, /* Intel 860 */
892 bfd_arch_romp
, /* IBM ROMP RS/6000 */
893 bfd_arch_alliant
, /* Alliant */
894 bfd_arch_convex
, /* Convex */
895 bfd_arch_m88k
, /* Motorola 88xxx */
896 bfd_arch_pyramid
, /* Pyramid Technology */
897 bfd_arch_h8300
, /* Hitachi H8/300 */
905 This structure contains information on architectures.
907 typedef int bfd_reloc_code_type
;
909 typedef struct bfd_arch_info
912 int bits_per_address
;
914 enum bfd_architecture arch
;
917 CONST
char *printable_name
;
918 /* true if this is the default machine for the architecture */
920 CONST
struct bfd_arch_info
* EXFUN((*compatible
),(CONST
struct bfd_arch_info
*a
,
921 CONST
struct bfd_arch_info
*b
));
923 boolean
EXFUN((*scan
),(CONST
struct bfd_arch_info
*,CONST
char *));
924 unsigned int EXFUN((*disassemble
),(bfd_vma addr
, CONST
char *data
,
926 CONST
struct reloc_howto_struct
*EXFUN((*reloc_type_lookup
), (CONST
struct
928 bfd_reloc_code_type code
));
930 struct bfd_arch_info
*next
;
932 } bfd_arch_info_type
;
937 Return a printable string representing the architecture and machine
938 from the pointer to the arch info structure
941 CONST
char *EXFUN(bfd_printable_name
,(bfd
*abfd
));
946 This routine is provided with a string and tries to work out if bfd
947 supports any cpu which could be described with the name provided. The
948 routine returns a pointer to an arch_info structure if a machine is
949 found, otherwise NULL.
952 bfd_arch_info_type
*EXFUN(bfd_scan_arch
,(CONST
char *));
956 bfd_arch_get_compatible
957 This routine is used to determine whether two BFDs' architectures and
958 machine types are compatible. It calculates the lowest common
959 denominator between the two architectures and machine types implied by
960 the BFDs and returns a pointer to an arch_info structure describing
961 the compatible machine.
964 CONST bfd_arch_info_type
*EXFUN(bfd_arch_get_compatible
,
973 void EXFUN(bfd_set_arch_info
,(bfd
*, bfd_arch_info_type
*));
979 Returns the enumerated type which describes the supplied bfd's
983 enum bfd_architecture
EXFUN(bfd_get_arch
, (bfd
*abfd
));
989 Returns the long type which describes the supplied bfd's
993 unsigned long EXFUN(bfd_get_mach
, (bfd
*abfd
));
997 bfd_arch_bits_per_byte
999 Returns the number of bits in one of the architectures bytes
1002 unsigned int EXFUN(bfd_arch_bits_per_byte
, (bfd
*abfd
));
1006 bfd_arch_bits_per_address
1008 Returns the number of bits in one of the architectures addresses
1011 unsigned int EXFUN(bfd_arch_bits_per_address
, (bfd
*abfd
));
1018 bfd_arch_info_type
* EXFUN(bfd_get_arch_info
,(bfd
*));
1025 bfd_arch_info_type
* EXFUN(bfd_lookup_arch
,(enum
1026 bfd_architecture arch
,long machine
));
1030 Look for the architecure info struct which matches the arguments
1031 given. A machine of 0 will match the machine/architecture structure which
1032 marks itself as the default.
1034 bfd_printable_arch_mach
1035 Return a printable string representing the architecture and machine
1038 NB. The use of this routine is depreciated.
1041 PROTO(CONST
char *,bfd_printable_arch_mach
,
1042 (enum bfd_architecture arch
, unsigned long machine
));
1048 /* bfd_perform_relocation
1049 The relocation routine returns as a status an enumerated type:
1052 typedef enum bfd_reloc_status
{
1053 /* No errors detected
1059 The relocation was performed, but there was an overflow.
1065 The address to relocate was not within the section supplied
1068 bfd_reloc_outofrange
,
1071 Used by special functions
1080 bfd_reloc_notsupported
,
1083 Unsupported relocation size requested.
1089 The symbol to relocate against was undefined.
1092 bfd_reloc_undefined
,
1095 The relocation was performed, but may not be ok - presently generated
1096 only when linking i960 coff files with i960 b.out symbols.
1101 bfd_reloc_status_type
;
1106 typedef struct reloc_cache_entry
1110 A pointer into the canonical table of pointers
1113 struct symbol_cache_entry
**sym_ptr_ptr
;
1119 rawdata_offset address
;
1122 addend for relocation value
1128 if sym is null this is the section
1131 struct sec
*section
;
1134 Pointer to how to perform the required relocation
1137 CONST
struct reloc_howto_struct
*howto
;
1143 The @code{reloc_howto_type} is a structure which contains all the
1144 information that BFD needs to know to tie up a back end's data.
1147 typedef CONST
struct reloc_howto_struct
1149 /* The type field has mainly a documetary use - the back end can to what
1150 it wants with it, though the normally the back end's external idea of
1151 what a reloc number would be would be stored in this field. For
1152 example, the a PC relative word relocation in a coff environment would
1153 have the type 023 - because that's what the outside world calls a
1160 The value the final relocation is shifted right by. This drops
1161 unwanted data from the relocation.
1164 unsigned int rightshift
;
1167 The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1177 unsigned int bitsize
;
1180 Notes that the relocation is relative to the location in the data
1181 section of the addend. The relocation function will subtract from the
1182 relocation value the address of the location being relocated.
1185 boolean pc_relative
;
1191 unsigned int bitpos
;
1200 Causes the relocation routine to return an error if overflow is
1201 detected when relocating.
1204 boolean complain_on_overflow
;
1207 If this field is non null, then the supplied function is called rather
1208 than the normal function. This allows really strange relocation
1209 methods to be accomodated (eg, i960 callj instructions).
1212 bfd_reloc_status_type (*special_function
)();
1215 The textual name of the relocation type.
1221 When performing a partial link, some formats must modify the
1222 relocations rather than the data - this flag signals this.
1225 boolean partial_inplace
;
1228 The src_mask is used to select what parts of the read in data are to
1229 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1230 which we read and relocated, this would be 0x000000ff. When we have
1231 relocs which have an addend, such as sun4 extended relocs, the value
1232 in the offset part of a relocating field is garbage so we never use
1233 it. In this case the mask would be 0x00000000.
1237 /* The dst_mask is what parts of the instruction are replaced into the
1238 instruction. In most cases src_mask == dst_mask, except in the above
1239 special case, where dst_mask would be 0x000000ff, and src_mask would
1246 When some formats create PC relative instructions, they leave the
1247 value of the pc of the place being relocated in the offset slot of the
1248 instruction, so that a PC relative relocation can be made just by
1249 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1250 displacement part of an instruction empty (eg m88k bcs), this flag
1254 boolean pcrel_offset
;
1260 The HOWTO define is horrible and will go away.
1262 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1263 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1266 And will be replaced with the totally magic way. But for the moment,
1267 we are compatible, so do it this way..
1270 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,IN)
1273 Helper routine to turn a symbol into a relocation value.
1277 #define HOWTO_PREPARE(relocation, symbol) \
1279 if (symbol != (asymbol *)NULL) { \
1280 if (symbol->flags & BSF_FORT_COMM) { \
1284 relocation = symbol->value; \
1287 if (symbol->section != (asection *)NULL) { \
1288 relocation += symbol->section->output_section->vma + \
1289 symbol->section->output_offset; \
1296 typedef unsigned char bfd_byte
;
1298 typedef struct relent_chain
{
1300 struct relent_chain
*next
;
1305 If an output_bfd is supplied to this function the generated image
1306 will be relocatable, the relocations are copied to the output file
1307 after they have been changed to reflect the new state of the world.
1308 There are two ways of reflecting the results of partial linkage in an
1309 output file; by modifying the output data in place, and by modifying
1310 the relocation record. Some native formats (eg basic a.out and basic
1311 coff) have no way of specifying an addend in the relocation type, so
1312 the addend has to go in the output data. This is no big deal since in
1313 these formats the output data slot will always be big enough for the
1314 addend. Complex reloc types with addends were invented to solve just
1317 PROTO(bfd_reloc_status_type
,
1318 bfd_perform_relocation
,
1320 arelent
*reloc_entry
,
1322 asection
*input_section
,
1330 typedef enum bfd_reloc_code_real
{
1333 16 bits wide, simple reloc
1339 8 bits wide, but used to form an address like 0xffnn
1351 8 bits wide, pc relative
1355 } bfd_reloc_code_real_type
;
1359 bfd_reloc_type_lookup
1360 This routine returns a pointer to a howto struct which when invoked,
1361 will perform the supplied relocation on data from the architecture
1364 [Note] This function will go away.
1367 PROTO(CONST
struct reloc_howto_struct
*,
1368 bfd_reloc_type_lookup
,
1369 (CONST bfd_arch_info_type
*arch
, bfd_reloc_code_type code
));
1375 /* @subsection typedef asymbol
1376 An @code{asymbol} has the form:
1379 typedef struct symbol_cache_entry
1381 /* A pointer to the BFD which owns the symbol. This information is
1382 necessary so that a back end can work out what additional (invisible to
1383 the application writer) information is carried with the symbol.
1386 struct _bfd
*the_bfd
;
1389 The text of the symbol. The name is left alone, and not copied - the
1390 application may not alter it.
1396 The value of the symbol.
1402 Attributes of a symbol:
1405 #define BSF_NO_FLAGS 0x00
1408 The symbol has local scope; @code{static} in @code{C}. The value is
1409 the offset into the section of the data.
1412 #define BSF_LOCAL 0x01
1415 The symbol has global scope; initialized data in @code{C}. The value
1416 is the offset into the section of the data.
1419 #define BSF_GLOBAL 0x02
1425 #define BSF_IMPORT 0x04
1428 The symbol has global scope, and is exported. The value is the offset
1429 into the section of the data.
1432 #define BSF_EXPORT 0x08
1435 The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
1438 #define BSF_UNDEFINED 0x10
1441 The symbol is common, initialized to zero; default in @code{C}. The
1442 value is the size of the object in bytes.
1445 #define BSF_FORT_COMM 0x20
1448 A normal @code{C} symbol would be one of:
1449 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
1451 The symbol is a debugging record. The value has an arbitary meaning.
1454 #define BSF_DEBUGGING 0x40
1457 The symbol has no section attached, any value is the actual value and
1458 is not a relative offset to a section.
1461 #define BSF_ABSOLUTE 0x80
1467 #define BSF_KEEP 0x10000
1468 #define BSF_KEEP_G 0x80000
1474 #define BSF_WEAK 0x100000
1475 #define BSF_CTOR 0x200000
1476 #define BSF_FAKE 0x400000
1479 The symbol used to be a common symbol, but now it is allocated.
1482 #define BSF_OLD_COMMON 0x800000
1485 The default value for common data.
1488 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1491 In some files the type of a symbol sometimes alters its location
1492 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
1493 symbol appears where it was declared and not at the end of a section.
1494 This bit is set by the target BFD part to convey this information.
1497 #define BSF_NOT_AT_END 0x40000
1500 Signal that the symbol is the label of constructor section.
1503 #define BSF_CONSTRUCTOR 0x1000000
1506 Signal that the symbol is a warning symbol. If the symbol is a warning
1507 symbol, then the value field (I know this is tacky) will point to the
1508 asymbol which when referenced will cause the warning.
1511 #define BSF_WARNING 0x2000000
1514 Signal that the symbol is indirect. The value of the symbol is a
1515 pointer to an undefined asymbol which contains the name to use
1519 #define BSF_INDIRECT 0x4000000
1526 A pointer to the section to which this symbol is relative, or 0 if the
1527 symbol is absolute or undefined. Note that it is not sufficient to set
1528 this location to 0 to mark a symbol as absolute - the flag
1529 @code{BSF_ABSOLUTE} must be set also.
1532 struct sec
*section
;
1535 Back end special data. This is being phased out in favour of making
1544 get_symtab_upper_bound
1545 Returns the number of bytes required in a vector of pointers to
1546 @code{asymbols} for all the symbols in the supplied BFD, including a
1547 terminal NULL pointer. If there are no symbols in the BFD, then 0 is
1550 #define get_symtab_upper_bound(abfd) \
1551 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1555 bfd_canonicalize_symtab
1556 Supplied a BFD and a pointer to an uninitialized vector of pointers.
1557 This reads in the symbols from the BFD, and fills in the table with
1558 pointers to the symbols, and a trailing NULL. The routine returns the
1559 actual number of symbol pointers not including the NULL.
1562 #define bfd_canonicalize_symtab(abfd, location) \
1563 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1568 Provided a table of pointers to to symbols and a count, writes to the
1569 output BFD the symbols when closed.
1572 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
1576 bfd_print_symbol_vandf
1577 Prints the value and flags of the symbol supplied to the stream file.
1580 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
1584 bfd_make_empty_symbol
1585 This function creates a new @code{asymbol} structure for the BFD, and
1586 returns a pointer to it.
1588 This routine is necessary, since each back end has private information
1589 surrounding the @code{asymbol}. Building your own @code{asymbol} and
1590 pointing to it will not create the private information, and will cause
1593 #define bfd_make_empty_symbol(abfd) \
1594 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1597 /* @section @code{typedef bfd}
1599 A BFD is has type @code{bfd}; objects of this type are the cornerstone
1600 of any application using @code{libbfd}. References though the BFD and
1601 to data in the BFD give the entire BFD functionality.
1603 Here is the struct used to define the type @code{bfd}. This contains
1604 the major data about the file, and contains pointers to the rest of
1610 /* The filename the application opened the BFD with.
1613 CONST
char *filename
;
1616 A pointer to the target jump table.
1619 struct bfd_target
*xvec
;
1623 To avoid dragging too many header files into every file that
1624 includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME
1625 as a "long". Their correct types, to which they are cast when used,
1626 are "FILE *" and "time_t".
1628 The iostream is the result of an fopen on the filename.
1634 Is the file being cached @xref{File Caching}.
1640 Marks whether there was a default target specified when the BFD was
1641 opened. This is used to select what matching algorithm to use to chose
1645 boolean target_defaulted
;
1648 The caching routines use these to maintain a least-recently-used list of
1649 BFDs (@pxref{File Caching}).
1652 struct _bfd
*lru_prev
, *lru_next
;
1655 When a file is closed by the caching routines, BFD retains state
1656 information on the file here:
1665 boolean opened_once
;
1670 /* File modified time
1676 Reserved for an unimplemented file locking extension.
1682 The format which belongs to the BFD.
1688 The direction the BFD was opened with
1691 enum bfd_direction
{no_direction
= 0,
1693 write_direction
= 2,
1694 both_direction
= 3} direction
;
1697 Format_specific flags
1703 Currently my_archive is tested before adding origin to anything. I
1704 believe that this can become always an add of origin, with origin set
1705 to 0 for non archive files.
1711 Remember when output has begun, to stop strange things happening.
1714 boolean output_has_begun
;
1717 Pointer to linked list of sections
1720 struct sec
*sections
;
1723 The number of sections
1726 unsigned int section_count
;
1729 Stuff only useful for object files:
1733 bfd_vma start_address
;
1734 /* Used for input and output
1737 unsigned int symcount
;
1738 /* Symbol table for output BFD
1741 struct symbol_cache_entry
**outsymbols
;
1744 Pointer to structure which contains architecture information
1747 struct bfd_arch_info
*arch_info
;
1750 Stuff only useful for archives:
1754 struct _bfd
*my_archive
;
1756 struct _bfd
*archive_head
;
1760 Used by the back end to hold private data.
1766 Used by the application to hold private data
1772 Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}).
1775 struct obstack memory
;
1780 bfd_set_start_address
1782 Marks the entry point of an output BFD. Returns @code{true} on
1783 success, @code{false} otherwise.
1786 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1792 Return cached file modification time (e.g. as read from archive header
1793 for archive members, or from file system if we have been called
1794 before); else determine modify time, cache it, and return it.
1797 PROTO(long, bfd_get_mtime
, (bfd
*));
1805 #define bfd_sizeof_headers(abfd, reloc) \
1806 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1808 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1809 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1811 #define bfd_debug_info_start(abfd) \
1812 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1814 #define bfd_debug_info_end(abfd) \
1815 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1817 #define bfd_debug_info_accumulate(abfd, section) \
1818 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1820 #define bfd_stat_arch_elt(abfd, stat) \
1821 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1823 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1824 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1826 #define bfd_coff_swap_sym_in(a,e,i) \
1827 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1829 #define bfd_coff_swap_lineno_in(a,e,i) \
1830 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1832 #define bfd_set_arch_mach(abfd, arch, mach)\
1833 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1835 #define bfd_coff_swap_reloc_out(abfd, i, o) \
1836 BFD_SEND (abfd, _bfd_coff_swap_reloc_out, (abfd, i, o))
1838 #define bfd_coff_swap_lineno_out(abfd, i, o) \
1839 BFD_SEND (abfd, _bfd_coff_swap_lineno_out, (abfd, i, o))
1841 #define bfd_coff_swap_aux_out(abfd, i, t,c,o) \
1842 BFD_SEND (abfd, _bfd_coff_swap_aux_out, (abfd, i,t,c, o))
1844 #define bfd_coff_swap_sym_out(abfd, i,o) \
1845 BFD_SEND (abfd, _bfd_coff_swap_sym_out, (abfd, i, o))
1847 #define bfd_coff_swap_scnhdr_out(abfd, i,o) \
1848 BFD_SEND (abfd, _bfd_coff_swap_scnhdr_out, (abfd, i, o))
1850 #define bfd_coff_swap_filehdr_out(abfd, i,o) \
1851 BFD_SEND (abfd, _bfd_coff_swap_filehdr_out, (abfd, i, o))
1853 #define bfd_coff_swap_aouthdr_out(abfd, i,o) \
1854 BFD_SEND (abfd, _bfd_coff_swap_aouthdr_out, (abfd, i, o))
1860 /* bfd_get_next_mapent
1863 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1867 bfd_set_archive_head
1869 Used whilst processing archives. Sets the head of the chain of BFDs
1870 contained in an archive to @var{new_head}. (see chapter on archives)
1873 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1877 bfd_get_elt_at_index
1878 Return the sub bfd contained within the archive at archive index n.
1881 PROTO(bfd
*, bfd_get_elt_at_index
, (bfd
*, int));
1885 bfd_openr_next_archived_file
1886 Initially provided a BFD containing an archive and NULL, opens a BFD
1887 on the first contained element and returns that. Subsequent calls to
1888 bfd_openr_next_archived_file should pass the archive and the previous
1889 return value to return a created BFD to the next contained element.
1890 NULL is returned when there are no more.
1893 PROTO(bfd
*, bfd_openr_next_archived_file
,
1894 (bfd
*archive
, bfd
*previous
));
1901 /* bfd_core_file_failing_command
1902 Returns a read-only string explaining what program was running when
1903 it failed and produced the core file being read
1906 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1910 bfd_core_file_failing_signal
1911 Returns the signal number which caused the core dump which generated
1912 the file the BFD is attached to.
1915 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1919 core_file_matches_executable_p
1920 Returns @code{true} if the core file attached to @var{core_bfd} was
1921 generated by a run of the executable file attached to @var{exec_bfd},
1922 or else @code{false}.
1924 PROTO(boolean
, core_file_matches_executable_p
,
1925 (bfd
*core_bfd
, bfd
*exec_bfd
));
1932 @node bfd_target, , Targets, Targets
1933 @subsection bfd_target
1934 This structure contains everything that BFD knows about a target.
1935 It includes things like its byte order, name, what routines to call
1936 to do various operations, etc.
1938 Every BFD points to a target structure with its "xvec" member.
1940 Shortcut for declaring fields which are prototyped function pointers,
1941 while avoiding anguish on compilers that don't support protos.
1944 #define SDEF(ret, name, arglist) \
1945 PROTO(ret,(*name),arglist)
1946 #define SDEF_FMT(ret, name, arglist) \
1947 PROTO(ret,(*name[bfd_type_end]),arglist)
1950 These macros are used to dispatch to functions through the bfd_target
1951 vector. They are used in a number of macros further down in @file{bfd.h}, and
1952 are also used when calling various routines by hand inside the BFD
1953 implementation. The "arglist" argument must be parenthesized; it
1954 contains all the arguments to the called function.
1957 #define BFD_SEND(bfd, message, arglist) \
1958 ((*((bfd)->xvec->message)) arglist)
1961 For operations which index on the BFD format
1964 #define BFD_SEND_FMT(bfd, message, arglist) \
1965 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1968 This is the struct which defines the type of BFD this is. The
1969 "xvec" member of the struct @code{bfd} itself points here. Each module
1970 that implements access to a different target under BFD, defines
1973 FIXME, these names should be rationalised with the names of the
1974 entry points which call them. Too bad we can't have one macro to
1978 typedef struct bfd_target
1982 identifies the kind of target, eg SunOS4, Ultrix, etc
1988 The "flavour" of a back end is a general indication about the contents
1992 enum target_flavour
{
1993 bfd_target_unknown_flavour
,
1994 bfd_target_aout_flavour
,
1995 bfd_target_coff_flavour
,
1996 bfd_target_elf_flavour
,
1997 bfd_target_ieee_flavour
,
1998 bfd_target_oasys_flavour
,
1999 bfd_target_srec_flavour
} flavour
;
2002 The order of bytes within the data area of a file.
2005 boolean byteorder_big_p
;
2008 The order of bytes within the header parts of a file.
2011 boolean header_byteorder_big_p
;
2014 This is a mask of all the flags which an executable may have set -
2015 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
2018 flagword object_flags
;
2021 This is a mask of all the flags which a section may have set - from
2022 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
2025 flagword section_flags
;
2028 The pad character for filenames within an archive header.
2034 The maximum number of characters in an archive header.
2037 unsigned short ar_max_namelen
;
2040 The minimum alignment restriction for any section.
2043 unsigned int align_power_min
;
2046 Entries for byte swapping for data. These are different to the other
2047 entry points, since they don't take BFD as first arg. Certain other handlers
2051 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
2052 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
2053 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
2054 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
2055 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
2056 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
2059 Byte swapping for the headers
2062 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
2063 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
2064 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
2065 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
2066 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
2067 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
2070 Format dependent routines, these turn into vectors of entry points
2071 within the target vector structure; one for each format to check.
2073 Check the format of a file being read. Return bfd_target * or zero.
2076 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
2079 Set the format of a file being written.
2082 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
2085 Write cached information into a file being written, at bfd_close.
2088 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
2091 The following functions are defined in @code{JUMP_TABLE}. The idea is
2092 that the back end writer of @code{foo} names all the routines
2093 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
2094 in this structure in the right order.
2096 Core file entry points
2099 SDEF (char *, _core_file_failing_command
, (bfd
*));
2100 SDEF (int, _core_file_failing_signal
, (bfd
*));
2101 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
2104 Archive entry points
2107 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
2108 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
2109 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
2110 SDEF (boolean
, write_armap
, (bfd
*arch
,
2111 unsigned int elength
,
2120 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
2121 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
2122 file_ptr
, bfd_size_type
));
2123 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
2124 file_ptr
, bfd_size_type
));
2125 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
2128 Symbols and reloctions
2131 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
2132 SDEF (unsigned int, _bfd_canonicalize_symtab
,
2133 (bfd
*, struct symbol_cache_entry
**));
2134 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
2135 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
2136 struct symbol_cache_entry
**));
2137 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
2138 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
2139 bfd_print_symbol_type
));
2140 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2141 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
2143 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
2146 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
2147 SDEF (boolean
, _bfd_find_nearest_line
,
2148 (bfd
*abfd
, struct sec
*section
,
2149 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
2150 CONST
char **file
, CONST
char **func
, unsigned int *line
));
2151 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
2153 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
2155 SDEF (void, _bfd_debug_info_start
, (bfd
*));
2156 SDEF (void, _bfd_debug_info_end
, (bfd
*));
2157 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
2160 Special entry points for gdb to swap in coff symbol table parts
2163 SDEF(void, _bfd_coff_swap_aux_in
,(
2170 SDEF(void, _bfd_coff_swap_sym_in
,(
2175 SDEF(void, _bfd_coff_swap_lineno_in
, (
2181 Special entry points for gas to swap coff parts
2184 SDEF(unsigned int, _bfd_coff_swap_aux_out
,(
2191 SDEF(unsigned int, _bfd_coff_swap_sym_out
,(
2196 SDEF(unsigned int, _bfd_coff_swap_lineno_out
,(
2201 SDEF(unsigned int, _bfd_coff_swap_reloc_out
,(
2206 SDEF(unsigned int, _bfd_coff_swap_filehdr_out
,(
2211 SDEF(unsigned int, _bfd_coff_swap_aouthdr_out
,(
2216 SDEF(unsigned int, _bfd_coff_swap_scnhdr_out
,(
2226 Returns a pointer to the transfer vector for the object target
2227 named target_name. If target_name is NULL, chooses the one in the
2228 environment variable GNUTARGET; if that is null or not defined then
2229 the first entry in the target list is chosen. Passing in the
2230 string "default" or setting the environment variable to "default"
2231 will cause the first entry in the target list to be returned,
2232 and "target_defaulted" will be set in the BFD. This causes
2233 @code{bfd_check_format} to loop over all the targets to find the one
2234 that matches the file being read.
2236 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
2241 This function returns a freshly malloced NULL-terminated vector of the
2242 names of all the valid BFD targets. Do not modify the names
2244 PROTO(CONST
char **,bfd_target_list
,());
2251 /* *i bfd_check_format
2252 This routine is supplied a BFD and a format. It attempts to verify if
2253 the file attached to the BFD is indeed compatible with the format
2254 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
2257 If the BFD has been set to a specific @var{target} before the call,
2258 only the named target and format combination will be checked. If the
2259 target has not been set, or has been set to @code{default} then all
2260 the known target backends will be interrogated to determine a match.
2262 The function returns @code{true} on success, otherwise @code{false}
2263 with one of the following error codes:
2267 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
2269 @item system_call_error
2270 if an error occured during a read - even some file mismatches can
2271 cause system_call_errros
2272 @item file_not_recognised
2273 none of the backends recognised the file format
2274 @item file_ambiguously_recognized
2275 more than one backend recognised the file format.
2278 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
2283 This function sets the file format of the supplied BFD to the format
2284 requested. If the target set in the BFD does not support the format
2285 requested, the format is illegal or the BFD is not open for writing
2286 than an error occurs.
2288 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
2292 *i bfd_format_string
2293 This function takes one argument, and enumerated type (bfd_format) and
2294 returns a pointer to a const string "invalid", "object", "archive",
2295 "core" or "unknown" depending upon the value of the enumeration.
2297 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));