xref: /netbsd-src/external/gpl3/gdb.old/dist/bfd/bfd.c (revision 8b657b0747480f8989760d71343d6dd33f8d4cf9)
1 /* Generic BFD library interface and support routines.
2    Copyright (C) 1990-2022 Free Software Foundation, Inc.
3    Written by Cygnus Support.
4 
5    This file is part of BFD, the Binary File Descriptor library.
6 
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.
11 
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.
16 
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.  */
21 
22 /*
23 INODE
24 typedef bfd, Error reporting, BFD front end, BFD front end
25 
26 SECTION
27 	<<typedef bfd>>
28 
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.
32 
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.
36 
37 CODE_FRAGMENT
38 .
39 .enum bfd_direction
40 .  {
41 .    no_direction = 0,
42 .    read_direction = 1,
43 .    write_direction = 2,
44 .    both_direction = 3
45 .  };
46 .
47 .enum bfd_plugin_format
48 .  {
49 .    bfd_plugin_unknown = 0,
50 .    bfd_plugin_yes = 1,
51 .    bfd_plugin_no = 2
52 .  };
53 .
54 .struct bfd_build_id
55 .  {
56 .    bfd_size_type size;
57 .    bfd_byte data[1];
58 .  };
59 .
60 .struct bfd
61 .{
62 .  {* The filename the application opened the BFD with.  *}
63 .  const char *filename;
64 .
65 .  {* A pointer to the target jump table.  *}
66 .  const struct bfd_target *xvec;
67 .
68 .  {* The IOSTREAM, and corresponding IO vector that provide access
69 .     to the file backing the BFD.  *}
70 .  void *iostream;
71 .  const struct bfd_iovec *iovec;
72 .
73 .  {* The caching routines use these to maintain a
74 .     least-recently-used list of BFDs.  *}
75 .  struct bfd *lru_prev, *lru_next;
76 .
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.  *}
80 .  ufile_ptr where;
81 .
82 .  {* File modified time, if mtime_set is TRUE.  *}
83 .  long mtime;
84 .
85 .  {* A unique identifier of the BFD  *}
86 .  unsigned int id;
87 .
88 .  {* Format_specific flags.  *}
89 .  flagword flags;
90 .
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).  *}
97 .
98 .#define BFD_NO_FLAGS                0x0
99 .
100 .  {* BFD contains relocation entries.  *}
101 .#define HAS_RELOC                   0x1
102 .
103 .  {* BFD is directly executable.  *}
104 .#define EXEC_P                      0x2
105 .
106 .  {* BFD has line number information (basically used for F_LNNO in a
107 .     COFF header).  *}
108 .#define HAS_LINENO                  0x4
109 .
110 .  {* BFD has debugging information.  *}
111 .#define HAS_DEBUG                  0x08
112 .
113 .  {* BFD has symbols.  *}
114 .#define HAS_SYMS                   0x10
115 .
116 .  {* BFD has local symbols (basically used for F_LSYMS in a COFF
117 .     header).  *}
118 .#define HAS_LOCALS                 0x20
119 .
120 .  {* BFD is a dynamic object.  *}
121 .#define DYNAMIC                    0x40
122 .
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
127 .
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
131 .
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
136 .
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
140 .     duplicates.  *}
141 .#define BFD_TRADITIONAL_FORMAT    0x400
142 .
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
145 .     struct.  *}
146 .#define BFD_IN_MEMORY             0x800
147 .
148 .  {* This BFD has been created by the linker and doesn't correspond
149 .     to any input file.  *}
150 .#define BFD_LINKER_CREATED       0x1000
151 .
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
156 .
157 .  {* Compress sections in this BFD.  *}
158 .#define BFD_COMPRESS             0x4000
159 .
160 .  {* Decompress sections in this BFD.  *}
161 .#define BFD_DECOMPRESS           0x8000
162 .
163 .  {* BFD is a dummy, for plugins.  *}
164 .#define BFD_PLUGIN              0x10000
165 .
166 .  {* Compress sections in this BFD with SHF_COMPRESSED from gABI.  *}
167 .#define BFD_COMPRESS_GABI       0x20000
168 .
169 .  {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
170 .     BFD.  *}
171 .#define BFD_CONVERT_ELF_COMMON  0x40000
172 .
173 .  {* Use the ELF STT_COMMON type in this BFD.  *}
174 .#define BFD_USE_ELF_STT_COMMON  0x80000
175 .
176 .  {* Put pathnames into archives (non-POSIX).  *}
177 .#define BFD_ARCHIVE_FULL_PATH  0x100000
178 .
179 .#define BFD_CLOSED_BY_CACHE    0x200000
180 
181 .  {* Compress sections in this BFD with SHF_COMPRESSED zstd.  *}
182 .#define BFD_COMPRESS_ZSTD      0x400000
183 .
184 .  {* Flags bits to be saved in bfd_preserve_save.  *}
185 .#define BFD_FLAGS_SAVED \
186 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
187 .   | BFD_PLUGIN | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON \
188 .   | BFD_USE_ELF_STT_COMMON | BFD_COMPRESS_ZSTD)
189 .
190 .  {* Flags bits which are for BFD use only.  *}
191 .#define BFD_FLAGS_FOR_BFD_USE_MASK \
192 .  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
193 .   | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
194 .   | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
195 .
196 .  {* The format which belongs to the BFD. (object, core, etc.)  *}
197 .  ENUM_BITFIELD (bfd_format) format : 3;
198 .
199 .  {* The direction with which the BFD was opened.  *}
200 .  ENUM_BITFIELD (bfd_direction) direction : 2;
201 .
202 .  {* Is the file descriptor being cached?  That is, can it be closed as
203 .     needed, and re-opened when accessed later?  *}
204 .  unsigned int cacheable : 1;
205 .
206 .  {* Marks whether there was a default target specified when the
207 .     BFD was opened. This is used to select which matching algorithm
208 .     to use to choose the back end.  *}
209 .  unsigned int target_defaulted : 1;
210 .
211 .  {* ... and here: (``once'' means at least once).  *}
212 .  unsigned int opened_once : 1;
213 .
214 .  {* Set if we have a locally maintained mtime value, rather than
215 .     getting it from the file each time.  *}
216 .  unsigned int mtime_set : 1;
217 .
218 .  {* Flag set if symbols from this BFD should not be exported.  *}
219 .  unsigned int no_export : 1;
220 .
221 .  {* Remember when output has begun, to stop strange things
222 .     from happening.  *}
223 .  unsigned int output_has_begun : 1;
224 .
225 .  {* Have archive map.  *}
226 .  unsigned int has_armap : 1;
227 .
228 .  {* Set if this is a thin archive.  *}
229 .  unsigned int is_thin_archive : 1;
230 .
231 .  {* Set if this archive should not cache element positions.  *}
232 .  unsigned int no_element_cache : 1;
233 .
234 .  {* Set if only required symbols should be added in the link hash table for
235 .     this object.  Used by VMS linkers.  *}
236 .  unsigned int selective_search : 1;
237 .
238 .  {* Set if this is the linker output BFD.  *}
239 .  unsigned int is_linker_output : 1;
240 .
241 .  {* Set if this is the linker input BFD.  *}
242 .  unsigned int is_linker_input : 1;
243 .
244 .  {* If this is an input for a compiler plug-in library.  *}
245 .  ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
246 .
247 .  {* Set if this is a plugin output file.  *}
248 .  unsigned int lto_output : 1;
249 .
250 .  {* Set if this is a slim LTO object not loaded with a compiler plugin.  *}
251 .  unsigned int lto_slim_object : 1;
252 .
253 .  {* Do not attempt to modify this file.  Set when detecting errors
254 .     that BFD is not prepared to handle for objcopy/strip.  *}
255 .  unsigned int read_only : 1;
256 .
257 .  {* Set to dummy BFD created when claimed by a compiler plug-in
258 .     library.  *}
259 .  bfd *plugin_dummy_bfd;
260 .
261 .  {* The offset of this bfd in the file, typically 0 if it is not
262 .     contained in an archive.  *}
263 .  ufile_ptr origin;
264 .
265 .  {* The origin in the archive of the proxy entry.  This will
266 .     normally be the same as origin, except for thin archives,
267 .     when it will contain the current offset of the proxy in the
268 .     thin archive rather than the offset of the bfd in its actual
269 .     container.  *}
270 .  ufile_ptr proxy_origin;
271 .
272 .  {* A hash table for section names.  *}
273 .  struct bfd_hash_table section_htab;
274 .
275 .  {* Pointer to linked list of sections.  *}
276 .  struct bfd_section *sections;
277 .
278 .  {* The last section on the section list.  *}
279 .  struct bfd_section *section_last;
280 .
281 .  {* The number of sections.  *}
282 .  unsigned int section_count;
283 .
284 .  {* The archive plugin file descriptor.  *}
285 .  int archive_plugin_fd;
286 .
287 .  {* The number of opens on the archive plugin file descriptor.  *}
288 .  unsigned int archive_plugin_fd_open_count;
289 .
290 .  {* A field used by _bfd_generic_link_add_archive_symbols.  This will
291 .     be used only for archive elements.  *}
292 .  int archive_pass;
293 .
294 .  {* The total size of memory from bfd_alloc.  *}
295 .  bfd_size_type alloc_size;
296 .
297 .  {* Stuff only useful for object files:
298 .     The start address.  *}
299 .  bfd_vma start_address;
300 .
301 .  {* Symbol table for output BFD (with symcount entries).
302 .     Also used by the linker to cache input BFD symbols.  *}
303 .  struct bfd_symbol **outsymbols;
304 .
305 .  {* Used for input and output.  *}
306 .  unsigned int symcount;
307 .
308 .  {* Used for slurped dynamic symbol tables.  *}
309 .  unsigned int dynsymcount;
310 .
311 .  {* Pointer to structure which contains architecture information.  *}
312 .  const struct bfd_arch_info *arch_info;
313 .
314 .  {* Cached length of file for bfd_get_size.  0 until bfd_get_size is
315 .     called, 1 if stat returns an error or the file size is too large to
316 .     return in ufile_ptr.  Both 0 and 1 should be treated as "unknown".  *}
317 .  ufile_ptr size;
318 .
319 .  {* Stuff only useful for archives.  *}
320 .  void *arelt_data;
321 .  struct bfd *my_archive;      {* The containing archive BFD.  *}
322 .  struct bfd *archive_next;    {* The next BFD in the archive.  *}
323 .  struct bfd *archive_head;    {* The first BFD in the archive.  *}
324 .  struct bfd *nested_archives; {* List of nested archive in a flattened
325 .				   thin archive.  *}
326 .
327 .  union {
328 .    {* For input BFDs, a chain of BFDs involved in a link.  *}
329 .    struct bfd *next;
330 .    {* For output BFD, the linker hash table.  *}
331 .    struct bfd_link_hash_table *hash;
332 .  } link;
333 .
334 .  {* Used by the back end to hold private data.  *}
335 .  union
336 .    {
337 .      struct aout_data_struct *aout_data;
338 .      struct artdata *aout_ar_data;
339 .      struct coff_tdata *coff_obj_data;
340 .      struct pe_tdata *pe_obj_data;
341 .      struct xcoff_tdata *xcoff_obj_data;
342 .      struct ecoff_tdata *ecoff_obj_data;
343 .      struct srec_data_struct *srec_data;
344 .      struct verilog_data_struct *verilog_data;
345 .      struct ihex_data_struct *ihex_data;
346 .      struct tekhex_data_struct *tekhex_data;
347 .      struct elf_obj_tdata *elf_obj_data;
348 .      struct mmo_data_struct *mmo_data;
349 .      struct sun_core_struct *sun_core_data;
350 .      struct sco5_core_struct *sco5_core_data;
351 .      struct trad_core_struct *trad_core_data;
352 .      struct som_data_struct *som_data;
353 .      struct hpux_core_struct *hpux_core_data;
354 .      struct hppabsd_core_struct *hppabsd_core_data;
355 .      struct sgi_core_struct *sgi_core_data;
356 .      struct lynx_core_struct *lynx_core_data;
357 .      struct osf_core_struct *osf_core_data;
358 .      struct cisco_core_struct *cisco_core_data;
359 .      struct versados_data_struct *versados_data;
360 .      struct netbsd_core_struct *netbsd_core_data;
361 .      struct mach_o_data_struct *mach_o_data;
362 .      struct mach_o_fat_data_struct *mach_o_fat_data;
363 .      struct plugin_data_struct *plugin_data;
364 .      struct bfd_pef_data_struct *pef_data;
365 .      struct bfd_pef_xlib_data_struct *pef_xlib_data;
366 .      struct bfd_sym_data_struct *sym_data;
367 .      void *any;
368 .    }
369 .  tdata;
370 .
371 .  {* Used by the application to hold private data.  *}
372 .  void *usrdata;
373 .
374 .  {* Where all the allocated stuff under this BFD goes.  This is a
375 .     struct objalloc *, but we use void * to avoid requiring the inclusion
376 .     of objalloc.h.  *}
377 .  void *memory;
378 .
379 .  {* For input BFDs, the build ID, if the object has one. *}
380 .  const struct bfd_build_id *build_id;
381 .};
382 .
383 .static inline const char *
384 .bfd_get_filename (const bfd *abfd)
385 .{
386 .  return abfd->filename;
387 .}
388 .
389 .static inline bool
390 .bfd_get_cacheable (const bfd *abfd)
391 .{
392 .  return abfd->cacheable;
393 .}
394 .
395 .static inline enum bfd_format
396 .bfd_get_format (const bfd *abfd)
397 .{
398 .  return abfd->format;
399 .}
400 .
401 .static inline flagword
402 .bfd_get_file_flags (const bfd *abfd)
403 .{
404 .  return abfd->flags;
405 .}
406 .
407 .static inline bfd_vma
408 .bfd_get_start_address (const bfd *abfd)
409 .{
410 .  return abfd->start_address;
411 .}
412 .
413 .static inline unsigned int
414 .bfd_get_symcount (const bfd *abfd)
415 .{
416 .  return abfd->symcount;
417 .}
418 .
419 .static inline unsigned int
420 .bfd_get_dynamic_symcount (const bfd *abfd)
421 .{
422 .  return abfd->dynsymcount;
423 .}
424 .
425 .static inline struct bfd_symbol **
426 .bfd_get_outsymbols (const bfd *abfd)
427 .{
428 .  return abfd->outsymbols;
429 .}
430 .
431 .static inline unsigned int
432 .bfd_count_sections (const bfd *abfd)
433 .{
434 .  return abfd->section_count;
435 .}
436 .
437 .static inline bool
438 .bfd_has_map (const bfd *abfd)
439 .{
440 .  return abfd->has_armap;
441 .}
442 .
443 .static inline bool
444 .bfd_is_thin_archive (const bfd *abfd)
445 .{
446 .  return abfd->is_thin_archive;
447 .}
448 .
449 .static inline void *
450 .bfd_usrdata (const bfd *abfd)
451 .{
452 .  return abfd->usrdata;
453 .}
454 .
455 .{* See note beside bfd_set_section_userdata.  *}
456 .static inline bool
457 .bfd_set_cacheable (bfd * abfd, bool val)
458 .{
459 .  abfd->cacheable = val;
460 .  return true;
461 .}
462 .
463 .static inline void
464 .bfd_set_thin_archive (bfd *abfd, bool val)
465 .{
466 .  abfd->is_thin_archive = val;
467 .}
468 .
469 .static inline void
470 .bfd_set_usrdata (bfd *abfd, void *val)
471 .{
472 .  abfd->usrdata = val;
473 .}
474 .
475 .static inline asection *
476 .bfd_asymbol_section (const asymbol *sy)
477 .{
478 .  return sy->section;
479 .}
480 .
481 .static inline bfd_vma
482 .bfd_asymbol_value (const asymbol *sy)
483 .{
484 .  return sy->section->vma + sy->value;
485 .}
486 .
487 .static inline const char *
488 .bfd_asymbol_name (const asymbol *sy)
489 .{
490 .  return sy->name;
491 .}
492 .
493 .static inline struct bfd *
494 .bfd_asymbol_bfd (const asymbol *sy)
495 .{
496 .  return sy->the_bfd;
497 .}
498 .
499 .static inline void
500 .bfd_set_asymbol_name (asymbol *sy, const char *name)
501 .{
502 .  sy->name = name;
503 .}
504 .
505 .static inline bfd_size_type
506 .bfd_get_section_limit_octets (const bfd *abfd, const asection *sec)
507 .{
508 .  if (abfd->direction != write_direction && sec->rawsize != 0)
509 .    return sec->rawsize;
510 .  return sec->size;
511 .}
512 .
513 .{* Find the address one past the end of SEC.  *}
514 .static inline bfd_size_type
515 .bfd_get_section_limit (const bfd *abfd, const asection *sec)
516 .{
517 .  return (bfd_get_section_limit_octets (abfd, sec)
518 .	   / bfd_octets_per_byte (abfd, sec));
519 .}
520 .
521 .static inline bfd_size_type
522 .bfd_get_section_alloc_size (const bfd *abfd, const asection *sec)
523 .{
524 .  if (abfd->direction != write_direction && sec->rawsize > sec->size)
525 .    return sec->rawsize;
526 .  return sec->size;
527 .}
528 .
529 .{* Functions to handle insertion and deletion of a bfd's sections.  These
530 .   only handle the list pointers, ie. do not adjust section_count,
531 .   target_index etc.  *}
532 .static inline void
533 .bfd_section_list_remove (bfd *abfd, asection *s)
534 .{
535 .  asection *next = s->next;
536 .  asection *prev = s->prev;
537 .  if (prev)
538 .    prev->next = next;
539 .  else
540 .    abfd->sections = next;
541 .  if (next)
542 .    next->prev = prev;
543 .  else
544 .    abfd->section_last = prev;
545 .}
546 .
547 .static inline void
548 .bfd_section_list_append (bfd *abfd, asection *s)
549 .{
550 .  s->next = 0;
551 .  if (abfd->section_last)
552 .    {
553 .      s->prev = abfd->section_last;
554 .      abfd->section_last->next = s;
555 .    }
556 .  else
557 .    {
558 .      s->prev = 0;
559 .      abfd->sections = s;
560 .    }
561 .  abfd->section_last = s;
562 .}
563 .
564 .static inline void
565 .bfd_section_list_prepend (bfd *abfd, asection *s)
566 .{
567 .  s->prev = 0;
568 .  if (abfd->sections)
569 .    {
570 .      s->next = abfd->sections;
571 .      abfd->sections->prev = s;
572 .    }
573 .  else
574 .    {
575 .      s->next = 0;
576 .      abfd->section_last = s;
577 .    }
578 .  abfd->sections = s;
579 .}
580 .
581 .static inline void
582 .bfd_section_list_insert_after (bfd *abfd, asection *a, asection *s)
583 .{
584 .  asection *next = a->next;
585 .  s->next = next;
586 .  s->prev = a;
587 .  a->next = s;
588 .  if (next)
589 .    next->prev = s;
590 .  else
591 .    abfd->section_last = s;
592 .}
593 .
594 .static inline void
595 .bfd_section_list_insert_before (bfd *abfd, asection *b, asection *s)
596 .{
597 .  asection *prev = b->prev;
598 .  s->prev = prev;
599 .  s->next = b;
600 .  b->prev = s;
601 .  if (prev)
602 .    prev->next = s;
603 .  else
604 .    abfd->sections = s;
605 .}
606 .
607 .static inline bool
608 .bfd_section_removed_from_list (const bfd *abfd, const asection *s)
609 .{
610 .  return s->next ? s->next->prev != s : abfd->section_last != s;
611 .}
612 .
613 */
614 
615 #include "sysdep.h"
616 #include <stdarg.h>
617 #include "bfd.h"
618 #include "bfdver.h"
619 #include "libiberty.h"
620 #include "demangle.h"
621 #include "safe-ctype.h"
622 #include "bfdlink.h"
623 #include "libbfd.h"
624 #include "coff/internal.h"
625 #include "coff/sym.h"
626 #include "libcoff.h"
627 #include "libecoff.h"
628 #undef obj_symbols
629 #include "elf-bfd.h"
630 
631 #ifndef EXIT_FAILURE
632 #define EXIT_FAILURE 1
633 #endif
634 
635 
636 /* provide storage for subsystem, stack and heap data which may have been
637    passed in on the command line.  Ld puts this data into a bfd_link_info
638    struct which ultimately gets passed in to the bfd.  When it arrives, copy
639    it to the following struct so that the data will be available in coffcode.h
640    where it is needed.  The typedef's used are defined in bfd.h */
641 
642 /*
643 INODE
644 Error reporting, Miscellaneous, typedef bfd, BFD front end
645 
646 SECTION
647 	Error reporting
648 
649 	Most BFD functions return nonzero on success (check their
650 	individual documentation for precise semantics).  On an error,
651 	they call <<bfd_set_error>> to set an error condition that callers
652 	can check by calling <<bfd_get_error>>.
653 	If that returns <<bfd_error_system_call>>, then check
654 	<<errno>>.
655 
656 	The easiest way to report a BFD error to the user is to
657 	use <<bfd_perror>>.
658 
659 SUBSECTION
660 	Type <<bfd_error_type>>
661 
662 	The values returned by <<bfd_get_error>> are defined by the
663 	enumerated type <<bfd_error_type>>.
664 
665 CODE_FRAGMENT
666 .
667 .typedef enum bfd_error
668 .{
669 .  bfd_error_no_error = 0,
670 .  bfd_error_system_call,
671 .  bfd_error_invalid_target,
672 .  bfd_error_wrong_format,
673 .  bfd_error_wrong_object_format,
674 .  bfd_error_invalid_operation,
675 .  bfd_error_no_memory,
676 .  bfd_error_no_symbols,
677 .  bfd_error_no_armap,
678 .  bfd_error_no_more_archived_files,
679 .  bfd_error_malformed_archive,
680 .  bfd_error_missing_dso,
681 .  bfd_error_file_not_recognized,
682 .  bfd_error_file_ambiguously_recognized,
683 .  bfd_error_no_contents,
684 .  bfd_error_nonrepresentable_section,
685 .  bfd_error_no_debug_section,
686 .  bfd_error_bad_value,
687 .  bfd_error_file_truncated,
688 .  bfd_error_file_too_big,
689 .  bfd_error_sorry,
690 .  bfd_error_on_input,
691 .  bfd_error_invalid_error_code
692 .}
693 .bfd_error_type;
694 .
695 */
696 
697 static bfd_error_type bfd_error = bfd_error_no_error;
698 static bfd *input_bfd = NULL;
699 static bfd_error_type input_error = bfd_error_no_error;
700 
701 const char *const bfd_errmsgs[] =
702 {
703   N_("no error"),
704   N_("system call error"),
705   N_("invalid bfd target"),
706   N_("file in wrong format"),
707   N_("archive object file in wrong format"),
708   N_("invalid operation"),
709   N_("memory exhausted"),
710   N_("no symbols"),
711   N_("archive has no index; run ranlib to add one"),
712   N_("no more archived files"),
713   N_("malformed archive"),
714   N_("DSO missing from command line"),
715   N_("file format not recognized"),
716   N_("file format is ambiguous"),
717   N_("section has no contents"),
718   N_("nonrepresentable section on output"),
719   N_("symbol needs debug section which does not exist"),
720   N_("bad value"),
721   N_("file truncated"),
722   N_("file too big"),
723   N_("sorry, cannot handle this file"),
724   N_("error reading %s: %s"),
725   N_("#<invalid error code>")
726 };
727 
728 /*
729 FUNCTION
730 	bfd_get_error
731 
732 SYNOPSIS
733 	bfd_error_type bfd_get_error (void);
734 
735 DESCRIPTION
736 	Return the current BFD error condition.
737 */
738 
739 bfd_error_type
740 bfd_get_error (void)
741 {
742   return bfd_error;
743 }
744 
745 /*
746 FUNCTION
747 	bfd_set_error
748 
749 SYNOPSIS
750 	void bfd_set_error (bfd_error_type error_tag);
751 
752 DESCRIPTION
753 	Set the BFD error condition to be @var{error_tag}.
754 
755 	@var{error_tag} must not be bfd_error_on_input.  Use
756 	bfd_set_input_error for input errors instead.
757 */
758 
759 void
760 bfd_set_error (bfd_error_type error_tag)
761 {
762   bfd_error = error_tag;
763   if (bfd_error >= bfd_error_on_input)
764     abort ();
765 }
766 
767 /*
768 FUNCTION
769 	bfd_set_input_error
770 
771 SYNOPSIS
772 	void bfd_set_input_error (bfd *input, bfd_error_type error_tag);
773 
774 DESCRIPTION
775 
776 	Set the BFD error condition to be bfd_error_on_input.
777 	@var{input} is the input bfd where the error occurred, and
778 	@var{error_tag} the bfd_error_type error.
779 */
780 
781 void
782 bfd_set_input_error (bfd *input, bfd_error_type error_tag)
783 {
784   /* This is an error that occurred during bfd_close when writing an
785      archive, but on one of the input files.  */
786   bfd_error = bfd_error_on_input;
787   input_bfd = input;
788   input_error = error_tag;
789   if (input_error >= bfd_error_on_input)
790     abort ();
791 }
792 
793 /*
794 FUNCTION
795 	bfd_errmsg
796 
797 SYNOPSIS
798 	const char *bfd_errmsg (bfd_error_type error_tag);
799 
800 DESCRIPTION
801 	Return a string describing the error @var{error_tag}, or
802 	the system error if @var{error_tag} is <<bfd_error_system_call>>.
803 */
804 
805 const char *
806 bfd_errmsg (bfd_error_type error_tag)
807 {
808 #ifndef errno
809   extern int errno;
810 #endif
811   if (error_tag == bfd_error_on_input)
812     {
813       char *buf;
814       const char *msg = bfd_errmsg (input_error);
815 
816       if (asprintf (&buf, _(bfd_errmsgs [error_tag]),
817 		    bfd_get_filename (input_bfd), msg) != -1)
818 	return buf;
819 
820       /* Ick, what to do on out of memory?  */
821       return msg;
822     }
823 
824   if (error_tag == bfd_error_system_call)
825     return xstrerror (errno);
826 
827   if (error_tag > bfd_error_invalid_error_code)
828     error_tag = bfd_error_invalid_error_code;	/* sanity check */
829 
830   return _(bfd_errmsgs [error_tag]);
831 }
832 
833 /*
834 FUNCTION
835 	bfd_perror
836 
837 SYNOPSIS
838 	void bfd_perror (const char *message);
839 
840 DESCRIPTION
841 	Print to the standard error stream a string describing the
842 	last BFD error that occurred, or the last system error if
843 	the last BFD error was a system call failure.  If @var{message}
844 	is non-NULL and non-empty, the error string printed is preceded
845 	by @var{message}, a colon, and a space.  It is followed by a newline.
846 */
847 
848 void
849 bfd_perror (const char *message)
850 {
851   fflush (stdout);
852   if (message == NULL || *message == '\0')
853     fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
854   else
855     fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
856   fflush (stderr);
857 }
858 
859 /*
860 SUBSECTION
861 	BFD error handler
862 
863 	Some BFD functions want to print messages describing the
864 	problem.  They call a BFD error handler function.  This
865 	function may be overridden by the program.
866 
867 	The BFD error handler acts like vprintf.
868 
869 CODE_FRAGMENT
870 .
871 .typedef void (*bfd_error_handler_type) (const char *, va_list);
872 .
873 */
874 
875 /* The program name used when printing BFD error messages.  */
876 
877 static const char *_bfd_error_program_name;
878 
879 /* Support for positional parameters.  */
880 
881 union _bfd_doprnt_args
882 {
883   int i;
884   long l;
885   long long ll;
886   double d;
887   long double ld;
888   void *p;
889   enum
890   {
891     Bad,
892     Int,
893     Long,
894     LongLong,
895     Double,
896     LongDouble,
897     Ptr
898   } type;
899 };
900 
901 /* Maximum number of _bfd_error_handler args.  Don't increase this
902    without changing the code handling positional parameters.  */
903 #define MAX_ARGS 9
904 
905 /* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a
906    little and extended to handle '%pA', '%pB' and positional parameters.  */
907 
908 #define PRINT_TYPE(TYPE, FIELD) \
909   do								\
910     {								\
911       TYPE value = (TYPE) args[arg_no].FIELD;			\
912       result = print (stream, specifier, value);		\
913     } while (0)
914 
915 typedef int (*print_func) (void *, const char *, ...);
916 
917 static int
918 _bfd_doprnt (print_func print, void *stream, const char *format,
919 	     union _bfd_doprnt_args *args)
920 {
921   const char *ptr = format;
922   char specifier[128];
923   int total_printed = 0;
924   unsigned int arg_count = 0;
925 
926   while (*ptr != '\0')
927     {
928       int result;
929 
930       if (*ptr != '%')
931 	{
932 	  /* While we have regular characters, print them.  */
933 	  char *end = strchr (ptr, '%');
934 	  if (end != NULL)
935 	    result = print (stream, "%.*s", (int) (end - ptr), ptr);
936 	  else
937 	    result = print (stream, "%s", ptr);
938 	  ptr += result;
939 	}
940       else if (ptr[1] == '%')
941 	{
942 	  fputc ('%', stream);
943 	  result = 1;
944 	  ptr += 2;
945 	}
946       else
947 	{
948 	  /* We have a format specifier!  */
949 	  char *sptr = specifier;
950 	  int wide_width = 0, short_width = 0;
951 	  unsigned int arg_no;
952 
953 	  /* Copy the % and move forward.  */
954 	  *sptr++ = *ptr++;
955 
956 	  /* Check for a positional parameter.  */
957 	  arg_no = -1u;
958 	  if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
959 	    {
960 	      arg_no = *ptr - '1';
961 	      ptr += 2;
962 	    }
963 
964 	  /* Move past flags.  */
965 	  while (strchr ("-+ #0'I", *ptr))
966 	    *sptr++ = *ptr++;
967 
968 	  if (*ptr == '*')
969 	    {
970 	      int value;
971 	      unsigned int arg_index;
972 
973 	      ptr++;
974 	      arg_index = arg_count;
975 	      if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
976 		{
977 		  arg_index = *ptr - '1';
978 		  ptr += 2;
979 		}
980 	      value = abs (args[arg_index].i);
981 	      arg_count++;
982 	      sptr += sprintf (sptr, "%d", value);
983 	    }
984 	  else
985 	    /* Handle explicit numeric value.  */
986 	    while (ISDIGIT (*ptr))
987 	      *sptr++ = *ptr++;
988 
989 	  /* Precision.  */
990 	  if (*ptr == '.')
991 	    {
992 	      /* Copy and go past the period.  */
993 	      *sptr++ = *ptr++;
994 	      if (*ptr == '*')
995 		{
996 		  int value;
997 		  unsigned int arg_index;
998 
999 		  ptr++;
1000 		  arg_index = arg_count;
1001 		  if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
1002 		    {
1003 		      arg_index = *ptr - '1';
1004 		      ptr += 2;
1005 		    }
1006 		  value = abs (args[arg_index].i);
1007 		  arg_count++;
1008 		  sptr += sprintf (sptr, "%d", value);
1009 		}
1010 	      else
1011 		/* Handle explicit numeric value.  */
1012 		while (ISDIGIT (*ptr))
1013 		  *sptr++ = *ptr++;
1014 	    }
1015 	  while (strchr ("hlL", *ptr))
1016 	    {
1017 	      switch (*ptr)
1018 		{
1019 		case 'h':
1020 		  short_width = 1;
1021 		  break;
1022 		case 'l':
1023 		  wide_width++;
1024 		  break;
1025 		case 'L':
1026 		  wide_width = 2;
1027 		  break;
1028 		default:
1029 		  abort();
1030 		}
1031 	      *sptr++ = *ptr++;
1032 	    }
1033 
1034 	  /* Copy the type specifier, and NULL terminate.  */
1035 	  *sptr++ = *ptr++;
1036 	  *sptr = '\0';
1037 	  if ((int) arg_no < 0)
1038 	    arg_no = arg_count;
1039 
1040 	  switch (ptr[-1])
1041 	    {
1042 	    case 'd':
1043 	    case 'i':
1044 	    case 'o':
1045 	    case 'u':
1046 	    case 'x':
1047 	    case 'X':
1048 	    case 'c':
1049 	      {
1050 		/* Short values are promoted to int, so just copy it
1051 		   as an int and trust the C library printf to cast it
1052 		   to the right width.  */
1053 		if (short_width)
1054 		  PRINT_TYPE (int, i);
1055 		else
1056 		  {
1057 		    switch (wide_width)
1058 		      {
1059 		      case 0:
1060 			PRINT_TYPE (int, i);
1061 			break;
1062 		      case 1:
1063 			PRINT_TYPE (long, l);
1064 			break;
1065 		      case 2:
1066 		      default:
1067 #if defined (__MSVCRT__)
1068 			sptr[-3] = 'I';
1069 			sptr[-2] = '6';
1070 			sptr[-1] = '4';
1071 			*sptr++ = ptr[-1];
1072 			*sptr = '\0';
1073 #endif
1074 			PRINT_TYPE (long long, ll);
1075 			break;
1076 		      }
1077 		  }
1078 	      }
1079 	      break;
1080 	    case 'f':
1081 	    case 'e':
1082 	    case 'E':
1083 	    case 'g':
1084 	    case 'G':
1085 	      {
1086 		if (wide_width == 0)
1087 		  PRINT_TYPE (double, d);
1088 		else
1089 		  PRINT_TYPE (long double, ld);
1090 	      }
1091 	      break;
1092 	    case 's':
1093 	      PRINT_TYPE (char *, p);
1094 	      break;
1095 	    case 'p':
1096 	      if (*ptr == 'A')
1097 		{
1098 		  asection *sec;
1099 		  bfd *abfd;
1100 		  const char *group = NULL;
1101 		  struct coff_comdat_info *ci;
1102 
1103 		  ptr++;
1104 		  sec = (asection *) args[arg_no].p;
1105 		  if (sec == NULL)
1106 		    /* Invoking %pA with a null section pointer is an
1107 		       internal error.  */
1108 		    abort ();
1109 		  abfd = sec->owner;
1110 		  if (abfd != NULL
1111 		      && bfd_get_flavour (abfd) == bfd_target_elf_flavour
1112 		      && elf_next_in_group (sec) != NULL
1113 		      && (sec->flags & SEC_GROUP) == 0)
1114 		    group = elf_group_name (sec);
1115 		  else if (abfd != NULL
1116 			   && bfd_get_flavour (abfd) == bfd_target_coff_flavour
1117 			   && (ci = bfd_coff_get_comdat_section (sec->owner,
1118 								 sec)) != NULL)
1119 		    group = ci->name;
1120 		  if (group != NULL)
1121 		    result = print (stream, "%s[%s]", sec->name, group);
1122 		  else
1123 		    result = print (stream, "%s", sec->name);
1124 		}
1125 	      else if (*ptr == 'B')
1126 		{
1127 		  bfd *abfd;
1128 
1129 		  ptr++;
1130 		  abfd = (bfd *) args[arg_no].p;
1131 		  if (abfd == NULL)
1132 		    /* Invoking %pB with a null bfd pointer is an
1133 		       internal error.  */
1134 		    abort ();
1135 		  else if (abfd->my_archive
1136 			   && !bfd_is_thin_archive (abfd->my_archive))
1137 		    result = print (stream, "%s(%s)",
1138 				    bfd_get_filename (abfd->my_archive),
1139 				    bfd_get_filename (abfd));
1140 		  else
1141 		    result = print (stream, "%s", bfd_get_filename (abfd));
1142 		}
1143 	      else
1144 		PRINT_TYPE (void *, p);
1145 	      break;
1146 	    default:
1147 	      abort();
1148 	    }
1149 	  arg_count++;
1150 	}
1151       if (result == -1)
1152 	return -1;
1153       total_printed += result;
1154     }
1155 
1156   return total_printed;
1157 }
1158 
1159 /* First pass over FORMAT to gather ARGS.  Returns number of args.  */
1160 
1161 static unsigned int
1162 _bfd_doprnt_scan (const char *format, va_list ap, union _bfd_doprnt_args *args)
1163 {
1164   const char *ptr = format;
1165   unsigned int arg_count = 0;
1166 
1167   for (unsigned int i = 0; i < MAX_ARGS; i++)
1168     args[i].type = Bad;
1169 
1170   while (*ptr != '\0')
1171     {
1172       if (*ptr != '%')
1173 	{
1174 	  ptr = strchr (ptr, '%');
1175 	  if (ptr == NULL)
1176 	    break;
1177 	}
1178       else if (ptr[1] == '%')
1179 	ptr += 2;
1180       else
1181 	{
1182 	  int wide_width = 0, short_width = 0;
1183 	  unsigned int arg_no;
1184 	  int arg_type;
1185 
1186 	  ptr++;
1187 
1188 	  /* Check for a positional parameter.  */
1189 	  arg_no = -1u;
1190 	  if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
1191 	    {
1192 	      arg_no = *ptr - '1';
1193 	      ptr += 2;
1194 	    }
1195 
1196 	  /* Move past flags.  */
1197 	  while (strchr ("-+ #0'I", *ptr))
1198 	    ptr++;
1199 
1200 	  if (*ptr == '*')
1201 	    {
1202 	      unsigned int arg_index;
1203 
1204 	      ptr++;
1205 	      arg_index = arg_count;
1206 	      if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
1207 		{
1208 		  arg_index = *ptr - '1';
1209 		  ptr += 2;
1210 		}
1211 	      if (arg_index >= MAX_ARGS)
1212 		abort ();
1213 	      args[arg_index].type = Int;
1214 	      arg_count++;
1215 	    }
1216 	  else
1217 	    /* Handle explicit numeric value.  */
1218 	    while (ISDIGIT (*ptr))
1219 	      ptr++;
1220 
1221 	  /* Precision.  */
1222 	  if (*ptr == '.')
1223 	    {
1224 	      ptr++;
1225 	      if (*ptr == '*')
1226 		{
1227 		  unsigned int arg_index;
1228 
1229 		  ptr++;
1230 		  arg_index = arg_count;
1231 		  if (*ptr != '0' && ISDIGIT (*ptr) && ptr[1] == '$')
1232 		    {
1233 		      arg_index = *ptr - '1';
1234 		      ptr += 2;
1235 		    }
1236 		  if (arg_index >= MAX_ARGS)
1237 		    abort ();
1238 		  args[arg_index].type = Int;
1239 		  arg_count++;
1240 		}
1241 	      else
1242 		/* Handle explicit numeric value.  */
1243 		while (ISDIGIT (*ptr))
1244 		  ptr++;
1245 	    }
1246 	  while (strchr ("hlL", *ptr))
1247 	    {
1248 	      switch (*ptr)
1249 		{
1250 		case 'h':
1251 		  short_width = 1;
1252 		  break;
1253 		case 'l':
1254 		  wide_width++;
1255 		  break;
1256 		case 'L':
1257 		  wide_width = 2;
1258 		  break;
1259 		default:
1260 		  abort();
1261 		}
1262 	      ptr++;
1263 	    }
1264 
1265 	  ptr++;
1266 	  if ((int) arg_no < 0)
1267 	    arg_no = arg_count;
1268 
1269 	  arg_type = Bad;
1270 	  switch (ptr[-1])
1271 	    {
1272 	    case 'd':
1273 	    case 'i':
1274 	    case 'o':
1275 	    case 'u':
1276 	    case 'x':
1277 	    case 'X':
1278 	    case 'c':
1279 	      {
1280 		if (short_width)
1281 		  arg_type = Int;
1282 		else
1283 		  {
1284 		    switch (wide_width)
1285 		      {
1286 		      case 0:
1287 			arg_type = Int;
1288 			break;
1289 		      case 1:
1290 			arg_type = Long;
1291 			break;
1292 		      case 2:
1293 		      default:
1294 			arg_type = LongLong;
1295 			break;
1296 		      }
1297 		  }
1298 	      }
1299 	      break;
1300 	    case 'f':
1301 	    case 'e':
1302 	    case 'E':
1303 	    case 'g':
1304 	    case 'G':
1305 	      {
1306 		if (wide_width == 0)
1307 		  arg_type = Double;
1308 		else
1309 		  arg_type = LongDouble;
1310 	      }
1311 	      break;
1312 	    case 's':
1313 	      arg_type = Ptr;
1314 	      break;
1315 	    case 'p':
1316 	      if (*ptr == 'A' || *ptr == 'B')
1317 		ptr++;
1318 	      arg_type = Ptr;
1319 	      break;
1320 	    default:
1321 	      abort();
1322 	    }
1323 
1324 	  if (arg_no >= MAX_ARGS)
1325 	    abort ();
1326 	  args[arg_no].type = arg_type;
1327 	  arg_count++;
1328 	}
1329     }
1330 
1331   for (unsigned int i = 0; i < arg_count; i++)
1332     {
1333       switch (args[i].type)
1334 	{
1335 	case Int:
1336 	  args[i].i = va_arg (ap, int);
1337 	  break;
1338 	case Long:
1339 	  args[i].l = va_arg (ap, long);
1340 	  break;
1341 	case LongLong:
1342 	  args[i].ll = va_arg (ap, long long);
1343 	  break;
1344 	case Double:
1345 	  args[i].d = va_arg (ap, double);
1346 	  break;
1347 	case LongDouble:
1348 	  args[i].ld = va_arg (ap, long double);
1349 	  break;
1350 	case Ptr:
1351 	  args[i].p = va_arg (ap, void *);
1352 	  break;
1353 	default:
1354 	  abort ();
1355 	}
1356     }
1357 
1358   return arg_count;
1359 }
1360 
1361 /* The standard error handler that prints to stderr.  */
1362 
1363 static void
1364 error_handler_fprintf (const char *fmt, va_list ap)
1365 {
1366   union _bfd_doprnt_args args[MAX_ARGS];
1367 
1368   _bfd_doprnt_scan (fmt, ap, args);
1369 
1370   /* PR 4992: Don't interrupt output being sent to stdout.  */
1371   fflush (stdout);
1372 
1373   fprintf (stderr, "%s: ", _bfd_get_error_program_name ());
1374 
1375   _bfd_doprnt ((print_func) fprintf, stderr, fmt, args);
1376 
1377   /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
1378      warning, so use the fputc function to avoid it.  */
1379   fputc ('\n', stderr);
1380   fflush (stderr);
1381 }
1382 
1383 /* Control printing to a string buffer.  */
1384 struct buf_stream
1385 {
1386   char *ptr;
1387   int left;
1388 };
1389 
1390 /* An fprintf like function that instead prints to a string buffer.  */
1391 
1392 static int
1393 err_sprintf (void *stream, const char *fmt, ...)
1394 {
1395   struct buf_stream *s = stream;
1396   va_list ap;
1397 
1398   va_start (ap, fmt);
1399   int total = vsnprintf (s->ptr, s->left, fmt, ap);
1400   va_end (ap);
1401   if (total < 0)
1402     ;
1403   else if (total > s->left)
1404     {
1405       s->ptr += s->left;
1406       s->left = 0;
1407     }
1408   else
1409     {
1410       s->ptr += total;
1411       s->left -= total;
1412     }
1413   return total;
1414 }
1415 
1416 /* Communicate the bfd processed by bfd_check_format_matches to the
1417    error handling function error_handler_sprintf.  */
1418 
1419 static bfd *error_handler_bfd;
1420 
1421 /* An error handler that prints to a string, then dups that string to
1422    a per-xvec cache.  */
1423 
1424 static void
1425 error_handler_sprintf (const char *fmt, va_list ap)
1426 {
1427   union _bfd_doprnt_args args[MAX_ARGS];
1428   char error_buf[1024];
1429   struct buf_stream error_stream;
1430 
1431   _bfd_doprnt_scan (fmt, ap, args);
1432 
1433   error_stream.ptr = error_buf;
1434   error_stream.left = sizeof (error_buf);
1435   _bfd_doprnt (err_sprintf, &error_stream, fmt, args);
1436 
1437   size_t len = error_stream.ptr - error_buf;
1438   struct per_xvec_message **warn
1439     = _bfd_per_xvec_warn (error_handler_bfd->xvec, len + 1);
1440   if (*warn)
1441     {
1442       memcpy ((*warn)->message, error_buf, len);
1443       (*warn)->message[len] = 0;
1444     }
1445 }
1446 
1447 /* This is a function pointer to the routine which should handle BFD
1448    error messages.  It is called when a BFD routine encounters an
1449    error for which it wants to print a message.  Going through a
1450    function pointer permits a program linked against BFD to intercept
1451    the messages and deal with them itself.  */
1452 
1453 static bfd_error_handler_type _bfd_error_internal = error_handler_fprintf;
1454 
1455 /*
1456 FUNCTION
1457 	_bfd_error_handler
1458 
1459 SYNOPSIS
1460 	void _bfd_error_handler (const char *fmt, ...) ATTRIBUTE_PRINTF_1;
1461 
1462 DESCRIPTION
1463 	This is the default routine to handle BFD error messages.
1464 	Like fprintf (stderr, ...), but also handles some extra format
1465 	specifiers.
1466 
1467 	%pA section name from section.  For group components, prints
1468 	group name too.
1469 	%pB file name from bfd.  For archive components, prints
1470 	archive too.
1471 
1472 	Beware: Only supports a maximum of 9 format arguments.
1473 */
1474 
1475 void
1476 _bfd_error_handler (const char *fmt, ...)
1477 {
1478   va_list ap;
1479 
1480   va_start (ap, fmt);
1481   _bfd_error_internal (fmt, ap);
1482   va_end (ap);
1483 }
1484 
1485 /*
1486 FUNCTION
1487 	bfd_set_error_handler
1488 
1489 SYNOPSIS
1490 	bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
1491 
1492 DESCRIPTION
1493 	Set the BFD error handler function.  Returns the previous
1494 	function.
1495 */
1496 
1497 bfd_error_handler_type
1498 bfd_set_error_handler (bfd_error_handler_type pnew)
1499 {
1500   bfd_error_handler_type pold;
1501 
1502   pold = _bfd_error_internal;
1503   _bfd_error_internal = pnew;
1504   return pold;
1505 }
1506 
1507 /*
1508 INTERNAL_FUNCTION
1509 	_bfd_set_error_handler_caching
1510 
1511 SYNOPSIS
1512 	bfd_error_handler_type _bfd_set_error_handler_caching (bfd *);
1513 
1514 DESCRIPTION
1515 	Set the BFD error handler function to one that stores messages
1516 	to the per_xvec_warn array.  Returns the previous function.
1517 */
1518 
1519 bfd_error_handler_type
1520 _bfd_set_error_handler_caching (bfd *abfd)
1521 {
1522   error_handler_bfd = abfd;
1523   return bfd_set_error_handler (error_handler_sprintf);
1524 }
1525 
1526 /*
1527 FUNCTION
1528 	bfd_set_error_program_name
1529 
1530 SYNOPSIS
1531 	void bfd_set_error_program_name (const char *);
1532 
1533 DESCRIPTION
1534 	Set the program name to use when printing a BFD error.  This
1535 	is printed before the error message followed by a colon and
1536 	space.  The string must not be changed after it is passed to
1537 	this function.
1538 */
1539 
1540 void
1541 bfd_set_error_program_name (const char *name)
1542 {
1543   _bfd_error_program_name = name;
1544 }
1545 
1546 /*
1547 INTERNAL_FUNCTION
1548 	_bfd_get_error_program_name
1549 
1550 SYNOPSIS
1551 	const char *_bfd_get_error_program_name (void);
1552 
1553 DESCRIPTION
1554 	Get the program name used when printing a BFD error.
1555 */
1556 
1557 const char *
1558 _bfd_get_error_program_name (void)
1559 {
1560   if (_bfd_error_program_name != NULL)
1561     return _bfd_error_program_name;
1562   return "BFD";
1563 }
1564 
1565 /*
1566 SUBSECTION
1567 	BFD assert handler
1568 
1569 	If BFD finds an internal inconsistency, the bfd assert
1570 	handler is called with information on the BFD version, BFD
1571 	source file and line.  If this happens, most programs linked
1572 	against BFD are expected to want to exit with an error, or mark
1573 	the current BFD operation as failed, so it is recommended to
1574 	override the default handler, which just calls
1575 	_bfd_error_handler and continues.
1576 
1577 CODE_FRAGMENT
1578 .
1579 .typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
1580 .					  const char *bfd_version,
1581 .					  const char *bfd_file,
1582 .					  int bfd_line);
1583 .
1584 */
1585 
1586 /* Note the use of bfd_ prefix on the parameter names above: we want to
1587    show which one is the message and which is the version by naming the
1588    parameters, but avoid polluting the program-using-bfd namespace as
1589    the typedef is visible in the exported headers that the program
1590    includes.  Below, it's just for consistency.  */
1591 
1592 static void
1593 _bfd_default_assert_handler (const char *bfd_formatmsg,
1594 			     const char *bfd_version,
1595 			     const char *bfd_file,
1596 			     int bfd_line)
1597 
1598 {
1599   _bfd_error_handler (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
1600 }
1601 
1602 /* Similar to _bfd_error_handler, a program can decide to exit on an
1603    internal BFD error.  We use a non-variadic type to simplify passing
1604    on parameters to other functions, e.g. _bfd_error_handler.  */
1605 
1606 static bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
1607 
1608 /*
1609 FUNCTION
1610 	bfd_set_assert_handler
1611 
1612 SYNOPSIS
1613 	bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
1614 
1615 DESCRIPTION
1616 	Set the BFD assert handler function.  Returns the previous
1617 	function.
1618 */
1619 
1620 bfd_assert_handler_type
1621 bfd_set_assert_handler (bfd_assert_handler_type pnew)
1622 {
1623   bfd_assert_handler_type pold;
1624 
1625   pold = _bfd_assert_handler;
1626   _bfd_assert_handler = pnew;
1627   return pold;
1628 }
1629 
1630 /*
1631 INODE
1632 Miscellaneous, Memory Usage, Error reporting, BFD front end
1633 
1634 SECTION
1635 	Miscellaneous
1636 
1637 SUBSECTION
1638 	Miscellaneous functions
1639 */
1640 
1641 /*
1642 FUNCTION
1643 	bfd_get_reloc_upper_bound
1644 
1645 SYNOPSIS
1646 	long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
1647 
1648 DESCRIPTION
1649 	Return the number of bytes required to store the
1650 	relocation information associated with section @var{sect}
1651 	attached to bfd @var{abfd}.  If an error occurs, return -1.
1652 
1653 */
1654 
1655 long
1656 bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
1657 {
1658   if (abfd->format != bfd_object)
1659     {
1660       bfd_set_error (bfd_error_invalid_operation);
1661       return -1;
1662     }
1663 
1664   return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
1665 }
1666 
1667 /*
1668 FUNCTION
1669 	bfd_canonicalize_reloc
1670 
1671 SYNOPSIS
1672 	long bfd_canonicalize_reloc
1673 	  (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
1674 
1675 DESCRIPTION
1676 	Call the back end associated with the open BFD
1677 	@var{abfd} and translate the external form of the relocation
1678 	information attached to @var{sec} into the internal canonical
1679 	form.  Place the table into memory at @var{loc}, which has
1680 	been preallocated, usually by a call to
1681 	<<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or
1682 	-1 on error.
1683 
1684 	The @var{syms} table is also needed for horrible internal magic
1685 	reasons.
1686 
1687 */
1688 long
1689 bfd_canonicalize_reloc (bfd *abfd,
1690 			sec_ptr asect,
1691 			arelent **location,
1692 			asymbol **symbols)
1693 {
1694   if (abfd->format != bfd_object)
1695     {
1696       bfd_set_error (bfd_error_invalid_operation);
1697       return -1;
1698     }
1699 
1700   return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1701 		   (abfd, asect, location, symbols));
1702 }
1703 
1704 /*
1705 FUNCTION
1706 	bfd_set_reloc
1707 
1708 SYNOPSIS
1709 	void bfd_set_reloc
1710 	  (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
1711 
1712 DESCRIPTION
1713 	Set the relocation pointer and count within
1714 	section @var{sec} to the values @var{rel} and @var{count}.
1715 	The argument @var{abfd} is ignored.
1716 
1717 .#define bfd_set_reloc(abfd, asect, location, count) \
1718 .	BFD_SEND (abfd, _bfd_set_reloc, (abfd, asect, location, count))
1719 */
1720 
1721 /*
1722 FUNCTION
1723 	bfd_set_file_flags
1724 
1725 SYNOPSIS
1726 	bool bfd_set_file_flags (bfd *abfd, flagword flags);
1727 
1728 DESCRIPTION
1729 	Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1730 
1731 	Possible errors are:
1732 	o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1733 	o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1734 	o <<bfd_error_invalid_operation>> -
1735 	The flag word contained a bit which was not applicable to the
1736 	type of file.  E.g., an attempt was made to set the <<D_PAGED>> bit
1737 	on a BFD format which does not support demand paging.
1738 
1739 */
1740 
1741 bool
1742 bfd_set_file_flags (bfd *abfd, flagword flags)
1743 {
1744   if (abfd->format != bfd_object)
1745     {
1746       bfd_set_error (bfd_error_wrong_format);
1747       return false;
1748     }
1749 
1750   if (bfd_read_p (abfd))
1751     {
1752       bfd_set_error (bfd_error_invalid_operation);
1753       return false;
1754     }
1755 
1756   abfd->flags = flags;
1757   if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1758     {
1759       bfd_set_error (bfd_error_invalid_operation);
1760       return false;
1761     }
1762 
1763   return true;
1764 }
1765 
1766 void
1767 bfd_assert (const char *file, int line)
1768 {
1769   /* xgettext:c-format */
1770   (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1771 			  BFD_VERSION_STRING, file, line);
1772 }
1773 
1774 /* A more or less friendly abort message.  In libbfd.h abort is
1775    defined to call this function.  */
1776 
1777 void
1778 _bfd_abort (const char *file, int line, const char *fn)
1779 {
1780   if (fn != NULL)
1781     _bfd_error_handler
1782       /* xgettext:c-format */
1783       (_("BFD %s internal error, aborting at %s:%d in %s\n"),
1784        BFD_VERSION_STRING, file, line, fn);
1785   else
1786     _bfd_error_handler
1787       /* xgettext:c-format */
1788       (_("BFD %s internal error, aborting at %s:%d\n"),
1789        BFD_VERSION_STRING, file, line);
1790   _bfd_error_handler (_("Please report this bug.\n"));
1791   _exit (EXIT_FAILURE);
1792 }
1793 
1794 /*
1795 FUNCTION
1796 	bfd_get_arch_size
1797 
1798 SYNOPSIS
1799 	int bfd_get_arch_size (bfd *abfd);
1800 
1801 DESCRIPTION
1802 	Returns the normalized architecture address size, in bits, as
1803 	determined by the object file's format.  By normalized, we mean
1804 	either 32 or 64.  For ELF, this information is included in the
1805 	header.  Use bfd_arch_bits_per_address for number of bits in
1806 	the architecture address.
1807 
1808 RETURNS
1809 	Returns the arch size in bits if known, <<-1>> otherwise.
1810 */
1811 
1812 int
1813 bfd_get_arch_size (bfd *abfd)
1814 {
1815   if (abfd->xvec->flavour == bfd_target_elf_flavour)
1816     return get_elf_backend_data (abfd)->s->arch_size;
1817 
1818   return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
1819 }
1820 
1821 /*
1822 FUNCTION
1823 	bfd_get_sign_extend_vma
1824 
1825 SYNOPSIS
1826 	int bfd_get_sign_extend_vma (bfd *abfd);
1827 
1828 DESCRIPTION
1829 	Indicates if the target architecture "naturally" sign extends
1830 	an address.  Some architectures implicitly sign extend address
1831 	values when they are converted to types larger than the size
1832 	of an address.  For instance, bfd_get_start_address() will
1833 	return an address sign extended to fill a bfd_vma when this is
1834 	the case.
1835 
1836 RETURNS
1837 	Returns <<1>> if the target architecture is known to sign
1838 	extend addresses, <<0>> if the target architecture is known to
1839 	not sign extend addresses, and <<-1>> otherwise.
1840 */
1841 
1842 int
1843 bfd_get_sign_extend_vma (bfd *abfd)
1844 {
1845   const char *name;
1846 
1847   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1848     return get_elf_backend_data (abfd)->sign_extend_vma;
1849 
1850   name = bfd_get_target (abfd);
1851 
1852   /* Return a proper value for DJGPP & PE COFF.
1853      This function is required for DWARF2 support, but there is
1854      no place to store this information in the COFF back end.
1855      Should enough other COFF targets add support for DWARF2,
1856      a place will have to be found.  Until then, this hack will do.  */
1857   if (startswith (name, "coff-go32")
1858       || strcmp (name, "pe-i386") == 0
1859       || strcmp (name, "pei-i386") == 0
1860       || strcmp (name, "pe-x86-64") == 0
1861       || strcmp (name, "pei-x86-64") == 0
1862       || strcmp (name, "pe-aarch64-little") == 0
1863       || strcmp (name, "pei-aarch64-little") == 0
1864       || strcmp (name, "pe-arm-wince-little") == 0
1865       || strcmp (name, "pei-arm-wince-little") == 0
1866       || strcmp (name, "pei-loongarch64") == 0
1867       || strcmp (name, "aixcoff-rs6000") == 0
1868       || strcmp (name, "aix5coff64-rs6000") == 0)
1869     return 1;
1870 
1871   if (startswith (name, "mach-o"))
1872     return 0;
1873 
1874   bfd_set_error (bfd_error_wrong_format);
1875   return -1;
1876 }
1877 
1878 /*
1879 FUNCTION
1880 	bfd_set_start_address
1881 
1882 SYNOPSIS
1883 	bool bfd_set_start_address (bfd *abfd, bfd_vma vma);
1884 
1885 DESCRIPTION
1886 	Make @var{vma} the entry point of output BFD @var{abfd}.
1887 
1888 RETURNS
1889 	Returns <<TRUE>> on success, <<FALSE>> otherwise.
1890 */
1891 
1892 bool
1893 bfd_set_start_address (bfd *abfd, bfd_vma vma)
1894 {
1895   abfd->start_address = vma;
1896   return true;
1897 }
1898 
1899 /*
1900 FUNCTION
1901 	bfd_get_gp_size
1902 
1903 SYNOPSIS
1904 	unsigned int bfd_get_gp_size (bfd *abfd);
1905 
1906 DESCRIPTION
1907 	Return the maximum size of objects to be optimized using the GP
1908 	register under MIPS ECOFF.  This is typically set by the <<-G>>
1909 	argument to the compiler, assembler or linker.
1910 */
1911 
1912 unsigned int
1913 bfd_get_gp_size (bfd *abfd)
1914 {
1915   if (abfd->format == bfd_object)
1916     {
1917       if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1918 	return ecoff_data (abfd)->gp_size;
1919       else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1920 	return elf_gp_size (abfd);
1921     }
1922   return 0;
1923 }
1924 
1925 /*
1926 FUNCTION
1927 	bfd_set_gp_size
1928 
1929 SYNOPSIS
1930 	void bfd_set_gp_size (bfd *abfd, unsigned int i);
1931 
1932 DESCRIPTION
1933 	Set the maximum size of objects to be optimized using the GP
1934 	register under ECOFF or MIPS ELF.  This is typically set by
1935 	the <<-G>> argument to the compiler, assembler or linker.
1936 */
1937 
1938 void
1939 bfd_set_gp_size (bfd *abfd, unsigned int i)
1940 {
1941   /* Don't try to set GP size on an archive or core file!  */
1942   if (abfd->format != bfd_object)
1943     return;
1944 
1945   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1946     ecoff_data (abfd)->gp_size = i;
1947   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1948     elf_gp_size (abfd) = i;
1949 }
1950 
1951 /* Get the GP value.  This is an internal function used by some of the
1952    relocation special_function routines on targets which support a GP
1953    register.  */
1954 
1955 bfd_vma
1956 _bfd_get_gp_value (bfd *abfd)
1957 {
1958   if (! abfd)
1959     return 0;
1960   if (abfd->format != bfd_object)
1961     return 0;
1962 
1963   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1964     return ecoff_data (abfd)->gp;
1965   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1966     return elf_gp (abfd);
1967 
1968   return 0;
1969 }
1970 
1971 /* Set the GP value.  */
1972 
1973 void
1974 _bfd_set_gp_value (bfd *abfd, bfd_vma v)
1975 {
1976   if (! abfd)
1977     abort ();
1978   if (abfd->format != bfd_object)
1979     return;
1980 
1981   if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1982     ecoff_data (abfd)->gp = v;
1983   else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1984     elf_gp (abfd) = v;
1985 }
1986 
1987 /*
1988 FUNCTION
1989 	bfd_set_gp_value
1990 
1991 SYNOPSIS
1992 	void bfd_set_gp_value (bfd *abfd, bfd_vma v);
1993 
1994 DESCRIPTION
1995 	Allow external access to the fucntion to set the GP value.
1996 	This is specifically added for gdb-compile support.
1997 */
1998 
1999 void
2000 bfd_set_gp_value (bfd *abfd, bfd_vma v)
2001 {
2002   _bfd_set_gp_value (abfd, v);
2003 }
2004 
2005 /*
2006 FUNCTION
2007 	bfd_scan_vma
2008 
2009 SYNOPSIS
2010 	bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
2011 
2012 DESCRIPTION
2013 	Convert, like <<strtoul>>, a numerical expression
2014 	@var{string} into a <<bfd_vma>> integer, and return that integer.
2015 	(Though without as many bells and whistles as <<strtoul>>.)
2016 	The expression is assumed to be unsigned (i.e., positive).
2017 	If given a @var{base}, it is used as the base for conversion.
2018 	A base of 0 causes the function to interpret the string
2019 	in hex if a leading "0x" or "0X" is found, otherwise
2020 	in octal if a leading zero is found, otherwise in decimal.
2021 
2022 	If the value would overflow, the maximum <<bfd_vma>> value is
2023 	returned.
2024 */
2025 
2026 bfd_vma
2027 bfd_scan_vma (const char *string, const char **end, int base)
2028 {
2029   bfd_vma value;
2030   bfd_vma cutoff;
2031   unsigned int cutlim;
2032   int overflow;
2033 
2034   /* Let the host do it if possible.  */
2035   if (sizeof (bfd_vma) <= sizeof (unsigned long))
2036     return strtoul (string, (char **) end, base);
2037 
2038   if (sizeof (bfd_vma) <= sizeof (unsigned long long))
2039     return strtoull (string, (char **) end, base);
2040 
2041   if (base == 0)
2042     {
2043       if (string[0] == '0')
2044 	{
2045 	  if ((string[1] == 'x') || (string[1] == 'X'))
2046 	    base = 16;
2047 	  else
2048 	    base = 8;
2049 	}
2050     }
2051 
2052   if ((base < 2) || (base > 36))
2053     base = 10;
2054 
2055   if (base == 16
2056       && string[0] == '0'
2057       && (string[1] == 'x' || string[1] == 'X')
2058       && ISXDIGIT (string[2]))
2059     {
2060       string += 2;
2061     }
2062 
2063   cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
2064   cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
2065   value = 0;
2066   overflow = 0;
2067   while (1)
2068     {
2069       unsigned int digit;
2070 
2071       digit = *string;
2072       if (ISDIGIT (digit))
2073 	digit = digit - '0';
2074       else if (ISALPHA (digit))
2075 	digit = TOUPPER (digit) - 'A' + 10;
2076       else
2077 	break;
2078       if (digit >= (unsigned int) base)
2079 	break;
2080       if (value > cutoff || (value == cutoff && digit > cutlim))
2081 	overflow = 1;
2082       value = value * base + digit;
2083       ++string;
2084     }
2085 
2086   if (overflow)
2087     value = ~ (bfd_vma) 0;
2088 
2089   if (end != NULL)
2090     *end = string;
2091 
2092   return value;
2093 }
2094 
2095 /*
2096 FUNCTION
2097 	bfd_copy_private_header_data
2098 
2099 SYNOPSIS
2100 	bool bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
2101 
2102 DESCRIPTION
2103 	Copy private BFD header information from the BFD @var{ibfd} to the
2104 	the BFD @var{obfd}.  This copies information that may require
2105 	sections to exist, but does not require symbol tables.  Return
2106 	<<true>> on success, <<false>> on error.
2107 	Possible error returns are:
2108 
2109 	o <<bfd_error_no_memory>> -
2110 	Not enough memory exists to create private data for @var{obfd}.
2111 
2112 .#define bfd_copy_private_header_data(ibfd, obfd) \
2113 .	BFD_SEND (obfd, _bfd_copy_private_header_data, \
2114 .		  (ibfd, obfd))
2115 
2116 */
2117 
2118 /*
2119 FUNCTION
2120 	bfd_copy_private_bfd_data
2121 
2122 SYNOPSIS
2123 	bool bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
2124 
2125 DESCRIPTION
2126 	Copy private BFD information from the BFD @var{ibfd} to the
2127 	the BFD @var{obfd}.  Return <<TRUE>> on success, <<FALSE>> on error.
2128 	Possible error returns are:
2129 
2130 	o <<bfd_error_no_memory>> -
2131 	Not enough memory exists to create private data for @var{obfd}.
2132 
2133 .#define bfd_copy_private_bfd_data(ibfd, obfd) \
2134 .	BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
2135 .		  (ibfd, obfd))
2136 
2137 */
2138 
2139 /*
2140 FUNCTION
2141 	bfd_set_private_flags
2142 
2143 SYNOPSIS
2144 	bool bfd_set_private_flags (bfd *abfd, flagword flags);
2145 
2146 DESCRIPTION
2147 	Set private BFD flag information in the BFD @var{abfd}.
2148 	Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
2149 	returns are:
2150 
2151 	o <<bfd_error_no_memory>> -
2152 	Not enough memory exists to create private data for @var{obfd}.
2153 
2154 .#define bfd_set_private_flags(abfd, flags) \
2155 .	BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
2156 
2157 */
2158 
2159 /*
2160 FUNCTION
2161 	Other functions
2162 
2163 DESCRIPTION
2164 	The following functions exist but have not yet been documented.
2165 
2166 .#define bfd_sizeof_headers(abfd, info) \
2167 .	BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
2168 .
2169 .#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
2170 .	BFD_SEND (abfd, _bfd_find_nearest_line, \
2171 .		  (abfd, syms, sec, off, file, func, line, NULL))
2172 .
2173 .#define bfd_find_nearest_line_with_alt(abfd, alt_filename, sec, syms, off, \
2174 .					file, func, line, disc) \
2175 .	BFD_SEND (abfd, _bfd_find_nearest_line_with_alt, \
2176 .		  (abfd, alt_filename, syms, sec, off, file, func, line, disc))
2177 .
2178 .#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
2179 .					    line, disc) \
2180 .	BFD_SEND (abfd, _bfd_find_nearest_line, \
2181 .		  (abfd, syms, sec, off, file, func, line, disc))
2182 .
2183 .#define bfd_find_line(abfd, syms, sym, file, line) \
2184 .	BFD_SEND (abfd, _bfd_find_line, \
2185 .		  (abfd, syms, sym, file, line))
2186 .
2187 .#define bfd_find_inliner_info(abfd, file, func, line) \
2188 .	BFD_SEND (abfd, _bfd_find_inliner_info, \
2189 .		  (abfd, file, func, line))
2190 .
2191 .#define bfd_debug_info_start(abfd) \
2192 .	BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
2193 .
2194 .#define bfd_debug_info_end(abfd) \
2195 .	BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
2196 .
2197 .#define bfd_debug_info_accumulate(abfd, section) \
2198 .	BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
2199 .
2200 .#define bfd_stat_arch_elt(abfd, stat) \
2201 .	BFD_SEND (abfd->my_archive ? abfd->my_archive : abfd, \
2202 .		  _bfd_stat_arch_elt, (abfd, stat))
2203 .
2204 .#define bfd_update_armap_timestamp(abfd) \
2205 .	BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
2206 .
2207 .#define bfd_set_arch_mach(abfd, arch, mach)\
2208 .	BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
2209 .
2210 .#define bfd_relax_section(abfd, section, link_info, again) \
2211 .	BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
2212 .
2213 .#define bfd_gc_sections(abfd, link_info) \
2214 .	BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
2215 .
2216 .#define bfd_lookup_section_flags(link_info, flag_info, section) \
2217 .	BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
2218 .
2219 .#define bfd_merge_sections(abfd, link_info) \
2220 .	BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
2221 .
2222 .#define bfd_is_group_section(abfd, sec) \
2223 .	BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
2224 .
2225 .#define bfd_group_name(abfd, sec) \
2226 .	BFD_SEND (abfd, _bfd_group_name, (abfd, sec))
2227 .
2228 .#define bfd_discard_group(abfd, sec) \
2229 .	BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
2230 .
2231 .#define bfd_link_hash_table_create(abfd) \
2232 .	BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
2233 .
2234 .#define bfd_link_add_symbols(abfd, info) \
2235 .	BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
2236 .
2237 .#define bfd_link_just_syms(abfd, sec, info) \
2238 .	BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
2239 .
2240 .#define bfd_final_link(abfd, info) \
2241 .	BFD_SEND (abfd, _bfd_final_link, (abfd, info))
2242 .
2243 .#define bfd_free_cached_info(abfd) \
2244 .	BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
2245 .
2246 .#define bfd_get_dynamic_symtab_upper_bound(abfd) \
2247 .	BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
2248 .
2249 .#define bfd_print_private_bfd_data(abfd, file)\
2250 .	BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
2251 .
2252 .#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
2253 .	BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
2254 .
2255 .#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
2256 .	BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
2257 .						    dyncount, dynsyms, ret))
2258 .
2259 .#define bfd_get_dynamic_reloc_upper_bound(abfd) \
2260 .	BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
2261 .
2262 .#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
2263 .	BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
2264 .
2265 .extern bfd_byte *bfd_get_relocated_section_contents
2266 .  (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
2267 .   bool, asymbol **);
2268 .
2269 
2270 */
2271 
2272 bfd_byte *
2273 bfd_get_relocated_section_contents (bfd *abfd,
2274 				    struct bfd_link_info *link_info,
2275 				    struct bfd_link_order *link_order,
2276 				    bfd_byte *data,
2277 				    bool relocatable,
2278 				    asymbol **symbols)
2279 {
2280   bfd *abfd2;
2281   bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
2282 		   bfd_byte *, bool, asymbol **);
2283 
2284   if (link_order->type == bfd_indirect_link_order)
2285     {
2286       abfd2 = link_order->u.indirect.section->owner;
2287       if (abfd2 == NULL)
2288 	abfd2 = abfd;
2289     }
2290   else
2291     abfd2 = abfd;
2292 
2293   fn = abfd2->xvec->_bfd_get_relocated_section_contents;
2294 
2295   return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
2296 }
2297 
2298 /* Record information about an ELF program header.  */
2299 
2300 bool
2301 bfd_record_phdr (bfd *abfd,
2302 		 unsigned long type,
2303 		 bool flags_valid,
2304 		 flagword flags,
2305 		 bool at_valid,
2306 		 bfd_vma at,  /* Bytes.  */
2307 		 bool includes_filehdr,
2308 		 bool includes_phdrs,
2309 		 unsigned int count,
2310 		 asection **secs)
2311 {
2312   struct elf_segment_map *m, **pm;
2313   size_t amt;
2314   unsigned int opb = bfd_octets_per_byte (abfd, NULL);
2315 
2316   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
2317     return true;
2318 
2319   amt = sizeof (struct elf_segment_map);
2320   amt += ((bfd_size_type) count - 1) * sizeof (asection *);
2321   m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
2322   if (m == NULL)
2323     return false;
2324 
2325   m->p_type = type;
2326   m->p_flags = flags;
2327   m->p_paddr = at * opb;
2328   m->p_flags_valid = flags_valid;
2329   m->p_paddr_valid = at_valid;
2330   m->includes_filehdr = includes_filehdr;
2331   m->includes_phdrs = includes_phdrs;
2332   m->count = count;
2333   if (count > 0)
2334     memcpy (m->sections, secs, count * sizeof (asection *));
2335 
2336   for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
2337     ;
2338   *pm = m;
2339 
2340   return true;
2341 }
2342 
2343 #ifdef BFD64
2344 /* Return true iff this target is 32-bit.  */
2345 
2346 static bool
2347 is32bit (bfd *abfd)
2348 {
2349   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2350     {
2351       const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2352       return bed->s->elfclass == ELFCLASS32;
2353     }
2354 
2355   /* For non-ELF targets, use architecture information.  */
2356   return bfd_arch_bits_per_address (abfd) <= 32;
2357 }
2358 #endif
2359 
2360 /* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
2361    target's address size.  */
2362 
2363 void
2364 bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
2365 {
2366 #ifdef BFD64
2367   if (!is32bit (abfd))
2368     {
2369       sprintf (buf, "%016" PRIx64, (uint64_t) value);
2370       return;
2371     }
2372 #endif
2373   sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
2374 }
2375 
2376 void
2377 bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
2378 {
2379 #ifdef BFD64
2380   if (!is32bit (abfd))
2381     {
2382       fprintf ((FILE *) stream, "%016" PRIx64, (uint64_t) value);
2383       return;
2384     }
2385 #endif
2386   fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
2387 }
2388 
2389 /*
2390 FUNCTION
2391 	bfd_alt_mach_code
2392 
2393 SYNOPSIS
2394 	bool bfd_alt_mach_code (bfd *abfd, int alternative);
2395 
2396 DESCRIPTION
2397 
2398 	When more than one machine code number is available for the
2399 	same machine type, this function can be used to switch between
2400 	the preferred one (alternative == 0) and any others.  Currently,
2401 	only ELF supports this feature, with up to two alternate
2402 	machine codes.
2403 */
2404 
2405 bool
2406 bfd_alt_mach_code (bfd *abfd, int alternative)
2407 {
2408   if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2409     {
2410       int code;
2411 
2412       switch (alternative)
2413 	{
2414 	case 0:
2415 	  code = get_elf_backend_data (abfd)->elf_machine_code;
2416 	  break;
2417 
2418 	case 1:
2419 	  code = get_elf_backend_data (abfd)->elf_machine_alt1;
2420 	  if (code == 0)
2421 	    return false;
2422 	  break;
2423 
2424 	case 2:
2425 	  code = get_elf_backend_data (abfd)->elf_machine_alt2;
2426 	  if (code == 0)
2427 	    return false;
2428 	  break;
2429 
2430 	default:
2431 	  return false;
2432 	}
2433 
2434       elf_elfheader (abfd)->e_machine = code;
2435 
2436       return true;
2437     }
2438 
2439   return false;
2440 }
2441 
2442 /*
2443 FUNCTION
2444 	bfd_emul_get_maxpagesize
2445 
2446 SYNOPSIS
2447 	bfd_vma bfd_emul_get_maxpagesize (const char *);
2448 
2449 DESCRIPTION
2450 	Returns the maximum page size, in bytes, as determined by
2451 	emulation.
2452 
2453 RETURNS
2454 	Returns the maximum page size in bytes for ELF, 0 otherwise.
2455 */
2456 
2457 bfd_vma
2458 bfd_emul_get_maxpagesize (const char *emul)
2459 {
2460   const bfd_target *target;
2461 
2462   target = bfd_find_target (emul, NULL);
2463   if (target != NULL
2464       && target->flavour == bfd_target_elf_flavour)
2465     return xvec_get_elf_backend_data (target)->maxpagesize;
2466 
2467   return 0;
2468 }
2469 
2470 /*
2471 FUNCTION
2472 	bfd_emul_get_commonpagesize
2473 
2474 SYNOPSIS
2475 	bfd_vma bfd_emul_get_commonpagesize (const char *);
2476 
2477 DESCRIPTION
2478 	Returns the common page size, in bytes, as determined by
2479 	emulation.
2480 
2481 RETURNS
2482 	Returns the common page size in bytes for ELF, 0 otherwise.
2483 */
2484 
2485 bfd_vma
2486 bfd_emul_get_commonpagesize (const char *emul)
2487 {
2488   const bfd_target *target;
2489 
2490   target = bfd_find_target (emul, NULL);
2491   if (target != NULL
2492       && target->flavour == bfd_target_elf_flavour)
2493     {
2494       const struct elf_backend_data *bed;
2495 
2496       bed = xvec_get_elf_backend_data (target);
2497       return bed->commonpagesize;
2498     }
2499   return 0;
2500 }
2501 
2502 /*
2503 FUNCTION
2504 	bfd_demangle
2505 
2506 SYNOPSIS
2507 	char *bfd_demangle (bfd *, const char *, int);
2508 
2509 DESCRIPTION
2510 	Wrapper around cplus_demangle.  Strips leading underscores and
2511 	other such chars that would otherwise confuse the demangler.
2512 	If passed a g++ v3 ABI mangled name, returns a buffer allocated
2513 	with malloc holding the demangled name.  Returns NULL otherwise
2514 	and on memory alloc failure.
2515 */
2516 
2517 char *
2518 bfd_demangle (bfd *abfd, const char *name, int options)
2519 {
2520   char *res, *alloc;
2521   const char *pre, *suf;
2522   size_t pre_len;
2523   bool skip_lead;
2524 
2525   skip_lead = (abfd != NULL
2526 	       && *name != '\0'
2527 	       && bfd_get_symbol_leading_char (abfd) == *name);
2528   if (skip_lead)
2529     ++name;
2530 
2531   /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
2532      or the MS PE format.  These formats have a number of leading '.'s
2533      on at least some symbols, so we remove all dots to avoid
2534      confusing the demangler.  */
2535   pre = name;
2536   while (*name == '.' || *name == '$')
2537     ++name;
2538   pre_len = name - pre;
2539 
2540   /* Strip off @plt and suchlike too.  */
2541   alloc = NULL;
2542   suf = strchr (name, '@');
2543   if (suf != NULL)
2544     {
2545       alloc = (char *) bfd_malloc (suf - name + 1);
2546       if (alloc == NULL)
2547 	return NULL;
2548       memcpy (alloc, name, suf - name);
2549       alloc[suf - name] = '\0';
2550       name = alloc;
2551     }
2552 
2553   res = cplus_demangle (name, options);
2554 
2555   free (alloc);
2556 
2557   if (res == NULL)
2558     {
2559       if (skip_lead)
2560 	{
2561 	  size_t len = strlen (pre) + 1;
2562 	  alloc = (char *) bfd_malloc (len);
2563 	  if (alloc == NULL)
2564 	    return NULL;
2565 	  memcpy (alloc, pre, len);
2566 	  return alloc;
2567 	}
2568       return NULL;
2569     }
2570 
2571   /* Put back any prefix or suffix.  */
2572   if (pre_len != 0 || suf != NULL)
2573     {
2574       size_t len;
2575       size_t suf_len;
2576       char *final;
2577 
2578       len = strlen (res);
2579       if (suf == NULL)
2580 	suf = res + len;
2581       suf_len = strlen (suf) + 1;
2582       final = (char *) bfd_malloc (pre_len + len + suf_len);
2583       if (final != NULL)
2584 	{
2585 	  memcpy (final, pre, pre_len);
2586 	  memcpy (final + pre_len, res, len);
2587 	  memcpy (final + pre_len + len, suf, suf_len);
2588 	}
2589       free (res);
2590       res = final;
2591     }
2592 
2593   return res;
2594 }
2595 
2596 /* Get the linker information.  */
2597 
2598 struct bfd_link_info *
2599 _bfd_get_link_info (bfd *abfd)
2600 {
2601   if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
2602     return NULL;
2603 
2604   return elf_link_info (abfd);
2605 }
2606