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, 2008, 2009, 2010, 2011 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 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef SOLIST_H
  21 #define SOLIST_H
  22
  23 #define SO_NAME_MAX_PATH_SIZE 512       /* FIXME: Should be dynamic */
  24 /* For domain_enum domain.  */
  25 #include "symtab.h"
  26
  27 /* Forward declaration for target specific link map information.  This
  28    struct is opaque to all but the target specific file.  */
  29 struct lm_info;
  30
  31 struct so_list
  32   {
  33     /* The following fields of the structure come directly from the
  34        dynamic linker's tables in the inferior, and are initialized by
  35        current_sos.  */
  36
  37     struct so_list *next;       /* next structure in linked list */
  38
  39     /* A pointer to target specific link map information.  Often this
  40        will be a copy of struct link_map from the user process, but
  41        it need not be; it can be any collection of data needed to
  42        traverse the dynamic linker's data structures.  */
  43     struct lm_info *lm_info;
  44
  45     /* Shared object file name, exactly as it appears in the
  46        inferior's link map.  This may be a relative path, or something
  47        which needs to be looked up in LD_LIBRARY_PATH, etc.  We use it
  48        to tell which entries in the inferior's dynamic linker's link
  49        map we've already loaded.  */
  50     char so_original_name[SO_NAME_MAX_PATH_SIZE];
  51
  52     /* Shared object file name, expanded to something GDB can open.  */
  53     char so_name[SO_NAME_MAX_PATH_SIZE];
  54
  55     /* Program space this shared library belongs to.  */
  56     struct program_space *pspace;
  57
  58     /* The following fields of the structure are built from
  59        information gathered from the shared object file itself, and
  60        are set when we actually add it to our symbol tables.
  61
  62        current_sos must initialize these fields to 0.  */
  63
  64     bfd *abfd;
  65     char symbols_loaded;        /* flag: symbols read in yet?  */
  66
  67     /* objfile with symbols for a loaded library.  Target memory is read from
  68        ABFD.  OBJFILE may be NULL either before symbols have been loaded, if
  69        the file cannot be found or after the command "nosharedlibrary".  */
  70     struct objfile *objfile;
  71
  72     struct target_section *sections;
  73     struct target_section *sections_end;
  74
  75     /* Record the range of addresses belonging to this shared library.
  76        There may not be just one (e.g. if two segments are relocated
  77        differently); but this is only used for "info sharedlibrary".  */
  78     CORE_ADDR addr_low, addr_high;
  79   };
  80
  81 struct target_so_ops
  82   {
  83     /* Adjust the section binding addresses by the base address at
  84        which the object was actually mapped.  */
  85     void (*relocate_section_addresses) (struct so_list *so,
  86                                         struct target_section *);
  87
  88     /* Free the link map info and any other private data structures
  89        associated with a so_list entry.  */
  90     void (*free_so) (struct so_list *so);
  91
  92     /* Reset or free private data structures not associated with
  93        so_list entries.  */
  94     void (*clear_solib) (void);
  95
  96     /* Target dependent code to run after child process fork.  */
  97     void (*solib_create_inferior_hook) (int from_tty);
  98
  99     /* Do additional symbol handling, lookup, etc. after symbols for a
 100        shared object have been loaded in the usual way.  This is
 101        called to do any system specific symbol handling that might be
 102        needed.  */
 103     void (*special_symbol_handling) (void);
 104
 105     /* Construct a list of the currently loaded shared objects.  This
 106        list does not include an entry for the main executable file.
 107
 108        Note that we only gather information directly available from the
 109        inferior --- we don't examine any of the shared library files
 110        themselves.  The declaration of `struct so_list' says which fields
 111        we provide values for.  */
 112     struct so_list *(*current_sos) (void);
 113
 114     /* Find, open, and read the symbols for the main executable.  If
 115        FROM_TTYP dereferences to a non-zero integer, allow messages to
 116        be printed.  This parameter is a pointer rather than an int
 117        because open_symbol_file_object is called via catch_errors and
 118        catch_errors requires a pointer argument.  */
 119     int (*open_symbol_file_object) (void *from_ttyp);
 120
 121     /* Determine if PC lies in the dynamic symbol resolution code of
 122        the run time loader.  */
 123     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
 124
 125     /* Find and open shared library binary file.  */
 126     bfd *(*bfd_open) (char *pathname);
 127
 128     /* Extra hook for finding and opening a solib.
 129        Convenience function for remote debuggers finding host libs.  */
 130     int (*find_and_open_solib) (char *soname,
 131         unsigned o_flags, char **temp_pathname);
 132
 133     /* Hook for looking up global symbols in a library-specific way.  */
 134     struct symbol * (*lookup_lib_global_symbol) (const struct objfile *objfile,
 135                                                  const char *name,
 136                                                  const domain_enum domain);
 137
 138     /* Given two so_list objects, one from the GDB thread list
 139        and another from the list returned by current_sos, return 1
 140        if they represent the same library.
 141        Falls back to using strcmp on so_original_name field when set
 142        to NULL.  */
 143     int (*same) (struct so_list *gdb, struct so_list *inferior);
 144
 145     /* Return whether a region of memory must be kept in a core file
 146        for shared libraries loaded before "gcore" is used to be
 147        handled correctly when the core file is loaded.  This only
 148        applies when the section would otherwise not be kept in the
 149        core file (in particular, for readonly sections).  */
 150     int (*keep_data_in_core) (CORE_ADDR vaddr,
 151                               unsigned long size);
 152   };
 153
 154 /* Free the memory associated with a (so_list *).  */
 155 void free_so (struct so_list *so);
 156
 157 /* Return address of first so_list entry in master shared object list.  */
 158 struct so_list *master_so_list (void);
 159
 160 /* Find shared library binary file.  */
 161 extern char *solib_find (char *in_pathname, int *fd);
 162
 163 /* Open BFD for shared library file.  */
 164 extern bfd *solib_bfd_fopen (char *pathname, int fd);
 165
 166 /* Find solib binary file and open it.  */
 167 extern bfd *solib_bfd_open (char *in_pathname);
 168
 169 /* FIXME: gdbarch needs to control this variable.  */
 170 extern struct target_so_ops *current_target_so_ops;
 171
 172 /* Handler for library-specific global symbol lookup in solib.c.  */
 173 struct symbol *solib_global_lookup (const struct objfile *objfile,
 174                                     const char *name,
 175                                     const domain_enum domain);
 176
 177 #endif