1 /* Multi-process/thread control for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2007, 2008 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 3 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, see <http://www.gnu.org/licenses/>. */
30 #include "gdbthread.h"
31 #include "exceptions.h"
36 #include "gdb_string.h"
39 #include <sys/types.h>
45 /* Definition of struct thread_info exported to gdbthread.h */
47 /* Prototypes for exported functions. */
49 void _initialize_thread (void);
51 /* Prototypes for local functions. */
53 static struct thread_info
*thread_list
= NULL
;
54 static int highest_thread_num
;
56 static struct thread_info
*find_thread_id (int num
);
58 static void thread_command (char *tidstr
, int from_tty
);
59 static void thread_apply_all_command (char *, int);
60 static int thread_alive (struct thread_info
*);
61 static void info_threads_command (char *, int);
62 static void thread_apply_command (char *, int);
63 static void restore_current_thread (ptid_t
);
64 static void prune_threads (void);
67 delete_step_resume_breakpoint (void *arg
)
69 struct breakpoint
**breakpointp
= (struct breakpoint
**) arg
;
70 struct thread_info
*tp
;
72 if (*breakpointp
!= NULL
)
74 delete_breakpoint (*breakpointp
);
75 for (tp
= thread_list
; tp
; tp
= tp
->next
)
76 if (tp
->step_resume_breakpoint
== *breakpointp
)
77 tp
->step_resume_breakpoint
= NULL
;
84 free_thread (struct thread_info
*tp
)
86 /* NOTE: this will take care of any left-over step_resume breakpoints,
87 but not any user-specified thread-specific breakpoints. We can not
88 delete the breakpoint straight-off, because the inferior might not
89 be stopped at the moment. */
90 if (tp
->step_resume_breakpoint
)
91 tp
->step_resume_breakpoint
->disposition
= disp_del_at_next_stop
;
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
)
120 add_thread_silent (ptid_t ptid
)
122 struct thread_info
*tp
;
124 tp
= (struct thread_info
*) xmalloc (sizeof (*tp
));
125 memset (tp
, 0, sizeof (*tp
));
127 tp
->num
= ++highest_thread_num
;
128 tp
->next
= thread_list
;
131 observer_notify_new_thread (tp
);
137 add_thread_with_info (ptid_t ptid
, struct private_thread_info
*private)
139 struct thread_info
*result
= add_thread_silent (ptid
);
141 result
->private = private;
143 if (print_thread_events
)
144 printf_unfiltered (_("[New %s]\n"), target_pid_to_str (ptid
));
146 annotate_new_thread ();
151 add_thread (ptid_t ptid
)
153 return add_thread_with_info (ptid
, NULL
);
157 delete_thread (ptid_t ptid
)
159 struct thread_info
*tp
, *tpprev
;
163 for (tp
= thread_list
; tp
; tpprev
= tp
, tp
= tp
->next
)
164 if (ptid_equal (tp
->ptid
, ptid
))
171 tpprev
->next
= tp
->next
;
173 thread_list
= tp
->next
;
175 observer_notify_thread_exit (tp
);
180 static struct thread_info
*
181 find_thread_id (int num
)
183 struct thread_info
*tp
;
185 for (tp
= thread_list
; tp
; tp
= tp
->next
)
192 /* Find a thread_info by matching PTID. */
194 find_thread_pid (ptid_t ptid
)
196 struct thread_info
*tp
;
198 for (tp
= thread_list
; tp
; tp
= tp
->next
)
199 if (ptid_equal (tp
->ptid
, ptid
))
206 * Thread iterator function.
208 * Calls a callback function once for each thread, so long as
209 * the callback function returns false. If the callback function
210 * returns true, the iteration will end and the current thread
211 * will be returned. This can be useful for implementing a
212 * search for a thread with arbitrary attributes, or for applying
213 * some operation to every thread.
215 * FIXME: some of the existing functionality, such as
216 * "Thread apply all", might be rewritten using this functionality.
220 iterate_over_threads (int (*callback
) (struct thread_info
*, void *),
223 struct thread_info
*tp
;
225 for (tp
= thread_list
; tp
; tp
= tp
->next
)
226 if ((*callback
) (tp
, data
))
233 valid_thread_id (int num
)
235 struct thread_info
*tp
;
237 for (tp
= thread_list
; tp
; tp
= tp
->next
)
245 pid_to_thread_id (ptid_t ptid
)
247 struct thread_info
*tp
;
249 for (tp
= thread_list
; tp
; tp
= tp
->next
)
250 if (ptid_equal (tp
->ptid
, ptid
))
257 thread_id_to_pid (int num
)
259 struct thread_info
*thread
= find_thread_id (num
);
263 return pid_to_ptid (-1);
267 in_thread_list (ptid_t ptid
)
269 struct thread_info
*tp
;
271 for (tp
= thread_list
; tp
; tp
= tp
->next
)
272 if (ptid_equal (tp
->ptid
, ptid
))
275 return 0; /* Never heard of 'im */
278 /* Print a list of thread ids currently known, and the total number of
279 threads. To be used from within catch_errors. */
281 do_captured_list_thread_ids (struct ui_out
*uiout
, void *arg
)
283 struct thread_info
*tp
;
285 struct cleanup
*cleanup_chain
;
288 target_find_new_threads ();
290 cleanup_chain
= make_cleanup_ui_out_tuple_begin_end (uiout
, "thread-ids");
292 for (tp
= thread_list
; tp
; tp
= tp
->next
)
295 ui_out_field_int (uiout
, "thread-id", tp
->num
);
298 do_cleanups (cleanup_chain
);
299 ui_out_field_int (uiout
, "number-of-threads", num
);
303 /* Official gdblib interface function to get a list of thread ids and
306 gdb_list_thread_ids (struct ui_out
*uiout
, char **error_message
)
308 if (catch_exceptions_with_msg (uiout
, do_captured_list_thread_ids
, NULL
,
309 error_message
, RETURN_MASK_ALL
) < 0)
314 /* Load infrun state for the thread PID. */
317 load_infrun_state (ptid_t ptid
,
320 struct breakpoint
**step_resume_breakpoint
,
321 CORE_ADDR
*step_range_start
,
322 CORE_ADDR
*step_range_end
,
323 struct frame_id
*step_frame_id
,
324 int *stepping_over_breakpoint
,
325 int *stepping_through_solib_after_catch
,
326 bpstat
*stepping_through_solib_catchpoints
,
328 struct symtab
**current_symtab
)
330 struct thread_info
*tp
;
332 /* If we can't find the thread, then we're debugging a single threaded
333 process. No need to do anything in that case. */
334 tp
= find_thread_id (pid_to_thread_id (ptid
));
338 *prev_pc
= tp
->prev_pc
;
339 *trap_expected
= tp
->trap_expected
;
340 *step_resume_breakpoint
= tp
->step_resume_breakpoint
;
341 *step_range_start
= tp
->step_range_start
;
342 *step_range_end
= tp
->step_range_end
;
343 *step_frame_id
= tp
->step_frame_id
;
344 *stepping_over_breakpoint
= tp
->stepping_over_breakpoint
;
345 *stepping_through_solib_after_catch
=
346 tp
->stepping_through_solib_after_catch
;
347 *stepping_through_solib_catchpoints
=
348 tp
->stepping_through_solib_catchpoints
;
349 *current_line
= tp
->current_line
;
350 *current_symtab
= tp
->current_symtab
;
353 /* Save infrun state for the thread PID. */
356 save_infrun_state (ptid_t ptid
,
359 struct breakpoint
*step_resume_breakpoint
,
360 CORE_ADDR step_range_start
,
361 CORE_ADDR step_range_end
,
362 const struct frame_id
*step_frame_id
,
363 int stepping_over_breakpoint
,
364 int stepping_through_solib_after_catch
,
365 bpstat stepping_through_solib_catchpoints
,
367 struct symtab
*current_symtab
)
369 struct thread_info
*tp
;
371 /* If we can't find the thread, then we're debugging a single-threaded
372 process. Nothing to do in that case. */
373 tp
= find_thread_id (pid_to_thread_id (ptid
));
377 tp
->prev_pc
= prev_pc
;
378 tp
->trap_expected
= trap_expected
;
379 tp
->step_resume_breakpoint
= step_resume_breakpoint
;
380 tp
->step_range_start
= step_range_start
;
381 tp
->step_range_end
= step_range_end
;
382 tp
->step_frame_id
= (*step_frame_id
);
383 tp
->stepping_over_breakpoint
= stepping_over_breakpoint
;
384 tp
->stepping_through_solib_after_catch
= stepping_through_solib_after_catch
;
385 tp
->stepping_through_solib_catchpoints
= stepping_through_solib_catchpoints
;
386 tp
->current_line
= current_line
;
387 tp
->current_symtab
= current_symtab
;
390 /* Return true if TP is an active thread. */
392 thread_alive (struct thread_info
*tp
)
394 if (PIDGET (tp
->ptid
) == -1)
396 if (!target_thread_alive (tp
->ptid
))
398 tp
->ptid
= pid_to_ptid (-1); /* Mark it as dead */
407 struct thread_info
*tp
, *next
;
409 for (tp
= thread_list
; tp
; tp
= next
)
412 if (!thread_alive (tp
))
413 delete_thread (tp
->ptid
);
417 /* Prints the list of threads and their details on UIOUT.
418 This is a version of 'info_thread_command' suitable for
420 If REQESTED_THREAD is not -1, it's the GDB id of the thread
421 that should be printed. Otherwise, all threads are
424 print_thread_info (struct ui_out
*uiout
, int requested_thread
)
426 struct thread_info
*tp
;
428 struct frame_info
*cur_frame
;
429 struct cleanup
*old_chain
;
430 struct frame_id saved_frame_id
;
432 int current_thread
= -1;
434 /* Backup current thread and selected frame. */
435 saved_frame_id
= get_frame_id (get_selected_frame (NULL
));
436 old_chain
= make_cleanup_restore_current_thread (inferior_ptid
, saved_frame_id
);
438 make_cleanup_ui_out_list_begin_end (uiout
, "threads");
441 target_find_new_threads ();
442 current_ptid
= inferior_ptid
;
443 for (tp
= thread_list
; tp
; tp
= tp
->next
)
445 struct cleanup
*chain2
;
447 if (requested_thread
!= -1 && tp
->num
!= requested_thread
)
450 chain2
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
452 if (ptid_equal (tp
->ptid
, current_ptid
))
454 current_thread
= tp
->num
;
455 ui_out_text (uiout
, "* ");
458 ui_out_text (uiout
, " ");
460 ui_out_field_int (uiout
, "id", tp
->num
);
461 ui_out_text (uiout
, " ");
462 ui_out_field_string (uiout
, "target-id", target_tid_to_str (tp
->ptid
));
464 extra_info
= target_extra_thread_info (tp
);
467 ui_out_text (uiout
, " (");
468 ui_out_field_string (uiout
, "details", extra_info
);
469 ui_out_text (uiout
, ")");
471 ui_out_text (uiout
, " ");
472 /* That switch put us at the top of the stack (leaf frame). */
473 switch_to_thread (tp
->ptid
);
474 print_stack_frame (get_selected_frame (NULL
),
475 /* For MI output, print frame level. */
476 ui_out_is_mi_like_p (uiout
),
479 do_cleanups (chain2
);
482 /* Restores the current thread and the frame selected before
483 the "info threads" command. */
484 do_cleanups (old_chain
);
486 if (requested_thread
== -1)
488 gdb_assert (current_thread
!= -1 || !thread_list
);
489 if (current_thread
!= -1 && ui_out_is_mi_like_p (uiout
))
490 ui_out_field_int (uiout
, "current-thread-id", current_thread
);
493 /* If case we were not able to find the original frame, print the
494 new selected frame. */
495 if (frame_find_by_id (saved_frame_id
) == NULL
)
497 warning (_("Couldn't restore frame in current thread, at frame 0"));
498 /* For MI, we should probably have a notification about
499 current frame change. But this error is not very likely, so
500 don't bother for now. */
501 if (!ui_out_is_mi_like_p (uiout
))
502 print_stack_frame (get_selected_frame (NULL
), 0, LOCATION
);
507 /* Print information about currently known threads
509 * Note: this has the drawback that it _really_ switches
510 * threads, which frees the frame cache. A no-side
511 * effects info-threads command would be nicer.
515 info_threads_command (char *arg
, int from_tty
)
517 print_thread_info (uiout
, -1);
520 /* Switch from one thread to another. */
523 switch_to_thread (ptid_t ptid
)
525 if (ptid_equal (ptid
, inferior_ptid
))
528 inferior_ptid
= ptid
;
529 reinit_frame_cache ();
530 registers_changed ();
531 stop_pc
= read_pc ();
535 restore_current_thread (ptid_t ptid
)
537 if (!ptid_equal (ptid
, inferior_ptid
))
539 switch_to_thread (ptid
);
544 restore_selected_frame (struct frame_id a_frame_id
)
546 struct frame_info
*selected_frame_info
= NULL
;
548 if (frame_id_eq (a_frame_id
, null_frame_id
))
551 if ((selected_frame_info
= frame_find_by_id (a_frame_id
)) != NULL
)
553 select_frame (selected_frame_info
);
557 struct current_thread_cleanup
559 ptid_t inferior_ptid
;
560 struct frame_id selected_frame_id
;
564 do_restore_current_thread_cleanup (void *arg
)
566 struct current_thread_cleanup
*old
= arg
;
567 restore_current_thread (old
->inferior_ptid
);
568 restore_selected_frame (old
->selected_frame_id
);
573 make_cleanup_restore_current_thread (ptid_t inferior_ptid
,
574 struct frame_id a_frame_id
)
576 struct current_thread_cleanup
*old
577 = xmalloc (sizeof (struct current_thread_cleanup
));
578 old
->inferior_ptid
= inferior_ptid
;
579 old
->selected_frame_id
= a_frame_id
;
580 return make_cleanup (do_restore_current_thread_cleanup
, old
);
583 /* Apply a GDB command to a list of threads. List syntax is a whitespace
584 seperated list of numbers, or ranges, or the keyword `all'. Ranges consist
585 of two numbers seperated by a hyphen. Examples:
587 thread apply 1 2 7 4 backtrace Apply backtrace cmd to threads 1,2,7,4
588 thread apply 2-7 9 p foo(1) Apply p foo(1) cmd to threads 2->7 & 9
589 thread apply all p x/i $pc Apply x/i $pc cmd to all threads
593 thread_apply_all_command (char *cmd
, int from_tty
)
595 struct thread_info
*tp
;
596 struct cleanup
*old_chain
;
597 struct cleanup
*saved_cmd_cleanup_chain
;
599 struct frame_id saved_frame_id
;
601 int thread_has_changed
= 0;
603 if (cmd
== NULL
|| *cmd
== '\000')
604 error (_("Please specify a command following the thread ID list"));
606 current_ptid
= inferior_ptid
;
607 saved_frame_id
= get_frame_id (get_selected_frame (NULL
));
608 old_chain
= make_cleanup_restore_current_thread (inferior_ptid
, saved_frame_id
);
610 /* It is safe to update the thread list now, before
611 traversing it for "thread apply all". MVS */
612 target_find_new_threads ();
614 /* Save a copy of the command in case it is clobbered by
616 saved_cmd
= xstrdup (cmd
);
617 saved_cmd_cleanup_chain
= make_cleanup (xfree
, (void *) saved_cmd
);
618 for (tp
= thread_list
; tp
; tp
= tp
->next
)
619 if (thread_alive (tp
))
621 switch_to_thread (tp
->ptid
);
622 printf_filtered (_("\nThread %d (%s):\n"),
623 tp
->num
, target_tid_to_str (inferior_ptid
));
624 execute_command (cmd
, from_tty
);
625 strcpy (cmd
, saved_cmd
); /* Restore exact command used previously */
628 if (!ptid_equal (current_ptid
, inferior_ptid
))
629 thread_has_changed
= 1;
631 do_cleanups (saved_cmd_cleanup_chain
);
632 do_cleanups (old_chain
);
633 /* Print stack frame only if we changed thread. */
634 if (thread_has_changed
)
635 print_stack_frame (get_current_frame (), 1, SRC_LINE
);
640 thread_apply_command (char *tidlist
, int from_tty
)
644 struct cleanup
*old_chain
;
645 struct cleanup
*saved_cmd_cleanup_chain
;
647 struct frame_id saved_frame_id
;
649 int thread_has_changed
= 0;
651 if (tidlist
== NULL
|| *tidlist
== '\000')
652 error (_("Please specify a thread ID list"));
654 for (cmd
= tidlist
; *cmd
!= '\000' && !isalpha (*cmd
); cmd
++);
657 error (_("Please specify a command following the thread ID list"));
659 current_ptid
= inferior_ptid
;
660 saved_frame_id
= get_frame_id (get_selected_frame (NULL
));
661 old_chain
= make_cleanup_restore_current_thread (inferior_ptid
, saved_frame_id
);
663 /* Save a copy of the command in case it is clobbered by
665 saved_cmd
= xstrdup (cmd
);
666 saved_cmd_cleanup_chain
= make_cleanup (xfree
, (void *) saved_cmd
);
667 while (tidlist
< cmd
)
669 struct thread_info
*tp
;
672 start
= strtol (tidlist
, &p
, 10);
674 error (_("Error parsing %s"), tidlist
);
677 while (*tidlist
== ' ' || *tidlist
== '\t')
680 if (*tidlist
== '-') /* Got a range of IDs? */
682 tidlist
++; /* Skip the - */
683 end
= strtol (tidlist
, &p
, 10);
685 error (_("Error parsing %s"), tidlist
);
688 while (*tidlist
== ' ' || *tidlist
== '\t')
694 for (; start
<= end
; start
++)
696 tp
= find_thread_id (start
);
699 warning (_("Unknown thread %d."), start
);
700 else if (!thread_alive (tp
))
701 warning (_("Thread %d has terminated."), start
);
704 switch_to_thread (tp
->ptid
);
705 printf_filtered (_("\nThread %d (%s):\n"), tp
->num
,
706 target_tid_to_str (inferior_ptid
));
707 execute_command (cmd
, from_tty
);
708 strcpy (cmd
, saved_cmd
); /* Restore exact command used previously */
713 if (!ptid_equal (current_ptid
, inferior_ptid
))
714 thread_has_changed
= 1;
716 do_cleanups (saved_cmd_cleanup_chain
);
717 do_cleanups (old_chain
);
718 /* Print stack frame only if we changed thread. */
719 if (thread_has_changed
)
720 print_stack_frame (get_current_frame (), 1, SRC_LINE
);
723 /* Switch to the specified thread. Will dispatch off to thread_apply_command
724 if prefix of arg is `apply'. */
727 thread_command (char *tidstr
, int from_tty
)
731 /* Don't generate an error, just say which thread is current. */
732 if (target_has_stack
)
733 printf_filtered (_("[Current thread is %d (%s)]\n"),
734 pid_to_thread_id (inferior_ptid
),
735 target_tid_to_str (inferior_ptid
));
737 error (_("No stack."));
741 annotate_thread_changed ();
742 gdb_thread_select (uiout
, tidstr
, NULL
);
745 /* Print notices when new threads are attached and detached. */
746 int print_thread_events
= 1;
748 show_print_thread_events (struct ui_file
*file
, int from_tty
,
749 struct cmd_list_element
*c
, const char *value
)
751 fprintf_filtered (file
, _("\
752 Printing of thread events is %s.\n"),
757 do_captured_thread_select (struct ui_out
*uiout
, void *tidstr
)
760 struct thread_info
*tp
;
762 num
= value_as_long (parse_and_eval (tidstr
));
764 tp
= find_thread_id (num
);
767 error (_("Thread ID %d not known."), num
);
769 if (!thread_alive (tp
))
770 error (_("Thread ID %d has terminated."), num
);
772 switch_to_thread (tp
->ptid
);
774 ui_out_text (uiout
, "[Switching to thread ");
775 ui_out_field_int (uiout
, "new-thread-id", pid_to_thread_id (inferior_ptid
));
776 ui_out_text (uiout
, " (");
777 ui_out_text (uiout
, target_tid_to_str (inferior_ptid
));
778 ui_out_text (uiout
, ")]");
780 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
785 gdb_thread_select (struct ui_out
*uiout
, char *tidstr
, char **error_message
)
787 if (catch_exceptions_with_msg (uiout
, do_captured_thread_select
, tidstr
,
788 error_message
, RETURN_MASK_ALL
) < 0)
793 /* Commands with a prefix of `thread'. */
794 struct cmd_list_element
*thread_cmd_list
= NULL
;
797 _initialize_thread (void)
799 static struct cmd_list_element
*thread_apply_list
= NULL
;
801 add_info ("threads", info_threads_command
,
802 _("IDs of currently known threads."));
804 add_prefix_cmd ("thread", class_run
, thread_command
, _("\
805 Use this command to switch between threads.\n\
806 The new thread ID must be currently known."),
807 &thread_cmd_list
, "thread ", 1, &cmdlist
);
809 add_prefix_cmd ("apply", class_run
, thread_apply_command
,
810 _("Apply a command to a list of threads."),
811 &thread_apply_list
, "thread apply ", 1, &thread_cmd_list
);
813 add_cmd ("all", class_run
, thread_apply_all_command
,
814 _("Apply a command to all threads."), &thread_apply_list
);
817 add_com_alias ("t", "thread", class_run
, 1);
819 add_setshow_boolean_cmd ("thread-events", no_class
,
820 &print_thread_events
, _("\
821 Set printing of thread events (such as thread start and exit)."), _("\
822 Show printing of thread events (such as thread start and exit)."), NULL
,
824 show_print_thread_events
,
825 &setprintlist
, &showprintlist
);