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