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, 2009, 2010 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 symtab;
  26
  27 #include "breakpoint.h"
  28 #include "frame.h"
  29 #include "ui-out.h"
  30 #include "inferior.h"
  31
  32 /* Inferior thread specific part of `struct infcall_control_state'.
  33
  34    Inferior process counterpart is `struct inferior_control_state'.  */
  35
  36 struct thread_control_state
  37 {
  38   /* User/external stepping state.  */
  39
  40   /* Step-resume or longjmp-resume breakpoint.  */
  41   struct breakpoint *step_resume_breakpoint;
  42
  43   /* Exception-resume breakpoint.  */
  44   struct breakpoint *exception_resume_breakpoint;
  45
  46   /* Range to single step within.
  47
  48      If this is nonzero, respond to a single-step signal by continuing
  49      to step if the pc is in this range.
  50
  51      If step_range_start and step_range_end are both 1, it means to
  52      step for a single instruction (FIXME: it might clean up
  53      wait_for_inferior in a minor way if this were changed to the
  54      address of the instruction and that address plus one.  But maybe
  55      not.).  */
  56   CORE_ADDR step_range_start;   /* Inclusive */
  57   CORE_ADDR step_range_end;     /* Exclusive */
  58
  59   /* Stack frame address as of when stepping command was issued.
  60      This is how we know when we step into a subroutine call, and how
  61      to set the frame for the breakpoint used to step out.  */
  62   struct frame_id step_frame_id;
  63
  64   /* Similarly, the frame ID of the underlying stack frame (skipping
  65      any inlined frames).  */
  66   struct frame_id step_stack_frame_id;
  67
  68   /* Nonzero if we are presently stepping over a breakpoint.
  69
  70      If we hit a breakpoint or watchpoint, and then continue, we need
  71      to single step the current thread with breakpoints disabled, to
  72      avoid hitting the same breakpoint or watchpoint again.  And we
  73      should step just a single thread and keep other threads stopped,
  74      so that other threads don't miss breakpoints while they are
  75      removed.
  76
  77      So, this variable simultaneously means that we need to single
  78      step the current thread, keep other threads stopped, and that
  79      breakpoints should be removed while we step.
  80
  81      This variable is set either:
  82      - in proceed, when we resume inferior on user's explicit request
  83      - in keep_going, if handle_inferior_event decides we need to
  84      step over breakpoint.
  85
  86      The variable is cleared in normal_stop.  The proceed calls
  87      wait_for_inferior, which calls handle_inferior_event in a loop,
  88      and until wait_for_inferior exits, this variable is changed only
  89      by keep_going.  */
  90   int trap_expected;
  91
  92   /* Nonzero if the thread is being proceeded for a "finish" command
  93      or a similar situation when stop_registers should be saved.  */
  94   int proceed_to_finish;
  95
  96   /* Nonzero if the thread is being proceeded for an inferior function
  97      call.  */
  98   int in_infcall;
  99
 100   enum step_over_calls_kind step_over_calls;
 101
 102   /* Nonzero if stopped due to a step command.  */
 103   int stop_step;
 104
 105   /* Chain containing status of breakpoint(s) the thread stopped
 106      at.  */
 107   bpstat stop_bpstat;
 108 };
 109
 110 /* Inferior thread specific part of `struct infcall_suspend_state'.
 111
 112    Inferior process counterpart is `struct inferior_suspend_state'.  */
 113
 114 struct thread_suspend_state
 115 {
 116   /* Last signal that the inferior received (why it stopped).  */
 117   enum target_signal stop_signal;
 118 };
 119
 120 struct thread_info
 121 {
 122   struct thread_info *next;
 123   ptid_t ptid;                  /* "Actual process id";
 124                                     In fact, this may be overloaded with
 125                                     kernel thread id, etc.  */
 126   int num;                      /* Convenient handle (GDB thread id) */
 127
 128   /* Non-zero means the thread is executing.  Note: this is different
 129      from saying that there is an active target and we are stopped at
 130      a breakpoint, for instance.  This is a real indicator whether the
 131      thread is off and running.  */
 132   /* This field is internal to thread.c.  Never access it directly,
 133      use is_executing instead.  */
 134   int executing_;
 135
 136   /* Frontend view of the thread state.  Note that the RUNNING/STOPPED
 137      states are different from EXECUTING.  When the thread is stopped
 138      internally while handling an internal event, like a software
 139      single-step breakpoint, EXECUTING will be false, but running will
 140      still be true.  As a possible future extension, this could turn
 141      into enum { stopped, exited, stepping, finishing, until(ling),
 142      running ... }  */
 143   /* This field is internal to thread.c.  Never access it directly,
 144      use is_running instead.  */
 145   int state_;
 146
 147   /* If this is > 0, then it means there's code out there that relies
 148      on this thread being listed.  Don't delete it from the lists even
 149      if we detect it exiting.  */
 150   int refcount;
 151
 152   /* State of GDB control of inferior thread execution.
 153      See `struct thread_control_state'.  */
 154   struct thread_control_state control;
 155
 156   /* State of inferior thread to restore after GDB is done with an inferior
 157      call.  See `struct thread_suspend_state'.  */
 158   struct thread_suspend_state suspend;
 159
 160   int current_line;
 161   struct symtab *current_symtab;
 162
 163   /* Internal stepping state.  */
 164
 165   /* Record the pc of the thread the last time it stopped.  This is
 166      maintained by proceed and keep_going, and used in
 167      adjust_pc_after_break to distinguish a hardware single-step
 168      SIGTRAP from a breakpoint SIGTRAP.  */
 169   CORE_ADDR prev_pc;
 170
 171   /* Should we step over breakpoint next time keep_going is called?  */
 172   int stepping_over_breakpoint;
 173
 174   /* Set to TRUE if we should finish single-stepping over a breakpoint
 175      after hitting the current step-resume breakpoint.  */
 176   int step_after_step_resume_breakpoint;
 177
 178   /* This is set TRUE when a catchpoint of a shared library event
 179      triggers.  Since we don't wish to leave the inferior in the
 180      solib hook when we report the event, we step the inferior
 181      back to user code before stopping and reporting the event.  */
 182   int stepping_through_solib_after_catch;
 183
 184   /* When stepping_through_solib_after_catch is TRUE, this is a
 185      list of the catchpoints that should be reported as triggering
 186      when we finally do stop stepping.  */
 187   bpstat stepping_through_solib_catchpoints;
 188
 189   /* Per-thread command support.  */
 190
 191   /* Pointer to what is left to do for an execution command after the
 192      target stops.  Used only in asynchronous mode, by targets that
 193      support async execution.  Several execution commands use it.  */
 194   struct continuation *continuations;
 195
 196   /* Similar to the above, but used when a single execution command
 197      requires several resume/stop iterations.  Used by the step
 198      command.  */
 199   struct continuation *intermediate_continuations;
 200
 201   /* If stepping, nonzero means step count is > 1 so don't print frame
 202      next time inferior stops if it stops due to stepping.  */
 203   int step_multi;
 204
 205   /* This is used to remember when a fork or vfork event was caught by
 206      a catchpoint, and thus the event is to be followed at the next
 207      resume of the thread, and not immediately.  */
 208   struct target_waitstatus pending_follow;
 209
 210   /* True if this thread has been explicitly requested to stop.  */
 211   int stop_requested;
 212
 213   /* The initiating frame of a nexting operation, used for deciding
 214      which exceptions to intercept.  */
 215   struct frame_id initiating_frame;
 216
 217   /* Private data used by the target vector implementation.  */
 218   struct private_thread_info *private;
 219
 220   /* Function that is called to free PRIVATE.  If this is NULL, then
 221      xfree will be called on PRIVATE.  */
 222   void (*private_dtor) (struct private_thread_info *);
 223 };
 224
 225 /* Create an empty thread list, or empty the existing one.  */
 226 extern void init_thread_list (void);
 227
 228 /* Add a thread to the thread list, print a message
 229    that a new thread is found, and return the pointer to
 230    the new thread.  Caller my use this pointer to
 231    initialize the private thread data.  */
 232 extern struct thread_info *add_thread (ptid_t ptid);
 233
 234 /* Same as add_thread, but does not print a message
 235    about new thread.  */
 236 extern struct thread_info *add_thread_silent (ptid_t ptid);
 237
 238 /* Same as add_thread, and sets the private info.  */
 239 extern struct thread_info *add_thread_with_info (ptid_t ptid,
 240                                                  struct private_thread_info *);
 241
 242 /* Delete an existing thread list entry.  */
 243 extern void delete_thread (ptid_t);
 244
 245 /* Delete an existing thread list entry, and be quiet about it.  Used
 246    after the process this thread having belonged to having already
 247    exited, for example.  */
 248 extern void delete_thread_silent (ptid_t);
 249
 250 /* Delete a step_resume_breakpoint from the thread database. */
 251 extern void delete_step_resume_breakpoint (struct thread_info *);
 252
 253 /* Delete an exception_resume_breakpoint from the thread database. */
 254 extern void delete_exception_resume_breakpoint (struct thread_info *);
 255
 256 /* Translate the integer thread id (GDB's homegrown id, not the system's)
 257    into a "pid" (which may be overloaded with extra thread information).  */
 258 extern ptid_t thread_id_to_pid (int);
 259
 260 /* Translate a 'pid' (which may be overloaded with extra thread information)
 261    into the integer thread id (GDB's homegrown id, not the system's).  */
 262 extern int pid_to_thread_id (ptid_t ptid);
 263
 264 /* Boolean test for an already-known pid (which may be overloaded with
 265    extra thread information).  */
 266 extern int in_thread_list (ptid_t ptid);
 267
 268 /* Boolean test for an already-known thread id (GDB's homegrown id,
 269    not the system's).  */
 270 extern int valid_thread_id (int thread);
 271
 272 /* Search function to lookup a thread by 'pid'.  */
 273 extern struct thread_info *find_thread_ptid (ptid_t ptid);
 274
 275 /* Find thread by GDB user-visible thread number.  */
 276 struct thread_info *find_thread_id (int num);
 277
 278 /* Finds the first thread of the inferior given by PID.  If PID is -1,
 279    returns the first thread in the list.  */
 280 struct thread_info *first_thread_of_process (int pid);
 281
 282 /* Returns any thread of process PID.  */
 283 extern struct thread_info *any_thread_of_process (int pid);
 284
 285 /* Returns any non-exited thread of process PID, giving preference for
 286    already stopped threads.  */
 287 extern struct thread_info *any_live_thread_of_process (int pid);
 288
 289 /* Change the ptid of thread OLD_PTID to NEW_PTID.  */
 290 void thread_change_ptid (ptid_t old_ptid, ptid_t new_ptid);
 291
 292 /* Iterator function to call a user-provided callback function
 293    once for each known thread.  */
 294 typedef int (*thread_callback_func) (struct thread_info *, void *);
 295 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 296
 297 extern int thread_count (void);
 298
 299 /* Switch from one thread to another.  */
 300 extern void switch_to_thread (ptid_t ptid);
 301
 302 /* Marks thread PTID is running, or stopped.
 303    If PIDGET (PTID) is -1, marks all threads.  */
 304 extern void set_running (ptid_t ptid, int running);
 305
 306 /* Marks or clears thread(s) PTID as having been requested to stop.
 307    If PTID is MINUS_ONE_PTID, applies to all threads.  If
 308    ptid_is_pid(PTID) is true, applies to all threads of the process
 309    pointed at by PTID.  If STOP, then the THREAD_STOP_REQUESTED
 310    observer is called with PTID as argument.  */
 311 extern void set_stop_requested (ptid_t ptid, int stop);
 312
 313 /* NOTE: Since the thread state is not a boolean, most times, you do
 314    not want to check it with negation.  If you really want to check if
 315    the thread is stopped,
 316
 317     use (good):
 318
 319      if (is_stopped (ptid))
 320
 321     instead of (bad):
 322
 323      if (!is_running (ptid))
 324
 325    The latter also returns true on exited threads, most likelly not
 326    what you want.  */
 327
 328 /* Reports if in the frontend's perpective, thread PTID is running.  */
 329 extern int is_running (ptid_t ptid);
 330
 331 /* Is this thread listed, but known to have exited?  We keep it listed
 332    (but not visible) until it's safe to delete.  */
 333 extern int is_exited (ptid_t ptid);
 334
 335 /* In the frontend's perpective, is this thread stopped?  */
 336 extern int is_stopped (ptid_t ptid);
 337
 338 /* In the frontend's perpective is there any thread running?  */
 339 extern int any_running (void);
 340
 341 /* Marks thread PTID as executing, or not.  If PIDGET (PTID) is -1,
 342    marks all threads.
 343
 344    Note that this is different from the running state.  See the
 345    description of state_ and executing_ fields of struct
 346    thread_info.  */
 347 extern void set_executing (ptid_t ptid, int executing);
 348
 349 /* Reports if thread PTID is executing.  */
 350 extern int is_executing (ptid_t ptid);
 351
 352 /* Merge the executing property of thread PTID over to its thread
 353    state property (frontend running/stopped view).
 354
 355    "not executing" -> "stopped"
 356    "executing"     -> "running"
 357    "exited"        -> "exited"
 358
 359    If PIDGET (PTID) is -1, go over all threads.
 360
 361    Notifications are only emitted if the thread state did change.  */
 362 extern void finish_thread_state (ptid_t ptid);
 363
 364 /* Same as FINISH_THREAD_STATE, but with an interface suitable to be
 365    registered as a cleanup.  PTID_P points to the ptid_t that is
 366    passed to FINISH_THREAD_STATE.  */
 367 extern void finish_thread_state_cleanup (void *ptid_p);
 368
 369 /* Commands with a prefix of `thread'.  */
 370 extern struct cmd_list_element *thread_cmd_list;
 371
 372 /* Print notices on thread events (attach, detach, etc.), set with
 373    `set print thread-events'.  */
 374 extern int print_thread_events;
 375
 376 extern void print_thread_info (struct ui_out *uiout, int thread,
 377                                int pid);
 378
 379 extern struct cleanup *make_cleanup_restore_current_thread (void);
 380
 381 /* Returns a pointer into the thread_info corresponding to
 382    INFERIOR_PTID.  INFERIOR_PTID *must* be in the thread list.  */
 383 extern struct thread_info* inferior_thread (void);
 384
 385 extern void update_thread_list (void);
 386
 387 #endif /* GDBTHREAD_H */