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 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   5    1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
   6    2010, 2011, 2012
   7    Free Software Foundation, Inc.
   8
   9    Written by Cygnus Support.
  10
  11    This file is part of BFD, the Binary File Descriptor library.
  12
  13    This program is free software; you can redistribute it and/or modify
  14    it under the terms of the GNU General Public License as published by
  15    the Free Software Foundation; either version 3 of the License, or
  16    (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21    GNU General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  26    MA 02110-1301, USA.  */
  27
  28 #include "hashtab.h"
  29
  30 /* Align an address upward to a boundary, expressed as a number of bytes.
  31    E.g. align to an 8-byte boundary with argument of 8.  Take care never
  32    to wrap around if the address is within boundary-1 of the end of the
  33    address space.  */
  34 #define BFD_ALIGN(this, boundary)                                         \
  35   ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this))              \
  36    ? (((bfd_vma) (this) + ((boundary) - 1)) & ~ (bfd_vma) ((boundary)-1)) \
  37    : ~ (bfd_vma) 0)
  38
  39 /* If you want to read and write large blocks, you might want to do it
  40    in quanta of this amount */
  41 #define DEFAULT_BUFFERSIZE 8192
  42
  43 /* Set a tdata field.  Can't use the other macros for this, since they
  44    do casts, and casting to the left of assignment isn't portable.  */
  45 #define set_tdata(bfd, v) ((bfd)->tdata.any = (v))
  46
  47 /* If BFD_IN_MEMORY is set for a BFD, then the iostream fields points
  48    to an instance of this structure.  */
  49
  50 struct bfd_in_memory
  51 {
  52   /* Size of buffer.  */
  53   bfd_size_type size;
  54   /* Buffer holding contents of BFD.  */
  55   bfd_byte *buffer;
  56 };
  57
  58 struct section_hash_entry
  59 {
  60   struct bfd_hash_entry root;
  61   asection section;
  62 };
  63
  64 /* tdata for an archive.  For an input archive, cache
  65    needs to be free()'d.  For an output archive, symdefs do.  */
  66
  67 struct artdata
  68 {
  69   file_ptr first_file_filepos;
  70   /* Speed up searching the armap */
  71   htab_t cache;
  72   bfd *archive_head;            /* Only interesting in output routines.  */
  73   carsym *symdefs;              /* The symdef entries.  */
  74   symindex symdef_count;        /* How many there are.  */
  75   char *extended_names;         /* Clever intel extension.  */
  76   bfd_size_type extended_names_size; /* Size of extended names.  */
  77   /* When more compilers are standard C, this can be a time_t.  */
  78   long  armap_timestamp;        /* Timestamp value written into armap.
  79                                    This is used for BSD archives to check
  80                                    that the timestamp is recent enough
  81                                    for the BSD linker to not complain,
  82                                    just before we finish writing an
  83                                    archive.  */
  84   file_ptr armap_datepos;       /* Position within archive to seek to
  85                                    rewrite the date field.  */
  86   void *tdata;                  /* Backend specific information.  */
  87 };
  88
  89 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
  90
  91 /* Goes in bfd's arelt_data slot */
  92 struct areltdata
  93 {
  94   char * arch_header;           /* It's actually a string.  */
  95   bfd_size_type parsed_size;    /* Octets of filesize not including ar_hdr.  */
  96   bfd_size_type extra_size;     /* BSD4.4: extra bytes after the header.  */
  97   char *filename;               /* Null-terminated.  */
  98   file_ptr origin;              /* For element of a thin archive.  */
  99 };
 100
 101 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
 102
 103 extern void *bfd_malloc
 104   (bfd_size_type);
 105 extern void *bfd_realloc
 106   (void *, bfd_size_type);
 107 extern void *bfd_realloc_or_free
 108   (void *, bfd_size_type);
 109 extern void *bfd_zmalloc
 110   (bfd_size_type);
 111 extern void *bfd_malloc2
 112   (bfd_size_type, bfd_size_type);
 113 extern void *bfd_realloc2
 114   (void *, bfd_size_type, bfd_size_type);
 115 extern void *bfd_zmalloc2
 116   (bfd_size_type, bfd_size_type);
 117
 118 extern void _bfd_default_error_handler (const char *s, ...);
 119 extern bfd_error_handler_type _bfd_error_handler;
 120 extern bfd_assert_handler_type _bfd_assert_handler;
 121
 122 /* These routines allocate and free things on the BFD's objalloc.  */
 123
 124 extern void *bfd_alloc2
 125   (bfd *, bfd_size_type, bfd_size_type);
 126 extern void *bfd_zalloc2
 127   (bfd *, bfd_size_type, bfd_size_type);
 128 extern void bfd_release
 129   (bfd *, void *);
 130
 131 bfd * _bfd_create_empty_archive_element_shell
 132   (bfd *obfd);
 133 bfd * _bfd_look_for_bfd_in_cache
 134   (bfd *, file_ptr);
 135 bfd_boolean _bfd_add_bfd_to_archive_cache
 136   (bfd *, file_ptr, bfd *);
 137 bfd_boolean _bfd_generic_mkarchive
 138   (bfd *abfd);
 139 char *_bfd_append_relative_path
 140   (bfd *arch, char *elt_name);
 141 const bfd_target *bfd_generic_archive_p
 142   (bfd *abfd);
 143 bfd_boolean bfd_slurp_armap
 144   (bfd *abfd);
 145 bfd_boolean bfd_slurp_bsd_armap_f2
 146   (bfd *abfd);
 147 #define bfd_slurp_bsd_armap bfd_slurp_armap
 148 #define bfd_slurp_coff_armap bfd_slurp_armap
 149 bfd_boolean _bfd_slurp_extended_name_table
 150   (bfd *abfd);
 151 extern bfd_boolean _bfd_construct_extended_name_table
 152   (bfd *, bfd_boolean, char **, bfd_size_type *);
 153 bfd_boolean _bfd_write_archive_contents
 154   (bfd *abfd);
 155 bfd_boolean _bfd_compute_and_write_armap
 156   (bfd *, unsigned int elength);
 157 bfd *_bfd_get_elt_at_filepos
 158   (bfd *archive, file_ptr filepos);
 159 extern bfd *_bfd_generic_get_elt_at_index
 160   (bfd *, symindex);
 161 bfd * _bfd_new_bfd
 162   (void);
 163 bfd_boolean _bfd_free_cached_info
 164   (bfd *);
 165
 166 bfd_boolean bfd_false
 167   (bfd *ignore);
 168 bfd_boolean bfd_true
 169   (bfd *ignore);
 170 void *bfd_nullvoidptr
 171   (bfd *ignore);
 172 int bfd_0
 173   (bfd *ignore);
 174 unsigned int bfd_0u
 175   (bfd *ignore);
 176 long bfd_0l
 177   (bfd *ignore);
 178 long _bfd_n1
 179   (bfd *ignore);
 180 void bfd_void
 181   (bfd *ignore);
 182
 183 bfd *_bfd_new_bfd_contained_in
 184   (bfd *);
 185 const bfd_target *_bfd_dummy_target
 186   (bfd *abfd);
 187
 188 void bfd_dont_truncate_arname
 189   (bfd *abfd, const char *filename, char *hdr);
 190 void bfd_bsd_truncate_arname
 191   (bfd *abfd, const char *filename, char *hdr);
 192 void bfd_gnu_truncate_arname
 193   (bfd *abfd, const char *filename, char *hdr);
 194
 195 bfd_boolean bsd_write_armap
 196   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 197    int stridx);
 198
 199 bfd_boolean coff_write_armap
 200   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 201    int stridx);
 202
 203 extern void *_bfd_generic_read_ar_hdr
 204   (bfd *);
 205 extern void _bfd_ar_spacepad
 206   (char *, size_t, const char *, long);
 207 extern bfd_boolean _bfd_ar_sizepad
 208   (char *, size_t, bfd_size_type);
 209
 210 extern void *_bfd_generic_read_ar_hdr_mag
 211   (bfd *, const char *);
 212
 213 extern bfd_boolean _bfd_generic_write_ar_hdr
 214   (bfd *, bfd *);
 215
 216 extern bfd_boolean _bfd_bsd44_write_ar_hdr
 217   (bfd *, bfd *);
 218
 219 bfd * bfd_generic_openr_next_archived_file
 220   (bfd *archive, bfd *last_file);
 221
 222 int bfd_generic_stat_arch_elt
 223   (bfd *, struct stat *);
 224
 225 #define _bfd_read_ar_hdr(abfd) \
 226   BFD_SEND (abfd, _bfd_read_ar_hdr_fn, (abfd))
 227 #define _bfd_write_ar_hdr(archive, abfd)         \
 228   BFD_SEND (abfd, _bfd_write_ar_hdr_fn, (archive, abfd))
 229 \f
 230 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
 231    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
 232
 233 #define _bfd_generic_close_and_cleanup bfd_true
 234 #define _bfd_generic_bfd_free_cached_info bfd_true
 235 extern bfd_boolean _bfd_generic_new_section_hook
 236   (bfd *, asection *);
 237 extern bfd_boolean _bfd_generic_get_section_contents
 238   (bfd *, asection *, void *, file_ptr, bfd_size_type);
 239 extern bfd_boolean _bfd_generic_get_section_contents_in_window
 240   (bfd *, asection *, bfd_window *, file_ptr, bfd_size_type);
 241
 242 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 243    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 244
 245 #define _bfd_generic_bfd_copy_private_bfd_data \
 246   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 247 #define _bfd_generic_bfd_merge_private_bfd_data \
 248   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 249 #define _bfd_generic_bfd_set_private_flags \
 250   ((bfd_boolean (*) (bfd *, flagword)) bfd_true)
 251 #define _bfd_generic_bfd_copy_private_section_data \
 252   ((bfd_boolean (*) (bfd *, asection *, bfd *, asection *)) bfd_true)
 253 #define _bfd_generic_bfd_copy_private_symbol_data \
 254   ((bfd_boolean (*) (bfd *, asymbol *, bfd *, asymbol *)) bfd_true)
 255 #define _bfd_generic_bfd_copy_private_header_data \
 256   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 257 #define _bfd_generic_bfd_print_private_bfd_data \
 258   ((bfd_boolean (*) (bfd *, void *)) bfd_true)
 259
 260 extern bfd_boolean _bfd_generic_init_private_section_data
 261   (bfd *, asection *, bfd *, asection *, struct bfd_link_info *);
 262
 263 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 264    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 265
 266 extern char *_bfd_nocore_core_file_failing_command
 267   (bfd *);
 268 extern int _bfd_nocore_core_file_failing_signal
 269   (bfd *);
 270 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
 271   (bfd *, bfd *);
 272 extern int _bfd_nocore_core_file_pid
 273   (bfd *);
 274
 275 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
 276    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
 277
 278 #define _bfd_noarchive_slurp_armap bfd_false
 279 #define _bfd_noarchive_slurp_extended_name_table bfd_false
 280 #define _bfd_noarchive_construct_extended_name_table \
 281   ((bfd_boolean (*) (bfd *, char **, bfd_size_type *, const char **)) \
 282    bfd_false)
 283 #define _bfd_noarchive_truncate_arname \
 284   ((void (*) (bfd *, const char *, char *)) bfd_void)
 285 #define _bfd_noarchive_write_armap \
 286   ((bfd_boolean (*) (bfd *, unsigned int, struct orl *, unsigned int, int)) \
 287    bfd_false)
 288 #define _bfd_noarchive_read_ar_hdr bfd_nullvoidptr
 289 #define _bfd_noarchive_write_ar_hdr \
 290   ((bfd_boolean (*) (bfd *, bfd *)) bfd_false)
 291 #define _bfd_noarchive_openr_next_archived_file \
 292   ((bfd *(*) (bfd *, bfd *)) bfd_nullvoidptr)
 293 #define _bfd_noarchive_get_elt_at_index \
 294   ((bfd *(*) (bfd *, symindex)) bfd_nullvoidptr)
 295 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
 296 #define _bfd_noarchive_update_armap_timestamp bfd_false
 297
 298 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
 299    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
 300
 301 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
 302 #define _bfd_archive_bsd_slurp_extended_name_table \
 303   _bfd_slurp_extended_name_table
 304 extern bfd_boolean _bfd_archive_bsd_construct_extended_name_table
 305   (bfd *, char **, bfd_size_type *, const char **);
 306 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
 307 #define _bfd_archive_bsd_write_armap bsd_write_armap
 308 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
 309 #define _bfd_archive_bsd_write_ar_hdr _bfd_generic_write_ar_hdr
 310 #define _bfd_archive_bsd_openr_next_archived_file \
 311   bfd_generic_openr_next_archived_file
 312 #define _bfd_archive_bsd_get_elt_at_index _bfd_generic_get_elt_at_index
 313 #define _bfd_archive_bsd_generic_stat_arch_elt \
 314   bfd_generic_stat_arch_elt
 315 extern bfd_boolean _bfd_archive_bsd_update_armap_timestamp
 316   (bfd *);
 317
 318 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
 319    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
 320
 321 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
 322 #define _bfd_archive_coff_slurp_extended_name_table \
 323   _bfd_slurp_extended_name_table
 324 extern bfd_boolean _bfd_archive_coff_construct_extended_name_table
 325   (bfd *, char **, bfd_size_type *, const char **);
 326 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
 327 #define _bfd_archive_coff_write_armap coff_write_armap
 328 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
 329 #define _bfd_archive_coff_write_ar_hdr _bfd_generic_write_ar_hdr
 330 #define _bfd_archive_coff_openr_next_archived_file \
 331   bfd_generic_openr_next_archived_file
 332 #define _bfd_archive_coff_get_elt_at_index _bfd_generic_get_elt_at_index
 333 #define _bfd_archive_coff_generic_stat_arch_elt \
 334   bfd_generic_stat_arch_elt
 335 #define _bfd_archive_coff_update_armap_timestamp bfd_true
 336
 337 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD4.4 style
 338    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd44).  */
 339
 340 #define _bfd_archive_bsd44_slurp_armap bfd_slurp_bsd_armap
 341 #define _bfd_archive_bsd44_slurp_extended_name_table \
 342   _bfd_slurp_extended_name_table
 343 extern bfd_boolean _bfd_archive_bsd44_construct_extended_name_table
 344   (bfd *, char **, bfd_size_type *, const char **);
 345 #define _bfd_archive_bsd44_truncate_arname bfd_bsd_truncate_arname
 346 #define _bfd_archive_bsd44_write_armap bsd_write_armap
 347 #define _bfd_archive_bsd44_read_ar_hdr _bfd_generic_read_ar_hdr
 348 #define _bfd_archive_bsd44_write_ar_hdr _bfd_bsd44_write_ar_hdr
 349 #define _bfd_archive_bsd44_openr_next_archived_file \
 350   bfd_generic_openr_next_archived_file
 351 #define _bfd_archive_bsd44_get_elt_at_index _bfd_generic_get_elt_at_index
 352 #define _bfd_archive_bsd44_generic_stat_arch_elt \
 353   bfd_generic_stat_arch_elt
 354 #define _bfd_archive_bsd44_update_armap_timestamp \
 355   _bfd_archive_bsd_update_armap_timestamp
 356
 357 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get VMS style
 358    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_vms_lib).  Some of them
 359    are irrelevant and never called, so defined as NULL.  */
 360
 361 extern bfd_boolean _bfd_vms_lib_write_archive_contents (bfd *arch);
 362 #define _bfd_vms_lib_slurp_armap NULL
 363 #define _bfd_vms_lib_slurp_extended_name_table NULL
 364 #define _bfd_vms_lib_construct_extended_name_table NULL
 365 #define _bfd_vms_lib_truncate_arname NULL
 366 #define _bfd_vms_lib_write_armap NULL
 367 #define _bfd_vms_lib_read_ar_hdr NULL
 368 #define _bfd_vms_lib_write_ar_hdr NULL
 369 extern bfd *_bfd_vms_lib_openr_next_archived_file (bfd *, bfd *);
 370 extern bfd *_bfd_vms_lib_get_elt_at_index (bfd *, symindex);
 371 extern int _bfd_vms_lib_generic_stat_arch_elt (bfd *, struct stat *);
 372 #define _bfd_vms_lib_update_armap_timestamp bfd_true
 373
 374 /* Extra routines for VMS style archives.  */
 375
 376 extern symindex _bfd_vms_lib_find_symbol (bfd *, const char *);
 377 extern bfd *_bfd_vms_lib_get_imagelib_file (bfd *);
 378 extern const bfd_target *_bfd_vms_lib_alpha_archive_p (bfd *abfd);
 379 extern const bfd_target *_bfd_vms_lib_ia64_archive_p (bfd *abfd);
 380 extern bfd_boolean _bfd_vms_lib_alpha_mkarchive (bfd *abfd);
 381 extern bfd_boolean _bfd_vms_lib_ia64_mkarchive (bfd *abfd);
 382
 383 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
 384    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 385
 386 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
 387 #define _bfd_nosymbols_canonicalize_symtab \
 388   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 389 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
 390 #define _bfd_nosymbols_print_symbol \
 391   ((void (*) (bfd *, void *, asymbol *, bfd_print_symbol_type)) bfd_void)
 392 #define _bfd_nosymbols_get_symbol_info \
 393   ((void (*) (bfd *, asymbol *, symbol_info *)) bfd_void)
 394 #define _bfd_nosymbols_bfd_is_local_label_name \
 395   ((bfd_boolean (*) (bfd *, const char *)) bfd_false)
 396 #define _bfd_nosymbols_bfd_is_target_special_symbol \
 397   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
 398 #define _bfd_nosymbols_get_lineno \
 399   ((alent *(*) (bfd *, asymbol *)) bfd_nullvoidptr)
 400 #define _bfd_nosymbols_find_nearest_line \
 401   ((bfd_boolean (*) (bfd *, asection *, asymbol **, bfd_vma, const char **, \
 402                      const char **, unsigned int *)) \
 403    bfd_false)
 404 #define _bfd_nosymbols_find_inliner_info \
 405   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
 406    bfd_false)
 407 #define _bfd_nosymbols_bfd_make_debug_symbol \
 408   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 409 #define _bfd_nosymbols_read_minisymbols \
 410   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 411 #define _bfd_nosymbols_minisymbol_to_symbol \
 412   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 413    bfd_nullvoidptr)
 414
 415 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 416    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 417
 418 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
 419 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
 420                                               arelent **, asymbol **);
 421 #define _bfd_norelocs_bfd_reloc_type_lookup \
 422   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 423 #define _bfd_norelocs_bfd_reloc_name_lookup \
 424   ((reloc_howto_type *(*) (bfd *, const char *)) bfd_nullvoidptr)
 425
 426 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 427    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 428
 429 #define _bfd_nowrite_set_arch_mach \
 430   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 431    bfd_false)
 432 #define _bfd_nowrite_set_section_contents \
 433   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 434    bfd_false)
 435
 436 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 437    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 438
 439 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 440 extern bfd_boolean _bfd_generic_set_section_contents
 441   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 442
 443 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 444    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 445
 446 #define _bfd_nolink_sizeof_headers \
 447   ((int (*) (bfd *, struct bfd_link_info *)) bfd_0)
 448 #define _bfd_nolink_bfd_get_relocated_section_contents \
 449   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 450                    bfd_byte *, bfd_boolean, asymbol **)) \
 451    bfd_nullvoidptr)
 452 #define _bfd_nolink_bfd_relax_section \
 453   ((bfd_boolean (*) \
 454     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 455    bfd_false)
 456 #define _bfd_nolink_bfd_gc_sections \
 457   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 458    bfd_false)
 459 #define _bfd_nolink_bfd_lookup_section_flags \
 460   ((bfd_boolean (*) (struct bfd_link_info *, struct flag_info *, asection *)) \
 461    bfd_0)
 462 #define _bfd_nolink_bfd_merge_sections \
 463   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 464    bfd_false)
 465 #define _bfd_nolink_bfd_is_group_section \
 466   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 467    bfd_false)
 468 #define _bfd_nolink_bfd_discard_group \
 469   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 470    bfd_false)
 471 #define _bfd_nolink_bfd_link_hash_table_create \
 472   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 473 #define _bfd_nolink_bfd_link_hash_table_free \
 474   ((void (*) (struct bfd_link_hash_table *)) bfd_void)
 475 #define _bfd_nolink_bfd_link_add_symbols \
 476   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 477 #define _bfd_nolink_bfd_link_just_syms \
 478   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 479 #define _bfd_nolink_bfd_copy_link_hash_symbol_type \
 480   ((void (*) (bfd *, struct bfd_link_hash_entry *, \
 481               struct bfd_link_hash_entry *)) bfd_void)
 482 #define _bfd_nolink_bfd_final_link \
 483   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 484 #define _bfd_nolink_bfd_link_split_section \
 485   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 486 #define _bfd_nolink_section_already_linked \
 487   ((bfd_boolean (*) (bfd *, asection *, \
 488                      struct bfd_link_info *)) bfd_false)
 489 #define _bfd_nolink_bfd_define_common_symbol \
 490   ((bfd_boolean (*) (bfd *, struct bfd_link_info *, \
 491                      struct bfd_link_hash_entry *)) bfd_false)
 492
 493 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 494    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 495    (_bfd_nodynamic).  */
 496
 497 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 498 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 499   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 500 #define _bfd_nodynamic_get_synthetic_symtab \
 501   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 502 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 503 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 504   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 505 \f
 506 /* Generic routine to determine of the given symbol is a local
 507    label.  */
 508 extern bfd_boolean bfd_generic_is_local_label_name
 509   (bfd *, const char *);
 510
 511 /* Generic minisymbol routines.  */
 512 extern long _bfd_generic_read_minisymbols
 513   (bfd *, bfd_boolean, void **, unsigned int *);
 514 extern asymbol *_bfd_generic_minisymbol_to_symbol
 515   (bfd *, bfd_boolean, const void *, asymbol *);
 516
 517 /* Find the nearest line using .stab/.stabstr sections.  */
 518 extern bfd_boolean _bfd_stab_section_find_nearest_line
 519   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 520    const char **, const char **, unsigned int *, void **);
 521
 522 /* Find the nearest line using DWARF 1 debugging information.  */
 523 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 524   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 525    const char **, unsigned int *);
 526
 527 struct dwarf_debug_section
 528 {
 529   const char *uncompressed_name;
 530   const char *compressed_name;
 531 };
 532
 533 /* Map of uncompressed DWARF debug section name to compressed one.  It
 534    is terminated by NULL uncompressed_name.  */
 535
 536 extern const struct dwarf_debug_section dwarf_debug_sections[];
 537
 538 /* Find the nearest line using DWARF 2 debugging information.  */
 539 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 540   (bfd *, const struct dwarf_debug_section *, asection *, asymbol **, bfd_vma,
 541    const char **, const char **, unsigned int *, unsigned int *, unsigned int,
 542    void **);
 543
 544 /* Find the line using DWARF 2 debugging information.  */
 545 extern bfd_boolean _bfd_dwarf2_find_line
 546   (bfd *, asymbol **, asymbol *, const char **,
 547    unsigned int *, unsigned int *, unsigned int, void **);
 548
 549 bfd_boolean _bfd_generic_find_line
 550   (bfd *, asymbol **, asymbol *, const char **, unsigned int *);
 551
 552 bfd_boolean _bfd_generic_find_nearest_line_discriminator
 553   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
 554    unsigned int *, unsigned int *);
 555
 556 /* Find inliner info after calling bfd_find_nearest_line. */
 557 extern bfd_boolean _bfd_dwarf2_find_inliner_info
 558   (bfd *, const char **, const char **, unsigned int *, void **);
 559
 560 /* Read DWARF 2 debugging information. */
 561 extern bfd_boolean _bfd_dwarf2_slurp_debug_info
 562   (bfd *, bfd *, const struct dwarf_debug_section *, asymbol **, void **);
 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 /* Create a string table.  */
 707 extern struct bfd_strtab_hash *_bfd_stringtab_init
 708   (void);
 709
 710 /* Create an XCOFF .debug section style string table.  */
 711 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 712   (void);
 713
 714 /* Free a string table.  */
 715 extern void _bfd_stringtab_free
 716   (struct bfd_strtab_hash *);
 717
 718 /* Get the size of a string table.  */
 719 extern bfd_size_type _bfd_stringtab_size
 720   (struct bfd_strtab_hash *);
 721
 722 /* Add a string to a string table.  */
 723 extern bfd_size_type _bfd_stringtab_add
 724   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 725
 726 /* Write out a string table.  */
 727 extern bfd_boolean _bfd_stringtab_emit
 728   (bfd *, struct bfd_strtab_hash *);
 729
 730 /* Check that endianness of input and output file match.  */
 731 extern bfd_boolean _bfd_generic_verify_endian_match
 732   (bfd *, bfd *);
 733 \f
 734 /* Macros to tell if bfds are read or write enabled.
 735
 736    Note that bfds open for read may be scribbled into if the fd passed
 737    to bfd_fdopenr is actually open both for read and write
 738    simultaneously.  However an output bfd will never be open for
 739    read.  Therefore sometimes you want to check bfd_read_p or
 740    !bfd_read_p, and only sometimes bfd_write_p.
 741 */
 742
 743 #define bfd_read_p(abfd) \
 744   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 745 #define bfd_write_p(abfd) \
 746   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 747
 748 void bfd_assert
 749   (const char*,int);
 750
 751 #define BFD_ASSERT(x) \
 752   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 753
 754 #define BFD_FAIL() \
 755   do { bfd_assert(__FILE__,__LINE__); } while (0)
 756
 757 extern void _bfd_abort
 758   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 759
 760 /* if gcc >= 2.6, we can give a function name, too */
 761 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 762 #define __PRETTY_FUNCTION__  ((char *) NULL)
 763 #endif
 764
 765 #undef abort
 766 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 767
 768 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 769    the system "off_t" or "off64_t", as the offset.  */
 770 extern file_ptr real_ftell (FILE *file);
 771 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 772 extern FILE *real_fopen (const char *filename, const char *modes);
 773
 774 /* List of supported target vectors, and the default vector (if
 775    bfd_default_vector[0] is NULL, there is no default).  */
 776 extern const bfd_target * const *bfd_target_vector;
 777 extern const bfd_target *bfd_default_vector[];
 778
 779 /* List of associated target vectors.  */
 780 extern const bfd_target * const *bfd_associated_vector;
 781
 782 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 783    other common header files.  */
 784
 785 #if defined(__STDC__) || defined(ALMOST_STDC)
 786 struct ecoff_find_line;
 787 #endif
 788
 789 extern bfd_boolean _bfd_ecoff_locate_line
 790   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 791    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 792    const char **, const char **, unsigned int *);
 793 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 794   (void *, bfd_byte *);
 795 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 796   (void *, bfd_byte *);
 797 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 798   (void *, bfd_byte *);
 799
 800 extern bfd_vma _bfd_get_gp_value
 801   (bfd *);
 802 extern void _bfd_set_gp_value
 803   (bfd *, bfd_vma);
 804
 805 /* Function shared by the COFF and ELF SH backends, which have no
 806    other common header files.  */
 807
 808 #ifndef _bfd_sh_align_load_span
 809 extern bfd_boolean _bfd_sh_align_load_span
 810   (bfd *, asection *, bfd_byte *,
 811    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 812    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 813 #endif
 814
 815 /* This is the shape of the elements inside the already_linked hash
 816    table. It maps a name onto a list of already_linked elements with
 817    the same name.  */
 818
 819 struct bfd_section_already_linked_hash_entry
 820 {
 821   struct bfd_hash_entry root;
 822   struct bfd_section_already_linked *entry;
 823 };
 824
 825 struct bfd_section_already_linked
 826 {
 827   struct bfd_section_already_linked *next;
 828   asection *sec;
 829 };
 830
 831 extern struct bfd_section_already_linked_hash_entry *
 832   bfd_section_already_linked_table_lookup (const char *);
 833 extern bfd_boolean bfd_section_already_linked_table_insert
 834   (struct bfd_section_already_linked_hash_entry *, asection *);
 835 extern void bfd_section_already_linked_table_traverse
 836   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 837                     void *), void *);
 838
 839 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 840 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);