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