bfd/libbfd-in.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 /* Align an address upward to a boundary, expressed as a number of bytes.
  23    E.g. align to an 8-byte boundary with argument of 8.  */
  24 #define BFD_ALIGN(this, boundary) \
  25   ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
  26
  27 /* If you want to read and write large blocks, you might want to do it
  28    in quanta of this amount */
  29 #define DEFAULT_BUFFERSIZE 8192
  30
  31 /* Set a tdata field.  Can't use the other macros for this, since they
  32    do casts, and casting to the left of assignment isn't portable.  */
  33 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
  34
  35 /* tdata for an archive.  For an input archive, cache
  36    needs to be free()'d.  For an output archive, symdefs do.  */
  37
  38 struct artdata {
  39   file_ptr first_file_filepos;
  40   /* Speed up searching the armap */
  41   struct ar_cache *cache;
  42   bfd *archive_head;            /* Only interesting in output routines */
  43   carsym *symdefs;              /* the symdef entries */
  44   symindex symdef_count;             /* how many there are */
  45   char *extended_names;         /* clever intel extension */
  46   /* when more compilers are standard C, this can be a time_t */
  47   long  armap_timestamp;        /* Timestamp value written into armap.
  48                                    This is used for BSD archives to check
  49                                    that the timestamp is recent enough
  50                                    for the BSD linker to not complain,
  51                                    just before we finish writing an
  52                                    archive.  */
  53   file_ptr armap_datepos;       /* Position within archive to seek to
  54                                    rewrite the date field.  */
  55   PTR tdata;                    /* Backend specific information.  */
  56 };
  57
  58 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  59
  60 /* Goes in bfd's arelt_data slot */
  61 struct areltdata {
  62   char * arch_header;                        /* it's actually a string */
  63   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  64   char *filename;                            /* null-terminated */
  65 };
  66
  67 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  68
  69 char *bfd_zmalloc PARAMS ((bfd_size_type size));
  70
  71 /* These routines allocate and free things on the BFD's obstack.  Note
  72    that realloc can never occur in place.  */
  73
  74 PTR     bfd_alloc PARAMS ((bfd *abfd, size_t size));
  75 PTR     bfd_zalloc PARAMS ((bfd *abfd, size_t size));
  76 PTR     bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
  77 void    bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
  78 PTR     bfd_alloc_finish PARAMS ((bfd *abfd));
  79 PTR     bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
  80
  81 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
  82
  83
  84 bfd_size_type   bfd_read  PARAMS ((PTR ptr, bfd_size_type size,
  85                                    bfd_size_type nitems, bfd *abfd));
  86 bfd_size_type   bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
  87                                    bfd_size_type nitems, bfd *abfd));
  88 int             bfd_seek  PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
  89                                    CONST int direction));
  90 long            bfd_tell  PARAMS ((bfd *abfd));
  91
  92 int             bfd_flush PARAMS ((bfd *abfd));
  93 int             bfd_stat  PARAMS ((bfd *abfd, struct stat *));
  94
  95 bfd *   _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
  96 bfd *   _bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
  97 boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
  98 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
  99 struct areltdata *      _bfd_snarf_ar_hdr PARAMS ((bfd *abfd));
 100 bfd_target *            bfd_generic_archive_p PARAMS ((bfd *abfd));
 101 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
 102 boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
 103 #define bfd_slurp_bsd_armap bfd_slurp_armap
 104 #define bfd_slurp_coff_armap bfd_slurp_armap
 105 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
 106 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
 107 bfd *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
 108 bfd * _bfd_new_bfd PARAMS ((void));
 109
 110 #define DEFAULT_STRING_SPACE_SIZE 0x2000
 111 boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
 112                                          unsigned int *table_length,
 113                                          char **free_ptr));
 114
 115 boolean bfd_false PARAMS ((bfd *ignore));
 116 boolean bfd_true PARAMS ((bfd *ignore));
 117 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
 118 int     bfd_0 PARAMS ((bfd *ignore));
 119 unsigned int    bfd_0u PARAMS ((bfd *ignore));
 120 long    bfd_0l PARAMS ((bfd *ignore));
 121 long    _bfd_n1 PARAMS ((bfd *ignore));
 122 void    bfd_void PARAMS ((bfd *ignore));
 123
 124 bfd *   _bfd_new_bfd_contained_in PARAMS ((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 \f
 146 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
 147    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
 148
 149 #define _bfd_generic_close_and_cleanup bfd_true
 150 #define _bfd_generic_bfd_free_cached_info bfd_true
 151 #define _bfd_generic_new_section_hook \
 152   ((boolean (*) PARAMS ((bfd *, asection *))) bfd_true)
 153 extern boolean _bfd_generic_get_section_contents
 154   PARAMS ((bfd *, asection *, PTR location, file_ptr offset,
 155            bfd_size_type count));
 156
 157 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 158    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 159
 160 #define _bfd_generic_bfd_copy_private_bfd_data \
 161   ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
 162 #define _bfd_generic_bfd_copy_private_section_data \
 163   ((boolean (*) PARAMS ((bfd *, asection *, bfd *, asection *))) bfd_true)
 164
 165 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 166    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 167
 168 extern char *_bfd_nocore_core_file_failing_command PARAMS ((bfd *));
 169 extern int _bfd_nocore_core_file_failing_signal PARAMS ((bfd *));
 170 extern boolean _bfd_nocore_core_file_matches_executable_p
 171   PARAMS ((bfd *, bfd *));
 172
 173 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
 174    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
 175
 176 #define _bfd_noarchive_slurp_armap bfd_false
 177 #define _bfd_noarchive_slurp_extended_name_table bfd_false
 178 #define _bfd_noarchive_truncate_arname \
 179   ((void (*) PARAMS ((bfd *, const char *, char *))) bfd_void)
 180 #define _bfd_noarchive_write_armap \
 181   ((boolean (*) \
 182     PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int))) \
 183    bfd_false)
 184 #define _bfd_noarchive_openr_next_archived_file \
 185   ((bfd *(*) PARAMS ((bfd *, bfd *))) bfd_nullvoidptr)
 186 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
 187
 188 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
 189    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
 190
 191 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
 192 #define _bfd_archive_bsd_slurp_extended_name_table \
 193   _bfd_slurp_extended_name_table
 194 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
 195 #define _bfd_archive_bsd_write_armap bsd_write_armap
 196 #define _bfd_archive_bsd_openr_next_archived_file \
 197   bfd_generic_openr_next_archived_file
 198 #define _bfd_archive_bsd_generic_stat_arch_elt \
 199   bfd_generic_stat_arch_elt
 200
 201 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
 202    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
 203
 204 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
 205 #define _bfd_archive_coff_slurp_extended_name_table \
 206   _bfd_slurp_extended_name_table
 207 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
 208 #define _bfd_archive_coff_write_armap coff_write_armap
 209 #define _bfd_archive_coff_openr_next_archived_file \
 210   bfd_generic_openr_next_archived_file
 211 #define _bfd_archive_coff_generic_stat_arch_elt \
 212   bfd_generic_stat_arch_elt
 213
 214 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
 215    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 216
 217 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
 218 #define _bfd_nosymbols_get_symtab \
 219   ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
 220 #define _bfd_nosymbols_make_empty_symbol \
 221   ((asymbol *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
 222 #define _bfd_nosymbols_print_symbol \
 223   ((void (*) PARAMS ((bfd *, PTR, asymbol *, bfd_print_symbol_type))) bfd_void)
 224 #define _bfd_nosymbols_get_symbol_info \
 225   ((void (*) PARAMS ((bfd *, asymbol *, symbol_info *))) bfd_void)
 226 #define _bfd_nosymbols_bfd_is_local_label \
 227   ((boolean (*) PARAMS ((bfd *, asymbol *))) bfd_false)
 228 #define _bfd_nosymbols_get_lineno \
 229   ((alent *(*) PARAMS ((bfd *, asymbol *))) bfd_nullvoidptr)
 230 #define _bfd_nosymbols_find_nearest_line \
 231   ((boolean (*) \
 232     PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **, \
 233              const char **, unsigned int *))) \
 234    bfd_false)
 235 #define _bfd_nosymbols_bfd_make_debug_symbol \
 236   ((asymbol *(*) PARAMS ((bfd *, PTR, unsigned long))) bfd_nullvoidptr)
 237
 238 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 239    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 240
 241 #define _bfd_norelocs_get_reloc_upper_bound \
 242   ((long (*) PARAMS ((bfd *, asection *))) _bfd_n1)
 243 #define _bfd_norelocs_canonicalize_reloc \
 244   ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) _bfd_n1)
 245 #define _bfd_norelocs_bfd_reloc_type_lookup \
 246   ((const reloc_howto_type *(*) PARAMS ((bfd *, bfd_reloc_code_real_type))) \
 247    bfd_nullvoidptr)
 248
 249 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 250    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 251
 252 #define _bfd_nowrite_set_arch_mach \
 253   ((boolean (*) PARAMS ((bfd *, enum bfd_architecture, unsigned long))) \
 254    bfd_false)
 255 #define _bfd_nowrite_set_section_contents \
 256   ((boolean (*) PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type))) \
 257    bfd_false)
 258
 259 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 260    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 261
 262 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 263 extern boolean _bfd_generic_set_section_contents
 264   PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
 265
 266 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 267    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 268
 269 #define _bfd_nolink_sizeof_headers ((int (*) PARAMS ((bfd *, boolean))) bfd_0)
 270 #define _bfd_nolink_bfd_get_relocated_section_contents \
 271   ((bfd_byte *(*) \
 272     PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 273              bfd_byte *, boolean, asymbol **))) \
 274    bfd_nullvoidptr)
 275 #define _bfd_nolink_bfd_relax_section \
 276   ((boolean (*) \
 277     PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *))) \
 278    bfd_false)
 279 #define _bfd_nolink_bfd_link_hash_table_create \
 280   ((struct bfd_link_hash_table *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
 281 #define _bfd_nolink_bfd_link_add_symbols \
 282   ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
 283 #define _bfd_nolink_bfd_final_link \
 284   ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
 285 \f
 286 /* Generic routine to determine of the given symbol is a local
 287    label.  */
 288 extern boolean bfd_generic_is_local_label PARAMS ((bfd *, asymbol *));
 289
 290 /* A routine to create entries for a bfd_link_hash_table.  */
 291 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 292   PARAMS ((struct bfd_hash_entry *entry,
 293            struct bfd_hash_table *table,
 294            const char *string));
 295
 296 /* Initialize a bfd_link_hash_table.  */
 297 extern boolean _bfd_link_hash_table_init
 298   PARAMS ((struct bfd_link_hash_table *, bfd *,
 299            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 300                                        struct bfd_hash_table *,
 301                                        const char *)));
 302
 303 /* Generic link hash table creation routine.  */
 304 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 305   PARAMS ((bfd *));
 306
 307 /* Generic add symbol routine.  */
 308 extern boolean _bfd_generic_link_add_symbols
 309   PARAMS ((bfd *, struct bfd_link_info *));
 310
 311 /* Generic add symbol routine.  This version is used by targets for
 312    which the linker must collect constructors and destructors by name,
 313    as the collect2 program does.  */
 314 extern boolean _bfd_generic_link_add_symbols_collect
 315   PARAMS ((bfd *, struct bfd_link_info *));
 316
 317 /* Generic archive add symbol routine.  */
 318 extern boolean _bfd_generic_link_add_archive_symbols
 319   PARAMS ((bfd *, struct bfd_link_info *,
 320            boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
 321
 322 /* Forward declaration to avoid prototype errors.  */
 323 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 324
 325 /* Generic routine to add a single symbol.  */
 326 extern boolean _bfd_generic_link_add_one_symbol
 327   PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
 328            asection *, bfd_vma, const char *, boolean copy,
 329            boolean constructor, struct bfd_link_hash_entry **));
 330
 331 /* Generic link routine.  */
 332 extern boolean _bfd_generic_final_link
 333   PARAMS ((bfd *, struct bfd_link_info *));
 334
 335 /* Generic reloc_link_order processing routine.  */
 336 extern boolean _bfd_generic_reloc_link_order
 337   PARAMS ((bfd *, struct bfd_link_info *, asection *,
 338            struct bfd_link_order *));
 339
 340 /* Default link order processing routine.  */
 341 extern boolean _bfd_default_link_order
 342   PARAMS ((bfd *, struct bfd_link_info *, asection *,
 343            struct bfd_link_order *));
 344
 345 /* Count the number of reloc entries in a link order list.  */
 346 extern unsigned int _bfd_count_link_order_relocs
 347   PARAMS ((struct bfd_link_order *));
 348
 349 /* Final link relocation routine.  */
 350 extern bfd_reloc_status_type _bfd_final_link_relocate
 351   PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
 352            bfd_vma address, bfd_vma value, bfd_vma addend));
 353
 354 /* Relocate a particular location by a howto and a value.  */
 355 extern bfd_reloc_status_type _bfd_relocate_contents
 356   PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
 357 \f
 358 /* Macros to tell if bfds are read or write enabled.
 359
 360    Note that bfds open for read may be scribbled into if the fd passed
 361    to bfd_fdopenr is actually open both for read and write
 362    simultaneously.  However an output bfd will never be open for
 363    read.  Therefore sometimes you want to check bfd_read_p or
 364    !bfd_read_p, and only sometimes bfd_write_p.
 365 */
 366
 367 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 368 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 369
 370 void    bfd_assert PARAMS ((char*,int));
 371
 372 #define BFD_ASSERT(x) \
 373 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
 374
 375 #define BFD_FAIL() \
 376 { bfd_assert(__FILE__,__LINE__); }
 377
 378 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
 379
 380 extern bfd *bfd_last_cache;
 381
 382 /* Now Steve, what's the story here? */
 383 #ifdef lint
 384 #define itos(x) "l"
 385 #define stoi(x) 1
 386 #else
 387 #define itos(x) ((char*)(x))
 388 #define stoi(x) ((int)(x))
 389 #endif
 390
 391 /* List of supported target vectors, and the default vector (if
 392    bfd_default_vector[0] is NULL, there is no default).  */
 393 extern bfd_target *bfd_target_vector[];
 394 extern bfd_target *bfd_default_vector[];
 395
 396 /* And more follows */
 397