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