1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright 1990-2013 2013 Free Software Foundation, Inc.
5 Contributed by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
23 #ifndef __BFD_H_SEEN__
24 #define __BFD_H_SEEN__
26 /* PR 14072: Ensure that config.h is included first. */
27 #if !defined PACKAGE && !defined PACKAGE_VERSION
28 #error config.h must be included before this header
39 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
41 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
42 The problem is, "32_" is not a valid preprocessing token, and we don't
43 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
44 cause the inner CONCAT2 macros to be evaluated first, producing
45 still-valid pp-tokens. Then the final concatenation can be done. */
47 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
51 /* This is a utility macro to handle the situation where the code
52 wants to place a constant string into the code, followed by a
53 comma and then the length of the string. Doing this by hand
54 is error prone, so using this macro is safer. */
55 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
56 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
57 to create the arguments to another macro, since the preprocessor
58 will mis-count the number of arguments to the outer macro (by not
59 evaluating STRING_COMMA_LEN and so missing the comma). This is a
60 problem for example when trying to use STRING_COMMA_LEN to build
61 the arguments to the strncmp() macro. Hence this alternative
62 definition of strncmp is provided here.
64 Note - these macros do NOT work if STR2 is not a constant string. */
65 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
66 /* strcpy() can have a similar problem, but since we know we are
67 copying a constant string, we can use memcpy which will be faster
68 since there is no need to check for a NUL byte inside STR. We
69 can also save time if we do not need to copy the terminating NUL. */
70 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
71 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
74 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
76 /* The word size used by BFD on the host. This may be 64 with a 32
77 bit target if the host is 64 bit, or if other 64 bit targets have
78 been selected with --enable-targets, or if --enable-64-bit-bfd. */
79 #define BFD_ARCH_SIZE @wordsize@
81 /* The word size of the default bfd target. */
82 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
84 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
85 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
86 #if @BFD_HOST_64_BIT_DEFINED@
87 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
88 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
89 typedef BFD_HOST_64_BIT bfd_int64_t;
90 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
93 #if BFD_ARCH_SIZE >= 64
99 #define INLINE __inline__
105 /* Declaring a type wide enough to hold a host long and a host pointer. */
106 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
107 typedef BFD_HOSTPTR_T bfd_hostptr_t;
109 /* Forward declaration. */
110 typedef struct bfd bfd;
112 /* Boolean type used in bfd. Too many systems define their own
113 versions of "boolean" for us to safely typedef a "boolean" of
114 our own. Using an enum for "bfd_boolean" has its own set of
115 problems, with strange looking casts required to avoid warnings
116 on some older compilers. Thus we just use an int.
118 General rule: Functions which are bfd_boolean return TRUE on
119 success and FALSE on failure (unless they're a predicate). */
121 typedef int bfd_boolean;
129 #ifndef BFD_HOST_64_BIT
130 #error No 64 bit integer type available
131 #endif /* ! defined (BFD_HOST_64_BIT) */
133 typedef BFD_HOST_U_64_BIT bfd_vma;
134 typedef BFD_HOST_64_BIT bfd_signed_vma;
135 typedef BFD_HOST_U_64_BIT bfd_size_type;
136 typedef BFD_HOST_U_64_BIT symvalue;
138 #if BFD_HOST_64BIT_LONG
139 #define BFD_VMA_FMT "l"
140 #elif defined (__MSVCRT__)
141 #define BFD_VMA_FMT "I64"
143 #define BFD_VMA_FMT "ll"
147 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
148 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
151 #else /* not BFD64 */
153 /* Represent a target address. Also used as a generic unsigned type
154 which is guaranteed to be big enough to hold any arithmetic types
155 we need to deal with. */
156 typedef unsigned long bfd_vma;
158 /* A generic signed type which is guaranteed to be big enough to hold any
159 arithmetic types we need to deal with. Can be assumed to be compatible
160 with bfd_vma in the same way that signed and unsigned ints are compatible
161 (as parameters, in assignment, etc). */
162 typedef long bfd_signed_vma;
164 typedef unsigned long symvalue;
165 typedef unsigned long bfd_size_type;
167 /* Print a bfd_vma x on stream s. */
168 #define BFD_VMA_FMT "l"
169 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
170 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
172 #endif /* not BFD64 */
174 #define HALF_BFD_SIZE_TYPE \
175 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
177 #ifndef BFD_HOST_64_BIT
178 /* Fall back on a 32 bit type. The idea is to make these types always
179 available for function return types, but in the case that
180 BFD_HOST_64_BIT is undefined such a function should abort or
181 otherwise signal an error. */
182 typedef bfd_signed_vma bfd_int64_t;
183 typedef bfd_vma bfd_uint64_t;
186 /* An offset into a file. BFD always uses the largest possible offset
187 based on the build time availability of fseek, fseeko, or fseeko64. */
188 typedef @bfd_file_ptr@ file_ptr;
189 typedef unsigned @bfd_file_ptr@ ufile_ptr;
191 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
192 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
194 #define printf_vma(x) fprintf_vma(stdout,x)
195 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
197 typedef unsigned int flagword; /* 32 bits of flags */
198 typedef unsigned char bfd_byte;
202 typedef enum bfd_format
204 bfd_unknown = 0, /* File format is unknown. */
205 bfd_object, /* Linker/assembler/compiler output. */
206 bfd_archive, /* Object archive file. */
207 bfd_core, /* Core dump. */
208 bfd_type_end /* Marks the end; don't use it! */
212 /* Symbols and relocation. */
214 /* A count of carsyms (canonical archive symbols). */
215 typedef unsigned long symindex;
217 /* How to perform a relocation. */
218 typedef const struct reloc_howto_struct reloc_howto_type;
220 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
222 /* General purpose part of a symbol X;
223 target specific parts are in libcoff.h, libaout.h, etc. */
225 #define bfd_get_section(x) ((x)->section)
226 #define bfd_get_output_section(x) ((x)->section->output_section)
227 #define bfd_set_section(x,y) ((x)->section) = (y)
228 #define bfd_asymbol_base(x) ((x)->section->vma)
229 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
230 #define bfd_asymbol_name(x) ((x)->name)
231 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
232 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
233 #define bfd_asymbol_flavour(x) \
234 (((x)->flags & BSF_SYNTHETIC) != 0 \
235 ? bfd_target_unknown_flavour \
236 : bfd_asymbol_bfd (x)->xvec->flavour)
238 /* A canonical archive symbol. */
239 /* This is a type pun with struct ranlib on purpose! */
240 typedef struct carsym
243 file_ptr file_offset; /* Look here to find the file. */
245 carsym; /* To make these you call a carsymogen. */
247 /* Used in generating armaps (archive tables of contents).
248 Perhaps just a forward definition would do? */
249 struct orl /* Output ranlib. */
251 char **name; /* Symbol name. */
256 } u; /* bfd* or file position. */
257 int namidx; /* Index into string table. */
260 /* Linenumber stuff. */
261 typedef struct lineno_cache_entry
263 unsigned int line_number; /* Linenumber from start of function. */
266 struct bfd_symbol *sym; /* Function name. */
267 bfd_vma offset; /* Offset into section. */
272 /* Object and core file sections. */
274 #define align_power(addr, align) \
275 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
277 typedef struct bfd_section *sec_ptr;
279 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name)
280 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
281 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
282 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
283 (ptr)->alignment_power)
284 #define bfd_section_name(bfd, ptr) ((ptr)->name)
285 #define bfd_section_size(bfd, ptr) ((ptr)->size)
286 #define bfd_get_section_size(ptr) ((ptr)->size)
287 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
288 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
289 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
290 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
291 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
293 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
295 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
296 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
297 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
298 /* Find the address one past the end of SEC. */
299 #define bfd_get_section_limit(bfd, sec) \
300 (((bfd)->direction != write_direction && (sec)->rawsize != 0 \
301 ? (sec)->rawsize : (sec)->size) / bfd_octets_per_byte (bfd))
303 /* Return TRUE if input section SEC has been discarded. */
304 #define discarded_section(sec) \
305 (!bfd_is_abs_section (sec) \
306 && bfd_is_abs_section ((sec)->output_section) \
307 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
308 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
310 typedef enum bfd_print_symbol
312 bfd_print_symbol_name,
313 bfd_print_symbol_more,
315 } bfd_print_symbol_type;
317 /* Information about a symbol that nm needs. */
319 typedef struct _symbol_info
323 const char *name; /* Symbol name. */
324 unsigned char stab_type; /* Stab type. */
325 char stab_other; /* Stab other. */
326 short stab_desc; /* Stab desc. */
327 const char *stab_name; /* String for stab type. */
330 /* Get the name of a stabs type code. */
332 extern const char *bfd_get_stab_name (int);
334 /* Hash table routines. There is no way to free up a hash table. */
336 /* An element in the hash table. Most uses will actually use a larger
337 structure, and an instance of this will be the first field. */
339 struct bfd_hash_entry
341 /* Next entry for this hash code. */
342 struct bfd_hash_entry *next;
343 /* String being hashed. */
345 /* Hash code. This is the full hash code, not the index into the
352 struct bfd_hash_table
354 /* The hash array. */
355 struct bfd_hash_entry **table;
356 /* A function used to create new elements in the hash table. The
357 first entry is itself a pointer to an element. When this
358 function is first invoked, this pointer will be NULL. However,
359 having the pointer permits a hierarchy of method functions to be
360 built each of which calls the function in the superclass. Thus
361 each function should be written to allocate a new block of memory
362 only if the argument is NULL. */
363 struct bfd_hash_entry *(*newfunc)
364 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
365 /* An objalloc for this hash table. This is a struct objalloc *,
366 but we use void * to avoid requiring the inclusion of objalloc.h. */
368 /* The number of slots in the hash table. */
370 /* The number of entries in the hash table. */
372 /* The size of elements. */
373 unsigned int entsize;
374 /* If non-zero, don't grow the hash table. */
375 unsigned int frozen:1;
378 /* Initialize a hash table. */
379 extern bfd_boolean bfd_hash_table_init
380 (struct bfd_hash_table *,
381 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
382 struct bfd_hash_table *,
386 /* Initialize a hash table specifying a size. */
387 extern bfd_boolean bfd_hash_table_init_n
388 (struct bfd_hash_table *,
389 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
390 struct bfd_hash_table *,
392 unsigned int, unsigned int);
394 /* Free up a hash table. */
395 extern void bfd_hash_table_free
396 (struct bfd_hash_table *);
398 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
399 will be created for this string if one does not already exist. The
400 COPY argument must be TRUE if this routine should copy the string
401 into newly allocated memory when adding an entry. */
402 extern struct bfd_hash_entry *bfd_hash_lookup
403 (struct bfd_hash_table *, const char *, bfd_boolean create,
406 /* Insert an entry in a hash table. */
407 extern struct bfd_hash_entry *bfd_hash_insert
408 (struct bfd_hash_table *, const char *, unsigned long);
410 /* Rename an entry in a hash table. */
411 extern void bfd_hash_rename
412 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
414 /* Replace an entry in a hash table. */
415 extern void bfd_hash_replace
416 (struct bfd_hash_table *, struct bfd_hash_entry *old,
417 struct bfd_hash_entry *nw);
419 /* Base method for creating a hash table entry. */
420 extern struct bfd_hash_entry *bfd_hash_newfunc
421 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
423 /* Grab some space for a hash table entry. */
424 extern void *bfd_hash_allocate
425 (struct bfd_hash_table *, unsigned int);
427 /* Traverse a hash table in a random order, calling a function on each
428 element. If the function returns FALSE, the traversal stops. The
429 INFO argument is passed to the function. */
430 extern void bfd_hash_traverse
431 (struct bfd_hash_table *,
432 bfd_boolean (*) (struct bfd_hash_entry *, void *),
435 /* Allows the default size of a hash table to be configured. New hash
436 tables allocated using bfd_hash_table_init will be created with
438 extern unsigned long bfd_hash_set_default_size (unsigned long);
440 /* This structure is used to keep track of stabs in sections
441 information while linking. */
445 /* A hash table used to hold stabs strings. */
446 struct bfd_strtab_hash *strings;
447 /* The header file hash table. */
448 struct bfd_hash_table includes;
449 /* The first .stabstr section. */
450 struct bfd_section *stabstr;
453 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
455 /* User program access to BFD facilities. */
457 /* Direct I/O routines, for programs which know more about the object
458 file than BFD does. Use higher level routines if possible. */
460 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
461 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
462 extern int bfd_seek (bfd *, file_ptr, int);
463 extern file_ptr bfd_tell (bfd *);
464 extern int bfd_flush (bfd *);
465 extern int bfd_stat (bfd *, struct stat *);
467 /* Deprecated old routines. */
469 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
470 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
471 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
472 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
473 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
474 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
476 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
477 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
478 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
479 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
480 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
481 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
483 extern void warn_deprecated (const char *, const char *, int, const char *);
485 /* Cast from const char * to char * so that caller can assign to
486 a char * without a warning. */
487 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
488 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
489 #define bfd_get_format(abfd) ((abfd)->format)
490 #define bfd_get_target(abfd) ((abfd)->xvec->name)
491 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
492 #define bfd_family_coff(abfd) \
493 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
494 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
495 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
496 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
497 #define bfd_header_big_endian(abfd) \
498 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
499 #define bfd_header_little_endian(abfd) \
500 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
501 #define bfd_get_file_flags(abfd) ((abfd)->flags)
502 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
503 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
504 #define bfd_my_archive(abfd) ((abfd)->my_archive)
505 #define bfd_has_map(abfd) ((abfd)->has_armap)
506 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
508 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
509 #define bfd_usrdata(abfd) ((abfd)->usrdata)
511 #define bfd_get_start_address(abfd) ((abfd)->start_address)
512 #define bfd_get_symcount(abfd) ((abfd)->symcount)
513 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
514 #define bfd_count_sections(abfd) ((abfd)->section_count)
516 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
518 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
520 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
522 extern bfd_boolean bfd_cache_close
524 /* NB: This declaration should match the autogenerated one in libbfd.h. */
526 extern bfd_boolean bfd_cache_close_all (void);
528 extern bfd_boolean bfd_record_phdr
529 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
530 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
532 /* Byte swapping routines. */
534 bfd_uint64_t bfd_getb64 (const void *);
535 bfd_uint64_t bfd_getl64 (const void *);
536 bfd_int64_t bfd_getb_signed_64 (const void *);
537 bfd_int64_t bfd_getl_signed_64 (const void *);
538 bfd_vma bfd_getb32 (const void *);
539 bfd_vma bfd_getl32 (const void *);
540 bfd_signed_vma bfd_getb_signed_32 (const void *);
541 bfd_signed_vma bfd_getl_signed_32 (const void *);
542 bfd_vma bfd_getb16 (const void *);
543 bfd_vma bfd_getl16 (const void *);
544 bfd_signed_vma bfd_getb_signed_16 (const void *);
545 bfd_signed_vma bfd_getl_signed_16 (const void *);
546 void bfd_putb64 (bfd_uint64_t, void *);
547 void bfd_putl64 (bfd_uint64_t, void *);
548 void bfd_putb32 (bfd_vma, void *);
549 void bfd_putl32 (bfd_vma, void *);
550 void bfd_putb16 (bfd_vma, void *);
551 void bfd_putl16 (bfd_vma, void *);
553 /* Byte swapping routines which take size and endiannes as arguments. */
555 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
556 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
558 #if defined(__STDC__) || defined(ALMOST_STDC)
559 struct ecoff_debug_info;
560 struct ecoff_debug_swap;
563 struct bfd_link_info;
564 struct bfd_link_hash_entry;
565 struct bfd_section_already_linked;
566 struct bfd_elf_version_tree;
569 extern bfd_boolean bfd_section_already_linked_table_init (void);
570 extern void bfd_section_already_linked_table_free (void);
571 extern bfd_boolean _bfd_handle_already_linked
572 (struct bfd_section *, struct bfd_section_already_linked *,
573 struct bfd_link_info *);
575 /* Externally visible ECOFF routines. */
577 extern bfd_vma bfd_ecoff_get_gp_value
579 extern bfd_boolean bfd_ecoff_set_gp_value
580 (bfd *abfd, bfd_vma gp_value);
581 extern bfd_boolean bfd_ecoff_set_regmasks
582 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
583 unsigned long *cprmask);
584 extern void *bfd_ecoff_debug_init
585 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
586 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
587 extern void bfd_ecoff_debug_free
588 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
589 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
590 extern bfd_boolean bfd_ecoff_debug_accumulate
591 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
592 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
593 struct ecoff_debug_info *input_debug,
594 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
595 extern bfd_boolean bfd_ecoff_debug_accumulate_other
596 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
597 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
598 struct bfd_link_info *);
599 extern bfd_boolean bfd_ecoff_debug_externals
600 (bfd *abfd, struct ecoff_debug_info *debug,
601 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
602 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
603 void (*set_index) (struct bfd_symbol *, bfd_size_type));
604 extern bfd_boolean bfd_ecoff_debug_one_external
605 (bfd *abfd, struct ecoff_debug_info *debug,
606 const struct ecoff_debug_swap *swap, const char *name,
607 struct ecoff_extr *esym);
608 extern bfd_size_type bfd_ecoff_debug_size
609 (bfd *abfd, struct ecoff_debug_info *debug,
610 const struct ecoff_debug_swap *swap);
611 extern bfd_boolean bfd_ecoff_write_debug
612 (bfd *abfd, struct ecoff_debug_info *debug,
613 const struct ecoff_debug_swap *swap, file_ptr where);
614 extern bfd_boolean bfd_ecoff_write_accumulated_debug
615 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
616 const struct ecoff_debug_swap *swap,
617 struct bfd_link_info *info, file_ptr where);
619 /* Externally visible ELF routines. */
621 struct bfd_link_needed_list
623 struct bfd_link_needed_list *next;
628 enum dynamic_lib_link_class {
632 DYN_NO_ADD_NEEDED = 4,
636 enum notice_asneeded_action {
642 extern bfd_boolean bfd_elf_record_link_assignment
643 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
645 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
646 (bfd *, struct bfd_link_info *);
647 extern bfd_boolean bfd_elf_get_bfd_needed_list
648 (bfd *, struct bfd_link_needed_list **);
649 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
650 const char *, bfd_vma);
651 extern bfd_boolean bfd_elf_size_dynamic_sections
652 (bfd *, const char *, const char *, const char *, const char *, const char *,
653 const char * const *, struct bfd_link_info *, struct bfd_section **);
654 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
655 (bfd *, struct bfd_link_info *);
656 extern void bfd_elf_set_dt_needed_name
657 (bfd *, const char *);
658 extern const char *bfd_elf_get_dt_soname
660 extern void bfd_elf_set_dyn_lib_class
661 (bfd *, enum dynamic_lib_link_class);
662 extern int bfd_elf_get_dyn_lib_class
664 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
665 (bfd *, struct bfd_link_info *);
666 extern bfd_boolean bfd_elf_discard_info
667 (bfd *, struct bfd_link_info *);
668 extern unsigned int _bfd_elf_default_action_discarded
669 (struct bfd_section *);
671 /* Return an upper bound on the number of bytes required to store a
672 copy of ABFD's program header table entries. Return -1 if an error
673 occurs; bfd_get_error will return an appropriate code. */
674 extern long bfd_get_elf_phdr_upper_bound
677 /* Copy ABFD's program header table entries to *PHDRS. The entries
678 will be stored as an array of Elf_Internal_Phdr structures, as
679 defined in include/elf/internal.h. To find out how large the
680 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
682 Return the number of program header table entries read, or -1 if an
683 error occurs; bfd_get_error will return an appropriate code. */
684 extern int bfd_get_elf_phdrs
685 (bfd *abfd, void *phdrs);
687 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
688 reconstruct an ELF file by reading the segments out of remote memory
689 based on the ELF file header at EHDR_VMA and the ELF program headers it
690 points to. If not null, *LOADBASEP is filled in with the difference
691 between the VMAs from which the segments were read, and the VMAs the
692 file headers (and hence BFD's idea of each section's VMA) put them at.
694 The function TARGET_READ_MEMORY is called to copy LEN bytes from the
695 remote memory at target address VMA into the local buffer at MYADDR; it
696 should return zero on success or an `errno' code on failure. TEMPL must
697 be a BFD for an ELF target with the word size and byte order found in
698 the remote memory. */
699 extern bfd *bfd_elf_bfd_from_remote_memory
700 (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
701 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
704 extern struct bfd_section *_bfd_elf_tls_setup
705 (bfd *, struct bfd_link_info *);
707 extern struct bfd_section *
708 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
710 extern void _bfd_fix_excluded_sec_syms
711 (bfd *, struct bfd_link_info *);
713 extern unsigned bfd_m68k_mach_to_features (int);
715 extern int bfd_m68k_features_to_mach (unsigned);
717 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
718 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
721 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
723 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
724 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
727 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
728 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
731 /* SunOS shared library support routines for the linker. */
733 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
734 (bfd *, struct bfd_link_info *);
735 extern bfd_boolean bfd_sunos_record_link_assignment
736 (bfd *, struct bfd_link_info *, const char *);
737 extern bfd_boolean bfd_sunos_size_dynamic_sections
738 (bfd *, struct bfd_link_info *, struct bfd_section **,
739 struct bfd_section **, struct bfd_section **);
741 /* Linux shared library support routines for the linker. */
743 extern bfd_boolean bfd_i386linux_size_dynamic_sections
744 (bfd *, struct bfd_link_info *);
745 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
746 (bfd *, struct bfd_link_info *);
747 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
748 (bfd *, struct bfd_link_info *);
752 struct _bfd_window_internal;
753 typedef struct _bfd_window_internal bfd_window_internal;
755 typedef struct _bfd_window
757 /* What the user asked for. */
760 /* The actual window used by BFD. Small user-requested read-only
761 regions sharing a page may share a single window into the object
762 file. Read-write versions shouldn't until I've fixed things to
763 keep track of which portions have been claimed by the
764 application; don't want to give the same region back when the
765 application wants two writable copies! */
766 struct _bfd_window_internal *i;
770 extern void bfd_init_window
772 extern void bfd_free_window
774 extern bfd_boolean bfd_get_file_window
775 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
777 /* XCOFF support routines for the linker. */
779 extern bfd_boolean bfd_xcoff_split_import_path
780 (bfd *, const char *, const char **, const char **);
781 extern bfd_boolean bfd_xcoff_set_archive_import_path
782 (struct bfd_link_info *, bfd *, const char *);
783 extern bfd_boolean bfd_xcoff_link_record_set
784 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
785 extern bfd_boolean bfd_xcoff_import_symbol
786 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
787 const char *, const char *, const char *, unsigned int);
788 extern bfd_boolean bfd_xcoff_export_symbol
789 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
790 extern bfd_boolean bfd_xcoff_link_count_reloc
791 (bfd *, struct bfd_link_info *, const char *);
792 extern bfd_boolean bfd_xcoff_record_link_assignment
793 (bfd *, struct bfd_link_info *, const char *);
794 extern bfd_boolean bfd_xcoff_size_dynamic_sections
795 (bfd *, struct bfd_link_info *, const char *, const char *,
796 unsigned long, unsigned long, unsigned long, bfd_boolean,
797 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
798 extern bfd_boolean bfd_xcoff_link_generate_rtinit
799 (bfd *, const char *, const char *, bfd_boolean);
801 /* XCOFF support routines for ar. */
802 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
805 /* Externally visible COFF routines. */
807 #if defined(__STDC__) || defined(ALMOST_STDC)
808 struct internal_syment;
809 union internal_auxent;
812 extern bfd_boolean bfd_coff_get_syment
813 (bfd *, struct bfd_symbol *, struct internal_syment *);
815 extern bfd_boolean bfd_coff_get_auxent
816 (bfd *, struct bfd_symbol *, int, union internal_auxent *);
818 extern bfd_boolean bfd_coff_set_symbol_class
819 (bfd *, struct bfd_symbol *, unsigned int);
821 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
822 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
824 /* ARM VFP11 erratum workaround support. */
827 BFD_ARM_VFP11_FIX_DEFAULT,
828 BFD_ARM_VFP11_FIX_NONE,
829 BFD_ARM_VFP11_FIX_SCALAR,
830 BFD_ARM_VFP11_FIX_VECTOR
833 extern void bfd_elf32_arm_init_maps
836 extern void bfd_elf32_arm_set_vfp11_fix
837 (bfd *, struct bfd_link_info *);
839 extern void bfd_elf32_arm_set_cortex_a8_fix
840 (bfd *, struct bfd_link_info *);
842 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
843 (bfd *, struct bfd_link_info *);
845 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
846 (bfd *, struct bfd_link_info *);
848 /* ARM Interworking support. Called from linker. */
849 extern bfd_boolean bfd_arm_allocate_interworking_sections
850 (struct bfd_link_info *);
852 extern bfd_boolean bfd_arm_process_before_allocation
853 (bfd *, struct bfd_link_info *, int);
855 extern bfd_boolean bfd_arm_get_bfd_for_interworking
856 (bfd *, struct bfd_link_info *);
858 /* PE ARM Interworking support. Called from linker. */
859 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
860 (struct bfd_link_info *);
862 extern bfd_boolean bfd_arm_pe_process_before_allocation
863 (bfd *, struct bfd_link_info *, int);
865 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
866 (bfd *, struct bfd_link_info *);
868 /* ELF ARM Interworking support. Called from linker. */
869 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
870 (struct bfd_link_info *);
872 extern bfd_boolean bfd_elf32_arm_process_before_allocation
873 (bfd *, struct bfd_link_info *);
875 void bfd_elf32_arm_set_target_relocs
876 (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix,
877 int, int, int, int, int);
879 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
880 (bfd *, struct bfd_link_info *);
882 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
883 (bfd *, struct bfd_link_info *);
885 /* ELF ARM mapping symbol support */
886 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
887 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
888 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
889 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
890 extern bfd_boolean bfd_is_arm_special_symbol_name
891 (const char * name, int type);
893 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
895 /* ARM Note section processing. */
896 extern bfd_boolean bfd_arm_merge_machines
899 extern bfd_boolean bfd_arm_update_notes
900 (bfd *, const char *);
902 extern unsigned int bfd_arm_get_mach_from_notes
903 (bfd *, const char *);
905 /* ARM stub generation support. Called from the linker. */
906 extern int elf32_arm_setup_section_lists
907 (bfd *, struct bfd_link_info *);
908 extern void elf32_arm_next_input_section
909 (struct bfd_link_info *, struct bfd_section *);
910 extern bfd_boolean elf32_arm_size_stubs
911 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
912 struct bfd_section * (*) (const char *, struct bfd_section *, unsigned int),
914 extern bfd_boolean elf32_arm_build_stubs
915 (struct bfd_link_info *);
917 /* ARM unwind section editing support. */
918 extern bfd_boolean elf32_arm_fix_exidx_coverage
919 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
921 /* C6x unwind section editing support. */
922 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
923 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
925 /* PowerPC @tls opcode transform/validate. */
926 extern unsigned int _bfd_elf_ppc_at_tls_transform
927 (unsigned int, unsigned int);
928 /* PowerPC @tprel opcode transform/validate. */
929 extern unsigned int _bfd_elf_ppc_at_tprel_transform
930 (unsigned int, unsigned int);
932 extern void bfd_elf64_aarch64_init_maps
935 extern void bfd_elf32_aarch64_init_maps
938 extern void bfd_elf64_aarch64_set_options
939 (bfd *, struct bfd_link_info *, int, int, int);
941 extern void bfd_elf32_aarch64_set_options
942 (bfd *, struct bfd_link_info *, int, int, int);
944 /* ELF AArch64 mapping symbol support. */
945 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
946 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
947 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
948 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
949 extern bfd_boolean bfd_is_aarch64_special_symbol_name
950 (const char * name, int type);
952 /* AArch64 stub generation support for ELF64. Called from the linker. */
953 extern int elf64_aarch64_setup_section_lists
954 (bfd *, struct bfd_link_info *);
955 extern void elf64_aarch64_next_input_section
956 (struct bfd_link_info *, struct bfd_section *);
957 extern bfd_boolean elf64_aarch64_size_stubs
958 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
959 struct bfd_section * (*) (const char *, struct bfd_section *),
961 extern bfd_boolean elf64_aarch64_build_stubs
962 (struct bfd_link_info *);
963 /* AArch64 stub generation support for ELF32. Called from the linker. */
964 extern int elf32_aarch64_setup_section_lists
965 (bfd *, struct bfd_link_info *);
966 extern void elf32_aarch64_next_input_section
967 (struct bfd_link_info *, struct bfd_section *);
968 extern bfd_boolean elf32_aarch64_size_stubs
969 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
970 struct bfd_section * (*) (const char *, struct bfd_section *),
972 extern bfd_boolean elf32_aarch64_build_stubs
973 (struct bfd_link_info *);
976 /* TI COFF load page support. */
977 extern void bfd_ticoff_set_section_load_page
978 (struct bfd_section *, int);
980 extern int bfd_ticoff_get_section_load_page
981 (struct bfd_section *);
983 /* H8/300 functions. */
984 extern bfd_vma bfd_h8300_pad_address
987 /* IA64 Itanium code generation. Called from linker. */
988 extern void bfd_elf32_ia64_after_parse
991 extern void bfd_elf64_ia64_after_parse
994 /* This structure is used for a comdat section, as in PE. A comdat
995 section is associated with a particular symbol. When the linker
996 sees a comdat section, it keeps only one of the sections with a
997 given name and associated with a given symbol. */
999 struct coff_comdat_info
1001 /* The name of the symbol associated with a comdat section. */
1004 /* The local symbol table index of the symbol associated with a
1005 comdat section. This is only meaningful to the object file format
1006 specific code; it is not an index into the list returned by
1007 bfd_canonicalize_symtab. */
1011 extern struct coff_comdat_info * bfd_coff_get_comdat_section
1012 (bfd *, struct bfd_section *);