Add calls to update resume_point

Add calls to update `resume_point` variable with location of
next resume location to all `await_suspend` functions and `then`
functions.

Author: Radosław Cybulski

include/seastar/core/coroutine.hh

@@ -30,6 +30,7 @@
 
 #ifndef SEASTAR_MODULE
 #include <coroutine>
+#include <source_location>
 #endif
 
 namespace seastar {
@@ -144,7 +145,8 @@ public:
     }
 
     template<typename U>
-    void await_suspend(std::coroutine_handle<U> hndl) noexcept {
+    void await_suspend(std::coroutine_handle<U> hndl, std::source_location sl = std::source_location::current()) noexcept {
+        hndl.promise().update_resume_point(sl);
         if (!CheckPreempt || !_future.available()) {
             _future.set_coroutine(hndl.promise());
         } else {
@@ -169,7 +171,8 @@ public:
     }
 
     template<typename U>
-    void await_suspend(std::coroutine_handle<U> hndl) noexcept {
+    void await_suspend(std::coroutine_handle<U> hndl, std::source_location sl = std::source_location::current()) noexcept {
+        hndl.promise().update_resume_point(sl);
         if (!CheckPreempt || !_future.available()) {
             _future.set_coroutine(hndl.promise());
         } else {

include/seastar/core/future.hh

@@ -31,6 +31,7 @@
 #include <stdexcept>
 #include <type_traits>
 #include <utility>
+#include <source_location>
 #endif
 
 #include <seastar/core/task.hh>
@@ -1231,13 +1232,14 @@ private:
         future_base::schedule(tws, &tws->_state);
     }
     template <typename Pr, typename Func, typename Wrapper>
-    void schedule(Pr&& pr, Func&& func, Wrapper&& wrapper) noexcept {
+    void schedule(Pr&& pr, Func&& func, Wrapper&& wrapper, std::source_location sl) noexcept {
         // If this new throws a std::bad_alloc there is nothing that
         // can be done about it. The corresponding future is not ready
         // and we cannot break the chain. Since this function is
         // noexcept, it will call std::terminate if new throws.
         memory::scoped_critical_alloc_section _;
         auto tws = new continuation<Pr, Func, Wrapper, T>(std::move(pr), std::move(func), std::move(wrapper));
+        tws->update_resume_point(sl);
         // In a debug build we schedule ready futures, but not in
         // other build modes.
 #ifdef SEASTAR_DEBUG
@@ -1355,9 +1357,9 @@ public:
     requires std::invocable<Func, T>
                  || (std::same_as<void, T> && std::invocable<Func>)
     Result
-    then(Func&& func) noexcept {
+    then(Func&& func, std::source_location sl = std::source_location::current()) noexcept {
 #ifndef SEASTAR_TYPE_ERASE_MORE
-        return then_impl(std::move(func));
+        return then_impl(std::move(func), sl);
 #else
         using func_type = typename internal::future_result<Func, T>::func_type;
         noncopyable_function<func_type> ncf;
@@ -1367,7 +1369,7 @@ public:
                 return futurize_invoke(func, std::forward<decltype(args)>(args)...);
             });
         }
-        return then_impl(std::move(ncf));
+        return then_impl(std::move(ncf), sl);
 #endif
     }
 
@@ -1393,18 +1395,18 @@ public:
     template <typename Func, typename Result = futurize_t<internal::result_of_apply_t<Func, T>>>
     requires ::seastar::CanApplyTuple<Func, T>
     Result
-    then_unpack(Func&& func) noexcept {
+    then_unpack(Func&& func, std::source_location sl = std::source_location::current()) noexcept {
         return then([func = std::forward<Func>(func)] (T&& tuple) mutable {
             // sizeof...(tuple) is required to be 1
             return std::apply(func, std::move(tuple));
-        });
+        }, sl);
     }
 
 private:
 
     // Keep this simple so that Named Return Value Optimization is used.
     template <typename Func, typename Result>
-    Result then_impl_nrvo(Func&& func) noexcept {
+    Result then_impl_nrvo(Func&& func, std::source_location sl) noexcept {
         using futurator = futurize<internal::future_result_t<Func, T>>;
         typename futurator::type fut(future_for_get_promise_marker{});
         using pr_type = decltype(fut.get_promise());
@@ -1419,13 +1421,13 @@ private:
                     return internal::future_invoke(func, std::move(state).get_value());
                 });
             }
-        });
+        }, sl);
         return fut;
     }
 
     template <typename Func, typename Result = futurize_t<internal::future_result_t<Func, T>>>
     Result
