/* Generic BFD library interface and support routines.

   Copyright (C) 1990-2026 Free Software Foundation, Inc.

   Written by Cygnus Support.

   This file is part of BFD, the Binary File Descriptor library.

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 3 of the License, or

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,

   MA 02110-1301, USA.  */

/*

INODE

typedef bfd, Error reporting, BFD front end, BFD front end

SECTION

  <<typedef bfd>>

  A BFD has type <<bfd>>; objects of this type are the

  cornerstone of any application using BFD. Using BFD

  consists of making references though the BFD and to data in the BFD.

  Here is the structure that defines the type <<bfd>>.  It

  contains the major data about the file and pointers

  to the rest of the data.

EXTERNAL

.typedef enum bfd_format

.  {

.    bfd_unknown = 0, {* File format is unknown.  *}

.    bfd_object,  {* Linker/assembler/compiler output.  *}

.    bfd_archive, {* Object archive file.  *}

.    bfd_core,    {* Core dump.  *}

.    bfd_type_end {* Marks the end; don't use it!  *}

.  }

.bfd_format;

.

.enum bfd_direction

.  {

.    no_direction = 0,

.    read_direction = 1,

.    write_direction = 2,

.    both_direction = 3

.  };

.

.enum bfd_last_io

.  {

.    bfd_io_seek = 0,

.    bfd_io_read = 1,

.    bfd_io_write = 2,

.    bfd_io_force = 3

.  };

.

.enum bfd_plugin_format

.  {

.    bfd_plugin_unknown = 0,

.    bfd_plugin_yes = 1,

.    bfd_plugin_yes_unused = 2,

.    bfd_plugin_no = 3

.  };

.

.struct bfd_build_id

.  {

.    bfd_size_type size;

.    bfd_byte data[1];

.  };

.

.enum bfd_lto_object_type

.  {

.    lto_non_object,    {* Not an LTO object.  *}

.    lto_non_ir_object,   {* An object without LTO IR.  *}

.    lto_slim_ir_object,  {* A slim LTO IR object.  *}

.    lto_fat_ir_object,   {* A fat LTO IR object.  *}

.    lto_mixed_object   {* A mixed LTO IR object.  *}

.  };

.

.struct bfd_mmapped_entry

.  {

.    void *addr;

.    size_t size;

.  };

.

.struct bfd_mmapped

.  {

.    struct bfd_mmapped *next;

.    unsigned int max_entry;

.    unsigned int next_entry;

.    struct bfd_mmapped_entry entries[1];

.  };

.

CODE_FRAGMENT

.struct bfd

.{

.  {* The filename the application opened the BFD with.  *}

.  const char *filename;

.

.  {* A pointer to the target jump table.  *}

.  const struct bfd_target *xvec;

.

.  {* The IOSTREAM, and corresponding IO vector that provide access

.     to the file backing the BFD.  *}

.  void *iostream;

.  const struct bfd_iovec *iovec;

.

.  {* The caching routines use these to maintain a

.     least-recently-used list of BFDs.  *}

.  struct bfd *lru_prev, *lru_next;

.

.  {* Track current file position (or current buffer offset for

.     in-memory BFDs).  When a file is closed by the caching routines,

.     BFD retains state information on the file here.  *}

.  ufile_ptr where;

.

.  {* File modified time, if mtime_set is TRUE.  *}

.  long mtime;

.

.  {* A unique identifier of the BFD  *}

.  unsigned int id;

.

.  {* Format_specific flags.  *}

.  flagword flags;

.

.  {* Values that may appear in the flags field of a BFD.  These also

.     appear in the object_flags field of the bfd_target structure, where

.     they indicate the set of flags used by that backend (not all flags

.     are meaningful for all object file formats) (FIXME: at the moment,

.     the object_flags values have mostly just been copied from backend

.     to another, and are not necessarily correct).  *}

.

.#define BFD_NO_FLAGS                0x0

.

.  {* BFD contains relocation entries.  *}

.#define HAS_RELOC                   0x1

.

.  {* BFD is directly executable.  *}

.#define EXEC_P                      0x2

.

.  {* BFD has line number information (basically used for F_LNNO in a

.     COFF header).  *}

.#define HAS_LINENO                  0x4

.

.  {* BFD has debugging information.  *}

.#define HAS_DEBUG                  0x08

.

.  {* BFD has symbols.  *}

.#define HAS_SYMS                   0x10

.

.  {* BFD has local symbols (basically used for F_LSYMS in a COFF

.     header).  *}

.#define HAS_LOCALS                 0x20

.

.  {* BFD is a dynamic object.  *}

.#define DYNAMIC                    0x40

.

.  {* Text section is write protected (if D_PAGED is not set, this is

.     like an a.out NMAGIC file) (the linker sets this by default, but

.     clears it for -r or -N).  *}

.#define WP_TEXT                    0x80

.

.  {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the

.     linker sets this by default, but clears it for -r or -n or -N).  *}

.#define D_PAGED                   0x100

.

.  {* BFD is relaxable (this means that bfd_relax_section may be able to

.     do something) (sometimes bfd_relax_section can do something even if

.     this is not set).  *}

.#define BFD_IS_RELAXABLE          0x200

.

.  {* This may be set before writing out a BFD to request using a

.     traditional format.  For example, this is used to request that when

.     writing out an a.out object the symbols not be hashed to eliminate

.     duplicates.  *}

.#define BFD_TRADITIONAL_FORMAT    0x400

.

.  {* This flag indicates that the BFD contents are actually cached

.     in memory.  If this is set, iostream points to a malloc'd

.     bfd_in_memory struct.  *}

.#define BFD_IN_MEMORY             0x800

.

.  {* This BFD has been created by the linker and doesn't correspond

.     to any input file.  *}

.#define BFD_LINKER_CREATED       0x1000

.

.  {* This may be set before writing out a BFD to request that it

.     be written using values for UIDs, GIDs, timestamps, etc. that

.     will be consistent from run to run.  *}

.#define BFD_DETERMINISTIC_OUTPUT 0x2000

.

.  {* Compress sections in this BFD.  *}

.#define BFD_COMPRESS             0x4000

.

.  {* Decompress sections in this BFD.  *}

.#define BFD_DECOMPRESS           0x8000

.

.  {* BFD is a dummy, for plugins.  *}

.#define BFD_PLUGIN              0x10000

.

.  {* Compress sections in this BFD with SHF_COMPRESSED from gABI.  *}

.#define BFD_COMPRESS_GABI       0x20000

.

.  {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this

.     BFD.  *}

.#define BFD_CONVERT_ELF_COMMON  0x40000

.

.  {* Use the ELF STT_COMMON type in this BFD.  *}

.#define BFD_USE_ELF_STT_COMMON  0x80000

.

.  {* Put pathnames into archives (non-POSIX).  *}

.#define BFD_ARCHIVE_FULL_PATH  0x100000

.

.#define BFD_CLOSED_BY_CACHE    0x200000

.  {* Compress sections in this BFD with SHF_COMPRESSED zstd.  *}

.#define BFD_COMPRESS_ZSTD      0x400000

.

.  {* Don't generate ELF section header.  *}

.#define BFD_NO_SECTION_HEADER  0x800000

.

.  {* Flags bits which are for BFD use only.  *}

.#define BFD_FLAGS_FOR_BFD_USE_MASK \

.  (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \

.   | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \

.   | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON \

.   | BFD_NO_SECTION_HEADER)

.

.  {* The format which belongs to the BFD. (object, core, etc.)  *}

.  ENUM_BITFIELD (bfd_format) format : 3;

.

.  {* The direction with which the BFD was opened.  *}

.  ENUM_BITFIELD (bfd_direction) direction : 2;

.

.  {* POSIX.1-2017 (IEEE Std 1003.1) says of fopen : "When a file is

.     opened with update mode ('+' as the second or third character in

.     the mode argument), both input and output may be performed on

.     the associated stream.  However, the application shall ensure

.     that output is not directly followed by input without an

.     intervening call to fflush() or to a file positioning function

.     (fseek(), fsetpos(), or rewind()), and input is not directly

.     followed by output without an intervening call to a file

.     positioning function, unless the input operation encounters

.     end-of-file."

.     This field tracks the last IO operation, so that bfd can insert

.     a seek when IO direction changes.  *}

.  ENUM_BITFIELD (bfd_last_io) last_io : 2;

.

.  {* Is the file descriptor being cached?  That is, can it be closed as

.     needed, and re-opened when accessed later?  *}

.  unsigned int cacheable : 1;

.

.  {* Marks whether there was a default target specified when the

.     BFD was opened. This is used to select which matching algorithm

.     to use to choose the back end.  *}

.  unsigned int target_defaulted : 1;

.

.  {* ... and here: (``once'' means at least once).  *}

.  unsigned int opened_once : 1;

.

.  {* Set if we have a locally maintained mtime value, rather than

.     getting it from the file each time.  *}

.  unsigned int mtime_set : 1;

.

.  {* Flag set if symbols from this BFD should not be exported.  *}

.  unsigned int no_export : 1;

.

.  {* Remember when output has begun, to stop strange things

.     from happening.  *}

.  unsigned int output_has_begun : 1;

.

.  {* Have archive map.  *}

.  unsigned int has_armap : 1;

.

.  {* Accept a mapless archive for link.  *}

.  unsigned int link_mapless : 1;

.

.  {* Set if this is a thin archive.  *}

.  unsigned int is_thin_archive : 1;

.

.  {* Set if this is a collection of files pretending to be an archive.  *}

.  unsigned int is_fake_archive : 1;

.

.  {* Set if this archive should not cache element positions.  *}

.  unsigned int no_element_cache : 1;

.

.  {* Set if only required symbols should be added in the link hash table for

.     this object.  Used by VMS linkers.  *}

.  unsigned int selective_search : 1;

.

.  {* Set if this is the linker output BFD.  *}

.  unsigned int is_linker_output : 1;

.

.  {* Set if this is the linker input BFD.  *}

.  unsigned int is_linker_input : 1;

.

.  {* If this is an input for a compiler plug-in library.  *}

.  ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;

.

.  {* Set if this is a plugin output file.  *}

.  unsigned int lto_output : 1;

.

.  {* Do not attempt to modify this file.  Set when detecting errors

.     that BFD is not prepared to handle for objcopy/strip.  *}

.  unsigned int read_only : 1;

.

.  {* LTO object type.  *}

.  ENUM_BITFIELD (bfd_lto_object_type) lto_type : 3;

.

.  {* Set if this BFD is currently being processed by

.     bfd_check_format_matches.  This is checked by the cache to

.     avoid closing the BFD in this case.  This should only be

.     examined or modified while the BFD lock is held.  *}

.  unsigned int in_format_matches : 1;

.

.  {* Set to dummy BFD created when claimed by a compiler plug-in

.     library.  *}

.  bfd *plugin_dummy_bfd;

.

.  {* The offset of this bfd in the file, typically 0 if it is not

.     contained in an archive.  *}

.  ufile_ptr origin;

.

.  {* A reference in the archive for the proxy entry as follows:

.

.     1. For regular archives this will be the same as origin.

.

.     2. For thin archives it will contain the current offset

.  of the proxy in the thin archive rather than the offset

.  of the bfd in its actual container.

.

.     3. For fake archives it will contain the next archive member's

.  BFD reference or a NULL pointer if this is the last member.  *}

.  ufile_ptr_or_bfd proxy_handle;

.

.  {* A hash table for section names.  *}

.  struct bfd_hash_table section_htab;

.

.  {* Pointer to linked list of sections.  *}

.  struct bfd_section *sections;

.

.  {* The last section on the section list.  *}

.  struct bfd_section *section_last;

.

.  {* The object-only section on the section list.  *}

.  struct bfd_section *object_only_section;

.

.  {* The number of sections.  *}

.  unsigned int section_count;

.

.  {* The archive plugin file descriptor.  *}

.  int archive_plugin_fd;

.

.  {* The number of opens on the archive plugin file descriptor.  *}

.  unsigned int archive_plugin_fd_open_count;

.

.  {* A field used by _bfd_generic_link_add_archive_symbols.  This will

.     be used only for archive elements.  *}

.  int archive_pass;

.

.  {* The total size of memory from bfd_alloc.  *}

.  bfd_size_type alloc_size;

.

.  {* Stuff only useful for object files:

.     The start address.  *}

.  bfd_vma start_address;

.

.  {* Symbol table for output BFD (with symcount entries).

.     Also used by the linker to cache input BFD symbols.  *}

.  struct bfd_symbol **outsymbols;

.

.  {* Used for input and output.  *}

.  unsigned int symcount;

.

.  {* Used for slurped dynamic symbol tables.  *}

.  unsigned int dynsymcount;

.

.  {* Pointer to structure which contains architecture information.  *}

.  const struct bfd_arch_info *arch_info;

.

.  {* Cached length of file for bfd_get_size.  0 until bfd_get_size is

.     called, 1 if stat returns an error or the file size is too large to

.     return in ufile_ptr.  Both 0 and 1 should be treated as "unknown".  *}

.  ufile_ptr size;

.

.  {* Stuff only useful for archives.  *}

.  void *arelt_data;

.  struct bfd *my_archive;      {* The containing archive BFD.  *}

.  struct bfd *archive_next;    {* The next BFD in the archive.  *}

.  struct bfd *archive_head;    {* The first BFD in the archive.  *}

.  struct bfd *nested_archives; {* List of nested archive in a flattened

.          thin archive.  *}

.

.  union {

.    {* For input BFDs, a chain of BFDs involved in a link.  *}

.    struct bfd *next;

.    {* For output BFD, the linker hash table.  *}

.    struct bfd_link_hash_table *hash;

.  } link;

.

.  {* Used by the back end to hold private data.  *}

.  union

.    {

.      struct aout_data_struct *aout_data;

.      struct artdata *aout_ar_data;

.      struct coff_tdata *coff_obj_data;

.      struct pe_tdata *pe_obj_data;

.      struct xcoff_tdata *xcoff_obj_data;

.      struct ecoff_tdata *ecoff_obj_data;

.      struct srec_data_struct *srec_data;

.      struct verilog_data_struct *verilog_data;

.      struct ihex_data_struct *ihex_data;

.      struct tekhex_data_struct *tekhex_data;

.      struct elf_obj_tdata *elf_obj_data;

.      struct mmo_data_struct *mmo_data;

.      struct trad_core_struct *trad_core_data;

.      struct som_data_struct *som_data;

.      struct hpux_core_struct *hpux_core_data;

.      struct hppabsd_core_struct *hppabsd_core_data;

.      struct sgi_core_struct *sgi_core_data;

.      struct lynx_core_struct *lynx_core_data;

.      struct osf_core_struct *osf_core_data;

.      struct cisco_core_struct *cisco_core_data;

.      struct netbsd_core_struct *netbsd_core_data;

.      struct mach_o_data_struct *mach_o_data;

.      struct mach_o_fat_data_struct *mach_o_fat_data;

.      struct plugin_data_struct *plugin_data;

.      struct bfd_pef_data_struct *pef_data;

.      struct bfd_pef_xlib_data_struct *pef_xlib_data;

.      struct bfd_sym_data_struct *sym_data;

.      void *any;

.    }

.  tdata;

.

.  {* Used by the application to hold private data.  *}

.  void *usrdata;

.

.  {* Where all the allocated stuff under this BFD goes.  This is a

.     struct objalloc *, but we use void * to avoid requiring the inclusion

.     of objalloc.h.  *}

.  void *memory;

.

.  {* For input BFDs, the build ID, if the object has one. *}

.  const struct bfd_build_id *build_id;

.

.  {* For input BFDs, mmapped entries. *}

.  struct bfd_mmapped *mmapped;

.};

.

EXTERNAL

.static inline const char *

.bfd_get_filename (const bfd *abfd)

.{

.  return abfd->filename;

.}

.

.static inline bool

.bfd_get_cacheable (const bfd *abfd)

.{

.  return abfd->cacheable;

.}

.

.static inline enum bfd_format

.bfd_get_format (const bfd *abfd)

.{

.  return abfd->format;

.}

.

.static inline enum bfd_lto_object_type

.bfd_get_lto_type (const bfd *abfd)

.{

.  return abfd->lto_type;

.}

.

.static inline bool

.bfd_lto_slim_symbol_p (const bfd *abfd, const char *name)

.{

.  return (bfd_get_lto_type (abfd) != lto_non_ir_object

.    && name != NULL

.    && name[0] == '_'

.    && name[1] == '_'

.    && strcmp (name + (name[2] == '_'), "__gnu_lto_slim") == 0);

.}

.

.static inline flagword

.bfd_get_file_flags (const bfd *abfd)

.{

.  return abfd->flags;

.}

.

.static inline bfd_vma

.bfd_get_start_address (const bfd *abfd)

.{

.  return abfd->start_address;

.}

.

.static inline unsigned int

.bfd_get_symcount (const bfd *abfd)

.{

.  return abfd->symcount;

.}

.

.static inline unsigned int

.bfd_get_dynamic_symcount (const bfd *abfd)

.{

.  return abfd->dynsymcount;

.}

.

.static inline struct bfd_symbol **

.bfd_get_outsymbols (const bfd *abfd)

.{

.  return abfd->outsymbols;

.}

.

.static inline unsigned int

.bfd_count_sections (const bfd *abfd)

.{

.  return abfd->section_count;

.}

.

.static inline bool

.bfd_has_map (const bfd *abfd)

.{

.  return abfd->has_armap;

.}

.

.static inline bool

.bfd_link_mapless (const bfd *abfd)

.{

.  return abfd->link_mapless;

.}

.

.static inline bool

.bfd_is_thin_archive (const bfd *abfd)

.{

.  return abfd->is_thin_archive;

.}

.

.static inline bool

.bfd_is_fake_archive (const bfd *abfd)

.{

.  return abfd->is_fake_archive;

.}

.

.static inline void *

.bfd_usrdata (const bfd *abfd)

.{

.  return abfd->usrdata;

.}

.

.{* See note beside bfd_set_section_userdata.  *}

.static inline bool

.bfd_set_cacheable (bfd * abfd, bool val)

.{

.  abfd->cacheable = val;

.  return true;

.}

.

.static inline void

.bfd_set_link_mapless (bfd *abfd, bool val)

.{

.  abfd->link_mapless = val;

.}

.

.static inline void

.bfd_set_thin_archive (bfd *abfd, bool val)

.{

.  abfd->is_thin_archive = val;

.}

.

.static inline void

.bfd_set_fake_archive (bfd *abfd, bool val)

.{

.  abfd->is_fake_archive = val;

.}

.

.static inline void

.bfd_set_usrdata (bfd *abfd, void *val)

.{

.  abfd->usrdata = val;

.}

.

.static inline asection *

.bfd_asymbol_section (const asymbol *sy)

.{

.  return sy->section;

.}

.

.static inline bfd_vma

.bfd_asymbol_value (const asymbol *sy)

.{

.  return sy->section->vma + sy->value;

.}

.

.static inline const char *

.bfd_asymbol_name (const asymbol *sy)

.{

.  return sy->name;

.}

.

.static inline struct bfd *

.bfd_asymbol_bfd (const asymbol *sy)

.{

.  return sy->the_bfd;

.}

.

.static inline void

.bfd_set_asymbol_name (asymbol *sy, const char *name)

.{

.  sy->name = name;

.}

.

.{* For input sections return the original size on disk of the

.   section.  For output sections return the current size.  *}

.static inline bfd_size_type

.bfd_get_section_limit_octets (const bfd *abfd, const asection *sec)

.{

.  if (abfd->format != bfd_core && abfd->direction != write_direction

.      && sec->rawsize != 0)

.    return sec->rawsize;

.  return sec->size;

.}

.

.{* Find the address one past the end of SEC.  *}

.static inline bfd_size_type

.bfd_get_section_limit (const bfd *abfd, const asection *sec)

.{

.  return (bfd_get_section_limit_octets (abfd, sec)

.    / bfd_octets_per_byte (abfd, sec));

.}

.

.{* For input sections return the larger of the current size and the

.   original size on disk of the section.  For output sections return

.   the current size.  *}

.static inline bfd_size_type

.bfd_get_section_alloc_size (const bfd *abfd, const asection *sec)

.{

.  if (abfd->format != bfd_core && abfd->direction != write_direction

.      && sec->rawsize > sec->size)

.    return sec->rawsize;

.  return sec->size;

.}

.

.{* Functions to handle insertion and deletion of a bfd's sections.  These

.   only handle the list pointers, ie. do not adjust section_count,

.   target_index etc.  *}

.static inline void

.bfd_section_list_remove (bfd *abfd, asection *s)

.{

.  asection *next = s->next;

.  asection *prev = s->prev;

.  if (prev)

.    prev->next = next;

.  else

.    abfd->sections = next;

.  if (next)

.    next->prev = prev;

.  else

.    abfd->section_last = prev;

.}

.

.static inline void

.bfd_section_list_append (bfd *abfd, asection *s)

.{

.  s->next = 0;

.  if (abfd->section_last)

.    {

.      s->prev = abfd->section_last;

.      abfd->section_last->next = s;

.    }

.  else

.    {

.      s->prev = 0;

.      abfd->sections = s;

.    }

.  abfd->section_last = s;

.}

.

.static inline void

.bfd_section_list_prepend (bfd *abfd, asection *s)

.{

.  s->prev = 0;

.  if (abfd->sections)

.    {

.      s->next = abfd->sections;

.      abfd->sections->prev = s;

.    }

.  else

.    {

.      s->next = 0;

.      abfd->section_last = s;

.    }

.  abfd->sections = s;

.}

.

.static inline void

.bfd_section_list_insert_after (bfd *abfd, asection *a, asection *s)

.{

.  asection *next = a->next;

.  s->next = next;

.  s->prev = a;

.  a->next = s;

.  if (next)

.    next->prev = s;

.  else

.    abfd->section_last = s;

.}

.

.static inline void

.bfd_section_list_insert_before (bfd *abfd, asection *b, asection *s)

.{

.  asection *prev = b->prev;

.  s->prev = prev;

.  s->next = b;

.  b->prev = s;

.  if (prev)

.    prev->next = s;

.  else

.    abfd->sections = s;

.}

.

.static inline bool

.bfd_section_removed_from_list (const bfd *abfd, const asection *s)

.{

.  return s->next ? s->next->prev != s : abfd->section_last != s;

.}

.

*/

