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 #define ALL_SO_LIBS(so) \
  28     for (so = so_list_head; \
  29          so != NULL; \
  30          so = so->next)
  31
  32 /* Forward declaration for target specific link map information.  This
  33    struct is opaque to all but the target specific file.  */
  34 struct lm_info;
  35
  36 struct so_list
  37   {
  38     /* The following fields of the structure come directly from the
  39        dynamic linker's tables in the inferior, and are initialized by
  40        current_sos.  */
  41
  42     struct so_list *next;       /* next structure in linked list */
  43
  44     /* A pointer to target specific link map information.  Often this
  45        will be a copy of struct link_map from the user process, but
  46        it need not be; it can be any collection of data needed to
  47        traverse the dynamic linker's data structures.  */
  48     struct lm_info *lm_info;
  49
  50     /* Shared object file name, exactly as it appears in the
  51        inferior's link map.  This may be a relative path, or something
  52        which needs to be looked up in LD_LIBRARY_PATH, etc.  We use it
  53        to tell which entries in the inferior's dynamic linker's link
  54        map we've already loaded.  */
  55     char so_original_name[SO_NAME_MAX_PATH_SIZE];
  56
  57     /* Shared object file name, expanded to something GDB can open.  */
  58     char so_name[SO_NAME_MAX_PATH_SIZE];
  59
  60     /* Program space this shared library belongs to.  */
  61     struct program_space *pspace;
  62
  63     /* The following fields of the structure are built from
  64        information gathered from the shared object file itself, and
  65        are set when we actually add it to our symbol tables.
  66
  67        current_sos must initialize these fields to 0.  */
  68
  69     bfd *abfd;
  70     char symbols_loaded;        /* flag: symbols read in yet?  */
  71
  72     /* objfile with symbols for a loaded library.  Target memory is read from
  73        ABFD.  OBJFILE may be NULL either before symbols have been loaded, if
  74        the file cannot be found or after the command "nosharedlibrary".  */
  75     struct objfile *objfile;
  76
  77     struct target_section *sections;
  78     struct target_section *sections_end;
  79
  80     /* Record the range of addresses belonging to this shared library.
  81        There may not be just one (e.g. if two segments are relocated
  82        differently).  This is used for "info sharedlibrary" and
  83        the MI command "-file-list-shared-libraries".  The latter has a format
  84        that supports outputting multiple segments once the related code
  85        supports them.  */
  86     CORE_ADDR addr_low, addr_high;
  87   };
  88
  89 struct target_so_ops
  90   {
  91     /* Adjust the section binding addresses by the base address at
  92        which the object was actually mapped.  */
  93     void (*relocate_section_addresses) (struct so_list *so,
  94                                         struct target_section *);
  95
  96     /* Free the link map info and any other private data structures
  97        associated with a so_list entry.  */
  98     void (*free_so) (struct so_list *so);
  99
 100     /* Reset private data structures associated with SO.
 101        This is called when SO is about to be reloaded.
 102        It is also called before free_so when SO is about to be freed.  */
 103     void (*clear_so) (struct so_list *so);
 104
 105     /* Reset or free private data structures not associated with
 106        so_list entries.  */
 107     void (*clear_solib) (void);
 108
 109     /* Target dependent code to run after child process fork.  */
 110     void (*solib_create_inferior_hook) (int from_tty);
 111
 112     /* Construct a list of the currently loaded shared objects.  This
 113        list does not include an entry for the main executable file.
 114
 115        Note that we only gather information directly available from the
 116        inferior --- we don't examine any of the shared library files
 117        themselves.  The declaration of `struct so_list' says which fields
 118        we provide values for.  */
 119     struct so_list *(*current_sos) (void);
 120
 121     /* Find, open, and read the symbols for the main executable.  If
 122        FROM_TTYP dereferences to a non-zero integer, allow messages to
 123        be printed.  This parameter is a pointer rather than an int
 124        because open_symbol_file_object is called via catch_errors and
 125        catch_errors requires a pointer argument.  */
 126     int (*open_symbol_file_object) (void *from_ttyp);
 127
 128     /* Determine if PC lies in the dynamic symbol resolution code of
 129        the run time loader.  */
 130     int (*in_dynsym_resolve_code) (CORE_ADDR pc);
 131
 132     /* Find and open shared library binary file.  */
 133     gdb_bfd_ref_ptr (*bfd_open) (char *pathname);
 134
 135     /* Optional extra hook for finding and opening a solib.
 136        If TEMP_PATHNAME is non-NULL: If the file is successfully opened a
 137        pointer to a malloc'd and realpath'd copy of SONAME is stored there,
 138        otherwise NULL is stored there.  */
 139     int (*find_and_open_solib) (const char *soname,
 140         unsigned o_flags, char **temp_pathname);
 141
 142     /* Hook for looking up global symbols in a library-specific way.  */
 143     struct block_symbol (*lookup_lib_global_symbol)
 144       (struct objfile *objfile,
 145        const char *name,
 146        const domain_enum domain);
 147
 148     /* Given two so_list objects, one from the GDB thread list
 149        and another from the list returned by current_sos, return 1
 150        if they represent the same library.
 151        Falls back to using strcmp on so_original_name field when set
 152        to NULL.  */
 153     int (*same) (struct so_list *gdb, struct so_list *inferior);
 154
 155     /* Return whether a region of memory must be kept in a core file
 156        for shared libraries loaded before "gcore" is used to be
 157        handled correctly when the core file is loaded.  This only
 158        applies when the section would otherwise not be kept in the
 159        core file (in particular, for readonly sections).  */
 160     int (*keep_data_in_core) (CORE_ADDR vaddr,
 161                               unsigned long size);
 162
 163     /* Enable or disable optional solib event breakpoints as
 164        appropriate.  This should be called whenever
 165        stop_on_solib_events is changed.  This pointer can be
 166        NULL, in which case no enabling or disabling is necessary
 167        for this target.  */
 168     void (*update_breakpoints) (void);
 169
 170     /* Target-specific processing of solib events that will be
 171        performed before solib_add is called.  This pointer can be
 172        NULL, in which case no specific preprocessing is necessary
 173        for this target.  */
 174     void (*handle_event) (void);
 175   };
 176
 177 /* Free the memory associated with a (so_list *).  */
 178 void free_so (struct so_list *so);
 179
 180 /* Return address of first so_list entry in master shared object list.  */
 181 struct so_list *master_so_list (void);
 182
 183 /* Find main executable binary file.  */
 184 extern char *exec_file_find (const char *in_pathname, int *fd);
 185
 186 /* Find shared library binary file.  */
 187 extern char *solib_find (const char *in_pathname, int *fd);
 188
 189 /* Open BFD for shared library file.  */
 190 extern gdb_bfd_ref_ptr solib_bfd_fopen (char *pathname, int fd);
 191
 192 /* Find solib binary file and open it.  */
 193 extern gdb_bfd_ref_ptr solib_bfd_open (char *in_pathname);
 194
 195 /* FIXME: gdbarch needs to control this variable.  */
 196 extern struct target_so_ops *current_target_so_ops;
 197
 198 /* Handler for library-specific global symbol lookup in solib.c.  */
 199 struct block_symbol solib_global_lookup (struct objfile *objfile,
 200                                             const char *name,
 201                                             const domain_enum domain);
 202
 203 #endif