bfd/bfd-in2.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    ==> The bfd.h file is generated from bfd-in.h and various .c files; if you
   3    ==> change it, your changes will probably be lost.
   4    Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   5    Contributed by Cygnus Support.
   6
   7 This file is part of BFD, the Binary File Descriptor library.
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  22
  23 /* bfd.h -- The only header file required by users of the bfd library
  24
  25 The bfd.h file is generated from bfd-in.h and various .c files; if you
  26 change it, your changes will probably be lost.
  27
  28 All the prototypes and definitions following the comment "THE FOLLOWING
  29 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  30 BFD.  If you change it, someone oneday will extract it from the source
  31 again, and your changes will be lost.  To save yourself from this bind,
  32 change the definitions in the source in the bfd directory.  Type "make
  33 docs" and then "make headers" in that directory, and magically this file
  34 will change to reflect your changes.
  35
  36 If you don't have the tools to perform the extraction, then you are
  37 safe from someone on your system trampling over your header files.
  38 You should still maintain the equivalence between the source and this
  39 file though; every change you make to the .c file should be reflected
  40 here.  */
  41
  42 #ifndef __BFD_H_SEEN__
  43 #define __BFD_H_SEEN__
  44
  45 #include "ansidecl.h"
  46 #include "obstack.h"
  47
  48 #define BFD_VERSION "2.2"
  49
  50 #define BFD_ARCH_SIZE @WORDSIZE@
  51
  52 #if BFD_ARCH_SIZE >= 64
  53 #define BFD64
  54 #endif
  55
  56 #ifndef FOPEN_AUT /* WAG */
  57 /* INSERT SYSDEP HERE */
  58 /* END OF SYSDEP */
  59 #endif
  60
  61 /* forward declaration */
  62 typedef struct _bfd bfd;
  63
  64 /* To squelch erroneous compiler warnings ("illegal pointer
  65    combination") from the SVR3 compiler, we would like to typedef
  66    boolean to int (it doesn't like functions which return boolean.
  67    Making sure they are never implicitly declared to return int
  68    doesn't seem to help).  But this file is not configured based on
  69    the host.  */
  70 /* General rules: functions which are boolean return true on success
  71    and false on failure (unless they're a predicate).   -- bfd.doc */
  72 /* I'm sure this is going to break something and someone is going to
  73    force me to change it. */
  74 /* typedef enum boolean {false, true} boolean; */
  75 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  76 typedef enum bfd_boolean {false, true} boolean;
  77
  78 /* A pointer to a position in a file.  */
  79 /* FIXME:  This should be using off_t from <sys/types.h>.
  80    For now, try to avoid breaking stuff by not including <sys/types.h> here.
  81    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
  82    Probably the best long-term answer is to avoid using file_ptr AND off_t
  83    in this header file, and to handle this in the BFD implementation
  84    rather than in its interface.  */
  85 /* typedef off_t        file_ptr; */
  86 typedef long int file_ptr;
  87
  88 /* Support for different sizes of target format ints and addresses.  If the
  89    host implements 64-bit values, it defines HOST_64_BIT to be the appropriate
  90    type.  Otherwise, this code will fall back on gcc's "long long" type if gcc
  91    is being used.  HOST_64_BIT must be defined in such a way as to be a valid
  92    type name by itself or with "unsigned" prefixed.  It should be a signed
  93    type by itself.
  94
  95    If neither is the case, then compilation will fail if 64-bit targets are
  96    requested.  If you don't request any 64-bit targets, you should be safe. */
  97
  98 #ifdef  BFD64
  99
 100 #if defined (__GNUC__) && !defined (HOST_64_BIT)
 101 #define HOST_64_BIT long long
 102 typedef HOST_64_BIT int64_type;
 103 typedef unsigned HOST_64_BIT uint64_type;
 104 #endif
 105
 106 typedef unsigned HOST_64_BIT bfd_vma;
 107 typedef HOST_64_BIT bfd_signed_vma;
 108 typedef unsigned HOST_64_BIT bfd_size_type;
 109 typedef unsigned HOST_64_BIT symvalue;
 110 #define fprintf_vma(s,x) \
 111                 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
 112 #else /* not BFD64  */
 113
 114 /* Represent a target address.  Also used as a generic unsigned type
 115    which is guaranteed to be big enough to hold any arithmetic types
 116    we need to deal with.  */
 117 typedef unsigned long bfd_vma;
 118
 119 /* A generic signed type which is guaranteed to be big enough to hold any
 120    arithmetic types we need to deal with.  Can be assumed to be compatible
 121    with bfd_vma in the same way that signed and unsigned ints are compatible
 122    (as parameters, in assignment, etc).  */
 123 typedef long bfd_signed_vma;
 124
 125 typedef unsigned long symvalue;
 126 typedef unsigned long bfd_size_type;
 127
 128 /* Print a bfd_vma x on stream s.  */
 129 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 130 #endif /* not BFD64  */
 131 #define printf_vma(x) fprintf_vma(stdout,x)
 132
 133 typedef unsigned int flagword;  /* 32 bits of flags */
 134 \f
 135 /** File formats */
 136
 137 typedef enum bfd_format {
 138               bfd_unknown = 0,  /* file format is unknown */
 139               bfd_object,       /* linker/assember/compiler output */
 140               bfd_archive,      /* object archive file */
 141               bfd_core,         /* core dump */
 142               bfd_type_end}     /* marks the end; don't use it! */
 143          bfd_format;
 144
 145 /* Object file flag values */
 146 #define NO_FLAGS        0x00
 147 #define HAS_RELOC       0x01
 148 #define EXEC_P          0x02
 149 #define HAS_LINENO      0x04
 150 #define HAS_DEBUG       0x08
 151 #define HAS_SYMS        0x10
 152 #define HAS_LOCALS      0x20
 153 #define DYNAMIC         0x40
 154 #define WP_TEXT         0x80
 155 #define D_PAGED         0x100
 156 #define BFD_IS_RELAXABLE 0x200
 157 \f
 158 /* symbols and relocation */
 159
 160 typedef unsigned long symindex;
 161
 162 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 163
 164 typedef enum bfd_symclass {
 165               bfd_symclass_unknown = 0,
 166               bfd_symclass_fcommon, /* fortran common symbols */
 167               bfd_symclass_global, /* global symbol, what a surprise */
 168               bfd_symclass_debugger, /* some debugger symbol */
 169               bfd_symclass_undefined /* none known */
 170             } symclass;
 171
 172
 173 typedef int symtype;            /* Who knows, yet? */
 174
 175
 176 /* general purpose part of a symbol;
 177    target specific parts will be found in libcoff.h, liba.out.h etc */
 178
 179
 180 #define bfd_get_section(x) ((x)->section)
 181 #define bfd_get_output_section(x) ((x)->section->output_section)
 182 #define bfd_set_section(x,y) ((x)->section) = (y)
 183 #define bfd_asymbol_base(x) ((x)->section->vma)
 184 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 185 #define bfd_asymbol_name(x) ((x)->name)
 186 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 187 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 188 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 189
 190 /* This is a type pun with struct ranlib on purpose! */
 191 typedef struct carsym {
 192   char *name;
 193   file_ptr file_offset;         /* look here to find the file */
 194 } carsym;                       /* to make these you call a carsymogen */
 195
 196
 197 /* Used in generating armaps.  Perhaps just a forward definition would do? */
 198 struct orl {                    /* output ranlib */
 199   char **name;                  /* symbol name */
 200   file_ptr pos;                 /* bfd* or file position */
 201   int namidx;                   /* index into string table */
 202 };
 203
 204 \f
 205
 206 /* Linenumber stuff */
 207 typedef struct lineno_cache_entry {
 208   unsigned int line_number;     /* Linenumber from start of function*/
 209   union {
 210  struct symbol_cache_entry *sym;                /* Function name */
 211     unsigned long offset;       /* Offset into section */
 212   } u;
 213 } alent;
 214 \f
 215 /* object and core file sections */
 216
 217
 218 #define align_power(addr, align)        \
 219         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 220
 221 typedef struct sec *sec_ptr;
 222
 223 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 224 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 225 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 226 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 227 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 228 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 229 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 230 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 231 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 232
 233 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 234
 235 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 236 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 237 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 238
 239 typedef struct stat stat_type;
 240 \f
 241 /** Error handling */
 242
 243 typedef enum bfd_error {
 244               no_error = 0, system_call_error, invalid_target,
 245               wrong_format, invalid_operation, no_memory,
 246               no_symbols, no_relocation_info,
 247               no_more_archived_files, malformed_archive,
 248               symbol_not_found, file_not_recognized,
 249               file_ambiguously_recognized, no_contents,
 250               bfd_error_nonrepresentable_section,
 251               no_debug_section, bad_value,
 252
 253               /* An input file is shorter than expected.  */
 254               file_truncated,
 255
 256               invalid_error_code} bfd_ec;
 257
 258 extern bfd_ec bfd_error;
 259 struct reloc_cache_entry;
 260 struct bfd_seclet;
 261
 262
 263 typedef struct bfd_error_vector {
 264   void (* nonrepresentable_section ) PARAMS ((CONST bfd  *CONST abfd,
 265                                               CONST char *CONST name));
 266   void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
 267                                      CONST struct bfd_seclet *sec));
 268   void (* reloc_value_truncated) PARAMS ((CONST struct
 269                                           reloc_cache_entry *rel,
 270                                           struct bfd_seclet *sec));
 271
 272   void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
 273                                     CONST struct bfd_seclet *sec));
 274
 275 } bfd_error_vector_type;
 276
 277 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
 278 void bfd_perror PARAMS ((CONST char *message));
 279 \f
 280
 281 typedef enum bfd_print_symbol
 282 {
 283   bfd_print_symbol_name,
 284   bfd_print_symbol_more,
 285   bfd_print_symbol_all
 286 } bfd_print_symbol_type;
 287
 288 \f
 289 /* Information about a symbol that nm needs.  */
 290
 291 typedef struct _symbol_info
 292 {
 293   symvalue value;
 294   char type;                   /*  */
 295   CONST char *name;            /* Symbol name.  */
 296   char stab_other;             /* Unused. */
 297   short stab_desc;             /* Info for N_TYPE.  */
 298   CONST char *stab_name;
 299 } symbol_info;
 300 \f
 301 /* The code that implements targets can initialize a jump table with this
 302    macro.  It must name all its routines the same way (a prefix plus
 303    the standard routine suffix), or it must #define the routines that
 304    are not so named, before calling JUMP_TABLE in the initializer.  */
 305
 306 /* Semi-portable string concatenation in cpp */
 307 #ifndef CAT
 308 #ifdef __STDC__
 309 #define CAT(a,b) a##b
 310 #define CAT3(a,b,c) a##b##c
 311 #else
 312 #define CAT(a,b) a/**/b
 313 #define CAT3(a,b,c) a/**/b/**/c
 314 #endif
 315 #endif
 316
 317 #define JUMP_TABLE(NAME)\
 318 CAT(NAME,_core_file_failing_command),\
 319 CAT(NAME,_core_file_failing_signal),\
 320 CAT(NAME,_core_file_matches_executable_p),\
 321 CAT(NAME,_slurp_armap),\
 322 CAT(NAME,_slurp_extended_name_table),\
 323 CAT(NAME,_truncate_arname),\
 324 CAT(NAME,_write_armap),\
 325 CAT(NAME,_close_and_cleanup),   \
 326 CAT(NAME,_set_section_contents),\
 327 CAT(NAME,_get_section_contents),\
 328 CAT(NAME,_new_section_hook),\
 329 CAT(NAME,_get_symtab_upper_bound),\
 330 CAT(NAME,_get_symtab),\
 331 CAT(NAME,_get_reloc_upper_bound),\
 332 CAT(NAME,_canonicalize_reloc),\
 333 CAT(NAME,_make_empty_symbol),\
 334 CAT(NAME,_print_symbol),\
 335 CAT(NAME,_get_symbol_info),\
 336 CAT(NAME,_get_lineno),\
 337 CAT(NAME,_set_arch_mach),\
 338 CAT(NAME,_openr_next_archived_file),\
 339 CAT(NAME,_find_nearest_line),\
 340 CAT(NAME,_generic_stat_arch_elt),\
 341 CAT(NAME,_sizeof_headers),\
 342 CAT(NAME,_bfd_debug_info_start),\
 343 CAT(NAME,_bfd_debug_info_end),\
 344 CAT(NAME,_bfd_debug_info_accumulate),\
 345 CAT(NAME,_bfd_get_relocated_section_contents),\
 346 CAT(NAME,_bfd_relax_section),\
 347 CAT(NAME,_bfd_seclet_link),\
 348 CAT(NAME,_bfd_reloc_type_lookup),\
 349 CAT(NAME,_bfd_make_debug_symbol)
 350
 351 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 352
 353 \f
 354 /* User program access to BFD facilities */
 355
 356 extern CONST short _bfd_host_big_endian;
 357 #define HOST_BYTE_ORDER_BIG_P   (*(char *)&_bfd_host_big_endian)
 358
 359 /* The bfd itself */
 360
 361 /* Cast from const char * to char * so that caller can assign to
 362    a char * without a warning.  */
 363 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 364 #define bfd_get_format(abfd) ((abfd)->format)
 365 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 366 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 367 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 368 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 369 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 370 #define bfd_has_map(abfd) ((abfd)->has_armap)
 371 #define bfd_header_twiddle_required(abfd) \
 372         ((((abfd)->xvec->header_byteorder_big_p)                \
 373           != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
 374
 375 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 376 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 377
 378 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 379 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 380 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 381 #define bfd_count_sections(abfd) ((abfd)->section_count)
 382 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
 383 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
 384
 385 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 386
 387 #define BYTE_SIZE 1
 388 #define SHORT_SIZE 2
 389 #define LONG_SIZE 4
 390
 391 /* And more from the source.  */
 392 void
 393 bfd_init PARAMS ((void));
 394
 395 bfd *
 396 bfd_openr PARAMS ((CONST char *filename, CONST char*target));
 397
 398 bfd *
 399 bfd_fdopenr PARAMS ((CONST char *filename, CONST char *target, int fd));
 400
 401 bfd *
 402 bfd_openw PARAMS ((CONST char *filename, CONST char *target));
 403
 404 boolean
 405 bfd_close PARAMS ((bfd *));
 406
 407 boolean
 408 bfd_close_all_done PARAMS ((bfd *));
 409
 410 bfd_size_type
 411 bfd_alloc_size PARAMS ((bfd *abfd));
 412
 413 bfd *
 414 bfd_create PARAMS ((CONST char *filename, bfd *template));
 415
 416
 417  /* Byte swapping macros for user section data.  */
 418
 419 #define bfd_put_8(abfd, val, ptr) \
 420                 (*((unsigned char *)(ptr)) = (unsigned char)val)
 421 #define bfd_put_signed_8 \
 422                 bfd_put_8
 423 #define bfd_get_8(abfd, ptr) \
 424                 (*(unsigned char *)(ptr))
 425 #define bfd_get_signed_8(abfd, ptr) \
 426                 ((*(unsigned char *)(ptr) ^ 0x80) - 0x80)
 427
 428 #define bfd_put_16(abfd, val, ptr) \
 429                 BFD_SEND(abfd, bfd_putx16, ((val),(ptr)))
 430 #define bfd_put_signed_16 \
 431                  bfd_put_16
 432 #define bfd_get_16(abfd, ptr) \
 433                 BFD_SEND(abfd, bfd_getx16, (ptr))
 434 #define bfd_get_signed_16(abfd, ptr) \
 435                  BFD_SEND (abfd, bfd_getx_signed_16, (ptr))
 436
 437 #define bfd_put_32(abfd, val, ptr) \
 438                 BFD_SEND(abfd, bfd_putx32, ((val),(ptr)))
 439 #define bfd_put_signed_32 \
 440                  bfd_put_32
 441 #define bfd_get_32(abfd, ptr) \
 442                 BFD_SEND(abfd, bfd_getx32, (ptr))
 443 #define bfd_get_signed_32(abfd, ptr) \
 444                  BFD_SEND(abfd, bfd_getx_signed_32, (ptr))
 445
 446 #define bfd_put_64(abfd, val, ptr) \
 447                 BFD_SEND(abfd, bfd_putx64, ((val), (ptr)))
 448 #define bfd_put_signed_64 \
 449                  bfd_put_64
 450 #define bfd_get_64(abfd, ptr) \
 451                 BFD_SEND(abfd, bfd_getx64, (ptr))
 452 #define bfd_get_signed_64(abfd, ptr) \
 453                  BFD_SEND(abfd, bfd_getx_signed_64, (ptr))
 454
 455
 456  /* Byte swapping macros for file header data.  */
 457
 458 #define bfd_h_put_8(abfd, val, ptr) \
 459                 bfd_put_8 (abfd, val, ptr)
 460 #define bfd_h_put_signed_8(abfd, val, ptr) \
 461                 bfd_put_8 (abfd, val, ptr)
 462 #define bfd_h_get_8(abfd, ptr) \
 463                 bfd_get_8 (abfd, ptr)
 464 #define bfd_h_get_signed_8(abfd, ptr) \
 465                 bfd_get_signed_8 (abfd, ptr)
 466
 467 #define bfd_h_put_16(abfd, val, ptr) \
 468                 BFD_SEND(abfd, bfd_h_putx16,(val,ptr))
 469 #define bfd_h_put_signed_16 \
 470                  bfd_h_put_16
 471 #define bfd_h_get_16(abfd, ptr) \
 472                 BFD_SEND(abfd, bfd_h_getx16,(ptr))
 473 #define bfd_h_get_signed_16(abfd, ptr) \
 474                  BFD_SEND(abfd, bfd_h_getx_signed_16, (ptr))
 475
 476 #define bfd_h_put_32(abfd, val, ptr) \
 477                 BFD_SEND(abfd, bfd_h_putx32,(val,ptr))
 478 #define bfd_h_put_signed_32 \
 479                  bfd_h_put_32
 480 #define bfd_h_get_32(abfd, ptr) \
 481                 BFD_SEND(abfd, bfd_h_getx32,(ptr))
 482 #define bfd_h_get_signed_32(abfd, ptr) \
 483                  BFD_SEND(abfd, bfd_h_getx_signed_32, (ptr))
 484
 485 #define bfd_h_put_64(abfd, val, ptr) \
 486                 BFD_SEND(abfd, bfd_h_putx64,(val, ptr))
 487 #define bfd_h_put_signed_64 \
 488                  bfd_h_put_64
 489 #define bfd_h_get_64(abfd, ptr) \
 490                 BFD_SEND(abfd, bfd_h_getx64,(ptr))
 491 #define bfd_h_get_signed_64(abfd, ptr) \
 492                  BFD_SEND(abfd, bfd_h_getx_signed_64, (ptr))
 493
 494 typedef struct sec
 495 {
 496          /* The name of the section, the name isn't a copy, the pointer is
 497         the same as that passed to bfd_make_section. */
 498
 499     CONST char *name;
 500
 501
 502          /* Which section is it 0.nth      */
 503
 504    int index;
 505
 506          /* The next section in the list belonging to the BFD, or NULL. */
 507
 508     struct sec *next;
 509
 510          /* The field flags contains attributes of the section. Some of
 511            flags are read in from the object file, and some are
 512            synthesized from other information.  */
 513
 514     flagword flags;
 515
 516 #define SEC_NO_FLAGS   0x000
 517
 518          /* Tells the OS to allocate space for this section when loaded.
 519            This would clear for a section containing debug information
 520            only. */
 521
 522
 523 #define SEC_ALLOC      0x001
 524          /* Tells the OS to load the section from the file when loading.
 525            This would be clear for a .bss section */
 526
 527 #define SEC_LOAD       0x002
 528          /* The section contains data still to be relocated, so there will
 529            be some relocation information too. */
 530
 531 #define SEC_RELOC      0x004
 532
 533          /* Obsolete ? */
 534
 535 #define SEC_BALIGN     0x008
 536
 537          /* A signal to the OS that the section contains read only
 538           data. */
 539 #define SEC_READONLY   0x010
 540
 541          /* The section contains code only. */
 542
 543 #define SEC_CODE       0x020
 544
 545          /* The section contains data only. */
 546
 547 #define SEC_DATA        0x040
 548
 549          /* The section will reside in ROM. */
 550
 551 #define SEC_ROM        0x080
 552
 553          /* The section contains constructor information. This section
 554            type is used by the linker to create lists of constructors and
 555            destructors used by <<g++>>. When a back end sees a symbol
 556            which should be used in a constructor list, it creates a new
 557            section for the type of name (eg <<__CTOR_LIST__>>), attaches
 558            the symbol to it and builds a relocation. To build the lists
 559            of constructors, all the linker has to to is catenate all the
 560            sections called <<__CTOR_LIST__>> and relocte the data
 561            contained within - exactly the operations it would peform on
 562            standard data. */
 563
 564 #define SEC_CONSTRUCTOR 0x100
 565
 566          /* The section is a constuctor, and should be placed at the
 567           end of the . */
 568
 569 #define SEC_CONSTRUCTOR_TEXT 0x1100
 570
 571 #define SEC_CONSTRUCTOR_DATA 0x2100
 572
 573 #define SEC_CONSTRUCTOR_BSS  0x3100
 574
 575          /* The section has contents - a data section could be
 576            <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>, a debug section could be
 577            <<SEC_HAS_CONTENTS>> */
 578
 579 #define SEC_HAS_CONTENTS 0x200
 580
 581          /* An instruction to the linker not to output sections
 582           containing this flag even if they have information which
 583           would normally be written. */
 584
 585 #define SEC_NEVER_LOAD 0x400
 586
 587          /* The section is a shared library section.  The linker must leave
 588            these completely alone, as the vma and size are used when
 589            the executable is loaded. */
 590
 591 #define SEC_SHARED_LIBRARY 0x800
 592
 593          /* The section is a common section (symbols may be defined
 594            multiple times, the value of a symbol is the amount of
 595            space it requires, and the largest symbol value is the one
 596            used).  Most targets have exactly one of these (.bss), but
 597            ECOFF has two. */
 598
 599 #define SEC_IS_COMMON 0x8000
 600
 601         /*  The virtual memory address of the section - where it will be
 602            at run time - the symbols are relocated against this */
 603    bfd_vma vma;
 604
 605         /*  The load address of the section - where it would be in a
 606            rom image, really only used for writing section header information */
 607    bfd_vma lma;
 608
 609    boolean user_set_vma;
 610
 611          /* The size of the section in bytes, as it will be output.
 612            contains a value even if the section has no contents (eg, the
 613            size of <<.bss>>). This will be filled in after relocation */
 614
 615    bfd_size_type _cooked_size;
 616
 617          /* The size on disk of the section in bytes originally.  Normally this
 618             value is the same as the size, but if some relaxing has
 619             been done, then this value will be bigger.  */
 620
 621    bfd_size_type _raw_size;
 622
 623          /* If this section is going to be output, then this value is the
 624            offset into the output section of the first byte in the input
 625            section. Eg, if this was going to start at the 100th byte in
 626            the output section, this value would be 100. */
 627
 628    bfd_vma output_offset;
 629
 630          /* The output section through which to map on output. */
 631
 632    struct sec *output_section;
 633
 634          /* The alignment requirement of the section, as an exponent - eg
 635            3 aligns to 2^3 (or 8) */
 636
 637    unsigned int alignment_power;
 638
 639          /* If an input section, a pointer to a vector of relocation
 640            records for the data in this section. */
 641
 642    struct reloc_cache_entry *relocation;
 643
 644          /* If an output section, a pointer to a vector of pointers to
 645            relocation records for the data in this section. */
 646
 647    struct reloc_cache_entry **orelocation;
 648
 649          /* The number of relocation records in one of the above  */
 650
 651    unsigned reloc_count;
 652
 653          /* Information below is back end specific - and not always used
 654            or updated
 655
 656            File position of section data    */
 657
 658    file_ptr filepos;
 659
 660          /* File position of relocation info */
 661
 662    file_ptr rel_filepos;
 663
 664          /* File position of line data       */
 665
 666    file_ptr line_filepos;
 667
 668          /* Pointer to data for applications */
 669
 670    PTR userdata;
 671
 672    struct lang_output_section *otheruserdata;
 673
 674          /* Attached line number information */
 675
 676    alent *lineno;
 677
 678          /* Number of line number records   */
 679
 680    unsigned int lineno_count;
 681
 682          /* When a section is being output, this value changes as more
 683            linenumbers are written out */
 684
 685    file_ptr moving_line_filepos;
 686
 687          /* what the section number is in the target world  */
 688
 689    int target_index;
 690
 691    PTR used_by_bfd;
 692
 693          /* If this is a constructor section then here is a list of the
 694            relocations created to relocate items within it. */
 695
 696    struct relent_chain *constructor_chain;
 697
 698          /* The BFD which owns the section. */
 699
 700    bfd *owner;
 701
 702    boolean reloc_done;
 703           /* A symbol which points at this section only */
 704    struct symbol_cache_entry *symbol;
 705    struct symbol_cache_entry **symbol_ptr_ptr;
 706    struct bfd_seclet *seclets_head;
 707    struct bfd_seclet *seclets_tail;
 708 } asection ;
 709
 710
 711 #define BFD_ABS_SECTION_NAME "*ABS*"
 712 #define BFD_UND_SECTION_NAME "*UND*"
 713 #define BFD_COM_SECTION_NAME "*COM*"
 714 #define BFD_IND_SECTION_NAME "*IND*"
 715
 716      /* the absolute section */
 717  extern   asection bfd_abs_section;
 718      /* Pointer to the undefined section */
 719  extern   asection bfd_und_section;
 720      /* Pointer to the common section */
 721  extern asection bfd_com_section;
 722      /* Pointer to the indirect section */
 723  extern asection bfd_ind_section;
 724
 725  extern struct symbol_cache_entry *bfd_abs_symbol;
 726  extern struct symbol_cache_entry *bfd_com_symbol;
 727  extern struct symbol_cache_entry *bfd_und_symbol;
 728  extern struct symbol_cache_entry *bfd_ind_symbol;
 729 #define bfd_get_section_size_before_reloc(section) \
 730      (section->reloc_done ? (abort(),1): (section)->_raw_size)
 731 #define bfd_get_section_size_after_reloc(section) \
 732      ((section->reloc_done) ? (section)->_cooked_size: (abort(),1))
 733 asection *
 734 bfd_get_section_by_name PARAMS ((bfd *abfd, CONST char *name));
 735
 736 asection *
 737 bfd_make_section_old_way PARAMS ((bfd *, CONST char *name));
 738
 739 asection *
 740 bfd_make_section PARAMS ((bfd *, CONST char *name));
 741
 742 boolean
 743 bfd_set_section_flags PARAMS ((bfd *, asection *, flagword));
 744
 745 void
 746 bfd_map_over_sections PARAMS ((bfd *abfd,
 747     void (*func)(bfd *abfd,
 748     asection *sect,
 749     PTR obj),
 750     PTR obj));
 751
 752 boolean
 753 bfd_set_section_size PARAMS ((bfd *, asection *, bfd_size_type val));
 754
 755 boolean
 756 bfd_set_section_contents
 757  PARAMS ((bfd *abfd,
 758     asection *section,
 759     PTR data,
 760     file_ptr offset,
 761     bfd_size_type count));
 762
 763 boolean
 764 bfd_get_section_contents
 765  PARAMS ((bfd *abfd, asection *section, PTR location,
 766     file_ptr offset, bfd_size_type count));
 767
 768 enum bfd_architecture
 769 {
 770   bfd_arch_unknown,    /* File arch not known */
 771   bfd_arch_obscure,    /* Arch known, not one of these */
 772   bfd_arch_m68k,       /* Motorola 68xxx */
 773   bfd_arch_vax,        /* DEC Vax */
 774   bfd_arch_i960,       /* Intel 960 */
 775      /* The order of the following is important.
 776        lower number indicates a machine type that
 777        only accepts a subset of the instructions
 778        available to machines with higher numbers.
 779        The exception is the "ca", which is
 780        incompatible with all other machines except
 781        "core". */
 782
 783 #define bfd_mach_i960_core      1
 784 #define bfd_mach_i960_ka_sa     2
 785 #define bfd_mach_i960_kb_sb     3
 786 #define bfd_mach_i960_mc        4
 787 #define bfd_mach_i960_xa        5
 788 #define bfd_mach_i960_ca        6
 789
 790   bfd_arch_a29k,       /* AMD 29000 */
 791   bfd_arch_sparc,      /* SPARC */
 792   bfd_arch_mips,       /* MIPS Rxxxx */
 793   bfd_arch_i386,       /* Intel 386 */
 794   bfd_arch_we32k,      /* AT&T WE32xxx */
 795   bfd_arch_tahoe,      /* CCI/Harris Tahoe */
 796   bfd_arch_i860,       /* Intel 860 */
 797   bfd_arch_romp,       /* IBM ROMP PC/RT */
 798   bfd_arch_alliant,    /* Alliant */
 799   bfd_arch_convex,     /* Convex */
 800   bfd_arch_m88k,       /* Motorola 88xxx */
 801   bfd_arch_pyramid,    /* Pyramid Technology */
 802   bfd_arch_h8300,      /* Hitachi H8/300 */
 803 #define bfd_mach_h8300   1
 804 #define bfd_mach_h8300h  2
 805   bfd_arch_rs6000,     /* IBM RS/6000 */
 806   bfd_arch_hppa,       /* HP PA RISC */
 807   bfd_arch_z8k,        /* Zilog Z8000 */
 808 #define bfd_mach_z8001          1
 809 #define bfd_mach_z8002          2
 810   bfd_arch_h8500,      /* Hitachi H8/500 */
 811   bfd_arch_sh,         /* Hitachi SH */
 812   bfd_arch_alpha,      /* Dec Alpha */
 813   bfd_arch_last
 814   };
 815
 816 typedef struct bfd_arch_info
 817 {
 818   int bits_per_word;
 819   int bits_per_address;
 820   int bits_per_byte;
 821   enum bfd_architecture arch;
 822   long mach;
 823   char *arch_name;
 824   CONST  char *printable_name;
 825   unsigned int section_align_power;
 826   /* true if this is the default machine for the architecture */
 827   boolean the_default;
 828   CONST struct bfd_arch_info * (*compatible)
 829         PARAMS ((CONST struct bfd_arch_info *a,
 830                  CONST struct bfd_arch_info *b));
 831
 832   boolean (*scan) PARAMS ((CONST struct bfd_arch_info *, CONST char *));
 833    /* How to disassemble an instruction, producing a printable
 834      representation on a specified stdio stream.  This isn't
 835      defined for most processors at present, because of the size
 836      of the additional tables it would drag in, and because gdb
 837      wants to use a different interface.  */
 838   unsigned int (*disassemble) PARAMS ((bfd_vma addr, CONST char *data,
 839                                         PTR stream));
 840
 841   struct bfd_arch_info *next;
 842 } bfd_arch_info_type;
 843 CONST char *
 844 bfd_printable_name PARAMS ((bfd *abfd));
 845
 846 bfd_arch_info_type *
 847 bfd_scan_arch PARAMS ((CONST char *));
 848
 849 CONST bfd_arch_info_type *
 850 bfd_arch_get_compatible PARAMS ((
 851     CONST bfd *abfd,
 852     CONST bfd *bbfd));
 853
 854 void
 855 bfd_set_arch_info PARAMS ((bfd *, bfd_arch_info_type *));
 856
 857 enum bfd_architecture
 858 bfd_get_arch PARAMS ((bfd *abfd));
 859
 860 unsigned long
 861 bfd_get_mach PARAMS ((bfd *abfd));
 862
 863 unsigned int
 864 bfd_arch_bits_per_byte PARAMS ((bfd *abfd));
 865
 866 unsigned int
 867 bfd_arch_bits_per_address PARAMS ((bfd *abfd));
 868
 869 bfd_arch_info_type *
 870 bfd_get_arch_info PARAMS ((bfd *));
 871
 872 bfd_arch_info_type *
 873 bfd_lookup_arch
 874  PARAMS ((enum bfd_architecture
 875     arch,
 876     long machine));
 877
 878 CONST char *
 879 bfd_printable_arch_mach
 880  PARAMS ((enum bfd_architecture arch, unsigned long machine));
 881
 882 typedef enum bfd_reloc_status
 883 {
 884         /* No errors detected */
 885   bfd_reloc_ok,
 886
 887         /* The relocation was performed, but there was an overflow. */
 888   bfd_reloc_overflow,
 889
 890         /* The address to relocate was not within the section supplied. */
 891   bfd_reloc_outofrange,
 892
 893         /* Used by special functions */
 894   bfd_reloc_continue,
 895
 896         /* Unused */
 897   bfd_reloc_notsupported,
 898
 899         /* Unsupported relocation size requested. */
 900   bfd_reloc_other,
 901
 902         /* The symbol to relocate against was undefined. */
 903   bfd_reloc_undefined,
 904
 905         /* The relocation was performed, but may not be ok - presently
 906           generated only when linking i960 coff files with i960 b.out
 907           symbols. */
 908   bfd_reloc_dangerous
 909  }
 910  bfd_reloc_status_type;
 911
 912
 913 typedef struct reloc_cache_entry
 914 {
 915         /* A pointer into the canonical table of pointers  */
 916   struct symbol_cache_entry **sym_ptr_ptr;
 917
 918         /* offset in section */
 919   bfd_size_type address;
 920
 921         /* addend for relocation value */
 922   bfd_vma addend;
 923
 924         /* Pointer to how to perform the required relocation */
 925   CONST struct reloc_howto_struct *howto;
 926
 927 } arelent;
 928
 929 typedef CONST struct reloc_howto_struct
 930 {
 931         /*  The type field has mainly a documetary use - the back end can
 932            to what it wants with it, though the normally the back end's
 933            external idea of what a reloc number would be would be stored
 934            in this field. For example, the a PC relative word relocation
 935            in a coff environment would have the type 023 - because that's
 936            what the outside world calls a R_PCRWORD reloc. */
 937   unsigned int type;
 938
 939         /*  The value the final relocation is shifted right by. This drops
 940            unwanted data from the relocation.  */
 941   unsigned int rightshift;
 942
 943         /*  The size of the item to be relocated - 0, is one byte, 1 is 2
 944            bytes, 2 is four bytes.  A negative value indicates that the
 945             result is to be subtracted from the data.  */
 946   int size;
 947
 948         /*  Now obsolete?  But m68k-coff still uses it... */
 949   unsigned int bitsize;
 950
 951         /*  Notes that the relocation is relative to the location in the
 952            data section of the addend. The relocation function will
 953            subtract from the relocation value the address of the location
 954            being relocated. */
 955   boolean pc_relative;
 956
 957   unsigned int bitpos;
 958
 959         /*  Now obsolete */
 960   boolean absolute;
 961
 962         /* Causes the relocation routine to return an error if overflow
 963           is detected when relocating. */
 964   boolean complain_on_overflow;
 965
 966         /* If this field is non null, then the supplied function is
 967           called rather than the normal function. This allows really
 968           strange relocation methods to be accomodated (e.g., i960 callj
 969           instructions). */
 970   bfd_reloc_status_type (*special_function)
 971                                     PARAMS ((bfd *abfd,
 972                                              arelent *reloc_entry,
 973                                             struct symbol_cache_entry *symbol,
 974                                             PTR data,
 975                                             asection *input_section,
 976                                             bfd *output_bfd));
 977
 978         /* The textual name of the relocation type. */
 979   char *name;
 980
 981         /* When performing a partial link, some formats must modify the
 982           relocations rather than the data - this flag signals this.*/
 983   boolean partial_inplace;
 984
 985         /* The src_mask is used to select what parts of the read in data
 986           are to be used in the relocation sum.  E.g., if this was an 8 bit
 987           bit of data which we read and relocated, this would be
 988           0x000000ff. When we have relocs which have an addend, such as
 989           sun4 extended relocs, the value in the offset part of a
 990           relocating field is garbage so we never use it. In this case
 991           the mask would be 0x00000000. */
 992   bfd_vma src_mask;
 993
 994         /* The dst_mask is what parts of the instruction are replaced
 995           into the instruction. In most cases src_mask == dst_mask,
 996           except in the above special case, where dst_mask would be
 997           0x000000ff, and src_mask would be 0x00000000.   */
 998   bfd_vma dst_mask;
 999
1000         /* When some formats create PC relative instructions, they leave
1001           the value of the pc of the place being relocated in the offset
1002           slot of the instruction, so that a PC relative relocation can
1003           be made just by adding in an ordinary offset (e.g., sun3 a.out).
1004           Some formats leave the displacement part of an instruction
1005           empty (e.g., m88k bcs), this flag signals the fact.*/
1006   boolean pcrel_offset;
1007
1008 } reloc_howto_type;
1009 #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
1010   {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
1011 #define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,false,false,FUNCTION, NAME,false,0,0,IN)
1012
1013 #define HOWTO_PREPARE(relocation, symbol)      \
1014   {                                            \
1015   if (symbol != (asymbol *)NULL) {             \
1016     if (bfd_is_com_section (symbol->section)) { \
1017       relocation = 0;                          \
1018     }                                          \
1019     else {                                     \
1020       relocation = symbol->value;              \
1021     }                                          \
1022   }                                            \
1023 }
1024 typedef unsigned char bfd_byte;
1025
1026 typedef struct relent_chain {
1027   arelent relent;
1028   struct   relent_chain *next;
1029 } arelent_chain;
1030 bfd_reloc_status_type
1031
1032 bfd_perform_relocation
1033  PARAMS ((bfd * abfd,
1034     arelent *reloc_entry,
1035     PTR data,
1036     asection *input_section,
1037     bfd *output_bfd));
1038
1039 typedef enum bfd_reloc_code_real
1040
1041 {
1042         /* 16 bits wide, simple reloc */
1043   BFD_RELOC_16,
1044
1045         /* 8 bits wide, but used to form an address like 0xffnn */
1046   BFD_RELOC_8_FFnn,
1047
1048         /* 8 bits wide, simple */
1049   BFD_RELOC_8,
1050
1051         /* 8 bits wide, pc relative */
1052   BFD_RELOC_8_PCREL,
1053
1054         /* The type of reloc used to build a contructor table - at the
1055           moment probably a 32 bit wide abs address, but the cpu can
1056           choose. */
1057
1058   BFD_RELOC_CTOR,
1059
1060         /* 32 bits wide, simple reloc */
1061   BFD_RELOC_32,
1062          /* 32 bits, PC-relative */
1063   BFD_RELOC_32_PCREL,
1064
1065          /* High 22 bits of 32-bit value; simple reloc.  */
1066   BFD_RELOC_HI22,
1067          /* Low 10 bits.  */
1068   BFD_RELOC_LO10,
1069
1070          /* Reloc types used for i960/b.out.  */
1071   BFD_RELOC_24_PCREL,
1072   BFD_RELOC_I960_CALLJ,
1073
1074   BFD_RELOC_16_PCREL,
1075          /* 32-bit pc-relative, shifted right 2 bits (i.e., 30-bit
1076            word displacement, e.g. for SPARC) */
1077   BFD_RELOC_32_PCREL_S2,
1078
1079    /* now for the sparc/elf codes */
1080   BFD_RELOC_NONE,                /* actually used */
1081   BFD_RELOC_SPARC_WDISP22,
1082   BFD_RELOC_SPARC22,
1083   BFD_RELOC_SPARC13,
1084   BFD_RELOC_SPARC_BASE13,
1085   BFD_RELOC_SPARC_GOT10,
1086   BFD_RELOC_SPARC_GOT13,
1087   BFD_RELOC_SPARC_GOT22,
1088   BFD_RELOC_SPARC_PC10,
1089   BFD_RELOC_SPARC_PC22,
1090   BFD_RELOC_SPARC_WPLT30,
1091   BFD_RELOC_SPARC_COPY,
1092   BFD_RELOC_SPARC_GLOB_DAT,
1093   BFD_RELOC_SPARC_JMP_SLOT,
1094   BFD_RELOC_SPARC_RELATIVE,
1095   BFD_RELOC_SPARC_UA32,
1096
1097    /* this one is a.out specific? */
1098   BFD_RELOC_SPARC_BASE22,
1099
1100         /* Bits 27..2 of the relocation address shifted right 2 bits;
1101          simple reloc otherwise.  */
1102   BFD_RELOC_MIPS_JMP,
1103
1104         /* signed 16-bit pc-relative, shifted right 2 bits (e.g. for MIPS) */
1105   BFD_RELOC_16_PCREL_S2,
1106
1107         /* High 16 bits of 32-bit value; simple reloc.  */
1108   BFD_RELOC_HI16,
1109         /* High 16 bits of 32-bit value but the low 16 bits will be sign
1110           extended and added to form the final result.  If the low 16
1111           bits form a negative number, we need to add one to the high value
1112           to compensate for the borrow when the low bits are added.  */
1113   BFD_RELOC_HI16_S,
1114         /* Low 16 bits.  */
1115   BFD_RELOC_LO16,
1116
1117          /* 16 bit relocation relative to the global pointer.  */
1118   BFD_RELOC_MIPS_GPREL,
1119
1120         /* These are, so far, specific to HPPA processors.  I'm not sure that
1121            some don't duplicate other reloc types, such as BFD_RELOC_32 and
1122            _32_PCREL.  Also, many more were in the list I got that don't
1123            fit in well in the model BFD uses, so I've omitted them for now.
1124            If we do make this reloc type get used for code that really does
1125            implement the funky reloc types, they'll have to be added to this
1126            list.   */
1127   BFD_RELOC_HPPA_32,
1128   BFD_RELOC_HPPA_11,
1129   BFD_RELOC_HPPA_14,
1130   BFD_RELOC_HPPA_17,
1131   BFD_RELOC_HPPA_L21,
1132   BFD_RELOC_HPPA_R11,
1133   BFD_RELOC_HPPA_R14,
1134   BFD_RELOC_HPPA_R17,
1135   BFD_RELOC_HPPA_LS21,
1136   BFD_RELOC_HPPA_RS11,
1137   BFD_RELOC_HPPA_RS14,
1138   BFD_RELOC_HPPA_RS17,
1139   BFD_RELOC_HPPA_LD21,
1140   BFD_RELOC_HPPA_RD11,
1141   BFD_RELOC_HPPA_RD14,
1142   BFD_RELOC_HPPA_RD17,
1143   BFD_RELOC_HPPA_LR21,
1144   BFD_RELOC_HPPA_RR14,
1145   BFD_RELOC_HPPA_RR17,
1146   BFD_RELOC_HPPA_GOTOFF_11,
1147   BFD_RELOC_HPPA_GOTOFF_14,
1148   BFD_RELOC_HPPA_GOTOFF_L21,
1149   BFD_RELOC_HPPA_GOTOFF_R11,
1150   BFD_RELOC_HPPA_GOTOFF_R14,
1151   BFD_RELOC_HPPA_GOTOFF_LS21,
1152   BFD_RELOC_HPPA_GOTOFF_RS11,
1153   BFD_RELOC_HPPA_GOTOFF_RS14,
1154   BFD_RELOC_HPPA_GOTOFF_LD21,
1155   BFD_RELOC_HPPA_GOTOFF_RD11,
1156   BFD_RELOC_HPPA_GOTOFF_RD14,
1157   BFD_RELOC_HPPA_GOTOFF_LR21,
1158   BFD_RELOC_HPPA_GOTOFF_RR14,
1159   BFD_RELOC_HPPA_DLT_32,
1160   BFD_RELOC_HPPA_DLT_11,
1161   BFD_RELOC_HPPA_DLT_14,
1162   BFD_RELOC_HPPA_DLT_L21,
1163   BFD_RELOC_HPPA_DLT_R11,
1164   BFD_RELOC_HPPA_DLT_R14,
1165   BFD_RELOC_HPPA_ABS_CALL_11,
1166   BFD_RELOC_HPPA_ABS_CALL_14,
1167   BFD_RELOC_HPPA_ABS_CALL_17,
1168   BFD_RELOC_HPPA_ABS_CALL_L21,
1169   BFD_RELOC_HPPA_ABS_CALL_R11,
1170   BFD_RELOC_HPPA_ABS_CALL_R14,
1171   BFD_RELOC_HPPA_ABS_CALL_R17,
1172   BFD_RELOC_HPPA_ABS_CALL_LS21,
1173   BFD_RELOC_HPPA_ABS_CALL_RS11,
1174   BFD_RELOC_HPPA_ABS_CALL_RS14,
1175   BFD_RELOC_HPPA_ABS_CALL_RS17,
1176   BFD_RELOC_HPPA_ABS_CALL_LD21,
1177   BFD_RELOC_HPPA_ABS_CALL_RD11,
1178   BFD_RELOC_HPPA_ABS_CALL_RD14,
1179   BFD_RELOC_HPPA_ABS_CALL_RD17,
1180   BFD_RELOC_HPPA_ABS_CALL_LR21,
1181   BFD_RELOC_HPPA_ABS_CALL_RR14,
1182   BFD_RELOC_HPPA_ABS_CALL_RR17,
1183   BFD_RELOC_HPPA_PCREL_CALL_11,
1184   BFD_RELOC_HPPA_PCREL_CALL_12,
1185   BFD_RELOC_HPPA_PCREL_CALL_14,
1186   BFD_RELOC_HPPA_PCREL_CALL_17,
1187   BFD_RELOC_HPPA_PCREL_CALL_L21,
1188   BFD_RELOC_HPPA_PCREL_CALL_R11,
1189   BFD_RELOC_HPPA_PCREL_CALL_R14,
1190   BFD_RELOC_HPPA_PCREL_CALL_R17,
1191   BFD_RELOC_HPPA_PCREL_CALL_LS21,
1192   BFD_RELOC_HPPA_PCREL_CALL_RS11,
1193   BFD_RELOC_HPPA_PCREL_CALL_RS14,
1194   BFD_RELOC_HPPA_PCREL_CALL_RS17,
1195   BFD_RELOC_HPPA_PCREL_CALL_LD21,
1196   BFD_RELOC_HPPA_PCREL_CALL_RD11,
1197   BFD_RELOC_HPPA_PCREL_CALL_RD14,
1198   BFD_RELOC_HPPA_PCREL_CALL_RD17,
1199   BFD_RELOC_HPPA_PCREL_CALL_LR21,
1200   BFD_RELOC_HPPA_PCREL_CALL_RR14,
1201   BFD_RELOC_HPPA_PCREL_CALL_RR17,
1202   BFD_RELOC_HPPA_PLABEL_32,
1203   BFD_RELOC_HPPA_PLABEL_11,
1204   BFD_RELOC_HPPA_PLABEL_14,
1205   BFD_RELOC_HPPA_PLABEL_L21,
1206   BFD_RELOC_HPPA_PLABEL_R11,
1207   BFD_RELOC_HPPA_PLABEL_R14,
1208   BFD_RELOC_HPPA_UNWIND_ENTRY,
1209   BFD_RELOC_HPPA_UNWIND_ENTRIES,
1210
1211    /* this must be the highest numeric value */
1212   BFD_RELOC_UNUSED
1213  } bfd_reloc_code_real_type;
1214 CONST struct reloc_howto_struct *
1215
1216 bfd_reloc_type_lookup  PARAMS ((bfd *abfd, bfd_reloc_code_real_type code));
1217
1218 typedef struct symbol_cache_entry
1219 {
1220          /* A pointer to the BFD which owns the symbol. This information
1221            is necessary so that a back end can work out what additional
1222            information (invisible to the application writer) is carried
1223            with the symbol.
1224
1225            This field is *almost* redundant, since you can use section->owner
1226            instead, except that some symbols point to the global sections
1227            bfd_{abs,com,und}_section.  This could be fixed by making
1228            these globals be per-bfd (or per-target-flavor).  FIXME. */
1229
1230   struct _bfd *the_bfd;  /* Use bfd_asymbol_bfd(sym) to access this field. */
1231
1232          /* The text of the symbol. The name is left alone, and not copied - the
1233            application may not alter it. */
1234   CONST char *name;
1235
1236          /* The value of the symbol.  This really should be a union of a
1237           numeric value with a pointer, since some flags indicate that
1238           a pointer to another symbol is stored here.  */
1239   symvalue value;
1240
1241          /* Attributes of a symbol: */
1242
1243 #define BSF_NO_FLAGS    0x00
1244
1245          /* The symbol has local scope; <<static>> in <<C>>. The value
1246            is the offset into the section of the data. */
1247 #define BSF_LOCAL       0x01
1248
1249          /* The symbol has global scope; initialized data in <<C>>. The
1250            value is the offset into the section of the data. */
1251 #define BSF_GLOBAL      0x02
1252
1253          /* The symbol has global scope, and is exported. The value is
1254            the offset into the section of the data. */
1255 #define BSF_EXPORT      0x04
1256
1257          /* A normal C symbol would be one of:
1258            <<BSF_LOCAL>>, <<BSF_FORT_COMM>>,  <<BSF_UNDEFINED>> or
1259            <<BSF_EXPORT|BSD_GLOBAL>> */
1260
1261          /* The symbol is a debugging record. The value has an arbitary
1262            meaning. */
1263 #define BSF_DEBUGGING   0x08
1264
1265          /* The symbol denotes a function entry point.  Used in ELF,
1266            perhaps others someday.  */
1267 #define BSF_FUNCTION    0x10
1268
1269          /* Used by the linker. */
1270 #define BSF_KEEP        0x20
1271 #define BSF_KEEP_G      0x40
1272
1273          /* ... document me ... */
1274 #define BSF_WEAK        0x80
1275
1276         /* This symbol was created to point to a section, e.g. ELF's
1277            STT_SECTION symbols.  */
1278 #define BSF_SECTION_SYM 0x100
1279
1280          /* The symbol used to be a common symbol, but now it is
1281            allocated. */
1282 #define BSF_OLD_COMMON  0x200
1283
1284          /* The default value for common data. */
1285 #define BFD_FORT_COMM_DEFAULT_VALUE 0
1286
1287          /* In some files the type of a symbol sometimes alters its
1288            location in an output file - ie in coff a <<ISFCN>> symbol
1289            which is also <<C_EXT>> symbol appears where it was
1290            declared and not at the end of a section.  This bit is set
1291            by the target BFD part to convey this information. */
1292
1293 #define BSF_NOT_AT_END    0x400
1294
1295          /* Signal that the symbol is the label of constructor section. */
1296 #define BSF_CONSTRUCTOR   0x800
1297
1298          /* Signal that the symbol is a warning symbol. If the symbol
1299            is a warning symbol, then the value field (I know this is
1300            tacky) will point to the asymbol which when referenced will
1301            cause the warning. */
1302 #define BSF_WARNING       0x1000
1303
1304          /* Signal that the symbol is indirect. The value of the symbol
1305            is a pointer to an undefined asymbol which contains the
1306            name to use instead. */
1307 #define BSF_INDIRECT      0x2000
1308
1309          /* BSF_FILE marks symbols that contain a file name.  This is used
1310            for ELF STT_FILE symbols.  */
1311 #define BSF_FILE          0x4000
1312
1313   flagword flags;
1314
1315          /* A pointer to the section to which this symbol is
1316            relative.  This will always be non NULL, there are special
1317           sections for undefined and absolute symbols */
1318   struct sec *section;
1319
1320          /* Back end special data. This is being phased out in favour
1321            of making this a union. */
1322   PTR udata;
1323
1324 } asymbol;
1325 #define get_symtab_upper_bound(abfd) \
1326      BFD_SEND (abfd, _get_symtab_upper_bound, (abfd))
1327 #define bfd_canonicalize_symtab(abfd, location) \
1328      BFD_SEND (abfd, _bfd_canonicalize_symtab,\
1329                   (abfd, location))
1330 boolean
1331 bfd_set_symtab  PARAMS ((bfd *, asymbol **, unsigned int ));
1332
1333 void
1334 bfd_print_symbol_vandf PARAMS ((PTR file, asymbol *symbol));
1335
1336 #define bfd_make_empty_symbol(abfd) \
1337      BFD_SEND (abfd, _bfd_make_empty_symbol, (abfd))
1338 #define bfd_make_debug_symbol(abfd,ptr,size) \
1339         BFD_SEND (abfd, _bfd_make_debug_symbol, (abfd, ptr, size))
1340 int
1341 bfd_decode_symclass PARAMS ((asymbol *symbol));
1342
1343 void
1344 bfd_symbol_info PARAMS ((asymbol *symbol, symbol_info *ret));
1345
1346 struct _bfd
1347 {
1348      /* The filename the application opened the BFD with.  */
1349     CONST char *filename;
1350
1351      /* A pointer to the target jump table.             */
1352     struct bfd_target *xvec;
1353
1354      /* To avoid dragging too many header files into every file that
1355        includes `<<bfd.h>>', IOSTREAM has been declared as a "char
1356        *", and MTIME as a "long".  Their correct types, to which they
1357        are cast when used, are "FILE *" and "time_t".    The iostream
1358        is the result of an fopen on the filename. */
1359     char *iostream;
1360
1361      /* Is the file being cached */
1362
1363     boolean cacheable;
1364
1365      /* Marks whether there was a default target specified when the
1366        BFD was opened. This is used to select what matching algorithm
1367        to use to chose the back end. */
1368
1369     boolean target_defaulted;
1370
1371      /* The caching routines use these to maintain a
1372        least-recently-used list of BFDs */
1373
1374     struct _bfd *lru_prev, *lru_next;
1375
1376      /* When a file is closed by the caching routines, BFD retains
1377        state information on the file here:
1378      */
1379
1380     file_ptr where;
1381
1382      /* and here:*/
1383
1384     boolean opened_once;
1385
1386      /* Set if we have a locally maintained mtime value, rather than
1387        getting it from the file each time: */
1388
1389     boolean mtime_set;
1390
1391      /* File modified time, if mtime_set is true: */
1392
1393     long mtime;
1394
1395      /* Reserved for an unimplemented file locking extension.*/
1396
1397     int ifd;
1398
1399      /* The format which belongs to the BFD.*/
1400
1401     bfd_format format;
1402
1403      /* The direction the BFD was opened with*/
1404
1405     enum bfd_direction {no_direction = 0,
1406                         read_direction = 1,
1407                         write_direction = 2,
1408                         both_direction = 3} direction;
1409
1410      /* Format_specific flags*/
1411
1412     flagword flags;
1413
1414      /* Currently my_archive is tested before adding origin to
1415        anything. I believe that this can become always an add of
1416        origin, with origin set to 0 for non archive files.   */
1417
1418     file_ptr origin;
1419
1420      /* Remember when output has begun, to stop strange things
1421        happening. */
1422     boolean output_has_begun;
1423
1424      /* Pointer to linked list of sections*/
1425     struct sec  *sections;
1426
1427      /* The number of sections */
1428     unsigned int section_count;
1429
1430      /* Stuff only useful for object files:
1431        The start address. */
1432     bfd_vma start_address;
1433
1434      /* Used for input and output*/
1435     unsigned int symcount;
1436
1437      /* Symbol table for output BFD*/
1438     struct symbol_cache_entry  **outsymbols;
1439
1440      /* Pointer to structure which contains architecture information*/
1441     struct bfd_arch_info *arch_info;
1442
1443      /* Stuff only useful for archives:*/
1444     PTR arelt_data;
1445     struct _bfd *my_archive;
1446     struct _bfd *next;
1447     struct _bfd *archive_head;
1448     boolean has_armap;
1449
1450      /* Used by the back end to hold private data. */
1451
1452     union
1453       {
1454       struct aout_data_struct *aout_data;
1455       struct artdata *aout_ar_data;
1456       struct _oasys_data *oasys_obj_data;
1457       struct _oasys_ar_data *oasys_ar_data;
1458       struct coff_tdata *coff_obj_data;
1459       struct ecoff_tdata *ecoff_obj_data;
1460       struct ieee_data_struct *ieee_data;
1461       struct ieee_ar_data_struct *ieee_ar_data;
1462       struct srec_data_struct *srec_data;
1463       struct tekhex_data_struct *tekhex_data;
1464       struct elf_obj_tdata *elf_obj_data;
1465       struct bout_data_struct *bout_data;
1466       struct sun_core_struct *sun_core_data;
1467       struct trad_core_struct *trad_core_data;
1468       struct hppa_data_struct *hppa_data;
1469       struct hppa_core_struct *hppa_core_data;
1470       struct sgi_core_struct *sgi_core_data;
1471       PTR any;
1472       } tdata;
1473
1474      /* Used by the application to hold private data*/
1475     PTR usrdata;
1476
1477      /* Where all the allocated stuff under this BFD goes */
1478     struct obstack memory;
1479
1480      /* Is this really needed in addition to usrdata?  */
1481     asymbol **ld_symbols;
1482 };
1483
1484 unsigned int
1485 bfd_get_reloc_upper_bound PARAMS ((bfd *abfd, asection *sect));
1486
1487 unsigned int
1488 bfd_canonicalize_reloc
1489  PARAMS ((bfd *abfd,
1490     asection *sec,
1491     arelent **loc,
1492     asymbol     **syms));
1493
1494 boolean
1495 bfd_set_file_flags PARAMS ((bfd *abfd, flagword flags));
1496
1497 void
1498 bfd_set_reloc
1499  PARAMS ((bfd *abfd, asection *sec, arelent **rel, unsigned int count)
1500
1501     );
1502
1503 boolean
1504 bfd_set_start_address PARAMS ((bfd *, bfd_vma));
1505
1506 long
1507 bfd_get_mtime PARAMS ((bfd *));
1508
1509 long
1510 bfd_get_size PARAMS ((bfd *));
1511
1512 int
1513 bfd_get_gp_size PARAMS ((bfd *));
1514
1515 void
1516 bfd_set_gp_size PARAMS ((bfd *, int));
1517
1518 #define bfd_sizeof_headers(abfd, reloc) \
1519      BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1520
1521 #define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1522      BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
1523
1524         /* Do these three do anything useful at all, for any back end?  */
1525 #define bfd_debug_info_start(abfd) \
1526         BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1527
1528 #define bfd_debug_info_end(abfd) \
1529         BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1530
1531 #define bfd_debug_info_accumulate(abfd, section) \
1532         BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1533
1534
1535 #define bfd_stat_arch_elt(abfd, stat) \
1536         BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1537
1538 #define bfd_set_arch_mach(abfd, arch, mach)\
1539         BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1540
1541 #define bfd_get_relocated_section_contents(abfd, seclet, data, relocateable) \
1542         BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data, relocateable))
1543
1544 #define bfd_relax_section(abfd, section, symbols) \
1545        BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
1546
1547 #define bfd_seclet_link(abfd, data, relocateable) \
1548        BFD_SEND (abfd, _bfd_seclet_link, (abfd, data, relocateable))
1549 symindex
1550 bfd_get_next_mapent PARAMS ((bfd *, symindex previous, carsym ** sym));
1551
1552 boolean
1553 bfd_set_archive_head PARAMS ((bfd *output, bfd *new_head));
1554
1555 bfd *
1556 bfd_get_elt_at_index PARAMS ((bfd * archive, int index));
1557
1558 bfd*
1559 bfd_openr_next_archived_file PARAMS ((bfd *archive, bfd *previous));
1560
1561 CONST char *
1562 bfd_core_file_failing_command PARAMS ((bfd *));
1563
1564 int
1565 bfd_core_file_failing_signal PARAMS ((bfd *));
1566
1567 boolean
1568 core_file_matches_executable_p
1569  PARAMS ((bfd *core_bfd, bfd *exec_bfd));
1570
1571 #define BFD_SEND(bfd, message, arglist) \
1572                ((*((bfd)->xvec->message)) arglist)
1573 #define BFD_SEND_FMT(bfd, message, arglist) \
1574             (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
1575 typedef struct bfd_target
1576 {
1577   char *name;
1578   enum target_flavour {
1579     bfd_target_unknown_flavour,
1580     bfd_target_aout_flavour,
1581     bfd_target_coff_flavour,
1582     bfd_target_ecoff_flavour,
1583     bfd_target_elf_flavour,
1584     bfd_target_ieee_flavour,
1585     bfd_target_oasys_flavour,
1586     bfd_target_tekhex_flavour,
1587     bfd_target_srec_flavour,
1588     bfd_target_hppa_flavour} flavour;
1589   boolean byteorder_big_p;
1590   boolean header_byteorder_big_p;
1591   flagword object_flags;
1592   flagword section_flags;
1593   char symbol_leading_char;
1594   char ar_pad_char;
1595   unsigned short ar_max_namelen;
1596   unsigned int align_power_min;
1597   bfd_vma      (*bfd_getx64) PARAMS ((bfd_byte *));
1598   bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((bfd_byte *));
1599   void         (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *));
1600   bfd_vma      (*bfd_getx32) PARAMS ((bfd_byte *));
1601   bfd_signed_vma (*bfd_getx_signed_32) PARAMS ((bfd_byte *));
1602   void         (*bfd_putx32) PARAMS ((bfd_vma, bfd_byte *));
1603   bfd_vma      (*bfd_getx16) PARAMS ((bfd_byte *));
1604   bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((bfd_byte *));
1605   void         (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *));
1606   bfd_vma      (*bfd_h_getx64) PARAMS ((bfd_byte *));
1607   bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((bfd_byte *));
1608   void         (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *));
1609   bfd_vma      (*bfd_h_getx32) PARAMS ((bfd_byte *));
1610   bfd_signed_vma (*bfd_h_getx_signed_32) PARAMS ((bfd_byte *));
1611   void         (*bfd_h_putx32) PARAMS ((bfd_vma, bfd_byte *));
1612   bfd_vma      (*bfd_h_getx16) PARAMS ((bfd_byte *));
1613   bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((bfd_byte *));
1614   void         (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *));
1615   struct bfd_target * (*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *));
1616   boolean             (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *));
1617   boolean             (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *));
1618   char *   (*_core_file_failing_command) PARAMS ((bfd *));
1619   int      (*_core_file_failing_signal) PARAMS ((bfd *));
1620   boolean  (*_core_file_matches_executable_p) PARAMS ((bfd *, bfd *));
1621   boolean  (*_bfd_slurp_armap) PARAMS ((bfd *));
1622   boolean  (*_bfd_slurp_extended_name_table) PARAMS ((bfd *));
1623   void     (*_bfd_truncate_arname) PARAMS ((bfd *, CONST char *, char *));
1624   boolean  (*write_armap) PARAMS ((bfd *arch,
1625                               unsigned int elength,
1626                               struct orl *map,
1627                               unsigned int orl_count,
1628                               int stridx));
1629   boolean       (*_close_and_cleanup) PARAMS ((bfd *));
1630   boolean       (*_bfd_set_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1631                                             file_ptr, bfd_size_type));
1632   boolean       (*_bfd_get_section_contents) PARAMS ((bfd *, sec_ptr, PTR,
1633                                             file_ptr, bfd_size_type));
1634   boolean       (*_new_section_hook) PARAMS ((bfd *, sec_ptr));
1635   unsigned int  (*_get_symtab_upper_bound) PARAMS ((bfd *));
1636   unsigned int  (*_bfd_canonicalize_symtab) PARAMS ((bfd *,
1637                                               struct symbol_cache_entry **));
1638   unsigned int  (*_get_reloc_upper_bound) PARAMS ((bfd *, sec_ptr));
1639   unsigned int  (*_bfd_canonicalize_reloc) PARAMS ((bfd *, sec_ptr, arelent **,
1640                                               struct symbol_cache_entry **));
1641   struct symbol_cache_entry  *
1642                 (*_bfd_make_empty_symbol) PARAMS ((bfd *));
1643   void          (*_bfd_print_symbol) PARAMS ((bfd *, PTR,
1644                                       struct symbol_cache_entry *,
1645                                       bfd_print_symbol_type));
1646 #define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
1647   void          (*_bfd_get_symbol_info) PARAMS ((bfd *,
1648                                       struct symbol_cache_entry *,
1649                                       symbol_info *));
1650 #define bfd_get_symbol_info(b,p,e) BFD_SEND(b, _bfd_get_symbol_info, (b,p,e))
1651   alent *    (*_get_lineno) PARAMS ((bfd *, struct symbol_cache_entry *));
1652
1653   boolean    (*_bfd_set_arch_mach) PARAMS ((bfd *, enum bfd_architecture,
1654                     unsigned long));
1655
1656   bfd *      (*openr_next_archived_file) PARAMS ((bfd *arch, bfd *prev));
1657
1658   boolean    (*_bfd_find_nearest_line) PARAMS ((bfd *abfd,
1659                     struct sec *section, struct symbol_cache_entry **symbols,
1660                     bfd_vma offset, CONST char **file, CONST char **func,
1661                     unsigned int *line));
1662
1663   int        (*_bfd_stat_arch_elt) PARAMS ((bfd *, struct stat *));
1664
1665   int        (*_bfd_sizeof_headers) PARAMS ((bfd *, boolean));
1666
1667   void       (*_bfd_debug_info_start) PARAMS ((bfd *));
1668   void       (*_bfd_debug_info_end) PARAMS ((bfd *));
1669   void       (*_bfd_debug_info_accumulate) PARAMS ((bfd *, struct sec *));
1670
1671   bfd_byte * (*_bfd_get_relocated_section_contents) PARAMS ((bfd *,
1672                     struct bfd_seclet *, bfd_byte *data,
1673                     boolean relocateable));
1674
1675   boolean    (*_bfd_relax_section) PARAMS ((bfd *, struct sec *,
1676                     struct symbol_cache_entry **));
1677
1678   boolean    (*_bfd_seclet_link) PARAMS ((bfd *, PTR data,
1679                      boolean relocateable));
1680   /* See documentation on reloc types.  */
1681  CONST struct reloc_howto_struct *
1682        (*reloc_type_lookup) PARAMS ((bfd *abfd,
1683                                      bfd_reloc_code_real_type code));
1684
1685   /* Back-door to allow format-aware applications to create debug symbols
1686     while using BFD for everything else.  Currently used by the assembler
1687     when creating COFF files.  */
1688  asymbol *  (*_bfd_make_debug_symbol) PARAMS ((
1689        bfd *abfd,
1690        void *ptr,
1691        unsigned long size));
1692  PTR backend_data;
1693 } bfd_target;
1694 bfd_target *
1695 bfd_find_target PARAMS ((CONST char *, bfd *));
1696
1697 CONST char **
1698 bfd_target_list PARAMS ((void));
1699
1700 boolean
1701 bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
1702
1703 boolean
1704 bfd_set_format PARAMS ((bfd *, bfd_format));
1705
1706 CONST char *
1707 bfd_format_string PARAMS ((bfd_format));
1708
1709 #endif