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