-    then_impl(Func&& func) noexcept {
+    then_impl(Func&& func, std::source_location sl) noexcept {
 #ifndef SEASTAR_DEBUG
         using futurator = futurize<internal::future_result_t<Func, T>>;
         if (failed()) {
@@ -1434,7 +1436,7 @@ private:
             return futurator::invoke(std::forward<Func>(func), get_available_state_ref().take_value());
         }
 #endif
-        return then_impl_nrvo<Func, Result>(std::forward<Func>(func));
+        return then_impl_nrvo<Func, Result>(std::forward<Func>(func), sl);
     }
 
 public:
@@ -1455,23 +1457,23 @@ public:
     ///         to the eventual value of this future.
     template <std::invocable<future> Func, typename FuncResult = std::invoke_result_t<Func, future>>
     futurize_t<FuncResult>
-    then_wrapped(Func&& func) & noexcept {
-        return then_wrapped_maybe_erase<false, FuncResult>(std::forward<Func>(func));
+    then_wrapped(Func&& func, std::source_location sl = std::source_location::current()) & noexcept {
+        return then_wrapped_maybe_erase<false, FuncResult>(std::forward<Func>(func), sl);
     }
 
     template <std::invocable<future&&> Func, typename FuncResult = std::invoke_result_t<Func, future&&>>
     futurize_t<FuncResult>
-    then_wrapped(Func&& func) && noexcept {
-        return then_wrapped_maybe_erase<true, FuncResult>(std::forward<Func>(func));
+    then_wrapped(Func&& func, std::source_location sl = std::source_location::current()) && noexcept {
+        return then_wrapped_maybe_erase<true, FuncResult>(std::forward<Func>(func), sl);
     }
 
 private:
 
     template <bool AsSelf, typename FuncResult, typename Func>
     futurize_t<FuncResult>
-    then_wrapped_maybe_erase(Func&& func) noexcept {
+    then_wrapped_maybe_erase(Func&& func, std::source_location sl) noexcept {
 #ifndef SEASTAR_TYPE_ERASE_MORE
-        return then_wrapped_common<AsSelf, FuncResult>(std::forward<Func>(func));
+        return then_wrapped_common<AsSelf, FuncResult>(std::forward<Func>(func), sl);
 #else
         using futurator = futurize<FuncResult>;
         using WrapFuncResult = typename futurator::type;
@@ -1482,29 +1484,29 @@ private:
                 return futurator::invoke(func, std::move(f));
             });
         }
-        return then_wrapped_common<AsSelf, WrapFuncResult>(std::move(ncf));
+        return then_wrapped_common<AsSelf, WrapFuncResult>(std::move(ncf), sl);
 #endif
     }
 
     // Keep this simple so that Named Return Value Optimization is used.
     template <typename FuncResult, typename Func>
     futurize_t<FuncResult>
-    then_wrapped_nrvo(Func&& func) noexcept {
+    then_wrapped_nrvo(Func&& func, std::source_location sl) noexcept {
         using futurator = futurize<FuncResult>;
         typename futurator::type fut(future_for_get_promise_marker{});
         using pr_type = decltype(fut.get_promise());
         schedule(fut.get_promise(), std::move(func), [](pr_type&& pr, Func& func, future_state&& state) {
             futurator::satisfy_with_result_of(std::move(pr), [&func, &state] {
                 return func(future(std::move(state)));
             });
-        });
+        }, sl);
         return fut;
     }
 
 
     template <bool AsSelf, typename FuncResult, typename Func>
     futurize_t<FuncResult>
