bfd/bfd-in2.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 98, 1999
   3    Free Software Foundation, Inc.
   4    Contributed by Cygnus Support.
   5
   6 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
   7 ** instead, change bfd-in.h or the other BFD source files processed to
   8 ** generate these files.
   9
  10 This file is part of BFD, the Binary File Descriptor library.
  11
  12 This program is free software; you can redistribute it and/or modify
  13 it under the terms of the GNU General Public License as published by
  14 the Free Software Foundation; either version 2 of the License, or
  15 (at your option) any later version.
  16
  17 This program is distributed in the hope that it will be useful,
  18 but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 GNU General Public License for more details.
  21
  22 You should have received a copy of the GNU General Public License
  23 along with this program; if not, write to the Free Software
  24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  25
  26 /* bfd.h -- The only header file required by users of the bfd library
  27
  28 The bfd.h file is generated from bfd-in.h and various .c files; if you
  29 change it, your changes will probably be lost.
  30
  31 All the prototypes and definitions following the comment "THE FOLLOWING
  32 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  33 BFD.  If you change it, someone oneday will extract it from the source
  34 again, and your changes will be lost.  To save yourself from this bind,
  35 change the definitions in the source in the bfd directory.  Type "make
  36 docs" and then "make headers" in that directory, and magically this file
  37 will change to reflect your changes.
  38
  39 If you don't have the tools to perform the extraction, then you are
  40 safe from someone on your system trampling over your header files.
  41 You should still maintain the equivalence between the source and this
  42 file though; every change you make to the .c file should be reflected
  43 here.  */
  44
  45 #ifndef __BFD_H_SEEN__
  46 #define __BFD_H_SEEN__
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #include "ansidecl.h"
  53
  54 /* These two lines get substitutions done by commands in Makefile.in.  */
  55 #define BFD_VERSION  "@VERSION@"
  56 #define BFD_ARCH_SIZE @wordsize@
  57 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  58 #if @BFD_HOST_64_BIT_DEFINED@
  59 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  60 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  61 #endif
  62
  63 #if BFD_ARCH_SIZE >= 64
  64 #define BFD64
  65 #endif
  66
  67 #ifndef INLINE
  68 #if __GNUC__ >= 2
  69 #define INLINE __inline__
  70 #else
  71 #define INLINE
  72 #endif
  73 #endif
  74
  75 /* forward declaration */
  76 typedef struct _bfd bfd;
  77
  78 /* To squelch erroneous compiler warnings ("illegal pointer
  79    combination") from the SVR3 compiler, we would like to typedef
  80    boolean to int (it doesn't like functions which return boolean.
  81    Making sure they are never implicitly declared to return int
  82    doesn't seem to help).  But this file is not configured based on
  83    the host.  */
  84 /* General rules: functions which are boolean return true on success
  85    and false on failure (unless they're a predicate).   -- bfd.doc */
  86 /* I'm sure this is going to break something and someone is going to
  87    force me to change it. */
  88 /* typedef enum boolean {false, true} boolean; */
  89 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  90 /* It gets worse if the host also defines a true/false enum... -sts */
  91 /* And even worse if your compiler has built-in boolean types... -law */
  92 #if defined (__GNUG__) && (__GNUC_MINOR__ > 5)
  93 #define TRUE_FALSE_ALREADY_DEFINED
  94 #endif
  95 #ifdef MPW
  96 /* Pre-emptive strike - get the file with the enum. */
  97 #include <Types.h>
  98 #define TRUE_FALSE_ALREADY_DEFINED
  99 #endif /* MPW */
 100 #ifndef TRUE_FALSE_ALREADY_DEFINED
 101 typedef enum bfd_boolean {false, true} boolean;
 102 #define BFD_TRUE_FALSE
 103 #else
 104 /* Use enum names that will appear nowhere else.  */
 105 typedef enum bfd_boolean {bfd_fffalse, bfd_tttrue} boolean;
 106 #endif
 107
 108 /* A pointer to a position in a file.  */
 109 /* FIXME:  This should be using off_t from <sys/types.h>.
 110    For now, try to avoid breaking stuff by not including <sys/types.h> here.
 111    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
 112    Probably the best long-term answer is to avoid using file_ptr AND off_t
 113    in this header file, and to handle this in the BFD implementation
 114    rather than in its interface.  */
 115 /* typedef off_t        file_ptr; */
 116 typedef long int file_ptr;
 117
 118 /* Support for different sizes of target format ints and addresses.
 119    If the type `long' is at least 64 bits, BFD_HOST_64BIT_LONG will be
 120    set to 1 above.  Otherwise, if gcc is being used, this code will
 121    use gcc's "long long" type.  Otherwise, BFD_HOST_64_BIT must be
 122    defined above.  */
 123
 124 #ifndef BFD_HOST_64_BIT
 125 # if BFD_HOST_64BIT_LONG
 126 #  define BFD_HOST_64_BIT long
 127 #  define BFD_HOST_U_64_BIT unsigned long
 128 # else
 129 #  ifdef __GNUC__
 130 #   if __GNUC__ >= 2
 131 #    define BFD_HOST_64_BIT long long
 132 #    define BFD_HOST_U_64_BIT unsigned long long
 133 #   endif /* __GNUC__ >= 2 */
 134 #  endif /* ! defined (__GNUC__) */
 135 # endif /* ! BFD_HOST_64BIT_LONG */
 136 #endif /* ! defined (BFD_HOST_64_BIT) */
 137
 138 #ifdef BFD64
 139
 140 #ifndef BFD_HOST_64_BIT
 141  #error No 64 bit integer type available
 142 #endif /* ! defined (BFD_HOST_64_BIT) */
 143
 144 typedef BFD_HOST_U_64_BIT bfd_vma;
 145 typedef BFD_HOST_64_BIT bfd_signed_vma;
 146 typedef BFD_HOST_U_64_BIT bfd_size_type;
 147 typedef BFD_HOST_U_64_BIT symvalue;
 148
 149 #ifndef fprintf_vma
 150 #if BFD_HOST_64BIT_LONG
 151 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 152 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 153 #else
 154 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 155 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 156 #define fprintf_vma(s,x) \
 157   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 158 #define sprintf_vma(s,x) \
 159   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 160 #endif
 161 #endif
 162
 163 #else /* not BFD64  */
 164
 165 /* Represent a target address.  Also used as a generic unsigned type
 166    which is guaranteed to be big enough to hold any arithmetic types
 167    we need to deal with.  */
 168 typedef unsigned long bfd_vma;
 169
 170 /* A generic signed type which is guaranteed to be big enough to hold any
 171    arithmetic types we need to deal with.  Can be assumed to be compatible
 172    with bfd_vma in the same way that signed and unsigned ints are compatible
 173    (as parameters, in assignment, etc).  */
 174 typedef long bfd_signed_vma;
 175
 176 typedef unsigned long symvalue;
 177 typedef unsigned long bfd_size_type;
 178
 179 /* Print a bfd_vma x on stream s.  */
 180 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 181 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
 182
 183 #endif /* not BFD64  */
 184
 185 #define printf_vma(x) fprintf_vma(stdout,x)
 186
 187 typedef unsigned int flagword;  /* 32 bits of flags */
 188 typedef unsigned char bfd_byte;
 189 \f
 190 /** File formats */
 191
 192 typedef enum bfd_format {
 193               bfd_unknown = 0,  /* file format is unknown */
 194               bfd_object,       /* linker/assember/compiler output */
 195               bfd_archive,      /* object archive file */
 196               bfd_core,         /* core dump */
 197               bfd_type_end}     /* marks the end; don't use it! */
 198          bfd_format;
 199
 200 /* Values that may appear in the flags field of a BFD.  These also
 201    appear in the object_flags field of the bfd_target structure, where
 202    they indicate the set of flags used by that backend (not all flags
 203    are meaningful for all object file formats) (FIXME: at the moment,
 204    the object_flags values have mostly just been copied from backend
 205    to another, and are not necessarily correct).  */
 206
 207 /* No flags.  */
 208 #define BFD_NO_FLAGS    0x00
 209
 210 /* BFD contains relocation entries.  */
 211 #define HAS_RELOC       0x01
 212
 213 /* BFD is directly executable.  */
 214 #define EXEC_P          0x02
 215
 216 /* BFD has line number information (basically used for F_LNNO in a
 217    COFF header).  */
 218 #define HAS_LINENO      0x04
 219
 220 /* BFD has debugging information.  */
 221 #define HAS_DEBUG       0x08
 222
 223 /* BFD has symbols.  */
 224 #define HAS_SYMS        0x10
 225
 226 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 227    header).  */
 228 #define HAS_LOCALS      0x20
 229
 230 /* BFD is a dynamic object.  */
 231 #define DYNAMIC         0x40
 232
 233 /* Text section is write protected (if D_PAGED is not set, this is
 234    like an a.out NMAGIC file) (the linker sets this by default, but
 235    clears it for -r or -N).  */
 236 #define WP_TEXT         0x80
 237
 238 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 239    linker sets this by default, but clears it for -r or -n or -N).  */
 240 #define D_PAGED         0x100
 241
 242 /* BFD is relaxable (this means that bfd_relax_section may be able to
 243    do something) (sometimes bfd_relax_section can do something even if
 244    this is not set).  */
 245 #define BFD_IS_RELAXABLE 0x200
 246
 247 /* This may be set before writing out a BFD to request using a
 248    traditional format.  For example, this is used to request that when
 249    writing out an a.out object the symbols not be hashed to eliminate
 250    duplicates.  */
 251 #define BFD_TRADITIONAL_FORMAT 0x400
 252
 253 /* This flag indicates that the BFD contents are actually cached in
 254    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
 255 #define BFD_IN_MEMORY 0x800
 256 \f
 257 /* symbols and relocation */
 258
 259 /* A count of carsyms (canonical archive symbols).  */
 260 typedef unsigned long symindex;
 261
 262 /* How to perform a relocation.  */
 263 typedef const struct reloc_howto_struct reloc_howto_type;
 264
 265 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 266
 267 /* General purpose part of a symbol X;
 268    target specific parts are in libcoff.h, libaout.h, etc.  */
 269
 270 #define bfd_get_section(x) ((x)->section)
 271 #define bfd_get_output_section(x) ((x)->section->output_section)
 272 #define bfd_set_section(x,y) ((x)->section) = (y)
 273 #define bfd_asymbol_base(x) ((x)->section->vma)
 274 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 275 #define bfd_asymbol_name(x) ((x)->name)
 276 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 277 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 278 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 279
 280 /* A canonical archive symbol.  */
 281 /* This is a type pun with struct ranlib on purpose! */
 282 typedef struct carsym {
 283   char *name;
 284   file_ptr file_offset;         /* look here to find the file */
 285 } carsym;                       /* to make these you call a carsymogen */
 286
 287
 288 /* Used in generating armaps (archive tables of contents).
 289    Perhaps just a forward definition would do? */
 290 struct orl {                    /* output ranlib */
 291   char **name;                  /* symbol name */
 292   file_ptr pos;                 /* bfd* or file position */
 293   int namidx;                   /* index into string table */
 294 };
 295 \f
 296
 297 /* Linenumber stuff */
 298 typedef struct lineno_cache_entry {
 299   unsigned int line_number;     /* Linenumber from start of function*/
 300   union {
 301     struct symbol_cache_entry *sym; /* Function name */
 302     unsigned long offset;       /* Offset into section */
 303   } u;
 304 } alent;
 305 \f
 306 /* object and core file sections */
 307
 308 #define align_power(addr, align)        \
 309         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 310
 311 typedef struct sec *sec_ptr;
 312
 313 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 314 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 315 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 316 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 317 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 318 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 319 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 320 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 321 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 322 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 323
 324 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 325
 326 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = (boolean)true), true)
 327 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 328 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 329
 330 typedef struct stat stat_type;
 331 \f
 332 typedef enum bfd_print_symbol
 333 {
 334   bfd_print_symbol_name,
 335   bfd_print_symbol_more,
 336   bfd_print_symbol_all
 337 } bfd_print_symbol_type;
 338
 339 /* Information about a symbol that nm needs.  */
 340
 341 typedef struct _symbol_info
 342 {
 343   symvalue value;
 344   char type;
 345   CONST char *name;            /* Symbol name.  */
 346   unsigned char stab_type;     /* Stab type.  */
 347   char stab_other;             /* Stab other. */
 348   short stab_desc;             /* Stab desc.  */
 349   CONST char *stab_name;       /* String for stab type.  */
 350 } symbol_info;
 351
 352 /* Get the name of a stabs type code.  */
 353
 354 extern const char *bfd_get_stab_name PARAMS ((int));
 355 \f
 356 /* Hash table routines.  There is no way to free up a hash table.  */
 357
 358 /* An element in the hash table.  Most uses will actually use a larger
 359    structure, and an instance of this will be the first field.  */
 360
 361 struct bfd_hash_entry
 362 {
 363   /* Next entry for this hash code.  */
 364   struct bfd_hash_entry *next;
 365   /* String being hashed.  */
 366   const char *string;
 367   /* Hash code.  This is the full hash code, not the index into the
 368      table.  */
 369   unsigned long hash;
 370 };
 371
 372 /* A hash table.  */
 373
 374 struct bfd_hash_table
 375 {
 376   /* The hash array.  */
 377   struct bfd_hash_entry **table;
 378   /* The number of slots in the hash table.  */
 379   unsigned int size;
 380   /* A function used to create new elements in the hash table.  The
 381      first entry is itself a pointer to an element.  When this
 382      function is first invoked, this pointer will be NULL.  However,
 383      having the pointer permits a hierarchy of method functions to be
 384      built each of which calls the function in the superclass.  Thus
 385      each function should be written to allocate a new block of memory
 386      only if the argument is NULL.  */
 387   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
 388                                              struct bfd_hash_table *,
 389                                              const char *));
 390    /* An objalloc for this hash table.  This is a struct objalloc *,
 391      but we use PTR to avoid requiring the inclusion of objalloc.h.  */
 392   PTR memory;
 393 };
 394
 395 /* Initialize a hash table.  */
 396 extern boolean bfd_hash_table_init
 397   PARAMS ((struct bfd_hash_table *,
 398            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 399                                        struct bfd_hash_table *,
 400                                        const char *)));
 401
 402 /* Initialize a hash table specifying a size.  */
 403 extern boolean bfd_hash_table_init_n
 404   PARAMS ((struct bfd_hash_table *,
 405            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 406                                        struct bfd_hash_table *,
 407                                        const char *),
 408            unsigned int size));
 409
 410 /* Free up a hash table.  */
 411 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
 412
 413 /* Look up a string in a hash table.  If CREATE is true, a new entry
 414    will be created for this string if one does not already exist.  The
 415    COPY argument must be true if this routine should copy the string
 416    into newly allocated memory when adding an entry.  */
 417 extern struct bfd_hash_entry *bfd_hash_lookup
 418   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
 419            boolean copy));
 420
 421 /* Replace an entry in a hash table.  */
 422 extern void bfd_hash_replace
 423   PARAMS ((struct bfd_hash_table *, struct bfd_hash_entry *old,
 424            struct bfd_hash_entry *nw));
 425
 426 /* Base method for creating a hash table entry.  */
 427 extern struct bfd_hash_entry *bfd_hash_newfunc
 428   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
 429            const char *));
 430
 431 /* Grab some space for a hash table entry.  */
 432 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
 433                                       unsigned int));
 434
 435 /* Traverse a hash table in a random order, calling a function on each
 436    element.  If the function returns false, the traversal stops.  The
 437    INFO argument is passed to the function.  */
 438 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
 439                                        boolean (*) (struct bfd_hash_entry *,
 440                                                     PTR),
 441                                        PTR info));
 442 \f
 443 /* Semi-portable string concatenation in cpp.
 444    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
 445    The problem is, "32_" is not a valid preprocessing token, and we don't
 446    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
 447    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
 448    Then the final concatenation can be done.  (Sigh.)  */
 449 #ifndef CAT
 450 #ifdef SABER
 451 #define CAT(a,b)        a##b
 452 #define CAT3(a,b,c)     a##b##c
 453 #define CAT4(a,b,c,d)   a##b##c##d
 454 #else
 455 #if defined(__STDC__) || defined(ALMOST_STDC)
 456 #define CAT(a,b) a##b
 457 #define CAT3(a,b,c) a##b##c
 458 #define XCAT2(a,b)      CAT(a,b)
 459 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
 460 #else
 461 #define CAT(a,b) a/**/b
 462 #define CAT3(a,b,c) a/**/b/**/c
 463 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
 464 #endif
 465 #endif
 466 #endif
 467
 468 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 469 \f
 470 /* User program access to BFD facilities */
 471
 472 /* Direct I/O routines, for programs which know more about the object
 473    file than BFD does.  Use higher level routines if possible.  */
 474
 475 extern bfd_size_type bfd_read
 476   PARAMS ((PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
 477 extern bfd_size_type bfd_write
 478   PARAMS ((const PTR, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
 479 extern int bfd_seek PARAMS ((bfd *abfd, file_ptr fp, int direction));
 480 extern long bfd_tell PARAMS ((bfd *abfd));
 481 extern int bfd_flush PARAMS ((bfd *abfd));
 482 extern int bfd_stat PARAMS ((bfd *abfd, struct stat *));
 483
 484
 485 /* Cast from const char * to char * so that caller can assign to
 486    a char * without a warning.  */
 487 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 488 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 489 #define bfd_get_format(abfd) ((abfd)->format)
 490 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 491 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 492 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 493 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 494 #define bfd_header_big_endian(abfd) \
 495   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 496 #define bfd_header_little_endian(abfd) \
 497   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 498 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 499 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 500 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 501 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 502 #define bfd_has_map(abfd) ((abfd)->has_armap)
 503
 504 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 505 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 506
 507 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 508 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 509 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 510 #define bfd_count_sections(abfd) ((abfd)->section_count)
 511
 512 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 513
 514 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (boolean)(bool)), true)
 515
 516 extern boolean bfd_record_phdr
 517   PARAMS ((bfd *, unsigned long, boolean, flagword, boolean, bfd_vma,
 518            boolean, boolean, unsigned int, struct sec **));
 519
 520 /* Byte swapping routines.  */
 521
 522 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 523 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 524 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 525 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 526 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 527 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 528 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 529 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 530 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 531 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 532 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 533 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 534 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 535 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 536 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 537 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 538 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 539 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 540 \f
 541 /* Externally visible ECOFF routines.  */
 542
 543 #if defined(__STDC__) || defined(ALMOST_STDC)
 544 struct ecoff_debug_info;
 545 struct ecoff_debug_swap;
 546 struct ecoff_extr;
 547 struct symbol_cache_entry;
 548 struct bfd_link_info;
 549 struct bfd_link_hash_entry;
 550 struct bfd_elf_version_tree;
 551 #endif
 552 extern bfd_vma bfd_ecoff_get_gp_value PARAMS ((bfd * abfd));
 553 extern boolean bfd_ecoff_set_gp_value PARAMS ((bfd *abfd, bfd_vma gp_value));
 554 extern boolean bfd_ecoff_set_regmasks
 555   PARAMS ((bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 556            unsigned long *cprmask));
 557 extern PTR bfd_ecoff_debug_init
 558   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 559            const struct ecoff_debug_swap *output_swap,
 560            struct bfd_link_info *));
 561 extern void bfd_ecoff_debug_free
 562   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 563            const struct ecoff_debug_swap *output_swap,
 564            struct bfd_link_info *));
 565 extern boolean bfd_ecoff_debug_accumulate
 566   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 567            const struct ecoff_debug_swap *output_swap,
 568            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 569            const struct ecoff_debug_swap *input_swap,
 570            struct bfd_link_info *));
 571 extern boolean bfd_ecoff_debug_accumulate_other
 572   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 573            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 574            struct bfd_link_info *));
 575 extern boolean bfd_ecoff_debug_externals
 576   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 577            const struct ecoff_debug_swap *swap,
 578            boolean relocateable,
 579            boolean (*get_extr) (struct symbol_cache_entry *,
 580                                 struct ecoff_extr *),
 581            void (*set_index) (struct symbol_cache_entry *,
 582                               bfd_size_type)));
 583 extern boolean bfd_ecoff_debug_one_external
 584   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 585            const struct ecoff_debug_swap *swap,
 586            const char *name, struct ecoff_extr *esym));
 587 extern bfd_size_type bfd_ecoff_debug_size
 588   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 589            const struct ecoff_debug_swap *swap));
 590 extern boolean bfd_ecoff_write_debug
 591   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 592            const struct ecoff_debug_swap *swap, file_ptr where));
 593 extern boolean bfd_ecoff_write_accumulated_debug
 594   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 595            const struct ecoff_debug_swap *swap,
 596            struct bfd_link_info *info, file_ptr where));
 597 extern boolean bfd_mips_ecoff_create_embedded_relocs
 598   PARAMS ((bfd *, struct bfd_link_info *, struct sec *, struct sec *,
 599            char **));
 600
 601 /* Externally visible ELF routines.  */
 602
 603 struct bfd_link_needed_list
 604 {
 605   struct bfd_link_needed_list *next;
 606   bfd *by;
 607   const char *name;
 608 };
 609
 610 extern boolean bfd_elf32_record_link_assignment
 611   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 612 extern boolean bfd_elf64_record_link_assignment
 613   PARAMS ((bfd *, struct bfd_link_info *, const char *, boolean));
 614 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 615   PARAMS ((bfd *, struct bfd_link_info *));
 616 extern boolean bfd_elf_get_bfd_needed_list
 617   PARAMS ((bfd *, struct bfd_link_needed_list **));
 618 extern boolean bfd_elf32_size_dynamic_sections
 619   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
 620            const char * const *, struct bfd_link_info *, struct sec **,
 621            struct bfd_elf_version_tree *));
 622 extern boolean bfd_elf64_size_dynamic_sections
 623   PARAMS ((bfd *, const char *, const char *, boolean, const char *,
 624            const char * const *, struct bfd_link_info *, struct sec **,
 625            struct bfd_elf_version_tree *));
 626 extern void bfd_elf_set_dt_needed_name PARAMS ((bfd *, const char *));
 627 extern const char *bfd_elf_get_dt_soname PARAMS ((bfd *));
 628
 629 /* Return an upper bound on the number of bytes required to store a
 630    copy of ABFD's program header table entries.  Return -1 if an error
 631    occurs; bfd_get_error will return an appropriate code.  */
 632 extern long bfd_get_elf_phdr_upper_bound PARAMS ((bfd *abfd));
 633
 634 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 635    will be stored as an array of Elf_Internal_Phdr structures, as
 636    defined in include/elf/internal.h.  To find out how large the
 637    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 638
 639    Return the number of program header table entries read, or -1 if an
 640    error occurs; bfd_get_error will return an appropriate code.  */
 641 extern int bfd_get_elf_phdrs PARAMS ((bfd *abfd, void *phdrs));
 642
 643 /* SunOS shared library support routines for the linker.  */
 644
 645 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 646   PARAMS ((bfd *, struct bfd_link_info *));
 647 extern boolean bfd_sunos_record_link_assignment
 648   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 649 extern boolean bfd_sunos_size_dynamic_sections
 650   PARAMS ((bfd *, struct bfd_link_info *, struct sec **, struct sec **,
 651            struct sec **));
 652
 653 /* Linux shared library support routines for the linker.  */
 654
 655 extern boolean bfd_i386linux_size_dynamic_sections
 656   PARAMS ((bfd *, struct bfd_link_info *));
 657 extern boolean bfd_m68klinux_size_dynamic_sections
 658   PARAMS ((bfd *, struct bfd_link_info *));
 659 extern boolean bfd_sparclinux_size_dynamic_sections
 660   PARAMS ((bfd *, struct bfd_link_info *));
 661
 662 /* mmap hacks */
 663
 664 struct _bfd_window_internal;
 665 typedef struct _bfd_window_internal bfd_window_internal;
 666
 667 typedef struct _bfd_window {
 668   /* What the user asked for.  */
 669   PTR data;
 670   bfd_size_type size;
 671   /* The actual window used by BFD.  Small user-requested read-only
 672      regions sharing a page may share a single window into the object
 673      file.  Read-write versions shouldn't until I've fixed things to
 674      keep track of which portions have been claimed by the
 675      application; don't want to give the same region back when the
 676      application wants two writable copies!  */
 677   struct _bfd_window_internal *i;
 678 } bfd_window;
 679
 680 extern void bfd_init_window PARAMS ((bfd_window *));
 681 extern void bfd_free_window PARAMS ((bfd_window *));
 682 extern boolean bfd_get_file_window
 683   PARAMS ((bfd *, file_ptr, bfd_size_type, bfd_window *, boolean));
 684
 685 /* XCOFF support routines for the linker.  */
 686
 687 extern boolean bfd_xcoff_link_record_set
 688   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 689            bfd_size_type));
 690 extern boolean bfd_xcoff_import_symbol
 691   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 692            bfd_vma, const char *, const char *, const char *));
 693 extern boolean bfd_xcoff_export_symbol
 694   PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *,
 695            boolean));
 696 extern boolean bfd_xcoff_link_count_reloc
 697   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 698 extern boolean bfd_xcoff_record_link_assignment
 699   PARAMS ((bfd *, struct bfd_link_info *, const char *));
 700 extern boolean bfd_xcoff_size_dynamic_sections
 701   PARAMS ((bfd *, struct bfd_link_info *, const char *, const char *,
 702            unsigned long, unsigned long, unsigned long, boolean,
 703            int, boolean, boolean, struct sec **));
 704
 705 /* Externally visible COFF routines.  */
 706
 707 #if defined(__STDC__) || defined(ALMOST_STDC)
 708 struct internal_syment;
 709 union internal_auxent;
 710 #endif
 711
 712 extern boolean bfd_coff_get_syment
 713   PARAMS ((bfd *, struct symbol_cache_entry *, struct internal_syment *));
 714
 715 extern boolean bfd_coff_get_auxent
 716   PARAMS ((bfd *, struct symbol_cache_entry *, int, union internal_auxent *));
 717
 718 extern boolean bfd_coff_set_symbol_class
 719   PARAMS ((bfd *, struct symbol_cache_entry *, unsigned int));
 720
 721 /* ARM Interworking support.  Called from linker.  */
 722 extern boolean bfd_arm_allocate_interworking_sections
 723   PARAMS ((struct bfd_link_info *));
 724
 725 extern boolean bfd_arm_process_before_allocation
 726   PARAMS ((bfd *, struct bfd_link_info *, int));
 727
 728 extern boolean bfd_arm_get_bfd_for_interworking
 729   PARAMS ((bfd *, struct bfd_link_info *));
 730
 731 /* ELF ARM Interworking support.  Called from linker.  */
 732 extern boolean bfd_elf32_arm_allocate_interworking_sections
 733   PARAMS ((struct bfd_link_info *));
 734
 735 extern boolean bfd_elf32_arm_process_before_allocation
 736   PARAMS ((bfd *, struct bfd_link_info *, int));
 737
 738 extern boolean bfd_elf32_arm_get_bfd_for_interworking
 739   PARAMS ((bfd *, struct bfd_link_info *));
 740
 741 /* And more from the source.  */
 742 void
 743 bfd_init PARAMS ((void));
 744
 745 bfd *
 746 bfd_openr PARAMS ((CONST char *filename, CONST char *target));
 747
 748 bfd *
 749 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
 750
 751 bfd *
 752 bfd_openstreamr PARAMS ((const char *, const char *, PTR));
 753
 754 bfd *
 755 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
 756
 757 boolean
 758 bfd_close PARAMS ((bfd *abfd));
 759
 760 boolean
 761 bfd_close_all_done PARAMS ((bfd *));
 762
 763 bfd *
 764 bfd_create PARAMS ((CONST char *filename, bfd *templ));
 765
 766 boolean
 767 bfd_make_writable PARAMS ((bfd *abfd));
 768
 769 boolean
 770 bfd_make_readable PARAMS ((bfd *abfd));
 771
 772
 773  /* Byte swapping macros for user section data.  */
 774
 775 #define bfd_put_8(abfd, val, ptr) \
 776                 ((void) (*((unsigned char *)(ptr)) = (unsigned char)(val)))
 777 #define bfd_put_signed_8 \
 778                bfd_put_8
 779 #define bfd_get_8(abfd, ptr) \
 780                 (*(unsigned char *)(ptr))
 781 #define bfd_get_signed_8(abfd, ptr) \
 782                ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
 783
 784 #define bfd_put_16(abfd, val, ptr) \
 785                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
 786 #define bfd_put_signed_16 \
 787                 bfd_put_16
 788 #define bfd_get_16(abfd, ptr) \
 789                 BFD_SEND(abfd, bfd_getx16, (ptr))
 790 #define bfd_get_signed_16(abfd, ptr) \
 791                 BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
 792
 793 #define bfd_put_32(abfd, val, ptr) \
 794                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
 795 #define bfd_put_signed_32 \
 796                 bfd_put_32
 797 #define bfd_get_32(abfd, ptr) \
 798                 BFD_SEND(abfd, bfd_getx32, (ptr))
 799 #define bfd_get_signed_32(abfd, ptr) \
 800                 BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
 801
 802 #define bfd_put_64(abfd, val, ptr) \
 803                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
 804 #define bfd_put_signed_64 \
 805                 bfd_put_64
 806 #define bfd_get_64(abfd, ptr) \
 807                 BFD_SEND(abfd, bfd_getx64, (ptr))
 808 #define bfd_get_signed_64(abfd, ptr) \
 809                 BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
 810
 811 #define bfd_get(bits, abfd, ptr)                               \
 812                 ((bits) == 8 ? bfd_get_8 (abfd, ptr)           \
 813                 : (bits) == 16 ? bfd_get_16 (abfd, ptr)        \
 814                 : (bits) == 32 ? bfd_get_32 (abfd, ptr)        \
 815                 : (bits) == 64 ? bfd_get_64 (abfd, ptr)        \
 816                 : (abort (), (bfd_vma) - 1))
 817
 818 #define bfd_put(bits, abfd, val, ptr)                          \
 819                 ((bits) == 8 ? bfd_put_8 (abfd, val, ptr)      \
 820                 : (bits) == 16 ? bfd_put_16 (abfd, val, ptr)   \
 821                 : (bits) == 32 ? bfd_put_32 (abfd, val, ptr)   \
 822                 : (bits) == 64 ? bfd_put_64 (abfd, val, ptr)   \
 823                 : (abort (), (void) 0))
 824
 825
 826  /* Byte swapping macros for file header data.  */
 827
 828 #define bfd_h_put_8(abfd, val, ptr) \
 829                bfd_put_8 (abfd, val, ptr)
 830 #define bfd_h_put_signed_8(abfd, val, ptr) \
 831                bfd_put_8 (abfd, val, ptr)
 832 #define bfd_h_get_8(abfd, ptr) \
 833                bfd_get_8 (abfd, ptr)
 834 #define bfd_h_get_signed_8(abfd, ptr) \
 835                bfd_get_signed_8 (abfd, ptr)
 836
 837 #define bfd_h_put_16(abfd, val, ptr) \
 838                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
 839 #define bfd_h_put_signed_16 \
 840                 bfd_h_put_16
 841 #define bfd_h_get_16(abfd, ptr) \
 842                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
 843 #define bfd_h_get_signed_16(abfd, ptr) \
 844                 BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
 845
 846 #define bfd_h_put_32(abfd, val, ptr) \
 847                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
 848 #define bfd_h_put_signed_32 \
 849                 bfd_h_put_32
 850 #define bfd_h_get_32(abfd, ptr) \
 851                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
 852 #define bfd_h_get_signed_32(abfd, ptr) \
 853                 BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
 854
 855 #define bfd_h_put_64(abfd, val, ptr) \
 856                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
 857 #define bfd_h_put_signed_64 \
 858                 bfd_h_put_64
 859 #define bfd_h_get_64(abfd, ptr) \
 860                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
 861 #define bfd_h_get_signed_64(abfd, ptr) \
 862                 BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
 863
 864   /* This structure is used for a comdat section, as in PE.  A comdat
 865     section is associated with a particular symbol.  When the linker
 866     sees a comdat section, it keeps only one of the sections with a
 867     given name and associated with a given symbol. */
 868
 869 struct bfd_comdat_info
 870 {
 871    /* The name of the symbol associated with a comdat section.  */
 872   const char *name;
 873
 874    /* The local symbol table index of the symbol associated with a
 875      comdat section.  This is only meaningful to the object file format
 876      specific code; it is not an index into the list returned by
 877      bfd_canonicalize_symtab.  */
 878   long symbol;
 879
 880    /* If this section is being discarded, the linker uses this field
 881      to point to the input section which is being kept.  */
 882   struct sec *sec;
 883 };
 884
 885 typedef struct sec
 886 {
 887          /* The name of the section; the name isn't a copy, the pointer is
 888         the same as that passed to bfd_make_section. */
 889
 890     CONST char *name;
 891
 892          /* Which section is it; 0..nth.      */
 893
 894    int index;
 895
 896          /* The next section in the list belonging to the BFD, or NULL. */
 897
 898     struct sec *next;
 899
 900          /* The field flags contains attributes of the section. Some
 901            flags are read in from the object file, and some are
 902            synthesized from other information.  */
 903
 904     flagword flags;
 905
 906 #define SEC_NO_FLAGS   0x000
 907
 908          /* Tells the OS to allocate space for this section when loading.
 909            This is clear for a section containing debug information
 910            only. */
 911 #define SEC_ALLOC      0x001
 912
 913          /* Tells the OS to load the section from the file when loading.
 914            This is clear for a .bss section. */
 915 #define SEC_LOAD       0x002
 916
 917          /* The section contains data still to be relocated, so there is
 918            some relocation information too. */
 919 #define SEC_RELOC      0x004
 920
 921 #if 0    /* Obsolete ? */
 922 #define SEC_BALIGN     0x008
 923 #endif
 924
 925          /* A signal to the OS that the section contains read only
 926           data. */
 927 #define SEC_READONLY   0x010
 928
 929          /* The section contains code only. */
 930 #define SEC_CODE       0x020
 931
 932          /* The section contains data only. */
 933 #define SEC_DATA       0x040
 934
 935          /* The section will reside in ROM. */
 936 #define SEC_ROM        0x080
 937
 938          /* The section contains constructor information. This section
 939            type is used by the linker to create lists of constructors and
 940            destructors used by <<g++>>. When a back end sees a symbol
 941            which should be used in a constructor list, it creates a new
 942            section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
 943            the symbol to it, and builds a relocation. To build the lists
 944            of constructors, all the linker has to do is catenate all the
 945            sections called <<__CTOR_LIST__>> and relocate the data
 946            contained within - exactly the operations it would peform on
 947            standard data. */
 948 #define SEC_CONSTRUCTOR 0x100
 949
 950          /* The section is a constructor, and should be placed at the
 951           end of the text, data, or bss section(?). */
 952 #define SEC_CONSTRUCTOR_TEXT 0x1100
 953 #define SEC_CONSTRUCTOR_DATA 0x2100
 954 #define SEC_CONSTRUCTOR_BSS  0x3100
 955
 956          /* The section has contents - a data section could be
 957            <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
 958            <<SEC_HAS_CONTENTS>> */
 959 #define SEC_HAS_CONTENTS 0x200
 960
 961          /* An instruction to the linker to not output the section
 962            even if it has information which would normally be written. */
 963 #define SEC_NEVER_LOAD 0x400
 964
 965          /* The section is a COFF shared library section.  This flag is
 966            only for the linker.  If this type of section appears in
 967            the input file, the linker must copy it to the output file
 968            without changing the vma or size.  FIXME: Although this
 969            was originally intended to be general, it really is COFF
 970            specific (and the flag was renamed to indicate this).  It
 971            might be cleaner to have some more general mechanism to
 972            allow the back end to control what the linker does with
 973            sections. */
 974 #define SEC_COFF_SHARED_LIBRARY 0x800
 975
 976          /* The section contains common symbols (symbols may be defined
 977            multiple times, the value of a symbol is the amount of
 978            space it requires, and the largest symbol value is the one
 979            used).  Most targets have exactly one of these (which we
 980            translate to bfd_com_section_ptr), but ECOFF has two. */
 981 #define SEC_IS_COMMON 0x8000
 982
 983          /* The section contains only debugging information.  For
 984            example, this is set for ELF .debug and .stab sections.
 985            strip tests this flag to see if a section can be
 986            discarded. */
 987 #define SEC_DEBUGGING 0x10000
 988
 989          /* The contents of this section are held in memory pointed to
 990            by the contents field.  This is checked by
 991            bfd_get_section_contents, and the data is retrieved from
 992            memory if appropriate.  */
 993 #define SEC_IN_MEMORY 0x20000
 994
 995          /* The contents of this section are to be excluded by the
 996            linker for executable and shared objects unless those
 997            objects are to be further relocated.  */
 998 #define SEC_EXCLUDE 0x40000
 999
1000         /* The contents of this section are to be sorted by the
1001           based on the address specified in the associated symbol
1002           table.  */
1003 #define SEC_SORT_ENTRIES 0x80000
1004
1005         /* When linking, duplicate sections of the same name should be
1006           discarded, rather than being combined into a single section as
1007           is usually done.  This is similar to how common symbols are
1008           handled.  See SEC_LINK_DUPLICATES below.  */
1009 #define SEC_LINK_ONCE 0x100000
1010
1011         /* If SEC_LINK_ONCE is set, this bitfield describes how the linker
1012           should handle duplicate sections.  */
1013 #define SEC_LINK_DUPLICATES 0x600000
1014
1015         /* This value for SEC_LINK_DUPLICATES means that duplicate
1016           sections with the same name should simply be discarded. */
1017 #define SEC_LINK_DUPLICATES_DISCARD 0x0
1018
1019         /* This value for SEC_LINK_DUPLICATES means that the linker
1020           should warn if there are any duplicate sections, although
1021           it should still only link one copy.  */
1022 #define SEC_LINK_DUPLICATES_ONE_ONLY 0x200000
1023
1024         /* This value for SEC_LINK_DUPLICATES means that the linker
1025           should warn if any duplicate sections are a different size.  */
1026 #define SEC_LINK_DUPLICATES_SAME_SIZE 0x400000
1027
1028         /* This value for SEC_LINK_DUPLICATES means that the linker
1029           should warn if any duplicate sections contain different
1030           contents.  */
1031 #define SEC_LINK_DUPLICATES_SAME_CONTENTS 0x600000
1032
1033         /* This section was created by the linker as part of dynamic
1034           relocation or other arcane processing.  It is skipped when
1035           going through the first-pass output, trusting that someone
1036           else up the line will take care of it later.  */
1037 #define SEC_LINKER_CREATED 0x800000
1038
1039         /* This section should not be subject to garbage collection.  */
1040 #define SEC_KEEP 0x1000000
1041
1042         /* This section contains "short" data, and should be placed
1043           "near" the GP.  */
1044 #define SEC_SMALL_DATA 0x2000000
1045
1046         /* This section contains data which may be shared with other
1047           executables or shared objects.  */
1048 #define SEC_SHARED 0x4000000
1049
1050         /*  End of section flags.  */
1051
1052         /* Some internal packed boolean fields.  */
1053
1054         /* See the vma field.  */
1055        unsigned int user_set_vma : 1;
1056
1057         /* Whether relocations have been processed.  */
1058        unsigned int reloc_done : 1;
1059
1060         /* A mark flag used by some of the linker backends.  */
1061        unsigned int linker_mark : 1;
1062
1063         /* A mark flag used by some linker backends for garbage collection.  */
1064        unsigned int gc_mark : 1;
1065
1066         /* End of internal packed boolean fields.  */
1067
1068         /*  The virtual memory address of the section - where it will be
1069            at run time.  The symbols are relocated against this.  The
1070            user_set_vma flag is maintained by bfd; if it's not set, the
1071            backend can assign addresses (for example, in <<a.out>>, where
1072            the default address for <<.data>> is dependent on the specific
1073            target and various flags).  */
1074
1075    bfd_vma vma;
1076
1077         /*  The load address of the section - where it would be in a
1078            rom image; really only used for writing section header
1079            information. */
1080
1081    bfd_vma lma;
1082
1083          /* The size of the section in octets, as it will be output.
1084            Contains a value even if the section has no contents (e.g., the
1085            size of <<.bss>>).  This will be filled in after relocation.  */
1086
1087    bfd_size_type _cooked_size;
1088
1089          /* The original size on disk of the section, in octets.  Normally this
1090            value is the same as the size, but if some relaxing has
1091            been done, then this value will be bigger.  */
1092
1093    bfd_size_type _raw_size;
1094
1095          /* If this section is going to be output, then this value is the
1096            offset in *bytes* into the output section of the first byte in the
1097            input section (byte ==> smallest addressable unit on the
1098            target).  In most cases, if this was going to start at the
1099            100th octet (8-bit quantity) in the output section, this value
1100            would be 100.  However, if the target byte size is 16 bits
1101            (bfd_octets_per_byte is "2"), this value would be 50. */
1102
1103    bfd_vma output_offset;
1104
1105          /* The output section through which to map on output. */
1106
1107    struct sec *output_section;
1108
1109          /* The alignment requirement of the section, as an exponent of 2 -
1110            e.g., 3 aligns to 2^3 (or 8). */
1111
1112    unsigned int alignment_power;
1113
1114          /* If an input section, a pointer to a vector of relocation
1115            records for the data in this section. */
1116
1117    struct reloc_cache_entry *relocation;
1118
1119          /* If an output section, a pointer to a vector of pointers to
1120            relocation records for the data in this section. */
1121
1122    struct reloc_cache_entry **orelocation;
1123
1124          /* The number of relocation records in one of the above  */
1125
1126    unsigned reloc_count;
1127
1128          /* Information below is back end specific - and not always used
1129            or updated.  */
1130
1131          /* File position of section data    */
1132
1133    file_ptr filepos;
1134
1135          /* File position of relocation info */
1136
1137    file_ptr rel_filepos;
1138
1139          /* File position of line data       */
1140
1141    file_ptr line_filepos;
1142
1143          /* Pointer to data for applications */
1144
1145    PTR userdata;
1146
1147          /* If the SEC_IN_MEMORY flag is set, this points to the actual
1148            contents.  */
1149    unsigned char *contents;
1150
1151          /* Attached line number information */
1152
1153    alent *lineno;
1154
1155          /* Number of line number records   */
1156
1157    unsigned int lineno_count;
1158
1159          /* Optional information about a COMDAT entry; NULL if not COMDAT */
1160
1161    struct bfd_comdat_info *comdat;
1162
1163          /* When a section is being output, this value changes as more
1164            linenumbers are written out */
1165
1166    file_ptr moving_line_filepos;
1167
1168          /* What the section number is in the target world  */
1169
1170    int target_index;
1171
1172    PTR used_by_bfd;
1173
1174          /* If this is a constructor section then here is a list of the
1175            relocations created to relocate items within it. */
1176
1177    struct relent_chain *constructor_chain;
1178
1179          /* The BFD which owns the section. */
1180
1181    bfd *owner;
1182
1183          /* A symbol which points at this section only */
1184    struct symbol_cache_entry *symbol;
1185    struct symbol_cache_entry **symbol_ptr_ptr;
1186
1187    struct bfd_link_order *link_order_head;
1188    struct bfd_link_order *link_order_tail;
1189 } asection ;
1190
1191      /* These sections are global, and are managed by BFD.  The application
1192        and target back end are not permitted to change the values in
1193        these sections.  New code should use the section_ptr macros rather
1194        than referring directly to the const sections.  The const sections
1195        may eventually vanish.  */
1196 #define BFD_ABS_SECTION_NAME "*ABS*"
1197 #define BFD_UND_SECTION_NAME "*UND*"
1198 #define BFD_COM_SECTION_NAME "*COM*"
1199 #define BFD_IND_SECTION_NAME "*IND*"
1200
1201      /* the absolute section */
1202 extern const asection bfd_abs_section;
1203 #define bfd_abs_section_ptr ((asection *) &bfd_abs_section)
1204 #define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
1205      /* Pointer to the undefined section */
1206 extern const asection bfd_und_section;
1207 #define bfd_und_section_ptr ((asection *) &bfd_und_section)
1208 #define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
1209      /* Pointer to the common section */
1210 extern const asection bfd_com_section;
1211 #define bfd_com_section_ptr ((asection *) &bfd_com_section)
1212      /* Pointer to the indirect section */
1213 extern const asection bfd_ind_section;
1214 #define bfd_ind_section_ptr ((asection *) &bfd_ind_section)
1215 #define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
1216
1217 extern const struct symbol_cache_entry * const bfd_abs_symbol;
1218 extern const struct symbol_cache_entry * const bfd_com_symbol;
1219 extern const struct symbol_cache_entry * const bfd_und_symbol;
1220 extern const struct symbol_cache_entry * const bfd_ind_symbol;
1221 #define bfd_get_section_size_before_reloc(section) \
1222      (section->reloc_done ? (abort(),1): (section)->_raw_size)
1223 #define bfd_get_section_size_after_reloc(section) \
1224      ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
1225 asection *
1226 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
1227
1228 asection *
1229 bfd_make_section_old_way PARAMS ((bfd *abfd, CONST char *name));
1230
1231 asection *
1232 bfd_make_section_anyway PARAMS ((bfd *abfd, CONST char *name));
1233
1234 asection *
1235 bfd_make_section PARAMS ((bfd *, CONST char *name));
1236
1237 boolean
1238 bfd_set_section_flags PARAMS ((bfd *abfd, asection *sec, flagword flags));
1239
1240 void
1241 bfd_map_over_sections PARAMS ((bfd *abfd,
1242     void (*func)(bfd *abfd,
1243     asection *sect,
1244     PTR obj),
1245     PTR obj));
1246
1247 boolean
1248 bfd_set_section_size PARAMS ((bfd *abfd, asection *sec, bfd_size_type val));
1249
1250 boolean
1251 bfd_set_section_contents
1252  PARAMS ((bfd *abfd,
1253     asection *section,
1254     PTR data,
1255     file_ptr offset,
1256     bfd_size_type count));
1257
1258 boolean
1259 bfd_get_section_contents
1260  PARAMS ((bfd *abfd, asection *section, PTR location,
1261     file_ptr offset, bfd_size_type count));
1262
1263 boolean
1264 bfd_copy_private_section_data PARAMS ((bfd *ibfd, asection *isec, bfd *obfd, asection *osec));
1265
1266 #define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1267      BFD_SEND (obfd, _bfd_copy_private_section_data, \
1268                (ibfd, isection, obfd, osection))
1269 void
1270 _bfd_strip_section_from_output
1271  PARAMS ((struct bfd_link_info *info, asection *section));
1272
1273 enum bfd_architecture
1274 {
1275   bfd_arch_unknown,    /* File arch not known */
1276   bfd_arch_obscure,    /* Arch known, not one of these */
1277   bfd_arch_m68k,       /* Motorola 68xxx */
1278 #define bfd_mach_m68000 1
1279 #define bfd_mach_m68008 2
1280 #define bfd_mach_m68010 3
1281 #define bfd_mach_m68020 4
1282 #define bfd_mach_m68030 5
1283 #define bfd_mach_m68040 6
1284 #define bfd_mach_m68060 7
1285 #define bfd_mach_cpu32  8
1286   bfd_arch_vax,        /* DEC Vax */
1287   bfd_arch_i960,       /* Intel 960 */
1288      /* The order of the following is important.
1289        lower number indicates a machine type that
1290        only accepts a subset of the instructions
1291        available to machines with higher numbers.
1292        The exception is the "ca", which is
1293        incompatible with all other machines except
1294        "core". */
1295
1296 #define bfd_mach_i960_core      1
1297 #define bfd_mach_i960_ka_sa     2
1298 #define bfd_mach_i960_kb_sb     3
1299 #define bfd_mach_i960_mc        4
1300 #define bfd_mach_i960_xa        5
1301 #define bfd_mach_i960_ca        6
1302 #define bfd_mach_i960_jx        7
1303 #define bfd_mach_i960_hx        8
1304
1305   bfd_arch_a29k,       /* AMD 29000 */
1306   bfd_arch_sparc,      /* SPARC */
1307 #define bfd_mach_sparc                 1
1308  /* The difference between v8plus and v9 is that v9 is a true 64 bit env.  */
1309 #define bfd_mach_sparc_sparclet        2
1310 #define bfd_mach_sparc_sparclite       3
1311 #define bfd_mach_sparc_v8plus          4
1312 #define bfd_mach_sparc_v8plusa         5  /* with ultrasparc add'ns */
1313 #define bfd_mach_sparc_sparclite_le    6
1314 #define bfd_mach_sparc_v9              7
1315 #define bfd_mach_sparc_v9a             8  /* with ultrasparc add'ns */
1316  /* Nonzero if MACH has the v9 instruction set.  */
1317 #define bfd_mach_sparc_v9_p(mach) \
1318   ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9a)
1319   bfd_arch_mips,       /* MIPS Rxxxx */
1320 #define bfd_mach_mips3000              3000
1321 #define bfd_mach_mips3900              3900
1322 #define bfd_mach_mips4000              4000
1323 #define bfd_mach_mips4010              4010
1324 #define bfd_mach_mips4100              4100
1325 #define bfd_mach_mips4111              4111
1326 #define bfd_mach_mips4300              4300
1327 #define bfd_mach_mips4400              4400
1328 #define bfd_mach_mips4600              4600
1329 #define bfd_mach_mips4650              4650
1330 #define bfd_mach_mips5000              5000
1331 #define bfd_mach_mips6000              6000
1332 #define bfd_mach_mips8000              8000
1333 #define bfd_mach_mips10000             10000
1334 #define bfd_mach_mips16                16
1335   bfd_arch_i386,       /* Intel 386 */
1336 #define bfd_mach_i386_i386 0
1337 #define bfd_mach_i386_i8086 1
1338 #define bfd_mach_i386_i386_intel_syntax 2
1339   bfd_arch_we32k,      /* AT&T WE32xxx */
1340   bfd_arch_tahoe,      /* CCI/Harris Tahoe */
1341   bfd_arch_i860,       /* Intel 860 */
1342   bfd_arch_romp,       /* IBM ROMP PC/RT */
1343   bfd_arch_alliant,    /* Alliant */
1344   bfd_arch_convex,     /* Convex */
1345   bfd_arch_m88k,       /* Motorola 88xxx */
1346   bfd_arch_pyramid,    /* Pyramid Technology */
1347   bfd_arch_h8300,      /* Hitachi H8/300 */
1348 #define bfd_mach_h8300   1
1349 #define bfd_mach_h8300h  2
1350 #define bfd_mach_h8300s  3
1351   bfd_arch_powerpc,    /* PowerPC */
1352   bfd_arch_rs6000,     /* IBM RS/6000 */
1353   bfd_arch_hppa,       /* HP PA RISC */
1354   bfd_arch_d10v,       /* Mitsubishi D10V */
1355 #define bfd_mach_d10v          0
1356 #define bfd_mach_d10v_ts2      2
1357 #define bfd_mach_d10v_ts3      3
1358   bfd_arch_d30v,       /* Mitsubishi D30V */
1359   bfd_arch_z8k,        /* Zilog Z8000 */
1360 #define bfd_mach_z8001         1
1361 #define bfd_mach_z8002         2
1362   bfd_arch_h8500,      /* Hitachi H8/500 */
1363   bfd_arch_sh,         /* Hitachi SH */
1364 #define bfd_mach_sh            0
1365 #define bfd_mach_sh2        0x20
1366 #define bfd_mach_sh_dsp     0x2d
1367 #define bfd_mach_sh3        0x30
1368 #define bfd_mach_sh3_dsp    0x3d
1369 #define bfd_mach_sh3e       0x3e
1370 #define bfd_mach_sh4        0x40
1371   bfd_arch_alpha,      /* Dec Alpha */
1372 #define bfd_mach_alpha_ev4  0x10
1373 #define bfd_mach_alpha_ev5  0x20
1374 #define bfd_mach_alpha_ev6  0x30
1375   bfd_arch_arm,        /* Advanced Risc Machines ARM */
1376 #define bfd_mach_arm_2         1
1377 #define bfd_mach_arm_2a        2
1378 #define bfd_mach_arm_3         3
1379 #define bfd_mach_arm_3M        4
1380 #define bfd_mach_arm_4         5
1381 #define bfd_mach_arm_4T        6
1382 #define bfd_mach_arm_5         7
1383 #define bfd_mach_arm_5T        8
1384   bfd_arch_ns32k,      /* National Semiconductors ns32000 */
1385   bfd_arch_w65,        /* WDC 65816 */
1386   bfd_arch_tic30,      /* Texas Instruments TMS320C30 */
1387   bfd_arch_tic80,      /* TI TMS320c80 (MVP) */
1388   bfd_arch_v850,       /* NEC V850 */
1389 #define bfd_mach_v850          0
1390 #define bfd_mach_v850e         'E'
1391 #define bfd_mach_v850ea        'A'
1392   bfd_arch_arc,        /* Argonaut RISC Core */
1393 #define bfd_mach_arc_base 0
1394   bfd_arch_m32r,       /* Mitsubishi M32R/D */
1395 #define bfd_mach_m32r          0  /* backwards compatibility */
1396 #define bfd_mach_m32rx         'x'
1397   bfd_arch_mn10200,    /* Matsushita MN10200 */
1398   bfd_arch_mn10300,    /* Matsushita MN10300 */
1399 #define bfd_mach_mn10300               300
1400 #define bfd_mach_am33          330
1401   bfd_arch_fr30,
1402 #define bfd_mach_fr30          0x46523330
1403   bfd_arch_mcore,
1404   bfd_arch_pj,
1405   bfd_arch_last
1406   };
1407
1408 typedef struct bfd_arch_info
1409 {
1410   int bits_per_word;
1411   int bits_per_address;
1412   int bits_per_byte;
1413   enum bfd_architecture arch;
1414   unsigned long mach;
1415   const char *arch_name;
1416   const char *printable_name;
1417   unsigned int section_align_power;
1418   /* true if this is the default machine for the architecture */
1419   boolean the_default;
1420   const struct bfd_arch_info * (*compatible)
1421        PARAMS ((const struct bfd_arch_info *a,
1422                 const struct bfd_arch_info *b));
1423
1424   boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
1425
1426   const struct bfd_arch_info *next;
1427 } bfd_arch_info_type;
1428 const char *
1429 bfd_printable_name PARAMS ((bfd *abfd));
1430
1431 const bfd_arch_info_type *
1432 bfd_scan_arch PARAMS ((const char *string));
1433
1434 const char **
1435 bfd_arch_list PARAMS ((void));
1436
1437 const bfd_arch_info_type *
1438 bfd_arch_get_compatible PARAMS ((
1439     const bfd *abfd,
1440     const bfd *bbfd));
1441
1442 void
1443 bfd_set_arch_info PARAMS ((bfd *abfd, const bfd_arch_info_type *arg));
1444
1445 enum bfd_architecture
1446 bfd_get_arch PARAMS ((bfd *abfd));
1447
1448 unsigned long
1449 bfd_get_mach PARAMS ((bfd *abfd));
1450
1451 unsigned int
1452 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
1453
1454 unsigned int
1455 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
1456
1457 const bfd_arch_info_type *
1458 bfd_get_arch_info PARAMS ((bfd *abfd));
1459
1460 const bfd_arch_info_type *
1461 bfd_lookup_arch
1462  PARAMS ((enum bfd_architecture
1463     arch,
1464     unsigned long machine));
1465
1466 const char *
1467 bfd_printable_arch_mach
1468  PARAMS ((enum bfd_architecture arch, unsigned long machine));
1469
1470 int
1471 bfd_octets_per_byte PARAMS ((bfd *abfd));
1472
1473 int
1474 bfd_arch_mach_octets_per_byte PARAMS ((enum bfd_architecture arch,
1475     unsigned long machine));
1476
1477 typedef enum bfd_reloc_status
1478 {
1479         /* No errors detected */
1480   bfd_reloc_ok,
1481
1482         /* The relocation was performed, but there was an overflow. */
1483   bfd_reloc_overflow,
1484
1485         /* The address to relocate was not within the section supplied. */
1486   bfd_reloc_outofrange,
1487
1488         /* Used by special functions */
1489   bfd_reloc_continue,
1490
1491         /* Unsupported relocation size requested. */
1492   bfd_reloc_notsupported,
1493
1494         /* Unused */
1495   bfd_reloc_other,
1496
1497         /* The symbol to relocate against was undefined. */
1498   bfd_reloc_undefined,
1499
1500         /* The relocation was performed, but may not be ok - presently
1501           generated only when linking i960 coff files with i960 b.out
1502           symbols.  If this type is returned, the error_message argument
1503           to bfd_perform_relocation will be set.  */
1504   bfd_reloc_dangerous
1505  }
1506  bfd_reloc_status_type;
1507
1508
1509 typedef struct reloc_cache_entry
1510 {
1511         /* A pointer into the canonical table of pointers  */
1512   struct symbol_cache_entry **sym_ptr_ptr;
1513
1514         /* offset in section */
1515   bfd_size_type address;
1516
1517         /* addend for relocation value */
1518   bfd_vma addend;
1519
1520         /* Pointer to how to perform the required relocation */
1521   reloc_howto_type *howto;
1522
1523 } arelent;
1524 enum complain_overflow
1525 {
1526         /* Do not complain on overflow. */
1527   complain_overflow_dont,
1528
1529         /* Complain if the bitfield overflows, whether it is considered
1530           as signed or unsigned. */
1531   complain_overflow_bitfield,
1532
1533         /* Complain if the value overflows when considered as signed
1534           number. */
1535   complain_overflow_signed,
1536
1537         /* Complain if the value overflows when considered as an
1538           unsigned number. */
1539   complain_overflow_unsigned
1540 };
1541
1542 struct reloc_howto_struct
1543 {
1544         /*  The type field has mainly a documentary use - the back end can
1545            do what it wants with it, though normally the back end's
1546            external idea of what a reloc number is stored
1547            in this field. For example, a PC relative word relocation
1548            in a coff environment has the type 023 - because that's
1549            what the outside world calls a R_PCRWORD reloc. */
1550   unsigned int type;
1551
1552         /*  The value the final relocation is shifted right by. This drops
1553            unwanted data from the relocation.  */
1554   unsigned int rightshift;
1555
1556         /*  The size of the item to be relocated.  This is *not* a
1557            power-of-two measure.  To get the number of bytes operated
1558            on by a type of relocation, use bfd_get_reloc_size.  */
1559   int size;
1560
1561         /*  The number of bits in the item to be relocated.  This is used
1562            when doing overflow checking.  */
1563   unsigned int bitsize;
1564
1565         /*  Notes that the relocation is relative to the location in the
1566            data section of the addend. The relocation function will
1567            subtract from the relocation value the address of the location
1568            being relocated. */
1569   boolean pc_relative;
1570
1571         /*  The bit position of the reloc value in the destination.
1572            The relocated value is left shifted by this amount. */
1573   unsigned int bitpos;
1574
1575         /* What type of overflow error should be checked for when
1576           relocating. */
1577   enum complain_overflow complain_on_overflow;
1578
1579         /* If this field is non null, then the supplied function is
1580           called rather than the normal function. This allows really
1581           strange relocation methods to be accomodated (e.g., i960 callj
1582           instructions). */
1583   bfd_reloc_status_type (*special_function)
1584                                    PARAMS ((bfd *abfd,
1585                                             arelent *reloc_entry,
1586                                             struct symbol_cache_entry *symbol,
1587                                             PTR data,
1588                                             asection *input_section,
1589                                             bfd *output_bfd,
1590                                             char **error_message));
1591
1592         /* The textual name of the relocation type. */
1593   char *name;
1594
1595         /* When performing a partial link, some formats must modify the
1596           relocations rather than the data - this flag signals this.*/
1597   boolean partial_inplace;
1598
1599         /* The src_mask selects which parts of the read in data
1600           are to be used in the relocation sum.  E.g., if this was an 8 bit
1601           bit of data which we read and relocated, this would be
1602           0x000000ff. When we have relocs which have an addend, such as
1603           sun4 extended relocs, the value in the offset part of a
1604           relocating field is garbage so we never use it. In this case
1605           the mask would be 0x00000000. */
1606   bfd_vma src_mask;
1607
1608         /* The dst_mask selects which parts of the instruction are replaced
1609           into the instruction. In most cases src_mask == dst_mask,
1610           except in the above special case, where dst_mask would be
1611           0x000000ff, and src_mask would be 0x00000000.   */
1612   bfd_vma dst_mask;
1613
1614         /* When some formats create PC relative instructions, they leave
1615           the value of the pc of the place being relocated in the offset
1616           slot of the instruction, so that a PC relative relocation can
1617           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1618           Some formats leave the displacement part of an instruction
1619           empty (e.g., m88k bcs); this flag signals the fact.*/
1620   boolean pcrel_offset;
1621
1622 };
1623 #define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1624   {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1625 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
1626
1627 #define EMPTY_HOWTO(C) \
1628   HOWTO((C),0,0,0,false,0,complain_overflow_dont,NULL,NULL,false,0,0,false)
1629
1630 #define HOWTO_PREPARE(relocation, symbol)      \
1631   {                                            \
1632   if (symbol != (asymbol *)NULL) {             \
1633     if (bfd_is_com_section (symbol->section)) { \
1634       relocation = 0;                          \
1635     }                                          \
1636     else {                                     \
1637       relocation = symbol->value;              \
1638     }                                          \
1639   }                                            \
1640 }
1641 unsigned int
1642 bfd_get_reloc_size  PARAMS ((reloc_howto_type *));
1643
1644 typedef struct relent_chain {
1645   arelent relent;
1646   struct   relent_chain *next;
1647 } arelent_chain;
1648 bfd_reloc_status_type
1649
1650 bfd_check_overflow
1651  PARAMS ((enum complain_overflow how,
1652     unsigned int bitsize,
1653     unsigned int rightshift,
1654     unsigned int addrsize,
1655     bfd_vma relocation));
1656
1657 bfd_reloc_status_type
1658
1659 bfd_perform_relocation
1660  PARAMS ((bfd *abfd,
1661     arelent *reloc_entry,
1662     PTR data,
1663     asection *input_section,
1664     bfd *output_bfd,
1665     char **error_message));
1666
1667 bfd_reloc_status_type
1668
1669 bfd_install_relocation
1670  PARAMS ((bfd *abfd,
1671     arelent *reloc_entry,
1672     PTR data, bfd_vma data_start,
1673     asection *input_section,
1674     char **error_message));
1675
1676 enum bfd_reloc_code_real {
1677   _dummy_first_bfd_reloc_code_real,
1678
1679
1680 /* Basic absolute relocations of N bits. */
1681   BFD_RELOC_64,
1682   BFD_RELOC_32,
1683   BFD_RELOC_26,
1684   BFD_RELOC_24,
1685   BFD_RELOC_16,
1686   BFD_RELOC_14,
1687   BFD_RELOC_8,
1688
1689 /* PC-relative relocations.  Sometimes these are relative to the address
1690 of the relocation itself; sometimes they are relative to the start of
1691 the section containing the relocation.  It depends on the specific target.
1692
1693 The 24-bit relocation is used in some Intel 960 configurations. */
1694   BFD_RELOC_64_PCREL,
1695   BFD_RELOC_32_PCREL,
1696   BFD_RELOC_24_PCREL,
1697   BFD_RELOC_16_PCREL,
1698   BFD_RELOC_12_PCREL,
1699   BFD_RELOC_8_PCREL,
1700
1701 /* For ELF. */
1702   BFD_RELOC_32_GOT_PCREL,
1703   BFD_RELOC_16_GOT_PCREL,
1704   BFD_RELOC_8_GOT_PCREL,
1705   BFD_RELOC_32_GOTOFF,
1706   BFD_RELOC_16_GOTOFF,
1707   BFD_RELOC_LO16_GOTOFF,
1708   BFD_RELOC_HI16_GOTOFF,
1709   BFD_RELOC_HI16_S_GOTOFF,
1710   BFD_RELOC_8_GOTOFF,
1711   BFD_RELOC_32_PLT_PCREL,
1712   BFD_RELOC_24_PLT_PCREL,
1713   BFD_RELOC_16_PLT_PCREL,
1714   BFD_RELOC_8_PLT_PCREL,
1715   BFD_RELOC_32_PLTOFF,
1716   BFD_RELOC_16_PLTOFF,
1717   BFD_RELOC_LO16_PLTOFF,
1718   BFD_RELOC_HI16_PLTOFF,
1719   BFD_RELOC_HI16_S_PLTOFF,
1720   BFD_RELOC_8_PLTOFF,
1721
1722 /* Relocations used by 68K ELF. */
1723   BFD_RELOC_68K_GLOB_DAT,
1724   BFD_RELOC_68K_JMP_SLOT,
1725   BFD_RELOC_68K_RELATIVE,
1726
1727 /* Linkage-table relative. */
1728   BFD_RELOC_32_BASEREL,
1729   BFD_RELOC_16_BASEREL,
1730   BFD_RELOC_LO16_BASEREL,
1731   BFD_RELOC_HI16_BASEREL,
1732   BFD_RELOC_HI16_S_BASEREL,
1733   BFD_RELOC_8_BASEREL,
1734   BFD_RELOC_RVA,
1735
1736 /* Absolute 8-bit relocation, but used to form an address like 0xFFnn. */
1737   BFD_RELOC_8_FFnn,
1738
1739 /* These PC-relative relocations are stored as word displacements --
1740 i.e., byte displacements shifted right two bits.  The 30-bit word
1741 displacement (<<32_PCREL_S2>> -- 32 bits, shifted 2) is used on the
1742 SPARC.  (SPARC tools generally refer to this as <<WDISP30>>.)  The
1743 signed 16-bit displacement is used on the MIPS, and the 23-bit
1744 displacement is used on the Alpha. */
1745   BFD_RELOC_32_PCREL_S2,
1746   BFD_RELOC_16_PCREL_S2,
1747   BFD_RELOC_23_PCREL_S2,
1748
1749 /* High 22 bits and low 10 bits of 32-bit value, placed into lower bits of
1750 the target word.  These are used on the SPARC. */
1751   BFD_RELOC_HI22,
1752   BFD_RELOC_LO10,
1753
1754 /* For systems that allocate a Global Pointer register, these are
1755 displacements off that register.  These relocation types are
1756 handled specially, because the value the register will have is
1757 decided relatively late. */
1758   BFD_RELOC_GPREL16,
1759   BFD_RELOC_GPREL32,
1760
1761 /* Reloc types used for i960/b.out. */
1762   BFD_RELOC_I960_CALLJ,
1763
1764 /* SPARC ELF relocations.  There is probably some overlap with other
1765 relocation types already defined. */
1766   BFD_RELOC_NONE,
1767   BFD_RELOC_SPARC_WDISP22,
1768   BFD_RELOC_SPARC22,
1769   BFD_RELOC_SPARC13,
1770   BFD_RELOC_SPARC_GOT10,
1771   BFD_RELOC_SPARC_GOT13,
1772   BFD_RELOC_SPARC_GOT22,
1773   BFD_RELOC_SPARC_PC10,
1774   BFD_RELOC_SPARC_PC22,
1775   BFD_RELOC_SPARC_WPLT30,
1776   BFD_RELOC_SPARC_COPY,
1777   BFD_RELOC_SPARC_GLOB_DAT,
1778   BFD_RELOC_SPARC_JMP_SLOT,
1779   BFD_RELOC_SPARC_RELATIVE,
1780   BFD_RELOC_SPARC_UA32,
1781
1782 /* I think these are specific to SPARC a.out (e.g., Sun 4). */
1783   BFD_RELOC_SPARC_BASE13,
1784   BFD_RELOC_SPARC_BASE22,
1785
1786 /* SPARC64 relocations */
1787 #define BFD_RELOC_SPARC_64 BFD_RELOC_64
1788   BFD_RELOC_SPARC_10,
1789   BFD_RELOC_SPARC_11,
1790   BFD_RELOC_SPARC_OLO10,
1791   BFD_RELOC_SPARC_HH22,
1792   BFD_RELOC_SPARC_HM10,
1793   BFD_RELOC_SPARC_LM22,
1794   BFD_RELOC_SPARC_PC_HH22,
1795   BFD_RELOC_SPARC_PC_HM10,
1796   BFD_RELOC_SPARC_PC_LM22,
1797   BFD_RELOC_SPARC_WDISP16,
1798   BFD_RELOC_SPARC_WDISP19,
1799   BFD_RELOC_SPARC_7,
1800   BFD_RELOC_SPARC_6,
1801   BFD_RELOC_SPARC_5,
1802 #define BFD_RELOC_SPARC_DISP64 BFD_RELOC_64_PCREL
1803   BFD_RELOC_SPARC_PLT64,
1804   BFD_RELOC_SPARC_HIX22,
1805   BFD_RELOC_SPARC_LOX10,
1806   BFD_RELOC_SPARC_H44,
1807   BFD_RELOC_SPARC_M44,
1808   BFD_RELOC_SPARC_L44,
1809   BFD_RELOC_SPARC_REGISTER,
1810
1811 /* SPARC little endian relocation */
1812   BFD_RELOC_SPARC_REV32,
1813
1814 /* Alpha ECOFF and ELF relocations.  Some of these treat the symbol or
1815 "addend" in some special way.
1816 For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1817 writing; when reading, it will be the absolute section symbol.  The
1818 addend is the displacement in bytes of the "lda" instruction from
1819 the "ldah" instruction (which is at the address of this reloc). */
1820   BFD_RELOC_ALPHA_GPDISP_HI16,
1821
1822 /* For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1823 with GPDISP_HI16 relocs.  The addend is ignored when writing the
1824 relocations out, and is filled in with the file's GP value on
1825 reading, for convenience. */
1826   BFD_RELOC_ALPHA_GPDISP_LO16,
1827
1828 /* The ELF GPDISP relocation is exactly the same as the GPDISP_HI16
1829 relocation except that there is no accompanying GPDISP_LO16
1830 relocation. */
1831   BFD_RELOC_ALPHA_GPDISP,
1832
1833 /* The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1834 the assembler turns it into a LDQ instruction to load the address of
1835 the symbol, and then fills in a register in the real instruction.
1836
1837 The LITERAL reloc, at the LDQ instruction, refers to the .lita
1838 section symbol.  The addend is ignored when writing, but is filled
1839 in with the file's GP value on reading, for convenience, as with the
1840 GPDISP_LO16 reloc.
1841
1842 The ELF_LITERAL reloc is somewhere between 16_GOTOFF and GPDISP_LO16.
1843 It should refer to the symbol to be referenced, as with 16_GOTOFF,
1844 but it generates output not based on the position within the .got
1845 section, but relative to the GP value chosen for the file during the
1846 final link stage.
1847
1848 The LITUSE reloc, on the instruction using the loaded address, gives
1849 information to the linker that it might be able to use to optimize
1850 away some literal section references.  The symbol is ignored (read
1851 as the absolute section symbol), and the "addend" indicates the type
1852 of instruction using the register:
1853 1 - "memory" fmt insn
1854 2 - byte-manipulation (byte offset reg)
1855 3 - jsr (target of branch)
1856
1857 The GNU linker currently doesn't do any of this optimizing. */
1858   BFD_RELOC_ALPHA_LITERAL,
1859   BFD_RELOC_ALPHA_ELF_LITERAL,
1860   BFD_RELOC_ALPHA_LITUSE,
1861
1862 /* The BFD_RELOC_ALPHA_USER_* relocations are used by the assembler to
1863 process the explicit !<reloc>!sequence relocations, and are mapped
1864 into the normal relocations at the end of processing. */
1865   BFD_RELOC_ALPHA_USER_LITERAL,
1866   BFD_RELOC_ALPHA_USER_LITUSE_BASE,
1867   BFD_RELOC_ALPHA_USER_LITUSE_BYTOFF,
1868   BFD_RELOC_ALPHA_USER_LITUSE_JSR,
1869   BFD_RELOC_ALPHA_USER_GPDISP,
1870   BFD_RELOC_ALPHA_USER_GPRELHIGH,
1871   BFD_RELOC_ALPHA_USER_GPRELLOW,
1872
1873 /* The HINT relocation indicates a value that should be filled into the
1874 "hint" field of a jmp/jsr/ret instruction, for possible branch-
1875 prediction logic which may be provided on some processors. */
1876   BFD_RELOC_ALPHA_HINT,
1877
1878 /* The LINKAGE relocation outputs a linkage pair in the object file,
1879 which is filled by the linker. */
1880   BFD_RELOC_ALPHA_LINKAGE,
1881
1882 /* The CODEADDR relocation outputs a STO_CA in the object file,
1883 which is filled by the linker. */
1884   BFD_RELOC_ALPHA_CODEADDR,
1885
1886 /* Bits 27..2 of the relocation address shifted right 2 bits;
1887 simple reloc otherwise. */
1888   BFD_RELOC_MIPS_JMP,
1889
1890 /* The MIPS16 jump instruction. */
1891   BFD_RELOC_MIPS16_JMP,
1892
1893 /* MIPS16 GP relative reloc. */
1894   BFD_RELOC_MIPS16_GPREL,
1895
1896 /* High 16 bits of 32-bit value; simple reloc. */
1897   BFD_RELOC_HI16,
1898
1899 /* High 16 bits of 32-bit value but the low 16 bits will be sign
1900 extended and added to form the final result.  If the low 16
1901 bits form a negative number, we need to add one to the high value
1902 to compensate for the borrow when the low bits are added. */
1903   BFD_RELOC_HI16_S,
1904
1905 /* Low 16 bits. */
1906   BFD_RELOC_LO16,
1907
1908 /* Like BFD_RELOC_HI16_S, but PC relative. */
1909   BFD_RELOC_PCREL_HI16_S,
1910
1911 /* Like BFD_RELOC_LO16, but PC relative. */
1912   BFD_RELOC_PCREL_LO16,
1913
1914 /* Relocation relative to the global pointer. */
1915 #define BFD_RELOC_MIPS_GPREL BFD_RELOC_GPREL16
1916
1917 /* Relocation against a MIPS literal section. */
1918   BFD_RELOC_MIPS_LITERAL,
1919
1920 /* MIPS ELF relocations. */
1921   BFD_RELOC_MIPS_GOT16,
1922   BFD_RELOC_MIPS_CALL16,
1923 #define BFD_RELOC_MIPS_GPREL32 BFD_RELOC_GPREL32
1924   BFD_RELOC_MIPS_GOT_HI16,
1925   BFD_RELOC_MIPS_GOT_LO16,
1926   BFD_RELOC_MIPS_CALL_HI16,
1927   BFD_RELOC_MIPS_CALL_LO16,
1928   BFD_RELOC_MIPS_SUB,
1929   BFD_RELOC_MIPS_GOT_PAGE,
1930   BFD_RELOC_MIPS_GOT_OFST,
1931   BFD_RELOC_MIPS_GOT_DISP,
1932
1933
1934 /* i386/elf relocations */
1935   BFD_RELOC_386_GOT32,
1936   BFD_RELOC_386_PLT32,
1937   BFD_RELOC_386_COPY,
1938   BFD_RELOC_386_GLOB_DAT,
1939   BFD_RELOC_386_JUMP_SLOT,
1940   BFD_RELOC_386_RELATIVE,
1941   BFD_RELOC_386_GOTOFF,
1942   BFD_RELOC_386_GOTPC,
1943
1944 /* ns32k relocations */
1945   BFD_RELOC_NS32K_IMM_8,
1946   BFD_RELOC_NS32K_IMM_16,
1947   BFD_RELOC_NS32K_IMM_32,
1948   BFD_RELOC_NS32K_IMM_8_PCREL,
1949   BFD_RELOC_NS32K_IMM_16_PCREL,
1950   BFD_RELOC_NS32K_IMM_32_PCREL,
1951   BFD_RELOC_NS32K_DISP_8,
1952   BFD_RELOC_NS32K_DISP_16,
1953   BFD_RELOC_NS32K_DISP_32,
1954   BFD_RELOC_NS32K_DISP_8_PCREL,
1955   BFD_RELOC_NS32K_DISP_16_PCREL,
1956   BFD_RELOC_NS32K_DISP_32_PCREL,
1957
1958 /* Picojava relocs.  Not all of these appear in object files. */
1959   BFD_RELOC_PJ_CODE_HI16,
1960   BFD_RELOC_PJ_CODE_LO16,
1961   BFD_RELOC_PJ_CODE_DIR16,
1962   BFD_RELOC_PJ_CODE_DIR32,
1963   BFD_RELOC_PJ_CODE_REL16,
1964   BFD_RELOC_PJ_CODE_REL32,
1965
1966 /* Power(rs6000) and PowerPC relocations. */
1967   BFD_RELOC_PPC_B26,
1968   BFD_RELOC_PPC_BA26,
1969   BFD_RELOC_PPC_TOC16,
1970   BFD_RELOC_PPC_B16,
1971   BFD_RELOC_PPC_B16_BRTAKEN,
1972   BFD_RELOC_PPC_B16_BRNTAKEN,
1973   BFD_RELOC_PPC_BA16,
1974   BFD_RELOC_PPC_BA16_BRTAKEN,
1975   BFD_RELOC_PPC_BA16_BRNTAKEN,
1976   BFD_RELOC_PPC_COPY,
1977   BFD_RELOC_PPC_GLOB_DAT,
1978   BFD_RELOC_PPC_JMP_SLOT,
1979   BFD_RELOC_PPC_RELATIVE,
1980   BFD_RELOC_PPC_LOCAL24PC,
1981   BFD_RELOC_PPC_EMB_NADDR32,
1982   BFD_RELOC_PPC_EMB_NADDR16,
1983   BFD_RELOC_PPC_EMB_NADDR16_LO,
1984   BFD_RELOC_PPC_EMB_NADDR16_HI,
1985   BFD_RELOC_PPC_EMB_NADDR16_HA,
1986   BFD_RELOC_PPC_EMB_SDAI16,
1987   BFD_RELOC_PPC_EMB_SDA2I16,
1988   BFD_RELOC_PPC_EMB_SDA2REL,
1989   BFD_RELOC_PPC_EMB_SDA21,
1990   BFD_RELOC_PPC_EMB_MRKREF,
1991   BFD_RELOC_PPC_EMB_RELSEC16,
1992   BFD_RELOC_PPC_EMB_RELST_LO,
1993   BFD_RELOC_PPC_EMB_RELST_HI,
1994   BFD_RELOC_PPC_EMB_RELST_HA,
1995   BFD_RELOC_PPC_EMB_BIT_FLD,
1996   BFD_RELOC_PPC_EMB_RELSDA,
1997
1998 /* The type of reloc used to build a contructor table - at the moment
1999 probably a 32 bit wide absolute relocation, but the target can choose.
2000 It generally does map to one of the other relocation types. */
2001   BFD_RELOC_CTOR,
2002
2003 /* ARM 26 bit pc-relative branch.  The lowest two bits must be zero and are
2004 not stored in the instruction. */
2005   BFD_RELOC_ARM_PCREL_BRANCH,
2006
2007 /* These relocs are only used within the ARM assembler.  They are not
2008 (at present) written to any object files. */
2009   BFD_RELOC_ARM_IMMEDIATE,
2010   BFD_RELOC_ARM_ADRL_IMMEDIATE,
2011   BFD_RELOC_ARM_OFFSET_IMM,
2012   BFD_RELOC_ARM_SHIFT_IMM,
2013   BFD_RELOC_ARM_SWI,
2014   BFD_RELOC_ARM_MULTI,
2015   BFD_RELOC_ARM_CP_OFF_IMM,
2016   BFD_RELOC_ARM_ADR_IMM,
2017   BFD_RELOC_ARM_LDR_IMM,
2018   BFD_RELOC_ARM_LITERAL,
2019   BFD_RELOC_ARM_IN_POOL,
2020   BFD_RELOC_ARM_OFFSET_IMM8,
2021   BFD_RELOC_ARM_HWLITERAL,
2022   BFD_RELOC_ARM_THUMB_ADD,
2023   BFD_RELOC_ARM_THUMB_IMM,
2024   BFD_RELOC_ARM_THUMB_SHIFT,
2025   BFD_RELOC_ARM_THUMB_OFFSET,
2026   BFD_RELOC_ARM_GOT12,
2027   BFD_RELOC_ARM_GOT32,
2028   BFD_RELOC_ARM_JUMP_SLOT,
2029   BFD_RELOC_ARM_COPY,
2030   BFD_RELOC_ARM_GLOB_DAT,
2031   BFD_RELOC_ARM_PLT32,
2032   BFD_RELOC_ARM_RELATIVE,
2033   BFD_RELOC_ARM_GOTOFF,
2034   BFD_RELOC_ARM_GOTPC,
2035
2036 /* Hitachi SH relocs.  Not all of these appear in object files. */
2037   BFD_RELOC_SH_PCDISP8BY2,
2038   BFD_RELOC_SH_PCDISP12BY2,
2039   BFD_RELOC_SH_IMM4,
2040   BFD_RELOC_SH_IMM4BY2,
2041   BFD_RELOC_SH_IMM4BY4,
2042   BFD_RELOC_SH_IMM8,
2043   BFD_RELOC_SH_IMM8BY2,
2044   BFD_RELOC_SH_IMM8BY4,
2045   BFD_RELOC_SH_PCRELIMM8BY2,
2046   BFD_RELOC_SH_PCRELIMM8BY4,
2047   BFD_RELOC_SH_SWITCH16,
2048   BFD_RELOC_SH_SWITCH32,
2049   BFD_RELOC_SH_USES,
2050   BFD_RELOC_SH_COUNT,
2051   BFD_RELOC_SH_ALIGN,
2052   BFD_RELOC_SH_CODE,
2053   BFD_RELOC_SH_DATA,
2054   BFD_RELOC_SH_LABEL,
2055
2056 /* Thumb 23-, 12- and 9-bit pc-relative branches.  The lowest bit must
2057 be zero and is not stored in the instruction. */
2058   BFD_RELOC_THUMB_PCREL_BRANCH9,
2059   BFD_RELOC_THUMB_PCREL_BRANCH12,
2060   BFD_RELOC_THUMB_PCREL_BRANCH23,
2061
2062 /* Argonaut RISC Core (ARC) relocs.
2063 ARC 22 bit pc-relative branch.  The lowest two bits must be zero and are
2064 not stored in the instruction.  The high 20 bits are installed in bits 26
2065 through 7 of the instruction. */
2066   BFD_RELOC_ARC_B22_PCREL,
2067
2068 /* ARC 26 bit absolute branch.  The lowest two bits must be zero and are not
2069 stored in the instruction.  The high 24 bits are installed in bits 23
2070 through 0. */
2071   BFD_RELOC_ARC_B26,
2072
2073 /* Mitsubishi D10V relocs.
2074 This is a 10-bit reloc with the right 2 bits
2075 assumed to be 0. */
2076   BFD_RELOC_D10V_10_PCREL_R,
2077
2078 /* Mitsubishi D10V relocs.
2079 This is a 10-bit reloc with the right 2 bits
2080 assumed to be 0.  This is the same as the previous reloc
2081 except it is in the left container, i.e.,
2082 shifted left 15 bits. */
2083   BFD_RELOC_D10V_10_PCREL_L,
2084
2085 /* This is an 18-bit reloc with the right 2 bits
2086 assumed to be 0. */
2087   BFD_RELOC_D10V_18,
2088
2089 /* This is an 18-bit reloc with the right 2 bits
2090 assumed to be 0. */
2091   BFD_RELOC_D10V_18_PCREL,
2092
2093 /* Mitsubishi D30V relocs.
2094 This is a 6-bit absolute reloc. */
2095   BFD_RELOC_D30V_6,
2096
2097 /* This is a 6-bit pc-relative reloc with
2098 the right 3 bits assumed to be 0. */
2099   BFD_RELOC_D30V_9_PCREL,
2100
2101 /* This is a 6-bit pc-relative reloc with
2102 the right 3 bits assumed to be 0. Same
2103 as the previous reloc but on the right side
2104 of the container. */
2105   BFD_RELOC_D30V_9_PCREL_R,
2106
2107 /* This is a 12-bit absolute reloc with the
2108 right 3 bitsassumed to be 0. */
2109   BFD_RELOC_D30V_15,
2110
2111 /* This is a 12-bit pc-relative reloc with
2112 the right 3 bits assumed to be 0. */
2113   BFD_RELOC_D30V_15_PCREL,
2114
2115 /* This is a 12-bit pc-relative reloc with
2116 the right 3 bits assumed to be 0. Same
2117 as the previous reloc but on the right side
2118 of the container. */
2119   BFD_RELOC_D30V_15_PCREL_R,
2120
2121 /* This is an 18-bit absolute reloc with
2122 the right 3 bits assumed to be 0. */
2123   BFD_RELOC_D30V_21,
2124
2125 /* This is an 18-bit pc-relative reloc with
2126 the right 3 bits assumed to be 0. */
2127   BFD_RELOC_D30V_21_PCREL,
2128
2129 /* This is an 18-bit pc-relative reloc with
2130 the right 3 bits assumed to be 0. Same
2131 as the previous reloc but on the right side
2132 of the container. */
2133   BFD_RELOC_D30V_21_PCREL_R,
2134
2135 /* This is a 32-bit absolute reloc. */
2136   BFD_RELOC_D30V_32,
2137
2138 /* This is a 32-bit pc-relative reloc. */
2139   BFD_RELOC_D30V_32_PCREL,
2140
2141 /* Mitsubishi M32R relocs.
2142 This is a 24 bit absolute address. */
2143   BFD_RELOC_M32R_24,
2144
2145 /* This is a 10-bit pc-relative reloc with the right 2 bits assumed to be 0. */
2146   BFD_RELOC_M32R_10_PCREL,
2147
2148 /* This is an 18-bit reloc with the right 2 bits assumed to be 0. */
2149   BFD_RELOC_M32R_18_PCREL,
2150
2151 /* This is a 26-bit reloc with the right 2 bits assumed to be 0. */
2152   BFD_RELOC_M32R_26_PCREL,
2153
2154 /* This is a 16-bit reloc containing the high 16 bits of an address
2155 used when the lower 16 bits are treated as unsigned. */
2156   BFD_RELOC_M32R_HI16_ULO,
2157
2158 /* This is a 16-bit reloc containing the high 16 bits of an address
2159 used when the lower 16 bits are treated as signed. */
2160   BFD_RELOC_M32R_HI16_SLO,
2161
2162 /* This is a 16-bit reloc containing the lower 16 bits of an address. */
2163   BFD_RELOC_M32R_LO16,
2164
2165 /* This is a 16-bit reloc containing the small data area offset for use in
2166 add3, load, and store instructions. */
2167   BFD_RELOC_M32R_SDA16,
2168
2169 /* This is a 9-bit reloc */
2170   BFD_RELOC_V850_9_PCREL,
2171
2172 /* This is a 22-bit reloc */
2173   BFD_RELOC_V850_22_PCREL,
2174
2175 /* This is a 16 bit offset from the short data area pointer. */
2176   BFD_RELOC_V850_SDA_16_16_OFFSET,
2177
2178 /* This is a 16 bit offset (of which only 15 bits are used) from the
2179 short data area pointer. */
2180   BFD_RELOC_V850_SDA_15_16_OFFSET,
2181
2182 /* This is a 16 bit offset from the zero data area pointer. */
2183   BFD_RELOC_V850_ZDA_16_16_OFFSET,
2184
2185 /* This is a 16 bit offset (of which only 15 bits are used) from the
2186 zero data area pointer. */
2187   BFD_RELOC_V850_ZDA_15_16_OFFSET,
2188
2189 /* This is an 8 bit offset (of which only 6 bits are used) from the
2190 tiny data area pointer. */
2191   BFD_RELOC_V850_TDA_6_8_OFFSET,
2192
2193 /* This is an 8bit offset (of which only 7 bits are used) from the tiny
2194 data area pointer. */
2195   BFD_RELOC_V850_TDA_7_8_OFFSET,
2196
2197 /* This is a 7 bit offset from the tiny data area pointer. */
2198   BFD_RELOC_V850_TDA_7_7_OFFSET,
2199
2200 /* This is a 16 bit offset from the tiny data area pointer. */
2201   BFD_RELOC_V850_TDA_16_16_OFFSET,
2202
2203 /* This is a 5 bit offset (of which only 4 bits are used) from the tiny
2204 data area pointer. */
2205   BFD_RELOC_V850_TDA_4_5_OFFSET,
2206
2207 /* This is a 4 bit offset from the tiny data area pointer. */
2208   BFD_RELOC_V850_TDA_4_4_OFFSET,
2209
2210 /* This is a 16 bit offset from the short data area pointer, with the
2211 bits placed non-contigously in the instruction. */
2212   BFD_RELOC_V850_SDA_16_16_SPLIT_OFFSET,
2213
2214 /* This is a 16 bit offset from the zero data area pointer, with the
2215 bits placed non-contigously in the instruction. */
2216   BFD_RELOC_V850_ZDA_16_16_SPLIT_OFFSET,
2217
2218 /* This is a 6 bit offset from the call table base pointer. */
2219   BFD_RELOC_V850_CALLT_6_7_OFFSET,
2220
2221 /* This is a 16 bit offset from the call table base pointer. */
2222   BFD_RELOC_V850_CALLT_16_16_OFFSET,
2223
2224
2225 /* This is a 32bit pcrel reloc for the mn10300, offset by two bytes in the
2226 instruction. */
2227   BFD_RELOC_MN10300_32_PCREL,
2228
2229 /* This is a 16bit pcrel reloc for the mn10300, offset by two bytes in the
2230 instruction. */
2231   BFD_RELOC_MN10300_16_PCREL,
2232
2233 /* This is a 8bit DP reloc for the tms320c30, where the most
2234 significant 8 bits of a 24 bit word are placed into the least
2235 significant 8 bits of the opcode. */
2236   BFD_RELOC_TIC30_LDP,
2237
2238 /* This is a 48 bit reloc for the FR30 that stores 32 bits. */
2239   BFD_RELOC_FR30_48,
2240
2241 /* This is a 32 bit reloc for the FR30 that stores 20 bits split up into
2242 two sections. */
2243   BFD_RELOC_FR30_20,
2244
2245 /* This is a 16 bit reloc for the FR30 that stores a 6 bit word offset in
2246 4 bits. */
2247   BFD_RELOC_FR30_6_IN_4,
2248
2249 /* This is a 16 bit reloc for the FR30 that stores an 8 bit byte offset
2250 into 8 bits. */
2251   BFD_RELOC_FR30_8_IN_8,
2252
2253 /* This is a 16 bit reloc for the FR30 that stores a 9 bit short offset
2254 into 8 bits. */
2255   BFD_RELOC_FR30_9_IN_8,
2256
2257 /* This is a 16 bit reloc for the FR30 that stores a 10 bit word offset
2258 into 8 bits. */
2259   BFD_RELOC_FR30_10_IN_8,
2260
2261 /* This is a 16 bit reloc for the FR30 that stores a 9 bit pc relative
2262 short offset into 8 bits. */
2263   BFD_RELOC_FR30_9_PCREL,
2264
2265 /* This is a 16 bit reloc for the FR30 that stores a 12 bit pc relative
2266 short offset into 11 bits. */
2267   BFD_RELOC_FR30_12_PCREL,
2268
2269 /* Motorola Mcore relocations. */
2270   BFD_RELOC_MCORE_PCREL_IMM8BY4,
2271   BFD_RELOC_MCORE_PCREL_IMM11BY2,
2272   BFD_RELOC_MCORE_PCREL_IMM4BY2,
2273   BFD_RELOC_MCORE_PCREL_32,
2274   BFD_RELOC_MCORE_PCREL_JSR_IMM11BY2,
2275   BFD_RELOC_MCORE_RVA,
2276
2277 /* These two relocations are used by the linker to determine which of
2278 the entries in a C++ virtual function table are actually used.  When
2279 the --gc-sections option is given, the linker will zero out the entries
2280 that are not used, so that the code for those functions need not be
2281 included in the output.
2282
2283 VTABLE_INHERIT is a zero-space relocation used to describe to the
2284 linker the inheritence tree of a C++ virtual function table.  The
2285 relocation's symbol should be the parent class' vtable, and the
2286 relocation should be located at the child vtable.
2287
2288 VTABLE_ENTRY is a zero-space relocation that describes the use of a
2289 virtual function table entry.  The reloc's symbol should refer to the
2290 table of the class mentioned in the code.  Off of that base, an offset
2291 describes the entry that is being used.  For Rela hosts, this offset
2292 is stored in the reloc's addend.  For Rel hosts, we are forced to put
2293 this offset in the reloc's section offset. */
2294   BFD_RELOC_VTABLE_INHERIT,
2295   BFD_RELOC_VTABLE_ENTRY,
2296   BFD_RELOC_UNUSED };
2297 typedef enum bfd_reloc_code_real bfd_reloc_code_real_type;
2298 reloc_howto_type *
2299
2300 bfd_reloc_type_lookup  PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
2301
2302 const char *
2303 bfd_get_reloc_code_name  PARAMS ((bfd_reloc_code_real_type code));
2304
2305
2306 typedef struct symbol_cache_entry
2307 {
2308         /* A pointer to the BFD which owns the symbol. This information
2309           is necessary so that a back end can work out what additional
2310           information (invisible to the application writer) is carried
2311           with the symbol.
2312
2313           This field is *almost* redundant, since you can use section->owner
2314           instead, except that some symbols point to the global sections
2315           bfd_{abs,com,und}_section.  This could be fixed by making
2316           these globals be per-bfd (or per-target-flavor).  FIXME. */
2317
2318   struct _bfd *the_bfd;  /* Use bfd_asymbol_bfd(sym) to access this field. */
2319
2320         /* The text of the symbol. The name is left alone, and not copied; the
2321           application may not alter it. */
2322   CONST char *name;
2323
2324         /* The value of the symbol.  This really should be a union of a
2325           numeric value with a pointer, since some flags indicate that
2326           a pointer to another symbol is stored here.  */
2327   symvalue value;
2328
2329         /* Attributes of a symbol: */
2330
2331 #define BSF_NO_FLAGS    0x00
2332
2333         /* The symbol has local scope; <<static>> in <<C>>. The value
2334           is the offset into the section of the data. */
2335 #define BSF_LOCAL      0x01
2336
2337         /* The symbol has global scope; initialized data in <<C>>. The
2338           value is the offset into the section of the data. */
2339 #define BSF_GLOBAL     0x02
2340
2341         /* The symbol has global scope and is exported. The value is
2342           the offset into the section of the data. */
2343 #define BSF_EXPORT     BSF_GLOBAL  /* no real difference */
2344
2345         /* A normal C symbol would be one of:
2346           <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
2347           <<BSF_GLOBAL>> */
2348
2349         /* The symbol is a debugging record. The value has an arbitary
2350           meaning, unless BSF_DEBUGGING_RELOC is also set.  */
2351 #define BSF_DEBUGGING  0x08
2352
2353         /* The symbol denotes a function entry point.  Used in ELF,
2354           perhaps others someday.  */
2355 #define BSF_FUNCTION    0x10
2356
2357         /* Used by the linker. */
2358 #define BSF_KEEP        0x20
2359 #define BSF_KEEP_G      0x40
2360
2361         /* A weak global symbol, overridable without warnings by
2362           a regular global symbol of the same name.  */
2363 #define BSF_WEAK        0x80
2364
2365         /* This symbol was created to point to a section, e.g. ELF's
2366           STT_SECTION symbols.  */
2367 #define BSF_SECTION_SYM 0x100
2368
2369         /* The symbol used to be a common symbol, but now it is
2370           allocated. */
2371 #define BSF_OLD_COMMON  0x200
2372
2373         /* The default value for common data. */
2374 #define BFD_FORT_COMM_DEFAULT_VALUE 0
2375
2376         /* In some files the type of a symbol sometimes alters its
2377           location in an output file - ie in coff a <<ISFCN>> symbol
2378           which is also <<C_EXT>> symbol appears where it was
2379           declared and not at the end of a section.  This bit is set
2380           by the target BFD part to convey this information. */
2381
2382 #define BSF_NOT_AT_END    0x400
2383
2384         /* Signal that the symbol is the label of constructor section. */
2385 #define BSF_CONSTRUCTOR   0x800
2386
2387         /* Signal that the symbol is a warning symbol.  The name is a
2388           warning.  The name of the next symbol is the one to warn about;
2389           if a reference is made to a symbol with the same name as the next
2390           symbol, a warning is issued by the linker. */
2391 #define BSF_WARNING       0x1000
2392
2393         /* Signal that the symbol is indirect.  This symbol is an indirect
2394           pointer to the symbol with the same name as the next symbol. */
2395 #define BSF_INDIRECT      0x2000
2396
2397         /* BSF_FILE marks symbols that contain a file name.  This is used
2398           for ELF STT_FILE symbols.  */
2399 #define BSF_FILE          0x4000
2400
2401         /* Symbol is from dynamic linking information.  */
2402 #define BSF_DYNAMIC       0x8000
2403
2404         /* The symbol denotes a data object.  Used in ELF, and perhaps
2405           others someday.  */
2406 #define BSF_OBJECT        0x10000
2407
2408         /* This symbol is a debugging symbol.  The value is the offset
2409           into the section of the data.  BSF_DEBUGGING should be set
2410           as well.  */
2411 #define BSF_DEBUGGING_RELOC 0x20000
2412
2413   flagword flags;
2414
2415         /* A pointer to the section to which this symbol is
2416           relative.  This will always be non NULL, there are special
2417           sections for undefined and absolute symbols.  */
2418   struct sec *section;
2419
2420         /* Back end special data.  */
2421   union
2422     {
2423       PTR p;
2424       bfd_vma i;
2425     } udata;
2426
2427 } asymbol;
2428 #define bfd_get_symtab_upper_bound(abfd) \
2429      BFD_SEND (abfd, _bfd_get_symtab_upper_bound, (abfd))
2430 boolean
2431 bfd_is_local_label PARAMS ((bfd *abfd, asymbol *sym));
2432
2433 boolean
2434 bfd_is_local_label_name PARAMS ((bfd *abfd, const char *name));
2435
2436 #define bfd_is_local_label_name(abfd, name) \
2437      BFD_SEND (abfd, _bfd_is_local_label_name, (abfd, name))
2438 #define bfd_canonicalize_symtab(abfd, location) \
2439      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
2440                   (abfd, location))
2441 boolean
2442 bfd_set_symtab  PARAMS ((bfd *abfd, asymbol **location, unsigned int count));
2443
2444 void
2445 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
2446
2447 #define bfd_make_empty_symbol(abfd) \
2448      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
2449 #define bfd_make_debug_symbol(abfd,ptr,size) \
2450         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
2451 int
2452 bfd_decode_symclass PARAMS ((asymbol *symbol));
2453
2454 boolean
2455 bfd_is_undefined_symclass  PARAMS ((int symclass));
2456
2457 void
2458 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
2459
2460 boolean
2461 bfd_copy_private_symbol_data PARAMS ((bfd *ibfd, asymbol *isym, bfd *obfd, asymbol *osym));
2462
2463 #define bfd_copy_private_symbol_data(ibfd, isymbol, obfd, osymbol) \
2464      BFD_SEND (obfd, _bfd_copy_private_symbol_data, \
2465                (ibfd, isymbol, obfd, osymbol))
2466 struct _bfd
2467 {
2468      /* The filename the application opened the BFD with.  */
2469     CONST char *filename;
2470
2471      /* A pointer to the target jump table.             */
2472     const struct bfd_target *xvec;
2473
2474      /* To avoid dragging too many header files into every file that
2475        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
2476        *", and MTIME as a "long".  Their correct types, to which they
2477        are cast when used, are "FILE *" and "time_t".    The iostream
2478        is the result of an fopen on the filename.  However, if the
2479        BFD_IN_MEMORY flag is set, then iostream is actually a pointer
2480        to a bfd_in_memory struct.  */
2481     PTR iostream;
2482
2483      /* Is the file descriptor being cached?  That is, can it be closed as
2484        needed, and re-opened when accessed later?  */
2485
2486     boolean cacheable;
2487
2488      /* Marks whether there was a default target specified when the
2489        BFD was opened. This is used to select which matching algorithm
2490        to use to choose the back end. */
2491
2492     boolean target_defaulted;
2493
2494      /* The caching routines use these to maintain a
2495        least-recently-used list of BFDs */
2496
2497     struct _bfd *lru_prev, *lru_next;
2498
2499      /* When a file is closed by the caching routines, BFD retains
2500        state information on the file here: */
2501
2502     file_ptr where;
2503
2504      /* and here: (``once'' means at least once) */
2505
2506     boolean opened_once;
2507
2508      /* Set if we have a locally maintained mtime value, rather than
2509        getting it from the file each time: */
2510
2511     boolean mtime_set;
2512
2513      /* File modified time, if mtime_set is true: */
2514
2515     long mtime;
2516
2517      /* Reserved for an unimplemented file locking extension.*/
2518
2519     int ifd;
2520
2521      /* The format which belongs to the BFD. (object, core, etc.) */
2522
2523     bfd_format format;
2524
2525      /* The direction the BFD was opened with*/
2526
2527     enum bfd_direction {no_direction = 0,
2528                         read_direction = 1,
2529                         write_direction = 2,
2530                         both_direction = 3} direction;
2531
2532      /* Format_specific flags*/
2533
2534     flagword flags;
2535
2536      /* Currently my_archive is tested before adding origin to
2537        anything. I believe that this can become always an add of
2538        origin, with origin set to 0 for non archive files.   */
2539
2540     file_ptr origin;
2541
2542      /* Remember when output has begun, to stop strange things
2543        from happening. */
2544     boolean output_has_begun;
2545
2546      /* Pointer to linked list of sections*/
2547     struct sec  *sections;
2548
2549      /* The number of sections */
2550     unsigned int section_count;
2551
2552      /* Stuff only useful for object files:
2553        The start address. */
2554     bfd_vma start_address;
2555
2556      /* Used for input and output*/
2557     unsigned int symcount;
2558
2559      /* Symbol table for output BFD (with symcount entries) */
2560     struct symbol_cache_entry  **outsymbols;
2561
2562      /* Pointer to structure which contains architecture information*/
2563     const struct bfd_arch_info *arch_info;
2564
2565      /* Stuff only useful for archives:*/
2566     PTR arelt_data;
2567     struct _bfd *my_archive;      /* The containing archive BFD.  */
2568     struct _bfd *next;            /* The next BFD in the archive.  */
2569     struct _bfd *archive_head;    /* The first BFD in the archive.  */
2570     boolean has_armap;
2571
2572      /* A chain of BFD structures involved in a link.  */
2573     struct _bfd *link_next;
2574
2575      /* A field used by _bfd_generic_link_add_archive_symbols.  This will
2576        be used only for archive elements.  */
2577     int archive_pass;
2578
2579      /* Used by the back end to hold private data. */
2580
2581     union
2582       {
2583       struct aout_data_struct *aout_data;
2584       struct artdata *aout_ar_data;
2585       struct _oasys_data *oasys_obj_data;
2586       struct _oasys_ar_data *oasys_ar_data;
2587       struct coff_tdata *coff_obj_data;
2588       struct pe_tdata *pe_obj_data;
2589       struct xcoff_tdata *xcoff_obj_data;
2590       struct ecoff_tdata *ecoff_obj_data;
2591       struct ieee_data_struct *ieee_data;
2592       struct ieee_ar_data_struct *ieee_ar_data;
2593       struct srec_data_struct *srec_data;
2594       struct ihex_data_struct *ihex_data;
2595       struct tekhex_data_struct *tekhex_data;
2596       struct elf_obj_tdata *elf_obj_data;
2597       struct nlm_obj_tdata *nlm_obj_data;
2598       struct bout_data_struct *bout_data;
2599       struct sun_core_struct *sun_core_data;
2600       struct sco5_core_struct *sco5_core_data;
2601       struct trad_core_struct *trad_core_data;
2602       struct som_data_struct *som_data;
2603       struct hpux_core_struct *hpux_core_data;
2604       struct hppabsd_core_struct *hppabsd_core_data;
2605       struct sgi_core_struct *sgi_core_data;
2606       struct lynx_core_struct *lynx_core_data;
2607       struct osf_core_struct *osf_core_data;
2608       struct cisco_core_struct *cisco_core_data;
2609       struct versados_data_struct *versados_data;
2610       struct netbsd_core_struct *netbsd_core_data;
2611       PTR any;
2612       } tdata;
2613
2614      /* Used by the application to hold private data*/
2615     PTR usrdata;
2616
2617    /* Where all the allocated stuff under this BFD goes.  This is a
2618      struct objalloc *, but we use PTR to avoid requiring the inclusion of
2619      objalloc.h.  */
2620     PTR memory;
2621 };
2622
2623 typedef enum bfd_error
2624 {
2625   bfd_error_no_error = 0,
2626   bfd_error_system_call,
2627   bfd_error_invalid_target,
2628   bfd_error_wrong_format,
2629   bfd_error_invalid_operation,
2630   bfd_error_no_memory,
2631   bfd_error_no_symbols,
2632   bfd_error_no_armap,
2633   bfd_error_no_more_archived_files,
2634   bfd_error_malformed_archive,
2635   bfd_error_file_not_recognized,
2636   bfd_error_file_ambiguously_recognized,
2637   bfd_error_no_contents,
2638   bfd_error_nonrepresentable_section,
2639   bfd_error_no_debug_section,
2640   bfd_error_bad_value,
2641   bfd_error_file_truncated,
2642   bfd_error_file_too_big,
2643   bfd_error_invalid_error_code
2644 } bfd_error_type;
2645
2646 bfd_error_type
2647 bfd_get_error  PARAMS ((void));
2648
2649 void
2650 bfd_set_error  PARAMS ((bfd_error_type error_tag));
2651
2652 CONST char *
2653 bfd_errmsg  PARAMS ((bfd_error_type error_tag));
2654
2655 void
2656 bfd_perror  PARAMS ((CONST char *message));
2657
2658 typedef void (*bfd_error_handler_type) PARAMS ((const char *, ...));
2659
2660 bfd_error_handler_type
2661 bfd_set_error_handler  PARAMS ((bfd_error_handler_type));
2662
2663 void
2664 bfd_set_error_program_name  PARAMS ((const char *));
2665
2666 bfd_error_handler_type
2667 bfd_get_error_handler  PARAMS ((void));
2668
2669 long
2670 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
2671
2672 long
2673 bfd_canonicalize_reloc
2674  PARAMS ((bfd *abfd,
2675     asection *sec,
2676     arelent **loc,
2677     asymbol **syms));
2678
2679 void
2680 bfd_set_reloc
2681  PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
2682
2683     );
2684
2685 boolean
2686 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
2687
2688 boolean
2689 bfd_set_start_address PARAMS ((bfd *abfd, bfd_vma vma));
2690
2691 long
2692 bfd_get_mtime PARAMS ((bfd *abfd));
2693
2694 long
2695 bfd_get_size PARAMS ((bfd *abfd));
2696
2697 int
2698 bfd_get_gp_size PARAMS ((bfd *abfd));
2699
2700 void
2701 bfd_set_gp_size PARAMS ((bfd *abfd, int i));
2702
2703 bfd_vma
2704 bfd_scan_vma PARAMS ((CONST char *string, CONST char **end, int base));
2705
2706 boolean
2707 bfd_copy_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
2708
2709 #define bfd_copy_private_bfd_data(ibfd, obfd) \
2710      BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
2711                (ibfd, obfd))
2712 boolean
2713 bfd_merge_private_bfd_data PARAMS ((bfd *ibfd, bfd *obfd));
2714
2715 #define bfd_merge_private_bfd_data(ibfd, obfd) \
2716      BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
2717                (ibfd, obfd))
2718 boolean
2719 bfd_set_private_flags PARAMS ((bfd *abfd, flagword flags));
2720
2721 #define bfd_set_private_flags(abfd, flags) \
2722      BFD_SEND (abfd, _bfd_set_private_flags, \
2723                (abfd, flags))
2724 #define bfd_sizeof_headers(abfd, reloc) \
2725      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
2726
2727 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2728      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
2729
2730         /* Do these three do anything useful at all, for any back end?  */
2731 #define bfd_debug_info_start(abfd) \
2732         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2733
2734 #define bfd_debug_info_end(abfd) \
2735         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2736
2737 #define bfd_debug_info_accumulate(abfd, section) \
2738         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2739
2740
2741 #define bfd_stat_arch_elt(abfd, stat) \
2742         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
2743
2744 #define bfd_update_armap_timestamp(abfd) \
2745         BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2746
2747 #define bfd_set_arch_mach(abfd, arch, mach)\
2748         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2749
2750 #define bfd_relax_section(abfd, section, link_info, again) \
2751        BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2752
2753 #define bfd_gc_sections(abfd, link_info) \
2754        BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
2755
2756 #define bfd_link_hash_table_create(abfd) \
2757        BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2758
2759 #define bfd_link_add_symbols(abfd, info) \
2760        BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2761
2762 #define bfd_final_link(abfd, info) \
2763        BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2764
2765 #define bfd_free_cached_info(abfd) \
2766        BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2767
2768 #define bfd_get_dynamic_symtab_upper_bound(abfd) \
2769        BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2770
2771 #define bfd_print_private_bfd_data(abfd, file)\
2772        BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2773
2774 #define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2775        BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2776
2777 #define bfd_get_dynamic_reloc_upper_bound(abfd) \
2778        BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2779
2780 #define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2781        BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2782
2783 extern bfd_byte *bfd_get_relocated_section_contents
2784        PARAMS ((bfd *, struct bfd_link_info *,
2785                  struct bfd_link_order *, bfd_byte *,
2786                  boolean, asymbol **));
2787
2788 symindex
2789 bfd_get_next_mapent PARAMS ((bfd *abfd, symindex previous, carsym **sym));
2790
2791 boolean
2792 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
2793
2794 bfd *
2795 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
2796
2797 CONST char *
2798 bfd_core_file_failing_command PARAMS ((bfd *abfd));
2799
2800 int
2801 bfd_core_file_failing_signal PARAMS ((bfd *abfd));
2802
2803 boolean
2804 core_file_matches_executable_p
2805  PARAMS ((bfd *core_bfd, bfd *exec_bfd));
2806
2807 #define BFD_SEND(bfd, message, arglist) \
2808                ((*((bfd)->xvec->message)) arglist)
2809
2810 #ifdef DEBUG_BFD_SEND
2811 #undef BFD_SEND
2812 #define BFD_SEND(bfd, message, arglist) \
2813   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
2814     ((*((bfd)->xvec->message)) arglist) : \
2815     (bfd_assert (__FILE__,__LINE__), NULL))
2816 #endif
2817 #define BFD_SEND_FMT(bfd, message, arglist) \
2818             (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
2819
2820 #ifdef DEBUG_BFD_SEND
2821 #undef BFD_SEND_FMT
2822 #define BFD_SEND_FMT(bfd, message, arglist) \
2823   (((bfd) && (bfd)->xvec && (bfd)->xvec->message) ? \
2824    (((bfd)->xvec->message[(int)((bfd)->format)]) arglist) : \
2825    (bfd_assert (__FILE__,__LINE__), NULL))
2826 #endif
2827 enum bfd_flavour {
2828   bfd_target_unknown_flavour,
2829   bfd_target_aout_flavour,
2830   bfd_target_coff_flavour,
2831   bfd_target_ecoff_flavour,
2832   bfd_target_elf_flavour,
2833   bfd_target_ieee_flavour,
2834   bfd_target_nlm_flavour,
2835   bfd_target_oasys_flavour,
2836   bfd_target_tekhex_flavour,
2837   bfd_target_srec_flavour,
2838   bfd_target_ihex_flavour,
2839   bfd_target_som_flavour,
2840   bfd_target_os9k_flavour,
2841   bfd_target_versados_flavour,
2842   bfd_target_msdos_flavour,
2843   bfd_target_ovax_flavour,
2844   bfd_target_evax_flavour
2845 };
2846
2847 enum bfd_endian { BFD_ENDIAN_BIG, BFD_ENDIAN_LITTLE, BFD_ENDIAN_UNKNOWN };
2848
2849  /* Forward declaration.  */
2850 typedef struct bfd_link_info _bfd_link_info;
2851
2852 typedef struct bfd_target
2853 {
2854   char *name;
2855   enum bfd_flavour flavour;
2856   enum bfd_endian byteorder;
2857   enum bfd_endian header_byteorder;
2858   flagword object_flags;
2859   flagword section_flags;
2860   char symbol_leading_char;
2861   char ar_pad_char;
2862   unsigned short ar_max_namelen;
2863   bfd_vma      (*bfd_getx64) PARAMS ((const bfd_byte *));
2864   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *));
2865   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
2866   bfd_vma      (*bfd_getx32) PARAMS ((const bfd_byte *));
2867   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((const bfd_byte *));
2868   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
2869   bfd_vma      (*bfd_getx16) PARAMS ((const bfd_byte *));
2870   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *));
2871   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
2872   bfd_vma      (*bfd_h_getx64) PARAMS ((const bfd_byte *));
2873   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *));
2874   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
2875   bfd_vma      (*bfd_h_getx32) PARAMS ((const bfd_byte *));
2876   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((const bfd_byte *));
2877   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
2878   bfd_vma      (*bfd_h_getx16) PARAMS ((const bfd_byte *));
2879   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *));
2880   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
2881   const struct bfd_target *(*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
2882   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
2883   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
2884
2885    /* Generic entry points.  */
2886 #define BFD_JUMP_TABLE_GENERIC(NAME)\
2887 CAT(NAME,_close_and_cleanup),\
2888 CAT(NAME,_bfd_free_cached_info),\
2889 CAT(NAME,_new_section_hook),\
2890 CAT(NAME,_get_section_contents),\
2891 CAT(NAME,_get_section_contents_in_window)
2892
2893    /* Called when the BFD is being closed to do any necessary cleanup.  */
2894   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
2895    /* Ask the BFD to free all cached information.  */
2896   boolean (*_bfd_free_cached_info) PARAMS ((bfd *));
2897    /* Called when a new section is created.  */
2898   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
2899    /* Read the contents of a section.  */
2900   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
2901                                             file_ptr, bfd_size_type));
2902   boolean       (*_bfd_get_section_contents_in_window)
2903                           PARAMS ((bfd *, sec_ptr, bfd_window *,
2904                                    file_ptr, bfd_size_type));
2905
2906    /* Entry points to copy private data.  */
2907 #define BFD_JUMP_TABLE_COPY(NAME)\
2908 CAT(NAME,_bfd_copy_private_bfd_data),\
2909 CAT(NAME,_bfd_merge_private_bfd_data),\
2910 CAT(NAME,_bfd_copy_private_section_data),\
2911 CAT(NAME,_bfd_copy_private_symbol_data),\
2912 CAT(NAME,_bfd_set_private_flags),\
2913 CAT(NAME,_bfd_print_private_bfd_data)\
2914    /* Called to copy BFD general private data from one object file
2915      to another.  */
2916   boolean       (*_bfd_copy_private_bfd_data) PARAMS ((bfd *, bfd *));
2917    /* Called to merge BFD general private data from one object file
2918      to a common output file when linking.  */
2919   boolean       (*_bfd_merge_private_bfd_data) PARAMS ((bfd *, bfd *));
2920    /* Called to copy BFD private section data from one object file
2921      to another.  */
2922   boolean       (*_bfd_copy_private_section_data) PARAMS ((bfd *, sec_ptr,
2923                                                        bfd *, sec_ptr));
2924    /* Called to copy BFD private symbol data from one symbol
2925      to another.  */
2926   boolean       (*_bfd_copy_private_symbol_data) PARAMS ((bfd *, asymbol *,
2927                                                           bfd *, asymbol *));
2928    /* Called to set private backend flags */
2929   boolean       (*_bfd_set_private_flags) PARAMS ((bfd *, flagword));
2930
2931    /* Called to print private BFD data */
2932   boolean       (*_bfd_print_private_bfd_data) PARAMS ((bfd *, PTR));
2933
2934    /* Core file entry points.  */
2935 #define BFD_JUMP_TABLE_CORE(NAME)\
2936 CAT(NAME,_core_file_failing_command),\
2937 CAT(NAME,_core_file_failing_signal),\
2938 CAT(NAME,_core_file_matches_executable_p)
2939   char *   (*_core_file_failing_command) PARAMS ((bfd *));
2940   int      (*_core_file_failing_signal) PARAMS ((bfd *));
2941   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
2942
2943    /* Archive entry points.  */
2944 #define BFD_JUMP_TABLE_ARCHIVE(NAME)\
2945 CAT(NAME,_slurp_armap),\
2946 CAT(NAME,_slurp_extended_name_table),\
2947 CAT(NAME,_construct_extended_name_table),\
2948 CAT(NAME,_truncate_arname),\
2949 CAT(NAME,_write_armap),\
2950 CAT(NAME,_read_ar_hdr),\
2951 CAT(NAME,_openr_next_archived_file),\
2952 CAT(NAME,_get_elt_at_index),\
2953 CAT(NAME,_generic_stat_arch_elt),\
2954 CAT(NAME,_update_armap_timestamp)
2955   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
2956   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
2957   boolean  (*_bfd_construct_extended_name_table)
2958              PARAMS ((bfd *, char **, bfd_size_type *, const char **));
2959   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
2960   boolean  (*write_armap) PARAMS ((bfd *arch,
2961                               unsigned int elength,
2962                               struct orl *map,
2963                               unsigned int orl_count,
2964                               int stridx));
2965   PTR (*_bfd_read_ar_hdr_fn) PARAMS ((bfd *));
2966   bfd *    (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
2967 #define bfd_get_elt_at_index(b,i) BFD_SEND(b, _bfd_get_elt_at_index, (b,i))
2968   bfd *    (*_bfd_get_elt_at_index) PARAMS ((bfd *, symindex));
2969   int      (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
2970   boolean  (*_bfd_update_armap_timestamp) PARAMS ((bfd *));
2971
2972    /* Entry points used for symbols.  */
2973 #define BFD_JUMP_TABLE_SYMBOLS(NAME)\
2974 CAT(NAME,_get_symtab_upper_bound),\
2975 CAT(NAME,_get_symtab),\
2976 CAT(NAME,_make_empty_symbol),\
2977 CAT(NAME,_print_symbol),\
2978 CAT(NAME,_get_symbol_info),\
2979 CAT(NAME,_bfd_is_local_label_name),\
2980 CAT(NAME,_get_lineno),\
2981 CAT(NAME,_find_nearest_line),\
2982 CAT(NAME,_bfd_make_debug_symbol),\
2983 CAT(NAME,_read_minisymbols),\
2984 CAT(NAME,_minisymbol_to_symbol)
2985   long  (*_bfd_get_symtab_upper_bound) PARAMS ((bfd *));
2986   long  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
2987                                              struct symbol_cache_entry **));
2988   struct symbol_cache_entry  *
2989                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
2990   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
2991                                       struct symbol_cache_entry *,
2992                                       bfd_print_symbol_type));
2993 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
2994   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
2995                                       struct symbol_cache_entry *,
2996                                       symbol_info *));
2997 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
2998   boolean       (*_bfd_is_local_label_name) PARAMS ((bfd *, const char *));
2999
3000   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
3001   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
3002                     struct sec *section, struct symbol_cache_entry **symbols,
3003                     bfd_vma offset, CONST char **file, CONST char **func,
3004                     unsigned int *line));
3005   /* Back-door to allow format-aware applications to create debug symbols
3006     while using BFD for everything else.  Currently used by the assembler
3007     when creating COFF files.  */
3008   asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
3009        bfd *abfd,
3010        void *ptr,
3011        unsigned long size));
3012 #define bfd_read_minisymbols(b, d, m, s) \
3013   BFD_SEND (b, _read_minisymbols, (b, d, m, s))
3014   long  (*_read_minisymbols) PARAMS ((bfd *, boolean, PTR *,
3015                                       unsigned int *));
3016 #define bfd_minisymbol_to_symbol(b, d, m, f) \
3017   BFD_SEND (b, _minisymbol_to_symbol, (b, d, m, f))
3018   asymbol *(*_minisymbol_to_symbol) PARAMS ((bfd *, boolean, const PTR,
3019                                              asymbol *));
3020
3021    /* Routines for relocs.  */
3022 #define BFD_JUMP_TABLE_RELOCS(NAME)\
3023 CAT(NAME,_get_reloc_upper_bound),\
3024 CAT(NAME,_canonicalize_reloc),\
3025 CAT(NAME,_bfd_reloc_type_lookup)
3026   long  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
3027   long  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
3028                                             struct symbol_cache_entry **));
3029    /* See documentation on reloc types.  */
3030   reloc_howto_type *
3031        (*reloc_type_lookup) PARAMS ((bfd *abfd,
3032                                      bfd_reloc_code_real_type code));
3033
3034    /* Routines used when writing an object file.  */
3035 #define BFD_JUMP_TABLE_WRITE(NAME)\
3036 CAT(NAME,_set_arch_mach),\
3037 CAT(NAME,_set_section_contents)
3038   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
3039                     unsigned long));
3040   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
3041                                             file_ptr, bfd_size_type));
3042
3043    /* Routines used by the linker.  */
3044 #define BFD_JUMP_TABLE_LINK(NAME)\
3045 CAT(NAME,_sizeof_headers),\
3046 CAT(NAME,_bfd_get_relocated_section_contents),\
3047 CAT(NAME,_bfd_relax_section),\
3048 CAT(NAME,_bfd_link_hash_table_create),\
3049 CAT(NAME,_bfd_link_add_symbols),\
3050 CAT(NAME,_bfd_final_link),\
3051 CAT(NAME,_bfd_link_split_section),\
3052 CAT(NAME,_bfd_gc_sections)
3053   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
3054   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
3055                     struct bfd_link_info *, struct bfd_link_order *,
3056                     bfd_byte *data, boolean relocateable,
3057                     struct symbol_cache_entry **));
3058
3059   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
3060                     struct bfd_link_info *, boolean *again));
3061
3062    /* Create a hash table for the linker.  Different backends store
3063      different information in this table.  */
3064   struct bfd_link_hash_table *(*_bfd_link_hash_table_create) PARAMS ((bfd *));
3065
3066    /* Add symbols from this object file into the hash table.  */
3067   boolean (*_bfd_link_add_symbols) PARAMS ((bfd *, struct bfd_link_info *));
3068
3069    /* Do a link based on the link_order structures attached to each
3070      section of the BFD.  */
3071   boolean (*_bfd_final_link) PARAMS ((bfd *, struct bfd_link_info *));
3072
3073    /* Should this section be split up into smaller pieces during linking.  */
3074   boolean (*_bfd_link_split_section) PARAMS ((bfd *, struct sec *));
3075
3076    /* Remove sections that are not referenced from the output.  */
3077   boolean (*_bfd_gc_sections) PARAMS ((bfd *, struct bfd_link_info *));
3078
3079    /* Routines to handle dynamic symbols and relocs.  */
3080 #define BFD_JUMP_TABLE_DYNAMIC(NAME)\
3081 CAT(NAME,_get_dynamic_symtab_upper_bound),\
3082 CAT(NAME,_canonicalize_dynamic_symtab),\
3083 CAT(NAME,_get_dynamic_reloc_upper_bound),\
3084 CAT(NAME,_canonicalize_dynamic_reloc)
3085    /* Get the amount of memory required to hold the dynamic symbols. */
3086   long  (*_bfd_get_dynamic_symtab_upper_bound) PARAMS ((bfd *));
3087    /* Read in the dynamic symbols.  */
3088   long  (*_bfd_canonicalize_dynamic_symtab)
3089     PARAMS ((bfd *, struct symbol_cache_entry **));
3090    /* Get the amount of memory required to hold the dynamic relocs.  */
3091   long  (*_bfd_get_dynamic_reloc_upper_bound) PARAMS ((bfd *));
3092    /* Read in the dynamic relocs.  */
3093   long  (*_bfd_canonicalize_dynamic_reloc)
3094     PARAMS ((bfd *, arelent **, struct symbol_cache_entry **));
3095
3096   /* Opposite endian version of this target.  */
3097  const struct bfd_target * alternative_target;
3098
3099  PTR backend_data;
3100
3101 } bfd_target;
3102 boolean
3103 bfd_set_default_target  PARAMS ((const char *name));
3104
3105 const bfd_target *
3106 bfd_find_target PARAMS ((CONST char *target_name, bfd *abfd));
3107
3108 const char **
3109 bfd_target_list PARAMS ((void));
3110
3111 const bfd_target *
3112 bfd_search_for_target  PARAMS ((int (* search_func)(const bfd_target *, void *), void *));
3113
3114 boolean
3115 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
3116
3117 boolean
3118 bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
3119
3120 boolean
3121 bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
3122
3123 CONST char *
3124 bfd_format_string PARAMS ((bfd_format format));
3125
3126 #ifdef __cplusplus
3127 }
3128 #endif
3129 #endif