#include "sysdep.h"

#include <stdarg.h>

#include "bfd.h"

#include "bfdver.h"

#include "libiberty.h"

#include "demangle.h"

#include "safe-ctype.h"

#include "bfdlink.h"

#include "libbfd.h"

#include "coff/internal.h"

#include "coff/sym.h"

#include "libcoff.h"

#include "libecoff.h"

#undef obj_symbols

#include "elf-bfd.h"

#ifndef EXIT_FAILURE

#define EXIT_FAILURE 1

#endif

#ifdef TLS

#define THREAD_LOCAL TLS

#else

#define THREAD_LOCAL

#endif

/* provide storage for subsystem, stack and heap data which may have been

   passed in on the command line.  Ld puts this data into a bfd_link_info

   struct which ultimately gets passed in to the bfd.  When it arrives, copy

   it to the following struct so that the data will be available in coffcode.h

   where it is needed.  The typedef's used are defined in bfd.h */

/*

INODE

Error reporting, Initialization, typedef bfd, BFD front end

SECTION

  Error reporting

  Most BFD functions return nonzero on success (check their

  individual documentation for precise semantics).  On an error,

  they call <<bfd_set_error>> to set an error condition that callers

  can check by calling <<bfd_get_error>>.

  If that returns <<bfd_error_system_call>>, then check

  <<errno>>.

  The easiest way to report a BFD error to the user is to

  use <<bfd_perror>>.

  The BFD error is thread-local.

SUBSECTION

  Type <<bfd_error_type>>

  The values returned by <<bfd_get_error>> are defined by the

  enumerated type <<bfd_error_type>>.

CODE_FRAGMENT

.typedef enum bfd_error

.{

.  bfd_error_no_error = 0,

.  bfd_error_system_call,

.  bfd_error_invalid_target,

.  bfd_error_wrong_format,

.  bfd_error_wrong_object_format,

.  bfd_error_invalid_operation,

.  bfd_error_no_memory,

.  bfd_error_no_symbols,

.  bfd_error_no_armap,

.  bfd_error_no_more_archived_files,

.  bfd_error_malformed_archive,

.  bfd_error_missing_dso,

.  bfd_error_file_not_recognized,

.  bfd_error_file_ambiguously_recognized,

.  bfd_error_no_contents,

.  bfd_error_nonrepresentable_section,

.  bfd_error_no_debug_section,

.  bfd_error_bad_value,

.  bfd_error_file_truncated,

.  bfd_error_file_too_big,

.  bfd_error_sorry,

.  bfd_error_on_input,

.  bfd_error_invalid_error_code

.}

.bfd_error_type;

.

*/

