Subversion Repositories or1k

/* Handle SunOS and SVR4 shared libraries for GDB, the GNU Debugger.

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

   2001

   Free Software Foundation, Inc.

   This file is part of GDB.

   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 2 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., 59 Temple Place - Suite 330,

   Boston, MA 02111-1307, USA.  */

#include "defs.h"

#include "regcache.h"

#include <sys/types.h>

#include <signal.h>

#include "gdb_string.h"

#include <sys/param.h>

#include <fcntl.h>

#ifndef SVR4_SHARED_LIBS

 /* SunOS shared libs need the nlist structure.  */

#include <a.out.h>

#include <link.h>

#else

#include "elf/external.h"

#include "elf/common.h"

#include "elf/mips.h"

#endif

#include "symtab.h"

#include "bfd.h"

#include "symfile.h"

#include "objfiles.h"

#include "gdbcore.h"

#include "command.h"

#include "target.h"

#include "frame.h"

#include "gdb_regex.h"

#include "inferior.h"

#include "environ.h"

#include "language.h"

#include "gdbcmd.h"

#include "solist.h"

#include "solib-svr4.h"

#ifndef SVR4_FETCH_LINK_MAP_OFFSETS

#define SVR4_FETCH_LINK_MAP_OFFSETS() fetch_link_map_offsets ()

#endif

static struct link_map_offsets *default_svr4_fetch_link_map_offsets (void);

static struct link_map_offsets *(*fetch_link_map_offsets)(void) =

  default_svr4_fetch_link_map_offsets;

/* legacy_svr4_fetch_link_map_offsets_hook is a pointer to a function

   which is used to fetch link map offsets.  It will only be set

   by solib-legacy.c, if at all. */

struct link_map_offsets *(*legacy_svr4_fetch_link_map_offsets_hook)(void) = 0;

/* Link map info to include in an allocated so_list entry */

struct lm_info

  {

    /* Pointer to copy of link map from inferior.  The type is char *

       rather than void *, so that we may use byte offsets to find the

       various fields without the need for a cast.  */

    char *lm;

  };

/* On SVR4 systems, a list of symbols in the dynamic linker where

   GDB can try to place a breakpoint to monitor shared library

   events.

   If none of these symbols are found, or other errors occur, then

   SVR4 systems will fall back to using a symbol as the "startup

   mapping complete" breakpoint address.  */

#ifdef SVR4_SHARED_LIBS

static char *solib_break_names[] =

{

  "r_debug_state",

  "_r_debug_state",

  "_dl_debug_state",

  "rtld_db_dlactivity",

  "_rtld_debug_state",

  NULL

};

#endif

#define BKPT_AT_SYMBOL 1

#if defined (BKPT_AT_SYMBOL) && defined (SVR4_SHARED_LIBS)

static char *bkpt_names[] =

{

#ifdef SOLIB_BKPT_NAME

  SOLIB_BKPT_NAME,              /* Prefer configured name if it exists. */

#endif

  "_start",

  "main",

  NULL

};

#endif

/* Symbols which are used to locate the base of the link map structures. */

#ifndef SVR4_SHARED_LIBS

static char *debug_base_symbols[] =

{

  "_DYNAMIC",

  "_DYNAMIC__MGC",

  NULL

};

#endif

static char *main_name_list[] =

{

  "main_$main",

  NULL

};

/* Fetch (and possibly build) an appropriate link_map_offsets structure

   for native targets using struct definitions from link.h.

   Note: For non-native targets (i.e. cross-debugging situations),

   you need to define a target specific fetch_link_map_offsets()

   function and call set_solib_svr4_fetch_link_map_offsets () to

   register this function.  */

static struct link_map_offsets *

default_svr4_fetch_link_map_offsets (void)

