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