gdb/solib.h

   1 /* Shared library declarations for GDB, the GNU Debugger.
   2    Copyright 1992, 1993, 1995, 1998, 1999, 2000, 2001
   3    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 2 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, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 /* Forward decl's for prototypes */
  23 struct target_ops;
  24
  25 /* Called when we free all symtabs, to free the shared library information
  26    as well. */
  27
  28 #define CLEAR_SOLIB                     clear_solib
  29
  30 extern void clear_solib (void);
  31
  32 /* Called to add symbols from a shared library to gdb's symbol table. */
  33
  34 #define SOLIB_ADD(filename, from_tty, targ) \
  35     solib_add (filename, from_tty, targ)
  36
  37 extern void solib_add (char *, int, struct target_ops *);
  38
  39 /* Function to be called when the inferior starts up, to discover the names
  40    of shared libraries that are dynamically linked, the base addresses to
  41    which they are linked, and sufficient information to read in their symbols
  42    at a later time. */
  43
  44 #define SOLIB_CREATE_INFERIOR_HOOK(PID) solib_create_inferior_hook()
  45
  46 /* Function to be called to remove the connection between debugger and
  47    dynamic linker that was established by SOLIB_CREATE_INFERIOR_HOOK.
  48    (This operation does not remove shared library information from
  49    the debugger, as CLEAR_SOLIB does.)
  50
  51    This functionality is presently not implemented for this target.
  52  */
  53 #define SOLIB_REMOVE_INFERIOR_HOOK(PID) (0)
  54
  55 extern void solib_create_inferior_hook (void);  /* solib.c */
  56
  57 /* This function is called by the "catch load" command.  It allows
  58    the debugger to be notified by the dynamic linker when a specified
  59    library file (or any library file, if filename is NULL) is loaded.
  60
  61    Presently, this functionality is not implemented.
  62  */
  63 #define SOLIB_CREATE_CATCH_LOAD_HOOK(pid,tempflag,filename,cond_string) \
  64    error("catch of library loads/unloads not yet implemented on this platform")
  65
  66 /* This function is called by the "catch unload" command.  It allows
  67    the debugger to be notified by the dynamic linker when a specified
  68    library file (or any library file, if filename is NULL) is unloaded.
  69
  70    Presently, this functionality is not implemented.
  71  */
  72 #define SOLIB_CREATE_CATCH_UNLOAD_HOOK(pid,tempflag,filename,cond_string) \
  73    error("catch of library loads/unloads not yet implemented on this platform")
  74
  75 /* This function returns TRUE if the dynamic linker has just reported
  76    a load of a library.
  77
  78    This function must be used only when the inferior has stopped in
  79    the dynamic linker hook, or undefined results are guaranteed.
  80
  81    Presently, this functionality is not implemented.
  82  */
  83
  84 /*
  85    #define SOLIB_HAVE_LOAD_EVENT(pid) \
  86    error("catch of library loads/unloads not yet implemented on this platform")
  87  */
  88
  89 #define SOLIB_HAVE_LOAD_EVENT(pid) \
  90 (0)
  91
  92 /* This function returns a pointer to the string representation of the
  93    pathname of the dynamically-linked library that has just been loaded.
  94
  95    This function must be used only when SOLIB_HAVE_LOAD_EVENT is TRUE,
  96    or undefined results are guaranteed.
  97
  98    This string's contents are only valid immediately after the inferior
  99    has stopped in the dynamic linker hook, and becomes invalid as soon
 100    as the inferior is continued.  Clients should make a copy of this
 101    string if they wish to continue the inferior and then access the string.
 102
 103    Presently, this functionality is not implemented.
 104  */
 105
 106 /*
 107    #define SOLIB_LOADED_LIBRARY_PATHNAME(pid) \
 108    error("catch of library loads/unloads not yet implemented on this platform")
 109  */
 110
 111 #define SOLIB_LOADED_LIBRARY_PATHNAME(pid) \
 112 (0)
 113
 114 /* This function returns TRUE if the dynamic linker has just reported
 115    an unload of a library.
 116
 117    This function must be used only when the inferior has stopped in
 118    the dynamic linker hook, or undefined results are guaranteed.
 119
 120    Presently, this functionality is not implemented.
 121  */
 122 /*
 123    #define SOLIB_HAVE_UNLOAD_EVENT(pid) \
 124    error("catch of library loads/unloads not yet implemented on this platform")
 125  */
 126
 127 #define SOLIB_HAVE_UNLOAD_EVENT(pid) \
 128 (0)
 129
 130 /* This function returns a pointer to the string representation of the
 131    pathname of the dynamically-linked library that has just been unloaded.
 132
 133    This function must be used only when SOLIB_HAVE_UNLOAD_EVENT is TRUE,
 134    or undefined results are guaranteed.
 135
 136    This string's contents are only valid immediately after the inferior
 137    has stopped in the dynamic linker hook, and becomes invalid as soon
 138    as the inferior is continued.  Clients should make a copy of this
 139    string if they wish to continue the inferior and then access the string.
 140
 141    Presently, this functionality is not implemented.
 142  */
 143 /*
 144    #define SOLIB_UNLOADED_LIBRARY_PATHNAME(pid) \
 145    error("catch of library loads/unloads not yet implemented on this platform")
 146  */
 147
 148 #define SOLIB_UNLOADED_LIBRARY_PATHNAME(pid) \
 149 (0)
 150
 151 /* This function returns TRUE if pc is the address of an instruction that
 152    lies within the dynamic linker (such as the event hook, or the dld
 153    itself).
 154
 155    This function must be used only when a dynamic linker event has been
 156    caught, and the inferior is being stepped out of the hook, or undefined
 157    results are guaranteed.
 158
 159    Presently, this functionality is not implemented.
 160  */
 161
 162 /*
 163    #define SOLIB_IN_DYNAMIC_LINKER(pid,pc) \
 164    error("catch of library loads/unloads not yet implemented on this platform")
 165  */
 166
 167 #define SOLIB_IN_DYNAMIC_LINKER(pid,pc) \
 168 (0)
 169
 170 /* This function must be called when the inferior is killed, and the program
 171    restarted.  This is not the same as CLEAR_SOLIB, in that it doesn't discard
 172    any symbol tables.
 173
 174    Presently, this functionality is not implemented.
 175  */
 176 #define SOLIB_RESTART() \
 177   (0)
 178
 179 /* If we can't set a breakpoint, and it's in a shared library, just
 180    disable it.  */
 181
 182 #define DISABLE_UNSETTABLE_BREAK(addr)  (solib_address(addr) != NULL)
 183
 184 extern char *solib_address (CORE_ADDR); /* solib.c */
 185
 186 /* If ADDR lies in a shared library, return its name.  */
 187
 188 #define PC_SOLIB(addr)  solib_address (addr)
 189
 190 /* Return 1 if PC lies in the dynamic symbol resolution code of the
 191    run time loader.  */
 192
 193 #define IN_SOLIB_DYNSYM_RESOLVE_CODE(pc) in_solib_dynsym_resolve_code (pc)
 194
 195 extern int in_solib_dynsym_resolve_code (CORE_ADDR);    /* solib.c */
 196
 197 /* Discard symbols that were auto-loaded from shared libraries. */
 198
 199 extern void no_shared_libraries (char *ignored, int from_tty);