const char *const bfd_errmsgs[] =

{

  N_("no error"),

  N_("system call error"),

  N_("invalid bfd target"),

  N_("file in wrong format"),

  N_("archive object file in wrong format"),

  N_("invalid operation"),

  N_("memory exhausted"),

  N_("no symbols"),

  N_("archive has no index; run ranlib to add one or use --link-mapless"),

  N_("no more archived files"),

  N_("malformed archive"),

  N_("DSO missing from command line"),

  N_("file format not recognized"),

  N_("file format is ambiguous"),

  N_("section has no contents"),

  N_("nonrepresentable section on output"),

  N_("symbol needs debug section which does not exist"),

  N_("bad value"),

  N_("file truncated"),

  N_("file too big"),

  N_("sorry, cannot handle this file"),

  N_("error reading %s: %s"),

  N_("#<invalid error code>")

};

static THREAD_LOCAL bfd_error_type bfd_error;

static THREAD_LOCAL char *_bfd_error_buf;

/* Free any data associated with the BFD error.  */

static void

_bfd_clear_error_data (void)

{

  bfd_error = bfd_error_no_error;

  free (_bfd_error_buf);

  _bfd_error_buf = NULL;

}

/*

FUNCTION

  bfd_get_error

SYNOPSIS

  bfd_error_type bfd_get_error (void);

DESCRIPTION

  Return the current BFD error condition.

*/

