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