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