1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright (C) 1990-2022 Free Software Foundation, Inc.
5 Contributed by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
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.
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.
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. */
23 #ifndef __BFD_H_SEEN__
24 #define __BFD_H_SEEN__
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
39 #include "diagnostics.h"
44 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
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. */
52 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
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)
62 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
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@
69 /* The word size of the default bfd target. */
70 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
74 #if BFD_ARCH_SIZE >= 64
78 /* Forward declaration. */
79 typedef struct bfd bfd
;
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). */
85 #ifdef POISON_BFD_BOOLEAN
86 # pragma GCC poison bfd_boolean
88 # define bfd_boolean bool
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))
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
;
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
;
113 typedef uint64_t bfd_size_type
;
114 typedef uint64_t symvalue
;
116 #else /* not BFD64 */
118 typedef unsigned long bfd_vma
;
119 typedef long bfd_signed_vma
;
120 typedef unsigned long symvalue
;
121 typedef unsigned long bfd_size_type
;
123 #endif /* not BFD64 */
125 #define HALF_BFD_SIZE_TYPE \
126 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
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
;
133 extern void bfd_sprintf_vma (bfd
*, char *, bfd_vma
);
134 extern void bfd_fprintf_vma (bfd
*, void *, bfd_vma
);
136 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
138 typedef unsigned int flagword
; /* 32 bits of flags */
139 typedef unsigned char bfd_byte
;
143 typedef enum bfd_format
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! */
153 /* Symbols and relocation. */
155 /* A count of carsyms (canonical archive symbols). */
156 typedef unsigned long symindex
;
158 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
160 /* A canonical archive symbol. */
161 /* This is a type pun with struct ranlib on purpose! */
162 typedef struct carsym
165 file_ptr file_offset
; /* Look here to find the file. */
167 carsym
; /* To make these you call a carsymogen. */
169 /* Used in generating armaps (archive tables of contents).
170 Perhaps just a forward definition would do? */
171 struct orl
/* Output ranlib. */
173 char **name
; /* Symbol name. */
178 } u
; /* bfd* or file position. */
179 int namidx
; /* Index into string table. */
182 /* Linenumber stuff. */
183 typedef struct lineno_cache_entry
185 unsigned int line_number
; /* Linenumber from start of function. */
188 struct bfd_symbol
*sym
; /* Function name. */
189 bfd_vma offset
; /* Offset into section. */
194 /* Object and core file sections. */
195 typedef struct bfd_section
*sec_ptr
;
197 #define align_power(addr, align) \
198 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
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
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)) \
209 typedef enum bfd_print_symbol
211 bfd_print_symbol_name
,
212 bfd_print_symbol_more
,
214 } bfd_print_symbol_type
;
216 /* Information about a symbol that nm needs. */
218 typedef struct _symbol_info
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. */
229 /* Get the name of a stabs type code. */
231 extern const char *bfd_get_stab_name (int);
233 /* Hash table routines. There is no way to free up a hash table. */
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. */
238 struct bfd_hash_entry
240 /* Next entry for this hash code. */
241 struct bfd_hash_entry
*next
;
242 /* String being hashed. */
244 /* Hash code. This is the full hash code, not the index into the
251 struct bfd_hash_table
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. */
267 /* The number of slots in the hash table. */
269 /* The number of entries in the hash table. */
271 /* The size of elements. */
272 unsigned int entsize
;
273 /* If non-zero, don't grow the hash table. */
274 unsigned int frozen
:1;
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
*,
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
*,
291 unsigned int, unsigned int);
293 /* Free up a hash table. */
294 extern void bfd_hash_table_free
295 (struct bfd_hash_table
*);
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
);
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);
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
*);
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
);
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 *);
321 /* Grab some space for a hash table entry. */
322 extern void *bfd_hash_allocate
323 (struct bfd_hash_table
*, unsigned int);
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 *),
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
336 extern unsigned long bfd_hash_set_default_size (unsigned long);
338 /* Types of compressed DWARF debug sections. We currently support
340 enum compressed_debug_section_type
342 COMPRESS_DEBUG_NONE
= 0,
343 COMPRESS_DEBUG
= 1 << 0,
344 COMPRESS_DEBUG_GNU_ZLIB
= COMPRESS_DEBUG
| 1 << 1,
345 COMPRESS_DEBUG_GABI_ZLIB
= COMPRESS_DEBUG
| 1 << 2,
346 COMPRESS_DEBUG_ZSTD
= COMPRESS_DEBUG
| 1 << 3
349 /* This structure is used to keep track of stabs in sections
350 information while linking. */
354 /* A hash table used to hold stabs strings. */
355 struct bfd_strtab_hash
*strings
;
356 /* The header file hash table. */
357 struct bfd_hash_table includes
;
358 /* The first .stabstr section. */
359 struct bfd_section
*stabstr
;
362 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
364 /* User program access to BFD facilities. */
366 /* Direct I/O routines, for programs which know more about the object
367 file than BFD does. Use higher level routines if possible. */
369 extern bfd_size_type
bfd_bread (void *, bfd_size_type
, bfd
*);
370 extern bfd_size_type
bfd_bwrite (const void *, bfd_size_type
, bfd
*);
371 extern int bfd_seek (bfd
*, file_ptr
, int);
372 extern file_ptr
bfd_tell (bfd
*);
373 extern int bfd_flush (bfd
*);
374 extern int bfd_stat (bfd
*, struct stat
*);
376 /* Deprecated old routines. */
378 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
379 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
380 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
381 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
382 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
383 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
385 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
386 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
387 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
388 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
389 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
390 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
392 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
394 extern bool bfd_cache_close
396 /* NB: This declaration should match the autogenerated one in libbfd.h. */
398 extern bool bfd_cache_close_all (void);
400 extern bool bfd_record_phdr
401 (bfd
*, unsigned long, bool, flagword
, bool, bfd_vma
,
402 bool, bool, unsigned int, struct bfd_section
**);
404 /* Byte swapping routines. */
406 uint64_t bfd_getb64 (const void *);
407 uint64_t bfd_getl64 (const void *);
408 int64_t bfd_getb_signed_64 (const void *);
409 int64_t bfd_getl_signed_64 (const void *);
410 bfd_vma
bfd_getb32 (const void *);
411 bfd_vma
bfd_getl32 (const void *);
412 bfd_signed_vma
bfd_getb_signed_32 (const void *);
413 bfd_signed_vma
bfd_getl_signed_32 (const void *);
414 bfd_vma
bfd_getb16 (const void *);
415 bfd_vma
bfd_getl16 (const void *);
416 bfd_signed_vma
bfd_getb_signed_16 (const void *);
417 bfd_signed_vma
bfd_getl_signed_16 (const void *);
418 void bfd_putb64 (uint64_t, void *);
419 void bfd_putl64 (uint64_t, void *);
420 void bfd_putb32 (bfd_vma
, void *);
421 void bfd_putl32 (bfd_vma
, void *);
422 void bfd_putb24 (bfd_vma
, void *);
423 void bfd_putl24 (bfd_vma
, void *);
424 void bfd_putb16 (bfd_vma
, void *);
425 void bfd_putl16 (bfd_vma
, void *);
427 /* Byte swapping routines which take size and endiannes as arguments. */
429 uint64_t bfd_get_bits (const void *, int, bool);
430 void bfd_put_bits (uint64_t, void *, int, bool);
435 struct _bfd_window_internal
;
436 typedef struct _bfd_window_internal bfd_window_internal
;
438 typedef struct _bfd_window
440 /* What the user asked for. */
443 /* The actual window used by BFD. Small user-requested read-only
444 regions sharing a page may share a single window into the object
445 file. Read-write versions shouldn't until I've fixed things to
446 keep track of which portions have been claimed by the
447 application; don't want to give the same region back when the
448 application wants two writable copies! */
449 struct _bfd_window_internal
*i
;
453 extern void bfd_init_window
455 extern void bfd_free_window
457 extern bool bfd_get_file_window
458 (bfd
*, file_ptr
, bfd_size_type
, bfd_window
*, bool);
460 /* Externally visible ELF routines. */
462 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
463 reconstruct an ELF file by reading the segments out of remote
464 memory based on the ELF file header at EHDR_VMA and the ELF program
465 headers it points to. If non-zero, SIZE is the known extent of the
466 object. If not null, *LOADBASEP is filled in with the difference
467 between the VMAs from which the segments were read, and the VMAs
468 the file headers (and hence BFD's idea of each section's VMA) put
471 The function TARGET_READ_MEMORY is called to copy LEN bytes from
472 the remote memory at target address VMA into the local buffer at
473 MYADDR; it should return zero on success or an `errno' code on
474 failure. TEMPL must be a BFD for a target with the word size and
475 byte order found in the remote memory. */
476 extern bfd
*bfd_elf_bfd_from_remote_memory
477 (bfd
*templ
, bfd_vma ehdr_vma
, bfd_size_type size
, bfd_vma
*loadbasep
,
478 int (*target_read_memory
) (bfd_vma vma
, bfd_byte
*myaddr
,
481 /* Forward declarations. */
482 struct ecoff_debug_info
;
483 struct ecoff_debug_swap
;
485 struct bfd_link_info
;
486 struct bfd_link_hash_entry
;
488 /* Return TRUE if the start of STR matches PREFIX, FALSE otherwise. */
491 startswith (const char *str
, const char *prefix
)
493 return strncmp (str
, prefix
, strlen (prefix
)) == 0;