bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2
   3    Copyright (C) 1990-2019 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Support.
   6
   7    This file is part of BFD, the Binary File Descriptor library.
   8
   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.
  13
  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.
  18
  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.  */
  22
  23 #ifndef __BFD_H_SEEN__
  24 #define __BFD_H_SEEN__
  25
  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
  29 #endif
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include "ansidecl.h"
  36 #include "symcat.h"
  37 #include "bfd_stdint.h"
  38 #include "diagnostics.h"
  39 #include <stdarg.h>
  40 #include <sys/stat.h>
  41
  42 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  43 #ifndef SABER
  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.  */
  49 #undef CONCAT4
  50 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  51 #endif
  52 #endif
  53
  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.
  66
  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))
  75
  76
  77 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
  78
  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@
  83
  84 /* The word size of the default bfd target.  */
  85 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  86
  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;
  94 #endif
  95
  96 #ifdef HAVE_INTTYPES_H
  97 # include <inttypes.h>
  98 #else
  99 # if BFD_HOST_64BIT_LONG
 100 #  define BFD_PRI64 "l"
 101 # elif defined (__MSVCRT__)
 102 #  define BFD_PRI64 "I64"
 103 # else
 104 #  define BFD_PRI64 "ll"
 105 # endif
 106 # undef PRId64
 107 # define PRId64 BFD_PRI64 "d"
 108 # undef PRIu64
 109 # define PRIu64 BFD_PRI64 "u"
 110 # undef PRIx64
 111 # define PRIx64 BFD_PRI64 "x"
 112 #endif
 113
 114 #if BFD_ARCH_SIZE >= 64
 115 #define BFD64
 116 #endif
 117
 118 #ifndef INLINE
 119 #if __GNUC__ >= 2
 120 #define INLINE __inline__
 121 #else
 122 #define INLINE
 123 #endif
 124 #endif
 125
 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;
 129
 130 /* Forward declaration.  */
 131 typedef struct bfd bfd;
 132
 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.
 138
 139    General rule: Functions which are bfd_boolean return TRUE on
 140    success and FALSE on failure (unless they're a predicate).  */
 141
 142 typedef int bfd_boolean;
 143 #undef FALSE
 144 #undef TRUE
 145 #define FALSE 0
 146 #define TRUE 1
 147
 148 #ifdef BFD64
 149
 150 #ifndef BFD_HOST_64_BIT
 151  #error No 64 bit integer type available
 152 #endif /* ! defined (BFD_HOST_64_BIT) */
 153
 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;
 158
 159 #if BFD_HOST_64BIT_LONG
 160 #define BFD_VMA_FMT "l"
 161 #elif defined (__MSVCRT__)
 162 #define BFD_VMA_FMT "I64"
 163 #else
 164 #define BFD_VMA_FMT "ll"
 165 #endif
 166
 167 #ifndef fprintf_vma
 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)
 170 #endif
 171
 172 #else /* not BFD64  */
 173
 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;
 178
 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;
 184
 185 typedef unsigned long symvalue;
 186 typedef unsigned long bfd_size_type;
 187
 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)
 192
 193 #endif /* not BFD64  */
 194
 195 #define HALF_BFD_SIZE_TYPE \
 196   (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
 197
 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;
 205 #endif
 206
 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;
 211
 212 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
 213 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
 214
 215 #define printf_vma(x) fprintf_vma(stdout,x)
 216 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 217
 218 typedef unsigned int flagword;  /* 32 bits of flags */
 219 typedef unsigned char bfd_byte;
 220 \f
 221 /* File formats.  */
 222
 223 typedef enum bfd_format
 224 {
 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!  */
 230 }
 231 bfd_format;
 232 \f
 233 /* Symbols and relocation.  */
 234
 235 /* A count of carsyms (canonical archive symbols).  */
 236 typedef unsigned long symindex;
 237
 238 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 239
 240 /* A canonical archive symbol.  */
 241 /* This is a type pun with struct ranlib on purpose!  */
 242 typedef struct carsym
 243 {
 244   const char *name;
 245   file_ptr file_offset; /* Look here to find the file.  */
 246 }
 247 carsym;                 /* To make these you call a carsymogen.  */
 248
 249 /* Used in generating armaps (archive tables of contents).
 250    Perhaps just a forward definition would do?  */
 251 struct orl              /* Output ranlib.  */
 252 {
 253   char **name;          /* Symbol name.  */
 254   union
 255   {
 256     file_ptr pos;
 257     bfd *abfd;
 258   } u;                  /* bfd* or file position.  */
 259   int namidx;           /* Index into string table.  */
 260 };
 261
 262 /* Linenumber stuff.  */
 263 typedef struct lineno_cache_entry
 264 {
 265   unsigned int line_number;     /* Linenumber from start of function.  */
 266   union
 267   {
 268     struct bfd_symbol *sym;     /* Function name.  */
 269     bfd_vma offset;             /* Offset into section.  */
 270   } u;
 271 }
 272 alent;
 273 \f
 274 /* Object and core file sections.  */
 275 typedef struct bfd_section *sec_ptr;
 276
 277 #define align_power(addr, align)        \
 278   (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
 279
 280 /* Align an address upward to a boundary, expressed as a number of bytes.
 281    E.g. align to an 8-byte boundary with argument of 8.  Take care never
 282    to wrap around if the address is within boundary-1 of the end of the
 283    address space.  */
 284 #define BFD_ALIGN(this, boundary)                                         \
 285   ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this))              \
 286    ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
 287    : ~ (bfd_vma) 0)
 288 \f
 289 typedef enum bfd_print_symbol
 290 {
 291   bfd_print_symbol_name,
 292   bfd_print_symbol_more,
 293   bfd_print_symbol_all
 294 } bfd_print_symbol_type;
 295
 296 /* Information about a symbol that nm needs.  */
 297
 298 typedef struct _symbol_info
 299 {
 300   symvalue value;
 301   char type;
 302   const char *name;             /* Symbol name.  */
 303   unsigned char stab_type;      /* Stab type.  */
 304   char stab_other;              /* Stab other.  */
 305   short stab_desc;              /* Stab desc.  */
 306   const char *stab_name;        /* String for stab type.  */
 307 } symbol_info;
 308
 309 /* Get the name of a stabs type code.  */
 310
 311 extern const char *bfd_get_stab_name (int);
 312 \f
 313 /* Hash table routines.  There is no way to free up a hash table.  */
 314
 315 /* An element in the hash table.  Most uses will actually use a larger
 316    structure, and an instance of this will be the first field.  */
 317
 318 struct bfd_hash_entry
 319 {
 320   /* Next entry for this hash code.  */
 321   struct bfd_hash_entry *next;
 322   /* String being hashed.  */
 323   const char *string;
 324   /* Hash code.  This is the full hash code, not the index into the
 325      table.  */
 326   unsigned long hash;
 327 };
 328
 329 /* A hash table.  */
 330
 331 struct bfd_hash_table
 332 {
 333   /* The hash array.  */
 334   struct bfd_hash_entry **table;
 335   /* A function used to create new elements in the hash table.  The
 336      first entry is itself a pointer to an element.  When this
 337      function is first invoked, this pointer will be NULL.  However,
 338      having the pointer permits a hierarchy of method functions to be
 339      built each of which calls the function in the superclass.  Thus
 340      each function should be written to allocate a new block of memory
 341      only if the argument is NULL.  */
 342   struct bfd_hash_entry *(*newfunc)
 343     (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 344   /* An objalloc for this hash table.  This is a struct objalloc *,
 345      but we use void * to avoid requiring the inclusion of objalloc.h.  */
 346   void *memory;
 347   /* The number of slots in the hash table.  */
 348   unsigned int size;
 349   /* The number of entries in the hash table.  */
 350   unsigned int count;
 351   /* The size of elements.  */
 352   unsigned int entsize;
 353   /* If non-zero, don't grow the hash table.  */
 354   unsigned int frozen:1;
 355 };
 356
 357 /* Initialize a hash table.  */
 358 extern bfd_boolean bfd_hash_table_init
 359   (struct bfd_hash_table *,
 360    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 361                                struct bfd_hash_table *,
 362                                const char *),
 363    unsigned int);
 364
 365 /* Initialize a hash table specifying a size.  */
 366 extern bfd_boolean bfd_hash_table_init_n
 367   (struct bfd_hash_table *,
 368    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 369                                struct bfd_hash_table *,
 370                                const char *),
 371    unsigned int, unsigned int);
 372
 373 /* Free up a hash table.  */
 374 extern void bfd_hash_table_free
 375   (struct bfd_hash_table *);
 376
 377 /* Look up a string in a hash table.  If CREATE is TRUE, a new entry
 378    will be created for this string if one does not already exist.  The
 379    COPY argument must be TRUE if this routine should copy the string
 380    into newly allocated memory when adding an entry.  */
 381 extern struct bfd_hash_entry *bfd_hash_lookup
 382   (struct bfd_hash_table *, const char *, bfd_boolean create,
 383    bfd_boolean copy);
 384
 385 /* Insert an entry in a hash table.  */
 386 extern struct bfd_hash_entry *bfd_hash_insert
 387   (struct bfd_hash_table *, const char *, unsigned long);
 388
 389 /* Rename an entry in a hash table.  */
 390 extern void bfd_hash_rename
 391   (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
 392
 393 /* Replace an entry in a hash table.  */
 394 extern void bfd_hash_replace
 395   (struct bfd_hash_table *, struct bfd_hash_entry *old,
 396    struct bfd_hash_entry *nw);
 397
 398 /* Base method for creating a hash table entry.  */
 399 extern struct bfd_hash_entry *bfd_hash_newfunc
 400   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 401
 402 /* Grab some space for a hash table entry.  */
 403 extern void *bfd_hash_allocate
 404   (struct bfd_hash_table *, unsigned int);
 405
 406 /* Traverse a hash table in a random order, calling a function on each
 407    element.  If the function returns FALSE, the traversal stops.  The
 408    INFO argument is passed to the function.  */
 409 extern void bfd_hash_traverse
 410   (struct bfd_hash_table *,
 411    bfd_boolean (*) (struct bfd_hash_entry *, void *),
 412    void *info);
 413
 414 /* Allows the default size of a hash table to be configured. New hash
 415    tables allocated using bfd_hash_table_init will be created with
 416    this size.  */
 417 extern unsigned long bfd_hash_set_default_size (unsigned long);
 418
 419 /* Types of compressed DWARF debug sections.  We currently support
 420    zlib.  */
 421 enum compressed_debug_section_type
 422 {
 423   COMPRESS_DEBUG_NONE = 0,
 424   COMPRESS_DEBUG = 1 << 0,
 425   COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
 426   COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
 427 };
 428
 429 /* This structure is used to keep track of stabs in sections
 430    information while linking.  */
 431
 432 struct stab_info
 433 {
 434   /* A hash table used to hold stabs strings.  */
 435   struct bfd_strtab_hash *strings;
 436   /* The header file hash table.  */
 437   struct bfd_hash_table includes;
 438   /* The first .stabstr section.  */
 439   struct bfd_section *stabstr;
 440 };
 441
 442 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
 443
 444 /* User program access to BFD facilities.  */
 445
 446 /* Direct I/O routines, for programs which know more about the object
 447    file than BFD does.  Use higher level routines if possible.  */
 448
 449 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
 450 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
 451 extern int bfd_seek (bfd *, file_ptr, int);
 452 extern file_ptr bfd_tell (bfd *);
 453 extern int bfd_flush (bfd *);
 454 extern int bfd_stat (bfd *, struct stat *);
 455
 456 /* Deprecated old routines.  */
 457 #if __GNUC__
 458 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 459   (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
 460    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 461 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 462   (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
 463    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 464 #else
 465 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 466   (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 467    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 468 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 469   (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 470    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 471 #endif
 472 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
 473
 474 extern bfd_boolean bfd_cache_close
 475   (bfd *abfd);
 476 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 477
 478 extern bfd_boolean bfd_cache_close_all (void);
 479
 480 extern bfd_boolean bfd_record_phdr
 481   (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
 482    bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
 483
 484 /* Byte swapping routines.  */
 485
 486 bfd_uint64_t bfd_getb64 (const void *);
 487 bfd_uint64_t bfd_getl64 (const void *);
 488 bfd_int64_t bfd_getb_signed_64 (const void *);
 489 bfd_int64_t bfd_getl_signed_64 (const void *);
 490 bfd_vma bfd_getb32 (const void *);
 491 bfd_vma bfd_getl32 (const void *);
 492 bfd_signed_vma bfd_getb_signed_32 (const void *);
 493 bfd_signed_vma bfd_getl_signed_32 (const void *);
 494 bfd_vma bfd_getb16 (const void *);
 495 bfd_vma bfd_getl16 (const void *);
 496 bfd_signed_vma bfd_getb_signed_16 (const void *);
 497 bfd_signed_vma bfd_getl_signed_16 (const void *);
 498 void bfd_putb64 (bfd_uint64_t, void *);
 499 void bfd_putl64 (bfd_uint64_t, void *);
 500 void bfd_putb32 (bfd_vma, void *);
 501 void bfd_putl32 (bfd_vma, void *);
 502 void bfd_putb24 (bfd_vma, void *);
 503 void bfd_putl24 (bfd_vma, void *);
 504 void bfd_putb16 (bfd_vma, void *);
 505 void bfd_putl16 (bfd_vma, void *);
 506
 507 /* Byte swapping routines which take size and endiannes as arguments.  */
 508
 509 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
 510 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
 511
 512 #if defined(__STDC__) || defined(ALMOST_STDC)
 513 struct ecoff_debug_info;
 514 struct ecoff_debug_swap;
 515 struct ecoff_extr;
 516 struct bfd_symbol;
 517 struct bfd_link_info;
 518 struct bfd_link_hash_entry;
 519 struct bfd_section_already_linked;
 520 struct bfd_elf_version_tree;
 521 #endif
 522
 523 extern bfd_boolean bfd_section_already_linked_table_init (void);
 524 extern void bfd_section_already_linked_table_free (void);
 525 extern bfd_boolean _bfd_handle_already_linked
 526   (struct bfd_section *, struct bfd_section_already_linked *,
 527    struct bfd_link_info *);
 528 \f
 529 /* Externally visible ECOFF routines.  */
 530
 531 extern bfd_boolean bfd_ecoff_set_gp_value
 532   (bfd *abfd, bfd_vma gp_value);
 533 extern bfd_boolean bfd_ecoff_set_regmasks
 534   (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 535    unsigned long *cprmask);
 536 extern void *bfd_ecoff_debug_init
 537   (bfd *output_bfd, struct ecoff_debug_info *output_debug,
 538    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 539 extern void bfd_ecoff_debug_free
 540   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 541    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 542 extern bfd_boolean bfd_ecoff_debug_accumulate
 543   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 544    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 545    struct ecoff_debug_info *input_debug,
 546    const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
 547 extern bfd_boolean bfd_ecoff_debug_accumulate_other
 548   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 549    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 550    struct bfd_link_info *);
 551 extern bfd_boolean bfd_ecoff_debug_externals
 552   (bfd *abfd, struct ecoff_debug_info *debug,
 553    const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
 554    bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
 555    void (*set_index) (struct bfd_symbol *, bfd_size_type));
 556 extern bfd_boolean bfd_ecoff_debug_one_external
 557   (bfd *abfd, struct ecoff_debug_info *debug,
 558    const struct ecoff_debug_swap *swap, const char *name,
 559    struct ecoff_extr *esym);
 560 extern bfd_size_type bfd_ecoff_debug_size
 561   (bfd *abfd, struct ecoff_debug_info *debug,
 562    const struct ecoff_debug_swap *swap);
 563 extern bfd_boolean bfd_ecoff_write_debug
 564   (bfd *abfd, struct ecoff_debug_info *debug,
 565    const struct ecoff_debug_swap *swap, file_ptr where);
 566 extern bfd_boolean bfd_ecoff_write_accumulated_debug
 567   (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
 568    const struct ecoff_debug_swap *swap,
 569    struct bfd_link_info *info, file_ptr where);
 570
 571 /* Externally visible ELF routines.  */
 572
 573 struct bfd_link_needed_list
 574 {
 575   struct bfd_link_needed_list *next;
 576   bfd *by;
 577   const char *name;
 578 };
 579
 580 enum dynamic_lib_link_class {
 581   DYN_NORMAL = 0,
 582   DYN_AS_NEEDED = 1,
 583   DYN_DT_NEEDED = 2,
 584   DYN_NO_ADD_NEEDED = 4,
 585   DYN_NO_NEEDED = 8
 586 };
 587
 588 enum notice_asneeded_action {
 589   notice_as_needed,
 590   notice_not_needed,
 591   notice_needed
 592 };
 593
 594 extern bfd_boolean bfd_elf_record_link_assignment
 595   (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
 596    bfd_boolean);
 597 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 598   (bfd *, struct bfd_link_info *);
 599 extern bfd_boolean bfd_elf_get_bfd_needed_list
 600   (bfd *, struct bfd_link_needed_list **);
 601 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *,
 602                                                const char *, bfd_vma);
 603 extern bfd_boolean bfd_elf_size_dynamic_sections
 604   (bfd *, const char *, const char *, const char *, const char *, const char *,
 605    const char * const *, struct bfd_link_info *, struct bfd_section **);
 606 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
 607   (bfd *, struct bfd_link_info *);
 608 extern void bfd_elf_set_dt_needed_name
 609   (bfd *, const char *);
 610 extern const char *bfd_elf_get_dt_soname
 611   (bfd *);
 612 extern void bfd_elf_set_dyn_lib_class
 613   (bfd *, enum dynamic_lib_link_class);
 614 extern int bfd_elf_get_dyn_lib_class
 615   (bfd *);
 616 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 617   (bfd *, struct bfd_link_info *);
 618 extern int bfd_elf_discard_info
 619   (bfd *, struct bfd_link_info *);
 620 extern unsigned int _bfd_elf_default_action_discarded
 621   (struct bfd_section *);
 622
 623 /* Return an upper bound on the number of bytes required to store a
 624    copy of ABFD's program header table entries.  Return -1 if an error
 625    occurs; bfd_get_error will return an appropriate code.  */
 626 extern long bfd_get_elf_phdr_upper_bound
 627   (bfd *abfd);
 628
 629 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 630    will be stored as an array of Elf_Internal_Phdr structures, as
 631    defined in include/elf/internal.h.  To find out how large the
 632    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 633
 634    Return the number of program header table entries read, or -1 if an
 635    error occurs; bfd_get_error will return an appropriate code.  */
 636 extern int bfd_get_elf_phdrs
 637   (bfd *abfd, void *phdrs);
 638
 639 /* Create a new BFD as if by bfd_openr.  Rather than opening a file,
 640    reconstruct an ELF file by reading the segments out of remote
 641    memory based on the ELF file header at EHDR_VMA and the ELF program
 642    headers it points to.  If non-zero, SIZE is the known extent of the
 643    object.  If not null, *LOADBASEP is filled in with the difference
 644    between the VMAs from which the segments were read, and the VMAs
 645    the file headers (and hence BFD's idea of each section's VMA) put
 646    them at.
 647
 648    The function TARGET_READ_MEMORY is called to copy LEN bytes from
 649    the remote memory at target address VMA into the local buffer at
 650    MYADDR; it should return zero on success or an `errno' code on
 651    failure.  TEMPL must be a BFD for a target with the word size and
 652    byte order found in the remote memory.  */
 653 extern bfd *bfd_elf_bfd_from_remote_memory
 654   (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
 655    int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
 656                               bfd_size_type len));
 657
 658 extern struct bfd_section *_bfd_elf_tls_setup
 659   (bfd *, struct bfd_link_info *);
 660
 661 extern struct bfd_section *
 662 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
 663
 664 extern void _bfd_fix_excluded_sec_syms
 665   (bfd *, struct bfd_link_info *);
 666
 667 extern unsigned bfd_m68k_mach_to_features (int);
 668
 669 extern int bfd_m68k_features_to_mach (unsigned);
 670
 671 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
 672   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
 673    char **);
 674
 675 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
 676
 677 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
 678   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
 679    char **);
 680
 681 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs
 682   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
 683    char **);
 684
 685 /* SunOS shared library support routines for the linker.  */
 686
 687 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 688   (bfd *, struct bfd_link_info *);
 689 extern bfd_boolean bfd_sunos_record_link_assignment
 690   (bfd *, struct bfd_link_info *, const char *);
 691 extern bfd_boolean bfd_sunos_size_dynamic_sections
 692   (bfd *, struct bfd_link_info *, struct bfd_section **,
 693    struct bfd_section **, struct bfd_section **);
 694
 695 /* Linux shared library support routines for the linker.  */
 696
 697 extern bfd_boolean bfd_i386linux_size_dynamic_sections
 698   (bfd *, struct bfd_link_info *);
 699 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
 700   (bfd *, struct bfd_link_info *);
 701
 702 /* mmap hacks */
 703
 704 struct _bfd_window_internal;
 705 typedef struct _bfd_window_internal bfd_window_internal;
 706
 707 typedef struct _bfd_window
 708 {
 709   /* What the user asked for.  */
 710   void *data;
 711   bfd_size_type size;
 712   /* The actual window used by BFD.  Small user-requested read-only
 713      regions sharing a page may share a single window into the object
 714      file.  Read-write versions shouldn't until I've fixed things to
 715      keep track of which portions have been claimed by the
 716      application; don't want to give the same region back when the
 717      application wants two writable copies!  */
 718   struct _bfd_window_internal *i;
 719 }
 720 bfd_window;
 721
 722 extern void bfd_init_window
 723   (bfd_window *);
 724 extern void bfd_free_window
 725   (bfd_window *);
 726 extern bfd_boolean bfd_get_file_window
 727   (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
 728
 729 /* XCOFF support routines for the linker.  */
 730
 731 extern bfd_boolean bfd_xcoff_split_import_path
 732   (bfd *, const char *, const char **, const char **);
 733 extern bfd_boolean bfd_xcoff_set_archive_import_path
 734   (struct bfd_link_info *, bfd *, const char *);
 735 extern bfd_boolean bfd_xcoff_link_record_set
 736   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
 737 extern bfd_boolean bfd_xcoff_import_symbol
 738   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
 739    const char *, const char *, const char *, unsigned int);
 740 extern bfd_boolean bfd_xcoff_export_symbol
 741   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
 742 extern bfd_boolean bfd_xcoff_link_count_reloc
 743   (bfd *, struct bfd_link_info *, const char *);
 744 extern bfd_boolean bfd_xcoff_record_link_assignment
 745   (bfd *, struct bfd_link_info *, const char *);
 746 extern bfd_boolean bfd_xcoff_size_dynamic_sections
 747   (bfd *, struct bfd_link_info *, const char *, const char *,
 748    unsigned long, unsigned long, unsigned long, bfd_boolean,
 749    int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean);
 750 extern bfd_boolean bfd_xcoff_link_generate_rtinit
 751   (bfd *, const char *, const char *, bfd_boolean);
 752
 753 /* XCOFF support routines for ar.  */
 754 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
 755   (bfd *, char *);
 756
 757 /* Externally visible COFF routines.  */
 758
 759 #if defined(__STDC__) || defined(ALMOST_STDC)
 760 struct internal_syment;
 761 union internal_auxent;
 762 #endif
 763
 764 extern bfd_boolean bfd_coff_set_symbol_class
 765   (bfd *, struct bfd_symbol *, unsigned int);
 766
 767 /* ARM VFP11 erratum workaround support.  */
 768 typedef enum
 769 {
 770   BFD_ARM_VFP11_FIX_DEFAULT,
 771   BFD_ARM_VFP11_FIX_NONE,
 772   BFD_ARM_VFP11_FIX_SCALAR,
 773   BFD_ARM_VFP11_FIX_VECTOR
 774 } bfd_arm_vfp11_fix;
 775
 776 extern void bfd_elf32_arm_init_maps
 777   (bfd *);
 778
 779 extern void bfd_elf32_arm_set_vfp11_fix
 780   (bfd *, struct bfd_link_info *);
 781
 782 extern void bfd_elf32_arm_set_cortex_a8_fix
 783   (bfd *, struct bfd_link_info *);
 784
 785 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
 786   (bfd *, struct bfd_link_info *);
 787
 788 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
 789   (bfd *, struct bfd_link_info *);
 790
 791 /* ARM STM STM32L4XX erratum workaround support.  */
 792 typedef enum
 793 {
 794   BFD_ARM_STM32L4XX_FIX_NONE,
 795   BFD_ARM_STM32L4XX_FIX_DEFAULT,
 796   BFD_ARM_STM32L4XX_FIX_ALL
 797 } bfd_arm_stm32l4xx_fix;
 798
 799 extern void bfd_elf32_arm_set_stm32l4xx_fix
 800   (bfd *, struct bfd_link_info *);
 801
 802 extern bfd_boolean bfd_elf32_arm_stm32l4xx_erratum_scan
 803   (bfd *, struct bfd_link_info *);
 804
 805 extern void bfd_elf32_arm_stm32l4xx_fix_veneer_locations
 806   (bfd *, struct bfd_link_info *);
 807
 808 /* ARM Interworking support.  Called from linker.  */
 809 extern bfd_boolean bfd_arm_allocate_interworking_sections
 810   (struct bfd_link_info *);
 811
 812 extern bfd_boolean bfd_arm_process_before_allocation
 813   (bfd *, struct bfd_link_info *, int);
 814
 815 extern bfd_boolean bfd_arm_get_bfd_for_interworking
 816   (bfd *, struct bfd_link_info *);
 817
 818 /* PE ARM Interworking support.  Called from linker.  */
 819 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
 820   (struct bfd_link_info *);
 821
 822 extern bfd_boolean bfd_arm_pe_process_before_allocation
 823   (bfd *, struct bfd_link_info *, int);
 824
 825 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
 826   (bfd *, struct bfd_link_info *);
 827
 828 /* ELF ARM Interworking support.  Called from linker.  */
 829 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
 830   (struct bfd_link_info *);
 831
 832 extern bfd_boolean bfd_elf32_arm_process_before_allocation
 833   (bfd *, struct bfd_link_info *);
 834
 835 struct elf32_arm_params {
 836   char *thumb_entry_symbol;
 837   int byteswap_code;
 838   int target1_is_rel;
 839   char * target2_type;
 840   int fix_v4bx;
 841   int use_blx;
 842   bfd_arm_vfp11_fix vfp11_denorm_fix;
 843   bfd_arm_stm32l4xx_fix stm32l4xx_fix;
 844   int no_enum_size_warning;
 845   int no_wchar_size_warning;
 846   int pic_veneer;
 847   int fix_cortex_a8;
 848   int fix_arm1176;
 849   int merge_exidx_entries;
 850   int cmse_implib;
 851   bfd *in_implib_bfd;
 852 };
 853
 854 void bfd_elf32_arm_set_target_params
 855   (bfd *, struct bfd_link_info *, struct elf32_arm_params *);
 856
 857 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
 858   (bfd *, struct bfd_link_info *);
 859
 860 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
 861   (bfd *, struct bfd_link_info *);
 862
 863 extern void bfd_elf32_arm_keep_private_stub_output_sections
 864   (struct bfd_link_info *);
 865
 866 /* ELF ARM mapping symbol support.  */
 867 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP    (1 << 0)
 868 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG    (1 << 1)
 869 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER  (1 << 2)
 870 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY    (~0)
 871
 872 extern bfd_boolean bfd_is_arm_special_symbol_name
 873   (const char *, int);
 874
 875 extern void bfd_elf32_arm_set_byteswap_code
 876   (struct bfd_link_info *, int);
 877
 878 extern void bfd_elf32_arm_use_long_plt (void);
 879
 880 /* ARM Note section processing.  */
 881 extern bfd_boolean bfd_arm_merge_machines
 882   (bfd *, bfd *);
 883
 884 extern bfd_boolean bfd_arm_update_notes
 885   (bfd *, const char *);
 886
 887 extern unsigned int bfd_arm_get_mach_from_notes
 888   (bfd *, const char *);
 889
 890 /* ARM stub generation support.  Called from the linker.  */
 891 extern int elf32_arm_setup_section_lists
 892   (bfd *, struct bfd_link_info *);
 893 extern void elf32_arm_next_input_section
 894   (struct bfd_link_info *, struct bfd_section *);
 895 extern bfd_boolean elf32_arm_size_stubs
 896   (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
 897    struct bfd_section * (*) (const char *, struct bfd_section *,
 898                              struct bfd_section *, unsigned int),
 899    void (*) (void));
 900 extern bfd_boolean elf32_arm_build_stubs
 901   (struct bfd_link_info *);
 902
 903 /* ARM unwind section editing support.  */
 904 extern bfd_boolean elf32_arm_fix_exidx_coverage
 905 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
 906
 907 /* C6x unwind section editing support.  */
 908 extern bfd_boolean elf32_tic6x_fix_exidx_coverage
 909 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean);
 910
 911 extern void bfd_elf64_aarch64_init_maps
 912   (bfd *);
 913
 914 extern void bfd_elf32_aarch64_init_maps
 915   (bfd *);
 916
 917 /* Types of PLTs based on the level of security.  This would be a
 918    bit-mask to denote which of the combinations of security features
 919    are enabled:
 920    - No security feature PLTs
 921    - PLTs with BTI instruction
 922    - PLTs with PAC instruction
 923 */
 924 typedef enum
 925 {
 926   PLT_NORMAL    = 0x0,  /* Normal plts.  */
 927   PLT_BTI       = 0x1,  /* plts with bti.  */
 928   PLT_PAC       = 0x2,  /* plts with pointer authentication.  */
 929   PLT_BTI_PAC   = PLT_BTI | PLT_PAC
 930 } aarch64_plt_type;
 931
 932 /* To indicate if BTI is enabled with/without warning.  */
 933 typedef enum
 934 {
 935   BTI_NONE      = 0,  /* BTI is not enabled.  */
 936   BTI_WARN      = 1,  /* BTI is enabled with -z force-bti.  */
 937 } aarch64_enable_bti_type;
 938
 939 /* A structure to encompass all information coming from BTI or PAC
 940    related command line options.  This involves the "PLT_TYPE" to determine
 941    which version of PLTs to pick and "BTI_TYPE" to determine if
 942    BTI should be turned on with any warnings.   */
 943 typedef struct
 944 {
 945   aarch64_plt_type plt_type;
 946   aarch64_enable_bti_type bti_type;
 947 } aarch64_bti_pac_info;
 948
 949 /* An enum to define what kind of erratum fixes we should apply.  This gives the
 950    user a bit more control over the sequences we generate.  */
 951 typedef enum
 952 {
 953   ERRAT_NONE  = (1 << 0),  /* No erratum workarounds allowed.  */
 954   ERRAT_ADR   = (1 << 1),  /* Erratum workarounds using ADR allowed.  */
 955   ERRAT_ADRP  = (1 << 2),  /* Erratum workarounds using ADRP are allowed.  */
 956 } erratum_84319_opts;
 957
 958 extern void bfd_elf64_aarch64_set_options
 959   (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
 960    aarch64_bti_pac_info);
 961
 962 extern void bfd_elf32_aarch64_set_options
 963   (bfd *, struct bfd_link_info *, int, int, int, int, erratum_84319_opts, int,
 964    aarch64_bti_pac_info);
 965
 966 /* ELF AArch64 mapping symbol support.  */
 967 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP        (1 << 0)
 968 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG        (1 << 1)
 969 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER      (1 << 2)
 970 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY        (~0)
 971 extern bfd_boolean bfd_is_aarch64_special_symbol_name
 972   (const char * name, int type);
 973
 974 /* AArch64 stub generation support for ELF64.  Called from the linker.  */
 975 extern int elf64_aarch64_setup_section_lists
 976   (bfd *, struct bfd_link_info *);
 977 extern void elf64_aarch64_next_input_section
 978   (struct bfd_link_info *, struct bfd_section *);
 979 extern bfd_boolean elf64_aarch64_size_stubs
 980   (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
 981    struct bfd_section * (*) (const char *, struct bfd_section *),
 982    void (*) (void));
 983 extern bfd_boolean elf64_aarch64_build_stubs
 984   (struct bfd_link_info *);
 985 /* AArch64 stub generation support for ELF32.  Called from the linker.  */
 986 extern int elf32_aarch64_setup_section_lists
 987   (bfd *, struct bfd_link_info *);
 988 extern void elf32_aarch64_next_input_section
 989   (struct bfd_link_info *, struct bfd_section *);
 990 extern bfd_boolean elf32_aarch64_size_stubs
 991   (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
 992    struct bfd_section * (*) (const char *, struct bfd_section *),
 993    void (*) (void));
 994 extern bfd_boolean elf32_aarch64_build_stubs
 995   (struct bfd_link_info *);
 996
 997
 998 /* TI COFF load page support.  */
 999 extern void bfd_ticoff_set_section_load_page
1000   (struct bfd_section *, int);
1001
1002 extern int bfd_ticoff_get_section_load_page
1003   (struct bfd_section *);