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