Automatic date update in version.in
[external/binutils.git] / gdb / thread.c
1 /* Multi-process/thread control for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2018 Free Software Foundation, Inc.
4
5    Contributed by Lynx Real-Time Systems, Inc.  Los Gatos, CA.
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 #include "defs.h"
23 #include "symtab.h"
24 #include "frame.h"
25 #include "inferior.h"
26 #include "environ.h"
27 #include "value.h"
28 #include "target.h"
29 #include "gdbthread.h"
30 #include "command.h"
31 #include "gdbcmd.h"
32 #include "regcache.h"
33 #include "btrace.h"
34
35 #include <ctype.h>
36 #include <sys/types.h>
37 #include <signal.h>
38 #include "ui-out.h"
39 #include "observable.h"
40 #include "annotate.h"
41 #include "cli/cli-decode.h"
42 #include "gdb_regex.h"
43 #include "cli/cli-utils.h"
44 #include "thread-fsm.h"
45 #include "tid-parse.h"
46 #include <algorithm>
47 #include "common/gdb_optional.h"
48
49 /* Definition of struct thread_info exported to gdbthread.h.  */
50
51 /* Prototypes for local functions.  */
52
53 struct thread_info *thread_list = NULL;
54 static int highest_thread_num;
55
56 /* True if any thread is, or may be executing.  We need to track this
57    separately because until we fully sync the thread list, we won't
58    know whether the target is fully stopped, even if we see stop
59    events for all known threads, because any of those threads may have
60    spawned new threads we haven't heard of yet.  */
61 static int threads_executing;
62
63 static int thread_alive (struct thread_info *);
64
65 /* RAII type used to increase / decrease the refcount of each thread
66    in a given list of threads.  */
67
68 class scoped_inc_dec_ref
69 {
70 public:
71   explicit scoped_inc_dec_ref (const std::vector<thread_info *> &thrds)
72     : m_thrds (thrds)
73   {
74     for (thread_info *thr : m_thrds)
75       thr->incref ();
76   }
77
78   ~scoped_inc_dec_ref ()
79   {
80     for (thread_info *thr : m_thrds)
81       thr->decref ();
82   }
83
84 private:
85   const std::vector<thread_info *> &m_thrds;
86 };
87
88
89 struct thread_info*
90 inferior_thread (void)
91 {
92   struct thread_info *tp = find_thread_ptid (inferior_ptid);
93   gdb_assert (tp);
94   return tp;
95 }
96
97 /* Delete the breakpoint pointed at by BP_P, if there's one.  */
98
99 static void
100 delete_thread_breakpoint (struct breakpoint **bp_p)
101 {
102   if (*bp_p != NULL)
103     {
104       delete_breakpoint (*bp_p);
105       *bp_p = NULL;
106     }
107 }
108
109 void
110 delete_step_resume_breakpoint (struct thread_info *tp)
111 {
112   if (tp != NULL)
113     delete_thread_breakpoint (&tp->control.step_resume_breakpoint);
114 }
115
116 void
117 delete_exception_resume_breakpoint (struct thread_info *tp)
118 {
119   if (tp != NULL)
120     delete_thread_breakpoint (&tp->control.exception_resume_breakpoint);
121 }
122
123 /* See gdbthread.h.  */
124
125 void
126 delete_single_step_breakpoints (struct thread_info *tp)
127 {
128   if (tp != NULL)
129     delete_thread_breakpoint (&tp->control.single_step_breakpoints);
130 }
131
132 /* Delete the breakpoint pointed at by BP_P at the next stop, if
133    there's one.  */
134
135 static void
136 delete_at_next_stop (struct breakpoint **bp)
137 {
138   if (*bp != NULL)
139     {
140       (*bp)->disposition = disp_del_at_next_stop;
141       *bp = NULL;
142     }
143 }
144
145 /* See gdbthread.h.  */
146
147 int
148 thread_has_single_step_breakpoints_set (struct thread_info *tp)
149 {
150   return tp->control.single_step_breakpoints != NULL;
151 }
152
153 /* See gdbthread.h.  */
154
155 int
156 thread_has_single_step_breakpoint_here (struct thread_info *tp,
157                                         const address_space *aspace,
158                                         CORE_ADDR addr)
159 {
160   struct breakpoint *ss_bps = tp->control.single_step_breakpoints;
161
162   return (ss_bps != NULL
163           && breakpoint_has_location_inserted_here (ss_bps, aspace, addr));
164 }
165
166 /* See gdbthread.h.  */
167
168 void
169 thread_cancel_execution_command (struct thread_info *thr)
170 {
171   if (thr->thread_fsm != NULL)
172     {
173       thread_fsm_clean_up (thr->thread_fsm, thr);
174       thread_fsm_delete (thr->thread_fsm);
175       thr->thread_fsm = NULL;
176     }
177 }
178
179 static void
180 clear_thread_inferior_resources (struct thread_info *tp)
181 {
182   /* NOTE: this will take care of any left-over step_resume breakpoints,
183      but not any user-specified thread-specific breakpoints.  We can not
184      delete the breakpoint straight-off, because the inferior might not
185      be stopped at the moment.  */
186   delete_at_next_stop (&tp->control.step_resume_breakpoint);
187   delete_at_next_stop (&tp->control.exception_resume_breakpoint);
188   delete_at_next_stop (&tp->control.single_step_breakpoints);
189
190   delete_longjmp_breakpoint_at_next_stop (tp->global_num);
191
192   bpstat_clear (&tp->control.stop_bpstat);
193
194   btrace_teardown (tp);
195
196   thread_cancel_execution_command (tp);
197 }
198
199 /* Set the TP's state as exited.  */
200
201 static void
202 set_thread_exited (thread_info *tp, int silent)
203 {
204   /* Dead threads don't need to step-over.  Remove from queue.  */
205   if (tp->step_over_next != NULL)
206     thread_step_over_chain_remove (tp);
207
208   if (tp->state != THREAD_EXITED)
209     {
210       gdb::observers::thread_exit.notify (tp, silent);
211
212       /* Tag it as exited.  */
213       tp->state = THREAD_EXITED;
214
215       /* Clear breakpoints, etc. associated with this thread.  */
216       clear_thread_inferior_resources (tp);
217     }
218 }
219
220 void
221 init_thread_list (void)
222 {
223   struct thread_info *tp, *tmp;
224
225   highest_thread_num = 0;
226
227   ALL_THREADS_SAFE (tp, tmp)
228     {
229       if (tp->deletable ())
230         delete tp;
231       else
232         set_thread_exited (tp, 1);
233     }
234
235   thread_list = NULL;
236   threads_executing = 0;
237 }
238
239 /* Allocate a new thread of inferior INF with target id PTID and add
240    it to the thread list.  */
241
242 static struct thread_info *
243 new_thread (struct inferior *inf, ptid_t ptid)
244 {
245   thread_info *tp = new thread_info (inf, ptid);
246
247   if (thread_list == NULL)
248     thread_list = tp;
249   else
250     {
251       struct thread_info *last;
252
253       for (last = thread_list; last->next != NULL; last = last->next)
254         ;
255       last->next = tp;
256     }
257
258   return tp;
259 }
260
261 struct thread_info *
262 add_thread_silent (ptid_t ptid)
263 {
264   struct thread_info *tp;
265   struct inferior *inf = find_inferior_ptid (ptid);
266   gdb_assert (inf != NULL);
267
268   tp = find_thread_ptid (ptid);
269   if (tp)
270     /* Found an old thread with the same id.  It has to be dead,
271        otherwise we wouldn't be adding a new thread with the same id.
272        The OS is reusing this id --- delete it, and recreate a new
273        one.  */
274     {
275       /* In addition to deleting the thread, if this is the current
276          thread, then we need to take care that delete_thread doesn't
277          really delete the thread if it is inferior_ptid.  Create a
278          new template thread in the list with an invalid ptid, switch
279          to it, delete the original thread, reset the new thread's
280          ptid, and switch to it.  */
281
282       if (inferior_ptid == ptid)
283         {
284           thread_info *new_thr = new_thread (inf, null_ptid);
285
286           /* Make switch_to_thread not read from the thread.  */
287           new_thr->state = THREAD_EXITED;
288           switch_to_no_thread ();
289
290           /* Now we can delete it.  */
291           delete_thread (tp);
292
293           /* Now reset its ptid, and reswitch inferior_ptid to it.  */
294           new_thr->ptid = ptid;
295           new_thr->state = THREAD_STOPPED;
296           switch_to_thread (new_thr);
297
298           gdb::observers::new_thread.notify (new_thr);
299
300           /* All done.  */
301           return new_thr;
302         }
303       else
304         /* Just go ahead and delete it.  */
305         delete_thread (tp);
306     }
307
308   tp = new_thread (inf, ptid);
309   gdb::observers::new_thread.notify (tp);
310
311   return tp;
312 }
313
314 struct thread_info *
315 add_thread_with_info (ptid_t ptid, private_thread_info *priv)
316 {
317   struct thread_info *result = add_thread_silent (ptid);
318
319   result->priv.reset (priv);
320
321   if (print_thread_events)
322     printf_unfiltered (_("[New %s]\n"), target_pid_to_str (ptid));
323
324   annotate_new_thread ();
325   return result;
326 }
327
328 struct thread_info *
329 add_thread (ptid_t ptid)
330 {
331   return add_thread_with_info (ptid, NULL);
332 }
333
334 private_thread_info::~private_thread_info () = default;
335
336 thread_info::thread_info (struct inferior *inf_, ptid_t ptid_)
337   : ptid (ptid_), inf (inf_)
338 {
339   gdb_assert (inf_ != NULL);
340
341   this->global_num = ++highest_thread_num;
342   this->per_inf_num = ++inf_->highest_thread_num;
343
344   /* Nothing to follow yet.  */
345   memset (&this->pending_follow, 0, sizeof (this->pending_follow));
346   this->pending_follow.kind = TARGET_WAITKIND_SPURIOUS;
347   this->suspend.waitstatus.kind = TARGET_WAITKIND_IGNORE;
348 }
349
350 thread_info::~thread_info ()
351 {
352   xfree (this->name);
353 }
354
355 /* Add TP to the end of the step-over chain LIST_P.  */
356
357 static void
358 step_over_chain_enqueue (struct thread_info **list_p, struct thread_info *tp)
359 {
360   gdb_assert (tp->step_over_next == NULL);
361   gdb_assert (tp->step_over_prev == NULL);
362
363   if (*list_p == NULL)
364     {
365       *list_p = tp;
366       tp->step_over_prev = tp->step_over_next = tp;
367     }
368   else
369     {
370       struct thread_info *head = *list_p;
371       struct thread_info *tail = head->step_over_prev;
372
373       tp->step_over_prev = tail;
374       tp->step_over_next = head;
375       head->step_over_prev = tp;
376       tail->step_over_next = tp;
377     }
378 }
379
380 /* Remove TP from step-over chain LIST_P.  */
381
382 static void
383 step_over_chain_remove (struct thread_info **list_p, struct thread_info *tp)
384 {
385   gdb_assert (tp->step_over_next != NULL);
386   gdb_assert (tp->step_over_prev != NULL);
387
388   if (*list_p == tp)
389     {
390       if (tp == tp->step_over_next)
391         *list_p = NULL;
392       else
393         *list_p = tp->step_over_next;
394     }
395
396   tp->step_over_prev->step_over_next = tp->step_over_next;
397   tp->step_over_next->step_over_prev = tp->step_over_prev;
398   tp->step_over_prev = tp->step_over_next = NULL;
399 }
400
401 /* See gdbthread.h.  */
402
403 struct thread_info *
404 thread_step_over_chain_next (struct thread_info *tp)
405 {
406   struct thread_info *next = tp->step_over_next;
407
408   return (next == step_over_queue_head ? NULL : next);
409 }
410
411 /* See gdbthread.h.  */
412
413 int
414 thread_is_in_step_over_chain (struct thread_info *tp)
415 {
416   return (tp->step_over_next != NULL);
417 }
418
419 /* See gdbthread.h.  */
420
421 void
422 thread_step_over_chain_enqueue (struct thread_info *tp)
423 {
424   step_over_chain_enqueue (&step_over_queue_head, tp);
425 }
426
427 /* See gdbthread.h.  */
428
429 void
430 thread_step_over_chain_remove (struct thread_info *tp)
431 {
432   step_over_chain_remove (&step_over_queue_head, tp);
433 }
434
435 /* Delete thread TP.  If SILENT, don't notify the observer of this
436    exit.  */
437
438 static void
439 delete_thread_1 (thread_info *thr, bool silent)
440 {
441   struct thread_info *tp, *tpprev;
442
443   tpprev = NULL;
444
445   for (tp = thread_list; tp; tpprev = tp, tp = tp->next)
446     if (tp == thr)
447       break;
448
449   if (!tp)
450     return;
451
452   set_thread_exited (tp, silent);
453
454   if (!tp->deletable ())
455     {
456        /* Will be really deleted some other time.  */
457        return;
458      }
459
460   if (tpprev)
461     tpprev->next = tp->next;
462   else
463     thread_list = tp->next;
464
465   delete tp;
466 }
467
468 /* Delete thread THREAD and notify of thread exit.  If this is the
469    current thread, don't actually delete it, but tag it as exited and
470    do the notification.  If this is the user selected thread, clear
471    it.  */
472
473 void
474 delete_thread (thread_info *thread)
475 {
476   delete_thread_1 (thread, false /* not silent */);
477 }
478
479 void
480 delete_thread_silent (thread_info *thread)
481 {
482   delete_thread_1 (thread, true /* silent */);
483 }
484
485 struct thread_info *
486 find_thread_global_id (int global_id)
487 {
488   struct thread_info *tp;
489
490   for (tp = thread_list; tp; tp = tp->next)
491     if (tp->global_num == global_id)
492       return tp;
493
494   return NULL;
495 }
496
497 static struct thread_info *
498 find_thread_id (struct inferior *inf, int thr_num)
499 {
500   struct thread_info *tp;
501
502   for (tp = thread_list; tp; tp = tp->next)
503     if (tp->inf == inf && tp->per_inf_num == thr_num)
504       return tp;
505
506   return NULL;
507 }
508
509 /* Find a thread_info by matching PTID.  */
510
511 struct thread_info *
512 find_thread_ptid (ptid_t ptid)
513 {
514   struct thread_info *tp;
515
516   for (tp = thread_list; tp; tp = tp->next)
517     if (tp->ptid == ptid)
518       return tp;
519
520   return NULL;
521 }
522
523 /* See gdbthread.h.  */
524
525 struct thread_info *
526 find_thread_by_handle (struct value *thread_handle, struct inferior *inf)
527 {
528   return target_thread_handle_to_thread_info
529            (value_contents_all (thread_handle),
530             TYPE_LENGTH (value_type (thread_handle)),
531             inf);
532 }
533
534 /*
535  * Thread iterator function.
536  *
537  * Calls a callback function once for each thread, so long as
538  * the callback function returns false.  If the callback function
539  * returns true, the iteration will end and the current thread
540  * will be returned.  This can be useful for implementing a
541  * search for a thread with arbitrary attributes, or for applying
542  * some operation to every thread.
543  *
544  * FIXME: some of the existing functionality, such as
545  * "Thread apply all", might be rewritten using this functionality.
546  */
547
548 struct thread_info *
549 iterate_over_threads (int (*callback) (struct thread_info *, void *),
550                       void *data)
551 {
552   struct thread_info *tp, *next;
553
554   for (tp = thread_list; tp; tp = next)
555     {
556       next = tp->next;
557       if ((*callback) (tp, data))
558         return tp;
559     }
560
561   return NULL;
562 }
563
564 int
565 thread_count (void)
566 {
567   int result = 0;
568   struct thread_info *tp;
569
570   for (tp = thread_list; tp; tp = tp->next)
571     ++result;
572
573   return result;
574 }
575
576 /* Return the number of non-exited threads in the thread list.  */
577
578 static int
579 live_threads_count (void)
580 {
581   int result = 0;
582   struct thread_info *tp;
583
584   ALL_NON_EXITED_THREADS (tp)
585     ++result;
586
587   return result;
588 }
589
590 int
591 valid_global_thread_id (int global_id)
592 {
593   struct thread_info *tp;
594
595   for (tp = thread_list; tp; tp = tp->next)
596     if (tp->global_num == global_id)
597       return 1;
598
599   return 0;
600 }
601
602 int
603 in_thread_list (ptid_t ptid)
604 {
605   struct thread_info *tp;
606
607   for (tp = thread_list; tp; tp = tp->next)
608     if (tp->ptid == ptid)
609       return 1;
610
611   return 0;                     /* Never heard of 'im.  */
612 }
613
614 /* Finds the first thread of the inferior.  */
615
616 thread_info *
617 first_thread_of_inferior (inferior *inf)
618 {
619   struct thread_info *tp, *ret = NULL;
620
621   for (tp = thread_list; tp; tp = tp->next)
622     if (tp->inf == inf)
623       if (ret == NULL || tp->global_num < ret->global_num)
624         ret = tp;
625
626   return ret;
627 }
628
629 thread_info *
630 any_thread_of_inferior (inferior *inf)
631 {
632   struct thread_info *tp;
633
634   gdb_assert (inf->pid != 0);
635
636   /* Prefer the current thread.  */
637   if (inf == current_inferior ())
638     return inferior_thread ();
639
640   ALL_NON_EXITED_THREADS (tp)
641     if (tp->inf == inf)
642       return tp;
643
644   return NULL;
645 }
646
647 thread_info *
648 any_live_thread_of_inferior (inferior *inf)
649 {
650   struct thread_info *curr_tp = NULL;
651   struct thread_info *tp;
652   struct thread_info *tp_executing = NULL;
653
654   gdb_assert (inf != NULL && inf->pid != 0);
655
656   /* Prefer the current thread if it's not executing.  */
657   if (inferior_ptid != null_ptid && current_inferior () == inf)
658     {
659       /* If the current thread is dead, forget it.  If it's not
660          executing, use it.  Otherwise, still choose it (below), but
661          only if no other non-executing thread is found.  */
662       curr_tp = inferior_thread ();
663       if (curr_tp->state == THREAD_EXITED)
664         curr_tp = NULL;
665       else if (!curr_tp->executing)
666         return curr_tp;
667     }
668
669   ALL_NON_EXITED_THREADS (tp)
670     if (tp->inf == inf)
671       {
672         if (!tp->executing)
673           return tp;
674
675         tp_executing = tp;
676       }
677
678   /* If both the current thread and all live threads are executing,
679      prefer the current thread.  */
680   if (curr_tp != NULL)
681     return curr_tp;
682
683   /* Otherwise, just return an executing thread, if any.  */
684   return tp_executing;
685 }
686
687 /* Return true if TP is an active thread.  */
688 static int
689 thread_alive (struct thread_info *tp)
690 {
691   if (tp->state == THREAD_EXITED)
692     return 0;
693   if (!target_thread_alive (tp->ptid))
694     return 0;
695   return 1;
696 }
697
698 /* See gdbthreads.h.  */
699
700 void
701 prune_threads (void)
702 {
703   struct thread_info *tp, *tmp;
704
705   ALL_THREADS_SAFE (tp, tmp)
706     {
707       if (!thread_alive (tp))
708         delete_thread (tp);
709     }
710 }
711
712 /* See gdbthreads.h.  */
713
714 void
715 delete_exited_threads (void)
716 {
717   struct thread_info *tp, *tmp;
718
719   ALL_THREADS_SAFE (tp, tmp)
720     {
721       if (tp->state == THREAD_EXITED)
722         delete_thread (tp);
723     }
724 }
725
726 /* Return true value if stack temporaies are enabled for the thread
727    TP.  */
728
729 bool
730 thread_stack_temporaries_enabled_p (thread_info *tp)
731 {
732   if (tp == NULL)
733     return false;
734   else
735     return tp->stack_temporaries_enabled;
736 }
737
738 /* Push V on to the stack temporaries of the thread with id PTID.  */
739
740 void
741 push_thread_stack_temporary (thread_info *tp, struct value *v)
742 {
743   gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
744   tp->stack_temporaries.push_back (v);
745 }
746
747 /* Return true if VAL is among the stack temporaries of the thread
748    TP.  Return false otherwise.  */
749
750 bool
751 value_in_thread_stack_temporaries (struct value *val, thread_info *tp)
752 {
753   gdb_assert (tp != NULL && tp->stack_temporaries_enabled);
754   for (value *v : tp->stack_temporaries)
755     if (v == val)
756       return true;
757
758   return false;
759 }
760
761 /* Return the last of the stack temporaries for thread with id PTID.
762    Return NULL if there are no stack temporaries for the thread.  */
763
764 value *
765 get_last_thread_stack_temporary (thread_info *tp)
766 {
767   struct value *lastval = NULL;
768
769   gdb_assert (tp != NULL);
770   if (!tp->stack_temporaries.empty ())
771     lastval = tp->stack_temporaries.back ();
772
773   return lastval;
774 }
775
776 void
777 thread_change_ptid (ptid_t old_ptid, ptid_t new_ptid)
778 {
779   struct inferior *inf;
780   struct thread_info *tp;
781
782   /* It can happen that what we knew as the target inferior id
783      changes.  E.g, target remote may only discover the remote process
784      pid after adding the inferior to GDB's list.  */
785   inf = find_inferior_ptid (old_ptid);
786   inf->pid = new_ptid.pid ();
787
788   tp = find_thread_ptid (old_ptid);
789   tp->ptid = new_ptid;
790
791   gdb::observers::thread_ptid_changed.notify (old_ptid, new_ptid);
792 }
793
794 /* See gdbthread.h.  */
795
796 void
797 set_resumed (ptid_t ptid, int resumed)
798 {
799   struct thread_info *tp;
800   int all = ptid == minus_one_ptid;
801
802   if (all || ptid.is_pid ())
803     {
804       for (tp = thread_list; tp; tp = tp->next)
805         if (all || tp->ptid.pid () == ptid.pid ())
806           tp->resumed = resumed;
807     }
808   else
809     {
810       tp = find_thread_ptid (ptid);
811       gdb_assert (tp != NULL);
812       tp->resumed = resumed;
813     }
814 }
815
816 /* Helper for set_running, that marks one thread either running or
817    stopped.  */
818
819 static int
820 set_running_thread (struct thread_info *tp, int running)
821 {
822   int started = 0;
823
824   if (running && tp->state == THREAD_STOPPED)
825     started = 1;
826   tp->state = running ? THREAD_RUNNING : THREAD_STOPPED;
827
828   if (!running)
829     {
830       /* If the thread is now marked stopped, remove it from
831          the step-over queue, so that we don't try to resume
832          it until the user wants it to.  */
833       if (tp->step_over_next != NULL)
834         thread_step_over_chain_remove (tp);
835     }
836
837   return started;
838 }
839
840 /* See gdbthread.h.  */
841
842 void
843 thread_info::set_running (bool running)
844 {
845   if (set_running_thread (this, running))
846     gdb::observers::target_resumed.notify (this->ptid);
847 }
848
849 void
850 set_running (ptid_t ptid, int running)
851 {
852   struct thread_info *tp;
853   int all = ptid == minus_one_ptid;
854   int any_started = 0;
855
856   /* We try not to notify the observer if no thread has actually changed
857      the running state -- merely to reduce the number of messages to
858      frontend.  Frontend is supposed to handle multiple *running just fine.  */
859   if (all || ptid.is_pid ())
860     {
861       for (tp = thread_list; tp; tp = tp->next)
862         if (all || tp->ptid.pid () == ptid.pid ())
863           {
864             if (tp->state == THREAD_EXITED)
865               continue;
866
867             if (set_running_thread (tp, running))
868               any_started = 1;
869           }
870     }
871   else
872     {
873       tp = find_thread_ptid (ptid);
874       gdb_assert (tp != NULL);
875       gdb_assert (tp->state != THREAD_EXITED);
876       if (set_running_thread (tp, running))
877         any_started = 1;
878     }
879   if (any_started)
880     gdb::observers::target_resumed.notify (ptid);
881 }
882
883 static int
884 is_thread_state (ptid_t ptid, enum thread_state state)
885 {
886   struct thread_info *tp;
887
888   tp = find_thread_ptid (ptid);
889   gdb_assert (tp);
890   return tp->state == state;
891 }
892
893 int
894 is_stopped (ptid_t ptid)
895 {
896   return is_thread_state (ptid, THREAD_STOPPED);
897 }
898
899 int
900 is_exited (ptid_t ptid)
901 {
902   return is_thread_state (ptid, THREAD_EXITED);
903 }
904
905 int
906 is_running (ptid_t ptid)
907 {
908   return is_thread_state (ptid, THREAD_RUNNING);
909 }
910
911 int
912 is_executing (ptid_t ptid)
913 {
914   struct thread_info *tp;
915
916   tp = find_thread_ptid (ptid);
917   gdb_assert (tp);
918   return tp->executing;
919 }
920
921 /* Helper for set_executing.  Set's the thread's 'executing' field
922    from EXECUTING, and if EXECUTING is true also clears the thread's
923    stop_pc.  */
924
925 static void
926 set_executing_thread (thread_info *thr, bool executing)
927 {
928   thr->executing = executing;
929   if (executing)
930     thr->suspend.stop_pc = ~(CORE_ADDR) 0;
931 }
932
933 void
934 set_executing (ptid_t ptid, int executing)
935 {
936   struct thread_info *tp;
937   int all = ptid == minus_one_ptid;
938
939   if (all || ptid.is_pid ())
940     {
941       for (tp = thread_list; tp; tp = tp->next)
942         if (all || tp->ptid.pid () == ptid.pid ())
943           set_executing_thread (tp, executing);
944     }
945   else
946     {
947       tp = find_thread_ptid (ptid);
948       gdb_assert (tp);
949       set_executing_thread (tp, executing);
950     }
951
952   /* It only takes one running thread to spawn more threads.*/
953   if (executing)
954     threads_executing = 1;
955   /* Only clear the flag if the caller is telling us everything is
956      stopped.  */
957   else if (minus_one_ptid == ptid)
958     threads_executing = 0;
959 }
960
961 /* See gdbthread.h.  */
962
963 int
964 threads_are_executing (void)
965 {
966   return threads_executing;
967 }
968
969 void
970 set_stop_requested (ptid_t ptid, int stop)
971 {
972   struct thread_info *tp;
973   int all = ptid == minus_one_ptid;
974
975   if (all || ptid.is_pid ())
976     {
977       for (tp = thread_list; tp; tp = tp->next)
978         if (all || tp->ptid.pid () == ptid.pid ())
979           tp->stop_requested = stop;
980     }
981   else
982     {
983       tp = find_thread_ptid (ptid);
984       gdb_assert (tp);
985       tp->stop_requested = stop;
986     }
987
988   /* Call the stop requested observer so other components of GDB can
989      react to this request.  */
990   if (stop)
991     gdb::observers::thread_stop_requested.notify (ptid);
992 }
993
994 void
995 finish_thread_state (ptid_t ptid)
996 {
997   struct thread_info *tp;
998   int all;
999   int any_started = 0;
1000
1001   all = ptid == minus_one_ptid;
1002
1003   if (all || ptid.is_pid ())
1004     {
1005       for (tp = thread_list; tp; tp = tp->next)
1006         {
1007           if (tp->state == THREAD_EXITED)
1008             continue;
1009           if (all || ptid.pid () == tp->ptid.pid ())
1010             {
1011               if (set_running_thread (tp, tp->executing))
1012                 any_started = 1;
1013             }
1014         }
1015     }
1016   else
1017     {
1018       tp = find_thread_ptid (ptid);
1019       gdb_assert (tp);
1020       if (tp->state != THREAD_EXITED)
1021         {
1022           if (set_running_thread (tp, tp->executing))
1023             any_started = 1;
1024         }
1025     }
1026
1027   if (any_started)
1028     gdb::observers::target_resumed.notify (ptid);
1029 }
1030
1031 /* See gdbthread.h.  */
1032
1033 void
1034 validate_registers_access (void)
1035 {
1036   /* No selected thread, no registers.  */
1037   if (inferior_ptid == null_ptid)
1038     error (_("No thread selected."));
1039
1040   thread_info *tp = inferior_thread ();
1041
1042   /* Don't try to read from a dead thread.  */
1043   if (tp->state == THREAD_EXITED)
1044     error (_("The current thread has terminated"));
1045
1046   /* ... or from a spinning thread.  FIXME: This isn't actually fully
1047      correct.  It'll allow an user-requested access (e.g., "print $pc"
1048      at the prompt) when a thread is not executing for some internal
1049      reason, but is marked running from the user's perspective.  E.g.,
1050      the thread is waiting for its turn in the step-over queue.  */
1051   if (tp->executing)
1052     error (_("Selected thread is running."));
1053 }
1054
1055 /* See gdbthread.h.  */
1056
1057 bool
1058 can_access_registers_thread (thread_info *thread)
1059 {
1060   /* No thread, no registers.  */
1061   if (thread == NULL)
1062     return false;
1063
1064   /* Don't try to read from a dead thread.  */
1065   if (thread->state == THREAD_EXITED)
1066     return false;
1067
1068   /* ... or from a spinning thread.  FIXME: see validate_registers_access.  */
1069   if (thread->executing)
1070     return false;
1071
1072   return true;
1073 }
1074
1075 int
1076 pc_in_thread_step_range (CORE_ADDR pc, struct thread_info *thread)
1077 {
1078   return (pc >= thread->control.step_range_start
1079           && pc < thread->control.step_range_end);
1080 }
1081
1082 /* Helper for print_thread_info.  Returns true if THR should be
1083    printed.  If REQUESTED_THREADS, a list of GDB ids/ranges, is not
1084    NULL, only print THR if its ID is included in the list.  GLOBAL_IDS
1085    is true if REQUESTED_THREADS is list of global IDs, false if a list
1086    of per-inferior thread ids.  If PID is not -1, only print THR if it
1087    is a thread from the process PID.  Otherwise, threads from all
1088    attached PIDs are printed.  If both REQUESTED_THREADS is not NULL
1089    and PID is not -1, then the thread is printed if it belongs to the
1090    specified process.  Otherwise, an error is raised.  */
1091
1092 static int
1093 should_print_thread (const char *requested_threads, int default_inf_num,
1094                      int global_ids, int pid, struct thread_info *thr)
1095 {
1096   if (requested_threads != NULL && *requested_threads != '\0')
1097     {
1098       int in_list;
1099
1100       if (global_ids)
1101         in_list = number_is_in_list (requested_threads, thr->global_num);
1102       else
1103         in_list = tid_is_in_list (requested_threads, default_inf_num,
1104                                   thr->inf->num, thr->per_inf_num);
1105       if (!in_list)
1106         return 0;
1107     }
1108
1109   if (pid != -1 && thr->ptid.pid () != pid)
1110     {
1111       if (requested_threads != NULL && *requested_threads != '\0')
1112         error (_("Requested thread not found in requested process"));
1113       return 0;
1114     }
1115
1116   if (thr->state == THREAD_EXITED)
1117     return 0;
1118
1119   return 1;
1120 }
1121
1122 /* Return the string to display in "info threads"'s "Target Id"
1123    column, for TP.  */
1124
1125 static std::string
1126 thread_target_id_str (thread_info *tp)
1127 {
1128   const char *target_id = target_pid_to_str (tp->ptid);
1129   const char *extra_info = target_extra_thread_info (tp);
1130   const char *name = tp->name != nullptr ? tp->name : target_thread_name (tp);
1131
1132   if (extra_info != nullptr && name != nullptr)
1133     return string_printf ("%s \"%s\" (%s)", target_id, name, extra_info);
1134   else if (extra_info != nullptr)
1135     return string_printf ("%s (%s)", target_id, extra_info);
1136   else if (name != nullptr)
1137     return string_printf ("%s \"%s\"", target_id, name);
1138   else
1139     return target_id;
1140 }
1141
1142 /* Like print_thread_info, but in addition, GLOBAL_IDS indicates
1143    whether REQUESTED_THREADS is a list of global or per-inferior
1144    thread ids.  */
1145
1146 static void
1147 print_thread_info_1 (struct ui_out *uiout, const char *requested_threads,
1148                      int global_ids, int pid,
1149                      int show_global_ids)
1150 {
1151   struct thread_info *tp;
1152   struct inferior *inf;
1153   int default_inf_num = current_inferior ()->num;
1154
1155   update_thread_list ();
1156
1157   /* Whether we saw any thread.  */
1158   bool any_thread = false;
1159   /* Whether the current thread is exited.  */
1160   bool current_exited = false;
1161
1162   thread_info *current_thread = (inferior_ptid != null_ptid
1163                                  ? inferior_thread () : NULL);
1164
1165   {
1166     /* For backward compatibility, we make a list for MI.  A table is
1167        preferable for the CLI, though, because it shows table
1168        headers.  */
1169     gdb::optional<ui_out_emit_list> list_emitter;
1170     gdb::optional<ui_out_emit_table> table_emitter;
1171
1172     if (uiout->is_mi_like_p ())
1173       list_emitter.emplace (uiout, "threads");
1174     else
1175       {
1176         int n_threads = 0;
1177         /* The width of the "Target Id" column.  Grown below to
1178            accommodate the largest entry.  */
1179         size_t target_id_col_width = 17;
1180
1181         ALL_THREADS (tp)
1182           {
1183             if (!should_print_thread (requested_threads, default_inf_num,
1184                                       global_ids, pid, tp))
1185               continue;
1186
1187             if (!uiout->is_mi_like_p ())
1188               {
1189                 target_id_col_width
1190                   = std::max (target_id_col_width,
1191                               thread_target_id_str (tp).size ());
1192               }
1193
1194             ++n_threads;
1195           }
1196
1197         if (n_threads == 0)
1198           {
1199             if (requested_threads == NULL || *requested_threads == '\0')
1200               uiout->message (_("No threads.\n"));
1201             else
1202               uiout->message (_("No threads match '%s'.\n"),
1203                               requested_threads);
1204             return;
1205           }
1206
1207         table_emitter.emplace (uiout, show_global_ids ? 5 : 4,
1208                                n_threads, "threads");
1209
1210         uiout->table_header (1, ui_left, "current", "");
1211         uiout->table_header (4, ui_left, "id-in-tg", "Id");
1212         if (show_global_ids)
1213           uiout->table_header (4, ui_left, "id", "GId");
1214         uiout->table_header (target_id_col_width, ui_left,
1215                              "target-id", "Target Id");
1216         uiout->table_header (1, ui_left, "frame", "Frame");
1217         uiout->table_body ();
1218       }
1219
1220     /* We'll be switching threads temporarily.  */
1221     scoped_restore_current_thread restore_thread;
1222
1223     ALL_THREADS_BY_INFERIOR (inf, tp)
1224       {
1225         int core;
1226
1227         any_thread = true;
1228         if (tp == current_thread && tp->state == THREAD_EXITED)
1229           current_exited = true;
1230
1231         if (!should_print_thread (requested_threads, default_inf_num,
1232                                   global_ids, pid, tp))
1233           continue;
1234
1235         ui_out_emit_tuple tuple_emitter (uiout, NULL);
1236
1237         if (!uiout->is_mi_like_p ())
1238           {
1239             if (tp == current_thread)
1240               uiout->field_string ("current", "*");
1241             else
1242               uiout->field_skip ("current");
1243
1244             uiout->field_string ("id-in-tg", print_thread_id (tp));
1245           }
1246
1247         if (show_global_ids || uiout->is_mi_like_p ())
1248           uiout->field_int ("id", tp->global_num);
1249
1250         /* For the CLI, we stuff everything into the target-id field.
1251            This is a gross hack to make the output come out looking
1252            correct.  The underlying problem here is that ui-out has no
1253            way to specify that a field's space allocation should be
1254            shared by several fields.  For MI, we do the right thing
1255            instead.  */
1256
1257         if (uiout->is_mi_like_p ())
1258           {
1259             uiout->field_string ("target-id", target_pid_to_str (tp->ptid));
1260
1261             const char *extra_info = target_extra_thread_info (tp);
1262             if (extra_info != nullptr)
1263               uiout->field_string ("details", extra_info);
1264
1265             const char *name = (tp->name != nullptr
1266                                 ? tp->name
1267                                 : target_thread_name (tp));
1268             if (name != NULL)
1269               uiout->field_string ("name", name);
1270           }
1271         else
1272           {
1273             uiout->field_string ("target-id",
1274                                  thread_target_id_str (tp).c_str ());
1275           }
1276
1277         if (tp->state == THREAD_RUNNING)
1278           uiout->text ("(running)\n");
1279         else
1280           {
1281             /* The switch below puts us at the top of the stack (leaf
1282                frame).  */
1283             switch_to_thread (tp);
1284             print_stack_frame (get_selected_frame (NULL),
1285                                /* For MI output, print frame level.  */
1286                                uiout->is_mi_like_p (),
1287                                LOCATION, 0);
1288           }
1289
1290         if (uiout->is_mi_like_p ())
1291           {
1292             const char *state = "stopped";
1293
1294             if (tp->state == THREAD_RUNNING)
1295               state = "running";
1296             uiout->field_string ("state", state);
1297           }
1298
1299         core = target_core_of_thread (tp->ptid);
1300         if (uiout->is_mi_like_p () && core != -1)
1301           uiout->field_int ("core", core);
1302       }
1303
1304     /* This end scope restores the current thread and the frame
1305        selected before the "info threads" command, and it finishes the
1306        ui-out list or table.  */
1307   }
1308
1309   if (pid == -1 && requested_threads == NULL)
1310     {
1311       if (uiout->is_mi_like_p () && inferior_ptid != null_ptid)
1312         uiout->field_int ("current-thread-id", current_thread->global_num);
1313
1314       if (inferior_ptid != null_ptid && current_exited)
1315         uiout->message ("\n\
1316 The current thread <Thread ID %s> has terminated.  See `help thread'.\n",
1317                         print_thread_id (inferior_thread ()));
1318       else if (any_thread && inferior_ptid == null_ptid)
1319         uiout->message ("\n\
1320 No selected thread.  See `help thread'.\n");
1321     }
1322 }
1323
1324 /* See gdbthread.h.  */
1325
1326 void
1327 print_thread_info (struct ui_out *uiout, char *requested_threads, int pid)
1328 {
1329   print_thread_info_1 (uiout, requested_threads, 1, pid, 0);
1330 }
1331
1332 /* Implementation of the "info threads" command.
1333
1334    Note: this has the drawback that it _really_ switches
1335          threads, which frees the frame cache.  A no-side
1336          effects info-threads command would be nicer.  */
1337
1338 static void
1339 info_threads_command (const char *arg, int from_tty)
1340 {
1341   int show_global_ids = 0;
1342
1343   if (arg != NULL
1344       && check_for_argument (&arg, "-gid", sizeof ("-gid") - 1))
1345     {
1346       arg = skip_spaces (arg);
1347       show_global_ids = 1;
1348     }
1349
1350   print_thread_info_1 (current_uiout, arg, 0, -1, show_global_ids);
1351 }
1352
1353 /* See gdbthread.h.  */
1354
1355 void
1356 switch_to_thread_no_regs (struct thread_info *thread)
1357 {
1358   struct inferior *inf = thread->inf;
1359
1360   set_current_program_space (inf->pspace);
1361   set_current_inferior (inf);
1362
1363   inferior_ptid = thread->ptid;
1364 }
1365
1366 /* See gdbthread.h.  */
1367
1368 void
1369 switch_to_no_thread ()
1370 {
1371   if (inferior_ptid == null_ptid)
1372     return;
1373
1374   inferior_ptid = null_ptid;
1375   reinit_frame_cache ();
1376 }
1377
1378 /* See gdbthread.h.  */
1379
1380 void
1381 switch_to_thread (thread_info *thr)
1382 {
1383   gdb_assert (thr != NULL);
1384
1385   if (inferior_ptid == thr->ptid)
1386     return;
1387
1388   switch_to_thread_no_regs (thr);
1389
1390   reinit_frame_cache ();
1391 }
1392
1393 /* See common/common-gdbthread.h.  */
1394
1395 void
1396 switch_to_thread (ptid_t ptid)
1397 {
1398   thread_info *thr = find_thread_ptid (ptid);
1399   switch_to_thread (thr);
1400 }
1401
1402 static void
1403 restore_selected_frame (struct frame_id a_frame_id, int frame_level)
1404 {
1405   struct frame_info *frame = NULL;
1406   int count;
1407
1408   /* This means there was no selected frame.  */
1409   if (frame_level == -1)
1410     {
1411       select_frame (NULL);
1412       return;
1413     }
1414
1415   gdb_assert (frame_level >= 0);
1416
1417   /* Restore by level first, check if the frame id is the same as
1418      expected.  If that fails, try restoring by frame id.  If that
1419      fails, nothing to do, just warn the user.  */
1420
1421   count = frame_level;
1422   frame = find_relative_frame (get_current_frame (), &count);
1423   if (count == 0
1424       && frame != NULL
1425       /* The frame ids must match - either both valid or both outer_frame_id.
1426          The latter case is not failsafe, but since it's highly unlikely
1427          the search by level finds the wrong frame, it's 99.9(9)% of
1428          the time (for all practical purposes) safe.  */
1429       && frame_id_eq (get_frame_id (frame), a_frame_id))
1430     {
1431       /* Cool, all is fine.  */
1432       select_frame (frame);
1433       return;
1434     }
1435
1436   frame = frame_find_by_id (a_frame_id);
1437   if (frame != NULL)
1438     {
1439       /* Cool, refound it.  */
1440       select_frame (frame);
1441       return;
1442     }
1443
1444   /* Nothing else to do, the frame layout really changed.  Select the
1445      innermost stack frame.  */
1446   select_frame (get_current_frame ());
1447
1448   /* Warn the user.  */
1449   if (frame_level > 0 && !current_uiout->is_mi_like_p ())
1450     {
1451       warning (_("Couldn't restore frame #%d in "
1452                  "current thread.  Bottom (innermost) frame selected:"),
1453                frame_level);
1454       /* For MI, we should probably have a notification about
1455          current frame change.  But this error is not very
1456          likely, so don't bother for now.  */
1457       print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
1458     }
1459 }
1460
1461 scoped_restore_current_thread::~scoped_restore_current_thread ()
1462 {
1463   /* If an entry of thread_info was previously selected, it won't be
1464      deleted because we've increased its refcount.  The thread represented
1465      by this thread_info entry may have already exited (due to normal exit,
1466      detach, etc), so the thread_info.state is THREAD_EXITED.  */
1467   if (m_thread != NULL
1468       /* If the previously selected thread belonged to a process that has
1469          in the mean time exited (or killed, detached, etc.), then don't revert
1470          back to it, but instead simply drop back to no thread selected.  */
1471       && m_inf->pid != 0)
1472     switch_to_thread (m_thread);
1473   else
1474     {
1475       switch_to_no_thread ();
1476       set_current_inferior (m_inf);
1477     }
1478
1479   /* The running state of the originally selected thread may have
1480      changed, so we have to recheck it here.  */
1481   if (inferior_ptid != null_ptid
1482       && m_was_stopped
1483       && m_thread->state == THREAD_STOPPED
1484       && target_has_registers
1485       && target_has_stack
1486       && target_has_memory)
1487     restore_selected_frame (m_selected_frame_id, m_selected_frame_level);
1488
1489   if (m_thread != NULL)
1490     m_thread->decref ();
1491   m_inf->decref ();
1492 }
1493
1494 scoped_restore_current_thread::scoped_restore_current_thread ()
1495 {
1496   m_thread = NULL;
1497   m_inf = current_inferior ();
1498
1499   if (inferior_ptid != null_ptid)
1500     {
1501       thread_info *tp = inferior_thread ();
1502       struct frame_info *frame;
1503
1504       m_was_stopped = tp->state == THREAD_STOPPED;
1505       if (m_was_stopped
1506           && target_has_registers
1507           && target_has_stack
1508           && target_has_memory)
1509         {
1510           /* When processing internal events, there might not be a
1511              selected frame.  If we naively call get_selected_frame
1512              here, then we can end up reading debuginfo for the
1513              current frame, but we don't generally need the debuginfo
1514              at this point.  */
1515           frame = get_selected_frame_if_set ();
1516         }
1517       else
1518         frame = NULL;
1519
1520       m_selected_frame_id = get_frame_id (frame);
1521       m_selected_frame_level = frame_relative_level (frame);
1522
1523       tp->incref ();
1524       m_thread = tp;
1525     }
1526
1527   m_inf->incref ();
1528 }
1529
1530 /* See gdbthread.h.  */
1531
1532 int
1533 show_thread_that_caused_stop (void)
1534 {
1535   return highest_thread_num > 1;
1536 }
1537
1538 /* See gdbthread.h.  */
1539
1540 int
1541 show_inferior_qualified_tids (void)
1542 {
1543   return (inferior_list->next != NULL || inferior_list->num != 1);
1544 }
1545
1546 /* See gdbthread.h.  */
1547
1548 const char *
1549 print_thread_id (struct thread_info *thr)
1550 {
1551   char *s = get_print_cell ();
1552
1553   if (show_inferior_qualified_tids ())
1554     xsnprintf (s, PRINT_CELL_SIZE, "%d.%d", thr->inf->num, thr->per_inf_num);
1555   else
1556     xsnprintf (s, PRINT_CELL_SIZE, "%d", thr->per_inf_num);
1557   return s;
1558 }
1559
1560 /* If true, tp_array_compar should sort in ascending order, otherwise
1561    in descending order.  */
1562
1563 static bool tp_array_compar_ascending;
1564
1565 /* Sort an array for struct thread_info pointers by thread ID (first
1566    by inferior number, and then by per-inferior thread number).  The
1567    order is determined by TP_ARRAY_COMPAR_ASCENDING.  */
1568
1569 static bool
1570 tp_array_compar (const thread_info *a, const thread_info *b)
1571 {
1572   if (a->inf->num != b->inf->num)
1573     {
1574       if (tp_array_compar_ascending)
1575         return a->inf->num < b->inf->num;
1576       else
1577         return a->inf->num > b->inf->num;
1578     }
1579
1580   if (tp_array_compar_ascending)
1581     return (a->per_inf_num < b->per_inf_num);
1582   else
1583     return (a->per_inf_num > b->per_inf_num);
1584 }
1585
1586 /* Switch to thread THR and execute CMD.
1587    FLAGS.QUIET controls the printing of the thread information.
1588    FLAGS.CONT and FLAGS.SILENT control how to handle errors.  */
1589
1590 static void
1591 thr_try_catch_cmd (thread_info *thr, const char *cmd, int from_tty,
1592                    const qcs_flags &flags)
1593 {
1594   switch_to_thread (thr);
1595   TRY
1596     {
1597       std::string cmd_result = execute_command_to_string (cmd, from_tty);
1598       if (!flags.silent || cmd_result.length () > 0)
1599         {
1600           if (!flags.quiet)
1601             printf_filtered (_("\nThread %s (%s):\n"),
1602                              print_thread_id (thr),
1603                              target_pid_to_str (inferior_ptid));
1604           printf_filtered ("%s", cmd_result.c_str ());
1605         }
1606     }
1607   CATCH (ex, RETURN_MASK_ERROR)
1608     {
1609       if (!flags.silent)
1610         {
1611           if (!flags.quiet)
1612             printf_filtered (_("\nThread %s (%s):\n"),
1613                              print_thread_id (thr),
1614                              target_pid_to_str (inferior_ptid));
1615           if (flags.cont)
1616             printf_filtered ("%s\n", ex.message);
1617           else
1618             throw_exception (ex);
1619         }
1620     }
1621   END_CATCH;
1622 }
1623
1624 /* Apply a GDB command to a list of threads.  List syntax is a whitespace
1625    separated list of numbers, or ranges, or the keyword `all'.  Ranges consist
1626    of two numbers separated by a hyphen.  Examples:
1627
1628    thread apply 1 2 7 4 backtrace       Apply backtrace cmd to threads 1,2,7,4
1629    thread apply 2-7 9 p foo(1)  Apply p foo(1) cmd to threads 2->7 & 9
1630    thread apply all x/i $pc   Apply x/i $pc cmd to all threads.  */
1631
1632 static void
1633 thread_apply_all_command (const char *cmd, int from_tty)
1634 {
1635   qcs_flags flags;
1636
1637   tp_array_compar_ascending = false;
1638
1639   while (cmd != NULL)
1640     {
1641       if (check_for_argument (&cmd, "-ascending", strlen ("-ascending")))
1642         {
1643           cmd = skip_spaces (cmd);
1644           tp_array_compar_ascending = true;
1645           continue;
1646         }
1647
1648       if (parse_flags_qcs ("thread apply all", &cmd, &flags))
1649         continue;
1650
1651       break;
1652     }
1653
1654   if (cmd == NULL || *cmd == '\000')
1655     error (_("Please specify a command at the end of 'thread apply all'"));
1656
1657   update_thread_list ();
1658
1659   int tc = live_threads_count ();
1660   if (tc != 0)
1661     {
1662       /* Save a copy of the thread list and increment each thread's
1663          refcount while executing the command in the context of each
1664          thread, in case the command is one that wipes threads.  E.g.,
1665          detach, kill, disconnect, etc., or even normally continuing
1666          over an inferior or thread exit.  */
1667       std::vector<thread_info *> thr_list_cpy;
1668       thr_list_cpy.reserve (tc);
1669
1670       {
1671         thread_info *tp;
1672
1673         ALL_NON_EXITED_THREADS (tp)
1674           {
1675             thr_list_cpy.push_back (tp);
1676           }
1677
1678         gdb_assert (thr_list_cpy.size () == tc);
1679       }
1680
1681       /* Increment the refcounts, and restore them back on scope
1682          exit.  */
1683       scoped_inc_dec_ref inc_dec_ref (thr_list_cpy);
1684
1685       std::sort (thr_list_cpy.begin (), thr_list_cpy.end (), tp_array_compar);
1686
1687       scoped_restore_current_thread restore_thread;
1688
1689       for (thread_info *thr : thr_list_cpy)
1690         if (thread_alive (thr))
1691           thr_try_catch_cmd (thr, cmd, from_tty, flags);
1692     }
1693 }
1694
1695 /* Implementation of the "thread apply" command.  */
1696
1697 static void
1698 thread_apply_command (const char *tidlist, int from_tty)
1699 {
1700   qcs_flags flags;
1701   const char *cmd = NULL;
1702   const char *cmd_or_flags;
1703   tid_range_parser parser;
1704
1705   if (tidlist == NULL || *tidlist == '\000')
1706     error (_("Please specify a thread ID list"));
1707
1708   parser.init (tidlist, current_inferior ()->num);
1709   while (!parser.finished ())
1710     {
1711       int inf_num, thr_start, thr_end;
1712
1713       if (!parser.get_tid_range (&inf_num, &thr_start, &thr_end))
1714         {
1715           cmd = parser.cur_tok ();
1716           break;
1717         }
1718     }
1719
1720   cmd_or_flags = cmd;
1721   while (cmd != NULL && parse_flags_qcs ("thread apply", &cmd, &flags))
1722     ;
1723
1724   if (cmd == NULL)
1725     error (_("Please specify a command following the thread ID list"));
1726
1727   if (tidlist == cmd || !isalpha (cmd[0]))
1728     invalid_thread_id_error (cmd);
1729
1730   scoped_restore_current_thread restore_thread;
1731
1732   parser.init (tidlist, current_inferior ()->num);
1733   while (!parser.finished () && parser.cur_tok () < cmd_or_flags)
1734     {
1735       struct thread_info *tp = NULL;
1736       struct inferior *inf;
1737       int inf_num, thr_num;
1738
1739       parser.get_tid (&inf_num, &thr_num);
1740       inf = find_inferior_id (inf_num);
1741       if (inf != NULL)
1742         tp = find_thread_id (inf, thr_num);
1743
1744       if (parser.in_star_range ())
1745         {
1746           if (inf == NULL)
1747             {
1748               warning (_("Unknown inferior %d"), inf_num);
1749               parser.skip_range ();
1750               continue;
1751             }
1752
1753           /* No use looking for threads past the highest thread number
1754              the inferior ever had.  */
1755           if (thr_num >= inf->highest_thread_num)
1756             parser.skip_range ();
1757
1758           /* Be quiet about unknown threads numbers.  */
1759           if (tp == NULL)
1760             continue;
1761         }
1762
1763       if (tp == NULL)
1764         {
1765           if (show_inferior_qualified_tids () || parser.tid_is_qualified ())
1766             warning (_("Unknown thread %d.%d"), inf_num, thr_num);
1767           else
1768             warning (_("Unknown thread %d"), thr_num);
1769           continue;
1770         }
1771
1772       if (!thread_alive (tp))
1773         {
1774           warning (_("Thread %s has terminated."), print_thread_id (tp));
1775           continue;
1776         }
1777
1778       thr_try_catch_cmd (tp, cmd, from_tty, flags);
1779     }
1780 }
1781
1782
1783 /* Implementation of the "taas" command.  */
1784
1785 static void
1786 taas_command (const char *cmd, int from_tty)
1787 {
1788   std::string expanded = std::string ("thread apply all -s ") + cmd;
1789   execute_command (expanded.c_str (), from_tty);
1790 }
1791
1792 /* Implementation of the "tfaas" command.  */
1793
1794 static void
1795 tfaas_command (const char *cmd, int from_tty)
1796 {
1797   std::string expanded
1798     = std::string ("thread apply all -s frame apply all -s ") + cmd;
1799   execute_command (expanded.c_str (), from_tty);
1800 }
1801
1802 /* Switch to the specified thread, or print the current thread.  */
1803
1804 void
1805 thread_command (const char *tidstr, int from_tty)
1806 {
1807   if (tidstr == NULL)
1808     {
1809       if (inferior_ptid == null_ptid)
1810         error (_("No thread selected"));
1811
1812       if (target_has_stack)
1813         {
1814           struct thread_info *tp = inferior_thread ();
1815
1816           if (tp->state == THREAD_EXITED)
1817             printf_filtered (_("[Current thread is %s (%s) (exited)]\n"),
1818                              print_thread_id (tp),
1819                              target_pid_to_str (inferior_ptid));
1820           else
1821             printf_filtered (_("[Current thread is %s (%s)]\n"),
1822                              print_thread_id (tp),
1823                              target_pid_to_str (inferior_ptid));
1824         }
1825       else
1826         error (_("No stack."));
1827     }
1828   else
1829     {
1830       ptid_t previous_ptid = inferior_ptid;
1831
1832       thread_select (tidstr, parse_thread_id (tidstr, NULL));
1833
1834       /* Print if the thread has not changed, otherwise an event will
1835          be sent.  */
1836       if (inferior_ptid == previous_ptid)
1837         {
1838           print_selected_thread_frame (current_uiout,
1839                                        USER_SELECTED_THREAD
1840                                        | USER_SELECTED_FRAME);
1841         }
1842       else
1843         {
1844           gdb::observers::user_selected_context_changed.notify
1845             (USER_SELECTED_THREAD | USER_SELECTED_FRAME);
1846         }
1847     }
1848 }
1849
1850 /* Implementation of `thread name'.  */
1851
1852 static void
1853 thread_name_command (const char *arg, int from_tty)
1854 {
1855   struct thread_info *info;
1856
1857   if (inferior_ptid == null_ptid)
1858     error (_("No thread selected"));
1859
1860   arg = skip_spaces (arg);
1861
1862   info = inferior_thread ();
1863   xfree (info->name);
1864   info->name = arg ? xstrdup (arg) : NULL;
1865 }
1866
1867 /* Find thread ids with a name, target pid, or extra info matching ARG.  */
1868
1869 static void
1870 thread_find_command (const char *arg, int from_tty)
1871 {
1872   struct thread_info *tp;
1873   const char *tmp;
1874   unsigned long match = 0;
1875
1876   if (arg == NULL || *arg == '\0')
1877     error (_("Command requires an argument."));
1878
1879   tmp = re_comp (arg);
1880   if (tmp != 0)
1881     error (_("Invalid regexp (%s): %s"), tmp, arg);
1882
1883   update_thread_list ();
1884   for (tp = thread_list; tp; tp = tp->next)
1885     {
1886       if (tp->name != NULL && re_exec (tp->name))
1887         {
1888           printf_filtered (_("Thread %s has name '%s'\n"),
1889                            print_thread_id (tp), tp->name);
1890           match++;
1891         }
1892
1893       tmp = target_thread_name (tp);
1894       if (tmp != NULL && re_exec (tmp))
1895         {
1896           printf_filtered (_("Thread %s has target name '%s'\n"),
1897                            print_thread_id (tp), tmp);
1898           match++;
1899         }
1900
1901       tmp = target_pid_to_str (tp->ptid);
1902       if (tmp != NULL && re_exec (tmp))
1903         {
1904           printf_filtered (_("Thread %s has target id '%s'\n"),
1905                            print_thread_id (tp), tmp);
1906           match++;
1907         }
1908
1909       tmp = target_extra_thread_info (tp);
1910       if (tmp != NULL && re_exec (tmp))
1911         {
1912           printf_filtered (_("Thread %s has extra info '%s'\n"),
1913                            print_thread_id (tp), tmp);
1914           match++;
1915         }
1916     }
1917   if (!match)
1918     printf_filtered (_("No threads match '%s'\n"), arg);
1919 }
1920
1921 /* Print notices when new threads are attached and detached.  */
1922 int print_thread_events = 1;
1923 static void
1924 show_print_thread_events (struct ui_file *file, int from_tty,
1925                           struct cmd_list_element *c, const char *value)
1926 {
1927   fprintf_filtered (file,
1928                     _("Printing of thread events is %s.\n"),
1929                     value);
1930 }
1931
1932 /* See gdbthread.h.  */
1933
1934 void
1935 thread_select (const char *tidstr, thread_info *tp)
1936 {
1937   if (!thread_alive (tp))
1938     error (_("Thread ID %s has terminated."), tidstr);
1939
1940   switch_to_thread (tp);
1941
1942   annotate_thread_changed ();
1943
1944   /* Since the current thread may have changed, see if there is any
1945      exited thread we can now delete.  */
1946   prune_threads ();
1947 }
1948
1949 /* Print thread and frame switch command response.  */
1950
1951 void
1952 print_selected_thread_frame (struct ui_out *uiout,
1953                              user_selected_what selection)
1954 {
1955   struct thread_info *tp = inferior_thread ();
1956
1957   if (selection & USER_SELECTED_THREAD)
1958     {
1959       if (uiout->is_mi_like_p ())
1960         {
1961           uiout->field_int ("new-thread-id",
1962                             inferior_thread ()->global_num);
1963         }
1964       else
1965         {
1966           uiout->text ("[Switching to thread ");
1967           uiout->field_string ("new-thread-id", print_thread_id (tp));
1968           uiout->text (" (");
1969           uiout->text (target_pid_to_str (inferior_ptid));
1970           uiout->text (")]");
1971         }
1972     }
1973
1974   if (tp->state == THREAD_RUNNING)
1975     {
1976       if (selection & USER_SELECTED_THREAD)
1977         uiout->text ("(running)\n");
1978     }
1979   else if (selection & USER_SELECTED_FRAME)
1980     {
1981       if (selection & USER_SELECTED_THREAD)
1982         uiout->text ("\n");
1983
1984       if (has_stack_frames ())
1985         print_stack_frame_to_uiout (uiout, get_selected_frame (NULL),
1986                                     1, SRC_AND_LOC, 1);
1987     }
1988 }
1989
1990 /* Update the 'threads_executing' global based on the threads we know
1991    about right now.  */
1992
1993 static void
1994 update_threads_executing (void)
1995 {
1996   struct thread_info *tp;
1997
1998   threads_executing = 0;
1999   ALL_NON_EXITED_THREADS (tp)
2000     {
2001       if (tp->executing)
2002         {
2003           threads_executing = 1;
2004           break;
2005         }
2006     }
2007 }
2008
2009 void
2010 update_thread_list (void)
2011 {
2012   target_update_thread_list ();
2013   update_threads_executing ();
2014 }
2015
2016 /* Return a new value for the selected thread's id.  Return a value of
2017    0 if no thread is selected.  If GLOBAL is true, return the thread's
2018    global number.  Otherwise return the per-inferior number.  */
2019
2020 static struct value *
2021 thread_num_make_value_helper (struct gdbarch *gdbarch, int global)
2022 {
2023   int int_val;
2024
2025   if (inferior_ptid == null_ptid)
2026     int_val = 0;
2027   else
2028     {
2029       thread_info *tp = inferior_thread ();
2030       if (global)
2031         int_val = tp->global_num;
2032       else
2033         int_val = tp->per_inf_num;
2034     }
2035
2036   return value_from_longest (builtin_type (gdbarch)->builtin_int, int_val);
2037 }
2038
2039 /* Return a new value for the selected thread's per-inferior thread
2040    number.  Return a value of 0 if no thread is selected, or no
2041    threads exist.  */
2042
2043 static struct value *
2044 thread_id_per_inf_num_make_value (struct gdbarch *gdbarch,
2045                                   struct internalvar *var,
2046                                   void *ignore)
2047 {
2048   return thread_num_make_value_helper (gdbarch, 0);
2049 }
2050
2051 /* Return a new value for the selected thread's global id.  Return a
2052    value of 0 if no thread is selected, or no threads exist.  */
2053
2054 static struct value *
2055 global_thread_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
2056                              void *ignore)
2057 {
2058   return thread_num_make_value_helper (gdbarch, 1);
2059 }
2060
2061 /* Commands with a prefix of `thread'.  */
2062 struct cmd_list_element *thread_cmd_list = NULL;
2063
2064 /* Implementation of `thread' variable.  */
2065
2066 static const struct internalvar_funcs thread_funcs =
2067 {
2068   thread_id_per_inf_num_make_value,
2069   NULL,
2070   NULL
2071 };
2072
2073 /* Implementation of `gthread' variable.  */
2074
2075 static const struct internalvar_funcs gthread_funcs =
2076 {
2077   global_thread_id_make_value,
2078   NULL,
2079   NULL
2080 };
2081
2082 void
2083 _initialize_thread (void)
2084 {
2085   static struct cmd_list_element *thread_apply_list = NULL;
2086
2087   add_info ("threads", info_threads_command,
2088             _("Display currently known threads.\n\
2089 Usage: info threads [-gid] [ID]...\n\
2090 -gid: Show global thread IDs.\n\
2091 If ID is given, it is a space-separated list of IDs of threads to display.\n\
2092 Otherwise, all threads are displayed."));
2093
2094   add_prefix_cmd ("thread", class_run, thread_command, _("\
2095 Use this command to switch between threads.\n\
2096 The new thread ID must be currently known."),
2097                   &thread_cmd_list, "thread ", 1, &cmdlist);
2098
2099 #define THREAD_APPLY_FLAGS_HELP "\
2100 Prints per-inferior thread number and target system's thread id\n\
2101 followed by COMMAND output.\n\
2102 FLAG arguments are -q (quiet), -c (continue), -s (silent).\n\
2103 Flag -q disables printing the thread information.\n\
2104 By default, if a COMMAND raises an error, thread apply is aborted.\n\
2105 Flag -c indicates to print the error and continue.\n\
2106 Flag -s indicates to silently ignore a COMMAND that raises an error\n\
2107 or produces no output."
2108
2109   add_prefix_cmd ("apply", class_run, thread_apply_command,
2110                   _("Apply a command to a list of threads.\n\
2111 Usage: thread apply ID... [FLAG]... COMMAND\n\
2112 ID is a space-separated list of IDs of threads to apply COMMAND on.\n"
2113 THREAD_APPLY_FLAGS_HELP),
2114                   &thread_apply_list, "thread apply ", 1, &thread_cmd_list);
2115
2116   add_cmd ("all", class_run, thread_apply_all_command,
2117            _("\
2118 Apply a command to all threads.\n\
2119 \n\
2120 Usage: thread apply all [-ascending] [FLAG]... COMMAND\n\
2121 -ascending: Call COMMAND for all threads in ascending order.\n\
2122             The default is descending order.\n"
2123 THREAD_APPLY_FLAGS_HELP),
2124            &thread_apply_list);
2125
2126   add_com ("taas", class_run, taas_command, _("\
2127 Apply a command to all threads (ignoring errors and empty output).\n\
2128 Usage: taas COMMAND\n\
2129 shortcut for 'thread apply all -s COMMAND'"));
2130
2131   add_com ("tfaas", class_run, tfaas_command, _("\
2132 Apply a command to all frames of all threads (ignoring errors and empty output).\n\
2133 Usage: tfaas COMMAND\n\
2134 shortcut for 'thread apply all -s frame apply all -s COMMAND'"));
2135
2136   add_cmd ("name", class_run, thread_name_command,
2137            _("Set the current thread's name.\n\
2138 Usage: thread name [NAME]\n\
2139 If NAME is not given, then any existing name is removed."), &thread_cmd_list);
2140
2141   add_cmd ("find", class_run, thread_find_command, _("\
2142 Find threads that match a regular expression.\n\
2143 Usage: thread find REGEXP\n\
2144 Will display thread ids whose name, target ID, or extra info matches REGEXP."),
2145            &thread_cmd_list);
2146
2147   add_com_alias ("t", "thread", class_run, 1);
2148
2149   add_setshow_boolean_cmd ("thread-events", no_class,
2150                            &print_thread_events, _("\
2151 Set printing of thread events (such as thread start and exit)."), _("\
2152 Show printing of thread events (such as thread start and exit)."), NULL,
2153                            NULL,
2154                            show_print_thread_events,
2155                            &setprintlist, &showprintlist);
2156
2157   create_internalvar_type_lazy ("_thread", &thread_funcs, NULL);
2158   create_internalvar_type_lazy ("_gthread", &gthread_funcs, NULL);
2159 }