bfd/bfd.c

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