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
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 . {* Currently my_archive is tested before adding origin to
149 . anything. I believe that this can become always an add of
150 . origin, with origin set to 0 for non archive files. *}
153 . {* A hash table for section names. *}
154 . struct bfd_hash_table section_htab;
156 . {* Pointer to linked list of sections. *}
157 . struct bfd_section *sections;
159 . {* The last section on the section list. *}
160 . struct bfd_section *section_last;
162 . {* The number of sections. *}
163 . unsigned int section_count;
165 . {* Stuff only useful for object files:
166 . The start address. *}
167 . bfd_vma start_address;
169 . {* Used for input and output. *}
170 . unsigned int symcount;
172 . {* Symbol table for output BFD (with symcount entries). *}
173 . struct bfd_symbol **outsymbols;
175 . {* Used for slurped dynamic symbol tables. *}
176 . unsigned int dynsymcount;
178 . {* Pointer to structure which contains architecture information. *}
179 . const struct bfd_arch_info *arch_info;
181 . {* Stuff only useful for archives. *}
183 . struct bfd *my_archive; {* The containing archive BFD. *}
184 . struct bfd *archive_next; {* The next BFD in the archive. *}
185 . struct bfd *archive_head; {* The first BFD in the archive. *}
187 . {* A chain of BFD structures involved in a link. *}
188 . struct bfd *link_next;
190 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
191 . be used only for archive elements. *}
194 . {* Used by the back end to hold private data. *}
197 . struct aout_data_struct *aout_data;
198 . struct artdata *aout_ar_data;
199 . struct _oasys_data *oasys_obj_data;
200 . struct _oasys_ar_data *oasys_ar_data;
201 . struct coff_tdata *coff_obj_data;
202 . struct pe_tdata *pe_obj_data;
203 . struct xcoff_tdata *xcoff_obj_data;
204 . struct ecoff_tdata *ecoff_obj_data;
205 . struct ieee_data_struct *ieee_data;
206 . struct ieee_ar_data_struct *ieee_ar_data;
207 . struct srec_data_struct *srec_data;
208 . struct ihex_data_struct *ihex_data;
209 . struct tekhex_data_struct *tekhex_data;
210 . struct elf_obj_tdata *elf_obj_data;
211 . struct nlm_obj_tdata *nlm_obj_data;
212 . struct bout_data_struct *bout_data;
213 . struct mmo_data_struct *mmo_data;
214 . struct sun_core_struct *sun_core_data;
215 . struct sco5_core_struct *sco5_core_data;
216 . struct trad_core_struct *trad_core_data;
217 . struct som_data_struct *som_data;
218 . struct hpux_core_struct *hpux_core_data;
219 . struct hppabsd_core_struct *hppabsd_core_data;
220 . struct sgi_core_struct *sgi_core_data;
221 . struct lynx_core_struct *lynx_core_data;
222 . struct osf_core_struct *osf_core_data;
223 . struct cisco_core_struct *cisco_core_data;
224 . struct versados_data_struct *versados_data;
225 . struct netbsd_core_struct *netbsd_core_data;
226 . struct mach_o_data_struct *mach_o_data;
227 . struct mach_o_fat_data_struct *mach_o_fat_data;
228 . struct bfd_pef_data_struct *pef_data;
229 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
230 . struct bfd_sym_data_struct *sym_data;
235 . {* Used by the application to hold private data. *}
238 . {* Where all the allocated stuff under this BFD goes. This is a
239 . struct objalloc *, but we use void * to avoid requiring the inclusion
243 . {* Is the file descriptor being cached? That is, can it be closed as
244 . needed, and re-opened when accessed later? *}
245 . unsigned int cacheable : 1;
247 . {* Marks whether there was a default target specified when the
248 . BFD was opened. This is used to select which matching algorithm
249 . to use to choose the back end. *}
250 . unsigned int target_defaulted : 1;
252 . {* ... and here: (``once'' means at least once). *}
253 . unsigned int opened_once : 1;
255 . {* Set if we have a locally maintained mtime value, rather than
256 . getting it from the file each time. *}
257 . unsigned int mtime_set : 1;
259 . {* Flag set if symbols from this BFD should not be exported. *}
260 . unsigned int no_export : 1;
262 . {* Remember when output has begun, to stop strange things
264 . unsigned int output_has_begun : 1;
266 . {* Have archive map. *}
267 . unsigned int has_armap : 1;
276 #include "libiberty.h"
277 #include "demangle.h"
278 #include "safe-ctype.h"
281 #include "coff/internal.h"
282 #include "coff/sym.h"
284 #include "libecoff.h"
289 #define EXIT_FAILURE 1
293 /* provide storage for subsystem, stack and heap data which may have been
294 passed in on the command line. Ld puts this data into a bfd_link_info
295 struct which ultimately gets passed in to the bfd. When it arrives, copy
296 it to the following struct so that the data will be available in coffcode.h
297 where it is needed. The typedef's used are defined in bfd.h */
303 Most BFD functions return nonzero on success (check their
304 individual documentation for precise semantics). On an error,
305 they call <<bfd_set_error>> to set an error condition that callers
306 can check by calling <<bfd_get_error>>.
307 If that returns <<bfd_error_system_call>>, then check
310 The easiest way to report a BFD error to the user is to
314 Type <<bfd_error_type>>
316 The values returned by <<bfd_get_error>> are defined by the
317 enumerated type <<bfd_error_type>>.
321 .typedef enum bfd_error
323 . bfd_error_no_error = 0,
324 . bfd_error_system_call,
325 . bfd_error_invalid_target,
326 . bfd_error_wrong_format,
327 . bfd_error_wrong_object_format,
328 . bfd_error_invalid_operation,
329 . bfd_error_no_memory,
330 . bfd_error_no_symbols,
331 . bfd_error_no_armap,
332 . bfd_error_no_more_archived_files,
333 . bfd_error_malformed_archive,
334 . bfd_error_file_not_recognized,
335 . bfd_error_file_ambiguously_recognized,
336 . bfd_error_no_contents,
337 . bfd_error_nonrepresentable_section,
338 . bfd_error_no_debug_section,
339 . bfd_error_bad_value,
340 . bfd_error_file_truncated,
341 . bfd_error_file_too_big,
342 . bfd_error_on_input,
343 . bfd_error_invalid_error_code
349 static bfd_error_type bfd_error = bfd_error_no_error;
350 static bfd *input_bfd = NULL;
351 static bfd_error_type input_error = bfd_error_no_error;
353 const char *const bfd_errmsgs[] =
356 N_("System call error"),
357 N_("Invalid bfd target"),
358 N_("File in wrong format"),
359 N_("Archive object file in wrong format"),
360 N_("Invalid operation"),
361 N_("Memory exhausted"),
363 N_("Archive has no index; run ranlib to add one"),
364 N_("No more archived files"),
365 N_("Malformed archive"),
366 N_("File format not recognized"),
367 N_("File format is ambiguous"),
368 N_("Section has no contents"),
369 N_("Nonrepresentable section on output"),
370 N_("Symbol needs debug section which does not exist"),
372 N_("File truncated"),
374 N_("Error reading %s: %s"),
375 N_("#<Invalid error code>")
383 bfd_error_type bfd_get_error (void);
386 Return the current BFD error condition.
400 void bfd_set_error (bfd_error_type error_tag, ...);
403 Set the BFD error condition to be @var{error_tag}.
404 If @var{error_tag} is bfd_error_on_input, then this function
405 takes two more parameters, the input bfd where the error
406 occurred, and the bfd_error_type error.
410 bfd_set_error (bfd_error_type error_tag, ...)
412 bfd_error = error_tag;
413 if (error_tag == bfd_error_on_input)
415 /* This is an error that occurred during bfd_close when
416 writing an archive, but on one of the input files. */
419 va_start (ap, error_tag);
420 input_bfd = va_arg (ap, bfd *);
421 input_error = va_arg (ap, int);
422 if (input_error >= bfd_error_on_input)
433 const char *bfd_errmsg (bfd_error_type error_tag);
436 Return a string describing the error @var{error_tag}, or
437 the system error if @var{error_tag} is <<bfd_error_system_call>>.
441 bfd_errmsg (bfd_error_type error_tag)
446 if (error_tag == bfd_error_on_input)
449 const char *msg = bfd_errmsg (input_error);
451 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
455 /* Ick, what to do on out of memory? */
459 if (error_tag == bfd_error_system_call)
460 return xstrerror (errno);
462 if (error_tag > bfd_error_invalid_error_code)
463 error_tag = bfd_error_invalid_error_code; /* sanity check */
465 return _(bfd_errmsgs [error_tag]);
473 void bfd_perror (const char *message);
476 Print to the standard error stream a string describing the
477 last BFD error that occurred, or the last system error if
478 the last BFD error was a system call failure. If @var{message}
479 is non-NULL and non-empty, the error string printed is preceded
480 by @var{message}, a colon, and a space. It is followed by a newline.
484 bfd_perror (const char *message)
486 if (message == NULL || *message == '\0')
487 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
489 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
496 Some BFD functions want to print messages describing the
497 problem. They call a BFD error handler function. This
498 function may be overridden by the program.
500 The BFD error handler acts like printf.
504 .typedef void (*bfd_error_handler_type) (const char *, ...);
508 /* The program name used when printing BFD error messages. */
510 static const char *_bfd_error_program_name;
512 /* This is the default routine to handle BFD error messages.
513 Like fprintf (stderr, ...), but also handles some extra format specifiers.
515 %A section name from section. For group components, print group name too.
516 %B file name from bfd. For archive components, prints archive too.
518 Note - because these two extra format specifiers require special handling
519 they are scanned for and processed in this function, before calling
520 vfprintf. This means that the *arguments* for these format specifiers
521 must be the first ones in the variable argument list, regardless of where
522 the specifiers appear in the format string. Thus for example calling
523 this function with a format string of:
525 "blah %s blah %A blah %d blah %B"
527 would involve passing the arguments as:
529 "blah %s blah %A blah %d blah %B",
537 _bfd_default_error_handler (const char *fmt, ...)
541 const char *new_fmt, *p;
545 /* PR 4992: Don't interrupt output being sent to stdout. */
548 if (_bfd_error_program_name != NULL)
549 fprintf (stderr, "%s: ", _bfd_error_program_name);
551 fprintf (stderr, "BFD: ");
557 /* Reserve enough space for the existing format string. */
558 avail -= strlen (fmt) + 1;
560 _exit (EXIT_FAILURE);
566 size_t len, extra, trim;
569 if (p == NULL || p[1] == '\0')
574 memcpy (bufp, fmt, len + 1);
579 if (p[1] == 'A' || p[1] == 'B')
582 memcpy (bufp, fmt, len);
587 /* If we run out of space, tough, you lose your ridiculously
588 long file or section name. It's not safe to try to alloc
589 memory here; We might be printing an out of memory message. */
600 bfd *abfd = va_arg (ap, bfd *);
603 /* Invoking %B with a null bfd pointer is an internal error. */
605 else if (abfd->my_archive)
606 snprintf (bufp, avail, "%s(%s)",
607 abfd->my_archive->filename, abfd->filename);
609 snprintf (bufp, avail, "%s", abfd->filename);
613 asection *sec = va_arg (ap, asection *);
615 const char *group = NULL;
616 struct coff_comdat_info *ci;
619 /* Invoking %A with a null section pointer is an internal error. */
623 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
624 && elf_next_in_group (sec) != NULL
625 && (sec->flags & SEC_GROUP) == 0)
626 group = elf_group_name (sec);
627 else if (abfd != NULL
628 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
629 && (ci = bfd_coff_get_comdat_section (sec->owner,
633 snprintf (bufp, avail, "%s[%s]", sec->name, group);
635 snprintf (bufp, avail, "%s", sec->name);
638 avail = avail - len + 2;
640 /* We need to replace any '%' we printed by "%%".
641 First count how many. */
645 while ((q = strchr (q, '%')) != NULL)
651 /* If there isn't room, trim off the end of the string. */
656 trim = extra - avail;
669 /* Now double all '%' chars, shuffling the string as we go. */
672 while ((q[extra] = *q) != '%')
682 vfprintf (stderr, new_fmt, ap);
688 /* This is a function pointer to the routine which should handle BFD
689 error messages. It is called when a BFD routine encounters an
690 error for which it wants to print a message. Going through a
691 function pointer permits a program linked against BFD to intercept
692 the messages and deal with them itself. */
694 bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
698 bfd_set_error_handler
701 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
704 Set the BFD error handler function. Returns the previous
708 bfd_error_handler_type
709 bfd_set_error_handler (bfd_error_handler_type pnew)
711 bfd_error_handler_type pold;
713 pold = _bfd_error_handler;
714 _bfd_error_handler = pnew;
720 bfd_set_error_program_name
723 void bfd_set_error_program_name (const char *);
726 Set the program name to use when printing a BFD error. This
727 is printed before the error message followed by a colon and
728 space. The string must not be changed after it is passed to
733 bfd_set_error_program_name (const char *name)
735 _bfd_error_program_name = name;
740 bfd_get_error_handler
743 bfd_error_handler_type bfd_get_error_handler (void);
746 Return the BFD error handler function.
749 bfd_error_handler_type
750 bfd_get_error_handler (void)
752 return _bfd_error_handler;
760 Miscellaneous functions
765 bfd_get_reloc_upper_bound
768 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
771 Return the number of bytes required to store the
772 relocation information associated with section @var{sect}
773 attached to bfd @var{abfd}. If an error occurs, return -1.
778 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
780 if (abfd->format != bfd_object)
782 bfd_set_error (bfd_error_invalid_operation);
786 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
791 bfd_canonicalize_reloc
794 long bfd_canonicalize_reloc
795 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
798 Call the back end associated with the open BFD
799 @var{abfd} and translate the external form of the relocation
800 information attached to @var{sec} into the internal canonical
801 form. Place the table into memory at @var{loc}, which has
802 been preallocated, usually by a call to
803 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
806 The @var{syms} table is also needed for horrible internal magic
811 bfd_canonicalize_reloc (bfd *abfd,
816 if (abfd->format != bfd_object)
818 bfd_set_error (bfd_error_invalid_operation);
822 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
823 (abfd, asect, location, symbols));
832 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
835 Set the relocation pointer and count within
836 section @var{sec} to the values @var{rel} and @var{count}.
837 The argument @var{abfd} is ignored.
842 bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
847 asect->orelocation = location;
848 asect->reloc_count = count;
856 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
859 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
862 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
863 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
864 o <<bfd_error_invalid_operation>> -
865 The flag word contained a bit which was not applicable to the
866 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
867 on a BFD format which does not support demand paging.
872 bfd_set_file_flags (bfd *abfd, flagword flags)
874 if (abfd->format != bfd_object)
876 bfd_set_error (bfd_error_wrong_format);
880 if (bfd_read_p (abfd))
882 bfd_set_error (bfd_error_invalid_operation);
886 bfd_get_file_flags (abfd) = flags;
887 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
889 bfd_set_error (bfd_error_invalid_operation);
897 bfd_assert (const char *file, int line)
899 (*_bfd_error_handler) (_("BFD %s assertion fail %s:%d"),
900 BFD_VERSION_STRING, file, line);
903 /* A more or less friendly abort message. In libbfd.h abort is
904 defined to call this function. */
907 _bfd_abort (const char *file, int line, const char *fn)
910 (*_bfd_error_handler)
911 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
912 BFD_VERSION_STRING, file, line, fn);
914 (*_bfd_error_handler)
915 (_("BFD %s internal error, aborting at %s line %d\n"),
916 BFD_VERSION_STRING, file, line);
917 (*_bfd_error_handler) (_("Please report this bug.\n"));
918 _exit (EXIT_FAILURE);
926 int bfd_get_arch_size (bfd *abfd);
929 Returns the architecture address size, in bits, as determined
930 by the object file's format. For ELF, this information is
931 included in the header.
934 Returns the arch size in bits if known, <<-1>> otherwise.
938 bfd_get_arch_size (bfd *abfd)
940 if (abfd->xvec->flavour == bfd_target_elf_flavour)
941 return get_elf_backend_data (abfd)->s->arch_size;
948 bfd_get_sign_extend_vma
951 int bfd_get_sign_extend_vma (bfd *abfd);
954 Indicates if the target architecture "naturally" sign extends
955 an address. Some architectures implicitly sign extend address
956 values when they are converted to types larger than the size
957 of an address. For instance, bfd_get_start_address() will
958 return an address sign extended to fill a bfd_vma when this is
962 Returns <<1>> if the target architecture is known to sign
963 extend addresses, <<0>> if the target architecture is known to
964 not sign extend addresses, and <<-1>> otherwise.
968 bfd_get_sign_extend_vma (bfd *abfd)
972 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
973 return get_elf_backend_data (abfd)->sign_extend_vma;
975 name = bfd_get_target (abfd);
977 /* Return a proper value for DJGPP & PE COFF.
978 This function is required for DWARF2 support, but there is
979 no place to store this information in the COFF back end.
980 Should enough other COFF targets add support for DWARF2,
981 a place will have to be found. Until then, this hack will do. */
982 if (CONST_STRNEQ (name, "coff-go32")
983 || strcmp (name, "pe-i386") == 0
984 || strcmp (name, "pei-i386") == 0
985 || strcmp (name, "pe-x86-64") == 0
986 || strcmp (name, "pei-x86-64") == 0
987 || strcmp (name, "pe-arm-wince-little") == 0
988 || strcmp (name, "pei-arm-wince-little") == 0)
991 bfd_set_error (bfd_error_wrong_format);
997 bfd_set_start_address
1000 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1003 Make @var{vma} the entry point of output BFD @var{abfd}.
1006 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1010 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1012 abfd->start_address = vma;
1021 unsigned int bfd_get_gp_size (bfd *abfd);
1024 Return the maximum size of objects to be optimized using the GP
1025 register under MIPS ECOFF. This is typically set by the <<-G>>
1026 argument to the compiler, assembler or linker.
1030 bfd_get_gp_size (bfd *abfd)
1032 if (abfd->format == bfd_object)
1034 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1035 return ecoff_data (abfd)->gp_size;
1036 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1037 return elf_gp_size (abfd);
1047 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1050 Set the maximum size of objects to be optimized using the GP
1051 register under ECOFF or MIPS ELF. This is typically set by
1052 the <<-G>> argument to the compiler, assembler or linker.
1056 bfd_set_gp_size (bfd *abfd, unsigned int i)
1058 /* Don't try to set GP size on an archive or core file! */
1059 if (abfd->format != bfd_object)
1062 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1063 ecoff_data (abfd)->gp_size = i;
1064 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1065 elf_gp_size (abfd) = i;
1068 /* Get the GP value. This is an internal function used by some of the
1069 relocation special_function routines on targets which support a GP
1073 _bfd_get_gp_value (bfd *abfd)
1077 if (abfd->format != bfd_object)
1080 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1081 return ecoff_data (abfd)->gp;
1082 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1083 return elf_gp (abfd);
1088 /* Set the GP value. */
1091 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1095 if (abfd->format != bfd_object)
1098 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1099 ecoff_data (abfd)->gp = v;
1100 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1109 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1112 Convert, like <<strtoul>>, a numerical expression
1113 @var{string} into a <<bfd_vma>> integer, and return that integer.
1114 (Though without as many bells and whistles as <<strtoul>>.)
1115 The expression is assumed to be unsigned (i.e., positive).
1116 If given a @var{base}, it is used as the base for conversion.
1117 A base of 0 causes the function to interpret the string
1118 in hex if a leading "0x" or "0X" is found, otherwise
1119 in octal if a leading zero is found, otherwise in decimal.
1121 If the value would overflow, the maximum <<bfd_vma>> value is
1126 bfd_scan_vma (const char *string, const char **end, int base)
1130 unsigned int cutlim;
1133 /* Let the host do it if possible. */
1134 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1135 return strtoul (string, (char **) end, base);
1137 #ifdef HAVE_STRTOULL
1138 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1139 return strtoull (string, (char **) end, base);
1144 if (string[0] == '0')
1146 if ((string[1] == 'x') || (string[1] == 'X'))
1153 if ((base < 2) || (base > 36))
1158 && (string[1] == 'x' || string[1] == 'X')
1159 && ISXDIGIT (string[2]))
1164 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1165 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1173 if (ISDIGIT (digit))
1174 digit = digit - '0';
1175 else if (ISALPHA (digit))
1176 digit = TOUPPER (digit) - 'A' + 10;
1179 if (digit >= (unsigned int) base)
1181 if (value > cutoff || (value == cutoff && digit > cutlim))
1183 value = value * base + digit;
1188 value = ~ (bfd_vma) 0;
1198 bfd_copy_private_header_data
1201 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1204 Copy private BFD header information from the BFD @var{ibfd} to the
1205 the BFD @var{obfd}. This copies information that may require
1206 sections to exist, but does not require symbol tables. Return
1207 <<true>> on success, <<false>> on error.
1208 Possible error returns are:
1210 o <<bfd_error_no_memory>> -
1211 Not enough memory exists to create private data for @var{obfd}.
1213 .#define bfd_copy_private_header_data(ibfd, obfd) \
1214 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1221 bfd_copy_private_bfd_data
1224 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1227 Copy private BFD information from the BFD @var{ibfd} to the
1228 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1229 Possible error returns are:
1231 o <<bfd_error_no_memory>> -
1232 Not enough memory exists to create private data for @var{obfd}.
1234 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1235 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1242 bfd_merge_private_bfd_data
1245 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1248 Merge private BFD information from the BFD @var{ibfd} to the
1249 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1250 on success, <<FALSE>> on error. Possible error returns are:
1252 o <<bfd_error_no_memory>> -
1253 Not enough memory exists to create private data for @var{obfd}.
1255 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1256 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1263 bfd_set_private_flags
1266 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1269 Set private BFD flag information in the BFD @var{abfd}.
1270 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1273 o <<bfd_error_no_memory>> -
1274 Not enough memory exists to create private data for @var{obfd}.
1276 .#define bfd_set_private_flags(abfd, flags) \
1277 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1286 The following functions exist but have not yet been documented.
1288 .#define bfd_sizeof_headers(abfd, info) \
1289 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1291 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1292 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1293 . (abfd, sec, syms, off, file, func, line))
1295 .#define bfd_find_line(abfd, syms, sym, file, line) \
1296 . BFD_SEND (abfd, _bfd_find_line, \
1297 . (abfd, syms, sym, file, line))
1299 .#define bfd_find_inliner_info(abfd, file, func, line) \
1300 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1301 . (abfd, file, func, line))
1303 .#define bfd_debug_info_start(abfd) \
1304 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1306 .#define bfd_debug_info_end(abfd) \
1307 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1309 .#define bfd_debug_info_accumulate(abfd, section) \
1310 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1312 .#define bfd_stat_arch_elt(abfd, stat) \
1313 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1315 .#define bfd_update_armap_timestamp(abfd) \
1316 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1318 .#define bfd_set_arch_mach(abfd, arch, mach)\
1319 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1321 .#define bfd_relax_section(abfd, section, link_info, again) \
1322 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1324 .#define bfd_gc_sections(abfd, link_info) \
1325 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1327 .#define bfd_merge_sections(abfd, link_info) \
1328 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1330 .#define bfd_is_group_section(abfd, sec) \
1331 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1333 .#define bfd_discard_group(abfd, sec) \
1334 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1336 .#define bfd_link_hash_table_create(abfd) \
1337 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1339 .#define bfd_link_hash_table_free(abfd, hash) \
1340 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1342 .#define bfd_link_add_symbols(abfd, info) \
1343 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1345 .#define bfd_link_just_syms(abfd, sec, info) \
1346 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1348 .#define bfd_final_link(abfd, info) \
1349 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1351 .#define bfd_free_cached_info(abfd) \
1352 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1354 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1355 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1357 .#define bfd_print_private_bfd_data(abfd, file)\
1358 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1360 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1361 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1363 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1364 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1365 . dyncount, dynsyms, ret))
1367 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1368 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1370 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1371 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1373 .extern bfd_byte *bfd_get_relocated_section_contents
1374 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1375 . bfd_boolean, asymbol **);
1381 bfd_get_relocated_section_contents (bfd *abfd,
1382 struct bfd_link_info *link_info,
1383 struct bfd_link_order *link_order,
1385 bfd_boolean relocatable,
1389 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1390 bfd_byte *, bfd_boolean, asymbol **);
1392 if (link_order->type == bfd_indirect_link_order)
1394 abfd2 = link_order->u.indirect.section->owner;
1401 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1403 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1406 /* Record information about an ELF program header. */
1409 bfd_record_phdr (bfd *abfd,
1411 bfd_boolean flags_valid,
1413 bfd_boolean at_valid,
1415 bfd_boolean includes_filehdr,
1416 bfd_boolean includes_phdrs,
1420 struct elf_segment_map *m, **pm;
1423 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1426 amt = sizeof (struct elf_segment_map);
1427 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1428 m = bfd_zalloc (abfd, amt);
1435 m->p_flags_valid = flags_valid;
1436 m->p_paddr_valid = at_valid;
1437 m->includes_filehdr = includes_filehdr;
1438 m->includes_phdrs = includes_phdrs;
1441 memcpy (m->sections, secs, count * sizeof (asection *));
1443 for (pm = &elf_tdata (abfd)->segment_map; *pm != NULL; pm = &(*pm)->next)
1451 /* Return true iff this target is 32-bit. */
1456 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1458 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1459 return bed->s->elfclass == ELFCLASS32;
1462 /* For non-ELF, make a guess based on the target name. */
1463 return (strstr (bfd_get_target (abfd), "64") == NULL
1464 && strcmp (bfd_get_target (abfd), "mmo") != 0);
1468 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1469 target's address size. */
1472 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1477 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1481 sprintf_vma (buf, value);
1485 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1490 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1494 fprintf_vma ((FILE *) stream, value);
1502 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1506 When more than one machine code number is available for the
1507 same machine type, this function can be used to switch between
1508 the preferred one (alternative == 0) and any others. Currently,
1509 only ELF supports this feature, with up to two alternate
1514 bfd_alt_mach_code (bfd *abfd, int alternative)
1516 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1520 switch (alternative)
1523 code = get_elf_backend_data (abfd)->elf_machine_code;
1527 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1533 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1542 elf_elfheader (abfd)->e_machine = code;
1553 .struct bfd_preserve
1558 . const struct bfd_arch_info *arch_info;
1559 . struct bfd_section *sections;
1560 . struct bfd_section *section_last;
1561 . unsigned int section_count;
1562 . struct bfd_hash_table section_htab;
1572 bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1575 When testing an object for compatibility with a particular
1576 target back-end, the back-end object_p function needs to set
1577 up certain fields in the bfd on successfully recognizing the
1578 object. This typically happens in a piecemeal fashion, with
1579 failures possible at many points. On failure, the bfd is
1580 supposed to be restored to its initial state, which is
1581 virtually impossible. However, restoring a subset of the bfd
1582 state works in practice. This function stores the subset and
1583 reinitializes the bfd.
1588 bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
1590 preserve->tdata = abfd->tdata.any;
1591 preserve->arch_info = abfd->arch_info;
1592 preserve->flags = abfd->flags;
1593 preserve->sections = abfd->sections;
1594 preserve->section_last = abfd->section_last;
1595 preserve->section_count = abfd->section_count;
1596 preserve->section_htab = abfd->section_htab;
1598 if (! bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
1599 sizeof (struct section_hash_entry)))
1602 abfd->tdata.any = NULL;
1603 abfd->arch_info = &bfd_default_arch_struct;
1604 abfd->flags &= BFD_IN_MEMORY;
1605 abfd->sections = NULL;
1606 abfd->section_last = NULL;
1607 abfd->section_count = 0;
1614 bfd_preserve_restore
1617 void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1620 This function restores bfd state saved by bfd_preserve_save.
1621 If MARKER is non-NULL in struct bfd_preserve then that block
1622 and all subsequently bfd_alloc'd memory is freed.
1627 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
1629 bfd_hash_table_free (&abfd->section_htab);
1631 abfd->tdata.any = preserve->tdata;
1632 abfd->arch_info = preserve->arch_info;
1633 abfd->flags = preserve->flags;
1634 abfd->section_htab = preserve->section_htab;
1635 abfd->sections = preserve->sections;
1636 abfd->section_last = preserve->section_last;
1637 abfd->section_count = preserve->section_count;
1639 /* bfd_release frees all memory more recently bfd_alloc'd than
1640 its arg, as well as its arg. */
1641 if (preserve->marker != NULL)
1643 bfd_release (abfd, preserve->marker);
1644 preserve->marker = NULL;
1653 void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1656 This function should be called when the bfd state saved by
1657 bfd_preserve_save is no longer needed. ie. when the back-end
1658 object_p function returns with success.
1663 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
1665 /* It would be nice to be able to free more memory here, eg. old
1666 tdata, but that's not possible since these blocks are sitting
1667 inside bfd_alloc'd memory. The section hash is on a separate
1669 bfd_hash_table_free (&preserve->section_htab);
1674 bfd_emul_get_maxpagesize
1677 bfd_vma bfd_emul_get_maxpagesize (const char *);
1680 Returns the maximum page size, in bytes, as determined by
1684 Returns the maximum page size in bytes for ELF, abort
1689 bfd_emul_get_maxpagesize (const char *emul)
1691 const bfd_target *target;
1693 target = bfd_find_target (emul, NULL);
1695 && target->flavour == bfd_target_elf_flavour)
1696 return xvec_get_elf_backend_data (target)->maxpagesize;
1703 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1704 int offset, const bfd_target *orig_target)
1706 if (target->flavour == bfd_target_elf_flavour)
1708 const struct elf_backend_data *bed;
1710 bed = xvec_get_elf_backend_data (target);
1711 *((bfd_vma *) ((char *) bed + offset)) = size;
1714 if (target->alternative_target
1715 && target->alternative_target != orig_target)
1716 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1722 bfd_emul_set_maxpagesize
1725 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1728 For ELF, set the maximum page size for the emulation. It is
1729 a no-op for other formats.
1734 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1736 const bfd_target *target;
1738 target = bfd_find_target (emul, NULL);
1740 bfd_elf_set_pagesize (target, size,
1741 offsetof (struct elf_backend_data,
1742 maxpagesize), target);
1747 bfd_emul_get_commonpagesize
1750 bfd_vma bfd_emul_get_commonpagesize (const char *);
1753 Returns the common page size, in bytes, as determined by
1757 Returns the common page size in bytes for ELF, abort otherwise.
1761 bfd_emul_get_commonpagesize (const char *emul)
1763 const bfd_target *target;
1765 target = bfd_find_target (emul, NULL);
1767 && target->flavour == bfd_target_elf_flavour)
1768 return xvec_get_elf_backend_data (target)->commonpagesize;
1776 bfd_emul_set_commonpagesize
1779 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1782 For ELF, set the common page size for the emulation. It is
1783 a no-op for other formats.
1788 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1790 const bfd_target *target;
1792 target = bfd_find_target (emul, NULL);
1794 bfd_elf_set_pagesize (target, size,
1795 offsetof (struct elf_backend_data,
1796 commonpagesize), target);
1804 char *bfd_demangle (bfd *, const char *, int);
1807 Wrapper around cplus_demangle. Strips leading underscores and
1808 other such chars that would otherwise confuse the demangler.
1809 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1810 with malloc holding the demangled name. Returns NULL otherwise
1811 and on memory alloc failure.
1815 bfd_demangle (bfd *abfd, const char *name, int options)
1818 const char *pre, *suf;
1823 && bfd_get_symbol_leading_char (abfd) == *name)
1826 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1827 or the MS PE format. These formats have a number of leading '.'s
1828 on at least some symbols, so we remove all dots to avoid
1829 confusing the demangler. */
1831 while (*name == '.' || *name == '$')
1833 pre_len = name - pre;
1835 /* Strip off @plt and suchlike too. */
1837 suf = strchr (name, '@');
1840 alloc = bfd_malloc (suf - name + 1);
1843 memcpy (alloc, name, suf - name);
1844 alloc[suf - name] = '\0';
1848 res = cplus_demangle (name, options);
1856 /* Put back any prefix or suffix. */
1857 if (pre_len != 0 || suf != NULL)
1866 suf_len = strlen (suf) + 1;
1867 final = bfd_malloc (pre_len + len + suf_len);
1870 memcpy (final, pre, pre_len);
1871 memcpy (final + pre_len, res, len);
1872 memcpy (final + pre_len + len, suf, suf_len);