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 };
  63
  64 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  65
  66 /* Goes in bfd's arelt_data slot */
  67 struct areltdata {
  68   char * arch_header;                        /* it's actually a string */
  69   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  70   char *filename;                            /* null-terminated */
  71 };
  72
  73 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  74
  75 char *zalloc PARAMS ((bfd_size_type size));
  76
  77 /* These routines allocate and free things on the BFD's obstack.  Note
  78    that realloc can never occur in place.  */
  79
  80 PTR     bfd_alloc PARAMS ((bfd *abfd, size_t size));
  81 PTR     bfd_zalloc PARAMS ((bfd *abfd, size_t size));
  82 PTR     bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
  83 void    bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
  84 PTR     bfd_alloc_finish PARAMS ((bfd *abfd));
  85 PTR     bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
  86
  87 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
  88
  89
  90 bfd_size_type   bfd_read  PARAMS ((PTR ptr, bfd_size_type size,
  91                                    bfd_size_type nitems, bfd *abfd));
  92 bfd_size_type   bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
  93                                    bfd_size_type nitems, bfd *abfd));
  94 int             bfd_seek  PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
  95                                    CONST int direction));
  96 long            bfd_tell  PARAMS ((bfd *abfd));
  97
  98 int             bfd_flush PARAMS ((bfd *abfd));
  99 int             bfd_stat  PARAMS ((bfd *abfd, struct stat *));
 100
 101 bfd *   _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
 102 bfd *   look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
 103 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
 104 struct areltdata *      snarf_ar_hdr PARAMS ((bfd *abfd));
 105 bfd_target *            bfd_generic_archive_p PARAMS ((bfd *abfd));
 106 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
 107 boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
 108 #define bfd_slurp_bsd_armap bfd_slurp_armap
 109 #define bfd_slurp_coff_armap bfd_slurp_armap
 110 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
 111 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
 112 bfd *   new_bfd PARAMS ((void));
 113
 114 #define DEFAULT_STRING_SPACE_SIZE 0x2000
 115 boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
 116                                          unsigned int *table_length,
 117                                          char **free_ptr));
 118
 119 boolean bfd_false PARAMS ((bfd *ignore));
 120 boolean bfd_true PARAMS ((bfd *ignore));
 121 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
 122 int     bfd_0 PARAMS ((bfd *ignore));
 123 unsigned int    bfd_0u PARAMS ((bfd *ignore));
 124 void    bfd_void PARAMS ((bfd *ignore));
 125
 126 bfd *   new_bfd_contained_in PARAMS ((bfd *));
 127 boolean  _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
 128 char *   _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
 129 int      _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
 130 boolean  _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
 131                                                             bfd *exec_bfd));
 132 bfd_target *    _bfd_dummy_target PARAMS ((bfd *abfd));
 133
 134 void    bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 135                                         char *hdr));
 136 void    bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 137                                         char *hdr));
 138 void    bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 139                                         char *hdr));
 140
 141 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
 142                                   struct orl *map, unsigned int orl_count, int stridx));
 143
 144 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
 145                                    struct orl *map, unsigned int orl_count, int stridx));
 146
 147 bfd *   bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
 148                                                      bfd *last_file));
 149
 150 int     bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
 151
 152 boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 153                                                   PTR location, file_ptr offset,
 154                                                   bfd_size_type count));
 155
 156 boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 157                                                   PTR location, file_ptr offset,
 158                                                   bfd_size_type count));
 159 \f
 160 /* A routine to create entries for a bfd_link_hash_table.  */
 161 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 162   PARAMS ((struct bfd_hash_entry *entry,
 163            struct bfd_hash_table *table,
 164            const char *string));
 165
 166 /* Initialize a bfd_link_hash_table.  */
 167 extern boolean _bfd_link_hash_table_init
 168   PARAMS ((struct bfd_link_hash_table *, bfd *,
 169            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 170                                        struct bfd_hash_table *,
 171                                        const char *)));
 172
 173 /* Generic link hash table creation routine.  */
 174 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 175   PARAMS ((bfd *));
 176
 177 /* Generic add symbol routine.  */
 178 extern boolean _bfd_generic_link_add_symbols
 179   PARAMS ((bfd *, struct bfd_link_info *));
 180
 181 /* Generic archive add symbol routine.  */
 182 extern boolean _bfd_generic_link_add_archive_symbols
 183   PARAMS ((bfd *, struct bfd_link_info *,
 184            boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
 185
 186 /* Forward declaration to avoid prototype errors.  */
 187 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 188
 189 /* Generic routine to add a single symbol.  */
 190 extern boolean _bfd_generic_link_add_one_symbol
 191   PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
 192            asection *, bfd_vma, const char *, boolean copy,
 193            struct bfd_link_hash_entry **));
 194
 195 /* Generic link routine.  */
 196 extern boolean _bfd_generic_final_link
 197   PARAMS ((bfd *, struct bfd_link_info *));
 198
 199 /* Default link order processing routine.  */
 200 extern boolean _bfd_default_link_order
 201   PARAMS ((bfd *, struct bfd_link_info *, asection *,
 202            struct bfd_link_order *));
 203
 204 /* Final link relocation routine.  */
 205 extern bfd_reloc_status_type _bfd_final_link_relocate
 206   PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
 207            bfd_vma address, bfd_vma value, bfd_vma addend));
 208
 209 /* Relocate a particular location by a howto and a value.  */
 210 extern bfd_reloc_status_type _bfd_relocate_contents
 211   PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
 212 \f
 213 /* Macros to tell if bfds are read or write enabled.
 214
 215    Note that bfds open for read may be scribbled into if the fd passed
 216    to bfd_fdopenr is actually open both for read and write
 217    simultaneously.  However an output bfd will never be open for
 218    read.  Therefore sometimes you want to check bfd_read_p or
 219    !bfd_read_p, and only sometimes bfd_write_p.
 220 */
 221
 222 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 223 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 224
 225 void    bfd_assert PARAMS ((char*,int));
 226
 227 #define BFD_ASSERT(x) \
 228 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 229
 230 #define BFD_FAIL() \
 231 { bfd_assert(__FILE__,__LINE__); }
 232
 233 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
 234
 235 extern bfd *bfd_last_cache;
 236
 237 /* Now Steve, what's the story here? */
 238 #ifdef lint
 239 #define itos(x) "l"
 240 #define stoi(x) 1
 241 #else
 242 #define itos(x) ((char*)(x))
 243 #define stoi(x) ((int)(x))
 244 #endif
 245
 246 /* Generic routine for close_and_cleanup is really just bfd_true.  */
 247 #define bfd_generic_close_and_cleanup   bfd_true
 248
 249 /* List of supported target vectors, and the default vector (if
 250    default_vector[0] is NULL, there is no default).  */
 251 extern bfd_target *target_vector[];
 252 extern bfd_target *default_vector[];
 253
 254 /* And more follows */
 255
 256 void
 257 bfd_check_init PARAMS ((void));
 258
 259 PTR
 260 bfd_xmalloc  PARAMS ((bfd_size_type size));
 261
 262 PTR
 263 bfd_xmalloc_by_size_t  PARAMS ((size_t size));
 264
 265 void
 266 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 267
 268 unsigned int
 269 bfd_log2 PARAMS ((bfd_vma x));
 270
 271 #define BFD_CACHE_MAX_OPEN 10
 272 extern bfd *bfd_last_cache;
 273
 274 #define bfd_cache_lookup(x) \
 275     ((x)==bfd_last_cache? \
 276       (FILE*)(bfd_last_cache->iostream): \
 277        bfd_cache_lookup_worker(x))
 278 boolean
 279 bfd_cache_close  PARAMS ((bfd *abfd));
 280
 281 FILE*
 282 bfd_open_file PARAMS ((bfd *abfd));
 283
 284 FILE *
 285 bfd_cache_lookup_worker PARAMS ((bfd *abfd));
 286
 287 void
 288 bfd_constructor_entry PARAMS ((bfd *abfd,
 289     asymbol **symbol_ptr_ptr,
 290     CONST char*type));
 291
 292 const struct reloc_howto_struct *
 293 bfd_default_reloc_type_lookup
 294  PARAMS ((bfd *abfd AND
 295     bfd_reloc_code_real_type  code));
 296
 297 boolean
 298 bfd_generic_relax_section
 299  PARAMS ((bfd *abfd,
 300     asection *section,
 301     struct bfd_link_info *,
 302     asymbol **symbols));
 303
 304 bfd_byte *
 305
 306 bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
 307     struct bfd_link_info *link_info,
 308     struct bfd_link_order *link_order,
 309     bfd_byte *data,
 310     boolean relocateable,
 311     asymbol **symbols));
 312
 313 boolean
 314 bfd_generic_seclet_link
 315  PARAMS ((bfd *abfd,
 316     PTR data,
 317     boolean relocateable));
 318
 319 extern bfd_arch_info_type bfd_default_arch_struct;
 320 boolean
 321 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
 322     enum bfd_architecture arch,
 323     unsigned long mach));
 324
 325 void
 326 bfd_arch_init PARAMS ((void));
 327
 328 void
 329 bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
 330
 331 CONST bfd_arch_info_type *
 332 bfd_default_compatible
 333  PARAMS ((CONST bfd_arch_info_type *a,
 334     CONST bfd_arch_info_type *b));
 335
 336 boolean
 337 bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));
 338
 339 struct elf_internal_shdr *
 340 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
 341