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