bfd/bfd-in.h

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