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.
38 .typedef enum bfd_format
40 . bfd_unknown = 0, {* File format is unknown. *}
41 . bfd_object, {* Linker/assembler/compiler output. *}
42 . bfd_archive, {* Object archive file. *}
43 . bfd_core, {* Core dump. *}
44 . bfd_type_end {* Marks the end; don't use it! *}
52 . write_direction = 2,
64 .enum bfd_plugin_format
66 . bfd_plugin_unknown = 0,
81 . {* The filename the application opened the BFD with. *}
82 . const char *filename;
84 . {* A pointer to the target jump table. *}
85 . const struct bfd_target *xvec;
87 . {* The IOSTREAM, and corresponding IO vector that provide access
88 . to the file backing the BFD. *}
90 . const struct bfd_iovec *iovec;
92 . {* The caching routines use these to maintain a
93 . least-recently-used list of BFDs. *}
94 . struct bfd *lru_prev, *lru_next;
96 . {* Track current file position (or current buffer offset for
97 . in-memory BFDs). When a file is closed by the caching routines,
98 . BFD retains state information on the file here. *}
101 . {* File modified time, if mtime_set is TRUE. *}
104 . {* A unique identifier of the BFD *}
107 . {* Format_specific flags. *}
110 . {* Values that may appear in the flags field of a BFD. These also
111 . appear in the object_flags field of the bfd_target structure, where
112 . they indicate the set of flags used by that backend (not all flags
113 . are meaningful for all object file formats) (FIXME: at the moment,
114 . the object_flags values have mostly just been copied from backend
115 . to another, and are not necessarily correct). *}
117 .#define BFD_NO_FLAGS 0x0
119 . {* BFD contains relocation entries. *}
120 .#define HAS_RELOC 0x1
122 . {* BFD is directly executable. *}
125 . {* BFD has line number information (basically used for F_LNNO in a
127 .#define HAS_LINENO 0x4
129 . {* BFD has debugging information. *}
130 .#define HAS_DEBUG 0x08
132 . {* BFD has symbols. *}
133 .#define HAS_SYMS 0x10
135 . {* BFD has local symbols (basically used for F_LSYMS in a COFF
137 .#define HAS_LOCALS 0x20
139 . {* BFD is a dynamic object. *}
140 .#define DYNAMIC 0x40
142 . {* Text section is write protected (if D_PAGED is not set, this is
143 . like an a.out NMAGIC file) (the linker sets this by default, but
144 . clears it for -r or -N). *}
145 .#define WP_TEXT 0x80
147 . {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
148 . linker sets this by default, but clears it for -r or -n or -N). *}
149 .#define D_PAGED 0x100
151 . {* BFD is relaxable (this means that bfd_relax_section may be able to
152 . do something) (sometimes bfd_relax_section can do something even if
153 . this is not set). *}
154 .#define BFD_IS_RELAXABLE 0x200
156 . {* This may be set before writing out a BFD to request using a
157 . traditional format. For example, this is used to request that when
158 . writing out an a.out object the symbols not be hashed to eliminate
160 .#define BFD_TRADITIONAL_FORMAT 0x400
162 . {* This flag indicates that the BFD contents are actually cached
163 . in memory. If this is set, iostream points to a bfd_in_memory
165 .#define BFD_IN_MEMORY 0x800
167 . {* This BFD has been created by the linker and doesn't correspond
168 . to any input file. *}
169 .#define BFD_LINKER_CREATED 0x1000
171 . {* This may be set before writing out a BFD to request that it
172 . be written using values for UIDs, GIDs, timestamps, etc. that
173 . will be consistent from run to run. *}
174 .#define BFD_DETERMINISTIC_OUTPUT 0x2000
176 . {* Compress sections in this BFD. *}
177 .#define BFD_COMPRESS 0x4000
179 . {* Decompress sections in this BFD. *}
180 .#define BFD_DECOMPRESS 0x8000
182 . {* BFD is a dummy, for plugins. *}
183 .#define BFD_PLUGIN 0x10000
185 . {* Compress sections in this BFD with SHF_COMPRESSED from gABI. *}
186 .#define BFD_COMPRESS_GABI 0x20000
188 . {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
190 .#define BFD_CONVERT_ELF_COMMON 0x40000
192 . {* Use the ELF STT_COMMON type in this BFD. *}
193 .#define BFD_USE_ELF_STT_COMMON 0x80000
195 . {* Put pathnames into archives (non-POSIX). *}
196 .#define BFD_ARCHIVE_FULL_PATH 0x100000
198 .#define BFD_CLOSED_BY_CACHE 0x200000
200 . {* Compress sections in this BFD with SHF_COMPRESSED zstd. *}
201 .#define BFD_COMPRESS_ZSTD 0x400000
203 . {* Don't generate ELF section header. *}
204 .#define BFD_NO_SECTION_HEADER 0x800000
206 . {* Flags bits which are for BFD use only. *}
207 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
208 . (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
209 . | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
210 . | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON \
211 . | BFD_NO_SECTION_HEADER)
213 . {* The format which belongs to the BFD. (object, core, etc.) *}
214 . ENUM_BITFIELD (bfd_format) format : 3;
216 . {* The direction with which the BFD was opened. *}
217 . ENUM_BITFIELD (bfd_direction) direction : 2;
219 . {* POSIX.1-2017 (IEEE Std 1003.1) says of fopen : "When a file is
220 . opened with update mode ('+' as the second or third character in
221 . the mode argument), both input and output may be performed on
222 . the associated stream. However, the application shall ensure
223 . that output is not directly followed by input without an
224 . intervening call to fflush() or to a file positioning function
225 . (fseek(), fsetpos(), or rewind()), and input is not directly
226 . followed by output without an intervening call to a file
227 . positioning function, unless the input operation encounters
229 . This field tracks the last IO operation, so that bfd can insert
230 . a seek when IO direction changes. *}
231 . ENUM_BITFIELD (bfd_last_io) last_io : 2;
233 . {* Is the file descriptor being cached? That is, can it be closed as
234 . needed, and re-opened when accessed later? *}
235 . unsigned int cacheable : 1;
237 . {* Marks whether there was a default target specified when the
238 . BFD was opened. This is used to select which matching algorithm
239 . to use to choose the back end. *}
240 . unsigned int target_defaulted : 1;
242 . {* ... and here: (``once'' means at least once). *}
243 . unsigned int opened_once : 1;
245 . {* Set if we have a locally maintained mtime value, rather than
246 . getting it from the file each time. *}
247 . unsigned int mtime_set : 1;
249 . {* Flag set if symbols from this BFD should not be exported. *}
250 . unsigned int no_export : 1;
252 . {* Remember when output has begun, to stop strange things
254 . unsigned int output_has_begun : 1;
256 . {* Have archive map. *}
257 . unsigned int has_armap : 1;
259 . {* Set if this is a thin archive. *}
260 . unsigned int is_thin_archive : 1;
262 . {* Set if this archive should not cache element positions. *}
263 . unsigned int no_element_cache : 1;
265 . {* Set if only required symbols should be added in the link hash table for
266 . this object. Used by VMS linkers. *}
267 . unsigned int selective_search : 1;
269 . {* Set if this is the linker output BFD. *}
270 . unsigned int is_linker_output : 1;
272 . {* Set if this is the linker input BFD. *}
273 . unsigned int is_linker_input : 1;
275 . {* If this is an input for a compiler plug-in library. *}
276 . ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
278 . {* Set if this is a plugin output file. *}
279 . unsigned int lto_output : 1;
281 . {* Set if this is a slim LTO object not loaded with a compiler plugin. *}
282 . unsigned int lto_slim_object : 1;
284 . {* Do not attempt to modify this file. Set when detecting errors
285 . that BFD is not prepared to handle for objcopy/strip. *}
286 . unsigned int read_only : 1;
288 . {* Set to dummy BFD created when claimed by a compiler plug-in
290 . bfd *plugin_dummy_bfd;
292 . {* The offset of this bfd in the file, typically 0 if it is not
293 . contained in an archive. *}
296 . {* The origin in the archive of the proxy entry. This will
297 . normally be the same as origin, except for thin archives,
298 . when it will contain the current offset of the proxy in the
299 . thin archive rather than the offset of the bfd in its actual
301 . ufile_ptr proxy_origin;
303 . {* A hash table for section names. *}
304 . struct bfd_hash_table section_htab;
306 . {* Pointer to linked list of sections. *}
307 . struct bfd_section *sections;
309 . {* The last section on the section list. *}
310 . struct bfd_section *section_last;
312 . {* The number of sections. *}
313 . unsigned int section_count;
315 . {* The archive plugin file descriptor. *}
316 . int archive_plugin_fd;
318 . {* The number of opens on the archive plugin file descriptor. *}
319 . unsigned int archive_plugin_fd_open_count;
321 . {* A field used by _bfd_generic_link_add_archive_symbols. This will
322 . be used only for archive elements. *}
325 . {* The total size of memory from bfd_alloc. *}
326 . bfd_size_type alloc_size;
328 . {* Stuff only useful for object files:
329 . The start address. *}
330 . bfd_vma start_address;
332 . {* Symbol table for output BFD (with symcount entries).
333 . Also used by the linker to cache input BFD symbols. *}
334 . struct bfd_symbol **outsymbols;
336 . {* Used for input and output. *}
337 . unsigned int symcount;
339 . {* Used for slurped dynamic symbol tables. *}
340 . unsigned int dynsymcount;
342 . {* Pointer to structure which contains architecture information. *}
343 . const struct bfd_arch_info *arch_info;
345 . {* Cached length of file for bfd_get_size. 0 until bfd_get_size is
346 . called, 1 if stat returns an error or the file size is too large to
347 . return in ufile_ptr. Both 0 and 1 should be treated as "unknown". *}
350 . {* Stuff only useful for archives. *}
352 . struct bfd *my_archive; {* The containing archive BFD. *}
353 . struct bfd *archive_next; {* The next BFD in the archive. *}
354 . struct bfd *archive_head; {* The first BFD in the archive. *}
355 . struct bfd *nested_archives; {* List of nested archive in a flattened
359 . {* For input BFDs, a chain of BFDs involved in a link. *}
361 . {* For output BFD, the linker hash table. *}
362 . struct bfd_link_hash_table *hash;
365 . {* Used by the back end to hold private data. *}
368 . struct aout_data_struct *aout_data;
369 . struct artdata *aout_ar_data;
370 . struct coff_tdata *coff_obj_data;
371 . struct pe_tdata *pe_obj_data;
372 . struct xcoff_tdata *xcoff_obj_data;
373 . struct ecoff_tdata *ecoff_obj_data;
374 . struct srec_data_struct *srec_data;
375 . struct verilog_data_struct *verilog_data;
376 . struct ihex_data_struct *ihex_data;
377 . struct tekhex_data_struct *tekhex_data;
378 . struct elf_obj_tdata *elf_obj_data;
379 . struct mmo_data_struct *mmo_data;
380 . struct trad_core_struct *trad_core_data;
381 . struct som_data_struct *som_data;
382 . struct hpux_core_struct *hpux_core_data;
383 . struct hppabsd_core_struct *hppabsd_core_data;
384 . struct sgi_core_struct *sgi_core_data;
385 . struct lynx_core_struct *lynx_core_data;
386 . struct osf_core_struct *osf_core_data;
387 . struct cisco_core_struct *cisco_core_data;
388 . struct netbsd_core_struct *netbsd_core_data;
389 . struct mach_o_data_struct *mach_o_data;
390 . struct mach_o_fat_data_struct *mach_o_fat_data;
391 . struct plugin_data_struct *plugin_data;
392 . struct bfd_pef_data_struct *pef_data;
393 . struct bfd_pef_xlib_data_struct *pef_xlib_data;
394 . struct bfd_sym_data_struct *sym_data;
399 . {* Used by the application to hold private data. *}
402 . {* Where all the allocated stuff under this BFD goes. This is a
403 . struct objalloc *, but we use void * to avoid requiring the inclusion
407 . {* For input BFDs, the build ID, if the object has one. *}
408 . const struct bfd_build_id *build_id;
413 .static inline const char *
414 .bfd_get_filename (const bfd *abfd)
416 . return abfd->filename;
420 .bfd_get_cacheable (const bfd *abfd)
422 . return abfd->cacheable;
425 .static inline enum bfd_format
426 .bfd_get_format (const bfd *abfd)
428 . return abfd->format;
431 .static inline flagword
432 .bfd_get_file_flags (const bfd *abfd)
434 . return abfd->flags;
437 .static inline bfd_vma
438 .bfd_get_start_address (const bfd *abfd)
440 . return abfd->start_address;
443 .static inline unsigned int
444 .bfd_get_symcount (const bfd *abfd)
446 . return abfd->symcount;
449 .static inline unsigned int
450 .bfd_get_dynamic_symcount (const bfd *abfd)
452 . return abfd->dynsymcount;
455 .static inline struct bfd_symbol **
456 .bfd_get_outsymbols (const bfd *abfd)
458 . return abfd->outsymbols;
461 .static inline unsigned int
462 .bfd_count_sections (const bfd *abfd)
464 . return abfd->section_count;
468 .bfd_has_map (const bfd *abfd)
470 . return abfd->has_armap;
474 .bfd_is_thin_archive (const bfd *abfd)
476 . return abfd->is_thin_archive;
479 .static inline void *
480 .bfd_usrdata (const bfd *abfd)
482 . return abfd->usrdata;
485 .{* See note beside bfd_set_section_userdata. *}
487 .bfd_set_cacheable (bfd * abfd, bool val)
489 . abfd->cacheable = val;
494 .bfd_set_thin_archive (bfd *abfd, bool val)
496 . abfd->is_thin_archive = val;
500 .bfd_set_usrdata (bfd *abfd, void *val)
502 . abfd->usrdata = val;
505 .static inline asection *
506 .bfd_asymbol_section (const asymbol *sy)
508 . return sy->section;
511 .static inline bfd_vma
512 .bfd_asymbol_value (const asymbol *sy)
514 . return sy->section->vma + sy->value;
517 .static inline const char *
518 .bfd_asymbol_name (const asymbol *sy)
523 .static inline struct bfd *
524 .bfd_asymbol_bfd (const asymbol *sy)
526 . return sy->the_bfd;
530 .bfd_set_asymbol_name (asymbol *sy, const char *name)
535 .{* For input sections return the original size on disk of the
536 . section. For output sections return the current size. *}
537 .static inline bfd_size_type
538 .bfd_get_section_limit_octets (const bfd *abfd, const asection *sec)
540 . if (abfd->direction != write_direction && sec->rawsize != 0)
541 . return sec->rawsize;
545 .{* Find the address one past the end of SEC. *}
546 .static inline bfd_size_type
547 .bfd_get_section_limit (const bfd *abfd, const asection *sec)
549 . return (bfd_get_section_limit_octets (abfd, sec)
550 . / bfd_octets_per_byte (abfd, sec));
553 .{* For input sections return the larger of the current size and the
554 . original size on disk of the section. For output sections return
555 . the current size. *}
556 .static inline bfd_size_type
557 .bfd_get_section_alloc_size (const bfd *abfd, const asection *sec)
559 . if (abfd->direction != write_direction && sec->rawsize > sec->size)
560 . return sec->rawsize;
564 .{* Functions to handle insertion and deletion of a bfd's sections. These
565 . only handle the list pointers, ie. do not adjust section_count,
566 . target_index etc. *}
568 .bfd_section_list_remove (bfd *abfd, asection *s)
570 . asection *next = s->next;
571 . asection *prev = s->prev;
575 . abfd->sections = next;
579 . abfd->section_last = prev;
583 .bfd_section_list_append (bfd *abfd, asection *s)
586 . if (abfd->section_last)
588 . s->prev = abfd->section_last;
589 . abfd->section_last->next = s;
594 . abfd->sections = s;
596 . abfd->section_last = s;
600 .bfd_section_list_prepend (bfd *abfd, asection *s)
603 . if (abfd->sections)
605 . s->next = abfd->sections;
606 . abfd->sections->prev = s;
611 . abfd->section_last = s;
613 . abfd->sections = s;
617 .bfd_section_list_insert_after (bfd *abfd, asection *a, asection *s)
619 . asection *next = a->next;
626 . abfd->section_last = s;
630 .bfd_section_list_insert_before (bfd *abfd, asection *b, asection *s)
632 . asection *prev = b->prev;
639 . abfd->sections = s;
643 .bfd_section_removed_from_list (const bfd *abfd, const asection *s)
645 . return s->next ? s->next->prev != s : abfd->section_last != s;
654 #include "libiberty.h"
655 #include "demangle.h"
656 #include "safe-ctype.h"
659 #include "coff/internal.h"
660 #include "coff/sym.h"
662 #include "libecoff.h"
667 #define EXIT_FAILURE 1
671 /* provide storage for subsystem, stack and heap data which may have been
672 passed in on the command line. Ld puts this data into a bfd_link_info
673 struct which ultimately gets passed in to the bfd. When it arrives, copy
674 it to the following struct so that the data will be available in coffcode.h
675 where it is needed. The typedef's used are defined in bfd.h */
679 Error reporting, Initialization, typedef bfd, BFD front end
684 Most BFD functions return nonzero on success (check their
685 individual documentation for precise semantics). On an error,
686 they call <<bfd_set_error>> to set an error condition that callers
687 can check by calling <<bfd_get_error>>.
688 If that returns <<bfd_error_system_call>>, then check
691 The easiest way to report a BFD error to the user is to
695 Type <<bfd_error_type>>
697 The values returned by <<bfd_get_error>> are defined by the
698 enumerated type <<bfd_error_type>>.
701 .typedef enum bfd_error
703 . bfd_error_no_error = 0,
704 . bfd_error_system_call,
705 . bfd_error_invalid_target,
706 . bfd_error_wrong_format,
707 . bfd_error_wrong_object_format,
708 . bfd_error_invalid_operation,
709 . bfd_error_no_memory,
710 . bfd_error_no_symbols,
711 . bfd_error_no_armap,
712 . bfd_error_no_more_archived_files,
713 . bfd_error_malformed_archive,
714 . bfd_error_missing_dso,
715 . bfd_error_file_not_recognized,
716 . bfd_error_file_ambiguously_recognized,
717 . bfd_error_no_contents,
718 . bfd_error_nonrepresentable_section,
719 . bfd_error_no_debug_section,
720 . bfd_error_bad_value,
721 . bfd_error_file_truncated,
722 . bfd_error_file_too_big,
724 . bfd_error_on_input,
725 . bfd_error_invalid_error_code
730 .{* A buffer that is freed on bfd_close. *}
731 .extern char *_bfd_error_buf;
735 static bfd_error_type bfd_error
;
736 static bfd_error_type input_error
;
737 static bfd
*input_bfd
;
738 char *_bfd_error_buf
;
740 const char *const bfd_errmsgs
[] =
743 N_("system call error"),
744 N_("invalid bfd target"),
745 N_("file in wrong format"),
746 N_("archive object file in wrong format"),
747 N_("invalid operation"),
748 N_("memory exhausted"),
750 N_("archive has no index; run ranlib to add one"),
751 N_("no more archived files"),
752 N_("malformed archive"),
753 N_("DSO missing from command line"),
754 N_("file format not recognized"),
755 N_("file format is ambiguous"),
756 N_("section has no contents"),
757 N_("nonrepresentable section on output"),
758 N_("symbol needs debug section which does not exist"),
760 N_("file truncated"),
762 N_("sorry, cannot handle this file"),
763 N_("error reading %s: %s"),
764 N_("#<invalid error code>")
772 bfd_error_type bfd_get_error (void);
775 Return the current BFD error condition.
789 void bfd_set_error (bfd_error_type error_tag);
792 Set the BFD error condition to be @var{error_tag}.
794 @var{error_tag} must not be bfd_error_on_input. Use
795 bfd_set_input_error for input errors instead.
799 bfd_set_error (bfd_error_type error_tag
)
801 bfd_error
= error_tag
;
802 if (bfd_error
>= bfd_error_on_input
)
811 void bfd_set_input_error (bfd *input, bfd_error_type error_tag);
815 Set the BFD error condition to be bfd_error_on_input.
816 @var{input} is the input bfd where the error occurred, and
817 @var{error_tag} the bfd_error_type error.
821 bfd_set_input_error (bfd
*input
, bfd_error_type error_tag
)
823 /* This is an error that occurred during bfd_close when writing an
824 archive, but on one of the input files. */
825 bfd_error
= bfd_error_on_input
;
826 free (_bfd_error_buf
);
827 _bfd_error_buf
= NULL
;
829 input_error
= error_tag
;
830 if (input_error
>= bfd_error_on_input
)
839 const char *bfd_errmsg (bfd_error_type error_tag);
842 Return a string describing the error @var{error_tag}, or
843 the system error if @var{error_tag} is <<bfd_error_system_call>>.
847 bfd_errmsg (bfd_error_type error_tag
)
852 if (error_tag
== bfd_error_on_input
)
854 const char *msg
= bfd_errmsg (input_error
);
855 char *ret
= bfd_asprintf (_(bfd_errmsgs
[error_tag
]),
856 bfd_get_filename (input_bfd
), msg
);
860 /* Ick, what to do on out of memory? */
864 if (error_tag
== bfd_error_system_call
)
865 return xstrerror (errno
);
867 if (error_tag
> bfd_error_invalid_error_code
)
868 error_tag
= bfd_error_invalid_error_code
; /* sanity check */
870 return _(bfd_errmsgs
[error_tag
]);
878 void bfd_perror (const char *message);
881 Print to the standard error stream a string describing the
882 last BFD error that occurred, or the last system error if
883 the last BFD error was a system call failure. If @var{message}
884 is non-NULL and non-empty, the error string printed is preceded
885 by @var{message}, a colon, and a space. It is followed by a newline.
889 bfd_perror (const char *message
)
892 if (message
== NULL
|| *message
== '\0')
893 fprintf (stderr
, "%s\n", bfd_errmsg (bfd_get_error ()));
895 fprintf (stderr
, "%s: %s\n", message
, bfd_errmsg (bfd_get_error ()));
904 char *bfd_asprintf (const char *fmt, ...);
907 Primarily for error reporting, this function is like
908 libiberty's xasprintf except that it can return NULL on no
909 memory and the returned string should not be freed. Uses a
910 single malloc'd buffer managed by libbfd, _bfd_error_buf.
911 Be aware that a call to this function frees the result of any
912 previous call. bfd_errmsg (bfd_error_on_input) also calls
917 bfd_asprintf (const char *fmt
, ...)
919 free (_bfd_error_buf
);
920 _bfd_error_buf
= NULL
;
923 int count
= vasprintf (&_bfd_error_buf
, fmt
, ap
);
927 bfd_set_error (bfd_error_no_memory
);
928 _bfd_error_buf
= NULL
;
930 return _bfd_error_buf
;
937 Some BFD functions want to print messages describing the
938 problem. They call a BFD error handler function. This
939 function may be overridden by the program.
941 The BFD error handler acts like vprintf.
944 .typedef void (*bfd_error_handler_type) (const char *, va_list);
948 /* The program name used when printing BFD error messages. */
950 static const char *_bfd_error_program_name
;
952 /* Support for positional parameters. */
954 union _bfd_doprnt_args
974 /* Maximum number of _bfd_error_handler args. Don't increase this
975 without changing the code handling positional parameters. */
978 /* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a
979 little and extended to handle '%pA', '%pB' and positional parameters. */
981 #define PRINT_TYPE(TYPE, FIELD) \
984 TYPE value = (TYPE) args[arg_no].FIELD; \
985 result = print (stream, specifier, value); \
988 typedef int (*print_func
) (void *, const char *, ...);
991 _bfd_doprnt (print_func print
, void *stream
, const char *format
,
992 union _bfd_doprnt_args
*args
)
994 const char *ptr
= format
;
996 int total_printed
= 0;
997 unsigned int arg_count
= 0;
1005 /* While we have regular characters, print them. */
1006 char *end
= strchr (ptr
, '%');
1008 result
= print (stream
, "%.*s", (int) (end
- ptr
), ptr
);
1010 result
= print (stream
, "%s", ptr
);
1013 else if (ptr
[1] == '%')
1015 fputc ('%', stream
);
1021 /* We have a format specifier! */
1022 char *sptr
= specifier
;
1023 int wide_width
= 0, short_width
= 0;
1024 unsigned int arg_no
;
1026 /* Copy the % and move forward. */
1029 /* Check for a positional parameter. */
1031 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1033 arg_no
= *ptr
- '1';
1037 /* Move past flags. */
1038 while (strchr ("-+ #0'I", *ptr
))
1044 unsigned int arg_index
;
1047 arg_index
= arg_count
;
1048 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1050 arg_index
= *ptr
- '1';
1053 value
= abs (args
[arg_index
].i
);
1055 sptr
+= sprintf (sptr
, "%d", value
);
1058 /* Handle explicit numeric value. */
1059 while (ISDIGIT (*ptr
))
1065 /* Copy and go past the period. */
1070 unsigned int arg_index
;
1073 arg_index
= arg_count
;
1074 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1076 arg_index
= *ptr
- '1';
1079 value
= abs (args
[arg_index
].i
);
1081 sptr
+= sprintf (sptr
, "%d", value
);
1084 /* Handle explicit numeric value. */
1085 while (ISDIGIT (*ptr
))
1088 while (strchr ("hlL", *ptr
))
1107 /* Copy the type specifier, and NULL terminate. */
1110 if ((int) arg_no
< 0)
1123 /* Short values are promoted to int, so just copy it
1124 as an int and trust the C library printf to cast it
1125 to the right width. */
1127 PRINT_TYPE (int, i
);
1133 PRINT_TYPE (int, i
);
1136 PRINT_TYPE (long, l
);
1140 #if defined (__MSVCRT__)
1147 PRINT_TYPE (long long, ll
);
1159 if (wide_width
== 0)
1160 PRINT_TYPE (double, d
);
1162 PRINT_TYPE (long double, ld
);
1166 PRINT_TYPE (char *, p
);
1173 const char *group
= NULL
;
1174 struct coff_comdat_info
*ci
;
1177 sec
= (asection
*) args
[arg_no
].p
;
1179 /* Invoking %pA with a null section pointer is an
1184 && bfd_get_flavour (abfd
) == bfd_target_elf_flavour
1185 && elf_next_in_group (sec
) != NULL
1186 && (sec
->flags
& SEC_GROUP
) == 0)
1187 group
= elf_group_name (sec
);
1188 else if (abfd
!= NULL
1189 && bfd_get_flavour (abfd
) == bfd_target_coff_flavour
1190 && (ci
= bfd_coff_get_comdat_section (sec
->owner
,
1194 result
= print (stream
, "%s[%s]", sec
->name
, group
);
1196 result
= print (stream
, "%s", sec
->name
);
1198 else if (*ptr
== 'B')
1203 abfd
= (bfd
*) args
[arg_no
].p
;
1205 /* Invoking %pB with a null bfd pointer is an
1208 else if (abfd
->my_archive
1209 && !bfd_is_thin_archive (abfd
->my_archive
))
1210 result
= print (stream
, "%s(%s)",
1211 bfd_get_filename (abfd
->my_archive
),
1212 bfd_get_filename (abfd
));
1214 result
= print (stream
, "%s", bfd_get_filename (abfd
));
1217 PRINT_TYPE (void *, p
);
1226 total_printed
+= result
;
1229 return total_printed
;
1232 /* First pass over FORMAT to gather ARGS. Returns number of args. */
1235 _bfd_doprnt_scan (const char *format
, va_list ap
, union _bfd_doprnt_args
*args
)
1237 const char *ptr
= format
;
1238 unsigned int arg_count
= 0;
1240 for (unsigned int i
= 0; i
< MAX_ARGS
; i
++)
1243 while (*ptr
!= '\0')
1247 ptr
= strchr (ptr
, '%');
1251 else if (ptr
[1] == '%')
1255 int wide_width
= 0, short_width
= 0;
1256 unsigned int arg_no
;
1261 /* Check for a positional parameter. */
1263 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1265 arg_no
= *ptr
- '1';
1269 /* Move past flags. */
1270 while (strchr ("-+ #0'I", *ptr
))
1275 unsigned int arg_index
;
1278 arg_index
= arg_count
;
1279 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1281 arg_index
= *ptr
- '1';
1284 if (arg_index
>= MAX_ARGS
)
1286 args
[arg_index
].type
= Int
;
1290 /* Handle explicit numeric value. */
1291 while (ISDIGIT (*ptr
))
1300 unsigned int arg_index
;
1303 arg_index
= arg_count
;
1304 if (*ptr
!= '0' && ISDIGIT (*ptr
) && ptr
[1] == '$')
1306 arg_index
= *ptr
- '1';
1309 if (arg_index
>= MAX_ARGS
)
1311 args
[arg_index
].type
= Int
;
1315 /* Handle explicit numeric value. */
1316 while (ISDIGIT (*ptr
))
1319 while (strchr ("hlL", *ptr
))
1339 if ((int) arg_no
< 0)
1367 arg_type
= LongLong
;
1379 if (wide_width
== 0)
1382 arg_type
= LongDouble
;
1389 if (*ptr
== 'A' || *ptr
== 'B')
1397 if (arg_no
>= MAX_ARGS
)
1399 args
[arg_no
].type
= arg_type
;
1404 for (unsigned int i
= 0; i
< arg_count
; i
++)
1406 switch (args
[i
].type
)
1409 args
[i
].i
= va_arg (ap
, int);
1412 args
[i
].l
= va_arg (ap
, long);
1415 args
[i
].ll
= va_arg (ap
, long long);
1418 args
[i
].d
= va_arg (ap
, double);
1421 args
[i
].ld
= va_arg (ap
, long double);
1424 args
[i
].p
= va_arg (ap
, void *);
1434 /* The standard error handler that prints to stderr. */
1437 error_handler_fprintf (const char *fmt
, va_list ap
)
1439 union _bfd_doprnt_args args
[MAX_ARGS
];
1441 _bfd_doprnt_scan (fmt
, ap
, args
);
1443 /* PR 4992: Don't interrupt output being sent to stdout. */
1446 fprintf (stderr
, "%s: ", _bfd_get_error_program_name ());
1448 _bfd_doprnt ((print_func
) fprintf
, stderr
, fmt
, args
);
1450 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
1451 warning, so use the fputc function to avoid it. */
1452 fputc ('\n', stderr
);
1456 /* Control printing to a string buffer. */
1463 /* An fprintf like function that instead prints to a string buffer. */
1466 err_sprintf (void *stream
, const char *fmt
, ...)
1468 struct buf_stream
*s
= stream
;
1472 int total
= vsnprintf (s
->ptr
, s
->left
, fmt
, ap
);
1476 else if (total
> s
->left
)
1489 /* Communicate the bfd processed by bfd_check_format_matches to the
1490 error handling function error_handler_sprintf. */
1492 static bfd
*error_handler_bfd
;
1494 /* An error handler that prints to a string, then dups that string to
1495 a per-xvec cache. */
1498 error_handler_sprintf (const char *fmt
, va_list ap
)
1500 union _bfd_doprnt_args args
[MAX_ARGS
];
1501 char error_buf
[1024];
1502 struct buf_stream error_stream
;
1504 _bfd_doprnt_scan (fmt
, ap
, args
);
1506 error_stream
.ptr
= error_buf
;
1507 error_stream
.left
= sizeof (error_buf
);
1508 _bfd_doprnt (err_sprintf
, &error_stream
, fmt
, args
);
1510 size_t len
= error_stream
.ptr
- error_buf
;
1511 struct per_xvec_message
**warn
1512 = _bfd_per_xvec_warn (error_handler_bfd
->xvec
, len
+ 1);
1515 memcpy ((*warn
)->message
, error_buf
, len
);
1516 (*warn
)->message
[len
] = 0;
1520 /* This is a function pointer to the routine which should handle BFD
1521 error messages. It is called when a BFD routine encounters an
1522 error for which it wants to print a message. Going through a
1523 function pointer permits a program linked against BFD to intercept
1524 the messages and deal with them itself. */
1526 static bfd_error_handler_type _bfd_error_internal
= error_handler_fprintf
;
1533 void _bfd_error_handler (const char *fmt, ...) ATTRIBUTE_PRINTF_1;
1536 This is the default routine to handle BFD error messages.
1537 Like fprintf (stderr, ...), but also handles some extra format
1540 %pA section name from section. For group components, prints
1542 %pB file name from bfd. For archive components, prints
1545 Beware: Only supports a maximum of 9 format arguments.
1549 _bfd_error_handler (const char *fmt
, ...)
1554 _bfd_error_internal (fmt
, ap
);
1560 bfd_set_error_handler
1563 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
1566 Set the BFD error handler function. Returns the previous
1570 bfd_error_handler_type
1571 bfd_set_error_handler (bfd_error_handler_type pnew
)
1573 bfd_error_handler_type pold
;
1575 pold
= _bfd_error_internal
;
1576 _bfd_error_internal
= pnew
;
1582 _bfd_set_error_handler_caching
1585 bfd_error_handler_type _bfd_set_error_handler_caching (bfd *);
1588 Set the BFD error handler function to one that stores messages
1589 to the per_xvec_warn array. Returns the previous function.
1592 bfd_error_handler_type
1593 _bfd_set_error_handler_caching (bfd
*abfd
)
1595 error_handler_bfd
= abfd
;
1596 return bfd_set_error_handler (error_handler_sprintf
);
1601 bfd_set_error_program_name
1604 void bfd_set_error_program_name (const char *);
1607 Set the program name to use when printing a BFD error. This
1608 is printed before the error message followed by a colon and
1609 space. The string must not be changed after it is passed to
1614 bfd_set_error_program_name (const char *name
)
1616 _bfd_error_program_name
= name
;
1621 _bfd_get_error_program_name
1624 const char *_bfd_get_error_program_name (void);
1627 Get the program name used when printing a BFD error.
1631 _bfd_get_error_program_name (void)
1633 if (_bfd_error_program_name
!= NULL
)
1634 return _bfd_error_program_name
;
1642 If BFD finds an internal inconsistency, the bfd assert
1643 handler is called with information on the BFD version, BFD
1644 source file and line. If this happens, most programs linked
1645 against BFD are expected to want to exit with an error, or mark
1646 the current BFD operation as failed, so it is recommended to
1647 override the default handler, which just calls
1648 _bfd_error_handler and continues.
1651 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
1652 . const char *bfd_version,
1653 . const char *bfd_file,
1658 /* Note the use of bfd_ prefix on the parameter names above: we want to
1659 show which one is the message and which is the version by naming the
1660 parameters, but avoid polluting the program-using-bfd namespace as
1661 the typedef is visible in the exported headers that the program
1662 includes. Below, it's just for consistency. */
1665 _bfd_default_assert_handler (const char *bfd_formatmsg
,
1666 const char *bfd_version
,
1667 const char *bfd_file
,
1671 _bfd_error_handler (bfd_formatmsg
, bfd_version
, bfd_file
, bfd_line
);
1674 /* Similar to _bfd_error_handler, a program can decide to exit on an
1675 internal BFD error. We use a non-variadic type to simplify passing
1676 on parameters to other functions, e.g. _bfd_error_handler. */
1678 static bfd_assert_handler_type _bfd_assert_handler
= _bfd_default_assert_handler
;
1682 bfd_set_assert_handler
1685 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
1688 Set the BFD assert handler function. Returns the previous
1692 bfd_assert_handler_type
1693 bfd_set_assert_handler (bfd_assert_handler_type pnew
)
1695 bfd_assert_handler_type pold
;
1697 pold
= _bfd_assert_handler
;
1698 _bfd_assert_handler
= pnew
;
1704 Initialization, Miscellaneous, Error reporting, BFD front end
1710 unsigned int bfd_init (void);
1713 This routine must be called before any other BFD function to
1714 initialize magical internal data structures.
1715 Returns a magic number, which may be used to check
1716 that the bfd library is configured as expected by users.
1718 .{* Value returned by bfd_init. *}
1719 .#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
1726 bfd_error
= bfd_error_no_error
;
1728 free (_bfd_error_buf
);
1729 _bfd_error_buf
= NULL
;
1730 input_error
= bfd_error_no_error
;
1731 _bfd_error_program_name
= NULL
;
1732 _bfd_error_internal
= error_handler_fprintf
;
1733 _bfd_assert_handler
= _bfd_default_assert_handler
;
1735 return BFD_INIT_MAGIC
;
1740 Miscellaneous, Memory Usage, Initialization, BFD front end
1746 Miscellaneous functions
1751 bfd_get_reloc_upper_bound
1754 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1757 Return the number of bytes required to store the
1758 relocation information associated with section @var{sect}
1759 attached to bfd @var{abfd}. If an error occurs, return -1.
1764 bfd_get_reloc_upper_bound (bfd
*abfd
, sec_ptr asect
)
1766 if (abfd
->format
!= bfd_object
)
1768 bfd_set_error (bfd_error_invalid_operation
);
1772 return BFD_SEND (abfd
, _get_reloc_upper_bound
, (abfd
, asect
));
1777 bfd_canonicalize_reloc
1780 long bfd_canonicalize_reloc
1781 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1784 Call the back end associated with the open BFD
1785 @var{abfd} and translate the external form of the relocation
1786 information attached to @var{sec} into the internal canonical
1787 form. Place the table into memory at @var{loc}, which has
1788 been preallocated, usually by a call to
1789 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
1792 The @var{syms} table is also needed for horrible internal magic
1797 bfd_canonicalize_reloc (bfd
*abfd
,
1802 if (abfd
->format
!= bfd_object
)
1804 bfd_set_error (bfd_error_invalid_operation
);
1808 return BFD_SEND (abfd
, _bfd_canonicalize_reloc
,
1809 (abfd
, asect
, location
, symbols
));
1818 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1821 Set the relocation pointer and count within
1822 section @var{sec} to the values @var{rel} and @var{count}.
1823 The argument @var{abfd} is ignored.
1825 .#define bfd_set_reloc(abfd, asect, location, count) \
1826 . BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1834 bool bfd_set_file_flags (bfd *abfd, flagword flags);
1837 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1839 Possible errors are:
1840 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1841 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1842 o <<bfd_error_invalid_operation>> -
1843 The flag word contained a bit which was not applicable to the
1844 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1845 on a BFD format which does not support demand paging.
1850 bfd_set_file_flags (bfd
*abfd
, flagword flags
)
1852 if (abfd
->format
!= bfd_object
)
1854 bfd_set_error (bfd_error_wrong_format
);
1858 if (bfd_read_p (abfd
))
1860 bfd_set_error (bfd_error_invalid_operation
);
1864 abfd
->flags
= flags
;
1865 if ((flags
& bfd_applicable_file_flags (abfd
)) != flags
)
1867 bfd_set_error (bfd_error_invalid_operation
);
1875 bfd_assert (const char *file
, int line
)
1877 /* xgettext:c-format */
1878 (*_bfd_assert_handler
) (_("BFD %s assertion fail %s:%d"),
1879 BFD_VERSION_STRING
, file
, line
);
1882 /* A more or less friendly abort message. In libbfd.h abort is
1883 defined to call this function. */
1886 _bfd_abort (const char *file
, int line
, const char *fn
)
1890 /* xgettext:c-format */
1891 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1892 BFD_VERSION_STRING
, file
, line
, fn
);
1895 /* xgettext:c-format */
1896 (_("BFD %s internal error, aborting at %s:%d\n"),
1897 BFD_VERSION_STRING
, file
, line
);
1898 _bfd_error_handler (_("Please report this bug.\n"));
1899 _exit (EXIT_FAILURE
);
1907 int bfd_get_arch_size (bfd *abfd);
1910 Returns the normalized architecture address size, in bits, as
1911 determined by the object file's format. By normalized, we mean
1912 either 32 or 64. For ELF, this information is included in the
1913 header. Use bfd_arch_bits_per_address for number of bits in
1914 the architecture address.
1916 Returns the arch size in bits if known, <<-1>> otherwise.
1920 bfd_get_arch_size (bfd
*abfd
)
1922 if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
1923 return get_elf_backend_data (abfd
)->s
->arch_size
;
1925 return bfd_arch_bits_per_address (abfd
) > 32 ? 64 : 32;
1930 bfd_get_sign_extend_vma
1933 int bfd_get_sign_extend_vma (bfd *abfd);
1936 Indicates if the target architecture "naturally" sign extends
1937 an address. Some architectures implicitly sign extend address
1938 values when they are converted to types larger than the size
1939 of an address. For instance, bfd_get_start_address() will
1940 return an address sign extended to fill a bfd_vma when this is
1943 Returns <<1>> if the target architecture is known to sign
1944 extend addresses, <<0>> if the target architecture is known to
1945 not sign extend addresses, and <<-1>> otherwise.
1949 bfd_get_sign_extend_vma (bfd
*abfd
)
1953 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1954 return get_elf_backend_data (abfd
)->sign_extend_vma
;
1956 name
= bfd_get_target (abfd
);
1958 /* Return a proper value for DJGPP & PE COFF.
1959 This function is required for DWARF2 support, but there is
1960 no place to store this information in the COFF back end.
1961 Should enough other COFF targets add support for DWARF2,
1962 a place will have to be found. Until then, this hack will do. */
1963 if (startswith (name
, "coff-go32")
1964 || strcmp (name
, "pe-i386") == 0
1965 || strcmp (name
, "pei-i386") == 0
1966 || strcmp (name
, "pe-x86-64") == 0
1967 || strcmp (name
, "pei-x86-64") == 0
1968 || strcmp (name
, "pe-aarch64-little") == 0
1969 || strcmp (name
, "pei-aarch64-little") == 0
1970 || strcmp (name
, "pe-arm-wince-little") == 0
1971 || strcmp (name
, "pei-arm-wince-little") == 0
1972 || strcmp (name
, "pei-loongarch64") == 0
1973 || strcmp (name
, "aixcoff-rs6000") == 0
1974 || strcmp (name
, "aix5coff64-rs6000") == 0)
1977 if (startswith (name
, "mach-o"))
1980 bfd_set_error (bfd_error_wrong_format
);
1986 bfd_set_start_address
1989 bool bfd_set_start_address (bfd *abfd, bfd_vma vma);
1992 Make @var{vma} the entry point of output BFD @var{abfd}.
1994 Returns <<TRUE>> on success, <<FALSE>> otherwise.
1998 bfd_set_start_address (bfd
*abfd
, bfd_vma vma
)
2000 abfd
->start_address
= vma
;
2009 unsigned int bfd_get_gp_size (bfd *abfd);
2012 Return the maximum size of objects to be optimized using the GP
2013 register under MIPS ECOFF. This is typically set by the <<-G>>
2014 argument to the compiler, assembler or linker.
2018 bfd_get_gp_size (bfd
*abfd
)
2020 if (abfd
->format
== bfd_object
)
2022 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
2023 return ecoff_data (abfd
)->gp_size
;
2024 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
2025 return elf_gp_size (abfd
);
2035 void bfd_set_gp_size (bfd *abfd, unsigned int i);
2038 Set the maximum size of objects to be optimized using the GP
2039 register under ECOFF or MIPS ELF. This is typically set by
2040 the <<-G>> argument to the compiler, assembler or linker.
2044 bfd_set_gp_size (bfd
*abfd
, unsigned int i
)
2046 /* Don't try to set GP size on an archive or core file! */
2047 if (abfd
->format
!= bfd_object
)
2050 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
2051 ecoff_data (abfd
)->gp_size
= i
;
2052 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
2053 elf_gp_size (abfd
) = i
;
2056 /* Get the GP value. This is an internal function used by some of the
2057 relocation special_function routines on targets which support a GP
2061 _bfd_get_gp_value (bfd
*abfd
)
2065 if (abfd
->format
!= bfd_object
)
2068 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
2069 return ecoff_data (abfd
)->gp
;
2070 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
2071 return elf_gp (abfd
);
2076 /* Set the GP value. */
2079 _bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
2083 if (abfd
->format
!= bfd_object
)
2086 if (abfd
->xvec
->flavour
== bfd_target_ecoff_flavour
)
2087 ecoff_data (abfd
)->gp
= v
;
2088 else if (abfd
->xvec
->flavour
== bfd_target_elf_flavour
)
2097 void bfd_set_gp_value (bfd *abfd, bfd_vma v);
2100 Allow external access to the fucntion to set the GP value.
2101 This is specifically added for gdb-compile support.
2105 bfd_set_gp_value (bfd
*abfd
, bfd_vma v
)
2107 _bfd_set_gp_value (abfd
, v
);
2115 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
2118 Convert, like <<strtoul>>, a numerical expression
2119 @var{string} into a <<bfd_vma>> integer, and return that integer.
2120 (Though without as many bells and whistles as <<strtoul>>.)
2121 The expression is assumed to be unsigned (i.e., positive).
2122 If given a @var{base}, it is used as the base for conversion.
2123 A base of 0 causes the function to interpret the string
2124 in hex if a leading "0x" or "0X" is found, otherwise
2125 in octal if a leading zero is found, otherwise in decimal.
2127 If the value would overflow, the maximum <<bfd_vma>> value is
2132 bfd_scan_vma (const char *string
, const char **end
, int base
)
2136 unsigned int cutlim
;
2139 /* Let the host do it if possible. */
2140 if (sizeof (bfd_vma
) <= sizeof (unsigned long))
2141 return strtoul (string
, (char **) end
, base
);
2143 if (sizeof (bfd_vma
) <= sizeof (unsigned long long))
2144 return strtoull (string
, (char **) end
, base
);
2148 if (string
[0] == '0')
2150 if ((string
[1] == 'x') || (string
[1] == 'X'))
2157 if ((base
< 2) || (base
> 36))
2162 && (string
[1] == 'x' || string
[1] == 'X')
2163 && ISXDIGIT (string
[2]))
2168 cutoff
= (~ (bfd_vma
) 0) / (bfd_vma
) base
;
2169 cutlim
= (~ (bfd_vma
) 0) % (bfd_vma
) base
;
2177 if (ISDIGIT (digit
))
2178 digit
= digit
- '0';
2179 else if (ISALPHA (digit
))
2180 digit
= TOUPPER (digit
) - 'A' + 10;
2183 if (digit
>= (unsigned int) base
)
2185 if (value
> cutoff
|| (value
== cutoff
&& digit
> cutlim
))
2187 value
= value
* base
+ digit
;
2192 value
= ~ (bfd_vma
) 0;
2202 bfd_copy_private_header_data
2205 bool bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
2208 Copy private BFD header information from the BFD @var{ibfd} to the
2209 the BFD @var{obfd}. This copies information that may require
2210 sections to exist, but does not require symbol tables. Return
2211 <<true>> on success, <<false>> on error.
2212 Possible error returns are:
2214 o <<bfd_error_no_memory>> -
2215 Not enough memory exists to create private data for @var{obfd}.
2217 .#define bfd_copy_private_header_data(ibfd, obfd) \
2218 . BFD_SEND (obfd, _bfd_copy_private_header_data, \
2225 bfd_copy_private_bfd_data
2228 bool bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
2231 Copy private BFD information from the BFD @var{ibfd} to the
2232 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
2233 Possible error returns are:
2235 o <<bfd_error_no_memory>> -
2236 Not enough memory exists to create private data for @var{obfd}.
2238 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
2239 . BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
2246 bfd_set_private_flags
2249 bool bfd_set_private_flags (bfd *abfd, flagword flags);
2252 Set private BFD flag information in the BFD @var{abfd}.
2253 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
2256 o <<bfd_error_no_memory>> -
2257 Not enough memory exists to create private data for @var{obfd}.
2259 .#define bfd_set_private_flags(abfd, flags) \
2260 . BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
2269 The following functions exist but have not yet been documented.
2271 .#define bfd_sizeof_headers(abfd, info) \
2272 . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
2274 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2275 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2276 . (abfd, syms, sec, off, file, func, line, NULL))
2278 .#define bfd_find_nearest_line_with_alt(abfd, alt_filename, sec, syms, off, \
2279 . file, func, line, disc) \
2280 . BFD_SEND (abfd, _bfd_find_nearest_line_with_alt, \
2281 . (abfd, alt_filename, syms, sec, off, file, func, line, disc))
2283 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
2285 . BFD_SEND (abfd, _bfd_find_nearest_line, \
2286 . (abfd, syms, sec, off, file, func, line, disc))
2288 .#define bfd_find_line(abfd, syms, sym, file, line) \
2289 . BFD_SEND (abfd, _bfd_find_line, \
2290 . (abfd, syms, sym, file, line))
2292 .#define bfd_find_inliner_info(abfd, file, func, line) \
2293 . BFD_SEND (abfd, _bfd_find_inliner_info, \
2294 . (abfd, file, func, line))
2296 .#define bfd_debug_info_start(abfd) \
2297 . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2299 .#define bfd_debug_info_end(abfd) \
2300 . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2302 .#define bfd_debug_info_accumulate(abfd, section) \
2303 . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2305 .#define bfd_stat_arch_elt(abfd, stat) \
2306 . BFD_SEND (abfd->my_archive ? abfd->my_archive : abfd, \
2307 . _bfd_stat_arch_elt, (abfd, stat))
2309 .#define bfd_update_armap_timestamp(abfd) \
2310 . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2312 .#define bfd_set_arch_mach(abfd, arch, mach)\
2313 . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2315 .#define bfd_relax_section(abfd, section, link_info, again) \
2316 . BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2318 .#define bfd_gc_sections(abfd, link_info) \
2319 . BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
2321 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
2322 . BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
2324 .#define bfd_merge_sections(abfd, link_info) \
2325 . BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
2327 .#define bfd_is_group_section(abfd, sec) \
2328 . BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
2330 .#define bfd_group_name(abfd, sec) \
2331 . BFD_SEND (abfd, _bfd_group_name, (abfd, sec))
2333 .#define bfd_discard_group(abfd, sec) \
2334 . BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
2336 .#define bfd_link_hash_table_create(abfd) \
2337 . BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2339 .#define bfd_link_add_symbols(abfd, info) \
2340 . BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2342 .#define bfd_link_just_syms(abfd, sec, info) \
2343 . BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
2345 .#define bfd_final_link(abfd, info) \
2346 . BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2348 .#define bfd_free_cached_info(abfd) \
2349 . BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2351 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
2352 . BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2354 .#define bfd_print_private_bfd_data(abfd, file)\
2355 . BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2357 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2358 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2360 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
2361 . BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
2362 . dyncount, dynsyms, ret))
2364 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
2365 . BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2367 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2368 . BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2374 bfd_get_relocated_section_contents
2377 bfd_byte *bfd_get_relocated_section_contents
2378 (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
2382 Read and relocate the indirect link_order section, into DATA
2383 (if non-NULL) or to a malloc'd buffer. Return the buffer, or
2388 bfd_get_relocated_section_contents (bfd
*abfd
,
2389 struct bfd_link_info
*link_info
,
2390 struct bfd_link_order
*link_order
,
2396 bfd_byte
*(*fn
) (bfd
*, struct bfd_link_info
*, struct bfd_link_order
*,
2397 bfd_byte
*, bool, asymbol
**);
2399 if (link_order
->type
== bfd_indirect_link_order
)
2401 abfd2
= link_order
->u
.indirect
.section
->owner
;
2408 fn
= abfd2
->xvec
->_bfd_get_relocated_section_contents
;
2410 return (*fn
) (abfd
, link_info
, link_order
, data
, relocatable
, symbols
);
2418 bool bfd_record_phdr
2419 (bfd *, unsigned long, bool, flagword, bool, bfd_vma,
2420 bool, bool, unsigned int, struct bfd_section **);
2423 Record information about an ELF program header.
2427 bfd_record_phdr (bfd
*abfd
,
2432 bfd_vma at
, /* Bytes. */
2433 bool includes_filehdr
,
2434 bool includes_phdrs
,
2438 struct elf_segment_map
*m
, **pm
;
2440 unsigned int opb
= bfd_octets_per_byte (abfd
, NULL
);
2442 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2445 amt
= sizeof (struct elf_segment_map
);
2446 amt
+= ((bfd_size_type
) count
- 1) * sizeof (asection
*);
2447 m
= (struct elf_segment_map
*) bfd_zalloc (abfd
, amt
);
2453 m
->p_paddr
= at
* opb
;
2454 m
->p_flags_valid
= flags_valid
;
2455 m
->p_paddr_valid
= at_valid
;
2456 m
->includes_filehdr
= includes_filehdr
;
2457 m
->includes_phdrs
= includes_phdrs
;
2460 memcpy (m
->sections
, secs
, count
* sizeof (asection
*));
2462 for (pm
= &elf_seg_map (abfd
); *pm
!= NULL
; pm
= &(*pm
)->next
)
2470 /* Return true iff this target is 32-bit. */
2475 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2477 const struct elf_backend_data
*bed
= get_elf_backend_data (abfd
);
2478 return bed
->s
->elfclass
== ELFCLASS32
;
2481 /* For non-ELF targets, use architecture information. */
2482 return bfd_arch_bits_per_address (abfd
) <= 32;
2492 void bfd_sprintf_vma (bfd *, char *, bfd_vma);
2493 void bfd_fprintf_vma (bfd *, void *, bfd_vma);
2496 bfd_sprintf_vma and bfd_fprintf_vma display an address in the
2497 target's address size.
2500 .#define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd, stdout, x)
2505 bfd_sprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, char *buf
, bfd_vma value
)
2508 if (!is32bit (abfd
))
2510 sprintf (buf
, "%016" PRIx64
, (uint64_t) value
);
2514 sprintf (buf
, "%08lx", (unsigned long) value
& 0xffffffff);
2518 bfd_fprintf_vma (bfd
*abfd ATTRIBUTE_UNUSED
, void *stream
, bfd_vma value
)
2521 if (!is32bit (abfd
))
2523 fprintf ((FILE *) stream
, "%016" PRIx64
, (uint64_t) value
);
2527 fprintf ((FILE *) stream
, "%08lx", (unsigned long) value
& 0xffffffff);
2535 bool bfd_alt_mach_code (bfd *abfd, int alternative);
2539 When more than one machine code number is available for the
2540 same machine type, this function can be used to switch between
2541 the preferred one (alternative == 0) and any others. Currently,
2542 only ELF supports this feature, with up to two alternate
2547 bfd_alt_mach_code (bfd
*abfd
, int alternative
)
2549 if (bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
2553 switch (alternative
)
2556 code
= get_elf_backend_data (abfd
)->elf_machine_code
;
2560 code
= get_elf_backend_data (abfd
)->elf_machine_alt1
;
2566 code
= get_elf_backend_data (abfd
)->elf_machine_alt2
;
2575 elf_elfheader (abfd
)->e_machine
= code
;
2585 bfd_emul_get_maxpagesize
2588 bfd_vma bfd_emul_get_maxpagesize (const char *);
2591 Returns the maximum page size, in bytes, as determined by
2596 bfd_emul_get_maxpagesize (const char *emul
)
2598 const bfd_target
*target
;
2600 target
= bfd_find_target (emul
, NULL
);
2602 && target
->flavour
== bfd_target_elf_flavour
)
2603 return xvec_get_elf_backend_data (target
)->maxpagesize
;
2610 bfd_emul_get_commonpagesize
2613 bfd_vma bfd_emul_get_commonpagesize (const char *);
2616 Returns the common page size, in bytes, as determined by
2621 bfd_emul_get_commonpagesize (const char *emul
)
2623 const bfd_target
*target
;
2625 target
= bfd_find_target (emul
, NULL
);
2627 && target
->flavour
== bfd_target_elf_flavour
)
2629 const struct elf_backend_data
*bed
;
2631 bed
= xvec_get_elf_backend_data (target
);
2632 return bed
->commonpagesize
;
2642 char *bfd_demangle (bfd *, const char *, int);
2645 Wrapper around cplus_demangle. Strips leading underscores and
2646 other such chars that would otherwise confuse the demangler.
2647 If passed a g++ v3 ABI mangled name, returns a buffer allocated
2648 with malloc holding the demangled name. Returns NULL otherwise
2649 and on memory alloc failure.
2653 bfd_demangle (bfd
*abfd
, const char *name
, int options
)
2656 const char *pre
, *suf
;
2660 skip_lead
= (abfd
!= NULL
2662 && bfd_get_symbol_leading_char (abfd
) == *name
);
2666 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
2667 or the MS PE format. These formats have a number of leading '.'s
2668 on at least some symbols, so we remove all dots to avoid
2669 confusing the demangler. */
2671 while (*name
== '.' || *name
== '$')
2673 pre_len
= name
- pre
;
2675 /* Strip off @plt and suchlike too. */
2677 suf
= strchr (name
, '@');
2680 alloc
= (char *) bfd_malloc (suf
- name
+ 1);
2683 memcpy (alloc
, name
, suf
- name
);
2684 alloc
[suf
- name
] = '\0';
2688 res
= cplus_demangle (name
, options
);
2696 size_t len
= strlen (pre
) + 1;
2697 alloc
= (char *) bfd_malloc (len
);
2700 memcpy (alloc
, pre
, len
);
2706 /* Put back any prefix or suffix. */
2707 if (pre_len
!= 0 || suf
!= NULL
)
2716 suf_len
= strlen (suf
) + 1;
2717 final
= (char *) bfd_malloc (pre_len
+ len
+ suf_len
);
2720 memcpy (final
, pre
, pre_len
);
2721 memcpy (final
+ pre_len
, res
, len
);
2722 memcpy (final
+ pre_len
+ len
, suf
, suf_len
);
2731 /* Get the linker information. */
2733 struct bfd_link_info
*
2734 _bfd_get_link_info (bfd
*abfd
)
2736 if (bfd_get_flavour (abfd
) != bfd_target_elf_flavour
)
2739 return elf_link_info (abfd
);