. /include/boost/corosio /detail /timeout_awaitable.hpp
100.00% Lines (62/62) 100.00% Functions (9/9)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2026 Steve Gerbino 2   // Copyright (c) 2026 Steve Gerbino
3   // 3   //
4   // Distributed under the Boost Software License, Version 1.0. (See accompanying 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) 5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6   // 6   //
7   // Official repository: https://github.com/cppalliance/corosio 7   // Official repository: https://github.com/cppalliance/corosio
8   // 8   //
9   9  
10   #ifndef BOOST_COROSIO_DETAIL_TIMEOUT_AWAITABLE_HPP 10   #ifndef BOOST_COROSIO_DETAIL_TIMEOUT_AWAITABLE_HPP
11   #define BOOST_COROSIO_DETAIL_TIMEOUT_AWAITABLE_HPP 11   #define BOOST_COROSIO_DETAIL_TIMEOUT_AWAITABLE_HPP
12   12  
13   #include <boost/corosio/io_context.hpp> 13   #include <boost/corosio/io_context.hpp>
14   #include <boost/corosio/detail/timeout_coro.hpp> 14   #include <boost/corosio/detail/timeout_coro.hpp>
15   #include <boost/corosio/detail/timer.hpp> 15   #include <boost/corosio/detail/timer.hpp>
16   #include <boost/corosio/detail/except.hpp> 16   #include <boost/corosio/detail/except.hpp>
17   #include <boost/capy/cond.hpp> 17   #include <boost/capy/cond.hpp>
18   #include <boost/capy/error.hpp> 18   #include <boost/capy/error.hpp>
19   #include <boost/capy/ex/io_env.hpp> 19   #include <boost/capy/ex/io_env.hpp>
20   #include <boost/capy/io_result.hpp> 20   #include <boost/capy/io_result.hpp>
21   21  
22   #include <chrono> 22   #include <chrono>
23   #include <coroutine> 23   #include <coroutine>
24   #include <new> 24   #include <new>
25   #include <optional> 25   #include <optional>
26   #include <stdexcept> 26   #include <stdexcept>
27   #include <stop_token> 27   #include <stop_token>
28   #include <type_traits> 28   #include <type_traits>
29   #include <utility> 29   #include <utility>
30   30  
31   /* Races an inner IoAwaitable against a timer via a shared 31   /* Races an inner IoAwaitable against a timer via a shared
32   stop_source. await_suspend arms the timer by launching a 32   stop_source. await_suspend arms the timer by launching a
33   fire-and-forget timeout_coro, then starts the inner op with 33   fire-and-forget timeout_coro, then starts the inner op with
34   an interposed stop_token. Whichever completes first signals 34   an interposed stop_token. Whichever completes first signals
35   the stop_source, cancelling the other. 35   the stop_source, cancelling the other.
36   36  
37   Parent cancellation is forwarded through a stop_callback 37   Parent cancellation is forwarded through a stop_callback
38   stored in a placement-new buffer (stop_callback is not 38   stored in a placement-new buffer (stop_callback is not
39   movable, but the awaitable must be movable for 39   movable, but the awaitable must be movable for
40   transform_awaiter). The buffer is inert during moves 40   transform_awaiter). The buffer is inert during moves
41   (before await_suspend) and constructed in-place once the 41   (before await_suspend) and constructed in-place once the
42   awaitable is pinned on the coroutine frame. 42   awaitable is pinned on the coroutine frame.
43   43  
44   The timeout_coro can outlive this awaitable — it owns its 44   The timeout_coro can outlive this awaitable — it owns its
45   env and self-destroys via suspend_never. The timer lives in 45   env and self-destroys via suspend_never. The timer lives in
46   std::optional and is constructed lazily in await_suspend, 46   std::optional and is constructed lazily in await_suspend,
47   once the awaiting coroutine's executor context is known. */ 47   once the awaiting coroutine's executor context is known. */
48   48  
49   namespace boost::corosio::detail { 49   namespace boost::corosio::detail {
50   50  
51   // Local stand-in for capy::detail's io_result trait: corosio must not 51   // Local stand-in for capy::detail's io_result trait: corosio must not
52   // reach into capy::detail, but the result-mapping switch in 52   // reach into capy::detail, but the result-mapping switch in
53   // await_resume needs to distinguish io_result from other return types. 53   // await_resume needs to distinguish io_result from other return types.
54   template<typename T> 54   template<typename T>
55   struct is_io_result : std::false_type 55   struct is_io_result : std::false_type
56   { 56   {
57   }; 57   };
58   58  
59   template<typename... Ts> 59   template<typename... Ts>
60   struct is_io_result<capy::io_result<Ts...>> : std::true_type 60   struct is_io_result<capy::io_result<Ts...>> : std::true_type
61   { 61   {
62   }; 62   };
63   63  
64   template<typename T> 64   template<typename T>
65   inline constexpr bool is_io_result_v = is_io_result<T>::value; 65   inline constexpr bool is_io_result_v = is_io_result<T>::value;
66   66  
67   /** Awaitable adapter that cancels an inner operation after a deadline. 67   /** Awaitable adapter that cancels an inner operation after a deadline.
68   68  
69   Races the inner awaitable against a timer. A shared stop_source 69   Races the inner awaitable against a timer. A shared stop_source
70   ties them together: whichever completes first cancels the other. 70   ties them together: whichever completes first cancels the other.
71   Parent cancellation is forwarded via stop_callback. 71   Parent cancellation is forwarded via stop_callback.
72   72  
73   The timer is constructed internally in `await_suspend` from the 73   The timer is constructed internally in `await_suspend` from the
74   execution context in `io_env`. 74   execution context in `io_env`.
75   75  
76   @tparam A The inner IoAwaitable type (decayed). 76   @tparam A The inner IoAwaitable type (decayed).
77   */ 77   */
78   template<typename A> 78   template<typename A>
79   struct timeout_awaitable 79   struct timeout_awaitable
80   { 80   {
81   struct stop_forwarder 81   struct stop_forwarder
82   { 82   {
83   std::stop_source* src_; 83   std::stop_source* src_;
HITCBC 84   1936 void operator()() const noexcept 84   1867 void operator()() const noexcept
85   { 85   {
HITCBC 86   1936 src_->request_stop(); 86   1867 src_->request_stop();
HITCBC 87   1936 } 87   1867 }
88   }; 88   };
89   89  
90   using time_point = std::chrono::steady_clock::time_point; 90   using time_point = std::chrono::steady_clock::time_point;
91   using stop_cb_type = std::stop_callback<stop_forwarder>; 91   using stop_cb_type = std::stop_callback<stop_forwarder>;
92   92  
93   A inner_; 93   A inner_;
94   std::optional<timer> timer_; 94   std::optional<timer> timer_;
95   time_point deadline_; 95   time_point deadline_;
96   std::chrono::nanoseconds dur_{}; 96   std::chrono::nanoseconds dur_{};
97   bool has_deadline_ = true; 97   bool has_deadline_ = true;
98   std::stop_source stop_src_; 98   std::stop_source stop_src_;
99   std::stop_token parent_token_; 99   std::stop_token parent_token_;
100   capy::io_env inner_env_; 100   capy::io_env inner_env_;
101   alignas(stop_cb_type) unsigned char cb_buf_[sizeof(stop_cb_type)]; 101   alignas(stop_cb_type) unsigned char cb_buf_[sizeof(stop_cb_type)];
102   bool cb_active_ = false; 102   bool cb_active_ = false;
103   103  
104   /// Construct without a timer, deadline given as an absolute time. 104   /// Construct without a timer, deadline given as an absolute time.
HITCBC 105   4 timeout_awaitable(A&& inner, time_point deadline) 105   4 timeout_awaitable(A&& inner, time_point deadline)
HITCBC 106   4 : inner_(std::move(inner)) 106   4 : inner_(std::move(inner))
HITCBC 107   4 , deadline_(deadline) 107   4 , deadline_(deadline)
108   { 108   {
HITCBC 109   4 } 109   4 }
110   110  
111   /// Construct without a timer, deadline measured from suspension. 111   /// Construct without a timer, deadline measured from suspension.
HITCBC 112   2055 timeout_awaitable(A&& inner, std::chrono::nanoseconds dur) 112   2055 timeout_awaitable(A&& inner, std::chrono::nanoseconds dur)
HITCBC 113   2055 : inner_(std::move(inner)) 113   2055 : inner_(std::move(inner))
HITCBC 114   2055 , dur_(dur) 114   2055 , dur_(dur)
HITCBC 115   2055 , has_deadline_(false) 115   2055 , has_deadline_(false)
116   { 116   {
HITCBC 117   2055 } 117   2055 }
118   118  
HITCBC 119   4120 ~timeout_awaitable() 119   4120 ~timeout_awaitable()
120   { 120   {
HITCBC 121   4120 destroy_parent_cb(); 121   4120 destroy_parent_cb();
HITCBC 122   4120 } 122   4120 }
123   123  
124   // Only moved before await_suspend, when cb_active_ is false 124   // Only moved before await_suspend, when cb_active_ is false
HITCBC 125   2061 timeout_awaitable(timeout_awaitable&& o) noexcept( 125   2061 timeout_awaitable(timeout_awaitable&& o) noexcept(
126   std::is_nothrow_move_constructible_v<A>) 126   std::is_nothrow_move_constructible_v<A>)
HITCBC 127   2061 : inner_(std::move(o.inner_)) 127   2061 : inner_(std::move(o.inner_))
HITCBC 128   2061 , timer_(std::move(o.timer_)) 128   2061 , timer_(std::move(o.timer_))
HITCBC 129   2061 , deadline_(o.deadline_) 129   2061 , deadline_(o.deadline_)
HITCBC 130   2061 , dur_(o.dur_) 130   2061 , dur_(o.dur_)
HITCBC 131   2061 , has_deadline_(o.has_deadline_) 131   2061 , has_deadline_(o.has_deadline_)
HITCBC 132   2061 , stop_src_(std::move(o.stop_src_)) 132   2061 , stop_src_(std::move(o.stop_src_))
133   { 133   {
HITCBC 134   2061 } 134   2061 }
135   135  
136   timeout_awaitable(timeout_awaitable const&) = delete; 136   timeout_awaitable(timeout_awaitable const&) = delete;
137   timeout_awaitable& operator=(timeout_awaitable const&) = delete; 137   timeout_awaitable& operator=(timeout_awaitable const&) = delete;
138   timeout_awaitable& operator=(timeout_awaitable&&) = delete; 138   timeout_awaitable& operator=(timeout_awaitable&&) = delete;
139   139  
140   // Forwarding here is load-bearing, not an optimization: awaitables 140   // Forwarding here is load-bearing, not an optimization: awaitables
141   // may perform setup in await_ready (type-erased stream wrappers 141   // may perform setup in await_ready (type-erased stream wrappers
142   // construct their cached inner op there), so the full awaiter 142   // construct their cached inner op there), so the full awaiter
143   // protocol must reach inner_ before await_suspend is driven. An 143   // protocol must reach inner_ before await_suspend is driven. An
144   // already-ready inner op also skips arming the timer entirely. 144   // already-ready inner op also skips arming the timer entirely.
HITCBC 145   2057 bool await_ready() 145   2057 bool await_ready()
146   { 146   {
HITCBC 147   2057 return inner_.await_ready(); 147   2057 return inner_.await_ready();
148   } 148   }
149   149  
HITCBC 150   2055 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env) 150   2055 auto await_suspend(std::coroutine_handle<> h, capy::io_env const* env)
151   { 151   {
HITCBC 152   2055 parent_token_ = env->stop_token; 152   2055 parent_token_ = env->stop_token;
153   153  
154   // The deadline timer is built here from the awaiting 154   // The deadline timer is built here from the awaiting
155   // coroutine's executor context, the first point at which it 155   // coroutine's executor context, the first point at which it
156   // is known. await_suspend is driven through a noexcept 156   // is known. await_suspend is driven through a noexcept
157   // wrapper, so a failure cannot be surfaced as a catchable 157   // wrapper, so a failure cannot be surfaced as a catchable
158   // exception. An executor whose context is not an io_context 158   // exception. An executor whose context is not an io_context
159   // cannot supply a timer service; silently running the 159   // cannot supply a timer service; silently running the
160   // operation with no deadline would be a worse failure than 160   // operation with no deadline would be a worse failure than
161   // aborting, so translate the service-lookup error into a 161   // aborting, so translate the service-lookup error into a
162   // clear precondition diagnostic. This terminates by design 162   // clear precondition diagnostic. This terminates by design
163   // (a usage error) rather than dropping the requested timeout. 163   // (a usage error) rather than dropping the requested timeout.
164   // The detached timeout coroutine must own its executor by 164   // The detached timeout coroutine must own its executor by
165   // value (see timeout_coro::set_env_owned); io_env carries 165   // value (see timeout_coro::set_env_owned); io_env carries
166   // only a non-owning executor_ref. Recover the concrete 166   // only a non-owning executor_ref. Recover the concrete
167   // executor from the context rather than the executor_ref: 167   // executor from the context rather than the executor_ref:
168   // wrapped executors (a strand over the io_context) satisfy 168   // wrapped executors (a strand over the io_context) satisfy
169   // the documented precondition but do not expose the io 169   // the documented precondition but do not expose the io
170   // executor as their target. The timer construction below 170   // executor as their target. The timer construction below
171   // validates the context is an io_context, and the detached 171   // validates the context is an io_context, and the detached
172   // coroutine shares only the thread-safe stop_source with 172   // coroutine shares only the thread-safe stop_source with
173   // the caller, so resuming it on the raw io executor instead 173   // the caller, so resuming it on the raw io executor instead
174   // of the caller's wrapper is safe. 174   // of the caller's wrapper is safe.
175   try 175   try
176   { 176   {
HITCBC 177   2055 timer_.emplace(env->executor.context()); 177   2055 timer_.emplace(env->executor.context());
178   } 178   }
HITCBC 179   4 catch (std::logic_error const&) 179   4 catch (std::logic_error const&)
180   { 180   {
HITCBC 181   2 throw_logic_error( 181   2 throw_logic_error(
182   "timeout requires an io_context-backed executor"); 182   "timeout requires an io_context-backed executor");
183   } 183   }
184   auto ex = static_cast<io_context&>( 184   auto ex = static_cast<io_context&>(
HITCBC 185   2053 env->executor.context()).get_executor(); 185   2053 env->executor.context()).get_executor();
186   186  
HITCBC 187   2053 if (has_deadline_) 187   2053 if (has_deadline_)
HITCBC 188   4 timer_->expires_at(deadline_); 188   4 timer_->expires_at(deadline_);
189   else 189   else
HITCBC 190   2049 timer_->expires_after(dur_); 190   2049 timer_->expires_after(dur_);
191   191  
192   // Launch fire-and-forget timeout (starts suspended) 192   // Launch fire-and-forget timeout (starts suspended)
HITCBC 193   2053 auto timeout = make_timeout(*timer_, stop_src_); 193   2053 auto timeout = make_timeout(*timer_, stop_src_);
HITCBC 194   4106 timeout.h_.promise().set_env_owned( 194   4106 timeout.h_.promise().set_env_owned(
HITCBC 195   2053 ex, stop_src_.get_token(), env->frame_allocator); 195   2053 ex, stop_src_.get_token(), env->frame_allocator);
196   // Runs synchronously until timer.wait() suspends 196   // Runs synchronously until timer.wait() suspends
HITCBC 197   2053 timeout.h_.resume(); 197   2053 timeout.h_.resume();
198   // timeout goes out of scope; destructor is a no-op, 198   // timeout goes out of scope; destructor is a no-op,
199   // the coroutine self-destroys via suspend_never 199   // the coroutine self-destroys via suspend_never
200   200  
201   // Forward parent cancellation 201   // Forward parent cancellation
HITCBC 202   2053 new (cb_buf_) stop_cb_type(env->stop_token, stop_forwarder{&stop_src_}); 202   2053 new (cb_buf_) stop_cb_type(env->stop_token, stop_forwarder{&stop_src_});
HITCBC 203   2053 cb_active_ = true; 203   2053 cb_active_ = true;
204   204  
205   // Start the inner op with our interposed stop_token 205   // Start the inner op with our interposed stop_token
HITCBC 206   2053 inner_env_ = { 206   2053 inner_env_ = {
HITCBC 207   2053 env->executor, stop_src_.get_token(), env->frame_allocator}; 207   2053 env->executor, stop_src_.get_token(), env->frame_allocator};
HITCBC 208   4106 return inner_.await_suspend(h, &inner_env_); 208   4106 return inner_.await_suspend(h, &inner_env_);
HITCBC 209   2053 } 209   2053 }
210   210  
HITCBC 211   2053 decltype(auto) await_resume() 211   2053 decltype(auto) await_resume()
212   { 212   {
213   // Read before request_stop: afterwards stop_requested() 213   // Read before request_stop: afterwards stop_requested()
214   // can no longer distinguish who fired first. This must also 214   // can no longer distinguish who fired first. This must also
215   // happen before inner_.await_resume() rather than after: when 215   // happen before inner_.await_resume() rather than after: when
216   // the inner awaitable is itself a timeout_awaitable (nested 216   // the inner awaitable is itself a timeout_awaitable (nested
217   // timeout()), our own request_stop() below is visible through 217   // timeout()), our own request_stop() below is visible through
218   // its parent_token_ (aliasing our stop_src_), and would 218   // its parent_token_ (aliasing our stop_src_), and would
219   // otherwise make its read of "parent" look like a 219   // otherwise make its read of "parent" look like a
220   // cancellation that never happened. 220   // cancellation that never happened.
HITCBC 221   2053 bool const parent = parent_token_.stop_requested(); 221   2053 bool const parent = parent_token_.stop_requested();
HITCBC 222   2053 bool const fired = stop_src_.stop_requested(); 222   2053 bool const fired = stop_src_.stop_requested();
223   223  
224   // If inner_.await_resume() throws below, request_stop() is 224   // If inner_.await_resume() throws below, request_stop() is
225   // skipped; the still-armed timeout coroutine is then drained 225   // skipped; the still-armed timeout coroutine is then drained
226   // by timer_'s destructor rather than by us. 226   // by timer_'s destructor rather than by us.
HITCBC 227   2053 auto r = inner_.await_resume(); 227   2053 auto r = inner_.await_resume();
228   228  
229   // Cancel whichever is still pending (idempotent) 229   // Cancel whichever is still pending (idempotent)
HITCBC 230   2051 stop_src_.request_stop(); 230   2051 stop_src_.request_stop();
HITCBC 231   2051 destroy_parent_cb(); 231   2051 destroy_parent_cb();
232   232  
233   // Deadline won: stop_src_ is assumed to be the only 233   // Deadline won: stop_src_ is assumed to be the only
234   // cancellation source, whose only writers are the timer 234   // cancellation source, whose only writers are the timer
235   // coroutine and the parent forwarder, so fired && !parent 235   // coroutine and the parent forwarder, so fired && !parent
236   // identifies a timeout. A third-party cancellation of the 236   // identifies a timeout. A third-party cancellation of the
237   // inner op (e.g. a socket cancel issued from elsewhere) 237   // inner op (e.g. a socket cancel issued from elsewhere)
238   // landing in the same window as the deadline firing is 238   // landing in the same window as the deadline firing is
239   // reported as a timeout. 239   // reported as a timeout.
HITCBC 240   2075 if (fired && !parent && 240   2075 if (fired && !parent &&
HITCBC 241   2075 r.ec == capy::cond::canceled) 241   2075 r.ec == capy::cond::canceled)
242   { 242   {
HITCBC 243   24 std::remove_cvref_t<decltype(r)> t{}; 243   24 std::remove_cvref_t<decltype(r)> t{};
HITCBC 244   24 t.ec = make_error_code(capy::error::timeout); 244   24 t.ec = make_error_code(capy::error::timeout);
HITCBC 245   24 return t; 245   24 return t;
246   } 246   }
HITCBC 247   2027 return r; 247   2027 return r;
248   } 248   }
249   249  
HITCBC 250   6171 void destroy_parent_cb() noexcept 250   6171 void destroy_parent_cb() noexcept
251   { 251   {
HITCBC 252   6171 if (cb_active_) 252   6171 if (cb_active_)
253   { 253   {
HITCBC 254   2053 std::launder(reinterpret_cast<stop_cb_type*>(cb_buf_)) 254   2053 std::launder(reinterpret_cast<stop_cb_type*>(cb_buf_))
HITCBC 255   2053 ->~stop_cb_type(); 255   2053 ->~stop_cb_type();
HITCBC 256   2053 cb_active_ = false; 256   2053 cb_active_ = false;
257   } 257   }
HITCBC 258   6171 } 258   6171 }
259   }; 259   };
260   260  
261   } // namespace boost::corosio::detail 261   } // namespace boost::corosio::detail
262   262  
263   #endif 263   #endif