* gnu-nat.c: Include "inf-child.h".
[external/binutils.git] / gdb / gnu-nat.h
1 /* Common things used by the various *gnu-nat.c files
2    Copyright (C) 1995, 1996, 1997, 1999, 2000, 2007, 2008, 2009
3    Free Software Foundation, Inc.
4
5    Written by Miles Bader <miles@gnu.ai.mit.edu>
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 __GNU_NAT_H__
21 #define __GNU_NAT_H__
22
23 #include <unistd.h>
24 #include <mach.h>
25
26 struct inf;
27
28 extern struct inf *gnu_current_inf;
29
30 /* Converts a GDB pid to a struct proc.  */
31 struct proc *inf_tid_to_thread (struct inf *inf, int tid);
32
33 /* Makes sure that INF's thread list is synced with the actual process.  */
34 int inf_update_procs (struct inf *inf);
35
36 /* A proc is either a thread, or the task (there can only be one task proc
37    because it always has the same TID, PROC_TID_TASK).  */
38 struct proc
39   {
40     thread_t port;              /* The task or thread port.  */
41     int tid;                    /* The GDB pid (actually a thread id).  */
42     int num;                    /* An id number for threads, to print.  */
43
44     mach_port_t saved_exc_port; /* The task/thread's real exception port.  */
45     mach_port_t exc_port;       /* Our replacement, which for.  */
46
47     int sc;                     /* Desired suspend count.   */
48     int cur_sc;                 /* Implemented suspend count.  */
49     int run_sc;                 /* Default sc when the program is running. */
50     int pause_sc;               /* Default sc when gdb has control. */
51     int resume_sc;              /* Sc resulting from the last resume. */
52     int detach_sc;              /* SC to leave around when detaching
53                                    from program. */
54
55     thread_state_data_t state;  /* Registers, &c. */
56     int state_valid:1;          /* True if STATE is up to date. */
57     int state_changed:1;
58
59     int aborted:1;              /* True if thread_abort has been called.  */
60     int dead:1;                 /* We happen to know it's actually dead. */
61
62     /* Bit mask of registers fetched by gdb.  This is used when we re-fetch
63        STATE after aborting the thread, to detect that gdb may have out-of-date
64        information.  */
65     unsigned long fetched_regs;
66
67     struct inf *inf;            /* Where we come from.  */
68
69     struct proc *next;
70   };
71
72 /* The task has a thread entry with this TID.  */
73 #define PROC_TID_TASK   (-1)
74
75 #define proc_is_task(proc) ((proc)->tid == PROC_TID_TASK)
76 #define proc_is_thread(proc) ((proc)->tid != PROC_TID_TASK)
77
78 extern int __proc_pid (struct proc *proc);
79
80 /* Make sure that the state field in PROC is up to date, and return a
81    pointer to it, or 0 if something is wrong.  If WILL_MODIFY is true,
82    makes sure that the thread is stopped and aborted first, and sets
83    the state_changed field in PROC to true.  */
84 extern thread_state_t proc_get_state (struct proc *proc, int will_modify);
85
86 /* Return printable description of proc.  */
87 extern char *proc_string (struct proc *proc);
88
89 #define proc_debug(_proc, msg, args...) \
90   do { struct proc *__proc = (_proc); \
91        debug ("{proc %d/%d %s}: " msg, \
92               __proc_pid (__proc), __proc->tid, \
93               host_address_to_string (__proc) , ##args); } while (0)
94
95 extern int gnu_debug_flag;
96
97 #define debug(msg, args...) \
98  do { if (gnu_debug_flag) \
99         fprintf_unfiltered (gdb_stdlog, "%s:%d: " msg "\r\n", __FILE__ , __LINE__ , ##args); } while (0)
100
101 /* Create a prototype generic GNU/Hurd target.  The client can
102    override it with local methods.  */
103 struct target_ops *gnu_target (void);
104
105 #endif /* __GNU_NAT_H__ */