bfd_error_type

bfd_get_error (void)

{

  return bfd_error;

}

/*

FUNCTION

  bfd_set_error

SYNOPSIS

  void bfd_set_error (bfd_error_type error_tag);

DESCRIPTION

  Set the BFD error condition to be @var{error_tag}.

  @var{error_tag} must not be bfd_error_on_input.  Use

  bfd_set_input_error for input errors instead.

*/

void

bfd_set_error (bfd_error_type error_tag)

{

  bfd_error = error_tag;

  if (bfd_error >= bfd_error_on_input)

    abort ();

}

/*

FUNCTION

  bfd_set_input_error

SYNOPSIS

  void bfd_set_input_error (bfd *input, bfd_error_type error_tag);

DESCRIPTION

  Set the BFD error condition to be bfd_error_on_input.

  @var{input} is the input bfd where the error occurred, and

  @var{error_tag} the bfd_error_type error.

*/

void

bfd_set_input_error (bfd *input, bfd_error_type error_tag)

{

  /* This is an error that occurred during bfd_close when writing an

     archive, but on one of the input files.  */

  _bfd_clear_error_data ();

  if (error_tag >= bfd_error_on_input)

    abort ();

  if (bfd_asprintf (_(bfd_errmsgs[bfd_error_on_input]),

        bfd_get_filename (input), bfd_errmsg (error_tag)))

    bfd_error = bfd_error_on_input;

}