{

  if (legacy_svr4_fetch_link_map_offsets_hook)

    return legacy_svr4_fetch_link_map_offsets_hook ();

  else

    {

      internal_error (__FILE__, __LINE__,

"default_svr4_fetch_link_map_offsets called without legacy link_map support enabled.");

      return 0;

    }

}

/* Macro to extract an address from a solib structure.

   When GDB is configured for some 32-bit targets (e.g. Solaris 2.7

   sparc), BFD is configured to handle 64-bit targets, so CORE_ADDR is

   64 bits.  We have to extract only the significant bits of addresses

   to get the right address when accessing the core file BFD.  */

#define SOLIB_EXTRACT_ADDRESS(MEMBER) \

        extract_address (&(MEMBER), sizeof (MEMBER))

/* local data declarations */

#ifndef SVR4_SHARED_LIBS

/* NOTE: converted the macros LM_ADDR, LM_NEXT, LM_NAME and

   IGNORE_FIRST_LINK_MAP_ENTRY into functions (see below).

   MVS, June 2000  */

static struct link_dynamic dynamic_copy;

static struct link_dynamic_2 ld_2_copy;

static struct ld_debug debug_copy;

static CORE_ADDR debug_addr;

static CORE_ADDR flag_addr;

#endif /* !SVR4_SHARED_LIBS */

/* link map access functions */

static CORE_ADDR

LM_ADDR (struct so_list *so)

{

  struct link_map_offsets *lmo = SVR4_FETCH_LINK_MAP_OFFSETS ();

  return (CORE_ADDR) extract_signed_integer (so->lm_info->lm + lmo->l_addr_offset,

                                             lmo->l_addr_size);

}

static CORE_ADDR

LM_NEXT (struct so_list *so)

{

  struct link_map_offsets *lmo = SVR4_FETCH_LINK_MAP_OFFSETS ();

  return extract_address (so->lm_info->lm + lmo->l_next_offset, lmo->l_next_size);

}

static CORE_ADDR

LM_NAME (struct so_list *so)

{

  struct link_map_offsets *lmo = SVR4_FETCH_LINK_MAP_OFFSETS ();

  return extract_address (so->lm_info->lm + lmo->l_name_offset, lmo->l_name_size);

}

#ifndef SVR4_SHARED_LIBS

static int

IGNORE_FIRST_LINK_MAP_ENTRY (struct so_list *so)

{

  return 0;

}

#else /* SVR4_SHARED_LIBS */

static int

IGNORE_FIRST_LINK_MAP_ENTRY (struct so_list *so)

{

  struct link_map_offsets *lmo = SVR4_FETCH_LINK_MAP_OFFSETS ();

  return extract_address (so->lm_info->lm + lmo->l_prev_offset,

                          lmo->l_prev_size) == 0;

}

#endif /* !SVR4_SHARED_LIBS */

static CORE_ADDR debug_base;    /* Base of dynamic linker structures */

static CORE_ADDR breakpoint_addr;       /* Address where end bkpt is set */

/* Local function prototypes */

static int match_main (char *);

#ifndef SVR4_SHARED_LIBS

/* Allocate the runtime common object file.  */

static void

allocate_rt_common_objfile (void)

{

  struct objfile *objfile;

  struct objfile *last_one;

  objfile = (struct objfile *) xmalloc (sizeof (struct objfile));

  memset (objfile, 0, sizeof (struct objfile));

  objfile->md = NULL;

  obstack_specify_allocation (&objfile->psymbol_cache.cache, 0, 0,

                              xmalloc, xfree);

  obstack_specify_allocation (&objfile->psymbol_obstack, 0, 0, xmalloc,

                              xfree);

  obstack_specify_allocation (&objfile->symbol_obstack, 0, 0, xmalloc,

                              xfree);

  obstack_specify_allocation (&objfile->type_obstack, 0, 0, xmalloc,

                              xfree);

  objfile->name = mstrsave (objfile->md, "rt_common");

  /* Add this file onto the tail of the linked list of other such files. */

  objfile->next = NULL;

  if (object_files == NULL)

    object_files = objfile;

  else

    {

      for (last_one = object_files;

           last_one->next;

           last_one = last_one->next);

      last_one->next = objfile;

    }

  rt_common_objfile = objfile;

}

