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 #define BFD_VERSION "2.2"
  51
  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 typedef enum bfd_boolean {false, true} boolean;
  85
  86 /* A pointer to a position in a file.  */
  87 /* FIXME:  This should be using off_t from <sys/types.h>.
  88    For now, try to avoid breaking stuff by not including <sys/types.h> here.
  89    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
  90    Probably the best long-term answer is to avoid using file_ptr AND off_t
  91    in this header file, and to handle this in the BFD implementation
  92    rather than in its interface.  */
  93 /* typedef off_t        file_ptr; */
  94 typedef long int file_ptr;
  95
  96 /* Support for different sizes of target format ints and addresses.  If the
  97    host implements 64-bit values, it defines HOST_64_BIT to be the appropriate
  98    type.  Otherwise, this code will fall back on gcc's "long long" type if gcc
  99    is being used.  HOST_64_BIT must be defined in such a way as to be a valid
 100    type name by itself or with "unsigned" prefixed.  It should be a signed
 101    type by itself.
 102
 103    If neither is the case, then compilation will fail if 64-bit targets are
 104    requested.  If you don't request any 64-bit targets, you should be safe. */
 105
 106 #ifdef  BFD64
 107
 108 #if defined (__GNUC__) && !defined (HOST_64_BIT)
 109 #define HOST_64_BIT long long
 110 typedef HOST_64_BIT int64_type;
 111 typedef unsigned HOST_64_BIT uint64_type;
 112 #endif
 113
 114 #if !defined (uint64_type) && defined (__GNUC__)
 115 #define uint64_type unsigned long long
 116 #define int64_type long long
 117 #define uint64_typeLOW(x) (unsigned long)(((x) & 0xffffffff))
 118 #define uint64_typeHIGH(x) (unsigned long)(((x) >> 32) & 0xffffffff)
 119 #endif
 120
 121 typedef unsigned HOST_64_BIT bfd_vma;
 122 typedef HOST_64_BIT bfd_signed_vma;
 123 typedef unsigned HOST_64_BIT bfd_size_type;
 124 typedef unsigned HOST_64_BIT symvalue;
 125 #define fprintf_vma(s,x) \
 126                 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
 127 #define sprintf_vma(s,x) \
 128                 sprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
 129 #else /* not BFD64  */
 130
 131 /* Represent a target address.  Also used as a generic unsigned type
 132    which is guaranteed to be big enough to hold any arithmetic types
 133    we need to deal with.  */
 134 typedef unsigned long bfd_vma;
 135
 136 /* A generic signed type which is guaranteed to be big enough to hold any
 137    arithmetic types we need to deal with.  Can be assumed to be compatible
 138    with bfd_vma in the same way that signed and unsigned ints are compatible
 139    (as parameters, in assignment, etc).  */
 140 typedef long bfd_signed_vma;
 141
 142 typedef unsigned long symvalue;
 143 typedef unsigned long bfd_size_type;
 144
 145 /* Print a bfd_vma x on stream s.  */
 146 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 147 #define sprintf_vma(s,x) sprintf(s, "%08lx", x)
 148 #endif /* not BFD64  */
 149 #define printf_vma(x) fprintf_vma(stdout,x)
 150
 151 typedef unsigned int flagword;  /* 32 bits of flags */
 152 \f
 153 /** File formats */
 154
 155 typedef enum bfd_format {
 156               bfd_unknown = 0,  /* file format is unknown */
 157               bfd_object,       /* linker/assember/compiler output */
 158               bfd_archive,      /* object archive file */
 159               bfd_core,         /* core dump */
 160               bfd_type_end}     /* marks the end; don't use it! */
 161          bfd_format;
 162
 163 /* Values that may appear in the flags field of a BFD.  These also
 164    appear in the object_flags field of the bfd_target structure, where
 165    they indicate the set of flags used by that backend (not all flags
 166    are meaningful for all object file formats) (FIXME: at the moment,
 167    the object_flags values have mostly just been copied from backend
 168    to another, and are not necessarily correct).  */
 169
 170 /* No flags.  */
 171 #define NO_FLAGS        0x00
 172
 173 /* BFD contains relocation entries.  */
 174 #define HAS_RELOC       0x01
 175
 176 /* BFD is directly executable.  */
 177 #define EXEC_P          0x02
 178
 179 /* BFD has line number information (basically used for F_LNNO in a
 180    COFF header).  */
 181 #define HAS_LINENO      0x04
 182
 183 /* BFD has debugging information.  */
 184 #define HAS_DEBUG       0x08
 185
 186 /* BFD has symbols.  */
 187 #define HAS_SYMS        0x10
 188
 189 /* BFD has local symbols (basically used for F_LSYMS in a COFF
 190    header).  */
 191 #define HAS_LOCALS      0x20
 192
 193 /* BFD is a dynamic object.  */
 194 #define DYNAMIC         0x40
 195
 196 /* Text section is write protected (if D_PAGED is not set, this is
 197    like an a.out NMAGIC file) (the linker sets this by default, but
 198    clears it for -r or -N).  */
 199 #define WP_TEXT         0x80
 200
 201 /* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
 202    linker sets this by default, but clears it for -r or -n or -N).  */
 203 #define D_PAGED         0x100
 204
 205 /* BFD is relaxable (this means that bfd_relax_section may be able to
 206    do something).  */
 207 #define BFD_IS_RELAXABLE 0x200
 208 \f
 209 /* symbols and relocation */
 210
 211 typedef unsigned long symindex;
 212
 213 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 214
 215 typedef enum bfd_symclass {
 216               bfd_symclass_unknown = 0,
 217               bfd_symclass_fcommon, /* fortran common symbols */
 218               bfd_symclass_global, /* global symbol, what a surprise */
 219               bfd_symclass_debugger, /* some debugger symbol */
 220               bfd_symclass_undefined /* none known */
 221             } symclass;
 222
 223
 224 /* general purpose part of a symbol;
 225    target specific parts will be found in libcoff.h, liba.out.h etc */
 226
 227
 228 #define bfd_get_section(x) ((x)->section)
 229 #define bfd_get_output_section(x) ((x)->section->output_section)
 230 #define bfd_set_section(x,y) ((x)->section) = (y)
 231 #define bfd_asymbol_base(x) ((x)->section->vma)
 232 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 233 #define bfd_asymbol_name(x) ((x)->name)
 234 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 235 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 236 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 237
 238 /* This is a type pun with struct ranlib on purpose! */
 239 typedef struct carsym {
 240   char *name;
 241   file_ptr file_offset;         /* look here to find the file */
 242 } carsym;                       /* to make these you call a carsymogen */
 243
 244
 245 /* Used in generating armaps.  Perhaps just a forward definition would do? */
 246 struct orl {                    /* output ranlib */
 247   char **name;                  /* symbol name */
 248   file_ptr pos;                 /* bfd* or file position */
 249   int namidx;                   /* index into string table */
 250 };
 251
 252 \f
 253
 254 /* Linenumber stuff */
 255 typedef struct lineno_cache_entry {
 256   unsigned int line_number;     /* Linenumber from start of function*/
 257   union {
 258  struct symbol_cache_entry *sym;                /* Function name */
 259     unsigned long offset;       /* Offset into section */
 260   } u;
 261 } alent;
 262 \f
 263 /* object and core file sections */
 264
 265
 266 #define align_power(addr, align)        \
 267         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 268
 269 typedef struct sec *sec_ptr;
 270
 271 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 272 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 273 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 274 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 275 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 276 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 277 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 278 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 279 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 280
 281 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 282
 283 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 284 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 285 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 286
 287 typedef struct stat stat_type;
 288 \f
 289 /** Error handling */
 290
 291 typedef enum bfd_error {
 292               no_error = 0, system_call_error, invalid_target,
 293               wrong_format, invalid_operation, no_memory,
 294               no_symbols, no_relocation_info,
 295               no_more_archived_files, malformed_archive,
 296               symbol_not_found, file_not_recognized,
 297               file_ambiguously_recognized, no_contents,
 298               bfd_error_nonrepresentable_section,
 299               no_debug_section, bad_value,
 300
 301               /* An input file is shorter than expected.  */
 302               file_truncated,
 303
 304               invalid_error_code} bfd_ec;
 305
 306 extern bfd_ec bfd_error;
 307 struct reloc_cache_entry;
 308 struct bfd_seclet;
 309
 310
 311 typedef struct bfd_error_vector {
 312   void (* nonrepresentable_section ) PARAMS ((CONST bfd  *CONST abfd,
 313                                               CONST char *CONST name));
 314   void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
 315                                      CONST struct bfd_seclet *sec));
 316   void (* reloc_value_truncated) PARAMS ((CONST struct
 317                                           reloc_cache_entry *rel,
 318                                           struct bfd_seclet *sec));
 319
 320   void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
 321                                     CONST struct bfd_seclet *sec));
 322
 323 } bfd_error_vector_type;
 324
 325 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
 326 void bfd_perror PARAMS ((CONST char *message));
 327 \f
 328
 329 typedef enum bfd_print_symbol
 330 {
 331   bfd_print_symbol_name,
 332   bfd_print_symbol_more,
 333   bfd_print_symbol_all
 334 } bfd_print_symbol_type;
 335
 336 \f
 337 /* Information about a symbol that nm needs.  */
 338
 339 typedef struct _symbol_info
 340 {
 341   symvalue value;
 342   char type;                   /*  */
 343   CONST char *name;            /* Symbol name.  */
 344   char stab_other;             /* Unused. */
 345   short stab_desc;             /* Info for N_TYPE.  */
 346   CONST char *stab_name;
 347 } symbol_info;
 348 \f
 349 /* The code that implements targets can initialize a jump table with this
 350    macro.  It must name all its routines the same way (a prefix plus
 351    the standard routine suffix), or it must #define the routines that
 352    are not so named, before calling JUMP_TABLE in the initializer.  */
 353
 354 /* Semi-portable string concatenation in cpp.
 355    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
 356    The problem is, "32_" is not a valid preprocessing token, and we don't
 357    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
 358    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
 359    Then the final concatenation can be done.  (Sigh.)  */
 360 #ifndef CAT
 361 #ifdef SABER
 362 #define CAT(a,b)        a##b
 363 #define CAT3(a,b,c)     a##b##c
 364 #define CAT4(a,b,c,d)   a##b##c##d
 365 #else
 366 #ifdef __STDC__
 367 #define CAT(a,b) a##b
 368 #define CAT3(a,b,c) a##b##c
 369 #define XCAT2(a,b)      CAT(a,b)
 370 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
 371 #else
 372 #define CAT(a,b) a/**/b
 373 #define CAT3(a,b,c) a/**/b/**/c
 374 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
 375 #endif
 376 #endif
 377 #endif
 378
 379 #define JUMP_TABLE(NAME)\
 380 CAT(NAME,_core_file_failing_command),\
 381 CAT(NAME,_core_file_failing_signal),\
 382 CAT(NAME,_core_file_matches_executable_p),\
 383 CAT(NAME,_slurp_armap),\
 384 CAT(NAME,_slurp_extended_name_table),\
 385 CAT(NAME,_truncate_arname),\
 386 CAT(NAME,_write_armap),\
 387 CAT(NAME,_close_and_cleanup),\
 388 CAT(NAME,_set_section_contents),\
 389 CAT(NAME,_get_section_contents),\
 390 CAT(NAME,_new_section_hook),\
 391 CAT(NAME,_get_symtab_upper_bound),\
 392 CAT(NAME,_get_symtab),\
 393 CAT(NAME,_get_reloc_upper_bound),\
 394 CAT(NAME,_canonicalize_reloc),\
 395 CAT(NAME,_make_empty_symbol),\
 396 CAT(NAME,_print_symbol),\
 397 CAT(NAME,_get_symbol_info),\
 398 CAT(NAME,_get_lineno),\
 399 CAT(NAME,_set_arch_mach),\
 400 CAT(NAME,_openr_next_archived_file),\
 401 CAT(NAME,_find_nearest_line),\
 402 CAT(NAME,_generic_stat_arch_elt),\
 403 CAT(NAME,_sizeof_headers),\
 404 CAT(NAME,_bfd_debug_info_start),\
 405 CAT(NAME,_bfd_debug_info_end),\
 406 CAT(NAME,_bfd_debug_info_accumulate),\
 407 CAT(NAME,_bfd_get_relocated_section_contents),\
 408 CAT(NAME,_bfd_relax_section),\
 409 CAT(NAME,_bfd_seclet_link),\
 410 CAT(NAME,_bfd_reloc_type_lookup),\
 411 CAT(NAME,_bfd_make_debug_symbol)
 412
 413 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 414
 415 \f
 416 /* User program access to BFD facilities */
 417
 418 /* Cast from const char * to char * so that caller can assign to
 419    a char * without a warning.  */
 420 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 421 #define bfd_get_cacheable(abfd) ((abfd)->cacheable)
 422 #define bfd_get_format(abfd) ((abfd)->format)
 423 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 424 #define bfd_get_flavour(abfd) ((abfd)->xvec->flavour)
 425 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 426 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 427 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 428 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 429 #define bfd_has_map(abfd) ((abfd)->has_armap)
 430
 431 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 432 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 433
 434 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 435 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 436 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 437 #define bfd_count_sections(abfd) ((abfd)->section_count)
 438
 439 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 440
 441 #define bfd_set_cacheable(abfd,bool) (((abfd)->cacheable = (bool)), true)
 442
 443 /* Byte swapping routines.  */
 444
 445 bfd_vma         bfd_getb64         PARAMS ((unsigned char *));
 446 bfd_vma         bfd_getl64         PARAMS ((unsigned char *));
 447 bfd_signed_vma  bfd_getb_signed_64 PARAMS ((unsigned char *));
 448 bfd_signed_vma  bfd_getl_signed_64 PARAMS ((unsigned char *));
 449 bfd_vma         bfd_getb32         PARAMS ((unsigned char *));
 450 bfd_vma         bfd_getl32         PARAMS ((unsigned char *));
 451 bfd_signed_vma  bfd_getb_signed_32 PARAMS ((unsigned char *));
 452 bfd_signed_vma  bfd_getl_signed_32 PARAMS ((unsigned char *));
 453 bfd_vma         bfd_getb16         PARAMS ((unsigned char *));
 454 bfd_vma         bfd_getl16         PARAMS ((unsigned char *));
 455 bfd_signed_vma  bfd_getb_signed_16 PARAMS ((unsigned char *));
 456 bfd_signed_vma  bfd_getl_signed_16 PARAMS ((unsigned char *));
 457 void            bfd_putb64         PARAMS ((bfd_vma, unsigned char *));
 458 void            bfd_putl64         PARAMS ((bfd_vma, unsigned char *));
 459 void            bfd_putb32         PARAMS ((bfd_vma, unsigned char *));
 460 void            bfd_putl32         PARAMS ((bfd_vma, unsigned char *));
 461 void            bfd_putb16         PARAMS ((bfd_vma, unsigned char *));
 462 void            bfd_putl16         PARAMS ((bfd_vma, unsigned char *));
 463
 464 /* ECOFF linking routines.  */
 465 #ifdef __STDC__
 466 struct ecoff_debug_info;
 467 struct ecoff_debug_swap;
 468 struct ecoff_extr;
 469 struct symbol_cache_entry;
 470 #endif
 471 extern boolean bfd_ecoff_debug_accumulate
 472   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 473            const struct ecoff_debug_swap *output_swap,
 474            bfd *input_bfd, struct ecoff_debug_info *input_debug,
 475            const struct ecoff_debug_swap *input_swap,
 476            boolean relocateable));
 477 extern boolean bfd_ecoff_debug_link_other
 478   PARAMS ((bfd *output_bfd, struct ecoff_debug_info *output_debug,
 479            const struct ecoff_debug_swap *output_swap, bfd *input_bfd));
 480 extern boolean bfd_ecoff_debug_externals
 481   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 482            const struct ecoff_debug_swap *swap,
 483            boolean relocateable,
 484            boolean (*get_extr) (struct symbol_cache_entry *,
 485                                 struct ecoff_extr *),
 486            void (*set_index) (struct symbol_cache_entry *,
 487                               bfd_size_type)));
 488 extern bfd_size_type bfd_ecoff_debug_size
 489   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 490            const struct ecoff_debug_swap *swap));
 491 extern boolean bfd_ecoff_write_debug
 492   PARAMS ((bfd *abfd, struct ecoff_debug_info *debug,
 493            const struct ecoff_debug_swap *swap, file_ptr where));
 494
 495 /* And more from the source.  */