gdb/gnu-nat.h

   1 /* Common things used by the various *gnu-nat.c files
   2    Copyright (C) 1995-2024 Free Software Foundation, Inc.
   3
   4    Written by Miles Bader <miles@gnu.ai.mit.edu>
   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 GNU_NAT_H
  20 #define GNU_NAT_H
  21
  22 /* Work around conflict between Mach's 'thread_info' function, and GDB's
  23    'thread_info' class.  Make the former available as 'mach_thread_info'.  */
  24 #define thread_info mach_thread_info
  25 /* Mach headers are not yet ready for C++ compilation.  */
  26 extern "C"
  27 {
  28 #include <mach.h>
  29 }
  30 #undef thread_info
  31 /* Divert 'mach_thread_info' to the original Mach 'thread_info' function.  */
  32 extern __typeof__ (mach_thread_info) mach_thread_info asm ("thread_info");
  33
  34 #include <unistd.h>
  35
  36 #include "inf-child.h"
  37
  38 struct inf;
  39
  40 extern struct inf *gnu_current_inf;
  41
  42 /* Converts a GDB pid to a struct proc.  */
  43 struct proc *inf_tid_to_thread (struct inf *inf, int tid);
  44
  45 typedef void (inf_threads_ftype) (struct proc *thread, void *arg);
  46
  47 /* Call F for every thread in inferior INF, passing ARG as second parameter.  */
  48 void inf_threads (struct inf *inf, inf_threads_ftype *f, void *arg);
  49
  50 /* Makes sure that INF's thread list is synced with the actual process.  */
  51 int inf_update_procs (struct inf *inf);
  52
  53 /* A proc is either a thread, or the task (there can only be one task proc
  54    because it always has the same TID, PROC_TID_TASK).  */
  55 struct proc
  56   {
  57     thread_t port;              /* The task or thread port.  */
  58     int tid;                    /* The GDB pid (actually a thread id).  */
  59     int num;                    /* An id number for threads, to print.  */
  60
  61     mach_port_t saved_exc_port; /* The task/thread's real exception port.  */
  62     mach_port_t exc_port;       /* Our replacement, which for.  */
  63
  64     int sc;                     /* Desired suspend count.   */
  65     int cur_sc;                 /* Implemented suspend count.  */
  66     int run_sc;                 /* Default sc when the program is running.  */
  67     int pause_sc;               /* Default sc when gdb has control.  */
  68     int resume_sc;              /* Sc resulting from the last resume.  */
  69     int detach_sc;              /* SC to leave around when detaching
  70                                    from program.  */
  71
  72     thread_state_data_t state;  /* Registers, &c.  */
  73     int state_valid:1;          /* True if STATE is up to date.  */
  74     int state_changed:1;
  75
  76     int aborted:1;              /* True if thread_abort has been called.  */
  77     int dead:1;                 /* We happen to know it's actually dead.  */
  78
  79     /* Bit mask of registers fetched by gdb.  This is used when we re-fetch
  80        STATE after aborting the thread, to detect that gdb may have out-of-date
  81        information.  */
  82     unsigned long fetched_regs;
  83
  84     struct inf *inf;            /* Where we come from.  */
  85
  86     struct proc *next;
  87   };
  88
  89 /* The task has a thread entry with this TID.  */
  90 #define PROC_TID_TASK   (-1)
  91
  92 #define proc_is_task(proc) ((proc)->tid == PROC_TID_TASK)
  93 #define proc_is_thread(proc) ((proc)->tid != PROC_TID_TASK)
  94
  95 extern int __proc_pid (struct proc *proc);
  96
  97 /* Return printable description of proc.  */
  98 extern char *proc_string (struct proc *proc);
  99
 100 #define proc_debug(_proc, msg, args...) \
 101   do { struct proc *__proc = (_proc); \
 102        debug ("{proc %d/%d %s}: " msg, \
 103               __proc_pid (__proc), __proc->tid, \
 104               host_address_to_string (__proc) , ##args); } while (0)
 105
 106 extern bool gnu_debug_flag;
 107
 108 #define debug(msg, args...) \
 109  do { if (gnu_debug_flag) \
 110      gdb_printf (gdb_stdlog, "%s:%d: " msg "\r\n",              \
 111                  __FILE__ , __LINE__ , ##args); } while (0)
 112
 113 /* A prototype generic GNU/Hurd target.  The client can override it
 114    with local methods.  */
 115
 116 struct gnu_nat_target : public inf_child_target
 117 {
 118   void attach (const char *, int) override;
 119   bool attach_no_wait () override
 120   { return true; }
 121
 122   void detach (inferior *, int) override;
 123   void resume (ptid_t, int, enum gdb_signal) override;
 124
 125   ptid_t wait (ptid_t, struct target_waitstatus *, target_wait_flags) override;
 126   enum target_xfer_status xfer_partial (enum target_object object,
 127                                         const char *annex,
 128                                         gdb_byte *readbuf,
 129                                         const gdb_byte *writebuf,
 130                                         ULONGEST offset, ULONGEST len,
 131                                         ULONGEST *xfered_len) override;
 132
 133   int find_memory_regions (find_memory_region_ftype func, void *data)
 134     override;
 135   void kill () override;
 136
 137   void create_inferior (const char *, const std::string &,
 138                         char **, int) override;
 139   void mourn_inferior () override;
 140   bool thread_alive (ptid_t ptid) override;
 141   std::string pid_to_str (ptid_t) override;
 142   void stop (ptid_t) override;
 143
 144   void inf_validate_procs (struct inf *inf);
 145   void inf_suspend (struct inf *inf);
 146   void inf_set_traced (struct inf *inf, int on);
 147   void steal_exc_port (struct proc *proc, mach_port_t name);
 148
 149   /* Make sure that the state field in PROC is up to date, and return a
 150      pointer to it, or 0 if something is wrong.  If WILL_MODIFY is true,
 151      makes sure that the thread is stopped and aborted first, and sets
 152      the state_changed field in PROC to true.  */
 153   thread_state_t proc_get_state (struct proc *proc, int will_modify);
 154
 155 private:
 156   void inf_clear_wait (struct inf *inf);
 157   void inf_cleanup (struct inf *inf);
 158   void inf_startup (struct inf *inf, int pid);
 159   int inf_update_suspends (struct inf *inf);
 160   void inf_set_pid (struct inf *inf, pid_t pid);
 161   void inf_steal_exc_ports (struct inf *inf);
 162   void inf_validate_procinfo (struct inf *inf);
 163   void inf_validate_task_sc (struct inf *inf);
 164   void inf_restore_exc_ports (struct inf *inf);
 165   void inf_set_threads_resume_sc (struct inf *inf,
 166                                   struct proc *run_thread,
 167                                   int run_others);
 168   int inf_set_threads_resume_sc_for_signal_thread (struct inf *inf);
 169   void inf_resume (struct inf *inf);
 170   void inf_set_step_thread (struct inf *inf, struct proc *proc);
 171   void inf_detach (struct inf *inf);
 172   void inf_attach (struct inf *inf, int pid);
 173   void inf_signal (struct inf *inf, enum gdb_signal sig);
 174   void inf_continue (struct inf *inf);
 175
 176   struct proc *make_proc (struct inf *inf, mach_port_t port, int tid);
 177   void proc_abort (struct proc *proc, int force);
 178   struct proc *_proc_free (struct proc *proc);
 179   int proc_update_sc (struct proc *proc);
 180   kern_return_t proc_get_exception_port (struct proc *proc, mach_port_t * port);
 181   kern_return_t proc_set_exception_port (struct proc *proc, mach_port_t port);
 182   mach_port_t _proc_get_exc_port (struct proc *proc);
 183   void proc_steal_exc_port (struct proc *proc, mach_port_t exc_port);
 184   void proc_restore_exc_port (struct proc *proc);
 185   int proc_trace (struct proc *proc, int set);
 186 };
 187
 188 /* The final/concrete instance.  */
 189 extern gnu_nat_target *gnu_target;
 190
 191 #endif /* GNU_NAT_H */