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 /* Object file flag values */
 164 #define NO_FLAGS        0x00
 165 #define HAS_RELOC       0x01
 166 #define EXEC_P          0x02
 167 #define HAS_LINENO      0x04
 168 #define HAS_DEBUG       0x08
 169 #define HAS_SYMS        0x10
 170 #define HAS_LOCALS      0x20
 171 #define DYNAMIC         0x40
 172 #define WP_TEXT         0x80
 173 #define D_PAGED         0x100
 174 #define BFD_IS_RELAXABLE 0x200
 175 \f
 176 /* symbols and relocation */
 177
 178 typedef unsigned long symindex;
 179
 180 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 181
 182 typedef enum bfd_symclass {
 183               bfd_symclass_unknown = 0,
 184               bfd_symclass_fcommon, /* fortran common symbols */
 185               bfd_symclass_global, /* global symbol, what a surprise */
 186               bfd_symclass_debugger, /* some debugger symbol */
 187               bfd_symclass_undefined /* none known */
 188             } symclass;
 189
 190
 191 typedef int symtype;            /* Who knows, yet? */
 192
 193
 194 /* general purpose part of a symbol;
 195    target specific parts will be found in libcoff.h, liba.out.h etc */
 196
 197
 198 #define bfd_get_section(x) ((x)->section)
 199 #define bfd_get_output_section(x) ((x)->section->output_section)
 200 #define bfd_set_section(x,y) ((x)->section) = (y)
 201 #define bfd_asymbol_base(x) ((x)->section->vma)
 202 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 203 #define bfd_asymbol_name(x) ((x)->name)
 204 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 205 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 206 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 207
 208 /* This is a type pun with struct ranlib on purpose! */
 209 typedef struct carsym {
 210   char *name;
 211   file_ptr file_offset;         /* look here to find the file */
 212 } carsym;                       /* to make these you call a carsymogen */
 213
 214
 215 /* Used in generating armaps.  Perhaps just a forward definition would do? */
 216 struct orl {                    /* output ranlib */
 217   char **name;                  /* symbol name */
 218   file_ptr pos;                 /* bfd* or file position */
 219   int namidx;                   /* index into string table */
 220 };
 221
 222 \f
 223
 224 /* Linenumber stuff */
 225 typedef struct lineno_cache_entry {
 226   unsigned int line_number;     /* Linenumber from start of function*/
 227   union {
 228  struct symbol_cache_entry *sym;                /* Function name */
 229     unsigned long offset;       /* Offset into section */
 230   } u;
 231 } alent;
 232 \f
 233 /* object and core file sections */
 234
 235
 236 #define align_power(addr, align)        \
 237         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 238
 239 typedef struct sec *sec_ptr;
 240
 241 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 242 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 243 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 244 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 245 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 246 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 247 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 248 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 249 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 250
 251 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 252
 253 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 254 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 255 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 256
 257 typedef struct stat stat_type;
 258 \f
 259 /** Error handling */
 260
 261 typedef enum bfd_error {
 262               no_error = 0, system_call_error, invalid_target,
 263               wrong_format, invalid_operation, no_memory,
 264               no_symbols, no_relocation_info,
 265               no_more_archived_files, malformed_archive,
 266               symbol_not_found, file_not_recognized,
 267               file_ambiguously_recognized, no_contents,
 268               bfd_error_nonrepresentable_section,
 269               no_debug_section, bad_value,
 270
 271               /* An input file is shorter than expected.  */
 272               file_truncated,
 273
 274               invalid_error_code} bfd_ec;
 275
 276 extern bfd_ec bfd_error;
 277 struct reloc_cache_entry;
 278 struct bfd_seclet;
 279
 280
 281 typedef struct bfd_error_vector {
 282   void (* nonrepresentable_section ) PARAMS ((CONST bfd  *CONST abfd,
 283                                               CONST char *CONST name));
 284   void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
 285                                      CONST struct bfd_seclet *sec));
 286   void (* reloc_value_truncated) PARAMS ((CONST struct
 287                                           reloc_cache_entry *rel,
 288                                           struct bfd_seclet *sec));
 289
 290   void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
 291                                     CONST struct bfd_seclet *sec));
 292
 293 } bfd_error_vector_type;
 294
 295 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
 296 void bfd_perror PARAMS ((CONST char *message));
 297 \f
 298
 299 typedef enum bfd_print_symbol
 300 {
 301   bfd_print_symbol_name,
 302   bfd_print_symbol_more,
 303   bfd_print_symbol_all
 304 } bfd_print_symbol_type;
 305
 306 \f
 307 /* Information about a symbol that nm needs.  */
 308
 309 typedef struct _symbol_info
 310 {
 311   symvalue value;
 312   char type;                   /*  */
 313   CONST char *name;            /* Symbol name.  */
 314   char stab_other;             /* Unused. */
 315   short stab_desc;             /* Info for N_TYPE.  */
 316   CONST char *stab_name;
 317 } symbol_info;
 318 \f
 319 /* The code that implements targets can initialize a jump table with this
 320    macro.  It must name all its routines the same way (a prefix plus
 321    the standard routine suffix), or it must #define the routines that
 322    are not so named, before calling JUMP_TABLE in the initializer.  */
 323
 324 /* Semi-portable string concatenation in cpp.
 325    The CAT4 hack is to avoid a problem with some strict ANSI C preprocessors.
 326    The problem is, "32_" is not a valid preprocessing token, and we don't
 327    want extra underscores (e.g., "nlm_32_").  The XCAT2 macro will cause the
 328    inner CAT macros to be evaluated first, producing still-valid pp-tokens.
 329    Then the final concatenation can be done.  (Sigh.)  */
 330 #ifndef CAT
 331 #ifdef SABER
 332 #define CAT(a,b)        a##b
 333 #define CAT3(a,b,c)     a##b##c
 334 #define CAT4(a,b,c,d)   a##b##c##d
 335 #else
 336 #ifdef __STDC__
 337 #define CAT(a,b) a##b
 338 #define CAT3(a,b,c) a##b##c
 339 #define XCAT2(a,b)      CAT(a,b)
 340 #define CAT4(a,b,c,d)   XCAT2(CAT(a,b),CAT(c,d))
 341 #else
 342 #define CAT(a,b) a/**/b
 343 #define CAT3(a,b,c) a/**/b/**/c
 344 #define CAT4(a,b,c,d)   a/**/b/**/c/**/d
 345 #endif
 346 #endif
 347 #endif
 348
 349 #define JUMP_TABLE(NAME)\
 350 CAT(NAME,_core_file_failing_command),\
 351 CAT(NAME,_core_file_failing_signal),\
 352 CAT(NAME,_core_file_matches_executable_p),\
 353 CAT(NAME,_slurp_armap),\
 354 CAT(NAME,_slurp_extended_name_table),\
 355 CAT(NAME,_truncate_arname),\
 356 CAT(NAME,_write_armap),\
 357 CAT(NAME,_close_and_cleanup),\
 358 CAT(NAME,_set_section_contents),\
 359 CAT(NAME,_get_section_contents),\
 360 CAT(NAME,_new_section_hook),\
 361 CAT(NAME,_get_symtab_upper_bound),\
 362 CAT(NAME,_get_symtab),\
 363 CAT(NAME,_get_reloc_upper_bound),\
 364 CAT(NAME,_canonicalize_reloc),\
 365 CAT(NAME,_make_empty_symbol),\
 366 CAT(NAME,_print_symbol),\
 367 CAT(NAME,_get_symbol_info),\
 368 CAT(NAME,_get_lineno),\
 369 CAT(NAME,_set_arch_mach),\
 370 CAT(NAME,_openr_next_archived_file),\
 371 CAT(NAME,_find_nearest_line),\
 372 CAT(NAME,_generic_stat_arch_elt),\
 373 CAT(NAME,_sizeof_headers),\
 374 CAT(NAME,_bfd_debug_info_start),\
 375 CAT(NAME,_bfd_debug_info_end),\
 376 CAT(NAME,_bfd_debug_info_accumulate),\
 377 CAT(NAME,_bfd_get_relocated_section_contents),\
 378 CAT(NAME,_bfd_relax_section),\
 379 CAT(NAME,_bfd_seclet_link),\
 380 CAT(NAME,_bfd_reloc_type_lookup),\
 381 CAT(NAME,_bfd_make_debug_symbol)
 382
 383 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 384
 385 \f
 386 /* User program access to BFD facilities */
 387
 388 extern CONST short _bfd_host_big_endian;
 389 #define HOST_BYTE_ORDER_BIG_P   (*(char *)&_bfd_host_big_endian)
 390
 391 /* The bfd itself */
 392
 393 /* Cast from const char * to char * so that caller can assign to
 394    a char * without a warning.  */
 395 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 396 #define bfd_get_format(abfd) ((abfd)->format)
 397 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 398 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 399 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 400 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 401 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 402 #define bfd_has_map(abfd) ((abfd)->has_armap)
 403 #define bfd_header_twiddle_required(abfd) \
 404         ((((abfd)->xvec->header_byteorder_big_p)                \
 405           != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
 406
 407 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 408 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 409
 410 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 411 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 412 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 413 #define bfd_count_sections(abfd) ((abfd)->section_count)
 414 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
 415 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
 416
 417 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 418
 419 #define BYTE_SIZE 1
 420 #define SHORT_SIZE 2
 421 #define LONG_SIZE 4
 422
 423 /* And more from the source.  */