* target.h: Add enum target_waitkind, enum target_signal, and
[deliverable/binutils-gdb.git] / bfd / libbfd.h
CommitLineData
c618de01
SC
1/* libbfd.h -- Declarations used by bfd library *implementation*.
2 (This include file is not for users of the library.)
14e3c2e4 3 Copyright 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
c618de01 4 Written by Cygnus Support.
fc723380 5
c618de01 6This file is part of BFD, the Binary File Descriptor library.
4a81b561 7
c618de01 8This program is free software; you can redistribute it and/or modify
4a81b561 9it under the terms of the GNU General Public License as published by
c618de01
SC
10the Free Software Foundation; either version 2 of the License, or
11(at your option) any later version.
4a81b561 12
c618de01 13This program is distributed in the hope that it will be useful,
4a81b561
DHW
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
c618de01
SC
19along with this program; if not, write to the Free Software
20Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
4a81b561 21
4c3721d5
ILT
22/* Use builtin alloca for gcc. */
23#ifdef __GNUC__
24#ifndef alloca
25#define alloca __builtin_alloca
26#endif
27#endif
4a81b561 28
01dd1b2b
SC
29/* Align an address upward to a boundary, expressed as a number of bytes.
30 E.g. align to an 8-byte boundary with argument of 8. */
de0da6ce 31#define BFD_ALIGN(this, boundary) \
01dd1b2b
SC
32 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
33
4a81b561
DHW
34/* If you want to read and write large blocks, you might want to do it
35 in quanta of this amount */
36#define DEFAULT_BUFFERSIZE 8192
37
fc723380
JG
38/* Set a tdata field. Can't use the other macros for this, since they
39 do casts, and casting to the left of assignment isn't portable. */
d5cd3c0e 40#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
fc723380
JG
41
42/* tdata for an archive. For an input archive, cache
43 needs to be free()'d. For an output archive, symdefs do. */
4a81b561
DHW
44
45struct artdata {
46 file_ptr first_file_filepos;
47 /* Speed up searching the armap */
48 struct ar_cache *cache;
49 bfd *archive_head; /* Only interesting in output routines */
50 carsym *symdefs; /* the symdef entries */
51 symindex symdef_count; /* how many there are */
52 char *extended_names; /* clever intel extension */
c188b0be
DM
53 /* when more compilers are standard C, this can be a time_t */
54 long armap_timestamp; /* Timestamp value written into armap.
b5b4294e
JG
55 This is used for BSD archives to check
56 that the timestamp is recent enough
57 for the BSD linker to not complain,
58 just before we finish writing an
59 archive. */
60 file_ptr armap_datepos; /* Position within archive to seek to
61 rewrite the date field. */
b59f0276 62 PTR tdata; /* Backend specific information. */
4a81b561
DHW
63};
64
e98e6ec1 65#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4a81b561
DHW
66
67/* Goes in bfd's arelt_data slot */
68struct areltdata {
69 char * arch_header; /* it's actually a string */
70 unsigned int parsed_size; /* octets of filesize not including ar_hdr */
71 char *filename; /* null-terminated */
72};
73
74#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
75
287c221d 76char *zalloc PARAMS ((bfd_size_type size));
9846338e 77
fc723380
JG
78/* These routines allocate and free things on the BFD's obstack. Note
79 that realloc can never occur in place. */
4a81b561 80
6affd66a
KR
81PTR bfd_alloc PARAMS ((bfd *abfd, size_t size));
82PTR bfd_zalloc PARAMS ((bfd *abfd, size_t size));
83PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new));
84void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size));
287c221d
PB
85PTR bfd_alloc_finish PARAMS ((bfd *abfd));
86PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
87
88#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
89
90
91bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size,
92 bfd_size_type nitems, bfd *abfd));
93bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
94 bfd_size_type nitems, bfd *abfd));
95int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
96 CONST int direction));
97long bfd_tell PARAMS ((bfd *abfd));
98
b5b4294e
JG
99int bfd_flush PARAMS ((bfd *abfd));
100int bfd_stat PARAMS ((bfd *abfd, struct stat *));
101
287c221d
PB
102bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
103bfd * look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
b59f0276 104boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *));
287c221d 105boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
b59f0276 106struct areltdata * _bfd_snarf_ar_hdr PARAMS ((bfd *abfd));
287c221d
PB
107bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
108boolean bfd_slurp_armap PARAMS ((bfd *abfd));
898728d4 109boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
287c221d
PB
110#define bfd_slurp_bsd_armap bfd_slurp_armap
111#define bfd_slurp_coff_armap bfd_slurp_armap
112boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
113boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
4c3721d5 114bfd * new_bfd PARAMS ((void));
4a81b561
DHW
115
116#define DEFAULT_STRING_SPACE_SIZE 0x2000
287c221d
PB
117boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
118 unsigned int *table_length,
119 char **free_ptr));
898728d4 120
287c221d
PB
121boolean bfd_false PARAMS ((bfd *ignore));
122boolean bfd_true PARAMS ((bfd *ignore));
123PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
124int bfd_0 PARAMS ((bfd *ignore));
125unsigned int bfd_0u PARAMS ((bfd *ignore));
126void bfd_void PARAMS ((bfd *ignore));
127
128bfd * new_bfd_contained_in PARAMS ((bfd *));
129boolean _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
130char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
131int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
132boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
4a81b561 133 bfd *exec_bfd));
287c221d 134bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4a81b561 135
287c221d 136void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 137 char *hdr));
287c221d 138void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 139 char *hdr));
287c221d 140void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 141 char *hdr));
4a81b561 142
287c221d 143boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 144 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 145
287c221d 146boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 147 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 148
287c221d 149bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
2203f786 150 bfd *last_file));
4a81b561 151
287c221d 152int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
fc723380 153
287c221d
PB
154boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
155 PTR location, file_ptr offset,
156 bfd_size_type count));
01dd1b2b 157
287c221d
PB
158boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
159 PTR location, file_ptr offset,
160 bfd_size_type count));
4c3721d5
ILT
161\f
162/* A routine to create entries for a bfd_link_hash_table. */
163extern struct bfd_hash_entry *_bfd_link_hash_newfunc
164 PARAMS ((struct bfd_hash_entry *entry,
165 struct bfd_hash_table *table,
166 const char *string));
167
168/* Initialize a bfd_link_hash_table. */
169extern boolean _bfd_link_hash_table_init
170 PARAMS ((struct bfd_link_hash_table *, bfd *,
171 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
172 struct bfd_hash_table *,
173 const char *)));
174
175/* Generic link hash table creation routine. */
176extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
177 PARAMS ((bfd *));
178
179/* Generic add symbol routine. */
180extern boolean _bfd_generic_link_add_symbols
181 PARAMS ((bfd *, struct bfd_link_info *));
182
183/* Generic archive add symbol routine. */
184extern boolean _bfd_generic_link_add_archive_symbols
185 PARAMS ((bfd *, struct bfd_link_info *,
186 boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
187
188/* Forward declaration to avoid prototype errors. */
189typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
190
191/* Generic routine to add a single symbol. */
192extern boolean _bfd_generic_link_add_one_symbol
193 PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
194 asection *, bfd_vma, const char *, boolean copy,
195 struct bfd_link_hash_entry **));
196
197/* Generic link routine. */
198extern boolean _bfd_generic_final_link
199 PARAMS ((bfd *, struct bfd_link_info *));
200
201/* Default link order processing routine. */
202extern boolean _bfd_default_link_order
203 PARAMS ((bfd *, struct bfd_link_info *, asection *,
204 struct bfd_link_order *));
205
206/* Final link relocation routine. */
207extern bfd_reloc_status_type _bfd_final_link_relocate
208 PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
209 bfd_vma address, bfd_vma value, bfd_vma addend));
210
211/* Relocate a particular location by a howto and a value. */
212extern bfd_reloc_status_type _bfd_relocate_contents
213 PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
214\f
4a81b561
DHW
215/* Macros to tell if bfds are read or write enabled.
216
217 Note that bfds open for read may be scribbled into if the fd passed
218 to bfd_fdopenr is actually open both for read and write
219 simultaneously. However an output bfd will never be open for
220 read. Therefore sometimes you want to check bfd_read_p or
221 !bfd_read_p, and only sometimes bfd_write_p.
222*/
223
287c221d
PB
224#define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
225#define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
226
227void bfd_assert PARAMS ((char*,int));
4a81b561 228
4a81b561
DHW
229#define BFD_ASSERT(x) \
230{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
231
232#define BFD_FAIL() \
233{ bfd_assert(__FILE__,__LINE__); }
234
287c221d 235FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4a81b561
DHW
236
237extern bfd *bfd_last_cache;
4a81b561
DHW
238
239/* Now Steve, what's the story here? */
240#ifdef lint
241#define itos(x) "l"
242#define stoi(x) 1
243#else
244#define itos(x) ((char*)(x))
245#define stoi(x) ((int)(x))
246#endif
69ebee86
JG
247
248/* Generic routine for close_and_cleanup is really just bfd_true. */
249#define bfd_generic_close_and_cleanup bfd_true
6f715d66 250
4c3721d5
ILT
251/* List of supported target vectors, and the default vector (if
252 default_vector[0] is NULL, there is no default). */
253extern bfd_target *target_vector[];
254extern bfd_target *default_vector[];
255
b8d69097 256/* And more follows */
6f715d66 257
fefb4b30
JG
258void
259bfd_check_init PARAMS ((void));
260
261PTR
e2756048 262bfd_xmalloc PARAMS ((bfd_size_type size));
fefb4b30 263
6affd66a 264PTR
e2756048 265bfd_xmalloc_by_size_t PARAMS ((size_t size));
6affd66a 266
fefb4b30
JG
267void
268bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
269
3ceaa255 270unsigned int
fefb4b30
JG
271bfd_log2 PARAMS ((bfd_vma x));
272
6f715d66 273#define BFD_CACHE_MAX_OPEN 10
6f715d66 274extern bfd *bfd_last_cache;
e98e6ec1 275
6f715d66 276#define bfd_cache_lookup(x) \
0cda46cf
SC
277 ((x)==bfd_last_cache? \
278 (FILE*)(bfd_last_cache->iostream): \
279 bfd_cache_lookup_worker(x))
fefb4b30 280boolean
c188b0be 281bfd_cache_close PARAMS ((bfd *abfd));
fefb4b30
JG
282
283FILE*
c188b0be 284bfd_open_file PARAMS ((bfd *abfd));
fefb4b30
JG
285
286FILE *
c188b0be 287bfd_cache_lookup_worker PARAMS ((bfd *abfd));
fefb4b30
JG
288
289void
290bfd_constructor_entry PARAMS ((bfd *abfd,
e98e6ec1
SC
291 asymbol **symbol_ptr_ptr,
292 CONST char*type));
fefb4b30 293
e2756048 294const struct reloc_howto_struct *
fefb4b30 295bfd_default_reloc_type_lookup
14e3c2e4 296 PARAMS ((bfd *abfd AND
3860075f 297 bfd_reloc_code_real_type code));
fefb4b30
JG
298
299boolean
300bfd_generic_relax_section
301 PARAMS ((bfd *abfd,
d58b7049 302 asection *section,
4c3721d5 303 struct bfd_link_info *,
d5cd3c0e 304 asymbol **symbols));
fefb4b30 305
e98e6ec1 306bfd_byte *
fefb4b30 307
287c221d 308bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
4c3721d5
ILT
309 struct bfd_link_info *link_info,
310 struct bfd_link_order *link_order,
14e3c2e4 311 bfd_byte *data,
4c3721d5
ILT
312 boolean relocateable,
313 asymbol **symbols));
14e3c2e4 314
e98e6ec1 315extern bfd_arch_info_type bfd_default_arch_struct;
fefb4b30
JG
316boolean
317bfd_default_set_arch_mach PARAMS ((bfd *abfd,
e98e6ec1
SC
318 enum bfd_architecture arch,
319 unsigned long mach));
fefb4b30 320
c188b0be 321void
fefb4b30
JG
322bfd_arch_init PARAMS ((void));
323
324void
c188b0be 325bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
fefb4b30
JG
326
327CONST bfd_arch_info_type *
328bfd_default_compatible
329 PARAMS ((CONST bfd_arch_info_type *a,
e98e6ec1 330 CONST bfd_arch_info_type *b));
fefb4b30
JG
331
332boolean
c188b0be 333bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));
fefb4b30 334
3ceaa255 335struct elf_internal_shdr *
6affd66a 336bfd_elf_find_section PARAMS ((bfd *abfd, char *name));
fefb4b30 337
This page took 0.111638 seconds and 4 git commands to generate.