bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 ** NOTE: bfd.h and bfd-in2.h are GENERATED files.  Don't change them;
   6 ** instead, change bfd-in.h or the other BFD source files processed to
   7 ** generate these files.
   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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  24
  25 /* bfd.h -- The only header file required by users of the bfd library
  26
  27 The bfd.h file is generated from bfd-in.h and various .c files; if you
  28 change it, your changes will probably be lost.
  29
  30 All the prototypes and definitions following the comment "THE FOLLOWING
  31 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  32 BFD.  If you change it, someone oneday will extract it from the source
  33 again, and your changes will be lost.  To save yourself from this bind,
  34 change the definitions in the source in the bfd directory.  Type "make
  35 docs" and then "make headers" in that directory, and magically this file
  36 will change to reflect your changes.
  37
  38 If you don't have the tools to perform the extraction, then you are
  39 safe from someone on your system trampling over your header files.
  40 You should still maintain the equivalence between the source and this
  41 file though; every change you make to the .c file should be reflected
  42 here.  */
  43
  44 #ifndef __BFD_H_SEEN__
  45 #define __BFD_H_SEEN__
  46
  47 #include "ansidecl.h"
  48 #include "obstack.h"
  49
  50 /* These two lines get substitutions done by commands in Makefile.in.  */
  51 #define BFD_VERSION   "@VERSION@"
  52 #define BFD_ARCH_SIZE @WORDSIZE@
  53
  54 #if BFD_ARCH_SIZE >= 64
  55 #define BFD64
  56 #endif
  57
  58 #ifndef INLINE
  59 #if __GNUC__ >= 2
  60 #define INLINE __inline__
  61 #else
  62 #define INLINE
  63 #endif
  64 #endif
  65
  66 /* 64-bit type definition (if any) from bfd's sysdep.h goes here */
  67
  68
  69 /* forward declaration */
  70 typedef struct _bfd bfd;
  71
  72 /* To squelch erroneous compiler warnings ("illegal pointer
  73    combination") from the SVR3 compiler, we would like to typedef
  74    boolean to int (it doesn't like functions which return boolean.
  75    Making sure they are never implicitly declared to return int
  76    doesn't seem to help).  But this file is not configured based on
  77    the host.  */
  78 /* General rules: functions which are boolean return true on success
  79    and false on failure (unless they're a predicate).   -- bfd.doc */
  80 /* I'm sure this is going to break something and someone is going to
  81    force me to change it. */
  82 /* typedef enum boolean {false, true} boolean; */
  83 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  84 /* It gets worse if the host also defines a true/false enum... -sts */
  85 #ifndef TRUE_FALSE_ALREADY_DEFINED
  86 typedef enum bfd_boolean {false, true} boolean;
  87 #define BFD_TRUE_FALSE
  88 #else
  89 typedef enum bfd_boolean {bfd_false, bfd_true} boolean;
  90 #endif
  91
  92 /* A pointer to a position in a file.  */
  93 /* FIXME:  This should be using off_t from <sys/types.h>.
  94    For now, try to avoid breaking stuff by not including <sys/types.h> here.
  95    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
  96    Probably the best long-term answer is to avoid using file_ptr AND off_t
  97    in this header file, and to handle this in the BFD implementation
  98    rather than in its interface.  */
  99 /* typedef off_t        file_ptr; */
 100 typedef long int file_ptr;
 101
 102 /* Support for different sizes of target format ints and addresses.  If the
 103    host implements 64-bit values, it defines BFD_HOST_64_BIT to be the appropriate
 104    type.  Otherwise, this code will fall back on gcc's "long long" type if gcc
 105    is being used.  BFD_HOST_64_BIT must be defined in such a way as to be a valid
 106    type name by itself or with "unsigned" prefixed.  It should be a signed
 107    type by itself.
 108
 109    If neither is the case, then compilation will fail if 64-bit targets are
 110    requested.  If you don't request any 64-bit targets, you should be safe. */
 111
 112 #ifdef  BFD64
 113
 114 #if defined (__GNUC__) && !defined (BFD_HOST_64_BIT)
 115 #define BFD_HOST_64_BIT long long
 116 typedef BFD_HOST_64_BIT int64_type;
 117 typedef unsigned BFD_HOST_64_BIT uint64_type;
 118 #endif
 119
 120 #if !defined (uint64_type) && defined (__GNUC__)
 121 #define uint64_type unsigned long long
 122 #define int64_type long long
 123 #endif
 124 #ifndef uint64_typeLOW
 125 #define uint64_typeLOW(x) ((unsigned long)(((x) & 0xffffffff)))
 126 #define uint64_typeHIGH(x) ((unsigned long)(((x) >> 32) & 0xffffffff))
 127 #endif
 128
 129 typedef unsigned BFD_HOST_64_BIT bfd_vma;
 130 typedef BFD_HOST_64_BIT bfd_signed_vma;
 131 typedef unsigned BFD_HOST_64_BIT bfd_size_type;
 132 typedef unsigned BFD_HOST_64_BIT symvalue;
 133 #ifndef fprintf_vma
 134 #define fprintf_vma(s,x) \
 135                 fprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
 136 #define sprintf_vma(s,x) \
 137                 sprintf(s,"%08lx%08lx", uint64_typeHIGH(x), uint64_typeLOW(x))
 138 #endif
 139 #else /* not BFD64  */
 140
 141 /* Represent a target address.  Also used as a generic unsigned type
 142    which is guaranteed to be big enough to hold any arithmetic types
 143    we need to deal with.  */
 144 typedef unsigned long bfd_vma;
 145
 146 /* A generic signed type which is guaranteed to be big enough to hold any
 147    arithmetic types we need to deal with.  Can be assumed to be compatible
 148    with bfd_vma in the same way that signed and unsigned ints are compatible
 149    (as parameters, in assignment, etc).  */
 150 typedef long bfd_signed_vma;
 151
 152 typedef unsigned long symvalue;
 153 typedef unsigned long bfd_size_type;
 154
 155 /* Print a bfd_vma x on stream s.  */
 156 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 157 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
 158 #endif /* not BFD64  */
 159 #define printf_vma(x) fprintf_vma(stdout,x)
 160
 161 typedef unsigned int flagword;  /* 32 bits of flags */
 162 \f
 163 /** File formats */
 164
 165 typedef enum bfd_format {
 166               bfd_unknown = 0,  /* file format is unknown */
 167               bfd_object,       /* linker/assember/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          bfd_format;
 172
 173 /* Values that may appear in the flags field of a BFD.  These also
 174    appear in the object_flags field of the bfd_target structure, where
 175    they indicate the set of flags used by that backend (not all flags
 176    are meaningful for all object file formats) (FIXME: at the moment,
 177    the object_flags values have mostly just been copied from backend
 178    to another, and are not necessarily correct).  */
 179
 180 /* No flags.  */
 181 #define NO_FLAGS        0x00
 182
 183 /* BFD contains relocation entries.  */
 184 #define HAS_RELOC       0x01
 185
 186 /* BFD is directly executable.  */
 187 #define EXEC_P          0x02
 188
 189 /* BFD has line number information (basically used for F_LNNO in a
 190    COFF header).  */
 191 #define HAS_LINENO      0x04
 192
 193 /* BFD has debugging information.  */
 194 #define HAS_DEBUG       0x08
 195
 196 /* BFD has symbols.  */
 197 #define HAS_SYMS        0x10
 198
 199 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 200    header).  */
 201 #define HAS_LOCALS      0x20
 202
 203 /* BFD is a dynamic object.  */
 204 #define DYNAMIC         0x40
 205
 206 /* Text section is write protected (if D_PAGED is not set, this is
 207    like an a.out NMAGIC file) (the linker sets this by default, but
 208    clears it for -r or -N).  */
 209 #define WP_TEXT         0x80
 210
 211 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 212    linker sets this by default, but clears it for -r or -n or -N).  */
 213 #define D_PAGED         0x100
 214
 215 /* BFD is relaxable (this means that bfd_relax_section may be able to
 216    do something).  */
 217 #define BFD_IS_RELAXABLE 0x200
 218 \f
 219 /* symbols and relocation */
 220
 221 /* A count of carsyms (canonical archive symbols).  */
 222 typedef unsigned long symindex;
 223
 224 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 225
 226 /* General purpose part of a symbol X;
 227    target specific parts are in libcoff.h, libaout.h, etc.  */
 228
 229 #define bfd_get_section(x) ((x)->section)
 230 #define bfd_get_output_section(x) ((x)->section->output_section)
 231 #define bfd_set_section(x,y) ((x)->section) = (y)
 232 #define bfd_asymbol_base(x) ((x)->section->vma)
 233 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 234 #define bfd_asymbol_name(x) ((x)->name)
 235 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 236 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 237 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 238
 239 /* A canonical archive symbol.  */
 240 /* This is a type pun with struct ranlib on purpose! */
 241 typedef struct carsym {
 242   char *name;
 243   file_ptr file_offset;         /* look here to find the file */
 244 } carsym;                       /* to make these you call a carsymogen */
 245
 246
 247 /* Used in generating armaps (archive tables of contents).
 248    Perhaps just a forward definition would do? */
 249 struct orl {                    /* output ranlib */
 250   char **name;                  /* symbol name */
 251   file_ptr pos;                 /* bfd* or file position */
 252   int namidx;                   /* index into string table */
 253 };
 254
 255 \f
 256
 257 /* Linenumber stuff */
 258 typedef struct lineno_cache_entry {
 259   unsigned int line_number;     /* Linenumber from start of function*/
 260   union {
 261     struct symbol_cache_entry *sym; /* Function name */
 262     unsigned long offset;       /* Offset into section */
 263   } u;
 264 } alent;
 265 \f
 266 /* object and core file sections */
 267
 268
 269 #define align_power(addr, align)        \
 270         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 271
 272 typedef struct sec *sec_ptr;
 273
 274 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 275 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 276 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 277 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 278 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 279 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 280 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 281 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 282 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 283
 284 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 285
 286 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 287 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 288 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 289
 290 typedef struct stat stat_type;
 291 \f
 292 typedef enum bfd_print_symbol
 293 {
 294   bfd_print_symbol_name,
 295   bfd_print_symbol_more,
 296   bfd_print_symbol_all
 297 } bfd_print_symbol_type;
 298
 299 /* Information about a symbol that nm needs.  */
 300
 301 typedef struct _symbol_info
 302 {
 303   symvalue value;
 304   char type;
 305   CONST char *name;            /* Symbol name.  */
 306   char stab_other;             /* Unused. */
 307   short stab_desc;             /* Info for N_TYPE.  */
 308   CONST char *stab_name;
 309 } symbol_info;
 310 \f
 311 /* Hash table routines.  There is no way to free up a hash table.  */
 312
 313 /* An element in the hash table.  Most uses will actually use a larger
 314    structure, and an instance of this will be the first field.  */
 315
 316 struct bfd_hash_entry
 317 {
 318   /* Next entry for this hash code.  */
 319   struct bfd_hash_entry *next;
 320   /* String being hashed.  */
 321   const char *string;
 322   /* Hash code.  This is the full hash code, not the index into the
 323      table.  */
 324   unsigned long hash;
 325 };
 326
 327 /* A hash table.  */
 328
 329 struct bfd_hash_table
 330 {
 331   /* The hash array.  */
 332   struct bfd_hash_entry **table;
 333   /* The number of slots in the hash table.  */
 334   unsigned int size;
 335   /* A function used to create new elements in the hash table.  The
 336      first entry is itself a pointer to an element.  When this
 337      function is first invoked, this pointer will be NULL.  However,
 338      having the pointer permits a hierarchy of method functions to be
 339      built each of which calls the function in the superclass.  Thus
 340      each function should be written to allocate a new block of memory
 341      only if the argument is NULL.  */
 342   struct bfd_hash_entry *(*newfunc) PARAMS ((struct bfd_hash_entry *,
 343                                              struct bfd_hash_table *,
 344                                              const char *));
 345   /* An obstack for this hash table.  */
 346   struct obstack memory;
 347 };
 348
 349 /* Initialize a hash table.  */
 350 extern boolean bfd_hash_table_init
 351   PARAMS ((struct bfd_hash_table *,
 352            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 353                                        struct bfd_hash_table *,
 354                                        const char *)));
 355
 356 /* Initialize a hash table specifying a size.  */
 357 extern boolean bfd_hash_table_init_n
 358   PARAMS ((struct bfd_hash_table *,
 359            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 360                                        struct bfd_hash_table *,
 361                                        const char *),
 362            unsigned int size));
 363
 364 /* Free up a hash table.  */
 365 extern void bfd_hash_table_free PARAMS ((struct bfd_hash_table *));
 366
 367 /* Look up a string in a hash table.  If CREATE is true, a new entry
 368    will be created for this string if one does not already exist.  The
 369    COPY argument must be true if this routine should copy the string
 370    into newly allocated memory when adding an entry.  */
 371 extern struct bfd_hash_entry *bfd_hash_lookup
 372   PARAMS ((struct bfd_hash_table *, const char *, boolean create,
 373            boolean copy));
 374
 375 /* Base method for creating a hash table entry.  */
 376 extern struct bfd_hash_entry *bfd_hash_newfunc
 377   PARAMS ((struct bfd_hash_entry *, struct bfd_hash_table *,
 378            const char *));
 379
 380 /* Grab some space for a hash table entry.  */
 381 extern PTR bfd_hash_allocate PARAMS ((struct bfd_hash_table *,
 382                                       unsigned int));
 383
 384 /* Traverse a hash table in a random order, calling a function on each
 385    element.  If the function returns false, the traversal stops.  The
 386    INFO argument is passed to the function.  */
 387 extern void bfd_hash_traverse PARAMS ((struct bfd_hash_table *,
 388                                        boolean (*) (struct bfd_hash_entry *,
 389                                                     PTR),
 390                                        PTR info));
 391 \f
 392 /* Semi-portable string concatenation in cpp.
 393    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
 394    The problem is, "32_" is not a valid preprocessing token, and we don't
 395    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
 396    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
 397    Then the final concatenation can be done.  (Sigh.)  */
 398 #ifndef CAT
 399 #ifdef SABER
 400 #define CAT(a,b)        a##b
 401 #define CAT3(a,b,c)     a##b##c
 402 #define CAT4(a,b,c,d)   a##b##c##d
 403 #else
 404 #if defined(__STDC__) || defined(ALMOST_STDC)
 405 #define CAT(a,b) a##b
 406 #define CAT3(a,b,c) a##b##c
 407 #define XCAT2(a,b)      CAT(a,b)
 408 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
 409 #else
 410 #define CAT(a,b) a/**/b
 411 #define CAT3(a,b,c) a/**/b/**/c
 412 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
 413 #endif
 414 #endif
 415 #endif
 416
 417 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 418 \f
 419 /* User program access to BFD facilities */
 420
 421 /* Cast from const char * to char * so that caller can assign to
 422    a char * without a warning.  */
 423 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 424 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 425 #define bfd_get_format(abfd) ((abfd)->format)
 426 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 427 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 428 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 429 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 430 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 431 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 432 #define bfd_has_map(abfd) ((abfd)->has_armap)
 433
 434 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 435 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 436
 437 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 438 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 439 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 440 #define bfd_count_sections(abfd) ((abfd)->section_count)
 441
 442 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 443
 444 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (bool)), true)
 445
 446 /* Byte swapping routines.  */
 447
 448 bfd_vma         bfd_getb64         PARAMS ((const unsigned char *));
 449 bfd_vma         bfd_getl64         PARAMS ((const unsigned char *));
 450 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((const unsigned char *));
 451 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((const unsigned char *));
 452 bfd_vma         bfd_getb32         PARAMS ((const unsigned char *));
 453 bfd_vma         bfd_getl32         PARAMS ((const unsigned char *));
 454 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((const unsigned char *));
 455 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((const unsigned char *));
 456 bfd_vma         bfd_getb16         PARAMS ((const unsigned char *));
 457 bfd_vma         bfd_getl16         PARAMS ((const unsigned char *));
 458 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((const unsigned char *));
 459 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((const unsigned char *));
 460 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 461 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 462 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 463 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 464 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 465 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 466
 467 /* ECOFF linking routines.  */
 468 #if defined(__STDC__) || defined(ALMOST_STDC)
 469 struct ecoff_debug_info;
 470 struct ecoff_debug_swap;
 471 struct ecoff_extr;
 472 struct symbol_cache_entry;
 473 struct bfd_link_info;
 474 #endif
 475 extern PTR bfd_ecoff_debug_init
 476   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 477            const struct ecoff_debug_swap *output_swap,
 478            struct bfd_link_info *));
 479 extern void bfd_ecoff_debug_free
 480   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 481            const struct ecoff_debug_swap *output_swap,
 482            struct bfd_link_info *));
 483 extern boolean bfd_ecoff_debug_accumulate
 484   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 485            const struct ecoff_debug_swap *output_swap,
 486            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 487            const struct ecoff_debug_swap *input_swap,
 488            struct bfd_link_info *));
 489 extern boolean bfd_ecoff_debug_accumulate_other
 490   PARAMS ((PTR handle, bfd *output_bfd, struct ecoff_debug_info *output_debug,
 491            const struct ecoff_debug_swap *output_swap, bfd *input_bfd,
 492            struct bfd_link_info *));
 493 extern boolean bfd_ecoff_debug_externals
 494   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 495            const struct ecoff_debug_swap *swap,
 496            boolean relocateable,
 497            boolean (*get_extr) (struct symbol_cache_entry *,
 498                                 struct ecoff_extr *),
 499            void (*set_index) (struct symbol_cache_entry *,
 500                               bfd_size_type)));
 501 extern boolean bfd_ecoff_debug_one_external
 502   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 503            const struct ecoff_debug_swap *swap,
 504            const char *name, struct ecoff_extr *esym));
 505 extern bfd_size_type bfd_ecoff_debug_size
 506   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 507            const struct ecoff_debug_swap *swap));
 508 extern boolean bfd_ecoff_write_debug
 509   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 510            const struct ecoff_debug_swap *swap, file_ptr where));
 511 extern boolean bfd_ecoff_write_accumulated_debug
 512   PARAMS ((PTR handle, bfd *abfd, struct ecoff_debug_info *debug,
 513            const struct ecoff_debug_swap *swap,
 514            struct bfd_link_info *info, file_ptr where));
 515
 516 /* And more from the source.  */