gdb/solist.h

   1 /* Shared library declarations for GDB, the GNU Debugger.
   2    Copyright (C) 1990-2017 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef SOLIST_H
  20 #define SOLIST_H
  21
  22 #define SO_NAME_MAX_PATH_SIZE 512       /* FIXME: Should be dynamic */
  23 /* For domain_enum domain.  */
  24 #include "symtab.h"
  25 #include "gdb_bfd.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 private data structures associated with SO.
  93        This is called when SO is about to be reloaded.
  94        It is also called before free_so when SO is about to be freed.  */
  95     void (*clear_so) (struct so_list *so);
  96
  97     /* Reset or free private data structures not associated with
  98        so_list entries.  */
  99     void (*clear_solib) (void);
 100
 101     /* Target dependent code to run after child process fork.  */
 102     void (*solib_create_inferior_hook) (int from_tty);
 103
 104     /* Construct a list of the currently loaded shared objects.  This
 105        list does not include an entry for the main executable file.
 106
 107        Note that we only gather information directly available from the
 108        inferior --- we don't examine any of the shared library files
 109        themselves.  The declaration of `struct so_list' says which fields
 110        we provide values for.  */
 111     struct so_list *(*current_sos) (void);
 112
 113     /* Find, open, and read the symbols for the main executable.  If
 114        FROM_TTYP dereferences to a non-zero integer, allow messages to
 115        be printed.  This parameter is a pointer rather than an int
 116        because open_symbol_file_object is called via catch_errors and
 117        catch_errors requires a pointer argument.  */
 118     int (*open_symbol_file_object) (void *from_ttyp);
 119
 120     /* Determine if PC lies in the dynamic symbol resolution code of
 121        the run time loader.  */
 122     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
 123
 124     /* Find and open shared library binary file.  */
 125     gdb_bfd_ref_ptr (*bfd_open) (char *pathname);
 126
 127     /* Optional extra hook for finding and opening a solib.
 128        If TEMP_PATHNAME is non-NULL: If the file is successfully opened a
 129        pointer to a malloc'd and realpath'd copy of SONAME is stored there,
 130        otherwise NULL is stored there.  */
 131     int (*find_and_open_solib) (const char *soname,
 132         unsigned o_flags, char **temp_pathname);
 133
 134     /* Hook for looking up global symbols in a library-specific way.  */
 135     struct block_symbol (*lookup_lib_global_symbol)
 136       (struct objfile *objfile,
 137        const char *name,
 138        const domain_enum domain);
 139
 140     /* Given two so_list objects, one from the GDB thread list
 141        and another from the list returned by current_sos, return 1
 142        if they represent the same library.
 143        Falls back to using strcmp on so_original_name field when set
 144        to NULL.  */
 145     int (*same) (struct so_list *gdb, struct so_list *inferior);
 146
 147     /* Return whether a region of memory must be kept in a core file
 148        for shared libraries loaded before "gcore" is used to be
 149        handled correctly when the core file is loaded.  This only
 150        applies when the section would otherwise not be kept in the
 151        core file (in particular, for readonly sections).  */
 152     int (*keep_data_in_core) (CORE_ADDR vaddr,
 153                               unsigned long size);
 154
 155     /* Enable or disable optional solib event breakpoints as
 156        appropriate.  This should be called whenever
 157        stop_on_solib_events is changed.  This pointer can be
 158        NULL, in which case no enabling or disabling is necessary
 159        for this target.  */
 160     void (*update_breakpoints) (void);
 161
 162     /* Target-specific processing of solib events that will be
 163        performed before solib_add is called.  This pointer can be
 164        NULL, in which case no specific preprocessing is necessary
 165        for this target.  */
 166     void (*handle_event) (void);
 167   };
 168
 169 /* Free the memory associated with a (so_list *).  */
 170 void free_so (struct so_list *so);
 171
 172 /* Return address of first so_list entry in master shared object list.  */
 173 struct so_list *master_so_list (void);
 174
 175 /* Find main executable binary file.  */
 176 extern char *exec_file_find (const char *in_pathname, int *fd);
 177
 178 /* Find shared library binary file.  */
 179 extern char *solib_find (const char *in_pathname, int *fd);
 180
 181 /* Open BFD for shared library file.  */
 182 extern gdb_bfd_ref_ptr solib_bfd_fopen (char *pathname, int fd);
 183
 184 /* Find solib binary file and open it.  */
 185 extern gdb_bfd_ref_ptr solib_bfd_open (char *in_pathname);
 186
 187 /* FIXME: gdbarch needs to control this variable.  */
 188 extern struct target_so_ops *current_target_so_ops;
 189
 190 /* Handler for library-specific global symbol lookup in solib.c.  */
 191 struct block_symbol solib_global_lookup (struct objfile *objfile,
 192                                             const char *name,
 193                                             const domain_enum domain);
 194
 195 #endif