/*

FUNCTION

  bfd_errmsg

SYNOPSIS

  const char *bfd_errmsg (bfd_error_type error_tag);

DESCRIPTION

  Return a string describing the error @var{error_tag}, or

  the system error if @var{error_tag} is <<bfd_error_system_call>>.

*/

const char *

bfd_errmsg (bfd_error_type error_tag)

{

#ifndef errno

  extern int errno;

#endif

  if (error_tag == bfd_error_on_input)

    return _bfd_error_buf;

  if (error_tag == bfd_error_system_call)

    return xstrerror (errno);

  if (error_tag > bfd_error_invalid_error_code)

    error_tag = bfd_error_invalid_error_code; /* sanity check */

  return _(bfd_errmsgs[error_tag]);

}

/*

FUNCTION

  bfd_perror

SYNOPSIS

  void bfd_perror (const char *message);

DESCRIPTION

  Print to the standard error stream a string describing the

  last BFD error that occurred, or the last system error if

  the last BFD error was a system call failure.  If @var{message}

  is non-NULL and non-empty, the error string printed is preceded

  by @var{message}, a colon, and a space.  It is followed by a newline.

*/

void

bfd_perror (const char *message)

{

  fflush (stdout);

  if (message == NULL || *message == '\0')

    fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));

  else

    fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));

  fflush (stderr);

}

