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
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.
40 . {* A unique identifier of the BFD *}
43 . {* The filename the application opened the BFD with. *}
44 . const char *filename;
46 . {* A pointer to the target jump table. *}
47 . const struct bfd_target *xvec;
49 . {* The IOSTREAM, and corresponding IO vector that provide access
50 . to the file backing the BFD. *}
52 . const struct bfd_iovec *iovec;
54 . {* The caching routines use these to maintain a
55 . least-recently-used list of BFDs. *}
56 . struct bfd *lru_prev, *lru_next;
58 . {* When a file is closed by the caching routines, BFD retains
59 . state information on the file here... *}
62 . {* File modified time, if mtime_set is TRUE. *}
65 . {* Reserved for an unimplemented file locking extension. *}
68 . {* The format which belongs to the BFD. (object, core, etc.) *}
71 . {* The direction with which the BFD was opened. *}
76 . write_direction = 2,
81 . {* Format_specific flags. *}
84 . {* Values that may appear in the flags field of a BFD. These also
85 . appear in the object_flags field of the bfd_target structure, where
86 . they indicate the set of flags used by that backend (not all flags
87 . are meaningful for all object file formats) (FIXME: at the moment,
88 . the object_flags values have mostly just been copied from backend
89 . to another, and are not necessarily correct). *}
91 .#define BFD_NO_FLAGS 0x00
93 . {* BFD contains relocation entries. *}
94 .#define HAS_RELOC 0x01
96 . {* BFD is directly executable. *}
99 . {* BFD has line number information (basically used for F_LNNO in a
101 .#define HAS_LINENO 0x04
103 . {* BFD has debugging information. *}
104 .#define HAS_DEBUG 0x08
106 . {* BFD has symbols. *}
107 .#define HAS_SYMS 0x10
109 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
111 .#define HAS_LOCALS 0x20
113 . {* BFD is a dynamic object. *}
114 .#define DYNAMIC 0x40
116 . {* Text section is write protected (if D_PAGED is not set, this is
117 . like an a.out NMAGIC file) (the linker sets this by default, but
118 . clears it for -r or -N). *}
119 .#define WP_TEXT 0x80
121 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
122 . linker sets this by default, but clears it for -r or -n or -N). *}
123 .#define D_PAGED 0x100
125 . {* BFD is relaxable (this means that bfd_relax_section may be able to
126 . do something) (sometimes bfd_relax_section can do something even if
127 . this is not set). *}
128 .#define BFD_IS_RELAXABLE 0x200
130 . {* This may be set before writing out a BFD to request using a
131 . traditional format. For example, this is used to request that when
132 . writing out an a.out object the symbols not be hashed to eliminate
134 .#define BFD_TRADITIONAL_FORMAT 0x400
136 . {* This flag indicates that the BFD contents are actually cached
137 . in memory. If this is set, iostream points to a bfd_in_memory
139 .#define BFD_IN_MEMORY 0x800
141 . {* The sections in this BFD specify a memory page. *}
142 .#define HAS_LOAD_PAGE 0x1000
144 . {* This BFD has been created by the linker and doesn't correspond
145 . to any input file. *}
146 .#define BFD_LINKER_CREATED 0x2000
148 . {* This may be set before writing out a BFD to request that it
149 . be written using values for UIDs, GIDs, timestamps, etc. that
150 . will be consistent from run to run. *}
151 .#define BFD_DETERMINISTIC_OUTPUT 0x4000
153 . {* Currently my_archive is tested before adding origin to
154 . anything. I believe that this can become always an add of
155 . origin, with origin set to 0 for non archive files. *}
158 . {* The origin in the archive of the proxy entry. This will
159 . normally be the same as origin, except for thin archives,
160 . when it will contain the current offset of the proxy in the
161 . thin archive rather than the offset of the bfd in its actual
163 . ufile_ptr proxy_origin;
165 . {* A hash table for section names. *}
166 . struct bfd_hash_table section_htab;
168 . {* Pointer to linked list of sections. *}
169 . struct bfd_section *sections;
171 . {* The last section on the section list. *}
172 . struct bfd_section *section_last;
174 . {* The number of sections. *}
175 . unsigned int section_count;
177 . {* Stuff only useful for object files:
178 . The start address. *}
179 . bfd_vma start_address;
181 . {* Used for input and output. *}
182 . unsigned int symcount;
184 . {* Symbol table for output BFD (with symcount entries).
185 . Also used by the linker to cache input BFD symbols. *}
186 . struct bfd_symbol **outsymbols;
188 . {* Used for slurped dynamic symbol tables. *}
189 . unsigned int dynsymcount;
191 . {* Pointer to structure which contains architecture information. *}
192 . const struct bfd_arch_info *arch_info;
194 . {* Stuff only useful for archives. *}
196 . struct bfd *my_archive; {* The containing archive BFD. *}
197 . struct bfd *archive_next; {* The next BFD in the archive. *}
198 . struct bfd *archive_head; {* The first BFD in the archive. *}
199 . struct bfd *nested_archives; {* List of nested archive in a flattened
202 . {* A chain of BFD structures involved in a link. *}
203 . struct bfd *link_next;
205 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
206 . be used only for archive elements. *}
209 . {* Used by the back end to hold private data. *}
212 . struct aout_data_struct *aout_data;
213 . struct artdata *aout_ar_data;
214 . struct _oasys_data *oasys_obj_data;
215 . struct _oasys_ar_data *oasys_ar_data;
216 . struct coff_tdata *coff_obj_data;
217 . struct pe_tdata *pe_obj_data;
218 . struct xcoff_tdata *xcoff_obj_data;
219 . struct ecoff_tdata *ecoff_obj_data;
220 . struct ieee_data_struct *ieee_data;
221 . struct ieee_ar_data_struct *ieee_ar_data;
222 . struct srec_data_struct *srec_data;
223 . struct verilog_data_struct *verilog_data;
224 . struct ihex_data_struct *ihex_data;
225 . struct tekhex_data_struct *tekhex_data;
226 . struct elf_obj_tdata *elf_obj_data;
227 . struct nlm_obj_tdata *nlm_obj_data;
228 . struct bout_data_struct *bout_data;
229 . struct mmo_data_struct *mmo_data;
230 . struct sun_core_struct *sun_core_data;
231 . struct sco5_core_struct *sco5_core_data;
232 . struct trad_core_struct *trad_core_data;
233 . struct som_data_struct *som_data;
234 . struct hpux_core_struct *hpux_core_data;
235 . struct hppabsd_core_struct *hppabsd_core_data;
236 . struct sgi_core_struct *sgi_core_data;
237 . struct lynx_core_struct *lynx_core_data;
238 . struct osf_core_struct *osf_core_data;
239 . struct cisco_core_struct *cisco_core_data;
240 . struct versados_data_struct *versados_data;
241 . struct netbsd_core_struct *netbsd_core_data;
242 . struct mach_o_data_struct *mach_o_data;
243 . struct mach_o_fat_data_struct *mach_o_fat_data;
244 . struct bfd_pef_data_struct *pef_data;
245 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
246 . struct bfd_sym_data_struct *sym_data;
251 . {* Used by the application to hold private data. *}
254 . {* Where all the allocated stuff under this BFD goes. This is a
255 . struct objalloc *, but we use void * to avoid requiring the inclusion
259 . {* Is the file descriptor being cached? That is, can it be closed as
260 . needed, and re-opened when accessed later? *}
261 . unsigned int cacheable : 1;
263 . {* Marks whether there was a default target specified when the
264 . BFD was opened. This is used to select which matching algorithm
265 . to use to choose the back end. *}
266 . unsigned int target_defaulted : 1;
268 . {* ... and here: (``once'' means at least once). *}
269 . unsigned int opened_once : 1;
271 . {* Set if we have a locally maintained mtime value, rather than
272 . getting it from the file each time. *}
273 . unsigned int mtime_set : 1;
275 . {* Flag set if symbols from this BFD should not be exported. *}
276 . unsigned int no_export : 1;
278 . {* Remember when output has begun, to stop strange things
280 . unsigned int output_has_begun : 1;
282 . {* Have archive map. *}
283 . unsigned int has_armap : 1;
285 . {* Set if this is a thin archive. *}
286 . unsigned int is_thin_archive : 1;
295 #include "libiberty.h"
296 #include "demangle.h"
297 #include "safe-ctype.h"
300 #include "coff/internal.h"
301 #include "coff/sym.h"
303 #include "libecoff.h"
308 #define EXIT_FAILURE 1
312 /* provide storage for subsystem, stack and heap data which may have been
313 passed in on the command line. Ld puts this data into a bfd_link_info
314 struct which ultimately gets passed in to the bfd. When it arrives, copy
315 it to the following struct so that the data will be available in coffcode.h
316 where it is needed. The typedef's used are defined in bfd.h */
322 Most BFD functions return nonzero on success (check their
323 individual documentation for precise semantics). On an error,
324 they call <<bfd_set_error>> to set an error condition that callers
325 can check by calling <<bfd_get_error>>.
326 If that returns <<bfd_error_system_call>>, then check
329 The easiest way to report a BFD error to the user is to
333 Type <<bfd_error_type>>
335 The values returned by <<bfd_get_error>> are defined by the
336 enumerated type <<bfd_error_type>>.
340 .typedef enum bfd_error
342 . bfd_error_no_error = 0,
343 . bfd_error_system_call,
344 . bfd_error_invalid_target,
345 . bfd_error_wrong_format,
346 . bfd_error_wrong_object_format,
347 . bfd_error_invalid_operation,
348 . bfd_error_no_memory,
349 . bfd_error_no_symbols,
350 . bfd_error_no_armap,
351 . bfd_error_no_more_archived_files,
352 . bfd_error_malformed_archive,
353 . bfd_error_file_not_recognized,
354 . bfd_error_file_ambiguously_recognized,
355 . bfd_error_no_contents,
356 . bfd_error_nonrepresentable_section,
357 . bfd_error_no_debug_section,
358 . bfd_error_bad_value,
359 . bfd_error_file_truncated,
360 . bfd_error_file_too_big,
361 . bfd_error_on_input,
362 . bfd_error_invalid_error_code
368 static bfd_error_type bfd_error
= bfd_error_no_error
;
369 static bfd
*input_bfd
= NULL
;
370 static bfd_error_type input_error
= bfd_error_no_error
;
372 const char *const bfd_errmsgs
[] =
375 N_("System call error"),
376 N_("Invalid bfd target"),
377 N_("File in wrong format"),
378 N_("Archive object file in wrong format"),
379 N_("Invalid operation"),
380 N_("Memory exhausted"),
382 N_("Archive has no index; run ranlib to add one"),
383 N_("No more archived files"),
384 N_("Malformed archive"),
385 N_("File format not recognized"),
386 N_("File format is ambiguous"),
387 N_("Section has no contents"),
388 N_("Nonrepresentable section on output"),
389 N_("Symbol needs debug section which does not exist"),
391 N_("File truncated"),
393 N_("Error reading %s: %s"),
394 N_("#<Invalid error code>")
402 bfd_error_type bfd_get_error (void);
405 Return the current BFD error condition.
419 void bfd_set_error (bfd_error_type error_tag, ...);
422 Set the BFD error condition to be @var{error_tag}.
423 If @var{error_tag} is bfd_error_on_input, then this function
424 takes two more parameters, the input bfd where the error
425 occurred, and the bfd_error_type error.
429 bfd_set_error (bfd_error_type error_tag
, ...)
431 bfd_error
= error_tag
;
432 if (error_tag
== bfd_error_on_input
)
434 /* This is an error that occurred during bfd_close when
435 writing an archive, but on one of the input files. */
438 va_start (ap
, error_tag
);
439 input_bfd
= va_arg (ap
, bfd
*);
440 input_error
= va_arg (ap
, int);
441 if (input_error
>= bfd_error_on_input
)
452 const char *bfd_errmsg (bfd_error_type error_tag);
455 Return a string describing the error @var{error_tag}, or
456 the system error if @var{error_tag} is <<bfd_error_system_call>>.
460 bfd_errmsg (bfd_error_type error_tag
)
465 if (error_tag
== bfd_error_on_input
)
468 const char *msg
= bfd_errmsg (input_error
);
470 if (asprintf (&buf
, _(bfd_errmsgs
[error_tag
]), input_bfd
->filename
, msg
)
474 /* Ick, what to do on out of memory? */
478 if (error_tag
== bfd_error_system_call
)
479 return xstrerror (errno
);
481 if (error_tag
> bfd_error_invalid_error_code
)
482 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
484 return _(bfd_errmsgs
[error_tag
]);
492 void bfd_perror (const char *message);
495 Print to the standard error stream a string describing the
496 last BFD error that occurred, or the last system error if
497 the last BFD error was a system call failure. If @var{message}
498 is non-NULL and non-empty, the error string printed is preceded
499 by @var{message}, a colon, and a space. It is followed by a newline.
503 bfd_perror (const char *message
)
505 if (message
== NULL
|| *message
== '\0')
506 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
508 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
515 Some BFD functions want to print messages describing the
516 problem. They call a BFD error handler function. This
517 function may be overridden by the program.
519 The BFD error handler acts like printf.
523 .typedef void (*bfd_error_handler_type) (const char *, ...);
527 /* The program name used when printing BFD error messages. */
529 static const char *_bfd_error_program_name
;
531 /* This is the default routine to handle BFD error messages.
532 Like fprintf (stderr, ...), but also handles some extra format specifiers.
534 %A section name from section. For group components, print group name too.
535 %B file name from bfd. For archive components, prints archive too.
537 Note - because these two extra format specifiers require special handling
538 they are scanned for and processed in this function, before calling
539 vfprintf. This means that the *arguments* for these format specifiers
540 must be the first ones in the variable argument list, regardless of where
541 the specifiers appear in the format string. Thus for example calling
542 this function with a format string of:
544 "blah %s blah %A blah %d blah %B"
546 would involve passing the arguments as:
548 "blah %s blah %A blah %d blah %B",
556 _bfd_default_error_handler (const char *fmt
, ...)
560 const char *new_fmt
, *p
;
564 /* PR 4992: Don't interrupt output being sent to stdout. */
567 if (_bfd_error_program_name
!= NULL
)
568 fprintf (stderr
, "%s: ", _bfd_error_program_name
);
570 fprintf (stderr
, "BFD: ");
576 /* Reserve enough space for the existing format string. */
577 avail
-= strlen (fmt
) + 1;
579 _exit (EXIT_FAILURE
);
585 size_t len
, extra
, trim
;
588 if (p
== NULL
|| p
[1] == '\0')
593 memcpy (bufp
, fmt
, len
+ 1);
598 if (p
[1] == 'A' || p
[1] == 'B')
601 memcpy (bufp
, fmt
, len
);
606 /* If we run out of space, tough, you lose your ridiculously
607 long file or section name. It's not safe to try to alloc
608 memory here; We might be printing an out of memory message. */
619 bfd
*abfd
= va_arg (ap
, bfd
*);
622 /* Invoking %B with a null bfd pointer is an internal error. */
624 else if (abfd
->my_archive
)
625 snprintf (bufp
, avail
, "%s(%s)",
626 abfd
->my_archive
->filename
, abfd
->filename
);
628 snprintf (bufp
, avail
, "%s", abfd
->filename
);
632 asection
*sec
= va_arg (ap
, asection
*);
634 const char *group
= NULL
;
635 struct coff_comdat_info
*ci
;
638 /* Invoking %A with a null section pointer is an internal error. */
642 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
643 && elf_next_in_group (sec
) != NULL
644 && (sec
->flags
& SEC_GROUP
) == 0)
645 group
= elf_group_name (sec
);
646 else if (abfd
!= NULL
647 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
648 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
652 snprintf (bufp
, avail
, "%s[%s]", sec
->name
, group
);
654 snprintf (bufp
, avail
, "%s", sec
->name
);
657 avail
= avail
- len
+ 2;
659 /* We need to replace any '%' we printed by "%%".
660 First count how many. */
664 while ((q
= strchr (q
, '%')) != NULL
)
670 /* If there isn't room, trim off the end of the string. */
675 trim
= extra
- avail
;
688 /* Now double all '%' chars, shuffling the string as we go. */
691 while ((q
[extra
] = *q
) != '%')
701 vfprintf (stderr
, new_fmt
, ap
);
707 /* This is a function pointer to the routine which should handle BFD
708 error messages. It is called when a BFD routine encounters an
709 error for which it wants to print a message. Going through a
710 function pointer permits a program linked against BFD to intercept
711 the messages and deal with them itself. */
713 bfd_error_handler_type _bfd_error_handler
= _bfd_default_error_handler
;
717 bfd_set_error_handler
720 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
723 Set the BFD error handler function. Returns the previous
727 bfd_error_handler_type
728 bfd_set_error_handler (bfd_error_handler_type pnew
)
730 bfd_error_handler_type pold
;
732 pold
= _bfd_error_handler
;
733 _bfd_error_handler
= pnew
;
739 bfd_set_error_program_name
742 void bfd_set_error_program_name (const char *);
745 Set the program name to use when printing a BFD error. This
746 is printed before the error message followed by a colon and
747 space. The string must not be changed after it is passed to
752 bfd_set_error_program_name (const char *name
)
754 _bfd_error_program_name
= name
;
759 bfd_get_error_handler
762 bfd_error_handler_type bfd_get_error_handler (void);
765 Return the BFD error handler function.
768 bfd_error_handler_type
769 bfd_get_error_handler (void)
771 return _bfd_error_handler
;
779 Miscellaneous functions
784 bfd_get_reloc_upper_bound
787 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
790 Return the number of bytes required to store the
791 relocation information associated with section @var{sect}
792 attached to bfd @var{abfd}. If an error occurs, return -1.
797 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
799 if (abfd
->format
!= bfd_object
)
801 bfd_set_error (bfd_error_invalid_operation
);
805 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
810 bfd_canonicalize_reloc
813 long bfd_canonicalize_reloc
814 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
817 Call the back end associated with the open BFD
818 @var{abfd} and translate the external form of the relocation
819 information attached to @var{sec} into the internal canonical
820 form. Place the table into memory at @var{loc}, which has
821 been preallocated, usually by a call to
822 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
825 The @var{syms} table is also needed for horrible internal magic
830 bfd_canonicalize_reloc (bfd
*abfd
,
835 if (abfd
->format
!= bfd_object
)
837 bfd_set_error (bfd_error_invalid_operation
);
841 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
842 (abfd
, asect
, location
, symbols
));
851 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
854 Set the relocation pointer and count within
855 section @var{sec} to the values @var{rel} and @var{count}.
856 The argument @var{abfd} is ignored.
861 bfd_set_reloc (bfd
*ignore_abfd ATTRIBUTE_UNUSED
,
866 asect
->orelocation
= location
;
867 asect
->reloc_count
= count
;
875 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
878 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
881 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
882 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
883 o <<bfd_error_invalid_operation>> -
884 The flag word contained a bit which was not applicable to the
885 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
886 on a BFD format which does not support demand paging.
891 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
893 if (abfd
->format
!= bfd_object
)
895 bfd_set_error (bfd_error_wrong_format
);
899 if (bfd_read_p (abfd
))
901 bfd_set_error (bfd_error_invalid_operation
);
905 bfd_get_file_flags (abfd
) = flags
;
906 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
908 bfd_set_error (bfd_error_invalid_operation
);
916 bfd_assert (const char *file
, int line
)
918 (*_bfd_error_handler
) (_("BFD %s assertion fail %s:%d"),
919 BFD_VERSION_STRING
, file
, line
);
922 /* A more or less friendly abort message. In libbfd.h abort is
923 defined to call this function. */
926 _bfd_abort (const char *file
, int line
, const char *fn
)
929 (*_bfd_error_handler
)
930 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
931 BFD_VERSION_STRING
, file
, line
, fn
);
933 (*_bfd_error_handler
)
934 (_("BFD %s internal error, aborting at %s line %d\n"),
935 BFD_VERSION_STRING
, file
, line
);
936 (*_bfd_error_handler
) (_("Please report this bug.\n"));
937 _exit (EXIT_FAILURE
);
945 int bfd_get_arch_size (bfd *abfd);
948 Returns the architecture address size, in bits, as determined
949 by the object file's format. For ELF, this information is
950 included in the header.
953 Returns the arch size in bits if known, <<-1>> otherwise.
957 bfd_get_arch_size (bfd
*abfd
)
959 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
960 return get_elf_backend_data (abfd
)->s
->arch_size
;
967 bfd_get_sign_extend_vma
970 int bfd_get_sign_extend_vma (bfd *abfd);
973 Indicates if the target architecture "naturally" sign extends
974 an address. Some architectures implicitly sign extend address
975 values when they are converted to types larger than the size
976 of an address. For instance, bfd_get_start_address() will
977 return an address sign extended to fill a bfd_vma when this is
981 Returns <<1>> if the target architecture is known to sign
982 extend addresses, <<0>> if the target architecture is known to
983 not sign extend addresses, and <<-1>> otherwise.
987 bfd_get_sign_extend_vma (bfd
*abfd
)
991 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
992 return get_elf_backend_data (abfd
)->sign_extend_vma
;
994 name
= bfd_get_target (abfd
);
996 /* Return a proper value for DJGPP & PE COFF.
997 This function is required for DWARF2 support, but there is
998 no place to store this information in the COFF back end.
999 Should enough other COFF targets add support for DWARF2,
1000 a place will have to be found. Until then, this hack will do. */
1001 if (CONST_STRNEQ (name
, "coff-go32")
1002 || strcmp (name
, "pe-i386") == 0
1003 || strcmp (name
, "pei-i386") == 0
1004 || strcmp (name
, "pe-x86-64") == 0
1005 || strcmp (name
, "pei-x86-64") == 0
1006 || strcmp (name
, "pe-arm-wince-little") == 0
1007 || strcmp (name
, "pei-arm-wince-little") == 0)
1010 if (CONST_STRNEQ (name
, "mach-o"))
1013 bfd_set_error (bfd_error_wrong_format
);
1019 bfd_set_start_address
1022 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1025 Make @var{vma} the entry point of output BFD @var{abfd}.
1028 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1032 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
1034 abfd
->start_address
= vma
;
1043 unsigned int bfd_get_gp_size (bfd *abfd);
1046 Return the maximum size of objects to be optimized using the GP
1047 register under MIPS ECOFF. This is typically set by the <<-G>>
1048 argument to the compiler, assembler or linker.
1052 bfd_get_gp_size (bfd
*abfd
)
1054 if (abfd
->format
== bfd_object
)
1056 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1057 return ecoff_data (abfd
)->gp_size
;
1058 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1059 return elf_gp_size (abfd
);
1069 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1072 Set the maximum size of objects to be optimized using the GP
1073 register under ECOFF or MIPS ELF. This is typically set by
1074 the <<-G>> argument to the compiler, assembler or linker.
1078 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
1080 /* Don't try to set GP size on an archive or core file! */
1081 if (abfd
->format
!= bfd_object
)
1084 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1085 ecoff_data (abfd
)->gp_size
= i
;
1086 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1087 elf_gp_size (abfd
) = i
;
1090 /* Get the GP value. This is an internal function used by some of the
1091 relocation special_function routines on targets which support a GP
1095 _bfd_get_gp_value (bfd
*abfd
)
1099 if (abfd
->format
!= bfd_object
)
1102 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1103 return ecoff_data (abfd
)->gp
;
1104 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1105 return elf_gp (abfd
);
1110 /* Set the GP value. */
1113 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
1117 if (abfd
->format
!= bfd_object
)
1120 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1121 ecoff_data (abfd
)->gp
= v
;
1122 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1131 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1134 Convert, like <<strtoul>>, a numerical expression
1135 @var{string} into a <<bfd_vma>> integer, and return that integer.
1136 (Though without as many bells and whistles as <<strtoul>>.)
1137 The expression is assumed to be unsigned (i.e., positive).
1138 If given a @var{base}, it is used as the base for conversion.
1139 A base of 0 causes the function to interpret the string
1140 in hex if a leading "0x" or "0X" is found, otherwise
1141 in octal if a leading zero is found, otherwise in decimal.
1143 If the value would overflow, the maximum <<bfd_vma>> value is
1148 bfd_scan_vma (const char *string
, const char **end
, int base
)
1152 unsigned int cutlim
;
1155 /* Let the host do it if possible. */
1156 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
1157 return strtoul (string
, (char **) end
, base
);
1159 #ifdef HAVE_STRTOULL
1160 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
1161 return strtoull (string
, (char **) end
, base
);
1166 if (string
[0] == '0')
1168 if ((string
[1] == 'x') || (string
[1] == 'X'))
1175 if ((base
< 2) || (base
> 36))
1180 && (string
[1] == 'x' || string
[1] == 'X')
1181 && ISXDIGIT (string
[2]))
1186 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
1187 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
1195 if (ISDIGIT (digit
))
1196 digit
= digit
- '0';
1197 else if (ISALPHA (digit
))
1198 digit
= TOUPPER (digit
) - 'A' + 10;
1201 if (digit
>= (unsigned int) base
)
1203 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
1205 value
= value
* base
+ digit
;
1210 value
= ~ (bfd_vma
) 0;
1220 bfd_copy_private_header_data
1223 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1226 Copy private BFD header information from the BFD @var{ibfd} to the
1227 the BFD @var{obfd}. This copies information that may require
1228 sections to exist, but does not require symbol tables. Return
1229 <<true>> on success, <<false>> on error.
1230 Possible error returns are:
1232 o <<bfd_error_no_memory>> -
1233 Not enough memory exists to create private data for @var{obfd}.
1235 .#define bfd_copy_private_header_data(ibfd, obfd) \
1236 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1243 bfd_copy_private_bfd_data
1246 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1249 Copy private BFD information from the BFD @var{ibfd} to the
1250 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1251 Possible error returns are:
1253 o <<bfd_error_no_memory>> -
1254 Not enough memory exists to create private data for @var{obfd}.
1256 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1257 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1264 bfd_merge_private_bfd_data
1267 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1270 Merge private BFD information from the BFD @var{ibfd} to the
1271 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1272 on success, <<FALSE>> on error. Possible error returns are:
1274 o <<bfd_error_no_memory>> -
1275 Not enough memory exists to create private data for @var{obfd}.
1277 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1278 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1285 bfd_set_private_flags
1288 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1291 Set private BFD flag information in the BFD @var{abfd}.
1292 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1295 o <<bfd_error_no_memory>> -
1296 Not enough memory exists to create private data for @var{obfd}.
1298 .#define bfd_set_private_flags(abfd, flags) \
1299 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1308 The following functions exist but have not yet been documented.
1310 .#define bfd_sizeof_headers(abfd, info) \
1311 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1313 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1314 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1315 . (abfd, sec, syms, off, file, func, line))
1317 .#define bfd_find_line(abfd, syms, sym, file, line) \
1318 . BFD_SEND (abfd, _bfd_find_line, \
1319 . (abfd, syms, sym, file, line))
1321 .#define bfd_find_inliner_info(abfd, file, func, line) \
1322 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1323 . (abfd, file, func, line))
1325 .#define bfd_debug_info_start(abfd) \
1326 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1328 .#define bfd_debug_info_end(abfd) \
1329 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1331 .#define bfd_debug_info_accumulate(abfd, section) \
1332 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1334 .#define bfd_stat_arch_elt(abfd, stat) \
1335 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1337 .#define bfd_update_armap_timestamp(abfd) \
1338 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1340 .#define bfd_set_arch_mach(abfd, arch, mach)\
1341 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1343 .#define bfd_relax_section(abfd, section, link_info, again) \
1344 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1346 .#define bfd_gc_sections(abfd, link_info) \
1347 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1349 .#define bfd_merge_sections(abfd, link_info) \
1350 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1352 .#define bfd_is_group_section(abfd, sec) \
1353 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1355 .#define bfd_discard_group(abfd, sec) \
1356 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1358 .#define bfd_link_hash_table_create(abfd) \
1359 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1361 .#define bfd_link_hash_table_free(abfd, hash) \
1362 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1364 .#define bfd_link_add_symbols(abfd, info) \
1365 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1367 .#define bfd_link_just_syms(abfd, sec, info) \
1368 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1370 .#define bfd_final_link(abfd, info) \
1371 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1373 .#define bfd_free_cached_info(abfd) \
1374 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1376 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1377 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1379 .#define bfd_print_private_bfd_data(abfd, file)\
1380 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1382 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1383 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1385 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1386 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1387 . dyncount, dynsyms, ret))
1389 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1390 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1392 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1393 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1395 .extern bfd_byte *bfd_get_relocated_section_contents
1396 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1397 . bfd_boolean, asymbol **);
1403 bfd_get_relocated_section_contents (bfd
*abfd
,
1404 struct bfd_link_info
*link_info
,
1405 struct bfd_link_order
*link_order
,
1407 bfd_boolean relocatable
,
1411 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
1412 bfd_byte
*, bfd_boolean
, asymbol
**);
1414 if (link_order
->type
== bfd_indirect_link_order
)
1416 abfd2
= link_order
->u
.indirect
.section
->owner
;
1423 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
1425 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
1428 /* Record information about an ELF program header. */
1431 bfd_record_phdr (bfd
*abfd
,
1433 bfd_boolean flags_valid
,
1435 bfd_boolean at_valid
,
1437 bfd_boolean includes_filehdr
,
1438 bfd_boolean includes_phdrs
,
1442 struct elf_segment_map
*m
, **pm
;
1445 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
1448 amt
= sizeof (struct elf_segment_map
);
1449 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
1450 m
= bfd_zalloc (abfd
, amt
);
1457 m
->p_flags_valid
= flags_valid
;
1458 m
->p_paddr_valid
= at_valid
;
1459 m
->includes_filehdr
= includes_filehdr
;
1460 m
->includes_phdrs
= includes_phdrs
;
1463 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
1465 for (pm
= &elf_tdata (abfd
)->segment_map
; *pm
!= NULL
; pm
= &(*pm
)->next
)
1473 /* Return true iff this target is 32-bit. */
1478 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1480 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
1481 return bed
->s
->elfclass
== ELFCLASS32
;
1484 /* For non-ELF targets, use architecture information. */
1485 return bfd_arch_bits_per_address (abfd
) <= 32;
1489 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1490 target's address size. */
1493 bfd_sprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, char *buf
, bfd_vma value
)
1498 sprintf (buf
, "%08lx", (unsigned long) value
& 0xffffffff);
1502 sprintf_vma (buf
, value
);
1506 bfd_fprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, void *stream
, bfd_vma value
)
1511 fprintf ((FILE *) stream
, "%08lx", (unsigned long) value
& 0xffffffff);
1515 fprintf_vma ((FILE *) stream
, value
);
1523 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1527 When more than one machine code number is available for the
1528 same machine type, this function can be used to switch between
1529 the preferred one (alternative == 0) and any others. Currently,
1530 only ELF supports this feature, with up to two alternate
1535 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
1537 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1541 switch (alternative
)
1544 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
1548 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
1554 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
1563 elf_elfheader (abfd
)->e_machine
= code
;
1574 .struct bfd_preserve
1579 . const struct bfd_arch_info *arch_info;
1580 . struct bfd_section *sections;
1581 . struct bfd_section *section_last;
1582 . unsigned int section_count;
1583 . struct bfd_hash_table section_htab;
1593 bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1596 When testing an object for compatibility with a particular
1597 target back-end, the back-end object_p function needs to set
1598 up certain fields in the bfd on successfully recognizing the
1599 object. This typically happens in a piecemeal fashion, with
1600 failures possible at many points. On failure, the bfd is
1601 supposed to be restored to its initial state, which is
1602 virtually impossible. However, restoring a subset of the bfd
1603 state works in practice. This function stores the subset and
1604 reinitializes the bfd.
1609 bfd_preserve_save (bfd
*abfd
, struct bfd_preserve
*preserve
)
1611 preserve
->tdata
= abfd
->tdata
.any
;
1612 preserve
->arch_info
= abfd
->arch_info
;
1613 preserve
->flags
= abfd
->flags
;
1614 preserve
->sections
= abfd
->sections
;
1615 preserve
->section_last
= abfd
->section_last
;
1616 preserve
->section_count
= abfd
->section_count
;
1617 preserve
->section_htab
= abfd
->section_htab
;
1619 if (! bfd_hash_table_init (&abfd
->section_htab
, bfd_section_hash_newfunc
,
1620 sizeof (struct section_hash_entry
)))
1623 abfd
->tdata
.any
= NULL
;
1624 abfd
->arch_info
= &bfd_default_arch_struct
;
1625 abfd
->flags
&= BFD_IN_MEMORY
;
1626 abfd
->sections
= NULL
;
1627 abfd
->section_last
= NULL
;
1628 abfd
->section_count
= 0;
1635 bfd_preserve_restore
1638 void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1641 This function restores bfd state saved by bfd_preserve_save.
1642 If MARKER is non-NULL in struct bfd_preserve then that block
1643 and all subsequently bfd_alloc'd memory is freed.
1648 bfd_preserve_restore (bfd
*abfd
, struct bfd_preserve
*preserve
)
1650 bfd_hash_table_free (&abfd
->section_htab
);
1652 abfd
->tdata
.any
= preserve
->tdata
;
1653 abfd
->arch_info
= preserve
->arch_info
;
1654 abfd
->flags
= preserve
->flags
;
1655 abfd
->section_htab
= preserve
->section_htab
;
1656 abfd
->sections
= preserve
->sections
;
1657 abfd
->section_last
= preserve
->section_last
;
1658 abfd
->section_count
= preserve
->section_count
;
1660 /* bfd_release frees all memory more recently bfd_alloc'd than
1661 its arg, as well as its arg. */
1662 if (preserve
->marker
!= NULL
)
1664 bfd_release (abfd
, preserve
->marker
);
1665 preserve
->marker
= NULL
;
1674 void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1677 This function should be called when the bfd state saved by
1678 bfd_preserve_save is no longer needed. ie. when the back-end
1679 object_p function returns with success.
1684 bfd_preserve_finish (bfd
*abfd ATTRIBUTE_UNUSED
, struct bfd_preserve
*preserve
)
1686 /* It would be nice to be able to free more memory here, eg. old
1687 tdata, but that's not possible since these blocks are sitting
1688 inside bfd_alloc'd memory. The section hash is on a separate
1690 bfd_hash_table_free (&preserve
->section_htab
);
1695 bfd_emul_get_maxpagesize
1698 bfd_vma bfd_emul_get_maxpagesize (const char *);
1701 Returns the maximum page size, in bytes, as determined by
1705 Returns the maximum page size in bytes for ELF, abort
1710 bfd_emul_get_maxpagesize (const char *emul
)
1712 const bfd_target
*target
;
1714 target
= bfd_find_target (emul
, NULL
);
1716 && target
->flavour
== bfd_target_elf_flavour
)
1717 return xvec_get_elf_backend_data (target
)->maxpagesize
;
1724 bfd_elf_set_pagesize (const bfd_target
*target
, bfd_vma size
,
1725 int offset
, const bfd_target
*orig_target
)
1727 if (target
->flavour
== bfd_target_elf_flavour
)
1729 const struct elf_backend_data
*bed
;
1731 bed
= xvec_get_elf_backend_data (target
);
1732 *((bfd_vma
*) ((char *) bed
+ offset
)) = size
;
1735 if (target
->alternative_target
1736 && target
->alternative_target
!= orig_target
)
1737 bfd_elf_set_pagesize (target
->alternative_target
, size
, offset
,
1743 bfd_emul_set_maxpagesize
1746 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1749 For ELF, set the maximum page size for the emulation. It is
1750 a no-op for other formats.
1755 bfd_emul_set_maxpagesize (const char *emul
, bfd_vma size
)
1757 const bfd_target
*target
;
1759 target
= bfd_find_target (emul
, NULL
);
1761 bfd_elf_set_pagesize (target
, size
,
1762 offsetof (struct elf_backend_data
,
1763 maxpagesize
), target
);
1768 bfd_emul_get_commonpagesize
1771 bfd_vma bfd_emul_get_commonpagesize (const char *);
1774 Returns the common page size, in bytes, as determined by
1778 Returns the common page size in bytes for ELF, abort otherwise.
1782 bfd_emul_get_commonpagesize (const char *emul
)
1784 const bfd_target
*target
;
1786 target
= bfd_find_target (emul
, NULL
);
1788 && target
->flavour
== bfd_target_elf_flavour
)
1789 return xvec_get_elf_backend_data (target
)->commonpagesize
;
1797 bfd_emul_set_commonpagesize
1800 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1803 For ELF, set the common page size for the emulation. It is
1804 a no-op for other formats.
1809 bfd_emul_set_commonpagesize (const char *emul
, bfd_vma size
)
1811 const bfd_target
*target
;
1813 target
= bfd_find_target (emul
, NULL
);
1815 bfd_elf_set_pagesize (target
, size
,
1816 offsetof (struct elf_backend_data
,
1817 commonpagesize
), target
);
1825 char *bfd_demangle (bfd *, const char *, int);
1828 Wrapper around cplus_demangle. Strips leading underscores and
1829 other such chars that would otherwise confuse the demangler.
1830 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1831 with malloc holding the demangled name. Returns NULL otherwise
1832 and on memory alloc failure.
1836 bfd_demangle (bfd
*abfd
, const char *name
, int options
)
1839 const char *pre
, *suf
;
1841 bfd_boolean skip_lead
;
1843 skip_lead
= (abfd
!= NULL
1845 && bfd_get_symbol_leading_char (abfd
) == *name
);
1849 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1850 or the MS PE format. These formats have a number of leading '.'s
1851 on at least some symbols, so we remove all dots to avoid
1852 confusing the demangler. */
1854 while (*name
== '.' || *name
== '$')
1856 pre_len
= name
- pre
;
1858 /* Strip off @plt and suchlike too. */
1860 suf
= strchr (name
, '@');
1863 alloc
= bfd_malloc (suf
- name
+ 1);
1866 memcpy (alloc
, name
, suf
- name
);
1867 alloc
[suf
- name
] = '\0';
1871 res
= cplus_demangle (name
, options
);
1880 size_t len
= strlen (pre
) + 1;
1881 alloc
= bfd_malloc (len
);
1884 memcpy (alloc
, pre
, len
);
1890 /* Put back any prefix or suffix. */
1891 if (pre_len
!= 0 || suf
!= NULL
)
1900 suf_len
= strlen (suf
) + 1;
1901 final
= bfd_malloc (pre_len
+ len
+ suf_len
);
1904 memcpy (final
, pre
, pre_len
);
1905 memcpy (final
+ pre_len
, res
, len
);
1906 memcpy (final
+ pre_len
+ len
, suf
, suf_len
);