* libbfd-in.h (struct artdata): Added tdata field.
[deliverable/binutils-gdb.git] / bfd / libbfd-in.h
CommitLineData
4e6f9223
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.
4e6f9223
SC
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
4c3721d5
ILT
22/* Use builtin alloca for gcc. */
23#ifdef __GNUC__
24#ifndef alloca
25#define alloca __builtin_alloca
26#endif
27#endif
4e6f9223 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. */
8c4a1ace 31#define BFD_ALIGN(this, boundary) \
01dd1b2b
SC
32 ((( (this) + ((boundary) -1)) & (~((boundary)-1))))
33
4e6f9223
SC
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
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. */
14e3c2e4 40#define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v))
4e6f9223
SC
41
42/* tdata for an archive. For an input archive, cache
43 needs to be free()'d. For an output archive, symdefs do. */
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 */
4c3721d5
ILT
53 /* when more compilers are standard C, this can be a time_t */
54 long armap_timestamp; /* Timestamp value written into armap.
a6f5fcd8
SC
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. */
4e6f9223
SC
63};
64
14e3c2e4 65#define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data)
4e6f9223
SC
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
14e3c2e4 76char *zalloc PARAMS ((bfd_size_type size));
4e6f9223
SC
77
78/* These routines allocate and free things on the BFD's obstack. Note
79 that realloc can never occur in place. */
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));
14e3c2e4
JK
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
4c3721d5
ILT
99int bfd_flush PARAMS ((bfd *abfd));
100int bfd_stat PARAMS ((bfd *abfd, struct stat *));
101
14e3c2e4
JK
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 *));
14e3c2e4 105boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd));
b59f0276 106struct areltdata * _bfd_snarf_ar_hdr PARAMS ((bfd *abfd));
14e3c2e4
JK
107bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd));
108boolean bfd_slurp_armap PARAMS ((bfd *abfd));
6affd66a 109boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd));
14e3c2e4
JK
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));
4e6f9223
SC
115
116#define DEFAULT_STRING_SPACE_SIZE 0x2000
14e3c2e4
JK
117boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string,
118 unsigned int *table_length,
119 char **free_ptr));
6affd66a 120
14e3c2e4
JK
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,
4e6f9223 133 bfd *exec_bfd));
14e3c2e4 134bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd));
4e6f9223 135
14e3c2e4 136void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
4e6f9223 137 char *hdr));
14e3c2e4 138void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
4e6f9223 139 char *hdr));
14e3c2e4 140void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename,
4e6f9223
SC
141 char *hdr));
142
14e3c2e4 143boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 144 struct orl *map, unsigned int orl_count, int stridx));
4e6f9223 145
14e3c2e4 146boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength,
01dd1b2b 147 struct orl *map, unsigned int orl_count, int stridx));
4e6f9223 148
14e3c2e4 149bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive,
4e6f9223
SC
150 bfd *last_file));
151
14e3c2e4 152int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *));
4e6f9223 153
14e3c2e4
JK
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
14e3c2e4
JK
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
4e6f9223
SC
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
14e3c2e4
JK
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));
4e6f9223 228
4e6f9223
SC
229#define BFD_ASSERT(x) \
230{ if (!(x)) bfd_assert(__FILE__,__LINE__); }
231
232#define BFD_FAIL() \
233{ bfd_assert(__FILE__,__LINE__); }
234
14e3c2e4 235FILE * bfd_cache_lookup_worker PARAMS ((bfd *));
4e6f9223
SC
236
237extern bfd *bfd_last_cache;
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
247
248/* Generic routine for close_and_cleanup is really just bfd_true. */
249#define bfd_generic_close_and_cleanup bfd_true
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
14e3c2e4 256/* And more follows */
4e6f9223 257
This page took 0.09635 seconds and 4 git commands to generate.