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