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