. /include/boost/corosio /detail /timer.hpp
98.36% Lines (60/61) 94.12% Functions (16/17)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2025 Vinnie Falco (vinnie.falco@gmail.com) 2   // Copyright (c) 2025 Vinnie Falco (vinnie.falco@gmail.com)
3   // Copyright (c) 2026 Steve Gerbino 3   // Copyright (c) 2026 Steve Gerbino
4   // 4   //
5   // Distributed under the Boost Software License, Version 1.0. (See accompanying 5   // Distributed under the Boost Software License, Version 1.0. (See accompanying
6   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 6   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
7   // 7   //
8   // Official repository: https://github.com/cppalliance/corosio 8   // Official repository: https://github.com/cppalliance/corosio
9   // 9   //
10   10  
11   #ifndef BOOST_COROSIO_DETAIL_TIMER_HPP 11   #ifndef BOOST_COROSIO_DETAIL_TIMER_HPP
12   #define BOOST_COROSIO_DETAIL_TIMER_HPP 12   #define BOOST_COROSIO_DETAIL_TIMER_HPP
13   13  
14   #include <boost/corosio/detail/config.hpp> 14   #include <boost/corosio/detail/config.hpp>
15   #include <boost/corosio/detail/intrusive.hpp> 15   #include <boost/corosio/detail/intrusive.hpp>
16   #include <boost/corosio/detail/scheduler_op.hpp> 16   #include <boost/corosio/detail/scheduler_op.hpp>
17   #include <boost/corosio/io/io_object.hpp> 17   #include <boost/corosio/io/io_object.hpp>
18   #include <boost/capy/continuation.hpp> 18   #include <boost/capy/continuation.hpp>
19   #include <boost/capy/io_result.hpp> 19   #include <boost/capy/io_result.hpp>
20   #include <boost/capy/error.hpp> 20   #include <boost/capy/error.hpp>
21   #include <boost/capy/ex/executor_ref.hpp> 21   #include <boost/capy/ex/executor_ref.hpp>
22   #include <boost/capy/ex/execution_context.hpp> 22   #include <boost/capy/ex/execution_context.hpp>
23   #include <boost/capy/ex/io_env.hpp> 23   #include <boost/capy/ex/io_env.hpp>
24   24  
25   #include <atomic> 25   #include <atomic>
26   #include <chrono> 26   #include <chrono>
27   #include <coroutine> 27   #include <coroutine>
28   #include <cstddef> 28   #include <cstddef>
29   #include <limits> 29   #include <limits>
30   #include <new> 30   #include <new>
31   #include <stop_token> 31   #include <stop_token>
32   #include <system_error> 32   #include <system_error>
33   33  
34   namespace boost::corosio::detail { 34   namespace boost::corosio::detail {
35   35  
36   // timer_service is defined in timer_service.hpp, which includes this 36   // timer_service is defined in timer_service.hpp, which includes this
37   // header. waiter_node and wait_awaitable are defined below the timer 37   // header. waiter_node and wait_awaitable are defined below the timer
38   // class: waiter_node stores a timer::implementation*, which cannot be 38   // class: waiter_node stores a timer::implementation*, which cannot be
39   // forward-declared as a nested type. implementation stores only a 39   // forward-declared as a nested type. implementation stores only a
40   // waiter_node pointer, so this forward declaration suffices for its 40   // waiter_node pointer, so this forward declaration suffices for its
41   // data layout. 41   // data layout.
42   class timer_service; 42   class timer_service;
43   struct waiter_node; 43   struct waiter_node;
44   struct wait_awaitable; 44   struct wait_awaitable;
45   45  
46   /** An asynchronous timer for coroutine I/O. 46   /** An asynchronous timer for coroutine I/O.
47   47  
48   This class provides asynchronous timer operations that return 48   This class provides asynchronous timer operations that return
49   awaitable types. The timer can be used to schedule operations 49   awaitable types. The timer can be used to schedule operations
50   to occur after a specified duration or at a specific time point. 50   to occur after a specified duration or at a specific time point.
51   51  
52   Each timer carries at most one wait: `delay` and `timeout` own a 52   Each timer carries at most one wait: `delay` and `timeout` own a
53   private timer per `co_await`. When the timer expires the waiter 53   private timer per `co_await`. When the timer expires the waiter
54   completes with success; a cancelled wait completes with an error 54   completes with success; a cancelled wait completes with an error
55   that compares equal to `capy::cond::canceled`. 55   that compares equal to `capy::cond::canceled`.
56   56  
57   Each timer operation participates in the affine awaitable protocol, 57   Each timer operation participates in the affine awaitable protocol,
58   ensuring coroutines resume on the correct executor. 58   ensuring coroutines resume on the correct executor.
59   59  
60   @par Thread Safety 60   @par Thread Safety
61   Distinct objects: Safe.@n 61   Distinct objects: Safe.@n
62   Shared objects: Unsafe. 62   Shared objects: Unsafe.
63   63  
64   @par Semantics 64   @par Semantics
65   Timers are not backed by per-timer kernel objects. The io_context's 65   Timers are not backed by per-timer kernel objects. The io_context's
66   timer service keeps a process-side min-heap of pending expirations; 66   timer service keeps a process-side min-heap of pending expirations;
67   the nearest expiry drives the reactor's poll timeout, and expirations 67   the nearest expiry drives the reactor's poll timeout, and expirations
68   are processed in the run loop. 68   are processed in the run loop.
69   */ 69   */
70   class BOOST_COROSIO_DECL timer : public io_object 70   class BOOST_COROSIO_DECL timer : public io_object
71   { 71   {
72   friend struct wait_awaitable; 72   friend struct wait_awaitable;
73   73  
74   public: 74   public:
75   /** Backend state and wait entry point for a timer. 75   /** Backend state and wait entry point for a timer.
76   76  
77   Holds per-timer state ( expiry, heap position, the single waiter ) and 77   Holds per-timer state ( expiry, heap position, the single waiter ) and
78   the `wait` entry point used by the awaitable returned from 78   the `wait` entry point used by the awaitable returned from
79   @ref timer::wait. There is exactly one concrete timer backend, 79   @ref timer::wait. There is exactly one concrete timer backend,
80   so `wait` is a plain member function rather than a virtual 80   so `wait` is a plain member function rather than a virtual
81   dispatch point. 81   dispatch point.
82   */ 82   */
83   struct implementation : io_object::implementation 83   struct implementation : io_object::implementation
84   { 84   {
85   /// Sentinel value indicating the timer is not in the heap. 85   /// Sentinel value indicating the timer is not in the heap.
86   static constexpr std::size_t npos = 86   static constexpr std::size_t npos =
87   (std::numeric_limits<std::size_t>::max)(); 87   (std::numeric_limits<std::size_t>::max)();
88   88  
89   // Only mutated by the owning thread (expires_at/expires_after) 89   // Only mutated by the owning thread (expires_at/expires_after)
90   // before a wait is published; cross-thread consumers read the 90   // before a wait is published; cross-thread consumers read the
91   // heap entry's copied time_, never this field, so it needs no 91   // heap entry's copied time_, never this field, so it needs no
92   // atomicity. 92   // atomicity.
93   /// The absolute expiry time point. 93   /// The absolute expiry time point.
94   std::chrono::steady_clock::time_point expiry_{}; 94   std::chrono::steady_clock::time_point expiry_{};
95   95  
96   // heap_index_ and might_have_pending_waits_ are cross-thread 96   // heap_index_ and might_have_pending_waits_ are cross-thread
97   // hints, not authoritative state: the real state lives in the 97   // hints, not authoritative state: the real state lives in the
98   // heap and the published waiter under timer_service::mutex_. Every 98   // heap and the published waiter under timer_service::mutex_. Every
99   // unlocked fast-out that reads them is either re-validated under 99   // unlocked fast-out that reads them is either re-validated under
100   // the mutex or safe under a stale value in both directions, and 100   // the mutex or safe under a stale value in both directions, and
101   // any locked writer / locked reader pair is already ordered by 101   // any locked writer / locked reader pair is already ordered by
102   // the mutex. All accesses therefore use memory_order_relaxed, 102   // the mutex. All accesses therefore use memory_order_relaxed,
103   // which keeps the lock-free fast paths fence-free while making 103   // which keeps the lock-free fast paths fence-free while making
104   // the concurrent reads well-defined. 104   // the concurrent reads well-defined.
105   /// Index in the timer service's min-heap, or `npos`. 105   /// Index in the timer service's min-heap, or `npos`.
106   std::atomic<std::size_t> heap_index_{npos}; 106   std::atomic<std::size_t> heap_index_{npos};
107   107  
108   // false implies waiter_ is null: both are cleared together 108   // false implies waiter_ is null: both are cleared together
109   // under the service mutex. 109   // under the service mutex.
110   /// True if `wait()` has been called since last cancel. 110   /// True if `wait()` has been called since last cancel.
111   std::atomic<bool> might_have_pending_waits_{false}; 111   std::atomic<bool> might_have_pending_waits_{false};
112   112  
113   /// The timer service that owns this implementation. 113   /// The timer service that owns this implementation.
114   timer_service* svc_ = nullptr; 114   timer_service* svc_ = nullptr;
115   115  
116   // Exactly one wait may be outstanding: delay and timeout own 116   // Exactly one wait may be outstanding: delay and timeout own
117   // a private timer per co_await, and the service's drains rely 117   // a private timer per co_await, and the service's drains rely
118   // on the one-to-one pairing. 118   // on the one-to-one pairing.
119   /// The waiter published on this timer, or `nullptr`. 119   /// The waiter published on this timer, or `nullptr`.
120   waiter_node* waiter_ = nullptr; 120   waiter_node* waiter_ = nullptr;
121   121  
122   /// Free list linkage, reused when this impl is recycled. 122   /// Free list linkage, reused when this impl is recycled.
123   implementation* next_free_ = nullptr; 123   implementation* next_free_ = nullptr;
124   124  
125   /// Construct bound to the given timer service. 125   /// Construct bound to the given timer service.
HITCBC 126   1214 explicit implementation(timer_service& svc) noexcept : svc_(&svc) {} 126   1384 explicit implementation(timer_service& svc) noexcept : svc_(&svc) {}
127   127  
128   /** Check whether the timer is expired and absent from the heap. 128   /** Check whether the timer is expired and absent from the heap.
129   129  
130   The single definition of the already-expired fast-path 130   The single definition of the already-expired fast-path
131   predicate: `await_suspend` tests it inline and `wait()` 131   predicate: `await_suspend` tests it inline and `wait()`
132   re-tests it because the expiry can elapse between the two 132   re-tests it because the expiry can elapse between the two
133   reads. 133   reads.
134   */ 134   */
HITCBC 135   28651 bool already_expired() const noexcept 135   28313 bool already_expired() const noexcept
136   { 136   {
HITCBC 137   85953 return heap_index_.load(std::memory_order_relaxed) == npos && 137   84939 return heap_index_.load(std::memory_order_relaxed) == npos &&
HITCBC 138 - 56638 (expiry_ == (std::chrono::steady_clock::time_point::min)() || 138 + 28313 (expiry_ ==
HITGNC   139 + 55962 (std::chrono::steady_clock::time_point::min)() ||
HITCBC 139   56638 expiry_ <= std::chrono::steady_clock::now()); 140   55962 expiry_ <= std::chrono::steady_clock::now());
140   } 141   }
141   142  
142   /** Asynchronously wait for the timer to expire. 143   /** Asynchronously wait for the timer to expire.
143   144  
144   Publishes the waiter into the service's heap and the 145   Publishes the waiter into the service's heap and the
145   timer's waiter slot, after which it may complete on any 146   timer's waiter slot, after which it may complete on any
146   thread. If the timer is already expired and not in the 147   thread. If the timer is already expired and not in the
147   heap, completes by posting the continuation without 148   heap, completes by posting the continuation without
148   publishing. 149   publishing.
149   150  
150   @par Preconditions 151   @par Preconditions
151   @p w is fully initialized, and its storage (the awaitable 152   @p w is fully initialized, and its storage (the awaitable
152   on the suspended coroutine's frame) outlives the wait. 153   on the suspended coroutine's frame) outlives the wait.
153   154  
154   @param w The waiter to publish. 155   @param w The waiter to publish.
155   */ 156   */
156   // Exported at member level: dllexport on the enclosing timer 157   // Exported at member level: dllexport on the enclosing timer
157   // class does not extend to nested classes, and header-inline 158   // class does not extend to nested classes, and header-inline
158   // callers (wait_awaitable::await_suspend) reference this 159   // callers (wait_awaitable::await_suspend) reference this
159   // symbol from outside the corosio DLL. 160   // symbol from outside the corosio DLL.
160   BOOST_COROSIO_DECL 161   BOOST_COROSIO_DECL
161   std::coroutine_handle<> wait(waiter_node& w); 162   std::coroutine_handle<> wait(waiter_node& w);
162   163  
163   /** Publish a waiter unconditionally. 164   /** Publish a waiter unconditionally.
164   165  
165   Like `wait`, but never takes the elapsed fast path. The 166   Like `wait`, but never takes the elapsed fast path. The
166   fast path posts the continuation directly, bypassing the 167   fast path posts the continuation directly, bypassing the
167   embedded op; hook-driven waits must observe every 168   embedded op; hook-driven waits must observe every
168   completion through the op, where the re-arm hook runs. 169   completion through the op, where the re-arm hook runs.
169   170  
170   @par Preconditions 171   @par Preconditions
171   Same as `wait`. 172   Same as `wait`.
172   173  
173   @param w The waiter to publish. 174   @param w The waiter to publish.
174   */ 175   */
175   std::coroutine_handle<> publish(waiter_node& w); 176   std::coroutine_handle<> publish(waiter_node& w);
176   }; 177   };
177   178  
178   /// The clock type used for time operations. 179   /// The clock type used for time operations.
179   using clock_type = std::chrono::steady_clock; 180   using clock_type = std::chrono::steady_clock;
180   181  
181   /// The time point type for absolute expiry times. 182   /// The time point type for absolute expiry times.
182   using time_point = clock_type::time_point; 183   using time_point = clock_type::time_point;
183   184  
184   /// The duration type for relative expiry times. 185   /// The duration type for relative expiry times.
185   using duration = clock_type::duration; 186   using duration = clock_type::duration;
186   187  
187   /** Destructor. 188   /** Destructor.
188   189  
189   Cancels any pending operations and releases timer resources. 190   Cancels any pending operations and releases timer resources.
190   */ 191   */
191   ~timer() override; 192   ~timer() override;
192   193  
193   /** Construct a timer from an execution context. 194   /** Construct a timer from an execution context.
194   195  
195   @param ctx The execution context that will own this timer. It 196   @param ctx The execution context that will own this timer. It
196   must be a corosio io_context; otherwise the constructor 197   must be a corosio io_context; otherwise the constructor
197   throws (a timer service is required). 198   throws (a timer service is required).
198   199  
199   @throws std::logic_error if @p ctx is not an io_context. 200   @throws std::logic_error if @p ctx is not an io_context.
200   */ 201   */
201   explicit timer(capy::execution_context& ctx); 202   explicit timer(capy::execution_context& ctx);
202   203  
203   /** Move constructor. 204   /** Move constructor.
204   205  
205   Transfers ownership of the timer resources. Required so a 206   Transfers ownership of the timer resources. Required so a
206   disengaged `std::optional<timer>` is movable; a timer is never 207   disengaged `std::optional<timer>` is movable; a timer is never
207   moved while a wait is published. 208   moved while a wait is published.
208   209  
209   @pre No awaitables returned by @p other's methods exist. 210   @pre No awaitables returned by @p other's methods exist.
210   */ 211   */
MISUBC 211   ✗ timer(timer&&) noexcept = default; 212   ✗ timer(timer&&) noexcept = default;
212   213  
213   /** Move assignment operator. 214   /** Move assignment operator.
214   215  
215   Closes any existing timer and transfers ownership. 216   Closes any existing timer and transfers ownership.
216   217  
217   @pre No awaitables returned by either `*this` or @p other's 218   @pre No awaitables returned by either `*this` or @p other's
218   methods exist. 219   methods exist.
219   */ 220   */
220   timer& operator=(timer&&) noexcept = default; 221   timer& operator=(timer&&) noexcept = default;
221   222  
222   timer(timer const&) = delete; 223   timer(timer const&) = delete;
223   timer& operator=(timer const&) = delete; 224   timer& operator=(timer const&) = delete;
224   225  
225   /** Return the timer's expiry time as an absolute time. 226   /** Return the timer's expiry time as an absolute time.
226   227  
227   @return The expiry time point. If no expiry has been set, 228   @return The expiry time point. If no expiry has been set,
228   returns a default-constructed time_point. 229   returns a default-constructed time_point.
229   */ 230   */
230   time_point expiry() const noexcept 231   time_point expiry() const noexcept
231   { 232   {
232   return get().expiry_; 233   return get().expiry_;
233   } 234   }
234   235  
235   /** Set the timer's expiry time as an absolute time. 236   /** Set the timer's expiry time as an absolute time.
236   237  
237   @par Preconditions 238   @par Preconditions
238   No wait is published on this timer. 239   No wait is published on this timer.
239   240  
240   @param t The expiry time to be used for the timer. 241   @param t The expiry time to be used for the timer.
241   */ 242   */
HITCBC 242   16 void expires_at(time_point t) 243   16 void expires_at(time_point t)
243   { 244   {
HITCBC 244   16 auto& impl = get(); 245   16 auto& impl = get();
HITCBC 245   32 BOOST_COROSIO_ASSERT( 246   32 BOOST_COROSIO_ASSERT(
246   impl.heap_index_.load(std::memory_order_relaxed) == 247   impl.heap_index_.load(std::memory_order_relaxed) ==
247   implementation::npos); 248   implementation::npos);
HITCBC 248   16 impl.expiry_ = t; 249   16 impl.expiry_ = t;
HITCBC 249   16 } 250   16 }
250   251  
251   /** Set the timer's expiry time relative to now. 252   /** Set the timer's expiry time relative to now.
252   253  
253   @par Preconditions 254   @par Preconditions
254   No wait is published on this timer. 255   No wait is published on this timer.
255   256  
256   @param d The expiry time relative to now. 257   @param d The expiry time relative to now.
257   */ 258   */
HITCBC 258   19076 void expires_after(duration d) 259   18873 void expires_after(duration d)
259   { 260   {
HITCBC 260   19076 auto& impl = get(); 261   18873 auto& impl = get();
HITCBC 261   38152 BOOST_COROSIO_ASSERT( 262   37746 BOOST_COROSIO_ASSERT(
262   impl.heap_index_.load(std::memory_order_relaxed) == 263   impl.heap_index_.load(std::memory_order_relaxed) ==
263   implementation::npos); 264   implementation::npos);
HITCBC 264   19076 if (d <= duration::zero()) 265   18873 if (d <= duration::zero())
HITCBC 265   680 impl.expiry_ = (time_point::min)(); 266   680 impl.expiry_ = (time_point::min)();
266   else 267   else
267   { 268   {
268   // Saturate rather than overflow: a clamped near-max duration 269   // Saturate rather than overflow: a clamped near-max duration
269   // (e.g. delay(hours::max())) would wrap now() + d past the 270   // (e.g. delay(hours::max())) would wrap now() + d past the
270   // clock's range and appear already elapsed. 271   // clock's range and appear already elapsed.
HITCBC 271   18396 auto const now = clock_type::now(); 272   18193 auto const now = clock_type::now();
HITCBC 272 - 18396 impl.expiry_ = 273 + 18193 impl.expiry_ = ((time_point::max)() - now < d)
HITCBC 273 - 18396 ((time_point::max)() - now < d) ? (time_point::max)() : now + d; 274 + 36382 ? (time_point::max)()
HITGNC   275 + 18189 : now + d;
274   } 276   }
HITCBC 275   19076 } 277   18873 }
276   278  
277   /** Set the timer's expiry time relative to now. 279   /** Set the timer's expiry time relative to now.
278   280  
279   This is a convenience overload that accepts any duration type 281   This is a convenience overload that accepts any duration type
280   and converts it to the timer's native duration type. 282   and converts it to the timer's native duration type.
281   283  
282   @param d The expiry time relative to now. 284   @param d The expiry time relative to now.
283   */ 285   */
284   template<class Rep, class Period> 286   template<class Rep, class Period>
285   void expires_after(std::chrono::duration<Rep, Period> d) 287   void expires_after(std::chrono::duration<Rep, Period> d)
286   { 288   {
287   expires_after(std::chrono::duration_cast<duration>(d)); 289   expires_after(std::chrono::duration_cast<duration>(d));
288   } 290   }
289   291  
290   /** Wait for the timer to expire. 292   /** Wait for the timer to expire.
291   293  
292   At most one wait may be outstanding at a time. 294   At most one wait may be outstanding at a time.
293   295  
294   The operation supports cancellation via `std::stop_token` through 296   The operation supports cancellation via `std::stop_token` through
295   the affine awaitable protocol. If the associated stop token is 297   the affine awaitable protocol. If the associated stop token is
296   triggered, only that waiter completes with an error that 298   triggered, only that waiter completes with an error that
297   compares equal to `capy::cond::canceled`. 299   compares equal to `capy::cond::canceled`.
298   300  
299   This timer must outlive the returned awaitable. 301   This timer must outlive the returned awaitable.
300   302  
301   @return An awaitable that completes with `io_result<>`. 303   @return An awaitable that completes with `io_result<>`.
302   */ 304   */
303   // Defined below wait_awaitable, which needs timer complete. 305   // Defined below wait_awaitable, which needs timer complete.
304   wait_awaitable wait(); 306   wait_awaitable wait();
305   307  
306   /** Publish a hook-driven wait. 308   /** Publish a hook-driven wait.
307   309  
308   Bypasses the elapsed fast path so every completion is 310   Bypasses the elapsed fast path so every completion is
309   delivered through the waiter's embedded op, where the 311   delivered through the waiter's embedded op, where the
310   re-arm hook is consulted. Used by awaitables that 312   re-arm hook is consulted. Used by awaitables that
311   re-publish the waiter to continue a logical wait across 313   re-publish the waiter to continue a logical wait across
312   several timer expirations. 314   several timer expirations.
313   315  
314   @par Preconditions 316   @par Preconditions
315   @p w is fully initialized ( handle, executor, stop token, 317   @p w is fully initialized ( handle, executor, stop token,
316   hook fields ) and its storage outlives the wait. 318   hook fields ) and its storage outlives the wait.
317   319  
318   @param w The waiter to publish. 320   @param w The waiter to publish.
319   321  
320   @return `std::noop_coroutine()`. 322   @return `std::noop_coroutine()`.
321   */ 323   */
322   std::coroutine_handle<> publish_wait(waiter_node& w); 324   std::coroutine_handle<> publish_wait(waiter_node& w);
323   325  
324   /** Re-arm an already-fired waiter with a new relative expiry. 326   /** Re-arm an already-fired waiter with a new relative expiry.
325   327  
326   Stores the ( saturated ) expiry and re-publishes @p w. The 328   Stores the ( saturated ) expiry and re-publishes @p w. The
327   waiter's original work count and stop callback remain in 329   waiter's original work count and stop callback remain in
328   effect. Must only be called from the waiter's re-arm hook, 330   effect. Must only be called from the waiter's re-arm hook,
329   where the waiter has been popped from the service but not 331   where the waiter has been popped from the service but not
330   yet resumed. 332   yet resumed.
331   333  
332   @par Preconditions 334   @par Preconditions
333   The timer has no other waiters — this is what makes the 335   The timer has no other waiters — this is what makes the
334   unlocked expiry write race-free. 336   unlocked expiry write race-free.
335   337  
336   Re-publication needs heap capacity and can fail under 338   Re-publication needs heap capacity and can fail under
337   allocation pressure. On failure the waiter is left exactly as 339   allocation pressure. On failure the waiter is left exactly as
338   the hook received it, so the caller completes the wait through 340   the hook received it, so the caller completes the wait through
339   the normal resume path instead of re-arming. 341   the normal resume path instead of re-arming.
340   342  
341   @param w The waiter to re-publish. 343   @param w The waiter to re-publish.
342   @param d The next expiry relative to now. 344   @param d The next expiry relative to now.
343   345  
344   @return `true` if re-published; `false` if allocation failed. 346   @return `true` if re-published; `false` if allocation failed.
345   */ 347   */
346   [[nodiscard]] bool rearm_wait(waiter_node& w, duration d) noexcept; 348   [[nodiscard]] bool rearm_wait(waiter_node& w, duration d) noexcept;
347   349  
348   protected: 350   protected:
349   explicit timer(handle h) noexcept : io_object(std::move(h)) {} 351   explicit timer(handle h) noexcept : io_object(std::move(h)) {}
350   352  
351   private: 353   private:
352   /// Return the underlying implementation. 354   /// Return the underlying implementation.
HITCBC 353   38184 implementation& get() const noexcept 355   37778 implementation& get() const noexcept
354   { 356   {
HITCBC 355   38184 return *static_cast<implementation*>(h_.get()); 357   37778 return *static_cast<implementation*>(h_.get());
356   } 358   }
357   }; 359   };
358   360  
359   /** Frame-resident per-wait state for a timer wait. 361   /** Frame-resident per-wait state for a timer wait.
360   362  
361   One node exists per `co_await` on a timer, embedded in the 363   One node exists per `co_await` on a timer, embedded in the
362   awaitable on the suspended coroutine's frame — never allocated. 364   awaitable on the suspended coroutine's frame — never allocated.
363   Once published by `implementation::wait()` the node may be 365   Once published by `implementation::wait()` the node may be
364   completed from any thread; every completion path finishes 366   completed from any thread; every completion path finishes
365   touching the node before resuming or destroying the coroutine, 367   touching the node before resuming or destroying the coroutine,
366   because either act may end the node's storage. 368   because either act may end the node's storage.
367   369  
368   The node owns no resources: the stop token is borrowed from the 370   The node owns no resources: the stop token is borrowed from the
369   awaiting chain's `io_env` (which outlives the suspension) and 371   awaiting chain's `io_env` (which outlives the suspension) and
370   the stop callback is managed manually in `cb_buf_`, destroyed on 372   the stop callback is managed manually in `cb_buf_`, destroyed on
371   every completion path before the frame can die. 373   every completion path before the frame can die.
372   */ 374   */
373   struct BOOST_COROSIO_SYMBOL_VISIBLE waiter_node 375   struct BOOST_COROSIO_SYMBOL_VISIBLE waiter_node
374   : intrusive_list<waiter_node>::node 376   : intrusive_list<waiter_node>::node
375   { 377   {
376   // Embedded completion op — avoids heap allocation per fire/cancel. 378   // Embedded completion op — avoids heap allocation per fire/cancel.
377   // Members are exported and defined non-inline in timer.cpp: the 379   // Members are exported and defined non-inline in timer.cpp: the
378   // inline waiter_node constructor references do_complete and the 380   // inline waiter_node constructor references do_complete and the
379   // vtable from translation units that reach this header through 381   // vtable from translation units that reach this header through
380   // delay.hpp without ever including timer_service.hpp, so the one 382   // delay.hpp without ever including timer_service.hpp, so the one
381   // strong definition must live in a TU that is always linked. 383   // strong definition must live in a TU that is always linked.
382   struct BOOST_COROSIO_SYMBOL_VISIBLE completion_op final : scheduler_op 384   struct BOOST_COROSIO_SYMBOL_VISIBLE completion_op final : scheduler_op
383   { 385   {
384   waiter_node* waiter_ = nullptr; 386   waiter_node* waiter_ = nullptr;
385   387  
386   BOOST_COROSIO_DECL 388   BOOST_COROSIO_DECL
387   static void do_complete( 389   static void do_complete(
388   void* owner, scheduler_op* base, std::uint32_t, std::uint32_t); 390   void* owner, scheduler_op* base, std::uint32_t, std::uint32_t);
389   391  
HITCBC 390   32010 completion_op() noexcept : scheduler_op(&do_complete) {} 392   31668 completion_op() noexcept : scheduler_op(&do_complete) {}
391   393  
392   BOOST_COROSIO_DECL void operator()() override; 394   BOOST_COROSIO_DECL void operator()() override;
393   BOOST_COROSIO_DECL void destroy() override; 395   BOOST_COROSIO_DECL void destroy() override;
394   }; 396   };
395   397  
396   // Per-waiter stop_token cancellation 398   // Per-waiter stop_token cancellation
397   struct canceller 399   struct canceller
398   { 400   {
399   waiter_node* waiter_; 401   waiter_node* waiter_;
400   BOOST_COROSIO_DECL void operator()() const; 402   BOOST_COROSIO_DECL void operator()() const;
401   }; 403   };
402   404  
403   using stop_cb_type = std::stop_callback<canceller>; 405   using stop_cb_type = std::stop_callback<canceller>;
404   406  
405   // nullptr once unpublished from the timer ( concurrency marker ) 407   // nullptr once unpublished from the timer ( concurrency marker )
406   /// The timer this waiter is published on, or `nullptr`. 408   /// The timer this waiter is published on, or `nullptr`.
407   timer::implementation* impl_ = nullptr; 409   timer::implementation* impl_ = nullptr;
408   410  
409   /// The timer service that completes this waiter. 411   /// The timer service that completes this waiter.
410   timer_service* svc_ = nullptr; 412   timer_service* svc_ = nullptr;
411   413  
412   /// The suspended coroutine, destroyed by the shutdown drains. 414   /// The suspended coroutine, destroyed by the shutdown drains.
413   std::coroutine_handle<> h_; 415   std::coroutine_handle<> h_;
414   416  
415   /// The continuation posted to resume the coroutine. 417   /// The continuation posted to resume the coroutine.
416   capy::continuation cont_; 418   capy::continuation cont_;
417   419  
418   /// The executor the continuation is posted through. 420   /// The executor the continuation is posted through.
419   capy::executor_ref d_; 421   capy::executor_ref d_;
420   422  
421   // Borrowed from the awaiting chain's io_env, which outlives the 423   // Borrowed from the awaiting chain's io_env, which outlives the
422   // suspension; the node holds no owning state. 424   // suspension; the node holds no owning state.
423   /// The stop token observed for cancellation. 425   /// The stop token observed for cancellation.
424   std::stop_token const* token_ = nullptr; 426   std::stop_token const* token_ = nullptr;
425   427  
426   /// The completion result read by `await_resume`. 428   /// The completion result read by `await_resume`.
427   std::error_code ec_; 429   std::error_code ec_;
428   430  
429   // Consulted by the completion op before resuming; lets a 431   // Consulted by the completion op before resuming; lets a
430   // clock-facade wait re-publish itself instead of completing. 432   // clock-facade wait re-publish itself instead of completing.
431   // Never consulted on the shutdown destroy path. Consulted on 433   // Never consulted on the shutdown destroy path. Consulted on
432   // every completion, including cancellation ( `ec_` set ) — the 434   // every completion, including cancellation ( `ec_` set ) — the
433   // hook must inspect `w`'s `ec_` and must not re-arm a canceled 435   // hook must inspect `w`'s `ec_` and must not re-arm a canceled
434   // waiter. Runs inside the completion path; must not throw. 436   // waiter. Runs inside the completion path; must not throw.
435   /// Re-arm hook: return true to skip resumption ( wait continues ). 437   /// Re-arm hook: return true to skip resumption ( wait continues ).
436   bool (*on_fire_)(void*) noexcept = nullptr; 438   bool (*on_fire_)(void*) noexcept = nullptr;
437   439  
438   /// Context passed to `on_fire_` ( the owning awaitable ). 440   /// Context passed to `on_fire_` ( the owning awaitable ).
439   void* on_fire_ctx_ = nullptr; 441   void* on_fire_ctx_ = nullptr;
440   442  
441   /// The embedded completion op posted to the scheduler. 443   /// The embedded completion op posted to the scheduler.
442   completion_op op_; 444   completion_op op_;
443   445  
444   // stop_callback is neither movable nor assignable; construct it 446   // stop_callback is neither movable nor assignable; construct it
445   // in place once the node is pinned on the coroutine frame, and 447   // in place once the node is pinned on the coroutine frame, and
446   // destroy it manually on every completion path. 448   // destroy it manually on every completion path.
447   /// Storage for the armed stop callback. 449   /// Storage for the armed stop callback.
448   alignas(stop_cb_type) unsigned char cb_buf_[sizeof(stop_cb_type)]; 450   alignas(stop_cb_type) unsigned char cb_buf_[sizeof(stop_cb_type)];
449   451  
450   /// True while `cb_buf_` holds a live stop callback. 452   /// True while `cb_buf_` holds a live stop callback.
451   bool cb_active_ = false; 453   bool cb_active_ = false;
452   454  
HITCBC 453   32010 waiter_node() noexcept 455   31668 waiter_node() noexcept
HITCBC 454   32010 { 456   31668 {
HITCBC 455   32010 op_.waiter_ = this; 457   31668 op_.waiter_ = this;
HITCBC 456   32010 } 458   31668 }
457   459  
458   // The embedded op self-points and the list hooks are published 460   // The embedded op self-points and the list hooks are published
459   // to other threads; the node never moves. 461   // to other threads; the node never moves.
460   waiter_node(waiter_node const&) = delete; 462   waiter_node(waiter_node const&) = delete;
461   waiter_node& operator=(waiter_node const&) = delete; 463   waiter_node& operator=(waiter_node const&) = delete;
462   464  
463   /** Bind the coroutine and its environment before publication. 465   /** Bind the coroutine and its environment before publication.
464   466  
465   The single definition of the fields every wait must populate 467   The single definition of the fields every wait must populate
466   before the node is published; hook-driven waits additionally 468   before the node is published; hook-driven waits additionally
467   set `on_fire_` / `on_fire_ctx_`. 469   set `on_fire_` / `on_fire_ctx_`.
468   470  
469   @param h The coroutine to resume on completion. 471   @param h The coroutine to resume on completion.
470   @param env The awaiting chain's environment; must outlive 472   @param env The awaiting chain's environment; must outlive
471   the suspension. 473   the suspension.
472   */ 474   */
HITCBC 473   14999 void bind(std::coroutine_handle<> h, capy::io_env const& env) noexcept 475   14828 void bind(std::coroutine_handle<> h, capy::io_env const& env) noexcept
474   { 476   {
HITCBC 475   14999 h_ = h; 477   14828 h_ = h;
HITCBC 476   14999 cont_.h = h; 478   14828 cont_.h = h;
HITCBC 477   14999 d_ = env.executor; 479   14828 d_ = env.executor;
HITCBC 478   14999 token_ = &env.stop_token; 480   14828 token_ = &env.stop_token;
HITCBC 479   14999 } 481   14828 }
480   482  
481   /** Arm the stop callback. 483   /** Arm the stop callback.
482   484  
483   @par Preconditions 485   @par Preconditions
484   `token_` is set. 486   `token_` is set.
485   */ 487   */
HITCBC 486   1492 void arm_stop_cb() 488   1575 void arm_stop_cb()
487   { 489   {
HITCBC 488   1492 new (cb_buf_) stop_cb_type(*token_, canceller{this}); 490   1575 new (cb_buf_) stop_cb_type(*token_, canceller{this});
HITCBC 489   1492 cb_active_ = true; 491   1575 cb_active_ = true;
HITCBC 490   1492 } 492   1575 }
491   493  
492   /// Destroy the stop callback if armed. 494   /// Destroy the stop callback if armed.
HITCBC 493   14146 void reset_stop_cb() noexcept 495   13977 void reset_stop_cb() noexcept
494   { 496   {
HITCBC 495   14146 if (cb_active_) 497   13977 if (cb_active_)
496   { 498   {
HITCBC 497   1492 std::launder(reinterpret_cast<stop_cb_type*>(cb_buf_)) 499   1575 std::launder(reinterpret_cast<stop_cb_type*>(cb_buf_))
HITCBC 498   1492 ->~stop_cb_type(); 500   1575 ->~stop_cb_type();
HITCBC 499   1492 cb_active_ = false; 501   1575 cb_active_ = false;
500   } 502   }
HITCBC 501   14146 } 503   13977 }
502   }; 504   };
503   505  
504   /** Awaitable returned by `timer::wait()`. 506   /** Awaitable returned by `timer::wait()`.
505   507  
506   Carries the waiter node so a wait performs no allocation. The 508   Carries the waiter node so a wait performs no allocation. The
507   awaitable is movable only before `await_suspend` publishes the 509   awaitable is movable only before `await_suspend` publishes the
508   node (a move builds a fresh, quiescent node); afterwards it is 510   node (a move builds a fresh, quiescent node); afterwards it is
509   pinned on the coroutine frame until the wait completes. 511   pinned on the coroutine frame until the wait completes.
510   */ 512   */
511   struct wait_awaitable 513   struct wait_awaitable
512   { 514   {
513   timer& t_; 515   timer& t_;
514   waiter_node w_; 516   waiter_node w_;
515   517  
HITCBC 516   14752 explicit wait_awaitable(timer& t) noexcept : t_(t) {} 518   14581 explicit wait_awaitable(timer& t) noexcept : t_(t) {}
517   519  
HITCBC 518   14752 wait_awaitable(wait_awaitable&& o) noexcept : t_(o.t_) {} 520   14581 wait_awaitable(wait_awaitable&& o) noexcept : t_(o.t_) {}
519   521  
520   wait_awaitable(wait_awaitable const&) = delete; 522   wait_awaitable(wait_awaitable const&) = delete;
521   wait_awaitable& operator=(wait_awaitable const&) = delete; 523   wait_awaitable& operator=(wait_awaitable const&) = delete;
522   wait_awaitable& operator=(wait_awaitable&&) = delete; 524   wait_awaitable& operator=(wait_awaitable&&) = delete;
523   525  
HITCBC 524   2053 bool await_ready() const noexcept 526   2053 bool await_ready() const noexcept
525   { 527   {
HITCBC 526   2053 return false; 528   2053 return false;
527   } 529   }
528   530  
529   // Cancellation surfaces through w_.ec_: the stop_token path in 531   // Cancellation surfaces through w_.ec_: the stop_token path in
530   // wait() completes the waiter with error::canceled written to 532   // wait() completes the waiter with error::canceled written to
531   // it, so there is no separate token to consult here. 533   // it, so there is no separate token to consult here.
HITCBC 532   14723 [[nodiscard]] capy::io_result<> await_resume() const noexcept 534   14552 [[nodiscard]] capy::io_result<> await_resume() const noexcept
533   { 535   {
HITCBC 534   14723 return {w_.ec_}; 536   14552 return {w_.ec_};
535   } 537   }
536   538  
HITCBC 537   14752 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 539   14581 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
538   -> std::coroutine_handle<> 540   -> std::coroutine_handle<>
539   { 541   {
HITCBC 540   14752 auto& impl = t_.get(); 542   14581 auto& impl = t_.get();
HITCBC 541   14752 w_.bind(h, *env); 543   14581 w_.bind(h, *env);
542   544  
543   // Inline fast path: already expired and not in the heap. 545   // Inline fast path: already expired and not in the heap.
544   // Post instead of dispatch so the coroutine yields to the 546   // Post instead of dispatch so the coroutine yields to the
545   // scheduler, allowing other queued work to run. 547   // scheduler, allowing other queued work to run.
HITCBC 546   14752 if (impl.already_expired()) 548   14581 if (impl.already_expired())
547   { 549   {
HITCBC 548   853 w_.ec_ = {}; 550   849 w_.ec_ = {};
HITCBC 549   853 w_.d_.post(w_.cont_); 551   849 w_.d_.post(w_.cont_);
HITCBC 550   853 return std::noop_coroutine(); 552   849 return std::noop_coroutine();
551   } 553   }
552   554  
HITCBC 553   13899 return impl.wait(w_); 555   13732 return impl.wait(w_);
554   } 556   }
555   }; 557   };
556   558  
557   inline wait_awaitable 559   inline wait_awaitable
HITCBC 558   14752 timer::wait() 560   14581 timer::wait()
559   { 561   {
HITCBC 560   14752 return wait_awaitable(*this); 562   14581 return wait_awaitable(*this);
561   } 563   }
562   564  
563   } // namespace boost::corosio::detail 565   } // namespace boost::corosio::detail
564   566  
565   #endif 567   #endif