gdb/gdbthread.h

   1 /* Multi-process/thread control defs for GDB, the GNU debugger.
   2    Copyright 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1997, 1998, 1999,
   3    2000
   4    Free Software Foundation, Inc.
   5    Contributed by Lynx Real-Time Systems, Inc.  Los Gatos, CA.
   6
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 59 Temple Place - Suite 330,
  23    Boston, MA 02111-1307, USA.  */
  24
  25 #ifndef GDBTHREAD_H
  26 #define GDBTHREAD_H
  27
  28 struct breakpoint;
  29 struct frame_id;
  30 struct symtab;
  31
  32 /* For bpstat */
  33 #include "breakpoint.h"
  34
  35 /* For struct frame_id.  */
  36 #include "frame.h"
  37
  38 struct thread_info
  39 {
  40   struct thread_info *next;
  41   ptid_t ptid;                  /* "Actual process id";
  42                                     In fact, this may be overloaded with
  43                                     kernel thread id, etc.  */
  44   int num;                      /* Convenient handle (GDB thread id) */
  45   /* State from wait_for_inferior */
  46   CORE_ADDR prev_pc;
  47   CORE_ADDR prev_func_start;
  48   char *prev_func_name;
  49   struct breakpoint *step_resume_breakpoint;
  50   struct breakpoint *through_sigtramp_breakpoint;
  51   CORE_ADDR step_range_start;
  52   CORE_ADDR step_range_end;
  53   struct frame_id step_frame_id;
  54   CORE_ADDR step_sp;
  55   int current_line;
  56   struct symtab *current_symtab;
  57   int trap_expected;
  58   int handling_longjmp;
  59   int another_trap;
  60
  61   /* This is set TRUE when a catchpoint of a shared library event
  62      triggers.  Since we don't wish to leave the inferior in the
  63      solib hook when we report the event, we step the inferior
  64      back to user code before stopping and reporting the event.  */
  65   int stepping_through_solib_after_catch;
  66
  67   /* When stepping_through_solib_after_catch is TRUE, this is a
  68      list of the catchpoints that should be reported as triggering
  69      when we finally do stop stepping.  */
  70   bpstat stepping_through_solib_catchpoints;
  71
  72   /* This is set to TRUE when this thread is in a signal handler
  73      trampoline and we're single-stepping through it.  */
  74   int stepping_through_sigtramp;
  75
  76   /* Private data used by the target vector implementation.  */
  77   struct private_thread_info *private;
  78 };
  79
  80 /* Create an empty thread list, or empty the existing one.  */
  81 extern void init_thread_list (void);
  82
  83 /* Add a thread to the thread list.
  84    Note that add_thread now returns the handle of the new thread,
  85    so that the caller may initialize the private thread data.  */
  86 extern struct thread_info *add_thread (ptid_t ptid);
  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                                CORE_ADDR prev_func_start,
 122                                char     *prev_func_name,
 123                                int       trap_expected,
 124                                struct breakpoint *step_resume_breakpoint,
 125                                struct breakpoint *through_sigtramp_breakpoint,
 126                                CORE_ADDR step_range_start,
 127                                CORE_ADDR step_range_end,
 128                                const struct frame_id *step_frame_id,
 129                                int       handling_longjmp,
 130                                int       another_trap,
 131                                int       stepping_through_solib_after_catch,
 132                                bpstat    stepping_through_solib_catchpoints,
 133                                int       stepping_through_sigtramp,
 134                                int       current_line,
 135                                struct symtab *current_symtab,
 136                                CORE_ADDR step_sp);
 137
 138 /* infrun context switch: load the debugger state previously saved
 139    for the given thread.  */
 140 extern void load_infrun_state (ptid_t ptid,
 141                                CORE_ADDR *prev_pc,
 142                                CORE_ADDR *prev_func_start,
 143                                char     **prev_func_name,
 144                                int       *trap_expected,
 145                                struct breakpoint **step_resume_breakpoint,
 146                                struct breakpoint **through_sigtramp_breakpoint,
 147                                CORE_ADDR *step_range_start,
 148                                CORE_ADDR *step_range_end,
 149                                struct frame_id *step_frame_id,
 150                                int       *handling_longjmp,
 151                                int       *another_trap,
 152                                int       *stepping_through_solib_affter_catch,
 153                                bpstat    *stepping_through_solib_catchpoints,
 154                                int       *stepping_through_sigtramp,
 155                                int       *current_line,
 156                                struct symtab **current_symtab,
 157                                CORE_ADDR *step_sp);
 158
 159 /* Commands with a prefix of `thread'.  */
 160 extern struct cmd_list_element *thread_cmd_list;
 161
 162 #endif /* GDBTHREAD_H */