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