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_get_section(x) ((x)->section)
244 #define bfd_get_output_section(x) ((x)->section->output_section)
245 #define bfd_set_section(x,y) ((x)->section) = (y)
246 #define bfd_asymbol_base(x) ((x)->section->vma)
247 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
248 #define bfd_asymbol_name(x) ((x)->name)
249 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
250 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
251 #define bfd_asymbol_flavour(x) \
252 (((x)->flags & BSF_SYNTHETIC) != 0 \
253 ? bfd_target_unknown_flavour \
254 : bfd_asymbol_bfd (x)->xvec->flavour)
256 /* A canonical archive symbol. */
257 /* This is a type pun with struct ranlib on purpose! */
258 typedef struct carsym
261 file_ptr file_offset; /* Look here to find the file. */
263 carsym; /* To make these you call a carsymogen. */
265 /* Used in generating armaps (archive tables of contents).
266 Perhaps just a forward definition would do? */
267 struct orl /* Output ranlib. */
269 char **name; /* Symbol name. */
274 } u; /* bfd* or file position. */
275 int namidx; /* Index into string table. */
278 /* Linenumber stuff. */
279 typedef struct lineno_cache_entry
281 unsigned int line_number; /* Linenumber from start of function. */
284 struct bfd_symbol *sym; /* Function name. */
285 bfd_vma offset; /* Offset into section. */
290 /* Object and core file sections. */
291 typedef struct bfd_section *sec_ptr;
293 #define align_power(addr, align) \
294 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
296 /* Align an address upward to a boundary, expressed as a number of bytes.
297 E.g. align to an 8-byte boundary with argument of 8. Take care never
298 to wrap around if the address is within boundary-1 of the end of the
300 #define BFD_ALIGN(this, boundary) \
301 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
302 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
305 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name)
306 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
307 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
308 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
309 (ptr)->alignment_power)
310 #define bfd_section_name(bfd, ptr) ((ptr)->name)
311 #define bfd_section_size(bfd, ptr) ((ptr)->size)
312 #define bfd_get_section_size(ptr) ((ptr)->size)
313 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
314 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
315 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
316 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
317 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
319 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
321 #define bfd_get_section_limit_octets(bfd, sec) \
322 ((bfd)->direction != write_direction && (sec)->rawsize != 0 \
323 ? (sec)->rawsize : (sec)->size)
325 /* Find the address one past the end of SEC. */
326 #define bfd_get_section_limit(bfd, sec) \
327 (bfd_get_section_limit_octets(bfd, sec) / bfd_octets_per_byte (bfd))
329 /* Return TRUE if input section SEC has been discarded. */
330 #define discarded_section(sec) \
331 (!bfd_is_abs_section (sec) \
332 && bfd_is_abs_section ((sec)->output_section) \
333 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \
334 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
336 typedef enum bfd_print_symbol
338 bfd_print_symbol_name,
339 bfd_print_symbol_more,
341 } bfd_print_symbol_type;
343 /* Information about a symbol that nm needs. */
345 typedef struct _symbol_info
349 const char *name; /* Symbol name. */
350 unsigned char stab_type; /* Stab type. */
351 char stab_other; /* Stab other. */
352 short stab_desc; /* Stab desc. */
353 const char *stab_name; /* String for stab type. */
356 /* Get the name of a stabs type code. */
358 extern const char *bfd_get_stab_name (int);
360 /* Hash table routines. There is no way to free up a hash table. */
362 /* An element in the hash table. Most uses will actually use a larger
363 structure, and an instance of this will be the first field. */
365 struct bfd_hash_entry
367 /* Next entry for this hash code. */
368 struct bfd_hash_entry *next;
369 /* String being hashed. */
371 /* Hash code. This is the full hash code, not the index into the
378 struct bfd_hash_table
380 /* The hash array. */
381 struct bfd_hash_entry **table;
382 /* A function used to create new elements in the hash table. The
383 first entry is itself a pointer to an element. When this
384 function is first invoked, this pointer will be NULL. However,
385 having the pointer permits a hierarchy of method functions to be
386 built each of which calls the function in the superclass. Thus
387 each function should be written to allocate a new block of memory
388 only if the argument is NULL. */
389 struct bfd_hash_entry *(*newfunc)
390 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
391 /* An objalloc for this hash table. This is a struct objalloc *,
392 but we use void * to avoid requiring the inclusion of objalloc.h. */
394 /* The number of slots in the hash table. */
396 /* The number of entries in the hash table. */
398 /* The size of elements. */
399 unsigned int entsize;
400 /* If non-zero, don't grow the hash table. */
401 unsigned int frozen:1;
404 /* Initialize a hash table. */
405 extern bfd_boolean bfd_hash_table_init
406 (struct bfd_hash_table *,
407 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
408 struct bfd_hash_table *,
412 /* Initialize a hash table specifying a size. */
413 extern bfd_boolean bfd_hash_table_init_n
414 (struct bfd_hash_table *,
415 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
416 struct bfd_hash_table *,
418 unsigned int, unsigned int);
420 /* Free up a hash table. */
421 extern void bfd_hash_table_free
422 (struct bfd_hash_table *);
424 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
425 will be created for this string if one does not already exist. The
426 COPY argument must be TRUE if this routine should copy the string
427 into newly allocated memory when adding an entry. */
428 extern struct bfd_hash_entry *bfd_hash_lookup
429 (struct bfd_hash_table *, const char *, bfd_boolean create,
432 /* Insert an entry in a hash table. */
433 extern struct bfd_hash_entry *bfd_hash_insert
434 (struct bfd_hash_table *, const char *, unsigned long);
436 /* Rename an entry in a hash table. */
437 extern void bfd_hash_rename
438 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
440 /* Replace an entry in a hash table. */
441 extern void bfd_hash_replace
442 (struct bfd_hash_table *, struct bfd_hash_entry *old,
443 struct bfd_hash_entry *nw);
445 /* Base method for creating a hash table entry. */
446 extern struct bfd_hash_entry *bfd_hash_newfunc
447 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
449 /* Grab some space for a hash table entry. */
450 extern void *bfd_hash_allocate
451 (struct bfd_hash_table *, unsigned int);
453 /* Traverse a hash table in a random order, calling a function on each
454 element. If the function returns FALSE, the traversal stops. The
455 INFO argument is passed to the function. */
456 extern void bfd_hash_traverse
457 (struct bfd_hash_table *,
458 bfd_boolean (*) (struct bfd_hash_entry *, void *),
461 /* Allows the default size of a hash table to be configured. New hash
462 tables allocated using bfd_hash_table_init will be created with
464 extern unsigned long bfd_hash_set_default_size (unsigned long);
466 /* Types of compressed DWARF debug sections. We currently support
468 enum compressed_debug_section_type
470 COMPRESS_DEBUG_NONE = 0,
471 COMPRESS_DEBUG = 1 << 0,
472 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
473 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
476 /* This structure is used to keep track of stabs in sections
477 information while linking. */
481 /* A hash table used to hold stabs strings. */
482 struct bfd_strtab_hash *strings;
483 /* The header file hash table. */
484 struct bfd_hash_table includes;
485 /* The first .stabstr section. */
486 struct bfd_section *stabstr;
489 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
491 /* User program access to BFD facilities. */
493 /* Direct I/O routines, for programs which know more about the object
494 file than BFD does. Use higher level routines if possible. */
496 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
497 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
498 extern int bfd_seek (bfd *, file_ptr, int);
499 extern file_ptr bfd_tell (bfd *);
500 extern int bfd_flush (bfd *);
501 extern int bfd_stat (bfd *, struct stat *);
503 /* Deprecated old routines. */
505 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
506 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
507 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
508 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
509 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
510 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
512 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
513 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
514 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
515 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
516 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
517 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
519 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
521 #define bfd_get_filename(abfd) ((abfd)->filename)
522 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
523 #define bfd_get_format(abfd) ((abfd)->format)
524 #define bfd_get_target(abfd) ((abfd)->xvec->name)
525 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
526 #define bfd_family_coff(abfd) \
527 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
528 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
529 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
530 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
531 #define bfd_header_big_endian(abfd) \
532 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
533 #define bfd_header_little_endian(abfd) \
534 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
535 #define bfd_get_file_flags(abfd) ((abfd)->flags)
536 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
537 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
538 #define bfd_has_map(abfd) ((abfd)->has_armap)
539 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
541 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
542 #define bfd_usrdata(abfd) ((abfd)->usrdata)
544 #define bfd_get_start_address(abfd) ((abfd)->start_address)
545 #define bfd_get_symcount(abfd) ((abfd)->symcount)
546 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
547 #define bfd_count_sections(abfd) ((abfd)->section_count)
549 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
551 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
553 extern bfd_boolean bfd_cache_close
555 /* NB: This declaration should match the autogenerated one in libbfd.h. */
557 extern bfd_boolean bfd_cache_close_all (void);
559 extern bfd_boolean bfd_record_phdr
560 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
561 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
563 /* Byte swapping routines. */
565 bfd_uint64_t bfd_getb64 (const void *);
566 bfd_uint64_t bfd_getl64 (const void *);
567 bfd_int64_t bfd_getb_signed_64 (const void *);
568 bfd_int64_t bfd_getl_signed_64 (const void *);
569 bfd_vma bfd_getb32 (const void *);
570 bfd_vma bfd_getl32 (const void *);
571 bfd_signed_vma bfd_getb_signed_32 (const void *);
572 bfd_signed_vma bfd_getl_signed_32 (const void *);
573 bfd_vma bfd_getb16 (const void *);
574 bfd_vma bfd_getl16 (const void *);
575 bfd_signed_vma bfd_getb_signed_16 (const void *);
576 bfd_signed_vma bfd_getl_signed_16 (const void *);
577 void bfd_putb64 (bfd_uint64_t, void *);
578 void bfd_putl64 (bfd_uint64_t, void *);
579 void bfd_putb32 (bfd_vma, void *);
580 void bfd_putl32 (bfd_vma, void *);
581 void bfd_putb24 (bfd_vma, void *);
582 void bfd_putl24 (bfd_vma, void *);
583 void bfd_putb16 (bfd_vma, void *);
584 void bfd_putl16 (bfd_vma, void *);
586 /* Byte swapping routines which take size and endiannes as arguments. */
588 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
589 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
591 #if defined(__STDC__) || defined(ALMOST_STDC)
592 struct ecoff_debug_info;
593 struct ecoff_debug_swap;
596 struct bfd_link_info;
597 struct bfd_link_hash_entry;
598 struct bfd_section_already_linked;
599 struct bfd_elf_version_tree;
602 extern bfd_boolean bfd_section_already_linked_table_init (void);
603 extern void bfd_section_already_linked_table_free (void);
604 extern bfd_boolean _bfd_handle_already_linked
605 (struct bfd_section *, struct bfd_section_already_linked *,
606 struct bfd_link_info *);
608 /* Externally visible ECOFF routines. */
610 extern bfd_boolean bfd_ecoff_set_gp_value
611 (bfd *abfd, bfd_vma gp_value);
612 extern bfd_boolean bfd_ecoff_set_regmasks
613 (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
614 unsigned long *cprmask);
615 extern void *bfd_ecoff_debug_init
616 (bfd *output_bfd, struct ecoff_debug_info *output_debug,
617 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
618 extern void bfd_ecoff_debug_free
619 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
620 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
621 extern bfd_boolean bfd_ecoff_debug_accumulate
622 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
623 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
624 struct ecoff_debug_info *input_debug,
625 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
626 extern bfd_boolean bfd_ecoff_debug_accumulate_other
627 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
628 const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
629 struct bfd_link_info *);
630 extern bfd_boolean bfd_ecoff_debug_externals
631 (bfd *abfd, struct ecoff_debug_info *debug,
632 const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
633 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
634 void (*set_index) (struct bfd_symbol *, bfd_size_type));
635 extern bfd_boolean bfd_ecoff_debug_one_external
636 (bfd *abfd, struct ecoff_debug_info *debug,
637 const struct ecoff_debug_swap *swap, const char *name,
638 struct ecoff_extr *esym);
639 extern bfd_size_type bfd_ecoff_debug_size
640 (bfd *abfd, struct ecoff_debug_info *debug,
641 const struct ecoff_debug_swap *swap);
642 extern bfd_boolean bfd_ecoff_write_debug
643 (bfd *abfd, struct ecoff_debug_info *debug,
644 const struct ecoff_debug_swap *swap, file_ptr where);
645 extern bfd_boolean bfd_ecoff_write_accumulated_debug
646 (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
647 const struct ecoff_debug_swap *swap,
648 struct bfd_link_info *info, file_ptr where);
650 /* Externally visible ELF routines. */
652 struct bfd_link_needed_list
654 struct bfd_link_needed_list *next;
659 enum dynamic_lib_link_class {
663 DYN_NO_ADD_NEEDED = 4,
667 enum notice_asneeded_action {
673 extern bfd_boolean bfd_elf_record_link_assignment
674 (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
676 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
677 (bfd *, struct bfd_link_info *);
678 extern bfd_boolean bfd_elf_get_bfd_needed_list
679 (bfd *, struct bfd_link_needed_list **);
680 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
681 const char *, bfd_vma);
682 extern bfd_boolean bfd_elf_size_dynamic_sections
683 (bfd *, const char *, const char *, const char *, const char *, const char *,
684 const char * const *, struct bfd_link_info *, struct bfd_section **);
685 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
686 (bfd *, struct bfd_link_info *);
687 extern void bfd_elf_set_dt_needed_name
688 (bfd *, const char *);
689 extern const char *bfd_elf_get_dt_soname
691 extern void bfd_elf_set_dyn_lib_class
692 (bfd *, enum dynamic_lib_link_class);
693 extern int bfd_elf_get_dyn_lib_class
695 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
696 (bfd *, struct bfd_link_info *);
697 extern int bfd_elf_discard_info
698 (bfd *, struct bfd_link_info *);
699 extern unsigned int _bfd_elf_default_action_discarded
700 (struct bfd_section *);
702 /* Return an upper bound on the number of bytes required to store a
703 copy of ABFD's program header table entries. Return -1 if an error
704 occurs; bfd_get_error will return an appropriate code. */
705 extern long bfd_get_elf_phdr_upper_bound
708 /* Copy ABFD's program header table entries to *PHDRS. The entries
709 will be stored as an array of Elf_Internal_Phdr structures, as
710 defined in include/elf/internal.h. To find out how large the
711 buffer needs to be, call bfd_get_elf_phdr_upper_bound.
713 Return the number of program header table entries read, or -1 if an
714 error occurs; bfd_get_error will return an appropriate code. */
715 extern int bfd_get_elf_phdrs
716 (bfd *abfd, void *phdrs);
718 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
719 reconstruct an ELF file by reading the segments out of remote
720 memory based on the ELF file header at EHDR_VMA and the ELF program
721 headers it points to. If non-zero, SIZE is the known extent of the
722 object. If not null, *LOADBASEP is filled in with the difference
723 between the VMAs from which the segments were read, and the VMAs
724 the file headers (and hence BFD's idea of each section's VMA) put
727 The function TARGET_READ_MEMORY is called to copy LEN bytes from
728 the remote memory at target address VMA into the local buffer at
729 MYADDR; it should return zero on success or an `errno' code on
730 failure. TEMPL must be a BFD for a target with the word size and
731 byte order found in the remote memory. */
732 extern bfd *bfd_elf_bfd_from_remote_memory
733 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
734 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
737 extern struct bfd_section *_bfd_elf_tls_setup
738 (bfd *, struct bfd_link_info *);
740 extern struct bfd_section *
741 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
743 extern void _bfd_fix_excluded_sec_syms
744 (bfd *, struct bfd_link_info *);
746 extern unsigned bfd_m68k_mach_to_features (int);
748 extern int bfd_m68k_features_to_mach (unsigned);
750 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
751 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
754 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
756 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
757 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
760 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
761 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
764 /* SunOS shared library support routines for the linker. */
766 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
767 (bfd *, struct bfd_link_info *);
768 extern bfd_boolean bfd_sunos_record_link_assignment
769 (bfd *, struct bfd_link_info *, const char *);
770 extern bfd_boolean bfd_sunos_size_dynamic_sections
771 (bfd *, struct bfd_link_info *, struct bfd_section **,
772 struct bfd_section **, struct bfd_section **);
774 /* Linux shared library support routines for the linker. */
776 extern bfd_boolean bfd_i386linux_size_dynamic_sections
777 (bfd *, struct bfd_link_info *);
778 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
779 (bfd *, struct bfd_link_info *);
783 struct _bfd_window_internal;
784 typedef struct _bfd_window_internal bfd_window_internal;
786 typedef struct _bfd_window
788 /* What the user asked for. */
791 /* The actual window used by BFD. Small user-requested read-only
792 regions sharing a page may share a single window into the object
793 file. Read-write versions shouldn't until I've fixed things to
794 keep track of which portions have been claimed by the
795 application; don't want to give the same region back when the
796 application wants two writable copies! */
797 struct _bfd_window_internal *i;
801 extern void bfd_init_window
803 extern void bfd_free_window
805 extern bfd_boolean bfd_get_file_window
806 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
808 /* XCOFF support routines for the linker. */
810 extern bfd_boolean bfd_xcoff_split_import_path
811 (bfd *, const char *, const char **, const char **);
812 extern bfd_boolean bfd_xcoff_set_archive_import_path
813 (struct bfd_link_info *, bfd *, const char *);
814 extern bfd_boolean bfd_xcoff_link_record_set
815 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
816 extern bfd_boolean bfd_xcoff_import_symbol
817 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
818 const char *, const char *, const char *, unsigned int);
819 extern bfd_boolean bfd_xcoff_export_symbol
820 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
821 extern bfd_boolean bfd_xcoff_link_count_reloc
822 (bfd *, struct bfd_link_info *, const char *);
823 extern bfd_boolean bfd_xcoff_record_link_assignment
824 (bfd *, struct bfd_link_info *, const char *);
825 extern bfd_boolean bfd_xcoff_size_dynamic_sections
826 (bfd *, struct bfd_link_info *, const char *, const char *,
827 unsigned long, unsigned long, unsigned long, bfd_boolean,
828 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
829 extern bfd_boolean bfd_xcoff_link_generate_rtinit
830 (bfd *, const char *, const char *, bfd_boolean);
832 /* XCOFF support routines for ar. */
833 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
836 /* Externally visible COFF routines. */
838 #if defined(__STDC__) || defined(ALMOST_STDC)
839 struct internal_syment;
840 union internal_auxent;
843 extern bfd_boolean bfd_coff_set_symbol_class
844 (bfd *, struct bfd_symbol *, unsigned int);
846 /* ARM VFP11 erratum workaround support. */
849 BFD_ARM_VFP11_FIX_DEFAULT,
850 BFD_ARM_VFP11_FIX_NONE,
851 BFD_ARM_VFP11_FIX_SCALAR,
852 BFD_ARM_VFP11_FIX_VECTOR
855 extern void bfd_elf32_arm_init_maps
858 extern void bfd_elf32_arm_set_vfp11_fix
859 (bfd *, struct bfd_link_info *);
861 extern void bfd_elf32_arm_set_cortex_a8_fix
862 (bfd *, struct bfd_link_info *);
864 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
865 (bfd *, struct bfd_link_info *);
867 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
868 (bfd *, struct bfd_link_info *);
870 /* ARM STM STM32L4XX erratum workaround support. */
873 BFD_ARM_STM32L4XX_FIX_NONE,
874 BFD_ARM_STM32L4XX_FIX_DEFAULT,
875 BFD_ARM_STM32L4XX_FIX_ALL
876 } bfd_arm_stm32l4xx_fix;
878 extern void bfd_elf32_arm_set_stm32l4xx_fix
879 (bfd *, struct bfd_link_info *);
881 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
882 (bfd *, struct bfd_link_info *);
884 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
885 (bfd *, struct bfd_link_info *);
887 /* ARM Interworking support. Called from linker. */
888 extern bfd_boolean bfd_arm_allocate_interworking_sections
889 (struct bfd_link_info *);
891 extern bfd_boolean bfd_arm_process_before_allocation
892 (bfd *, struct bfd_link_info *, int);
894 extern bfd_boolean bfd_arm_get_bfd_for_interworking
895 (bfd *, struct bfd_link_info *);
897 /* PE ARM Interworking support. Called from linker. */
898 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
899 (struct bfd_link_info *);
901 extern bfd_boolean bfd_arm_pe_process_before_allocation
902 (bfd *, struct bfd_link_info *, int);
904 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
905 (bfd *, struct bfd_link_info *);
907 /* ELF ARM Interworking support. Called from linker. */
908 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
909 (struct bfd_link_info *);
911 extern bfd_boolean bfd_elf32_arm_process_before_allocation
912 (bfd *, struct bfd_link_info *);
914 struct elf32_arm_params {
915 char *thumb_entry_symbol;
921 bfd_arm_vfp11_fix vfp11_denorm_fix;
922 bfd_arm_stm32l4xx_fix stm32l4xx_fix;
923 int no_enum_size_warning;
924 int no_wchar_size_warning;
928 int merge_exidx_entries;
933 void bfd_elf32_arm_set_target_params
934 (bfd *, struct bfd_link_info *, struct elf32_arm_params *);
936 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
937 (bfd *, struct bfd_link_info *);
939 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
940 (bfd *, struct bfd_link_info *);
942 extern void bfd_elf32_arm_keep_private_stub_output_sections
943 (struct bfd_link_info *);
945 /* ELF ARM mapping symbol support. */
946 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0)
947 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1)
948 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2)
949 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0)
951 extern bfd_boolean bfd_is_arm_special_symbol_name
954 extern void bfd_elf32_arm_set_byteswap_code
955 (struct bfd_link_info *, int);
957 extern void bfd_elf32_arm_use_long_plt (void);
959 /* ARM Note section processing. */
960 extern bfd_boolean bfd_arm_merge_machines
963 extern bfd_boolean bfd_arm_update_notes
964 (bfd *, const char *);
966 extern unsigned int bfd_arm_get_mach_from_notes
967 (bfd *, const char *);
969 /* ARM stub generation support. Called from the linker. */
970 extern int elf32_arm_setup_section_lists
971 (bfd *, struct bfd_link_info *);
972 extern void elf32_arm_next_input_section
973 (struct bfd_link_info *, struct bfd_section *);
974 extern bfd_boolean elf32_arm_size_stubs
975 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
976 struct bfd_section * (*) (const char *, struct bfd_section *,
977 struct bfd_section *, unsigned int),
979 extern bfd_boolean elf32_arm_build_stubs
980 (struct bfd_link_info *);
982 /* ARM unwind section editing support. */
983 extern bfd_boolean elf32_arm_fix_exidx_coverage
984 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
986 /* C6x unwind section editing support. */
987 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
988 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
990 extern void bfd_elf64_aarch64_init_maps
993 extern void bfd_elf32_aarch64_init_maps
996 /* Types of PLTs based on the level of security. This would be a
997 bit-mask to denote which of the combinations of security features
999 - No security feature PLTs
1000 - PLTs with BTI instruction
1001 - PLTs with PAC instruction
1005 PLT_NORMAL = 0x0, /* Normal plts. */
1006 PLT_BTI = 0x1, /* plts with bti. */
1007 PLT_PAC = 0x2, /* plts with pointer authentication. */
1008 PLT_BTI_PAC = PLT_BTI | PLT_PAC
1011 /* To indicate if BTI is enabled with/without warning. */
1014 BTI_NONE = 0, /* BTI is not enabled. */
1015 BTI_WARN = 1, /* BTI is enabled with -z force-bti. */
1016 } aarch64_enable_bti_type;
1018 /* A structure to encompass all information coming from BTI or PAC
1019 related command line options. This involves the "PLT_TYPE" to determine
1020 which version of PLTs to pick and "BTI_TYPE" to determine if
1021 BTI should be turned on with any warnings. */
1024 aarch64_plt_type plt_type;
1025 aarch64_enable_bti_type bti_type;
1026 } aarch64_bti_pac_info;
1028 /* An enum to define what kind of erratum fixes we should apply. This gives the
1029 user a bit more control over the sequences we generate. */
1032 ERRAT_NONE = (1 << 0), /* No erratum workarounds allowed. */
1033 ERRAT_ADR = (1 << 1), /* Erratum workarounds using ADR allowed. */
1034 ERRAT_ADRP = (1 << 2), /* Erratum workarounds using ADRP are allowed. */
1035 } erratum_84319_opts;
1037 extern void bfd_elf64_aarch64_set_options
1038 (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
1039 aarch64_bti_pac_info);
1041 extern void bfd_elf32_aarch64_set_options
1042 (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
1043 aarch64_bti_pac_info);
1045 /* ELF AArch64 mapping symbol support. */
1046 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0)
1047 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1)
1048 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2)
1049 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0)
1050 extern bfd_boolean bfd_is_aarch64_special_symbol_name
1051 (const char * name, int type);
1053 /* AArch64 stub generation support for ELF64. Called from the linker. */
1054 extern int elf64_aarch64_setup_section_lists
1055 (bfd *, struct bfd_link_info *);
1056 extern void elf64_aarch64_next_input_section
1057 (struct bfd_link_info *, struct bfd_section *);
1058 extern bfd_boolean elf64_aarch64_size_stubs
1059 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1060 struct bfd_section * (*) (const char *, struct bfd_section *),
1062 extern bfd_boolean elf64_aarch64_build_stubs
1063 (struct bfd_link_info *);
1064 /* AArch64 stub generation support for ELF32. Called from the linker. */
1065 extern int elf32_aarch64_setup_section_lists
1066 (bfd *, struct bfd_link_info *);
1067 extern void elf32_aarch64_next_input_section
1068 (struct bfd_link_info *, struct bfd_section *);
1069 extern bfd_boolean elf32_aarch64_size_stubs
1070 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1071 struct bfd_section * (*) (const char *, struct bfd_section *),
1073 extern bfd_boolean elf32_aarch64_build_stubs
1074 (struct bfd_link_info *);
1077 /* TI COFF load page support. */
1078 extern void bfd_ticoff_set_section_load_page
1079 (struct bfd_section *, int);
1081 extern int bfd_ticoff_get_section_load_page
1082 (struct bfd_section *);
1084 /* H8/300 functions. */
1085 extern bfd_vma bfd_h8300_pad_address
1088 /* IA64 Itanium code generation. Called from linker. */
1089 extern void bfd_elf32_ia64_after_parse
1092 extern void bfd_elf64_ia64_after_parse
1095 /* V850 Note manipulation routines. */
1096 extern bfd_boolean v850_elf_create_sections
1097 (struct bfd_link_info *);
1099 extern bfd_boolean v850_elf_set_note
1100 (bfd *, unsigned int, unsigned int);
1102 /* MIPS ABI flags data access. For the disassembler. */
1103 struct elf_internal_abiflags_v0;
1104 extern struct elf_internal_abiflags_v0 *bfd_mips_elf_get_abiflags (bfd *);
1106 /* C-SKY functions. */
1107 extern bfd_boolean elf32_csky_build_stubs
1108 (struct bfd_link_info *);
1109 extern bfd_boolean elf32_csky_size_stubs
1110 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
1111 struct bfd_section *(*) (const char*, struct bfd_section*),
1113 extern void elf32_csky_next_input_section
1114 (struct bfd_link_info *, struct bfd_section *);
1115 extern int elf32_csky_setup_section_lists
1116 (bfd *, struct bfd_link_info *);