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