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