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