bfd/bfd-in.h

   1 /* A -*- C -*- header file for the bfd library
   2    Copyright 1990, 1991 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 This file is part of BFD, the Binary File Descriptor library.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 /* bfd.h -- The only header file required by users of the bfd library
  22
  23 This file is generated from various .c files, if you change it, your
  24 bits may be lost.
  25
  26 All the prototypes and definitions following the comment "THE FOLLOWING
  27 IS EXTRACTED FROM THE SOURCE" are extracted from the source files for
  28 BFD.  If you change it, someone oneday will extract it from the source
  29 again, and your changes will be lost.  To save yourself from this bind,
  30 change the definitions in the source in the bfd directory.  Type "make
  31 docs" and then "make headers" in that directory, and magically this file
  32 will change to reflect your changes.
  33
  34 If you don't have the tools to perform the extraction, then you are
  35 safe from someone on your system trampling over your header files.
  36 You should still maintain the equivalence between the source and this
  37 file though; every change you make to the .c file should be reflected
  38 here.  */
  39
  40 #ifndef __BFD_H_SEEN__
  41 #define __BFD_H_SEEN__
  42
  43 #include "ansidecl.h"
  44 #include "obstack.h"
  45
  46 /* Make it easier to declare prototypes (puts conditional here) */
  47 #ifndef PROTO
  48 #       if __STDC__
  49 #               define PROTO(type, name, arglist) type name arglist
  50 #       else
  51 #               define PROTO(type, name, arglist) type name ()
  52 #       endif
  53 #endif
  54
  55 #define BFD_VERSION "1.96"
  56
  57 /* forward declaration */
  58 typedef struct _bfd bfd;
  59
  60 /* General rules: functions which are boolean return true on success
  61    and false on failure (unless they're a predicate).   -- bfd.doc */
  62 /* I'm sure this is going to break something and someone is going to
  63    force me to change it. */
  64 /* typedef enum boolean {false, true} boolean; */
  65 /* Yup, SVR4 has a "typedef enum boolean" in <sys/types.h>  -fnf */
  66 typedef enum bfd_boolean {false, true} boolean;
  67
  68 /* Try to avoid breaking stuff */
  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    0
 110 #define HAS_RELOC   001
 111 #define EXEC_P      002
 112 #define HAS_LINENO  004
 113 #define HAS_DEBUG   010
 114 #define HAS_SYMS    020
 115 #define HAS_LOCALS  040
 116 #define DYNAMIC     0100
 117 #define WP_TEXT     0200
 118 #define D_PAGED     0400
 119
 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_section_name(bfd, ptr) ((ptr)->name)
 184 #define bfd_section_size(bfd, ptr) (bfd_get_section_size_before_reloc(ptr))
 185 #define bfd_section_vma(bfd, ptr) ((ptr)->vma)
 186 #define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)
 187 #define bfd_get_section_flags(bfd, ptr) ((ptr)->flags)
 188 #define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)
 189
 190 #define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (val)), true)
 191 #define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),true)
 192 #define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),true)
 193
 194 typedef struct stat stat_type;
 195 \f
 196 /** Error handling */
 197
 198 typedef enum bfd_error {
 199               no_error = 0, system_call_error, invalid_target,
 200               wrong_format, invalid_operation, no_memory,
 201               no_symbols, no_relocation_info,
 202               no_more_archived_files, malformed_archive,
 203               symbol_not_found, file_not_recognized,
 204               file_ambiguously_recognized, no_contents,
 205               bfd_error_nonrepresentable_section,
 206               no_debug_section,
 207               invalid_error_code} bfd_ec;
 208
 209 extern bfd_ec bfd_error;
 210 struct reloc_cache_entry;
 211 struct bfd_seclet_struct ;
 212
 213
 214 typedef struct bfd_error_vector {
 215   PROTO(void,(* nonrepresentable_section ),(CONST bfd  *CONST abfd,
 216                                             CONST char *CONST name));
 217   PROTO(void,(* undefined_symbol),(CONST struct reloc_cache_entry *rel,
 218                                    CONST struct bfd_seclet_struct *sec
 219                                    ));
 220   PROTO(void, (* reloc_value_truncated),(CONST struct
 221                                           reloc_cache_entry *rel,
 222                                           struct bfd_seclet_struct *sec));
 223
 224   PROTO(void, (* reloc_dangerous),(CONST struct reloc_cache_entry *rel,
 225                                    CONST struct bfd_seclet_struct *sec));
 226
 227 } bfd_error_vector_type;
 228
 229 PROTO (char *, bfd_errmsg, (bfd_ec error_tag));
 230 PROTO (void, bfd_perror, (CONST char *message));
 231 \f
 232
 233 typedef enum bfd_print_symbol
 234 {
 235   bfd_print_symbol_name,
 236   bfd_print_symbol_more,
 237   bfd_print_symbol_all,
 238   bfd_print_symbol_nm   /* Pretty format suitable for nm program. */
 239 } bfd_print_symbol_type;
 240
 241 \f
 242 \f
 243 /* The code that implements targets can initialize a jump table with this
 244    macro.  It must name all its routines the same way (a prefix plus
 245    the standard routine suffix), or it must #define the routines that
 246    are not so named, before calling JUMP_TABLE in the initializer.  */
 247
 248 /* Semi-portable string concatenation in cpp */
 249 #ifndef CAT
 250 #ifdef __STDC__
 251 #define CAT(a,b) a##b
 252 #else
 253 #define CAT(a,b) a/**/b
 254 #endif
 255 #endif
 256
 257 #define JUMP_TABLE(NAME)\
 258 CAT(NAME,_core_file_failing_command),\
 259 CAT(NAME,_core_file_failing_signal),\
 260 CAT(NAME,_core_file_matches_executable_p),\
 261 CAT(NAME,_slurp_armap),\
 262 CAT(NAME,_slurp_extended_name_table),\
 263 CAT(NAME,_truncate_arname),\
 264 CAT(NAME,_write_armap),\
 265 CAT(NAME,_close_and_cleanup),   \
 266 CAT(NAME,_set_section_contents),\
 267 CAT(NAME,_get_section_contents),\
 268 CAT(NAME,_new_section_hook),\
 269 CAT(NAME,_get_symtab_upper_bound),\
 270 CAT(NAME,_get_symtab),\
 271 CAT(NAME,_get_reloc_upper_bound),\
 272 CAT(NAME,_canonicalize_reloc),\
 273 CAT(NAME,_make_empty_symbol),\
 274 CAT(NAME,_print_symbol),\
 275 CAT(NAME,_get_lineno),\
 276 CAT(NAME,_set_arch_mach),\
 277 CAT(NAME,_openr_next_archived_file),\
 278 CAT(NAME,_find_nearest_line),\
 279 CAT(NAME,_generic_stat_arch_elt),\
 280 CAT(NAME,_sizeof_headers),\
 281 CAT(NAME,_bfd_debug_info_start),\
 282 CAT(NAME,_bfd_debug_info_end),\
 283 CAT(NAME,_bfd_debug_info_accumulate),\
 284 CAT(NAME,_bfd_get_relocated_section_contents),\
 285 CAT(NAME,_bfd_relax_section)
 286
 287 #define COFF_SWAP_TABLE \
 288  coff_swap_aux_in, coff_swap_sym_in, coff_swap_lineno_in, \
 289  coff_swap_aux_out, coff_swap_sym_out, \
 290  coff_swap_lineno_out, coff_swap_reloc_out, \
 291  coff_swap_filehdr_out, coff_swap_aouthdr_out, \
 292  coff_swap_scnhdr_out
 293
 294
 295 \f
 296 /* User program access to BFD facilities */
 297
 298 extern CONST short _bfd_host_big_endian;
 299 #define HOST_BYTE_ORDER_BIG_P   (*(char *)&_bfd_host_big_endian)
 300
 301 /* The bfd itself */
 302
 303 /* Cast from const char * to char * so that caller can assign to
 304    a char * without a warning.  */
 305 #define bfd_get_filename(abfd) ((char *) (abfd)->filename)
 306 #define bfd_get_format(abfd) ((abfd)->format)
 307 #define bfd_get_target(abfd) ((abfd)->xvec->name)
 308 #define bfd_get_file_flags(abfd) ((abfd)->flags)
 309 #define bfd_applicable_file_flags(abfd) ((abfd)->xvec->object_flags)
 310 #define bfd_applicable_section_flags(abfd) ((abfd)->xvec->section_flags)
 311 #define bfd_my_archive(abfd) ((abfd)->my_archive)
 312 #define bfd_has_map(abfd) ((abfd)->has_armap)
 313 #define bfd_header_twiddle_required(abfd) \
 314         ((((abfd)->xvec->header_byteorder_big_p)                \
 315           != (boolean)HOST_BYTE_ORDER_BIG_P) ? true:false)
 316
 317 #define bfd_valid_reloc_types(abfd) ((abfd)->xvec->valid_reloc_types)
 318 #define bfd_usrdata(abfd) ((abfd)->usrdata)
 319
 320 #define bfd_get_start_address(abfd) ((abfd)->start_address)
 321 #define bfd_get_symcount(abfd) ((abfd)->symcount)
 322 #define bfd_get_outsymbols(abfd) ((abfd)->outsymbols)
 323 #define bfd_count_sections(abfd) ((abfd)->section_count)
 324 #define bfd_get_architecture(abfd) ((abfd)->obj_arch)
 325 #define bfd_get_machine(abfd) ((abfd)->obj_machine)
 326
 327
 328
 329 #define BYTE_SIZE 1
 330 #define SHORT_SIZE 2
 331 #define LONG_SIZE 4
 332
 333
 334
 335 /* ANd more from the source */
 336
 337
 338
 339
 340
 341
 342
 343
 344