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