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