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))
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 fprintf_vma(s,x) fprintf(s, "%08lx", x)
94 #define printf_vma(x) fprintf_vma(stdout,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
,
207 invalid_error_code
} bfd_ec
;
209 extern bfd_ec bfd_error
;
211 typedef struct bfd_error_vector
{
212 PROTO(void,(* nonrepresentable_section
),(CONST bfd
*CONST abfd
,
213 CONST
char *CONST name
));
214 } bfd_error_vector_type
;
216 PROTO (char *, bfd_errmsg
, ());
217 PROTO (void, bfd_perror
, (CONST
char *message
));
220 typedef enum bfd_print_symbol
222 bfd_print_symbol_name
,
223 bfd_print_symbol_more
,
224 bfd_print_symbol_all
,
225 bfd_print_symbol_nm
, /* Pretty format suitable for nm program. */
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 function closes a BFD. It differs from @code{bfd_close} since it
384 does not complete any pending operations. This routine would be used
385 if the application had just used BFD for swapping and didn't want to
386 use any of the writing code.
388 If the created file is executable, then @code{chmod} is called to mark
391 All memory attached to the BFD's obstacks is released.
393 @code{true} is returned if all is ok, otherwise @code{false}.
395 PROTO(boolean
, bfd_close_all_done
,(bfd
*));
400 This routine creates a new BFD in the manner of @code{bfd_openw}, but without
401 opening a file. The new BFD takes the target from the target used by
402 @var{template}. The format is always set to @code{bfd_object}.
405 PROTO(bfd
*, bfd_create
, (CONST
char *filename
, bfd
*template));
410 Return the number of bytes in the obstacks connected to the supplied
413 PROTO(bfd_size_type
,bfd_alloc_size
,(bfd
*abfd
));
422 These macros as used for reading and writing raw data in sections;
423 each access (except for bytes) is vectored through the target format
424 of the BFD and mangled accordingly. The mangling performs any
425 necessary endian translations and removes alignment restrictions.
427 #define bfd_put_8(abfd, val, ptr) \
428 (*((char *)ptr) = (char)val)
429 #define bfd_get_8(abfd, ptr) \
431 #define bfd_put_16(abfd, val, ptr) \
432 BFD_SEND(abfd, bfd_putx16, (val,ptr))
433 #define bfd_get_16(abfd, ptr) \
434 BFD_SEND(abfd, bfd_getx16, (ptr))
435 #define bfd_put_32(abfd, val, ptr) \
436 BFD_SEND(abfd, bfd_putx32, (val,ptr))
437 #define bfd_get_32(abfd, ptr) \
438 BFD_SEND(abfd, bfd_getx32, (ptr))
439 #define bfd_put_64(abfd, val, ptr) \
440 BFD_SEND(abfd, bfd_putx64, (val, ptr))
441 #define bfd_get_64(abfd, ptr) \
442 BFD_SEND(abfd, bfd_getx64, (ptr))
445 These macros have the same function as their @code{bfd_get_x}
446 bretherin, except that they are used for removing information for the
447 header records of object files. Believe it or not, some object files
448 keep their header records in big endian order, and their data in little
451 #define bfd_h_put_8(abfd, val, ptr) \
452 (*((char *)ptr) = (char)val)
453 #define bfd_h_get_8(abfd, ptr) \
455 #define bfd_h_put_16(abfd, val, ptr) \
456 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
457 #define bfd_h_get_16(abfd, ptr) \
458 BFD_SEND(abfd, bfd_h_getx16,(ptr))
459 #define bfd_h_put_32(abfd, val, ptr) \
460 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
461 #define bfd_h_get_32(abfd, ptr) \
462 BFD_SEND(abfd, bfd_h_getx32,(ptr))
463 #define bfd_h_put_64(abfd, val, ptr) \
464 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
465 #define bfd_h_get_64(abfd, ptr) \
466 BFD_SEND(abfd, bfd_h_getx64,(ptr))
469 /* The shape of a section struct:
475 The name of the section, the name isn't a copy, the pointer is
476 the same as that passed to bfd_make_section.
482 The next section in the list belonging to the BFD, or NULL.
488 The field flags contains attributes of the section. Some of these
489 flags are read in from the object file, and some are synthesized from
498 #define SEC_NO_FLAGS 0x000
501 Tells the OS to allocate space for this section when loaded.
502 This would clear for a section containing debug information only.
505 #define SEC_ALLOC 0x001
508 Tells the OS to load the section from the file when loading.
509 This would be clear for a .bss section
512 #define SEC_LOAD 0x002
515 The section contains data still to be relocated, so there will be some
516 relocation information too.
519 #define SEC_RELOC 0x004
525 #define SEC_BALIGN 0x008
528 A signal to the OS that the section contains read only data.
531 #define SEC_READONLY 0x010
534 The section contains code only.
537 #define SEC_CODE 0x020
540 The section contains data only.
543 #define SEC_DATA 0x040
546 The section will reside in ROM.
549 #define SEC_ROM 0x080
552 The section contains constructor information. This section type is
553 used by the linker to create lists of constructors and destructors
554 used by @code{g++}. When a back end sees a symbol which should be used
555 in a constructor list, it creates a new section for the type of name
556 (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a
557 relocation. To build the lists of constructors, all the linker has to
558 to is catenate all the sections called @code{__CTOR_LIST__} and
559 relocte the data contained within - exactly the operations it would
560 peform on standard data.
563 #define SEC_CONSTRUCTOR 0x100
566 The section is a constuctor, and should be placed at the end of the ..
569 #define SEC_CONSTRUCTOR_TEXT 0x1100
573 #define SEC_CONSTRUCTOR_DATA 0x2100
577 #define SEC_CONSTRUCTOR_BSS 0x3100
581 The section has contents - a bss section could be
582 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
583 @code{SEC_HAS_CONTENTS}
586 #define SEC_HAS_CONTENTS 0x200
589 An instruction to the linker not to output sections containing
590 this flag even if they have information which would normally be written.
593 #define SEC_NEVER_LOAD 0x400
597 The base address of the section in the address space of the target.
603 The size of the section in bytes of the loaded section. This contains
604 a value even if the section has no contents (eg, the size of @code{.bss}).
610 If this section is going to be output, then this value is the
611 offset into the output section of the first byte in the input
612 section. Eg, if this was going to start at the 100th byte in the
613 output section, this value would be 100.
616 bfd_vma output_offset
;
619 The output section through which to map on output.
622 struct sec
*output_section
;
625 The alignment requirement of the section, as an exponent - eg 3
629 unsigned int alignment_power
;
632 If an input section, a pointer to a vector of relocation records for
633 the data in this section.
636 struct reloc_cache_entry
*relocation
;
639 If an output section, a pointer to a vector of pointers to
640 relocation records for the data in this section.
643 struct reloc_cache_entry
**orelocation
;
646 The number of relocation records in one of the above
649 unsigned reloc_count
;
652 Which section is it 0..nth
658 Information below is back end specific - and not always used or
661 File position of section data
665 /* File position of relocation info
668 file_ptr rel_filepos
;
671 File position of line data
674 file_ptr line_filepos
;
677 Pointer to data for applications
684 struct lang_output_section
*otheruserdata
;
687 Attached line number information
691 /* Number of line number records
694 unsigned int lineno_count
;
697 When a section is being output, this value changes as more
698 linenumbers are written out
701 file_ptr moving_line_filepos
;
704 what the section number is in the target world
707 unsigned int target_index
;
714 If this is a constructor section then here is a list of the
715 relocations created to relocate items within it.
718 struct relent_chain
*constructor_chain
;
721 The BFD which owns the section.
732 bfd_get_section_by_name
733 Runs through the provided @var{abfd} and returns the @code{asection}
734 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
737 PROTO(asection
*, bfd_get_section_by_name
,
738 (bfd
*abfd
, CONST
char *name
));
742 bfd_make_section_old_way
743 This function creates a new empty section called @var{name} and attaches it
744 to the end of the chain of sections for the BFD supplied. An attempt to
745 create a section with a name which is already in use, returns its pointer without
746 changing the section chain.
748 It has the funny name since this is the way it used to be before gilmore broke it.
752 @item invalid_operation
753 If output has already started for this BFD.
755 If obstack alloc fails.
759 PROTO(asection
*, bfd_make_section_old_way
, (bfd
*, CONST
char *name
));
764 This function creates a new empty section called @var{name} and attaches it
765 to the end of the chain of sections for the BFD supplied. An attempt to
766 create a section with a name which is already in use, returns NULL without
767 changing the section chain.
771 @item invalid_operation
772 If output has already started for this BFD.
774 If obstack alloc fails.
778 PROTO(asection
*, bfd_make_section
, (bfd
*, CONST
char *name
));
782 bfd_set_section_flags
783 Attempts to set the attributes of the section named in the BFD
784 supplied to the value. Returns true on success, false on error.
785 Possible error returns are:
787 @item invalid operation
788 The section cannot have one or more of the attributes requested. For
789 example, a .bss section in @code{a.out} may not have the
790 @code{SEC_HAS_CONTENTS} field set.
794 PROTO(boolean
, bfd_set_section_flags
,
795 (bfd
*, asection
*, flagword
));
799 bfd_map_over_sections
800 Calls the provided function @var{func} for each section attached to
801 the BFD @var{abfd}, passing @var{obj} as an argument. The function
802 will be called as if by
805 func(abfd, the_section, obj);
809 PROTO(void, bfd_map_over_sections
,
810 (bfd
*abfd
, void (*func
)(), PTR obj
));
814 This is the prefered method for iterating over sections, an
815 alternative would be to use a loop:
819 for (p = abfd->sections; p != NULL; p = p->next)
824 Sets @var{section} to the size @var{val}. If the operation is ok, then
825 @code{true} is returned, else @code{false}.
827 Possible error returns:
829 @item invalid_operation
830 Writing has started to the BFD, so setting the size is invalid
834 PROTO(boolean
, bfd_set_section_size
,
835 (bfd
*, asection
*, bfd_size_type val
));
839 bfd_set_section_contents
840 Sets the contents of the section @var{section} in BFD @var{abfd} to
841 the data starting in memory at @var{data}. The data is written to the
842 output section starting at offset @var{offset} for @var{count} bytes.
844 Normally @code{true} is returned, else @code{false}. Possible error
848 The output section does not have the @code{SEC_HAS_CONTENTS}
849 attribute, so nothing can be written to it.
850 @item and some more too
852 This routine is front end to the back end function @code{_bfd_set_section_contents}.
855 PROTO(boolean
, bfd_set_section_contents
,
860 bfd_size_type count
));
864 bfd_get_section_contents
865 This function reads data from @var{section} in BFD @var{abfd} into
866 memory starting at @var{location}. The data is read at an offset of
867 @var{offset} from the start of the input section, and is read for
870 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
871 set are requested, then the @var{location} is filled with zeroes.
873 If no errors occur, @code{true} is returned, else @code{false}.
881 PROTO(boolean
, bfd_get_section_contents
,
882 (bfd
*abfd
, asection
*section
, PTR location
,
883 file_ptr offset
, bfd_size_type count
));
892 This enum gives the object file's CPU
893 architecture, in a global sense. E.g. what processor family does it
894 belong to? There is another field, which indicates what processor
895 within the family is in use. The machine gives a number which
896 distingushes different versions of the architecture, containing for
897 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
898 Motorola 68020 and 68030.
901 enum bfd_architecture
903 bfd_arch_unknown
, /* File arch not known */
904 bfd_arch_obscure
, /* Arch known, not one of these */
905 bfd_arch_m68k
, /* Motorola 68xxx */
906 bfd_arch_vax
, /* DEC Vax */
907 bfd_arch_i960
, /* Intel 960 */
908 /* The order of the following is important.
909 lower number indicates a machine type that
910 only accepts a subset of the instructions
911 available to machines with higher numbers.
912 The exception is the "ca", which is
913 incompatible with all other machines except
916 #define bfd_mach_i960_core 1
917 #define bfd_mach_i960_ka_sa 2
918 #define bfd_mach_i960_kb_sb 3
919 #define bfd_mach_i960_mc 4
920 #define bfd_mach_i960_xa 5
921 #define bfd_mach_i960_ca 6
923 bfd_arch_a29k
, /* AMD 29000 */
924 bfd_arch_sparc
, /* SPARC */
925 bfd_arch_mips
, /* MIPS Rxxxx */
926 bfd_arch_i386
, /* Intel 386 */
927 bfd_arch_ns32k
, /* National Semiconductor 32xxx */
928 bfd_arch_tahoe
, /* CCI/Harris Tahoe */
929 bfd_arch_i860
, /* Intel 860 */
930 bfd_arch_romp
, /* IBM ROMP PC/RT */
931 bfd_arch_alliant
, /* Alliant */
932 bfd_arch_convex
, /* Convex */
933 bfd_arch_m88k
, /* Motorola 88xxx */
934 bfd_arch_pyramid
, /* Pyramid Technology */
935 bfd_arch_h8300
, /* Hitachi H8/300 */
936 bfd_arch_rs6000
, /* IBM RS/6000 */
944 This structure contains information on architectures.
946 typedef int bfd_reloc_code_type
;
948 typedef struct bfd_arch_info
951 int bits_per_address
;
953 enum bfd_architecture arch
;
956 CONST
char *printable_name
;
957 /* true if this is the default machine for the architecture */
959 CONST
struct bfd_arch_info
* EXFUN((*compatible
),(CONST
struct bfd_arch_info
*a
,
960 CONST
struct bfd_arch_info
*b
));
962 boolean
EXFUN((*scan
),(CONST
struct bfd_arch_info
*,CONST
char *));
963 unsigned int EXFUN((*disassemble
),(bfd_vma addr
, CONST
char *data
,
965 CONST
struct reloc_howto_struct
*EXFUN((*reloc_type_lookup
), (CONST
struct
967 bfd_reloc_code_type code
));
969 struct bfd_arch_info
*next
;
971 } bfd_arch_info_type
;
976 Return a printable string representing the architecture and machine
977 from the pointer to the arch info structure
980 CONST
char *EXFUN(bfd_printable_name
,(bfd
*abfd
));
985 This routine is provided with a string and tries to work out if bfd
986 supports any cpu which could be described with the name provided. The
987 routine returns a pointer to an arch_info structure if a machine is
988 found, otherwise NULL.
991 bfd_arch_info_type
*EXFUN(bfd_scan_arch
,(CONST
char *));
995 bfd_arch_get_compatible
996 This routine is used to determine whether two BFDs' architectures and
997 machine types are compatible. It calculates the lowest common
998 denominator between the two architectures and machine types implied by
999 the BFDs and returns a pointer to an arch_info structure describing
1000 the compatible machine.
1003 CONST bfd_arch_info_type
*EXFUN(bfd_arch_get_compatible
,
1012 void EXFUN(bfd_set_arch_info
,(bfd
*, bfd_arch_info_type
*));
1018 Returns the enumerated type which describes the supplied bfd's
1022 enum bfd_architecture
EXFUN(bfd_get_arch
, (bfd
*abfd
));
1028 Returns the long type which describes the supplied bfd's
1032 unsigned long EXFUN(bfd_get_mach
, (bfd
*abfd
));
1036 bfd_arch_bits_per_byte
1038 Returns the number of bits in one of the architectures bytes
1041 unsigned int EXFUN(bfd_arch_bits_per_byte
, (bfd
*abfd
));
1045 bfd_arch_bits_per_address
1047 Returns the number of bits in one of the architectures addresses
1050 unsigned int EXFUN(bfd_arch_bits_per_address
, (bfd
*abfd
));
1057 bfd_arch_info_type
* EXFUN(bfd_get_arch_info
,(bfd
*));
1064 bfd_arch_info_type
* EXFUN(bfd_lookup_arch
,(enum
1065 bfd_architecture arch
,long machine
));
1069 Look for the architecure info struct which matches the arguments
1070 given. A machine of 0 will match the machine/architecture structure which
1071 marks itself as the default.
1073 bfd_printable_arch_mach
1074 Return a printable string representing the architecture and machine
1077 NB. The use of this routine is depreciated.
1080 PROTO(CONST
char *,bfd_printable_arch_mach
,
1081 (enum bfd_architecture arch
, unsigned long machine
));
1087 /* bfd_perform_relocation
1088 The relocation routine returns as a status an enumerated type:
1091 typedef enum bfd_reloc_status
{
1092 /* No errors detected
1098 The relocation was performed, but there was an overflow.
1104 The address to relocate was not within the section supplied
1107 bfd_reloc_outofrange
,
1110 Used by special functions
1119 bfd_reloc_notsupported
,
1122 Unsupported relocation size requested.
1128 The symbol to relocate against was undefined.
1131 bfd_reloc_undefined
,
1134 The relocation was performed, but may not be ok - presently generated
1135 only when linking i960 coff files with i960 b.out symbols.
1140 bfd_reloc_status_type
;
1145 typedef struct reloc_cache_entry
1149 A pointer into the canonical table of pointers
1152 struct symbol_cache_entry
**sym_ptr_ptr
;
1158 rawdata_offset address
;
1161 addend for relocation value
1167 if sym is null this is the section
1170 struct sec
*section
;
1173 Pointer to how to perform the required relocation
1176 CONST
struct reloc_howto_struct
*howto
;
1182 The @code{reloc_howto_type} is a structure which contains all the
1183 information that BFD needs to know to tie up a back end's data.
1186 typedef CONST
struct reloc_howto_struct
1188 /* The type field has mainly a documetary use - the back end can to what
1189 it wants with it, though the normally the back end's external idea of
1190 what a reloc number would be would be stored in this field. For
1191 example, the a PC relative word relocation in a coff environment would
1192 have the type 023 - because that's what the outside world calls a
1199 The value the final relocation is shifted right by. This drops
1200 unwanted data from the relocation.
1203 unsigned int rightshift
;
1206 The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1216 unsigned int bitsize
;
1219 Notes that the relocation is relative to the location in the data
1220 section of the addend. The relocation function will subtract from the
1221 relocation value the address of the location being relocated.
1224 boolean pc_relative
;
1230 unsigned int bitpos
;
1239 Causes the relocation routine to return an error if overflow is
1240 detected when relocating.
1243 boolean complain_on_overflow
;
1246 If this field is non null, then the supplied function is called rather
1247 than the normal function. This allows really strange relocation
1248 methods to be accomodated (eg, i960 callj instructions).
1251 bfd_reloc_status_type (*special_function
)();
1254 The textual name of the relocation type.
1260 When performing a partial link, some formats must modify the
1261 relocations rather than the data - this flag signals this.
1264 boolean partial_inplace
;
1267 The src_mask is used to select what parts of the read in data are to
1268 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1269 which we read and relocated, this would be 0x000000ff. When we have
1270 relocs which have an addend, such as sun4 extended relocs, the value
1271 in the offset part of a relocating field is garbage so we never use
1272 it. In this case the mask would be 0x00000000.
1276 /* The dst_mask is what parts of the instruction are replaced into the
1277 instruction. In most cases src_mask == dst_mask, except in the above
1278 special case, where dst_mask would be 0x000000ff, and src_mask would
1285 When some formats create PC relative instructions, they leave the
1286 value of the pc of the place being relocated in the offset slot of the
1287 instruction, so that a PC relative relocation can be made just by
1288 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1289 displacement part of an instruction empty (eg m88k bcs), this flag
1293 boolean pcrel_offset
;
1299 The HOWTO define is horrible and will go away.
1301 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1302 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1305 And will be replaced with the totally magic way. But for the moment,
1306 we are compatible, so do it this way..
1309 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,IN)
1312 Helper routine to turn a symbol into a relocation value.
1316 #define HOWTO_PREPARE(relocation, symbol) \
1318 if (symbol != (asymbol *)NULL) { \
1319 if (symbol->flags & BSF_FORT_COMM) { \
1323 relocation = symbol->value; \
1326 if (symbol->section != (asection *)NULL) { \
1327 relocation += symbol->section->output_section->vma + \
1328 symbol->section->output_offset; \
1335 typedef unsigned char bfd_byte
;
1337 typedef struct relent_chain
{
1339 struct relent_chain
*next
;
1344 If an output_bfd is supplied to this function the generated image
1345 will be relocatable, the relocations are copied to the output file
1346 after they have been changed to reflect the new state of the world.
1347 There are two ways of reflecting the results of partial linkage in an
1348 output file; by modifying the output data in place, and by modifying
1349 the relocation record. Some native formats (eg basic a.out and basic
1350 coff) have no way of specifying an addend in the relocation type, so
1351 the addend has to go in the output data. This is no big deal since in
1352 these formats the output data slot will always be big enough for the
1353 addend. Complex reloc types with addends were invented to solve just
1356 PROTO(bfd_reloc_status_type
,
1357 bfd_perform_relocation
,
1359 arelent
*reloc_entry
,
1361 asection
*input_section
,
1369 typedef enum bfd_reloc_code_real
{
1372 16 bits wide, simple reloc
1378 8 bits wide, but used to form an address like 0xffnn
1390 8 bits wide, pc relative
1396 The type of reloc used to build a contructor table - at the moment probably a 32 bit
1397 wide abs address, but the cpu can choose.
1404 } bfd_reloc_code_real_type
;
1408 bfd_reloc_type_lookup
1409 This routine returns a pointer to a howto struct which when invoked,
1410 will perform the supplied relocation on data from the architecture
1414 PROTO(CONST
struct reloc_howto_struct
*,
1415 bfd_reloc_type_lookup
,
1416 (CONST bfd_arch_info_type
*arch
, bfd_reloc_code_type code
));
1422 /* @subsection typedef asymbol
1423 An @code{asymbol} has the form:
1426 typedef struct symbol_cache_entry
1428 /* A pointer to the BFD which owns the symbol. This information is
1429 necessary so that a back end can work out what additional (invisible to
1430 the application writer) information is carried with the symbol.
1433 struct _bfd
*the_bfd
;
1436 The text of the symbol. The name is left alone, and not copied - the
1437 application may not alter it.
1443 The value of the symbol.
1449 Attributes of a symbol:
1452 #define BSF_NO_FLAGS 0x00
1455 The symbol has local scope; @code{static} in @code{C}. The value is
1456 the offset into the section of the data.
1459 #define BSF_LOCAL 0x01
1462 The symbol has global scope; initialized data in @code{C}. The value
1463 is the offset into the section of the data.
1466 #define BSF_GLOBAL 0x02
1472 #define BSF_IMPORT 0x04
1475 The symbol has global scope, and is exported. The value is the offset
1476 into the section of the data.
1479 #define BSF_EXPORT 0x08
1482 The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
1485 #define BSF_UNDEFINED 0x10
1488 The symbol is common, initialized to zero; default in @code{C}. The
1489 value is the size of the object in bytes.
1492 #define BSF_FORT_COMM 0x20
1495 A normal @code{C} symbol would be one of:
1496 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
1498 The symbol is a debugging record. The value has an arbitary meaning.
1501 #define BSF_DEBUGGING 0x40
1504 The symbol has no section attached, any value is the actual value and
1505 is not a relative offset to a section.
1508 #define BSF_ABSOLUTE 0x80
1514 #define BSF_KEEP 0x10000
1515 #define BSF_KEEP_G 0x80000
1521 #define BSF_WEAK 0x100000
1522 #define BSF_CTOR 0x200000
1523 #define BSF_FAKE 0x400000
1526 The symbol used to be a common symbol, but now it is allocated.
1529 #define BSF_OLD_COMMON 0x800000
1532 The default value for common data.
1535 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1538 In some files the type of a symbol sometimes alters its location
1539 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
1540 symbol appears where it was declared and not at the end of a section.
1541 This bit is set by the target BFD part to convey this information.
1544 #define BSF_NOT_AT_END 0x40000
1547 Signal that the symbol is the label of constructor section.
1550 #define BSF_CONSTRUCTOR 0x1000000
1553 Signal that the symbol is a warning symbol. If the symbol is a warning
1554 symbol, then the value field (I know this is tacky) will point to the
1555 asymbol which when referenced will cause the warning.
1558 #define BSF_WARNING 0x2000000
1561 Signal that the symbol is indirect. The value of the symbol is a
1562 pointer to an undefined asymbol which contains the name to use
1566 #define BSF_INDIRECT 0x4000000
1573 A pointer to the section to which this symbol is relative, or 0 if the
1574 symbol is absolute or undefined. Note that it is not sufficient to set
1575 this location to 0 to mark a symbol as absolute - the flag
1576 @code{BSF_ABSOLUTE} must be set also.
1579 struct sec
*section
;
1582 Back end special data. This is being phased out in favour of making
1591 get_symtab_upper_bound
1592 Returns the number of bytes required in a vector of pointers to
1593 @code{asymbols} for all the symbols in the supplied BFD, including a
1594 terminal NULL pointer. If there are no symbols in the BFD, then 0 is
1597 #define get_symtab_upper_bound(abfd) \
1598 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1602 bfd_canonicalize_symtab
1603 Supplied a BFD and a pointer to an uninitialized vector of pointers.
1604 This reads in the symbols from the BFD, and fills in the table with
1605 pointers to the symbols, and a trailing NULL. The routine returns the
1606 actual number of symbol pointers not including the NULL.
1609 #define bfd_canonicalize_symtab(abfd, location) \
1610 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1615 Provided a table of pointers to symbols and a count, writes to the
1616 output BFD the symbols when closed.
1619 PROTO(boolean
, bfd_set_symtab
, (bfd
*, asymbol
**, unsigned int ));
1623 bfd_print_symbol_vandf
1624 Prints the value and flags of the symbol supplied to the stream file.
1627 PROTO(void, bfd_print_symbol_vandf
, (PTR file
, asymbol
*symbol
));
1631 bfd_make_empty_symbol
1632 This function creates a new @code{asymbol} structure for the BFD, and
1633 returns a pointer to it.
1635 This routine is necessary, since each back end has private information
1636 surrounding the @code{asymbol}. Building your own @code{asymbol} and
1637 pointing to it will not create the private information, and will cause
1640 #define bfd_make_empty_symbol(abfd) \
1641 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1645 Return a lower-case character corresponding to the symbol class of symbol.
1648 PROTO(int, bfd_decode_symclass
, (asymbol
*symbol
));
1654 /* @section @code{typedef bfd}
1656 A BFD is has type @code{bfd}; objects of this type are the cornerstone
1657 of any application using @code{libbfd}. References though the BFD and
1658 to data in the BFD give the entire BFD functionality.
1660 Here is the struct used to define the type @code{bfd}. This contains
1661 the major data about the file, and contains pointers to the rest of
1667 /* The filename the application opened the BFD with.
1670 CONST
char *filename
;
1673 A pointer to the target jump table.
1676 struct bfd_target
*xvec
;
1680 To avoid dragging too many header files into every file that
1681 includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME
1682 as a "long". Their correct types, to which they are cast when used,
1683 are "FILE *" and "time_t".
1685 The iostream is the result of an fopen on the filename.
1691 Is the file being cached @xref{File Caching}.
1697 Marks whether there was a default target specified when the BFD was
1698 opened. This is used to select what matching algorithm to use to chose
1702 boolean target_defaulted
;
1705 The caching routines use these to maintain a least-recently-used list of
1706 BFDs (@pxref{File Caching}).
1709 struct _bfd
*lru_prev
, *lru_next
;
1712 When a file is closed by the caching routines, BFD retains state
1713 information on the file here:
1722 boolean opened_once
;
1727 /* File modified time
1733 Reserved for an unimplemented file locking extension.
1739 The format which belongs to the BFD.
1745 The direction the BFD was opened with
1748 enum bfd_direction
{no_direction
= 0,
1750 write_direction
= 2,
1751 both_direction
= 3} direction
;
1754 Format_specific flags
1760 Currently my_archive is tested before adding origin to anything. I
1761 believe that this can become always an add of origin, with origin set
1762 to 0 for non archive files.
1768 Remember when output has begun, to stop strange things happening.
1771 boolean output_has_begun
;
1774 Pointer to linked list of sections
1777 struct sec
*sections
;
1780 The number of sections
1783 unsigned int section_count
;
1786 Stuff only useful for object files:
1790 bfd_vma start_address
;
1791 /* Used for input and output
1794 unsigned int symcount
;
1795 /* Symbol table for output BFD
1798 struct symbol_cache_entry
**outsymbols
;
1801 Pointer to structure which contains architecture information
1804 struct bfd_arch_info
*arch_info
;
1807 Stuff only useful for archives:
1811 struct _bfd
*my_archive
;
1813 struct _bfd
*archive_head
;
1817 Used by the back end to hold private data.
1823 Used by the application to hold private data
1829 Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}).
1832 struct obstack memory
;
1837 bfd_set_start_address
1839 Marks the entry point of an output BFD. Returns @code{true} on
1840 success, @code{false} otherwise.
1843 PROTO(boolean
, bfd_set_start_address
,(bfd
*, bfd_vma
));
1849 Return cached file modification time (e.g. as read from archive header
1850 for archive members, or from file system if we have been called
1851 before); else determine modify time, cache it, and return it.
1854 PROTO(long, bfd_get_mtime
, (bfd
*));
1862 #define bfd_sizeof_headers(abfd, reloc) \
1863 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1865 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1866 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1868 #define bfd_debug_info_start(abfd) \
1869 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1871 #define bfd_debug_info_end(abfd) \
1872 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1874 #define bfd_debug_info_accumulate(abfd, section) \
1875 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1877 #define bfd_stat_arch_elt(abfd, stat) \
1878 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1880 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1881 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1883 #define bfd_coff_swap_sym_in(a,e,i) \
1884 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1886 #define bfd_coff_swap_lineno_in(a,e,i) \
1887 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1889 #define bfd_set_arch_mach(abfd, arch, mach)\
1890 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1892 #define bfd_coff_swap_reloc_out(abfd, i, o) \
1893 BFD_SEND (abfd, _bfd_coff_swap_reloc_out, (abfd, i, o))
1895 #define bfd_coff_swap_lineno_out(abfd, i, o) \
1896 BFD_SEND (abfd, _bfd_coff_swap_lineno_out, (abfd, i, o))
1898 #define bfd_coff_swap_aux_out(abfd, i, t,c,o) \
1899 BFD_SEND (abfd, _bfd_coff_swap_aux_out, (abfd, i,t,c, o))
1901 #define bfd_coff_swap_sym_out(abfd, i,o) \
1902 BFD_SEND (abfd, _bfd_coff_swap_sym_out, (abfd, i, o))
1904 #define bfd_coff_swap_scnhdr_out(abfd, i,o) \
1905 BFD_SEND (abfd, _bfd_coff_swap_scnhdr_out, (abfd, i, o))
1907 #define bfd_coff_swap_filehdr_out(abfd, i,o) \
1908 BFD_SEND (abfd, _bfd_coff_swap_filehdr_out, (abfd, i, o))
1910 #define bfd_coff_swap_aouthdr_out(abfd, i,o) \
1911 BFD_SEND (abfd, _bfd_coff_swap_aouthdr_out, (abfd, i, o))
1917 /* bfd_get_next_mapent
1920 PROTO(symindex
, bfd_get_next_mapent
, (bfd
*, symindex
, carsym
**));
1924 bfd_set_archive_head
1926 Used whilst processing archives. Sets the head of the chain of BFDs
1927 contained in an archive to @var{new_head}. (see chapter on archives)
1930 PROTO(boolean
, bfd_set_archive_head
, (bfd
*output
, bfd
*new_head
));
1934 bfd_get_elt_at_index
1935 Return the sub bfd contained within the archive at archive index n.
1938 PROTO(bfd
*, bfd_get_elt_at_index
, (bfd
*, int));
1942 bfd_openr_next_archived_file
1943 Initially provided a BFD containing an archive and NULL, opens a BFD
1944 on the first contained element and returns that. Subsequent calls to
1945 bfd_openr_next_archived_file should pass the archive and the previous
1946 return value to return a created BFD to the next contained element.
1947 NULL is returned when there are no more.
1950 PROTO(bfd
*, bfd_openr_next_archived_file
,
1951 (bfd
*archive
, bfd
*previous
));
1958 /* bfd_core_file_failing_command
1959 Returns a read-only string explaining what program was running when
1960 it failed and produced the core file being read
1963 PROTO(CONST
char *, bfd_core_file_failing_command
, (bfd
*));
1967 bfd_core_file_failing_signal
1968 Returns the signal number which caused the core dump which generated
1969 the file the BFD is attached to.
1972 PROTO(int, bfd_core_file_failing_signal
, (bfd
*));
1976 core_file_matches_executable_p
1977 Returns @code{true} if the core file attached to @var{core_bfd} was
1978 generated by a run of the executable file attached to @var{exec_bfd},
1979 or else @code{false}.
1981 PROTO(boolean
, core_file_matches_executable_p
,
1982 (bfd
*core_bfd
, bfd
*exec_bfd
));
1989 @node bfd_target, , Targets, Targets
1990 @subsection bfd_target
1991 This structure contains everything that BFD knows about a target.
1992 It includes things like its byte order, name, what routines to call
1993 to do various operations, etc.
1995 Every BFD points to a target structure with its "xvec" member.
1997 Shortcut for declaring fields which are prototyped function pointers,
1998 while avoiding anguish on compilers that don't support protos.
2001 #define SDEF(ret, name, arglist) \
2002 PROTO(ret,(*name),arglist)
2003 #define SDEF_FMT(ret, name, arglist) \
2004 PROTO(ret,(*name[bfd_type_end]),arglist)
2007 These macros are used to dispatch to functions through the bfd_target
2008 vector. They are used in a number of macros further down in @file{bfd.h}, and
2009 are also used when calling various routines by hand inside the BFD
2010 implementation. The "arglist" argument must be parenthesized; it
2011 contains all the arguments to the called function.
2014 #define BFD_SEND(bfd, message, arglist) \
2015 ((*((bfd)->xvec->message)) arglist)
2018 For operations which index on the BFD format
2021 #define BFD_SEND_FMT(bfd, message, arglist) \
2022 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
2025 This is the struct which defines the type of BFD this is. The
2026 "xvec" member of the struct @code{bfd} itself points here. Each module
2027 that implements access to a different target under BFD, defines
2030 FIXME, these names should be rationalised with the names of the
2031 entry points which call them. Too bad we can't have one macro to
2035 typedef struct bfd_target
2039 identifies the kind of target, eg SunOS4, Ultrix, etc
2045 The "flavour" of a back end is a general indication about the contents
2049 enum target_flavour
{
2050 bfd_target_unknown_flavour
,
2051 bfd_target_aout_flavour
,
2052 bfd_target_coff_flavour
,
2053 bfd_target_elf_flavour
,
2054 bfd_target_ieee_flavour
,
2055 bfd_target_oasys_flavour
,
2056 bfd_target_srec_flavour
} flavour
;
2059 The order of bytes within the data area of a file.
2062 boolean byteorder_big_p
;
2065 The order of bytes within the header parts of a file.
2068 boolean header_byteorder_big_p
;
2071 This is a mask of all the flags which an executable may have set -
2072 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
2075 flagword object_flags
;
2078 This is a mask of all the flags which a section may have set - from
2079 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
2082 flagword section_flags
;
2085 The pad character for filenames within an archive header.
2091 The maximum number of characters in an archive header.
2094 unsigned short ar_max_namelen
;
2097 The minimum alignment restriction for any section.
2100 unsigned int align_power_min
;
2103 Entries for byte swapping for data. These are different to the other
2104 entry points, since they don't take BFD as first arg. Certain other handlers
2108 SDEF (bfd_vma
, bfd_getx64
, (bfd_byte
*));
2109 SDEF (void, bfd_putx64
, (bfd_vma
, bfd_byte
*));
2110 SDEF (bfd_vma
, bfd_getx32
, (bfd_byte
*));
2111 SDEF (void, bfd_putx32
, (bfd_vma
, bfd_byte
*));
2112 SDEF (bfd_vma
, bfd_getx16
, (bfd_byte
*));
2113 SDEF (void, bfd_putx16
, (bfd_vma
, bfd_byte
*));
2116 Byte swapping for the headers
2119 SDEF (bfd_vma
, bfd_h_getx64
, (bfd_byte
*));
2120 SDEF (void, bfd_h_putx64
, (bfd_vma
, bfd_byte
*));
2121 SDEF (bfd_vma
, bfd_h_getx32
, (bfd_byte
*));
2122 SDEF (void, bfd_h_putx32
, (bfd_vma
, bfd_byte
*));
2123 SDEF (bfd_vma
, bfd_h_getx16
, (bfd_byte
*));
2124 SDEF (void, bfd_h_putx16
, (bfd_vma
, bfd_byte
*));
2127 Format dependent routines, these turn into vectors of entry points
2128 within the target vector structure; one for each format to check.
2130 Check the format of a file being read. Return bfd_target * or zero.
2133 SDEF_FMT (struct bfd_target
*, _bfd_check_format
, (bfd
*));
2136 Set the format of a file being written.
2139 SDEF_FMT (boolean
, _bfd_set_format
, (bfd
*));
2142 Write cached information into a file being written, at bfd_close.
2145 SDEF_FMT (boolean
, _bfd_write_contents
, (bfd
*));
2148 The following functions are defined in @code{JUMP_TABLE}. The idea is
2149 that the back end writer of @code{foo} names all the routines
2150 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
2151 in this structure in the right order.
2153 Core file entry points
2156 SDEF (char *, _core_file_failing_command
, (bfd
*));
2157 SDEF (int, _core_file_failing_signal
, (bfd
*));
2158 SDEF (boolean
, _core_file_matches_executable_p
, (bfd
*, bfd
*));
2161 Archive entry points
2164 SDEF (boolean
, _bfd_slurp_armap
, (bfd
*));
2165 SDEF (boolean
, _bfd_slurp_extended_name_table
, (bfd
*));
2166 SDEF (void, _bfd_truncate_arname
, (bfd
*, CONST
char *, char *));
2167 SDEF (boolean
, write_armap
, (bfd
*arch
,
2168 unsigned int elength
,
2170 unsigned int orl_count
,
2177 SDEF (boolean
, _close_and_cleanup
, (bfd
*));
2178 SDEF (boolean
, _bfd_set_section_contents
, (bfd
*, sec_ptr
, PTR
,
2179 file_ptr
, bfd_size_type
));
2180 SDEF (boolean
, _bfd_get_section_contents
, (bfd
*, sec_ptr
, PTR
,
2181 file_ptr
, bfd_size_type
));
2182 SDEF (boolean
, _new_section_hook
, (bfd
*, sec_ptr
));
2185 Symbols and reloctions
2188 SDEF (unsigned int, _get_symtab_upper_bound
, (bfd
*));
2189 SDEF (unsigned int, _bfd_canonicalize_symtab
,
2190 (bfd
*, struct symbol_cache_entry
**));
2191 SDEF (unsigned int, _get_reloc_upper_bound
, (bfd
*, sec_ptr
));
2192 SDEF (unsigned int, _bfd_canonicalize_reloc
, (bfd
*, sec_ptr
, arelent
**,
2193 struct symbol_cache_entry
**));
2194 SDEF (struct symbol_cache_entry
*, _bfd_make_empty_symbol
, (bfd
*));
2195 SDEF (void, _bfd_print_symbol
, (bfd
*, PTR
, struct symbol_cache_entry
*,
2196 bfd_print_symbol_type
));
2197 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2198 SDEF (alent
*, _get_lineno
, (bfd
*, struct symbol_cache_entry
*));
2200 SDEF (boolean
, _bfd_set_arch_mach
, (bfd
*, enum bfd_architecture
,
2203 SDEF (bfd
*, openr_next_archived_file
, (bfd
*arch
, bfd
*prev
));
2204 SDEF (boolean
, _bfd_find_nearest_line
,
2205 (bfd
*abfd
, struct sec
*section
,
2206 struct symbol_cache_entry
**symbols
,bfd_vma offset
,
2207 CONST
char **file
, CONST
char **func
, unsigned int *line
));
2208 SDEF (int, _bfd_stat_arch_elt
, (bfd
*, struct stat
*));
2210 SDEF (int, _bfd_sizeof_headers
, (bfd
*, boolean
));
2212 SDEF (void, _bfd_debug_info_start
, (bfd
*));
2213 SDEF (void, _bfd_debug_info_end
, (bfd
*));
2214 SDEF (void, _bfd_debug_info_accumulate
, (bfd
*, struct sec
*));
2217 Special entry points for gdb to swap in coff symbol table parts
2220 SDEF(void, _bfd_coff_swap_aux_in
,(
2227 SDEF(void, _bfd_coff_swap_sym_in
,(
2232 SDEF(void, _bfd_coff_swap_lineno_in
, (
2238 Special entry points for gas to swap coff parts
2241 SDEF(unsigned int, _bfd_coff_swap_aux_out
,(
2248 SDEF(unsigned int, _bfd_coff_swap_sym_out
,(
2253 SDEF(unsigned int, _bfd_coff_swap_lineno_out
,(
2258 SDEF(unsigned int, _bfd_coff_swap_reloc_out
,(
2263 SDEF(unsigned int, _bfd_coff_swap_filehdr_out
,(
2268 SDEF(unsigned int, _bfd_coff_swap_aouthdr_out
,(
2273 SDEF(unsigned int, _bfd_coff_swap_scnhdr_out
,(
2283 Returns a pointer to the transfer vector for the object target
2284 named target_name. If target_name is NULL, chooses the one in the
2285 environment variable GNUTARGET; if that is null or not defined then
2286 the first entry in the target list is chosen. Passing in the
2287 string "default" or setting the environment variable to "default"
2288 will cause the first entry in the target list to be returned,
2289 and "target_defaulted" will be set in the BFD. This causes
2290 @code{bfd_check_format} to loop over all the targets to find the one
2291 that matches the file being read.
2293 PROTO(bfd_target
*, bfd_find_target
,(CONST
char *, bfd
*));
2298 This function returns a freshly malloced NULL-terminated vector of the
2299 names of all the valid BFD targets. Do not modify the names
2301 PROTO(CONST
char **,bfd_target_list
,());
2308 /* *i bfd_check_format
2309 This routine is supplied a BFD and a format. It attempts to verify if
2310 the file attached to the BFD is indeed compatible with the format
2311 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
2314 If the BFD has been set to a specific @var{target} before the call,
2315 only the named target and format combination will be checked. If the
2316 target has not been set, or has been set to @code{default} then all
2317 the known target backends will be interrogated to determine a match.
2319 The function returns @code{true} on success, otherwise @code{false}
2320 with one of the following error codes:
2324 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
2326 @item system_call_error
2327 if an error occured during a read - even some file mismatches can
2328 cause system_call_errros
2329 @item file_not_recognised
2330 none of the backends recognised the file format
2331 @item file_ambiguously_recognized
2332 more than one backend recognised the file format.
2335 PROTO(boolean
, bfd_check_format
, (bfd
*abfd
, bfd_format format
));
2340 This function sets the file format of the supplied BFD to the format
2341 requested. If the target set in the BFD does not support the format
2342 requested, the format is illegal or the BFD is not open for writing
2343 than an error occurs.
2345 PROTO(boolean
,bfd_set_format
,(bfd
*, bfd_format
));
2349 *i bfd_format_string
2350 This function takes one argument, and enumerated type (bfd_format) and
2351 returns a pointer to a const string "invalid", "object", "archive",
2352 "core" or "unknown" depending upon the value of the enumeration.
2354 PROTO(CONST
char *, bfd_format_string
, (bfd_format
));