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