TLA Line data Source code
1 : //
2 : // Copyright (c) 2026 Steve Gerbino
3 : //
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)
6 : //
7 : // Official repository: https://github.com/cppalliance/corosio
8 : //
9 :
10 : #ifndef BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SCHEDULER_HPP
11 : #define BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SCHEDULER_HPP
12 :
13 : #include <boost/corosio/detail/config.hpp>
14 : #include <boost/corosio/detail/object_ref.hpp>
15 : #include <boost/capy/ex/execution_context.hpp>
16 : #include <boost/capy/ex/abandon.hpp>
17 :
18 : #include <boost/corosio/detail/ready_queue.hpp>
19 : #include <boost/corosio/detail/scheduler.hpp>
20 : #include <boost/corosio/detail/scheduler_op.hpp>
21 : #include <boost/corosio/detail/thread_local_ptr.hpp>
22 : #include <boost/corosio/detail/timer_service.hpp>
23 :
24 : #include <atomic>
25 : #include <chrono>
26 : #include <coroutine>
27 : #include <cstddef>
28 : #include <cstdint>
29 : #include <limits>
30 : #include <memory>
31 : #include <stdexcept>
32 :
33 : #include <boost/corosio/detail/conditionally_enabled_mutex.hpp>
34 : #include <boost/corosio/detail/conditionally_enabled_event.hpp>
35 :
36 : namespace boost::corosio::detail {
37 :
38 : // Forward declarations
39 : class reactor_scheduler;
40 :
41 : /** A deregistered descriptor whose owner must outlive the reactor pass
42 : that may still hold it.
43 :
44 : An event the reactor has already read from the kernel can name a
45 : descriptor that another thread closes before the reactor queues it.
46 : The closing thread hands over a reference instead of dropping it, so
47 : the owner is neither freed nor recycled until that pass ends.
48 : */
49 : struct reactor_retirable
50 : {
51 : // All four fields are guarded by the scheduler's mutex.
52 :
53 : /// Next in the scheduler's retired list.
54 : reactor_retirable* retired_next_ = nullptr;
55 :
56 : /// Owner reference held until the pass ends.
57 : object_ref retired_ref_;
58 :
59 : /// Next in a settling thread's list of references to drop.
60 : reactor_retirable* dropped_next_ = nullptr;
61 :
62 : /// Owner reference waiting to be dropped outside the mutex.
63 : object_ref dropped_ref_;
64 :
65 : /// Move @p keep into a queued completion, if one is pending.
66 : virtual void hand_off(object_ref& keep) noexcept = 0;
67 :
68 : protected:
69 HIT 11999 : ~reactor_retirable() = default;
70 : };
71 :
72 : /** Per-thread state for a reactor scheduler.
73 :
74 : Each thread running a scheduler's event loop has one of these
75 : on a thread-local stack. It holds a private work queue and
76 : inline completion budget for speculative I/O fast paths.
77 : */
78 : struct BOOST_COROSIO_SYMBOL_VISIBLE reactor_scheduler_context
79 : {
80 : /// Scheduler this context belongs to.
81 : reactor_scheduler const* key;
82 :
83 : /// Next context frame on this thread's stack.
84 : reactor_scheduler_context* next;
85 :
86 : /// Private work queue for reduced contention.
87 : ready_queue private_queue;
88 :
89 : /// Unflushed work count for the private queue.
90 : std::int64_t private_outstanding_work;
91 :
92 : /// Remaining inline completions allowed this cycle.
93 : int inline_budget;
94 :
95 : /// Maximum inline budget (adaptive, 2-16).
96 : int inline_budget_max;
97 :
98 : /// True if no other thread absorbed queued work last cycle.
99 : bool unassisted;
100 :
101 : /// Construct a context frame linked to @a n.
102 : reactor_scheduler_context(
103 : reactor_scheduler const* k, reactor_scheduler_context* n);
104 : };
105 :
106 : /// Thread-local context stack for reactor schedulers.
107 : inline thread_local_ptr<reactor_scheduler_context> reactor_context_stack;
108 :
109 : /// Find the context frame for a scheduler on this thread.
110 : inline reactor_scheduler_context*
111 1025181 : reactor_find_context(reactor_scheduler const* self) noexcept
112 : {
113 1025754 : for (auto* c = reactor_context_stack.get(); c != nullptr; c = c->next)
114 : {
115 962679 : if (c->key == self)
116 962106 : return c;
117 : }
118 63075 : return nullptr;
119 : }
120 :
121 : /** Non-template base for reactor-backed scheduler implementations.
122 :
123 : Provides the complete threading model shared by epoll, kqueue,
124 : and select schedulers: signal state machine, inline completion
125 : budget, work counting, run/poll methods, and the do_one event
126 : loop.
127 :
128 : Derived classes provide platform-specific hooks by overriding:
129 : - `run_task(lock, ctx)` to run the reactor poll
130 : - `interrupt_reactor()` to wake a blocked reactor
131 :
132 : De-templated from the original CRTP design to eliminate
133 : duplicate instantiations when multiple backends are compiled
134 : into the same binary. Virtual dispatch for run_task (called
135 : once per reactor cycle, before a blocking syscall) has
136 : negligible overhead.
137 :
138 : @par Thread Safety
139 : All public member functions are thread-safe.
140 : */
141 : class reactor_scheduler
142 : : public scheduler
143 : {
144 : public:
145 : using context_type = reactor_scheduler_context;
146 : using mutex_type = conditionally_enabled_mutex;
147 : using lock_type = mutex_type::scoped_lock;
148 : using event_type = conditionally_enabled_event;
149 :
150 : /// Post a coroutine for deferred execution.
151 : void post(std::coroutine_handle<> h) const override;
152 :
153 : /// Post a scheduler operation for deferred execution.
154 : void post(scheduler_op* h) const override;
155 :
156 : /** Release an owner reference once no reactor pass can hold `d`.
157 :
158 : Called after a descriptor is deregistered. If a reactor pass is
159 : running, `keep` is parked on `d` until that pass ends. Then, or
160 : at once if no pass is running, it moves to `d`'s queued
161 : invocation if `d` is queued, and is dropped otherwise.
162 :
163 : @param d The deregistered descriptor.
164 : @param keep A reference to the descriptor's owner.
165 : */
166 : void retire_descriptor(reactor_retirable& d, object_ref keep) const;
167 :
168 : /// Post a continuation for deferred execution.
169 : void post(capy::continuation&) const override;
170 :
171 : /// Return true if called from a thread running this scheduler.
172 : bool running_in_this_thread() const noexcept override;
173 :
174 : /// Request the scheduler to stop dispatching handlers.
175 : void stop() override;
176 :
177 : /// Return true if the scheduler has been stopped.
178 : bool stopped() const noexcept override;
179 :
180 : /// Reset the stopped state so `run()` can resume.
181 : void restart() override;
182 :
183 : /// Run the event loop until no work remains.
184 : std::size_t run() override;
185 :
186 : /// Run until one handler completes or no work remains.
187 : std::size_t run_one() override;
188 :
189 : /// Run until one handler completes or @a usec elapses.
190 : std::size_t wait_one(long usec) override;
191 :
192 : /// Run ready handlers without blocking.
193 : std::size_t poll() override;
194 :
195 : /// Run at most one ready handler without blocking.
196 : std::size_t poll_one() override;
197 :
198 : /// Increment the outstanding work count.
199 : void work_started() noexcept override;
200 :
201 : /// Decrement the outstanding work count, stopping on zero.
202 : void work_finished() noexcept override;
203 :
204 : /** Reset the thread's inline completion budget.
205 :
206 : Called at the start of each posted completion handler to
207 : grant a fresh budget for speculative inline completions.
208 : */
209 : void reset_inline_budget() const noexcept;
210 :
211 : /** Consume one unit of inline budget if available.
212 :
213 : @return True if budget was available and consumed.
214 : */
215 : bool try_consume_inline_budget() const noexcept;
216 :
217 : /** Offset a forthcoming work_finished from work_cleanup.
218 :
219 : Called by descriptor_state when all I/O returned EAGAIN and
220 : no handler will be executed. Must be called from a scheduler
221 : thread.
222 : */
223 : /** Note that an op was parked outside the usual registration path.
224 :
225 : A reactor that builds its poll set from parked ops must rebuild
226 : it; one the kernel tracks needs nothing.
227 : */
228 458 : virtual void notify_reparked() const {}
229 :
230 : void compensating_work_started() const noexcept;
231 :
232 : /** Post an operation whose work is already counted.
233 :
234 : The posting thread touches nothing of the scheduler after this
235 : returns, unlike a @ref post followed by @ref work_finished: once
236 : posted, the operation can complete and let its context be
237 : destroyed.
238 :
239 : @pre work_started() was called for @p op.
240 :
241 : @param op The operation to post.
242 : */
243 : void post_counted(scheduler_op* op) const;
244 :
245 : /** Post completed operations for deferred invocation.
246 :
247 : If called from a thread running this scheduler, operations
248 : go to the thread's private queue (fast path). Otherwise,
249 : operations are added to the global queue under mutex and a
250 : waiter is signaled.
251 :
252 : @pre work_started() must have been called for each operation.
253 :
254 : @param ops Queue of operations to post.
255 : */
256 : void post_deferred_completions(ready_queue& ops) const;
257 :
258 : /** Apply runtime configuration to the scheduler.
259 :
260 : Called by `io_context` after construction. Values that do
261 : not apply to this backend are silently ignored.
262 :
263 : @param max_events Event buffer size for epoll/kqueue.
264 : @param budget_init Starting inline completion budget.
265 : @param budget_max Hard ceiling on adaptive budget ramp-up.
266 : @param unassisted Budget when single-threaded.
267 : */
268 : virtual void configure_reactor(
269 : unsigned max_events,
270 : unsigned budget_init,
271 : unsigned budget_max,
272 : unsigned unassisted);
273 :
274 : /// Return the configured initial inline budget.
275 13155 : unsigned inline_budget_initial() const noexcept
276 : {
277 13155 : return inline_budget_initial_;
278 : }
279 :
280 : /// Return true when scheduler locking is disabled (fully-lockless tier).
281 1448 : bool scheduler_locking_disabled() const noexcept override
282 : {
283 1448 : return scheduler_locking_disabled_;
284 : }
285 :
286 4413 : void configure_threading(threading_config cfg) noexcept override
287 : {
288 4413 : scheduler_locking_disabled_ = !cfg.scheduler_locking;
289 : // reactor_io_locking takes effect at descriptor registration (see the
290 : // register_descriptor overrides), not here.
291 4413 : reactor_io_locking_ = cfg.reactor_io_locking;
292 4413 : one_thread_ = cfg.one_thread;
293 4413 : mutex_.set_enabled(cfg.scheduler_locking);
294 4413 : cond_.set_enabled(cfg.scheduler_locking);
295 4413 : }
296 :
297 : protected:
298 : timer_service* timer_svc_ = nullptr;
299 : bool scheduler_locking_disabled_ = false;
300 : bool reactor_io_locking_ = true;
301 : bool one_thread_ = false;
302 :
303 4425 : reactor_scheduler() = default;
304 :
305 : /// Destroy, destroying whatever was posted after the drain.
306 : ~reactor_scheduler() override;
307 :
308 : /** Drain completed_ops during shutdown.
309 :
310 : Pops all operations from the global queue and destroys them,
311 : skipping the task sentinel. Signals all waiting threads.
312 : Derived classes call this from their shutdown() override
313 : before performing platform-specific cleanup.
314 : */
315 : void shutdown_drain();
316 :
317 : /// Destroy every queued operation without running it.
318 : void destroy_queued(lock_type& lock) noexcept;
319 :
320 : /// RAII guard that re-inserts the task sentinel after `run_task`.
321 : struct task_cleanup
322 : {
323 : reactor_scheduler const* sched;
324 : lock_type* lock;
325 : context_type& ctx;
326 : ~task_cleanup();
327 : };
328 :
329 : mutable mutex_type mutex_{true};
330 : mutable event_type cond_{true};
331 : mutable ready_queue completed_ops_;
332 : mutable std::atomic<std::int64_t> outstanding_work_{0};
333 : std::atomic<bool> stopped_{false};
334 : mutable std::atomic<bool> task_running_{false};
335 : mutable bool task_interrupted_ = false;
336 :
337 : // Descriptors retired during the running reactor pass (guarded by
338 : // mutex_).
339 : mutable reactor_retirable* retired_ = nullptr;
340 :
341 : /// Settle every descriptor retired before the current pass ended.
342 : /// @pre `lock` holds `mutex_`; it is held again on return.
343 : void settle_retired(lock_type& lock) const;
344 :
345 : // Runtime-configurable reactor tuning parameters.
346 : // Defaults match the library's built-in values.
347 : unsigned max_events_per_poll_ = 128;
348 : unsigned inline_budget_initial_ = 2;
349 : unsigned inline_budget_max_ = 16;
350 : unsigned unassisted_budget_ = 4;
351 :
352 : /// Bit 0 of `state_`: set when the condvar should be signaled.
353 : static constexpr std::size_t signaled_bit = 1;
354 :
355 : /// Increment per waiting thread in `state_`.
356 : static constexpr std::size_t waiter_increment = 2;
357 : mutable std::size_t state_ = 0;
358 :
359 : /// Sentinel op that triggers a reactor poll when dequeued.
360 : struct task_op final : scheduler_op
361 : {
362 : // LCOV_EXCL_START: the sentinel is intercepted by pointer
363 : // identity; its virtuals exist for vtable completeness.
364 : void operator()() override {}
365 : void destroy() override {}
366 : // LCOV_EXCL_STOP
367 : };
368 : task_op task_op_;
369 :
370 : /** Run the platform-specific reactor poll.
371 :
372 : @par Postconditions
373 : `lock` is owned on return, however the poll ended. An
374 : implementation that unlocks around the blocking call owes the
375 : caller a matching re-acquire on every path out, including the
376 : errors it retries rather than reports.
377 : */
378 : virtual void
379 : run_task(lock_type& lock, context_type& ctx, long timeout_us) = 0;
380 :
381 : /// Wake a blocked reactor (e.g. write to eventfd or pipe).
382 : virtual void interrupt_reactor() const = 0;
383 :
384 : private:
385 : struct work_cleanup
386 : {
387 : reactor_scheduler* sched;
388 : lock_type* lock;
389 : context_type& ctx;
390 : ~work_cleanup();
391 : };
392 :
393 : std::size_t do_one(lock_type& lock, long timeout_us, context_type& ctx);
394 :
395 : void signal_all(lock_type& lock) const;
396 : bool maybe_unlock_and_signal_one(lock_type& lock) const;
397 : bool unlock_and_signal_one(lock_type& lock) const;
398 : void clear_signal() const;
399 : void wait_for_signal(lock_type& lock) const;
400 : void wait_for_signal_for(lock_type& lock, long timeout_us) const;
401 : void wake_one_thread_and_unlock(lock_type& lock) const;
402 : };
403 :
404 : /** RAII guard that pushes/pops a scheduler context frame.
405 :
406 : On construction, pushes a new context frame onto the
407 : thread-local stack. On destruction, drains any remaining
408 : private queue items to the global queue and pops the frame.
409 : */
410 : struct reactor_thread_context_guard
411 : {
412 : /// The context frame managed by this guard.
413 : reactor_scheduler_context frame_;
414 :
415 : /// Marks the scheduler innermost for the executor's fast check.
416 : running_scheduler_guard running_;
417 :
418 : /// Construct the guard, pushing a frame for @a sched.
419 13155 : explicit reactor_thread_context_guard(
420 : reactor_scheduler const* sched) noexcept
421 13155 : : frame_(sched, reactor_context_stack.get())
422 13155 : , running_(sched)
423 : {
424 13155 : reactor_context_stack.set(&frame_);
425 13155 : }
426 :
427 : /** Destroy the guard, popping the frame.
428 :
429 : The private queue is empty here by invariant: work_cleanup and
430 : task_cleanup splice it to the global queue after every handler
431 : and every reactor pass.
432 : */
433 13155 : ~reactor_thread_context_guard() noexcept
434 : {
435 13155 : reactor_context_stack.set(frame_.next);
436 13155 : }
437 : };
438 :
439 : // ---- Inline implementations ------------------------------------------------
440 :
441 13155 : inline reactor_scheduler_context::reactor_scheduler_context(
442 13155 : reactor_scheduler const* k, reactor_scheduler_context* n)
443 13155 : : key(k)
444 13155 : , next(n)
445 13155 : , private_outstanding_work(0)
446 13155 : , inline_budget(0)
447 13155 : , inline_budget_max(static_cast<int>(k->inline_budget_initial()))
448 13155 : , unassisted(false)
449 : {
450 13155 : }
451 :
452 : inline void
453 54 : reactor_scheduler::configure_reactor(
454 : unsigned max_events,
455 : unsigned budget_init,
456 : unsigned budget_max,
457 : unsigned unassisted)
458 : {
459 106 : if (max_events < 1 ||
460 52 : max_events > static_cast<unsigned>(std::numeric_limits<int>::max()))
461 2 : throw std::out_of_range("max_events_per_poll must be in [1, INT_MAX]");
462 52 : if (budget_max > static_cast<unsigned>(std::numeric_limits<int>::max()))
463 2 : throw std::out_of_range("inline_budget_max must be in [0, INT_MAX]");
464 :
465 : // Clamp initial and unassisted to budget_max.
466 50 : if (budget_init > budget_max)
467 20 : budget_init = budget_max;
468 50 : if (unassisted > budget_max)
469 20 : unassisted = budget_max;
470 :
471 50 : max_events_per_poll_ = max_events;
472 50 : inline_budget_initial_ = budget_init;
473 50 : inline_budget_max_ = budget_max;
474 50 : unassisted_budget_ = unassisted;
475 50 : }
476 :
477 : inline void
478 111330 : reactor_scheduler::reset_inline_budget() const noexcept
479 : {
480 : // When budget is disabled (max==0), all paths below would no-op
481 : // (inline_budget stays 0). Skip the TLS lookup entirely.
482 111330 : if (inline_budget_max_ == 0)
483 58 : return;
484 111272 : if (auto* ctx = reactor_find_context(this))
485 : {
486 : // Cap when no other thread absorbed queued work
487 111272 : if (ctx->unassisted)
488 : {
489 110162 : ctx->inline_budget_max = static_cast<int>(unassisted_budget_);
490 110162 : ctx->inline_budget = static_cast<int>(unassisted_budget_);
491 110162 : return;
492 : }
493 : // Ramp up when previous cycle fully consumed budget.
494 : // max(1, ...) ensures the doubling escapes zero.
495 1110 : if (ctx->inline_budget == 0)
496 330 : ctx->inline_budget_max =
497 330 : (std::min)((std::max)(1, ctx->inline_budget_max) * 2,
498 660 : static_cast<int>(inline_budget_max_));
499 780 : else if (ctx->inline_budget < ctx->inline_budget_max)
500 245 : ctx->inline_budget_max = static_cast<int>(inline_budget_initial_);
501 1110 : ctx->inline_budget = ctx->inline_budget_max;
502 : }
503 : }
504 :
505 : inline bool
506 472848 : reactor_scheduler::try_consume_inline_budget() const noexcept
507 : {
508 472848 : if (inline_budget_max_ == 0)
509 44 : return false;
510 472804 : if (auto* ctx = reactor_find_context(this))
511 : {
512 472786 : if (ctx->inline_budget > 0)
513 : {
514 377932 : --ctx->inline_budget;
515 377932 : return true;
516 : }
517 : }
518 94872 : return false;
519 : }
520 :
521 : inline void
522 3672 : reactor_scheduler::post(std::coroutine_handle<> h) const
523 : {
524 : struct post_handler final : scheduler_op
525 : {
526 : std::coroutine_handle<> h_;
527 :
528 3672 : explicit post_handler(std::coroutine_handle<> h) : h_(h) {}
529 7344 : ~post_handler() override = default;
530 :
531 3656 : void operator()() override
532 : {
533 3656 : auto saved = h_;
534 3656 : delete this;
535 3656 : saved.resume();
536 3656 : }
537 :
538 16 : void destroy() override
539 : {
540 : // A bare handle carries no owner to unwind from: it is
541 : // destroyed directly.
542 16 : auto saved = h_;
543 16 : delete this;
544 16 : saved.destroy();
545 16 : }
546 : };
547 :
548 3672 : auto ph = std::make_unique<post_handler>(h);
549 :
550 3672 : if (auto* ctx = reactor_find_context(this))
551 : {
552 8 : ++ctx->private_outstanding_work;
553 8 : ctx->private_queue.push(ph.release());
554 8 : return;
555 : }
556 :
557 3664 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
558 :
559 3664 : lock_type lock(mutex_);
560 3664 : completed_ops_.push(ph.release());
561 3664 : wake_one_thread_and_unlock(lock);
562 3672 : }
563 :
564 : inline void
565 119742 : reactor_scheduler::post(scheduler_op* h) const
566 : {
567 119742 : if (auto* ctx = reactor_find_context(this))
568 : {
569 117685 : ++ctx->private_outstanding_work;
570 117685 : ctx->private_queue.push(h);
571 117685 : return;
572 : }
573 :
574 2057 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
575 :
576 2057 : lock_type lock(mutex_);
577 2057 : completed_ops_.push(h);
578 2057 : wake_one_thread_and_unlock(lock);
579 2057 : }
580 :
581 : inline void
582 252861 : reactor_scheduler::post(capy::continuation& c) const
583 : {
584 252861 : if (auto* ctx = reactor_find_context(this))
585 : {
586 220651 : ++ctx->private_outstanding_work;
587 220651 : ctx->private_queue.push(c);
588 220651 : return;
589 : }
590 :
591 32210 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
592 :
593 32210 : lock_type lock(mutex_);
594 32210 : completed_ops_.push(c);
595 32210 : wake_one_thread_and_unlock(lock);
596 32210 : }
597 :
598 : inline bool
599 23757 : reactor_scheduler::running_in_this_thread() const noexcept
600 : {
601 23757 : return reactor_find_context(this) != nullptr;
602 : }
603 :
604 : inline void
605 8364 : reactor_scheduler::stop()
606 : {
607 8364 : lock_type lock(mutex_);
608 8364 : if (!stopped_.load(std::memory_order_acquire))
609 : {
610 7368 : stopped_.store(true, std::memory_order_release);
611 7368 : signal_all(lock);
612 7368 : interrupt_reactor();
613 : }
614 8364 : }
615 :
616 : inline bool
617 3552 : reactor_scheduler::stopped() const noexcept
618 : {
619 3552 : return stopped_.load(std::memory_order_acquire);
620 : }
621 :
622 : inline void
623 5766 : reactor_scheduler::restart()
624 : {
625 5766 : stopped_.store(false, std::memory_order_release);
626 5766 : }
627 :
628 : inline std::size_t
629 6542 : reactor_scheduler::run()
630 : {
631 13084 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
632 : {
633 238 : stop();
634 238 : return 0;
635 : }
636 :
637 6304 : reactor_thread_context_guard ctx(this);
638 6304 : lock_type lock(mutex_);
639 :
640 6304 : std::size_t n = 0;
641 : for (;;)
642 : {
643 418815 : if (!do_one(lock, -1, ctx.frame_))
644 6301 : break;
645 412511 : if (n != (std::numeric_limits<std::size_t>::max)())
646 412511 : ++n;
647 412511 : if (!lock.owns_lock())
648 93067 : lock.lock();
649 : }
650 6301 : return n;
651 6307 : }
652 :
653 : inline std::size_t
654 130 : reactor_scheduler::run_one()
655 : {
656 260 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
657 : {
658 3 : stop();
659 3 : return 0;
660 : }
661 :
662 127 : reactor_thread_context_guard ctx(this);
663 127 : lock_type lock(mutex_);
664 127 : return do_one(lock, -1, ctx.frame_);
665 127 : }
666 :
667 : inline std::size_t
668 6158 : reactor_scheduler::wait_one(long usec)
669 : {
670 12316 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
671 : {
672 785 : stop();
673 785 : return 0;
674 : }
675 :
676 5373 : reactor_thread_context_guard ctx(this);
677 5373 : lock_type lock(mutex_);
678 5373 : return do_one(lock, usec, ctx.frame_);
679 5373 : }
680 :
681 : inline std::size_t
682 1327 : reactor_scheduler::poll()
683 : {
684 2654 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
685 : {
686 29 : stop();
687 29 : return 0;
688 : }
689 :
690 1298 : reactor_thread_context_guard ctx(this);
691 1298 : lock_type lock(mutex_);
692 :
693 1298 : std::size_t n = 0;
694 : for (;;)
695 : {
696 9275 : if (!do_one(lock, 0, ctx.frame_))
697 1298 : break;
698 7977 : if (n != (std::numeric_limits<std::size_t>::max)())
699 7977 : ++n;
700 7977 : if (!lock.owns_lock())
701 7975 : lock.lock();
702 : }
703 1298 : return n;
704 1298 : }
705 :
706 : inline std::size_t
707 58 : reactor_scheduler::poll_one()
708 : {
709 116 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
710 : {
711 5 : stop();
712 5 : return 0;
713 : }
714 :
715 53 : reactor_thread_context_guard ctx(this);
716 53 : lock_type lock(mutex_);
717 53 : return do_one(lock, 0, ctx.frame_);
718 53 : }
719 :
720 : inline void
721 67648 : reactor_scheduler::work_started() noexcept
722 : {
723 67648 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
724 67648 : }
725 :
726 : inline void
727 113181 : reactor_scheduler::work_finished() noexcept
728 : {
729 226362 : if (outstanding_work_.fetch_sub(1, std::memory_order_acq_rel) == 1)
730 7239 : stop();
731 113181 : }
732 :
733 : inline void
734 39099 : reactor_scheduler::compensating_work_started() const noexcept
735 : {
736 39099 : auto* ctx = reactor_find_context(this);
737 39099 : if (ctx)
738 39097 : ++ctx->private_outstanding_work;
739 39099 : }
740 :
741 : inline void
742 1972 : reactor_scheduler::post_counted(scheduler_op* op) const
743 : {
744 1972 : if (auto* ctx = reactor_find_context(this))
745 : {
746 605 : ctx->private_queue.push(op);
747 605 : return;
748 : }
749 :
750 1367 : lock_type lock(mutex_);
751 1367 : completed_ops_.push(op);
752 1367 : wake_one_thread_and_unlock(lock);
753 1367 : }
754 :
755 : inline void
756 16057 : reactor_scheduler::post_deferred_completions(ready_queue& ops) const
757 : {
758 16057 : if (ops.empty())
759 16057 : return;
760 :
761 2 : if (auto* ctx = reactor_find_context(this))
762 : {
763 2 : ctx->private_queue.splice(ops);
764 2 : return;
765 : }
766 :
767 MIS 0 : lock_type lock(mutex_);
768 0 : completed_ops_.splice(ops);
769 0 : wake_one_thread_and_unlock(lock);
770 0 : }
771 :
772 : inline void
773 HIT 22999 : reactor_scheduler::retire_descriptor(
774 : reactor_retirable& d, object_ref keep) const
775 : {
776 22999 : lock_type lock(mutex_);
777 22999 : if (!task_running_.load(std::memory_order_relaxed))
778 : {
779 : // No pass can hold an event, but an earlier one may have
780 : // queued d.
781 17625 : d.hand_off(keep);
782 17625 : return;
783 : }
784 : // Already parked for this pass: the held reference suffices.
785 5374 : if (d.retired_ref_)
786 7 : return;
787 5367 : d.retired_ref_ = std::move(keep);
788 5367 : d.retired_next_ = retired_;
789 5367 : retired_ = &d;
790 22999 : }
791 :
792 : inline void
793 369989 : reactor_scheduler::settle_retired(lock_type& lock) const
794 : {
795 : // Handed off under the lock, since a later pass may retire the same
796 : // descriptor again as soon as it is released. A reference that is
797 : // not handed off may be the owner's last, and its release recycles
798 : // through the pool mutex, so it is dropped with the lock released.
799 369989 : reactor_retirable* dropped = nullptr;
800 375356 : while (auto* d = retired_)
801 : {
802 5367 : retired_ = d->retired_next_;
803 5367 : d->retired_next_ = nullptr;
804 5367 : auto keep = std::move(d->retired_ref_);
805 5367 : d->hand_off(keep);
806 : // A drop already pending keeps the owner alive, so this one
807 : // cannot be the last and is released here.
808 5367 : if (!keep || d->dropped_ref_)
809 511 : continue;
810 4856 : d->dropped_ref_ = std::move(keep);
811 4856 : d->dropped_next_ = dropped;
812 4856 : dropped = d;
813 10734 : }
814 374845 : while (auto* d = dropped)
815 : {
816 4856 : dropped = d->dropped_next_;
817 4856 : d->dropped_next_ = nullptr;
818 4856 : auto keep = std::move(d->dropped_ref_);
819 4856 : lock.unlock();
820 4856 : keep.reset();
821 4856 : lock.lock();
822 4856 : }
823 369989 : }
824 :
825 : inline void
826 4413 : reactor_scheduler::shutdown_drain()
827 : {
828 : // This scheduler's constructor registered the timer service, so
829 : // the context shuts it down later; its waiters' frames must be
830 : // destroyed before the drain, which then destroys whatever their
831 : // destructors post. The context's own call later finds no waiter.
832 4413 : if (timer_svc_)
833 4413 : timer_svc_->shutdown();
834 :
835 4413 : wait_cancels_posting();
836 :
837 4413 : lock_type lock(mutex_);
838 4413 : settle_retired(lock);
839 4413 : destroy_queued(lock);
840 4413 : signal_all(lock);
841 4413 : }
842 :
843 4425 : inline reactor_scheduler::~reactor_scheduler()
844 : {
845 : // Service destructors run after the drain and may still post.
846 4425 : lock_type lock(mutex_);
847 4425 : destroy_queued(lock);
848 4425 : }
849 :
850 : inline void
851 8838 : reactor_scheduler::destroy_queued(lock_type& lock) noexcept
852 : {
853 22593 : while (auto e = completed_ops_.pop())
854 : {
855 13755 : if (ready_is_continuation(e))
856 : {
857 7808 : lock.unlock();
858 7808 : if (auto* c = ready_as_cont(e); c->h)
859 7808 : capy::abandon(*c);
860 7808 : lock.lock();
861 : }
862 : else
863 : {
864 5947 : auto* op = ready_as_op(e);
865 5947 : if (op == &task_op_)
866 4410 : continue;
867 1537 : lock.unlock();
868 1537 : op->destroy();
869 1537 : lock.lock();
870 : }
871 13755 : }
872 8838 : }
873 :
874 : inline void
875 11781 : reactor_scheduler::signal_all(lock_type&) const
876 : {
877 11781 : state_ |= signaled_bit;
878 11781 : cond_.notify_all();
879 11781 : }
880 :
881 : inline bool
882 39298 : reactor_scheduler::maybe_unlock_and_signal_one(lock_type& lock) const
883 : {
884 39298 : state_ |= signaled_bit;
885 39298 : if (state_ > signaled_bit)
886 : {
887 : // Signalled before unlocking: a post from another context's
888 : // thread may be the last touch of this scheduler before the
889 : // posted work runs, finishes and lets it be destroyed.
890 215 : cond_.notify_one();
891 215 : lock.unlock();
892 215 : return true;
893 : }
894 39083 : return false;
895 : }
896 :
897 : inline bool
898 686818 : reactor_scheduler::unlock_and_signal_one(lock_type& lock) const
899 : {
900 686818 : state_ |= signaled_bit;
901 686818 : bool have_waiters = state_ > signaled_bit;
902 686818 : lock.unlock();
903 686818 : if (have_waiters)
904 4769 : cond_.notify_one();
905 686818 : return have_waiters;
906 : }
907 :
908 : inline void
909 841 : reactor_scheduler::clear_signal() const
910 : {
911 841 : state_ &= ~signaled_bit;
912 841 : }
913 :
914 : inline void
915 831 : reactor_scheduler::wait_for_signal(lock_type& lock) const
916 : {
917 1747 : while ((state_ & signaled_bit) == 0)
918 : {
919 916 : state_ += waiter_increment;
920 916 : cond_.wait(lock);
921 916 : state_ -= waiter_increment;
922 : }
923 831 : }
924 :
925 : inline void
926 10 : reactor_scheduler::wait_for_signal_for(lock_type& lock, long timeout_us) const
927 : {
928 10 : if ((state_ & signaled_bit) == 0)
929 : {
930 10 : state_ += waiter_increment;
931 10 : cond_.wait_for(lock, std::chrono::microseconds(timeout_us));
932 10 : state_ -= waiter_increment;
933 : }
934 10 : }
935 :
936 : inline void
937 39298 : reactor_scheduler::wake_one_thread_and_unlock(lock_type& lock) const
938 : {
939 39298 : if (maybe_unlock_and_signal_one(lock))
940 215 : return;
941 :
942 39083 : if (task_running_.load(std::memory_order_relaxed) && !task_interrupted_)
943 : {
944 1614 : task_interrupted_ = true;
945 : // Under the lock, for the same reason as the signal above.
946 1614 : interrupt_reactor();
947 1614 : lock.unlock();
948 : }
949 : else
950 : {
951 37469 : lock.unlock();
952 : }
953 : }
954 :
955 423346 : inline reactor_scheduler::work_cleanup::~work_cleanup()
956 : {
957 423346 : std::int64_t produced = ctx.private_outstanding_work;
958 423346 : if (produced > 1)
959 1011 : sched->outstanding_work_.fetch_add(
960 : produced - 1, std::memory_order_relaxed);
961 422335 : else if (produced < 1)
962 65834 : sched->work_finished();
963 423346 : ctx.private_outstanding_work = 0;
964 :
965 423346 : if (!ctx.private_queue.empty())
966 : {
967 319757 : lock->lock();
968 319757 : sched->completed_ops_.splice(ctx.private_queue);
969 : }
970 423346 : }
971 :
972 365579 : inline reactor_scheduler::task_cleanup::~task_cleanup()
973 : {
974 365579 : if (ctx.private_outstanding_work > 0)
975 : {
976 10592 : sched->outstanding_work_.fetch_add(
977 10592 : ctx.private_outstanding_work, std::memory_order_relaxed);
978 10592 : ctx.private_outstanding_work = 0;
979 : }
980 :
981 365579 : if (!ctx.private_queue.empty())
982 : {
983 10592 : if (!lock->owns_lock())
984 MIS 0 : lock->lock();
985 HIT 10592 : sched->completed_ops_.splice(ctx.private_queue);
986 : }
987 365579 : }
988 :
989 : inline std::size_t
990 433643 : reactor_scheduler::do_one(lock_type& lock, long timeout_us, context_type& ctx)
991 : {
992 : for (;;)
993 : {
994 797367 : if (stopped_.load(std::memory_order_acquire))
995 6470 : return 0;
996 :
997 790897 : std::uintptr_t e = completed_ops_.pop();
998 790897 : scheduler_op* op = ready_is_continuation(e) ? nullptr : ready_as_op(e);
999 :
1000 : // Handle reactor sentinel — time to poll for I/O
1001 790897 : if (op == &task_op_)
1002 : {
1003 366710 : bool more_handlers = !completed_ops_.empty();
1004 :
1005 468053 : if (!more_handlers &&
1006 202686 : (outstanding_work_.load(std::memory_order_acquire) == 0 ||
1007 : timeout_us == 0))
1008 : {
1009 1131 : completed_ops_.push(&task_op_);
1010 1131 : return 0;
1011 : }
1012 :
1013 365579 : long task_timeout_us = more_handlers ? 0 : timeout_us;
1014 365579 : task_interrupted_ = task_timeout_us == 0;
1015 365579 : task_running_.store(true, std::memory_order_release);
1016 :
1017 : // Wake a peer to take the pending handlers while this thread
1018 : // polls the reactor; skipped when one_thread_ (no peer exists).
1019 365579 : if (more_handlers && !one_thread_)
1020 265356 : unlock_and_signal_one(lock);
1021 :
1022 : try
1023 : {
1024 365579 : run_task(lock, ctx, task_timeout_us);
1025 : }
1026 3 : catch (...)
1027 : {
1028 3 : task_running_.store(false, std::memory_order_relaxed);
1029 3 : throw;
1030 3 : }
1031 :
1032 365576 : task_running_.store(false, std::memory_order_relaxed);
1033 365576 : completed_ops_.push(&task_op_);
1034 365576 : settle_retired(lock);
1035 365576 : if (timeout_us > 0)
1036 2693 : return 0;
1037 362883 : continue;
1038 362883 : }
1039 :
1040 : // Handle ready entry (op or continuation)
1041 424187 : if (e != 0)
1042 : {
1043 423346 : bool more = !completed_ops_.empty();
1044 :
1045 423346 : if (more && !one_thread_)
1046 : {
1047 : // Wake a peer for the remaining work; unassisted if none
1048 : // was parked to take it.
1049 421462 : ctx.unassisted = !unlock_and_signal_one(lock);
1050 : }
1051 : else
1052 : {
1053 : // No peer to wake (one_thread_, or nothing more queued).
1054 1884 : ctx.unassisted = more;
1055 1884 : lock.unlock();
1056 : }
1057 :
1058 423346 : [[maybe_unused]] work_cleanup on_exit{this, &lock, ctx};
1059 :
1060 423346 : if (ready_is_continuation(e))
1061 245053 : ready_as_cont(e)->h.resume();
1062 : else
1063 178293 : (*op)();
1064 423346 : return 1;
1065 423346 : }
1066 :
1067 1682 : if (outstanding_work_.load(std::memory_order_acquire) == 0 ||
1068 : timeout_us == 0)
1069 MIS 0 : return 0;
1070 :
1071 HIT 841 : clear_signal();
1072 841 : if (timeout_us < 0)
1073 831 : wait_for_signal(lock);
1074 : else
1075 10 : wait_for_signal_for(lock, timeout_us);
1076 363724 : }
1077 : }
1078 :
1079 : } // namespace boost::corosio::detail
1080 :
1081 : #endif // BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SCHEDULER_HPP
|
