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 /* And even worse if your compiler provides a stdbool.h that conflicts
  92    with these definitions... gcc 2.95 and later do.  -drow */
  93 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
  94 #define TRUE_FALSE_ALREADY_DEFINED
  95 #else
  96 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95))
  97 #include <stdbool.h>
  98 #define TRUE_FALSE_ALREADY_DEFINED
  99 #endif
 100 #endif
 101 #ifdef MPW
 102 /* Pre-emptive strike - get the file with the enum.  */
 103 #include <Types.h>
 104 #define TRUE_FALSE_ALREADY_DEFINED
 105 #endif /* MPW */
 106 #ifndef TRUE_FALSE_ALREADY_DEFINED
 107 typedef enum bfd_boolean {false, true} boolean;
 108 #define BFD_TRUE_FALSE
 109 #else
 110 /* Use enum names that will appear nowhere else.  */
 111 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
 112 #endif
 113
 114 /* Support for different sizes of target format ints and addresses.
 115    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
 116    set to 1 above.  Otherwise, if gcc is being used, this code will
 117    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
 118    defined above.  */
 119
 120 #ifndef BFD_HOST_64_BIT
 121 # if BFD_HOST_64BIT_LONG
 122 #  define BFD_HOST_64_BIT long
 123 #  define BFD_HOST_U_64_BIT unsigned long
 124 # else
 125 #  ifdef __GNUC__
 126 #   if __GNUC__ >= 2
 127 #    define BFD_HOST_64_BIT long long
 128 #    define BFD_HOST_U_64_BIT unsigned long long
 129 #   endif /* __GNUC__ >= 2 */
 130 #  endif /* ! defined (__GNUC__) */
 131 # endif /* ! BFD_HOST_64BIT_LONG */
 132 #endif /* ! defined (BFD_HOST_64_BIT) */
 133
 134 #ifdef BFD64
 135
 136 #ifndef BFD_HOST_64_BIT
 137  #error No 64 bit integer type available
 138 #endif /* ! defined (BFD_HOST_64_BIT) */
 139
 140 typedef BFD_HOST_U_64_BIT bfd_vma;
 141 typedef BFD_HOST_64_BIT bfd_signed_vma;
 142 typedef BFD_HOST_U_64_BIT bfd_size_type;
 143 typedef BFD_HOST_U_64_BIT symvalue;
 144
 145 #ifndef fprintf_vma
 146 #if BFD_HOST_64BIT_LONG
 147 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 148 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 149 #else
 150 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 151 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 152 #define fprintf_vma(s,x) \
 153   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 154 #define sprintf_vma(s,x) \
 155   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 156 #endif
 157 #endif
 158
 159 #else /* not BFD64  */
 160
 161 /* Represent a target address.  Also used as a generic unsigned type
 162    which is guaranteed to be big enough to hold any arithmetic types
 163    we need to deal with.  */
 164 typedef unsigned long bfd_vma;
 165
 166 /* A generic signed type which is guaranteed to be big enough to hold any
 167    arithmetic types we need to deal with.  Can be assumed to be compatible
 168    with bfd_vma in the same way that signed and unsigned ints are compatible
 169    (as parameters, in assignment, etc).  */
 170 typedef long bfd_signed_vma;
 171
 172 typedef unsigned long symvalue;
 173 typedef unsigned long bfd_size_type;
 174
 175 /* Print a bfd_vma x on stream s.  */
 176 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
 177 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
 178
 179 #endif /* not BFD64  */
 180
 181 /* A pointer to a position in a file.  */
 182 /* FIXME:  This should be using off_t from <sys/types.h>.
 183    For now, try to avoid breaking stuff by not including <sys/types.h> here.
 184    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
 185    Probably the best long-term answer is to avoid using file_ptr AND off_t
 186    in this header file, and to handle this in the BFD implementation
 187    rather than in its interface.  */
 188 /* typedef off_t        file_ptr; */
 189 typedef bfd_signed_vma file_ptr;
 190 typedef bfd_vma ufile_ptr;
 191
 192 extern void bfd_sprintf_vma PARAMS ((bfd *, char *, bfd_vma));
 193 extern void bfd_fprintf_vma PARAMS ((bfd *, PTR, bfd_vma));
 194
 195 #define printf_vma(x) fprintf_vma(stdout,x)
 196 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 197
 198 typedef unsigned int flagword;  /* 32 bits of flags */
 199 typedef unsigned char bfd_byte;
 200 \f
 201 /* File formats.  */
 202
 203 typedef enum bfd_format
 204 {
 205   bfd_unknown = 0,      /* File format is unknown.  */
 206   bfd_object,           /* Linker/assember/compiler output.  */
 207   bfd_archive,          /* Object archive file.  */
 208   bfd_core,             /* Core dump.  */
 209   bfd_type_end          /* Marks the end; don't use it!  */
 210 }
 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 {
 297   char *name;
 298   file_ptr file_offset; /* Look here to find the file.  */
 299 }
 300 carsym;                 /* To make these you call a carsymogen.  */
 301
 302 /* Used in generating armaps (archive tables of contents).
 303    Perhaps just a forward definition would do?  */
 304 struct orl                      /* Output ranlib.  */
 305 {
 306   char **name;          /* Symbol name.  */
 307   union
 308   {
 309     file_ptr pos;
 310     bfd *abfd;
 311   } u;                  /* bfd* or file position.  */
 312   int namidx;           /* Index into string table.  */
 313 };
 314 \f
 315 /* Linenumber stuff.  */
 316 typedef struct lineno_cache_entry
 317 {
 318   unsigned int line_number;     /* Linenumber from start of function.  */
 319   union
 320   {
 321     struct symbol_cache_entry *sym;     /* Function name.  */
 322     bfd_vma offset;                     /* Offset into section.  */
 323   } u;
 324 }
 325 alent;
 326 \f
 327 /* Object and core file sections.  */
 328
 329 #define align_power(addr, align)        \
 330         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 331
 332 typedef struct sec *sec_ptr;
 333
 334 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 335 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 336 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 337 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 338 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 339 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 340 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 341 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 342 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 343 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 344
 345 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 346
 347 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
 348 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 349 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 350
 351 typedef struct stat stat_type;
 352 \f
 353 typedef enum bfd_print_symbol
 354 {
 355   bfd_print_symbol_name,
 356   bfd_print_symbol_more,
 357   bfd_print_symbol_all
 358 } bfd_print_symbol_type;
 359
 360 /* Information about a symbol that nm needs.  */
 361
 362 typedef struct _symbol_info
 363 {
 364   symvalue value;
 365   char type;
 366   const char *name;            /* Symbol name.  */
 367   unsigned char stab_type;     /* Stab type.  */
 368   char stab_other;             /* Stab other.  */
 369   short stab_desc;             /* Stab desc.  */
 370   const char *stab_name;       /* String for stab type.  */
 371 } symbol_info;
 372
 373 /* Get the name of a stabs type code.  */
 374
 375 extern const char *bfd_get_stab_name PARAMS ((int));
 376 \f
 377 /* Hash table routines.  There is no way to free up a hash table.  */
 378
 379 /* An element in the hash table.  Most uses will actually use a larger
 380    structure, and an instance of this will be the first field.  */
 381
 382 struct bfd_hash_entry
 383 {
 384   /* Next entry for this hash code.  */
 385   struct bfd_hash_entry *next;
 386   /* String being hashed.  */
 387   const char *string;
 388   /* Hash code.  This is the full hash code, not the index into the
 389      table.  */
 390   unsigned long hash;
 391 };
 392
 393 /* A hash table.  */
 394
 395 struct bfd_hash_table
 396 {
 397   /* The hash array.  */
 398   struct bfd_hash_entry **table;
 399   /* The number of slots in the hash table.  */
 400   unsigned int size;
 401   /* A function used to create new elements in the hash table.  The
 402      first entry is itself a pointer to an element.  When this
 403      function is first invoked, this pointer will be NULL.  However,
 404      having the pointer permits a hierarchy of method functions to be
 405      built each of which calls the function in the superclass.  Thus
 406      each function should be written to allocate a new block of memory
 407      only if the argument is NULL.  */
 408   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
 409                                              struct bfd_hash_table *,
 410                                              const char *));
 411    /* An objalloc for this hash table.  This is a struct objalloc *,
 412      but we use PTR to avoid requiring the inclusion of objalloc.h.  */
 413   PTR memory;
 414 };
 415
 416 /* Initialize a hash table.  */
 417 extern boolean bfd_hash_table_init
 418   PARAMS ((struct bfd_hash_table *,
 419            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 420                                        struct bfd_hash_table *,
 421                                        const char *)));
 422
 423 /* Initialize a hash table specifying a size.  */
 424 extern boolean bfd_hash_table_init_n
 425   PARAMS ((struct bfd_hash_table *,
 426            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 427                                        struct bfd_hash_table *,
 428                                        const char *),
 429            unsigned int size));
 430
 431 /* Free up a hash table.  */
 432 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
 433
 434 /* Look up a string in a hash table.  If CREATE is true, a new entry
 435    will be created for this string if one does not already exist.  The
 436    COPY argument must be true if this routine should copy the string
 437    into newly allocated memory when adding an entry.  */
 438 extern struct bfd_hash_entry *bfd_hash_lookup
 439   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
 440            boolean copy));
 441
 442 /* Replace an entry in a hash table.  */
 443 extern void bfd_hash_replace
 444   PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
 445            struct bfd_hash_entry *nw));
 446
 447 /* Base method for creating a hash table entry.  */
 448 extern struct bfd_hash_entry *bfd_hash_newfunc
 449   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
 450            const char *));
 451
 452 /* Grab some space for a hash table entry.  */
 453 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
 454                                       unsigned int));
 455
 456 /* Traverse a hash table in a random order, calling a function on each
 457    element.  If the function returns false, the traversal stops.  The
 458    INFO argument is passed to the function.  */
 459 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
 460                                        boolean (*) (struct bfd_hash_entry *,
 461                                                     PTR),
 462                                        PTR info));
 463
 464 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 465
 466 /* User program access to BFD facilities.  */
 467
 468 /* Direct I/O routines, for programs which know more about the object
 469    file than BFD does.  Use higher level routines if possible.  */
 470
 471 extern bfd_size_type bfd_bread PARAMS ((PTR, bfd_size_type, bfd *));
 472 extern bfd_size_type bfd_bwrite PARAMS ((const PTR, bfd_size_type, bfd *));
 473 extern int bfd_seek PARAMS ((bfd *, file_ptr, int));
 474 extern ufile_ptr bfd_tell PARAMS ((bfd *));
 475 extern int bfd_flush PARAMS ((bfd *));
 476 extern int bfd_stat PARAMS ((bfd *, struct stat *));
 477
 478 /* Deprecated old routines.  */
 479 #if __GNUC__
 480 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 481   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 482    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 483 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 484   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 485    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 486 #else
 487 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 488   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 489    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 490 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 491   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 492    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 493 #endif
 494 extern void warn_deprecated
 495   PARAMS ((const char *, const char *, int, const char *));
 496
 497 /* Cast from const char * to char * so that caller can assign to
 498    a char * without a warning.  */
 499 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 500 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 501 #define bfd_get_format(abfd) ((abfd)->format)
 502 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 503 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 504 #define bfd_family_coff(abfd) \
 505   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
 506    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
 507 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 508 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 509 #define bfd_header_big_endian(abfd) \
 510   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 511 #define bfd_header_little_endian(abfd) \
 512   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 513 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 514 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 515 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 516 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 517 #define bfd_has_map(abfd) ((abfd)->has_armap)
 518
 519 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 520 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 521
 522 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 523 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 524 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 525 #define bfd_count_sections(abfd) ((abfd)->section_count)
 526
 527 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 528
 529 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean) (bool)), true)
 530
 531 extern boolean bfd_cache_close PARAMS ((bfd *abfd));
 532 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 533
 534 extern boolean bfd_record_phdr
 535   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
 536            boolean, boolean, unsigned int, struct sec **));
 537
 538 /* Byte swapping routines.  */
 539
 540 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 541 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 542 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 543 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 544 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 545 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 546 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 547 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 548 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 549 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 550 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 551 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 552 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 553 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 554 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 555 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 556 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 557 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 558
 559 /* Byte swapping routines which take size and endiannes as arguments.  */
 560
 561 bfd_vma         bfd_get_bits       PARAMS ((bfd_byte *, int, boolean));
 562 void            bfd_put_bits       PARAMS ((bfd_vma, bfd_byte *, int, boolean));
 563 \f
 564 /* Externally visible ECOFF routines.  */
 565
 566 #if defined(__STDC__) || defined(ALMOST_STDC)
 567 struct ecoff_debug_info;
 568 struct ecoff_debug_swap;
 569 struct ecoff_extr;
 570 struct symbol_cache_entry;
 571 struct bfd_link_info;
 572 struct bfd_link_hash_entry;
 573 struct bfd_elf_version_tree;
 574 #endif
 575 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
 576 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
 577 extern boolean bfd_ecoff_set_regmasks
 578   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 579            unsigned long *cprmask));
 580 extern PTR bfd_ecoff_debug_init
 581   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 582            const struct ecoff_debug_swap *output_swap,
 583            struct bfd_link_info *));
 584 extern void bfd_ecoff_debug_free
 585   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 586            const struct ecoff_debug_swap *output_swap,
 587            struct bfd_link_info *));
 588 extern boolean bfd_ecoff_debug_accumulate
 589   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 590            const struct ecoff_debug_swap *output_swap,
 591            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 592            const struct ecoff_debug_swap *input_swap,
 593            struct bfd_link_info *));
 594 extern boolean bfd_ecoff_debug_accumulate_other
 595   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 596            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 597            struct bfd_link_info *));
 598 extern boolean bfd_ecoff_debug_externals
 599   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 600            const struct ecoff_debug_swap *swap,
 601            boolean relocateable,
 602            boolean (*get_extr) (struct symbol_cache_entry *,
 603                                 struct ecoff_extr *),
 604            void (*set_index) (struct symbol_cache_entry *,
 605                               bfd_size_type)));
 606 extern boolean bfd_ecoff_debug_one_external
 607   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 608            const struct ecoff_debug_swap *swap,
 609            const char *name, struct ecoff_extr *esym));
 610 extern bfd_size_type bfd_ecoff_debug_size
 611   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 612            const struct ecoff_debug_swap *swap));
 613 extern boolean bfd_ecoff_write_debug
 614   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 615            const struct ecoff_debug_swap *swap, file_ptr where));
 616 extern boolean bfd_ecoff_write_accumulated_debug
 617   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 618            const struct ecoff_debug_swap *swap,
 619            struct bfd_link_info *info, file_ptr where));
 620 extern boolean bfd_mips_ecoff_create_embedded_relocs
 621   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 622            char **));
 623
 624 /* Externally visible ELF routines.  */
 625
 626 struct bfd_link_needed_list
 627 {
 628   struct bfd_link_needed_list *next;
 629   bfd *by;
 630   const char *name;
 631 };
 632
 633 extern boolean bfd_elf32_record_link_assignment
 634   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 635 extern boolean bfd_elf64_record_link_assignment
 636   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 637 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 638   PARAMS ((bfd *, struct bfd_link_info *));
 639 extern boolean bfd_elf_get_bfd_needed_list
 640   PARAMS ((bfd *, struct bfd_link_needed_list **));
 641 extern boolean bfd_elf32_size_dynamic_sections
 642   PARAMS ((bfd *, const char *, const char *, const char *,
 643            const char * const *, struct bfd_link_info *, struct sec **,
 644            struct bfd_elf_version_tree *));
 645 extern boolean bfd_elf64_size_dynamic_sections
 646   PARAMS ((bfd *, const char *, const char *, const char *,
 647            const char * const *, struct bfd_link_info *, struct sec **,
 648            struct bfd_elf_version_tree *));
 649 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
 650 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
 651 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
 652 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 653   PARAMS ((bfd *, struct bfd_link_info *));
 654 extern boolean bfd_elf32_discard_info
 655   PARAMS ((bfd *, struct bfd_link_info *));
 656 extern boolean bfd_elf64_discard_info
 657   PARAMS ((bfd *, struct bfd_link_info *));
 658
 659 /* Return an upper bound on the number of bytes required to store a
 660    copy of ABFD's program header table entries.  Return -1 if an error
 661    occurs; bfd_get_error will return an appropriate code.  */
 662 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
 663
 664 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 665    will be stored as an array of Elf_Internal_Phdr structures, as
 666    defined in include/elf/internal.h.  To find out how large the
 667    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 668
 669    Return the number of program header table entries read, or -1 if an
 670    error occurs; bfd_get_error will return an appropriate code.  */
 671 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
 672
 673 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 674 extern int bfd_get_arch_size PARAMS ((bfd *));
 675
 676 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
 677 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
 678
 679 extern boolean bfd_m68k_elf32_create_embedded_relocs
 680   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 681            char **));
 682 extern boolean bfd_mips_elf32_create_embedded_relocs
 683   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 684            char **));
 685
 686 /* SunOS shared library support routines for the linker.  */
 687
 688 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 689   PARAMS ((bfd *, struct bfd_link_info *));
 690 extern boolean bfd_sunos_record_link_assignment
 691   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 692 extern boolean bfd_sunos_size_dynamic_sections
 693   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
 694            struct sec **));
 695
 696 /* Linux shared library support routines for the linker.  */
 697
 698 extern boolean bfd_i386linux_size_dynamic_sections
 699   PARAMS ((bfd *, struct bfd_link_info *));
 700 extern boolean bfd_m68klinux_size_dynamic_sections
 701   PARAMS ((bfd *, struct bfd_link_info *));
 702 extern boolean bfd_sparclinux_size_dynamic_sections
 703   PARAMS ((bfd *, struct bfd_link_info *));
 704
 705 /* mmap hacks */
 706
 707 struct _bfd_window_internal;
 708 typedef struct _bfd_window_internal bfd_window_internal;
 709
 710 typedef struct _bfd_window
 711 {
 712   /* What the user asked for.  */
 713   PTR data;
 714   bfd_size_type size;
 715   /* The actual window used by BFD.  Small user-requested read-only
 716      regions sharing a page may share a single window into the object
 717      file.  Read-write versions shouldn't until I've fixed things to
 718      keep track of which portions have been claimed by the
 719      application; don't want to give the same region back when the
 720      application wants two writable copies!  */
 721   struct _bfd_window_internal *i;
 722 }
 723 bfd_window;
 724
 725 extern void bfd_init_window PARAMS ((bfd_window *));
 726 extern void bfd_free_window PARAMS ((bfd_window *));
 727 extern boolean bfd_get_file_window
 728   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
 729
 730 /* XCOFF support routines for the linker.  */
 731
 732 extern boolean bfd_xcoff_link_record_set
 733   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 734            bfd_size_type));
 735 extern boolean bfd_xcoff_import_symbol
 736   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 737            bfd_vma, const char *, const char *, const char *, unsigned int));
 738 extern boolean bfd_xcoff_export_symbol
 739   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *));
 740 extern boolean bfd_xcoff_link_count_reloc
 741   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 742 extern boolean bfd_xcoff_record_link_assignment
 743   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 744 extern boolean bfd_xcoff_size_dynamic_sections
 745   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
 746            unsigned long, unsigned long, unsigned long, boolean,
 747            int, boolean, boolean, struct sec **));
 748 extern boolean bfd_xcoff_link_generate_rtinit
 749   PARAMS ((bfd *, const char *, const char *));
 750
 751 /* Externally visible COFF routines.  */
 752
 753 #if defined(__STDC__) || defined(ALMOST_STDC)
 754 struct internal_syment;
 755 union internal_auxent;
 756 #endif
 757
 758 extern boolean bfd_coff_get_syment
 759   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
 760
 761 extern boolean bfd_coff_get_auxent
 762   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
 763
 764 extern boolean bfd_coff_set_symbol_class
 765   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
 766
 767 extern boolean bfd_m68k_coff_create_embedded_relocs
 768   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 769            char **));
 770
 771 /* ARM Interworking support.  Called from linker.  */
 772 extern boolean bfd_arm_allocate_interworking_sections
 773   PARAMS ((struct bfd_link_info *));
 774
 775 extern boolean bfd_arm_process_before_allocation
 776   PARAMS ((bfd *, struct bfd_link_info *, int));
 777
 778 extern boolean bfd_arm_get_bfd_for_interworking
 779   PARAMS ((bfd *, struct bfd_link_info *));
 780
 781 /* PE ARM Interworking support.  Called from linker.  */
 782 extern boolean bfd_arm_pe_allocate_interworking_sections
 783   PARAMS ((struct bfd_link_info *));
 784
 785 extern boolean bfd_arm_pe_process_before_allocation
 786   PARAMS ((bfd *, struct bfd_link_info *, int));
 787
 788 extern boolean bfd_arm_pe_get_bfd_for_interworking
 789   PARAMS ((bfd *, struct bfd_link_info *));
 790
 791 /* ELF ARM Interworking support.  Called from linker.  */
 792 extern boolean bfd_elf32_arm_allocate_interworking_sections
 793   PARAMS ((struct bfd_link_info *));
 794
 795 extern boolean bfd_elf32_arm_process_before_allocation
 796   PARAMS ((bfd *, struct bfd_link_info *, int));
 797
 798 extern boolean bfd_elf32_arm_get_bfd_for_interworking
 799   PARAMS ((bfd *, struct bfd_link_info *));
 800
 801 /* TI COFF load page support.  */
 802 extern void bfd_ticoff_set_section_load_page
 803   PARAMS ((struct sec *, int));
 804
 805 extern int bfd_ticoff_get_section_load_page
 806   PARAMS ((struct sec *));
 807
 808 /* And more from the source.  */