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