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