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