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_line \
 406   ((bfd_boolean (*) (bfd *, asymbol **, asymbol *,      \
 407                      const char **, unsigned int *))    \
 408    bfd_false)
 409 #define _bfd_nosymbols_find_inliner_info \
 410   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
 411    bfd_false)
 412 #define _bfd_nosymbols_bfd_make_debug_symbol \
 413   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 414 #define _bfd_nosymbols_read_minisymbols \
 415   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 416 #define _bfd_nosymbols_minisymbol_to_symbol \
 417   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 418    bfd_nullvoidptr)
 419
 420 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 421    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 422
 423 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
 424 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
 425                                               arelent **, asymbol **);
 426 #define _bfd_norelocs_bfd_reloc_type_lookup \
 427   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 428 #define _bfd_norelocs_bfd_reloc_name_lookup \
 429   ((reloc_howto_type *(*) (bfd *, const char *)) bfd_nullvoidptr)
 430
 431 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 432    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 433
 434 #define _bfd_nowrite_set_arch_mach \
 435   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 436    bfd_false)
 437 #define _bfd_nowrite_set_section_contents \
 438   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 439    bfd_false)
 440
 441 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 442    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 443
 444 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 445 extern bfd_boolean _bfd_generic_set_section_contents
 446   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 447
 448 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 449    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 450
 451 #define _bfd_nolink_sizeof_headers \
 452   ((int (*) (bfd *, struct bfd_link_info *)) bfd_0)
 453 #define _bfd_nolink_bfd_get_relocated_section_contents \
 454   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 455                    bfd_byte *, bfd_boolean, asymbol **)) \
 456    bfd_nullvoidptr)
 457 #define _bfd_nolink_bfd_relax_section \
 458   ((bfd_boolean (*) \
 459     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 460    bfd_false)
 461 #define _bfd_nolink_bfd_gc_sections \
 462   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 463    bfd_false)
 464 #define _bfd_nolink_bfd_lookup_section_flags \
 465   ((bfd_boolean (*) (struct bfd_link_info *, struct flag_info *, asection *)) \
 466    bfd_0)
 467 #define _bfd_nolink_bfd_merge_sections \
 468   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 469    bfd_false)
 470 #define _bfd_nolink_bfd_is_group_section \
 471   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 472    bfd_false)
 473 #define _bfd_nolink_bfd_discard_group \
 474   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 475    bfd_false)
 476 #define _bfd_nolink_bfd_link_hash_table_create \
 477   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 478 #define _bfd_nolink_bfd_link_add_symbols \
 479   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 480 #define _bfd_nolink_bfd_link_just_syms \
 481   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 482 #define _bfd_nolink_bfd_copy_link_hash_symbol_type \
 483   ((void (*) (bfd *, struct bfd_link_hash_entry *, \
 484               struct bfd_link_hash_entry *)) bfd_void)
 485 #define _bfd_nolink_bfd_final_link \
 486   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 487 #define _bfd_nolink_bfd_link_split_section \
 488   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 489 #define _bfd_nolink_section_already_linked \
 490   ((bfd_boolean (*) (bfd *, asection *, \
 491                      struct bfd_link_info *)) bfd_false)
 492 #define _bfd_nolink_bfd_define_common_symbol \
 493   ((bfd_boolean (*) (bfd *, struct bfd_link_info *, \
 494                      struct bfd_link_hash_entry *)) bfd_false)
 495
 496 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 497    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 498    (_bfd_nodynamic).  */
 499
 500 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 501 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 502   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 503 #define _bfd_nodynamic_get_synthetic_symtab \
 504   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 505 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 506 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 507   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 508 \f
 509 /* Generic routine to determine of the given symbol is a local
 510    label.  */
 511 extern bfd_boolean bfd_generic_is_local_label_name
 512   (bfd *, const char *);
 513
 514 /* Generic minisymbol routines.  */
 515 extern long _bfd_generic_read_minisymbols
 516   (bfd *, bfd_boolean, void **, unsigned int *);
 517 extern asymbol *_bfd_generic_minisymbol_to_symbol
 518   (bfd *, bfd_boolean, const void *, asymbol *);
 519
 520 /* Find the nearest line using .stab/.stabstr sections.  */
 521 extern bfd_boolean _bfd_stab_section_find_nearest_line
 522   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 523    const char **, const char **, unsigned int *, void **);
 524
 525 /* Find the nearest line using DWARF 1 debugging information.  */
 526 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 527   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 528    const char **, unsigned int *);
 529
 530 struct dwarf_debug_section
 531 {
 532   const char *uncompressed_name;
 533   const char *compressed_name;
 534 };
 535
 536 /* Map of uncompressed DWARF debug section name to compressed one.  It
 537    is terminated by NULL uncompressed_name.  */
 538
 539 extern const struct dwarf_debug_section dwarf_debug_sections[];
 540
 541 /* Find the nearest line using DWARF 2 debugging information.  */
 542 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 543   (bfd *, const struct dwarf_debug_section *, asection *, asymbol **, bfd_vma,
 544    const char **, const char **, unsigned int *, unsigned int *, unsigned int,
 545    void **);
 546
 547 /* Find the line using DWARF 2 debugging information.  */
 548 extern bfd_boolean _bfd_dwarf2_find_line
 549   (bfd *, asymbol **, asymbol *, const char **,
 550    unsigned int *, unsigned int *, unsigned int, void **);
 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    bfd_boolean);
 564
 565 /* Clean up the data used to handle DWARF 2 debugging information. */
 566 extern void _bfd_dwarf2_cleanup_debug_info
 567   (bfd *, void **);
 568
 569 /* Create a new section entry.  */
 570 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 571   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 572
 573 /* A routine to create entries for a bfd_link_hash_table.  */
 574 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 575   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 576    const char *string);
 577
 578 /* Initialize a bfd_link_hash_table.  */
 579 extern bfd_boolean _bfd_link_hash_table_init
 580   (struct bfd_link_hash_table *, bfd *,
 581    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 582                                struct bfd_hash_table *,
 583                                const char *),
 584    unsigned int);
 585
 586 /* Generic link hash table creation routine.  */
 587 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 588   (bfd *);
 589
 590 /* Generic link hash table destruction routine.  */
 591 extern void _bfd_generic_link_hash_table_free
 592   (bfd *);
 593
 594 /* Generic add symbol routine.  */
 595 extern bfd_boolean _bfd_generic_link_add_symbols
 596   (bfd *, struct bfd_link_info *);
 597
 598 /* Generic add symbol routine.  This version is used by targets for
 599    which the linker must collect constructors and destructors by name,
 600    as the collect2 program does.  */
 601 extern bfd_boolean _bfd_generic_link_add_symbols_collect
 602   (bfd *, struct bfd_link_info *);
 603
 604 /* Generic archive add symbol routine.  */
 605 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 606   (bfd *, struct bfd_link_info *,
 607    bfd_boolean (*) (bfd *, struct bfd_link_info *,
 608                     struct bfd_link_hash_entry *, const char *,
 609                     bfd_boolean *));
 610
 611 /* Forward declaration to avoid prototype errors.  */
 612 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 613
 614 /* Generic routine to add a single symbol.  */
 615 extern bfd_boolean _bfd_generic_link_add_one_symbol
 616   (struct bfd_link_info *, bfd *, const char *name, flagword,
 617    asection *, bfd_vma, const char *, bfd_boolean copy,
 618    bfd_boolean constructor, struct bfd_link_hash_entry **);
 619
 620 /* Generic routine to mark section as supplying symbols only.  */
 621 extern void _bfd_generic_link_just_syms
 622   (asection *, struct bfd_link_info *);
 623
 624 /* Generic routine that does nothing.  */
 625 extern void _bfd_generic_copy_link_hash_symbol_type
 626   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
 627
 628 /* Generic link routine.  */
 629 extern bfd_boolean _bfd_generic_final_link
 630   (bfd *, struct bfd_link_info *);
 631
 632 extern bfd_boolean _bfd_generic_link_split_section
 633   (bfd *, struct bfd_section *);
 634
 635 extern bfd_boolean _bfd_generic_section_already_linked
 636   (bfd *, asection *, struct bfd_link_info *);
 637
 638 /* Generic reloc_link_order processing routine.  */
 639 extern bfd_boolean _bfd_generic_reloc_link_order
 640   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 641
 642 /* Default link order processing routine.  */
 643 extern bfd_boolean _bfd_default_link_order
 644   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 645
 646 /* Count the number of reloc entries in a link order list.  */
 647 extern unsigned int _bfd_count_link_order_relocs
 648   (struct bfd_link_order *);
 649
 650 /* Final link relocation routine.  */
 651 extern bfd_reloc_status_type _bfd_final_link_relocate
 652   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 653    bfd_vma, bfd_vma, bfd_vma);
 654
 655 /* Relocate a particular location by a howto and a value.  */
 656 extern bfd_reloc_status_type _bfd_relocate_contents
 657   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 658
 659 /* Clear a given location using a given howto.  */
 660 extern void _bfd_clear_contents (reloc_howto_type *howto, bfd *input_bfd,
 661                                  asection *input_section, bfd_byte *location);
 662
 663 /* Link stabs in sections in the first pass.  */
 664
 665 extern bfd_boolean _bfd_link_section_stabs
 666   (bfd *, struct stab_info *, asection *, asection *, void **,
 667    bfd_size_type *);
 668
 669 /* Eliminate stabs for discarded functions and symbols.  */
 670 extern bfd_boolean _bfd_discard_section_stabs
 671   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 672
 673 /* Write out the .stab section when linking stabs in sections.  */
 674
 675 extern bfd_boolean _bfd_write_section_stabs
 676   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 677
 678 /* Write out the .stabstr string table when linking stabs in sections.  */
 679
 680 extern bfd_boolean _bfd_write_stab_strings
 681   (bfd *, struct stab_info *);
 682
 683 /* Find an offset within a .stab section when linking stabs in
 684    sections.  */
 685
 686 extern bfd_vma _bfd_stab_section_offset
 687   (asection *, void *, bfd_vma);
 688
 689 /* Register a SEC_MERGE section as a candidate for merging.  */
 690
 691 extern bfd_boolean _bfd_add_merge_section
 692   (bfd *, void **, asection *, void **);
 693
 694 /* Attempt to merge SEC_MERGE sections.  */
 695
 696 extern bfd_boolean _bfd_merge_sections
 697   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 698
 699 /* Write out a merged section.  */
 700
 701 extern bfd_boolean _bfd_write_merged_section
 702   (bfd *, asection *, void *);
 703
 704 /* Find an offset within a modified SEC_MERGE section.  */
 705
 706 extern bfd_vma _bfd_merged_section_offset
 707   (bfd *, asection **, void *, bfd_vma);
 708
 709 /* Tidy up when done.  */
 710
 711 extern void _bfd_merge_sections_free (void *);
 712
 713 /* Create a string table.  */
 714 extern struct bfd_strtab_hash *_bfd_stringtab_init
 715   (void);
 716
 717 /* Create an XCOFF .debug section style string table.  */
 718 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 719   (void);
 720
 721 /* Free a string table.  */
 722 extern void _bfd_stringtab_free
 723   (struct bfd_strtab_hash *);
 724
 725 /* Get the size of a string table.  */
 726 extern bfd_size_type _bfd_stringtab_size
 727   (struct bfd_strtab_hash *);
 728
 729 /* Add a string to a string table.  */
 730 extern bfd_size_type _bfd_stringtab_add
 731   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 732
 733 /* Write out a string table.  */
 734 extern bfd_boolean _bfd_stringtab_emit
 735   (bfd *, struct bfd_strtab_hash *);
 736
 737 /* Check that endianness of input and output file match.  */
 738 extern bfd_boolean _bfd_generic_verify_endian_match
 739   (bfd *, bfd *);
 740 \f
 741 /* Macros to tell if bfds are read or write enabled.
 742
 743    Note that bfds open for read may be scribbled into if the fd passed
 744    to bfd_fdopenr is actually open both for read and write
 745    simultaneously.  However an output bfd will never be open for
 746    read.  Therefore sometimes you want to check bfd_read_p or
 747    !bfd_read_p, and only sometimes bfd_write_p.
 748 */
 749
 750 #define bfd_read_p(abfd) \
 751   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 752 #define bfd_write_p(abfd) \
 753   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 754
 755 void bfd_assert
 756   (const char*,int);
 757
 758 #define BFD_ASSERT(x) \
 759   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 760
 761 #define BFD_FAIL() \
 762   do { bfd_assert(__FILE__,__LINE__); } while (0)
 763
 764 extern void _bfd_abort
 765   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 766
 767 /* if gcc >= 2.6, we can give a function name, too */
 768 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 769 #define __PRETTY_FUNCTION__  ((char *) NULL)
 770 #endif
 771
 772 #undef abort
 773 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 774
 775 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 776    the system "off_t" or "off64_t", as the offset.  */
 777 extern file_ptr real_ftell (FILE *file);
 778 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 779 extern FILE *real_fopen (const char *filename, const char *modes);
 780
 781 /* List of supported target vectors, and the default vector (if
 782    bfd_default_vector[0] is NULL, there is no default).  */
 783 extern const bfd_target * const *bfd_target_vector;
 784 extern const bfd_target *bfd_default_vector[];
 785
 786 /* List of associated target vectors.  */
 787 extern const bfd_target * const *bfd_associated_vector;
 788
 789 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 790    other common header files.  */
 791
 792 #if defined(__STDC__) || defined(ALMOST_STDC)
 793 struct ecoff_find_line;
 794 #endif
 795
 796 extern bfd_boolean _bfd_ecoff_locate_line
 797   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 798    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 799    const char **, const char **, unsigned int *);
 800 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 801   (void *, bfd_byte *);
 802 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 803   (void *, bfd_byte *);
 804 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 805   (void *, bfd_byte *);
 806
 807 extern bfd_vma _bfd_get_gp_value
 808   (bfd *);
 809 extern void _bfd_set_gp_value
 810   (bfd *, bfd_vma);
 811
 812 /* Function shared by the COFF and ELF SH backends, which have no
 813    other common header files.  */
 814
 815 #ifndef _bfd_sh_align_load_span
 816 extern bfd_boolean _bfd_sh_align_load_span
 817   (bfd *, asection *, bfd_byte *,
 818    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 819    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 820 #endif
 821
 822 /* This is the shape of the elements inside the already_linked hash
 823    table. It maps a name onto a list of already_linked elements with
 824    the same name.  */
 825
 826 struct bfd_section_already_linked_hash_entry
 827 {
 828   struct bfd_hash_entry root;
 829   struct bfd_section_already_linked *entry;
 830 };
 831
 832 struct bfd_section_already_linked
 833 {
 834   struct bfd_section_already_linked *next;
 835   asection *sec;
 836 };
 837
 838 extern struct bfd_section_already_linked_hash_entry *
 839   bfd_section_already_linked_table_lookup (const char *);
 840 extern bfd_boolean bfd_section_already_linked_table_insert
 841   (struct bfd_section_already_linked_hash_entry *, asection *);
 842 extern void bfd_section_already_linked_table_traverse
 843   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 844                     void *), void *);
 845
 846 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 847 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);