1 /* Multi-process/thread control defs for GDB, the GNU debugger.
2 Copyright (C) 1987-2017 Free Software Foundation, Inc.
3 Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA.
6 This file is part of GDB.
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.
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.
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/>. */
26 #include "breakpoint.h"
31 #include "common/vec.h"
32 #include "target/waitstatus.h"
33 #include "cli/cli-utils.h"
34 #include "common/refcounted-object.h"
35 #include "common-gdbthread.h"
37 /* Frontend view of the thread state. Possible extensions: stepping,
38 finishing, until(ling),... */
46 /* Inferior thread specific part of `struct infcall_control_state'.
48 Inferior process counterpart is `struct inferior_control_state'. */
50 struct thread_control_state
52 /* User/external stepping state. */
54 /* Step-resume or longjmp-resume breakpoint. */
55 struct breakpoint *step_resume_breakpoint;
57 /* Exception-resume breakpoint. */
58 struct breakpoint *exception_resume_breakpoint;
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. */
65 struct breakpoint *single_step_breakpoints;
67 /* Range to single step within.
69 If this is nonzero, respond to a single-step signal by continuing
70 to step if the pc is in this range.
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
77 CORE_ADDR step_range_start; /* Inclusive */
78 CORE_ADDR step_range_end; /* Exclusive */
80 /* Function the thread was in as of last it started stepping. */
81 struct symbol *step_start_function;
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
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. */
94 struct frame_id step_frame_id;
96 /* Similarly, the frame ID of the underlying stack frame (skipping
97 any inlined frames). */
98 struct frame_id step_stack_frame_id;
100 /* Nonzero if we are presently stepping over a breakpoint.
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
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.
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.
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
124 /* Nonzero if the thread is being proceeded for a "finish" command
125 or a similar situation when return value should be printed. */
126 int proceed_to_finish;
128 /* Nonzero if the thread is being proceeded for an inferior function
132 enum step_over_calls_kind step_over_calls;
134 /* Nonzero if stopped due to a step command. */
137 /* Chain containing status of breakpoint(s) the thread stopped
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". */
144 int stepping_command;
147 /* Inferior thread specific part of `struct infcall_suspend_state'. */
149 struct thread_suspend_state
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. */
158 enum gdb_signal stop_signal;
160 /* The reason the thread last stopped, if we need to track it
161 (breakpoint, watchpoint, etc.) */
162 enum target_stop_reason stop_reason;
164 /* The waitstatus for this thread's last event. */
165 struct target_waitstatus waitstatus;
166 /* If true WAITSTATUS hasn't been handled yet. */
167 int waitstatus_pending_p;
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
171 last stop, e.g., "return" command, or "p $pc = 0xf000"). This is
172 used in coordination with stop_reason and waitstatus_pending_p:
173 if the thread's PC is changed since it last stopped, a pending
174 breakpoint waitstatus is discarded. */
178 typedef struct value *value_ptr;
179 DEF_VEC_P (value_ptr);
180 typedef VEC (value_ptr) value_vec;
182 /* Threads are intrusively refcounted objects. Being the
183 user-selected thread is normally considered an implicit strong
184 reference and is thus not accounted in the refcount, unlike
185 inferior objects. This is necessary, because there's no "current
186 thread" pointer. Instead the current thread is inferred from the
187 inferior_ptid global. However, when GDB needs to remember the
188 selected thread to later restore it, GDB bumps the thread object's
189 refcount, to prevent something deleting the thread object before
190 reverting back (e.g., due to a "kill" command). If the thread
191 meanwhile exits before being re-selected, then the thread object is
192 left listed in the thread list, but marked with state
193 THREAD_EXITED. (See make_cleanup_restore_current_thread and
194 delete_thread). All other thread references are considered weak
195 references. Placing a thread in the thread list is an implicit
196 strong reference, and is thus not accounted for in the thread's
199 class thread_info : public refcounted_object
202 explicit thread_info (inferior *inf, ptid_t ptid);
205 bool deletable () const
207 /* If this is the current thread, or there's code out there that
208 relies on it existing (refcount > 0) we can't delete yet. */
209 return (refcount () == 0 && !ptid_equal (ptid, inferior_ptid));
212 struct thread_info *next = NULL;
213 ptid_t ptid; /* "Actual process id";
214 In fact, this may be overloaded with
215 kernel thread id, etc. */
217 /* Each thread has two GDB IDs.
219 a) The thread ID (Id). This consists of the pair of:
221 - the number of the thread's inferior and,
223 - the thread's thread number in its inferior, aka, the
224 per-inferior thread number. This number is unique in the
225 inferior but not unique between inferiors.
227 b) The global ID (GId). This is a a single integer unique
228 between all inferiors.
232 (gdb) info threads -gid
233 Id GId Target Id Frame
234 * 1.1 1 Thread A 0x16a09237 in foo () at foo.c:10
235 1.2 3 Thread B 0x15ebc6ed in bar () at foo.c:20
236 1.3 5 Thread C 0x15ebc6ed in bar () at foo.c:20
237 2.1 2 Thread A 0x16a09237 in foo () at foo.c:10
238 2.2 4 Thread B 0x15ebc6ed in bar () at foo.c:20
239 2.3 6 Thread C 0x15ebc6ed in bar () at foo.c:20
241 Above, both inferiors 1 and 2 have threads numbered 1-3, but each
242 thread has its own unique global ID. */
244 /* The thread's global GDB thread number. This is exposed to MI,
245 Python/Scheme, visible with "info threads -gid", and is also what
246 the $_gthread convenience variable is bound to. */
249 /* The per-inferior thread number. This is unique in the inferior
250 the thread belongs to, but not unique between inferiors. This is
251 what the $_thread convenience variable is bound to. */
254 /* The inferior this thread belongs to. */
255 struct inferior *inf;
257 /* The name of the thread, as specified by the user. This is NULL
258 if the thread does not have a user-given name. */
261 /* Non-zero means the thread is executing. Note: this is different
262 from saying that there is an active target and we are stopped at
263 a breakpoint, for instance. This is a real indicator whether the
264 thread is off and running. */
267 /* Non-zero if this thread is resumed from infrun's perspective.
268 Note that a thread can be marked both as not-executing and
269 resumed at the same time. This happens if we try to resume a
270 thread that has a wait status pending. We shouldn't let the
271 thread really run until that wait status has been processed, but
272 we should not process that wait status if we didn't try to let
276 /* Frontend view of the thread state. Note that the THREAD_RUNNING/
277 THREAD_STOPPED states are different from EXECUTING. When the
278 thread is stopped internally while handling an internal event,
279 like a software single-step breakpoint, EXECUTING will be false,
280 but STATE will still be THREAD_RUNNING. */
281 enum thread_state state = THREAD_STOPPED;
283 /* State of GDB control of inferior thread execution.
284 See `struct thread_control_state'. */
285 thread_control_state control {};
287 /* State of inferior thread to restore after GDB is done with an inferior
288 call. See `struct thread_suspend_state'. */
289 thread_suspend_state suspend {};
291 int current_line = 0;
292 struct symtab *current_symtab = NULL;
294 /* Internal stepping state. */
296 /* Record the pc of the thread the last time it was resumed. (It
297 can't be done on stop as the PC may change since the last stop,
298 e.g., "return" command, or "p $pc = 0xf000"). This is maintained
299 by proceed and keep_going, and among other things, it's used in
300 adjust_pc_after_break to distinguish a hardware single-step
301 SIGTRAP from a breakpoint SIGTRAP. */
302 CORE_ADDR prev_pc = 0;
304 /* Did we set the thread stepping a breakpoint instruction? This is
305 used in conjunction with PREV_PC to decide whether to adjust the
307 int stepped_breakpoint = 0;
309 /* Should we step over breakpoint next time keep_going is called? */
310 int stepping_over_breakpoint = 0;
312 /* Should we step over a watchpoint next time keep_going is called?
313 This is needed on targets with non-continuable, non-steppable
315 int stepping_over_watchpoint = 0;
317 /* Set to TRUE if we should finish single-stepping over a breakpoint
318 after hitting the current step-resume breakpoint. The context here
319 is that GDB is to do `next' or `step' while signal arrives.
320 When stepping over a breakpoint and signal arrives, GDB will attempt
321 to skip signal handler, so it inserts a step_resume_breakpoint at the
322 signal return address, and resume inferior.
323 step_after_step_resume_breakpoint is set to TRUE at this moment in
324 order to keep GDB in mind that there is still a breakpoint to step over
325 when GDB gets back SIGTRAP from step_resume_breakpoint. */
326 int step_after_step_resume_breakpoint = 0;
328 /* Pointer to the state machine manager object that handles what is
329 left to do for the thread's execution command after the target
330 stops. Several execution commands use it. */
331 struct thread_fsm *thread_fsm = NULL;
333 /* This is used to remember when a fork or vfork event was caught by
334 a catchpoint, and thus the event is to be followed at the next
335 resume of the thread, and not immediately. */
336 struct target_waitstatus pending_follow;
338 /* True if this thread has been explicitly requested to stop. */
339 int stop_requested = 0;
341 /* The initiating frame of a nexting operation, used for deciding
342 which exceptions to intercept. If it is null_frame_id no
343 bp_longjmp or bp_exception but longjmp has been caught just for
344 bp_longjmp_call_dummy. */
345 struct frame_id initiating_frame = null_frame_id;
347 /* Private data used by the target vector implementation. */
348 struct private_thread_info *priv = NULL;
350 /* Function that is called to free PRIVATE. If this is NULL, then
351 xfree will be called on PRIVATE. */
352 void (*private_dtor) (struct private_thread_info *) = NULL;
354 /* Branch trace information for this thread. */
355 struct btrace_thread_info btrace {};
357 /* Flag which indicates that the stack temporaries should be stored while
358 evaluating expressions. */
359 int stack_temporaries_enabled = 0;
361 /* Values that are stored as temporaries on stack while evaluating
363 value_vec *stack_temporaries = NULL;
365 /* Step-over chain. A thread is in the step-over queue if these are
366 non-NULL. If only a single thread is in the chain, then these
367 fields point to self. */
368 struct thread_info *step_over_prev = NULL;
369 struct thread_info *step_over_next = NULL;
372 /* Create an empty thread list, or empty the existing one. */
373 extern void init_thread_list (void);
375 /* Add a thread to the thread list, print a message
376 that a new thread is found, and return the pointer to
377 the new thread. Caller my use this pointer to
378 initialize the private thread data. */
379 extern struct thread_info *add_thread (ptid_t ptid);
381 /* Same as add_thread, but does not print a message
383 extern struct thread_info *add_thread_silent (ptid_t ptid);
385 /* Same as add_thread, and sets the private info. */
386 extern struct thread_info *add_thread_with_info (ptid_t ptid,
387 struct private_thread_info *);
389 /* Delete an existing thread list entry. */
390 extern void delete_thread (ptid_t);
392 /* Delete an existing thread list entry, and be quiet about it. Used
393 after the process this thread having belonged to having already
394 exited, for example. */
395 extern void delete_thread_silent (ptid_t);
397 /* Delete a step_resume_breakpoint from the thread database. */
398 extern void delete_step_resume_breakpoint (struct thread_info *);
400 /* Delete an exception_resume_breakpoint from the thread database. */
401 extern void delete_exception_resume_breakpoint (struct thread_info *);
403 /* Delete the single-step breakpoints of thread TP, if any. */
404 extern void delete_single_step_breakpoints (struct thread_info *tp);
406 /* Check if the thread has software single stepping breakpoints
408 extern int thread_has_single_step_breakpoints_set (struct thread_info *tp);
410 /* Check whether the thread has software single stepping breakpoints
412 extern int thread_has_single_step_breakpoint_here (struct thread_info *tp,
413 struct address_space *aspace,
416 /* Translate the global integer thread id (GDB's homegrown id, not the
417 system's) into a "pid" (which may be overloaded with extra thread
419 extern ptid_t global_thread_id_to_ptid (int num);
421 /* Translate a 'pid' (which may be overloaded with extra thread
422 information) into the global integer thread id (GDB's homegrown id,
423 not the system's). */
424 extern int ptid_to_global_thread_id (ptid_t ptid);
426 /* Returns whether to show inferior-qualified thread IDs, or plain
427 thread numbers. Inferior-qualified IDs are shown whenever we have
428 multiple inferiors, or the only inferior left has number > 1. */
429 extern int show_inferior_qualified_tids (void);
431 /* Return a string version of THR's thread ID. If there are multiple
432 inferiors, then this prints the inferior-qualifier form, otherwise
433 it only prints the thread number. The result is stored in a
434 circular static buffer, NUMCELLS deep. */
435 const char *print_thread_id (struct thread_info *thr);
437 /* Boolean test for an already-known pid (which may be overloaded with
438 extra thread information). */
439 extern int in_thread_list (ptid_t ptid);
441 /* Boolean test for an already-known global thread id (GDB's homegrown
442 global id, not the system's). */
443 extern int valid_global_thread_id (int global_id);
445 /* Search function to lookup a thread by 'pid'. */
446 extern struct thread_info *find_thread_ptid (ptid_t ptid);
448 /* Find thread by GDB global thread ID. */
449 struct thread_info *find_thread_global_id (int global_id);
451 /* Find thread by thread library specific handle in inferior INF. */
452 struct thread_info *find_thread_by_handle (struct value *thread_handle,
453 struct inferior *inf);
455 /* Finds the first thread of the inferior given by PID. If PID is -1,
456 returns the first thread in the list. */
457 struct thread_info *first_thread_of_process (int pid);
459 /* Returns any thread of process PID, giving preference to the current
461 extern struct thread_info *any_thread_of_process (int pid);
463 /* Returns any non-exited thread of process PID, giving preference to
464 the current thread, and to not executing threads. */
465 extern struct thread_info *any_live_thread_of_process (int pid);
467 /* Change the ptid of thread OLD_PTID to NEW_PTID. */
468 void thread_change_ptid (ptid_t old_ptid, ptid_t new_ptid);
470 /* Iterator function to call a user-provided callback function
471 once for each known thread. */
472 typedef int (*thread_callback_func) (struct thread_info *, void *);
473 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
475 /* Traverse all threads. */
476 #define ALL_THREADS(T) \
477 for (T = thread_list; T; T = T->next) \
479 /* Traverse over all threads, sorted by inferior. */
480 #define ALL_THREADS_BY_INFERIOR(inf, tp) \
481 ALL_INFERIORS (inf) \
485 /* Traverse all threads, except those that have THREAD_EXITED
488 #define ALL_NON_EXITED_THREADS(T) \
489 for (T = thread_list; T; T = T->next) \
490 if ((T)->state != THREAD_EXITED)
492 /* Traverse all threads, including those that have THREAD_EXITED
493 state. Allows deleting the currently iterated thread. */
494 #define ALL_THREADS_SAFE(T, TMP) \
495 for ((T) = thread_list; \
496 (T) != NULL ? ((TMP) = (T)->next, 1): 0; \
499 extern int thread_count (void);
501 /* Switch from one thread to another. Does not read registers and
502 sets STOP_PC to -1. */
503 extern void switch_to_thread_no_regs (struct thread_info *thread);
505 /* Marks or clears thread(s) PTID as resumed. If PTID is
506 MINUS_ONE_PTID, applies to all threads. If ptid_is_pid(PTID) is
507 true, applies to all threads of the process pointed at by PTID. */
508 extern void set_resumed (ptid_t ptid, int resumed);
510 /* Marks thread PTID is running, or stopped.
511 If PTID is minus_one_ptid, marks all threads. */
512 extern void set_running (ptid_t ptid, int running);
514 /* Marks or clears thread(s) PTID as having been requested to stop.
515 If PTID is MINUS_ONE_PTID, applies to all threads. If
516 ptid_is_pid(PTID) is true, applies to all threads of the process
517 pointed at by PTID. If STOP, then the THREAD_STOP_REQUESTED
518 observer is called with PTID as argument. */
519 extern void set_stop_requested (ptid_t ptid, int stop);
521 /* NOTE: Since the thread state is not a boolean, most times, you do
522 not want to check it with negation. If you really want to check if
523 the thread is stopped,
527 if (is_stopped (ptid))
531 if (!is_running (ptid))
533 The latter also returns true on exited threads, most likelly not
536 /* Reports if in the frontend's perpective, thread PTID is running. */
537 extern int is_running (ptid_t ptid);
539 /* Is this thread listed, but known to have exited? We keep it listed
540 (but not visible) until it's safe to delete. */
541 extern int is_exited (ptid_t ptid);
543 /* In the frontend's perpective, is this thread stopped? */
544 extern int is_stopped (ptid_t ptid);
546 /* Marks thread PTID as executing, or not. If PTID is minus_one_ptid,
549 Note that this is different from the running state. See the
550 description of state and executing fields of struct
552 extern void set_executing (ptid_t ptid, int executing);
554 /* Reports if thread PTID is executing. */
555 extern int is_executing (ptid_t ptid);
557 /* True if any (known or unknown) thread is or may be executing. */
558 extern int threads_are_executing (void);
560 /* Merge the executing property of thread PTID over to its thread
561 state property (frontend running/stopped view).
563 "not executing" -> "stopped"
564 "executing" -> "running"
567 If PTID is minus_one_ptid, go over all threads.
569 Notifications are only emitted if the thread state did change. */
570 extern void finish_thread_state (ptid_t ptid);
572 /* Same as FINISH_THREAD_STATE, but with an interface suitable to be
573 registered as a cleanup. PTID_P points to the ptid_t that is
574 passed to FINISH_THREAD_STATE. */
575 extern void finish_thread_state_cleanup (void *ptid_p);
577 /* Commands with a prefix of `thread'. */
578 extern struct cmd_list_element *thread_cmd_list;
580 extern void thread_command (char *tidstr, int from_tty);
582 /* Print notices on thread events (attach, detach, etc.), set with
583 `set print thread-events'. */
584 extern int print_thread_events;
586 /* Prints the list of threads and their details on UIOUT. If
587 REQUESTED_THREADS, a list of GDB ids/ranges, is not NULL, only
588 print threads whose ID is included in the list. If PID is not -1,
589 only print threads from the process PID. Otherwise, threads from
590 all attached PIDs are printed. If both REQUESTED_THREADS is not
591 NULL and PID is not -1, then the thread is printed if it belongs to
592 the specified process. Otherwise, an error is raised. */
593 extern void print_thread_info (struct ui_out *uiout, char *requested_threads,
596 /* Save/restore current inferior/thread/frame. */
598 class scoped_restore_current_thread
601 scoped_restore_current_thread ();
602 ~scoped_restore_current_thread ();
604 DISABLE_COPY_AND_ASSIGN (scoped_restore_current_thread);
607 thread_info *m_thread;
609 frame_id m_selected_frame_id;
610 int m_selected_frame_level;
614 /* Returns a pointer into the thread_info corresponding to
615 INFERIOR_PTID. INFERIOR_PTID *must* be in the thread list. */
616 extern struct thread_info* inferior_thread (void);
618 extern void update_thread_list (void);
620 /* Delete any thread the target says is no longer alive. */
622 extern void prune_threads (void);
624 /* Delete threads marked THREAD_EXITED. Unlike prune_threads, this
625 does not consult the target about whether the thread is alive right
627 extern void delete_exited_threads (void);
629 /* Return true if PC is in the stepping range of THREAD. */
631 int pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread);
633 extern struct cleanup *enable_thread_stack_temporaries (ptid_t ptid);
635 extern int thread_stack_temporaries_enabled_p (ptid_t ptid);
637 extern void push_thread_stack_temporary (ptid_t ptid, struct value *v);
639 extern struct value *get_last_thread_stack_temporary (ptid_t);
641 extern int value_in_thread_stack_temporaries (struct value *, ptid_t);
643 /* Add TP to the end of its inferior's pending step-over chain. */
645 extern void thread_step_over_chain_enqueue (struct thread_info *tp);
647 /* Remove TP from its inferior's pending step-over chain. */
649 extern void thread_step_over_chain_remove (struct thread_info *tp);
651 /* Return the next thread in the step-over chain starting at TP. NULL
652 if TP is the last entry in the chain. */
654 extern struct thread_info *thread_step_over_chain_next (struct thread_info *tp);
656 /* Return true if TP is in the step-over chain. */
658 extern int thread_is_in_step_over_chain (struct thread_info *tp);
660 /* Cancel any ongoing execution command. */
662 extern void thread_cancel_execution_command (struct thread_info *thr);
664 /* Check whether it makes sense to access a register of the current
665 thread at this point. If not, throw an error (e.g., the thread is
667 extern void validate_registers_access (void);
669 /* Check whether it makes sense to access a register of PTID at this point.
670 Returns true if registers may be accessed; false otherwise. */
671 extern bool can_access_registers_ptid (ptid_t ptid);
673 /* Returns whether to show which thread hit the breakpoint, received a
674 signal, etc. and ended up causing a user-visible stop. This is
675 true iff we ever detected multiple threads. */
676 extern int show_thread_that_caused_stop (void);
678 /* Print the message for a thread or/and frame selected. */
679 extern void print_selected_thread_frame (struct ui_out *uiout,
680 user_selected_what selection);
682 /* Helper for the CLI's "thread" command and for MI's -thread-select.
683 Selects thread THR. TIDSTR is the original string the thread ID
684 was parsed from. This is used in the error message if THR is not
686 extern void thread_select (const char *tidstr, thread_info *thr);
688 extern struct thread_info *thread_list;
690 #endif /* GDBTHREAD_H */