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.  If so, it must
  93    be included first.  -drow */
  94 #if defined (__GNUG__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))
  95 #define TRUE_FALSE_ALREADY_DEFINED
  96 #else
  97 #if defined (__bool_true_false_are_defined)
  98 /* We have <stdbool.h>.  */
  99 #define TRUE_FALSE_ALREADY_DEFINED
 100 #endif
 101 #endif
 102 #ifdef MPW
 103 /* Pre-emptive strike - get the file with the enum.  */
 104 #include <Types.h>
 105 #define TRUE_FALSE_ALREADY_DEFINED
 106 #endif /* MPW */
 107 #ifndef TRUE_FALSE_ALREADY_DEFINED
 108 typedef enum bfd_boolean {false, true} boolean;
 109 #define BFD_TRUE_FALSE
 110 #else
 111 /* Use enum names that will appear nowhere else.  */
 112 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
 113 #endif
 114
 115 /* Support for different sizes of target format ints and addresses.
 116    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
 117    set to 1 above.  Otherwise, if gcc is being used, this code will
 118    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
 119    defined above.  */
 120
 121 #ifndef BFD_HOST_64_BIT
 122 # if BFD_HOST_64BIT_LONG
 123 #  define BFD_HOST_64_BIT long
 124 #  define BFD_HOST_U_64_BIT unsigned long
 125 # else
 126 #  ifdef __GNUC__
 127 #   if __GNUC__ >= 2
 128 #    define BFD_HOST_64_BIT long long
 129 #    define BFD_HOST_U_64_BIT unsigned long long
 130 #   endif /* __GNUC__ >= 2 */
 131 #  endif /* ! defined (__GNUC__) */
 132 # endif /* ! BFD_HOST_64BIT_LONG */
 133 #endif /* ! defined (BFD_HOST_64_BIT) */
 134
 135 #ifdef BFD64
 136
 137 #ifndef BFD_HOST_64_BIT
 138  #error No 64 bit integer type available
 139 #endif /* ! defined (BFD_HOST_64_BIT) */
 140
 141 typedef BFD_HOST_U_64_BIT bfd_vma;
 142 typedef BFD_HOST_64_BIT bfd_signed_vma;
 143 typedef BFD_HOST_U_64_BIT bfd_size_type;
 144 typedef BFD_HOST_U_64_BIT symvalue;
 145
 146 #ifndef fprintf_vma
 147 #if BFD_HOST_64BIT_LONG
 148 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 149 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 150 #else
 151 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 152 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 153 #define fprintf_vma(s,x) \
 154   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 155 #define sprintf_vma(s,x) \
 156   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 157 #endif
 158 #endif
 159
 160 #else /* not BFD64  */
 161
 162 /* Represent a target address.  Also used as a generic unsigned type
 163    which is guaranteed to be big enough to hold any arithmetic types
 164    we need to deal with.  */
 165 typedef unsigned long bfd_vma;
 166
 167 /* A generic signed type which is guaranteed to be big enough to hold any
 168    arithmetic types we need to deal with.  Can be assumed to be compatible
 169    with bfd_vma in the same way that signed and unsigned ints are compatible
 170    (as parameters, in assignment, etc).  */
 171 typedef long bfd_signed_vma;
 172
 173 typedef unsigned long symvalue;
 174 typedef unsigned long bfd_size_type;
 175
 176 /* Print a bfd_vma x on stream s.  */
 177 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
 178 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
 179
 180 #endif /* not BFD64  */
 181
 182 /* A pointer to a position in a file.  */
 183 /* FIXME:  This should be using off_t from <sys/types.h>.
 184    For now, try to avoid breaking stuff by not including <sys/types.h> here.
 185    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
 186    Probably the best long-term answer is to avoid using file_ptr AND off_t
 187    in this header file, and to handle this in the BFD implementation
 188    rather than in its interface.  */
 189 /* typedef off_t        file_ptr; */
 190 typedef bfd_signed_vma file_ptr;
 191 typedef bfd_vma ufile_ptr;
 192
 193 extern void bfd_sprintf_vma PARAMS ((bfd *, char *, bfd_vma));
 194 extern void bfd_fprintf_vma PARAMS ((bfd *, PTR, bfd_vma));
 195
 196 #define printf_vma(x) fprintf_vma(stdout,x)
 197 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 198
 199 typedef unsigned int flagword;  /* 32 bits of flags */
 200 typedef unsigned char bfd_byte;
 201 \f
 202 /* File formats.  */
 203
 204 typedef enum bfd_format
 205 {
 206   bfd_unknown = 0,      /* File format is unknown.  */
 207   bfd_object,           /* Linker/assember/compiler output.  */
 208   bfd_archive,          /* Object archive file.  */
 209   bfd_core,             /* Core dump.  */
 210   bfd_type_end          /* Marks the end; don't use it!  */
 211 }
 212 bfd_format;
 213
 214 /* Values that may appear in the flags field of a BFD.  These also
 215    appear in the object_flags field of the bfd_target structure, where
 216    they indicate the set of flags used by that backend (not all flags
 217    are meaningful for all object file formats) (FIXME: at the moment,
 218    the object_flags values have mostly just been copied from backend
 219    to another, and are not necessarily correct).  */
 220
 221 /* No flags.  */
 222 #define BFD_NO_FLAGS    0x00
 223
 224 /* BFD contains relocation entries.  */
 225 #define HAS_RELOC       0x01
 226
 227 /* BFD is directly executable.  */
 228 #define EXEC_P          0x02
 229
 230 /* BFD has line number information (basically used for F_LNNO in a
 231    COFF header).  */
 232 #define HAS_LINENO      0x04
 233
 234 /* BFD has debugging information.  */
 235 #define HAS_DEBUG       0x08
 236
 237 /* BFD has symbols.  */
 238 #define HAS_SYMS        0x10
 239
 240 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 241    header).  */
 242 #define HAS_LOCALS      0x20
 243
 244 /* BFD is a dynamic object.  */
 245 #define DYNAMIC         0x40
 246
 247 /* Text section is write protected (if D_PAGED is not set, this is
 248    like an a.out NMAGIC file) (the linker sets this by default, but
 249    clears it for -r or -N).  */
 250 #define WP_TEXT         0x80
 251
 252 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 253    linker sets this by default, but clears it for -r or -n or -N).  */
 254 #define D_PAGED         0x100
 255
 256 /* BFD is relaxable (this means that bfd_relax_section may be able to
 257    do something) (sometimes bfd_relax_section can do something even if
 258    this is not set).  */
 259 #define BFD_IS_RELAXABLE 0x200
 260
 261 /* This may be set before writing out a BFD to request using a
 262    traditional format.  For example, this is used to request that when
 263    writing out an a.out object the symbols not be hashed to eliminate
 264    duplicates.  */
 265 #define BFD_TRADITIONAL_FORMAT 0x400
 266
 267 /* This flag indicates that the BFD contents are actually cached in
 268    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
 269 #define BFD_IN_MEMORY 0x800
 270 \f
 271 /* Symbols and relocation.  */
 272
 273 /* A count of carsyms (canonical archive symbols).  */
 274 typedef unsigned long symindex;
 275
 276 /* How to perform a relocation.  */
 277 typedef const struct reloc_howto_struct reloc_howto_type;
 278
 279 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 280
 281 /* General purpose part of a symbol X;
 282    target specific parts are in libcoff.h, libaout.h, etc.  */
 283
 284 #define bfd_get_section(x) ((x)->section)
 285 #define bfd_get_output_section(x) ((x)->section->output_section)
 286 #define bfd_set_section(x,y) ((x)->section) = (y)
 287 #define bfd_asymbol_base(x) ((x)->section->vma)
 288 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 289 #define bfd_asymbol_name(x) ((x)->name)
 290 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 291 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 292 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 293
 294 /* A canonical archive symbol.  */
 295 /* This is a type pun with struct ranlib on purpose!  */
 296 typedef struct carsym
 297 {
 298   char *name;
 299   file_ptr file_offset; /* Look here to find the file.  */
 300 }
 301 carsym;                 /* To make these you call a carsymogen.  */
 302
 303 /* Used in generating armaps (archive tables of contents).
 304    Perhaps just a forward definition would do?  */
 305 struct orl                      /* Output ranlib.  */
 306 {
 307   char **name;          /* Symbol name.  */
 308   union
 309   {
 310     file_ptr pos;
 311     bfd *abfd;
 312   } u;                  /* bfd* or file position.  */
 313   int namidx;           /* Index into string table.  */
 314 };
 315 \f
 316 /* Linenumber stuff.  */
 317 typedef struct lineno_cache_entry
 318 {
 319   unsigned int line_number;     /* Linenumber from start of function.  */
 320   union
 321   {
 322     struct symbol_cache_entry *sym;     /* Function name.  */
 323     bfd_vma offset;                     /* Offset into section.  */
 324   } u;
 325 }
 326 alent;
 327 \f
 328 /* Object and core file sections.  */
 329
 330 #define align_power(addr, align)        \
 331         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 332
 333 typedef struct sec *sec_ptr;
 334
 335 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 336 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 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_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 529
 530 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean) (bool)), true)
 531
 532 extern boolean bfd_cache_close PARAMS ((bfd *abfd));
 533 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 534
 535 extern boolean bfd_record_phdr
 536   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
 537            boolean, boolean, unsigned int, struct sec **));
 538
 539 /* Byte swapping routines.  */
 540
 541 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 542 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 543 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 544 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 545 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 546 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 547 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 548 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 549 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 550 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 551 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 552 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 553 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 554 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 555 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 556 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 557 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 558 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 559
 560 /* Byte swapping routines which take size and endiannes as arguments.  */
 561
 562 bfd_vma         bfd_get_bits       PARAMS ((bfd_byte *, int, boolean));
 563 void            bfd_put_bits       PARAMS ((bfd_vma, bfd_byte *, int, boolean));
 564 \f
 565 /* Externally visible ECOFF routines.  */
 566
 567 #if defined(__STDC__) || defined(ALMOST_STDC)
 568 struct ecoff_debug_info;
 569 struct ecoff_debug_swap;
 570 struct ecoff_extr;
 571 struct symbol_cache_entry;
 572 struct bfd_link_info;
 573 struct bfd_link_hash_entry;
 574 struct bfd_elf_version_tree;
 575 #endif
 576 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
 577 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
 578 extern boolean bfd_ecoff_set_regmasks
 579   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 580            unsigned long *cprmask));
 581 extern PTR bfd_ecoff_debug_init
 582   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 583            const struct ecoff_debug_swap *output_swap,
 584            struct bfd_link_info *));
 585 extern void bfd_ecoff_debug_free
 586   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 587            const struct ecoff_debug_swap *output_swap,
 588            struct bfd_link_info *));
 589 extern boolean bfd_ecoff_debug_accumulate
 590   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 591            const struct ecoff_debug_swap *output_swap,
 592            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 593            const struct ecoff_debug_swap *input_swap,
 594            struct bfd_link_info *));
 595 extern boolean bfd_ecoff_debug_accumulate_other
 596   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 597            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 598            struct bfd_link_info *));
 599 extern boolean bfd_ecoff_debug_externals
 600   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 601            const struct ecoff_debug_swap *swap,
 602            boolean relocateable,
 603            boolean (*get_extr) (struct symbol_cache_entry *,
 604                                 struct ecoff_extr *),
 605            void (*set_index) (struct symbol_cache_entry *,
 606                               bfd_size_type)));
 607 extern boolean bfd_ecoff_debug_one_external
 608   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 609            const struct ecoff_debug_swap *swap,
 610            const char *name, struct ecoff_extr *esym));
 611 extern bfd_size_type bfd_ecoff_debug_size
 612   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 613            const struct ecoff_debug_swap *swap));
 614 extern boolean bfd_ecoff_write_debug
 615   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 616            const struct ecoff_debug_swap *swap, file_ptr where));
 617 extern boolean bfd_ecoff_write_accumulated_debug
 618   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 619            const struct ecoff_debug_swap *swap,
 620            struct bfd_link_info *info, file_ptr where));
 621 extern boolean bfd_mips_ecoff_create_embedded_relocs
 622   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 623            char **));
 624
 625 /* Externally visible ELF routines.  */
 626
 627 struct bfd_link_needed_list
 628 {
 629   struct bfd_link_needed_list *next;
 630   bfd *by;
 631   const char *name;
 632 };
 633
 634 extern boolean bfd_elf32_record_link_assignment
 635   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 636 extern boolean bfd_elf64_record_link_assignment
 637   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 638 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 639   PARAMS ((bfd *, struct bfd_link_info *));
 640 extern boolean bfd_elf_get_bfd_needed_list
 641   PARAMS ((bfd *, struct bfd_link_needed_list **));
 642 extern boolean bfd_elf32_size_dynamic_sections
 643   PARAMS ((bfd *, const char *, const char *, const char *,
 644            const char * const *, struct bfd_link_info *, struct sec **,
 645            struct bfd_elf_version_tree *));
 646 extern boolean bfd_elf64_size_dynamic_sections
 647   PARAMS ((bfd *, const char *, const char *, const char *,
 648            const char * const *, struct bfd_link_info *, struct sec **,
 649            struct bfd_elf_version_tree *));
 650 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
 651 extern void bfd_elf_set_dt_needed_soname PARAMS ((bfd *, const char *));
 652 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
 653 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 654   PARAMS ((bfd *, struct bfd_link_info *));
 655 extern boolean bfd_elf32_discard_info
 656   PARAMS ((bfd *, struct bfd_link_info *));
 657 extern boolean bfd_elf64_discard_info
 658   PARAMS ((bfd *, struct bfd_link_info *));
 659
 660 /* Return an upper bound on the number of bytes required to store a
 661    copy of ABFD's program header table entries.  Return -1 if an error
 662    occurs; bfd_get_error will return an appropriate code.  */
 663 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
 664
 665 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 666    will be stored as an array of Elf_Internal_Phdr structures, as
 667    defined in include/elf/internal.h.  To find out how large the
 668    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 669
 670    Return the number of program header table entries read, or -1 if an
 671    error occurs; bfd_get_error will return an appropriate code.  */
 672 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
 673
 674 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 675 extern int bfd_get_arch_size PARAMS ((bfd *));
 676
 677 /* Return true if address "naturally" sign extends, or -1 if not elf.  */
 678 extern int bfd_get_sign_extend_vma PARAMS ((bfd *));
 679
 680 extern boolean bfd_m68k_elf32_create_embedded_relocs
 681   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 682            char **));
 683 extern boolean bfd_mips_elf32_create_embedded_relocs
 684   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 685            char **));
 686
 687 /* SunOS shared library support routines for the linker.  */
 688
 689 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 690   PARAMS ((bfd *, struct bfd_link_info *));
 691 extern boolean bfd_sunos_record_link_assignment
 692   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 693 extern boolean bfd_sunos_size_dynamic_sections
 694   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
 695            struct sec **));
 696
 697 /* Linux shared library support routines for the linker.  */
 698
 699 extern boolean bfd_i386linux_size_dynamic_sections
 700   PARAMS ((bfd *, struct bfd_link_info *));
 701 extern boolean bfd_m68klinux_size_dynamic_sections
 702   PARAMS ((bfd *, struct bfd_link_info *));
 703 extern boolean bfd_sparclinux_size_dynamic_sections
 704   PARAMS ((bfd *, struct bfd_link_info *));
 705
 706 /* mmap hacks */
 707
 708 struct _bfd_window_internal;
 709 typedef struct _bfd_window_internal bfd_window_internal;
 710
 711 typedef struct _bfd_window
 712 {
 713   /* What the user asked for.  */
 714   PTR data;
 715   bfd_size_type size;
 716   /* The actual window used by BFD.  Small user-requested read-only
 717      regions sharing a page may share a single window into the object
 718      file.  Read-write versions shouldn't until I've fixed things to
 719      keep track of which portions have been claimed by the
 720      application; don't want to give the same region back when the
 721      application wants two writable copies!  */
 722   struct _bfd_window_internal *i;
 723 }
 724 bfd_window;
 725
 726 extern void bfd_init_window PARAMS ((bfd_window *));
 727 extern void bfd_free_window PARAMS ((bfd_window *));
 728 extern boolean bfd_get_file_window
 729   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
 730
 731 /* XCOFF support routines for the linker.  */
 732
 733 extern boolean bfd_xcoff_link_record_set
 734   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 735            bfd_size_type));
 736 extern boolean bfd_xcoff_import_symbol
 737   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 738            bfd_vma, const char *, const char *, const char *, unsigned int));
 739 extern boolean bfd_xcoff_export_symbol
 740   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *));
 741 extern boolean bfd_xcoff_link_count_reloc
 742   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 743 extern boolean bfd_xcoff_record_link_assignment
 744   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 745 extern boolean bfd_xcoff_size_dynamic_sections
 746   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
 747            unsigned long, unsigned long, unsigned long, boolean,
 748            int, boolean, boolean, struct sec **));
 749 extern boolean bfd_xcoff_link_generate_rtinit
 750   PARAMS ((bfd *, const char *, const char *));
 751
 752 /* Externally visible COFF routines.  */
 753
 754 #if defined(__STDC__) || defined(ALMOST_STDC)
 755 struct internal_syment;
 756 union internal_auxent;
 757 #endif
 758
 759 extern boolean bfd_coff_get_syment
 760   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
 761
 762 extern boolean bfd_coff_get_auxent
 763   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
 764
 765 extern boolean bfd_coff_set_symbol_class
 766   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
 767
 768 extern boolean bfd_m68k_coff_create_embedded_relocs
 769   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 770            char **));
 771
 772 /* ARM Interworking support.  Called from linker.  */
 773 extern boolean bfd_arm_allocate_interworking_sections
 774   PARAMS ((struct bfd_link_info *));
 775
 776 extern boolean bfd_arm_process_before_allocation
 777   PARAMS ((bfd *, struct bfd_link_info *, int));
 778
 779 extern boolean bfd_arm_get_bfd_for_interworking
 780   PARAMS ((bfd *, struct bfd_link_info *));
 781
 782 /* PE ARM Interworking support.  Called from linker.  */
 783 extern boolean bfd_arm_pe_allocate_interworking_sections
 784   PARAMS ((struct bfd_link_info *));
 785
 786 extern boolean bfd_arm_pe_process_before_allocation
 787   PARAMS ((bfd *, struct bfd_link_info *, int));
 788
 789 extern boolean bfd_arm_pe_get_bfd_for_interworking
 790   PARAMS ((bfd *, struct bfd_link_info *));
 791
 792 /* ELF ARM Interworking support.  Called from linker.  */
 793 extern boolean bfd_elf32_arm_allocate_interworking_sections
 794   PARAMS ((struct bfd_link_info *));
 795
 796 extern boolean bfd_elf32_arm_process_before_allocation
 797   PARAMS ((bfd *, struct bfd_link_info *, int));
 798
 799 extern boolean bfd_elf32_arm_get_bfd_for_interworking
 800   PARAMS ((bfd *, struct bfd_link_info *));
 801
 802 /* TI COFF load page support.  */
 803 extern void bfd_ticoff_set_section_load_page
 804   PARAMS ((struct sec *, int));
 805
 806 extern int bfd_ticoff_get_section_load_page
 807   PARAMS ((struct sec *));
 808
 809 /* And more from the source.  */