Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Multi-process/thread control defs for GDB, the GNU debugger. |
b811d2c2 | 2 | Copyright (C) 1987-2020 Free Software Foundation, Inc. |
b6ba6518 KB |
3 | Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA. |
4 | ||
c906108c | 5 | |
c5aa993b | 6 | This file is part of GDB. |
c906108c | 7 | |
c5aa993b JM |
8 | This program is free software; you can redistribute it and/or modify |
9 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 10 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 11 | (at your option) any later version. |
c906108c | 12 | |
c5aa993b JM |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
c906108c | 17 | |
c5aa993b | 18 | You should have received a copy of the GNU General Public License |
a9762ec7 | 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
20 | |
21 | #ifndef GDBTHREAD_H | |
22 | #define GDBTHREAD_H | |
23 | ||
da3331ec AC |
24 | struct symtab; |
25 | ||
c906108c | 26 | #include "breakpoint.h" |
aa0cd9c1 | 27 | #include "frame.h" |
8e8901c5 | 28 | #include "ui-out.h" |
02d27625 | 29 | #include "btrace.h" |
372316f1 | 30 | #include "target/waitstatus.h" |
5d5658a1 | 31 | #include "cli/cli-utils.h" |
268a13a5 TT |
32 | #include "gdbsupport/refcounted-object.h" |
33 | #include "gdbsupport/common-gdbthread.h" | |
34 | #include "gdbsupport/forward-scope-exit.h" | |
8e8901c5 | 35 | |
08036331 | 36 | struct inferior; |
5b6d1e4f | 37 | struct process_stratum_target; |
08036331 | 38 | |
30596231 | 39 | /* Frontend view of the thread state. Possible extensions: stepping, |
6af05e64 PA |
40 | finishing, until(ling),... |
41 | ||
42 | NOTE: Since the thread state is not a boolean, most times, you do | |
43 | not want to check it with negation. If you really want to check if | |
44 | the thread is stopped, | |
45 | ||
46 | use (good): | |
47 | ||
48 | if (tp->state == THREAD_STOPPED) | |
49 | ||
50 | instead of (bad): | |
51 | ||
52 | if (tp->state != THREAD_RUNNING) | |
53 | ||
54 | The latter is also true for exited threads, most likely not what | |
55 | you want. */ | |
30596231 PA |
56 | enum thread_state |
57 | { | |
6af05e64 | 58 | /* In the frontend's perpective, the thread is stopped. */ |
30596231 | 59 | THREAD_STOPPED, |
6af05e64 PA |
60 | |
61 | /* In the frontend's perpective, the thread is running. */ | |
30596231 | 62 | THREAD_RUNNING, |
6af05e64 PA |
63 | |
64 | /* The thread is listed, but known to have exited. We keep it | |
65 | listed (but not visible) until it's safe to delete it. */ | |
30596231 PA |
66 | THREAD_EXITED, |
67 | }; | |
68 | ||
08036331 PA |
69 | /* STEP_OVER_ALL means step over all subroutine calls. |
70 | STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions. | |
71 | STEP_OVER_NONE means don't step over any subroutine calls. */ | |
72 | ||
73 | enum step_over_calls_kind | |
74 | { | |
75 | STEP_OVER_NONE, | |
76 | STEP_OVER_ALL, | |
77 | STEP_OVER_UNDEBUGGABLE | |
78 | }; | |
79 | ||
16c381f0 | 80 | /* Inferior thread specific part of `struct infcall_control_state'. |
8ea051c5 | 81 | |
16c381f0 | 82 | Inferior process counterpart is `struct inferior_control_state'. */ |
8ea051c5 | 83 | |
16c381f0 JK |
84 | struct thread_control_state |
85 | { | |
4e1c45ea PA |
86 | /* User/external stepping state. */ |
87 | ||
8358c15c | 88 | /* Step-resume or longjmp-resume breakpoint. */ |
ee841dd8 | 89 | struct breakpoint *step_resume_breakpoint = nullptr; |
8358c15c | 90 | |
186c406b | 91 | /* Exception-resume breakpoint. */ |
ee841dd8 | 92 | struct breakpoint *exception_resume_breakpoint = nullptr; |
186c406b | 93 | |
34b7e8a6 PA |
94 | /* Breakpoints used for software single stepping. Plural, because |
95 | it may have multiple locations. E.g., if stepping over a | |
96 | conditional branch instruction we can't decode the condition for, | |
97 | we'll need to put a breakpoint at the branch destination, and | |
98 | another at the instruction after the branch. */ | |
ee841dd8 | 99 | struct breakpoint *single_step_breakpoints = nullptr; |
34b7e8a6 | 100 | |
4e1c45ea PA |
101 | /* Range to single step within. |
102 | ||
103 | If this is nonzero, respond to a single-step signal by continuing | |
104 | to step if the pc is in this range. | |
105 | ||
106 | If step_range_start and step_range_end are both 1, it means to | |
107 | step for a single instruction (FIXME: it might clean up | |
108 | wait_for_inferior in a minor way if this were changed to the | |
109 | address of the instruction and that address plus one. But maybe | |
0963b4bd | 110 | not). */ |
ee841dd8 TT |
111 | CORE_ADDR step_range_start = 0; /* Inclusive */ |
112 | CORE_ADDR step_range_end = 0; /* Exclusive */ | |
4e1c45ea | 113 | |
885eeb5b | 114 | /* Function the thread was in as of last it started stepping. */ |
ee841dd8 | 115 | struct symbol *step_start_function = nullptr; |
885eeb5b | 116 | |
c1e36e3e PA |
117 | /* If GDB issues a target step request, and this is nonzero, the |
118 | target should single-step this thread once, and then continue | |
119 | single-stepping it without GDB core involvement as long as the | |
120 | thread stops in the step range above. If this is zero, the | |
121 | target should ignore the step range, and only issue one single | |
122 | step. */ | |
ee841dd8 | 123 | int may_range_step = 0; |
c1e36e3e | 124 | |
4e1c45ea PA |
125 | /* Stack frame address as of when stepping command was issued. |
126 | This is how we know when we step into a subroutine call, and how | |
127 | to set the frame for the breakpoint used to step out. */ | |
ee841dd8 | 128 | struct frame_id step_frame_id {}; |
edb3359d DJ |
129 | |
130 | /* Similarly, the frame ID of the underlying stack frame (skipping | |
131 | any inlined frames). */ | |
ee841dd8 | 132 | struct frame_id step_stack_frame_id {}; |
edb3359d | 133 | |
4e1c45ea PA |
134 | /* Nonzero if we are presently stepping over a breakpoint. |
135 | ||
136 | If we hit a breakpoint or watchpoint, and then continue, we need | |
137 | to single step the current thread with breakpoints disabled, to | |
138 | avoid hitting the same breakpoint or watchpoint again. And we | |
139 | should step just a single thread and keep other threads stopped, | |
140 | so that other threads don't miss breakpoints while they are | |
141 | removed. | |
142 | ||
143 | So, this variable simultaneously means that we need to single | |
144 | step the current thread, keep other threads stopped, and that | |
145 | breakpoints should be removed while we step. | |
146 | ||
147 | This variable is set either: | |
148 | - in proceed, when we resume inferior on user's explicit request | |
149 | - in keep_going, if handle_inferior_event decides we need to | |
150 | step over breakpoint. | |
151 | ||
152 | The variable is cleared in normal_stop. The proceed calls | |
153 | wait_for_inferior, which calls handle_inferior_event in a loop, | |
154 | and until wait_for_inferior exits, this variable is changed only | |
155 | by keep_going. */ | |
ee841dd8 | 156 | int trap_expected = 0; |
4e1c45ea | 157 | |
16c381f0 | 158 | /* Nonzero if the thread is being proceeded for a "finish" command |
46c03469 | 159 | or a similar situation when return value should be printed. */ |
ee841dd8 | 160 | int proceed_to_finish = 0; |
16c381f0 JK |
161 | |
162 | /* Nonzero if the thread is being proceeded for an inferior function | |
163 | call. */ | |
ee841dd8 | 164 | int in_infcall = 0; |
16c381f0 | 165 | |
ee841dd8 | 166 | enum step_over_calls_kind step_over_calls = STEP_OVER_NONE; |
16c381f0 JK |
167 | |
168 | /* Nonzero if stopped due to a step command. */ | |
ee841dd8 | 169 | int stop_step = 0; |
16c381f0 JK |
170 | |
171 | /* Chain containing status of breakpoint(s) the thread stopped | |
172 | at. */ | |
ee841dd8 | 173 | bpstat stop_bpstat = nullptr; |
17b2616c | 174 | |
856e7dd6 PA |
175 | /* Whether the command that started the thread was a stepping |
176 | command. This is used to decide whether "set scheduler-locking | |
177 | step" behaves like "on" or "off". */ | |
ee841dd8 | 178 | int stepping_command = 0; |
16c381f0 JK |
179 | }; |
180 | ||
a38fe4fe | 181 | /* Inferior thread specific part of `struct infcall_suspend_state'. */ |
16c381f0 JK |
182 | |
183 | struct thread_suspend_state | |
184 | { | |
70509625 PA |
185 | /* Last signal that the inferior received (why it stopped). When |
186 | the thread is resumed, this signal is delivered. Note: the | |
187 | target should not check whether the signal is in pass state, | |
188 | because the signal may have been explicitly passed with the | |
189 | "signal" command, which overrides "handle nopass". If the signal | |
190 | should be suppressed, the core will take care of clearing this | |
191 | before the target is resumed. */ | |
dd848631 | 192 | enum gdb_signal stop_signal = GDB_SIGNAL_0; |
372316f1 PA |
193 | |
194 | /* The reason the thread last stopped, if we need to track it | |
195 | (breakpoint, watchpoint, etc.) */ | |
dd848631 | 196 | enum target_stop_reason stop_reason = TARGET_STOPPED_BY_NO_REASON; |
372316f1 PA |
197 | |
198 | /* The waitstatus for this thread's last event. */ | |
dd848631 | 199 | struct target_waitstatus waitstatus {}; |
372316f1 | 200 | /* If true WAITSTATUS hasn't been handled yet. */ |
dd848631 | 201 | int waitstatus_pending_p = 0; |
372316f1 PA |
202 | |
203 | /* Record the pc of the thread the last time it stopped. (This is | |
204 | not the current thread's PC as that may have changed since the | |
f2ffa92b PA |
205 | last stop, e.g., "return" command, or "p $pc = 0xf000"). |
206 | ||
207 | - If the thread's PC has not changed since the thread last | |
208 | stopped, then proceed skips a breakpoint at the current PC, | |
209 | otherwise we let the thread run into the breakpoint. | |
210 | ||
211 | - If the thread has an unprocessed event pending, as indicated by | |
212 | waitstatus_pending_p, this is used in coordination with | |
213 | stop_reason: if the thread's PC has changed since the thread | |
214 | last stopped, a pending breakpoint waitstatus is discarded. | |
215 | ||
216 | - If the thread is running, this is set to -1, to avoid leaving | |
217 | it with a stale value, to make it easier to catch bugs. */ | |
dd848631 | 218 | CORE_ADDR stop_pc = 0; |
16c381f0 JK |
219 | }; |
220 | ||
7aabaf9d SM |
221 | /* Base class for target-specific thread data. */ |
222 | struct private_thread_info | |
223 | { | |
224 | virtual ~private_thread_info () = 0; | |
225 | }; | |
226 | ||
3a3fd0fd PA |
227 | /* Threads are intrusively refcounted objects. Being the |
228 | user-selected thread is normally considered an implicit strong | |
229 | reference and is thus not accounted in the refcount, unlike | |
230 | inferior objects. This is necessary, because there's no "current | |
231 | thread" pointer. Instead the current thread is inferred from the | |
232 | inferior_ptid global. However, when GDB needs to remember the | |
233 | selected thread to later restore it, GDB bumps the thread object's | |
234 | refcount, to prevent something deleting the thread object before | |
a6c21d4a | 235 | reverting back (e.g., due to a "kill" command). If the thread |
3a3fd0fd PA |
236 | meanwhile exits before being re-selected, then the thread object is |
237 | left listed in the thread list, but marked with state | |
09e3c4ca | 238 | THREAD_EXITED. (See scoped_restore_current_thread and |
3a3fd0fd PA |
239 | delete_thread). All other thread references are considered weak |
240 | references. Placing a thread in the thread list is an implicit | |
241 | strong reference, and is thus not accounted for in the thread's | |
242 | refcount. */ | |
243 | ||
244 | class thread_info : public refcounted_object | |
16c381f0 | 245 | { |
12316564 YQ |
246 | public: |
247 | explicit thread_info (inferior *inf, ptid_t ptid); | |
248 | ~thread_info (); | |
249 | ||
08036331 | 250 | bool deletable () const; |
803bdfe4 | 251 | |
00431a78 PA |
252 | /* Mark this thread as running and notify observers. */ |
253 | void set_running (bool running); | |
254 | ||
12316564 | 255 | struct thread_info *next = NULL; |
16c381f0 JK |
256 | ptid_t ptid; /* "Actual process id"; |
257 | In fact, this may be overloaded with | |
258 | kernel thread id, etc. */ | |
5d5658a1 PA |
259 | |
260 | /* Each thread has two GDB IDs. | |
261 | ||
262 | a) The thread ID (Id). This consists of the pair of: | |
263 | ||
264 | - the number of the thread's inferior and, | |
265 | ||
266 | - the thread's thread number in its inferior, aka, the | |
267 | per-inferior thread number. This number is unique in the | |
268 | inferior but not unique between inferiors. | |
269 | ||
270 | b) The global ID (GId). This is a a single integer unique | |
271 | between all inferiors. | |
272 | ||
273 | E.g.: | |
274 | ||
275 | (gdb) info threads -gid | |
276 | Id GId Target Id Frame | |
277 | * 1.1 1 Thread A 0x16a09237 in foo () at foo.c:10 | |
278 | 1.2 3 Thread B 0x15ebc6ed in bar () at foo.c:20 | |
279 | 1.3 5 Thread C 0x15ebc6ed in bar () at foo.c:20 | |
280 | 2.1 2 Thread A 0x16a09237 in foo () at foo.c:10 | |
281 | 2.2 4 Thread B 0x15ebc6ed in bar () at foo.c:20 | |
282 | 2.3 6 Thread C 0x15ebc6ed in bar () at foo.c:20 | |
283 | ||
284 | Above, both inferiors 1 and 2 have threads numbered 1-3, but each | |
285 | thread has its own unique global ID. */ | |
286 | ||
c84f6bbf | 287 | /* The thread's global GDB thread number. This is exposed to MI, |
663f6d42 PA |
288 | Python/Scheme, visible with "info threads -gid", and is also what |
289 | the $_gthread convenience variable is bound to. */ | |
5d5658a1 PA |
290 | int global_num; |
291 | ||
292 | /* The per-inferior thread number. This is unique in the inferior | |
293 | the thread belongs to, but not unique between inferiors. This is | |
294 | what the $_thread convenience variable is bound to. */ | |
295 | int per_inf_num; | |
296 | ||
297 | /* The inferior this thread belongs to. */ | |
298 | struct inferior *inf; | |
16c381f0 | 299 | |
4694da01 TT |
300 | /* The name of the thread, as specified by the user. This is NULL |
301 | if the thread does not have a user-given name. */ | |
12316564 | 302 | char *name = NULL; |
4694da01 | 303 | |
719546c4 | 304 | /* True means the thread is executing. Note: this is different |
16c381f0 JK |
305 | from saying that there is an active target and we are stopped at |
306 | a breakpoint, for instance. This is a real indicator whether the | |
307 | thread is off and running. */ | |
5b6d1e4f | 308 | bool executing = false; |
16c381f0 | 309 | |
719546c4 | 310 | /* True if this thread is resumed from infrun's perspective. |
372316f1 PA |
311 | Note that a thread can be marked both as not-executing and |
312 | resumed at the same time. This happens if we try to resume a | |
313 | thread that has a wait status pending. We shouldn't let the | |
314 | thread really run until that wait status has been processed, but | |
315 | we should not process that wait status if we didn't try to let | |
316 | the thread run. */ | |
719546c4 | 317 | bool resumed = false; |
372316f1 | 318 | |
f6e29b6e YQ |
319 | /* Frontend view of the thread state. Note that the THREAD_RUNNING/ |
320 | THREAD_STOPPED states are different from EXECUTING. When the | |
321 | thread is stopped internally while handling an internal event, | |
322 | like a software single-step breakpoint, EXECUTING will be false, | |
323 | but STATE will still be THREAD_RUNNING. */ | |
12316564 | 324 | enum thread_state state = THREAD_STOPPED; |
16c381f0 | 325 | |
16c381f0 JK |
326 | /* State of GDB control of inferior thread execution. |
327 | See `struct thread_control_state'. */ | |
ee841dd8 | 328 | thread_control_state control; |
16c381f0 JK |
329 | |
330 | /* State of inferior thread to restore after GDB is done with an inferior | |
331 | call. See `struct thread_suspend_state'. */ | |
dd848631 | 332 | thread_suspend_state suspend; |
16c381f0 | 333 | |
12316564 YQ |
334 | int current_line = 0; |
335 | struct symtab *current_symtab = NULL; | |
16c381f0 JK |
336 | |
337 | /* Internal stepping state. */ | |
338 | ||
4d9d9d04 PA |
339 | /* Record the pc of the thread the last time it was resumed. (It |
340 | can't be done on stop as the PC may change since the last stop, | |
341 | e.g., "return" command, or "p $pc = 0xf000"). This is maintained | |
342 | by proceed and keep_going, and among other things, it's used in | |
16c381f0 JK |
343 | adjust_pc_after_break to distinguish a hardware single-step |
344 | SIGTRAP from a breakpoint SIGTRAP. */ | |
12316564 | 345 | CORE_ADDR prev_pc = 0; |
16c381f0 | 346 | |
7f5ef605 PA |
347 | /* Did we set the thread stepping a breakpoint instruction? This is |
348 | used in conjunction with PREV_PC to decide whether to adjust the | |
349 | PC. */ | |
12316564 | 350 | int stepped_breakpoint = 0; |
7f5ef605 | 351 | |
4e1c45ea | 352 | /* Should we step over breakpoint next time keep_going is called? */ |
12316564 | 353 | int stepping_over_breakpoint = 0; |
0d06e24b | 354 | |
963f9c80 PA |
355 | /* Should we step over a watchpoint next time keep_going is called? |
356 | This is needed on targets with non-continuable, non-steppable | |
357 | watchpoints. */ | |
12316564 | 358 | int stepping_over_watchpoint = 0; |
963f9c80 | 359 | |
4e1c45ea | 360 | /* Set to TRUE if we should finish single-stepping over a breakpoint |
6aa27652 YQ |
361 | after hitting the current step-resume breakpoint. The context here |
362 | is that GDB is to do `next' or `step' while signal arrives. | |
363 | When stepping over a breakpoint and signal arrives, GDB will attempt | |
364 | to skip signal handler, so it inserts a step_resume_breakpoint at the | |
365 | signal return address, and resume inferior. | |
366 | step_after_step_resume_breakpoint is set to TRUE at this moment in | |
367 | order to keep GDB in mind that there is still a breakpoint to step over | |
368 | when GDB gets back SIGTRAP from step_resume_breakpoint. */ | |
12316564 | 369 | int step_after_step_resume_breakpoint = 0; |
4e1c45ea | 370 | |
243a9253 PA |
371 | /* Pointer to the state machine manager object that handles what is |
372 | left to do for the thread's execution command after the target | |
373 | stops. Several execution commands use it. */ | |
12316564 | 374 | struct thread_fsm *thread_fsm = NULL; |
a474d7c2 | 375 | |
e58b0e63 PA |
376 | /* This is used to remember when a fork or vfork event was caught by |
377 | a catchpoint, and thus the event is to be followed at the next | |
378 | resume of the thread, and not immediately. */ | |
379 | struct target_waitstatus pending_follow; | |
380 | ||
252fbfc8 | 381 | /* True if this thread has been explicitly requested to stop. */ |
12316564 | 382 | int stop_requested = 0; |
252fbfc8 | 383 | |
186c406b | 384 | /* The initiating frame of a nexting operation, used for deciding |
e2e4d78b JK |
385 | which exceptions to intercept. If it is null_frame_id no |
386 | bp_longjmp or bp_exception but longjmp has been caught just for | |
387 | bp_longjmp_call_dummy. */ | |
12316564 | 388 | struct frame_id initiating_frame = null_frame_id; |
186c406b | 389 | |
0d06e24b | 390 | /* Private data used by the target vector implementation. */ |
7aabaf9d | 391 | std::unique_ptr<private_thread_info> priv; |
02d27625 MM |
392 | |
393 | /* Branch trace information for this thread. */ | |
12316564 | 394 | struct btrace_thread_info btrace {}; |
6c659fc2 SC |
395 | |
396 | /* Flag which indicates that the stack temporaries should be stored while | |
397 | evaluating expressions. */ | |
fdf07f3a | 398 | bool stack_temporaries_enabled = false; |
6c659fc2 SC |
399 | |
400 | /* Values that are stored as temporaries on stack while evaluating | |
401 | expressions. */ | |
fdf07f3a | 402 | std::vector<struct value *> stack_temporaries; |
c2829269 PA |
403 | |
404 | /* Step-over chain. A thread is in the step-over queue if these are | |
405 | non-NULL. If only a single thread is in the chain, then these | |
406 | fields point to self. */ | |
12316564 YQ |
407 | struct thread_info *step_over_prev = NULL; |
408 | struct thread_info *step_over_next = NULL; | |
0d06e24b JM |
409 | }; |
410 | ||
00431a78 PA |
411 | /* A gdb::ref_ptr pointer to a thread_info. */ |
412 | ||
413 | using thread_info_ref | |
75cbc781 | 414 | = gdb::ref_ptr<struct thread_info, refcounted_object_ref_policy>; |
00431a78 | 415 | |
0d06e24b JM |
416 | /* Create an empty thread list, or empty the existing one. */ |
417 | extern void init_thread_list (void); | |
418 | ||
93815fbf VP |
419 | /* Add a thread to the thread list, print a message |
420 | that a new thread is found, and return the pointer to | |
421 | the new thread. Caller my use this pointer to | |
422 | initialize the private thread data. */ | |
5b6d1e4f PA |
423 | extern struct thread_info *add_thread (process_stratum_target *targ, |
424 | ptid_t ptid); | |
0d06e24b | 425 | |
5b6d1e4f PA |
426 | /* Same as add_thread, but does not print a message about new |
427 | thread. */ | |
428 | extern struct thread_info *add_thread_silent (process_stratum_target *targ, | |
429 | ptid_t ptid); | |
93815fbf | 430 | |
17faa917 | 431 | /* Same as add_thread, and sets the private info. */ |
5b6d1e4f PA |
432 | extern struct thread_info *add_thread_with_info (process_stratum_target *targ, |
433 | ptid_t ptid, | |
434 | private_thread_info *); | |
17faa917 | 435 | |
0d06e24b | 436 | /* Delete an existing thread list entry. */ |
75cbc781 | 437 | extern void delete_thread (struct thread_info *thread); |
0d06e24b | 438 | |
5e0b29c1 PA |
439 | /* Delete an existing thread list entry, and be quiet about it. Used |
440 | after the process this thread having belonged to having already | |
441 | exited, for example. */ | |
75cbc781 | 442 | extern void delete_thread_silent (struct thread_info *thread); |
5e0b29c1 | 443 | |
0963b4bd | 444 | /* Delete a step_resume_breakpoint from the thread database. */ |
4e1c45ea | 445 | extern void delete_step_resume_breakpoint (struct thread_info *); |
8601f500 | 446 | |
0963b4bd | 447 | /* Delete an exception_resume_breakpoint from the thread database. */ |
186c406b TT |
448 | extern void delete_exception_resume_breakpoint (struct thread_info *); |
449 | ||
34b7e8a6 PA |
450 | /* Delete the single-step breakpoints of thread TP, if any. */ |
451 | extern void delete_single_step_breakpoints (struct thread_info *tp); | |
452 | ||
453 | /* Check if the thread has software single stepping breakpoints | |
454 | set. */ | |
455 | extern int thread_has_single_step_breakpoints_set (struct thread_info *tp); | |
456 | ||
457 | /* Check whether the thread has software single stepping breakpoints | |
458 | set at PC. */ | |
459 | extern int thread_has_single_step_breakpoint_here (struct thread_info *tp, | |
accd0bcd | 460 | const address_space *aspace, |
34b7e8a6 PA |
461 | CORE_ADDR addr); |
462 | ||
5d5658a1 PA |
463 | /* Returns whether to show inferior-qualified thread IDs, or plain |
464 | thread numbers. Inferior-qualified IDs are shown whenever we have | |
465 | multiple inferiors, or the only inferior left has number > 1. */ | |
466 | extern int show_inferior_qualified_tids (void); | |
0d06e24b | 467 | |
5d5658a1 PA |
468 | /* Return a string version of THR's thread ID. If there are multiple |
469 | inferiors, then this prints the inferior-qualifier form, otherwise | |
470 | it only prints the thread number. The result is stored in a | |
471 | circular static buffer, NUMCELLS deep. */ | |
43792cf0 PA |
472 | const char *print_thread_id (struct thread_info *thr); |
473 | ||
00431a78 | 474 | /* Boolean test for an already-known ptid. */ |
5b6d1e4f | 475 | extern bool in_thread_list (process_stratum_target *targ, ptid_t ptid); |
0d06e24b | 476 | |
5d5658a1 PA |
477 | /* Boolean test for an already-known global thread id (GDB's homegrown |
478 | global id, not the system's). */ | |
479 | extern int valid_global_thread_id (int global_id); | |
0d06e24b | 480 | |
5b6d1e4f PA |
481 | /* Find thread PTID of inferior INF. */ |
482 | extern thread_info *find_thread_ptid (inferior *inf, ptid_t ptid); | |
483 | ||
0d06e24b | 484 | /* Search function to lookup a thread by 'pid'. */ |
5b6d1e4f PA |
485 | extern struct thread_info *find_thread_ptid (process_stratum_target *targ, |
486 | ptid_t ptid); | |
0d06e24b | 487 | |
08036331 PA |
488 | /* Search function to lookup a thread by 'ptid'. Only searches in |
489 | threads of INF. */ | |
490 | extern struct thread_info *find_thread_ptid (inferior *inf, ptid_t ptid); | |
491 | ||
5d5658a1 PA |
492 | /* Find thread by GDB global thread ID. */ |
493 | struct thread_info *find_thread_global_id (int global_id); | |
1e92afda | 494 | |
e04ee09e | 495 | /* Find thread by thread library specific handle in inferior INF. */ |
50a82723 KB |
496 | struct thread_info *find_thread_by_handle |
497 | (gdb::array_view<const gdb_byte> handle, struct inferior *inf); | |
e04ee09e | 498 | |
00431a78 | 499 | /* Finds the first thread of the specified inferior. */ |
75cbc781 | 500 | extern struct thread_info *first_thread_of_inferior (inferior *inf); |
bad34192 | 501 | |
00431a78 PA |
502 | /* Returns any thread of inferior INF, giving preference to the |
503 | current thread. */ | |
75cbc781 | 504 | extern struct thread_info *any_thread_of_inferior (inferior *inf); |
2277426b | 505 | |
00431a78 | 506 | /* Returns any non-exited thread of inferior INF, giving preference to |
32990ada | 507 | the current thread, and to not executing threads. */ |
75cbc781 | 508 | extern struct thread_info *any_live_thread_of_inferior (inferior *inf); |
6c95b8df | 509 | |
5231c1fd | 510 | /* Change the ptid of thread OLD_PTID to NEW_PTID. */ |
5b6d1e4f PA |
511 | void thread_change_ptid (process_stratum_target *targ, |
512 | ptid_t old_ptid, ptid_t new_ptid); | |
5231c1fd | 513 | |
0d06e24b JM |
514 | /* Iterator function to call a user-provided callback function |
515 | once for each known thread. */ | |
516 | typedef int (*thread_callback_func) (struct thread_info *, void *); | |
517 | extern struct thread_info *iterate_over_threads (thread_callback_func, void *); | |
518 | ||
08036331 PA |
519 | /* Pull in the internals of the inferiors/threads ranges and |
520 | iterators. Must be done after struct thread_info is defined. */ | |
521 | #include "thread-iter.h" | |
522 | ||
5b6d1e4f PA |
523 | /* Return a range that can be used to walk over threads, with |
524 | range-for. | |
525 | ||
526 | Used like this, it walks over all threads of all inferiors of all | |
527 | targets: | |
08036331 PA |
528 | |
529 | for (thread_info *thr : all_threads ()) | |
530 | { .... } | |
08036331 | 531 | |
5b6d1e4f PA |
532 | FILTER_PTID can be used to filter out threads that don't match. |
533 | FILTER_PTID can be: | |
534 | ||
535 | - minus_one_ptid, meaning walk all threads of all inferiors of | |
536 | PROC_TARGET. If PROC_TARGET is NULL, then of all targets. | |
537 | ||
538 | - A process ptid, in which case walk all threads of the specified | |
539 | process. PROC_TARGET must be non-NULL in this case. | |
540 | ||
541 | - A thread ptid, in which case walk that thread only. PROC_TARGET | |
542 | must be non-NULL in this case. | |
543 | */ | |
5d5658a1 | 544 | |
08036331 | 545 | inline all_matching_threads_range |
5b6d1e4f PA |
546 | all_threads (process_stratum_target *proc_target = nullptr, |
547 | ptid_t filter_ptid = minus_one_ptid) | |
08036331 | 548 | { |
5b6d1e4f | 549 | return all_matching_threads_range (proc_target, filter_ptid); |
08036331 | 550 | } |
5d5658a1 | 551 | |
08036331 | 552 | /* Return a range that can be used to walk over all non-exited threads |
5b6d1e4f PA |
553 | of all inferiors, with range-for. Arguments are like all_threads |
554 | above. */ | |
08036331 PA |
555 | |
556 | inline all_non_exited_threads_range | |
5b6d1e4f PA |
557 | all_non_exited_threads (process_stratum_target *proc_target = nullptr, |
558 | ptid_t filter_ptid = minus_one_ptid) | |
08036331 | 559 | { |
5b6d1e4f | 560 | return all_non_exited_threads_range (proc_target, filter_ptid); |
08036331 | 561 | } |
e5ef252a | 562 | |
08036331 PA |
563 | /* Return a range that can be used to walk over all threads of all |
564 | inferiors, with range-for, safely. I.e., it is safe to delete the | |
565 | currently-iterated thread. When combined with range-for, this | |
566 | allow convenient patterns like this: | |
e5ef252a | 567 | |
08036331 PA |
568 | for (thread_info *t : all_threads_safe ()) |
569 | if (some_condition ()) | |
570 | delete f; | |
571 | */ | |
572 | ||
573 | inline all_threads_safe_range | |
574 | all_threads_safe () | |
575 | { | |
5b6d1e4f | 576 | return {}; |
08036331 | 577 | } |
ab970af1 | 578 | |
5b6d1e4f | 579 | extern int thread_count (process_stratum_target *proc_target); |
20874c92 | 580 | |
08036331 PA |
581 | /* Return true if we have any thread in any inferior. */ |
582 | extern bool any_thread_p (); | |
583 | ||
00431a78 | 584 | /* Switch context to thread THR. Also sets the STOP_PC global. */ |
75cbc781 | 585 | extern void switch_to_thread (struct thread_info *thr); |
00431a78 PA |
586 | |
587 | /* Switch context to no thread selected. */ | |
588 | extern void switch_to_no_thread (); | |
589 | ||
f2ffa92b | 590 | /* Switch from one thread to another. Does not read registers. */ |
6efcd9a8 PA |
591 | extern void switch_to_thread_no_regs (struct thread_info *thread); |
592 | ||
5b6d1e4f PA |
593 | /* Marks or clears thread(s) PTID of TARG as resumed. If PTID is |
594 | MINUS_ONE_PTID, applies to all threads of TARG. If | |
252fbfc8 | 595 | ptid_is_pid(PTID) is true, applies to all threads of the process |
5b6d1e4f PA |
596 | pointed at by {TARG,PTID}. */ |
597 | extern void set_resumed (process_stratum_target *targ, | |
598 | ptid_t ptid, bool resumed); | |
599 | ||
600 | /* Marks thread PTID of TARG as running, or as stopped. If PTID is | |
601 | minus_one_ptid, marks all threads of TARG. */ | |
602 | extern void set_running (process_stratum_target *targ, | |
603 | ptid_t ptid, bool running); | |
604 | ||
605 | /* Marks or clears thread(s) PTID of TARG as having been requested to | |
606 | stop. If PTID is MINUS_ONE_PTID, applies to all threads of TARG. | |
607 | If ptid_is_pid(PTID) is true, applies to all threads of the process | |
608 | pointed at by {TARG, PTID}. If STOP, then the | |
609 | THREAD_STOP_REQUESTED observer is called with PTID as argument. */ | |
610 | extern void set_stop_requested (process_stratum_target *targ, | |
611 | ptid_t ptid, bool stop); | |
612 | ||
613 | /* Marks thread PTID of TARG as executing, or not. If PTID is | |
614 | minus_one_ptid, marks all threads of TARG. | |
0d6431e2 PA |
615 | |
616 | Note that this is different from the running state. See the | |
30596231 | 617 | description of state and executing fields of struct |
0d6431e2 | 618 | thread_info. */ |
5b6d1e4f PA |
619 | extern void set_executing (process_stratum_target *targ, |
620 | ptid_t ptid, bool executing); | |
8ea051c5 | 621 | |
5b6d1e4f PA |
622 | /* True if any (known or unknown) thread of TARG is or may be |
623 | executing. */ | |
624 | extern bool threads_are_executing (process_stratum_target *targ); | |
b57bacec | 625 | |
5b6d1e4f PA |
626 | /* Merge the executing property of thread PTID of TARG over to its |
627 | thread state property (frontend running/stopped view). | |
29f49a6a PA |
628 | |
629 | "not executing" -> "stopped" | |
630 | "executing" -> "running" | |
631 | "exited" -> "exited" | |
632 | ||
5b6d1e4f | 633 | If PTID is minus_one_ptid, go over all threads of TARG. |
29f49a6a PA |
634 | |
635 | Notifications are only emitted if the thread state did change. */ | |
5b6d1e4f | 636 | extern void finish_thread_state (process_stratum_target *targ, ptid_t ptid); |
29f49a6a | 637 | |
731f534f PA |
638 | /* Calls finish_thread_state on scope exit, unless release() is called |
639 | to disengage. */ | |
77f0e74c PA |
640 | using scoped_finish_thread_state |
641 | = FORWARD_SCOPE_EXIT (finish_thread_state); | |
29f49a6a | 642 | |
c906108c SS |
643 | /* Commands with a prefix of `thread'. */ |
644 | extern struct cmd_list_element *thread_cmd_list; | |
645 | ||
981a3fb3 | 646 | extern void thread_command (const char *tidstr, int from_tty); |
f0e8c4c5 | 647 | |
93815fbf VP |
648 | /* Print notices on thread events (attach, detach, etc.), set with |
649 | `set print thread-events'. */ | |
491144b5 | 650 | extern bool print_thread_events; |
93815fbf | 651 | |
5d5658a1 PA |
652 | /* Prints the list of threads and their details on UIOUT. If |
653 | REQUESTED_THREADS, a list of GDB ids/ranges, is not NULL, only | |
654 | print threads whose ID is included in the list. If PID is not -1, | |
655 | only print threads from the process PID. Otherwise, threads from | |
656 | all attached PIDs are printed. If both REQUESTED_THREADS is not | |
657 | NULL and PID is not -1, then the thread is printed if it belongs to | |
658 | the specified process. Otherwise, an error is raised. */ | |
24c54127 TT |
659 | extern void print_thread_info (struct ui_out *uiout, |
660 | const char *requested_threads, | |
3ee1c036 | 661 | int pid); |
8e8901c5 | 662 | |
5ed8105e PA |
663 | /* Save/restore current inferior/thread/frame. */ |
664 | ||
665 | class scoped_restore_current_thread | |
666 | { | |
667 | public: | |
668 | scoped_restore_current_thread (); | |
669 | ~scoped_restore_current_thread (); | |
670 | ||
d6541620 | 671 | DISABLE_COPY_AND_ASSIGN (scoped_restore_current_thread); |
5ed8105e | 672 | |
873657b9 PA |
673 | /* Cancel restoring on scope exit. */ |
674 | void dont_restore () { m_dont_restore = true; } | |
675 | ||
5ed8105e | 676 | private: |
873657b9 PA |
677 | void restore (); |
678 | ||
679 | bool m_dont_restore = false; | |
7aabaf9d SM |
680 | /* Use the "class" keyword here, because of a clash with a "thread_info" |
681 | function in the Darwin API. */ | |
682 | class thread_info *m_thread; | |
5ed8105e PA |
683 | inferior *m_inf; |
684 | frame_id m_selected_frame_id; | |
685 | int m_selected_frame_level; | |
686 | bool m_was_stopped; | |
687 | }; | |
6208b47d | 688 | |
4e1c45ea PA |
689 | /* Returns a pointer into the thread_info corresponding to |
690 | INFERIOR_PTID. INFERIOR_PTID *must* be in the thread list. */ | |
691 | extern struct thread_info* inferior_thread (void); | |
6208b47d | 692 | |
dc146f7c VP |
693 | extern void update_thread_list (void); |
694 | ||
e8032dde PA |
695 | /* Delete any thread the target says is no longer alive. */ |
696 | ||
697 | extern void prune_threads (void); | |
698 | ||
8a06aea7 PA |
699 | /* Delete threads marked THREAD_EXITED. Unlike prune_threads, this |
700 | does not consult the target about whether the thread is alive right | |
701 | now. */ | |
702 | extern void delete_exited_threads (void); | |
703 | ||
ce4c476a PA |
704 | /* Return true if PC is in the stepping range of THREAD. */ |
705 | ||
706 | int pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread); | |
707 | ||
00431a78 PA |
708 | /* Enable storing stack temporaries for thread THR and disable and |
709 | clear the stack temporaries on destruction. Holds a strong | |
710 | reference to THR. */ | |
fdf07f3a TT |
711 | |
712 | class enable_thread_stack_temporaries | |
713 | { | |
714 | public: | |
715 | ||
75cbc781 | 716 | explicit enable_thread_stack_temporaries (struct thread_info *thr) |
00431a78 | 717 | : m_thr (thr) |
fdf07f3a | 718 | { |
00431a78 | 719 | gdb_assert (m_thr != NULL); |
fdf07f3a | 720 | |
00431a78 PA |
721 | m_thr->incref (); |
722 | ||
723 | m_thr->stack_temporaries_enabled = true; | |
724 | m_thr->stack_temporaries.clear (); | |
fdf07f3a TT |
725 | } |
726 | ||
727 | ~enable_thread_stack_temporaries () | |
728 | { | |
00431a78 PA |
729 | m_thr->stack_temporaries_enabled = false; |
730 | m_thr->stack_temporaries.clear (); | |
fdf07f3a | 731 | |
00431a78 | 732 | m_thr->decref (); |
fdf07f3a TT |
733 | } |
734 | ||
735 | DISABLE_COPY_AND_ASSIGN (enable_thread_stack_temporaries); | |
736 | ||
737 | private: | |
738 | ||
75cbc781 | 739 | struct thread_info *m_thr; |
fdf07f3a | 740 | }; |
6c659fc2 | 741 | |
75cbc781 | 742 | extern bool thread_stack_temporaries_enabled_p (struct thread_info *tp); |
6c659fc2 | 743 | |
75cbc781 | 744 | extern void push_thread_stack_temporary (struct thread_info *tp, struct value *v); |
6c659fc2 | 745 | |
75cbc781 | 746 | extern value *get_last_thread_stack_temporary (struct thread_info *tp); |
6c659fc2 | 747 | |
00431a78 | 748 | extern bool value_in_thread_stack_temporaries (struct value *, |
75cbc781 | 749 | struct thread_info *thr); |
6c659fc2 | 750 | |
c2829269 PA |
751 | /* Add TP to the end of its inferior's pending step-over chain. */ |
752 | ||
753 | extern void thread_step_over_chain_enqueue (struct thread_info *tp); | |
754 | ||
755 | /* Remove TP from its inferior's pending step-over chain. */ | |
756 | ||
757 | extern void thread_step_over_chain_remove (struct thread_info *tp); | |
758 | ||
759 | /* Return the next thread in the step-over chain starting at TP. NULL | |
760 | if TP is the last entry in the chain. */ | |
761 | ||
762 | extern struct thread_info *thread_step_over_chain_next (struct thread_info *tp); | |
763 | ||
764 | /* Return true if TP is in the step-over chain. */ | |
765 | ||
766 | extern int thread_is_in_step_over_chain (struct thread_info *tp); | |
767 | ||
243a9253 PA |
768 | /* Cancel any ongoing execution command. */ |
769 | ||
770 | extern void thread_cancel_execution_command (struct thread_info *thr); | |
771 | ||
a911d87a PA |
772 | /* Check whether it makes sense to access a register of the current |
773 | thread at this point. If not, throw an error (e.g., the thread is | |
774 | executing). */ | |
775 | extern void validate_registers_access (void); | |
776 | ||
00431a78 | 777 | /* Check whether it makes sense to access a register of THREAD at this point. |
cf77c34e | 778 | Returns true if registers may be accessed; false otherwise. */ |
75cbc781 | 779 | extern bool can_access_registers_thread (struct thread_info *thread); |
cf77c34e | 780 | |
f303dbd6 PA |
781 | /* Returns whether to show which thread hit the breakpoint, received a |
782 | signal, etc. and ended up causing a user-visible stop. This is | |
783 | true iff we ever detected multiple threads. */ | |
784 | extern int show_thread_that_caused_stop (void); | |
785 | ||
4034d0ff AT |
786 | /* Print the message for a thread or/and frame selected. */ |
787 | extern void print_selected_thread_frame (struct ui_out *uiout, | |
788 | user_selected_what selection); | |
789 | ||
65630365 PA |
790 | /* Helper for the CLI's "thread" command and for MI's -thread-select. |
791 | Selects thread THR. TIDSTR is the original string the thread ID | |
792 | was parsed from. This is used in the error message if THR is not | |
793 | alive anymore. */ | |
7aabaf9d | 794 | extern void thread_select (const char *tidstr, class thread_info *thr); |
65630365 | 795 | |
c5aa993b | 796 | #endif /* GDBTHREAD_H */ |