/* Read all dynamically loaded common symbol definitions from the inferior

   and put them into the minimal symbol table for the runtime common

   objfile.  */

static void

solib_add_common_symbols (CORE_ADDR rtc_symp)

{

  struct rtc_symb inferior_rtc_symb;

  struct nlist inferior_rtc_nlist;

  int len;

  char *name;

  /* Remove any runtime common symbols from previous runs.  */

  if (rt_common_objfile != NULL && rt_common_objfile->minimal_symbol_count)

    {

      obstack_free (&rt_common_objfile->symbol_obstack, 0);

      obstack_specify_allocation (&rt_common_objfile->symbol_obstack, 0, 0,

                                  xmalloc, xfree);

      rt_common_objfile->minimal_symbol_count = 0;

      rt_common_objfile->msymbols = NULL;

    }

  init_minimal_symbol_collection ();

  make_cleanup_discard_minimal_symbols ();

  while (rtc_symp)

    {

      read_memory (rtc_symp,

                   (char *) &inferior_rtc_symb,

                   sizeof (inferior_rtc_symb));

      read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_sp),

                   (char *) &inferior_rtc_nlist,

                   sizeof (inferior_rtc_nlist));

      if (inferior_rtc_nlist.n_type == N_COMM)

        {

          /* FIXME: The length of the symbol name is not available, but in the

             current implementation the common symbol is allocated immediately

             behind the name of the symbol. */

          len = inferior_rtc_nlist.n_value - inferior_rtc_nlist.n_un.n_strx;

          name = xmalloc (len);

          read_memory (SOLIB_EXTRACT_ADDRESS (inferior_rtc_nlist.n_un.n_name),

                       name, len);

          /* Allocate the runtime common objfile if necessary. */

          if (rt_common_objfile == NULL)

            allocate_rt_common_objfile ();

          prim_record_minimal_symbol (name, inferior_rtc_nlist.n_value,

                                      mst_bss, rt_common_objfile);

          xfree (name);

        }

      rtc_symp = SOLIB_EXTRACT_ADDRESS (inferior_rtc_symb.rtc_next);

    }

  /* Install any minimal symbols that have been collected as the current

     minimal symbols for the runtime common objfile.  */

  install_minimal_symbols (rt_common_objfile);

}

#endif /* SVR4_SHARED_LIBS */

#ifdef SVR4_SHARED_LIBS

static CORE_ADDR bfd_lookup_symbol (bfd *, char *);

/*

   LOCAL FUNCTION

   bfd_lookup_symbol -- lookup the value for a specific symbol

   SYNOPSIS

   CORE_ADDR bfd_lookup_symbol (bfd *abfd, char *symname)

   DESCRIPTION

   An expensive way to lookup the value of a single symbol for

   bfd's that are only temporary anyway.  This is used by the

   shared library support to find the address of the debugger

   interface structures in the shared library.

   Note that 0 is specifically allowed as an error return (no

   such symbol).

 */

static CORE_ADDR

bfd_lookup_symbol (bfd *abfd, char *symname)

