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
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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, 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 last section on the section list. *}
115 . struct bfd_section *section_last;
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 . {* Flag set if symbols from this BFD should not be exported. *}
137 . bfd_boolean no_export;
139 . {* Stuff only useful for archives. *}
141 . struct bfd *my_archive; {* The containing archive BFD. *}
142 . struct bfd *next; {* The next BFD in the archive. *}
143 . struct bfd *archive_head; {* The first BFD in the archive. *}
144 . bfd_boolean has_armap;
146 . {* A chain of BFD structures involved in a link. *}
147 . struct bfd *link_next;
149 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
150 . be used only for archive elements. *}
153 . {* Used by the back end to hold private data. *}
156 . struct aout_data_struct *aout_data;
157 . struct artdata *aout_ar_data;
158 . struct _oasys_data *oasys_obj_data;
159 . struct _oasys_ar_data *oasys_ar_data;
160 . struct coff_tdata *coff_obj_data;
161 . struct pe_tdata *pe_obj_data;
162 . struct xcoff_tdata *xcoff_obj_data;
163 . struct ecoff_tdata *ecoff_obj_data;
164 . struct ieee_data_struct *ieee_data;
165 . struct ieee_ar_data_struct *ieee_ar_data;
166 . struct srec_data_struct *srec_data;
167 . struct ihex_data_struct *ihex_data;
168 . struct tekhex_data_struct *tekhex_data;
169 . struct elf_obj_tdata *elf_obj_data;
170 . struct nlm_obj_tdata *nlm_obj_data;
171 . struct bout_data_struct *bout_data;
172 . struct mmo_data_struct *mmo_data;
173 . struct sun_core_struct *sun_core_data;
174 . struct sco5_core_struct *sco5_core_data;
175 . struct trad_core_struct *trad_core_data;
176 . struct som_data_struct *som_data;
177 . struct hpux_core_struct *hpux_core_data;
178 . struct hppabsd_core_struct *hppabsd_core_data;
179 . struct sgi_core_struct *sgi_core_data;
180 . struct lynx_core_struct *lynx_core_data;
181 . struct osf_core_struct *osf_core_data;
182 . struct cisco_core_struct *cisco_core_data;
183 . struct versados_data_struct *versados_data;
184 . struct netbsd_core_struct *netbsd_core_data;
185 . struct mach_o_data_struct *mach_o_data;
186 . struct mach_o_fat_data_struct *mach_o_fat_data;
187 . struct bfd_pef_data_struct *pef_data;
188 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
189 . struct bfd_sym_data_struct *sym_data;
194 . {* Used by the application to hold private data. *}
197 . {* Where all the allocated stuff under this BFD goes. This is a
198 . struct objalloc *, but we use void * to avoid requiring the inclusion
209 #include "libiberty.h"
210 #include "safe-ctype.h"
213 #include "coff/internal.h"
214 #include "coff/sym.h"
216 #include "libecoff.h"
220 /* provide storage for subsystem, stack and heap data which may have been
221 passed in on the command line. Ld puts this data into a bfd_link_info
222 struct which ultimately gets passed in to the bfd. When it arrives, copy
223 it to the following struct so that the data will be available in coffcode.h
224 where it is needed. The typedef's used are defined in bfd.h */
230 Most BFD functions return nonzero on success (check their
231 individual documentation for precise semantics). On an error,
232 they call <<bfd_set_error>> to set an error condition that callers
233 can check by calling <<bfd_get_error>>.
234 If that returns <<bfd_error_system_call>>, then check
237 The easiest way to report a BFD error to the user is to
241 Type <<bfd_error_type>>
243 The values returned by <<bfd_get_error>> are defined by the
244 enumerated type <<bfd_error_type>>.
248 .typedef enum bfd_error
250 . bfd_error_no_error = 0,
251 . bfd_error_system_call,
252 . bfd_error_invalid_target,
253 . bfd_error_wrong_format,
254 . bfd_error_wrong_object_format,
255 . bfd_error_invalid_operation,
256 . bfd_error_no_memory,
257 . bfd_error_no_symbols,
258 . bfd_error_no_armap,
259 . bfd_error_no_more_archived_files,
260 . bfd_error_malformed_archive,
261 . bfd_error_file_not_recognized,
262 . bfd_error_file_ambiguously_recognized,
263 . bfd_error_no_contents,
264 . bfd_error_nonrepresentable_section,
265 . bfd_error_no_debug_section,
266 . bfd_error_bad_value,
267 . bfd_error_file_truncated,
268 . bfd_error_file_too_big,
269 . bfd_error_invalid_error_code
275 static bfd_error_type bfd_error
= bfd_error_no_error
;
277 const char *const bfd_errmsgs
[] =
280 N_("System call error"),
281 N_("Invalid bfd target"),
282 N_("File in wrong format"),
283 N_("Archive object file in wrong format"),
284 N_("Invalid operation"),
285 N_("Memory exhausted"),
287 N_("Archive has no index; run ranlib to add one"),
288 N_("No more archived files"),
289 N_("Malformed archive"),
290 N_("File format not recognized"),
291 N_("File format is ambiguous"),
292 N_("Section has no contents"),
293 N_("Nonrepresentable section on output"),
294 N_("Symbol needs debug section which does not exist"),
296 N_("File truncated"),
298 N_("#<Invalid error code>")
306 bfd_error_type bfd_get_error (void);
309 Return the current BFD error condition.
323 void bfd_set_error (bfd_error_type error_tag);
326 Set the BFD error condition to be @var{error_tag}.
330 bfd_set_error (bfd_error_type error_tag
)
332 bfd_error
= error_tag
;
340 const char *bfd_errmsg (bfd_error_type error_tag);
343 Return a string describing the error @var{error_tag}, or
344 the system error if @var{error_tag} is <<bfd_error_system_call>>.
348 bfd_errmsg (bfd_error_type error_tag
)
353 if (error_tag
== bfd_error_system_call
)
354 return xstrerror (errno
);
356 if (error_tag
> bfd_error_invalid_error_code
)
357 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
359 return _(bfd_errmsgs
[error_tag
]);
367 void bfd_perror (const char *message);
370 Print to the standard error stream a string describing the
371 last BFD error that occurred, or the last system error if
372 the last BFD error was a system call failure. If @var{message}
373 is non-NULL and non-empty, the error string printed is preceded
374 by @var{message}, a colon, and a space. It is followed by a newline.
378 bfd_perror (const char *message
)
380 if (bfd_get_error () == bfd_error_system_call
)
381 /* Must be a system error then. */
382 perror ((char *) message
);
385 if (message
== NULL
|| *message
== '\0')
386 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
388 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
396 Some BFD functions want to print messages describing the
397 problem. They call a BFD error handler function. This
398 function may be overridden by the program.
400 The BFD error handler acts like printf.
404 .typedef void (*bfd_error_handler_type) (const char *, ...);
408 /* The program name used when printing BFD error messages. */
410 static const char *_bfd_error_program_name
;
412 /* This is the default routine to handle BFD error messages.
413 Like fprintf (stderr, ...), but also handles some extra format specifiers.
415 %A section name from section. For group components, print group name too.
416 %B file name from bfd. For archive components, prints archive too.
420 _bfd_default_error_handler (const char *fmt
, ...)
424 const char *new_fmt
, *p
;
428 if (_bfd_error_program_name
!= NULL
)
429 fprintf (stderr
, "%s: ", _bfd_error_program_name
);
431 fprintf (stderr
, "BFD: ");
437 /* Reserve enough space for the existing format string. */
438 avail
-= strlen (fmt
) + 1;
446 size_t len
, extra
, trim
;
449 if (p
== NULL
|| p
[1] == '\0')
454 memcpy (bufp
, fmt
, len
+ 1);
459 if (p
[1] == 'A' || p
[1] == 'B')
462 memcpy (bufp
, fmt
, len
);
467 /* If we run out of space, tough, you lose your ridiculously
468 long file or section name. It's not safe to try to alloc
469 memory here; We might be printing an out of memory message. */
480 bfd
*abfd
= va_arg (ap
, bfd
*);
481 if (abfd
->my_archive
)
482 snprintf (bufp
, avail
, "%s(%s)",
483 abfd
->my_archive
->filename
, abfd
->filename
);
485 snprintf (bufp
, avail
, "%s", abfd
->filename
);
489 asection
*sec
= va_arg (ap
, asection
*);
490 bfd
*abfd
= sec
->owner
;
491 const char *group
= NULL
;
492 struct coff_comdat_info
*ci
;
495 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
496 && elf_next_in_group (sec
) != NULL
497 && (sec
->flags
& SEC_GROUP
) == 0)
498 group
= elf_group_name (sec
);
499 else if (abfd
!= NULL
500 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
501 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
505 snprintf (bufp
, avail
, "%s[%s]", sec
->name
, group
);
507 snprintf (bufp
, avail
, "%s", sec
->name
);
510 avail
= avail
- len
+ 2;
512 /* We need to replace any '%' we printed by "%%".
513 First count how many. */
517 while ((q
= strchr (q
, '%')) != NULL
)
523 /* If there isn't room, trim off the end of the string. */
528 trim
= extra
- avail
;
541 /* Now double all '%' chars, shuffling the string as we go. */
544 while ((q
[extra
] = *q
) != '%')
554 vfprintf (stderr
, new_fmt
, ap
);
560 /* This is a function pointer to the routine which should handle BFD
561 error messages. It is called when a BFD routine encounters an
562 error for which it wants to print a message. Going through a
563 function pointer permits a program linked against BFD to intercept
564 the messages and deal with them itself. */
566 bfd_error_handler_type _bfd_error_handler
= _bfd_default_error_handler
;
570 bfd_set_error_handler
573 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
576 Set the BFD error handler function. Returns the previous
580 bfd_error_handler_type
581 bfd_set_error_handler (bfd_error_handler_type pnew
)
583 bfd_error_handler_type pold
;
585 pold
= _bfd_error_handler
;
586 _bfd_error_handler
= pnew
;
592 bfd_set_error_program_name
595 void bfd_set_error_program_name (const char *);
598 Set the program name to use when printing a BFD error. This
599 is printed before the error message followed by a colon and
600 space. The string must not be changed after it is passed to
605 bfd_set_error_program_name (const char *name
)
607 _bfd_error_program_name
= name
;
612 bfd_get_error_handler
615 bfd_error_handler_type bfd_get_error_handler (void);
618 Return the BFD error handler function.
621 bfd_error_handler_type
622 bfd_get_error_handler (void)
624 return _bfd_error_handler
;
634 bfd_get_reloc_upper_bound
637 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
640 Return the number of bytes required to store the
641 relocation information associated with section @var{sect}
642 attached to bfd @var{abfd}. If an error occurs, return -1.
647 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
649 if (abfd
->format
!= bfd_object
)
651 bfd_set_error (bfd_error_invalid_operation
);
655 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
660 bfd_canonicalize_reloc
663 long bfd_canonicalize_reloc
664 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
667 Call the back end associated with the open BFD
668 @var{abfd} and translate the external form of the relocation
669 information attached to @var{sec} into the internal canonical
670 form. Place the table into memory at @var{loc}, which has
671 been preallocated, usually by a call to
672 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
675 The @var{syms} table is also needed for horrible internal magic
680 bfd_canonicalize_reloc (bfd
*abfd
,
685 if (abfd
->format
!= bfd_object
)
687 bfd_set_error (bfd_error_invalid_operation
);
691 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
692 (abfd
, asect
, location
, symbols
));
701 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
704 Set the relocation pointer and count within
705 section @var{sec} to the values @var{rel} and @var{count}.
706 The argument @var{abfd} is ignored.
711 bfd_set_reloc (bfd
*ignore_abfd ATTRIBUTE_UNUSED
,
716 asect
->orelocation
= location
;
717 asect
->reloc_count
= count
;
725 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
728 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
731 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
732 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
733 o <<bfd_error_invalid_operation>> -
734 The flag word contained a bit which was not applicable to the
735 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
736 on a BFD format which does not support demand paging.
741 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
743 if (abfd
->format
!= bfd_object
)
745 bfd_set_error (bfd_error_wrong_format
);
749 if (bfd_read_p (abfd
))
751 bfd_set_error (bfd_error_invalid_operation
);
755 bfd_get_file_flags (abfd
) = flags
;
756 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
758 bfd_set_error (bfd_error_invalid_operation
);
766 bfd_assert (const char *file
, int line
)
768 (*_bfd_error_handler
) (_("BFD %s assertion fail %s:%d"),
769 BFD_VERSION_STRING
, file
, line
);
772 /* A more or less friendly abort message. In libbfd.h abort is
773 defined to call this function. */
776 #define EXIT_FAILURE 1
780 _bfd_abort (const char *file
, int line
, const char *fn
)
783 (*_bfd_error_handler
)
784 (_("BFD %s internal error, aborting at %s line %d in %s\n"),
785 BFD_VERSION_STRING
, file
, line
, fn
);
787 (*_bfd_error_handler
)
788 (_("BFD %s internal error, aborting at %s line %d\n"),
789 BFD_VERSION_STRING
, file
, line
);
790 (*_bfd_error_handler
) (_("Please report this bug.\n"));
791 xexit (EXIT_FAILURE
);
799 int bfd_get_arch_size (bfd *abfd);
802 Returns the architecture address size, in bits, as determined
803 by the object file's format. For ELF, this information is
804 included in the header.
807 Returns the arch size in bits if known, <<-1>> otherwise.
811 bfd_get_arch_size (bfd
*abfd
)
813 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
814 return get_elf_backend_data (abfd
)->s
->arch_size
;
821 bfd_get_sign_extend_vma
824 int bfd_get_sign_extend_vma (bfd *abfd);
827 Indicates if the target architecture "naturally" sign extends
828 an address. Some architectures implicitly sign extend address
829 values when they are converted to types larger than the size
830 of an address. For instance, bfd_get_start_address() will
831 return an address sign extended to fill a bfd_vma when this is
835 Returns <<1>> if the target architecture is known to sign
836 extend addresses, <<0>> if the target architecture is known to
837 not sign extend addresses, and <<-1>> otherwise.
841 bfd_get_sign_extend_vma (bfd
*abfd
)
845 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
846 return get_elf_backend_data (abfd
)->sign_extend_vma
;
848 name
= bfd_get_target (abfd
);
850 /* Return a proper value for DJGPP & PE COFF (x86 COFF variants).
851 This function is required for DWARF2 support, but there is
852 no place to store this information in the COFF back end.
853 Should enough other COFF targets add support for DWARF2,
854 a place will have to be found. Until then, this hack will do. */
855 if (strncmp (name
, "coff-go32", sizeof ("coff-go32") - 1) == 0
856 || strcmp (name
, "pe-i386") == 0
857 || strcmp (name
, "pei-i386") == 0)
860 bfd_set_error (bfd_error_wrong_format
);
866 bfd_set_start_address
869 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
872 Make @var{vma} the entry point of output BFD @var{abfd}.
875 Returns <<TRUE>> on success, <<FALSE>> otherwise.
879 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
881 abfd
->start_address
= vma
;
890 unsigned int bfd_get_gp_size (bfd *abfd);
893 Return the maximum size of objects to be optimized using the GP
894 register under MIPS ECOFF. This is typically set by the <<-G>>
895 argument to the compiler, assembler or linker.
899 bfd_get_gp_size (bfd
*abfd
)
901 if (abfd
->format
== bfd_object
)
903 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
904 return ecoff_data (abfd
)->gp_size
;
905 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
906 return elf_gp_size (abfd
);
916 void bfd_set_gp_size (bfd *abfd, unsigned int i);
919 Set the maximum size of objects to be optimized using the GP
920 register under ECOFF or MIPS ELF. This is typically set by
921 the <<-G>> argument to the compiler, assembler or linker.
925 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
927 /* Don't try to set GP size on an archive or core file! */
928 if (abfd
->format
!= bfd_object
)
931 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
932 ecoff_data (abfd
)->gp_size
= i
;
933 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
934 elf_gp_size (abfd
) = i
;
937 /* Get the GP value. This is an internal function used by some of the
938 relocation special_function routines on targets which support a GP
942 _bfd_get_gp_value (bfd
*abfd
)
946 if (abfd
->format
!= bfd_object
)
949 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
950 return ecoff_data (abfd
)->gp
;
951 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
952 return elf_gp (abfd
);
957 /* Set the GP value. */
960 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
964 if (abfd
->format
!= bfd_object
)
967 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
968 ecoff_data (abfd
)->gp
= v
;
969 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
978 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
981 Convert, like <<strtoul>>, a numerical expression
982 @var{string} into a <<bfd_vma>> integer, and return that integer.
983 (Though without as many bells and whistles as <<strtoul>>.)
984 The expression is assumed to be unsigned (i.e., positive).
985 If given a @var{base}, it is used as the base for conversion.
986 A base of 0 causes the function to interpret the string
987 in hex if a leading "0x" or "0X" is found, otherwise
988 in octal if a leading zero is found, otherwise in decimal.
990 If the value would overflow, the maximum <<bfd_vma>> value is
995 bfd_scan_vma (const char *string
, const char **end
, int base
)
1002 /* Let the host do it if possible. */
1003 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
1004 return strtoul (string
, (char **) end
, base
);
1006 #ifdef HAVE_STRTOULL
1007 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
1008 return strtoull (string
, (char **) end
, base
);
1013 if (string
[0] == '0')
1015 if ((string
[1] == 'x') || (string
[1] == 'X'))
1022 if ((base
< 2) || (base
> 36))
1027 && (string
[1] == 'x' || string
[1] == 'X')
1028 && ISXDIGIT (string
[2]))
1033 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
1034 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
1042 if (ISDIGIT (digit
))
1043 digit
= digit
- '0';
1044 else if (ISALPHA (digit
))
1045 digit
= TOUPPER (digit
) - 'A' + 10;
1048 if (digit
>= (unsigned int) base
)
1050 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
1052 value
= value
* base
+ digit
;
1057 value
= ~ (bfd_vma
) 0;
1067 bfd_copy_private_header_data
1070 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1073 Copy private BFD header information from the BFD @var{ibfd} to the
1074 the BFD @var{obfd}. This copies information that may require
1075 sections to exist, but does not require symbol tables. Return
1076 <<true>> on success, <<false>> on error.
1077 Possible error returns are:
1079 o <<bfd_error_no_memory>> -
1080 Not enough memory exists to create private data for @var{obfd}.
1082 .#define bfd_copy_private_header_data(ibfd, obfd) \
1083 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1090 bfd_copy_private_bfd_data
1093 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1096 Copy private BFD information from the BFD @var{ibfd} to the
1097 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1098 Possible error returns are:
1100 o <<bfd_error_no_memory>> -
1101 Not enough memory exists to create private data for @var{obfd}.
1103 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1104 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1111 bfd_merge_private_bfd_data
1114 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
1117 Merge private BFD information from the BFD @var{ibfd} to the
1118 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1119 on success, <<FALSE>> on error. Possible error returns are:
1121 o <<bfd_error_no_memory>> -
1122 Not enough memory exists to create private data for @var{obfd}.
1124 .#define bfd_merge_private_bfd_data(ibfd, obfd) \
1125 . BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1132 bfd_set_private_flags
1135 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1138 Set private BFD flag information in the BFD @var{abfd}.
1139 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1142 o <<bfd_error_no_memory>> -
1143 Not enough memory exists to create private data for @var{obfd}.
1145 .#define bfd_set_private_flags(abfd, flags) \
1146 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1155 The following functions exist but have not yet been documented.
1157 .#define bfd_sizeof_headers(abfd, reloc) \
1158 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
1160 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1161 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1162 . (abfd, sec, syms, off, file, func, line))
1164 .#define bfd_find_line(abfd, syms, sym, file, line) \
1165 . BFD_SEND (abfd, _bfd_find_line, \
1166 . (abfd, syms, sym, file, line))
1168 .#define bfd_find_inliner_info(abfd, file, func, line) \
1169 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1170 . (abfd, file, func, line))
1172 .#define bfd_debug_info_start(abfd) \
1173 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1175 .#define bfd_debug_info_end(abfd) \
1176 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1178 .#define bfd_debug_info_accumulate(abfd, section) \
1179 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1181 .#define bfd_stat_arch_elt(abfd, stat) \
1182 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1184 .#define bfd_update_armap_timestamp(abfd) \
1185 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1187 .#define bfd_set_arch_mach(abfd, arch, mach)\
1188 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1190 .#define bfd_relax_section(abfd, section, link_info, again) \
1191 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1193 .#define bfd_gc_sections(abfd, link_info) \
1194 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1196 .#define bfd_merge_sections(abfd, link_info) \
1197 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1199 .#define bfd_is_group_section(abfd, sec) \
1200 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1202 .#define bfd_discard_group(abfd, sec) \
1203 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1205 .#define bfd_link_hash_table_create(abfd) \
1206 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1208 .#define bfd_link_hash_table_free(abfd, hash) \
1209 . BFD_SEND (abfd, _bfd_link_hash_table_free, (hash))
1211 .#define bfd_link_add_symbols(abfd, info) \
1212 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1214 .#define bfd_link_just_syms(abfd, sec, info) \
1215 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1217 .#define bfd_final_link(abfd, info) \
1218 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1220 .#define bfd_free_cached_info(abfd) \
1221 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1223 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1224 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1226 .#define bfd_print_private_bfd_data(abfd, file)\
1227 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1229 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1230 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1232 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1233 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1234 . dyncount, dynsyms, ret))
1236 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1237 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1239 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1240 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1242 .extern bfd_byte *bfd_get_relocated_section_contents
1243 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1244 . bfd_boolean, asymbol **);
1250 bfd_get_relocated_section_contents (bfd
*abfd
,
1251 struct bfd_link_info
*link_info
,
1252 struct bfd_link_order
*link_order
,
1254 bfd_boolean relocatable
,
1258 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
1259 bfd_byte
*, bfd_boolean
, asymbol
**);
1261 if (link_order
->type
== bfd_indirect_link_order
)
1263 abfd2
= link_order
->u
.indirect
.section
->owner
;
1270 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
1272 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
1275 /* Record information about an ELF program header. */
1278 bfd_record_phdr (bfd
*abfd
,
1280 bfd_boolean flags_valid
,
1282 bfd_boolean at_valid
,
1284 bfd_boolean includes_filehdr
,
1285 bfd_boolean includes_phdrs
,
1289 struct elf_segment_map
*m
, **pm
;
1292 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
1295 amt
= sizeof (struct elf_segment_map
);
1296 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
1297 m
= bfd_alloc (abfd
, amt
);
1305 m
->p_flags_valid
= flags_valid
;
1306 m
->p_paddr_valid
= at_valid
;
1307 m
->includes_filehdr
= includes_filehdr
;
1308 m
->includes_phdrs
= includes_phdrs
;
1311 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
1313 for (pm
= &elf_tdata (abfd
)->segment_map
; *pm
!= NULL
; pm
= &(*pm
)->next
)
1321 bfd_sprintf_vma (bfd
*abfd
, char *buf
, bfd_vma value
)
1323 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1324 get_elf_backend_data (abfd
)->elf_backend_sprintf_vma (abfd
, buf
, value
);
1326 sprintf_vma (buf
, value
);
1330 bfd_fprintf_vma (bfd
*abfd
, void *stream
, bfd_vma value
)
1332 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1333 get_elf_backend_data (abfd
)->elf_backend_fprintf_vma (abfd
, stream
, value
);
1335 fprintf_vma ((FILE *) stream
, value
);
1343 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
1347 When more than one machine code number is available for the
1348 same machine type, this function can be used to switch between
1349 the preferred one (alternative == 0) and any others. Currently,
1350 only ELF supports this feature, with up to two alternate
1355 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
1357 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1361 switch (alternative
)
1364 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
1368 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
1374 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
1383 elf_elfheader (abfd
)->e_machine
= code
;
1394 .struct bfd_preserve
1399 . const struct bfd_arch_info *arch_info;
1400 . struct bfd_section *sections;
1401 . struct bfd_section *section_last;
1402 . unsigned int section_count;
1403 . struct bfd_hash_table section_htab;
1413 bfd_boolean bfd_preserve_save (bfd *, struct bfd_preserve *);
1416 When testing an object for compatibility with a particular
1417 target back-end, the back-end object_p function needs to set
1418 up certain fields in the bfd on successfully recognizing the
1419 object. This typically happens in a piecemeal fashion, with
1420 failures possible at many points. On failure, the bfd is
1421 supposed to be restored to its initial state, which is
1422 virtually impossible. However, restoring a subset of the bfd
1423 state works in practice. This function stores the subset and
1424 reinitializes the bfd.
1429 bfd_preserve_save (bfd
*abfd
, struct bfd_preserve
*preserve
)
1431 preserve
->tdata
= abfd
->tdata
.any
;
1432 preserve
->arch_info
= abfd
->arch_info
;
1433 preserve
->flags
= abfd
->flags
;
1434 preserve
->sections
= abfd
->sections
;
1435 preserve
->section_last
= abfd
->section_last
;
1436 preserve
->section_count
= abfd
->section_count
;
1437 preserve
->section_htab
= abfd
->section_htab
;
1439 if (! bfd_hash_table_init (&abfd
->section_htab
, bfd_section_hash_newfunc
))
1442 abfd
->tdata
.any
= NULL
;
1443 abfd
->arch_info
= &bfd_default_arch_struct
;
1444 abfd
->flags
&= BFD_IN_MEMORY
;
1445 abfd
->sections
= NULL
;
1446 abfd
->section_last
= NULL
;
1447 abfd
->section_count
= 0;
1454 bfd_preserve_restore
1457 void bfd_preserve_restore (bfd *, struct bfd_preserve *);
1460 This function restores bfd state saved by bfd_preserve_save.
1461 If MARKER is non-NULL in struct bfd_preserve then that block
1462 and all subsequently bfd_alloc'd memory is freed.
1467 bfd_preserve_restore (bfd
*abfd
, struct bfd_preserve
*preserve
)
1469 bfd_hash_table_free (&abfd
->section_htab
);
1471 abfd
->tdata
.any
= preserve
->tdata
;
1472 abfd
->arch_info
= preserve
->arch_info
;
1473 abfd
->flags
= preserve
->flags
;
1474 abfd
->section_htab
= preserve
->section_htab
;
1475 abfd
->sections
= preserve
->sections
;
1476 abfd
->section_last
= preserve
->section_last
;
1477 abfd
->section_count
= preserve
->section_count
;
1479 /* bfd_release frees all memory more recently bfd_alloc'd than
1480 its arg, as well as its arg. */
1481 if (preserve
->marker
!= NULL
)
1483 bfd_release (abfd
, preserve
->marker
);
1484 preserve
->marker
= NULL
;
1493 void bfd_preserve_finish (bfd *, struct bfd_preserve *);
1496 This function should be called when the bfd state saved by
1497 bfd_preserve_save is no longer needed. ie. when the back-end
1498 object_p function returns with success.
1503 bfd_preserve_finish (bfd
*abfd ATTRIBUTE_UNUSED
, struct bfd_preserve
*preserve
)
1505 /* It would be nice to be able to free more memory here, eg. old
1506 tdata, but that's not possible since these blocks are sitting
1507 inside bfd_alloc'd memory. The section hash is on a separate
1509 bfd_hash_table_free (&preserve
->section_htab
);
1517 void bfd_hide_symbol (bfd *,
1518 struct bfd_link_info *,
1519 struct bfd_link_hash_entry *,
1523 This function hides a symbol so that it won't be exported.
1528 bfd_hide_symbol (bfd
*abfd
,
1529 struct bfd_link_info
*link_info
,
1530 struct bfd_link_hash_entry
*h
,
1531 bfd_boolean force_local
)
1533 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1534 (get_elf_backend_data (abfd
)->elf_backend_hide_symbol
)
1535 (link_info
, (struct elf_link_hash_entry
*) h
, force_local
);