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