-    then_wrapped_common(Func&& func) noexcept {
+    then_wrapped_common(Func&& func, std::source_location sl) noexcept {
 #ifndef SEASTAR_DEBUG
         using futurator = futurize<FuncResult>;
         if (available()) {
@@ -1518,7 +1520,7 @@ private:
             }
         }
 #endif
-        return then_wrapped_nrvo<FuncResult, Func>(std::forward<Func>(func));
+        return then_wrapped_nrvo<FuncResult, Func>(std::forward<Func>(func), sl);
     }
 
     void forward_to(internal::promise_base_with_type<T>&& pr) noexcept {
@@ -1570,8 +1572,8 @@ public:
      * nested will be propagated.
      */
     template <std::invocable Func>
-    future<T> finally(Func&& func) noexcept {
-        return then_wrapped(finally_body<Func, is_future<std::invoke_result_t<Func>>::value>(std::forward<Func>(func)));
+    future<T> finally(Func&& func, std::source_location sl = std::source_location::current()) noexcept {
+        return then_wrapped(finally_body<Func, is_future<std::invoke_result_t<Func>>::value>(std::forward<Func>(func)), sl);
     }
 
 
@@ -1617,24 +1619,24 @@ public:
     ///
     /// Terminates the entire program is this future resolves
     /// to an exception.  Use with caution.
-    future<> or_terminate() noexcept {
+    future<> or_terminate(std::source_location sl = std::source_location::current()) noexcept {
         return then_wrapped([] (auto&& f) {
             try {
                 f.get();
             } catch (...) {
                 engine_exit(std::current_exception());
             }
-        });
+        }, sl);
     }
 
     /// \brief Discards the value carried by this future.
     ///
     /// Converts the future into a no-value \c future<>, by
     /// ignoring any result.  Exceptions are propagated unchanged.
-    future<> discard_result() noexcept {
+    future<> discard_result(std::source_location sl = std::source_location::current()) noexcept {
         // We need the generic variadic lambda, below, because then() behaves differently
         // when value_type is when_all_succeed_tuple
-        return then([] (auto&&...) {});
+        return then([] (auto&&...) {}, sl);
     }
 
     /// \brief Handle the exception carried by this future.
@@ -1655,15 +1657,15 @@ public:
                     || (std::tuple_size_v<tuple_type> == 0 && std::is_invocable_r_v<void, Func, std::exception_ptr>)
                     || (std::tuple_size_v<tuple_type> == 1 && std::is_invocable_r_v<T, Func, std::exception_ptr>)
                     || (std::tuple_size_v<tuple_type> > 1 && std::is_invocable_r_v<tuple_type ,Func, std::exception_ptr>)
-    future<T> handle_exception(Func&& func) noexcept {
+    future<T> handle_exception(Func&& func, std::source_location sl = std::source_location::current()) noexcept {
         return then_wrapped([func = std::forward<Func>(func)]
                              (auto&& fut) mutable -> future<T> {
             if (!fut.failed()) {
                 return make_ready_future<T>(fut.get());
             } else {
                 return futurize_invoke(func, fut.get_exception());
             }
-        });
+        }, sl);
     }
 
     /// \brief Handle the exception of a certain type carried by this future.
@@ -1677,7 +1679,7 @@ public:
     /// If exception, that future holds, does not match func parameter type
     /// it is propagated as is.
     template <typename Func>
-    future<T> handle_exception_type(Func&& func) noexcept {
+    future<T> handle_exception_type(Func&& func, std::source_location sl = std::source_location::current()) noexcept {
         using trait = function_traits<Func>;
         static_assert(trait::arity == 1, "func can take only one parameter");
         using ex_type = typename trait::template arg<0>::type;
@@ -1688,7 +1690,7 @@ public:
             } catch(ex_type& ex) {
                 return futurize_invoke(func, ex);
             }
-        });
+        }, sl);
     }
 
     /// \brief Ignore any result hold by this future

include/seastar/coroutine/all.hh

@@ -161,7 +161,9 @@ private:
                 return (... && futures.available());
             }, state._futures);
         }
