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