Configury changes: update src repository (binutils, gdb, and rda) to use
[binutils.git] / bfd / bfd-in.h
blobff9dcd604fa8cd37c1f1a4c946de5220386646e0
1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
5 Free Software Foundation, Inc.
7 Contributed by Cygnus Support.
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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
25 #ifndef __BFD_H_SEEN__
26 #define __BFD_H_SEEN__
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
32 #include "ansidecl.h"
33 #include "symcat.h"
34 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
35 #ifndef SABER
36 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
37 The problem is, "32_" is not a valid preprocessing token, and we don't
38 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
39 cause the inner CONCAT2 macros to be evaluated first, producing
40 still-valid pp-tokens. Then the final concatenation can be done. */
41 #undef CONCAT4
42 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
43 #endif
44 #endif
46 /* The word size used by BFD on the host. This may be 64 with a 32
47 bit target if the host is 64 bit, or if other 64 bit targets have
48 been selected with --enable-targets, or if --enable-64-bit-bfd. */
49 #define BFD_ARCH_SIZE @wordsize@
51 /* The word size of the default bfd target. */
52 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
54 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
55 #define BFD_HOST_LONG_LONG @BFD_HOST_LONG_LONG@
56 #if @BFD_HOST_64_BIT_DEFINED@
57 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
58 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
59 typedef BFD_HOST_64_BIT bfd_int64_t;
60 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
61 #endif
63 #if BFD_ARCH_SIZE >= 64
64 #define BFD64
65 #endif
67 #ifndef INLINE
68 #if __GNUC__ >= 2
69 #define INLINE __inline__
70 #else
71 #define INLINE
72 #endif
73 #endif
75 /* Forward declaration. */
76 typedef struct bfd bfd;
78 /* Boolean type used in bfd. Too many systems define their own
79 versions of "boolean" for us to safely typedef a "boolean" of
80 our own. Using an enum for "bfd_boolean" has its own set of
81 problems, with strange looking casts required to avoid warnings
82 on some older compilers. Thus we just use an int.
84 General rule: Functions which are bfd_boolean return TRUE on
85 success and FALSE on failure (unless they're a predicate). */
87 typedef int bfd_boolean;
88 #undef FALSE
89 #undef TRUE
90 #define FALSE 0
91 #define TRUE 1
93 #ifdef BFD64
95 #ifndef BFD_HOST_64_BIT
96 #error No 64 bit integer type available
97 #endif /* ! defined (BFD_HOST_64_BIT) */
99 typedef BFD_HOST_U_64_BIT bfd_vma;
100 typedef BFD_HOST_64_BIT bfd_signed_vma;
101 typedef BFD_HOST_U_64_BIT bfd_size_type;
102 typedef BFD_HOST_U_64_BIT symvalue;
104 #ifndef fprintf_vma
105 #if BFD_HOST_64BIT_LONG
106 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
107 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
108 #else
109 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
110 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
111 #define fprintf_vma(s,x) \
112 fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
113 #define sprintf_vma(s,x) \
114 sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
115 #endif
116 #endif
118 #else /* not BFD64 */
120 /* Represent a target address. Also used as a generic unsigned type
121 which is guaranteed to be big enough to hold any arithmetic types
122 we need to deal with. */
123 typedef unsigned long bfd_vma;
125 /* A generic signed type which is guaranteed to be big enough to hold any
126 arithmetic types we need to deal with. Can be assumed to be compatible
127 with bfd_vma in the same way that signed and unsigned ints are compatible
128 (as parameters, in assignment, etc). */
129 typedef long bfd_signed_vma;
131 typedef unsigned long symvalue;
132 typedef unsigned long bfd_size_type;
134 /* Print a bfd_vma x on stream s. */
135 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
136 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
138 #endif /* not BFD64 */
140 #define HALF_BFD_SIZE_TYPE \
141 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
143 #ifndef BFD_HOST_64_BIT
144 /* Fall back on a 32 bit type. The idea is to make these types always
145 available for function return types, but in the case that
146 BFD_HOST_64_BIT is undefined such a function should abort or
147 otherwise signal an error. */
148 typedef bfd_signed_vma bfd_int64_t;
149 typedef bfd_vma bfd_uint64_t;
150 #endif
152 /* An offset into a file. BFD always uses the largest possible offset
153 based on the build time availability of fseek, fseeko, or fseeko64. */
154 typedef @bfd_file_ptr@ file_ptr;
155 typedef unsigned @bfd_file_ptr@ ufile_ptr;
157 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
158 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
160 #define printf_vma(x) fprintf_vma(stdout,x)
161 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
163 typedef unsigned int flagword; /* 32 bits of flags */
164 typedef unsigned char bfd_byte;
166 /* File formats. */
168 typedef enum bfd_format
170 bfd_unknown = 0, /* File format is unknown. */
171 bfd_object, /* Linker/assembler/compiler output. */
172 bfd_archive, /* Object archive file. */
173 bfd_core, /* Core dump. */
174 bfd_type_end /* Marks the end; don't use it! */
176 bfd_format;
178 /* Values that may appear in the flags field of a BFD. These also
179 appear in the object_flags field of the bfd_target structure, where
180 they indicate the set of flags used by that backend (not all flags
181 are meaningful for all object file formats) (FIXME: at the moment,
182 the object_flags values have mostly just been copied from backend
183 to another, and are not necessarily correct). */
185 /* No flags. */
186 #define BFD_NO_FLAGS 0x00
188 /* BFD contains relocation entries. */
189 #define HAS_RELOC 0x01
191 /* BFD is directly executable. */
192 #define EXEC_P 0x02
194 /* BFD has line number information (basically used for F_LNNO in a
195 COFF header). */
196 #define HAS_LINENO 0x04
198 /* BFD has debugging information. */
199 #define HAS_DEBUG 0x08
201 /* BFD has symbols. */
202 #define HAS_SYMS 0x10
204 /* BFD has local symbols (basically used for F_LSYMS in a COFF
205 header). */
206 #define HAS_LOCALS 0x20
208 /* BFD is a dynamic object. */
209 #define DYNAMIC 0x40
211 /* Text section is write protected (if D_PAGED is not set, this is
212 like an a.out NMAGIC file) (the linker sets this by default, but
213 clears it for -r or -N). */
214 #define WP_TEXT 0x80
216 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
217 linker sets this by default, but clears it for -r or -n or -N). */
218 #define D_PAGED 0x100
220 /* BFD is relaxable (this means that bfd_relax_section may be able to
221 do something) (sometimes bfd_relax_section can do something even if
222 this is not set). */
223 #define BFD_IS_RELAXABLE 0x200
225 /* This may be set before writing out a BFD to request using a
226 traditional format. For example, this is used to request that when
227 writing out an a.out object the symbols not be hashed to eliminate
228 duplicates. */
229 #define BFD_TRADITIONAL_FORMAT 0x400
231 /* This flag indicates that the BFD contents are actually cached in
232 memory. If this is set, iostream points to a bfd_in_memory struct. */
233 #define BFD_IN_MEMORY 0x800
235 /* The sections in this BFD specify a memory page. */
236 #define HAS_LOAD_PAGE 0x1000
238 /* This BFD has been created by the linker and doesn't correspond
239 to any input file. */
240 #define BFD_LINKER_CREATED 0x2000
242 /* Symbols and relocation. */
244 /* A count of carsyms (canonical archive symbols). */
245 typedef unsigned long symindex;
247 /* How to perform a relocation. */
248 typedef const struct reloc_howto_struct reloc_howto_type;
250 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
252 /* General purpose part of a symbol X;
253 target specific parts are in libcoff.h, libaout.h, etc. */
255 #define bfd_get_section(x) ((x)->section)
256 #define bfd_get_output_section(x) ((x)->section->output_section)
257 #define bfd_set_section(x,y) ((x)->section) = (y)
258 #define bfd_asymbol_base(x) ((x)->section->vma)
259 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
260 #define bfd_asymbol_name(x) ((x)->name)
261 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
262 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
263 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
265 /* A canonical archive symbol. */
266 /* This is a type pun with struct ranlib on purpose! */
267 typedef struct carsym
269 char *name;
270 file_ptr file_offset; /* Look here to find the file. */
272 carsym; /* To make these you call a carsymogen. */
274 /* Used in generating armaps (archive tables of contents).
275 Perhaps just a forward definition would do? */
276 struct orl /* Output ranlib. */
278 char **name; /* Symbol name. */
279 union
281 file_ptr pos;
282 bfd *abfd;
283 } u; /* bfd* or file position. */
284 int namidx; /* Index into string table. */
287 /* Linenumber stuff. */
288 typedef struct lineno_cache_entry
290 unsigned int line_number; /* Linenumber from start of function. */
291 union
293 struct bfd_symbol *sym; /* Function name. */
294 bfd_vma offset; /* Offset into section. */
295 } u;
297 alent;
299 /* Object and core file sections. */
301 #define align_power(addr, align) \
302 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
304 typedef struct bfd_section *sec_ptr;
306 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
307 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
308 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
309 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
310 #define bfd_section_name(bfd, ptr) ((ptr)->name)
311 #define bfd_section_size(bfd, ptr) ((ptr)->size)
312 #define bfd_get_section_size(ptr) ((ptr)->size)
313 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
314 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
315 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
316 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
317 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
319 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
321 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
322 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
323 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
324 /* Find the address one past the end of SEC. */
325 #define bfd_get_section_limit(bfd, sec) \
326 (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
327 / bfd_octets_per_byte (bfd))
329 typedef struct stat stat_type;
331 typedef enum bfd_print_symbol
333 bfd_print_symbol_name,
334 bfd_print_symbol_more,
335 bfd_print_symbol_all
336 } bfd_print_symbol_type;
338 /* Information about a symbol that nm needs. */
340 typedef struct _symbol_info
342 symvalue value;
343 char type;
344 const char *name; /* Symbol name. */
345 unsigned char stab_type; /* Stab type. */
346 char stab_other; /* Stab other. */
347 short stab_desc; /* Stab desc. */
348 const char *stab_name; /* String for stab type. */
349 } symbol_info;
351 /* Get the name of a stabs type code. */
353 extern const char *bfd_get_stab_name (int);
355 /* Hash table routines. There is no way to free up a hash table. */
357 /* An element in the hash table. Most uses will actually use a larger
358 structure, and an instance of this will be the first field. */
360 struct bfd_hash_entry
362 /* Next entry for this hash code. */
363 struct bfd_hash_entry *next;
364 /* String being hashed. */
365 const char *string;
366 /* Hash code. This is the full hash code, not the index into the
367 table. */
368 unsigned long hash;
371 /* A hash table. */
373 struct bfd_hash_table
375 /* The hash array. */
376 struct bfd_hash_entry **table;
377 /* The number of slots in the hash table. */
378 unsigned int size;
379 /* The number of entries in the hash table. */
380 unsigned int count;
381 /* The size of elements. */
382 unsigned int entsize;
383 /* A function used to create new elements in the hash table. The
384 first entry is itself a pointer to an element. When this
385 function is first invoked, this pointer will be NULL. However,
386 having the pointer permits a hierarchy of method functions to be
387 built each of which calls the function in the superclass. Thus
388 each function should be written to allocate a new block of memory
389 only if the argument is NULL. */
390 struct bfd_hash_entry *(*newfunc)
391 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
392 /* An objalloc for this hash table. This is a struct objalloc *,
393 but we use void * to avoid requiring the inclusion of objalloc.h. */
394 void *memory;
397 /* Initialize a hash table. */
398 extern bfd_boolean bfd_hash_table_init
399 (struct bfd_hash_table *,
400 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
401 struct bfd_hash_table *,
402 const char *),
403 unsigned int);
405 /* Initialize a hash table specifying a size. */
406 extern bfd_boolean bfd_hash_table_init_n
407 (struct bfd_hash_table *,
408 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
409 struct bfd_hash_table *,
410 const char *),
411 unsigned int, unsigned int);
413 /* Free up a hash table. */
414 extern void bfd_hash_table_free
415 (struct bfd_hash_table *);
417 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
418 will be created for this string if one does not already exist. The
419 COPY argument must be TRUE if this routine should copy the string
420 into newly allocated memory when adding an entry. */
421 extern struct bfd_hash_entry *bfd_hash_lookup
422 (struct bfd_hash_table *, const char *, bfd_boolean create,
423 bfd_boolean copy);
425 /* Replace an entry in a hash table. */
426 extern void bfd_hash_replace
427 (struct bfd_hash_table *, struct bfd_hash_entry *old,
428 struct bfd_hash_entry *nw);
430 /* Base method for creating a hash table entry. */
431 extern struct bfd_hash_entry *bfd_hash_newfunc
432 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
434 /* Grab some space for a hash table entry. */
435 extern void *bfd_hash_allocate
436 (struct bfd_hash_table *, unsigned int);
438 /* Traverse a hash table in a random order, calling a function on each
439 element. If the function returns FALSE, the traversal stops. The
440 INFO argument is passed to the function. */
441 extern void bfd_hash_traverse
442 (struct bfd_hash_table *,
443 bfd_boolean (*) (struct bfd_hash_entry *, void *),
444 void *info);
446 /* Allows the default size of a hash table to be configured. New hash
447 tables allocated using bfd_hash_table_init will be created with
448 this size. */
449 extern void bfd_hash_set_default_size (bfd_size_type);
451 /* This structure is used to keep track of stabs in sections
452 information while linking. */
454 struct stab_info
456 /* A hash table used to hold stabs strings. */
457 struct bfd_strtab_hash *strings;
458 /* The header file hash table. */
459 struct bfd_hash_table includes;
460 /* The first .stabstr section. */
461 struct bfd_section *stabstr;
464 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
466 /* User program access to BFD facilities. */
468 /* Direct I/O routines, for programs which know more about the object
469 file than BFD does. Use higher level routines if possible. */
471 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
472 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
473 extern int bfd_seek (bfd *, file_ptr, int);
474 extern file_ptr bfd_tell (bfd *);
475 extern int bfd_flush (bfd *);
476 extern int bfd_stat (bfd *, struct stat *);
478 /* Deprecated old routines. */
479 #if __GNUC__
480 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
481 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
482 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
483 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
484 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
485 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
486 #else
487 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
488 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
489 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
490 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
491 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
492 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
493 #endif
494 extern void warn_deprecated (const char *, const char *, int, const char *);
496 /* Cast from const char * to char * so that caller can assign to
497 a char * without a warning. */
498 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
499 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
500 #define bfd_get_format(abfd) ((abfd)->format)
501 #define bfd_get_target(abfd) ((abfd)->xvec->name)
502 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
503 #define bfd_family_coff(abfd) \
504 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
505 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
506 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
507 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
508 #define bfd_header_big_endian(abfd) \
509 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
510 #define bfd_header_little_endian(abfd) \
511 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
512 #define bfd_get_file_flags(abfd) ((abfd)->flags)
513 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
514 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
515 #define bfd_my_archive(abfd) ((abfd)->my_archive)
516 #define bfd_has_map(abfd) ((abfd)->has_armap)
518 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
519 #define bfd_usrdata(abfd) ((abfd)->usrdata)
521 #define bfd_get_start_address(abfd) ((abfd)->start_address)
522 #define bfd_get_symcount(abfd) ((abfd)->symcount)
523 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
524 #define bfd_count_sections(abfd) ((abfd)->section_count)
526 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
528 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
530 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
532 extern bfd_boolean bfd_cache_close
533 (bfd *abfd);
534 /* NB: This declaration should match the autogenerated one in libbfd.h. */
536 extern bfd_boolean bfd_cache_close_all (void);
538 extern bfd_boolean bfd_record_phdr
539 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
540 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
542 /* Byte swapping routines. */
544 bfd_uint64_t bfd_getb64 (const void *);
545 bfd_uint64_t bfd_getl64 (const void *);
546 bfd_int64_t bfd_getb_signed_64 (const void *);
547 bfd_int64_t bfd_getl_signed_64 (const void *);
548 bfd_vma bfd_getb32 (const void *);
549 bfd_vma bfd_getl32 (const void *);
550 bfd_signed_vma bfd_getb_signed_32 (const void *);
551 bfd_signed_vma bfd_getl_signed_32 (const void *);
552 bfd_vma bfd_getb16 (const void *);
553 bfd_vma bfd_getl16 (const void *);
554 bfd_signed_vma bfd_getb_signed_16 (const void *);
555 bfd_signed_vma bfd_getl_signed_16 (const void *);
556 void bfd_putb64 (bfd_uint64_t, void *);
557 void bfd_putl64 (bfd_uint64_t, void *);
558 void bfd_putb32 (bfd_vma, void *);
559 void bfd_putl32 (bfd_vma, void *);
560 void bfd_putb16 (bfd_vma, void *);
561 void bfd_putl16 (bfd_vma, void *);
563 /* Byte swapping routines which take size and endiannes as arguments. */
565 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
566 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
568 extern bfd_boolean bfd_section_already_linked_table_init (void);
569 extern void bfd_section_already_linked_table_free (void);
571 /* Externally visible ECOFF routines. */
573 #if defined(__STDC__) || defined(ALMOST_STDC)
574 struct ecoff_debug_info;
575 struct ecoff_debug_swap;
576 struct ecoff_extr;
577 struct bfd_symbol;
578 struct bfd_link_info;
579 struct bfd_link_hash_entry;
580 struct bfd_elf_version_tree;
581 #endif
582 extern bfd_vma bfd_ecoff_get_gp_value
583 (bfd * abfd);
584 extern bfd_boolean bfd_ecoff_set_gp_value
585 (bfd *abfd, bfd_vma gp_value);
586 extern bfd_boolean bfd_ecoff_set_regmasks
587 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
588 unsigned long *cprmask);
589 extern void *bfd_ecoff_debug_init
590 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
591 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
592 extern void bfd_ecoff_debug_free
593 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
594 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
595 extern bfd_boolean bfd_ecoff_debug_accumulate
596 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
597 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
598 struct ecoff_debug_info *input_debug,
599 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
600 extern bfd_boolean bfd_ecoff_debug_accumulate_other
601 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
602 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
603 struct bfd_link_info *);
604 extern bfd_boolean bfd_ecoff_debug_externals
605 (bfd *abfd, struct ecoff_debug_info *debug,
606 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
607 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
608 void (*set_index) (struct bfd_symbol *, bfd_size_type));
609 extern bfd_boolean bfd_ecoff_debug_one_external
610 (bfd *abfd, struct ecoff_debug_info *debug,
611 const struct ecoff_debug_swap *swap, const char *name,
612 struct ecoff_extr *esym);
613 extern bfd_size_type bfd_ecoff_debug_size
614 (bfd *abfd, struct ecoff_debug_info *debug,
615 const struct ecoff_debug_swap *swap);
616 extern bfd_boolean bfd_ecoff_write_debug
617 (bfd *abfd, struct ecoff_debug_info *debug,
618 const struct ecoff_debug_swap *swap, file_ptr where);
619 extern bfd_boolean bfd_ecoff_write_accumulated_debug
620 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
621 const struct ecoff_debug_swap *swap,
622 struct bfd_link_info *info, file_ptr where);
624 /* Externally visible ELF routines. */
626 struct bfd_link_needed_list
628 struct bfd_link_needed_list *next;
629 bfd *by;
630 const char *name;
633 enum dynamic_lib_link_class {
634 DYN_NORMAL = 0,
635 DYN_AS_NEEDED = 1,
636 DYN_DT_NEEDED = 2,
637 DYN_NO_ADD_NEEDED = 4,
638 DYN_NO_NEEDED = 8
641 extern bfd_boolean bfd_elf_record_link_assignment
642 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
643 bfd_boolean);
644 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
645 (bfd *, struct bfd_link_info *);
646 extern bfd_boolean bfd_elf_get_bfd_needed_list
647 (bfd *, struct bfd_link_needed_list **);
648 extern bfd_boolean bfd_elf_size_dynamic_sections
649 (bfd *, const char *, const char *, const char *, const char * const *,
650 struct bfd_link_info *, struct bfd_section **,
651 struct bfd_elf_version_tree *);
652 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
653 (bfd *, struct bfd_link_info *);
654 extern void bfd_elf_set_dt_needed_name
655 (bfd *, const char *);
656 extern const char *bfd_elf_get_dt_soname
657 (bfd *);
658 extern void bfd_elf_set_dyn_lib_class
659 (bfd *, int);
660 extern int bfd_elf_get_dyn_lib_class
661 (bfd *);
662 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
663 (bfd *, struct bfd_link_info *);
664 extern bfd_boolean bfd_elf_discard_info
665 (bfd *, struct bfd_link_info *);
666 extern unsigned int _bfd_elf_default_action_discarded
667 (struct bfd_section *);
669 /* Return an upper bound on the number of bytes required to store a
670 copy of ABFD's program header table entries. Return -1 if an error
671 occurs; bfd_get_error will return an appropriate code. */
672 extern long bfd_get_elf_phdr_upper_bound
673 (bfd *abfd);
675 /* Copy ABFD's program header table entries to *PHDRS. The entries
676 will be stored as an array of Elf_Internal_Phdr structures, as
677 defined in include/elf/internal.h. To find out how large the
678 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
680 Return the number of program header table entries read, or -1 if an
681 error occurs; bfd_get_error will return an appropriate code. */
682 extern int bfd_get_elf_phdrs
683 (bfd *abfd, void *phdrs);
685 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
686 reconstruct an ELF file by reading the segments out of remote memory
687 based on the ELF file header at EHDR_VMA and the ELF program headers it
688 points to. If not null, *LOADBASEP is filled in with the difference
689 between the VMAs from which the segments were read, and the VMAs the
690 file headers (and hence BFD's idea of each section's VMA) put them at.
692 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
693 remote memory at target address VMA into the local buffer at MYADDR; it
694 should return zero on success or an `errno' code on failure. TEMPL must
695 be a BFD for an ELF target with the word size and byte order found in
696 the remote memory. */
697 extern bfd *bfd_elf_bfd_from_remote_memory
698 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
699 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
701 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
702 extern int bfd_get_arch_size
703 (bfd *);
705 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
706 extern int bfd_get_sign_extend_vma
707 (bfd *);
709 extern struct bfd_section *_bfd_elf_tls_setup
710 (bfd *, struct bfd_link_info *);
712 extern void _bfd_fix_excluded_sec_syms
713 (bfd *, struct bfd_link_info *);
715 extern unsigned bfd_m68k_mach_to_features (int);
717 extern int bfd_m68k_features_to_mach (unsigned);
719 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
720 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
721 char **);
723 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
724 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
725 char **);
727 /* SunOS shared library support routines for the linker. */
729 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
730 (bfd *, struct bfd_link_info *);
731 extern bfd_boolean bfd_sunos_record_link_assignment
732 (bfd *, struct bfd_link_info *, const char *);
733 extern bfd_boolean bfd_sunos_size_dynamic_sections
734 (bfd *, struct bfd_link_info *, struct bfd_section **,
735 struct bfd_section **, struct bfd_section **);
737 /* Linux shared library support routines for the linker. */
739 extern bfd_boolean bfd_i386linux_size_dynamic_sections
740 (bfd *, struct bfd_link_info *);
741 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
742 (bfd *, struct bfd_link_info *);
743 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
744 (bfd *, struct bfd_link_info *);
746 /* mmap hacks */
748 struct _bfd_window_internal;
749 typedef struct _bfd_window_internal bfd_window_internal;
751 typedef struct _bfd_window
753 /* What the user asked for. */
754 void *data;
755 bfd_size_type size;
756 /* The actual window used by BFD. Small user-requested read-only
757 regions sharing a page may share a single window into the object
758 file. Read-write versions shouldn't until I've fixed things to
759 keep track of which portions have been claimed by the
760 application; don't want to give the same region back when the
761 application wants two writable copies! */
762 struct _bfd_window_internal *i;
764 bfd_window;
766 extern void bfd_init_window
767 (bfd_window *);
768 extern void bfd_free_window
769 (bfd_window *);
770 extern bfd_boolean bfd_get_file_window
771 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
773 /* XCOFF support routines for the linker. */
775 extern bfd_boolean bfd_xcoff_link_record_set
776 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
777 extern bfd_boolean bfd_xcoff_import_symbol
778 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
779 const char *, const char *, const char *, unsigned int);
780 extern bfd_boolean bfd_xcoff_export_symbol
781 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
782 extern bfd_boolean bfd_xcoff_link_count_reloc
783 (bfd *, struct bfd_link_info *, const char *);
784 extern bfd_boolean bfd_xcoff_record_link_assignment
785 (bfd *, struct bfd_link_info *, const char *);
786 extern bfd_boolean bfd_xcoff_size_dynamic_sections
787 (bfd *, struct bfd_link_info *, const char *, const char *,
788 unsigned long, unsigned long, unsigned long, bfd_boolean,
789 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
790 extern bfd_boolean bfd_xcoff_link_generate_rtinit
791 (bfd *, const char *, const char *, bfd_boolean);
793 /* XCOFF support routines for ar. */
794 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
795 (bfd *, char *);
797 /* Externally visible COFF routines. */
799 #if defined(__STDC__) || defined(ALMOST_STDC)
800 struct internal_syment;
801 union internal_auxent;
802 #endif
804 extern bfd_boolean bfd_coff_get_syment
805 (bfd *, struct bfd_symbol *, struct internal_syment *);
807 extern bfd_boolean bfd_coff_get_auxent
808 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
810 extern bfd_boolean bfd_coff_set_symbol_class
811 (bfd *, struct bfd_symbol *, unsigned int);
813 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
814 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
816 /* ARM Interworking support. Called from linker. */
817 extern bfd_boolean bfd_arm_allocate_interworking_sections
818 (struct bfd_link_info *);
820 extern bfd_boolean bfd_arm_process_before_allocation
821 (bfd *, struct bfd_link_info *, int);
823 extern bfd_boolean bfd_arm_get_bfd_for_interworking
824 (bfd *, struct bfd_link_info *);
826 /* PE ARM Interworking support. Called from linker. */
827 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
828 (struct bfd_link_info *);
830 extern bfd_boolean bfd_arm_pe_process_before_allocation
831 (bfd *, struct bfd_link_info *, int);
833 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
834 (bfd *, struct bfd_link_info *);
836 /* ELF ARM Interworking support. Called from linker. */
837 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
838 (struct bfd_link_info *);
840 extern bfd_boolean bfd_elf32_arm_process_before_allocation
841 (bfd *, struct bfd_link_info *, int);
843 void bfd_elf32_arm_set_target_relocs
844 (struct bfd_link_info *, int, char *, int, int);
846 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
847 (bfd *, struct bfd_link_info *);
849 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
850 (bfd *, struct bfd_link_info *);
852 /* ELF ARM mapping symbol support */
853 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
854 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
855 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
856 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
857 extern bfd_boolean bfd_is_arm_special_symbol_name
858 (const char * name, int type);
860 /* ARM Note section processing. */
861 extern bfd_boolean bfd_arm_merge_machines
862 (bfd *, bfd *);
864 extern bfd_boolean bfd_arm_update_notes
865 (bfd *, const char *);
867 extern unsigned int bfd_arm_get_mach_from_notes
868 (bfd *, const char *);
870 /* TI COFF load page support. */
871 extern void bfd_ticoff_set_section_load_page
872 (struct bfd_section *, int);
874 extern int bfd_ticoff_get_section_load_page
875 (struct bfd_section *);
877 /* H8/300 functions. */
878 extern bfd_vma bfd_h8300_pad_address
879 (bfd *, bfd_vma);
881 /* IA64 Itanium code generation. Called from linker. */
882 extern void bfd_elf32_ia64_after_parse
883 (int);
885 extern void bfd_elf64_ia64_after_parse
886 (int);
888 /* This structure is used for a comdat section, as in PE. A comdat
889 section is associated with a particular symbol. When the linker
890 sees a comdat section, it keeps only one of the sections with a
891 given name and associated with a given symbol. */
893 struct coff_comdat_info
895 /* The name of the symbol associated with a comdat section. */
896 const char *name;
898 /* The local symbol table index of the symbol associated with a
899 comdat section. This is only meaningful to the object file format
900 specific code; it is not an index into the list returned by
901 bfd_canonicalize_symtab. */
902 long symbol;
905 extern struct coff_comdat_info *bfd_coff_get_comdat_section
906 (bfd *, struct bfd_section *);