-        void await_suspend(coroutine_handle_t h) {
+        template <typename U>
+        void await_suspend(std::coroutine_handle<U> h, std::source_location sl = std::source_location::current()) {
+            h.promise().update_resume_point(sl);
             when_ready = h;
             process<0>();
         }

include/seastar/coroutine/as_future.hh

@@ -22,6 +22,7 @@
 #pragma once
 
 #include <seastar/core/coroutine.hh>
+#include <source_location>
 
 namespace seastar {
 
@@ -42,7 +43,8 @@ public:
     }
 
     template<typename U>
-    void await_suspend(std::coroutine_handle<U> hndl) noexcept {
+    void await_suspend(std::coroutine_handle<U> hndl, std::source_location sl = std::source_location::current()) noexcept {
+        hndl.promise().update_resume_point(sl);
         if (!CheckPreempt || !_future.available()) {
             _future.set_coroutine(hndl.promise());
         } else {

include/seastar/coroutine/exception.hh

@@ -24,6 +24,7 @@
 #include <seastar/core/future.hh>
 #include <coroutine>
 #include <exception>
+#include <source_location>
 
 namespace seastar {
 
@@ -42,7 +43,8 @@ struct exception_awaiter {
     }
 
     template<typename U>
-    void await_suspend(std::coroutine_handle<U> hndl) noexcept {
+    void await_suspend(std::coroutine_handle<U> hndl, std::source_location sl = std::source_location::current()) noexcept {
+        hndl.promise().update_resume_point(sl);
         hndl.promise().set_exception(std::move(eptr));
         hndl.destroy();
     }

include/seastar/coroutine/generator.hh

@@ -141,7 +141,7 @@ public:
         return _future.available();
     }
 
-    coroutine_handle<> await_suspend(coroutine_handle<promise_type> coro) noexcept;
+    coroutine_handle<> await_suspend(coroutine_handle<promise_type> coro, std::source_location sl = std::source_location::current()) noexcept;
     void await_resume() noexcept { }
 };
 
@@ -260,7 +260,8 @@ public:
     }
 
     template<typename Promise>
-    void await_suspend(coroutine_handle<Promise> coro) noexcept {
+    void await_suspend(coroutine_handle<Promise> coro, std::source_location sl = std::source_location::current()) noexcept {
+        coro.promise().update_resume_point(sl);
         auto& current_task = coro.promise();
         if (_next_value_future.available()) {
             seastar::schedule(&current_task);
@@ -527,7 +528,8 @@ auto generator_buffered_promise<T, Container>::get_return_object() noexcept -> g
 
 template<typename T, template <typename> class Container>
 coroutine_handle<> yield_awaiter<T, Container>::await_suspend(
-    coroutine_handle<generator_buffered_promise<T, Container>> coro) noexcept {
+    coroutine_handle<generator_buffered_promise<T, Container>> coro, std::source_location sl) noexcept {
+    coro.promise().update_resume_point(sl);
     if (_future.available()) {
         auto& current_task = coro.promise();
         seastar::schedule(&current_task);

include/seastar/coroutine/maybe_yield.hh

@@ -35,7 +35,8 @@ struct maybe_yield_awaiter final {
     }
 
     template <typename T>
-    void await_suspend(std::coroutine_handle<T> h) {
+    void await_suspend(std::coroutine_handle<T> h, std::source_location sl = std::source_location::current()) noexcept {
+        h.promise().update_resume_point(sl);
         schedule(&h.promise());
     }
 

include/seastar/coroutine/parallel_for_each.hh

@@ -152,7 +152,8 @@ public:
     }
 
     template<typename T>
-    void await_suspend(std::coroutine_handle<T> h) {
+    void await_suspend(std::coroutine_handle<T> h, std::source_location sl = std::source_location::current()) noexcept {
+        h.promise().update_resume_point(sl);
         _when_ready = h;
         _waiting_task = &h.promise();
         resume_or_set_callback();

include/seastar/coroutine/switch_to.hh

@@ -70,7 +70,8 @@ public:
     }
 
     template<typename T>
-    void await_suspend(std::coroutine_handle<T> hndl) noexcept {
+    void await_suspend(std::coroutine_handle<T> hndl, std::source_location sl = std::source_location::current()) noexcept {
+        hndl.promise().update_resume_point(sl);
         auto& t = hndl.promise();
         t.set_scheduling_group(_switch_to_sg);
         _task = &t;