1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2022 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 . {* Track current file position (or current buffer offset for
78 . in-memory BFDs). When a file is closed by the caching routines,
79 . BFD retains state information on the file here. *}
82 . {* File modified time, if mtime_set is TRUE. *}
85 . {* A unique identifier of the BFD *}
88 . {* Format_specific flags. *}
91 . {* Values that may appear in the flags field of a BFD. These also
92 . appear in the object_flags field of the bfd_target structure, where
93 . they indicate the set of flags used by that backend (not all flags
94 . are meaningful for all object file formats) (FIXME: at the moment,
95 . the object_flags values have mostly just been copied from backend
96 . to another, and are not necessarily correct). *}
98 .#define BFD_NO_FLAGS 0x0
100 . {* BFD contains relocation entries. *}
101 .#define HAS_RELOC 0x1
103 . {* BFD is directly executable. *}
106 . {* BFD has line number information (basically used for F_LNNO in a
108 .#define HAS_LINENO 0x4
110 . {* BFD has debugging information. *}
111 .#define HAS_DEBUG 0x08
113 . {* BFD has symbols. *}
114 .#define HAS_SYMS 0x10
116 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
118 .#define HAS_LOCALS 0x20
120 . {* BFD is a dynamic object. *}
121 .#define DYNAMIC 0x40
123 . {* Text section is write protected (if D_PAGED is not set, this is
124 . like an a.out NMAGIC file) (the linker sets this by default, but
125 . clears it for -r or -N). *}
126 .#define WP_TEXT 0x80
128 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
129 . linker sets this by default, but clears it for -r or -n or -N). *}
130 .#define D_PAGED 0x100
132 . {* BFD is relaxable (this means that bfd_relax_section may be able to
133 . do something) (sometimes bfd_relax_section can do something even if
134 . this is not set). *}
135 .#define BFD_IS_RELAXABLE 0x200
137 . {* This may be set before writing out a BFD to request using a
138 . traditional format. For example, this is used to request that when
139 . writing out an a.out object the symbols not be hashed to eliminate
141 .#define BFD_TRADITIONAL_FORMAT 0x400
143 . {* This flag indicates that the BFD contents are actually cached
144 . in memory. If this is set, iostream points to a bfd_in_memory
146 .#define BFD_IN_MEMORY 0x800
148 . {* This BFD has been created by the linker and doesn't correspond
149 . to any input file. *}
150 .#define BFD_LINKER_CREATED 0x1000
152 . {* This may be set before writing out a BFD to request that it
153 . be written using values for UIDs, GIDs, timestamps, etc. that
154 . will be consistent from run to run. *}
155 .#define BFD_DETERMINISTIC_OUTPUT 0x2000
157 . {* Compress sections in this BFD. *}
158 .#define BFD_COMPRESS 0x4000
160 . {* Decompress sections in this BFD. *}
161 .#define BFD_DECOMPRESS 0x8000
163 . {* BFD is a dummy, for plugins. *}
164 .#define BFD_PLUGIN 0x10000
166 . {* Compress sections in this BFD with SHF_COMPRESSED from gABI. *}
167 .#define BFD_COMPRESS_GABI 0x20000
169 . {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
171 .#define BFD_CONVERT_ELF_COMMON 0x40000
173 . {* Use the ELF STT_COMMON type in this BFD. *}
174 .#define BFD_USE_ELF_STT_COMMON 0x80000
176 . {* Put pathnames into archives (non-POSIX). *}
177 .#define BFD_ARCHIVE_FULL_PATH 0x100000
179 .#define BFD_CLOSED_BY_CACHE 0x200000
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 . {* The format which belongs to the BFD. (object, core, etc.) *}
194 . ENUM_BITFIELD (bfd_format) format : 3;
196 . {* The direction with which the BFD was opened. *}
197 . ENUM_BITFIELD (bfd_direction) direction : 2;
199 . {* Is the file descriptor being cached? That is, can it be closed as
200 . needed, and re-opened when accessed later? *}
201 . unsigned int cacheable : 1;
203 . {* Marks whether there was a default target specified when the
204 . BFD was opened. This is used to select which matching algorithm
205 . to use to choose the back end. *}
206 . unsigned int target_defaulted : 1;
208 . {* ... and here: (``once'' means at least once). *}
209 . unsigned int opened_once : 1;
211 . {* Set if we have a locally maintained mtime value, rather than
212 . getting it from the file each time. *}
213 . unsigned int mtime_set : 1;
215 . {* Flag set if symbols from this BFD should not be exported. *}
216 . unsigned int no_export : 1;
218 . {* Remember when output has begun, to stop strange things
220 . unsigned int output_has_begun : 1;
222 . {* Have archive map. *}
223 . unsigned int has_armap : 1;
225 . {* Set if this is a thin archive. *}
226 . unsigned int is_thin_archive : 1;
228 . {* Set if this archive should not cache element positions. *}
229 . unsigned int no_element_cache : 1;
231 . {* Set if only required symbols should be added in the link hash table for
232 . this object. Used by VMS linkers. *}
233 . unsigned int selective_search : 1;
235 . {* Set if this is the linker output BFD. *}
236 . unsigned int is_linker_output : 1;
238 . {* Set if this is the linker input BFD. *}
239 . unsigned int is_linker_input : 1;
241 . {* If this is an input for a compiler plug-in library. *}
242 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
244 . {* Set if this is a plugin output file. *}
245 . unsigned int lto_output : 1;
247 . {* Set if this is a slim LTO object not loaded with a compiler plugin. *}
248 . unsigned int lto_slim_object : 1;
250 . {* Do not attempt to modify this file. Set when detecting errors
251 . that BFD is not prepared to handle for objcopy/strip. *}
252 . unsigned int read_only : 1;
254 . {* Set to dummy BFD created when claimed by a compiler plug-in
256 . bfd *plugin_dummy_bfd;
258 . {* The offset of this bfd in the file, typically 0 if it is not
259 . contained in an archive. *}
262 . {* The origin in the archive of the proxy entry. This will
263 . normally be the same as origin, except for thin archives,
264 . when it will contain the current offset of the proxy in the
265 . thin archive rather than the offset of the bfd in its actual
267 . ufile_ptr proxy_origin;
269 . {* A hash table for section names. *}
270 . struct bfd_hash_table section_htab;
272 . {* Pointer to linked list of sections. *}
273 . struct bfd_section *sections;
275 . {* The last section on the section list. *}
276 . struct bfd_section *section_last;
278 . {* The number of sections. *}
279 . unsigned int section_count;
281 . {* The archive plugin file descriptor. *}
282 . int archive_plugin_fd;
284 . {* The number of opens on the archive plugin file descriptor. *}
285 . unsigned int archive_plugin_fd_open_count;
287 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
288 . be used only for archive elements. *}
291 . {* The total size of memory from bfd_alloc. *}
292 . bfd_size_type alloc_size;
294 . {* Stuff only useful for object files:
295 . The start address. *}
296 . bfd_vma start_address;
298 . {* Symbol table for output BFD (with symcount entries).
299 . Also used by the linker to cache input BFD symbols. *}
300 . struct bfd_symbol **outsymbols;
302 . {* Used for input and output. *}
303 . unsigned int symcount;
305 . {* Used for slurped dynamic symbol tables. *}
306 . unsigned int dynsymcount;
308 . {* Pointer to structure which contains architecture information. *}
309 . const struct bfd_arch_info *arch_info;
311 . {* Cached length of file for bfd_get_size. 0 until bfd_get_size is
312 . called, 1 if stat returns an error or the file size is too large to
313 . return in ufile_ptr. Both 0 and 1 should be treated as "unknown". *}
316 . {* Stuff only useful for archives. *}
318 . struct bfd *my_archive; {* The containing archive BFD. *}
319 . struct bfd *archive_next; {* The next BFD in the archive. *}
320 . struct bfd *archive_head; {* The first BFD in the archive. *}
321 . struct bfd *nested_archives; {* List of nested archive in a flattened
325 . {* For input BFDs, a chain of BFDs involved in a link. *}
327 . {* For output BFD, the linker hash table. *}
328 . struct bfd_link_hash_table *hash;
331 . {* Used by the back end to hold private data. *}
334 . struct aout_data_struct *aout_data;
335 . struct artdata *aout_ar_data;
336 . struct coff_tdata *coff_obj_data;
337 . struct pe_tdata *pe_obj_data;
338 . struct xcoff_tdata *xcoff_obj_data;
339 . struct ecoff_tdata *ecoff_obj_data;
340 . struct srec_data_struct *srec_data;
341 . struct verilog_data_struct *verilog_data;
342 . struct ihex_data_struct *ihex_data;
343 . struct tekhex_data_struct *tekhex_data;
344 . struct elf_obj_tdata *elf_obj_data;
345 . struct mmo_data_struct *mmo_data;
346 . struct sun_core_struct *sun_core_data;
347 . struct sco5_core_struct *sco5_core_data;
348 . struct trad_core_struct *trad_core_data;
349 . struct som_data_struct *som_data;
350 . struct hpux_core_struct *hpux_core_data;
351 . struct hppabsd_core_struct *hppabsd_core_data;
352 . struct sgi_core_struct *sgi_core_data;
353 . struct lynx_core_struct *lynx_core_data;
354 . struct osf_core_struct *osf_core_data;
355 . struct cisco_core_struct *cisco_core_data;
356 . struct versados_data_struct *versados_data;
357 . struct netbsd_core_struct *netbsd_core_data;
358 . struct mach_o_data_struct *mach_o_data;
359 . struct mach_o_fat_data_struct *mach_o_fat_data;
360 . struct plugin_data_struct *plugin_data;
361 . struct bfd_pef_data_struct *pef_data;
362 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
363 . struct bfd_sym_data_struct *sym_data;
368 . {* Used by the application to hold private data. *}
371 . {* Where all the allocated stuff under this BFD goes. This is a
372 . struct objalloc *, but we use void * to avoid requiring the inclusion
376 . {* For input BFDs, the build ID, if the object has one. *}
377 . const struct bfd_build_id *build_id;
380 .static inline const char *
381 .bfd_get_filename (const bfd *abfd)
383 . return abfd->filename;
387 .bfd_get_cacheable (const bfd *abfd)
389 . return abfd->cacheable;
392 .static inline enum bfd_format
393 .bfd_get_format (const bfd *abfd)
395 . return abfd->format;
398 .static inline flagword
399 .bfd_get_file_flags (const bfd *abfd)
401 . return abfd->flags;
404 .static inline bfd_vma
405 .bfd_get_start_address (const bfd *abfd)
407 . return abfd->start_address;
410 .static inline unsigned int
411 .bfd_get_symcount (const bfd *abfd)
413 . return abfd->symcount;
416 .static inline unsigned int
417 .bfd_get_dynamic_symcount (const bfd *abfd)
419 . return abfd->dynsymcount;
422 .static inline struct bfd_symbol **
423 .bfd_get_outsymbols (const bfd *abfd)
425 . return abfd->outsymbols;
428 .static inline unsigned int
429 .bfd_count_sections (const bfd *abfd)
431 . return abfd->section_count;
435 .bfd_has_map (const bfd *abfd)
437 . return abfd->has_armap;
441 .bfd_is_thin_archive (const bfd *abfd)
443 . return abfd->is_thin_archive;
446 .static inline void *
447 .bfd_usrdata (const bfd *abfd)
449 . return abfd->usrdata;
452 .{* See note beside bfd_set_section_userdata. *}
454 .bfd_set_cacheable (bfd * abfd, bool val)
456 . abfd->cacheable = val;
461 .bfd_set_thin_archive (bfd *abfd, bool val)
463 . abfd->is_thin_archive = val;
467 .bfd_set_usrdata (bfd *abfd, void *val)
469 . abfd->usrdata = val;
472 .static inline asection *
473 .bfd_asymbol_section (const asymbol *sy)
475 . return sy->section;
478 .static inline bfd_vma
479 .bfd_asymbol_value (const asymbol *sy)
481 . return sy->section->vma + sy->value;
484 .static inline const char *
485 .bfd_asymbol_name (const asymbol *sy)
490 .static inline struct bfd *
491 .bfd_asymbol_bfd (const asymbol *sy)
493 . return sy->the_bfd;
497 .bfd_set_asymbol_name (asymbol *sy, const char *name)
502 .static inline bfd_size_type
503 .bfd_get_section_limit_octets (const bfd *abfd, const asection *sec)
505 . if (abfd->direction != write_direction && sec->rawsize != 0)
506 . return sec->rawsize;
510 .{* Find the address one past the end of SEC. *}
511 .static inline bfd_size_type
512 .bfd_get_section_limit (const bfd *abfd, const asection *sec)
514 . return (bfd_get_section_limit_octets (abfd, sec)
515 . / bfd_octets_per_byte (abfd, sec));
518 .{* Functions to handle insertion and deletion of a bfd's sections. These
519 . only handle the list pointers, ie. do not adjust section_count,
520 . target_index etc. *}
522 .bfd_section_list_remove (bfd *abfd, asection *s)
524 . asection *next = s->next;
525 . asection *prev = s->prev;
529 . abfd->sections = next;
533 . abfd->section_last = prev;
537 .bfd_section_list_append (bfd *abfd, asection *s)
540 . if (abfd->section_last)
542 . s->prev = abfd->section_last;
543 . abfd->section_last->next = s;
548 . abfd->sections = s;
550 . abfd->section_last = s;
554 .bfd_section_list_prepend (bfd *abfd, asection *s)
557 . if (abfd->sections)
559 . s->next = abfd->sections;
560 . abfd->sections->prev = s;
565 . abfd->section_last = s;
567 . abfd->sections = s;
571 .bfd_section_list_insert_after (bfd *abfd, asection *a, asection *s)
573 . asection *next = a->next;
580 . abfd->section_last = s;
584 .bfd_section_list_insert_before (bfd *abfd, asection *b, asection *s)
586 . asection *prev = b->prev;
593 . abfd->sections = s;
597 .bfd_section_removed_from_list (const bfd *abfd, const asection *s)
599 . return s->next ? s->next->prev != s : abfd->section_last != s;
608 #include "libiberty.h"
609 #include "demangle.h"
610 #include "safe-ctype.h"
613 #include "coff/internal.h"
614 #include "coff/sym.h"
616 #include "libecoff.h"
621 #define EXIT_FAILURE 1
625 /* provide storage for subsystem, stack and heap data which may have been
626 passed in on the command line. Ld puts this data into a bfd_link_info
627 struct which ultimately gets passed in to the bfd. When it arrives, copy
628 it to the following struct so that the data will be available in coffcode.h
629 where it is needed. The typedef's used are defined in bfd.h */
633 Error reporting, Miscellaneous, typedef bfd, BFD front end
638 Most BFD functions return nonzero on success (check their
639 individual documentation for precise semantics). On an error,
640 they call <<bfd_set_error>> to set an error condition that callers
641 can check by calling <<bfd_get_error>>.
642 If that returns <<bfd_error_system_call>>, then check
645 The easiest way to report a BFD error to the user is to
649 Type <<bfd_error_type>>
651 The values returned by <<bfd_get_error>> are defined by the
652 enumerated type <<bfd_error_type>>.
656 .typedef enum bfd_error
658 . bfd_error_no_error = 0,
659 . bfd_error_system_call,
660 . bfd_error_invalid_target,
661 . bfd_error_wrong_format,
662 . bfd_error_wrong_object_format,
663 . bfd_error_invalid_operation,
664 . bfd_error_no_memory,
665 . bfd_error_no_symbols,
666 . bfd_error_no_armap,
667 . bfd_error_no_more_archived_files,
668 . bfd_error_malformed_archive,
669 . bfd_error_missing_dso,
670 . bfd_error_file_not_recognized,
671 . bfd_error_file_ambiguously_recognized,
672 . bfd_error_no_contents,
673 . bfd_error_nonrepresentable_section,
674 . bfd_error_no_debug_section,
675 . bfd_error_bad_value,
676 . bfd_error_file_truncated,
677 . bfd_error_file_too_big,
679 . bfd_error_on_input,
680 . bfd_error_invalid_error_code
686 static bfd_error_type bfd_error
= bfd_error_no_error
;
687 static bfd
*input_bfd
= NULL
;
688 static bfd_error_type input_error
= bfd_error_no_error
;
690 const char *const bfd_errmsgs
[] =
693 N_("system call error"),
694 N_("invalid bfd target"),
695 N_("file in wrong format"),
696 N_("archive object file in wrong format"),
697 N_("invalid operation"),
698 N_("memory exhausted"),
700 N_("archive has no index; run ranlib to add one"),
701 N_("no more archived files"),
702 N_("malformed archive"),
703 N_("DSO missing from command line"),
704 N_("file format not recognized"),
705 N_("file format is ambiguous"),
706 N_("section has no contents"),
707 N_("nonrepresentable section on output"),
708 N_("symbol needs debug section which does not exist"),
710 N_("file truncated"),
712 N_("sorry, cannot handle this file"),
713 N_("error reading %s: %s"),
714 N_("#<invalid error code>")
722 bfd_error_type bfd_get_error (void);
725 Return the current BFD error condition.
739 void bfd_set_error (bfd_error_type error_tag);
742 Set the BFD error condition to be @var{error_tag}.
744 @var{error_tag} must not be bfd_error_on_input. Use
745 bfd_set_input_error for input errors instead.
749 bfd_set_error (bfd_error_type error_tag
)
751 bfd_error
= error_tag
;
752 if (bfd_error
>= bfd_error_on_input
)
761 void bfd_set_input_error (bfd *input, bfd_error_type error_tag);
765 Set the BFD error condition to be bfd_error_on_input.
766 @var{input} is the input bfd where the error occurred, and
767 @var{error_tag} the bfd_error_type error.
771 bfd_set_input_error (bfd
*input
, bfd_error_type error_tag
)
773 /* This is an error that occurred during bfd_close when writing an
774 archive, but on one of the input files. */
775 bfd_error
= bfd_error_on_input
;
777 input_error
= error_tag
;
778 if (input_error
>= bfd_error_on_input
)
787 const char *bfd_errmsg (bfd_error_type error_tag);
790 Return a string describing the error @var{error_tag}, or
791 the system error if @var{error_tag} is <<bfd_error_system_call>>.
795 bfd_errmsg (bfd_error_type error_tag
)
800 if (error_tag
== bfd_error_on_input
)
803 const char *msg
= bfd_errmsg (input_error
);
805 if (asprintf (&buf
, _(bfd_errmsgs
[error_tag
]),
806 bfd_get_filename (input_bfd
), msg
) != -1)
809 /* Ick, what to do on out of memory? */
813 if (error_tag
== bfd_error_system_call
)
814 return xstrerror (errno
);
816 if (error_tag
> bfd_error_invalid_error_code
)
817 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
819 return _(bfd_errmsgs
[error_tag
]);
827 void bfd_perror (const char *message);
830 Print to the standard error stream a string describing the
831 last BFD error that occurred, or the last system error if
832 the last BFD error was a system call failure. If @var{message}
833 is non-NULL and non-empty, the error string printed is preceded
834 by @var{message}, a colon, and a space. It is followed by a newline.
838 bfd_perror (const char *message
)
841 if (message
== NULL
|| *message
== '\0')
842 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
844 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
852 Some BFD functions want to print messages describing the
853 problem. They call a BFD error handler function. This
854 function may be overridden by the program.
856 The BFD error handler acts like vprintf.
860 .typedef void (*bfd_error_handler_type) (const char *, va_list);
864 /* The program name used when printing BFD error messages. */
866 static const char *_bfd_error_program_name
;
868 /* Support for positional parameters. */
870 union _bfd_doprnt_args
890 /* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a
891 little and extended to handle '%pA', '%pB' and positional parameters. */
893 #define PRINT_TYPE(TYPE, FIELD) \
896 TYPE value = (TYPE) args[arg_no].FIELD; \
897 result = fprintf (stream, specifier, value); \
901 _bfd_doprnt (FILE *stream
, const char *format
, union _bfd_doprnt_args
*args
)
903 const char *ptr
= format
;
905 int total_printed
= 0;
906 unsigned int arg_count
= 0;
914 /* While we have regular characters, print them. */
915 char *end
= strchr (ptr
, '%');
917 result
= fprintf (stream
, "%.*s", (int) (end
- ptr
), ptr
);
919 result
= fprintf (stream
, "%s", ptr
);
922 else if (ptr
[1] == '%')
930 /* We have a format specifier! */
931 char *sptr
= specifier
;
932 int wide_width
= 0, short_width
= 0;
935 /* Copy the % and move forward. */
938 /* Check for a positional parameter. */
940 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
946 /* Move past flags. */
947 while (strchr ("-+ #0'I", *ptr
))
953 unsigned int arg_index
;
956 arg_index
= arg_count
;
957 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
959 arg_index
= *ptr
- '1';
962 value
= abs (args
[arg_index
].i
);
964 sptr
+= sprintf (sptr
, "%d", value
);
967 /* Handle explicit numeric value. */
968 while (ISDIGIT (*ptr
))
974 /* Copy and go past the period. */
979 unsigned int arg_index
;
982 arg_index
= arg_count
;
983 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
985 arg_index
= *ptr
- '1';
988 value
= abs (args
[arg_index
].i
);
990 sptr
+= sprintf (sptr
, "%d", value
);
993 /* Handle explicit numeric value. */
994 while (ISDIGIT (*ptr
))
997 while (strchr ("hlL", *ptr
))
1016 /* Copy the type specifier, and NULL terminate. */
1019 if ((int) arg_no
< 0)
1032 /* Short values are promoted to int, so just copy it
1033 as an int and trust the C library printf to cast it
1034 to the right width. */
1036 PRINT_TYPE (int, i
);
1042 PRINT_TYPE (int, i
);
1045 PRINT_TYPE (long, l
);
1049 #if defined (__MSVCRT__)
1056 PRINT_TYPE (long long, ll
);
1068 if (wide_width
== 0)
1069 PRINT_TYPE (double, d
);
1071 PRINT_TYPE (long double, ld
);
1075 PRINT_TYPE (char *, p
);
1082 const char *group
= NULL
;
1083 struct coff_comdat_info
*ci
;
1086 sec
= (asection
*) args
[arg_no
].p
;
1088 /* Invoking %pA with a null section pointer is an
1093 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
1094 && elf_next_in_group (sec
) != NULL
1095 && (sec
->flags
& SEC_GROUP
) == 0)
1096 group
= elf_group_name (sec
);
1097 else if (abfd
!= NULL
1098 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
1099 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
1103 result
= fprintf (stream
, "%s[%s]", sec
->name
, group
);
1105 result
= fprintf (stream
, "%s", sec
->name
);
1107 else if (*ptr
== 'B')
1112 abfd
= (bfd
*) args
[arg_no
].p
;
1114 /* Invoking %pB with a null bfd pointer is an
1117 else if (abfd
->my_archive
1118 && !bfd_is_thin_archive (abfd
->my_archive
))
1119 result
= fprintf (stream
, "%s(%s)",
1120 bfd_get_filename (abfd
->my_archive
),
1121 bfd_get_filename (abfd
));
1123 result
= fprintf (stream
, "%s", bfd_get_filename (abfd
));
1126 PRINT_TYPE (void *, p
);
1135 total_printed
+= result
;
1138 return total_printed
;
1141 /* First pass over FORMAT to gather ARGS. Returns number of args. */
1144 _bfd_doprnt_scan (const char *format
, union _bfd_doprnt_args
*args
)
1146 const char *ptr
= format
;
1147 unsigned int arg_count
= 0;
1149 while (*ptr
!= '\0')
1153 ptr
= strchr (ptr
, '%');
1157 else if (ptr
[1] == '%')
1161 int wide_width
= 0, short_width
= 0;
1162 unsigned int arg_no
;
1167 /* Check for a positional parameter. */
1169 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1171 arg_no
= *ptr
- '1';
1175 /* Move past flags. */
1176 while (strchr ("-+ #0'I", *ptr
))
1181 unsigned int arg_index
;
1184 arg_index
= arg_count
;
1185 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1187 arg_index
= *ptr
- '1';
1192 args
[arg_index
].type
= Int
;
1196 /* Handle explicit numeric value. */
1197 while (ISDIGIT (*ptr
))
1206 unsigned int arg_index
;
1209 arg_index
= arg_count
;
1210 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1212 arg_index
= *ptr
- '1';
1217 args
[arg_index
].type
= Int
;
1221 /* Handle explicit numeric value. */
1222 while (ISDIGIT (*ptr
))
1225 while (strchr ("hlL", *ptr
))
1245 if ((int) arg_no
< 0)
1273 arg_type
= LongLong
;
1285 if (wide_width
== 0)
1288 arg_type
= LongDouble
;
1295 if (*ptr
== 'A' || *ptr
== 'B')
1305 args
[arg_no
].type
= arg_type
;
1314 error_handler_internal (const char *fmt
, va_list ap
)
1316 unsigned int i
, arg_count
;
1317 union _bfd_doprnt_args args
[9];
1319 for (i
= 0; i
< sizeof (args
) / sizeof (args
[0]); i
++)
1322 arg_count
= _bfd_doprnt_scan (fmt
, args
);
1323 for (i
= 0; i
< arg_count
; i
++)
1325 switch (args
[i
].type
)
1328 args
[i
].i
= va_arg (ap
, int);
1331 args
[i
].l
= va_arg (ap
, long);
1334 args
[i
].ll
= va_arg (ap
, long long);
1337 args
[i
].d
= va_arg (ap
, double);
1340 args
[i
].ld
= va_arg (ap
, long double);
1343 args
[i
].p
= va_arg (ap
, void *);
1350 /* PR 4992: Don't interrupt output being sent to stdout. */
1353 if (_bfd_error_program_name
!= NULL
)
1354 fprintf (stderr
, "%s: ", _bfd_error_program_name
);
1356 fprintf (stderr
, "BFD: ");
1358 _bfd_doprnt (stderr
, fmt
, args
);
1360 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
1361 warning, so use the fputc function to avoid it. */
1362 fputc ('\n', stderr
);
1366 /* This is a function pointer to the routine which should handle BFD
1367 error messages. It is called when a BFD routine encounters an
1368 error for which it wants to print a message. Going through a
1369 function pointer permits a program linked against BFD to intercept
1370 the messages and deal with them itself. */
1372 static bfd_error_handler_type _bfd_error_internal
= error_handler_internal
;
1379 void _bfd_error_handler (const char *fmt, ...) ATTRIBUTE_PRINTF_1;
1382 This is the default routine to handle BFD error messages.
1383 Like fprintf (stderr, ...), but also handles some extra format
1386 %pA section name from section. For group components, prints
1388 %pB file name from bfd. For archive components, prints
1391 Beware: Only supports a maximum of 9 format arguments.
1395 _bfd_error_handler (const char *fmt
, ...)
1400 _bfd_error_internal (fmt
, ap
);
1406 bfd_set_error_handler
1409 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
1412 Set the BFD error handler function. Returns the previous
1416 bfd_error_handler_type
1417 bfd_set_error_handler (bfd_error_handler_type pnew
)
1419 bfd_error_handler_type pold
;
1421 pold
= _bfd_error_internal
;
1422 _bfd_error_internal
= pnew
;
1428 bfd_set_error_program_name
1431 void bfd_set_error_program_name (const char *);
1434 Set the program name to use when printing a BFD error. This
1435 is printed before the error message followed by a colon and
1436 space. The string must not be changed after it is passed to
1441 bfd_set_error_program_name (const char *name
)
1443 _bfd_error_program_name
= name
;
1450 If BFD finds an internal inconsistency, the bfd assert
1451 handler is called with information on the BFD version, BFD
1452 source file and line. If this happens, most programs linked
1453 against BFD are expected to want to exit with an error, or mark
1454 the current BFD operation as failed, so it is recommended to
1455 override the default handler, which just calls
1456 _bfd_error_handler and continues.
1460 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
1461 . const char *bfd_version,
1462 . const char *bfd_file,
1467 /* Note the use of bfd_ prefix on the parameter names above: we want to
1468 show which one is the message and which is the version by naming the
1469 parameters, but avoid polluting the program-using-bfd namespace as
1470 the typedef is visible in the exported headers that the program
1471 includes. Below, it's just for consistency. */
1474 _bfd_default_assert_handler (const char *bfd_formatmsg
,
1475 const char *bfd_version
,
1476 const char *bfd_file
,
1480 _bfd_error_handler (bfd_formatmsg
, bfd_version
, bfd_file
, bfd_line
);
1483 /* Similar to _bfd_error_handler, a program can decide to exit on an
1484 internal BFD error. We use a non-variadic type to simplify passing
1485 on parameters to other functions, e.g. _bfd_error_handler. */
1487 static bfd_assert_handler_type _bfd_assert_handler
= _bfd_default_assert_handler
;
1491 bfd_set_assert_handler
1494 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
1497 Set the BFD assert handler function. Returns the previous
1501 bfd_assert_handler_type
1502 bfd_set_assert_handler (bfd_assert_handler_type pnew
)
1504 bfd_assert_handler_type pold
;
1506 pold
= _bfd_assert_handler
;
1507 _bfd_assert_handler
= pnew
;
1513 Miscellaneous, Memory Usage, Error reporting, BFD front end
1519 Miscellaneous functions
1524 bfd_get_reloc_upper_bound
1527 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1530 Return the number of bytes required to store the
1531 relocation information associated with section @var{sect}
1532 attached to bfd @var{abfd}. If an error occurs, return -1.
1537 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
1539 if (abfd
->format
!= bfd_object
)
1541 bfd_set_error (bfd_error_invalid_operation
);
1545 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
1550 bfd_canonicalize_reloc
1553 long bfd_canonicalize_reloc
1554 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1557 Call the back end associated with the open BFD
1558 @var{abfd} and translate the external form of the relocation
1559 information attached to @var{sec} into the internal canonical
1560 form. Place the table into memory at @var{loc}, which has
1561 been preallocated, usually by a call to
1562 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
1565 The @var{syms} table is also needed for horrible internal magic
1570 bfd_canonicalize_reloc (bfd
*abfd
,
1575 if (abfd
->format
!= bfd_object
)
1577 bfd_set_error (bfd_error_invalid_operation
);
1581 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
1582 (abfd
, asect
, location
, symbols
));
1591 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1594 Set the relocation pointer and count within
1595 section @var{sec} to the values @var{rel} and @var{count}.
1596 The argument @var{abfd} is ignored.
1598 .#define bfd_set_reloc(abfd, asect, location, count) \
1599 . BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1607 bool bfd_set_file_flags (bfd *abfd, flagword flags);
1610 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1612 Possible errors are:
1613 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1614 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1615 o <<bfd_error_invalid_operation>> -
1616 The flag word contained a bit which was not applicable to the
1617 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1618 on a BFD format which does not support demand paging.
1623 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
1625 if (abfd
->format
!= bfd_object
)
1627 bfd_set_error (bfd_error_wrong_format
);
1631 if (bfd_read_p (abfd
))
1633 bfd_set_error (bfd_error_invalid_operation
);
1637 abfd
->flags
= flags
;
1638 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
1640 bfd_set_error (bfd_error_invalid_operation
);
1648 bfd_assert (const char *file
, int line
)
1650 /* xgettext:c-format */
1651 (*_bfd_assert_handler
) (_("BFD %s assertion fail %s:%d"),
1652 BFD_VERSION_STRING
, file
, line
);
1655 /* A more or less friendly abort message. In libbfd.h abort is
1656 defined to call this function. */
1659 _bfd_abort (const char *file
, int line
, const char *fn
)
1663 /* xgettext:c-format */
1664 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1665 BFD_VERSION_STRING
, file
, line
, fn
);
1668 /* xgettext:c-format */
1669 (_("BFD %s internal error, aborting at %s:%d\n"),
1670 BFD_VERSION_STRING
, file
, line
);
1671 _bfd_error_handler (_("Please report this bug.\n"));
1672 _exit (EXIT_FAILURE
);
1680 int bfd_get_arch_size (bfd *abfd);
1683 Returns the normalized architecture address size, in bits, as
1684 determined by the object file's format. By normalized, we mean
1685 either 32 or 64. For ELF, this information is included in the
1686 header. Use bfd_arch_bits_per_address for number of bits in
1687 the architecture address.
1690 Returns the arch size in bits if known, <<-1>> otherwise.
1694 bfd_get_arch_size (bfd
*abfd
)
1696 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1697 return get_elf_backend_data (abfd
)->s
->arch_size
;
1699 return bfd_arch_bits_per_address (abfd
) > 32 ? 64 : 32;
1704 bfd_get_sign_extend_vma
1707 int bfd_get_sign_extend_vma (bfd *abfd);
1710 Indicates if the target architecture "naturally" sign extends
1711 an address. Some architectures implicitly sign extend address
1712 values when they are converted to types larger than the size
1713 of an address. For instance, bfd_get_start_address() will
1714 return an address sign extended to fill a bfd_vma when this is
1718 Returns <<1>> if the target architecture is known to sign
1719 extend addresses, <<0>> if the target architecture is known to
1720 not sign extend addresses, and <<-1>> otherwise.
1724 bfd_get_sign_extend_vma (bfd
*abfd
)
1728 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1729 return get_elf_backend_data (abfd
)->sign_extend_vma
;
1731 name
= bfd_get_target (abfd
);
1733 /* Return a proper value for DJGPP & PE COFF.
1734 This function is required for DWARF2 support, but there is
1735 no place to store this information in the COFF back end.
1736 Should enough other COFF targets add support for DWARF2,
1737 a place will have to be found. Until then, this hack will do. */
1738 if (startswith (name
, "coff-go32")
1739 || strcmp (name
, "pe-i386") == 0
1740 || strcmp (name
, "pei-i386") == 0
1741 || strcmp (name
, "pe-x86-64") == 0
1742 || strcmp (name
, "pei-x86-64") == 0
1743 || strcmp (name
, "pei-aarch64-little") == 0
1744 || strcmp (name
, "pe-arm-wince-little") == 0
1745 || strcmp (name
, "pei-arm-wince-little") == 0
1746 || strcmp (name
, "pei-loongarch64") == 0
1747 || strcmp (name
, "aixcoff-rs6000") == 0
1748 || strcmp (name
, "aix5coff64-rs6000") == 0)
1751 if (startswith (name
, "mach-o"))
1754 bfd_set_error (bfd_error_wrong_format
);
1760 bfd_set_start_address
1763 bool bfd_set_start_address (bfd *abfd, bfd_vma vma);
1766 Make @var{vma} the entry point of output BFD @var{abfd}.
1769 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1773 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
1775 abfd
->start_address
= vma
;
1784 unsigned int bfd_get_gp_size (bfd *abfd);
1787 Return the maximum size of objects to be optimized using the GP
1788 register under MIPS ECOFF. This is typically set by the <<-G>>
1789 argument to the compiler, assembler or linker.
1793 bfd_get_gp_size (bfd
*abfd
)
1795 if (abfd
->format
== bfd_object
)
1797 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1798 return ecoff_data (abfd
)->gp_size
;
1799 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1800 return elf_gp_size (abfd
);
1810 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1813 Set the maximum size of objects to be optimized using the GP
1814 register under ECOFF or MIPS ELF. This is typically set by
1815 the <<-G>> argument to the compiler, assembler or linker.
1819 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
1821 /* Don't try to set GP size on an archive or core file! */
1822 if (abfd
->format
!= bfd_object
)
1825 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1826 ecoff_data (abfd
)->gp_size
= i
;
1827 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1828 elf_gp_size (abfd
) = i
;
1831 /* Get the GP value. This is an internal function used by some of the
1832 relocation special_function routines on targets which support a GP
1836 _bfd_get_gp_value (bfd
*abfd
)
1840 if (abfd
->format
!= bfd_object
)
1843 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1844 return ecoff_data (abfd
)->gp
;
1845 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1846 return elf_gp (abfd
);
1851 /* Set the GP value. */
1854 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
1858 if (abfd
->format
!= bfd_object
)
1861 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1862 ecoff_data (abfd
)->gp
= v
;
1863 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1872 void bfd_set_gp_value (bfd *abfd, bfd_vma v);
1875 Allow external access to the fucntion to set the GP value.
1876 This is specifically added for gdb-compile support.
1880 bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
1882 _bfd_set_gp_value (abfd
, v
);
1890 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
1893 Convert, like <<strtoul>>, a numerical expression
1894 @var{string} into a <<bfd_vma>> integer, and return that integer.
1895 (Though without as many bells and whistles as <<strtoul>>.)
1896 The expression is assumed to be unsigned (i.e., positive).
1897 If given a @var{base}, it is used as the base for conversion.
1898 A base of 0 causes the function to interpret the string
1899 in hex if a leading "0x" or "0X" is found, otherwise
1900 in octal if a leading zero is found, otherwise in decimal.
1902 If the value would overflow, the maximum <<bfd_vma>> value is
1907 bfd_scan_vma (const char *string
, const char **end
, int base
)
1911 unsigned int cutlim
;
1914 /* Let the host do it if possible. */
1915 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
1916 return strtoul (string
, (char **) end
, base
);
1918 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
1919 return strtoull (string
, (char **) end
, base
);
1923 if (string
[0] == '0')
1925 if ((string
[1] == 'x') || (string
[1] == 'X'))
1932 if ((base
< 2) || (base
> 36))
1937 && (string
[1] == 'x' || string
[1] == 'X')
1938 && ISXDIGIT (string
[2]))
1943 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
1944 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
1952 if (ISDIGIT (digit
))
1953 digit
= digit
- '0';
1954 else if (ISALPHA (digit
))
1955 digit
= TOUPPER (digit
) - 'A' + 10;
1958 if (digit
>= (unsigned int) base
)
1960 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
1962 value
= value
* base
+ digit
;
1967 value
= ~ (bfd_vma
) 0;
1977 bfd_copy_private_header_data
1980 bool bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1983 Copy private BFD header information from the BFD @var{ibfd} to the
1984 the BFD @var{obfd}. This copies information that may require
1985 sections to exist, but does not require symbol tables. Return
1986 <<true>> on success, <<false>> on error.
1987 Possible error returns are:
1989 o <<bfd_error_no_memory>> -
1990 Not enough memory exists to create private data for @var{obfd}.
1992 .#define bfd_copy_private_header_data(ibfd, obfd) \
1993 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
2000 bfd_copy_private_bfd_data
2003 bool bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
2006 Copy private BFD information from the BFD @var{ibfd} to the
2007 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
2008 Possible error returns are:
2010 o <<bfd_error_no_memory>> -
2011 Not enough memory exists to create private data for @var{obfd}.
2013 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
2014 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
2021 bfd_set_private_flags
2024 bool bfd_set_private_flags (bfd *abfd, flagword flags);
2027 Set private BFD flag information in the BFD @var{abfd}.
2028 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
2031 o <<bfd_error_no_memory>> -
2032 Not enough memory exists to create private data for @var{obfd}.
2034 .#define bfd_set_private_flags(abfd, flags) \
2035 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
2044 The following functions exist but have not yet been documented.
2046 .#define bfd_sizeof_headers(abfd, info) \
2047 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
2049 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2050 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2051 . (abfd, syms, sec, off, file, func, line, NULL))
2053 .#define bfd_find_nearest_line_with_alt(abfd, alt_filename, sec, syms, off, \
2054 . file, func, line, disc) \
2055 . BFD_SEND (abfd, _bfd_find_nearest_line_with_alt, \
2056 . (abfd, alt_filename, syms, sec, off, file, func, line, disc))
2058 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
2060 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2061 . (abfd, syms, sec, off, file, func, line, disc))
2063 .#define bfd_find_line(abfd, syms, sym, file, line) \
2064 . BFD_SEND (abfd, _bfd_find_line, \
2065 . (abfd, syms, sym, file, line))
2067 .#define bfd_find_inliner_info(abfd, file, func, line) \
2068 . BFD_SEND (abfd, _bfd_find_inliner_info, \
2069 . (abfd, file, func, line))
2071 .#define bfd_debug_info_start(abfd) \
2072 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2074 .#define bfd_debug_info_end(abfd) \
2075 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2077 .#define bfd_debug_info_accumulate(abfd, section) \
2078 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2080 .#define bfd_stat_arch_elt(abfd, stat) \
2081 . BFD_SEND (abfd->my_archive ? abfd->my_archive : abfd, \
2082 . _bfd_stat_arch_elt, (abfd, stat))
2084 .#define bfd_update_armap_timestamp(abfd) \
2085 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2087 .#define bfd_set_arch_mach(abfd, arch, mach)\
2088 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2090 .#define bfd_relax_section(abfd, section, link_info, again) \
2091 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2093 .#define bfd_gc_sections(abfd, link_info) \
2094 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
2096 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
2097 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
2099 .#define bfd_merge_sections(abfd, link_info) \
2100 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
2102 .#define bfd_is_group_section(abfd, sec) \
2103 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
2105 .#define bfd_group_name(abfd, sec) \
2106 . BFD_SEND (abfd, _bfd_group_name, (abfd, sec))
2108 .#define bfd_discard_group(abfd, sec) \
2109 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
2111 .#define bfd_link_hash_table_create(abfd) \
2112 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2114 .#define bfd_link_add_symbols(abfd, info) \
2115 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2117 .#define bfd_link_just_syms(abfd, sec, info) \
2118 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
2120 .#define bfd_final_link(abfd, info) \
2121 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2123 .#define bfd_free_cached_info(abfd) \
2124 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2126 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
2127 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2129 .#define bfd_print_private_bfd_data(abfd, file)\
2130 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2132 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2133 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2135 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
2136 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
2137 . dyncount, dynsyms, ret))
2139 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
2140 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2142 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2143 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2145 .extern bfd_byte *bfd_get_relocated_section_contents
2146 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
2147 . bool, asymbol **);
2153 bfd_get_relocated_section_contents (bfd
*abfd
,
2154 struct bfd_link_info
*link_info
,
2155 struct bfd_link_order
*link_order
,
2161 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
2162 bfd_byte
*, bool, asymbol
**);
2164 if (link_order
->type
== bfd_indirect_link_order
)
2166 abfd2
= link_order
->u
.indirect
.section
->owner
;
2173 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
2175 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
2178 /* Record information about an ELF program header. */
2181 bfd_record_phdr (bfd
*abfd
,
2186 bfd_vma at
, /* Bytes. */
2187 bool includes_filehdr
,
2188 bool includes_phdrs
,
2192 struct elf_segment_map
*m
, **pm
;
2194 unsigned int opb
= bfd_octets_per_byte (abfd
, NULL
);
2196 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2199 amt
= sizeof (struct elf_segment_map
);
2200 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
2201 m
= (struct elf_segment_map
*) bfd_zalloc (abfd
, amt
);
2207 m
->p_paddr
= at
* opb
;
2208 m
->p_flags_valid
= flags_valid
;
2209 m
->p_paddr_valid
= at_valid
;
2210 m
->includes_filehdr
= includes_filehdr
;
2211 m
->includes_phdrs
= includes_phdrs
;
2214 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
2216 for (pm
= &elf_seg_map (abfd
); *pm
!= NULL
; pm
= &(*pm
)->next
)
2224 /* Return true iff this target is 32-bit. */
2229 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2231 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
2232 return bed
->s
->elfclass
== ELFCLASS32
;
2235 /* For non-ELF targets, use architecture information. */
2236 return bfd_arch_bits_per_address (abfd
) <= 32;
2240 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
2241 target's address size. */
2244 bfd_sprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, char *buf
, bfd_vma value
)
2247 if (!is32bit (abfd
))
2249 sprintf (buf
, "%016" PRIx64
, (uint64_t) value
);
2253 sprintf (buf
, "%08lx", (unsigned long) value
& 0xffffffff);
2257 bfd_fprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, void *stream
, bfd_vma value
)
2260 if (!is32bit (abfd
))
2262 fprintf ((FILE *) stream
, "%016" PRIx64
, (uint64_t) value
);
2266 fprintf ((FILE *) stream
, "%08lx", (unsigned long) value
& 0xffffffff);
2274 bool bfd_alt_mach_code (bfd *abfd, int alternative);
2278 When more than one machine code number is available for the
2279 same machine type, this function can be used to switch between
2280 the preferred one (alternative == 0) and any others. Currently,
2281 only ELF supports this feature, with up to two alternate
2286 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
2288 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2292 switch (alternative
)
2295 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
2299 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
2305 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
2314 elf_elfheader (abfd
)->e_machine
= code
;
2324 bfd_emul_get_maxpagesize
2327 bfd_vma bfd_emul_get_maxpagesize (const char *);
2330 Returns the maximum page size, in bytes, as determined by
2334 Returns the maximum page size in bytes for ELF, 0 otherwise.
2338 bfd_emul_get_maxpagesize (const char *emul
)
2340 const bfd_target
*target
;
2342 target
= bfd_find_target (emul
, NULL
);
2344 && target
->flavour
== bfd_target_elf_flavour
)
2345 return xvec_get_elf_backend_data (target
)->maxpagesize
;
2352 bfd_emul_get_commonpagesize
2355 bfd_vma bfd_emul_get_commonpagesize (const char *);
2358 Returns the common page size, in bytes, as determined by
2362 Returns the common page size in bytes for ELF, 0 otherwise.
2366 bfd_emul_get_commonpagesize (const char *emul
)
2368 const bfd_target
*target
;
2370 target
= bfd_find_target (emul
, NULL
);
2372 && target
->flavour
== bfd_target_elf_flavour
)
2374 const struct elf_backend_data
*bed
;
2376 bed
= xvec_get_elf_backend_data (target
);
2377 return bed
->commonpagesize
;
2387 char *bfd_demangle (bfd *, const char *, int);
2390 Wrapper around cplus_demangle. Strips leading underscores and
2391 other such chars that would otherwise confuse the demangler.
2392 If passed a g++ v3 ABI mangled name, returns a buffer allocated
2393 with malloc holding the demangled name. Returns NULL otherwise
2394 and on memory alloc failure.
2398 bfd_demangle (bfd
*abfd
, const char *name
, int options
)
2401 const char *pre
, *suf
;
2405 skip_lead
= (abfd
!= NULL
2407 && bfd_get_symbol_leading_char (abfd
) == *name
);
2411 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
2412 or the MS PE format. These formats have a number of leading '.'s
2413 on at least some symbols, so we remove all dots to avoid
2414 confusing the demangler. */
2416 while (*name
== '.' || *name
== '$')
2418 pre_len
= name
- pre
;
2420 /* Strip off @plt and suchlike too. */
2422 suf
= strchr (name
, '@');
2425 alloc
= (char *) bfd_malloc (suf
- name
+ 1);
2428 memcpy (alloc
, name
, suf
- name
);
2429 alloc
[suf
- name
] = '\0';
2433 res
= cplus_demangle (name
, options
);
2441 size_t len
= strlen (pre
) + 1;
2442 alloc
= (char *) bfd_malloc (len
);
2445 memcpy (alloc
, pre
, len
);
2451 /* Put back any prefix or suffix. */
2452 if (pre_len
!= 0 || suf
!= NULL
)
2461 suf_len
= strlen (suf
) + 1;
2462 final
= (char *) bfd_malloc (pre_len
+ len
+ suf_len
);
2465 memcpy (final
, pre
, pre_len
);
2466 memcpy (final
+ pre_len
, res
, len
);
2467 memcpy (final
+ pre_len
+ len
, suf
, suf_len
);
2478 bfd_update_compression_header
2481 void bfd_update_compression_header
2482 (bfd *abfd, bfd_byte *contents, asection *sec);
2485 Set the compression header at CONTENTS of SEC in ABFD and update
2486 elf_section_flags for compression.
2490 bfd_update_compression_header (bfd
*abfd
, bfd_byte
*contents
,
2493 if ((abfd
->flags
& BFD_COMPRESS
) == 0)
2496 switch (bfd_get_flavour (abfd
))
2498 case bfd_target_elf_flavour
:
2499 if ((abfd
->flags
& BFD_COMPRESS_GABI
) != 0)
2501 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
2502 struct bfd_elf_section_data
* esd
= elf_section_data (sec
);
2504 /* Set the SHF_COMPRESSED bit. */
2505 elf_section_flags (sec
) |= SHF_COMPRESSED
;
2507 if (bed
->s
->elfclass
== ELFCLASS32
)
2509 Elf32_External_Chdr
*echdr
= (Elf32_External_Chdr
*) contents
;
2510 bfd_put_32 (abfd
, ELFCOMPRESS_ZLIB
, &echdr
->ch_type
);
2511 bfd_put_32 (abfd
, sec
->size
, &echdr
->ch_size
);
2512 bfd_put_32 (abfd
, 1u << sec
->alignment_power
,
2513 &echdr
->ch_addralign
);
2514 /* bfd_log2 (alignof (Elf32_Chdr)) */
2515 bfd_set_section_alignment (sec
, 2);
2516 esd
->this_hdr
.sh_addralign
= 4;
2520 Elf64_External_Chdr
*echdr
= (Elf64_External_Chdr
*) contents
;
2521 bfd_put_32 (abfd
, ELFCOMPRESS_ZLIB
, &echdr
->ch_type
);
2522 bfd_put_32 (abfd
, 0, &echdr
->ch_reserved
);
2523 bfd_put_64 (abfd
, sec
->size
, &echdr
->ch_size
);
2524 bfd_put_64 (abfd
, UINT64_C (1) << sec
->alignment_power
,
2525 &echdr
->ch_addralign
);
2526 /* bfd_log2 (alignof (Elf64_Chdr)) */
2527 bfd_set_section_alignment (sec
, 3);
2528 esd
->this_hdr
.sh_addralign
= 8;
2533 /* Clear the SHF_COMPRESSED bit. */
2534 elf_section_flags (sec
) &= ~SHF_COMPRESSED
;
2538 /* Write the zlib header. It should be "ZLIB" followed by
2539 the uncompressed section size, 8 bytes in big-endian
2541 memcpy (contents
, "ZLIB", 4);
2542 bfd_putb64 (sec
->size
, contents
+ 4);
2543 /* No way to keep the original alignment, just use 1 always. */
2544 bfd_set_section_alignment (sec
, 0);
2551 bfd_check_compression_header
2554 bool bfd_check_compression_header
2555 (bfd *abfd, bfd_byte *contents, asection *sec,
2556 bfd_size_type *uncompressed_size,
2557 unsigned int *uncompressed_alignment_power);
2560 Check the compression header at CONTENTS of SEC in ABFD and
2561 store the uncompressed size in UNCOMPRESSED_SIZE and the
2562 uncompressed data alignment in UNCOMPRESSED_ALIGNMENT_POWER
2563 if the compression header is valid.
2566 Return TRUE if the compression header is valid.
2570 bfd_check_compression_header (bfd
*abfd
, bfd_byte
*contents
,
2572 bfd_size_type
*uncompressed_size
,
2573 unsigned int *uncompressed_alignment_power
)
2575 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
2576 && (elf_section_flags (sec
) & SHF_COMPRESSED
) != 0)
2578 Elf_Internal_Chdr chdr
;
2579 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
2580 if (bed
->s
->elfclass
== ELFCLASS32
)
2582 Elf32_External_Chdr
*echdr
= (Elf32_External_Chdr
*) contents
;
2583 chdr
.ch_type
= bfd_get_32 (abfd
, &echdr
->ch_type
);
2584 chdr
.ch_size
= bfd_get_32 (abfd
, &echdr
->ch_size
);
2585 chdr
.ch_addralign
= bfd_get_32 (abfd
, &echdr
->ch_addralign
);
2589 Elf64_External_Chdr
*echdr
= (Elf64_External_Chdr
*) contents
;
2590 chdr
.ch_type
= bfd_get_32 (abfd
, &echdr
->ch_type
);
2591 chdr
.ch_size
= bfd_get_64 (abfd
, &echdr
->ch_size
);
2592 chdr
.ch_addralign
= bfd_get_64 (abfd
, &echdr
->ch_addralign
);
2594 if (chdr
.ch_type
== ELFCOMPRESS_ZLIB
2595 && chdr
.ch_addralign
== (chdr
.ch_addralign
& -chdr
.ch_addralign
))
2597 *uncompressed_size
= chdr
.ch_size
;
2598 *uncompressed_alignment_power
= bfd_log2 (chdr
.ch_addralign
);
2608 bfd_get_compression_header_size
2611 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2614 Return the size of the compression header of SEC in ABFD.
2617 Return the size of the compression header in bytes.
2621 bfd_get_compression_header_size (bfd
*abfd
, asection
*sec
)
2623 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2627 if (!(abfd
->flags
& BFD_COMPRESS_GABI
))
2630 else if (!(elf_section_flags (sec
) & SHF_COMPRESSED
))
2633 if (get_elf_backend_data (abfd
)->s
->elfclass
== ELFCLASS32
)
2634 return sizeof (Elf32_External_Chdr
);
2636 return sizeof (Elf64_External_Chdr
);
2644 bfd_convert_section_size
2647 bfd_size_type bfd_convert_section_size
2648 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2651 Convert the size @var{size} of the section @var{isec} in input
2652 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2656 bfd_convert_section_size (bfd
*ibfd
, sec_ptr isec
, bfd
*obfd
,
2659 bfd_size_type hdr_size
;
2661 /* Do nothing if either input or output aren't ELF. */
2662 if (bfd_get_flavour (ibfd
) != bfd_target_elf_flavour
2663 || bfd_get_flavour (obfd
) != bfd_target_elf_flavour
)
2666 /* Do nothing if ELF classes of input and output are the same. */
2667 if (get_elf_backend_data (ibfd
)->s
->elfclass
2668 == get_elf_backend_data (obfd
)->s
->elfclass
)
2671 /* Convert GNU property size. */
2672 if (startswith (isec
->name
, NOTE_GNU_PROPERTY_SECTION_NAME
))
2673 return _bfd_elf_convert_gnu_property_size (ibfd
, obfd
);
2675 /* Do nothing if input file will be decompressed. */
2676 if ((ibfd
->flags
& BFD_DECOMPRESS
))
2679 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2680 hdr_size
= bfd_get_compression_header_size (ibfd
, isec
);
2684 /* Adjust the size of the output SHF_COMPRESSED section. */
2685 if (hdr_size
== sizeof (Elf32_External_Chdr
))
2686 return (size
- sizeof (Elf32_External_Chdr
)
2687 + sizeof (Elf64_External_Chdr
));
2689 return (size
- sizeof (Elf64_External_Chdr
)
2690 + sizeof (Elf32_External_Chdr
));
2695 bfd_convert_section_contents
2698 bool bfd_convert_section_contents
2699 (bfd *ibfd, asection *isec, bfd *obfd,
2700 bfd_byte **ptr, bfd_size_type *ptr_size);
2703 Convert the contents, stored in @var{*ptr}, of the section
2704 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2705 if needed. The original buffer pointed to by @var{*ptr} may
2706 be freed and @var{*ptr} is returned with memory malloc'd by this
2707 function, and the new size written to @var{ptr_size}.
2711 bfd_convert_section_contents (bfd
*ibfd
, sec_ptr isec
, bfd
*obfd
,
2712 bfd_byte
**ptr
, bfd_size_type
*ptr_size
)
2715 bfd_size_type ihdr_size
, ohdr_size
, size
;
2716 Elf_Internal_Chdr chdr
;
2719 /* Do nothing if either input or output aren't ELF. */
2720 if (bfd_get_flavour (ibfd
) != bfd_target_elf_flavour
2721 || bfd_get_flavour (obfd
) != bfd_target_elf_flavour
)
2724 /* Do nothing if ELF classes of input and output are the same. */
2725 if (get_elf_backend_data (ibfd
)->s
->elfclass
2726 == get_elf_backend_data (obfd
)->s
->elfclass
)
2729 /* Convert GNU properties. */
2730 if (startswith (isec
->name
, NOTE_GNU_PROPERTY_SECTION_NAME
))
2731 return _bfd_elf_convert_gnu_properties (ibfd
, isec
, obfd
, ptr
,
2734 /* Do nothing if input file will be decompressed. */
2735 if ((ibfd
->flags
& BFD_DECOMPRESS
))
2738 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2739 ihdr_size
= bfd_get_compression_header_size (ibfd
, isec
);
2743 /* PR 25221. Check for corrupt input sections. */
2744 if (ihdr_size
> bfd_get_section_limit (ibfd
, isec
))
2745 /* FIXME: Issue a warning about a corrupt
2746 compression header size field ? */
2751 /* Convert the contents of the input SHF_COMPRESSED section to
2752 output. Get the input compression header and the size of the
2753 output compression header. */
2754 if (ihdr_size
== sizeof (Elf32_External_Chdr
))
2756 Elf32_External_Chdr
*echdr
= (Elf32_External_Chdr
*) contents
;
2757 chdr
.ch_type
= bfd_get_32 (ibfd
, &echdr
->ch_type
);
2758 chdr
.ch_size
= bfd_get_32 (ibfd
, &echdr
->ch_size
);
2759 chdr
.ch_addralign
= bfd_get_32 (ibfd
, &echdr
->ch_addralign
);
2761 ohdr_size
= sizeof (Elf64_External_Chdr
);
2763 use_memmove
= false;
2765 else if (ihdr_size
!= sizeof (Elf64_External_Chdr
))
2767 /* FIXME: Issue a warning about a corrupt
2768 compression header size field ? */
2773 Elf64_External_Chdr
*echdr
= (Elf64_External_Chdr
*) contents
;
2774 chdr
.ch_type
= bfd_get_32 (ibfd
, &echdr
->ch_type
);
2775 chdr
.ch_size
= bfd_get_64 (ibfd
, &echdr
->ch_size
);
2776 chdr
.ch_addralign
= bfd_get_64 (ibfd
, &echdr
->ch_addralign
);
2778 ohdr_size
= sizeof (Elf32_External_Chdr
);
2782 size
= bfd_section_size (isec
) - ihdr_size
+ ohdr_size
;
2785 contents
= (bfd_byte
*) bfd_malloc (size
);
2786 if (contents
== NULL
)
2790 /* Write out the output compression header. */
2791 if (ohdr_size
== sizeof (Elf32_External_Chdr
))
2793 Elf32_External_Chdr
*echdr
= (Elf32_External_Chdr
*) contents
;
2794 bfd_put_32 (obfd
, ELFCOMPRESS_ZLIB
, &echdr
->ch_type
);
2795 bfd_put_32 (obfd
, chdr
.ch_size
, &echdr
->ch_size
);
2796 bfd_put_32 (obfd
, chdr
.ch_addralign
, &echdr
->ch_addralign
);
2800 Elf64_External_Chdr
*echdr
= (Elf64_External_Chdr
*) contents
;
2801 bfd_put_32 (obfd
, ELFCOMPRESS_ZLIB
, &echdr
->ch_type
);
2802 bfd_put_32 (obfd
, 0, &echdr
->ch_reserved
);
2803 bfd_put_64 (obfd
, chdr
.ch_size
, &echdr
->ch_size
);
2804 bfd_put_64 (obfd
, chdr
.ch_addralign
, &echdr
->ch_addralign
);
2807 /* Copy the compressed contents. */
2809 memmove (contents
+ ohdr_size
, *ptr
+ ihdr_size
, size
- ohdr_size
);
2812 memcpy (contents
+ ohdr_size
, *ptr
+ ihdr_size
, size
- ohdr_size
);
2821 /* Get the linker information. */
2823 struct bfd_link_info
*
2824 _bfd_get_link_info (bfd
*abfd
)
2826 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2829 return elf_link_info (abfd
);