1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
/*
* Copyright (C) 2024 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <coroutine>
#include <wtf/CompletionHandler.h>
namespace WTF {
template<typename PromiseType>
class CoroutineHandle {
public:
CoroutineHandle() = default;
CoroutineHandle(std::coroutine_handle<PromiseType>&& handle)
: m_handle(std::exchange(handle, nullptr)) { }
CoroutineHandle(CoroutineHandle&& other)
: m_handle(std::exchange(other.m_handle, nullptr)) { }
CoroutineHandle& operator=(CoroutineHandle&& other)
{
m_handle = std::exchange(other.m_handle, nullptr);
return *this;
}
CoroutineHandle(const CoroutineHandle&) = delete;
CoroutineHandle& operator=(const CoroutineHandle&) = delete;
~CoroutineHandle()
{
if (m_handle)
m_handle.destroy();
}
std::coroutine_handle<PromiseType> handle() const { return m_handle; }
private:
std::coroutine_handle<PromiseType> m_handle;
};
template<typename T>
class [[nodiscard]] Awaitable {
WTF_FORBID_HEAP_ALLOCATION;
public:
class PromiseBase {
WTF_DEPRECATED_MAKE_FAST_ALLOCATED(PromiseBase);
public:
struct final_awaitable {
WTF_FORBID_HEAP_ALLOCATION;
public:
bool await_ready() const noexcept { return false; }
template<typename Promise>
std::coroutine_handle<> await_suspend(std::coroutine_handle<Promise> coroutine) noexcept { return coroutine.promise().handle(); }
void await_resume() noexcept { }
};
std::suspend_always initial_suspend() { return { }; }
final_awaitable final_suspend() noexcept { return { }; }
template<typename Promise>
void unhandled_exception() { }
void setHandle(std::coroutine_handle<> handle) { m_handle = handle; }
std::coroutine_handle<> handle() { return m_handle; }
private:
std::coroutine_handle<> m_handle;
};
template<typename U>
class Promise final : public PromiseBase {
public:
Awaitable<U> get_return_object() { return Awaitable<U> { std::coroutine_handle<Promise>::from_promise(*this) }; }
void return_value(U&& value) { m_value = WTFMove(value); }
U result() && { return std::exchange(m_value, { }); }
private:
U m_value;
};
template<std::same_as<void> U>
class Promise<U> : public PromiseBase {
public:
Awaitable<void> get_return_object() { return Awaitable<void> { std::coroutine_handle<Promise>::from_promise(*this) }; }
void return_void() { }
void result() { }
};
using promise_type = Promise<T>;
class AwaitableHelper {
WTF_FORBID_HEAP_ALLOCATION;
public:
AwaitableHelper(std::coroutine_handle<promise_type> coroutine)
: m_coroutine(coroutine) { }
bool await_ready() const { return m_coroutine.done(); }
std::coroutine_handle<> await_suspend(std::coroutine_handle<> handle)
{
m_coroutine.promise().setHandle(handle);
return m_coroutine;
}
T await_resume() { return WTFMove(this->m_coroutine.promise()).result(); }
private:
std::coroutine_handle<promise_type> m_coroutine;
};
Awaitable(std::coroutine_handle<promise_type> coroutine)
: m_coroutine(std::exchange(coroutine, nullptr)) { }
AwaitableHelper operator co_await() const { return { m_coroutine.handle() }; }
private:
CoroutineHandle<promise_type> m_coroutine;
};
struct Task {
WTF_FORBID_HEAP_ALLOCATION;
public:
struct promise_type {
WTF_DEPRECATED_MAKE_STRUCT_FAST_ALLOCATED(promise_type);
Task get_return_object() { return { }; }
std::suspend_never initial_suspend() { return { }; }
std::suspend_never final_suspend() noexcept { return { }; }
void unhandled_exception() { }
void return_void() { }
};
};
template<typename T> class [[nodiscard]] AwaitableFromCompletionHandler {
WTF_FORBID_HEAP_ALLOCATION;
public:
using Callback = CompletionHandler<void(CompletionHandler<void(T&&)>)>;
AwaitableFromCompletionHandler(Callback&& callback)
: m_callback(WTFMove(callback)) { }
bool await_ready() const { return !!m_result; }
void await_suspend(std::coroutine_handle<> handle)
{
m_callback([this, handle] (T&& result) mutable {
m_result = WTFMove(result);
handle();
});
}
T await_resume() { return *std::exchange(m_result, { }); }
private:
Callback m_callback;
std::optional<T> m_result;
};
template<> class [[nodiscard]] AwaitableFromCompletionHandler<void> {
WTF_FORBID_HEAP_ALLOCATION;
public:
using Callback = CompletionHandler<void(CompletionHandler<void(void)>)>;
AwaitableFromCompletionHandler(Callback&& callback)
: m_callback(WTFMove(callback)) { }
bool await_ready() const { return !m_callback; }
void await_suspend(std::coroutine_handle<> handle)
{
m_callback([handle] {
handle();
});
}
void await_resume() { }
private:
Callback m_callback;
};
}
using WTF::Awaitable;
using WTF::AwaitableFromCompletionHandler;
using WTF::CoroutineHandle;
using WTF::Task;
|