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