gdb/thread.c

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