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    2012 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 #ifndef PACKAGE
  29 #error config.h must be included before this header
  30 #endif
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include "ansidecl.h"
  37 #include "symcat.h"
  38 #include <sys/stat.h>
  39
  40 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  41 #ifndef SABER
  42 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
  43    The problem is, "32_" is not a valid preprocessing token, and we don't
  44    want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will
  45    cause the inner CONCAT2 macros to be evaluated first, producing
  46    still-valid pp-tokens.  Then the final concatenation can be done.  */
  47 #undef CONCAT4
  48 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  49 #endif
  50 #endif
  51
  52 /* This is a utility macro to handle the situation where the code
  53    wants to place a constant string into the code, followed by a
  54    comma and then the length of the string.  Doing this by hand
  55    is error prone, so using this macro is safer.  */
  56 #define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)
  57 /* Unfortunately it is not possible to use the STRING_COMMA_LEN macro
  58    to create the arguments to another macro, since the preprocessor
  59    will mis-count the number of arguments to the outer macro (by not
  60    evaluating STRING_COMMA_LEN and so missing the comma).  This is a
  61    problem for example when trying to use STRING_COMMA_LEN to build
  62    the arguments to the strncmp() macro.  Hence this alternative
  63    definition of strncmp is provided here.
  64
  65    Note - these macros do NOT work if STR2 is not a constant string.  */
  66 #define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)
  67   /* strcpy() can have a similar problem, but since we know we are
  68      copying a constant string, we can use memcpy which will be faster
  69      since there is no need to check for a NUL byte inside STR.  We
  70      can also save time if we do not need to copy the terminating NUL.  */
  71 #define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)
  72 #define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))
  73
  74
  75 #define BFD_SUPPORTS_PLUGINS @supports_plugins@
  76
  77 /* The word size used by BFD on the host.  This may be 64 with a 32
  78    bit target if the host is 64 bit, or if other 64 bit targets have
  79    been selected with --enable-targets, or if --enable-64-bit-bfd.  */
  80 #define BFD_ARCH_SIZE @wordsize@
  81
  82 /* The word size of the default bfd target.  */
  83 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  84
  85 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  86 #define BFD_HOST_64BIT_LONG_LONG @BFD_HOST_64BIT_LONG_LONG@
  87 #if @BFD_HOST_64_BIT_DEFINED@
  88 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  89 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  90 typedef BFD_HOST_64_BIT bfd_int64_t;
  91 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
  92 #endif
  93
  94 #if BFD_ARCH_SIZE >= 64
  95 #define BFD64
  96 #endif
  97
  98 #ifndef INLINE
  99 #if __GNUC__ >= 2
 100 #define INLINE __inline__
 101 #else
 102 #define INLINE
 103 #endif
 104 #endif
 105
 106 /* Declaring a type wide enough to hold a host long and a host pointer.  */
 107 #define BFD_HOSTPTR_T   @BFD_HOSTPTR_T@
 108 typedef BFD_HOSTPTR_T bfd_hostptr_t;
 109
 110 /* Forward declaration.  */
 111 typedef struct bfd bfd;
 112
 113 /* Boolean type used in bfd.  Too many systems define their own
 114    versions of "boolean" for us to safely typedef a "boolean" of
 115    our own.  Using an enum for "bfd_boolean" has its own set of
 116    problems, with strange looking casts required to avoid warnings
 117    on some older compilers.  Thus we just use an int.
 118
 119    General rule: Functions which are bfd_boolean return TRUE on
 120    success and FALSE on failure (unless they're a predicate).  */
 121
 122 typedef int bfd_boolean;
 123 #undef FALSE
 124 #undef TRUE
 125 #define FALSE 0
 126 #define TRUE 1
 127
 128 #ifdef BFD64
 129
 130 #ifndef BFD_HOST_64_BIT
 131  #error No 64 bit integer type available
 132 #endif /* ! defined (BFD_HOST_64_BIT) */
 133
 134 typedef BFD_HOST_U_64_BIT bfd_vma;
 135 typedef BFD_HOST_64_BIT bfd_signed_vma;
 136 typedef BFD_HOST_U_64_BIT bfd_size_type;
 137 typedef BFD_HOST_U_64_BIT symvalue;
 138
 139 #if BFD_HOST_64BIT_LONG
 140 #define BFD_VMA_FMT "l"
 141 #elif defined (__MSVCRT__)
 142 #define BFD_VMA_FMT "I64"
 143 #else
 144 #define BFD_VMA_FMT "ll"
 145 #endif
 146
 147 #ifndef fprintf_vma
 148 #define sprintf_vma(s,x) sprintf (s, "%016" BFD_VMA_FMT "x", x)
 149 #define fprintf_vma(f,x) fprintf (f, "%016" BFD_VMA_FMT "x", x)
 150 #endif
 151
 152 #else /* not BFD64  */
 153
 154 /* Represent a target address.  Also used as a generic unsigned type
 155    which is guaranteed to be big enough to hold any arithmetic types
 156    we need to deal with.  */
 157 typedef unsigned long bfd_vma;
 158
 159 /* A generic signed type which is guaranteed to be big enough to hold any
 160    arithmetic types we need to deal with.  Can be assumed to be compatible
 161    with bfd_vma in the same way that signed and unsigned ints are compatible
 162    (as parameters, in assignment, etc).  */
 163 typedef long bfd_signed_vma;
 164
 165 typedef unsigned long symvalue;
 166 typedef unsigned long bfd_size_type;
 167
 168 /* Print a bfd_vma x on stream s.  */
 169 #define BFD_VMA_FMT "l"
 170 #define fprintf_vma(s,x) fprintf (s, "%08" BFD_VMA_FMT "x", x)
 171 #define sprintf_vma(s,x) sprintf (s, "%08" BFD_VMA_FMT "x", 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) ((void) bfd, (ptr)->name)
 281 #define bfd_get_section_vma(bfd, ptr) ((void) bfd, (ptr)->vma)
 282 #define bfd_get_section_lma(bfd, ptr) ((void) bfd, (ptr)->lma)
 283 #define bfd_get_section_alignment(bfd, ptr) ((void) bfd, \
 284                                              (ptr)->alignment_power)
 285 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 286 #define bfd_section_size(bfd, ptr) ((ptr)->size)
 287 #define bfd_get_section_size(ptr) ((ptr)->size)
 288 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 289 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 290 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 291 #define bfd_get_section_flags(bfd, ptr) ((void) bfd, (ptr)->flags)
 292 #define bfd_get_section_userdata(bfd, ptr) ((void) bfd, (ptr)->userdata)
 293
 294 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 295
 296 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
 297 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
 298 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
 299 /* Find the address one past the end of SEC.  */
 300 #define bfd_get_section_limit(bfd, sec) \
 301   (((bfd)->direction != write_direction && (sec)->rawsize != 0  \
 302     ? (sec)->rawsize : (sec)->size) / bfd_octets_per_byte (bfd))
 303
 304 /* Return TRUE if input section SEC has been discarded.  */
 305 #define discarded_section(sec)                          \
 306   (!bfd_is_abs_section (sec)                                    \
 307    && bfd_is_abs_section ((sec)->output_section)                \
 308    && (sec)->sec_info_type != SEC_INFO_TYPE_MERGE               \
 309    && (sec)->sec_info_type != SEC_INFO_TYPE_JUST_SYMS)
 310 \f
 311 typedef enum bfd_print_symbol
 312 {
 313   bfd_print_symbol_name,
 314   bfd_print_symbol_more,
 315   bfd_print_symbol_all
 316 } bfd_print_symbol_type;
 317
 318 /* Information about a symbol that nm needs.  */
 319
 320 typedef struct _symbol_info
 321 {
 322   symvalue value;
 323   char type;
 324   const char *name;            /* Symbol name.  */
 325   unsigned char stab_type;     /* Stab type.  */
 326   char stab_other;             /* Stab other.  */
 327   short stab_desc;             /* Stab desc.  */
 328   const char *stab_name;       /* String for stab type.  */
 329 } symbol_info;
 330
 331 /* Get the name of a stabs type code.  */
 332
 333 extern const char *bfd_get_stab_name (int);
 334 \f
 335 /* Hash table routines.  There is no way to free up a hash table.  */
 336
 337 /* An element in the hash table.  Most uses will actually use a larger
 338    structure, and an instance of this will be the first field.  */
 339
 340 struct bfd_hash_entry
 341 {
 342   /* Next entry for this hash code.  */
 343   struct bfd_hash_entry *next;
 344   /* String being hashed.  */
 345   const char *string;
 346   /* Hash code.  This is the full hash code, not the index into the
 347      table.  */
 348   unsigned long hash;
 349 };
 350
 351 /* A hash table.  */
 352
 353 struct bfd_hash_table
 354 {
 355   /* The hash array.  */
 356   struct bfd_hash_entry **table;
 357   /* A function used to create new elements in the hash table.  The
 358      first entry is itself a pointer to an element.  When this
 359      function is first invoked, this pointer will be NULL.  However,
 360      having the pointer permits a hierarchy of method functions to be
 361      built each of which calls the function in the superclass.  Thus
 362      each function should be written to allocate a new block of memory
 363      only if the argument is NULL.  */
 364   struct bfd_hash_entry *(*newfunc)
 365     (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 366    /* An objalloc for this hash table.  This is a struct objalloc *,
 367      but we use void * to avoid requiring the inclusion of objalloc.h.  */
 368   void *memory;
 369   /* The number of slots in the hash table.  */
 370   unsigned int size;
 371   /* The number of entries in the hash table.  */
 372   unsigned int count;
 373   /* The size of elements.  */
 374   unsigned int entsize;
 375   /* If non-zero, don't grow the hash table.  */
 376   unsigned int frozen:1;
 377 };
 378
 379 /* Initialize a hash table.  */
 380 extern bfd_boolean bfd_hash_table_init
 381   (struct bfd_hash_table *,
 382    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 383                                struct bfd_hash_table *,
 384                                const char *),
 385    unsigned int);
 386
 387 /* Initialize a hash table specifying a size.  */
 388 extern bfd_boolean bfd_hash_table_init_n
 389   (struct bfd_hash_table *,
 390    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 391                                struct bfd_hash_table *,
 392                                const char *),
 393    unsigned int, unsigned int);
 394
 395 /* Free up a hash table.  */
 396 extern void bfd_hash_table_free
 397   (struct bfd_hash_table *);
 398
 399 /* Look up a string in a hash table.  If CREATE is TRUE, a new entry
 400    will be created for this string if one does not already exist.  The
 401    COPY argument must be TRUE if this routine should copy the string
 402    into newly allocated memory when adding an entry.  */
 403 extern struct bfd_hash_entry *bfd_hash_lookup
 404   (struct bfd_hash_table *, const char *, bfd_boolean create,
 405    bfd_boolean copy);
 406
 407 /* Insert an entry in a hash table.  */
 408 extern struct bfd_hash_entry *bfd_hash_insert
 409   (struct bfd_hash_table *, const char *, unsigned long);
 410
 411 /* Rename an entry in a hash table.  */
 412 extern void bfd_hash_rename
 413   (struct bfd_hash_table *, const char *, struct bfd_hash_entry *);
 414
 415 /* Replace an entry in a hash table.  */
 416 extern void bfd_hash_replace
 417   (struct bfd_hash_table *, struct bfd_hash_entry *old,
 418    struct bfd_hash_entry *nw);
 419
 420 /* Base method for creating a hash table entry.  */
 421 extern struct bfd_hash_entry *bfd_hash_newfunc
 422   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 423
 424 /* Grab some space for a hash table entry.  */
 425 extern void *bfd_hash_allocate
 426   (struct bfd_hash_table *, unsigned int);
 427
 428 /* Traverse a hash table in a random order, calling a function on each
 429    element.  If the function returns FALSE, the traversal stops.  The
 430    INFO argument is passed to the function.  */
 431 extern void bfd_hash_traverse
 432   (struct bfd_hash_table *,
 433    bfd_boolean (*) (struct bfd_hash_entry *, void *),
 434    void *info);
 435
 436 /* Allows the default size of a hash table to be configured. New hash
 437    tables allocated using bfd_hash_table_init will be created with
 438    this size.  */
 439 extern unsigned long bfd_hash_set_default_size (unsigned long);
 440
 441 /* This structure is used to keep track of stabs in sections
 442    information while linking.  */
 443
 444 struct stab_info
 445 {
 446   /* A hash table used to hold stabs strings.  */
 447   struct bfd_strtab_hash *strings;
 448   /* The header file hash table.  */
 449   struct bfd_hash_table includes;
 450   /* The first .stabstr section.  */
 451   struct bfd_section *stabstr;
 452 };
 453
 454 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
 455
 456 /* User program access to BFD facilities.  */
 457
 458 /* Direct I/O routines, for programs which know more about the object
 459    file than BFD does.  Use higher level routines if possible.  */
 460
 461 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
 462 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
 463 extern int bfd_seek (bfd *, file_ptr, int);
 464 extern file_ptr bfd_tell (bfd *);
 465 extern int bfd_flush (bfd *);
 466 extern int bfd_stat (bfd *, struct stat *);
 467
 468 /* Deprecated old routines.  */
 469 #if __GNUC__
 470 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 471   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 472    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 473 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 474   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 475    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 476 #else
 477 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 478   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 479    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 480 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 481   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 482    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 483 #endif
 484 extern void warn_deprecated (const char *, const char *, int, const char *);
 485
 486 /* Cast from const char * to char * so that caller can assign to
 487    a char * without a warning.  */
 488 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 489 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 490 #define bfd_get_format(abfd) ((abfd)->format)
 491 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 492 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 493 #define bfd_family_coff(abfd) \
 494   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
 495    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
 496 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 497 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 498 #define bfd_header_big_endian(abfd) \
 499   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 500 #define bfd_header_little_endian(abfd) \
 501   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 502 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 503 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 504 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 505 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 506 #define bfd_has_map(abfd) ((abfd)->has_armap)
 507 #define bfd_is_thin_archive(abfd) ((abfd)->is_thin_archive)
 508
 509 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 510 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 511
 512 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 513 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 514 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 515 #define bfd_count_sections(abfd) ((abfd)->section_count)
 516
 517 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
 518
 519 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 520
 521 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
 522
 523 extern bfd_boolean bfd_cache_close
 524   (bfd *abfd);
 525 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 526
 527 extern bfd_boolean bfd_cache_close_all (void);
 528
 529 extern bfd_boolean bfd_record_phdr
 530   (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
 531    bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
 532
 533 /* Byte swapping routines.  */
 534
 535 bfd_uint64_t bfd_getb64 (const void *);
 536 bfd_uint64_t bfd_getl64 (const void *);
 537 bfd_int64_t bfd_getb_signed_64 (const void *);
 538 bfd_int64_t bfd_getl_signed_64 (const void *);
 539 bfd_vma bfd_getb32 (const void *);
 540 bfd_vma bfd_getl32 (const void *);
 541 bfd_signed_vma bfd_getb_signed_32 (const void *);
 542 bfd_signed_vma bfd_getl_signed_32 (const void *);
 543 bfd_vma bfd_getb16 (const void *);
 544 bfd_vma bfd_getl16 (const void *);
 545 bfd_signed_vma bfd_getb_signed_16 (const void *);
 546 bfd_signed_vma bfd_getl_signed_16 (const void *);
 547 void bfd_putb64 (bfd_uint64_t, void *);
 548 void bfd_putl64 (bfd_uint64_t, void *);
 549 void bfd_putb32 (bfd_vma, void *);
 550 void bfd_putl32 (bfd_vma, void *);
 551 void bfd_putb16 (bfd_vma, void *);
 552 void bfd_putl16 (bfd_vma, void *);
 553
 554 /* Byte swapping routines which take size and endiannes as arguments.  */
 555
 556 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
 557 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
 558
 559 #if defined(__STDC__) || defined(ALMOST_STDC)
 560 struct ecoff_debug_info;
 561 struct ecoff_debug_swap;
 562 struct ecoff_extr;
 563 struct bfd_symbol;
 564 struct bfd_link_info;
 565 struct bfd_link_hash_entry;
 566 struct bfd_section_already_linked;
 567 struct bfd_elf_version_tree;
 568 #endif
 569
 570 extern bfd_boolean bfd_section_already_linked_table_init (void);
 571 extern void bfd_section_already_linked_table_free (void);
 572 extern bfd_boolean _bfd_handle_already_linked
 573   (struct bfd_section *, struct bfd_section_already_linked *,
 574    struct bfd_link_info *);
 575 \f
 576 /* Externally visible ECOFF routines.  */
 577
 578 extern bfd_vma bfd_ecoff_get_gp_value
 579   (bfd * abfd);
 580 extern bfd_boolean bfd_ecoff_set_gp_value
 581   (bfd *abfd, bfd_vma gp_value);
 582 extern bfd_boolean bfd_ecoff_set_regmasks
 583   (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 584    unsigned long *cprmask);
 585 extern void *bfd_ecoff_debug_init
 586   (bfd *output_bfd, struct ecoff_debug_info *output_debug,
 587    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 588 extern void bfd_ecoff_debug_free
 589   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 590    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 591 extern bfd_boolean bfd_ecoff_debug_accumulate
 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 ecoff_debug_info *input_debug,
 595    const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
 596 extern bfd_boolean bfd_ecoff_debug_accumulate_other
 597   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 598    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 599    struct bfd_link_info *);
 600 extern bfd_boolean bfd_ecoff_debug_externals
 601   (bfd *abfd, struct ecoff_debug_info *debug,
 602    const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
 603    bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
 604    void (*set_index) (struct bfd_symbol *, bfd_size_type));
 605 extern bfd_boolean bfd_ecoff_debug_one_external
 606   (bfd *abfd, struct ecoff_debug_info *debug,
 607    const struct ecoff_debug_swap *swap, const char *name,
 608    struct ecoff_extr *esym);
 609 extern bfd_size_type bfd_ecoff_debug_size
 610   (bfd *abfd, struct ecoff_debug_info *debug,
 611    const struct ecoff_debug_swap *swap);
 612 extern bfd_boolean bfd_ecoff_write_debug
 613   (bfd *abfd, struct ecoff_debug_info *debug,
 614    const struct ecoff_debug_swap *swap, file_ptr where);
 615 extern bfd_boolean bfd_ecoff_write_accumulated_debug
 616   (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
 617    const struct ecoff_debug_swap *swap,
 618    struct bfd_link_info *info, file_ptr where);
 619
 620 /* Externally visible ELF routines.  */
 621
 622 struct bfd_link_needed_list
 623 {
 624   struct bfd_link_needed_list *next;
 625   bfd *by;
 626   const char *name;
 627 };
 628
 629 enum dynamic_lib_link_class {
 630   DYN_NORMAL = 0,
 631   DYN_AS_NEEDED = 1,
 632   DYN_DT_NEEDED = 2,
 633   DYN_NO_ADD_NEEDED = 4,
 634   DYN_NO_NEEDED = 8
 635 };
 636
 637 enum notice_asneeded_action {
 638   notice_as_needed,
 639   notice_not_needed,
 640   notice_needed
 641 };
 642
 643 extern bfd_boolean bfd_elf_record_link_assignment
 644   (bfd *, struct bfd_link_info *, const char *, bfd_boolean,
 645    bfd_boolean);
 646 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 647   (bfd *, struct bfd_link_info *);
 648 extern bfd_boolean bfd_elf_get_bfd_needed_list
 649   (bfd *, struct bfd_link_needed_list **);
 650 extern bfd_boolean bfd_elf_size_dynamic_sections
 651   (bfd *, const char *, const char *, const char *, const char *, const char *,
 652    const char * const *, struct bfd_link_info *, struct bfd_section **);
 653 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
 654   (bfd *, struct bfd_link_info *);
 655 extern void bfd_elf_set_dt_needed_name
 656   (bfd *, const char *);
 657 extern const char *bfd_elf_get_dt_soname
 658   (bfd *);
 659 extern void bfd_elf_set_dyn_lib_class
 660   (bfd *, enum dynamic_lib_link_class);
 661 extern int bfd_elf_get_dyn_lib_class
 662   (bfd *);
 663 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 664   (bfd *, struct bfd_link_info *);
 665 extern bfd_boolean bfd_elf_discard_info
 666   (bfd *, struct bfd_link_info *);
 667 extern unsigned int _bfd_elf_default_action_discarded
 668   (struct bfd_section *);
 669
 670 /* Return an upper bound on the number of bytes required to store a
 671    copy of ABFD's program header table entries.  Return -1 if an error
 672    occurs; bfd_get_error will return an appropriate code.  */
 673 extern long bfd_get_elf_phdr_upper_bound
 674   (bfd *abfd);
 675
 676 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 677    will be stored as an array of Elf_Internal_Phdr structures, as
 678    defined in include/elf/internal.h.  To find out how large the
 679    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 680
 681    Return the number of program header table entries read, or -1 if an
 682    error occurs; bfd_get_error will return an appropriate code.  */
 683 extern int bfd_get_elf_phdrs
 684   (bfd *abfd, void *phdrs);
 685
 686 /* Create a new BFD as if by bfd_openr.  Rather than opening a file,
 687    reconstruct an ELF file by reading the segments out of remote memory
 688    based on the ELF file header at EHDR_VMA and the ELF program headers it
 689    points to.  If not null, *LOADBASEP is filled in with the difference
 690    between the VMAs from which the segments were read, and the VMAs the
 691    file headers (and hence BFD's idea of each section's VMA) put them at.
 692
 693    The function TARGET_READ_MEMORY is called to copy LEN bytes from the
 694    remote memory at target address VMA into the local buffer at MYADDR; it
 695    should return zero on success or an `errno' code on failure.  TEMPL must
 696    be a BFD for an ELF target with the word size and byte order found in
 697    the remote memory.  */
 698 extern bfd *bfd_elf_bfd_from_remote_memory
 699   (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
 700    int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
 701
 702 extern struct bfd_section *_bfd_elf_tls_setup
 703   (bfd *, struct bfd_link_info *);
 704
 705 extern struct bfd_section *
 706 _bfd_nearby_section (bfd *, struct bfd_section *, bfd_vma);
 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