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_find_inliner_info \
 316   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
 317    bfd_false)
 318 #define _bfd_nosymbols_bfd_make_debug_symbol \
 319   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 320 #define _bfd_nosymbols_read_minisymbols \
 321   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 322 #define _bfd_nosymbols_minisymbol_to_symbol \
 323   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 324    bfd_nullvoidptr)
 325
 326 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 327    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 328
 329 #define _bfd_norelocs_get_reloc_upper_bound \
 330   ((long (*) (bfd *, asection *)) _bfd_n1)
 331 #define _bfd_norelocs_canonicalize_reloc \
 332   ((long (*) (bfd *, asection *, arelent **, asymbol **)) _bfd_n1)
 333 #define _bfd_norelocs_bfd_reloc_type_lookup \
 334   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 335
 336 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 337    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 338
 339 #define _bfd_nowrite_set_arch_mach \
 340   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 341    bfd_false)
 342 #define _bfd_nowrite_set_section_contents \
 343   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 344    bfd_false)
 345
 346 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 347    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 348
 349 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 350 extern bfd_boolean _bfd_generic_set_section_contents
 351   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 352
 353 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 354    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 355
 356 #define _bfd_nolink_sizeof_headers ((int (*) (bfd *, bfd_boolean)) bfd_0)
 357 #define _bfd_nolink_bfd_get_relocated_section_contents \
 358   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 359                    bfd_byte *, bfd_boolean, asymbol **)) \
 360    bfd_nullvoidptr)
 361 #define _bfd_nolink_bfd_relax_section \
 362   ((bfd_boolean (*) \
 363     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 364    bfd_false)
 365 #define _bfd_nolink_bfd_gc_sections \
 366   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 367    bfd_false)
 368 #define _bfd_nolink_bfd_merge_sections \
 369   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 370    bfd_false)
 371 #define _bfd_nolink_bfd_is_group_section \
 372   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 373    bfd_false)
 374 #define _bfd_nolink_bfd_discard_group \
 375   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 376    bfd_false)
 377 #define _bfd_nolink_bfd_link_hash_table_create \
 378   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 379 #define _bfd_nolink_bfd_link_hash_table_free \
 380   ((void (*) (struct bfd_link_hash_table *)) bfd_void)
 381 #define _bfd_nolink_bfd_link_add_symbols \
 382   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 383 #define _bfd_nolink_bfd_link_just_syms \
 384   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 385 #define _bfd_nolink_bfd_final_link \
 386   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 387 #define _bfd_nolink_bfd_link_split_section \
 388   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 389 #define _bfd_nolink_section_already_linked \
 390   ((void (*) (bfd *, struct bfd_section *)) bfd_void)
 391
 392 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 393    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 394    (_bfd_nodynamic).  */
 395
 396 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 397 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 398   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 399 #define _bfd_nodynamic_get_synthetic_symtab \
 400   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 401 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 402 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 403   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 404 \f
 405 /* Generic routine to determine of the given symbol is a local
 406    label.  */
 407 extern bfd_boolean bfd_generic_is_local_label_name
 408   (bfd *, const char *);
 409
 410 /* Generic minisymbol routines.  */
 411 extern long _bfd_generic_read_minisymbols
 412   (bfd *, bfd_boolean, void **, unsigned int *);
 413 extern asymbol *_bfd_generic_minisymbol_to_symbol
 414   (bfd *, bfd_boolean, const void *, asymbol *);
 415
 416 /* Find the nearest line using .stab/.stabstr sections.  */
 417 extern bfd_boolean _bfd_stab_section_find_nearest_line
 418   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 419    const char **, const char **, unsigned int *, void **);
 420
 421 /* Find the nearest line using DWARF 1 debugging information.  */
 422 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 423   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 424    const char **, unsigned int *);
 425
 426 /* Find the nearest line using DWARF 2 debugging information.  */
 427 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 428   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
 429    unsigned int *, unsigned int, void **);
 430
 431 /* Find inliner info after calling bfd_find_nearest_line. */
 432 extern bfd_boolean _bfd_dwarf2_find_inliner_info
 433   (bfd *, const char **, const char **, unsigned int *, void **);
 434
 435 /* Create a new section entry.  */
 436 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 437   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 438
 439 /* A routine to create entries for a bfd_link_hash_table.  */
 440 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 441   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 442    const char *string);
 443
 444 /* Initialize a bfd_link_hash_table.  */
 445 extern bfd_boolean _bfd_link_hash_table_init
 446   (struct bfd_link_hash_table *, bfd *,
 447    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 448                                struct bfd_hash_table *,
 449                                const char *));
 450
 451 /* Generic link hash table creation routine.  */
 452 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 453   (bfd *);
 454
 455 /* Generic link hash table destruction routine.  */
 456 extern void _bfd_generic_link_hash_table_free
 457   (struct bfd_link_hash_table *);
 458
 459 /* Generic add symbol routine.  */
 460 extern bfd_boolean _bfd_generic_link_add_symbols
 461   (bfd *, struct bfd_link_info *);
 462
 463 /* Generic add symbol routine.  This version is used by targets for
 464    which the linker must collect constructors and destructors by name,
 465    as the collect2 program does.  */
 466 extern bfd_boolean _bfd_generic_link_add_symbols_collect
 467   (bfd *, struct bfd_link_info *);
 468
 469 /* Generic archive add symbol routine.  */
 470 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 471   (bfd *, struct bfd_link_info *,
 472    bfd_boolean (*) (bfd *, struct bfd_link_info *, bfd_boolean *));
 473
 474 /* Forward declaration to avoid prototype errors.  */
 475 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 476
 477 /* Generic routine to add a single symbol.  */
 478 extern bfd_boolean _bfd_generic_link_add_one_symbol
 479   (struct bfd_link_info *, bfd *, const char *name, flagword,
 480    asection *, bfd_vma, const char *, bfd_boolean copy,
 481    bfd_boolean constructor, struct bfd_link_hash_entry **);
 482
 483 /* Generic routine to mark section as supplying symbols only.  */
 484 extern void _bfd_generic_link_just_syms
 485   (asection *, struct bfd_link_info *);
 486
 487 /* Generic link routine.  */
 488 extern bfd_boolean _bfd_generic_final_link
 489   (bfd *, struct bfd_link_info *);
 490
 491 extern bfd_boolean _bfd_generic_link_split_section
 492   (bfd *, struct bfd_section *);
 493
 494 extern void _bfd_generic_section_already_linked
 495   (bfd *, struct bfd_section *);
 496
 497 /* Generic reloc_link_order processing routine.  */
 498 extern bfd_boolean _bfd_generic_reloc_link_order
 499   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 500
 501 /* Default link order processing routine.  */
 502 extern bfd_boolean _bfd_default_link_order
 503   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 504
 505 /* Count the number of reloc entries in a link order list.  */
 506 extern unsigned int _bfd_count_link_order_relocs
 507   (struct bfd_link_order *);
 508
 509 /* Final link relocation routine.  */
 510 extern bfd_reloc_status_type _bfd_final_link_relocate
 511   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 512    bfd_vma, bfd_vma, bfd_vma);
 513
 514 /* Relocate a particular location by a howto and a value.  */
 515 extern bfd_reloc_status_type _bfd_relocate_contents
 516   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 517
 518 /* Link stabs in sections in the first pass.  */
 519
 520 extern bfd_boolean _bfd_link_section_stabs
 521   (bfd *, struct stab_info *, asection *, asection *, void **,
 522    bfd_size_type *);
 523
 524 /* Eliminate stabs for discarded functions and symbols.  */
 525 extern bfd_boolean _bfd_discard_section_stabs
 526   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 527
 528 /* Write out the .stab section when linking stabs in sections.  */
 529
 530 extern bfd_boolean _bfd_write_section_stabs
 531   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 532
 533 /* Write out the .stabstr string table when linking stabs in sections.  */
 534
 535 extern bfd_boolean _bfd_write_stab_strings
 536   (bfd *, struct stab_info *);
 537
 538 /* Find an offset within a .stab section when linking stabs in
 539    sections.  */
 540
 541 extern bfd_vma _bfd_stab_section_offset
 542   (asection *, void *, bfd_vma);
 543
 544 /* Register a SEC_MERGE section as a candidate for merging.  */
 545
 546 extern bfd_boolean _bfd_add_merge_section
 547   (bfd *, void **, asection *, void **);
 548
 549 /* Attempt to merge SEC_MERGE sections.  */
 550
 551 extern bfd_boolean _bfd_merge_sections
 552   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 553
 554 /* Write out a merged section.  */
 555
 556 extern bfd_boolean _bfd_write_merged_section
 557   (bfd *, asection *, void *);
 558
 559 /* Find an offset within a modified SEC_MERGE section.  */
 560
 561 extern bfd_vma _bfd_merged_section_offset
 562   (bfd *, asection **, void *, bfd_vma);
 563
 564 /* Create a string table.  */
 565 extern struct bfd_strtab_hash *_bfd_stringtab_init
 566   (void);
 567
 568 /* Create an XCOFF .debug section style string table.  */
 569 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 570   (void);
 571
 572 /* Free a string table.  */
 573 extern void _bfd_stringtab_free
 574   (struct bfd_strtab_hash *);
 575
 576 /* Get the size of a string table.  */
 577 extern bfd_size_type _bfd_stringtab_size
 578   (struct bfd_strtab_hash *);
 579
 580 /* Add a string to a string table.  */
 581 extern bfd_size_type _bfd_stringtab_add
 582   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 583
 584 /* Write out a string table.  */
 585 extern bfd_boolean _bfd_stringtab_emit
 586   (bfd *, struct bfd_strtab_hash *);
 587
 588 /* Check that endianness of input and output file match.  */
 589 extern bfd_boolean _bfd_generic_verify_endian_match
 590   (bfd *, bfd *);
 591 \f
 592 /* Macros to tell if bfds are read or write enabled.
 593
 594    Note that bfds open for read may be scribbled into if the fd passed
 595    to bfd_fdopenr is actually open both for read and write
 596    simultaneously.  However an output bfd will never be open for
 597    read.  Therefore sometimes you want to check bfd_read_p or
 598    !bfd_read_p, and only sometimes bfd_write_p.
 599 */
 600
 601 #define bfd_read_p(abfd) \
 602   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 603 #define bfd_write_p(abfd) \
 604   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 605
 606 void bfd_assert
 607   (const char*,int);
 608
 609 #define BFD_ASSERT(x) \
 610   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 611
 612 #define BFD_FAIL() \
 613   do { bfd_assert(__FILE__,__LINE__); } while (0)
 614
 615 extern void _bfd_abort
 616   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 617
 618 /* if gcc >= 2.6, we can give a function name, too */
 619 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 620 #define __PRETTY_FUNCTION__  ((char *) NULL)
 621 #endif
 622
 623 #undef abort
 624 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 625
 626 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 627    the system "off_t" or "off64_t", as the offset.  */
 628 extern file_ptr real_ftell (FILE *file);
 629 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 630
 631 FILE *  bfd_cache_lookup_worker
 632   (bfd *);
 633
 634 extern bfd *bfd_last_cache;
 635
 636 /* List of supported target vectors, and the default vector (if
 637    bfd_default_vector[0] is NULL, there is no default).  */
 638 extern const bfd_target * const *bfd_target_vector;
 639 extern const bfd_target *bfd_default_vector[];
 640
 641 /* List of associated target vectors.  */
 642 extern const bfd_target * const *bfd_associated_vector;
 643
 644 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 645    other common header files.  */
 646
 647 #if defined(__STDC__) || defined(ALMOST_STDC)
 648 struct ecoff_find_line;
 649 #endif
 650
 651 extern bfd_boolean _bfd_ecoff_locate_line
 652   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 653    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 654    const char **, const char **, unsigned int *);
 655 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 656   (void *, bfd_byte *);
 657 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 658   (void *, bfd_byte *);
 659 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 660   (void *, bfd_byte *);
 661
 662 extern bfd_vma _bfd_get_gp_value
 663   (bfd *);
 664 extern void _bfd_set_gp_value
 665   (bfd *, bfd_vma);
 666
 667 /* Function shared by the COFF and ELF SH backends, which have no
 668    other common header files.  */
 669
 670 #ifndef _bfd_sh_align_load_span
 671 extern bfd_boolean _bfd_sh_align_load_span
 672   (bfd *, asection *, bfd_byte *,
 673    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 674    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 675 #endif
 676
 677 /* This is the shape of the elements inside the already_linked hash
 678    table. It maps a name onto a list of already_linked elements with
 679    the same name.  */
 680
 681 struct bfd_section_already_linked_hash_entry
 682 {
 683   struct bfd_hash_entry root;
 684   struct bfd_section_already_linked *entry;
 685 };
 686
 687 struct bfd_section_already_linked
 688 {
 689   struct bfd_section_already_linked *next;
 690   asection *sec;
 691 };
 692
 693 extern struct bfd_section_already_linked_hash_entry *
 694   bfd_section_already_linked_table_lookup (const char *);
 695 extern void bfd_section_already_linked_table_insert
 696   (struct bfd_section_already_linked_hash_entry *, asection *);
 697 extern void bfd_section_already_linked_table_traverse
 698   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 699                     void *), void *);
 700
 701 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 702 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
 703