]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/solib.h
Update copyright year range in header of all files managed by GDB
[thirdparty/binutils-gdb.git] / gdb / solib.h
index eafef48b2b9a4e87244f1464f8111b467aaca370..24c365a0ae0f7520a27f42e5cb90e8a46c8681af 100644 (file)
 /* Shared library declarations for GDB, the GNU Debugger.
-   Copyright (C) 1992, 1998 Free Software Foundation, Inc.
 
-This file is part of GDB.
+   Copyright (C) 1992-2023 Free Software Foundation, Inc.
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+   This file is part of GDB.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-#ifdef __STDC__                /* Forward decl's for prototypes */
-struct target_ops;
-#endif
-
-/* Called when we free all symtabs, to free the shared library information
-   as well. */
-
-#define CLEAR_SOLIB                    clear_solib
-
-extern void
-clear_solib PARAMS ((void));
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
-/* Called to add symbols from a shared library to gdb's symbol table. */
+#ifndef SOLIB_H
+#define SOLIB_H
 
-#define SOLIB_ADD(filename, from_tty, targ) \
-    solib_add (filename, from_tty, targ)
+/* Forward decl's for prototypes */
+struct so_list;
+struct target_ops;
+struct target_so_ops;
+struct program_space;
 
-extern void
-solib_add PARAMS ((char *, int, struct target_ops *));
+#include "gdb_bfd.h"
+#include "symfile-add-flags.h"
 
-/* Function to be called when the inferior starts up, to discover the names
-   of shared libraries that are dynamically linked, the base addresses to
-   which they are linked, and sufficient information to read in their symbols
-   at a later time. */
+/* Value of the 'set debug solib' configuration variable.  */
 
-#define SOLIB_CREATE_INFERIOR_HOOK(PID)        solib_create_inferior_hook()
+extern bool debug_solib;
 
-/* Function to be called to remove the connection between debugger and
-   dynamic linker that was established by SOLIB_CREATE_INFERIOR_HOOK.
-   (This operation does not remove shared library information from
-   the debugger, as CLEAR_SOLIB does.)
+/* Print an "solib" debug statement.  */
 