/*

INTERNAL_FUNCTION

  bfd_asprintf

SYNOPSIS

  char *bfd_asprintf (const char *fmt, ...);

DESCRIPTION

  Primarily for error reporting, this function is like

  libiberty's xasprintf except that it can return NULL on no

  memory and the returned string should not be freed.  Uses a

  thread-local malloc'd buffer managed by libbfd, _bfd_error_buf.

  Be aware that a call to this function frees the result of any

  previous call.  bfd_errmsg (bfd_error_on_input) also calls

  this function.

*/

char *

bfd_asprintf (const char *fmt, ...)

{

  free (_bfd_error_buf);

  _bfd_error_buf = NULL;

  va_list ap;

  va_start (ap, fmt);

  int count = vasprintf (&_bfd_error_buf, fmt, ap);

  va_end (ap);

  if (count == -1)

    {

      bfd_set_error (bfd_error_no_memory);

      _bfd_error_buf = NULL;

    }

  return _bfd_error_buf;

}

/*

SUBSECTION

  BFD error handler

  Some BFD functions want to print messages describing the

  problem.  They call a BFD error handler function.  This

  function may be overridden by the program.

  The BFD error handler acts like vprintf.

CODE_FRAGMENT

.typedef void (*bfd_error_handler_type) (const char *, va_list);

.

*/

