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