1 /* Multi-process/thread control for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
6 Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
32 #include "gdbthread.h"
37 #include "gdb_string.h"
40 #include <sys/types.h>
44 /*#include "lynxos-core.h" */
46 /* Definition of struct thread_info exported to gdbthread.h */
48 /* Prototypes for exported functions. */
50 void _initialize_thread (void);
52 /* Prototypes for local functions. */
54 static struct thread_info *thread_list = NULL;
55 static int highest_thread_num;
57 static struct thread_info *find_thread_id (int num);
59 static void thread_command (char *tidstr, int from_tty);
60 static void thread_apply_all_command (char *, int);
61 static int thread_alive (struct thread_info *);
62 static void info_threads_command (char *, int);
63 static void thread_apply_command (char *, int);
64 static void restore_current_thread (ptid_t);
65 static void switch_to_thread (ptid_t ptid);
66 static void prune_threads (void);
69 delete_step_resume_breakpoint (void *arg)
71 struct breakpoint **breakpointp = (struct breakpoint **) arg;
72 struct thread_info *tp;
74 if (*breakpointp != NULL)
76 delete_breakpoint (*breakpointp);
77 for (tp = thread_list; tp; tp = tp->next)
78 if (tp->step_resume_breakpoint == *breakpointp)
79 tp->step_resume_breakpoint = NULL;
86 free_thread (struct thread_info *tp)
88 /* NOTE: this will take care of any left-over step_resume breakpoints,
89 but not any user-specified thread-specific breakpoints. */
90 if (tp->step_resume_breakpoint)
91 delete_breakpoint (tp->step_resume_breakpoint);
93 /* FIXME: do I ever need to call the back-end to give it a
94 chance at this private data before deleting the thread? */
102 init_thread_list (void)
104 struct thread_info *tp, *tpnext;
106 highest_thread_num = 0;
110 for (tp = thread_list; tp; tp = tpnext)
119 /* add_thread now returns a pointer to the new thread_info,
120 so that back_ends can initialize their private data. */
123 add_thread (ptid_t ptid)
125 struct thread_info *tp;
127 tp = (struct thread_info *) xmalloc (sizeof (*tp));
128 memset (tp, 0, sizeof (*tp));
130 tp->num = ++highest_thread_num;
131 tp->next = thread_list;
137 delete_thread (ptid_t ptid)
139 struct thread_info *tp, *tpprev;
143 for (tp = thread_list; tp; tpprev = tp, tp = tp->next)
144 if (ptid_equal (tp->ptid, ptid))
151 tpprev->next = tp->next;
153 thread_list = tp->next;
158 static struct thread_info *
159 find_thread_id (int num)
161 struct thread_info *tp;
163 for (tp = thread_list; tp; tp = tp->next)
170 /* Find a thread_info by matching PTID. */
172 find_thread_pid (ptid_t ptid)
174 struct thread_info *tp;
176 for (tp = thread_list; tp; tp = tp->next)
177 if (ptid_equal (tp->ptid, ptid))
184 * Thread iterator function.
186 * Calls a callback function once for each thread, so long as
187 * the callback function returns false. If the callback function
188 * returns true, the iteration will end and the current thread
189 * will be returned. This can be useful for implementing a
190 * search for a thread with arbitrary attributes, or for applying
191 * some operation to every thread.
193 * FIXME: some of the existing functionality, such as
194 * "Thread apply all", might be rewritten using this functionality.
198 iterate_over_threads (int (*callback) (struct thread_info *, void *),
201 struct thread_info *tp;
203 for (tp = thread_list; tp; tp = tp->next)
204 if ((*callback) (tp, data))
211 valid_thread_id (int num)
213 struct thread_info *tp;
215 for (tp = thread_list; tp; tp = tp->next)
223 pid_to_thread_id (ptid_t ptid)
225 struct thread_info *tp;
227 for (tp = thread_list; tp; tp = tp->next)
228 if (ptid_equal (tp->ptid, ptid))
235 thread_id_to_pid (int num)
237 struct thread_info *thread = find_thread_id (num);
241 return pid_to_ptid (-1);
245 in_thread_list (ptid_t ptid)
247 struct thread_info *tp;
249 for (tp = thread_list; tp; tp = tp->next)
250 if (ptid_equal (tp->ptid, ptid))
253 return 0; /* Never heard of 'im */
256 /* Print a list of thread ids currently known, and the total number of
257 threads. To be used from within catch_errors. */
259 do_captured_list_thread_ids (struct ui_out *uiout, void *arg)
261 struct thread_info *tp;
263 struct cleanup *cleanup_chain;
266 target_find_new_threads ();
268 cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "thread-ids");
270 for (tp = thread_list; tp; tp = tp->next)
273 ui_out_field_int (uiout, "thread-id", tp->num);
276 do_cleanups (cleanup_chain);
277 ui_out_field_int (uiout, "number-of-threads", num);
281 /* Official gdblib interface function to get a list of thread ids and
284 gdb_list_thread_ids (struct ui_out *uiout)
286 return catch_exceptions (uiout, do_captured_list_thread_ids, NULL,
287 NULL, RETURN_MASK_ALL);
290 /* Load infrun state for the thread PID. */
293 load_infrun_state (ptid_t ptid,
295 CORE_ADDR *prev_func_start,
296 char **prev_func_name,
298 struct breakpoint **step_resume_breakpoint,
299 struct breakpoint **through_sigtramp_breakpoint,
300 CORE_ADDR *step_range_start,
301 CORE_ADDR *step_range_end,
302 struct frame_id *step_frame_id,
303 int *handling_longjmp,
305 int *stepping_through_solib_after_catch,
306 bpstat *stepping_through_solib_catchpoints,
307 int *stepping_through_sigtramp,
309 struct symtab **current_symtab, CORE_ADDR *step_sp)
311 struct thread_info *tp;
313 /* If we can't find the thread, then we're debugging a single threaded
314 process. No need to do anything in that case. */
315 tp = find_thread_id (pid_to_thread_id (ptid));
319 *prev_pc = tp->prev_pc;
320 *prev_func_start = tp->prev_func_start;
321 *prev_func_name = tp->prev_func_name;
322 *trap_expected = tp->trap_expected;
323 *step_resume_breakpoint = tp->step_resume_breakpoint;
324 *through_sigtramp_breakpoint = tp->through_sigtramp_breakpoint;
325 *step_range_start = tp->step_range_start;
326 *step_range_end = tp->step_range_end;
327 *step_frame_id = tp->step_frame_id;
328 *handling_longjmp = tp->handling_longjmp;
329 *another_trap = tp->another_trap;
330 *stepping_through_solib_after_catch =
331 tp->stepping_through_solib_after_catch;
332 *stepping_through_solib_catchpoints =
333 tp->stepping_through_solib_catchpoints;
334 *stepping_through_sigtramp = tp->stepping_through_sigtramp;
335 *current_line = tp->current_line;
336 *current_symtab = tp->current_symtab;
337 *step_sp = tp->step_sp;
340 /* Save infrun state for the thread PID. */
343 save_infrun_state (ptid_t ptid,
345 CORE_ADDR prev_func_start,
346 char *prev_func_name,
348 struct breakpoint *step_resume_breakpoint,
349 struct breakpoint *through_sigtramp_breakpoint,
350 CORE_ADDR step_range_start,
351 CORE_ADDR step_range_end,
352 const struct frame_id *step_frame_id,
353 int handling_longjmp,
355 int stepping_through_solib_after_catch,
356 bpstat stepping_through_solib_catchpoints,
357 int stepping_through_sigtramp,
359 struct symtab *current_symtab, CORE_ADDR step_sp)
361 struct thread_info *tp;
363 /* If we can't find the thread, then we're debugging a single-threaded
364 process. Nothing to do in that case. */
365 tp = find_thread_id (pid_to_thread_id (ptid));
369 tp->prev_pc = prev_pc;
370 tp->prev_func_start = prev_func_start;
371 tp->prev_func_name = prev_func_name;
372 tp->trap_expected = trap_expected;
373 tp->step_resume_breakpoint = step_resume_breakpoint;
374 tp->through_sigtramp_breakpoint = through_sigtramp_breakpoint;
375 tp->step_range_start = step_range_start;
376 tp->step_range_end = step_range_end;
377 tp->step_frame_id = (*step_frame_id);
378 tp->handling_longjmp = handling_longjmp;
379 tp->another_trap = another_trap;
380 tp->stepping_through_solib_after_catch = stepping_through_solib_after_catch;
381 tp->stepping_through_solib_catchpoints = stepping_through_solib_catchpoints;
382 tp->stepping_through_sigtramp = stepping_through_sigtramp;
383 tp->current_line = current_line;
384 tp->current_symtab = current_symtab;
385 tp->step_sp = step_sp;
388 /* Return true if TP is an active thread. */
390 thread_alive (struct thread_info *tp)
392 if (PIDGET (tp->ptid) == -1)
394 if (!target_thread_alive (tp->ptid))
396 tp->ptid = pid_to_ptid (-1); /* Mark it as dead */
405 struct thread_info *tp, *next;
407 for (tp = thread_list; tp; tp = next)
410 if (!thread_alive (tp))
411 delete_thread (tp->ptid);
415 /* Print information about currently known threads
417 * Note: this has the drawback that it _really_ switches
418 * threads, which frees the frame cache. A no-side
419 * effects info-threads command would be nicer.
423 info_threads_command (char *arg, int from_tty)
425 struct thread_info *tp;
427 struct frame_info *cur_frame;
428 int saved_frame_level = frame_relative_level (deprecated_selected_frame);
432 /* Avoid coredumps which would happen if we tried to access a NULL
433 deprecated_selected_frame. */
434 if (!target_has_stack)
438 target_find_new_threads ();
439 current_ptid = inferior_ptid;
440 for (tp = thread_list; tp; tp = tp->next)
442 if (ptid_equal (tp->ptid, current_ptid))
443 printf_filtered ("* ");
445 printf_filtered (" ");
448 printf_filtered ("%d %s", tp->num, target_tid_to_str (tp->ptid));
450 printf_filtered ("%d %s", tp->num, target_pid_to_str (tp->ptid));
453 extra_info = target_extra_thread_info (tp);
455 printf_filtered (" (%s)", extra_info);
458 switch_to_thread (tp->ptid);
459 if (deprecated_selected_frame)
460 print_stack_frame (deprecated_selected_frame, -1, 0);
462 printf_filtered ("[No stack.]\n");
465 switch_to_thread (current_ptid);
467 /* Code below copied from "up_silently_base" in "stack.c".
468 * It restores the frame set by the user before the "info threads"
469 * command. We have finished the info-threads display by switching
470 * back to the current thread. That switch has put us at the top
471 * of the stack (leaf frame).
473 counter = saved_frame_level;
474 cur_frame = find_relative_frame (deprecated_selected_frame, &counter);
477 /* Ooops, can't restore, tell user where we are. */
478 warning ("Couldn't restore frame in current thread, at frame 0");
479 print_stack_frame (deprecated_selected_frame, -1, 0);
483 select_frame (cur_frame);
486 /* re-show current frame. */
487 show_stack_frame (cur_frame);
490 /* Switch from one thread to another. */
493 switch_to_thread (ptid_t ptid)
495 if (ptid_equal (ptid, inferior_ptid))
498 inferior_ptid = ptid;
499 flush_cached_frames ();
500 registers_changed ();
501 stop_pc = read_pc ();
502 select_frame (get_current_frame ());
506 restore_current_thread (ptid_t ptid)
508 if (!ptid_equal (ptid, inferior_ptid))
510 switch_to_thread (ptid);
511 print_stack_frame (get_current_frame (), 0, -1);
515 struct current_thread_cleanup
517 ptid_t inferior_ptid;
521 do_restore_current_thread_cleanup (void *arg)
523 struct current_thread_cleanup *old = arg;
524 restore_current_thread (old->inferior_ptid);
528 static struct cleanup *
529 make_cleanup_restore_current_thread (ptid_t inferior_ptid)
531 struct current_thread_cleanup *old
532 = xmalloc (sizeof (struct current_thread_cleanup));
533 old->inferior_ptid = inferior_ptid;
534 return make_cleanup (do_restore_current_thread_cleanup, old);
537 /* Apply a GDB command to a list of threads. List syntax is a whitespace
538 seperated list of numbers, or ranges, or the keyword `all'. Ranges consist
539 of two numbers seperated by a hyphen. Examples:
541 thread apply 1 2 7 4 backtrace Apply backtrace cmd to threads 1,2,7,4
542 thread apply 2-7 9 p foo(1) Apply p foo(1) cmd to threads 2->7 & 9
543 thread apply all p x/i $pc Apply x/i $pc cmd to all threads
547 thread_apply_all_command (char *cmd, int from_tty)
549 struct thread_info *tp;
550 struct cleanup *old_chain;
551 struct cleanup *saved_cmd_cleanup_chain;
554 if (cmd == NULL || *cmd == '\000')
555 error ("Please specify a command following the thread ID list");
557 old_chain = make_cleanup_restore_current_thread (inferior_ptid);
559 /* It is safe to update the thread list now, before
560 traversing it for "thread apply all". MVS */
561 target_find_new_threads ();
563 /* Save a copy of the command in case it is clobbered by
565 saved_cmd = xstrdup (cmd);
566 saved_cmd_cleanup_chain = make_cleanup (xfree, (void *) saved_cmd);
567 for (tp = thread_list; tp; tp = tp->next)
568 if (thread_alive (tp))
570 switch_to_thread (tp->ptid);
572 printf_filtered ("\nThread %d (%s):\n",
573 tp->num, target_tid_to_str (inferior_ptid));
575 printf_filtered ("\nThread %d (%s):\n", tp->num,
576 target_pid_to_str (inferior_ptid));
578 execute_command (cmd, from_tty);
579 strcpy (cmd, saved_cmd); /* Restore exact command used previously */
582 do_cleanups (saved_cmd_cleanup_chain);
583 do_cleanups (old_chain);
587 thread_apply_command (char *tidlist, int from_tty)
591 struct cleanup *old_chain;
592 struct cleanup *saved_cmd_cleanup_chain;
595 if (tidlist == NULL || *tidlist == '\000')
596 error ("Please specify a thread ID list");
598 for (cmd = tidlist; *cmd != '\000' && !isalpha (*cmd); cmd++);
601 error ("Please specify a command following the thread ID list");
603 old_chain = make_cleanup_restore_current_thread (inferior_ptid);
605 /* Save a copy of the command in case it is clobbered by
607 saved_cmd = xstrdup (cmd);
608 saved_cmd_cleanup_chain = make_cleanup (xfree, (void *) saved_cmd);
609 while (tidlist < cmd)
611 struct thread_info *tp;
614 start = strtol (tidlist, &p, 10);
616 error ("Error parsing %s", tidlist);
619 while (*tidlist == ' ' || *tidlist == '\t')
622 if (*tidlist == '-') /* Got a range of IDs? */
624 tidlist++; /* Skip the - */
625 end = strtol (tidlist, &p, 10);
627 error ("Error parsing %s", tidlist);
630 while (*tidlist == ' ' || *tidlist == '\t')
636 for (; start <= end; start++)
638 tp = find_thread_id (start);
641 warning ("Unknown thread %d.", start);
642 else if (!thread_alive (tp))
643 warning ("Thread %d has terminated.", start);
646 switch_to_thread (tp->ptid);
648 printf_filtered ("\nThread %d (%s):\n", tp->num,
649 target_tid_to_str (inferior_ptid));
651 printf_filtered ("\nThread %d (%s):\n", tp->num,
652 target_pid_to_str (inferior_ptid));
654 execute_command (cmd, from_tty);
655 strcpy (cmd, saved_cmd); /* Restore exact command used previously */
660 do_cleanups (saved_cmd_cleanup_chain);
661 do_cleanups (old_chain);
664 /* Switch to the specified thread. Will dispatch off to thread_apply_command
665 if prefix of arg is `apply'. */
668 thread_command (char *tidstr, int from_tty)
672 /* Don't generate an error, just say which thread is current. */
673 if (target_has_stack)
674 printf_filtered ("[Current thread is %d (%s)]\n",
675 pid_to_thread_id (inferior_ptid),
676 #if defined(HPUXHPPA)
677 target_tid_to_str (inferior_ptid)
679 target_pid_to_str (inferior_ptid)
687 gdb_thread_select (uiout, tidstr);
691 do_captured_thread_select (struct ui_out *uiout, void *tidstr)
694 struct thread_info *tp;
696 num = value_as_long (parse_and_eval (tidstr));
698 tp = find_thread_id (num);
701 error ("Thread ID %d not known.", num);
703 if (!thread_alive (tp))
704 error ("Thread ID %d has terminated.\n", num);
706 switch_to_thread (tp->ptid);
708 ui_out_text (uiout, "[Switching to thread ");
709 ui_out_field_int (uiout, "new-thread-id", pid_to_thread_id (inferior_ptid));
710 ui_out_text (uiout, " (");
711 #if defined(HPUXHPPA)
712 ui_out_text (uiout, target_tid_to_str (inferior_ptid));
714 ui_out_text (uiout, target_pid_to_str (inferior_ptid));
716 ui_out_text (uiout, ")]");
718 print_stack_frame (deprecated_selected_frame,
719 frame_relative_level (deprecated_selected_frame), 1);
724 gdb_thread_select (struct ui_out *uiout, char *tidstr)
726 return catch_exceptions (uiout, do_captured_thread_select, tidstr,
727 NULL, RETURN_MASK_ALL);
730 /* Commands with a prefix of `thread'. */
731 struct cmd_list_element *thread_cmd_list = NULL;
734 _initialize_thread (void)
736 static struct cmd_list_element *thread_apply_list = NULL;
738 add_info ("threads", info_threads_command,
739 "IDs of currently known threads.");
741 add_prefix_cmd ("thread", class_run, thread_command,
742 "Use this command to switch between threads.\n\
743 The new thread ID must be currently known.", &thread_cmd_list, "thread ", 1, &cmdlist);
745 add_prefix_cmd ("apply", class_run, thread_apply_command,
746 "Apply a command to a list of threads.",
747 &thread_apply_list, "apply ", 1, &thread_cmd_list);
749 add_cmd ("all", class_run, thread_apply_all_command,
750 "Apply a command to all threads.", &thread_apply_list);
753 add_com_alias ("t", "thread", class_run, 1);