1 /* Generic BFD support for file formats.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000, 2001, 2002,
3 2003, 2005, 2007, 2008, 2009 Free Software Foundation, Inc.
4 Written by Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
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 3 of the License, or
11 (at your option) any later version.
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.
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., 51 Franklin Street - Fifth Floor, Boston,
21 MA 02110-1301, USA. */
28 A format is a BFD concept of high level file contents type. The
29 formats supported by BFD are:
33 The BFD may contain data, symbols, relocations and debug info.
37 The BFD contains other BFDs and an optional index.
41 The BFD contains the result of an executable core dump.
51 /* IMPORT from targets.c. */
52 extern const size_t _bfd_target_vector_entries
;
59 bfd_boolean bfd_check_format (bfd *abfd, bfd_format format);
62 Verify if the file attached to the BFD @var{abfd} is compatible
63 with the format @var{format} (i.e., one of <<bfd_object>>,
64 <<bfd_archive>> or <<bfd_core>>).
66 If the BFD has been set to a specific target before the
67 call, only the named target and format combination is
68 checked. If the target has not been set, or has been set to
69 <<default>>, then all the known target backends is
70 interrogated to determine a match. If the default target
71 matches, it is used. If not, exactly one target must recognize
72 the file, or an error results.
74 The function returns <<TRUE>> on success, otherwise <<FALSE>>
75 with one of the following error codes:
77 o <<bfd_error_invalid_operation>> -
78 if <<format>> is not one of <<bfd_object>>, <<bfd_archive>> or
81 o <<bfd_error_system_call>> -
82 if an error occured during a read - even some file mismatches
83 can cause bfd_error_system_calls.
85 o <<file_not_recognised>> -
86 none of the backends recognised the file format.
88 o <<bfd_error_file_ambiguously_recognized>> -
89 more than one backend recognised the file format.
93 bfd_check_format (bfd
*abfd
, bfd_format format
)
95 return bfd_check_format_matches (abfd
, format
, NULL
);
103 const struct bfd_arch_info
*arch_info
;
104 struct bfd_section
*sections
;
105 struct bfd_section
*section_last
;
106 unsigned int section_count
;
107 struct bfd_hash_table section_htab
;
110 /* When testing an object for compatibility with a particular target
111 back-end, the back-end object_p function needs to set up certain
112 fields in the bfd on successfully recognizing the object. This
113 typically happens in a piecemeal fashion, with failures possible at
114 many points. On failure, the bfd is supposed to be restored to its
115 initial state, which is virtually impossible. However, restoring a
116 subset of the bfd state works in practice. This function stores
120 bfd_preserve_save (bfd
*abfd
, struct bfd_preserve
*preserve
)
122 preserve
->tdata
= abfd
->tdata
.any
;
123 preserve
->arch_info
= abfd
->arch_info
;
124 preserve
->flags
= abfd
->flags
;
125 preserve
->sections
= abfd
->sections
;
126 preserve
->section_last
= abfd
->section_last
;
127 preserve
->section_count
= abfd
->section_count
;
128 preserve
->section_htab
= abfd
->section_htab
;
129 preserve
->marker
= bfd_alloc (abfd
, 1);
130 if (preserve
->marker
== NULL
)
133 return bfd_hash_table_init (&abfd
->section_htab
, bfd_section_hash_newfunc
,
134 sizeof (struct section_hash_entry
));
137 /* Clear out a subset of BFD state. */
140 bfd_reinit (bfd
*abfd
)
142 abfd
->tdata
.any
= NULL
;
143 abfd
->arch_info
= &bfd_default_arch_struct
;
144 abfd
->flags
&= BFD_FLAGS_SAVED
;
145 bfd_section_list_clear (abfd
);
148 /* Restores bfd state saved by bfd_preserve_save. */
151 bfd_preserve_restore (bfd
*abfd
, struct bfd_preserve
*preserve
)
153 bfd_hash_table_free (&abfd
->section_htab
);
155 abfd
->tdata
.any
= preserve
->tdata
;
156 abfd
->arch_info
= preserve
->arch_info
;
157 abfd
->flags
= preserve
->flags
;
158 abfd
->section_htab
= preserve
->section_htab
;
159 abfd
->sections
= preserve
->sections
;
160 abfd
->section_last
= preserve
->section_last
;
161 abfd
->section_count
= preserve
->section_count
;
163 /* bfd_release frees all memory more recently bfd_alloc'd than
164 its arg, as well as its arg. */
165 bfd_release (abfd
, preserve
->marker
);
166 preserve
->marker
= NULL
;
169 /* Called when the bfd state saved by bfd_preserve_save is no longer
173 bfd_preserve_finish (bfd
*abfd ATTRIBUTE_UNUSED
, struct bfd_preserve
*preserve
)
175 /* It would be nice to be able to free more memory here, eg. old
176 tdata, but that's not possible since these blocks are sitting
177 inside bfd_alloc'd memory. The section hash is on a separate
179 bfd_hash_table_free (&preserve
->section_htab
);
180 preserve
->marker
= NULL
;
185 bfd_check_format_matches
188 bfd_boolean bfd_check_format_matches
189 (bfd *abfd, bfd_format format, char ***matching);
192 Like <<bfd_check_format>>, except when it returns FALSE with
193 <<bfd_errno>> set to <<bfd_error_file_ambiguously_recognized>>. In that
194 case, if @var{matching} is not NULL, it will be filled in with
195 a NULL-terminated list of the names of the formats that matched,
196 allocated with <<malloc>>.
197 Then the user may choose a format and try again.
199 When done with the list that @var{matching} points to, the caller
204 bfd_check_format_matches (bfd
*abfd
, bfd_format format
, char ***matching
)
206 extern const bfd_target binary_vec
;
207 const bfd_target
* const *target
;
208 const bfd_target
**matching_vector
= NULL
;
209 const bfd_target
*save_targ
, *right_targ
, *ar_right_targ
, *match_targ
;
210 int match_count
, best_count
, best_match
;
212 struct bfd_preserve preserve
;
214 if (matching
!= NULL
)
217 if (!bfd_read_p (abfd
)
218 || (unsigned int) abfd
->format
>= (unsigned int) bfd_type_end
)
220 bfd_set_error (bfd_error_invalid_operation
);
224 if (abfd
->format
!= bfd_unknown
)
225 return abfd
->format
== format
;
227 if (matching
!= NULL
|| *bfd_associated_vector
!= NULL
)
231 amt
= sizeof (*matching_vector
) * 2 * _bfd_target_vector_entries
;
232 matching_vector
= (const bfd_target
**) bfd_malloc (amt
);
233 if (!matching_vector
)
237 /* Presume the answer is yes. */
238 abfd
->format
= format
;
239 save_targ
= abfd
->xvec
;
240 preserve
.marker
= NULL
;
242 /* If the target type was explicitly specified, just check that target. */
243 if (!abfd
->target_defaulted
)
245 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0) /* rewind! */
248 right_targ
= BFD_SEND_FMT (abfd
, _bfd_check_format
, (abfd
));
253 /* For a long time the code has dropped through to check all
254 targets if the specified target was wrong. I don't know why,
255 and I'm reluctant to change it. However, in the case of an
256 archive, it can cause problems. If the specified target does
257 not permit archives (e.g., the binary target), then we should
258 not allow some other target to recognize it as an archive, but
259 should instead allow the specified target to recognize it as an
260 object. When I first made this change, it broke the PE target,
261 because the specified pei-i386 target did not recognize the
262 actual pe-i386 archive. Since there may be other problems of
263 this sort, I changed this test to check only for the binary
265 if (format
== bfd_archive
&& save_targ
== &binary_vec
)
269 /* Since the target type was defaulted, check them all in the hope
270 that one will be uniquely recognized. */
272 ar_right_targ
= NULL
;
277 ar_match_index
= _bfd_target_vector_entries
;
279 for (target
= bfd_target_vector
; *target
!= NULL
; target
++)
281 const bfd_target
*temp
;
284 /* Don't check the default target twice. */
285 if (*target
== &binary_vec
286 || (!abfd
->target_defaulted
&& *target
== save_targ
)
287 || (*target
)->match_priority
> best_match
)
290 /* If we already tried a match, the bfd is modified and may
291 have sections attached, which will confuse the next
292 _bfd_check_format call. */
295 /* Change BFD's target temporarily. */
296 abfd
->xvec
= *target
;
298 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0)
301 /* If _bfd_check_format neglects to set bfd_error, assume
302 bfd_error_wrong_format. We didn't used to even pay any
303 attention to bfd_error, so I suspect that some
304 _bfd_check_format might have this problem. */
305 bfd_set_error (bfd_error_wrong_format
);
307 temp
= BFD_SEND_FMT (abfd
, _bfd_check_format
, (abfd
));
311 if (preserve
.marker
!= NULL
)
312 bfd_preserve_finish (abfd
, &preserve
);
315 if (temp
&& (abfd
->format
!= bfd_archive
|| bfd_has_map (abfd
)))
317 /* This format checks out as ok! */
320 /* If this is the default target, accept it, even if other
321 targets might match. People who want those other targets
322 have to set the GNUTARGET variable. */
323 if (temp
== bfd_default_vector
[0])
327 matching_vector
[match_count
] = temp
;
330 if (temp
->match_priority
< best_match
)
332 best_match
= temp
->match_priority
;
338 || (err
= bfd_get_error ()) == bfd_error_wrong_object_format
339 || err
== bfd_error_file_ambiguously_recognized
)
341 /* An archive with no armap or objects of the wrong type,
342 or an ambiguous match. We want this target to match
343 if we get no better matches. */
344 if (ar_right_targ
!= bfd_default_vector
[0])
345 ar_right_targ
= *target
;
347 matching_vector
[ar_match_index
] = *target
;
350 else if (err
!= bfd_error_wrong_format
)
353 if (temp
&& !bfd_preserve_save (abfd
, &preserve
))
360 if (match_count
== 0)
362 /* Try partial matches. */
363 right_targ
= ar_right_targ
;
365 if (right_targ
== bfd_default_vector
[0])
371 match_count
= ar_match_index
- _bfd_target_vector_entries
;
373 if (matching_vector
&& match_count
> 1)
374 memcpy (matching_vector
,
375 matching_vector
+ _bfd_target_vector_entries
,
376 sizeof (*matching_vector
) * match_count
);
382 const bfd_target
* const *assoc
= bfd_associated_vector
;
384 while ((right_targ
= *assoc
++) != NULL
)
389 if (matching_vector
[i
] == right_targ
)
400 /* There is way too much undoing of half-known state here. We
401 really shouldn't iterate on live bfd's. Note that saving the
402 whole bfd and restoring it would be even worse; the first thing
403 you notice is that the cached bfd file position gets out of sync. */
404 if (preserve
.marker
!= NULL
)
405 bfd_preserve_restore (abfd
, &preserve
);
407 if (match_count
== 1)
409 abfd
->xvec
= right_targ
;
410 /* If we come out of the loop knowing that the last target that
411 matched is the one we want, then ABFD should still be in a usable
412 state (except possibly for XVEC). */
413 if (match_targ
!= right_targ
)
416 if (bfd_seek (abfd
, (file_ptr
) 0, SEEK_SET
) != 0)
418 match_targ
= BFD_SEND_FMT (abfd
, _bfd_check_format
, (abfd
));
419 BFD_ASSERT (match_targ
!= NULL
);
423 /* If the file was opened for update, then `output_has_begun'
424 some time ago when the file was created. Do not recompute
425 sections sizes or alignments in _bfd_set_section_contents.
426 We can not set this flag until after checking the format,
427 because it will interfere with creation of BFD sections. */
428 if (abfd
->direction
== both_direction
)
429 abfd
->output_has_begun
= TRUE
;
432 free (matching_vector
);
434 /* File position has moved, BTW. */
438 if (match_count
== 0)
441 bfd_set_error (bfd_error_file_not_recognized
);
443 abfd
->xvec
= save_targ
;
444 abfd
->format
= bfd_unknown
;
446 free (matching_vector
);
447 if (preserve
.marker
!= NULL
)
448 bfd_preserve_restore (abfd
, &preserve
);
452 /* Restore original target type and format. */
453 abfd
->xvec
= save_targ
;
454 abfd
->format
= bfd_unknown
;
455 bfd_set_error (bfd_error_file_ambiguously_recognized
);
459 *matching
= (char **) matching_vector
;
460 matching_vector
[match_count
] = NULL
;
461 /* Return target names. This is a little nasty. Maybe we
462 should do another bfd_malloc? */
463 while (--match_count
>= 0)
465 const char *name
= matching_vector
[match_count
]->name
;
466 *(const char **) &matching_vector
[match_count
] = name
;
477 bfd_boolean bfd_set_format (bfd *abfd, bfd_format format);
480 This function sets the file format of the BFD @var{abfd} to the
481 format @var{format}. If the target set in the BFD does not
482 support the format requested, the format is invalid, or the BFD
483 is not open for writing, then an error occurs.
487 bfd_set_format (bfd
*abfd
, bfd_format format
)
489 if (bfd_read_p (abfd
)
490 || (unsigned int) abfd
->format
>= (unsigned int) bfd_type_end
)
492 bfd_set_error (bfd_error_invalid_operation
);
496 if (abfd
->format
!= bfd_unknown
)
497 return abfd
->format
== format
;
499 /* Presume the answer is yes. */
500 abfd
->format
= format
;
502 if (!BFD_SEND_FMT (abfd
, _bfd_set_format
, (abfd
)))
504 abfd
->format
= bfd_unknown
;
516 const char *bfd_format_string (bfd_format format);
519 Return a pointer to a const string
520 <<invalid>>, <<object>>, <<archive>>, <<core>>, or <<unknown>>,
521 depending upon the value of @var{format}.
525 bfd_format_string (bfd_format format
)
527 if (((int) format
< (int) bfd_unknown
)
528 || ((int) format
>= (int) bfd_type_end
))
534 return "object"; /* Linker/assembler/compiler output. */
536 return "archive"; /* Object archive file. */
538 return "core"; /* Core dump. */