bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2
   3    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   4    1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Support.
   7
   8    This file is part of BFD, the Binary File Descriptor library.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
  23
  24 #ifndef __BFD_H_SEEN__
  25 #define __BFD_H_SEEN__
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #include "ansidecl.h"
  32 #include "symcat.h"
  33 #if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)
  34 #ifndef SABER
  35 /* This hack is to avoid a problem with some strict ANSI C preprocessors.
  36    The problem is, "32_" is not a valid preprocessing token, and we don't
  37    want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will
  38    cause the inner CONCAT2 macros to be evaluated first, producing
  39    still-valid pp-tokens.  Then the final concatenation can be done.  */
  40 #undef CONCAT4
  41 #define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))
  42 #endif
  43 #endif
  44
  45 /* The word size used by BFD on the host.  This may be 64 with a 32
  46    bit target if the host is 64 bit, or if other 64 bit targets have
  47    been selected with --enable-targets, or if --enable-64-bit-bfd.  */
  48 #define BFD_ARCH_SIZE @wordsize@
  49
  50 /* The word size of the default bfd target.  */
  51 #define BFD_DEFAULT_TARGET_SIZE @bfd_default_target_size@
  52
  53 #define BFD_HOST_64BIT_LONG @BFD_HOST_64BIT_LONG@
  54 #define BFD_HOST_LONG_LONG @BFD_HOST_LONG_LONG@
  55 #if @BFD_HOST_64_BIT_DEFINED@
  56 #define BFD_HOST_64_BIT @BFD_HOST_64_BIT@
  57 #define BFD_HOST_U_64_BIT @BFD_HOST_U_64_BIT@
  58 typedef BFD_HOST_64_BIT bfd_int64_t;
  59 typedef BFD_HOST_U_64_BIT bfd_uint64_t;
  60 #endif
  61
  62 #if BFD_ARCH_SIZE >= 64
  63 #define BFD64
  64 #endif
  65
  66 #ifndef INLINE
  67 #if __GNUC__ >= 2
  68 #define INLINE __inline__
  69 #else
  70 #define INLINE
  71 #endif
  72 #endif
  73
  74 /* Forward declaration.  */
  75 typedef struct bfd bfd;
  76
  77 /* Boolean type used in bfd.  Too many systems define their own
  78    versions of "boolean" for us to safely typedef a "boolean" of
  79    our own.  Using an enum for "bfd_boolean" has its own set of
  80    problems, with strange looking casts required to avoid warnings
  81    on some older compilers.  Thus we just use an int.
  82
  83    General rule: Functions which are bfd_boolean return TRUE on
  84    success and FALSE on failure (unless they're a predicate).  */
  85
  86 typedef int bfd_boolean;
  87 #undef FALSE
  88 #undef TRUE
  89 #define FALSE 0
  90 #define TRUE 1
  91
  92 #ifdef BFD64
  93
  94 #ifndef BFD_HOST_64_BIT
  95  #error No 64 bit integer type available
  96 #endif /* ! defined (BFD_HOST_64_BIT) */
  97
  98 typedef BFD_HOST_U_64_BIT bfd_vma;
  99 typedef BFD_HOST_64_BIT bfd_signed_vma;
 100 typedef BFD_HOST_U_64_BIT bfd_size_type;
 101 typedef BFD_HOST_U_64_BIT symvalue;
 102
 103 #ifndef fprintf_vma
 104 #if BFD_HOST_64BIT_LONG
 105 #define sprintf_vma(s,x) sprintf (s, "%016lx", x)
 106 #define fprintf_vma(f,x) fprintf (f, "%016lx", x)
 107 #else
 108 #define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))
 109 #define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))
 110 #define fprintf_vma(s,x) \
 111   fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 112 #define sprintf_vma(s,x) \
 113   sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))
 114 #endif
 115 #endif
 116
 117 #else /* not BFD64  */
 118
 119 /* Represent a target address.  Also used as a generic unsigned type
 120    which is guaranteed to be big enough to hold any arithmetic types
 121    we need to deal with.  */
 122 typedef unsigned long bfd_vma;
 123
 124 /* A generic signed type which is guaranteed to be big enough to hold any
 125    arithmetic types we need to deal with.  Can be assumed to be compatible
 126    with bfd_vma in the same way that signed and unsigned ints are compatible
 127    (as parameters, in assignment, etc).  */
 128 typedef long bfd_signed_vma;
 129
 130 typedef unsigned long symvalue;
 131 typedef unsigned long bfd_size_type;
 132
 133 /* Print a bfd_vma x on stream s.  */
 134 #define fprintf_vma(s,x) fprintf (s, "%08lx", x)
 135 #define sprintf_vma(s,x) sprintf (s, "%08lx", x)
 136
 137 #endif /* not BFD64  */
 138
 139 #define HALF_BFD_SIZE_TYPE \
 140   (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))
 141
 142 #ifndef BFD_HOST_64_BIT
 143 /* Fall back on a 32 bit type.  The idea is to make these types always
 144    available for function return types, but in the case that
 145    BFD_HOST_64_BIT is undefined such a function should abort or
 146    otherwise signal an error.  */
 147 typedef bfd_signed_vma bfd_int64_t;
 148 typedef bfd_vma bfd_uint64_t;
 149 #endif
 150
 151 /* An offset into a file.  BFD always uses the largest possible offset
 152    based on the build time availability of fseek, fseeko, or fseeko64.  */
 153 typedef @bfd_file_ptr@ file_ptr;
 154 typedef unsigned @bfd_file_ptr@ ufile_ptr;
 155
 156 extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);
 157 extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);
 158
 159 #define printf_vma(x) fprintf_vma(stdout,x)
 160 #define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)
 161
 162 typedef unsigned int flagword;  /* 32 bits of flags */
 163 typedef unsigned char bfd_byte;
 164 \f
 165 /* File formats.  */
 166
 167 typedef enum bfd_format
 168 {
 169   bfd_unknown = 0,      /* File format is unknown.  */
 170   bfd_object,           /* Linker/assembler/compiler output.  */
 171   bfd_archive,          /* Object archive file.  */
 172   bfd_core,             /* Core dump.  */
 173   bfd_type_end          /* Marks the end; don't use it!  */
 174 }
 175 bfd_format;
 176
 177 /* Values that may appear in the flags field of a BFD.  These also
 178    appear in the object_flags field of the bfd_target structure, where
 179    they indicate the set of flags used by that backend (not all flags
 180    are meaningful for all object file formats) (FIXME: at the moment,
 181    the object_flags values have mostly just been copied from backend
 182    to another, and are not necessarily correct).  */
 183
 184 /* No flags.  */
 185 #define BFD_NO_FLAGS    0x00
 186
 187 /* BFD contains relocation entries.  */
 188 #define HAS_RELOC       0x01
 189
 190 /* BFD is directly executable.  */
 191 #define EXEC_P          0x02
 192
 193 /* BFD has line number information (basically used for F_LNNO in a
 194    COFF header).  */
 195 #define HAS_LINENO      0x04
 196
 197 /* BFD has debugging information.  */
 198 #define HAS_DEBUG       0x08
 199
 200 /* BFD has symbols.  */
 201 #define HAS_SYMS        0x10
 202
 203 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 204    header).  */
 205 #define HAS_LOCALS      0x20
 206
 207 /* BFD is a dynamic object.  */
 208 #define DYNAMIC         0x40
 209
 210 /* Text section is write protected (if D_PAGED is not set, this is
 211    like an a.out NMAGIC file) (the linker sets this by default, but
 212    clears it for -r or -N).  */
 213 #define WP_TEXT         0x80
 214
 215 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 216    linker sets this by default, but clears it for -r or -n or -N).  */
 217 #define D_PAGED         0x100
 218
 219 /* BFD is relaxable (this means that bfd_relax_section may be able to
 220    do something) (sometimes bfd_relax_section can do something even if
 221    this is not set).  */
 222 #define BFD_IS_RELAXABLE 0x200
 223
 224 /* This may be set before writing out a BFD to request using a
 225    traditional format.  For example, this is used to request that when
 226    writing out an a.out object the symbols not be hashed to eliminate
 227    duplicates.  */
 228 #define BFD_TRADITIONAL_FORMAT 0x400
 229
 230 /* This flag indicates that the BFD contents are actually cached in
 231    memory.  If this is set, iostream points to a bfd_in_memory struct.  */
 232 #define BFD_IN_MEMORY 0x800
 233
 234 /* The sections in this BFD specify a memory page.  */
 235 #define HAS_LOAD_PAGE 0x1000
 236
 237 /* This BFD has been created by the linker and doesn't correspond
 238    to any input file.  */
 239 #define BFD_LINKER_CREATED 0x2000
 240 \f
 241 /* Symbols and relocation.  */
 242
 243 /* A count of carsyms (canonical archive symbols).  */
 244 typedef unsigned long symindex;
 245
 246 /* How to perform a relocation.  */
 247 typedef const struct reloc_howto_struct reloc_howto_type;
 248
 249 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 250
 251 /* General purpose part of a symbol X;
 252    target specific parts are in libcoff.h, libaout.h, etc.  */
 253
 254 #define bfd_get_section(x) ((x)->section)
 255 #define bfd_get_output_section(x) ((x)->section->output_section)
 256 #define bfd_set_section(x,y) ((x)->section) = (y)
 257 #define bfd_asymbol_base(x) ((x)->section->vma)
 258 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 259 #define bfd_asymbol_name(x) ((x)->name)
 260 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 261 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 262 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 263
 264 /* A canonical archive symbol.  */
 265 /* This is a type pun with struct ranlib on purpose!  */
 266 typedef struct carsym
 267 {
 268   char *name;
 269   file_ptr file_offset; /* Look here to find the file.  */
 270 }
 271 carsym;                 /* To make these you call a carsymogen.  */
 272
 273 /* Used in generating armaps (archive tables of contents).
 274    Perhaps just a forward definition would do?  */
 275 struct orl                      /* Output ranlib.  */
 276 {
 277   char **name;          /* Symbol name.  */
 278   union
 279   {
 280     file_ptr pos;
 281     bfd *abfd;
 282   } u;                  /* bfd* or file position.  */
 283   int namidx;           /* Index into string table.  */
 284 };
 285 \f
 286 /* Linenumber stuff.  */
 287 typedef struct lineno_cache_entry
 288 {
 289   unsigned int line_number;     /* Linenumber from start of function.  */
 290   union
 291   {
 292     struct bfd_symbol *sym;     /* Function name.  */
 293     bfd_vma offset;                     /* Offset into section.  */
 294   } u;
 295 }
 296 alent;
 297 \f
 298 /* Object and core file sections.  */
 299
 300 #define align_power(addr, align)        \
 301   (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))
 302
 303 typedef struct bfd_section *sec_ptr;
 304
 305 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 306 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 307 #define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)
 308 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 309 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 310 #define bfd_section_size(bfd, ptr) ((ptr)->size)
 311 #define bfd_get_section_size(ptr) ((ptr)->size)
 312 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 313 #define bfd_section_lma(bfd, ptr) ((ptr)->lma)
 314 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 315 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 316 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 317
 318 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 319
 320 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)
 321 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)
 322 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)
 323 /* Find the address one past the end of SEC.  */
 324 #define bfd_get_section_limit(bfd, sec) \
 325   (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \
 326    / bfd_octets_per_byte (bfd))
 327
 328 typedef struct stat stat_type;
 329 \f
 330 typedef enum bfd_print_symbol
 331 {
 332   bfd_print_symbol_name,
 333   bfd_print_symbol_more,
 334   bfd_print_symbol_all
 335 } bfd_print_symbol_type;
 336
 337 /* Information about a symbol that nm needs.  */
 338
 339 typedef struct _symbol_info
 340 {
 341   symvalue value;
 342   char type;
 343   const char *name;            /* Symbol name.  */
 344   unsigned char stab_type;     /* Stab type.  */
 345   char stab_other;             /* Stab other.  */
 346   short stab_desc;             /* Stab desc.  */
 347   const char *stab_name;       /* String for stab type.  */
 348 } symbol_info;
 349
 350 /* Get the name of a stabs type code.  */
 351
 352 extern const char *bfd_get_stab_name (int);
 353 \f
 354 /* Hash table routines.  There is no way to free up a hash table.  */
 355
 356 /* An element in the hash table.  Most uses will actually use a larger
 357    structure, and an instance of this will be the first field.  */
 358
 359 struct bfd_hash_entry
 360 {
 361   /* Next entry for this hash code.  */
 362   struct bfd_hash_entry *next;
 363   /* String being hashed.  */
 364   const char *string;
 365   /* Hash code.  This is the full hash code, not the index into the
 366      table.  */
 367   unsigned long hash;
 368 };
 369
 370 /* A hash table.  */
 371
 372 struct bfd_hash_table
 373 {
 374   /* The hash array.  */
 375   struct bfd_hash_entry **table;
 376   /* The number of slots in the hash table.  */
 377   unsigned int size;
 378   /* A function used to create new elements in the hash table.  The
 379      first entry is itself a pointer to an element.  When this
 380      function is first invoked, this pointer will be NULL.  However,
 381      having the pointer permits a hierarchy of method functions to be
 382      built each of which calls the function in the superclass.  Thus
 383      each function should be written to allocate a new block of memory
 384      only if the argument is NULL.  */
 385   struct bfd_hash_entry *(*newfunc)
 386     (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 387    /* An objalloc for this hash table.  This is a struct objalloc *,
 388      but we use void * to avoid requiring the inclusion of objalloc.h.  */
 389   void *memory;
 390 };
 391
 392 /* Initialize a hash table.  */
 393 extern bfd_boolean bfd_hash_table_init
 394   (struct bfd_hash_table *,
 395    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 396                                struct bfd_hash_table *,
 397                                const char *));
 398
 399 /* Initialize a hash table specifying a size.  */
 400 extern bfd_boolean bfd_hash_table_init_n
 401   (struct bfd_hash_table *,
 402    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 403                                struct bfd_hash_table *,
 404                                const char *),
 405    unsigned int size);
 406
 407 /* Free up a hash table.  */
 408 extern void bfd_hash_table_free
 409   (struct bfd_hash_table *);
 410
 411 /* Look up a string in a hash table.  If CREATE is TRUE, a new entry
 412    will be created for this string if one does not already exist.  The
 413    COPY argument must be TRUE if this routine should copy the string
 414    into newly allocated memory when adding an entry.  */
 415 extern struct bfd_hash_entry *bfd_hash_lookup
 416   (struct bfd_hash_table *, const char *, bfd_boolean create,
 417    bfd_boolean copy);
 418
 419 /* Replace an entry in a hash table.  */
 420 extern void bfd_hash_replace
 421   (struct bfd_hash_table *, struct bfd_hash_entry *old,
 422    struct bfd_hash_entry *nw);
 423
 424 /* Base method for creating a hash table entry.  */
 425 extern struct bfd_hash_entry *bfd_hash_newfunc
 426   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 427
 428 /* Grab some space for a hash table entry.  */
 429 extern void *bfd_hash_allocate
 430   (struct bfd_hash_table *, unsigned int);
 431
 432 /* Traverse a hash table in a random order, calling a function on each
 433    element.  If the function returns FALSE, the traversal stops.  The
 434    INFO argument is passed to the function.  */
 435 extern void bfd_hash_traverse
 436   (struct bfd_hash_table *,
 437    bfd_boolean (*) (struct bfd_hash_entry *, void *),
 438    void *info);
 439
 440 /* Allows the default size of a hash table to be configured. New hash
 441    tables allocated using bfd_hash_table_init will be created with
 442    this size.  */
 443 extern void bfd_hash_set_default_size (bfd_size_type);
 444
 445 /* This structure is used to keep track of stabs in sections
 446    information while linking.  */
 447
 448 struct stab_info
 449 {
 450   /* A hash table used to hold stabs strings.  */
 451   struct bfd_strtab_hash *strings;
 452   /* The header file hash table.  */
 453   struct bfd_hash_table includes;
 454   /* The first .stabstr section.  */
 455   struct bfd_section *stabstr;
 456 };
 457
 458 #define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table
 459
 460 /* User program access to BFD facilities.  */
 461
 462 /* Direct I/O routines, for programs which know more about the object
 463    file than BFD does.  Use higher level routines if possible.  */
 464
 465 extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);
 466 extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);
 467 extern int bfd_seek (bfd *, file_ptr, int);
 468 extern file_ptr bfd_tell (bfd *);
 469 extern int bfd_flush (bfd *);
 470 extern int bfd_stat (bfd *, struct stat *);
 471
 472 /* Deprecated old routines.  */
 473 #if __GNUC__
 474 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 475   (warn_deprecated ("bfd_read", __FILE__, __LINE__, __FUNCTION__),      \
 476    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 477 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 478   (warn_deprecated ("bfd_write", __FILE__, __LINE__, __FUNCTION__),     \
 479    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 480 #else
 481 #define bfd_read(BUF, ELTSIZE, NITEMS, ABFD)                            \
 482   (warn_deprecated ("bfd_read", (const char *) 0, 0, (const char *) 0), \
 483    bfd_bread ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 484 #define bfd_write(BUF, ELTSIZE, NITEMS, ABFD)                           \
 485   (warn_deprecated ("bfd_write", (const char *) 0, 0, (const char *) 0),\
 486    bfd_bwrite ((BUF), (ELTSIZE) * (NITEMS), (ABFD)))
 487 #endif
 488 extern void warn_deprecated (const char *, const char *, int, const char *);
 489
 490 /* Cast from const char * to char * so that caller can assign to
 491    a char * without a warning.  */
 492 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 493 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 494 #define bfd_get_format(abfd) ((abfd)->format)
 495 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 496 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 497 #define bfd_family_coff(abfd) \
 498   (bfd_get_flavour (abfd) == bfd_target_coff_flavour || \
 499    bfd_get_flavour (abfd) == bfd_target_xcoff_flavour)
 500 #define bfd_big_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_BIG)
 501 #define bfd_little_endian(abfd) ((abfd)->xvec->byteorder == BFD_ENDIAN_LITTLE)
 502 #define bfd_header_big_endian(abfd) \
 503   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_BIG)
 504 #define bfd_header_little_endian(abfd) \
 505   ((abfd)->xvec->header_byteorder == BFD_ENDIAN_LITTLE)
 506 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 507 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 508 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 509 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 510 #define bfd_has_map(abfd) ((abfd)->has_armap)
 511
 512 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 513 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 514
 515 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 516 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 517 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 518 #define bfd_count_sections(abfd) ((abfd)->section_count)
 519
 520 #define bfd_get_dynamic_symcount(abfd) ((abfd)->dynsymcount)
 521
 522 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 523
 524 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = bool), TRUE)
 525
 526 extern bfd_boolean bfd_cache_close
 527   (bfd *abfd);
 528 /* NB: This declaration should match the autogenerated one in libbfd.h.  */
 529
 530 extern bfd_boolean bfd_cache_close_all (void);
 531
 532 extern bfd_boolean bfd_record_phdr
 533   (bfd *, unsigned long, bfd_boolean, flagword, bfd_boolean, bfd_vma,
 534    bfd_boolean, bfd_boolean, unsigned int, struct bfd_section **);
 535
 536 /* Byte swapping routines.  */
 537
 538 bfd_uint64_t bfd_getb64 (const void *);
 539 bfd_uint64_t bfd_getl64 (const void *);
 540 bfd_int64_t bfd_getb_signed_64 (const void *);
 541 bfd_int64_t bfd_getl_signed_64 (const void *);
 542 bfd_vma bfd_getb32 (const void *);
 543 bfd_vma bfd_getl32 (const void *);
 544 bfd_signed_vma bfd_getb_signed_32 (const void *);
 545 bfd_signed_vma bfd_getl_signed_32 (const void *);
 546 bfd_vma bfd_getb16 (const void *);
 547 bfd_vma bfd_getl16 (const void *);
 548 bfd_signed_vma bfd_getb_signed_16 (const void *);
 549 bfd_signed_vma bfd_getl_signed_16 (const void *);
 550 void bfd_putb64 (bfd_uint64_t, void *);
 551 void bfd_putl64 (bfd_uint64_t, void *);
 552 void bfd_putb32 (bfd_vma, void *);
 553 void bfd_putl32 (bfd_vma, void *);
 554 void bfd_putb16 (bfd_vma, void *);
 555 void bfd_putl16 (bfd_vma, void *);
 556
 557 /* Byte swapping routines which take size and endiannes as arguments.  */
 558
 559 bfd_uint64_t bfd_get_bits (const void *, int, bfd_boolean);
 560 void bfd_put_bits (bfd_uint64_t, void *, int, bfd_boolean);
 561
 562 extern bfd_boolean bfd_section_already_linked_table_init (void);
 563 extern void bfd_section_already_linked_table_free (void);
 564 \f
 565 /* Externally visible ECOFF routines.  */
 566
 567 #if defined(__STDC__) || defined(ALMOST_STDC)
 568 struct ecoff_debug_info;
 569 struct ecoff_debug_swap;
 570 struct ecoff_extr;
 571 struct bfd_symbol;
 572 struct bfd_link_info;
 573 struct bfd_link_hash_entry;
 574 struct bfd_elf_version_tree;
 575 #endif
 576 extern bfd_vma bfd_ecoff_get_gp_value
 577   (bfd * abfd);
 578 extern bfd_boolean bfd_ecoff_set_gp_value
 579   (bfd *abfd, bfd_vma gp_value);
 580 extern bfd_boolean bfd_ecoff_set_regmasks
 581   (bfd *abfd, unsigned long gprmask, unsigned long fprmask,
 582    unsigned long *cprmask);
 583 extern void *bfd_ecoff_debug_init
 584   (bfd *output_bfd, struct ecoff_debug_info *output_debug,
 585    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 586 extern void bfd_ecoff_debug_free
 587   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 588    const struct ecoff_debug_swap *output_swap, struct bfd_link_info *);
 589 extern bfd_boolean bfd_ecoff_debug_accumulate
 590   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 591    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 592    struct ecoff_debug_info *input_debug,
 593    const struct ecoff_debug_swap *input_swap, struct bfd_link_info *);
 594 extern bfd_boolean bfd_ecoff_debug_accumulate_other
 595   (void *handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 596    const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 597    struct bfd_link_info *);
 598 extern bfd_boolean bfd_ecoff_debug_externals
 599   (bfd *abfd, struct ecoff_debug_info *debug,
 600    const struct ecoff_debug_swap *swap, bfd_boolean relocatable,
 601    bfd_boolean (*get_extr) (struct bfd_symbol *, struct ecoff_extr *),
 602    void (*set_index) (struct bfd_symbol *, bfd_size_type));
 603 extern bfd_boolean bfd_ecoff_debug_one_external
 604   (bfd *abfd, struct ecoff_debug_info *debug,
 605    const struct ecoff_debug_swap *swap, const char *name,
 606    struct ecoff_extr *esym);
 607 extern bfd_size_type bfd_ecoff_debug_size
 608   (bfd *abfd, struct ecoff_debug_info *debug,
 609    const struct ecoff_debug_swap *swap);
 610 extern bfd_boolean bfd_ecoff_write_debug
 611   (bfd *abfd, struct ecoff_debug_info *debug,
 612    const struct ecoff_debug_swap *swap, file_ptr where);
 613 extern bfd_boolean bfd_ecoff_write_accumulated_debug
 614   (void *handle, bfd *abfd, struct ecoff_debug_info *debug,
 615    const struct ecoff_debug_swap *swap,
 616    struct bfd_link_info *info, file_ptr where);
 617
 618 /* Externally visible ELF routines.  */
 619
 620 struct bfd_link_needed_list
 621 {
 622   struct bfd_link_needed_list *next;
 623   bfd *by;
 624   const char *name;
 625 };
 626
 627 enum dynamic_lib_link_class {
 628   DYN_NORMAL = 0,
 629   DYN_AS_NEEDED = 1,
 630   DYN_DT_NEEDED = 2,
 631   DYN_NO_ADD_NEEDED = 4,
 632   DYN_NO_NEEDED = 8
 633 };
 634
 635 extern bfd_boolean bfd_elf_record_link_assignment
 636   (bfd *, struct bfd_link_info *, const char *, bfd_boolean);
 637 extern struct bfd_link_needed_list *bfd_elf_get_needed_list
 638   (bfd *, struct bfd_link_info *);
 639 extern bfd_boolean bfd_elf_get_bfd_needed_list
 640   (bfd *, struct bfd_link_needed_list **);
 641 extern bfd_boolean bfd_elf_size_dynamic_sections
 642   (bfd *, const char *, const char *, const char *, const char * const *,
 643    struct bfd_link_info *, struct bfd_section **,
 644    struct bfd_elf_version_tree *);
 645 extern bfd_boolean bfd_elf_size_dynsym_hash_dynstr
 646   (bfd *, struct bfd_link_info *);
 647 extern void bfd_elf_set_dt_needed_name
 648   (bfd *, const char *);
 649 extern const char *bfd_elf_get_dt_soname
 650   (bfd *);
 651 extern void bfd_elf_set_dyn_lib_class
 652   (bfd *, int);
 653 extern int bfd_elf_get_dyn_lib_class
 654   (bfd *);
 655 extern struct bfd_link_needed_list *bfd_elf_get_runpath_list
 656   (bfd *, struct bfd_link_info *);
 657 extern bfd_boolean bfd_elf_discard_info
 658   (bfd *, struct bfd_link_info *);
 659
 660 /* Return an upper bound on the number of bytes required to store a
 661    copy of ABFD's program header table entries.  Return -1 if an error
 662    occurs; bfd_get_error will return an appropriate code.  */
 663 extern long bfd_get_elf_phdr_upper_bound
 664   (bfd *abfd);
 665
 666 /* Copy ABFD's program header table entries to *PHDRS.  The entries
 667    will be stored as an array of Elf_Internal_Phdr structures, as
 668    defined in include/elf/internal.h.  To find out how large the
 669    buffer needs to be, call bfd_get_elf_phdr_upper_bound.
 670
 671    Return the number of program header table entries read, or -1 if an
 672    error occurs; bfd_get_error will return an appropriate code.  */
 673 extern int bfd_get_elf_phdrs
 674   (bfd *abfd, void *phdrs);
 675
 676 /* Create a new BFD as if by bfd_openr.  Rather than opening a file,
 677    reconstruct an ELF file by reading the segments out of remote memory
 678    based on the ELF file header at EHDR_VMA and the ELF program headers it
 679    points to.  If not null, *LOADBASEP is filled in with the difference
 680    between the VMAs from which the segments were read, and the VMAs the
 681    file headers (and hence BFD's idea of each section's VMA) put them at.
 682
 683    The function TARGET_READ_MEMORY is called to copy LEN bytes from the
 684    remote memory at target address VMA into the local buffer at MYADDR; it
 685    should return zero on success or an `errno' code on failure.  TEMPL must
 686    be a BFD for an ELF target with the word size and byte order found in
 687    the remote memory.  */
 688 extern bfd *bfd_elf_bfd_from_remote_memory
 689   (bfd *templ, bfd_vma ehdr_vma, bfd_vma *loadbasep,
 690    int (*target_read_memory) (bfd_vma vma, bfd_byte *myaddr, int len));
 691
 692 /* Return the arch_size field of an elf bfd, or -1 if not elf.  */
 693 extern int bfd_get_arch_size
 694   (bfd *);
 695
 696 /* Return TRUE if address "naturally" sign extends, or -1 if not elf.  */
 697 extern int bfd_get_sign_extend_vma
 698   (bfd *);
 699
 700 extern struct bfd_section *_bfd_elf_tls_setup
 701   (bfd *, struct bfd_link_info *);
 702
 703 extern void _bfd_elf_provide_symbol
 704   (struct bfd_link_info *, const char *, bfd_vma, struct bfd_section *);
 705
 706 extern void _bfd_elf_provide_section_bound_symbols
 707   (struct bfd_link_info *, struct bfd_section *sec, const char *, const char *);
 708
 709 extern bfd_boolean bfd_m68k_elf32_create_embedded_relocs
 710   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
 711
 712 /* SunOS shared library support routines for the linker.  */
 713
 714 extern struct bfd_link_needed_list *bfd_sunos_get_needed_list
 715   (bfd *, struct bfd_link_info *);
 716 extern bfd_boolean bfd_sunos_record_link_assignment
 717   (bfd *, struct bfd_link_info *, const char *);
 718 extern bfd_boolean bfd_sunos_size_dynamic_sections
 719   (bfd *, struct bfd_link_info *, struct bfd_section **, struct bfd_section **, struct bfd_section **);
 720
 721 /* Linux shared library support routines for the linker.  */
 722
 723 extern bfd_boolean bfd_i386linux_size_dynamic_sections
 724   (bfd *, struct bfd_link_info *);
 725 extern bfd_boolean bfd_m68klinux_size_dynamic_sections
 726   (bfd *, struct bfd_link_info *);
 727 extern bfd_boolean bfd_sparclinux_size_dynamic_sections
 728   (bfd *, struct bfd_link_info *);
 729
 730 /* mmap hacks */
 731
 732 struct _bfd_window_internal;
 733 typedef struct _bfd_window_internal bfd_window_internal;
 734
 735 typedef struct _bfd_window
 736 {
 737   /* What the user asked for.  */
 738   void *data;
 739   bfd_size_type size;
 740   /* The actual window used by BFD.  Small user-requested read-only
 741      regions sharing a page may share a single window into the object
 742      file.  Read-write versions shouldn't until I've fixed things to
 743      keep track of which portions have been claimed by the
 744      application; don't want to give the same region back when the
 745      application wants two writable copies!  */
 746   struct _bfd_window_internal *i;
 747 }
 748 bfd_window;
 749
 750 extern void bfd_init_window
 751   (bfd_window *);
 752 extern void bfd_free_window
 753   (bfd_window *);
 754 extern bfd_boolean bfd_get_file_window
 755   (bfd *, file_ptr, bfd_size_type, bfd_window *, bfd_boolean);
 756
 757 /* XCOFF support routines for the linker.  */
 758
 759 extern bfd_boolean bfd_xcoff_link_record_set
 760   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_size_type);
 761 extern bfd_boolean bfd_xcoff_import_symbol
 762   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *, bfd_vma,
 763    const char *, const char *, const char *, unsigned int);
 764 extern bfd_boolean bfd_xcoff_export_symbol
 765   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
 766 extern bfd_boolean bfd_xcoff_link_count_reloc
 767   (bfd *, struct bfd_link_info *, const char *);
 768 extern bfd_boolean bfd_xcoff_record_link_assignment
 769   (bfd *, struct bfd_link_info *, const char *);
 770 extern bfd_boolean bfd_xcoff_size_dynamic_sections
 771   (bfd *, struct bfd_link_info *, const char *, const char *,
 772    unsigned long, unsigned long, unsigned long, bfd_boolean,
 773    int, bfd_boolean, bfd_boolean, struct bfd_section **, bfd_boolean);
 774 extern bfd_boolean bfd_xcoff_link_generate_rtinit
 775   (bfd *, const char *, const char *, bfd_boolean);
 776
 777 /* XCOFF support routines for ar.  */
 778 extern bfd_boolean bfd_xcoff_ar_archive_set_magic
 779   (bfd *, char *);
 780
 781 /* Externally visible COFF routines.  */
 782
 783 #if defined(__STDC__) || defined(ALMOST_STDC)
 784 struct internal_syment;
 785 union internal_auxent;
 786 #endif
 787
 788 extern bfd_boolean bfd_coff_get_syment
 789   (bfd *, struct bfd_symbol *, struct internal_syment *);
 790
 791 extern bfd_boolean bfd_coff_get_auxent
 792   (bfd *, struct bfd_symbol *, int, union internal_auxent *);
 793
 794 extern bfd_boolean bfd_coff_set_symbol_class
 795   (bfd *, struct bfd_symbol *, unsigned int);
 796
 797 extern bfd_boolean bfd_m68k_coff_create_embedded_relocs
 798   (bfd *, struct bfd_link_info *, struct bfd_section *, struct bfd_section *, char **);
 799
 800 /* ARM Interworking support.  Called from linker.  */
 801 extern bfd_boolean bfd_arm_allocate_interworking_sections
 802   (struct bfd_link_info *);
 803
 804 extern bfd_boolean bfd_arm_process_before_allocation
 805   (bfd *, struct bfd_link_info *, int);
 806
 807 extern bfd_boolean bfd_arm_get_bfd_for_interworking
 808   (bfd *, struct bfd_link_info *);
 809
 810 /* PE ARM Interworking support.  Called from linker.  */
 811 extern bfd_boolean bfd_arm_pe_allocate_interworking_sections
 812   (struct bfd_link_info *);
 813
 814 extern bfd_boolean bfd_arm_pe_process_before_allocation
 815   (bfd *, struct bfd_link_info *, int);
 816
 817 extern bfd_boolean bfd_arm_pe_get_bfd_for_interworking
 818   (bfd *, struct bfd_link_info *);
 819
 820 /* ELF ARM Interworking support.  Called from linker.  */
 821 extern bfd_boolean bfd_elf32_arm_allocate_interworking_sections
 822   (struct bfd_link_info *);
 823
 824 extern bfd_boolean bfd_elf32_arm_process_before_allocation
 825   (bfd *, struct bfd_link_info *, int);
 826
 827 void bfd_elf32_arm_set_target_relocs
 828   (struct bfd_link_info *, int, char *, int, int);
 829
 830 extern bfd_boolean bfd_elf32_arm_get_bfd_for_interworking
 831   (bfd *, struct bfd_link_info *);
 832
 833 extern bfd_boolean bfd_elf32_arm_add_glue_sections_to_bfd
 834   (bfd *, struct bfd_link_info *);
 835
 836 /* ELF ARM mapping symbol support */
 837 extern bfd_boolean bfd_is_arm_mapping_symbol_name
 838   (const char * name);
 839
 840 /* ARM Note section processing.  */
 841 extern bfd_boolean bfd_arm_merge_machines
 842   (bfd *, bfd *);
 843
 844 extern bfd_boolean bfd_arm_update_notes
 845   (bfd *, const char *);
 846
 847 extern unsigned int bfd_arm_get_mach_from_notes
 848   (bfd *, const char *);
 849
 850 /* TI COFF load page support.  */
 851 extern void bfd_ticoff_set_section_load_page
 852   (struct bfd_section *, int);
 853
 854 extern int bfd_ticoff_get_section_load_page
 855   (struct bfd_section *);
 856
 857 /* H8/300 functions.  */
 858 extern bfd_vma bfd_h8300_pad_address
 859   (bfd *, bfd_vma);
 860
 861 /* IA64 Itanium code generation.  Called from linker.  */
 862 extern void bfd_elf32_ia64_after_parse
 863   (int);
 864
 865 extern void bfd_elf64_ia64_after_parse
 866   (int);
 867
 868 /* This structure is used for a comdat section, as in PE.  A comdat
 869    section is associated with a particular symbol.  When the linker
 870    sees a comdat section, it keeps only one of the sections with a
 871    given name and associated with a given symbol.  */
 872
 873 struct coff_comdat_info
 874 {
 875   /* The name of the symbol associated with a comdat section.  */
 876   const char *name;
 877
 878   /* The local symbol table index of the symbol associated with a
 879      comdat section.  This is only meaningful to the object file format
 880      specific code; it is not an index into the list returned by
 881      bfd_canonicalize_symtab.  */
 882   long symbol;
 883 };
 884
 885 extern struct coff_comdat_info *bfd_coff_get_comdat_section
 886   (bfd *, struct bfd_section *);
 887