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