bfd/bfd-in2.h

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