gdb/solist.h

   1 /* Shared library declarations for GDB, the GNU Debugger.
   2    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
   3    2001, 2007 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   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 2 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,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef SOLIST_H
  23 #define SOLIST_H
  24
  25 #define SO_NAME_MAX_PATH_SIZE 512       /* FIXME: Should be dynamic */
  26 /* For domain_enum domain.  */
  27 #include "symtab.h"
  28
  29 /* Forward declaration for target specific link map information.  This
  30    struct is opaque to all but the target specific file.  */
  31 struct lm_info;
  32
  33 struct so_list
  34   {
  35     /* The following fields of the structure come directly from the
  36        dynamic linker's tables in the inferior, and are initialized by
  37        current_sos.  */
  38
  39     struct so_list *next;       /* next structure in linked list */
  40
  41     /* A pointer to target specific link map information.  Often this
  42        will be a copy of struct link_map from the user process, but
  43        it need not be; it can be any collection of data needed to
  44        traverse the dynamic linker's data structures. */
  45     struct lm_info *lm_info;
  46
  47     /* Shared object file name, exactly as it appears in the
  48        inferior's link map.  This may be a relative path, or something
  49        which needs to be looked up in LD_LIBRARY_PATH, etc.  We use it
  50        to tell which entries in the inferior's dynamic linker's link
  51        map we've already loaded.  */
  52     char so_original_name[SO_NAME_MAX_PATH_SIZE];
  53
  54     /* shared object file name, expanded to something GDB can open */
  55     char so_name[SO_NAME_MAX_PATH_SIZE];
  56
  57     /* The following fields of the structure are built from
  58        information gathered from the shared object file itself, and
  59        are set when we actually add it to our symbol tables.
  60
  61        current_sos must initialize these fields to 0.  */
  62
  63     bfd *abfd;
  64     char symbols_loaded;        /* flag: symbols read in yet? */
  65     char from_tty;              /* flag: print msgs? */
  66     struct objfile *objfile;    /* objfile for loaded lib */
  67     struct section_table *sections;
  68     struct section_table *sections_end;
  69
  70     /* Record the range of addresses belonging to this shared library.
  71        There may not be just one (e.g. if two segments are relocated
  72        differently); but this is only used for "info sharedlibrary".  */
  73     CORE_ADDR addr_low, addr_high;
  74   };
  75
  76 struct target_so_ops
  77   {
  78     /* Adjust the section binding addresses by the base address at
  79        which the object was actually mapped.  */
  80     void (*relocate_section_addresses) (struct so_list *so,
  81                                         struct section_table *);
  82
  83     /* Free the the link map info and any other private data
  84        structures associated with a so_list entry.  */
  85     void (*free_so) (struct so_list *so);
  86
  87     /* Reset or free private data structures not associated with
  88        so_list entries.  */
  89     void (*clear_solib) (void);
  90
  91     /* Target dependent code to run after child process fork.  */
  92     void (*solib_create_inferior_hook) (void);
  93
  94     /* Do additional symbol handling, lookup, etc. after symbols
  95        for a shared object have been loaded.  */
  96     void (*special_symbol_handling) (void);
  97
  98     /* Construct a list of the currently loaded shared objects.  */
  99     struct so_list *(*current_sos) (void);
 100
 101     /* Find, open, and read the symbols for the main executable.  */
 102     int (*open_symbol_file_object) (void *from_ttyp);
 103
 104     /* Determine if PC lies in the dynamic symbol resolution code of
 105        the run time loader */
 106     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
 107
 108     /* Extra hook for finding and opening a solib.
 109        Convenience function for remote debuggers finding host libs.  */
 110     int (*find_and_open_solib) (char *soname,
 111         unsigned o_flags, char **temp_pathname);
 112
 113     /* Hook for looking up global symbols in a library-specific way.  */
 114     struct symbol * (*lookup_lib_global_symbol) (const struct objfile *objfile,
 115                                                  const char *name,
 116                                                  const char *linkage_name,
 117                                                  const domain_enum domain,
 118                                                  struct symtab **symtab);
 119
 120   };
 121
 122 /* Free the memory associated with a (so_list *).  */
 123 void free_so (struct so_list *so);
 124
 125 /* Return address of first so_list entry in master shared object list.  */
 126 struct so_list *master_so_list (void);
 127
 128 /* Find solib binary file and open it.  */
 129 extern int solib_open (char *in_pathname, char **found_pathname);
 130
 131 /* FIXME: gdbarch needs to control this variable */
 132 extern struct target_so_ops *current_target_so_ops;
 133
 134 #define TARGET_SO_RELOCATE_SECTION_ADDRESSES \
 135   (current_target_so_ops->relocate_section_addresses)
 136 #define TARGET_SO_FIND_AND_OPEN_SOLIB \
 137   (current_target_so_ops->find_and_open_solib)
 138 #define TARGET_SO_IN_DYNSYM_RESOLVE_CODE \
 139   (current_target_so_ops->in_dynsym_resolve_code)
 140
 141 /* Handler for library-specific global symbol lookup in solib.c.  */
 142 struct symbol *solib_global_lookup (const struct objfile *objfile,
 143                                     const char *name,
 144                                     const char *linkage_name,
 145                                     const domain_enum domain,
 146                                     struct symtab **symtab);
 147
 148 #endif