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