1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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__
34 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
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. */
42 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
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;
88 #if BFD_ARCH_SIZE >= 64
94 #define INLINE __inline__
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;
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"
138 #define BFD_VMA_FMT "ll"
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)
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;
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;
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! */
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
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. */
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. */
261 struct bfd_symbol *sym; /* Function name. */
262 bfd_vma offset; /* Offset into section. */
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 (((bfd)->direction != write_direction && (sec)->rawsize != 0 \
295 ? (sec)->rawsize : (sec)->size) / 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. */
307 typedef enum bfd_print_symbol
309 bfd_print_symbol_name,
310 bfd_print_symbol_more,
312 } bfd_print_symbol_type;
314 /* Information about a symbol that nm needs. */
316 typedef struct _symbol_info
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. */
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. */
342 /* Hash code. This is the full hash code, not the index into the
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. */
365 /* The number of slots in the hash table. */
367 /* The number of entries in the hash table. */
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 *,
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 *,
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,
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 *),
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
435 extern unsigned long bfd_hash_set_default_size (unsigned long);
437 /* This structure is used to keep track of stabs in sections
438 information while linking. */
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. */
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)))
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)))
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
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 #if defined(__STDC__) || defined(ALMOST_STDC)
556 struct ecoff_debug_info;
557 struct ecoff_debug_swap;
560 struct bfd_link_info;
561 struct bfd_link_hash_entry;
562 struct bfd_section_already_linked;
563 struct bfd_elf_version_tree;
566 extern bfd_boolean bfd_section_already_linked_table_init (void);
567 extern void bfd_section_already_linked_table_free (void);
568 extern bfd_boolean _bfd_handle_already_linked
569 (struct bfd_section *, struct bfd_section_already_linked *,
570 struct bfd_link_info *);
572 /* Externally visible ECOFF routines. */
574 extern bfd_vma bfd_ecoff_get_gp_value
576 extern bfd_boolean bfd_ecoff_set_gp_value
577 (bfd *abfd, bfd_vma gp_value);
578 extern bfd_boolean bfd_ecoff_set_regmasks
579 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
580 unsigned long *cprmask);
581 extern void *bfd_ecoff_debug_init
582 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
583 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
584 extern void bfd_ecoff_debug_free
585 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
586 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
587 extern bfd_boolean bfd_ecoff_debug_accumulate
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 ecoff_debug_info *input_debug,
591 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
592 extern bfd_boolean bfd_ecoff_debug_accumulate_other
593 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
594 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
595 struct bfd_link_info *);
596 extern bfd_boolean bfd_ecoff_debug_externals
597 (bfd *abfd, struct ecoff_debug_info *debug,
598 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
599 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
600 void (*set_index) (struct bfd_symbol *, bfd_size_type));
601 extern bfd_boolean bfd_ecoff_debug_one_external
602 (bfd *abfd, struct ecoff_debug_info *debug,
603 const struct ecoff_debug_swap *swap, const char *name,
604 struct ecoff_extr *esym);
605 extern bfd_size_type bfd_ecoff_debug_size
606 (bfd *abfd, struct ecoff_debug_info *debug,
607 const struct ecoff_debug_swap *swap);
608 extern bfd_boolean bfd_ecoff_write_debug
609 (bfd *abfd, struct ecoff_debug_info *debug,
610 const struct ecoff_debug_swap *swap, file_ptr where);
611 extern bfd_boolean bfd_ecoff_write_accumulated_debug
612 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
613 const struct ecoff_debug_swap *swap,
614 struct bfd_link_info *info, file_ptr where);
616 /* Externally visible ELF routines. */
618 struct bfd_link_needed_list
620 struct bfd_link_needed_list *next;
625 enum dynamic_lib_link_class {
629 DYN_NO_ADD_NEEDED = 4,
633 enum notice_asneeded_action {
639 extern bfd_boolean bfd_elf_record_link_assignment
640 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
642 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
643 (bfd *, struct bfd_link_info *);
644 extern bfd_boolean bfd_elf_get_bfd_needed_list
645 (bfd *, struct bfd_link_needed_list **);
646 extern bfd_boolean bfd_elf_size_dynamic_sections
647 (bfd *, const char *, const char *, const char *, const char *, const char *,
648 const char * const *, struct bfd_link_info *, struct bfd_section **);
649 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
650 (bfd *, struct bfd_link_info *);
651 extern void bfd_elf_set_dt_needed_name
652 (bfd *, const char *);
653 extern const char *bfd_elf_get_dt_soname
655 extern void bfd_elf_set_dyn_lib_class
656 (bfd *, enum dynamic_lib_link_class);
657 extern int bfd_elf_get_dyn_lib_class
659 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
660 (bfd *, struct bfd_link_info *);
661 extern bfd_boolean bfd_elf_discard_info
662 (bfd *, struct bfd_link_info *);
663 extern unsigned int _bfd_elf_default_action_discarded
664 (struct bfd_section *);
666 /* Return an upper bound on the number of bytes required to store a
667 copy of ABFD's program header table entries. Return -1 if an error
668 occurs; bfd_get_error will return an appropriate code. */
669 extern long bfd_get_elf_phdr_upper_bound
672 /* Copy ABFD's program header table entries to *PHDRS. The entries
673 will be stored as an array of Elf_Internal_Phdr structures, as
674 defined in include/elf/internal.h. To find out how large the
675 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
677 Return the number of program header table entries read, or -1 if an
678 error occurs; bfd_get_error will return an appropriate code. */
679 extern int bfd_get_elf_phdrs
680 (bfd *abfd, void *phdrs);
682 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
683 reconstruct an ELF file by reading the segments out of remote memory
684 based on the ELF file header at EHDR_VMA and the ELF program headers it
685 points to. If not null, *LOADBASEP is filled in with the difference
686 between the VMAs from which the segments were read, and the VMAs the
687 file headers (and hence BFD's idea of each section's VMA) put them at.
689 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
690 remote memory at target address VMA into the local buffer at MYADDR; it
691 should return zero on success or an `errno' code on failure. TEMPL must
692 be a BFD for an ELF target with the word size and byte order found in
693 the remote memory. */
694 extern bfd *bfd_elf_bfd_from_remote_memory
695 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
696 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
698 /* Return the arch_size field of an elf bfd, or -1 if not elf. */
699 extern int bfd_get_arch_size
702 /* Return TRUE if address "naturally" sign extends, or -1 if not elf. */
703 extern int bfd_get_sign_extend_vma
706 extern struct bfd_section *_bfd_elf_tls_setup
707 (bfd *, struct bfd_link_info *);
709 extern void _bfd_fix_excluded_sec_syms
710 (bfd *, struct bfd_link_info *);
712 extern unsigned bfd_m68k_mach_to_features (int);
714 extern int bfd_m68k_features_to_mach (unsigned);
716 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
717 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
720 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
722 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
723 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
726 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
727 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
730 /* SunOS shared library support routines for the linker. */
732 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
733 (bfd *, struct bfd_link_info *);
734 extern bfd_boolean bfd_sunos_record_link_assignment
735 (bfd *, struct bfd_link_info *, const char *);
736 extern bfd_boolean bfd_sunos_size_dynamic_sections
737 (bfd *, struct bfd_link_info *, struct bfd_section **,
738 struct bfd_section **, struct bfd_section **);
740 /* Linux shared library support routines for the linker. */
742 extern bfd_boolean bfd_i386linux_size_dynamic_sections
743 (bfd *, struct bfd_link_info *);
744 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
745 (bfd *, struct bfd_link_info *);
746 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
747 (bfd *, struct bfd_link_info *);
751 struct _bfd_window_internal;
752 typedef struct _bfd_window_internal bfd_window_internal;
754 typedef struct _bfd_window
756 /* What the user asked for. */
759 /* The actual window used by BFD. Small user-requested read-only
760 regions sharing a page may share a single window into the object
761 file. Read-write versions shouldn't until I've fixed things to
762 keep track of which portions have been claimed by the
763 application; don't want to give the same region back when the
764 application wants two writable copies! */
765 struct _bfd_window_internal *i;
769 extern void bfd_init_window
771 extern void bfd_free_window
773 extern bfd_boolean bfd_get_file_window
774 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
776 /* XCOFF support routines for the linker. */
778 extern bfd_boolean bfd_xcoff_split_import_path
779 (bfd *, const char *, const char **, const char **);
780 extern bfd_boolean bfd_xcoff_set_archive_import_path
781 (struct bfd_link_info *, bfd *, const char *);
782 extern bfd_boolean bfd_xcoff_link_record_set
783 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
784 extern bfd_boolean bfd_xcoff_import_symbol
785 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
786 const char *, const char *, const char *, unsigned int);
787 extern bfd_boolean bfd_xcoff_export_symbol
788 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
789 extern bfd_boolean bfd_xcoff_link_count_reloc
790 (bfd *, struct bfd_link_info *, const char *);
791 extern bfd_boolean bfd_xcoff_record_link_assignment
792 (bfd *, struct bfd_link_info *, const char *);
793 extern bfd_boolean bfd_xcoff_size_dynamic_sections
794 (bfd *, struct bfd_link_info *, const char *, const char *,
795 unsigned long, unsigned long, unsigned long, bfd_boolean,
796 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
797 extern bfd_boolean bfd_xcoff_link_generate_rtinit
798 (bfd *, const char *, const char *, bfd_boolean);
800 /* XCOFF support routines for ar. */
801 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
804 /* Externally visible COFF routines. */
806 #if defined(__STDC__) || defined(ALMOST_STDC)
807 struct internal_syment;
808 union internal_auxent;
811 extern bfd_boolean bfd_coff_get_syment
812 (bfd *, struct bfd_symbol *, struct internal_syment *);
814 extern bfd_boolean bfd_coff_get_auxent
815 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
817 extern bfd_boolean bfd_coff_set_symbol_class
818 (bfd *, struct bfd_symbol *, unsigned int);
820 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
821 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
823 /* ARM VFP11 erratum workaround support. */
826 BFD_ARM_VFP11_FIX_DEFAULT,
827 BFD_ARM_VFP11_FIX_NONE,
828 BFD_ARM_VFP11_FIX_SCALAR,
829 BFD_ARM_VFP11_FIX_VECTOR
832 extern void bfd_elf32_arm_init_maps
835 extern void bfd_elf32_arm_set_vfp11_fix
836 (bfd *, struct bfd_link_info *);
838 extern void bfd_elf32_arm_set_cortex_a8_fix
839 (bfd *, struct bfd_link_info *);
841 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
842 (bfd *, struct bfd_link_info *);
844 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
845 (bfd *, struct bfd_link_info *);
847 /* ARM Interworking support. Called from linker. */
848 extern bfd_boolean bfd_arm_allocate_interworking_sections
849 (struct bfd_link_info *);
851 extern bfd_boolean bfd_arm_process_before_allocation
852 (bfd *, struct bfd_link_info *, int);
854 extern bfd_boolean bfd_arm_get_bfd_for_interworking
855 (bfd *, struct bfd_link_info *);
857 /* PE ARM Interworking support. Called from linker. */
858 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
859 (struct bfd_link_info *);
861 extern bfd_boolean bfd_arm_pe_process_before_allocation
862 (bfd *, struct bfd_link_info *, int);
864 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
865 (bfd *, struct bfd_link_info *);
867 /* ELF ARM Interworking support. Called from linker. */
868 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
869 (struct bfd_link_info *);
871 extern bfd_boolean bfd_elf32_arm_process_before_allocation
872 (bfd *, struct bfd_link_info *);
874 void bfd_elf32_arm_set_target_relocs
875 (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix,
876 int, int, int, int, int);
878 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
879 (bfd *, struct bfd_link_info *);
881 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
882 (bfd *, struct bfd_link_info *);
884 /* ELF ARM mapping symbol support */
885 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
886 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
887 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
888 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
889 extern bfd_boolean bfd_is_arm_special_symbol_name
890 (const char * name, int type);
892 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
894 /* ARM Note section processing. */
895 extern bfd_boolean bfd_arm_merge_machines
898 extern bfd_boolean bfd_arm_update_notes
899 (bfd *, const char *);
901 extern unsigned int bfd_arm_get_mach_from_notes
902 (bfd *, const char *);
904 /* ARM stub generation support. Called from the linker. */
905 extern int elf32_arm_setup_section_lists
906 (bfd *, struct bfd_link_info *);
907 extern void elf32_arm_next_input_section
908 (struct bfd_link_info *, struct bfd_section *);
909 extern bfd_boolean elf32_arm_size_stubs
910 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
911 struct bfd_section * (*) (const char *, struct bfd_section *), void (*) (void));
912 extern bfd_boolean elf32_arm_build_stubs
913 (struct bfd_link_info *);
915 /* ARM unwind section editing support. */
916 extern bfd_boolean elf32_arm_fix_exidx_coverage
917 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
919 /* C6x unwind section editing support. */
920 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
921 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
923 /* PowerPC @tls opcode transform/validate. */
924 extern unsigned int _bfd_elf_ppc_at_tls_transform
925 (unsigned int, unsigned int);
926 /* PowerPC @tprel opcode transform/validate. */
927 extern unsigned int _bfd_elf_ppc_at_tprel_transform
928 (unsigned int, unsigned int);
930 /* TI COFF load page support. */
931 extern void bfd_ticoff_set_section_load_page
932 (struct bfd_section *, int);
934 extern int bfd_ticoff_get_section_load_page
935 (struct bfd_section *);
937 /* H8/300 functions. */
938 extern bfd_vma bfd_h8300_pad_address
941 /* IA64 Itanium code generation. Called from linker. */
942 extern void bfd_elf32_ia64_after_parse
945 extern void bfd_elf64_ia64_after_parse
948 /* This structure is used for a comdat section, as in PE. A comdat
949 section is associated with a particular symbol. When the linker
950 sees a comdat section, it keeps only one of the sections with a
951 given name and associated with a given symbol. */
953 struct coff_comdat_info
955 /* The name of the symbol associated with a comdat section. */
958 /* The local symbol table index of the symbol associated with a
959 comdat section. This is only meaningful to the object file format
960 specific code; it is not an index into the list returned by
961 bfd_canonicalize_symtab. */
965 extern struct coff_comdat_info *bfd_coff_get_comdat_section
966 (bfd *, struct bfd_section *);