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 :
32 : #include <boost/corosio/detail/conditionally_enabled_mutex.hpp>
33 : #include <boost/corosio/detail/conditionally_enabled_event.hpp>
34 :
35 : namespace boost::corosio::detail {
36 :
37 : // Forward declarations
38 : class reactor_scheduler;
39 :
40 : /** A deregistered descriptor whose owner must outlive the reactor pass
41 : that may still hold it.
42 :
43 : An event the reactor has already read from the kernel can name a
44 : descriptor that another thread closes before the reactor queues it.
45 : The closing thread hands over a reference instead of dropping it, so
46 : the owner is neither freed nor recycled until that pass ends.
47 : */
48 : struct reactor_retirable
49 : {
50 : // All four fields are guarded by the scheduler's mutex.
51 :
52 : /// Next in the scheduler's retired list.
53 : reactor_retirable* retired_next_ = nullptr;
54 :
55 : /// Owner reference held until the pass ends.
56 : object_ref retired_ref_;
57 :
58 : /// Next in a settling thread's list of references to drop.
59 : reactor_retirable* dropped_next_ = nullptr;
60 :
61 : /// Owner reference waiting to be dropped outside the mutex.
62 : object_ref dropped_ref_;
63 :
64 : /// Move @p keep into a queued completion, if one is pending.
65 : virtual void hand_off(object_ref& keep) noexcept = 0;
66 :
67 : protected:
68 HIT 12273 : ~reactor_retirable() = default;
69 : };
70 :
71 : /** Per-thread state for a reactor scheduler.
72 :
73 : Each thread running a scheduler's event loop has one of these
74 : on a thread-local stack. It holds a private work queue and
75 : inline completion budget for speculative I/O fast paths.
76 : */
77 : struct BOOST_COROSIO_SYMBOL_VISIBLE reactor_scheduler_context
78 : {
79 : /// Scheduler this context belongs to.
80 : reactor_scheduler const* key;
81 :
82 : /// Next context frame on this thread's stack.
83 : reactor_scheduler_context* next;
84 :
85 : /// Private work queue for reduced contention.
86 : ready_queue private_queue;
87 :
88 : /// Unflushed work count for the private queue.
89 : std::int64_t private_outstanding_work;
90 :
91 : /// Remaining inline completions allowed this cycle.
92 : int inline_budget;
93 :
94 : /// Maximum inline budget (adaptive, 2-16).
95 : int inline_budget_max;
96 :
97 : /// True if no other thread absorbed queued work last cycle.
98 : bool unassisted;
99 :
100 : /// Construct a context frame linked to @a n.
101 : reactor_scheduler_context(
102 : reactor_scheduler const* k, reactor_scheduler_context* n);
103 : };
104 :
105 : /// Thread-local context stack for reactor schedulers.
106 : inline thread_local_ptr<reactor_scheduler_context> reactor_context_stack;
107 :
108 : /// Find the context frame for a scheduler on this thread.
109 : inline reactor_scheduler_context*
110 968564 : reactor_find_context(reactor_scheduler const* self) noexcept
111 : {
112 969176 : for (auto* c = reactor_context_stack.get(); c != nullptr; c = c->next)
113 : {
114 906194 : if (c->key == self)
115 905582 : return c;
116 : }
117 62982 : return nullptr;
118 : }
119 :
120 : /** Non-template base for reactor-backed scheduler implementations.
121 :
122 : Provides the complete threading model shared by epoll, kqueue,
123 : and select schedulers: signal state machine, inline completion
124 : budget, work counting, run/poll methods, and the do_one event
125 : loop.
126 :
127 : Derived classes provide platform-specific hooks by overriding:
128 : - `run_task(lock, ctx)` to run the reactor poll
129 : - `interrupt_reactor()` to wake a blocked reactor
130 :
131 : De-templated from the original CRTP design to eliminate
132 : duplicate instantiations when multiple backends are compiled
133 : into the same binary. Virtual dispatch for run_task (called
134 : once per reactor cycle, before a blocking syscall) has
135 : negligible overhead.
136 :
137 : @par Thread Safety
138 : All public member functions are thread-safe.
139 : */
140 : class reactor_scheduler : public scheduler
141 : {
142 : public:
143 : using context_type = reactor_scheduler_context;
144 : using mutex_type = conditionally_enabled_mutex;
145 : using lock_type = mutex_type::scoped_lock;
146 : using event_type = conditionally_enabled_event;
147 :
148 : /// Post a coroutine for deferred execution.
149 : void post(std::coroutine_handle<> h) const override;
150 :
151 : /// Post a scheduler operation for deferred execution.
152 : void post(scheduler_op* h) const override;
153 :
154 : /** Release an owner reference once no reactor pass can hold `d`.
155 :
156 : Called after a descriptor is deregistered. If a reactor pass is
157 : running, `keep` is parked on `d` until that pass ends. Then, or
158 : at once if no pass is running, it moves to `d`'s queued
159 : invocation if `d` is queued, and is dropped otherwise.
160 :
161 : @param d The deregistered descriptor.
162 : @param keep A reference to the descriptor's owner.
163 : */
164 : void retire_descriptor(reactor_retirable& d, object_ref keep) const;
165 :
166 : /// Post a continuation for deferred execution.
167 : void post(capy::continuation&) const override;
168 :
169 : /// Return true if called from a thread running this scheduler.
170 : bool running_in_this_thread() const noexcept override;
171 :
172 : /// Request the scheduler to stop dispatching handlers.
173 : void stop() override;
174 :
175 : /// Return true if the scheduler has been stopped.
176 : bool stopped() const noexcept override;
177 :
178 : /// Reset the stopped state so `run()` can resume.
179 : void restart() override;
180 :
181 : /// Run the event loop until no work remains.
182 : std::size_t run() override;
183 :
184 : /// Run until one handler completes or no work remains.
185 : std::size_t run_one() override;
186 :
187 : /// Run until one handler completes or @a usec elapses.
188 : std::size_t wait_one(long usec) override;
189 :
190 : /// Run ready handlers without blocking.
191 : std::size_t poll() override;
192 :
193 : /// Run at most one ready handler without blocking.
194 : std::size_t poll_one() override;
195 :
196 : /// Increment the outstanding work count.
197 : void work_started() noexcept override;
198 :
199 : /// Decrement the outstanding work count, stopping on zero.
200 : void work_finished() noexcept override;
201 :
202 : /** Reset the thread's inline completion budget.
203 :
204 : Called at the start of each posted completion handler to
205 : grant a fresh budget for speculative inline completions.
206 : */
207 : void reset_inline_budget() const noexcept;
208 :
209 : /** Consume one unit of inline budget if available.
210 :
211 : @return True if budget was available and consumed.
212 : */
213 : bool try_consume_inline_budget() const noexcept;
214 :
215 : /** Offset a forthcoming work_finished from work_cleanup.
216 :
217 : Called by descriptor_state when all I/O returned EAGAIN and
218 : no handler will be executed. Must be called from a scheduler
219 : thread.
220 : */
221 : /** Note that an op was parked outside the usual registration path.
222 :
223 : A reactor that builds its poll set from parked ops must rebuild
224 : it; one the kernel tracks needs nothing.
225 : */
226 439 : virtual void notify_reparked() const {}
227 :
228 : void compensating_work_started() const noexcept;
229 :
230 : /** Post an operation whose work is already counted.
231 :
232 : The posting thread touches nothing of the scheduler after this
233 : returns, unlike a @ref post followed by @ref work_finished: once
234 : posted, the operation can complete and let its context be
235 : destroyed.
236 :
237 : @pre work_started() was called for @p op.
238 :
239 : @param op The operation to post.
240 : */
241 : void post_counted(scheduler_op* op) const;
242 :
243 : /** Post completed operations for deferred invocation.
244 :
245 : If called from a thread running this scheduler, operations
246 : go to the thread's private queue (fast path). Otherwise,
247 : operations are added to the global queue under mutex and a
248 : waiter is signaled.
249 :
250 : @pre work_started() must have been called for each operation.
251 :
252 : @param ops Queue of operations to post.
253 : */
254 : void post_deferred_completions(ready_queue& ops) const;
255 :
256 : /** Apply runtime configuration to the scheduler.
257 :
258 : Called by `io_context` after construction. Values that do
259 : not apply to this backend are silently ignored.
260 :
261 : @pre `max_events` is in [ 1, `INT_MAX` ] and `budget_max` is at
262 : most `INT_MAX`; `io_context` validates both.
263 :
264 : @param max_events Event buffer size for epoll/kqueue.
265 : @param budget_init Starting inline completion budget.
266 : @param budget_max Hard ceiling on adaptive budget ramp-up.
267 : @param unassisted Budget when single-threaded.
268 : */
269 : virtual void configure_reactor(
270 : unsigned max_events,
271 : unsigned budget_init,
272 : unsigned budget_max,
273 : unsigned unassisted);
274 :
275 : /// Return the configured initial inline budget.
276 13205 : unsigned inline_budget_initial() const noexcept
277 : {
278 13205 : return inline_budget_initial_;
279 : }
280 :
281 : /// Return true when scheduler locking is disabled (fully-lockless tier).
282 1460 : bool scheduler_locking_disabled() const noexcept override
283 : {
284 1460 : return scheduler_locking_disabled_;
285 : }
286 :
287 4498 : void configure_threading(threading_config cfg) noexcept override
288 : {
289 4498 : scheduler_locking_disabled_ = !cfg.scheduler_locking;
290 : // reactor_io_locking takes effect at descriptor registration (see the
291 : // register_descriptor overrides), not here.
292 4498 : reactor_io_locking_ = cfg.reactor_io_locking;
293 4498 : one_thread_ = cfg.one_thread;
294 4498 : mutex_.set_enabled(cfg.scheduler_locking);
295 4498 : cond_.set_enabled(cfg.scheduler_locking);
296 4498 : }
297 :
298 : protected:
299 : bool scheduler_locking_disabled_ = false;
300 : bool reactor_io_locking_ = true;
301 : bool one_thread_ = false;
302 :
303 4514 : 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 : /// Wake the reactor whenever the earliest timer changes.
385 : void on_timer_service_attached(timer_service& svc) override;
386 :
387 : private:
388 : struct work_cleanup
389 : {
390 : reactor_scheduler* sched;
391 : lock_type* lock;
392 : context_type& ctx;
393 : ~work_cleanup();
394 : };
395 :
396 : std::size_t do_one(lock_type& lock, long timeout_us, context_type& ctx);
397 :
398 : void signal_all(lock_type& lock) const;
399 : bool maybe_unlock_and_signal_one(lock_type& lock) const;
400 : bool unlock_and_signal_one(lock_type& lock) const;
401 : void clear_signal() const;
402 : void wait_for_signal(lock_type& lock) const;
403 : void wait_for_signal_for(lock_type& lock, long timeout_us) const;
404 : void wake_one_thread_and_unlock(lock_type& lock) const;
405 : };
406 :
407 : /** RAII guard that pushes/pops a scheduler context frame.
408 :
409 : On construction, pushes a new context frame onto the
410 : thread-local stack. On destruction, drains any remaining
411 : private queue items to the global queue and pops the frame.
412 : */
413 : struct reactor_thread_context_guard
414 : {
415 : /// The context frame managed by this guard.
416 : reactor_scheduler_context frame_;
417 :
418 : /// Marks the scheduler innermost for the executor's fast check.
419 : running_scheduler_guard running_;
420 :
421 : /// Construct the guard, pushing a frame for @a sched.
422 13205 : explicit reactor_thread_context_guard(
423 : reactor_scheduler const* sched) noexcept
424 13205 : : frame_(sched, reactor_context_stack.get())
425 13205 : , running_(sched)
426 : {
427 13205 : reactor_context_stack.set(&frame_);
428 13205 : }
429 :
430 : /** Destroy the guard, popping the frame.
431 :
432 : The private queue is empty here by invariant: work_cleanup and
433 : task_cleanup splice it to the global queue after every handler
434 : and every reactor pass.
435 : */
436 13205 : ~reactor_thread_context_guard() noexcept
437 : {
438 13205 : reactor_context_stack.set(frame_.next);
439 13205 : }
440 : };
441 :
442 : // ---- Inline implementations ------------------------------------------------
443 :
444 13205 : inline reactor_scheduler_context::reactor_scheduler_context(
445 13205 : reactor_scheduler const* k, reactor_scheduler_context* n)
446 13205 : : key(k)
447 13205 : , next(n)
448 13205 : , private_outstanding_work(0)
449 13205 : , inline_budget(0)
450 13205 : , inline_budget_max(static_cast<int>(k->inline_budget_initial()))
451 13205 : , unassisted(false)
452 : {
453 13205 : }
454 :
455 : inline void
456 50 : reactor_scheduler::configure_reactor(
457 : unsigned max_events,
458 : unsigned budget_init,
459 : unsigned budget_max,
460 : unsigned unassisted)
461 : {
462 50 : BOOST_COROSIO_ASSERT(
463 : max_events >= 1 &&
464 : max_events <= static_cast<unsigned>((std::numeric_limits<int>::max)()));
465 50 : BOOST_COROSIO_ASSERT(
466 : budget_max <= static_cast<unsigned>((std::numeric_limits<int>::max)()));
467 :
468 : // Clamp initial and unassisted to budget_max.
469 50 : if (budget_init > budget_max)
470 20 : budget_init = budget_max;
471 50 : if (unassisted > budget_max)
472 20 : unassisted = budget_max;
473 :
474 50 : max_events_per_poll_ = max_events;
475 50 : inline_budget_initial_ = budget_init;
476 50 : inline_budget_max_ = budget_max;
477 50 : unassisted_budget_ = unassisted;
478 50 : }
479 :
480 : inline void
481 106062 : reactor_scheduler::reset_inline_budget() const noexcept
482 : {
483 : // When budget is disabled (max==0), all paths below would no-op
484 : // (inline_budget stays 0). Skip the TLS lookup entirely.
485 106062 : if (inline_budget_max_ == 0)
486 58 : return;
487 106004 : if (auto* ctx = reactor_find_context(this))
488 : {
489 : // Cap when no other thread absorbed queued work
490 106004 : if (ctx->unassisted)
491 : {
492 104995 : ctx->inline_budget_max = static_cast<int>(unassisted_budget_);
493 104995 : ctx->inline_budget = static_cast<int>(unassisted_budget_);
494 104995 : return;
495 : }
496 : // Ramp up when previous cycle fully consumed budget.
497 : // max(1, ...) ensures the doubling escapes zero.
498 : // Doubled in a wider type: the cap may be as large as INT_MAX.
499 1009 : if (ctx->inline_budget == 0)
500 : {
501 : long long const doubled =
502 305 : 2LL * (std::max)(1, ctx->inline_budget_max);
503 305 : long long const cap = inline_budget_max_;
504 305 : ctx->inline_budget_max = static_cast<int>((std::min)(doubled, cap));
505 : }
506 704 : else if (ctx->inline_budget < ctx->inline_budget_max)
507 : {
508 240 : ctx->inline_budget_max = static_cast<int>(inline_budget_initial_);
509 : }
510 1009 : ctx->inline_budget = ctx->inline_budget_max;
511 : }
512 : }
513 :
514 : inline bool
515 446389 : reactor_scheduler::try_consume_inline_budget() const noexcept
516 : {
517 446389 : if (inline_budget_max_ == 0)
518 44 : return false;
519 446345 : if (auto* ctx = reactor_find_context(this))
520 : {
521 446312 : if (ctx->inline_budget > 0)
522 : {
523 356758 : --ctx->inline_budget;
524 356758 : return true;
525 : }
526 : }
527 89587 : return false;
528 : }
529 :
530 : inline void
531 3672 : reactor_scheduler::post(std::coroutine_handle<> h) const
532 : {
533 : struct post_handler final : scheduler_op
534 : {
535 : std::coroutine_handle<> h_;
536 :
537 3672 : explicit post_handler(std::coroutine_handle<> h) : h_(h) {}
538 7344 : ~post_handler() override = default;
539 :
540 3656 : void operator()() override
541 : {
542 3656 : auto saved = h_;
543 3656 : delete this;
544 3656 : saved.resume();
545 3656 : }
546 :
547 16 : void destroy() override
548 : {
549 : // A bare handle carries no owner to unwind from: it is
550 : // destroyed directly.
551 16 : auto saved = h_;
552 16 : delete this;
553 16 : saved.destroy();
554 16 : }
555 : };
556 :
557 3672 : auto ph = std::make_unique<post_handler>(h);
558 :
559 3672 : if (auto* ctx = reactor_find_context(this))
560 : {
561 8 : ++ctx->private_outstanding_work;
562 8 : ctx->private_queue.push(ph.release());
563 8 : return;
564 : }
565 :
566 3664 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
567 :
568 3664 : lock_type lock(mutex_);
569 3664 : completed_ops_.push(ph.release());
570 3664 : wake_one_thread_and_unlock(lock);
571 3672 : }
572 :
573 : inline void
574 112711 : reactor_scheduler::post(scheduler_op* h) const
575 : {
576 112711 : if (auto* ctx = reactor_find_context(this))
577 : {
578 111174 : ++ctx->private_outstanding_work;
579 111174 : ctx->private_queue.push(h);
580 111174 : return;
581 : }
582 :
583 1537 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
584 :
585 1537 : lock_type lock(mutex_);
586 1537 : completed_ops_.push(h);
587 1537 : wake_one_thread_and_unlock(lock);
588 1537 : }
589 :
590 : inline void
591 236716 : reactor_scheduler::post(capy::continuation& c) const
592 : {
593 236716 : if (auto* ctx = reactor_find_context(this))
594 : {
595 204299 : ++ctx->private_outstanding_work;
596 204299 : ctx->private_queue.push(c);
597 204299 : return;
598 : }
599 :
600 32417 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
601 :
602 32417 : lock_type lock(mutex_);
603 32417 : completed_ops_.push(c);
604 32417 : wake_one_thread_and_unlock(lock);
605 32417 : }
606 :
607 : inline bool
608 23956 : reactor_scheduler::running_in_this_thread() const noexcept
609 : {
610 23956 : return reactor_find_context(this) != nullptr;
611 : }
612 :
613 : inline void
614 8597 : reactor_scheduler::stop()
615 : {
616 8597 : lock_type lock(mutex_);
617 8597 : if (!stopped_.load(std::memory_order_acquire))
618 : {
619 7511 : stopped_.store(true, std::memory_order_release);
620 7511 : signal_all(lock);
621 7511 : interrupt_reactor();
622 : }
623 8597 : }
624 :
625 : inline bool
626 3547 : reactor_scheduler::stopped() const noexcept
627 : {
628 3547 : return stopped_.load(std::memory_order_acquire);
629 : }
630 :
631 : inline void
632 5895 : reactor_scheduler::restart()
633 : {
634 5895 : stopped_.store(false, std::memory_order_release);
635 5895 : }
636 :
637 : inline std::size_t
638 6681 : reactor_scheduler::run()
639 : {
640 13362 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
641 : {
642 286 : stop();
643 286 : return 0;
644 : }
645 :
646 6395 : reactor_thread_context_guard ctx(this);
647 6395 : lock_type lock(mutex_);
648 :
649 6395 : std::size_t n = 0;
650 : for (;;)
651 : {
652 393768 : if (!do_one(lock, -1, ctx.frame_))
653 6392 : break;
654 387373 : if (n != (std::numeric_limits<std::size_t>::max)())
655 387373 : ++n;
656 387373 : if (!lock.owns_lock())
657 89970 : lock.lock();
658 : }
659 6392 : return n;
660 6398 : }
661 :
662 : inline std::size_t
663 128 : reactor_scheduler::run_one()
664 : {
665 256 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
666 : {
667 3 : stop();
668 3 : return 0;
669 : }
670 :
671 125 : reactor_thread_context_guard ctx(this);
672 125 : lock_type lock(mutex_);
673 125 : return do_one(lock, -1, ctx.frame_);
674 125 : }
675 :
676 : inline std::size_t
677 6146 : reactor_scheduler::wait_one(long usec)
678 : {
679 12292 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
680 : {
681 826 : stop();
682 826 : return 0;
683 : }
684 :
685 5320 : reactor_thread_context_guard ctx(this);
686 5320 : lock_type lock(mutex_);
687 5320 : return do_one(lock, usec, ctx.frame_);
688 5320 : }
689 :
690 : inline std::size_t
691 1339 : reactor_scheduler::poll()
692 : {
693 2678 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
694 : {
695 29 : stop();
696 29 : return 0;
697 : }
698 :
699 1310 : reactor_thread_context_guard ctx(this);
700 1310 : lock_type lock(mutex_);
701 :
702 1310 : std::size_t n = 0;
703 : for (;;)
704 : {
705 9316 : if (!do_one(lock, 0, ctx.frame_))
706 1310 : break;
707 8006 : if (n != (std::numeric_limits<std::size_t>::max)())
708 8006 : ++n;
709 8006 : if (!lock.owns_lock())
710 8004 : lock.lock();
711 : }
712 1310 : return n;
713 1310 : }
714 :
715 : inline std::size_t
716 60 : reactor_scheduler::poll_one()
717 : {
718 120 : if (outstanding_work_.load(std::memory_order_acquire) == 0)
719 : {
720 5 : stop();
721 5 : return 0;
722 : }
723 :
724 55 : reactor_thread_context_guard ctx(this);
725 55 : lock_type lock(mutex_);
726 55 : return do_one(lock, 0, ctx.frame_);
727 55 : }
728 :
729 : inline void
730 66844 : reactor_scheduler::work_started() noexcept
731 : {
732 66844 : outstanding_work_.fetch_add(1, std::memory_order_relaxed);
733 66844 : }
734 :
735 : inline void
736 111153 : reactor_scheduler::work_finished() noexcept
737 : {
738 222306 : if (outstanding_work_.fetch_sub(1, std::memory_order_acq_rel) == 1)
739 7383 : stop();
740 111153 : }
741 :
742 : inline void
743 37181 : reactor_scheduler::compensating_work_started() const noexcept
744 : {
745 37181 : auto* ctx = reactor_find_context(this);
746 37181 : if (ctx)
747 37179 : ++ctx->private_outstanding_work;
748 37181 : }
749 :
750 : inline void
751 1977 : reactor_scheduler::post_counted(scheduler_op* op) const
752 : {
753 1977 : if (auto* ctx = reactor_find_context(this))
754 : {
755 604 : ctx->private_queue.push(op);
756 604 : return;
757 : }
758 :
759 1373 : lock_type lock(mutex_);
760 1373 : completed_ops_.push(op);
761 1373 : wake_one_thread_and_unlock(lock);
762 1373 : }
763 :
764 : inline void
765 16026 : reactor_scheduler::post_deferred_completions(ready_queue& ops) const
766 : {
767 16026 : if (ops.empty())
768 16026 : return;
769 :
770 2 : if (auto* ctx = reactor_find_context(this))
771 : {
772 2 : ctx->private_queue.splice(ops);
773 2 : return;
774 : }
775 :
776 MIS 0 : lock_type lock(mutex_);
777 0 : completed_ops_.splice(ops);
778 0 : wake_one_thread_and_unlock(lock);
779 0 : }
780 :
781 : inline void
782 HIT 23124 : reactor_scheduler::retire_descriptor(
783 : reactor_retirable& d, object_ref keep) const
784 : {
785 23124 : lock_type lock(mutex_);
786 23124 : if (!task_running_.load(std::memory_order_relaxed))
787 : {
788 : // No pass can hold an event, but an earlier one may have
789 : // queued d.
790 17755 : d.hand_off(keep);
791 17755 : return;
792 : }
793 : // Already parked for this pass: the held reference suffices.
794 5369 : if (d.retired_ref_)
795 102 : return;
796 5267 : d.retired_ref_ = std::move(keep);
797 5267 : d.retired_next_ = retired_;
798 5267 : retired_ = &d;
799 23124 : }
800 :
801 : inline void
802 305441 : reactor_scheduler::settle_retired(lock_type& lock) const
803 : {
804 : // Handed off under the lock, since a later pass may retire the same
805 : // descriptor again as soon as it is released. A reference that is
806 : // not handed off may be the owner's last, and its release recycles
807 : // through the pool mutex, so it is dropped with the lock released.
808 305441 : reactor_retirable* dropped = nullptr;
809 310708 : while (auto* d = retired_)
810 : {
811 5267 : retired_ = d->retired_next_;
812 5267 : d->retired_next_ = nullptr;
813 5267 : auto keep = std::move(d->retired_ref_);
814 5267 : d->hand_off(keep);
815 : // A drop already pending keeps the owner alive, so this one
816 : // cannot be the last and is released here.
817 5267 : if (!keep || d->dropped_ref_)
818 392 : continue;
819 4875 : d->dropped_ref_ = std::move(keep);
820 4875 : d->dropped_next_ = dropped;
821 4875 : dropped = d;
822 10534 : }
823 310316 : while (auto* d = dropped)
824 : {
825 4875 : dropped = d->dropped_next_;
826 4875 : d->dropped_next_ = nullptr;
827 4875 : auto keep = std::move(d->dropped_ref_);
828 4875 : lock.unlock();
829 4875 : keep.reset();
830 4875 : lock.lock();
831 4875 : }
832 305441 : }
833 :
834 : inline void
835 390 : reactor_scheduler::on_timer_service_attached(timer_service& svc)
836 : {
837 390 : svc.set_on_earliest_changed(timer_service::callback(this, [](void* p) {
838 3223 : static_cast<reactor_scheduler*>(p)->interrupt_reactor();
839 3223 : }));
840 390 : }
841 :
842 : inline void
843 4498 : reactor_scheduler::shutdown_drain()
844 : {
845 4498 : wait_cancels_posting();
846 :
847 4498 : lock_type lock(mutex_);
848 4498 : settle_retired(lock);
849 4498 : destroy_queued(lock);
850 4498 : signal_all(lock);
851 4498 : }
852 :
853 4514 : inline reactor_scheduler::~reactor_scheduler()
854 : {
855 : // Services give up their work in shutdown(), but anything posted
856 : // after the drain, such as from a destructor, is still destroyed.
857 4514 : lock_type lock(mutex_);
858 4514 : destroy_queued(lock);
859 4514 : }
860 :
861 : inline void
862 9012 : reactor_scheduler::destroy_queued(lock_type& lock) noexcept
863 : {
864 22906 : while (auto e = completed_ops_.pop())
865 : {
866 13894 : if (ready_is_continuation(e))
867 : {
868 7843 : lock.unlock();
869 7843 : if (auto* c = ready_as_cont(e); c->h)
870 7843 : capy::abandon(*c);
871 7843 : lock.lock();
872 : }
873 : else
874 : {
875 6051 : auto* op = ready_as_op(e);
876 6051 : if (op == &task_op_)
877 4495 : continue;
878 1556 : lock.unlock();
879 1556 : op->destroy();
880 1556 : lock.lock();
881 : }
882 13894 : }
883 9012 : }
884 :
885 : inline void
886 12009 : reactor_scheduler::signal_all(lock_type&) const
887 : {
888 12009 : state_ |= signaled_bit;
889 12009 : cond_.notify_all();
890 12009 : }
891 :
892 : inline bool
893 38991 : reactor_scheduler::maybe_unlock_and_signal_one(lock_type& lock) const
894 : {
895 38991 : state_ |= signaled_bit;
896 38991 : if (state_ > signaled_bit)
897 : {
898 : // Signalled before unlocking: a post from another context's
899 : // thread may be the last touch of this scheduler before the
900 : // posted work runs, finishes and lets it be destroyed.
901 165 : cond_.notify_one();
902 165 : lock.unlock();
903 165 : return true;
904 : }
905 38826 : return false;
906 : }
907 :
908 : inline bool
909 654704 : reactor_scheduler::unlock_and_signal_one(lock_type& lock) const
910 : {
911 654704 : state_ |= signaled_bit;
912 654704 : bool have_waiters = state_ > signaled_bit;
913 654704 : lock.unlock();
914 654704 : if (have_waiters)
915 4227 : cond_.notify_one();
916 654704 : return have_waiters;
917 : }
918 :
919 : inline void
920 723 : reactor_scheduler::clear_signal() const
921 : {
922 723 : state_ &= ~signaled_bit;
923 723 : }
924 :
925 : inline void
926 714 : reactor_scheduler::wait_for_signal(lock_type& lock) const
927 : {
928 1516 : while ((state_ & signaled_bit) == 0)
929 : {
930 802 : state_ += waiter_increment;
931 802 : cond_.wait(lock);
932 802 : state_ -= waiter_increment;
933 : }
934 714 : }
935 :
936 : inline void
937 9 : reactor_scheduler::wait_for_signal_for(lock_type& lock, long timeout_us) const
938 : {
939 9 : if ((state_ & signaled_bit) == 0)
940 : {
941 9 : state_ += waiter_increment;
942 9 : cond_.wait_for(lock, std::chrono::microseconds(timeout_us));
943 9 : state_ -= waiter_increment;
944 : }
945 9 : }
946 :
947 : inline void
948 38991 : reactor_scheduler::wake_one_thread_and_unlock(lock_type& lock) const
949 : {
950 38991 : if (maybe_unlock_and_signal_one(lock))
951 165 : return;
952 :
953 38826 : if (task_running_.load(std::memory_order_relaxed) && !task_interrupted_)
954 : {
955 1738 : task_interrupted_ = true;
956 : // Under the lock, for the same reason as the signal above.
957 1738 : interrupt_reactor();
958 1738 : lock.unlock();
959 : }
960 : else
961 : {
962 37088 : lock.unlock();
963 : }
964 : }
965 :
966 398230 : inline reactor_scheduler::work_cleanup::~work_cleanup()
967 : {
968 398230 : std::int64_t produced = ctx.private_outstanding_work;
969 398230 : if (produced > 1)
970 1000 : sched->outstanding_work_.fetch_add(
971 : produced - 1, std::memory_order_relaxed);
972 397230 : else if (produced < 1)
973 64640 : sched->work_finished();
974 398230 : ctx.private_outstanding_work = 0;
975 :
976 398230 : if (!ctx.private_queue.empty())
977 : {
978 297732 : lock->lock();
979 297732 : sched->completed_ops_.splice(ctx.private_queue);
980 : }
981 398230 : }
982 :
983 300946 : inline reactor_scheduler::task_cleanup::~task_cleanup()
984 : {
985 300946 : if (ctx.private_outstanding_work > 0)
986 : {
987 9987 : sched->outstanding_work_.fetch_add(
988 9987 : ctx.private_outstanding_work, std::memory_order_relaxed);
989 9987 : ctx.private_outstanding_work = 0;
990 : }
991 :
992 300946 : if (!ctx.private_queue.empty())
993 : {
994 9987 : if (!lock->owns_lock())
995 MIS 0 : lock->lock();
996 HIT 9987 : sched->completed_ops_.splice(ctx.private_queue);
997 : }
998 300946 : }
999 :
1000 : inline std::size_t
1001 408584 : reactor_scheduler::do_one(lock_type& lock, long timeout_us, context_type& ctx)
1002 : {
1003 : for (;;)
1004 : {
1005 707603 : if (stopped_.load(std::memory_order_acquire))
1006 6568 : return 0;
1007 :
1008 701035 : auto const e = completed_ops_.pop();
1009 701035 : scheduler_op* op = ready_is_continuation(e) ? nullptr : ready_as_op(e);
1010 :
1011 : // Handle reactor sentinel — time to poll for I/O
1012 701035 : if (op == &task_op_)
1013 : {
1014 302082 : bool more_handlers = !completed_ops_.empty();
1015 :
1016 346073 : if (!more_handlers &&
1017 87982 : (outstanding_work_.load(std::memory_order_acquire) == 0 ||
1018 : timeout_us == 0))
1019 : {
1020 1136 : completed_ops_.push(&task_op_);
1021 1136 : return 0;
1022 : }
1023 :
1024 300946 : long task_timeout_us = more_handlers ? 0 : timeout_us;
1025 300946 : task_interrupted_ = task_timeout_us == 0;
1026 300946 : task_running_.store(true, std::memory_order_release);
1027 :
1028 : // Wake a peer to take the pending handlers while this thread
1029 : // polls the reactor; skipped when one_thread_ (no peer exists).
1030 300946 : if (more_handlers && !one_thread_)
1031 258080 : unlock_and_signal_one(lock);
1032 :
1033 : try
1034 : {
1035 300946 : run_task(lock, ctx, task_timeout_us);
1036 : }
1037 3 : catch (...)
1038 : {
1039 3 : task_running_.store(false, std::memory_order_relaxed);
1040 3 : throw;
1041 3 : }
1042 :
1043 300943 : task_running_.store(false, std::memory_order_relaxed);
1044 300943 : completed_ops_.push(&task_op_);
1045 300943 : settle_retired(lock);
1046 300943 : if (timeout_us > 0)
1047 2647 : return 0;
1048 298296 : continue;
1049 298296 : }
1050 :
1051 : // Handle ready entry (op or continuation)
1052 398953 : if (e != nullptr)
1053 : {
1054 398230 : bool more = !completed_ops_.empty();
1055 :
1056 398230 : if (more && !one_thread_)
1057 : {
1058 : // Wake a peer for the remaining work; unassisted if none
1059 : // was parked to take it.
1060 396624 : ctx.unassisted = !unlock_and_signal_one(lock);
1061 : }
1062 : else
1063 : {
1064 : // No peer to wake (one_thread_, or nothing more queued).
1065 1606 : ctx.unassisted = more;
1066 1606 : lock.unlock();
1067 : }
1068 :
1069 398230 : [[maybe_unused]] work_cleanup on_exit{this, &lock, ctx};
1070 :
1071 398230 : if (ready_is_continuation(e))
1072 228873 : ready_as_cont(e)->h.resume();
1073 : else
1074 169357 : (*op)();
1075 398230 : return 1;
1076 398230 : }
1077 :
1078 1446 : if (outstanding_work_.load(std::memory_order_acquire) == 0 ||
1079 : timeout_us == 0)
1080 MIS 0 : return 0;
1081 :
1082 HIT 723 : clear_signal();
1083 723 : if (timeout_us < 0)
1084 714 : wait_for_signal(lock);
1085 : else
1086 9 : wait_for_signal_for(lock, timeout_us);
1087 299019 : }
1088 : }
1089 :
1090 : } // namespace boost::corosio::detail
1091 :
1092 : #endif // BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SCHEDULER_HPP
|
