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