gdbsupport/gdb-dlfcn.h

   1 /* Platform independent shared object routines for GDB.
   2
   3    Copyright (C) 2011-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 GDB_DLFCN_H
  21 #define GDB_DLFCN_H
  22
  23 /* A deleter that closes an open dynamic library.  */
  24
  25 struct dlclose_deleter
  26 {
  27   void operator() (void *handle) const;
  28 };
  29
  30 /* A unique pointer that points to a dynamic library.  */
  31
  32 typedef std::unique_ptr<void, dlclose_deleter> gdb_dlhandle_up;
  33
  34 /* Load the dynamic library file named FILENAME, and return a handle
  35    for that dynamic library.  Throw an error if the loading fails for
  36    any reason.  */
  37
  38 gdb_dlhandle_up gdb_dlopen (const char *filename);
  39
  40 /* Return the address of the symbol named SYMBOL inside the shared
  41    library whose handle is HANDLE.  Return NULL when the symbol could
  42    not be found.  */
  43
  44 void *gdb_dlsym (const gdb_dlhandle_up &handle, const char *symbol);
  45
  46 /* Return non-zero if the dynamic library functions are available on
  47    this platform.  */
  48
  49 int is_dl_available(void);
  50
  51 #endif /* GDB_DLFCN_H */