daily update
[binutils.git] / bfd / bfd-in.h
blob827cc1a6839f0b6a21b99d824f6955826efb8228
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, 2007, 2008
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 3 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 /* This is a utility macro to handle the situation where the code
47 wants to place a constant string into the code, followed by a
48 comma and then the length of the string. Doing this by hand
49 is error prone, so using this macro is safer. */
50 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
51 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
52 to create the arguments to another macro, since the preprocessor
53 will mis-count the number of arguments to the outer macro (by not
54 evaluating STRING_COMMA_LEN and so missing the comma). This is a
55 problem for example when trying to use STRING_COMMA_LEN to build
56 the arguments to the strncmp() macro. Hence this alternative
57 definition of strncmp is provided here.
59 Note - these macros do NOT work if STR2 is not a constant string. */
60 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
61 /* strcpy() can have a similar problem, but since we know we are
62 copying a constant string, we can use memcpy which will be faster
63 since there is no need to check for a NUL byte inside STR. We
64 can also save time if we do not need to copy the terminating NUL. */
65 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
66 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
69 /* The word size used by BFD on the host. This may be 64 with a 32
70 bit target if the host is 64 bit, or if other 64 bit targets have
71 been selected with --enable-targets, or if --enable-64-bit-bfd. */
72 #define BFD_ARCH_SIZE @wordsize@
74 /* The word size of the default bfd target. */
75 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
77 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
78 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
79 #if @BFD_HOST_64_BIT_DEFINED@
80 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
81 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
82 typedef BFD_HOST_64_BIT bfd_int64_t;
83 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
84 #endif
86 #if BFD_ARCH_SIZE >= 64
87 #define BFD64
88 #endif
90 #ifndef INLINE
91 #if __GNUC__ >= 2
92 #define INLINE __inline__
93 #else
94 #define INLINE
95 #endif
96 #endif
98 /* Declaring a type wide enough to hold a host long and a host pointer. */
99 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
100 typedef BFD_HOSTPTR_T bfd_hostptr_t;
102 /* Forward declaration. */
103 typedef struct bfd bfd;
105 /* Boolean type used in bfd. Too many systems define their own
106 versions of "boolean" for us to safely typedef a "boolean" of
107 our own. Using an enum for "bfd_boolean" has its own set of
108 problems, with strange looking casts required to avoid warnings
109 on some older compilers. Thus we just use an int.
111 General rule: Functions which are bfd_boolean return TRUE on
112 success and FALSE on failure (unless they're a predicate). */
114 typedef int bfd_boolean;
115 #undef FALSE
116 #undef TRUE
117 #define FALSE 0
118 #define TRUE 1
120 #ifdef BFD64
122 #ifndef BFD_HOST_64_BIT
123 #error No 64 bit integer type available
124 #endif /* ! defined (BFD_HOST_64_BIT) */
126 typedef BFD_HOST_U_64_BIT bfd_vma;
127 typedef BFD_HOST_64_BIT bfd_signed_vma;
128 typedef BFD_HOST_U_64_BIT bfd_size_type;
129 typedef BFD_HOST_U_64_BIT symvalue;
131 #if BFD_HOST_64BIT_LONG
132 #define BFD_VMA_FMT "l"
133 #elif defined (__MSVCRT__)
134 #define BFD_VMA_FMT "I64"
135 #else
136 #define BFD_VMA_FMT "ll"
137 #endif
139 #ifndef fprintf_vma
140 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
141 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
142 #endif
144 #else /* not BFD64 */
146 /* Represent a target address. Also used as a generic unsigned type
147 which is guaranteed to be big enough to hold any arithmetic types
148 we need to deal with. */
149 typedef unsigned long bfd_vma;
151 /* A generic signed type which is guaranteed to be big enough to hold any
152 arithmetic types we need to deal with. Can be assumed to be compatible
153 with bfd_vma in the same way that signed and unsigned ints are compatible
154 (as parameters, in assignment, etc). */
155 typedef long bfd_signed_vma;
157 typedef unsigned long symvalue;
158 typedef unsigned long bfd_size_type;
160 /* Print a bfd_vma x on stream s. */
161 #define BFD_VMA_FMT "l"
162 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
163 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
165 #endif /* not BFD64 */
167 #define HALF_BFD_SIZE_TYPE \
168 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
170 #ifndef BFD_HOST_64_BIT
171 /* Fall back on a 32 bit type. The idea is to make these types always
172 available for function return types, but in the case that
173 BFD_HOST_64_BIT is undefined such a function should abort or
174 otherwise signal an error. */
175 typedef bfd_signed_vma bfd_int64_t;
176 typedef bfd_vma bfd_uint64_t;
177 #endif
179 /* An offset into a file. BFD always uses the largest possible offset
180 based on the build time availability of fseek, fseeko, or fseeko64. */
181 typedef @bfd_file_ptr@ file_ptr;
182 typedef unsigned @bfd_file_ptr@ ufile_ptr;
184 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
185 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
187 #define printf_vma(x) fprintf_vma(stdout,x)
188 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
190 typedef unsigned int flagword; /* 32 bits of flags */
191 typedef unsigned char bfd_byte;
193 /* File formats. */
195 typedef enum bfd_format
197 bfd_unknown = 0, /* File format is unknown. */
198 bfd_object, /* Linker/assembler/compiler output. */
199 bfd_archive, /* Object archive file. */
200 bfd_core, /* Core dump. */
201 bfd_type_end /* Marks the end; don't use it! */
203 bfd_format;
205 /* Symbols and relocation. */
207 /* A count of carsyms (canonical archive symbols). */
208 typedef unsigned long symindex;
210 /* How to perform a relocation. */
211 typedef const struct reloc_howto_struct reloc_howto_type;
213 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
215 /* General purpose part of a symbol X;
216 target specific parts are in libcoff.h, libaout.h, etc. */
218 #define bfd_get_section(x) ((x)->section)
219 #define bfd_get_output_section(x) ((x)->section->output_section)
220 #define bfd_set_section(x,y) ((x)->section) = (y)
221 #define bfd_asymbol_base(x) ((x)->section->vma)
222 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
223 #define bfd_asymbol_name(x) ((x)->name)
224 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
225 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
226 #define bfd_asymbol_flavour(x) \
227 (((x)->flags & BSF_SYNTHETIC) != 0 \
228 ? bfd_target_unknown_flavour \
229 : bfd_asymbol_bfd (x)->xvec->flavour)
231 /* A canonical archive symbol. */
232 /* This is a type pun with struct ranlib on purpose! */
233 typedef struct carsym
235 char *name;
236 file_ptr file_offset; /* Look here to find the file. */
238 carsym; /* To make these you call a carsymogen. */
240 /* Used in generating armaps (archive tables of contents).
241 Perhaps just a forward definition would do? */
242 struct orl /* Output ranlib. */
244 char **name; /* Symbol name. */
245 union
247 file_ptr pos;
248 bfd *abfd;
249 } u; /* bfd* or file position. */
250 int namidx; /* Index into string table. */
253 /* Linenumber stuff. */
254 typedef struct lineno_cache_entry
256 unsigned int line_number; /* Linenumber from start of function. */
257 union
259 struct bfd_symbol *sym; /* Function name. */
260 bfd_vma offset; /* Offset into section. */
261 } u;
263 alent;
265 /* Object and core file sections. */
267 #define align_power(addr, align) \
268 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
270 typedef struct bfd_section *sec_ptr;
272 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
273 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
274 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
275 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
276 #define bfd_section_name(bfd, ptr) ((ptr)->name)
277 #define bfd_section_size(bfd, ptr) ((ptr)->size)
278 #define bfd_get_section_size(ptr) ((ptr)->size)
279 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
280 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
281 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
282 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
283 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
285 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
287 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
288 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
289 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
290 /* Find the address one past the end of SEC. */
291 #define bfd_get_section_limit(bfd, sec) \
292 (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
293 / bfd_octets_per_byte (bfd))
295 /* Return TRUE if section has been discarded. */
296 #define elf_discarded_section(sec) \
297 (!bfd_is_abs_section (sec) \
298 && bfd_is_abs_section ((sec)->output_section) \
299 && (sec)->sec_info_type != ELF_INFO_TYPE_MERGE \
300 && (sec)->sec_info_type != ELF_INFO_TYPE_JUST_SYMS)
302 /* Forward define. */
303 struct stat;
305 typedef enum bfd_print_symbol
307 bfd_print_symbol_name,
308 bfd_print_symbol_more,
309 bfd_print_symbol_all
310 } bfd_print_symbol_type;
312 /* Information about a symbol that nm needs. */
314 typedef struct _symbol_info
316 symvalue value;
317 char type;
318 const char *name; /* Symbol name. */
319 unsigned char stab_type; /* Stab type. */
320 char stab_other; /* Stab other. */
321 short stab_desc; /* Stab desc. */
322 const char *stab_name; /* String for stab type. */
323 } symbol_info;
325 /* Get the name of a stabs type code. */
327 extern const char *bfd_get_stab_name (int);
329 /* Hash table routines. There is no way to free up a hash table. */
331 /* An element in the hash table. Most uses will actually use a larger
332 structure, and an instance of this will be the first field. */
334 struct bfd_hash_entry
336 /* Next entry for this hash code. */
337 struct bfd_hash_entry *next;
338 /* String being hashed. */
339 const char *string;
340 /* Hash code. This is the full hash code, not the index into the
341 table. */
342 unsigned long hash;
345 /* A hash table. */
347 struct bfd_hash_table
349 /* The hash array. */
350 struct bfd_hash_entry **table;
351 /* A function used to create new elements in the hash table. The
352 first entry is itself a pointer to an element. When this
353 function is first invoked, this pointer will be NULL. However,
354 having the pointer permits a hierarchy of method functions to be
355 built each of which calls the function in the superclass. Thus
356 each function should be written to allocate a new block of memory
357 only if the argument is NULL. */
358 struct bfd_hash_entry *(*newfunc)
359 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
360 /* An objalloc for this hash table. This is a struct objalloc *,
361 but we use void * to avoid requiring the inclusion of objalloc.h. */
362 void *memory;
363 /* The number of slots in the hash table. */
364 unsigned int size;
365 /* The number of entries in the hash table. */
366 unsigned int count;
367 /* The size of elements. */
368 unsigned int entsize;
369 /* If non-zero, don't grow the hash table. */
370 unsigned int frozen:1;
373 /* Initialize a hash table. */
374 extern bfd_boolean bfd_hash_table_init
375 (struct bfd_hash_table *,
376 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
377 struct bfd_hash_table *,
378 const char *),
379 unsigned int);
381 /* Initialize a hash table specifying a size. */
382 extern bfd_boolean bfd_hash_table_init_n
383 (struct bfd_hash_table *,
384 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
385 struct bfd_hash_table *,
386 const char *),
387 unsigned int, unsigned int);
389 /* Free up a hash table. */
390 extern void bfd_hash_table_free
391 (struct bfd_hash_table *);
393 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
394 will be created for this string if one does not already exist. The
395 COPY argument must be TRUE if this routine should copy the string
396 into newly allocated memory when adding an entry. */
397 extern struct bfd_hash_entry *bfd_hash_lookup
398 (struct bfd_hash_table *, const char *, bfd_boolean create,
399 bfd_boolean copy);
401 /* Insert an entry in a hash table. */
402 extern struct bfd_hash_entry *bfd_hash_insert
403 (struct bfd_hash_table *, const char *, unsigned long);
405 /* Replace an entry in a hash table. */
406 extern void bfd_hash_replace
407 (struct bfd_hash_table *, struct bfd_hash_entry *old,
408 struct bfd_hash_entry *nw);
410 /* Base method for creating a hash table entry. */
411 extern struct bfd_hash_entry *bfd_hash_newfunc
412 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
414 /* Grab some space for a hash table entry. */
415 extern void *bfd_hash_allocate
416 (struct bfd_hash_table *, unsigned int);
418 /* Traverse a hash table in a random order, calling a function on each
419 element. If the function returns FALSE, the traversal stops. The
420 INFO argument is passed to the function. */
421 extern void bfd_hash_traverse
422 (struct bfd_hash_table *,
423 bfd_boolean (*) (struct bfd_hash_entry *, void *),
424 void *info);
426 /* Allows the default size of a hash table to be configured. New hash
427 tables allocated using bfd_hash_table_init will be created with
428 this size. */
429 extern void bfd_hash_set_default_size (bfd_size_type);
431 /* This structure is used to keep track of stabs in sections
432 information while linking. */
434 struct stab_info
436 /* A hash table used to hold stabs strings. */
437 struct bfd_strtab_hash *strings;
438 /* The header file hash table. */
439 struct bfd_hash_table includes;
440 /* The first .stabstr section. */
441 struct bfd_section *stabstr;
444 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
446 /* User program access to BFD facilities. */
448 /* Direct I/O routines, for programs which know more about the object
449 file than BFD does. Use higher level routines if possible. */
451 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
452 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
453 extern int bfd_seek (bfd *, file_ptr, int);
454 extern file_ptr bfd_tell (bfd *);
455 extern int bfd_flush (bfd *);
456 extern int bfd_stat (bfd *, struct stat *);
458 /* Deprecated old routines. */
459 #if __GNUC__
460 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
461 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
462 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
463 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
464 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
465 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
466 #else
467 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
468 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
469 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
470 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
471 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
472 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
473 #endif
474 extern void warn_deprecated (const char *, const char *, int, const char *);
476 /* Cast from const char * to char * so that caller can assign to
477 a char * without a warning. */
478 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
479 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
480 #define bfd_get_format(abfd) ((abfd)->format)
481 #define bfd_get_target(abfd) ((abfd)->xvec->name)
482 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
483 #define bfd_family_coff(abfd) \
484 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
485 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
486 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
487 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
488 #define bfd_header_big_endian(abfd) \
489 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
490 #define bfd_header_little_endian(abfd) \
491 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
492 #define bfd_get_file_flags(abfd) ((abfd)->flags)
493 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
494 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
495 #define bfd_my_archive(abfd) ((abfd)->my_archive)
496 #define bfd_has_map(abfd) ((abfd)->has_armap)
497 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
499 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
500 #define bfd_usrdata(abfd) ((abfd)->usrdata)
502 #define bfd_get_start_address(abfd) ((abfd)->start_address)
503 #define bfd_get_symcount(abfd) ((abfd)->symcount)
504 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
505 #define bfd_count_sections(abfd) ((abfd)->section_count)
507 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
509 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
511 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
513 extern bfd_boolean bfd_cache_close
514 (bfd *abfd);
515 /* NB: This declaration should match the autogenerated one in libbfd.h. */
517 extern bfd_boolean bfd_cache_close_all (void);
519 extern bfd_boolean bfd_record_phdr
520 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
521 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
523 /* Byte swapping routines. */
525 bfd_uint64_t bfd_getb64 (const void *);
526 bfd_uint64_t bfd_getl64 (const void *);
527 bfd_int64_t bfd_getb_signed_64 (const void *);
528 bfd_int64_t bfd_getl_signed_64 (const void *);
529 bfd_vma bfd_getb32 (const void *);
530 bfd_vma bfd_getl32 (const void *);
531 bfd_signed_vma bfd_getb_signed_32 (const void *);
532 bfd_signed_vma bfd_getl_signed_32 (const void *);
533 bfd_vma bfd_getb16 (const void *);
534 bfd_vma bfd_getl16 (const void *);
535 bfd_signed_vma bfd_getb_signed_16 (const void *);
536 bfd_signed_vma bfd_getl_signed_16 (const void *);
537 void bfd_putb64 (bfd_uint64_t, void *);
538 void bfd_putl64 (bfd_uint64_t, void *);
539 void bfd_putb32 (bfd_vma, void *);
540 void bfd_putl32 (bfd_vma, void *);
541 void bfd_putb16 (bfd_vma, void *);
542 void bfd_putl16 (bfd_vma, void *);
544 /* Byte swapping routines which take size and endiannes as arguments. */
546 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
547 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
549 extern bfd_boolean bfd_section_already_linked_table_init (void);
550 extern void bfd_section_already_linked_table_free (void);
552 /* Externally visible ECOFF routines. */
554 #if defined(__STDC__) || defined(ALMOST_STDC)
555 struct ecoff_debug_info;
556 struct ecoff_debug_swap;
557 struct ecoff_extr;
558 struct bfd_symbol;
559 struct bfd_link_info;
560 struct bfd_link_hash_entry;
561 struct bfd_elf_version_tree;
562 #endif
563 extern bfd_vma bfd_ecoff_get_gp_value
564 (bfd * abfd);
565 extern bfd_boolean bfd_ecoff_set_gp_value
566 (bfd *abfd, bfd_vma gp_value);
567 extern bfd_boolean bfd_ecoff_set_regmasks
568 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
569 unsigned long *cprmask);
570 extern void *bfd_ecoff_debug_init
571 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
572 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
573 extern void bfd_ecoff_debug_free
574 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
575 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
576 extern bfd_boolean bfd_ecoff_debug_accumulate
577 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
578 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
579 struct ecoff_debug_info *input_debug,
580 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
581 extern bfd_boolean bfd_ecoff_debug_accumulate_other
582 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
583 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
584 struct bfd_link_info *);
585 extern bfd_boolean bfd_ecoff_debug_externals
586 (bfd *abfd, struct ecoff_debug_info *debug,
587 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
588 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
589 void (*set_index) (struct bfd_symbol *, bfd_size_type));
590 extern bfd_boolean bfd_ecoff_debug_one_external
591 (bfd *abfd, struct ecoff_debug_info *debug,
592 const struct ecoff_debug_swap *swap, const char *name,
593 struct ecoff_extr *esym);
594 extern bfd_size_type bfd_ecoff_debug_size
595 (bfd *abfd, struct ecoff_debug_info *debug,
596 const struct ecoff_debug_swap *swap);
597 extern bfd_boolean bfd_ecoff_write_debug
598 (bfd *abfd, struct ecoff_debug_info *debug,
599 const struct ecoff_debug_swap *swap, file_ptr where);
600 extern bfd_boolean bfd_ecoff_write_accumulated_debug
601 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
602 const struct ecoff_debug_swap *swap,
603 struct bfd_link_info *info, file_ptr where);
605 /* Externally visible ELF routines. */
607 struct bfd_link_needed_list
609 struct bfd_link_needed_list *next;
610 bfd *by;
611 const char *name;
614 enum dynamic_lib_link_class {
615 DYN_NORMAL = 0,
616 DYN_AS_NEEDED = 1,
617 DYN_DT_NEEDED = 2,
618 DYN_NO_ADD_NEEDED = 4,
619 DYN_NO_NEEDED = 8
622 enum notice_asneeded_action {
623 notice_as_needed,
624 notice_not_needed,
625 notice_needed
628 extern bfd_boolean bfd_elf_record_link_assignment
629 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
630 bfd_boolean);
631 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
632 (bfd *, struct bfd_link_info *);
633 extern bfd_boolean bfd_elf_get_bfd_needed_list
634 (bfd *, struct bfd_link_needed_list **);
635 extern bfd_boolean bfd_elf_size_dynamic_sections
636 (bfd *, const char *, const char *, const char *, const char * const *,
637 struct bfd_link_info *, struct bfd_section **,
638 struct bfd_elf_version_tree *);
639 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
640 (bfd *, struct bfd_link_info *);
641 extern void bfd_elf_set_dt_needed_name
642 (bfd *, const char *);
643 extern const char *bfd_elf_get_dt_soname
644 (bfd *);
645 extern void bfd_elf_set_dyn_lib_class
646 (bfd *, enum dynamic_lib_link_class);
647 extern int bfd_elf_get_dyn_lib_class
648 (bfd *);
649 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
650 (bfd *, struct bfd_link_info *);
651 extern bfd_boolean bfd_elf_discard_info
652 (bfd *, struct bfd_link_info *);
653 extern unsigned int _bfd_elf_default_action_discarded
654 (struct bfd_section *);
656 /* Return an upper bound on the number of bytes required to store a
657 copy of ABFD's program header table entries. Return -1 if an error
658 occurs; bfd_get_error will return an appropriate code. */
659 extern long bfd_get_elf_phdr_upper_bound
660 (bfd *abfd);
662 /* Copy ABFD's program header table entries to *PHDRS. The entries
663 will be stored as an array of Elf_Internal_Phdr structures, as
664 defined in include/elf/internal.h. To find out how large the
665 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
667 Return the number of program header table entries read, or -1 if an
668 error occurs; bfd_get_error will return an appropriate code. */
669 extern int bfd_get_elf_phdrs
670 (bfd *abfd, void *phdrs);
672 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
673 reconstruct an ELF file by reading the segments out of remote memory
674 based on the ELF file header at EHDR_VMA and the ELF program headers it
675 points to. If not null, *LOADBASEP is filled in with the difference
676 between the VMAs from which the segments were read, and the VMAs the
677 file headers (and hence BFD's idea of each section's VMA) put them at.
679 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
680 remote memory at target address VMA into the local buffer at MYADDR; it
681 should return zero on success or an `errno' code on failure. TEMPL must
682 be a BFD for an ELF target with the word size and byte order found in
683 the remote memory. */
684 extern bfd *bfd_elf_bfd_from_remote_memory
685 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
686 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
688 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
689 extern int bfd_get_arch_size
690 (bfd *);
692 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
693 extern int bfd_get_sign_extend_vma
694 (bfd *);
696 extern struct bfd_section *_bfd_elf_tls_setup
697 (bfd *, struct bfd_link_info *);
699 extern void _bfd_fix_excluded_sec_syms
700 (bfd *, struct bfd_link_info *);
702 extern unsigned bfd_m68k_mach_to_features (int);
704 extern int bfd_m68k_features_to_mach (unsigned);
706 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
707 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
708 char **);
710 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
712 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
713 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
714 char **);
716 /* SunOS shared library support routines for the linker. */
718 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
719 (bfd *, struct bfd_link_info *);
720 extern bfd_boolean bfd_sunos_record_link_assignment
721 (bfd *, struct bfd_link_info *, const char *);
722 extern bfd_boolean bfd_sunos_size_dynamic_sections
723 (bfd *, struct bfd_link_info *, struct bfd_section **,
724 struct bfd_section **, struct bfd_section **);
726 /* Linux shared library support routines for the linker. */
728 extern bfd_boolean bfd_i386linux_size_dynamic_sections
729 (bfd *, struct bfd_link_info *);
730 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
731 (bfd *, struct bfd_link_info *);
732 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
733 (bfd *, struct bfd_link_info *);
735 /* mmap hacks */
737 struct _bfd_window_internal;
738 typedef struct _bfd_window_internal bfd_window_internal;
740 typedef struct _bfd_window
742 /* What the user asked for. */
743 void *data;
744 bfd_size_type size;
745 /* The actual window used by BFD. Small user-requested read-only
746 regions sharing a page may share a single window into the object
747 file. Read-write versions shouldn't until I've fixed things to
748 keep track of which portions have been claimed by the
749 application; don't want to give the same region back when the
750 application wants two writable copies! */
751 struct _bfd_window_internal *i;
753 bfd_window;
755 extern void bfd_init_window
756 (bfd_window *);
757 extern void bfd_free_window
758 (bfd_window *);
759 extern bfd_boolean bfd_get_file_window
760 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
762 /* XCOFF support routines for the linker. */
764 extern bfd_boolean bfd_xcoff_link_record_set
765 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
766 extern bfd_boolean bfd_xcoff_import_symbol
767 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
768 const char *, const char *, const char *, unsigned int);
769 extern bfd_boolean bfd_xcoff_export_symbol
770 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
771 extern bfd_boolean bfd_xcoff_link_count_reloc
772 (bfd *, struct bfd_link_info *, const char *);
773 extern bfd_boolean bfd_xcoff_record_link_assignment
774 (bfd *, struct bfd_link_info *, const char *);
775 extern bfd_boolean bfd_xcoff_size_dynamic_sections
776 (bfd *, struct bfd_link_info *, const char *, const char *,
777 unsigned long, unsigned long, unsigned long, bfd_boolean,
778 int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
779 extern bfd_boolean bfd_xcoff_link_generate_rtinit
780 (bfd *, const char *, const char *, bfd_boolean);
782 /* XCOFF support routines for ar. */
783 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
784 (bfd *, char *);
786 /* Externally visible COFF routines. */
788 #if defined(__STDC__) || defined(ALMOST_STDC)
789 struct internal_syment;
790 union internal_auxent;
791 #endif
793 extern bfd_boolean bfd_coff_get_syment
794 (bfd *, struct bfd_symbol *, struct internal_syment *);
796 extern bfd_boolean bfd_coff_get_auxent
797 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
799 extern bfd_boolean bfd_coff_set_symbol_class
800 (bfd *, struct bfd_symbol *, unsigned int);
802 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
803 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
805 /* ARM VFP11 erratum workaround support. */
806 typedef enum
808 BFD_ARM_VFP11_FIX_DEFAULT,
809 BFD_ARM_VFP11_FIX_NONE,
810 BFD_ARM_VFP11_FIX_SCALAR,
811 BFD_ARM_VFP11_FIX_VECTOR
812 } bfd_arm_vfp11_fix;
814 extern void bfd_elf32_arm_init_maps
815 (bfd *);
817 extern void bfd_elf32_arm_set_vfp11_fix
818 (bfd *, struct bfd_link_info *);
820 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
821 (bfd *, struct bfd_link_info *);
823 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
824 (bfd *, struct bfd_link_info *);
826 /* ARM Interworking support. Called from linker. */
827 extern bfd_boolean bfd_arm_allocate_interworking_sections
828 (struct bfd_link_info *);
830 extern bfd_boolean bfd_arm_process_before_allocation
831 (bfd *, struct bfd_link_info *, int);
833 extern bfd_boolean bfd_arm_get_bfd_for_interworking
834 (bfd *, struct bfd_link_info *);
836 /* PE ARM Interworking support. Called from linker. */
837 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
838 (struct bfd_link_info *);
840 extern bfd_boolean bfd_arm_pe_process_before_allocation
841 (bfd *, struct bfd_link_info *, int);
843 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
844 (bfd *, struct bfd_link_info *);
846 /* ELF ARM Interworking support. Called from linker. */
847 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
848 (struct bfd_link_info *);
850 extern bfd_boolean bfd_elf32_arm_process_before_allocation
851 (bfd *, struct bfd_link_info *);
853 void bfd_elf32_arm_set_target_relocs
854 (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix,
855 int, int, int);
857 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
858 (bfd *, struct bfd_link_info *);
860 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
861 (bfd *, struct bfd_link_info *);
863 /* ELF ARM mapping symbol support */
864 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
865 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
866 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
867 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
868 extern bfd_boolean bfd_is_arm_special_symbol_name
869 (const char * name, int type);
871 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
873 /* ARM Note section processing. */
874 extern bfd_boolean bfd_arm_merge_machines
875 (bfd *, bfd *);
877 extern bfd_boolean bfd_arm_update_notes
878 (bfd *, const char *);
880 extern unsigned int bfd_arm_get_mach_from_notes
881 (bfd *, const char *);
883 /* ARM stub generation support. Called from the linker. */
884 extern int elf32_arm_setup_section_lists
885 (bfd *, struct bfd_link_info *);
886 extern void elf32_arm_next_input_section
887 (struct bfd_link_info *, struct bfd_section *);
888 extern bfd_boolean elf32_arm_size_stubs
889 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
890 struct bfd_section * (*) (const char *, struct bfd_section *), void (*) (void));
891 extern bfd_boolean elf32_arm_build_stubs
892 (struct bfd_link_info *);
894 /* TI COFF load page support. */
895 extern void bfd_ticoff_set_section_load_page
896 (struct bfd_section *, int);
898 extern int bfd_ticoff_get_section_load_page
899 (struct bfd_section *);
901 /* H8/300 functions. */
902 extern bfd_vma bfd_h8300_pad_address
903 (bfd *, bfd_vma);
905 /* IA64 Itanium code generation. Called from linker. */
906 extern void bfd_elf32_ia64_after_parse
907 (int);
909 extern void bfd_elf64_ia64_after_parse
910 (int);
912 /* This structure is used for a comdat section, as in PE. A comdat
913 section is associated with a particular symbol. When the linker
914 sees a comdat section, it keeps only one of the sections with a
915 given name and associated with a given symbol. */
917 struct coff_comdat_info
919 /* The name of the symbol associated with a comdat section. */
920 const char *name;
922 /* The local symbol table index of the symbol associated with a
923 comdat section. This is only meaningful to the object file format
924 specific code; it is not an index into the list returned by
925 bfd_canonicalize_symtab. */
926 long symbol;
929 extern struct coff_comdat_info *bfd_coff_get_comdat_section
930 (bfd *, struct bfd_section *);