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