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