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, 2002
   4    Free Software Foundation, Inc.
   5    Contributed by Cygnus Support.
   6
   7 This file is part of BFD, the Binary File Descriptor library.
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef __BFD_H_SEEN__
  24 #define __BFD_H_SEEN__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #include "ansidecl.h"
  31 #include "symcat.h"
  32 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  33 #ifndef SABER
  34 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
  35    The problem is, "32_" is not a valid preprocessing token, and we don't
  36    want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will
  37    cause the inner CONCAT2 macros to be evaluated first, producing
  38    still-valid pp-tokens.  Then the final concatenation can be done.  */
  39 #undef CONCAT4
  40 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  41 #endif
  42 #endif
  43
  44 #define BFD_VERSION @bfd_version@
  45 #define BFD_VERSION_DATE @bfd_version_date@
  46 #define BFD_VERSION_STRING @bfd_version_string@
  47
  48 /* The word size used by BFD on the host.  This may be 64 with a 32
  49    bit target if the host is 64 bit, or if other 64 bit targets have
  50    been selected with --enable-targets, or if --enable-64-bit-bfd.  */
  51 #define BFD_ARCH_SIZE @wordsize@
  52
  53 /* The word size of the default bfd target.  */
  54 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  55
  56 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  57 #if @BFD_HOST_64_BIT_DEFINED@
  58 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  59 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  60 #endif
  61
  62 #if BFD_ARCH_SIZE >= 64
  63 #define BFD64
  64 #endif
  65
  66 #ifndef INLINE
  67 #if __GNUC__ >= 2
  68 #define INLINE __inline__
  69 #else
  70 #define INLINE
  71 #endif
  72 #endif
  73
  74 /* Forward declaration.  */
  75 typedef struct _bfd bfd;
  76
  77 /* To squelch erroneous compiler warnings ("illegal pointer
  78    combination") from the SVR3 compiler, we would like to typedef
  79    boolean to int (it doesn't like functions which return boolean.
  80    Making sure they are never implicitly declared to return int
  81    doesn't seem to help).  But this file is not configured based on
  82    the host.  */
  83 /* General rules: functions which are boolean return true on success
  84    and false on failure (unless they're a predicate).   -- bfd.doc */
  85 /* I'm sure this is going to break something and someone is going to
  86    force me to change it.  */
  87 /* typedef enum boolean {false, true} boolean; */
  88 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  89 /* It gets worse if the host also defines a true/false enum... -sts */
  90 /* And even worse if your compiler has built-in boolean types... -law */
  91 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
  92 #define TRUE_FALSE_ALREADY_DEFINED
  93 #endif
  94 #ifdef MPW
  95 /* Pre-emptive strike - get the file with the enum.  */
  96 #include <Types.h>
  97 #define TRUE_FALSE_ALREADY_DEFINED
  98 #endif /* MPW */
  99 #ifndef TRUE_FALSE_ALREADY_DEFINED
 100 typedef enum bfd_boolean {false, true} boolean;
 101 #define BFD_TRUE_FALSE
 102 #else
 103 /* Use enum names that will appear nowhere else.  */
 104 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
 105 #endif
 106
 107 /* Support for different sizes of target format ints and addresses.
 108    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
 109    set to 1 above.  Otherwise, if gcc is being used, this code will
 110    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
 111    defined above.  */
 112
 113 #ifndef BFD_HOST_64_BIT
 114 # if BFD_HOST_64BIT_LONG
 115 #  define BFD_HOST_64_BIT long
 116 #  define BFD_HOST_U_64_BIT unsigned long
 117 # else
 118 #  ifdef __GNUC__
 119 #   if __GNUC__ >= 2
 120 #    define BFD_HOST_64_BIT long long
 121 #    define BFD_HOST_U_64_BIT unsigned long long
 122 #   endif /* __GNUC__ >= 2 */
 123 #  endif /* ! defined (__GNUC__) */
 124 # endif /* ! BFD_HOST_64BIT_LONG */
 125 #endif /* ! defined (BFD_HOST_64_BIT) */
 126
 127 #ifdef BFD64
 128
 129 #ifndef BFD_HOST_64_BIT
 130  #error No 64 bit integer type available
 131 #endif /* ! defined (BFD_HOST_64_BIT) */
 132
 133 typedef BFD_HOST_U_64_BIT bfd_vma;
 134 typedef BFD_HOST_64_BIT bfd_signed_vma;
 135 typedef BFD_HOST_U_64_BIT bfd_size_type;
 136 typedef BFD_HOST_U_64_BIT symvalue;
 137
 138 #ifndef fprintf_vma
 139 #if BFD_HOST_64BIT_LONG
 140 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 141 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 142 #else
 143 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 144 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 145 #define fprintf_vma(s,x) \
 146   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 147 #define sprintf_vma(s,x) \
 148   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 149 #endif
 150 #endif
 151
 152 #else /* not BFD64  */
 153
 154 /* Represent a target address.  Also used as a generic unsigned type
 155    which is guaranteed to be big enough to hold any arithmetic types
 156    we need to deal with.  */
 157 typedef unsigned long bfd_vma;
 158
 159 /* A generic signed type which is guaranteed to be big enough to hold any
 160    arithmetic types we need to deal with.  Can be assumed to be compatible
 161    with bfd_vma in the same way that signed and unsigned ints are compatible
 162    (as parameters, in assignment, etc).  */
 163 typedef long bfd_signed_vma;
 164
 165 typedef unsigned long symvalue;
 166 typedef unsigned long bfd_size_type;
 167
 168 /* Print a bfd_vma x on stream s.  */
 169 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
 170 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
 171
 172 #endif /* not BFD64  */
 173
 174 /* A pointer to a position in a file.  */
 175 /* FIXME:  This should be using off_t from <sys/types.h>.
 176    For now, try to avoid breaking stuff by not including <sys/types.h> here.
 177    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
 178    Probably the best long-term answer is to avoid using file_ptr AND off_t
 179    in this header file, and to handle this in the BFD implementation
 180    rather than in its interface.  */
 181 /* typedef off_t        file_ptr; */
 182 typedef bfd_signed_vma file_ptr;
 183 typedef bfd_vma ufile_ptr;
 184
 185 extern void bfd_sprintf_vma PARAMS ((bfd *, char *, bfd_vma));
 186 extern void bfd_fprintf_vma PARAMS ((bfd *, PTR, bfd_vma));
 187
 188 #define printf_vma(x) fprintf_vma(stdout,x)
 189 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 190
 191 typedef unsigned int flagword;  /* 32 bits of flags */
 192 typedef unsigned char bfd_byte;
 193 \f
 194 /* File formats.  */
 195
 196 typedef enum bfd_format
 197 {
 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 }
 204 bfd_format;
 205
 206 /* Values that may appear in the flags field of a BFD.  These also
 207    appear in the object_flags field of the bfd_target structure, where
 208    they indicate the set of flags used by that backend (not all flags
 209    are meaningful for all object file formats) (FIXME: at the moment,
 210    the object_flags values have mostly just been copied from backend
 211    to another, and are not necessarily correct).  */
 212
 213 /* No flags.  */
 214 #define BFD_NO_FLAGS    0x00
 215
 216 /* BFD contains relocation entries.  */
 217 #define HAS_RELOC       0x01
 218
 219 /* BFD is directly executable.  */
 220 #define EXEC_P          0x02
 221
 222 /* BFD has line number information (basically used for F_LNNO in a
 223    COFF header).  */
 224 #define HAS_LINENO      0x04
 225
 226 /* BFD has debugging information.  */
 227 #define HAS_DEBUG       0x08
 228
 229 /* BFD has symbols.  */
 230 #define HAS_SYMS        0x10
 231
 232 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 233    header).  */
 234 #define HAS_LOCALS      0x20
 235
 236 /* BFD is a dynamic object.  */
 237 #define DYNAMIC         0x40
 238
 239 /* Text section is write protected (if D_PAGED is not set, this is
 240    like an a.out NMAGIC file) (the linker sets this by default, but
 241    clears it for -r or -N).  */
 242 #define WP_TEXT         0x80
 243
 244 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 245    linker sets this by default, but clears it for -r or -n or -N).  */
 246 #define D_PAGED         0x100
 247
 248 /* BFD is relaxable (this means that bfd_relax_section may be able to
 249    do something) (sometimes bfd_relax_section can do something even if
 250    this is not set).  */
 251 #define BFD_IS_RELAXABLE 0x200
 252
 253 /* This may be set before writing out a BFD to request using a
 254    traditional format.  For example, this is used to request that when
 255    writing out an a.out object the symbols not be hashed to eliminate
 256    duplicates.  */
 257 #define BFD_TRADITIONAL_FORMAT 0x400
 258
 259 /* This flag indicates that the BFD contents are actually cached in
 260    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
 261 #define BFD_IN_MEMORY 0x800
 262 \f
 263 /* Symbols and relocation.  */
 264
 265 /* A count of carsyms (canonical archive symbols).  */
 266 typedef unsigned long symindex;
 267
 268 /* How to perform a relocation.  */
 269 typedef const struct reloc_howto_struct reloc_howto_type;
 270
 271 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 272
 273 /* General purpose part of a symbol X;
 274    target specific parts are in libcoff.h, libaout.h, etc.  */
 275
 276 #define bfd_get_section(x) ((x)->section)
 277 #define bfd_get_output_section(x) ((x)->section->output_section)
 278 #define bfd_set_section(x,y) ((x)->section) = (y)
 279 #define bfd_asymbol_base(x) ((x)->section->vma)
 280 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 281 #define bfd_asymbol_name(x) ((x)->name)
 282 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 283 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 284 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 285
 286 /* A canonical archive symbol.  */
 287 /* This is a type pun with struct ranlib on purpose!  */
 288 typedef struct carsym
 289 {
 290   char *name;
 291   file_ptr file_offset; /* Look here to find the file.  */
 292 }
 293 carsym;                 /* To make these you call a carsymogen.  */
 294
 295 /* Used in generating armaps (archive tables of contents).
 296    Perhaps just a forward definition would do?  */
 297 struct orl                      /* Output ranlib.  */
 298 {
 299   char **name;          /* Symbol name.  */
 300   union
 301   {
 302     file_ptr pos;
 303     bfd *abfd;
 304   } u;                  /* bfd* or file position.  */
 305   int namidx;           /* Index into string table.  */
 306 };
 307 \f
 308 /* Linenumber stuff.  */
 309 typedef struct lineno_cache_entry
 310 {
 311   unsigned int line_number;     /* Linenumber from start of function.  */
 312   union
 313   {
 314     struct symbol_cache_entry *sym;     /* Function name.  */
 315     bfd_vma offset;                     /* Offset into section.  */
 316   } u;
 317 }
 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
 457 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 458
 459 /* User program access to BFD facilities.  */
 460
 461 /* Direct I/O routines, for programs which know more about the object
 462    file than BFD does.  Use higher level routines if possible.  */
 463
 464 extern bfd_size_type bfd_bread PARAMS ((PTR, bfd_size_type, bfd *));
 465 extern bfd_size_type bfd_bwrite PARAMS ((const PTR, bfd_size_type, bfd *));
 466 extern int bfd_seek PARAMS ((bfd *, file_ptr, int));
 467 extern ufile_ptr bfd_tell PARAMS ((bfd *));
 468 extern int bfd_flush PARAMS ((bfd *));
 469 extern int bfd_stat PARAMS ((bfd *, struct stat *));
 470
 471 /* Deprecated old routines.  */
 472 #if __GNUC__
 473 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 474   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 475    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 476 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 477   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 478    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 479 #else
 480 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 481   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 482    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 483 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 484   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 485    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 486 #endif
 487 extern void warn_deprecated
 488   PARAMS ((const char *, const char *, int, const char *));
 489
 490 /* Cast from const char * to char * so that caller can assign to
 491    a char * without a warning.  */
 492 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 493 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 494 #define bfd_get_format(abfd) ((abfd)->format)
 495 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 496 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 497 #define bfd_family_coff(abfd) \
 498   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
 499    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
 500 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 501 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 502 #define bfd_header_big_endian(abfd) \
 503   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 504 #define bfd_header_little_endian(abfd) \
 505   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 506 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 507 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 508 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 509 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 510 #define bfd_has_map(abfd) ((abfd)->has_armap)
 511
 512 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 513 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 514
 515 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 516 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 517 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 518 #define bfd_count_sections(abfd) ((abfd)->section_count)
 519
 520 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 521
 522 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean) (bool)), true)
 523
 524 extern boolean bfd_cache_close PARAMS ((bfd *abfd));
 525 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 526
 527 extern boolean bfd_record_phdr
 528   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
 529            boolean, boolean, unsigned int, struct sec **));
 530
 531 /* Byte swapping routines.  */
 532
 533 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 534 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 535 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 536 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 537 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 538 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 539 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 540 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 541 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 542 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 543 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 544 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 545 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 546 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 547 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 548 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 549 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 550 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 551
 552 /* Byte swapping routines which take size and endiannes as arguments.  */
 553
 554 bfd_vma         bfd_get_bits       PARAMS ((bfd_byte *, int, boolean));
 555 void            bfd_put_bits       PARAMS ((bfd_vma, bfd_byte *, int, boolean));
 556 \f
 557 /* Externally visible ECOFF routines.  */
 558
 559 #if defined(__STDC__) || defined(ALMOST_STDC)
 560 struct ecoff_debug_info;
 561 struct ecoff_debug_swap;
 562 struct ecoff_extr;
 563 struct symbol_cache_entry;
 564 struct bfd_link_info;
 565 struct bfd_link_hash_entry;
 566 struct bfd_elf_version_tree;
 567 #endif
 568 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
 569 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
 570 extern boolean bfd_ecoff_set_regmasks
 571   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 572            unsigned long *cprmask));
 573 extern PTR bfd_ecoff_debug_init
 574   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 575            const struct ecoff_debug_swap *output_swap,
 576            struct bfd_link_info *));
 577 extern void bfd_ecoff_debug_free
 578   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 579            const struct ecoff_debug_swap *output_swap,
 580            struct bfd_link_info *));
 581 extern boolean bfd_ecoff_debug_accumulate
 582   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 583            const struct ecoff_debug_swap *output_swap,
 584            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 585            const struct ecoff_debug_swap *input_swap,
 586            struct bfd_link_info *));
 587 extern boolean bfd_ecoff_debug_accumulate_other
 588   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 589            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 590            struct bfd_link_info *));
 591 extern boolean bfd_ecoff_debug_externals
 592   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 593            const struct ecoff_debug_swap *swap,
 594            boolean relocateable,
 595            boolean (*get_extr) (struct symbol_cache_entry *,
 596                                 struct ecoff_extr *),
 597            void (*set_index) (struct symbol_cache_entry *,
 598                               bfd_size_type)));
 599 extern boolean bfd_ecoff_debug_one_external
 600   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 601            const struct ecoff_debug_swap *swap,
 602            const char *name, struct ecoff_extr *esym));
 603 extern bfd_size_type bfd_ecoff_debug_size
 604   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 605            const struct ecoff_debug_swap *swap));
 606 extern boolean bfd_ecoff_write_debug
 607   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 608            const struct ecoff_debug_swap *swap, file_ptr where));
 609 extern boolean bfd_ecoff_write_accumulated_debug
 610   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 611            const struct ecoff_debug_swap *swap,
 612            struct bfd_link_info *info, file_ptr where));
 613 extern boolean bfd_mips_ecoff_create_embedded_relocs
 614   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 615            char **));
 616
 617 /* Externally visible ELF routines.  */
 618
 619 struct bfd_link_needed_list
 620 {
 621   struct bfd_link_needed_list *next;
 622   bfd *by;
 623   const char *name;
 624 };
 625
 626 extern boolean bfd_elf32_record_link_assignment
 627   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 628 extern boolean bfd_elf64_record_link_assignment
 629   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 630 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 631   PARAMS ((bfd *, struct bfd_link_info *));
 632 extern boolean bfd_elf_get_bfd_needed_list
 633   PARAMS ((bfd *, struct bfd_link_needed_list **));
 634 extern boolean bfd_elf32_size_dynamic_sections
 635   PARAMS ((bfd *, const char *, const char *, const char *,
 636            const char * const *, struct bfd_link_info *, struct sec **,
 637            struct bfd_elf_version_tree *));
 638 extern boolean bfd_elf64_size_dynamic_sections
 639   PARAMS ((bfd *, const char *, const char *, const char *,
 640            const char * const *, struct bfd_link_info *, struct sec **,
 641            struct bfd_elf_version_tree *));
 642 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
 643 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
 644 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
 645 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 646   PARAMS ((bfd *, struct bfd_link_info *));
 647 extern boolean bfd_elf32_discard_info
 648   PARAMS ((bfd *, struct bfd_link_info *));
 649 extern boolean bfd_elf64_discard_info
 650   PARAMS ((bfd *, struct bfd_link_info *));
 651
 652 /* Return an upper bound on the number of bytes required to store a
 653    copy of ABFD's program header table entries.  Return -1 if an error
 654    occurs; bfd_get_error will return an appropriate code.  */
 655 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
 656
 657 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 658    will be stored as an array of Elf_Internal_Phdr structures, as
 659    defined in include/elf/internal.h.  To find out how large the
 660    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 661
 662    Return the number of program header table entries read, or -1 if an
 663    error occurs; bfd_get_error will return an appropriate code.  */
 664 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
 665
 666 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 667 extern int bfd_get_arch_size PARAMS ((bfd *));
 668
 669 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
 670 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
 671
 672 extern boolean bfd_m68k_elf32_create_embedded_relocs
 673   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 674            char **));
 675 extern boolean bfd_mips_elf32_create_embedded_relocs
 676   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 677            char **));
 678
 679 /* SunOS shared library support routines for the linker.  */
 680
 681 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 682   PARAMS ((bfd *, struct bfd_link_info *));
 683 extern boolean bfd_sunos_record_link_assignment
 684   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 685 extern boolean bfd_sunos_size_dynamic_sections
 686   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
 687            struct sec **));
 688
 689 /* Linux shared library support routines for the linker.  */
 690
 691 extern boolean bfd_i386linux_size_dynamic_sections
 692   PARAMS ((bfd *, struct bfd_link_info *));
 693 extern boolean bfd_m68klinux_size_dynamic_sections
 694   PARAMS ((bfd *, struct bfd_link_info *));
 695 extern boolean bfd_sparclinux_size_dynamic_sections
 696   PARAMS ((bfd *, struct bfd_link_info *));
 697
 698 /* mmap hacks */
 699
 700 struct _bfd_window_internal;
 701 typedef struct _bfd_window_internal bfd_window_internal;
 702
 703 typedef struct _bfd_window
 704 {
 705   /* What the user asked for.  */
 706   PTR data;
 707   bfd_size_type size;
 708   /* The actual window used by BFD.  Small user-requested read-only
 709      regions sharing a page may share a single window into the object
 710      file.  Read-write versions shouldn't until I've fixed things to
 711      keep track of which portions have been claimed by the
 712      application; don't want to give the same region back when the
 713      application wants two writable copies!  */
 714   struct _bfd_window_internal *i;
 715 }
 716 bfd_window;
 717
 718 extern void bfd_init_window PARAMS ((bfd_window *));
 719 extern void bfd_free_window PARAMS ((bfd_window *));
 720 extern boolean bfd_get_file_window
 721   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
 722
 723 /* XCOFF support routines for the linker.  */
 724
 725 extern boolean bfd_xcoff_link_record_set
 726   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 727            bfd_size_type));
 728 extern boolean bfd_xcoff_import_symbol
 729   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 730            bfd_vma, const char *, const char *, const char *, unsigned int));
 731 extern boolean bfd_xcoff_export_symbol
 732   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *));
 733 extern boolean bfd_xcoff_link_count_reloc
 734   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 735 extern boolean bfd_xcoff_record_link_assignment
 736   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 737 extern boolean bfd_xcoff_size_dynamic_sections
 738   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
 739            unsigned long, unsigned long, unsigned long, boolean,
 740            int, boolean, boolean, struct sec **));
 741 extern boolean bfd_xcoff_link_generate_rtinit
 742   PARAMS ((bfd *, const char *, const char *));
 743
 744 /* Externally visible COFF routines.  */
 745
 746 #if defined(__STDC__) || defined(ALMOST_STDC)
 747 struct internal_syment;
 748 union internal_auxent;
 749 #endif
 750
 751 extern boolean bfd_coff_get_syment
 752   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
 753
 754 extern boolean bfd_coff_get_auxent
 755   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
 756
 757 extern boolean bfd_coff_set_symbol_class
 758   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
 759
 760 extern boolean bfd_m68k_coff_create_embedded_relocs
 761   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 762            char **));
 763
 764 /* ARM Interworking support.  Called from linker.  */
 765 extern boolean bfd_arm_allocate_interworking_sections
 766   PARAMS ((struct bfd_link_info *));
 767
 768 extern boolean bfd_arm_process_before_allocation
 769   PARAMS ((bfd *, struct bfd_link_info *, int));
 770
 771 extern boolean bfd_arm_get_bfd_for_interworking
 772   PARAMS ((bfd *, struct bfd_link_info *));
 773
 774 /* PE ARM Interworking support.  Called from linker.  */
 775 extern boolean bfd_arm_pe_allocate_interworking_sections
 776   PARAMS ((struct bfd_link_info *));
 777
 778 extern boolean bfd_arm_pe_process_before_allocation
 779   PARAMS ((bfd *, struct bfd_link_info *, int));
 780
 781 extern boolean bfd_arm_pe_get_bfd_for_interworking
 782   PARAMS ((bfd *, struct bfd_link_info *));
 783
 784 /* ELF ARM Interworking support.  Called from linker.  */
 785 extern boolean bfd_elf32_arm_allocate_interworking_sections
 786   PARAMS ((struct bfd_link_info *));
 787
 788 extern boolean bfd_elf32_arm_process_before_allocation
 789   PARAMS ((bfd *, struct bfd_link_info *, int));
 790
 791 extern boolean bfd_elf32_arm_get_bfd_for_interworking
 792   PARAMS ((bfd *, struct bfd_link_info *));
 793
 794 /* TI COFF load page support.  */
 795 extern void bfd_ticoff_set_section_load_page
 796   PARAMS ((struct sec *, int));
 797
 798 extern int bfd_ticoff_get_section_load_page
 799   PARAMS ((struct sec *));
 800
 801 /* And more from the source.  */