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