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