1 /* Main header file for the bfd library -- portable access to object files.
2 ==> The bfd.h file is generated from bfd-in.h and various .c files; if you
3 ==> change it, your changes will probably be lost.
4 Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
5 Contributed by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
23 /* bfd.h -- The only header file required by users of the bfd library
25 The bfd.h file is generated from bfd-in.h and various .c files; if you
26 change it, your changes will probably be lost.
28 All the prototypes and definitions following the comment "THE FOLLOWING
29 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
30 BFD. If you change it, someone oneday will extract it from the source
31 again, and your changes will be lost. To save yourself from this bind,
32 change the definitions in the source in the bfd directory. Type "make
33 docs" and then "make headers" in that directory, and magically this file
34 will change to reflect your changes.
36 If you don't have the tools to perform the extraction, then you are
37 safe from someone on your system trampling over your header files.
38 You should still maintain the equivalence between the source and this
39 file though; every change you make to the .c file should be reflected
42 #ifndef __BFD_H_SEEN__
43 #define __BFD_H_SEEN__
48 #define BFD_VERSION "2.0"
50 /* forward declaration */
51 typedef struct _bfd bfd;
53 /* General rules: functions which are boolean return true on success
54 and false on failure (unless they're a predicate). -- bfd.doc */
55 /* I'm sure this is going to break something and someone is going to
56 force me to change it. */
57 /* typedef enum boolean {false, true} boolean; */
58 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */
59 typedef enum bfd_boolean {false, true} boolean;
61 /* A pointer to a position in a file. */
62 /* FIXME: This should be using off_t from <sys/types.h>.
63 For now, try to avoid breaking stuff by not including <sys/types.h> here.
64 This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
65 Probably the best long-term answer is to avoid using file_ptr AND off_t
66 in this header file, and to handle this in the BFD implementation
67 rather than in its interface. */
68 /* typedef off_t file_ptr; */
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 */
109 #define NO_FLAGS 0x00
110 #define HAS_RELOC 0x01
112 #define HAS_LINENO 0x04
113 #define HAS_DEBUG 0x08
114 #define HAS_SYMS 0x10
115 #define HAS_LOCALS 0x20
118 #define D_PAGED 0x100
119 #define BFD_IS_RELAXABLE 0x200
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->vma)
147 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
148 #define bfd_asymbol_name(x) ((x)->name)
149 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
150 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
151 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
153 /* This is a type pun with struct ranlib on purpose! */
154 typedef struct carsym {
156 file_ptr file_offset; /* look here to find the file */
157 } carsym; /* to make these you call a carsymogen */
160 /* Used in generating armaps. Perhaps just a forward definition would do? */
161 struct orl { /* output ranlib */
162 char **name; /* symbol name */
163 file_ptr pos; /* bfd* or file position */
164 int namidx; /* index into string table */
169 /* Linenumber stuff */
170 typedef struct lineno_cache_entry {
171 unsigned int line_number; /* Linenumber from start of function*/
173 struct symbol_cache_entry *sym; /* Function name */
174 unsigned long offset; /* Offset into section */
178 /* object and core file sections */
181 #define align_power(addr, align) \
182 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
184 typedef struct sec *sec_ptr;
186 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
187 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
188 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
189 #define bfd_section_name(bfd, ptr) ((ptr)->name)
190 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
191 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
192 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
193 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
194 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
196 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
198 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), ((ptr)->user_set_vma = true), true)
199 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
200 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
202 typedef struct stat stat_type;
204 /** Error handling */
206 typedef enum bfd_error {
207 no_error = 0, system_call_error, invalid_target,
208 wrong_format, invalid_operation, no_memory,
209 no_symbols, no_relocation_info,
210 no_more_archived_files, malformed_archive,
211 symbol_not_found, file_not_recognized,
212 file_ambiguously_recognized, no_contents,
213 bfd_error_nonrepresentable_section,
214 no_debug_section, bad_value,
215 invalid_error_code} bfd_ec;
217 extern bfd_ec bfd_error;
218 struct reloc_cache_entry;
222 typedef struct bfd_error_vector {
223 void (* nonrepresentable_section ) PARAMS ((CONST bfd *CONST abfd,
224 CONST char *CONST name));
225 void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
226 CONST struct bfd_seclet *sec));
227 void (* reloc_value_truncated) PARAMS ((CONST struct
228 reloc_cache_entry *rel,
229 struct bfd_seclet *sec));
231 void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
232 CONST struct bfd_seclet *sec));
234 } bfd_error_vector_type;
236 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
237 void bfd_perror PARAMS ((CONST char *message));
240 typedef enum bfd_print_symbol
242 bfd_print_symbol_name,
243 bfd_print_symbol_more,
244 bfd_print_symbol_all,
245 bfd_print_symbol_nm /* Pretty format suitable for nm program. */
246 } bfd_print_symbol_type;
250 /* The code that implements targets can initialize a jump table with this
251 macro. It must name all its routines the same way (a prefix plus
252 the standard routine suffix), or it must #define the routines that
253 are not so named, before calling JUMP_TABLE in the initializer. */
255 /* Semi-portable string concatenation in cpp */
258 #define CAT(a,b) a##b
260 #define CAT(a,b) a/**/b
264 #define JUMP_TABLE(NAME)\
265 CAT(NAME,_core_file_failing_command),\
266 CAT(NAME,_core_file_failing_signal),\
267 CAT(NAME,_core_file_matches_executable_p),\
268 CAT(NAME,_slurp_armap),\
269 CAT(NAME,_slurp_extended_name_table),\
270 CAT(NAME,_truncate_arname),\
271 CAT(NAME,_write_armap),\
272 CAT(NAME,_close_and_cleanup), \
273 CAT(NAME,_set_section_contents),\
274 CAT(NAME,_get_section_contents),\
275 CAT(NAME,_new_section_hook),\
276 CAT(NAME,_get_symtab_upper_bound),\
277 CAT(NAME,_get_symtab),\
278 CAT(NAME,_get_reloc_upper_bound),\
279 CAT(NAME,_canonicalize_reloc),\
280 CAT(NAME,_make_empty_symbol),\
281 CAT(NAME,_print_symbol),\
282 CAT(NAME,_get_lineno),\
283 CAT(NAME,_set_arch_mach),\
284 CAT(NAME,_openr_next_archived_file),\
285 CAT(NAME,_find_nearest_line),\
286 CAT(NAME,_generic_stat_arch_elt),\
287 CAT(NAME,_sizeof_headers),\
288 CAT(NAME,_bfd_debug_info_start),\
289 CAT(NAME,_bfd_debug_info_end),\
290 CAT(NAME,_bfd_debug_info_accumulate),\
291 CAT(NAME,_bfd_get_relocated_section_contents),\
292 CAT(NAME,_bfd_relax_section),\
293 CAT(NAME,_bfd_seclet_link)
295 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
298 /* User program access to BFD facilities */
300 extern CONST short _bfd_host_big_endian;
301 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
305 /* Cast from const char * to char * so that caller can assign to
306 a char * without a warning. */
307 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
308 #define bfd_get_format(abfd) ((abfd)->format)
309 #define bfd_get_target(abfd) ((abfd)->xvec->name)
310 #define bfd_get_file_flags(abfd) ((abfd)->flags)
311 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
312 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
313 #define bfd_my_archive(abfd) ((abfd)->my_archive)
314 #define bfd_has_map(abfd) ((abfd)->has_armap)
315 #define bfd_header_twiddle_required(abfd) \
316 ((((abfd)->xvec->header_byteorder_big_p) \
317 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
319 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
320 #define bfd_usrdata(abfd) ((abfd)->usrdata)
322 #define bfd_get_start_address(abfd) ((abfd)->start_address)
323 #define bfd_get_symcount(abfd) ((abfd)->symcount)
324 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
325 #define bfd_count_sections(abfd) ((abfd)->section_count)
326 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
327 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
329 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
335 /* And more from the source. */
337 bfd_init PARAMS ((void));
340 bfd_openr PARAMS ((CONST char *filename, CONST char*target));
343 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
346 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
349 bfd_close PARAMS ((bfd *));
352 bfd_close_all_done PARAMS ((bfd *));
355 bfd_alloc_size PARAMS ((bfd *abfd));
358 bfd_create PARAMS ((CONST char *filename, bfd *template));
360 #define bfd_put_8(abfd, val, ptr) \
361 (*((char *)ptr) = (char)val)
362 #define bfd_get_8(abfd, ptr) \
364 #define bfd_put_16(abfd, val, ptr) \
365 BFD_SEND(abfd, bfd_putx16, (val,ptr))
366 #define bfd_get_16(abfd, ptr) \
367 BFD_SEND(abfd, bfd_getx16, (ptr))
368 #define bfd_put_32(abfd, val, ptr) \
369 BFD_SEND(abfd, bfd_putx32, (val,ptr))
370 #define bfd_get_32(abfd, ptr) \
371 BFD_SEND(abfd, bfd_getx32, (ptr))
372 #define bfd_put_64(abfd, val, ptr) \
373 BFD_SEND(abfd, bfd_putx64, (val, ptr))
374 #define bfd_get_64(abfd, ptr) \
375 BFD_SEND(abfd, bfd_getx64, (ptr))
376 #define bfd_h_put_8(abfd, val, ptr) \
377 (*((char *)ptr) = (char)val)
378 #define bfd_h_get_8(abfd, ptr) \
380 #define bfd_h_put_16(abfd, val, ptr) \
381 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
382 #define bfd_h_get_16(abfd, ptr) \
383 BFD_SEND(abfd, bfd_h_getx16,(ptr))
384 #define bfd_h_put_32(abfd, val, ptr) \
385 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
386 #define bfd_h_get_32(abfd, ptr) \
387 BFD_SEND(abfd, bfd_h_getx32,(ptr))
388 #define bfd_h_put_64(abfd, val, ptr) \
389 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
390 #define bfd_h_get_64(abfd, ptr) \
391 BFD_SEND(abfd, bfd_h_getx64,(ptr))
394 /* The name of the section, the name isn't a copy, the pointer is
395 the same as that passed to bfd_make_section. */
400 /* Which section is it 0.nth */
404 /* The next section in the list belonging to the BFD, or NULL. */
408 /* The field flags contains attributes of the section. Some of
409 flags are read in from the object file, and some are
410 synthesized from other information. */
414 #define SEC_NO_FLAGS 0x000
416 /* Tells the OS to allocate space for this section when loaded.
417 This would clear for a section containing debug information
421 #define SEC_ALLOC 0x001
422 /* Tells the OS to load the section from the file when loading.
423 This would be clear for a .bss section */
425 #define SEC_LOAD 0x002
426 /* The section contains data still to be relocated, so there will
427 be some relocation information too. */
429 #define SEC_RELOC 0x004
433 #define SEC_BALIGN 0x008
435 /* A signal to the OS that the section contains read only
437 #define SEC_READONLY 0x010
439 /* The section contains code only. */
441 #define SEC_CODE 0x020
443 /* The section contains data only. */
445 #define SEC_DATA 0x040
447 /* The section will reside in ROM. */
449 #define SEC_ROM 0x080
451 /* The section contains constructor information. This section
452 type is used by the linker to create lists of constructors and
453 destructors used by <<g++>>. When a back end sees a symbol
454 which should be used in a constructor list, it creates a new
455 section for the type of name (eg <<__CTOR_LIST__>>), attaches
456 the symbol to it and builds a relocation. To build the lists
457 of constructors, all the linker has to to is catenate all the
458 sections called <<__CTOR_LIST__>> and relocte the data
459 contained within - exactly the operations it would peform on
462 #define SEC_CONSTRUCTOR 0x100
464 /* The section is a constuctor, and should be placed at the
467 #define SEC_CONSTRUCTOR_TEXT 0x1100
469 #define SEC_CONSTRUCTOR_DATA 0x2100
471 #define SEC_CONSTRUCTOR_BSS 0x3100
473 /* The section has contents - a data section could be
474 <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>, a debug section could be
475 <<SEC_HAS_CONTENTS>> */
477 #define SEC_HAS_CONTENTS 0x200
479 /* An instruction to the linker not to output sections
480 containing this flag even if they have information which
481 would normally be written. */
483 #define SEC_NEVER_LOAD 0x400
485 /* The section is a shared library section. The linker must leave
486 these completely alone, as the vma and size are used when
487 the executable is loaded. */
489 #define SEC_SHARED_LIBRARY 0x800
491 /* The section is a common section (symbols may be defined
492 multiple times, the value of a symbol is the amount of
493 space it requires, and the largest symbol value is the one
494 used). Most targets have exactly one of these (.bss), but
497 #define SEC_IS_COMMON 0x8000
500 boolean user_set_vma;
502 /* The size of the section in bytes, as it will be output.
503 contains a value even if the section has no contents (eg, the
504 size of <<.bss>>). This will be filled in after relocation */
506 bfd_size_type _cooked_size;
508 /* The size on disk of the section in bytes originally. Normally this
509 value is the same as the size, but if some relaxing has
510 been done, then this value will be bigger. */
512 bfd_size_type _raw_size;
514 /* If this section is going to be output, then this value is the
515 offset into the output section of the first byte in the input
516 section. Eg, if this was going to start at the 100th byte in
517 the output section, this value would be 100. */
519 bfd_vma output_offset;
521 /* The output section through which to map on output. */
523 struct sec *output_section;
525 /* The alignment requirement of the section, as an exponent - eg
526 3 aligns to 2^3 (or 8) */
528 unsigned int alignment_power;
530 /* If an input section, a pointer to a vector of relocation
531 records for the data in this section. */
533 struct reloc_cache_entry *relocation;
535 /* If an output section, a pointer to a vector of pointers to
536 relocation records for the data in this section. */
538 struct reloc_cache_entry **orelocation;
540 /* The number of relocation records in one of the above */
542 unsigned reloc_count;
544 /* Information below is back end specific - and not always used
547 File position of section data */
551 /* File position of relocation info */
553 file_ptr rel_filepos;
555 /* File position of line data */
557 file_ptr line_filepos;
559 /* Pointer to data for applications */
563 struct lang_output_section *otheruserdata;
565 /* Attached line number information */
569 /* Number of line number records */
571 unsigned int lineno_count;
573 /* When a section is being output, this value changes as more
574 linenumbers are written out */
576 file_ptr moving_line_filepos;
578 /* what the section number is in the target world */
584 /* If this is a constructor section then here is a list of the
585 relocations created to relocate items within it. */
587 struct relent_chain *constructor_chain;
589 /* The BFD which owns the section. */
594 /* A symbol which points at this section only */
595 struct symbol_cache_entry *symbol;
596 struct symbol_cache_entry **symbol_ptr_ptr;
597 struct bfd_seclet *seclets_head;
598 struct bfd_seclet *seclets_tail;
602 #define BFD_ABS_SECTION_NAME "*ABS*"
603 #define BFD_UND_SECTION_NAME "*UND*"
604 #define BFD_COM_SECTION_NAME "*COM*"
606 /* the absolute section */
607 extern asection bfd_abs_section;
608 /* Pointer to the undefined section */
609 extern asection bfd_und_section;
610 /* Pointer to the common section */
611 extern asection bfd_com_section;
613 extern struct symbol_cache_entry *bfd_abs_symbol;
614 extern struct symbol_cache_entry *bfd_com_symbol;
615 extern struct symbol_cache_entry *bfd_und_symbol;
616 #define bfd_get_section_size_before_reloc(section) \
617 (section->reloc_done ? (abort(),1): (section)->_raw_size)
618 #define bfd_get_section_size_after_reloc(section) \
619 ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
621 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
624 bfd_make_section_old_way PARAMS ((bfd *, CONST char *name));
627 bfd_make_section PARAMS ((bfd *, CONST char *name));
630 bfd_set_section_flags PARAMS ((bfd *, asection *, flagword));
633 bfd_map_over_sections PARAMS ((bfd *abfd,
634 void (*func)(bfd *abfd,
640 bfd_set_section_size PARAMS ((bfd *, asection *, bfd_size_type val));
643 bfd_set_section_contents
648 bfd_size_type count));
651 bfd_get_section_contents
652 PARAMS ((bfd *abfd, asection *section, PTR location,
653 file_ptr offset, bfd_size_type count));
655 enum bfd_architecture
657 bfd_arch_unknown, /* File arch not known */
658 bfd_arch_obscure, /* Arch known, not one of these */
659 bfd_arch_m68k, /* Motorola 68xxx */
660 bfd_arch_vax, /* DEC Vax */
661 bfd_arch_i960, /* Intel 960 */
662 /* The order of the following is important.
663 lower number indicates a machine type that
664 only accepts a subset of the instructions
665 available to machines with higher numbers.
666 The exception is the "ca", which is
667 incompatible with all other machines except
670 #define bfd_mach_i960_core 1
671 #define bfd_mach_i960_ka_sa 2
672 #define bfd_mach_i960_kb_sb 3
673 #define bfd_mach_i960_mc 4
674 #define bfd_mach_i960_xa 5
675 #define bfd_mach_i960_ca 6
677 bfd_arch_a29k, /* AMD 29000 */
678 bfd_arch_sparc, /* SPARC */
679 bfd_arch_mips, /* MIPS Rxxxx */
680 bfd_arch_i386, /* Intel 386 */
681 bfd_arch_we32k, /* AT&T WE32xxx */
682 bfd_arch_tahoe, /* CCI/Harris Tahoe */
683 bfd_arch_i860, /* Intel 860 */
684 bfd_arch_romp, /* IBM ROMP PC/RT */
685 bfd_arch_alliant, /* Alliant */
686 bfd_arch_convex, /* Convex */
687 bfd_arch_m88k, /* Motorola 88xxx */
688 bfd_arch_pyramid, /* Pyramid Technology */
689 bfd_arch_h8300, /* Hitachi H8/300 */
690 bfd_arch_rs6000, /* IBM RS/6000 */
691 bfd_arch_hppa, /* HP PA RISC */
692 bfd_arch_z8k, /* Zilog Z8000 */
693 #define bfd_mach_z8001 1
694 #define bfd_mach_z8002 2
698 typedef struct bfd_arch_info
701 int bits_per_address;
703 enum bfd_architecture arch;
706 CONST char *printable_name;
707 unsigned int section_align_power;
708 /* true if this is the default machine for the architecture */
710 CONST struct bfd_arch_info * (*compatible)
711 PARAMS ((CONST struct bfd_arch_info *a,
712 CONST struct bfd_arch_info *b));
714 boolean (*scan) PARAMS ((CONST struct bfd_arch_info *, CONST char *));
715 /* How to disassemble an instruction, producing a printable
716 representation on a specified stdio stream. This isn't
717 defined for most processors at present, because of the size
718 of the additional tables it would drag in, and because gdb
719 wants to use a different interface. */
720 unsigned int (*disassemble) PARAMS ((bfd_vma addr, CONST char *data,
723 struct bfd_arch_info *next;
724 } bfd_arch_info_type;
726 bfd_printable_name PARAMS ((bfd *abfd));
729 bfd_scan_arch PARAMS ((CONST char *));
731 CONST bfd_arch_info_type *
732 bfd_arch_get_compatible PARAMS ((
737 bfd_set_arch_info PARAMS ((bfd *, bfd_arch_info_type *));
739 enum bfd_architecture
740 bfd_get_arch PARAMS ((bfd *abfd));
743 bfd_get_mach PARAMS ((bfd *abfd));
746 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
749 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
752 bfd_get_arch_info PARAMS ((bfd *));
756 PARAMS ((enum bfd_architecture
761 bfd_printable_arch_mach
762 PARAMS ((enum bfd_architecture arch, unsigned long machine));
764 typedef enum bfd_reloc_status
766 /* No errors detected */
769 /* The relocation was performed, but there was an overflow. */
772 /* The address to relocate was not within the section supplied*/
773 bfd_reloc_outofrange,
775 /* Used by special functions */
779 bfd_reloc_notsupported,
781 /* Unsupported relocation size requested. */
784 /* The symbol to relocate against was undefined.*/
787 /* The relocation was performed, but may not be ok - presently
788 generated only when linking i960 coff files with i960 b.out
792 bfd_reloc_status_type;
795 typedef struct reloc_cache_entry
797 /* A pointer into the canonical table of pointers */
798 struct symbol_cache_entry **sym_ptr_ptr;
800 /* offset in section */
801 rawdata_offset address;
803 /* addend for relocation value */
806 /* Pointer to how to perform the required relocation */
807 CONST struct reloc_howto_struct *howto;
811 typedef CONST struct reloc_howto_struct
813 /* The type field has mainly a documetary use - the back end can
814 to what it wants with it, though the normally the back end's
815 external idea of what a reloc number would be would be stored
816 in this field. For example, the a PC relative word relocation
817 in a coff environment would have the type 023 - because that's
818 what the outside world calls a R_PCRWORD reloc. */
821 /* The value the final relocation is shifted right by. This drops
822 unwanted data from the relocation. */
823 unsigned int rightshift;
825 /* The size of the item to be relocated - 0, is one byte, 1 is 2
826 bytes, 3 is four bytes. A negative value indicates that the
827 result is to be subtracted from the data. */
830 /* Now obsolete? But m68k-coff still uses it... */
831 unsigned int bitsize;
833 /* Notes that the relocation is relative to the location in the
834 data section of the addend. The relocation function will
835 subtract from the relocation value the address of the location
844 /* Causes the relocation routine to return an error if overflow
845 is detected when relocating. */
846 boolean complain_on_overflow;
848 /* If this field is non null, then the supplied function is
849 called rather than the normal function. This allows really
850 strange relocation methods to be accomodated (e.g., i960 callj
852 bfd_reloc_status_type (*special_function)
854 arelent *reloc_entry,
855 struct symbol_cache_entry *symbol,
857 asection *input_section,
860 /* The textual name of the relocation type. */
863 /* When performing a partial link, some formats must modify the
864 relocations rather than the data - this flag signals this.*/
865 boolean partial_inplace;
867 /* The src_mask is used to select what parts of the read in data
868 are to be used in the relocation sum. E.g., if this was an 8 bit
869 bit of data which we read and relocated, this would be
870 0x000000ff. When we have relocs which have an addend, such as
871 sun4 extended relocs, the value in the offset part of a
872 relocating field is garbage so we never use it. In this case
873 the mask would be 0x00000000. */
876 /* The dst_mask is what parts of the instruction are replaced
877 into the instruction. In most cases src_mask == dst_mask,
878 except in the above special case, where dst_mask would be
879 0x000000ff, and src_mask would be 0x00000000. */
882 /* When some formats create PC relative instructions, they leave
883 the value of the pc of the place being relocated in the offset
884 slot of the instruction, so that a PC relative relocation can
885 be made just by adding in an ordinary offset (e.g., sun3 a.out).
886 Some formats leave the displacement part of an instruction
887 empty (e.g., m88k bcs), this flag signals the fact.*/
888 boolean pcrel_offset;
891 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
892 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
893 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,IN)
895 #define HOWTO_PREPARE(relocation, symbol) \
897 if (symbol != (asymbol *)NULL) { \
898 if (bfd_is_com_section (symbol->section)) { \
902 relocation = symbol->value; \
906 typedef unsigned char bfd_byte;
908 typedef struct relent_chain {
910 struct relent_chain *next;
912 bfd_reloc_status_type
914 bfd_perform_relocation
916 arelent *reloc_entry,
918 asection *input_section,
921 typedef enum bfd_reloc_code_real
924 /* 16 bits wide, simple reloc */
927 /* 8 bits wide, but used to form an address like 0xffnn */
930 /* 8 bits wide, simple */
933 /* 8 bits wide, pc relative */
936 /* The type of reloc used to build a contructor table - at the
937 moment probably a 32 bit wide abs address, but the cpu can
942 /* 32 bits wide, simple reloc */
944 /* 32 bits, PC-relative */
947 /* High 22 bits of 32-bit value; simple reloc. */
952 /* Reloc types used for i960/b.out. */
954 BFD_RELOC_I960_CALLJ,
957 /* 32-bit pc-relative, shifted right 2 bits (i.e., 30-bit
958 word displacement, e.g. for SPARC) */
959 BFD_RELOC_32_PCREL_S2,
961 /* now for the sparc/elf codes */
962 BFD_RELOC_NONE, /* actually used */
963 BFD_RELOC_SPARC_WDISP22,
966 BFD_RELOC_SPARC_BASE13,
967 BFD_RELOC_SPARC_GOT10,
968 BFD_RELOC_SPARC_GOT13,
969 BFD_RELOC_SPARC_GOT22,
970 BFD_RELOC_SPARC_PC10,
971 BFD_RELOC_SPARC_PC22,
972 BFD_RELOC_SPARC_WPLT30,
973 BFD_RELOC_SPARC_COPY,
974 BFD_RELOC_SPARC_GLOB_DAT,
975 BFD_RELOC_SPARC_JMP_SLOT,
976 BFD_RELOC_SPARC_RELATIVE,
977 BFD_RELOC_SPARC_UA32,
979 /* this one is a.out specific? */
980 BFD_RELOC_SPARC_BASE22,
982 /* this must be the highest numeric value */
984 } bfd_reloc_code_real_type;
985 CONST struct reloc_howto_struct *
987 bfd_reloc_type_lookup PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
989 typedef struct symbol_cache_entry
991 /* A pointer to the BFD which owns the symbol. This information
992 is necessary so that a back end can work out what additional
993 information (invisible to the application writer) is carried
996 This field is *almost* redundant, since you can use section->owner
997 instead, except that some symbols point to the global sections
998 bfd_{abs,com,und}_section. This could be fixed by making
999 these globals be per-bfd (or per-target-flavor). FIXME. */
1001 struct _bfd *the_bfd; /* Use bfd_asymbol_bfd(sym) to access this field. */
1003 /* The text of the symbol. The name is left alone, and not copied - the
1004 application may not alter it. */
1007 /* The value of the symbol.*/
1010 /* Attributes of a symbol: */
1012 #define BSF_NO_FLAGS 0x00
1014 /* The symbol has local scope; <<static>> in <<C>>. The value
1015 is the offset into the section of the data. */
1016 #define BSF_LOCAL 0x01
1018 /* The symbol has global scope; initialized data in <<C>>. The
1019 value is the offset into the section of the data. */
1020 #define BSF_GLOBAL 0x02
1022 /* Obsolete; should be deleted? */
1023 #define BSF_IMPORT 0x04
1025 /* The symbol has global scope, and is exported. The value is
1026 the offset into the section of the data. */
1027 #define BSF_EXPORT 0x08
1029 /* The symbol is undefined. <<extern>> in <<C>>. The value has
1030 no meaning. Obsolete; should be deleted? */
1031 #define BSF_UNDEFINED_OBS 0x10
1033 /* The symbol is common, initialized to zero; default in
1034 <<C>>. The value is the size of the object in bytes. */
1035 #define BSF_FORT_COMM_OBS 0x20
1037 /* A normal C symbol would be one of:
1038 <<BSF_LOCAL>>, <<BSF_FORT_COMM>>, <<BSF_UNDEFINED>> or
1039 <<BSF_EXPORT|BSD_GLOBAL>> */
1041 /* The symbol is a debugging record. The value has an arbitary
1043 #define BSF_DEBUGGING 0x40
1045 /* Used by the linker. */
1046 #define BSF_KEEP 0x10000
1047 #define BSF_KEEP_G 0x80000
1049 /* Unused; should be deleted? */
1050 #define BSF_WEAK 0x100000
1051 #define BSF_CTOR 0x200000
1053 /* This symbol was created to point to a section, e.g. ELF's
1054 STT_SECTION symbols. */
1055 #define BSF_SECTION_SYM 0x400000
1057 /* The symbol used to be a common symbol, but now it is
1059 #define BSF_OLD_COMMON 0x800000
1061 /* The default value for common data. */
1062 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1064 /* In some files the type of a symbol sometimes alters its
1065 location in an output file - ie in coff a <<ISFCN>> symbol
1066 which is also <<C_EXT>> symbol appears where it was
1067 declared and not at the end of a section. This bit is set
1068 by the target BFD part to convey this information. */
1070 #define BSF_NOT_AT_END 0x40000
1072 /* Signal that the symbol is the label of constructor section. */
1073 #define BSF_CONSTRUCTOR 0x1000000
1075 /* Signal that the symbol is a warning symbol. If the symbol
1076 is a warning symbol, then the value field (I know this is
1077 tacky) will point to the asymbol which when referenced will
1078 cause the warning. */
1079 #define BSF_WARNING 0x2000000
1081 /* Signal that the symbol is indirect. The value of the symbol
1082 is a pointer to an undefined asymbol which contains the
1083 name to use instead. */
1084 #define BSF_INDIRECT 0x4000000
1086 /* BSF_FILE marks symbols that contain a file name. This is used
1087 for ELF STT_FILE symbols. */
1088 #define BSF_FILE 0x08000000
1092 /* A pointer to the section to which this symbol is
1093 relative. This will always be non NULL, there are special
1094 sections for undefined and absolute symbols */
1095 struct sec *section;
1097 /* Back end special data. This is being phased out in favour
1098 of making this a union. */
1102 #define get_symtab_upper_bound(abfd) \
1103 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1104 #define bfd_canonicalize_symtab(abfd, location) \
1105 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1108 bfd_set_symtab PARAMS ((bfd *, asymbol **, unsigned int ));
1111 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
1113 #define bfd_make_empty_symbol(abfd) \
1114 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1115 #define bfd_make_debug_symbol(abfd,ptr,size) \
1116 BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
1118 bfd_decode_symclass PARAMS ((asymbol *symbol));
1122 /* The filename the application opened the BFD with. */
1123 CONST char *filename;
1125 /* A pointer to the target jump table. */
1126 struct bfd_target *xvec;
1128 /* To avoid dragging too many header files into every file that
1129 includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1130 *", and MTIME as a "long". Their correct types, to which they
1131 are cast when used, are "FILE *" and "time_t". The iostream
1132 is the result of an fopen on the filename. */
1135 /* Is the file being cached */
1139 /* Marks whether there was a default target specified when the
1140 BFD was opened. This is used to select what matching algorithm
1141 to use to chose the back end. */
1143 boolean target_defaulted;
1145 /* The caching routines use these to maintain a
1146 least-recently-used list of BFDs */
1148 struct _bfd *lru_prev, *lru_next;
1150 /* When a file is closed by the caching routines, BFD retains
1151 state information on the file here:
1158 boolean opened_once;
1160 /* Set if we have a locally maintained mtime value, rather than
1161 getting it from the file each time: */
1165 /* File modified time, if mtime_set is true: */
1169 /* Reserved for an unimplemented file locking extension.*/
1173 /* The format which belongs to the BFD.*/
1177 /* The direction the BFD was opened with*/
1179 enum bfd_direction {no_direction = 0,
1181 write_direction = 2,
1182 both_direction = 3} direction;
1184 /* Format_specific flags*/
1188 /* Currently my_archive is tested before adding origin to
1189 anything. I believe that this can become always an add of
1190 origin, with origin set to 0 for non archive files. */
1194 /* Remember when output has begun, to stop strange things
1196 boolean output_has_begun;
1198 /* Pointer to linked list of sections*/
1199 struct sec *sections;
1201 /* The number of sections */
1202 unsigned int section_count;
1204 /* Stuff only useful for object files:
1205 The start address. */
1206 bfd_vma start_address;
1208 /* Used for input and output*/
1209 unsigned int symcount;
1211 /* Symbol table for output BFD*/
1212 struct symbol_cache_entry **outsymbols;
1214 /* Pointer to structure which contains architecture information*/
1215 struct bfd_arch_info *arch_info;
1217 /* Stuff only useful for archives:*/
1219 struct _bfd *my_archive;
1221 struct _bfd *archive_head;
1224 /* Used by the back end to hold private data. */
1228 struct aout_data_struct *aout_data;
1229 struct artdata *aout_ar_data;
1230 struct _oasys_data *oasys_obj_data;
1231 struct _oasys_ar_data *oasys_ar_data;
1232 struct coff_tdata *coff_obj_data;
1233 struct ecoff_tdata *ecoff_obj_data;
1234 struct ieee_data_struct *ieee_data;
1235 struct ieee_ar_data_struct *ieee_ar_data;
1236 struct srec_data_struct *srec_data;
1237 struct tekhex_data_struct *tekhex_data;
1238 struct elf_obj_tdata *elf_obj_data;
1239 struct bout_data_struct *bout_data;
1240 struct sun_core_struct *sun_core_data;
1241 struct trad_core_struct *trad_core_data;
1242 struct hppa_data_struct *hppa_data;
1243 struct hppa_core_struct *hppa_core_data;
1247 /* Used by the application to hold private data*/
1250 /* Where all the allocated stuff under this BFD goes */
1251 struct obstack memory;
1253 /* Is this really needed in addition to usrdata? */
1254 asymbol **ld_symbols;
1258 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
1261 bfd_canonicalize_reloc
1268 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
1272 PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
1277 bfd_set_start_address PARAMS ((bfd *, bfd_vma));
1280 bfd_get_mtime PARAMS ((bfd *));
1283 bfd_get_size PARAMS ((bfd *));
1285 #define bfd_sizeof_headers(abfd, reloc) \
1286 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1288 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1289 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
1291 /* Do these three do anything useful at all, for any back end? */
1292 #define bfd_debug_info_start(abfd) \
1293 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1295 #define bfd_debug_info_end(abfd) \
1296 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1298 #define bfd_debug_info_accumulate(abfd, section) \
1299 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1302 #define bfd_stat_arch_elt(abfd, stat) \
1303 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1305 #define bfd_set_arch_mach(abfd, arch, mach)\
1306 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1308 #define bfd_get_relocated_section_contents(abfd, seclet, data, relocateable) \
1309 BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data, relocateable))
1311 #define bfd_relax_section(abfd, section, symbols) \
1312 BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
1314 #define bfd_seclet_link(abfd, data, relocateable) \
1315 BFD_SEND (abfd, _bfd_seclet_link, (abfd, data, relocateable))
1317 bfd_get_next_mapent PARAMS ((bfd *, symindex previous, carsym ** sym));
1320 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
1323 bfd_get_elt_at_index PARAMS ((bfd * archive, int index));
1326 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
1329 bfd_core_file_failing_command PARAMS ((bfd *));
1332 bfd_core_file_failing_signal PARAMS ((bfd *));
1335 core_file_matches_executable_p
1336 PARAMS ((bfd *core_bfd, bfd *exec_bfd));
1338 #define BFD_SEND(bfd, message, arglist) \
1339 ((*((bfd)->xvec->message)) arglist)
1340 #define BFD_SEND_FMT(bfd, message, arglist) \
1341 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1342 typedef struct bfd_target
1345 enum target_flavour {
1346 bfd_target_unknown_flavour,
1347 bfd_target_aout_flavour,
1348 bfd_target_coff_flavour,
1349 bfd_target_ecoff_flavour,
1350 bfd_target_elf_flavour,
1351 bfd_target_ieee_flavour,
1352 bfd_target_oasys_flavour,
1353 bfd_target_tekhex_flavour,
1354 bfd_target_srec_flavour,
1355 bfd_target_hppa_flavour} flavour;
1356 boolean byteorder_big_p;
1357 boolean header_byteorder_big_p;
1358 flagword object_flags;
1359 flagword section_flags;
1360 char symbol_leading_char;
1362 unsigned short ar_max_namelen;
1363 unsigned int align_power_min;
1364 bfd_vma (*bfd_getx64) PARAMS ((bfd_byte *));
1365 void (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
1366 bfd_vma (*bfd_getx32) PARAMS ((bfd_byte *));
1367 void (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
1368 bfd_vma (*bfd_getx16) PARAMS ((bfd_byte *));
1369 void (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
1370 bfd_vma (*bfd_h_getx64) PARAMS ((bfd_byte *));
1371 void (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
1372 bfd_vma (*bfd_h_getx32) PARAMS ((bfd_byte *));
1373 void (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
1374 bfd_vma (*bfd_h_getx16) PARAMS ((bfd_byte *));
1375 void (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
1376 struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
1377 boolean (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
1378 boolean (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
1379 char * (*_core_file_failing_command) PARAMS ((bfd *));
1380 int (*_core_file_failing_signal) PARAMS ((bfd *));
1381 boolean (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
1382 boolean (*_bfd_slurp_armap) PARAMS ((bfd *));
1383 boolean (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
1384 void (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
1385 boolean (*write_armap) PARAMS ((bfd *arch,
1386 unsigned int elength,
1388 unsigned int orl_count,
1390 boolean (*_close_and_cleanup) PARAMS ((bfd *));
1391 boolean (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1392 file_ptr, bfd_size_type));
1393 boolean (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1394 file_ptr, bfd_size_type));
1395 boolean (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
1396 unsigned int (*_get_symtab_upper_bound) PARAMS ((bfd *));
1397 unsigned int (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
1398 struct symbol_cache_entry **));
1399 unsigned int (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
1400 unsigned int (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
1401 struct symbol_cache_entry **));
1402 struct symbol_cache_entry *
1403 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
1404 void (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
1405 struct symbol_cache_entry *,
1406 bfd_print_symbol_type));
1407 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1408 alent * (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
1410 boolean (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
1413 bfd * (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
1415 boolean (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
1416 struct sec *section, struct symbol_cache_entry **symbols,
1417 bfd_vma offset, CONST char **file, CONST char **func,
1418 unsigned int *line));
1420 int (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
1422 int (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
1424 void (*_bfd_debug_info_start) PARAMS ((bfd *));
1425 void (*_bfd_debug_info_end) PARAMS ((bfd *));
1426 void (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
1428 bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
1429 struct bfd_seclet *, bfd_byte *data,
1430 boolean relocateable));
1432 boolean (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
1433 struct symbol_cache_entry **));
1435 boolean (*_bfd_seclet_link) PARAMS ((bfd *, PTR data,
1436 boolean relocateable));
1437 /* See documentation on reloc types. */
1438 CONST struct reloc_howto_struct *
1439 (*reloc_type_lookup) PARAMS ((bfd *abfd,
1440 bfd_reloc_code_real_type code));
1442 /* Back-door to allow format-aware applications to create debug symbols
1443 while using BFD for everything else. Currently used by the assembler
1444 when creating COFF files. */
1445 asymbol * (*_bfd_make_debug_symbol) PARAMS ((
1448 unsigned long size));
1452 bfd_find_target PARAMS ((CONST char *, bfd *));
1455 bfd_target_list PARAMS ((void));
1458 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
1461 bfd_set_format PARAMS ((bfd *, bfd_format));
1464 bfd_format_string PARAMS ((bfd_format));