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