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