include/boost/corosio/native/detail/reactor/reactor_scheduler.hpp

84.3% Lines (306/0/363) 89.4% List of functions (42/0/47)
reactor_scheduler.hpp
f(x) Functions (47)
Function Calls Lines Blocks
boost::corosio::detail::reactor_find_context(boost::corosio::detail::reactor_scheduler const*) :79 1191686x 100.0% 86.0% boost::corosio::detail::reactor_flush_private_work(boost::corosio::detail::reactor_scheduler_context*, std::atomic<long>&) :91 0 0.0% 0.0% boost::corosio::detail::reactor_drain_private_queue(boost::corosio::detail::reactor_scheduler_context*, std::atomic<long>&, boost::corosio::detail::ready_queue&) :108 9x 50.0% 64.0% boost::corosio::detail::reactor_scheduler::inline_budget_initial() const :256 1157x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::scheduler_locking_disabled() const :262 172x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::configure_threading(boost::corosio::detail::scheduler::threading_config) :267 1410x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::reactor_scheduler() :284 1410x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::task_op::operator()() :329 0 0.0% 0.0% boost::corosio::detail::reactor_scheduler::task_op::destroy() :330 0 0.0% 0.0% boost::corosio::detail::reactor_thread_context_guard::reactor_thread_context_guard(boost::corosio::detail::reactor_scheduler const*) :376 1157x 100.0% 100.0% boost::corosio::detail::reactor_thread_context_guard::~reactor_thread_context_guard() :384 1157x 66.7% 80.0% boost::corosio::detail::reactor_scheduler_context::reactor_scheduler_context(boost::corosio::detail::reactor_scheduler const*, boost::corosio::detail::reactor_scheduler_context*) :396 1157x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::configure_reactor(unsigned int, unsigned int, unsigned int, unsigned int) :410 28x 93.3% 74.0% boost::corosio::detail::reactor_scheduler::reset_inline_budget() const :437 132588x 50.0% 43.0% boost::corosio::detail::reactor_scheduler::try_consume_inline_budget() const :468 575136x 87.5% 88.0% boost::corosio::detail::reactor_scheduler::post(std::__n4861::coroutine_handle<void>) const :484 3686x 100.0% 84.0% boost::corosio::detail::reactor_scheduler::post(std::__n4861::coroutine_handle<void>) const::post_handler::post_handler(std::__n4861::coroutine_handle<void>) :490 3686x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::post(std::__n4861::coroutine_handle<void>) const::post_handler::~post_handler() :491 7372x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::post(std::__n4861::coroutine_handle<void>) const::post_handler::operator()() :493 3674x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::post(std::__n4861::coroutine_handle<void>) const::post_handler::destroy() :500 12x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::post(boost::corosio::detail::scheduler_op*) const :525 126220x 100.0% 87.0% boost::corosio::detail::reactor_scheduler::post(boost::capy::continuation&) const :542 17894x 100.0% 87.0% boost::corosio::detail::reactor_scheduler::running_in_this_thread() const :559 7439x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::stop() :565 1129x 100.0% 82.0% boost::corosio::detail::reactor_scheduler::stopped() const :577 96x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::restart() :583 259x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::run() :589 1129x 100.0% 76.0% boost::corosio::detail::reactor_scheduler::run_one() :614 25x 100.0% 64.0% boost::corosio::detail::reactor_scheduler::wait_one(long) :628 64x 100.0% 70.0% boost::corosio::detail::reactor_scheduler::poll() :642 21x 100.0% 76.0% boost::corosio::detail::reactor_scheduler::poll_one() :667 9x 100.0% 70.0% boost::corosio::detail::reactor_scheduler::work_started() :681 35493x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::work_finished() :687 55144x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::compensating_work_started() const :694 328723x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::drain_thread_queue(boost::corosio::detail::ready_queue&, long) const :702 0 0.0% 0.0% boost::corosio::detail::reactor_scheduler::post_deferred_completions(boost::corosio::detail::ready_queue&) const :715 17025x 30.0% 35.0% boost::corosio::detail::reactor_scheduler::shutdown_drain() :732 1410x 100.0% 88.0% boost::corosio::detail::reactor_scheduler::signal_all(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&) const :760 2484x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::maybe_unlock_and_signal_one(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&) const :767 10801x 57.1% 50.0% boost::corosio::detail::reactor_scheduler::unlock_and_signal_one(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&) const :781 561237x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::clear_signal() const :793 7x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::wait_for_signal(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&) const :799 7x 100.0% 100.0% boost::corosio::detail::reactor_scheduler::wait_for_signal_for(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&, long) const :811 0 0.0% 0.0% boost::corosio::detail::reactor_scheduler::wake_one_thread_and_unlock(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&) const :823 10801x 87.5% 92.0% boost::corosio::detail::reactor_scheduler::work_cleanup::~work_cleanup() :841 493518x 92.3% 92.0% boost::corosio::detail::reactor_scheduler::task_cleanup::~task_cleanup() :865 365393x 83.3% 86.0% boost::corosio::detail::reactor_scheduler::do_one(boost::corosio::detail::conditionally_enabled_mutex::scoped_lock&, long, boost::corosio::detail::reactor_scheduler_context*) :886 494623x 87.5% 80.0%
Line TLA Hits 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/capy/ex/execution_context.hpp>
15
16 #include <boost/corosio/detail/ready_queue.hpp>
17 #include <boost/corosio/detail/scheduler.hpp>
18 #include <boost/corosio/detail/scheduler_op.hpp>
19 #include <boost/corosio/detail/thread_local_ptr.hpp>
20
21 #include <atomic>
22 #include <chrono>
23 #include <coroutine>
24 #include <cstddef>
25 #include <cstdint>
26 #include <limits>
27 #include <memory>
28 #include <stdexcept>
29
30 #include <boost/corosio/detail/conditionally_enabled_mutex.hpp>
31 #include <boost/corosio/detail/conditionally_enabled_event.hpp>
32
33 namespace boost::corosio::detail {
34
35 // Forward declarations
36 class reactor_scheduler;
37 class timer_service;
38
39 /** Per-thread state for a reactor scheduler.
40
41 Each thread running a scheduler's event loop has one of these
42 on a thread-local stack. It holds a private work queue and
43 inline completion budget for speculative I/O fast paths.
44 */
45 struct BOOST_COROSIO_SYMBOL_VISIBLE reactor_scheduler_context
46 {
47 /// Scheduler this context belongs to.
48 reactor_scheduler const* key;
49
50 /// Next context frame on this thread's stack.
51 reactor_scheduler_context* next;
52
53 /// Private work queue for reduced contention.
54 ready_queue private_queue;
55
56 /// Unflushed work count for the private queue.
57 std::int64_t private_outstanding_work;
58
59 /// Remaining inline completions allowed this cycle.
60 int inline_budget;
61
62 /// Maximum inline budget (adaptive, 2-16).
63 int inline_budget_max;
64
65 /// True if no other thread absorbed queued work last cycle.
66 bool unassisted;
67
68 /// Construct a context frame linked to @a n.
69 reactor_scheduler_context(
70 reactor_scheduler const* k,
71 reactor_scheduler_context* n);
72 };
73
74 /// Thread-local context stack for reactor schedulers.
75 inline thread_local_ptr<reactor_scheduler_context> reactor_context_stack;
76
77 /// Find the context frame for a scheduler on this thread.
78 inline reactor_scheduler_context*
79 1191686x reactor_find_context(reactor_scheduler const* self) noexcept
80 {
81 1191686x for (auto* c = reactor_context_stack.get(); c != nullptr; c = c->next)
82 {
83 1174144x if (c->key == self)
84 1174144x return c;
85 }
86 17542x return nullptr;
87 }
88
89 /// Flush private work count to global counter.
90 inline void
91 reactor_flush_private_work(
92 reactor_scheduler_context* ctx,
93 std::atomic<std::int64_t>& outstanding_work) noexcept
94 {
95 if (ctx && ctx->private_outstanding_work > 0)
96 {
97 outstanding_work.fetch_add(
98 ctx->private_outstanding_work, std::memory_order_relaxed);
99 ctx->private_outstanding_work = 0;
100 }
101 }
102
103 /** Drain private queue to global queue, flushing work count first.
104
105 @return True if any ops were drained.
106 */
107 inline bool
108 9x reactor_drain_private_queue(
109 reactor_scheduler_context* ctx,
110 std::atomic<std::int64_t>& outstanding_work,
111 ready_queue& completed_ops) noexcept
112 {
113 9x if (!ctx || ctx->private_queue.empty())
114 9x return false;
115
116 reactor_flush_private_work(ctx, outstanding_work);
117 completed_ops.splice(ctx->private_queue);
118 return true;
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 , public capy::execution_context::service
144 {
145 public:
146 using key_type = scheduler;
147 using context_type = reactor_scheduler_context;
148 using mutex_type = conditionally_enabled_mutex;
149 using lock_type = mutex_type::scoped_lock;
150 using event_type = conditionally_enabled_event;
151
152 /// Post a coroutine for deferred execution.
153 void post(std::coroutine_handle<> h) const override;
154
155 /// Post a scheduler operation for deferred execution.
156 void post(scheduler_op* h) const override;
157
158 /// Post a continuation for deferred execution.
159 void post(capy::continuation&) const override;
160
161 /// Return true if called from a thread running this scheduler.
162 bool running_in_this_thread() const noexcept override;
163
164 /// Request the scheduler to stop dispatching handlers.
165 void stop() override;
166
167 /// Return true if the scheduler has been stopped.
168 bool stopped() const noexcept override;
169
170 /// Reset the stopped state so `run()` can resume.
171 void restart() override;
172
173 /// Run the event loop until no work remains.
174 std::size_t run() override;
175
176 /// Run until one handler completes or no work remains.
177 std::size_t run_one() override;
178
179 /// Run until one handler completes or @a usec elapses.
180 std::size_t wait_one(long usec) override;
181
182 /// Run ready handlers without blocking.
183 std::size_t poll() override;
184
185 /// Run at most one ready handler without blocking.
186 std::size_t poll_one() override;
187
188 /// Increment the outstanding work count.
189 void work_started() noexcept override;
190
191 /// Decrement the outstanding work count, stopping on zero.
192 void work_finished() noexcept override;
193
194 /** Reset the thread's inline completion budget.
195
196 Called at the start of each posted completion handler to
197 grant a fresh budget for speculative inline completions.
198 */
199 void reset_inline_budget() const noexcept;
200
201 /** Consume one unit of inline budget if available.
202
203 @return True if budget was available and consumed.
204 */
205 bool try_consume_inline_budget() const noexcept;
206
207 /** Offset a forthcoming work_finished from work_cleanup.
208
209 Called by descriptor_state when all I/O returned EAGAIN and
210 no handler will be executed. Must be called from a scheduler
211 thread.
212 */
213 void compensating_work_started() const noexcept;
214
215 /** Drain work from thread context's private queue to global queue.
216
217 Flushes private work count to the global counter, then
218 transfers the queue under mutex protection.
219
220 @param queue The private queue to drain.
221 @param count Private work count to flush before draining.
222 */
223 void drain_thread_queue(ready_queue& queue, std::int64_t count) const;
224
225 /** Post completed operations for deferred invocation.
226
227 If called from a thread running this scheduler, operations
228 go to the thread's private queue (fast path). Otherwise,
229 operations are added to the global queue under mutex and a
230 waiter is signaled.
231
232 @par Preconditions
233 work_started() must have been called for each operation.
234
235 @param ops Queue of operations to post.
236 */
237 void post_deferred_completions(ready_queue& ops) const;
238
239 /** Apply runtime configuration to the scheduler.
240
241 Called by `io_context` after construction. Values that do
242 not apply to this backend are silently ignored.
243
244 @param max_events Event buffer size for epoll/kqueue.
245 @param budget_init Starting inline completion budget.
246 @param budget_max Hard ceiling on adaptive budget ramp-up.
247 @param unassisted Budget when single-threaded.
248 */
249 virtual void configure_reactor(
250 unsigned max_events,
251 unsigned budget_init,
252 unsigned budget_max,
253 unsigned unassisted);
254
255 /// Return the configured initial inline budget.
256 1157x unsigned inline_budget_initial() const noexcept
257 {
258 1157x return inline_budget_initial_;
259 }
260
261 /// Return true when scheduler locking is disabled (fully-lockless tier).
262 172x bool scheduler_locking_disabled() const noexcept override
263 {
264 172x return scheduler_locking_disabled_;
265 }
266
267 1410x void configure_threading(threading_config cfg) noexcept override
268 {
269 1410x scheduler_locking_disabled_ = !cfg.scheduler_locking;
270 // reactor_io_locking takes effect at descriptor registration (see the
271 // register_descriptor overrides), not here.
272 1410x reactor_io_locking_ = cfg.reactor_io_locking;
273 1410x one_thread_ = cfg.one_thread;
274 1410x mutex_.set_enabled(cfg.scheduler_locking);
275 1410x cond_.set_enabled(cfg.scheduler_locking);
276 1410x }
277
278 protected:
279 timer_service* timer_svc_ = nullptr;
280 bool scheduler_locking_disabled_ = false;
281 bool reactor_io_locking_ = true;
282 bool one_thread_ = false;
283
284 1410x reactor_scheduler() = default;
285
286 /** Drain completed_ops during shutdown.
287
288 Pops all operations from the global queue and destroys them,
289 skipping the task sentinel. Signals all waiting threads.
290 Derived classes call this from their shutdown() override
291 before performing platform-specific cleanup.
292 */
293 void shutdown_drain();
294
295 /// RAII guard that re-inserts the task sentinel after `run_task`.
296 struct task_cleanup
297 {
298 reactor_scheduler const* sched;
299 lock_type* lock;
300 context_type* ctx;
301 ~task_cleanup();
302 };
303
304 mutable mutex_type mutex_{true};
305 mutable event_type cond_{true};
306 mutable ready_queue completed_ops_;
307 mutable std::atomic<std::int64_t> outstanding_work_{0};
308 std::atomic<bool> stopped_{false};
309 mutable std::atomic<bool> task_running_{false};
310 mutable bool task_interrupted_ = false;
311
312 // Runtime-configurable reactor tuning parameters.
313 // Defaults match the library's built-in values.
314 unsigned max_events_per_poll_ = 128;
315 unsigned inline_budget_initial_ = 2;
316 unsigned inline_budget_max_ = 16;
317 unsigned unassisted_budget_ = 4;
318
319 /// Bit 0 of `state_`: set when the condvar should be signaled.
320 static constexpr std::size_t signaled_bit = 1;
321
322 /// Increment per waiting thread in `state_`.
323 static constexpr std::size_t waiter_increment = 2;
324 mutable std::size_t state_ = 0;
325
326 /// Sentinel op that triggers a reactor poll when dequeued.
327 struct task_op final : scheduler_op
328 {
329 void operator()() override {}
330 void destroy() override {}
331 };
332 task_op task_op_;
333
334 /// Run the platform-specific reactor poll.
335 virtual void
336 run_task(lock_type& lock, context_type* ctx,
337 long timeout_us) = 0;
338
339 /// Wake a blocked reactor (e.g. write to eventfd or pipe).
340 virtual void interrupt_reactor() const = 0;
341
342 private:
343 struct work_cleanup
344 {
345 reactor_scheduler* sched;
346 lock_type* lock;
347 context_type* ctx;
348 ~work_cleanup();
349 };
350
351 std::size_t do_one(
352 lock_type& lock, long timeout_us, context_type* ctx);
353
354 void signal_all(lock_type& lock) const;
355 bool maybe_unlock_and_signal_one(lock_type& lock) const;
356 bool unlock_and_signal_one(lock_type& lock) const;
357 void clear_signal() const;
358 void wait_for_signal(lock_type& lock) const;
359 void wait_for_signal_for(
360 lock_type& lock, long timeout_us) const;
361 void wake_one_thread_and_unlock(lock_type& lock) const;
362 };
363
364 /** RAII guard that pushes/pops a scheduler context frame.
365
366 On construction, pushes a new context frame onto the
367 thread-local stack. On destruction, drains any remaining
368 private queue items to the global queue and pops the frame.
369 */
370 struct reactor_thread_context_guard
371 {
372 /// The context frame managed by this guard.
373 reactor_scheduler_context frame_;
374
375 /// Construct the guard, pushing a frame for @a sched.
376 1157x explicit reactor_thread_context_guard(
377 reactor_scheduler const* sched) noexcept
378 1157x : frame_(sched, reactor_context_stack.get())
379 {
380 1157x reactor_context_stack.set(&frame_);
381 1157x }
382
383 /// Destroy the guard, draining private work and popping the frame.
384 1157x ~reactor_thread_context_guard() noexcept
385 {
386 1157x if (!frame_.private_queue.empty())
387 frame_.key->drain_thread_queue(
388 frame_.private_queue, frame_.private_outstanding_work);
389 1157x reactor_context_stack.set(frame_.next);
390 1157x }
391 };
392
393 // ---- Inline implementations ------------------------------------------------
394
395 inline
396 1157x reactor_scheduler_context::reactor_scheduler_context(
397 reactor_scheduler const* k,
398 1157x reactor_scheduler_context* n)
399 1157x : key(k)
400 1157x , next(n)
401 1157x , private_outstanding_work(0)
402 1157x , inline_budget(0)
403 1157x , inline_budget_max(
404 1157x static_cast<int>(k->inline_budget_initial()))
405 1157x , unassisted(false)
406 {
407 1157x }
408
409 inline void
410 28x reactor_scheduler::configure_reactor(
411 unsigned max_events,
412 unsigned budget_init,
413 unsigned budget_max,
414 unsigned unassisted)
415 {
416 54x if (max_events < 1 ||
417 26x max_events > static_cast<unsigned>(std::numeric_limits<int>::max()))
418 throw std::out_of_range(
419 2x "max_events_per_poll must be in [1, INT_MAX]");
420 26x if (budget_max > static_cast<unsigned>(std::numeric_limits<int>::max()))
421 throw std::out_of_range(
422 "inline_budget_max must be in [0, INT_MAX]");
423
424 // Clamp initial and unassisted to budget_max.
425 26x if (budget_init > budget_max)
426 2x budget_init = budget_max;
427 26x if (unassisted > budget_max)
428 2x unassisted = budget_max;
429
430 26x max_events_per_poll_ = max_events;
431 26x inline_budget_initial_ = budget_init;
432 26x inline_budget_max_ = budget_max;
433 26x unassisted_budget_ = unassisted;
434 26x }
435
436 inline void
437 132588x reactor_scheduler::reset_inline_budget() const noexcept
438 {
439 // When budget is disabled (max==0), all paths below would no-op
440 // (inline_budget stays 0). Skip the TLS lookup entirely.
441 132588x if (inline_budget_max_ == 0)
442 return;
443 132588x if (auto* ctx = reactor_find_context(this))
444 {
445 // Cap when no other thread absorbed queued work
446 132588x if (ctx->unassisted)
447 {
448 132588x ctx->inline_budget_max =
449 132588x static_cast<int>(unassisted_budget_);
450 132588x ctx->inline_budget =
451 132588x static_cast<int>(unassisted_budget_);
452 132588x return;
453 }
454 // Ramp up when previous cycle fully consumed budget.
455 // max(1, ...) ensures the doubling escapes zero.
456 if (ctx->inline_budget == 0)
457 ctx->inline_budget_max = (std::min)(
458 (std::max)(1, ctx->inline_budget_max) * 2,
459 static_cast<int>(inline_budget_max_));
460 else if (ctx->inline_budget < ctx->inline_budget_max)
461 ctx->inline_budget_max =
462 static_cast<int>(inline_budget_initial_);
463 ctx->inline_budget = ctx->inline_budget_max;
464 }
465 }
466
467 inline bool
468 575136x reactor_scheduler::try_consume_inline_budget() const noexcept
469 {
470 575136x if (inline_budget_max_ == 0)
471 return false;
472 575136x if (auto* ctx = reactor_find_context(this))
473 {
474 575136x if (ctx->inline_budget > 0)
475 {
476 460020x --ctx->inline_budget;
477 460020x return true;
478 }
479 }
480 115116x return false;
481 }
482
483 inline void
484 3686x reactor_scheduler::post(std::coroutine_handle<> h) const
485 {
486 struct post_handler final : scheduler_op
487 {
488 std::coroutine_handle<> h_;
489
490 3686x explicit post_handler(std::coroutine_handle<> h) : h_(h) {}
491 7372x ~post_handler() override = default;
492
493 3674x void operator()() override
494 {
495 3674x auto saved = h_;
496 3674x delete this;
497 3674x saved.resume();
498 3674x }
499
500 12x void destroy() override
501 {
502 12x auto saved = h_;
503 12x delete this;
504 12x saved.destroy();
505 12x }
506 };
507
508 3686x auto ph = std::make_unique<post_handler>(h);
509
510 3686x if (auto* ctx = reactor_find_context(this))
511 {
512 26x ++ctx->private_outstanding_work;
513 26x ctx->private_queue.push(ph.release());
514 26x return;
515 }
516
517 3660x outstanding_work_.fetch_add(1, std::memory_order_relaxed);
518
519 3660x lock_type lock(mutex_);
520 3660x completed_ops_.push(ph.release());
521 3660x wake_one_thread_and_unlock(lock);
522 3686x }
523
524 inline void
525 126220x reactor_scheduler::post(scheduler_op* h) const
526 {
527 126220x if (auto* ctx = reactor_find_context(this))
528 {
529 125823x ++ctx->private_outstanding_work;
530 125823x ctx->private_queue.push(h);
531 125823x return;
532 }
533
534 397x outstanding_work_.fetch_add(1, std::memory_order_relaxed);
535
536 397x lock_type lock(mutex_);
537 397x completed_ops_.push(h);
538 397x wake_one_thread_and_unlock(lock);
539 397x }
540
541 inline void
542 17894x reactor_scheduler::post(capy::continuation& c) const
543 {
544 17894x if (auto* ctx = reactor_find_context(this))
545 {
546 11150x ++ctx->private_outstanding_work;
547 11150x ctx->private_queue.push(c);
548 11150x return;
549 }
550
551 6744x outstanding_work_.fetch_add(1, std::memory_order_relaxed);
552
553 6744x lock_type lock(mutex_);
554 6744x completed_ops_.push(c);
555 6744x wake_one_thread_and_unlock(lock);
556 6744x }
557
558 inline bool
559 7439x reactor_scheduler::running_in_this_thread() const noexcept
560 {
561 7439x return reactor_find_context(this) != nullptr;
562 }
563
564 inline void
565 1129x reactor_scheduler::stop()
566 {
567 1129x lock_type lock(mutex_);
568 1129x if (!stopped_.load(std::memory_order_acquire))
569 {
570 1074x stopped_.store(true, std::memory_order_release);
571 1074x signal_all(lock);
572 1074x interrupt_reactor();
573 }
574 1129x }
575
576 inline bool
577 96x reactor_scheduler::stopped() const noexcept
578 {
579 96x return stopped_.load(std::memory_order_acquire);
580 }
581
582 inline void
583 259x reactor_scheduler::restart()
584 {
585 259x stopped_.store(false, std::memory_order_release);
586 259x }
587
588 inline std::size_t
589 1129x reactor_scheduler::run()
590 {
591 2258x if (outstanding_work_.load(std::memory_order_acquire) == 0)
592 {
593 59x stop();
594 59x return 0;
595 }
596
597 1070x reactor_thread_context_guard ctx(this);
598 1070x lock_type lock(mutex_);
599
600 1070x std::size_t n = 0;
601 for (;;)
602 {
603 494500x if (!do_one(lock, -1, &ctx.frame_))
604 1070x break;
605 493430x if (n != (std::numeric_limits<std::size_t>::max)())
606 493430x ++n;
607 493430x if (!lock.owns_lock())
608 365021x lock.lock();
609 }
610 1070x return n;
611 1070x }
612
613 inline std::size_t
614 25x reactor_scheduler::run_one()
615 {
616 50x if (outstanding_work_.load(std::memory_order_acquire) == 0)
617 {
618 1x stop();
619 1x return 0;
620 }
621
622 24x reactor_thread_context_guard ctx(this);
623 24x lock_type lock(mutex_);
624 24x return do_one(lock, -1, &ctx.frame_);
625 24x }
626
627 inline std::size_t
628 64x reactor_scheduler::wait_one(long usec)
629 {
630 128x if (outstanding_work_.load(std::memory_order_acquire) == 0)
631 {
632 23x stop();
633 23x return 0;
634 }
635
636 41x reactor_thread_context_guard ctx(this);
637 41x lock_type lock(mutex_);
638 41x return do_one(lock, usec, &ctx.frame_);
639 41x }
640
641 inline std::size_t
642 21x reactor_scheduler::poll()
643 {
644 42x if (outstanding_work_.load(std::memory_order_acquire) == 0)
645 {
646 3x stop();
647 3x return 0;
648 }
649
650 18x reactor_thread_context_guard ctx(this);
651 18x lock_type lock(mutex_);
652
653 18x std::size_t n = 0;
654 for (;;)
655 {
656 54x if (!do_one(lock, 0, &ctx.frame_))
657 18x break;
658 36x if (n != (std::numeric_limits<std::size_t>::max)())
659 36x ++n;
660 36x if (!lock.owns_lock())
661 36x lock.lock();
662 }
663 18x return n;
664 18x }
665
666 inline std::size_t
667 9x reactor_scheduler::poll_one()
668 {
669 18x if (outstanding_work_.load(std::memory_order_acquire) == 0)
670 {
671 5x stop();
672 5x return 0;
673 }
674
675 4x reactor_thread_context_guard ctx(this);
676 4x lock_type lock(mutex_);
677 4x return do_one(lock, 0, &ctx.frame_);
678 4x }
679
680 inline void
681 35493x reactor_scheduler::work_started() noexcept
682 {
683 35493x outstanding_work_.fetch_add(1, std::memory_order_relaxed);
684 35493x }
685
686 inline void
687 55144x reactor_scheduler::work_finished() noexcept
688 {
689 110288x if (outstanding_work_.fetch_sub(1, std::memory_order_acq_rel) == 1)
690 1029x stop();
691 55144x }
692
693 inline void
694 328723x reactor_scheduler::compensating_work_started() const noexcept
695 {
696 328723x auto* ctx = reactor_find_context(this);
697 328723x if (ctx)
698 328723x ++ctx->private_outstanding_work;
699 328723x }
700
701 inline void
702 reactor_scheduler::drain_thread_queue(
703 ready_queue& queue, std::int64_t count) const
704 {
705 if (count > 0)
706 outstanding_work_.fetch_add(count, std::memory_order_relaxed);
707
708 lock_type lock(mutex_);
709 completed_ops_.splice(queue);
710 if (count > 0)
711 maybe_unlock_and_signal_one(lock);
712 }
713
714 inline void
715 17025x reactor_scheduler::post_deferred_completions(ready_queue& ops) const
716 {
717 17025x if (ops.empty())
718 17025x return;
719
720 if (auto* ctx = reactor_find_context(this))
721 {
722 ctx->private_queue.splice(ops);
723 return;
724 }
725
726 lock_type lock(mutex_);
727 completed_ops_.splice(ops);
728 wake_one_thread_and_unlock(lock);
729 }
730
731 inline void
732 1410x reactor_scheduler::shutdown_drain()
733 {
734 1410x lock_type lock(mutex_);
735
736 3049x while (auto e = completed_ops_.pop())
737 {
738 1639x if (ready_is_continuation(e))
739 {
740 4x lock.unlock();
741 4x if (auto h = ready_as_cont(e)->h)
742 4x h.destroy();
743 4x lock.lock();
744 }
745 else
746 {
747 1635x auto* op = ready_as_op(e);
748 1635x if (op == &task_op_)
749 1410x continue;
750 225x lock.unlock();
751 225x op->destroy();
752 225x lock.lock();
753 }
754 1639x }
755
756 1410x signal_all(lock);
757 1410x }
758
759 inline void
760 2484x reactor_scheduler::signal_all(lock_type&) const
761 {
762 2484x state_ |= signaled_bit;
763 2484x cond_.notify_all();
764 2484x }
765
766 inline bool
767 10801x reactor_scheduler::maybe_unlock_and_signal_one(
768 lock_type& lock) const
769 {
770 10801x state_ |= signaled_bit;
771 10801x if (state_ > signaled_bit)
772 {
773 lock.unlock();
774 cond_.notify_one();
775 return true;
776 }
777 10801x return false;
778 }
779
780 inline bool
781 561237x reactor_scheduler::unlock_and_signal_one(
782 lock_type& lock) const
783 {
784 561237x state_ |= signaled_bit;
785 561237x bool have_waiters = state_ > signaled_bit;
786 561237x lock.unlock();
787 561237x if (have_waiters)
788 6x cond_.notify_one();
789 561237x return have_waiters;
790 }
791
792 inline void
793 7x reactor_scheduler::clear_signal() const
794 {
795 7x state_ &= ~signaled_bit;
796 7x }
797
798 inline void
799 7x reactor_scheduler::wait_for_signal(
800 lock_type& lock) const
801 {
802 16x while ((state_ & signaled_bit) == 0)
803 {
804 9x state_ += waiter_increment;
805 9x cond_.wait(lock);
806 9x state_ -= waiter_increment;
807 }
808 7x }
809
810 inline void
811 reactor_scheduler::wait_for_signal_for(
812 lock_type& lock, long timeout_us) const
813 {
814 if ((state_ & signaled_bit) == 0)
815 {
816 state_ += waiter_increment;
817 cond_.wait_for(lock, std::chrono::microseconds(timeout_us));
818 state_ -= waiter_increment;
819 }
820 }
821
822 inline void
823 10801x reactor_scheduler::wake_one_thread_and_unlock(
824 lock_type& lock) const
825 {
826 10801x if (maybe_unlock_and_signal_one(lock))
827 return;
828
829 10801x if (task_running_.load(std::memory_order_relaxed) && !task_interrupted_)
830 {
831 119x task_interrupted_ = true;
832 119x lock.unlock();
833 119x interrupt_reactor();
834 }
835 else
836 {
837 10682x lock.unlock();
838 }
839 }
840
841 493518x inline reactor_scheduler::work_cleanup::~work_cleanup()
842 {
843 493518x if (ctx)
844 {
845 493518x std::int64_t produced = ctx->private_outstanding_work;
846 493518x if (produced > 1)
847 311x sched->outstanding_work_.fetch_add(
848 produced - 1, std::memory_order_relaxed);
849 493207x else if (produced < 1)
850 36688x sched->work_finished();
851 493518x ctx->private_outstanding_work = 0;
852
853 493518x if (!ctx->private_queue.empty())
854 {
855 128409x lock->lock();
856 128409x sched->completed_ops_.splice(ctx->private_queue);
857 }
858 }
859 else
860 {
861 sched->work_finished();
862 }
863 493518x }
864
865 730786x inline reactor_scheduler::task_cleanup::~task_cleanup()
866 {
867 365393x if (!ctx)
868 return;
869
870 365393x if (ctx->private_outstanding_work > 0)
871 {
872 8573x sched->outstanding_work_.fetch_add(
873 8573x ctx->private_outstanding_work, std::memory_order_relaxed);
874 8573x ctx->private_outstanding_work = 0;
875 }
876
877 365393x if (!ctx->private_queue.empty())
878 {
879 8573x if (!lock->owns_lock())
880 lock->lock();
881 8573x sched->completed_ops_.splice(ctx->private_queue);
882 }
883 365393x }
884
885 inline std::size_t
886 494623x reactor_scheduler::do_one(
887 lock_type& lock, long timeout_us, context_type* ctx)
888 {
889 for (;;)
890 {
891 860006x if (stopped_.load(std::memory_order_acquire))
892 1069x return 0;
893
894 858937x std::uintptr_t e = completed_ops_.pop();
895 858937x scheduler_op* op = ready_is_continuation(e) ? nullptr : ready_as_op(e);
896
897 // Handle reactor sentinel — time to poll for I/O
898 858937x if (op == &task_op_)
899 {
900 bool more_handlers =
901 365410x !completed_ops_.empty() || (ctx && !ctx->private_queue.empty());
902
903 663079x if (!more_handlers &&
904 595338x (outstanding_work_.load(std::memory_order_acquire) == 0 ||
905 timeout_us == 0))
906 {
907 17x completed_ops_.push(&task_op_);
908 17x return 0;
909 }
910
911 365393x long task_timeout_us = more_handlers ? 0 : timeout_us;
912 365393x task_interrupted_ = task_timeout_us == 0;
913 365393x task_running_.store(true, std::memory_order_release);
914
915 // Wake a peer to take the pending handlers while this thread
916 // polls the reactor; skipped when one_thread_ (no peer exists).
917 365393x if (more_handlers && !one_thread_)
918 67734x unlock_and_signal_one(lock);
919
920 try
921 {
922 365393x run_task(lock, ctx, task_timeout_us);
923 }
924 catch (...)
925 {
926 task_running_.store(false, std::memory_order_relaxed);
927 throw;
928 }
929
930 365393x task_running_.store(false, std::memory_order_relaxed);
931 365393x completed_ops_.push(&task_op_);
932 365393x if (timeout_us > 0)
933 17x return 0;
934 365376x continue;
935 365376x }
936
937 // Handle ready entry (op or continuation)
938 493527x if (e != 0)
939 {
940 493518x bool more = !completed_ops_.empty();
941
942 493518x if (more && !one_thread_)
943 {
944 // Wake a peer for the remaining work; unassisted if none
945 // was parked to take it.
946 493503x ctx->unassisted = !unlock_and_signal_one(lock);
947 }
948 else
949 {
950 // No peer to wake (one_thread_, or nothing more queued).
951 15x ctx->unassisted = more;
952 15x lock.unlock();
953 }
954
955 493518x work_cleanup on_exit{this, &lock, ctx};
956 (void)on_exit;
957
958 493518x if (ready_is_continuation(e))
959 17890x ready_as_cont(e)->h.resume();
960 else
961 475628x (*op)();
962 493518x return 1;
963 493518x }
964
965 // Try private queue before blocking
966 9x if (reactor_drain_private_queue(ctx, outstanding_work_, completed_ops_))
967 continue;
968
969 18x if (outstanding_work_.load(std::memory_order_acquire) == 0 ||
970 timeout_us == 0)
971 2x return 0;
972
973 7x clear_signal();
974 7x if (timeout_us < 0)
975 7x wait_for_signal(lock);
976 else
977 wait_for_signal_for(lock, timeout_us);
978 365383x }
979 }
980
981 } // namespace boost::corosio::detail
982
983 #endif // BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SCHEDULER_HPP
984