bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2
   3    Copyright (C) 1990-2022 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 <stdint.h>
  38 #include <stdbool.h>
  39 #include "diagnostics.h"
  40 #include <stdarg.h>
  41 #include <string.h>
  42 #include <sys/stat.h>
  43
  44 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  45 #ifndef SABER
  46 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
  47    The problem is, "32_" is not a valid preprocessing token, and we don't
  48    want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will
  49    cause the inner CONCAT2 macros to be evaluated first, producing
  50    still-valid pp-tokens.  Then the final concatenation can be done.  */
  51 #undef CONCAT4
  52 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  53 #endif
  54 #endif
  55
  56 /* This is a utility macro to handle the situation where the code
  57    wants to place a constant string into the code, followed by a
  58    comma and then the length of the string.  Doing this by hand
  59    is error prone, so using this macro is safer.  */
  60 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
  61
  62 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
  63
  64 /* The word size used by BFD on the host.  This may be 64 with a 32
  65    bit target if the host is 64 bit, or if other 64 bit targets have
  66    been selected with --enable-targets, or if --enable-64-bit-bfd.  */
  67 #define BFD_ARCH_SIZE @wordsize@
  68
  69 /* The word size of the default bfd target.  */
  70 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  71
  72 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  73 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
  74 #if @BFD_HOST_64_BIT_DEFINED@
  75 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  76 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  77 typedef BFD_HOST_64_BIT bfd_int64_t;
  78 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
  79 #endif
  80
  81 #include <inttypes.h>
  82
  83 #if BFD_ARCH_SIZE >= 64
  84 #define BFD64
  85 #endif
  86
  87 /* Declaring a type wide enough to hold a host long and a host pointer.  */
  88 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
  89 typedef BFD_HOSTPTR_T bfd_hostptr_t;
  90
  91 /* Forward declaration.  */
  92 typedef struct bfd bfd;
  93
  94 /* Boolean type used in bfd.
  95    General rule: Functions which are bfd_boolean return TRUE on
  96    success and FALSE on failure (unless they're a predicate).  */
  97
  98 #ifdef POISON_BFD_BOOLEAN
  99 # pragma GCC poison bfd_boolean
 100 #else
 101 # define bfd_boolean bool
 102 # undef FALSE
 103 # undef TRUE
 104 # define FALSE 0
 105 # define TRUE 1
 106 #endif
 107
 108 /* Silence "applying zero offset to null pointer" UBSAN warnings.  */
 109 #define PTR_ADD(P,A) ((A) != 0 ? (P) + (A) : (P))
 110 /* Also prevent non-zero offsets from being applied to a null pointer.  */
 111 #define NPTR_ADD(P,A) ((P) != NULL ? (P) + (A) : (P))
 112
 113 #ifdef BFD64
 114
 115 #ifndef BFD_HOST_64_BIT
 116  #error No 64 bit integer type available
 117 #endif /* ! defined (BFD_HOST_64_BIT) */
 118
 119 typedef BFD_HOST_U_64_BIT bfd_vma;
 120 typedef BFD_HOST_64_BIT bfd_signed_vma;
 121 typedef BFD_HOST_U_64_BIT bfd_size_type;
 122 typedef BFD_HOST_U_64_BIT symvalue;
 123
 124 #if BFD_HOST_64BIT_LONG
 125 #define BFD_VMA_FMT "l"
 126 #elif defined (__MSVCRT__)
 127 #define BFD_VMA_FMT "I64"
 128 #else
 129 #define BFD_VMA_FMT "ll"
 130 #endif
 131
 132 #ifndef fprintf_vma
 133 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
 134 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
 135 #endif
 136
 137 #else /* not BFD64  */
 138
 139 /* Represent a target address.  Also used as a generic unsigned type
 140    which is guaranteed to be big enough to hold any arithmetic types
 141    we need to deal with.  */
 142 typedef unsigned long bfd_vma;
 143
 144 /* A generic signed type which is guaranteed to be big enough to hold any
 145    arithmetic types we need to deal with.  Can be assumed to be compatible
 146    with bfd_vma in the same way that signed and unsigned ints are compatible
 147    (as parameters, in assignment, etc).  */
 148 typedef long bfd_signed_vma;
 149
 150 typedef unsigned long symvalue;
 151 typedef unsigned long bfd_size_type;
 152
 153 /* Print a bfd_vma x on stream s.  */
 154 #define BFD_VMA_FMT "l"
 155 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
 156 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
 157
 158 #endif /* not BFD64  */
 159
 160 #define HALF_BFD_SIZE_TYPE \
 161   (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
 162
 163 #ifndef BFD_HOST_64_BIT
 164 /* Fall back on a 32 bit type.  The idea is to make these types always
 165    available for function return types, but in the case that
 166    BFD_HOST_64_BIT is undefined such a function should abort or
 167    otherwise signal an error.  */
 168 typedef bfd_signed_vma bfd_int64_t;
 169 typedef bfd_vma bfd_uint64_t;
 170 #endif
 171
 172 /* An offset into a file.  BFD always uses the largest possible offset
 173    based on the build time availability of fseek, fseeko, or fseeko64.  */
 174 typedef @bfd_file_ptr@ file_ptr;
 175 typedef unsigned @bfd_file_ptr@ ufile_ptr;
 176
 177 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
 178 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
 179
 180 #define printf_vma(x) fprintf_vma(stdout,x)
 181 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 182
 183 typedef unsigned int flagword;  /* 32 bits of flags */
 184 typedef unsigned char bfd_byte;
 185 \f
 186 /* File formats.  */
 187
 188 typedef enum bfd_format
 189 {
 190   bfd_unknown = 0,      /* File format is unknown.  */
 191   bfd_object,           /* Linker/assembler/compiler output.  */
 192   bfd_archive,          /* Object archive file.  */
 193   bfd_core,             /* Core dump.  */
 194   bfd_type_end          /* Marks the end; don't use it!  */
 195 }
 196 bfd_format;
 197 \f
 198 /* Symbols and relocation.  */
 199
 200 /* A count of carsyms (canonical archive symbols).  */
 201 typedef unsigned long symindex;
 202
 203 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 204
 205 /* A canonical archive symbol.  */
 206 /* This is a type pun with struct ranlib on purpose!  */
 207 typedef struct carsym
 208 {
 209   const char *name;
 210   file_ptr file_offset; /* Look here to find the file.  */
 211 }
 212 carsym;                 /* To make these you call a carsymogen.  */
 213
 214 /* Used in generating armaps (archive tables of contents).
 215    Perhaps just a forward definition would do?  */
 216 struct orl              /* Output ranlib.  */
 217 {
 218   char **name;          /* Symbol name.  */
 219   union
 220   {
 221     file_ptr pos;
 222     bfd *abfd;
 223   } u;                  /* bfd* or file position.  */
 224   int namidx;           /* Index into string table.  */
 225 };
 226
 227 /* Linenumber stuff.  */
 228 typedef struct lineno_cache_entry
 229 {
 230   unsigned int line_number;     /* Linenumber from start of function.  */
 231   union
 232   {
 233     struct bfd_symbol *sym;     /* Function name.  */
 234     bfd_vma offset;             /* Offset into section.  */
 235   } u;
 236 }
 237 alent;
 238 \f
 239 /* Object and core file sections.  */
 240 typedef struct bfd_section *sec_ptr;
 241
 242 #define align_power(addr, align)        \
 243   (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
 244
 245 /* Align an address upward to a boundary, expressed as a number of bytes.
 246    E.g. align to an 8-byte boundary with argument of 8.  Take care never
 247    to wrap around if the address is within boundary-1 of the end of the
 248    address space.  */
 249 #define BFD_ALIGN(this, boundary)                                         \
 250   ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this))              \
 251    ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
 252    : ~ (bfd_vma) 0)
 253 \f
 254 typedef enum bfd_print_symbol
 255 {
 256   bfd_print_symbol_name,
 257   bfd_print_symbol_more,
 258   bfd_print_symbol_all
 259 } bfd_print_symbol_type;
 260
 261 /* Information about a symbol that nm needs.  */
 262
 263 typedef struct _symbol_info
 264 {
 265   symvalue value;
 266   char type;
 267   const char *name;             /* Symbol name.  */
 268   unsigned char stab_type;      /* Stab type.  */
 269   char stab_other;              /* Stab other.  */
 270   short stab_desc;              /* Stab desc.  */
 271   const char *stab_name;        /* String for stab type.  */
 272 } symbol_info;
 273
 274 /* Get the name of a stabs type code.  */
 275
 276 extern const char *bfd_get_stab_name (int);
 277 \f
 278 /* Hash table routines.  There is no way to free up a hash table.  */
 279
 280 /* An element in the hash table.  Most uses will actually use a larger
 281    structure, and an instance of this will be the first field.  */
 282
 283 struct bfd_hash_entry
 284 {
 285   /* Next entry for this hash code.  */
 286   struct bfd_hash_entry *next;
 287   /* String being hashed.  */
 288   const char *string;
 289   /* Hash code.  This is the full hash code, not the index into the
 290      table.  */
 291   unsigned long hash;
 292 };
 293
 294 /* A hash table.  */
 295
 296 struct bfd_hash_table
 297 {
 298   /* The hash array.  */
 299   struct bfd_hash_entry **table;
 300   /* A function used to create new elements in the hash table.  The
 301      first entry is itself a pointer to an element.  When this
 302      function is first invoked, this pointer will be NULL.  However,
 303      having the pointer permits a hierarchy of method functions to be
 304      built each of which calls the function in the superclass.  Thus
 305      each function should be written to allocate a new block of memory
 306      only if the argument is NULL.  */
 307   struct bfd_hash_entry *(*newfunc)
 308     (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 309   /* An objalloc for this hash table.  This is a struct objalloc *,
 310      but we use void * to avoid requiring the inclusion of objalloc.h.  */
 311   void *memory;
 312   /* The number of slots in the hash table.  */
 313   unsigned int size;
 314   /* The number of entries in the hash table.  */
 315   unsigned int count;
 316   /* The size of elements.  */
 317   unsigned int entsize;
 318   /* If non-zero, don't grow the hash table.  */
 319   unsigned int frozen:1;
 320 };
 321
 322 /* Initialize a hash table.  */
 323 extern bool bfd_hash_table_init
 324   (struct bfd_hash_table *,
 325    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 326                                struct bfd_hash_table *,
 327                                const char *),
 328    unsigned int);
 329
 330 /* Initialize a hash table specifying a size.  */
 331 extern bool bfd_hash_table_init_n
 332   (struct bfd_hash_table *,
 333    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 334                                struct bfd_hash_table *,
 335                                const char *),
 336    unsigned int, unsigned int);
 337
 338 /* Free up a hash table.  */
 339 extern void bfd_hash_table_free
 340   (struct bfd_hash_table *);
 341
 342 /* Look up a string in a hash table.  If CREATE is TRUE, a new entry
 343    will be created for this string if one does not already exist.  The
 344    COPY argument must be TRUE if this routine should copy the string
 345    into newly allocated memory when adding an entry.  */
 346 extern struct bfd_hash_entry *bfd_hash_lookup
 347   (struct bfd_hash_table *, const char *, bool create, bool copy);
 348
 349 /* Insert an entry in a hash table.  */
 350 extern struct bfd_hash_entry *bfd_hash_insert
 351   (struct bfd_hash_table *, const char *, unsigned long);
 352
 353 /* Rename an entry in a hash table.  */
 354 extern void bfd_hash_rename
 355   (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
 356
 357 /* Replace an entry in a hash table.  */
 358 extern void bfd_hash_replace
 359   (struct bfd_hash_table *, struct bfd_hash_entry *old,
 360    struct bfd_hash_entry *nw);
 361
 362 /* Base method for creating a hash table entry.  */
 363 extern struct bfd_hash_entry *bfd_hash_newfunc
 364   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 365
 366 /* Grab some space for a hash table entry.  */
 367 extern void *bfd_hash_allocate
 368   (struct bfd_hash_table *, unsigned int);
 369
 370 /* Traverse a hash table in a random order, calling a function on each
 371    element.  If the function returns FALSE, the traversal stops.  The
 372    INFO argument is passed to the function.  */
 373 extern void bfd_hash_traverse
 374   (struct bfd_hash_table *,
 375    bool (*) (struct bfd_hash_entry *, void *),
 376    void *info);
 377
 378 /* Allows the default size of a hash table to be configured. New hash
 379    tables allocated using bfd_hash_table_init will be created with
 380    this size.  */
 381 extern unsigned long bfd_hash_set_default_size (unsigned long);
 382
 383 /* Types of compressed DWARF debug sections.  We currently support
 384    zlib.  */
 385 enum compressed_debug_section_type
 386 {
 387   COMPRESS_DEBUG_NONE = 0,
 388   COMPRESS_DEBUG = 1 << 0,
 389   COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
 390   COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
 391 };
 392
 393 /* This structure is used to keep track of stabs in sections
 394    information while linking.  */
 395
 396 struct stab_info
 397 {
 398   /* A hash table used to hold stabs strings.  */
 399   struct bfd_strtab_hash *strings;
 400   /* The header file hash table.  */
 401   struct bfd_hash_table includes;
 402   /* The first .stabstr section.  */
 403   struct bfd_section *stabstr;
 404 };
 405
 406 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
 407
 408 /* User program access to BFD facilities.  */
 409
 410 /* Direct I/O routines, for programs which know more about the object
 411    file than BFD does.  Use higher level routines if possible.  */
 412
 413 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
 414 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
 415 extern int bfd_seek (bfd *, file_ptr, int);
 416 extern file_ptr bfd_tell (bfd *);
 417 extern int bfd_flush (bfd *);
 418 extern int bfd_stat (bfd *, struct stat *);
 419
 420 /* Deprecated old routines.  */
 421 #if __GNUC__
 422 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 423   (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
 424    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 425 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 426   (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
 427    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 428 #else
 429 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 430   (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 431    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 432 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 433   (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 434    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 435 #endif
 436 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
 437
 438 extern bool bfd_cache_close
 439   (bfd *abfd);
 440 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 441
 442 extern bool bfd_cache_close_all (void);
 443
 444 extern bool bfd_record_phdr
 445   (bfd *, unsigned long, bool, flagword, bool, bfd_vma,
 446    bool, bool, unsigned int, struct bfd_section **);
 447
 448 /* Byte swapping routines.  */
 449
 450 bfd_uint64_t bfd_getb64 (const void *);
 451 bfd_uint64_t bfd_getl64 (const void *);
 452 bfd_int64_t bfd_getb_signed_64 (const void *);
 453 bfd_int64_t bfd_getl_signed_64 (const void *);
 454 bfd_vma bfd_getb32 (const void *);
 455 bfd_vma bfd_getl32 (const void *);
 456 bfd_signed_vma bfd_getb_signed_32 (const void *);
 457 bfd_signed_vma bfd_getl_signed_32 (const void *);
 458 bfd_vma bfd_getb16 (const void *);
 459 bfd_vma bfd_getl16 (const void *);
 460 bfd_signed_vma bfd_getb_signed_16 (const void *);
 461 bfd_signed_vma bfd_getl_signed_16 (const void *);
 462 void bfd_putb64 (bfd_uint64_t, void *);
 463 void bfd_putl64 (bfd_uint64_t, void *);
 464 void bfd_putb32 (bfd_vma, void *);
 465 void bfd_putl32 (bfd_vma, void *);
 466 void bfd_putb24 (bfd_vma, void *);
 467 void bfd_putl24 (bfd_vma, void *);
 468 void bfd_putb16 (bfd_vma, void *);
 469 void bfd_putl16 (bfd_vma, void *);
 470
 471 /* Byte swapping routines which take size and endiannes as arguments.  */
 472
 473 bfd_uint64_t bfd_get_bits (const void *, int, bool);
 474 void bfd_put_bits (bfd_uint64_t, void *, int, bool);
 475
 476
 477 /* mmap hacks */
 478
 479 struct _bfd_window_internal;
 480 typedef struct _bfd_window_internal bfd_window_internal;
 481
 482 typedef struct _bfd_window
 483 {
 484   /* What the user asked for.  */
 485   void *data;
 486   bfd_size_type size;
 487   /* The actual window used by BFD.  Small user-requested read-only
 488      regions sharing a page may share a single window into the object
 489      file.  Read-write versions shouldn't until I've fixed things to
 490      keep track of which portions have been claimed by the
 491      application; don't want to give the same region back when the
 492      application wants two writable copies!  */
 493   struct _bfd_window_internal *i;
 494 }
 495 bfd_window;
 496
 497 extern void bfd_init_window
 498   (bfd_window *);
 499 extern void bfd_free_window
 500   (bfd_window *);
 501 extern bool bfd_get_file_window
 502   (bfd *, file_ptr, bfd_size_type, bfd_window *, bool);
 503 \f
 504 /* Externally visible ELF routines.  */
 505
 506 /* Create a new BFD as if by bfd_openr.  Rather than opening a file,
 507    reconstruct an ELF file by reading the segments out of remote
 508    memory based on the ELF file header at EHDR_VMA and the ELF program
 509    headers it points to.  If non-zero, SIZE is the known extent of the
 510    object.  If not null, *LOADBASEP is filled in with the difference
 511    between the VMAs from which the segments were read, and the VMAs
 512    the file headers (and hence BFD's idea of each section's VMA) put
 513    them at.
 514
 515    The function TARGET_READ_MEMORY is called to copy LEN bytes from
 516    the remote memory at target address VMA into the local buffer at
 517    MYADDR; it should return zero on success or an `errno' code on
 518    failure.  TEMPL must be a BFD for a target with the word size and
 519    byte order found in the remote memory.  */
 520 extern bfd *bfd_elf_bfd_from_remote_memory
 521   (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
 522    int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
 523                               bfd_size_type len));
 524
 525 /* Forward declarations.  */
 526 struct ecoff_debug_info;
 527 struct ecoff_debug_swap;
 528 struct ecoff_extr;
 529 struct bfd_link_info;
 530 struct bfd_link_hash_entry;
 531
 532 /* Return TRUE if the start of STR matches PREFIX, FALSE otherwise.  */
 533
 534 static inline bool
 535 startswith (const char *str, const char *prefix)
 536 {
 537   return strncmp (str, prefix, strlen (prefix)) == 0;
 538 }