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