include/boost/corosio/detail/timer_service.hpp

91.1% Lines (369/405) 97.9% List of functions (47/49) 65.6% Branches (118/180)
timer_service.hpp
f(x) Functions (49)
Function Calls Lines Branches Blocks
<unknown function 91> :91 boost::corosio::detail::timer_service::callback::callback() :96 1486x 100.0% 100.0% boost::corosio::detail::timer_service::callback::callback(void*, void (*)(void*)) :99 1486x 100.0% 100.0% boost::corosio::detail::timer_service::callback::operator()() const :108 5138x 100.0% 50.0% 100.0% boost::corosio::detail::timer_service::timer_service(boost::capy::execution_context&, boost::corosio::detail::scheduler&) :137 1486x 100.0% 100.0% boost::corosio::detail::timer_service::get_scheduler() :143 10368x 100.0% 100.0% boost::corosio::detail::timer_service::~timer_service() :149 2229x 100.0% 100.0% boost::corosio::detail::timer_service::set_on_earliest_changed(boost::corosio::detail::timer_service::callback) :155 743x 100.0% 100.0% boost::corosio::detail::timer_service::nearest_expiry() const :168 292049x 100.0% 50.0% 75.0% boost::corosio::detail::timer_service::refresh_cached_nearest() :211 334100x 100.0% 100.0% 100.0% boost::corosio::detail::waiter_node::~waiter_node() :224 502x 100.0% 100.0% boost::corosio::detail::waiter_node::completion_op::~completion_op() :228 502x 100.0% 100.0% boost::corosio::detail::waiter_node::completion_op::completion_op() :235 502x 100.0% 100.0% boost::corosio::detail::waiter_node::waiter_node() :261 502x 100.0% 100.0% boost::corosio::detail::timer_service::implementation::~implementation() :267 604x 100.0% 100.0% boost::corosio::detail::try_pop_tl_cache(boost::corosio::detail::timer_service*) :298 5297x 80.0% 50.0% 62.0% boost::corosio::detail::try_push_tl_cache(boost::corosio::detail::timer_service::implementation*) :313 5289x 100.0% 100.0% 100.0% boost::corosio::detail::try_pop_waiter_tl_cache() :324 5188x 100.0% 100.0% 100.0% boost::corosio::detail::try_push_waiter_tl_cache(boost::corosio::detail::waiter_node*) :336 5172x 100.0% 100.0% 100.0% boost::corosio::detail::timer_service_invalidate_cache() :347 743x 100.0% 100.0% 100.0% boost::corosio::detail::timer_service::implementation::implementation(boost::corosio::detail::timer_service&) :358 604x 100.0% 50.0% 100.0% boost::corosio::detail::timer_service::shutdown() :365 743x 100.0% 69.2% 93.0% boost::corosio::detail::timer_service::construct() :422 5297x 63.2% 66.7% 70.0% boost::corosio::detail::timer_service::destroy(boost::corosio::io_object::implementation*) :451 5295x 100.0% 100.0% boost::corosio::detail::timer_service::destroy_impl(boost::corosio::detail::timer_service::implementation&) :457 5295x 73.3% 62.5% 63.0% boost::corosio::detail::timer_service::create_waiter() :484 5188x 100.0% 83.3% 80.0% boost::corosio::detail::timer_service::destroy_waiter(boost::corosio::detail::waiter_node*) :502 5172x 100.0% 100.0% 100.0% boost::corosio::detail::timer_service::update_timer(boost::corosio::detail::timer_service::implementation&, std::__1::chrono::time_point<std::__1::chrono::steady_clock, std::__1::chrono::duration<long long, std::__1::ratio<1l, 1000000000l>>>) :513 6x 93.3% 50.0% 73.0% boost::corosio::detail::timer_service::insert_waiter(boost::corosio::detail::timer_service::implementation&, boost::corosio::detail::waiter_node*) :563 5188x 100.0% 75.0% 77.0% boost::corosio::detail::timer_service::cancel_timer(boost::corosio::detail::timer_service::implementation&) :583 5623x 87.0% 66.7% 75.0% boost::corosio::detail::timer_service::cancel_waiter(boost::corosio::detail::waiter_node*) :623 36x 93.8% 66.7% 66.0% boost::corosio::detail::timer_service::cancel_one_waiter(boost::corosio::detail::timer_service::implementation&) :646 2x 73.7% 37.5% 50.0% boost::corosio::detail::timer_service::process_expired() :673 328540x 95.0% 90.0% 86.0% boost::corosio::detail::timer_service::remove_timer_impl(boost::corosio::detail::timer_service::implementation&) :708 5158x 86.7% 50.0% 70.0% boost::corosio::detail::timer_service::up_heap(unsigned long) :735 5172x 100.0% 100.0% 100.0% boost::corosio::detail::timer_service::down_heap(unsigned long) :748 4658x 61.5% 50.0% 70.0% boost::corosio::detail::timer_service::swap_heap(unsigned long, unsigned long) :768 9292x 100.0% 100.0% boost::corosio::detail::waiter_node::canceller::operator()() const :780 36x 100.0% 100.0% boost::corosio::detail::waiter_node::completion_op::do_complete(void*, boost::corosio::detail::scheduler_op*, unsigned int, unsigned int) :786 0 0.0% 0.0% 0.0% boost::corosio::detail::waiter_node::completion_op::operator()() :800 5172x 100.0% 50.0% 100.0% boost::corosio::detail::waiter_node::completion_op::destroy() :825 8x 100.0% 50.0% 100.0% boost::corosio::detail::timer_service::implementation::wait(std::__1::coroutine_handle<void>, boost::capy::executor_ref, std::__1::stop_token, std::__1::error_code*, boost::capy::continuation*) :852 5215x 100.0% 80.0% 100.0% boost::corosio::detail::timer_service_access::get_timer(boost::corosio::io_context&) :896 5297x 100.0% 100.0% boost::corosio::detail::timer_service_access::set_timer(boost::corosio::io_context&, boost::corosio::detail::timer_service&) :901 743x 100.0% 100.0% boost::corosio::detail::timer_service_direct(boost::capy::execution_context&) :909 5297x 100.0% 100.0% boost::corosio::detail::timer_service_update_expiry(boost::corosio::io_timer::implementation&) :915 6x 100.0% 100.0% boost::corosio::detail::timer_service_cancel(boost::corosio::io_timer::implementation&) :922 334x 100.0% 50.0% 66.0% boost::corosio::detail::timer_service_cancel_one(boost::corosio::io_timer::implementation&) :929 2x 100.0% 50.0% 66.0% boost::corosio::detail::get_timer_service(boost::capy::execution_context&, boost::corosio::detail::scheduler&) :936 743x 100.0% 100.0%
Line Branch TLA Hits Source Code
1 //
2 // Copyright (c) 2025 Vinnie Falco ([email protected])
3 // Copyright (c) 2026 Steve Gerbino
4 //
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)
7 //
8 // Official repository: https://github.com/cppalliance/corosio
9 //
10
11 #ifndef BOOST_COROSIO_DETAIL_TIMER_SERVICE_HPP
12 #define BOOST_COROSIO_DETAIL_TIMER_SERVICE_HPP
13
14 #include <boost/corosio/timer.hpp>
15 #include <boost/corosio/io_context.hpp>
16 #include <boost/corosio/detail/scheduler_op.hpp>
17 #include <boost/corosio/detail/intrusive.hpp>
18 #include <boost/corosio/detail/thread_local_ptr.hpp>
19 #include <boost/capy/error.hpp>
20 #include <boost/capy/ex/execution_context.hpp>
21 #include <boost/capy/ex/executor_ref.hpp>
22 #include <system_error>
23
24 #include <atomic>
25 #include <chrono>
26 #include <coroutine>
27 #include <cstddef>
28 #include <limits>
29 #include <mutex>
30 #include <optional>
31 #include <stop_token>
32 #include <utility>
33 #include <vector>
34
35 namespace boost::corosio::detail {
36
37 struct scheduler;
38
39 /*
40 Timer Service
41 =============
42
43 Data Structures
44 ---------------
45 waiter_node holds per-waiter state: coroutine handle, executor,
46 error output, stop_token, embedded completion_op. Each concurrent
47 co_await t.wait() allocates one waiter_node.
48
49 timer_service::implementation holds per-timer state: expiry,
50 heap index, and an intrusive_list of waiter_nodes. Multiple
51 coroutines can wait on the same timer simultaneously.
52
53 timer_service owns a min-heap of active timers, a free list
54 of recycled impls, and a free list of recycled waiter_nodes. The
55 heap is ordered by expiry time; the scheduler queries
56 nearest_expiry() to set the epoll/timerfd timeout.
57
58 Optimization Strategy
59 ---------------------
60 1. Deferred heap insertion — expires_after() stores the expiry
61 but does not insert into the heap. Insertion happens in wait().
62 2. Thread-local impl cache — single-slot per-thread cache.
63 3. Embedded completion_op — eliminates heap allocation per fire/cancel.
64 4. Cached nearest expiry — atomic avoids mutex in nearest_expiry().
65 5. might_have_pending_waits_ flag — skips lock when no wait issued.
66 6. Thread-local waiter cache — single-slot per-thread cache.
67
68 Concurrency
69 -----------
70 stop_token callbacks can fire from any thread. The impl_
71 pointer on waiter_node is used as a "still in list" marker.
72 */
73
74 struct BOOST_COROSIO_SYMBOL_VISIBLE waiter_node;
75
76 inline void timer_service_invalidate_cache() noexcept;
77
78 // timer_service class body — member function definitions are
79 // out-of-class (after implementation and waiter_node are complete)
80 class BOOST_COROSIO_DECL timer_service final
81 : public capy::execution_context::service
82 , public io_object::io_service
83 {
84 public:
85 using clock_type = std::chrono::steady_clock;
86 using time_point = clock_type::time_point;
87
88 /// Type-erased callback for earliest-expiry-changed notifications.
89 class callback
90 {
91 743x void* ctx_ = nullptr;
92 743x void (*fn_)(void*) = nullptr;
93
94 public:
95 /// Construct an empty callback.
96 2229x callback() = default;
97
98 /// Construct a callback with the given context and function.
99 1486x callback(void* ctx, void (*fn)(void*)) noexcept : ctx_(ctx), fn_(fn) {}
100
101 /// Return true if the callback is non-empty.
102 explicit operator bool() const noexcept
103 {
104 return fn_ != nullptr;
105 }
106
107 /// Invoke the callback.
108 5138x void operator()() const
109 {
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5138 times.
5138x if (fn_)
111 5138x fn_(ctx_);
112 5138x }
113 };
114
115 struct implementation;
116
117 private:
118 struct heap_entry
119 {
120 time_point time_;
121 implementation* timer_;
122 };
123
124 scheduler* sched_ = nullptr;
125 mutable std::mutex mutex_;
126 std::vector<heap_entry> heap_;
127 743x implementation* free_list_ = nullptr;
128 743x waiter_node* waiter_free_list_ = nullptr;
129 callback on_earliest_changed_;
130 743x bool shutting_down_ = false;
131 // Avoids mutex in nearest_expiry() and empty()
132 1486x mutable std::atomic<std::int64_t> cached_nearest_ns_{
133 743x (std::numeric_limits<std::int64_t>::max)()};
134
135 public:
136 /// Construct the timer service bound to a scheduler.
137 3715x inline timer_service(capy::execution_context&, scheduler& sched)
138 743x : sched_(&sched)
139 2229x {
140 1486x }
141
142 /// Return the associated scheduler.
143 10368x inline scheduler& get_scheduler() noexcept
144 {
145 10368x return *sched_;
146 }
147
148 /// Destroy the timer service.
149 2229x ~timer_service() override = default;
150
151 timer_service(timer_service const&) = delete;
152 timer_service& operator=(timer_service const&) = delete;
153
154 /// Register a callback invoked when the earliest expiry changes.
155 743x inline void set_on_earliest_changed(callback cb)
156 {
157 743x on_earliest_changed_ = cb;
158 743x }
159
160 /// Return true if no timers are in the heap.
161 inline bool empty() const noexcept
162 {
163 return cached_nearest_ns_.load(std::memory_order_acquire) ==
164 (std::numeric_limits<std::int64_t>::max)();
165 }
166
167 /// Return the nearest timer expiry without acquiring the mutex.
168 292049x inline time_point nearest_expiry() const noexcept
169 {
170 292049x auto ns = cached_nearest_ns_.load(std::memory_order_acquire);
171
2/4
✓ Branch 0 taken 292049 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 292049 times.
✗ Branch 3 not taken.
292049x return time_point(time_point::duration(ns));
172 }
173
174 /// Cancel all pending timers and free cached resources.
175 inline void shutdown() override;
176
177 /// Construct a new timer implementation.
178 inline io_object::implementation* construct() override;
179
180 /// Destroy a timer implementation, cancelling pending waiters.
181 inline void destroy(io_object::implementation* p) override;
182
183 /// Cancel and recycle a timer implementation.
184 inline void destroy_impl(implementation& impl);
185
186 /// Create or recycle a waiter node.
187 inline waiter_node* create_waiter();
188
189 /// Return a waiter node to the cache or free list.
190 inline void destroy_waiter(waiter_node* w);
191
192 /// Update the timer expiry, cancelling existing waiters.
193 inline std::size_t update_timer(implementation& impl, time_point new_time);
194
195 /// Insert a waiter into the timer's waiter list and the heap.
196 inline void insert_waiter(implementation& impl, waiter_node* w);
197
198 /// Cancel all waiters on a timer.
199 inline std::size_t cancel_timer(implementation& impl);
200
201 /// Cancel a single waiter ( stop_token callback path ).
202 inline void cancel_waiter(waiter_node* w);
203
204 /// Cancel one waiter on a timer.
205 inline std::size_t cancel_one_waiter(implementation& impl);
206
207 /// Complete all waiters whose timers have expired.
208 inline std::size_t process_expired();
209
210 private:
211 334100x inline void refresh_cached_nearest() noexcept
212 {
213
2/2
✓ Branch 0 taken 5579 times.
✓ Branch 1 taken 328521 times.
334100x auto ns = heap_.empty() ? (std::numeric_limits<std::int64_t>::max)()
214 328521x : heap_[0].time_.time_since_epoch().count();
215 334100x cached_nearest_ns_.store(ns, std::memory_order_release);
216 334100x }
217
218 inline void remove_timer_impl(implementation& impl);
219 inline void up_heap(std::size_t index);
220 inline void down_heap(std::size_t index);
221 inline void swap_heap(std::size_t i1, std::size_t i2);
222 };
223
224 struct BOOST_COROSIO_SYMBOL_VISIBLE waiter_node
225 : intrusive_list<waiter_node>::node
226 {
227 // Embedded completion op — avoids heap allocation per fire/cancel
228 struct completion_op final : scheduler_op
229 {
230 251x waiter_node* waiter_ = nullptr;
231
232 static void do_complete(
233 void* owner, scheduler_op* base, std::uint32_t, std::uint32_t);
234
235 753x completion_op() noexcept : scheduler_op(&do_complete) {}
236
237 void operator()() override;
238 void destroy() override;
239 };
240
241 // Per-waiter stop_token cancellation
242 struct canceller
243 {
244 waiter_node* waiter_;
245 void operator()() const;
246 };
247
248 // nullptr once removed from timer's waiter list (concurrency marker)
249 251x timer_service::implementation* impl_ = nullptr;
250 251x timer_service* svc_ = nullptr;
251 std::coroutine_handle<> h_;
252 251x capy::continuation* cont_ = nullptr;
253 capy::executor_ref d_;
254 251x std::error_code* ec_out_ = nullptr;
255 std::stop_token token_;
256 std::optional<std::stop_callback<canceller>> stop_cb_;
257 completion_op op_;
258 std::error_code ec_value_;
259 251x waiter_node* next_free_ = nullptr;
260
261 1255x waiter_node() noexcept
262 251x {
263 251x op_.waiter_ = this;
264 502x }
265 };
266
267 struct timer_service::implementation final : timer::implementation
268 {
269 using clock_type = std::chrono::steady_clock;
270 using time_point = clock_type::time_point;
271 using duration = clock_type::duration;
272
273 timer_service* svc_ = nullptr;
274 intrusive_list<waiter_node> waiters_;
275
276 // Free list linkage (reused when impl is on free_list)
277 302x implementation* next_free_ = nullptr;
278
279 inline explicit implementation(timer_service& svc) noexcept;
280
281 inline std::coroutine_handle<> wait(
282 std::coroutine_handle<>,
283 capy::executor_ref,
284 std::stop_token,
285 std::error_code*,
286 capy::continuation*) override;
287 };
288
289 // Thread-local caches avoid hot-path mutex acquisitions:
290 // 1. Impl cache — single-slot, validated by comparing svc_
291 // 2. Waiter cache — single-slot, no service affinity
292 // All caches are cleared by timer_service_invalidate_cache() during shutdown.
293
294 inline thread_local_ptr<timer_service::implementation> tl_cached_impl;
295 inline thread_local_ptr<waiter_node> tl_cached_waiter;
296
297 inline timer_service::implementation*
298 5297x try_pop_tl_cache(timer_service* svc) noexcept
299 {
300 5297x auto* impl = tl_cached_impl.get();
301
2/2
✓ Branch 0 taken 302 times.
✓ Branch 1 taken 4995 times.
5297x if (impl)
302 {
303 4995x tl_cached_impl.set(nullptr);
304
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4995 times.
4995x if (impl->svc_ == svc)
305 4995x return impl;
306 // Stale impl from a destroyed service
307 delete impl;
308 }
309 302x return nullptr;
310 5297x }
311
312 inline bool
313 5289x try_push_tl_cache(timer_service::implementation* impl) noexcept
314 {
315
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 5199 times.
5289x if (!tl_cached_impl.get())
316 {
317 5199x tl_cached_impl.set(impl);
318 5199x return true;
319 }
320 90x return false;
321 5289x }
322
323 inline waiter_node*
324 5188x try_pop_waiter_tl_cache() noexcept
325 {
326 5188x auto* w = tl_cached_waiter.get();
327
2/2
✓ Branch 0 taken 4935 times.
✓ Branch 1 taken 253 times.
5188x if (w)
328 {
329 4935x tl_cached_waiter.set(nullptr);
330 4935x return w;
331 }
332 253x return nullptr;
333 5188x }
334
335 inline bool
336 5172x try_push_waiter_tl_cache(waiter_node* w) noexcept
337 {
338
2/2
✓ Branch 0 taken 86 times.
✓ Branch 1 taken 5086 times.
5172x if (!tl_cached_waiter.get())
339 {
340 5086x tl_cached_waiter.set(w);
341 5086x return true;
342 }
343 86x return false;
344 5172x }
345
346 inline void
347 743x timer_service_invalidate_cache() noexcept
348 {
349
2/2
✓ Branch 0 taken 539 times.
✓ Branch 1 taken 204 times.
743x delete tl_cached_impl.get();
350 743x tl_cached_impl.set(nullptr);
351
352
2/2
✓ Branch 0 taken 592 times.
✓ Branch 1 taken 151 times.
743x delete tl_cached_waiter.get();
353 743x tl_cached_waiter.set(nullptr);
354 743x }
355
356 // timer_service out-of-class member function definitions
357
358
1/2
✓ Branch 0 taken 302 times.
✗ Branch 1 not taken.
604x inline timer_service::implementation::implementation(
359 timer_service& svc) noexcept
360 302x : svc_(&svc)
361 604x {
362 604x }
363
364 inline void
365 743x timer_service::shutdown()
366 {
367 743x timer_service_invalidate_cache();
368 743x shutting_down_ = true;
369
370 // Snapshot impls and detach them from the heap so that
371 // coroutine-owned timer destructors (triggered by h.destroy()
372 // below) cannot re-enter remove_timer_impl() and mutate the
373 // vector during iteration.
374 743x std::vector<implementation*> impls;
375
1/2
✓ Branch 0 taken 743 times.
✗ Branch 1 not taken.
743x impls.reserve(heap_.size());
376
2/2
✓ Branch 0 taken 743 times.
✓ Branch 1 taken 8 times.
751x for (auto& entry : heap_)
377 {
378 8x entry.timer_->heap_index_ = (std::numeric_limits<std::size_t>::max)();
379
1/2
✓ Branch 0 taken 8 times.
✗ Branch 1 not taken.
8x impls.push_back(entry.timer_);
380 }
381 743x heap_.clear();
382 1486x cached_nearest_ns_.store(
383 743x (std::numeric_limits<std::int64_t>::max)(), std::memory_order_release);
384
385 // Cancel waiting timers. Each waiter called work_started()
386 // in implementation::wait(). On IOCP the scheduler shutdown
387 // loop exits when outstanding_work_ reaches zero, so we must
388 // call work_finished() here to balance it. On other backends
389 // this is harmless.
390
2/2
✓ Branch 0 taken 743 times.
✓ Branch 1 taken 8 times.
751x for (auto* impl : impls)
391 {
392
2/2
✓ Branch 0 taken 8 times.
✓ Branch 1 taken 8 times.
16x while (auto* w = impl->waiters_.pop_front())
393 {
394 8x w->stop_cb_.reset();
395 8x auto h = std::exchange(w->h_, {});
396 8x sched_->work_finished();
397
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
8x if (h)
398
1/2
✓ Branch 0 taken 8 times.
✗ Branch 1 not taken.
8x h.destroy();
399
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
8x delete w;
400 }
401
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
8x delete impl;
402 }
403
404 // Delete free-listed impls
405
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 743 times.
833x while (free_list_)
406 {
407 90x auto* next = free_list_->next_free_;
408
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 90 times.
90x delete free_list_;
409 90x free_list_ = next;
410 }
411
412 // Delete free-listed waiters
413
2/2
✓ Branch 0 taken 84 times.
✓ Branch 1 taken 743 times.
827x while (waiter_free_list_)
414 {
415 84x auto* next = waiter_free_list_->next_free_;
416
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 84 times.
84x delete waiter_free_list_;
417 84x waiter_free_list_ = next;
418 }
419 743x }
420
421 inline io_object::implementation*
422 5297x timer_service::construct()
423 {
424 5297x implementation* impl = try_pop_tl_cache(this);
425
2/2
✓ Branch 0 taken 4995 times.
✓ Branch 1 taken 302 times.
5297x if (impl)
426 {
427 4995x impl->svc_ = this;
428 4995x impl->heap_index_ = (std::numeric_limits<std::size_t>::max)();
429 4995x impl->might_have_pending_waits_ = false;
430 4995x return impl;
431 }
432
433 302x std::lock_guard lock(mutex_);
434
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 302 times.
302x if (free_list_)
435 {
436 impl = free_list_;
437 free_list_ = impl->next_free_;
438 impl->next_free_ = nullptr;
439 impl->svc_ = this;
440 impl->heap_index_ = (std::numeric_limits<std::size_t>::max)();
441 impl->might_have_pending_waits_ = false;
442 }
443 else
444 {
445
1/2
✓ Branch 0 taken 302 times.
✗ Branch 1 not taken.
302x impl = new implementation(*this);
446 }
447 302x return impl;
448 5297x }
449
450 inline void
451 5295x timer_service::destroy(io_object::implementation* p)
452 {
453 5295x destroy_impl(static_cast<implementation&>(*p));
454 5295x }
455
456 inline void
457 5295x timer_service::destroy_impl(implementation& impl)
458 {
459 // During shutdown the impl is owned by the shutdown loop.
460 // Re-entering here (from a coroutine-owned timer destructor
461 // triggered by h.destroy()) must not modify the heap or
462 // recycle the impl — shutdown deletes it directly.
463
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 5289 times.
5295x if (shutting_down_)
464 6x return;
465
466 5289x cancel_timer(impl);
467
468
1/2
✓ Branch 0 taken 5289 times.
✗ Branch 1 not taken.
5289x if (impl.heap_index_ != (std::numeric_limits<std::size_t>::max)())
469 {
470 std::lock_guard lock(mutex_);
471 remove_timer_impl(impl);
472 refresh_cached_nearest();
473 }
474
475
2/2
✓ Branch 0 taken 5199 times.
✓ Branch 1 taken 90 times.
5289x if (try_push_tl_cache(&impl))
476 5199x return;
477
478 90x std::lock_guard lock(mutex_);
479 90x impl.next_free_ = free_list_;
480 90x free_list_ = &impl;
481 5295x }
482
483 inline waiter_node*
484 5188x timer_service::create_waiter()
485 {
486
2/2
✓ Branch 0 taken 4935 times.
✓ Branch 1 taken 253 times.
5188x if (auto* w = try_pop_waiter_tl_cache())
487 4935x return w;
488
489 253x std::lock_guard lock(mutex_);
490
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 251 times.
253x if (waiter_free_list_)
491 {
492 2x auto* w = waiter_free_list_;
493 2x waiter_free_list_ = w->next_free_;
494 2x w->next_free_ = nullptr;
495 2x return w;
496 }
497
498
1/2
✓ Branch 0 taken 251 times.
✗ Branch 1 not taken.
251x return new waiter_node();
499 5188x }
500
501 inline void
502 5172x timer_service::destroy_waiter(waiter_node* w)
503 {
504
2/2
✓ Branch 0 taken 5086 times.
✓ Branch 1 taken 86 times.
5172x if (try_push_waiter_tl_cache(w))
505 5086x return;
506
507 86x std::lock_guard lock(mutex_);
508 86x w->next_free_ = waiter_free_list_;
509 86x waiter_free_list_ = w;
510 5172x }
511
512 inline std::size_t
513 6x timer_service::update_timer(implementation& impl, time_point new_time)
514 {
515 6x bool in_heap =
516 6x (impl.heap_index_ != (std::numeric_limits<std::size_t>::max)());
517
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
6x if (!in_heap && impl.waiters_.empty())
518 return 0;
519
520 6x bool notify = false;
521 6x intrusive_list<waiter_node> canceled;
522
523 {
524 6x std::lock_guard lock(mutex_);
525
526
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 6 times.
16x while (auto* w = impl.waiters_.pop_front())
527 {
528 10x w->impl_ = nullptr;
529 10x canceled.push_back(w);
530 }
531
532
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
6x if (impl.heap_index_ < heap_.size())
533 {
534 6x time_point old_time = heap_[impl.heap_index_].time_;
535 6x heap_[impl.heap_index_].time_ = new_time;
536
537
2/4
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 6 times.
✗ Branch 3 not taken.
6x if (new_time < old_time)
538
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
6x up_heap(impl.heap_index_);
539 else
540 down_heap(impl.heap_index_);
541
542 6x notify = (impl.heap_index_ == 0);
543 6x }
544
545 6x refresh_cached_nearest();
546 6x }
547
548 6x std::size_t count = 0;
549
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 6 times.
16x while (auto* w = canceled.pop_front())
550 {
551 10x w->ec_value_ = make_error_code(capy::error::canceled);
552 10x sched_->post(&w->op_);
553 10x ++count;
554 }
555
556
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
6x if (notify)
557 6x on_earliest_changed_();
558
559 6x return count;
560 6x }
561
562 inline void
563 5188x timer_service::insert_waiter(implementation& impl, waiter_node* w)
564 {
565 5188x bool notify = false;
566 {
567 5188x std::lock_guard lock(mutex_);
568
2/2
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 5166 times.
5188x if (impl.heap_index_ == (std::numeric_limits<std::size_t>::max)())
569 {
570 5166x impl.heap_index_ = heap_.size();
571
1/2
✓ Branch 0 taken 5166 times.
✗ Branch 1 not taken.
5166x heap_.push_back({impl.expiry_, &impl});
572
1/2
✓ Branch 0 taken 5166 times.
✗ Branch 1 not taken.
5166x up_heap(heap_.size() - 1);
573 5166x notify = (impl.heap_index_ == 0);
574 5166x refresh_cached_nearest();
575 5166x }
576 5188x impl.waiters_.push_back(w);
577 5188x }
578
2/2
✓ Branch 0 taken 56 times.
✓ Branch 1 taken 5132 times.
5188x if (notify)
579 5132x on_earliest_changed_();
580 5188x }
581
582 inline std::size_t
583 5623x timer_service::cancel_timer(implementation& impl)
584 {
585
2/2
✓ Branch 0 taken 5273 times.
✓ Branch 1 taken 350 times.
5623x if (!impl.might_have_pending_waits_)
586 5273x return 0;
587
588 // Not in heap and no waiters — just clear the flag
589
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 350 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
350x if (impl.heap_index_ == (std::numeric_limits<std::size_t>::max)() &&
590 impl.waiters_.empty())
591 {
592 impl.might_have_pending_waits_ = false;
593 return 0;
594 }
595
596 350x intrusive_list<waiter_node> canceled;
597
598 {
599 350x std::lock_guard lock(mutex_);
600
1/2
✓ Branch 0 taken 350 times.
✗ Branch 1 not taken.
350x remove_timer_impl(impl);
601
2/2
✓ Branch 0 taken 354 times.
✓ Branch 1 taken 350 times.
704x while (auto* w = impl.waiters_.pop_front())
602 {
603 354x w->impl_ = nullptr;
604 354x canceled.push_back(w);
605 }
606 350x refresh_cached_nearest();
607 350x }
608
609 350x impl.might_have_pending_waits_ = false;
610
611 350x std::size_t count = 0;
612
2/2
✓ Branch 0 taken 354 times.
✓ Branch 1 taken 350 times.
704x while (auto* w = canceled.pop_front())
613 {
614 354x w->ec_value_ = make_error_code(capy::error::canceled);
615 354x sched_->post(&w->op_);
616 354x ++count;
617 }
618
619 350x return count;
620 5623x }
621
622 inline void
623 36x timer_service::cancel_waiter(waiter_node* w)
624 {
625 {
626 36x std::lock_guard lock(mutex_);
627 // Already removed by cancel_timer or process_expired
628
1/2
✓ Branch 0 taken 36 times.
✗ Branch 1 not taken.
36x if (!w->impl_)
629 return;
630 36x auto* impl = w->impl_;
631 36x w->impl_ = nullptr;
632 36x impl->waiters_.remove(w);
633
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 34 times.
36x if (impl->waiters_.empty())
634 {
635
1/2
✓ Branch 0 taken 34 times.
✗ Branch 1 not taken.
34x remove_timer_impl(*impl);
636 34x impl->might_have_pending_waits_ = false;
637 34x }
638 36x refresh_cached_nearest();
639 36x }
640
641 36x w->ec_value_ = make_error_code(capy::error::canceled);
642 36x sched_->post(&w->op_);
643 36x }
644
645 inline std::size_t
646 2x timer_service::cancel_one_waiter(implementation& impl)
647 {
648
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
2x if (!impl.might_have_pending_waits_)
649 return 0;
650
651 2x waiter_node* w = nullptr;
652
653 {
654 2x std::lock_guard lock(mutex_);
655 2x w = impl.waiters_.pop_front();
656
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
2x if (!w)
657 return 0;
658 2x w->impl_ = nullptr;
659
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
2x if (impl.waiters_.empty())
660 {
661 remove_timer_impl(impl);
662 impl.might_have_pending_waits_ = false;
663 }
664 2x refresh_cached_nearest();
665 2x }
666
667 2x w->ec_value_ = make_error_code(capy::error::canceled);
668 2x sched_->post(&w->op_);
669 2x return 1;
670 2x }
671
672 inline std::size_t
673 328540x timer_service::process_expired()
674 {
675 328540x intrusive_list<waiter_node> expired;
676
677 {
678 328540x std::lock_guard lock(mutex_);
679 328540x auto now = clock_type::now();
680
681
4/4
✓ Branch 0 taken 5203 times.
✓ Branch 1 taken 328111 times.
✓ Branch 2 taken 328540 times.
✓ Branch 3 taken 4774 times.
333314x while (!heap_.empty() && heap_[0].time_ <= now)
682 {
683 4774x implementation* t = heap_[0].timer_;
684
1/2
✓ Branch 0 taken 4774 times.
✗ Branch 1 not taken.
4774x remove_timer_impl(*t);
685
2/2
✓ Branch 0 taken 4778 times.
✓ Branch 1 taken 4774 times.
9552x while (auto* w = t->waiters_.pop_front())
686 {
687 4778x w->impl_ = nullptr;
688 4778x w->ec_value_ = {};
689 4778x expired.push_back(w);
690 }
691 4774x t->might_have_pending_waits_ = false;
692 }
693
694 328540x refresh_cached_nearest();
695 328540x }
696
697 328540x std::size_t count = 0;
698
2/2
✓ Branch 0 taken 4778 times.
✓ Branch 1 taken 328540 times.
333318x while (auto* w = expired.pop_front())
699 {
700 4778x sched_->post(&w->op_);
701 4778x ++count;
702 }
703
704 328540x return count;
705 }
706
707 inline void
708 5158x timer_service::remove_timer_impl(implementation& impl)
709 {
710 5158x std::size_t index = impl.heap_index_;
711
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5158 times.
5158x if (index >= heap_.size())
712 return; // Not in heap
713
714
2/2
✓ Branch 0 taken 500 times.
✓ Branch 1 taken 4658 times.
5158x if (index == heap_.size() - 1)
715 {
716 // Last element, just pop
717 500x impl.heap_index_ = (std::numeric_limits<std::size_t>::max)();
718 500x heap_.pop_back();
719 500x }
720 else
721 {
722 // Swap with last and reheapify
723 4658x swap_heap(index, heap_.size() - 1);
724 4658x impl.heap_index_ = (std::numeric_limits<std::size_t>::max)();
725 4658x heap_.pop_back();
726
727
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 4658 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
4658x if (index > 0 && heap_[index].time_ < heap_[(index - 1) / 2].time_)
728 up_heap(index);
729 else
730 4658x down_heap(index);
731 }
732 5158x }
733
734 inline void
735 5172x timer_service::up_heap(std::size_t index)
736 {
737
2/2
✓ Branch 0 taken 5138 times.
✓ Branch 1 taken 4668 times.
9806x while (index > 0)
738 {
739 4668x std::size_t parent = (index - 1) / 2;
740
2/2
✓ Branch 0 taken 34 times.
✓ Branch 1 taken 4634 times.
4668x if (!(heap_[index].time_ < heap_[parent].time_))
741 34x break;
742 4634x swap_heap(index, parent);
743 4634x index = parent;
744 }
745 5172x }
746
747 inline void
748 4658x timer_service::down_heap(std::size_t index)
749 {
750 4658x std::size_t child = index * 2 + 1;
751
2/2
✓ Branch 0 taken 4652 times.
✓ Branch 1 taken 6 times.
4658x while (child < heap_.size())
752 {
753
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
6x std::size_t min_child = (child + 1 == heap_.size() ||
754 heap_[child].time_ < heap_[child + 1].time_)
755 6x ? child
756 : child + 1;
757
758
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
6x if (heap_[index].time_ < heap_[min_child].time_)
759 6x break;
760
761 swap_heap(index, min_child);
762 index = min_child;
763 child = index * 2 + 1;
764 }
765 4658x }
766
767 inline void
768 9292x timer_service::swap_heap(std::size_t i1, std::size_t i2)
769 {
770 9292x heap_entry tmp = heap_[i1];
771 9292x heap_[i1] = heap_[i2];
772 9292x heap_[i2] = tmp;
773 9292x heap_[i1].timer_->heap_index_ = i1;
774 9292x heap_[i2].timer_->heap_index_ = i2;
775 9292x }
776
777 // waiter_node out-of-class member function definitions
778
779 inline void
780 36x waiter_node::canceller::operator()() const
781 {
782 36x waiter_->svc_->cancel_waiter(waiter_);
783 36x }
784
785 inline void
786 waiter_node::completion_op::do_complete(
787 [[maybe_unused]] void* owner,
788 scheduler_op* base,
789 std::uint32_t,
790 std::uint32_t)
791 {
792 // owner is always non-null here. The destroy path (owner == nullptr)
793 // is unreachable because completion_op overrides destroy() directly,
794 // bypassing scheduler_op::destroy() which would call func_(nullptr, ...).
795 BOOST_COROSIO_ASSERT(owner);
796 static_cast<completion_op*>(base)->operator()();
797 }
798
799 inline void
800 5172x waiter_node::completion_op::operator()()
801 {
802 5172x auto* w = waiter_;
803 5172x w->stop_cb_.reset();
804
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5172 times.
5172x if (w->ec_out_)
805 5172x *w->ec_out_ = w->ec_value_;
806
807 5172x auto* cont = w->cont_;
808 5172x auto d = w->d_;
809 5172x auto* svc = w->svc_;
810 5172x auto& sched = svc->get_scheduler();
811
812 5172x svc->destroy_waiter(w);
813
814 5172x d.post(*cont);
815 5172x sched.work_finished();
816 5172x }
817
818 // GCC 14 false-positive: inlining ~optional<stop_callback> through
819 // delete loses track that stop_cb_ was already .reset() above.
820 #if defined(__GNUC__) && !defined(__clang__)
821 #pragma GCC diagnostic push
822 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
823 #endif
824 inline void
825 8x waiter_node::completion_op::destroy()
826 {
827 // Called during scheduler shutdown drain when this completion_op is
828 // in the scheduler's ready queue (posted by cancel_timer() or
829 // process_expired()). Balances the work_started() from
830 // implementation::wait(). The scheduler drain loop separately
831 // balances the work_started() from post(). On IOCP both decrements
832 // are required for outstanding_work_ to reach zero; on other
833 // backends this is harmless.
834 //
835 // This override also prevents scheduler_op::destroy() from calling
836 // do_complete(nullptr, ...). See also: timer_service::shutdown()
837 // which drains waiters still in the timer heap (the other path).
838 8x auto* w = waiter_;
839 8x w->stop_cb_.reset();
840 8x auto h = std::exchange(w->h_, {});
841 8x auto& sched = w->svc_->get_scheduler();
842
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
8x delete w;
843 8x sched.work_finished();
844
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
8x if (h)
845 8x h.destroy();
846 8x }
847 #if defined(__GNUC__) && !defined(__clang__)
848 #pragma GCC diagnostic pop
849 #endif
850
851 inline std::coroutine_handle<>
852 5215x timer_service::implementation::wait(
853 std::coroutine_handle<> h,
854 capy::executor_ref d,
855 std::stop_token token,
856 std::error_code* ec,
857 capy::continuation* cont)
858 {
859 // Already-expired fast path — no waiter_node, no mutex.
860 // Post instead of dispatch so the coroutine yields to the
861 // scheduler, allowing other queued work to run.
862
2/2
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 5193 times.
5215x if (heap_index_ == (std::numeric_limits<std::size_t>::max)())
863 {
864
3/4
✗ Branch 0 not taken.
✓ Branch 1 taken 5193 times.
✓ Branch 2 taken 27 times.
✓ Branch 3 taken 5166 times.
5193x if (expiry_ == (time_point::min)() || expiry_ <= clock_type::now())
865 {
866
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 27 times.
27x if (ec)
867 27x *ec = {};
868 27x d.post(*cont);
869 27x return std::noop_coroutine();
870 }
871 5166x }
872
873 5188x auto* w = svc_->create_waiter();
874 5188x w->impl_ = this;
875 5188x w->svc_ = svc_;
876 5188x w->h_ = h;
877 5188x w->cont_ = cont;
878 5188x w->d_ = d;
879 5188x w->token_ = std::move(token);
880 5188x w->ec_out_ = ec;
881
882 5188x svc_->insert_waiter(*this, w);
883 5188x might_have_pending_waits_ = true;
884 5188x svc_->get_scheduler().work_started();
885
886
2/2
✓ Branch 0 taken 5128 times.
✓ Branch 1 taken 60 times.
5188x if (w->token_.stop_possible())
887 60x w->stop_cb_.emplace(w->token_, waiter_node::canceller{w});
888
889 5188x return std::noop_coroutine();
890 5215x }
891
892 // Free functions
893
894 struct timer_service_access
895 {
896 5297x static timer_service& get_timer(io_context& ctx) noexcept
897 {
898 5297x return *ctx.timer_svc_;
899 }
900
901 743x static void set_timer(io_context& ctx, timer_service& svc) noexcept
902 {
903 743x ctx.timer_svc_ = &svc;
904 743x }
905 };
906
907 // Bypass find_service() mutex by reading io_context's cached pointer
908 inline io_object::io_service&
909 5297x timer_service_direct(capy::execution_context& ctx) noexcept
910 {
911 5297x return timer_service_access::get_timer(static_cast<io_context&>(ctx));
912 }
913
914 inline std::size_t
915 6x timer_service_update_expiry(timer::implementation& base)
916 {
917 6x auto& impl = static_cast<timer_service::implementation&>(base);
918 6x return impl.svc_->update_timer(impl, impl.expiry_);
919 }
920
921 inline std::size_t
922 334x timer_service_cancel(timer::implementation& base) noexcept
923 {
924 334x auto& impl = static_cast<timer_service::implementation&>(base);
925
1/2
✓ Branch 0 taken 334 times.
✗ Branch 1 not taken.
334x return impl.svc_->cancel_timer(impl);
926 }
927
928 inline std::size_t
929 2x timer_service_cancel_one(timer::implementation& base) noexcept
930 {
931 2x auto& impl = static_cast<timer_service::implementation&>(base);
932
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
2x return impl.svc_->cancel_one_waiter(impl);
933 }
934
935 inline timer_service&
936 743x get_timer_service(capy::execution_context& ctx, scheduler& sched)
937 {
938 743x auto& svc = ctx.make_service<timer_service>(sched);
939 743x timer_service_access::set_timer(static_cast<io_context&>(ctx), svc);
940 743x return svc;
941 }
942
943 } // namespace boost::corosio::detail
944
945 #endif
946