1 /* Generic BFD library interface and support routines.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
22 MA 02110-1301, USA. */
28 A BFD has type <<bfd>>; objects of this type are the
29 cornerstone of any application using BFD. Using BFD
30 consists of making references though the BFD and to data in the BFD.
32 Here is the structure that defines the type <<bfd>>. It
33 contains the major data about the file and pointers
34 to the rest of the data.
42 . write_direction = 2,
48 . {* A unique identifier of the BFD *}
51 . {* The filename the application opened the BFD with. *}
52 . const char *filename;
54 . {* A pointer to the target jump table. *}
55 . const struct bfd_target *xvec;
57 . {* The IOSTREAM, and corresponding IO vector that provide access
58 . to the file backing the BFD. *}
60 . const struct bfd_iovec *iovec;
62 . {* The caching routines use these to maintain a
63 . least-recently-used list of BFDs. *}
64 . struct bfd *lru_prev, *lru_next;
66 . {* When a file is closed by the caching routines, BFD retains
67 . state information on the file here... *}
70 . {* File modified time, if mtime_set is TRUE. *}
73 . {* Reserved for an unimplemented file locking extension. *}
76 . {* The format which belongs to the BFD. (object, core, etc.) *}
79 . {* The direction with which the BFD was opened. *}
80 . enum bfd_direction direction;
82 . {* Format_specific flags. *}
85 . {* Values that may appear in the flags field of a BFD. These also
86 . appear in the object_flags field of the bfd_target structure, where
87 . they indicate the set of flags used by that backend (not all flags
88 . are meaningful for all object file formats) (FIXME: at the moment,
89 . the object_flags values have mostly just been copied from backend
90 . to another, and are not necessarily correct). *}
92 .#define BFD_NO_FLAGS 0x00
94 . {* BFD contains relocation entries. *}
95 .#define HAS_RELOC 0x01
97 . {* BFD is directly executable. *}
100 . {* BFD has line number information (basically used for F_LNNO in a
102 .#define HAS_LINENO 0x04
104 . {* BFD has debugging information. *}
105 .#define HAS_DEBUG 0x08
107 . {* BFD has symbols. *}
108 .#define HAS_SYMS 0x10
110 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
112 .#define HAS_LOCALS 0x20
114 . {* BFD is a dynamic object. *}
115 .#define DYNAMIC 0x40
117 . {* Text section is write protected (if D_PAGED is not set, this is
118 . like an a.out NMAGIC file) (the linker sets this by default, but
119 . clears it for -r or -N). *}
120 .#define WP_TEXT 0x80
122 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
123 . linker sets this by default, but clears it for -r or -n or -N). *}
124 .#define D_PAGED 0x100
126 . {* BFD is relaxable (this means that bfd_relax_section may be able to
127 . do something) (sometimes bfd_relax_section can do something even if
128 . this is not set). *}
129 .#define BFD_IS_RELAXABLE 0x200
131 . {* This may be set before writing out a BFD to request using a
132 . traditional format. For example, this is used to request that when
133 . writing out an a.out object the symbols not be hashed to eliminate
135 .#define BFD_TRADITIONAL_FORMAT 0x400
137 . {* This flag indicates that the BFD contents are actually cached
138 . in memory. If this is set, iostream points to a bfd_in_memory
140 .#define BFD_IN_MEMORY 0x800
142 . {* The sections in this BFD specify a memory page. *}
143 .#define HAS_LOAD_PAGE 0x1000
145 . {* This BFD has been created by the linker and doesn't correspond
146 . to any input file. *}
147 .#define BFD_LINKER_CREATED 0x2000
149 . {* This may be set before writing out a BFD to request that it
150 . be written using values for UIDs, GIDs, timestamps, etc. that
151 . will be consistent from run to run. *}
152 .#define BFD_DETERMINISTIC_OUTPUT 0x4000
154 . {* Compress sections in this BFD. *}
155 .#define BFD_COMPRESS 0x8000
157 . {* Decompress sections in this BFD. *}
158 .#define BFD_DECOMPRESS 0x10000
160 . {* BFD is a dummy, for plugins. *}
161 .#define BFD_PLUGIN 0x20000
163 . {* Flags bits to be saved in bfd_preserve_save. *}
164 .#define BFD_FLAGS_SAVED \
165 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_PLUGIN)
167 . {* Flags bits which are for BFD use only. *}
168 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
169 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
170 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT)
172 . {* Currently my_archive is tested before adding origin to
173 . anything. I believe that this can become always an add of
174 . origin, with origin set to 0 for non archive files. *}
177 . {* The origin in the archive of the proxy entry. This will
178 . normally be the same as origin, except for thin archives,
179 . when it will contain the current offset of the proxy in the
180 . thin archive rather than the offset of the bfd in its actual
182 . ufile_ptr proxy_origin;
184 . {* A hash table for section names. *}
185 . struct bfd_hash_table section_htab;
187 . {* Pointer to linked list of sections. *}
188 . struct bfd_section *sections;
190 . {* The last section on the section list. *}
191 . struct bfd_section *section_last;
193 . {* The number of sections. *}
194 . unsigned int section_count;
196 . {* Stuff only useful for object files:
197 . The start address. *}
198 . bfd_vma start_address;
200 . {* Used for input and output. *}
201 . unsigned int symcount;
203 . {* Symbol table for output BFD (with symcount entries).
204 . Also used by the linker to cache input BFD symbols. *}
205 . struct bfd_symbol **outsymbols;
207 . {* Used for slurped dynamic symbol tables. *}
208 . unsigned int dynsymcount;
210 . {* Pointer to structure which contains architecture information. *}
211 . const struct bfd_arch_info *arch_info;
213 . {* Stuff only useful for archives. *}
215 . struct bfd *my_archive; {* The containing archive BFD. *}
216 . struct bfd *archive_next; {* The next BFD in the archive. *}
217 . struct bfd *archive_head; {* The first BFD in the archive. *}
218 . struct bfd *nested_archives; {* List of nested archive in a flattened
221 . {* A chain of BFD structures involved in a link. *}
222 . struct bfd *link_next;
224 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
225 . be used only for archive elements. *}
228 . {* Used by the back end to hold private data. *}
231 . struct aout_data_struct *aout_data;
232 . struct artdata *aout_ar_data;
233 . struct _oasys_data *oasys_obj_data;
234 . struct _oasys_ar_data *oasys_ar_data;
235 . struct coff_tdata *coff_obj_data;
236 . struct pe_tdata *pe_obj_data;
237 . struct xcoff_tdata *xcoff_obj_data;
238 . struct ecoff_tdata *ecoff_obj_data;
239 . struct ieee_data_struct *ieee_data;
240 . struct ieee_ar_data_struct *ieee_ar_data;
241 . struct srec_data_struct *srec_data;
242 . struct verilog_data_struct *verilog_data;
243 . struct ihex_data_struct *ihex_data;
244 . struct tekhex_data_struct *tekhex_data;
245 . struct elf_obj_tdata *elf_obj_data;
246 . struct nlm_obj_tdata *nlm_obj_data;
247 . struct bout_data_struct *bout_data;
248 . struct mmo_data_struct *mmo_data;
249 . struct sun_core_struct *sun_core_data;
250 . struct sco5_core_struct *sco5_core_data;
251 . struct trad_core_struct *trad_core_data;
252 . struct som_data_struct *som_data;
253 . struct hpux_core_struct *hpux_core_data;
254 . struct hppabsd_core_struct *hppabsd_core_data;
255 . struct sgi_core_struct *sgi_core_data;
256 . struct lynx_core_struct *lynx_core_data;
257 . struct osf_core_struct *osf_core_data;
258 . struct cisco_core_struct *cisco_core_data;
259 . struct versados_data_struct *versados_data;
260 . struct netbsd_core_struct *netbsd_core_data;
261 . struct mach_o_data_struct *mach_o_data;
262 . struct mach_o_fat_data_struct *mach_o_fat_data;
263 . struct plugin_data_struct *plugin_data;
264 . struct bfd_pef_data_struct *pef_data;
265 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
266 . struct bfd_sym_data_struct *sym_data;
271 . {* Used by the application to hold private data. *}
274 . {* Where all the allocated stuff under this BFD goes. This is a
275 . struct objalloc *, but we use void * to avoid requiring the inclusion
279 . {* Is the file descriptor being cached? That is, can it be closed as
280 . needed, and re-opened when accessed later? *}
281 . unsigned int cacheable : 1;
283 . {* Marks whether there was a default target specified when the
284 . BFD was opened. This is used to select which matching algorithm
285 . to use to choose the back end. *}
286 . unsigned int target_defaulted : 1;
288 . {* ... and here: (``once'' means at least once). *}
289 . unsigned int opened_once : 1;
291 . {* Set if we have a locally maintained mtime value, rather than
292 . getting it from the file each time. *}
293 . unsigned int mtime_set : 1;
295 . {* Flag set if symbols from this BFD should not be exported. *}
296 . unsigned int no_export : 1;
298 . {* Remember when output has begun, to stop strange things
300 . unsigned int output_has_begun : 1;
302 . {* Have archive map. *}
303 . unsigned int has_armap : 1;
305 . {* Set if this is a thin archive. *}
306 . unsigned int is_thin_archive : 1;
308 . {* Set if only required symbols should be added in the link hash table for
309 . this object. Used by VMS linkers. *}
310 . unsigned int selective_search : 1;
319 #include "libiberty.h"
320 #include "demangle.h"
321 #include "safe-ctype.h"
324 #include "coff/internal.h"
325 #include "coff/sym.h"
327 #include "libecoff.h"
332 #define EXIT_FAILURE 1
336 /* provide storage for subsystem, stack and heap data which may have been
337 passed in on the command line. Ld puts this data into a bfd_link_info
338 struct which ultimately gets passed in to the bfd. When it arrives, copy
339 it to the following struct so that the data will be available in coffcode.h
340 where it is needed. The typedef's used are defined in bfd.h */
346 Most BFD functions return nonzero on success (check their
347 individual documentation for precise semantics). On an error,
348 they call <<bfd_set_error>> to set an error condition that callers
349 can check by calling <<bfd_get_error>>.
350 If that returns <<bfd_error_system_call>>, then check
353 The easiest way to report a BFD error to the user is to
357 Type <<bfd_error_type>>
359 The values returned by <<bfd_get_error>> are defined by the
360 enumerated type <<bfd_error_type>>.
364 .typedef enum bfd_error
366 . bfd_error_no_error = 0,
367 . bfd_error_system_call,
368 . bfd_error_invalid_target,
369 . bfd_error_wrong_format,
370 . bfd_error_wrong_object_format,
371 . bfd_error_invalid_operation,
372 . bfd_error_no_memory,
373 . bfd_error_no_symbols,
374 . bfd_error_no_armap,
375 . bfd_error_no_more_archived_files,
376 . bfd_error_malformed_archive,
377 . bfd_error_missing_dso,
378 . bfd_error_file_not_recognized,
379 . bfd_error_file_ambiguously_recognized,
380 . bfd_error_no_contents,
381 . bfd_error_nonrepresentable_section,
382 . bfd_error_no_debug_section,
383 . bfd_error_bad_value,
384 . bfd_error_file_truncated,
385 . bfd_error_file_too_big,
386 . bfd_error_on_input,
387 . bfd_error_invalid_error_code
393 static bfd_error_type bfd_error = bfd_error_no_error;
394 static bfd *input_bfd = NULL;
395 static bfd_error_type input_error = bfd_error_no_error;
397 const char *const bfd_errmsgs[] =
400 N_("System call error"),
401 N_("Invalid bfd target"),
402 N_("File in wrong format"),
403 N_("Archive object file in wrong format"),
404 N_("Invalid operation"),
405 N_("Memory exhausted"),
407 N_("Archive has no index; run ranlib to add one"),
408 N_("No more archived files"),
409 N_("Malformed archive"),
410 N_("DSO missing from command line"),
411 N_("File format not recognized"),
412 N_("File format is ambiguous"),
413 N_("Section has no contents"),
414 N_("Nonrepresentable section on output"),
415 N_("Symbol needs debug section which does not exist"),
417 N_("File truncated"),
419 N_("Error reading %s: %s"),
420 N_("#<Invalid error code>")
428 bfd_error_type bfd_get_error (void);
431 Return the current BFD error condition.
445 void bfd_set_error (bfd_error_type error_tag, ...);
448 Set the BFD error condition to be @var{error_tag}.
449 If @var{error_tag} is bfd_error_on_input, then this function
450 takes two more parameters, the input bfd where the error
451 occurred, and the bfd_error_type error.
455 bfd_set_error (bfd_error_type error_tag, ...)
457 bfd_error = error_tag;
458 if (error_tag == bfd_error_on_input)
460 /* This is an error that occurred during bfd_close when
461 writing an archive, but on one of the input files. */
464 va_start (ap, error_tag);
465 input_bfd = va_arg (ap, bfd *);
466 input_error = (bfd_error_type) va_arg (ap, int);
467 if (input_error >= bfd_error_on_input)
478 const char *bfd_errmsg (bfd_error_type error_tag);
481 Return a string describing the error @var{error_tag}, or
482 the system error if @var{error_tag} is <<bfd_error_system_call>>.
486 bfd_errmsg (bfd_error_type error_tag)
491 if (error_tag == bfd_error_on_input)
494 const char *msg = bfd_errmsg (input_error);
496 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
500 /* Ick, what to do on out of memory? */
504 if (error_tag == bfd_error_system_call)
505 return xstrerror (errno);
507 if (error_tag > bfd_error_invalid_error_code)
508 error_tag = bfd_error_invalid_error_code; /* sanity check */
510 return _(bfd_errmsgs [error_tag]);
518 void bfd_perror (const char *message);
521 Print to the standard error stream a string describing the
522 last BFD error that occurred, or the last system error if
523 the last BFD error was a system call failure. If @var{message}
524 is non-NULL and non-empty, the error string printed is preceded
525 by @var{message}, a colon, and a space. It is followed by a newline.
529 bfd_perror (const char *message)
532 if (message == NULL || *message == '\0')
533 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
535 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
543 Some BFD functions want to print messages describing the
544 problem. They call a BFD error handler function. This
545 function may be overridden by the program.
547 The BFD error handler acts like printf.
551 .typedef void (*bfd_error_handler_type) (const char *, ...);
555 /* The program name used when printing BFD error messages. */
557 static const char *_bfd_error_program_name;
559 /* This is the default routine to handle BFD error messages.
560 Like fprintf (stderr, ...), but also handles some extra format specifiers.
562 %A section name from section. For group components, print group name too.
563 %B file name from bfd. For archive components, prints archive too.
565 Note - because these two extra format specifiers require special handling
566 they are scanned for and processed in this function, before calling
567 vfprintf. This means that the *arguments* for these format specifiers
568 must be the first ones in the variable argument list, regardless of where
569 the specifiers appear in the format string. Thus for example calling
570 this function with a format string of:
572 "blah %s blah %A blah %d blah %B"
574 would involve passing the arguments as:
576 "blah %s blah %A blah %d blah %B",
584 _bfd_default_error_handler (const char *fmt, ...)
588 const char *new_fmt, *p;
592 /* PR 4992: Don't interrupt output being sent to stdout. */
595 if (_bfd_error_program_name != NULL)
596 fprintf (stderr, "%s: ", _bfd_error_program_name);
598 fprintf (stderr, "BFD: ");
604 /* Reserve enough space for the existing format string. */
605 avail -= strlen (fmt) + 1;
607 _exit (EXIT_FAILURE);
613 size_t len, extra, trim;
616 if (p == NULL || p[1] == '\0')
621 memcpy (bufp, fmt, len + 1);
626 if (p[1] == 'A' || p[1] == 'B')
629 memcpy (bufp, fmt, len);
634 /* If we run out of space, tough, you lose your ridiculously
635 long file or section name. It's not safe to try to alloc
636 memory here; We might be printing an out of memory message. */
647 bfd *abfd = va_arg (ap, bfd *);
650 /* Invoking %B with a null bfd pointer is an internal error. */
652 else if (abfd->my_archive)
653 snprintf (bufp, avail, "%s(%s)",
654 abfd->my_archive->filename, abfd->filename);
656 snprintf (bufp, avail, "%s", abfd->filename);
660 asection *sec = va_arg (ap, asection *);
662 const char *group = NULL;
663 struct coff_comdat_info *ci;
666 /* Invoking %A with a null section pointer is an internal error. */
670 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
671 && elf_next_in_group (sec) != NULL
672 && (sec->flags & SEC_GROUP) == 0)
673 group = elf_group_name (sec);
674 else if (abfd != NULL
675 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
676 && (ci = bfd_coff_get_comdat_section (sec->owner,
680 snprintf (bufp, avail, "%s[%s]", sec->name, group);
682 snprintf (bufp, avail, "%s", sec->name);
685 avail = avail - len + 2;
687 /* We need to replace any '%' we printed by "%%".
688 First count how many. */
692 while ((q = strchr (q, '%')) != NULL)
698 /* If there isn't room, trim off the end of the string. */
703 trim = extra - avail;
716 /* Now double all '%' chars, shuffling the string as we go. */
719 while ((q[extra] = *q) != '%')
729 vfprintf (stderr, new_fmt, ap);
736 /* This is a function pointer to the routine which should handle BFD
737 error messages. It is called when a BFD routine encounters an
738 error for which it wants to print a message. Going through a
739 function pointer permits a program linked against BFD to intercept
740 the messages and deal with them itself. */
742 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
746 bfd_set_error_handler
749 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
752 Set the BFD error handler function. Returns the previous
756 bfd_error_handler_type
757 bfd_set_error_handler (bfd_error_handler_type pnew)
759 bfd_error_handler_type pold;
761 pold = _bfd_error_handler;
762 _bfd_error_handler = pnew;
768 bfd_set_error_program_name
771 void bfd_set_error_program_name (const char *);
774 Set the program name to use when printing a BFD error. This
775 is printed before the error message followed by a colon and
776 space. The string must not be changed after it is passed to
781 bfd_set_error_program_name (const char *name)
783 _bfd_error_program_name = name;
788 bfd_get_error_handler
791 bfd_error_handler_type bfd_get_error_handler (void);
794 Return the BFD error handler function.
797 bfd_error_handler_type
798 bfd_get_error_handler (void)
800 return _bfd_error_handler;
807 If BFD finds an internal inconsistency, the bfd assert
808 handler is called with information on the BFD version, BFD
809 source file and line. If this happens, most programs linked
810 against BFD are expected to want to exit with an error, or mark
811 the current BFD operation as failed, so it is recommended to
812 override the default handler, which just calls
813 _bfd_error_handler and continues.
817 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
818 . const char *bfd_version,
819 . const char *bfd_file,
824 /* Note the use of bfd_ prefix on the parameter names above: we want to
825 show which one is the message and which is the version by naming the
826 parameters, but avoid polluting the program-using-bfd namespace as
827 the typedef is visible in the exported headers that the program
828 includes. Below, it's just for consistency. */
831 _bfd_default_assert_handler (const char *bfd_formatmsg,
832 const char *bfd_version,
833 const char *bfd_file,
837 (*_bfd_error_handler) (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
840 /* Similar to _bfd_error_handler, a program can decide to exit on an
841 internal BFD error. We use a non-variadic type to simplify passing
842 on parameters to other functions, e.g. _bfd_error_handler. */
844 bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
848 bfd_set_assert_handler
851 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
854 Set the BFD assert handler function. Returns the previous
858 bfd_assert_handler_type
859 bfd_set_assert_handler (bfd_assert_handler_type pnew)
861 bfd_assert_handler_type pold;
863 pold = _bfd_assert_handler;
864 _bfd_assert_handler = pnew;
870 bfd_get_assert_handler
873 bfd_assert_handler_type bfd_get_assert_handler (void);
876 Return the BFD assert handler function.
879 bfd_assert_handler_type
880 bfd_get_assert_handler (void)
882 return _bfd_assert_handler;
890 Miscellaneous functions
895 bfd_get_reloc_upper_bound
898 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
901 Return the number of bytes required to store the
902 relocation information associated with section @var{sect}
903 attached to bfd @var{abfd}. If an error occurs, return -1.
908 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
910 if (abfd->format != bfd_object)
912 bfd_set_error (bfd_error_invalid_operation);
916 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
921 bfd_canonicalize_reloc
924 long bfd_canonicalize_reloc
925 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
928 Call the back end associated with the open BFD
929 @var{abfd} and translate the external form of the relocation
930 information attached to @var{sec} into the internal canonical
931 form. Place the table into memory at @var{loc}, which has
932 been preallocated, usually by a call to
933 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
936 The @var{syms} table is also needed for horrible internal magic
941 bfd_canonicalize_reloc (bfd *abfd,
946 if (abfd->format != bfd_object)
948 bfd_set_error (bfd_error_invalid_operation);
952 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
953 (abfd, asect, location, symbols));
962 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
965 Set the relocation pointer and count within
966 section @var{sec} to the values @var{rel} and @var{count}.
967 The argument @var{abfd} is ignored.
972 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
977 asect->orelocation = location;
978 asect->reloc_count = count;
986 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
989 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
992 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
993 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
994 o <<bfd_error_invalid_operation>> -
995 The flag word contained a bit which was not applicable to the
996 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
997 on a BFD format which does not support demand paging.
1002 bfd_set_file_flags (bfd *abfd, flagword flags)
1004 if (abfd->format != bfd_object)
1006 bfd_set_error (bfd_error_wrong_format);
1010 if (bfd_read_p (abfd))
1012 bfd_set_error (bfd_error_invalid_operation);
1016 bfd_get_file_flags (abfd) = flags;
1017 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1019 bfd_set_error (bfd_error_invalid_operation);
1027 bfd_assert (const char *file, int line)
1029 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1030 BFD_VERSION_STRING, file, line);
1033 /* A more or less friendly abort message. In libbfd.h abort is
1034 defined to call this function. */
1037 _bfd_abort (const char *file, int line, const char *fn)
1040 (*_bfd_error_handler)
1041 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
1042 BFD_VERSION_STRING, file, line, fn);
1044 (*_bfd_error_handler)
1045 (_("BFD %s internal error, aborting at %s line %d\n"),
1046 BFD_VERSION_STRING, file, line);
1047 (*_bfd_error_handler) (_("Please report this bug.\n"));
1048 _exit (EXIT_FAILURE);
1056 int bfd_get_arch_size (bfd *abfd);
1059 Returns the architecture address size, in bits, as determined
1060 by the object file's format. For ELF, this information is
1061 included in the header.
1064 Returns the arch size in bits if known, <<-1>> otherwise.
1068 bfd_get_arch_size (bfd *abfd)
1070 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1071 return get_elf_backend_data (abfd)->s->arch_size;
1078 bfd_get_sign_extend_vma
1081 int bfd_get_sign_extend_vma (bfd *abfd);
1084 Indicates if the target architecture "naturally" sign extends
1085 an address. Some architectures implicitly sign extend address
1086 values when they are converted to types larger than the size
1087 of an address. For instance, bfd_get_start_address() will
1088 return an address sign extended to fill a bfd_vma when this is
1092 Returns <<1>> if the target architecture is known to sign
1093 extend addresses, <<0>> if the target architecture is known to
1094 not sign extend addresses, and <<-1>> otherwise.
1098 bfd_get_sign_extend_vma (bfd *abfd)
1102 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1103 return get_elf_backend_data (abfd)->sign_extend_vma;
1105 name = bfd_get_target (abfd);
1107 /* Return a proper value for DJGPP & PE COFF.
1108 This function is required for DWARF2 support, but there is
1109 no place to store this information in the COFF back end.
1110 Should enough other COFF targets add support for DWARF2,
1111 a place will have to be found. Until then, this hack will do. */
1112 if (CONST_STRNEQ (name, "coff-go32")
1113 || strcmp (name, "pe-i386") == 0
1114 || strcmp (name, "pei-i386") == 0
1115 || strcmp (name, "pe-x86-64") == 0
1116 || strcmp (name, "pei-x86-64") == 0
1117 || strcmp (name, "pe-arm-wince-little") == 0
1118 || strcmp (name, "pei-arm-wince-little") == 0
1119 || strcmp (name, "aixcoff-rs6000") == 0)
1122 if (CONST_STRNEQ (name, "mach-o"))
1125 bfd_set_error (bfd_error_wrong_format);
1131 bfd_set_start_address
1134 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1137 Make @var{vma} the entry point of output BFD @var{abfd}.
1140 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1144 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1146 abfd->start_address = vma;
1155 unsigned int bfd_get_gp_size (bfd *abfd);
1158 Return the maximum size of objects to be optimized using the GP
1159 register under MIPS ECOFF. This is typically set by the <<-G>>
1160 argument to the compiler, assembler or linker.
1164 bfd_get_gp_size (bfd *abfd)
1166 if (abfd->format == bfd_object)
1168 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1169 return ecoff_data (abfd)->gp_size;
1170 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1171 return elf_gp_size (abfd);
1181 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1184 Set the maximum size of objects to be optimized using the GP
1185 register under ECOFF or MIPS ELF. This is typically set by
1186 the <<-G>> argument to the compiler, assembler or linker.
1190 bfd_set_gp_size (bfd *abfd, unsigned int i)
1192 /* Don't try to set GP size on an archive or core file! */
1193 if (abfd->format != bfd_object)
1196 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1197 ecoff_data (abfd)->gp_size = i;
1198 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1199 elf_gp_size (abfd) = i;
1202 /* Get the GP value. This is an internal function used by some of the
1203 relocation special_function routines on targets which support a GP
1207 _bfd_get_gp_value (bfd *abfd)
1211 if (abfd->format != bfd_object)
1214 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1215 return ecoff_data (abfd)->gp;
1216 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1217 return elf_gp (abfd);
1222 /* Set the GP value. */
1225 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1229 if (abfd->format != bfd_object)
1232 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1233 ecoff_data (abfd)->gp = v;
1234 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1243 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1246 Convert, like <<strtoul>>, a numerical expression
1247 @var{string} into a <<bfd_vma>> integer, and return that integer.
1248 (Though without as many bells and whistles as <<strtoul>>.)
1249 The expression is assumed to be unsigned (i.e., positive).
1250 If given a @var{base}, it is used as the base for conversion.
1251 A base of 0 causes the function to interpret the string
1252 in hex if a leading "0x" or "0X" is found, otherwise
1253 in octal if a leading zero is found, otherwise in decimal.
1255 If the value would overflow, the maximum <<bfd_vma>> value is
1260 bfd_scan_vma (const char *string, const char **end, int base)
1264 unsigned int cutlim;
1267 /* Let the host do it if possible. */
1268 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1269 return strtoul (string, (char **) end, base);
1271 #ifdef HAVE_STRTOULL
1272 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1273 return strtoull (string, (char **) end, base);
1278 if (string[0] == '0')
1280 if ((string[1] == 'x') || (string[1] == 'X'))
1287 if ((base < 2) || (base > 36))
1292 && (string[1] == 'x' || string[1] == 'X')
1293 && ISXDIGIT (string[2]))
1298 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1299 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1307 if (ISDIGIT (digit))
1308 digit = digit - '0';
1309 else if (ISALPHA (digit))
1310 digit = TOUPPER (digit) - 'A' + 10;
1313 if (digit >= (unsigned int) base)
1315 if (value > cutoff || (value == cutoff && digit > cutlim))
1317 value = value * base + digit;
1322 value = ~ (bfd_vma) 0;
1332 bfd_copy_private_header_data
1335 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1338 Copy private BFD header information from the BFD @var{ibfd} to the
1339 the BFD @var{obfd}. This copies information that may require
1340 sections to exist, but does not require symbol tables. Return
1341 <<true>> on success, <<false>> on error.
1342 Possible error returns are:
1344 o <<bfd_error_no_memory>> -
1345 Not enough memory exists to create private data for @var{obfd}.
1347 .#define bfd_copy_private_header_data(ibfd, obfd) \
1348 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1355 bfd_copy_private_bfd_data
1358 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1361 Copy private BFD information from the BFD @var{ibfd} to the
1362 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1363 Possible error returns are:
1365 o <<bfd_error_no_memory>> -
1366 Not enough memory exists to create private data for @var{obfd}.
1368 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1369 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1376 bfd_merge_private_bfd_data
1379 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1382 Merge private BFD information from the BFD @var{ibfd} to the
1383 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1384 on success, <<FALSE>> on error. Possible error returns are:
1386 o <<bfd_error_no_memory>> -
1387 Not enough memory exists to create private data for @var{obfd}.
1389 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1390 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1397 bfd_set_private_flags
1400 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1403 Set private BFD flag information in the BFD @var{abfd}.
1404 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1407 o <<bfd_error_no_memory>> -
1408 Not enough memory exists to create private data for @var{obfd}.
1410 .#define bfd_set_private_flags(abfd, flags) \
1411 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1420 The following functions exist but have not yet been documented.
1422 .#define bfd_sizeof_headers(abfd, info) \
1423 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1425 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1426 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1427 . (abfd, sec, syms, off, file, func, line))
1429 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1431 . BFD_SEND (abfd, _bfd_find_nearest_line_discriminator, \
1432 . (abfd, sec, syms, off, file, func, line, disc))
1434 .#define bfd_find_line(abfd, syms, sym, file, line) \
1435 . BFD_SEND (abfd, _bfd_find_line, \
1436 . (abfd, syms, sym, file, line))
1438 .#define bfd_find_inliner_info(abfd, file, func, line) \
1439 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1440 . (abfd, file, func, line))
1442 .#define bfd_debug_info_start(abfd) \
1443 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1445 .#define bfd_debug_info_end(abfd) \
1446 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1448 .#define bfd_debug_info_accumulate(abfd, section) \
1449 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1451 .#define bfd_stat_arch_elt(abfd, stat) \
1452 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1454 .#define bfd_update_armap_timestamp(abfd) \
1455 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1457 .#define bfd_set_arch_mach(abfd, arch, mach)\
1458 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1460 .#define bfd_relax_section(abfd, section, link_info, again) \
1461 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1463 .#define bfd_gc_sections(abfd, link_info) \
1464 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1466 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1467 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1469 .#define bfd_merge_sections(abfd, link_info) \
1470 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1472 .#define bfd_is_group_section(abfd, sec) \
1473 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1475 .#define bfd_discard_group(abfd, sec) \
1476 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1478 .#define bfd_link_hash_table_create(abfd) \
1479 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1481 .#define bfd_link_hash_table_free(abfd, hash) \
1482 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1484 .#define bfd_link_add_symbols(abfd, info) \
1485 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1487 .#define bfd_link_just_syms(abfd, sec, info) \
1488 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1490 .#define bfd_final_link(abfd, info) \
1491 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1493 .#define bfd_free_cached_info(abfd) \
1494 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1496 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1497 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1499 .#define bfd_print_private_bfd_data(abfd, file)\
1500 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1502 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1503 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1505 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1506 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1507 . dyncount, dynsyms, ret))
1509 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1510 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1512 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1513 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1515 .extern bfd_byte *bfd_get_relocated_section_contents
1516 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1517 . bfd_boolean, asymbol **);
1523 bfd_get_relocated_section_contents (bfd *abfd,
1524 struct bfd_link_info *link_info,
1525 struct bfd_link_order *link_order,
1527 bfd_boolean relocatable,
1531 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1532 bfd_byte *, bfd_boolean, asymbol **);
1534 if (link_order->type == bfd_indirect_link_order)
1536 abfd2 = link_order->u.indirect.section->owner;
1543 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1545 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1548 /* Record information about an ELF program header. */
1551 bfd_record_phdr (bfd *abfd,
1553 bfd_boolean flags_valid,
1555 bfd_boolean at_valid,
1557 bfd_boolean includes_filehdr,
1558 bfd_boolean includes_phdrs,
1562 struct elf_segment_map *m, **pm;
1565 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1568 amt = sizeof (struct elf_segment_map);
1569 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1570 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1577 m->p_flags_valid = flags_valid;
1578 m->p_paddr_valid = at_valid;
1579 m->includes_filehdr = includes_filehdr;
1580 m->includes_phdrs = includes_phdrs;
1583 memcpy (m->sections, secs, count * sizeof (asection *));
1585 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1593 /* Return true iff this target is 32-bit. */
1598 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1600 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1601 return bed->s->elfclass == ELFCLASS32;
1604 /* For non-ELF targets, use architecture information. */
1605 return bfd_arch_bits_per_address (abfd) <= 32;
1609 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1610 target's address size. */
1613 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1618 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1622 sprintf_vma (buf, value);
1626 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1631 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1635 fprintf_vma ((FILE *) stream, value);
1643 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1647 When more than one machine code number is available for the
1648 same machine type, this function can be used to switch between
1649 the preferred one (alternative == 0) and any others. Currently,
1650 only ELF supports this feature, with up to two alternate
1655 bfd_alt_mach_code (bfd *abfd, int alternative)
1657 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1661 switch (alternative)
1664 code = get_elf_backend_data (abfd)->elf_machine_code;
1668 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1674 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1683 elf_elfheader (abfd)->e_machine = code;
1693 bfd_emul_get_maxpagesize
1696 bfd_vma bfd_emul_get_maxpagesize (const char *);
1699 Returns the maximum page size, in bytes, as determined by
1703 Returns the maximum page size in bytes for ELF, 0 otherwise.
1707 bfd_emul_get_maxpagesize (const char *emul)
1709 const bfd_target *target;
1711 target = bfd_find_target (emul, NULL);
1713 && target->flavour == bfd_target_elf_flavour)
1714 return xvec_get_elf_backend_data (target)->maxpagesize;
1720 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1721 int offset, const bfd_target *orig_target)
1723 if (target->flavour == bfd_target_elf_flavour)
1725 const struct elf_backend_data *bed;
1727 bed = xvec_get_elf_backend_data (target);
1728 *((bfd_vma *) ((char *) bed + offset)) = size;
1731 if (target->alternative_target
1732 && target->alternative_target != orig_target)
1733 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1739 bfd_emul_set_maxpagesize
1742 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1745 For ELF, set the maximum page size for the emulation. It is
1746 a no-op for other formats.
1751 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1753 const bfd_target *target;
1755 target = bfd_find_target (emul, NULL);
1757 bfd_elf_set_pagesize (target, size,
1758 offsetof (struct elf_backend_data,
1759 maxpagesize), target);
1764 bfd_emul_get_commonpagesize
1767 bfd_vma bfd_emul_get_commonpagesize (const char *);
1770 Returns the common page size, in bytes, as determined by
1774 Returns the common page size in bytes for ELF, 0 otherwise.
1778 bfd_emul_get_commonpagesize (const char *emul)
1780 const bfd_target *target;
1782 target = bfd_find_target (emul, NULL);
1784 && target->flavour == bfd_target_elf_flavour)
1785 return xvec_get_elf_backend_data (target)->commonpagesize;
1792 bfd_emul_set_commonpagesize
1795 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1798 For ELF, set the common page size for the emulation. It is
1799 a no-op for other formats.
1804 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1806 const bfd_target *target;
1808 target = bfd_find_target (emul, NULL);
1810 bfd_elf_set_pagesize (target, size,
1811 offsetof (struct elf_backend_data,
1812 commonpagesize), target);
1820 char *bfd_demangle (bfd *, const char *, int);
1823 Wrapper around cplus_demangle. Strips leading underscores and
1824 other such chars that would otherwise confuse the demangler.
1825 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1826 with malloc holding the demangled name. Returns NULL otherwise
1827 and on memory alloc failure.
1831 bfd_demangle (bfd *abfd, const char *name, int options)
1834 const char *pre, *suf;
1836 bfd_boolean skip_lead;
1838 skip_lead = (abfd != NULL
1840 && bfd_get_symbol_leading_char (abfd) == *name);
1844 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1845 or the MS PE format. These formats have a number of leading '.'s
1846 on at least some symbols, so we remove all dots to avoid
1847 confusing the demangler. */
1849 while (*name == '.' || *name == '$')
1851 pre_len = name - pre;
1853 /* Strip off @plt and suchlike too. */
1855 suf = strchr (name, '@');
1858 alloc = (char *) bfd_malloc (suf - name + 1);
1861 memcpy (alloc, name, suf - name);
1862 alloc[suf - name] = '\0';
1866 res = cplus_demangle (name, options);
1875 size_t len = strlen (pre) + 1;
1876 alloc = (char *) bfd_malloc (len);
1879 memcpy (alloc, pre, len);
1885 /* Put back any prefix or suffix. */
1886 if (pre_len != 0 || suf != NULL)
1895 suf_len = strlen (suf) + 1;
1896 final = (char *) bfd_malloc (pre_len + len + suf_len);
1899 memcpy (final, pre, pre_len);
1900 memcpy (final + pre_len, res, len);
1901 memcpy (final + pre_len + len, suf, suf_len);