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