Skip to content

Rewrite frame_cb tests to avoid coroutine_handle UB #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mvandeberg merged 1 commit into from
Mar 21, 2026
Merged

Rewrite frame_cb tests to avoid coroutine_handle UB #240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 78 additions & 109 deletions test/unit/ex/frame_cb.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
#include <boost/capy/concept/io_awaitable.hpp>
#include <boost/capy/detail/await_suspend_helper.hpp>
#include <boost/capy/ex/io_env.hpp>
#include <boost/capy/ex/run_async.hpp>
#include <boost/capy/ex/thread_pool.hpp>
#include <boost/capy/io_result.hpp>
#include <boost/capy/task.hpp>
#include <boost/capy/test/run_blocking.hpp>

#include "test/unit/test_helpers.hpp"

Expand Down Expand Up @@ -45,10 +48,7 @@ struct frame_cb_test
cb.destroy = +[](detail::frame_cb*) {};
cb.data = &called;

auto h = std::coroutine_handle<>::from_address(
static_cast<void*>(&cb));

h.resume();
cb.resume(&cb);
BOOST_TEST(called);
}

Expand All @@ -63,10 +63,7 @@ struct frame_cb_test
};
cb.data = &destroy_called;

auto h = std::coroutine_handle<>::from_address(
static_cast<void*>(&cb));

h.destroy();
cb.destroy(&cb);
BOOST_TEST(destroy_called);
}

Expand All @@ -81,133 +78,105 @@ struct frame_cb_test
cb.destroy = +[](detail::frame_cb*) {};
cb.data = &value;

auto h = std::coroutine_handle<>::from_address(
static_cast<void*>(&cb));

h.resume();
cb.resume(&cb);
BOOST_TEST_EQ(value, 42);
}

void
testWithIoAwaitable()
// IoAwaitable that resumes synchronously and returns a value
struct sync_awaitable
{
struct test_awaitable
{
int* result;

bool await_ready() const noexcept
{
return false;
}

std::coroutine_handle<>
await_suspend(
std::coroutine_handle<> h,
io_env const*) noexcept
{
h.resume();
return std::noop_coroutine();
}

io_result<> await_resume() noexcept
{
*result = 99;
return {};
}
};

static_assert(IoAwaitable<test_awaitable>);

int result = 0;
bool resumed = false;
int value;

struct state
bool await_ready() const noexcept
{
test_awaitable* aw;
bool* resumed;
};

state st{nullptr, &resumed};
test_awaitable aw{&result};
st.aw = &aw;
return false;
}

detail::frame_cb cb;
cb.resume = +[](detail::frame_cb* p) {
auto* s = static_cast<state*>(p->data);
(void)s->aw->await_resume();
*s->resumed = true;
};
cb.destroy = +[](detail::frame_cb*) {};
cb.data = &st;
std::coroutine_handle<>
await_suspend(
std::coroutine_handle<> h,
io_env const*) noexcept
{
return h;
}

int dispatch_count = 0;
test_executor ex(dispatch_count);
io_env env{ex, {}};
io_result<int> await_resume() noexcept
{
return {std::error_code{}, value};
}
};

auto h = std::coroutine_handle<>::from_address(
static_cast<void*>(&cb));
static_assert(IoAwaitable<sync_awaitable>);

detail::call_await_suspend(&aw, h, &env);
static task<int>
await_sync(int v)
{
auto [ec, result] = co_await sync_awaitable{v};
co_return result;
}

BOOST_TEST(resumed);
void
testWithIoAwaitable()
{
int result = 0;
test::run_blocking(
[&](int v) { result = v; })(
await_sync(99));
BOOST_TEST_EQ(result, 99);
}

void
testWithAsyncAwaitable()
// IoAwaitable that posts to executor (async resume)
struct async_awaitable
{
thread_pool pool(1);
std::latch done(1);
bool resumed = false;
int value;

struct state
bool await_ready() const noexcept
{
bool* resumed;
std::latch* done;
};
return false;
}

state st{&resumed, &done};

detail::frame_cb cb;
cb.resume = +[](detail::frame_cb* p) {
auto* s = static_cast<state*>(p->data);
*s->resumed = true;
s->done->count_down();
};
cb.destroy = +[](detail::frame_cb*) {};
cb.data = &st;
std::coroutine_handle<>
await_suspend(
std::coroutine_handle<> h,
io_env const* env) noexcept
{
env->executor.post(h);
return std::noop_coroutine();
}

struct post_awaitable
io_result<int> await_resume() noexcept
{
bool await_ready() const noexcept
{
return false;
}

std::coroutine_handle<>
await_suspend(
std::coroutine_handle<> h,
io_env const* env) noexcept
{
env->executor.post(h);
return std::noop_coroutine();
}

void await_resume() noexcept {}
};
return {std::error_code{}, value};
}
};

static_assert(IoAwaitable<post_awaitable>);
static_assert(IoAwaitable<async_awaitable>);

post_awaitable aw;
io_env env{pool.get_executor(), {}};
static task<int>
await_async(int v)
{
auto [ec, result] = co_await async_awaitable{v};
co_return result;
}

auto h = std::coroutine_handle<>::from_address(
static_cast<void*>(&cb));
void
testWithAsyncAwaitable()
{
thread_pool pool(1);
std::latch done(1);
int result = 0;

detail::call_await_suspend(&aw, h, &env);
run_async(pool.get_executor(),
[&](int v) {
result = v;
done.count_down();
},
[&](std::exception_ptr) {
done.count_down();
})(await_async(99));

done.wait();
BOOST_TEST(resumed);
BOOST_TEST_EQ(result, 99);
}

void
Expand Down
Loading