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