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-2018 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_error_handler (const char *s, ...);
 113
 114 /* These routines allocate and free things on the BFD's objalloc.  */
 115
 116 extern void *bfd_alloc2
 117   (bfd *, bfd_size_type, bfd_size_type);
 118 extern void *bfd_zalloc2
 119   (bfd *, bfd_size_type, bfd_size_type);
 120 extern void bfd_release
 121   (bfd *, void *);
 122
 123 bfd * _bfd_create_empty_archive_element_shell
 124   (bfd *);
 125 bfd * _bfd_look_for_bfd_in_cache
 126   (bfd *, file_ptr);
 127 bfd_boolean _bfd_add_bfd_to_archive_cache
 128   (bfd *, file_ptr, bfd *);
 129 bfd_boolean _bfd_generic_mkarchive
 130   (bfd *);
 131 char *_bfd_append_relative_path
 132   (bfd *, char *);
 133 const bfd_target *bfd_generic_archive_p
 134   (bfd *);
 135 bfd_boolean bfd_slurp_armap
 136   (bfd *);
 137 bfd_boolean bfd_slurp_bsd_armap_f2
 138   (bfd *);
 139 #define bfd_slurp_bsd_armap bfd_slurp_armap
 140 #define bfd_slurp_coff_armap bfd_slurp_armap
 141 bfd_boolean _bfd_archive_64_bit_slurp_armap
 142   (bfd *);
 143 bfd_boolean _bfd_archive_64_bit_write_armap
 144   (bfd *, unsigned int, struct orl *, unsigned int, int);
 145 #define _bfd_archive_64_bit_slurp_extended_name_table \
 146   _bfd_slurp_extended_name_table
 147 #define _bfd_archive_64_bit_construct_extended_name_table \
 148   _bfd_archive_coff_construct_extended_name_table
 149 #define _bfd_archive_64_bit_truncate_arname \
 150   bfd_dont_truncate_arname
 151 #define _bfd_archive_64_bit_read_ar_hdr \
 152   _bfd_generic_read_ar_hdr
 153 #define _bfd_archive_64_bit_write_ar_hdr \
 154   _bfd_generic_write_ar_hdr
 155 #define _bfd_archive_64_bit_openr_next_archived_file \
 156   bfd_generic_openr_next_archived_file
 157 #define _bfd_archive_64_bit_get_elt_at_index \
 158   _bfd_generic_get_elt_at_index
 159 #define _bfd_archive_64_bit_generic_stat_arch_elt \
 160   bfd_generic_stat_arch_elt
 161 #define _bfd_archive_64_bit_update_armap_timestamp _bfd_bool_bfd_true
 162
 163 bfd_boolean _bfd_slurp_extended_name_table
 164   (bfd *);
 165 extern bfd_boolean _bfd_construct_extended_name_table
 166   (bfd *, bfd_boolean, char **, bfd_size_type *);
 167 bfd_boolean _bfd_write_archive_contents
 168   (bfd *);
 169 bfd_boolean _bfd_compute_and_write_armap
 170   (bfd *, unsigned int);
 171 bfd *_bfd_get_elt_at_filepos
 172   (bfd *, file_ptr);
 173 extern bfd *_bfd_generic_get_elt_at_index
 174   (bfd *, symindex);
 175 bfd * _bfd_new_bfd
 176   (void);
 177 bfd_boolean _bfd_free_cached_info
 178   (bfd *);
 179
 180 extern bfd_boolean _bfd_bool_bfd_false
 181   (bfd *);
 182 extern bfd_boolean _bfd_bool_bfd_asymbol_false
 183   (bfd *, asymbol *);
 184 extern bfd_boolean _bfd_bool_bfd_false_error
 185   (bfd *);
 186 extern bfd_boolean _bfd_bool_bfd_link_false_error
 187   (bfd *, struct bfd_link_info *);
 188 extern bfd_boolean _bfd_bool_bfd_true
 189   (bfd *);
 190 extern bfd_boolean _bfd_bool_bfd_link_true
 191   (bfd *, struct bfd_link_info *);
 192 extern bfd_boolean _bfd_bool_bfd_bfd_true
 193   (bfd *, bfd *);
 194 extern bfd_boolean _bfd_bool_bfd_uint_true
 195   (bfd *, unsigned int);
 196 extern bfd_boolean _bfd_bool_bfd_asection_bfd_asection_true
 197   (bfd *, asection *, bfd *, asection *);
 198 extern bfd_boolean _bfd_bool_bfd_asymbol_bfd_asymbol_true
 199   (bfd *, asymbol *, bfd *, asymbol *);
 200 extern bfd_boolean _bfd_bool_bfd_ptr_true
 201   (bfd *, void *);
 202 extern void *_bfd_ptr_bfd_null_error
 203   (bfd *);
 204 extern int _bfd_int_bfd_0
 205   (bfd *);
 206 extern unsigned int _bfd_uint_bfd_0
 207   (bfd *);
 208 extern long _bfd_long_bfd_0
 209   (bfd *);
 210 extern long _bfd_long_bfd_n1_error
 211   (bfd *);
 212 extern void _bfd_void_bfd
 213   (bfd *);
 214 extern void _bfd_void_bfd_link
 215   (bfd *, struct bfd_link_info *);
 216 extern void _bfd_void_bfd_asection
 217   (bfd *, asection *);
 218
 219 bfd *_bfd_new_bfd_contained_in
 220   (bfd *);
 221 const bfd_target *_bfd_dummy_target
 222   (bfd *);
 223
 224 void bfd_dont_truncate_arname
 225   (bfd *, const char *, char *);
 226 void bfd_bsd_truncate_arname
 227   (bfd *, const char *, char *);
 228 void bfd_gnu_truncate_arname
 229   (bfd *, const char *, char *);
 230
 231 bfd_boolean _bfd_bsd_write_armap
 232   (bfd *, unsigned int, struct orl *, unsigned int, int);
 233
 234 bfd_boolean _bfd_coff_write_armap
 235   (bfd *, unsigned int, struct orl *, unsigned int, int);
 236
 237 extern void *_bfd_generic_read_ar_hdr
 238   (bfd *);
 239 extern void _bfd_ar_spacepad
 240   (char *, size_t, const char *, long);
 241 extern bfd_boolean _bfd_ar_sizepad
 242   (char *, size_t, bfd_size_type);
 243
 244 extern void *_bfd_generic_read_ar_hdr_mag
 245   (bfd *, const char *);
 246
 247 extern bfd_boolean _bfd_generic_write_ar_hdr
 248   (bfd *, bfd *);
 249
 250 extern bfd_boolean _bfd_bsd44_write_ar_hdr
 251   (bfd *, bfd *);
 252
 253 bfd * bfd_generic_openr_next_archived_file
 254   (bfd *, bfd *);
 255
 256 int bfd_generic_stat_arch_elt
 257   (bfd *, struct stat *);
 258
 259 #define _bfd_read_ar_hdr(abfd) \
 260         BFD_SEND (abfd, _bfd_read_ar_hdr_fn, (abfd))
 261 #define _bfd_write_ar_hdr(archive, abfd)         \
 262         BFD_SEND (abfd, _bfd_write_ar_hdr_fn, (archive, abfd))
 263 \f
 264 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
 265    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
 266
 267 #define _bfd_generic_close_and_cleanup _bfd_archive_close_and_cleanup
 268 extern bfd_boolean _bfd_archive_close_and_cleanup
 269   (bfd *);
 270 #define _bfd_generic_bfd_free_cached_info _bfd_bool_bfd_true
 271 extern bfd_boolean _bfd_generic_new_section_hook
 272   (bfd *, asection *);
 273 extern bfd_boolean _bfd_generic_get_section_contents
 274   (bfd *, asection *, void *, file_ptr, bfd_size_type);
 275 extern bfd_boolean _bfd_generic_get_section_contents_in_window
 276   (bfd *, asection *, bfd_window *, file_ptr, bfd_size_type);
 277
 278 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 279    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 280
 281 #define _bfd_generic_bfd_copy_private_bfd_data _bfd_bool_bfd_bfd_true
 282 #define _bfd_generic_bfd_merge_private_bfd_data \
 283   _bfd_bool_bfd_link_true
 284 #define _bfd_generic_bfd_set_private_flags _bfd_bool_bfd_uint_true
 285 #define _bfd_generic_bfd_copy_private_section_data \
 286   _bfd_bool_bfd_asection_bfd_asection_true
 287 #define _bfd_generic_bfd_copy_private_symbol_data \
 288   _bfd_bool_bfd_asymbol_bfd_asymbol_true
 289 #define _bfd_generic_bfd_copy_private_header_data _bfd_bool_bfd_bfd_true
 290 #define _bfd_generic_bfd_print_private_bfd_data _bfd_bool_bfd_ptr_true
 291
 292 extern bfd_boolean _bfd_generic_init_private_section_data
 293   (bfd *, asection *, bfd *, asection *, struct bfd_link_info *);
 294
 295 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 296    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 297
 298 extern char *_bfd_nocore_core_file_failing_command
 299   (bfd *);
 300 extern int _bfd_nocore_core_file_failing_signal
 301   (bfd *);
 302 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
 303   (bfd *, bfd *);
 304 extern int _bfd_nocore_core_file_pid
 305   (bfd *);
 306
 307 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
 308    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
 309
 310 #define _bfd_noarchive_slurp_armap _bfd_bool_bfd_false_error
 311 #define _bfd_noarchive_slurp_extended_name_table _bfd_bool_bfd_false_error
 312 extern bfd_boolean _bfd_noarchive_construct_extended_name_table
 313   (bfd *, char **, bfd_size_type *, const char **);
 314 extern void _bfd_noarchive_truncate_arname
 315   (bfd *, const char *, char *);
 316 extern bfd_boolean _bfd_noarchive_write_armap
 317   (bfd *, unsigned int, struct orl *, unsigned int, int);
 318 #define _bfd_noarchive_read_ar_hdr _bfd_ptr_bfd_null_error
 319 extern bfd_boolean _bfd_noarchive_write_ar_hdr
 320   (bfd *, bfd *);
 321 extern bfd *
 322 _bfd_noarchive_openr_next_archived_file
 323   (bfd *, bfd *);
 324 extern bfd * _bfd_noarchive_get_elt_at_index
 325   (bfd *, symindex);
 326 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
 327 #define _bfd_noarchive_update_armap_timestamp _bfd_bool_bfd_false_error
 328
 329 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
 330    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
 331
 332 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
 333 #define _bfd_archive_bsd_slurp_extended_name_table \
 334   _bfd_slurp_extended_name_table
 335 extern bfd_boolean _bfd_archive_bsd_construct_extended_name_table
 336   (bfd *, char **, bfd_size_type *, const char **);
 337 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
 338 #define _bfd_archive_bsd_write_armap _bfd_bsd_write_armap
 339 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
 340 #define _bfd_archive_bsd_write_ar_hdr _bfd_generic_write_ar_hdr
 341 #define _bfd_archive_bsd_openr_next_archived_file \
 342   bfd_generic_openr_next_archived_file
 343 #define _bfd_archive_bsd_get_elt_at_index _bfd_generic_get_elt_at_index
 344 #define _bfd_archive_bsd_generic_stat_arch_elt \
 345   bfd_generic_stat_arch_elt
 346 extern bfd_boolean _bfd_archive_bsd_update_armap_timestamp
 347   (bfd *);
 348
 349 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
 350    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
 351
 352 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
 353 #define _bfd_archive_coff_slurp_extended_name_table \
 354   _bfd_slurp_extended_name_table
 355 extern bfd_boolean _bfd_archive_coff_construct_extended_name_table
 356   (bfd *, char **, bfd_size_type *, const char **);
 357 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
 358 #define _bfd_archive_coff_write_armap _bfd_coff_write_armap
 359 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
 360 #define _bfd_archive_coff_write_ar_hdr _bfd_generic_write_ar_hdr
 361 #define _bfd_archive_coff_openr_next_archived_file \
 362   bfd_generic_openr_next_archived_file
 363 #define _bfd_archive_coff_get_elt_at_index _bfd_generic_get_elt_at_index
 364 #define _bfd_archive_coff_generic_stat_arch_elt \
 365   bfd_generic_stat_arch_elt
 366 #define _bfd_archive_coff_update_armap_timestamp _bfd_bool_bfd_true
 367
 368 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD4.4 style
 369    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd44).  */
 370
 371 #define _bfd_archive_bsd44_slurp_armap bfd_slurp_bsd_armap
 372 #define _bfd_archive_bsd44_slurp_extended_name_table \
 373   _bfd_slurp_extended_name_table
 374 extern bfd_boolean _bfd_archive_bsd44_construct_extended_name_table
 375   (bfd *, char **, bfd_size_type *, const char **);
 376 #define _bfd_archive_bsd44_truncate_arname bfd_bsd_truncate_arname
 377 #define _bfd_archive_bsd44_write_armap _bfd_bsd_write_armap
 378 #define _bfd_archive_bsd44_read_ar_hdr _bfd_generic_read_ar_hdr
 379 #define _bfd_archive_bsd44_write_ar_hdr _bfd_bsd44_write_ar_hdr
 380 #define _bfd_archive_bsd44_openr_next_archived_file \
 381   bfd_generic_openr_next_archived_file
 382 #define _bfd_archive_bsd44_get_elt_at_index _bfd_generic_get_elt_at_index
 383 #define _bfd_archive_bsd44_generic_stat_arch_elt \
 384   bfd_generic_stat_arch_elt
 385 #define _bfd_archive_bsd44_update_armap_timestamp \
 386   _bfd_archive_bsd_update_armap_timestamp
 387
 388 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get VMS style
 389    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_vms_lib).  Some of them
 390    are irrelevant.  */
 391
 392 extern bfd_boolean _bfd_vms_lib_write_archive_contents (bfd *);
 393 #define _bfd_vms_lib_slurp_armap _bfd_noarchive_slurp_armap
 394 #define _bfd_vms_lib_slurp_extended_name_table \
 395   _bfd_noarchive_slurp_extended_name_table
 396 #define _bfd_vms_lib_construct_extended_name_table \
 397   _bfd_noarchive_construct_extended_name_table
 398 #define _bfd_vms_lib_truncate_arname _bfd_noarchive_truncate_arname
 399 #define _bfd_vms_lib_write_armap _bfd_noarchive_write_armap
 400 #define _bfd_vms_lib_read_ar_hdr _bfd_noarchive_read_ar_hdr
 401 #define _bfd_vms_lib_write_ar_hdr _bfd_noarchive_write_ar_hdr
 402 extern bfd *_bfd_vms_lib_openr_next_archived_file (bfd *, bfd *);
 403 extern bfd *_bfd_vms_lib_get_elt_at_index (bfd *, symindex);
 404 extern int _bfd_vms_lib_generic_stat_arch_elt (bfd *, struct stat *);
 405 #define _bfd_vms_lib_update_armap_timestamp _bfd_bool_bfd_true
 406
 407 /* Extra routines for VMS style archives.  */
 408
 409 extern symindex _bfd_vms_lib_find_symbol (bfd *, const char *);
 410 extern bfd *_bfd_vms_lib_get_imagelib_file (bfd *);
 411 extern const bfd_target *_bfd_vms_lib_alpha_archive_p (bfd *);
 412 extern const bfd_target *_bfd_vms_lib_ia64_archive_p (bfd *);
 413 extern bfd_boolean _bfd_vms_lib_alpha_mkarchive (bfd *);
 414 extern bfd_boolean _bfd_vms_lib_ia64_mkarchive (bfd *);
 415
 416 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
 417    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 418
 419 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_long_bfd_n1_error
 420 extern long _bfd_nosymbols_canonicalize_symtab
 421   (bfd *, asymbol **);
 422 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
 423 extern void _bfd_nosymbols_print_symbol
 424   (bfd *, void *, asymbol *, bfd_print_symbol_type);
 425 extern void _bfd_nosymbols_get_symbol_info
 426   (bfd *, asymbol *, symbol_info *);
 427 extern const char * _bfd_nosymbols_get_symbol_version_string
 428   (bfd *, asymbol *, bfd_boolean *);
 429 extern bfd_boolean _bfd_nosymbols_bfd_is_local_label_name
 430   (bfd *, const char *);
 431 #define _bfd_nosymbols_bfd_is_target_special_symbol _bfd_bool_bfd_asymbol_false
 432 extern alent *_bfd_nosymbols_get_lineno
 433   (bfd *, asymbol *);
 434 extern bfd_boolean _bfd_nosymbols_find_nearest_line
 435   (bfd *, asymbol **, asection *, bfd_vma,
 436    const char **, const char **, unsigned int *, unsigned int *);
 437 extern bfd_boolean _bfd_nosymbols_find_line
 438   (bfd *, asymbol **, asymbol *, const char **, unsigned int *);
 439 extern bfd_boolean _bfd_nosymbols_find_inliner_info
 440   (bfd *, const char **, const char **, unsigned int *);
 441 extern asymbol *_bfd_nosymbols_bfd_make_debug_symbol
 442   (bfd *, void *, unsigned long);
 443 extern long _bfd_nosymbols_read_minisymbols
 444   (bfd *, bfd_boolean, void **, unsigned int *);
 445 extern asymbol *_bfd_nosymbols_minisymbol_to_symbol
 446   (bfd *, bfd_boolean, const void *, asymbol *);
 447
 448 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 449    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 450
 451 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
 452 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
 453                                               arelent **, asymbol **);
 454 extern void _bfd_norelocs_set_reloc (bfd *, asection *,
 455                                      arelent **, unsigned int);
 456 extern reloc_howto_type *_bfd_norelocs_bfd_reloc_type_lookup
 457   (bfd *, bfd_reloc_code_real_type);
 458 extern reloc_howto_type *_bfd_norelocs_bfd_reloc_name_lookup
 459   (bfd *, const char *);
 460
 461 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 462    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 463
 464 extern bfd_boolean _bfd_nowrite_set_arch_mach
 465   (bfd *, enum bfd_architecture, unsigned long);
 466 extern bfd_boolean _bfd_nowrite_set_section_contents
 467   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 468
 469 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 470    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 471
 472 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 473 extern bfd_boolean _bfd_generic_set_section_contents
 474   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 475
 476 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 477    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 478
 479 extern int _bfd_nolink_sizeof_headers
 480   (bfd *, struct bfd_link_info *);
 481 extern bfd_byte *_bfd_nolink_bfd_get_relocated_section_contents
 482   (bfd *, struct bfd_link_info *, struct bfd_link_order *,
 483    bfd_byte *, bfd_boolean, asymbol **);
 484 extern bfd_boolean _bfd_nolink_bfd_relax_section
 485   (bfd *, asection *, struct bfd_link_info *, bfd_boolean *);
 486 #define _bfd_nolink_bfd_gc_sections _bfd_bool_bfd_link_false_error
 487 extern bfd_boolean _bfd_nolink_bfd_lookup_section_flags
 488   (struct bfd_link_info *, struct flag_info *, asection *);
 489 #define _bfd_nolink_bfd_merge_sections _bfd_bool_bfd_link_false_error
 490 extern bfd_boolean _bfd_nolink_bfd_is_group_section
 491   (bfd *, const asection *);
 492 extern bfd_boolean _bfd_nolink_bfd_discard_group
 493   (bfd *, asection *);
 494 extern struct bfd_link_hash_table *_bfd_nolink_bfd_link_hash_table_create
 495   (bfd *);
 496 #define _bfd_nolink_bfd_link_add_symbols _bfd_bool_bfd_link_false_error
 497 extern void _bfd_nolink_bfd_link_just_syms
 498   (asection *, struct bfd_link_info *);
 499 extern void _bfd_nolink_bfd_copy_link_hash_symbol_type
 500   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
 501 #define _bfd_nolink_bfd_final_link _bfd_bool_bfd_link_false_error
 502 extern bfd_boolean _bfd_nolink_bfd_link_split_section
 503   (bfd *, struct bfd_section *);
 504 extern bfd_boolean _bfd_nolink_section_already_linked
 505   (bfd *, asection *, struct bfd_link_info *);
 506 extern bfd_boolean _bfd_nolink_bfd_define_common_symbol
 507   (bfd *, struct bfd_link_info *, struct bfd_link_hash_entry *);
 508 extern struct bfd_link_hash_entry *_bfd_nolink_bfd_define_start_stop
 509   (struct bfd_link_info *, const char *, asection *);
 510 #define _bfd_nolink_bfd_link_check_relocs \
 511   _bfd_generic_link_check_relocs
 512
 513 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 514    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 515    (_bfd_nodynamic).  */
 516
 517 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_long_bfd_n1_error
 518 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 519   _bfd_nosymbols_canonicalize_symtab
 520 extern long _bfd_nodynamic_get_synthetic_symtab
 521   (bfd *, long, asymbol **, long, asymbol **, asymbol **);
 522 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_long_bfd_n1_error
 523 extern long _bfd_nodynamic_canonicalize_dynamic_reloc
 524   (bfd *, arelent **, asymbol **);
 525 \f
 526 /* Generic routine to determine of the given symbol is a local
 527    label.  */
 528 extern bfd_boolean bfd_generic_is_local_label_name
 529   (bfd *, const char *);
 530
 531 /* Generic minisymbol routines.  */
 532 extern long _bfd_generic_read_minisymbols
 533   (bfd *, bfd_boolean, void **, unsigned int *);
 534 extern asymbol *_bfd_generic_minisymbol_to_symbol
 535   (bfd *, bfd_boolean, const void *, asymbol *);
 536
 537 /* Find the nearest line using .stab/.stabstr sections.  */
 538 extern bfd_boolean _bfd_stab_section_find_nearest_line
 539   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 540    const char **, const char **, unsigned int *, void **);
 541
 542 /* Find the nearest line using DWARF 1 debugging information.  */
 543 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 544   (bfd *, asymbol **, asection *, bfd_vma,
 545    const char **, const char **, unsigned int *);
 546
 547 struct dwarf_debug_section
 548 {
 549   const char * uncompressed_name;
 550   const char * compressed_name;
 551 };
 552
 553 /* Map of uncompressed DWARF debug section name to compressed one.  It
 554    is terminated by NULL uncompressed_name.  */
 555
 556 extern const struct dwarf_debug_section dwarf_debug_sections[];
 557
 558 /* Find the nearest line using DWARF 2 debugging information.  */
 559 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 560   (bfd *, asymbol **, asymbol *, asection *, bfd_vma,
 561    const char **, const char **, unsigned int *, unsigned int *,
 562    const struct dwarf_debug_section *, unsigned int, void **);
 563
 564 /* Find the bias between DWARF addresses and real addresses.  */
 565 extern bfd_signed_vma _bfd_dwarf2_find_symbol_bias
 566   (asymbol **, void **);
 567
 568 /* Find inliner info after calling bfd_find_nearest_line. */
 569 extern bfd_boolean _bfd_dwarf2_find_inliner_info
 570   (bfd *, const char **, const char **, unsigned int *, void **);
 571
 572 /* Read DWARF 2 debugging information. */
 573 extern bfd_boolean _bfd_dwarf2_slurp_debug_info
 574   (bfd *, bfd *, const struct dwarf_debug_section *, asymbol **, void **,
 575    bfd_boolean);
 576
 577 /* Clean up the data used to handle DWARF 2 debugging information. */
 578 extern void _bfd_dwarf2_cleanup_debug_info
 579   (bfd *, void **);
 580
 581 /* Create a new section entry.  */
 582 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 583   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 584
 585 /* A routine to create entries for a bfd_link_hash_table.  */
 586 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 587   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 588    const char *string);
 589
 590 /* Initialize a bfd_link_hash_table.  */
 591 extern bfd_boolean _bfd_link_hash_table_init
 592   (struct bfd_link_hash_table *, bfd *,
 593    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 594                                struct bfd_hash_table *,
 595                                const char *),
 596    unsigned int);
 597
 598 /* Generic link hash table creation routine.  */
 599 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 600   (bfd *);
 601
 602 /* Generic link hash table destruction routine.  */
 603 extern void _bfd_generic_link_hash_table_free
 604   (bfd *);
 605
 606 /* Generic add symbol routine.  */
 607 extern bfd_boolean _bfd_generic_link_add_symbols
 608   (bfd *, struct bfd_link_info *);
 609
 610 /* Generic archive add symbol routine.  */
 611 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 612   (bfd *, struct bfd_link_info *,
 613    bfd_boolean (*) (bfd *, struct bfd_link_info *,
 614                     struct bfd_link_hash_entry *, const char *,
 615                     bfd_boolean *));
 616
 617 /* Forward declaration to avoid prototype errors.  */
 618 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 619
 620 /* Generic routine to add a single symbol.  */
 621 extern bfd_boolean _bfd_generic_link_add_one_symbol
 622   (struct bfd_link_info *, bfd *, const char *name, flagword,
 623    asection *, bfd_vma, const char *, bfd_boolean copy,
 624    bfd_boolean constructor, struct bfd_link_hash_entry **);
 625
 626 /* Generic routine to mark section as supplying symbols only.  */
 627 extern void _bfd_generic_link_just_syms
 628   (asection *, struct bfd_link_info *);
 629
 630 /* Generic routine that does nothing.  */
 631 extern void _bfd_generic_copy_link_hash_symbol_type
 632   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
 633
 634 /* Generic link routine.  */
 635 extern bfd_boolean _bfd_generic_final_link
 636   (bfd *, struct bfd_link_info *);
 637
 638 extern bfd_boolean _bfd_generic_link_split_section
 639   (bfd *, struct bfd_section *);
 640
 641 extern bfd_boolean _bfd_generic_section_already_linked
 642   (bfd *, asection *, struct bfd_link_info *);
 643
 644 /* Generic reloc_link_order processing routine.  */
 645 extern bfd_boolean _bfd_generic_reloc_link_order
 646   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 647
 648 /* Default link order processing routine.  */
 649 extern bfd_boolean _bfd_default_link_order
 650   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 651
 652 /* Count the number of reloc entries in a link order list.  */
 653 extern unsigned int _bfd_count_link_order_relocs
 654   (struct bfd_link_order *);
 655
 656 /* Final link relocation routine.  */
 657 extern bfd_reloc_status_type _bfd_final_link_relocate
 658   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 659    bfd_vma, bfd_vma, bfd_vma);
 660
 661 /* Relocate a particular location by a howto and a value.  */
 662 extern bfd_reloc_status_type _bfd_relocate_contents
 663   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 664
 665 /* Clear a given location using a given howto.  */
 666 extern void _bfd_clear_contents (reloc_howto_type *howto, bfd *input_bfd,
 667                                  asection *input_section, bfd_byte *location);
 668
 669 /* Link stabs in sections in the first pass.  */
 670
 671 extern bfd_boolean _bfd_link_section_stabs
 672   (bfd *, struct stab_info *, asection *, asection *, void **,
 673    bfd_size_type *);
 674
 675 /* Eliminate stabs for discarded functions and symbols.  */
 676 extern bfd_boolean _bfd_discard_section_stabs
 677   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 678
 679 /* Write out the .stab section when linking stabs in sections.  */
 680
 681 extern bfd_boolean _bfd_write_section_stabs
 682   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 683
 684 /* Write out the .stabstr string table when linking stabs in sections.  */
 685
 686 extern bfd_boolean _bfd_write_stab_strings
 687   (bfd *, struct stab_info *);
 688
 689 /* Find an offset within a .stab section when linking stabs in
 690    sections.  */
 691
 692 extern bfd_vma _bfd_stab_section_offset
 693   (asection *, void *, bfd_vma);
 694
 695 /* Register a SEC_MERGE section as a candidate for merging.  */
 696
 697 extern bfd_boolean _bfd_add_merge_section
 698   (bfd *, void **, asection *, void **);
 699
 700 /* Attempt to merge SEC_MERGE sections.  */
 701
 702 extern bfd_boolean _bfd_merge_sections
 703   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 704
 705 /* Write out a merged section.  */
 706
 707 extern bfd_boolean _bfd_write_merged_section
 708   (bfd *, asection *, void *);
 709
 710 /* Find an offset within a modified SEC_MERGE section.  */
 711
 712 extern bfd_vma _bfd_merged_section_offset
 713   (bfd *, asection **, void *, bfd_vma);
 714
 715 /* Tidy up when done.  */
 716
 717 extern void _bfd_merge_sections_free (void *);
 718
 719 /* Create a string table.  */
 720 extern struct bfd_strtab_hash *_bfd_stringtab_init
 721   (void);
 722
 723 /* Create an XCOFF .debug section style string table.  */
 724 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 725   (void);
 726
 727 /* Free a string table.  */
 728 extern void _bfd_stringtab_free
 729   (struct bfd_strtab_hash *);
 730
 731 /* Get the size of a string table.  */
 732 extern bfd_size_type _bfd_stringtab_size
 733   (struct bfd_strtab_hash *);
 734
 735 /* Add a string to a string table.  */
 736 extern bfd_size_type _bfd_stringtab_add
 737   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 738
 739 /* Write out a string table.  */
 740 extern bfd_boolean _bfd_stringtab_emit
 741   (bfd *, struct bfd_strtab_hash *);
 742 \f
 743 /* Macros to tell if bfds are read or write enabled.
 744
 745    Note that bfds open for read may be scribbled into if the fd passed
 746    to bfd_fdopenr is actually open both for read and write
 747    simultaneously.  However an output bfd will never be open for
 748    read.  Therefore sometimes you want to check bfd_read_p or
 749    !bfd_read_p, and only sometimes bfd_write_p.
 750 */
 751
 752 #define bfd_read_p(abfd) \
 753   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 754 #define bfd_write_p(abfd) \
 755   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 756
 757 void bfd_assert
 758   (const char*,int);
 759
 760 #define BFD_ASSERT(x) \
 761   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 762
 763 #define BFD_FAIL() \
 764   do { bfd_assert(__FILE__,__LINE__); } while (0)
 765
 766 extern void _bfd_abort
 767   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 768
 769 /* if gcc >= 2.6, we can give a function name, too */
 770 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 771 #define __PRETTY_FUNCTION__  ((char *) NULL)
 772 #endif
 773
 774 #undef abort
 775 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 776
 777 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 778    the system "off_t" or "off64_t", as the offset.  */
 779 extern file_ptr _bfd_real_ftell (FILE *file);
 780 extern int _bfd_real_fseek (FILE *file, file_ptr offset, int whence);
 781 extern FILE *_bfd_real_fopen (const char *filename, const char *modes);
 782
 783 /* List of supported target vectors, and the default vector (if
 784    bfd_default_vector[0] is NULL, there is no default).  */
 785 extern const bfd_target * const *bfd_target_vector;
 786 extern const bfd_target *bfd_default_vector[];
 787
 788 /* List of associated target vectors.  */
 789 extern const bfd_target * const *bfd_associated_vector;
 790
 791 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 792    other common header files.  */
 793
 794 #if defined(__STDC__) || defined(ALMOST_STDC)
 795 struct ecoff_find_line;
 796 #endif
 797
 798 extern bfd_boolean _bfd_ecoff_locate_line
 799   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 800    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 801    const char **, const char **, unsigned int *);
 802 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 803   (void *, bfd_byte *);
 804 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 805   (void *, bfd_byte *);
 806 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 807   (void *, bfd_byte *);
 808
 809 extern bfd_vma _bfd_get_gp_value
 810   (bfd *);
 811 extern void _bfd_set_gp_value
 812   (bfd *, bfd_vma);
 813
 814 /* Function shared by the COFF and ELF SH backends, which have no
 815    other common header files.  */
 816
 817 #ifndef _bfd_sh_align_load_span
 818 extern bfd_boolean _bfd_sh_align_load_span
 819   (bfd *, asection *, bfd_byte *,
 820    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 821    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 822 #endif
 823
 824 /* This is the shape of the elements inside the already_linked hash
 825    table. It maps a name onto a list of already_linked elements with
 826    the same name.  */
 827
 828 struct bfd_section_already_linked_hash_entry
 829 {
 830   struct bfd_hash_entry root;
 831   struct bfd_section_already_linked *entry;
 832 };
 833
 834 struct bfd_section_already_linked
 835 {
 836   struct bfd_section_already_linked *next;
 837   asection *sec;
 838 };
 839
 840 extern struct bfd_section_already_linked_hash_entry *
 841   bfd_section_already_linked_table_lookup (const char *);
 842 extern bfd_boolean bfd_section_already_linked_table_insert
 843   (struct bfd_section_already_linked_hash_entry *, asection *);
 844 extern void bfd_section_already_linked_table_traverse
 845   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 846                     void *), void *);
 847
 848 extern bfd_vma _bfd_read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 849 extern bfd_signed_vma _bfd_read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
 850 extern bfd_vma _bfd_safe_read_leb128 (bfd *, bfd_byte *, unsigned int *,
 851                                       bfd_boolean, const bfd_byte * const);