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 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.0"
  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
  73 #ifdef  HOST_64_BIT
  74 typedef HOST_64_BIT rawdata_offset;
  75 typedef HOST_64_BIT bfd_vma;
  76 typedef HOST_64_BIT bfd_word;
  77 typedef HOST_64_BIT bfd_offset;
  78 typedef HOST_64_BIT bfd_size_type;
  79 typedef HOST_64_BIT symvalue;
  80 typedef HOST_64_BIT bfd_64_type;
  81 #define fprintf_vma(s,x) \
  82                 fprintf(s,"%08x%08x", uint64_typeHIGH(x), uint64_typeLOW(x))
  83 #else
  84 typedef struct {int a,b;} bfd_64_type;
  85 typedef unsigned long rawdata_offset;
  86 typedef unsigned long bfd_vma;
  87 typedef unsigned long bfd_offset;
  88 typedef unsigned long bfd_word;
  89 typedef unsigned long bfd_size;
  90 typedef unsigned long symvalue;
  91 typedef unsigned long bfd_size_type;
  92 #define fprintf_vma(s,x) fprintf(s, "%08lx", x)
  93 #endif
  94 #define printf_vma(x) fprintf_vma(stdout,x)
  95
  96 typedef unsigned int flagword;  /* 32 bits of flags */
  97 \f
  98 /** File formats */
  99
 100 typedef enum bfd_format {
 101               bfd_unknown = 0,  /* file format is unknown */
 102               bfd_object,       /* linker/assember/compiler output */
 103               bfd_archive,      /* object archive file */
 104               bfd_core,         /* core dump */
 105               bfd_type_end}     /* marks the end; don't use it! */
 106          bfd_format;
 107
 108 /* Object file flag values */
 109 #define NO_FLAGS        0x00
 110 #define HAS_RELOC       0x01
 111 #define EXEC_P          0x02
 112 #define HAS_LINENO      0x04
 113 #define HAS_DEBUG       0x08
 114 #define HAS_SYMS        0x10
 115 #define HAS_LOCALS      0x20
 116 #define DYNAMIC         0x40
 117 #define WP_TEXT         0x80
 118 #define D_PAGED         0x100
 119 #define BFD_IS_RELAXABLE 0x200
 120 \f
 121 /* symbols and relocation */
 122
 123 typedef unsigned long symindex;
 124
 125 #define BFD_NO_MORE_SYMBOLS ((symindex) ~0)
 126
 127 typedef enum bfd_symclass {
 128               bfd_symclass_unknown = 0,
 129               bfd_symclass_fcommon, /* fortran common symbols */
 130               bfd_symclass_global, /* global symbol, what a surprise */
 131               bfd_symclass_debugger, /* some debugger symbol */
 132               bfd_symclass_undefined /* none known */
 133             } symclass;
 134
 135
 136 typedef int symtype;            /* Who knows, yet? */
 137
 138
 139 /* general purpose part of a symbol;
 140    target specific parts will be found in libcoff.h, liba.out.h etc */
 141
 142
 143 #define bfd_get_section(x) ((x)->section)
 144 #define bfd_get_output_section(x) ((x)->section->output_section)
 145 #define bfd_set_section(x,y) ((x)->section) = (y)
 146 #define bfd_asymbol_base(x) ((x)->section?((x)->section->vma):0)
 147 #define bfd_asymbol_value(x) (bfd_asymbol_base(x) + x->value)
 148 #define bfd_asymbol_name(x) ((x)->name)
 149
 150 /* This is a type pun with struct ranlib on purpose! */
 151 typedef struct carsym {
 152   char *name;
 153   file_ptr file_offset;         /* look here to find the file */
 154 } carsym;                       /* to make these you call a carsymogen */
 155
 156
 157 /* Used in generating armaps.  Perhaps just a forward definition would do? */
 158 struct orl {                    /* output ranlib */
 159   char **name;                  /* symbol name */
 160   file_ptr pos;                 /* bfd* or file position */
 161   int namidx;                   /* index into string table */
 162 };
 163
 164 \f
 165
 166 /* Linenumber stuff */
 167 typedef struct lineno_cache_entry {
 168   unsigned int line_number;     /* Linenumber from start of function*/
 169   union {
 170  struct symbol_cache_entry *sym;                /* Function name */
 171     unsigned long offset;       /* Offset into section */
 172   } u;
 173 } alent;
 174 \f
 175 /* object and core file sections */
 176
 177
 178 #define align_power(addr, align)        \
 179         ( ((addr) + ((1<<(align))-1)) & (-1 << (align)))
 180
 181 typedef struct sec *sec_ptr;
 182
 183 #define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)
 184 #define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)
 185 #define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)
 186 #define bfd_section_name(bfd, ptr) ((ptr)->name)
 187 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 188 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 189 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 190 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)
 191 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 192
 193 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), ((ptr)->user_set_vma = true), true)
 194 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 195 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 196
 197 typedef struct stat stat_type;
 198 \f
 199 /** Error handling */
 200
 201 typedef enum bfd_error {
 202               no_error = 0, system_call_error, invalid_target,
 203               wrong_format, invalid_operation, no_memory,
 204               no_symbols, no_relocation_info,
 205               no_more_archived_files, malformed_archive,
 206               symbol_not_found, file_not_recognized,
 207               file_ambiguously_recognized, no_contents,
 208               bfd_error_nonrepresentable_section,
 209               no_debug_section, bad_value,
 210               invalid_error_code} bfd_ec;
 211
 212 extern bfd_ec bfd_error;
 213 struct reloc_cache_entry;
 214 struct bfd_seclet;
 215
 216
 217 typedef struct bfd_error_vector {
 218   void (* nonrepresentable_section ) PARAMS ((CONST bfd  *CONST abfd,
 219                                               CONST char *CONST name));
 220   void (* undefined_symbol) PARAMS ((CONST struct reloc_cache_entry *rel,
 221                                      CONST struct bfd_seclet *sec));
 222   void (* reloc_value_truncated) PARAMS ((CONST struct
 223                                           reloc_cache_entry *rel,
 224                                           struct bfd_seclet *sec));
 225
 226   void (* reloc_dangerous) PARAMS ((CONST struct reloc_cache_entry *rel,
 227                                     CONST struct bfd_seclet *sec));
 228
 229 } bfd_error_vector_type;
 230
 231 CONST char *bfd_errmsg PARAMS ((bfd_ec error_tag));
 232 void bfd_perror PARAMS ((CONST char *message));
 233 \f
 234
 235 typedef enum bfd_print_symbol
 236 {
 237   bfd_print_symbol_name,
 238   bfd_print_symbol_more,
 239   bfd_print_symbol_all,
 240   bfd_print_symbol_nm   /* Pretty format suitable for nm program. */
 241 } bfd_print_symbol_type;
 242
 243 \f
 244 \f
 245 /* The code that implements targets can initialize a jump table with this
 246    macro.  It must name all its routines the same way (a prefix plus
 247    the standard routine suffix), or it must #define the routines that
 248    are not so named, before calling JUMP_TABLE in the initializer.  */
 249
 250 /* Semi-portable string concatenation in cpp */
 251 #ifndef CAT
 252 #ifdef __STDC__
 253 #define CAT(a,b) a##b
 254 #else
 255 #define CAT(a,b) a/**/b
 256 #endif
 257 #endif
 258
 259 #define JUMP_TABLE(NAME)\
 260 CAT(NAME,_core_file_failing_command),\
 261 CAT(NAME,_core_file_failing_signal),\
 262 CAT(NAME,_core_file_matches_executable_p),\
 263 CAT(NAME,_slurp_armap),\
 264 CAT(NAME,_slurp_extended_name_table),\
 265 CAT(NAME,_truncate_arname),\
 266 CAT(NAME,_write_armap),\
 267 CAT(NAME,_close_and_cleanup),   \
 268 CAT(NAME,_set_section_contents),\
 269 CAT(NAME,_get_section_contents),\
 270 CAT(NAME,_new_section_hook),\
 271 CAT(NAME,_get_symtab_upper_bound),\
 272 CAT(NAME,_get_symtab),\
 273 CAT(NAME,_get_reloc_upper_bound),\
 274 CAT(NAME,_canonicalize_reloc),\
 275 CAT(NAME,_make_empty_symbol),\
 276 CAT(NAME,_print_symbol),\
 277 CAT(NAME,_get_lineno),\
 278 CAT(NAME,_set_arch_mach),\
 279 CAT(NAME,_openr_next_archived_file),\
 280 CAT(NAME,_find_nearest_line),\
 281 CAT(NAME,_generic_stat_arch_elt),\
 282 CAT(NAME,_sizeof_headers),\
 283 CAT(NAME,_bfd_debug_info_start),\
 284 CAT(NAME,_bfd_debug_info_end),\
 285 CAT(NAME,_bfd_debug_info_accumulate),\
 286 CAT(NAME,_bfd_get_relocated_section_contents),\
 287 CAT(NAME,_bfd_relax_section)
 288
 289 #define COFF_SWAP_TABLE \
 290  coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, \
 291  coff_swap_aux_out, coff_swap_sym_out, \
 292  coff_swap_lineno_out, coff_swap_reloc_out, \
 293  coff_swap_filehdr_out, coff_swap_aouthdr_out, \
 294  coff_swap_scnhdr_out
 295
 296
 297 \f
 298 /* User program access to BFD facilities */
 299
 300 extern CONST short _bfd_host_big_endian;
 301 #define HOST_BYTE_ORDER_BIG_P   (*(char *)&_bfd_host_big_endian)
 302
 303 /* The bfd itself */
 304
 305 /* Cast from const char * to char * so that caller can assign to
 306    a char * without a warning.  */
 307 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 308 #define bfd_get_format(abfd) ((abfd)->format)
 309 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 310 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 311 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 312 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 313 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 314 #define bfd_has_map(abfd) ((abfd)->has_armap)
 315 #define bfd_header_twiddle_required(abfd) \
 316         ((((abfd)->xvec->header_byteorder_big_p)                \
 317           != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
 318
 319 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 320 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 321
 322 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 323 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 324 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 325 #define bfd_count_sections(abfd) ((abfd)->section_count)
 326 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
 327 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
 328
 329 #define bfd_get_symbol_leading_char(abfd) ((abfd)->xvec->symbol_leading_char)
 330
 331 #define BYTE_SIZE 1
 332 #define SHORT_SIZE 2
 333 #define LONG_SIZE 4
 334
 335 /* And more from the source.  */