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 /* FIXME -- a lot of my code allocates a large block and subdivides it.
  61    This can't always work, because of alignment restrictions.  We should change
  62    it before it becomes a problem -- Gumby */
  63
  64 PROTO (char *, zalloc, (bfd_size_type size));
  65
  66 /* These routines allocate and free things on the BFD's obstack.  Note
  67    that realloc can never occur in place.  */
  68
  69 PROTO(PTR, bfd_alloc, (bfd *abfd, bfd_size_type size));
  70 PROTO(PTR, bfd_zalloc,(bfd *abfd, bfd_size_type size));
  71 PROTO(PTR, bfd_realloc,(bfd *abfd, PTR orig, bfd_size_type new));
  72 PROTO(void, bfd_alloc_grow,(bfd *abfd, PTR thing, bfd_size_type size));
  73 PROTO(PTR, bfd_alloc_finish,(bfd *abfd));
  74 PROTO(PTR, bfd_alloc_by_size_t,(bfd *abfd, size_t wanted));
  75
  76 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
  77
  78
  79 PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
  80 PROTO (bfd_size_type, bfd_write, (CONST PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
  81
  82
  83
  84 PROTO (int, bfd_seek,(bfd* CONST abfd, CONST file_ptr fp , CONST int direction));
  85 PROTO (long, bfd_tell, (bfd *abfd));
  86 PROTO (bfd *, _bfd_create_empty_archive_element_shell, (bfd *obfd));
  87 PROTO (bfd *, look_for_bfd_in_cache, (bfd *arch_bfd, file_ptr index));
  88 PROTO (boolean, _bfd_generic_mkarchive, (bfd *abfd));
  89 PROTO (struct areltdata *, snarf_ar_hdr, (bfd *abfd));
  90 PROTO (bfd_target *, bfd_generic_archive_p, (bfd *abfd));
  91 PROTO (boolean, bfd_slurp_bsd_armap, (bfd *abfd));
  92 PROTO (boolean, bfd_slurp_coff_armap, (bfd *abfd));
  93 PROTO (boolean, _bfd_slurp_extended_name_table, (bfd *abfd));
  94 PROTO (boolean, _bfd_write_archive_contents, (bfd *abfd));
  95 PROTO (bfd *, new_bfd, ());
  96
  97 #define DEFAULT_STRING_SPACE_SIZE 0x2000
  98 PROTO (boolean, bfd_add_to_string_table, (char **table, char *new_string,
  99                                           unsigned int *table_length,
 100                                           char **free_ptr));
 101 PROTO (bfd_vma, _do_getb64, (unsigned char *addr));
 102 PROTO (bfd_vma, _do_getl64, (unsigned char *addr));
 103 PROTO (bfd_vma, _do_getb32, (unsigned char *addr));
 104 PROTO (bfd_vma, _do_getl32, (unsigned char *addr));
 105 PROTO (bfd_vma, _do_getb16, (unsigned char *addr));
 106 PROTO (bfd_vma, _do_getl16, (unsigned char *addr));
 107 PROTO (void, _do_putb64, (bfd_vma data, unsigned char *addr));
 108 PROTO (void, _do_putl64, (bfd_vma data, unsigned char *addr));
 109 PROTO (void, _do_putb32, (bfd_vma data, unsigned char *addr));
 110 PROTO (void, _do_putl32, (bfd_vma data, unsigned char *addr));
 111 PROTO (void, _do_putb16, (bfd_vma data, unsigned char *addr));
 112 PROTO (void, _do_putl16, (bfd_vma data, unsigned char *addr));
 113
 114 PROTO (boolean, bfd_false, (bfd *ignore));
 115 PROTO (boolean, bfd_true, (bfd *ignore));
 116 PROTO (PTR, bfd_nullvoidptr, (bfd *ignore));
 117 PROTO (int, bfd_0, (bfd *ignore));
 118 PROTO (unsigned int, bfd_0u, (bfd *ignore));
 119 PROTO (void, bfd_void, (bfd *ignore));
 120
 121 PROTO (bfd *,new_bfd_contained_in,(bfd *));
 122 PROTO (boolean, _bfd_dummy_new_section_hook, (bfd *ignore, asection *newsect));
 123 PROTO (char *, _bfd_dummy_core_file_failing_command, (bfd *abfd));
 124 PROTO (int, _bfd_dummy_core_file_failing_signal, (bfd *abfd));
 125 PROTO (boolean, _bfd_dummy_core_file_matches_executable_p, (bfd *core_bfd,
 126                                                             bfd *exec_bfd));
 127 PROTO (bfd_target *, _bfd_dummy_target, (bfd *abfd));
 128
 129 PROTO (void, bfd_dont_truncate_arname, (bfd *abfd, CONST char *filename,
 130                                         char *hdr));
 131 PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, CONST char *filename,
 132                                         char *hdr));
 133 PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, CONST char *filename,
 134                                         char *hdr));
 135
 136 PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength,
 137                                   struct orl *map, unsigned int orl_count, int stridx));
 138
 139 PROTO (boolean, coff_write_armap, (bfd *arch, unsigned int elength,
 140                                    struct orl *map, unsigned int orl_count, int stridx));
 141
 142 PROTO (bfd *, bfd_generic_openr_next_archived_file, (bfd *archive,
 143                                                      bfd *last_file));
 144
 145 PROTO(int, bfd_generic_stat_arch_elt, (bfd *, struct stat *));
 146
 147 PROTO(boolean, bfd_generic_get_section_contents,
 148       (bfd *abfd, sec_ptr section, PTR location, file_ptr offset,
 149        bfd_size_type count));
 150
 151 PROTO(boolean, bfd_generic_set_section_contents,
 152       (bfd *abfd, sec_ptr section, PTR location, file_ptr offset,
 153        bfd_size_type count));
 154
 155 /* Macros to tell if bfds are read or write enabled.
 156
 157    Note that bfds open for read may be scribbled into if the fd passed
 158    to bfd_fdopenr is actually open both for read and write
 159    simultaneously.  However an output bfd will never be open for
 160    read.  Therefore sometimes you want to check bfd_read_p or
 161    !bfd_read_p, and only sometimes bfd_write_p.
 162 */
 163
 164 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 165 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 166
 167 PROTO (void, bfd_assert,(char*,int));
 168 #define BFD_ASSERT(x) \
 169 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 170
 171 #define BFD_FAIL() \
 172 { bfd_assert(__FILE__,__LINE__); }
 173
 174 PROTO (FILE *, bfd_cache_lookup_worker, (bfd *));
 175
 176 extern bfd *bfd_last_cache;
 177
 178 /* Now Steve, what's the story here? */
 179 #ifdef lint
 180 #define itos(x) "l"
 181 #define stoi(x) 1
 182 #else
 183 #define itos(x) ((char*)(x))
 184 #define stoi(x) ((int)(x))
 185 #endif
 186
 187 /* Generic routine for close_and_cleanup is really just bfd_true.  */
 188 #define bfd_generic_close_and_cleanup   bfd_true
 189
 190 /* And more follows */
 191
 192 void
 193 bfd_check_init PARAMS ((void));
 194
 195 PTR
 196 bfd_xmalloc PARAMS (( bfd_size_type size));
 197
 198 void
 199 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 200
 201 bfd_vma
 202 bfd_log2 PARAMS ((bfd_vma x));
 203
 204 void
 205 bfd_check_init PARAMS ((void));
 206
 207 PTR
 208 bfd_xmalloc PARAMS (( bfd_size_type size));
 209
 210 void
 211 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
 212
 213 bfd_vma
 214 bfd_log2 PARAMS ((bfd_vma x));
 215
 216 #define BFD_CACHE_MAX_OPEN 10
 217 extern bfd *bfd_last_cache;
 218
 219 #define bfd_cache_lookup(x) \
 220     ((x)==bfd_last_cache? \
 221       (FILE*)(bfd_last_cache->iostream): \
 222        bfd_cache_lookup_worker(x))
 223 void
 224 bfd_cache_init  PARAMS ((bfd *));
 225
 226 boolean
 227 bfd_cache_close  PARAMS ((bfd *));
 228
 229 FILE*
 230 bfd_open_file PARAMS ((bfd *));
 231
 232 FILE *
 233 bfd_cache_lookup_worker PARAMS ((bfd *));
 234
 235 void
 236 bfd_constructor_entry PARAMS ((bfd *abfd,
 237     asymbol **symbol_ptr_ptr,
 238     CONST char*type));
 239
 240 CONST struct reloc_howto_struct *
 241 bfd_default_reloc_type_lookup
 242  PARAMS ((CONST struct bfd_arch_info *,
 243     bfd_reloc_code_real_type  code));
 244
 245 boolean
 246 bfd_generic_relax_section
 247  PARAMS ((bfd *abfd,
 248     asection *section,
 249     asymbol **symbols));
 250
 251 bfd_byte *
 252
 253 bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
 254     struct bfd_seclet_struct  *seclet,
 255     bfd_byte *data)
 256
 257     );
 258
 259 extern bfd_arch_info_type bfd_default_arch_struct;
 260 boolean
 261 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
 262     enum bfd_architecture arch,
 263     unsigned long mach));
 264
 265 void
 266 bfd_arch_init PARAMS ((void));
 267
 268 void
 269 bfd_arch_linkin PARAMS ((bfd_arch_info_type *));
 270
 271 CONST bfd_arch_info_type *
 272 bfd_default_compatible
 273  PARAMS ((CONST bfd_arch_info_type *a,
 274     CONST bfd_arch_info_type *b));
 275
 276 boolean
 277 bfd_default_scan PARAMS ((CONST struct bfd_arch_info *, CONST char *));
 278
 279 struct elf_internal_shdr *
 280 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
 281