gdb/solib.h

   1 /* Shared library declarations for GDB, the GNU Debugger.
   2
   3    Copyright (C) 1992-2024 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 3 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef SOLIB_H
  21 #define SOLIB_H
  22
  23 /* Forward decl's for prototypes */
  24 struct shobj;
  25 struct target_ops;
  26 struct target_so_ops;
  27 struct program_space;
  28
  29 #include "gdb_bfd.h"
  30 #include "symfile-add-flags.h"
  31 #include "gdbsupport/function-view.h"
  32
  33 /* Value of the 'set debug solib' configuration variable.  */
  34
  35 extern bool debug_solib;
  36
  37 /* Print an "solib" debug statement.  */
  38
  39 #define solib_debug_printf(fmt, ...) \
  40   debug_prefixed_printf_cond (debug_solib, "solib", fmt, ##__VA_ARGS__)
  41
  42 #define SOLIB_SCOPED_DEBUG_START_END(fmt, ...) \
  43   scoped_debug_start_end (debug_solib, "solib", fmt, ##__VA_ARGS__)
  44
  45 /* Called when we free all symtabs, to free the shared library information
  46    as well.  */
  47
  48 extern void clear_solib (void);
  49
  50 /* Called to add symbols from a shared library to gdb's symbol table.  */
  51
  52 extern void solib_add (const char *, int, int);
  53 extern bool solib_read_symbols (shobj &, symfile_add_flags);
  54
  55 /* Function to be called when the inferior starts up, to discover the
  56    names of shared libraries that are dynamically linked, the base
  57    addresses to which they are linked, and sufficient information to
  58    read in their symbols at a later time.  */
  59
  60 extern void solib_create_inferior_hook (int from_tty);
  61
  62 /* If ADDR lies in a shared library, return its name.  */
  63
  64 extern const char *solib_name_from_address (struct program_space *, CORE_ADDR);
  65
  66 /* Return true if ADDR lies within SOLIB.  */
  67
  68 extern bool solib_contains_address_p (const shobj &, CORE_ADDR);
  69
  70 /* Return whether the data starting at VADDR, size SIZE, must be kept
  71    in a core file for shared libraries loaded before "gcore" is used
  72    to be handled correctly when the core file is loaded.  This only
  73    applies when the section would otherwise not be kept in the core
  74    file (in particular, for readonly sections).  */
  75
  76 extern bool solib_keep_data_in_core (CORE_ADDR vaddr, unsigned long size);
  77
  78 /* Return true if PC lies in the dynamic symbol resolution code of the
  79    run time loader.  */
  80
  81 extern bool in_solib_dynsym_resolve_code (CORE_ADDR);
  82
  83 /* Discard symbols that were auto-loaded from shared libraries.  */
  84
  85 extern void no_shared_libraries (const char *ignored, int from_tty);
  86
  87 /* Synchronize GDB's shared object list with inferior's.
  88
  89    Extract the list of currently loaded shared objects from the
  90    inferior, and compare it with the list of shared objects in the
  91    current program space's list of shared libraries.  Edit
  92    so_list_head to bring it in sync with the inferior's new list.
  93
  94    If we notice that the inferior has unloaded some shared objects,
  95    free any symbolic info GDB had read about those shared objects.
  96
  97    Don't load symbolic info for any new shared objects; just add them
  98    to the list, and leave their symbols_loaded flag clear.
  99
 100    If FROM_TTY is non-null, feel free to print messages about what
 101    we're doing.  */
 102
 103 extern void update_solib_list (int from_tty);
 104
 105 /* Return true if NAME is the libpthread shared library.  */
 106
 107 extern bool libpthread_name_p (const char *name);
 108
 109 /* Look up symbol from both symbol table and dynamic string table.  */
 110
 111 extern CORE_ADDR gdb_bfd_lookup_symbol
 112      (bfd *abfd, gdb::function_view<bool (const asymbol *)> match_sym);
 113
 114 /* Look up symbol from symbol table.  */
 115
 116 extern CORE_ADDR gdb_bfd_lookup_symbol_from_symtab
 117      (bfd *abfd, gdb::function_view<bool (const asymbol *)> match_sym);
 118
 119 /* Scan for DESIRED_DYNTAG in .dynamic section of ABFD.  If DESIRED_DYNTAG is
 120    found, 1 is returned and the corresponding PTR and PTR_ADDR are set.  */
 121
 122 extern int gdb_bfd_scan_elf_dyntag (const int desired_dyntag, bfd *abfd,
 123                                     CORE_ADDR *ptr, CORE_ADDR *ptr_addr);
 124
 125 /* If FILENAME refers to an ELF shared object then attempt to return the
 126    string referred to by its DT_SONAME tag.   */
 127
 128 extern gdb::unique_xmalloc_ptr<char> gdb_bfd_read_elf_soname
 129   (const char *filename);
 130
 131 /* Enable or disable optional solib event breakpoints as appropriate.  */
 132
 133 extern void update_solib_breakpoints (void);
 134
 135 /* Handle an solib event by calling solib_add.  */
 136
 137 extern void handle_solib_event (void);
 138
 139 /* Associate SONAME with BUILD_ID in ABFD's registry so that it can be
 140    retrieved with get_cbfd_soname_build_id.  */
 141
 142 extern void set_cbfd_soname_build_id (gdb_bfd_ref_ptr abfd,
 143                                       const char *soname,
 144                                       const bfd_build_id *build_id);
 145
 146 #endif /* SOLIB_H */