Commit | Line | Data |
---|---|---|
252b5132 | 1 | /* Generic BFD support for file formats. |
9553c638 AM |
2 | Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000, 2001, 2002, |
3 | 2003, 2005 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 | |
3e110533 | 20 | Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, 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 |
c58b9523 | 89 | bfd_check_format (bfd *abfd, bfd_format format) |
252b5132 RH |
90 | { |
91 | return bfd_check_format_matches (abfd, format, NULL); | |
92 | } | |
93 | ||
94 | /* | |
95 | FUNCTION | |
96 | bfd_check_format_matches | |
97 | ||
98 | SYNOPSIS | |
c58b9523 AM |
99 | bfd_boolean bfd_check_format_matches |
100 | (bfd *abfd, bfd_format format, char ***matching); | |
252b5132 RH |
101 | |
102 | DESCRIPTION | |
b34976b6 | 103 | Like <<bfd_check_format>>, except when it returns FALSE with |
252b5132 RH |
104 | <<bfd_errno>> set to <<bfd_error_file_ambiguously_recognized>>. In that |
105 | case, if @var{matching} is not NULL, it will be filled in with | |
106 | a NULL-terminated list of the names of the formats that matched, | |
107 | allocated with <<malloc>>. | |
108 | Then the user may choose a format and try again. | |
109 | ||
110 | When done with the list that @var{matching} points to, the caller | |
3fde5a36 | 111 | should free it. |
252b5132 RH |
112 | */ |
113 | ||
b34976b6 | 114 | bfd_boolean |
c58b9523 | 115 | bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching) |
252b5132 RH |
116 | { |
117 | extern const bfd_target binary_vec; | |
08f74004 AM |
118 | const bfd_target * const *target; |
119 | const bfd_target **matching_vector = NULL; | |
120 | const bfd_target *save_targ, *right_targ, *ar_right_targ; | |
252b5132 | 121 | int match_count; |
3619ad04 | 122 | int ar_match_index; |
252b5132 | 123 | |
3619ad04 | 124 | if (!bfd_read_p (abfd) |
cea4409c | 125 | || (unsigned int) abfd->format >= (unsigned int) bfd_type_end) |
1d713d9e NC |
126 | { |
127 | bfd_set_error (bfd_error_invalid_operation); | |
b34976b6 | 128 | return FALSE; |
1d713d9e | 129 | } |
252b5132 RH |
130 | |
131 | if (abfd->format != bfd_unknown) | |
b34976b6 | 132 | return abfd->format == format; |
252b5132 | 133 | |
3fde5a36 | 134 | /* Since the target type was defaulted, check them |
252b5132 | 135 | all in the hope that one will be uniquely recognized. */ |
252b5132 RH |
136 | save_targ = abfd->xvec; |
137 | match_count = 0; | |
3619ad04 | 138 | ar_match_index = _bfd_target_vector_entries; |
3fde5a36 | 139 | |
252b5132 RH |
140 | if (matching) |
141 | { | |
dc810e39 AM |
142 | bfd_size_type amt; |
143 | ||
3619ad04 | 144 | *matching = NULL; |
08f74004 | 145 | amt = sizeof (*matching_vector) * 2 * _bfd_target_vector_entries; |
c58b9523 | 146 | matching_vector = bfd_malloc (amt); |
252b5132 | 147 | if (!matching_vector) |
b34976b6 | 148 | return FALSE; |
252b5132 | 149 | } |
3fde5a36 | 150 | |
252b5132 | 151 | right_targ = 0; |
3619ad04 | 152 | ar_right_targ = 0; |
252b5132 | 153 | |
1d713d9e | 154 | /* Presume the answer is yes. */ |
252b5132 RH |
155 | abfd->format = format; |
156 | ||
157 | /* If the target type was explicitly specified, just check that target. */ | |
1d713d9e NC |
158 | if (!abfd->target_defaulted) |
159 | { | |
dc810e39 | 160 | if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0) /* rewind! */ |
5ed6aba4 NC |
161 | { |
162 | if (matching) | |
c58b9523 | 163 | free (matching_vector); |
5ed6aba4 NC |
164 | return FALSE; |
165 | } | |
3fde5a36 | 166 | |
1d713d9e | 167 | right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd)); |
3fde5a36 | 168 | |
1d713d9e | 169 | if (right_targ) |
252b5132 | 170 | { |
1d713d9e | 171 | abfd->xvec = right_targ; /* Set the target as returned. */ |
3fde5a36 | 172 | |
1d713d9e | 173 | if (matching) |
c58b9523 | 174 | free (matching_vector); |
3fde5a36 | 175 | |
26ae6d5e DJ |
176 | /* If the file was opened for update, then `output_has_begun' |
177 | some time ago when the file was created. Do not recompute | |
178 | sections sizes or alignments in _bfd_set_section_contents. | |
179 | We can not set this flag until after checking the format, | |
180 | because it will interfere with creation of BFD sections. */ | |
181 | if (abfd->direction == both_direction) | |
182 | abfd->output_has_begun = TRUE; | |
183 | ||
b34976b6 | 184 | return TRUE; /* File position has moved, BTW. */ |
252b5132 | 185 | } |
1d713d9e NC |
186 | |
187 | /* For a long time the code has dropped through to check all | |
188 | targets if the specified target was wrong. I don't know why, | |
189 | and I'm reluctant to change it. However, in the case of an | |
190 | archive, it can cause problems. If the specified target does | |
191 | not permit archives (e.g., the binary target), then we should | |
192 | not allow some other target to recognize it as an archive, but | |
193 | should instead allow the specified target to recognize it as an | |
194 | object. When I first made this change, it broke the PE target, | |
195 | because the specified pei-i386 target did not recognize the | |
196 | actual pe-i386 archive. Since there may be other problems of | |
197 | this sort, I changed this test to check only for the binary | |
198 | target. */ | |
199 | if (format == bfd_archive && save_targ == &binary_vec) | |
252b5132 | 200 | { |
1d713d9e NC |
201 | abfd->xvec = save_targ; |
202 | abfd->format = bfd_unknown; | |
3fde5a36 | 203 | |
1d713d9e | 204 | if (matching) |
c58b9523 | 205 | free (matching_vector); |
3fde5a36 | 206 | |
1d713d9e | 207 | bfd_set_error (bfd_error_file_not_recognized); |
3fde5a36 | 208 | |
b34976b6 | 209 | return FALSE; |
1d713d9e NC |
210 | } |
211 | } | |
212 | ||
213 | for (target = bfd_target_vector; *target != NULL; target++) | |
214 | { | |
215 | const bfd_target *temp; | |
3619ad04 | 216 | bfd_error_type err; |
3fde5a36 | 217 | |
1d713d9e NC |
218 | if (*target == &binary_vec) |
219 | continue; | |
3fde5a36 | 220 | |
ed781d5d | 221 | abfd->xvec = *target; /* Change BFD's target temporarily. */ |
3fde5a36 | 222 | |
dc810e39 | 223 | if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0) |
5ed6aba4 NC |
224 | { |
225 | if (matching) | |
c58b9523 | 226 | free (matching_vector); |
5ed6aba4 NC |
227 | return FALSE; |
228 | } | |
3fde5a36 | 229 | |
1d713d9e NC |
230 | /* If _bfd_check_format neglects to set bfd_error, assume |
231 | bfd_error_wrong_format. We didn't used to even pay any | |
232 | attention to bfd_error, so I suspect that some | |
233 | _bfd_check_format might have this problem. */ | |
234 | bfd_set_error (bfd_error_wrong_format); | |
235 | ||
236 | temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd)); | |
3fde5a36 | 237 | |
1d713d9e | 238 | if (temp) |
ed781d5d NC |
239 | { |
240 | /* This format checks out as ok! */ | |
1d713d9e | 241 | right_targ = temp; |
3fde5a36 | 242 | |
1d713d9e NC |
243 | /* If this is the default target, accept it, even if other |
244 | targets might match. People who want those other targets | |
245 | have to set the GNUTARGET variable. */ | |
246 | if (temp == bfd_default_vector[0]) | |
247 | { | |
1d713d9e NC |
248 | match_count = 1; |
249 | break; | |
252b5132 | 250 | } |
3619ad04 AM |
251 | |
252 | if (matching) | |
08f74004 | 253 | matching_vector[match_count] = temp; |
3619ad04 AM |
254 | |
255 | match_count++; | |
1d713d9e | 256 | } |
3619ad04 AM |
257 | else if ((err = bfd_get_error ()) == bfd_error_wrong_object_format |
258 | || err == bfd_error_file_ambiguously_recognized) | |
259 | { | |
260 | /* An archive with objects of the wrong type, or an | |
261 | ambiguous match. We want this target to match if we get | |
262 | no better matches. */ | |
263 | if (ar_right_targ != bfd_default_vector[0]) | |
264 | ar_right_targ = *target; | |
265 | if (matching) | |
08f74004 | 266 | matching_vector[ar_match_index] = *target; |
3619ad04 AM |
267 | ar_match_index++; |
268 | } | |
269 | else if (err != bfd_error_wrong_format) | |
1d713d9e NC |
270 | { |
271 | abfd->xvec = save_targ; | |
272 | abfd->format = bfd_unknown; | |
3fde5a36 | 273 | |
3619ad04 | 274 | if (matching) |
c58b9523 | 275 | free (matching_vector); |
3fde5a36 | 276 | |
b34976b6 | 277 | return FALSE; |
1d713d9e NC |
278 | } |
279 | } | |
3fde5a36 | 280 | |
3619ad04 AM |
281 | if (match_count == 0) |
282 | { | |
283 | /* Try partial matches. */ | |
284 | right_targ = ar_right_targ; | |
ed781d5d | 285 | |
3619ad04 AM |
286 | if (right_targ == bfd_default_vector[0]) |
287 | { | |
288 | match_count = 1; | |
289 | } | |
290 | else | |
291 | { | |
292 | match_count = ar_match_index - _bfd_target_vector_entries; | |
ed781d5d | 293 | |
3619ad04 | 294 | if (matching && match_count > 1) |
ed781d5d NC |
295 | memcpy (matching_vector, |
296 | matching_vector + _bfd_target_vector_entries, | |
297 | sizeof (*matching_vector) * match_count); | |
08f74004 AM |
298 | } |
299 | } | |
300 | ||
4081944f NC |
301 | if (match_count > 1 |
302 | && bfd_associated_vector != NULL | |
303 | && matching) | |
08f74004 AM |
304 | { |
305 | const bfd_target * const *assoc = bfd_associated_vector; | |
306 | ||
307 | while ((right_targ = *assoc++) != NULL) | |
308 | { | |
309 | int i = match_count; | |
310 | ||
311 | while (--i >= 0) | |
312 | if (matching_vector[i] == right_targ) | |
313 | break; | |
314 | ||
315 | if (i >= 0) | |
316 | { | |
317 | match_count = 1; | |
318 | break; | |
3619ad04 AM |
319 | } |
320 | } | |
321 | } | |
322 | ||
1d713d9e NC |
323 | if (match_count == 1) |
324 | { | |
325 | abfd->xvec = right_targ; /* Change BFD's target permanently. */ | |
3fde5a36 | 326 | |
1d713d9e | 327 | if (matching) |
c58b9523 | 328 | free (matching_vector); |
3fde5a36 | 329 | |
26ae6d5e DJ |
330 | /* If the file was opened for update, then `output_has_begun' |
331 | some time ago when the file was created. Do not recompute | |
332 | sections sizes or alignments in _bfd_set_section_contents. | |
333 | We can not set this flag until after checking the format, | |
334 | because it will interfere with creation of BFD sections. */ | |
335 | if (abfd->direction == both_direction) | |
336 | abfd->output_has_begun = TRUE; | |
337 | ||
b34976b6 | 338 | return TRUE; /* File position has moved, BTW. */ |
252b5132 | 339 | } |
252b5132 | 340 | |
1d713d9e NC |
341 | abfd->xvec = save_targ; /* Restore original target type. */ |
342 | abfd->format = bfd_unknown; /* Restore original format. */ | |
3fde5a36 | 343 | |
252b5132 RH |
344 | if (match_count == 0) |
345 | { | |
346 | bfd_set_error (bfd_error_file_not_recognized); | |
3fde5a36 | 347 | |
252b5132 | 348 | if (matching) |
c58b9523 | 349 | free (matching_vector); |
252b5132 RH |
350 | } |
351 | else | |
3619ad04 AM |
352 | { |
353 | bfd_set_error (bfd_error_file_ambiguously_recognized); | |
354 | ||
355 | if (matching) | |
356 | { | |
08f74004 | 357 | *matching = (char **) matching_vector; |
3619ad04 | 358 | matching_vector[match_count] = NULL; |
08f74004 AM |
359 | /* Return target names. This is a little nasty. Maybe we |
360 | should do another bfd_malloc? */ | |
361 | while (--match_count >= 0) | |
362 | { | |
363 | const char *name = matching_vector[match_count]->name; | |
364 | *(const char **) &matching_vector[match_count] = name; | |
365 | } | |
3619ad04 AM |
366 | } |
367 | } | |
3fde5a36 | 368 | |
b34976b6 | 369 | return FALSE; |
252b5132 RH |
370 | } |
371 | ||
372 | /* | |
373 | FUNCTION | |
374 | bfd_set_format | |
375 | ||
376 | SYNOPSIS | |
ed781d5d | 377 | bfd_boolean bfd_set_format (bfd *abfd, bfd_format format); |
252b5132 RH |
378 | |
379 | DESCRIPTION | |
380 | This function sets the file format of the BFD @var{abfd} to the | |
381 | format @var{format}. If the target set in the BFD does not | |
382 | support the format requested, the format is invalid, or the BFD | |
383 | is not open for writing, then an error occurs. | |
252b5132 RH |
384 | */ |
385 | ||
b34976b6 | 386 | bfd_boolean |
c58b9523 | 387 | bfd_set_format (bfd *abfd, bfd_format format) |
252b5132 | 388 | { |
3619ad04 | 389 | if (bfd_read_p (abfd) |
cea4409c | 390 | || (unsigned int) abfd->format >= (unsigned int) bfd_type_end) |
1d713d9e NC |
391 | { |
392 | bfd_set_error (bfd_error_invalid_operation); | |
b34976b6 | 393 | return FALSE; |
1d713d9e | 394 | } |
252b5132 RH |
395 | |
396 | if (abfd->format != bfd_unknown) | |
b34976b6 | 397 | return abfd->format == format; |
252b5132 | 398 | |
1d713d9e | 399 | /* Presume the answer is yes. */ |
252b5132 RH |
400 | abfd->format = format; |
401 | ||
1d713d9e NC |
402 | if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd))) |
403 | { | |
404 | abfd->format = bfd_unknown; | |
b34976b6 | 405 | return FALSE; |
1d713d9e | 406 | } |
252b5132 | 407 | |
b34976b6 | 408 | return TRUE; |
252b5132 RH |
409 | } |
410 | ||
252b5132 RH |
411 | /* |
412 | FUNCTION | |
413 | bfd_format_string | |
414 | ||
415 | SYNOPSIS | |
ed781d5d | 416 | const char *bfd_format_string (bfd_format format); |
252b5132 RH |
417 | |
418 | DESCRIPTION | |
419 | Return a pointer to a const string | |
420 | <<invalid>>, <<object>>, <<archive>>, <<core>>, or <<unknown>>, | |
421 | depending upon the value of @var{format}. | |
422 | */ | |
423 | ||
3619ad04 | 424 | const char * |
c58b9523 | 425 | bfd_format_string (bfd_format format) |
252b5132 | 426 | { |
c58b9523 AM |
427 | if (((int) format < (int) bfd_unknown) |
428 | || ((int) format >= (int) bfd_type_end)) | |
252b5132 | 429 | return "invalid"; |
3fde5a36 | 430 | |
1d713d9e NC |
431 | switch (format) |
432 | { | |
433 | case bfd_object: | |
7dee875e | 434 | return "object"; /* Linker/assembler/compiler output. */ |
3fde5a36 | 435 | case bfd_archive: |
1d713d9e | 436 | return "archive"; /* Object archive file. */ |
3fde5a36 | 437 | case bfd_core: |
1d713d9e | 438 | return "core"; /* Core dump. */ |
3fde5a36 | 439 | default: |
1d713d9e NC |
440 | return "unknown"; |
441 | } | |
252b5132 | 442 | } |