gdb: move displaced stepping logic to gdbarch, allow starting concurrent displaced...
[deliverable/binutils-gdb.git] / gdb / gdbthread.h
1 /* Multi-process/thread control defs for GDB, the GNU debugger.
2 Copyright (C) 1987-2020 Free Software Foundation, Inc.
3 Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA.
4
5
6 This file is part of GDB.
7
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
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
12
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.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20
21 #ifndef GDBTHREAD_H
22 #define GDBTHREAD_H
23
24 struct symtab;
25
26 #include "breakpoint.h"
27 #include "frame.h"
28 #include "ui-out.h"
29 #include "btrace.h"
30 #include "target/waitstatus.h"
31 #include "cli/cli-utils.h"
32 #include "gdbsupport/refcounted-object.h"
33 #include "gdbsupport/common-gdbthread.h"
34 #include "gdbsupport/forward-scope-exit.h"
35 #include "displaced-stepping.h"
36
37 struct inferior;
38 struct process_stratum_target;
39
40 /* Frontend view of the thread state. Possible extensions: stepping,
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. */
57 enum thread_state
58 {
59 /* In the frontend's perpective, the thread is stopped. */
60 THREAD_STOPPED,
61
62 /* In the frontend's perpective, the thread is running. */
63 THREAD_RUNNING,
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. */
67 THREAD_EXITED,
68 };
69
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
81 /* Inferior thread specific part of `struct infcall_control_state'.
82
83 Inferior process counterpart is `struct inferior_control_state'. */
84
85 struct thread_control_state
86 {
87 /* User/external stepping state. */
88
89 /* Step-resume or longjmp-resume breakpoint. */
90 struct breakpoint *step_resume_breakpoint = nullptr;
91
92 /* Exception-resume breakpoint. */
93 struct breakpoint *exception_resume_breakpoint = nullptr;
94
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. */
100 struct breakpoint *single_step_breakpoints = nullptr;
101
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
111 not). */
112 CORE_ADDR step_range_start = 0; /* Inclusive */
113 CORE_ADDR step_range_end = 0; /* Exclusive */
114
115 /* Function the thread was in as of last it started stepping. */
116 struct symbol *step_start_function = nullptr;
117
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. */
124 int may_range_step = 0;
125
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. */
129 struct frame_id step_frame_id {};
130
131 /* Similarly, the frame ID of the underlying stack frame (skipping
132 any inlined frames). */
133 struct frame_id step_stack_frame_id {};
134
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. */
139 int trap_expected = 0;
140
141 /* Nonzero if the thread is being proceeded for a "finish" command
142 or a similar situation when return value should be printed. */
143 int proceed_to_finish = 0;
144
145 /* Nonzero if the thread is being proceeded for an inferior function
146 call. */
147 int in_infcall = 0;
148
149 enum step_over_calls_kind step_over_calls = STEP_OVER_NONE;
150
151 /* Nonzero if stopped due to a step command. */
152 int stop_step = 0;
153
154 /* Chain containing status of breakpoint(s) the thread stopped
155 at. */
156 bpstat stop_bpstat = nullptr;
157
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". */
161 int stepping_command = 0;
162 };
163
164 /* Inferior thread specific part of `struct infcall_suspend_state'. */
165
166 struct thread_suspend_state
167 {
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. */
175 enum gdb_signal stop_signal = GDB_SIGNAL_0;
176
177 /* The reason the thread last stopped, if we need to track it
178 (breakpoint, watchpoint, etc.) */
179 enum target_stop_reason stop_reason = TARGET_STOPPED_BY_NO_REASON;
180
181 /* The waitstatus for this thread's last event. */
182 struct target_waitstatus waitstatus {};
183 /* If true WAITSTATUS hasn't been handled yet. */
184 int waitstatus_pending_p = 0;
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
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. */
201 CORE_ADDR stop_pc = 0;
202 };
203
204 /* Base class for target-specific thread data. */
205 struct private_thread_info
206 {
207 virtual ~private_thread_info () = 0;
208 };
209
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
218 reverting back (e.g., due to a "kill" command). If the thread
219 meanwhile exits before being re-selected, then the thread object is
220 left listed in the thread list, but marked with state
221 THREAD_EXITED. (See scoped_restore_current_thread and
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
228 {
229 public:
230 explicit thread_info (inferior *inf, ptid_t ptid);
231 ~thread_info ();
232
233 bool deletable () const;
234
235 /* Mark this thread as running and notify observers. */
236 void set_running (bool running);
237
238 struct regcache *regcache ();
239 struct gdbarch *arch ();
240
241 struct thread_info *next = NULL;
242 ptid_t ptid; /* "Actual process id";
243 In fact, this may be overloaded with
244 kernel thread id, etc. */
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
273 /* The thread's global GDB thread number. This is exposed to MI,
274 Python/Scheme, visible with "info threads -gid", and is also what
275 the $_gthread convenience variable is bound to. */
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;
285
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. */
288 char *name = NULL;
289
290 /* True means the thread is executing. Note: this is different
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. */
294 bool executing = false;
295
296 /* True if this thread is resumed from infrun's perspective.
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. */
303 bool resumed = false;
304
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. */
310 enum thread_state state = THREAD_STOPPED;
311
312 /* State of GDB control of inferior thread execution.
313 See `struct thread_control_state'. */
314 thread_control_state control;
315
316 /* State of inferior thread to restore after GDB is done with an inferior
317 call. See `struct thread_suspend_state'. */
318 thread_suspend_state suspend;
319
320 int current_line = 0;
321 struct symtab *current_symtab = NULL;
322
323 /* Internal stepping state. */
324
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
329 adjust_pc_after_break to distinguish a hardware single-step
330 SIGTRAP from a breakpoint SIGTRAP. */
331 CORE_ADDR prev_pc = 0;
332
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. */
336 int stepped_breakpoint = 0;
337
338 /* Should we step over breakpoint next time keep_going is called? */
339 int stepping_over_breakpoint = 0;
340
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. */
344 int stepping_over_watchpoint = 0;
345
346 /* Set to TRUE if we should finish single-stepping over a breakpoint
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. */
355 int step_after_step_resume_breakpoint = 0;
356
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. */
360 struct thread_fsm *thread_fsm = NULL;
361
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
367 /* True if this thread has been explicitly requested to stop. */
368 int stop_requested = 0;
369
370 /* The initiating frame of a nexting operation, used for deciding
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. */
374 struct frame_id initiating_frame = null_frame_id;
375
376 /* Private data used by the target vector implementation. */
377 std::unique_ptr<private_thread_info> priv;
378
379 /* Branch trace information for this thread. */
380 struct btrace_thread_info btrace {};
381
382 /* Flag which indicates that the stack temporaries should be stored while
383 evaluating expressions. */
384 bool stack_temporaries_enabled = false;
385
386 /* Values that are stored as temporaries on stack while evaluating
387 expressions. */
388 std::vector<struct value *> stack_temporaries;
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. */
393 struct thread_info *step_over_prev = NULL;
394 struct thread_info *step_over_next = NULL;
395
396 displaced_step_thread_state displaced_step_state;
397 };
398
399 /* A gdb::ref_ptr pointer to a thread_info. */
400
401 using thread_info_ref
402 = gdb::ref_ptr<struct thread_info, refcounted_object_ref_policy>;
403
404 /* Create an empty thread list, or empty the existing one. */
405 extern void init_thread_list (void);
406
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. */
411 extern struct thread_info *add_thread (process_stratum_target *targ,
412 ptid_t ptid);
413
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);
418
419 /* Same as add_thread, and sets the private info. */
420 extern struct thread_info *add_thread_with_info (process_stratum_target *targ,
421 ptid_t ptid,
422 private_thread_info *);
423
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. */
427 extern void delete_thread (struct thread_info *thread);
428
429 /* Like delete_thread, but be quiet about it. Used when the process
430 this thread belonged to has already exited, for example. */
431 extern void delete_thread_silent (struct thread_info *thread);
432
433 /* Delete a step_resume_breakpoint from the thread database. */
434 extern void delete_step_resume_breakpoint (struct thread_info *);
435
436 /* Delete an exception_resume_breakpoint from the thread database. */
437 extern void delete_exception_resume_breakpoint (struct thread_info *);
438
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,
449 const address_space *aspace,
450 CORE_ADDR addr);
451
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);
456
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. */
461 const char *print_thread_id (struct thread_info *thr);
462
463 /* Boolean test for an already-known ptid. */
464 extern bool in_thread_list (process_stratum_target *targ, ptid_t ptid);
465
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);
469
470 /* Find (non-exited) thread PTID of inferior INF. */
471 extern thread_info *find_thread_ptid (inferior *inf, ptid_t ptid);
472
473 /* Search function to lookup a (non-exited) thread by 'ptid'. */
474 extern struct thread_info *find_thread_ptid (process_stratum_target *targ,
475 ptid_t ptid);
476
477 /* Search function to lookup a (non-exited) thread by 'ptid'. Only
478 searches in threads of INF. */
479 extern struct thread_info *find_thread_ptid (inferior *inf, ptid_t ptid);
480
481 /* Find thread by GDB global thread ID. */
482 struct thread_info *find_thread_global_id (int global_id);
483
484 /* Find thread by thread library specific handle in inferior INF. */
485 struct thread_info *find_thread_by_handle
486 (gdb::array_view<const gdb_byte> handle, struct inferior *inf);
487
488 /* Finds the first thread of the specified inferior. */
489 extern struct thread_info *first_thread_of_inferior (inferior *inf);
490
491 /* Returns any thread of inferior INF, giving preference to the
492 current thread. */
493 extern struct thread_info *any_thread_of_inferior (inferior *inf);
494
495 /* Returns any non-exited thread of inferior INF, giving preference to
496 the current thread, and to not executing threads. */
497 extern struct thread_info *any_live_thread_of_inferior (inferior *inf);
498
499 /* Change the ptid of thread OLD_PTID to NEW_PTID. */
500 void thread_change_ptid (process_stratum_target *targ,
501 ptid_t old_ptid, ptid_t new_ptid);
502
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
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
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:
517
518 for (thread_info *thr : all_threads ())
519 { .... }
520
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 */
533
534 inline all_matching_threads_range
535 all_threads (process_stratum_target *proc_target = nullptr,
536 ptid_t filter_ptid = minus_one_ptid)
537 {
538 return all_matching_threads_range (proc_target, filter_ptid);
539 }
540
541 /* Return a range that can be used to walk over all non-exited threads
542 of all inferiors, with range-for. Arguments are like all_threads
543 above. */
544
545 inline all_non_exited_threads_range
546 all_non_exited_threads (process_stratum_target *proc_target = nullptr,
547 ptid_t filter_ptid = minus_one_ptid)
548 {
549 return all_non_exited_threads_range (proc_target, filter_ptid);
550 }
551
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:
556
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 {
565 return {};
566 }
567
568 extern int thread_count (process_stratum_target *proc_target);
569
570 /* Return true if we have any thread in any inferior. */
571 extern bool any_thread_p ();
572
573 /* Switch context to thread THR. Also sets the STOP_PC global. */
574 extern void switch_to_thread (struct thread_info *thr);
575
576 /* Switch context to no thread selected. */
577 extern void switch_to_no_thread ();
578
579 /* Switch from one thread to another. Does not read registers. */
580 extern void switch_to_thread_no_regs (struct thread_info *thread);
581
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
584 ptid_is_pid(PTID) is true, applies to all threads of the process
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.
604
605 Note that this is different from the running state. See the
606 description of state and executing fields of struct
607 thread_info. */
608 extern void set_executing (process_stratum_target *targ,
609 ptid_t ptid, bool executing);
610
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);
614
615 /* Merge the executing property of thread PTID of TARG over to its
616 thread state property (frontend running/stopped view).
617
618 "not executing" -> "stopped"
619 "executing" -> "running"
620 "exited" -> "exited"
621
622 If PTID is minus_one_ptid, go over all threads of TARG.
623
624 Notifications are only emitted if the thread state did change. */
625 extern void finish_thread_state (process_stratum_target *targ, ptid_t ptid);
626
627 /* Calls finish_thread_state on scope exit, unless release() is called
628 to disengage. */
629 using scoped_finish_thread_state
630 = FORWARD_SCOPE_EXIT (finish_thread_state);
631
632 /* Commands with a prefix of `thread'. */
633 extern struct cmd_list_element *thread_cmd_list;
634
635 extern void thread_command (const char *tidstr, int from_tty);
636
637 /* Print notices on thread events (attach, detach, etc.), set with
638 `set print thread-events'. */
639 extern bool print_thread_events;
640
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. */
648 extern void print_thread_info (struct ui_out *uiout,
649 const char *requested_threads,
650 int pid);
651
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
660 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_thread);
661
662 /* Cancel restoring on scope exit. */
663 void dont_restore () { m_dont_restore = true; }
664
665 private:
666 void restore ();
667
668 bool m_dont_restore = false;
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;
672 inferior *m_inf;
673 frame_id m_selected_frame_id;
674 int m_selected_frame_level;
675 bool m_was_stopped;
676 };
677
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);
681
682 extern void update_thread_list (void);
683
684 /* Delete any thread the target says is no longer alive. */
685
686 extern void prune_threads (void);
687
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
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
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. */
700
701 class enable_thread_stack_temporaries
702 {
703 public:
704
705 explicit enable_thread_stack_temporaries (struct thread_info *thr)
706 : m_thr (thr)
707 {
708 gdb_assert (m_thr != NULL);
709
710 m_thr->incref ();
711
712 m_thr->stack_temporaries_enabled = true;
713 m_thr->stack_temporaries.clear ();
714 }
715
716 ~enable_thread_stack_temporaries ()
717 {
718 m_thr->stack_temporaries_enabled = false;
719 m_thr->stack_temporaries.clear ();
720
721 m_thr->decref ();
722 }
723
724 DISABLE_COPY_AND_ASSIGN (enable_thread_stack_temporaries);
725
726 private:
727
728 struct thread_info *m_thr;
729 };
730
731 extern bool thread_stack_temporaries_enabled_p (struct thread_info *tp);
732
733 extern void push_thread_stack_temporary (struct thread_info *tp, struct value *v);
734
735 extern value *get_last_thread_stack_temporary (struct thread_info *tp);
736
737 extern bool value_in_thread_stack_temporaries (struct value *,
738 struct thread_info *thr);
739
740 /* Add TP to the end of the global pending step-over chain. */
741
742 extern void global_thread_step_over_chain_enqueue (struct thread_info *tp);
743
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
749 /* Remove TP from the global pending step-over chain. */
750
751 extern void global_thread_step_over_chain_remove (thread_info *tp);
752
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. */
755
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);
763
764 /* Return true if TP is in any step-over chain. */
765
766 extern int thread_is_in_step_over_chain (struct thread_info *tp);
767
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
772 /* Cancel any ongoing execution command. */
773
774 extern void thread_cancel_execution_command (struct thread_info *thr);
775
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
781 /* Check whether it makes sense to access a register of THREAD at this point.
782 Returns true if registers may be accessed; false otherwise. */
783 extern bool can_access_registers_thread (struct thread_info *thread);
784
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
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
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. */
798 extern void thread_select (const char *tidstr, class thread_info *thr);
799
800 #endif /* GDBTHREAD_H */
This page took 0.056208 seconds and 4 git commands to generate.