1 /* Main header file for the bfd library -- portable access to object files. 2 3 Copyright (C) 1990-2020 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 "bfd_stdint.h" 38 #include "diagnostics.h" 39 #include <stdarg.h> 40 #include <sys/stat.h> 41 42 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE) 43 #ifndef SABER 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. */ 49 #undef CONCAT4 50 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d)) 51 #endif 52 #endif 53 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) 59 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro 60 to create the arguments to another macro, since the preprocessor 61 will mis-count the number of arguments to the outer macro (by not 62 evaluating STRING_COMMA_LEN and so missing the comma). This is a 63 problem for example when trying to use STRING_COMMA_LEN to build 64 the arguments to the strncmp() macro. Hence this alternative 65 definition of strncmp is provided here. 66 67 Note - these macros do NOT work if STR2 is not a constant string. */ 68 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0) 69 /* strcpy() can have a similar problem, but since we know we are 70 copying a constant string, we can use memcpy which will be faster 71 since there is no need to check for a NUL byte inside STR. We 72 can also save time if we do not need to copy the terminating NUL. */ 73 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1) 74 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2)) 75 76 77 #define BFD_SUPPORTS_PLUGINS @supports_plugins@ 78 79 /* The word size used by BFD on the host. This may be 64 with a 32 80 bit target if the host is 64 bit, or if other 64 bit targets have 81 been selected with --enable-targets, or if --enable-64-bit-bfd. */ 82 #define BFD_ARCH_SIZE @wordsize@ 83 84 /* The word size of the default bfd target. */ 85 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@ 86 87 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@ 88 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@ 89 #if @BFD_HOST_64_BIT_DEFINED@ 90 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@ 91 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@ 92 typedef BFD_HOST_64_BIT bfd_int64_t; 93 typedef BFD_HOST_U_64_BIT bfd_uint64_t; 94 #endif 95 96 #ifdef HAVE_INTTYPES_H 97 # include <inttypes.h> 98 #else 99 # if BFD_HOST_64BIT_LONG 100 # define BFD_PRI64 "l" 101 # elif defined (__MSVCRT__) 102 # define BFD_PRI64 "I64" 103 # else 104 # define BFD_PRI64 "ll" 105 # endif 106 # undef PRId64 107 # define PRId64 BFD_PRI64 "d" 108 # undef PRIu64 109 # define PRIu64 BFD_PRI64 "u" 110 # undef PRIx64 111 # define PRIx64 BFD_PRI64 "x" 112 #endif 113 114 #if BFD_ARCH_SIZE >= 64 115 #define BFD64 116 #endif 117 118 #ifndef INLINE 119 #if __GNUC__ >= 2 120 #define INLINE __inline__ 121 #else 122 #define INLINE 123 #endif 124 #endif 125 126 /* Declaring a type wide enough to hold a host long and a host pointer. */ 127 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@ 128 typedef BFD_HOSTPTR_T bfd_hostptr_t; 129 130 /* Forward declaration. */ 131 typedef struct bfd bfd; 132 133 /* Boolean type used in bfd. Too many systems define their own 134 versions of "boolean" for us to safely typedef a "boolean" of 135 our own. Using an enum for "bfd_boolean" has its own set of 136 problems, with strange looking casts required to avoid warnings 137 on some older compilers. Thus we just use an int. 138 139 General rule: Functions which are bfd_boolean return TRUE on 140 success and FALSE on failure (unless they're a predicate). */ 141 142 typedef int bfd_boolean; 143 #undef FALSE 144 #undef TRUE 145 #define FALSE 0 146 #define TRUE 1 147 148 #ifdef BFD64 149 150 #ifndef BFD_HOST_64_BIT 151 #error No 64 bit integer type available 152 #endif /* ! defined (BFD_HOST_64_BIT) */ 153 154 typedef BFD_HOST_U_64_BIT bfd_vma; 155 typedef BFD_HOST_64_BIT bfd_signed_vma; 156 typedef BFD_HOST_U_64_BIT bfd_size_type; 157 typedef BFD_HOST_U_64_BIT symvalue; 158 159 #if BFD_HOST_64BIT_LONG 160 #define BFD_VMA_FMT "l" 161 #elif defined (__MSVCRT__) 162 #define BFD_VMA_FMT "I64" 163 #else 164 #define BFD_VMA_FMT "ll" 165 #endif 166 167 #ifndef fprintf_vma 168 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x) 169 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x) 170 #endif 171 172 #else /* not BFD64 */ 173 174 /* Represent a target address. Also used as a generic unsigned type 175 which is guaranteed to be big enough to hold any arithmetic types 176 we need to deal with. */ 177 typedef unsigned long bfd_vma; 178 179 /* A generic signed type which is guaranteed to be big enough to hold any 180 arithmetic types we need to deal with. Can be assumed to be compatible 181 with bfd_vma in the same way that signed and unsigned ints are compatible 182 (as parameters, in assignment, etc). */ 183 typedef long bfd_signed_vma; 184 185 typedef unsigned long symvalue; 186 typedef unsigned long bfd_size_type; 187 188 /* Print a bfd_vma x on stream s. */ 189 #define BFD_VMA_FMT "l" 190 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x) 191 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x) 192 193 #endif /* not BFD64 */ 194 195 #define HALF_BFD_SIZE_TYPE \ 196 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2)) 197 198 #ifndef BFD_HOST_64_BIT 199 /* Fall back on a 32 bit type. The idea is to make these types always 200 available for function return types, but in the case that 201 BFD_HOST_64_BIT is undefined such a function should abort or 202 otherwise signal an error. */ 203 typedef bfd_signed_vma bfd_int64_t; 204 typedef bfd_vma bfd_uint64_t; 205 #endif 206 207 /* An offset into a file. BFD always uses the largest possible offset 208 based on the build time availability of fseek, fseeko, or fseeko64. */ 209 typedef @bfd_file_ptr@ file_ptr; 210 typedef unsigned @bfd_file_ptr@ ufile_ptr; 211 212 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma); 213 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma); 214 215 #define printf_vma(x) fprintf_vma(stdout,x) 216 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x) 217 218 typedef unsigned int flagword; /* 32 bits of flags */ 219 typedef unsigned char bfd_byte; 220 221 /* File formats. */ 222 223 typedef enum bfd_format 224 { 225 bfd_unknown = 0, /* File format is unknown. */ 226 bfd_object, /* Linker/assembler/compiler output. */ 227 bfd_archive, /* Object archive file. */ 228 bfd_core, /* Core dump. */ 229 bfd_type_end /* Marks the end; don't use it! */ 230 } 231 bfd_format; 232 233 /* Symbols and relocation. */ 234 235 /* A count of carsyms (canonical archive symbols). */ 236 typedef unsigned long symindex; 237 238 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) 239 240 /* A canonical archive symbol. */ 241 /* This is a type pun with struct ranlib on purpose! */ 242 typedef struct carsym 243 { 244 const char *name; 245 file_ptr file_offset; /* Look here to find the file. */ 246 } 247 carsym; /* To make these you call a carsymogen. */ 248 249 /* Used in generating armaps (archive tables of contents). 250 Perhaps just a forward definition would do? */ 251 struct orl /* Output ranlib. */ 252 { 253 char **name; /* Symbol name. */ 254 union 255 { 256 file_ptr pos; 257 bfd *abfd; 258 } u; /* bfd* or file position. */ 259 int namidx; /* Index into string table. */ 260 }; 261 262 /* Linenumber stuff. */ 263 typedef struct lineno_cache_entry 264 { 265 unsigned int line_number; /* Linenumber from start of function. */ 266 union 267 { 268 struct bfd_symbol *sym; /* Function name. */ 269 bfd_vma offset; /* Offset into section. */ 270 } u; 271 } 272 alent; 273 274 /* Object and core file sections. */ 275 typedef struct bfd_section *sec_ptr; 276 277 #define align_power(addr, align) \ 278 (((addr) + ((bfd_vma) 1 << (align)) - 1) & (-((bfd_vma) 1 << (align)))) 279 280 /* Align an address upward to a boundary, expressed as a number of bytes. 281 E.g. align to an 8-byte boundary with argument of 8. Take care never 282 to wrap around if the address is within boundary-1 of the end of the 283 address space. */ 284 #define BFD_ALIGN(this, boundary) \ 285 ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this)) \ 286 ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \ 287 : ~ (bfd_vma) 0) 288 289 typedef enum bfd_print_symbol 290 { 291 bfd_print_symbol_name, 292 bfd_print_symbol_more, 293 bfd_print_symbol_all 294 } bfd_print_symbol_type; 295 296 /* Information about a symbol that nm needs. */ 297 298 typedef struct _symbol_info 299 { 300 symvalue value; 301 char type; 302 const char *name; /* Symbol name. */ 303 unsigned char stab_type; /* Stab type. */ 304 char stab_other; /* Stab other. */ 305 short stab_desc; /* Stab desc. */ 306 const char *stab_name; /* String for stab type. */ 307 } symbol_info; 308 309 /* Get the name of a stabs type code. */ 310 311 extern const char *bfd_get_stab_name (int); 312 313 /* Hash table routines. There is no way to free up a hash table. */ 314 315 /* An element in the hash table. Most uses will actually use a larger 316 structure, and an instance of this will be the first field. */ 317 318 struct bfd_hash_entry 319 { 320 /* Next entry for this hash code. */ 321 struct bfd_hash_entry *next; 322 /* String being hashed. */ 323 const char *string; 324 /* Hash code. This is the full hash code, not the index into the 325 table. */ 326 unsigned long hash; 327 }; 328 329 /* A hash table. */ 330 331 struct bfd_hash_table 332 { 333 /* The hash array. */ 334 struct bfd_hash_entry **table; 335 /* A function used to create new elements in the hash table. The 336 first entry is itself a pointer to an element. When this 337 function is first invoked, this pointer will be NULL. However, 338 having the pointer permits a hierarchy of method functions to be 339 built each of which calls the function in the superclass. Thus 340 each function should be written to allocate a new block of memory 341 only if the argument is NULL. */ 342 struct bfd_hash_entry *(*newfunc) 343 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *); 344 /* An objalloc for this hash table. This is a struct objalloc *, 345 but we use void * to avoid requiring the inclusion of objalloc.h. */ 346 void *memory; 347 /* The number of slots in the hash table. */ 348 unsigned int size; 349 /* The number of entries in the hash table. */ 350 unsigned int count; 351 /* The size of elements. */ 352 unsigned int entsize; 353 /* If non-zero, don't grow the hash table. */ 354 unsigned int frozen:1; 355 }; 356 357 /* Initialize a hash table. */ 358 extern bfd_boolean bfd_hash_table_init 359 (struct bfd_hash_table *, 360 struct bfd_hash_entry *(*) (struct bfd_hash_entry *, 361 struct bfd_hash_table *, 362 const char *), 363 unsigned int); 364 365 /* Initialize a hash table specifying a size. */ 366 extern bfd_boolean bfd_hash_table_init_n 367 (struct bfd_hash_table *, 368 struct bfd_hash_entry *(*) (struct bfd_hash_entry *, 369 struct bfd_hash_table *, 370 const char *), 371 unsigned int, unsigned int); 372 373 /* Free up a hash table. */ 374 extern void bfd_hash_table_free 375 (struct bfd_hash_table *); 376 377 /* Look up a string in a hash table. If CREATE is TRUE, a new entry 378 will be created for this string if one does not already exist. The 379 COPY argument must be TRUE if this routine should copy the string 380 into newly allocated memory when adding an entry. */ 381 extern struct bfd_hash_entry *bfd_hash_lookup 382 (struct bfd_hash_table *, const char *, bfd_boolean create, 383 bfd_boolean copy); 384 385 /* Insert an entry in a hash table. */ 386 extern struct bfd_hash_entry *bfd_hash_insert 387 (struct bfd_hash_table *, const char *, unsigned long); 388 389 /* Rename an entry in a hash table. */ 390 extern void bfd_hash_rename 391 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *); 392 393 /* Replace an entry in a hash table. */ 394 extern void bfd_hash_replace 395 (struct bfd_hash_table *, struct bfd_hash_entry *old, 396 struct bfd_hash_entry *nw); 397 398 /* Base method for creating a hash table entry. */ 399 extern struct bfd_hash_entry *bfd_hash_newfunc 400 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *); 401 402 /* Grab some space for a hash table entry. */ 403 extern void *bfd_hash_allocate 404 (struct bfd_hash_table *, unsigned int); 405 406 /* Traverse a hash table in a random order, calling a function on each 407 element. If the function returns FALSE, the traversal stops. The 408 INFO argument is passed to the function. */ 409 extern void bfd_hash_traverse 410 (struct bfd_hash_table *, 411 bfd_boolean (*) (struct bfd_hash_entry *, void *), 412 void *info); 413 414 /* Allows the default size of a hash table to be configured. New hash 415 tables allocated using bfd_hash_table_init will be created with 416 this size. */ 417 extern unsigned long bfd_hash_set_default_size (unsigned long); 418 419 /* Types of compressed DWARF debug sections. We currently support 420 zlib. */ 421 enum compressed_debug_section_type 422 { 423 COMPRESS_DEBUG_NONE = 0, 424 COMPRESS_DEBUG = 1 << 0, 425 COMPRESS_DEBUG_GNU_ZLIB = COMPRESS_DEBUG | 1 << 1, 426 COMPRESS_DEBUG_GABI_ZLIB = COMPRESS_DEBUG | 1 << 2 427 }; 428 429 /* This structure is used to keep track of stabs in sections 430 information while linking. */ 431 432 struct stab_info 433 { 434 /* A hash table used to hold stabs strings. */ 435 struct bfd_strtab_hash *strings; 436 /* The header file hash table. */ 437 struct bfd_hash_table includes; 438 /* The first .stabstr section. */ 439 struct bfd_section *stabstr; 440 }; 441 442 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table 443 444 /* User program access to BFD facilities. */ 445 446 /* Direct I/O routines, for programs which know more about the object 447 file than BFD does. Use higher level routines if possible. */ 448 449 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *); 450 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *); 451 extern int bfd_seek (bfd *, file_ptr, int); 452 extern file_ptr bfd_tell (bfd *); 453 extern int bfd_flush (bfd *); 454 extern int bfd_stat (bfd *, struct stat *); 455 456 /* Deprecated old routines. */ 457 #if __GNUC__ 458 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \ 459 (_bfd_warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \ 460 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 461 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \ 462 (_bfd_warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \ 463 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 464 #else 465 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \ 466 (_bfd_warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \ 467 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 468 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \ 469 (_bfd_warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\ 470 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 471 #endif 472 extern void _bfd_warn_deprecated (const char *, const char *, int, const char *); 473 474 extern bfd_boolean bfd_cache_close 475 (bfd *abfd); 476 /* NB: This declaration should match the autogenerated one in libbfd.h. */ 477 478 extern bfd_boolean bfd_cache_close_all (void); 479 480 extern bfd_boolean bfd_record_phdr 481 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma, 482 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **); 483 484 /* Byte swapping routines. */ 485 486 bfd_uint64_t bfd_getb64 (const void *); 487 bfd_uint64_t bfd_getl64 (const void *); 488 bfd_int64_t bfd_getb_signed_64 (const void *); 489 bfd_int64_t bfd_getl_signed_64 (const void *); 490 bfd_vma bfd_getb32 (const void *); 491 bfd_vma bfd_getl32 (const void *); 492 bfd_signed_vma bfd_getb_signed_32 (const void *); 493 bfd_signed_vma bfd_getl_signed_32 (const void *); 494 bfd_vma bfd_getb16 (const void *); 495 bfd_vma bfd_getl16 (const void *); 496 bfd_signed_vma bfd_getb_signed_16 (const void *); 497 bfd_signed_vma bfd_getl_signed_16 (const void *); 498 void bfd_putb64 (bfd_uint64_t, void *); 499 void bfd_putl64 (bfd_uint64_t, void *); 500 void bfd_putb32 (bfd_vma, void *); 501 void bfd_putl32 (bfd_vma, void *); 502 void bfd_putb24 (bfd_vma, void *); 503 void bfd_putl24 (bfd_vma, void *); 504 void bfd_putb16 (bfd_vma, void *); 505 void bfd_putl16 (bfd_vma, void *); 506 507 /* Byte swapping routines which take size and endiannes as arguments. */ 508 509 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean); 510 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean); 511 512 513 /* mmap hacks */ 514 515 struct _bfd_window_internal; 516 typedef struct _bfd_window_internal bfd_window_internal; 517 518 typedef struct _bfd_window 519 { 520 /* What the user asked for. */ 521 void *data; 522 bfd_size_type size; 523 /* The actual window used by BFD. Small user-requested read-only 524 regions sharing a page may share a single window into the object 525 file. Read-write versions shouldn't until I've fixed things to 526 keep track of which portions have been claimed by the 527 application; don't want to give the same region back when the 528 application wants two writable copies! */ 529 struct _bfd_window_internal *i; 530 } 531 bfd_window; 532 533 extern void bfd_init_window 534 (bfd_window *); 535 extern void bfd_free_window 536 (bfd_window *); 537 extern bfd_boolean bfd_get_file_window 538 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean); 539 540 /* Externally visible ELF routines. */ 541 542 /* Create a new BFD as if by bfd_openr. Rather than opening a file, 543 reconstruct an ELF file by reading the segments out of remote 544 memory based on the ELF file header at EHDR_VMA and the ELF program 545 headers it points to. If non-zero, SIZE is the known extent of the 546 object. If not null, *LOADBASEP is filled in with the difference 547 between the VMAs from which the segments were read, and the VMAs 548 the file headers (and hence BFD's idea of each section's VMA) put 549 them at. 550 551 The function TARGET_READ_MEMORY is called to copy LEN bytes from 552 the remote memory at target address VMA into the local buffer at 553 MYADDR; it should return zero on success or an `errno' code on 554 failure. TEMPL must be a BFD for a target with the word size and 555 byte order found in the remote memory. */ 556 extern bfd *bfd_elf_bfd_from_remote_memory 557 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep, 558 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, 559 bfd_size_type len)); 560 561 /* Forward declarations. */ 562 struct ecoff_debug_info; 563 struct ecoff_debug_swap; 564 struct ecoff_extr; 565 struct bfd_link_info; 566 struct bfd_link_hash_entry; 567