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
   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_alloc
 122   (bfd *, bfd_size_type);
 123 extern void *bfd_zalloc
 124   (bfd *, bfd_size_type);
 125 extern void *bfd_alloc2
 126   (bfd *, bfd_size_type, bfd_size_type);
 127 extern void *bfd_zalloc2
 128   (bfd *, bfd_size_type, bfd_size_type);
 129 extern void bfd_release
 130   (bfd *, void *);
 131
 132 bfd * _bfd_create_empty_archive_element_shell
 133   (bfd *obfd);
 134 bfd * _bfd_look_for_bfd_in_cache
 135   (bfd *, file_ptr);
 136 bfd_boolean _bfd_add_bfd_to_archive_cache
 137   (bfd *, file_ptr, bfd *);
 138 bfd_boolean _bfd_generic_mkarchive
 139   (bfd *abfd);
 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 void _bfd_delete_bfd
 163   (bfd *);
 164 bfd_boolean _bfd_free_cached_info
 165   (bfd *);
 166
 167 bfd_boolean bfd_false
 168   (bfd *ignore);
 169 bfd_boolean bfd_true
 170   (bfd *ignore);
 171 void *bfd_nullvoidptr
 172   (bfd *ignore);
 173 int bfd_0
 174   (bfd *ignore);
 175 unsigned int bfd_0u
 176   (bfd *ignore);
 177 long bfd_0l
 178   (bfd *ignore);
 179 long _bfd_n1
 180   (bfd *ignore);
 181 void bfd_void
 182   (bfd *ignore);
 183
 184 bfd *_bfd_new_bfd_contained_in
 185   (bfd *);
 186 const bfd_target *_bfd_dummy_target
 187   (bfd *abfd);
 188
 189 void bfd_dont_truncate_arname
 190   (bfd *abfd, const char *filename, char *hdr);
 191 void bfd_bsd_truncate_arname
 192   (bfd *abfd, const char *filename, char *hdr);
 193 void bfd_gnu_truncate_arname
 194   (bfd *abfd, const char *filename, char *hdr);
 195
 196 bfd_boolean bsd_write_armap
 197   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 198    int stridx);
 199
 200 bfd_boolean coff_write_armap
 201   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
 202    int stridx);
 203
 204 extern void *_bfd_generic_read_ar_hdr
 205   (bfd *);
 206 extern void _bfd_ar_spacepad
 207   (char *, size_t, const char *, long);
 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_true
 233 #define _bfd_generic_bfd_free_cached_info bfd_true
 234 extern bfd_boolean _bfd_generic_new_section_hook
 235   (bfd *, asection *);
 236 extern bfd_boolean _bfd_generic_get_section_contents
 237   (bfd *, asection *, void *, file_ptr, bfd_size_type);
 238 extern bfd_boolean _bfd_generic_get_section_contents_in_window
 239   (bfd *, asection *, bfd_window *, file_ptr, bfd_size_type);
 240
 241 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
 242    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
 243
 244 #define _bfd_generic_bfd_copy_private_bfd_data \
 245   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 246 #define _bfd_generic_bfd_merge_private_bfd_data \
 247   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 248 #define _bfd_generic_bfd_set_private_flags \
 249   ((bfd_boolean (*) (bfd *, flagword)) bfd_true)
 250 #define _bfd_generic_bfd_copy_private_section_data \
 251   ((bfd_boolean (*) (bfd *, asection *, bfd *, asection *)) bfd_true)
 252 #define _bfd_generic_bfd_copy_private_symbol_data \
 253   ((bfd_boolean (*) (bfd *, asymbol *, bfd *, asymbol *)) bfd_true)
 254 #define _bfd_generic_bfd_copy_private_header_data \
 255   ((bfd_boolean (*) (bfd *, bfd *)) bfd_true)
 256 #define _bfd_generic_bfd_print_private_bfd_data \
 257   ((bfd_boolean (*) (bfd *, void *)) bfd_true)
 258
 259 extern bfd_boolean _bfd_generic_init_private_section_data
 260   (bfd *, asection *, bfd *, asection *, struct bfd_link_info *);
 261
 262 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
 263    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
 264
 265 extern char *_bfd_nocore_core_file_failing_command
 266   (bfd *);
 267 extern int _bfd_nocore_core_file_failing_signal
 268   (bfd *);
 269 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
 270   (bfd *, 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_SYMBOLS where there is no symbol
 355    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
 356
 357 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
 358 #define _bfd_nosymbols_canonicalize_symtab \
 359   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 360 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
 361 #define _bfd_nosymbols_print_symbol \
 362   ((void (*) (bfd *, void *, asymbol *, bfd_print_symbol_type)) bfd_void)
 363 #define _bfd_nosymbols_get_symbol_info \
 364   ((void (*) (bfd *, asymbol *, symbol_info *)) bfd_void)
 365 #define _bfd_nosymbols_bfd_is_local_label_name \
 366   ((bfd_boolean (*) (bfd *, const char *)) bfd_false)
 367 #define _bfd_nosymbols_bfd_is_target_special_symbol \
 368   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
 369 #define _bfd_nosymbols_get_lineno \
 370   ((alent *(*) (bfd *, asymbol *)) bfd_nullvoidptr)
 371 #define _bfd_nosymbols_find_nearest_line \
 372   ((bfd_boolean (*) (bfd *, asection *, asymbol **, bfd_vma, const char **, \
 373                      const char **, unsigned int *)) \
 374    bfd_false)
 375 #define _bfd_nosymbols_find_inliner_info \
 376   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
 377    bfd_false)
 378 #define _bfd_nosymbols_bfd_make_debug_symbol \
 379   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
 380 #define _bfd_nosymbols_read_minisymbols \
 381   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
 382 #define _bfd_nosymbols_minisymbol_to_symbol \
 383   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
 384    bfd_nullvoidptr)
 385
 386 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
 387    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
 388
 389 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
 390 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
 391                                               arelent **, asymbol **);
 392 #define _bfd_norelocs_bfd_reloc_type_lookup \
 393   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
 394 #define _bfd_norelocs_bfd_reloc_name_lookup \
 395   ((reloc_howto_type *(*) (bfd *, const char *)) bfd_nullvoidptr)
 396
 397 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
 398    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
 399
 400 #define _bfd_nowrite_set_arch_mach \
 401   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
 402    bfd_false)
 403 #define _bfd_nowrite_set_section_contents \
 404   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
 405    bfd_false)
 406
 407 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
 408    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
 409
 410 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
 411 extern bfd_boolean _bfd_generic_set_section_contents
 412   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
 413
 414 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
 415    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
 416
 417 #define _bfd_nolink_sizeof_headers \
 418   ((int (*) (bfd *, struct bfd_link_info *)) bfd_0)
 419 #define _bfd_nolink_bfd_get_relocated_section_contents \
 420   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
 421                    bfd_byte *, bfd_boolean, asymbol **)) \
 422    bfd_nullvoidptr)
 423 #define _bfd_nolink_bfd_relax_section \
 424   ((bfd_boolean (*) \
 425     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
 426    bfd_false)
 427 #define _bfd_nolink_bfd_gc_sections \
 428   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 429    bfd_false)
 430 #define _bfd_nolink_bfd_merge_sections \
 431   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
 432    bfd_false)
 433 #define _bfd_nolink_bfd_is_group_section \
 434   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
 435    bfd_false)
 436 #define _bfd_nolink_bfd_discard_group \
 437   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
 438    bfd_false)
 439 #define _bfd_nolink_bfd_link_hash_table_create \
 440   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
 441 #define _bfd_nolink_bfd_link_hash_table_free \
 442   ((void (*) (struct bfd_link_hash_table *)) bfd_void)
 443 #define _bfd_nolink_bfd_link_add_symbols \
 444   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 445 #define _bfd_nolink_bfd_link_just_syms \
 446   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
 447 #define _bfd_nolink_bfd_copy_link_hash_symbol_type \
 448   ((void (*) (bfd *, struct bfd_link_hash_entry *, \
 449               struct bfd_link_hash_entry *)) bfd_void)
 450 #define _bfd_nolink_bfd_final_link \
 451   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
 452 #define _bfd_nolink_bfd_link_split_section \
 453   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
 454 #define _bfd_nolink_section_already_linked \
 455   ((void (*) (bfd *, struct bfd_section *, struct bfd_link_info *)) bfd_void)
 456 #define _bfd_nolink_bfd_define_common_symbol \
 457   ((bfd_boolean (*) (bfd *, struct bfd_link_info *, \
 458                      struct bfd_link_hash_entry *)) bfd_false)
 459
 460 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
 461    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
 462    (_bfd_nodynamic).  */
 463
 464 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
 465 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
 466   ((long (*) (bfd *, asymbol **)) _bfd_n1)
 467 #define _bfd_nodynamic_get_synthetic_symtab \
 468   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
 469 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
 470 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
 471   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
 472 \f
 473 /* Generic routine to determine of the given symbol is a local
 474    label.  */
 475 extern bfd_boolean bfd_generic_is_local_label_name
 476   (bfd *, const char *);
 477
 478 /* Generic minisymbol routines.  */
 479 extern long _bfd_generic_read_minisymbols
 480   (bfd *, bfd_boolean, void **, unsigned int *);
 481 extern asymbol *_bfd_generic_minisymbol_to_symbol
 482   (bfd *, bfd_boolean, const void *, asymbol *);
 483
 484 /* Find the nearest line using .stab/.stabstr sections.  */
 485 extern bfd_boolean _bfd_stab_section_find_nearest_line
 486   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
 487    const char **, const char **, unsigned int *, void **);
 488
 489 /* Find the nearest line using DWARF 1 debugging information.  */
 490 extern bfd_boolean _bfd_dwarf1_find_nearest_line
 491   (bfd *, asection *, asymbol **, bfd_vma, const char **,
 492    const char **, unsigned int *);
 493
 494 /* Find the nearest line using DWARF 2 debugging information.  */
 495 extern bfd_boolean _bfd_dwarf2_find_nearest_line
 496   (bfd *, asection *, asymbol **, bfd_vma, const char **, const char **,
 497    unsigned int *, unsigned int, void **);
 498
 499 /* Find the line using DWARF 2 debugging information.  */
 500 extern bfd_boolean _bfd_dwarf2_find_line
 501   (bfd *, asymbol **, asymbol *, const char **,
 502    unsigned int *, unsigned int, void **);
 503
 504 bfd_boolean _bfd_generic_find_line
 505   (bfd *, asymbol **, asymbol *, const char **, unsigned int *);
 506
 507 /* Find inliner info after calling bfd_find_nearest_line. */
 508 extern bfd_boolean _bfd_dwarf2_find_inliner_info
 509   (bfd *, const char **, const char **, unsigned int *, void **);
 510
 511 /* Create a new section entry.  */
 512 extern struct bfd_hash_entry *bfd_section_hash_newfunc
 513   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
 514
 515 /* A routine to create entries for a bfd_link_hash_table.  */
 516 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
 517   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
 518    const char *string);
 519
 520 /* Initialize a bfd_link_hash_table.  */
 521 extern bfd_boolean _bfd_link_hash_table_init
 522   (struct bfd_link_hash_table *, bfd *,
 523    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
 524                                struct bfd_hash_table *,
 525                                const char *),
 526    unsigned int);
 527
 528 /* Generic link hash table creation routine.  */
 529 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
 530   (bfd *);
 531
 532 /* Generic link hash table destruction routine.  */
 533 extern void _bfd_generic_link_hash_table_free
 534   (struct bfd_link_hash_table *);
 535
 536 /* Generic add symbol routine.  */
 537 extern bfd_boolean _bfd_generic_link_add_symbols
 538   (bfd *, struct bfd_link_info *);
 539
 540 /* Generic add symbol routine.  This version is used by targets for
 541    which the linker must collect constructors and destructors by name,
 542    as the collect2 program does.  */
 543 extern bfd_boolean _bfd_generic_link_add_symbols_collect
 544   (bfd *, struct bfd_link_info *);
 545
 546 /* Generic archive add symbol routine.  */
 547 extern bfd_boolean _bfd_generic_link_add_archive_symbols
 548   (bfd *, struct bfd_link_info *,
 549    bfd_boolean (*) (bfd *, struct bfd_link_info *, bfd_boolean *));
 550
 551 /* Forward declaration to avoid prototype errors.  */
 552 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
 553
 554 /* Generic routine to add a single symbol.  */
 555 extern bfd_boolean _bfd_generic_link_add_one_symbol
 556   (struct bfd_link_info *, bfd *, const char *name, flagword,
 557    asection *, bfd_vma, const char *, bfd_boolean copy,
 558    bfd_boolean constructor, struct bfd_link_hash_entry **);
 559
 560 /* Generic routine to mark section as supplying symbols only.  */
 561 extern void _bfd_generic_link_just_syms
 562   (asection *, struct bfd_link_info *);
 563
 564 /* Generic routine that does nothing.  */
 565 extern void _bfd_generic_copy_link_hash_symbol_type
 566   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
 567
 568 /* Generic link routine.  */
 569 extern bfd_boolean _bfd_generic_final_link
 570   (bfd *, struct bfd_link_info *);
 571
 572 extern bfd_boolean _bfd_generic_link_split_section
 573   (bfd *, struct bfd_section *);
 574
 575 extern void _bfd_generic_section_already_linked
 576   (bfd *, struct bfd_section *, struct bfd_link_info *);
 577
 578 /* Generic reloc_link_order processing routine.  */
 579 extern bfd_boolean _bfd_generic_reloc_link_order
 580   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 581
 582 /* Default link order processing routine.  */
 583 extern bfd_boolean _bfd_default_link_order
 584   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
 585
 586 /* Count the number of reloc entries in a link order list.  */
 587 extern unsigned int _bfd_count_link_order_relocs
 588   (struct bfd_link_order *);
 589
 590 /* Final link relocation routine.  */
 591 extern bfd_reloc_status_type _bfd_final_link_relocate
 592   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
 593    bfd_vma, bfd_vma, bfd_vma);
 594
 595 /* Relocate a particular location by a howto and a value.  */
 596 extern bfd_reloc_status_type _bfd_relocate_contents
 597   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
 598
 599 /* Clear a given location using a given howto.  */
 600 extern void _bfd_clear_contents (reloc_howto_type *howto, bfd *input_bfd,
 601                                  bfd_byte *location);
 602
 603 /* Link stabs in sections in the first pass.  */
 604
 605 extern bfd_boolean _bfd_link_section_stabs
 606   (bfd *, struct stab_info *, asection *, asection *, void **,
 607    bfd_size_type *);
 608
 609 /* Eliminate stabs for discarded functions and symbols.  */
 610 extern bfd_boolean _bfd_discard_section_stabs
 611   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
 612
 613 /* Write out the .stab section when linking stabs in sections.  */
 614
 615 extern bfd_boolean _bfd_write_section_stabs
 616   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
 617
 618 /* Write out the .stabstr string table when linking stabs in sections.  */
 619
 620 extern bfd_boolean _bfd_write_stab_strings
 621   (bfd *, struct stab_info *);
 622
 623 /* Find an offset within a .stab section when linking stabs in
 624    sections.  */
 625
 626 extern bfd_vma _bfd_stab_section_offset
 627   (asection *, void *, bfd_vma);
 628
 629 /* Register a SEC_MERGE section as a candidate for merging.  */
 630
 631 extern bfd_boolean _bfd_add_merge_section
 632   (bfd *, void **, asection *, void **);
 633
 634 /* Attempt to merge SEC_MERGE sections.  */
 635
 636 extern bfd_boolean _bfd_merge_sections
 637   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
 638
 639 /* Write out a merged section.  */
 640
 641 extern bfd_boolean _bfd_write_merged_section
 642   (bfd *, asection *, void *);
 643
 644 /* Find an offset within a modified SEC_MERGE section.  */
 645
 646 extern bfd_vma _bfd_merged_section_offset
 647   (bfd *, asection **, void *, bfd_vma);
 648
 649 /* Create a string table.  */
 650 extern struct bfd_strtab_hash *_bfd_stringtab_init
 651   (void);
 652
 653 /* Create an XCOFF .debug section style string table.  */
 654 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
 655   (void);
 656
 657 /* Free a string table.  */
 658 extern void _bfd_stringtab_free
 659   (struct bfd_strtab_hash *);
 660
 661 /* Get the size of a string table.  */
 662 extern bfd_size_type _bfd_stringtab_size
 663   (struct bfd_strtab_hash *);
 664
 665 /* Add a string to a string table.  */
 666 extern bfd_size_type _bfd_stringtab_add
 667   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
 668
 669 /* Write out a string table.  */
 670 extern bfd_boolean _bfd_stringtab_emit
 671   (bfd *, struct bfd_strtab_hash *);
 672
 673 /* Check that endianness of input and output file match.  */
 674 extern bfd_boolean _bfd_generic_verify_endian_match
 675   (bfd *, bfd *);
 676 \f
 677 /* Macros to tell if bfds are read or write enabled.
 678
 679    Note that bfds open for read may be scribbled into if the fd passed
 680    to bfd_fdopenr is actually open both for read and write
 681    simultaneously.  However an output bfd will never be open for
 682    read.  Therefore sometimes you want to check bfd_read_p or
 683    !bfd_read_p, and only sometimes bfd_write_p.
 684 */
 685
 686 #define bfd_read_p(abfd) \
 687   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
 688 #define bfd_write_p(abfd) \
 689   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
 690
 691 void bfd_assert
 692   (const char*,int);
 693
 694 #define BFD_ASSERT(x) \
 695   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
 696
 697 #define BFD_FAIL() \
 698   do { bfd_assert(__FILE__,__LINE__); } while (0)
 699
 700 extern void _bfd_abort
 701   (const char *, int, const char *) ATTRIBUTE_NORETURN;
 702
 703 /* if gcc >= 2.6, we can give a function name, too */
 704 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
 705 #define __PRETTY_FUNCTION__  ((char *) NULL)
 706 #endif
 707
 708 #undef abort
 709 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
 710
 711 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
 712    the system "off_t" or "off64_t", as the offset.  */
 713 extern file_ptr real_ftell (FILE *file);
 714 extern int real_fseek (FILE *file, file_ptr offset, int whence);
 715 extern FILE *real_fopen (const char *filename, const char *modes);
 716
 717 /* List of supported target vectors, and the default vector (if
 718    bfd_default_vector[0] is NULL, there is no default).  */
 719 extern const bfd_target * const *bfd_target_vector;
 720 extern const bfd_target *bfd_default_vector[];
 721
 722 /* List of associated target vectors.  */
 723 extern const bfd_target * const *bfd_associated_vector;
 724
 725 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
 726    other common header files.  */
 727
 728 #if defined(__STDC__) || defined(ALMOST_STDC)
 729 struct ecoff_find_line;
 730 #endif
 731
 732 extern bfd_boolean _bfd_ecoff_locate_line
 733   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
 734    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
 735    const char **, const char **, unsigned int *);
 736 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
 737   (void *, bfd_byte *);
 738 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
 739   (void *, bfd_byte *);
 740 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
 741   (void *, bfd_byte *);
 742
 743 extern bfd_vma _bfd_get_gp_value
 744   (bfd *);
 745 extern void _bfd_set_gp_value
 746   (bfd *, bfd_vma);
 747
 748 /* Function shared by the COFF and ELF SH backends, which have no
 749    other common header files.  */
 750
 751 #ifndef _bfd_sh_align_load_span
 752 extern bfd_boolean _bfd_sh_align_load_span
 753   (bfd *, asection *, bfd_byte *,
 754    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
 755    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
 756 #endif
 757
 758 /* This is the shape of the elements inside the already_linked hash
 759    table. It maps a name onto a list of already_linked elements with
 760    the same name.  */
 761
 762 struct bfd_section_already_linked_hash_entry
 763 {
 764   struct bfd_hash_entry root;
 765   struct bfd_section_already_linked *entry;
 766 };
 767
 768 struct bfd_section_already_linked
 769 {
 770   struct bfd_section_already_linked *next;
 771   asection *sec;
 772 };
 773
 774 extern struct bfd_section_already_linked_hash_entry *
 775   bfd_section_already_linked_table_lookup (const char *);
 776 extern bfd_boolean bfd_section_already_linked_table_insert
 777   (struct bfd_section_already_linked_hash_entry *, asection *);
 778 extern void bfd_section_already_linked_table_traverse
 779   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
 780                     void *), void *);
 781
 782 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
 783 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
 784