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 (C) 1990-2016 Free Software Foundation, Inc.
   5
   6    Written by Cygnus Support.
   7
   8    This file is part of BFD, the Binary File Descriptor library.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  23    MA 02110-1301, USA.  */
  24
  25 #include "hashtab.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* If you want to read and write large blocks, you might want to do it
  32    in quanta of this amount */
  33 #define DEFAULT_BUFFERSIZE 8192
  34
  35 /* Set a tdata field.  Can't use the other macros for this, since they
  36    do casts, and casting to the left of assignment isn't portable.  */
  37 #define set_tdata(bfd, v) ((bfd)->tdata.any = (v))
  38
  39 /* If BFD_IN_MEMORY is set for a BFD, then the iostream fields points
  40    to an instance of this structure.  */
  41
  42 struct bfd_in_memory
  43 {
  44   /* Size of buffer.  */
  45   bfd_size_type size;
  46   /* Buffer holding contents of BFD.  */
  47   bfd_byte *buffer;
  48 };
  49
  50 struct section_hash_entry
  51 {
  52   struct bfd_hash_entry root;
  53   asection section;
  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 {
  61   file_ptr first_file_filepos;
  62   /* Speed up searching the armap */
  63   htab_t cache;
  64   bfd *archive_head;            /* Only interesting in output routines.  */
  65   carsym *symdefs;              /* The symdef entries.  */
  66   symindex symdef_count;        /* How many there are.  */
  67   char *extended_names;         /* Clever intel extension.  */
  68   bfd_size_type extended_names_size; /* Size of extended names.  */
  69   /* When more compilers are standard C, this can be a time_t.  */
  70   long  armap_timestamp;        /* Timestamp value written into armap.
  71                                    This is used for BSD archives to check
  72                                    that the timestamp is recent enough
  73                                    for the BSD linker to not complain,
  74                                    just before we finish writing an
  75                                    archive.  */
  76   file_ptr armap_datepos;       /* Position within archive to seek to
  77                                    rewrite the date field.  */
  78   void *tdata;                  /* Backend specific information.  */
  79 };
  80
  81 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  82
  83 /* Goes in bfd's arelt_data slot */
  84 struct areltdata
  85 {
  86   char * arch_header;           /* It's actually a string.  */
  87   bfd_size_type parsed_size;    /* Octets of filesize not including ar_hdr.  */
  88   bfd_size_type extra_size;     /* BSD4.4: extra bytes after the header.  */
  89   char *filename;               /* Null-terminated.  */
  90   file_ptr origin;              /* For element of a thin archive.  */
  91   void *parent_cache;           /* Where and how to find this member.  */
  92   file_ptr key;
  93 };
  94
  95 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
  96
  97 extern void *bfd_malloc
  98   (bfd_size_type);
  99 extern void *bfd_realloc
 100   (void *, bfd_size_type);
 101 extern void *bfd_realloc_or_free
 102   (void *, bfd_size_type);
 103 extern void *bfd_zmalloc
 104   (bfd_size_type);
 105 extern void *bfd_malloc2
 106   (bfd_size_type, bfd_size_type);
 107 extern void *bfd_realloc2
 108   (void *, bfd_size_type, bfd_size_type);
 109 extern void *bfd_zmalloc2
 110   (bfd_size_type, bfd_size_type);
 111
 112 extern void _bfd_default_error_handler (const char *s, ...);
 113 extern bfd_error_handler_type _bfd_error_handler;
 114 extern bfd_assert_handler_type _bfd_assert_handler;
 115
 116 /* These routines allocate and free things on the BFD's objalloc.  */
 117
 118 extern void *bfd_alloc2
 119   (bfd *, bfd_size_type, bfd_size_type);
 120 extern void *bfd_zalloc2
 121   (bfd *, bfd_size_type, bfd_size_type);
 122 extern void bfd_release
 123   (bfd *, void *);
 124
 125 bfd * _bfd_create_empty_archive_element_shell
 126   (bfd *obfd);
 127 bfd * _bfd_look_for_bfd_in_cache
 128   (bfd *, file_ptr);
 129 bfd_boolean _bfd_add_bfd_to_archive_cache
 130   (bfd *, file_ptr, bfd *);
 131 bfd_boolean _bfd_generic_mkarchive
 132   (bfd *abfd);
 133 char *_bfd_append_relative_path
 134   (bfd *arch, char *elt_name);
 135 const bfd_target *bfd_generic_archive_p
 136   (bfd *abfd);
 137 bfd_boolean bfd_slurp_armap
 138   (bfd *abfd);
 139 bfd_boolean bfd_slurp_bsd_armap_f2
 140   (bfd *abfd);
 141 #define bfd_slurp_bsd_armap bfd_slurp_armap
 142 #define bfd_slurp_coff_armap bfd_slurp_armap
 143 bfd_boolean _bfd_archive_64_bit_slurp_armap
 144   (bfd *);
 145 bfd_boolean _bfd_archive_64_bit_write_armap
 146   (bfd *, unsigned int, struct orl *, unsigned int, int);
 147 #define _bfd_archive_64_bit_slurp_extended_name_table \
 148   _bfd_slurp_extended_name_table
 149 #define _bfd_archive_64_bit_construct_extended_name_table \
 150   _bfd_archive_coff_construct_extended_name_table
 151 #define _bfd_archive_64_bit_truncate_arname \
 152   bfd_dont_truncate_arname
 153 #define _bfd_archive_64_bit_read_ar_hdr \
 154   _bfd_generic_read_ar_hdr
 155 #define _bfd_archive_64_bit_write_ar_hdr \
 156   _bfd_generic_write_ar_hdr
 157 #define _bfd_archive_64_bit_openr_next_archived_file \
 158   bfd_generic_openr_next_archived_file
 159 #define _bfd_archive_64_bit_get_elt_at_index \
 160   _bfd_generic_get_elt_at_index
 161 #define _bfd_archive_64_bit_generic_stat_arch_elt \
 162   bfd_generic_stat_arch_elt
 163 #define _bfd_archive_64_bit_update_armap_timestamp \
 164   bfd_true
 165
 166 bfd_boolean _bfd_slurp_extended_name_table
 167   (bfd *abfd);
 168 extern bfd_boolean _bfd_construct_extended_name_table
 169   (bfd *, bfd_boolean, char **, bfd_size_type *);
 170 bfd_boolean _bfd_write_archive_contents
 171   (bfd *abfd);
 172 bfd_boolean _bfd_compute_and_write_armap
 173   (bfd *, unsigned int elength);
 174 bfd *_bfd_get_elt_at_filepos
 175   (bfd *archive, file_ptr filepos);
 176 extern bfd *_bfd_generic_get_elt_at_index
 177   (bfd *, symindex);
 178 bfd * _bfd_new_bfd
 179   (void);
 180 bfd_boolean _bfd_free_cached_info
 181   (bfd *);
 182
 183 bfd_boolean bfd_false
 184   (bfd *ignore);
 185 bfd_boolean bfd_true
 186   (bfd *ignore);
 187 void *bfd_nullvoidptr
 188   (bfd *ignore);
 189 int bfd_0
 190   (bfd *ignore);
 191 unsigned int bfd_0u
 192   (bfd *ignore);
 193 long bfd_0l
 194   (bfd *ignore);
 195 long _bfd_n1
 196   (bfd *ignore);
 197 void bfd_void
 198   (bfd *ignore);
 199
 200 bfd *_bfd_new_bfd_contained_in
 201   (bfd *);
 202 const bfd_target *_bfd_dummy_target
 203   (bfd *abfd);
 204
 205 void bfd_dont_truncate_arname
 206   (bfd *abfd, const char *filename, char *hdr);
 207 void bfd_bsd_truncate_arname
 208   (bfd *abfd, const char *filename, char *hdr);
 209 void bfd_gnu_truncate_arname
 210   (bfd *abfd, const char *filename, char *hdr);
 211
 212 bfd_boolean bsd_write_armap
 213   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 214    int stridx);
 215
 216 bfd_boolean coff_write_armap
 217   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 218    int stridx);
 219
 220 extern void *_bfd_generic_read_ar_hdr
 221   (bfd *);
 222 extern void _bfd_ar_spacepad
 223   (char *, size_t, const char *, long);
 224 extern bfd_boolean _bfd_ar_sizepad
 225   (char *, size_t, bfd_size_type);
 226
 227 extern void *_bfd_generic_read_ar_hdr_mag
 228   (bfd *, const char *);
 229
 230 extern bfd_boolean _bfd_generic_write_ar_hdr
 231   (bfd *, bfd *);
 232
 233 extern bfd_boolean _bfd_bsd44_write_ar_hdr
 234   (bfd *, bfd *);
 235
 236 bfd * bfd_generic_openr_next_archived_file
 237   (bfd *archive, bfd *last_file);
 238
 239 int bfd_generic_stat_arch_elt
 240   (bfd *, struct stat *);
 241
 242 #define _bfd_read_ar_hdr(abfd) \
 243   BFD_SEND (abfd, _bfd_read_ar_hdr_fn, (abfd))
 244 #define _bfd_write_ar_hdr(archive, abfd)         \
 245   BFD_SEND (abfd, _bfd_write_ar_hdr_fn, (archive, abfd))
 246 \f
 247 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
 248    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
 249
 250 #define _bfd_generic_close_and_cleanup _bfd_archive_close_and_cleanup
 251 extern bfd_boolean _bfd_archive_close_and_cleanup
 252   (bfd *);
 253 #define _bfd_generic_bfd_free_cached_info bfd_true
 254 extern bfd_boolean _bfd_generic_new_section_hook
 255   (bfd *, asection *);
 256 extern bfd_boolean _bfd_generic_get_section_contents
 257   (bfd *, asection *, void *, file_ptr, bfd_size_type);
 258 extern bfd_boolean _bfd_generic_get_section_contents_in_window
 259   (bfd *, asection *, bfd_window *, file_ptr, bfd_size_type);
 260
 261 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 262    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 263
 264 #define _bfd_generic_bfd_copy_private_bfd_data \
 265   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 266 #define _bfd_generic_bfd_merge_private_bfd_data \
 267   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 268 #define _bfd_generic_bfd_set_private_flags \
 269   ((bfd_boolean (*) (bfd *, flagword)) bfd_true)
 270 #define _bfd_generic_bfd_copy_private_section_data \
 271   ((bfd_boolean (*) (bfd *, asection *, bfd *, asection *)) bfd_true)
 272 #define _bfd_generic_bfd_copy_private_symbol_data \
 273   ((bfd_boolean (*) (bfd *, asymbol *, bfd *, asymbol *)) bfd_true)
 274 #define _bfd_generic_bfd_copy_private_header_data \
 275   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 276 #define _bfd_generic_bfd_print_private_bfd_data \
 277   ((bfd_boolean (*) (bfd *, void *)) bfd_true)
 278
 279 extern bfd_boolean _bfd_generic_init_private_section_data
 280   (bfd *, asection *, bfd *, asection *, struct bfd_link_info *);
 281
 282 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 283    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 284
 285 extern char *_bfd_nocore_core_file_failing_command
 286   (bfd *);
 287 extern int _bfd_nocore_core_file_failing_signal
 288   (bfd *);
 289 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
 290   (bfd *, bfd *);
 291 extern int _bfd_nocore_core_file_pid
 292   (bfd *);
 293
 294 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
 295    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
 296
 297 #define _bfd_noarchive_slurp_armap bfd_false
 298 #define _bfd_noarchive_slurp_extended_name_table bfd_false
 299 #define _bfd_noarchive_construct_extended_name_table \
 300   ((bfd_boolean (*) (bfd *, char **, bfd_size_type *, const char **)) \
 301    bfd_false)
 302 #define _bfd_noarchive_truncate_arname \
 303   ((void (*) (bfd *, const char *, char *)) bfd_void)
 304 #define _bfd_noarchive_write_armap \
 305   ((bfd_boolean (*) (bfd *, unsigned int, struct orl *, unsigned int, int)) \
 306    bfd_false)
 307 #define _bfd_noarchive_read_ar_hdr bfd_nullvoidptr
 308 #define _bfd_noarchive_write_ar_hdr \
 309   ((bfd_boolean (*) (bfd *, bfd *)) bfd_false)
 310 #define _bfd_noarchive_openr_next_archived_file \
 311   ((bfd *(*) (bfd *, bfd *)) bfd_nullvoidptr)
 312 #define _bfd_noarchive_get_elt_at_index \
 313   ((bfd *(*) (bfd *, symindex)) bfd_nullvoidptr)
 314 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
 315 #define _bfd_noarchive_update_armap_timestamp bfd_false
 316
 317 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
 318    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
 319
 320 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
 321 #define _bfd_archive_bsd_slurp_extended_name_table \
 322   _bfd_slurp_extended_name_table
 323 extern bfd_boolean _bfd_archive_bsd_construct_extended_name_table
 324   (bfd *, char **, bfd_size_type *, const char **);
 325 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
 326 #define _bfd_archive_bsd_write_armap bsd_write_armap
 327 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
 328 #define _bfd_archive_bsd_write_ar_hdr _bfd_generic_write_ar_hdr
 329 #define _bfd_archive_bsd_openr_next_archived_file \
 330   bfd_generic_openr_next_archived_file
 331 #define _bfd_archive_bsd_get_elt_at_index _bfd_generic_get_elt_at_index
 332 #define _bfd_archive_bsd_generic_stat_arch_elt \
 333   bfd_generic_stat_arch_elt
 334 extern bfd_boolean _bfd_archive_bsd_update_armap_timestamp
 335   (bfd *);
 336
 337 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
 338    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
 339
 340 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
 341 #define _bfd_archive_coff_slurp_extended_name_table \
 342   _bfd_slurp_extended_name_table
 343 extern bfd_boolean _bfd_archive_coff_construct_extended_name_table
 344   (bfd *, char **, bfd_size_type *, const char **);
 345 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
 346 #define _bfd_archive_coff_write_armap coff_write_armap
 347 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
 348 #define _bfd_archive_coff_write_ar_hdr _bfd_generic_write_ar_hdr
 349 #define _bfd_archive_coff_openr_next_archived_file \
 350   bfd_generic_openr_next_archived_file
 351 #define _bfd_archive_coff_get_elt_at_index _bfd_generic_get_elt_at_index
 352 #define _bfd_archive_coff_generic_stat_arch_elt \
 353   bfd_generic_stat_arch_elt
 354 #define _bfd_archive_coff_update_armap_timestamp bfd_true
 355
 356 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD4.4 style
 357    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd44).  */
 358
 359 #define _bfd_archive_bsd44_slurp_armap bfd_slurp_bsd_armap
 360 #define _bfd_archive_bsd44_slurp_extended_name_table \
 361   _bfd_slurp_extended_name_table
 362 extern bfd_boolean _bfd_archive_bsd44_construct_extended_name_table
 363   (bfd *, char **, bfd_size_type *, const char **);
 364 #define _bfd_archive_bsd44_truncate_arname bfd_bsd_truncate_arname
 365 #define _bfd_archive_bsd44_write_armap bsd_write_armap
 366 #define _bfd_archive_bsd44_read_ar_hdr _bfd_generic_read_ar_hdr
 367 #define _bfd_archive_bsd44_write_ar_hdr _bfd_bsd44_write_ar_hdr
 368 #define _bfd_archive_bsd44_openr_next_archived_file \
 369   bfd_generic_openr_next_archived_file
 370 #define _bfd_archive_bsd44_get_elt_at_index _bfd_generic_get_elt_at_index
 371 #define _bfd_archive_bsd44_generic_stat_arch_elt \
 372   bfd_generic_stat_arch_elt
 373 #define _bfd_archive_bsd44_update_armap_timestamp \
 374   _bfd_archive_bsd_update_armap_timestamp
 375
 376 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get VMS style
 377    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_vms_lib).  Some of them
 378    are irrelevant and never called, so defined as NULL.  */
 379
 380 extern bfd_boolean _bfd_vms_lib_write_archive_contents (bfd *arch);
 381 #define _bfd_vms_lib_slurp_armap NULL
 382 #define _bfd_vms_lib_slurp_extended_name_table NULL
 383 #define _bfd_vms_lib_construct_extended_name_table NULL
 384 #define _bfd_vms_lib_truncate_arname NULL
 385 #define _bfd_vms_lib_write_armap NULL
 386 #define _bfd_vms_lib_read_ar_hdr NULL
 387 #define _bfd_vms_lib_write_ar_hdr NULL
 388 extern bfd *_bfd_vms_lib_openr_next_archived_file (bfd *, bfd *);
 389 extern bfd *_bfd_vms_lib_get_elt_at_index (bfd *, symindex);
 390 extern int _bfd_vms_lib_generic_stat_arch_elt (bfd *, struct stat *);
 391 #define _bfd_vms_lib_update_armap_timestamp bfd_true
 392
 393 /* Extra routines for VMS style archives.  */
 394
 395 extern symindex _bfd_vms_lib_find_symbol (bfd *, const char *);
 396 extern bfd *_bfd_vms_lib_get_imagelib_file (bfd *);
 397 extern const bfd_target *_bfd_vms_lib_alpha_archive_p (bfd *abfd);
 398 extern const bfd_target *_bfd_vms_lib_ia64_archive_p (bfd *abfd);
 399 extern bfd_boolean _bfd_vms_lib_alpha_mkarchive (bfd *abfd);
 400 extern bfd_boolean _bfd_vms_lib_ia64_mkarchive (bfd *abfd);
 401
 402 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
 403    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 404
 405 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
 406 #define _bfd_nosymbols_canonicalize_symtab \
 407   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 408 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
 409 #define _bfd_nosymbols_print_symbol \
 410   ((void (*) (bfd *, void *, asymbol *, bfd_print_symbol_type)) bfd_void)
 411 #define _bfd_nosymbols_get_symbol_info \
 412   ((void (*) (bfd *, asymbol *, symbol_info *)) bfd_void)
 413 #define _bfd_nosymbols_get_symbol_version_string \
 414   ((const char *(*) (bfd *, asymbol *, bfd_boolean *)) bfd_nullvoidptr)
 415 #define _bfd_nosymbols_bfd_is_local_label_name \
 416   ((bfd_boolean (*) (bfd *, const char *)) bfd_false)
 417 #define _bfd_nosymbols_bfd_is_target_special_symbol \
 418   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
 419 #define _bfd_nosymbols_get_lineno \
 420   ((alent *(*) (bfd *, asymbol *)) bfd_nullvoidptr)
 421 #define _bfd_nosymbols_find_nearest_line \
 422   ((bfd_boolean (*) (bfd *, asymbol **, asection *, bfd_vma,            \
 423                      const char **, const char **, unsigned int *,      \
 424                      unsigned int *))                                   \
 425    bfd_false)
 426 #define _bfd_nosymbols_find_line \
 427   ((bfd_boolean (*) (bfd *, asymbol **, asymbol *,      \
 428                      const char **, unsigned int *))    \
 429    bfd_false)
 430 #define _bfd_nosymbols_find_inliner_info \
 431   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
 432    bfd_false)
 433 #define _bfd_nosymbols_bfd_make_debug_symbol \
 434   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 435 #define _bfd_nosymbols_read_minisymbols \
 436   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 437 #define _bfd_nosymbols_minisymbol_to_symbol \
 438   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 439    bfd_nullvoidptr)
 440
 441 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 442    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 443
 444 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
 445 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
 446                                               arelent **, asymbol **);
 447 #define _bfd_norelocs_bfd_reloc_type_lookup \
 448   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 449 #define _bfd_norelocs_bfd_reloc_name_lookup \
 450   ((reloc_howto_type *(*) (bfd *, const char *)) bfd_nullvoidptr)
 451
 452 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 453    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 454
 455 #define _bfd_nowrite_set_arch_mach \
 456   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 457    bfd_false)
 458 #define _bfd_nowrite_set_section_contents \
 459   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 460    bfd_false)
 461
 462 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 463    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 464
 465 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 466 extern bfd_boolean _bfd_generic_set_section_contents
 467   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 468
 469 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 470    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 471
 472 #define _bfd_nolink_sizeof_headers \
 473   ((int (*) (bfd *, struct bfd_link_info *)) bfd_0)
 474 #define _bfd_nolink_bfd_get_relocated_section_contents \
 475   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 476                    bfd_byte *, bfd_boolean, asymbol **)) \
 477    bfd_nullvoidptr)
 478 #define _bfd_nolink_bfd_relax_section \
 479   ((bfd_boolean (*) \
 480     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 481    bfd_false)
 482 #define _bfd_nolink_bfd_gc_sections \
 483   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 484    bfd_false)
 485 #define _bfd_nolink_bfd_lookup_section_flags \
 486   ((bfd_boolean (*) (struct bfd_link_info *, struct flag_info *, asection *)) \
 487    bfd_0)
 488 #define _bfd_nolink_bfd_merge_sections \
 489   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 490    bfd_false)
 491 #define _bfd_nolink_bfd_is_group_section \
 492   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 493    bfd_false)
 494 #define _bfd_nolink_bfd_discard_group \
 495   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 496    bfd_false)
 497 #define _bfd_nolink_bfd_link_hash_table_create \
 498   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 499 #define _bfd_nolink_bfd_link_add_symbols \
 500   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 501 #define _bfd_nolink_bfd_link_just_syms \
 502   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 503 #define _bfd_nolink_bfd_copy_link_hash_symbol_type \
 504   ((void (*) (bfd *, struct bfd_link_hash_entry *, \
 505               struct bfd_link_hash_entry *)) bfd_void)
 506 #define _bfd_nolink_bfd_final_link \
 507   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 508 #define _bfd_nolink_bfd_link_split_section \
 509   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 510 #define _bfd_nolink_section_already_linked \
 511   ((bfd_boolean (*) (bfd *, asection *, \
 512                      struct bfd_link_info *)) bfd_false)
 513 #define _bfd_nolink_bfd_define_common_symbol \
 514   ((bfd_boolean (*) (bfd *, struct bfd_link_info *, \
 515                      struct bfd_link_hash_entry *)) bfd_false)
 516 #define _bfd_nolink_bfd_link_check_relocs \
 517   _bfd_generic_link_check_relocs
 518
 519 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 520    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 521    (_bfd_nodynamic).  */
 522
 523 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 524 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 525   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 526 #define _bfd_nodynamic_get_synthetic_symtab \
 527   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 528 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 529 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 530   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 531 \f
 532 /* Generic routine to determine of the given symbol is a local
 533    label.  */
 534 extern bfd_boolean bfd_generic_is_local_label_name
 535   (bfd *, const char *);
 536
 537 /* Generic minisymbol routines.  */
 538 extern long _bfd_generic_read_minisymbols
 539   (bfd *, bfd_boolean, void **, unsigned int *);
 540 extern asymbol *_bfd_generic_minisymbol_to_symbol
 541   (bfd *, bfd_boolean, const void *, asymbol *);
 542
 543 /* Find the nearest line using .stab/.stabstr sections.  */
 544 extern bfd_boolean _bfd_stab_section_find_nearest_line
 545   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 546    const char **, const char **, unsigned int *, void **);
 547
 548 /* Find the nearest line using DWARF 1 debugging information.  */
 549 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 550   (bfd *, asymbol **, asection *, bfd_vma,
 551    const char **, const char **, unsigned int *);
 552
 553 struct dwarf_debug_section
 554 {
 555   const char *uncompressed_name;
 556   const char *compressed_name;
 557 };
 558
 559 /* Map of uncompressed DWARF debug section name to compressed one.  It
 560    is terminated by NULL uncompressed_name.  */
 561
 562 extern const struct dwarf_debug_section dwarf_debug_sections[];
 563
 564 /* Find the nearest line using DWARF 2 debugging information.  */
 565 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 566   (bfd *, asymbol **, asymbol *, asection *, bfd_vma,
 567    const char **, const char **, unsigned int *, unsigned int *,
 568    const struct dwarf_debug_section *, unsigned int, void **);
 569
 570 /* Find the bias between DWARF addresses and real addresses.  */
 571 extern bfd_signed_vma _bfd_dwarf2_find_symbol_bias
 572   (asymbol **, void **);
 573
 574 /* Find inliner info after calling bfd_find_nearest_line. */
 575 extern bfd_boolean _bfd_dwarf2_find_inliner_info
 576   (bfd *, const char **, const char **, unsigned int *, void **);
 577
 578 /* Read DWARF 2 debugging information. */
 579 extern bfd_boolean _bfd_dwarf2_slurp_debug_info
 580   (bfd *, bfd *, const struct dwarf_debug_section *, asymbol **, void **,
 581    bfd_boolean);
 582
 583 /* Clean up the data used to handle DWARF 2 debugging information. */
 584 extern void _bfd_dwarf2_cleanup_debug_info
 585   (bfd *, void **);
 586
 587 /* Create a new section entry.  */
 588 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 589   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 590
 591 /* A routine to create entries for a bfd_link_hash_table.  */
 592 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 593   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 594    const char *string);
 595
 596 /* Initialize a bfd_link_hash_table.  */
 597 extern bfd_boolean _bfd_link_hash_table_init
 598   (struct bfd_link_hash_table *, bfd *,
 599    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 600                                struct bfd_hash_table *,
 601                                const char *),
 602    unsigned int);
 603
 604 /* Generic link hash table creation routine.  */
 605 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 606   (bfd *);
 607
 608 /* Generic link hash table destruction routine.  */
 609 extern void _bfd_generic_link_hash_table_free
 610   (bfd *);
 611
 612 /* Generic add symbol routine.  */
 613 extern bfd_boolean _bfd_generic_link_add_symbols
 614   (bfd *, struct bfd_link_info *);
 615
 616 /* Generic add symbol routine.  This version is used by targets for
 617    which the linker must collect constructors and destructors by name,
 618    as the collect2 program does.  */
 619 extern bfd_boolean _bfd_generic_link_add_symbols_collect
 620   (bfd *, struct bfd_link_info *);
 621
 622 /* Generic archive add symbol routine.  */
 623 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 624   (bfd *, struct bfd_link_info *,
 625    bfd_boolean (*) (bfd *, struct bfd_link_info *,
 626                     struct bfd_link_hash_entry *, const char *,
 627                     bfd_boolean *));
 628
 629 /* Forward declaration to avoid prototype errors.  */
 630 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 631
 632 /* Generic routine to add a single symbol.  */
 633 extern bfd_boolean _bfd_generic_link_add_one_symbol
 634   (struct bfd_link_info *, bfd *, const char *name, flagword,
 635    asection *, bfd_vma, const char *, bfd_boolean copy,
 636    bfd_boolean constructor, struct bfd_link_hash_entry **);
 637
 638 /* Generic routine to mark section as supplying symbols only.  */
 639 extern void _bfd_generic_link_just_syms
 640   (asection *, struct bfd_link_info *);
 641
 642 /* Generic routine that does nothing.  */
 643 extern void _bfd_generic_copy_link_hash_symbol_type
 644   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
 645
 646 /* Generic link routine.  */
 647 extern bfd_boolean _bfd_generic_final_link
 648   (bfd *, struct bfd_link_info *);
 649
 650 extern bfd_boolean _bfd_generic_link_split_section
 651   (bfd *, struct bfd_section *);
 652
 653 extern bfd_boolean _bfd_generic_section_already_linked
 654   (bfd *, asection *, struct bfd_link_info *);
 655
 656 /* Generic reloc_link_order processing routine.  */
 657 extern bfd_boolean _bfd_generic_reloc_link_order
 658   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 659
 660 /* Default link order processing routine.  */
 661 extern bfd_boolean _bfd_default_link_order
 662   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 663
 664 /* Count the number of reloc entries in a link order list.  */
 665 extern unsigned int _bfd_count_link_order_relocs
 666   (struct bfd_link_order *);
 667
 668 /* Final link relocation routine.  */
 669 extern bfd_reloc_status_type _bfd_final_link_relocate
 670   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 671    bfd_vma, bfd_vma, bfd_vma);
 672
 673 /* Relocate a particular location by a howto and a value.  */
 674 extern bfd_reloc_status_type _bfd_relocate_contents
 675   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 676
 677 /* Clear a given location using a given howto.  */
 678 extern void _bfd_clear_contents (reloc_howto_type *howto, bfd *input_bfd,
 679                                  asection *input_section, bfd_byte *location);
 680
 681 /* Link stabs in sections in the first pass.  */
 682
 683 extern bfd_boolean _bfd_link_section_stabs
 684   (bfd *, struct stab_info *, asection *, asection *, void **,
 685    bfd_size_type *);
 686
 687 /* Eliminate stabs for discarded functions and symbols.  */
 688 extern bfd_boolean _bfd_discard_section_stabs
 689   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 690
 691 /* Write out the .stab section when linking stabs in sections.  */
 692
 693 extern bfd_boolean _bfd_write_section_stabs
 694   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 695
 696 /* Write out the .stabstr string table when linking stabs in sections.  */
 697
 698 extern bfd_boolean _bfd_write_stab_strings
 699   (bfd *, struct stab_info *);
 700
 701 /* Find an offset within a .stab section when linking stabs in
 702    sections.  */
 703
 704 extern bfd_vma _bfd_stab_section_offset
 705   (asection *, void *, bfd_vma);
 706
 707 /* Register a SEC_MERGE section as a candidate for merging.  */
 708
 709 extern bfd_boolean _bfd_add_merge_section
 710   (bfd *, void **, asection *, void **);
 711
 712 /* Attempt to merge SEC_MERGE sections.  */
 713
 714 extern bfd_boolean _bfd_merge_sections
 715   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 716
 717 /* Write out a merged section.  */
 718
 719 extern bfd_boolean _bfd_write_merged_section
 720   (bfd *, asection *, void *);
 721
 722 /* Find an offset within a modified SEC_MERGE section.  */
 723
 724 extern bfd_vma _bfd_merged_section_offset
 725   (bfd *, asection **, void *, bfd_vma);
 726
 727 /* Tidy up when done.  */
 728
 729 extern void _bfd_merge_sections_free (void *);
 730
 731 /* Create a string table.  */
 732 extern struct bfd_strtab_hash *_bfd_stringtab_init
 733   (void);
 734
 735 /* Create an XCOFF .debug section style string table.  */
 736 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 737   (void);
 738
 739 /* Free a string table.  */
 740 extern void _bfd_stringtab_free
 741   (struct bfd_strtab_hash *);
 742
 743 /* Get the size of a string table.  */
 744 extern bfd_size_type _bfd_stringtab_size
 745   (struct bfd_strtab_hash *);
 746
 747 /* Add a string to a string table.  */
 748 extern bfd_size_type _bfd_stringtab_add
 749   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 750
 751 /* Write out a string table.  */
 752 extern bfd_boolean _bfd_stringtab_emit
 753   (bfd *, struct bfd_strtab_hash *);
 754
 755 /* Check that endianness of input and output file match.  */
 756 extern bfd_boolean _bfd_generic_verify_endian_match
 757   (bfd *, bfd *);
 758 \f
 759 /* Macros to tell if bfds are read or write enabled.
 760
 761    Note that bfds open for read may be scribbled into if the fd passed
 762    to bfd_fdopenr is actually open both for read and write
 763    simultaneously.  However an output bfd will never be open for
 764    read.  Therefore sometimes you want to check bfd_read_p or
 765    !bfd_read_p, and only sometimes bfd_write_p.
 766 */
 767
 768 #define bfd_read_p(abfd) \
 769   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 770 #define bfd_write_p(abfd) \
 771   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 772
 773 void bfd_assert
 774   (const char*,int);
 775
 776 #define BFD_ASSERT(x) \
 777   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 778
 779 #define BFD_FAIL() \
 780   do { bfd_assert(__FILE__,__LINE__); } while (0)
 781
 782 extern void _bfd_abort
 783   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 784
 785 /* if gcc >= 2.6, we can give a function name, too */
 786 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 787 #define __PRETTY_FUNCTION__  ((char *) NULL)
 788 #endif
 789
 790 #undef abort
 791 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 792
 793 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 794    the system "off_t" or "off64_t", as the offset.  */
 795 extern file_ptr real_ftell (FILE *file);
 796 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 797 extern FILE *real_fopen (const char *filename, const char *modes);
 798
 799 /* List of supported target vectors, and the default vector (if
 800    bfd_default_vector[0] is NULL, there is no default).  */
 801 extern const bfd_target * const *bfd_target_vector;
 802 extern const bfd_target *bfd_default_vector[];
 803
 804 /* List of associated target vectors.  */
 805 extern const bfd_target * const *bfd_associated_vector;
 806
 807 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 808    other common header files.  */
 809
 810 #if defined(__STDC__) || defined(ALMOST_STDC)
 811 struct ecoff_find_line;
 812 #endif
 813
 814 extern bfd_boolean _bfd_ecoff_locate_line
 815   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 816    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 817    const char **, const char **, unsigned int *);
 818 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 819   (void *, bfd_byte *);
 820 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 821   (void *, bfd_byte *);
 822 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 823   (void *, bfd_byte *);
 824
 825 extern bfd_vma _bfd_get_gp_value
 826   (bfd *);
 827 extern void _bfd_set_gp_value
 828   (bfd *, bfd_vma);
 829
 830 /* Function shared by the COFF and ELF SH backends, which have no
 831    other common header files.  */
 832
 833 #ifndef _bfd_sh_align_load_span
 834 extern bfd_boolean _bfd_sh_align_load_span
 835   (bfd *, asection *, bfd_byte *,
 836    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 837    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 838 #endif
 839
 840 /* This is the shape of the elements inside the already_linked hash
 841    table. It maps a name onto a list of already_linked elements with
 842    the same name.  */
 843
 844 struct bfd_section_already_linked_hash_entry
 845 {
 846   struct bfd_hash_entry root;
 847   struct bfd_section_already_linked *entry;
 848 };
 849
 850 struct bfd_section_already_linked
 851 {
 852   struct bfd_section_already_linked *next;
 853   asection *sec;
 854 };
 855
 856 extern struct bfd_section_already_linked_hash_entry *
 857   bfd_section_already_linked_table_lookup (const char *);
 858 extern bfd_boolean bfd_section_already_linked_table_insert
 859   (struct bfd_section_already_linked_hash_entry *, asection *);
 860 extern void bfd_section_already_linked_table_traverse
 861   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 862                     void *), void *);
 863
 864 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 865 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
 866 extern bfd_vma safe_read_leb128 (bfd *, bfd_byte *, unsigned int *,
 867                                  bfd_boolean, const bfd_byte * const);