1 /* Main header file for the bfd library -- portable access to object files. 2 3 Copyright (C) 1990-2014 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 <sys/stat.h> 38 39 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE) 40 #ifndef SABER 41 /* This hack is to avoid a problem with some strict ANSI C preprocessors. 42 The problem is, "32_" is not a valid preprocessing token, and we don't 43 want extra underscores (e.g., "nlm_32_"). The XCONCAT2 macro will 44 cause the inner CONCAT2 macros to be evaluated first, producing 45 still-valid pp-tokens. Then the final concatenation can be done. */ 46 #undef CONCAT4 47 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d)) 48 #endif 49 #endif 50 51 /* This is a utility macro to handle the situation where the code 52 wants to place a constant string into the code, followed by a 53 comma and then the length of the string. Doing this by hand 54 is error prone, so using this macro is safer. */ 55 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1) 56 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro 57 to create the arguments to another macro, since the preprocessor 58 will mis-count the number of arguments to the outer macro (by not 59 evaluating STRING_COMMA_LEN and so missing the comma). This is a 60 problem for example when trying to use STRING_COMMA_LEN to build 61 the arguments to the strncmp() macro. Hence this alternative 62 definition of strncmp is provided here. 63 64 Note - these macros do NOT work if STR2 is not a constant string. */ 65 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0) 66 /* strcpy() can have a similar problem, but since we know we are 67 copying a constant string, we can use memcpy which will be faster 68 since there is no need to check for a NUL byte inside STR. We 69 can also save time if we do not need to copy the terminating NUL. */ 70 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1) 71 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2)) 72 73 74 #define BFD_SUPPORTS_PLUGINS @supports_plugins@ 75 76 /* The word size used by BFD on the host. This may be 64 with a 32 77 bit target if the host is 64 bit, or if other 64 bit targets have 78 been selected with --enable-targets, or if --enable-64-bit-bfd. */ 79 #define BFD_ARCH_SIZE @wordsize@ 80 81 /* The word size of the default bfd target. */ 82 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@ 83 84 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@ 85 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@ 86 #if @BFD_HOST_64_BIT_DEFINED@ 87 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@ 88 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@ 89 typedef BFD_HOST_64_BIT bfd_int64_t; 90 typedef BFD_HOST_U_64_BIT bfd_uint64_t; 91 #endif 92 93 #if BFD_ARCH_SIZE >= 64 94 #define BFD64 95 #endif 96 97 #ifndef INLINE 98 #if __GNUC__ >= 2 99 #define INLINE __inline__ 100 #else 101 #define INLINE 102 #endif 103 #endif 104 105 /* Declaring a type wide enough to hold a host long and a host pointer. */ 106 #define BFD_HOSTPTR_T @BFD_HOSTPTR_T@ 107 typedef BFD_HOSTPTR_T bfd_hostptr_t; 108 109 /* Forward declaration. */ 110 typedef struct bfd bfd; 111 112 /* Boolean type used in bfd. Too many systems define their own 113 versions of "boolean" for us to safely typedef a "boolean" of 114 our own. Using an enum for "bfd_boolean" has its own set of 115 problems, with strange looking casts required to avoid warnings 116 on some older compilers. Thus we just use an int. 117 118 General rule: Functions which are bfd_boolean return TRUE on 119 success and FALSE on failure (unless they're a predicate). */ 120 121 typedef int bfd_boolean; 122 #undef FALSE 123 #undef TRUE 124 #define FALSE 0 125 #define TRUE 1 126 127 #ifdef BFD64 128 129 #ifndef BFD_HOST_64_BIT 130 #error No 64 bit integer type available 131 #endif /* ! defined (BFD_HOST_64_BIT) */ 132 133 typedef BFD_HOST_U_64_BIT bfd_vma; 134 typedef BFD_HOST_64_BIT bfd_signed_vma; 135 typedef BFD_HOST_U_64_BIT bfd_size_type; 136 typedef BFD_HOST_U_64_BIT symvalue; 137 138 #if BFD_HOST_64BIT_LONG 139 #define BFD_VMA_FMT "l" 140 #elif defined (__MSVCRT__) 141 #define BFD_VMA_FMT "I64" 142 #else 143 #define BFD_VMA_FMT "ll" 144 #endif 145 146 #ifndef fprintf_vma 147 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x) 148 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x) 149 #endif 150 151 #else /* not BFD64 */ 152 153 /* Represent a target address. Also used as a generic unsigned type 154 which is guaranteed to be big enough to hold any arithmetic types 155 we need to deal with. */ 156 typedef unsigned long bfd_vma; 157 158 /* A generic signed type which is guaranteed to be big enough to hold any 159 arithmetic types we need to deal with. Can be assumed to be compatible 160 with bfd_vma in the same way that signed and unsigned ints are compatible 161 (as parameters, in assignment, etc). */ 162 typedef long bfd_signed_vma; 163 164 typedef unsigned long symvalue; 165 typedef unsigned long bfd_size_type; 166 167 /* Print a bfd_vma x on stream s. */ 168 #define BFD_VMA_FMT "l" 169 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x) 170 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", x) 171 172 #endif /* not BFD64 */ 173 174 #define HALF_BFD_SIZE_TYPE \ 175 (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2)) 176 177 #ifndef BFD_HOST_64_BIT 178 /* Fall back on a 32 bit type. The idea is to make these types always 179 available for function return types, but in the case that 180 BFD_HOST_64_BIT is undefined such a function should abort or 181 otherwise signal an error. */ 182 typedef bfd_signed_vma bfd_int64_t; 183 typedef bfd_vma bfd_uint64_t; 184 #endif 185 186 /* An offset into a file. BFD always uses the largest possible offset 187 based on the build time availability of fseek, fseeko, or fseeko64. */ 188 typedef @bfd_file_ptr@ file_ptr; 189 typedef unsigned @bfd_file_ptr@ ufile_ptr; 190 191 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma); 192 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma); 193 194 #define printf_vma(x) fprintf_vma(stdout,x) 195 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x) 196 197 typedef unsigned int flagword; /* 32 bits of flags */ 198 typedef unsigned char bfd_byte; 199 200 /* File formats. */ 202 203 typedef enum bfd_format 204 { 205 bfd_unknown = 0, /* File format is unknown. */ 206 bfd_object, /* Linker/assembler/compiler output. */ 207 bfd_archive, /* Object archive file. */ 208 bfd_core, /* Core dump. */ 209 bfd_type_end /* Marks the end; don't use it! */ 210 } 211 bfd_format; 212 213 /* Symbols and relocation. */ 215 216 /* A count of carsyms (canonical archive symbols). */ 217 typedef unsigned long symindex; 218 219 /* How to perform a relocation. */ 220 typedef const struct reloc_howto_struct reloc_howto_type; 221 222 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0) 223 224 /* General purpose part of a symbol X; 225 target specific parts are in libcoff.h, libaout.h, etc. */ 226 227 #define bfd_get_section(x) ((x)->section) 228 #define bfd_get_output_section(x) ((x)->section->output_section) 229 #define bfd_set_section(x,y) ((x)->section) = (y) 230 #define bfd_asymbol_base(x) ((x)->section->vma) 231 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value) 232 #define bfd_asymbol_name(x) ((x)->name) 233 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/ 234 #define bfd_asymbol_bfd(x) ((x)->the_bfd) 235 #define bfd_asymbol_flavour(x) \ 236 (((x)->flags & BSF_SYNTHETIC) != 0 \ 237 ? bfd_target_unknown_flavour \ 238 : bfd_asymbol_bfd (x)->xvec->flavour) 239 240 /* A canonical archive symbol. */ 241 /* This is a type pun with struct ranlib on purpose! */ 242 typedef struct carsym 243 { 244 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. */ 264 typedef struct lineno_cache_entry 265 { 266 unsigned int line_number; /* Linenumber from start of function. */ 267 union 268 { 269 struct bfd_symbol *sym; /* Function name. */ 270 bfd_vma offset; /* Offset into section. */ 271 } u; 272 } 273 alent; 274 275 /* Object and core file sections. */ 277 278 #define align_power(addr, align) \ 279 (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align))) 280 281 typedef struct bfd_section *sec_ptr; 282 283 #define bfd_get_section_name(bfd, ptr) ((void) bfd, (ptr)->name) 284 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma) 285 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma) 286 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \ 287 (ptr)->alignment_power) 288 #define bfd_section_name(bfd, ptr) ((ptr)->name) 289 #define bfd_section_size(bfd, ptr) ((ptr)->size) 290 #define bfd_get_section_size(ptr) ((ptr)->size) 291 #define bfd_section_vma(bfd, ptr) ((ptr)->vma) 292 #define bfd_section_lma(bfd, ptr) ((ptr)->lma) 293 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power) 294 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags) 295 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata) 296 297 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0) 298 299 /* Find the address one past the end of SEC. */ 300 #define bfd_get_section_limit(bfd, sec) \ 301 (((bfd)->direction != write_direction && (sec)->rawsize != 0 \ 302 ? (sec)->rawsize : (sec)->size) / bfd_octets_per_byte (bfd)) 303 304 /* Return TRUE if input section SEC has been discarded. */ 305 #define discarded_section(sec) \ 306 (!bfd_is_abs_section (sec) \ 307 && bfd_is_abs_section ((sec)->output_section) \ 308 && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE \ 309 && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS) 310 311 typedef enum bfd_print_symbol 313 { 314 bfd_print_symbol_name, 315 bfd_print_symbol_more, 316 bfd_print_symbol_all 317 } bfd_print_symbol_type; 318 319 /* Information about a symbol that nm needs. */ 320 321 typedef struct _symbol_info 322 { 323 symvalue value; 324 char type; 325 const char *name; /* Symbol name. */ 326 unsigned char stab_type; /* Stab type. */ 327 char stab_other; /* Stab other. */ 328 short stab_desc; /* Stab desc. */ 329 const char *stab_name; /* String for stab type. */ 330 } symbol_info; 331 332 /* Get the name of a stabs type code. */ 333 334 extern const char *bfd_get_stab_name (int); 335 336 /* Hash table routines. There is no way to free up a hash table. */ 338 339 /* An element in the hash table. Most uses will actually use a larger 340 structure, and an instance of this will be the first field. */ 341 342 struct bfd_hash_entry 343 { 344 /* Next entry for this hash code. */ 345 struct bfd_hash_entry *next; 346 /* String being hashed. */ 347 const char *string; 348 /* Hash code. This is the full hash code, not the index into the 349 table. */ 350 unsigned long hash; 351 }; 352 353 /* A hash table. */ 354 355 struct bfd_hash_table 356 { 357 /* The hash array. */ 358 struct bfd_hash_entry **table; 359 /* A function used to create new elements in the hash table. The 360 first entry is itself a pointer to an element. When this 361 function is first invoked, this pointer will be NULL. However, 362 having the pointer permits a hierarchy of method functions to be 363 built each of which calls the function in the superclass. Thus 364 each function should be written to allocate a new block of memory 365 only if the argument is NULL. */ 366 struct bfd_hash_entry *(*newfunc) 367 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *); 368 /* An objalloc for this hash table. This is a struct objalloc *, 369 but we use void * to avoid requiring the inclusion of objalloc.h. */ 370 void *memory; 371 /* The number of slots in the hash table. */ 372 unsigned int size; 373 /* The number of entries in the hash table. */ 374 unsigned int count; 375 /* The size of elements. */ 376 unsigned int entsize; 377 /* If non-zero, don't grow the hash table. */ 378 unsigned int frozen:1; 379 }; 380 381 /* Initialize a hash table. */ 382 extern bfd_boolean bfd_hash_table_init 383 (struct bfd_hash_table *, 384 struct bfd_hash_entry *(*) (struct bfd_hash_entry *, 385 struct bfd_hash_table *, 386 const char *), 387 unsigned int); 388 389 /* Initialize a hash table specifying a size. */ 390 extern bfd_boolean bfd_hash_table_init_n 391 (struct bfd_hash_table *, 392 struct bfd_hash_entry *(*) (struct bfd_hash_entry *, 393 struct bfd_hash_table *, 394 const char *), 395 unsigned int, unsigned int); 396 397 /* Free up a hash table. */ 398 extern void bfd_hash_table_free 399 (struct bfd_hash_table *); 400 401 /* Look up a string in a hash table. If CREATE is TRUE, a new entry 402 will be created for this string if one does not already exist. The 403 COPY argument must be TRUE if this routine should copy the string 404 into newly allocated memory when adding an entry. */ 405 extern struct bfd_hash_entry *bfd_hash_lookup 406 (struct bfd_hash_table *, const char *, bfd_boolean create, 407 bfd_boolean copy); 408 409 /* Insert an entry in a hash table. */ 410 extern struct bfd_hash_entry *bfd_hash_insert 411 (struct bfd_hash_table *, const char *, unsigned long); 412 413 /* Rename an entry in a hash table. */ 414 extern void bfd_hash_rename 415 (struct bfd_hash_table *, const char *, struct bfd_hash_entry *); 416 417 /* Replace an entry in a hash table. */ 418 extern void bfd_hash_replace 419 (struct bfd_hash_table *, struct bfd_hash_entry *old, 420 struct bfd_hash_entry *nw); 421 422 /* Base method for creating a hash table entry. */ 423 extern struct bfd_hash_entry *bfd_hash_newfunc 424 (struct bfd_hash_entry *, struct bfd_hash_table *, const char *); 425 426 /* Grab some space for a hash table entry. */ 427 extern void *bfd_hash_allocate 428 (struct bfd_hash_table *, unsigned int); 429 430 /* Traverse a hash table in a random order, calling a function on each 431 element. If the function returns FALSE, the traversal stops. The 432 INFO argument is passed to the function. */ 433 extern void bfd_hash_traverse 434 (struct bfd_hash_table *, 435 bfd_boolean (*) (struct bfd_hash_entry *, void *), 436 void *info); 437 438 /* Allows the default size of a hash table to be configured. New hash 439 tables allocated using bfd_hash_table_init will be created with 440 this size. */ 441 extern unsigned long bfd_hash_set_default_size (unsigned long); 442 443 /* This structure is used to keep track of stabs in sections 444 information while linking. */ 445 446 struct stab_info 447 { 448 /* A hash table used to hold stabs strings. */ 449 struct bfd_strtab_hash *strings; 450 /* The header file hash table. */ 451 struct bfd_hash_table includes; 452 /* The first .stabstr section. */ 453 struct bfd_section *stabstr; 454 }; 455 456 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table 457 458 /* User program access to BFD facilities. */ 459 460 /* Direct I/O routines, for programs which know more about the object 461 file than BFD does. Use higher level routines if possible. */ 462 463 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *); 464 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *); 465 extern int bfd_seek (bfd *, file_ptr, int); 466 extern file_ptr bfd_tell (bfd *); 467 extern int bfd_flush (bfd *); 468 extern int bfd_stat (bfd *, struct stat *); 469 470 /* Deprecated old routines. */ 471 #if __GNUC__ 472 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \ 473 (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__), \ 474 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 475 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \ 476 (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__), \ 477 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 478 #else 479 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD) \ 480 (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \ 481 bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 482 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD) \ 483 (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\ 484 bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD))) 485 #endif 486 extern void warn_deprecated (const char *, const char *, int, const char *); 487 488 /* Cast from const char * to char * so that caller can assign to 489 a char * without a warning. */ 490 #define bfd_get_filename(abfd) ((char *) (abfd)->filename) 491 #define bfd_get_cacheable(abfd) ((abfd)->cacheable) 492 #define bfd_get_format(abfd) ((abfd)->format) 493 #define bfd_get_target(abfd) ((abfd)->xvec->name) 494 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour) 495 #define bfd_family_coff(abfd) \ 496 (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \ 497 bfd_get_flavour (abfd) == bfd_target_xcoff_flavour) 498 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG) 499 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE) 500 #define bfd_header_big_endian(abfd) \ 501 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG) 502 #define bfd_header_little_endian(abfd) \ 503 ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE) 504 #define bfd_get_file_flags(abfd) ((abfd)->flags) 505 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags) 506 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags) 507 #define bfd_my_archive(abfd) ((abfd)->my_archive) 508 #define bfd_has_map(abfd) ((abfd)->has_armap) 509 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive) 510 511 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types) 512 #define bfd_usrdata(abfd) ((abfd)->usrdata) 513 514 #define bfd_get_start_address(abfd) ((abfd)->start_address) 515 #define bfd_get_symcount(abfd) ((abfd)->symcount) 516 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols) 517 #define bfd_count_sections(abfd) ((abfd)->section_count) 518 519 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount) 520 521 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char) 522 523 extern bfd_boolean bfd_cache_close 524 (bfd *abfd); 525 /* NB: This declaration should match the autogenerated one in libbfd.h. */ 526 527 extern bfd_boolean bfd_cache_close_all (void); 528 529 extern bfd_boolean bfd_record_phdr 530 (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma, 531 bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **); 532 533 /* Byte swapping routines. */ 534 535 bfd_uint64_t bfd_getb64 (const void *); 536 bfd_uint64_t bfd_getl64 (const void *); 537 bfd_int64_t bfd_getb_signed_64 (const void *); 538 bfd_int64_t bfd_getl_signed_64 (const void *); 539 bfd_vma bfd_getb32 (const void *); 540 bfd_vma bfd_getl32 (const void *); 541 bfd_signed_vma bfd_getb_signed_32 (const void *); 542 bfd_signed_vma bfd_getl_signed_32 (const void *); 543 bfd_vma bfd_getb16 (const void *); 544 bfd_vma bfd_getl16 (const void *); 545 bfd_signed_vma bfd_getb_signed_16 (const void *); 546 bfd_signed_vma bfd_getl_signed_16 (const void *); 547 void bfd_putb64 (bfd_uint64_t, void *); 548 void bfd_putl64 (bfd_uint64_t, void *); 549 void bfd_putb32 (bfd_vma, void *); 550 void bfd_putl32 (bfd_vma, void *); 551 void bfd_putb16 (bfd_vma, void *); 552 void bfd_putl16 (bfd_vma, void *); 553 554 /* Byte swapping routines which take size and endiannes as arguments. */ 555 556 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean); 557 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean); 558 559 #if defined(__STDC__) || defined(ALMOST_STDC) 560 struct ecoff_debug_info; 561 struct ecoff_debug_swap; 562 struct ecoff_extr; 563 struct bfd_symbol; 564 struct bfd_link_info; 565 struct bfd_link_hash_entry; 566 struct bfd_section_already_linked; 567 struct bfd_elf_version_tree; 568 #endif 569 570 extern bfd_boolean bfd_section_already_linked_table_init (void); 571 extern void bfd_section_already_linked_table_free (void); 572 extern bfd_boolean _bfd_handle_already_linked 573 (struct bfd_section *, struct bfd_section_already_linked *, 574 struct bfd_link_info *); 575 576 /* Externally visible ECOFF routines. */ 578 579 extern bfd_vma bfd_ecoff_get_gp_value 580 (bfd * abfd); 581 extern bfd_boolean bfd_ecoff_set_gp_value 582 (bfd *abfd, bfd_vma gp_value); 583 extern bfd_boolean bfd_ecoff_set_regmasks 584 (bfd *abfd, unsigned long gprmask, unsigned long fprmask, 585 unsigned long *cprmask); 586 extern void *bfd_ecoff_debug_init 587 (bfd *output_bfd, struct ecoff_debug_info *output_debug, 588 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *); 589 extern void bfd_ecoff_debug_free 590 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, 591 const struct ecoff_debug_swap *output_swap, struct bfd_link_info *); 592 extern bfd_boolean bfd_ecoff_debug_accumulate 593 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, 594 const struct ecoff_debug_swap *output_swap, bfd *input_bfd, 595 struct ecoff_debug_info *input_debug, 596 const struct ecoff_debug_swap *input_swap, struct bfd_link_info *); 597 extern bfd_boolean bfd_ecoff_debug_accumulate_other 598 (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug, 599 const struct ecoff_debug_swap *output_swap, bfd *input_bfd, 600 struct bfd_link_info *); 601 extern bfd_boolean bfd_ecoff_debug_externals 602 (bfd *abfd, struct ecoff_debug_info *debug, 603 const struct ecoff_debug_swap *swap, bfd_boolean relocatable, 604 bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *), 605 void (*set_index) (struct bfd_symbol *, bfd_size_type)); 606 extern bfd_boolean bfd_ecoff_debug_one_external 607 (bfd *abfd, struct ecoff_debug_info *debug, 608 const struct ecoff_debug_swap *swap, const char *name, 609 struct ecoff_extr *esym); 610 extern bfd_size_type bfd_ecoff_debug_size 611 (bfd *abfd, struct ecoff_debug_info *debug, 612 const struct ecoff_debug_swap *swap); 613 extern bfd_boolean bfd_ecoff_write_debug 614 (bfd *abfd, struct ecoff_debug_info *debug, 615 const struct ecoff_debug_swap *swap, file_ptr where); 616 extern bfd_boolean bfd_ecoff_write_accumulated_debug 617 (void *handle, bfd *abfd, struct ecoff_debug_info *debug, 618 const struct ecoff_debug_swap *swap, 619 struct bfd_link_info *info, file_ptr where); 620 621 /* Externally visible ELF routines. */ 622 623 struct bfd_link_needed_list 624 { 625 struct bfd_link_needed_list *next; 626 bfd *by; 627 const char *name; 628 }; 629 630 enum dynamic_lib_link_class { 631 DYN_NORMAL = 0, 632 DYN_AS_NEEDED = 1, 633 DYN_DT_NEEDED = 2, 634 DYN_NO_ADD_NEEDED = 4, 635 DYN_NO_NEEDED = 8 636 }; 637 638 enum notice_asneeded_action { 639 notice_as_needed, 640 notice_not_needed, 641 notice_needed 642 }; 643 644 extern bfd_boolean bfd_elf_record_link_assignment 645 (bfd *, struct bfd_link_info *, const char *, bfd_boolean, 646 bfd_boolean); 647 extern struct bfd_link_needed_list *bfd_elf_get_needed_list 648 (bfd *, struct bfd_link_info *); 649 extern bfd_boolean bfd_elf_get_bfd_needed_list 650 (bfd *, struct bfd_link_needed_list **); 651 extern bfd_boolean bfd_elf_stack_segment_size (bfd *, struct bfd_link_info *, 652 const char *, bfd_vma); 653 extern bfd_boolean bfd_elf_size_dynamic_sections 654 (bfd *, const char *, const char *, const char *, const char *, const char *, 655 const char * const *, struct bfd_link_info *, struct bfd_section **); 656 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr 657 (bfd *, struct bfd_link_info *); 658 extern void bfd_elf_set_dt_needed_name 659 (bfd *, const char *); 660 extern const char *bfd_elf_get_dt_soname 661 (bfd *); 662 extern void bfd_elf_set_dyn_lib_class 663 (bfd *, enum dynamic_lib_link_class); 664 extern int bfd_elf_get_dyn_lib_class 665 (bfd *); 666 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list 667 (bfd *, struct bfd_link_info *); 668 extern int bfd_elf_discard_info 669 (bfd *, struct bfd_link_info *); 670 extern unsigned int _bfd_elf_default_action_discarded 671 (struct bfd_section *); 672 673 /* Return an upper bound on the number of bytes required to store a 674 copy of ABFD's program header table entries. Return -1 if an error 675 occurs; bfd_get_error will return an appropriate code. */ 676 extern long bfd_get_elf_phdr_upper_bound 677 (bfd *abfd); 678 679 /* Copy ABFD's program header table entries to *PHDRS. The entries 680 will be stored as an array of Elf_Internal_Phdr structures, as 681 defined in include/elf/internal.h. To find out how large the 682 buffer needs to be, call bfd_get_elf_phdr_upper_bound. 683 684 Return the number of program header table entries read, or -1 if an 685 error occurs; bfd_get_error will return an appropriate code. */ 686 extern int bfd_get_elf_phdrs 687 (bfd *abfd, void *phdrs); 688 689 /* Create a new BFD as if by bfd_openr. Rather than opening a file, 690 reconstruct an ELF file by reading the segments out of remote 691 memory based on the ELF file header at EHDR_VMA and the ELF program 692 headers it points to. If non-zero, SIZE is the known extent of the 693 object. If not null, *LOADBASEP is filled in with the difference 694 between the VMAs from which the segments were read, and the VMAs 695 the file headers (and hence BFD's idea of each section's VMA) put 696 them at. 697 698 The function TARGET_READ_MEMORY is called to copy LEN bytes from 699 the remote memory at target address VMA into the local buffer at 700 MYADDR; it should return zero on success or an `errno' code on 701 failure. TEMPL must be a BFD for a target with the word size and 702 byte order found in the remote memory. */ 703 extern bfd *bfd_elf_bfd_from_remote_memory 704 (bfd *templ, bfd_vma ehdr_vma, bfd_size_type size, bfd_vma *loadbasep, 705 int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, 706 bfd_size_type len)); 707 708 extern struct bfd_section *_bfd_elf_tls_setup 709 (bfd *, struct bfd_link_info *); 710 711 extern struct bfd_section * 712 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma); 713 714 extern void _bfd_fix_excluded_sec_syms 715 (bfd *, struct bfd_link_info *); 716 717 extern unsigned bfd_m68k_mach_to_features (int); 718 719 extern int bfd_m68k_features_to_mach (unsigned); 720 721 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs 722 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, 723 char **); 724 725 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int); 726 727 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs 728 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, 729 char **); 730 731 extern bfd_boolean bfd_cr16_elf32_create_embedded_relocs 732 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, 733 char **); 734 735 /* SunOS shared library support routines for the linker. */ 736 737 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list 738 (bfd *, struct bfd_link_info *); 739 extern bfd_boolean bfd_sunos_record_link_assignment 740 (bfd *, struct bfd_link_info *, const char *); 741 extern bfd_boolean bfd_sunos_size_dynamic_sections 742 (bfd *, struct bfd_link_info *, struct bfd_section **, 743 struct bfd_section **, struct bfd_section **); 744 745 /* Linux shared library support routines for the linker. */ 746 747 extern bfd_boolean bfd_i386linux_size_dynamic_sections 748 (bfd *, struct bfd_link_info *); 749 extern bfd_boolean bfd_m68klinux_size_dynamic_sections 750 (bfd *, struct bfd_link_info *); 751 extern bfd_boolean bfd_sparclinux_size_dynamic_sections 752 (bfd *, struct bfd_link_info *); 753 754 /* mmap hacks */ 755 756 struct _bfd_window_internal; 757 typedef struct _bfd_window_internal bfd_window_internal; 758 759 typedef struct _bfd_window 760 { 761 /* What the user asked for. */ 762 void *data; 763 bfd_size_type size; 764 /* The actual window used by BFD. Small user-requested read-only 765 regions sharing a page may share a single window into the object 766 file. Read-write versions shouldn't until I've fixed things to 767 keep track of which portions have been claimed by the 768 application; don't want to give the same region back when the 769 application wants two writable copies! */ 770 struct _bfd_window_internal *i; 771 } 772 bfd_window; 773 774 extern void bfd_init_window 775 (bfd_window *); 776 extern void bfd_free_window 777 (bfd_window *); 778 extern bfd_boolean bfd_get_file_window 779 (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean); 780 781 /* XCOFF support routines for the linker. */ 782 783 extern bfd_boolean bfd_xcoff_split_import_path 784 (bfd *, const char *, const char **, const char **); 785 extern bfd_boolean bfd_xcoff_set_archive_import_path 786 (struct bfd_link_info *, bfd *, const char *); 787 extern bfd_boolean bfd_xcoff_link_record_set 788 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type); 789 extern bfd_boolean bfd_xcoff_import_symbol 790 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma, 791 const char *, const char *, const char *, unsigned int); 792 extern bfd_boolean bfd_xcoff_export_symbol 793 (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *); 794 extern bfd_boolean bfd_xcoff_link_count_reloc 795 (bfd *, struct bfd_link_info *, const char *); 796 extern bfd_boolean bfd_xcoff_record_link_assignment 797 (bfd *, struct bfd_link_info *, const char *); 798 extern bfd_boolean bfd_xcoff_size_dynamic_sections 799 (bfd *, struct bfd_link_info *, const char *, const char *, 800 unsigned long, unsigned long, unsigned long, bfd_boolean, 801 int, bfd_boolean, unsigned int, struct bfd_section **, bfd_boolean); 802 extern bfd_boolean bfd_xcoff_link_generate_rtinit 803 (bfd *, const char *, const char *, bfd_boolean); 804 805 /* XCOFF support routines for ar. */ 806 extern bfd_boolean bfd_xcoff_ar_archive_set_magic 807 (bfd *, char *); 808 809 /* Externally visible COFF routines. */ 810 811 #if defined(__STDC__) || defined(ALMOST_STDC) 812 struct internal_syment; 813 union internal_auxent; 814 #endif 815 816 extern bfd_boolean bfd_coff_get_syment 817 (bfd *, struct bfd_symbol *, struct internal_syment *); 818 819 extern bfd_boolean bfd_coff_get_auxent 820 (bfd *, struct bfd_symbol *, int, union internal_auxent *); 821 822 extern bfd_boolean bfd_coff_set_symbol_class 823 (bfd *, struct bfd_symbol *, unsigned int); 824 825 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs 826 (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **); 827 828 /* ARM VFP11 erratum workaround support. */ 829 typedef enum 830 { 831 BFD_ARM_VFP11_FIX_DEFAULT, 832 BFD_ARM_VFP11_FIX_NONE, 833 BFD_ARM_VFP11_FIX_SCALAR, 834 BFD_ARM_VFP11_FIX_VECTOR 835 } bfd_arm_vfp11_fix; 836 837 extern void bfd_elf32_arm_init_maps 838 (bfd *); 839 840 extern void bfd_elf32_arm_set_vfp11_fix 841 (bfd *, struct bfd_link_info *); 842 843 extern void bfd_elf32_arm_set_cortex_a8_fix 844 (bfd *, struct bfd_link_info *); 845 846 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan 847 (bfd *, struct bfd_link_info *); 848 849 extern void bfd_elf32_arm_vfp11_fix_veneer_locations 850 (bfd *, struct bfd_link_info *); 851 852 /* ARM Interworking support. Called from linker. */ 853 extern bfd_boolean bfd_arm_allocate_interworking_sections 854 (struct bfd_link_info *); 855 856 extern bfd_boolean bfd_arm_process_before_allocation 857 (bfd *, struct bfd_link_info *, int); 858 859 extern bfd_boolean bfd_arm_get_bfd_for_interworking 860 (bfd *, struct bfd_link_info *); 861 862 /* PE ARM Interworking support. Called from linker. */ 863 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections 864 (struct bfd_link_info *); 865 866 extern bfd_boolean bfd_arm_pe_process_before_allocation 867 (bfd *, struct bfd_link_info *, int); 868 869 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking 870 (bfd *, struct bfd_link_info *); 871 872 /* ELF ARM Interworking support. Called from linker. */ 873 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections 874 (struct bfd_link_info *); 875 876 extern bfd_boolean bfd_elf32_arm_process_before_allocation 877 (bfd *, struct bfd_link_info *); 878 879 void bfd_elf32_arm_set_target_relocs 880 (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix, 881 int, int, int, int, int); 882 883 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking 884 (bfd *, struct bfd_link_info *); 885 886 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd 887 (bfd *, struct bfd_link_info *); 888 889 /* ELF ARM mapping symbol support. */ 890 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP (1 << 0) 891 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG (1 << 1) 892 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER (1 << 2) 893 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY (~0) 894 895 extern bfd_boolean bfd_is_arm_special_symbol_name 896 (const char *, int); 897 898 extern void bfd_elf32_arm_set_byteswap_code 899 (struct bfd_link_info *, int); 900 901 extern void bfd_elf32_arm_use_long_plt (void); 902 903 /* ARM Note section processing. */ 904 extern bfd_boolean bfd_arm_merge_machines 905 (bfd *, bfd *); 906 907 extern bfd_boolean bfd_arm_update_notes 908 (bfd *, const char *); 909 910 extern unsigned int bfd_arm_get_mach_from_notes 911 (bfd *, const char *); 912 913 /* ARM stub generation support. Called from the linker. */ 914 extern int elf32_arm_setup_section_lists 915 (bfd *, struct bfd_link_info *); 916 extern void elf32_arm_next_input_section 917 (struct bfd_link_info *, struct bfd_section *); 918 extern bfd_boolean elf32_arm_size_stubs 919 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma, 920 struct bfd_section * (*) (const char *, struct bfd_section *, unsigned int), 921 void (*) (void)); 922 extern bfd_boolean elf32_arm_build_stubs 923 (struct bfd_link_info *); 924 925 /* ARM unwind section editing support. */ 926 extern bfd_boolean elf32_arm_fix_exidx_coverage 927 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean); 928 929 /* C6x unwind section editing support. */ 930 extern bfd_boolean elf32_tic6x_fix_exidx_coverage 931 (struct bfd_section **, unsigned int, struct bfd_link_info *, bfd_boolean); 932 933 /* PowerPC @tls opcode transform/validate. */ 934 extern unsigned int _bfd_elf_ppc_at_tls_transform 935 (unsigned int, unsigned int); 936 /* PowerPC @tprel opcode transform/validate. */ 937 extern unsigned int _bfd_elf_ppc_at_tprel_transform 938 (unsigned int, unsigned int); 939 940 extern void bfd_elf64_aarch64_init_maps 941 (bfd *); 942 943 extern void bfd_elf32_aarch64_init_maps 944 (bfd *); 945 946 extern void bfd_elf64_aarch64_set_options 947 (bfd *, struct bfd_link_info *, int, int, int, int, int); 948 949 extern void bfd_elf32_aarch64_set_options 950 (bfd *, struct bfd_link_info *, int, int, int, int, int); 951 952 /* ELF AArch64 mapping symbol support. */ 953 #define BFD_AARCH64_SPECIAL_SYM_TYPE_MAP (1 << 0) 954 #define BFD_AARCH64_SPECIAL_SYM_TYPE_TAG (1 << 1) 955 #define BFD_AARCH64_SPECIAL_SYM_TYPE_OTHER (1 << 2) 956 #define BFD_AARCH64_SPECIAL_SYM_TYPE_ANY (~0) 957 extern bfd_boolean bfd_is_aarch64_special_symbol_name 958 (const char * name, int type); 959 960 /* AArch64 stub generation support for ELF64. Called from the linker. */ 961 extern int elf64_aarch64_setup_section_lists 962 (bfd *, struct bfd_link_info *); 963 extern void elf64_aarch64_next_input_section 964 (struct bfd_link_info *, struct bfd_section *); 965 extern bfd_boolean elf64_aarch64_size_stubs 966 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma, 967 struct bfd_section * (*) (const char *, struct bfd_section *), 968 void (*) (void)); 969 extern bfd_boolean elf64_aarch64_build_stubs 970 (struct bfd_link_info *); 971 /* AArch64 stub generation support for ELF32. Called from the linker. */ 972 extern int elf32_aarch64_setup_section_lists 973 (bfd *, struct bfd_link_info *); 974 extern void elf32_aarch64_next_input_section 975 (struct bfd_link_info *, struct bfd_section *); 976 extern bfd_boolean elf32_aarch64_size_stubs 977 (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma, 978 struct bfd_section * (*) (const char *, struct bfd_section *), 979 void (*) (void)); 980 extern bfd_boolean elf32_aarch64_build_stubs 981 (struct bfd_link_info *); 982 983 984 /* TI COFF load page support. */ 985 extern void bfd_ticoff_set_section_load_page 986 (struct bfd_section *, int); 987 988 extern int bfd_ticoff_get_section_load_page 989 (struct bfd_section *); 990 991 /* H8/300 functions. */ 992 extern bfd_vma bfd_h8300_pad_address 993 (bfd *, bfd_vma); 994 995 /* IA64 Itanium code generation. Called from linker. */ 996 extern void bfd_elf32_ia64_after_parse 997 (int); 998 999 extern void bfd_elf64_ia64_after_parse 1000 (int); 1001 1002 /* This structure is used for a comdat section, as in PE. A comdat 1003 section is associated with a particular symbol. When the linker 1004 sees a comdat section, it keeps only one of the sections with a 1005 given name and associated with a given symbol. */ 1006 1007 struct coff_comdat_info 1008 { 1009 /* The name of the symbol associated with a comdat section. */ 1010 const char *name; 1011 1012 /* The local symbol table index of the symbol associated with a 1013 comdat section. This is only meaningful to the object file format 1014 specific code; it is not an index into the list returned by 1015 bfd_canonicalize_symtab. */ 1016 long symbol; 1017 }; 1018 1019 extern struct coff_comdat_info * bfd_coff_get_comdat_section 1020 (bfd *, struct bfd_section *); 1021