gdb/gdbthread.h

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