Subversion Repositories openrisc

/* Generic BFD library interface and support routines.

   Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,

   2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008

   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.  */

/*

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.

CODE_FRAGMENT

.

.struct bfd

.{

.  {* A unique identifier of the BFD  *}

.  unsigned int id;

.

.  {* 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;

.

.  {* 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;

.

.  {* Reserved for an unimplemented file locking extension.  *}

.  int ifd;

.

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

.  bfd_format format;

.

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

.  enum bfd_direction

.    {

.      no_direction = 0,

.      read_direction = 1,

.      write_direction = 2,

.      both_direction = 3

.    }

.  direction;

.

.  {* 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   0x00

.

.  {* BFD contains relocation entries.  *}

.#define HAS_RELOC      0x01

.

.  {* BFD is directly executable.  *}

.#define EXEC_P         0x02

.

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

.     COFF header).  *}

.#define HAS_LINENO     0x04

.

.  {* 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 bfd_in_memory

.     struct.  *}

.#define BFD_IN_MEMORY 0x800

.

.  {* The sections in this BFD specify a memory page.  *}

.#define HAS_LOAD_PAGE 0x1000

.

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

.     to any input file.  *}

.#define BFD_LINKER_CREATED 0x2000

.

.  {* Currently my_archive is tested before adding origin to

.     anything. I believe that this can become always an add of

.     origin, with origin set to 0 for non archive files.  *}

.  ufile_ptr origin;

.

.  {* The origin in the archive of the proxy entry.  This will

.     normally be the same as origin, except for thin archives,

.     when it will contain the current offset of the proxy in the

.     thin archive rather than the offset of the bfd in its actual

.     container.  *}

.  ufile_ptr proxy_origin;

.

.  {* 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 number of sections.  *}

.  unsigned int section_count;

.

.  {* Stuff only useful for object files:

.     The start address.  *}

.  bfd_vma start_address;

.

.  {* Used for input and output.  *}

.  unsigned int symcount;

.

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

.  struct bfd_symbol  **outsymbols;

.

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

.  unsigned int dynsymcount;

.

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

.  const struct bfd_arch_info *arch_info;

.

.  {* 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.  *}

.

.  {* A chain of BFD structures involved in a link.  *}

.  struct bfd *link_next;

.

.  {* A field used by _bfd_generic_link_add_archive_symbols.  This will

.     be used only for archive elements.  *}

.  int archive_pass;

.

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

.  union

.    {

.      struct aout_data_struct *aout_data;

.      struct artdata *aout_ar_data;

.      struct _oasys_data *oasys_obj_data;

.      struct _oasys_ar_data *oasys_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 ieee_data_struct *ieee_data;

.      struct ieee_ar_data_struct *ieee_ar_data;

.      struct srec_data_struct *srec_data;

.      struct ihex_data_struct *ihex_data;

.      struct tekhex_data_struct *tekhex_data;

.      struct elf_obj_tdata *elf_obj_data;

.      struct nlm_obj_tdata *nlm_obj_data;

.      struct bout_data_struct *bout_data;

.      struct mmo_data_struct *mmo_data;

.      struct sun_core_struct *sun_core_data;

.      struct sco5_core_struct *sco5_core_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 versados_data_struct *versados_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 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;

.

.  {* 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;

.

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

.  unsigned int is_thin_archive : 1;

.};

.

*/

#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

/* 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 */

/*

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>>.

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_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_on_input,

.  bfd_error_invalid_error_code

.}

.bfd_error_type;

.

*/

static bfd_error_type bfd_error = bfd_error_no_error;

static bfd *input_bfd = NULL;

static bfd_error_type input_error = bfd_error_no_error;

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"),

  N_("No more archived files"),

  N_("Malformed archive"),

  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_("Error reading %s: %s"),

  N_("#<Invalid error code>")

};

/*

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}.

        If @var{error_tag} is bfd_error_on_input, then this function

        takes two more parameters, the input bfd where the error

        occurred, and the bfd_error_type error.

*/

void

bfd_set_error (bfd_error_type error_tag, ...)

