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