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   char *prev_func_name;
  48   struct breakpoint *step_resume_breakpoint;
  49   struct breakpoint *through_sigtramp_breakpoint;
  50   CORE_ADDR step_range_start;
  51   CORE_ADDR step_range_end;
  52   struct frame_id step_frame_id;
  53   CORE_ADDR step_sp;
  54   int current_line;
  55   struct symtab *current_symtab;
  56   int trap_expected;
  57   int handling_longjmp;
  58   int another_trap;
  59
  60   /* This is set TRUE when a catchpoint of a shared library event
  61      triggers.  Since we don't wish to leave the inferior in the
  62      solib hook when we report the event, we step the inferior
  63      back to user code before stopping and reporting the event.  */
  64   int stepping_through_solib_after_catch;
  65
  66   /* When stepping_through_solib_after_catch is TRUE, this is a
  67      list of the catchpoints that should be reported as triggering
  68      when we finally do stop stepping.  */
  69   bpstat stepping_through_solib_catchpoints;
  70
  71   /* This is set to TRUE when this thread is in a signal handler
  72      trampoline and we're single-stepping through it.  */
  73   int stepping_through_sigtramp;
  74
  75   /* Private data used by the target vector implementation.  */
  76   struct private_thread_info *private;
  77 };
  78
  79 /* Create an empty thread list, or empty the existing one.  */
  80 extern void init_thread_list (void);
  81
  82 /* Add a thread to the thread list.
  83    Note that add_thread now returns the handle of the new thread,
  84    so that the caller may initialize the private thread data.  */
  85 extern struct thread_info *add_thread (ptid_t ptid);
  86
  87 /* Delete an existing thread list entry.  */
  88 extern void delete_thread (ptid_t);
  89
  90 /* Delete a step_resume_breakpoint from the thread database. */
  91 extern void delete_step_resume_breakpoint (void *);
  92
  93 /* Translate the integer thread id (GDB's homegrown id, not the system's)
  94    into a "pid" (which may be overloaded with extra thread information).  */
  95 extern ptid_t thread_id_to_pid (int);
  96
  97 /* Translate a 'pid' (which may be overloaded with extra thread information)
  98    into the integer thread id (GDB's homegrown id, not the system's).  */
  99 extern int pid_to_thread_id (ptid_t ptid);
 100
 101 /* Boolean test for an already-known pid (which may be overloaded with
 102    extra thread information).  */
 103 extern int in_thread_list (ptid_t ptid);
 104
 105 /* Boolean test for an already-known thread id (GDB's homegrown id,
 106    not the system's).  */
 107 extern int valid_thread_id (int thread);
 108
 109 /* Search function to lookup a thread by 'pid'.  */
 110 extern struct thread_info *find_thread_pid (ptid_t ptid);
 111
 112 /* Iterator function to call a user-provided callback function
 113    once for each known thread.  */
 114 typedef int (*thread_callback_func) (struct thread_info *, void *);
 115 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 116
 117 /* infrun context switch: save the debugger state for the given thread.  */
 118 extern void save_infrun_state (ptid_t ptid,
 119                                CORE_ADDR prev_pc,
 120                                char     *prev_func_name,
 121                                int       trap_expected,
 122                                struct breakpoint *step_resume_breakpoint,
 123                                struct breakpoint *through_sigtramp_breakpoint,
 124                                CORE_ADDR step_range_start,
 125                                CORE_ADDR step_range_end,
 126                                const struct frame_id *step_frame_id,
 127                                int       handling_longjmp,
 128                                int       another_trap,
 129                                int       stepping_through_solib_after_catch,
 130                                bpstat    stepping_through_solib_catchpoints,
 131                                int       stepping_through_sigtramp,
 132                                int       current_line,
 133                                struct symtab *current_symtab,
 134                                CORE_ADDR step_sp);
 135
 136 /* infrun context switch: load the debugger state previously saved
 137    for the given thread.  */
 138 extern void load_infrun_state (ptid_t ptid,
 139                                CORE_ADDR *prev_pc,
 140                                char     **prev_func_name,
 141                                int       *trap_expected,
 142                                struct breakpoint **step_resume_breakpoint,
 143                                struct breakpoint **through_sigtramp_breakpoint,
 144                                CORE_ADDR *step_range_start,
 145                                CORE_ADDR *step_range_end,
 146                                struct frame_id *step_frame_id,
 147                                int       *handling_longjmp,
 148                                int       *another_trap,
 149                                int       *stepping_through_solib_affter_catch,
 150                                bpstat    *stepping_through_solib_catchpoints,
 151                                int       *stepping_through_sigtramp,
 152                                int       *current_line,
 153                                struct symtab **current_symtab,
 154                                CORE_ADDR *step_sp);
 155
 156 /* Commands with a prefix of `thread'.  */
 157 extern struct cmd_list_element *thread_cmd_list;
 158
 159 #endif /* GDBTHREAD_H */