gdb/gnu-nat.h

   1 /* Common things used by the various *gnu-nat.c files
   2    Copyright (C) 1995-2018 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 #include <unistd.h>
  23 #include <mach.h>
  24
  25 struct inf;
  26
  27 extern struct inf *gnu_current_inf;
  28
  29 /* Converts a GDB pid to a struct proc.  */
  30 struct proc *inf_tid_to_thread (struct inf *inf, int tid);
  31
  32 typedef void (inf_threads_ftype) (struct proc *thread, void *arg);
  33
  34 /* Call F for every thread in inferior INF, passing ARG as second parameter.  */
  35 void inf_threads (struct inf *inf, inf_threads_ftype *f, void *arg);
  36
  37 /* Makes sure that INF's thread list is synced with the actual process.  */
  38 int inf_update_procs (struct inf *inf);
  39
  40 /* A proc is either a thread, or the task (there can only be one task proc
  41    because it always has the same TID, PROC_TID_TASK).  */
  42 struct proc
  43   {
  44     thread_t port;              /* The task or thread port.  */
  45     int tid;                    /* The GDB pid (actually a thread id).  */
  46     int num;                    /* An id number for threads, to print.  */
  47
  48     mach_port_t saved_exc_port; /* The task/thread's real exception port.  */
  49     mach_port_t exc_port;       /* Our replacement, which for.  */
  50
  51     int sc;                     /* Desired suspend count.   */
  52     int cur_sc;                 /* Implemented suspend count.  */
  53     int run_sc;                 /* Default sc when the program is running.  */
  54     int pause_sc;               /* Default sc when gdb has control.  */
  55     int resume_sc;              /* Sc resulting from the last resume.  */
  56     int detach_sc;              /* SC to leave around when detaching
  57                                    from program.  */
  58
  59     thread_state_data_t state;  /* Registers, &c.  */
  60     int state_valid:1;          /* True if STATE is up to date.  */
  61     int state_changed:1;
  62
  63     int aborted:1;              /* True if thread_abort has been called.  */
  64     int dead:1;                 /* We happen to know it's actually dead.  */
  65
  66     /* Bit mask of registers fetched by gdb.  This is used when we re-fetch
  67        STATE after aborting the thread, to detect that gdb may have out-of-date
  68        information.  */
  69     unsigned long fetched_regs;
  70
  71     struct inf *inf;            /* Where we come from.  */
  72
  73     struct proc *next;
  74   };
  75
  76 /* The task has a thread entry with this TID.  */
  77 #define PROC_TID_TASK   (-1)
  78
  79 #define proc_is_task(proc) ((proc)->tid == PROC_TID_TASK)
  80 #define proc_is_thread(proc) ((proc)->tid != PROC_TID_TASK)
  81
  82 extern int __proc_pid (struct proc *proc);
  83
  84 /* Make sure that the state field in PROC is up to date, and return a
  85    pointer to it, or 0 if something is wrong.  If WILL_MODIFY is true,
  86    makes sure that the thread is stopped and aborted first, and sets
  87    the state_changed field in PROC to true.  */
  88 extern thread_state_t proc_get_state (struct proc *proc, int will_modify);
  89
  90 /* Return printable description of proc.  */
  91 extern char *proc_string (struct proc *proc);
  92
  93 #define proc_debug(_proc, msg, args...) \
  94   do { struct proc *__proc = (_proc); \
  95        debug ("{proc %d/%d %s}: " msg, \
  96               __proc_pid (__proc), __proc->tid, \
  97               host_address_to_string (__proc) , ##args); } while (0)
  98
  99 extern int gnu_debug_flag;
 100
 101 #define debug(msg, args...) \
 102  do { if (gnu_debug_flag) \
 103         fprintf_unfiltered (gdb_stdlog, "%s:%d: " msg "\r\n", \
 104                             __FILE__ , __LINE__ , ##args); } while (0)
 105
 106 /* A prototype generic GNU/Hurd target.  The client can override it
 107    with local methods.  */
 108
 109 struct gnu_nat_target : public inf_child_target
 110 {
 111   void attach (const char *, int) override;
 112   bool attach_no_wait () override
 113   { return true; }
 114
 115   void detach (inferior *, int) override;
 116   void resume (ptid_t, int, enum gdb_signal) override;
 117
 118   ptid_t wait (ptid_t, struct target_waitstatus *, int) override;
 119   enum target_xfer_status xfer_partial (enum target_object object,
 120                                         const char *annex,
 121                                         gdb_byte *readbuf,
 122                                         const gdb_byte *writebuf,
 123                                         ULONGEST offset, ULONGEST len,
 124                                         ULONGEST *xfered_len) override;
 125
 126   int find_memory_regions (find_memory_region_ftype func, void *data)
 127     override;
 128   void kill () override;
 129
 130   void create_inferior (const char *, const std::string &,
 131                         char **, int) override;
 132   void mourn_inferior () override;
 133   bool thread_alive (ptid_t ptid) override;
 134   const char *pid_to_str (ptid_t) override;
 135   void stop (ptid_t) override;
 136 };
 137
 138 #endif /* __GNU_NAT_H__ */