1 /* libbfd.h -- Declarations used by bfd library *implementation*.
2 (This include file is not for users of the library.)
3 Copyright 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
4 Written by Cygnus Support.
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
10 This file is part of BFD, the Binary File Descriptor library.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
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. */
28 #define BFD_ALIGN(this, boundary) \
29 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
31 /* If you want to read and write large blocks, you might want to do it
32 in quanta of this amount */
33 #define DEFAULT_BUFFERSIZE 8192
35 /* Set a tdata field. Can't use the other macros for this, since they
36 do casts, and casting to the left of assignment isn't portable. */
37 #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
39 /* tdata for an archive. For an input archive, cache
40 needs to be free()'d. For an output archive, symdefs do. */
43 file_ptr first_file_filepos;
44 /* Speed up searching the armap */
45 struct ar_cache *cache;
46 bfd *archive_head; /* Only interesting in output routines */
47 carsym *symdefs; /* the symdef entries */
48 symindex symdef_count; /* how many there are */
49 char *extended_names; /* clever intel extension */
50 /* when more compilers are standard C, this can be a time_t */
51 long armap_timestamp; /* Timestamp value written into armap.
52 This is used for BSD archives to check
53 that the timestamp is recent enough
54 for the BSD linker to not complain,
55 just before we finish writing an
57 file_ptr armap_datepos; /* Position within archive to seek to
58 rewrite the date field. */
59 PTR tdata; /* Backend specific information. */
62 #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
64 /* Goes in bfd's arelt_data slot */
66 char * arch_header; /* it's actually a string */
67 unsigned int parsed_size; /* octets of filesize not including ar_hdr */
68 char *filename; /* null-terminated */
71 #define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
73 char *bfd_zmalloc PARAMS ((bfd_size_type size));
75 extern bfd_error_handler_type _bfd_error_handler;
77 /* These routines allocate and free things on the BFD's obstack. Note
78 that realloc can never occur in place. */
80 PTR bfd_alloc PARAMS ((bfd *abfd, size_t size));
81 PTR bfd_zalloc PARAMS ((bfd *abfd, size_t size));
82 PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t size));
83 void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
84 PTR bfd_alloc_finish PARAMS ((bfd *abfd));
85 PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
87 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
89 bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
90 bfd * _bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
91 boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
92 boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
93 const bfd_target *bfd_generic_archive_p PARAMS ((bfd *abfd));
94 boolean bfd_slurp_armap PARAMS ((bfd *abfd));
95 boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
96 #define bfd_slurp_bsd_armap bfd_slurp_armap
97 #define bfd_slurp_coff_armap bfd_slurp_armap
98 boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
99 extern boolean _bfd_construct_extended_name_table
100 PARAMS ((bfd *, boolean, char **, bfd_size_type *));
101 boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
102 boolean _bfd_compute_and_write_armap PARAMS ((bfd *, unsigned int elength));
103 bfd *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
104 bfd * _bfd_new_bfd PARAMS ((void));
106 boolean bfd_false PARAMS ((bfd *ignore));
107 boolean bfd_true PARAMS ((bfd *ignore));
108 PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
109 int bfd_0 PARAMS ((bfd *ignore));
110 unsigned int bfd_0u PARAMS ((bfd *ignore));
111 long bfd_0l PARAMS ((bfd *ignore));
112 long _bfd_n1 PARAMS ((bfd *ignore));
113 void bfd_void PARAMS ((bfd *ignore));
115 bfd *_bfd_new_bfd_contained_in PARAMS ((bfd *));
116 const bfd_target *_bfd_dummy_target PARAMS ((bfd *abfd));
118 void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
120 void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
122 void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
125 boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
126 struct orl *map, unsigned int orl_count, int stridx));
128 boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
129 struct orl *map, unsigned int orl_count, int stridx));
131 extern PTR _bfd_generic_read_ar_hdr PARAMS ((bfd *));
133 bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
136 int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
138 #define _bfd_read_ar_hdr(abfd) \
139 BFD_SEND (abfd, _bfd_read_ar_hdr, (abfd))
141 /* Generic routines to use for BFD_JUMP_TABLE_GENERIC. Use
142 BFD_JUMP_TABLE_GENERIC (_bfd_generic). */
144 #define _bfd_generic_close_and_cleanup bfd_true
145 #define _bfd_generic_bfd_free_cached_info bfd_true
146 #define _bfd_generic_new_section_hook \
147 ((boolean (*) PARAMS ((bfd *, asection *))) bfd_true)
148 extern boolean _bfd_generic_get_section_contents
149 PARAMS ((bfd *, asection *, PTR location, file_ptr offset,
150 bfd_size_type count));
152 /* Generic routines to use for BFD_JUMP_TABLE_COPY. Use
153 BFD_JUMP_TABLE_COPY (_bfd_generic). */
155 #define _bfd_generic_bfd_copy_private_bfd_data \
156 ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
157 #define _bfd_generic_bfd_merge_private_bfd_data \
158 ((boolean (*) PARAMS ((bfd *, bfd *))) bfd_true)
159 #define _bfd_generic_bfd_set_private_flags \
160 ((boolean (*) PARAMS ((bfd *, flagword))) bfd_true)
161 #define _bfd_generic_bfd_copy_private_section_data \
162 ((boolean (*) PARAMS ((bfd *, asection *, bfd *, asection *))) bfd_true)
163 #define _bfd_generic_bfd_copy_private_symbol_data \
164 ((boolean (*) PARAMS ((bfd *, asymbol *, bfd *, asymbol *))) bfd_true)
165 #define _bfd_generic_bfd_print_private_bfd_data \
166 ((boolean (*) PARAMS ((bfd *, void *))) bfd_true)
168 /* Routines to use for BFD_JUMP_TABLE_CORE when there is no core file
169 support. Use BFD_JUMP_TABLE_CORE (_bfd_nocore). */
171 extern char *_bfd_nocore_core_file_failing_command PARAMS ((bfd *));
172 extern int _bfd_nocore_core_file_failing_signal PARAMS ((bfd *));
173 extern boolean _bfd_nocore_core_file_matches_executable_p
174 PARAMS ((bfd *, bfd *));
176 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE when there is no archive
177 file support. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive). */
179 #define _bfd_noarchive_slurp_armap bfd_false
180 #define _bfd_noarchive_slurp_extended_name_table bfd_false
181 #define _bfd_noarchive_construct_extended_name_table \
182 ((boolean (*) PARAMS ((bfd *, char **, bfd_size_type *, const char **))) \
184 #define _bfd_noarchive_truncate_arname \
185 ((void (*) PARAMS ((bfd *, const char *, char *))) bfd_void)
186 #define _bfd_noarchive_write_armap \
188 PARAMS ((bfd *, unsigned int, struct orl *, unsigned int, int))) \
190 #define _bfd_noarchive_read_ar_hdr bfd_nullvoidptr
191 #define _bfd_noarchive_openr_next_archived_file \
192 ((bfd *(*) PARAMS ((bfd *, bfd *))) bfd_nullvoidptr)
193 #define _bfd_noarchive_generic_stat_arch_elt bfd_generic_stat_arch_elt
194 #define _bfd_noarchive_update_armap_timestamp bfd_false
196 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get BSD style
197 archives. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_bsd). */
199 #define _bfd_archive_bsd_slurp_armap bfd_slurp_bsd_armap
200 #define _bfd_archive_bsd_slurp_extended_name_table \
201 _bfd_slurp_extended_name_table
202 extern boolean _bfd_archive_bsd_construct_extended_name_table
203 PARAMS ((bfd *, char **, bfd_size_type *, const char **));
204 #define _bfd_archive_bsd_truncate_arname bfd_bsd_truncate_arname
205 #define _bfd_archive_bsd_write_armap bsd_write_armap
206 #define _bfd_archive_bsd_read_ar_hdr _bfd_generic_read_ar_hdr
207 #define _bfd_archive_bsd_openr_next_archived_file \
208 bfd_generic_openr_next_archived_file
209 #define _bfd_archive_bsd_generic_stat_arch_elt \
210 bfd_generic_stat_arch_elt
211 extern boolean _bfd_archive_bsd_update_armap_timestamp PARAMS ((bfd *));
213 /* Routines to use for BFD_JUMP_TABLE_ARCHIVE to get COFF style
214 archives. Use BFD_JUMP_TABLE_ARCHIVE (_bfd_archive_coff). */
216 #define _bfd_archive_coff_slurp_armap bfd_slurp_coff_armap
217 #define _bfd_archive_coff_slurp_extended_name_table \
218 _bfd_slurp_extended_name_table
219 extern boolean _bfd_archive_coff_construct_extended_name_table
220 PARAMS ((bfd *, char **, bfd_size_type *, const char **));
221 #define _bfd_archive_coff_truncate_arname bfd_dont_truncate_arname
222 #define _bfd_archive_coff_write_armap coff_write_armap
223 #define _bfd_archive_coff_read_ar_hdr _bfd_generic_read_ar_hdr
224 #define _bfd_archive_coff_openr_next_archived_file \
225 bfd_generic_openr_next_archived_file
226 #define _bfd_archive_coff_generic_stat_arch_elt \
227 bfd_generic_stat_arch_elt
228 #define _bfd_archive_coff_update_armap_timestamp bfd_true
230 /* Routines to use for BFD_JUMP_TABLE_SYMBOLS where there is no symbol
231 support. Use BFD_JUMP_TABLE_SYMBOLS (_bfd_nosymbols). */
233 #define _bfd_nosymbols_get_symtab_upper_bound _bfd_n1
234 #define _bfd_nosymbols_get_symtab \
235 ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
236 #define _bfd_nosymbols_make_empty_symbol \
237 ((asymbol *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
238 #define _bfd_nosymbols_print_symbol \
239 ((void (*) PARAMS ((bfd *, PTR, asymbol *, bfd_print_symbol_type))) bfd_void)
240 #define _bfd_nosymbols_get_symbol_info \
241 ((void (*) PARAMS ((bfd *, asymbol *, symbol_info *))) bfd_void)
242 #define _bfd_nosymbols_bfd_is_local_label \
243 ((boolean (*) PARAMS ((bfd *, asymbol *))) bfd_false)
244 #define _bfd_nosymbols_get_lineno \
245 ((alent *(*) PARAMS ((bfd *, asymbol *))) bfd_nullvoidptr)
246 #define _bfd_nosymbols_find_nearest_line \
248 PARAMS ((bfd *, asection *, asymbol **, bfd_vma, const char **, \
249 const char **, unsigned int *))) \
251 #define _bfd_nosymbols_bfd_make_debug_symbol \
252 ((asymbol *(*) PARAMS ((bfd *, PTR, unsigned long))) bfd_nullvoidptr)
253 #define _bfd_nosymbols_read_minisymbols \
254 ((long (*) PARAMS ((bfd *, boolean, PTR *, unsigned int *))) _bfd_n1)
255 #define _bfd_nosymbols_minisymbol_to_symbol \
256 ((asymbol *(*) PARAMS ((bfd *, boolean, const PTR, asymbol *))) \
259 /* Routines to use for BFD_JUMP_TABLE_RELOCS when there is no reloc
260 support. Use BFD_JUMP_TABLE_RELOCS (_bfd_norelocs). */
262 #define _bfd_norelocs_get_reloc_upper_bound \
263 ((long (*) PARAMS ((bfd *, asection *))) _bfd_n1)
264 #define _bfd_norelocs_canonicalize_reloc \
265 ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) _bfd_n1)
266 #define _bfd_norelocs_bfd_reloc_type_lookup \
267 ((reloc_howto_type *(*) PARAMS ((bfd *, bfd_reloc_code_real_type))) \
270 /* Routines to use for BFD_JUMP_TABLE_WRITE for targets which may not
271 be written. Use BFD_JUMP_TABLE_WRITE (_bfd_nowrite). */
273 #define _bfd_nowrite_set_arch_mach \
274 ((boolean (*) PARAMS ((bfd *, enum bfd_architecture, unsigned long))) \
276 #define _bfd_nowrite_set_section_contents \
277 ((boolean (*) PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type))) \
280 /* Generic routines to use for BFD_JUMP_TABLE_WRITE. Use
281 BFD_JUMP_TABLE_WRITE (_bfd_generic). */
283 #define _bfd_generic_set_arch_mach bfd_default_set_arch_mach
284 extern boolean _bfd_generic_set_section_contents
285 PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
287 /* Routines to use for BFD_JUMP_TABLE_LINK for targets which do not
288 support linking. Use BFD_JUMP_TABLE_LINK (_bfd_nolink). */
290 #define _bfd_nolink_sizeof_headers ((int (*) PARAMS ((bfd *, boolean))) bfd_0)
291 #define _bfd_nolink_bfd_get_relocated_section_contents \
293 PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *, \
294 bfd_byte *, boolean, asymbol **))) \
296 #define _bfd_nolink_bfd_relax_section \
298 PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *))) \
300 #define _bfd_nolink_bfd_link_hash_table_create \
301 ((struct bfd_link_hash_table *(*) PARAMS ((bfd *))) bfd_nullvoidptr)
302 #define _bfd_nolink_bfd_link_add_symbols \
303 ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
304 #define _bfd_nolink_bfd_final_link \
305 ((boolean (*) PARAMS ((bfd *, struct bfd_link_info *))) bfd_false)
306 #define _bfd_nolink_bfd_link_split_section \
307 ((boolean (*) PARAMS ((bfd *, struct sec *))) bfd_false)
309 /* Routines to use for BFD_JUMP_TABLE_DYNAMIC for targets which do not
310 have dynamic symbols or relocs. Use BFD_JUMP_TABLE_DYNAMIC
313 #define _bfd_nodynamic_get_dynamic_symtab_upper_bound _bfd_n1
314 #define _bfd_nodynamic_canonicalize_dynamic_symtab \
315 ((long (*) PARAMS ((bfd *, asymbol **))) _bfd_n1)
316 #define _bfd_nodynamic_get_dynamic_reloc_upper_bound _bfd_n1
317 #define _bfd_nodynamic_canonicalize_dynamic_reloc \
318 ((long (*) PARAMS ((bfd *, arelent **, asymbol **))) _bfd_n1)
320 /* Generic routine to determine of the given symbol is a local
322 extern boolean bfd_generic_is_local_label PARAMS ((bfd *, asymbol *));
324 /* Generic minisymbol routines. */
325 extern long _bfd_generic_read_minisymbols
326 PARAMS ((bfd *, boolean, PTR *, unsigned int *));
327 extern asymbol *_bfd_generic_minisymbol_to_symbol
328 PARAMS ((bfd *, boolean, const PTR, asymbol *));
330 /* A routine to create entries for a bfd_link_hash_table. */
331 extern struct bfd_hash_entry *_bfd_link_hash_newfunc
332 PARAMS ((struct bfd_hash_entry *entry,
333 struct bfd_hash_table *table,
334 const char *string));
336 /* Initialize a bfd_link_hash_table. */
337 extern boolean _bfd_link_hash_table_init
338 PARAMS ((struct bfd_link_hash_table *, bfd *,
339 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
340 struct bfd_hash_table *,
343 /* Generic link hash table creation routine. */
344 extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
347 /* Generic add symbol routine. */
348 extern boolean _bfd_generic_link_add_symbols
349 PARAMS ((bfd *, struct bfd_link_info *));
351 /* Generic add symbol routine. This version is used by targets for
352 which the linker must collect constructors and destructors by name,
353 as the collect2 program does. */
354 extern boolean _bfd_generic_link_add_symbols_collect
355 PARAMS ((bfd *, struct bfd_link_info *));
357 /* Generic archive add symbol routine. */
358 extern boolean _bfd_generic_link_add_archive_symbols
359 PARAMS ((bfd *, struct bfd_link_info *,
360 boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
362 /* Forward declaration to avoid prototype errors. */
363 typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
365 /* Generic routine to add a single symbol. */
366 extern boolean _bfd_generic_link_add_one_symbol
367 PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
368 asection *, bfd_vma, const char *, boolean copy,
369 boolean constructor, struct bfd_link_hash_entry **));
371 /* Generic link routine. */
372 extern boolean _bfd_generic_final_link
373 PARAMS ((bfd *, struct bfd_link_info *));
375 extern boolean _bfd_generic_link_split_section
376 PARAMS ((bfd *, struct sec *));
378 /* Generic reloc_link_order processing routine. */
379 extern boolean _bfd_generic_reloc_link_order
380 PARAMS ((bfd *, struct bfd_link_info *, asection *,
381 struct bfd_link_order *));
383 /* Default link order processing routine. */
384 extern boolean _bfd_default_link_order
385 PARAMS ((bfd *, struct bfd_link_info *, asection *,
386 struct bfd_link_order *));
388 /* Count the number of reloc entries in a link order list. */
389 extern unsigned int _bfd_count_link_order_relocs
390 PARAMS ((struct bfd_link_order *));
392 /* Final link relocation routine. */
393 extern bfd_reloc_status_type _bfd_final_link_relocate
394 PARAMS ((reloc_howto_type *, bfd *, asection *, bfd_byte *,
395 bfd_vma address, bfd_vma value, bfd_vma addend));
397 /* Relocate a particular location by a howto and a value. */
398 extern bfd_reloc_status_type _bfd_relocate_contents
399 PARAMS ((reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
401 /* Create a string table. */
402 extern struct bfd_strtab_hash *_bfd_stringtab_init PARAMS ((void));
404 /* Free a string table. */
405 extern void _bfd_stringtab_free PARAMS ((struct bfd_strtab_hash *));
407 /* Get the size of a string table. */
408 extern bfd_size_type _bfd_stringtab_size PARAMS ((struct bfd_strtab_hash *));
410 /* Add a string to a string table. */
411 extern bfd_size_type _bfd_stringtab_add
412 PARAMS ((struct bfd_strtab_hash *, const char *, boolean hash,
415 /* Write out a string table. */
416 extern boolean _bfd_stringtab_emit PARAMS ((bfd *, struct bfd_strtab_hash *));
418 /* Macros to tell if bfds are read or write enabled.
420 Note that bfds open for read may be scribbled into if the fd passed
421 to bfd_fdopenr is actually open both for read and write
422 simultaneously. However an output bfd will never be open for
423 read. Therefore sometimes you want to check bfd_read_p or
424 !bfd_read_p, and only sometimes bfd_write_p.
427 #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
428 #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
430 void bfd_assert PARAMS ((const char*,int));
432 #define BFD_ASSERT(x) \
433 { if (!(x)) bfd_assert(__FILE__,__LINE__); }
436 { bfd_assert(__FILE__,__LINE__); }
438 FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
440 extern bfd *bfd_last_cache;
442 /* Now Steve, what's the story here? */
447 #define itos(x) ((char*)(x))
448 #define stoi(x) ((int)(x))
451 /* List of supported target vectors, and the default vector (if
452 bfd_default_vector[0] is NULL, there is no default). */
453 extern const bfd_target * const bfd_target_vector[];
454 extern const bfd_target * const bfd_default_vector[];
456 /* Functions shared by the ECOFF and MIPS ELF backends, which have no
457 other common header files. */
459 #if defined(__STDC__) || defined(ALMOST_STDC)
460 struct ecoff_find_line;
463 extern boolean _bfd_ecoff_locate_line
464 PARAMS ((bfd *, asection *, bfd_vma, struct ecoff_debug_info * const,
465 const struct ecoff_debug_swap * const, struct ecoff_find_line *,
466 const char **, const char **, unsigned int *));
467 extern boolean _bfd_ecoff_get_accumulated_pdr PARAMS ((PTR, bfd_byte *));
468 extern boolean _bfd_ecoff_get_accumulated_sym PARAMS ((PTR, bfd_byte *));
469 extern boolean _bfd_ecoff_get_accumulated_ss PARAMS ((PTR, bfd_byte *));
471 /* And more follows */