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