1 /* A -*- C -*- header file for the bfd library
2 Copyright 1990, 1991 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
21 /* bfd.h -- The only header file required by users of the bfd library
23 This file is generated from various .c files, if you change it, your
26 All the prototypes and definitions following the comment "THE FOLLOWING
27 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
28 BFD. If you change it, someone oneday will extract it from the source
29 again, and your changes will be lost. To save yourself from this bind,
30 change the definitions in the source in the bfd directory. Type "make
31 docs" and then "make headers" in that directory, and magically this file
32 will change to reflect your changes.
34 If you don't have the tools to perform the extraction, then you are
35 safe from someone on your system trampling over your header files.
36 You should still maintain the equivalence between the source and this
37 file though; every change you make to the .c file should be reflected
40 #ifndef __BFD_H_SEEN__
41 #define __BFD_H_SEEN__
46 /* Make it easier to declare prototypes (puts conditional here) */
49 # define PROTO(type, name, arglist) type name arglist
51 # define PROTO(type, name, arglist) type name ()
55 #define BFD_VERSION "0.18"
57 /* forward declaration */
58 typedef struct _bfd bfd;
60 /* General rules: functions which are boolean return true on success
61 and false on failure (unless they're a predicate). -- bfd.doc */
62 /* I'm sure this is going to break something and someone is going to
63 force me to change it. */
64 /* typedef enum boolean {false, true} boolean; */
65 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */
66 typedef enum bfd_boolean {false, true} boolean;
68 /* Try to avoid breaking stuff */
69 typedef long int file_ptr;
71 /* Support for different sizes of target format ints and addresses */
74 typedef HOST_64_BIT rawdata_offset;
75 typedef HOST_64_BIT bfd_vma;
76 typedef HOST_64_BIT bfd_word;
77 typedef HOST_64_BIT bfd_offset;
78 typedef HOST_64_BIT bfd_size_type;
79 typedef HOST_64_BIT symvalue;
80 typedef HOST_64_BIT bfd_64_type;
81 #define fprintf_vma(s,x) \
82 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
84 typedef struct {int a,b;} bfd_64_type;
85 typedef unsigned long rawdata_offset;
86 typedef unsigned long bfd_vma;
87 typedef unsigned long bfd_offset;
88 typedef unsigned long bfd_word;
89 typedef unsigned long bfd_size;
90 typedef unsigned long symvalue;
91 typedef unsigned long bfd_size_type;
92 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
94 #define printf_vma(x) fprintf_vma(stdout,x)
96 typedef unsigned int flagword; /* 32 bits of flags */
100 typedef enum bfd_format {
101 bfd_unknown = 0, /* file format is unknown */
102 bfd_object, /* linker/assember/compiler output */
103 bfd_archive, /* object archive file */
104 bfd_core, /* core dump */
105 bfd_type_end} /* marks the end; don't use it! */
108 /* Object file flag values */
110 #define HAS_RELOC 001
112 #define HAS_LINENO 004
113 #define HAS_DEBUG 010
115 #define HAS_LOCALS 040
121 /* symbols and relocation */
123 typedef unsigned long symindex;
125 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
127 typedef enum bfd_symclass {
128 bfd_symclass_unknown = 0,
129 bfd_symclass_fcommon, /* fortran common symbols */
130 bfd_symclass_global, /* global symbol, what a surprise */
131 bfd_symclass_debugger, /* some debugger symbol */
132 bfd_symclass_undefined /* none known */
136 typedef int symtype; /* Who knows, yet? */
139 /* general purpose part of a symbol;
140 target specific parts will be found in libcoff.h, liba.out.h etc */
143 #define bfd_get_section(x) ((x)->section)
144 #define bfd_get_output_section(x) ((x)->section->output_section)
145 #define bfd_set_section(x,y) ((x)->section) = (y)
146 #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0)
147 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value)
148 #define bfd_asymbol_name(x) ((x)->name)
150 /* This is a type pun with struct ranlib on purpose! */
151 typedef struct carsym {
153 file_ptr file_offset; /* look here to find the file */
154 } carsym; /* to make these you call a carsymogen */
157 /* Used in generating armaps. Perhaps just a forward definition would do? */
158 struct orl { /* output ranlib */
159 char **name; /* symbol name */
160 file_ptr pos; /* bfd* or file position */
161 int namidx; /* index into string table */
166 /* Linenumber stuff */
167 typedef struct lineno_cache_entry {
168 unsigned int line_number; /* Linenumber from start of function*/
170 struct symbol_cache_entry *sym; /* Function name */
171 unsigned long offset; /* Offset into section */
175 /* object and core file sections */
178 #define align_power(addr, align) \
179 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
181 typedef struct sec *sec_ptr;
183 #define bfd_section_name(bfd, ptr) ((ptr)->name)
184 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
185 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
186 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
187 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags)
188 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
190 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true)
191 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
192 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
194 typedef struct stat stat_type;
196 /** Error handling */
198 typedef enum bfd_error {
199 no_error = 0, system_call_error, invalid_target,
200 wrong_format, invalid_operation, no_memory,
201 no_symbols, no_relocation_info,
202 no_more_archived_files, malformed_archive,
203 symbol_not_found, file_not_recognized,
204 file_ambiguously_recognized, no_contents,
205 bfd_error_nonrepresentable_section,
207 invalid_error_code} bfd_ec;
209 extern bfd_ec bfd_error;
210 struct reloc_cache_entry;
211 struct bfd_seclet_struct ;
214 typedef struct bfd_error_vector {
215 PROTO(void,(* nonrepresentable_section ),(CONST bfd *CONST abfd,
216 CONST char *CONST name));
217 PROTO(void,(* undefined_symbol),(CONST struct reloc_cache_entry *rel,
218 CONST struct bfd_seclet_struct *sec
220 PROTO(void, (* reloc_value_truncated),(CONST struct
221 reloc_cache_entry *rel,
222 struct bfd_seclet_struct *sec));
224 PROTO(void, (* reloc_dangerous),(CONST struct reloc_cache_entry *rel,
225 CONST struct bfd_seclet_struct *sec));
227 } bfd_error_vector_type;
229 PROTO (char *, bfd_errmsg, (bfd_ec error_tag));
230 PROTO (void, bfd_perror, (CONST char *message));
233 typedef enum bfd_print_symbol
235 bfd_print_symbol_name,
236 bfd_print_symbol_more,
237 bfd_print_symbol_all,
238 bfd_print_symbol_nm /* Pretty format suitable for nm program. */
239 } bfd_print_symbol_type;
243 /* The code that implements targets can initialize a jump table with this
244 macro. It must name all its routines the same way (a prefix plus
245 the standard routine suffix), or it must #define the routines that
246 are not so named, before calling JUMP_TABLE in the initializer. */
248 /* Semi-portable string concatenation in cpp */
251 #define CAT(a,b) a##b
253 #define CAT(a,b) a/**/b
257 #define JUMP_TABLE(NAME)\
258 CAT(NAME,_core_file_failing_command),\
259 CAT(NAME,_core_file_failing_signal),\
260 CAT(NAME,_core_file_matches_executable_p),\
261 CAT(NAME,_slurp_armap),\
262 CAT(NAME,_slurp_extended_name_table),\
263 CAT(NAME,_truncate_arname),\
264 CAT(NAME,_write_armap),\
265 CAT(NAME,_close_and_cleanup), \
266 CAT(NAME,_set_section_contents),\
267 CAT(NAME,_get_section_contents),\
268 CAT(NAME,_new_section_hook),\
269 CAT(NAME,_get_symtab_upper_bound),\
270 CAT(NAME,_get_symtab),\
271 CAT(NAME,_get_reloc_upper_bound),\
272 CAT(NAME,_canonicalize_reloc),\
273 CAT(NAME,_make_empty_symbol),\
274 CAT(NAME,_print_symbol),\
275 CAT(NAME,_get_lineno),\
276 CAT(NAME,_set_arch_mach),\
277 CAT(NAME,_openr_next_archived_file),\
278 CAT(NAME,_find_nearest_line),\
279 CAT(NAME,_generic_stat_arch_elt),\
280 CAT(NAME,_sizeof_headers),\
281 CAT(NAME,_bfd_debug_info_start),\
282 CAT(NAME,_bfd_debug_info_end),\
283 CAT(NAME,_bfd_debug_info_accumulate),\
284 CAT(NAME,_bfd_get_relocated_section_contents),\
285 CAT(NAME,_bfd_relax_section)
287 #define COFF_SWAP_TABLE \
288 coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, \
289 coff_swap_aux_out, coff_swap_sym_out, \
290 coff_swap_lineno_out, coff_swap_reloc_out, \
291 coff_swap_filehdr_out, coff_swap_aouthdr_out, \
296 /* User program access to BFD facilities */
298 extern CONST short _bfd_host_big_endian;
299 #define HOST_BYTE_ORDER_BIG_P (*(char *)&_bfd_host_big_endian)
303 /* Cast from const char * to char * so that caller can assign to
304 a char * without a warning. */
305 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
306 #define bfd_get_format(abfd) ((abfd)->format)
307 #define bfd_get_target(abfd) ((abfd)->xvec->name)
308 #define bfd_get_file_flags(abfd) ((abfd)->flags)
309 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
310 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
311 #define bfd_my_archive(abfd) ((abfd)->my_archive)
312 #define bfd_has_map(abfd) ((abfd)->has_armap)
313 #define bfd_header_twiddle_required(abfd) \
314 ((((abfd)->xvec->header_byteorder_big_p) \
315 != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
317 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
318 #define bfd_usrdata(abfd) ((abfd)->usrdata)
320 #define bfd_get_start_address(abfd) ((abfd)->start_address)
321 #define bfd_get_symcount(abfd) ((abfd)->symcount)
322 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
323 #define bfd_count_sections(abfd) ((abfd)->section_count)
324 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
325 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
335 /* ANd more from the source */
345 void EXFUN(bfd_init, (void));
346 bfd *EXFUN(bfd_openr, (CONST char *filename, CONST char*target));
347 bfd *EXFUN(bfd_fdopenr, (CONST char *filename, CONST char *target, int fd));
348 bfd *EXFUN(bfd_openw, (CONST char *filename, CONST char *target));
349 boolean EXFUN(bfd_close, (bfd *));
350 boolean EXFUN(bfd_close_all_done, (bfd *));
351 bfd_size_type EXFUN(bfd_alloc_size, (bfd *abfd));
352 bfd *EXFUN(bfd_create, (CONST char *filename, bfd *template));
353 #define bfd_put_8(abfd, val, ptr) \
354 (*((char *)ptr) = (char)val)
355 #define bfd_get_8(abfd, ptr) \
357 #define bfd_put_16(abfd, val, ptr) \
358 BFD_SEND(abfd, bfd_putx16, (val,ptr))
359 #define bfd_get_16(abfd, ptr) \
360 BFD_SEND(abfd, bfd_getx16, (ptr))
361 #define bfd_put_32(abfd, val, ptr) \
362 BFD_SEND(abfd, bfd_putx32, (val,ptr))
363 #define bfd_get_32(abfd, ptr) \
364 BFD_SEND(abfd, bfd_getx32, (ptr))
365 #define bfd_put_64(abfd, val, ptr) \
366 BFD_SEND(abfd, bfd_putx64, (val, ptr))
367 #define bfd_get_64(abfd, ptr) \
368 BFD_SEND(abfd, bfd_getx64, (ptr))
369 #define bfd_h_put_8(abfd, val, ptr) \
370 (*((char *)ptr) = (char)val)
371 #define bfd_h_get_8(abfd, ptr) \
373 #define bfd_h_put_16(abfd, val, ptr) \
374 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
375 #define bfd_h_get_16(abfd, ptr) \
376 BFD_SEND(abfd, bfd_h_getx16,(ptr))
377 #define bfd_h_put_32(abfd, val, ptr) \
378 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
379 #define bfd_h_get_32(abfd, ptr) \
380 BFD_SEND(abfd, bfd_h_getx32,(ptr))
381 #define bfd_h_put_64(abfd, val, ptr) \
382 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
383 #define bfd_h_get_64(abfd, ptr) \
384 BFD_SEND(abfd, bfd_h_getx64,(ptr))
387 /* The name of the section, the name isn't a copy, the pointer is
388 the same as that passed to bfd_make_section. */
393 /* Which section is it 0.nth */
397 /* The next section in the list belonging to the BFD, or NULL. */
401 /* The field flags contains attributes of the section. Some of
402 flags are read in from the object file, and some are
403 synthesized from other information. */
407 #define SEC_NO_FLAGS 0x000
409 /* Tells the OS to allocate space for this section when loaded.
410 This would clear for a section containing debug information
414 #define SEC_ALLOC 0x001
415 /* Tells the OS to load the section from the file when loading.
416 This would be clear for a .bss section */
418 #define SEC_LOAD 0x002
419 /* The section contains data still to be relocated, so there will
420 be some relocation information too. */
422 #define SEC_RELOC 0x004
426 #define SEC_BALIGN 0x008
428 /* A signal to the OS that the section contains read only
430 #define SEC_READONLY 0x010
432 /* The section contains code only. */
434 #define SEC_CODE 0x020
436 /* The section contains data only. */
438 #define SEC_DATA 0x040
440 /* The section will reside in ROM. */
442 #define SEC_ROM 0x080
444 /* The section contains constructor information. This section
445 type is used by the linker to create lists of constructors and
446 destructors used by <<g++>>. When a back end sees a symbol
447 which should be used in a constructor list, it creates a new
448 section for the type of name (eg <<__CTOR_LIST__>>), attaches
449 the symbol to it and builds a relocation. To build the lists
450 of constructors, all the linker has to to is catenate all the
451 sections called <<__CTOR_LIST__>> and relocte the data
452 contained within - exactly the operations it would peform on
455 #define SEC_CONSTRUCTOR 0x100
457 /* The section is a constuctor, and should be placed at the
461 #define SEC_CONSTRUCTOR_TEXT 0x1100
463 #define SEC_CONSTRUCTOR_DATA 0x2100
465 #define SEC_CONSTRUCTOR_BSS 0x3100
468 /* The section has contents - a bss section could be
469 <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>, a debug section could be
470 <<SEC_HAS_CONTENTS>> */
472 #define SEC_HAS_CONTENTS 0x200
474 /* An instruction to the linker not to output sections
475 containing this flag even if they have information which
476 would normally be written. */
478 #define SEC_NEVER_LOAD 0x400
484 /* The size of the section in bytes, as it will be output.
485 contains a value even if the section has no contents (eg, the
486 size of <<.bss>>). This will be filled in after relocation */
488 bfd_size_type _cooked_size;
490 /* The size on disk of the section in bytes originally. Normally this
491 value is the same as the size, but if some relaxing has
492 been done, then this value will be bigger. */
494 bfd_size_type _raw_size;
496 /* If this section is going to be output, then this value is the
497 offset into the output section of the first byte in the input
498 section. Eg, if this was going to start at the 100th byte in
499 the output section, this value would be 100. */
501 bfd_vma output_offset;
503 /* The output section through which to map on output. */
505 struct sec *output_section;
507 /* The alignment requirement of the section, as an exponent - eg
508 3 aligns to 2^3 (or 8) */
510 unsigned int alignment_power;
512 /* If an input section, a pointer to a vector of relocation
513 records for the data in this section. */
515 struct reloc_cache_entry *relocation;
517 /* If an output section, a pointer to a vector of pointers to
518 relocation records for the data in this section. */
520 struct reloc_cache_entry **orelocation;
522 /* The number of relocation records in one of the above */
524 unsigned reloc_count;
526 /* Information below is back end specific - and not always used
529 File position of section data */
533 /* File position of relocation info */
535 file_ptr rel_filepos;
537 /* File position of line data */
539 file_ptr line_filepos;
541 /* Pointer to data for applications */
545 struct lang_output_section *otheruserdata;
547 /* Attached line number information */
551 /* Number of line number records */
553 unsigned int lineno_count;
555 /* When a section is being output, this value changes as more
556 linenumbers are written out */
558 file_ptr moving_line_filepos;
560 /* what the section number is in the target world */
566 /* If this is a constructor section then here is a list of the
567 relocations created to relocate items within it. */
569 struct relent_chain *constructor_chain;
571 /* The BFD which owns the section. */
576 /* A symbol which points at this section only */
577 struct symbol_cache_entry *symbol;
578 struct symbol_cache_entry **symbol_ptr_ptr;
579 struct bfd_seclet_struct *seclets_head;
580 struct bfd_seclet_struct *seclets_tail;
584 #define BFD_ABS_SECTION_NAME "*ABS*"
585 #define BFD_UND_SECTION_NAME "*UND*"
586 #define BFD_COM_SECTION_NAME "*COM*"
588 /* the absolute section */
589 extern asection bfd_abs_section;
590 /* Pointer to the undefined section */
591 extern asection bfd_und_section;
592 /* Pointer to the common section */
593 extern asection bfd_com_section;
595 extern struct symbol_cache_entry *bfd_abs_symbol;
596 extern struct symbol_cache_entry *bfd_com_symbol;
597 extern struct symbol_cache_entry *bfd_und_symbol;
598 #define bfd_get_section_size_before_reloc(section) \
599 (section->reloc_done ? (abort(),1): (section)->_raw_size)
600 #define bfd_get_section_size_after_reloc(section) \
601 ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
602 asection *EXFUN(bfd_get_section_by_name, (bfd *abfd, CONST char *name));
603 asection *EXFUN(bfd_make_section_old_way, (bfd *, CONST char *name));
604 asection * EXFUN(bfd_make_section, (bfd *, CONST char *name));
605 boolean EXFUN(bfd_set_section_flags, (bfd *, asection *, flagword));
606 void EXFUN(bfd_map_over_sections, (bfd *abfd,
607 void (*func)(bfd *abfd,
611 boolean EXFUN(bfd_set_section_size, (bfd *, asection *, bfd_size_type val));
612 boolean EXFUN(bfd_set_section_contents
617 bfd_size_type count));
618 boolean EXFUN(bfd_get_section_contents
619 , (bfd *abfd, asection *section, PTR location,
620 file_ptr offset, bfd_size_type count));
621 enum bfd_architecture
623 bfd_arch_unknown, /* File arch not known */
624 bfd_arch_obscure, /* Arch known, not one of these */
625 bfd_arch_m68k, /* Motorola 68xxx */
626 bfd_arch_vax, /* DEC Vax */
627 bfd_arch_i960, /* Intel 960 */
628 /* The order of the following is important.
629 lower number indicates a machine type that
630 only accepts a subset of the instructions
631 available to machines with higher numbers.
632 The exception is the "ca", which is
633 incompatible with all other machines except
636 #define bfd_mach_i960_core 1
637 #define bfd_mach_i960_ka_sa 2
638 #define bfd_mach_i960_kb_sb 3
639 #define bfd_mach_i960_mc 4
640 #define bfd_mach_i960_xa 5
641 #define bfd_mach_i960_ca 6
643 bfd_arch_a29k, /* AMD 29000 */
644 bfd_arch_sparc, /* SPARC */
645 bfd_arch_mips, /* MIPS Rxxxx */
646 bfd_arch_i386, /* Intel 386 */
647 bfd_arch_ns32k, /* National Semiconductor 32xxx */
648 bfd_arch_tahoe, /* CCI/Harris Tahoe */
649 bfd_arch_i860, /* Intel 860 */
650 bfd_arch_romp, /* IBM ROMP PC/RT */
651 bfd_arch_alliant, /* Alliant */
652 bfd_arch_convex, /* Convex */
653 bfd_arch_m88k, /* Motorola 88xxx */
654 bfd_arch_pyramid, /* Pyramid Technology */
655 bfd_arch_h8300, /* Hitachi H8/300 */
656 bfd_arch_rs6000, /* IBM RS/6000 */
659 typedef int bfd_reloc_code_type;
661 typedef struct bfd_arch_info
664 int bits_per_address;
666 enum bfd_architecture arch;
669 CONST char *printable_name;
670 /* true if this is the default machine for the architecture */
671 unsigned int section_align_power;
673 CONST struct bfd_arch_info * EXFUN((*compatible),
674 (CONST struct bfd_arch_info *a,
675 CONST struct bfd_arch_info *b));
677 boolean EXFUN((*scan),(CONST struct bfd_arch_info *,CONST char *));
678 unsigned int EXFUN((*disassemble),(bfd_vma addr, CONST char *data,
680 CONST struct reloc_howto_struct *EXFUN((*reloc_type_lookup),
681 (CONST struct bfd_arch_info *,
682 bfd_reloc_code_type code));
684 struct bfd_arch_info *next;
686 } bfd_arch_info_type;
687 CONST char *EXFUN(bfd_printable_name, (bfd *abfd));
688 bfd_arch_info_type *EXFUN(bfd_scan_arch, (CONST char *));
689 CONST bfd_arch_info_type *EXFUN(bfd_arch_get_compatible, (
692 void EXFUN(bfd_set_arch_info, (bfd *, bfd_arch_info_type *));
693 enum bfd_architecture EXFUN(bfd_get_arch, (bfd *abfd));
694 unsigned long EXFUN(bfd_get_mach, (bfd *abfd));
695 unsigned int EXFUN(bfd_arch_bits_per_byte, (bfd *abfd));
696 unsigned int EXFUN(bfd_arch_bits_per_address, (bfd *abfd));
697 bfd_arch_info_type * EXFUN(bfd_get_arch_info, (bfd *));
698 bfd_arch_info_type *EXFUN(bfd_lookup_arch
699 , (enum bfd_architecture
702 CONST char * EXFUN(bfd_printable_arch_mach
703 , (enum bfd_architecture arch, unsigned long machine));
704 typedef enum bfd_reloc_status
706 /* No errors detected */
709 /* The relocation was performed, but there was an overflow. */
712 /* The address to relocate was not within the section supplied*/
713 bfd_reloc_outofrange,
715 /* Used by special functions */
719 bfd_reloc_notsupported,
721 /* Unsupported relocation size requested. */
724 /* The symbol to relocate against was undefined.*/
727 /* The relocation was performed, but may not be ok - presently
728 generated only when linking i960 coff files with i960 b.out
732 bfd_reloc_status_type;
735 typedef struct reloc_cache_entry
737 /* A pointer into the canonical table of pointers */
738 struct symbol_cache_entry **sym_ptr_ptr;
740 /* offset in section */
741 rawdata_offset address;
743 /* addend for relocation value */
746 /* Pointer to how to perform the required relocation */
747 CONST struct reloc_howto_struct *howto;
751 typedef CONST struct reloc_howto_struct
753 /* The type field has mainly a documetary use - the back end can
754 to what it wants with it, though the normally the back end's
755 external idea of what a reloc number would be would be stored
756 in this field. For example, the a PC relative word relocation
757 in a coff environment would have the type 023 - because that's
758 what the outside world calls a R_PCRWORD reloc. */
761 /* The value the final relocation is shifted right by. This drops
762 unwanted data from the relocation. */
763 unsigned int rightshift;
765 /* The size of the item to be relocated - 0, is one byte, 1 is 2
766 bytes, 3 is four bytes. */
770 unsigned int bitsize;
772 /* Notes that the relocation is relative to the location in the
773 data section of the addend. The relocation function will
774 subtract from the relocation value the address of the location
784 /* Causes the relocation routine to return an error if overflow
785 is detected when relocating. */
786 boolean complain_on_overflow;
788 /* If this field is non null, then the supplied function is
789 called rather than the normal function. This allows really
790 strange relocation methods to be accomodated (eg, i960 callj
792 bfd_reloc_status_type EXFUN ((*special_function),
794 arelent *reloc_entry,
795 struct symbol_cache_entry *symbol,
797 asection *input_section));
799 /* The textual name of the relocation type. */
802 /* When performing a partial link, some formats must modify the
803 relocations rather than the data - this flag signals this.*/
804 boolean partial_inplace;
806 /* The src_mask is used to select what parts of the read in data
807 are to be used in the relocation sum. Eg, if this was an 8 bit
808 bit of data which we read and relocated, this would be
809 0x000000ff. When we have relocs which have an addend, such as
810 sun4 extended relocs, the value in the offset part of a
811 relocating field is garbage so we never use it. In this case
812 the mask would be 0x00000000. */
815 /* The dst_mask is what parts of the instruction are replaced
816 into the instruction. In most cases src_mask == dst_mask,
817 except in the above special case, where dst_mask would be
818 0x000000ff, and src_mask would be 0x00000000. */
821 /* When some formats create PC relative instructions, they leave
822 the value of the pc of the place being relocated in the offset
823 slot of the instruction, so that a PC relative relocation can
824 be made just by adding in an ordinary offset (eg sun3 a.out).
825 Some formats leave the displacement part of an instruction
826 empty (eg m88k bcs), this flag signals the fact.*/
827 boolean pcrel_offset;
830 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
831 {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
832 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,IN)
834 #define HOWTO_PREPARE(relocation, symbol) \
836 if (symbol != (asymbol *)NULL) { \
837 if (symbol->section == &bfd_com_section) { \
841 relocation = symbol->value; \
845 typedef unsigned char bfd_byte;
847 typedef struct relent_chain {
849 struct relent_chain *next;
851 bfd_reloc_status_type
852 EXFUN(bfd_perform_relocation
854 arelent *reloc_entry,
856 asection *input_section,
858 typedef enum bfd_reloc_code_real
860 /* 16 bits wide, simple reloc */
863 /* 8 bits wide, but used to form an address like 0xffnn */
866 /* 8 bits wide, simple */
869 /* 8 bits wide, pc relative */
872 /* The type of reloc used to build a contructor table - at the
873 moment probably a 32 bit wide abs address, but the cpu can
877 } bfd_reloc_code_real_type;
878 CONST struct reloc_howto_struct *
879 EXFUN(bfd_reloc_type_lookup
880 , (CONST bfd_arch_info_type *arch, bfd_reloc_code_type code));
881 typedef struct symbol_cache_entry
883 /* A pointer to the BFD which owns the symbol. This information
884 is necessary so that a back end can work out what additional
885 (invisible to the application writer) information is carried
888 struct _bfd *the_bfd;
890 /* The text of the symbol. The name is left alone, and not copied - the
891 application may not alter it. */
894 /* The value of the symbol.*/
897 /* Attributes of a symbol: */
899 #define BSF_NO_FLAGS 0x00
901 /* The symbol has local scope; <<static>> in <<C>>. The value
902 is the offset into the section of the data. */
903 #define BSF_LOCAL 0x01
905 /* The symbol has global scope; initialized data in <<C>>. The
906 value is the offset into the section of the data. */
907 #define BSF_GLOBAL 0x02
910 #define BSF_IMPORT 0x04
912 /* The symbol has global scope, and is exported. The value is
913 the offset into the section of the data. */
914 #define BSF_EXPORT 0x08
916 /* The symbol is undefined. <<extern>> in <<C>>. The value has
918 #define BSF_UNDEFINED_OBS 0x10
920 /* The symbol is common, initialized to zero; default in
921 <<C>>. The value is the size of the object in bytes. */
922 #define BSF_FORT_COMM_OBS 0x20
924 /* A normal C symbol would be one of:
925 <<BSF_LOCAL>>, <<BSF_FORT_COMM>>, <<BSF_UNDEFINED>> or
926 <<BSF_EXPORT|BSD_GLOBAL>> */
928 /* The symbol is a debugging record. The value has an arbitary
930 #define BSF_DEBUGGING 0x40
932 /* Used by the linker */
933 #define BSF_KEEP 0x10000
934 #define BSF_KEEP_G 0x80000
937 #define BSF_WEAK 0x100000
938 #define BSF_CTOR 0x200000
940 /* This symbol was created to point to a section */
941 #define BSF_SECTION_SYM 0x400000
943 /* The symbol used to be a common symbol, but now it is
945 #define BSF_OLD_COMMON 0x800000
947 /* The default value for common data. */
948 #define BFD_FORT_COMM_DEFAULT_VALUE 0
950 /* In some files the type of a symbol sometimes alters its
951 location in an output file - ie in coff a <<ISFCN>> symbol
952 which is also <<C_EXT>> symbol appears where it was
953 declared and not at the end of a section. This bit is set
954 by the target BFD part to convey this information. */
956 #define BSF_NOT_AT_END 0x40000
958 /* Signal that the symbol is the label of constructor section. */
959 #define BSF_CONSTRUCTOR 0x1000000
961 /* Signal that the symbol is a warning symbol. If the symbol
962 is a warning symbol, then the value field (I know this is
963 tacky) will point to the asymbol which when referenced will
964 cause the warning. */
965 #define BSF_WARNING 0x2000000
967 /* Signal that the symbol is indirect. The value of the symbol
968 is a pointer to an undefined asymbol which contains the
969 name to use instead. */
970 #define BSF_INDIRECT 0x4000000
974 /* A pointer to the section to which this symbol is
975 relative. This will always be non NULL, there are special
976 sections for undefined and absolute symbols */
979 /* Back end special data. This is being phased out in favour
980 of making this a union. */
984 #define get_symtab_upper_bound(abfd) \
985 BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
986 #define bfd_canonicalize_symtab(abfd, location) \
987 BFD_SEND (abfd, _bfd_canonicalize_symtab,\
989 boolean EXFUN(bfd_set_symtab , (bfd *, asymbol **, unsigned int ));
990 void EXFUN(bfd_print_symbol_vandf, (PTR file, asymbol *symbol));
991 #define bfd_make_empty_symbol(abfd) \
992 BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
993 int EXFUN(bfd_decode_symclass, (asymbol *symbol));
996 /* The filename the application opened the BFD with. */
997 CONST char *filename;
999 /* A pointer to the target jump table. */
1000 struct bfd_target *xvec;
1002 /* To avoid dragging too many header files into every file that
1003 includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1004 *", and MTIME as a "long". Their correct types, to which they
1005 are cast when used, are "FILE *" and "time_t". The iostream
1006 is the result of an fopen on the filename. */
1009 /* Is the file being cached */
1013 /* Marks whether there was a default target specified when the
1014 BFD was opened. This is used to select what matching algorithm
1015 to use to chose the back end. */
1017 boolean target_defaulted;
1019 /* The caching routines use these to maintain a
1020 least-recently-used list of BFDs */
1022 struct _bfd *lru_prev, *lru_next;
1024 /* When a file is closed by the caching routines, BFD retains
1025 state information on the file here:
1032 boolean opened_once;
1034 /* Set if we have a locally maintained mtime value, rather than
1035 getting it from the file each time: */
1039 /* File modified time, if mtime_set is true: */
1043 /* Reserved for an unimplemented file locking extension.*/
1047 /* The format which belongs to the BFD.*/
1051 /* The direction the BFD was opened with*/
1053 enum bfd_direction {no_direction = 0,
1055 write_direction = 2,
1056 both_direction = 3} direction;
1058 /* Format_specific flags*/
1062 /* Currently my_archive is tested before adding origin to
1063 anything. I believe that this can become always an add of
1064 origin, with origin set to 0 for non archive files. */
1068 /* Remember when output has begun, to stop strange things
1070 boolean output_has_begun;
1072 /* Pointer to linked list of sections*/
1073 struct sec *sections;
1075 /* The number of sections */
1076 unsigned int section_count;
1078 /* Stuff only useful for object files:
1079 The start address. */
1080 bfd_vma start_address;
1082 /* Used for input and output*/
1083 unsigned int symcount;
1085 /* Symbol table for output BFD*/
1086 struct symbol_cache_entry **outsymbols;
1088 /* Pointer to structure which contains architecture information*/
1089 struct bfd_arch_info *arch_info;
1091 /* Stuff only useful for archives:*/
1093 struct _bfd *my_archive;
1095 struct _bfd *archive_head;
1098 /* Used by the back end to hold private data. */
1102 struct aout_data_struct *aout_data;
1103 struct artdata *aout_ar_data;
1104 struct _oasys_data *oasys_obj_data;
1105 struct _oasys_ar_data *oasys_ar_data;
1106 struct coff_tdata *coff_obj_data;
1107 struct ieee_data_struct *ieee_data;
1108 struct ieee_ar_data_struct *ieee_ar_data;
1109 struct srec_data_struct *srec_data;
1110 struct elf_obj_tdata_struct *elf_obj_data;
1111 struct elf_core_tdata_struct *elf_core_data;
1112 struct bout_data_struct *bout_data;
1113 struct sun_core_struct *sun_core_data;
1114 struct trad_core_struct *trad_core_data;
1118 /* Used by the application to hold private data*/
1121 /* Where all the allocated stuff under this BFD goes */
1122 struct obstack memory;
1124 asymbol **ld_symbols;
1127 unsigned int EXFUN(bfd_get_reloc_upper_bound, (bfd *abfd, asection *sect));
1128 unsigned int EXFUN(bfd_canonicalize_reloc
1133 boolean EXFUN(bfd_set_file_flags, (bfd *abfd, flagword flags));
1134 void EXFUN(bfd_set_reloc
1135 , (bfd *abfd, asection *sec, arelent **rel, unsigned int count)
1138 boolean EXFUN(bfd_set_start_address, (bfd *, bfd_vma));
1139 long EXFUN(bfd_get_mtime, (bfd *));
1140 #define bfd_sizeof_headers(abfd, reloc) \
1141 BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1143 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1144 BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
1146 #define bfd_debug_info_start(abfd) \
1147 BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1149 #define bfd_debug_info_end(abfd) \
1150 BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1152 #define bfd_debug_info_accumulate(abfd, section) \
1153 BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1155 #define bfd_stat_arch_elt(abfd, stat) \
1156 BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1158 #define bfd_coff_swap_aux_in(a,e,t,c,i) \
1159 BFD_SEND (a, _bfd_coff_swap_aux_in, (a,e,t,c,i))
1161 #define bfd_coff_swap_sym_in(a,e,i) \
1162 BFD_SEND (a, _bfd_coff_swap_sym_in, (a,e,i))
1164 #define bfd_coff_swap_lineno_in(a,e,i) \
1165 BFD_SEND ( a, _bfd_coff_swap_lineno_in, (a,e,i))
1167 #define bfd_set_arch_mach(abfd, arch, mach)\
1168 BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1170 #define bfd_coff_swap_reloc_out(abfd, i, o) \
1171 BFD_SEND (abfd, _bfd_coff_swap_reloc_out, (abfd, i, o))
1173 #define bfd_coff_swap_lineno_out(abfd, i, o) \
1174 BFD_SEND (abfd, _bfd_coff_swap_lineno_out, (abfd, i, o))
1176 #define bfd_coff_swap_aux_out(abfd, i, t,c,o) \
1177 BFD_SEND (abfd, _bfd_coff_swap_aux_out, (abfd, i,t,c, o))
1179 #define bfd_coff_swap_sym_out(abfd, i,o) \
1180 BFD_SEND (abfd, _bfd_coff_swap_sym_out, (abfd, i, o))
1182 #define bfd_coff_swap_scnhdr_out(abfd, i,o) \
1183 BFD_SEND (abfd, _bfd_coff_swap_scnhdr_out, (abfd, i, o))
1185 #define bfd_coff_swap_filehdr_out(abfd, i,o) \
1186 BFD_SEND (abfd, _bfd_coff_swap_filehdr_out, (abfd, i, o))
1188 #define bfd_coff_swap_aouthdr_out(abfd, i,o) \
1189 BFD_SEND (abfd, _bfd_coff_swap_aouthdr_out, (abfd, i, o))
1191 #define bfd_get_relocated_section_contents(abfd, seclet) \
1192 BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet))
1194 #define bfd_relax_section(abfd, section, symbols) \
1195 BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
1196 symindex EXFUN(bfd_get_next_mapent, (bfd *, symindex previous, carsym ** sym));
1197 boolean EXFUN(bfd_set_archive_head, (bfd *output, bfd *new_head));
1198 bfd *EXFUN(bfd_get_elt_at_index, (bfd * archive, int index));
1199 bfd* EXFUN(bfd_openr_next_archived_file, (bfd *archive, bfd *previous));
1200 CONST char *EXFUN(bfd_core_file_failing_command, (bfd *));
1201 int EXFUN(bfd_core_file_failing_signal, (bfd *));
1202 boolean EXFUN(core_file_matches_executable_p
1203 , (bfd *core_bfd, bfd *exec_bfd));
1204 #define SDEF(ret, name, arglist) \
1205 PROTO(ret,(*name),arglist)
1206 #define SDEF_FMT(ret, name, arglist) \
1207 PROTO(ret,(*name[bfd_type_end]),arglist)
1208 #define BFD_SEND(bfd, message, arglist) \
1209 ((*((bfd)->xvec->message)) arglist)
1210 #define BFD_SEND_FMT(bfd, message, arglist) \
1211 (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1212 typedef struct bfd_target
1215 enum target_flavour {
1216 bfd_target_unknown_flavour,
1217 bfd_target_aout_flavour,
1218 bfd_target_coff_flavour,
1219 bfd_target_elf_flavour,
1220 bfd_target_ieee_flavour,
1221 bfd_target_oasys_flavour,
1222 bfd_target_srec_flavour} flavour;
1223 boolean byteorder_big_p;
1224 boolean header_byteorder_big_p;
1225 flagword object_flags;
1226 flagword section_flags;
1228 unsigned short ar_max_namelen;
1229 unsigned int align_power_min;
1230 SDEF (bfd_vma, bfd_getx64, (bfd_byte *));
1231 SDEF (void, bfd_putx64, (bfd_vma, bfd_byte *));
1232 SDEF (bfd_vma, bfd_getx32, (bfd_byte *));
1233 SDEF (void, bfd_putx32, (bfd_vma, bfd_byte *));
1234 SDEF (bfd_vma, bfd_getx16, (bfd_byte *));
1235 SDEF (void, bfd_putx16, (bfd_vma, bfd_byte *));
1236 SDEF (bfd_vma, bfd_h_getx64, (bfd_byte *));
1237 SDEF (void, bfd_h_putx64, (bfd_vma, bfd_byte *));
1238 SDEF (bfd_vma, bfd_h_getx32, (bfd_byte *));
1239 SDEF (void, bfd_h_putx32, (bfd_vma, bfd_byte *));
1240 SDEF (bfd_vma, bfd_h_getx16, (bfd_byte *));
1241 SDEF (void, bfd_h_putx16, (bfd_vma, bfd_byte *));
1242 SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *));
1243 SDEF_FMT (boolean, _bfd_set_format, (bfd *));
1244 SDEF_FMT (boolean, _bfd_write_contents, (bfd *));
1245 SDEF (char *, _core_file_failing_command, (bfd *));
1246 SDEF (int, _core_file_failing_signal, (bfd *));
1247 SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *));
1248 SDEF (boolean, _bfd_slurp_armap, (bfd *));
1249 SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *));
1250 SDEF (void, _bfd_truncate_arname, (bfd *, CONST char *, char *));
1251 SDEF (boolean, write_armap, (bfd *arch,
1252 unsigned int elength,
1254 unsigned int orl_count,
1256 SDEF (boolean, _close_and_cleanup, (bfd *));
1257 SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR,
1258 file_ptr, bfd_size_type));
1259 SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR,
1260 file_ptr, bfd_size_type));
1261 SDEF (boolean, _new_section_hook, (bfd *, sec_ptr));
1262 SDEF (unsigned int, _get_symtab_upper_bound, (bfd *));
1263 SDEF (unsigned int, _bfd_canonicalize_symtab,
1264 (bfd *, struct symbol_cache_entry **));
1265 SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr));
1266 SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **,
1267 struct symbol_cache_entry**));
1268 SDEF (struct symbol_cache_entry *, _bfd_make_empty_symbol, (bfd *));
1269 SDEF (void, _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry *,
1270 bfd_print_symbol_type));
1271 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1272 SDEF (alent *, _get_lineno, (bfd *, struct symbol_cache_entry *));
1274 SDEF (boolean, _bfd_set_arch_mach, (bfd *, enum bfd_architecture,
1277 SDEF (bfd *, openr_next_archived_file, (bfd *arch, bfd *prev));
1278 SDEF (boolean, _bfd_find_nearest_line,
1279 (bfd *abfd, struct sec *section,
1280 struct symbol_cache_entry **symbols,bfd_vma offset,
1281 CONST char **file, CONST char **func, unsigned int *line));
1282 SDEF (int, _bfd_stat_arch_elt, (bfd *, struct stat *));
1284 SDEF (int, _bfd_sizeof_headers, (bfd *, boolean));
1286 SDEF (void, _bfd_debug_info_start, (bfd *));
1287 SDEF (void, _bfd_debug_info_end, (bfd *));
1288 SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec *));
1289 SDEF (bfd_byte *, _bfd_get_relocated_section_contents, (bfd*,struct bfd_seclet_struct *));
1290 SDEF (boolean,_bfd_relax_section,(bfd *, struct sec *, struct symbol_cache_entry **));
1291 SDEF(void, _bfd_coff_swap_aux_in,(
1298 SDEF(void, _bfd_coff_swap_sym_in,(
1303 SDEF(void, _bfd_coff_swap_lineno_in, (
1308 SDEF(unsigned int, _bfd_coff_swap_aux_out,(
1315 SDEF(unsigned int, _bfd_coff_swap_sym_out,(
1320 SDEF(unsigned int, _bfd_coff_swap_lineno_out,(
1325 SDEF(unsigned int, _bfd_coff_swap_reloc_out,(
1330 SDEF(unsigned int, _bfd_coff_swap_filehdr_out,(
1335 SDEF(unsigned int, _bfd_coff_swap_aouthdr_out,(
1340 SDEF(unsigned int, _bfd_coff_swap_scnhdr_out,(
1346 bfd_target *EXFUN(bfd_find_target, (CONST char *, bfd *));
1347 CONST char **EXFUN(bfd_target_list, (void));
1348 boolean EXFUN(bfd_check_format, (bfd *abfd, bfd_format format));
1349 boolean EXFUN(bfd_set_format, (bfd *, bfd_format));
1350 CONST char *EXFUN(bfd_format_string, (bfd_format));