1 /* Multi-process/thread control for GDB, the GNU debugger.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "gdbthread.h"
36 #include <sys/types.h>
39 #include "observable.h"
41 #include "cli/cli-decode.h"
42 #include "gdb_regex.h"
43 #include "cli/cli-utils.h"
44 #include "thread-fsm.h"
45 #include "tid-parse.h"
47 #include "common/gdb_optional.h"
49 /* Definition of struct thread_info exported to gdbthread.h. */
51 /* Prototypes for local functions. */
53 struct thread_info *thread_list = NULL;
54 static int highest_thread_num;
56 /* True if any thread is, or may be executing. We need to track this
57 separately because until we fully sync the thread list, we won't
58 know whether the target is fully stopped, even if we see stop
59 events for all known threads, because any of those threads may have
60 spawned new threads we haven't heard of yet. */
61 static int threads_executing;
63 static int thread_alive (struct thread_info *);
65 /* RAII type used to increase / decrease the refcount of each thread
66 in a given list of threads. */
68 class scoped_inc_dec_ref
71 explicit scoped_inc_dec_ref (const std::vector<thread_info *> &thrds)
74 for (thread_info *thr : m_thrds)
78 ~scoped_inc_dec_ref ()
80 for (thread_info *thr : m_thrds)
85 const std::vector<thread_info *> &m_thrds;
90 inferior_thread (void)
92 struct thread_info *tp = find_thread_ptid (inferior_ptid);
97 /* Delete the breakpoint pointed at by BP_P, if there's one. */
100 delete_thread_breakpoint (struct breakpoint **bp_p)
104 delete_breakpoint (*bp_p);
110 delete_step_resume_breakpoint (struct thread_info *tp)
113 delete_thread_breakpoint (&tp->control.step_resume_breakpoint);
117 delete_exception_resume_breakpoint (struct thread_info *tp)
120 delete_thread_breakpoint (&tp->control.exception_resume_breakpoint);
123 /* See gdbthread.h. */
126 delete_single_step_breakpoints (struct thread_info *tp)
129 delete_thread_breakpoint (&tp->control.single_step_breakpoints);
132 /* Delete the breakpoint pointed at by BP_P at the next stop, if
136 delete_at_next_stop (struct breakpoint **bp)
140 (*bp)->disposition = disp_del_at_next_stop;
145 /* See gdbthread.h. */
148 thread_has_single_step_breakpoints_set (struct thread_info *tp)
150 return tp->control.single_step_breakpoints != NULL;
153 /* See gdbthread.h. */
156 thread_has_single_step_breakpoint_here (struct thread_info *tp,
157 const address_space *aspace,
160 struct breakpoint *ss_bps = tp->control.single_step_breakpoints;
162 return (ss_bps != NULL
163 && breakpoint_has_location_inserted_here (ss_bps, aspace, addr));
166 /* See gdbthread.h. */
169 thread_cancel_execution_command (struct thread_info *thr)
171 if (thr->thread_fsm != NULL)
173 thread_fsm_clean_up (thr->thread_fsm, thr);
174 thread_fsm_delete (thr->thread_fsm);
175 thr->thread_fsm = NULL;
180 clear_thread_inferior_resources (struct thread_info *tp)
182 /* NOTE: this will take care of any left-over step_resume breakpoints,
183 but not any user-specified thread-specific breakpoints. We can not
184 delete the breakpoint straight-off, because the inferior might not
185 be stopped at the moment. */
186 delete_at_next_stop (&tp->control.step_resume_breakpoint);
187 delete_at_next_stop (&tp->control.exception_resume_breakpoint);
188 delete_at_next_stop (&tp->control.single_step_breakpoints);
190 delete_longjmp_breakpoint_at_next_stop (tp->global_num);
192 bpstat_clear (&tp->control.stop_bpstat);
194 btrace_teardown (tp);
196 thread_cancel_execution_command (tp);
199 /* Set the TP's state as exited. */
202 set_thread_exited (thread_info *tp, int silent)
204 /* Dead threads don't need to step-over. Remove from queue. */
205 if (tp->step_over_next != NULL)
206 thread_step_over_chain_remove (tp);
208 if (tp->state != THREAD_EXITED)
210 gdb::observers::thread_exit.notify (tp, silent);
212 /* Tag it as exited. */
213 tp->state = THREAD_EXITED;
215 /* Clear breakpoints, etc. associated with this thread. */
216 clear_thread_inferior_resources (tp);
221 init_thread_list (void)
223 struct thread_info *tp, *tmp;
225 highest_thread_num = 0;
227 ALL_THREADS_SAFE (tp, tmp)
229 if (tp->deletable ())
232 set_thread_exited (tp, 1);
236 threads_executing = 0;
239 /* Allocate a new thread of inferior INF with target id PTID and add
240 it to the thread list. */
242 static struct thread_info *
243 new_thread (struct inferior *inf, ptid_t ptid)
245 thread_info *tp = new thread_info (inf, ptid);
247 if (thread_list == NULL)
251 struct thread_info *last;
253 for (last = thread_list; last->next != NULL; last = last->next)
262 add_thread_silent (ptid_t ptid)
264 struct thread_info *tp;
265 struct inferior *inf = find_inferior_ptid (ptid);
266 gdb_assert (inf != NULL);
268 tp = find_thread_ptid (ptid);
270 /* Found an old thread with the same id. It has to be dead,
271 otherwise we wouldn't be adding a new thread with the same id.
272 The OS is reusing this id --- delete it, and recreate a new
275 /* In addition to deleting the thread, if this is the current
276 thread, then we need to take care that delete_thread doesn't
277 really delete the thread if it is inferior_ptid. Create a
278 new template thread in the list with an invalid ptid, switch
279 to it, delete the original thread, reset the new thread's
280 ptid, and switch to it. */
282 if (inferior_ptid == ptid)
284 thread_info *new_thr = new_thread (inf, null_ptid);
286 /* Make switch_to_thread not read from the thread. */
287 new_thr->state = THREAD_EXITED;
288 switch_to_no_thread ();
290 /* Now we can delete it. */
293 /* Now reset its ptid, and reswitch inferior_ptid to it. */
294 new_thr->ptid = ptid;
295 new_thr->state = THREAD_STOPPED;
296 switch_to_thread (new_thr);
298 gdb::observers::new_thread.notify (new_thr);
304 /* Just go ahead and delete it. */
308 tp = new_thread (inf, ptid);
309 gdb::observers::new_thread.notify (tp);
315 add_thread_with_info (ptid_t ptid, private_thread_info *priv)
317 struct thread_info *result = add_thread_silent (ptid);
319 result->priv.reset (priv);
321 if (print_thread_events)
322 printf_unfiltered (_("[New %s]\n"), target_pid_to_str (ptid));
324 annotate_new_thread ();
329 add_thread (ptid_t ptid)
331 return add_thread_with_info (ptid, NULL);
334 private_thread_info::~private_thread_info () = default;
336 thread_info::thread_info (struct inferior *inf_, ptid_t ptid_)
337 : ptid (ptid_), inf (inf_)
339 gdb_assert (inf_ != NULL);
341 this->global_num = ++highest_thread_num;
342 this->per_inf_num = ++inf_->highest_thread_num;
344 /* Nothing to follow yet. */
345 memset (&this->pending_follow, 0, sizeof (this->pending_follow));
346 this->pending_follow.kind = TARGET_WAITKIND_SPURIOUS;
347 this->suspend.waitstatus.kind = TARGET_WAITKIND_IGNORE;
350 thread_info::~thread_info ()
355 /* Add TP to the end of the step-over chain LIST_P. */
358 step_over_chain_enqueue (struct thread_info **list_p, struct thread_info *tp)
360 gdb_assert (tp->step_over_next == NULL);
361 gdb_assert (tp->step_over_prev == NULL);
366 tp->step_over_prev = tp->step_over_next = tp;
370 struct thread_info *head = *list_p;
371 struct thread_info *tail = head->step_over_prev;
373 tp->step_over_prev = tail;
374 tp->step_over_next = head;
375 head->step_over_prev = tp;
376 tail->step_over_next = tp;
380 /* Remove TP from step-over chain LIST_P. */
383 step_over_chain_remove (struct thread_info **list_p, struct thread_info *tp)
385 gdb_assert (tp->step_over_next != NULL);
386 gdb_assert (tp->step_over_prev != NULL);
390 if (tp == tp->step_over_next)
393 *list_p = tp->step_over_next;
396 tp->step_over_prev->step_over_next = tp->step_over_next;
397 tp->step_over_next->step_over_prev = tp->step_over_prev;
398 tp->step_over_prev = tp->step_over_next = NULL;
401 /* See gdbthread.h. */
404 thread_step_over_chain_next (struct thread_info *tp)
406 struct thread_info *next = tp->step_over_next;
408 return (next == step_over_queue_head ? NULL : next);
411 /* See gdbthread.h. */
414 thread_is_in_step_over_chain (struct thread_info *tp)
416 return (tp->step_over_next != NULL);
419 /* See gdbthread.h. */
422 thread_step_over_chain_enqueue (struct thread_info *tp)
424 step_over_chain_enqueue (&step_over_queue_head, tp);
427 /* See gdbthread.h. */
430 thread_step_over_chain_remove (struct thread_info *tp)
432 step_over_chain_remove (&step_over_queue_head, tp);
435 /* Delete thread TP. If SILENT, don't notify the observer of this
439 delete_thread_1 (thread_info *thr, bool silent)
441 struct thread_info *tp, *tpprev;
445 for (tp = thread_list; tp; tpprev = tp, tp = tp->next)
452 set_thread_exited (tp, silent);
454 if (!tp->deletable ())
456 /* Will be really deleted some other time. */
461 tpprev->next = tp->next;
463 thread_list = tp->next;
468 /* Delete thread THREAD and notify of thread exit. If this is the
469 current thread, don't actually delete it, but tag it as exited and
470 do the notification. If this is the user selected thread, clear
474 delete_thread (thread_info *thread)
476 delete_thread_1 (thread, false /* not silent */);
480 delete_thread_silent (thread_info *thread)
482 delete_thread_1 (thread, true /* silent */);
486 find_thread_global_id (int global_id)
488 struct thread_info *tp;
490 for (tp = thread_list; tp; tp = tp->next)
491 if (tp->global_num == global_id)
497 static struct thread_info *
498 find_thread_id (struct inferior *inf, int thr_num)
500 struct thread_info *tp;
502 for (tp = thread_list; tp; tp = tp->next)
503 if (tp->inf == inf && tp->per_inf_num == thr_num)
509 /* Find a thread_info by matching PTID. */
512 find_thread_ptid (ptid_t ptid)
514 struct thread_info *tp;
516 for (tp = thread_list; tp; tp = tp->next)
517 if (tp->ptid == ptid)
523 /* See gdbthread.h. */
526 find_thread_by_handle (struct value *thread_handle, struct inferior *inf)
528 return target_thread_handle_to_thread_info
529 (value_contents_all (thread_handle),
530 TYPE_LENGTH (value_type (thread_handle)),
535 * Thread iterator function.
537 * Calls a callback function once for each thread, so long as
538 * the callback function returns false. If the callback function
539 * returns true, the iteration will end and the current thread
540 * will be returned. This can be useful for implementing a
541 * search for a thread with arbitrary attributes, or for applying
542 * some operation to every thread.
544 * FIXME: some of the existing functionality, such as
545 * "Thread apply all", might be rewritten using this functionality.
549 iterate_over_threads (int (*callback) (struct thread_info *, void *),
552 struct thread_info *tp, *next;
554 for (tp = thread_list; tp; tp = next)
557 if ((*callback) (tp, data))
568 struct thread_info *tp;
570 for (tp = thread_list; tp; tp = tp->next)
576 /* Return the number of non-exited threads in the thread list. */
579 live_threads_count (void)
582 struct thread_info *tp;
584 ALL_NON_EXITED_THREADS (tp)
591 valid_global_thread_id (int global_id)
593 struct thread_info *tp;
595 for (tp = thread_list; tp; tp = tp->next)
596 if (tp->global_num == global_id)
603 in_thread_list (ptid_t ptid)
605 struct thread_info *tp;
607 for (tp = thread_list; tp; tp = tp->next)
608 if (tp->ptid == ptid)
611 return 0; /* Never heard of 'im. */
614 /* Finds the first thread of the inferior. */
617 first_thread_of_inferior (inferior *inf)
619 struct thread_info *tp, *ret = NULL;
621 for (tp = thread_list; tp; tp = tp->next)
623 if (ret == NULL || tp->global_num < ret->global_num)
630 any_thread_of_inferior (inferior *inf)
632 struct thread_info *tp;
634 gdb_assert (inf->pid != 0);
636 /* Prefer the current thread. */
637 if (inf == current_inferior ())
638 return inferior_thread ();
640 ALL_NON_EXITED_THREADS (tp)
648 any_live_thread_of_inferior (inferior *inf)
650 struct thread_info *curr_tp = NULL;
651 struct thread_info *tp;
652 struct thread_info *tp_executing = NULL;
654 gdb_assert (inf != NULL && inf->pid != 0);
656 /* Prefer the current thread if it's not executing. */
657 if (inferior_ptid != null_ptid && current_inferior () == inf)
659 /* If the current thread is dead, forget it. If it's not
660 executing, use it. Otherwise, still choose it (below), but
661 only if no other non-executing thread is found. */
662 curr_tp = inferior_thread ();
663 if (curr_tp->state == THREAD_EXITED)
665 else if (!curr_tp->executing)
669 ALL_NON_EXITED_THREADS (tp)
678 /* If both the current thread and all live threads are executing,
679 prefer the current thread. */
683 /* Otherwise, just return an executing thread, if any. */
687 /* Return true if TP is an active thread. */
689 thread_alive (struct thread_info *tp)
691 if (tp->state == THREAD_EXITED)
693 if (!target_thread_alive (tp->ptid))
698 /* See gdbthreads.h. */
703 struct thread_info *tp, *tmp;
705 ALL_THREADS_SAFE (tp, tmp)
707 if (!thread_alive (tp))
712 /* See gdbthreads.h. */
715 delete_exited_threads (void)
717 struct thread_info *tp, *tmp;
719 ALL_THREADS_SAFE (tp, tmp)
721 if (tp->state == THREAD_EXITED)
726 /* Return true value if stack temporaies are enabled for the thread
730 thread_stack_temporaries_enabled_p (thread_info *tp)
735 return tp->stack_temporaries_enabled;
738 /* Push V on to the stack temporaries of the thread with id PTID. */
741 push_thread_stack_temporary (thread_info *tp, struct value *v)
743 gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
744 tp->stack_temporaries.push_back (v);
747 /* Return true if VAL is among the stack temporaries of the thread
748 TP. Return false otherwise. */
751 value_in_thread_stack_temporaries (struct value *val, thread_info *tp)
753 gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
754 for (value *v : tp->stack_temporaries)
761 /* Return the last of the stack temporaries for thread with id PTID.
762 Return NULL if there are no stack temporaries for the thread. */
765 get_last_thread_stack_temporary (thread_info *tp)
767 struct value *lastval = NULL;
769 gdb_assert (tp != NULL);
770 if (!tp->stack_temporaries.empty ())
771 lastval = tp->stack_temporaries.back ();
777 thread_change_ptid (ptid_t old_ptid, ptid_t new_ptid)
779 struct inferior *inf;
780 struct thread_info *tp;
782 /* It can happen that what we knew as the target inferior id
783 changes. E.g, target remote may only discover the remote process
784 pid after adding the inferior to GDB's list. */
785 inf = find_inferior_ptid (old_ptid);
786 inf->pid = ptid_get_pid (new_ptid);
788 tp = find_thread_ptid (old_ptid);
791 gdb::observers::thread_ptid_changed.notify (old_ptid, new_ptid);
794 /* See gdbthread.h. */
797 set_resumed (ptid_t ptid, int resumed)
799 struct thread_info *tp;
800 int all = ptid == minus_one_ptid;
802 if (all || ptid_is_pid (ptid))
804 for (tp = thread_list; tp; tp = tp->next)
805 if (all || ptid_get_pid (tp->ptid) == ptid_get_pid (ptid))
806 tp->resumed = resumed;
810 tp = find_thread_ptid (ptid);
811 gdb_assert (tp != NULL);
812 tp->resumed = resumed;
816 /* Helper for set_running, that marks one thread either running or
820 set_running_thread (struct thread_info *tp, int running)
824 if (running && tp->state == THREAD_STOPPED)
826 tp->state = running ? THREAD_RUNNING : THREAD_STOPPED;
830 /* If the thread is now marked stopped, remove it from
831 the step-over queue, so that we don't try to resume
832 it until the user wants it to. */
833 if (tp->step_over_next != NULL)
834 thread_step_over_chain_remove (tp);
840 /* See gdbthread.h. */
843 thread_info::set_running (bool running)
845 if (set_running_thread (this, running))
846 gdb::observers::target_resumed.notify (this->ptid);
850 set_running (ptid_t ptid, int running)
852 struct thread_info *tp;
853 int all = ptid == minus_one_ptid;
856 /* We try not to notify the observer if no thread has actually changed
857 the running state -- merely to reduce the number of messages to
858 frontend. Frontend is supposed to handle multiple *running just fine. */
859 if (all || ptid_is_pid (ptid))
861 for (tp = thread_list; tp; tp = tp->next)
862 if (all || ptid_get_pid (tp->ptid) == ptid_get_pid (ptid))
864 if (tp->state == THREAD_EXITED)
867 if (set_running_thread (tp, running))
873 tp = find_thread_ptid (ptid);
874 gdb_assert (tp != NULL);
875 gdb_assert (tp->state != THREAD_EXITED);
876 if (set_running_thread (tp, running))
880 gdb::observers::target_resumed.notify (ptid);
884 is_thread_state (ptid_t ptid, enum thread_state state)
886 struct thread_info *tp;
888 tp = find_thread_ptid (ptid);
890 return tp->state == state;
894 is_stopped (ptid_t ptid)
896 return is_thread_state (ptid, THREAD_STOPPED);
900 is_exited (ptid_t ptid)
902 return is_thread_state (ptid, THREAD_EXITED);
906 is_running (ptid_t ptid)
908 return is_thread_state (ptid, THREAD_RUNNING);
912 is_executing (ptid_t ptid)
914 struct thread_info *tp;
916 tp = find_thread_ptid (ptid);
918 return tp->executing;
921 /* Helper for set_executing. Set's the thread's 'executing' field
922 from EXECUTING, and if EXECUTING is true also clears the thread's
926 set_executing_thread (thread_info *thr, bool executing)
928 thr->executing = executing;
930 thr->suspend.stop_pc = ~(CORE_ADDR) 0;
934 set_executing (ptid_t ptid, int executing)
936 struct thread_info *tp;
937 int all = ptid == minus_one_ptid;
939 if (all || ptid_is_pid (ptid))
941 for (tp = thread_list; tp; tp = tp->next)
942 if (all || ptid_get_pid (tp->ptid) == ptid_get_pid (ptid))
943 set_executing_thread (tp, executing);
947 tp = find_thread_ptid (ptid);
949 set_executing_thread (tp, executing);
952 /* It only takes one running thread to spawn more threads.*/
954 threads_executing = 1;
955 /* Only clear the flag if the caller is telling us everything is
957 else if (minus_one_ptid == ptid)
958 threads_executing = 0;
961 /* See gdbthread.h. */
964 threads_are_executing (void)
966 return threads_executing;
970 set_stop_requested (ptid_t ptid, int stop)
972 struct thread_info *tp;
973 int all = ptid == minus_one_ptid;
975 if (all || ptid_is_pid (ptid))
977 for (tp = thread_list; tp; tp = tp->next)
978 if (all || ptid_get_pid (tp->ptid) == ptid_get_pid (ptid))
979 tp->stop_requested = stop;
983 tp = find_thread_ptid (ptid);
985 tp->stop_requested = stop;
988 /* Call the stop requested observer so other components of GDB can
989 react to this request. */
991 gdb::observers::thread_stop_requested.notify (ptid);
995 finish_thread_state (ptid_t ptid)
997 struct thread_info *tp;
1001 all = ptid == minus_one_ptid;
1003 if (all || ptid_is_pid (ptid))
1005 for (tp = thread_list; tp; tp = tp->next)
1007 if (tp->state == THREAD_EXITED)
1009 if (all || ptid_get_pid (ptid) == ptid_get_pid (tp->ptid))
1011 if (set_running_thread (tp, tp->executing))
1018 tp = find_thread_ptid (ptid);
1020 if (tp->state != THREAD_EXITED)
1022 if (set_running_thread (tp, tp->executing))
1028 gdb::observers::target_resumed.notify (ptid);
1031 /* See gdbthread.h. */
1034 validate_registers_access (void)
1036 /* No selected thread, no registers. */
1037 if (inferior_ptid == null_ptid)
1038 error (_("No thread selected."));
1040 thread_info *tp = inferior_thread ();
1042 /* Don't try to read from a dead thread. */
1043 if (tp->state == THREAD_EXITED)
1044 error (_("The current thread has terminated"));
1046 /* ... or from a spinning thread. FIXME: This isn't actually fully
1047 correct. It'll allow an user-requested access (e.g., "print $pc"
1048 at the prompt) when a thread is not executing for some internal
1049 reason, but is marked running from the user's perspective. E.g.,
1050 the thread is waiting for its turn in the step-over queue. */
1052 error (_("Selected thread is running."));
1055 /* See gdbthread.h. */
1058 can_access_registers_thread (thread_info *thread)
1060 /* No thread, no registers. */
1064 /* Don't try to read from a dead thread. */
1065 if (thread->state == THREAD_EXITED)
1068 /* ... or from a spinning thread. FIXME: see validate_registers_access. */
1069 if (thread->executing)
1076 pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread)
1078 return (pc >= thread->control.step_range_start
1079 && pc < thread->control.step_range_end);
1082 /* Helper for print_thread_info. Returns true if THR should be
1083 printed. If REQUESTED_THREADS, a list of GDB ids/ranges, is not
1084 NULL, only print THR if its ID is included in the list. GLOBAL_IDS
1085 is true if REQUESTED_THREADS is list of global IDs, false if a list
1086 of per-inferior thread ids. If PID is not -1, only print THR if it
1087 is a thread from the process PID. Otherwise, threads from all
1088 attached PIDs are printed. If both REQUESTED_THREADS is not NULL
1089 and PID is not -1, then the thread is printed if it belongs to the
1090 specified process. Otherwise, an error is raised. */
1093 should_print_thread (const char *requested_threads, int default_inf_num,
1094 int global_ids, int pid, struct thread_info *thr)
1096 if (requested_threads != NULL && *requested_threads != '\0')
1101 in_list = number_is_in_list (requested_threads, thr->global_num);
1103 in_list = tid_is_in_list (requested_threads, default_inf_num,
1104 thr->inf->num, thr->per_inf_num);
1109 if (pid != -1 && ptid_get_pid (thr->ptid) != pid)
1111 if (requested_threads != NULL && *requested_threads != '\0')
1112 error (_("Requested thread not found in requested process"));
1116 if (thr->state == THREAD_EXITED)
1122 /* Like print_thread_info, but in addition, GLOBAL_IDS indicates
1123 whether REQUESTED_THREADS is a list of global or per-inferior
1127 print_thread_info_1 (struct ui_out *uiout, const char *requested_threads,
1128 int global_ids, int pid,
1129 int show_global_ids)
1131 struct thread_info *tp;
1132 const char *extra_info, *name, *target_id;
1133 struct inferior *inf;
1134 int default_inf_num = current_inferior ()->num;
1136 update_thread_list ();
1138 /* Whether we saw any thread. */
1139 bool any_thread = false;
1140 /* Whether the current thread is exited. */
1141 bool current_exited = false;
1143 thread_info *current_thread = (inferior_ptid != null_ptid
1144 ? inferior_thread () : NULL);
1147 /* For backward compatibility, we make a list for MI. A table is
1148 preferable for the CLI, though, because it shows table
1150 gdb::optional<ui_out_emit_list> list_emitter;
1151 gdb::optional<ui_out_emit_table> table_emitter;
1153 if (uiout->is_mi_like_p ())
1154 list_emitter.emplace (uiout, "threads");
1161 if (!should_print_thread (requested_threads, default_inf_num,
1162 global_ids, pid, tp))
1170 if (requested_threads == NULL || *requested_threads == '\0')
1171 uiout->message (_("No threads.\n"));
1173 uiout->message (_("No threads match '%s'.\n"),
1178 table_emitter.emplace (uiout, show_global_ids ? 5 : 4,
1179 n_threads, "threads");
1181 uiout->table_header (1, ui_left, "current", "");
1182 uiout->table_header (4, ui_left, "id-in-tg", "Id");
1183 if (show_global_ids)
1184 uiout->table_header (4, ui_left, "id", "GId");
1185 uiout->table_header (17, ui_left, "target-id", "Target Id");
1186 uiout->table_header (1, ui_left, "frame", "Frame");
1187 uiout->table_body ();
1190 /* We'll be switching threads temporarily. */
1191 scoped_restore_current_thread restore_thread;
1193 ALL_THREADS_BY_INFERIOR (inf, tp)
1198 if (tp == current_thread && tp->state == THREAD_EXITED)
1199 current_exited = true;
1201 if (!should_print_thread (requested_threads, default_inf_num,
1202 global_ids, pid, tp))
1205 ui_out_emit_tuple tuple_emitter (uiout, NULL);
1207 if (!uiout->is_mi_like_p ())
1209 if (tp == current_thread)
1210 uiout->field_string ("current", "*");
1212 uiout->field_skip ("current");
1214 uiout->field_string ("id-in-tg", print_thread_id (tp));
1217 if (show_global_ids || uiout->is_mi_like_p ())
1218 uiout->field_int ("id", tp->global_num);
1220 /* For the CLI, we stuff everything into the target-id field.
1221 This is a gross hack to make the output come out looking
1222 correct. The underlying problem here is that ui-out has no
1223 way to specify that a field's space allocation should be
1224 shared by several fields. For MI, we do the right thing
1227 target_id = target_pid_to_str (tp->ptid);
1228 extra_info = target_extra_thread_info (tp);
1229 name = tp->name ? tp->name : target_thread_name (tp);
1231 if (uiout->is_mi_like_p ())
1233 uiout->field_string ("target-id", target_id);
1235 uiout->field_string ("details", extra_info);
1237 uiout->field_string ("name", name);
1241 std::string contents;
1243 if (extra_info && name)
1244 contents = string_printf ("%s \"%s\" (%s)", target_id,
1246 else if (extra_info)
1247 contents = string_printf ("%s (%s)", target_id, extra_info);
1249 contents = string_printf ("%s \"%s\"", target_id, name);
1251 contents = target_id;
1253 uiout->field_string ("target-id", contents.c_str ());
1256 if (tp->state == THREAD_RUNNING)
1257 uiout->text ("(running)\n");
1260 /* The switch below puts us at the top of the stack (leaf
1262 switch_to_thread (tp);
1263 print_stack_frame (get_selected_frame (NULL),
1264 /* For MI output, print frame level. */
1265 uiout->is_mi_like_p (),
1269 if (uiout->is_mi_like_p ())
1271 const char *state = "stopped";
1273 if (tp->state == THREAD_RUNNING)
1275 uiout->field_string ("state", state);
1278 core = target_core_of_thread (tp->ptid);
1279 if (uiout->is_mi_like_p () && core != -1)
1280 uiout->field_int ("core", core);
1283 /* This end scope restores the current thread and the frame
1284 selected before the "info threads" command, and it finishes the
1285 ui-out list or table. */
1288 if (pid == -1 && requested_threads == NULL)
1290 if (uiout->is_mi_like_p () && inferior_ptid != null_ptid)
1291 uiout->field_int ("current-thread-id", current_thread->global_num);
1293 if (inferior_ptid != null_ptid && current_exited)
1294 uiout->message ("\n\
1295 The current thread <Thread ID %s> has terminated. See `help thread'.\n",
1296 print_thread_id (inferior_thread ()));
1297 else if (any_thread && inferior_ptid == null_ptid)
1298 uiout->message ("\n\
1299 No selected thread. See `help thread'.\n");
1303 /* See gdbthread.h. */
1306 print_thread_info (struct ui_out *uiout, char *requested_threads, int pid)
1308 print_thread_info_1 (uiout, requested_threads, 1, pid, 0);
1311 /* Implementation of the "info threads" command.
1313 Note: this has the drawback that it _really_ switches
1314 threads, which frees the frame cache. A no-side
1315 effects info-threads command would be nicer. */
1318 info_threads_command (const char *arg, int from_tty)
1320 int show_global_ids = 0;
1323 && check_for_argument (&arg, "-gid", sizeof ("-gid") - 1))
1325 arg = skip_spaces (arg);
1326 show_global_ids = 1;
1329 print_thread_info_1 (current_uiout, arg, 0, -1, show_global_ids);
1332 /* See gdbthread.h. */
1335 switch_to_thread_no_regs (struct thread_info *thread)
1337 struct inferior *inf = thread->inf;
1339 set_current_program_space (inf->pspace);
1340 set_current_inferior (inf);
1342 inferior_ptid = thread->ptid;
1345 /* See gdbthread.h. */
1348 switch_to_no_thread ()
1350 if (inferior_ptid == null_ptid)
1353 inferior_ptid = null_ptid;
1354 reinit_frame_cache ();
1357 /* See gdbthread.h. */
1360 switch_to_thread (thread_info *thr)
1362 gdb_assert (thr != NULL);
1364 if (inferior_ptid == thr->ptid)
1367 switch_to_thread_no_regs (thr);
1369 reinit_frame_cache ();
1372 /* See common/common-gdbthread.h. */
1375 switch_to_thread (ptid_t ptid)
1377 thread_info *thr = find_thread_ptid (ptid);
1378 switch_to_thread (thr);
1382 restore_selected_frame (struct frame_id a_frame_id, int frame_level)
1384 struct frame_info *frame = NULL;
1387 /* This means there was no selected frame. */
1388 if (frame_level == -1)
1390 select_frame (NULL);
1394 gdb_assert (frame_level >= 0);
1396 /* Restore by level first, check if the frame id is the same as
1397 expected. If that fails, try restoring by frame id. If that
1398 fails, nothing to do, just warn the user. */
1400 count = frame_level;
1401 frame = find_relative_frame (get_current_frame (), &count);
1404 /* The frame ids must match - either both valid or both outer_frame_id.
1405 The latter case is not failsafe, but since it's highly unlikely
1406 the search by level finds the wrong frame, it's 99.9(9)% of
1407 the time (for all practical purposes) safe. */
1408 && frame_id_eq (get_frame_id (frame), a_frame_id))
1410 /* Cool, all is fine. */
1411 select_frame (frame);
1415 frame = frame_find_by_id (a_frame_id);
1418 /* Cool, refound it. */
1419 select_frame (frame);
1423 /* Nothing else to do, the frame layout really changed. Select the
1424 innermost stack frame. */
1425 select_frame (get_current_frame ());
1427 /* Warn the user. */
1428 if (frame_level > 0 && !current_uiout->is_mi_like_p ())
1430 warning (_("Couldn't restore frame #%d in "
1431 "current thread. Bottom (innermost) frame selected:"),
1433 /* For MI, we should probably have a notification about
1434 current frame change. But this error is not very
1435 likely, so don't bother for now. */
1436 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
1440 scoped_restore_current_thread::~scoped_restore_current_thread ()
1442 /* If an entry of thread_info was previously selected, it won't be
1443 deleted because we've increased its refcount. The thread represented
1444 by this thread_info entry may have already exited (due to normal exit,
1445 detach, etc), so the thread_info.state is THREAD_EXITED. */
1446 if (m_thread != NULL
1447 /* If the previously selected thread belonged to a process that has
1448 in the mean time exited (or killed, detached, etc.), then don't revert
1449 back to it, but instead simply drop back to no thread selected. */
1451 switch_to_thread (m_thread);
1454 switch_to_no_thread ();
1455 set_current_inferior (m_inf);
1458 /* The running state of the originally selected thread may have
1459 changed, so we have to recheck it here. */
1460 if (inferior_ptid != null_ptid
1462 && m_thread->state == THREAD_STOPPED
1463 && target_has_registers
1465 && target_has_memory)
1466 restore_selected_frame (m_selected_frame_id, m_selected_frame_level);
1468 if (m_thread != NULL)
1469 m_thread->decref ();
1473 scoped_restore_current_thread::scoped_restore_current_thread ()
1476 m_inf = current_inferior ();
1478 if (inferior_ptid != null_ptid)
1480 thread_info *tp = inferior_thread ();
1481 struct frame_info *frame;
1483 m_was_stopped = tp->state == THREAD_STOPPED;
1485 && target_has_registers
1487 && target_has_memory)
1489 /* When processing internal events, there might not be a
1490 selected frame. If we naively call get_selected_frame
1491 here, then we can end up reading debuginfo for the
1492 current frame, but we don't generally need the debuginfo
1494 frame = get_selected_frame_if_set ();
1499 m_selected_frame_id = get_frame_id (frame);
1500 m_selected_frame_level = frame_relative_level (frame);
1509 /* See gdbthread.h. */
1512 show_thread_that_caused_stop (void)
1514 return highest_thread_num > 1;
1517 /* See gdbthread.h. */
1520 show_inferior_qualified_tids (void)
1522 return (inferior_list->next != NULL || inferior_list->num != 1);
1525 /* See gdbthread.h. */
1528 print_thread_id (struct thread_info *thr)
1530 char *s = get_print_cell ();
1532 if (show_inferior_qualified_tids ())
1533 xsnprintf (s, PRINT_CELL_SIZE, "%d.%d", thr->inf->num, thr->per_inf_num);
1535 xsnprintf (s, PRINT_CELL_SIZE, "%d", thr->per_inf_num);
1539 /* If true, tp_array_compar should sort in ascending order, otherwise
1540 in descending order. */
1542 static bool tp_array_compar_ascending;
1544 /* Sort an array for struct thread_info pointers by thread ID (first
1545 by inferior number, and then by per-inferior thread number). The
1546 order is determined by TP_ARRAY_COMPAR_ASCENDING. */
1549 tp_array_compar (const thread_info *a, const thread_info *b)
1551 if (a->inf->num != b->inf->num)
1553 if (tp_array_compar_ascending)
1554 return a->inf->num < b->inf->num;
1556 return a->inf->num > b->inf->num;
1559 if (tp_array_compar_ascending)
1560 return (a->per_inf_num < b->per_inf_num);
1562 return (a->per_inf_num > b->per_inf_num);
1565 /* Apply a GDB command to a list of threads. List syntax is a whitespace
1566 separated list of numbers, or ranges, or the keyword `all'. Ranges consist
1567 of two numbers separated by a hyphen. Examples:
1569 thread apply 1 2 7 4 backtrace Apply backtrace cmd to threads 1,2,7,4
1570 thread apply 2-7 9 p foo(1) Apply p foo(1) cmd to threads 2->7 & 9
1571 thread apply all x/i $pc Apply x/i $pc cmd to all threads. */
1574 thread_apply_all_command (const char *cmd, int from_tty)
1576 tp_array_compar_ascending = false;
1578 && check_for_argument (&cmd, "-ascending", strlen ("-ascending")))
1580 cmd = skip_spaces (cmd);
1581 tp_array_compar_ascending = true;
1584 if (cmd == NULL || *cmd == '\000')
1585 error (_("Please specify a command following the thread ID list"));
1587 update_thread_list ();
1589 int tc = live_threads_count ();
1592 /* Save a copy of the thread list and increment each thread's
1593 refcount while executing the command in the context of each
1594 thread, in case the command is one that wipes threads. E.g.,
1595 detach, kill, disconnect, etc., or even normally continuing
1596 over an inferior or thread exit. */
1597 std::vector<thread_info *> thr_list_cpy;
1598 thr_list_cpy.reserve (tc);
1603 ALL_NON_EXITED_THREADS (tp)
1605 thr_list_cpy.push_back (tp);
1608 gdb_assert (thr_list_cpy.size () == tc);
1611 /* Increment the refcounts, and restore them back on scope
1613 scoped_inc_dec_ref inc_dec_ref (thr_list_cpy);
1615 std::sort (thr_list_cpy.begin (), thr_list_cpy.end (), tp_array_compar);
1617 scoped_restore_current_thread restore_thread;
1619 for (thread_info *thr : thr_list_cpy)
1620 if (thread_alive (thr))
1622 switch_to_thread (thr);
1623 printf_filtered (_("\nThread %s (%s):\n"),
1624 print_thread_id (thr),
1625 target_pid_to_str (inferior_ptid));
1627 execute_command (cmd, from_tty);
1632 /* Implementation of the "thread apply" command. */
1635 thread_apply_command (const char *tidlist, int from_tty)
1637 const char *cmd = NULL;
1638 tid_range_parser parser;
1640 if (tidlist == NULL || *tidlist == '\000')
1641 error (_("Please specify a thread ID list"));
1643 parser.init (tidlist, current_inferior ()->num);
1644 while (!parser.finished ())
1646 int inf_num, thr_start, thr_end;
1648 if (!parser.get_tid_range (&inf_num, &thr_start, &thr_end))
1650 cmd = parser.cur_tok ();
1656 error (_("Please specify a command following the thread ID list"));
1658 if (tidlist == cmd || !isalpha (cmd[0]))
1659 invalid_thread_id_error (cmd);
1661 scoped_restore_current_thread restore_thread;
1663 parser.init (tidlist, current_inferior ()->num);
1664 while (!parser.finished () && parser.cur_tok () < cmd)
1666 struct thread_info *tp = NULL;
1667 struct inferior *inf;
1668 int inf_num, thr_num;
1670 parser.get_tid (&inf_num, &thr_num);
1671 inf = find_inferior_id (inf_num);
1673 tp = find_thread_id (inf, thr_num);
1675 if (parser.in_star_range ())
1679 warning (_("Unknown inferior %d"), inf_num);
1680 parser.skip_range ();
1684 /* No use looking for threads past the highest thread number
1685 the inferior ever had. */
1686 if (thr_num >= inf->highest_thread_num)
1687 parser.skip_range ();
1689 /* Be quiet about unknown threads numbers. */
1696 if (show_inferior_qualified_tids () || parser.tid_is_qualified ())
1697 warning (_("Unknown thread %d.%d"), inf_num, thr_num);
1699 warning (_("Unknown thread %d"), thr_num);
1703 if (!thread_alive (tp))
1705 warning (_("Thread %s has terminated."), print_thread_id (tp));
1709 switch_to_thread (tp);
1711 printf_filtered (_("\nThread %s (%s):\n"), print_thread_id (tp),
1712 target_pid_to_str (inferior_ptid));
1713 execute_command (cmd, from_tty);
1717 /* Switch to the specified thread, or print the current thread. */
1720 thread_command (const char *tidstr, int from_tty)
1724 if (inferior_ptid == null_ptid)
1725 error (_("No thread selected"));
1727 if (target_has_stack)
1729 struct thread_info *tp = inferior_thread ();
1731 if (tp->state == THREAD_EXITED)
1732 printf_filtered (_("[Current thread is %s (%s) (exited)]\n"),
1733 print_thread_id (tp),
1734 target_pid_to_str (inferior_ptid));
1736 printf_filtered (_("[Current thread is %s (%s)]\n"),
1737 print_thread_id (tp),
1738 target_pid_to_str (inferior_ptid));
1741 error (_("No stack."));
1745 ptid_t previous_ptid = inferior_ptid;
1747 thread_select (tidstr, parse_thread_id (tidstr, NULL));
1749 /* Print if the thread has not changed, otherwise an event will
1751 if (inferior_ptid == previous_ptid)
1753 print_selected_thread_frame (current_uiout,
1754 USER_SELECTED_THREAD
1755 | USER_SELECTED_FRAME);
1759 gdb::observers::user_selected_context_changed.notify
1760 (USER_SELECTED_THREAD | USER_SELECTED_FRAME);
1765 /* Implementation of `thread name'. */
1768 thread_name_command (const char *arg, int from_tty)
1770 struct thread_info *info;
1772 if (inferior_ptid == null_ptid)
1773 error (_("No thread selected"));
1775 arg = skip_spaces (arg);
1777 info = inferior_thread ();
1779 info->name = arg ? xstrdup (arg) : NULL;
1782 /* Find thread ids with a name, target pid, or extra info matching ARG. */
1785 thread_find_command (const char *arg, int from_tty)
1787 struct thread_info *tp;
1789 unsigned long match = 0;
1791 if (arg == NULL || *arg == '\0')
1792 error (_("Command requires an argument."));
1794 tmp = re_comp (arg);
1796 error (_("Invalid regexp (%s): %s"), tmp, arg);
1798 update_thread_list ();
1799 for (tp = thread_list; tp; tp = tp->next)
1801 if (tp->name != NULL && re_exec (tp->name))
1803 printf_filtered (_("Thread %s has name '%s'\n"),
1804 print_thread_id (tp), tp->name);
1808 tmp = target_thread_name (tp);
1809 if (tmp != NULL && re_exec (tmp))
1811 printf_filtered (_("Thread %s has target name '%s'\n"),
1812 print_thread_id (tp), tmp);
1816 tmp = target_pid_to_str (tp->ptid);
1817 if (tmp != NULL && re_exec (tmp))
1819 printf_filtered (_("Thread %s has target id '%s'\n"),
1820 print_thread_id (tp), tmp);
1824 tmp = target_extra_thread_info (tp);
1825 if (tmp != NULL && re_exec (tmp))
1827 printf_filtered (_("Thread %s has extra info '%s'\n"),
1828 print_thread_id (tp), tmp);
1833 printf_filtered (_("No threads match '%s'\n"), arg);
1836 /* Print notices when new threads are attached and detached. */
1837 int print_thread_events = 1;
1839 show_print_thread_events (struct ui_file *file, int from_tty,
1840 struct cmd_list_element *c, const char *value)
1842 fprintf_filtered (file,
1843 _("Printing of thread events is %s.\n"),
1847 /* See gdbthread.h. */
1850 thread_select (const char *tidstr, thread_info *tp)
1852 if (!thread_alive (tp))
1853 error (_("Thread ID %s has terminated."), tidstr);
1855 switch_to_thread (tp);
1857 annotate_thread_changed ();
1859 /* Since the current thread may have changed, see if there is any
1860 exited thread we can now delete. */
1864 /* Print thread and frame switch command response. */
1867 print_selected_thread_frame (struct ui_out *uiout,
1868 user_selected_what selection)
1870 struct thread_info *tp = inferior_thread ();
1872 if (selection & USER_SELECTED_THREAD)
1874 if (uiout->is_mi_like_p ())
1876 uiout->field_int ("new-thread-id",
1877 inferior_thread ()->global_num);
1881 uiout->text ("[Switching to thread ");
1882 uiout->field_string ("new-thread-id", print_thread_id (tp));
1884 uiout->text (target_pid_to_str (inferior_ptid));
1889 if (tp->state == THREAD_RUNNING)
1891 if (selection & USER_SELECTED_THREAD)
1892 uiout->text ("(running)\n");
1894 else if (selection & USER_SELECTED_FRAME)
1896 if (selection & USER_SELECTED_THREAD)
1899 if (has_stack_frames ())
1900 print_stack_frame_to_uiout (uiout, get_selected_frame (NULL),
1905 /* Update the 'threads_executing' global based on the threads we know
1909 update_threads_executing (void)
1911 struct thread_info *tp;
1913 threads_executing = 0;
1914 ALL_NON_EXITED_THREADS (tp)
1918 threads_executing = 1;
1925 update_thread_list (void)
1927 target_update_thread_list ();
1928 update_threads_executing ();
1931 /* Return a new value for the selected thread's id. Return a value of
1932 0 if no thread is selected. If GLOBAL is true, return the thread's
1933 global number. Otherwise return the per-inferior number. */
1935 static struct value *
1936 thread_num_make_value_helper (struct gdbarch *gdbarch, int global)
1940 if (inferior_ptid == null_ptid)
1944 thread_info *tp = inferior_thread ();
1946 int_val = tp->global_num;
1948 int_val = tp->per_inf_num;
1951 return value_from_longest (builtin_type (gdbarch)->builtin_int, int_val);
1954 /* Return a new value for the selected thread's per-inferior thread
1955 number. Return a value of 0 if no thread is selected, or no
1958 static struct value *
1959 thread_id_per_inf_num_make_value (struct gdbarch *gdbarch,
1960 struct internalvar *var,
1963 return thread_num_make_value_helper (gdbarch, 0);
1966 /* Return a new value for the selected thread's global id. Return a
1967 value of 0 if no thread is selected, or no threads exist. */
1969 static struct value *
1970 global_thread_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
1973 return thread_num_make_value_helper (gdbarch, 1);
1976 /* Commands with a prefix of `thread'. */
1977 struct cmd_list_element *thread_cmd_list = NULL;
1979 /* Implementation of `thread' variable. */
1981 static const struct internalvar_funcs thread_funcs =
1983 thread_id_per_inf_num_make_value,
1988 /* Implementation of `gthread' variable. */
1990 static const struct internalvar_funcs gthread_funcs =
1992 global_thread_id_make_value,
1998 _initialize_thread (void)
2000 static struct cmd_list_element *thread_apply_list = NULL;
2002 add_info ("threads", info_threads_command,
2003 _("Display currently known threads.\n\
2004 Usage: info threads [-gid] [ID]...\n\
2005 -gid: Show global thread IDs.\n\
2006 If ID is given, it is a space-separated list of IDs of threads to display.\n\
2007 Otherwise, all threads are displayed."));
2009 add_prefix_cmd ("thread", class_run, thread_command, _("\
2010 Use this command to switch between threads.\n\
2011 The new thread ID must be currently known."),
2012 &thread_cmd_list, "thread ", 1, &cmdlist);
2014 add_prefix_cmd ("apply", class_run, thread_apply_command,
2015 _("Apply a command to a list of threads.\n\
2016 Usage: thread apply ID... COMMAND\n\
2017 ID is a space-separated list of IDs of threads to apply COMMAND on."),
2018 &thread_apply_list, "thread apply ", 1, &thread_cmd_list);
2020 add_cmd ("all", class_run, thread_apply_all_command,
2022 Apply a command to all threads.\n\
2024 Usage: thread apply all [-ascending] COMMAND\n\
2025 -ascending: Call COMMAND for all threads in ascending order.\n\
2026 The default is descending order.\
2028 &thread_apply_list);
2030 add_cmd ("name", class_run, thread_name_command,
2031 _("Set the current thread's name.\n\
2032 Usage: thread name [NAME]\n\
2033 If NAME is not given, then any existing name is removed."), &thread_cmd_list);
2035 add_cmd ("find", class_run, thread_find_command, _("\
2036 Find threads that match a regular expression.\n\
2037 Usage: thread find REGEXP\n\
2038 Will display thread ids whose name, target ID, or extra info matches REGEXP."),
2041 add_com_alias ("t", "thread", class_run, 1);
2043 add_setshow_boolean_cmd ("thread-events", no_class,
2044 &print_thread_events, _("\
2045 Set printing of thread events (such as thread start and exit)."), _("\
2046 Show printing of thread events (such as thread start and exit)."), NULL,
2048 show_print_thread_events,
2049 &setprintlist, &showprintlist);
2051 create_internalvar_type_lazy ("_thread", &thread_funcs, NULL);
2052 create_internalvar_type_lazy ("_gthread", >hread_funcs, NULL);