gdb/solib.h

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