1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2018 Free Software Foundation, Inc.
3 Written by Cygnus Support.
5 This file is part of BFD, the Binary File Descriptor library.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20 MA 02110-1301, USA. */
24 typedef bfd, Error reporting, BFD front end, BFD front end
29 A BFD has type <<bfd>>; objects of this type are the
30 cornerstone of any application using BFD. Using BFD
31 consists of making references though the BFD and to data in the BFD.
33 Here is the structure that defines the type <<bfd>>. It
34 contains the major data about the file and pointers
35 to the rest of the data.
43 . write_direction = 2,
47 .enum bfd_plugin_format
49 . bfd_plugin_unknown = 0,
62 . {* The filename the application opened the BFD with. *}
63 . const char *filename;
65 . {* A pointer to the target jump table. *}
66 . const struct bfd_target *xvec;
68 . {* The IOSTREAM, and corresponding IO vector that provide access
69 . to the file backing the BFD. *}
71 . const struct bfd_iovec *iovec;
73 . {* The caching routines use these to maintain a
74 . least-recently-used list of BFDs. *}
75 . struct bfd *lru_prev, *lru_next;
77 . {* When a file is closed by the caching routines, BFD retains
78 . state information on the file here... *}
81 . {* File modified time, if mtime_set is TRUE. *}
84 . {* A unique identifier of the BFD *}
87 . {* The format which belongs to the BFD. (object, core, etc.) *}
88 . ENUM_BITFIELD (bfd_format) format : 3;
90 . {* The direction with which the BFD was opened. *}
91 . ENUM_BITFIELD (bfd_direction) direction : 2;
93 . {* Format_specific flags. *}
94 . flagword flags : 20;
96 . {* Values that may appear in the flags field of a BFD. These also
97 . appear in the object_flags field of the bfd_target structure, where
98 . they indicate the set of flags used by that backend (not all flags
99 . are meaningful for all object file formats) (FIXME: at the moment,
100 . the object_flags values have mostly just been copied from backend
101 . to another, and are not necessarily correct). *}
103 .#define BFD_NO_FLAGS 0x0
105 . {* BFD contains relocation entries. *}
106 .#define HAS_RELOC 0x1
108 . {* BFD is directly executable. *}
111 . {* BFD has line number information (basically used for F_LNNO in a
113 .#define HAS_LINENO 0x4
115 . {* BFD has debugging information. *}
116 .#define HAS_DEBUG 0x08
118 . {* BFD has symbols. *}
119 .#define HAS_SYMS 0x10
121 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
123 .#define HAS_LOCALS 0x20
125 . {* BFD is a dynamic object. *}
126 .#define DYNAMIC 0x40
128 . {* Text section is write protected (if D_PAGED is not set, this is
129 . like an a.out NMAGIC file) (the linker sets this by default, but
130 . clears it for -r or -N). *}
131 .#define WP_TEXT 0x80
133 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
134 . linker sets this by default, but clears it for -r or -n or -N). *}
135 .#define D_PAGED 0x100
137 . {* BFD is relaxable (this means that bfd_relax_section may be able to
138 . do something) (sometimes bfd_relax_section can do something even if
139 . this is not set). *}
140 .#define BFD_IS_RELAXABLE 0x200
142 . {* This may be set before writing out a BFD to request using a
143 . traditional format. For example, this is used to request that when
144 . writing out an a.out object the symbols not be hashed to eliminate
146 .#define BFD_TRADITIONAL_FORMAT 0x400
148 . {* This flag indicates that the BFD contents are actually cached
149 . in memory. If this is set, iostream points to a bfd_in_memory
151 .#define BFD_IN_MEMORY 0x800
153 . {* This BFD has been created by the linker and doesn't correspond
154 . to any input file. *}
155 .#define BFD_LINKER_CREATED 0x1000
157 . {* This may be set before writing out a BFD to request that it
158 . be written using values for UIDs, GIDs, timestamps, etc. that
159 . will be consistent from run to run. *}
160 .#define BFD_DETERMINISTIC_OUTPUT 0x2000
162 . {* Compress sections in this BFD. *}
163 .#define BFD_COMPRESS 0x4000
165 . {* Decompress sections in this BFD. *}
166 .#define BFD_DECOMPRESS 0x8000
168 . {* BFD is a dummy, for plugins. *}
169 .#define BFD_PLUGIN 0x10000
171 . {* Compress sections in this BFD with SHF_COMPRESSED from gABI. *}
172 .#define BFD_COMPRESS_GABI 0x20000
174 . {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
176 .#define BFD_CONVERT_ELF_COMMON 0x40000
178 . {* Use the ELF STT_COMMON type in this BFD. *}
179 .#define BFD_USE_ELF_STT_COMMON 0x80000
181 . {* Flags bits to be saved in bfd_preserve_save. *}
182 .#define BFD_FLAGS_SAVED \
183 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
184 . | BFD_PLUGIN | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON \
185 . | BFD_USE_ELF_STT_COMMON)
187 . {* Flags bits which are for BFD use only. *}
188 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
189 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
190 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
191 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
193 . {* Is the file descriptor being cached? That is, can it be closed as
194 . needed, and re-opened when accessed later? *}
195 . unsigned int cacheable : 1;
197 . {* Marks whether there was a default target specified when the
198 . BFD was opened. This is used to select which matching algorithm
199 . to use to choose the back end. *}
200 . unsigned int target_defaulted : 1;
202 . {* ... and here: (``once'' means at least once). *}
203 . unsigned int opened_once : 1;
205 . {* Set if we have a locally maintained mtime value, rather than
206 . getting it from the file each time. *}
207 . unsigned int mtime_set : 1;
209 . {* Flag set if symbols from this BFD should not be exported. *}
210 . unsigned int no_export : 1;
212 . {* Remember when output has begun, to stop strange things
214 . unsigned int output_has_begun : 1;
216 . {* Have archive map. *}
217 . unsigned int has_armap : 1;
219 . {* Set if this is a thin archive. *}
220 . unsigned int is_thin_archive : 1;
222 . {* Set if only required symbols should be added in the link hash table for
223 . this object. Used by VMS linkers. *}
224 . unsigned int selective_search : 1;
226 . {* Set if this is the linker output BFD. *}
227 . unsigned int is_linker_output : 1;
229 . {* Set if this is the linker input BFD. *}
230 . unsigned int is_linker_input : 1;
232 . {* If this is an input for a compiler plug-in library. *}
233 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
235 . {* Set if this is a plugin output file. *}
236 . unsigned int lto_output : 1;
238 . {* Set to dummy BFD created when claimed by a compiler plug-in
240 . bfd *plugin_dummy_bfd;
242 . {* Currently my_archive is tested before adding origin to
243 . anything. I believe that this can become always an add of
244 . origin, with origin set to 0 for non archive files. *}
247 . {* The origin in the archive of the proxy entry. This will
248 . normally be the same as origin, except for thin archives,
249 . when it will contain the current offset of the proxy in the
250 . thin archive rather than the offset of the bfd in its actual
252 . ufile_ptr proxy_origin;
254 . {* A hash table for section names. *}
255 . struct bfd_hash_table section_htab;
257 . {* Pointer to linked list of sections. *}
258 . struct bfd_section *sections;
260 . {* The last section on the section list. *}
261 . struct bfd_section *section_last;
263 . {* The number of sections. *}
264 . unsigned int section_count;
266 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
267 . be used only for archive elements. *}
270 . {* Stuff only useful for object files:
271 . The start address. *}
272 . bfd_vma start_address;
274 . {* Symbol table for output BFD (with symcount entries).
275 . Also used by the linker to cache input BFD symbols. *}
276 . struct bfd_symbol **outsymbols;
278 . {* Used for input and output. *}
279 . unsigned int symcount;
281 . {* Used for slurped dynamic symbol tables. *}
282 . unsigned int dynsymcount;
284 . {* Pointer to structure which contains architecture information. *}
285 . const struct bfd_arch_info *arch_info;
287 . {* Stuff only useful for archives. *}
289 . struct bfd *my_archive; {* The containing archive BFD. *}
290 . struct bfd *archive_next; {* The next BFD in the archive. *}
291 . struct bfd *archive_head; {* The first BFD in the archive. *}
292 . struct bfd *nested_archives; {* List of nested archive in a flattened
296 . {* For input BFDs, a chain of BFDs involved in a link. *}
298 . {* For output BFD, the linker hash table. *}
299 . struct bfd_link_hash_table *hash;
302 . {* Used by the back end to hold private data. *}
305 . struct aout_data_struct *aout_data;
306 . struct artdata *aout_ar_data;
307 . struct _oasys_data *oasys_obj_data;
308 . struct _oasys_ar_data *oasys_ar_data;
309 . struct coff_tdata *coff_obj_data;
310 . struct pe_tdata *pe_obj_data;
311 . struct xcoff_tdata *xcoff_obj_data;
312 . struct ecoff_tdata *ecoff_obj_data;
313 . struct srec_data_struct *srec_data;
314 . struct verilog_data_struct *verilog_data;
315 . struct ihex_data_struct *ihex_data;
316 . struct tekhex_data_struct *tekhex_data;
317 . struct elf_obj_tdata *elf_obj_data;
318 . struct mmo_data_struct *mmo_data;
319 . struct sun_core_struct *sun_core_data;
320 . struct sco5_core_struct *sco5_core_data;
321 . struct trad_core_struct *trad_core_data;
322 . struct som_data_struct *som_data;
323 . struct hpux_core_struct *hpux_core_data;
324 . struct hppabsd_core_struct *hppabsd_core_data;
325 . struct sgi_core_struct *sgi_core_data;
326 . struct lynx_core_struct *lynx_core_data;
327 . struct osf_core_struct *osf_core_data;
328 . struct cisco_core_struct *cisco_core_data;
329 . struct versados_data_struct *versados_data;
330 . struct netbsd_core_struct *netbsd_core_data;
331 . struct mach_o_data_struct *mach_o_data;
332 . struct mach_o_fat_data_struct *mach_o_fat_data;
333 . struct plugin_data_struct *plugin_data;
334 . struct bfd_pef_data_struct *pef_data;
335 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
336 . struct bfd_sym_data_struct *sym_data;
341 . {* Used by the application to hold private data. *}
344 . {* Where all the allocated stuff under this BFD goes. This is a
345 . struct objalloc *, but we use void * to avoid requiring the inclusion
349 . {* For input BFDs, the build ID, if the object has one. *}
350 . const struct bfd_build_id *build_id;
353 .{* See note beside bfd_set_section_userdata. *}
354 .static inline bfd_boolean
355 .bfd_set_cacheable (bfd * abfd, bfd_boolean val)
357 . abfd->cacheable = val;
367 #include "libiberty.h"
368 #include "demangle.h"
369 #include "safe-ctype.h"
372 #include "coff/internal.h"
373 #include "coff/sym.h"
375 #include "libecoff.h"
380 #define EXIT_FAILURE 1
384 /* provide storage for subsystem, stack and heap data which may have been
385 passed in on the command line. Ld puts this data into a bfd_link_info
386 struct which ultimately gets passed in to the bfd. When it arrives, copy
387 it to the following struct so that the data will be available in coffcode.h
388 where it is needed. The typedef's used are defined in bfd.h */
392 Error reporting, Miscellaneous, typedef bfd, BFD front end
397 Most BFD functions return nonzero on success (check their
398 individual documentation for precise semantics). On an error,
399 they call <<bfd_set_error>> to set an error condition that callers
400 can check by calling <<bfd_get_error>>.
401 If that returns <<bfd_error_system_call>>, then check
404 The easiest way to report a BFD error to the user is to
408 Type <<bfd_error_type>>
410 The values returned by <<bfd_get_error>> are defined by the
411 enumerated type <<bfd_error_type>>.
415 .typedef enum bfd_error
417 . bfd_error_no_error = 0,
418 . bfd_error_system_call,
419 . bfd_error_invalid_target,
420 . bfd_error_wrong_format,
421 . bfd_error_wrong_object_format,
422 . bfd_error_invalid_operation,
423 . bfd_error_no_memory,
424 . bfd_error_no_symbols,
425 . bfd_error_no_armap,
426 . bfd_error_no_more_archived_files,
427 . bfd_error_malformed_archive,
428 . bfd_error_missing_dso,
429 . bfd_error_file_not_recognized,
430 . bfd_error_file_ambiguously_recognized,
431 . bfd_error_no_contents,
432 . bfd_error_nonrepresentable_section,
433 . bfd_error_no_debug_section,
434 . bfd_error_bad_value,
435 . bfd_error_file_truncated,
436 . bfd_error_file_too_big,
437 . bfd_error_on_input,
438 . bfd_error_invalid_error_code
444 static bfd_error_type bfd_error = bfd_error_no_error;
445 static bfd *input_bfd = NULL;
446 static bfd_error_type input_error = bfd_error_no_error;
448 const char *const bfd_errmsgs[] =
451 N_("system call error"),
452 N_("invalid bfd target"),
453 N_("file in wrong format"),
454 N_("archive object file in wrong format"),
455 N_("invalid operation"),
456 N_("memory exhausted"),
458 N_("archive has no index; run ranlib to add one"),
459 N_("no more archived files"),
460 N_("malformed archive"),
461 N_("DSO missing from command line"),
462 N_("file format not recognized"),
463 N_("file format is ambiguous"),
464 N_("section has no contents"),
465 N_("nonrepresentable section on output"),
466 N_("symbol needs debug section which does not exist"),
468 N_("file truncated"),
470 N_("error reading %s: %s"),
471 N_("#<invalid error code>")
479 bfd_error_type bfd_get_error (void);
482 Return the current BFD error condition.
496 void bfd_set_error (bfd_error_type error_tag);
499 Set the BFD error condition to be @var{error_tag}.
501 @var{error_tag} must not be bfd_error_on_input. Use
502 bfd_set_input_error for input errors instead.
506 bfd_set_error (bfd_error_type error_tag)
508 bfd_error = error_tag;
509 if (bfd_error >= bfd_error_on_input)
518 void bfd_set_input_error (bfd *input, bfd_error_type error_tag);
522 Set the BFD error condition to be bfd_error_on_input.
523 @var{input} is the input bfd where the error occurred, and
524 @var{error_tag} the bfd_error_type error.
528 bfd_set_input_error (bfd *input, bfd_error_type error_tag)
530 /* This is an error that occurred during bfd_close when writing an
531 archive, but on one of the input files. */
532 bfd_error = bfd_error_on_input;
534 input_error = error_tag;
535 if (input_error >= bfd_error_on_input)
544 const char *bfd_errmsg (bfd_error_type error_tag);
547 Return a string describing the error @var{error_tag}, or
548 the system error if @var{error_tag} is <<bfd_error_system_call>>.
552 bfd_errmsg (bfd_error_type error_tag)
557 if (error_tag == bfd_error_on_input)
560 const char *msg = bfd_errmsg (input_error);
562 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
566 /* Ick, what to do on out of memory? */
570 if (error_tag == bfd_error_system_call)
571 return xstrerror (errno);
573 if (error_tag > bfd_error_invalid_error_code)
574 error_tag = bfd_error_invalid_error_code; /* sanity check */
576 return _(bfd_errmsgs [error_tag]);
584 void bfd_perror (const char *message);
587 Print to the standard error stream a string describing the
588 last BFD error that occurred, or the last system error if
589 the last BFD error was a system call failure. If @var{message}
590 is non-NULL and non-empty, the error string printed is preceded
591 by @var{message}, a colon, and a space. It is followed by a newline.
595 bfd_perror (const char *message)
598 if (message == NULL || *message == '\0')
599 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
601 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
609 Some BFD functions want to print messages describing the
610 problem. They call a BFD error handler function. This
611 function may be overridden by the program.
613 The BFD error handler acts like vprintf.
617 .typedef void (*bfd_error_handler_type) (const char *, va_list);
621 /* The program name used when printing BFD error messages. */
623 static const char *_bfd_error_program_name;
625 /* Support for positional parameters. */
627 union _bfd_doprnt_args
647 /* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a
648 little and extended to handle '%pA', '%pB' and positional parameters. */
650 #define PRINT_TYPE(TYPE, FIELD) \
653 TYPE value = (TYPE) args[arg_no].FIELD; \
654 result = fprintf (stream, specifier, value); \
658 _bfd_doprnt (FILE *stream, const char *format, union _bfd_doprnt_args *args)
660 const char *ptr = format;
662 int total_printed = 0;
663 unsigned int arg_count = 0;
671 /* While we have regular characters, print them. */
672 char *end = strchr (ptr, '%');
674 result = fprintf (stream, "%.*s", (int) (end - ptr), ptr);
676 result = fprintf (stream, "%s", ptr);
679 else if (ptr[1] == '%')
687 /* We have a format specifier! */
688 char *sptr = specifier;
689 int wide_width = 0, short_width = 0;
692 /* Copy the % and move forward. */
695 /* Check for a positional parameter. */
697 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
703 /* Move past flags. */
704 while (strchr ("-+ #0'I", *ptr))
710 unsigned int arg_index;
713 arg_index = arg_count;
714 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
716 arg_index = *ptr - '1';
719 value = abs (args[arg_index].i);
721 sptr += sprintf (sptr, "%d", value);
724 /* Handle explicit numeric value. */
725 while (ISDIGIT (*ptr))
731 /* Copy and go past the period. */
736 unsigned int arg_index;
739 arg_index = arg_count;
740 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
742 arg_index = *ptr - '1';
745 value = abs (args[arg_index].i);
747 sptr += sprintf (sptr, "%d", value);
750 /* Handle explicit numeric value. */
751 while (ISDIGIT (*ptr))
754 while (strchr ("hlL", *ptr))
773 /* Copy the type specifier, and NULL terminate. */
776 if ((int) arg_no < 0)
789 /* Short values are promoted to int, so just copy it
790 as an int and trust the C library printf to cast it
791 to the right width. */
802 PRINT_TYPE (long, l);
806 #if defined (__MSVCRT__)
813 #if defined (__GNUC__) || defined (HAVE_LONG_LONG)
814 PRINT_TYPE (long long, ll);
816 /* Fake it and hope for the best. */
817 PRINT_TYPE (long, l);
831 PRINT_TYPE (double, d);
834 #if defined (__GNUC__) || defined (HAVE_LONG_DOUBLE)
835 PRINT_TYPE (long double, ld);
837 /* Fake it and hope for the best. */
838 PRINT_TYPE (double, d);
844 PRINT_TYPE (char *, p);
851 const char *group = NULL;
852 struct coff_comdat_info *ci;
855 sec = (asection *) args[arg_no].p;
857 /* Invoking %pA with a null section pointer is an
862 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
863 && elf_next_in_group (sec) != NULL
864 && (sec->flags & SEC_GROUP) == 0)
865 group = elf_group_name (sec);
866 else if (abfd != NULL
867 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
868 && (ci = bfd_coff_get_comdat_section (sec->owner,
872 result = fprintf (stream, "%s[%s]", sec->name, group);
874 result = fprintf (stream, "%s", sec->name);
876 else if (*ptr == 'B')
881 abfd = (bfd *) args[arg_no].p;
883 /* Invoking %pB with a null bfd pointer is an
886 else if (abfd->my_archive
887 && !bfd_is_thin_archive (abfd->my_archive))
888 result = fprintf (stream, "%s(%s)",
889 abfd->my_archive->filename,
892 result = fprintf (stream, "%s", abfd->filename);
895 PRINT_TYPE (void *, p);
904 total_printed += result;
907 return total_printed;
910 /* First pass over FORMAT to gather ARGS. Returns number of args. */
913 _bfd_doprnt_scan (const char *format, union _bfd_doprnt_args *args)
915 const char *ptr = format;
916 unsigned int arg_count = 0;
922 ptr = strchr (ptr, '%');
926 else if (ptr[1] == '%')
930 int wide_width = 0, short_width = 0;
936 /* Check for a positional parameter. */
938 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
944 /* Move past flags. */
945 while (strchr ("-+ #0'I", *ptr))
950 unsigned int arg_index;
953 arg_index = arg_count;
954 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
956 arg_index = *ptr - '1';
961 args[arg_index].type = Int;
965 /* Handle explicit numeric value. */
966 while (ISDIGIT (*ptr))
975 unsigned int arg_index;
978 arg_index = arg_count;
979 if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
981 arg_index = *ptr - '1';
986 args[arg_index].type = Int;
990 /* Handle explicit numeric value. */
991 while (ISDIGIT (*ptr))
994 while (strchr ("hlL", *ptr))
1014 if ((int) arg_no < 0)
1042 #if defined (__GNUC__) || defined (HAVE_LONG_LONG)
1043 arg_type = LongLong;
1058 if (wide_width == 0)
1062 #if defined (__GNUC__) || defined (HAVE_LONG_DOUBLE)
1063 arg_type = LongDouble;
1074 if (*ptr == 'A' || *ptr == 'B')
1084 args[arg_no].type = arg_type;
1092 /* This is the default routine to handle BFD error messages.
1093 Like fprintf (stderr, ...), but also handles some extra format specifiers.
1095 %pA section name from section. For group components, prints group name too.
1096 %pB file name from bfd. For archive components, prints archive too.
1098 Beware: Only supports a maximum of 9 format arguments. */
1101 error_handler_internal (const char *fmt, va_list ap)
1103 unsigned int i, arg_count;
1104 union _bfd_doprnt_args args[9];
1106 for (i = 0; i < sizeof (args) / sizeof (args[0]); i++)
1109 arg_count = _bfd_doprnt_scan (fmt, args);
1110 for (i = 0; i < arg_count; i++)
1112 switch (args[i].type)
1115 args[i].i = va_arg (ap, int);
1118 args[i].l = va_arg (ap, long);
1121 args[i].ll = va_arg (ap, long long);
1124 args[i].d = va_arg (ap, double);
1127 args[i].ld = va_arg (ap, long double);
1130 args[i].p = va_arg (ap, void *);
1137 /* PR 4992: Don't interrupt output being sent to stdout. */
1140 if (_bfd_error_program_name != NULL)
1141 fprintf (stderr, "%s: ", _bfd_error_program_name);
1143 fprintf (stderr, "BFD: ");
1145 _bfd_doprnt (stderr, fmt, args);
1147 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
1148 warning, so use the fputc function to avoid it. */
1149 fputc ('\n', stderr);
1153 /* This is a function pointer to the routine which should handle BFD
1154 error messages. It is called when a BFD routine encounters an
1155 error for which it wants to print a message. Going through a
1156 function pointer permits a program linked against BFD to intercept
1157 the messages and deal with them itself. */
1159 static bfd_error_handler_type _bfd_error_internal = error_handler_internal;
1162 _bfd_error_handler (const char *fmt, ...)
1167 _bfd_error_internal (fmt, ap);
1173 bfd_set_error_handler
1176 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
1179 Set the BFD error handler function. Returns the previous
1183 bfd_error_handler_type
1184 bfd_set_error_handler (bfd_error_handler_type pnew)
1186 bfd_error_handler_type pold;
1188 pold = _bfd_error_internal;
1189 _bfd_error_internal = pnew;
1195 bfd_set_error_program_name
1198 void bfd_set_error_program_name (const char *);
1201 Set the program name to use when printing a BFD error. This
1202 is printed before the error message followed by a colon and
1203 space. The string must not be changed after it is passed to
1208 bfd_set_error_program_name (const char *name)
1210 _bfd_error_program_name = name;
1217 If BFD finds an internal inconsistency, the bfd assert
1218 handler is called with information on the BFD version, BFD
1219 source file and line. If this happens, most programs linked
1220 against BFD are expected to want to exit with an error, or mark
1221 the current BFD operation as failed, so it is recommended to
1222 override the default handler, which just calls
1223 _bfd_error_handler and continues.
1227 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
1228 . const char *bfd_version,
1229 . const char *bfd_file,
1234 /* Note the use of bfd_ prefix on the parameter names above: we want to
1235 show which one is the message and which is the version by naming the
1236 parameters, but avoid polluting the program-using-bfd namespace as
1237 the typedef is visible in the exported headers that the program
1238 includes. Below, it's just for consistency. */
1241 _bfd_default_assert_handler (const char *bfd_formatmsg,
1242 const char *bfd_version,
1243 const char *bfd_file,
1247 _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
1250 /* Similar to _bfd_error_handler, a program can decide to exit on an
1251 internal BFD error. We use a non-variadic type to simplify passing
1252 on parameters to other functions, e.g. _bfd_error_handler. */
1254 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
1258 bfd_set_assert_handler
1261 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
1264 Set the BFD assert handler function. Returns the previous
1268 bfd_assert_handler_type
1269 bfd_set_assert_handler (bfd_assert_handler_type pnew)
1271 bfd_assert_handler_type pold;
1273 pold = _bfd_assert_handler;
1274 _bfd_assert_handler = pnew;
1280 Miscellaneous, Memory Usage, Error reporting, BFD front end
1286 Miscellaneous functions
1291 bfd_get_reloc_upper_bound
1294 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1297 Return the number of bytes required to store the
1298 relocation information associated with section @var{sect}
1299 attached to bfd @var{abfd}. If an error occurs, return -1.
1304 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
1306 if (abfd->format != bfd_object)
1308 bfd_set_error (bfd_error_invalid_operation);
1312 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
1317 bfd_canonicalize_reloc
1320 long bfd_canonicalize_reloc
1321 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1324 Call the back end associated with the open BFD
1325 @var{abfd} and translate the external form of the relocation
1326 information attached to @var{sec} into the internal canonical
1327 form. Place the table into memory at @var{loc}, which has
1328 been preallocated, usually by a call to
1329 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
1332 The @var{syms} table is also needed for horrible internal magic
1337 bfd_canonicalize_reloc (bfd *abfd,
1342 if (abfd->format != bfd_object)
1344 bfd_set_error (bfd_error_invalid_operation);
1348 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1349 (abfd, asect, location, symbols));
1358 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1361 Set the relocation pointer and count within
1362 section @var{sec} to the values @var{rel} and @var{count}.
1363 The argument @var{abfd} is ignored.
1365 .#define bfd_set_reloc(abfd, asect, location, count) \
1366 . BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1374 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
1377 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1379 Possible errors are:
1380 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1381 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1382 o <<bfd_error_invalid_operation>> -
1383 The flag word contained a bit which was not applicable to the
1384 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1385 on a BFD format which does not support demand paging.
1390 bfd_set_file_flags (bfd *abfd, flagword flags)
1392 if (abfd->format != bfd_object)
1394 bfd_set_error (bfd_error_wrong_format);
1398 if (bfd_read_p (abfd))
1400 bfd_set_error (bfd_error_invalid_operation);
1404 bfd_get_file_flags (abfd) = flags;
1405 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1407 bfd_set_error (bfd_error_invalid_operation);
1415 bfd_assert (const char *file, int line)
1417 /* xgettext:c-format */
1418 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1419 BFD_VERSION_STRING, file, line);
1422 /* A more or less friendly abort message. In libbfd.h abort is
1423 defined to call this function. */
1426 _bfd_abort (const char *file, int line, const char *fn)
1430 /* xgettext:c-format */
1431 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1432 BFD_VERSION_STRING, file, line, fn);
1435 /* xgettext:c-format */
1436 (_("BFD %s internal error, aborting at %s:%d\n"),
1437 BFD_VERSION_STRING, file, line);
1438 _bfd_error_handler (_("Please report this bug.\n"));
1439 _exit (EXIT_FAILURE);
1447 int bfd_get_arch_size (bfd *abfd);
1450 Returns the normalized architecture address size, in bits, as
1451 determined by the object file's format. By normalized, we mean
1452 either 32 or 64. For ELF, this information is included in the
1453 header. Use bfd_arch_bits_per_address for number of bits in
1454 the architecture address.
1457 Returns the arch size in bits if known, <<-1>> otherwise.
1461 bfd_get_arch_size (bfd *abfd)
1463 if (abfd->xvec->flavour == bfd_target_elf_flavour)
1464 return get_elf_backend_data (abfd)->s->arch_size;
1466 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1471 bfd_get_sign_extend_vma
1474 int bfd_get_sign_extend_vma (bfd *abfd);
1477 Indicates if the target architecture "naturally" sign extends
1478 an address. Some architectures implicitly sign extend address
1479 values when they are converted to types larger than the size
1480 of an address. For instance, bfd_get_start_address() will
1481 return an address sign extended to fill a bfd_vma when this is
1485 Returns <<1>> if the target architecture is known to sign
1486 extend addresses, <<0>> if the target architecture is known to
1487 not sign extend addresses, and <<-1>> otherwise.
1491 bfd_get_sign_extend_vma (bfd *abfd)
1495 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1496 return get_elf_backend_data (abfd)->sign_extend_vma;
1498 name = bfd_get_target (abfd);
1500 /* Return a proper value for DJGPP & PE COFF.
1501 This function is required for DWARF2 support, but there is
1502 no place to store this information in the COFF back end.
1503 Should enough other COFF targets add support for DWARF2,
1504 a place will have to be found. Until then, this hack will do. */
1505 if (CONST_STRNEQ (name, "coff-go32")
1506 || strcmp (name, "pe-i386") == 0
1507 || strcmp (name, "pei-i386") == 0
1508 || strcmp (name, "pe-x86-64") == 0
1509 || strcmp (name, "pei-x86-64") == 0
1510 || strcmp (name, "pe-arm-wince-little") == 0
1511 || strcmp (name, "pei-arm-wince-little") == 0
1512 || strcmp (name, "aixcoff-rs6000") == 0
1513 || strcmp (name, "aix5coff64-rs6000") == 0)
1516 if (CONST_STRNEQ (name, "mach-o"))
1519 bfd_set_error (bfd_error_wrong_format);
1525 bfd_set_start_address
1528 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
1531 Make @var{vma} the entry point of output BFD @var{abfd}.
1534 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1538 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1540 abfd->start_address = vma;
1549 unsigned int bfd_get_gp_size (bfd *abfd);
1552 Return the maximum size of objects to be optimized using the GP
1553 register under MIPS ECOFF. This is typically set by the <<-G>>
1554 argument to the compiler, assembler or linker.
1558 bfd_get_gp_size (bfd *abfd)
1560 if (abfd->format == bfd_object)
1562 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1563 return ecoff_data (abfd)->gp_size;
1564 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1565 return elf_gp_size (abfd);
1575 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1578 Set the maximum size of objects to be optimized using the GP
1579 register under ECOFF or MIPS ELF. This is typically set by
1580 the <<-G>> argument to the compiler, assembler or linker.
1584 bfd_set_gp_size (bfd *abfd, unsigned int i)
1586 /* Don't try to set GP size on an archive or core file! */
1587 if (abfd->format != bfd_object)
1590 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1591 ecoff_data (abfd)->gp_size = i;
1592 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1593 elf_gp_size (abfd) = i;
1596 /* Get the GP value. This is an internal function used by some of the
1597 relocation special_function routines on targets which support a GP
1601 _bfd_get_gp_value (bfd *abfd)
1605 if (abfd->format != bfd_object)
1608 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1609 return ecoff_data (abfd)->gp;
1610 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1611 return elf_gp (abfd);
1616 /* Set the GP value. */
1619 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1623 if (abfd->format != bfd_object)
1626 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1627 ecoff_data (abfd)->gp = v;
1628 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1637 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1640 Convert, like <<strtoul>>, a numerical expression
1641 @var{string} into a <<bfd_vma>> integer, and return that integer.
1642 (Though without as many bells and whistles as <<strtoul>>.)
1643 The expression is assumed to be unsigned (i.e., positive).
1644 If given a @var{base}, it is used as the base for conversion.
1645 A base of 0 causes the function to interpret the string
1646 in hex if a leading "0x" or "0X" is found, otherwise
1647 in octal if a leading zero is found, otherwise in decimal.
1649 If the value would overflow, the maximum <<bfd_vma>> value is
1654 bfd_scan_vma (const char *string, const char **end, int base)
1658 unsigned int cutlim;
1661 /* Let the host do it if possible. */
1662 if (sizeof (bfd_vma) <= sizeof (unsigned long))
1663 return strtoul (string, (char **) end, base);
1665 #if defined (HAVE_STRTOULL) && defined (HAVE_LONG_LONG)
1666 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1667 return strtoull (string, (char **) end, base);
1672 if (string[0] == '0')
1674 if ((string[1] == 'x') || (string[1] == 'X'))
1681 if ((base < 2) || (base > 36))
1686 && (string[1] == 'x' || string[1] == 'X')
1687 && ISXDIGIT (string[2]))
1692 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1693 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1701 if (ISDIGIT (digit))
1702 digit = digit - '0';
1703 else if (ISALPHA (digit))
1704 digit = TOUPPER (digit) - 'A' + 10;
1707 if (digit >= (unsigned int) base)
1709 if (value > cutoff || (value == cutoff && digit > cutlim))
1711 value = value * base + digit;
1716 value = ~ (bfd_vma) 0;
1726 bfd_copy_private_header_data
1729 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1732 Copy private BFD header information from the BFD @var{ibfd} to the
1733 the BFD @var{obfd}. This copies information that may require
1734 sections to exist, but does not require symbol tables. Return
1735 <<true>> on success, <<false>> on error.
1736 Possible error returns are:
1738 o <<bfd_error_no_memory>> -
1739 Not enough memory exists to create private data for @var{obfd}.
1741 .#define bfd_copy_private_header_data(ibfd, obfd) \
1742 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
1749 bfd_copy_private_bfd_data
1752 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
1755 Copy private BFD information from the BFD @var{ibfd} to the
1756 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
1757 Possible error returns are:
1759 o <<bfd_error_no_memory>> -
1760 Not enough memory exists to create private data for @var{obfd}.
1762 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
1763 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1770 bfd_set_private_flags
1773 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
1776 Set private BFD flag information in the BFD @var{abfd}.
1777 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1780 o <<bfd_error_no_memory>> -
1781 Not enough memory exists to create private data for @var{obfd}.
1783 .#define bfd_set_private_flags(abfd, flags) \
1784 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
1793 The following functions exist but have not yet been documented.
1795 .#define bfd_sizeof_headers(abfd, info) \
1796 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
1798 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
1799 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1800 . (abfd, syms, sec, off, file, func, line, NULL))
1802 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1804 . BFD_SEND (abfd, _bfd_find_nearest_line, \
1805 . (abfd, syms, sec, off, file, func, line, disc))
1807 .#define bfd_find_line(abfd, syms, sym, file, line) \
1808 . BFD_SEND (abfd, _bfd_find_line, \
1809 . (abfd, syms, sym, file, line))
1811 .#define bfd_find_inliner_info(abfd, file, func, line) \
1812 . BFD_SEND (abfd, _bfd_find_inliner_info, \
1813 . (abfd, file, func, line))
1815 .#define bfd_debug_info_start(abfd) \
1816 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
1818 .#define bfd_debug_info_end(abfd) \
1819 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
1821 .#define bfd_debug_info_accumulate(abfd, section) \
1822 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
1824 .#define bfd_stat_arch_elt(abfd, stat) \
1825 . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
1827 .#define bfd_update_armap_timestamp(abfd) \
1828 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
1830 .#define bfd_set_arch_mach(abfd, arch, mach)\
1831 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
1833 .#define bfd_relax_section(abfd, section, link_info, again) \
1834 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1836 .#define bfd_gc_sections(abfd, link_info) \
1837 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
1839 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
1840 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
1842 .#define bfd_merge_sections(abfd, link_info) \
1843 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
1845 .#define bfd_is_group_section(abfd, sec) \
1846 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1848 .#define bfd_discard_group(abfd, sec) \
1849 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1851 .#define bfd_link_hash_table_create(abfd) \
1852 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1854 .#define bfd_link_add_symbols(abfd, info) \
1855 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1857 .#define bfd_link_just_syms(abfd, sec, info) \
1858 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1860 .#define bfd_final_link(abfd, info) \
1861 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1863 .#define bfd_free_cached_info(abfd) \
1864 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1866 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1867 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1869 .#define bfd_print_private_bfd_data(abfd, file)\
1870 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1872 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1873 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1875 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1876 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1877 . dyncount, dynsyms, ret))
1879 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1880 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1882 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1883 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1885 .extern bfd_byte *bfd_get_relocated_section_contents
1886 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1887 . bfd_boolean, asymbol **);
1893 bfd_get_relocated_section_contents (bfd *abfd,
1894 struct bfd_link_info *link_info,
1895 struct bfd_link_order *link_order,
1897 bfd_boolean relocatable,
1901 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1902 bfd_byte *, bfd_boolean, asymbol **);
1904 if (link_order->type == bfd_indirect_link_order)
1906 abfd2 = link_order->u.indirect.section->owner;
1913 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1915 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
1918 /* Record information about an ELF program header. */
1921 bfd_record_phdr (bfd *abfd,
1923 bfd_boolean flags_valid,
1925 bfd_boolean at_valid,
1927 bfd_boolean includes_filehdr,
1928 bfd_boolean includes_phdrs,
1932 struct elf_segment_map *m, **pm;
1935 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
1938 amt = sizeof (struct elf_segment_map);
1939 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
1940 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
1947 m->p_flags_valid = flags_valid;
1948 m->p_paddr_valid = at_valid;
1949 m->includes_filehdr = includes_filehdr;
1950 m->includes_phdrs = includes_phdrs;
1953 memcpy (m->sections, secs, count * sizeof (asection *));
1955 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
1963 /* Return true iff this target is 32-bit. */
1968 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1970 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1971 return bed->s->elfclass == ELFCLASS32;
1974 /* For non-ELF targets, use architecture information. */
1975 return bfd_arch_bits_per_address (abfd) <= 32;
1979 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1980 target's address size. */
1983 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
1988 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1992 sprintf_vma (buf, value);
1996 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
2001 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
2005 fprintf_vma ((FILE *) stream, value);
2013 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
2017 When more than one machine code number is available for the
2018 same machine type, this function can be used to switch between
2019 the preferred one (alternative == 0) and any others. Currently,
2020 only ELF supports this feature, with up to two alternate
2025 bfd_alt_mach_code (bfd *abfd, int alternative)
2027 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2031 switch (alternative)
2034 code = get_elf_backend_data (abfd)->elf_machine_code;
2038 code = get_elf_backend_data (abfd)->elf_machine_alt1;
2044 code = get_elf_backend_data (abfd)->elf_machine_alt2;
2053 elf_elfheader (abfd)->e_machine = code;
2063 bfd_emul_get_maxpagesize
2066 bfd_vma bfd_emul_get_maxpagesize (const char *);
2069 Returns the maximum page size, in bytes, as determined by
2073 Returns the maximum page size in bytes for ELF, 0 otherwise.
2077 bfd_emul_get_maxpagesize (const char *emul)
2079 const bfd_target *target;
2081 target = bfd_find_target (emul, NULL);
2083 && target->flavour == bfd_target_elf_flavour)
2084 return xvec_get_elf_backend_data (target)->maxpagesize;
2090 bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
2091 int offset, const bfd_target *orig_target)
2093 if (target->flavour == bfd_target_elf_flavour)
2095 const struct elf_backend_data *bed;
2097 bed = xvec_get_elf_backend_data (target);
2098 *((bfd_vma *) ((char *) bed + offset)) = size;
2101 if (target->alternative_target
2102 && target->alternative_target != orig_target)
2103 bfd_elf_set_pagesize (target->alternative_target, size, offset,
2109 bfd_emul_set_maxpagesize
2112 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
2115 For ELF, set the maximum page size for the emulation. It is
2116 a no-op for other formats.
2121 bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
2123 const bfd_target *target;
2125 target = bfd_find_target (emul, NULL);
2127 bfd_elf_set_pagesize (target, size,
2128 offsetof (struct elf_backend_data,
2129 maxpagesize), target);
2134 bfd_emul_get_commonpagesize
2137 bfd_vma bfd_emul_get_commonpagesize (const char *, bfd_boolean);
2140 Returns the common page size, in bytes, as determined by
2144 Returns the common page size in bytes for ELF, 0 otherwise.
2148 bfd_emul_get_commonpagesize (const char *emul, bfd_boolean relro)
2150 const bfd_target *target;
2152 target = bfd_find_target (emul, NULL);
2154 && target->flavour == bfd_target_elf_flavour)
2156 const struct elf_backend_data *bed;
2158 bed = xvec_get_elf_backend_data (target);
2160 return bed->relropagesize;
2162 return bed->commonpagesize;
2169 bfd_emul_set_commonpagesize
2172 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
2175 For ELF, set the common page size for the emulation. It is
2176 a no-op for other formats.
2181 bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
2183 const bfd_target *target;
2185 target = bfd_find_target (emul, NULL);
2187 bfd_elf_set_pagesize (target, size,
2188 offsetof (struct elf_backend_data,
2189 commonpagesize), target);
2197 char *bfd_demangle (bfd *, const char *, int);
2200 Wrapper around cplus_demangle. Strips leading underscores and
2201 other such chars that would otherwise confuse the demangler.
2202 If passed a g++ v3 ABI mangled name, returns a buffer allocated
2203 with malloc holding the demangled name. Returns NULL otherwise
2204 and on memory alloc failure.
2208 bfd_demangle (bfd *abfd, const char *name, int options)
2211 const char *pre, *suf;
2213 bfd_boolean skip_lead;
2215 skip_lead = (abfd != NULL
2217 && bfd_get_symbol_leading_char (abfd) == *name);
2221 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
2222 or the MS PE format. These formats have a number of leading '.'s
2223 on at least some symbols, so we remove all dots to avoid
2224 confusing the demangler. */
2226 while (*name == '.' || *name == '$')
2228 pre_len = name - pre;
2230 /* Strip off @plt and suchlike too. */
2232 suf = strchr (name, '@');
2235 alloc = (char *) bfd_malloc (suf - name + 1);
2238 memcpy (alloc, name, suf - name);
2239 alloc[suf - name] = '\0';
2243 res = cplus_demangle (name, options);
2252 size_t len = strlen (pre) + 1;
2253 alloc = (char *) bfd_malloc (len);
2256 memcpy (alloc, pre, len);
2262 /* Put back any prefix or suffix. */
2263 if (pre_len != 0 || suf != NULL)
2272 suf_len = strlen (suf) + 1;
2273 final = (char *) bfd_malloc (pre_len + len + suf_len);
2276 memcpy (final, pre, pre_len);
2277 memcpy (final + pre_len, res, len);
2278 memcpy (final + pre_len + len, suf, suf_len);
2289 bfd_update_compression_header
2292 void bfd_update_compression_header
2293 (bfd *abfd, bfd_byte *contents, asection *sec);
2296 Set the compression header at CONTENTS of SEC in ABFD and update
2297 elf_section_flags for compression.
2301 bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
2304 if ((abfd->flags & BFD_COMPRESS) != 0)
2306 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2308 if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
2310 const struct elf_backend_data *bed
2311 = get_elf_backend_data (abfd);
2313 /* Set the SHF_COMPRESSED bit. */
2314 elf_section_flags (sec) |= SHF_COMPRESSED;
2316 if (bed->s->elfclass == ELFCLASS32)
2318 Elf32_External_Chdr *echdr
2319 = (Elf32_External_Chdr *) contents;
2320 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2321 bfd_put_32 (abfd, sec->size, &echdr->ch_size);
2322 bfd_put_32 (abfd, 1 << sec->alignment_power,
2323 &echdr->ch_addralign);
2327 Elf64_External_Chdr *echdr
2328 = (Elf64_External_Chdr *) contents;
2329 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2330 bfd_put_32 (abfd, 0, &echdr->ch_reserved);
2331 bfd_put_64 (abfd, sec->size, &echdr->ch_size);
2332 bfd_put_64 (abfd, 1 << sec->alignment_power,
2333 &echdr->ch_addralign);
2338 /* Clear the SHF_COMPRESSED bit. */
2339 elf_section_flags (sec) &= ~SHF_COMPRESSED;
2341 /* Write the zlib header. It should be "ZLIB" followed by
2342 the uncompressed section size, 8 bytes in big-endian
2344 memcpy (contents, "ZLIB", 4);
2345 bfd_putb64 (sec->size, contents + 4);
2355 bfd_check_compression_header
2358 bfd_boolean bfd_check_compression_header
2359 (bfd *abfd, bfd_byte *contents, asection *sec,
2360 bfd_size_type *uncompressed_size);
2363 Check the compression header at CONTENTS of SEC in ABFD and
2364 store the uncompressed size in UNCOMPRESSED_SIZE if the
2365 compression header is valid.
2368 Return TRUE if the compression header is valid.
2372 bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2374 bfd_size_type *uncompressed_size)
2376 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2377 && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2379 Elf_Internal_Chdr chdr;
2380 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2381 if (bed->s->elfclass == ELFCLASS32)
2383 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2384 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2385 chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2386 chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2390 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2391 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2392 chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2393 chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2395 if (chdr.ch_type == ELFCOMPRESS_ZLIB
2396 && chdr.ch_addralign == 1U << sec->alignment_power)
2398 *uncompressed_size = chdr.ch_size;
2408 bfd_get_compression_header_size
2411 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2414 Return the size of the compression header of SEC in ABFD.
2417 Return the size of the compression header in bytes.
2421 bfd_get_compression_header_size (bfd *abfd, asection *sec)
2423 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2427 if (!(abfd->flags & BFD_COMPRESS_GABI))
2430 else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2433 if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2434 return sizeof (Elf32_External_Chdr);
2436 return sizeof (Elf64_External_Chdr);
2444 bfd_convert_section_size
2447 bfd_size_type bfd_convert_section_size
2448 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2451 Convert the size @var{size} of the section @var{isec} in input
2452 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2456 bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2459 bfd_size_type hdr_size;
2461 /* Do nothing if input file will be decompressed. */
2462 if ((ibfd->flags & BFD_DECOMPRESS))
2465 /* Do nothing if either input or output aren't ELF. */
2466 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2467 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2470 /* Do nothing if ELF classes of input and output are the same. */
2471 if (get_elf_backend_data (ibfd)->s->elfclass
2472 == get_elf_backend_data (obfd)->s->elfclass)
2475 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2476 hdr_size = bfd_get_compression_header_size (ibfd, isec);
2480 /* Adjust the size of the output SHF_COMPRESSED section. */
2481 if (hdr_size == sizeof (Elf32_External_Chdr))
2482 return (size - sizeof (Elf32_External_Chdr)
2483 + sizeof (Elf64_External_Chdr));
2485 return (size - sizeof (Elf64_External_Chdr)
2486 + sizeof (Elf32_External_Chdr));
2491 bfd_convert_section_contents
2494 bfd_boolean bfd_convert_section_contents
2495 (bfd *ibfd, asection *isec, bfd *obfd,
2496 bfd_byte **ptr, bfd_size_type *ptr_size);
2499 Convert the contents, stored in @var{*ptr}, of the section
2500 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2501 if needed. The original buffer pointed to by @var{*ptr} may
2502 be freed and @var{*ptr} is returned with memory malloc'd by this
2503 function, and the new size written to @var{ptr_size}.
2507 bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
2508 bfd_byte **ptr, bfd_size_type *ptr_size)
2511 bfd_size_type ihdr_size, ohdr_size, size;
2512 Elf_Internal_Chdr chdr;
2513 bfd_boolean use_memmove;
2515 /* Do nothing if input file will be decompressed. */
2516 if ((ibfd->flags & BFD_DECOMPRESS))
2519 /* Do nothing if either input or output aren't ELF. */
2520 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2521 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2524 /* Do nothing if ELF classes of input and output are the same. */
2525 if (get_elf_backend_data (ibfd)->s->elfclass
2526 == get_elf_backend_data (obfd)->s->elfclass)
2529 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2530 ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2536 /* Convert the contents of the input SHF_COMPRESSED section to
2537 output. Get the input compression header and the size of the
2538 output compression header. */
2539 if (ihdr_size == sizeof (Elf32_External_Chdr))
2541 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2542 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2543 chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2544 chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2546 ohdr_size = sizeof (Elf64_External_Chdr);
2548 use_memmove = FALSE;
2552 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2553 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2554 chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2555 chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2557 ohdr_size = sizeof (Elf32_External_Chdr);
2561 size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2564 contents = (bfd_byte *) bfd_malloc (size);
2565 if (contents == NULL)
2569 /* Write out the output compression header. */
2570 if (ohdr_size == sizeof (Elf32_External_Chdr))
2572 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2573 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2574 bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2575 bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2579 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
2580 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2581 bfd_put_32 (obfd, 0, &echdr->ch_reserved);
2582 bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2583 bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2586 /* Copy the compressed contents. */
2588 memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2591 memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);