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