gdb/gdbthread.h

   1 /* Multi-process/thread control defs for GDB, the GNU debugger.
   2    Copyright (C) 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1997, 1998, 1999,
   3    2000, 2007, 2008 Free Software Foundation, Inc.
   4    Contributed by Lynx Real-Time Systems, Inc.  Los Gatos, CA.
   5
   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 3 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, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GDBTHREAD_H
  23 #define GDBTHREAD_H
  24
  25 struct breakpoint;
  26 struct frame_id;
  27 struct symtab;
  28
  29 /* For bpstat */
  30 #include "breakpoint.h"
  31
  32 /* For struct frame_id.  */
  33 #include "frame.h"
  34
  35 #include "ui-out.h"
  36
  37 struct thread_info
  38 {
  39   struct thread_info *next;
  40   ptid_t ptid;                  /* "Actual process id";
  41                                     In fact, this may be overloaded with
  42                                     kernel thread id, etc.  */
  43   int num;                      /* Convenient handle (GDB thread id) */
  44   /* State from wait_for_inferior */
  45   CORE_ADDR prev_pc;
  46   struct breakpoint *step_resume_breakpoint;
  47   CORE_ADDR step_range_start;
  48   CORE_ADDR step_range_end;
  49   struct frame_id step_frame_id;
  50   int current_line;
  51   struct symtab *current_symtab;
  52   int trap_expected;
  53   int handling_longjmp;
  54   int stepping_over_breakpoint;
  55
  56   /* This is set TRUE when a catchpoint of a shared library event
  57      triggers.  Since we don't wish to leave the inferior in the
  58      solib hook when we report the event, we step the inferior
  59      back to user code before stopping and reporting the event.  */
  60   int stepping_through_solib_after_catch;
  61
  62   /* When stepping_through_solib_after_catch is TRUE, this is a
  63      list of the catchpoints that should be reported as triggering
  64      when we finally do stop stepping.  */
  65   bpstat stepping_through_solib_catchpoints;
  66
  67   /* Private data used by the target vector implementation.  */
  68   struct private_thread_info *private;
  69 };
  70
  71 /* Create an empty thread list, or empty the existing one.  */
  72 extern void init_thread_list (void);
  73
  74 /* Add a thread to the thread list, print a message
  75    that a new thread is found, and return the pointer to
  76    the new thread.  Caller my use this pointer to
  77    initialize the private thread data.  */
  78 extern struct thread_info *add_thread (ptid_t ptid);
  79
  80 /* Same as add_thread, but does not print a message
  81    about new thread.  */
  82 extern struct thread_info *add_thread_silent (ptid_t ptid);
  83
  84 /* Same as add_thread, and sets the private info.  */
  85 extern struct thread_info *add_thread_with_info (ptid_t ptid,
  86                                                  struct private_thread_info *);
  87
  88 /* Delete an existing thread list entry.  */
  89 extern void delete_thread (ptid_t);
  90
  91 /* Delete a step_resume_breakpoint from the thread database. */
  92 extern void delete_step_resume_breakpoint (void *);
  93
  94 /* Translate the integer thread id (GDB's homegrown id, not the system's)
  95    into a "pid" (which may be overloaded with extra thread information).  */
  96 extern ptid_t thread_id_to_pid (int);
  97
  98 /* Translate a 'pid' (which may be overloaded with extra thread information)
  99    into the integer thread id (GDB's homegrown id, not the system's).  */
 100 extern int pid_to_thread_id (ptid_t ptid);
 101
 102 /* Boolean test for an already-known pid (which may be overloaded with
 103    extra thread information).  */
 104 extern int in_thread_list (ptid_t ptid);
 105
 106 /* Boolean test for an already-known thread id (GDB's homegrown id,
 107    not the system's).  */
 108 extern int valid_thread_id (int thread);
 109
 110 /* Search function to lookup a thread by 'pid'.  */
 111 extern struct thread_info *find_thread_pid (ptid_t ptid);
 112
 113 /* Iterator function to call a user-provided callback function
 114    once for each known thread.  */
 115 typedef int (*thread_callback_func) (struct thread_info *, void *);
 116 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 117
 118 /* infrun context switch: save the debugger state for the given thread.  */
 119 extern void save_infrun_state (ptid_t ptid,
 120                                CORE_ADDR prev_pc,
 121                                int       trap_expected,
 122                                struct breakpoint *step_resume_breakpoint,
 123                                CORE_ADDR step_range_start,
 124                                CORE_ADDR step_range_end,
 125                                const struct frame_id *step_frame_id,
 126                                int       handling_longjmp,
 127                                int       another_trap,
 128                                int       stepping_through_solib_after_catch,
 129                                bpstat    stepping_through_solib_catchpoints,
 130                                int       current_line,
 131                                struct symtab *current_symtab);
 132
 133 /* infrun context switch: load the debugger state previously saved
 134    for the given thread.  */
 135 extern void load_infrun_state (ptid_t ptid,
 136                                CORE_ADDR *prev_pc,
 137                                int       *trap_expected,
 138                                struct breakpoint **step_resume_breakpoint,
 139                                CORE_ADDR *step_range_start,
 140                                CORE_ADDR *step_range_end,
 141                                struct frame_id *step_frame_id,
 142                                int       *handling_longjmp,
 143                                int       *another_trap,
 144                                int       *stepping_through_solib_affter_catch,
 145                                bpstat    *stepping_through_solib_catchpoints,
 146                                int       *current_line,
 147                                struct symtab **current_symtab);
 148
 149 /* Switch from one thread to another.  */
 150 extern void switch_to_thread (ptid_t ptid);
 151
 152 /* Commands with a prefix of `thread'.  */
 153 extern struct cmd_list_element *thread_cmd_list;
 154
 155 /* Print notices on thread events (attach, detach, etc.), set with
 156    `set print thread-events'.  */
 157 extern int print_thread_events;
 158
 159 extern void print_thread_info (struct ui_out *uiout, int thread);
 160
 161 extern struct cleanup *make_cleanup_restore_current_thread (ptid_t,
 162                                                             struct frame_id);
 163
 164
 165 #endif /* GDBTHREAD_H */