| 1 |
|
|
1 |
|
|
| 2 |
|
// Copyright (c) 2026 Michael Vandeberg
|
2 |
|
// Copyright (c) 2026 Michael Vandeberg
|
| 3 |
|
|
3 |
|
|
| 4 |
|
// Distributed under the Boost Software License, Version 1.0. (See accompanying
|
4 |
|
// Distributed under the Boost Software License, Version 1.0. (See accompanying
|
| 5 |
|
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
5 |
|
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
| 6 |
|
|
6 |
|
|
| 7 |
|
// Official repository: https://github.com/cppalliance/capy
|
7 |
|
// Official repository: https://github.com/cppalliance/capy
|
| 8 |
|
|
8 |
|
|
| 9 |
|
|
9 |
|
|
| 10 |
|
#ifndef BOOST_CAPY_WHEN_ANY_HPP
|
10 |
|
#ifndef BOOST_CAPY_WHEN_ANY_HPP
|
| 11 |
|
#define BOOST_CAPY_WHEN_ANY_HPP
|
11 |
|
#define BOOST_CAPY_WHEN_ANY_HPP
|
| 12 |
|
|
12 |
|
|
| 13 |
|
#include <boost/capy/detail/config.hpp>
|
13 |
|
#include <boost/capy/detail/config.hpp>
|
| 14 |
|
#include <boost/capy/concept/executor.hpp>
|
14 |
|
#include <boost/capy/concept/executor.hpp>
|
| 15 |
|
#include <boost/capy/concept/io_awaitable.hpp>
|
15 |
|
#include <boost/capy/concept/io_awaitable.hpp>
|
| 16 |
|
#include <boost/capy/coro.hpp>
|
16 |
|
#include <boost/capy/coro.hpp>
|
| 17 |
|
#include <boost/capy/ex/executor_ref.hpp>
|
17 |
|
#include <boost/capy/ex/executor_ref.hpp>
|
| 18 |
|
#include <boost/capy/ex/frame_allocator.hpp>
|
18 |
|
#include <boost/capy/ex/frame_allocator.hpp>
|
| 19 |
|
#include <boost/capy/task.hpp>
|
19 |
|
#include <boost/capy/task.hpp>
|
| 20 |
|
|
20 |
|
|
| 21 |
|
|
21 |
|
|
| 22 |
|
|
22 |
|
|
| 23 |
|
|
23 |
|
|
| 24 |
|
|
24 |
|
|
| 25 |
|
|
25 |
|
|
| 26 |
|
|
26 |
|
|
| 27 |
|
|
27 |
|
|
| 28 |
|
|
28 |
|
|
| 29 |
|
|
29 |
|
|
| 30 |
|
|
30 |
|
|
| 31 |
|
|
31 |
|
|
| 32 |
|
|
32 |
|
|
| 33 |
|
|
33 |
|
|
| 34 |
|
|
34 |
|
|
| 35 |
|
when_any - Race multiple tasks, return first completion
|
35 |
|
when_any - Race multiple tasks, return first completion
|
| 36 |
|
========================================================
|
36 |
|
========================================================
|
| 37 |
|
|
37 |
|
|
| 38 |
|
|
38 |
|
|
| 39 |
|
|
39 |
|
|
| 40 |
|
when_any launches N tasks concurrently and completes when the FIRST task
|
40 |
|
when_any launches N tasks concurrently and completes when the FIRST task
|
| 41 |
|
finishes (success or failure). It then requests stop for all siblings and
|
41 |
|
finishes (success or failure). It then requests stop for all siblings and
|
| 42 |
|
waits for them to acknowledge before returning.
|
42 |
|
waits for them to acknowledge before returning.
|
| 43 |
|
|
43 |
|
|
| 44 |
|
|
44 |
|
|
| 45 |
|
|
45 |
|
|
| 46 |
|
The design mirrors when_all but with inverted completion semantics:
|
46 |
|
The design mirrors when_all but with inverted completion semantics:
|
| 47 |
|
|
47 |
|
|
| 48 |
|
when_all: complete when remaining_count reaches 0 (all done)
|
48 |
|
when_all: complete when remaining_count reaches 0 (all done)
|
| 49 |
|
when_any: complete when has_winner becomes true (first done)
|
49 |
|
when_any: complete when has_winner becomes true (first done)
|
| 50 |
|
BUT still wait for remaining_count to reach 0 for cleanup
|
50 |
|
BUT still wait for remaining_count to reach 0 for cleanup
|
| 51 |
|
|
51 |
|
|
| 52 |
|
|
52 |
|
|
| 53 |
|
- when_any_state: Shared state tracking winner and completion
|
53 |
|
- when_any_state: Shared state tracking winner and completion
|
| 54 |
|
- when_any_runner: Wrapper coroutine for each child task
|
54 |
|
- when_any_runner: Wrapper coroutine for each child task
|
| 55 |
|
- when_any_launcher: Awaitable that starts all runners concurrently
|
55 |
|
- when_any_launcher: Awaitable that starts all runners concurrently
|
| 56 |
|
|
56 |
|
|
| 57 |
|
|
57 |
|
|
| 58 |
|
|
58 |
|
|
| 59 |
|
1. Exactly one task becomes the winner (via atomic compare_exchange)
|
59 |
|
1. Exactly one task becomes the winner (via atomic compare_exchange)
|
| 60 |
|
2. All tasks must complete before parent resumes (cleanup safety)
|
60 |
|
2. All tasks must complete before parent resumes (cleanup safety)
|
| 61 |
|
3. Stop is requested immediately when winner is determined
|
61 |
|
3. Stop is requested immediately when winner is determined
|
| 62 |
|
4. Only the winner's result/exception is stored
|
62 |
|
4. Only the winner's result/exception is stored
|
| 63 |
|
|
63 |
|
|
| 64 |
|
|
64 |
|
|
| 65 |
|
|
65 |
|
|
| 66 |
|
std::variant requires unique alternative types. Since when_any can race
|
66 |
|
std::variant requires unique alternative types. Since when_any can race
|
| 67 |
|
tasks with identical return types (e.g., three task<int>), we must
|
67 |
|
tasks with identical return types (e.g., three task<int>), we must
|
| 68 |
|
deduplicate types before constructing the variant.
|
68 |
|
deduplicate types before constructing the variant.
|
| 69 |
|
|
69 |
|
|
| 70 |
|
Example: when_any(task<int>, task<string>, task<int>)
|
70 |
|
Example: when_any(task<int>, task<string>, task<int>)
|
| 71 |
|
- Raw types after void->monostate: int, string, int
|
71 |
|
- Raw types after void->monostate: int, string, int
|
| 72 |
|
- Deduplicated variant: std::variant<int, string>
|
72 |
|
- Deduplicated variant: std::variant<int, string>
|
| 73 |
|
- Return: pair<size_t, variant<int, string>>
|
73 |
|
- Return: pair<size_t, variant<int, string>>
|
| 74 |
|
|
74 |
|
|
| 75 |
|
The winner_index tells you which task won (0, 1, or 2), while the variant
|
75 |
|
The winner_index tells you which task won (0, 1, or 2), while the variant
|
| 76 |
|
holds the result. Use the index to determine how to interpret the variant.
|
76 |
|
holds the result. Use the index to determine how to interpret the variant.
|
| 77 |
|
|
77 |
|
|
| 78 |
|
|
78 |
|
|
| 79 |
|
|
79 |
|
|
| 80 |
|
void tasks contribute std::monostate to the variant (then deduplicated).
|
80 |
|
void tasks contribute std::monostate to the variant (then deduplicated).
|
| 81 |
|
All-void tasks result in: pair<size_t, variant<monostate>>
|
81 |
|
All-void tasks result in: pair<size_t, variant<monostate>>
|
| 82 |
|
|
82 |
|
|
| 83 |
|
|
83 |
|
|
| 84 |
|
|
84 |
|
|
| 85 |
|
Synchronization chain from winner's write to parent's read:
|
85 |
|
Synchronization chain from winner's write to parent's read:
|
| 86 |
|
|
86 |
|
|
| 87 |
|
1. Winner thread writes result_/winner_exception_ (non-atomic)
|
87 |
|
1. Winner thread writes result_/winner_exception_ (non-atomic)
|
| 88 |
|
2. Winner thread calls signal_completion() → fetch_sub(acq_rel) on remaining_count_
|
88 |
|
2. Winner thread calls signal_completion() → fetch_sub(acq_rel) on remaining_count_
|
| 89 |
|
3. Last task thread (may be winner or non-winner) calls signal_completion()
|
89 |
|
3. Last task thread (may be winner or non-winner) calls signal_completion()
|
| 90 |
|
→ fetch_sub(acq_rel) on remaining_count_, observing count becomes 0
|
90 |
|
→ fetch_sub(acq_rel) on remaining_count_, observing count becomes 0
|
| 91 |
|
4. Last task returns caller_ex_.dispatch(continuation_) via symmetric transfer
|
91 |
|
4. Last task returns caller_ex_.dispatch(continuation_) via symmetric transfer
|
| 92 |
|
5. Parent coroutine resumes and reads result_/winner_exception_
|
92 |
|
5. Parent coroutine resumes and reads result_/winner_exception_
|
| 93 |
|
|
93 |
|
|
| 94 |
|
Synchronization analysis:
|
94 |
|
Synchronization analysis:
|
| 95 |
|
- All fetch_sub operations on remaining_count_ form a release sequence
|
95 |
|
- All fetch_sub operations on remaining_count_ form a release sequence
|
| 96 |
|
- Winner's fetch_sub releases; subsequent fetch_sub operations participate
|
96 |
|
- Winner's fetch_sub releases; subsequent fetch_sub operations participate
|
| 97 |
|
in the modification order of remaining_count_
|
97 |
|
in the modification order of remaining_count_
|
| 98 |
|
- Last task's fetch_sub(acq_rel) synchronizes-with prior releases in the
|
98 |
|
- Last task's fetch_sub(acq_rel) synchronizes-with prior releases in the
|
| 99 |
|
modification order, establishing happens-before from winner's writes
|
99 |
|
modification order, establishing happens-before from winner's writes
|
| 100 |
|
- Executor dispatch() is expected to provide queue-based synchronization
|
100 |
|
- Executor dispatch() is expected to provide queue-based synchronization
|
| 101 |
|
(release-on-post, acquire-on-execute) completing the chain to parent
|
101 |
|
(release-on-post, acquire-on-execute) completing the chain to parent
|
| 102 |
|
- Even inline executors work (same thread = sequenced-before)
|
102 |
|
- Even inline executors work (same thread = sequenced-before)
|
| 103 |
|
|
103 |
|
|
| 104 |
|
Alternative considered: Adding winner_ready_ atomic (set with release after
|
104 |
|
Alternative considered: Adding winner_ready_ atomic (set with release after
|
| 105 |
|
storing winner data, acquired before reading) would make synchronization
|
105 |
|
storing winner data, acquired before reading) would make synchronization
|
| 106 |
|
self-contained and not rely on executor implementation details. Current
|
106 |
|
self-contained and not rely on executor implementation details. Current
|
| 107 |
|
approach is correct but requires careful reasoning about release sequences
|
107 |
|
approach is correct but requires careful reasoning about release sequences
|
| 108 |
|
|
108 |
|
|
| 109 |
|
|
109 |
|
|
| 110 |
|
|
110 |
|
|
| 111 |
|
|
111 |
|
|
| 112 |
|
Unlike when_all (which captures first exception, discards others), when_any
|
112 |
|
Unlike when_all (which captures first exception, discards others), when_any
|
| 113 |
|
treats exceptions as valid completions. If the winning task threw, that
|
113 |
|
treats exceptions as valid completions. If the winning task threw, that
|
| 114 |
|
exception is rethrown. Exceptions from non-winners are silently discarded.
|
114 |
|
exception is rethrown. Exceptions from non-winners are silently discarded.
|
| 115 |
|
|
115 |
|
|
| 116 |
|
|
116 |
|
|
| 117 |
|
|
117 |
|
|
| 118 |
|
|
118 |
|
|
| 119 |
|
|
119 |
|
|
| 120 |
|
|
120 |
|
|
| 121 |
|
|
121 |
|
|
| 122 |
|
/** Convert void to monostate for variant storage.
|
122 |
|
/** Convert void to monostate for variant storage.
|
| 123 |
|
|
123 |
|
|
| 124 |
|
std::variant<void, ...> is ill-formed, so void tasks contribute
|
124 |
|
std::variant<void, ...> is ill-formed, so void tasks contribute
|
| 125 |
|
std::monostate to the result variant instead. Non-void types
|
125 |
|
std::monostate to the result variant instead. Non-void types
|
| 126 |
|
|
126 |
|
|
| 127 |
|
|
127 |
|
|
| 128 |
|
@tparam T The type to potentially convert (void becomes monostate).
|
128 |
|
@tparam T The type to potentially convert (void becomes monostate).
|
| 129 |
|
|
129 |
|
|
| 130 |
|
|
130 |
|
|
| 131 |
|
using void_to_monostate_t = std::conditional_t<std::is_void_v<T>, std::monostate, T>;
|
131 |
|
using void_to_monostate_t = std::conditional_t<std::is_void_v<T>, std::monostate, T>;
|
| 132 |
|
|
132 |
|
|
| 133 |
|
// Type deduplication: std::variant requires unique alternative types.
|
133 |
|
// Type deduplication: std::variant requires unique alternative types.
|
| 134 |
|
// Fold left over the type list, appending each type only if not already present.
|
134 |
|
// Fold left over the type list, appending each type only if not already present.
|
| 135 |
|
template<typename Variant, typename T>
|
135 |
|
template<typename Variant, typename T>
|
| 136 |
|
struct variant_append_if_unique;
|
136 |
|
struct variant_append_if_unique;
|
| 137 |
|
|
137 |
|
|
| 138 |
|
template<typename... Vs, typename T>
|
138 |
|
template<typename... Vs, typename T>
|
| 139 |
|
struct variant_append_if_unique<std::variant<Vs...>, T>
|
139 |
|
struct variant_append_if_unique<std::variant<Vs...>, T>
|
| 140 |
|
|
140 |
|
|
| 141 |
|
using type = std::conditional_t<
|
141 |
|
using type = std::conditional_t<
|
| 142 |
|
(std::is_same_v<T, Vs> || ...),
|
142 |
|
(std::is_same_v<T, Vs> || ...),
|
| 143 |
|
|
143 |
|
|
| 144 |
|
|
144 |
|
|
| 145 |
|
|
145 |
|
|
| 146 |
|
|
146 |
|
|
| 147 |
|
template<typename Accumulated, typename... Remaining>
|
147 |
|
template<typename Accumulated, typename... Remaining>
|
| 148 |
|
|
148 |
|
|
| 149 |
|
|
149 |
|
|
| 150 |
|
template<typename Accumulated>
|
150 |
|
template<typename Accumulated>
|
| 151 |
|
struct deduplicate_impl<Accumulated>
|
151 |
|
struct deduplicate_impl<Accumulated>
|
| 152 |
|
|
152 |
|
|
| 153 |
|
using type = Accumulated;
|
153 |
|
using type = Accumulated;
|
| 154 |
|
|
154 |
|
|
| 155 |
|
|
155 |
|
|
| 156 |
|
template<typename Accumulated, typename T, typename... Rest>
|
156 |
|
template<typename Accumulated, typename T, typename... Rest>
|
| 157 |
|
struct deduplicate_impl<Accumulated, T, Rest...>
|
157 |
|
struct deduplicate_impl<Accumulated, T, Rest...>
|
| 158 |
|
|
158 |
|
|
| 159 |
|
using next = typename variant_append_if_unique<Accumulated, T>::type;
|
159 |
|
using next = typename variant_append_if_unique<Accumulated, T>::type;
|
| 160 |
|
using type = typename deduplicate_impl<next, Rest...>::type;
|
160 |
|
using type = typename deduplicate_impl<next, Rest...>::type;
|
| 161 |
|
|
161 |
|
|
| 162 |
|
|
162 |
|
|
| 163 |
|
// Deduplicated variant; void types become monostate before deduplication
|
163 |
|
// Deduplicated variant; void types become monostate before deduplication
|
| 164 |
|
template<typename T0, typename... Ts>
|
164 |
|
template<typename T0, typename... Ts>
|
| 165 |
|
using unique_variant_t = typename deduplicate_impl<
|
165 |
|
using unique_variant_t = typename deduplicate_impl<
|
| 166 |
|
std::variant<void_to_monostate_t<T0>>,
|
166 |
|
std::variant<void_to_monostate_t<T0>>,
|
| 167 |
|
void_to_monostate_t<Ts>...>::type;
|
167 |
|
void_to_monostate_t<Ts>...>::type;
|
| 168 |
|
|
168 |
|
|
| 169 |
|
// Result: (winner_index, deduplicated_variant). Use index to disambiguate
|
169 |
|
// Result: (winner_index, deduplicated_variant). Use index to disambiguate
|
| 170 |
|
// when multiple tasks share the same return type.
|
170 |
|
// when multiple tasks share the same return type.
|
| 171 |
|
template<typename T0, typename... Ts>
|
171 |
|
template<typename T0, typename... Ts>
|
| 172 |
|
using when_any_result_t = std::pair<std::size_t, unique_variant_t<T0, Ts...>>;
|
172 |
|
using when_any_result_t = std::pair<std::size_t, unique_variant_t<T0, Ts...>>;
|
| 173 |
|
|
173 |
|
|
| 174 |
|
// Extract result type from any awaitable via await_resume()
|
174 |
|
// Extract result type from any awaitable via await_resume()
|
| 175 |
|
|
175 |
|
|
| 176 |
|
using awaitable_result_t = decltype(std::declval<std::decay_t<A>&>().await_resume());
|
176 |
|
using awaitable_result_t = decltype(std::declval<std::decay_t<A>&>().await_resume());
|
| 177 |
|
|
177 |
|
|
| 178 |
|
/** Core shared state for when_any operations.
|
178 |
|
/** Core shared state for when_any operations.
|
| 179 |
|
|
179 |
|
|
| 180 |
|
Contains all members and methods common to both heterogeneous (variadic)
|
180 |
|
Contains all members and methods common to both heterogeneous (variadic)
|
| 181 |
|
and homogeneous (range) when_any implementations. State classes embed
|
181 |
|
and homogeneous (range) when_any implementations. State classes embed
|
| 182 |
|
this via composition to avoid CRTP destructor ordering issues.
|
182 |
|
this via composition to avoid CRTP destructor ordering issues.
|
| 183 |
|
|
183 |
|
|
| 184 |
|
|
184 |
|
|
| 185 |
|
Atomic operations protect winner selection and completion count.
|
185 |
|
Atomic operations protect winner selection and completion count.
|
| 186 |
|
|
186 |
|
|
| 187 |
|
|
187 |
|
|
| 188 |
|
|
188 |
|
|
| 189 |
|
std::atomic<std::size_t> remaining_count_;
|
189 |
|
std::atomic<std::size_t> remaining_count_;
|
| 190 |
|
std::size_t winner_index_{0};
|
190 |
|
std::size_t winner_index_{0};
|
| 191 |
|
std::exception_ptr winner_exception_;
|
191 |
|
std::exception_ptr winner_exception_;
|
| 192 |
|
std::stop_source stop_source_;
|
192 |
|
std::stop_source stop_source_;
|
| 193 |
|
|
193 |
|
|
| 194 |
|
// Bridges parent's stop token to our stop_source
|
194 |
|
// Bridges parent's stop token to our stop_source
|
| 195 |
|
|
195 |
|
|
| 196 |
|
|
196 |
|
|
| 197 |
|
std::stop_source* source_;
|
197 |
|
std::stop_source* source_;
|
| 198 |
|
void operator()() const noexcept { source_->request_stop(); }
|
198 |
|
void operator()() const noexcept { source_->request_stop(); }
|
| 199 |
|
|
199 |
|
|
| 200 |
|
using stop_callback_t = std::stop_callback<stop_callback_fn>;
|
200 |
|
using stop_callback_t = std::stop_callback<stop_callback_fn>;
|
| 201 |
|
std::optional<stop_callback_t> parent_stop_callback_;
|
201 |
|
std::optional<stop_callback_t> parent_stop_callback_;
|
| 202 |
|
|
202 |
|
|
| 203 |
|
|
203 |
|
|
| 204 |
|
|
204 |
|
|
| 205 |
|
|
205 |
|
|
| 206 |
|
// Placed last to avoid padding (1-byte atomic followed by 8-byte aligned members)
|
206 |
|
// Placed last to avoid padding (1-byte atomic followed by 8-byte aligned members)
|
| 207 |
|
std::atomic<bool> has_winner_{false};
|
207 |
|
std::atomic<bool> has_winner_{false};
|
| 208 |
|
|
208 |
|
|
| 209 |
|
explicit when_any_core(std::size_t count) noexcept
|
209 |
|
explicit when_any_core(std::size_t count) noexcept
|
| 210 |
|
: remaining_count_(count)
|
210 |
|
: remaining_count_(count)
|
| 211 |
|
|
211 |
|
|
| 212 |
|
|
212 |
|
|
| 213 |
|
|
213 |
|
|
| 214 |
|
/** Atomically claim winner status; exactly one task succeeds. */
|
214 |
|
/** Atomically claim winner status; exactly one task succeeds. */
|
| 215 |
|
bool try_win(std::size_t index) noexcept
|
215 |
|
bool try_win(std::size_t index) noexcept
|
| 216 |
|
|
216 |
|
|
| 217 |
|
|
217 |
|
|
| 218 |
|
if(has_winner_.compare_exchange_strong(
|
218 |
|
if(has_winner_.compare_exchange_strong(
|
| 219 |
|
expected, true, std::memory_order_acq_rel))
|
219 |
|
expected, true, std::memory_order_acq_rel))
|
| 220 |
|
|
220 |
|
|
| 221 |
|
|
221 |
|
|
| 222 |
|
stop_source_.request_stop();
|
222 |
|
stop_source_.request_stop();
|
| 223 |
|
|
223 |
|
|
| 224 |
|
|
224 |
|
|
| 225 |
|
|
225 |
|
|
| 226 |
|
|
226 |
|
|
| 227 |
|
|
227 |
|
|
| 228 |
|
/** @pre try_win() returned true. */
|
228 |
|
/** @pre try_win() returned true. */
|
| 229 |
|
void set_winner_exception(std::exception_ptr ep) noexcept
|
229 |
|
void set_winner_exception(std::exception_ptr ep) noexcept
|
| 230 |
|
|
230 |
|
|
| 231 |
|
|
231 |
|
|
| 232 |
|
|
232 |
|
|
| 233 |
|
|
233 |
|
|
| 234 |
|
/** Last task to complete resumes the parent via symmetric transfer. */
|
234 |
|
/** Last task to complete resumes the parent via symmetric transfer. */
|
| 235 |
|
|
235 |
|
|
| 236 |
|
|
236 |
|
|
| 237 |
|
auto remaining = remaining_count_.fetch_sub(1, std::memory_order_acq_rel);
|
237 |
|
auto remaining = remaining_count_.fetch_sub(1, std::memory_order_acq_rel);
|
| 238 |
|
|
238 |
|
|
| 239 |
|
caller_ex_.dispatch(continuation_);
|
239 |
|
caller_ex_.dispatch(continuation_);
|
| 240 |
|
return std::noop_coroutine();
|
240 |
|
return std::noop_coroutine();
|
| 241 |
|
|
241 |
|
|
| 242 |
|
|
242 |
|
|
| 243 |
|
|
243 |
|
|
| 244 |
|
/** Shared state for heterogeneous when_any operation.
|
244 |
|
/** Shared state for heterogeneous when_any operation.
|
| 245 |
|
|
245 |
|
|
| 246 |
|
Coordinates winner selection, result storage, and completion tracking
|
246 |
|
Coordinates winner selection, result storage, and completion tracking
|
| 247 |
|
for all child tasks in a when_any operation. Uses composition with
|
247 |
|
for all child tasks in a when_any operation. Uses composition with
|
| 248 |
|
when_any_core for shared functionality.
|
248 |
|
when_any_core for shared functionality.
|
| 249 |
|
|
249 |
|
|
| 250 |
|
|
250 |
|
|
| 251 |
|
Allocated on the parent coroutine's frame, outlives all runners.
|
251 |
|
Allocated on the parent coroutine's frame, outlives all runners.
|
| 252 |
|
|
252 |
|
|
| 253 |
|
@tparam T0 First task's result type.
|
253 |
|
@tparam T0 First task's result type.
|
| 254 |
|
@tparam Ts Remaining tasks' result types.
|
254 |
|
@tparam Ts Remaining tasks' result types.
|
| 255 |
|
|
255 |
|
|
| 256 |
|
template<typename T0, typename... Ts>
|
256 |
|
template<typename T0, typename... Ts>
|
| 257 |
|
|
257 |
|
|
| 258 |
|
|
258 |
|
|
| 259 |
|
static constexpr std::size_t task_count = 1 + sizeof...(Ts);
|
259 |
|
static constexpr std::size_t task_count = 1 + sizeof...(Ts);
|
| 260 |
|
using variant_type = unique_variant_t<T0, Ts...>;
|
260 |
|
using variant_type = unique_variant_t<T0, Ts...>;
|
| 261 |
|
|
261 |
|
|
| 262 |
|
|
262 |
|
|
| 263 |
|
std::optional<variant_type> result_;
|
263 |
|
std::optional<variant_type> result_;
|
| 264 |
|
std::array<coro, task_count> runner_handles_{};
|
264 |
|
std::array<coro, task_count> runner_handles_{};
|
| 265 |
|
|
265 |
|
|
| 266 |
|
|
266 |
|
|
| 267 |
|
|
267 |
|
|
| 268 |
|
|
268 |
|
|
| 269 |
|
|
269 |
|
|
| 270 |
|
|
270 |
|
|
| 271 |
|
|
271 |
|
|
| 272 |
|
|
272 |
|
|
| 273 |
|
for(auto h : runner_handles_)
|
273 |
|
for(auto h : runner_handles_)
|
| 274 |
|
|
274 |
|
|
| 275 |
|
|
275 |
|
|
| 276 |
|
|
276 |
|
|
| 277 |
|
|
277 |
|
|
| 278 |
|
/** @pre core_.try_win() returned true.
|
278 |
|
/** @pre core_.try_win() returned true.
|
| 279 |
|
@note Uses in_place_type (not index) because variant is deduplicated.
|
279 |
|
@note Uses in_place_type (not index) because variant is deduplicated.
|
| 280 |
|
|
280 |
|
|
| 281 |
|
|
281 |
|
|
| 282 |
|
void set_winner_result(T value)
|
282 |
|
void set_winner_result(T value)
|
| 283 |
|
noexcept(std::is_nothrow_move_constructible_v<T>)
|
283 |
|
noexcept(std::is_nothrow_move_constructible_v<T>)
|
| 284 |
|
|
284 |
|
|
| 285 |
|
result_.emplace(std::in_place_type<T>, std::move(value));
|
285 |
|
result_.emplace(std::in_place_type<T>, std::move(value));
|
| 286 |
|
|
286 |
|
|
| 287 |
|
|
287 |
|
|
| 288 |
|
/** @pre core_.try_win() returned true. */
|
288 |
|
/** @pre core_.try_win() returned true. */
|
| 289 |
|
void set_winner_void() noexcept
|
289 |
|
void set_winner_void() noexcept
|
| 290 |
|
|
290 |
|
|
| 291 |
|
result_.emplace(std::in_place_type<std::monostate>, std::monostate{});
|
291 |
|
result_.emplace(std::in_place_type<std::monostate>, std::monostate{});
|
| 292 |
|
|
292 |
|
|
| 293 |
|
|
293 |
|
|
| 294 |
|
|
294 |
|
|
| 295 |
|
/** Wrapper coroutine that runs a single child task for when_any.
|
295 |
|
/** Wrapper coroutine that runs a single child task for when_any.
|
| 296 |
|
|
296 |
|
|
| 297 |
|
Propagates executor/stop_token to the child, attempts to claim winner
|
297 |
|
Propagates executor/stop_token to the child, attempts to claim winner
|
| 298 |
|
status on completion, and signals completion for cleanup coordination.
|
298 |
|
status on completion, and signals completion for cleanup coordination.
|
| 299 |
|
|
299 |
|
|
| 300 |
|
@tparam StateType The state type (when_any_state or when_any_homogeneous_state).
|
300 |
|
@tparam StateType The state type (when_any_state or when_any_homogeneous_state).
|
| 301 |
|
|
301 |
|
|
| 302 |
|
template<typename StateType>
|
302 |
|
template<typename StateType>
|
| 303 |
|
|
303 |
|
|
| 304 |
|
|
304 |
|
|
| 305 |
|
struct promise_type // : frame_allocating_base // DISABLED FOR TESTING
|
305 |
|
struct promise_type // : frame_allocating_base // DISABLED FOR TESTING
|
| 306 |
|
|
306 |
|
|
| 307 |
|
StateType* state_ = nullptr;
|
307 |
|
StateType* state_ = nullptr;
|
| 308 |
|
|
308 |
|
|
| 309 |
|
|
309 |
|
|
| 310 |
|
std::stop_token stop_token_;
|
310 |
|
std::stop_token stop_token_;
|
| 311 |
|
|
311 |
|
|
| 312 |
|
when_any_runner get_return_object() noexcept
|
312 |
|
when_any_runner get_return_object() noexcept
|
| 313 |
|
|
313 |
|
|
| 314 |
|
return when_any_runner(std::coroutine_handle<promise_type>::from_promise(*this));
|
314 |
|
return when_any_runner(std::coroutine_handle<promise_type>::from_promise(*this));
|
| 315 |
|
|
315 |
|
|
| 316 |
|
|
316 |
|
|
| 317 |
|
// Starts suspended; launcher sets up state/ex/token then resumes
|
317 |
|
// Starts suspended; launcher sets up state/ex/token then resumes
|
| 318 |
|
std::suspend_always initial_suspend() noexcept
|
318 |
|
std::suspend_always initial_suspend() noexcept
|
| 319 |
|
|
319 |
|
|
| 320 |
|
|
320 |
|
|
| 321 |
|
|
321 |
|
|
| 322 |
|
|
322 |
|
|
| 323 |
|
auto final_suspend() noexcept
|
323 |
|
auto final_suspend() noexcept
|
| 324 |
|
|
324 |
|
|
| 325 |
|
|
325 |
|
|
| 326 |
|
|
326 |
|
|
| 327 |
|
|
327 |
|
|
| 328 |
|
bool await_ready() const noexcept { return false; }
|
328 |
|
bool await_ready() const noexcept { return false; }
|
| 329 |
|
coro await_suspend(coro) noexcept { return p_->state_->core_.signal_completion(); }
|
329 |
|
coro await_suspend(coro) noexcept { return p_->state_->core_.signal_completion(); }
|
| 330 |
|
void await_resume() const noexcept {}
|
330 |
|
void await_resume() const noexcept {}
|
| 331 |
|
|
331 |
|
|
| 332 |
|
|
332 |
|
|
| 333 |
|
|
333 |
|
|
| 334 |
|
|
334 |
|
|
| 335 |
|
void return_void() noexcept {}
|
335 |
|
void return_void() noexcept {}
|
| 336 |
|
|
336 |
|
|
| 337 |
|
// Exceptions are valid completions in when_any (unlike when_all)
|
337 |
|
// Exceptions are valid completions in when_any (unlike when_all)
|
| 338 |
|
void unhandled_exception()
|
338 |
|
void unhandled_exception()
|
| 339 |
|
|
339 |
|
|
| 340 |
|
if(state_->core_.try_win(index_))
|
340 |
|
if(state_->core_.try_win(index_))
|
| 341 |
|
state_->core_.set_winner_exception(std::current_exception());
|
341 |
|
state_->core_.set_winner_exception(std::current_exception());
|
| 342 |
|
|
342 |
|
|
| 343 |
|
|
343 |
|
|
| 344 |
|
/** Injects executor and stop token into child awaitables. */
|
344 |
|
/** Injects executor and stop token into child awaitables. */
|
| 345 |
|
template<class Awaitable>
|
345 |
|
template<class Awaitable>
|
| 346 |
|
|
346 |
|
|
| 347 |
|
|
347 |
|
|
| 348 |
|
std::decay_t<Awaitable> a_;
|
348 |
|
std::decay_t<Awaitable> a_;
|
| 349 |
|
|
349 |
|
|
| 350 |
|
|
350 |
|
|
| 351 |
|
bool await_ready() { return a_.await_ready(); }
|
351 |
|
bool await_ready() { return a_.await_ready(); }
|
| 352 |
|
auto await_resume() { return a_.await_resume(); }
|
352 |
|
auto await_resume() { return a_.await_resume(); }
|
| 353 |
|
|
353 |
|
|
| 354 |
|
|
354 |
|
|
| 355 |
|
auto await_suspend(std::coroutine_handle<Promise> h)
|
355 |
|
auto await_suspend(std::coroutine_handle<Promise> h)
|
| 356 |
|
|
356 |
|
|
| 357 |
|
return a_.await_suspend(h, p_->ex_, p_->stop_token_);
|
357 |
|
return a_.await_suspend(h, p_->ex_, p_->stop_token_);
|
| 358 |
|
|
358 |
|
|
| 359 |
|
|
359 |
|
|
| 360 |
|
|
360 |
|
|
| 361 |
|
template<class Awaitable>
|
361 |
|
template<class Awaitable>
|
| 362 |
|
auto await_transform(Awaitable&& a)
|
362 |
|
auto await_transform(Awaitable&& a)
|
| 363 |
|
|
363 |
|
|
| 364 |
|
using A = std::decay_t<Awaitable>;
|
364 |
|
using A = std::decay_t<Awaitable>;
|
| 365 |
|
if constexpr (IoAwaitable<A>)
|
365 |
|
if constexpr (IoAwaitable<A>)
|
| 366 |
|
|
366 |
|
|
| 367 |
|
return transform_awaiter<Awaitable>{
|
367 |
|
return transform_awaiter<Awaitable>{
|
| 368 |
|
std::forward<Awaitable>(a), this};
|
368 |
|
std::forward<Awaitable>(a), this};
|
| 369 |
|
|
369 |
|
|
| 370 |
|
|
370 |
|
|
| 371 |
|
|
371 |
|
|
| 372 |
|
static_assert(sizeof(A) == 0, "requires IoAwaitable");
|
372 |
|
static_assert(sizeof(A) == 0, "requires IoAwaitable");
|
| 373 |
|
|
373 |
|
|
| 374 |
|
|
374 |
|
|
| 375 |
|
|
375 |
|
|
| 376 |
|
|
376 |
|
|
| 377 |
|
std::coroutine_handle<promise_type> h_;
|
377 |
|
std::coroutine_handle<promise_type> h_;
|
| 378 |
|
|
378 |
|
|
| 379 |
|
explicit when_any_runner(std::coroutine_handle<promise_type> h) noexcept
|
379 |
|
explicit when_any_runner(std::coroutine_handle<promise_type> h) noexcept
|
| 380 |
|
|
380 |
|
|
| 381 |
|
|
381 |
|
|
| 382 |
|
|
382 |
|
|
| 383 |
|
|
383 |
|
|
| 384 |
|
// Enable move for all clang versions - some versions need it
|
384 |
|
// Enable move for all clang versions - some versions need it
|
| 385 |
|
when_any_runner(when_any_runner&& other) noexcept : h_(std::exchange(other.h_, nullptr)) {}
|
385 |
|
when_any_runner(when_any_runner&& other) noexcept : h_(std::exchange(other.h_, nullptr)) {}
|
| 386 |
|
|
386 |
|
|
| 387 |
|
|
387 |
|
|
| 388 |
|
when_any_runner(when_any_runner const&) = delete;
|
388 |
|
when_any_runner(when_any_runner const&) = delete;
|
| 389 |
|
when_any_runner& operator=(when_any_runner const&) = delete;
|
389 |
|
when_any_runner& operator=(when_any_runner const&) = delete;
|
| 390 |
|
when_any_runner& operator=(when_any_runner&&) = delete;
|
390 |
|
when_any_runner& operator=(when_any_runner&&) = delete;
|
| 391 |
|
|
391 |
|
|
| 392 |
|
|
392 |
|
|
| 393 |
|
|
393 |
|
|
| 394 |
|
return std::exchange(h_, nullptr);
|
394 |
|
return std::exchange(h_, nullptr);
|
| 395 |
|
|
395 |
|
|
| 396 |
|
|
396 |
|
|
| 397 |
|
|
397 |
|
|
| 398 |
|
/** Wraps a child awaitable, attempts to claim winner on completion.
|
398 |
|
/** Wraps a child awaitable, attempts to claim winner on completion.
|
| 399 |
|
|
399 |
|
|
| 400 |
|
Uses requires-expressions to detect state capabilities:
|
400 |
|
Uses requires-expressions to detect state capabilities:
|
| 401 |
|
- set_winner_void(): for heterogeneous void tasks (stores monostate)
|
401 |
|
- set_winner_void(): for heterogeneous void tasks (stores monostate)
|
| 402 |
|
- set_winner_result(): for non-void tasks
|
402 |
|
- set_winner_result(): for non-void tasks
|
| 403 |
|
- Neither: for homogeneous void tasks (no result storage)
|
403 |
|
- Neither: for homogeneous void tasks (no result storage)
|
| 404 |
|
|
404 |
|
|
| 405 |
|
template<IoAwaitable Awaitable, typename StateType>
|
405 |
|
template<IoAwaitable Awaitable, typename StateType>
|
| 406 |
|
when_any_runner<StateType>
|
406 |
|
when_any_runner<StateType>
|
| 407 |
|
make_when_any_runner(Awaitable inner, StateType* state, std::size_t index)
|
407 |
|
make_when_any_runner(Awaitable inner, StateType* state, std::size_t index)
|
| 408 |
|
|
408 |
|
|
| 409 |
|
using T = awaitable_result_t<Awaitable>;
|
409 |
|
using T = awaitable_result_t<Awaitable>;
|
| 410 |
|
if constexpr (std::is_void_v<T>)
|
410 |
|
if constexpr (std::is_void_v<T>)
|
| 411 |
|
|
411 |
|
|
| 412 |
|
co_await std::move(inner);
|
412 |
|
co_await std::move(inner);
|
| 413 |
|
if(state->core_.try_win(index))
|
413 |
|
if(state->core_.try_win(index))
|
| 414 |
|
|
414 |
|
|
| 415 |
|
// Heterogeneous void tasks store monostate in the variant
|
415 |
|
// Heterogeneous void tasks store monostate in the variant
|
| 416 |
|
if constexpr (requires { state->set_winner_void(); })
|
416 |
|
if constexpr (requires { state->set_winner_void(); })
|
| 417 |
|
state->set_winner_void();
|
417 |
|
state->set_winner_void();
|
| 418 |
|
// Homogeneous void tasks have no result to store
|
418 |
|
// Homogeneous void tasks have no result to store
|
| 419 |
|
|
419 |
|
|
| 420 |
|
|
420 |
|
|
| 421 |
|
|
421 |
|
|
| 422 |
|
|
422 |
|
|
| 423 |
|
auto result = co_await std::move(inner);
|
423 |
|
auto result = co_await std::move(inner);
|
| 424 |
|
if(state->core_.try_win(index))
|
424 |
|
if(state->core_.try_win(index))
|
| 425 |
|
|
425 |
|
|
| 426 |
|
// Defensive: move should not throw (already moved once), but we
|
426 |
|
// Defensive: move should not throw (already moved once), but we
|
| 427 |
|
// catch just in case since an uncaught exception would be devastating.
|
427 |
|
// catch just in case since an uncaught exception would be devastating.
|
| 428 |
|
|
428 |
|
|
| 429 |
|
|
429 |
|
|
| 430 |
|
state->set_winner_result(std::move(result));
|
430 |
|
state->set_winner_result(std::move(result));
|
| 431 |
|
|
431 |
|
|
| 432 |
|
|
432 |
|
|
| 433 |
|
|
433 |
|
|
| 434 |
|
state->core_.set_winner_exception(std::current_exception());
|
434 |
|
state->core_.set_winner_exception(std::current_exception());
|
| 435 |
|
|
435 |
|
|
| 436 |
|
|
436 |
|
|
| 437 |
|
|
437 |
|
|
| 438 |
|
|
438 |
|
|
| 439 |
|
|
439 |
|
|
| 440 |
|
/** Launches all runners concurrently; see await_suspend for lifetime concerns. */
|
440 |
|
/** Launches all runners concurrently; see await_suspend for lifetime concerns. */
|
| 441 |
|
template<IoAwaitable... Awaitables>
|
441 |
|
template<IoAwaitable... Awaitables>
|
| 442 |
|
|
442 |
|
|
| 443 |
|
|
443 |
|
|
| 444 |
|
using state_type = when_any_state<awaitable_result_t<Awaitables>...>;
|
444 |
|
using state_type = when_any_state<awaitable_result_t<Awaitables>...>;
|
| 445 |
|
|
445 |
|
|
| 446 |
|
std::tuple<Awaitables...>* tasks_;
|
446 |
|
std::tuple<Awaitables...>* tasks_;
|
| 447 |
|
|
447 |
|
|
| 448 |
|
|
448 |
|
|
| 449 |
|
|
449 |
|
|
| 450 |
|
|
450 |
|
|
| 451 |
|
std::tuple<Awaitables...>* tasks,
|
451 |
|
std::tuple<Awaitables...>* tasks,
|
| 452 |
|
|
452 |
|
|
| 453 |
|
|
453 |
|
|
| 454 |
|
|
454 |
|
|
| 455 |
|
|
455 |
|
|
| 456 |
|
|
456 |
|
|
| 457 |
|
|
457 |
|
|
| 458 |
|
bool await_ready() const noexcept
|
458 |
|
bool await_ready() const noexcept
|
| 459 |
|
|
459 |
|
|
| 460 |
|
return sizeof...(Awaitables) == 0;
|
460 |
|
return sizeof...(Awaitables) == 0;
|
| 461 |
|
|
461 |
|
|
| 462 |
|
|
462 |
|
|
| 463 |
|
/** CRITICAL: If the last task finishes synchronously, parent resumes and
|
463 |
|
/** CRITICAL: If the last task finishes synchronously, parent resumes and
|
| 464 |
|
destroys this object before await_suspend returns. Must not reference
|
464 |
|
destroys this object before await_suspend returns. Must not reference
|
| 465 |
|
`this` after the final launch_one call.
|
465 |
|
`this` after the final launch_one call.
|
| 466 |
|
|
466 |
|
|
| 467 |
|
|
467 |
|
|
| 468 |
|
coro await_suspend(coro continuation, Ex const& caller_ex, std::stop_token parent_token = {})
|
468 |
|
coro await_suspend(coro continuation, Ex const& caller_ex, std::stop_token parent_token = {})
|
| 469 |
|
|
469 |
|
|
| 470 |
|
state_->core_.continuation_ = continuation;
|
470 |
|
state_->core_.continuation_ = continuation;
|
| 471 |
|
state_->core_.caller_ex_ = caller_ex;
|
471 |
|
state_->core_.caller_ex_ = caller_ex;
|
| 472 |
|
|
472 |
|
|
| 473 |
|
if(parent_token.stop_possible())
|
473 |
|
if(parent_token.stop_possible())
|
| 474 |
|
|
474 |
|
|
| 475 |
|
state_->core_.parent_stop_callback_.emplace(
|
475 |
|
state_->core_.parent_stop_callback_.emplace(
|
| 476 |
|
|
476 |
|
|
| 477 |
|
when_any_core::stop_callback_fn{&state_->core_.stop_source_});
|
477 |
|
when_any_core::stop_callback_fn{&state_->core_.stop_source_});
|
| 478 |
|
|
478 |
|
|
| 479 |
|
if(parent_token.stop_requested())
|
479 |
|
if(parent_token.stop_requested())
|
| 480 |
|
state_->core_.stop_source_.request_stop();
|
480 |
|
state_->core_.stop_source_.request_stop();
|
| 481 |
|
|
481 |
|
|
| 482 |
|
|
482 |
|
|
| 483 |
|
auto token = state_->core_.stop_source_.get_token();
|
483 |
|
auto token = state_->core_.stop_source_.get_token();
|
| 484 |
|
[&]<std::size_t... Is>(std::index_sequence<Is...>) {
|
484 |
|
[&]<std::size_t... Is>(std::index_sequence<Is...>) {
|
| 485 |
|
(..., launch_one<Is>(caller_ex, token));
|
485 |
|
(..., launch_one<Is>(caller_ex, token));
|
| 486 |
|
}(std::index_sequence_for<Awaitables...>{});
|
486 |
|
}(std::index_sequence_for<Awaitables...>{});
|
| 487 |
|
|
487 |
|
|
| 488 |
|
return std::noop_coroutine();
|
488 |
|
return std::noop_coroutine();
|
| 489 |
|
|
489 |
|
|
| 490 |
|
|
490 |
|
|
| 491 |
|
void await_resume() const noexcept
|
491 |
|
void await_resume() const noexcept
|
| 492 |
|
|
492 |
|
|
| 493 |
|
|
493 |
|
|
| 494 |
|
|
494 |
|
|
| 495 |
|
|
495 |
|
|
| 496 |
|
/** @pre Ex::dispatch() and coro::resume() must not throw (handle may leak). */
|
496 |
|
/** @pre Ex::dispatch() and coro::resume() must not throw (handle may leak). */
|
| 497 |
|
template<std::size_t I, Executor Ex>
|
497 |
|
template<std::size_t I, Executor Ex>
|
| 498 |
|
void launch_one(Ex const& caller_ex, std::stop_token token)
|
498 |
|
void launch_one(Ex const& caller_ex, std::stop_token token)
|
| 499 |
|
|
499 |
|
|
| 500 |
|
auto runner = make_when_any_runner(
|
500 |
|
auto runner = make_when_any_runner(
|
| 501 |
|
std::move(std::get<I>(*tasks_)), state_, I);
|
501 |
|
std::move(std::get<I>(*tasks_)), state_, I);
|
| 502 |
|
|
502 |
|
|
| 503 |
|
auto h = runner.release();
|
503 |
|
auto h = runner.release();
|
| 504 |
|
h.promise().state_ = state_;
|
504 |
|
h.promise().state_ = state_;
|
| 505 |
|
|
505 |
|
|
| 506 |
|
h.promise().ex_ = caller_ex;
|
506 |
|
h.promise().ex_ = caller_ex;
|
| 507 |
|
h.promise().stop_token_ = token;
|
507 |
|
h.promise().stop_token_ = token;
|
| 508 |
|
|
508 |
|
|
| 509 |
|
|
509 |
|
|
| 510 |
|
state_->runner_handles_[I] = ch;
|
510 |
|
state_->runner_handles_[I] = ch;
|
| 511 |
|
|
511 |
|
|
| 512 |
|
|
512 |
|
|
| 513 |
|
|
513 |
|
|
| 514 |
|
|
514 |
|
|
| 515 |
|
|
515 |
|
|
| 516 |
|
|
516 |
|
|
| 517 |
|
/** Wait for the first awaitable to complete.
|
517 |
|
/** Wait for the first awaitable to complete.
|
| 518 |
|
|
518 |
|
|
| 519 |
|
Races multiple heterogeneous awaitables concurrently and returns when the
|
519 |
|
Races multiple heterogeneous awaitables concurrently and returns when the
|
| 520 |
|
first one completes. The result includes the winner's index and a
|
520 |
|
first one completes. The result includes the winner's index and a
|
| 521 |
|
deduplicated variant containing the result value.
|
521 |
|
deduplicated variant containing the result value.
|
| 522 |
|
|
522 |
|
|
| 523 |
|
|
523 |
|
|
| 524 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
524 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
| 525 |
|
are launched concurrently and execute in parallel. The coroutine resumes
|
525 |
|
are launched concurrently and execute in parallel. The coroutine resumes
|
| 526 |
|
only after all awaitables have completed, even though the winner is
|
526 |
|
only after all awaitables have completed, even though the winner is
|
| 527 |
|
determined by the first to finish.
|
527 |
|
determined by the first to finish.
|
| 528 |
|
|
528 |
|
|
| 529 |
|
@par Completion Conditions
|
529 |
|
@par Completion Conditions
|
| 530 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
530 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
| 531 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
531 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
| 532 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
532 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
| 533 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
533 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
| 534 |
|
@li The winner's result is returned; if the winner threw, the exception is rethrown
|
534 |
|
@li The winner's result is returned; if the winner threw, the exception is rethrown
|
| 535 |
|
|
535 |
|
|
| 536 |
|
@par Cancellation Semantics
|
536 |
|
@par Cancellation Semantics
|
| 537 |
|
Cancellation is supported via stop_token propagated through the
|
537 |
|
Cancellation is supported via stop_token propagated through the
|
| 538 |
|
|
538 |
|
|
| 539 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
539 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
| 540 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
540 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
| 541 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
541 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
| 542 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
542 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
| 543 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
543 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
| 544 |
|
|
544 |
|
|
| 545 |
|
|
545 |
|
|
| 546 |
|
All awaitables are launched concurrently before any can complete.
|
546 |
|
All awaitables are launched concurrently before any can complete.
|
| 547 |
|
The launcher iterates through the arguments, starting each task on the
|
547 |
|
The launcher iterates through the arguments, starting each task on the
|
| 548 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
548 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
| 549 |
|
executors or interleave on single-threaded executors. There is no
|
549 |
|
executors or interleave on single-threaded executors. There is no
|
| 550 |
|
guaranteed ordering of task completion.
|
550 |
|
guaranteed ordering of task completion.
|
| 551 |
|
|
551 |
|
|
| 552 |
|
@par Notable Error Conditions
|
552 |
|
@par Notable Error Conditions
|
| 553 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
553 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
| 554 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
554 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
| 555 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
555 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
| 556 |
|
|
556 |
|
|
| 557 |
|
|
557 |
|
|
| 558 |
|
|
558 |
|
|
| 559 |
|
|
559 |
|
|
| 560 |
|
auto [index, result] = co_await when_any(
|
560 |
|
auto [index, result] = co_await when_any(
|
| 561 |
|
fetch_from_primary(), // task<Response>
|
561 |
|
fetch_from_primary(), // task<Response>
|
| 562 |
|
fetch_from_backup() // task<Response>
|
562 |
|
fetch_from_backup() // task<Response>
|
| 563 |
|
|
563 |
|
|
| 564 |
|
// index is 0 or 1, result holds the winner's Response
|
564 |
|
// index is 0 or 1, result holds the winner's Response
|
| 565 |
|
auto response = std::get<Response>(result);
|
565 |
|
auto response = std::get<Response>(result);
|
| 566 |
|
|
566 |
|
|
| 567 |
|
|
567 |
|
|
| 568 |
|
|
568 |
|
|
| 569 |
|
@par Example with Heterogeneous Types
|
569 |
|
@par Example with Heterogeneous Types
|
| 570 |
|
|
570 |
|
|
| 571 |
|
task<void> mixed_types() {
|
571 |
|
task<void> mixed_types() {
|
| 572 |
|
auto [index, result] = co_await when_any(
|
572 |
|
auto [index, result] = co_await when_any(
|
| 573 |
|
fetch_int(), // task<int>
|
573 |
|
fetch_int(), // task<int>
|
| 574 |
|
fetch_string() // task<std::string>
|
574 |
|
fetch_string() // task<std::string>
|
| 575 |
|
|
575 |
|
|
| 576 |
|
|
576 |
|
|
| 577 |
|
std::cout << "Got int: " << std::get<int>(result) << "\n";
|
577 |
|
std::cout << "Got int: " << std::get<int>(result) << "\n";
|
| 578 |
|
|
578 |
|
|
| 579 |
|
std::cout << "Got string: " << std::get<std::string>(result) << "\n";
|
579 |
|
std::cout << "Got string: " << std::get<std::string>(result) << "\n";
|
| 580 |
|
|
580 |
|
|
| 581 |
|
|
581 |
|
|
| 582 |
|
|
582 |
|
|
| 583 |
|
@tparam A0 First awaitable type (must satisfy IoAwaitable).
|
583 |
|
@tparam A0 First awaitable type (must satisfy IoAwaitable).
|
| 584 |
|
@tparam As Remaining awaitable types (must satisfy IoAwaitable).
|
584 |
|
@tparam As Remaining awaitable types (must satisfy IoAwaitable).
|
| 585 |
|
@param a0 The first awaitable to race.
|
585 |
|
@param a0 The first awaitable to race.
|
| 586 |
|
@param as Additional awaitables to race concurrently.
|
586 |
|
@param as Additional awaitables to race concurrently.
|
| 587 |
|
@return A task yielding a pair of (winner_index, result_variant).
|
587 |
|
@return A task yielding a pair of (winner_index, result_variant).
|
| 588 |
|
|
588 |
|
|
| 589 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
589 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
| 590 |
|
|
590 |
|
|
| 591 |
|
|
591 |
|
|
| 592 |
|
Awaitables are moved into the coroutine frame; original objects become
|
592 |
|
Awaitables are moved into the coroutine frame; original objects become
|
| 593 |
|
empty after the call. When multiple awaitables share the same return type,
|
593 |
|
empty after the call. When multiple awaitables share the same return type,
|
| 594 |
|
the variant is deduplicated to contain only unique types. Use the winner
|
594 |
|
the variant is deduplicated to contain only unique types. Use the winner
|
| 595 |
|
index to determine which awaitable completed first. Void awaitables
|
595 |
|
index to determine which awaitable completed first. Void awaitables
|
| 596 |
|
contribute std::monostate to the variant.
|
596 |
|
contribute std::monostate to the variant.
|
| 597 |
|
|
597 |
|
|
| 598 |
|
@see when_all, IoAwaitable
|
598 |
|
@see when_all, IoAwaitable
|
| 599 |
|
|
599 |
|
|
| 600 |
|
template<IoAwaitable A0, IoAwaitable... As>
|
600 |
|
template<IoAwaitable A0, IoAwaitable... As>
|
| 601 |
|
[[nodiscard]] auto when_any(A0 a0, As... as)
|
601 |
|
[[nodiscard]] auto when_any(A0 a0, As... as)
|
| 602 |
|
-> task<detail::when_any_result_t<
|
602 |
|
-> task<detail::when_any_result_t<
|
| 603 |
|
detail::awaitable_result_t<A0>,
|
603 |
|
detail::awaitable_result_t<A0>,
|
| 604 |
|
detail::awaitable_result_t<As>...>>
|
604 |
|
detail::awaitable_result_t<As>...>>
|
| 605 |
|
|
605 |
|
|
| 606 |
|
using result_type = detail::when_any_result_t<
|
606 |
|
using result_type = detail::when_any_result_t<
|
| 607 |
|
detail::awaitable_result_t<A0>,
|
607 |
|
detail::awaitable_result_t<A0>,
|
| 608 |
|
detail::awaitable_result_t<As>...>;
|
608 |
|
detail::awaitable_result_t<As>...>;
|
| 609 |
|
|
609 |
|
|
| 610 |
|
|
610 |
|
|
| 611 |
|
detail::awaitable_result_t<A0>,
|
611 |
|
detail::awaitable_result_t<A0>,
|
| 612 |
|
detail::awaitable_result_t<As>...> state;
|
612 |
|
detail::awaitable_result_t<As>...> state;
|
| 613 |
|
std::tuple<A0, As...> awaitable_tuple(std::move(a0), std::move(as)...);
|
613 |
|
std::tuple<A0, As...> awaitable_tuple(std::move(a0), std::move(as)...);
|
| 614 |
|
|
614 |
|
|
| 615 |
|
co_await detail::when_any_launcher<A0, As...>(&awaitable_tuple, &state);
|
615 |
|
co_await detail::when_any_launcher<A0, As...>(&awaitable_tuple, &state);
|
| 616 |
|
|
616 |
|
|
| 617 |
|
if(state.core_.winner_exception_)
|
617 |
|
if(state.core_.winner_exception_)
|
| 618 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
618 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
| 619 |
|
|
619 |
|
|
| 620 |
|
co_return result_type{state.core_.winner_index_, std::move(*state.result_)};
|
620 |
|
co_return result_type{state.core_.winner_index_, std::move(*state.result_)};
|
| 621 |
|
|
621 |
|
|
| 622 |
|
|
622 |
|
|
| 623 |
|
/** Concept for ranges of full I/O awaitables.
|
623 |
|
/** Concept for ranges of full I/O awaitables.
|
| 624 |
|
|
624 |
|
|
| 625 |
|
A range satisfies `IoAwaitableRange` if it is a sized input range
|
625 |
|
A range satisfies `IoAwaitableRange` if it is a sized input range
|
| 626 |
|
whose value type satisfies @ref IoAwaitable. This enables when_any
|
626 |
|
whose value type satisfies @ref IoAwaitable. This enables when_any
|
| 627 |
|
to accept any container or view of awaitables, not just std::vector.
|
627 |
|
to accept any container or view of awaitables, not just std::vector.
|
| 628 |
|
|
628 |
|
|
| 629 |
|
@tparam R The range type.
|
629 |
|
@tparam R The range type.
|
| 630 |
|
|
630 |
|
|
| 631 |
|
|
631 |
|
|
| 632 |
|
@li `R` must satisfy `std::ranges::input_range`
|
632 |
|
@li `R` must satisfy `std::ranges::input_range`
|
| 633 |
|
@li `R` must satisfy `std::ranges::sized_range`
|
633 |
|
@li `R` must satisfy `std::ranges::sized_range`
|
| 634 |
|
@li `std::ranges::range_value_t<R>` must satisfy @ref IoAwaitable
|
634 |
|
@li `std::ranges::range_value_t<R>` must satisfy @ref IoAwaitable
|
| 635 |
|
|
635 |
|
|
| 636 |
|
@par Syntactic Requirements
|
636 |
|
@par Syntactic Requirements
|
| 637 |
|
|
637 |
|
|
| 638 |
|
@li `std::ranges::begin(r)` is valid
|
638 |
|
@li `std::ranges::begin(r)` is valid
|
| 639 |
|
@li `std::ranges::end(r)` is valid
|
639 |
|
@li `std::ranges::end(r)` is valid
|
| 640 |
|
@li `std::ranges::size(r)` returns `std::ranges::range_size_t<R>`
|
640 |
|
@li `std::ranges::size(r)` returns `std::ranges::range_size_t<R>`
|
| 641 |
|
@li `*std::ranges::begin(r)` satisfies @ref IoAwaitable
|
641 |
|
@li `*std::ranges::begin(r)` satisfies @ref IoAwaitable
|
| 642 |
|
|
642 |
|
|
| 643 |
|
|
643 |
|
|
| 644 |
|
|
644 |
|
|
| 645 |
|
template<IoAwaitableRange R>
|
645 |
|
template<IoAwaitableRange R>
|
| 646 |
|
task<void> race_all(R&& awaitables) {
|
646 |
|
task<void> race_all(R&& awaitables) {
|
| 647 |
|
auto winner = co_await when_any(std::forward<R>(awaitables));
|
647 |
|
auto winner = co_await when_any(std::forward<R>(awaitables));
|
| 648 |
|
|
648 |
|
|
| 649 |
|
|
649 |
|
|
| 650 |
|
|
650 |
|
|
| 651 |
|
|
651 |
|
|
| 652 |
|
@see when_any, IoAwaitable
|
652 |
|
@see when_any, IoAwaitable
|
| 653 |
|
|
653 |
|
|
| 654 |
|
|
654 |
|
|
| 655 |
|
concept IoAwaitableRange =
|
655 |
|
concept IoAwaitableRange =
|
| 656 |
|
std::ranges::input_range<R> &&
|
656 |
|
std::ranges::input_range<R> &&
|
| 657 |
|
std::ranges::sized_range<R> &&
|
657 |
|
std::ranges::sized_range<R> &&
|
| 658 |
|
IoAwaitable<std::ranges::range_value_t<R>>;
|
658 |
|
IoAwaitable<std::ranges::range_value_t<R>>;
|
| 659 |
|
|
659 |
|
|
| 660 |
|
|
660 |
|
|
| 661 |
|
|
661 |
|
|
| 662 |
|
/** Shared state for homogeneous when_any (range overload).
|
662 |
|
/** Shared state for homogeneous when_any (range overload).
|
| 663 |
|
|
663 |
|
|
| 664 |
|
Uses composition with when_any_core for shared functionality.
|
664 |
|
Uses composition with when_any_core for shared functionality.
|
| 665 |
|
Simpler than heterogeneous: optional<T> instead of variant, vector
|
665 |
|
Simpler than heterogeneous: optional<T> instead of variant, vector
|
| 666 |
|
instead of array for runner handles.
|
666 |
|
instead of array for runner handles.
|
| 667 |
|
|
667 |
|
|
| 668 |
|
|
668 |
|
|
| 669 |
|
struct when_any_homogeneous_state
|
669 |
|
struct when_any_homogeneous_state
|
| 670 |
|
|
670 |
|
|
| 671 |
|
|
671 |
|
|
| 672 |
|
std::optional<T> result_;
|
672 |
|
std::optional<T> result_;
|
| 673 |
|
std::vector<coro> runner_handles_;
|
673 |
|
std::vector<coro> runner_handles_;
|
| 674 |
|
|
674 |
|
|
| 675 |
|
explicit when_any_homogeneous_state(std::size_t count)
|
675 |
|
explicit when_any_homogeneous_state(std::size_t count)
|
| 676 |
|
|
676 |
|
|
| 677 |
|
|
677 |
|
|
| 678 |
|
|
678 |
|
|
| 679 |
|
|
679 |
|
|
| 680 |
|
|
680 |
|
|
| 681 |
|
~when_any_homogeneous_state()
|
681 |
|
~when_any_homogeneous_state()
|
| 682 |
|
|
682 |
|
|
| 683 |
|
for(auto h : runner_handles_)
|
683 |
|
for(auto h : runner_handles_)
|
| 684 |
|
|
684 |
|
|
| 685 |
|
|
685 |
|
|
| 686 |
|
|
686 |
|
|
| 687 |
|
|
687 |
|
|
| 688 |
|
/** @pre core_.try_win() returned true. */
|
688 |
|
/** @pre core_.try_win() returned true. */
|
| 689 |
|
void set_winner_result(T value)
|
689 |
|
void set_winner_result(T value)
|
| 690 |
|
noexcept(std::is_nothrow_move_constructible_v<T>)
|
690 |
|
noexcept(std::is_nothrow_move_constructible_v<T>)
|
| 691 |
|
|
691 |
|
|
| 692 |
|
result_.emplace(std::move(value));
|
692 |
|
result_.emplace(std::move(value));
|
| 693 |
|
|
693 |
|
|
| 694 |
|
|
694 |
|
|
| 695 |
|
|
695 |
|
|
| 696 |
|
/** Specialization for void tasks (no result storage needed). */
|
696 |
|
/** Specialization for void tasks (no result storage needed). */
|
| 697 |
|
|
697 |
|
|
| 698 |
|
struct when_any_homogeneous_state<void>
|
698 |
|
struct when_any_homogeneous_state<void>
|
| 699 |
|
|
699 |
|
|
| 700 |
|
|
700 |
|
|
| 701 |
|
std::vector<coro> runner_handles_;
|
701 |
|
std::vector<coro> runner_handles_;
|
| 702 |
|
|
702 |
|
|
| 703 |
|
explicit when_any_homogeneous_state(std::size_t count)
|
703 |
|
explicit when_any_homogeneous_state(std::size_t count)
|
| 704 |
|
|
704 |
|
|
| 705 |
|
|
705 |
|
|
| 706 |
|
|
706 |
|
|
| 707 |
|
|
707 |
|
|
| 708 |
|
|
708 |
|
|
| 709 |
|
~when_any_homogeneous_state()
|
709 |
|
~when_any_homogeneous_state()
|
| 710 |
|
|
710 |
|
|
| 711 |
|
for(auto h : runner_handles_)
|
711 |
|
for(auto h : runner_handles_)
|
| 712 |
|
|
712 |
|
|
| 713 |
|
|
713 |
|
|
| 714 |
|
|
714 |
|
|
| 715 |
|
|
715 |
|
|
| 716 |
|
// No set_winner_result - void tasks have no result to store
|
716 |
|
// No set_winner_result - void tasks have no result to store
|
| 717 |
|
|
717 |
|
|
| 718 |
|
|
718 |
|
|
| 719 |
|
/** Launches all runners concurrently; see await_suspend for lifetime concerns. */
|
719 |
|
/** Launches all runners concurrently; see await_suspend for lifetime concerns. */
|
| 720 |
|
template<IoAwaitableRange Range>
|
720 |
|
template<IoAwaitableRange Range>
|
| 721 |
|
class when_any_homogeneous_launcher
|
721 |
|
class when_any_homogeneous_launcher
|
| 722 |
|
|
722 |
|
|
| 723 |
|
using Awaitable = std::ranges::range_value_t<Range>;
|
723 |
|
using Awaitable = std::ranges::range_value_t<Range>;
|
| 724 |
|
using T = awaitable_result_t<Awaitable>;
|
724 |
|
using T = awaitable_result_t<Awaitable>;
|
| 725 |
|
|
725 |
|
|
| 726 |
|
|
726 |
|
|
| 727 |
|
when_any_homogeneous_state<T>* state_;
|
727 |
|
when_any_homogeneous_state<T>* state_;
|
| 728 |
|
|
728 |
|
|
| 729 |
|
|
729 |
|
|
| 730 |
|
when_any_homogeneous_launcher(
|
730 |
|
when_any_homogeneous_launcher(
|
| 731 |
|
|
731 |
|
|
| 732 |
|
when_any_homogeneous_state<T>* state)
|
732 |
|
when_any_homogeneous_state<T>* state)
|
| 733 |
|
|
733 |
|
|
| 734 |
|
|
734 |
|
|
| 735 |
|
|
735 |
|
|
| 736 |
|
|
736 |
|
|
| 737 |
|
|
737 |
|
|
| 738 |
|
bool await_ready() const noexcept
|
738 |
|
bool await_ready() const noexcept
|
| 739 |
|
|
739 |
|
|
| 740 |
|
return std::ranges::empty(*range_);
|
740 |
|
return std::ranges::empty(*range_);
|
| 741 |
|
|
741 |
|
|
| 742 |
|
|
742 |
|
|
| 743 |
|
/** CRITICAL: If the last task finishes synchronously, parent resumes and
|
743 |
|
/** CRITICAL: If the last task finishes synchronously, parent resumes and
|
| 744 |
|
destroys this object before await_suspend returns. Must not reference
|
744 |
|
destroys this object before await_suspend returns. Must not reference
|
| 745 |
|
`this` after the final launch_one call.
|
745 |
|
`this` after the final launch_one call.
|
| 746 |
|
|
746 |
|
|
| 747 |
|
|
747 |
|
|
| 748 |
|
coro await_suspend(coro continuation, Ex const& caller_ex, std::stop_token parent_token = {})
|
748 |
|
coro await_suspend(coro continuation, Ex const& caller_ex, std::stop_token parent_token = {})
|
| 749 |
|
|
749 |
|
|
| 750 |
|
state_->core_.continuation_ = continuation;
|
750 |
|
state_->core_.continuation_ = continuation;
|
| 751 |
|
state_->core_.caller_ex_ = caller_ex;
|
751 |
|
state_->core_.caller_ex_ = caller_ex;
|
| 752 |
|
|
752 |
|
|
| 753 |
|
if(parent_token.stop_possible())
|
753 |
|
if(parent_token.stop_possible())
|
| 754 |
|
|
754 |
|
|
| 755 |
|
state_->core_.parent_stop_callback_.emplace(
|
755 |
|
state_->core_.parent_stop_callback_.emplace(
|
| 756 |
|
|
756 |
|
|
| 757 |
|
when_any_core::stop_callback_fn{&state_->core_.stop_source_});
|
757 |
|
when_any_core::stop_callback_fn{&state_->core_.stop_source_});
|
| 758 |
|
|
758 |
|
|
| 759 |
|
if(parent_token.stop_requested())
|
759 |
|
if(parent_token.stop_requested())
|
| 760 |
|
state_->core_.stop_source_.request_stop();
|
760 |
|
state_->core_.stop_source_.request_stop();
|
| 761 |
|
|
761 |
|
|
| 762 |
|
|
762 |
|
|
| 763 |
|
auto token = state_->core_.stop_source_.get_token();
|
763 |
|
auto token = state_->core_.stop_source_.get_token();
|
| 764 |
|
|
764 |
|
|
| 765 |
|
|
765 |
|
|
| 766 |
|
|
766 |
|
|
| 767 |
|
launch_one(index, std::move(a), caller_ex, token);
|
767 |
|
launch_one(index, std::move(a), caller_ex, token);
|
| 768 |
|
|
768 |
|
|
| 769 |
|
|
769 |
|
|
| 770 |
|
|
770 |
|
|
| 771 |
|
return std::noop_coroutine();
|
771 |
|
return std::noop_coroutine();
|
| 772 |
|
|
772 |
|
|
| 773 |
|
|
773 |
|
|
| 774 |
|
void await_resume() const noexcept
|
774 |
|
void await_resume() const noexcept
|
| 775 |
|
|
775 |
|
|
| 776 |
|
|
776 |
|
|
| 777 |
|
|
777 |
|
|
| 778 |
|
|
778 |
|
|
| 779 |
|
/** @pre Ex::dispatch() and coro::resume() must not throw (handle may leak). */
|
779 |
|
/** @pre Ex::dispatch() and coro::resume() must not throw (handle may leak). */
|
| 780 |
|
|
780 |
|
|
| 781 |
|
void launch_one(std::size_t index, Awaitable&& awaitable, Ex const& caller_ex, std::stop_token token)
|
781 |
|
void launch_one(std::size_t index, Awaitable&& awaitable, Ex const& caller_ex, std::stop_token token)
|
| 782 |
|
|
782 |
|
|
| 783 |
|
auto runner = make_when_any_runner(
|
783 |
|
auto runner = make_when_any_runner(
|
| 784 |
|
std::move(awaitable), state_, index);
|
784 |
|
std::move(awaitable), state_, index);
|
| 785 |
|
|
785 |
|
|
| 786 |
|
auto h = runner.release();
|
786 |
|
auto h = runner.release();
|
| 787 |
|
h.promise().state_ = state_;
|
787 |
|
h.promise().state_ = state_;
|
| 788 |
|
h.promise().index_ = index;
|
788 |
|
h.promise().index_ = index;
|
| 789 |
|
h.promise().ex_ = caller_ex;
|
789 |
|
h.promise().ex_ = caller_ex;
|
| 790 |
|
h.promise().stop_token_ = token;
|
790 |
|
h.promise().stop_token_ = token;
|
| 791 |
|
|
791 |
|
|
| 792 |
|
|
792 |
|
|
| 793 |
|
state_->runner_handles_[index] = ch;
|
793 |
|
state_->runner_handles_[index] = ch;
|
| 794 |
|
|
794 |
|
|
| 795 |
|
|
795 |
|
|
| 796 |
|
|
796 |
|
|
| 797 |
|
|
797 |
|
|
| 798 |
|
|
798 |
|
|
| 799 |
|
|
799 |
|
|
| 800 |
|
/** Wait for the first awaitable to complete (range overload).
|
800 |
|
/** Wait for the first awaitable to complete (range overload).
|
| 801 |
|
|
801 |
|
|
| 802 |
|
Races a range of awaitables with the same result type. Accepts any
|
802 |
|
Races a range of awaitables with the same result type. Accepts any
|
| 803 |
|
sized input range of IoAwaitable types, enabling use with arrays,
|
803 |
|
sized input range of IoAwaitable types, enabling use with arrays,
|
| 804 |
|
spans, or custom containers.
|
804 |
|
spans, or custom containers.
|
| 805 |
|
|
805 |
|
|
| 806 |
|
|
806 |
|
|
| 807 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
807 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
| 808 |
|
in the range are launched concurrently and execute in parallel. The
|
808 |
|
in the range are launched concurrently and execute in parallel. The
|
| 809 |
|
coroutine resumes only after all awaitables have completed, even though
|
809 |
|
coroutine resumes only after all awaitables have completed, even though
|
| 810 |
|
the winner is determined by the first to finish.
|
810 |
|
the winner is determined by the first to finish.
|
| 811 |
|
|
811 |
|
|
| 812 |
|
@par Completion Conditions
|
812 |
|
@par Completion Conditions
|
| 813 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
813 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
| 814 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
814 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
| 815 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
815 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
| 816 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
816 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
| 817 |
|
@li The winner's index and result are returned; if the winner threw, the exception is rethrown
|
817 |
|
@li The winner's index and result are returned; if the winner threw, the exception is rethrown
|
| 818 |
|
|
818 |
|
|
| 819 |
|
@par Cancellation Semantics
|
819 |
|
@par Cancellation Semantics
|
| 820 |
|
Cancellation is supported via stop_token propagated through the
|
820 |
|
Cancellation is supported via stop_token propagated through the
|
| 821 |
|
|
821 |
|
|
| 822 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
822 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
| 823 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
823 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
| 824 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
824 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
| 825 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
825 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
| 826 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
826 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
| 827 |
|
|
827 |
|
|
| 828 |
|
|
828 |
|
|
| 829 |
|
All awaitables are launched concurrently before any can complete.
|
829 |
|
All awaitables are launched concurrently before any can complete.
|
| 830 |
|
The launcher iterates through the range, starting each task on the
|
830 |
|
The launcher iterates through the range, starting each task on the
|
| 831 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
831 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
| 832 |
|
executors or interleave on single-threaded executors. There is no
|
832 |
|
executors or interleave on single-threaded executors. There is no
|
| 833 |
|
guaranteed ordering of task completion.
|
833 |
|
guaranteed ordering of task completion.
|
| 834 |
|
|
834 |
|
|
| 835 |
|
@par Notable Error Conditions
|
835 |
|
@par Notable Error Conditions
|
| 836 |
|
@li Empty range: throws std::invalid_argument immediately (not via co_return)
|
836 |
|
@li Empty range: throws std::invalid_argument immediately (not via co_return)
|
| 837 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
837 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
| 838 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
838 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
| 839 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
839 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
| 840 |
|
|
840 |
|
|
| 841 |
|
|
841 |
|
|
| 842 |
|
|
842 |
|
|
| 843 |
|
|
843 |
|
|
| 844 |
|
std::array<task<Response>, 3> requests = {
|
844 |
|
std::array<task<Response>, 3> requests = {
|
| 845 |
|
|
845 |
|
|
| 846 |
|
|
846 |
|
|
| 847 |
|
|
847 |
|
|
| 848 |
|
|
848 |
|
|
| 849 |
|
|
849 |
|
|
| 850 |
|
auto [index, response] = co_await when_any(std::move(requests));
|
850 |
|
auto [index, response] = co_await when_any(std::move(requests));
|
| 851 |
|
|
851 |
|
|
| 852 |
|
|
852 |
|
|
| 853 |
|
|
853 |
|
|
| 854 |
|
|
854 |
|
|
| 855 |
|
|
855 |
|
|
| 856 |
|
task<Response> fetch_fastest(std::vector<Server> const& servers) {
|
856 |
|
task<Response> fetch_fastest(std::vector<Server> const& servers) {
|
| 857 |
|
std::vector<task<Response>> requests;
|
857 |
|
std::vector<task<Response>> requests;
|
| 858 |
|
for (auto const& server : servers)
|
858 |
|
for (auto const& server : servers)
|
| 859 |
|
requests.push_back(fetch_from(server));
|
859 |
|
requests.push_back(fetch_from(server));
|
| 860 |
|
|
860 |
|
|
| 861 |
|
auto [index, response] = co_await when_any(std::move(requests));
|
861 |
|
auto [index, response] = co_await when_any(std::move(requests));
|
| 862 |
|
|
862 |
|
|
| 863 |
|
|
863 |
|
|
| 864 |
|
|
864 |
|
|
| 865 |
|
|
865 |
|
|
| 866 |
|
@tparam R Range type satisfying IoAwaitableRange.
|
866 |
|
@tparam R Range type satisfying IoAwaitableRange.
|
| 867 |
|
@param awaitables Range of awaitables to race concurrently (must not be empty).
|
867 |
|
@param awaitables Range of awaitables to race concurrently (must not be empty).
|
| 868 |
|
@return A task yielding a pair of (winner_index, result).
|
868 |
|
@return A task yielding a pair of (winner_index, result).
|
| 869 |
|
|
869 |
|
|
| 870 |
|
@throws std::invalid_argument if range is empty (thrown before coroutine suspends).
|
870 |
|
@throws std::invalid_argument if range is empty (thrown before coroutine suspends).
|
| 871 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
871 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
| 872 |
|
|
872 |
|
|
| 873 |
|
|
873 |
|
|
| 874 |
|
Elements are moved from the range; for lvalue ranges, the original
|
874 |
|
Elements are moved from the range; for lvalue ranges, the original
|
| 875 |
|
container will have moved-from elements after this call. The range
|
875 |
|
container will have moved-from elements after this call. The range
|
| 876 |
|
is moved onto the coroutine frame to ensure lifetime safety. Unlike
|
876 |
|
is moved onto the coroutine frame to ensure lifetime safety. Unlike
|
| 877 |
|
the variadic overload, no variant wrapper is needed since all tasks
|
877 |
|
the variadic overload, no variant wrapper is needed since all tasks
|
| 878 |
|
share the same return type.
|
878 |
|
share the same return type.
|
| 879 |
|
|
879 |
|
|
| 880 |
|
@see when_any, IoAwaitableRange
|
880 |
|
@see when_any, IoAwaitableRange
|
| 881 |
|
|
881 |
|
|
| 882 |
|
template<IoAwaitableRange R>
|
882 |
|
template<IoAwaitableRange R>
|
| 883 |
|
requires (!std::is_void_v<detail::awaitable_result_t<std::ranges::range_value_t<R>>>)
|
883 |
|
requires (!std::is_void_v<detail::awaitable_result_t<std::ranges::range_value_t<R>>>)
|
| 884 |
|
[[nodiscard]] auto when_any(R&& awaitables)
|
884 |
|
[[nodiscard]] auto when_any(R&& awaitables)
|
| 885 |
|
-> task<std::pair<std::size_t, detail::awaitable_result_t<std::ranges::range_value_t<R>>>>
|
885 |
|
-> task<std::pair<std::size_t, detail::awaitable_result_t<std::ranges::range_value_t<R>>>>
|
| 886 |
|
|
886 |
|
|
| 887 |
|
using Awaitable = std::ranges::range_value_t<R>;
|
887 |
|
using Awaitable = std::ranges::range_value_t<R>;
|
| 888 |
|
using T = detail::awaitable_result_t<Awaitable>;
|
888 |
|
using T = detail::awaitable_result_t<Awaitable>;
|
| 889 |
|
using result_type = std::pair<std::size_t, T>;
|
889 |
|
using result_type = std::pair<std::size_t, T>;
|
| 890 |
|
using OwnedRange = std::remove_cvref_t<R>;
|
890 |
|
using OwnedRange = std::remove_cvref_t<R>;
|
| 891 |
|
|
891 |
|
|
| 892 |
|
auto count = std::ranges::size(awaitables);
|
892 |
|
auto count = std::ranges::size(awaitables);
|
| 893 |
|
|
893 |
|
|
| 894 |
|
throw std::invalid_argument("when_any requires at least one awaitable");
|
894 |
|
throw std::invalid_argument("when_any requires at least one awaitable");
|
| 895 |
|
|
895 |
|
|
| 896 |
|
// Move/copy range onto coroutine frame to ensure lifetime
|
896 |
|
// Move/copy range onto coroutine frame to ensure lifetime
|
| 897 |
|
OwnedRange owned_awaitables = std::forward<R>(awaitables);
|
897 |
|
OwnedRange owned_awaitables = std::forward<R>(awaitables);
|
| 898 |
|
|
898 |
|
|
| 899 |
|
detail::when_any_homogeneous_state<T> state(count);
|
899 |
|
detail::when_any_homogeneous_state<T> state(count);
|
| 900 |
|
|
900 |
|
|
| 901 |
|
co_await detail::when_any_homogeneous_launcher<OwnedRange>(&owned_awaitables, &state);
|
901 |
|
co_await detail::when_any_homogeneous_launcher<OwnedRange>(&owned_awaitables, &state);
|
| 902 |
|
|
902 |
|
|
| 903 |
|
if(state.core_.winner_exception_)
|
903 |
|
if(state.core_.winner_exception_)
|
| 904 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
904 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
| 905 |
|
|
905 |
|
|
| 906 |
|
co_return result_type{state.core_.winner_index_, std::move(*state.result_)};
|
906 |
|
co_return result_type{state.core_.winner_index_, std::move(*state.result_)};
|
| 907 |
|
|
907 |
|
|
| 908 |
|
|
908 |
|
|
| 909 |
|
/** Wait for the first awaitable to complete (void range overload).
|
909 |
|
/** Wait for the first awaitable to complete (void range overload).
|
| 910 |
|
|
910 |
|
|
| 911 |
|
Races a range of void-returning awaitables. Since void awaitables have
|
911 |
|
Races a range of void-returning awaitables. Since void awaitables have
|
| 912 |
|
no result value, only the winner's index is returned.
|
912 |
|
no result value, only the winner's index is returned.
|
| 913 |
|
|
913 |
|
|
| 914 |
|
|
914 |
|
|
| 915 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
915 |
|
The calling coroutine suspends when co_await is invoked. All awaitables
|
| 916 |
|
in the range are launched concurrently and execute in parallel. The
|
916 |
|
in the range are launched concurrently and execute in parallel. The
|
| 917 |
|
coroutine resumes only after all awaitables have completed, even though
|
917 |
|
coroutine resumes only after all awaitables have completed, even though
|
| 918 |
|
the winner is determined by the first to finish.
|
918 |
|
the winner is determined by the first to finish.
|
| 919 |
|
|
919 |
|
|
| 920 |
|
@par Completion Conditions
|
920 |
|
@par Completion Conditions
|
| 921 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
921 |
|
@li Winner is determined when the first awaitable completes (success or exception)
|
| 922 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
922 |
|
@li Only one task can claim winner status via atomic compare-exchange
|
| 923 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
923 |
|
@li Once a winner exists, stop is requested for all remaining siblings
|
| 924 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
924 |
|
@li Parent coroutine resumes only after all siblings acknowledge completion
|
| 925 |
|
@li The winner's index is returned; if the winner threw, the exception is rethrown
|
925 |
|
@li The winner's index is returned; if the winner threw, the exception is rethrown
|
| 926 |
|
|
926 |
|
|
| 927 |
|
@par Cancellation Semantics
|
927 |
|
@par Cancellation Semantics
|
| 928 |
|
Cancellation is supported via stop_token propagated through the
|
928 |
|
Cancellation is supported via stop_token propagated through the
|
| 929 |
|
|
929 |
|
|
| 930 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
930 |
|
@li Each child awaitable receives a stop_token derived from a shared stop_source
|
| 931 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
931 |
|
@li When the parent's stop token is activated, the stop is forwarded to all children
|
| 932 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
932 |
|
@li When a winner is determined, stop_source_.request_stop() is called immediately
|
| 933 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
933 |
|
@li Siblings must handle cancellation gracefully and complete before parent resumes
|
| 934 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
934 |
|
@li Stop requests are cooperative; tasks must check and respond to them
|
| 935 |
|
|
935 |
|
|
| 936 |
|
|
936 |
|
|
| 937 |
|
All awaitables are launched concurrently before any can complete.
|
937 |
|
All awaitables are launched concurrently before any can complete.
|
| 938 |
|
The launcher iterates through the range, starting each task on the
|
938 |
|
The launcher iterates through the range, starting each task on the
|
| 939 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
939 |
|
caller's executor. Tasks may execute in parallel on multi-threaded
|
| 940 |
|
executors or interleave on single-threaded executors. There is no
|
940 |
|
executors or interleave on single-threaded executors. There is no
|
| 941 |
|
guaranteed ordering of task completion.
|
941 |
|
guaranteed ordering of task completion.
|
| 942 |
|
|
942 |
|
|
| 943 |
|
@par Notable Error Conditions
|
943 |
|
@par Notable Error Conditions
|
| 944 |
|
@li Empty range: throws std::invalid_argument immediately (not via co_return)
|
944 |
|
@li Empty range: throws std::invalid_argument immediately (not via co_return)
|
| 945 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
945 |
|
@li Winner exception: if the winning task threw, that exception is rethrown
|
| 946 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
946 |
|
@li Non-winner exceptions: silently discarded (only winner's result matters)
|
| 947 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
947 |
|
@li Cancellation: tasks may complete via cancellation without throwing
|
| 948 |
|
|
948 |
|
|
| 949 |
|
|
949 |
|
|
| 950 |
|
|
950 |
|
|
| 951 |
|
|
951 |
|
|
| 952 |
|
std::vector<task<void>> tasks;
|
952 |
|
std::vector<task<void>> tasks;
|
| 953 |
|
for (int i = 0; i < 5; ++i)
|
953 |
|
for (int i = 0; i < 5; ++i)
|
| 954 |
|
tasks.push_back(background_work(i));
|
954 |
|
tasks.push_back(background_work(i));
|
| 955 |
|
|
955 |
|
|
| 956 |
|
std::size_t winner = co_await when_any(std::move(tasks));
|
956 |
|
std::size_t winner = co_await when_any(std::move(tasks));
|
| 957 |
|
// winner is the index of the first task to complete
|
957 |
|
// winner is the index of the first task to complete
|
| 958 |
|
|
958 |
|
|
| 959 |
|
|
959 |
|
|
| 960 |
|
|
960 |
|
|
| 961 |
|
@par Example with Timeout
|
961 |
|
@par Example with Timeout
|
| 962 |
|
|
962 |
|
|
| 963 |
|
task<void> with_timeout() {
|
963 |
|
task<void> with_timeout() {
|
| 964 |
|
std::vector<task<void>> tasks;
|
964 |
|
std::vector<task<void>> tasks;
|
| 965 |
|
tasks.push_back(long_running_operation());
|
965 |
|
tasks.push_back(long_running_operation());
|
| 966 |
|
tasks.push_back(delay(std::chrono::seconds(5)));
|
966 |
|
tasks.push_back(delay(std::chrono::seconds(5)));
|
| 967 |
|
|
967 |
|
|
| 968 |
|
std::size_t winner = co_await when_any(std::move(tasks));
|
968 |
|
std::size_t winner = co_await when_any(std::move(tasks));
|
| 969 |
|
|
969 |
|
|
| 970 |
|
|
970 |
|
|
| 971 |
|
|
971 |
|
|
| 972 |
|
|
972 |
|
|
| 973 |
|
|
973 |
|
|
| 974 |
|
|
974 |
|
|
| 975 |
|
@tparam R Range type satisfying IoAwaitableRange with void result.
|
975 |
|
@tparam R Range type satisfying IoAwaitableRange with void result.
|
| 976 |
|
@param awaitables Range of void awaitables to race concurrently (must not be empty).
|
976 |
|
@param awaitables Range of void awaitables to race concurrently (must not be empty).
|
| 977 |
|
@return A task yielding the winner's index (zero-based).
|
977 |
|
@return A task yielding the winner's index (zero-based).
|
| 978 |
|
|
978 |
|
|
| 979 |
|
@throws std::invalid_argument if range is empty (thrown before coroutine suspends).
|
979 |
|
@throws std::invalid_argument if range is empty (thrown before coroutine suspends).
|
| 980 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
980 |
|
@throws Rethrows the winner's exception if the winning task threw an exception.
|
| 981 |
|
|
981 |
|
|
| 982 |
|
|
982 |
|
|
| 983 |
|
Elements are moved from the range; for lvalue ranges, the original
|
983 |
|
Elements are moved from the range; for lvalue ranges, the original
|
| 984 |
|
container will have moved-from elements after this call. The range
|
984 |
|
container will have moved-from elements after this call. The range
|
| 985 |
|
is moved onto the coroutine frame to ensure lifetime safety. Unlike
|
985 |
|
is moved onto the coroutine frame to ensure lifetime safety. Unlike
|
| 986 |
|
the non-void overload, no result storage is needed since void tasks
|
986 |
|
the non-void overload, no result storage is needed since void tasks
|
| 987 |
|
|
987 |
|
|
| 988 |
|
|
988 |
|
|
| 989 |
|
@see when_any, IoAwaitableRange
|
989 |
|
@see when_any, IoAwaitableRange
|
| 990 |
|
|
990 |
|
|
| 991 |
|
template<IoAwaitableRange R>
|
991 |
|
template<IoAwaitableRange R>
|
| 992 |
|
requires std::is_void_v<detail::awaitable_result_t<std::ranges::range_value_t<R>>>
|
992 |
|
requires std::is_void_v<detail::awaitable_result_t<std::ranges::range_value_t<R>>>
|
| 993 |
|
[[nodiscard]] auto when_any(R&& awaitables) -> task<std::size_t>
|
993 |
|
[[nodiscard]] auto when_any(R&& awaitables) -> task<std::size_t>
|
| 994 |
|
|
994 |
|
|
| 995 |
|
using OwnedRange = std::remove_cvref_t<R>;
|
995 |
|
using OwnedRange = std::remove_cvref_t<R>;
|
| 996 |
|
|
996 |
|
|
| 997 |
|
auto count = std::ranges::size(awaitables);
|
997 |
|
auto count = std::ranges::size(awaitables);
|
| 998 |
|
|
998 |
|
|
| 999 |
|
throw std::invalid_argument("when_any requires at least one awaitable");
|
999 |
|
throw std::invalid_argument("when_any requires at least one awaitable");
|
| 1000 |
|
|
1000 |
|
|
| 1001 |
|
// Move/copy range onto coroutine frame to ensure lifetime
|
1001 |
|
// Move/copy range onto coroutine frame to ensure lifetime
|
| 1002 |
|
OwnedRange owned_awaitables = std::forward<R>(awaitables);
|
1002 |
|
OwnedRange owned_awaitables = std::forward<R>(awaitables);
|
| 1003 |
|
|
1003 |
|
|
| 1004 |
|
detail::when_any_homogeneous_state<void> state(count);
|
1004 |
|
detail::when_any_homogeneous_state<void> state(count);
|
| 1005 |
|
|
1005 |
|
|
| 1006 |
|
co_await detail::when_any_homogeneous_launcher<OwnedRange>(&owned_awaitables, &state);
|
1006 |
|
co_await detail::when_any_homogeneous_launcher<OwnedRange>(&owned_awaitables, &state);
|
| 1007 |
|
|
1007 |
|
|
| 1008 |
|
if(state.core_.winner_exception_)
|
1008 |
|
if(state.core_.winner_exception_)
|
| 1009 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
1009 |
|
std::rethrow_exception(state.core_.winner_exception_);
|
| 1010 |
|
|
1010 |
|
|
| 1011 |
|
co_return state.core_.winner_index_;
|
1011 |
|
co_return state.core_.winner_index_;
|
| 1012 |
|
|
1012 |
|
|
| 1013 |
|
|
1013 |
|
|
| 1014 |
|
|
1014 |
|
|
| 1015 |
|
|
1015 |
|
|
| 1016 |
|
|
1016 |
|
|
| 1017 |
|
|
1017 |
|
|