{

  long storage_needed;

  asymbol *sym;

  asymbol **symbol_table;

  unsigned int number_of_symbols;

  unsigned int i;

  struct cleanup *back_to;

  CORE_ADDR symaddr = 0;

  storage_needed = bfd_get_symtab_upper_bound (abfd);

  if (storage_needed > 0)

    {

      symbol_table = (asymbol **) xmalloc (storage_needed);

      back_to = make_cleanup (xfree, (PTR) symbol_table);

      number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);

      for (i = 0; i < number_of_symbols; i++)

        {

          sym = *symbol_table++;

          if (STREQ (sym->name, symname))

            {

              /* Bfd symbols are section relative. */

              symaddr = sym->value + sym->section->vma;

              break;

            }

        }

      do_cleanups (back_to);

    }

  if (symaddr)

    return symaddr;

  /* On FreeBSD, the dynamic linker is stripped by default.  So we'll

     have to check the dynamic string table too.  */

  storage_needed = bfd_get_dynamic_symtab_upper_bound (abfd);

  if (storage_needed > 0)

    {

      symbol_table = (asymbol **) xmalloc (storage_needed);

      back_to = make_cleanup (xfree, (PTR) symbol_table);

      number_of_symbols = bfd_canonicalize_dynamic_symtab (abfd, symbol_table);

      for (i = 0; i < number_of_symbols; i++)

        {

          sym = *symbol_table++;

          if (STREQ (sym->name, symname))

            {

              /* Bfd symbols are section relative. */

              symaddr = sym->value + sym->section->vma;

              break;

            }

        }

      do_cleanups (back_to);

    }

  return symaddr;

}

#ifdef HANDLE_SVR4_EXEC_EMULATORS

/*

   Solaris BCP (the part of Solaris which allows it to run SunOS4

   a.out files) throws in another wrinkle. Solaris does not fill

   in the usual a.out link map structures when running BCP programs,

   the only way to get at them is via groping around in the dynamic

   linker.

   The dynamic linker and it's structures are located in the shared

   C library, which gets run as the executable's "interpreter" by

   the kernel.

   Note that we can assume nothing about the process state at the time

   we need to find these structures.  We may be stopped on the first

   instruction of the interpreter (C shared library), the first

   instruction of the executable itself, or somewhere else entirely

   (if we attached to the process for example).

 */

static char *debug_base_symbols[] =

{

  "r_debug",                    /* Solaris 2.3 */

  "_r_debug",                   /* Solaris 2.1, 2.2 */

  NULL

};

static int look_for_base (int, CORE_ADDR);

/*

   LOCAL FUNCTION

   look_for_base -- examine file for each mapped address segment

   SYNOPSYS

   static int look_for_base (int fd, CORE_ADDR baseaddr)

   DESCRIPTION

   This function is passed to proc_iterate_over_mappings, which

   causes it to get called once for each mapped address space, with

   an open file descriptor for the file mapped to that space, and the

   base address of that mapped space.

   Our job is to find the debug base symbol in the file that this

   fd is open on, if it exists, and if so, initialize the dynamic

   linker structure base address debug_base.

   Note that this is a computationally expensive proposition, since

   we basically have to open a bfd on every call, so we specifically

   avoid opening the exec file.

 */

static int

look_for_base (int fd, CORE_ADDR baseaddr)

{

  bfd *interp_bfd;

  CORE_ADDR address = 0;

  char **symbolp;

  /* If the fd is -1, then there is no file that corresponds to this

     mapped memory segment, so skip it.  Also, if the fd corresponds

     to the exec file, skip it as well. */

  if (fd == -1

      || (exec_bfd != NULL

          && fdmatch (fileno ((FILE *) (exec_bfd->iostream)), fd)))

    {

      return (0);

    }

  /* Try to open whatever random file this fd corresponds to.  Note that

     we have no way currently to find the filename.  Don't gripe about

     any problems we might have, just fail. */

  if ((interp_bfd = bfd_fdopenr ("unnamed", gnutarget, fd)) == NULL)

    {

      return (0);

    }

  if (!bfd_check_format (interp_bfd, bfd_object))

    {

      /* FIXME-leak: on failure, might not free all memory associated with

         interp_bfd.  */

      bfd_close (interp_bfd);

      return (0);

    }

  /* Now try to find our debug base symbol in this file, which we at

     least know to be a valid ELF executable or shared library. */

  for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)

    {

      address = bfd_lookup_symbol (interp_bfd, *symbolp);

      if (address != 0)

        {

          break;

        }

    }

  if (address == 0)

    {

      /* FIXME-leak: on failure, might not free all memory associated with

         interp_bfd.  */

      bfd_close (interp_bfd);

      return (0);

    }

  /* Eureka!  We found the symbol.  But now we may need to relocate it

     by the base address.  If the symbol's value is less than the base

     address of the shared library, then it hasn't yet been relocated

     by the dynamic linker, and we have to do it ourself.  FIXME: Note

     that we make the assumption that the first segment that corresponds

     to the shared library has the base address to which the library

     was relocated. */

  if (address < baseaddr)

    {

      address += baseaddr;

    }

  debug_base = address;

  /* FIXME-leak: on failure, might not free all memory associated with

     interp_bfd.  */

  bfd_close (interp_bfd);

  return (1);

}

