2013-07-24 Sergio Durigan Junior <sergiodj@redhat.com>
[external/binutils.git] / gdb / linux-nat.h
1 /* Native debugging support for GNU/Linux (LWP layer).
2
3    Copyright (C) 2000-2013 Free Software Foundation, Inc.
4
5    This file is part of GDB.
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 #include "target.h"
21
22 #include <signal.h>
23
24 struct arch_lwp_info;
25
26 /* Structure describing an LWP.  This is public only for the purposes
27    of ALL_LWPS; target-specific code should generally not access it
28    directly.  */
29
30 struct lwp_info
31 {
32   /* The process id of the LWP.  This is a combination of the LWP id
33      and overall process id.  */
34   ptid_t ptid;
35
36   /* Non-zero if this LWP is cloned.  In this context "cloned" means
37      that the LWP is reporting to its parent using a signal other than
38      SIGCHLD.  */
39   int cloned;
40
41   /* Non-zero if we sent this LWP a SIGSTOP (but the LWP didn't report
42      it back yet).  */
43   int signalled;
44
45   /* Non-zero if this LWP is stopped.  */
46   int stopped;
47
48   /* Non-zero if this LWP will be/has been resumed.  Note that an LWP
49      can be marked both as stopped and resumed at the same time.  This
50      happens if we try to resume an LWP that has a wait status
51      pending.  We shouldn't let the LWP run until that wait status has
52      been processed, but we should not report that wait status if GDB
53      didn't try to let the LWP run.  */
54   int resumed;
55
56   /* The last resume GDB requested on this thread.  */
57   enum resume_kind last_resume_kind;
58
59   /* If non-zero, a pending wait status.  */
60   int status;
61
62   /* Non-zero if we were stepping this LWP.  */
63   int step;
64
65   /* STOPPED_BY_WATCHPOINT is non-zero if this LWP stopped with a data
66      watchpoint trap.  */
67   int stopped_by_watchpoint;
68
69   /* On architectures where it is possible to know the data address of
70      a triggered watchpoint, STOPPED_DATA_ADDRESS_P is non-zero, and
71      STOPPED_DATA_ADDRESS contains such data address.  Otherwise,
72      STOPPED_DATA_ADDRESS_P is false, and STOPPED_DATA_ADDRESS is
73      undefined.  Only valid if STOPPED_BY_WATCHPOINT is true.  */
74   int stopped_data_address_p;
75   CORE_ADDR stopped_data_address;
76
77   /* Non-zero if we expect a duplicated SIGINT.  */
78   int ignore_sigint;
79
80   /* If WAITSTATUS->KIND != TARGET_WAITKIND_SPURIOUS, the waitstatus
81      for this LWP's last event.  This may correspond to STATUS above,
82      or to a local variable in lin_lwp_wait.  */
83   struct target_waitstatus waitstatus;
84
85   /* Signal wether we are in a SYSCALL_ENTRY or
86      in a SYSCALL_RETURN event.
87      Values:
88      - TARGET_WAITKIND_SYSCALL_ENTRY
89      - TARGET_WAITKIND_SYSCALL_RETURN */
90   int syscall_state;
91
92   /* The processor core this LWP was last seen on.  */
93   int core;
94
95   /* Arch-specific additions.  */
96   struct arch_lwp_info *arch_private;
97
98   /* Next LWP in list.  */
99   struct lwp_info *next;
100 };
101
102 /* The global list of LWPs, for ALL_LWPS.  Unlike the threads list,
103    there is always at least one LWP on the list while the GNU/Linux
104    native target is active.  */
105 extern struct lwp_info *lwp_list;
106
107 /* Iterate over each active thread (light-weight process).  */
108 #define ALL_LWPS(LP)                                                    \
109   for ((LP) = lwp_list;                                                 \
110        (LP) != NULL;                                                    \
111        (LP) = (LP)->next)
112
113 #define GET_LWP(ptid)           ptid_get_lwp (ptid)
114 #define GET_PID(ptid)           ptid_get_pid (ptid)
115 #define is_lwp(ptid)            (GET_LWP (ptid) != 0)
116 #define BUILD_LWP(lwp, pid)     ptid_build (pid, lwp, 0)
117
118 /* Attempt to initialize libthread_db.  */
119 void check_for_thread_db (void);
120
121 int thread_db_attach_lwp (ptid_t ptid);
122
123 /* Return the set of signals used by the threads library.  */
124 extern void lin_thread_get_thread_signals (sigset_t *mask);
125
126 /* Find process PID's pending signal set from /proc/pid/status.  */
127 void linux_proc_pending_signals (int pid, sigset_t *pending,
128                                  sigset_t *blocked, sigset_t *ignored);
129
130 /* linux-nat functions for handling fork events.  */
131 extern void linux_enable_event_reporting (ptid_t ptid);
132
133 extern int lin_lwp_attach_lwp (ptid_t ptid);
134
135 extern void linux_stop_lwp (struct lwp_info *lwp);
136
137 /* Iterator function for lin-lwp's lwp list.  */
138 struct lwp_info *iterate_over_lwps (ptid_t filter,
139                                     int (*callback) (struct lwp_info *,
140                                                      void *), 
141                                     void *data);
142
143 /* Create a prototype generic GNU/Linux target.  The client can
144    override it with local methods.  */
145 struct target_ops * linux_target (void);
146
147 /* Create a generic GNU/Linux target using traditional 
148    ptrace register access.  */
149 struct target_ops *
150 linux_trad_target (CORE_ADDR (*register_u_offset)(struct gdbarch *, int, int));
151
152 /* Register the customized GNU/Linux target.  This should be used
153    instead of calling add_target directly.  */
154 void linux_nat_add_target (struct target_ops *);
155
156 /* Register a method to call whenever a new thread is attached.  */
157 void linux_nat_set_new_thread (struct target_ops *, void (*) (struct lwp_info *));
158
159
160 /* Register a method to call whenever a new fork is attached.  */
161 typedef void (linux_nat_new_fork_ftype) (struct lwp_info *parent,
162                                          pid_t child_pid);
163 void linux_nat_set_new_fork (struct target_ops *ops,
164                              linux_nat_new_fork_ftype *fn);
165
166 /* Register a method to call whenever a process is killed or
167    detached.  */
168 typedef void (linux_nat_forget_process_ftype) (pid_t pid);
169 void linux_nat_set_forget_process (struct target_ops *ops,
170                                    linux_nat_forget_process_ftype *fn);
171
172 /* Call the method registered with the function above.  PID is the
173    process to forget about.  */
174 void linux_nat_forget_process (pid_t pid);
175
176 /* Register a method that converts a siginfo object between the layout
177    that ptrace returns, and the layout in the architecture of the
178    inferior.  */
179 void linux_nat_set_siginfo_fixup (struct target_ops *,
180                                   int (*) (siginfo_t *,
181                                            gdb_byte *,
182                                            int));
183
184 /* Register a method to call prior to resuming a thread.  */
185
186 void linux_nat_set_prepare_to_resume (struct target_ops *,
187                                       void (*) (struct lwp_info *));
188
189 /* Update linux-nat internal state when changing from one fork
190    to another.  */
191 void linux_nat_switch_fork (ptid_t new_ptid);
192
193 /* Store the saved siginfo associated with PTID in *SIGINFO.
194    Return 1 if it was retrieved successfully, 0 otherwise (*SIGINFO is
195    uninitialized in such case).  */
196 int linux_nat_get_siginfo (ptid_t ptid, siginfo_t *siginfo);
197
198 /* Set alternative SIGTRAP-like events recognizer.  */
199 void linux_nat_set_status_is_event (struct target_ops *t,
200                                     int (*status_is_event) (int status));