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 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     struct objfile *objfile;    /* objfile for loaded lib */
  67     struct target_section *sections;
  68     struct target_section *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 target_section *);
  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) (int from_tty);
  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     /* Find and open shared library binary file.  */
 109     bfd *(*bfd_open) (char *pathname);
 110
 111     /* Extra hook for finding and opening a solib.
 112        Convenience function for remote debuggers finding host libs.  */
 113     int (*find_and_open_solib) (char *soname,
 114         unsigned o_flags, char **temp_pathname);
 115
 116     /* Hook for looking up global symbols in a library-specific way.  */
 117     struct symbol * (*lookup_lib_global_symbol) (const struct objfile *objfile,
 118                                                  const char *name,
 119                                                  const domain_enum domain);
 120
 121     /* Given two so_list objects, one from the GDB thread list
 122        and another from the list returned by current_sos, return 1
 123        if they represent the same library.
 124        Falls back to using strcmp on so_original_name field when set
 125        to NULL.  */
 126     int (*same) (struct so_list *gdb, struct so_list *inferior);
 127
 128     /* Return whether a region of memory must be kept in a core file
 129        for shared libraries loaded before "gcore" is used to be
 130        handled correctly when the core file is loaded.  This only
 131        applies when the section would otherwise not be kept in the
 132        core file (in particular, for readonly sections).  */
 133     int (*keep_data_in_core) (CORE_ADDR vaddr,
 134                               unsigned long size);
 135   };
 136
 137 /* Free the memory associated with a (so_list *).  */
 138 void free_so (struct so_list *so);
 139
 140 /* Return address of first so_list entry in master shared object list.  */
 141 struct so_list *master_so_list (void);
 142
 143 /* Find shared library binary file.  */
 144 extern char *solib_find (char *in_pathname, int *fd);
 145
 146 /* Open BFD for shared library file.  */
 147 extern bfd *solib_bfd_fopen (char *pathname, int fd);
 148
 149 /* Find solib binary file and open it.  */
 150 extern bfd *solib_bfd_open (char *in_pathname);
 151
 152 /* FIXME: gdbarch needs to control this variable */
 153 extern struct target_so_ops *current_target_so_ops;
 154
 155 /* Handler for library-specific global symbol lookup in solib.c.  */
 156 struct symbol *solib_global_lookup (const struct objfile *objfile,
 157                                     const char *name,
 158                                     const domain_enum domain);
 159
 160 #endif