bfd/libbfd.h

   1 /* libbfd.h -- Declarations used by bfd library *implementation*.
   2    (This include file is not for users of the library.)
   3    Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
   4    Written by Cygnus Support.
   5
   6 This file is part of BFD, the Binary File Descriptor library.
   7
   8 This program is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this program; if not, write to the Free Software
  20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  21
  22 /* Use builtin alloca for gcc.  */
  23 #ifdef __GNUC__
  24 #ifndef alloca
  25 #define alloca __builtin_alloca
  26 #endif
  27 #endif
  28
  29 /* Align an address upward to a boundary, expressed as a number of bytes.
  30    E.g. align to an 8-byte boundary with argument of 8.  */
  31 #define BFD_ALIGN(this, boundary) \
  32   ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
  33
  34 /* If you want to read and write large blocks, you might want to do it
  35    in quanta of this amount */
  36 #define DEFAULT_BUFFERSIZE 8192
  37
  38 /* Set a tdata field.  Can't use the other macros for this, since they
  39    do casts, and casting to the left of assignment isn't portable.  */
  40 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
  41
  42 /* tdata for an archive.  For an input archive, cache
  43    needs to be free()'d.  For an output archive, symdefs do.  */
  44
  45 struct artdata {
  46   file_ptr first_file_filepos;
  47   /* Speed up searching the armap */
  48   struct ar_cache *cache;
  49   bfd *archive_head;            /* Only interesting in output routines */
  50   carsym *symdefs;              /* the symdef entries */
  51   symindex symdef_count;             /* how many there are */
  52   char *extended_names;         /* clever intel extension */
  53   /* when more compilers are standard C, this can be a time_t */
  54   long  armap_timestamp;        /* Timestamp value written into armap.
  55                                    This is used for BSD archives to check
  56                                    that the timestamp is recent enough
  57                                    for the BSD linker to not complain,
  58                                    just before we finish writing an
  59                                    archive.  */
  60   file_ptr armap_datepos;       /* Position within archive to seek to
  61                                    rewrite the date field.  */
  62   PTR tdata;                    /* Backend specific information.  */
  63 };
  64
  65 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  66
  67 /* Goes in bfd's arelt_data slot */
  68 struct areltdata {
  69   char * arch_header;                        /* it's actually a string */
  70   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  71   char *filename;                            /* null-terminated */
  72 };
  73
  74 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  75
  76 char *zalloc PARAMS ((bfd_size_type size));
  77
  78 /* These routines allocate and free things on the BFD's obstack.  Note
  79    that realloc can never occur in place.  */
  80
  81 PTR     bfd_alloc PARAMS ((bfd *abfd, size_t size));
  82 PTR     bfd_zalloc PARAMS ((bfd *abfd, size_t size));
  83 PTR     bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
  84 void    bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
  85 PTR     bfd_alloc_finish PARAMS ((bfd *abfd));
  86 PTR     bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
  87
  88 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
  89
  90
  91 bfd_size_type   bfd_read  PARAMS ((PTR ptr, bfd_size_type size,
  92                                    bfd_size_type nitems, bfd *abfd));
  93 bfd_size_type   bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
  94                                    bfd_size_type nitems, bfd *abfd));
  95 int             bfd_seek  PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
  96                                    CONST int direction));
  97 long            bfd_tell  PARAMS ((bfd *abfd));
  98
  99 int             bfd_flush PARAMS ((bfd *abfd));
 100 int             bfd_stat  PARAMS ((bfd *abfd, struct stat *));
 101
 102 bfd *   _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
 103 bfd *   look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
 104 boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
 105 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
 106 struct areltdata *      _bfd_snarf_ar_hdr PARAMS ((bfd *abfd));
 107 bfd_target *            bfd_generic_archive_p PARAMS ((bfd *abfd));
 108 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
 109 boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
 110 #define bfd_slurp_bsd_armap bfd_slurp_armap
 111 #define bfd_slurp_coff_armap bfd_slurp_armap
 112 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
 113 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
 114 bfd *   new_bfd PARAMS ((void));
 115
 116 #define DEFAULT_STRING_SPACE_SIZE 0x2000
 117 boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
 118                                          unsigned int *table_length,
 119                                          char **free_ptr));
 120
 121 boolean bfd_false PARAMS ((bfd *ignore));
 122 boolean bfd_true PARAMS ((bfd *ignore));
 123 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
 124 int     bfd_0 PARAMS ((bfd *ignore));
 125 unsigned int    bfd_0u PARAMS ((bfd *ignore));
 126 void    bfd_void PARAMS ((bfd *ignore));
 127
 128 bfd *   new_bfd_contained_in PARAMS ((bfd *));
 129 boolean  _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
 130 char *   _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
 131 int      _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
 132 boolean  _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
 133                                                             bfd *exec_bfd));
 134 bfd_target *    _bfd_dummy_target PARAMS ((bfd *abfd));
 135
 136 void    bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 137                                         char *hdr));
 138 void    bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 139                                         char *hdr));
 140 void    bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 141                                         char *hdr));
 142
 143 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
 144                                   struct orl *map, unsigned int orl_count, int stridx));
 145
 146 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
 147                                    struct orl *map, unsigned int orl_count, int stridx));
 148
 149 bfd *   bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
 150                                                      bfd *last_file));
 151
 152 int     bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
 153
 154 boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 155                                                   PTR location, file_ptr offset,
 156                                                   bfd_size_type count));
 157
 158 boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 159                                                   PTR location, file_ptr offset,
 160                                                   bfd_size_type count));
 161 \f
 162 /* A routine to create entries for a bfd_link_hash_table.  */
 163 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 164   PARAMS ((struct bfd_hash_entry *entry,
 165            struct bfd_hash_table *table,
 166            const char *string));
 167
 168 /* Initialize a bfd_link_hash_table.  */
 169 extern boolean _bfd_link_hash_table_init
 170   PARAMS ((struct bfd_link_hash_table *, bfd *,
 171            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 172                                        struct bfd_hash_table *,
 173                                        const char *)));
 174
 175 /* Generic link hash table creation routine.  */
 176 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 177   PARAMS ((bfd *));
 178
 179 /* Generic add symbol routine.  */
 180 extern boolean _bfd_generic_link_add_symbols
 181   PARAMS ((bfd *, struct bfd_link_info *));
 182
 183 /* Generic archive add symbol routine.  */
 184 extern boolean _bfd_generic_link_add_archive_symbols
 185   PARAMS ((bfd *, struct bfd_link_info *,
 186            boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
 187
 188 /* Forward declaration to avoid prototype errors.  */
 189 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 190
 191 /* Generic routine to add a single symbol.  */
 192 extern boolean _bfd_generic_link_add_one_symbol
 193   PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
 194            asection *, bfd_vma, const char *, boolean copy,
 195            struct bfd_link_hash_entry **));
 196
 197 /* Generic link routine.  */
 198 extern boolean _bfd_generic_final_link
 199   PARAMS ((bfd *, struct bfd_link_info *));
 200
 201 /* Default link order processing routine.  */
 202 extern boolean _bfd_default_link_order
 203   PARAMS ((bfd *, struct bfd_link_info *, asection *,
 204            struct bfd_link_order *));
 205
 206 /* Final link relocation routine.  */
 207 extern bfd_reloc_status_type _bfd_final_link_relocate
 208   PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
 209            bfd_vma address, bfd_vma value, bfd_vma addend));
 210
 211 /* Relocate a particular location by a howto and a value.  */
 212 extern bfd_reloc_status_type _bfd_relocate_contents
 213   PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
 214 \f
 215 /* Macros to tell if bfds are read or write enabled.
 216
 217    Note that bfds open for read may be scribbled into if the fd passed
 218    to bfd_fdopenr is actually open both for read and write
 219    simultaneously.  However an output bfd will never be open for
 220    read.  Therefore sometimes you want to check bfd_read_p or
 221    !bfd_read_p, and only sometimes bfd_write_p.
 222 */
 223
 224 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 225 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 226
 227 void    bfd_assert PARAMS ((char*,int));
 228
 229 #define BFD_ASSERT(x) \
 230 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 231
 232 #define BFD_FAIL() \
 233 { bfd_assert(__FILE__,__LINE__); }
 234
 235 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
 236
 237 extern bfd *bfd_last_cache;
 238
 239 /* Now Steve, what's the story here? */
 240 #ifdef lint
 241 #define itos(x) "l"
 242 #define stoi(x) 1
 243 #else
 244 #define itos(x) ((char*)(x))
 245 #define stoi(x) ((int)(x))
 246 #endif
 247
 248 /* Generic routine for close_and_cleanup is really just bfd_true.  */
 249 #define bfd_generic_close_and_cleanup   bfd_true
 250
 251 /* List of supported target vectors, and the default vector (if
 252    default_vector[0] is NULL, there is no default).  */
 253 extern bfd_target *target_vector[];
 254 extern bfd_target *default_vector[];
 255
 256 /* And more follows */
 257
 258 void
 259 bfd_check_init PARAMS ((void));
 260
 261 PTR
 262 bfd_xmalloc  PARAMS ((bfd_size_type size));
 263
 264 PTR
 265 bfd_xmalloc_by_size_t  PARAMS ((size_t size));
 266
 267 void
 268 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 269
 270 unsigned int
 271 bfd_log2 PARAMS ((bfd_vma x));
 272
 273 #define BFD_CACHE_MAX_OPEN 10
 274 extern bfd *bfd_last_cache;
 275
 276 #define bfd_cache_lookup(x) \
 277     ((x)==bfd_last_cache? \
 278       (FILE*)(bfd_last_cache->iostream): \
 279        bfd_cache_lookup_worker(x))
 280 boolean
 281 bfd_cache_close  PARAMS ((bfd *abfd));
 282
 283 FILE*
 284 bfd_open_file PARAMS ((bfd *abfd));
 285
 286 FILE *
 287 bfd_cache_lookup_worker PARAMS ((bfd *abfd));
 288
 289 void
 290 bfd_constructor_entry PARAMS ((bfd *abfd,
 291     asymbol **symbol_ptr_ptr,
 292     CONST char*type));
 293
 294 const struct reloc_howto_struct *
 295 bfd_default_reloc_type_lookup
 296  PARAMS ((bfd *abfd AND
 297     bfd_reloc_code_real_type  code));
 298
 299 boolean
 300 bfd_generic_relax_section
 301  PARAMS ((bfd *abfd,
 302     asection *section,
 303     struct bfd_link_info *,
 304     asymbol **symbols));
 305
 306 bfd_byte *
 307
 308 bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
 309     struct bfd_link_info *link_info,
 310     struct bfd_link_order *link_order,
 311     bfd_byte *data,
 312     boolean relocateable,
 313     asymbol **symbols));
 314
 315 extern bfd_arch_info_type bfd_default_arch_struct;
 316 boolean
 317 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
 318     enum bfd_architecture arch,
 319     unsigned long mach));
 320
 321 void
 322 bfd_arch_init PARAMS ((void));
 323
 324 void
 325 bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
 326
 327 CONST bfd_arch_info_type *
 328 bfd_default_compatible
 329  PARAMS ((CONST bfd_arch_info_type *a,
 330     CONST bfd_arch_info_type *b));
 331
 332 boolean
 333 bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));
 334
 335 struct elf_internal_shdr *
 336 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
 337