1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright (C) 1990-2019 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
37 #include "bfd_stdint.h"
38 #include "diagnostics.h"
42 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
44 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
45 The problem is, "32_" is not a valid preprocessing token, and we don't
46 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
47 cause the inner CONCAT2 macros to be evaluated first, producing
48 still-valid pp-tokens. Then the final concatenation can be done. */
50 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
54 /* This is a utility macro to handle the situation where the code
55 wants to place a constant string into the code, followed by a
56 comma and then the length of the string. Doing this by hand
57 is error prone, so using this macro is safer. */
58 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
59 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
60 to create the arguments to another macro, since the preprocessor
61 will mis-count the number of arguments to the outer macro (by not
62 evaluating STRING_COMMA_LEN and so missing the comma). This is a
63 problem for example when trying to use STRING_COMMA_LEN to build
64 the arguments to the strncmp() macro. Hence this alternative
65 definition of strncmp is provided here.
67 Note - these macros do NOT work if STR2 is not a constant string. */
68 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
69 /* strcpy() can have a similar problem, but since we know we are
70 copying a constant string, we can use memcpy which will be faster
71 since there is no need to check for a NUL byte inside STR. We
72 can also save time if we do not need to copy the terminating NUL. */
73 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
74 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
77 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
79 /* The word size used by BFD on the host. This may be 64 with a 32
80 bit target if the host is 64 bit, or if other 64 bit targets have
81 been selected with --enable-targets, or if --enable-64-bit-bfd. */
82 #define BFD_ARCH_SIZE @wordsize@
84 /* The word size of the default bfd target. */
85 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
87 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
88 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
89 #if @BFD_HOST_64_BIT_DEFINED@
90 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
91 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
92 typedef BFD_HOST_64_BIT bfd_int64_t
;
93 typedef BFD_HOST_U_64_BIT bfd_uint64_t
;
96 #ifdef HAVE_INTTYPES_H
97 # include <inttypes.h>
99 # if BFD_HOST_64BIT_LONG
100 # define BFD_PRI64 "l"
101 # elif defined (__MSVCRT__)
102 # define BFD_PRI64 "I64"
104 # define BFD_PRI64 "ll"
107 # define PRId64 BFD_PRI64 "d"
109 # define PRIu64 BFD_PRI64 "u"
111 # define PRIx64 BFD_PRI64 "x"
114 #if BFD_ARCH_SIZE >= 64
120 #define INLINE __inline__
126 /* Declaring a type wide enough to hold a host long and a host pointer. */
127 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
128 typedef BFD_HOSTPTR_T bfd_hostptr_t
;
130 /* Forward declaration. */
131 typedef struct bfd bfd
;
133 /* Boolean type used in bfd. Too many systems define their own
134 versions of "boolean" for us to safely typedef a "boolean" of
135 our own. Using an enum for "bfd_boolean" has its own set of
136 problems, with strange looking casts required to avoid warnings
137 on some older compilers. Thus we just use an int.
139 General rule: Functions which are bfd_boolean return TRUE on
140 success and FALSE on failure (unless they're a predicate). */
142 typedef int bfd_boolean
;
150 #ifndef BFD_HOST_64_BIT
151 #error No 64 bit integer type available
152 #endif /* ! defined (BFD_HOST_64_BIT) */
154 typedef BFD_HOST_U_64_BIT bfd_vma
;
155 typedef BFD_HOST_64_BIT bfd_signed_vma
;
156 typedef BFD_HOST_U_64_BIT bfd_size_type
;
157 typedef BFD_HOST_U_64_BIT symvalue
;
159 #if BFD_HOST_64BIT_LONG
160 #define BFD_VMA_FMT "l"
161 #elif defined (__MSVCRT__)
162 #define BFD_VMA_FMT "I64"
164 #define BFD_VMA_FMT "ll"
168 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
169 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
172 #else /* not BFD64 */
174 /* Represent a target address. Also used as a generic unsigned type
175 which is guaranteed to be big enough to hold any arithmetic types
176 we need to deal with. */
177 typedef unsigned long bfd_vma
;
179 /* A generic signed type which is guaranteed to be big enough to hold any
180 arithmetic types we need to deal with. Can be assumed to be compatible
181 with bfd_vma in the same way that signed and unsigned ints are compatible
182 (as parameters, in assignment, etc). */
183 typedef long bfd_signed_vma
;
185 typedef unsigned long symvalue
;
186 typedef unsigned long bfd_size_type
;
188 /* Print a bfd_vma x on stream s. */
189 #define BFD_VMA_FMT "l"
190 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
191 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
193 #endif /* not BFD64 */
195 #define HALF_BFD_SIZE_TYPE \
196 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
198 #ifndef BFD_HOST_64_BIT
199 /* Fall back on a 32 bit type. The idea is to make these types always
200 available for function return types, but in the case that
201 BFD_HOST_64_BIT is undefined such a function should abort or
202 otherwise signal an error. */
203 typedef bfd_signed_vma bfd_int64_t
;
204 typedef bfd_vma bfd_uint64_t
;
207 /* An offset into a file. BFD always uses the largest possible offset
208 based on the build time availability of fseek, fseeko, or fseeko64. */
209 typedef @bfd_file_ptr@ file_ptr
;
210 typedef unsigned @bfd_file_ptr@ ufile_ptr
;
212 extern void bfd_sprintf_vma (bfd
*, char *, bfd_vma
);
213 extern void bfd_fprintf_vma (bfd
*, void *, bfd_vma
);
215 #define printf_vma(x) fprintf_vma(stdout,x)
216 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
218 typedef unsigned int flagword
; /* 32 bits of flags */
219 typedef unsigned char bfd_byte
;
223 typedef enum bfd_format
225 bfd_unknown
= 0, /* File format is unknown. */
226 bfd_object
, /* Linker/assembler/compiler output. */
227 bfd_archive
, /* Object archive file. */
228 bfd_core
, /* Core dump. */
229 bfd_type_end
/* Marks the end; don't use it! */
233 /* Symbols and relocation. */
235 /* A count of carsyms (canonical archive symbols). */
236 typedef unsigned long symindex
;
238 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
240 /* General purpose part of a symbol X;
241 target specific parts are in libcoff.h, libaout.h, etc. */
243 #define bfd_asymbol_section(sy) ((sy)->section)
244 #define bfd_asymbol_value(sy) ((sy)->section->vma + (sy)->value)
245 #define bfd_asymbol_name(sy) ((sy)->name)
246 #define bfd_asymbol_bfd(sy) ((sy)->the_bfd)
247 #define bfd_asymbol_flavour(sy) \
248 (((sy)->flags & BSF_SYNTHETIC) != 0 \
249 ? bfd_target_unknown_flavour \
250 : (sy)->the_bfd->xvec->flavour)
251 #define bfd_set_asymbol_name(sy, n) do { (sy)->name = (n); } while (0)
253 /* A canonical archive symbol. */
254 /* This is a type pun with struct ranlib on purpose! */
255 typedef struct carsym
258 file_ptr file_offset
; /* Look here to find the file. */
260 carsym
; /* To make these you call a carsymogen. */
262 /* Used in generating armaps (archive tables of contents).
263 Perhaps just a forward definition would do? */
264 struct orl
/* Output ranlib. */
266 char **name
; /* Symbol name. */
271 } u
; /* bfd* or file position. */
272 int namidx
; /* Index into string table. */
275 /* Linenumber stuff. */
276 typedef struct lineno_cache_entry
278 unsigned int line_number
; /* Linenumber from start of function. */
281 struct bfd_symbol
*sym
; /* Function name. */
282 bfd_vma offset
; /* Offset into section. */
287 /* Object and core file sections. */
288 typedef struct bfd_section
*sec_ptr
;
290 #define align_power(addr, align) \
291 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
293 /* Align an address upward to a boundary, expressed as a number of bytes.
294 E.g. align to an 8-byte boundary with argument of 8. Take care never
295 to wrap around if the address is within boundary-1 of the end of the
297 #define BFD_ALIGN(this, boundary) \
298 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
299 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
302 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name)
303 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
304 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
305 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
306 (ptr)->alignment_power)
307 #define bfd_section_name(bfd, ptr) ((ptr)->name)
308 #define bfd_section_size(bfd, ptr) ((ptr)->size)
309 #define bfd_get_section_size(ptr) ((ptr)->size)
310 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
311 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
312 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
313 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
314 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
316 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
318 #define bfd_get_section_limit_octets(bfd, sec) \
319 ((bfd)->direction != write_direction && (sec)->rawsize != 0 \
320 ? (sec)->rawsize : (sec)->size)
322 /* Find the address one past the end of SEC. */
323 #define bfd_get_section_limit(bfd, sec) \
324 (bfd_get_section_limit_octets(bfd, sec) / bfd_octets_per_byte (bfd))
326 /* Return TRUE if input section SEC has been discarded. */
327 #define discarded_section(sec) \
328 (!bfd_is_abs_section (sec) \
329 && bfd_is_abs_section ((sec)->output_section) \
330 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
331 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
333 typedef enum bfd_print_symbol
335 bfd_print_symbol_name
,
336 bfd_print_symbol_more
,
338 } bfd_print_symbol_type
;
340 /* Information about a symbol that nm needs. */
342 typedef struct _symbol_info
346 const char *name
; /* Symbol name. */
347 unsigned char stab_type
; /* Stab type. */
348 char stab_other
; /* Stab other. */
349 short stab_desc
; /* Stab desc. */
350 const char *stab_name
; /* String for stab type. */
353 /* Get the name of a stabs type code. */
355 extern const char *bfd_get_stab_name (int);
357 /* Hash table routines. There is no way to free up a hash table. */
359 /* An element in the hash table. Most uses will actually use a larger
360 structure, and an instance of this will be the first field. */
362 struct bfd_hash_entry
364 /* Next entry for this hash code. */
365 struct bfd_hash_entry
*next
;
366 /* String being hashed. */
368 /* Hash code. This is the full hash code, not the index into the
375 struct bfd_hash_table
377 /* The hash array. */
378 struct bfd_hash_entry
**table
;
379 /* A function used to create new elements in the hash table. The
380 first entry is itself a pointer to an element. When this
381 function is first invoked, this pointer will be NULL. However,
382 having the pointer permits a hierarchy of method functions to be
383 built each of which calls the function in the superclass. Thus
384 each function should be written to allocate a new block of memory
385 only if the argument is NULL. */
386 struct bfd_hash_entry
*(*newfunc
)
387 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
388 /* An objalloc for this hash table. This is a struct objalloc *,
389 but we use void * to avoid requiring the inclusion of objalloc.h. */
391 /* The number of slots in the hash table. */
393 /* The number of entries in the hash table. */
395 /* The size of elements. */
396 unsigned int entsize
;
397 /* If non-zero, don't grow the hash table. */
398 unsigned int frozen
:1;
401 /* Initialize a hash table. */
402 extern bfd_boolean bfd_hash_table_init
403 (struct bfd_hash_table
*,
404 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
405 struct bfd_hash_table
*,
409 /* Initialize a hash table specifying a size. */
410 extern bfd_boolean bfd_hash_table_init_n
411 (struct bfd_hash_table
*,
412 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
413 struct bfd_hash_table
*,
415 unsigned int, unsigned int);
417 /* Free up a hash table. */
418 extern void bfd_hash_table_free
419 (struct bfd_hash_table
*);
421 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
422 will be created for this string if one does not already exist. The
423 COPY argument must be TRUE if this routine should copy the string
424 into newly allocated memory when adding an entry. */
425 extern struct bfd_hash_entry
*bfd_hash_lookup
426 (struct bfd_hash_table
*, const char *, bfd_boolean create
,
429 /* Insert an entry in a hash table. */
430 extern struct bfd_hash_entry
*bfd_hash_insert
431 (struct bfd_hash_table
*, const char *, unsigned long);
433 /* Rename an entry in a hash table. */
434 extern void bfd_hash_rename
435 (struct bfd_hash_table
*, const char *, struct bfd_hash_entry
*);
437 /* Replace an entry in a hash table. */
438 extern void bfd_hash_replace
439 (struct bfd_hash_table
*, struct bfd_hash_entry
*old
,
440 struct bfd_hash_entry
*nw
);
442 /* Base method for creating a hash table entry. */
443 extern struct bfd_hash_entry
*bfd_hash_newfunc
444 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
446 /* Grab some space for a hash table entry. */
447 extern void *bfd_hash_allocate
448 (struct bfd_hash_table
*, unsigned int);
450 /* Traverse a hash table in a random order, calling a function on each
451 element. If the function returns FALSE, the traversal stops. The
452 INFO argument is passed to the function. */
453 extern void bfd_hash_traverse
454 (struct bfd_hash_table
*,
455 bfd_boolean (*) (struct bfd_hash_entry
*, void *),
458 /* Allows the default size of a hash table to be configured. New hash
459 tables allocated using bfd_hash_table_init will be created with
461 extern unsigned long bfd_hash_set_default_size (unsigned long);
463 /* Types of compressed DWARF debug sections. We currently support
465 enum compressed_debug_section_type
467 COMPRESS_DEBUG_NONE
= 0,
468 COMPRESS_DEBUG
= 1 << 0,
469 COMPRESS_DEBUG_GNU_ZLIB
= COMPRESS_DEBUG
| 1 << 1,
470 COMPRESS_DEBUG_GABI_ZLIB
= COMPRESS_DEBUG
| 1 << 2
473 /* This structure is used to keep track of stabs in sections
474 information while linking. */
478 /* A hash table used to hold stabs strings. */
479 struct bfd_strtab_hash
*strings
;
480 /* The header file hash table. */
481 struct bfd_hash_table includes
;
482 /* The first .stabstr section. */
483 struct bfd_section
*stabstr
;
486 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
488 /* User program access to BFD facilities. */
490 /* Direct I/O routines, for programs which know more about the object
491 file than BFD does. Use higher level routines if possible. */
493 extern bfd_size_type
bfd_bread (void *, bfd_size_type
, bfd
*);
494 extern bfd_size_type
bfd_bwrite (const void *, bfd_size_type
, bfd
*);
495 extern int bfd_seek (bfd
*, file_ptr
, int);
496 extern file_ptr
bfd_tell (bfd
*);
497 extern int bfd_flush (bfd
*);
498 extern int bfd_stat (bfd
*, struct stat
*);
500 /* Deprecated old routines. */
502 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
503 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
504 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
505 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
506 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
507 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
509 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
510 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
511 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
512 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
513 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
514 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
516 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
518 #define bfd_get_filename(abfd) ((abfd)->filename)
519 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
520 #define bfd_get_format(abfd) ((abfd)->format)
521 #define bfd_get_target(abfd) ((abfd)->xvec->name)
522 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
523 #define bfd_family_coff(abfd) \
524 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
525 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
526 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
527 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
528 #define bfd_header_big_endian(abfd) \
529 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
530 #define bfd_header_little_endian(abfd) \
531 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
532 #define bfd_get_file_flags(abfd) ((abfd)->flags)
533 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
534 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
535 #define bfd_has_map(abfd) ((abfd)->has_armap)
536 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
538 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
539 #define bfd_usrdata(abfd) ((abfd)->usrdata)
541 #define bfd_get_start_address(abfd) ((abfd)->start_address)
542 #define bfd_get_symcount(abfd) ((abfd)->symcount)
543 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
544 #define bfd_count_sections(abfd) ((abfd)->section_count)
546 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
548 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
550 extern bfd_boolean bfd_cache_close
552 /* NB: This declaration should match the autogenerated one in libbfd.h. */
554 extern bfd_boolean
bfd_cache_close_all (void);
556 extern bfd_boolean bfd_record_phdr
557 (bfd
*, unsigned long, bfd_boolean
, flagword
, bfd_boolean
, bfd_vma
,
558 bfd_boolean
, bfd_boolean
, unsigned int, struct bfd_section
**);
560 /* Byte swapping routines. */
562 bfd_uint64_t
bfd_getb64 (const void *);
563 bfd_uint64_t
bfd_getl64 (const void *);
564 bfd_int64_t
bfd_getb_signed_64 (const void *);
565 bfd_int64_t
bfd_getl_signed_64 (const void *);
566 bfd_vma
bfd_getb32 (const void *);
567 bfd_vma
bfd_getl32 (const void *);
568 bfd_signed_vma
bfd_getb_signed_32 (const void *);
569 bfd_signed_vma
bfd_getl_signed_32 (const void *);
570 bfd_vma
bfd_getb16 (const void *);
571 bfd_vma
bfd_getl16 (const void *);
572 bfd_signed_vma
bfd_getb_signed_16 (const void *);
573 bfd_signed_vma
bfd_getl_signed_16 (const void *);
574 void bfd_putb64 (bfd_uint64_t
, void *);
575 void bfd_putl64 (bfd_uint64_t
, void *);
576 void bfd_putb32 (bfd_vma
, void *);
577 void bfd_putl32 (bfd_vma
, void *);
578 void bfd_putb24 (bfd_vma
, void *);
579 void bfd_putl24 (bfd_vma
, void *);
580 void bfd_putb16 (bfd_vma
, void *);
581 void bfd_putl16 (bfd_vma
, void *);
583 /* Byte swapping routines which take size and endiannes as arguments. */
585 bfd_uint64_t
bfd_get_bits (const void *, int, bfd_boolean
);
586 void bfd_put_bits (bfd_uint64_t
, void *, int, bfd_boolean
);
588 #if defined(__STDC__) || defined(ALMOST_STDC)
589 struct ecoff_debug_info
;
590 struct ecoff_debug_swap
;
593 struct bfd_link_info
;
594 struct bfd_link_hash_entry
;
595 struct bfd_section_already_linked
;
596 struct bfd_elf_version_tree
;
599 extern bfd_boolean
bfd_section_already_linked_table_init (void);
600 extern void bfd_section_already_linked_table_free (void);
601 extern bfd_boolean _bfd_handle_already_linked
602 (struct bfd_section
*, struct bfd_section_already_linked
*,
603 struct bfd_link_info
*);
605 /* Externally visible ECOFF routines. */
607 extern bfd_boolean bfd_ecoff_set_gp_value
608 (bfd
*abfd
, bfd_vma gp_value
);
609 extern bfd_boolean bfd_ecoff_set_regmasks
610 (bfd
*abfd
, unsigned long gprmask
, unsigned long fprmask
,
611 unsigned long *cprmask
);
612 extern void *bfd_ecoff_debug_init
613 (bfd
*output_bfd
, struct ecoff_debug_info
*output_debug
,
614 const struct ecoff_debug_swap
*output_swap
, struct bfd_link_info
*);
615 extern void bfd_ecoff_debug_free
616 (void *handle
, bfd
*output_bfd
, struct ecoff_debug_info
*output_debug
,
617 const struct ecoff_debug_swap
*output_swap
, struct bfd_link_info
*);
618 extern bfd_boolean bfd_ecoff_debug_accumulate
619 (void *handle
, bfd
*output_bfd
, struct ecoff_debug_info
*output_debug
,
620 const struct ecoff_debug_swap
*output_swap
, bfd
*input_bfd
,
621 struct ecoff_debug_info
*input_debug
,
622 const struct ecoff_debug_swap
*input_swap
, struct bfd_link_info
*);
623 extern bfd_boolean bfd_ecoff_debug_accumulate_other
624 (void *handle
, bfd
*output_bfd
, struct ecoff_debug_info
*output_debug
,
625 const struct ecoff_debug_swap
*output_swap
, bfd
*input_bfd
,
626 struct bfd_link_info
*);
627 extern bfd_boolean bfd_ecoff_debug_externals
628 (bfd
*abfd
, struct ecoff_debug_info
*debug
,
629 const struct ecoff_debug_swap
*swap
, bfd_boolean relocatable
,
630 bfd_boolean (*get_extr
) (struct bfd_symbol
*, struct ecoff_extr
*),
631 void (*set_index
) (struct bfd_symbol
*, bfd_size_type
));
632 extern bfd_boolean bfd_ecoff_debug_one_external
633 (bfd
*abfd
, struct ecoff_debug_info
*debug
,
634 const struct ecoff_debug_swap
*swap
, const char *name
,
635 struct ecoff_extr
*esym
);
636 extern bfd_size_type bfd_ecoff_debug_size
637 (bfd
*abfd
, struct ecoff_debug_info
*debug
,
638 const struct ecoff_debug_swap
*swap
);
639 extern bfd_boolean bfd_ecoff_write_debug
640 (bfd
*abfd
, struct ecoff_debug_info
*debug
,
641 const struct ecoff_debug_swap
*swap
, file_ptr where
);
642 extern bfd_boolean bfd_ecoff_write_accumulated_debug
643 (void *handle
, bfd
*abfd
, struct ecoff_debug_info
*debug
,
644 const struct ecoff_debug_swap
*swap
,
645 struct bfd_link_info
*info
, file_ptr where
);
647 /* Externally visible ELF routines. */
649 struct bfd_link_needed_list
651 struct bfd_link_needed_list
*next
;
656 enum dynamic_lib_link_class
{
660 DYN_NO_ADD_NEEDED
= 4,
664 enum notice_asneeded_action
{
670 extern bfd_boolean bfd_elf_record_link_assignment
671 (bfd
*, struct bfd_link_info
*, const char *, bfd_boolean
,
673 extern struct bfd_link_needed_list
*bfd_elf_get_needed_list
674 (bfd
*, struct bfd_link_info
*);
675 extern bfd_boolean bfd_elf_get_bfd_needed_list
676 (bfd
*, struct bfd_link_needed_list
**);
677 extern bfd_boolean
bfd_elf_stack_segment_size (bfd
*, struct bfd_link_info
*,
678 const char *, bfd_vma
);
679 extern bfd_boolean bfd_elf_size_dynamic_sections
680 (bfd
*, const char *, const char *, const char *, const char *, const char *,
681 const char * const *, struct bfd_link_info
*, struct bfd_section
**);
682 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
683 (bfd
*, struct bfd_link_info
*);
684 extern void bfd_elf_set_dt_needed_name
685 (bfd
*, const char *);
686 extern const char *bfd_elf_get_dt_soname
688 extern void bfd_elf_set_dyn_lib_class
689 (bfd
*, enum dynamic_lib_link_class
);
690 extern int bfd_elf_get_dyn_lib_class
692 extern struct bfd_link_needed_list
*bfd_elf_get_runpath_list
693 (bfd
*, struct bfd_link_info
*);
694 extern int bfd_elf_discard_info
695 (bfd
*, struct bfd_link_info
*);
696 extern unsigned int _bfd_elf_default_action_discarded
697 (struct bfd_section
*);
699 /* Return an upper bound on the number of bytes required to store a
700 copy of ABFD's program header table entries. Return -1 if an error
701 occurs; bfd_get_error will return an appropriate code. */
702 extern long bfd_get_elf_phdr_upper_bound
705 /* Copy ABFD's program header table entries to *PHDRS. The entries
706 will be stored as an array of Elf_Internal_Phdr structures, as
707 defined in include/elf/internal.h. To find out how large the
708 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
710 Return the number of program header table entries read, or -1 if an
711 error occurs; bfd_get_error will return an appropriate code. */
712 extern int bfd_get_elf_phdrs
713 (bfd
*abfd
, void *phdrs
);
715 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
716 reconstruct an ELF file by reading the segments out of remote
717 memory based on the ELF file header at EHDR_VMA and the ELF program
718 headers it points to. If non-zero, SIZE is the known extent of the
719 object. If not null, *LOADBASEP is filled in with the difference
720 between the VMAs from which the segments were read, and the VMAs
721 the file headers (and hence BFD's idea of each section's VMA) put
724 The function TARGET_READ_MEMORY is called to copy LEN bytes from
725 the remote memory at target address VMA into the local buffer at
726 MYADDR; it should return zero on success or an `errno' code on
727 failure. TEMPL must be a BFD for a target with the word size and
728 byte order found in the remote memory. */
729 extern bfd
*bfd_elf_bfd_from_remote_memory
730 (bfd
*templ
, bfd_vma ehdr_vma
, bfd_size_type size
, bfd_vma
*loadbasep
,
731 int (*target_read_memory
) (bfd_vma vma
, bfd_byte
*myaddr
,
734 extern struct bfd_section
*_bfd_elf_tls_setup
735 (bfd
*, struct bfd_link_info
*);
737 extern struct bfd_section
*
738 _bfd_nearby_section (bfd
*, struct bfd_section
*, bfd_vma
);
740 extern void _bfd_fix_excluded_sec_syms
741 (bfd
*, struct bfd_link_info
*);
743 extern unsigned bfd_m68k_mach_to_features (int);
745 extern int bfd_m68k_features_to_mach (unsigned);
747 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
748 (bfd
*, struct bfd_link_info
*, struct bfd_section
*, struct bfd_section
*,
751 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info
*, int);
753 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
754 (bfd
*, struct bfd_link_info
*, struct bfd_section
*, struct bfd_section
*,
757 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
758 (bfd
*, struct bfd_link_info
*, struct bfd_section
*, struct bfd_section
*,
761 /* SunOS shared library support routines for the linker. */
763 extern struct bfd_link_needed_list
*bfd_sunos_get_needed_list
764 (bfd
*, struct bfd_link_info
*);
765 extern bfd_boolean bfd_sunos_record_link_assignment
766 (bfd
*, struct bfd_link_info
*, const char *);
767 extern bfd_boolean bfd_sunos_size_dynamic_sections
768 (bfd
*, struct bfd_link_info
*, struct bfd_section
**,
769 struct bfd_section
**, struct bfd_section
**);
771 /* Linux shared library support routines for the linker. */
773 extern bfd_boolean bfd_i386linux_size_dynamic_sections
774 (bfd
*, struct bfd_link_info
*);
775 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
776 (bfd
*, struct bfd_link_info
*);
780 struct _bfd_window_internal
;
781 typedef struct _bfd_window_internal bfd_window_internal
;
783 typedef struct _bfd_window
785 /* What the user asked for. */
788 /* The actual window used by BFD. Small user-requested read-only
789 regions sharing a page may share a single window into the object
790 file. Read-write versions shouldn't until I've fixed things to
791 keep track of which portions have been claimed by the
792 application; don't want to give the same region back when the
793 application wants two writable copies! */
794 struct _bfd_window_internal
*i
;
798 extern void bfd_init_window
800 extern void bfd_free_window
802 extern bfd_boolean bfd_get_file_window
803 (bfd
*, file_ptr
, bfd_size_type
, bfd_window
*, bfd_boolean
);
805 /* XCOFF support routines for the linker. */
807 extern bfd_boolean bfd_xcoff_split_import_path
808 (bfd
*, const char *, const char **, const char **);
809 extern bfd_boolean bfd_xcoff_set_archive_import_path
810 (struct bfd_link_info
*, bfd
*, const char *);
811 extern bfd_boolean bfd_xcoff_link_record_set
812 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*, bfd_size_type
);
813 extern bfd_boolean bfd_xcoff_import_symbol
814 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*, bfd_vma
,
815 const char *, const char *, const char *, unsigned int);
816 extern bfd_boolean bfd_xcoff_export_symbol
817 (bfd
*, struct bfd_link_info
*, struct bfd_link_hash_entry
*);
818 extern bfd_boolean bfd_xcoff_link_count_reloc
819 (bfd
*, struct bfd_link_info
*, const char *);
820 extern bfd_boolean bfd_xcoff_record_link_assignment
821 (bfd
*, struct bfd_link_info
*, const char *);
822 extern bfd_boolean bfd_xcoff_size_dynamic_sections
823 (bfd
*, struct bfd_link_info
*, const char *, const char *,
824 unsigned long, unsigned long, unsigned long, bfd_boolean
,
825 int, bfd_boolean
, unsigned int, struct bfd_section
**, bfd_boolean
);
826 extern bfd_boolean bfd_xcoff_link_generate_rtinit
827 (bfd
*, const char *, const char *, bfd_boolean
);
829 /* XCOFF support routines for ar. */
830 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
833 /* Externally visible COFF routines. */
835 #if defined(__STDC__) || defined(ALMOST_STDC)
836 struct internal_syment
;
837 union internal_auxent
;
840 extern bfd_boolean bfd_coff_set_symbol_class
841 (bfd
*, struct bfd_symbol
*, unsigned int);
843 /* ARM VFP11 erratum workaround support. */
846 BFD_ARM_VFP11_FIX_DEFAULT
,
847 BFD_ARM_VFP11_FIX_NONE
,
848 BFD_ARM_VFP11_FIX_SCALAR
,
849 BFD_ARM_VFP11_FIX_VECTOR
852 extern void bfd_elf32_arm_init_maps
855 extern void bfd_elf32_arm_set_vfp11_fix
856 (bfd
*, struct bfd_link_info
*);
858 extern void bfd_elf32_arm_set_cortex_a8_fix
859 (bfd
*, struct bfd_link_info
*);
861 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
862 (bfd
*, struct bfd_link_info
*);
864 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
865 (bfd
*, struct bfd_link_info
*);
867 /* ARM STM STM32L4XX erratum workaround support. */
870 BFD_ARM_STM32L4XX_FIX_NONE
,
871 BFD_ARM_STM32L4XX_FIX_DEFAULT
,
872 BFD_ARM_STM32L4XX_FIX_ALL
873 } bfd_arm_stm32l4xx_fix
;
875 extern void bfd_elf32_arm_set_stm32l4xx_fix
876 (bfd
*, struct bfd_link_info
*);
878 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
879 (bfd
*, struct bfd_link_info
*);
881 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
882 (bfd
*, struct bfd_link_info
*);
884 /* ARM Interworking support. Called from linker. */
885 extern bfd_boolean bfd_arm_allocate_interworking_sections
886 (struct bfd_link_info
*);
888 extern bfd_boolean bfd_arm_process_before_allocation
889 (bfd
*, struct bfd_link_info
*, int);
891 extern bfd_boolean bfd_arm_get_bfd_for_interworking
892 (bfd
*, struct bfd_link_info
*);
894 /* PE ARM Interworking support. Called from linker. */
895 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
896 (struct bfd_link_info
*);
898 extern bfd_boolean bfd_arm_pe_process_before_allocation
899 (bfd
*, struct bfd_link_info
*, int);
901 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
902 (bfd
*, struct bfd_link_info
*);
904 /* ELF ARM Interworking support. Called from linker. */
905 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
906 (struct bfd_link_info
*);
908 extern bfd_boolean bfd_elf32_arm_process_before_allocation
909 (bfd
*, struct bfd_link_info
*);
911 struct elf32_arm_params
{
912 char *thumb_entry_symbol
;
918 bfd_arm_vfp11_fix vfp11_denorm_fix
;
919 bfd_arm_stm32l4xx_fix stm32l4xx_fix
;
920 int no_enum_size_warning
;
921 int no_wchar_size_warning
;
925 int merge_exidx_entries
;
930 void bfd_elf32_arm_set_target_params
931 (bfd
*, struct bfd_link_info
*, struct elf32_arm_params
*);
933 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
934 (bfd
*, struct bfd_link_info
*);
936 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
937 (bfd
*, struct bfd_link_info
*);
939 extern void bfd_elf32_arm_keep_private_stub_output_sections
940 (struct bfd_link_info
*);
942 /* ELF ARM mapping symbol support. */
943 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
944 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
945 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
946 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
948 extern bfd_boolean bfd_is_arm_special_symbol_name
951 extern void bfd_elf32_arm_set_byteswap_code
952 (struct bfd_link_info
*, int);
954 extern void bfd_elf32_arm_use_long_plt (void);
956 /* ARM Note section processing. */
957 extern bfd_boolean bfd_arm_merge_machines
960 extern bfd_boolean bfd_arm_update_notes
961 (bfd
*, const char *);
963 extern unsigned int bfd_arm_get_mach_from_notes
964 (bfd
*, const char *);
966 /* ARM stub generation support. Called from the linker. */
967 extern int elf32_arm_setup_section_lists
968 (bfd
*, struct bfd_link_info
*);
969 extern void elf32_arm_next_input_section
970 (struct bfd_link_info
*, struct bfd_section
*);
971 extern bfd_boolean elf32_arm_size_stubs
972 (bfd
*, bfd
*, struct bfd_link_info
*, bfd_signed_vma
,
973 struct bfd_section
* (*) (const char *, struct bfd_section
*,
974 struct bfd_section
*, unsigned int),
976 extern bfd_boolean elf32_arm_build_stubs
977 (struct bfd_link_info
*);
979 /* ARM unwind section editing support. */
980 extern bfd_boolean elf32_arm_fix_exidx_coverage
981 (struct bfd_section
**, unsigned int, struct bfd_link_info
*, bfd_boolean
);
983 /* C6x unwind section editing support. */
984 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
985 (struct bfd_section
**, unsigned int, struct bfd_link_info
*, bfd_boolean
);
987 extern void bfd_elf64_aarch64_init_maps
990 extern void bfd_elf32_aarch64_init_maps
993 /* Types of PLTs based on the level of security. This would be a
994 bit-mask to denote which of the combinations of security features
996 - No security feature PLTs
997 - PLTs with BTI instruction
998 - PLTs with PAC instruction
1002 PLT_NORMAL
= 0x0, /* Normal plts. */
1003 PLT_BTI
= 0x1, /* plts with bti. */
1004 PLT_PAC
= 0x2, /* plts with pointer authentication. */
1005 PLT_BTI_PAC
= PLT_BTI
| PLT_PAC
1008 /* To indicate if BTI is enabled with/without warning. */
1011 BTI_NONE
= 0, /* BTI is not enabled. */
1012 BTI_WARN
= 1, /* BTI is enabled with -z force-bti. */
1013 } aarch64_enable_bti_type
;
1015 /* A structure to encompass all information coming from BTI or PAC
1016 related command line options. This involves the "PLT_TYPE" to determine
1017 which version of PLTs to pick and "BTI_TYPE" to determine if
1018 BTI should be turned on with any warnings. */
1021 aarch64_plt_type plt_type
;
1022 aarch64_enable_bti_type bti_type
;
1023 } aarch64_bti_pac_info
;
1025 /* An enum to define what kind of erratum fixes we should apply. This gives the
1026 user a bit more control over the sequences we generate. */
1029 ERRAT_NONE
= (1 << 0), /* No erratum workarounds allowed. */
1030 ERRAT_ADR
= (1 << 1), /* Erratum workarounds using ADR allowed. */
1031 ERRAT_ADRP
= (1 << 2), /* Erratum workarounds using ADRP are allowed. */
1032 } erratum_84319_opts
;
1034 extern void bfd_elf64_aarch64_set_options
1035 (bfd
*, struct bfd_link_info
*, int, int, int, int, erratum_84319_opts
, int,
1036 aarch64_bti_pac_info
);
1038 extern void bfd_elf32_aarch64_set_options
1039 (bfd
*, struct bfd_link_info
*, int, int, int, int, erratum_84319_opts
, int,
1040 aarch64_bti_pac_info
);
1042 /* ELF AArch64 mapping symbol support. */
1043 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
1044 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
1045 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
1046 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
1047 extern bfd_boolean bfd_is_aarch64_special_symbol_name
1048 (const char * name
, int type
);
1050 /* AArch64 stub generation support for ELF64. Called from the linker. */
1051 extern int elf64_aarch64_setup_section_lists
1052 (bfd
*, struct bfd_link_info
*);
1053 extern void elf64_aarch64_next_input_section
1054 (struct bfd_link_info
*, struct bfd_section
*);
1055 extern bfd_boolean elf64_aarch64_size_stubs
1056 (bfd
*, bfd
*, struct bfd_link_info
*, bfd_signed_vma
,
1057 struct bfd_section
* (*) (const char *, struct bfd_section
*),
1059 extern bfd_boolean elf64_aarch64_build_stubs
1060 (struct bfd_link_info
*);
1061 /* AArch64 stub generation support for ELF32. Called from the linker. */
1062 extern int elf32_aarch64_setup_section_lists
1063 (bfd
*, struct bfd_link_info
*);
1064 extern void elf32_aarch64_next_input_section
1065 (struct bfd_link_info
*, struct bfd_section
*);
1066 extern bfd_boolean elf32_aarch64_size_stubs
1067 (bfd
*, bfd
*, struct bfd_link_info
*, bfd_signed_vma
,
1068 struct bfd_section
* (*) (const char *, struct bfd_section
*),
1070 extern bfd_boolean elf32_aarch64_build_stubs
1071 (struct bfd_link_info
*);
1074 /* TI COFF load page support. */
1075 extern void bfd_ticoff_set_section_load_page
1076 (struct bfd_section
*, int);
1078 extern int bfd_ticoff_get_section_load_page
1079 (struct bfd_section
*);
1081 /* H8/300 functions. */
1082 extern bfd_vma bfd_h8300_pad_address
1085 /* IA64 Itanium code generation. Called from linker. */
1086 extern void bfd_elf32_ia64_after_parse
1089 extern void bfd_elf64_ia64_after_parse
1092 /* V850 Note manipulation routines. */
1093 extern bfd_boolean v850_elf_create_sections
1094 (struct bfd_link_info
*);
1096 extern bfd_boolean v850_elf_set_note
1097 (bfd
*, unsigned int, unsigned int);
1099 /* MIPS ABI flags data access. For the disassembler. */
1100 struct elf_internal_abiflags_v0
;
1101 extern struct elf_internal_abiflags_v0
*bfd_mips_elf_get_abiflags (bfd
*);
1103 /* C-SKY functions. */
1104 extern bfd_boolean elf32_csky_build_stubs
1105 (struct bfd_link_info
*);
1106 extern bfd_boolean elf32_csky_size_stubs
1107 (bfd
*, bfd
*, struct bfd_link_info
*, bfd_signed_vma
,
1108 struct bfd_section
*(*) (const char*, struct bfd_section
*),
1110 extern void elf32_csky_next_input_section
1111 (struct bfd_link_info
*, struct bfd_section
*);
1112 extern int elf32_csky_setup_section_lists
1113 (bfd
*, struct bfd_link_info
*);