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 #include "ui-out.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 stepping_over_breakpoint;
  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, print a message
  75    that a new thread is found, and return the pointer to
  76    the new thread.  Caller my use this pointer to
  77    initialize the private thread data.  */
  78 extern struct thread_info *add_thread (ptid_t ptid);
  79
  80 /* Same as add_thread, but does not print a message
  81    about new thread.  */
  82 extern struct thread_info *add_thread_silent (ptid_t ptid);
  83
  84 /* Delete an existing thread list entry.  */
  85 extern void delete_thread (ptid_t);
  86
  87 /* Delete a step_resume_breakpoint from the thread database. */
  88 extern void delete_step_resume_breakpoint (void *);
  89
  90 /* Translate the integer thread id (GDB's homegrown id, not the system's)
  91    into a "pid" (which may be overloaded with extra thread information).  */
  92 extern ptid_t thread_id_to_pid (int);
  93
  94 /* Translate a 'pid' (which may be overloaded with extra thread information)
  95    into the integer thread id (GDB's homegrown id, not the system's).  */
  96 extern int pid_to_thread_id (ptid_t ptid);
  97
  98 /* Boolean test for an already-known pid (which may be overloaded with
  99    extra thread information).  */
 100 extern int in_thread_list (ptid_t ptid);
 101
 102 /* Boolean test for an already-known thread id (GDB's homegrown id,
 103    not the system's).  */
 104 extern int valid_thread_id (int thread);
 105
 106 /* Search function to lookup a thread by 'pid'.  */
 107 extern struct thread_info *find_thread_pid (ptid_t ptid);
 108
 109 /* Iterator function to call a user-provided callback function
 110    once for each known thread.  */
 111 typedef int (*thread_callback_func) (struct thread_info *, void *);
 112 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 113
 114 /* infrun context switch: save the debugger state for the given thread.  */
 115 extern void save_infrun_state (ptid_t ptid,
 116                                CORE_ADDR prev_pc,
 117                                int       trap_expected,
 118                                struct breakpoint *step_resume_breakpoint,
 119                                CORE_ADDR step_range_start,
 120                                CORE_ADDR step_range_end,
 121                                const struct frame_id *step_frame_id,
 122                                int       handling_longjmp,
 123                                int       another_trap,
 124                                int       stepping_through_solib_after_catch,
 125                                bpstat    stepping_through_solib_catchpoints,
 126                                int       current_line,
 127                                struct symtab *current_symtab);
 128
 129 /* infrun context switch: load the debugger state previously saved
 130    for the given thread.  */
 131 extern void load_infrun_state (ptid_t ptid,
 132                                CORE_ADDR *prev_pc,
 133                                int       *trap_expected,
 134                                struct breakpoint **step_resume_breakpoint,
 135                                CORE_ADDR *step_range_start,
 136                                CORE_ADDR *step_range_end,
 137                                struct frame_id *step_frame_id,
 138                                int       *handling_longjmp,
 139                                int       *another_trap,
 140                                int       *stepping_through_solib_affter_catch,
 141                                bpstat    *stepping_through_solib_catchpoints,
 142                                int       *current_line,
 143                                struct symtab **current_symtab);
 144
 145 /* Switch from one thread to another.  */
 146 extern void switch_to_thread (ptid_t ptid);
 147
 148 /* Commands with a prefix of `thread'.  */
 149 extern struct cmd_list_element *thread_cmd_list;
 150
 151 /* Print notices on thread events (attach, detach, etc.), set with
 152    `set print thread-events'.  */
 153 extern int print_thread_events;
 154
 155 extern void print_thread_info (struct ui_out *uiout, int thread);
 156
 157 #endif /* GDBTHREAD_H */