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