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 symtab;
  26
  27 #include "breakpoint.h"
  28 #include "frame.h"
  29 #include "ui-out.h"
  30 #include "inferior.h"
  31
  32 struct thread_info
  33 {
  34   struct thread_info *next;
  35   ptid_t ptid;                  /* "Actual process id";
  36                                     In fact, this may be overloaded with
  37                                     kernel thread id, etc.  */
  38   int num;                      /* Convenient handle (GDB thread id) */
  39
  40   /* Non-zero means the thread is executing.  Note: this is different
  41      from saying that there is an active target and we are stopped at
  42      a breakpoint, for instance.  This is a real indicator whether the
  43      thread is off and running.  */
  44   /* This field is internal to thread.c.  Never access it directly,
  45      use is_executing instead.  */
  46   int executing_;
  47
  48   /* Frontend view of the thread state.  Note that the RUNNING/STOPPED
  49      states are different from EXECUTING.  When the thread is stopped
  50      internally while handling an internal event, like a software
  51      single-step breakpoint, EXECUTING will be false, but running will
  52      still be true.  As a possible future extension, this could turn
  53      into enum { stopped, exited, stepping, finishing, until(ling),
  54      running ... }  */
  55   /* This field is internal to thread.c.  Never access it directly,
  56      use is_running instead.  */
  57   int state_;
  58
  59   /* If this is > 0, then it means there's code out there that relies
  60      on this thread being listed.  Don't delete it from the lists even
  61      if we detect it exiting.  */
  62   int refcount;
  63
  64   /* State from wait_for_inferior */
  65   CORE_ADDR prev_pc;
  66   struct breakpoint *step_resume_breakpoint;
  67   CORE_ADDR step_range_start;
  68   CORE_ADDR step_range_end;
  69   struct frame_id step_frame_id;
  70   int current_line;
  71   struct symtab *current_symtab;
  72   int trap_expected;
  73   int stepping_over_breakpoint;
  74
  75   /* This is set TRUE when a catchpoint of a shared library event
  76      triggers.  Since we don't wish to leave the inferior in the
  77      solib hook when we report the event, we step the inferior
  78      back to user code before stopping and reporting the event.  */
  79   int stepping_through_solib_after_catch;
  80
  81   /* When stepping_through_solib_after_catch is TRUE, this is a
  82      list of the catchpoints that should be reported as triggering
  83      when we finally do stop stepping.  */
  84   bpstat stepping_through_solib_catchpoints;
  85
  86   /* The below are only per-thread in non-stop mode.  */
  87   /* Per-thread command support.  */
  88   struct continuation *continuations;
  89   struct continuation *intermediate_continuations;
  90   int proceed_to_finish;
  91   enum step_over_calls_kind step_over_calls;
  92   int stop_step;
  93   int step_multi;
  94
  95   enum target_signal stop_signal;
  96   /* Used in continue_command to set the proceed count of the
  97      breakpoint the thread stopped at.  */
  98   bpstat stop_bpstat;
  99
 100   /* Private data used by the target vector implementation.  */
 101   struct private_thread_info *private;
 102 };
 103
 104 /* Create an empty thread list, or empty the existing one.  */
 105 extern void init_thread_list (void);
 106
 107 /* Add a thread to the thread list, print a message
 108    that a new thread is found, and return the pointer to
 109    the new thread.  Caller my use this pointer to
 110    initialize the private thread data.  */
 111 extern struct thread_info *add_thread (ptid_t ptid);
 112
 113 /* Same as add_thread, but does not print a message
 114    about new thread.  */
 115 extern struct thread_info *add_thread_silent (ptid_t ptid);
 116
 117 /* Same as add_thread, and sets the private info.  */
 118 extern struct thread_info *add_thread_with_info (ptid_t ptid,
 119                                                  struct private_thread_info *);
 120
 121 /* Delete an existing thread list entry.  */
 122 extern void delete_thread (ptid_t);
 123
 124 /* Delete an existing thread list entry, and be quiet about it.  Used
 125    after the process this thread having belonged to having already
 126    exited, for example.  */
 127 extern void delete_thread_silent (ptid_t);
 128
 129 /* Delete a step_resume_breakpoint from the thread database. */
 130 extern void delete_step_resume_breakpoint (void *);
 131
 132 /* Translate the integer thread id (GDB's homegrown id, not the system's)
 133    into a "pid" (which may be overloaded with extra thread information).  */
 134 extern ptid_t thread_id_to_pid (int);
 135
 136 /* Translate a 'pid' (which may be overloaded with extra thread information)
 137    into the integer thread id (GDB's homegrown id, not the system's).  */
 138 extern int pid_to_thread_id (ptid_t ptid);
 139
 140 /* Boolean test for an already-known pid (which may be overloaded with
 141    extra thread information).  */
 142 extern int in_thread_list (ptid_t ptid);
 143
 144 /* Boolean test for an already-known thread id (GDB's homegrown id,
 145    not the system's).  */
 146 extern int valid_thread_id (int thread);
 147
 148 /* Search function to lookup a thread by 'pid'.  */
 149 extern struct thread_info *find_thread_pid (ptid_t ptid);
 150
 151 /* Find thread by GDB user-visible thread number.  */
 152 struct thread_info *find_thread_id (int num);
 153
 154 /* Iterator function to call a user-provided callback function
 155    once for each known thread.  */
 156 typedef int (*thread_callback_func) (struct thread_info *, void *);
 157 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 158
 159 extern int thread_count (void);
 160
 161 /* infrun context switch: save the debugger state for the given thread.  */
 162 extern void save_infrun_state (ptid_t ptid,
 163                                CORE_ADDR prev_pc,
 164                                int       trap_expected,
 165                                struct breakpoint *step_resume_breakpoint,
 166                                CORE_ADDR step_range_start,
 167                                CORE_ADDR step_range_end,
 168                                const struct frame_id *step_frame_id,
 169                                int       another_trap,
 170                                int       stepping_through_solib_after_catch,
 171                                bpstat    stepping_through_solib_catchpoints,
 172                                int       current_line,
 173                                struct symtab *current_symtab,
 174                                struct continuation *continuations,
 175                                struct continuation *intermediate_continuations,
 176                                int proceed_to_finish,
 177                                enum step_over_calls_kind step_over_calls,
 178                                int stop_step,
 179                                int step_multi,
 180                                enum target_signal stop_signal,
 181                                bpstat stop_bpstat);
 182
 183 /* infrun context switch: load the debugger state previously saved
 184    for the given thread.  */
 185 extern void load_infrun_state (ptid_t ptid,
 186                                CORE_ADDR *prev_pc,
 187                                int       *trap_expected,
 188                                struct breakpoint **step_resume_breakpoint,
 189                                CORE_ADDR *step_range_start,
 190                                CORE_ADDR *step_range_end,
 191                                struct frame_id *step_frame_id,
 192                                int       *another_trap,
 193                                int       *stepping_through_solib_after_catch,
 194                                bpstat    *stepping_through_solib_catchpoints,
 195                                int       *current_line,
 196                                struct symtab **current_symtab,
 197                                struct continuation **continuations,
 198                                struct continuation **intermediate_continuations,
 199                                int *proceed_to_finish,
 200                                enum step_over_calls_kind *step_over_calls,
 201                                int *stop_step,
 202                                int *step_multi,
 203                                enum target_signal *stop_signal,
 204                                bpstat *stop_bpstat);
 205
 206 /* Switch from one thread to another.  */
 207 extern void switch_to_thread (ptid_t ptid);
 208
 209 /* Marks thread PTID is running, or stopped.
 210    If PIDGET (PTID) is -1, marks all threads.  */
 211 extern void set_running (ptid_t ptid, int running);
 212
 213 /* NOTE: Since the thread state is not a boolean, most times, you do
 214    not want to check it with negation.  If you really want to check if
 215    the thread is stopped,
 216
 217     use (good):
 218
 219      if (is_stopped (ptid))
 220
 221     instead of (bad):
 222
 223      if (!is_running (ptid))
 224
 225    The latter also returns true on exited threads, most likelly not
 226    what you want.  */
 227
 228 /* Reports if in the frontend's perpective, thread PTID is running.  */
 229 extern int is_running (ptid_t ptid);
 230
 231 /* Is this thread listed, but known to have exited?  We keep it listed
 232    (but not visible) until it's safe to delete.  */
 233 extern int is_exited (ptid_t ptid);
 234
 235 /* In the frontend's perpective, is this thread stopped?  */
 236 extern int is_stopped (ptid_t ptid);
 237
 238 /* In the frontend's perpective is there any thread running?  */
 239 extern int any_running (void);
 240
 241 /* Marks thread PTID as executing, or not.  If PIDGET (PTID) is -1,
 242    marks all threads.
 243
 244    Note that this is different from the running state.  See the
 245    description of state_ and executing_ fields of struct
 246    thread_info.  */
 247 extern void set_executing (ptid_t ptid, int executing);
 248
 249 /* Reports if thread PTID is executing.  */
 250 extern int is_executing (ptid_t ptid);
 251
 252 /* Commands with a prefix of `thread'.  */
 253 extern struct cmd_list_element *thread_cmd_list;
 254
 255 /* Print notices on thread events (attach, detach, etc.), set with
 256    `set print thread-events'.  */
 257 extern int print_thread_events;
 258
 259 extern void print_thread_info (struct ui_out *uiout, int thread);
 260
 261 extern struct cleanup *make_cleanup_restore_current_thread (void);
 262
 263
 264 #endif /* GDBTHREAD_H */