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