{

  bfd_error = error_tag;

  if (error_tag == bfd_error_on_input)

    {

      /* This is an error that occurred during bfd_close when

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

      va_list ap;

      va_start (ap, error_tag);

      input_bfd = va_arg (ap, bfd *);

      input_error = va_arg (ap, int);

      if (input_error >= bfd_error_on_input)

        abort ();

      va_end (ap);

    }

}

/*

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)

    {

      char *buf;

      const char *msg = bfd_errmsg (input_error);

      if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)

          != -1)

        return buf;

      /* Ick, what to do on out of memory?  */

      return msg;

    }

  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)

{

  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 ()));

}

/*

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 printf.

CODE_FRAGMENT

.

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

.

*/

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

static const char *_bfd_error_program_name;

/* This is the default routine to handle BFD error messages.

   Like fprintf (stderr, ...), but also handles some extra format specifiers.

   %A section name from section.  For group components, print group name too.

   %B file name from bfd.  For archive components, prints archive too.

   Note - because these two extra format specifiers require special handling

   they are scanned for and processed in this function, before calling

   vfprintf.  This means that the *arguments* for these format specifiers

   must be the first ones in the variable argument list, regardless of where

   the specifiers appear in the format string.  Thus for example calling

   this function with a format string of:

      "blah %s blah %A blah %d blah %B"

   would involve passing the arguments as:

      "blah %s blah %A blah %d blah %B",

        asection_for_the_%A,

        bfd_for_the_%B,

        string_for_the_%s,

        integer_for_the_%d);

 */

void

_bfd_default_error_handler (const char *fmt, ...)

{

  va_list ap;

  char *bufp;

  const char *new_fmt, *p;

  size_t avail = 1000;

  char buf[1000];

  /* PR 4992: Don't interrupt output being sent to stdout.  */

  fflush (stdout);

  if (_bfd_error_program_name != NULL)

    fprintf (stderr, "%s: ", _bfd_error_program_name);

  else

    fprintf (stderr, "BFD: ");

  va_start (ap, fmt);

  new_fmt = fmt;

  bufp = buf;

  /* Reserve enough space for the existing format string.  */

  avail -= strlen (fmt) + 1;

  if (avail > 1000)

    _exit (EXIT_FAILURE);

  p = fmt;

  while (1)

    {

      char *q;

      size_t len, extra, trim;

      p = strchr (p, '%');

      if (p == NULL || p[1] == '\0')

        {

          if (new_fmt == buf)

            {

              len = strlen (fmt);

              memcpy (bufp, fmt, len + 1);

            }

          break;

        }

      if (p[1] == 'A' || p[1] == 'B')

        {

          len = p - fmt;

          memcpy (bufp, fmt, len);

          bufp += len;

          fmt = p + 2;

          new_fmt = buf;

          /* If we run out of space, tough, you lose your ridiculously

             long file or section name.  It's not safe to try to alloc

             memory here;  We might be printing an out of memory message.  */

          if (avail == 0)

            {

              *bufp++ = '*';

              *bufp++ = '*';

              *bufp = '\0';

            }

          else

            {

              if (p[1] == 'B')

                {

                  bfd *abfd = va_arg (ap, bfd *);

                  if (abfd == NULL)

                    /* Invoking %B with a null bfd pointer is an internal error.  */

                    abort ();

                  else if (abfd->my_archive)

                    snprintf (bufp, avail, "%s(%s)",

                              abfd->my_archive->filename, abfd->filename);

                  else

                    snprintf (bufp, avail, "%s", abfd->filename);

                }

              else

                {

                  asection *sec = va_arg (ap, asection *);

                  bfd *abfd;

                  const char *group = NULL;

                  struct coff_comdat_info *ci;

                  if (sec == NULL)

                    /* Invoking %A with a null section pointer is an internal error.  */

                    abort ();

                  abfd = sec->owner;

                  if (abfd != NULL

                      && bfd_get_flavour (abfd) == bfd_target_elf_flavour

                      && elf_next_in_group (sec) != NULL

                      && (sec->flags & SEC_GROUP) == 0)

                    group = elf_group_name (sec);

                  else if (abfd != NULL

                           && bfd_get_flavour (abfd) == bfd_target_coff_flavour

                           && (ci = bfd_coff_get_comdat_section (sec->owner,

                                                                 sec)) != NULL)

                    group = ci->name;

                  if (group != NULL)

                    snprintf (bufp, avail, "%s[%s]", sec->name, group);

                  else

                    snprintf (bufp, avail, "%s", sec->name);

                }

              len = strlen (bufp);

              avail = avail - len + 2;

              /* We need to replace any '%' we printed by "%%".

                 First count how many.  */

              q = bufp;

              bufp += len;

              extra = 0;

              while ((q = strchr (q, '%')) != NULL)

                {

                  ++q;

                  ++extra;

                }

              /* If there isn't room, trim off the end of the string.  */

              q = bufp;

              bufp += extra;

              if (extra > avail)

                {

                  trim = extra - avail;

                  bufp -= trim;

                  do

                    {

                      if (*--q == '%')

                        --extra;

                    }

                  while (--trim != 0);

                  *q = '\0';

                  avail = extra;

                }

              avail -= extra;

              /* Now double all '%' chars, shuffling the string as we go.  */

              while (extra != 0)

                {

                  while ((q[extra] = *q) != '%')

                    --q;

                  q[--extra] = '%';

                  --q;

                }

            }

        }

      p = p + 2;

    }

  vfprintf (stderr, new_fmt, ap);

  va_end (ap);

  putc ('\n', stderr);

}

