bfd_merge_private_bfd_data tidy
[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 (C) 1990-2016 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
28 extern "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
42 struct 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
50 struct 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
59 struct 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 */
84 struct 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
97 extern void *bfd_malloc
98   (bfd_size_type);
99 extern void *bfd_realloc
100   (void *, bfd_size_type);
101 extern void *bfd_realloc_or_free
102   (void *, bfd_size_type);
103 extern void *bfd_zmalloc
104   (bfd_size_type);
105 extern void *bfd_malloc2
106   (bfd_size_type, bfd_size_type);
107 extern void *bfd_realloc2
108   (void *, bfd_size_type, bfd_size_type);
109 extern void *bfd_zmalloc2
110   (bfd_size_type, bfd_size_type);
111
112 extern void _bfd_error_handler (const char *s, ...);
113
114 /* These routines allocate and free things on the BFD's objalloc.  */
115
116 extern void *bfd_alloc2
117   (bfd *, bfd_size_type, bfd_size_type);
118 extern void *bfd_zalloc2
119   (bfd *, bfd_size_type, bfd_size_type);
120 extern void bfd_release
121   (bfd *, void *);
122
123 bfd * _bfd_create_empty_archive_element_shell
124   (bfd *obfd);
125 bfd * _bfd_look_for_bfd_in_cache
126   (bfd *, file_ptr);
127 bfd_boolean _bfd_add_bfd_to_archive_cache
128   (bfd *, file_ptr, bfd *);
129 bfd_boolean _bfd_generic_mkarchive
130   (bfd *abfd);
131 char *_bfd_append_relative_path
132   (bfd *arch, char *elt_name);
133 const bfd_target *bfd_generic_archive_p
134   (bfd *abfd);
135 bfd_boolean bfd_slurp_armap
136   (bfd *abfd);
137 bfd_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
141 bfd_boolean _bfd_archive_64_bit_slurp_armap
142   (bfd *);
143 bfd_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
164 bfd_boolean _bfd_slurp_extended_name_table
165   (bfd *abfd);
166 extern bfd_boolean _bfd_construct_extended_name_table
167   (bfd *, bfd_boolean, char **, bfd_size_type *);
168 bfd_boolean _bfd_write_archive_contents
169   (bfd *abfd);
170 bfd_boolean _bfd_compute_and_write_armap
171   (bfd *, unsigned int elength);
172 bfd *_bfd_get_elt_at_filepos
173   (bfd *archive, file_ptr filepos);
174 extern bfd *_bfd_generic_get_elt_at_index
175   (bfd *, symindex);
176 bfd * _bfd_new_bfd
177   (void);
178 bfd_boolean _bfd_free_cached_info
179   (bfd *);
180
181 bfd_boolean bfd_false
182   (bfd *ignore);
183 bfd_boolean bfd_true
184   (bfd *ignore);
185 void *bfd_nullvoidptr
186   (bfd *ignore);
187 int bfd_0
188   (bfd *ignore);
189 unsigned int bfd_0u
190   (bfd *ignore);
191 long bfd_0l
192   (bfd *ignore);
193 long _bfd_n1
194   (bfd *ignore);
195 void bfd_void
196   (bfd *ignore);
197
198 bfd *_bfd_new_bfd_contained_in
199   (bfd *);
200 const bfd_target *_bfd_dummy_target
201   (bfd *abfd);
202
203 void bfd_dont_truncate_arname
204   (bfd *abfd, const char *filename, char *hdr);
205 void bfd_bsd_truncate_arname
206   (bfd *abfd, const char *filename, char *hdr);
207 void bfd_gnu_truncate_arname
208   (bfd *abfd, const char *filename, char *hdr);
209
210 bfd_boolean bsd_write_armap
211   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
212    int stridx);
213
214 bfd_boolean coff_write_armap
215   (bfd *arch, unsigned int elength, struct orl *map, unsigned int orl_count,
216    int stridx);
217
218 extern void *_bfd_generic_read_ar_hdr
219   (bfd *);
220 extern void _bfd_ar_spacepad
221   (char *, size_t, const char *, long);
222 extern bfd_boolean _bfd_ar_sizepad
223   (char *, size_t, bfd_size_type);
224
225 extern void *_bfd_generic_read_ar_hdr_mag
226   (bfd *, const char *);
227
228 extern bfd_boolean _bfd_generic_write_ar_hdr
229   (bfd *, bfd *);
230
231 extern bfd_boolean _bfd_bsd44_write_ar_hdr
232   (bfd *, bfd *);
233
234 bfd * bfd_generic_openr_next_archived_file
235   (bfd *archive, bfd *last_file);
236
237 int 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 \f
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
249 extern bfd_boolean _bfd_archive_close_and_cleanup
250   (bfd *);
251 #define _bfd_generic_bfd_free_cached_info bfd_true
252 extern bfd_boolean _bfd_generic_new_section_hook
253   (bfd *, asection *);
254 extern bfd_boolean _bfd_generic_get_section_contents
255   (bfd *, asection *, void *, file_ptr, bfd_size_type);
256 extern 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 *, bfd *)) 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
277 extern 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
283 extern char *_bfd_nocore_core_file_failing_command
284   (bfd *);
285 extern int _bfd_nocore_core_file_failing_signal
286   (bfd *);
287 extern bfd_boolean _bfd_nocore_core_file_matches_executable_p
288   (bfd *, bfd *);
289 extern 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
321 extern 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
332 extern 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
341 extern 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
360 extern 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 and never called, so defined as NULL.  */
377
378 extern bfd_boolean _bfd_vms_lib_write_archive_contents (bfd *arch);
379 #define _bfd_vms_lib_slurp_armap NULL
380 #define _bfd_vms_lib_slurp_extended_name_table NULL
381 #define _bfd_vms_lib_construct_extended_name_table NULL
382 #define _bfd_vms_lib_truncate_arname NULL
383 #define _bfd_vms_lib_write_armap NULL
384 #define _bfd_vms_lib_read_ar_hdr NULL
385 #define _bfd_vms_lib_write_ar_hdr NULL
386 extern bfd *_bfd_vms_lib_openr_next_archived_file (bfd *, bfd *);
387 extern bfd *_bfd_vms_lib_get_elt_at_index (bfd *, symindex);
388 extern int _bfd_vms_lib_generic_stat_arch_elt (bfd *, struct stat *);
389 #define _bfd_vms_lib_update_armap_timestamp bfd_true
390
391 /* Extra routines for VMS style archives.  */
392
393 extern symindex _bfd_vms_lib_find_symbol (bfd *, const char *);
394 extern bfd *_bfd_vms_lib_get_imagelib_file (bfd *);
395 extern const bfd_target *_bfd_vms_lib_alpha_archive_p (bfd *abfd);
396 extern const bfd_target *_bfd_vms_lib_ia64_archive_p (bfd *abfd);
397 extern bfd_boolean _bfd_vms_lib_alpha_mkarchive (bfd *abfd);
398 extern bfd_boolean _bfd_vms_lib_ia64_mkarchive (bfd *abfd);
399
400 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
401    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
402
403 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
404 #define _bfd_nosymbols_canonicalize_symtab \
405   ((long (*) (bfd *, asymbol **)) _bfd_n1)
406 #define _bfd_nosymbols_make_empty_symbol _bfd_generic_make_empty_symbol
407 #define _bfd_nosymbols_print_symbol \
408   ((void (*) (bfd *, void *, asymbol *, bfd_print_symbol_type)) bfd_void)
409 #define _bfd_nosymbols_get_symbol_info \
410   ((void (*) (bfd *, asymbol *, symbol_info *)) bfd_void)
411 #define _bfd_nosymbols_get_symbol_version_string \
412   ((const char *(*) (bfd *, asymbol *, bfd_boolean *)) bfd_nullvoidptr)
413 #define _bfd_nosymbols_bfd_is_local_label_name \
414   ((bfd_boolean (*) (bfd *, const char *)) bfd_false)
415 #define _bfd_nosymbols_bfd_is_target_special_symbol \
416   ((bfd_boolean (*) (bfd *, asymbol *)) bfd_false)
417 #define _bfd_nosymbols_get_lineno \
418   ((alent *(*) (bfd *, asymbol *)) bfd_nullvoidptr)
419 #define _bfd_nosymbols_find_nearest_line \
420   ((bfd_boolean (*) (bfd *, asymbol **, asection *, bfd_vma,            \
421                      const char **, const char **, unsigned int *,      \
422                      unsigned int *))                                   \
423    bfd_false)
424 #define _bfd_nosymbols_find_line \
425   ((bfd_boolean (*) (bfd *, asymbol **, asymbol *,      \
426                      const char **, unsigned int *))    \
427    bfd_false)
428 #define _bfd_nosymbols_find_inliner_info \
429   ((bfd_boolean (*) (bfd *, const char **, const char **, unsigned int *)) \
430    bfd_false)
431 #define _bfd_nosymbols_bfd_make_debug_symbol \
432   ((asymbol *(*) (bfd *, void *, unsigned long)) bfd_nullvoidptr)
433 #define _bfd_nosymbols_read_minisymbols \
434   ((long (*) (bfd *, bfd_boolean, void **, unsigned int *)) _bfd_n1)
435 #define _bfd_nosymbols_minisymbol_to_symbol \
436   ((asymbol *(*) (bfd *, bfd_boolean, const void *, asymbol *)) \
437    bfd_nullvoidptr)
438
439 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
440    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
441
442 extern long _bfd_norelocs_get_reloc_upper_bound (bfd *, asection *);
443 extern long _bfd_norelocs_canonicalize_reloc (bfd *, asection *,
444                                               arelent **, asymbol **);
445 #define _bfd_norelocs_bfd_reloc_type_lookup \
446   ((reloc_howto_type *(*) (bfd *, bfd_reloc_code_real_type)) bfd_nullvoidptr)
447 #define _bfd_norelocs_bfd_reloc_name_lookup \
448   ((reloc_howto_type *(*) (bfd *, const char *)) bfd_nullvoidptr)
449
450 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
451    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
452
453 #define _bfd_nowrite_set_arch_mach \
454   ((bfd_boolean (*) (bfd *, enum bfd_architecture, unsigned long)) \
455    bfd_false)
456 #define _bfd_nowrite_set_section_contents \
457   ((bfd_boolean (*) (bfd *, asection *, const void *, file_ptr, bfd_size_type)) \
458    bfd_false)
459
460 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
461    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
462
463 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
464 extern bfd_boolean _bfd_generic_set_section_contents
465   (bfd *, asection *, const void *, file_ptr, bfd_size_type);
466
467 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
468    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
469
470 #define _bfd_nolink_sizeof_headers \
471   ((int (*) (bfd *, struct bfd_link_info *)) bfd_0)
472 #define _bfd_nolink_bfd_get_relocated_section_contents \
473   ((bfd_byte *(*) (bfd *, struct bfd_link_info *, struct bfd_link_order *, \
474                    bfd_byte *, bfd_boolean, asymbol **)) \
475    bfd_nullvoidptr)
476 #define _bfd_nolink_bfd_relax_section \
477   ((bfd_boolean (*) \
478     (bfd *, asection *, struct bfd_link_info *, bfd_boolean *)) \
479    bfd_false)
480 #define _bfd_nolink_bfd_gc_sections \
481   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
482    bfd_false)
483 #define _bfd_nolink_bfd_lookup_section_flags \
484   ((bfd_boolean (*) (struct bfd_link_info *, struct flag_info *, asection *)) \
485    bfd_0)
486 #define _bfd_nolink_bfd_merge_sections \
487   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) \
488    bfd_false)
489 #define _bfd_nolink_bfd_is_group_section \
490   ((bfd_boolean (*) (bfd *, const struct bfd_section *)) \
491    bfd_false)
492 #define _bfd_nolink_bfd_discard_group \
493   ((bfd_boolean (*) (bfd *, struct bfd_section *)) \
494    bfd_false)
495 #define _bfd_nolink_bfd_link_hash_table_create \
496   ((struct bfd_link_hash_table *(*) (bfd *)) bfd_nullvoidptr)
497 #define _bfd_nolink_bfd_link_add_symbols \
498   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
499 #define _bfd_nolink_bfd_link_just_syms \
500   ((void (*) (asection *, struct bfd_link_info *)) bfd_void)
501 #define _bfd_nolink_bfd_copy_link_hash_symbol_type \
502   ((void (*) (bfd *, struct bfd_link_hash_entry *, \
503               struct bfd_link_hash_entry *)) bfd_void)
504 #define _bfd_nolink_bfd_final_link \
505   ((bfd_boolean (*) (bfd *, struct bfd_link_info *)) bfd_false)
506 #define _bfd_nolink_bfd_link_split_section \
507   ((bfd_boolean (*) (bfd *, struct bfd_section *)) bfd_false)
508 #define _bfd_nolink_section_already_linked \
509   ((bfd_boolean (*) (bfd *, asection *, \
510                      struct bfd_link_info *)) bfd_false)
511 #define _bfd_nolink_bfd_define_common_symbol \
512   ((bfd_boolean (*) (bfd *, struct bfd_link_info *, \
513                      struct bfd_link_hash_entry *)) bfd_false)
514 #define _bfd_nolink_bfd_link_check_relocs \
515   _bfd_generic_link_check_relocs
516
517 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
518    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
519    (_bfd_nodynamic).  */
520
521 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
522 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
523   ((long (*) (bfd *, asymbol **)) _bfd_n1)
524 #define _bfd_nodynamic_get_synthetic_symtab \
525   ((long (*) (bfd *, long, asymbol **, long, asymbol **, asymbol **)) _bfd_n1)
526 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
527 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
528   ((long (*) (bfd *, arelent **, asymbol **)) _bfd_n1)
529 \f
530 /* Generic routine to determine of the given symbol is a local
531    label.  */
532 extern bfd_boolean bfd_generic_is_local_label_name
533   (bfd *, const char *);
534
535 /* Generic minisymbol routines.  */
536 extern long _bfd_generic_read_minisymbols
537   (bfd *, bfd_boolean, void **, unsigned int *);
538 extern asymbol *_bfd_generic_minisymbol_to_symbol
539   (bfd *, bfd_boolean, const void *, asymbol *);
540
541 /* Find the nearest line using .stab/.stabstr sections.  */
542 extern bfd_boolean _bfd_stab_section_find_nearest_line
543   (bfd *, asymbol **, asection *, bfd_vma, bfd_boolean *,
544    const char **, const char **, unsigned int *, void **);
545
546 /* Find the nearest line using DWARF 1 debugging information.  */
547 extern bfd_boolean _bfd_dwarf1_find_nearest_line
548   (bfd *, asymbol **, asection *, bfd_vma,
549    const char **, const char **, unsigned int *);
550
551 struct dwarf_debug_section
552 {
553   const char *uncompressed_name;
554   const char *compressed_name;
555 };
556
557 /* Map of uncompressed DWARF debug section name to compressed one.  It
558    is terminated by NULL uncompressed_name.  */
559
560 extern const struct dwarf_debug_section dwarf_debug_sections[];
561
562 /* Find the nearest line using DWARF 2 debugging information.  */
563 extern bfd_boolean _bfd_dwarf2_find_nearest_line
564   (bfd *, asymbol **, asymbol *, asection *, bfd_vma,
565    const char **, const char **, unsigned int *, unsigned int *,
566    const struct dwarf_debug_section *, unsigned int, void **);
567
568 /* Find the bias between DWARF addresses and real addresses.  */
569 extern bfd_signed_vma _bfd_dwarf2_find_symbol_bias
570   (asymbol **, void **);
571
572 /* Find inliner info after calling bfd_find_nearest_line. */
573 extern bfd_boolean _bfd_dwarf2_find_inliner_info
574   (bfd *, const char **, const char **, unsigned int *, void **);
575
576 /* Read DWARF 2 debugging information. */
577 extern bfd_boolean _bfd_dwarf2_slurp_debug_info
578   (bfd *, bfd *, const struct dwarf_debug_section *, asymbol **, void **,
579    bfd_boolean);
580
581 /* Clean up the data used to handle DWARF 2 debugging information. */
582 extern void _bfd_dwarf2_cleanup_debug_info
583   (bfd *, void **);
584
585 /* Create a new section entry.  */
586 extern struct bfd_hash_entry *bfd_section_hash_newfunc
587   (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);
588
589 /* A routine to create entries for a bfd_link_hash_table.  */
590 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
591   (struct bfd_hash_entry *entry, struct bfd_hash_table *table,
592    const char *string);
593
594 /* Initialize a bfd_link_hash_table.  */
595 extern bfd_boolean _bfd_link_hash_table_init
596   (struct bfd_link_hash_table *, bfd *,
597    struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
598                                struct bfd_hash_table *,
599                                const char *),
600    unsigned int);
601
602 /* Generic link hash table creation routine.  */
603 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
604   (bfd *);
605
606 /* Generic link hash table destruction routine.  */
607 extern void _bfd_generic_link_hash_table_free
608   (bfd *);
609
610 /* Generic add symbol routine.  */
611 extern bfd_boolean _bfd_generic_link_add_symbols
612   (bfd *, struct bfd_link_info *);
613
614 /* Generic add symbol routine.  This version is used by targets for
615    which the linker must collect constructors and destructors by name,
616    as the collect2 program does.  */
617 extern bfd_boolean _bfd_generic_link_add_symbols_collect
618   (bfd *, struct bfd_link_info *);
619
620 /* Generic archive add symbol routine.  */
621 extern bfd_boolean _bfd_generic_link_add_archive_symbols
622   (bfd *, struct bfd_link_info *,
623    bfd_boolean (*) (bfd *, struct bfd_link_info *,
624                     struct bfd_link_hash_entry *, const char *,
625                     bfd_boolean *));
626
627 /* Forward declaration to avoid prototype errors.  */
628 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
629
630 /* Generic routine to add a single symbol.  */
631 extern bfd_boolean _bfd_generic_link_add_one_symbol
632   (struct bfd_link_info *, bfd *, const char *name, flagword,
633    asection *, bfd_vma, const char *, bfd_boolean copy,
634    bfd_boolean constructor, struct bfd_link_hash_entry **);
635
636 /* Generic routine to mark section as supplying symbols only.  */
637 extern void _bfd_generic_link_just_syms
638   (asection *, struct bfd_link_info *);
639
640 /* Generic routine that does nothing.  */
641 extern void _bfd_generic_copy_link_hash_symbol_type
642   (bfd *, struct bfd_link_hash_entry *, struct bfd_link_hash_entry *);
643
644 /* Generic link routine.  */
645 extern bfd_boolean _bfd_generic_final_link
646   (bfd *, struct bfd_link_info *);
647
648 extern bfd_boolean _bfd_generic_link_split_section
649   (bfd *, struct bfd_section *);
650
651 extern bfd_boolean _bfd_generic_section_already_linked
652   (bfd *, asection *, struct bfd_link_info *);
653
654 /* Generic reloc_link_order processing routine.  */
655 extern bfd_boolean _bfd_generic_reloc_link_order
656   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
657
658 /* Default link order processing routine.  */
659 extern bfd_boolean _bfd_default_link_order
660   (bfd *, struct bfd_link_info *, asection *, struct bfd_link_order *);
661
662 /* Count the number of reloc entries in a link order list.  */
663 extern unsigned int _bfd_count_link_order_relocs
664   (struct bfd_link_order *);
665
666 /* Final link relocation routine.  */
667 extern bfd_reloc_status_type _bfd_final_link_relocate
668   (reloc_howto_type *, bfd *, asection *, bfd_byte *,
669    bfd_vma, bfd_vma, bfd_vma);
670
671 /* Relocate a particular location by a howto and a value.  */
672 extern bfd_reloc_status_type _bfd_relocate_contents
673   (reloc_howto_type *, bfd *, bfd_vma, bfd_byte *);
674
675 /* Clear a given location using a given howto.  */
676 extern void _bfd_clear_contents (reloc_howto_type *howto, bfd *input_bfd,
677                                  asection *input_section, bfd_byte *location);
678
679 /* Link stabs in sections in the first pass.  */
680
681 extern bfd_boolean _bfd_link_section_stabs
682   (bfd *, struct stab_info *, asection *, asection *, void **,
683    bfd_size_type *);
684
685 /* Eliminate stabs for discarded functions and symbols.  */
686 extern bfd_boolean _bfd_discard_section_stabs
687   (bfd *, asection *, void *, bfd_boolean (*) (bfd_vma, void *), void *);
688
689 /* Write out the .stab section when linking stabs in sections.  */
690
691 extern bfd_boolean _bfd_write_section_stabs
692   (bfd *, struct stab_info *, asection *, void **, bfd_byte *);
693
694 /* Write out the .stabstr string table when linking stabs in sections.  */
695
696 extern bfd_boolean _bfd_write_stab_strings
697   (bfd *, struct stab_info *);
698
699 /* Find an offset within a .stab section when linking stabs in
700    sections.  */
701
702 extern bfd_vma _bfd_stab_section_offset
703   (asection *, void *, bfd_vma);
704
705 /* Register a SEC_MERGE section as a candidate for merging.  */
706
707 extern bfd_boolean _bfd_add_merge_section
708   (bfd *, void **, asection *, void **);
709
710 /* Attempt to merge SEC_MERGE sections.  */
711
712 extern bfd_boolean _bfd_merge_sections
713   (bfd *, struct bfd_link_info *, void *, void (*) (bfd *, asection *));
714
715 /* Write out a merged section.  */
716
717 extern bfd_boolean _bfd_write_merged_section
718   (bfd *, asection *, void *);
719
720 /* Find an offset within a modified SEC_MERGE section.  */
721
722 extern bfd_vma _bfd_merged_section_offset
723   (bfd *, asection **, void *, bfd_vma);
724
725 /* Tidy up when done.  */
726
727 extern void _bfd_merge_sections_free (void *);
728
729 /* Create a string table.  */
730 extern struct bfd_strtab_hash *_bfd_stringtab_init
731   (void);
732
733 /* Create an XCOFF .debug section style string table.  */
734 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init
735   (void);
736
737 /* Free a string table.  */
738 extern void _bfd_stringtab_free
739   (struct bfd_strtab_hash *);
740
741 /* Get the size of a string table.  */
742 extern bfd_size_type _bfd_stringtab_size
743   (struct bfd_strtab_hash *);
744
745 /* Add a string to a string table.  */
746 extern bfd_size_type _bfd_stringtab_add
747   (struct bfd_strtab_hash *, const char *, bfd_boolean hash, bfd_boolean copy);
748
749 /* Write out a string table.  */
750 extern bfd_boolean _bfd_stringtab_emit
751   (bfd *, struct bfd_strtab_hash *);
752 \f
753 /* Macros to tell if bfds are read or write enabled.
754
755    Note that bfds open for read may be scribbled into if the fd passed
756    to bfd_fdopenr is actually open both for read and write
757    simultaneously.  However an output bfd will never be open for
758    read.  Therefore sometimes you want to check bfd_read_p or
759    !bfd_read_p, and only sometimes bfd_write_p.
760 */
761
762 #define bfd_read_p(abfd) \
763   ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
764 #define bfd_write_p(abfd) \
765   ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
766
767 void bfd_assert
768   (const char*,int);
769
770 #define BFD_ASSERT(x) \
771   do { if (!(x)) bfd_assert(__FILE__,__LINE__); } while (0)
772
773 #define BFD_FAIL() \
774   do { bfd_assert(__FILE__,__LINE__); } while (0)
775
776 extern void _bfd_abort
777   (const char *, int, const char *) ATTRIBUTE_NORETURN;
778
779 /* if gcc >= 2.6, we can give a function name, too */
780 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 6)
781 #define __PRETTY_FUNCTION__  ((char *) NULL)
782 #endif
783
784 #undef abort
785 #define abort() _bfd_abort (__FILE__, __LINE__, __PRETTY_FUNCTION__)
786
787 /* Manipulate a system FILE but using BFD's "file_ptr", rather than
788    the system "off_t" or "off64_t", as the offset.  */
789 extern file_ptr real_ftell (FILE *file);
790 extern int real_fseek (FILE *file, file_ptr offset, int whence);
791 extern FILE *real_fopen (const char *filename, const char *modes);
792
793 /* List of supported target vectors, and the default vector (if
794    bfd_default_vector[0] is NULL, there is no default).  */
795 extern const bfd_target * const *bfd_target_vector;
796 extern const bfd_target *bfd_default_vector[];
797
798 /* List of associated target vectors.  */
799 extern const bfd_target * const *bfd_associated_vector;
800
801 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
802    other common header files.  */
803
804 #if defined(__STDC__) || defined(ALMOST_STDC)
805 struct ecoff_find_line;
806 #endif
807
808 extern bfd_boolean _bfd_ecoff_locate_line
809   (bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
810    const struct ecoff_debug_swap * const, struct ecoff_find_line *,
811    const char **, const char **, unsigned int *);
812 extern bfd_boolean _bfd_ecoff_get_accumulated_pdr
813   (void *, bfd_byte *);
814 extern bfd_boolean _bfd_ecoff_get_accumulated_sym
815   (void *, bfd_byte *);
816 extern bfd_boolean _bfd_ecoff_get_accumulated_ss
817   (void *, bfd_byte *);
818
819 extern bfd_vma _bfd_get_gp_value
820   (bfd *);
821 extern void _bfd_set_gp_value
822   (bfd *, bfd_vma);
823
824 /* Function shared by the COFF and ELF SH backends, which have no
825    other common header files.  */
826
827 #ifndef _bfd_sh_align_load_span
828 extern bfd_boolean _bfd_sh_align_load_span
829   (bfd *, asection *, bfd_byte *,
830    bfd_boolean (*) (bfd *, asection *, void *, bfd_byte *, bfd_vma),
831    void *, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, bfd_boolean *);
832 #endif
833
834 /* This is the shape of the elements inside the already_linked hash
835    table. It maps a name onto a list of already_linked elements with
836    the same name.  */
837
838 struct bfd_section_already_linked_hash_entry
839 {
840   struct bfd_hash_entry root;
841   struct bfd_section_already_linked *entry;
842 };
843
844 struct bfd_section_already_linked
845 {
846   struct bfd_section_already_linked *next;
847   asection *sec;
848 };
849
850 extern struct bfd_section_already_linked_hash_entry *
851   bfd_section_already_linked_table_lookup (const char *);
852 extern bfd_boolean bfd_section_already_linked_table_insert
853   (struct bfd_section_already_linked_hash_entry *, asection *);
854 extern void bfd_section_already_linked_table_traverse
855   (bfd_boolean (*) (struct bfd_section_already_linked_hash_entry *,
856                     void *), void *);
857
858 extern bfd_vma read_unsigned_leb128 (bfd *, bfd_byte *, unsigned int *);
859 extern bfd_signed_vma read_signed_leb128 (bfd *, bfd_byte *, unsigned int *);
860 extern bfd_vma safe_read_leb128 (bfd *, bfd_byte *, unsigned int *,
861                                  bfd_boolean, const bfd_byte * const);