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