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 stepping_over_breakpoint;
  54
  55   /* This is set TRUE when a catchpoint of a shared library event
  56      triggers.  Since we don't wish to leave the inferior in the
  57      solib hook when we report the event, we step the inferior
  58      back to user code before stopping and reporting the event.  */
  59   int stepping_through_solib_after_catch;
  60
  61   /* When stepping_through_solib_after_catch is TRUE, this is a
  62      list of the catchpoints that should be reported as triggering
  63      when we finally do stop stepping.  */
  64   bpstat stepping_through_solib_catchpoints;
  65
  66   /* This field is internal for thread.c.  Never access it directly,
  67      use is_running instead.  */
  68   int running_;
  69
  70   /* Private data used by the target vector implementation.  */
  71   struct private_thread_info *private;
  72 };
  73
  74 /* Create an empty thread list, or empty the existing one.  */
  75 extern void init_thread_list (void);
  76
  77 /* Add a thread to the thread list, print a message
  78    that a new thread is found, and return the pointer to
  79    the new thread.  Caller my use this pointer to
  80    initialize the private thread data.  */
  81 extern struct thread_info *add_thread (ptid_t ptid);
  82
  83 /* Same as add_thread, but does not print a message
  84    about new thread.  */
  85 extern struct thread_info *add_thread_silent (ptid_t ptid);
  86
  87 /* Same as add_thread, and sets the private info.  */
  88 extern struct thread_info *add_thread_with_info (ptid_t ptid,
  89                                                  struct private_thread_info *);
  90
  91 /* Delete an existing thread list entry.  */
  92 extern void delete_thread (ptid_t);
  93
  94 /* Delete a step_resume_breakpoint from the thread database. */
  95 extern void delete_step_resume_breakpoint (void *);
  96
  97 /* Translate the integer thread id (GDB's homegrown id, not the system's)
  98    into a "pid" (which may be overloaded with extra thread information).  */
  99 extern ptid_t thread_id_to_pid (int);
 100
 101 /* Translate a 'pid' (which may be overloaded with extra thread information)
 102    into the integer thread id (GDB's homegrown id, not the system's).  */
 103 extern int pid_to_thread_id (ptid_t ptid);
 104
 105 /* Boolean test for an already-known pid (which may be overloaded with
 106    extra thread information).  */
 107 extern int in_thread_list (ptid_t ptid);
 108
 109 /* Boolean test for an already-known thread id (GDB's homegrown id,
 110    not the system's).  */
 111 extern int valid_thread_id (int thread);
 112
 113 /* Search function to lookup a thread by 'pid'.  */
 114 extern struct thread_info *find_thread_pid (ptid_t ptid);
 115
 116 /* Iterator function to call a user-provided callback function
 117    once for each known thread.  */
 118 typedef int (*thread_callback_func) (struct thread_info *, void *);
 119 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 120
 121 extern int thread_count (void);
 122
 123 /* infrun context switch: save the debugger state for the given thread.  */
 124 extern void save_infrun_state (ptid_t ptid,
 125                                CORE_ADDR prev_pc,
 126                                int       trap_expected,
 127                                struct breakpoint *step_resume_breakpoint,
 128                                CORE_ADDR step_range_start,
 129                                CORE_ADDR step_range_end,
 130                                const struct frame_id *step_frame_id,
 131                                int       another_trap,
 132                                int       stepping_through_solib_after_catch,
 133                                bpstat    stepping_through_solib_catchpoints,
 134                                int       current_line,
 135                                struct symtab *current_symtab);
 136
 137 /* infrun context switch: load the debugger state previously saved
 138    for the given thread.  */
 139 extern void load_infrun_state (ptid_t ptid,
 140                                CORE_ADDR *prev_pc,
 141                                int       *trap_expected,
 142                                struct breakpoint **step_resume_breakpoint,
 143                                CORE_ADDR *step_range_start,
 144                                CORE_ADDR *step_range_end,
 145                                struct frame_id *step_frame_id,
 146                                int       *another_trap,
 147                                int       *stepping_through_solib_affter_catch,
 148                                bpstat    *stepping_through_solib_catchpoints,
 149                                int       *current_line,
 150                                struct symtab **current_symtab);
 151
 152 /* Switch from one thread to another.  */
 153 extern void switch_to_thread (ptid_t ptid);
 154
 155 /* Marks thread PTID is running, or stopped.
 156    If PIDGET (PTID) is -1, marks all threads.  */
 157 extern void set_running (ptid_t ptid, int running);
 158
 159 /* Reports if thread PTID is know to be running right now.  */
 160 extern int is_running (ptid_t ptid);
 161
 162 /* Commands with a prefix of `thread'.  */
 163 extern struct cmd_list_element *thread_cmd_list;
 164
 165 /* Print notices on thread events (attach, detach, etc.), set with
 166    `set print thread-events'.  */
 167 extern int print_thread_events;
 168
 169 extern void print_thread_info (struct ui_out *uiout, int thread);
 170
 171 extern struct cleanup *make_cleanup_restore_current_thread (ptid_t,
 172                                                             struct frame_id);
 173
 174
 175 #endif /* GDBTHREAD_H */