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_enum,
224 bfd_print_symbol_type_enum,
225 bfd_print_symbol_all_enum
226 } bfd_print_symbol_enum_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 coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in,
274 /* User program access to BFD facilities */
276 extern CONST short _bfd_host_big_endian;
277 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
281 /* Cast from const char * to char * so that caller can assign to
282 a char * without a warning. */
283 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
284 #define bfd_get_format(abfd) ((abfd)->format)
285 #define bfd_get_target(abfd) ((abfd)->xvec->name)
286 #define bfd_get_file_flags(abfd) ((abfd)->flags)
287 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
288 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
289 #define bfd_my_archive(abfd) ((abfd)->my_archive);
290 #define bfd_has_map(abfd) ((abfd)->has_armap)
291 #define bfd_header_twiddle_required(abfd) \
292 ((((abfd)->xvec->header_byteorder_big_p) \
293 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
295 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
296 #define bfd_usrdata(abfd) ((abfd)->usrdata)
298 #define bfd_get_start_address(abfd) ((abfd)->start_address)
299 #define bfd_get_symcount(abfd) ((abfd)->symcount)
300 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
301 #define bfd_count_sections(abfd) ((abfd)->section_count)
302 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
303 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
313 /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE */
319 This routine must be called before any other bfd function to initialize
320 magical internal data structures.
323 void EXFUN(bfd_init,(void));
330 Opens the file supplied (using @code{fopen}) with the target supplied, it
331 returns a pointer to the created BFD.
333 If NULL is returned then an error has occured.
334 Possible errors are no_memory, invalid_target or system_call error.
336 PROTO(bfd*, bfd_openr, (CONST char *filename,CONST char*target));
341 bfd_fdopenr is to bfd_fopenr much like fdopen is to fopen. It opens a BFD on
342 a file already described by the @var{fd} supplied.
344 Possible errors are no_memory, invalid_target and system_call error.
346 PROTO(bfd *, bfd_fdopenr,
347 (CONST char *filename, CONST char *target, int fd));
352 Creates a BFD, associated with file @var{filename}, using the file
353 format @var{target}, and returns a pointer to it.
355 Possible errors are system_call_error, no_memory, invalid_target.
357 PROTO(bfd *, bfd_openw, (CONST char *filename, CONST char *target));
362 This function closes a BFD. If the BFD was open for writing, then
363 pending operations are completed and the file written out and closed.
364 If the created file is executable, then @code{chmod} is called to mark
367 All memory attached to the BFD's obstacks is released.
369 @code{true} is returned if all is ok, otherwise @code{false}.
371 PROTO(boolean, bfd_close,(bfd *));
376 This routine creates a new BFD in the manner of @code{bfd_openw}, but without
377 opening a file. The new BFD takes the target from the target used by
378 @var{template}. The format is always set to @code{bfd_object}.
381 PROTO(bfd *, bfd_create, (CONST char *filename, bfd *template));
386 Return the number of bytes in the obstacks connected to the supplied
389 PROTO(bfd_size_type,bfd_alloc_size,(bfd *abfd));
398 These macros as used for reading and writing raw data in sections;
399 each access (except for bytes) is vectored through the target format
400 of the BFD and mangled accordingly. The mangling performs any
401 necessary endian translations and removes alignment restrictions.
403 #define bfd_put_8(abfd, val, ptr) \
404 (*((char *)ptr) = (char)val)
405 #define bfd_get_8(abfd, ptr) \
407 #define bfd_put_16(abfd, val, ptr) \
408 BFD_SEND(abfd, bfd_putx16, (val,ptr))
409 #define bfd_get_16(abfd, ptr) \
410 BFD_SEND(abfd, bfd_getx16, (ptr))
411 #define bfd_put_32(abfd, val, ptr) \
412 BFD_SEND(abfd, bfd_putx32, (val,ptr))
413 #define bfd_get_32(abfd, ptr) \
414 BFD_SEND(abfd, bfd_getx32, (ptr))
415 #define bfd_put_64(abfd, val, ptr) \
416 BFD_SEND(abfd, bfd_putx64, (val, ptr))
417 #define bfd_get_64(abfd, ptr) \
418 BFD_SEND(abfd, bfd_getx64, (ptr))
421 These macros have the same function as their @code{bfd_get_x}
422 bretherin, except that they are used for removing information for the
423 header records of object files. Believe it or not, some object files
424 keep their header records in big endian order, and their data in little
427 #define bfd_h_put_8(abfd, val, ptr) \
428 (*((char *)ptr) = (char)val)
429 #define bfd_h_get_8(abfd, ptr) \
431 #define bfd_h_put_16(abfd, val, ptr) \
432 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
433 #define bfd_h_get_16(abfd, ptr) \
434 BFD_SEND(abfd, bfd_h_getx16,(ptr))
435 #define bfd_h_put_32(abfd, val, ptr) \
436 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
437 #define bfd_h_get_32(abfd, ptr) \
438 BFD_SEND(abfd, bfd_h_getx32,(ptr))
439 #define bfd_h_put_64(abfd, val, ptr) \
440 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
441 #define bfd_h_get_64(abfd, ptr) \
442 BFD_SEND(abfd, bfd_h_getx64,(ptr))
445 /* The shape of a section struct:
451 The name of the section, the name isn't a copy, the pointer is
452 the same as that passed to bfd_make_section.
458 The next section in the list belonging to the BFD, or NULL.
464 The field flags contains attributes of the section. Some of these
465 flags are read in from the object file, and some are synthesized from
474 #define SEC_NO_FLAGS 0x000
477 Tells the OS to allocate space for this section when loaded.
478 This would clear for a section containing debug information only.
481 #define SEC_ALLOC 0x001
484 Tells the OS to load the section from the file when loading.
485 This would be clear for a .bss section
488 #define SEC_LOAD 0x002
491 The section contains data still to be relocated, so there will be some
492 relocation information too.
495 #define SEC_RELOC 0x004
501 #define SEC_BALIGN 0x008
504 A signal to the OS that the section contains read only data.
507 #define SEC_READONLY 0x010
510 The section contains code only.
513 #define SEC_CODE 0x020
516 The section contains data only.
519 #define SEC_DATA 0x040
522 The section will reside in ROM.
525 #define SEC_ROM 0x080
528 The section contains constructor information. This section type is
529 used by the linker to create lists of constructors and destructors
530 used by @code{g++}. When a back end sees a symbol which should be used
531 in a constructor list, it creates a new section for the type of name
532 (eg @code{__CTOR_LIST__}), attaches the symbol to it and builds a
533 relocation. To build the lists of constructors, all the linker has to
534 to is catenate all the sections called @code{__CTOR_LIST__} and
535 relocte the data contained within - exactly the operations it would
536 peform on standard data.
539 #define SEC_CONSTRUCTOR 0x100
542 The section is a constuctor, and should be placed at the end of the ..
545 #define SEC_CONSTRUCTOR_TEXT 0x1100
549 #define SEC_CONSTRUCTOR_DATA 0x2100
553 #define SEC_CONSTRUCTOR_BSS 0x3100
557 The section has contents - a bss section could be
558 @code{SEC_ALLOC} | @code{SEC_HAS_CONTENTS}, a debug section could be
559 @code{SEC_HAS_CONTENTS}
562 #define SEC_HAS_CONTENTS 0x200
565 An instruction to the linker not to output sections containing
566 this flag even if they have information which would normally be written.
569 #define SEC_NEVER_LOAD 0x400
573 The base address of the section in the address space of the target.
579 The size of the section in bytes of the loaded section. This contains
580 a value even if the section has no contents (eg, the size of @code{.bss}).
586 If this section is going to be output, then this value is the
587 offset into the output section of the first byte in the input
588 section. Eg, if this was going to start at the 100th byte in the
589 output section, this value would be 100.
592 bfd_vma output_offset;
595 The output section through which to map on output.
598 struct sec *output_section;
601 The alignment requirement of the section, as an exponent - eg 3
605 unsigned int alignment_power;
608 If an input section, a pointer to a vector of relocation records for
609 the data in this section.
612 struct reloc_cache_entry *relocation;
615 If an output section, a pointer to a vector of pointers to
616 relocation records for the data in this section.
619 struct reloc_cache_entry **orelocation;
622 The number of relocation records in one of the above
625 unsigned reloc_count;
628 Which section is it 0..nth
634 Information below is back end specific - and not always used or
637 File position of section data
641 /* File position of relocation info
644 file_ptr rel_filepos;
647 File position of line data
650 file_ptr line_filepos;
653 Pointer to data for applications
660 struct lang_output_section *otheruserdata;
663 Attached line number information
667 /* Number of line number records
670 unsigned int lineno_count;
673 When a section is being output, this value changes as more
674 linenumbers are written out
677 file_ptr moving_line_filepos;
680 what the section number is in the target world
683 unsigned int target_index;
690 If this is a constructor section then here is a list of the
691 relocations created to relocate items within it.
694 struct relent_chain *constructor_chain;
697 The BFD which owns the section.
708 bfd_get_section_by_name
709 Runs through the provided @var{abfd} and returns the @code{asection}
710 who's name matches that provided, otherwise NULL. @xref{Sections}, for more information.
713 PROTO(asection *, bfd_get_section_by_name,
714 (bfd *abfd, CONST char *name));
719 This function creates a new empty section called @var{name} and attaches it
720 to the end of the chain of sections for the BFD supplied. An attempt to
721 create a section with a name which is already in use, returns the old
722 section by that name instead.
726 @item invalid_operation
727 If output has already started for this BFD.
729 If obstack alloc fails.
733 PROTO(asection *, bfd_make_section, (bfd *, CONST char *name));
737 bfd_set_section_flags
738 Attempts to set the attributes of the section named in the BFD
739 supplied to the value. Returns true on success, false on error.
740 Possible error returns are:
742 @item invalid operation
743 The section cannot have one or more of the attributes requested. For
744 example, a .bss section in @code{a.out} may not have the
745 @code{SEC_HAS_CONTENTS} field set.
749 PROTO(boolean, bfd_set_section_flags,
750 (bfd *, asection *, flagword));
754 bfd_map_over_sections
755 Calls the provided function @var{func} for each section attached to
756 the BFD @var{abfd}, passing @var{obj} as an argument. The function
757 will be called as if by
760 func(abfd, the_section, obj);
764 PROTO(void, bfd_map_over_sections,
765 (bfd *abfd, void (*func)(), PTR obj));
769 This is the prefered method for iterating over sections, an
770 alternative would be to use a loop:
774 for (p = abfd->sections; p != NULL; p = p->next)
779 Sets @var{section} to the size @var{val}. If the operation is ok, then
780 @code{true} is returned, else @code{false}.
782 Possible error returns:
784 @item invalid_operation
785 Writing has started to the BFD, so setting the size is invalid
789 PROTO(boolean, bfd_set_section_size,
790 (bfd *, asection *, bfd_size_type val));
794 bfd_set_section_contents
795 Sets the contents of the section @var{section} in BFD @var{abfd} to
796 the data starting in memory at @var{data}. The data is written to the
797 output section starting at offset @var{offset} for @var{count} bytes.
799 Normally @code{true} is returned, else @code{false}. Possible error
803 The output section does not have the @code{SEC_HAS_CONTENTS}
804 attribute, so nothing can be written to it.
805 @item and some more too
807 This routine is front end to the back end function @code{_bfd_set_section_contents}.
810 PROTO(boolean, bfd_set_section_contents,
815 bfd_size_type count));
819 bfd_get_section_contents
820 This function reads data from @var{section} in BFD @var{abfd} into
821 memory starting at @var{location}. The data is read at an offset of
822 @var{offset} from the start of the input section, and is read for
825 If the contents of a constuctor with the @code{SEC_CONSTUCTOR} flag
826 set are requested, then the @var{location} is filled with zeroes.
828 If no errors occur, @code{true} is returned, else @code{false}.
836 PROTO(boolean, bfd_get_section_contents,
837 (bfd *abfd, asection *section, PTR location,
838 file_ptr offset, bfd_size_type count));
847 This enum gives the object file's CPU
848 architecture, in a global sense. E.g. what processor family does it
849 belong to? There is another field, which indicates what processor
850 within the family is in use. The machine gives a number which
851 distingushes different versions of the architecture, containing for
852 example 2 and 3 for Intel i960 KA and i960 KB, and 68020 and 68030 for
853 Motorola 68020 and 68030.
856 enum bfd_architecture
858 bfd_arch_unknown, /* File arch not known */
859 bfd_arch_obscure, /* Arch known, not one of these */
860 bfd_arch_m68k, /* Motorola 68xxx */
861 bfd_arch_vax, /* DEC Vax */
862 bfd_arch_i960, /* Intel 960 */
863 /* The order of the following is important.
864 lower number indicates a machine type that
865 only accepts a subset of the instructions
866 available to machines with higher numbers.
867 The exception is the "ca", which is
868 incompatible with all other machines except
871 #define bfd_mach_i960_core 1
872 #define bfd_mach_i960_ka_sa 2
873 #define bfd_mach_i960_kb_sb 3
874 #define bfd_mach_i960_mc 4
875 #define bfd_mach_i960_xa 5
876 #define bfd_mach_i960_ca 6
878 bfd_arch_a29k, /* AMD 29000 */
879 bfd_arch_sparc, /* SPARC */
880 bfd_arch_mips, /* MIPS Rxxxx */
881 bfd_arch_i386, /* Intel 386 */
882 bfd_arch_ns32k, /* National Semiconductor 32xxx */
883 bfd_arch_tahoe, /* CCI/Harris Tahoe */
884 bfd_arch_i860, /* Intel 860 */
885 bfd_arch_romp, /* IBM ROMP RS/6000 */
886 bfd_arch_alliant, /* Alliant */
887 bfd_arch_convex, /* Convex */
888 bfd_arch_m88k, /* Motorola 88xxx */
889 bfd_arch_pyramid, /* Pyramid Technology */
890 bfd_arch_h8300, /* Hitachi H8/300 */
898 This structure contains information on architectures.
900 typedef int bfd_reloc_code_enum_type;
902 typedef struct bfd_arch_info_struct
905 int bits_per_address;
907 enum bfd_architecture arch;
910 CONST char *printable_name;
911 /* true if this is the default machine for the architecture */
913 CONST struct bfd_arch_info_struct * EXFUN((*compatible),(CONST struct bfd_arch_info_struct *a,
914 CONST struct bfd_arch_info_struct *b));
917 boolean EXFUN((*scan),(CONST struct bfd_arch_info_struct *,CONST char *));
918 unsigned int EXFUN((*disassemble),(bfd_vma addr, CONST char *data,
920 CONST struct reloc_howto_struct *EXFUN((*reloc_type_lookup), (CONST struct
921 bfd_arch_info_struct *,
922 bfd_reloc_code_enum_type code));
924 struct bfd_arch_info_struct *next;
926 } bfd_arch_info_struct_type;
931 Return a printable string representing the architecture and machine
932 from the pointer to the arch info structure
935 CONST char *EXFUN(bfd_printable_name,(bfd *abfd));
940 This routine is provided with a string and tries to work out if bfd
941 supports any cpu which could be described with the name provided. The
942 routine returns a pointer to an arch_info structure if a machine is
943 found, otherwise NULL.
946 bfd_arch_info_struct_type *EXFUN(bfd_scan_arch,(CONST char *));
950 bfd_arch_get_compatible
951 This routine is used to determine whether two BFDs' architectures and
952 machine types are compatible. It calculates the lowest common
953 denominator between the two architectures and machine types implied by
954 the BFDs and returns a pointer to an arch_info structure describing
955 the compatible machine.
958 CONST bfd_arch_info_struct_type *EXFUN(bfd_arch_get_compatible,
967 void EXFUN(bfd_set_arch_info,(bfd *, bfd_arch_info_struct_type *));
973 Returns the enumerated type which describes the supplied bfd's
977 enum bfd_architecture EXFUN(bfd_get_arch, (bfd *abfd));
983 Returns the long type which describes the supplied bfd's
987 unsigned long EXFUN(bfd_get_mach, (bfd *abfd));
991 bfd_arch_bits_per_byte
993 Returns the number of bits in one of the architectures bytes
996 unsigned int EXFUN(bfd_arch_bits_per_byte, (bfd *abfd));
1000 bfd_arch_bits_per_address
1002 Returns the number of bits in one of the architectures addresses
1005 unsigned int EXFUN(bfd_arch_bits_per_address, (bfd *abfd));
1012 bfd_arch_info_struct_type * EXFUN(bfd_get_arch_info,(bfd *));
1019 bfd_arch_info_struct_type * EXFUN(bfd_lookup_arch,(enum
1020 bfd_architecture arch,long machine));
1024 Look for the architecure info struct which matches the arguments
1025 given. A machine of 0 will match the machine/architecture structure which
1026 marks itself as the default.
1028 bfd_printable_arch_mach
1029 Return a printable string representing the architecture and machine
1032 NB. The use of this routine is depreciated.
1035 PROTO(CONST char *,bfd_printable_arch_mach,
1036 (enum bfd_architecture arch, unsigned long machine));
1042 /* bfd_perform_relocation
1043 The relocation routine returns as a status an enumerated type:
1046 typedef enum bfd_reloc_status {
1047 /* No errors detected
1053 The relocation was performed, but there was an overflow.
1059 The address to relocate was not within the section supplied
1062 bfd_reloc_outofrange,
1065 Used by special functions
1074 bfd_reloc_notsupported,
1077 Unsupported relocation size requested.
1083 The symbol to relocate against was undefined.
1086 bfd_reloc_undefined,
1089 The relocation was performed, but may not be ok - presently generated
1090 only when linking i960 coff files with i960 b.out symbols.
1095 bfd_reloc_status_enum_type;
1100 typedef struct reloc_cache_entry
1104 A pointer into the canonical table of pointers
1107 struct symbol_cache_entry **sym_ptr_ptr;
1113 rawdata_offset address;
1116 addend for relocation value
1122 if sym is null this is the section
1125 struct sec *section;
1128 Pointer to how to perform the required relocation
1131 CONST struct reloc_howto_struct *howto;
1137 The @code{reloc_howto_type} is a structure which contains all the
1138 information that BFD needs to know to tie up a back end's data.
1141 typedef CONST struct reloc_howto_struct
1143 /* The type field has mainly a documetary use - the back end can to what
1144 it wants with it, though the normally the back end's external idea of
1145 what a reloc number would be would be stored in this field. For
1146 example, the a PC relative word relocation in a coff environment would
1147 have the type 023 - because that's what the outside world calls a
1154 The value the final relocation is shifted right by. This drops
1155 unwanted data from the relocation.
1158 unsigned int rightshift;
1161 The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
1171 unsigned int bitsize;
1174 Notes that the relocation is relative to the location in the data
1175 section of the addend. The relocation function will subtract from the
1176 relocation value the address of the location being relocated.
1179 boolean pc_relative;
1185 unsigned int bitpos;
1194 Causes the relocation routine to return an error if overflow is
1195 detected when relocating.
1198 boolean complain_on_overflow;
1201 If this field is non null, then the supplied function is called rather
1202 than the normal function. This allows really strange relocation
1203 methods to be accomodated (eg, i960 callj instructions).
1206 bfd_reloc_status_enum_type (*special_function)();
1209 The textual name of the relocation type.
1215 When performing a partial link, some formats must modify the
1216 relocations rather than the data - this flag signals this.
1219 boolean partial_inplace;
1222 The src_mask is used to select what parts of the read in data are to
1223 be used in the relocation sum. Eg, if this was an 8 bit bit of data
1224 which we read and relocated, this would be 0x000000ff. When we have
1225 relocs which have an addend, such as sun4 extended relocs, the value
1226 in the offset part of a relocating field is garbage so we never use
1227 it. In this case the mask would be 0x00000000.
1231 /* The dst_mask is what parts of the instruction are replaced into the
1232 instruction. In most cases src_mask == dst_mask, except in the above
1233 special case, where dst_mask would be 0x000000ff, and src_mask would
1240 When some formats create PC relative instructions, they leave the
1241 value of the pc of the place being relocated in the offset slot of the
1242 instruction, so that a PC relative relocation can be made just by
1243 adding in an ordinary offset (eg sun3 a.out). Some formats leave the
1244 displacement part of an instruction empty (eg m88k bcs), this flag
1248 boolean pcrel_offset;
1254 The HOWTO define is horrible and will go away.
1256 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1257 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1260 And will be replaced with the totally magic way. But for the moment,
1261 we are compatible, so do it this way..
1264 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,false)
1267 Helper routine to turn a symbol into a relocation value.
1271 #define HOWTO_PREPARE(relocation, symbol) \
1273 if (symbol != (asymbol *)NULL) { \
1274 if (symbol->flags & BSF_FORT_COMM) { \
1278 relocation = symbol->value; \
1281 if (symbol->section != (asection *)NULL) { \
1282 relocation += symbol->section->output_section->vma + \
1283 symbol->section->output_offset; \
1290 typedef unsigned char bfd_byte;
1292 typedef struct relent_chain {
1294 struct relent_chain *next;
1299 If an output_bfd is supplied to this function the generated image
1300 will be relocatable, the relocations are copied to the output file
1301 after they have been changed to reflect the new state of the world.
1302 There are two ways of reflecting the results of partial linkage in an
1303 output file; by modifying the output data in place, and by modifying
1304 the relocation record. Some native formats (eg basic a.out and basic
1305 coff) have no way of specifying an addend in the relocation type, so
1306 the addend has to go in the output data. This is no big deal since in
1307 these formats the output data slot will always be big enough for the
1308 addend. Complex reloc types with addends were invented to solve just
1311 PROTO(bfd_reloc_status_enum_type,
1312 bfd_perform_relocation,
1314 arelent *reloc_entry,
1316 asection *input_section,
1321 bfd_reloc_code_enum_type
1328 16 bits wide, simple reloc
1334 8 bits wide, but used to form an address like 0xffnn
1346 8 bits wide, pc relative
1350 } bfd_reloc_code_enum_real_type;
1354 bfd_reloc_type_lookup
1355 This routine returns a pointer to a howto struct which when invoked,
1356 will perform the supplied relocation on data from the architecture
1359 [Note] This function will go away.
1362 PROTO(CONST struct reloc_howto_struct *,
1363 bfd_reloc_type_lookup,
1364 (CONST bfd_arch_info_struct_type *arch, bfd_reloc_code_enum_type code));
1370 /* @subsection typedef asymbol
1371 An @code{asymbol} has the form:
1374 typedef struct symbol_cache_entry
1376 /* A pointer to the BFD which owns the symbol. This information is
1377 necessary so that a back end can work out what additional (invisible to
1378 the application writer) information is carried with the symbol.
1381 struct _bfd *the_bfd;
1384 The text of the symbol. The name is left alone, and not copied - the
1385 application may not alter it.
1391 The value of the symbol.
1397 Attributes of a symbol:
1400 #define BSF_NO_FLAGS 0x00
1403 The symbol has local scope; @code{static} in @code{C}. The value is
1404 the offset into the section of the data.
1407 #define BSF_LOCAL 0x01
1410 The symbol has global scope; initialized data in @code{C}. The value
1411 is the offset into the section of the data.
1414 #define BSF_GLOBAL 0x02
1420 #define BSF_IMPORT 0x04
1423 The symbol has global scope, and is exported. The value is the offset
1424 into the section of the data.
1427 #define BSF_EXPORT 0x08
1430 The symbol is undefined. @code{extern} in @code{C}. The value has no meaning.
1433 #define BSF_UNDEFINED 0x10
1436 The symbol is common, initialized to zero; default in @code{C}. The
1437 value is the size of the object in bytes.
1440 #define BSF_FORT_COMM 0x20
1443 A normal @code{C} symbol would be one of:
1444 @code{BSF_LOCAL}, @code{BSF_FORT_COMM}, @code{BSF_UNDEFINED} or @code{BSF_EXPORT|BSD_GLOBAL}
1446 The symbol is a debugging record. The value has an arbitary meaning.
1449 #define BSF_DEBUGGING 0x40
1452 The symbol has no section attached, any value is the actual value and
1453 is not a relative offset to a section.
1456 #define BSF_ABSOLUTE 0x80
1462 #define BSF_KEEP 0x10000
1463 #define BSF_KEEP_G 0x80000
1469 #define BSF_WEAK 0x100000
1470 #define BSF_CTOR 0x200000
1471 #define BSF_FAKE 0x400000
1474 The symbol used to be a common symbol, but now it is allocated.
1477 #define BSF_OLD_COMMON 0x800000
1480 The default value for common data.
1483 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1486 In some files the type of a symbol sometimes alters its location
1487 in an output file - ie in coff a @code{ISFCN} symbol which is also @code{C_EXT}
1488 symbol appears where it was declared and not at the end of a section.
1489 This bit is set by the target BFD part to convey this information.
1492 #define BSF_NOT_AT_END 0x40000
1495 Signal that the symbol is the label of constructor section.
1498 #define BSF_CONSTRUCTOR 0x1000000
1501 Signal that the symbol is a warning symbol. If the symbol is a warning
1502 symbol, then the value field (I know this is tacky) will point to the
1503 asymbol which when referenced will cause the warning.
1506 #define BSF_WARNING 0x2000000
1509 Signal that the symbol is indirect. The value of the symbol is a
1510 pointer to an undefined asymbol which contains the name to use
1514 #define BSF_INDIRECT 0x4000000
1521 A pointer to the section to which this symbol is relative, or 0 if the
1522 symbol is absolute or undefined. Note that it is not sufficient to set
1523 this location to 0 to mark a symbol as absolute - the flag
1524 @code{BSF_ABSOLUTE} must be set also.
1527 struct sec *section;
1530 Back end special data. This is being phased out in favour of making
1539 get_symtab_upper_bound
1540 Returns the number of bytes required in a vector of pointers to
1541 @code{asymbols} for all the symbols in the supplied BFD, including a
1542 terminal NULL pointer. If there are no symbols in the BFD, then 0 is
1545 #define get_symtab_upper_bound(abfd) \
1546 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1550 bfd_canonicalize_symtab
1551 Supplied a BFD and a pointer to an uninitialized vector of pointers.
1552 This reads in the symbols from the BFD, and fills in the table with
1553 pointers to the symbols, and a trailing NULL. The routine returns the
1554 actual number of symbol pointers not including the NULL.
1557 #define bfd_canonicalize_symtab(abfd, location) \
1558 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1563 Provided a table of pointers to to symbols and a count, writes to the
1564 output BFD the symbols when closed.
1567 PROTO(boolean, bfd_set_symtab, (bfd *, asymbol **, unsigned int ));
1571 bfd_print_symbol_vandf
1572 Prints the value and flags of the symbol supplied to the stream file.
1575 PROTO(void, bfd_print_symbol_vandf, (PTR file, asymbol *symbol));
1579 bfd_make_empty_symbol
1580 This function creates a new @code{asymbol} structure for the BFD, and
1581 returns a pointer to it.
1583 This routine is necessary, since each back end has private information
1584 surrounding the @code{asymbol}. Building your own @code{asymbol} and
1585 pointing to it will not create the private information, and will cause
1588 #define bfd_make_empty_symbol(abfd) \
1589 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1592 /* @section @code{typedef bfd}
1594 A BFD is has type @code{bfd}; objects of this type are the cornerstone
1595 of any application using @code{libbfd}. References though the BFD and
1596 to data in the BFD give the entire BFD functionality.
1598 Here is the struct used to define the type @code{bfd}. This contains
1599 the major data about the file, and contains pointers to the rest of
1605 /* The filename the application opened the BFD with.
1608 CONST char *filename;
1611 A pointer to the target jump table.
1614 struct bfd_target *xvec;
1618 To avoid dragging too many header files into every file that
1619 includes @file{bfd.h}, IOSTREAM has been declared as a "char *", and MTIME
1620 as a "long". Their correct types, to which they are cast when used,
1621 are "FILE *" and "time_t".
1623 The iostream is the result of an fopen on the filename.
1629 Is the file being cached @xref{File Caching}.
1635 Marks whether there was a default target specified when the BFD was
1636 opened. This is used to select what matching algorithm to use to chose
1640 boolean target_defaulted;
1643 The caching routines use these to maintain a least-recently-used list of
1644 BFDs (@pxref{File Caching}).
1647 struct _bfd *lru_prev, *lru_next;
1650 When a file is closed by the caching routines, BFD retains state
1651 information on the file here:
1660 boolean opened_once;
1665 /* File modified time
1671 Reserved for an unimplemented file locking extension.
1677 The format which belongs to the BFD.
1683 The direction the BFD was opened with
1686 enum bfd_direction {no_direction = 0,
1688 write_direction = 2,
1689 both_direction = 3} direction;
1692 Format_specific flags
1698 Currently my_archive is tested before adding origin to anything. I
1699 believe that this can become always an add of origin, with origin set
1700 to 0 for non archive files.
1706 Remember when output has begun, to stop strange things happening.
1709 boolean output_has_begun;
1712 Pointer to linked list of sections
1715 struct sec *sections;
1718 The number of sections
1721 unsigned int section_count;
1724 Stuff only useful for object files:
1728 bfd_vma start_address;
1729 /* Used for input and output
1732 unsigned int symcount;
1733 /* Symbol table for output BFD
1736 struct symbol_cache_entry **outsymbols;
1739 Pointer to structure which contains architecture information
1742 struct bfd_arch_info_struct *arch_info;
1745 Stuff only useful for archives:
1749 struct _bfd *my_archive;
1751 struct _bfd *archive_head;
1755 Used by the back end to hold private data.
1761 Used by the application to hold private data
1767 Where all the allocated stuff under this BFD goes (@pxref{Memory Usage}).
1770 struct obstack memory;
1775 bfd_set_start_address
1777 Marks the entry point of an output BFD. Returns @code{true} on
1778 success, @code{false} otherwise.
1781 PROTO(boolean, bfd_set_start_address,(bfd *, bfd_vma));
1787 Return cached file modification time (e.g. as read from archive header
1788 for archive members, or from file system if we have been called
1789 before); else determine modify time, cache it, and return it.
1792 PROTO(long, bfd_get_mtime, (bfd *));
1800 #define bfd_sizeof_headers(abfd, reloc) \
1801 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1803 #define bfd_find_nearest_line(abfd, section, symbols, offset, filename_ptr, func, line_ptr) \
1804 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, section, symbols, offset, filename_ptr, func, line_ptr))
1806 #define bfd_debug_info_start(abfd) \
1807 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1809 #define bfd_debug_info_end(abfd) \
1810 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1812 #define bfd_debug_info_accumulate(abfd, section) \
1813 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1815 #define bfd_stat_arch_elt(abfd, stat) \
1816 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1818 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1819 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1821 #define bfd_coff_swap_sym_in(a,e,i) \
1822 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1824 #define bfd_coff_swap_lineno_in(a,e,i) \
1825 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1827 #define bfd_set_arch_mach(abfd, arch, mach)\
1828 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1834 /* bfd_get_next_mapent
1837 PROTO(symindex, bfd_get_next_mapent, (bfd *, symindex, carsym **));
1841 bfd_set_archive_head
1843 Used whilst processing archives. Sets the head of the chain of BFDs
1844 contained in an archive to @var{new_head}. (see chapter on archives)
1847 PROTO(boolean, bfd_set_archive_head, (bfd *output, bfd *new_head));
1851 bfd_get_elt_at_index
1852 Return the sub bfd contained within the archive at archive index n.
1855 PROTO(bfd *, bfd_get_elt_at_index, (bfd *, int));
1859 bfd_openr_next_archived_file
1860 Initially provided a BFD containing an archive and NULL, opens a BFD
1861 on the first contained element and returns that. Subsequent calls to
1862 bfd_openr_next_archived_file should pass the archive and the previous
1863 return value to return a created BFD to the next contained element.
1864 NULL is returned when there are no more.
1867 PROTO(bfd*, bfd_openr_next_archived_file,
1868 (bfd *archive, bfd *previous));
1875 /* bfd_core_file_failing_command
1876 Returns a read-only string explaining what program was running when
1877 it failed and produced the core file being read
1880 PROTO(CONST char *, bfd_core_file_failing_command, (bfd *));
1884 bfd_core_file_failing_signal
1885 Returns the signal number which caused the core dump which generated
1886 the file the BFD is attached to.
1889 PROTO(int, bfd_core_file_failing_signal, (bfd *));
1893 core_file_matches_executable_p
1894 Returns @code{true} if the core file attached to @var{core_bfd} was
1895 generated by a run of the executable file attached to @var{exec_bfd},
1896 or else @code{false}.
1898 PROTO(boolean, core_file_matches_executable_p,
1899 (bfd *core_bfd, bfd *exec_bfd));
1907 @subsection bfd_target
1908 This structure contains everything that BFD knows about a target.
1909 It includes things like its byte order, name, what routines to call
1910 to do various operations, etc.
1912 Every BFD points to a target structure with its "xvec" member.
1914 Shortcut for declaring fields which are prototyped function pointers,
1915 while avoiding anguish on compilers that don't support protos.
1918 #define SDEF(ret, name, arglist) \
1919 PROTO(ret,(*name),arglist)
1920 #define SDEF_FMT(ret, name, arglist) \
1921 PROTO(ret,(*name[bfd_type_end]),arglist)
1924 These macros are used to dispatch to functions through the bfd_target
1925 vector. They are used in a number of macros further down in @file{bfd.h}, and
1926 are also used when calling various routines by hand inside the BFD
1927 implementation. The "arglist" argument must be parenthesized; it
1928 contains all the arguments to the called function.
1931 #define BFD_SEND(bfd, message, arglist) \
1932 ((*((bfd)->xvec->message)) arglist)
1935 For operations which index on the BFD format
1938 #define BFD_SEND_FMT(bfd, message, arglist) \
1939 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1942 This is the struct which defines the type of BFD this is. The
1943 "xvec" member of the struct @code{bfd} itself points here. Each module
1944 that implements access to a different target under BFD, defines
1947 FIXME, these names should be rationalised with the names of the
1948 entry points which call them. Too bad we can't have one macro to
1952 typedef struct bfd_target
1956 identifies the kind of target, eg SunOS4, Ultrix, etc
1962 The "flavour" of a back end is a general indication about the contents
1966 enum target_flavour_enum {
1967 bfd_target_aout_flavour_enum,
1968 bfd_target_coff_flavour_enum,
1969 bfd_target_elf_flavour_enum,
1970 bfd_target_ieee_flavour_enum,
1971 bfd_target_oasys_flavour_enum,
1972 bfd_target_srec_flavour_enum} flavour;
1975 The order of bytes within the data area of a file.
1978 boolean byteorder_big_p;
1981 The order of bytes within the header parts of a file.
1984 boolean header_byteorder_big_p;
1987 This is a mask of all the flags which an executable may have set -
1988 from the set @code{NO_FLAGS}, @code{HAS_RELOC}, ...@code{D_PAGED}.
1991 flagword object_flags;
1994 This is a mask of all the flags which a section may have set - from
1995 the set @code{SEC_NO_FLAGS}, @code{SEC_ALLOC}, ...@code{SET_NEVER_LOAD}.
1998 flagword section_flags;
2001 The pad character for filenames within an archive header.
2007 The maximum number of characters in an archive header.
2010 unsigned short ar_max_namelen;
2013 The minimum alignment restriction for any section.
2016 unsigned int align_power_min;
2019 Entries for byte swapping for data. These are different to the other
2020 entry points, since they don't take BFD as first arg. Certain other handlers
2024 SDEF (bfd_vma, bfd_getx64, (bfd_byte *));
2025 SDEF (void, bfd_putx64, (bfd_vma, bfd_byte *));
2026 SDEF (bfd_vma, bfd_getx32, (bfd_byte *));
2027 SDEF (void, bfd_putx32, (bfd_vma, bfd_byte *));
2028 SDEF (bfd_vma, bfd_getx16, (bfd_byte *));
2029 SDEF (void, bfd_putx16, (bfd_vma, bfd_byte *));
2032 Byte swapping for the headers
2035 SDEF (bfd_vma, bfd_h_getx64, (bfd_byte *));
2036 SDEF (void, bfd_h_putx64, (bfd_vma, bfd_byte *));
2037 SDEF (bfd_vma, bfd_h_getx32, (bfd_byte *));
2038 SDEF (void, bfd_h_putx32, (bfd_vma, bfd_byte *));
2039 SDEF (bfd_vma, bfd_h_getx16, (bfd_byte *));
2040 SDEF (void, bfd_h_putx16, (bfd_vma, bfd_byte *));
2043 Format dependent routines, these turn into vectors of entry points
2044 within the target vector structure; one for each format to check.
2046 Check the format of a file being read. Return bfd_target * or zero.
2049 SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *));
2052 Set the format of a file being written.
2055 SDEF_FMT (boolean, _bfd_set_format, (bfd *));
2058 Write cached information into a file being written, at bfd_close.
2061 SDEF_FMT (boolean, _bfd_write_contents, (bfd *));
2064 The following functions are defined in @code{JUMP_TABLE}. The idea is
2065 that the back end writer of @code{foo} names all the routines
2066 @code{foo_}@var{entry_point}, @code{JUMP_TABLE} will built the entries
2067 in this structure in the right order.
2069 Core file entry points
2072 SDEF (char *, _core_file_failing_command, (bfd *));
2073 SDEF (int, _core_file_failing_signal, (bfd *));
2074 SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *));
2077 Archive entry points
2080 SDEF (boolean, _bfd_slurp_armap, (bfd *));
2081 SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *));
2082 SDEF (void, _bfd_truncate_arname, (bfd *, CONST char *, char *));
2083 SDEF (boolean, write_armap, (bfd *arch,
2084 unsigned int elength,
2093 SDEF (boolean, _close_and_cleanup, (bfd *));
2094 SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR,
2095 file_ptr, bfd_size_type));
2096 SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR,
2097 file_ptr, bfd_size_type));
2098 SDEF (boolean, _new_section_hook, (bfd *, sec_ptr));
2101 Symbols and reloctions
2104 SDEF (unsigned int, _get_symtab_upper_bound, (bfd *));
2105 SDEF (unsigned int, _bfd_canonicalize_symtab,
2106 (bfd *, struct symbol_cache_entry **));
2107 SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr));
2108 SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **,
2109 struct symbol_cache_entry**));
2110 SDEF (struct symbol_cache_entry *, _bfd_make_empty_symbol, (bfd *));
2111 SDEF (void, _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry *,
2112 bfd_print_symbol_enum_type));
2113 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2114 SDEF (alent *, _get_lineno, (bfd *, struct symbol_cache_entry *));
2116 SDEF (boolean, _bfd_set_arch_mach, (bfd *, enum bfd_architecture,
2119 SDEF (bfd *, openr_next_archived_file, (bfd *arch, bfd *prev));
2120 SDEF (boolean, _bfd_find_nearest_line,
2121 (bfd *abfd, struct sec *section,
2122 struct symbol_cache_entry **symbols,bfd_vma offset,
2123 CONST char **file, CONST char **func, unsigned int *line));
2124 SDEF (int, _bfd_stat_arch_elt, (bfd *, struct stat *));
2126 SDEF (int, _bfd_sizeof_headers, (bfd *, boolean));
2128 SDEF (void, _bfd_debug_info_start, (bfd *));
2129 SDEF (void, _bfd_debug_info_end, (bfd *));
2130 SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec *));
2133 Special entry points for gdb to swap in coff symbol table parts
2136 SDEF(void, _bfd_coff_swap_aux_in,(
2143 SDEF(void, _bfd_coff_swap_sym_in,(
2148 SDEF(void, _bfd_coff_swap_lineno_in, (
2158 Returns a pointer to the transfer vector for the object target
2159 named target_name. If target_name is NULL, chooses the one in the
2160 environment variable GNUTARGET; if that is null or not defined then
2161 the first entry in the target list is chosen. Passing in the
2162 string "default" or setting the environment variable to "default"
2163 will cause the first entry in the target list to be returned,
2164 and "target_defaulted" will be set in the BFD. This causes
2165 @code{bfd_check_format} to loop over all the targets to find the one
2166 that matches the file being read.
2168 PROTO(bfd_target *, bfd_find_target,(CONST char *, bfd *));
2173 This function returns a freshly malloced NULL-terminated vector of the
2174 names of all the valid BFD targets. Do not modify the names
2176 PROTO(CONST char **,bfd_target_list,());
2183 /* *i bfd_check_format
2184 This routine is supplied a BFD and a format. It attempts to verify if
2185 the file attached to the BFD is indeed compatible with the format
2186 specified (ie, one of @code{bfd_object}, @code{bfd_archive} or
2189 If the BFD has been set to a specific @var{target} before the call,
2190 only the named target and format combination will be checked. If the
2191 target has not been set, or has been set to @code{default} then all
2192 the known target backends will be interrogated to determine a match.
2194 The function returns @code{true} on success, otherwise @code{false}
2195 with one of the following error codes:
2199 if @code{format} is not one of @code{bfd_object}, @code{bfd_archive}
2201 @item system_call_error
2202 if an error occured during a read - even some file mismatches can
2203 cause system_call_errros
2204 @item file_not_recognised
2205 none of the backends recognised the file format
2206 @item file_ambiguously_recognized
2207 more than one backend recognised the file format.
2210 PROTO(boolean, bfd_check_format, (bfd *abfd, bfd_format format));
2215 This function sets the file format of the supplied BFD to the format
2216 requested. If the target set in the BFD does not support the format
2217 requested, the format is illegal or the BFD is not open for writing
2218 than an error occurs.
2220 PROTO(boolean,bfd_set_format,(bfd *, bfd_format));
2224 *i bfd_format_string
2225 This function takes one argument, and enumerated type (bfd_format) and
2226 returns a pointer to a const string "invalid", "object", "archive",
2227 "core" or "unknown" depending upon the value of the enumeration.
2229 PROTO(CONST char *, bfd_format_string, (bfd_format));