gdb/nat/linux-nat.h

   1 /* Code for native debugging support for GNU/Linux (LWP layer).
   2
   3    Copyright (C) 2000-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_NAT_LINUX_NAT_H
  21 #define GDB_NAT_LINUX_NAT_H
  22
  23 #include "gdbsupport/function-view.h"
  24 #include "target/waitstatus.h"
  25
  26 struct lwp_info;
  27 struct arch_lwp_info;
  28
  29 /* This is the kernel's hard limit.  Not to be confused with SIGRTMIN.  */
  30 #ifndef __SIGRTMIN
  31 #define __SIGRTMIN 32
  32 #endif
  33
  34 /* Unlike other extended result codes, WSTOPSIG (status) on
  35    PTRACE_O_TRACESYSGOOD syscall events doesn't return SIGTRAP, but
  36    instead SIGTRAP with bit 7 set.  */
  37 #define SYSCALL_SIGTRAP (SIGTRAP | 0x80)
  38
  39 /* Does the current host support PTRACE_GETREGSET?  */
  40 extern tribool have_ptrace_getregset;
  41
  42 /* Return the ptid of the current lightweight process.  With NPTL
  43    threads and LWPs map 1:1, so this is equivalent to returning the
  44    ptid of the current thread.  This function must be provided by
  45    the client. */
  46
  47 extern ptid_t current_lwp_ptid (void);
  48
  49 /* Function type for the CALLBACK argument of iterate_over_lwps.  */
  50 typedef int (iterate_over_lwps_ftype) (struct lwp_info *lwp);
  51
  52 /* Iterate over all LWPs.  Calls CALLBACK with its second argument set
  53    to DATA for every LWP in the list.  If CALLBACK returns nonzero for
  54    a particular LWP, return a pointer to the structure describing that
  55    LWP immediately.  Otherwise return NULL.  This function must be
  56    provided by the client.  */
  57
  58 extern struct lwp_info *iterate_over_lwps
  59     (ptid_t filter,
  60      gdb::function_view<iterate_over_lwps_ftype> callback);
  61
  62 /* Return the ptid of LWP.  */
  63
  64 extern ptid_t ptid_of_lwp (struct lwp_info *lwp);
  65
  66 /* Set the architecture-specific data of LWP.  This function must be
  67    provided by the client. */
  68
  69 extern void lwp_set_arch_private_info (struct lwp_info *lwp,
  70                                        struct arch_lwp_info *info);
  71
  72 /* Return the architecture-specific data of LWP.  This function must
  73    be provided by the client. */
  74
  75 extern struct arch_lwp_info *lwp_arch_private_info (struct lwp_info *lwp);
  76
  77 /* Return nonzero if LWP is stopped, zero otherwise.  This function
  78    must be provided by the client.  */
  79
  80 extern int lwp_is_stopped (struct lwp_info *lwp);
  81
  82 /* Return the reason the LWP last stopped.  This function must be
  83    provided by the client.  */
  84
  85 extern enum target_stop_reason lwp_stop_reason (struct lwp_info *lwp);
  86
  87 /* Cause LWP to stop.  This function must be provided by the
  88    client.  */
  89
  90 extern void linux_stop_lwp (struct lwp_info *lwp);
  91
  92 /* Return nonzero if we are single-stepping this LWP at the ptrace
  93    level.  */
  94
  95 extern int lwp_is_stepping (struct lwp_info *lwp);
  96
  97 #endif /* GDB_NAT_LINUX_NAT_H */