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