gdb/nat/linux-procfs.h

   1 /* Linux-specific PROCFS manipulation routines.
   2    Copyright (C) 2011-2024 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef GDB_NAT_LINUX_PROCFS_H
  20 #define GDB_NAT_LINUX_PROCFS_H
  21
  22 #include <unistd.h>
  23
  24 /* Return the TGID of LWPID from /proc/pid/status.  Returns -1 if not
  25    found.  Failure to open the /proc file results in a warning.  */
  26
  27 extern int linux_proc_get_tgid (pid_t lwpid);
  28
  29 /* Return the TracerPid of LWPID from /proc/pid/status.  Returns -1 if
  30    not found.  Does not warn on failure to open the /proc file.  */
  31
  32 extern pid_t linux_proc_get_tracerpid_nowarn (pid_t lwpid);
  33
  34 /* Detect `T (stopped)' in `/proc/PID/status'.
  35    Other states including `T (tracing stop)' are reported as false.  */
  36
  37 extern int linux_proc_pid_is_stopped (pid_t pid);
  38
  39 extern int linux_proc_pid_is_trace_stopped_nowarn (pid_t pid);
  40
  41 /* Return non-zero if PID is a zombie.  Failure to open the
  42    /proc/pid/status file results in a warning.  */
  43
  44 extern int linux_proc_pid_is_zombie (pid_t pid);
  45
  46 /* Return non-zero if PID is a zombie.  Does not warn on failure to
  47    open the /proc file.  */
  48
  49 extern int linux_proc_pid_is_zombie_nowarn (pid_t pid);
  50
  51 /* Return non-zero if /proc/PID/status indicates that PID is gone
  52    (i.e., in Z/Zombie or X/Dead state).  Failure to open the /proc
  53    file is assumed to indicate the thread is gone.  */
  54
  55 extern int linux_proc_pid_is_gone (pid_t pid);
  56
  57 /* Index of fields of interest in /proc/PID/stat, from procfs(5) man page.  */
  58 #define LINUX_PROC_STAT_STATE 3
  59 #define LINUX_PROC_STAT_STARTTIME 22
  60 #define LINUX_PROC_STAT_PROCESSOR 39
  61
  62 /* Returns FIELD (as numbered in procfs(5) man page) of
  63    /proc/PID/task/LWP/stat file.  */
  64
  65 extern std::optional<std::string> linux_proc_get_stat_field (ptid_t ptid,
  66                                                              int field);
  67
  68 /* Return a string giving the thread's name or NULL if the
  69    information is unavailable.  The returned value points to a statically
  70    allocated buffer.  The value therefore becomes invalid at the next
  71    linux_proc_tid_get_name call.  */
  72
  73 extern const char *linux_proc_tid_get_name (ptid_t ptid);
  74
  75 /* Callback function for linux_proc_attach_tgid_threads.  If the PTID
  76    thread is not yet known, try to attach to it and return true,
  77    otherwise return false.  */
  78 typedef int (*linux_proc_attach_lwp_func) (ptid_t ptid);
  79
  80 /* If PID is a tgid, scan the /proc/PID/task/ directory for existing
  81    threads, and call FUNC for each thread found.  */
  82 extern void linux_proc_attach_tgid_threads (pid_t pid,
  83                                             linux_proc_attach_lwp_func func);
  84
  85 /* Return true if the /proc/PID/task/ directory exists.  */
  86 extern int linux_proc_task_list_dir_exists (pid_t pid);
  87
  88 /* Return the full absolute name of the executable file that was run
  89    to create the process PID.  The returned value persists until this
  90    function is next called.  */
  91
  92 extern const char *linux_proc_pid_to_exec_file (int pid);
  93
  94 /* Display possible problems on this system.  Display them only once
  95    per GDB execution.  */
  96
  97 extern void linux_proc_init_warnings ();
  98
  99 #endif /* GDB_NAT_LINUX_PROCFS_H */