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