Change insertion marker for new bfd.h generation scheme.
[deliverable/binutils-gdb.git] / bfd / libbfd.h
... / ...
CommitLineData
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 Free Software Foundation, Inc.
4 Written by Cygnus Support.
5
6This file is part of BFD, the Binary File Descriptor library.
7
8This program is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 2 of the License, or
11(at your option) any later version.
12
13This program is distributed in the hope that it will be useful,
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
19along with this program; if not, write to the Free Software
20Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
21
22
23/* Align an address upward to a boundary, expressed as a number of bytes.
24 E.g. align to an 8-byte boundary with argument of 8. */
25#define BFD_ALIGN(this, boundary) \
26 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
27
28/* If you want to read and write large blocks, you might want to do it
29 in quanta of this amount */
30#define DEFAULT_BUFFERSIZE 8192
31
32/* Set a tdata field. Can't use the other macros for this, since they
33 do casts, and casting to the left of assignment isn't portable. */
34#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
35
36/* tdata for an archive. For an input archive, cache
37 needs to be free()'d. For an output archive, symdefs do. */
38
39struct artdata {
40 file_ptr first_file_filepos;
41 /* Speed up searching the armap */
42 struct ar_cache *cache;
43 bfd *archive_head; /* Only interesting in output routines */
44 carsym *symdefs; /* the symdef entries */
45 symindex symdef_count; /* how many there are */
46 char *extended_names; /* clever intel extension */
47};
48
49#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
50
51/* Goes in bfd's arelt_data slot */
52struct areltdata {
53 char * arch_header; /* it's actually a string */
54 unsigned int parsed_size; /* octets of filesize not including ar_hdr */
55 char *filename; /* null-terminated */
56};
57
58#define arelt_size(bfd) (((struct areltdata *)((bfd)->arelt_data))->parsed_size)
59
60char *zalloc PARAMS ((bfd_size_type size));
61
62/* These routines allocate and free things on the BFD's obstack. Note
63 that realloc can never occur in place. */
64
65PTR bfd_alloc PARAMS ((bfd *abfd, bfd_size_type size));
66PTR bfd_zalloc PARAMS ((bfd *abfd, bfd_size_type size));
67PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, bfd_size_type new));
68void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, bfd_size_type size));
69PTR bfd_alloc_finish PARAMS ((bfd *abfd));
70PTR bfd_alloc_by_size_t PARAMS ((bfd *abfd, size_t wanted));
71
72#define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
73
74
75bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size,
76 bfd_size_type nitems, bfd *abfd));
77bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size,
78 bfd_size_type nitems, bfd *abfd));
79int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp,
80 CONST int direction));
81long bfd_tell PARAMS ((bfd *abfd));
82
83bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd));
84bfd * look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index));
85boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
86struct areltdata * snarf_ar_hdr PARAMS ((bfd *abfd));
87bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
88boolean bfd_slurp_armap PARAMS ((bfd *abfd));
89#define bfd_slurp_bsd_armap bfd_slurp_armap
90#define bfd_slurp_coff_armap bfd_slurp_armap
91boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd));
92boolean _bfd_write_archive_contents PARAMS ((bfd *abfd));
93bfd * new_bfd PARAMS (());
94
95#define DEFAULT_STRING_SPACE_SIZE 0x2000
96boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
97 unsigned int *table_length,
98 char **free_ptr));
99bfd_vma _do_getb64 PARAMS ((unsigned char *addr));
100bfd_vma _do_getl64 PARAMS ((unsigned char *addr));
101bfd_signed_vma _do_getb_signed_64 PARAMS ((unsigned char *addr));
102bfd_signed_vma _do_getl_signed_64 PARAMS ((unsigned char *addr));
103bfd_vma _do_getb32 PARAMS ((unsigned char *addr));
104bfd_vma _do_getl32 PARAMS ((unsigned char *addr));
105bfd_signed_vma _do_getb_signed_32 PARAMS ((unsigned char *addr));
106bfd_signed_vma _do_getl_signed_32 PARAMS ((unsigned char *addr));
107bfd_vma _do_getb16 PARAMS ((unsigned char *addr));
108bfd_vma _do_getl16 PARAMS ((unsigned char *addr));
109bfd_signed_vma _do_getb_signed_16 PARAMS ((unsigned char *addr));
110bfd_signed_vma _do_getl_signed_16 PARAMS ((unsigned char *addr));
111void _do_putb64 PARAMS ((bfd_vma data, unsigned char *addr));
112void _do_putl64 PARAMS ((bfd_vma data, unsigned char *addr));
113void _do_putb32 PARAMS ((bfd_vma data, unsigned char *addr));
114void _do_putl32 PARAMS ((bfd_vma data, unsigned char *addr));
115void _do_putb16 PARAMS ((bfd_vma data, unsigned char *addr));
116void _do_putl16 PARAMS ((bfd_vma data, unsigned char *addr));
117
118boolean bfd_false PARAMS ((bfd *ignore));
119boolean bfd_true PARAMS ((bfd *ignore));
120PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
121int bfd_0 PARAMS ((bfd *ignore));
122unsigned int bfd_0u PARAMS ((bfd *ignore));
123void bfd_void PARAMS ((bfd *ignore));
124
125bfd * new_bfd_contained_in PARAMS ((bfd *));
126boolean _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
127char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
128int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
129boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
130 bfd *exec_bfd));
131bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
132
133void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
134 char *hdr));
135void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
136 char *hdr));
137void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
138 char *hdr));
139
140boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
141 struct orl *map, unsigned int orl_count, int stridx));
142
143boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
144 struct orl *map, unsigned int orl_count, int stridx));
145
146bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
147 bfd *last_file));
148
149int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
150
151boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
152 PTR location, file_ptr offset,
153 bfd_size_type count));
154
155boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
156 PTR location, file_ptr offset,
157 bfd_size_type count));
158
159/* Macros to tell if bfds are read or write enabled.
160
161 Note that bfds open for read may be scribbled into if the fd passed
162 to bfd_fdopenr is actually open both for read and write
163 simultaneously. However an output bfd will never be open for
164 read. Therefore sometimes you want to check bfd_read_p or
165 !bfd_read_p, and only sometimes bfd_write_p.
166*/
167
168#define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
169#define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
170
171void bfd_assert PARAMS ((char*,int));
172
173#define BFD_ASSERT(x) \
174{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
175
176#define BFD_FAIL() \
177{ bfd_assert(__FILE__,__LINE__); }
178
179FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
180
181extern bfd *bfd_last_cache;
182
183/* Now Steve, what's the story here? */
184#ifdef lint
185#define itos(x) "l"
186#define stoi(x) 1
187#else
188#define itos(x) ((char*)(x))
189#define stoi(x) ((int)(x))
190#endif
191
192/* Generic routine for close_and_cleanup is really just bfd_true. */
193#define bfd_generic_close_and_cleanup bfd_true
194
195/* And more follows */
196
197void
198bfd_check_init PARAMS ((void));
199
200PTR
201bfd_xmalloc PARAMS (( bfd_size_type size));
202
203void
204bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
205
206bfd_vma
207bfd_log2 PARAMS ((bfd_vma x));
208
209#define BFD_CACHE_MAX_OPEN 10
210extern bfd *bfd_last_cache;
211
212#define bfd_cache_lookup(x) \
213 ((x)==bfd_last_cache? \
214 (FILE*)(bfd_last_cache->iostream): \
215 bfd_cache_lookup_worker(x))
216void
217bfd_cache_init PARAMS ((bfd *));
218
219boolean
220bfd_cache_close PARAMS ((bfd *));
221
222FILE*
223bfd_open_file PARAMS ((bfd *));
224
225FILE *
226bfd_cache_lookup_worker PARAMS ((bfd *));
227
228void
229bfd_constructor_entry PARAMS ((bfd *abfd,
230 asymbol **symbol_ptr_ptr,
231 CONST char*type));
232
233CONST struct reloc_howto_struct *
234bfd_default_reloc_type_lookup
235 PARAMS ((bfd *abfd AND
236 bfd_reloc_code_real_type code));
237
238boolean
239bfd_generic_relax_section
240 PARAMS ((bfd *abfd,
241 asection *section,
242 asymbol **symbols));
243
244bfd_byte *
245
246bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
247 struct bfd_seclet *seclet,
248 bfd_byte *data,
249 boolean relocateable));
250
251boolean
252bfd_generic_seclet_link
253 PARAMS ((bfd *abfd,
254 PTR data,
255 boolean relocateable));
256
257extern bfd_arch_info_type bfd_default_arch_struct;
258boolean
259bfd_default_set_arch_mach PARAMS ((bfd *abfd,
260 enum bfd_architecture arch,
261 unsigned long mach));
262
263void
264bfd_arch_init PARAMS ((void));
265
266void
267bfd_arch_linkin PARAMS ((bfd_arch_info_type *));
268
269CONST bfd_arch_info_type *
270bfd_default_compatible
271 PARAMS ((CONST bfd_arch_info_type *a,
272 CONST bfd_arch_info_type *b));
273
274boolean
275bfd_default_scan PARAMS ((CONST struct bfd_arch_info *, CONST char *));
276
277struct elf_internal_shdr *
278bfd_elf_find_section PARAMS ((bfd *abfd, char *name));
279
This page took 0.027105 seconds and 4 git commands to generate.