1 /* Thread iterators and ranges for GDB, the GNU debugger.
2 Copyright (C) 2018-2023 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdbsupport/filtered-iterator.h"
23 #include "gdbsupport/iterator-range.h"
24 #include "gdbsupport/next-iterator.h"
25 #include "gdbsupport/reference-to-pointer-iterator.h"
26 #include "gdbsupport/safe-iterator.h"
28 /* A forward iterator that iterates over a given inferior's
31 using inf_threads_iterator
32 = reference_to_pointer_iterator
<intrusive_list
<thread_info
>::iterator
>;
34 /* A forward iterator that iterates over all threads of all
37 class all_threads_iterator
40 typedef all_threads_iterator self_type
;
41 typedef struct thread_info
*value_type
;
42 typedef struct thread_info
*&reference
;
43 typedef struct thread_info
**pointer
;
44 typedef std::forward_iterator_tag iterator_category
;
45 typedef int difference_type
;
50 /* Create an iterator that points to the first thread of the first
52 explicit all_threads_iterator (begin_t
);
54 /* Create a one-past-end iterator. */
55 all_threads_iterator ()
59 thread_info
*operator* () const { return m_thr
; }
61 all_threads_iterator
&operator++ ()
67 bool operator== (const all_threads_iterator
&other
) const
68 { return m_thr
== other
.m_thr
; }
70 bool operator!= (const all_threads_iterator
&other
) const
71 { return m_thr
!= other
.m_thr
; }
74 /* Advance to the next thread. */
78 /* The current inferior and thread. M_THR is NULL if we reached the
79 end of the threads list of the last inferior. */
84 /* Iterate over all threads that match a given PTID. */
86 class all_matching_threads_iterator
89 typedef all_matching_threads_iterator self_type
;
90 typedef struct thread_info
*value_type
;
91 typedef struct thread_info
*&reference
;
92 typedef struct thread_info
**pointer
;
93 typedef std::forward_iterator_tag iterator_category
;
94 typedef int difference_type
;
96 /* Creates an iterator that iterates over all threads that match
98 all_matching_threads_iterator (process_stratum_target
*filter_target
,
101 /* Create a one-past-end iterator. */
102 all_matching_threads_iterator () = default;
104 thread_info
*operator* () const { return m_thr
; }
106 all_matching_threads_iterator
&operator++ ()
112 bool operator== (const all_matching_threads_iterator
&other
) const
113 { return m_thr
== other
.m_thr
; }
115 bool operator!= (const all_matching_threads_iterator
&other
) const
116 { return m_thr
!= other
.m_thr
; }
119 /* Advance to next thread, skipping filtered threads. */
122 /* True if M_INF has the process target M_FILTER_TARGET. */
123 bool m_inf_matches ();
128 /* All threads, possibly filtered down to a single target. */
131 /* All threads of the given inferior. */
132 ALL_THREADS_OF_INFERIOR
,
134 /* A specific thread. */
138 /* The current inferior. */
139 inferior
*m_inf
= nullptr;
141 /* The current thread. */
142 thread_info
*m_thr
= nullptr;
144 /* The target we filter on (may be nullptr). */
145 process_stratum_target
*m_filter_target
;
148 /* Filter for filtered_iterator. Filters out exited threads. */
150 struct non_exited_thread_filter
152 bool operator() (struct thread_info
*thr
) const
154 return thr
->state
!= THREAD_EXITED
;
158 /* Iterate over all non-exited threads that match a given PTID. */
160 using all_non_exited_threads_iterator
161 = filtered_iterator
<all_matching_threads_iterator
, non_exited_thread_filter
>;
163 /* Iterate over all non-exited threads of an inferior. */
165 using inf_non_exited_threads_iterator
166 = filtered_iterator
<inf_threads_iterator
, non_exited_thread_filter
>;
168 /* Iterate over all threads of all inferiors, safely. */
170 using all_threads_safe_iterator
171 = basic_safe_iterator
<all_threads_iterator
>;
173 /* Iterate over all threads of an inferior, safely. */
175 using safe_inf_threads_iterator
176 = basic_safe_iterator
<inf_threads_iterator
>;
178 /* A range adapter that makes it possible to iterate over all threads
179 of an inferior with range-for. */
181 using inf_threads_range
= iterator_range
<inf_threads_iterator
>;
183 /* A range adapter that makes it possible to iterate over all
184 non-exited threads of an inferior with range-for. */
186 using inf_non_exited_threads_range
187 = iterator_range
<inf_non_exited_threads_iterator
>;
189 /* A range adapter that makes it possible to iterate over all threads
190 of an inferior with range-for, safely. */
192 using safe_inf_threads_range
= iterator_range
<safe_inf_threads_iterator
>;
194 /* A range adapter that makes it possible to iterate over all threads
195 with range-for "safely". I.e., it is safe to delete the
196 currently-iterated thread. */
198 using all_threads_safe_range
= iterator_range
<all_threads_safe_iterator
>;
200 /* A range adapter that makes it possible to iterate over all threads
201 that match a PTID filter with range-for. */
203 struct all_matching_threads_range
206 all_matching_threads_range (process_stratum_target
*filter_target
,
208 : m_filter_target (filter_target
), m_filter_ptid (filter_ptid
)
210 all_matching_threads_range ()
211 : m_filter_target (nullptr), m_filter_ptid (minus_one_ptid
)
214 all_matching_threads_iterator
begin () const
215 { return all_matching_threads_iterator (m_filter_target
, m_filter_ptid
); }
216 all_matching_threads_iterator
end () const
217 { return all_matching_threads_iterator (); }
221 process_stratum_target
*m_filter_target
;
222 ptid_t m_filter_ptid
;
225 /* A range adapter that makes it possible to iterate over all
226 non-exited threads of all inferiors, with range-for.
227 Threads/inferiors that do not match FILTER_PTID are filtered
230 class all_non_exited_threads_range
233 all_non_exited_threads_range (process_stratum_target
*filter_target
,
235 : m_filter_target (filter_target
), m_filter_ptid (filter_ptid
)
238 all_non_exited_threads_range ()
239 : m_filter_target (nullptr), m_filter_ptid (minus_one_ptid
)
242 all_non_exited_threads_iterator
begin () const
243 { return all_non_exited_threads_iterator (m_filter_target
, m_filter_ptid
); }
244 all_non_exited_threads_iterator
end () const
245 { return all_non_exited_threads_iterator (); }
248 process_stratum_target
*m_filter_target
;
249 ptid_t m_filter_ptid
;
252 #endif /* THREAD_ITER_H */