1 /* Main header file for the bfd library -- portable access to object files.
2 Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 ** NOTE: bfd.h and bfd-in2.h are GENERATED files. Don't change them;
6 ** instead, change bfd-in.h or the other BFD source files processed to
7 ** generate these files.
9 This file is part of BFD, the Binary File Descriptor library.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
25 /* bfd.h -- The only header file required by users of the bfd library
27 The bfd.h file is generated from bfd-in.h and various .c files; if you
28 change it, your changes will probably be lost.
30 All the prototypes and definitions following the comment "THE FOLLOWING
31 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
32 BFD. If you change it, someone oneday will extract it from the source
33 again, and your changes will be lost. To save yourself from this bind,
34 change the definitions in the source in the bfd directory. Type "make
35 docs" and then "make headers" in that directory, and magically this file
36 will change to reflect your changes.
38 If you don't have the tools to perform the extraction, then you are
39 safe from someone on your system trampling over your header files.
40 You should still maintain the equivalence between the source and this
41 file though; every change you make to the .c file should be reflected
44 #ifndef __BFD_H_SEEN__
45 #define __BFD_H_SEEN__
50 #define BFD_VERSION "2.2"
52 #define BFD_ARCH_SIZE @WORDSIZE@
54 #if BFD_ARCH_SIZE >= 64
60 #define INLINE __inline__
66 /* 64-bit type definition (if any) from bfd's sysdep.h goes here */
69 /* forward declaration */
70 typedef struct _bfd bfd;
72 /* To squelch erroneous compiler warnings ("illegal pointer
73 combination") from the SVR3 compiler, we would like to typedef
74 boolean to int (it doesn't like functions which return boolean.
75 Making sure they are never implicitly declared to return int
76 doesn't seem to help). But this file is not configured based on
78 /* General rules: functions which are boolean return true on success
79 and false on failure (unless they're a predicate). -- bfd.doc */
80 /* I'm sure this is going to break something and someone is going to
81 force me to change it. */
82 /* typedef enum boolean {false, true} boolean; */
83 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h> -fnf */
84 /* It gets worse if the host also defines a true/false enum... -sts */
85 #ifndef TRUE_FALSE_ALREADY_DEFINED
86 typedef enum bfd_boolean {false, true} boolean;
87 #define BFD_TRUE_FALSE
89 typedef enum bfd_boolean {bfd_false, bfd_true} boolean;
92 /* A pointer to a position in a file. */
93 /* FIXME: This should be using off_t from <sys/types.h>.
94 For now, try to avoid breaking stuff by not including <sys/types.h> here.
95 This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
96 Probably the best long-term answer is to avoid using file_ptr AND off_t
97 in this header file, and to handle this in the BFD implementation
98 rather than in its interface. */
99 /* typedef off_t file_ptr; */
100 typedef long int file_ptr;
102 /* Support for different sizes of target format ints and addresses. If the
103 host implements 64-bit values, it defines HOST_64_BIT to be the appropriate
104 type. Otherwise, this code will fall back on gcc's "long long" type if gcc
105 is being used. HOST_64_BIT must be defined in such a way as to be a valid
106 type name by itself or with "unsigned" prefixed. It should be a signed
109 If neither is the case, then compilation will fail if 64-bit targets are
110 requested. If you don't request any 64-bit targets, you should be safe. */
114 #if defined (__GNUC__) && !defined (HOST_64_BIT)
115 #define HOST_64_BIT long long
116 typedef HOST_64_BIT int64_type;
117 typedef unsigned HOST_64_BIT uint64_type;
120 #if !defined (uint64_type) && defined (__GNUC__)
121 #define uint64_type unsigned long long
122 #define int64_type long long
124 #ifndef uint64_typeLOW
125 #define uint64_typeLOW(x) ((unsigned long)(((x) & 0xffffffff)))
126 #define uint64_typeHIGH(x) ((unsigned long)(((x) >> 32) & 0xffffffff))
129 typedef unsigned HOST_64_BIT bfd_vma;
130 typedef HOST_64_BIT bfd_signed_vma;
131 typedef unsigned HOST_64_BIT bfd_size_type;
132 typedef unsigned HOST_64_BIT symvalue;
134 #define fprintf_vma(s,x) \
135 fprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
136 #define sprintf_vma(s,x) \
137 sprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
139 #else /* not BFD64 */
141 /* Represent a target address. Also used as a generic unsigned type
142 which is guaranteed to be big enough to hold any arithmetic types
143 we need to deal with. */
144 typedef unsigned long bfd_vma;
146 /* A generic signed type which is guaranteed to be big enough to hold any
147 arithmetic types we need to deal with. Can be assumed to be compatible
148 with bfd_vma in the same way that signed and unsigned ints are compatible
149 (as parameters, in assignment, etc). */
150 typedef long bfd_signed_vma;
152 typedef unsigned long symvalue;
153 typedef unsigned long bfd_size_type;
155 /* Print a bfd_vma x on stream s. */
156 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
157 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
158 #endif /* not BFD64 */
159 #define printf_vma(x) fprintf_vma(stdout,x)
161 typedef unsigned int flagword; /* 32 bits of flags */
165 typedef enum bfd_format {
166 bfd_unknown = 0, /* file format is unknown */
167 bfd_object, /* linker/assember/compiler output */
168 bfd_archive, /* object archive file */
169 bfd_core, /* core dump */
170 bfd_type_end} /* marks the end; don't use it! */
173 /* Values that may appear in the flags field of a BFD. These also
174 appear in the object_flags field of the bfd_target structure, where
175 they indicate the set of flags used by that backend (not all flags
176 are meaningful for all object file formats) (FIXME: at the moment,
177 the object_flags values have mostly just been copied from backend
178 to another, and are not necessarily correct). */
181 #define NO_FLAGS 0x00
183 /* BFD contains relocation entries. */
184 #define HAS_RELOC 0x01
186 /* BFD is directly executable. */
189 /* BFD has line number information (basically used for F_LNNO in a
191 #define HAS_LINENO 0x04
193 /* BFD has debugging information. */
194 #define HAS_DEBUG 0x08
196 /* BFD has symbols. */
197 #define HAS_SYMS 0x10
199 /* BFD has local symbols (basically used for F_LSYMS in a COFF
201 #define HAS_LOCALS 0x20
203 /* BFD is a dynamic object. */
206 /* Text section is write protected (if D_PAGED is not set, this is
207 like an a.out NMAGIC file) (the linker sets this by default, but
208 clears it for -r or -N). */
211 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
212 linker sets this by default, but clears it for -r or -n or -N). */
213 #define D_PAGED 0x100
215 /* BFD is relaxable (this means that bfd_relax_section may be able to
217 #define BFD_IS_RELAXABLE 0x200
219 /* symbols and relocation */
221 typedef unsigned long symindex;
223 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
225 typedef enum bfd_symclass {
226 bfd_symclass_unknown = 0,
227 bfd_symclass_fcommon, /* fortran common symbols */
228 bfd_symclass_global, /* global symbol, what a surprise */
229 bfd_symclass_debugger, /* some debugger symbol */
230 bfd_symclass_undefined /* none known */
234 /* general purpose part of a symbol;
235 target specific parts will be found in libcoff.h, liba.out.h etc */
238 #define bfd_get_section(x) ((x)->section)
239 #define bfd_get_output_section(x) ((x)->section->output_section)
240 #define bfd_set_section(x,y) ((x)->section) = (y)
241 #define bfd_asymbol_base(x) ((x)->section->vma)
242 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
243 #define bfd_asymbol_name(x) ((x)->name)
244 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
245 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
246 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
248 /* This is a type pun with struct ranlib on purpose! */
249 typedef struct carsym {
251 file_ptr file_offset; /* look here to find the file */
252 } carsym; /* to make these you call a carsymogen */
255 /* Used in generating armaps. Perhaps just a forward definition would do? */
256 struct orl { /* output ranlib */
257 char **name; /* symbol name */
258 file_ptr pos; /* bfd* or file position */
259 int namidx; /* index into string table */
264 /* Linenumber stuff */
265 typedef struct lineno_cache_entry {
266 unsigned int line_number; /* Linenumber from start of function*/
268 struct symbol_cache_entry *sym; /* Function name */
269 unsigned long offset; /* Offset into section */
273 /* object and core file sections */
276 #define align_power(addr, align) \
277 ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
279 typedef struct sec *sec_ptr;
281 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
282 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
283 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
284 #define bfd_section_name(bfd, ptr) ((ptr)->name)
285 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
286 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
287 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
288 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
289 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
291 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
293 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
294 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
295 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
297 typedef struct stat stat_type;
301 typedef enum bfd_error
310 no_more_archived_files,
313 file_ambiguously_recognized,
315 nonrepresentable_section,
322 extern bfd_ec bfd_error;
324 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
325 void bfd_perror PARAMS ((CONST char *message));
328 typedef enum bfd_print_symbol
330 bfd_print_symbol_name,
331 bfd_print_symbol_more,
333 } bfd_print_symbol_type;
336 /* Information about a symbol that nm needs. */
338 typedef struct _symbol_info
342 CONST char *name; /* Symbol name. */
343 char stab_other; /* Unused. */
344 short stab_desc; /* Info for N_TYPE. */
345 CONST char *stab_name;
348 /* Hash table routines. There is no way to free up a hash table. */
350 /* An element in the hash table. Most uses will actually use a larger
351 structure, and an instance of this will be the first field. */
353 struct bfd_hash_entry
355 /* Next entry for this hash code. */
356 struct bfd_hash_entry *next;
357 /* String being hashed. */
359 /* Hash code. This is the full hash code, not the index into the
366 struct bfd_hash_table
368 /* The hash array. */
369 struct bfd_hash_entry **table;
370 /* The number of slots in the hash table. */
372 /* A function used to create new elements in the hash table. The
373 first entry is itself a pointer to an element. When this
374 function is first invoked, this pointer will be NULL. However,
375 having the pointer permits a hierarchy of method functions to be
376 built each of which calls the function in the superclass. Thus
377 each function should be written to allocate a new block of memory
378 only if the argument is NULL. */
379 struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
380 struct bfd_hash_table *,
382 /* An obstack for this hash table. */
383 struct obstack memory;
386 /* Initialize a hash table. */
387 extern boolean bfd_hash_table_init
388 PARAMS ((struct bfd_hash_table *,
389 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
390 struct bfd_hash_table *,
393 /* Initialize a hash table specifying a size. */
394 extern boolean bfd_hash_table_init_n
395 PARAMS ((struct bfd_hash_table *,
396 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
397 struct bfd_hash_table *,
401 /* Free up a hash table. */
402 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
404 /* Look up a string in a hash table. If CREATE is true, a new entry
405 will be created for this string if one does not already exist. The
406 COPY argument must be true if this routine should copy the string
407 into newly allocated memory when adding an entry. */
408 extern struct bfd_hash_entry *bfd_hash_lookup
409 PARAMS ((struct bfd_hash_table *, const char *, boolean create,
412 /* Base method for creating a hash table entry. */
413 extern struct bfd_hash_entry *bfd_hash_newfunc
414 PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
417 /* Grab some space for a hash table entry. */
418 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
421 /* Traverse a hash table in a random order, calling a function on each
422 element. If the function returns false, the traversal stops. The
423 INFO argument is passed to the function. */
424 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
425 boolean (*) (struct bfd_hash_entry *,
429 /* The code that implements targets can initialize a jump table with this
430 macro. It must name all its routines the same way (a prefix plus
431 the standard routine suffix), or it must #define the routines that
432 are not so named, before calling JUMP_TABLE in the initializer. */
434 /* Semi-portable string concatenation in cpp.
435 The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
436 The problem is, "32_" is not a valid preprocessing token, and we don't
437 want extra underscores (e.g., "nlm_32_"). The XCAT2 macro will cause the
438 inner CAT macros to be evaluated first, producing still-valid pp-tokens.
439 Then the final concatenation can be done. (Sigh.) */
442 #define CAT(a,b) a##b
443 #define CAT3(a,b,c) a##b##c
444 #define CAT4(a,b,c,d) a##b##c##d
446 #if defined(__STDC__) || defined(ALMOST_STDC)
447 #define CAT(a,b) a##b
448 #define CAT3(a,b,c) a##b##c
449 #define XCAT2(a,b) CAT(a,b)
450 #define CAT4(a,b,c,d) XCAT2(CAT(a,b),CAT(c,d))
452 #define CAT(a,b) a/**/b
453 #define CAT3(a,b,c) a/**/b/**/c
454 #define CAT4(a,b,c,d) a/**/b/**/c/**/d
459 #define JUMP_TABLE(NAME)\
460 CAT(NAME,_core_file_failing_command),\
461 CAT(NAME,_core_file_failing_signal),\
462 CAT(NAME,_core_file_matches_executable_p),\
463 CAT(NAME,_slurp_armap),\
464 CAT(NAME,_slurp_extended_name_table),\
465 CAT(NAME,_truncate_arname),\
466 CAT(NAME,_write_armap),\
467 CAT(NAME,_close_and_cleanup),\
468 CAT(NAME,_set_section_contents),\
469 CAT(NAME,_get_section_contents),\
470 CAT(NAME,_new_section_hook),\
471 CAT(NAME,_get_symtab_upper_bound),\
472 CAT(NAME,_get_symtab),\
473 CAT(NAME,_get_reloc_upper_bound),\
474 CAT(NAME,_canonicalize_reloc),\
475 CAT(NAME,_make_empty_symbol),\
476 CAT(NAME,_print_symbol),\
477 CAT(NAME,_get_symbol_info),\
478 CAT(NAME,_get_lineno),\
479 CAT(NAME,_set_arch_mach),\
480 CAT(NAME,_openr_next_archived_file),\
481 CAT(NAME,_find_nearest_line),\
482 CAT(NAME,_generic_stat_arch_elt),\
483 CAT(NAME,_sizeof_headers),\
484 CAT(NAME,_bfd_debug_info_start),\
485 CAT(NAME,_bfd_debug_info_end),\
486 CAT(NAME,_bfd_debug_info_accumulate),\
487 CAT(NAME,_bfd_get_relocated_section_contents),\
488 CAT(NAME,_bfd_relax_section),\
489 CAT(NAME,_bfd_reloc_type_lookup),\
490 CAT(NAME,_bfd_make_debug_symbol),\
491 CAT(NAME,_bfd_link_hash_table_create),\
492 CAT(NAME,_bfd_link_add_symbols),\
493 CAT(NAME,_bfd_final_link)
495 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
498 /* User program access to BFD facilities */
500 /* Cast from const char * to char * so that caller can assign to
501 a char * without a warning. */
502 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
503 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
504 #define bfd_get_format(abfd) ((abfd)->format)
505 #define bfd_get_target(abfd) ((abfd)->xvec->name)
506 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
507 #define bfd_get_file_flags(abfd) ((abfd)->flags)
508 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
509 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
510 #define bfd_my_archive(abfd) ((abfd)->my_archive)
511 #define bfd_has_map(abfd) ((abfd)->has_armap)
513 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
514 #define bfd_usrdata(abfd) ((abfd)->usrdata)
516 #define bfd_get_start_address(abfd) ((abfd)->start_address)
517 #define bfd_get_symcount(abfd) ((abfd)->symcount)
518 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
519 #define bfd_count_sections(abfd) ((abfd)->section_count)
521 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
523 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (bool)), true)
525 /* Byte swapping routines. */
527 bfd_vma bfd_getb64 PARAMS ((const unsigned char *));
528 bfd_vma bfd_getl64 PARAMS ((const unsigned char *));
529 bfd_signed_vma bfd_getb_signed_64 PARAMS ((const unsigned char *));
530 bfd_signed_vma bfd_getl_signed_64 PARAMS ((const unsigned char *));
531 bfd_vma bfd_getb32 PARAMS ((const unsigned char *));
532 bfd_vma bfd_getl32 PARAMS ((const unsigned char *));
533 bfd_signed_vma bfd_getb_signed_32 PARAMS ((const unsigned char *));
534 bfd_signed_vma bfd_getl_signed_32 PARAMS ((const unsigned char *));
535 bfd_vma bfd_getb16 PARAMS ((const unsigned char *));
536 bfd_vma bfd_getl16 PARAMS ((const unsigned char *));
537 bfd_signed_vma bfd_getb_signed_16 PARAMS ((const unsigned char *));
538 bfd_signed_vma bfd_getl_signed_16 PARAMS ((const unsigned char *));
539 void bfd_putb64 PARAMS ((bfd_vma, unsigned char *));
540 void bfd_putl64 PARAMS ((bfd_vma, unsigned char *));
541 void bfd_putb32 PARAMS ((bfd_vma, unsigned char *));
542 void bfd_putl32 PARAMS ((bfd_vma, unsigned char *));
543 void bfd_putb16 PARAMS ((bfd_vma, unsigned char *));
544 void bfd_putl16 PARAMS ((bfd_vma, unsigned char *));
546 /* ECOFF linking routines. */
547 #if defined(__STDC__) || defined(ALMOST_STDC)
548 struct ecoff_debug_info;
549 struct ecoff_debug_swap;
551 struct symbol_cache_entry;
552 struct bfd_link_info;
554 extern PTR bfd_ecoff_debug_init
555 PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
556 const struct ecoff_debug_swap *output_swap,
557 struct bfd_link_info *));
558 extern void bfd_ecoff_debug_free
559 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
560 const struct ecoff_debug_swap *output_swap,
561 struct bfd_link_info *));
562 extern boolean bfd_ecoff_debug_accumulate
563 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
564 const struct ecoff_debug_swap *output_swap,
565 bfd *input_bfd, struct ecoff_debug_info *input_debug,
566 const struct ecoff_debug_swap *input_swap,
567 struct bfd_link_info *));
568 extern boolean bfd_ecoff_debug_accumulate_other
569 PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
570 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
571 struct bfd_link_info *));
572 extern boolean bfd_ecoff_debug_externals
573 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
574 const struct ecoff_debug_swap *swap,
575 boolean relocateable,
576 boolean (*get_extr) (struct symbol_cache_entry *,
577 struct ecoff_extr *),
578 void (*set_index) (struct symbol_cache_entry *,
580 extern boolean bfd_ecoff_debug_one_external
581 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
582 const struct ecoff_debug_swap *swap,
583 const char *name, struct ecoff_extr *esym));
584 extern bfd_size_type bfd_ecoff_debug_size
585 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
586 const struct ecoff_debug_swap *swap));
587 extern boolean bfd_ecoff_write_debug
588 PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
589 const struct ecoff_debug_swap *swap, file_ptr where));
590 extern boolean bfd_ecoff_write_accumulated_debug
591 PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
592 const struct ecoff_debug_swap *swap,
593 struct bfd_link_info *info, file_ptr where));
595 /* And more from the source. */