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