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