Commit | Line | Data |
---|---|---|
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 | ||
6 | This file is part of BFD, the Binary File Descriptor library. | |
7 | ||
8 | This program is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 2 of the License, or | |
11 | (at your option) any later version. | |
12 | ||
13 | This program is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with this program; if not, write to the Free Software | |
20 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
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. */ | |
8c4a1ace | 24 | #define BFD_ALIGN(this, boundary) \ |
01dd1b2b SC |
25 | ((( (this) + ((boundary) -1)) & (~((boundary)-1)))) |
26 | ||
4e6f9223 SC |
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 | ||
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. */ | |
14e3c2e4 | 33 | #define set_tdata(bfd, v) ((bfd)->tdata.any = (PTR) (v)) |
4e6f9223 SC |
34 | |
35 | /* tdata for an archive. For an input archive, cache | |
36 | needs to be free()'d. For an output archive, symdefs do. */ | |
37 | ||
38 | struct 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 */ | |
4c3721d5 ILT |
46 | /* when more compilers are standard C, this can be a time_t */ |
47 | long armap_timestamp; /* Timestamp value written into armap. | |
a6f5fcd8 SC |
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. */ |
4e6f9223 SC |
56 | }; |
57 | ||
14e3c2e4 | 58 | #define bfd_ardata(bfd) ((bfd)->tdata.aout_ar_data) |
4e6f9223 SC |
59 | |
60 | /* Goes in bfd's arelt_data slot */ | |
61 | struct 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 | 69 | char *bfd_zmalloc PARAMS ((bfd_size_type size)); |
4e6f9223 SC |
70 | |
71 | /* These routines allocate and free things on the BFD's obstack. Note | |
72 | that realloc can never occur in place. */ | |
73 | ||
6affd66a KR |
74 | PTR bfd_alloc PARAMS ((bfd *abfd, size_t size)); |
75 | PTR bfd_zalloc PARAMS ((bfd *abfd, size_t size)); | |
76 | PTR bfd_realloc PARAMS ((bfd *abfd, PTR orig, size_t new)); | |
77 | void bfd_alloc_grow PARAMS ((bfd *abfd, PTR thing, size_t size)); | |
14e3c2e4 JK |
78 | PTR bfd_alloc_finish PARAMS ((bfd *abfd)); |
79 | PTR 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 | ||
84 | bfd_size_type bfd_read PARAMS ((PTR ptr, bfd_size_type size, | |
85 | bfd_size_type nitems, bfd *abfd)); | |
86 | bfd_size_type bfd_write PARAMS ((CONST PTR ptr, bfd_size_type size, | |
87 | bfd_size_type nitems, bfd *abfd)); | |
88 | int bfd_seek PARAMS ((bfd* CONST abfd, CONST file_ptr fp, | |
89 | CONST int direction)); | |
90 | long bfd_tell PARAMS ((bfd *abfd)); | |
91 | ||
4c3721d5 ILT |
92 | int bfd_flush PARAMS ((bfd *abfd)); |
93 | int bfd_stat PARAMS ((bfd *abfd, struct stat *)); | |
94 | ||
14e3c2e4 | 95 | bfd * _bfd_create_empty_archive_element_shell PARAMS ((bfd *obfd)); |
f4bd7a8f | 96 | bfd * _bfd_look_for_bfd_in_cache PARAMS ((bfd *arch_bfd, file_ptr index)); |
b59f0276 | 97 | boolean _bfd_add_bfd_to_archive_cache PARAMS ((bfd *, file_ptr, bfd *)); |
14e3c2e4 | 98 | boolean _bfd_generic_mkarchive PARAMS ((bfd *abfd)); |
b59f0276 | 99 | struct areltdata * _bfd_snarf_ar_hdr PARAMS ((bfd *abfd)); |
14e3c2e4 JK |
100 | bfd_target * bfd_generic_archive_p PARAMS ((bfd *abfd)); |
101 | boolean bfd_slurp_armap PARAMS ((bfd *abfd)); | |
6affd66a | 102 | boolean bfd_slurp_bsd_armap_f2 PARAMS ((bfd *abfd)); |
14e3c2e4 JK |
103 | #define bfd_slurp_bsd_armap bfd_slurp_armap |
104 | #define bfd_slurp_coff_armap bfd_slurp_armap | |
105 | boolean _bfd_slurp_extended_name_table PARAMS ((bfd *abfd)); | |
106 | boolean _bfd_write_archive_contents PARAMS ((bfd *abfd)); | |
f4bd7a8f DM |
107 | bfd *_bfd_get_elt_at_filepos PARAMS ((bfd *archive, file_ptr filepos)); |
108 | bfd * _bfd_new_bfd PARAMS ((void)); | |
4e6f9223 SC |
109 | |
110 | #define DEFAULT_STRING_SPACE_SIZE 0x2000 | |
14e3c2e4 JK |
111 | boolean bfd_add_to_string_table PARAMS ((char **table, char *new_string, |
112 | unsigned int *table_length, | |
113 | char **free_ptr)); | |
6affd66a | 114 | |
14e3c2e4 JK |
115 | boolean bfd_false PARAMS ((bfd *ignore)); |
116 | boolean bfd_true PARAMS ((bfd *ignore)); | |
117 | PTR bfd_nullvoidptr PARAMS ((bfd *ignore)); | |
118 | int bfd_0 PARAMS ((bfd *ignore)); | |
119 | unsigned int bfd_0u PARAMS ((bfd *ignore)); | |
326e32d7 | 120 | long bfd_0l PARAMS ((bfd *ignore)); |
14e3c2e4 JK |
121 | void bfd_void PARAMS ((bfd *ignore)); |
122 | ||
f4bd7a8f | 123 | bfd * _bfd_new_bfd_contained_in PARAMS ((bfd *)); |
14e3c2e4 JK |
124 | boolean _bfd_dummy_new_section_hook PARAMS ((bfd *ignore, asection *newsect)); |
125 | char * _bfd_dummy_core_file_failing_command PARAMS ((bfd *abfd)); | |
126 | int _bfd_dummy_core_file_failing_signal PARAMS ((bfd *abfd)); | |
127 | boolean _bfd_dummy_core_file_matches_executable_p PARAMS ((bfd *core_bfd, | |
4e6f9223 | 128 | bfd *exec_bfd)); |
14e3c2e4 | 129 | bfd_target * _bfd_dummy_target PARAMS ((bfd *abfd)); |
4e6f9223 | 130 | |
14e3c2e4 | 131 | void bfd_dont_truncate_arname PARAMS ((bfd *abfd, CONST char *filename, |
4e6f9223 | 132 | char *hdr)); |
14e3c2e4 | 133 | void bfd_bsd_truncate_arname PARAMS ((bfd *abfd, CONST char *filename, |
4e6f9223 | 134 | char *hdr)); |
14e3c2e4 | 135 | void bfd_gnu_truncate_arname PARAMS ((bfd *abfd, CONST char *filename, |
4e6f9223 SC |
136 | char *hdr)); |
137 | ||
14e3c2e4 | 138 | boolean bsd_write_armap PARAMS ((bfd *arch, unsigned int elength, |
01dd1b2b | 139 | struct orl *map, unsigned int orl_count, int stridx)); |
4e6f9223 | 140 | |
14e3c2e4 | 141 | boolean coff_write_armap PARAMS ((bfd *arch, unsigned int elength, |
01dd1b2b | 142 | struct orl *map, unsigned int orl_count, int stridx)); |
4e6f9223 | 143 | |
14e3c2e4 | 144 | bfd * bfd_generic_openr_next_archived_file PARAMS ((bfd *archive, |
4e6f9223 SC |
145 | bfd *last_file)); |
146 | ||
14e3c2e4 | 147 | int bfd_generic_stat_arch_elt PARAMS ((bfd *, struct stat *)); |
4e6f9223 | 148 | |
14e3c2e4 JK |
149 | boolean bfd_generic_get_section_contents PARAMS ((bfd *abfd, sec_ptr section, |
150 | PTR location, file_ptr offset, | |
151 | bfd_size_type count)); | |
01dd1b2b | 152 | |
14e3c2e4 JK |
153 | boolean bfd_generic_set_section_contents PARAMS ((bfd *abfd, sec_ptr section, |
154 | PTR location, file_ptr offset, | |
155 | bfd_size_type count)); | |
4c3721d5 | 156 | \f |
f1cca647 ILT |
157 | /* Generic routine to determine of the given symbol is a local |
158 | label. */ | |
159 | extern boolean bfd_generic_is_local_label PARAMS ((bfd *, asymbol *)); | |
160 | ||
4c3721d5 ILT |
161 | /* A routine to create entries for a bfd_link_hash_table. */ |
162 | extern struct bfd_hash_entry *_bfd_link_hash_newfunc | |
163 | PARAMS ((struct bfd_hash_entry *entry, | |
164 | struct bfd_hash_table *table, | |
165 | const char *string)); | |
166 | ||
167 | /* Initialize a bfd_link_hash_table. */ | |
168 | extern boolean _bfd_link_hash_table_init | |
169 | PARAMS ((struct bfd_link_hash_table *, bfd *, | |
170 | struct bfd_hash_entry *(*) (struct bfd_hash_entry *, | |
171 | struct bfd_hash_table *, | |
172 | const char *))); | |
173 | ||
174 | /* Generic link hash table creation routine. */ | |
175 | extern struct bfd_link_hash_table *_bfd_generic_link_hash_table_create | |
176 | PARAMS ((bfd *)); | |
177 | ||
178 | /* Generic add symbol routine. */ | |
179 | extern boolean _bfd_generic_link_add_symbols | |
180 | PARAMS ((bfd *, struct bfd_link_info *)); | |
181 | ||
326e32d7 ILT |
182 | /* Generic add symbol routine. This version is used by targets for |
183 | which the linker must collect constructors and destructors by name, | |
184 | as the collect2 program does. */ | |
185 | extern boolean _bfd_generic_link_add_symbols_collect | |
186 | PARAMS ((bfd *, struct bfd_link_info *)); | |
187 | ||
4c3721d5 ILT |
188 | /* Generic archive add symbol routine. */ |
189 | extern boolean _bfd_generic_link_add_archive_symbols | |
190 | PARAMS ((bfd *, struct bfd_link_info *, | |
191 | boolean (*checkfn) (bfd *, struct bfd_link_info *, boolean *))); | |
192 | ||
193 | /* Forward declaration to avoid prototype errors. */ | |
194 | typedef struct bfd_link_hash_entry _bfd_link_hash_entry; | |
195 | ||
196 | /* Generic routine to add a single symbol. */ | |
197 | extern boolean _bfd_generic_link_add_one_symbol | |
198 | PARAMS ((struct bfd_link_info *, bfd *, const char *name, flagword, | |
199 | asection *, bfd_vma, const char *, boolean copy, | |
f1cca647 | 200 | boolean constructor, struct bfd_link_hash_entry **)); |
4c3721d5 ILT |
201 | |
202 | /* Generic link routine. */ | |
203 | extern boolean _bfd_generic_final_link | |
204 | PARAMS ((bfd *, struct bfd_link_info *)); | |
205 | ||
f1cca647 ILT |
206 | /* Generic reloc_link_order processing routine. */ |
207 | extern boolean _bfd_generic_reloc_link_order | |
208 | PARAMS ((bfd *, struct bfd_link_info *, asection *, | |
209 | struct bfd_link_order *)); | |
210 | ||
4c3721d5 ILT |
211 | /* Default link order processing routine. */ |
212 | extern boolean _bfd_default_link_order | |
213 | PARAMS ((bfd *, struct bfd_link_info *, asection *, | |
214 | struct bfd_link_order *)); | |
215 | ||
f1cca647 ILT |
216 | /* Count the number of reloc entries in a link order list. */ |
217 | extern unsigned int _bfd_count_link_order_relocs | |
218 | PARAMS ((struct bfd_link_order *)); | |
219 | ||
4c3721d5 ILT |
220 | /* Final link relocation routine. */ |
221 | extern bfd_reloc_status_type _bfd_final_link_relocate | |
222 | PARAMS ((const reloc_howto_type *, bfd *, asection *, bfd_byte *, | |
223 | bfd_vma address, bfd_vma value, bfd_vma addend)); | |
224 | ||
225 | /* Relocate a particular location by a howto and a value. */ | |
226 | extern bfd_reloc_status_type _bfd_relocate_contents | |
227 | PARAMS ((const reloc_howto_type *, bfd *, bfd_vma, bfd_byte *)); | |
228 | \f | |
4e6f9223 SC |
229 | /* Macros to tell if bfds are read or write enabled. |
230 | ||
231 | Note that bfds open for read may be scribbled into if the fd passed | |
232 | to bfd_fdopenr is actually open both for read and write | |
233 | simultaneously. However an output bfd will never be open for | |
234 | read. Therefore sometimes you want to check bfd_read_p or | |
235 | !bfd_read_p, and only sometimes bfd_write_p. | |
236 | */ | |
237 | ||
14e3c2e4 JK |
238 | #define bfd_read_p(abfd) ((abfd)->direction == read_direction || (abfd)->direction == both_direction) |
239 | #define bfd_write_p(abfd) ((abfd)->direction == write_direction || (abfd)->direction == both_direction) | |
240 | ||
241 | void bfd_assert PARAMS ((char*,int)); | |
4e6f9223 | 242 | |
4e6f9223 SC |
243 | #define BFD_ASSERT(x) \ |
244 | { if (!(x)) bfd_assert(__FILE__,__LINE__); } | |
245 | ||
246 | #define BFD_FAIL() \ | |
247 | { bfd_assert(__FILE__,__LINE__); } | |
248 | ||
14e3c2e4 | 249 | FILE * bfd_cache_lookup_worker PARAMS ((bfd *)); |
4e6f9223 SC |
250 | |
251 | extern bfd *bfd_last_cache; | |
252 | ||
253 | /* Now Steve, what's the story here? */ | |
254 | #ifdef lint | |
255 | #define itos(x) "l" | |
256 | #define stoi(x) 1 | |
257 | #else | |
258 | #define itos(x) ((char*)(x)) | |
259 | #define stoi(x) ((int)(x)) | |
260 | #endif | |
261 | ||
262 | /* Generic routine for close_and_cleanup is really just bfd_true. */ | |
263 | #define bfd_generic_close_and_cleanup bfd_true | |
264 | ||
4c3721d5 | 265 | /* List of supported target vectors, and the default vector (if |
f4bd7a8f DM |
266 | bfd_default_vector[0] is NULL, there is no default). */ |
267 | extern bfd_target *bfd_target_vector[]; | |
268 | extern bfd_target *bfd_default_vector[]; | |
4c3721d5 | 269 | |
14e3c2e4 | 270 | /* And more follows */ |
4e6f9223 | 271 |