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