#endif /* HANDLE_SVR4_EXEC_EMULATORS */

/*

   LOCAL FUNCTION

   elf_locate_base -- locate the base address of dynamic linker structs

   for SVR4 elf targets.

   SYNOPSIS

   CORE_ADDR elf_locate_base (void)

   DESCRIPTION

   For SVR4 elf targets the address of the dynamic linker's runtime

   structure is contained within the dynamic info section in the

   executable file.  The dynamic section is also mapped into the

   inferior address space.  Because the runtime loader fills in the

   real address before starting the inferior, we have to read in the

   dynamic info section from the inferior address space.

   If there are any errors while trying to find the address, we

   silently return 0, otherwise the found address is returned.

 */

static CORE_ADDR

elf_locate_base (void)

{

  sec_ptr dyninfo_sect;

  int dyninfo_sect_size;

  CORE_ADDR dyninfo_addr;

  char *buf;

  char *bufend;

  int arch_size;

  /* Find the start address of the .dynamic section.  */

  dyninfo_sect = bfd_get_section_by_name (exec_bfd, ".dynamic");

  if (dyninfo_sect == NULL)

    return 0;

  dyninfo_addr = bfd_section_vma (exec_bfd, dyninfo_sect);

  /* Read in .dynamic section, silently ignore errors.  */

  dyninfo_sect_size = bfd_section_size (exec_bfd, dyninfo_sect);

  buf = alloca (dyninfo_sect_size);

  if (target_read_memory (dyninfo_addr, buf, dyninfo_sect_size))

    return 0;

  /* Find the DT_DEBUG entry in the the .dynamic section.

     For mips elf we look for DT_MIPS_RLD_MAP, mips elf apparently has

     no DT_DEBUG entries.  */

  arch_size = bfd_get_arch_size (exec_bfd);

  if (arch_size == -1)  /* failure */

    return 0;

  if (arch_size == 32)

    { /* 32-bit elf */

      for (bufend = buf + dyninfo_sect_size;

           buf < bufend;

           buf += sizeof (Elf32_External_Dyn))

        {

          Elf32_External_Dyn *x_dynp = (Elf32_External_Dyn *) buf;

          long dyn_tag;

          CORE_ADDR dyn_ptr;

          dyn_tag = bfd_h_get_32 (exec_bfd, (bfd_byte *) x_dynp->d_tag);

          if (dyn_tag == DT_NULL)

            break;

          else if (dyn_tag == DT_DEBUG)

            {

              dyn_ptr = bfd_h_get_32 (exec_bfd,

                                      (bfd_byte *) x_dynp->d_un.d_ptr);

              return dyn_ptr;

            }

          else if (dyn_tag == DT_MIPS_RLD_MAP)

            {

              char *pbuf;

              pbuf = alloca (TARGET_PTR_BIT / HOST_CHAR_BIT);

              /* DT_MIPS_RLD_MAP contains a pointer to the address

                 of the dynamic link structure.  */

              dyn_ptr = bfd_h_get_32 (exec_bfd,

                                      (bfd_byte *) x_dynp->d_un.d_ptr);

              if (target_read_memory (dyn_ptr, pbuf, sizeof (pbuf)))

                return 0;

              return extract_unsigned_integer (pbuf, sizeof (pbuf));

            }

        }

    }

  else /* 64-bit elf */

    {

      for (bufend = buf + dyninfo_sect_size;

           buf < bufend;

           buf += sizeof (Elf64_External_Dyn))

        {

          Elf64_External_Dyn *x_dynp = (Elf64_External_Dyn *) buf;

          long dyn_tag;

          CORE_ADDR dyn_ptr;

          dyn_tag = bfd_h_get_64 (exec_bfd, (bfd_byte *) x_dynp->d_tag);

          if (dyn_tag == DT_NULL)

            break;

          else if (dyn_tag == DT_DEBUG)

            {

              dyn_ptr = bfd_h_get_64 (exec_bfd,

                                      (bfd_byte *) x_dynp->d_un.d_ptr);

              return dyn_ptr;

            }

        }

    }

  /* DT_DEBUG entry not found.  */

  return 0;

}

