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