bfd/bfd-in2.h

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