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