bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001
   4    Free Software Foundation, Inc.
   5    Contributed by Cygnus Support.
   6
   7 This file is part of BFD, the Binary File Descriptor library.
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef __BFD_H_SEEN__
  24 #define __BFD_H_SEEN__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #include "ansidecl.h"
  31 #include "symcat.h"
  32 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  33 #ifndef SABER
  34 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
  35    The problem is, "32_" is not a valid preprocessing token, and we don't
  36    want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will
  37    cause the inner CONCAT2 macros to be evaluated first, producing
  38    still-valid pp-tokens.  Then the final concatenation can be done.  */
  39 #undef CONCAT4
  40 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  41 #endif
  42 #endif
  43
  44 #define BFD_VERSION @bfd_version@
  45 #define BFD_VERSION_DATE @bfd_version_date@
  46 #define BFD_VERSION_STRING @bfd_version_string@
  47
  48 /* The word size used by BFD on the host.  This may be 64 with a 32
  49    bit target if the host is 64 bit, or if other 64 bit targets have
  50    been selected with --enable-targets, or if --enable-64-bit-bfd.  */
  51 #define BFD_ARCH_SIZE @wordsize@
  52
  53 /* The word size of the default bfd target.  */
  54 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  55
  56 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  57 #if @BFD_HOST_64_BIT_DEFINED@
  58 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  59 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  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 /* To squelch erroneous compiler warnings ("illegal pointer
  78    combination") from the SVR3 compiler, we would like to typedef
  79    boolean to int (it doesn't like functions which return boolean.
  80    Making sure they are never implicitly declared to return int
  81    doesn't seem to help).  But this file is not configured based on
  82    the host.  */
  83 /* General rules: functions which are boolean return true on success
  84    and false on failure (unless they're a predicate).   -- bfd.doc */
  85 /* I'm sure this is going to break something and someone is going to
  86    force me to change it.  */
  87 /* typedef enum boolean {false, true} boolean; */
  88 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  89 /* It gets worse if the host also defines a true/false enum... -sts */
  90 /* And even worse if your compiler has built-in boolean types... -law */
  91 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
  92 #define TRUE_FALSE_ALREADY_DEFINED
  93 #endif
  94 #ifdef MPW
  95 /* Pre-emptive strike - get the file with the enum.  */
  96 #include <Types.h>
  97 #define TRUE_FALSE_ALREADY_DEFINED
  98 #endif /* MPW */
  99 #ifndef TRUE_FALSE_ALREADY_DEFINED
 100 typedef enum bfd_boolean {false, true} boolean;
 101 #define BFD_TRUE_FALSE
 102 #else
 103 /* Use enum names that will appear nowhere else.  */
 104 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
 105 #endif
 106
 107 /* Support for different sizes of target format ints and addresses.
 108    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
 109    set to 1 above.  Otherwise, if gcc is being used, this code will
 110    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
 111    defined above.  */
 112
 113 #ifndef BFD_HOST_64_BIT
 114 # if BFD_HOST_64BIT_LONG
 115 #  define BFD_HOST_64_BIT long
 116 #  define BFD_HOST_U_64_BIT unsigned long
 117 # else
 118 #  ifdef __GNUC__
 119 #   if __GNUC__ >= 2
 120 #    define BFD_HOST_64_BIT long long
 121 #    define BFD_HOST_U_64_BIT unsigned long long
 122 #   endif /* __GNUC__ >= 2 */
 123 #  endif /* ! defined (__GNUC__) */
 124 # endif /* ! BFD_HOST_64BIT_LONG */
 125 #endif /* ! defined (BFD_HOST_64_BIT) */
 126
 127 #ifdef BFD64
 128
 129 #ifndef BFD_HOST_64_BIT
 130  #error No 64 bit integer type available
 131 #endif /* ! defined (BFD_HOST_64_BIT) */
 132
 133 typedef BFD_HOST_U_64_BIT bfd_vma;
 134 typedef BFD_HOST_64_BIT bfd_signed_vma;
 135 typedef BFD_HOST_U_64_BIT bfd_size_type;
 136 typedef BFD_HOST_U_64_BIT symvalue;
 137
 138 #ifndef fprintf_vma
 139 #if BFD_HOST_64BIT_LONG
 140 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 141 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 142 #else
 143 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 144 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 145 #define fprintf_vma(s,x) \
 146   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 147 #define sprintf_vma(s,x) \
 148   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 149 #endif
 150 #endif
 151
 152 #else /* not BFD64  */
 153
 154 /* Represent a target address.  Also used as a generic unsigned type
 155    which is guaranteed to be big enough to hold any arithmetic types
 156    we need to deal with.  */
 157 typedef unsigned long bfd_vma;
 158
 159 /* A generic signed type which is guaranteed to be big enough to hold any
 160    arithmetic types we need to deal with.  Can be assumed to be compatible
 161    with bfd_vma in the same way that signed and unsigned ints are compatible
 162    (as parameters, in assignment, etc).  */
 163 typedef long bfd_signed_vma;
 164
 165 typedef unsigned long symvalue;
 166 typedef unsigned long bfd_size_type;
 167
 168 /* Print a bfd_vma x on stream s.  */
 169 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
 170 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
 171
 172 #endif /* not BFD64  */
 173
 174 /* A pointer to a position in a file.  */
 175 /* FIXME:  This should be using off_t from <sys/types.h>.
 176    For now, try to avoid breaking stuff by not including <sys/types.h> here.
 177    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
 178    Probably the best long-term answer is to avoid using file_ptr AND off_t
 179    in this header file, and to handle this in the BFD implementation
 180    rather than in its interface.  */
 181 /* typedef off_t        file_ptr; */
 182 typedef bfd_signed_vma file_ptr;
 183 typedef bfd_vma ufile_ptr;
 184
 185 extern void bfd_sprintf_vma PARAMS ((bfd *, char *, bfd_vma));
 186 extern void bfd_fprintf_vma PARAMS ((bfd *, PTR, bfd_vma));
 187
 188 #define printf_vma(x) fprintf_vma(stdout,x)
 189 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 190
 191 typedef unsigned int flagword;  /* 32 bits of flags */
 192 typedef unsigned char bfd_byte;
 193 \f
 194 /** File formats */
 195
 196 typedef enum bfd_format {
 197               bfd_unknown = 0,  /* file format is unknown */
 198               bfd_object,       /* linker/assember/compiler output */
 199               bfd_archive,      /* object archive file */
 200               bfd_core,         /* core dump */
 201               bfd_type_end}     /* marks the end; don't use it! */
 202          bfd_format;
 203
 204 /* Values that may appear in the flags field of a BFD.  These also
 205    appear in the object_flags field of the bfd_target structure, where
 206    they indicate the set of flags used by that backend (not all flags
 207    are meaningful for all object file formats) (FIXME: at the moment,
 208    the object_flags values have mostly just been copied from backend
 209    to another, and are not necessarily correct).  */
 210
 211 /* No flags.  */
 212 #define BFD_NO_FLAGS    0x00
 213
 214 /* BFD contains relocation entries.  */
 215 #define HAS_RELOC       0x01
 216
 217 /* BFD is directly executable.  */
 218 #define EXEC_P          0x02
 219
 220 /* BFD has line number information (basically used for F_LNNO in a
 221    COFF header).  */
 222 #define HAS_LINENO      0x04
 223
 224 /* BFD has debugging information.  */
 225 #define HAS_DEBUG       0x08
 226
 227 /* BFD has symbols.  */
 228 #define HAS_SYMS        0x10
 229
 230 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 231    header).  */
 232 #define HAS_LOCALS      0x20
 233
 234 /* BFD is a dynamic object.  */
 235 #define DYNAMIC         0x40
 236
 237 /* Text section is write protected (if D_PAGED is not set, this is
 238    like an a.out NMAGIC file) (the linker sets this by default, but
 239    clears it for -r or -N).  */
 240 #define WP_TEXT         0x80
 241
 242 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 243    linker sets this by default, but clears it for -r or -n or -N).  */
 244 #define D_PAGED         0x100
 245
 246 /* BFD is relaxable (this means that bfd_relax_section may be able to
 247    do something) (sometimes bfd_relax_section can do something even if
 248    this is not set).  */
 249 #define BFD_IS_RELAXABLE 0x200
 250
 251 /* This may be set before writing out a BFD to request using a
 252    traditional format.  For example, this is used to request that when
 253    writing out an a.out object the symbols not be hashed to eliminate
 254    duplicates.  */
 255 #define BFD_TRADITIONAL_FORMAT 0x400
 256
 257 /* This flag indicates that the BFD contents are actually cached in
 258    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
 259 #define BFD_IN_MEMORY 0x800
 260 \f
 261 /* symbols and relocation */
 262
 263 /* A count of carsyms (canonical archive symbols).  */
 264 typedef unsigned long symindex;
 265
 266 /* How to perform a relocation.  */
 267 typedef const struct reloc_howto_struct reloc_howto_type;
 268
 269 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 270
 271 /* General purpose part of a symbol X;
 272    target specific parts are in libcoff.h, libaout.h, etc.  */
 273
 274 #define bfd_get_section(x) ((x)->section)
 275 #define bfd_get_output_section(x) ((x)->section->output_section)
 276 #define bfd_set_section(x,y) ((x)->section) = (y)
 277 #define bfd_asymbol_base(x) ((x)->section->vma)
 278 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 279 #define bfd_asymbol_name(x) ((x)->name)
 280 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 281 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 282 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 283
 284 /* A canonical archive symbol.  */
 285 /* This is a type pun with struct ranlib on purpose! */
 286 typedef struct carsym {
 287   char *name;
 288   file_ptr file_offset;         /* look here to find the file */
 289 } carsym;                       /* to make these you call a carsymogen */
 290
 291 /* Used in generating armaps (archive tables of contents).
 292    Perhaps just a forward definition would do? */
 293 struct orl {                    /* output ranlib */
 294   char **name;                  /* symbol name */
 295   union {
 296     file_ptr pos;
 297     bfd *abfd;
 298   } u;                          /* bfd* or file position */
 299   int namidx;                   /* index into string table */
 300 };
 301 \f
 302 /* Linenumber stuff */
 303 typedef struct lineno_cache_entry {
 304   unsigned int line_number;     /* Linenumber from start of function*/
 305   union {
 306     struct symbol_cache_entry *sym; /* Function name */
 307     bfd_vma offset;         /* Offset into section */
 308   } u;
 309 } alent;
 310 \f
 311 /* object and core file sections */
 312
 313 #define align_power(addr, align)        \
 314         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 315
 316 typedef struct sec *sec_ptr;
 317
 318 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 319 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 320 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 321 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 322 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 323 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 324 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 325 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 326 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 327 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 328
 329 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 330
 331 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
 332 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 333 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 334
 335 typedef struct stat stat_type;
 336 \f
 337 typedef enum bfd_print_symbol
 338 {
 339   bfd_print_symbol_name,
 340   bfd_print_symbol_more,
 341   bfd_print_symbol_all
 342 } bfd_print_symbol_type;
 343
 344 /* Information about a symbol that nm needs.  */
 345
 346 typedef struct _symbol_info
 347 {
 348   symvalue value;
 349   char type;
 350   const char *name;            /* Symbol name.  */
 351   unsigned char stab_type;     /* Stab type.  */
 352   char stab_other;             /* Stab other.  */
 353   short stab_desc;             /* Stab desc.  */
 354   const char *stab_name;       /* String for stab type.  */
 355 } symbol_info;
 356
 357 /* Get the name of a stabs type code.  */
 358
 359 extern const char *bfd_get_stab_name PARAMS ((int));
 360 \f
 361 /* Hash table routines.  There is no way to free up a hash table.  */
 362
 363 /* An element in the hash table.  Most uses will actually use a larger
 364    structure, and an instance of this will be the first field.  */
 365
 366 struct bfd_hash_entry
 367 {
 368   /* Next entry for this hash code.  */
 369   struct bfd_hash_entry *next;
 370   /* String being hashed.  */
 371   const char *string;
 372   /* Hash code.  This is the full hash code, not the index into the
 373      table.  */
 374   unsigned long hash;
 375 };
 376
 377 /* A hash table.  */
 378
 379 struct bfd_hash_table
 380 {
 381   /* The hash array.  */
 382   struct bfd_hash_entry **table;
 383   /* The number of slots in the hash table.  */
 384   unsigned int size;
 385   /* A function used to create new elements in the hash table.  The
 386      first entry is itself a pointer to an element.  When this
 387      function is first invoked, this pointer will be NULL.  However,
 388      having the pointer permits a hierarchy of method functions to be
 389      built each of which calls the function in the superclass.  Thus
 390      each function should be written to allocate a new block of memory
 391      only if the argument is NULL.  */
 392   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
 393                                              struct bfd_hash_table *,
 394                                              const char *));
 395    /* An objalloc for this hash table.  This is a struct objalloc *,
 396      but we use PTR to avoid requiring the inclusion of objalloc.h.  */
 397   PTR memory;
 398 };
 399
 400 /* Initialize a hash table.  */
 401 extern boolean bfd_hash_table_init
 402   PARAMS ((struct bfd_hash_table *,
 403            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 404                                        struct bfd_hash_table *,
 405                                        const char *)));
 406
 407 /* Initialize a hash table specifying a size.  */
 408 extern boolean bfd_hash_table_init_n
 409   PARAMS ((struct bfd_hash_table *,
 410            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 411                                        struct bfd_hash_table *,
 412                                        const char *),
 413            unsigned int size));
 414
 415 /* Free up a hash table.  */
 416 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
 417
 418 /* Look up a string in a hash table.  If CREATE is true, a new entry
 419    will be created for this string if one does not already exist.  The
 420    COPY argument must be true if this routine should copy the string
 421    into newly allocated memory when adding an entry.  */
 422 extern struct bfd_hash_entry *bfd_hash_lookup
 423   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
 424            boolean copy));
 425
 426 /* Replace an entry in a hash table.  */
 427 extern void bfd_hash_replace
 428   PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
 429            struct bfd_hash_entry *nw));
 430
 431 /* Base method for creating a hash table entry.  */
 432 extern struct bfd_hash_entry *bfd_hash_newfunc
 433   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
 434            const char *));
 435
 436 /* Grab some space for a hash table entry.  */
 437 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
 438                                       unsigned int));
 439
 440 /* Traverse a hash table in a random order, calling a function on each
 441    element.  If the function returns false, the traversal stops.  The
 442    INFO argument is passed to the function.  */
 443 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
 444                                        boolean (*) (struct bfd_hash_entry *,
 445                                                     PTR),
 446                                        PTR info));
 447
 448 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 449
 450 /* User program access to BFD facilities */
 451
 452 /* Direct I/O routines, for programs which know more about the object
 453    file than BFD does.  Use higher level routines if possible.  */
 454
 455 extern bfd_size_type bfd_bread PARAMS ((PTR, bfd_size_type, bfd *));
 456 extern bfd_size_type bfd_bwrite PARAMS ((const PTR, bfd_size_type, bfd *));
 457 extern int bfd_seek PARAMS ((bfd *, file_ptr, int));
 458 extern ufile_ptr bfd_tell PARAMS ((bfd *));
 459 extern int bfd_flush PARAMS ((bfd *));
 460 extern int bfd_stat PARAMS ((bfd *, struct stat *));
 461
 462 /* Deprecated old routines.  */
 463 #if __GNUC__
 464 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 465   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 466    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 467 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 468   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 469    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 470 #else
 471 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 472   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 473    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 474 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 475   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 476    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 477 #endif
 478 extern void warn_deprecated
 479   PARAMS ((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_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 512
 513 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean) (bool)), true)
 514
 515 extern boolean bfd_cache_close PARAMS ((bfd *abfd));
 516 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 517
 518 extern boolean bfd_record_phdr
 519   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
 520            boolean, boolean, unsigned int, struct sec **));
 521
 522 /* Byte swapping routines.  */
 523
 524 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 525 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 526 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 527 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 528 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 529 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 530 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 531 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 532 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 533 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 534 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 535 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 536 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 537 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 538 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 539 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 540 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 541 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 542
 543 /* Byte swapping routines which take size and endiannes as arguments.  */
 544
 545 bfd_vma         bfd_get_bits       PARAMS ((bfd_byte *, int, boolean));
 546 void            bfd_put_bits       PARAMS ((bfd_vma, bfd_byte *, int, boolean));
 547 \f
 548 /* Externally visible ECOFF routines.  */
 549
 550 #if defined(__STDC__) || defined(ALMOST_STDC)
 551 struct ecoff_debug_info;
 552 struct ecoff_debug_swap;
 553 struct ecoff_extr;
 554 struct symbol_cache_entry;
 555 struct bfd_link_info;
 556 struct bfd_link_hash_entry;
 557 struct bfd_elf_version_tree;
 558 #endif
 559 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
 560 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
 561 extern boolean bfd_ecoff_set_regmasks
 562   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 563            unsigned long *cprmask));
 564 extern PTR bfd_ecoff_debug_init
 565   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 566            const struct ecoff_debug_swap *output_swap,
 567            struct bfd_link_info *));
 568 extern void bfd_ecoff_debug_free
 569   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 570            const struct ecoff_debug_swap *output_swap,
 571            struct bfd_link_info *));
 572 extern boolean bfd_ecoff_debug_accumulate
 573   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 574            const struct ecoff_debug_swap *output_swap,
 575            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 576            const struct ecoff_debug_swap *input_swap,
 577            struct bfd_link_info *));
 578 extern boolean bfd_ecoff_debug_accumulate_other
 579   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 580            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 581            struct bfd_link_info *));
 582 extern boolean bfd_ecoff_debug_externals
 583   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 584            const struct ecoff_debug_swap *swap,
 585            boolean relocateable,
 586            boolean (*get_extr) (struct symbol_cache_entry *,
 587                                 struct ecoff_extr *),
 588            void (*set_index) (struct symbol_cache_entry *,
 589                               bfd_size_type)));
 590 extern boolean bfd_ecoff_debug_one_external
 591   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 592            const struct ecoff_debug_swap *swap,
 593            const char *name, struct ecoff_extr *esym));
 594 extern bfd_size_type bfd_ecoff_debug_size
 595   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 596            const struct ecoff_debug_swap *swap));
 597 extern boolean bfd_ecoff_write_debug
 598   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 599            const struct ecoff_debug_swap *swap, file_ptr where));
 600 extern boolean bfd_ecoff_write_accumulated_debug
 601   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 602            const struct ecoff_debug_swap *swap,
 603            struct bfd_link_info *info, file_ptr where));
 604 extern boolean bfd_mips_ecoff_create_embedded_relocs
 605   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 606            char **));
 607
 608 /* Externally visible ELF routines.  */
 609
 610 struct bfd_link_needed_list
 611 {
 612   struct bfd_link_needed_list *next;
 613   bfd *by;
 614   const char *name;
 615 };
 616
 617 extern boolean bfd_elf32_record_link_assignment
 618   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 619 extern boolean bfd_elf64_record_link_assignment
 620   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 621 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 622   PARAMS ((bfd *, struct bfd_link_info *));
 623 extern boolean bfd_elf_get_bfd_needed_list
 624   PARAMS ((bfd *, struct bfd_link_needed_list **));
 625 extern boolean bfd_elf32_size_dynamic_sections
 626   PARAMS ((bfd *, const char *, const char *, const char *,
 627            const char * const *, struct bfd_link_info *, struct sec **,
 628            struct bfd_elf_version_tree *));
 629 extern boolean bfd_elf64_size_dynamic_sections
 630   PARAMS ((bfd *, const char *, const char *, const char *,
 631            const char * const *, struct bfd_link_info *, struct sec **,
 632            struct bfd_elf_version_tree *));
 633 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
 634 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
 635 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
 636 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 637   PARAMS ((bfd *, struct bfd_link_info *));
 638 extern boolean bfd_elf32_discard_info
 639   PARAMS ((bfd *, struct bfd_link_info *));
 640 extern boolean bfd_elf64_discard_info
 641   PARAMS ((bfd *, struct bfd_link_info *));
 642
 643 /* Return an upper bound on the number of bytes required to store a
 644    copy of ABFD's program header table entries.  Return -1 if an error
 645    occurs; bfd_get_error will return an appropriate code.  */
 646 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
 647
 648 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 649    will be stored as an array of Elf_Internal_Phdr structures, as
 650    defined in include/elf/internal.h.  To find out how large the
 651    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 652
 653    Return the number of program header table entries read, or -1 if an
 654    error occurs; bfd_get_error will return an appropriate code.  */
 655 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
 656
 657 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 658 extern int bfd_get_arch_size PARAMS ((bfd *));
 659
 660 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
 661 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
 662
 663 extern boolean bfd_m68k_elf32_create_embedded_relocs
 664   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 665            char **));
 666 extern boolean bfd_mips_elf32_create_embedded_relocs
 667   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 668            char **));
 669
 670 /* SunOS shared library support routines for the linker.  */
 671
 672 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 673   PARAMS ((bfd *, struct bfd_link_info *));
 674 extern boolean bfd_sunos_record_link_assignment
 675   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 676 extern boolean bfd_sunos_size_dynamic_sections
 677   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
 678            struct sec **));
 679
 680 /* Linux shared library support routines for the linker.  */
 681
 682 extern boolean bfd_i386linux_size_dynamic_sections
 683   PARAMS ((bfd *, struct bfd_link_info *));
 684 extern boolean bfd_m68klinux_size_dynamic_sections
 685   PARAMS ((bfd *, struct bfd_link_info *));
 686 extern boolean bfd_sparclinux_size_dynamic_sections
 687   PARAMS ((bfd *, struct bfd_link_info *));
 688
 689 /* mmap hacks */
 690
 691 struct _bfd_window_internal;
 692 typedef struct _bfd_window_internal bfd_window_internal;
 693
 694 typedef struct _bfd_window {
 695   /* What the user asked for.  */
 696   PTR data;
 697   bfd_size_type size;
 698   /* The actual window used by BFD.  Small user-requested read-only
 699      regions sharing a page may share a single window into the object
 700      file.  Read-write versions shouldn't until I've fixed things to
 701      keep track of which portions have been claimed by the
 702      application; don't want to give the same region back when the
 703      application wants two writable copies!  */
 704   struct _bfd_window_internal *i;
 705 } bfd_window;
 706
 707 extern void bfd_init_window PARAMS ((bfd_window *));
 708 extern void bfd_free_window PARAMS ((bfd_window *));
 709 extern boolean bfd_get_file_window
 710   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
 711
 712 /* XCOFF support routines for the linker.  */
 713
 714 extern boolean bfd_xcoff_link_record_set
 715   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 716            bfd_size_type));
 717 extern boolean bfd_xcoff_import_symbol
 718   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 719            bfd_vma, const char *, const char *, const char *, unsigned int));
 720 extern boolean bfd_xcoff_export_symbol
 721   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *));
 722 extern boolean bfd_xcoff_link_count_reloc
 723   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 724 extern boolean bfd_xcoff_record_link_assignment
 725   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 726 extern boolean bfd_xcoff_size_dynamic_sections
 727   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
 728            unsigned long, unsigned long, unsigned long, boolean,
 729            int, boolean, boolean, struct sec **));
 730 extern boolean bfd_xcoff_link_generate_rtinit
 731   PARAMS ((bfd *, const char *, const char *));
 732
 733 /* Externally visible COFF routines.  */
 734
 735 #if defined(__STDC__) || defined(ALMOST_STDC)
 736 struct internal_syment;
 737 union internal_auxent;
 738 #endif
 739
 740 extern boolean bfd_coff_get_syment
 741   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
 742
 743 extern boolean bfd_coff_get_auxent
 744   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
 745
 746 extern boolean bfd_coff_set_symbol_class
 747   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
 748
 749 extern boolean bfd_m68k_coff_create_embedded_relocs
 750   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 751            char **));
 752
 753 /* ARM Interworking support.  Called from linker.  */
 754 extern boolean bfd_arm_allocate_interworking_sections
 755   PARAMS ((struct bfd_link_info *));
 756
 757 extern boolean bfd_arm_process_before_allocation
 758   PARAMS ((bfd *, struct bfd_link_info *, int));
 759
 760 extern boolean bfd_arm_get_bfd_for_interworking
 761   PARAMS ((bfd *, struct bfd_link_info *));
 762
 763 /* PE ARM Interworking support.  Called from linker.  */
 764 extern boolean bfd_arm_pe_allocate_interworking_sections
 765   PARAMS ((struct bfd_link_info *));
 766
 767 extern boolean bfd_arm_pe_process_before_allocation
 768   PARAMS ((bfd *, struct bfd_link_info *, int));
 769
 770 extern boolean bfd_arm_pe_get_bfd_for_interworking
 771   PARAMS ((bfd *, struct bfd_link_info *));
 772
 773 /* ELF ARM Interworking support.  Called from linker.  */
 774 extern boolean bfd_elf32_arm_allocate_interworking_sections
 775   PARAMS ((struct bfd_link_info *));
 776
 777 extern boolean bfd_elf32_arm_process_before_allocation
 778   PARAMS ((bfd *, struct bfd_link_info *, int));
 779
 780 extern boolean bfd_elf32_arm_get_bfd_for_interworking
 781   PARAMS ((bfd *, struct bfd_link_info *));
 782
 783 /* TI COFF load page support.  */
 784 extern void bfd_ticoff_set_section_load_page
 785   PARAMS ((struct sec *, int));
 786
 787 extern int bfd_ticoff_get_section_load_page
 788   PARAMS ((struct sec *));
 789
 790 /* And more from the source.  */