bfd/bfd-in.h

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