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