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