123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538 |
- /* Main header file for the bfd library -- portable access to object files.
- Copyright (C) 1990-2022 Free Software Foundation, Inc.
- Contributed by Cygnus Support.
- This file is part of BFD, the Binary File Descriptor library.
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
- #ifndef __BFD_H_SEEN__
- #define __BFD_H_SEEN__
- /* PR 14072: Ensure that config.h is included first. */
- #if !defined PACKAGE && !defined PACKAGE_VERSION
- #error config.h must be included before this header
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include "ansidecl.h"
- #include "symcat.h"
- #include <stdint.h>
- #include <stdbool.h>
- #include "diagnostics.h"
- #include <stdarg.h>
- #include <string.h>
- #include <sys/stat.h>
- #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
- #ifndef SABER
- /* This hack is to avoid a problem with some strict ANSI C preprocessors.
- The problem is, "32_" is not a valid preprocessing token, and we don't
- want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
- cause the inner CONCAT2 macros to be evaluated first, producing
- still-valid pp-tokens. Then the final concatenation can be done. */
- #undef CONCAT4
- #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
- #endif
- #endif
- /* This is a utility macro to handle the situation where the code
- wants to place a constant string into the code, followed by a
- comma and then the length of the string. Doing this by hand
- is error prone, so using this macro is safer. */
- #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
- #define BFD_SUPPORTS_PLUGINS @supports_plugins@
- /* The word size used by BFD on the host. This may be 64 with a 32
- bit target if the host is 64 bit, or if other 64 bit targets have
- been selected with --enable-targets, or if --enable-64-bit-bfd. */
- #define BFD_ARCH_SIZE @wordsize@
- /* The word size of the default bfd target. */
- #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
- #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
- #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
- #if @BFD_HOST_64_BIT_DEFINED@
- #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
- #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
- typedef BFD_HOST_64_BIT bfd_int64_t;
- typedef BFD_HOST_U_64_BIT bfd_uint64_t;
- #endif
- #include <inttypes.h>
- #if BFD_ARCH_SIZE >= 64
- #define BFD64
- #endif
- /* Declaring a type wide enough to hold a host long and a host pointer. */
- #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
- typedef BFD_HOSTPTR_T bfd_hostptr_t;
- /* Forward declaration. */
- typedef struct bfd bfd;
- /* Boolean type used in bfd.
- General rule: Functions which are bfd_boolean return TRUE on
- success and FALSE on failure (unless they're a predicate). */
- #ifdef POISON_BFD_BOOLEAN
- # pragma GCC poison bfd_boolean
- #else
- # define bfd_boolean bool
- # undef FALSE
- # undef TRUE
- # define FALSE 0
- # define TRUE 1
- #endif
- /* Silence "applying zero offset to null pointer" UBSAN warnings. */
- #define PTR_ADD(P,A) ((A) != 0 ? (P) + (A) : (P))
- /* Also prevent non-zero offsets from being applied to a null pointer. */
- #define NPTR_ADD(P,A) ((P) != NULL ? (P) + (A) : (P))
- #ifdef BFD64
- #ifndef BFD_HOST_64_BIT
- #error No 64 bit integer type available
- #endif /* ! defined (BFD_HOST_64_BIT) */
- typedef BFD_HOST_U_64_BIT bfd_vma;
- typedef BFD_HOST_64_BIT bfd_signed_vma;
- typedef BFD_HOST_U_64_BIT bfd_size_type;
- typedef BFD_HOST_U_64_BIT symvalue;
- #if BFD_HOST_64BIT_LONG
- #define BFD_VMA_FMT "l"
- #elif defined (__MSVCRT__)
- #define BFD_VMA_FMT "I64"
- #else
- #define BFD_VMA_FMT "ll"
- #endif
- #ifndef fprintf_vma
- #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
- #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
- #endif
- #else /* not BFD64 */
- /* Represent a target address. Also used as a generic unsigned type
- which is guaranteed to be big enough to hold any arithmetic types
- we need to deal with. */
- typedef unsigned long bfd_vma;
- /* A generic signed type which is guaranteed to be big enough to hold any
- arithmetic types we need to deal with. Can be assumed to be compatible
- with bfd_vma in the same way that signed and unsigned ints are compatible
- (as parameters, in assignment, etc). */
- typedef long bfd_signed_vma;
- typedef unsigned long symvalue;
- typedef unsigned long bfd_size_type;
- /* Print a bfd_vma x on stream s. */
- #define BFD_VMA_FMT "l"
- #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
- #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
- #endif /* not BFD64 */
- #define HALF_BFD_SIZE_TYPE \
- (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
- #ifndef BFD_HOST_64_BIT
- /* Fall back on a 32 bit type. The idea is to make these types always
- available for function return types, but in the case that
- BFD_HOST_64_BIT is undefined such a function should abort or
- otherwise signal an error. */
- typedef bfd_signed_vma bfd_int64_t;
- typedef bfd_vma bfd_uint64_t;
- #endif
- /* An offset into a file. BFD always uses the largest possible offset
- based on the build time availability of fseek, fseeko, or fseeko64. */
- typedef @bfd_file_ptr@ file_ptr;
- typedef unsigned @bfd_file_ptr@ ufile_ptr;
- extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
- extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
- #define printf_vma(x) fprintf_vma(stdout,x)
- #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
- typedef unsigned int flagword; /* 32 bits of flags */
- typedef unsigned char bfd_byte;
- /* File formats. */
- typedef enum bfd_format
- {
- bfd_unknown = 0, /* File format is unknown. */
- bfd_object, /* Linker/assembler/compiler output. */
- bfd_archive, /* Object archive file. */
- bfd_core, /* Core dump. */
- bfd_type_end /* Marks the end; don't use it! */
- }
- bfd_format;
- /* Symbols and relocation. */
- /* A count of carsyms (canonical archive symbols). */
- typedef unsigned long symindex;
- #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
- /* A canonical archive symbol. */
- /* This is a type pun with struct ranlib on purpose! */
- typedef struct carsym
- {
- const char *name;
- file_ptr file_offset; /* Look here to find the file. */
- }
- carsym; /* To make these you call a carsymogen. */
- /* Used in generating armaps (archive tables of contents).
- Perhaps just a forward definition would do? */
- struct orl /* Output ranlib. */
- {
- char **name; /* Symbol name. */
- union
- {
- file_ptr pos;
- bfd *abfd;
- } u; /* bfd* or file position. */
- int namidx; /* Index into string table. */
- };
- /* Linenumber stuff. */
- typedef struct lineno_cache_entry
- {
- unsigned int line_number; /* Linenumber from start of function. */
- union
- {
- struct bfd_symbol *sym; /* Function name. */
- bfd_vma offset; /* Offset into section. */
- } u;
- }
- alent;
- /* Object and core file sections. */
- typedef struct bfd_section *sec_ptr;
- #define align_power(addr, align) \
- (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
- /* Align an address upward to a boundary, expressed as a number of bytes.
- E.g. align to an 8-byte boundary with argument of 8. Take care never
- to wrap around if the address is within boundary-1 of the end of the
- address space. */
- #define BFD_ALIGN(this, boundary) \
- ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
- ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
- : ~ (bfd_vma) 0)
- typedef enum bfd_print_symbol
- {
- bfd_print_symbol_name,
- bfd_print_symbol_more,
- bfd_print_symbol_all
- } bfd_print_symbol_type;
- /* Information about a symbol that nm needs. */
- typedef struct _symbol_info
- {
- symvalue value;
- char type;
- const char *name; /* Symbol name. */
- unsigned char stab_type; /* Stab type. */
- char stab_other; /* Stab other. */
- short stab_desc; /* Stab desc. */
- const char *stab_name; /* String for stab type. */
- } symbol_info;
- /* Get the name of a stabs type code. */
- extern const char *bfd_get_stab_name (int);
- /* Hash table routines. There is no way to free up a hash table. */
- /* An element in the hash table. Most uses will actually use a larger
- structure, and an instance of this will be the first field. */
- struct bfd_hash_entry
- {
- /* Next entry for this hash code. */
- struct bfd_hash_entry *next;
- /* String being hashed. */
- const char *string;
- /* Hash code. This is the full hash code, not the index into the
- table. */
- unsigned long hash;
- };
- /* A hash table. */
- struct bfd_hash_table
- {
- /* The hash array. */
- struct bfd_hash_entry **table;
- /* A function used to create new elements in the hash table. The
- first entry is itself a pointer to an element. When this
- function is first invoked, this pointer will be NULL. However,
- having the pointer permits a hierarchy of method functions to be
- built each of which calls the function in the superclass. Thus
- each function should be written to allocate a new block of memory
- only if the argument is NULL. */
- struct bfd_hash_entry *(*newfunc)
- (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
- /* An objalloc for this hash table. This is a struct objalloc *,
- but we use void * to avoid requiring the inclusion of objalloc.h. */
- void *memory;
- /* The number of slots in the hash table. */
- unsigned int size;
- /* The number of entries in the hash table. */
- unsigned int count;
- /* The size of elements. */
- unsigned int entsize;
- /* If non-zero, don't grow the hash table. */
- unsigned int frozen:1;
- };
- /* Initialize a hash table. */
- extern bool bfd_hash_table_init
- (struct bfd_hash_table *,
- struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
- struct bfd_hash_table *,
- const char *),
- unsigned int);
- /* Initialize a hash table specifying a size. */
- extern bool bfd_hash_table_init_n
- (struct bfd_hash_table *,
- struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
- struct bfd_hash_table *,
- const char *),
- unsigned int, unsigned int);
- /* Free up a hash table. */
- extern void bfd_hash_table_free
- (struct bfd_hash_table *);
- /* Look up a string in a hash table. If CREATE is TRUE, a new entry
- will be created for this string if one does not already exist. The
- COPY argument must be TRUE if this routine should copy the string
- into newly allocated memory when adding an entry. */
- extern struct bfd_hash_entry *bfd_hash_lookup
- (struct bfd_hash_table *, const char *, bool create, bool copy);
- /* Insert an entry in a hash table. */
- extern struct bfd_hash_entry *bfd_hash_insert
- (struct bfd_hash_table *, const char *, unsigned long);
- /* Rename an entry in a hash table. */
- extern void bfd_hash_rename
- (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
- /* Replace an entry in a hash table. */
- extern void bfd_hash_replace
- (struct bfd_hash_table *, struct bfd_hash_entry *old,
- struct bfd_hash_entry *nw);
- /* Base method for creating a hash table entry. */
- extern struct bfd_hash_entry *bfd_hash_newfunc
- (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
- /* Grab some space for a hash table entry. */
- extern void *bfd_hash_allocate
- (struct bfd_hash_table *, unsigned int);
- /* Traverse a hash table in a random order, calling a function on each
- element. If the function returns FALSE, the traversal stops. The
- INFO argument is passed to the function. */
- extern void bfd_hash_traverse
- (struct bfd_hash_table *,
- bool (*) (struct bfd_hash_entry *, void *),
- void *info);
- /* Allows the default size of a hash table to be configured. New hash
- tables allocated using bfd_hash_table_init will be created with
- this size. */
- extern unsigned long bfd_hash_set_default_size (unsigned long);
- /* Types of compressed DWARF debug sections. We currently support
- zlib. */
- enum compressed_debug_section_type
- {
- COMPRESS_DEBUG_NONE = 0,
- COMPRESS_DEBUG = 1 << 0,
- COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1,
- COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2
- };
- /* This structure is used to keep track of stabs in sections
- information while linking. */
- struct stab_info
- {
- /* A hash table used to hold stabs strings. */
- struct bfd_strtab_hash *strings;
- /* The header file hash table. */
- struct bfd_hash_table includes;
- /* The first .stabstr section. */
- struct bfd_section *stabstr;
- };
- #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
- /* User program access to BFD facilities. */
- /* Direct I/O routines, for programs which know more about the object
- file than BFD does. Use higher level routines if possible. */
- extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
- extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
- extern int bfd_seek (bfd *, file_ptr, int);
- extern file_ptr bfd_tell (bfd *);
- extern int bfd_flush (bfd *);
- extern int bfd_stat (bfd *, struct stat *);
- /* Deprecated old routines. */
- #if __GNUC__
- #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
- (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
- bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
- #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
- (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
- bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
- #else
- #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
- (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
- bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
- #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
- (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
- bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
- #endif
- extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
- extern bool bfd_cache_close
- (bfd *abfd);
- /* NB: This declaration should match the autogenerated one in libbfd.h. */
- extern bool bfd_cache_close_all (void);
- extern bool bfd_record_phdr
- (bfd *, unsigned long, bool, flagword, bool, bfd_vma,
- bool, bool, unsigned int, struct bfd_section **);
- /* Byte swapping routines. */
- bfd_uint64_t bfd_getb64 (const void *);
- bfd_uint64_t bfd_getl64 (const void *);
- bfd_int64_t bfd_getb_signed_64 (const void *);
- bfd_int64_t bfd_getl_signed_64 (const void *);
- bfd_vma bfd_getb32 (const void *);
- bfd_vma bfd_getl32 (const void *);
- bfd_signed_vma bfd_getb_signed_32 (const void *);
- bfd_signed_vma bfd_getl_signed_32 (const void *);
- bfd_vma bfd_getb16 (const void *);
- bfd_vma bfd_getl16 (const void *);
- bfd_signed_vma bfd_getb_signed_16 (const void *);
- bfd_signed_vma bfd_getl_signed_16 (const void *);
- void bfd_putb64 (bfd_uint64_t, void *);
- void bfd_putl64 (bfd_uint64_t, void *);
- void bfd_putb32 (bfd_vma, void *);
- void bfd_putl32 (bfd_vma, void *);
- void bfd_putb24 (bfd_vma, void *);
- void bfd_putl24 (bfd_vma, void *);
- void bfd_putb16 (bfd_vma, void *);
- void bfd_putl16 (bfd_vma, void *);
- /* Byte swapping routines which take size and endiannes as arguments. */
- bfd_uint64_t bfd_get_bits (const void *, int, bool);
- void bfd_put_bits (bfd_uint64_t, void *, int, bool);
- /* mmap hacks */
- struct _bfd_window_internal;
- typedef struct _bfd_window_internal bfd_window_internal;
- typedef struct _bfd_window
- {
- /* What the user asked for. */
- void *data;
- bfd_size_type size;
- /* The actual window used by BFD. Small user-requested read-only
- regions sharing a page may share a single window into the object
- file. Read-write versions shouldn't until I've fixed things to
- keep track of which portions have been claimed by the
- application; don't want to give the same region back when the
- application wants two writable copies! */
- struct _bfd_window_internal *i;
- }
- bfd_window;
- extern void bfd_init_window
- (bfd_window *);
- extern void bfd_free_window
- (bfd_window *);
- extern bool bfd_get_file_window
- (bfd *, file_ptr, bfd_size_type, bfd_window *, bool);
- /* Externally visible ELF routines. */
- /* Create a new BFD as if by bfd_openr. Rather than opening a file,
- reconstruct an ELF file by reading the segments out of remote
- memory based on the ELF file header at EHDR_VMA and the ELF program
- headers it points to. If non-zero, SIZE is the known extent of the
- object. If not null, *LOADBASEP is filled in with the difference
- between the VMAs from which the segments were read, and the VMAs
- the file headers (and hence BFD's idea of each section's VMA) put
- them at.
- The function TARGET_READ_MEMORY is called to copy LEN bytes from
- the remote memory at target address VMA into the local buffer at
- MYADDR; it should return zero on success or an `errno' code on
- failure. TEMPL must be a BFD for a target with the word size and
- byte order found in the remote memory. */
- extern bfd *bfd_elf_bfd_from_remote_memory
- (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep,
- int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr,
- bfd_size_type len));
- /* Forward declarations. */
- struct ecoff_debug_info;
- struct ecoff_debug_swap;
- struct ecoff_extr;
- struct bfd_link_info;
- struct bfd_link_hash_entry;
- /* Return TRUE if the start of STR matches PREFIX, FALSE otherwise. */
- static inline bool
- startswith (const char *str, const char *prefix)
- {
- return strncmp (str, prefix, strlen (prefix)) == 0;
- }
|