bfd/bfd-in.h

   1 /* Main header file for the bfd library -- portable access to object files.
   2    ==> The bfd.h file is generated from bfd-in.h and various .c files; if you
   3    ==> change it, your changes will probably be lost.
   4    Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   5    Contributed by Cygnus Support.
   6
   7 This file is part of BFD, the Binary File Descriptor library.
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  22
  23 /* bfd.h -- The only header file required by users of the bfd library
  24
  25 The bfd.h file is generated from bfd-in.h and various .c files; if you
  26 change it, your changes will probably be lost.
  27
  28 All the prototypes and definitions following the comment "THE FOLLOWING
  29 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  30 BFD.  If you change it, someone oneday will extract it from the source
  31 again, and your changes will be lost.  To save yourself from this bind,
  32 change the definitions in the source in the bfd directory.  Type "make
  33 docs" and then "make headers" in that directory, and magically this file
  34 will change to reflect your changes.
  35
  36 If you don't have the tools to perform the extraction, then you are
  37 safe from someone on your system trampling over your header files.
  38 You should still maintain the equivalence between the source and this
  39 file though; every change you make to the .c file should be reflected
  40 here.  */
  41
  42 #ifndef __BFD_H_SEEN__
  43 #define __BFD_H_SEEN__
  44
  45 #include "ansidecl.h"
  46 #include "obstack.h"
  47
  48 #define BFD_VERSION "2.2"
  49
  50 #define BFD_ARCH_SIZE @WORDSIZE@
  51
  52 #if BFD_ARCH_SIZE >= 64
  53 #define BFD64
  54 #endif
  55
  56 #ifndef FOPEN_AUT /* WAG */
  57 /* INSERT SYSDEP HERE */
  58 /* END OF SYSDEP */
  59 #endif
  60
  61 /* forward declaration */
  62 typedef struct _bfd bfd;
  63
  64 /* To squelch erroneous compiler warnings ("illegal pointer
  65    combination") from the SVR3 compiler, we would like to typedef
  66    boolean to int (it doesn't like functions which return boolean.
  67    Making sure they are never implicitly declared to return int
  68    doesn't seem to help).  But this file is not configured based on
  69    the host.  */
  70 /* General rules: functions which are boolean return true on success
  71    and false on failure (unless they're a predicate).   -- bfd.doc */
  72 /* I'm sure this is going to break something and someone is going to
  73    force me to change it. */
  74 /* typedef enum boolean {false, true} boolean; */
  75 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  76 typedef enum bfd_boolean {false, true} boolean;
  77
  78 /* A pointer to a position in a file.  */
  79 /* FIXME:  This should be using off_t from <sys/types.h>.
  80    For now, try to avoid breaking stuff by not including <sys/types.h> here.
  81    This will break on systems with 64-bit file offsets (e.g. 4.4BSD).
  82    Probably the best long-term answer is to avoid using file_ptr AND off_t
  83    in this header file, and to handle this in the BFD implementation
  84    rather than in its interface.  */
  85 /* typedef off_t        file_ptr; */
  86 typedef long int file_ptr;
  87
  88 /* Support for different sizes of target format ints and addresses.  If the
  89    host implements 64-bit values, it defines HOST_64_BIT to be the appropriate
  90    type.  Otherwise, this code will fall back on gcc's "long long" type if gcc
  91    is being used.  HOST_64_BIT must be defined in such a way as to be a valid
  92    type name by itself or with "unsigned" prefixed.  It should be a signed
  93    type by itself.
  94
  95    If neither is the case, then compilation will fail if 64-bit targets are
  96    requested.  If you don't request any 64-bit targets, you should be safe. */
  97
  98 #ifdef  BFD64
  99
 100 #if defined (__GNUC__) && !defined (HOST_64_BIT)
 101 #define HOST_64_BIT long long
 102 typedef HOST_64_BIT int64_type;
 103 typedef unsigned HOST_64_BIT uint64_type;
 104 #endif
 105
 106 typedef unsigned HOST_64_BIT bfd_vma;
 107 typedef HOST_64_BIT bfd_signed_vma;
 108 typedef unsigned HOST_64_BIT bfd_size_type;
 109 typedef unsigned HOST_64_BIT symvalue;
 110 #define fprintf_vma(s,x) \
 111                 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
 112 #else /* not BFD64  */
 113
 114 /* Represent a target address.  Also used as a generic unsigned type
 115    which is guaranteed to be big enough to hold any arithmetic types
 116    we need to deal with.  */
 117 typedef unsigned long bfd_vma;
 118
 119 /* A generic signed type which is guaranteed to be big enough to hold any
 120    arithmetic types we need to deal with.  Can be assumed to be compatible
 121    with bfd_vma in the same way that signed and unsigned ints are compatible
 122    (as parameters, in assignment, etc).  */
 123 typedef long bfd_signed_vma;
 124
 125 typedef unsigned long symvalue;
 126 typedef unsigned long bfd_size_type;
 127
 128 /* Print a bfd_vma x on stream s.  */
 129 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
 130 #endif /* not BFD64  */
 131 #define printf_vma(x) fprintf_vma(stdout,x)
 132
 133 typedef unsigned int flagword;  /* 32 bits of flags */
 134 \f
 135 /** File formats */
 136
 137 typedef enum bfd_format {
 138               bfd_unknown = 0,  /* file format is unknown */
 139               bfd_object,       /* linker/assember/compiler output */
 140               bfd_archive,      /* object archive file */
 141               bfd_core,         /* core dump */
 142               bfd_type_end}     /* marks the end; don't use it! */
 143          bfd_format;
 144
 145 /* Object file flag values */
 146 #define NO_FLAGS        0x00
 147 #define HAS_RELOC       0x01
 148 #define EXEC_P          0x02
 149 #define HAS_LINENO      0x04
 150 #define HAS_DEBUG       0x08
 151 #define HAS_SYMS        0x10
 152 #define HAS_LOCALS      0x20
 153 #define DYNAMIC         0x40
 154 #define WP_TEXT         0x80
 155 #define D_PAGED         0x100
 156 #define BFD_IS_RELAXABLE 0x200
 157 \f
 158 /* symbols and relocation */
 159
 160 typedef unsigned long symindex;
 161
 162 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 163
 164 typedef enum bfd_symclass {
 165               bfd_symclass_unknown = 0,
 166               bfd_symclass_fcommon, /* fortran common symbols */
 167               bfd_symclass_global, /* global symbol, what a surprise */
 168               bfd_symclass_debugger, /* some debugger symbol */
 169               bfd_symclass_undefined /* none known */
 170             } symclass;
 171
 172
 173 typedef int symtype;            /* Who knows, yet? */
 174
 175
 176 /* general purpose part of a symbol;
 177    target specific parts will be found in libcoff.h, liba.out.h etc */
 178
 179
 180 #define bfd_get_section(x) ((x)->section)
 181 #define bfd_get_output_section(x) ((x)->section->output_section)
 182 #define bfd_set_section(x,y) ((x)->section) = (y)
 183 #define bfd_asymbol_base(x) ((x)->section->vma)
 184 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)
 185 #define bfd_asymbol_name(x) ((x)->name)
 186 /*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/
 187 #define bfd_asymbol_bfd(x) ((x)->the_bfd)
 188 #define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)
 189
 190 /* This is a type pun with struct ranlib on purpose! */
 191 typedef struct carsym {
 192   char *name;
 193   file_ptr file_offset;         /* look here to find the file */
 194 } carsym;                       /* to make these you call a carsymogen */
 195
 196
 197 /* Used in generating armaps.  Perhaps just a forward definition would do? */
 198 struct orl {                    /* output ranlib */
 199   char **name;                  /* symbol name */
 200   file_ptr pos;                 /* bfd* or file position */
 201   int namidx;                   /* index into string table */
 202 };
 203
 204 \f
 205
 206 /* Linenumber stuff */
 207 typedef struct lineno_cache_entry {
 208   unsigned int line_number;     /* Linenumber from start of function*/
 209   union {
 210  struct symbol_cache_entry *sym;                /* Function name */
 211     unsigned long offset;       /* Offset into section */
 212   } u;
 213 } alent;
 214 \f
 215 /* object and core file sections */
 216
 217
 218 #define align_power(addr, align)        \
 219         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 220
 221 typedef struct sec *sec_ptr;
 222
 223 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 224 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 225 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 226 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 227 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 228 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 229 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 230 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 231 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 232
 233 #define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)
 234
 235 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma= (val)), ((ptr)->user_set_vma = true), true)
 236 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 237 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 238
 239 typedef struct stat stat_type;
 240 \f
 241 /** Error handling */
 242
 243 typedef enum bfd_error {
 244               no_error = 0, system_call_error, invalid_target,
 245               wrong_format, invalid_operation, no_memory,
 246               no_symbols, no_relocation_info,
 247               no_more_archived_files, malformed_archive,
 248               symbol_not_found, file_not_recognized,
 249               file_ambiguously_recognized, no_contents,
 250               bfd_error_nonrepresentable_section,
 251               no_debug_section, bad_value,
 252
 253               /* An input file is shorter than expected.  */
 254               file_truncated,
 255
 256               invalid_error_code} bfd_ec;
 257
 258 extern bfd_ec bfd_error;
 259 struct reloc_cache_entry;
 260 struct bfd_seclet;
 261
 262
 263 typedef struct bfd_error_vector {
 264   void (* nonrepresentable_section ) PARAMS ((CONST bfd  *CONST abfd,
 265                                               CONST char *CONST name));
 266   void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
 267                                      CONST struct bfd_seclet *sec));
 268   void (* reloc_value_truncated) PARAMS ((CONST struct
 269                                           reloc_cache_entry *rel,
 270                                           struct bfd_seclet *sec));
 271
 272   void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
 273                                     CONST struct bfd_seclet *sec));
 274
 275 } bfd_error_vector_type;
 276
 277 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
 278 void bfd_perror PARAMS ((CONST char *message));
 279 \f
 280
 281 typedef enum bfd_print_symbol
 282 {
 283   bfd_print_symbol_name,
 284   bfd_print_symbol_more,
 285   bfd_print_symbol_all
 286 } bfd_print_symbol_type;
 287
 288 \f
 289 /* Information about a symbol that nm needs.  */
 290
 291 typedef struct _symbol_info
 292 {
 293   symvalue value;
 294   char type;                   /*  */
 295   CONST char *name;            /* Symbol name.  */
 296   char stab_other;             /* Unused. */
 297   short stab_desc;             /* Info for N_TYPE.  */
 298   CONST char *stab_name;
 299 } symbol_info;
 300 \f
 301 /* The code that implements targets can initialize a jump table with this
 302    macro.  It must name all its routines the same way (a prefix plus
 303    the standard routine suffix), or it must #define the routines that
 304    are not so named, before calling JUMP_TABLE in the initializer.  */
 305
 306 /* Semi-portable string concatenation in cpp */
 307 #ifndef CAT
 308 #ifdef __STDC__
 309 #define CAT(a,b) a##b
 310 #define CAT3(a,b,c) a##b##c
 311 #else
 312 #define CAT(a,b) a/**/b
 313 #define CAT3(a,b,c) a/**/b/**/c
 314 #endif
 315 #endif
 316
 317 #define JUMP_TABLE(NAME)\
 318 CAT(NAME,_core_file_failing_command),\
 319 CAT(NAME,_core_file_failing_signal),\
 320 CAT(NAME,_core_file_matches_executable_p),\
 321 CAT(NAME,_slurp_armap),\
 322 CAT(NAME,_slurp_extended_name_table),\
 323 CAT(NAME,_truncate_arname),\
 324 CAT(NAME,_write_armap),\
 325 CAT(NAME,_close_and_cleanup),   \
 326 CAT(NAME,_set_section_contents),\
 327 CAT(NAME,_get_section_contents),\
 328 CAT(NAME,_new_section_hook),\
 329 CAT(NAME,_get_symtab_upper_bound),\
 330 CAT(NAME,_get_symtab),\
 331 CAT(NAME,_get_reloc_upper_bound),\
 332 CAT(NAME,_canonicalize_reloc),\
 333 CAT(NAME,_make_empty_symbol),\
 334 CAT(NAME,_print_symbol),\
 335 CAT(NAME,_get_symbol_info),\
 336 CAT(NAME,_get_lineno),\
 337 CAT(NAME,_set_arch_mach),\
 338 CAT(NAME,_openr_next_archived_file),\
 339 CAT(NAME,_find_nearest_line),\
 340 CAT(NAME,_generic_stat_arch_elt),\
 341 CAT(NAME,_sizeof_headers),\
 342 CAT(NAME,_bfd_debug_info_start),\
 343 CAT(NAME,_bfd_debug_info_end),\
 344 CAT(NAME,_bfd_debug_info_accumulate),\
 345 CAT(NAME,_bfd_get_relocated_section_contents),\
 346 CAT(NAME,_bfd_relax_section),\
 347 CAT(NAME,_bfd_seclet_link),\
 348 CAT(NAME,_bfd_reloc_type_lookup),\
 349 CAT(NAME,_bfd_make_debug_symbol)
 350
 351 #define COFF_SWAP_TABLE (PTR) &bfd_coff_std_swap_table
 352
 353 \f
 354 /* User program access to BFD facilities */
 355
 356 extern CONST short _bfd_host_big_endian;
 357 #define HOST_BYTE_ORDER_BIG_P   (*(char *)&_bfd_host_big_endian)
 358
 359 /* The bfd itself */
 360
 361 /* Cast from const char * to char * so that caller can assign to
 362    a char * without a warning.  */
 363 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 364 #define bfd_get_format(abfd) ((abfd)->format)
 365 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 366 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 367 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 368 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 369 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 370 #define bfd_has_map(abfd) ((abfd)->has_armap)
 371 #define bfd_header_twiddle_required(abfd) \
 372         ((((abfd)->xvec->header_byteorder_big_p)                \
 373           != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
 374
 375 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 376 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 377
 378 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 379 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 380 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 381 #define bfd_count_sections(abfd) ((abfd)->section_count)
 382 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
 383 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
 384
 385 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 386
 387 #define BYTE_SIZE 1
 388 #define SHORT_SIZE 2
 389 #define LONG_SIZE 4
 390
 391 /* And more from the source.  */