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
   4    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   5    1999, 2000, 2001, 2002, 2003, 2004, 2005
   6    Free Software Foundation, Inc.
   7
   8    Written by Cygnus Support.
   9
  10 This file is part of BFD, the Binary File Descriptor library.
  11
  12 This program is free software; you can redistribute it and/or modify
  13 it under the terms of the GNU General Public License as published by
  14 the Free Software Foundation; either version 2 of the License, or
  15 (at your option) any later version.
  16
  17 This program is distributed in the hope that it will be useful,
  18 but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 GNU General Public License for more details.
  21
  22 You should have received a copy of the GNU General Public License
  23 along with this program; if not, write to the Free Software
  24 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
  25
  26 #include "hashtab.h"
  27
  28 /* Align an address upward to a boundary, expressed as a number of bytes.
  29    E.g. align to an 8-byte boundary with argument of 8.  Take care never
  30    to wrap around if the address is within boundary-1 of the end of the
  31    address space.  */
  32 #define BFD_ALIGN(this, boundary)                                         \
  33   ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this))              \
  34    ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
  35    : ~ (bfd_vma) 0)
  36
  37 /* If you want to read and write large blocks, you might want to do it
  38    in quanta of this amount */
  39 #define DEFAULT_BUFFERSIZE 8192
  40
  41 /* Set a tdata field.  Can't use the other macros for this, since they
  42    do casts, and casting to the left of assignment isn't portable.  */
  43 #define set_tdata(bfd, v) ((bfd)->tdata.any = (v))
  44
  45 /* If BFD_IN_MEMORY is set for a BFD, then the iostream fields points
  46    to an instance of this structure.  */
  47
  48 struct bfd_in_memory
  49 {
  50   /* Size of buffer.  */
  51   bfd_size_type size;
  52   /* Buffer holding contents of BFD.  */
  53   bfd_byte *buffer;
  54 };
  55
  56 /* tdata for an archive.  For an input archive, cache
  57    needs to be free()'d.  For an output archive, symdefs do.  */
  58
  59 struct artdata {
  60   file_ptr first_file_filepos;
  61   /* Speed up searching the armap */
  62   htab_t cache;
  63   bfd *archive_head;            /* Only interesting in output routines */
  64   carsym *symdefs;              /* the symdef entries */
  65   symindex symdef_count;        /* how many there are */
  66   char *extended_names;         /* clever intel extension */
  67   /* when more compilers are standard C, this can be a time_t */
  68   long  armap_timestamp;        /* Timestamp value written into armap.
  69                                    This is used for BSD archives to check
  70                                    that the timestamp is recent enough
  71                                    for the BSD linker to not complain,
  72                                    just before we finish writing an
  73                                    archive.  */
  74   file_ptr armap_datepos;       /* Position within archive to seek to
  75                                    rewrite the date field.  */
  76   void *tdata;                  /* Backend specific information.  */
  77 };
  78
  79 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  80
  81 /* Goes in bfd's arelt_data slot */
  82 struct areltdata {
  83   char * arch_header;           /* it's actually a string */
  84   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
  85   char *filename;               /* null-terminated */
  86 };
  87
  88 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  89
  90 extern void *bfd_malloc
  91   (bfd_size_type);
  92 extern void *bfd_realloc
  93   (void *, bfd_size_type);
  94 extern void *bfd_zmalloc
  95   (bfd_size_type);
  96
  97 extern void _bfd_default_error_handler (const char *s, ...);
  98 extern bfd_error_handler_type _bfd_error_handler;
  99
 100 /* These routines allocate and free things on the BFD's objalloc.  */
 101
 102 extern void *bfd_alloc
 103   (bfd *, bfd_size_type);
 104 extern void *bfd_zalloc
 105   (bfd *, bfd_size_type);
 106 extern void bfd_release
 107   (bfd *, void *);
 108
 109 bfd * _bfd_create_empty_archive_element_shell
 110   (bfd *obfd);
 111 bfd * _bfd_look_for_bfd_in_cache
 112   (bfd *, file_ptr);
 113 bfd_boolean _bfd_add_bfd_to_archive_cache
 114   (bfd *, file_ptr, bfd *);
 115 bfd_boolean _bfd_generic_mkarchive
 116   (bfd *abfd);
 117 const bfd_target *bfd_generic_archive_p
 118   (bfd *abfd);
 119 bfd_boolean bfd_slurp_armap
 120   (bfd *abfd);
 121 bfd_boolean bfd_slurp_bsd_armap_f2
 122   (bfd *abfd);
 123 #define bfd_slurp_bsd_armap bfd_slurp_armap
 124 #define bfd_slurp_coff_armap bfd_slurp_armap
 125 bfd_boolean _bfd_slurp_extended_name_table
 126   (bfd *abfd);
 127 extern bfd_boolean _bfd_construct_extended_name_table
 128   (bfd *, bfd_boolean, char **, bfd_size_type *);
 129 bfd_boolean _bfd_write_archive_contents
 130   (bfd *abfd);
 131 bfd_boolean _bfd_compute_and_write_armap
 132   (bfd *, unsigned int elength);
 133 bfd *_bfd_get_elt_at_filepos
 134   (bfd *archive, file_ptr filepos);
 135 extern bfd *_bfd_generic_get_elt_at_index
 136   (bfd *, symindex);
 137 bfd * _bfd_new_bfd
 138   (void);
 139 void _bfd_delete_bfd
 140   (bfd *);
 141
 142 bfd_boolean bfd_false
 143   (bfd *ignore);
 144 bfd_boolean bfd_true
 145   (bfd *ignore);
 146 void *bfd_nullvoidptr
 147   (bfd *ignore);
 148 int bfd_0
 149   (bfd *ignore);
 150 unsigned int bfd_0u
 151   (bfd *ignore);
 152 long bfd_0l
 153   (bfd *ignore);
 154 long _bfd_n1
 155   (bfd *ignore);
 156 void bfd_void
 157   (bfd *ignore);
 158
 159 bfd *_bfd_new_bfd_contained_in
 160   (bfd *);
 161 const bfd_target *_bfd_dummy_target
 162   (bfd *abfd);
 163
 164 void bfd_dont_truncate_arname
 165   (bfd *abfd, const char *filename, char *hdr);
 166 void bfd_bsd_truncate_arname
 167   (bfd *abfd, const char *filename, char *hdr);
 168 void bfd_gnu_truncate_arname
 169   (bfd *abfd, const char *filename, char *hdr);
 170
 171 bfd_boolean bsd_write_armap
 172   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 173    int stridx);
 174
 175 bfd_boolean coff_write_armap
 176   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 177    int stridx);
 178
 179 extern void *_bfd_generic_read_ar_hdr
 180   (bfd *);
 181 extern void _bfd_ar_spacepad
 182   (char *, size_t, const char *, long);
 183
 184 extern void *_bfd_generic_read_ar_hdr_mag
 185   (bfd *, const char *);
 186
 187 bfd * bfd_generic_openr_next_archived_file
 188   (bfd *archive, bfd *last_file);
 189
 190 int bfd_generic_stat_arch_elt
 191   (bfd *, struct stat *);
 192
 193 #define _bfd_read_ar_hdr(abfd) \
 194   BFD_SEND (abfd, _bfd_read_ar_hdr_fn, (abfd))
 195 \f
 196 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
 197    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
 198
 199 #define _bfd_generic_close_and_cleanup bfd_true
 200 #define _bfd_generic_bfd_free_cached_info bfd_true
 201 #define _bfd_generic_new_section_hook \
 202   ((bfd_boolean (*) (bfd *, asection *)) bfd_true)
 203 extern bfd_boolean _bfd_generic_get_section_contents
 204   (bfd *, asection *, void *, file_ptr, bfd_size_type);
 205 extern bfd_boolean _bfd_generic_get_section_contents_in_window
 206   (bfd *, asection *, bfd_window *, file_ptr, bfd_size_type);
 207
 208 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 209    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 210
 211 #define _bfd_generic_bfd_copy_private_bfd_data \
 212   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 213 #define _bfd_generic_bfd_merge_private_bfd_data \
 214   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 215 #define _bfd_generic_bfd_set_private_flags \
 216   ((bfd_boolean (*) (bfd *, flagword)) bfd_true)
 217 #define _bfd_generic_bfd_copy_private_section_data \
 218   ((bfd_boolean (*) (bfd *, asection *, bfd *, asection *)) bfd_true)
 219 #define _bfd_generic_bfd_copy_private_symbol_data \
 220   ((bfd_boolean (*) (bfd *, asymbol *, bfd *, asymbol *)) bfd_true)
 221 #define _bfd_generic_bfd_copy_private_header_data \
 222   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 223 #define _bfd_generic_bfd_print_private_bfd_data \
 224   ((bfd_boolean (*) (bfd *, void *)) bfd_true)
 225
 226 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 227    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 228
 229 extern char *_bfd_nocore_core_file_failing_command
 230   (bfd *);
 231 extern int _bfd_nocore_core_file_failing_signal
 232   (bfd *);
 233 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
 234   (bfd *, bfd *);
 235
 236 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
 237    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
 238
 239 #define _bfd_noarchive_slurp_armap bfd_false
 240 #define _bfd_noarchive_slurp_extended_name_table bfd_false
 241 #define _bfd_noarchive_construct_extended_name_table \
 242   ((bfd_boolean (*) (bfd *, char **, bfd_size_type *, const char **)) \
 243    bfd_false)
 244 #define _bfd_noarchive_truncate_arname \
 245   ((void (*) (bfd *, const char *, char *)) bfd_void)
 246 #define _bfd_noarchive_write_armap \
 247   ((bfd_boolean (*) (bfd *, unsigned int, struct orl *, unsigned int, int)) \
 248    bfd_false)
 249 #define _bfd_noarchive_read_ar_hdr bfd_nullvoidptr
 250 #define _bfd_noarchive_openr_next_archived_file \
 251   ((bfd *(*) (bfd *, bfd *)) bfd_nullvoidptr)
 252 #define _bfd_noarchive_get_elt_at_index \
 253   ((bfd *(*) (bfd *, symindex)) bfd_nullvoidptr)
 254 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
 255 #define _bfd_noarchive_update_armap_timestamp bfd_false
 256
 257 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
 258    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
 259
 260 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
 261 #define _bfd_archive_bsd_slurp_extended_name_table \
 262   _bfd_slurp_extended_name_table
 263 extern bfd_boolean _bfd_archive_bsd_construct_extended_name_table
 264   (bfd *, char **, bfd_size_type *, const char **);
 265 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
 266 #define _bfd_archive_bsd_write_armap bsd_write_armap
 267 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
 268 #define _bfd_archive_bsd_openr_next_archived_file \
 269   bfd_generic_openr_next_archived_file
 270 #define _bfd_archive_bsd_get_elt_at_index _bfd_generic_get_elt_at_index
 271 #define _bfd_archive_bsd_generic_stat_arch_elt \
 272   bfd_generic_stat_arch_elt
 273 extern bfd_boolean _bfd_archive_bsd_update_armap_timestamp
 274   (bfd *);
 275
 276 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
 277    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
 278
 279 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
 280 #define _bfd_archive_coff_slurp_extended_name_table \
 281   _bfd_slurp_extended_name_table
 282 extern bfd_boolean _bfd_archive_coff_construct_extended_name_table
 283   (bfd *, char **, bfd_size_type *, const char **);
 284 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
 285 #define _bfd_archive_coff_write_armap coff_write_armap
 286 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
 287 #define _bfd_archive_coff_openr_next_archived_file \
 288   bfd_generic_openr_next_archived_file
 289 #define _bfd_archive_coff_get_elt_at_index _bfd_generic_get_elt_at_index
 290 #define _bfd_archive_coff_generic_stat_arch_elt \
 291   bfd_generic_stat_arch_elt
 292 #define _bfd_archive_coff_update_armap_timestamp bfd_true
 293
 294 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
 295    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 296
 297 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
 298 #define _bfd_nosymbols_canonicalize_symtab \
 299   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 300 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
 301 #define _bfd_nosymbols_print_symbol \
 302   ((void (*) (bfd *, void *, asymbol *, bfd_print_symbol_type)) bfd_void)
 303 #define _bfd_nosymbols_get_symbol_info \
 304   ((void (*) (bfd *, asymbol *, symbol_info *)) bfd_void)
 305 #define _bfd_nosymbols_bfd_is_local_label_name \
 306   ((bfd_boolean (*) (bfd *, const char *)) bfd_false)
 307 #define _bfd_nosymbols_bfd_is_target_special_symbol \
 308   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
 309 #define _bfd_nosymbols_get_lineno \
 310   ((alent *(*) (bfd *, asymbol *)) bfd_nullvoidptr)
 311 #define _bfd_nosymbols_find_nearest_line \
 312   ((bfd_boolean (*) (bfd *, asection *, asymbol **, bfd_vma, const char **, \
 313                      const char **, unsigned int *)) \
 314    bfd_false)
 315 #define _bfd_nosymbols_bfd_make_debug_symbol \
 316   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 317 #define _bfd_nosymbols_read_minisymbols \
 318   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 319 #define _bfd_nosymbols_minisymbol_to_symbol \
 320   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 321    bfd_nullvoidptr)
 322
 323 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 324    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 325
 326 #define _bfd_norelocs_get_reloc_upper_bound \
 327   ((long (*) (bfd *, asection *)) _bfd_n1)
 328 #define _bfd_norelocs_canonicalize_reloc \
 329   ((long (*) (bfd *, asection *, arelent **, asymbol **)) _bfd_n1)
 330 #define _bfd_norelocs_bfd_reloc_type_lookup \
 331   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 332
 333 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 334    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 335
 336 #define _bfd_nowrite_set_arch_mach \
 337   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 338    bfd_false)
 339 #define _bfd_nowrite_set_section_contents \
 340   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 341    bfd_false)
 342
 343 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 344    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 345
 346 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 347 extern bfd_boolean _bfd_generic_set_section_contents
 348   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 349
 350 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 351    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 352
 353 #define _bfd_nolink_sizeof_headers ((int (*) (bfd *, bfd_boolean)) bfd_0)
 354 #define _bfd_nolink_bfd_get_relocated_section_contents \
 355   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 356                    bfd_byte *, bfd_boolean, asymbol **)) \
 357    bfd_nullvoidptr)
 358 #define _bfd_nolink_bfd_relax_section \
 359   ((bfd_boolean (*) \
 360     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 361    bfd_false)
 362 #define _bfd_nolink_bfd_gc_sections \
 363   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 364    bfd_false)
 365 #define _bfd_nolink_bfd_merge_sections \
 366   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 367    bfd_false)
 368 #define _bfd_nolink_bfd_is_group_section \
 369   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 370    bfd_false)
 371 #define _bfd_nolink_bfd_discard_group \
 372   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 373    bfd_false)
 374 #define _bfd_nolink_bfd_link_hash_table_create \
 375   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 376 #define _bfd_nolink_bfd_link_hash_table_free \
 377   ((void (*) (struct bfd_link_hash_table *)) bfd_void)
 378 #define _bfd_nolink_bfd_link_add_symbols \
 379   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 380 #define _bfd_nolink_bfd_link_just_syms \
 381   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 382 #define _bfd_nolink_bfd_final_link \
 383   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 384 #define _bfd_nolink_bfd_link_split_section \
 385   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 386 #define _bfd_nolink_section_already_linked \
 387   ((void (*) (bfd *, struct bfd_section *)) bfd_void)
 388
 389 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 390    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 391    (_bfd_nodynamic).  */
 392
 393 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 394 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 395   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 396 #define _bfd_nodynamic_get_synthetic_symtab \
 397   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 398 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 399 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 400   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 401 \f
 402 /* Generic routine to determine of the given symbol is a local
 403    label.  */
 404 extern bfd_boolean bfd_generic_is_local_label_name
 405   (bfd *, const char *);
 406
 407 /* Generic minisymbol routines.  */
 408 extern long _bfd_generic_read_minisymbols
 409   (bfd *, bfd_boolean, void **, unsigned int *);
 410 extern asymbol *_bfd_generic_minisymbol_to_symbol
 411   (bfd *, bfd_boolean, const void *, asymbol *);
 412
 413 /* Find the nearest line using .stab/.stabstr sections.  */
 414 extern bfd_boolean _bfd_stab_section_find_nearest_line
 415   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 416    const char **, const char **, unsigned int *, void **);
 417
 418 /* Find the nearest line using DWARF 1 debugging information.  */
 419 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 420   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 421    const char **, unsigned int *);
 422
 423 /* Find the nearest line using DWARF 2 debugging information.  */
 424 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 425   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
 426    unsigned int *, unsigned int, void **);
 427
 428 /* Create a new section entry.  */
 429 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 430   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 431
 432 /* A routine to create entries for a bfd_link_hash_table.  */
 433 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 434   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 435    const char *string);
 436
 437 /* Initialize a bfd_link_hash_table.  */
 438 extern bfd_boolean _bfd_link_hash_table_init
 439   (struct bfd_link_hash_table *, bfd *,
 440    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 441                                struct bfd_hash_table *,
 442                                const char *));
 443
 444 /* Generic link hash table creation routine.  */
 445 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 446   (bfd *);
 447
 448 /* Generic link hash table destruction routine.  */
 449 extern void _bfd_generic_link_hash_table_free
 450   (struct bfd_link_hash_table *);
 451
 452 /* Generic add symbol routine.  */
 453 extern bfd_boolean _bfd_generic_link_add_symbols
 454   (bfd *, struct bfd_link_info *);
 455
 456 /* Generic add symbol routine.  This version is used by targets for
 457    which the linker must collect constructors and destructors by name,
 458    as the collect2 program does.  */
 459 extern bfd_boolean _bfd_generic_link_add_symbols_collect
 460   (bfd *, struct bfd_link_info *);
 461
 462 /* Generic archive add symbol routine.  */
 463 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 464   (bfd *, struct bfd_link_info *,
 465    bfd_boolean (*) (bfd *, struct bfd_link_info *, bfd_boolean *));
 466
 467 /* Forward declaration to avoid prototype errors.  */
 468 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 469
 470 /* Generic routine to add a single symbol.  */
 471 extern bfd_boolean _bfd_generic_link_add_one_symbol
 472   (struct bfd_link_info *, bfd *, const char *name, flagword,
 473    asection *, bfd_vma, const char *, bfd_boolean copy,
 474    bfd_boolean constructor, struct bfd_link_hash_entry **);
 475
 476 /* Generic routine to mark section as supplying symbols only.  */
 477 extern void _bfd_generic_link_just_syms
 478   (asection *, struct bfd_link_info *);
 479
 480 /* Generic link routine.  */
 481 extern bfd_boolean _bfd_generic_final_link
 482   (bfd *, struct bfd_link_info *);
 483
 484 extern bfd_boolean _bfd_generic_link_split_section
 485   (bfd *, struct bfd_section *);
 486
 487 extern void _bfd_generic_section_already_linked
 488   (bfd *, struct bfd_section *);
 489
 490 /* Generic reloc_link_order processing routine.  */
 491 extern bfd_boolean _bfd_generic_reloc_link_order
 492   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 493
 494 /* Default link order processing routine.  */
 495 extern bfd_boolean _bfd_default_link_order
 496   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 497
 498 /* Count the number of reloc entries in a link order list.  */
 499 extern unsigned int _bfd_count_link_order_relocs
 500   (struct bfd_link_order *);
 501
 502 /* Final link relocation routine.  */
 503 extern bfd_reloc_status_type _bfd_final_link_relocate
 504   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 505    bfd_vma, bfd_vma, bfd_vma);
 506
 507 /* Relocate a particular location by a howto and a value.  */
 508 extern bfd_reloc_status_type _bfd_relocate_contents
 509   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 510
 511 /* Link stabs in sections in the first pass.  */
 512
 513 extern bfd_boolean _bfd_link_section_stabs
 514   (bfd *, struct stab_info *, asection *, asection *, void **,
 515    bfd_size_type *);
 516
 517 /* Eliminate stabs for discarded functions and symbols.  */
 518 extern bfd_boolean _bfd_discard_section_stabs
 519   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 520
 521 /* Write out the .stab section when linking stabs in sections.  */
 522
 523 extern bfd_boolean _bfd_write_section_stabs
 524   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 525
 526 /* Write out the .stabstr string table when linking stabs in sections.  */
 527
 528 extern bfd_boolean _bfd_write_stab_strings
 529   (bfd *, struct stab_info *);
 530
 531 /* Find an offset within a .stab section when linking stabs in
 532    sections.  */
 533
 534 extern bfd_vma _bfd_stab_section_offset
 535   (asection *, void *, bfd_vma);
 536
 537 /* Register a SEC_MERGE section as a candidate for merging.  */
 538
 539 extern bfd_boolean _bfd_add_merge_section
 540   (bfd *, void **, asection *, void **);
 541
 542 /* Attempt to merge SEC_MERGE sections.  */
 543
 544 extern bfd_boolean _bfd_merge_sections
 545   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 546
 547 /* Write out a merged section.  */
 548
 549 extern bfd_boolean _bfd_write_merged_section
 550   (bfd *, asection *, void *);
 551
 552 /* Find an offset within a modified SEC_MERGE section.  */
 553
 554 extern bfd_vma _bfd_merged_section_offset
 555   (bfd *, asection **, void *, bfd_vma);
 556
 557 /* Create a string table.  */
 558 extern struct bfd_strtab_hash *_bfd_stringtab_init
 559   (void);
 560
 561 /* Create an XCOFF .debug section style string table.  */
 562 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 563   (void);
 564
 565 /* Free a string table.  */
 566 extern void _bfd_stringtab_free
 567   (struct bfd_strtab_hash *);
 568
 569 /* Get the size of a string table.  */
 570 extern bfd_size_type _bfd_stringtab_size
 571   (struct bfd_strtab_hash *);
 572
 573 /* Add a string to a string table.  */
 574 extern bfd_size_type _bfd_stringtab_add
 575   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 576
 577 /* Write out a string table.  */
 578 extern bfd_boolean _bfd_stringtab_emit
 579   (bfd *, struct bfd_strtab_hash *);
 580
 581 /* Check that endianness of input and output file match.  */
 582 extern bfd_boolean _bfd_generic_verify_endian_match
 583   (bfd *, bfd *);
 584 \f
 585 /* Macros to tell if bfds are read or write enabled.
 586
 587    Note that bfds open for read may be scribbled into if the fd passed
 588    to bfd_fdopenr is actually open both for read and write
 589    simultaneously.  However an output bfd will never be open for
 590    read.  Therefore sometimes you want to check bfd_read_p or
 591    !bfd_read_p, and only sometimes bfd_write_p.
 592 */
 593
 594 #define bfd_read_p(abfd) \
 595   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 596 #define bfd_write_p(abfd) \
 597   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 598
 599 void bfd_assert
 600   (const char*,int);
 601
 602 #define BFD_ASSERT(x) \
 603   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 604
 605 #define BFD_FAIL() \
 606   do { bfd_assert(__FILE__,__LINE__); } while (0)
 607
 608 extern void _bfd_abort
 609   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 610
 611 /* if gcc >= 2.6, we can give a function name, too */
 612 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 613 #define __PRETTY_FUNCTION__  ((char *) NULL)
 614 #endif
 615
 616 #undef abort
 617 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 618
 619 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 620    the system "off_t" or "off64_t", as the offset.  */
 621 extern file_ptr real_ftell (FILE *file);
 622 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 623
 624 FILE *  bfd_cache_lookup_worker
 625   (bfd *);
 626
 627 extern bfd *bfd_last_cache;
 628
 629 /* List of supported target vectors, and the default vector (if
 630    bfd_default_vector[0] is NULL, there is no default).  */
 631 extern const bfd_target * const *bfd_target_vector;
 632 extern const bfd_target *bfd_default_vector[];
 633
 634 /* List of associated target vectors.  */
 635 extern const bfd_target * const *bfd_associated_vector;
 636
 637 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 638    other common header files.  */
 639
 640 #if defined(__STDC__) || defined(ALMOST_STDC)
 641 struct ecoff_find_line;
 642 #endif
 643
 644 extern bfd_boolean _bfd_ecoff_locate_line
 645   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 646    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 647    const char **, const char **, unsigned int *);
 648 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 649   (void *, bfd_byte *);
 650 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 651   (void *, bfd_byte *);
 652 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 653   (void *, bfd_byte *);
 654
 655 extern bfd_vma _bfd_get_gp_value
 656   (bfd *);
 657 extern void _bfd_set_gp_value
 658   (bfd *, bfd_vma);
 659
 660 /* Function shared by the COFF and ELF SH backends, which have no
 661    other common header files.  */
 662
 663 #ifndef _bfd_sh_align_load_span
 664 extern bfd_boolean _bfd_sh_align_load_span
 665   (bfd *, asection *, bfd_byte *,
 666    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 667    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 668 #endif
 669
 670 /* This is the shape of the elements inside the already_linked hash
 671    table. It maps a name onto a list of already_linked elements with
 672    the same name.  */
 673
 674 struct bfd_section_already_linked_hash_entry
 675 {
 676   struct bfd_hash_entry root;
 677   struct bfd_section_already_linked *entry;
 678 };
 679
 680 struct bfd_section_already_linked
 681 {
 682   struct bfd_section_already_linked *next;
 683   asection *sec;
 684 };
 685
 686 extern struct bfd_section_already_linked_hash_entry *
 687   bfd_section_already_linked_table_lookup (const char *);
 688 extern void bfd_section_already_linked_table_insert
 689   (struct bfd_section_already_linked_hash_entry *, asection *);
 690 extern void bfd_section_already_linked_table_traverse
 691   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 692                     void *), void *);
 693
 694 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 695 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
 696