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 *bfd_zmalloc 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 *   _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 *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
 115 bfd * _bfd_new_bfd PARAMS ((void));
 116
 117 #define DEFAULT_STRING_SPACE_SIZE 0x2000
 118 boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
 119                                          unsigned int *table_length,
 120                                          char **free_ptr));
 121
 122 boolean bfd_false PARAMS ((bfd *ignore));
 123 boolean bfd_true PARAMS ((bfd *ignore));
 124 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
 125 int     bfd_0 PARAMS ((bfd *ignore));
 126 unsigned int    bfd_0u PARAMS ((bfd *ignore));
 127 void    bfd_void PARAMS ((bfd *ignore));
 128
 129 bfd *   _bfd_new_bfd_contained_in PARAMS ((bfd *));
 130 boolean  _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
 131 char *   _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
 132 int      _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
 133 boolean  _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
 134                                                             bfd *exec_bfd));
 135 bfd_target *    _bfd_dummy_target PARAMS ((bfd *abfd));
 136
 137 void    bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 138                                         char *hdr));
 139 void    bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 140                                         char *hdr));
 141 void    bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 142                                         char *hdr));
 143
 144 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
 145                                   struct orl *map, unsigned int orl_count, int stridx));
 146
 147 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
 148                                    struct orl *map, unsigned int orl_count, int stridx));
 149
 150 bfd *   bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
 151                                                      bfd *last_file));
 152
 153 int     bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
 154
 155 boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 156                                                   PTR location, file_ptr offset,
 157                                                   bfd_size_type count));
 158
 159 boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 160                                                   PTR location, file_ptr offset,
 161                                                   bfd_size_type count));
 162 \f
 163 /* A routine to create entries for a bfd_link_hash_table.  */
 164 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 165   PARAMS ((struct bfd_hash_entry *entry,
 166            struct bfd_hash_table *table,
 167            const char *string));
 168
 169 /* Initialize a bfd_link_hash_table.  */
 170 extern boolean _bfd_link_hash_table_init
 171   PARAMS ((struct bfd_link_hash_table *, bfd *,
 172            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 173                                        struct bfd_hash_table *,
 174                                        const char *)));
 175
 176 /* Generic link hash table creation routine.  */
 177 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 178   PARAMS ((bfd *));
 179
 180 /* Generic add symbol routine.  */
 181 extern boolean _bfd_generic_link_add_symbols
 182   PARAMS ((bfd *, struct bfd_link_info *));
 183
 184 /* Generic archive add symbol routine.  */
 185 extern boolean _bfd_generic_link_add_archive_symbols
 186   PARAMS ((bfd *, struct bfd_link_info *,
 187            boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
 188
 189 /* Forward declaration to avoid prototype errors.  */
 190 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 191
 192 /* Generic routine to add a single symbol.  */
 193 extern boolean _bfd_generic_link_add_one_symbol
 194   PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
 195            asection *, bfd_vma, const char *, boolean copy,
 196            boolean constructor, unsigned int bitsize,
 197            struct bfd_link_hash_entry **));
 198
 199 /* Generic link routine.  */
 200 extern boolean _bfd_generic_final_link
 201   PARAMS ((bfd *, struct bfd_link_info *));
 202
 203 /* Default link order processing routine.  */
 204 extern boolean _bfd_default_link_order
 205   PARAMS ((bfd *, struct bfd_link_info *, asection *,
 206            struct bfd_link_order *));
 207
 208 /* Final link relocation routine.  */
 209 extern bfd_reloc_status_type _bfd_final_link_relocate
 210   PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
 211            bfd_vma address, bfd_vma value, bfd_vma addend));
 212
 213 /* Relocate a particular location by a howto and a value.  */
 214 extern bfd_reloc_status_type _bfd_relocate_contents
 215   PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
 216 \f
 217 /* Macros to tell if bfds are read or write enabled.
 218
 219    Note that bfds open for read may be scribbled into if the fd passed
 220    to bfd_fdopenr is actually open both for read and write
 221    simultaneously.  However an output bfd will never be open for
 222    read.  Therefore sometimes you want to check bfd_read_p or
 223    !bfd_read_p, and only sometimes bfd_write_p.
 224 */
 225
 226 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 227 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 228
 229 void    bfd_assert PARAMS ((char*,int));
 230
 231 #define BFD_ASSERT(x) \
 232 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 233
 234 #define BFD_FAIL() \
 235 { bfd_assert(__FILE__,__LINE__); }
 236
 237 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
 238
 239 extern bfd *bfd_last_cache;
 240
 241 /* Now Steve, what's the story here? */
 242 #ifdef lint
 243 #define itos(x) "l"
 244 #define stoi(x) 1
 245 #else
 246 #define itos(x) ((char*)(x))
 247 #define stoi(x) ((int)(x))
 248 #endif
 249
 250 /* Generic routine for close_and_cleanup is really just bfd_true.  */
 251 #define bfd_generic_close_and_cleanup   bfd_true
 252
 253 /* List of supported target vectors, and the default vector (if
 254    bfd_default_vector[0] is NULL, there is no default).  */
 255 extern bfd_target *bfd_target_vector[];
 256 extern bfd_target *bfd_default_vector[];
 257
 258 /* And more follows */
 259
 260 void
 261 bfd_check_init PARAMS ((void));
 262
 263 PTR
 264 bfd_xmalloc  PARAMS ((bfd_size_type size));
 265
 266 PTR
 267 bfd_xmalloc_by_size_t  PARAMS ((size_t size));
 268
 269 void
 270 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 271
 272 unsigned int
 273 bfd_log2 PARAMS ((bfd_vma x));
 274
 275 #define BFD_CACHE_MAX_OPEN 10
 276 extern bfd *bfd_last_cache;
 277
 278 #define bfd_cache_lookup(x) \
 279     ((x)==bfd_last_cache? \
 280       (FILE*)(bfd_last_cache->iostream): \
 281        bfd_cache_lookup_worker(x))
 282 boolean
 283 bfd_cache_close  PARAMS ((bfd *abfd));
 284
 285 FILE*
 286 bfd_open_file PARAMS ((bfd *abfd));
 287
 288 FILE *
 289 bfd_cache_lookup_worker PARAMS ((bfd *abfd));
 290
 291 void
 292 bfd_constructor_entry PARAMS ((bfd *abfd,
 293     asymbol **symbol_ptr_ptr,
 294     CONST char*type));
 295
 296 const struct reloc_howto_struct *
 297 bfd_default_reloc_type_lookup
 298  PARAMS ((bfd *abfd AND
 299     bfd_reloc_code_real_type  code));
 300
 301 boolean
 302 bfd_generic_relax_section
 303  PARAMS ((bfd *abfd,
 304     asection *section,
 305     struct bfd_link_info *,
 306     asymbol **symbols));
 307
 308 bfd_byte *
 309
 310 bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
 311     struct bfd_link_info *link_info,
 312     struct bfd_link_order *link_order,
 313     bfd_byte *data,
 314     boolean relocateable,
 315     asymbol **symbols));
 316
 317 extern bfd_arch_info_type bfd_default_arch_struct;
 318 boolean
 319 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
 320     enum bfd_architecture arch,
 321     unsigned long mach));
 322
 323 void
 324 bfd_arch_init PARAMS ((void));
 325
 326 void
 327 bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
 328
 329 CONST bfd_arch_info_type *
 330 bfd_default_compatible
 331  PARAMS ((CONST bfd_arch_info_type *a,
 332     CONST bfd_arch_info_type *b));
 333
 334 boolean
 335 bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));
 336
 337 struct elf_internal_shdr *
 338 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
 339