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