/* The program name used when printing BFD error messages.  */

static const char *_bfd_error_program_name;

/* Support for positional parameters.  */

union _bfd_doprnt_args

{

  int i;

  long l;

  long long ll;

  double d;

  long double ld;

  void *p;

  enum

  {

    Bad,

    Int,

    Long,

    LongLong,

    Double,

    LongDouble,

    Ptr

  } type;

};

/* Maximum number of _bfd_error_handler args.  Don't increase this

   without changing the code handling positional parameters.  */

#define MAX_ARGS 9

/* This macro and _bfd_doprnt taken from libiberty _doprnt.c, tidied a

   little and extended to handle '%pA', '%pB' and positional parameters.  */

#define PRINT_TYPE(TYPE, FIELD) \

  do                \

    {               \

      TYPE value = (TYPE) args[arg_no].FIELD;     \

      result = print (stream, specifier, value);    \

    } while (0)

/*

CODE_FRAGMENT

.typedef int (*bfd_print_callback) (void *, const char *, ...);

*/

static int

_bfd_doprnt (bfd_print_callback print, void *stream, const char *format,

       union _bfd_doprnt_args *args)

{

  const char *ptr = format;

  char specifier[128];

  int total_printed = 0;

  unsigned int arg_count = 0;

  while (*ptr != '\0')

    {

      int result;

      if (*ptr != '%')

  {

    /* While we have regular characters, print them.  */

    const char *end = strchr (ptr, '%');

    if (end != NULL)

      result = print (stream, "%.*s", (int) (end - ptr), ptr);

    else

      result = print (stream, "%s", ptr);

    ptr += result;

  }

      else if (ptr[1] == '%')

  {

    print (stream, "%%");

    result = 1;

    ptr += 2;

  }

      else

  {

    /* We have a format specifier!  */

    char *sptr = specifier;

    int wide_width = 0, short_width = 0;

    unsigned int arg_no;

    /* Copy the % and move forward.  */

    *sptr++ = *ptr++;