/* This is a function pointer to the routine which should handle BFD

   error messages.  It is called when a BFD routine encounters an

   error for which it wants to print a message.  Going through a

   function pointer permits a program linked against BFD to intercept

   the messages and deal with them itself.  */

bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;

/*

FUNCTION

        bfd_set_error_handler

SYNOPSIS

        bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);

DESCRIPTION

        Set the BFD error handler function.  Returns the previous

        function.

*/

bfd_error_handler_type

bfd_set_error_handler (bfd_error_handler_type pnew)

{

  bfd_error_handler_type pold;

  pold = _bfd_error_handler;

  _bfd_error_handler = pnew;

  return pold;

}

/*

FUNCTION

        bfd_set_error_program_name

SYNOPSIS

        void bfd_set_error_program_name (const char *);

DESCRIPTION

        Set the program name to use when printing a BFD error.  This

        is printed before the error message followed by a colon and

        space.  The string must not be changed after it is passed to

        this function.

*/

void

bfd_set_error_program_name (const char *name)

{

  _bfd_error_program_name = name;

}

/*

FUNCTION

        bfd_get_error_handler

SYNOPSIS

        bfd_error_handler_type bfd_get_error_handler (void);

DESCRIPTION

        Return the BFD error handler function.

*/

bfd_error_handler_type

bfd_get_error_handler (void)

{

  return _bfd_error_handler;

}

/*

SECTION

        Miscellaneous

SUBSECTION

        Miscellaneous functions

*/

/*

FUNCTION

        bfd_get_reloc_upper_bound

SYNOPSIS

        long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);

DESCRIPTION

        Return the number of bytes required to store the

        relocation information associated with section @var{sect}

        attached to bfd @var{abfd}.  If an error occurs, return -1.

*/

long

bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)

{

  if (abfd->format != bfd_object)

    {

      bfd_set_error (bfd_error_invalid_operation);

      return -1;

    }

  return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));

}

/*

FUNCTION

        bfd_canonicalize_reloc

SYNOPSIS

        long bfd_canonicalize_reloc

          (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);

DESCRIPTION

        Call the back end associated with the open BFD

        @var{abfd} and translate the external form of the relocation

        information attached to @var{sec} into the internal canonical

        form.  Place the table into memory at @var{loc}, which has

        been preallocated, usually by a call to

        <<bfd_get_reloc_upper_bound>>.  Returns the number of relocs, or

        -1 on error.

        The @var{syms} table is also needed for horrible internal magic

        reasons.

*/