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)                  \
 235   (((x)->flags & BSF_SYNTHETIC) != 0            \
 236    ? bfd_target_unknown_flavour                 \
 237    : bfd_asymbol_bfd (x)->xvec->flavour)
 238
 239 /* A canonical archive symbol.  */
 240 /* This is a type pun with struct ranlib on purpose!  */
 241 typedef struct carsym
 242 {
 243   char *name;
 244   file_ptr file_offset; /* Look here to find the file.  */
 245 }
 246 carsym;                 /* To make these you call a carsymogen.  */
 247
 248 /* Used in generating armaps (archive tables of contents).
 249    Perhaps just a forward definition would do?  */
 250 struct orl                      /* Output ranlib.  */
 251 {
 252   char **name;          /* Symbol name.  */
 253   union
 254   {
 255     file_ptr pos;
 256     bfd *abfd;
 257   } u;                  /* bfd* or file position.  */
 258   int namidx;           /* Index into string table.  */
 259 };
 260 \f
 261 /* Linenumber stuff.  */
 262 typedef struct lineno_cache_entry
 263 {
 264   unsigned int line_number;     /* Linenumber from start of function.  */
 265   union
 266   {
 267     struct bfd_symbol *sym;     /* Function name.  */
 268     bfd_vma offset;                     /* Offset into section.  */
 269   } u;
 270 }
 271 alent;
 272 \f
 273 /* Object and core file sections.  */
 274
 275 #define align_power(addr, align)        \
 276   (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
 277
 278 typedef struct bfd_section *sec_ptr;
 279
 280 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 281 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 282 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
 283 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 284 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 285 #define bfd_section_size(bfd, ptr) ((ptr)->size)
 286 #define bfd_get_section_size(ptr) ((ptr)->size)
 287 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 288 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 289 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 290 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 291 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 292
 293 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 294
 295 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
 296 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
 297 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
 298 /* Find the address one past the end of SEC.  */
 299 #define bfd_get_section_limit(bfd, sec) \
 300   (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
 301    / bfd_octets_per_byte (bfd))
 302
 303 /* Return TRUE if section has been discarded.  */
 304 #define elf_discarded_section(sec)                              \
 305   (!bfd_is_abs_section (sec)                                    \
 306    && bfd_is_abs_section ((sec)->output_section)                \
 307    && (sec)->sec_info_type != ELF_INFO_TYPE_MERGE               \
 308    && (sec)->sec_info_type != ELF_INFO_TYPE_JUST_SYMS)
 309
 310 /* Forward define.  */
 311 struct stat;
 312 \f
 313 typedef enum bfd_print_symbol
 314 {
 315   bfd_print_symbol_name,
 316   bfd_print_symbol_more,
 317   bfd_print_symbol_all
 318 } bfd_print_symbol_type;
 319
 320 /* Information about a symbol that nm needs.  */
 321
 322 typedef struct _symbol_info
 323 {
 324   symvalue value;
 325   char type;
 326   const char *name;            /* Symbol name.  */
 327   unsigned char stab_type;     /* Stab type.  */
 328   char stab_other;             /* Stab other.  */
 329   short stab_desc;             /* Stab desc.  */
 330   const char *stab_name;       /* String for stab type.  */
 331 } symbol_info;
 332
 333 /* Get the name of a stabs type code.  */
 334
 335 extern const char *bfd_get_stab_name (int);
 336 \f
 337 /* Hash table routines.  There is no way to free up a hash table.  */
 338
 339 /* An element in the hash table.  Most uses will actually use a larger
 340    structure, and an instance of this will be the first field.  */
 341
 342 struct bfd_hash_entry
 343 {
 344   /* Next entry for this hash code.  */
 345   struct bfd_hash_entry *next;
 346   /* String being hashed.  */
 347   const char *string;
 348   /* Hash code.  This is the full hash code, not the index into the
 349      table.  */
 350   unsigned long hash;
 351 };
 352
 353 /* A hash table.  */
 354
 355 struct bfd_hash_table
 356 {
 357   /* The hash array.  */
 358   struct bfd_hash_entry **table;
 359   /* A function used to create new elements in the hash table.  The
 360      first entry is itself a pointer to an element.  When this
 361      function is first invoked, this pointer will be NULL.  However,
 362      having the pointer permits a hierarchy of method functions to be
 363      built each of which calls the function in the superclass.  Thus
 364      each function should be written to allocate a new block of memory
 365      only if the argument is NULL.  */
 366   struct bfd_hash_entry *(*newfunc)
 367     (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 368    /* An objalloc for this hash table.  This is a struct objalloc *,
 369      but we use void * to avoid requiring the inclusion of objalloc.h.  */
 370   void *memory;
 371   /* The number of slots in the hash table.  */
 372   unsigned int size;
 373   /* The number of entries in the hash table.  */
 374   unsigned int count;
 375   /* The size of elements.  */
 376   unsigned int entsize;
 377   /* If non-zero, don't grow the hash table.  */
 378   unsigned int frozen:1;
 379 };
 380
 381 /* Initialize a hash table.  */
 382 extern bfd_boolean bfd_hash_table_init
 383   (struct bfd_hash_table *,
 384    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 385                                struct bfd_hash_table *,
 386                                const char *),
 387    unsigned int);
 388
 389 /* Initialize a hash table specifying a size.  */
 390 extern bfd_boolean bfd_hash_table_init_n
 391   (struct bfd_hash_table *,
 392    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 393                                struct bfd_hash_table *,
 394                                const char *),
 395    unsigned int, unsigned int);
 396
 397 /* Free up a hash table.  */
 398 extern void bfd_hash_table_free
 399   (struct bfd_hash_table *);
 400
 401 /* Look up a string in a hash table.  If CREATE is TRUE, a new entry
 402    will be created for this string if one does not already exist.  The
 403    COPY argument must be TRUE if this routine should copy the string
 404    into newly allocated memory when adding an entry.  */
 405 extern struct bfd_hash_entry *bfd_hash_lookup
 406   (struct bfd_hash_table *, const char *, bfd_boolean create,
 407    bfd_boolean copy);
 408
 409 /* Insert an entry in a hash table.  */
 410 extern struct bfd_hash_entry *bfd_hash_insert
 411   (struct bfd_hash_table *, const char *, unsigned long);
 412
 413 /* Replace an entry in a hash table.  */
 414 extern void bfd_hash_replace
 415   (struct bfd_hash_table *, struct bfd_hash_entry *old,
 416    struct bfd_hash_entry *nw);
 417
 418 /* Base method for creating a hash table entry.  */
 419 extern struct bfd_hash_entry *bfd_hash_newfunc
 420   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 421
 422 /* Grab some space for a hash table entry.  */
 423 extern void *bfd_hash_allocate
 424   (struct bfd_hash_table *, unsigned int);
 425
 426 /* Traverse a hash table in a random order, calling a function on each
 427    element.  If the function returns FALSE, the traversal stops.  The
 428    INFO argument is passed to the function.  */
 429 extern void bfd_hash_traverse
 430   (struct bfd_hash_table *,
 431    bfd_boolean (*) (struct bfd_hash_entry *, void *),
 432    void *info);
 433
 434 /* Allows the default size of a hash table to be configured. New hash
 435    tables allocated using bfd_hash_table_init will be created with
 436    this size.  */
 437 extern void bfd_hash_set_default_size (bfd_size_type);
 438
 439 /* This structure is used to keep track of stabs in sections
 440    information while linking.  */
 441
 442 struct stab_info
 443 {
 444   /* A hash table used to hold stabs strings.  */
 445   struct bfd_strtab_hash *strings;
 446   /* The header file hash table.  */
 447   struct bfd_hash_table includes;
 448   /* The first .stabstr section.  */
 449   struct bfd_section *stabstr;
 450 };
 451
 452 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
 453
 454 /* User program access to BFD facilities.  */
 455
 456 /* Direct I/O routines, for programs which know more about the object
 457    file than BFD does.  Use higher level routines if possible.  */
 458
 459 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
 460 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
 461 extern int bfd_seek (bfd *, file_ptr, int);
 462 extern file_ptr bfd_tell (bfd *);
 463 extern int bfd_flush (bfd *);
 464 extern int bfd_stat (bfd *, struct stat *);
 465
 466 /* Deprecated old routines.  */
 467 #if __GNUC__
 468 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 469   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 470    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 471 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 472   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 473    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 474 #else
 475 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 476   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 477    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 478 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 479   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 480    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 481 #endif
 482 extern void warn_deprecated (const char *, const char *, int, const char *);
 483
 484 /* Cast from const char * to char * so that caller can assign to
 485    a char * without a warning.  */
 486 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 487 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 488 #define bfd_get_format(abfd) ((abfd)->format)
 489 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 490 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 491 #define bfd_family_coff(abfd) \
 492   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
 493    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
 494 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 495 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 496 #define bfd_header_big_endian(abfd) \
 497   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 498 #define bfd_header_little_endian(abfd) \
 499   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 500 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 501 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 502 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 503 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 504 #define bfd_has_map(abfd) ((abfd)->has_armap)
 505 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
 506
 507 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 508 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 509
 510 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 511 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 512 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 513 #define bfd_count_sections(abfd) ((abfd)->section_count)
 514
 515 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
 516
 517 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 518
 519 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
 520
 521 extern bfd_boolean bfd_cache_close
 522   (bfd *abfd);
 523 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 524
 525 extern bfd_boolean bfd_cache_close_all (void);
 526
 527 extern bfd_boolean bfd_record_phdr
 528   (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
 529    bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
 530
 531 /* Byte swapping routines.  */
 532
 533 bfd_uint64_t bfd_getb64 (const void *);
 534 bfd_uint64_t bfd_getl64 (const void *);
 535 bfd_int64_t bfd_getb_signed_64 (const void *);
 536 bfd_int64_t bfd_getl_signed_64 (const void *);
 537 bfd_vma bfd_getb32 (const void *);
 538 bfd_vma bfd_getl32 (const void *);
 539 bfd_signed_vma bfd_getb_signed_32 (const void *);
 540 bfd_signed_vma bfd_getl_signed_32 (const void *);
 541 bfd_vma bfd_getb16 (const void *);
 542 bfd_vma bfd_getl16 (const void *);
 543 bfd_signed_vma bfd_getb_signed_16 (const void *);
 544 bfd_signed_vma bfd_getl_signed_16 (const void *);
 545 void bfd_putb64 (bfd_uint64_t, void *);
 546 void bfd_putl64 (bfd_uint64_t, void *);
 547 void bfd_putb32 (bfd_vma, void *);
 548 void bfd_putl32 (bfd_vma, void *);
 549 void bfd_putb16 (bfd_vma, void *);
 550 void bfd_putl16 (bfd_vma, void *);
 551
 552 /* Byte swapping routines which take size and endiannes as arguments.  */
 553
 554 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
 555 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
 556
 557 extern bfd_boolean bfd_section_already_linked_table_init (void);
 558 extern void bfd_section_already_linked_table_free (void);
 559 \f
 560 /* Externally visible ECOFF routines.  */
 561
 562 #if defined(__STDC__) || defined(ALMOST_STDC)
 563 struct ecoff_debug_info;
 564 struct ecoff_debug_swap;
 565 struct ecoff_extr;
 566 struct bfd_symbol;
 567 struct bfd_link_info;
 568 struct bfd_link_hash_entry;
 569 struct bfd_elf_version_tree;
 570 #endif
 571 extern bfd_vma bfd_ecoff_get_gp_value
 572   (bfd * abfd);
 573 extern bfd_boolean bfd_ecoff_set_gp_value
 574   (bfd *abfd, bfd_vma gp_value);
 575 extern bfd_boolean bfd_ecoff_set_regmasks
 576   (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 577    unsigned long *cprmask);
 578 extern void *bfd_ecoff_debug_init
 579   (bfd *output_bfd, struct ecoff_debug_info *output_debug,
 580    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 581 extern void bfd_ecoff_debug_free
 582   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 583    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 584 extern bfd_boolean bfd_ecoff_debug_accumulate
 585   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 586    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 587    struct ecoff_debug_info *input_debug,
 588    const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
 589 extern bfd_boolean bfd_ecoff_debug_accumulate_other
 590   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 591    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 592    struct bfd_link_info *);
 593 extern bfd_boolean bfd_ecoff_debug_externals
 594   (bfd *abfd, struct ecoff_debug_info *debug,
 595    const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
 596    bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
 597    void (*set_index) (struct bfd_symbol *, bfd_size_type));
 598 extern bfd_boolean bfd_ecoff_debug_one_external
 599   (bfd *abfd, struct ecoff_debug_info *debug,
 600    const struct ecoff_debug_swap *swap, const char *name,
 601    struct ecoff_extr *esym);
 602 extern bfd_size_type bfd_ecoff_debug_size
 603   (bfd *abfd, struct ecoff_debug_info *debug,
 604    const struct ecoff_debug_swap *swap);
 605 extern bfd_boolean bfd_ecoff_write_debug
 606   (bfd *abfd, struct ecoff_debug_info *debug,
 607    const struct ecoff_debug_swap *swap, file_ptr where);
 608 extern bfd_boolean bfd_ecoff_write_accumulated_debug
 609   (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
 610    const struct ecoff_debug_swap *swap,
 611    struct bfd_link_info *info, file_ptr where);
 612
 613 /* Externally visible ELF routines.  */
 614
 615 struct bfd_link_needed_list
 616 {
 617   struct bfd_link_needed_list *next;
 618   bfd *by;
 619   const char *name;
 620 };
 621
 622 enum dynamic_lib_link_class {
 623   DYN_NORMAL = 0,
 624   DYN_AS_NEEDED = 1,
 625   DYN_DT_NEEDED = 2,
 626   DYN_NO_ADD_NEEDED = 4,
 627   DYN_NO_NEEDED = 8
 628 };
 629
 630 enum notice_asneeded_action {
 631   notice_as_needed,
 632   notice_not_needed,
 633   notice_needed
 634 };
 635
 636 extern bfd_boolean bfd_elf_record_link_assignment
 637   (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
 638    bfd_boolean);
 639 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 640   (bfd *, struct bfd_link_info *);
 641 extern bfd_boolean bfd_elf_get_bfd_needed_list
 642   (bfd *, struct bfd_link_needed_list **);
 643 extern bfd_boolean bfd_elf_size_dynamic_sections
 644   (bfd *, const char *, const char *, const char *, const char * const *,
 645    struct bfd_link_info *, struct bfd_section **,
 646    struct bfd_elf_version_tree *);
 647 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
 648   (bfd *, struct bfd_link_info *);
 649 extern void bfd_elf_set_dt_needed_name
 650   (bfd *, const char *);
 651 extern const char *bfd_elf_get_dt_soname
 652   (bfd *);
 653 extern void bfd_elf_set_dyn_lib_class
 654   (bfd *, enum dynamic_lib_link_class);
 655 extern int bfd_elf_get_dyn_lib_class
 656   (bfd *);
 657 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 658   (bfd *, struct bfd_link_info *);
 659 extern bfd_boolean bfd_elf_discard_info
 660   (bfd *, struct bfd_link_info *);
 661 extern unsigned int _bfd_elf_default_action_discarded
 662   (struct bfd_section *);
 663
 664 /* Return an upper bound on the number of bytes required to store a
 665    copy of ABFD's program header table entries.  Return -1 if an error
 666    occurs; bfd_get_error will return an appropriate code.  */
 667 extern long bfd_get_elf_phdr_upper_bound
 668   (bfd *abfd);
 669
 670 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 671    will be stored as an array of Elf_Internal_Phdr structures, as
 672    defined in include/elf/internal.h.  To find out how large the
 673    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 674
 675    Return the number of program header table entries read, or -1 if an
 676    error occurs; bfd_get_error will return an appropriate code.  */
 677 extern int bfd_get_elf_phdrs
 678   (bfd *abfd, void *phdrs);
 679
 680 /* Create a new BFD as if by bfd_openr.  Rather than opening a file,
 681    reconstruct an ELF file by reading the segments out of remote memory
 682    based on the ELF file header at EHDR_VMA and the ELF program headers it
 683    points to.  If not null, *LOADBASEP is filled in with the difference
 684    between the VMAs from which the segments were read, and the VMAs the
 685    file headers (and hence BFD's idea of each section's VMA) put them at.
 686
 687    The function TARGET_READ_MEMORY is called to copy LEN bytes from the
 688    remote memory at target address VMA into the local buffer at MYADDR; it
 689    should return zero on success or an `errno' code on failure.  TEMPL must
 690    be a BFD for an ELF target with the word size and byte order found in
 691    the remote memory.  */
 692 extern bfd *bfd_elf_bfd_from_remote_memory
 693   (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
 694    int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
 695
 696 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 697 extern int bfd_get_arch_size
 698   (bfd *);
 699
 700 /* Return TRUE if address "naturally" sign extends, or -1 if not elf.  */
 701 extern int bfd_get_sign_extend_vma
 702   (bfd *);
 703
 704 extern struct bfd_section *_bfd_elf_tls_setup
 705   (bfd *, struct bfd_link_info *);
 706
 707 extern void _bfd_fix_excluded_sec_syms
 708   (bfd *, struct bfd_link_info *);
 709
 710 extern unsigned bfd_m68k_mach_to_features (int);
 711
 712 extern int bfd_m68k_features_to_mach (unsigned);
 713
 714 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
 715   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
 716    char **);
 717
 718 extern void bfd_elf_m68k_set_target_options (struct bfd_link_info *, int);
 719
 720 extern bfd_boolean bfd_bfin_elf32_create_embedded_relocs
 721   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *,
 722    char **);
 723
 724 /* SunOS shared library support routines for the linker.  */
 725
 726 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 727   (bfd *, struct bfd_link_info *);
 728 extern bfd_boolean bfd_sunos_record_link_assignment
 729   (bfd *, struct bfd_link_info *, const char *);
 730 extern bfd_boolean bfd_sunos_size_dynamic_sections
 731   (bfd *, struct bfd_link_info *, struct bfd_section **,
 732    struct bfd_section **, struct bfd_section **);
 733
 734 /* Linux shared library support routines for the linker.  */
 735
 736 extern bfd_boolean bfd_i386linux_size_dynamic_sections
 737   (bfd *, struct bfd_link_info *);
 738 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
 739   (bfd *, struct bfd_link_info *);
 740 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
 741   (bfd *, struct bfd_link_info *);
 742
 743 /* mmap hacks */
 744
 745 struct _bfd_window_internal;
 746 typedef struct _bfd_window_internal bfd_window_internal;
 747
 748 typedef struct _bfd_window
 749 {
 750   /* What the user asked for.  */
 751   void *data;
 752   bfd_size_type size;
 753   /* The actual window used by BFD.  Small user-requested read-only
 754      regions sharing a page may share a single window into the object
 755      file.  Read-write versions shouldn't until I've fixed things to
 756      keep track of which portions have been claimed by the
 757      application; don't want to give the same region back when the
 758      application wants two writable copies!  */
 759   struct _bfd_window_internal *i;
 760 }
 761 bfd_window;
 762
 763 extern void bfd_init_window
 764   (bfd_window *);
 765 extern void bfd_free_window
 766   (bfd_window *);
 767 extern bfd_boolean bfd_get_file_window
 768   (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
 769
 770 /* XCOFF support routines for the linker.  */
 771
 772 extern bfd_boolean bfd_xcoff_link_record_set
 773   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
 774 extern bfd_boolean bfd_xcoff_import_symbol
 775   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
 776    const char *, const char *, const char *, unsigned int);
 777 extern bfd_boolean bfd_xcoff_export_symbol
 778   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
 779 extern bfd_boolean bfd_xcoff_link_count_reloc
 780   (bfd *, struct bfd_link_info *, const char *);
 781 extern bfd_boolean bfd_xcoff_record_link_assignment
 782   (bfd *, struct bfd_link_info *, const char *);
 783 extern bfd_boolean bfd_xcoff_size_dynamic_sections
 784   (bfd *, struct bfd_link_info *, const char *, const char *,
 785    unsigned long, unsigned long, unsigned long, bfd_boolean,
 786    int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
 787 extern bfd_boolean bfd_xcoff_link_generate_rtinit
 788   (bfd *, const char *, const char *, bfd_boolean);
 789
 790 /* XCOFF support routines for ar.  */
 791 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
 792   (bfd *, char *);
 793
 794 /* Externally visible COFF routines.  */
 795
 796 #if defined(__STDC__) || defined(ALMOST_STDC)
 797 struct internal_syment;
 798 union internal_auxent;
 799 #endif
 800
 801 extern bfd_boolean bfd_coff_get_syment
 802   (bfd *, struct bfd_symbol *, struct internal_syment *);
 803
 804 extern bfd_boolean bfd_coff_get_auxent
 805   (bfd *, struct bfd_symbol *, int, union internal_auxent *);
 806
 807 extern bfd_boolean bfd_coff_set_symbol_class
 808   (bfd *, struct bfd_symbol *, unsigned int);
 809
 810 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
 811   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
 812
 813 /* ARM VFP11 erratum workaround support.  */
 814 typedef enum
 815 {
 816   BFD_ARM_VFP11_FIX_DEFAULT,
 817   BFD_ARM_VFP11_FIX_NONE,
 818   BFD_ARM_VFP11_FIX_SCALAR,
 819   BFD_ARM_VFP11_FIX_VECTOR
 820 } bfd_arm_vfp11_fix;
 821
 822 extern void bfd_elf32_arm_init_maps
 823   (bfd *);
 824
 825 extern void bfd_elf32_arm_set_vfp11_fix
 826   (bfd *, struct bfd_link_info *);
 827
 828 extern bfd_boolean bfd_elf32_arm_vfp11_erratum_scan
 829   (bfd *, struct bfd_link_info *);
 830
 831 extern void bfd_elf32_arm_vfp11_fix_veneer_locations
 832   (bfd *, struct bfd_link_info *);
 833
 834 /* ARM Interworking support.  Called from linker.  */
 835 extern bfd_boolean bfd_arm_allocate_interworking_sections
 836   (struct bfd_link_info *);
 837
 838 extern bfd_boolean bfd_arm_process_before_allocation
 839   (bfd *, struct bfd_link_info *, int);
 840
 841 extern bfd_boolean bfd_arm_get_bfd_for_interworking
 842   (bfd *, struct bfd_link_info *);
 843
 844 /* PE ARM Interworking support.  Called from linker.  */
 845 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
 846   (struct bfd_link_info *);
 847
 848 extern bfd_boolean bfd_arm_pe_process_before_allocation
 849   (bfd *, struct bfd_link_info *, int);
 850
 851 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
 852   (bfd *, struct bfd_link_info *);
 853
 854 /* ELF ARM Interworking support.  Called from linker.  */
 855 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
 856   (struct bfd_link_info *);
 857
 858 extern bfd_boolean bfd_elf32_arm_process_before_allocation
 859   (bfd *, struct bfd_link_info *);
 860
 861 void bfd_elf32_arm_set_target_relocs
 862   (bfd *, struct bfd_link_info *, int, char *, int, int, bfd_arm_vfp11_fix,
 863    int, int);
 864
 865 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
 866   (bfd *, struct bfd_link_info *);
 867
 868 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
 869   (bfd *, struct bfd_link_info *);
 870
 871 /* ELF ARM mapping symbol support */
 872 #define BFD_ARM_SPECIAL_SYM_TYPE_MAP    (1 << 0)
 873 #define BFD_ARM_SPECIAL_SYM_TYPE_TAG    (1 << 1)
 874 #define BFD_ARM_SPECIAL_SYM_TYPE_OTHER  (1 << 2)
 875 #define BFD_ARM_SPECIAL_SYM_TYPE_ANY    (~0)
 876 extern bfd_boolean bfd_is_arm_special_symbol_name
 877   (const char * name, int type);
 878
 879 extern void bfd_elf32_arm_set_byteswap_code (struct bfd_link_info *, int);
 880
 881 /* ARM Note section processing.  */
 882 extern bfd_boolean bfd_arm_merge_machines
 883   (bfd *, bfd *);
 884
 885 extern bfd_boolean bfd_arm_update_notes
 886   (bfd *, const char *);
 887
 888 extern unsigned int bfd_arm_get_mach_from_notes
 889   (bfd *, const char *);
 890
 891 /* ARM stub generation support.  Called from the linker.  */
 892 extern int elf32_arm_setup_section_lists
 893   (bfd *, struct bfd_link_info *);
 894 extern void elf32_arm_next_input_section
 895   (struct bfd_link_info *, struct bfd_section *);
 896 extern bfd_boolean elf32_arm_size_stubs
 897   (bfd *, bfd *, struct bfd_link_info *, bfd_signed_vma,
 898    struct bfd_section * (*) (const char *, struct bfd_section *), void (*) (void));
 899 extern bfd_boolean elf32_arm_build_stubs
 900   (struct bfd_link_info *);
 901
 902 /* TI COFF load page support.  */
 903 extern void bfd_ticoff_set_section_load_page
 904   (struct bfd_section *, int);
 905
 906 extern int bfd_ticoff_get_section_load_page
 907   (struct bfd_section *);
 908
 909 /* H8/300 functions.  */
 910 extern bfd_vma bfd_h8300_pad_address
 911   (bfd *, bfd_vma);
 912
 913 /* IA64 Itanium code generation.  Called from linker.  */
 914 extern void bfd_elf32_ia64_after_parse
 915   (int);
 916
 917 extern void bfd_elf64_ia64_after_parse
 918   (int);
 919
 920 /* This structure is used for a comdat section, as in PE.  A comdat
 921    section is associated with a particular symbol.  When the linker
 922    sees a comdat section, it keeps only one of the sections with a
 923    given name and associated with a given symbol.  */
 924
 925 struct coff_comdat_info
 926 {
 927   /* The name of the symbol associated with a comdat section.  */
 928   const char *name;
 929
 930   /* The local symbol table index of the symbol associated with a
 931      comdat section.  This is only meaningful to the object file format
 932      specific code; it is not an index into the list returned by
 933      bfd_canonicalize_symtab.  */
 934   long symbol;
 935 };
 936
 937 extern struct coff_comdat_info *bfd_coff_get_comdat_section
 938   (bfd *, struct bfd_section *);
 939