19990502 sourceware import
[external/binutils.git] / bfd / libbfd.h
1 /* libbfd.h -- Declarations used by bfd library *implementation*.
2    (This include file is not for users of the library.)
3    Copyright 1990, 91, 92, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
4    Written by Cygnus Support.
5
6 ** NOTE: libbfd.h is a GENERATED file.  Don't change it; instead,
7 ** change libbfd-in.h or the other BFD source files processed to
8 ** generate this file.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
25
26 /* Align an address upward to a boundary, expressed as a number of bytes.
27    E.g. align to an 8-byte boundary with argument of 8.  Take care never
28    to wrap around if the address is within boundary-1 of the end of the
29    address space.  */
30 #define BFD_ALIGN(this, boundary)                                       \
31   ((((bfd_vma) (this) + (boundary) - 1) >= (bfd_vma) (this))            \
32    ? (((bfd_vma) (this) + ((boundary) - 1)) & (~((boundary)-1)))        \
33    : ~ (bfd_vma) 0)
34
35 /* If you want to read and write large blocks, you might want to do it
36    in quanta of this amount */
37 #define DEFAULT_BUFFERSIZE 8192
38
39 /* Set a tdata field.  Can't use the other macros for this, since they
40    do casts, and casting to the left of assignment isn't portable.  */
41 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
42
43 /* If BFD_IN_MEMORY is set for a BFD, then the iostream fields points
44    to an instance of this structure.  */
45
46 struct bfd_in_memory
47 {
48   /* Size of buffer.  */
49   bfd_size_type size;
50   /* Buffer holding contents of BFD.  */
51   bfd_byte *buffer;
52 };
53
54 /* tdata for an archive.  For an input archive, cache
55    needs to be free()'d.  For an output archive, symdefs do.  */
56
57 struct artdata {
58   file_ptr first_file_filepos;
59   /* Speed up searching the armap */
60   struct ar_cache *cache;
61   bfd *archive_head;            /* Only interesting in output routines */
62   carsym *symdefs;              /* the symdef entries */
63   symindex symdef_count;             /* how many there are */
64   char *extended_names;         /* clever intel extension */
65   /* when more compilers are standard C, this can be a time_t */
66   long  armap_timestamp;        /* Timestamp value written into armap.
67                                    This is used for BSD archives to check
68                                    that the timestamp is recent enough
69                                    for the BSD linker to not complain,
70                                    just before we finish writing an
71                                    archive.  */
72   file_ptr armap_datepos;       /* Position within archive to seek to
73                                    rewrite the date field.  */
74   PTR tdata;                    /* Backend specific information.  */
75 };
76
77 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
78
79 /* Goes in bfd's arelt_data slot */
80 struct areltdata {
81   char * arch_header;                        /* it's actually a string */
82   unsigned int parsed_size;     /* octets of filesize not including ar_hdr */
83   char *filename;                            /* null-terminated */
84 };
85
86 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
87
88 extern PTR bfd_malloc PARAMS ((size_t));
89 extern PTR bfd_realloc PARAMS ((PTR, size_t));
90 extern PTR bfd_zmalloc PARAMS ((size_t));
91
92 extern bfd_error_handler_type _bfd_error_handler;
93
94 /* These routines allocate and free things on the BFD's objalloc.  */
95
96 extern PTR bfd_alloc PARAMS ((bfd *, size_t));
97 extern PTR bfd_zalloc PARAMS ((bfd *, size_t));
98 extern void bfd_release PARAMS ((bfd *, PTR));
99
100 bfd *   _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
101 bfd *   _bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
102 boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
103 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
104 const bfd_target *bfd_generic_archive_p PARAMS ((bfd *abfd));
105 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
106 boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
107 #define bfd_slurp_bsd_armap bfd_slurp_armap
108 #define bfd_slurp_coff_armap bfd_slurp_armap
109 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
110 extern boolean _bfd_construct_extended_name_table
111   PARAMS ((bfd *, boolean, char **, bfd_size_type *));
112 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
113 boolean _bfd_compute_and_write_armap PARAMS ((bfd *, unsigned int elength));
114 bfd *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
115 extern bfd *_bfd_generic_get_elt_at_index PARAMS ((bfd *, symindex));
116 bfd * _bfd_new_bfd PARAMS ((void));
117
118 boolean bfd_false PARAMS ((bfd *ignore));
119 boolean bfd_true PARAMS ((bfd *ignore));
120 PTR     bfd_nullvoidptr PARAMS ((bfd *ignore));
121 int     bfd_0 PARAMS ((bfd *ignore));
122 unsigned int    bfd_0u PARAMS ((bfd *ignore));
123 long    bfd_0l PARAMS ((bfd *ignore));
124 long    _bfd_n1 PARAMS ((bfd *ignore));
125 void    bfd_void PARAMS ((bfd *ignore));
126
127 bfd *_bfd_new_bfd_contained_in PARAMS ((bfd *));
128 const bfd_target *_bfd_dummy_target PARAMS ((bfd *abfd));
129
130 void    bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
131                                         char *hdr));
132 void    bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
133                                         char *hdr));
134 void    bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
135                                         char *hdr));
136
137 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
138                                   struct orl *map, unsigned int orl_count, int stridx));
139
140 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
141                                    struct orl *map, unsigned int orl_count, int stridx));
142
143 extern PTR _bfd_generic_read_ar_hdr PARAMS ((bfd *));
144
145 extern PTR _bfd_generic_read_ar_hdr_mag PARAMS ((bfd *, const char *));
146
147 bfd *   bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
148                                                      bfd *last_file));
149
150 int     bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
151
152 #define _bfd_read_ar_hdr(abfd) \
153   BFD_SEND (abfd, _bfd_read_ar_hdr_fn, (abfd))
154 \f
155 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC.  Use
156    BFD_JUMP_TABLE_GENERIC (_bfd_generic).  */
157
158 #define _bfd_generic_close_and_cleanup bfd_true
159 #define _bfd_generic_bfd_free_cached_info bfd_true
160 #define _bfd_generic_new_section_hook \
161   ((boolean (*) PARAMS ((bfd *, asection *))) bfd_true)
162 extern boolean _bfd_generic_get_section_contents
163   PARAMS ((bfd *, asection *, PTR location, file_ptr offset,
164            bfd_size_type count));
165 extern boolean _bfd_generic_get_section_contents_in_window
166   PARAMS ((bfd *, asection *, bfd_window *, file_ptr, bfd_size_type));
167
168 /* Generic routines to use for BFD_JUMP_TABLE_COPY.  Use
169    BFD_JUMP_TABLE_COPY (_bfd_generic).  */
170
171 #define _bfd_generic_bfd_copy_private_bfd_data \
172   ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
173 #define _bfd_generic_bfd_merge_private_bfd_data \
174   ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
175 #define _bfd_generic_bfd_set_private_flags \
176   ((boolean (*) PARAMS ((bfd *, flagword))) bfd_true)
177 #define _bfd_generic_bfd_copy_private_section_data \
178   ((boolean (*) PARAMS ((bfd *, asection *, bfd *, asection *))) bfd_true)
179 #define _bfd_generic_bfd_copy_private_symbol_data \
180   ((boolean (*) PARAMS ((bfd *, asymbol *, bfd *, asymbol *))) bfd_true)
181 #define _bfd_generic_bfd_print_private_bfd_data \
182   ((boolean (*) PARAMS ((bfd *, PTR))) bfd_true)
183
184 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
185    support.  Use BFD_JUMP_TABLE_CORE (_bfd_nocore).  */
186
187 extern char *_bfd_nocore_core_file_failing_command PARAMS ((bfd *));
188 extern int _bfd_nocore_core_file_failing_signal PARAMS ((bfd *));
189 extern boolean _bfd_nocore_core_file_matches_executable_p
190   PARAMS ((bfd *, bfd *));
191
192 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
193    file support.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive).  */
194
195 #define _bfd_noarchive_slurp_armap bfd_false
196 #define _bfd_noarchive_slurp_extended_name_table bfd_false
197 #define _bfd_noarchive_construct_extended_name_table \
198   ((boolean (*) PARAMS ((bfd *, char **, bfd_size_type *, const char **))) \
199    bfd_false)
200 #define _bfd_noarchive_truncate_arname \
201   ((void (*) PARAMS ((bfd *, const char *, char *))) bfd_void)
202 #define _bfd_noarchive_write_armap \
203   ((boolean (*) \
204     PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int))) \
205    bfd_false)
206 #define _bfd_noarchive_read_ar_hdr bfd_nullvoidptr
207 #define _bfd_noarchive_openr_next_archived_file \
208   ((bfd *(*) PARAMS ((bfd *, bfd *))) bfd_nullvoidptr)
209 #define _bfd_noarchive_get_elt_at_index \
210   ((bfd *(*) PARAMS ((bfd *, symindex))) bfd_nullvoidptr)
211 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
212 #define _bfd_noarchive_update_armap_timestamp bfd_false
213
214 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
215    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd).  */
216
217 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
218 #define _bfd_archive_bsd_slurp_extended_name_table \
219   _bfd_slurp_extended_name_table
220 extern boolean _bfd_archive_bsd_construct_extended_name_table
221   PARAMS ((bfd *, char **, bfd_size_type *, const char **));
222 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
223 #define _bfd_archive_bsd_write_armap bsd_write_armap
224 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
225 #define _bfd_archive_bsd_openr_next_archived_file \
226   bfd_generic_openr_next_archived_file
227 #define _bfd_archive_bsd_get_elt_at_index _bfd_generic_get_elt_at_index
228 #define _bfd_archive_bsd_generic_stat_arch_elt \
229   bfd_generic_stat_arch_elt
230 extern boolean _bfd_archive_bsd_update_armap_timestamp PARAMS ((bfd *));
231
232 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
233    archives.  Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff).  */
234
235 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
236 #define _bfd_archive_coff_slurp_extended_name_table \
237   _bfd_slurp_extended_name_table
238 extern boolean _bfd_archive_coff_construct_extended_name_table
239   PARAMS ((bfd *, char **, bfd_size_type *, const char **));
240 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
241 #define _bfd_archive_coff_write_armap coff_write_armap
242 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
243 #define _bfd_archive_coff_openr_next_archived_file \
244   bfd_generic_openr_next_archived_file
245 #define _bfd_archive_coff_get_elt_at_index _bfd_generic_get_elt_at_index
246 #define _bfd_archive_coff_generic_stat_arch_elt \
247   bfd_generic_stat_arch_elt
248 #define _bfd_archive_coff_update_armap_timestamp bfd_true
249
250 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
251    support.  Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols).  */
252
253 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
254 #define _bfd_nosymbols_get_symtab \
255   ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
256 #define _bfd_nosymbols_make_empty_symbol \
257   ((asymbol *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
258 #define _bfd_nosymbols_print_symbol \
259   ((void (*) PARAMS ((bfd *, PTR, asymbol *, bfd_print_symbol_type))) bfd_void)
260 #define _bfd_nosymbols_get_symbol_info \
261   ((void (*) PARAMS ((bfd *, asymbol *, symbol_info *))) bfd_void)
262 #define _bfd_nosymbols_bfd_is_local_label_name \
263   ((boolean (*) PARAMS ((bfd *, const char *))) bfd_false)
264 #define _bfd_nosymbols_get_lineno \
265   ((alent *(*) PARAMS ((bfd *, asymbol *))) bfd_nullvoidptr)
266 #define _bfd_nosymbols_find_nearest_line \
267   ((boolean (*) \
268     PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **, \
269              const char **, unsigned int *))) \
270    bfd_false)
271 #define _bfd_nosymbols_bfd_make_debug_symbol \
272   ((asymbol *(*) PARAMS ((bfd *, PTR, unsigned long))) bfd_nullvoidptr)
273 #define _bfd_nosymbols_read_minisymbols \
274   ((long (*) PARAMS ((bfd *, boolean, PTR *, unsigned int *))) _bfd_n1)
275 #define _bfd_nosymbols_minisymbol_to_symbol \
276   ((asymbol *(*) PARAMS ((bfd *, boolean, const PTR, asymbol *))) \
277    bfd_nullvoidptr)
278
279 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
280    support.  Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs).  */
281
282 #define _bfd_norelocs_get_reloc_upper_bound \
283   ((long (*) PARAMS ((bfd *, asection *))) _bfd_n1)
284 #define _bfd_norelocs_canonicalize_reloc \
285   ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) _bfd_n1)
286 #define _bfd_norelocs_bfd_reloc_type_lookup \
287   ((reloc_howto_type *(*) PARAMS ((bfd *, bfd_reloc_code_real_type))) \
288    bfd_nullvoidptr)
289
290 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
291    be written.  Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite).  */
292
293 #define _bfd_nowrite_set_arch_mach \
294   ((boolean (*) PARAMS ((bfd *, enum bfd_architecture, unsigned long))) \
295    bfd_false)
296 #define _bfd_nowrite_set_section_contents \
297   ((boolean (*) PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type))) \
298    bfd_false)
299
300 /* Generic routines to use for BFD_JUMP_TABLE_WRITE.  Use
301    BFD_JUMP_TABLE_WRITE (_bfd_generic).  */
302
303 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
304 extern boolean _bfd_generic_set_section_contents
305   PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
306
307 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
308    support linking.  Use BFD_JUMP_TABLE_LINK (_bfd_nolink).  */
309
310 #define _bfd_nolink_sizeof_headers ((int (*) PARAMS ((bfd *, boolean))) bfd_0)
311 #define _bfd_nolink_bfd_get_relocated_section_contents \
312   ((bfd_byte *(*) \
313     PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *, \
314              bfd_byte *, boolean, asymbol **))) \
315    bfd_nullvoidptr)
316 #define _bfd_nolink_bfd_relax_section \
317   ((boolean (*) \
318     PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *))) \
319    bfd_false)
320 #define _bfd_nolink_bfd_gc_sections \
321   ((boolean (*) \
322     PARAMS ((bfd *, struct bfd_link_info *))) \
323    bfd_false)
324 #define _bfd_nolink_bfd_link_hash_table_create \
325   ((struct bfd_link_hash_table *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
326 #define _bfd_nolink_bfd_link_add_symbols \
327   ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
328 #define _bfd_nolink_bfd_final_link \
329   ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
330 #define _bfd_nolink_bfd_link_split_section \
331   ((boolean (*) PARAMS ((bfd *, struct sec *))) bfd_false)
332
333 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
334    have dynamic symbols or relocs.  Use BFD_JUMP_TABLE_DYNAMIC
335    (_bfd_nodynamic).  */
336
337 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
338 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
339   ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
340 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
341 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
342   ((long (*) PARAMS ((bfd *, arelent **, asymbol **))) _bfd_n1)
343 \f
344 /* Generic routine to determine of the given symbol is a local
345    label.  */
346 extern boolean bfd_generic_is_local_label_name PARAMS ((bfd *, const char *));
347
348 /* Generic minisymbol routines.  */
349 extern long _bfd_generic_read_minisymbols
350   PARAMS ((bfd *, boolean, PTR *, unsigned int *));
351 extern asymbol *_bfd_generic_minisymbol_to_symbol
352   PARAMS ((bfd *, boolean, const PTR, asymbol *));
353
354 /* Find the nearest line using .stab/.stabstr sections.  */
355 extern boolean _bfd_stab_section_find_nearest_line
356   PARAMS ((bfd *, asymbol **, asection *, bfd_vma, boolean *, const char **,
357            const char **, unsigned int *, PTR *));
358
359 /* Find the neaderst line using DWARF 1 debugging information.  */
360 extern boolean _bfd_dwarf1_find_nearest_line
361   PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **,
362            const char **, unsigned int *));
363
364 /* Find the nearest line using DWARF 2 debugging information.  */
365 extern boolean _bfd_dwarf2_find_nearest_line
366   PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **,
367            const char **, unsigned int *));
368
369 /* A routine to create entries for a bfd_link_hash_table.  */
370 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
371   PARAMS ((struct bfd_hash_entry *entry,
372            struct bfd_hash_table *table,
373            const char *string));
374
375 /* Initialize a bfd_link_hash_table.  */
376 extern boolean _bfd_link_hash_table_init
377   PARAMS ((struct bfd_link_hash_table *, bfd *,
378            struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
379                                        struct bfd_hash_table *,
380                                        const char *)));
381
382 /* Generic link hash table creation routine.  */
383 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
384   PARAMS ((bfd *));
385
386 /* Generic add symbol routine.  */
387 extern boolean _bfd_generic_link_add_symbols
388   PARAMS ((bfd *, struct bfd_link_info *));
389
390 /* Generic add symbol routine.  This version is used by targets for
391    which the linker must collect constructors and destructors by name,
392    as the collect2 program does.  */
393 extern boolean _bfd_generic_link_add_symbols_collect
394   PARAMS ((bfd *, struct bfd_link_info *));
395
396 /* Generic archive add symbol routine.  */
397 extern boolean _bfd_generic_link_add_archive_symbols
398   PARAMS ((bfd *, struct bfd_link_info *,
399            boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
400
401
402
403 /* Forward declaration to avoid prototype errors.  */
404 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
405
406 /* Generic routine to add a single symbol.  */
407 extern boolean _bfd_generic_link_add_one_symbol
408   PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
409            asection *, bfd_vma, const char *, boolean copy,
410            boolean constructor, struct bfd_link_hash_entry **));
411
412 /* Generic link routine.  */
413 extern boolean _bfd_generic_final_link
414   PARAMS ((bfd *, struct bfd_link_info *));
415
416 extern boolean _bfd_generic_link_split_section
417   PARAMS ((bfd *, struct sec *));
418
419 /* Generic reloc_link_order processing routine.  */
420 extern boolean _bfd_generic_reloc_link_order
421   PARAMS ((bfd *, struct bfd_link_info *, asection *,
422            struct bfd_link_order *));
423
424 /* Default link order processing routine.  */
425 extern boolean _bfd_default_link_order
426   PARAMS ((bfd *, struct bfd_link_info *, asection *,
427            struct bfd_link_order *));
428
429 /* Count the number of reloc entries in a link order list.  */
430 extern unsigned int _bfd_count_link_order_relocs
431   PARAMS ((struct bfd_link_order *));
432
433 /* Final link relocation routine.  */
434 extern bfd_reloc_status_type _bfd_final_link_relocate
435   PARAMS ((reloc_howto_type *, bfd *, asection *, bfd_byte *,
436            bfd_vma address, bfd_vma value, bfd_vma addend));
437
438 /* Relocate a particular location by a howto and a value.  */
439 extern bfd_reloc_status_type _bfd_relocate_contents
440   PARAMS ((reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
441
442 /* Link stabs in sections in the first pass.  */
443
444 extern boolean _bfd_link_section_stabs
445   PARAMS ((bfd *, PTR *, asection *, asection *, PTR *));
446
447 /* Write out the .stab section when linking stabs in sections.  */
448
449 extern boolean _bfd_write_section_stabs
450   PARAMS ((bfd *, PTR *, asection *, PTR *, bfd_byte *));
451
452 /* Write out the .stabstr string table when linking stabs in sections.  */
453
454 extern boolean _bfd_write_stab_strings PARAMS ((bfd *, PTR *));
455
456 /* Find an offset within a .stab section when linking stabs in
457    sections.  */
458
459 extern bfd_vma _bfd_stab_section_offset
460   PARAMS ((bfd *, PTR *, asection *, PTR *, bfd_vma));
461
462 /* Create a string table.  */
463 extern struct bfd_strtab_hash *_bfd_stringtab_init PARAMS ((void));
464
465 /* Create an XCOFF .debug section style string table.  */
466 extern struct bfd_strtab_hash *_bfd_xcoff_stringtab_init PARAMS ((void));
467
468 /* Free a string table.  */
469 extern void _bfd_stringtab_free PARAMS ((struct bfd_strtab_hash *));
470
471 /* Get the size of a string table.  */
472 extern bfd_size_type _bfd_stringtab_size PARAMS ((struct bfd_strtab_hash *));
473
474 /* Add a string to a string table.  */
475 extern bfd_size_type _bfd_stringtab_add
476   PARAMS ((struct bfd_strtab_hash *, const char *, boolean hash,
477            boolean copy));
478
479 /* Write out a string table.  */
480 extern boolean _bfd_stringtab_emit PARAMS ((bfd *, struct bfd_strtab_hash *));
481 \f
482 /* Macros to tell if bfds are read or write enabled.
483
484    Note that bfds open for read may be scribbled into if the fd passed
485    to bfd_fdopenr is actually open both for read and write
486    simultaneously.  However an output bfd will never be open for
487    read.  Therefore sometimes you want to check bfd_read_p or
488    !bfd_read_p, and only sometimes bfd_write_p.
489 */
490
491 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
492 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
493
494 void    bfd_assert PARAMS ((const char*,int));
495
496 #define BFD_ASSERT(x) \
497 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
498
499 #define BFD_FAIL() \
500 { bfd_assert(__FILE__,__LINE__); }
501
502 FILE *  bfd_cache_lookup_worker PARAMS ((bfd *));
503
504 extern bfd *bfd_last_cache;
505
506 /* List of supported target vectors, and the default vector (if
507    bfd_default_vector[0] is NULL, there is no default).  */
508 extern const bfd_target * const bfd_target_vector[];
509 extern const bfd_target *bfd_default_vector[];
510
511 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
512    other common header files.  */
513
514 #if defined(__STDC__) || defined(ALMOST_STDC)
515 struct ecoff_find_line;
516 #endif
517
518 extern boolean _bfd_ecoff_locate_line
519   PARAMS ((bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
520            const struct ecoff_debug_swap * const, struct ecoff_find_line *,
521            const char **, const char **, unsigned int *));
522 extern boolean _bfd_ecoff_get_accumulated_pdr PARAMS ((PTR, bfd_byte *));
523 extern boolean _bfd_ecoff_get_accumulated_sym PARAMS ((PTR, bfd_byte *));
524 extern boolean _bfd_ecoff_get_accumulated_ss PARAMS ((PTR, bfd_byte *));
525
526 extern bfd_vma _bfd_get_gp_value PARAMS ((bfd *));
527 extern void _bfd_set_gp_value PARAMS ((bfd *, bfd_vma));
528
529 /* Function shared by the COFF and ELF SH backends, which have no
530    other common header files.  */
531
532 extern boolean _bfd_sh_align_load_span
533   PARAMS ((bfd *, asection *, bfd_byte *,
534            boolean (*) (bfd *, asection *, PTR, bfd_byte *, bfd_vma),
535            PTR, bfd_vma **, bfd_vma *, bfd_vma, bfd_vma, boolean *));
536
537 /* And more follows */
538
539 void 
540 bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd,  int i));
541
542 unsigned int 
543 bfd_log2 PARAMS ((bfd_vma x));
544
545 #define BFD_CACHE_MAX_OPEN 10
546 extern bfd *bfd_last_cache;
547
548 #define bfd_cache_lookup(x) \
549     ((x)==bfd_last_cache? \
550       (FILE*)(bfd_last_cache->iostream): \
551        bfd_cache_lookup_worker(x))
552 boolean 
553 bfd_cache_init  PARAMS ((bfd *abfd));
554
555 boolean 
556 bfd_cache_close  PARAMS ((bfd *abfd));
557
558 FILE* 
559 bfd_open_file PARAMS ((bfd *abfd));
560
561 FILE *
562 bfd_cache_lookup_worker PARAMS ((bfd *abfd));
563
564 #ifdef _BFD_MAKE_TABLE_bfd_reloc_code_real
565
566 static const char *const bfd_reloc_code_real_names[] = { "@@uninitialized@@",
567
568   "BFD_RELOC_64",
569   "BFD_RELOC_32",
570   "BFD_RELOC_26",
571   "BFD_RELOC_24",
572   "BFD_RELOC_16",
573   "BFD_RELOC_14",
574   "BFD_RELOC_8",
575   "BFD_RELOC_64_PCREL",
576   "BFD_RELOC_32_PCREL",
577   "BFD_RELOC_24_PCREL",
578   "BFD_RELOC_16_PCREL",
579   "BFD_RELOC_12_PCREL",
580   "BFD_RELOC_8_PCREL",
581   "BFD_RELOC_32_GOT_PCREL",
582   "BFD_RELOC_16_GOT_PCREL",
583   "BFD_RELOC_8_GOT_PCREL",
584   "BFD_RELOC_32_GOTOFF",
585   "BFD_RELOC_16_GOTOFF",
586   "BFD_RELOC_LO16_GOTOFF",
587   "BFD_RELOC_HI16_GOTOFF",
588   "BFD_RELOC_HI16_S_GOTOFF",
589   "BFD_RELOC_8_GOTOFF",
590   "BFD_RELOC_32_PLT_PCREL",
591   "BFD_RELOC_24_PLT_PCREL",
592   "BFD_RELOC_16_PLT_PCREL",
593   "BFD_RELOC_8_PLT_PCREL",
594   "BFD_RELOC_32_PLTOFF",
595   "BFD_RELOC_16_PLTOFF",
596   "BFD_RELOC_LO16_PLTOFF",
597   "BFD_RELOC_HI16_PLTOFF",
598   "BFD_RELOC_HI16_S_PLTOFF",
599   "BFD_RELOC_8_PLTOFF",
600   "BFD_RELOC_68K_GLOB_DAT",
601   "BFD_RELOC_68K_JMP_SLOT",
602   "BFD_RELOC_68K_RELATIVE",
603   "BFD_RELOC_32_BASEREL",
604   "BFD_RELOC_16_BASEREL",
605   "BFD_RELOC_LO16_BASEREL",
606   "BFD_RELOC_HI16_BASEREL",
607   "BFD_RELOC_HI16_S_BASEREL",
608   "BFD_RELOC_8_BASEREL",
609   "BFD_RELOC_RVA",
610   "BFD_RELOC_8_FFnn",
611   "BFD_RELOC_32_PCREL_S2",
612   "BFD_RELOC_16_PCREL_S2",
613   "BFD_RELOC_23_PCREL_S2",
614   "BFD_RELOC_HI22",
615   "BFD_RELOC_LO10",
616   "BFD_RELOC_GPREL16",
617   "BFD_RELOC_GPREL32",
618   "BFD_RELOC_I960_CALLJ",
619   "BFD_RELOC_NONE",
620   "BFD_RELOC_SPARC_WDISP22",
621   "BFD_RELOC_SPARC22",
622   "BFD_RELOC_SPARC13",
623   "BFD_RELOC_SPARC_GOT10",
624   "BFD_RELOC_SPARC_GOT13",
625   "BFD_RELOC_SPARC_GOT22",
626   "BFD_RELOC_SPARC_PC10",
627   "BFD_RELOC_SPARC_PC22",
628   "BFD_RELOC_SPARC_WPLT30",
629   "BFD_RELOC_SPARC_COPY",
630   "BFD_RELOC_SPARC_GLOB_DAT",
631   "BFD_RELOC_SPARC_JMP_SLOT",
632   "BFD_RELOC_SPARC_RELATIVE",
633   "BFD_RELOC_SPARC_UA32",
634   "BFD_RELOC_SPARC_BASE13",
635   "BFD_RELOC_SPARC_BASE22",
636   "BFD_RELOC_SPARC_10",
637   "BFD_RELOC_SPARC_11",
638   "BFD_RELOC_SPARC_OLO10",
639   "BFD_RELOC_SPARC_HH22",
640   "BFD_RELOC_SPARC_HM10",
641   "BFD_RELOC_SPARC_LM22",
642   "BFD_RELOC_SPARC_PC_HH22",
643   "BFD_RELOC_SPARC_PC_HM10",
644   "BFD_RELOC_SPARC_PC_LM22",
645   "BFD_RELOC_SPARC_WDISP16",
646   "BFD_RELOC_SPARC_WDISP19",
647   "BFD_RELOC_SPARC_7",
648   "BFD_RELOC_SPARC_6",
649   "BFD_RELOC_SPARC_5",
650   "BFD_RELOC_SPARC_PLT64",
651   "BFD_RELOC_SPARC_HIX22",
652   "BFD_RELOC_SPARC_LOX10",
653   "BFD_RELOC_SPARC_H44",
654   "BFD_RELOC_SPARC_M44",
655   "BFD_RELOC_SPARC_L44",
656   "BFD_RELOC_SPARC_REGISTER",
657   "BFD_RELOC_SPARC_REV32",
658   "BFD_RELOC_ALPHA_GPDISP_HI16",
659   "BFD_RELOC_ALPHA_GPDISP_LO16",
660   "BFD_RELOC_ALPHA_GPDISP",
661   "BFD_RELOC_ALPHA_LITERAL",
662   "BFD_RELOC_ALPHA_ELF_LITERAL",
663   "BFD_RELOC_ALPHA_LITUSE",
664   "BFD_RELOC_ALPHA_HINT",
665   "BFD_RELOC_ALPHA_LINKAGE",
666   "BFD_RELOC_ALPHA_CODEADDR",
667   "BFD_RELOC_MIPS_JMP",
668   "BFD_RELOC_MIPS16_JMP",
669   "BFD_RELOC_MIPS16_GPREL",
670   "BFD_RELOC_HI16",
671   "BFD_RELOC_HI16_S",
672   "BFD_RELOC_LO16",
673   "BFD_RELOC_PCREL_HI16_S",
674   "BFD_RELOC_PCREL_LO16",
675   "BFD_RELOC_MIPS_LITERAL",
676   "BFD_RELOC_MIPS_GOT16",
677   "BFD_RELOC_MIPS_CALL16",
678   "BFD_RELOC_MIPS_GOT_HI16",
679   "BFD_RELOC_MIPS_GOT_LO16",
680   "BFD_RELOC_MIPS_CALL_HI16",
681   "BFD_RELOC_MIPS_CALL_LO16",
682
683   "BFD_RELOC_386_GOT32",
684   "BFD_RELOC_386_PLT32",
685   "BFD_RELOC_386_COPY",
686   "BFD_RELOC_386_GLOB_DAT",
687   "BFD_RELOC_386_JUMP_SLOT",
688   "BFD_RELOC_386_RELATIVE",
689   "BFD_RELOC_386_GOTOFF",
690   "BFD_RELOC_386_GOTPC",
691   "BFD_RELOC_NS32K_IMM_8",
692   "BFD_RELOC_NS32K_IMM_16",
693   "BFD_RELOC_NS32K_IMM_32",
694   "BFD_RELOC_NS32K_IMM_8_PCREL",
695   "BFD_RELOC_NS32K_IMM_16_PCREL",
696   "BFD_RELOC_NS32K_IMM_32_PCREL",
697   "BFD_RELOC_NS32K_DISP_8",
698   "BFD_RELOC_NS32K_DISP_16",
699   "BFD_RELOC_NS32K_DISP_32",
700   "BFD_RELOC_NS32K_DISP_8_PCREL",
701   "BFD_RELOC_NS32K_DISP_16_PCREL",
702   "BFD_RELOC_NS32K_DISP_32_PCREL",
703   "BFD_RELOC_PPC_B26",
704   "BFD_RELOC_PPC_BA26",
705   "BFD_RELOC_PPC_TOC16",
706   "BFD_RELOC_PPC_B16",
707   "BFD_RELOC_PPC_B16_BRTAKEN",
708   "BFD_RELOC_PPC_B16_BRNTAKEN",
709   "BFD_RELOC_PPC_BA16",
710   "BFD_RELOC_PPC_BA16_BRTAKEN",
711   "BFD_RELOC_PPC_BA16_BRNTAKEN",
712   "BFD_RELOC_PPC_COPY",
713   "BFD_RELOC_PPC_GLOB_DAT",
714   "BFD_RELOC_PPC_JMP_SLOT",
715   "BFD_RELOC_PPC_RELATIVE",
716   "BFD_RELOC_PPC_LOCAL24PC",
717   "BFD_RELOC_PPC_EMB_NADDR32",
718   "BFD_RELOC_PPC_EMB_NADDR16",
719   "BFD_RELOC_PPC_EMB_NADDR16_LO",
720   "BFD_RELOC_PPC_EMB_NADDR16_HI",
721   "BFD_RELOC_PPC_EMB_NADDR16_HA",
722   "BFD_RELOC_PPC_EMB_SDAI16",
723   "BFD_RELOC_PPC_EMB_SDA2I16",
724   "BFD_RELOC_PPC_EMB_SDA2REL",
725   "BFD_RELOC_PPC_EMB_SDA21",
726   "BFD_RELOC_PPC_EMB_MRKREF",
727   "BFD_RELOC_PPC_EMB_RELSEC16",
728   "BFD_RELOC_PPC_EMB_RELST_LO",
729   "BFD_RELOC_PPC_EMB_RELST_HI",
730   "BFD_RELOC_PPC_EMB_RELST_HA",
731   "BFD_RELOC_PPC_EMB_BIT_FLD",
732   "BFD_RELOC_PPC_EMB_RELSDA",
733   "BFD_RELOC_CTOR",
734   "BFD_RELOC_ARM_PCREL_BRANCH",
735   "BFD_RELOC_ARM_IMMEDIATE",
736   "BFD_RELOC_ARM_OFFSET_IMM",
737   "BFD_RELOC_ARM_SHIFT_IMM",
738   "BFD_RELOC_ARM_SWI",
739   "BFD_RELOC_ARM_MULTI",
740   "BFD_RELOC_ARM_CP_OFF_IMM",
741   "BFD_RELOC_ARM_ADR_IMM",
742   "BFD_RELOC_ARM_LDR_IMM",
743   "BFD_RELOC_ARM_LITERAL",
744   "BFD_RELOC_ARM_IN_POOL",
745   "BFD_RELOC_ARM_OFFSET_IMM8",
746   "BFD_RELOC_ARM_HWLITERAL",
747   "BFD_RELOC_ARM_THUMB_ADD",
748   "BFD_RELOC_ARM_THUMB_IMM",
749   "BFD_RELOC_ARM_THUMB_SHIFT",
750   "BFD_RELOC_ARM_THUMB_OFFSET",
751   "BFD_RELOC_ARM_GOT12",
752   "BFD_RELOC_ARM_GOT32",
753   "BFD_RELOC_ARM_JUMP_SLOT",
754   "BFD_RELOC_ARM_COPY",
755   "BFD_RELOC_ARM_GLOB_DAT",
756   "BFD_RELOC_ARM_PLT32",
757   "BFD_RELOC_ARM_RELATIVE",
758   "BFD_RELOC_ARM_GOTOFF",
759   "BFD_RELOC_ARM_GOTPC",
760   "BFD_RELOC_SH_PCDISP8BY2",
761   "BFD_RELOC_SH_PCDISP12BY2",
762   "BFD_RELOC_SH_IMM4",
763   "BFD_RELOC_SH_IMM4BY2",
764   "BFD_RELOC_SH_IMM4BY4",
765   "BFD_RELOC_SH_IMM8",
766   "BFD_RELOC_SH_IMM8BY2",
767   "BFD_RELOC_SH_IMM8BY4",
768   "BFD_RELOC_SH_PCRELIMM8BY2",
769   "BFD_RELOC_SH_PCRELIMM8BY4",
770   "BFD_RELOC_SH_SWITCH16",
771   "BFD_RELOC_SH_SWITCH32",
772   "BFD_RELOC_SH_USES",
773   "BFD_RELOC_SH_COUNT",
774   "BFD_RELOC_SH_ALIGN",
775   "BFD_RELOC_SH_CODE",
776   "BFD_RELOC_SH_DATA",
777   "BFD_RELOC_SH_LABEL",
778   "BFD_RELOC_THUMB_PCREL_BRANCH9",
779   "BFD_RELOC_THUMB_PCREL_BRANCH12",
780   "BFD_RELOC_THUMB_PCREL_BRANCH23",
781   "BFD_RELOC_ARC_B22_PCREL",
782   "BFD_RELOC_ARC_B26",
783   "BFD_RELOC_D10V_10_PCREL_R",
784   "BFD_RELOC_D10V_10_PCREL_L",
785   "BFD_RELOC_D10V_18",
786   "BFD_RELOC_D10V_18_PCREL",
787   "BFD_RELOC_D30V_6",
788   "BFD_RELOC_D30V_9_PCREL",
789   "BFD_RELOC_D30V_9_PCREL_R",
790   "BFD_RELOC_D30V_15",
791   "BFD_RELOC_D30V_15_PCREL",
792   "BFD_RELOC_D30V_15_PCREL_R",
793   "BFD_RELOC_D30V_21",
794   "BFD_RELOC_D30V_21_PCREL",
795   "BFD_RELOC_D30V_21_PCREL_R",
796   "BFD_RELOC_D30V_32",
797   "BFD_RELOC_D30V_32_PCREL",
798   "BFD_RELOC_M32R_24",
799   "BFD_RELOC_M32R_10_PCREL",
800   "BFD_RELOC_M32R_18_PCREL",
801   "BFD_RELOC_M32R_26_PCREL",
802   "BFD_RELOC_M32R_HI16_ULO",
803   "BFD_RELOC_M32R_HI16_SLO",
804   "BFD_RELOC_M32R_LO16",
805   "BFD_RELOC_M32R_SDA16",
806   "BFD_RELOC_V850_9_PCREL",
807   "BFD_RELOC_V850_22_PCREL",
808   "BFD_RELOC_V850_SDA_16_16_OFFSET",
809   "BFD_RELOC_V850_SDA_15_16_OFFSET",
810   "BFD_RELOC_V850_ZDA_16_16_OFFSET",
811   "BFD_RELOC_V850_ZDA_15_16_OFFSET",
812   "BFD_RELOC_V850_TDA_6_8_OFFSET",
813   "BFD_RELOC_V850_TDA_7_8_OFFSET",
814   "BFD_RELOC_V850_TDA_7_7_OFFSET",
815   "BFD_RELOC_V850_TDA_16_16_OFFSET",
816   "BFD_RELOC_V850_TDA_4_5_OFFSET",
817   "BFD_RELOC_V850_TDA_4_4_OFFSET",
818   "BFD_RELOC_V850_SDA_16_16_SPLIT_OFFSET",
819   "BFD_RELOC_V850_ZDA_16_16_SPLIT_OFFSET",
820   "BFD_RELOC_V850_CALLT_6_7_OFFSET",
821   "BFD_RELOC_V850_CALLT_16_16_OFFSET",
822
823   "BFD_RELOC_MN10300_32_PCREL",
824   "BFD_RELOC_MN10300_16_PCREL",
825   "BFD_RELOC_TIC30_LDP",
826   "BFD_RELOC_FR30_48",
827   "BFD_RELOC_FR30_20",
828   "BFD_RELOC_FR30_6_IN_4",
829   "BFD_RELOC_FR30_8_IN_8",
830   "BFD_RELOC_FR30_9_IN_8",
831   "BFD_RELOC_FR30_10_IN_8",
832   "BFD_RELOC_FR30_9_PCREL",
833   "BFD_RELOC_FR30_12_PCREL",
834   "BFD_RELOC_MCORE_PCREL_IMM8BY4",
835   "BFD_RELOC_MCORE_PCREL_IMM11BY2",
836   "BFD_RELOC_MCORE_PCREL_IMM4BY2",
837   "BFD_RELOC_MCORE_PCREL_32",
838   "BFD_RELOC_MCORE_PCREL_JSR_IMM11BY2",
839   "BFD_RELOC_VTABLE_INHERIT",
840   "BFD_RELOC_VTABLE_ENTRY",
841  "@@overflow: BFD_RELOC_UNUSED@@",
842 };
843 #endif
844
845 reloc_howto_type *
846 bfd_default_reloc_type_lookup
847  PARAMS ((bfd *abfd, bfd_reloc_code_real_type  code));
848
849 boolean 
850 bfd_generic_relax_section
851  PARAMS ((bfd *abfd,
852     asection *section,
853     struct bfd_link_info *,
854     boolean *));
855
856 boolean 
857 bfd_generic_gc_sections
858  PARAMS ((bfd *, struct bfd_link_info *));
859
860 bfd_byte *
861
862 bfd_generic_get_relocated_section_contents  PARAMS ((bfd *abfd,
863     struct bfd_link_info *link_info,
864     struct bfd_link_order *link_order,
865     bfd_byte *data,
866     boolean relocateable,
867     asymbol **symbols));
868
869 extern const bfd_arch_info_type bfd_default_arch_struct;
870 boolean 
871 bfd_default_set_arch_mach PARAMS ((bfd *abfd,
872     enum bfd_architecture arch,
873     unsigned long mach));
874
875 const bfd_arch_info_type *
876 bfd_default_compatible
877  PARAMS ((const bfd_arch_info_type *a,
878     const bfd_arch_info_type *b));
879
880 boolean 
881 bfd_default_scan PARAMS ((const struct bfd_arch_info *info, const char *string));
882
883 struct elf_internal_shdr *
884 bfd_elf_find_section  PARAMS ((bfd *abfd, char *name));
885