bfd/bfd-in.h

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