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