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
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 2 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
27 A BFD has type <<bfd>>; objects of this type are the
28 cornerstone of any application using BFD. Using BFD
29 consists of making references though the BFD and to data in the BFD.
31 Here is the structure that defines the type <<bfd>>. It
32 contains the major data about the file and pointers
33 to the rest of the data.
39 . {* A unique identifier of the BFD *}
42 . {* The filename the application opened the BFD with. *}
43 . const char *filename;
45 . {* A pointer to the target jump table. *}
46 . const struct bfd_target *xvec;
48 . {* The IOSTREAM, and corresponding IO vector that provide access
49 . to the file backing the BFD. *}
51 . const struct bfd_iovec *iovec;
53 . {* Is the file descriptor being cached? That is, can it be closed as
54 . needed, and re-opened when accessed later? *}
55 . bfd_boolean cacheable;
57 . {* Marks whether there was a default target specified when the
58 . BFD was opened. This is used to select which matching algorithm
59 . to use to choose the back end. *}
60 . bfd_boolean target_defaulted;
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 . {* ... and here: (``once'' means at least once). *}
71 . bfd_boolean opened_once;
73 . {* Set if we have a locally maintained mtime value, rather than
74 . getting it from the file each time. *}
75 . bfd_boolean mtime_set;
77 . {* File modified time, if mtime_set is TRUE. *}
80 . {* Reserved for an unimplemented file locking extension. *}
83 . {* The format which belongs to the BFD. (object, core, etc.) *}
86 . {* The direction with which the BFD was opened. *}
91 . write_direction = 2,
96 . {* Format_specific flags. *}
99 . {* Currently my_archive is tested before adding origin to
100 . anything. I believe that this can become always an add of
101 . origin, with origin set to 0 for non archive files. *}
104 . {* Remember when output has begun, to stop strange things
106 . bfd_boolean output_has_begun;
108 . {* A hash table for section names. *}
109 . struct bfd_hash_table section_htab;
111 . {* Pointer to linked list of sections. *}
112 . struct bfd_section *sections;
114 . {* The place where we add to the section list. *}
115 . struct bfd_section **section_tail;
117 . {* The number of sections. *}
118 . unsigned int section_count;
120 . {* Stuff only useful for object files:
121 . The start address. *}
122 . bfd_vma start_address;
124 . {* Used for input and output. *}
125 . unsigned int symcount;
127 . {* Symbol table for output BFD (with symcount entries). *}
128 . struct bfd_symbol **outsymbols;
130 . {* Used for slurped dynamic symbol tables. *}
131 . unsigned int dynsymcount;
133 . {* Pointer to structure which contains architecture information. *}
134 . const struct bfd_arch_info *arch_info;
136 . {* Stuff only useful for archives. *}
138 . struct bfd *my_archive; {* The containing archive BFD. *}
139 . struct bfd *next; {* The next BFD in the archive. *}
140 . struct bfd *archive_head; {* The first BFD in the archive. *}
141 . bfd_boolean has_armap;
143 . {* A chain of BFD structures involved in a link. *}
144 . struct bfd *link_next;
146 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
147 . be used only for archive elements. *}
150 . {* Used by the back end to hold private data. *}
153 . struct aout_data_struct *aout_data;
154 . struct artdata *aout_ar_data;
155 . struct _oasys_data *oasys_obj_data;
156 . struct _oasys_ar_data *oasys_ar_data;
157 . struct coff_tdata *coff_obj_data;
158 . struct pe_tdata *pe_obj_data;
159 . struct xcoff_tdata *xcoff_obj_data;
160 . struct ecoff_tdata *ecoff_obj_data;
161 . struct ieee_data_struct *ieee_data;
162 . struct ieee_ar_data_struct *ieee_ar_data;
163 . struct srec_data_struct *srec_data;
164 . struct ihex_data_struct *ihex_data;
165 . struct tekhex_data_struct *tekhex_data;
166 . struct elf_obj_tdata *elf_obj_data;
167 . struct nlm_obj_tdata *nlm_obj_data;
168 . struct bout_data_struct *bout_data;
169 . struct mmo_data_struct *mmo_data;
170 . struct sun_core_struct *sun_core_data;
171 . struct sco5_core_struct *sco5_core_data;
172 . struct trad_core_struct *trad_core_data;
173 . struct som_data_struct *som_data;
174 . struct hpux_core_struct *hpux_core_data;
175 . struct hppabsd_core_struct *hppabsd_core_data;
176 . struct sgi_core_struct *sgi_core_data;
177 . struct lynx_core_struct *lynx_core_data;
178 . struct osf_core_struct *osf_core_data;
179 . struct cisco_core_struct *cisco_core_data;
180 . struct versados_data_struct *versados_data;
181 . struct netbsd_core_struct *netbsd_core_data;
182 . struct mach_o_data_struct *mach_o_data;
183 . struct mach_o_fat_data_struct *mach_o_fat_data;
184 . struct bfd_pef_data_struct *pef_data;
185 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
186 . struct bfd_sym_data_struct *sym_data;
191 . {* Used by the application to hold private data. *}
194 . {* Where all the allocated stuff under this BFD goes. This is a
195 . struct objalloc *, but we use void * to avoid requiring the inclusion
206 #include "libiberty.h"
207 #include "safe-ctype.h"
210 #include "coff/internal.h"
211 #include "coff/sym.h"
213 #include "libecoff.h"
217 /* provide storage for subsystem, stack and heap data which may have been
218 passed in on the command line. Ld puts this data into a bfd_link_info
219 struct which ultimately gets passed in to the bfd. When it arrives, copy
220 it to the following struct so that the data will be available in coffcode.h
221 where it is needed. The typedef's used are defined in bfd.h */
227 Most BFD functions return nonzero on success (check their
228 individual documentation for precise semantics). On an error,
229 they call <<bfd_set_error>> to set an error condition that callers
230 can check by calling <<bfd_get_error>>.
231 If that returns <<bfd_error_system_call>>, then check
234 The easiest way to report a BFD error to the user is to
238 Type <<bfd_error_type>>
240 The values returned by <<bfd_get_error>> are defined by the
241 enumerated type <<bfd_error_type>>.
245 .typedef enum bfd_error
247 . bfd_error_no_error = 0,
248 . bfd_error_system_call,
249 . bfd_error_invalid_target,
250 . bfd_error_wrong_format,
251 . bfd_error_wrong_object_format,
252 . bfd_error_invalid_operation,
253 . bfd_error_no_memory,
254 . bfd_error_no_symbols,
255 . bfd_error_no_armap,
256 . bfd_error_no_more_archived_files,
257 . bfd_error_malformed_archive,
258 . bfd_error_file_not_recognized,
259 . bfd_error_file_ambiguously_recognized,
260 . bfd_error_no_contents,
261 . bfd_error_nonrepresentable_section,
262 . bfd_error_no_debug_section,
263 . bfd_error_bad_value,
264 . bfd_error_file_truncated,
265 . bfd_error_file_too_big,
266 . bfd_error_invalid_error_code
272 static bfd_error_type bfd_error
= bfd_error_no_error
;
274 const char *const bfd_errmsgs
[] =
277 N_("System call error"),
278 N_("Invalid bfd target"),
279 N_("File in wrong format"),
280 N_("Archive object file in wrong format"),
281 N_("Invalid operation"),
282 N_("Memory exhausted"),
284 N_("Archive has no index; run ranlib to add one"),
285 N_("No more archived files"),
286 N_("Malformed archive"),
287 N_("File format not recognized"),
288 N_("File format is ambiguous"),
289 N_("Section has no contents"),
290 N_("Nonrepresentable section on output"),
291 N_("Symbol needs debug section which does not exist"),
293 N_("File truncated"),
295 N_("#<Invalid error code>")
303 bfd_error_type bfd_get_error (void);
306 Return the current BFD error condition.
320 void bfd_set_error (bfd_error_type error_tag);
323 Set the BFD error condition to be @var{error_tag}.
327 bfd_set_error (bfd_error_type error_tag
)
329 bfd_error
= error_tag
;
337 const char *bfd_errmsg (bfd_error_type error_tag);
340 Return a string describing the error @var{error_tag}, or
341 the system error if @var{error_tag} is <<bfd_error_system_call>>.
345 bfd_errmsg (bfd_error_type error_tag
)
350 if (error_tag
== bfd_error_system_call
)
351 return xstrerror (errno
);
353 if (error_tag
> bfd_error_invalid_error_code
)
354 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
356 return _(bfd_errmsgs
[error_tag
]);
364 void bfd_perror (const char *message);
367 Print to the standard error stream a string describing the
368 last BFD error that occurred, or the last system error if
369 the last BFD error was a system call failure. If @var{message}
370 is non-NULL and non-empty, the error string printed is preceded
371 by @var{message}, a colon, and a space. It is followed by a newline.
375 bfd_perror (const char *message
)
377 if (bfd_get_error () == bfd_error_system_call
)
378 /* Must be a system error then. */
379 perror ((char *) message
);
382 if (message
== NULL
|| *message
== '\0')
383 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
385 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
393 Some BFD functions want to print messages describing the
394 problem. They call a BFD error handler function. This
395 function may be overridden by the program.
397 The BFD error handler acts like printf.
401 .typedef void (*bfd_error_handler_type) (const char *, ...);
405 /* The program name used when printing BFD error messages. */
407 static const char *_bfd_error_program_name
;
409 /* This is the default routine to handle BFD error messages.
410 Like fprintf (stderr, ...), but also handles some extra format specifiers.
412 %A section name from section. For group components, print group name too.
413 %B file name from bfd. For archive components, prints archive too.
417 _bfd_default_error_handler (const char *fmt
, ...)
421 const char *new_fmt
, *p
;
425 if (_bfd_error_program_name
!= NULL
)
426 fprintf (stderr
, "%s: ", _bfd_error_program_name
);
428 fprintf (stderr
, "BFD: ");
434 /* Reserve enough space for the existing format string. */
435 avail
-= strlen (fmt
) + 1;
443 size_t len
, extra
, trim
;
446 if (p
== NULL
|| p
[1] == '\0')
451 memcpy (bufp
, fmt
, len
+ 1);
456 if (p
[1] == 'A' || p
[1] == 'B')
459 memcpy (bufp
, fmt
, len
);
464 /* If we run out of space, tough, you lose your ridiculously
465 long file or section name. It's not safe to try to alloc
466 memory here; We might be printing an out of memory message. */
477 bfd
*abfd
= va_arg (ap
, bfd
*);
478 if (abfd
->my_archive
)
479 snprintf (bufp
, avail
, "%s(%s)",
480 abfd
->my_archive
->filename
, abfd
->filename
);
482 snprintf (bufp
, avail
, "%s", abfd
->filename
);
486 asection
*sec
= va_arg (ap
, asection
*);
487 bfd
*abfd
= sec
->owner
;
488 const char *group
= NULL
;
489 struct coff_comdat_info
*ci
;
492 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
493 && elf_next_in_group (sec
) != NULL
494 && (sec
->flags
& SEC_GROUP
) == 0)
495 group
= elf_group_name (sec
);
496 else if (abfd
!= NULL
497 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
498 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
502 snprintf (bufp
, avail
, "%s[%s]", sec
->name
, group
);
504 snprintf (bufp
, avail
, "%s", sec
->name
);
507 avail
= avail
- len
+ 2;
509 /* We need to replace any '%' we printed by "%%".
510 First count how many. */
514 while ((q
= strchr (q
, '%')) != NULL
)
520 /* If there isn't room, trim off the end of the string. */
525 trim
= extra
- avail
;
536 /* Now double all '%' chars, shuffling the string as we go. */
539 while ((q
[extra
] = *q
) != '%')
549 vfprintf (stderr
, new_fmt
, ap
);
555 /* This is a function pointer to the routine which should handle BFD
556 error messages. It is called when a BFD routine encounters an
557 error for which it wants to print a message. Going through a
558 function pointer permits a program linked against BFD to intercept
559 the messages and deal with them itself. */
561 bfd_error_handler_type _bfd_error_handler
= _bfd_default_error_handler
;
565 bfd_set_error_handler
568 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
571 Set the BFD error handler function. Returns the previous
575 bfd_error_handler_type
576 bfd_set_error_handler (bfd_error_handler_type pnew
)
578 bfd_error_handler_type pold
;
580 pold
= _bfd_error_handler
;
581 _bfd_error_handler
= pnew
;
587 bfd_set_error_program_name
590 void bfd_set_error_program_name (const char *);
593 Set the program name to use when printing a BFD error. This
594 is printed before the error message followed by a colon and
595 space. The string must not be changed after it is passed to
600 bfd_set_error_program_name (const char *name
)
602 _bfd_error_program_name
= name
;
607 bfd_get_error_handler
610 bfd_error_handler_type bfd_get_error_handler (void);
613 Return the BFD error handler function.
616 bfd_error_handler_type
617 bfd_get_error_handler (void)
619 return _bfd_error_handler
;
629 bfd_get_reloc_upper_bound
632 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
635 Return the number of bytes required to store the
636 relocation information associated with section @var{sect}
637 attached to bfd @var{abfd}. If an error occurs, return -1.
642 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
644 if (abfd
->format
!= bfd_object
)
646 bfd_set_error (bfd_error_invalid_operation
);
650 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
655 bfd_canonicalize_reloc
658 long bfd_canonicalize_reloc
659 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
662 Call the back end associated with the open BFD
663 @var{abfd} and translate the external form of the relocation
664 information attached to @var{sec} into the internal canonical
665 form. Place the table into memory at @var{loc}, which has
666 been preallocated, usually by a call to
667 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
670 The @var{syms} table is also needed for horrible internal magic
675 bfd_canonicalize_reloc (bfd
*abfd
,
680 if (abfd
->format
!= bfd_object
)
682 bfd_set_error (bfd_error_invalid_operation
);
686 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
687 (abfd
, asect
, location
, symbols
));
696 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
699 Set the relocation pointer and count within
700 section @var{sec} to the values @var{rel} and @var{count}.
701 The argument @var{abfd} is ignored.
706 bfd_set_reloc (bfd
*ignore_abfd ATTRIBUTE_UNUSED
,
711 asect
->orelocation
= location
;
712 asect
->reloc_count
= count
;
720 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
723 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
726 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
727 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
728 o <<bfd_error_invalid_operation>> -
729 The flag word contained a bit which was not applicable to the
730 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
731 on a BFD format which does not support demand paging.
736 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
738 if (abfd
->format
!= bfd_object
)
740 bfd_set_error (bfd_error_wrong_format
);
744 if (bfd_read_p (abfd
))
746 bfd_set_error (bfd_error_invalid_operation
);
750 bfd_get_file_flags (abfd
) = flags
;
751 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
753 bfd_set_error (bfd_error_invalid_operation
);
761 bfd_assert (const char *file
, int line
)
763 (*_bfd_error_handler
) (_("BFD %s assertion fail %s:%d"),
764 BFD_VERSION_STRING
, file
, line
);
767 /* A more or less friendly abort message. In libbfd.h abort is
768 defined to call this function. */
771 #define EXIT_FAILURE 1
775 _bfd_abort (const char *file
, int line
, const char *fn
)
778 (*_bfd_error_handler
)
779 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
780 BFD_VERSION_STRING
, file
, line
, fn
);
782 (*_bfd_error_handler
)
783 (_("BFD %s internal error, aborting at %s line %d\n"),
784 BFD_VERSION_STRING
, file
, line
);
785 (*_bfd_error_handler
) (_("Please report this bug.\n"));
786 xexit (EXIT_FAILURE
);
794 int bfd_get_arch_size (bfd *abfd);
797 Returns the architecture address size, in bits, as determined
798 by the object file's format. For ELF, this information is
799 included in the header.
802 Returns the arch size in bits if known, <<-1>> otherwise.
806 bfd_get_arch_size (bfd
*abfd
)
808 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
809 return get_elf_backend_data (abfd
)->s
->arch_size
;
816 bfd_get_sign_extend_vma
819 int bfd_get_sign_extend_vma (bfd *abfd);
822 Indicates if the target architecture "naturally" sign extends
823 an address. Some architectures implicitly sign extend address
824 values when they are converted to types larger than the size
825 of an address. For instance, bfd_get_start_address() will
826 return an address sign extended to fill a bfd_vma when this is
830 Returns <<1>> if the target architecture is known to sign
831 extend addresses, <<0>> if the target architecture is known to
832 not sign extend addresses, and <<-1>> otherwise.
836 bfd_get_sign_extend_vma (bfd
*abfd
)
840 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
841 return get_elf_backend_data (abfd
)->sign_extend_vma
;
843 name
= bfd_get_target (abfd
);
845 /* Return a proper value for DJGPP & PE COFF (x86 COFF variants).
846 This function is required for DWARF2 support, but there is
847 no place to store this information in the COFF back end.
848 Should enough other COFF targets add support for DWARF2,
849 a place will have to be found. Until then, this hack will do. */
850 if (strncmp (name
, "coff-go32", sizeof ("coff-go32") - 1) == 0
851 || strcmp (name
, "pe-i386") == 0
852 || strcmp (name
, "pei-i386") == 0)
855 bfd_set_error (bfd_error_wrong_format
);
861 bfd_set_start_address
864 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
867 Make @var{vma} the entry point of output BFD @var{abfd}.
870 Returns <<TRUE>> on success, <<FALSE>> otherwise.
874 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
876 abfd
->start_address
= vma
;
885 unsigned int bfd_get_gp_size (bfd *abfd);
888 Return the maximum size of objects to be optimized using the GP
889 register under MIPS ECOFF. This is typically set by the <<-G>>
890 argument to the compiler, assembler or linker.
894 bfd_get_gp_size (bfd
*abfd
)
896 if (abfd
->format
== bfd_object
)
898 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
899 return ecoff_data (abfd
)->gp_size
;
900 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
901 return elf_gp_size (abfd
);
911 void bfd_set_gp_size (bfd *abfd, unsigned int i);
914 Set the maximum size of objects to be optimized using the GP
915 register under ECOFF or MIPS ELF. This is typically set by
916 the <<-G>> argument to the compiler, assembler or linker.
920 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
922 /* Don't try to set GP size on an archive or core file! */
923 if (abfd
->format
!= bfd_object
)
926 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
927 ecoff_data (abfd
)->gp_size
= i
;
928 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
929 elf_gp_size (abfd
) = i
;
932 /* Get the GP value. This is an internal function used by some of the
933 relocation special_function routines on targets which support a GP
937 _bfd_get_gp_value (bfd
*abfd
)
941 if (abfd
->format
!= bfd_object
)
944 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
945 return ecoff_data (abfd
)->gp
;
946 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
947 return elf_gp (abfd
);
952 /* Set the GP value. */
955 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
959 if (abfd
->format
!= bfd_object
)
962 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
963 ecoff_data (abfd
)->gp
= v
;
964 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
973 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
976 Convert, like <<strtoul>>, a numerical expression
977 @var{string} into a <<bfd_vma>> integer, and return that integer.
978 (Though without as many bells and whistles as <<strtoul>>.)
979 The expression is assumed to be unsigned (i.e., positive).
980 If given a @var{base}, it is used as the base for conversion.
981 A base of 0 causes the function to interpret the string
982 in hex if a leading "0x" or "0X" is found, otherwise
983 in octal if a leading zero is found, otherwise in decimal.
985 If the value would overflow, the maximum <<bfd_vma>> value is
990 bfd_scan_vma (const char *string
, const char **end
, int base
)
997 /* Let the host do it if possible. */
998 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
999 return strtoul (string
, (char **) end
, base
);
1001 #ifdef HAVE_STRTOULL
1002 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
1003 return strtoull (string
, (char **) end
, base
);
1008 if (string
[0] == '0')
1010 if ((string
[1] == 'x') || (string
[1] == 'X'))
1017 if ((base
< 2) || (base
> 36))
1022 && (string
[1] == 'x' || string
[1] == 'X')
1023 && ISXDIGIT (string
[2]))
1028 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
1029 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
1037 if (ISDIGIT (digit
))
1038 digit
= digit
- '0';
1039 else if (ISALPHA (digit
))
1040 digit
= TOUPPER (digit
) - 'A' + 10;
1043 if (digit
>= (unsigned int) base
)
1045 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
1047 value
= value
* base
+ digit
;
1052 value
= ~ (bfd_vma
) 0;
1062 bfd_copy_private_header_data
1065 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1068 Copy private BFD header information from the BFD @var{ibfd} to the
1069 the BFD @var{obfd}. This copies information that may require
1070 sections to exist, but does not require symbol tables. Return
1071 <<true>> on success, <<false>> on error.
1072 Possible error returns are:
1074 o <<bfd_error_no_memory>> -
1075 Not enough memory exists to create private data for @var{obfd}.
1077 .#define bfd_copy_private_header_data(ibfd, obfd) \
1078 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1085 bfd_copy_private_bfd_data
1088 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1091 Copy private BFD information from the BFD @var{ibfd} to the
1092 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1093 Possible error returns are:
1095 o <<bfd_error_no_memory>> -
1096 Not enough memory exists to create private data for @var{obfd}.
1098 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1099 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1106 bfd_merge_private_bfd_data
1109 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1112 Merge private BFD information from the BFD @var{ibfd} to the
1113 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1114 on success, <<FALSE>> on error. Possible error returns are:
1116 o <<bfd_error_no_memory>> -
1117 Not enough memory exists to create private data for @var{obfd}.
1119 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1120 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1127 bfd_set_private_flags
1130 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1133 Set private BFD flag information in the BFD @var{abfd}.
1134 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1137 o <<bfd_error_no_memory>> -
1138 Not enough memory exists to create private data for @var{obfd}.
1140 .#define bfd_set_private_flags(abfd, flags) \
1141 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1150 The following functions exist but have not yet been documented.
1152 .#define bfd_sizeof_headers(abfd, reloc) \
1153 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1155 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1156 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1157 . (abfd, sec, syms, off, file, func, line))
1159 .#define bfd_debug_info_start(abfd) \
1160 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1162 .#define bfd_debug_info_end(abfd) \
1163 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1165 .#define bfd_debug_info_accumulate(abfd, section) \
1166 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1168 .#define bfd_stat_arch_elt(abfd, stat) \
1169 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1171 .#define bfd_update_armap_timestamp(abfd) \
1172 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1174 .#define bfd_set_arch_mach(abfd, arch, mach)\
1175 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1177 .#define bfd_relax_section(abfd, section, link_info, again) \
1178 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1180 .#define bfd_gc_sections(abfd, link_info) \
1181 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1183 .#define bfd_merge_sections(abfd, link_info) \
1184 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1186 .#define bfd_is_group_section(abfd, sec) \
1187 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1189 .#define bfd_discard_group(abfd, sec) \
1190 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1192 .#define bfd_link_hash_table_create(abfd) \
1193 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1195 .#define bfd_link_hash_table_free(abfd, hash) \
1196 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1198 .#define bfd_link_add_symbols(abfd, info) \
1199 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1201 .#define bfd_link_just_syms(sec, info) \
1202 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1204 .#define bfd_final_link(abfd, info) \
1205 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1207 .#define bfd_free_cached_info(abfd) \
1208 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1210 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1211 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1213 .#define bfd_print_private_bfd_data(abfd, file)\
1214 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1216 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1217 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1219 .#define bfd_get_synthetic_symtab(abfd, dynsyms, ret) \
1220 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, dynsyms, ret))
1222 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1223 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1225 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1226 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1228 .extern bfd_byte *bfd_get_relocated_section_contents
1229 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1230 . bfd_boolean, asymbol **);
1236 bfd_get_relocated_section_contents (bfd
*abfd
,
1237 struct bfd_link_info
*link_info
,
1238 struct bfd_link_order
*link_order
,
1240 bfd_boolean relocatable
,
1244 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
1245 bfd_byte
*, bfd_boolean
, asymbol
**);
1247 if (link_order
->type
== bfd_indirect_link_order
)
1249 abfd2
= link_order
->u
.indirect
.section
->owner
;
1256 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
1258 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
1261 /* Record information about an ELF program header. */
1264 bfd_record_phdr (bfd
*abfd
,
1266 bfd_boolean flags_valid
,
1268 bfd_boolean at_valid
,
1270 bfd_boolean includes_filehdr
,
1271 bfd_boolean includes_phdrs
,
1275 struct elf_segment_map
*m
, **pm
;
1278 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
1281 amt
= sizeof (struct elf_segment_map
);
1282 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
1283 m
= bfd_alloc (abfd
, amt
);
1291 m
->p_flags_valid
= flags_valid
;
1292 m
->p_paddr_valid
= at_valid
;
1293 m
->includes_filehdr
= includes_filehdr
;
1294 m
->includes_phdrs
= includes_phdrs
;
1297 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
1299 for (pm
= &elf_tdata (abfd
)->segment_map
; *pm
!= NULL
; pm
= &(*pm
)->next
)
1307 bfd_sprintf_vma (bfd
*abfd
, char *buf
, bfd_vma value
)
1309 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1310 get_elf_backend_data (abfd
)->elf_backend_sprintf_vma (abfd
, buf
, value
);
1312 sprintf_vma (buf
, value
);
1316 bfd_fprintf_vma (bfd
*abfd
, void *stream
, bfd_vma value
)
1318 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1319 get_elf_backend_data (abfd
)->elf_backend_fprintf_vma (abfd
, stream
, value
);
1321 fprintf_vma ((FILE *) stream
, value
);
1329 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1333 When more than one machine code number is available for the
1334 same machine type, this function can be used to switch between
1335 the preferred one (alternative == 0) and any others. Currently,
1336 only ELF supports this feature, with up to two alternate
1341 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
1343 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1347 switch (alternative
)
1350 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
1354 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
1360 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
1369 elf_elfheader (abfd
)->e_machine
= code
;
1380 .struct bfd_preserve
1385 . const struct bfd_arch_info *arch_info;
1386 . struct bfd_section *sections;
1387 . struct bfd_section **section_tail;
1388 . unsigned int section_count;
1389 . struct bfd_hash_table section_htab;
1399 bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1402 When testing an object for compatibility with a particular
1403 target back-end, the back-end object_p function needs to set
1404 up certain fields in the bfd on successfully recognizing the
1405 object. This typically happens in a piecemeal fashion, with
1406 failures possible at many points. On failure, the bfd is
1407 supposed to be restored to its initial state, which is
1408 virtually impossible. However, restoring a subset of the bfd
1409 state works in practice. This function stores the subset and
1410 reinitializes the bfd.
1415 bfd_preserve_save (bfd
*abfd
, struct bfd_preserve
*preserve
)
1417 preserve
->tdata
= abfd
->tdata
.any
;
1418 preserve
->arch_info
= abfd
->arch_info
;
1419 preserve
->flags
= abfd
->flags
;
1420 preserve
->sections
= abfd
->sections
;
1421 preserve
->section_tail
= abfd
->section_tail
;
1422 preserve
->section_count
= abfd
->section_count
;
1423 preserve
->section_htab
= abfd
->section_htab
;
1425 if (! bfd_hash_table_init (&abfd
->section_htab
, bfd_section_hash_newfunc
))
1428 abfd
->tdata
.any
= NULL
;
1429 abfd
->arch_info
= &bfd_default_arch_struct
;
1430 abfd
->flags
&= BFD_IN_MEMORY
;
1431 abfd
->sections
= NULL
;
1432 abfd
->section_tail
= &abfd
->sections
;
1433 abfd
->section_count
= 0;
1440 bfd_preserve_restore
1443 void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1446 This function restores bfd state saved by bfd_preserve_save.
1447 If MARKER is non-NULL in struct bfd_preserve then that block
1448 and all subsequently bfd_alloc'd memory is freed.
1453 bfd_preserve_restore (bfd
*abfd
, struct bfd_preserve
*preserve
)
1455 bfd_hash_table_free (&abfd
->section_htab
);
1457 abfd
->tdata
.any
= preserve
->tdata
;
1458 abfd
->arch_info
= preserve
->arch_info
;
1459 abfd
->flags
= preserve
->flags
;
1460 abfd
->section_htab
= preserve
->section_htab
;
1461 abfd
->sections
= preserve
->sections
;
1462 abfd
->section_tail
= preserve
->section_tail
;
1463 abfd
->section_count
= preserve
->section_count
;
1465 /* bfd_release frees all memory more recently bfd_alloc'd than
1466 its arg, as well as its arg. */
1467 if (preserve
->marker
!= NULL
)
1469 bfd_release (abfd
, preserve
->marker
);
1470 preserve
->marker
= NULL
;
1479 void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1482 This function should be called when the bfd state saved by
1483 bfd_preserve_save is no longer needed. ie. when the back-end
1484 object_p function returns with success.
1489 bfd_preserve_finish (bfd
*abfd ATTRIBUTE_UNUSED
, struct bfd_preserve
*preserve
)
1491 /* It would be nice to be able to free more memory here, eg. old
1492 tdata, but that's not possible since these blocks are sitting
1493 inside bfd_alloc'd memory. The section hash is on a separate
1495 bfd_hash_table_free (&preserve
->section_htab
);