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