1 /* Multi-process/thread control for GDB, the GNU debugger.
3 Copyright (C) 1986-2015 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"
37 #include <sys/types.h>
42 #include "cli/cli-decode.h"
43 #include "gdb_regex.h"
44 #include "cli/cli-utils.h"
45 #include "continuations.h"
47 /* Definition of struct thread_info exported to gdbthread.h. */
49 /* Prototypes for exported functions. */
51 void _initialize_thread (void);
53 /* Prototypes for local functions. */
55 struct thread_info *thread_list = NULL;
56 static int highest_thread_num;
58 /* True if any thread is, or may be executing. We need to track this
59 separately because until we fully sync the thread list, we won't
60 know whether the target is fully stopped, even if we see stop
61 events for all known threads, because any of those threads may have
62 spawned new threads we haven't heard of yet. */
63 static int threads_executing;
65 static void thread_apply_all_command (char *, int);
66 static int thread_alive (struct thread_info *);
67 static void info_threads_command (char *, int);
68 static void thread_apply_command (char *, int);
69 static void restore_current_thread (ptid_t);
71 /* Data to cleanup thread array. */
73 struct thread_array_cleanup
75 /* Array of thread pointers used to set
77 struct thread_info **tp_array;
79 /* Thread count in the array. */
85 inferior_thread (void)
87 struct thread_info *tp = find_thread_ptid (inferior_ptid);
92 /* Delete the breakpoint pointed at by BP_P, if there's one. */
95 delete_thread_breakpoint (struct breakpoint **bp_p)
99 delete_breakpoint (*bp_p);
105 delete_step_resume_breakpoint (struct thread_info *tp)
108 delete_thread_breakpoint (&tp->control.step_resume_breakpoint);
112 delete_exception_resume_breakpoint (struct thread_info *tp)
115 delete_thread_breakpoint (&tp->control.exception_resume_breakpoint);
118 /* See gdbthread.h. */
121 delete_single_step_breakpoints (struct thread_info *tp)
124 delete_thread_breakpoint (&tp->control.single_step_breakpoints);
127 /* Delete the breakpoint pointed at by BP_P at the next stop, if
131 delete_at_next_stop (struct breakpoint **bp)
135 (*bp)->disposition = disp_del_at_next_stop;
140 /* See gdbthread.h. */
143 thread_has_single_step_breakpoints_set (struct thread_info *tp)
145 return tp->control.single_step_breakpoints != NULL;
148 /* See gdbthread.h. */
151 thread_has_single_step_breakpoint_here (struct thread_info *tp,
152 struct address_space *aspace,
155 struct breakpoint *ss_bps = tp->control.single_step_breakpoints;
157 return (ss_bps != NULL
158 && breakpoint_has_location_inserted_here (ss_bps, aspace, addr));
162 clear_thread_inferior_resources (struct thread_info *tp)
164 /* NOTE: this will take care of any left-over step_resume breakpoints,
165 but not any user-specified thread-specific breakpoints. We can not
166 delete the breakpoint straight-off, because the inferior might not
167 be stopped at the moment. */
168 delete_at_next_stop (&tp->control.step_resume_breakpoint);
169 delete_at_next_stop (&tp->control.exception_resume_breakpoint);
170 delete_at_next_stop (&tp->control.single_step_breakpoints);
172 delete_longjmp_breakpoint_at_next_stop (tp->num);
174 bpstat_clear (&tp->control.stop_bpstat);
176 btrace_teardown (tp);
178 do_all_intermediate_continuations_thread (tp, 1);
179 do_all_continuations_thread (tp, 1);
183 free_thread (struct thread_info *tp)
187 if (tp->private_dtor)
188 tp->private_dtor (tp->priv);
198 init_thread_list (void)
200 struct thread_info *tp, *tpnext;
202 highest_thread_num = 0;
207 for (tp = thread_list; tp; tp = tpnext)
214 threads_executing = 0;
217 /* Allocate a new thread with target id PTID and add it to the thread
220 static struct thread_info *
221 new_thread (ptid_t ptid)
223 struct thread_info *tp;
225 tp = xcalloc (1, sizeof (*tp));
228 tp->num = ++highest_thread_num;
229 tp->next = thread_list;
232 /* Nothing to follow yet. */
233 tp->pending_follow.kind = TARGET_WAITKIND_SPURIOUS;
234 tp->state = THREAD_STOPPED;
240 add_thread_silent (ptid_t ptid)
242 struct thread_info *tp;
244 tp = find_thread_ptid (ptid);
246 /* Found an old thread with the same id. It has to be dead,
247 otherwise we wouldn't be adding a new thread with the same id.
248 The OS is reusing this id --- delete it, and recreate a new
251 /* In addition to deleting the thread, if this is the current
252 thread, then we need to take care that delete_thread doesn't
253 really delete the thread if it is inferior_ptid. Create a
254 new template thread in the list with an invalid ptid, switch
255 to it, delete the original thread, reset the new thread's
256 ptid, and switch to it. */
258 if (ptid_equal (inferior_ptid, ptid))
260 tp = new_thread (null_ptid);
262 /* Make switch_to_thread not read from the thread. */
263 tp->state = THREAD_EXITED;
264 switch_to_thread (null_ptid);
266 /* Now we can delete it. */
267 delete_thread (ptid);
269 /* Now reset its ptid, and reswitch inferior_ptid to it. */
271 tp->state = THREAD_STOPPED;
272 switch_to_thread (ptid);
274 observer_notify_new_thread (tp);
280 /* Just go ahead and delete it. */
281 delete_thread (ptid);
284 tp = new_thread (ptid);
285 observer_notify_new_thread (tp);
291 add_thread_with_info (ptid_t ptid, struct private_thread_info *priv)
293 struct thread_info *result = add_thread_silent (ptid);
297 if (print_thread_events)
298 printf_unfiltered (_("[New %s]\n"), target_pid_to_str (ptid));
300 annotate_new_thread ();
305 add_thread (ptid_t ptid)
307 return add_thread_with_info (ptid, NULL);
310 /* Add TP to the end of the step-over chain LIST_P. */
313 step_over_chain_enqueue (struct thread_info **list_p, struct thread_info *tp)
315 gdb_assert (tp->step_over_next == NULL);
316 gdb_assert (tp->step_over_prev == NULL);
321 tp->step_over_prev = tp->step_over_next = tp;
325 struct thread_info *head = *list_p;
326 struct thread_info *tail = head->step_over_prev;
328 tp->step_over_prev = tail;
329 tp->step_over_next = head;
330 head->step_over_prev = tp;
331 tail->step_over_next = tp;
335 /* Remove TP from step-over chain LIST_P. */
338 step_over_chain_remove (struct thread_info **list_p, struct thread_info *tp)
340 gdb_assert (tp->step_over_next != NULL);
341 gdb_assert (tp->step_over_prev != NULL);
345 if (tp == tp->step_over_next)
348 *list_p = tp->step_over_next;
351 tp->step_over_prev->step_over_next = tp->step_over_next;
352 tp->step_over_next->step_over_prev = tp->step_over_prev;
353 tp->step_over_prev = tp->step_over_next = NULL;
356 /* See gdbthread.h. */
359 thread_step_over_chain_next (struct thread_info *tp)
361 struct thread_info *next = tp->step_over_next;
363 return (next == step_over_queue_head ? NULL : next);
366 /* See gdbthread.h. */
369 thread_is_in_step_over_chain (struct thread_info *tp)
371 return (tp->step_over_next != NULL);
374 /* See gdbthread.h. */
377 thread_step_over_chain_enqueue (struct thread_info *tp)
379 step_over_chain_enqueue (&step_over_queue_head, tp);
382 /* See gdbthread.h. */
385 thread_step_over_chain_remove (struct thread_info *tp)
387 step_over_chain_remove (&step_over_queue_head, tp);
390 /* Delete thread PTID. If SILENT, don't notify the observer of this
393 delete_thread_1 (ptid_t ptid, int silent)
395 struct thread_info *tp, *tpprev;
399 for (tp = thread_list; tp; tpprev = tp, tp = tp->next)
400 if (ptid_equal (tp->ptid, ptid))
406 /* Dead threads don't need to step-over. Remove from queue. */
407 if (tp->step_over_next != NULL)
408 thread_step_over_chain_remove (tp);
410 /* If this is the current thread, or there's code out there that
411 relies on it existing (refcount > 0) we can't delete yet. Mark
412 it as exited, and notify it. */
414 || ptid_equal (tp->ptid, inferior_ptid))
416 if (tp->state != THREAD_EXITED)
418 observer_notify_thread_exit (tp, silent);
420 /* Tag it as exited. */
421 tp->state = THREAD_EXITED;
423 /* Clear breakpoints, etc. associated with this thread. */
424 clear_thread_inferior_resources (tp);
427 /* Will be really deleted some other time. */
431 /* Notify thread exit, but only if we haven't already. */
432 if (tp->state != THREAD_EXITED)
433 observer_notify_thread_exit (tp, silent);
435 /* Tag it as exited. */
436 tp->state = THREAD_EXITED;
437 clear_thread_inferior_resources (tp);
440 tpprev->next = tp->next;
442 thread_list = tp->next;
447 /* Delete thread PTID and notify of thread exit. If this is
448 inferior_ptid, don't actually delete it, but tag it as exited and
449 do the notification. If PTID is the user selected thread, clear
452 delete_thread (ptid_t ptid)
454 delete_thread_1 (ptid, 0 /* not silent */);
458 delete_thread_silent (ptid_t ptid)
460 delete_thread_1 (ptid, 1 /* silent */);
464 find_thread_id (int num)
466 struct thread_info *tp;
468 for (tp = thread_list; tp; tp = tp->next)
475 /* Find a thread_info by matching PTID. */
477 find_thread_ptid (ptid_t ptid)
479 struct thread_info *tp;
481 for (tp = thread_list; tp; tp = tp->next)
482 if (ptid_equal (tp->ptid, ptid))
489 * Thread iterator function.
491 * Calls a callback function once for each thread, so long as
492 * the callback function returns false. If the callback function
493 * returns true, the iteration will end and the current thread
494 * will be returned. This can be useful for implementing a
495 * search for a thread with arbitrary attributes, or for applying
496 * some operation to every thread.
498 * FIXME: some of the existing functionality, such as
499 * "Thread apply all", might be rewritten using this functionality.
503 iterate_over_threads (int (*callback) (struct thread_info *, void *),
506 struct thread_info *tp, *next;
508 for (tp = thread_list; tp; tp = next)
511 if ((*callback) (tp, data))
522 struct thread_info *tp;
524 for (tp = thread_list; tp; tp = tp->next)
531 valid_thread_id (int num)
533 struct thread_info *tp;
535 for (tp = thread_list; tp; tp = tp->next)
543 pid_to_thread_id (ptid_t ptid)
545 struct thread_info *tp;
547 for (tp = thread_list; tp; tp = tp->next)
548 if (ptid_equal (tp->ptid, ptid))
555 thread_id_to_pid (int num)
557 struct thread_info *thread = find_thread_id (num);
562 return pid_to_ptid (-1);
566 in_thread_list (ptid_t ptid)
568 struct thread_info *tp;
570 for (tp = thread_list; tp; tp = tp->next)
571 if (ptid_equal (tp->ptid, ptid))
574 return 0; /* Never heard of 'im. */
577 /* Finds the first thread of the inferior given by PID. If PID is -1,
578 return the first thread in the list. */
581 first_thread_of_process (int pid)
583 struct thread_info *tp, *ret = NULL;
585 for (tp = thread_list; tp; tp = tp->next)
586 if (pid == -1 || ptid_get_pid (tp->ptid) == pid)
587 if (ret == NULL || tp->num < ret->num)
594 any_thread_of_process (int pid)
596 struct thread_info *tp;
598 gdb_assert (pid != 0);
600 /* Prefer the current thread. */
601 if (ptid_get_pid (inferior_ptid) == pid)
602 return inferior_thread ();
604 ALL_NON_EXITED_THREADS (tp)
605 if (ptid_get_pid (tp->ptid) == pid)
612 any_live_thread_of_process (int pid)
614 struct thread_info *curr_tp = NULL;
615 struct thread_info *tp;
616 struct thread_info *tp_executing = NULL;
618 gdb_assert (pid != 0);
620 /* Prefer the current thread if it's not executing. */
621 if (ptid_get_pid (inferior_ptid) == pid)
623 /* If the current thread is dead, forget it. If it's not
624 executing, use it. Otherwise, still choose it (below), but
625 only if no other non-executing thread is found. */
626 curr_tp = inferior_thread ();
627 if (curr_tp->state == THREAD_EXITED)
629 else if (!curr_tp->executing)
633 ALL_NON_EXITED_THREADS (tp)
634 if (ptid_get_pid (tp->ptid) == pid)
642 /* If both the current thread and all live threads are executing,
643 prefer the current thread. */
647 /* Otherwise, just return an executing thread, if any. */
651 /* Print a list of thread ids currently known, and the total number of
652 threads. To be used from within catch_errors. */
654 do_captured_list_thread_ids (struct ui_out *uiout, void *arg)
656 struct thread_info *tp;
658 struct cleanup *cleanup_chain;
659 int current_thread = -1;
661 update_thread_list ();
663 cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "thread-ids");
665 for (tp = thread_list; tp; tp = tp->next)
667 if (tp->state == THREAD_EXITED)
670 if (ptid_equal (tp->ptid, inferior_ptid))
671 current_thread = tp->num;
674 ui_out_field_int (uiout, "thread-id", tp->num);
677 do_cleanups (cleanup_chain);
679 if (current_thread != -1)
680 ui_out_field_int (uiout, "current-thread-id", current_thread);
681 ui_out_field_int (uiout, "number-of-threads", num);
685 /* Official gdblib interface function to get a list of thread ids and
688 gdb_list_thread_ids (struct ui_out *uiout, char **error_message)
690 if (catch_exceptions_with_msg (uiout, do_captured_list_thread_ids, NULL,
691 error_message, RETURN_MASK_ALL) < 0)
696 /* Return true if TP is an active thread. */
698 thread_alive (struct thread_info *tp)
700 if (tp->state == THREAD_EXITED)
702 if (!target_thread_alive (tp->ptid))
707 /* See gdbthreads.h. */
712 struct thread_info *tp, *tmp;
714 ALL_THREADS_SAFE (tp, tmp)
716 if (!thread_alive (tp))
717 delete_thread (tp->ptid);
721 /* See gdbthreads.h. */
724 delete_exited_threads (void)
726 struct thread_info *tp, *tmp;
728 ALL_THREADS_SAFE (tp, tmp)
730 if (tp->state == THREAD_EXITED)
731 delete_thread (tp->ptid);
735 /* Disable storing stack temporaries for the thread whose id is
739 disable_thread_stack_temporaries (void *data)
742 struct thread_info *tp = find_thread_ptid (*pd);
746 tp->stack_temporaries_enabled = 0;
747 VEC_free (value_ptr, tp->stack_temporaries);
753 /* Enable storing stack temporaries for thread with id PTID and return a
754 cleanup which can disable and clear the stack temporaries. */
757 enable_thread_stack_temporaries (ptid_t ptid)
759 struct thread_info *tp = find_thread_ptid (ptid);
763 gdb_assert (tp != NULL);
765 tp->stack_temporaries_enabled = 1;
766 tp->stack_temporaries = NULL;
767 data = (ptid_t *) xmalloc (sizeof (ptid_t));
769 c = make_cleanup (disable_thread_stack_temporaries, data);
774 /* Return non-zero value if stack temporaies are enabled for the thread
778 thread_stack_temporaries_enabled_p (ptid_t ptid)
780 struct thread_info *tp = find_thread_ptid (ptid);
785 return tp->stack_temporaries_enabled;
788 /* Push V on to the stack temporaries of the thread with id PTID. */
791 push_thread_stack_temporary (ptid_t ptid, struct value *v)
793 struct thread_info *tp = find_thread_ptid (ptid);
795 gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
796 VEC_safe_push (value_ptr, tp->stack_temporaries, v);
799 /* Return 1 if VAL is among the stack temporaries of the thread
800 with id PTID. Return 0 otherwise. */
803 value_in_thread_stack_temporaries (struct value *val, ptid_t ptid)
805 struct thread_info *tp = find_thread_ptid (ptid);
807 gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
808 if (!VEC_empty (value_ptr, tp->stack_temporaries))
813 for (i = 0; VEC_iterate (value_ptr, tp->stack_temporaries, i, v); i++)
821 /* Return the last of the stack temporaries for thread with id PTID.
822 Return NULL if there are no stack temporaries for the thread. */
825 get_last_thread_stack_temporary (ptid_t ptid)
827 struct value *lastval = NULL;
828 struct thread_info *tp = find_thread_ptid (ptid);
830 gdb_assert (tp != NULL);
831 if (!VEC_empty (value_ptr, tp->stack_temporaries))
832 lastval = VEC_last (value_ptr, tp->stack_temporaries);
838 thread_change_ptid (ptid_t old_ptid, ptid_t new_ptid)
840 struct inferior *inf;
841 struct thread_info *tp;
843 /* It can happen that what we knew as the target inferior id
844 changes. E.g, target remote may only discover the remote process
845 pid after adding the inferior to GDB's list. */
846 inf = find_inferior_ptid (old_ptid);
847 inf->pid = ptid_get_pid (new_ptid);
849 tp = find_thread_ptid (old_ptid);
852 observer_notify_thread_ptid_changed (old_ptid, new_ptid);
856 set_running (ptid_t ptid, int running)
858 struct thread_info *tp;
859 int all = ptid_equal (ptid, minus_one_ptid);
861 /* We try not to notify the observer if no thread has actually changed
862 the running state -- merely to reduce the number of messages to
863 frontend. Frontend is supposed to handle multiple *running just fine. */
864 if (all || ptid_is_pid (ptid))
868 for (tp = thread_list; tp; tp = tp->next)
869 if (all || ptid_get_pid (tp->ptid) == ptid_get_pid (ptid))
871 if (tp->state == THREAD_EXITED)
873 if (running && tp->state == THREAD_STOPPED)
875 tp->state = running ? THREAD_RUNNING : THREAD_STOPPED;
878 observer_notify_target_resumed (ptid);
884 tp = find_thread_ptid (ptid);
886 gdb_assert (tp->state != THREAD_EXITED);
887 if (running && tp->state == THREAD_STOPPED)
889 tp->state = running ? THREAD_RUNNING : THREAD_STOPPED;
891 observer_notify_target_resumed (ptid);
896 is_thread_state (ptid_t ptid, enum thread_state state)
898 struct thread_info *tp;
900 tp = find_thread_ptid (ptid);
902 return tp->state == state;
906 is_stopped (ptid_t ptid)
908 return is_thread_state (ptid, THREAD_STOPPED);
912 is_exited (ptid_t ptid)
914 return is_thread_state (ptid, THREAD_EXITED);
918 is_running (ptid_t ptid)
920 return is_thread_state (ptid, THREAD_RUNNING);
924 is_executing (ptid_t ptid)
926 struct thread_info *tp;
928 tp = find_thread_ptid (ptid);
930 return tp->executing;
934 set_executing (ptid_t ptid, int executing)
936 struct thread_info *tp;
937 int all = ptid_equal (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 tp->executing = executing;
947 tp = find_thread_ptid (ptid);
949 tp->executing = 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 (ptid_equal (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_equal (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 observer_notify_thread_stop_requested (ptid);
995 finish_thread_state (ptid_t ptid)
997 struct thread_info *tp;
1001 all = ptid_equal (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 (tp->executing && tp->state == THREAD_STOPPED)
1013 tp->state = tp->executing ? THREAD_RUNNING : THREAD_STOPPED;
1019 tp = find_thread_ptid (ptid);
1021 if (tp->state != THREAD_EXITED)
1023 if (tp->executing && tp->state == THREAD_STOPPED)
1025 tp->state = tp->executing ? THREAD_RUNNING : THREAD_STOPPED;
1030 observer_notify_target_resumed (ptid);
1034 finish_thread_state_cleanup (void *arg)
1036 ptid_t *ptid_p = arg;
1040 finish_thread_state (*ptid_p);
1044 pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread)
1046 return (pc >= thread->control.step_range_start
1047 && pc < thread->control.step_range_end);
1050 /* Prints the list of threads and their details on UIOUT.
1051 This is a version of 'info_threads_command' suitable for
1053 If REQUESTED_THREAD is not -1, it's the GDB id of the thread
1054 that should be printed. Otherwise, all threads are
1056 If PID is not -1, only print threads from the process PID.
1057 Otherwise, threads from all attached PIDs are printed.
1058 If both REQUESTED_THREAD and PID are not -1, then the thread
1059 is printed if it belongs to the specified process. Otherwise,
1060 an error is raised. */
1062 print_thread_info (struct ui_out *uiout, char *requested_threads, int pid)
1064 struct thread_info *tp;
1065 ptid_t current_ptid;
1066 struct cleanup *old_chain;
1067 char *extra_info, *name, *target_id;
1068 int current_thread = -1;
1070 update_thread_list ();
1071 current_ptid = inferior_ptid;
1073 /* We'll be switching threads temporarily. */
1074 old_chain = make_cleanup_restore_current_thread ();
1076 /* For backward compatibility, we make a list for MI. A table is
1077 preferable for the CLI, though, because it shows table
1079 if (ui_out_is_mi_like_p (uiout))
1080 make_cleanup_ui_out_list_begin_end (uiout, "threads");
1085 for (tp = thread_list; tp; tp = tp->next)
1087 if (!number_is_in_list (requested_threads, tp->num))
1090 if (pid != -1 && ptid_get_pid (tp->ptid) != pid)
1093 if (tp->state == THREAD_EXITED)
1101 if (requested_threads == NULL || *requested_threads == '\0')
1102 ui_out_message (uiout, 0, _("No threads.\n"));
1104 ui_out_message (uiout, 0, _("No threads match '%s'.\n"),
1106 do_cleanups (old_chain);
1110 make_cleanup_ui_out_table_begin_end (uiout, 4, n_threads, "threads");
1112 ui_out_table_header (uiout, 1, ui_left, "current", "");
1113 ui_out_table_header (uiout, 4, ui_left, "id", "Id");
1114 ui_out_table_header (uiout, 17, ui_left, "target-id", "Target Id");
1115 ui_out_table_header (uiout, 1, ui_left, "frame", "Frame");
1116 ui_out_table_body (uiout);
1119 for (tp = thread_list; tp; tp = tp->next)
1121 struct cleanup *chain2;
1124 if (!number_is_in_list (requested_threads, tp->num))
1127 if (pid != -1 && ptid_get_pid (tp->ptid) != pid)
1129 if (requested_threads != NULL && *requested_threads != '\0')
1130 error (_("Requested thread not found in requested process"));
1134 if (ptid_equal (tp->ptid, current_ptid))
1135 current_thread = tp->num;
1137 if (tp->state == THREAD_EXITED)
1140 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
1142 if (ui_out_is_mi_like_p (uiout))
1144 /* Compatibility. */
1145 if (ptid_equal (tp->ptid, current_ptid))
1146 ui_out_text (uiout, "* ");
1148 ui_out_text (uiout, " ");
1152 if (ptid_equal (tp->ptid, current_ptid))
1153 ui_out_field_string (uiout, "current", "*");
1155 ui_out_field_skip (uiout, "current");
1158 ui_out_field_int (uiout, "id", tp->num);
1160 /* For the CLI, we stuff everything into the target-id field.
1161 This is a gross hack to make the output come out looking
1162 correct. The underlying problem here is that ui-out has no
1163 way to specify that a field's space allocation should be
1164 shared by several fields. For MI, we do the right thing
1167 target_id = target_pid_to_str (tp->ptid);
1168 extra_info = target_extra_thread_info (tp);
1169 name = tp->name ? tp->name : target_thread_name (tp);
1171 if (ui_out_is_mi_like_p (uiout))
1173 ui_out_field_string (uiout, "target-id", target_id);
1175 ui_out_field_string (uiout, "details", extra_info);
1177 ui_out_field_string (uiout, "name", name);
1181 struct cleanup *str_cleanup;
1184 if (extra_info && name)
1185 contents = xstrprintf ("%s \"%s\" (%s)", target_id,
1187 else if (extra_info)
1188 contents = xstrprintf ("%s (%s)", target_id, extra_info);
1190 contents = xstrprintf ("%s \"%s\"", target_id, name);
1192 contents = xstrdup (target_id);
1193 str_cleanup = make_cleanup (xfree, contents);
1195 ui_out_field_string (uiout, "target-id", contents);
1196 do_cleanups (str_cleanup);
1199 if (tp->state == THREAD_RUNNING)
1200 ui_out_text (uiout, "(running)\n");
1203 /* The switch below puts us at the top of the stack (leaf
1205 switch_to_thread (tp->ptid);
1206 print_stack_frame (get_selected_frame (NULL),
1207 /* For MI output, print frame level. */
1208 ui_out_is_mi_like_p (uiout),
1212 if (ui_out_is_mi_like_p (uiout))
1214 char *state = "stopped";
1216 if (tp->state == THREAD_RUNNING)
1218 ui_out_field_string (uiout, "state", state);
1221 core = target_core_of_thread (tp->ptid);
1222 if (ui_out_is_mi_like_p (uiout) && core != -1)
1223 ui_out_field_int (uiout, "core", core);
1225 do_cleanups (chain2);
1228 /* Restores the current thread and the frame selected before
1229 the "info threads" command. */
1230 do_cleanups (old_chain);
1232 if (pid == -1 && requested_threads == NULL)
1234 gdb_assert (current_thread != -1
1236 || ptid_equal (inferior_ptid, null_ptid));
1237 if (current_thread != -1 && ui_out_is_mi_like_p (uiout))
1238 ui_out_field_int (uiout, "current-thread-id", current_thread);
1240 if (current_thread != -1 && is_exited (current_ptid))
1241 ui_out_message (uiout, 0, "\n\
1242 The current thread <Thread ID %d> has terminated. See `help thread'.\n",
1244 else if (thread_list
1245 && current_thread == -1
1246 && ptid_equal (current_ptid, null_ptid))
1247 ui_out_message (uiout, 0, "\n\
1248 No selected thread. See `help thread'.\n");
1252 /* Print information about currently known threads
1254 Optional ARG is a thread id, or list of thread ids.
1256 Note: this has the drawback that it _really_ switches
1257 threads, which frees the frame cache. A no-side
1258 effects info-threads command would be nicer. */
1261 info_threads_command (char *arg, int from_tty)
1263 print_thread_info (current_uiout, arg, -1);
1266 /* Switch from one thread to another. */
1269 switch_to_thread (ptid_t ptid)
1271 /* Switch the program space as well, if we can infer it from the now
1272 current thread. Otherwise, it's up to the caller to select the
1274 if (!ptid_equal (ptid, null_ptid))
1276 struct inferior *inf;
1278 inf = find_inferior_ptid (ptid);
1279 gdb_assert (inf != NULL);
1280 set_current_program_space (inf->pspace);
1281 set_current_inferior (inf);
1284 if (ptid_equal (ptid, inferior_ptid))
1287 inferior_ptid = ptid;
1288 reinit_frame_cache ();
1290 /* We don't check for is_stopped, because we're called at times
1291 while in the TARGET_RUNNING state, e.g., while handling an
1293 if (!ptid_equal (inferior_ptid, null_ptid)
1294 && !is_exited (ptid)
1295 && !is_executing (ptid))
1296 stop_pc = regcache_read_pc (get_thread_regcache (ptid));
1298 stop_pc = ~(CORE_ADDR) 0;
1302 restore_current_thread (ptid_t ptid)
1304 switch_to_thread (ptid);
1308 restore_selected_frame (struct frame_id a_frame_id, int frame_level)
1310 struct frame_info *frame = NULL;
1313 /* This means there was no selected frame. */
1314 if (frame_level == -1)
1316 select_frame (NULL);
1320 gdb_assert (frame_level >= 0);
1322 /* Restore by level first, check if the frame id is the same as
1323 expected. If that fails, try restoring by frame id. If that
1324 fails, nothing to do, just warn the user. */
1326 count = frame_level;
1327 frame = find_relative_frame (get_current_frame (), &count);
1330 /* The frame ids must match - either both valid or both outer_frame_id.
1331 The latter case is not failsafe, but since it's highly unlikely
1332 the search by level finds the wrong frame, it's 99.9(9)% of
1333 the time (for all practical purposes) safe. */
1334 && frame_id_eq (get_frame_id (frame), a_frame_id))
1336 /* Cool, all is fine. */
1337 select_frame (frame);
1341 frame = frame_find_by_id (a_frame_id);
1344 /* Cool, refound it. */
1345 select_frame (frame);
1349 /* Nothing else to do, the frame layout really changed. Select the
1350 innermost stack frame. */
1351 select_frame (get_current_frame ());
1353 /* Warn the user. */
1354 if (frame_level > 0 && !ui_out_is_mi_like_p (current_uiout))
1356 warning (_("Couldn't restore frame #%d in "
1357 "current thread. Bottom (innermost) frame selected:"),
1359 /* For MI, we should probably have a notification about
1360 current frame change. But this error is not very
1361 likely, so don't bother for now. */
1362 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
1366 /* Data used by the cleanup installed by
1367 'make_cleanup_restore_current_thread'. */
1369 struct current_thread_cleanup
1371 /* Next in list of currently installed 'struct
1372 current_thread_cleanup' cleanups. See
1373 'current_thread_cleanup_chain' below. */
1374 struct current_thread_cleanup *next;
1376 ptid_t inferior_ptid;
1377 struct frame_id selected_frame_id;
1378 int selected_frame_level;
1384 /* A chain of currently installed 'struct current_thread_cleanup'
1385 cleanups. Restoring the previously selected thread looks up the
1386 old thread in the thread list by ptid. If the thread changes ptid,
1387 we need to update the cleanup's thread structure so the look up
1389 static struct current_thread_cleanup *current_thread_cleanup_chain;
1391 /* A thread_ptid_changed observer. Update all currently installed
1392 current_thread_cleanup cleanups that want to switch back to
1393 OLD_PTID to switch back to NEW_PTID instead. */
1396 restore_current_thread_ptid_changed (ptid_t old_ptid, ptid_t new_ptid)
1398 struct current_thread_cleanup *it;
1400 for (it = current_thread_cleanup_chain; it != NULL; it = it->next)
1402 if (ptid_equal (it->inferior_ptid, old_ptid))
1403 it->inferior_ptid = new_ptid;
1408 do_restore_current_thread_cleanup (void *arg)
1410 struct thread_info *tp;
1411 struct current_thread_cleanup *old = arg;
1413 tp = find_thread_ptid (old->inferior_ptid);
1415 /* If the previously selected thread belonged to a process that has
1416 in the mean time been deleted (due to normal exit, detach, etc.),
1417 then don't revert back to it, but instead simply drop back to no
1420 && find_inferior_ptid (tp->ptid) != NULL)
1421 restore_current_thread (old->inferior_ptid);
1424 restore_current_thread (null_ptid);
1425 set_current_inferior (find_inferior_id (old->inf_id));
1428 /* The running state of the originally selected thread may have
1429 changed, so we have to recheck it here. */
1430 if (!ptid_equal (inferior_ptid, null_ptid)
1432 && is_stopped (inferior_ptid)
1433 && target_has_registers
1435 && target_has_memory)
1436 restore_selected_frame (old->selected_frame_id,
1437 old->selected_frame_level);
1441 restore_current_thread_cleanup_dtor (void *arg)
1443 struct current_thread_cleanup *old = arg;
1444 struct thread_info *tp;
1445 struct inferior *inf;
1447 current_thread_cleanup_chain = current_thread_cleanup_chain->next;
1449 tp = find_thread_ptid (old->inferior_ptid);
1452 inf = find_inferior_id (old->inf_id);
1454 inf->removable = old->was_removable;
1458 /* Set the thread reference count. */
1461 set_thread_refcount (void *data)
1464 struct thread_array_cleanup *ta_cleanup = data;
1466 for (k = 0; k != ta_cleanup->count; k++)
1467 ta_cleanup->tp_array[k]->refcount--;
1471 make_cleanup_restore_current_thread (void)
1473 struct thread_info *tp;
1474 struct frame_info *frame;
1475 struct current_thread_cleanup *old;
1477 old = xmalloc (sizeof (struct current_thread_cleanup));
1478 old->inferior_ptid = inferior_ptid;
1479 old->inf_id = current_inferior ()->num;
1480 old->was_removable = current_inferior ()->removable;
1482 old->next = current_thread_cleanup_chain;
1483 current_thread_cleanup_chain = old;
1485 if (!ptid_equal (inferior_ptid, null_ptid))
1487 old->was_stopped = is_stopped (inferior_ptid);
1488 if (old->was_stopped
1489 && target_has_registers
1491 && target_has_memory)
1493 /* When processing internal events, there might not be a
1494 selected frame. If we naively call get_selected_frame
1495 here, then we can end up reading debuginfo for the
1496 current frame, but we don't generally need the debuginfo
1498 frame = get_selected_frame_if_set ();
1503 old->selected_frame_id = get_frame_id (frame);
1504 old->selected_frame_level = frame_relative_level (frame);
1506 tp = find_thread_ptid (inferior_ptid);
1511 current_inferior ()->removable = 0;
1513 return make_cleanup_dtor (do_restore_current_thread_cleanup, old,
1514 restore_current_thread_cleanup_dtor);
1517 /* If non-zero tp_array_compar should sort in ascending order, otherwise in
1518 descending order. */
1520 static int tp_array_compar_ascending;
1522 /* Sort an array for struct thread_info pointers by their NUM, order is
1523 determined by TP_ARRAY_COMPAR_ASCENDING. */
1526 tp_array_compar (const void *ap_voidp, const void *bp_voidp)
1528 const struct thread_info *const *ap = ap_voidp;
1529 const struct thread_info *const *bp = bp_voidp;
1531 return ((((*ap)->num > (*bp)->num) - ((*ap)->num < (*bp)->num))
1532 * (tp_array_compar_ascending ? +1 : -1));
1535 /* Apply a GDB command to a list of threads. List syntax is a whitespace
1536 seperated list of numbers, or ranges, or the keyword `all'. Ranges consist
1537 of two numbers seperated by a hyphen. Examples:
1539 thread apply 1 2 7 4 backtrace Apply backtrace cmd to threads 1,2,7,4
1540 thread apply 2-7 9 p foo(1) Apply p foo(1) cmd to threads 2->7 & 9
1541 thread apply all p x/i $pc Apply x/i $pc cmd to all threads. */
1544 thread_apply_all_command (char *cmd, int from_tty)
1546 struct cleanup *old_chain;
1549 struct thread_array_cleanup ta_cleanup;
1551 tp_array_compar_ascending = 0;
1553 && check_for_argument (&cmd, "-ascending", strlen ("-ascending")))
1555 cmd = skip_spaces (cmd);
1556 tp_array_compar_ascending = 1;
1559 if (cmd == NULL || *cmd == '\000')
1560 error (_("Please specify a command following the thread ID list"));
1562 update_thread_list ();
1564 old_chain = make_cleanup_restore_current_thread ();
1566 /* Save a copy of the command in case it is clobbered by
1568 saved_cmd = xstrdup (cmd);
1569 make_cleanup (xfree, saved_cmd);
1571 /* Note this includes exited threads. */
1572 tc = thread_count ();
1575 struct thread_info **tp_array;
1576 struct thread_info *tp;
1579 /* Save a copy of the thread_list in case we execute detach
1581 tp_array = xmalloc (sizeof (struct thread_info *) * tc);
1582 make_cleanup (xfree, tp_array);
1584 ALL_NON_EXITED_THREADS (tp)
1590 /* Because we skipped exited threads, we may end up with fewer
1591 threads in the array than the total count of threads. */
1592 gdb_assert (i <= tc);
1595 qsort (tp_array, i, sizeof (*tp_array), tp_array_compar);
1597 ta_cleanup.tp_array = tp_array;
1598 ta_cleanup.count = i;
1599 make_cleanup (set_thread_refcount, &ta_cleanup);
1601 for (k = 0; k != i; k++)
1602 if (thread_alive (tp_array[k]))
1604 switch_to_thread (tp_array[k]->ptid);
1605 printf_filtered (_("\nThread %d (%s):\n"),
1607 target_pid_to_str (inferior_ptid));
1608 execute_command (cmd, from_tty);
1610 /* Restore exact command used previously. */
1611 strcpy (cmd, saved_cmd);
1615 do_cleanups (old_chain);
1619 thread_apply_command (char *tidlist, int from_tty)
1622 struct cleanup *old_chain;
1624 struct get_number_or_range_state state;
1626 if (tidlist == NULL || *tidlist == '\000')
1627 error (_("Please specify a thread ID list"));
1629 for (cmd = tidlist; *cmd != '\000' && !isalpha (*cmd); cmd++);
1632 error (_("Please specify a command following the thread ID list"));
1634 /* Save a copy of the command in case it is clobbered by
1636 saved_cmd = xstrdup (cmd);
1637 old_chain = make_cleanup (xfree, saved_cmd);
1639 init_number_or_range (&state, tidlist);
1640 while (!state.finished && state.string < cmd)
1642 struct thread_info *tp;
1645 start = get_number_or_range (&state);
1647 make_cleanup_restore_current_thread ();
1649 tp = find_thread_id (start);
1652 warning (_("Unknown thread %d."), start);
1653 else if (!thread_alive (tp))
1654 warning (_("Thread %d has terminated."), start);
1657 switch_to_thread (tp->ptid);
1659 printf_filtered (_("\nThread %d (%s):\n"), tp->num,
1660 target_pid_to_str (inferior_ptid));
1661 execute_command (cmd, from_tty);
1663 /* Restore exact command used previously. */
1664 strcpy (cmd, saved_cmd);
1668 do_cleanups (old_chain);
1671 /* Switch to the specified thread. Will dispatch off to thread_apply_command
1672 if prefix of arg is `apply'. */
1675 thread_command (char *tidstr, int from_tty)
1679 if (ptid_equal (inferior_ptid, null_ptid))
1680 error (_("No thread selected"));
1682 if (target_has_stack)
1684 if (is_exited (inferior_ptid))
1685 printf_filtered (_("[Current thread is %d (%s) (exited)]\n"),
1686 pid_to_thread_id (inferior_ptid),
1687 target_pid_to_str (inferior_ptid));
1689 printf_filtered (_("[Current thread is %d (%s)]\n"),
1690 pid_to_thread_id (inferior_ptid),
1691 target_pid_to_str (inferior_ptid));
1694 error (_("No stack."));
1698 gdb_thread_select (current_uiout, tidstr, NULL);
1701 /* Implementation of `thread name'. */
1704 thread_name_command (char *arg, int from_tty)
1706 struct thread_info *info;
1708 if (ptid_equal (inferior_ptid, null_ptid))
1709 error (_("No thread selected"));
1711 arg = skip_spaces (arg);
1713 info = inferior_thread ();
1715 info->name = arg ? xstrdup (arg) : NULL;
1718 /* Find thread ids with a name, target pid, or extra info matching ARG. */
1721 thread_find_command (char *arg, int from_tty)
1723 struct thread_info *tp;
1725 unsigned long match = 0;
1727 if (arg == NULL || *arg == '\0')
1728 error (_("Command requires an argument."));
1730 tmp = re_comp (arg);
1732 error (_("Invalid regexp (%s): %s"), tmp, arg);
1734 update_thread_list ();
1735 for (tp = thread_list; tp; tp = tp->next)
1737 if (tp->name != NULL && re_exec (tp->name))
1739 printf_filtered (_("Thread %d has name '%s'\n"),
1744 tmp = target_thread_name (tp);
1745 if (tmp != NULL && re_exec (tmp))
1747 printf_filtered (_("Thread %d has target name '%s'\n"),
1752 tmp = target_pid_to_str (tp->ptid);
1753 if (tmp != NULL && re_exec (tmp))
1755 printf_filtered (_("Thread %d has target id '%s'\n"),
1760 tmp = target_extra_thread_info (tp);
1761 if (tmp != NULL && re_exec (tmp))
1763 printf_filtered (_("Thread %d has extra info '%s'\n"),
1769 printf_filtered (_("No threads match '%s'\n"), arg);
1772 /* Print notices when new threads are attached and detached. */
1773 int print_thread_events = 1;
1775 show_print_thread_events (struct ui_file *file, int from_tty,
1776 struct cmd_list_element *c, const char *value)
1778 fprintf_filtered (file,
1779 _("Printing of thread events is %s.\n"),
1784 do_captured_thread_select (struct ui_out *uiout, void *tidstr)
1787 struct thread_info *tp;
1789 num = value_as_long (parse_and_eval (tidstr));
1791 tp = find_thread_id (num);
1794 error (_("Thread ID %d not known."), num);
1796 if (!thread_alive (tp))
1797 error (_("Thread ID %d has terminated."), num);
1799 switch_to_thread (tp->ptid);
1801 annotate_thread_changed ();
1803 ui_out_text (uiout, "[Switching to thread ");
1804 ui_out_field_int (uiout, "new-thread-id", pid_to_thread_id (inferior_ptid));
1805 ui_out_text (uiout, " (");
1806 ui_out_text (uiout, target_pid_to_str (inferior_ptid));
1807 ui_out_text (uiout, ")]");
1809 /* Note that we can't reach this with an exited thread, due to the
1810 thread_alive check above. */
1811 if (tp->state == THREAD_RUNNING)
1812 ui_out_text (uiout, "(running)\n");
1815 ui_out_text (uiout, "\n");
1816 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
1819 /* Since the current thread may have changed, see if there is any
1820 exited thread we can now delete. */
1827 gdb_thread_select (struct ui_out *uiout, char *tidstr, char **error_message)
1829 if (catch_exceptions_with_msg (uiout, do_captured_thread_select, tidstr,
1830 error_message, RETURN_MASK_ALL) < 0)
1835 /* Update the 'threads_executing' global based on the threads we know
1839 update_threads_executing (void)
1841 struct thread_info *tp;
1843 threads_executing = 0;
1844 ALL_NON_EXITED_THREADS (tp)
1848 threads_executing = 1;
1855 update_thread_list (void)
1857 target_update_thread_list ();
1858 update_threads_executing ();
1861 /* Return a new value for the selected thread's id. Return a value of 0 if
1862 no thread is selected, or no threads exist. */
1864 static struct value *
1865 thread_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
1868 struct thread_info *tp = find_thread_ptid (inferior_ptid);
1870 return value_from_longest (builtin_type (gdbarch)->builtin_int,
1871 (tp ? tp->num : 0));
1874 /* Commands with a prefix of `thread'. */
1875 struct cmd_list_element *thread_cmd_list = NULL;
1877 /* Implementation of `thread' variable. */
1879 static const struct internalvar_funcs thread_funcs =
1881 thread_id_make_value,
1887 _initialize_thread (void)
1889 static struct cmd_list_element *thread_apply_list = NULL;
1891 add_info ("threads", info_threads_command,
1892 _("Display currently known threads.\n\
1893 Usage: info threads [ID]...\n\
1894 Optional arguments are thread IDs with spaces between.\n\
1895 If no arguments, all threads are displayed."));
1897 add_prefix_cmd ("thread", class_run, thread_command, _("\
1898 Use this command to switch between threads.\n\
1899 The new thread ID must be currently known."),
1900 &thread_cmd_list, "thread ", 1, &cmdlist);
1902 add_prefix_cmd ("apply", class_run, thread_apply_command,
1903 _("Apply a command to a list of threads."),
1904 &thread_apply_list, "thread apply ", 1, &thread_cmd_list);
1906 add_cmd ("all", class_run, thread_apply_all_command,
1908 Apply a command to all threads.\n\
1910 Usage: thread apply all [-ascending] <command>\n\
1911 -ascending: Call <command> for all threads in ascending order.\n\
1912 The default is descending order.\
1914 &thread_apply_list);
1916 add_cmd ("name", class_run, thread_name_command,
1917 _("Set the current thread's name.\n\
1918 Usage: thread name [NAME]\n\
1919 If NAME is not given, then any existing name is removed."), &thread_cmd_list);
1921 add_cmd ("find", class_run, thread_find_command, _("\
1922 Find threads that match a regular expression.\n\
1923 Usage: thread find REGEXP\n\
1924 Will display thread ids whose name, target ID, or extra info matches REGEXP."),
1927 add_com_alias ("t", "thread", class_run, 1);
1929 add_setshow_boolean_cmd ("thread-events", no_class,
1930 &print_thread_events, _("\
1931 Set printing of thread events (such as thread start and exit)."), _("\
1932 Show printing of thread events (such as thread start and exit)."), NULL,
1934 show_print_thread_events,
1935 &setprintlist, &showprintlist);
1937 create_internalvar_type_lazy ("_thread", &thread_funcs, NULL);
1939 observer_attach_thread_ptid_changed (restore_current_thread_ptid_changed);