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