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