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 running state.  Note that this is different
  49      from EXECUTING.  When the thread is stopped internally while
  50      handling an internal event, like a software single-step
  51      breakpoint, executing will be false, but running will still be
  52      true.  As a possible future extension, this could turn into
  53      enum { stopped, stepping, finishing, until(ling), ... }  */
  54   /* This field is internal to thread.c.  Never access it directly,
  55      use is_running instead.  */
  56   int running_;
  57
  58   /* State from wait_for_inferior */
  59   CORE_ADDR prev_pc;
  60   struct breakpoint *step_resume_breakpoint;
  61   CORE_ADDR step_range_start;
  62   CORE_ADDR step_range_end;
  63   struct frame_id step_frame_id;
  64   int current_line;
  65   struct symtab *current_symtab;
  66   int trap_expected;
  67   int stepping_over_breakpoint;
  68
  69   /* This is set TRUE when a catchpoint of a shared library event
  70      triggers.  Since we don't wish to leave the inferior in the
  71      solib hook when we report the event, we step the inferior
  72      back to user code before stopping and reporting the event.  */
  73   int stepping_through_solib_after_catch;
  74
  75   /* When stepping_through_solib_after_catch is TRUE, this is a
  76      list of the catchpoints that should be reported as triggering
  77      when we finally do stop stepping.  */
  78   bpstat stepping_through_solib_catchpoints;
  79
  80   /* The below are only per-thread in non-stop mode.  */
  81   /* Per-thread command support.  */
  82   struct continuation *continuations;
  83   struct continuation *intermediate_continuations;
  84   int proceed_to_finish;
  85   enum step_over_calls_kind step_over_calls;
  86   int stop_step;
  87   int step_multi;
  88
  89   enum target_signal stop_signal;
  90   /* Used in continue_command to set the proceed count of the
  91      breakpoint the thread stopped at.  */
  92   bpstat stop_bpstat;
  93
  94   /* Private data used by the target vector implementation.  */
  95   struct private_thread_info *private;
  96 };
  97
  98 /* Create an empty thread list, or empty the existing one.  */
  99 extern void init_thread_list (void);
 100
 101 /* Add a thread to the thread list, print a message
 102    that a new thread is found, and return the pointer to
 103    the new thread.  Caller my use this pointer to
 104    initialize the private thread data.  */
 105 extern struct thread_info *add_thread (ptid_t ptid);
 106
 107 /* Same as add_thread, but does not print a message
 108    about new thread.  */
 109 extern struct thread_info *add_thread_silent (ptid_t ptid);
 110
 111 /* Same as add_thread, and sets the private info.  */
 112 extern struct thread_info *add_thread_with_info (ptid_t ptid,
 113                                                  struct private_thread_info *);
 114
 115 /* Delete an existing thread list entry.  */
 116 extern void delete_thread (ptid_t);
 117
 118 /* Delete an existing thread list entry, and be quiet about it.  Used
 119    after the process this thread having belonged to having already
 120    exited, for example.  */
 121 extern void delete_thread_silent (ptid_t);
 122
 123 /* Delete a step_resume_breakpoint from the thread database. */
 124 extern void delete_step_resume_breakpoint (void *);
 125
 126 /* Translate the integer thread id (GDB's homegrown id, not the system's)
 127    into a "pid" (which may be overloaded with extra thread information).  */
 128 extern ptid_t thread_id_to_pid (int);
 129
 130 /* Translate a 'pid' (which may be overloaded with extra thread information)
 131    into the integer thread id (GDB's homegrown id, not the system's).  */
 132 extern int pid_to_thread_id (ptid_t ptid);
 133
 134 /* Boolean test for an already-known pid (which may be overloaded with
 135    extra thread information).  */
 136 extern int in_thread_list (ptid_t ptid);
 137
 138 /* Boolean test for an already-known thread id (GDB's homegrown id,
 139    not the system's).  */
 140 extern int valid_thread_id (int thread);
 141
 142 /* Search function to lookup a thread by 'pid'.  */
 143 extern struct thread_info *find_thread_pid (ptid_t ptid);
 144
 145 /* Iterator function to call a user-provided callback function
 146    once for each known thread.  */
 147 typedef int (*thread_callback_func) (struct thread_info *, void *);
 148 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 149
 150 extern int thread_count (void);
 151
 152 /* infrun context switch: save the debugger state for the given thread.  */
 153 extern void save_infrun_state (ptid_t ptid,
 154                                CORE_ADDR prev_pc,
 155                                int       trap_expected,
 156                                struct breakpoint *step_resume_breakpoint,
 157                                CORE_ADDR step_range_start,
 158                                CORE_ADDR step_range_end,
 159                                const struct frame_id *step_frame_id,
 160                                int       another_trap,
 161                                int       stepping_through_solib_after_catch,
 162                                bpstat    stepping_through_solib_catchpoints,
 163                                int       current_line,
 164                                struct symtab *current_symtab,
 165                                struct continuation *continuations,
 166                                struct continuation *intermediate_continuations,
 167                                int proceed_to_finish,
 168                                enum step_over_calls_kind step_over_calls,
 169                                int stop_step,
 170                                int step_multi,
 171                                enum target_signal stop_signal,
 172                                bpstat stop_bpstat);
 173
 174 /* infrun context switch: load the debugger state previously saved
 175    for the given thread.  */
 176 extern void load_infrun_state (ptid_t ptid,
 177                                CORE_ADDR *prev_pc,
 178                                int       *trap_expected,
 179                                struct breakpoint **step_resume_breakpoint,
 180                                CORE_ADDR *step_range_start,
 181                                CORE_ADDR *step_range_end,
 182                                struct frame_id *step_frame_id,
 183                                int       *another_trap,
 184                                int       *stepping_through_solib_after_catch,
 185                                bpstat    *stepping_through_solib_catchpoints,
 186                                int       *current_line,
 187                                struct symtab **current_symtab,
 188                                struct continuation **continuations,
 189                                struct continuation **intermediate_continuations,
 190                                int *proceed_to_finish,
 191                                enum step_over_calls_kind *step_over_calls,
 192                                int *stop_step,
 193                                int *step_multi,
 194                                enum target_signal *stop_signal,
 195                                bpstat *stop_bpstat);
 196
 197 /* Switch from one thread to another.  */
 198 extern void switch_to_thread (ptid_t ptid);
 199
 200 /* Marks thread PTID is running, or stopped.
 201    If PIDGET (PTID) is -1, marks all threads.  */
 202 extern void set_running (ptid_t ptid, int running);
 203
 204 /* Reports if thread PTID is known to be running right now.  */
 205 extern int is_running (ptid_t ptid);
 206
 207 /* Reports if any thread is known to be running right now.  */
 208 extern int any_running (void);
 209
 210 /* Marks thread PTID as executing, or as stopped.
 211    If PIDGET (PTID) is -1, marks all threads.  */
 212 extern void set_executing (ptid_t ptid, int executing);
 213
 214 /* Reports if thread PTID is executing.  */
 215 extern int is_executing (ptid_t ptid);
 216
 217 /* Commands with a prefix of `thread'.  */
 218 extern struct cmd_list_element *thread_cmd_list;
 219
 220 /* Print notices on thread events (attach, detach, etc.), set with
 221    `set print thread-events'.  */
 222 extern int print_thread_events;
 223
 224 extern void print_thread_info (struct ui_out *uiout, int thread);
 225
 226 extern struct cleanup *make_cleanup_restore_current_thread (ptid_t,
 227                                                             struct frame_id);
 228
 229
 230 #endif /* GDBTHREAD_H */