bfd/bfd-in.h

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