1 /* Main header file for the bfd library -- portable access to object files.
3 Copyright (C) 1990-2021 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
37 #include "bfd_stdint.h"
38 #include "diagnostics.h"
42 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
44 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
45 The problem is, "32_" is not a valid preprocessing token, and we don't
46 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will
47 cause the inner CONCAT2 macros to be evaluated first, producing
48 still-valid pp-tokens. Then the final concatenation can be done. */
50 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
54 /* This is a utility macro to handle the situation where the code
55 wants to place a constant string into the code, followed by a
56 comma and then the length of the string. Doing this by hand
57 is error prone, so using this macro is safer. */
58 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
60 /* strcpy() can have a similar problem, but since we know we are
61 copying a constant string, we can use memcpy which will be faster
62 since there is no need to check for a NUL byte inside STR. We
63 can also save time if we do not need to copy the terminating NUL. */
64 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
65 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
67 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
69 /* The word size used by BFD on the host. This may be 64 with a 32
70 bit target if the host is 64 bit, or if other 64 bit targets have
71 been selected with --enable-targets, or if --enable-64-bit-bfd. */
72 #define BFD_ARCH_SIZE @wordsize@
74 /* The word size of the default bfd target. */
75 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
77 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
78 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
79 #if @BFD_HOST_64_BIT_DEFINED@
80 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
81 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
82 typedef BFD_HOST_64_BIT bfd_int64_t
;
83 typedef BFD_HOST_U_64_BIT bfd_uint64_t
;
86 #ifdef HAVE_INTTYPES_H
87 # include <inttypes.h>
89 # if BFD_HOST_64BIT_LONG
90 # define BFD_PRI64 "l"
91 # elif defined (__MSVCRT__)
92 # define BFD_PRI64 "I64"
94 # define BFD_PRI64 "ll"
97 # define PRId64 BFD_PRI64 "d"
99 # define PRIu64 BFD_PRI64 "u"
101 # define PRIx64 BFD_PRI64 "x"
104 #if BFD_ARCH_SIZE >= 64
110 #define INLINE __inline__
116 /* Declaring a type wide enough to hold a host long and a host pointer. */
117 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@
118 typedef BFD_HOSTPTR_T bfd_hostptr_t
;
120 /* Forward declaration. */
121 typedef struct bfd bfd
;
123 /* Boolean type used in bfd. Too many systems define their own
124 versions of "boolean" for us to safely typedef a "boolean" of
125 our own. Using an enum for "bfd_boolean" has its own set of
126 problems, with strange looking casts required to avoid warnings
127 on some older compilers. Thus we just use an int.
129 General rule: Functions which are bfd_boolean return TRUE on
130 success and FALSE on failure (unless they're a predicate). */
132 typedef int bfd_boolean
;
140 #ifndef BFD_HOST_64_BIT
141 #error No 64 bit integer type available
142 #endif /* ! defined (BFD_HOST_64_BIT) */
144 typedef BFD_HOST_U_64_BIT bfd_vma
;
145 typedef BFD_HOST_64_BIT bfd_signed_vma
;
146 typedef BFD_HOST_U_64_BIT bfd_size_type
;
147 typedef BFD_HOST_U_64_BIT symvalue
;
149 #if BFD_HOST_64BIT_LONG
150 #define BFD_VMA_FMT "l"
151 #elif defined (__MSVCRT__)
152 #define BFD_VMA_FMT "I64"
154 #define BFD_VMA_FMT "ll"
158 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
159 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
162 #else /* not BFD64 */
164 /* Represent a target address. Also used as a generic unsigned type
165 which is guaranteed to be big enough to hold any arithmetic types
166 we need to deal with. */
167 typedef unsigned long bfd_vma
;
169 /* A generic signed type which is guaranteed to be big enough to hold any
170 arithmetic types we need to deal with. Can be assumed to be compatible
171 with bfd_vma in the same way that signed and unsigned ints are compatible
172 (as parameters, in assignment, etc). */
173 typedef long bfd_signed_vma
;
175 typedef unsigned long symvalue
;
176 typedef unsigned long bfd_size_type
;
178 /* Print a bfd_vma x on stream s. */
179 #define BFD_VMA_FMT "l"
180 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
181 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x)
183 #endif /* not BFD64 */
185 #define HALF_BFD_SIZE_TYPE \
186 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
188 #ifndef BFD_HOST_64_BIT
189 /* Fall back on a 32 bit type. The idea is to make these types always
190 available for function return types, but in the case that
191 BFD_HOST_64_BIT is undefined such a function should abort or
192 otherwise signal an error. */
193 typedef bfd_signed_vma bfd_int64_t
;
194 typedef bfd_vma bfd_uint64_t
;
197 /* An offset into a file. BFD always uses the largest possible offset
198 based on the build time availability of fseek, fseeko, or fseeko64. */
199 typedef @bfd_file_ptr@ file_ptr
;
200 typedef unsigned @bfd_file_ptr@ ufile_ptr
;
202 extern void bfd_sprintf_vma (bfd
*, char *, bfd_vma
);
203 extern void bfd_fprintf_vma (bfd
*, void *, bfd_vma
);
205 #define printf_vma(x) fprintf_vma(stdout,x)
206 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
208 typedef unsigned int flagword
; /* 32 bits of flags */
209 typedef unsigned char bfd_byte
;
213 typedef enum bfd_format
215 bfd_unknown
= 0, /* File format is unknown. */
216 bfd_object
, /* Linker/assembler/compiler output. */
217 bfd_archive
, /* Object archive file. */
218 bfd_core
, /* Core dump. */
219 bfd_type_end
/* Marks the end; don't use it! */
223 /* Symbols and relocation. */
225 /* A count of carsyms (canonical archive symbols). */
226 typedef unsigned long symindex
;
228 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
230 /* A canonical archive symbol. */
231 /* This is a type pun with struct ranlib on purpose! */
232 typedef struct carsym
235 file_ptr file_offset
; /* Look here to find the file. */
237 carsym
; /* To make these you call a carsymogen. */
239 /* Used in generating armaps (archive tables of contents).
240 Perhaps just a forward definition would do? */
241 struct orl
/* Output ranlib. */
243 char **name
; /* Symbol name. */
248 } u
; /* bfd* or file position. */
249 int namidx
; /* Index into string table. */
252 /* Linenumber stuff. */
253 typedef struct lineno_cache_entry
255 unsigned int line_number
; /* Linenumber from start of function. */
258 struct bfd_symbol
*sym
; /* Function name. */
259 bfd_vma offset
; /* Offset into section. */
264 /* Object and core file sections. */
265 typedef struct bfd_section
*sec_ptr
;
267 #define align_power(addr, align) \
268 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align))))
270 /* Align an address upward to a boundary, expressed as a number of bytes.
271 E.g. align to an 8-byte boundary with argument of 8. Take care never
272 to wrap around if the address is within boundary-1 of the end of the
274 #define BFD_ALIGN(this, boundary) \
275 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \
276 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
279 typedef enum bfd_print_symbol
281 bfd_print_symbol_name
,
282 bfd_print_symbol_more
,
284 } bfd_print_symbol_type
;
286 /* Information about a symbol that nm needs. */
288 typedef struct _symbol_info
292 const char *name
; /* Symbol name. */
293 unsigned char stab_type
; /* Stab type. */
294 char stab_other
; /* Stab other. */
295 short stab_desc
; /* Stab desc. */
296 const char *stab_name
; /* String for stab type. */
299 /* Get the name of a stabs type code. */
301 extern const char *bfd_get_stab_name (int);
303 /* Hash table routines. There is no way to free up a hash table. */
305 /* An element in the hash table. Most uses will actually use a larger
306 structure, and an instance of this will be the first field. */
308 struct bfd_hash_entry
310 /* Next entry for this hash code. */
311 struct bfd_hash_entry
*next
;
312 /* String being hashed. */
314 /* Hash code. This is the full hash code, not the index into the
321 struct bfd_hash_table
323 /* The hash array. */
324 struct bfd_hash_entry
**table
;
325 /* A function used to create new elements in the hash table. The
326 first entry is itself a pointer to an element. When this
327 function is first invoked, this pointer will be NULL. However,
328 having the pointer permits a hierarchy of method functions to be
329 built each of which calls the function in the superclass. Thus
330 each function should be written to allocate a new block of memory
331 only if the argument is NULL. */
332 struct bfd_hash_entry
*(*newfunc
)
333 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
334 /* An objalloc for this hash table. This is a struct objalloc *,
335 but we use void * to avoid requiring the inclusion of objalloc.h. */
337 /* The number of slots in the hash table. */
339 /* The number of entries in the hash table. */
341 /* The size of elements. */
342 unsigned int entsize
;
343 /* If non-zero, don't grow the hash table. */
344 unsigned int frozen
:1;
347 /* Initialize a hash table. */
348 extern bfd_boolean bfd_hash_table_init
349 (struct bfd_hash_table
*,
350 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
351 struct bfd_hash_table
*,
355 /* Initialize a hash table specifying a size. */
356 extern bfd_boolean bfd_hash_table_init_n
357 (struct bfd_hash_table
*,
358 struct bfd_hash_entry
*(*) (struct bfd_hash_entry
*,
359 struct bfd_hash_table
*,
361 unsigned int, unsigned int);
363 /* Free up a hash table. */
364 extern void bfd_hash_table_free
365 (struct bfd_hash_table
*);
367 /* Look up a string in a hash table. If CREATE is TRUE, a new entry
368 will be created for this string if one does not already exist. The
369 COPY argument must be TRUE if this routine should copy the string
370 into newly allocated memory when adding an entry. */
371 extern struct bfd_hash_entry
*bfd_hash_lookup
372 (struct bfd_hash_table
*, const char *, bfd_boolean create
,
375 /* Insert an entry in a hash table. */
376 extern struct bfd_hash_entry
*bfd_hash_insert
377 (struct bfd_hash_table
*, const char *, unsigned long);
379 /* Rename an entry in a hash table. */
380 extern void bfd_hash_rename
381 (struct bfd_hash_table
*, const char *, struct bfd_hash_entry
*);
383 /* Replace an entry in a hash table. */
384 extern void bfd_hash_replace
385 (struct bfd_hash_table
*, struct bfd_hash_entry
*old
,
386 struct bfd_hash_entry
*nw
);
388 /* Base method for creating a hash table entry. */
389 extern struct bfd_hash_entry
*bfd_hash_newfunc
390 (struct bfd_hash_entry
*, struct bfd_hash_table
*, const char *);
392 /* Grab some space for a hash table entry. */
393 extern void *bfd_hash_allocate
394 (struct bfd_hash_table
*, unsigned int);
396 /* Traverse a hash table in a random order, calling a function on each
397 element. If the function returns FALSE, the traversal stops. The
398 INFO argument is passed to the function. */
399 extern void bfd_hash_traverse
400 (struct bfd_hash_table
*,
401 bfd_boolean (*) (struct bfd_hash_entry
*, void *),
404 /* Allows the default size of a hash table to be configured. New hash
405 tables allocated using bfd_hash_table_init will be created with
407 extern unsigned long bfd_hash_set_default_size (unsigned long);
409 /* Types of compressed DWARF debug sections. We currently support
411 enum compressed_debug_section_type
413 COMPRESS_DEBUG_NONE
= 0,
414 COMPRESS_DEBUG
= 1 << 0,
415 COMPRESS_DEBUG_GNU_ZLIB
= COMPRESS_DEBUG
| 1 << 1,
416 COMPRESS_DEBUG_GABI_ZLIB
= COMPRESS_DEBUG
| 1 << 2
419 /* This structure is used to keep track of stabs in sections
420 information while linking. */
424 /* A hash table used to hold stabs strings. */
425 struct bfd_strtab_hash
*strings
;
426 /* The header file hash table. */
427 struct bfd_hash_table includes
;
428 /* The first .stabstr section. */
429 struct bfd_section
*stabstr
;
432 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
434 /* User program access to BFD facilities. */
436 /* Direct I/O routines, for programs which know more about the object
437 file than BFD does. Use higher level routines if possible. */
439 extern bfd_size_type
bfd_bread (void *, bfd_size_type
, bfd
*);
440 extern bfd_size_type
bfd_bwrite (const void *, bfd_size_type
, bfd
*);
441 extern int bfd_seek (bfd
*, file_ptr
, int);
442 extern file_ptr
bfd_tell (bfd
*);
443 extern int bfd_flush (bfd
*);
444 extern int bfd_stat (bfd
*, struct stat
*);
446 /* Deprecated old routines. */
448 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
449 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \
450 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
451 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
452 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \
453 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
455 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \
456 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
457 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
458 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \
459 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
460 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
462 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *);
464 extern bfd_boolean bfd_cache_close
466 /* NB: This declaration should match the autogenerated one in libbfd.h. */
468 extern bfd_boolean
bfd_cache_close_all (void);
470 extern bfd_boolean bfd_record_phdr
471 (bfd
*, unsigned long, bfd_boolean
, flagword
, bfd_boolean
, bfd_vma
,
472 bfd_boolean
, bfd_boolean
, unsigned int, struct bfd_section
**);
474 /* Byte swapping routines. */
476 bfd_uint64_t
bfd_getb64 (const void *);
477 bfd_uint64_t
bfd_getl64 (const void *);
478 bfd_int64_t
bfd_getb_signed_64 (const void *);
479 bfd_int64_t
bfd_getl_signed_64 (const void *);
480 bfd_vma
bfd_getb32 (const void *);
481 bfd_vma
bfd_getl32 (const void *);
482 bfd_signed_vma
bfd_getb_signed_32 (const void *);
483 bfd_signed_vma
bfd_getl_signed_32 (const void *);
484 bfd_vma
bfd_getb16 (const void *);
485 bfd_vma
bfd_getl16 (const void *);
486 bfd_signed_vma
bfd_getb_signed_16 (const void *);
487 bfd_signed_vma
bfd_getl_signed_16 (const void *);
488 void bfd_putb64 (bfd_uint64_t
, void *);
489 void bfd_putl64 (bfd_uint64_t
, void *);
490 void bfd_putb32 (bfd_vma
, void *);
491 void bfd_putl32 (bfd_vma
, void *);
492 void bfd_putb24 (bfd_vma
, void *);
493 void bfd_putl24 (bfd_vma
, void *);
494 void bfd_putb16 (bfd_vma
, void *);
495 void bfd_putl16 (bfd_vma
, void *);
497 /* Byte swapping routines which take size and endiannes as arguments. */
499 bfd_uint64_t
bfd_get_bits (const void *, int, bfd_boolean
);
500 void bfd_put_bits (bfd_uint64_t
, void *, int, bfd_boolean
);
505 struct _bfd_window_internal
;
506 typedef struct _bfd_window_internal bfd_window_internal
;
508 typedef struct _bfd_window
510 /* What the user asked for. */
513 /* The actual window used by BFD. Small user-requested read-only
514 regions sharing a page may share a single window into the object
515 file. Read-write versions shouldn't until I've fixed things to
516 keep track of which portions have been claimed by the
517 application; don't want to give the same region back when the
518 application wants two writable copies! */
519 struct _bfd_window_internal
*i
;
523 extern void bfd_init_window
525 extern void bfd_free_window
527 extern bfd_boolean bfd_get_file_window
528 (bfd
*, file_ptr
, bfd_size_type
, bfd_window
*, bfd_boolean
);
530 /* Externally visible ELF routines. */
532 /* Create a new BFD as if by bfd_openr. Rather than opening a file,
533 reconstruct an ELF file by reading the segments out of remote
534 memory based on the ELF file header at EHDR_VMA and the ELF program
535 headers it points to. If non-zero, SIZE is the known extent of the
536 object. If not null, *LOADBASEP is filled in with the difference
537 between the VMAs from which the segments were read, and the VMAs
538 the file headers (and hence BFD's idea of each section's VMA) put
541 The function TARGET_READ_MEMORY is called to copy LEN bytes from
542 the remote memory at target address VMA into the local buffer at
543 MYADDR; it should return zero on success or an `errno' code on
544 failure. TEMPL must be a BFD for a target with the word size and
545 byte order found in the remote memory. */
546 extern bfd
*bfd_elf_bfd_from_remote_memory
547 (bfd
*templ
, bfd_vma ehdr_vma
, bfd_size_type size
, bfd_vma
*loadbasep
,
548 int (*target_read_memory
) (bfd_vma vma
, bfd_byte
*myaddr
,
551 /* Forward declarations. */
552 struct ecoff_debug_info
;
553 struct ecoff_debug_swap
;
555 struct bfd_link_info
;
556 struct bfd_link_hash_entry
;
558 /* Return TRUE if the start of STR matches PREFIX, FALSE otherwise. */
560 static inline bfd_boolean
561 startswith (const char *str
, const char *prefix
)
563 return strncmp (str
, prefix
, strlen (prefix
)) == 0;