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 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
  23 /* Align an address upward to a boundary, expressed as a number of bytes.
  24    E.g. align to an 8-byte boundary with argument of 8.  */
  25 #define BFD_ALIGN(this, boundary) \
  26   ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
  27
  28 /* If you want to read and write large blocks, you might want to do it
  29    in quanta of this amount */
  30 #define DEFAULT_BUFFERSIZE 8192
  31
  32 /* Set a tdata field.  Can't use the other macros for this, since they
  33    do casts, and casting to the left of assignment isn't portable.  */
  34 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
  35
  36 /* tdata for an archive.  For an input archive, cache
  37    needs to be free()'d.  For an output archive, symdefs do.  */
  38
  39 struct artdata {
  40   file_ptr first_file_filepos;
  41   /* Speed up searching the armap */
  42   struct ar_cache *cache;
  43   bfd *archive_head;            /* Only interesting in output routines */
  44   carsym *symdefs;              /* the symdef entries */
  45   symindex symdef_count;             /* how many there are */
  46   char *extended_names;         /* clever intel extension */
  47 };
  48
  49 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  50
  51 /* Goes in bfd's arelt_data slot */
  52 struct areltdata {
  53   char * arch_header;                        /* it's actually a string */
  54   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  55   char *filename;                            /* null-terminated */
  56 };
  57
  58 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  59
  60 char *zalloc PARAMS ((bfd_size_type size));
  61
  62 /* These routines allocate and free things on the BFD's obstack.  Note
  63    that realloc can never occur in place.  */
  64
  65 PTR     bfd_alloc PARAMS ((bfd *abfd, bfd_size_type size));
  66 PTR     bfd_zalloc PARAMS ((bfd *abfd, bfd_size_type size));
  67 PTR     bfd_realloc PARAMS ((bfd *abfd, PTR orig, bfd_size_type new));
  68 void    bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, bfd_size_type size));
  69 PTR     bfd_alloc_finish PARAMS ((bfd *abfd));
  70 PTR     bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
  71
  72 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
  73
  74
  75 bfd_size_type   bfd_read  PARAMS ((PTR ptr, bfd_size_type size,
  76                                    bfd_size_type nitems, bfd *abfd));
  77 bfd_size_type   bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
  78                                    bfd_size_type nitems, bfd *abfd));
  79 int             bfd_seek  PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
  80                                    CONST int direction));
  81 long            bfd_tell  PARAMS ((bfd *abfd));
  82
  83 bfd *   _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
  84 bfd *   look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
  85 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
  86 struct areltdata *      snarf_ar_hdr PARAMS ((bfd *abfd));
  87 bfd_target *            bfd_generic_archive_p PARAMS ((bfd *abfd));
  88 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
  89 #define bfd_slurp_bsd_armap bfd_slurp_armap
  90 #define bfd_slurp_coff_armap bfd_slurp_armap
  91 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
  92 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
  93 bfd *   new_bfd PARAMS (());
  94
  95 #define DEFAULT_STRING_SPACE_SIZE 0x2000
  96 boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
  97                                          unsigned int *table_length,
  98                                          char **free_ptr));
  99 bfd_vma _do_getb64 PARAMS ((unsigned char *addr));
 100 bfd_vma _do_getl64 PARAMS ((unsigned char *addr));
 101 bfd_vma _do_getb32 PARAMS ((unsigned char *addr));
 102 bfd_vma _do_getl32 PARAMS ((unsigned char *addr));
 103 bfd_vma _do_getb16 PARAMS ((unsigned char *addr));
 104 bfd_vma _do_getl16 PARAMS ((unsigned char *addr));
 105 void    _do_putb64 PARAMS ((bfd_vma data, unsigned char *addr));
 106 void    _do_putl64 PARAMS ((bfd_vma data, unsigned char *addr));
 107 void    _do_putb32 PARAMS ((bfd_vma data, unsigned char *addr));
 108 void    _do_putl32 PARAMS ((bfd_vma data, unsigned char *addr));
 109 void    _do_putb16 PARAMS ((bfd_vma data, unsigned char *addr));
 110 void    _do_putl16 PARAMS ((bfd_vma data, unsigned char *addr));
 111
 112 boolean bfd_false PARAMS ((bfd *ignore));
 113 boolean bfd_true PARAMS ((bfd *ignore));
 114 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
 115 int     bfd_0 PARAMS ((bfd *ignore));
 116 unsigned int    bfd_0u PARAMS ((bfd *ignore));
 117 void    bfd_void PARAMS ((bfd *ignore));
 118
 119 bfd *   new_bfd_contained_in PARAMS ((bfd *));
 120 boolean  _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
 121 char *   _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
 122 int      _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
 123 boolean  _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
 124                                                             bfd *exec_bfd));
 125 bfd_target *    _bfd_dummy_target PARAMS ((bfd *abfd));
 126
 127 void    bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 128                                         char *hdr));
 129 void    bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 130                                         char *hdr));
 131 void    bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
 132                                         char *hdr));
 133
 134 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
 135                                   struct orl *map, unsigned int orl_count, int stridx));
 136
 137 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
 138                                    struct orl *map, unsigned int orl_count, int stridx));
 139
 140 bfd *   bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
 141                                                      bfd *last_file));
 142
 143 int     bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
 144
 145 boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 146                                                   PTR location, file_ptr offset,
 147                                                   bfd_size_type count));
 148
 149 boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
 150                                                   PTR location, file_ptr offset,
 151                                                   bfd_size_type count));
 152
 153 /* Macros to tell if bfds are read or write enabled.
 154
 155    Note that bfds open for read may be scribbled into if the fd passed
 156    to bfd_fdopenr is actually open both for read and write
 157    simultaneously.  However an output bfd will never be open for
 158    read.  Therefore sometimes you want to check bfd_read_p or
 159    !bfd_read_p, and only sometimes bfd_write_p.
 160 */
 161
 162 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 163 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 164
 165 void    bfd_assert PARAMS ((char*,int));
 166
 167 #define BFD_ASSERT(x) \
 168 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 169
 170 #define BFD_FAIL() \
 171 { bfd_assert(__FILE__,__LINE__); }
 172
 173 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
 174
 175 extern bfd *bfd_last_cache;
 176
 177 /* Now Steve, what's the story here? */
 178 #ifdef lint
 179 #define itos(x) "l"
 180 #define stoi(x) 1
 181 #else
 182 #define itos(x) ((char*)(x))
 183 #define stoi(x) ((int)(x))
 184 #endif
 185
 186 /* Generic routine for close_and_cleanup is really just bfd_true.  */
 187 #define bfd_generic_close_and_cleanup   bfd_true
 188
 189 /* And more follows */
 190
 191 void
 192 bfd_check_init PARAMS ((void));
 193
 194 PTR
 195 bfd_xmalloc PARAMS (( bfd_size_type size));
 196
 197 void
 198 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 199
 200 bfd_vma
 201 bfd_log2 PARAMS ((bfd_vma x));
 202
 203 void
 204 bfd_check_init PARAMS ((void));
 205
 206 PTR
 207 bfd_xmalloc PARAMS (( bfd_size_type size));
 208
 209 void
 210 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 211
 212 bfd_vma
 213 bfd_log2 PARAMS ((bfd_vma x));
 214
 215 #define BFD_CACHE_MAX_OPEN 10
 216 extern bfd *bfd_last_cache;
 217
 218 #define bfd_cache_lookup(x) \
 219     ((x)==bfd_last_cache? \
 220       (FILE*)(bfd_last_cache->iostream): \
 221        bfd_cache_lookup_worker(x))
 222 void
 223 bfd_cache_init  PARAMS ((bfd *));
 224
 225 boolean
 226 bfd_cache_close  PARAMS ((bfd *));
 227
 228 FILE*
 229 bfd_open_file PARAMS ((bfd *));
 230
 231 FILE *
 232 bfd_cache_lookup_worker PARAMS ((bfd *));
 233
 234 void
 235 bfd_constructor_entry PARAMS ((bfd *abfd,
 236     asymbol **symbol_ptr_ptr,
 237     CONST char*type));
 238
 239 CONST struct reloc_howto_struct *
 240 bfd_default_reloc_type_lookup
 241  PARAMS ((CONST struct bfd_arch_info *,
 242     bfd_reloc_code_real_type  code));
 243
 244 boolean
 245 bfd_generic_relax_section
 246  PARAMS ((bfd *abfd,
 247     asection *section,
 248     asymbol **symbols));
 249
 250 bfd_byte *
 251
 252 bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
 253     struct bfd_seclet *seclet,
 254     bfd_byte *data));
 255
 256 extern bfd_arch_info_type bfd_default_arch_struct;
 257 boolean
 258 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
 259     enum bfd_architecture arch,
 260     unsigned long mach));
 261
 262 void
 263 bfd_arch_init PARAMS ((void));
 264
 265 void
 266 bfd_arch_linkin PARAMS ((bfd_arch_info_type *));
 267
 268 CONST bfd_arch_info_type *
 269 bfd_default_compatible
 270  PARAMS ((CONST bfd_arch_info_type *a,
 271     CONST bfd_arch_info_type *b));
 272
 273 boolean
 274 bfd_default_scan PARAMS ((CONST struct bfd_arch_info *, CONST char *));
 275
 276 struct elf_internal_shdr *
 277 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
 278