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