* config/m68k/monitor.mt (TDEPFILE): Add remote-es.o.
[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
f4bd7a8f 76char *bfd_zmalloc 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 102bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
f4bd7a8f 103bfd * _bfd_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));
f4bd7a8f
DM
114bfd *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos));
115bfd * _bfd_new_bfd PARAMS ((void));
4a81b561
DHW
116
117#define DEFAULT_STRING_SPACE_SIZE 0x2000
287c221d
PB
118boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
119 unsigned int *table_length,
120 char **free_ptr));
898728d4 121
287c221d
PB
122boolean bfd_false PARAMS ((bfd *ignore));
123boolean bfd_true PARAMS ((bfd *ignore));
124PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
125int bfd_0 PARAMS ((bfd *ignore));
126unsigned int bfd_0u PARAMS ((bfd *ignore));
127void bfd_void PARAMS ((bfd *ignore));
128
f4bd7a8f 129bfd * _bfd_new_bfd_contained_in PARAMS ((bfd *));
287c221d
PB
130boolean _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
131char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
132int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
133boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
4a81b561 134 bfd *exec_bfd));
287c221d 135bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4a81b561 136
287c221d 137void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 138 char *hdr));
287c221d 139void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 140 char *hdr));
287c221d 141void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 142 char *hdr));
4a81b561 143
287c221d 144boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 145 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 146
287c221d 147boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 148 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 149
287c221d 150bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
2203f786 151 bfd *last_file));
4a81b561 152
287c221d 153int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
fc723380 154
287c221d
PB
155boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
156 PTR location, file_ptr offset,
157 bfd_size_type count));
01dd1b2b 158
287c221d
PB
159boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
160 PTR location, file_ptr offset,
161 bfd_size_type count));
4c3721d5
ILT
162\f
163/* A routine to create entries for a bfd_link_hash_table. */
164extern struct bfd_hash_entry *_bfd_link_hash_newfunc
165 PARAMS ((struct bfd_hash_entry *entry,
166 struct bfd_hash_table *table,
167 const char *string));
168
169/* Initialize a bfd_link_hash_table. */
170extern boolean _bfd_link_hash_table_init
171 PARAMS ((struct bfd_link_hash_table *, bfd *,
172 struct bfd_hash_entry *(*) (struct bfd_hash_entry *,
173 struct bfd_hash_table *,
174 const char *)));
175
176/* Generic link hash table creation routine. */
177extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create
178 PARAMS ((bfd *));
179
180/* Generic add symbol routine. */
181extern boolean _bfd_generic_link_add_symbols
182 PARAMS ((bfd *, struct bfd_link_info *));
183
184/* Generic archive add symbol routine. */
185extern boolean _bfd_generic_link_add_archive_symbols
186 PARAMS ((bfd *, struct bfd_link_info *,
187 boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *)));
188
189/* Forward declaration to avoid prototype errors. */
190typedef struct bfd_link_hash_entry _bfd_link_hash_entry;
191
192/* Generic routine to add a single symbol. */
193extern boolean _bfd_generic_link_add_one_symbol
194 PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword,
195 asection *, bfd_vma, const char *, boolean copy,
f4bd7a8f 196 boolean constructor, unsigned int bitsize,
4c3721d5
ILT
197 struct bfd_link_hash_entry **));
198
199/* Generic link routine. */
200extern boolean _bfd_generic_final_link
201 PARAMS ((bfd *, struct bfd_link_info *));
202
203/* Default link order processing routine. */
204extern boolean _bfd_default_link_order
205 PARAMS ((bfd *, struct bfd_link_info *, asection *,
206 struct bfd_link_order *));
207
208/* Final link relocation routine. */
209extern bfd_reloc_status_type _bfd_final_link_relocate
210 PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *,
211 bfd_vma address, bfd_vma value, bfd_vma addend));
212
213/* Relocate a particular location by a howto and a value. */
214extern bfd_reloc_status_type _bfd_relocate_contents
215 PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *));
216\f
4a81b561
DHW
217/* Macros to tell if bfds are read or write enabled.
218
219 Note that bfds open for read may be scribbled into if the fd passed
220 to bfd_fdopenr is actually open both for read and write
221 simultaneously. However an output bfd will never be open for
222 read. Therefore sometimes you want to check bfd_read_p or
223 !bfd_read_p, and only sometimes bfd_write_p.
224*/
225
287c221d
PB
226#define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
227#define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
228
229void bfd_assert PARAMS ((char*,int));
4a81b561 230
4a81b561
DHW
231#define BFD_ASSERT(x) \
232{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
233
234#define BFD_FAIL() \
235{ bfd_assert(__FILE__,__LINE__); }
236
287c221d 237FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4a81b561
DHW
238
239extern bfd *bfd_last_cache;
4a81b561
DHW
240
241/* Now Steve, what's the story here? */
242#ifdef lint
243#define itos(x) "l"
244#define stoi(x) 1
245#else
246#define itos(x) ((char*)(x))
247#define stoi(x) ((int)(x))
248#endif
69ebee86
JG
249
250/* Generic routine for close_and_cleanup is really just bfd_true. */
251#define bfd_generic_close_and_cleanup bfd_true
6f715d66 252
4c3721d5 253/* List of supported target vectors, and the default vector (if
f4bd7a8f
DM
254 bfd_default_vector[0] is NULL, there is no default). */
255extern bfd_target *bfd_target_vector[];
256extern bfd_target *bfd_default_vector[];
4c3721d5 257
b8d69097 258/* And more follows */
6f715d66 259
fefb4b30
JG
260void
261bfd_check_init PARAMS ((void));
262
263PTR
e2756048 264bfd_xmalloc PARAMS ((bfd_size_type size));
fefb4b30 265
6affd66a 266PTR
e2756048 267bfd_xmalloc_by_size_t PARAMS ((size_t size));
6affd66a 268
fefb4b30
JG
269void
270bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
271
3ceaa255 272unsigned int
fefb4b30
JG
273bfd_log2 PARAMS ((bfd_vma x));
274
6f715d66 275#define BFD_CACHE_MAX_OPEN 10
6f715d66 276extern bfd *bfd_last_cache;
e98e6ec1 277
6f715d66 278#define bfd_cache_lookup(x) \
0cda46cf
SC
279 ((x)==bfd_last_cache? \
280 (FILE*)(bfd_last_cache->iostream): \
281 bfd_cache_lookup_worker(x))
fefb4b30 282boolean
c188b0be 283bfd_cache_close PARAMS ((bfd *abfd));
fefb4b30
JG
284
285FILE*
c188b0be 286bfd_open_file PARAMS ((bfd *abfd));
fefb4b30
JG
287
288FILE *
c188b0be 289bfd_cache_lookup_worker PARAMS ((bfd *abfd));
fefb4b30
JG
290
291void
292bfd_constructor_entry PARAMS ((bfd *abfd,
e98e6ec1
SC
293 asymbol **symbol_ptr_ptr,
294 CONST char*type));
fefb4b30 295
e2756048 296const struct reloc_howto_struct *
fefb4b30 297bfd_default_reloc_type_lookup
14e3c2e4 298 PARAMS ((bfd *abfd AND
3860075f 299 bfd_reloc_code_real_type code));
fefb4b30
JG
300
301boolean
302bfd_generic_relax_section
303 PARAMS ((bfd *abfd,
d58b7049 304 asection *section,
4c3721d5 305 struct bfd_link_info *,
d5cd3c0e 306 asymbol **symbols));
fefb4b30 307
e98e6ec1 308bfd_byte *
fefb4b30 309
287c221d 310bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
4c3721d5
ILT
311 struct bfd_link_info *link_info,
312 struct bfd_link_order *link_order,
14e3c2e4 313 bfd_byte *data,
4c3721d5
ILT
314 boolean relocateable,
315 asymbol **symbols));
14e3c2e4 316
e98e6ec1 317extern bfd_arch_info_type bfd_default_arch_struct;
fefb4b30
JG
318boolean
319bfd_default_set_arch_mach PARAMS ((bfd *abfd,
e98e6ec1
SC
320 enum bfd_architecture arch,
321 unsigned long mach));
fefb4b30 322
c188b0be 323void
fefb4b30
JG
324bfd_arch_init PARAMS ((void));
325
326void
c188b0be 327bfd_arch_linkin PARAMS ((bfd_arch_info_type *ptr));
fefb4b30
JG
328
329CONST bfd_arch_info_type *
330bfd_default_compatible
331 PARAMS ((CONST bfd_arch_info_type *a,
e98e6ec1 332 CONST bfd_arch_info_type *b));
fefb4b30
JG
333
334boolean
c188b0be 335bfd_default_scan PARAMS ((CONST struct bfd_arch_info *info, CONST char *string));
fefb4b30 336
3ceaa255 337struct elf_internal_shdr *
6affd66a 338bfd_elf_find_section PARAMS ((bfd *abfd, char *name));
fefb4b30 339
This page took 0.115675 seconds and 4 git commands to generate.