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