1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright (C) 1990-2016 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. */
273 typedef struct bfd_section *sec_ptr;
275 #define align_power(addr, align) \
276 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
278 /* Align an address upward to a boundary, expressed as a number of bytes.
279 E.g. align to an 8-byte boundary with argument of 8. Take care never
280 to wrap around if the address is within boundary-1 of the end of the
282 #define BFD_ALIGN(this, boundary) \
283 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
284 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
287 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name)
288 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
289 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
290 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
291 (ptr)->alignment_power)
292 #define bfd_section_name(bfd, ptr) ((ptr)->name)
293 #define bfd_section_size(bfd, ptr) ((ptr)->size)
294 #define bfd_get_section_size(ptr) ((ptr)->size)
295 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
296 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
297 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
298 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
299 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
301 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
303 #define bfd_get_section_limit_octets(bfd, sec) \
304 ((bfd)->direction != write_direction && (sec)->rawsize != 0 \
305 ? (sec)->rawsize : (sec)->size)
307 /* Find the address one past the end of SEC. */
308 #define bfd_get_section_limit(bfd, sec) \
309 (bfd_get_section_limit_octets(bfd, sec) / bfd_octets_per_byte (bfd))
311 /* Return TRUE if input section SEC has been discarded. */
312 #define discarded_section(sec) \
313 (!bfd_is_abs_section (sec) \
314 && bfd_is_abs_section ((sec)->output_section) \
315 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
316 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
318 typedef enum bfd_print_symbol
320 bfd_print_symbol_name,
321 bfd_print_symbol_more,
323 } bfd_print_symbol_type;
325 /* Information about a symbol that nm needs. */
327 typedef struct _symbol_info
331 const char *name; /* Symbol name. */
332 unsigned char stab_type; /* Stab type. */
333 char stab_other; /* Stab other. */
334 short stab_desc; /* Stab desc. */
335 const char *stab_name; /* String for stab type. */
338 /* Get the name of a stabs type code. */
340 extern const char *bfd_get_stab_name (int);
342 /* Hash table routines. There is no way to free up a hash table. */
344 /* An element in the hash table. Most uses will actually use a larger
345 structure, and an instance of this will be the first field. */
347 struct bfd_hash_entry
349 /* Next entry for this hash code. */
350 struct bfd_hash_entry *next;
351 /* String being hashed. */
353 /* Hash code. This is the full hash code, not the index into the
360 struct bfd_hash_table
362 /* The hash array. */
363 struct bfd_hash_entry **table;
364 /* A function used to create new elements in the hash table. The
365 first entry is itself a pointer to an element. When this
366 function is first invoked, this pointer will be NULL. However,
367 having the pointer permits a hierarchy of method functions to be
368 built each of which calls the function in the superclass. Thus
369 each function should be written to allocate a new block of memory
370 only if the argument is NULL. */
371 struct bfd_hash_entry *(*newfunc)
372 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
373 /* An objalloc for this hash table. This is a struct objalloc *,
374 but we use void * to avoid requiring the inclusion of objalloc.h. */
376 /* The number of slots in the hash table. */
378 /* The number of entries in the hash table. */
380 /* The size of elements. */
381 unsigned int entsize;
382 /* If non-zero, don't grow the hash table. */
383 unsigned int frozen:1;
386 /* Initialize a hash table. */
387 extern bfd_boolean bfd_hash_table_init
388 (struct bfd_hash_table *,
389 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
390 struct bfd_hash_table *,
394 /* Initialize a hash table specifying a size. */
395 extern bfd_boolean bfd_hash_table_init_n
396 (struct bfd_hash_table *,
397 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
398 struct bfd_hash_table *,
400 unsigned int, unsigned int);
402 /* Free up a hash table. */
403 extern void bfd_hash_table_free
404 (struct bfd_hash_table *);
406 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
407 will be created for this string if one does not already exist. The
408 COPY argument must be TRUE if this routine should copy the string
409 into newly allocated memory when adding an entry. */
410 extern struct bfd_hash_entry *bfd_hash_lookup
411 (struct bfd_hash_table *, const char *, bfd_boolean create,
414 /* Insert an entry in a hash table. */
415 extern struct bfd_hash_entry *bfd_hash_insert
416 (struct bfd_hash_table *, const char *, unsigned long);
418 /* Rename an entry in a hash table. */
419 extern void bfd_hash_rename
420 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
422 /* Replace an entry in a hash table. */
423 extern void bfd_hash_replace
424 (struct bfd_hash_table *, struct bfd_hash_entry *old,
425 struct bfd_hash_entry *nw);
427 /* Base method for creating a hash table entry. */
428 extern struct bfd_hash_entry *bfd_hash_newfunc
429 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
431 /* Grab some space for a hash table entry. */
432 extern void *bfd_hash_allocate
433 (struct bfd_hash_table *, unsigned int);
435 /* Traverse a hash table in a random order, calling a function on each
436 element. If the function returns FALSE, the traversal stops. The
437 INFO argument is passed to the function. */
438 extern void bfd_hash_traverse
439 (struct bfd_hash_table *,
440 bfd_boolean (*) (struct bfd_hash_entry *, void *),
443 /* Allows the default size of a hash table to be configured. New hash
444 tables allocated using bfd_hash_table_init will be created with
446 extern unsigned long bfd_hash_set_default_size (unsigned long);
448 /* Types of compressed DWARF debug sections. We currently support
450 enum compressed_debug_section_type
452 COMPRESS_DEBUG_NONE = 0,
453 COMPRESS_DEBUG = 1 << 0,
454 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
455 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
458 /* This structure is used to keep track of stabs in sections
459 information while linking. */
463 /* A hash table used to hold stabs strings. */
464 struct bfd_strtab_hash *strings;
465 /* The header file hash table. */
466 struct bfd_hash_table includes;
467 /* The first .stabstr section. */
468 struct bfd_section *stabstr;
471 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
473 /* User program access to BFD facilities. */
475 /* Direct I/O routines, for programs which know more about the object
476 file than BFD does. Use higher level routines if possible. */
478 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
479 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
480 extern int bfd_seek (bfd *, file_ptr, int);
481 extern file_ptr bfd_tell (bfd *);
482 extern int bfd_flush (bfd *);
483 extern int bfd_stat (bfd *, struct stat *);
485 /* Deprecated old routines. */
487 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
488 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
489 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
490 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
491 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
492 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
494 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
495 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
496 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
497 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
498 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
499 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
501 extern void warn_deprecated (const char *, const char *, int, const char *);
503 /* Cast from const char * to char * so that caller can assign to
504 a char * without a warning. */
505 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
506 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
507 #define bfd_get_format(abfd) ((abfd)->format)
508 #define bfd_get_target(abfd) ((abfd)->xvec->name)
509 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
510 #define bfd_family_coff(abfd) \
511 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
512 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
513 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
514 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
515 #define bfd_header_big_endian(abfd) \
516 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
517 #define bfd_header_little_endian(abfd) \
518 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
519 #define bfd_get_file_flags(abfd) ((abfd)->flags)
520 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
521 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
522 #define bfd_has_map(abfd) ((abfd)->has_armap)
523 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
525 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
526 #define bfd_usrdata(abfd) ((abfd)->usrdata)
528 #define bfd_get_start_address(abfd) ((abfd)->start_address)
529 #define bfd_get_symcount(abfd) ((abfd)->symcount)
530 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
531 #define bfd_count_sections(abfd) ((abfd)->section_count)
533 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
535 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
537 extern bfd_boolean bfd_cache_close
539 /* NB: This declaration should match the autogenerated one in libbfd.h. */
541 extern bfd_boolean bfd_cache_close_all (void);
543 extern bfd_boolean bfd_record_phdr
544 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
545 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
547 /* Byte swapping routines. */
549 bfd_uint64_t bfd_getb64 (const void *);
550 bfd_uint64_t bfd_getl64 (const void *);
551 bfd_int64_t bfd_getb_signed_64 (const void *);
552 bfd_int64_t bfd_getl_signed_64 (const void *);
553 bfd_vma bfd_getb32 (const void *);
554 bfd_vma bfd_getl32 (const void *);
555 bfd_signed_vma bfd_getb_signed_32 (const void *);
556 bfd_signed_vma bfd_getl_signed_32 (const void *);
557 bfd_vma bfd_getb16 (const void *);
558 bfd_vma bfd_getl16 (const void *);
559 bfd_signed_vma bfd_getb_signed_16 (const void *);
560 bfd_signed_vma bfd_getl_signed_16 (const void *);
561 void bfd_putb64 (bfd_uint64_t, void *);
562 void bfd_putl64 (bfd_uint64_t, void *);
563 void bfd_putb32 (bfd_vma, void *);
564 void bfd_putl32 (bfd_vma, void *);
565 void bfd_putb16 (bfd_vma, void *);
566 void bfd_putl16 (bfd_vma, void *);
568 /* Byte swapping routines which take size and endiannes as arguments. */
570 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
571 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
573 #if defined(__STDC__) || defined(ALMOST_STDC)
574 struct ecoff_debug_info;
575 struct ecoff_debug_swap;
578 struct bfd_link_info;
579 struct bfd_link_hash_entry;
580 struct bfd_section_already_linked;
581 struct bfd_elf_version_tree;
584 extern bfd_boolean bfd_section_already_linked_table_init (void);
585 extern void bfd_section_already_linked_table_free (void);
586 extern bfd_boolean _bfd_handle_already_linked
587 (struct bfd_section *, struct bfd_section_already_linked *,
588 struct bfd_link_info *);
590 /* Externally visible ECOFF routines. */
592 extern bfd_vma bfd_ecoff_get_gp_value
594 extern bfd_boolean bfd_ecoff_set_gp_value
595 (bfd *abfd, bfd_vma gp_value);
596 extern bfd_boolean bfd_ecoff_set_regmasks
597 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
598 unsigned long *cprmask);
599 extern void *bfd_ecoff_debug_init
600 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
601 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
602 extern void bfd_ecoff_debug_free
603 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
604 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
605 extern bfd_boolean bfd_ecoff_debug_accumulate
606 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
607 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
608 struct ecoff_debug_info *input_debug,
609 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
610 extern bfd_boolean bfd_ecoff_debug_accumulate_other
611 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
612 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
613 struct bfd_link_info *);
614 extern bfd_boolean bfd_ecoff_debug_externals
615 (bfd *abfd, struct ecoff_debug_info *debug,
616 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
617 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
618 void (*set_index) (struct bfd_symbol *, bfd_size_type));
619 extern bfd_boolean bfd_ecoff_debug_one_external
620 (bfd *abfd, struct ecoff_debug_info *debug,
621 const struct ecoff_debug_swap *swap, const char *name,
622 struct ecoff_extr *esym);
623 extern bfd_size_type bfd_ecoff_debug_size
624 (bfd *abfd, struct ecoff_debug_info *debug,
625 const struct ecoff_debug_swap *swap);
626 extern bfd_boolean bfd_ecoff_write_debug
627 (bfd *abfd, struct ecoff_debug_info *debug,
628 const struct ecoff_debug_swap *swap, file_ptr where);
629 extern bfd_boolean bfd_ecoff_write_accumulated_debug
630 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
631 const struct ecoff_debug_swap *swap,
632 struct bfd_link_info *info, file_ptr where);
634 /* Externally visible ELF routines. */
636 struct bfd_link_needed_list
638 struct bfd_link_needed_list *next;
643 enum dynamic_lib_link_class {
647 DYN_NO_ADD_NEEDED = 4,
651 enum notice_asneeded_action {
657 extern bfd_boolean bfd_elf_record_link_assignment
658 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
660 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
661 (bfd *, struct bfd_link_info *);
662 extern bfd_boolean bfd_elf_get_bfd_needed_list
663 (bfd *, struct bfd_link_needed_list **);
664 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
665 const char *, bfd_vma);
666 extern bfd_boolean bfd_elf_size_dynamic_sections
667 (bfd *, const char *, const char *, const char *, const char *, const char *,
668 const char * const *, struct bfd_link_info *, struct bfd_section **);
669 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
670 (bfd *, struct bfd_link_info *);
671 extern void bfd_elf_set_dt_needed_name
672 (bfd *, const char *);
673 extern const char *bfd_elf_get_dt_soname
675 extern void bfd_elf_set_dyn_lib_class
676 (bfd *, enum dynamic_lib_link_class);
677 extern int bfd_elf_get_dyn_lib_class
679 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
680 (bfd *, struct bfd_link_info *);
681 extern int bfd_elf_discard_info
682 (bfd *, struct bfd_link_info *);
683 extern unsigned int _bfd_elf_default_action_discarded
684 (struct bfd_section *);
686 /* Return an upper bound on the number of bytes required to store a
687 copy of ABFD's program header table entries. Return -1 if an error
688 occurs; bfd_get_error will return an appropriate code. */
689 extern long bfd_get_elf_phdr_upper_bound
692 /* Copy ABFD's program header table entries to *PHDRS. The entries
693 will be stored as an array of Elf_Internal_Phdr structures, as
694 defined in include/elf/internal.h. To find out how large the
695 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
697 Return the number of program header table entries read, or -1 if an
698 error occurs; bfd_get_error will return an appropriate code. */
699 extern int bfd_get_elf_phdrs
700 (bfd *abfd, void *phdrs);
702 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
703 reconstruct an ELF file by reading the segments out of remote
704 memory based on the ELF file header at EHDR_VMA and the ELF program
705 headers it points to. If non-zero, SIZE is the known extent of the
706 object. If not null, *LOADBASEP is filled in with the difference
707 between the VMAs from which the segments were read, and the VMAs
708 the file headers (and hence BFD's idea of each section's VMA) put
711 The function TARGET_READ_MEMORY is called to copy LEN bytes from
712 the remote memory at target address VMA into the local buffer at
713 MYADDR; it should return zero on success or an `errno' code on
714 failure. TEMPL must be a BFD for a target with the word size and
715 byte order found in the remote memory. */
716 extern bfd *bfd_elf_bfd_from_remote_memory
717 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
718 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
721 extern struct bfd_section *_bfd_elf_tls_setup
722 (bfd *, struct bfd_link_info *);
724 extern struct bfd_section *
725 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
727 extern void _bfd_fix_excluded_sec_syms
728 (bfd *, struct bfd_link_info *);
730 extern unsigned bfd_m68k_mach_to_features (int);
732 extern int bfd_m68k_features_to_mach (unsigned);
734 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
735 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
738 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
740 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
741 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
744 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
745 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
748 /* SunOS shared library support routines for the linker. */
750 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
751 (bfd *, struct bfd_link_info *);
752 extern bfd_boolean bfd_sunos_record_link_assignment
753 (bfd *, struct bfd_link_info *, const char *);
754 extern bfd_boolean bfd_sunos_size_dynamic_sections
755 (bfd *, struct bfd_link_info *, struct bfd_section **,
756 struct bfd_section **, struct bfd_section **);
758 /* Linux shared library support routines for the linker. */
760 extern bfd_boolean bfd_i386linux_size_dynamic_sections
761 (bfd *, struct bfd_link_info *);
762 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
763 (bfd *, struct bfd_link_info *);
764 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
765 (bfd *, struct bfd_link_info *);
769 struct _bfd_window_internal;
770 typedef struct _bfd_window_internal bfd_window_internal;
772 typedef struct _bfd_window
774 /* What the user asked for. */
777 /* The actual window used by BFD. Small user-requested read-only
778 regions sharing a page may share a single window into the object
779 file. Read-write versions shouldn't until I've fixed things to
780 keep track of which portions have been claimed by the
781 application; don't want to give the same region back when the
782 application wants two writable copies! */
783 struct _bfd_window_internal *i;
787 extern void bfd_init_window
789 extern void bfd_free_window
791 extern bfd_boolean bfd_get_file_window
792 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
794 /* XCOFF support routines for the linker. */
796 extern bfd_boolean bfd_xcoff_split_import_path
797 (bfd *, const char *, const char **, const char **);
798 extern bfd_boolean bfd_xcoff_set_archive_import_path
799 (struct bfd_link_info *, bfd *, const char *);
800 extern bfd_boolean bfd_xcoff_link_record_set
801 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
802 extern bfd_boolean bfd_xcoff_import_symbol
803 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
804 const char *, const char *, const char *, unsigned int);
805 extern bfd_boolean bfd_xcoff_export_symbol
806 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
807 extern bfd_boolean bfd_xcoff_link_count_reloc
808 (bfd *, struct bfd_link_info *, const char *);
809 extern bfd_boolean bfd_xcoff_record_link_assignment
810 (bfd *, struct bfd_link_info *, const char *);
811 extern bfd_boolean bfd_xcoff_size_dynamic_sections
812 (bfd *, struct bfd_link_info *, const char *, const char *,
813 unsigned long, unsigned long, unsigned long, bfd_boolean,
814 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
815 extern bfd_boolean bfd_xcoff_link_generate_rtinit
816 (bfd *, const char *, const char *, bfd_boolean);
818 /* XCOFF support routines for ar. */
819 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
822 /* Externally visible COFF routines. */
824 #if defined(__STDC__) || defined(ALMOST_STDC)
825 struct internal_syment;
826 union internal_auxent;
829 extern bfd_boolean bfd_coff_set_symbol_class
830 (bfd *, struct bfd_symbol *, unsigned int);
832 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
833 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
835 /* ARM VFP11 erratum workaround support. */
838 BFD_ARM_VFP11_FIX_DEFAULT,
839 BFD_ARM_VFP11_FIX_NONE,
840 BFD_ARM_VFP11_FIX_SCALAR,
841 BFD_ARM_VFP11_FIX_VECTOR
844 extern void bfd_elf32_arm_init_maps
847 extern void bfd_elf32_arm_set_vfp11_fix
848 (bfd *, struct bfd_link_info *);
850 extern void bfd_elf32_arm_set_cortex_a8_fix
851 (bfd *, struct bfd_link_info *);
853 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
854 (bfd *, struct bfd_link_info *);
856 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
857 (bfd *, struct bfd_link_info *);
859 /* ARM STM STM32L4XX erratum workaround support. */
862 BFD_ARM_STM32L4XX_FIX_NONE,
863 BFD_ARM_STM32L4XX_FIX_DEFAULT,
864 BFD_ARM_STM32L4XX_FIX_ALL
865 } bfd_arm_stm32l4xx_fix;
867 extern void bfd_elf32_arm_set_stm32l4xx_fix
868 (bfd *, struct bfd_link_info *);
870 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
871 (bfd *, struct bfd_link_info *);
873 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
874 (bfd *, struct bfd_link_info *);
876 /* ARM Interworking support. Called from linker. */
877 extern bfd_boolean bfd_arm_allocate_interworking_sections
878 (struct bfd_link_info *);
880 extern bfd_boolean bfd_arm_process_before_allocation
881 (bfd *, struct bfd_link_info *, int);
883 extern bfd_boolean bfd_arm_get_bfd_for_interworking
884 (bfd *, struct bfd_link_info *);
886 /* PE ARM Interworking support. Called from linker. */
887 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
888 (struct bfd_link_info *);
890 extern bfd_boolean bfd_arm_pe_process_before_allocation
891 (bfd *, struct bfd_link_info *, int);
893 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
894 (bfd *, struct bfd_link_info *);
896 /* ELF ARM Interworking support. Called from linker. */
897 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
898 (struct bfd_link_info *);
900 extern bfd_boolean bfd_elf32_arm_process_before_allocation
901 (bfd *, struct bfd_link_info *);
903 struct elf32_arm_params {
904 char *thumb_entry_symbol;
910 bfd_arm_vfp11_fix vfp11_denorm_fix;
911 bfd_arm_stm32l4xx_fix stm32l4xx_fix;
912 int no_enum_size_warning;
913 int no_wchar_size_warning;
917 int merge_exidx_entries;
922 void bfd_elf32_arm_set_target_params
923 (bfd *, struct bfd_link_info *, struct elf32_arm_params *);
925 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
926 (bfd *, struct bfd_link_info *);
928 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
929 (bfd *, struct bfd_link_info *);
931 extern void bfd_elf32_arm_keep_private_stub_output_sections
932 (struct bfd_link_info *);
934 /* ELF ARM mapping symbol support. */
935 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
936 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
937 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
938 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
940 extern bfd_boolean bfd_is_arm_special_symbol_name
943 extern void bfd_elf32_arm_set_byteswap_code
944 (struct bfd_link_info *, int);
946 extern void bfd_elf32_arm_use_long_plt (void);
948 /* ARM Note section processing. */
949 extern bfd_boolean bfd_arm_merge_machines
952 extern bfd_boolean bfd_arm_update_notes
953 (bfd *, const char *);
955 extern unsigned int bfd_arm_get_mach_from_notes
956 (bfd *, const char *);
958 /* ARM stub generation support. Called from the linker. */
959 extern int elf32_arm_setup_section_lists
960 (bfd *, struct bfd_link_info *);
961 extern void elf32_arm_next_input_section
962 (struct bfd_link_info *, struct bfd_section *);
963 extern bfd_boolean elf32_arm_size_stubs
964 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
965 struct bfd_section * (*) (const char *, struct bfd_section *,
966 struct bfd_section *, unsigned int),
968 extern bfd_boolean elf32_arm_build_stubs
969 (struct bfd_link_info *);
971 /* ARM unwind section editing support. */
972 extern bfd_boolean elf32_arm_fix_exidx_coverage
973 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
975 /* C6x unwind section editing support. */
976 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
977 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
979 extern void bfd_elf64_aarch64_init_maps
982 extern void bfd_elf32_aarch64_init_maps
985 extern void bfd_elf64_aarch64_set_options
986 (bfd *, struct bfd_link_info *, int, int, int, int, int, int);
988 extern void bfd_elf32_aarch64_set_options
989 (bfd *, struct bfd_link_info *, int, int, int, int, int, int);
991 /* ELF AArch64 mapping symbol support. */
992 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
993 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
994 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
995 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
996 extern bfd_boolean bfd_is_aarch64_special_symbol_name
997 (const char * name, int type);
999 /* AArch64 stub generation support for ELF64. Called from the linker. */
1000 extern int elf64_aarch64_setup_section_lists
1001 (bfd *, struct bfd_link_info *);
1002 extern void elf64_aarch64_next_input_section
1003 (struct bfd_link_info *, struct bfd_section *);
1004 extern bfd_boolean elf64_aarch64_size_stubs
1005 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1006 struct bfd_section * (*) (const char *, struct bfd_section *),
1008 extern bfd_boolean elf64_aarch64_build_stubs
1009 (struct bfd_link_info *);
1010 /* AArch64 stub generation support for ELF32. Called from the linker. */
1011 extern int elf32_aarch64_setup_section_lists
1012 (bfd *, struct bfd_link_info *);
1013 extern void elf32_aarch64_next_input_section
1014 (struct bfd_link_info *, struct bfd_section *);
1015 extern bfd_boolean elf32_aarch64_size_stubs
1016 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1017 struct bfd_section * (*) (const char *, struct bfd_section *),
1019 extern bfd_boolean elf32_aarch64_build_stubs
1020 (struct bfd_link_info *);
1023 /* TI COFF load page support. */
1024 extern void bfd_ticoff_set_section_load_page
1025 (struct bfd_section *, int);
1027 extern int bfd_ticoff_get_section_load_page
1028 (struct bfd_section *);
1030 /* H8/300 functions. */
1031 extern bfd_vma bfd_h8300_pad_address
1034 /* IA64 Itanium code generation. Called from linker. */
1035 extern void bfd_elf32_ia64_after_parse
1038 extern void bfd_elf64_ia64_after_parse
1041 /* V850 Note manipulation routines. */
1042 extern bfd_boolean v850_elf_create_sections
1043 (struct bfd_link_info *);
1045 extern bfd_boolean v850_elf_set_note
1046 (bfd *, unsigned int, unsigned int);