bfd/bfd-in2.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
   6 ** instead, change bfd-in.h or the other BFD source files processed to
   7 ** generate these files.
   8
   9 This file is part of BFD, the Binary File Descriptor library.
  10
  11 This program is free software; you can redistribute it and/or modify
  12 it under the terms of the GNU General Public License as published by
  13 the Free Software Foundation; either version 2 of the License, or
  14 (at your option) any later version.
  15
  16 This program is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 GNU General Public License for more details.
  20
  21 You should have received a copy of the GNU General Public License
  22 along with this program; if not, write to the Free Software
  23 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  24
  25 /* bfd.h -- The only header file required by users of the bfd library
  26
  27 The bfd.h file is generated from bfd-in.h and various .c files; if you
  28 change it, your changes will probably be lost.
  29
  30 All the prototypes and definitions following the comment "THE FOLLOWING
  31 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  32 BFD.  If you change it, someone oneday will extract it from the source
  33 again, and your changes will be lost.  To save yourself from this bind,
  34 change the definitions in the source in the bfd directory.  Type "make
  35 docs" and then "make headers" in that directory, and magically this file
  36 will change to reflect your changes.
  37
  38 If you don't have the tools to perform the extraction, then you are
  39 safe from someone on your system trampling over your header files.
  40 You should still maintain the equivalence between the source and this
  41 file though; every change you make to the .c file should be reflected
  42 here.  */
  43
  44 #ifndef __BFD_H_SEEN__
  45 #define __BFD_H_SEEN__
  46
  47 #include "ansidecl.h"
  48 #include "obstack.h"
  49
  50 /* These two lines get substitutions done by commands in Makefile.in.  */
  51 #define BFD_VERSION   "@VERSION@"
  52 #define BFD_ARCH_SIZE @WORDSIZE@
  53
  54 #if BFD_ARCH_SIZE >= 64
  55 #define BFD64
  56 #endif
  57
  58 #ifndef INLINE
  59 #if __GNUC__ >= 2
  60 #define INLINE __inline__
  61 #else
  62 #define INLINE
  63 #endif
  64 #endif
  65
  66 /* 64-bit type definition (if any) from bfd's sysdep.h goes here */
  67
  68
  69 /* forward declaration */
  70 typedef struct _bfd bfd;
  71
  72 /* To squelch erroneous compiler warnings ("illegal pointer
  73    combination") from the SVR3 compiler, we would like to typedef
  74    boolean to int (it doesn't like functions which return boolean.
  75    Making sure they are never implicitly declared to return int
  76    doesn't seem to help).  But this file is not configured based on
  77    the host.  */
  78 /* General rules: functions which are boolean return true on success
  79    and false on failure (unless they're a predicate).   -- bfd.doc */
  80 /* I'm sure this is going to break something and someone is going to
  81    force me to change it. */
  82 /* typedef enum boolean {false, true} boolean; */
  83 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  84 /* It gets worse if the host also defines a true/false enum... -sts */
  85 #ifndef TRUE_FALSE_ALREADY_DEFINED
  86 typedef enum bfd_boolean {false, true} boolean;
  87 #define BFD_TRUE_FALSE
  88 #else
  89 typedef enum bfd_boolean {bfd_false, bfd_true} boolean;
  90 #endif
  91
  92 /* A pointer to a position in a file.  */
  93 /* FIXME:  This should be using off_t from <sys/types.h>.
  94    For now, try to avoid breaking stuff by not including <sys/types.h> here.
  95    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
  96    Probably the best long-term answer is to avoid using file_ptr AND off_t
  97    in this header file, and to handle this in the BFD implementation
  98    rather than in its interface.  */
  99 /* typedef off_t        file_ptr; */
 100 typedef long int file_ptr;
 101
 102 /* Support for different sizes of target format ints and addresses.  If the
 103    host implements 64-bit values, it defines BFD_HOST_64_BIT to be the appropriate
 104    type.  Otherwise, this code will fall back on gcc's "long long" type if gcc
 105    is being used.  BFD_HOST_64_BIT must be defined in such a way as to be a valid
 106    type name by itself or with "unsigned" prefixed.  It should be a signed
 107    type by itself.
 108
 109    If neither is the case, then compilation will fail if 64-bit targets are
 110    requested.  If you don't request any 64-bit targets, you should be safe. */
 111
 112 #ifdef  BFD64
 113
 114 #if defined (__GNUC__) && !defined (BFD_HOST_64_BIT)
 115 #define BFD_HOST_64_BIT long long
 116 typedef BFD_HOST_64_BIT int64_type;
 117 typedef unsigned BFD_HOST_64_BIT uint64_type;
 118 #endif
 119
 120 #if !defined (uint64_type) && defined (__GNUC__)
 121 #define uint64_type unsigned long long
 122 #define int64_type long long
 123 #endif
 124 #ifndef uint64_typeLOW
 125 #define uint64_typeLOW(x) ((unsigned long)(((x) & 0xffffffff)))
 126 #define uint64_typeHIGH(x) ((unsigned long)(((x) >> 32) & 0xffffffff))
 127 #endif
 128
 129 typedef unsigned BFD_HOST_64_BIT bfd_vma;
 130 typedef BFD_HOST_64_BIT bfd_signed_vma;
 131 typedef unsigned BFD_HOST_64_BIT bfd_size_type;
 132 typedef unsigned BFD_HOST_64_BIT symvalue;
 133 #ifndef fprintf_vma
 134 #define fprintf_vma(s,x) \
 135                 fprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
 136 #define sprintf_vma(s,x) \
 137                 sprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
 138 #endif
 139 #else /* not BFD64  */
 140
 141 /* Represent a target address.  Also used as a generic unsigned type
 142    which is guaranteed to be big enough to hold any arithmetic types
 143    we need to deal with.  */
 144 typedef unsigned long bfd_vma;
 145
 146 /* A generic signed type which is guaranteed to be big enough to hold any
 147    arithmetic types we need to deal with.  Can be assumed to be compatible
 148    with bfd_vma in the same way that signed and unsigned ints are compatible
 149    (as parameters, in assignment, etc).  */
 150 typedef long bfd_signed_vma;
 151
 152 typedef unsigned long symvalue;
 153 typedef unsigned long bfd_size_type;
 154
 155 /* Print a bfd_vma x on stream s.  */
 156 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 157 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
 158 #endif /* not BFD64  */
 159 #define printf_vma(x) fprintf_vma(stdout,x)
 160
 161 typedef unsigned int flagword;  /* 32 bits of flags */
 162 \f
 163 /** File formats */
 164
 165 typedef enum bfd_format {
 166               bfd_unknown = 0,  /* file format is unknown */
 167               bfd_object,       /* linker/assember/compiler output */
 168               bfd_archive,      /* object archive file */
 169               bfd_core,         /* core dump */
 170               bfd_type_end}     /* marks the end; don't use it! */
 171          bfd_format;
 172
 173 /* Values that may appear in the flags field of a BFD.  These also
 174    appear in the object_flags field of the bfd_target structure, where
 175    they indicate the set of flags used by that backend (not all flags
 176    are meaningful for all object file formats) (FIXME: at the moment,
 177    the object_flags values have mostly just been copied from backend
 178    to another, and are not necessarily correct).  */
 179
 180 /* No flags.  */
 181 #define NO_FLAGS        0x00
 182
 183 /* BFD contains relocation entries.  */
 184 #define HAS_RELOC       0x01
 185
 186 /* BFD is directly executable.  */
 187 #define EXEC_P          0x02
 188
 189 /* BFD has line number information (basically used for F_LNNO in a
 190    COFF header).  */
 191 #define HAS_LINENO      0x04
 192
 193 /* BFD has debugging information.  */
 194 #define HAS_DEBUG       0x08
 195
 196 /* BFD has symbols.  */
 197 #define HAS_SYMS        0x10
 198
 199 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 200    header).  */
 201 #define HAS_LOCALS      0x20
 202
 203 /* BFD is a dynamic object.  */
 204 #define DYNAMIC         0x40
 205
 206 /* Text section is write protected (if D_PAGED is not set, this is
 207    like an a.out NMAGIC file) (the linker sets this by default, but
 208    clears it for -r or -N).  */
 209 #define WP_TEXT         0x80
 210
 211 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 212    linker sets this by default, but clears it for -r or -n or -N).  */
 213 #define D_PAGED         0x100
 214
 215 /* BFD is relaxable (this means that bfd_relax_section may be able to
 216    do something).  */
 217 #define BFD_IS_RELAXABLE 0x200
 218 \f
 219 /* symbols and relocation */
 220
 221 /* A count of carsyms (canonical archive symbols).  */
 222 typedef unsigned long symindex;
 223
 224 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 225
 226 /* General purpose part of a symbol X;
 227    target specific parts are in libcoff.h, libaout.h, etc.  */
 228
 229 #define bfd_get_section(x) ((x)->section)
 230 #define bfd_get_output_section(x) ((x)->section->output_section)
 231 #define bfd_set_section(x,y) ((x)->section) = (y)
 232 #define bfd_asymbol_base(x) ((x)->section->vma)
 233 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 234 #define bfd_asymbol_name(x) ((x)->name)
 235 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 236 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 237 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 238
 239 /* A canonical archive symbol.  */
 240 /* This is a type pun with struct ranlib on purpose! */
 241 typedef struct carsym {
 242   char *name;
 243   file_ptr file_offset;         /* look here to find the file */
 244 } carsym;                       /* to make these you call a carsymogen */
 245
 246
 247 /* Used in generating armaps (archive tables of contents).
 248    Perhaps just a forward definition would do? */
 249 struct orl {                    /* output ranlib */
 250   char **name;                  /* symbol name */
 251   file_ptr pos;                 /* bfd* or file position */
 252   int namidx;                   /* index into string table */
 253 };
 254
 255 \f
 256
 257 /* Linenumber stuff */
 258 typedef struct lineno_cache_entry {
 259   unsigned int line_number;     /* Linenumber from start of function*/
 260   union {
 261     struct symbol_cache_entry *sym; /* Function name */
 262     unsigned long offset;       /* Offset into section */
 263   } u;
 264 } alent;
 265 \f
 266 /* object and core file sections */
 267
 268
 269 #define align_power(addr, align)        \
 270         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 271
 272 typedef struct sec *sec_ptr;
 273
 274 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 275 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 276 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 277 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 278 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 279 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 280 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 281 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 282 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 283
 284 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 285
 286 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 287 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 288 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 289
 290 typedef struct stat stat_type;
 291 \f
 292 typedef enum bfd_print_symbol
 293 {
 294   bfd_print_symbol_name,
 295   bfd_print_symbol_more,
 296   bfd_print_symbol_all
 297 } bfd_print_symbol_type;
 298
 299 /* Information about a symbol that nm needs.  */
 300
 301 typedef struct _symbol_info
 302 {
 303   symvalue value;
 304   char type;
 305   CONST char *name;            /* Symbol name.  */
 306   char stab_other;             /* Unused. */
 307   short stab_desc;             /* Info for N_TYPE.  */
 308   CONST char *stab_name;
 309 } symbol_info;
 310 \f
 311 /* Hash table routines.  There is no way to free up a hash table.  */
 312
 313 /* An element in the hash table.  Most uses will actually use a larger
 314    structure, and an instance of this will be the first field.  */
 315
 316 struct bfd_hash_entry
 317 {
 318   /* Next entry for this hash code.  */
 319   struct bfd_hash_entry *next;
 320   /* String being hashed.  */
 321   const char *string;
 322   /* Hash code.  This is the full hash code, not the index into the
 323      table.  */
 324   unsigned long hash;
 325 };
 326
 327 /* A hash table.  */
 328
 329 struct bfd_hash_table
 330 {
 331   /* The hash array.  */
 332   struct bfd_hash_entry **table;
 333   /* The number of slots in the hash table.  */
 334   unsigned int size;
 335   /* A function used to create new elements in the hash table.  The
 336      first entry is itself a pointer to an element.  When this
 337      function is first invoked, this pointer will be NULL.  However,
 338      having the pointer permits a hierarchy of method functions to be
 339      built each of which calls the function in the superclass.  Thus
 340      each function should be written to allocate a new block of memory
 341      only if the argument is NULL.  */
 342   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
 343                                              struct bfd_hash_table *,
 344                                              const char *));
 345   /* An obstack for this hash table.  */
 346   struct obstack memory;
 347 };
 348
 349 /* Initialize a hash table.  */
 350 extern boolean bfd_hash_table_init
 351   PARAMS ((struct bfd_hash_table *,
 352            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 353                                        struct bfd_hash_table *,
 354                                        const char *)));
 355
 356 /* Initialize a hash table specifying a size.  */
 357 extern boolean bfd_hash_table_init_n
 358   PARAMS ((struct bfd_hash_table *,
 359            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 360                                        struct bfd_hash_table *,
 361                                        const char *),
 362            unsigned int size));
 363
 364 /* Free up a hash table.  */
 365 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
 366
 367 /* Look up a string in a hash table.  If CREATE is true, a new entry
 368    will be created for this string if one does not already exist.  The
 369    COPY argument must be true if this routine should copy the string
 370    into newly allocated memory when adding an entry.  */
 371 extern struct bfd_hash_entry *bfd_hash_lookup
 372   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
 373            boolean copy));
 374
 375 /* Base method for creating a hash table entry.  */
 376 extern struct bfd_hash_entry *bfd_hash_newfunc
 377   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
 378            const char *));
 379
 380 /* Grab some space for a hash table entry.  */
 381 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
 382                                       unsigned int));
 383
 384 /* Traverse a hash table in a random order, calling a function on each
 385    element.  If the function returns false, the traversal stops.  The
 386    INFO argument is passed to the function.  */
 387 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
 388                                        boolean (*) (struct bfd_hash_entry *,
 389                                                     PTR),
 390                                        PTR info));
 391 \f
 392 /* The code that implements targets can initialize a jump table with this
 393    macro.  It must name all its routines the same way (a prefix plus
 394    the standard routine suffix), or it must #define the routines that
 395    are not so named, before calling JUMP_TABLE in the initializer.  */
 396
 397 /* Semi-portable string concatenation in cpp.
 398    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
 399    The problem is, "32_" is not a valid preprocessing token, and we don't
 400    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
 401    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
 402    Then the final concatenation can be done.  (Sigh.)  */
 403 #ifndef CAT
 404 #ifdef SABER
 405 #define CAT(a,b)        a##b
 406 #define CAT3(a,b,c)     a##b##c
 407 #define CAT4(a,b,c,d)   a##b##c##d
 408 #else
 409 #if defined(__STDC__) || defined(ALMOST_STDC)
 410 #define CAT(a,b) a##b
 411 #define CAT3(a,b,c) a##b##c
 412 #define XCAT2(a,b)      CAT(a,b)
 413 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
 414 #else
 415 #define CAT(a,b) a/**/b
 416 #define CAT3(a,b,c) a/**/b/**/c
 417 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
 418 #endif
 419 #endif
 420 #endif
 421
 422 #define JUMP_TABLE(NAME)\
 423 CAT(NAME,_core_file_failing_command),\
 424 CAT(NAME,_core_file_failing_signal),\
 425 CAT(NAME,_core_file_matches_executable_p),\
 426 CAT(NAME,_slurp_armap),\
 427 CAT(NAME,_slurp_extended_name_table),\
 428 CAT(NAME,_truncate_arname),\
 429 CAT(NAME,_write_armap),\
 430 CAT(NAME,_close_and_cleanup),\
 431 CAT(NAME,_set_section_contents),\
 432 CAT(NAME,_get_section_contents),\
 433 CAT(NAME,_new_section_hook),\
 434 CAT(NAME,_bfd_copy_private_section_data),\
 435 CAT(NAME,_bfd_copy_private_bfd_data),\
 436 CAT(NAME,_get_symtab_upper_bound),\
 437 CAT(NAME,_get_symtab),\
 438 CAT(NAME,_get_reloc_upper_bound),\
 439 CAT(NAME,_canonicalize_reloc),\
 440 CAT(NAME,_make_empty_symbol),\
 441 CAT(NAME,_print_symbol),\
 442 CAT(NAME,_get_symbol_info),\
 443 CAT(NAME,_bfd_is_local_label),\
 444 CAT(NAME,_get_lineno),\
 445 CAT(NAME,_set_arch_mach),\
 446 CAT(NAME,_openr_next_archived_file),\
 447 CAT(NAME,_find_nearest_line),\
 448 CAT(NAME,_generic_stat_arch_elt),\
 449 CAT(NAME,_sizeof_headers),\
 450 CAT(NAME,_bfd_debug_info_start),\
 451 CAT(NAME,_bfd_debug_info_end),\
 452 CAT(NAME,_bfd_debug_info_accumulate),\
 453 CAT(NAME,_bfd_get_relocated_section_contents),\
 454 CAT(NAME,_bfd_relax_section),\
 455 CAT(NAME,_bfd_reloc_type_lookup),\
 456 CAT(NAME,_bfd_make_debug_symbol),\
 457 CAT(NAME,_bfd_link_hash_table_create),\
 458 CAT(NAME,_bfd_link_add_symbols),\
 459 CAT(NAME,_bfd_final_link)
 460
 461 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 462
 463 \f
 464 /* User program access to BFD facilities */
 465
 466 /* Cast from const char * to char * so that caller can assign to
 467    a char * without a warning.  */
 468 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 469 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 470 #define bfd_get_format(abfd) ((abfd)->format)
 471 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 472 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 473 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 474 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 475 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 476 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 477 #define bfd_has_map(abfd) ((abfd)->has_armap)
 478
 479 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 480 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 481
 482 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 483 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 484 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 485 #define bfd_count_sections(abfd) ((abfd)->section_count)
 486
 487 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 488
 489 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (bool)), true)
 490
 491 /* Byte swapping routines.  */
 492
 493 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 494 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 495 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 496 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 497 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 498 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 499 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 500 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 501 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 502 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 503 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 504 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 505 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 506 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 507 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 508 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 509 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 510 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 511
 512 /* ECOFF linking routines.  */
 513 #if defined(__STDC__) || defined(ALMOST_STDC)
 514 struct ecoff_debug_info;
 515 struct ecoff_debug_swap;
 516 struct ecoff_extr;
 517 struct symbol_cache_entry;
 518 struct bfd_link_info;
 519 #endif
 520 extern PTR bfd_ecoff_debug_init
 521   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 522            const struct ecoff_debug_swap *output_swap,
 523            struct bfd_link_info *));
 524 extern void bfd_ecoff_debug_free
 525   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 526            const struct ecoff_debug_swap *output_swap,
 527            struct bfd_link_info *));
 528 extern boolean bfd_ecoff_debug_accumulate
 529   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 530            const struct ecoff_debug_swap *output_swap,
 531            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 532            const struct ecoff_debug_swap *input_swap,
 533            struct bfd_link_info *));
 534 extern boolean bfd_ecoff_debug_accumulate_other
 535   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 536            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 537            struct bfd_link_info *));
 538 extern boolean bfd_ecoff_debug_externals
 539   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 540            const struct ecoff_debug_swap *swap,
 541            boolean relocateable,
 542            boolean (*get_extr) (struct symbol_cache_entry *,
 543                                 struct ecoff_extr *),
 544            void (*set_index) (struct symbol_cache_entry *,
 545                               bfd_size_type)));
 546 extern boolean bfd_ecoff_debug_one_external
 547   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 548            const struct ecoff_debug_swap *swap,
 549            const char *name, struct ecoff_extr *esym));
 550 extern bfd_size_type bfd_ecoff_debug_size
 551   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 552            const struct ecoff_debug_swap *swap));
 553 extern boolean bfd_ecoff_write_debug
 554   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 555            const struct ecoff_debug_swap *swap, file_ptr where));
 556 extern boolean bfd_ecoff_write_accumulated_debug
 557   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 558            const struct ecoff_debug_swap *swap,
 559            struct bfd_link_info *info, file_ptr where));
 560
 561 /* And more from the source.  */
 562 void
 563 bfd_init PARAMS ((void));
 564
 565 bfd *
 566 bfd_openr PARAMS ((CONST char *filename, CONST char *target));
 567
 568 bfd *
 569 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
 570
 571 bfd *
 572 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
 573
 574 boolean
 575 bfd_close PARAMS ((bfd *abfd));
 576
 577 boolean
 578 bfd_close_all_done PARAMS ((bfd *));
 579
 580 bfd_size_type
 581 bfd_alloc_size PARAMS ((bfd *abfd));
 582
 583 bfd *
 584 bfd_create PARAMS ((CONST char *filename, bfd *templ));
 585
 586
 587  /* Byte swapping macros for user section data.  */
 588
 589 #define bfd_put_8(abfd, val, ptr) \
 590                 (*((unsigned char *)(ptr)) = (unsigned char)(val))
 591 #define bfd_put_signed_8 \
 592                 bfd_put_8
 593 #define bfd_get_8(abfd, ptr) \
 594                 (*(unsigned char *)(ptr))
 595 #define bfd_get_signed_8(abfd, ptr) \
 596                 ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
 597
 598 #define bfd_put_16(abfd, val, ptr) \
 599                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
 600 #define bfd_put_signed_16 \
 601                  bfd_put_16
 602 #define bfd_get_16(abfd, ptr) \
 603                 BFD_SEND(abfd, bfd_getx16, (ptr))
 604 #define bfd_get_signed_16(abfd, ptr) \
 605                  BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
 606
 607 #define bfd_put_32(abfd, val, ptr) \
 608                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
 609 #define bfd_put_signed_32 \
 610                  bfd_put_32
 611 #define bfd_get_32(abfd, ptr) \
 612                 BFD_SEND(abfd, bfd_getx32, (ptr))
 613 #define bfd_get_signed_32(abfd, ptr) \
 614                  BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
 615
 616 #define bfd_put_64(abfd, val, ptr) \
 617                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
 618 #define bfd_put_signed_64 \
 619                  bfd_put_64
 620 #define bfd_get_64(abfd, ptr) \
 621                 BFD_SEND(abfd, bfd_getx64, (ptr))
 622 #define bfd_get_signed_64(abfd, ptr) \
 623                  BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
 624
 625
 626  /* Byte swapping macros for file header data.  */
 627
 628 #define bfd_h_put_8(abfd, val, ptr) \
 629                 bfd_put_8 (abfd, val, ptr)
 630 #define bfd_h_put_signed_8(abfd, val, ptr) \
 631                 bfd_put_8 (abfd, val, ptr)
 632 #define bfd_h_get_8(abfd, ptr) \
 633                 bfd_get_8 (abfd, ptr)
 634 #define bfd_h_get_signed_8(abfd, ptr) \
 635                 bfd_get_signed_8 (abfd, ptr)
 636
 637 #define bfd_h_put_16(abfd, val, ptr) \
 638                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
 639 #define bfd_h_put_signed_16 \
 640                  bfd_h_put_16
 641 #define bfd_h_get_16(abfd, ptr) \
 642                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
 643 #define bfd_h_get_signed_16(abfd, ptr) \
 644                  BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
 645
 646 #define bfd_h_put_32(abfd, val, ptr) \
 647                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
 648 #define bfd_h_put_signed_32 \
 649                  bfd_h_put_32
 650 #define bfd_h_get_32(abfd, ptr) \
 651                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
 652 #define bfd_h_get_signed_32(abfd, ptr) \
 653                  BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
 654
 655 #define bfd_h_put_64(abfd, val, ptr) \
 656                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
 657 #define bfd_h_put_signed_64 \
 658                  bfd_h_put_64
 659 #define bfd_h_get_64(abfd, ptr) \
 660                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
 661 #define bfd_h_get_signed_64(abfd, ptr) \
 662                  BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
 663
 664 typedef struct sec
 665 {
 666          /* The name of the section; the name isn't a copy, the pointer is
 667         the same as that passed to bfd_make_section. */
 668
 669     CONST char *name;
 670
 671          /* Which section is it; 0..nth.      */
 672
 673    int index;
 674
 675          /* The next section in the list belonging to the BFD, or NULL. */
 676
 677     struct sec *next;
 678
 679          /* The field flags contains attributes of the section. Some
 680            flags are read in from the object file, and some are
 681            synthesized from other information.  */
 682
 683     flagword flags;
 684
 685 #define SEC_NO_FLAGS   0x000
 686
 687          /* Tells the OS to allocate space for this section when loading.
 688            This is clear for a section containing debug information
 689            only. */
 690 #define SEC_ALLOC      0x001
 691
 692          /* Tells the OS to load the section from the file when loading.
 693            This is clear for a .bss section. */
 694 #define SEC_LOAD       0x002
 695
 696          /* The section contains data still to be relocated, so there is
 697            some relocation information too. */
 698 #define SEC_RELOC      0x004
 699
 700 #if 0    /* Obsolete ? */
 701 #define SEC_BALIGN     0x008
 702 #endif
 703
 704          /* A signal to the OS that the section contains read only
 705           data. */
 706 #define SEC_READONLY   0x010
 707
 708          /* The section contains code only. */
 709 #define SEC_CODE       0x020
 710
 711          /* The section contains data only. */
 712 #define SEC_DATA       0x040
 713
 714          /* The section will reside in ROM. */
 715 #define SEC_ROM        0x080
 716
 717          /* The section contains constructor information. This section
 718            type is used by the linker to create lists of constructors and
 719            destructors used by <<g++>>. When a back end sees a symbol
 720            which should be used in a constructor list, it creates a new
 721            section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
 722            the symbol to it, and builds a relocation. To build the lists
 723            of constructors, all the linker has to do is catenate all the
 724            sections called <<__CTOR_LIST__>> and relocate the data
 725            contained within - exactly the operations it would peform on
 726            standard data. */
 727 #define SEC_CONSTRUCTOR 0x100
 728
 729          /* The section is a constuctor, and should be placed at the
 730           end of the text, data, or bss section(?). */
 731 #define SEC_CONSTRUCTOR_TEXT 0x1100
 732 #define SEC_CONSTRUCTOR_DATA 0x2100
 733 #define SEC_CONSTRUCTOR_BSS  0x3100
 734
 735          /* The section has contents - a data section could be
 736            <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
 737            <<SEC_HAS_CONTENTS>> */
 738 #define SEC_HAS_CONTENTS 0x200
 739
 740          /* An instruction to the linker to not output the section
 741           even if it has information which would normally be written. */
 742 #define SEC_NEVER_LOAD 0x400
 743
 744          /* The section is a shared library section.  The linker must leave
 745            these completely alone, as the vma and size are used when
 746            the executable is loaded. */
 747 #define SEC_SHARED_LIBRARY 0x800
 748
 749          /* The section is a common section (symbols may be defined
 750            multiple times, the value of a symbol is the amount of
 751            space it requires, and the largest symbol value is the one
 752            used).  Most targets have exactly one of these (which we
 753             translate to bfd_com_section), but ECOFF has two. */
 754 #define SEC_IS_COMMON 0x8000
 755
 756          /* The section contains only debugging information.  For
 757            example, this is set for ELF .debug and .stab sections.
 758            strip tests this flag to see if a section can be
 759            discarded. */
 760 #define SEC_DEBUGGING 0x10000
 761
 762          /* The contents of this section are held in memory pointed to
 763            by the contents field.  This is checked by
 764            bfd_get_section_contents, and the data is retrieved from
 765            memory if appropriate.  */
 766 #define SEC_IN_MEMORY 0x20000
 767
 768          /*  End of section flags.  */
 769
 770         /*  The virtual memory address of the section - where it will be
 771            at run time.  The symbols are relocated against this.  The
 772             user_set_vma flag is maintained by bfd; if it's not set, the
 773             backend can assign addresses (for example, in <<a.out>>, where
 774             the default address for <<.data>> is dependent on the specific
 775             target and various flags).  */
 776
 777    bfd_vma vma;
 778    boolean user_set_vma;
 779
 780         /*  The load address of the section - where it would be in a
 781            rom image; really only used for writing section header
 782             information. */
 783
 784    bfd_vma lma;
 785
 786          /* The size of the section in bytes, as it will be output.
 787            contains a value even if the section has no contents (e.g., the
 788            size of <<.bss>>). This will be filled in after relocation */
 789
 790    bfd_size_type _cooked_size;
 791
 792          /* The original size on disk of the section, in bytes.  Normally this
 793             value is the same as the size, but if some relaxing has
 794             been done, then this value will be bigger.  */
 795
 796    bfd_size_type _raw_size;
 797
 798          /* If this section is going to be output, then this value is the
 799            offset into the output section of the first byte in the input
 800            section. E.g., if this was going to start at the 100th byte in
 801            the output section, this value would be 100. */
 802
 803    bfd_vma output_offset;
 804
 805          /* The output section through which to map on output. */
 806
 807    struct sec *output_section;
 808
 809          /* The alignment requirement of the section, as an exponent of 2 -
 810            e.g., 3 aligns to 2^3 (or 8). */
 811
 812    unsigned int alignment_power;
 813
 814          /* If an input section, a pointer to a vector of relocation
 815            records for the data in this section. */
 816
 817    struct reloc_cache_entry *relocation;
 818
 819          /* If an output section, a pointer to a vector of pointers to
 820            relocation records for the data in this section. */
 821
 822    struct reloc_cache_entry **orelocation;
 823
 824          /* The number of relocation records in one of the above  */
 825
 826    unsigned reloc_count;
 827
 828          /* Information below is back end specific - and not always used
 829            or updated.  */
 830
 831          /* File position of section data    */
 832
 833    file_ptr filepos;
 834
 835          /* File position of relocation info */
 836
 837    file_ptr rel_filepos;
 838
 839          /* File position of line data       */
 840
 841    file_ptr line_filepos;
 842
 843          /* Pointer to data for applications */
 844
 845    PTR userdata;
 846
 847          /* If the SEC_IN_MEMORY flag is set, this points to the actual
 848            contents.  */
 849    unsigned char *contents;
 850
 851          /* Attached line number information */
 852
 853    alent *lineno;
 854
 855          /* Number of line number records   */
 856
 857    unsigned int lineno_count;
 858
 859          /* When a section is being output, this value changes as more
 860            linenumbers are written out */
 861
 862    file_ptr moving_line_filepos;
 863
 864          /* What the section number is in the target world  */
 865
 866    int target_index;
 867
 868    PTR used_by_bfd;
 869
 870          /* If this is a constructor section then here is a list of the
 871            relocations created to relocate items within it. */
 872
 873    struct relent_chain *constructor_chain;
 874
 875          /* The BFD which owns the section. */
 876
 877    bfd *owner;
 878
 879    boolean reloc_done;
 880           /* A symbol which points at this section only */
 881    struct symbol_cache_entry *symbol;
 882    struct symbol_cache_entry **symbol_ptr_ptr;
 883
 884    struct bfd_link_order *link_order_head;
 885    struct bfd_link_order *link_order_tail;
 886 } asection ;
 887
 888
 889      /* These sections are global, and are managed by BFD.  The application
 890        and target back end are not permitted to change the values in
 891         these sections.  */
 892 #define BFD_ABS_SECTION_NAME "*ABS*"
 893 #define BFD_UND_SECTION_NAME "*UND*"
 894 #define BFD_COM_SECTION_NAME "*COM*"
 895 #define BFD_IND_SECTION_NAME "*IND*"
 896
 897      /* the absolute section */
 898 extern asection bfd_abs_section;
 899      /* Pointer to the undefined section */
 900 extern asection bfd_und_section;
 901      /* Pointer to the common section */
 902 extern asection bfd_com_section;
 903      /* Pointer to the indirect section */
 904 extern asection bfd_ind_section;
 905
 906 extern struct symbol_cache_entry *bfd_abs_symbol;
 907 extern struct symbol_cache_entry *bfd_com_symbol;
 908 extern struct symbol_cache_entry *bfd_und_symbol;
 909 extern struct symbol_cache_entry *bfd_ind_symbol;
 910 #define bfd_get_section_size_before_reloc(section) \
 911      (section->reloc_done ? (abort(),1): (section)->_raw_size)
 912 #define bfd_get_section_size_after_reloc(section) \
 913      ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
 914 asection *
 915 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
 916
 917 asection *
 918 bfd_make_section_old_way PARAMS ((bfd *abfd, CONST char *name));
 919
 920 asection *
 921 bfd_make_section_anyway PARAMS ((bfd *abfd, CONST char *name));
 922
 923 asection *
 924 bfd_make_section PARAMS ((bfd *, CONST char *name));
 925
 926 boolean
 927 bfd_set_section_flags PARAMS ((bfd *abfd, asection *sec, flagword flags));
 928
 929 void
 930 bfd_map_over_sections PARAMS ((bfd *abfd,
 931     void (*func)(bfd *abfd,
 932     asection *sect,
 933     PTR obj),
 934     PTR obj));
 935
 936 boolean
 937 bfd_set_section_size PARAMS ((bfd *abfd, asection *sec, bfd_size_type val));
 938
 939 boolean
 940 bfd_set_section_contents
 941  PARAMS ((bfd *abfd,
 942     asection *section,
 943     PTR data,
 944     file_ptr offset,
 945     bfd_size_type count));
 946
 947 boolean
 948 bfd_get_section_contents
 949  PARAMS ((bfd *abfd, asection *section, PTR location,
 950     file_ptr offset, bfd_size_type count));
 951
 952 boolean
 953 bfd_copy_private_section_data PARAMS ((bfd *ibfd, asection *isec, bfd *obfd, asection *osec));
 954
 955 #define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
 956      BFD_SEND (ibfd, _bfd_copy_private_section_data, \
 957                 (ibfd, isection, obfd, osection))
 958 enum bfd_architecture
 959 {
 960   bfd_arch_unknown,    /* File arch not known */
 961   bfd_arch_obscure,    /* Arch known, not one of these */
 962   bfd_arch_m68k,       /* Motorola 68xxx */
 963   bfd_arch_vax,        /* DEC Vax */
 964   bfd_arch_i960,       /* Intel 960 */
 965      /* The order of the following is important.
 966        lower number indicates a machine type that
 967        only accepts a subset of the instructions
 968        available to machines with higher numbers.
 969        The exception is the "ca", which is
 970        incompatible with all other machines except
 971        "core". */
 972
 973 #define bfd_mach_i960_core      1
 974 #define bfd_mach_i960_ka_sa     2
 975 #define bfd_mach_i960_kb_sb     3
 976 #define bfd_mach_i960_mc        4
 977 #define bfd_mach_i960_xa        5
 978 #define bfd_mach_i960_ca        6
 979
 980   bfd_arch_a29k,       /* AMD 29000 */
 981   bfd_arch_sparc,      /* SPARC */
 982   bfd_arch_mips,       /* MIPS Rxxxx */
 983   bfd_arch_i386,       /* Intel 386 */
 984   bfd_arch_we32k,      /* AT&T WE32xxx */
 985   bfd_arch_tahoe,      /* CCI/Harris Tahoe */
 986   bfd_arch_i860,       /* Intel 860 */
 987   bfd_arch_romp,       /* IBM ROMP PC/RT */
 988   bfd_arch_alliant,    /* Alliant */
 989   bfd_arch_convex,     /* Convex */
 990   bfd_arch_m88k,       /* Motorola 88xxx */
 991   bfd_arch_pyramid,    /* Pyramid Technology */
 992   bfd_arch_h8300,      /* Hitachi H8/300 */
 993 #define bfd_mach_h8300   1
 994 #define bfd_mach_h8300h  2
 995   bfd_arch_powerpc,    /* PowerPC */
 996   bfd_arch_rs6000,     /* IBM RS/6000 */
 997   bfd_arch_hppa,       /* HP PA RISC */
 998   bfd_arch_z8k,        /* Zilog Z8000 */
 999 #define bfd_mach_z8001          1
1000 #define bfd_mach_z8002          2
1001   bfd_arch_h8500,      /* Hitachi H8/500 */
1002   bfd_arch_sh,         /* Hitachi SH */
1003   bfd_arch_alpha,      /* Dec Alpha */
1004   bfd_arch_last
1005   };
1006
1007 typedef struct bfd_arch_info
1008 {
1009   int bits_per_word;
1010   int bits_per_address;
1011   int bits_per_byte;
1012   enum bfd_architecture arch;
1013   long mach;
1014   char *arch_name;
1015   CONST  char *printable_name;
1016   unsigned int section_align_power;
1017   /* true if this is the default machine for the architecture */
1018   boolean the_default;
1019   CONST struct bfd_arch_info * (*compatible)
1020         PARAMS ((CONST struct bfd_arch_info *a,
1021                  CONST struct bfd_arch_info *b));
1022
1023   boolean (*scan) PARAMS ((CONST struct bfd_arch_info *, CONST char *));
1024    /* How to disassemble an instruction, producing a printable
1025      representation on a specified stdio stream.  This isn't
1026      defined for most processors at present, because of the size
1027      of the additional tables it would drag in, and because gdb
1028      wants to use a different interface.  */
1029   unsigned int (*disassemble) PARAMS ((bfd_vma addr, CONST char *data,
1030                                         PTR stream));
1031
1032   struct bfd_arch_info *next;
1033 } bfd_arch_info_type;
1034 CONST char *
1035 bfd_printable_name PARAMS ((bfd *abfd));
1036
1037 bfd_arch_info_type *
1038 bfd_scan_arch PARAMS ((CONST char *string));
1039
1040 CONST bfd_arch_info_type *
1041 bfd_arch_get_compatible PARAMS ((
1042     CONST bfd *abfd,
1043     CONST bfd *bbfd));
1044
1045 void
1046 bfd_set_arch_info PARAMS ((bfd *abfd, bfd_arch_info_type *arg));
1047
1048 enum bfd_architecture
1049 bfd_get_arch PARAMS ((bfd *abfd));
1050
1051 unsigned long
1052 bfd_get_mach PARAMS ((bfd *abfd));
1053
1054 unsigned int
1055 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
1056
1057 unsigned int
1058 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
1059
1060 bfd_arch_info_type *
1061 bfd_get_arch_info PARAMS ((bfd *abfd));
1062
1063 bfd_arch_info_type *
1064 bfd_lookup_arch
1065  PARAMS ((enum bfd_architecture
1066     arch,
1067     long machine));
1068
1069 CONST char *
1070 bfd_printable_arch_mach
1071  PARAMS ((enum bfd_architecture arch, unsigned long machine));
1072
1073 typedef enum bfd_reloc_status
1074 {
1075         /* No errors detected */
1076   bfd_reloc_ok,
1077
1078         /* The relocation was performed, but there was an overflow. */
1079   bfd_reloc_overflow,
1080
1081         /* The address to relocate was not within the section supplied. */
1082   bfd_reloc_outofrange,
1083
1084         /* Used by special functions */
1085   bfd_reloc_continue,
1086
1087         /* Unsupported relocation size requested. */
1088   bfd_reloc_notsupported,
1089
1090         /* Unused */
1091   bfd_reloc_other,
1092
1093         /* The symbol to relocate against was undefined. */
1094   bfd_reloc_undefined,
1095
1096         /* The relocation was performed, but may not be ok - presently
1097           generated only when linking i960 coff files with i960 b.out
1098           symbols.  If this type is returned, the error_message argument
1099           to bfd_perform_relocation will be set.  */
1100   bfd_reloc_dangerous
1101  }
1102  bfd_reloc_status_type;
1103
1104
1105 typedef struct reloc_cache_entry
1106 {
1107         /* A pointer into the canonical table of pointers  */
1108   struct symbol_cache_entry **sym_ptr_ptr;
1109
1110         /* offset in section */
1111   bfd_size_type address;
1112
1113         /* addend for relocation value */
1114   bfd_vma addend;
1115
1116         /* Pointer to how to perform the required relocation */
1117   const struct reloc_howto_struct *howto;
1118
1119 } arelent;
1120 enum complain_overflow
1121 {
1122          /* Do not complain on overflow. */
1123   complain_overflow_dont,
1124
1125          /* Complain if the bitfield overflows, whether it is considered
1126            as signed or unsigned. */
1127   complain_overflow_bitfield,
1128
1129          /* Complain if the value overflows when considered as signed
1130            number. */
1131   complain_overflow_signed,
1132
1133          /* Complain if the value overflows when considered as an
1134            unsigned number. */
1135   complain_overflow_unsigned
1136 };
1137
1138 typedef struct reloc_howto_struct
1139 {
1140         /*  The type field has mainly a documetary use - the back end can
1141            do what it wants with it, though normally the back end's
1142            external idea of what a reloc number is stored
1143            in this field. For example, a PC relative word relocation
1144            in a coff environment has the type 023 - because that's
1145            what the outside world calls a R_PCRWORD reloc. */
1146   unsigned int type;
1147
1148         /*  The value the final relocation is shifted right by. This drops
1149            unwanted data from the relocation.  */
1150   unsigned int rightshift;
1151
1152          /*  The size of the item to be relocated.  This is *not* a
1153             power-of-two measure.  To get the number of bytes operated
1154             on by a type of relocation, use bfd_get_reloc_size.  */
1155   int size;
1156
1157         /*  The number of bits in the item to be relocated.  This is used
1158             when doing overflow checking.  */
1159   unsigned int bitsize;
1160
1161         /*  Notes that the relocation is relative to the location in the
1162            data section of the addend. The relocation function will
1163            subtract from the relocation value the address of the location
1164            being relocated. */
1165   boolean pc_relative;
1166
1167          /*  The bit position of the reloc value in the destination.
1168             The relocated value is left shifted by this amount. */
1169   unsigned int bitpos;
1170
1171          /* What type of overflow error should be checked for when
1172            relocating. */
1173   enum complain_overflow complain_on_overflow;
1174
1175         /* If this field is non null, then the supplied function is
1176           called rather than the normal function. This allows really
1177           strange relocation methods to be accomodated (e.g., i960 callj
1178           instructions). */
1179   bfd_reloc_status_type (*special_function)
1180                                     PARAMS ((bfd *abfd,
1181                                              arelent *reloc_entry,
1182                                             struct symbol_cache_entry *symbol,
1183                                             PTR data,
1184                                             asection *input_section,
1185                                             bfd *output_bfd,
1186                                             char **error_message));
1187
1188         /* The textual name of the relocation type. */
1189   char *name;
1190
1191         /* When performing a partial link, some formats must modify the
1192           relocations rather than the data - this flag signals this.*/
1193   boolean partial_inplace;
1194
1195         /* The src_mask selects which parts of the read in data
1196           are to be used in the relocation sum.  E.g., if this was an 8 bit
1197           bit of data which we read and relocated, this would be
1198           0x000000ff. When we have relocs which have an addend, such as
1199           sun4 extended relocs, the value in the offset part of a
1200           relocating field is garbage so we never use it. In this case
1201           the mask would be 0x00000000. */
1202   bfd_vma src_mask;
1203
1204         /* The dst_mask selects which parts of the instruction are replaced
1205           into the instruction. In most cases src_mask == dst_mask,
1206           except in the above special case, where dst_mask would be
1207           0x000000ff, and src_mask would be 0x00000000.   */
1208   bfd_vma dst_mask;
1209
1210         /* When some formats create PC relative instructions, they leave
1211           the value of the pc of the place being relocated in the offset
1212           slot of the instruction, so that a PC relative relocation can
1213           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1214           Some formats leave the displacement part of an instruction
1215           empty (e.g., m88k bcs); this flag signals the fact.*/
1216   boolean pcrel_offset;
1217
1218 } reloc_howto_type;
1219 #define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1220   {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1221 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
1222
1223 #define HOWTO_PREPARE(relocation, symbol)      \
1224   {                                            \
1225   if (symbol != (asymbol *)NULL) {             \
1226     if (bfd_is_com_section (symbol->section)) { \
1227       relocation = 0;                          \
1228     }                                          \
1229     else {                                     \
1230       relocation = symbol->value;              \
1231     }                                          \
1232   }                                            \
1233 }
1234 int
1235 bfd_get_reloc_size  PARAMS ((const reloc_howto_type *));
1236
1237 typedef unsigned char bfd_byte;
1238
1239 typedef struct relent_chain {
1240   arelent relent;
1241   struct   relent_chain *next;
1242 } arelent_chain;
1243 bfd_reloc_status_type
1244
1245 bfd_perform_relocation
1246  PARAMS ((bfd *abfd,
1247     arelent *reloc_entry,
1248     PTR data,
1249     asection *input_section,
1250     bfd *output_bfd,
1251     char **error_message));
1252
1253 typedef enum bfd_reloc_code_real
1254 {
1255    /* Basic absolute relocations */
1256   BFD_RELOC_64,
1257   BFD_RELOC_32,
1258   BFD_RELOC_26,
1259   BFD_RELOC_16,
1260   BFD_RELOC_14,
1261   BFD_RELOC_8,
1262
1263    /* PC-relative relocations */
1264   BFD_RELOC_64_PCREL,
1265   BFD_RELOC_32_PCREL,
1266   BFD_RELOC_24_PCREL,     /* used by i960 */
1267   BFD_RELOC_16_PCREL,
1268   BFD_RELOC_8_PCREL,
1269
1270    /* Linkage-table relative */
1271   BFD_RELOC_32_BASEREL,
1272   BFD_RELOC_16_BASEREL,
1273   BFD_RELOC_8_BASEREL,
1274
1275    /* The type of reloc used to build a contructor table - at the moment
1276      probably a 32 bit wide abs address, but the cpu can choose. */
1277   BFD_RELOC_CTOR,
1278
1279    /* 8 bits wide, but used to form an address like 0xffnn */
1280   BFD_RELOC_8_FFnn,
1281
1282    /* 32-bit pc-relative, shifted right 2 bits (i.e., 30-bit
1283      word displacement, e.g. for SPARC) */
1284   BFD_RELOC_32_PCREL_S2,
1285    /* signed 16-bit pc-relative, shifted right 2 bits (e.g. for MIPS) */
1286   BFD_RELOC_16_PCREL_S2,
1287    /* this is used on the Alpha */
1288   BFD_RELOC_23_PCREL_S2,
1289
1290    /* High 22 bits of 32-bit value, placed into lower 22 bits of
1291      target word; simple reloc.  */
1292   BFD_RELOC_HI22,
1293    /* Low 10 bits.  */
1294   BFD_RELOC_LO10,
1295
1296    /* For systems that allocate a Global Pointer register, these are
1297      displacements off that register.  These relocation types are
1298      handled specially, because the value the register will have is
1299      decided relatively late.  */
1300   BFD_RELOC_GPREL16,
1301   BFD_RELOC_GPREL32,
1302
1303    /* Reloc types used for i960/b.out.  */
1304   BFD_RELOC_I960_CALLJ,
1305
1306    /* now for the sparc/elf codes */
1307   BFD_RELOC_NONE,                /* actually used */
1308   BFD_RELOC_SPARC_WDISP22,
1309   BFD_RELOC_SPARC22,
1310   BFD_RELOC_SPARC13,
1311   BFD_RELOC_SPARC_GOT10,
1312   BFD_RELOC_SPARC_GOT13,
1313   BFD_RELOC_SPARC_GOT22,
1314   BFD_RELOC_SPARC_PC10,
1315   BFD_RELOC_SPARC_PC22,
1316   BFD_RELOC_SPARC_WPLT30,
1317   BFD_RELOC_SPARC_COPY,
1318   BFD_RELOC_SPARC_GLOB_DAT,
1319   BFD_RELOC_SPARC_JMP_SLOT,
1320   BFD_RELOC_SPARC_RELATIVE,
1321   BFD_RELOC_SPARC_UA32,
1322
1323    /* these are a.out specific? */
1324   BFD_RELOC_SPARC_BASE13,
1325   BFD_RELOC_SPARC_BASE22,
1326
1327    /* start-sanitize-v9 */
1328   BFD_RELOC_SPARC_10,
1329   BFD_RELOC_SPARC_11,
1330 #define  BFD_RELOC_SPARC_64 BFD_RELOC_64
1331   BFD_RELOC_SPARC_OLO10,
1332   BFD_RELOC_SPARC_HH22,
1333   BFD_RELOC_SPARC_HM10,
1334   BFD_RELOC_SPARC_LM22,
1335   BFD_RELOC_SPARC_PC_HH22,
1336   BFD_RELOC_SPARC_PC_HM10,
1337   BFD_RELOC_SPARC_PC_LM22,
1338   BFD_RELOC_SPARC_WDISP16,
1339   BFD_RELOC_SPARC_WDISP19,
1340   BFD_RELOC_SPARC_GLOB_JMP,
1341   BFD_RELOC_SPARC_LO7,
1342    /* end-sanitize-v9 */
1343
1344    /* Alpha ECOFF relocations.  Some of these treat the symbol or "addend"
1345      in some special way.  */
1346    /* For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1347      writing; when reading, it will be the absolute section symbol.  The
1348      addend is the displacement in bytes of the "lda" instruction from
1349      the "ldah" instruction (which is at the address of this reloc).  */
1350   BFD_RELOC_ALPHA_GPDISP_HI16,
1351    /* For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1352      with GPDISP_HI16 relocs.  The addend is ignored when writing the
1353      relocations out, and is filled in with the file's GP value on
1354      reading, for convenience.  */
1355   BFD_RELOC_ALPHA_GPDISP_LO16,
1356
1357    /* The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1358      the assembler turns it into a LDQ instruction to load the address of
1359      the symbol, and then fills in a register in the real instruction.
1360
1361      The LITERAL reloc, at the LDQ instruction, refers to the .lita
1362      section symbol.  The addend is ignored when writing, but is filled
1363      in with the file's GP value on reading, for convenience, as with the
1364      GPDISP_LO16 reloc.
1365
1366      The LITUSE reloc, on the instruction using the loaded address, gives
1367      information to the linker that it might be able to use to optimize
1368      away some literal section references.  The symbol is ignored (read
1369      as the absolute section symbol), and the "addend" indicates the type
1370      of instruction using the register:
1371               1 - "memory" fmt insn
1372               2 - byte-manipulation (byte offset reg)
1373               3 - jsr (target of branch)
1374
1375      The GNU linker currently doesn't do any of this optimizing.  */
1376   BFD_RELOC_ALPHA_LITERAL,
1377   BFD_RELOC_ALPHA_LITUSE,
1378
1379    /* The HINT relocation indicates a value that should be filled into the
1380      "hint" field of a jmp/jsr/ret instruction, for possible branch-
1381      prediction logic which may be provided on some processors.  */
1382   BFD_RELOC_ALPHA_HINT,
1383
1384    /* Bits 27..2 of the relocation address shifted right 2 bits;
1385      simple reloc otherwise.  */
1386   BFD_RELOC_MIPS_JMP,
1387
1388    /* High 16 bits of 32-bit value; simple reloc.  */
1389   BFD_RELOC_HI16,
1390    /* High 16 bits of 32-bit value but the low 16 bits will be sign
1391      extended and added to form the final result.  If the low 16
1392      bits form a negative number, we need to add one to the high value
1393      to compensate for the borrow when the low bits are added.  */
1394   BFD_RELOC_HI16_S,
1395    /* Low 16 bits.  */
1396   BFD_RELOC_LO16,
1397
1398    /* relocation relative to the global pointer.  */
1399 #define BFD_RELOC_MIPS_GPREL BFD_RELOC_GPREL16
1400
1401    /* Relocation against a MIPS literal section.  */
1402   BFD_RELOC_MIPS_LITERAL,
1403
1404    /* MIPS ELF relocations.  */
1405   BFD_RELOC_MIPS_GOT16,
1406   BFD_RELOC_MIPS_CALL16,
1407 #define BFD_RELOC_MIPS_GPREL32 BFD_RELOC_GPREL32
1408
1409    /* These are, so far, specific to HPPA processors.  I'm not sure that some
1410      don't duplicate other reloc types, such as BFD_RELOC_32 and _32_PCREL.
1411      Also, many more were in the list I got that don't fit in well in the
1412      model BFD uses, so I've omitted them for now.  If we do make this reloc
1413      type get used for code that really does implement the funky reloc types,
1414      they'll have to be added to this list.  */
1415   BFD_RELOC_HPPA_32,
1416   BFD_RELOC_HPPA_11,
1417   BFD_RELOC_HPPA_14,
1418   BFD_RELOC_HPPA_17,
1419
1420   BFD_RELOC_HPPA_L21,
1421   BFD_RELOC_HPPA_R11,
1422   BFD_RELOC_HPPA_R14,
1423   BFD_RELOC_HPPA_R17,
1424   BFD_RELOC_HPPA_LS21,
1425   BFD_RELOC_HPPA_RS11,
1426   BFD_RELOC_HPPA_RS14,
1427   BFD_RELOC_HPPA_RS17,
1428   BFD_RELOC_HPPA_LD21,
1429   BFD_RELOC_HPPA_RD11,
1430   BFD_RELOC_HPPA_RD14,
1431   BFD_RELOC_HPPA_RD17,
1432   BFD_RELOC_HPPA_LR21,
1433   BFD_RELOC_HPPA_RR14,
1434   BFD_RELOC_HPPA_RR17,
1435
1436   BFD_RELOC_HPPA_GOTOFF_11,
1437   BFD_RELOC_HPPA_GOTOFF_14,
1438   BFD_RELOC_HPPA_GOTOFF_L21,
1439   BFD_RELOC_HPPA_GOTOFF_R11,
1440   BFD_RELOC_HPPA_GOTOFF_R14,
1441   BFD_RELOC_HPPA_GOTOFF_LS21,
1442   BFD_RELOC_HPPA_GOTOFF_RS11,
1443   BFD_RELOC_HPPA_GOTOFF_RS14,
1444   BFD_RELOC_HPPA_GOTOFF_LD21,
1445   BFD_RELOC_HPPA_GOTOFF_RD11,
1446   BFD_RELOC_HPPA_GOTOFF_RD14,
1447   BFD_RELOC_HPPA_GOTOFF_LR21,
1448   BFD_RELOC_HPPA_GOTOFF_RR14,
1449
1450   BFD_RELOC_HPPA_DLT_32,
1451   BFD_RELOC_HPPA_DLT_11,
1452   BFD_RELOC_HPPA_DLT_14,
1453   BFD_RELOC_HPPA_DLT_L21,
1454   BFD_RELOC_HPPA_DLT_R11,
1455   BFD_RELOC_HPPA_DLT_R14,
1456
1457   BFD_RELOC_HPPA_ABS_CALL_11,
1458   BFD_RELOC_HPPA_ABS_CALL_14,
1459   BFD_RELOC_HPPA_ABS_CALL_17,
1460   BFD_RELOC_HPPA_ABS_CALL_L21,
1461   BFD_RELOC_HPPA_ABS_CALL_R11,
1462   BFD_RELOC_HPPA_ABS_CALL_R14,
1463   BFD_RELOC_HPPA_ABS_CALL_R17,
1464   BFD_RELOC_HPPA_ABS_CALL_LS21,
1465   BFD_RELOC_HPPA_ABS_CALL_RS11,
1466   BFD_RELOC_HPPA_ABS_CALL_RS14,
1467   BFD_RELOC_HPPA_ABS_CALL_RS17,
1468   BFD_RELOC_HPPA_ABS_CALL_LD21,
1469   BFD_RELOC_HPPA_ABS_CALL_RD11,
1470   BFD_RELOC_HPPA_ABS_CALL_RD14,
1471   BFD_RELOC_HPPA_ABS_CALL_RD17,
1472   BFD_RELOC_HPPA_ABS_CALL_LR21,
1473   BFD_RELOC_HPPA_ABS_CALL_RR14,
1474   BFD_RELOC_HPPA_ABS_CALL_RR17,
1475
1476   BFD_RELOC_HPPA_PCREL_CALL_11,
1477   BFD_RELOC_HPPA_PCREL_CALL_12,
1478   BFD_RELOC_HPPA_PCREL_CALL_14,
1479   BFD_RELOC_HPPA_PCREL_CALL_17,
1480   BFD_RELOC_HPPA_PCREL_CALL_L21,
1481   BFD_RELOC_HPPA_PCREL_CALL_R11,
1482   BFD_RELOC_HPPA_PCREL_CALL_R14,
1483   BFD_RELOC_HPPA_PCREL_CALL_R17,
1484   BFD_RELOC_HPPA_PCREL_CALL_LS21,
1485   BFD_RELOC_HPPA_PCREL_CALL_RS11,
1486   BFD_RELOC_HPPA_PCREL_CALL_RS14,
1487   BFD_RELOC_HPPA_PCREL_CALL_RS17,
1488   BFD_RELOC_HPPA_PCREL_CALL_LD21,
1489   BFD_RELOC_HPPA_PCREL_CALL_RD11,
1490   BFD_RELOC_HPPA_PCREL_CALL_RD14,
1491   BFD_RELOC_HPPA_PCREL_CALL_RD17,
1492   BFD_RELOC_HPPA_PCREL_CALL_LR21,
1493   BFD_RELOC_HPPA_PCREL_CALL_RR14,
1494   BFD_RELOC_HPPA_PCREL_CALL_RR17,
1495
1496   BFD_RELOC_HPPA_PLABEL_32,
1497   BFD_RELOC_HPPA_PLABEL_11,
1498   BFD_RELOC_HPPA_PLABEL_14,
1499   BFD_RELOC_HPPA_PLABEL_L21,
1500   BFD_RELOC_HPPA_PLABEL_R11,
1501   BFD_RELOC_HPPA_PLABEL_R14,
1502
1503   BFD_RELOC_HPPA_UNWIND_ENTRY,
1504   BFD_RELOC_HPPA_UNWIND_ENTRIES,
1505
1506    /* i386/elf relocations */
1507   BFD_RELOC_386_GOT32,
1508   BFD_RELOC_386_PLT32,
1509   BFD_RELOC_386_COPY,
1510   BFD_RELOC_386_GLOB_DAT,
1511   BFD_RELOC_386_JUMP_SLOT,
1512   BFD_RELOC_386_RELATIVE,
1513   BFD_RELOC_386_GOTOFF,
1514   BFD_RELOC_386_GOTPC,
1515
1516    /* PowerPC/POWER (RS/6000) relocs.  */
1517    /* 26 bit relative branch.  Low two bits must be zero.  High 24
1518      bits installed in bits 6 through 29 of instruction.  */
1519   BFD_RELOC_PPC_B26,
1520    /* 26 bit absolute branch, like BFD_RELOC_PPC_B26 but absolute.  */
1521   BFD_RELOC_PPC_BA26,
1522    /* 16 bit TOC relative reference.  */
1523   BFD_RELOC_PPC_TOC16,
1524
1525    /* this must be the highest numeric value */
1526   BFD_RELOC_UNUSED
1527  } bfd_reloc_code_real_type;
1528 const struct reloc_howto_struct *
1529
1530 bfd_reloc_type_lookup  PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
1531
1532
1533 typedef struct symbol_cache_entry
1534 {
1535          /* A pointer to the BFD which owns the symbol. This information
1536            is necessary so that a back end can work out what additional
1537            information (invisible to the application writer) is carried
1538            with the symbol.
1539
1540            This field is *almost* redundant, since you can use section->owner
1541            instead, except that some symbols point to the global sections
1542            bfd_{abs,com,und}_section.  This could be fixed by making
1543            these globals be per-bfd (or per-target-flavor).  FIXME. */
1544
1545   struct _bfd *the_bfd;  /* Use bfd_asymbol_bfd(sym) to access this field. */
1546
1547          /* The text of the symbol. The name is left alone, and not copied; the
1548            application may not alter it. */
1549   CONST char *name;
1550
1551          /* The value of the symbol.  This really should be a union of a
1552           numeric value with a pointer, since some flags indicate that
1553           a pointer to another symbol is stored here.  */
1554   symvalue value;
1555
1556          /* Attributes of a symbol: */
1557
1558 #define BSF_NO_FLAGS    0x00
1559
1560          /* The symbol has local scope; <<static>> in <<C>>. The value
1561            is the offset into the section of the data. */
1562 #define BSF_LOCAL       0x01
1563
1564          /* The symbol has global scope; initialized data in <<C>>. The
1565            value is the offset into the section of the data. */
1566 #define BSF_GLOBAL      0x02
1567
1568          /* The symbol has global scope and is exported. The value is
1569            the offset into the section of the data. */
1570 #define BSF_EXPORT      BSF_GLOBAL  /* no real difference */
1571
1572          /* A normal C symbol would be one of:
1573            <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
1574            <<BSF_GLOBAL>> */
1575
1576          /* The symbol is a debugging record. The value has an arbitary
1577            meaning. */
1578 #define BSF_DEBUGGING   0x08
1579
1580          /* The symbol denotes a function entry point.  Used in ELF,
1581            perhaps others someday.  */
1582 #define BSF_FUNCTION    0x10
1583
1584          /* Used by the linker. */
1585 #define BSF_KEEP        0x20
1586 #define BSF_KEEP_G      0x40
1587
1588          /* A weak global symbol, overridable without warnings by
1589            a regular global symbol of the same name.  */
1590 #define BSF_WEAK        0x80
1591
1592         /* This symbol was created to point to a section, e.g. ELF's
1593            STT_SECTION symbols.  */
1594 #define BSF_SECTION_SYM 0x100
1595
1596          /* The symbol used to be a common symbol, but now it is
1597            allocated. */
1598 #define BSF_OLD_COMMON  0x200
1599
1600          /* The default value for common data. */
1601 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1602
1603          /* In some files the type of a symbol sometimes alters its
1604            location in an output file - ie in coff a <<ISFCN>> symbol
1605            which is also <<C_EXT>> symbol appears where it was
1606            declared and not at the end of a section.  This bit is set
1607            by the target BFD part to convey this information. */
1608
1609 #define BSF_NOT_AT_END    0x400
1610
1611          /* Signal that the symbol is the label of constructor section. */
1612 #define BSF_CONSTRUCTOR   0x800
1613
1614          /* Signal that the symbol is a warning symbol. If the symbol
1615            is a warning symbol, then the value field (I know this is
1616            tacky) will point to the asymbol which when referenced will
1617            cause the warning. */
1618 #define BSF_WARNING       0x1000
1619
1620          /* Signal that the symbol is indirect. The value of the symbol
1621            is a pointer to an undefined asymbol which contains the
1622            name to use instead. */
1623 #define BSF_INDIRECT      0x2000
1624
1625          /* BSF_FILE marks symbols that contain a file name.  This is used
1626            for ELF STT_FILE symbols.  */
1627 #define BSF_FILE          0x4000
1628
1629          /* Symbol is from dynamic linking information.  */
1630 #define BSF_DYNAMIC        0x8000
1631
1632   flagword flags;
1633
1634          /* A pointer to the section to which this symbol is
1635            relative.  This will always be non NULL, there are special
1636           sections for undefined and absolute symbols */
1637   struct sec *section;
1638
1639          /* Back end special data. This is being phased out in favour
1640            of making this a union. */
1641   PTR udata;
1642
1643 } asymbol;
1644 #define bfd_get_symtab_upper_bound(abfd) \
1645      BFD_SEND (abfd, _bfd_get_symtab_upper_bound, (abfd))
1646 boolean
1647 bfd_is_local_label PARAMS ((bfd *abfd, asymbol *sym));
1648
1649 #define bfd_is_local_label(abfd, sym) \
1650      BFD_SEND (abfd, _bfd_is_local_label,(abfd, sym))
1651 #define bfd_canonicalize_symtab(abfd, location) \
1652      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1653                   (abfd, location))
1654 boolean
1655 bfd_set_symtab  PARAMS ((bfd *abfd, asymbol **location, unsigned int count));
1656
1657 void
1658 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
1659
1660 #define bfd_make_empty_symbol(abfd) \
1661      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1662 #define bfd_make_debug_symbol(abfd,ptr,size) \
1663         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
1664 int
1665 bfd_decode_symclass PARAMS ((asymbol *symbol));
1666
1667 void
1668 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
1669
1670 struct _bfd
1671 {
1672      /* The filename the application opened the BFD with.  */
1673     CONST char *filename;
1674
1675      /* A pointer to the target jump table.             */
1676     struct bfd_target *xvec;
1677
1678      /* To avoid dragging too many header files into every file that
1679        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1680        *", and MTIME as a "long".  Their correct types, to which they
1681        are cast when used, are "FILE *" and "time_t".    The iostream
1682        is the result of an fopen on the filename. */
1683     char *iostream;
1684
1685      /* Is the file descriptor being cached?  That is, can it be closed as
1686        needed, and re-opened when accessed later?  */
1687
1688     boolean cacheable;
1689
1690      /* Marks whether there was a default target specified when the
1691        BFD was opened. This is used to select which matching algorithm
1692        to use to choose the back end. */
1693
1694     boolean target_defaulted;
1695
1696      /* The caching routines use these to maintain a
1697        least-recently-used list of BFDs */
1698
1699     struct _bfd *lru_prev, *lru_next;
1700
1701      /* When a file is closed by the caching routines, BFD retains
1702        state information on the file here: */
1703
1704     file_ptr where;
1705
1706      /* and here: (``once'' means at least once) */
1707
1708     boolean opened_once;
1709
1710      /* Set if we have a locally maintained mtime value, rather than
1711        getting it from the file each time: */
1712
1713     boolean mtime_set;
1714
1715      /* File modified time, if mtime_set is true: */
1716
1717     long mtime;
1718
1719      /* Reserved for an unimplemented file locking extension.*/
1720
1721     int ifd;
1722
1723      /* The format which belongs to the BFD. (object, core, etc.) */
1724
1725     bfd_format format;
1726
1727      /* The direction the BFD was opened with*/
1728
1729     enum bfd_direction {no_direction = 0,
1730                         read_direction = 1,
1731                         write_direction = 2,
1732                         both_direction = 3} direction;
1733
1734      /* Format_specific flags*/
1735
1736     flagword flags;
1737
1738      /* Currently my_archive is tested before adding origin to
1739        anything. I believe that this can become always an add of
1740        origin, with origin set to 0 for non archive files.   */
1741
1742     file_ptr origin;
1743
1744      /* Remember when output has begun, to stop strange things
1745        from happening. */
1746     boolean output_has_begun;
1747
1748      /* Pointer to linked list of sections*/
1749     struct sec  *sections;
1750
1751      /* The number of sections */
1752     unsigned int section_count;
1753
1754      /* Stuff only useful for object files:
1755        The start address. */
1756     bfd_vma start_address;
1757
1758      /* Used for input and output*/
1759     unsigned int symcount;
1760
1761      /* Symbol table for output BFD (with symcount entries) */
1762     struct symbol_cache_entry  **outsymbols;
1763
1764      /* Pointer to structure which contains architecture information*/
1765     struct bfd_arch_info *arch_info;
1766
1767      /* Stuff only useful for archives:*/
1768     PTR arelt_data;
1769     struct _bfd *my_archive;      /* The containing archive BFD.  */
1770     struct _bfd *next;            /* The next BFD in the archive.  */
1771     struct _bfd *archive_head;    /* The first BFD in the archive.  */
1772     boolean has_armap;
1773
1774      /* A chain of BFD structures involved in a link.  */
1775     struct _bfd *link_next;
1776
1777      /* A field used by _bfd_generic_link_add_archive_symbols.  This will
1778        be used only for archive elements.  */
1779     int archive_pass;
1780
1781      /* Used by the back end to hold private data. */
1782
1783     union
1784       {
1785       struct aout_data_struct *aout_data;
1786       struct artdata *aout_ar_data;
1787       struct _oasys_data *oasys_obj_data;
1788       struct _oasys_ar_data *oasys_ar_data;
1789       struct coff_tdata *coff_obj_data;
1790       struct ecoff_tdata *ecoff_obj_data;
1791       struct ieee_data_struct *ieee_data;
1792       struct ieee_ar_data_struct *ieee_ar_data;
1793       struct srec_data_struct *srec_data;
1794       struct tekhex_data_struct *tekhex_data;
1795       struct elf_obj_tdata *elf_obj_data;
1796       struct nlm_obj_tdata *nlm_obj_data;
1797       struct bout_data_struct *bout_data;
1798       struct sun_core_struct *sun_core_data;
1799       struct trad_core_struct *trad_core_data;
1800       struct som_data_struct *som_data;
1801       struct hpux_core_struct *hpux_core_data;
1802       struct hppabsd_core_struct *hppabsd_core_data;
1803       struct sgi_core_struct *sgi_core_data;
1804       struct lynx_core_struct *lynx_core_data;
1805       struct osf_core_struct *osf_core_data;
1806       struct cisco_core_struct *cisco_core_data;
1807       PTR any;
1808       } tdata;
1809
1810      /* Used by the application to hold private data*/
1811     PTR usrdata;
1812
1813      /* Where all the allocated stuff under this BFD goes */
1814     struct obstack memory;
1815 };
1816
1817 typedef enum bfd_error
1818 {
1819   bfd_error_no_error = 0,
1820   bfd_error_system_call,
1821   bfd_error_invalid_target,
1822   bfd_error_wrong_format,
1823   bfd_error_invalid_operation,
1824   bfd_error_no_memory,
1825   bfd_error_no_symbols,
1826   bfd_error_no_more_archived_files,
1827   bfd_error_malformed_archive,
1828   bfd_error_file_not_recognized,
1829   bfd_error_file_ambiguously_recognized,
1830   bfd_error_no_contents,
1831   bfd_error_nonrepresentable_section,
1832   bfd_error_no_debug_section,
1833   bfd_error_bad_value,
1834   bfd_error_file_truncated,
1835   bfd_error_invalid_error_code
1836 } bfd_error_type;
1837
1838 bfd_error_type
1839 bfd_get_error  PARAMS ((void));
1840
1841 void
1842 bfd_set_error  PARAMS ((bfd_error_type error_tag));
1843
1844 CONST char *
1845 bfd_errmsg  PARAMS ((bfd_error_type error_tag));
1846
1847 void
1848 bfd_perror  PARAMS ((CONST char *message));
1849
1850 long
1851 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
1852
1853 long
1854 bfd_canonicalize_reloc
1855  PARAMS ((bfd *abfd,
1856     asection *sec,
1857     arelent **loc,
1858     asymbol     **syms));
1859
1860 void
1861 bfd_set_reloc
1862  PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
1863
1864     );
1865
1866 boolean
1867 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
1868
1869 boolean
1870 bfd_set_start_address PARAMS ((bfd *abfd, bfd_vma vma));
1871
1872 long
1873 bfd_get_mtime PARAMS ((bfd *abfd));
1874
1875 long
1876 bfd_get_size PARAMS ((bfd *abfd));
1877
1878 int
1879 bfd_get_gp_size PARAMS ((bfd *abfd));
1880
1881 void
1882 bfd_set_gp_size PARAMS ((bfd *abfd, int i));
1883
1884 bfd_vma
1885 bfd_scan_vma PARAMS ((CONST char *string, CONST char **end, int base));
1886
1887 boolean
1888 bfd_copy_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
1889
1890 #define bfd_copy_private_bfd_data(ibfd, obfd) \
1891      BFD_SEND (ibfd, _bfd_copy_private_bfd_data, \
1892                 (ibfd, obfd))
1893 #define bfd_sizeof_headers(abfd, reloc) \
1894      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1895
1896 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1897      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
1898
1899         /* Do these three do anything useful at all, for any back end?  */
1900 #define bfd_debug_info_start(abfd) \
1901         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1902
1903 #define bfd_debug_info_end(abfd) \
1904         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1905
1906 #define bfd_debug_info_accumulate(abfd, section) \
1907         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1908
1909
1910 #define bfd_stat_arch_elt(abfd, stat) \
1911         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1912
1913 #define bfd_set_arch_mach(abfd, arch, mach)\
1914         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1915
1916 #define bfd_get_relocated_section_contents(abfd, link_info, link_order, data, relocateable, symbols) \
1917         BFD_SEND (abfd, _bfd_get_relocated_section_contents, \
1918                  (abfd, link_info, link_order, data, relocateable, symbols))
1919
1920 #define bfd_relax_section(abfd, section, link_info, again) \
1921        BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1922
1923 #define bfd_link_hash_table_create(abfd) \
1924         BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1925
1926 #define bfd_link_add_symbols(abfd, info) \
1927         BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1928
1929 #define bfd_final_link(abfd, info) \
1930         BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1931
1932 symindex
1933 bfd_get_next_mapent PARAMS ((bfd *abfd, symindex previous, carsym **sym));
1934
1935 boolean
1936 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
1937
1938 bfd *
1939 bfd_get_elt_at_index PARAMS ((bfd *archive, int index));
1940
1941 bfd *
1942 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
1943
1944 CONST char *
1945 bfd_core_file_failing_command PARAMS ((bfd *abfd));
1946
1947 int
1948 bfd_core_file_failing_signal PARAMS ((bfd *abfd));
1949
1950 boolean
1951 core_file_matches_executable_p
1952  PARAMS ((bfd *core_bfd, bfd *exec_bfd));
1953
1954 #define BFD_SEND(bfd, message, arglist) \
1955                ((*((bfd)->xvec->message)) arglist)
1956
1957 #ifdef DEBUG_BFD_SEND
1958 #undef BFD_SEND
1959 #define BFD_SEND(bfd, message, arglist) \
1960   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
1961     ((*((bfd)->xvec->message)) arglist) : \
1962     (bfd_assert (__FILE__,__LINE__), NULL))
1963 #endif
1964 #define BFD_SEND_FMT(bfd, message, arglist) \
1965             (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1966
1967 #ifdef DEBUG_BFD_SEND
1968 #undef BFD_SEND_FMT
1969 #define BFD_SEND_FMT(bfd, message, arglist) \
1970   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
1971    (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) : \
1972    (bfd_assert (__FILE__,__LINE__), NULL))
1973 #endif
1974 enum bfd_flavour {
1975   bfd_target_unknown_flavour,
1976   bfd_target_aout_flavour,
1977   bfd_target_coff_flavour,
1978   bfd_target_ecoff_flavour,
1979   bfd_target_elf_flavour,
1980   bfd_target_ieee_flavour,
1981   bfd_target_nlm_flavour,
1982   bfd_target_oasys_flavour,
1983   bfd_target_tekhex_flavour,
1984   bfd_target_srec_flavour,
1985   bfd_target_som_flavour,
1986   bfd_target_os9k_flavour};
1987
1988  /* Forward declaration.  */
1989 typedef struct bfd_link_info _bfd_link_info;
1990
1991 typedef struct bfd_target
1992 {
1993   char *name;
1994   enum bfd_flavour flavour;
1995   boolean byteorder_big_p;
1996   boolean header_byteorder_big_p;
1997   flagword object_flags;
1998   flagword section_flags;
1999   char symbol_leading_char;
2000   char ar_pad_char;
2001   unsigned short ar_max_namelen;
2002   unsigned int align_power_min;
2003   bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
2004   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
2005   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
2006   bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
2007   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
2008   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
2009   bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
2010   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
2011   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
2012   bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
2013   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
2014   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
2015   bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
2016   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
2017   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
2018   bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
2019   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
2020   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
2021   struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
2022   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
2023   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
2024   char *   (*_core_file_failing_command) PARAMS ((bfd *));
2025   int      (*_core_file_failing_signal) PARAMS ((bfd *));
2026   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
2027   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
2028   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
2029   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
2030   boolean  (*write_armap) PARAMS ((bfd *arch,
2031                               unsigned int elength,
2032                               struct orl *map,
2033                               unsigned int orl_count,
2034                               int stridx));
2035   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
2036   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
2037                                             file_ptr, bfd_size_type));
2038   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
2039                                             file_ptr, bfd_size_type));
2040   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
2041   boolean       (*_bfd_copy_private_section_data) PARAMS ((bfd *, sec_ptr,
2042                                                         bfd *, sec_ptr));
2043   boolean        (*_bfd_copy_private_bfd_data) PARAMS ((bfd *, bfd *));
2044   long  (*_bfd_get_symtab_upper_bound) PARAMS ((bfd *));
2045   long  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
2046                                              struct symbol_cache_entry **));
2047   long  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
2048   long  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
2049                                             struct symbol_cache_entry **));
2050   struct symbol_cache_entry  *
2051                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
2052   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
2053                                       struct symbol_cache_entry *,
2054                                       bfd_print_symbol_type));
2055 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2056   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
2057                                       struct symbol_cache_entry *,
2058                                       symbol_info *));
2059 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
2060   boolean        (*_bfd_is_local_label) PARAMS ((bfd *, asymbol *));
2061   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
2062
2063   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
2064                     unsigned long));
2065
2066   bfd *      (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
2067
2068   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
2069                     struct sec *section, struct symbol_cache_entry **symbols,
2070                     bfd_vma offset, CONST char **file, CONST char **func,
2071                     unsigned int *line));
2072
2073   int        (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
2074
2075   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
2076
2077   void       (*_bfd_debug_info_start) PARAMS ((bfd *));
2078   void       (*_bfd_debug_info_end) PARAMS ((bfd *));
2079   void       (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
2080
2081   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
2082                     struct bfd_link_info *, struct bfd_link_order *,
2083                     bfd_byte *data, boolean relocateable,
2084                     struct symbol_cache_entry **));
2085
2086   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
2087                     struct bfd_link_info *, boolean *again));
2088
2089   /* See documentation on reloc types.  */
2090  CONST struct reloc_howto_struct *
2091        (*reloc_type_lookup) PARAMS ((bfd *abfd,
2092                                      bfd_reloc_code_real_type code));
2093
2094   /* Back-door to allow format-aware applications to create debug symbols
2095     while using BFD for everything else.  Currently used by the assembler
2096     when creating COFF files.  */
2097  asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
2098        bfd *abfd,
2099        void *ptr,
2100        unsigned long size));
2101
2102   /* Create a hash table for the linker.  Different backends store
2103     different information in this table.  */
2104  struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
2105
2106   /* Add symbols from this object file into the hash table.  */
2107  boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
2108
2109   /* Do a link based on the link_order structures attached to each
2110     section of the BFD.  */
2111  boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
2112
2113  PTR backend_data;
2114 } bfd_target;
2115 bfd_target *
2116 bfd_find_target PARAMS ((CONST char *target_name, bfd *abfd));
2117
2118 CONST char **
2119 bfd_target_list PARAMS ((void));
2120
2121 boolean
2122 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
2123
2124 boolean
2125 bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
2126
2127 boolean
2128 bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
2129
2130 CONST char *
2131 bfd_format_string PARAMS ((bfd_format format));
2132
2133 #endif