from ralphc: recognize some mips variants
[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.)
de0da6ce 3 Copyright 1990, 1991 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
4a81b561 22
01dd1b2b
SC
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. */
de0da6ce 25#define BFD_ALIGN(this, boundary) \
01dd1b2b
SC
26 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
27
4a81b561
DHW
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
fc723380
JG
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. */
d5cd3c0e 34#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
fc723380
JG
35
36/* tdata for an archive. For an input archive, cache
37 needs to be free()'d. For an output archive, symdefs do. */
4a81b561
DHW
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
e98e6ec1 49#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4a81b561
DHW
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
287c221d 60char *zalloc PARAMS ((bfd_size_type size));
9846338e 61
fc723380
JG
62/* These routines allocate and free things on the BFD's obstack. Note
63 that realloc can never occur in place. */
4a81b561 64
287c221d
PB
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 (());
4a81b561
DHW
94
95#define DEFAULT_STRING_SPACE_SIZE 0x2000
287c221d
PB
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_vma _do_getb32 PARAMS ((unsigned char *addr));
102bfd_vma _do_getl32 PARAMS ((unsigned char *addr));
103bfd_vma _do_getb16 PARAMS ((unsigned char *addr));
104bfd_vma _do_getl16 PARAMS ((unsigned char *addr));
105void _do_putb64 PARAMS ((bfd_vma data, unsigned char *addr));
106void _do_putl64 PARAMS ((bfd_vma data, unsigned char *addr));
107void _do_putb32 PARAMS ((bfd_vma data, unsigned char *addr));
108void _do_putl32 PARAMS ((bfd_vma data, unsigned char *addr));
109void _do_putb16 PARAMS ((bfd_vma data, unsigned char *addr));
110void _do_putl16 PARAMS ((bfd_vma data, unsigned char *addr));
111
112boolean bfd_false PARAMS ((bfd *ignore));
113boolean bfd_true PARAMS ((bfd *ignore));
114PTR bfd_nullvoidptr PARAMS ((bfd *ignore));
115int bfd_0 PARAMS ((bfd *ignore));
116unsigned int bfd_0u PARAMS ((bfd *ignore));
117void bfd_void PARAMS ((bfd *ignore));
118
119bfd * new_bfd_contained_in PARAMS ((bfd *));
120boolean _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect));
121char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd));
122int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd));
123boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd,
4a81b561 124 bfd *exec_bfd));
287c221d 125bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4a81b561 126
287c221d 127void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 128 char *hdr));
287c221d 129void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 130 char *hdr));
287c221d 131void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
69ebee86 132 char *hdr));
4a81b561 133
287c221d 134boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 135 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 136
287c221d 137boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 138 struct orl *map, unsigned int orl_count, int stridx));
4a81b561 139
287c221d 140bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
2203f786 141 bfd *last_file));
4a81b561 142
287c221d 143int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
fc723380 144
287c221d
PB
145boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section,
146 PTR location, file_ptr offset,
147 bfd_size_type count));
01dd1b2b 148
287c221d
PB
149boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section,
150 PTR location, file_ptr offset,
151 bfd_size_type count));
2203f786 152
4a81b561
DHW
153/* Macros to tell if bfds are read or write enabled.
154
155 Note that bfds open for read may be scribbled into if the fd passed
156 to bfd_fdopenr is actually open both for read and write
157 simultaneously. However an output bfd will never be open for
158 read. Therefore sometimes you want to check bfd_read_p or
159 !bfd_read_p, and only sometimes bfd_write_p.
160*/
161
287c221d
PB
162#define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction)
163#define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction)
164
165void bfd_assert PARAMS ((char*,int));
4a81b561 166
4a81b561
DHW
167#define BFD_ASSERT(x) \
168{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
169
170#define BFD_FAIL() \
171{ bfd_assert(__FILE__,__LINE__); }
172
287c221d 173FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4a81b561
DHW
174
175extern bfd *bfd_last_cache;
4a81b561
DHW
176
177/* Now Steve, what's the story here? */
178#ifdef lint
179#define itos(x) "l"
180#define stoi(x) 1
181#else
182#define itos(x) ((char*)(x))
183#define stoi(x) ((int)(x))
184#endif
69ebee86
JG
185
186/* Generic routine for close_and_cleanup is really just bfd_true. */
187#define bfd_generic_close_and_cleanup bfd_true
6f715d66 188
b8d69097 189/* And more follows */
6f715d66 190
fefb4b30
JG
191void
192bfd_check_init PARAMS ((void));
193
194PTR
195bfd_xmalloc PARAMS (( bfd_size_type size));
196
197void
198bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
199
200bfd_vma
201bfd_log2 PARAMS ((bfd_vma x));
202
203void
204bfd_check_init PARAMS ((void));
205
206PTR
207bfd_xmalloc PARAMS (( bfd_size_type size));
208
209void
210bfd_write_bigendian_4byte_int PARAMS ((bfd *abfd, int i));
211
212bfd_vma
213bfd_log2 PARAMS ((bfd_vma x));
214
6f715d66 215#define BFD_CACHE_MAX_OPEN 10
6f715d66 216extern bfd *bfd_last_cache;
e98e6ec1 217
6f715d66 218#define bfd_cache_lookup(x) \
0cda46cf
SC
219 ((x)==bfd_last_cache? \
220 (FILE*)(bfd_last_cache->iostream): \
221 bfd_cache_lookup_worker(x))
fefb4b30
JG
222void
223bfd_cache_init PARAMS ((bfd *));
224
225boolean
226bfd_cache_close PARAMS ((bfd *));
227
228FILE*
229bfd_open_file PARAMS ((bfd *));
230
231FILE *
232bfd_cache_lookup_worker PARAMS ((bfd *));
233
234void
235bfd_constructor_entry PARAMS ((bfd *abfd,
e98e6ec1
SC
236 asymbol **symbol_ptr_ptr,
237 CONST char*type));
fefb4b30
JG
238
239CONST struct reloc_howto_struct *
240bfd_default_reloc_type_lookup
241 PARAMS ((CONST struct bfd_arch_info *,
3860075f 242 bfd_reloc_code_real_type code));
fefb4b30
JG
243
244boolean
245bfd_generic_relax_section
246 PARAMS ((bfd *abfd,
d58b7049 247 asection *section,
d5cd3c0e 248 asymbol **symbols));
fefb4b30 249
e98e6ec1 250bfd_byte *
fefb4b30 251
287c221d
PB
252bfd_generic_get_relocated_section_contents PARAMS ((bfd *abfd,
253 struct bfd_seclet *seclet,
254 bfd_byte *data));
fefb4b30 255
e98e6ec1 256extern bfd_arch_info_type bfd_default_arch_struct;
fefb4b30
JG
257boolean
258bfd_default_set_arch_mach PARAMS ((bfd *abfd,
e98e6ec1
SC
259 enum bfd_architecture arch,
260 unsigned long mach));
fefb4b30
JG
261
262void
263bfd_arch_init PARAMS ((void));
264
265void
266bfd_arch_linkin PARAMS ((bfd_arch_info_type *));
267
268CONST bfd_arch_info_type *
269bfd_default_compatible
270 PARAMS ((CONST bfd_arch_info_type *a,
e98e6ec1 271 CONST bfd_arch_info_type *b));
fefb4b30
JG
272
273boolean
274bfd_default_scan PARAMS ((CONST struct bfd_arch_info *, CONST char *));
275
1a917f54 276Elf_Internal_Shdr *
fefb4b30
JG
277bfd_elf_find_section PARAMS ((bfd *abfd, char *name));
278
This page took 0.078433 seconds and 4 git commands to generate.