Commit | Line | Data |
---|---|---|
252b5132 | 1 | /* Generic BFD support for file formats. |
ed781d5d | 2 | Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000, 2001, 2002, 2003 |
7898deda | 3 | Free Software Foundation, Inc. |
252b5132 RH |
4 | Written by Cygnus Support. |
5 | ||
ed781d5d | 6 | This file is part of BFD, the Binary File Descriptor library. |
252b5132 | 7 | |
ed781d5d NC |
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. | |
252b5132 | 12 | |
ed781d5d NC |
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. | |
252b5132 | 17 | |
ed781d5d NC |
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ | |
252b5132 RH |
21 | |
22 | /* | |
23 | SECTION | |
24 | File formats | |
25 | ||
26 | A format is a BFD concept of high level file contents type. The | |
3fde5a36 | 27 | formats supported by BFD are: |
252b5132 RH |
28 | |
29 | o <<bfd_object>> | |
30 | ||
31 | The BFD may contain data, symbols, relocations and debug info. | |
32 | ||
33 | o <<bfd_archive>> | |
34 | ||
35 | The BFD contains other BFDs and an optional index. | |
36 | ||
37 | o <<bfd_core>> | |
38 | ||
39 | The BFD contains the result of an executable core dump. | |
40 | ||
252b5132 RH |
41 | */ |
42 | ||
43 | #include "bfd.h" | |
44 | #include "sysdep.h" | |
45 | #include "libbfd.h" | |
46 | ||
47 | /* IMPORT from targets.c. */ | |
48 | extern const size_t _bfd_target_vector_entries; | |
49 | ||
50 | /* | |
51 | FUNCTION | |
52 | bfd_check_format | |
53 | ||
54 | SYNOPSIS | |
ed781d5d | 55 | bfd_boolean bfd_check_format (bfd *abfd, bfd_format format); |
252b5132 RH |
56 | |
57 | DESCRIPTION | |
58 | Verify if the file attached to the BFD @var{abfd} is compatible | |
59 | with the format @var{format} (i.e., one of <<bfd_object>>, | |
60 | <<bfd_archive>> or <<bfd_core>>). | |
61 | ||
62 | If the BFD has been set to a specific target before the | |
63 | call, only the named target and format combination is | |
64 | checked. If the target has not been set, or has been set to | |
65 | <<default>>, then all the known target backends is | |
66 | interrogated to determine a match. If the default target | |
67 | matches, it is used. If not, exactly one target must recognize | |
68 | the file, or an error results. | |
69 | ||
b34976b6 | 70 | The function returns <<TRUE>> on success, otherwise <<FALSE>> |
3fde5a36 | 71 | with one of the following error codes: |
252b5132 RH |
72 | |
73 | o <<bfd_error_invalid_operation>> - | |
74 | if <<format>> is not one of <<bfd_object>>, <<bfd_archive>> or | |
75 | <<bfd_core>>. | |
76 | ||
77 | o <<bfd_error_system_call>> - | |
78 | if an error occured during a read - even some file mismatches | |
79 | can cause bfd_error_system_calls. | |
80 | ||
81 | o <<file_not_recognised>> - | |
82 | none of the backends recognised the file format. | |
83 | ||
84 | o <<bfd_error_file_ambiguously_recognized>> - | |
85 | more than one backend recognised the file format. | |
86 | */ | |
87 | ||
b34976b6 | 88 | bfd_boolean |
252b5132 RH |
89 | bfd_check_format (abfd, format) |
90 | bfd *abfd; | |
91 | bfd_format format; | |
92 | { | |
93 | return bfd_check_format_matches (abfd, format, NULL); | |
94 | } | |
95 | ||
96 | /* | |
97 | FUNCTION | |
98 | bfd_check_format_matches | |
99 | ||
100 | SYNOPSIS | |
ed781d5d NC |
101 | bfd_boolean bfd_check_format_matches (bfd *abfd, bfd_format format, |
102 | char ***matching); | |
252b5132 RH |
103 | |
104 | DESCRIPTION | |
b34976b6 | 105 | Like <<bfd_check_format>>, except when it returns FALSE with |
252b5132 RH |
106 | <<bfd_errno>> set to <<bfd_error_file_ambiguously_recognized>>. In that |
107 | case, if @var{matching} is not NULL, it will be filled in with | |
108 | a NULL-terminated list of the names of the formats that matched, | |
109 | allocated with <<malloc>>. | |
110 | Then the user may choose a format and try again. | |
111 | ||
112 | When done with the list that @var{matching} points to, the caller | |
3fde5a36 | 113 | should free it. |
252b5132 RH |
114 | */ |
115 | ||
b34976b6 | 116 | bfd_boolean |
252b5132 RH |
117 | bfd_check_format_matches (abfd, format, matching) |
118 | bfd *abfd; | |
119 | bfd_format format; | |
120 | char ***matching; | |
121 | { | |
122 | extern const bfd_target binary_vec; | |
08f74004 AM |
123 | const bfd_target * const *target; |
124 | const bfd_target **matching_vector = NULL; | |
125 | const bfd_target *save_targ, *right_targ, *ar_right_targ; | |
252b5132 | 126 | int match_count; |
3619ad04 | 127 | int ar_match_index; |
252b5132 | 128 | |
3619ad04 | 129 | if (!bfd_read_p (abfd) |
cea4409c | 130 | || (unsigned int) abfd->format >= (unsigned int) bfd_type_end) |
1d713d9e NC |
131 | { |
132 | bfd_set_error (bfd_error_invalid_operation); | |
b34976b6 | 133 | return FALSE; |
1d713d9e | 134 | } |
252b5132 RH |
135 | |
136 | if (abfd->format != bfd_unknown) | |
b34976b6 | 137 | return abfd->format == format; |
252b5132 | 138 | |
3fde5a36 | 139 | /* Since the target type was defaulted, check them |
252b5132 | 140 | all in the hope that one will be uniquely recognized. */ |
252b5132 RH |
141 | save_targ = abfd->xvec; |
142 | match_count = 0; | |
3619ad04 | 143 | ar_match_index = _bfd_target_vector_entries; |
3fde5a36 | 144 | |
252b5132 RH |
145 | if (matching) |
146 | { | |
dc810e39 AM |
147 | bfd_size_type amt; |
148 | ||
3619ad04 | 149 | *matching = NULL; |
08f74004 AM |
150 | amt = sizeof (*matching_vector) * 2 * _bfd_target_vector_entries; |
151 | matching_vector = (const bfd_target **) bfd_malloc (amt); | |
252b5132 | 152 | if (!matching_vector) |
b34976b6 | 153 | return FALSE; |
252b5132 | 154 | } |
3fde5a36 | 155 | |
252b5132 | 156 | right_targ = 0; |
3619ad04 | 157 | ar_right_targ = 0; |
252b5132 | 158 | |
1d713d9e | 159 | /* Presume the answer is yes. */ |
252b5132 RH |
160 | abfd->format = format; |
161 | ||
162 | /* If the target type was explicitly specified, just check that target. */ | |
1d713d9e NC |
163 | if (!abfd->target_defaulted) |
164 | { | |
dc810e39 | 165 | if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0) /* rewind! */ |
5ed6aba4 NC |
166 | { |
167 | if (matching) | |
168 | free ((PTR) matching_vector); | |
169 | return FALSE; | |
170 | } | |
3fde5a36 | 171 | |
1d713d9e | 172 | right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd)); |
3fde5a36 | 173 | |
1d713d9e | 174 | if (right_targ) |
252b5132 | 175 | { |
1d713d9e | 176 | abfd->xvec = right_targ; /* Set the target as returned. */ |
3fde5a36 | 177 | |
1d713d9e | 178 | if (matching) |
08f74004 | 179 | free ((PTR) matching_vector); |
3fde5a36 | 180 | |
b34976b6 | 181 | return TRUE; /* File position has moved, BTW. */ |
252b5132 | 182 | } |
1d713d9e NC |
183 | |
184 | /* For a long time the code has dropped through to check all | |
185 | targets if the specified target was wrong. I don't know why, | |
186 | and I'm reluctant to change it. However, in the case of an | |
187 | archive, it can cause problems. If the specified target does | |
188 | not permit archives (e.g., the binary target), then we should | |
189 | not allow some other target to recognize it as an archive, but | |
190 | should instead allow the specified target to recognize it as an | |
191 | object. When I first made this change, it broke the PE target, | |
192 | because the specified pei-i386 target did not recognize the | |
193 | actual pe-i386 archive. Since there may be other problems of | |
194 | this sort, I changed this test to check only for the binary | |
195 | target. */ | |
196 | if (format == bfd_archive && save_targ == &binary_vec) | |
252b5132 | 197 | { |
1d713d9e NC |
198 | abfd->xvec = save_targ; |
199 | abfd->format = bfd_unknown; | |
3fde5a36 | 200 | |
1d713d9e | 201 | if (matching) |
08f74004 | 202 | free ((PTR) matching_vector); |
3fde5a36 | 203 | |
1d713d9e | 204 | bfd_set_error (bfd_error_file_not_recognized); |
3fde5a36 | 205 | |
b34976b6 | 206 | return FALSE; |
1d713d9e NC |
207 | } |
208 | } | |
209 | ||
210 | for (target = bfd_target_vector; *target != NULL; target++) | |
211 | { | |
212 | const bfd_target *temp; | |
3619ad04 | 213 | bfd_error_type err; |
3fde5a36 | 214 | |
1d713d9e NC |
215 | if (*target == &binary_vec) |
216 | continue; | |
3fde5a36 | 217 | |
ed781d5d | 218 | abfd->xvec = *target; /* Change BFD's target temporarily. */ |
3fde5a36 | 219 | |
dc810e39 | 220 | if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0) |
5ed6aba4 NC |
221 | { |
222 | if (matching) | |
223 | free ((PTR) matching_vector); | |
224 | return FALSE; | |
225 | } | |
3fde5a36 | 226 | |
1d713d9e NC |
227 | /* If _bfd_check_format neglects to set bfd_error, assume |
228 | bfd_error_wrong_format. We didn't used to even pay any | |
229 | attention to bfd_error, so I suspect that some | |
230 | _bfd_check_format might have this problem. */ | |
231 | bfd_set_error (bfd_error_wrong_format); | |
232 | ||
233 | temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd)); | |
3fde5a36 | 234 | |
1d713d9e | 235 | if (temp) |
ed781d5d NC |
236 | { |
237 | /* This format checks out as ok! */ | |
1d713d9e | 238 | right_targ = temp; |
3fde5a36 | 239 | |
1d713d9e NC |
240 | /* If this is the default target, accept it, even if other |
241 | targets might match. People who want those other targets | |
242 | have to set the GNUTARGET variable. */ | |
243 | if (temp == bfd_default_vector[0]) | |
244 | { | |
1d713d9e NC |
245 | match_count = 1; |
246 | break; | |
252b5132 | 247 | } |
3619ad04 AM |
248 | |
249 | if (matching) | |
08f74004 | 250 | matching_vector[match_count] = temp; |
3619ad04 AM |
251 | |
252 | match_count++; | |
253 | ||
252b5132 | 254 | #ifdef GNU960 |
1d713d9e NC |
255 | /* Big- and little-endian b.out archives look the same, but it |
256 | doesn't matter: there is no difference in their headers, and | |
257 | member file byte orders will (I hope) be handled appropriately | |
258 | by bfd. Ditto for big and little coff archives. And the 4 | |
259 | coff/b.out object formats are unambiguous. So accept the | |
260 | first match we find. */ | |
261 | break; | |
252b5132 | 262 | #endif |
1d713d9e | 263 | } |
3619ad04 AM |
264 | else if ((err = bfd_get_error ()) == bfd_error_wrong_object_format |
265 | || err == bfd_error_file_ambiguously_recognized) | |
266 | { | |
267 | /* An archive with objects of the wrong type, or an | |
268 | ambiguous match. We want this target to match if we get | |
269 | no better matches. */ | |
270 | if (ar_right_targ != bfd_default_vector[0]) | |
271 | ar_right_targ = *target; | |
272 | if (matching) | |
08f74004 | 273 | matching_vector[ar_match_index] = *target; |
3619ad04 AM |
274 | ar_match_index++; |
275 | } | |
276 | else if (err != bfd_error_wrong_format) | |
1d713d9e NC |
277 | { |
278 | abfd->xvec = save_targ; | |
279 | abfd->format = bfd_unknown; | |
3fde5a36 | 280 | |
3619ad04 | 281 | if (matching) |
08f74004 | 282 | free ((PTR) matching_vector); |
3fde5a36 | 283 | |
b34976b6 | 284 | return FALSE; |
1d713d9e NC |
285 | } |
286 | } | |
3fde5a36 | 287 | |
3619ad04 AM |
288 | if (match_count == 0) |
289 | { | |
290 | /* Try partial matches. */ | |
291 | right_targ = ar_right_targ; | |
ed781d5d | 292 | |
3619ad04 AM |
293 | if (right_targ == bfd_default_vector[0]) |
294 | { | |
295 | match_count = 1; | |
296 | } | |
297 | else | |
298 | { | |
299 | match_count = ar_match_index - _bfd_target_vector_entries; | |
ed781d5d | 300 | |
3619ad04 | 301 | if (matching && match_count > 1) |
ed781d5d NC |
302 | memcpy (matching_vector, |
303 | matching_vector + _bfd_target_vector_entries, | |
304 | sizeof (*matching_vector) * match_count); | |
08f74004 AM |
305 | } |
306 | } | |
307 | ||
4081944f NC |
308 | if (match_count > 1 |
309 | && bfd_associated_vector != NULL | |
310 | && matching) | |
08f74004 AM |
311 | { |
312 | const bfd_target * const *assoc = bfd_associated_vector; | |
313 | ||
314 | while ((right_targ = *assoc++) != NULL) | |
315 | { | |
316 | int i = match_count; | |
317 | ||
318 | while (--i >= 0) | |
319 | if (matching_vector[i] == right_targ) | |
320 | break; | |
321 | ||
322 | if (i >= 0) | |
323 | { | |
324 | match_count = 1; | |
325 | break; | |
3619ad04 AM |
326 | } |
327 | } | |
328 | } | |
329 | ||
1d713d9e NC |
330 | if (match_count == 1) |
331 | { | |
332 | abfd->xvec = right_targ; /* Change BFD's target permanently. */ | |
3fde5a36 | 333 | |
1d713d9e | 334 | if (matching) |
08f74004 | 335 | free ((PTR) matching_vector); |
3fde5a36 | 336 | |
b34976b6 | 337 | return TRUE; /* File position has moved, BTW. */ |
252b5132 | 338 | } |
252b5132 | 339 | |
1d713d9e NC |
340 | abfd->xvec = save_targ; /* Restore original target type. */ |
341 | abfd->format = bfd_unknown; /* Restore original format. */ | |
3fde5a36 | 342 | |
252b5132 RH |
343 | if (match_count == 0) |
344 | { | |
345 | bfd_set_error (bfd_error_file_not_recognized); | |
3fde5a36 | 346 | |
252b5132 | 347 | if (matching) |
08f74004 | 348 | free ((PTR) matching_vector); |
252b5132 RH |
349 | } |
350 | else | |
3619ad04 AM |
351 | { |
352 | bfd_set_error (bfd_error_file_ambiguously_recognized); | |
353 | ||
354 | if (matching) | |
355 | { | |
08f74004 | 356 | *matching = (char **) matching_vector; |
3619ad04 | 357 | matching_vector[match_count] = NULL; |
08f74004 AM |
358 | /* Return target names. This is a little nasty. Maybe we |
359 | should do another bfd_malloc? */ | |
360 | while (--match_count >= 0) | |
361 | { | |
362 | const char *name = matching_vector[match_count]->name; | |
363 | *(const char **) &matching_vector[match_count] = name; | |
364 | } | |
3619ad04 AM |
365 | } |
366 | } | |
3fde5a36 | 367 | |
b34976b6 | 368 | return FALSE; |
252b5132 RH |
369 | } |
370 | ||
371 | /* | |
372 | FUNCTION | |
373 | bfd_set_format | |
374 | ||
375 | SYNOPSIS | |
ed781d5d | 376 | bfd_boolean bfd_set_format (bfd *abfd, bfd_format format); |
252b5132 RH |
377 | |
378 | DESCRIPTION | |
379 | This function sets the file format of the BFD @var{abfd} to the | |
380 | format @var{format}. If the target set in the BFD does not | |
381 | support the format requested, the format is invalid, or the BFD | |
382 | is not open for writing, then an error occurs. | |
252b5132 RH |
383 | */ |
384 | ||
b34976b6 | 385 | bfd_boolean |
252b5132 RH |
386 | bfd_set_format (abfd, format) |
387 | bfd *abfd; | |
388 | bfd_format format; | |
389 | { | |
3619ad04 | 390 | if (bfd_read_p (abfd) |
cea4409c | 391 | || (unsigned int) abfd->format >= (unsigned int) bfd_type_end) |
1d713d9e NC |
392 | { |
393 | bfd_set_error (bfd_error_invalid_operation); | |
b34976b6 | 394 | return FALSE; |
1d713d9e | 395 | } |
252b5132 RH |
396 | |
397 | if (abfd->format != bfd_unknown) | |
b34976b6 | 398 | return abfd->format == format; |
252b5132 | 399 | |
1d713d9e | 400 | /* Presume the answer is yes. */ |
252b5132 RH |
401 | abfd->format = format; |
402 | ||
1d713d9e NC |
403 | if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd))) |
404 | { | |
405 | abfd->format = bfd_unknown; | |
b34976b6 | 406 | return FALSE; |
1d713d9e | 407 | } |
252b5132 | 408 | |
b34976b6 | 409 | return TRUE; |
252b5132 RH |
410 | } |
411 | ||
252b5132 RH |
412 | /* |
413 | FUNCTION | |
414 | bfd_format_string | |
415 | ||
416 | SYNOPSIS | |
ed781d5d | 417 | const char *bfd_format_string (bfd_format format); |
252b5132 RH |
418 | |
419 | DESCRIPTION | |
420 | Return a pointer to a const string | |
421 | <<invalid>>, <<object>>, <<archive>>, <<core>>, or <<unknown>>, | |
422 | depending upon the value of @var{format}. | |
423 | */ | |
424 | ||
3619ad04 | 425 | const char * |
252b5132 RH |
426 | bfd_format_string (format) |
427 | bfd_format format; | |
428 | { | |
3fde5a36 KH |
429 | if (((int)format <(int) bfd_unknown) |
430 | || ((int)format >=(int) bfd_type_end)) | |
252b5132 | 431 | return "invalid"; |
3fde5a36 | 432 | |
1d713d9e NC |
433 | switch (format) |
434 | { | |
435 | case bfd_object: | |
436 | return "object"; /* Linker/assember/compiler output. */ | |
3fde5a36 | 437 | case bfd_archive: |
1d713d9e | 438 | return "archive"; /* Object archive file. */ |
3fde5a36 | 439 | case bfd_core: |
1d713d9e | 440 | return "core"; /* Core dump. */ |
3fde5a36 | 441 | default: |
1d713d9e NC |
442 | return "unknown"; |
443 | } | |
252b5132 | 444 | } |