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