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