-   This functionality is presently not implemented for this target.
-   */
-#define SOLIB_REMOVE_INFERIOR_HOOK(PID) (0)
+#define solib_debug_printf(fmt, ...) \
+  debug_prefixed_printf_cond (debug_solib, "solib", fmt, ##__VA_ARGS__)
 
-extern void
-solib_create_inferior_hook PARAMS((void));     /* solib.c */
+#define SOLIB_SCOPED_DEBUG_START_END(fmt, ...) \
+  scoped_debug_start_end (debug_solib, "solib", fmt, ##__VA_ARGS__)
 
-/* This function is called by the "catch load" command.  It allows
-   the debugger to be notified by the dynamic linker when a specified
-   library file (or any library file, if filename is NULL) is loaded.
+/* Called when we free all symtabs, to free the shared library information
+   as well.  */
 
-   Presently, this functionality is not implemented.
-   */
-#define SOLIB_CREATE_CATCH_LOAD_HOOK(pid,tempflag,filename,cond_string) \
-   error("catch of library loads/unloads not yet implemented on this platform")
+extern void clear_solib (void);
 
-/* This function is called by the "catch unload" command.  It allows
-   the debugger to be notified by the dynamic linker when a specified
-   library file (or any library file, if filename is NULL) is unloaded.
+/* Called to add symbols from a shared library to gdb's symbol table.  */
 
-   Presently, this functionality is not implemented.
-   */
-#define SOLIB_CREATE_CATCH_UNLOAD_HOOK(pid,tempflag,filename,cond_string) \
-   error("catch of library loads/unloads not yet implemented on this platform")
+extern void solib_add (const char *, int, int);
+extern bool solib_read_symbols (struct so_list *, symfile_add_flags);
 
-/* This function returns TRUE if the dynamic linker has just reported
-   a load of a library.
+/* Function to be called when the inferior starts up, to discover the
+   names of shared libraries that are dynamically linked, the base
+   addresses to which they are linked, and sufficient information to
+   read in their symbols at a later time.  */
 
-   This function must be used only when the inferior has stopped in
-   the dynamic linker hook, or undefined results are guaranteed.
+extern void solib_create_inferior_hook (int from_tty);
 
-   Presently, this functionality is not implemented.
-   */
+/* If ADDR lies in a shared library, return its name.  */
 
-/*
-#define SOLIB_HAVE_LOAD_EVENT(pid) \
-    error("catch of library loads/unloads not yet implemented on this platform")
-*/
+extern const char *solib_name_from_address (struct program_space *, CORE_ADDR);
 
-#define SOLIB_HAVE_LOAD_EVENT(pid) \
-(0)
+/* Return true if ADDR lies within SOLIB.  */
 
-/* This function returns a pointer to the string representation of the
-   pathname of the dynamically-linked library that has just been loaded.
+extern bool solib_contains_address_p (const struct so_list *, CORE_ADDR);
 
-   This function must be used only when SOLIB_HAVE_LOAD_EVENT is TRUE,
-   or undefined results are guaranteed.
+/* Return whether the data starting at VADDR, size SIZE, must be kept
+   in a core file for shared libraries loaded before "gcore" is used
+   to be handled correctly when the core file is loaded.  This only
+   applies when the section would otherwise not be kept in the core
+   file (in particular, for readonly sections).  */
 
-   This string's contents are only valid immediately after the inferior
-   has stopped in the dynamic linker hook, and becomes invalid as soon
-   as the inferior is continued.  Clients should make a copy of this
-   string if they wish to continue the inferior and then access the string.
+extern bool solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size);
 
-   Presently, this functionality is not implemented.
-   */
+/* Return true if PC lies in the dynamic symbol resolution code of the
+   run time loader.  */
 
-/*
-#define SOLIB_LOADED_LIBRARY_PATHNAME(pid) \
-   error("catch of library loads/unloads not yet implemented on this platform")
-*/
+extern bool in_solib_dynsym_resolve_code (CORE_ADDR);
 
-#define SOLIB_LOADED_LIBRARY_PATHNAME(pid) \
-(0)
+/* Discard symbols that were auto-loaded from shared libraries.  */
 
-/* This function returns TRUE if the dynamic linker has just reported
-   an unload of a library.
+extern void no_shared_libraries (const char *ignored, int from_tty);
 
-   This function must be used only when the inferior has stopped in
-   the dynamic linker hook, or undefined results are guaranteed.
+/* Synchronize GDB's shared object list with inferior's.
 
-   Presently, this functionality is not implemented.
-   */
-/*
-#define SOLIB_HAVE_UNLOAD_EVENT(pid) \
-   error("catch of library loads/unloads not yet implemented on this platform")
-*/
+   Extract the list of currently loaded shared objects from the
+   inferior, and compare it with the list of shared objects in the
+   current program space's list of shared libraries.  Edit
+   so_list_head to bring it in sync with the inferior's new list.
 
-#define SOLIB_HAVE_UNLOAD_EVENT(pid) \
-(0)
+   If we notice that the inferior has unloaded some shared objects,
+   free any symbolic info GDB had read about those shared objects.
 
-/* This function returns a pointer to the string representation of the
-   pathname of the dynamically-linked library that has just been unloaded.
+   Don't load symbolic info for any new shared objects; just add them
+   to the list, and leave their symbols_loaded flag clear.
 
-   This function must be used only when SOLIB_HAVE_UNLOAD_EVENT is TRUE,
-   or undefined results are guaranteed.
+   If FROM_TTY is non-null, feel free to print messages about what
+   we're doing.  */
 
-   This string's contents are only valid immediately after the inferior
-   has stopped in the dynamic linker hook, and becomes invalid as soon
-   as the inferior is continued.  Clients should make a copy of this
-   string if they wish to continue the inferior and then access the string.
+extern void update_solib_list (int from_tty);
 
-   Presently, this functionality is not implemented.
-   */
-/*
-#define SOLIB_UNLOADED_LIBRARY_PATHNAME(pid) \
-   error("catch of library loads/unloads not yet implemented on this platform")
-*/
+/* Return true if NAME is the libpthread shared library.  */
 
-#define SOLIB_UNLOADED_LIBRARY_PATHNAME(pid) \
-(0)
+extern bool libpthread_name_p (const char *name);
 
-/* This function returns TRUE if pc is the address of an instruction that
-   lies within the dynamic linker (such as the event hook, or the dld
-   itself).
+/* Look up symbol from both symbol table and dynamic string table.  */
 
-   This function must be used only when a dynamic linker event has been
-   caught, and the inferior is being stepped out of the hook, or undefined
-   results are guaranteed.
+extern CORE_ADDR gdb_bfd_lookup_symbol (bfd *abfd,
+                                       int (*match_sym) (const asymbol *,
+                                                         const void *),
+                                       const void *data);
 
-   Presently, this functionality is not implemented.
-   */
+/* Look up symbol from symbol table.  */
 
-/*
-#define SOLIB_IN_DYNAMIC_LINKER(pid,pc) \
-   error("catch of library loads/unloads not yet implemented on this platform")
-*/
+extern CORE_ADDR gdb_bfd_lookup_symbol_from_symtab (bfd *abfd,
+                                                   int (*match_sym)
+                                                     (const asymbol *,
+                                                      const void *),
+                                                   const void *data);
 
-#define SOLIB_IN_DYNAMIC_LINKER(pid,pc) \
-(0)
+/* Scan for DESIRED_DYNTAG in .dynamic section of ABFD.  If DESIRED_DYNTAG is
+   found, 1 is returned and the corresponding PTR and PTR_ADDR are set.  */
 
-/* This function must be called when the inferior is killed, and the program
-   restarted.  This is not the same as CLEAR_SOLIB, in that it doesn't discard
-   any symbol tables.
+extern int gdb_bfd_scan_elf_dyntag (const int desired_dyntag, bfd *abfd,
+                                   CORE_ADDR *ptr, CORE_ADDR *ptr_addr);
 
-   Presently, this functionality is not implemented.
-   */
-#define SOLIB_RESTART() \
-  (0)
+/* If FILENAME refers to an ELF shared object then attempt to return the
+   string referred to by its DT_SONAME tag.   */
 
-/* If we can't set a breakpoint, and it's in a shared library, just
-   disable it.  */
+extern gdb::unique_xmalloc_ptr<char> gdb_bfd_read_elf_soname
+  (const char *filename);
 
-#define DISABLE_UNSETTABLE_BREAK(addr) (solib_address(addr) != NULL)
+/* Enable or disable optional solib event breakpoints as appropriate.  */
 
-extern char *
-solib_address PARAMS ((CORE_ADDR));            /* solib.c */
+extern void update_solib_breakpoints (void);
 
-/* If ADDR lies in a shared library, return its name.  */
+/* Handle an solib event by calling solib_add.  */
 
-#define PC_SOLIB(addr) solib_address (addr)
+extern void handle_solib_event (void);
 
-#ifdef SVR4_SHARED_LIBS
+/* Associate SONAME with BUILD_ID in ABFD's registry so that it can be
+   retrieved with get_cbfd_soname_build_id.  */
 
-/* Return 1 if PC lies in the dynamic symbol resolution code of the
-   SVR4 run time loader.  */
+extern void set_cbfd_soname_build_id (gdb_bfd_ref_ptr abfd,
+                                     const char *soname,
+                                     const bfd_build_id *build_id);
 
-#define IN_SOLIB_DYNSYM_RESOLVE_CODE(pc) in_svr4_dynsym_resolve_code (pc)
+/* If SONAME had a build-id associated with it in ABFD's registry by a
+   previous call to set_cbfd_soname_build_id then return the build-id
+   as a NULL-terminated hex string.  */
 
-extern int
-in_svr4_dynsym_resolve_code PARAMS ((CORE_ADDR));
+extern gdb::unique_xmalloc_ptr<char> get_cbfd_soname_build_id
+  (gdb_bfd_ref_ptr abfd, const char *soname);
 
-#endif
+#endif /* SOLIB_H */