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