#endif /* SVR4_SHARED_LIBS */

/*

   LOCAL FUNCTION

   locate_base -- locate the base address of dynamic linker structs

   SYNOPSIS

   CORE_ADDR locate_base (void)

   DESCRIPTION

   For both the SunOS and SVR4 shared library implementations, if the

   inferior executable has been linked dynamically, there is a single

   address somewhere in the inferior's data space which is the key to

   locating all of the dynamic linker's runtime structures.  This

   address is the value of the debug base symbol.  The job of this

   function is to find and return that address, or to return 0 if there

   is no such address (the executable is statically linked for example).

   For SunOS, the job is almost trivial, since the dynamic linker and

   all of it's structures are statically linked to the executable at

   link time.  Thus the symbol for the address we are looking for has

   already been added to the minimal symbol table for the executable's

   objfile at the time the symbol file's symbols were read, and all we

   have to do is look it up there.  Note that we explicitly do NOT want

   to find the copies in the shared library.

   The SVR4 version is a bit more complicated because the address

   is contained somewhere in the dynamic info section.  We have to go

   to a lot more work to discover the address of the debug base symbol.

   Because of this complexity, we cache the value we find and return that

   value on subsequent invocations.  Note there is no copy in the

   executable symbol tables.

 */

static CORE_ADDR

locate_base (void)

{

#ifndef SVR4_SHARED_LIBS

  struct minimal_symbol *msymbol;

  CORE_ADDR address = 0;

  char **symbolp;

  /* For SunOS, we want to limit the search for the debug base symbol to the

     executable being debugged, since there is a duplicate named symbol in the

     shared library.  We don't want the shared library versions. */

  for (symbolp = debug_base_symbols; *symbolp != NULL; symbolp++)

    {

      msymbol = lookup_minimal_symbol (*symbolp, NULL, symfile_objfile);

      if ((msymbol != NULL) && (SYMBOL_VALUE_ADDRESS (msymbol) != 0))

        {

          address = SYMBOL_VALUE_ADDRESS (msymbol);

          return (address);

        }

    }

  return (0);

#else /* SVR4_SHARED_LIBS */

  /* Check to see if we have a currently valid address, and if so, avoid

     doing all this work again and just return the cached address.  If

     we have no cached address, try to locate it in the dynamic info

     section for ELF executables.  */

  if (debug_base == 0)

    {

      if (exec_bfd != NULL

          && bfd_get_flavour (exec_bfd) == bfd_target_elf_flavour)

        debug_base = elf_locate_base ();

#ifdef HANDLE_SVR4_EXEC_EMULATORS

      /* Try it the hard way for emulated executables.  */

      else if (!ptid_equal (inferior_ptid, null_ptid) && target_has_execution)

        proc_iterate_over_mappings (look_for_base);

#endif

    }

  return (debug_base);

#endif /* !SVR4_SHARED_LIBS */