1 /* Generic BFD library interface and support routines.
2 Copyright (C) 1990-2023 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 . {* Compress sections in this BFD with SHF_COMPRESSED zstd. *}
182 .#define BFD_COMPRESS_ZSTD 0x400000
184 . {* Flags bits which are for BFD use only. *}
185 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
186 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
187 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
188 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
190 . {* The format which belongs to the BFD. (object, core, etc.) *}
191 . ENUM_BITFIELD (bfd_format) format : 3;
193 . {* The direction with which the BFD was opened. *}
194 . ENUM_BITFIELD (bfd_direction) direction : 2;
196 . {* Is the file descriptor being cached? That is, can it be closed as
197 . needed, and re-opened when accessed later? *}
198 . unsigned int cacheable : 1;
200 . {* Marks whether there was a default target specified when the
201 . BFD was opened. This is used to select which matching algorithm
202 . to use to choose the back end. *}
203 . unsigned int target_defaulted : 1;
205 . {* ... and here: (``once'' means at least once). *}
206 . unsigned int opened_once : 1;
208 . {* Set if we have a locally maintained mtime value, rather than
209 . getting it from the file each time. *}
210 . unsigned int mtime_set : 1;
212 . {* Flag set if symbols from this BFD should not be exported. *}
213 . unsigned int no_export : 1;
215 . {* Remember when output has begun, to stop strange things
217 . unsigned int output_has_begun : 1;
219 . {* Have archive map. *}
220 . unsigned int has_armap : 1;
222 . {* Set if this is a thin archive. *}
223 . unsigned int is_thin_archive : 1;
225 . {* Set if this archive should not cache element positions. *}
226 . unsigned int no_element_cache : 1;
228 . {* Set if only required symbols should be added in the link hash table for
229 . this object. Used by VMS linkers. *}
230 . unsigned int selective_search : 1;
232 . {* Set if this is the linker output BFD. *}
233 . unsigned int is_linker_output : 1;
235 . {* Set if this is the linker input BFD. *}
236 . unsigned int is_linker_input : 1;
238 . {* If this is an input for a compiler plug-in library. *}
239 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
241 . {* Set if this is a plugin output file. *}
242 . unsigned int lto_output : 1;
244 . {* Set if this is a slim LTO object not loaded with a compiler plugin. *}
245 . unsigned int lto_slim_object : 1;
247 . {* Do not attempt to modify this file. Set when detecting errors
248 . that BFD is not prepared to handle for objcopy/strip. *}
249 . unsigned int read_only : 1;
251 . {* Set to dummy BFD created when claimed by a compiler plug-in
253 . bfd *plugin_dummy_bfd;
255 . {* The offset of this bfd in the file, typically 0 if it is not
256 . contained in an archive. *}
259 . {* The origin in the archive of the proxy entry. This will
260 . normally be the same as origin, except for thin archives,
261 . when it will contain the current offset of the proxy in the
262 . thin archive rather than the offset of the bfd in its actual
264 . ufile_ptr proxy_origin;
266 . {* A hash table for section names. *}
267 . struct bfd_hash_table section_htab;
269 . {* Pointer to linked list of sections. *}
270 . struct bfd_section *sections;
272 . {* The last section on the section list. *}
273 . struct bfd_section *section_last;
275 . {* The number of sections. *}
276 . unsigned int section_count;
278 . {* The archive plugin file descriptor. *}
279 . int archive_plugin_fd;
281 . {* The number of opens on the archive plugin file descriptor. *}
282 . unsigned int archive_plugin_fd_open_count;
284 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
285 . be used only for archive elements. *}
288 . {* The total size of memory from bfd_alloc. *}
289 . bfd_size_type alloc_size;
291 . {* Stuff only useful for object files:
292 . The start address. *}
293 . bfd_vma start_address;
295 . {* Symbol table for output BFD (with symcount entries).
296 . Also used by the linker to cache input BFD symbols. *}
297 . struct bfd_symbol **outsymbols;
299 . {* Used for input and output. *}
300 . unsigned int symcount;
302 . {* Used for slurped dynamic symbol tables. *}
303 . unsigned int dynsymcount;
305 . {* Pointer to structure which contains architecture information. *}
306 . const struct bfd_arch_info *arch_info;
308 . {* Cached length of file for bfd_get_size. 0 until bfd_get_size is
309 . called, 1 if stat returns an error or the file size is too large to
310 . return in ufile_ptr. Both 0 and 1 should be treated as "unknown". *}
313 . {* Stuff only useful for archives. *}
315 . struct bfd *my_archive; {* The containing archive BFD. *}
316 . struct bfd *archive_next; {* The next BFD in the archive. *}
317 . struct bfd *archive_head; {* The first BFD in the archive. *}
318 . struct bfd *nested_archives; {* List of nested archive in a flattened
322 . {* For input BFDs, a chain of BFDs involved in a link. *}
324 . {* For output BFD, the linker hash table. *}
325 . struct bfd_link_hash_table *hash;
328 . {* Used by the back end to hold private data. *}
331 . struct aout_data_struct *aout_data;
332 . struct artdata *aout_ar_data;
333 . struct coff_tdata *coff_obj_data;
334 . struct pe_tdata *pe_obj_data;
335 . struct xcoff_tdata *xcoff_obj_data;
336 . struct ecoff_tdata *ecoff_obj_data;
337 . struct srec_data_struct *srec_data;
338 . struct verilog_data_struct *verilog_data;
339 . struct ihex_data_struct *ihex_data;
340 . struct tekhex_data_struct *tekhex_data;
341 . struct elf_obj_tdata *elf_obj_data;
342 . struct mmo_data_struct *mmo_data;
343 . struct trad_core_struct *trad_core_data;
344 . struct som_data_struct *som_data;
345 . struct hpux_core_struct *hpux_core_data;
346 . struct hppabsd_core_struct *hppabsd_core_data;
347 . struct sgi_core_struct *sgi_core_data;
348 . struct lynx_core_struct *lynx_core_data;
349 . struct osf_core_struct *osf_core_data;
350 . struct cisco_core_struct *cisco_core_data;
351 . struct netbsd_core_struct *netbsd_core_data;
352 . struct mach_o_data_struct *mach_o_data;
353 . struct mach_o_fat_data_struct *mach_o_fat_data;
354 . struct plugin_data_struct *plugin_data;
355 . struct bfd_pef_data_struct *pef_data;
356 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
357 . struct bfd_sym_data_struct *sym_data;
362 . {* Used by the application to hold private data. *}
365 . {* Where all the allocated stuff under this BFD goes. This is a
366 . struct objalloc *, but we use void * to avoid requiring the inclusion
370 . {* For input BFDs, the build ID, if the object has one. *}
371 . const struct bfd_build_id *build_id;
374 .static inline const char *
375 .bfd_get_filename (const bfd *abfd)
377 . return abfd->filename;
381 .bfd_get_cacheable (const bfd *abfd)
383 . return abfd->cacheable;
386 .static inline enum bfd_format
387 .bfd_get_format (const bfd *abfd)
389 . return abfd->format;
392 .static inline flagword
393 .bfd_get_file_flags (const bfd *abfd)
395 . return abfd->flags;
398 .static inline bfd_vma
399 .bfd_get_start_address (const bfd *abfd)
401 . return abfd->start_address;
404 .static inline unsigned int
405 .bfd_get_symcount (const bfd *abfd)
407 . return abfd->symcount;
410 .static inline unsigned int
411 .bfd_get_dynamic_symcount (const bfd *abfd)
413 . return abfd->dynsymcount;
416 .static inline struct bfd_symbol **
417 .bfd_get_outsymbols (const bfd *abfd)
419 . return abfd->outsymbols;
422 .static inline unsigned int
423 .bfd_count_sections (const bfd *abfd)
425 . return abfd->section_count;
429 .bfd_has_map (const bfd *abfd)
431 . return abfd->has_armap;
435 .bfd_is_thin_archive (const bfd *abfd)
437 . return abfd->is_thin_archive;
440 .static inline void *
441 .bfd_usrdata (const bfd *abfd)
443 . return abfd->usrdata;
446 .{* See note beside bfd_set_section_userdata. *}
448 .bfd_set_cacheable (bfd * abfd, bool val)
450 . abfd->cacheable = val;
455 .bfd_set_thin_archive (bfd *abfd, bool val)
457 . abfd->is_thin_archive = val;
461 .bfd_set_usrdata (bfd *abfd, void *val)
463 . abfd->usrdata = val;
466 .static inline asection *
467 .bfd_asymbol_section (const asymbol *sy)
469 . return sy->section;
472 .static inline bfd_vma
473 .bfd_asymbol_value (const asymbol *sy)
475 . return sy->section->vma + sy->value;
478 .static inline const char *
479 .bfd_asymbol_name (const asymbol *sy)
484 .static inline struct bfd *
485 .bfd_asymbol_bfd (const asymbol *sy)
487 . return sy->the_bfd;
491 .bfd_set_asymbol_name (asymbol *sy, const char *name)
496 .{* For input sections return the original size on disk of the
497 . section. For output sections return the current size. *}
498 .static inline bfd_size_type
499 .bfd_get_section_limit_octets (const bfd *abfd, const asection *sec)
501 . if (abfd->direction != write_direction && sec->rawsize != 0)
502 . return sec->rawsize;
506 .{* Find the address one past the end of SEC. *}
507 .static inline bfd_size_type
508 .bfd_get_section_limit (const bfd *abfd, const asection *sec)
510 . return (bfd_get_section_limit_octets (abfd, sec)
511 . / bfd_octets_per_byte (abfd, sec));
514 .{* For input sections return the larger of the current size and the
515 . original size on disk of the section. For output sections return
516 . the current size. *}
517 .static inline bfd_size_type
518 .bfd_get_section_alloc_size (const bfd *abfd, const asection *sec)
520 . if (abfd->direction != write_direction && sec->rawsize > sec->size)
521 . return sec->rawsize;
525 .{* Functions to handle insertion and deletion of a bfd's sections. These
526 . only handle the list pointers, ie. do not adjust section_count,
527 . target_index etc. *}
529 .bfd_section_list_remove (bfd *abfd, asection *s)
531 . asection *next = s->next;
532 . asection *prev = s->prev;
536 . abfd->sections = next;
540 . abfd->section_last = prev;
544 .bfd_section_list_append (bfd *abfd, asection *s)
547 . if (abfd->section_last)
549 . s->prev = abfd->section_last;
550 . abfd->section_last->next = s;
555 . abfd->sections = s;
557 . abfd->section_last = s;
561 .bfd_section_list_prepend (bfd *abfd, asection *s)
564 . if (abfd->sections)
566 . s->next = abfd->sections;
567 . abfd->sections->prev = s;
572 . abfd->section_last = s;
574 . abfd->sections = s;
578 .bfd_section_list_insert_after (bfd *abfd, asection *a, asection *s)
580 . asection *next = a->next;
587 . abfd->section_last = s;
591 .bfd_section_list_insert_before (bfd *abfd, asection *b, asection *s)
593 . asection *prev = b->prev;
600 . abfd->sections = s;
604 .bfd_section_removed_from_list (const bfd *abfd, const asection *s)
606 . return s->next ? s->next->prev != s : abfd->section_last != s;
615 #include "libiberty.h"
616 #include "demangle.h"
617 #include "safe-ctype.h"
620 #include "coff/internal.h"
621 #include "coff/sym.h"
623 #include "libecoff.h"
628 #define EXIT_FAILURE 1
632 /* provide storage for subsystem, stack and heap data which may have been
633 passed in on the command line. Ld puts this data into a bfd_link_info
634 struct which ultimately gets passed in to the bfd. When it arrives, copy
635 it to the following struct so that the data will be available in coffcode.h
636 where it is needed. The typedef's used are defined in bfd.h */
640 Error reporting, Initialization, typedef bfd, BFD front end
645 Most BFD functions return nonzero on success (check their
646 individual documentation for precise semantics). On an error,
647 they call <<bfd_set_error>> to set an error condition that callers
648 can check by calling <<bfd_get_error>>.
649 If that returns <<bfd_error_system_call>>, then check
652 The easiest way to report a BFD error to the user is to
656 Type <<bfd_error_type>>
658 The values returned by <<bfd_get_error>> are defined by the
659 enumerated type <<bfd_error_type>>.
663 .typedef enum bfd_error
665 . bfd_error_no_error = 0,
666 . bfd_error_system_call,
667 . bfd_error_invalid_target,
668 . bfd_error_wrong_format,
669 . bfd_error_wrong_object_format,
670 . bfd_error_invalid_operation,
671 . bfd_error_no_memory,
672 . bfd_error_no_symbols,
673 . bfd_error_no_armap,
674 . bfd_error_no_more_archived_files,
675 . bfd_error_malformed_archive,
676 . bfd_error_missing_dso,
677 . bfd_error_file_not_recognized,
678 . bfd_error_file_ambiguously_recognized,
679 . bfd_error_no_contents,
680 . bfd_error_nonrepresentable_section,
681 . bfd_error_no_debug_section,
682 . bfd_error_bad_value,
683 . bfd_error_file_truncated,
684 . bfd_error_file_too_big,
686 . bfd_error_on_input,
687 . bfd_error_invalid_error_code
693 static bfd_error_type bfd_error
;
694 static bfd
*input_bfd
;
695 static bfd_error_type input_error
;
697 const char *const bfd_errmsgs
[] =
700 N_("system call error"),
701 N_("invalid bfd target"),
702 N_("file in wrong format"),
703 N_("archive object file in wrong format"),
704 N_("invalid operation"),
705 N_("memory exhausted"),
707 N_("archive has no index; run ranlib to add one"),
708 N_("no more archived files"),
709 N_("malformed archive"),
710 N_("DSO missing from command line"),
711 N_("file format not recognized"),
712 N_("file format is ambiguous"),
713 N_("section has no contents"),
714 N_("nonrepresentable section on output"),
715 N_("symbol needs debug section which does not exist"),
717 N_("file truncated"),
719 N_("sorry, cannot handle this file"),
720 N_("error reading %s: %s"),
721 N_("#<invalid error code>")
729 bfd_error_type bfd_get_error (void);
732 Return the current BFD error condition.
746 void bfd_set_error (bfd_error_type error_tag);
749 Set the BFD error condition to be @var{error_tag}.
751 @var{error_tag} must not be bfd_error_on_input. Use
752 bfd_set_input_error for input errors instead.
756 bfd_set_error (bfd_error_type error_tag
)
758 bfd_error
= error_tag
;
759 if (bfd_error
>= bfd_error_on_input
)
768 void bfd_set_input_error (bfd *input, bfd_error_type error_tag);
772 Set the BFD error condition to be bfd_error_on_input.
773 @var{input} is the input bfd where the error occurred, and
774 @var{error_tag} the bfd_error_type error.
778 bfd_set_input_error (bfd
*input
, bfd_error_type error_tag
)
780 /* This is an error that occurred during bfd_close when writing an
781 archive, but on one of the input files. */
782 bfd_error
= bfd_error_on_input
;
784 input_error
= error_tag
;
785 if (input_error
>= bfd_error_on_input
)
794 const char *bfd_errmsg (bfd_error_type error_tag);
797 Return a string describing the error @var{error_tag}, or
798 the system error if @var{error_tag} is <<bfd_error_system_call>>.
802 bfd_errmsg (bfd_error_type error_tag
)
807 if (error_tag
== bfd_error_on_input
)
810 const char *msg
= bfd_errmsg (input_error
);
812 if (asprintf (&buf
, _(bfd_errmsgs
[error_tag
]),
813 bfd_get_filename (input_bfd
), msg
) != -1)
816 /* Ick, what to do on out of memory? */
820 if (error_tag
== bfd_error_system_call
)
821 return xstrerror (errno
);
823 if (error_tag
> bfd_error_invalid_error_code
)
824 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
826 return _(bfd_errmsgs
[error_tag
]);
834 void bfd_perror (const char *message);
837 Print to the standard error stream a string describing the
838 last BFD error that occurred, or the last system error if
839 the last BFD error was a system call failure. If @var{message}
840 is non-NULL and non-empty, the error string printed is preceded
841 by @var{message}, a colon, and a space. It is followed by a newline.
845 bfd_perror (const char *message
)
848 if (message
== NULL
|| *message
== '\0')
849 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
851 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
859 Some BFD functions want to print messages describing the
860 problem. They call a BFD error handler function. This
861 function may be overridden by the program.
863 The BFD error handler acts like vprintf.
867 .typedef void (*bfd_error_handler_type) (const char *, va_list);
871 /* The program name used when printing BFD error messages. */
873 static const char *_bfd_error_program_name
;
875 /* Support for positional parameters. */
877 union _bfd_doprnt_args
897 /* Maximum number of _bfd_error_handler args. Don't increase this
898 without changing the code handling positional parameters. */
901 /* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a
902 little and extended to handle '%pA', '%pB' and positional parameters. */
904 #define PRINT_TYPE(TYPE, FIELD) \
907 TYPE value = (TYPE) args[arg_no].FIELD; \
908 result = print (stream, specifier, value); \
911 typedef int (*print_func
) (void *, const char *, ...);
914 _bfd_doprnt (print_func print
, void *stream
, const char *format
,
915 union _bfd_doprnt_args
*args
)
917 const char *ptr
= format
;
919 int total_printed
= 0;
920 unsigned int arg_count
= 0;
928 /* While we have regular characters, print them. */
929 char *end
= strchr (ptr
, '%');
931 result
= print (stream
, "%.*s", (int) (end
- ptr
), ptr
);
933 result
= print (stream
, "%s", ptr
);
936 else if (ptr
[1] == '%')
944 /* We have a format specifier! */
945 char *sptr
= specifier
;
946 int wide_width
= 0, short_width
= 0;
949 /* Copy the % and move forward. */
952 /* Check for a positional parameter. */
954 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
960 /* Move past flags. */
961 while (strchr ("-+ #0'I", *ptr
))
967 unsigned int arg_index
;
970 arg_index
= arg_count
;
971 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
973 arg_index
= *ptr
- '1';
976 value
= abs (args
[arg_index
].i
);
978 sptr
+= sprintf (sptr
, "%d", value
);
981 /* Handle explicit numeric value. */
982 while (ISDIGIT (*ptr
))
988 /* Copy and go past the period. */
993 unsigned int arg_index
;
996 arg_index
= arg_count
;
997 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
999 arg_index
= *ptr
- '1';
1002 value
= abs (args
[arg_index
].i
);
1004 sptr
+= sprintf (sptr
, "%d", value
);
1007 /* Handle explicit numeric value. */
1008 while (ISDIGIT (*ptr
))
1011 while (strchr ("hlL", *ptr
))
1030 /* Copy the type specifier, and NULL terminate. */
1033 if ((int) arg_no
< 0)
1046 /* Short values are promoted to int, so just copy it
1047 as an int and trust the C library printf to cast it
1048 to the right width. */
1050 PRINT_TYPE (int, i
);
1056 PRINT_TYPE (int, i
);
1059 PRINT_TYPE (long, l
);
1063 #if defined (__MSVCRT__)
1070 PRINT_TYPE (long long, ll
);
1082 if (wide_width
== 0)
1083 PRINT_TYPE (double, d
);
1085 PRINT_TYPE (long double, ld
);
1089 PRINT_TYPE (char *, p
);
1096 const char *group
= NULL
;
1097 struct coff_comdat_info
*ci
;
1100 sec
= (asection
*) args
[arg_no
].p
;
1102 /* Invoking %pA with a null section pointer is an
1107 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
1108 && elf_next_in_group (sec
) != NULL
1109 && (sec
->flags
& SEC_GROUP
) == 0)
1110 group
= elf_group_name (sec
);
1111 else if (abfd
!= NULL
1112 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
1113 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
1117 result
= print (stream
, "%s[%s]", sec
->name
, group
);
1119 result
= print (stream
, "%s", sec
->name
);
1121 else if (*ptr
== 'B')
1126 abfd
= (bfd
*) args
[arg_no
].p
;
1128 /* Invoking %pB with a null bfd pointer is an
1131 else if (abfd
->my_archive
1132 && !bfd_is_thin_archive (abfd
->my_archive
))
1133 result
= print (stream
, "%s(%s)",
1134 bfd_get_filename (abfd
->my_archive
),
1135 bfd_get_filename (abfd
));
1137 result
= print (stream
, "%s", bfd_get_filename (abfd
));
1140 PRINT_TYPE (void *, p
);
1149 total_printed
+= result
;
1152 return total_printed
;
1155 /* First pass over FORMAT to gather ARGS. Returns number of args. */
1158 _bfd_doprnt_scan (const char *format
, va_list ap
, union _bfd_doprnt_args
*args
)
1160 const char *ptr
= format
;
1161 unsigned int arg_count
= 0;
1163 for (unsigned int i
= 0; i
< MAX_ARGS
; i
++)
1166 while (*ptr
!= '\0')
1170 ptr
= strchr (ptr
, '%');
1174 else if (ptr
[1] == '%')
1178 int wide_width
= 0, short_width
= 0;
1179 unsigned int arg_no
;
1184 /* Check for a positional parameter. */
1186 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1188 arg_no
= *ptr
- '1';
1192 /* Move past flags. */
1193 while (strchr ("-+ #0'I", *ptr
))
1198 unsigned int arg_index
;
1201 arg_index
= arg_count
;
1202 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1204 arg_index
= *ptr
- '1';
1207 if (arg_index
>= MAX_ARGS
)
1209 args
[arg_index
].type
= Int
;
1213 /* Handle explicit numeric value. */
1214 while (ISDIGIT (*ptr
))
1223 unsigned int arg_index
;
1226 arg_index
= arg_count
;
1227 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1229 arg_index
= *ptr
- '1';
1232 if (arg_index
>= MAX_ARGS
)
1234 args
[arg_index
].type
= Int
;
1238 /* Handle explicit numeric value. */
1239 while (ISDIGIT (*ptr
))
1242 while (strchr ("hlL", *ptr
))
1262 if ((int) arg_no
< 0)
1290 arg_type
= LongLong
;
1302 if (wide_width
== 0)
1305 arg_type
= LongDouble
;
1312 if (*ptr
== 'A' || *ptr
== 'B')
1320 if (arg_no
>= MAX_ARGS
)
1322 args
[arg_no
].type
= arg_type
;
1327 for (unsigned int i
= 0; i
< arg_count
; i
++)
1329 switch (args
[i
].type
)
1332 args
[i
].i
= va_arg (ap
, int);
1335 args
[i
].l
= va_arg (ap
, long);
1338 args
[i
].ll
= va_arg (ap
, long long);
1341 args
[i
].d
= va_arg (ap
, double);
1344 args
[i
].ld
= va_arg (ap
, long double);
1347 args
[i
].p
= va_arg (ap
, void *);
1357 /* The standard error handler that prints to stderr. */
1360 error_handler_fprintf (const char *fmt
, va_list ap
)
1362 union _bfd_doprnt_args args
[MAX_ARGS
];
1364 _bfd_doprnt_scan (fmt
, ap
, args
);
1366 /* PR 4992: Don't interrupt output being sent to stdout. */
1369 fprintf (stderr
, "%s: ", _bfd_get_error_program_name ());
1371 _bfd_doprnt ((print_func
) fprintf
, stderr
, fmt
, args
);
1373 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
1374 warning, so use the fputc function to avoid it. */
1375 fputc ('\n', stderr
);
1379 /* Control printing to a string buffer. */
1386 /* An fprintf like function that instead prints to a string buffer. */
1389 err_sprintf (void *stream
, const char *fmt
, ...)
1391 struct buf_stream
*s
= stream
;
1395 int total
= vsnprintf (s
->ptr
, s
->left
, fmt
, ap
);
1399 else if (total
> s
->left
)
1412 /* Communicate the bfd processed by bfd_check_format_matches to the
1413 error handling function error_handler_sprintf. */
1415 static bfd
*error_handler_bfd
;
1417 /* An error handler that prints to a string, then dups that string to
1418 a per-xvec cache. */
1421 error_handler_sprintf (const char *fmt
, va_list ap
)
1423 union _bfd_doprnt_args args
[MAX_ARGS
];
1424 char error_buf
[1024];
1425 struct buf_stream error_stream
;
1427 _bfd_doprnt_scan (fmt
, ap
, args
);
1429 error_stream
.ptr
= error_buf
;
1430 error_stream
.left
= sizeof (error_buf
);
1431 _bfd_doprnt (err_sprintf
, &error_stream
, fmt
, args
);
1433 size_t len
= error_stream
.ptr
- error_buf
;
1434 struct per_xvec_message
**warn
1435 = _bfd_per_xvec_warn (error_handler_bfd
->xvec
, len
+ 1);
1438 memcpy ((*warn
)->message
, error_buf
, len
);
1439 (*warn
)->message
[len
] = 0;
1443 /* This is a function pointer to the routine which should handle BFD
1444 error messages. It is called when a BFD routine encounters an
1445 error for which it wants to print a message. Going through a
1446 function pointer permits a program linked against BFD to intercept
1447 the messages and deal with them itself. */
1449 static bfd_error_handler_type _bfd_error_internal
= error_handler_fprintf
;
1456 void _bfd_error_handler (const char *fmt, ...) ATTRIBUTE_PRINTF_1;
1459 This is the default routine to handle BFD error messages.
1460 Like fprintf (stderr, ...), but also handles some extra format
1463 %pA section name from section. For group components, prints
1465 %pB file name from bfd. For archive components, prints
1468 Beware: Only supports a maximum of 9 format arguments.
1472 _bfd_error_handler (const char *fmt
, ...)
1477 _bfd_error_internal (fmt
, ap
);
1483 bfd_set_error_handler
1486 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
1489 Set the BFD error handler function. Returns the previous
1493 bfd_error_handler_type
1494 bfd_set_error_handler (bfd_error_handler_type pnew
)
1496 bfd_error_handler_type pold
;
1498 pold
= _bfd_error_internal
;
1499 _bfd_error_internal
= pnew
;
1505 _bfd_set_error_handler_caching
1508 bfd_error_handler_type _bfd_set_error_handler_caching (bfd *);
1511 Set the BFD error handler function to one that stores messages
1512 to the per_xvec_warn array. Returns the previous function.
1515 bfd_error_handler_type
1516 _bfd_set_error_handler_caching (bfd
*abfd
)
1518 error_handler_bfd
= abfd
;
1519 return bfd_set_error_handler (error_handler_sprintf
);
1524 bfd_set_error_program_name
1527 void bfd_set_error_program_name (const char *);
1530 Set the program name to use when printing a BFD error. This
1531 is printed before the error message followed by a colon and
1532 space. The string must not be changed after it is passed to
1537 bfd_set_error_program_name (const char *name
)
1539 _bfd_error_program_name
= name
;
1544 _bfd_get_error_program_name
1547 const char *_bfd_get_error_program_name (void);
1550 Get the program name used when printing a BFD error.
1554 _bfd_get_error_program_name (void)
1556 if (_bfd_error_program_name
!= NULL
)
1557 return _bfd_error_program_name
;
1565 If BFD finds an internal inconsistency, the bfd assert
1566 handler is called with information on the BFD version, BFD
1567 source file and line. If this happens, most programs linked
1568 against BFD are expected to want to exit with an error, or mark
1569 the current BFD operation as failed, so it is recommended to
1570 override the default handler, which just calls
1571 _bfd_error_handler and continues.
1575 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
1576 . const char *bfd_version,
1577 . const char *bfd_file,
1582 /* Note the use of bfd_ prefix on the parameter names above: we want to
1583 show which one is the message and which is the version by naming the
1584 parameters, but avoid polluting the program-using-bfd namespace as
1585 the typedef is visible in the exported headers that the program
1586 includes. Below, it's just for consistency. */
1589 _bfd_default_assert_handler (const char *bfd_formatmsg
,
1590 const char *bfd_version
,
1591 const char *bfd_file
,
1595 _bfd_error_handler (bfd_formatmsg
, bfd_version
, bfd_file
, bfd_line
);
1598 /* Similar to _bfd_error_handler, a program can decide to exit on an
1599 internal BFD error. We use a non-variadic type to simplify passing
1600 on parameters to other functions, e.g. _bfd_error_handler. */
1602 static bfd_assert_handler_type _bfd_assert_handler
= _bfd_default_assert_handler
;
1606 bfd_set_assert_handler
1609 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
1612 Set the BFD assert handler function. Returns the previous
1616 bfd_assert_handler_type
1617 bfd_set_assert_handler (bfd_assert_handler_type pnew
)
1619 bfd_assert_handler_type pold
;
1621 pold
= _bfd_assert_handler
;
1622 _bfd_assert_handler
= pnew
;
1628 Initialization, Miscellaneous, Error reporting, BFD front end
1634 unsigned int bfd_init (void);
1637 This routine must be called before any other BFD function to
1638 initialize magical internal data structures.
1639 Returns a magic number, which may be used to check
1640 that the bfd library is configured as expected by users.
1642 .{* Value returned by bfd_init. *}
1643 .#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
1650 bfd_error
= bfd_error_no_error
;
1652 input_error
= bfd_error_no_error
;
1653 _bfd_error_program_name
= NULL
;
1654 _bfd_error_internal
= error_handler_fprintf
;
1655 _bfd_assert_handler
= _bfd_default_assert_handler
;
1657 return BFD_INIT_MAGIC
;
1662 Miscellaneous, Memory Usage, Initialization, BFD front end
1668 Miscellaneous functions
1673 bfd_get_reloc_upper_bound
1676 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1679 Return the number of bytes required to store the
1680 relocation information associated with section @var{sect}
1681 attached to bfd @var{abfd}. If an error occurs, return -1.
1686 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
1688 if (abfd
->format
!= bfd_object
)
1690 bfd_set_error (bfd_error_invalid_operation
);
1694 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
1699 bfd_canonicalize_reloc
1702 long bfd_canonicalize_reloc
1703 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1706 Call the back end associated with the open BFD
1707 @var{abfd} and translate the external form of the relocation
1708 information attached to @var{sec} into the internal canonical
1709 form. Place the table into memory at @var{loc}, which has
1710 been preallocated, usually by a call to
1711 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
1714 The @var{syms} table is also needed for horrible internal magic
1719 bfd_canonicalize_reloc (bfd
*abfd
,
1724 if (abfd
->format
!= bfd_object
)
1726 bfd_set_error (bfd_error_invalid_operation
);
1730 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
1731 (abfd
, asect
, location
, symbols
));
1740 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1743 Set the relocation pointer and count within
1744 section @var{sec} to the values @var{rel} and @var{count}.
1745 The argument @var{abfd} is ignored.
1747 .#define bfd_set_reloc(abfd, asect, location, count) \
1748 . BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1756 bool bfd_set_file_flags (bfd *abfd, flagword flags);
1759 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1761 Possible errors are:
1762 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1763 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1764 o <<bfd_error_invalid_operation>> -
1765 The flag word contained a bit which was not applicable to the
1766 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1767 on a BFD format which does not support demand paging.
1772 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
1774 if (abfd
->format
!= bfd_object
)
1776 bfd_set_error (bfd_error_wrong_format
);
1780 if (bfd_read_p (abfd
))
1782 bfd_set_error (bfd_error_invalid_operation
);
1786 abfd
->flags
= flags
;
1787 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
1789 bfd_set_error (bfd_error_invalid_operation
);
1797 bfd_assert (const char *file
, int line
)
1799 /* xgettext:c-format */
1800 (*_bfd_assert_handler
) (_("BFD %s assertion fail %s:%d"),
1801 BFD_VERSION_STRING
, file
, line
);
1804 /* A more or less friendly abort message. In libbfd.h abort is
1805 defined to call this function. */
1808 _bfd_abort (const char *file
, int line
, const char *fn
)
1812 /* xgettext:c-format */
1813 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1814 BFD_VERSION_STRING
, file
, line
, fn
);
1817 /* xgettext:c-format */
1818 (_("BFD %s internal error, aborting at %s:%d\n"),
1819 BFD_VERSION_STRING
, file
, line
);
1820 _bfd_error_handler (_("Please report this bug.\n"));
1821 _exit (EXIT_FAILURE
);
1829 int bfd_get_arch_size (bfd *abfd);
1832 Returns the normalized architecture address size, in bits, as
1833 determined by the object file's format. By normalized, we mean
1834 either 32 or 64. For ELF, this information is included in the
1835 header. Use bfd_arch_bits_per_address for number of bits in
1836 the architecture address.
1838 Returns the arch size in bits if known, <<-1>> otherwise.
1842 bfd_get_arch_size (bfd
*abfd
)
1844 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1845 return get_elf_backend_data (abfd
)->s
->arch_size
;
1847 return bfd_arch_bits_per_address (abfd
) > 32 ? 64 : 32;
1852 bfd_get_sign_extend_vma
1855 int bfd_get_sign_extend_vma (bfd *abfd);
1858 Indicates if the target architecture "naturally" sign extends
1859 an address. Some architectures implicitly sign extend address
1860 values when they are converted to types larger than the size
1861 of an address. For instance, bfd_get_start_address() will
1862 return an address sign extended to fill a bfd_vma when this is
1865 Returns <<1>> if the target architecture is known to sign
1866 extend addresses, <<0>> if the target architecture is known to
1867 not sign extend addresses, and <<-1>> otherwise.
1871 bfd_get_sign_extend_vma (bfd
*abfd
)
1875 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1876 return get_elf_backend_data (abfd
)->sign_extend_vma
;
1878 name
= bfd_get_target (abfd
);
1880 /* Return a proper value for DJGPP & PE COFF.
1881 This function is required for DWARF2 support, but there is
1882 no place to store this information in the COFF back end.
1883 Should enough other COFF targets add support for DWARF2,
1884 a place will have to be found. Until then, this hack will do. */
1885 if (startswith (name
, "coff-go32")
1886 || strcmp (name
, "pe-i386") == 0
1887 || strcmp (name
, "pei-i386") == 0
1888 || strcmp (name
, "pe-x86-64") == 0
1889 || strcmp (name
, "pei-x86-64") == 0
1890 || strcmp (name
, "pe-aarch64-little") == 0
1891 || strcmp (name
, "pei-aarch64-little") == 0
1892 || strcmp (name
, "pe-arm-wince-little") == 0
1893 || strcmp (name
, "pei-arm-wince-little") == 0
1894 || strcmp (name
, "pei-loongarch64") == 0
1895 || strcmp (name
, "aixcoff-rs6000") == 0
1896 || strcmp (name
, "aix5coff64-rs6000") == 0)
1899 if (startswith (name
, "mach-o"))
1902 bfd_set_error (bfd_error_wrong_format
);
1908 bfd_set_start_address
1911 bool bfd_set_start_address (bfd *abfd, bfd_vma vma);
1914 Make @var{vma} the entry point of output BFD @var{abfd}.
1916 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1920 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
1922 abfd
->start_address
= vma
;
1931 unsigned int bfd_get_gp_size (bfd *abfd);
1934 Return the maximum size of objects to be optimized using the GP
1935 register under MIPS ECOFF. This is typically set by the <<-G>>
1936 argument to the compiler, assembler or linker.
1940 bfd_get_gp_size (bfd
*abfd
)
1942 if (abfd
->format
== bfd_object
)
1944 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1945 return ecoff_data (abfd
)->gp_size
;
1946 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1947 return elf_gp_size (abfd
);
1957 void bfd_set_gp_size (bfd *abfd, unsigned int i);
1960 Set the maximum size of objects to be optimized using the GP
1961 register under ECOFF or MIPS ELF. This is typically set by
1962 the <<-G>> argument to the compiler, assembler or linker.
1966 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
1968 /* Don't try to set GP size on an archive or core file! */
1969 if (abfd
->format
!= bfd_object
)
1972 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1973 ecoff_data (abfd
)->gp_size
= i
;
1974 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1975 elf_gp_size (abfd
) = i
;
1978 /* Get the GP value. This is an internal function used by some of the
1979 relocation special_function routines on targets which support a GP
1983 _bfd_get_gp_value (bfd
*abfd
)
1987 if (abfd
->format
!= bfd_object
)
1990 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
1991 return ecoff_data (abfd
)->gp
;
1992 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1993 return elf_gp (abfd
);
1998 /* Set the GP value. */
2001 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
2005 if (abfd
->format
!= bfd_object
)
2008 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
2009 ecoff_data (abfd
)->gp
= v
;
2010 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
2019 void bfd_set_gp_value (bfd *abfd, bfd_vma v);
2022 Allow external access to the fucntion to set the GP value.
2023 This is specifically added for gdb-compile support.
2027 bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
2029 _bfd_set_gp_value (abfd
, v
);
2037 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
2040 Convert, like <<strtoul>>, a numerical expression
2041 @var{string} into a <<bfd_vma>> integer, and return that integer.
2042 (Though without as many bells and whistles as <<strtoul>>.)
2043 The expression is assumed to be unsigned (i.e., positive).
2044 If given a @var{base}, it is used as the base for conversion.
2045 A base of 0 causes the function to interpret the string
2046 in hex if a leading "0x" or "0X" is found, otherwise
2047 in octal if a leading zero is found, otherwise in decimal.
2049 If the value would overflow, the maximum <<bfd_vma>> value is
2054 bfd_scan_vma (const char *string
, const char **end
, int base
)
2058 unsigned int cutlim
;
2061 /* Let the host do it if possible. */
2062 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
2063 return strtoul (string
, (char **) end
, base
);
2065 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
2066 return strtoull (string
, (char **) end
, base
);
2070 if (string
[0] == '0')
2072 if ((string
[1] == 'x') || (string
[1] == 'X'))
2079 if ((base
< 2) || (base
> 36))
2084 && (string
[1] == 'x' || string
[1] == 'X')
2085 && ISXDIGIT (string
[2]))
2090 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
2091 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
2099 if (ISDIGIT (digit
))
2100 digit
= digit
- '0';
2101 else if (ISALPHA (digit
))
2102 digit
= TOUPPER (digit
) - 'A' + 10;
2105 if (digit
>= (unsigned int) base
)
2107 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
2109 value
= value
* base
+ digit
;
2114 value
= ~ (bfd_vma
) 0;
2124 bfd_copy_private_header_data
2127 bool bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
2130 Copy private BFD header information from the BFD @var{ibfd} to the
2131 the BFD @var{obfd}. This copies information that may require
2132 sections to exist, but does not require symbol tables. Return
2133 <<true>> on success, <<false>> on error.
2134 Possible error returns are:
2136 o <<bfd_error_no_memory>> -
2137 Not enough memory exists to create private data for @var{obfd}.
2139 .#define bfd_copy_private_header_data(ibfd, obfd) \
2140 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
2147 bfd_copy_private_bfd_data
2150 bool bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
2153 Copy private BFD information from the BFD @var{ibfd} to the
2154 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
2155 Possible error returns are:
2157 o <<bfd_error_no_memory>> -
2158 Not enough memory exists to create private data for @var{obfd}.
2160 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
2161 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
2168 bfd_set_private_flags
2171 bool bfd_set_private_flags (bfd *abfd, flagword flags);
2174 Set private BFD flag information in the BFD @var{abfd}.
2175 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
2178 o <<bfd_error_no_memory>> -
2179 Not enough memory exists to create private data for @var{obfd}.
2181 .#define bfd_set_private_flags(abfd, flags) \
2182 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
2191 The following functions exist but have not yet been documented.
2193 .#define bfd_sizeof_headers(abfd, info) \
2194 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
2196 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2197 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2198 . (abfd, syms, sec, off, file, func, line, NULL))
2200 .#define bfd_find_nearest_line_with_alt(abfd, alt_filename, sec, syms, off, \
2201 . file, func, line, disc) \
2202 . BFD_SEND (abfd, _bfd_find_nearest_line_with_alt, \
2203 . (abfd, alt_filename, syms, sec, off, file, func, line, disc))
2205 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
2207 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2208 . (abfd, syms, sec, off, file, func, line, disc))
2210 .#define bfd_find_line(abfd, syms, sym, file, line) \
2211 . BFD_SEND (abfd, _bfd_find_line, \
2212 . (abfd, syms, sym, file, line))
2214 .#define bfd_find_inliner_info(abfd, file, func, line) \
2215 . BFD_SEND (abfd, _bfd_find_inliner_info, \
2216 . (abfd, file, func, line))
2218 .#define bfd_debug_info_start(abfd) \
2219 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2221 .#define bfd_debug_info_end(abfd) \
2222 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2224 .#define bfd_debug_info_accumulate(abfd, section) \
2225 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2227 .#define bfd_stat_arch_elt(abfd, stat) \
2228 . BFD_SEND (abfd->my_archive ? abfd->my_archive : abfd, \
2229 . _bfd_stat_arch_elt, (abfd, stat))
2231 .#define bfd_update_armap_timestamp(abfd) \
2232 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2234 .#define bfd_set_arch_mach(abfd, arch, mach)\
2235 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2237 .#define bfd_relax_section(abfd, section, link_info, again) \
2238 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2240 .#define bfd_gc_sections(abfd, link_info) \
2241 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
2243 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
2244 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
2246 .#define bfd_merge_sections(abfd, link_info) \
2247 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
2249 .#define bfd_is_group_section(abfd, sec) \
2250 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
2252 .#define bfd_group_name(abfd, sec) \
2253 . BFD_SEND (abfd, _bfd_group_name, (abfd, sec))
2255 .#define bfd_discard_group(abfd, sec) \
2256 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
2258 .#define bfd_link_hash_table_create(abfd) \
2259 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2261 .#define bfd_link_add_symbols(abfd, info) \
2262 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2264 .#define bfd_link_just_syms(abfd, sec, info) \
2265 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
2267 .#define bfd_final_link(abfd, info) \
2268 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2270 .#define bfd_free_cached_info(abfd) \
2271 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2273 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
2274 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2276 .#define bfd_print_private_bfd_data(abfd, file)\
2277 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2279 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2280 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2282 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
2283 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
2284 . dyncount, dynsyms, ret))
2286 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
2287 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2289 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2290 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2292 .extern bfd_byte *bfd_get_relocated_section_contents
2293 . (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
2294 . bool, asymbol **);
2300 bfd_get_relocated_section_contents (bfd
*abfd
,
2301 struct bfd_link_info
*link_info
,
2302 struct bfd_link_order
*link_order
,
2308 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
2309 bfd_byte
*, bool, asymbol
**);
2311 if (link_order
->type
== bfd_indirect_link_order
)
2313 abfd2
= link_order
->u
.indirect
.section
->owner
;
2320 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
2322 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
2325 /* Record information about an ELF program header. */
2328 bfd_record_phdr (bfd
*abfd
,
2333 bfd_vma at
, /* Bytes. */
2334 bool includes_filehdr
,
2335 bool includes_phdrs
,
2339 struct elf_segment_map
*m
, **pm
;
2341 unsigned int opb
= bfd_octets_per_byte (abfd
, NULL
);
2343 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2346 amt
= sizeof (struct elf_segment_map
);
2347 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
2348 m
= (struct elf_segment_map
*) bfd_zalloc (abfd
, amt
);
2354 m
->p_paddr
= at
* opb
;
2355 m
->p_flags_valid
= flags_valid
;
2356 m
->p_paddr_valid
= at_valid
;
2357 m
->includes_filehdr
= includes_filehdr
;
2358 m
->includes_phdrs
= includes_phdrs
;
2361 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
2363 for (pm
= &elf_seg_map (abfd
); *pm
!= NULL
; pm
= &(*pm
)->next
)
2371 /* Return true iff this target is 32-bit. */
2376 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2378 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
2379 return bed
->s
->elfclass
== ELFCLASS32
;
2382 /* For non-ELF targets, use architecture information. */
2383 return bfd_arch_bits_per_address (abfd
) <= 32;
2387 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
2388 target's address size. */
2391 bfd_sprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, char *buf
, bfd_vma value
)
2394 if (!is32bit (abfd
))
2396 sprintf (buf
, "%016" PRIx64
, (uint64_t) value
);
2400 sprintf (buf
, "%08lx", (unsigned long) value
& 0xffffffff);
2404 bfd_fprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, void *stream
, bfd_vma value
)
2407 if (!is32bit (abfd
))
2409 fprintf ((FILE *) stream
, "%016" PRIx64
, (uint64_t) value
);
2413 fprintf ((FILE *) stream
, "%08lx", (unsigned long) value
& 0xffffffff);
2421 bool bfd_alt_mach_code (bfd *abfd, int alternative);
2425 When more than one machine code number is available for the
2426 same machine type, this function can be used to switch between
2427 the preferred one (alternative == 0) and any others. Currently,
2428 only ELF supports this feature, with up to two alternate
2433 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
2435 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2439 switch (alternative
)
2442 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
2446 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
2452 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
2461 elf_elfheader (abfd
)->e_machine
= code
;
2471 bfd_emul_get_maxpagesize
2474 bfd_vma bfd_emul_get_maxpagesize (const char *);
2477 Returns the maximum page size, in bytes, as determined by
2482 bfd_emul_get_maxpagesize (const char *emul
)
2484 const bfd_target
*target
;
2486 target
= bfd_find_target (emul
, NULL
);
2488 && target
->flavour
== bfd_target_elf_flavour
)
2489 return xvec_get_elf_backend_data (target
)->maxpagesize
;
2496 bfd_emul_get_commonpagesize
2499 bfd_vma bfd_emul_get_commonpagesize (const char *);
2502 Returns the common page size, in bytes, as determined by
2507 bfd_emul_get_commonpagesize (const char *emul
)
2509 const bfd_target
*target
;
2511 target
= bfd_find_target (emul
, NULL
);
2513 && target
->flavour
== bfd_target_elf_flavour
)
2515 const struct elf_backend_data
*bed
;
2517 bed
= xvec_get_elf_backend_data (target
);
2518 return bed
->commonpagesize
;
2528 char *bfd_demangle (bfd *, const char *, int);
2531 Wrapper around cplus_demangle. Strips leading underscores and
2532 other such chars that would otherwise confuse the demangler.
2533 If passed a g++ v3 ABI mangled name, returns a buffer allocated
2534 with malloc holding the demangled name. Returns NULL otherwise
2535 and on memory alloc failure.
2539 bfd_demangle (bfd
*abfd
, const char *name
, int options
)
2542 const char *pre
, *suf
;
2546 skip_lead
= (abfd
!= NULL
2548 && bfd_get_symbol_leading_char (abfd
) == *name
);
2552 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
2553 or the MS PE format. These formats have a number of leading '.'s
2554 on at least some symbols, so we remove all dots to avoid
2555 confusing the demangler. */
2557 while (*name
== '.' || *name
== '$')
2559 pre_len
= name
- pre
;
2561 /* Strip off @plt and suchlike too. */
2563 suf
= strchr (name
, '@');
2566 alloc
= (char *) bfd_malloc (suf
- name
+ 1);
2569 memcpy (alloc
, name
, suf
- name
);
2570 alloc
[suf
- name
] = '\0';
2574 res
= cplus_demangle (name
, options
);
2582 size_t len
= strlen (pre
) + 1;
2583 alloc
= (char *) bfd_malloc (len
);
2586 memcpy (alloc
, pre
, len
);
2592 /* Put back any prefix or suffix. */
2593 if (pre_len
!= 0 || suf
!= NULL
)
2602 suf_len
= strlen (suf
) + 1;
2603 final
= (char *) bfd_malloc (pre_len
+ len
+ suf_len
);
2606 memcpy (final
, pre
, pre_len
);
2607 memcpy (final
+ pre_len
, res
, len
);
2608 memcpy (final
+ pre_len
+ len
, suf
, suf_len
);
2617 /* Get the linker information. */
2619 struct bfd_link_info
*
2620 _bfd_get_link_info (bfd
*abfd
)
2622 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2625 return elf_link_info (abfd
);