gdb/gdbthread.h

   1 /* Multi-process/thread control defs for GDB, the GNU debugger.
   2    Copyright (C) 1987-2020 Free Software Foundation, Inc.
   3    Contributed by Lynx Real-Time Systems, Inc.  Los Gatos, CA.
   4
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GDBTHREAD_H
  22 #define GDBTHREAD_H
  23
  24 struct symtab;
  25
  26 #include "breakpoint.h"
  27 #include "frame.h"
  28 #include "ui-out.h"
  29 #include "btrace.h"
  30 #include "target/waitstatus.h"
  31 #include "cli/cli-utils.h"
  32 #include "gdbsupport/refcounted-object.h"
  33 #include "gdbsupport/common-gdbthread.h"
  34 #include "gdbsupport/forward-scope-exit.h"
  35
  36 struct inferior;
  37 struct process_stratum_target;
  38
  39 /* Frontend view of the thread state.  Possible extensions: stepping,
  40    finishing, until(ling),...
  41
  42    NOTE: Since the thread state is not a boolean, most times, you do
  43    not want to check it with negation.  If you really want to check if
  44    the thread is stopped,
  45
  46     use (good):
  47
  48      if (tp->state == THREAD_STOPPED)
  49
  50     instead of (bad):
  51
  52      if (tp->state != THREAD_RUNNING)
  53
  54    The latter is also true for exited threads, most likely not what
  55    you want.  */
  56 enum thread_state
  57 {
  58   /* In the frontend's perpective, the thread is stopped.  */
  59   THREAD_STOPPED,
  60
  61   /* In the frontend's perpective, the thread is running.  */
  62   THREAD_RUNNING,
  63
  64   /* The thread is listed, but known to have exited.  We keep it
  65      listed (but not visible) until it's safe to delete it.  */
  66   THREAD_EXITED,
  67 };
  68
  69 /* STEP_OVER_ALL means step over all subroutine calls.
  70    STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
  71    STEP_OVER_NONE means don't step over any subroutine calls.  */
  72
  73 enum step_over_calls_kind
  74   {
  75     STEP_OVER_NONE,
  76     STEP_OVER_ALL,
  77     STEP_OVER_UNDEBUGGABLE
  78   };
  79
  80 /* Inferior thread specific part of `struct infcall_control_state'.
  81
  82    Inferior process counterpart is `struct inferior_control_state'.  */
  83
  84 struct thread_control_state
  85 {
  86   /* User/external stepping state.  */
  87
  88   /* Step-resume or longjmp-resume breakpoint.  */
  89   struct breakpoint *step_resume_breakpoint = nullptr;
  90
  91   /* Exception-resume breakpoint.  */
  92   struct breakpoint *exception_resume_breakpoint = nullptr;
  93
  94   /* Breakpoints used for software single stepping.  Plural, because
  95      it may have multiple locations.  E.g., if stepping over a
  96      conditional branch instruction we can't decode the condition for,
  97      we'll need to put a breakpoint at the branch destination, and
  98      another at the instruction after the branch.  */
  99   struct breakpoint *single_step_breakpoints = nullptr;
 100
 101   /* Range to single step within.
 102
 103      If this is nonzero, respond to a single-step signal by continuing
 104      to step if the pc is in this range.
 105
 106      If step_range_start and step_range_end are both 1, it means to
 107      step for a single instruction (FIXME: it might clean up
 108      wait_for_inferior in a minor way if this were changed to the
 109      address of the instruction and that address plus one.  But maybe
 110      not).  */
 111   CORE_ADDR step_range_start = 0;       /* Inclusive */
 112   CORE_ADDR step_range_end = 0;         /* Exclusive */
 113
 114   /* Function the thread was in as of last it started stepping.  */
 115   struct symbol *step_start_function = nullptr;
 116
 117   /* If GDB issues a target step request, and this is nonzero, the
 118      target should single-step this thread once, and then continue
 119      single-stepping it without GDB core involvement as long as the
 120      thread stops in the step range above.  If this is zero, the
 121      target should ignore the step range, and only issue one single
 122      step.  */
 123   int may_range_step = 0;
 124
 125   /* Stack frame address as of when stepping command was issued.
 126      This is how we know when we step into a subroutine call, and how
 127      to set the frame for the breakpoint used to step out.  */
 128   struct frame_id step_frame_id {};
 129
 130   /* Similarly, the frame ID of the underlying stack frame (skipping
 131      any inlined frames).  */
 132   struct frame_id step_stack_frame_id {};
 133
 134   /* True if the the thread is presently stepping over a breakpoint or
 135      a watchpoint, either with an inline step over or a displaced (out
 136      of line) step, and we're now expecting it to report a trap for
 137      the finished single step.  */
 138   int trap_expected = 0;
 139
 140   /* Nonzero if the thread is being proceeded for a "finish" command
 141      or a similar situation when return value should be printed.  */
 142   int proceed_to_finish = 0;
 143
 144   /* Nonzero if the thread is being proceeded for an inferior function
 145      call.  */
 146   int in_infcall = 0;
 147
 148   enum step_over_calls_kind step_over_calls = STEP_OVER_NONE;
 149
 150   /* Nonzero if stopped due to a step command.  */
 151   int stop_step = 0;
 152
 153   /* Chain containing status of breakpoint(s) the thread stopped
 154      at.  */
 155   bpstat stop_bpstat = nullptr;
 156
 157   /* Whether the command that started the thread was a stepping
 158      command.  This is used to decide whether "set scheduler-locking
 159      step" behaves like "on" or "off".  */
 160   int stepping_command = 0;
 161 };
 162
 163 /* Inferior thread specific part of `struct infcall_suspend_state'.  */
 164
 165 struct thread_suspend_state
 166 {
 167   /* Last signal that the inferior received (why it stopped).  When
 168      the thread is resumed, this signal is delivered.  Note: the
 169      target should not check whether the signal is in pass state,
 170      because the signal may have been explicitly passed with the
 171      "signal" command, which overrides "handle nopass".  If the signal
 172      should be suppressed, the core will take care of clearing this
 173      before the target is resumed.  */
 174   enum gdb_signal stop_signal = GDB_SIGNAL_0;
 175
 176   /* The reason the thread last stopped, if we need to track it
 177      (breakpoint, watchpoint, etc.)  */
 178   enum target_stop_reason stop_reason = TARGET_STOPPED_BY_NO_REASON;
 179
 180   /* The waitstatus for this thread's last event.  */
 181   struct target_waitstatus waitstatus {};
 182   /* If true WAITSTATUS hasn't been handled yet.  */
 183   int waitstatus_pending_p = 0;
 184
 185   /* Record the pc of the thread the last time it stopped.  (This is
 186      not the current thread's PC as that may have changed since the
 187      last stop, e.g., "return" command, or "p $pc = 0xf000").
 188
 189      - If the thread's PC has not changed since the thread last
 190        stopped, then proceed skips a breakpoint at the current PC,
 191        otherwise we let the thread run into the breakpoint.
 192
 193      - If the thread has an unprocessed event pending, as indicated by
 194        waitstatus_pending_p, this is used in coordination with
 195        stop_reason: if the thread's PC has changed since the thread
 196        last stopped, a pending breakpoint waitstatus is discarded.
 197
 198      - If the thread is running, this is set to -1, to avoid leaving
 199        it with a stale value, to make it easier to catch bugs.  */
 200   CORE_ADDR stop_pc = 0;
 201 };
 202
 203 /* Base class for target-specific thread data.  */
 204 struct private_thread_info
 205 {
 206   virtual ~private_thread_info () = 0;
 207 };
 208
 209 /* Threads are intrusively refcounted objects.  Being the
 210    user-selected thread is normally considered an implicit strong
 211    reference and is thus not accounted in the refcount, unlike
 212    inferior objects.  This is necessary, because there's no "current
 213    thread" pointer.  Instead the current thread is inferred from the
 214    inferior_ptid global.  However, when GDB needs to remember the
 215    selected thread to later restore it, GDB bumps the thread object's
 216    refcount, to prevent something deleting the thread object before
 217    reverting back (e.g., due to a "kill" command).  If the thread
 218    meanwhile exits before being re-selected, then the thread object is
 219    left listed in the thread list, but marked with state
 220    THREAD_EXITED.  (See scoped_restore_current_thread and
 221    delete_thread).  All other thread references are considered weak
 222    references.  Placing a thread in the thread list is an implicit
 223    strong reference, and is thus not accounted for in the thread's
 224    refcount.  */
 225
 226 class thread_info : public refcounted_object
 227 {
 228 public:
 229   explicit thread_info (inferior *inf, ptid_t ptid);
 230   ~thread_info ();
 231
 232   bool deletable () const;
 233
 234   /* Mark this thread as running and notify observers.  */
 235   void set_running (bool running);
 236
 237   struct thread_info *next = NULL;
 238   ptid_t ptid;                  /* "Actual process id";
 239                                     In fact, this may be overloaded with
 240                                     kernel thread id, etc.  */
 241
 242   /* Each thread has two GDB IDs.
 243
 244      a) The thread ID (Id).  This consists of the pair of:
 245
 246         - the number of the thread's inferior and,
 247
 248         - the thread's thread number in its inferior, aka, the
 249           per-inferior thread number.  This number is unique in the
 250           inferior but not unique between inferiors.
 251
 252      b) The global ID (GId).  This is a a single integer unique
 253         between all inferiors.
 254
 255      E.g.:
 256
 257       (gdb) info threads -gid
 258         Id    GId   Target Id   Frame
 259       * 1.1   1     Thread A    0x16a09237 in foo () at foo.c:10
 260         1.2   3     Thread B    0x15ebc6ed in bar () at foo.c:20
 261         1.3   5     Thread C    0x15ebc6ed in bar () at foo.c:20
 262         2.1   2     Thread A    0x16a09237 in foo () at foo.c:10
 263         2.2   4     Thread B    0x15ebc6ed in bar () at foo.c:20
 264         2.3   6     Thread C    0x15ebc6ed in bar () at foo.c:20
 265
 266      Above, both inferiors 1 and 2 have threads numbered 1-3, but each
 267      thread has its own unique global ID.  */
 268
 269   /* The thread's global GDB thread number.  This is exposed to MI,
 270      Python/Scheme, visible with "info threads -gid", and is also what
 271      the $_gthread convenience variable is bound to.  */
 272   int global_num;
 273
 274   /* The per-inferior thread number.  This is unique in the inferior
 275      the thread belongs to, but not unique between inferiors.  This is
 276      what the $_thread convenience variable is bound to.  */
 277   int per_inf_num;
 278
 279   /* The inferior this thread belongs to.  */
 280   struct inferior *inf;
 281
 282   /* The name of the thread, as specified by the user.  This is NULL
 283      if the thread does not have a user-given name.  */
 284   char *name = NULL;
 285
 286   /* True means the thread is executing.  Note: this is different
 287      from saying that there is an active target and we are stopped at
 288      a breakpoint, for instance.  This is a real indicator whether the
 289      thread is off and running.  */
 290   bool executing = false;
 291
 292   /* True if this thread is resumed from infrun's perspective.
 293      Note that a thread can be marked both as not-executing and
 294      resumed at the same time.  This happens if we try to resume a
 295      thread that has a wait status pending.  We shouldn't let the
 296      thread really run until that wait status has been processed, but
 297      we should not process that wait status if we didn't try to let
 298      the thread run.  */
 299   bool resumed = false;
 300
 301   /* Frontend view of the thread state.  Note that the THREAD_RUNNING/
 302      THREAD_STOPPED states are different from EXECUTING.  When the
 303      thread is stopped internally while handling an internal event,
 304      like a software single-step breakpoint, EXECUTING will be false,
 305      but STATE will still be THREAD_RUNNING.  */
 306   enum thread_state state = THREAD_STOPPED;
 307
 308   /* State of GDB control of inferior thread execution.
 309      See `struct thread_control_state'.  */
 310   thread_control_state control;
 311
 312   /* State of inferior thread to restore after GDB is done with an inferior
 313      call.  See `struct thread_suspend_state'.  */
 314   thread_suspend_state suspend;
 315
 316   int current_line = 0;
 317   struct symtab *current_symtab = NULL;
 318
 319   /* Internal stepping state.  */
 320
 321   /* Record the pc of the thread the last time it was resumed.  (It
 322      can't be done on stop as the PC may change since the last stop,
 323      e.g., "return" command, or "p $pc = 0xf000").  This is maintained
 324      by proceed and keep_going, and among other things, it's used in
 325      adjust_pc_after_break to distinguish a hardware single-step
 326      SIGTRAP from a breakpoint SIGTRAP.  */
 327   CORE_ADDR prev_pc = 0;
 328
 329   /* Did we set the thread stepping a breakpoint instruction?  This is
 330      used in conjunction with PREV_PC to decide whether to adjust the
 331      PC.  */
 332   int stepped_breakpoint = 0;
 333
 334   /* Should we step over breakpoint next time keep_going is called?  */
 335   int stepping_over_breakpoint = 0;
 336
 337   /* Should we step over a watchpoint next time keep_going is called?
 338      This is needed on targets with non-continuable, non-steppable
 339      watchpoints.  */
 340   int stepping_over_watchpoint = 0;
 341
 342   /* Set to TRUE if we should finish single-stepping over a breakpoint
 343      after hitting the current step-resume breakpoint.  The context here
 344      is that GDB is to do `next' or `step' while signal arrives.
 345      When stepping over a breakpoint and signal arrives, GDB will attempt
 346      to skip signal handler, so it inserts a step_resume_breakpoint at the
 347      signal return address, and resume inferior.
 348      step_after_step_resume_breakpoint is set to TRUE at this moment in
 349      order to keep GDB in mind that there is still a breakpoint to step over
 350      when GDB gets back SIGTRAP from step_resume_breakpoint.  */
 351   int step_after_step_resume_breakpoint = 0;
 352
 353   /* Pointer to the state machine manager object that handles what is
 354      left to do for the thread's execution command after the target
 355      stops.  Several execution commands use it.  */
 356   struct thread_fsm *thread_fsm = NULL;
 357
 358   /* This is used to remember when a fork or vfork event was caught by
 359      a catchpoint, and thus the event is to be followed at the next
 360      resume of the thread, and not immediately.  */
 361   struct target_waitstatus pending_follow;
 362
 363   /* True if this thread has been explicitly requested to stop.  */
 364   int stop_requested = 0;
 365
 366   /* The initiating frame of a nexting operation, used for deciding
 367      which exceptions to intercept.  If it is null_frame_id no
 368      bp_longjmp or bp_exception but longjmp has been caught just for
 369      bp_longjmp_call_dummy.  */
 370   struct frame_id initiating_frame = null_frame_id;
 371
 372   /* Private data used by the target vector implementation.  */
 373   std::unique_ptr<private_thread_info> priv;
 374
 375   /* Branch trace information for this thread.  */
 376   struct btrace_thread_info btrace {};
 377
 378   /* Flag which indicates that the stack temporaries should be stored while
 379      evaluating expressions.  */
 380   bool stack_temporaries_enabled = false;
 381
 382   /* Values that are stored as temporaries on stack while evaluating
 383      expressions.  */
 384   std::vector<struct value *> stack_temporaries;
 385
 386   /* Step-over chain.  A thread is in the step-over queue if these are
 387      non-NULL.  If only a single thread is in the chain, then these
 388      fields point to self.  */
 389   struct thread_info *step_over_prev = NULL;
 390   struct thread_info *step_over_next = NULL;
 391 };
 392
 393 /* A gdb::ref_ptr pointer to a thread_info.  */
 394
 395 using thread_info_ref
 396   = gdb::ref_ptr<struct thread_info, refcounted_object_ref_policy>;
 397
 398 /* Create an empty thread list, or empty the existing one.  */
 399 extern void init_thread_list (void);
 400
 401 /* Add a thread to the thread list, print a message
 402    that a new thread is found, and return the pointer to
 403    the new thread.  Caller my use this pointer to
 404    initialize the private thread data.  */
 405 extern struct thread_info *add_thread (process_stratum_target *targ,
 406                                        ptid_t ptid);
 407
 408 /* Same as add_thread, but does not print a message about new
 409    thread.  */
 410 extern struct thread_info *add_thread_silent (process_stratum_target *targ,
 411                                               ptid_t ptid);
 412
 413 /* Same as add_thread, and sets the private info.  */
 414 extern struct thread_info *add_thread_with_info (process_stratum_target *targ,
 415                                                  ptid_t ptid,
 416                                                  private_thread_info *);
 417
 418 /* Delete thread THREAD and notify of thread exit.  If the thread is
 419    currently not deletable, don't actually delete it but still tag it
 420    as exited and do the notification.  */
 421 extern void delete_thread (struct thread_info *thread);
 422
 423 /* Like delete_thread, but be quiet about it.  Used when the process
 424    this thread belonged to has already exited, for example.  */
 425 extern void delete_thread_silent (struct thread_info *thread);
 426
 427 /* Delete a step_resume_breakpoint from the thread database.  */
 428 extern void delete_step_resume_breakpoint (struct thread_info *);
 429
 430 /* Delete an exception_resume_breakpoint from the thread database.  */
 431 extern void delete_exception_resume_breakpoint (struct thread_info *);
 432
 433 /* Delete the single-step breakpoints of thread TP, if any.  */
 434 extern void delete_single_step_breakpoints (struct thread_info *tp);
 435
 436 /* Check if the thread has software single stepping breakpoints
 437    set.  */
 438 extern int thread_has_single_step_breakpoints_set (struct thread_info *tp);
 439
 440 /* Check whether the thread has software single stepping breakpoints
 441    set at PC.  */
 442 extern int thread_has_single_step_breakpoint_here (struct thread_info *tp,
 443                                                    const address_space *aspace,
 444                                                    CORE_ADDR addr);
 445
 446 /* Returns whether to show inferior-qualified thread IDs, or plain
 447    thread numbers.  Inferior-qualified IDs are shown whenever we have
 448    multiple inferiors, or the only inferior left has number > 1.  */
 449 extern int show_inferior_qualified_tids (void);
 450
 451 /* Return a string version of THR's thread ID.  If there are multiple
 452    inferiors, then this prints the inferior-qualifier form, otherwise
 453    it only prints the thread number.  The result is stored in a
 454    circular static buffer, NUMCELLS deep.  */
 455 const char *print_thread_id (struct thread_info *thr);
 456
 457 /* Boolean test for an already-known ptid.  */
 458 extern bool in_thread_list (process_stratum_target *targ, ptid_t ptid);
 459
 460 /* Boolean test for an already-known global thread id (GDB's homegrown
 461    global id, not the system's).  */
 462 extern int valid_global_thread_id (int global_id);
 463
 464 /* Find (non-exited) thread PTID of inferior INF.  */
 465 extern thread_info *find_thread_ptid (inferior *inf, ptid_t ptid);
 466
 467 /* Search function to lookup a (non-exited) thread by 'ptid'.  */
 468 extern struct thread_info *find_thread_ptid (process_stratum_target *targ,
 469                                              ptid_t ptid);
 470
 471 /* Search function to lookup a (non-exited) thread by 'ptid'.  Only
 472    searches in threads of INF.  */
 473 extern struct thread_info *find_thread_ptid (inferior *inf, ptid_t ptid);
 474
 475 /* Find thread by GDB global thread ID.  */
 476 struct thread_info *find_thread_global_id (int global_id);
 477
 478 /* Find thread by thread library specific handle in inferior INF.  */
 479 struct thread_info *find_thread_by_handle
 480   (gdb::array_view<const gdb_byte> handle, struct inferior *inf);
 481
 482 /* Finds the first thread of the specified inferior.  */
 483 extern struct thread_info *first_thread_of_inferior (inferior *inf);
 484
 485 /* Returns any thread of inferior INF, giving preference to the
 486    current thread.  */
 487 extern struct thread_info *any_thread_of_inferior (inferior *inf);
 488
 489 /* Returns any non-exited thread of inferior INF, giving preference to
 490    the current thread, and to not executing threads.  */
 491 extern struct thread_info *any_live_thread_of_inferior (inferior *inf);
 492
 493 /* Change the ptid of thread OLD_PTID to NEW_PTID.  */
 494 void thread_change_ptid (process_stratum_target *targ,
 495                          ptid_t old_ptid, ptid_t new_ptid);
 496
 497 /* Iterator function to call a user-provided callback function
 498    once for each known thread.  */
 499 typedef int (*thread_callback_func) (struct thread_info *, void *);
 500 extern struct thread_info *iterate_over_threads (thread_callback_func, void *);
 501
 502 /* Pull in the internals of the inferiors/threads ranges and
 503    iterators.  Must be done after struct thread_info is defined.  */
 504 #include "thread-iter.h"
 505
 506 /* Return a range that can be used to walk over threads, with
 507    range-for.
 508
 509    Used like this, it walks over all threads of all inferiors of all
 510    targets:
 511
 512        for (thread_info *thr : all_threads ())
 513          { .... }
 514
 515    FILTER_PTID can be used to filter out threads that don't match.
 516    FILTER_PTID can be:
 517
 518    - minus_one_ptid, meaning walk all threads of all inferiors of
 519      PROC_TARGET.  If PROC_TARGET is NULL, then of all targets.
 520
 521    - A process ptid, in which case walk all threads of the specified
 522      process.  PROC_TARGET must be non-NULL in this case.
 523
 524    - A thread ptid, in which case walk that thread only.  PROC_TARGET
 525      must be non-NULL in this case.
 526 */
 527
 528 inline all_matching_threads_range
 529 all_threads (process_stratum_target *proc_target = nullptr,
 530              ptid_t filter_ptid = minus_one_ptid)
 531 {
 532   return all_matching_threads_range (proc_target, filter_ptid);
 533 }
 534
 535 /* Return a range that can be used to walk over all non-exited threads
 536    of all inferiors, with range-for.  Arguments are like all_threads
 537    above.  */
 538
 539 inline all_non_exited_threads_range
 540 all_non_exited_threads (process_stratum_target *proc_target = nullptr,
 541                         ptid_t filter_ptid = minus_one_ptid)
 542 {
 543   return all_non_exited_threads_range (proc_target, filter_ptid);
 544 }
 545
 546 /* Return a range that can be used to walk over all threads of all
 547    inferiors, with range-for, safely.  I.e., it is safe to delete the
 548    currently-iterated thread.  When combined with range-for, this
 549    allow convenient patterns like this:
 550
 551      for (thread_info *t : all_threads_safe ())
 552        if (some_condition ())
 553          delete f;
 554 */
 555
 556 inline all_threads_safe_range
 557 all_threads_safe ()
 558 {
 559   return {};
 560 }
 561
 562 extern int thread_count (process_stratum_target *proc_target);
 563
 564 /* Return true if we have any thread in any inferior.  */
 565 extern bool any_thread_p ();
 566
 567 /* Switch context to thread THR.  Also sets the STOP_PC global.  */
 568 extern void switch_to_thread (struct thread_info *thr);
 569
 570 /* Switch context to no thread selected.  */
 571 extern void switch_to_no_thread ();
 572
 573 /* Switch from one thread to another.  Does not read registers.  */
 574 extern void switch_to_thread_no_regs (struct thread_info *thread);
 575
 576 /* Marks or clears thread(s) PTID of TARG as resumed.  If PTID is
 577    MINUS_ONE_PTID, applies to all threads of TARG.  If
 578    ptid_is_pid(PTID) is true, applies to all threads of the process
 579    pointed at by {TARG,PTID}.  */
 580 extern void set_resumed (process_stratum_target *targ,
 581                          ptid_t ptid, bool resumed);
 582
 583 /* Marks thread PTID of TARG as running, or as stopped.  If PTID is
 584    minus_one_ptid, marks all threads of TARG.  */
 585 extern void set_running (process_stratum_target *targ,
 586                          ptid_t ptid, bool running);
 587
 588 /* Marks or clears thread(s) PTID of TARG as having been requested to
 589    stop.  If PTID is MINUS_ONE_PTID, applies to all threads of TARG.
 590    If ptid_is_pid(PTID) is true, applies to all threads of the process
 591    pointed at by {TARG, PTID}.  If STOP, then the
 592    THREAD_STOP_REQUESTED observer is called with PTID as argument.  */
 593 extern void set_stop_requested (process_stratum_target *targ,
 594                                 ptid_t ptid, bool stop);
 595
 596 /* Marks thread PTID of TARG as executing, or not.  If PTID is
 597    minus_one_ptid, marks all threads of TARG.
 598
 599    Note that this is different from the running state.  See the
 600    description of state and executing fields of struct
 601    thread_info.  */
 602 extern void set_executing (process_stratum_target *targ,
 603                            ptid_t ptid, bool executing);
 604
 605 /* True if any (known or unknown) thread of TARG is or may be
 606    executing.  */
 607 extern bool threads_are_executing (process_stratum_target *targ);
 608
 609 /* Merge the executing property of thread PTID of TARG over to its
 610    thread state property (frontend running/stopped view).
 611
 612    "not executing" -> "stopped"
 613    "executing"     -> "running"
 614    "exited"        -> "exited"
 615
 616    If PTID is minus_one_ptid, go over all threads of TARG.
 617
 618    Notifications are only emitted if the thread state did change.  */
 619 extern void finish_thread_state (process_stratum_target *targ, ptid_t ptid);
 620
 621 /* Calls finish_thread_state on scope exit, unless release() is called
 622    to disengage.  */
 623 using scoped_finish_thread_state
 624   = FORWARD_SCOPE_EXIT (finish_thread_state);
 625
 626 /* Commands with a prefix of `thread'.  */
 627 extern struct cmd_list_element *thread_cmd_list;
 628
 629 extern void thread_command (const char *tidstr, int from_tty);
 630
 631 /* Print notices on thread events (attach, detach, etc.), set with
 632    `set print thread-events'.  */
 633 extern bool print_thread_events;
 634
 635 /* Prints the list of threads and their details on UIOUT.  If
 636    REQUESTED_THREADS, a list of GDB ids/ranges, is not NULL, only
 637    print threads whose ID is included in the list.  If PID is not -1,
 638    only print threads from the process PID.  Otherwise, threads from
 639    all attached PIDs are printed.  If both REQUESTED_THREADS is not
 640    NULL and PID is not -1, then the thread is printed if it belongs to
 641    the specified process.  Otherwise, an error is raised.  */
 642 extern void print_thread_info (struct ui_out *uiout,
 643                                const char *requested_threads,
 644                                int pid);
 645
 646 /* Save/restore current inferior/thread/frame.  */
 647
 648 class scoped_restore_current_thread
 649 {
 650 public:
 651   scoped_restore_current_thread ();
 652   ~scoped_restore_current_thread ();
 653
 654   DISABLE_COPY_AND_ASSIGN (scoped_restore_current_thread);
 655
 656   /* Cancel restoring on scope exit.  */
 657   void dont_restore () { m_dont_restore = true; }
 658
 659 private:
 660   void restore ();
 661
 662   bool m_dont_restore = false;
 663   /* Use the "class" keyword here, because of a clash with a "thread_info"
 664      function in the Darwin API.  */
 665   class thread_info *m_thread;
 666   inferior *m_inf;
 667   frame_id m_selected_frame_id;
 668   int m_selected_frame_level;
 669   bool m_was_stopped;
 670 };
 671
 672 /* Returns a pointer into the thread_info corresponding to
 673    INFERIOR_PTID.  INFERIOR_PTID *must* be in the thread list.  */
 674 extern struct thread_info* inferior_thread (void);
 675
 676 extern void update_thread_list (void);
 677
 678 /* Delete any thread the target says is no longer alive.  */
 679
 680 extern void prune_threads (void);
 681
 682 /* Delete threads marked THREAD_EXITED.  Unlike prune_threads, this
 683    does not consult the target about whether the thread is alive right
 684    now.  */
 685 extern void delete_exited_threads (void);
 686
 687 /* Return true if PC is in the stepping range of THREAD.  */
 688
 689 int pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread);
 690
 691 /* Enable storing stack temporaries for thread THR and disable and
 692    clear the stack temporaries on destruction.  Holds a strong
 693    reference to THR.  */
 694
 695 class enable_thread_stack_temporaries
 696 {
 697 public:
 698
 699   explicit enable_thread_stack_temporaries (struct thread_info *thr)
 700     : m_thr (thr)
 701   {
 702     gdb_assert (m_thr != NULL);
 703
 704     m_thr->incref ();
 705
 706     m_thr->stack_temporaries_enabled = true;
 707     m_thr->stack_temporaries.clear ();
 708   }
 709
 710   ~enable_thread_stack_temporaries ()
 711   {
 712     m_thr->stack_temporaries_enabled = false;
 713     m_thr->stack_temporaries.clear ();
 714
 715     m_thr->decref ();
 716   }
 717
 718   DISABLE_COPY_AND_ASSIGN (enable_thread_stack_temporaries);
 719
 720 private:
 721
 722   struct thread_info *m_thr;
 723 };
 724
 725 extern bool thread_stack_temporaries_enabled_p (struct thread_info *tp);
 726
 727 extern void push_thread_stack_temporary (struct thread_info *tp, struct value *v);
 728
 729 extern value *get_last_thread_stack_temporary (struct thread_info *tp);
 730
 731 extern bool value_in_thread_stack_temporaries (struct value *,
 732                                                struct thread_info *thr);
 733
 734 /* Add TP to the end of the global pending step-over chain.  */
 735
 736 extern void global_thread_step_over_chain_enqueue (struct thread_info *tp);
 737
 738 /* Remove TP from the global pending step-over chain.  */
 739
 740 extern void global_thread_step_over_chain_remove (struct thread_info *tp);
 741
 742 /* Return the next thread in the global step-over chain.  NULL
 743    if TP is the last entry in the chain.  */
 744
 745 extern struct thread_info *global_thread_step_over_chain_next (struct thread_info *tp);
 746
 747 /* Return true if TP is in any step-over chain.  */
 748
 749 extern int thread_is_in_step_over_chain (struct thread_info *tp);
 750
 751 /* Cancel any ongoing execution command.  */
 752
 753 extern void thread_cancel_execution_command (struct thread_info *thr);
 754
 755 /* Check whether it makes sense to access a register of the current
 756    thread at this point.  If not, throw an error (e.g., the thread is
 757    executing).  */
 758 extern void validate_registers_access (void);
 759
 760 /* Check whether it makes sense to access a register of THREAD at this point.
 761    Returns true if registers may be accessed; false otherwise.  */
 762 extern bool can_access_registers_thread (struct thread_info *thread);
 763
 764 /* Returns whether to show which thread hit the breakpoint, received a
 765    signal, etc. and ended up causing a user-visible stop.  This is
 766    true iff we ever detected multiple threads.  */
 767 extern int show_thread_that_caused_stop (void);
 768
 769 /* Print the message for a thread or/and frame selected.  */
 770 extern void print_selected_thread_frame (struct ui_out *uiout,
 771                                          user_selected_what selection);
 772
 773 /* Helper for the CLI's "thread" command and for MI's -thread-select.
 774    Selects thread THR.  TIDSTR is the original string the thread ID
 775    was parsed from.  This is used in the error message if THR is not
 776    alive anymore.  */
 777 extern void thread_select (const char *tidstr, class thread_info *thr);
 778
 779 #endif /* GDBTHREAD_H */