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