00c6467f254b54958560155bd9b2360cb5fabafb
[binutils-gdb.git] / gdb / thread.c
1 /* Multi-process/thread control for GDB, the GNU debugger.
2 Copyright 1986, 1987, 1988, 1993, 1998, 1999, 2000
3
4 Contributed by Lynx Real-Time Systems, Inc. Los Gatos, CA.
5 Free Software Foundation, Inc.
6
7 This file is part of GDB.
8
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 2 of the License, or
12 (at your option) any later version.
13
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.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
23
24 #include "defs.h"
25 #include "symtab.h"
26 #include "frame.h"
27 #include "inferior.h"
28 #include "environ.h"
29 #include "value.h"
30 #include "target.h"
31 #include "gdbthread.h"
32 #include "command.h"
33 #include "gdbcmd.h"
34
35 #include <ctype.h>
36 #include <sys/types.h>
37 #include <signal.h>
38 #ifdef UI_OUT
39 #include "ui-out.h"
40 #endif
41
42 /*#include "lynxos-core.h" */
43
44 /* Definition of struct thread_info exported to gdbthread.h */
45
46 /* Prototypes for exported functions. */
47
48 void _initialize_thread (void);
49
50 /* Prototypes for local functions. */
51
52 static struct thread_info *thread_list = NULL;
53 static int highest_thread_num;
54
55 static struct thread_info *find_thread_id (int num);
56
57 static void thread_command (char *tidstr, int from_tty);
58 static void thread_apply_all_command (char *, int);
59 static int thread_alive (struct thread_info *);
60 static void info_threads_command (char *, int);
61 static void thread_apply_command (char *, int);
62 static void restore_current_thread (int);
63 static void switch_to_thread (int pid);
64 static void prune_threads (void);
65
66 static void
67 free_thread (struct thread_info *tp)
68 {
69 /* NOTE: this will take care of any left-over step_resume breakpoints,
70 but not any user-specified thread-specific breakpoints. */
71 if (tp->step_resume_breakpoint)
72 delete_breakpoint (tp->step_resume_breakpoint);
73
74 /* FIXME: do I ever need to call the back-end to give it a
75 chance at this private data before deleting the thread? */
76 if (tp->private)
77 free (tp->private);
78
79 free (tp);
80 }
81
82 void
83 init_thread_list ()
84 {
85 struct thread_info *tp, *tpnext;
86
87 highest_thread_num = 0;
88 if (!thread_list)
89 return;
90
91 for (tp = thread_list; tp; tp = tpnext)
92 {
93 tpnext = tp->next;
94 free_thread (tp);
95 }
96
97 thread_list = NULL;
98 }
99
100 /* add_thread now returns a pointer to the new thread_info,
101 so that back_ends can initialize their private data. */
102
103 struct thread_info *
104 add_thread (pid)
105 int pid;
106 {
107 struct thread_info *tp;
108
109 tp = (struct thread_info *) xmalloc (sizeof (struct thread_info));
110
111 tp->pid = pid;
112 tp->num = ++highest_thread_num;
113 tp->prev_pc = 0;
114 tp->prev_func_start = 0;
115 tp->prev_func_name = NULL;
116 tp->step_range_start = 0;
117 tp->step_range_end = 0;
118 tp->step_frame_address = 0;
119 tp->step_resume_breakpoint = 0;
120 tp->through_sigtramp_breakpoint = 0;
121 tp->handling_longjmp = 0;
122 tp->trap_expected = 0;
123 tp->another_trap = 0;
124 tp->stepping_through_solib_after_catch = 0;
125 tp->stepping_through_solib_catchpoints = NULL;
126 tp->stepping_through_sigtramp = 0;
127 tp->next = thread_list;
128 tp->private = NULL;
129 thread_list = tp;
130 return tp;
131 }
132
133 void
134 delete_thread (pid)
135 int pid;
136 {
137 struct thread_info *tp, *tpprev;
138
139 tpprev = NULL;
140
141 for (tp = thread_list; tp; tpprev = tp, tp = tp->next)
142 if (tp->pid == pid)
143 break;
144
145 if (!tp)
146 return;
147
148 if (tpprev)
149 tpprev->next = tp->next;
150 else
151 thread_list = tp->next;
152
153 free_thread (tp);
154 }
155
156 static struct thread_info *
157 find_thread_id (num)
158 int num;
159 {
160 struct thread_info *tp;
161
162 for (tp = thread_list; tp; tp = tp->next)
163 if (tp->num == num)
164 return tp;
165
166 return NULL;
167 }
168
169 /* Find a thread_info by matching 'pid'. */
170 struct thread_info *
171 find_thread_pid (pid)
172 int pid;
173 {
174 struct thread_info *tp;
175
176 for (tp = thread_list; tp; tp = tp->next)
177 if (tp->pid == pid)
178 return tp;
179
180 return NULL;
181 }
182
183 /*
184 * Thread iterator function.
185 *
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.
192 *
193 * FIXME: some of the existing functionality, such as
194 * "Thread apply all", might be rewritten using this functionality.
195 */
196
197 struct thread_info *
198 iterate_over_threads (callback, data)
199 int (*callback) ();
200 void *data;
201 {
202 struct thread_info *tp;
203
204 for (tp = thread_list; tp; tp = tp->next)
205 if ((*callback) (tp, data))
206 return tp;
207
208 return NULL;
209 }
210
211 int
212 valid_thread_id (num)
213 int num;
214 {
215 struct thread_info *tp;
216
217 for (tp = thread_list; tp; tp = tp->next)
218 if (tp->num == num)
219 return 1;
220
221 return 0;
222 }
223
224 int
225 pid_to_thread_id (pid)
226 int pid;
227 {
228 struct thread_info *tp;
229
230 for (tp = thread_list; tp; tp = tp->next)
231 if (tp->pid == pid)
232 return tp->num;
233
234 return 0;
235 }
236
237 int
238 thread_id_to_pid (num)
239 int num;
240 {
241 struct thread_info *thread = find_thread_id (num);
242 if (thread)
243 return thread->pid;
244 else
245 return -1;
246 }
247
248 int
249 in_thread_list (pid)
250 int pid;
251 {
252 struct thread_info *tp;
253
254 for (tp = thread_list; tp; tp = tp->next)
255 if (tp->pid == pid)
256 return 1;
257
258 return 0; /* Never heard of 'im */
259 }
260 #ifdef UI_OUT
261 /* Print a list of thread ids currently known, and the total number of
262 threads. To be used from within catch_errors. */
263 static int
264 do_captured_list_thread_ids (void *arg)
265 {
266 struct thread_info *tp;
267 int num = 0;
268
269 ui_out_list_begin (uiout, "thread-ids");
270
271 for (tp = thread_list; tp; tp = tp->next)
272 {
273 num++;
274 ui_out_field_int (uiout, "thread-id", tp->num);
275 }
276
277 ui_out_list_end (uiout);
278 ui_out_field_int (uiout, "number-of-threads", num);
279 return GDB_RC_OK;
280 }
281
282 /* Official gdblib interface function to get a list of thread ids and
283 the total number. */
284 enum gdb_rc
285 gdb_list_thread_ids (/* output object */)
286 {
287 return catch_errors (do_captured_list_thread_ids, NULL,
288 NULL, RETURN_MASK_ALL);
289 }
290 #endif
291
292 /* Load infrun state for the thread PID. */
293
294 void
295 load_infrun_state (pid, prev_pc, prev_func_start, prev_func_name,
296 trap_expected, step_resume_breakpoint,
297 through_sigtramp_breakpoint, step_range_start,
298 step_range_end, step_frame_address,
299 handling_longjmp, another_trap,
300 stepping_through_solib_after_catch,
301 stepping_through_solib_catchpoints,
302 stepping_through_sigtramp)
303 int pid;
304 CORE_ADDR *prev_pc;
305 CORE_ADDR *prev_func_start;
306 char **prev_func_name;
307 int *trap_expected;
308 struct breakpoint **step_resume_breakpoint;
309 struct breakpoint **through_sigtramp_breakpoint;
310 CORE_ADDR *step_range_start;
311 CORE_ADDR *step_range_end;
312 CORE_ADDR *step_frame_address;
313 int *handling_longjmp;
314 int *another_trap;
315 int *stepping_through_solib_after_catch;
316 bpstat *stepping_through_solib_catchpoints;
317 int *stepping_through_sigtramp;
318 {
319 struct thread_info *tp;
320
321 /* If we can't find the thread, then we're debugging a single threaded
322 process. No need to do anything in that case. */
323 tp = find_thread_id (pid_to_thread_id (pid));
324 if (tp == NULL)
325 return;
326
327 *prev_pc = tp->prev_pc;
328 *prev_func_start = tp->prev_func_start;
329 *prev_func_name = tp->prev_func_name;
330 *step_resume_breakpoint = tp->step_resume_breakpoint;
331 *step_range_start = tp->step_range_start;
332 *step_range_end = tp->step_range_end;
333 *step_frame_address = tp->step_frame_address;
334 *through_sigtramp_breakpoint = tp->through_sigtramp_breakpoint;
335 *handling_longjmp = tp->handling_longjmp;
336 *trap_expected = tp->trap_expected;
337 *another_trap = tp->another_trap;
338 *stepping_through_solib_after_catch = tp->stepping_through_solib_after_catch;
339 *stepping_through_solib_catchpoints = tp->stepping_through_solib_catchpoints;
340 *stepping_through_sigtramp = tp->stepping_through_sigtramp;
341 }
342
343 /* Save infrun state for the thread PID. */
344
345 void
346 save_infrun_state (pid, prev_pc, prev_func_start, prev_func_name,
347 trap_expected, step_resume_breakpoint,
348 through_sigtramp_breakpoint, step_range_start,
349 step_range_end, step_frame_address,
350 handling_longjmp, another_trap,
351 stepping_through_solib_after_catch,
352 stepping_through_solib_catchpoints,
353 stepping_through_sigtramp)
354 int pid;
355 CORE_ADDR prev_pc;
356 CORE_ADDR prev_func_start;
357 char *prev_func_name;
358 int trap_expected;
359 struct breakpoint *step_resume_breakpoint;
360 struct breakpoint *through_sigtramp_breakpoint;
361 CORE_ADDR step_range_start;
362 CORE_ADDR step_range_end;
363 CORE_ADDR step_frame_address;
364 int handling_longjmp;
365 int another_trap;
366 int stepping_through_solib_after_catch;
367 bpstat stepping_through_solib_catchpoints;
368 int stepping_through_sigtramp;
369 {
370 struct thread_info *tp;
371
372 /* If we can't find the thread, then we're debugging a single-threaded
373 process. Nothing to do in that case. */
374 tp = find_thread_id (pid_to_thread_id (pid));
375 if (tp == NULL)
376 return;
377
378 tp->prev_pc = prev_pc;
379 tp->prev_func_start = prev_func_start;
380 tp->prev_func_name = prev_func_name;
381 tp->step_resume_breakpoint = step_resume_breakpoint;
382 tp->step_range_start = step_range_start;
383 tp->step_range_end = step_range_end;
384 tp->step_frame_address = step_frame_address;
385 tp->through_sigtramp_breakpoint = through_sigtramp_breakpoint;
386 tp->handling_longjmp = handling_longjmp;
387 tp->trap_expected = trap_expected;
388 tp->another_trap = another_trap;
389 tp->stepping_through_solib_after_catch = stepping_through_solib_after_catch;
390 tp->stepping_through_solib_catchpoints = stepping_through_solib_catchpoints;
391 tp->stepping_through_sigtramp = stepping_through_sigtramp;
392 }
393
394 /* Return true if TP is an active thread. */
395 static int
396 thread_alive (tp)
397 struct thread_info *tp;
398 {
399 if (tp->pid == -1)
400 return 0;
401 if (!target_thread_alive (tp->pid))
402 {
403 tp->pid = -1; /* Mark it as dead */
404 return 0;
405 }
406 return 1;
407 }
408
409 static void
410 prune_threads ()
411 {
412 struct thread_info *tp, *next;
413
414 for (tp = thread_list; tp; tp = next)
415 {
416 next = tp->next;
417 if (!thread_alive (tp))
418 delete_thread (tp->pid);
419 }
420 }
421
422 /* Print information about currently known threads
423
424 * Note: this has the drawback that it _really_ switches
425 * threads, which frees the frame cache. A no-side
426 * effects info-threads command would be nicer.
427 */
428
429 static void
430 info_threads_command (arg, from_tty)
431 char *arg;
432 int from_tty;
433 {
434 struct thread_info *tp;
435 int current_pid;
436 struct frame_info *cur_frame;
437 int saved_frame_level = selected_frame_level;
438 int counter;
439 char *extra_info;
440
441 /* Avoid coredumps which would happen if we tried to access a NULL
442 selected_frame. */
443 if (!target_has_stack)
444 error ("No stack.");
445
446 prune_threads ();
447 target_find_new_threads ();
448 current_pid = inferior_pid;
449 for (tp = thread_list; tp; tp = tp->next)
450 {
451 if (tp->pid == current_pid)
452 printf_filtered ("* ");
453 else
454 printf_filtered (" ");
455
456 #ifdef HPUXHPPA
457 printf_filtered ("%d %s", tp->num, target_tid_to_str (tp->pid));
458 #else
459 printf_filtered ("%d %s", tp->num, target_pid_to_str (tp->pid));
460 #endif
461
462 extra_info = target_extra_thread_info (tp);
463 if (extra_info)
464 printf_filtered (" (%s)", extra_info);
465 puts_filtered (" ");
466
467 switch_to_thread (tp->pid);
468 if (selected_frame)
469 print_only_stack_frame (selected_frame, -1, 0);
470 else
471 printf_filtered ("[No stack.]\n");
472 }
473
474 switch_to_thread (current_pid);
475
476 /* Code below copied from "up_silently_base" in "stack.c".
477 * It restores the frame set by the user before the "info threads"
478 * command. We have finished the info-threads display by switching
479 * back to the current thread. That switch has put us at the top
480 * of the stack (leaf frame).
481 */
482 counter = saved_frame_level;
483 cur_frame = find_relative_frame (selected_frame, &counter);
484 if (counter != 0)
485 {
486 /* Ooops, can't restore, tell user where we are. */
487 warning ("Couldn't restore frame in current thread, at frame 0");
488 print_stack_frame (selected_frame, -1, 0);
489 }
490 else
491 {
492 select_frame (cur_frame, saved_frame_level);
493 }
494
495 /* re-show current frame. */
496 show_stack_frame (cur_frame);
497 }
498
499 /* Switch from one thread to another. */
500
501 static void
502 switch_to_thread (pid)
503 int pid;
504 {
505 if (pid == inferior_pid)
506 return;
507
508 inferior_pid = pid;
509 flush_cached_frames ();
510 registers_changed ();
511 stop_pc = read_pc ();
512 select_frame (get_current_frame (), 0);
513 }
514
515 static void
516 restore_current_thread (pid)
517 int pid;
518 {
519 if (pid != inferior_pid)
520 {
521 switch_to_thread (pid);
522 print_stack_frame (get_current_frame (), 0, -1);
523 }
524 }
525
526 struct current_thread_cleanup
527 {
528 int inferior_pid;
529 };
530
531 static void
532 do_restore_current_thread_cleanup (void *arg)
533 {
534 struct current_thread_cleanup *old = arg;
535 restore_current_thread (old->inferior_pid);
536 free (old);
537 }
538
539 static struct cleanup *
540 make_cleanup_restore_current_thread (int inferior_pid)
541 {
542 struct current_thread_cleanup *old
543 = xmalloc (sizeof (struct current_thread_cleanup));
544 old->inferior_pid = inferior_pid;
545 return make_cleanup (do_restore_current_thread_cleanup, old);
546 }
547
548 /* Apply a GDB command to a list of threads. List syntax is a whitespace
549 seperated list of numbers, or ranges, or the keyword `all'. Ranges consist
550 of two numbers seperated by a hyphen. Examples:
551
552 thread apply 1 2 7 4 backtrace Apply backtrace cmd to threads 1,2,7,4
553 thread apply 2-7 9 p foo(1) Apply p foo(1) cmd to threads 2->7 & 9
554 thread apply all p x/i $pc Apply x/i $pc cmd to all threads
555 */
556
557 static void
558 thread_apply_all_command (cmd, from_tty)
559 char *cmd;
560 int from_tty;
561 {
562 struct thread_info *tp;
563 struct cleanup *old_chain;
564
565 if (cmd == NULL || *cmd == '\000')
566 error ("Please specify a command following the thread ID list");
567
568 old_chain = make_cleanup_restore_current_thread (inferior_pid);
569
570 for (tp = thread_list; tp; tp = tp->next)
571 if (thread_alive (tp))
572 {
573 switch_to_thread (tp->pid);
574 #ifdef HPUXHPPA
575 printf_filtered ("\nThread %d (%s):\n",
576 tp->num,
577 target_tid_to_str (inferior_pid));
578 #else
579 printf_filtered ("\nThread %d (%s):\n", tp->num,
580 target_pid_to_str (inferior_pid));
581 #endif
582 execute_command (cmd, from_tty);
583 }
584
585 do_cleanups (old_chain);
586 }
587
588 static void
589 thread_apply_command (tidlist, from_tty)
590 char *tidlist;
591 int from_tty;
592 {
593 char *cmd;
594 char *p;
595 struct cleanup *old_chain;
596
597 if (tidlist == NULL || *tidlist == '\000')
598 error ("Please specify a thread ID list");
599
600 for (cmd = tidlist; *cmd != '\000' && !isalpha (*cmd); cmd++);
601
602 if (*cmd == '\000')
603 error ("Please specify a command following the thread ID list");
604
605 old_chain = make_cleanup_restore_current_thread (inferior_pid);
606
607 while (tidlist < cmd)
608 {
609 struct thread_info *tp;
610 int start, end;
611
612 start = strtol (tidlist, &p, 10);
613 if (p == tidlist)
614 error ("Error parsing %s", tidlist);
615 tidlist = p;
616
617 while (*tidlist == ' ' || *tidlist == '\t')
618 tidlist++;
619
620 if (*tidlist == '-') /* Got a range of IDs? */
621 {
622 tidlist++; /* Skip the - */
623 end = strtol (tidlist, &p, 10);
624 if (p == tidlist)
625 error ("Error parsing %s", tidlist);
626 tidlist = p;
627
628 while (*tidlist == ' ' || *tidlist == '\t')
629 tidlist++;
630 }
631 else
632 end = start;
633
634 for (; start <= end; start++)
635 {
636 tp = find_thread_id (start);
637
638 if (!tp)
639 warning ("Unknown thread %d.", start);
640 else if (!thread_alive (tp))
641 warning ("Thread %d has terminated.", start);
642 else
643 {
644 switch_to_thread (tp->pid);
645 #ifdef HPUXHPPA
646 printf_filtered ("\nThread %d (%s):\n", tp->num,
647 target_tid_to_str (inferior_pid));
648 #else
649 printf_filtered ("\nThread %d (%s):\n", tp->num,
650 target_pid_to_str (inferior_pid));
651 #endif
652 execute_command (cmd, from_tty);
653 }
654 }
655 }
656
657 do_cleanups (old_chain);
658 }
659
660 /* Switch to the specified thread. Will dispatch off to thread_apply_command
661 if prefix of arg is `apply'. */
662
663 static void
664 thread_command (tidstr, from_tty)
665 char *tidstr;
666 int from_tty;
667 {
668 if (!tidstr)
669 {
670 /* Don't generate an error, just say which thread is current. */
671 if (target_has_stack)
672 printf_filtered ("[Current thread is %d (%s)]\n",
673 pid_to_thread_id (inferior_pid),
674 #if defined(HPUXHPPA)
675 target_tid_to_str (inferior_pid)
676 #else
677 target_pid_to_str (inferior_pid)
678 #endif
679 );
680 else
681 error ("No stack.");
682 return;
683 }
684
685 gdb_thread_select (tidstr);
686 }
687
688 static int
689 do_captured_thread_select (void *tidstr)
690 {
691 int num;
692 struct thread_info *tp;
693
694 num = atoi ((char *)tidstr);
695
696 tp = find_thread_id (num);
697
698 #ifdef UI_OUT
699 if (!tp)
700 error ("Thread ID %d not known.", num);
701 #else
702 if (!tp)
703 error ("Thread ID %d not known. Use the \"info threads\" command to\n\
704 see the IDs of currently known threads.", num);
705 #endif
706
707 if (!thread_alive (tp))
708 error ("Thread ID %d has terminated.\n", num);
709
710 switch_to_thread (tp->pid);
711
712 #ifdef UI_OUT
713 ui_out_text (uiout, "[Switching to thread ");
714 ui_out_field_int (uiout, "new-thread-id", pid_to_thread_id (inferior_pid));
715 ui_out_text (uiout, " (");
716 #if defined(HPUXHPPA)
717 ui_out_text (uiout, target_tid_to_str (inferior_pid));
718 #else
719 ui_out_text (uiout, target_pid_to_str (inferior_pid));
720 #endif
721 ui_out_text (uiout, ")]");
722 #else /* UI_OUT */
723 printf_filtered ("[Switching to thread %d (%s)]\n",
724 pid_to_thread_id (inferior_pid),
725 #if defined(HPUXHPPA)
726 target_tid_to_str (inferior_pid)
727 #else
728 target_pid_to_str (inferior_pid)
729 #endif
730 );
731 #endif /* UI_OUT */
732
733 print_stack_frame (selected_frame, selected_frame_level, 1);
734 return GDB_RC_OK;
735 }
736
737 enum gdb_rc
738 gdb_thread_select (char *tidstr)
739 {
740 return catch_errors (do_captured_thread_select, tidstr,
741 NULL, RETURN_MASK_ALL);
742 }
743
744 /* Commands with a prefix of `thread'. */
745 struct cmd_list_element *thread_cmd_list = NULL;
746
747 void
748 _initialize_thread ()
749 {
750 static struct cmd_list_element *thread_apply_list = NULL;
751
752 add_info ("threads", info_threads_command,
753 "IDs of currently known threads.");
754
755 add_prefix_cmd ("thread", class_run, thread_command,
756 "Use this command to switch between threads.\n\
757 The new thread ID must be currently known.", &thread_cmd_list, "thread ", 1,
758 &cmdlist);
759
760 add_prefix_cmd ("apply", class_run, thread_apply_command,
761 "Apply a command to a list of threads.",
762 &thread_apply_list, "apply ", 1, &thread_cmd_list);
763
764 add_cmd ("all", class_run, thread_apply_all_command,
765 "Apply a command to all threads.",
766 &thread_apply_list);
767
768 if (!xdb_commands)
769 add_com_alias ("t", "thread", class_run, 1);
770 }