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 #define BFD_VERSION "2.2"
  51
  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,_get_symtab_upper_bound),\
 435 CAT(NAME,_get_symtab),\
 436 CAT(NAME,_get_reloc_upper_bound),\
 437 CAT(NAME,_canonicalize_reloc),\
 438 CAT(NAME,_make_empty_symbol),\
 439 CAT(NAME,_print_symbol),\
 440 CAT(NAME,_get_symbol_info),\
 441 CAT(NAME,_get_lineno),\
 442 CAT(NAME,_set_arch_mach),\
 443 CAT(NAME,_openr_next_archived_file),\
 444 CAT(NAME,_find_nearest_line),\
 445 CAT(NAME,_generic_stat_arch_elt),\
 446 CAT(NAME,_sizeof_headers),\
 447 CAT(NAME,_bfd_debug_info_start),\
 448 CAT(NAME,_bfd_debug_info_end),\
 449 CAT(NAME,_bfd_debug_info_accumulate),\
 450 CAT(NAME,_bfd_get_relocated_section_contents),\
 451 CAT(NAME,_bfd_relax_section),\
 452 CAT(NAME,_bfd_reloc_type_lookup),\
 453 CAT(NAME,_bfd_make_debug_symbol),\
 454 CAT(NAME,_bfd_link_hash_table_create),\
 455 CAT(NAME,_bfd_link_add_symbols),\
 456 CAT(NAME,_bfd_final_link)
 457
 458 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 459
 460 \f
 461 /* User program access to BFD facilities */
 462
 463 /* Cast from const char * to char * so that caller can assign to
 464    a char * without a warning.  */
 465 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 466 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 467 #define bfd_get_format(abfd) ((abfd)->format)
 468 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 469 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 470 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 471 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 472 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 473 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 474 #define bfd_has_map(abfd) ((abfd)->has_armap)
 475
 476 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 477 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 478
 479 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 480 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 481 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 482 #define bfd_count_sections(abfd) ((abfd)->section_count)
 483
 484 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 485
 486 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (bool)), true)
 487
 488 /* Byte swapping routines.  */
 489
 490 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 491 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 492 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 493 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 494 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 495 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 496 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 497 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 498 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 499 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 500 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 501 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 502 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 503 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 504 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 505 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 506 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 507 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 508
 509 /* ECOFF linking routines.  */
 510 #if defined(__STDC__) || defined(ALMOST_STDC)
 511 struct ecoff_debug_info;
 512 struct ecoff_debug_swap;
 513 struct ecoff_extr;
 514 struct symbol_cache_entry;
 515 struct bfd_link_info;
 516 #endif
 517 extern PTR bfd_ecoff_debug_init
 518   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 519            const struct ecoff_debug_swap *output_swap,
 520            struct bfd_link_info *));
 521 extern void bfd_ecoff_debug_free
 522   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 523            const struct ecoff_debug_swap *output_swap,
 524            struct bfd_link_info *));
 525 extern boolean bfd_ecoff_debug_accumulate
 526   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 527            const struct ecoff_debug_swap *output_swap,
 528            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 529            const struct ecoff_debug_swap *input_swap,
 530            struct bfd_link_info *));
 531 extern boolean bfd_ecoff_debug_accumulate_other
 532   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 533            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 534            struct bfd_link_info *));
 535 extern boolean bfd_ecoff_debug_externals
 536   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 537            const struct ecoff_debug_swap *swap,
 538            boolean relocateable,
 539            boolean (*get_extr) (struct symbol_cache_entry *,
 540                                 struct ecoff_extr *),
 541            void (*set_index) (struct symbol_cache_entry *,
 542                               bfd_size_type)));
 543 extern boolean bfd_ecoff_debug_one_external
 544   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 545            const struct ecoff_debug_swap *swap,
 546            const char *name, struct ecoff_extr *esym));
 547 extern bfd_size_type bfd_ecoff_debug_size
 548   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 549            const struct ecoff_debug_swap *swap));
 550 extern boolean bfd_ecoff_write_debug
 551   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 552            const struct ecoff_debug_swap *swap, file_ptr where));
 553 extern boolean bfd_ecoff_write_accumulated_debug
 554   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 555            const struct ecoff_debug_swap *swap,
 556            struct bfd_link_info *info, file_ptr where));
 557
 558 /* And more from the source.  */
 559 void
 560 bfd_init PARAMS ((void));
 561
 562 bfd *
 563 bfd_openr PARAMS ((CONST char *filename, CONST char *target));
 564
 565 bfd *
 566 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
 567
 568 bfd *
 569 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
 570
 571 boolean
 572 bfd_close PARAMS ((bfd *abfd));
 573
 574 boolean
 575 bfd_close_all_done PARAMS ((bfd *));
 576
 577 bfd_size_type
 578 bfd_alloc_size PARAMS ((bfd *abfd));
 579
 580 bfd *
 581 bfd_create PARAMS ((CONST char *filename, bfd *templ));
 582
 583
 584  /* Byte swapping macros for user section data.  */
 585
 586 #define bfd_put_8(abfd, val, ptr) \
 587                 (*((unsigned char *)(ptr)) = (unsigned char)(val))
 588 #define bfd_put_signed_8 \
 589                 bfd_put_8
 590 #define bfd_get_8(abfd, ptr) \
 591                 (*(unsigned char *)(ptr))
 592 #define bfd_get_signed_8(abfd, ptr) \
 593                 ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
 594
 595 #define bfd_put_16(abfd, val, ptr) \
 596                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
 597 #define bfd_put_signed_16 \
 598                  bfd_put_16
 599 #define bfd_get_16(abfd, ptr) \
 600                 BFD_SEND(abfd, bfd_getx16, (ptr))
 601 #define bfd_get_signed_16(abfd, ptr) \
 602                  BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
 603
 604 #define bfd_put_32(abfd, val, ptr) \
 605                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
 606 #define bfd_put_signed_32 \
 607                  bfd_put_32
 608 #define bfd_get_32(abfd, ptr) \
 609                 BFD_SEND(abfd, bfd_getx32, (ptr))
 610 #define bfd_get_signed_32(abfd, ptr) \
 611                  BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
 612
 613 #define bfd_put_64(abfd, val, ptr) \
 614                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
 615 #define bfd_put_signed_64 \
 616                  bfd_put_64
 617 #define bfd_get_64(abfd, ptr) \
 618                 BFD_SEND(abfd, bfd_getx64, (ptr))
 619 #define bfd_get_signed_64(abfd, ptr) \
 620                  BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
 621
 622
 623  /* Byte swapping macros for file header data.  */
 624
 625 #define bfd_h_put_8(abfd, val, ptr) \
 626                 bfd_put_8 (abfd, val, ptr)
 627 #define bfd_h_put_signed_8(abfd, val, ptr) \
 628                 bfd_put_8 (abfd, val, ptr)
 629 #define bfd_h_get_8(abfd, ptr) \
 630                 bfd_get_8 (abfd, ptr)
 631 #define bfd_h_get_signed_8(abfd, ptr) \
 632                 bfd_get_signed_8 (abfd, ptr)
 633
 634 #define bfd_h_put_16(abfd, val, ptr) \
 635                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
 636 #define bfd_h_put_signed_16 \
 637                  bfd_h_put_16
 638 #define bfd_h_get_16(abfd, ptr) \
 639                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
 640 #define bfd_h_get_signed_16(abfd, ptr) \
 641                  BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
 642
 643 #define bfd_h_put_32(abfd, val, ptr) \
 644                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
 645 #define bfd_h_put_signed_32 \
 646                  bfd_h_put_32
 647 #define bfd_h_get_32(abfd, ptr) \
 648                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
 649 #define bfd_h_get_signed_32(abfd, ptr) \
 650                  BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
 651
 652 #define bfd_h_put_64(abfd, val, ptr) \
 653                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
 654 #define bfd_h_put_signed_64 \
 655                  bfd_h_put_64
 656 #define bfd_h_get_64(abfd, ptr) \
 657                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
 658 #define bfd_h_get_signed_64(abfd, ptr) \
 659                  BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
 660
 661 typedef struct sec
 662 {
 663          /* The name of the section; the name isn't a copy, the pointer is
 664         the same as that passed to bfd_make_section. */
 665
 666     CONST char *name;
 667
 668          /* Which section is it; 0..nth.      */
 669
 670    int index;
 671
 672          /* The next section in the list belonging to the BFD, or NULL. */
 673
 674     struct sec *next;
 675
 676          /* The field flags contains attributes of the section. Some
 677            flags are read in from the object file, and some are
 678            synthesized from other information.  */
 679
 680     flagword flags;
 681
 682 #define SEC_NO_FLAGS   0x000
 683
 684          /* Tells the OS to allocate space for this section when loading.
 685            This is clear for a section containing debug information
 686            only. */
 687 #define SEC_ALLOC      0x001
 688
 689          /* Tells the OS to load the section from the file when loading.
 690            This is clear for a .bss section. */
 691 #define SEC_LOAD       0x002
 692
 693          /* The section contains data still to be relocated, so there is
 694            some relocation information too. */
 695 #define SEC_RELOC      0x004
 696
 697 #if 0    /* Obsolete ? */
 698 #define SEC_BALIGN     0x008
 699 #endif
 700
 701          /* A signal to the OS that the section contains read only
 702           data. */
 703 #define SEC_READONLY   0x010
 704
 705          /* The section contains code only. */
 706 #define SEC_CODE       0x020
 707
 708          /* The section contains data only. */
 709 #define SEC_DATA       0x040
 710
 711          /* The section will reside in ROM. */
 712 #define SEC_ROM        0x080
 713
 714          /* The section contains constructor information. This section
 715            type is used by the linker to create lists of constructors and
 716            destructors used by <<g++>>. When a back end sees a symbol
 717            which should be used in a constructor list, it creates a new
 718            section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
 719            the symbol to it, and builds a relocation. To build the lists
 720            of constructors, all the linker has to do is catenate all the
 721            sections called <<__CTOR_LIST__>> and relocate the data
 722            contained within - exactly the operations it would peform on
 723            standard data. */
 724 #define SEC_CONSTRUCTOR 0x100
 725
 726          /* The section is a constuctor, and should be placed at the
 727           end of the text, data, or bss section(?). */
 728 #define SEC_CONSTRUCTOR_TEXT 0x1100
 729 #define SEC_CONSTRUCTOR_DATA 0x2100
 730 #define SEC_CONSTRUCTOR_BSS  0x3100
 731
 732          /* The section has contents - a data section could be
 733            <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
 734            <<SEC_HAS_CONTENTS>> */
 735 #define SEC_HAS_CONTENTS 0x200
 736
 737          /* An instruction to the linker to not output the section
 738           even if it has information which would normally be written. */
 739 #define SEC_NEVER_LOAD 0x400
 740
 741          /* The section is a shared library section.  The linker must leave
 742            these completely alone, as the vma and size are used when
 743            the executable is loaded. */
 744 #define SEC_SHARED_LIBRARY 0x800
 745
 746          /* The section is a common section (symbols may be defined
 747            multiple times, the value of a symbol is the amount of
 748            space it requires, and the largest symbol value is the one
 749            used).  Most targets have exactly one of these (which we
 750             translate to bfd_com_section), but ECOFF has two. */
 751 #define SEC_IS_COMMON 0x8000
 752
 753          /* The section contains only debugging information.  For
 754            example, this is set for ELF .debug and .stab sections.
 755            strip tests this flag to see if a section can be
 756            discarded. */
 757 #define SEC_DEBUGGING 0x10000
 758
 759          /*  End of section flags.  */
 760
 761         /*  The virtual memory address of the section - where it will be
 762            at run time.  The symbols are relocated against this.  The
 763             user_set_vma flag is maintained by bfd; if it's not set, the
 764             backend can assign addresses (for example, in <<a.out>>, where
 765             the default address for <<.data>> is dependent on the specific
 766             target and various flags).  */
 767
 768    bfd_vma vma;
 769    boolean user_set_vma;
 770
 771         /*  The load address of the section - where it would be in a
 772            rom image; really only used for writing section header
 773             information. */
 774
 775    bfd_vma lma;
 776
 777          /* The size of the section in bytes, as it will be output.
 778            contains a value even if the section has no contents (e.g., the
 779            size of <<.bss>>). This will be filled in after relocation */
 780
 781    bfd_size_type _cooked_size;
 782
 783          /* The original size on disk of the section, in bytes.  Normally this
 784             value is the same as the size, but if some relaxing has
 785             been done, then this value will be bigger.  */
 786
 787    bfd_size_type _raw_size;
 788
 789          /* If this section is going to be output, then this value is the
 790            offset into the output section of the first byte in the input
 791            section. E.g., if this was going to start at the 100th byte in
 792            the output section, this value would be 100. */
 793
 794    bfd_vma output_offset;
 795
 796          /* The output section through which to map on output. */
 797
 798    struct sec *output_section;
 799
 800          /* The alignment requirement of the section, as an exponent of 2 -
 801            e.g., 3 aligns to 2^3 (or 8). */
 802
 803    unsigned int alignment_power;
 804
 805          /* If an input section, a pointer to a vector of relocation
 806            records for the data in this section. */
 807
 808    struct reloc_cache_entry *relocation;
 809
 810          /* If an output section, a pointer to a vector of pointers to
 811            relocation records for the data in this section. */
 812
 813    struct reloc_cache_entry **orelocation;
 814
 815          /* The number of relocation records in one of the above  */
 816
 817    unsigned reloc_count;
 818
 819          /* Information below is back end specific - and not always used
 820            or updated.  */
 821
 822          /* File position of section data    */
 823
 824    file_ptr filepos;
 825
 826          /* File position of relocation info */
 827
 828    file_ptr rel_filepos;
 829
 830          /* File position of line data       */
 831
 832    file_ptr line_filepos;
 833
 834          /* Pointer to data for applications */
 835
 836    PTR userdata;
 837
 838    struct lang_output_section *otheruserdata;
 839
 840          /* Attached line number information */
 841
 842    alent *lineno;
 843
 844          /* Number of line number records   */
 845
 846    unsigned int lineno_count;
 847
 848          /* When a section is being output, this value changes as more
 849            linenumbers are written out */
 850
 851    file_ptr moving_line_filepos;
 852
 853          /* What the section number is in the target world  */
 854
 855    int target_index;
 856
 857    PTR used_by_bfd;
 858
 859          /* If this is a constructor section then here is a list of the
 860            relocations created to relocate items within it. */
 861
 862    struct relent_chain *constructor_chain;
 863
 864          /* The BFD which owns the section. */
 865
 866    bfd *owner;
 867
 868    boolean reloc_done;
 869           /* A symbol which points at this section only */
 870    struct symbol_cache_entry *symbol;
 871    struct symbol_cache_entry **symbol_ptr_ptr;
 872
 873    struct bfd_link_order *link_order_head;
 874    struct bfd_link_order *link_order_tail;
 875 } asection ;
 876
 877
 878      /* These sections are global, and are managed by BFD.  The application
 879        and target back end are not permitted to change the values in
 880         these sections.  */
 881 #define BFD_ABS_SECTION_NAME "*ABS*"
 882 #define BFD_UND_SECTION_NAME "*UND*"
 883 #define BFD_COM_SECTION_NAME "*COM*"
 884 #define BFD_IND_SECTION_NAME "*IND*"
 885
 886      /* the absolute section */
 887 extern asection bfd_abs_section;
 888      /* Pointer to the undefined section */
 889 extern asection bfd_und_section;
 890      /* Pointer to the common section */
 891 extern asection bfd_com_section;
 892      /* Pointer to the indirect section */
 893 extern asection bfd_ind_section;
 894
 895 extern struct symbol_cache_entry *bfd_abs_symbol;
 896 extern struct symbol_cache_entry *bfd_com_symbol;
 897 extern struct symbol_cache_entry *bfd_und_symbol;
 898 extern struct symbol_cache_entry *bfd_ind_symbol;
 899 #define bfd_get_section_size_before_reloc(section) \
 900      (section->reloc_done ? (abort(),1): (section)->_raw_size)
 901 #define bfd_get_section_size_after_reloc(section) \
 902      ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
 903 asection *
 904 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
 905
 906 asection *
 907 bfd_make_section_old_way PARAMS ((bfd *abfd, CONST char *name));
 908
 909 asection *
 910 bfd_make_section_anyway PARAMS ((bfd *abfd, CONST char *name));
 911
 912 asection *
 913 bfd_make_section PARAMS ((bfd *, CONST char *name));
 914
 915 boolean
 916 bfd_set_section_flags PARAMS ((bfd *abfd, asection *sec, flagword flags));
 917
 918 void
 919 bfd_map_over_sections PARAMS ((bfd *abfd,
 920     void (*func)(bfd *abfd,
 921     asection *sect,
 922     PTR obj),
 923     PTR obj));
 924
 925 boolean
 926 bfd_set_section_size PARAMS ((bfd *abfd, asection *sec, bfd_size_type val));
 927
 928 boolean
 929 bfd_set_section_contents
 930  PARAMS ((bfd *abfd,
 931     asection *section,
 932     PTR data,
 933     file_ptr offset,
 934     bfd_size_type count));
 935
 936 boolean
 937 bfd_get_section_contents
 938  PARAMS ((bfd *abfd, asection *section, PTR location,
 939     file_ptr offset, bfd_size_type count));
 940
 941 enum bfd_architecture
 942 {
 943   bfd_arch_unknown,    /* File arch not known */
 944   bfd_arch_obscure,    /* Arch known, not one of these */
 945   bfd_arch_m68k,       /* Motorola 68xxx */
 946   bfd_arch_vax,        /* DEC Vax */
 947   bfd_arch_i960,       /* Intel 960 */
 948      /* The order of the following is important.
 949        lower number indicates a machine type that
 950        only accepts a subset of the instructions
 951        available to machines with higher numbers.
 952        The exception is the "ca", which is
 953        incompatible with all other machines except
 954        "core". */
 955
 956 #define bfd_mach_i960_core      1
 957 #define bfd_mach_i960_ka_sa     2
 958 #define bfd_mach_i960_kb_sb     3
 959 #define bfd_mach_i960_mc        4
 960 #define bfd_mach_i960_xa        5
 961 #define bfd_mach_i960_ca        6
 962
 963   bfd_arch_a29k,       /* AMD 29000 */
 964   bfd_arch_sparc,      /* SPARC */
 965   bfd_arch_mips,       /* MIPS Rxxxx */
 966   bfd_arch_i386,       /* Intel 386 */
 967   bfd_arch_we32k,      /* AT&T WE32xxx */
 968   bfd_arch_tahoe,      /* CCI/Harris Tahoe */
 969   bfd_arch_i860,       /* Intel 860 */
 970   bfd_arch_romp,       /* IBM ROMP PC/RT */
 971   bfd_arch_alliant,    /* Alliant */
 972   bfd_arch_convex,     /* Convex */
 973   bfd_arch_m88k,       /* Motorola 88xxx */
 974   bfd_arch_pyramid,    /* Pyramid Technology */
 975   bfd_arch_h8300,      /* Hitachi H8/300 */
 976 #define bfd_mach_h8300   1
 977 #define bfd_mach_h8300h  2
 978   bfd_arch_powerpc,    /* PowerPC */
 979   bfd_arch_rs6000,     /* IBM RS/6000 */
 980   bfd_arch_hppa,       /* HP PA RISC */
 981   bfd_arch_z8k,        /* Zilog Z8000 */
 982 #define bfd_mach_z8001          1
 983 #define bfd_mach_z8002          2
 984   bfd_arch_h8500,      /* Hitachi H8/500 */
 985   bfd_arch_sh,         /* Hitachi SH */
 986   bfd_arch_alpha,      /* Dec Alpha */
 987   bfd_arch_last
 988   };
 989
 990 typedef struct bfd_arch_info
 991 {
 992   int bits_per_word;
 993   int bits_per_address;
 994   int bits_per_byte;
 995   enum bfd_architecture arch;
 996   long mach;
 997   char *arch_name;
 998   CONST  char *printable_name;
 999   unsigned int section_align_power;
1000   /* true if this is the default machine for the architecture */
1001   boolean the_default;
1002   CONST struct bfd_arch_info * (*compatible)
1003         PARAMS ((CONST struct bfd_arch_info *a,
1004                  CONST struct bfd_arch_info *b));
1005
1006   boolean (*scan) PARAMS ((CONST struct bfd_arch_info *, CONST char *));
1007    /* How to disassemble an instruction, producing a printable
1008      representation on a specified stdio stream.  This isn't
1009      defined for most processors at present, because of the size
1010      of the additional tables it would drag in, and because gdb
1011      wants to use a different interface.  */
1012   unsigned int (*disassemble) PARAMS ((bfd_vma addr, CONST char *data,
1013                                         PTR stream));
1014
1015   struct bfd_arch_info *next;
1016 } bfd_arch_info_type;
1017 CONST char *
1018 bfd_printable_name PARAMS ((bfd *abfd));
1019
1020 bfd_arch_info_type *
1021 bfd_scan_arch PARAMS ((CONST char *string));
1022
1023 CONST bfd_arch_info_type *
1024 bfd_arch_get_compatible PARAMS ((
1025     CONST bfd *abfd,
1026     CONST bfd *bbfd));
1027
1028 void
1029 bfd_set_arch_info PARAMS ((bfd *abfd, bfd_arch_info_type *arg));
1030
1031 enum bfd_architecture
1032 bfd_get_arch PARAMS ((bfd *abfd));
1033
1034 unsigned long
1035 bfd_get_mach PARAMS ((bfd *abfd));
1036
1037 unsigned int
1038 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
1039
1040 unsigned int
1041 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
1042
1043 bfd_arch_info_type *
1044 bfd_get_arch_info PARAMS ((bfd *abfd));
1045
1046 bfd_arch_info_type *
1047 bfd_lookup_arch
1048  PARAMS ((enum bfd_architecture
1049     arch,
1050     long machine));
1051
1052 CONST char *
1053 bfd_printable_arch_mach
1054  PARAMS ((enum bfd_architecture arch, unsigned long machine));
1055
1056 typedef enum bfd_reloc_status
1057 {
1058         /* No errors detected */
1059   bfd_reloc_ok,
1060
1061         /* The relocation was performed, but there was an overflow. */
1062   bfd_reloc_overflow,
1063
1064         /* The address to relocate was not within the section supplied. */
1065   bfd_reloc_outofrange,
1066
1067         /* Used by special functions */
1068   bfd_reloc_continue,
1069
1070         /* Unsupported relocation size requested. */
1071   bfd_reloc_notsupported,
1072
1073         /* Unused */
1074   bfd_reloc_other,
1075
1076         /* The symbol to relocate against was undefined. */
1077   bfd_reloc_undefined,
1078
1079         /* The relocation was performed, but may not be ok - presently
1080           generated only when linking i960 coff files with i960 b.out
1081           symbols.  If this type is returned, the error_message argument
1082           to bfd_perform_relocation will be set.  */
1083   bfd_reloc_dangerous
1084  }
1085  bfd_reloc_status_type;
1086
1087
1088 typedef struct reloc_cache_entry
1089 {
1090         /* A pointer into the canonical table of pointers  */
1091   struct symbol_cache_entry **sym_ptr_ptr;
1092
1093         /* offset in section */
1094   bfd_size_type address;
1095
1096         /* addend for relocation value */
1097   bfd_vma addend;
1098
1099         /* Pointer to how to perform the required relocation */
1100   const struct reloc_howto_struct *howto;
1101
1102 } arelent;
1103 enum complain_overflow
1104 {
1105          /* Do not complain on overflow. */
1106   complain_overflow_dont,
1107
1108          /* Complain if the bitfield overflows, whether it is considered
1109            as signed or unsigned. */
1110   complain_overflow_bitfield,
1111
1112          /* Complain if the value overflows when considered as signed
1113            number. */
1114   complain_overflow_signed,
1115
1116          /* Complain if the value overflows when considered as an
1117            unsigned number. */
1118   complain_overflow_unsigned
1119 };
1120
1121 typedef struct reloc_howto_struct
1122 {
1123         /*  The type field has mainly a documetary use - the back end can
1124            do what it wants with it, though normally the back end's
1125            external idea of what a reloc number is stored
1126            in this field. For example, a PC relative word relocation
1127            in a coff environment has the type 023 - because that's
1128            what the outside world calls a R_PCRWORD reloc. */
1129   unsigned int type;
1130
1131         /*  The value the final relocation is shifted right by. This drops
1132            unwanted data from the relocation.  */
1133   unsigned int rightshift;
1134
1135          /*  The size of the item to be relocated.  This is *not* a
1136             power-of-two measure.  To get the number of bytes operated
1137             on by a type of relocation, use bfd_get_reloc_size.  */
1138   int size;
1139
1140         /*  The number of bits in the item to be relocated.  This is used
1141             when doing overflow checking.  */
1142   unsigned int bitsize;
1143
1144         /*  Notes that the relocation is relative to the location in the
1145            data section of the addend. The relocation function will
1146            subtract from the relocation value the address of the location
1147            being relocated. */
1148   boolean pc_relative;
1149
1150          /*  The bit position of the reloc value in the destination.
1151             The relocated value is left shifted by this amount. */
1152   unsigned int bitpos;
1153
1154          /* What type of overflow error should be checked for when
1155            relocating. */
1156   enum complain_overflow complain_on_overflow;
1157
1158         /* If this field is non null, then the supplied function is
1159           called rather than the normal function. This allows really
1160           strange relocation methods to be accomodated (e.g., i960 callj
1161           instructions). */
1162   bfd_reloc_status_type (*special_function)
1163                                     PARAMS ((bfd *abfd,
1164                                              arelent *reloc_entry,
1165                                             struct symbol_cache_entry *symbol,
1166                                             PTR data,
1167                                             asection *input_section,
1168                                             bfd *output_bfd,
1169                                             char **error_message));
1170
1171         /* The textual name of the relocation type. */
1172   char *name;
1173
1174         /* When performing a partial link, some formats must modify the
1175           relocations rather than the data - this flag signals this.*/
1176   boolean partial_inplace;
1177
1178         /* The src_mask selects which parts of the read in data
1179           are to be used in the relocation sum.  E.g., if this was an 8 bit
1180           bit of data which we read and relocated, this would be
1181           0x000000ff. When we have relocs which have an addend, such as
1182           sun4 extended relocs, the value in the offset part of a
1183           relocating field is garbage so we never use it. In this case
1184           the mask would be 0x00000000. */
1185   bfd_vma src_mask;
1186
1187         /* The dst_mask selects which parts of the instruction are replaced
1188           into the instruction. In most cases src_mask == dst_mask,
1189           except in the above special case, where dst_mask would be
1190           0x000000ff, and src_mask would be 0x00000000.   */
1191   bfd_vma dst_mask;
1192
1193         /* When some formats create PC relative instructions, they leave
1194           the value of the pc of the place being relocated in the offset
1195           slot of the instruction, so that a PC relative relocation can
1196           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1197           Some formats leave the displacement part of an instruction
1198           empty (e.g., m88k bcs); this flag signals the fact.*/
1199   boolean pcrel_offset;
1200
1201 } reloc_howto_type;
1202 #define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1203   {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1204 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
1205
1206 #define HOWTO_PREPARE(relocation, symbol)      \
1207   {                                            \
1208   if (symbol != (asymbol *)NULL) {             \
1209     if (bfd_is_com_section (symbol->section)) { \
1210       relocation = 0;                          \
1211     }                                          \
1212     else {                                     \
1213       relocation = symbol->value;              \
1214     }                                          \
1215   }                                            \
1216 }
1217 int
1218 bfd_get_reloc_size  PARAMS ((const reloc_howto_type *));
1219
1220 typedef unsigned char bfd_byte;
1221
1222 typedef struct relent_chain {
1223   arelent relent;
1224   struct   relent_chain *next;
1225 } arelent_chain;
1226 bfd_reloc_status_type
1227
1228 bfd_perform_relocation
1229  PARAMS ((bfd *abfd,
1230     arelent *reloc_entry,
1231     PTR data,
1232     asection *input_section,
1233     bfd *output_bfd,
1234     char **error_message));
1235
1236 typedef enum bfd_reloc_code_real
1237 {
1238    /* Basic absolute relocations */
1239   BFD_RELOC_64,
1240   BFD_RELOC_32,
1241   BFD_RELOC_16,
1242   BFD_RELOC_14,
1243   BFD_RELOC_8,
1244
1245    /* PC-relative relocations */
1246   BFD_RELOC_64_PCREL,
1247   BFD_RELOC_32_PCREL,
1248   BFD_RELOC_24_PCREL,     /* used by i960 */
1249   BFD_RELOC_16_PCREL,
1250   BFD_RELOC_8_PCREL,
1251
1252    /* Linkage-table relative */
1253   BFD_RELOC_32_BASEREL,
1254   BFD_RELOC_16_BASEREL,
1255   BFD_RELOC_8_BASEREL,
1256
1257    /* The type of reloc used to build a contructor table - at the moment
1258      probably a 32 bit wide abs address, but the cpu can choose. */
1259   BFD_RELOC_CTOR,
1260
1261    /* 8 bits wide, but used to form an address like 0xffnn */
1262   BFD_RELOC_8_FFnn,
1263
1264    /* 32-bit pc-relative, shifted right 2 bits (i.e., 30-bit
1265      word displacement, e.g. for SPARC) */
1266   BFD_RELOC_32_PCREL_S2,
1267    /* signed 16-bit pc-relative, shifted right 2 bits (e.g. for MIPS) */
1268   BFD_RELOC_16_PCREL_S2,
1269    /* this is used on the Alpha */
1270   BFD_RELOC_23_PCREL_S2,
1271
1272    /* High 22 bits of 32-bit value, placed into lower 22 bits of
1273      target word; simple reloc.  */
1274   BFD_RELOC_HI22,
1275    /* Low 10 bits.  */
1276   BFD_RELOC_LO10,
1277
1278    /* For systems that allocate a Global Pointer register, these are
1279      displacements off that register.  These relocation types are
1280      handled specially, because the value the register will have is
1281      decided relatively late.  */
1282   BFD_RELOC_GPREL16,
1283   BFD_RELOC_GPREL32,
1284
1285    /* Reloc types used for i960/b.out.  */
1286   BFD_RELOC_I960_CALLJ,
1287
1288    /* now for the sparc/elf codes */
1289   BFD_RELOC_NONE,                /* actually used */
1290   BFD_RELOC_SPARC_WDISP22,
1291   BFD_RELOC_SPARC22,
1292   BFD_RELOC_SPARC13,
1293   BFD_RELOC_SPARC_GOT10,
1294   BFD_RELOC_SPARC_GOT13,
1295   BFD_RELOC_SPARC_GOT22,
1296   BFD_RELOC_SPARC_PC10,
1297   BFD_RELOC_SPARC_PC22,
1298   BFD_RELOC_SPARC_WPLT30,
1299   BFD_RELOC_SPARC_COPY,
1300   BFD_RELOC_SPARC_GLOB_DAT,
1301   BFD_RELOC_SPARC_JMP_SLOT,
1302   BFD_RELOC_SPARC_RELATIVE,
1303   BFD_RELOC_SPARC_UA32,
1304
1305    /* these are a.out specific? */
1306   BFD_RELOC_SPARC_BASE13,
1307   BFD_RELOC_SPARC_BASE22,
1308
1309    /* start-sanitize-v9 */
1310   BFD_RELOC_SPARC_10,
1311   BFD_RELOC_SPARC_11,
1312 #define  BFD_RELOC_SPARC_64 BFD_RELOC_64
1313   BFD_RELOC_SPARC_OLO10,
1314   BFD_RELOC_SPARC_HH22,
1315   BFD_RELOC_SPARC_HM10,
1316   BFD_RELOC_SPARC_LM22,
1317   BFD_RELOC_SPARC_PC_HH22,
1318   BFD_RELOC_SPARC_PC_HM10,
1319   BFD_RELOC_SPARC_PC_LM22,
1320   BFD_RELOC_SPARC_WDISP16,
1321   BFD_RELOC_SPARC_WDISP19,
1322   BFD_RELOC_SPARC_GLOB_JMP,
1323   BFD_RELOC_SPARC_LO7,
1324    /* end-sanitize-v9 */
1325
1326    /* Alpha ECOFF relocations.  Some of these treat the symbol or "addend"
1327      in some special way.  */
1328    /* For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1329      writing; when reading, it will be the absolute section symbol.  The
1330      addend is the displacement in bytes of the "lda" instruction from
1331      the "ldah" instruction (which is at the address of this reloc).  */
1332   BFD_RELOC_ALPHA_GPDISP_HI16,
1333    /* For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1334      with GPDISP_HI16 relocs.  The addend is ignored when writing the
1335      relocations out, and is filled in with the file's GP value on
1336      reading, for convenience.  */
1337   BFD_RELOC_ALPHA_GPDISP_LO16,
1338
1339    /* The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1340      the assembler turns it into a LDQ instruction to load the address of
1341      the symbol, and then fills in a register in the real instruction.
1342
1343      The LITERAL reloc, at the LDQ instruction, refers to the .lita
1344      section symbol.  The addend is ignored when writing, but is filled
1345      in with the file's GP value on reading, for convenience, as with the
1346      GPDISP_LO16 reloc.
1347
1348      The LITUSE reloc, on the instruction using the loaded address, gives
1349      information to the linker that it might be able to use to optimize
1350      away some literal section references.  The symbol is ignored (read
1351      as the absolute section symbol), and the "addend" indicates the type
1352      of instruction using the register:
1353               1 - "memory" fmt insn
1354               2 - byte-manipulation (byte offset reg)
1355               3 - jsr (target of branch)
1356
1357      The GNU linker currently doesn't do any of this optimizing.  */
1358   BFD_RELOC_ALPHA_LITERAL,
1359   BFD_RELOC_ALPHA_LITUSE,
1360
1361    /* The HINT relocation indicates a value that should be filled into the
1362      "hint" field of a jmp/jsr/ret instruction, for possible branch-
1363      prediction logic which may be provided on some processors.  */
1364   BFD_RELOC_ALPHA_HINT,
1365
1366    /* Bits 27..2 of the relocation address shifted right 2 bits;
1367      simple reloc otherwise.  */
1368   BFD_RELOC_MIPS_JMP,
1369
1370    /* High 16 bits of 32-bit value; simple reloc.  */
1371   BFD_RELOC_HI16,
1372    /* High 16 bits of 32-bit value but the low 16 bits will be sign
1373      extended and added to form the final result.  If the low 16
1374      bits form a negative number, we need to add one to the high value
1375      to compensate for the borrow when the low bits are added.  */
1376   BFD_RELOC_HI16_S,
1377    /* Low 16 bits.  */
1378   BFD_RELOC_LO16,
1379
1380    /* relocation relative to the global pointer.  */
1381 #define BFD_RELOC_MIPS_GPREL BFD_RELOC_GPREL16
1382
1383    /* Relocation against a MIPS literal section.  */
1384   BFD_RELOC_MIPS_LITERAL,
1385
1386    /* MIPS ELF relocations.  */
1387   BFD_RELOC_MIPS_GOT16,
1388   BFD_RELOC_MIPS_CALL16,
1389 #define BFD_RELOC_MIPS_GPREL32 BFD_RELOC_GPREL32
1390
1391    /* These are, so far, specific to HPPA processors.  I'm not sure that some
1392      don't duplicate other reloc types, such as BFD_RELOC_32 and _32_PCREL.
1393      Also, many more were in the list I got that don't fit in well in the
1394      model BFD uses, so I've omitted them for now.  If we do make this reloc
1395      type get used for code that really does implement the funky reloc types,
1396      they'll have to be added to this list.  */
1397   BFD_RELOC_HPPA_32,
1398   BFD_RELOC_HPPA_11,
1399   BFD_RELOC_HPPA_14,
1400   BFD_RELOC_HPPA_17,
1401
1402   BFD_RELOC_HPPA_L21,
1403   BFD_RELOC_HPPA_R11,
1404   BFD_RELOC_HPPA_R14,
1405   BFD_RELOC_HPPA_R17,
1406   BFD_RELOC_HPPA_LS21,
1407   BFD_RELOC_HPPA_RS11,
1408   BFD_RELOC_HPPA_RS14,
1409   BFD_RELOC_HPPA_RS17,
1410   BFD_RELOC_HPPA_LD21,
1411   BFD_RELOC_HPPA_RD11,
1412   BFD_RELOC_HPPA_RD14,
1413   BFD_RELOC_HPPA_RD17,
1414   BFD_RELOC_HPPA_LR21,
1415   BFD_RELOC_HPPA_RR14,
1416   BFD_RELOC_HPPA_RR17,
1417
1418   BFD_RELOC_HPPA_GOTOFF_11,
1419   BFD_RELOC_HPPA_GOTOFF_14,
1420   BFD_RELOC_HPPA_GOTOFF_L21,
1421   BFD_RELOC_HPPA_GOTOFF_R11,
1422   BFD_RELOC_HPPA_GOTOFF_R14,
1423   BFD_RELOC_HPPA_GOTOFF_LS21,
1424   BFD_RELOC_HPPA_GOTOFF_RS11,
1425   BFD_RELOC_HPPA_GOTOFF_RS14,
1426   BFD_RELOC_HPPA_GOTOFF_LD21,
1427   BFD_RELOC_HPPA_GOTOFF_RD11,
1428   BFD_RELOC_HPPA_GOTOFF_RD14,
1429   BFD_RELOC_HPPA_GOTOFF_LR21,
1430   BFD_RELOC_HPPA_GOTOFF_RR14,
1431
1432   BFD_RELOC_HPPA_DLT_32,
1433   BFD_RELOC_HPPA_DLT_11,
1434   BFD_RELOC_HPPA_DLT_14,
1435   BFD_RELOC_HPPA_DLT_L21,
1436   BFD_RELOC_HPPA_DLT_R11,
1437   BFD_RELOC_HPPA_DLT_R14,
1438
1439   BFD_RELOC_HPPA_ABS_CALL_11,
1440   BFD_RELOC_HPPA_ABS_CALL_14,
1441   BFD_RELOC_HPPA_ABS_CALL_17,
1442   BFD_RELOC_HPPA_ABS_CALL_L21,
1443   BFD_RELOC_HPPA_ABS_CALL_R11,
1444   BFD_RELOC_HPPA_ABS_CALL_R14,
1445   BFD_RELOC_HPPA_ABS_CALL_R17,
1446   BFD_RELOC_HPPA_ABS_CALL_LS21,
1447   BFD_RELOC_HPPA_ABS_CALL_RS11,
1448   BFD_RELOC_HPPA_ABS_CALL_RS14,
1449   BFD_RELOC_HPPA_ABS_CALL_RS17,
1450   BFD_RELOC_HPPA_ABS_CALL_LD21,
1451   BFD_RELOC_HPPA_ABS_CALL_RD11,
1452   BFD_RELOC_HPPA_ABS_CALL_RD14,
1453   BFD_RELOC_HPPA_ABS_CALL_RD17,
1454   BFD_RELOC_HPPA_ABS_CALL_LR21,
1455   BFD_RELOC_HPPA_ABS_CALL_RR14,
1456   BFD_RELOC_HPPA_ABS_CALL_RR17,
1457
1458   BFD_RELOC_HPPA_PCREL_CALL_11,
1459   BFD_RELOC_HPPA_PCREL_CALL_12,
1460   BFD_RELOC_HPPA_PCREL_CALL_14,
1461   BFD_RELOC_HPPA_PCREL_CALL_17,
1462   BFD_RELOC_HPPA_PCREL_CALL_L21,
1463   BFD_RELOC_HPPA_PCREL_CALL_R11,
1464   BFD_RELOC_HPPA_PCREL_CALL_R14,
1465   BFD_RELOC_HPPA_PCREL_CALL_R17,
1466   BFD_RELOC_HPPA_PCREL_CALL_LS21,
1467   BFD_RELOC_HPPA_PCREL_CALL_RS11,
1468   BFD_RELOC_HPPA_PCREL_CALL_RS14,
1469   BFD_RELOC_HPPA_PCREL_CALL_RS17,
1470   BFD_RELOC_HPPA_PCREL_CALL_LD21,
1471   BFD_RELOC_HPPA_PCREL_CALL_RD11,
1472   BFD_RELOC_HPPA_PCREL_CALL_RD14,
1473   BFD_RELOC_HPPA_PCREL_CALL_RD17,
1474   BFD_RELOC_HPPA_PCREL_CALL_LR21,
1475   BFD_RELOC_HPPA_PCREL_CALL_RR14,
1476   BFD_RELOC_HPPA_PCREL_CALL_RR17,
1477
1478   BFD_RELOC_HPPA_PLABEL_32,
1479   BFD_RELOC_HPPA_PLABEL_11,
1480   BFD_RELOC_HPPA_PLABEL_14,
1481   BFD_RELOC_HPPA_PLABEL_L21,
1482   BFD_RELOC_HPPA_PLABEL_R11,
1483   BFD_RELOC_HPPA_PLABEL_R14,
1484
1485   BFD_RELOC_HPPA_UNWIND_ENTRY,
1486   BFD_RELOC_HPPA_UNWIND_ENTRIES,
1487
1488    /* i386/elf relocations */
1489   BFD_RELOC_386_GOT32,
1490   BFD_RELOC_386_PLT32,
1491   BFD_RELOC_386_COPY,
1492   BFD_RELOC_386_GLOB_DAT,
1493   BFD_RELOC_386_JUMP_SLOT,
1494   BFD_RELOC_386_RELATIVE,
1495   BFD_RELOC_386_GOTOFF,
1496   BFD_RELOC_386_GOTPC,
1497
1498    /* PowerPC/POWER (RS/6000) relocs.  */
1499    /* 26 bit relative branch.  Low two bits must be zero.  High 24
1500      bits installed in bits 6 through 29 of instruction.  */
1501   BFD_RELOC_PPC_B26,
1502    /* 26 bit absolute branch, like BFD_RELOC_PPC_B26 but absolute.  */
1503   BFD_RELOC_PPC_BA26,
1504    /* 16 bit TOC relative reference.  */
1505   BFD_RELOC_PPC_TOC16,
1506
1507    /* this must be the highest numeric value */
1508   BFD_RELOC_UNUSED
1509  } bfd_reloc_code_real_type;
1510 const struct reloc_howto_struct *
1511
1512 bfd_reloc_type_lookup  PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
1513
1514
1515 typedef struct symbol_cache_entry
1516 {
1517          /* A pointer to the BFD which owns the symbol. This information
1518            is necessary so that a back end can work out what additional
1519            information (invisible to the application writer) is carried
1520            with the symbol.
1521
1522            This field is *almost* redundant, since you can use section->owner
1523            instead, except that some symbols point to the global sections
1524            bfd_{abs,com,und}_section.  This could be fixed by making
1525            these globals be per-bfd (or per-target-flavor).  FIXME. */
1526
1527   struct _bfd *the_bfd;  /* Use bfd_asymbol_bfd(sym) to access this field. */
1528
1529          /* The text of the symbol. The name is left alone, and not copied; the
1530            application may not alter it. */
1531   CONST char *name;
1532
1533          /* The value of the symbol.  This really should be a union of a
1534           numeric value with a pointer, since some flags indicate that
1535           a pointer to another symbol is stored here.  */
1536   symvalue value;
1537
1538          /* Attributes of a symbol: */
1539
1540 #define BSF_NO_FLAGS    0x00
1541
1542          /* The symbol has local scope; <<static>> in <<C>>. The value
1543            is the offset into the section of the data. */
1544 #define BSF_LOCAL       0x01
1545
1546          /* The symbol has global scope; initialized data in <<C>>. The
1547            value is the offset into the section of the data. */
1548 #define BSF_GLOBAL      0x02
1549
1550          /* The symbol has global scope and is exported. The value is
1551            the offset into the section of the data. */
1552 #define BSF_EXPORT      BSF_GLOBAL  /* no real difference */
1553
1554          /* A normal C symbol would be one of:
1555            <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
1556            <<BSF_GLOBAL>> */
1557
1558          /* The symbol is a debugging record. The value has an arbitary
1559            meaning. */
1560 #define BSF_DEBUGGING   0x08
1561
1562          /* The symbol denotes a function entry point.  Used in ELF,
1563            perhaps others someday.  */
1564 #define BSF_FUNCTION    0x10
1565
1566          /* Used by the linker. */
1567 #define BSF_KEEP        0x20
1568 #define BSF_KEEP_G      0x40
1569
1570          /* A weak global symbol, overridable without warnings by
1571            a regular global symbol of the same name.  */
1572 #define BSF_WEAK        0x80
1573
1574         /* This symbol was created to point to a section, e.g. ELF's
1575            STT_SECTION symbols.  */
1576 #define BSF_SECTION_SYM 0x100
1577
1578          /* The symbol used to be a common symbol, but now it is
1579            allocated. */
1580 #define BSF_OLD_COMMON  0x200
1581
1582          /* The default value for common data. */
1583 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1584
1585          /* In some files the type of a symbol sometimes alters its
1586            location in an output file - ie in coff a <<ISFCN>> symbol
1587            which is also <<C_EXT>> symbol appears where it was
1588            declared and not at the end of a section.  This bit is set
1589            by the target BFD part to convey this information. */
1590
1591 #define BSF_NOT_AT_END    0x400
1592
1593          /* Signal that the symbol is the label of constructor section. */
1594 #define BSF_CONSTRUCTOR   0x800
1595
1596          /* Signal that the symbol is a warning symbol. If the symbol
1597            is a warning symbol, then the value field (I know this is
1598            tacky) will point to the asymbol which when referenced will
1599            cause the warning. */
1600 #define BSF_WARNING       0x1000
1601
1602          /* Signal that the symbol is indirect. The value of the symbol
1603            is a pointer to an undefined asymbol which contains the
1604            name to use instead. */
1605 #define BSF_INDIRECT      0x2000
1606
1607          /* BSF_FILE marks symbols that contain a file name.  This is used
1608            for ELF STT_FILE symbols.  */
1609 #define BSF_FILE          0x4000
1610
1611          /* Symbol is from dynamic linking information.  */
1612 #define BSF_DYNAMIC        0x8000
1613
1614   flagword flags;
1615
1616          /* A pointer to the section to which this symbol is
1617            relative.  This will always be non NULL, there are special
1618           sections for undefined and absolute symbols */
1619   struct sec *section;
1620
1621          /* Back end special data. This is being phased out in favour
1622            of making this a union. */
1623   PTR udata;
1624
1625 } asymbol;
1626 #define get_symtab_upper_bound(abfd) \
1627      BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1628 #define bfd_canonicalize_symtab(abfd, location) \
1629      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1630                   (abfd, location))
1631 boolean
1632 bfd_set_symtab  PARAMS ((bfd *abfd, asymbol **location, unsigned int count));
1633
1634 void
1635 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
1636
1637 #define bfd_make_empty_symbol(abfd) \
1638      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1639 #define bfd_make_debug_symbol(abfd,ptr,size) \
1640         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
1641 int
1642 bfd_decode_symclass PARAMS ((asymbol *symbol));
1643
1644 void
1645 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
1646
1647 struct _bfd
1648 {
1649      /* The filename the application opened the BFD with.  */
1650     CONST char *filename;
1651
1652      /* A pointer to the target jump table.             */
1653     struct bfd_target *xvec;
1654
1655      /* To avoid dragging too many header files into every file that
1656        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1657        *", and MTIME as a "long".  Their correct types, to which they
1658        are cast when used, are "FILE *" and "time_t".    The iostream
1659        is the result of an fopen on the filename. */
1660     char *iostream;
1661
1662      /* Is the file descriptor being cached?  That is, can it be closed as
1663        needed, and re-opened when accessed later?  */
1664
1665     boolean cacheable;
1666
1667      /* Marks whether there was a default target specified when the
1668        BFD was opened. This is used to select which matching algorithm
1669        to use to choose the back end. */
1670
1671     boolean target_defaulted;
1672
1673      /* The caching routines use these to maintain a
1674        least-recently-used list of BFDs */
1675
1676     struct _bfd *lru_prev, *lru_next;
1677
1678      /* When a file is closed by the caching routines, BFD retains
1679        state information on the file here: */
1680
1681     file_ptr where;
1682
1683      /* and here: (``once'' means at least once) */
1684
1685     boolean opened_once;
1686
1687      /* Set if we have a locally maintained mtime value, rather than
1688        getting it from the file each time: */
1689
1690     boolean mtime_set;
1691
1692      /* File modified time, if mtime_set is true: */
1693
1694     long mtime;
1695
1696      /* Reserved for an unimplemented file locking extension.*/
1697
1698     int ifd;
1699
1700      /* The format which belongs to the BFD. (object, core, etc.) */
1701
1702     bfd_format format;
1703
1704      /* The direction the BFD was opened with*/
1705
1706     enum bfd_direction {no_direction = 0,
1707                         read_direction = 1,
1708                         write_direction = 2,
1709                         both_direction = 3} direction;
1710
1711      /* Format_specific flags*/
1712
1713     flagword flags;
1714
1715      /* Currently my_archive is tested before adding origin to
1716        anything. I believe that this can become always an add of
1717        origin, with origin set to 0 for non archive files.   */
1718
1719     file_ptr origin;
1720
1721      /* Remember when output has begun, to stop strange things
1722        from happening. */
1723     boolean output_has_begun;
1724
1725      /* Pointer to linked list of sections*/
1726     struct sec  *sections;
1727
1728      /* The number of sections */
1729     unsigned int section_count;
1730
1731      /* Stuff only useful for object files:
1732        The start address. */
1733     bfd_vma start_address;
1734
1735      /* Used for input and output*/
1736     unsigned int symcount;
1737
1738      /* Symbol table for output BFD (with symcount entries) */
1739     struct symbol_cache_entry  **outsymbols;
1740
1741      /* Pointer to structure which contains architecture information*/
1742     struct bfd_arch_info *arch_info;
1743
1744      /* Stuff only useful for archives:*/
1745     PTR arelt_data;
1746     struct _bfd *my_archive;      /* The containing archive BFD.  */
1747     struct _bfd *next;            /* The next BFD in the archive.  */
1748     struct _bfd *archive_head;    /* The first BFD in the archive.  */
1749     boolean has_armap;
1750
1751      /* A chain of BFD structures involved in a link.  */
1752     struct _bfd *link_next;
1753
1754      /* A field used by _bfd_generic_link_add_archive_symbols.  This will
1755        be used only for archive elements.  */
1756     int archive_pass;
1757
1758      /* Used by the back end to hold private data. */
1759
1760     union
1761       {
1762       struct aout_data_struct *aout_data;
1763       struct artdata *aout_ar_data;
1764       struct _oasys_data *oasys_obj_data;
1765       struct _oasys_ar_data *oasys_ar_data;
1766       struct coff_tdata *coff_obj_data;
1767       struct ecoff_tdata *ecoff_obj_data;
1768       struct ieee_data_struct *ieee_data;
1769       struct ieee_ar_data_struct *ieee_ar_data;
1770       struct srec_data_struct *srec_data;
1771       struct tekhex_data_struct *tekhex_data;
1772       struct elf_obj_tdata *elf_obj_data;
1773       struct nlm_obj_tdata *nlm_obj_data;
1774       struct bout_data_struct *bout_data;
1775       struct sun_core_struct *sun_core_data;
1776       struct trad_core_struct *trad_core_data;
1777       struct som_data_struct *som_data;
1778       struct hpux_core_struct *hpux_core_data;
1779       struct hppabsd_core_struct *hppabsd_core_data;
1780       struct sgi_core_struct *sgi_core_data;
1781       struct lynx_core_struct *lynx_core_data;
1782       struct osf_core_struct *osf_core_data;
1783       PTR any;
1784       } tdata;
1785
1786      /* Used by the application to hold private data*/
1787     PTR usrdata;
1788
1789      /* Where all the allocated stuff under this BFD goes */
1790     struct obstack memory;
1791 };
1792
1793 typedef enum bfd_error
1794 {
1795   bfd_error_no_error = 0,
1796   bfd_error_system_call,
1797   bfd_error_invalid_target,
1798   bfd_error_wrong_format,
1799   bfd_error_invalid_operation,
1800   bfd_error_no_memory,
1801   bfd_error_no_symbols,
1802   bfd_error_no_more_archived_files,
1803   bfd_error_malformed_archive,
1804   bfd_error_file_not_recognized,
1805   bfd_error_file_ambiguously_recognized,
1806   bfd_error_no_contents,
1807   bfd_error_nonrepresentable_section,
1808   bfd_error_no_debug_section,
1809   bfd_error_bad_value,
1810   bfd_error_file_truncated,
1811   bfd_error_invalid_error_code
1812 } bfd_error_type;
1813
1814 bfd_error_type
1815 bfd_get_error  PARAMS ((void));
1816
1817 void
1818 bfd_set_error  PARAMS ((bfd_error_type error_tag));
1819
1820 CONST char *
1821 bfd_errmsg  PARAMS ((bfd_error_type error_tag));
1822
1823 void
1824 bfd_perror  PARAMS ((CONST char *message));
1825
1826 unsigned int
1827 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
1828
1829 unsigned int
1830 bfd_canonicalize_reloc
1831  PARAMS ((bfd *abfd,
1832     asection *sec,
1833     arelent **loc,
1834     asymbol     **syms));
1835
1836 void
1837 bfd_set_reloc
1838  PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
1839
1840     );
1841
1842 boolean
1843 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
1844
1845 boolean
1846 bfd_set_start_address PARAMS ((bfd *abfd, bfd_vma vma));
1847
1848 long
1849 bfd_get_mtime PARAMS ((bfd *abfd));
1850
1851 long
1852 bfd_get_size PARAMS ((bfd *abfd));
1853
1854 int
1855 bfd_get_gp_size PARAMS ((bfd *abfd));
1856
1857 void
1858 bfd_set_gp_size PARAMS ((bfd *abfd, int i));
1859
1860 bfd_vma
1861 bfd_scan_vma PARAMS ((CONST char *string, CONST char **end, int base));
1862
1863 #define bfd_sizeof_headers(abfd, reloc) \
1864      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1865
1866 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1867      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
1868
1869         /* Do these three do anything useful at all, for any back end?  */
1870 #define bfd_debug_info_start(abfd) \
1871         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1872
1873 #define bfd_debug_info_end(abfd) \
1874         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1875
1876 #define bfd_debug_info_accumulate(abfd, section) \
1877         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1878
1879
1880 #define bfd_stat_arch_elt(abfd, stat) \
1881         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1882
1883 #define bfd_set_arch_mach(abfd, arch, mach)\
1884         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1885
1886 #define bfd_get_relocated_section_contents(abfd, link_info, link_order, data, relocateable, symbols) \
1887         BFD_SEND (abfd, _bfd_get_relocated_section_contents, \
1888                  (abfd, link_info, link_order, data, relocateable, symbols))
1889
1890 #define bfd_relax_section(abfd, section, link_info, symbols) \
1891        BFD_SEND (abfd, _bfd_relax_section, \
1892                  (abfd, section, link_info, symbols))
1893
1894 #define bfd_link_hash_table_create(abfd) \
1895         BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1896
1897 #define bfd_link_add_symbols(abfd, info) \
1898         BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1899
1900 #define bfd_final_link(abfd, info) \
1901         BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1902
1903 symindex
1904 bfd_get_next_mapent PARAMS ((bfd *abfd, symindex previous, carsym **sym));
1905
1906 boolean
1907 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
1908
1909 bfd *
1910 bfd_get_elt_at_index PARAMS ((bfd *archive, int index));
1911
1912 bfd *
1913 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
1914
1915 CONST char *
1916 bfd_core_file_failing_command PARAMS ((bfd *abfd));
1917
1918 int
1919 bfd_core_file_failing_signal PARAMS ((bfd *abfd));
1920
1921 boolean
1922 core_file_matches_executable_p
1923  PARAMS ((bfd *core_bfd, bfd *exec_bfd));
1924
1925 #define BFD_SEND(bfd, message, arglist) \
1926                ((*((bfd)->xvec->message)) arglist)
1927 #define BFD_SEND_FMT(bfd, message, arglist) \
1928             (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1929 enum bfd_flavour {
1930   bfd_target_unknown_flavour,
1931   bfd_target_aout_flavour,
1932   bfd_target_coff_flavour,
1933   bfd_target_ecoff_flavour,
1934   bfd_target_elf_flavour,
1935   bfd_target_ieee_flavour,
1936   bfd_target_nlm_flavour,
1937   bfd_target_oasys_flavour,
1938   bfd_target_tekhex_flavour,
1939   bfd_target_srec_flavour,
1940   bfd_target_som_flavour};
1941
1942  /* Forward declaration.  */
1943 typedef struct bfd_link_info _bfd_link_info;
1944
1945 typedef struct bfd_target
1946 {
1947   char *name;
1948   enum bfd_flavour flavour;
1949   boolean byteorder_big_p;
1950   boolean header_byteorder_big_p;
1951   flagword object_flags;
1952   flagword section_flags;
1953   char symbol_leading_char;
1954   char ar_pad_char;
1955   unsigned short ar_max_namelen;
1956   unsigned int align_power_min;
1957   bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
1958   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
1959   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
1960   bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
1961   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
1962   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
1963   bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
1964   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
1965   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
1966   bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
1967   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
1968   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
1969   bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
1970   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
1971   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
1972   bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
1973   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
1974   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
1975   struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
1976   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
1977   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
1978   char *   (*_core_file_failing_command) PARAMS ((bfd *));
1979   int      (*_core_file_failing_signal) PARAMS ((bfd *));
1980   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
1981   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
1982   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
1983   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
1984   boolean  (*write_armap) PARAMS ((bfd *arch,
1985                               unsigned int elength,
1986                               struct orl *map,
1987                               unsigned int orl_count,
1988                               int stridx));
1989   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
1990   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1991                                             file_ptr, bfd_size_type));
1992   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1993                                             file_ptr, bfd_size_type));
1994   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
1995   unsigned int  (*_get_symtab_upper_bound) PARAMS ((bfd *));
1996   unsigned int  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
1997                                               struct symbol_cache_entry **));
1998   unsigned int  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
1999   unsigned int  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
2000                                               struct symbol_cache_entry **));
2001   struct symbol_cache_entry  *
2002                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
2003   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
2004                                       struct symbol_cache_entry *,
2005                                       bfd_print_symbol_type));
2006 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2007   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
2008                                       struct symbol_cache_entry *,
2009                                       symbol_info *));
2010 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
2011   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
2012
2013   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
2014                     unsigned long));
2015
2016   bfd *      (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
2017
2018   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
2019                     struct sec *section, struct symbol_cache_entry **symbols,
2020                     bfd_vma offset, CONST char **file, CONST char **func,
2021                     unsigned int *line));
2022
2023   int        (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
2024
2025   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
2026
2027   void       (*_bfd_debug_info_start) PARAMS ((bfd *));
2028   void       (*_bfd_debug_info_end) PARAMS ((bfd *));
2029   void       (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
2030
2031   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
2032                     struct bfd_link_info *, struct bfd_link_order *,
2033                     bfd_byte *data, boolean relocateable,
2034                     struct symbol_cache_entry **));
2035
2036   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
2037                     struct bfd_link_info *, struct symbol_cache_entry **));
2038
2039   /* See documentation on reloc types.  */
2040  CONST struct reloc_howto_struct *
2041        (*reloc_type_lookup) PARAMS ((bfd *abfd,
2042                                      bfd_reloc_code_real_type code));
2043
2044   /* Back-door to allow format-aware applications to create debug symbols
2045     while using BFD for everything else.  Currently used by the assembler
2046     when creating COFF files.  */
2047  asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
2048        bfd *abfd,
2049        void *ptr,
2050        unsigned long size));
2051
2052   /* Create a hash table for the linker.  Different backends store
2053     different information in this table.  */
2054  struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
2055
2056   /* Add symbols from this object file into the hash table.  */
2057  boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
2058
2059   /* Do a link based on the link_order structures attached to each
2060     section of the BFD.  */
2061  boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
2062
2063  PTR backend_data;
2064 } bfd_target;
2065 bfd_target *
2066 bfd_find_target PARAMS ((CONST char *target_name, bfd *abfd));
2067
2068 CONST char **
2069 bfd_target_list PARAMS ((void));
2070
2071 boolean
2072 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
2073
2074 boolean
2075 bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
2076
2077 boolean
2078 bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
2079
2080 CONST char *
2081 bfd_format_string PARAMS ((bfd_format format));
2082
2083 #endif