Index/include / boost / corosio / native / detail / reactor / reactor_signal_pipe.hpp

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

91.3% Lines (21 / 23) 50.0% Branches (1 / 2) 87.5% Functions (7 / 8)
[ ] prev/next file n p prev/next uncovered line
reactor_signal_pipe.hpp
f(x) Functions (8)
Function Calls Lines Branches Blocks
boost::corosio::detail::reactor_signal_pipe_reader::reactor_signal_pipe_reader() :43 9278x 100.0% – 100.0% boost::corosio::detail::reactor_signal_pipe_reader::~reactor_signal_pipe_reader() :43 9278x 100.0% – 100.0% boost::corosio::detail::reactor_signal_pipe_reader::drain_op::drain_op() :45 9278x 100.0% – 100.0% boost::corosio::detail::reactor_signal_pipe_reader::drain_op::~drain_op() :45 9277x 100.0% – 100.0% boost::corosio::detail::reactor_signal_pipe_reader::drain_op::perform_io() :49 985x 100.0% – 100.0% boost::corosio::detail::reactor_signal_pipe_reader::drain_op::operator()() :54 985x 92.3% 50.0% 62.0% boost::corosio::detail::reactor_signal_pipe_reader::drain_op::destroy() :77 0 0.0% – 0.0% boost::corosio::detail::reactor_signal_pipe_reader::arm() :85 563x 100.0% – 100.0%
Line Branch TLA Hits Source Code
1 //
2 // Copyright (c) 2026 Michael Vandeberg
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_SIGNAL_PIPE_HPP
11 #define BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SIGNAL_PIPE_HPP
12
13 #include <boost/corosio/detail/platform.hpp>
14
15 #if BOOST_COROSIO_POSIX
16
17 #include <boost/corosio/native/detail/posix/posix_signal_service.hpp>
18 #include <boost/corosio/native/detail/reactor/reactor_descriptor_state.hpp>
19 #include <boost/corosio/native/detail/reactor/reactor_op_base.hpp>
20
21 #include <errno.h>
22
23 /*
24 Reactor signal-pipe reader
25 ==========================
26
27 Bridges the global POSIX signal self-pipe (see posix_signal_service.hpp)
28 to the reactor backends (epoll/kqueue/select). The concrete scheduler owns
29 one of these for its lifetime and, in register_signal_reader(), parks the
30 drain op as the descriptor's read_op then calls register_descriptor().
31
32 On each read-readiness edge the drain op completes without touching the
33 pipe, and invoke_deferred_io runs it once the descriptor lock is
34 released. Only then does it drain the pipe and deliver the signals:
35 delivery posts into every context watching the pipe, and a post made
36 under this descriptor's lock would order it before another context's
37 scheduler lock, the reverse of that scheduler's own order. The op then
38 parks itself again, draining once more if an edge arrived meanwhile.
39 */
40
41 namespace boost::corosio::detail {
42
43 struct reactor_signal_pipe_reader
44 {
45 4639x struct drain_op final : reactor_op_base
46 {
47 4639x reactor_signal_pipe_reader* reader = nullptr;
48
49 985x void perform_io() noexcept override
50 {
51 985x errn = 0;
52 985x }
53
54 985x void operator()() override
55 {
56 985x auto& desc = reader->desc;
57 985x for (;;)
58 {
59 985x posix_signal_detail::drain_signal_pipe();
60 985x conditionally_enabled_mutex::scoped_lock lock(desc.mutex);
61 // An edge seen while unparked set read_ready instead.
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 985 times.
 985x if (!desc.read_ready)
63 {
64 985x desc.read_op = this;
65 985x break;
66 }
67 ✗ desc.read_ready = false;
68 985x }
69 // A select() started while this op was out ran without the
70 // pipe in its read set.
71 985x desc.scheduler_->notify_reparked();
72 // Nothing counted this op as work; balance the decrement
73 // that follows the inline run of a completed op.
74 985x desc.scheduler_->compensating_work_started();
75 985x }
76
77 ✗ void destroy() override {}
78 };
79
80 reactor_descriptor_state desc;
81 drain_op op;
82
83 // Park the drain op and return the descriptor to hand to
84 // scheduler::register_descriptor(read_fd, ...).
85 563x reactor_descriptor_state* arm() noexcept
86 {
87 563x op.reader = this;
88 563x desc.read_op = &op;
89 563x return &desc;
90 }
91 };
92
93 } // namespace boost::corosio::detail
94
95 #endif // BOOST_COROSIO_POSIX
96
97 #endif // BOOST_COROSIO_NATIVE_DETAIL_REACTOR_REACTOR_SIGNAL_PIPE_HPP
98