{"id":108402,"date":"2023-07-07T07:00:00","date_gmt":"2023-07-07T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=108402"},"modified":"2023-06-19T07:40:43","modified_gmt":"2023-06-19T14:40:43","slug":"20230707-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20230707-00\/?p=108402\/","title":{"rendered":"How to wait for multiple C++ coroutines to complete before propagating failure, finding the awaiter"},"content":{"rendered":"

Last time, we wrapped an object that was its own awaiter<\/a>. In general, though, we may have to find the awaiter.<\/p>\n

Fortunately, we already wrote a helper class that can find an awaiter. Let’s bring it back, but with a little change to the get_awaiter<\/code> function.<\/p>\n

class awaiter_finder\r\n{\r\n    template<typename T>\r\n    static void find_co_await_member(T&&, ...);\r\n    template<typename T>\r\n    static auto find_co_await_member(T&& value, int)\r\n    -> std::decay_t<<\/span>decltype(static_cast<T&&>(value).operator co_await())><\/span> {\r\n        return static_cast<T&&>(value).operator co_await();\r\n    }\r\n    template<typename T>\r\n    using member_awaiter = decltype(find_co_await_member(std::declval<T>(), 0));\r\n\r\n    template<typename T>\r\n    static void find_co_await_free(T&&, ...);\r\n    template<typename T>\r\n    static auto find_co_await_free(T&& value, int)\r\n    -> std::decay_t<<\/span>decltype(operator co_await(static_cast<T&&>(value)))><\/span> {\r\n    return operator co_await(static_cast<T&&>(value));\r\n    }\r\n    template<typename T>\r\n    using free_awaiter = decltype(find_co_await_free(std::declval<T>(), 0));\r\n\r\npublic:\r\n    template<typename T>\r\n    static decltype(auto)<\/span> get_awaiter(T&& value)\r\n    {\r\n        if constexpr (!std::is_same_v<member_awaiter<T>, void>) {\r\n            return find_co_await_member(static_cast<T&&>(value), 0);\r\n        } else if constexpr (!std::is_same_v<free_awaiter<T>, void>) {\r\n            return find_co_await_free(static_cast<T&&>(value), 0);\r\n        } else {\r\n            return std::forward<T>(value);<\/span>\r\n        }\r\n    }\r\n\r\n    template<typename T>\r\n    using type = decltype(get_awaiter(std::declval<T>()));\r\n};\r\n<\/pre>\n
In the case where the object is its own awaiter, we want get_awaiter()<\/code> to return a reference to the object itself. This means that we need to change the return type of get_awaiter()<\/code> to decltype(auto)<\/code> so that it will infer a reference when we return value<\/code>.<\/p>\n
But that means that it will also infer a reference from find_co_await_member<\/code> and find_co_await_free<\/code>, so we have to std::decay_t<\/code> those return types to remove any reference or cv-qualifiers.<\/p>\n
We can use this helper to teach our wrapped_awaitable<\/code> how to find the awaiter.<\/p>\n
template<typename Inner>\r\nstruct wrapped_awaitable\r\n{\r\n    wrapped_awaitable(Inner& inner) :\r\n    m_awaiter(awaiter_finder::get_awaiter(std::move(inner)))<\/span> {}\r\n\r\n    typename awaiter_finder::type<Inner> m_awaiter;<\/span>\r\n    std::exception_ptr m_eptr;\r\n\r\n    bool await_ready() try\r\n    { return m_awaiter<\/span>.await_ready(); }\r\n    catch (...) {\r\n        m_eptr = std::current_exception();\r\n        return true;\r\n    }\r\n\r\n    template<typename Handle>\r\n    std::coroutine_handle<>\r\n    await_suspend(Handle handle) try {\r\n        using Ret = decltype(m_awaiter<\/span>.await_suspend(handle));\r\n        if constexpr (std::is_same_v<void, Ret>) {\r\n            m_awaiter<\/span>.await_suspend(handle);\r\n            return std::noop_coroutine();\r\n        } else if constexpr (std::is_same_v<bool, Ret>) {\r\n            return m_awaiter<\/span>.await_suspend(handle) ? \r\n                static_cast<std::coroutine_handle<>>(\r\n                    std::noop_coroutine()) :\r\n                handle;\r\n        } else {\r\n            return m_awaiter<\/span>.await_suspend(handle);\r\n        }\r\n    } catch (...) {\r\n        m_eptr = std::current_exception();\r\n        return handle;\r\n    }\r\n\r\n    std::exception_ptr await_resume() try {\r\n        if (m_eptr) return m_eptr;\r\n        m_awaiter<\/span>.await_resume();\r\n        return nullptr;\r\n    } catch (...) {\r\n        return std::current_exception();\r\n    }\r\n};\r\n\r\ntemplate<typename... T>\r\nIAsyncAction when_all_complete(T... asyncs)\r\n{\r\n    std::exception_ptr eptr;\r\n\r\n    auto accumulate = [&](std::exception_ptr e) {\r\n        if (eptr == nullptr) eptr = e;\r\n    };\r\n\r\n    (accumulate(co_await wrapped_awaitable(asyncs)), ...);\r\n\r\n    if (eptr) std::rethrow_exception(eptr);\r\n}\r\n<\/pre>\n
Now that we have a wrapped_awaitable<\/code> that completes with a std::exception_ptr<\/code>, we have reduced the problem to the case way at the start of this series where we have a bunch of items, all of the same type, so we can put them in an initializer_list<\/code> and use standard algorithms with them.<\/p>\n
template<typename... T>\r\nIAsyncAction when_all_complete(T... asyncs)\r\n{\r\n    auto results = { co_await wrapped_awaitable(asyncs))... };\r\n    auto it = std::find_if(results.begin(), results.end(),\r\n        [](auto&& eptr) { return eptr; });\r\n    if (it != results.end()) std::rethrow_exception(*it);\r\n}\r\n<\/pre>\n
However, this misses an edge case: If you call when_all_complete<\/code> with no parameters, the compiler cannot deduce results<\/code> from what ends up being an empty set of braces. So we’ll have to provide an explicit type for it.<\/p>\n
template<typename... T>\r\nIAsyncAction when_all_complete(T... asyncs)\r\n{\r\n    std::initializer_list<std::exception_ptr><\/span>\r\n        results = { co_await wrapped_awaitable(asyncs))... };\r\n    auto it = std::find_if(results.begin(), results.end(),\r\n        [](auto&& eptr) { return eptr; });\r\n    if (it != results.end()) std::rethrow_exception(*it);\r\n}\r\n<\/pre>\n
Okay, we finally did it: We wrote a when_all_complete<\/code> which runs all of the awaitables to completion.\u00b9 If any of the awaitables throws an exception, then the first such exception is reported.<\/p>\n
We’ll wrap up with some final thoughts next time.<\/p>\n
\u00b9 Now, if any of the awaitables throws in its awaiter because it is unable to await at all, then we won’t wait for completion after all because the awaiter failed at its job. But we have no way of knowing whether any exception that is thrown from the awaiter means “I awaited successfully, and it completed in a failure state”, or whether it means “I couldn’t even await!” We just have to do the best we can with the information we have. At least we fulfilled our end of the deal: We did wait for the awaitable to run to completion. If it decided to report failure before finishing its work, that’s the awaitable’s problem.<\/p>\n","protected":false},"excerpt":{"rendered":"
Making sure to wrap the right thing.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-108402","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Making sure to wrap the right thing.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108402","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=108402"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/108402\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=108402"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=108402"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=108402"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}