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, 2008 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 3 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, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GDBTHREAD_H
  23 #define GDBTHREAD_H
  24
  25 struct breakpoint;
  26 struct frame_id;
  27 struct symtab;
  28
  29 /* For bpstat */
  30 #include "breakpoint.h"
  31
  32 /* For struct frame_id.  */
  33 #include "frame.h"
  34
  35 struct thread_info
  36 {
  37   struct thread_info *next;
  38   ptid_t ptid;                  /* "Actual process id";
  39                                     In fact, this may be overloaded with
  40                                     kernel thread id, etc.  */
  41   int num;                      /* Convenient handle (GDB thread id) */
  42   /* State from wait_for_inferior */
  43   CORE_ADDR prev_pc;
  44   struct breakpoint *step_resume_breakpoint;
  45   CORE_ADDR step_range_start;
  46   CORE_ADDR step_range_end;
  47   struct frame_id step_frame_id;
  48   int current_line;
  49   struct symtab *current_symtab;
  50   int trap_expected;
  51   int handling_longjmp;
  52   int stepping_over_breakpoint;
  53
  54   /* This is set TRUE when a catchpoint of a shared library event
  55      triggers.  Since we don't wish to leave the inferior in the
  56      solib hook when we report the event, we step the inferior
  57      back to user code before stopping and reporting the event.  */
  58   int stepping_through_solib_after_catch;
  59
  60   /* When stepping_through_solib_after_catch is TRUE, this is a
  61      list of the catchpoints that should be reported as triggering
  62      when we finally do stop stepping.  */
  63   bpstat stepping_through_solib_catchpoints;
  64
  65   /* Private data used by the target vector implementation.  */
  66   struct private_thread_info *private;
  67 };
  68
  69 /* Create an empty thread list, or empty the existing one.  */
  70 extern void init_thread_list (void);
  71
  72 /* Add a thread to the thread list, print a message
  73    that a new thread is found, and return the pointer to
  74    the new thread.  Caller my use this pointer to
  75    initialize the private thread data.  */
  76 extern struct thread_info *add_thread (ptid_t ptid);
  77
  78 /* Same as add_thread, but does not print a message
  79    about new thread.  */
  80 extern struct thread_info *add_thread_silent (ptid_t ptid);
  81
  82 /* Delete an existing thread list entry.  */
  83 extern void delete_thread (ptid_t);
  84
  85 /* Delete a step_resume_breakpoint from the thread database. */
  86 extern void delete_step_resume_breakpoint (void *);
  87
  88 /* Translate the integer thread id (GDB's homegrown id, not the system's)
  89    into a "pid" (which may be overloaded with extra thread information).  */
  90 extern ptid_t thread_id_to_pid (int);
  91
  92 /* Translate a 'pid' (which may be overloaded with extra thread information)
  93    into the integer thread id (GDB's homegrown id, not the system's).  */
  94 extern int pid_to_thread_id (ptid_t ptid);
  95
  96 /* Boolean test for an already-known pid (which may be overloaded with
  97    extra thread information).  */
  98 extern int in_thread_list (ptid_t ptid);
  99
 100 /* Boolean test for an already-known thread id (GDB's homegrown id,
 101    not the system's).  */
 102 extern int valid_thread_id (int thread);
 103
 104 /* Search function to lookup a thread by 'pid'.  */
 105 extern struct thread_info *find_thread_pid (ptid_t ptid);
 106
 107 /* Iterator function to call a user-provided callback function
 108    once for each known thread.  */
 109 typedef int (*thread_callback_func) (struct thread_info *, void *);
 110 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 111
 112 /* infrun context switch: save the debugger state for the given thread.  */
 113 extern void save_infrun_state (ptid_t ptid,
 114                                CORE_ADDR prev_pc,
 115                                int       trap_expected,
 116                                struct breakpoint *step_resume_breakpoint,
 117                                CORE_ADDR step_range_start,
 118                                CORE_ADDR step_range_end,
 119                                const struct frame_id *step_frame_id,
 120                                int       handling_longjmp,
 121                                int       another_trap,
 122                                int       stepping_through_solib_after_catch,
 123                                bpstat    stepping_through_solib_catchpoints,
 124                                int       current_line,
 125                                struct symtab *current_symtab);
 126
 127 /* infrun context switch: load the debugger state previously saved
 128    for the given thread.  */
 129 extern void load_infrun_state (ptid_t ptid,
 130                                CORE_ADDR *prev_pc,
 131                                int       *trap_expected,
 132                                struct breakpoint **step_resume_breakpoint,
 133                                CORE_ADDR *step_range_start,
 134                                CORE_ADDR *step_range_end,
 135                                struct frame_id *step_frame_id,
 136                                int       *handling_longjmp,
 137                                int       *another_trap,
 138                                int       *stepping_through_solib_affter_catch,
 139                                bpstat    *stepping_through_solib_catchpoints,
 140                                int       *current_line,
 141                                struct symtab **current_symtab);
 142
 143 /* Switch from one thread to another.  */
 144 extern void switch_to_thread (ptid_t ptid);
 145
 146 /* Commands with a prefix of `thread'.  */
 147 extern struct cmd_list_element *thread_cmd_list;
 148
 149 /* Print notices on thread events (attach, detach, etc.), set with
 150    `set print thread-events'.  */
 151 extern int print_thread_events;
 152
 153 #endif /* GDBTHREAD_H */