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