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