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