mirror of
https://github.com/latentPrion/libspinscale.git
synced 2026-06-23 19:48:32 +00:00
Compare commits
41 Commits
1d1cb099db
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 3d81ee92aa | |||
| 2f31e9a034 | |||
| a29c779f6e | |||
| 1763685c0e | |||
| 016b2d26de | |||
| ffe86369e2 | |||
| 00be517f30 | |||
| ebf0fa2921 | |||
| d33e70f14a | |||
| 656aae37c8 | |||
| 5689ac3914 | |||
| 565e339a8b | |||
| b04b0db155 | |||
| 44894299b4 | |||
| edde8f4a64 | |||
| 8a7d4272bd | |||
| c60854845d | |||
| a53e0ca325 | |||
| 42076d6c78 | |||
| 2749d77d65 | |||
| 3ea1475757 | |||
| 6df9407e65 | |||
| 0afa3e16b8 | |||
| 4dbc066aac | |||
| ca2cccaa9c | |||
| a14d622eaf | |||
| 16e0350245 | |||
| 5f265567d1 | |||
| e7707dacdf | |||
| 5d139abff2 | |||
| e29bee52cf | |||
| daad2a8c95 | |||
| abdb857e55 | |||
| 525530b567 | |||
| 3f91cbf104 | |||
| 6396cce7e0 | |||
| 15295ac05e | |||
| dc58e5d521 | |||
| 1db3494d26 | |||
| e94aaf9323 | |||
| 83ad680c68 |
@@ -0,0 +1,3 @@
|
||||
[submodule "googletest"]
|
||||
path = googletest
|
||||
url = https://github.com/google/googletest.git
|
||||
+29
-1
@@ -1,6 +1,8 @@
|
||||
cmake_minimum_required(VERSION 3.16)
|
||||
project(libspinscale VERSION 0.1.0 LANGUAGES CXX)
|
||||
|
||||
include(GNUInstallDirs)
|
||||
|
||||
# Set C++ standard
|
||||
set(CMAKE_CXX_STANDARD 20)
|
||||
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||
@@ -76,10 +78,11 @@ find_package(Threads REQUIRED)
|
||||
|
||||
# Create the library
|
||||
add_library(spinscale SHARED
|
||||
src/boostAsioLinkageFix.cpp
|
||||
src/qutex.cpp
|
||||
src/lockerAndInvokerBase.cpp
|
||||
src/componentThread.cpp
|
||||
src/component.cpp
|
||||
src/envKvStore.cpp
|
||||
src/puppeteerComponent.cpp
|
||||
src/puppetApplication.cpp
|
||||
src/runtime.cpp
|
||||
@@ -147,6 +150,31 @@ install(DIRECTORY include/spinscale
|
||||
FILES_MATCHING PATTERN "*.h"
|
||||
)
|
||||
|
||||
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
|
||||
set(_libspinscaleTestsDefault ON)
|
||||
else()
|
||||
set(_libspinscaleTestsDefault OFF)
|
||||
if(DEFINED ENABLE_TESTS AND ENABLE_TESTS)
|
||||
set(_libspinscaleTestsDefault ON)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
option(LIBSPINSCALE_BUILD_TESTS "Build libspinscale unit tests"
|
||||
${_libspinscaleTestsDefault})
|
||||
|
||||
if(LIBSPINSCALE_BUILD_TESTS)
|
||||
if(NOT TARGET gtest AND NOT TARGET gtest_main)
|
||||
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
|
||||
add_subdirectory(
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/googletest
|
||||
${CMAKE_CURRENT_BINARY_DIR}/googletest
|
||||
EXCLUDE_FROM_ALL)
|
||||
endif()
|
||||
|
||||
enable_testing()
|
||||
add_subdirectory(tests)
|
||||
endif()
|
||||
|
||||
install(FILES include/boostAsioLinkageFix.h
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
|
||||
)
|
||||
|
||||
@@ -0,0 +1,293 @@
|
||||
# libspinscale
|
||||
|
||||
libspinscale is a C++ coroutine and asynchronous component runtime for
|
||||
thread-affine systems: applications where work is not just asynchronous, but
|
||||
must run on specific long-lived component threads with explicit lifecycle,
|
||||
posting, cancellation, and orchestration rules.
|
||||
|
||||
It is built around a simple premise: in some systems, the important question is
|
||||
not only "when does this async operation complete?", but also "which component
|
||||
thread owns this work, where does it resume, what locks does the coroutine
|
||||
chain hold, and how does a whole subsystem start or stop as one unit?"
|
||||
|
||||
libspinscale targets that class of problems directly.
|
||||
|
||||
## What It Is For
|
||||
|
||||
libspinscale is meant for applications that look more like a small distributed
|
||||
runtime inside one process than a collection of independent async tasks. It is a
|
||||
fit when the program has:
|
||||
|
||||
- Dedicated component threads with their own `boost::asio::io_context`.
|
||||
- Thread-affine components that must run operations on their owning thread.
|
||||
- Startup, pause, resume, and shutdown protocols across many threads.
|
||||
- Coroutine orchestration that needs structured fan-out and settlement scanning.
|
||||
- Cross-thread post-to and post-back behavior that must be explicit and
|
||||
predictable.
|
||||
- Coroutine-aware locking where deadlock detection must understand the caller
|
||||
coroutine chain.
|
||||
|
||||
Typical examples include simulation runtimes, test harnesses, embedded control
|
||||
planes, game/server subsystems, robotics-style component graphs, multi-thread
|
||||
workflow engines, and other applications where "run this on the right thread" is
|
||||
part of the correctness contract.
|
||||
|
||||
## What Makes It Different
|
||||
|
||||
Most C++ coroutine libraries focus on awaitable primitives, task types, event
|
||||
loops, generators, or composable async algorithms. libspinscale focuses on
|
||||
thread-affine component orchestration. We'll compare libspinscale to contemporaneous C++ coro libraries below to differentiate it:
|
||||
|
||||
Boost.Asio gives excellent networking and executor primitives, but it does not
|
||||
define an application-level component model. libspinscale uses Asio
|
||||
`io_context`s as posting threads and layers a stricter coroutine model on top:
|
||||
component threads, post-to/post-back promises, lifecycle invokers, and
|
||||
structured group settlement.
|
||||
|
||||
Folly coroutines provide production-grade task abstractions and executor
|
||||
integration, especially for large service stacks. libspinscale is narrower: it
|
||||
optimizes for explicit component ownership and deterministic thread handoff
|
||||
rather than general-purpose async service composition.
|
||||
|
||||
cppcoro provides foundational coroutine types such as tasks, generators, async
|
||||
manual reset events, and related primitives. libspinscale is less of a primitive
|
||||
toolkit and more of a runtime pattern for systems with named threads, component
|
||||
lifetimes, and cross-thread orchestration.
|
||||
|
||||
In short: libspinscale is not trying to replace Boost.Asio, Folly, or cppcoro.
|
||||
It is trying to solve the coordination problem that appears above them when an
|
||||
application has a fixed topology of cooperating component threads.
|
||||
|
||||
## Core Ideas
|
||||
|
||||
### Component Threads
|
||||
|
||||
`ComponentThread` owns a `boost::asio::io_context` and represents a named
|
||||
execution thread. `PuppeteerThread` and `PuppetThread` build a lifecycle model
|
||||
on top of that thread:
|
||||
|
||||
- A puppeteer coordinates the application.
|
||||
- Puppet threads host component work.
|
||||
- Lifecycle operations such as JOLT, start, pause, resume, and exit are exposed
|
||||
as awaitable operations.
|
||||
|
||||
`PuppetApplication` orchestrates a set of puppet threads and exposes lifecycle
|
||||
batch operations:
|
||||
|
||||
```cpp
|
||||
co_await app.joltAllPuppetThreadsCReq();
|
||||
co_await app.startAllPuppetThreadsCReq();
|
||||
co_await app.exitAllPuppetThreadsCReq();
|
||||
```
|
||||
|
||||
These operations are coroutine-native. Callers that are already in a coroutine
|
||||
can `co_await` them directly.
|
||||
|
||||
### Posting Promises
|
||||
|
||||
Posting coroutines are tied to a target thread. A tagged posting promise posts the
|
||||
callee coroutine to `ThreadTag::io_context()` at initial suspend and posts back
|
||||
to the caller's `io_context` at completion.
|
||||
|
||||
```cpp
|
||||
struct BodyThreadTag
|
||||
{
|
||||
static boost::asio::io_context &io_context();
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
using BodyPostingPromise =
|
||||
sscl::co::TaggedPostingPromise<T, BodyThreadTag>;
|
||||
|
||||
template<typename T>
|
||||
using BodyInvoker =
|
||||
sscl::co::ViralPostingInvoker<BodyPostingPromise, T>;
|
||||
```
|
||||
|
||||
This makes thread ownership visible in the coroutine return type. A component
|
||||
operation can say, at the type level, that it runs on the body thread and resumes
|
||||
its caller correctly when done.
|
||||
|
||||
### Viral And Non-Viral Invokers
|
||||
|
||||
libspinscale distinguishes coroutine-to-coroutine orchestration from
|
||||
non-coroutine entry points.
|
||||
|
||||
Viral invokers are awaitable and are used inside coroutine call chains:
|
||||
|
||||
```cpp
|
||||
BodyInvoker<void> BodyComponent::initializeCReq()
|
||||
{
|
||||
co_return;
|
||||
}
|
||||
|
||||
co_await body.initializeCReq();
|
||||
```
|
||||
|
||||
Non-viral invokers are for top-level boundaries where ordinary code starts a
|
||||
coroutine and supplies a completion callback:
|
||||
|
||||
```cpp
|
||||
auto invoker = component.initializeFromHookCReq(exceptionPtr, [] {
|
||||
// completion callback
|
||||
});
|
||||
```
|
||||
|
||||
This distinction is intentional. Coroutine orchestration should use `co_await`.
|
||||
Callback-style completion should stay at the outer boundary.
|
||||
|
||||
### Dynamic Post Targets
|
||||
|
||||
Most posting coroutines use a compile-time `ThreadTag`. When the target thread is
|
||||
known only at runtime, `DynamicViralPostingInvoker<T>` and
|
||||
`ExplicitPostTarget` allow the caller to supply the destination `io_context`:
|
||||
|
||||
```cpp
|
||||
sscl::co::DynamicViralPostingInvoker<void>
|
||||
runOnSelectedThread(sscl::co::ExplicitPostTarget target)
|
||||
{
|
||||
co_return;
|
||||
}
|
||||
|
||||
co_await runOnSelectedThread(sscl::co::ExplicitPostTarget{thread.getIoContext()});
|
||||
```
|
||||
|
||||
The post-back side still returns to the caller's thread.
|
||||
|
||||
### Group Settlement
|
||||
|
||||
`co::Group` provides structured fan-out over heterogeneous invokers. Members can
|
||||
be added, awaited as a group, and inspected by settlement status:
|
||||
|
||||
```cpp
|
||||
sscl::co::Group group;
|
||||
|
||||
auto bodyInit = body.initializeCReq();
|
||||
auto worldInit = world.initializeCReq();
|
||||
auto legInit = leg.initializeCReq();
|
||||
|
||||
group.add(bodyInit);
|
||||
group.add(worldInit);
|
||||
group.add(legInit);
|
||||
|
||||
co_await group.getAwaitAllSettlementsInvoker();
|
||||
group.checkForAndReThrowGroupExceptions();
|
||||
```
|
||||
|
||||
Settlements record whether a member completed or threw. The original invoker can
|
||||
be recovered from a descriptor when a caller needs typed return values.
|
||||
|
||||
### Non-Viral Task Nursery
|
||||
|
||||
`co::NonViralTaskNursery` is the structured-concurrency owner for non-viral
|
||||
invokers at non-coroutine boundaries. Unlike `co::Group`, it is for callback-style
|
||||
entry from ordinary code (HTTP handlers, timers, shutdown sequences), not for
|
||||
`co_await` orchestration inside coroutines.
|
||||
|
||||
```cpp
|
||||
sscl::co::NonViralTaskNursery nursery;
|
||||
nursery.openAdmission();
|
||||
|
||||
nursery.launch(
|
||||
[](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return component.someNonViralCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
lease.getSyncCanceler());
|
||||
},
|
||||
[](std::exception_ptr &exceptionPtr)
|
||||
{
|
||||
sscl::co::NonViralCompletion nvc(exceptionPtr);
|
||||
nvc.checkAndRethrowException();
|
||||
});
|
||||
|
||||
nursery.requestCancelOnAll();
|
||||
nursery.closeAdmission();
|
||||
nursery.syncAwaitAllSettlements(
|
||||
sscl::ComponentThread::getSelf()->getIoContext());
|
||||
```
|
||||
|
||||
Each slot owns a `SyncCancelerForAsyncWork`. `requestCancelOnAll()` only signals
|
||||
cooperative stop; it does not destroy invokers. Invokers are retired when their
|
||||
completion callbacks run. Call `closeAdmission()` explicitly before
|
||||
`asyncAwaitAllSettlements()` or `syncAwaitAllSettlements()`; those APIs wait until
|
||||
all slots have retired naturally and throw if admission is still open.
|
||||
|
||||
`syncAwaitAllSettlements()` runs a nested `io_context` loop on the **calling
|
||||
thread** (it blocks in `run_one()` until every slot has retired). Pass the
|
||||
caller thread's `io_context` — usually `ComponentThread::getSelf()->getIoContext()`
|
||||
— not some other thread's context. While the caller is blocked pumping another
|
||||
thread's queue, handlers posted to the caller's own `io_context` are abandoned
|
||||
and the drain can deadlock even when in-flight work has already completed on a
|
||||
different thread.
|
||||
|
||||
`launch(factory, onSettledHook)` registers a non-null hook before `fillSlot()`.
|
||||
Omit the hook (default `nullptr`) when no settlement callback is needed.
|
||||
`Slot::Lease` is commit-required: an uncommitted lease removes its
|
||||
reservation on destruction. `fillSlot()` takes an invoker factory (deferred
|
||||
construction) because non-viral coroutines may complete synchronously during
|
||||
invoker construction. The factory may capture `lease` by reference;
|
||||
`setOnSettledHook()` and the hook passed to `launch()` may not capture `lease`
|
||||
itself. The nursery passes the slot's `exceptionPtr` into the hook at retirement.
|
||||
`Slot::Handle` is an opaque slot pointer valid only while the slot remains in the
|
||||
nursery.
|
||||
|
||||
Slot metadata (`exceptionPtr`, lease/settlement status, canceler) lives on `Slot`.
|
||||
`MemberInvokerBase` is invoker type-erasure only.
|
||||
|
||||
### Coroutine-Aware Locking
|
||||
|
||||
`co::CoQutex` is a coroutine-aware mutual exclusion primitive. It tracks
|
||||
acquired locks through the coroutine promise chain, which lets it detect
|
||||
dangerous re-acquisition patterns across nested coroutine calls instead of only
|
||||
within one stack frame.
|
||||
|
||||
```cpp
|
||||
auto releaseHandle = co_await qutex.getAcquireInvocationAndSuspensionPolicy();
|
||||
```
|
||||
|
||||
When a coroutine cannot acquire the qutex, it suspends and is resumed through
|
||||
the correct caller `io_context`.
|
||||
|
||||
## Design Biases
|
||||
|
||||
libspinscale intentionally favors:
|
||||
|
||||
- Explicit thread ownership over invisible executor selection.
|
||||
- Member coroutine APIs over free-function workaround layers.
|
||||
- `co_await` orchestration inside coroutine code.
|
||||
- Callback completion only at non-coroutine boundaries.
|
||||
- Structured group settlement over ad hoc counters and flags.
|
||||
- Type-visible posting behavior over ambient global schedulers.
|
||||
|
||||
These choices make the library opinionated. That is the point. It is designed
|
||||
for systems where implicit scheduling is a source of bugs.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
libspinscale is not a general replacement for:
|
||||
|
||||
- Boost.Asio networking and executor facilities.
|
||||
- Folly's broad async service infrastructure.
|
||||
- cppcoro's foundational coroutine primitive set.
|
||||
- Standard library coroutine machinery.
|
||||
|
||||
It also is not trying to hide C++ coroutine mechanics. Promise types, invokers,
|
||||
and suspension behavior are part of the public design because the target
|
||||
applications need control over where work runs and where completion resumes.
|
||||
|
||||
## Status
|
||||
|
||||
The API is still evolving. The current direction is centered on coroutine-native
|
||||
component orchestration:
|
||||
|
||||
- `boost::asio::io_context` is the thread event-loop primitive.
|
||||
- Posting coroutines use `TaggedPostingPromise<T, ThreadTag>`.
|
||||
- Runtime-selected posting uses `DynamicViralPostingInvoker<T>`.
|
||||
- Component lifecycle batches are viral non-posting coroutines.
|
||||
- `co::Group` is the primary structured fan-out/fan-in primitive.
|
||||
- `co::NonViralTaskNursery` owns non-viral invoker lifetimes at outer boundaries.
|
||||
|
||||
Expect breaking changes when they simplify the ownership, lifecycle, or
|
||||
post-to/post-back model.
|
||||
Submodule
+1
Submodule googletest added at 7140cd416c
@@ -1,58 +0,0 @@
|
||||
#ifndef ASYNCHRONOUS_BRIDGE_H
|
||||
#define ASYNCHRONOUS_BRIDGE_H
|
||||
|
||||
#include <boostAsioLinkageFix.h>
|
||||
#include <atomic>
|
||||
#include <boost/asio/io_service.hpp>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
class AsynchronousBridge
|
||||
{
|
||||
public:
|
||||
AsynchronousBridge(boost::asio::io_service &io_service)
|
||||
: isAsyncOperationComplete(false), io_service(io_service)
|
||||
{}
|
||||
|
||||
void setAsyncOperationComplete(void)
|
||||
{
|
||||
/** EXPLANATION:
|
||||
* This empty post()ed message is necessary to ensure that the thread
|
||||
* that's waiting on the io_service is signaled to wake up and check
|
||||
* the io_service's queue.
|
||||
*/
|
||||
isAsyncOperationComplete.store(true);
|
||||
io_service.post([]{});
|
||||
}
|
||||
|
||||
void waitForAsyncOperationCompleteOrIoServiceStopped(void)
|
||||
{
|
||||
for (;;)
|
||||
{
|
||||
io_service.run_one();
|
||||
if (isAsyncOperationComplete.load() || io_service.stopped())
|
||||
{ break; }
|
||||
|
||||
/** EXPLANATION:
|
||||
* In the puppeteer and mind thread loops we call checkException()
|
||||
* after run() returns, but we don't have to do that here because
|
||||
* setException() calls stop().
|
||||
*
|
||||
* So if an exception is set on our thread, we'll break out of this
|
||||
* loop due to the check for stopped() above, and that'll take us
|
||||
* back out to the main loop, where we'll catch the exception.
|
||||
*/
|
||||
}
|
||||
}
|
||||
|
||||
bool exitedBecauseIoServiceStopped(void) const
|
||||
{ return io_service.stopped(); }
|
||||
|
||||
private:
|
||||
std::atomic<bool> isAsyncOperationComplete;
|
||||
boost::asio::io_service &io_service;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
|
||||
#endif // ASYNCHRONOUS_BRIDGE_H
|
||||
@@ -8,7 +8,7 @@
|
||||
#include <memory>
|
||||
#include <thread>
|
||||
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/componentThread.h>
|
||||
@@ -31,7 +31,7 @@ public:
|
||||
{
|
||||
public:
|
||||
explicit WaitingCoroutineBase(
|
||||
boost::asio::io_service &callerIoContextIn) noexcept
|
||||
boost::asio::io_context &callerIoContextIn) noexcept
|
||||
: callerIoContext(callerIoContextIn)
|
||||
{}
|
||||
|
||||
@@ -40,7 +40,7 @@ public:
|
||||
virtual void post() noexcept = 0;
|
||||
|
||||
public:
|
||||
boost::asio::io_service &callerIoContext;
|
||||
boost::asio::io_context &callerIoContext;
|
||||
};
|
||||
|
||||
template <typename Promise>
|
||||
@@ -49,7 +49,7 @@ public:
|
||||
{
|
||||
public:
|
||||
TypedWaitingCoroutine(
|
||||
boost::asio::io_service &callerIoContextIn,
|
||||
boost::asio::io_context &callerIoContextIn,
|
||||
std::coroutine_handle<Promise> callerSchedHandleIn) noexcept
|
||||
: WaitingCoroutineBase(callerIoContextIn),
|
||||
callerSchedHandle(callerSchedHandleIn)
|
||||
@@ -83,8 +83,8 @@ public:
|
||||
template <typename Promise>
|
||||
bool await_suspend(std::coroutine_handle<Promise> cvCallerSchedHandle) noexcept
|
||||
{
|
||||
boost::asio::io_service &cvCallerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoService();
|
||||
boost::asio::io_context &cvCallerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoContext();
|
||||
|
||||
sscl::SpinLock::Guard guard(parentCv.spinLock);
|
||||
if (parentCv.isSignaled) {
|
||||
@@ -130,8 +130,8 @@ public:
|
||||
template <typename Promise>
|
||||
DecisionFactors awaitSuspend(std::coroutine_handle<Promise> cvCallerSchedHandle) noexcept
|
||||
{
|
||||
boost::asio::io_service &cvCallerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoService();
|
||||
boost::asio::io_context &cvCallerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoContext();
|
||||
|
||||
parentCv.spinLock.acquire();
|
||||
if (parentCv.isSignaled)
|
||||
@@ -197,7 +197,7 @@ public:
|
||||
template <typename Promise>
|
||||
void enqueueWaitingCoroutine(
|
||||
std::coroutine_handle<Promise> handle,
|
||||
boost::asio::io_service &ctx) noexcept
|
||||
boost::asio::io_context &ctx) noexcept
|
||||
{
|
||||
waitingCoroutines.push_back(
|
||||
std::make_unique<TypedWaitingCoroutine<Promise>>(ctx, handle));
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
#include <coroutine>
|
||||
#include <deque>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <type_traits>
|
||||
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
@@ -13,7 +14,7 @@
|
||||
#include <thread>
|
||||
#endif
|
||||
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/componentThread.h>
|
||||
@@ -28,6 +29,15 @@ public:
|
||||
class ReleaseHandle;
|
||||
|
||||
CoQutex() noexcept = default;
|
||||
|
||||
CoQutex([[maybe_unused]] const std::string &_name) noexcept
|
||||
:
|
||||
#ifdef CONFIG_ENABLE_DEBUG_LOCKS
|
||||
name(_name),
|
||||
#endif
|
||||
isOwned(false)
|
||||
{}
|
||||
|
||||
CoQutex(const CoQutex &) = delete;
|
||||
CoQutex(CoQutex &&) noexcept = delete;
|
||||
CoQutex &operator=(const CoQutex &) = delete;
|
||||
@@ -46,7 +56,7 @@ public:
|
||||
{
|
||||
WaitingCoroutine(
|
||||
std::coroutine_handle<void> _callerSchedHandle,
|
||||
boost::asio::io_service &_callerIoContext,
|
||||
boost::asio::io_context &_callerIoContext,
|
||||
PromiseChainLink &_waitingPromise) noexcept
|
||||
: callerSchedHandle(_callerSchedHandle),
|
||||
callerIoContext(_callerIoContext),
|
||||
@@ -54,7 +64,7 @@ public:
|
||||
{}
|
||||
|
||||
std::coroutine_handle<void> callerSchedHandle;
|
||||
boost::asio::io_service &callerIoContext;
|
||||
boost::asio::io_context &callerIoContext;
|
||||
PromiseChainLink &waitingPromise;
|
||||
};
|
||||
|
||||
@@ -77,7 +87,13 @@ public:
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Walking caller promise chain.\n";
|
||||
#endif
|
||||
if (link.holdsAcquiredLock(coQutex)) {
|
||||
throw std::runtime_error("Deadlock detected: CoQutex re-acquire on caller promise chain.");
|
||||
std::string message =
|
||||
"Deadlock detected: CoQutex re-acquire on caller promise chain";
|
||||
#ifdef CONFIG_ENABLE_DEBUG_LOCKS
|
||||
message += " (" + coQutex.name + ")";
|
||||
#endif
|
||||
message += ".";
|
||||
throw std::runtime_error(message);
|
||||
}
|
||||
});
|
||||
|
||||
@@ -88,7 +104,7 @@ public:
|
||||
}
|
||||
coQutex.waitingCoroutines.emplace_back(
|
||||
std::coroutine_handle<void>::from_address(callerSchedHandle.address()),
|
||||
sscl::ComponentThread::getSelf()->getIoService(),
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
*acquirerChainLink);
|
||||
return true;
|
||||
}
|
||||
@@ -130,6 +146,9 @@ private:
|
||||
waitingCoroutines.pop_front();
|
||||
}
|
||||
|
||||
#ifdef CONFIG_ENABLE_DEBUG_LOCKS
|
||||
std::string name;
|
||||
#endif
|
||||
sscl::SpinLock spinLock;
|
||||
bool isOwned = false;
|
||||
std::deque<AcquireInvocationAndSuspensionPolicy::WaitingCoroutine> waitingCoroutines;
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
#ifndef DYNAMIC_POSTING_INVOKER_H
|
||||
#define DYNAMIC_POSTING_INVOKER_H
|
||||
|
||||
#include <stdexcept>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/co/postingPromise.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
/** Fallback ThreadTag for DynamicViralPostingInvoker when ExplicitPostTarget is
|
||||
* omitted. Callers must always pass ExplicitPostTarget in production paths.
|
||||
*/
|
||||
struct DynamicPostTargetThreadTag
|
||||
{
|
||||
static boost::asio::io_context &io_context()
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": ExplicitPostTarget required for DynamicViralPostingInvoker");
|
||||
}
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
using DynamicPostingPromise =
|
||||
TaggedPostingPromise<T, DynamicPostTargetThreadTag>;
|
||||
|
||||
template<typename T>
|
||||
using DynamicViralPostingInvoker =
|
||||
ViralPostingInvoker<DynamicPostingPromise, T>;
|
||||
|
||||
using DynamicNonViralPostingInvoker =
|
||||
NonViralPostingInvoker<DynamicPostingPromise>;
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // DYNAMIC_POSTING_INVOKER_H
|
||||
+111
-58
@@ -1,6 +1,7 @@
|
||||
#ifndef GROUP_H
|
||||
#define GROUP_H
|
||||
|
||||
#include <any>
|
||||
#include <cassert>
|
||||
#include <coroutine>
|
||||
#include <cstddef>
|
||||
@@ -14,7 +15,7 @@
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/componentThread.h>
|
||||
@@ -60,6 +61,42 @@ concept AwaitableIface = requires(T &t) {
|
||||
{ get_operator_co_await(t) };
|
||||
} && AwaiterIface<decltype(get_operator_co_await(std::declval<T &>()))>;
|
||||
|
||||
template<AwaiterIface T>
|
||||
T &asAwaiter(T &t) noexcept
|
||||
{
|
||||
return t;
|
||||
}
|
||||
|
||||
template<AwaitableIface T>
|
||||
auto asAwaiter(T &t) noexcept(noexcept(get_operator_co_await(t)))
|
||||
-> decltype(get_operator_co_await(t))
|
||||
{
|
||||
return get_operator_co_await(t);
|
||||
}
|
||||
|
||||
inline bool endsWithLineBreak(const std::string &message)
|
||||
{
|
||||
return !message.empty()
|
||||
&& (message.back() == '\n' || message.back() == '\r');
|
||||
}
|
||||
|
||||
inline void appendGroupAdapterExceptionLine(
|
||||
std::ostringstream &ostream, std::exception_ptr exceptionPtr)
|
||||
{
|
||||
ostream << "Exc thrown in Group Adapter: ";
|
||||
try {
|
||||
std::rethrow_exception(exceptionPtr);
|
||||
} catch (const std::exception &e) {
|
||||
const std::string message = e.what();
|
||||
ostream << message;
|
||||
if (!endsWithLineBreak(message)) {
|
||||
ostream << "\n";
|
||||
}
|
||||
} catch (...) {
|
||||
ostream << "<unknown exception type>\n";
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
|
||||
template <typename T>
|
||||
@@ -71,8 +108,27 @@ concept AwaiterIface = detail::AwaiterIface<T>;
|
||||
template <typename T>
|
||||
concept AwaitableOrAwaiterIface = AwaiterIface<T> || AwaitableIface<T>;
|
||||
|
||||
template <typename Invoker>
|
||||
requires AwaitableOrAwaiterIface<Invoker>
|
||||
/** Typical usage — parallel members, then gather:
|
||||
*
|
||||
* co::Group group;
|
||||
*
|
||||
* auto bodyInit = body.initializeCReq(exceptionPtr, noopCallback);
|
||||
* auto legInit = leg.initializeCReq(exceptionPtr, noopCallback);
|
||||
* ViralNonPostingInvoker<void> batch = app.joltAllPuppetThreadsCReq(...);
|
||||
*
|
||||
* group.add(bodyInit);
|
||||
* group.add(legInit);
|
||||
* group.add(batch);
|
||||
*
|
||||
* co_await group.getAwaitAllSettlementsInvoker();
|
||||
* group.checkForAndReThrowGroupExceptions();
|
||||
*
|
||||
* (void)bodyInit.completedReturnValues();
|
||||
*
|
||||
* // When walking settlement slots by index:
|
||||
* settlements[i].invokerAs<BodyViralPostingInvoker<void>>()
|
||||
* .completedReturnValues();
|
||||
*/
|
||||
struct Group
|
||||
{
|
||||
enum class AwaitingCondition {
|
||||
@@ -91,9 +147,23 @@ struct Group
|
||||
UNSETTLED, COMPLETED, EXCEPTION_THROWN
|
||||
};
|
||||
|
||||
SettlementDescriptor(Invoker &_invoker)
|
||||
: invoker(std::ref(_invoker))
|
||||
{}
|
||||
template<typename Member>
|
||||
void bindMemberRef(Member &member)
|
||||
{
|
||||
memberInvokerRef = std::ref(member);
|
||||
}
|
||||
|
||||
template<typename Member>
|
||||
Member &invokerAs() const
|
||||
{
|
||||
try {
|
||||
return std::any_cast<std::reference_wrapper<Member>>(
|
||||
memberInvokerRef).get();
|
||||
} catch (const std::bad_any_cast &) {
|
||||
throw std::runtime_error(
|
||||
"Group settlement invoker type mismatch");
|
||||
}
|
||||
}
|
||||
|
||||
void setSettlementStatus() noexcept
|
||||
{
|
||||
@@ -109,7 +179,7 @@ struct Group
|
||||
TypeE type = TypeE::UNSETTLED;
|
||||
std::exception_ptr calleeException = nullptr;
|
||||
std::exception_ptr adapterException = nullptr;
|
||||
std::reference_wrapper<Invoker> invoker;
|
||||
std::any memberInvokerRef;
|
||||
};
|
||||
|
||||
struct SettlementAwaitingInvoker;
|
||||
@@ -178,15 +248,8 @@ struct Group
|
||||
}
|
||||
|
||||
doThrow = true;
|
||||
ostream << "Exc thrown in Group Adapter: ";
|
||||
try {
|
||||
std::rethrow_exception(item.adapterException);
|
||||
} catch (const std::exception &e) {
|
||||
ostream << e.what();
|
||||
} catch (...) {
|
||||
ostream << "<unknown exception type>";
|
||||
}
|
||||
ostream << "\n";
|
||||
detail::appendGroupAdapterExceptionLine(
|
||||
ostream, item.adapterException);
|
||||
}
|
||||
|
||||
if (doThrow) {
|
||||
@@ -439,7 +502,7 @@ struct Group
|
||||
* would be impossible.
|
||||
*
|
||||
* So we should be able to call resume() directly here without
|
||||
* post()ing to current_io_context().
|
||||
* post()ing to ComponentThread::getSelf()->getIoContext().
|
||||
*
|
||||
* EXPLANATION:
|
||||
* However, in order to ensure that we keep this adapter coro
|
||||
@@ -447,7 +510,7 @@ struct Group
|
||||
* directly calling the handle.
|
||||
*/
|
||||
boost::asio::post(
|
||||
sscl::ComponentThread::getSelf()->getIoService(),
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
groupAwaiterSchedHandleToWake);
|
||||
}
|
||||
|
||||
@@ -466,28 +529,17 @@ struct Group
|
||||
* target async fn, and also to convey its results back to the Group class.
|
||||
* It's effectively a go-between coro that provides the outcomes that Invokers
|
||||
* normally provide, without needing, itself, to be co_awaited.
|
||||
*
|
||||
* settlementIndex is captured by value (not a vector iterator) so adapter
|
||||
* coros remain valid if settlements reallocate during concurrent add().
|
||||
*/
|
||||
NonAwaitableNonPostingAdapterCoro nonAwaitableAdapterCoro(
|
||||
template<AwaitableOrAwaiterIface Member>
|
||||
NonAwaitableNonPostingAdapterCoro memberAdapterCoro(
|
||||
Member &memberInvoker,
|
||||
std::size_t settlementIndex) noexcept
|
||||
{
|
||||
/** EXPLANATION:
|
||||
* It's very convenient that our design for the NonViralNonSuspendingInvoker
|
||||
* coincidentally allows us to supply a lambda that can be used to test
|
||||
* for the settlement conditions that are being waited on by the Group's
|
||||
* co_awaiter.
|
||||
*
|
||||
* settlementIndex is captured by value (not a vector iterator) so adapter
|
||||
* coros remain valid if settlements reallocate during concurrent add().
|
||||
*/
|
||||
try {
|
||||
/* Return values remain in the callee promise until the caller-owned
|
||||
* invoker is destroyed (~PostingInvoker). The group co_awaiter reads
|
||||
* results via settlements[settlementIndex].invoker after awaiting.
|
||||
*
|
||||
* Index settlements[] each time; do not cache a reference across
|
||||
* co_await because concurrent add() may reallocate the vector.
|
||||
*/
|
||||
co_await s.rsrc.settlements[settlementIndex].invoker.get();
|
||||
co_await detail::asAwaiter(memberInvoker);
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
@@ -505,12 +557,8 @@ struct Group
|
||||
co_return;
|
||||
}
|
||||
|
||||
/** EXPLANATION:
|
||||
* Each invoker passed to add() must outlive this Group and the callee frame
|
||||
* (see ~PostingInvoker). The group co_awaiter reads return values from those
|
||||
* invokers after awaiting; do not destroy an invoker until reads are done.
|
||||
*/
|
||||
void add(Invoker &invoker)
|
||||
template<AwaitableOrAwaiterIface Member>
|
||||
void add(Member &memberInvoker)
|
||||
{
|
||||
std::size_t settlementIndex = 0;
|
||||
|
||||
@@ -525,16 +573,17 @@ struct Group
|
||||
}
|
||||
|
||||
settlementIndex = s.rsrc.settlements.size();
|
||||
s.rsrc.settlements.emplace_back(invoker);
|
||||
s.rsrc.settlements.emplace_back();
|
||||
s.rsrc.settlements[settlementIndex].bindMemberRef(memberInvoker);
|
||||
}
|
||||
|
||||
nonAwaitableAdapterCoro(settlementIndex);
|
||||
memberAdapterCoro(memberInvoker, settlementIndex);
|
||||
}
|
||||
|
||||
void checkForAndReThrowGroupExceptions() const
|
||||
std::exception_ptr captureAggregatedGroupExceptions() const
|
||||
{
|
||||
std::ostringstream ostream;
|
||||
bool doThrow = false;
|
||||
bool hasFailures = false;
|
||||
|
||||
for (auto &item : s.rsrc.settlements)
|
||||
{
|
||||
@@ -544,20 +593,24 @@ struct Group
|
||||
|
||||
assert(item.calleeException);
|
||||
|
||||
doThrow = true;
|
||||
ostream << "Exc thrown in Group Adapter: ";
|
||||
try {
|
||||
std::rethrow_exception(item.calleeException);
|
||||
} catch (const std::exception &e) {
|
||||
ostream << e.what();
|
||||
} catch (...) {
|
||||
ostream << "<unknown exception type>";
|
||||
}
|
||||
ostream << "\n";
|
||||
hasFailures = true;
|
||||
detail::appendGroupAdapterExceptionLine(
|
||||
ostream, item.calleeException);
|
||||
}
|
||||
|
||||
if (doThrow) {
|
||||
throw std::runtime_error(ostream.str());
|
||||
if (!hasFailures) {
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
return std::make_exception_ptr(std::runtime_error(ostream.str()));
|
||||
}
|
||||
|
||||
void checkForAndReThrowGroupExceptions() const
|
||||
{
|
||||
std::exception_ptr aggregatedException =
|
||||
captureAggregatedGroupExceptions();
|
||||
if (aggregatedException) {
|
||||
std::rethrow_exception(aggregatedException);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
#ifndef POSTING_INVOKER_H
|
||||
#define POSTING_INVOKER_H
|
||||
#ifndef INVOKER_BASE_H
|
||||
#define INVOKER_BASE_H
|
||||
|
||||
#include <config.h>
|
||||
#include <coroutine>
|
||||
@@ -8,29 +8,34 @@
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
#include <spinscale/co/promises.h>
|
||||
#include <spinscale/co/promiseChainLink.h>
|
||||
#include <spinscale/co/returnValues.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
/** Shared callee-frame owner and awaiter for posting and non-posting promises.
|
||||
* Posting vs non-posting completion is implemented in each promise's PostBackStatus
|
||||
* and final_suspend; this type only wires caller handles and reads return values.
|
||||
*/
|
||||
template <typename PromiseType, typename T>
|
||||
class PostingInvoker
|
||||
class Invoker
|
||||
{
|
||||
public:
|
||||
explicit PostingInvoker(PromiseType &_calleePromise) noexcept
|
||||
explicit Invoker(PromiseType &_calleePromise) noexcept
|
||||
: calleePromise(_calleePromise)
|
||||
{}
|
||||
|
||||
PostingInvoker(const PostingInvoker &) = delete;
|
||||
PostingInvoker &operator=(const PostingInvoker &) = delete;
|
||||
Invoker(const Invoker &) = delete;
|
||||
Invoker &operator=(const Invoker &) = delete;
|
||||
|
||||
PostingInvoker(PostingInvoker &&other) noexcept
|
||||
Invoker(Invoker &&other) noexcept
|
||||
: calleePromise(other.calleePromise),
|
||||
ownsFrameDestroy_(std::exchange(other.ownsFrameDestroy_, false))
|
||||
{}
|
||||
|
||||
PostingInvoker &operator=(PostingInvoker &&other) = delete;
|
||||
Invoker &operator=(Invoker &&other) = delete;
|
||||
|
||||
~PostingInvoker() noexcept
|
||||
~Invoker() noexcept
|
||||
{
|
||||
if (!ownsFrameDestroy_) { return; }
|
||||
|
||||
@@ -41,11 +46,12 @@ public:
|
||||
}
|
||||
|
||||
template <typename CallerPromise>
|
||||
bool setCallerSchedHandle(std::coroutine_handle<CallerPromise> callerSchedHandle) noexcept
|
||||
bool setCallerSchedHandle(
|
||||
std::coroutine_handle<CallerPromise> callerSchedHandle) noexcept
|
||||
{
|
||||
static_assert(
|
||||
std::is_base_of_v<PromiseChainLink, CallerPromise>,
|
||||
"PostingInvoker caller promise must derive from PromiseChainLink");
|
||||
"Invoker caller promise must derive from PromiseChainLink");
|
||||
|
||||
calleePromise.callerSchedHandle = callerSchedHandle;
|
||||
calleePromise.setCallerPromiseChainLink(&callerSchedHandle.promise());
|
||||
@@ -89,11 +95,11 @@ private:
|
||||
|
||||
/** EXPLANATION:
|
||||
* Every live invoker owns destruction of its callee coroutine frame in
|
||||
* ~PostingInvoker (via calleePromise.selfSchedHandle).
|
||||
* ~Invoker (via calleePromise.selfSchedHandle).
|
||||
*
|
||||
* The only time frame destruction is skipped is for a moved-from invoker
|
||||
* after move construction or move assignment, so we do not double-destroy
|
||||
* the same handle when get_return_object() returns the invoker by value.
|
||||
* after move construction, so we do not double-destroy the same handle
|
||||
* when get_return_object() returns the invoker by value.
|
||||
*
|
||||
* This is not an opt-out for viral vs non-viral callers or for "callee
|
||||
* still running"; callers must keep the invoker alive until the callee
|
||||
@@ -102,6 +108,12 @@ private:
|
||||
bool ownsFrameDestroy_ = true;
|
||||
};
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
using PostingInvoker = Invoker<PromiseType, T>;
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
using NonPostingInvoker = Invoker<PromiseType, T>;
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // POSTING_INVOKER_H
|
||||
#endif // INVOKER_BASE_H
|
||||
+128
-14
@@ -10,7 +10,8 @@
|
||||
#include <thread>
|
||||
#include <type_traits>
|
||||
|
||||
#include <spinscale/co/postingInvoker.h>
|
||||
#include <spinscale/co/invokerBase.h>
|
||||
#include <spinscale/co/nonPostingPromise.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
@@ -18,10 +19,10 @@ namespace sscl::co {
|
||||
* PostingPromiseTemplate<void> (no return-value path to a caller).
|
||||
*
|
||||
* The invoker must outlive the callee frame: do not discard the return object
|
||||
* from get_return_object(). ~PostingInvoker destroys the callee frame.
|
||||
* from get_return_object(). ~Invoker destroys the callee frame.
|
||||
*/
|
||||
template <template <typename> class PostingPromiseTemplate>
|
||||
struct NonViralNonSuspendingInvoker
|
||||
struct NonViralPostingInvoker
|
||||
: public PostingInvoker<PostingPromiseTemplate<void>, void>
|
||||
{
|
||||
struct promise_type
|
||||
@@ -29,10 +30,10 @@ struct NonViralNonSuspendingInvoker
|
||||
{
|
||||
using PostingPromiseTemplate<void>::PostingPromiseTemplate;
|
||||
|
||||
NonViralNonSuspendingInvoker<PostingPromiseTemplate> get_return_object()
|
||||
NonViralPostingInvoker<PostingPromiseTemplate> get_return_object()
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning NonViralNonSuspendingInvoker.\n";
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning NonViralPostingInvoker.\n";
|
||||
#endif
|
||||
if (!this->callerLambda)
|
||||
{
|
||||
@@ -46,14 +47,17 @@ struct NonViralNonSuspendingInvoker
|
||||
*/
|
||||
std::ostringstream oss;
|
||||
oss << std::this_thread::get_id()
|
||||
<< ": Missing completion lambda: non-viral coroutines require a completion lambda.";
|
||||
<< ": Missing completion lambda: non-viral coroutines require a completion lambda."
|
||||
<< " Promise type=" << typeid(*this).name()
|
||||
<< ". This usually means promise construction did not bind the"
|
||||
<< " (exception_ptr&, function<void()>, ...) constructor.";
|
||||
throw std::runtime_error(oss.str());
|
||||
}
|
||||
|
||||
this->setSelfSchedHandle(
|
||||
std::coroutine_handle<promise_type>::from_promise(*this));
|
||||
|
||||
return NonViralNonSuspendingInvoker<PostingPromiseTemplate>(*this);
|
||||
return NonViralPostingInvoker<PostingPromiseTemplate>(*this);
|
||||
}
|
||||
};
|
||||
|
||||
@@ -62,7 +66,7 @@ struct NonViralNonSuspendingInvoker
|
||||
bool await_ready() const noexcept
|
||||
{ std::terminate(); }
|
||||
|
||||
void await_suspend(std::coroutine_handle<NonViralNonSuspendingInvoker<PostingPromiseTemplate>>) noexcept
|
||||
void await_suspend(std::coroutine_handle<NonViralPostingInvoker<PostingPromiseTemplate>>) noexcept
|
||||
{ std::terminate(); }
|
||||
|
||||
void await_resume() noexcept
|
||||
@@ -73,10 +77,10 @@ struct NonViralNonSuspendingInvoker
|
||||
* target chosen by the posting-promise alias, e.g. BodyPostingPromise<int>).
|
||||
*
|
||||
* The invoker must outlive the callee frame until results are read.
|
||||
* ~PostingInvoker destroys the callee frame (not await_resume).
|
||||
* ~Invoker destroys the callee frame (not await_resume).
|
||||
*/
|
||||
template <template <typename> class PostingPromiseTemplate, typename T>
|
||||
struct ViralSuspendingInvoker
|
||||
struct ViralPostingInvoker
|
||||
: public PostingInvoker<PostingPromiseTemplate<T>, T>
|
||||
{
|
||||
struct promise_type
|
||||
@@ -84,15 +88,15 @@ struct ViralSuspendingInvoker
|
||||
{
|
||||
using PostingPromiseTemplate<T>::PostingPromiseTemplate;
|
||||
|
||||
ViralSuspendingInvoker<PostingPromiseTemplate, T> get_return_object() noexcept
|
||||
ViralPostingInvoker<PostingPromiseTemplate, T> get_return_object() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning ViralSuspendingInvoker.\n";
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning ViralPostingInvoker.\n";
|
||||
#endif
|
||||
this->setSelfSchedHandle(
|
||||
std::coroutine_handle<promise_type>::from_promise(*this));
|
||||
|
||||
return ViralSuspendingInvoker<PostingPromiseTemplate, T>(*this);
|
||||
return ViralPostingInvoker<PostingPromiseTemplate, T>(*this);
|
||||
}
|
||||
};
|
||||
|
||||
@@ -111,7 +115,7 @@ struct ViralSuspendingInvoker
|
||||
{
|
||||
static_assert(
|
||||
std::is_base_of_v<PromiseChainLink, CallerPromise>,
|
||||
"ViralSuspendingInvoker caller promise must derive from PromiseChainLink");
|
||||
"ViralPostingInvoker caller promise must derive from PromiseChainLink");
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Setting callerSchedHandle.\n";
|
||||
#endif
|
||||
@@ -144,6 +148,116 @@ struct ViralSuspendingInvoker
|
||||
}
|
||||
};
|
||||
|
||||
/** Non-viral coroutine entry that must not be co_awaited: runs on the caller
|
||||
* thread (initial_suspend is never) and invokes the completion lambda directly
|
||||
* from final_suspend (no cross-thread posting).
|
||||
*
|
||||
* The invoker must outlive the callee frame: do not discard the return object
|
||||
* from get_return_object(). ~Invoker destroys the callee frame.
|
||||
*/
|
||||
struct NonViralNonPostingInvoker
|
||||
: public NonPostingInvoker<NonPostingPromise<void>, void>
|
||||
{
|
||||
struct promise_type
|
||||
: public NonPostingPromise<void>
|
||||
{
|
||||
using NonPostingPromise<void>::NonPostingPromise;
|
||||
|
||||
NonViralNonPostingInvoker get_return_object()
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning NonViralNonPostingInvoker.\n";
|
||||
#endif
|
||||
if (!this->callerLambda)
|
||||
{
|
||||
std::ostringstream oss;
|
||||
oss << std::this_thread::get_id()
|
||||
<< ": Missing completion lambda: non-viral coroutines require a completion lambda."
|
||||
<< " Promise type=" << typeid(*this).name()
|
||||
<< ". This usually means promise construction did not bind the"
|
||||
<< " (exception_ptr&, function<void()>, ...) constructor.";
|
||||
throw std::runtime_error(oss.str());
|
||||
}
|
||||
|
||||
this->setSelfSchedHandle(
|
||||
std::coroutine_handle<promise_type>::from_promise(*this));
|
||||
|
||||
return NonViralNonPostingInvoker(*this);
|
||||
}
|
||||
};
|
||||
|
||||
using NonPostingInvoker<NonPostingPromise<void>, void>::NonPostingInvoker;
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ std::terminate(); }
|
||||
|
||||
void await_suspend(std::coroutine_handle<NonViralNonPostingInvoker>) noexcept
|
||||
{ std::terminate(); }
|
||||
|
||||
void await_resume() noexcept
|
||||
{ std::terminate(); }
|
||||
};
|
||||
|
||||
/** Viral awaitable non-posting coroutine: runs eagerly on the caller thread
|
||||
* (initial_suspend is never). Caller resume uses symmetric transfer when the
|
||||
* caller has registered before callee completion; otherwise PostBackStatus
|
||||
* fast-paths await_resume on co_await.
|
||||
*/
|
||||
template <typename T = void>
|
||||
struct ViralNonPostingInvoker
|
||||
: public NonPostingInvoker<NonPostingPromise<T>, T>
|
||||
{
|
||||
struct promise_type
|
||||
: public NonPostingPromise<T>
|
||||
{
|
||||
using NonPostingPromise<T>::NonPostingPromise;
|
||||
|
||||
ViralNonPostingInvoker<T> get_return_object() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id()
|
||||
<< " Returning ViralNonPostingInvoker.\n";
|
||||
#endif
|
||||
this->setSelfSchedHandle(
|
||||
std::coroutine_handle<promise_type>::from_promise(*this));
|
||||
|
||||
return ViralNonPostingInvoker<T>(*this);
|
||||
}
|
||||
};
|
||||
|
||||
using NonPostingInvoker<NonPostingPromise<T>, T>::NonPostingInvoker;
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ return false; }
|
||||
|
||||
template <typename CallerPromise>
|
||||
bool await_suspend(
|
||||
std::coroutine_handle<CallerPromise> callerSchedHandle) noexcept
|
||||
{
|
||||
static_assert(
|
||||
std::is_base_of_v<PromiseChainLink, CallerPromise>,
|
||||
"ViralNonPostingInvoker caller promise must derive from "
|
||||
"PromiseChainLink");
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id()
|
||||
<< " Setting callerSchedHandle.\n";
|
||||
#endif
|
||||
const bool suspendCaller =
|
||||
this->setCallerSchedHandle(callerSchedHandle);
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id()
|
||||
<< " CallerFlowExecutor returned suspend=" << suspendCaller
|
||||
<< ".\n";
|
||||
#endif
|
||||
return suspendCaller;
|
||||
}
|
||||
|
||||
auto await_resume()
|
||||
{
|
||||
return NonPostingInvoker<NonPostingPromise<T>, T>::await_resume();
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // INVOKERS_H
|
||||
|
||||
@@ -0,0 +1,228 @@
|
||||
#ifndef NON_POSTING_PROMISE_H
|
||||
#define NON_POSTING_PROMISE_H
|
||||
|
||||
#include <config.h>
|
||||
#include <coroutine>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <iostream>
|
||||
#include <thread>
|
||||
#include <utility>
|
||||
|
||||
#include <spinscale/spinLock.h>
|
||||
#include <spinscale/co/coQutex.h>
|
||||
#include <spinscale/co/nonViralCompletion.h>
|
||||
#include <spinscale/co/promiseChainLink.h>
|
||||
#include <spinscale/co/promiseReturnOps.h>
|
||||
#include <spinscale/co/returnValues.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
template <typename T>
|
||||
struct NonPostingPromise
|
||||
: public PromiseChainLink,
|
||||
public PromiseReturnOps<NonPostingPromise<T>, T>
|
||||
{
|
||||
struct PostBackStatus
|
||||
{
|
||||
struct CalleeFlowExecutor;
|
||||
struct CallerFlowExecutor;
|
||||
friend struct CalleeFlowExecutor;
|
||||
friend struct CallerFlowExecutor;
|
||||
|
||||
explicit PostBackStatus(NonPostingPromise &calleePromiseIn) noexcept
|
||||
: calleePromise(calleePromiseIn)
|
||||
{}
|
||||
|
||||
void reset() noexcept
|
||||
{
|
||||
sscl::SpinLock::Guard guard(lock);
|
||||
callerHasSetCallerSchedHandle = false;
|
||||
calleeIsReadyToPostBack = false;
|
||||
}
|
||||
|
||||
struct FlowExecutor
|
||||
{
|
||||
explicit FlowExecutor(PostBackStatus &parentIn) noexcept
|
||||
: parent(parentIn)
|
||||
{}
|
||||
|
||||
PostBackStatus &parent;
|
||||
};
|
||||
|
||||
struct CalleeFlowExecutor
|
||||
: public FlowExecutor
|
||||
{
|
||||
explicit CalleeFlowExecutor(PostBackStatus &parentIn) noexcept
|
||||
: FlowExecutor(parentIn)
|
||||
{}
|
||||
|
||||
bool operator()() noexcept
|
||||
{
|
||||
sscl::SpinLock::Guard guard(this->parent.lock);
|
||||
this->parent.calleeIsReadyToPostBack = true;
|
||||
if (this->parent.callerHasSetCallerSchedHandle) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
struct CallerFlowExecutor
|
||||
: public FlowExecutor
|
||||
{
|
||||
explicit CallerFlowExecutor(PostBackStatus &parentIn) noexcept
|
||||
: FlowExecutor(parentIn)
|
||||
{}
|
||||
|
||||
bool operator()() noexcept
|
||||
{
|
||||
sscl::SpinLock::Guard guard(this->parent.lock);
|
||||
this->parent.callerHasSetCallerSchedHandle = true;
|
||||
if (this->parent.calleeIsReadyToPostBack) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
CalleeFlowExecutor getCalleeFlowExecutor() noexcept
|
||||
{
|
||||
return CalleeFlowExecutor(*this);
|
||||
}
|
||||
|
||||
CallerFlowExecutor getCallerFlowExecutor() noexcept
|
||||
{
|
||||
return CallerFlowExecutor(*this);
|
||||
}
|
||||
|
||||
NonPostingPromise &calleePromise;
|
||||
|
||||
private:
|
||||
sscl::SpinLock lock;
|
||||
bool callerHasSetCallerSchedHandle = false;
|
||||
bool calleeIsReadyToPostBack = false;
|
||||
};
|
||||
|
||||
/** Completion work must run from this awaiter's await_suspend, not
|
||||
* synchronously inside promise.final_suspend() before it returns: the
|
||||
* hidden coroutine segment index in the coroutine state is only advanced
|
||||
* after final_suspend exits. See docs/prompts/post-to-and-back-in-invokables.md.
|
||||
*/
|
||||
struct FinalSuspendNonPostingInvoker
|
||||
: public std::suspend_always
|
||||
{
|
||||
explicit FinalSuspendNonPostingInvoker(
|
||||
NonPostingPromise &calleePromiseIn) noexcept
|
||||
: calleePromise(calleePromiseIn)
|
||||
{}
|
||||
|
||||
std::coroutine_handle<> await_suspend(
|
||||
std::coroutine_handle<> const) noexcept
|
||||
{
|
||||
if (calleePromise.callerLambda)
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << "final_suspend" << ": "
|
||||
<< std::this_thread::get_id()
|
||||
<< " Non-viral non-posting: invoking callerLambda directly.\n";
|
||||
#endif
|
||||
auto callerLambda = std::move(calleePromise.callerLambda);
|
||||
callerLambda();
|
||||
return std::noop_coroutine();
|
||||
}
|
||||
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << "final_suspend" << ": " << std::this_thread::get_id()
|
||||
<< " Viral non-posting: running CalleeFlowExecutor.\n";
|
||||
#endif
|
||||
const bool symmetricTransferToCaller =
|
||||
calleePromise.postBackStatus.getCalleeFlowExecutor()();
|
||||
|
||||
if (symmetricTransferToCaller && calleePromise.callerSchedHandle) {
|
||||
return calleePromise.callerSchedHandle;
|
||||
}
|
||||
|
||||
return std::noop_coroutine();
|
||||
}
|
||||
|
||||
NonPostingPromise &calleePromise;
|
||||
};
|
||||
|
||||
NonPostingPromise() noexcept
|
||||
: returnValues(),
|
||||
postBackStatus(*this)
|
||||
{}
|
||||
|
||||
template <typename... TailArgs>
|
||||
NonPostingPromise(
|
||||
std::exception_ptr &callerExceptionPtr,
|
||||
std::function<void()> callerLambdaIn,
|
||||
TailArgs &&...) noexcept
|
||||
: returnValues(callerExceptionPtr),
|
||||
callerLambda(std::move(callerLambdaIn)),
|
||||
postBackStatus(*this)
|
||||
{}
|
||||
|
||||
template <typename ObjectArg, typename... TailArgs>
|
||||
requires (!std::same_as<std::remove_cvref_t<ObjectArg>, std::exception_ptr>)
|
||||
NonPostingPromise(
|
||||
ObjectArg &&,
|
||||
std::exception_ptr &callerExceptionPtr,
|
||||
std::function<void()> callerLambdaIn,
|
||||
TailArgs &&...) noexcept
|
||||
: NonPostingPromise(
|
||||
callerExceptionPtr,
|
||||
std::move(callerLambdaIn))
|
||||
{}
|
||||
|
||||
~NonPostingPromise() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id()
|
||||
<< " Destructing.\n";
|
||||
#endif
|
||||
}
|
||||
|
||||
std::suspend_never initial_suspend() noexcept
|
||||
{ return {}; }
|
||||
|
||||
auto final_suspend() noexcept
|
||||
{ return FinalSuspendNonPostingInvoker(*this); }
|
||||
|
||||
void unhandled_exception() noexcept
|
||||
{
|
||||
returnValues.myExceptionPtr = std::current_exception();
|
||||
}
|
||||
|
||||
void removeAcquiredLock(CoQutex &coQutex) noexcept override
|
||||
{
|
||||
eraseFirstMatchingAcquiredLock(coQutex);
|
||||
}
|
||||
|
||||
const PromiseChainLink *callerPromiseChainLink() const noexcept override
|
||||
{ return callerChainLink; }
|
||||
|
||||
PromiseChainLink *callerPromiseChainLink() noexcept override
|
||||
{ return callerChainLink; }
|
||||
|
||||
void setSelfSchedHandle(std::coroutine_handle<> schedHandle) noexcept
|
||||
{ selfSchedHandle = schedHandle; }
|
||||
|
||||
void setCallerPromiseChainLink(PromiseChainLink *chainLink) noexcept
|
||||
{ callerChainLink = chainLink; }
|
||||
|
||||
ReturnValues<T> returnValues;
|
||||
std::function<void()> callerLambda;
|
||||
PostBackStatus postBackStatus;
|
||||
std::coroutine_handle<> selfSchedHandle;
|
||||
std::coroutine_handle<> callerSchedHandle;
|
||||
PromiseChainLink *callerChainLink = nullptr;
|
||||
|
||||
template <typename, typename>
|
||||
friend class Invoker;
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // NON_POSTING_PROMISE_H
|
||||
@@ -0,0 +1,40 @@
|
||||
#ifndef NON_VIRAL_COMPLETION_H
|
||||
#define NON_VIRAL_COMPLETION_H
|
||||
|
||||
#include <exception>
|
||||
#include <utility>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
class NonViralCompletion
|
||||
{
|
||||
public:
|
||||
explicit NonViralCompletion(std::exception_ptr &exceptionPtr)
|
||||
: exceptionPtr(exceptionPtr)
|
||||
{}
|
||||
|
||||
bool hasException() const noexcept
|
||||
{
|
||||
return exceptionPtr != nullptr;
|
||||
}
|
||||
|
||||
void checkAndRethrowException() const
|
||||
{
|
||||
if (exceptionPtr)
|
||||
{
|
||||
std::rethrow_exception(exceptionPtr);
|
||||
}
|
||||
}
|
||||
|
||||
std::exception_ptr releaseException() noexcept
|
||||
{
|
||||
return std::exchange(exceptionPtr, nullptr);
|
||||
}
|
||||
|
||||
private:
|
||||
std::exception_ptr &exceptionPtr;
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // NON_VIRAL_COMPLETION_H
|
||||
@@ -0,0 +1,527 @@
|
||||
#ifndef NON_VIRAL_TASK_NURSERY_H
|
||||
#define NON_VIRAL_TASK_NURSERY_H
|
||||
|
||||
#include <boostAsioLinkageFix.h>
|
||||
|
||||
#include <cstddef>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <list>
|
||||
#include <memory>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
|
||||
#include <spinscale/cps/asynchronousBridge.h>
|
||||
#include <spinscale/sharedResourceGroup.h>
|
||||
#include <spinscale/spinLock.h>
|
||||
#include <spinscale/syncCancelerForAsyncWork.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
namespace detail {
|
||||
|
||||
struct MemberInvokerBase
|
||||
{
|
||||
virtual ~MemberInvokerBase() = default;
|
||||
};
|
||||
|
||||
template <class Invoker>
|
||||
struct MemberInvoker : MemberInvokerBase
|
||||
{
|
||||
explicit MemberInvoker(Invoker &&invokerIn)
|
||||
: invoker(std::move(invokerIn))
|
||||
{}
|
||||
|
||||
Invoker invoker;
|
||||
};
|
||||
|
||||
} // namespace detail
|
||||
|
||||
/** Structured-concurrency owner for non-viral invokers at non-coroutine boundaries.
|
||||
*
|
||||
* The nursery owns invoker lifetimes until natural completion, wraps completion
|
||||
* callbacks, tracks unsettled slots, fans out cooperative cancel via per-slot
|
||||
* SyncCancelerForAsyncWork, and provides drain APIs.
|
||||
*
|
||||
* Each nursery member must be one complete, self-contained non-viral async
|
||||
* flow. For an external HTTP request, that means one coroutine should shepherd
|
||||
* the whole request from framework callback through all sscl component awaits
|
||||
* to final response/commit/error handling. Do not use the nursery as a place
|
||||
* to reserve a slot, perform partial setup elsewhere, and later return to
|
||||
* fill the slot. Do not add each individual awaited operation as a separate
|
||||
* nursery member. The external submitter should add the complete flow to the
|
||||
* nursery and then return; the nursery owns that flow until the flow settles.
|
||||
*
|
||||
* Call closeAdmission() explicitly before asyncAwaitAllSettlements() or
|
||||
* syncAwaitAllSettlements().
|
||||
*
|
||||
* syncAwaitAllSettlements() runs a nested io_context loop on the calling
|
||||
* thread (AsynchronousBridge). Pass the calling thread's io_context —
|
||||
* typically
|
||||
* ComponentThread::getSelf()->getIoContext() — not another thread's
|
||||
* io_context. If the caller pumps a different thread's queue while blocked,
|
||||
* completions posted back to the caller's own io_context are never executed
|
||||
* and the drain can deadlock even after cooperative cancel.
|
||||
*/
|
||||
class NonViralTaskNursery
|
||||
{
|
||||
public:
|
||||
enum class SlotLeaseStatus {
|
||||
RESERVED, ACTIVE_UNSETTLED, RETIRED
|
||||
};
|
||||
|
||||
enum class SlotSettlementStatus {
|
||||
UNSETTLED, COMPLETED, EXCEPTION_THROWN
|
||||
};
|
||||
|
||||
class Slot
|
||||
{
|
||||
public:
|
||||
/** Opaque handle to a nursery slot. Valid while the slot remains in storage. */
|
||||
class Handle
|
||||
{
|
||||
public:
|
||||
bool operator==(const Handle &_other) const noexcept
|
||||
{ return &slot == &_other.slot; }
|
||||
|
||||
bool operator!=(const Handle &_other) const noexcept
|
||||
{ return &slot != &_other.slot; }
|
||||
|
||||
private:
|
||||
friend class NonViralTaskNursery;
|
||||
friend class Lease;
|
||||
|
||||
explicit Handle(Slot &_slot) noexcept
|
||||
: slot(_slot)
|
||||
{}
|
||||
|
||||
Slot &slot;
|
||||
};
|
||||
|
||||
class Lease
|
||||
{
|
||||
public:
|
||||
Lease(Lease &&_other) noexcept
|
||||
: nursery(_other.nursery), slot(_other.slot),
|
||||
slotCommittedSoLeaseShouldntDestroy(
|
||||
std::exchange(
|
||||
_other.slotCommittedSoLeaseShouldntDestroy,
|
||||
true))
|
||||
{}
|
||||
|
||||
Lease(const Lease &) = delete;
|
||||
Lease &operator=(const Lease &) = delete;
|
||||
Lease &operator=(Lease &&) = delete;
|
||||
|
||||
~Lease()
|
||||
{
|
||||
if (!slotCommittedSoLeaseShouldntDestroy) {
|
||||
nursery.releaseUncommittedSlot(slot);
|
||||
}
|
||||
}
|
||||
|
||||
std::exception_ptr &getExceptionStorage()
|
||||
{ return slot.exceptionPtr; }
|
||||
|
||||
std::function<void()> getCallerLambda()
|
||||
{ return nursery.buildCallerLambdaForSlot(slot); }
|
||||
|
||||
sscl::SyncCancelerForAsyncWork &getSyncCanceler()
|
||||
{ return slot.syncCanceler; }
|
||||
|
||||
void setOnSettledHook(
|
||||
std::function<void(std::exception_ptr &exceptionPtr)> hook)
|
||||
{
|
||||
if (slot.leaseStatus != SlotLeaseStatus::RESERVED)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": must be called before fillSlot()");
|
||||
}
|
||||
|
||||
slot.onSettledHook = std::move(hook);
|
||||
}
|
||||
|
||||
/** Factory must create the invoker. Deferred construction is
|
||||
* required because non-viral coroutines may complete synchronously
|
||||
* during invoker construction, before fillSlot() can store the
|
||||
* record.
|
||||
*/
|
||||
template <class InvokerFactory>
|
||||
void fillSlot(InvokerFactory &&invokerFactory)
|
||||
{
|
||||
Slot &reservedSlot = slot;
|
||||
|
||||
if (reservedSlot.memberInvoker)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": slot already filled");
|
||||
}
|
||||
|
||||
if (reservedSlot.leaseStatus != SlotLeaseStatus::RESERVED)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": slot is not reserved");
|
||||
}
|
||||
|
||||
reservedSlot.leaseStatus = SlotLeaseStatus::ACTIVE_UNSETTLED;
|
||||
auto invoker = invokerFactory();
|
||||
|
||||
if (reservedSlot.leaseStatus == SlotLeaseStatus::RETIRED)
|
||||
{
|
||||
/** EXPLANATION:
|
||||
* Non-viral coroutines may complete synchronously inside
|
||||
* the factory. Retirement already ran; the local invoker
|
||||
* must be allowed to destroy the callee frame on return.
|
||||
*/
|
||||
return;
|
||||
}
|
||||
|
||||
reservedSlot.memberInvoker = std::make_unique<
|
||||
detail::MemberInvoker<std::decay_t<decltype(invoker)>>>(
|
||||
std::move(invoker));
|
||||
}
|
||||
|
||||
void commit()
|
||||
{
|
||||
if (slotCommittedSoLeaseShouldntDestroy)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": lease already committed");
|
||||
}
|
||||
|
||||
Slot &reservedSlot = slot;
|
||||
|
||||
if (reservedSlot.leaseStatus == SlotLeaseStatus::RESERVED)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": fillSlot() required before commit()");
|
||||
}
|
||||
|
||||
slotCommittedSoLeaseShouldntDestroy = true;
|
||||
}
|
||||
|
||||
Handle handle() const
|
||||
{
|
||||
return Handle(slot);
|
||||
}
|
||||
|
||||
private:
|
||||
friend class NonViralTaskNursery;
|
||||
|
||||
Lease(NonViralTaskNursery &_nursery, Slot &_slot) noexcept
|
||||
: nursery(_nursery), slot(_slot)
|
||||
{}
|
||||
|
||||
NonViralTaskNursery &nursery;
|
||||
Slot &slot;
|
||||
bool slotCommittedSoLeaseShouldntDestroy = false;
|
||||
};
|
||||
|
||||
private:
|
||||
friend class NonViralTaskNursery;
|
||||
friend class Lease;
|
||||
|
||||
SlotLeaseStatus leaseStatus = SlotLeaseStatus::RESERVED;
|
||||
SlotSettlementStatus settlementStatus = SlotSettlementStatus::UNSETTLED;
|
||||
std::exception_ptr exceptionPtr = nullptr;
|
||||
sscl::SyncCancelerForAsyncWork syncCanceler;
|
||||
std::unique_ptr<detail::MemberInvokerBase> memberInvoker;
|
||||
std::function<void(std::exception_ptr &exceptionPtr)> onSettledHook;
|
||||
};
|
||||
|
||||
void openAdmission()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
s.rsrc.admissionOpen = true;
|
||||
}
|
||||
|
||||
void closeAdmission()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
s.rsrc.admissionOpen = false;
|
||||
}
|
||||
|
||||
bool admissionIsOpen() const
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
return s.rsrc.admissionOpen;
|
||||
}
|
||||
|
||||
bool allSettled() const
|
||||
{ return unsettledCount() == 0; }
|
||||
|
||||
std::size_t unsettledCount() const
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
return countUnsettledSlotsUnlocked();
|
||||
}
|
||||
|
||||
Slot::Lease getNewSlotLease()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
|
||||
if (!s.rsrc.admissionOpen)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": admission closed");
|
||||
}
|
||||
|
||||
pruneRetiredSlotsUnlocked();
|
||||
s.rsrc.slots.emplace_back();
|
||||
Slot &slot = s.rsrc.slots.back();
|
||||
return Slot::Lease(*this, slot);
|
||||
}
|
||||
|
||||
void requestCancelOnAll()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
|
||||
for (auto &slot : s.rsrc.slots)
|
||||
{
|
||||
if (slot.leaseStatus != SlotLeaseStatus::ACTIVE_UNSETTLED) {
|
||||
continue;
|
||||
}
|
||||
|
||||
slot.syncCanceler.requestStop();
|
||||
}
|
||||
}
|
||||
|
||||
void asyncAwaitAllSettlements(std::function<void()> callback)
|
||||
{
|
||||
std::function<void()> waiterToInvoke;
|
||||
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
|
||||
if (s.rsrc.admissionOpen)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": admission must be closed before awaiting drain");
|
||||
}
|
||||
|
||||
if (countUnsettledSlotsUnlocked() == 0) {
|
||||
waiterToInvoke = std::move(callback);
|
||||
}
|
||||
else if (s.rsrc.drainWaiter)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": drain waiter already registered");
|
||||
}
|
||||
else {
|
||||
s.rsrc.drainWaiter = std::move(callback);
|
||||
}
|
||||
}
|
||||
|
||||
if (waiterToInvoke) {
|
||||
waiterToInvoke();
|
||||
}
|
||||
}
|
||||
|
||||
/** Nested drain: blocks the calling thread in run_one() on @p ioContext until
|
||||
* all slots retire. @p ioContext must be the caller thread's io_context.
|
||||
*/
|
||||
void syncAwaitAllSettlements(boost::asio::io_context &ioContext)
|
||||
{
|
||||
if (admissionIsOpen())
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__)
|
||||
+ ": admission must be closed before awaiting drain");
|
||||
}
|
||||
|
||||
if (allSettled()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (ioContext.stopped())
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": provided io_context is stopped");
|
||||
}
|
||||
|
||||
/** EXPLANATION:
|
||||
* Drain may run on the thread that processes a completion callback,
|
||||
* not necessarily the thread blocked in waitForAsyncOperationComplete.
|
||||
* Keep the bridge off the waiter thread's stack.
|
||||
*/
|
||||
auto bridge = std::make_shared<sscl::cps::AsynchronousBridge>(
|
||||
ioContext);
|
||||
asyncAwaitAllSettlements(
|
||||
[bridge]()
|
||||
{
|
||||
bridge->setAsyncOperationComplete();
|
||||
});
|
||||
|
||||
bridge->waitForAsyncOperationCompleteOrIoContextStopped();
|
||||
}
|
||||
|
||||
template <class InvokerFactory>
|
||||
Slot::Handle launch(
|
||||
InvokerFactory &&factory,
|
||||
std::function<void(std::exception_ptr &exceptionPtr)> onSettledHook =
|
||||
nullptr)
|
||||
{
|
||||
auto lease = getNewSlotLease();
|
||||
lease.getSyncCanceler().startAcceptingWork();
|
||||
if (onSettledHook) {
|
||||
lease.setOnSettledHook(std::move(onSettledHook));
|
||||
}
|
||||
lease.fillSlot(
|
||||
[&factory, &lease]()
|
||||
{
|
||||
return std::forward<InvokerFactory>(factory)(lease);
|
||||
});
|
||||
lease.commit();
|
||||
return lease.handle();
|
||||
}
|
||||
|
||||
private:
|
||||
friend class Slot::Lease;
|
||||
|
||||
struct State
|
||||
{
|
||||
bool admissionOpen = false;
|
||||
std::list<Slot> slots;
|
||||
std::function<void()> drainWaiter;
|
||||
};
|
||||
|
||||
std::size_t countUnsettledSlotsUnlocked() const
|
||||
{
|
||||
std::size_t count = 0;
|
||||
|
||||
for (const auto &slot : s.rsrc.slots)
|
||||
{
|
||||
if (slot.leaseStatus == SlotLeaseStatus::ACTIVE_UNSETTLED) {
|
||||
++count;
|
||||
}
|
||||
}
|
||||
|
||||
return count;
|
||||
}
|
||||
|
||||
void releaseUncommittedSlot(Slot &slot)
|
||||
{
|
||||
std::function<void()> waiterToInvoke;
|
||||
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
|
||||
if (slot.leaseStatus != SlotLeaseStatus::RESERVED) {
|
||||
return;
|
||||
}
|
||||
|
||||
slot.leaseStatus = SlotLeaseStatus::RETIRED;
|
||||
slot.memberInvoker.reset();
|
||||
waiterToInvoke = takeDrainWaiterIfDrainedUnlocked();
|
||||
}
|
||||
|
||||
if (waiterToInvoke) { waiterToInvoke(); }
|
||||
}
|
||||
|
||||
std::function<void()> buildCallerLambdaForSlot(Slot &slot)
|
||||
{
|
||||
return
|
||||
[this, slot = std::ref(slot)]()
|
||||
{
|
||||
retireSlot(slot.get());
|
||||
};
|
||||
}
|
||||
|
||||
void retireSlot(Slot &slot)
|
||||
{
|
||||
std::function<void()> waiterToInvoke;
|
||||
std::function<void(std::exception_ptr &exceptionPtr)> onSettledHook;
|
||||
std::exception_ptr settledExceptionPtr;
|
||||
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
|
||||
if (slot.leaseStatus != SlotLeaseStatus::ACTIVE_UNSETTLED)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": slot is not active and "
|
||||
"unsettled");
|
||||
}
|
||||
if (slot.settlementStatus != SlotSettlementStatus::UNSETTLED) {
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": slot is not unsettled");
|
||||
}
|
||||
|
||||
if (!verifySlotIsManagedUnlocked(slot)) {
|
||||
return;
|
||||
}
|
||||
|
||||
settledExceptionPtr = slot.exceptionPtr;
|
||||
if (settledExceptionPtr) {
|
||||
slot.settlementStatus = SlotSettlementStatus::EXCEPTION_THROWN;
|
||||
} else {
|
||||
slot.settlementStatus = SlotSettlementStatus::COMPLETED;
|
||||
}
|
||||
|
||||
onSettledHook = std::move(slot.onSettledHook);
|
||||
slot.leaseStatus = SlotLeaseStatus::RETIRED;
|
||||
slot.memberInvoker.reset();
|
||||
waiterToInvoke = takeDrainWaiterIfDrainedUnlocked();
|
||||
}
|
||||
|
||||
if (onSettledHook) {
|
||||
onSettledHook(settledExceptionPtr);
|
||||
}
|
||||
|
||||
if (waiterToInvoke) { waiterToInvoke(); }
|
||||
}
|
||||
|
||||
/** Caller must hold s.lock. */
|
||||
bool verifySlotIsManagedUnlocked(const Slot &slot) const
|
||||
{
|
||||
for (const auto &trackedSlot : s.rsrc.slots)
|
||||
{
|
||||
if (&trackedSlot == &slot) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/** Caller must hold s.lock. */
|
||||
void pruneRetiredSlotsUnlocked()
|
||||
{
|
||||
for (auto it = s.rsrc.slots.begin(); it != s.rsrc.slots.end();)
|
||||
{
|
||||
if (it->leaseStatus == SlotLeaseStatus::RETIRED) {
|
||||
it = s.rsrc.slots.erase(it);
|
||||
} else {
|
||||
++it;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Caller must hold s.lock. */
|
||||
std::function<void()> takeDrainWaiterIfDrainedUnlocked()
|
||||
{
|
||||
if (s.rsrc.admissionOpen) {
|
||||
return {};
|
||||
}
|
||||
|
||||
if (countUnsettledSlotsUnlocked() != 0) {
|
||||
return {};
|
||||
}
|
||||
|
||||
return std::exchange(s.rsrc.drainWaiter, {});
|
||||
}
|
||||
|
||||
public:
|
||||
mutable sscl::SharedResourceGroup<sscl::SpinLock, State> s;
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // NON_VIRAL_TASK_NURSERY_H
|
||||
@@ -0,0 +1,29 @@
|
||||
#ifndef POST_TARGET_H
|
||||
#define POST_TARGET_H
|
||||
|
||||
#include <type_traits>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
/** Opt-in dynamic post-TO target for TaggedPostingPromise coroutines.
|
||||
* When omitted, initial_suspend posts to ThreadTag::io_context().
|
||||
* Post-back still uses callerIoContext (getSelf() at co_await site).
|
||||
*/
|
||||
struct ExplicitPostTarget
|
||||
{
|
||||
boost::asio::io_context& ioContext;
|
||||
|
||||
explicit ExplicitPostTarget(boost::asio::io_context& ctx) noexcept
|
||||
: ioContext(ctx)
|
||||
{}
|
||||
};
|
||||
|
||||
template<typename T>
|
||||
inline constexpr bool is_explicit_post_target_v =
|
||||
std::same_as<std::remove_cvref_t<T>, ExplicitPostTarget>;
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // POST_TARGET_H
|
||||
@@ -1,96 +1,33 @@
|
||||
#ifndef PROMISES_H
|
||||
#define PROMISES_H
|
||||
#ifndef POSTING_PROMISE_H
|
||||
#define POSTING_PROMISE_H
|
||||
|
||||
#include <config.h>
|
||||
#include <coroutine>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <iostream>
|
||||
#include <optional>
|
||||
#include <typeinfo>
|
||||
#include <thread>
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/componentThread.h>
|
||||
#include <spinscale/co/coQutex.h>
|
||||
#include <spinscale/co/nonViralCompletion.h>
|
||||
#include <spinscale/co/postTarget.h>
|
||||
#include <spinscale/co/promiseChainLink.h>
|
||||
#include <spinscale/co/promiseReturnOps.h>
|
||||
#include <spinscale/co/returnValues.h>
|
||||
#include <spinscale/spinLock.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
class PostingInvoker;
|
||||
|
||||
template <typename T, bool IsVoid = std::is_void_v<T>>
|
||||
struct ReturnValueStorage;
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValueStorage<T, false>
|
||||
{
|
||||
T myReturnValue{};
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValueStorage<T, true>
|
||||
{
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValues
|
||||
: public ReturnValueStorage<T>
|
||||
{
|
||||
ReturnValues() noexcept
|
||||
: myExceptionPtr(myMemberExceptionPtr)
|
||||
{}
|
||||
|
||||
explicit ReturnValues(std::exception_ptr &callerExceptionPtr) noexcept
|
||||
: myExceptionPtr(callerExceptionPtr)
|
||||
{}
|
||||
|
||||
~ReturnValues() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Destructing.\n";
|
||||
#endif
|
||||
}
|
||||
|
||||
/** EXPLANATION:
|
||||
* The exception_ptr ref here can either point to the exception_ptr
|
||||
* a non-viral coroutine supplied to us as its storage space for
|
||||
* where we should store any exception that is thrown;
|
||||
*
|
||||
* Or it could point to the member exception_ptr in this very class,
|
||||
* which is used for viral coroutines that can bubble their exception
|
||||
* up and automatically via the language runtime.
|
||||
*/
|
||||
std::exception_ptr &myExceptionPtr;
|
||||
std::exception_ptr myMemberExceptionPtr = nullptr;
|
||||
};
|
||||
|
||||
/** `return_value` / `return_void` only. ThreadTag is not a template parameter here:
|
||||
* for tagged promises, PromiseType is `TaggedPostingPromise<T, ThreadTag>`.
|
||||
*/
|
||||
template <typename PromiseType, typename T, bool IsVoid = std::is_void_v<T>>
|
||||
struct PostingPromiseReturnOps;
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
struct PostingPromiseReturnOps<PromiseType, T, false>
|
||||
{
|
||||
void return_value(T returnValue) noexcept
|
||||
{
|
||||
static_cast<PromiseType *>(this)->returnValues.myReturnValue = std::move(returnValue);
|
||||
}
|
||||
};
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
struct PostingPromiseReturnOps<PromiseType, T, true>
|
||||
{
|
||||
void return_void() noexcept
|
||||
{
|
||||
return;
|
||||
}
|
||||
};
|
||||
class Invoker;
|
||||
|
||||
template <typename T>
|
||||
struct PostingPromise
|
||||
@@ -190,19 +127,19 @@ struct PostingPromise
|
||||
: public std::suspend_always
|
||||
{
|
||||
InitialSuspendPostingInvoker(
|
||||
boost::asio::io_service &targetIoServiceIn,
|
||||
boost::asio::io_context &targetIoContextIn,
|
||||
std::coroutine_handle<> targetSchedHandleIn) noexcept
|
||||
: targetIoService(targetIoServiceIn),
|
||||
: targetIoContext(targetIoContextIn),
|
||||
targetSchedHandle(targetSchedHandleIn)
|
||||
{}
|
||||
|
||||
bool await_suspend(std::coroutine_handle<> const) noexcept
|
||||
{
|
||||
boost::asio::post(targetIoService, targetSchedHandle);
|
||||
boost::asio::post(targetIoContext, targetSchedHandle);
|
||||
return true;
|
||||
}
|
||||
|
||||
boost::asio::io_service &targetIoService;
|
||||
boost::asio::io_context &targetIoContext;
|
||||
std::coroutine_handle<> targetSchedHandle;
|
||||
};
|
||||
|
||||
@@ -228,15 +165,12 @@ struct PostingPromise
|
||||
std::cout << "final_suspend" << ": " << std::this_thread::get_id()
|
||||
<< " Non-viral: posting callerLambda completion to callerIoContext.\n";
|
||||
#endif
|
||||
auto callerLambda = std::move(calleePromise.callerLambda);
|
||||
boost::asio::post(
|
||||
calleePromise.callerIoContext,
|
||||
[&calleeRef = calleePromise]()
|
||||
[callerLambda = std::move(callerLambda)]() mutable
|
||||
{
|
||||
if (calleeRef.returnValues.myExceptionPtr) {
|
||||
std::rethrow_exception(calleeRef.returnValues.myExceptionPtr);
|
||||
}
|
||||
|
||||
calleeRef.callerLambda();
|
||||
callerLambda();
|
||||
});
|
||||
}
|
||||
else
|
||||
@@ -257,6 +191,7 @@ struct PostingPromise
|
||||
: returnValues(), postBackStatus(*this)
|
||||
{}
|
||||
|
||||
/** Non-viral entry: post-TO uses ThreadTag default (via TaggedPostingPromise). */
|
||||
template <typename... TailArgs>
|
||||
PostingPromise(
|
||||
std::exception_ptr &_callerExceptionPtr,
|
||||
@@ -267,6 +202,93 @@ struct PostingPromise
|
||||
postBackStatus(*this)
|
||||
{}
|
||||
|
||||
/** Non-viral entry with explicit post-TO target. */
|
||||
template <typename... TailArgs>
|
||||
PostingPromise(
|
||||
ExplicitPostTarget _calleePostTarget,
|
||||
std::exception_ptr &_callerExceptionPtr,
|
||||
std::function<void()> _callerLambda,
|
||||
TailArgs &&...) noexcept
|
||||
: returnValues(_callerExceptionPtr),
|
||||
callerLambda(std::move(_callerLambda)),
|
||||
calleePostTarget(std::move(_calleePostTarget)),
|
||||
postBackStatus(*this)
|
||||
{}
|
||||
|
||||
/** Viral / free-function entry with explicit post-TO target. */
|
||||
template <typename... TailArgs>
|
||||
PostingPromise(
|
||||
ExplicitPostTarget _calleePostTarget,
|
||||
TailArgs &&...) noexcept
|
||||
: returnValues(),
|
||||
calleePostTarget(std::move(_calleePostTarget)),
|
||||
postBackStatus(*this)
|
||||
{}
|
||||
|
||||
/** Viral / free-function entry: post-TO uses ThreadTag default. */
|
||||
template <typename FirstArg, typename... TailArgs>
|
||||
requires (!is_explicit_post_target_v<std::remove_cvref_t<FirstArg>>)
|
||||
PostingPromise(FirstArg &&, TailArgs &&...) noexcept
|
||||
: PostingPromise()
|
||||
{}
|
||||
|
||||
/** Member non-viral: peel implicit object parameter. */
|
||||
template <typename ObjectArg, typename... TailArgs>
|
||||
requires (
|
||||
!std::same_as<std::remove_cvref_t<ObjectArg>, std::exception_ptr>
|
||||
&& !is_explicit_post_target_v<std::remove_cvref_t<ObjectArg>>)
|
||||
PostingPromise(
|
||||
ObjectArg &&,
|
||||
std::exception_ptr &_callerExceptionPtr,
|
||||
std::function<void()> _callerLambda,
|
||||
TailArgs &&...) noexcept
|
||||
: PostingPromise(
|
||||
_callerExceptionPtr,
|
||||
std::move(_callerLambda))
|
||||
{}
|
||||
|
||||
/** Member non-viral with explicit post-TO target. */
|
||||
template <typename ObjectArg, typename... TailArgs>
|
||||
requires (
|
||||
!std::same_as<std::remove_cvref_t<ObjectArg>, std::exception_ptr>
|
||||
&& !is_explicit_post_target_v<std::remove_cvref_t<ObjectArg>>)
|
||||
PostingPromise(
|
||||
ObjectArg &&,
|
||||
ExplicitPostTarget _calleePostTarget,
|
||||
std::exception_ptr &_callerExceptionPtr,
|
||||
std::function<void()> _callerLambda,
|
||||
TailArgs &&...) noexcept
|
||||
: PostingPromise(
|
||||
std::move(_calleePostTarget),
|
||||
_callerExceptionPtr,
|
||||
std::move(_callerLambda))
|
||||
{}
|
||||
|
||||
/** Member viral with explicit post-TO target. */
|
||||
template <typename ObjectArg, typename... TailArgs>
|
||||
requires (
|
||||
!std::same_as<std::remove_cvref_t<ObjectArg>, std::exception_ptr>
|
||||
&& !is_explicit_post_target_v<std::remove_cvref_t<ObjectArg>>)
|
||||
PostingPromise(
|
||||
ObjectArg &&,
|
||||
ExplicitPostTarget _calleePostTarget,
|
||||
TailArgs &&...) noexcept
|
||||
: PostingPromise(std::move(_calleePostTarget))
|
||||
{}
|
||||
|
||||
/** Member viral: peel implicit object parameter. */
|
||||
template <typename ObjectArg, typename FirstArg, typename... TailArgs>
|
||||
requires (
|
||||
!std::same_as<std::remove_cvref_t<ObjectArg>, std::exception_ptr>
|
||||
&& !is_explicit_post_target_v<std::remove_cvref_t<ObjectArg>>
|
||||
&& !is_explicit_post_target_v<std::remove_cvref_t<FirstArg>>)
|
||||
PostingPromise(
|
||||
ObjectArg &&,
|
||||
FirstArg &&,
|
||||
TailArgs &&...) noexcept
|
||||
: PostingPromise()
|
||||
{}
|
||||
|
||||
~PostingPromise() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
@@ -303,8 +325,9 @@ struct PostingPromise
|
||||
|
||||
ReturnValues<T> returnValues;
|
||||
std::function<void()> callerLambda;
|
||||
boost::asio::io_service &callerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoService();
|
||||
boost::asio::io_context &callerIoContext =
|
||||
sscl::ComponentThread::getSelf()->getIoContext();
|
||||
std::optional<ExplicitPostTarget> calleePostTarget;
|
||||
std::coroutine_handle<> selfSchedHandle;
|
||||
std::coroutine_handle<void> callerSchedHandle;
|
||||
PromiseChainLink *callerChainLink = nullptr;
|
||||
@@ -322,28 +345,15 @@ protected:
|
||||
}
|
||||
|
||||
template <typename, typename>
|
||||
friend class PostingInvoker;
|
||||
friend class Invoker;
|
||||
};
|
||||
|
||||
template <typename T, typename ThreadTag>
|
||||
struct TaggedPostingPromise
|
||||
: public PostingPromise<T>,
|
||||
public PostingPromiseReturnOps<TaggedPostingPromise<T, ThreadTag>, T>
|
||||
public PromiseReturnOps<TaggedPostingPromise<T, ThreadTag>, T>
|
||||
{
|
||||
TaggedPostingPromise() noexcept
|
||||
: PostingPromise<T>()
|
||||
{}
|
||||
|
||||
template <typename... TailArgs>
|
||||
TaggedPostingPromise(
|
||||
std::exception_ptr &_exceptionPtr,
|
||||
std::function<void()> _callerLambda,
|
||||
TailArgs &&... tailArgs) noexcept
|
||||
: PostingPromise<T>(
|
||||
_exceptionPtr,
|
||||
std::move(_callerLambda),
|
||||
std::forward<TailArgs>(tailArgs)...)
|
||||
{}
|
||||
using PostingPromise<T>::PostingPromise;
|
||||
|
||||
auto initial_suspend() noexcept
|
||||
{
|
||||
@@ -351,12 +361,17 @@ struct TaggedPostingPromise
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " About to post selfSchedHandle to " << typeid(ThreadTag).name() << ".\n";
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id() << " Returning InitialSuspendPostingInvoker.\n";
|
||||
#endif
|
||||
boost::asio::io_context &postToIoContext =
|
||||
this->calleePostTarget
|
||||
? this->calleePostTarget->ioContext
|
||||
: ThreadTag::io_context();
|
||||
|
||||
return typename PostingPromise<T>::InitialSuspendPostingInvoker(
|
||||
ThreadTag::io_service(),
|
||||
postToIoContext,
|
||||
this->selfSchedHandle);
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // PROMISES_H
|
||||
#endif // POSTING_PROMISE_H
|
||||
@@ -0,0 +1,38 @@
|
||||
#ifndef PROMISE_RETURN_OPS_H
|
||||
#define PROMISE_RETURN_OPS_H
|
||||
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
#include <spinscale/co/returnValues.h>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
/** `return_value` / `return_void` only. ThreadTag is not a template parameter here:
|
||||
* for tagged promises, PromiseType is `TaggedPostingPromise<T, ThreadTag>`.
|
||||
*/
|
||||
template <typename PromiseType, typename T, bool IsVoid = std::is_void_v<T>>
|
||||
struct PromiseReturnOps;
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
struct PromiseReturnOps<PromiseType, T, false>
|
||||
{
|
||||
void return_value(T returnValue) noexcept
|
||||
{
|
||||
static_cast<PromiseType *>(this)->returnValues.myReturnValue =
|
||||
std::move(returnValue);
|
||||
}
|
||||
};
|
||||
|
||||
template <typename PromiseType, typename T>
|
||||
struct PromiseReturnOps<PromiseType, T, true>
|
||||
{
|
||||
void return_void() noexcept
|
||||
{
|
||||
return;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // PROMISE_RETURN_OPS_H
|
||||
@@ -0,0 +1,61 @@
|
||||
#ifndef RETURN_VALUES_H
|
||||
#define RETURN_VALUES_H
|
||||
|
||||
#include <config.h>
|
||||
#include <exception>
|
||||
#include <iostream>
|
||||
#include <thread>
|
||||
#include <type_traits>
|
||||
|
||||
namespace sscl::co {
|
||||
|
||||
template <typename T, bool IsVoid = std::is_void_v<T>>
|
||||
struct ReturnValueStorage;
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValueStorage<T, false>
|
||||
{
|
||||
T myReturnValue{};
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValueStorage<T, true>
|
||||
{
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct ReturnValues
|
||||
: public ReturnValueStorage<T>
|
||||
{
|
||||
ReturnValues() noexcept
|
||||
: myExceptionPtr(myMemberExceptionPtr)
|
||||
{}
|
||||
|
||||
explicit ReturnValues(std::exception_ptr &callerExceptionPtr) noexcept
|
||||
: myExceptionPtr(callerExceptionPtr)
|
||||
{}
|
||||
|
||||
~ReturnValues() noexcept
|
||||
{
|
||||
#ifdef CONFIG_LIBSSCL_DEBUG_CO
|
||||
std::cout << __func__ << ": " << std::this_thread::get_id()
|
||||
<< " Destructing.\n";
|
||||
#endif
|
||||
}
|
||||
|
||||
/** EXPLANATION:
|
||||
* The exception_ptr ref here can either point to the exception_ptr
|
||||
* a non-viral coroutine supplied to us as its storage space for
|
||||
* where we should store any exception that is thrown;
|
||||
*
|
||||
* Or it could point to the member exception_ptr in this very class,
|
||||
* which is used for viral coroutines that can bubble their exception
|
||||
* up and automatically via the language runtime.
|
||||
*/
|
||||
std::exception_ptr &myExceptionPtr;
|
||||
std::exception_ptr myMemberExceptionPtr = nullptr;
|
||||
};
|
||||
|
||||
} // namespace sscl::co
|
||||
|
||||
#endif // RETURN_VALUES_H
|
||||
@@ -4,7 +4,7 @@
|
||||
#include <config.h>
|
||||
#include <atomic>
|
||||
#include <memory>
|
||||
#include <spinscale/callback.h>
|
||||
#include <spinscale/cps/callback.h>
|
||||
#include <spinscale/puppetApplication.h>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
#ifndef COMPONENT_THREAD_H
|
||||
#define COMPONENT_THREAD_H
|
||||
|
||||
#include <boostAsioLinkageFix.h>
|
||||
#include <atomic>
|
||||
#include <thread>
|
||||
#include <unordered_map>
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <stdexcept>
|
||||
#include <queue>
|
||||
#include <functional>
|
||||
@@ -13,9 +11,12 @@
|
||||
#include <sched.h>
|
||||
#include <unistd.h>
|
||||
#include <memory>
|
||||
#include <spinscale/callback.h>
|
||||
#include <coroutine>
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
#include <spinscale/cps/callback.h>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
@@ -34,7 +35,8 @@ class ComponentThread
|
||||
{
|
||||
protected:
|
||||
ComponentThread(ThreadId _id, std::string _name)
|
||||
: id(_id), name(std::move(_name)), work(io_service), keepLooping(true)
|
||||
: id(_id), name(std::move(_name)),
|
||||
work(boost::asio::make_work_guard(io_context)), keepLooping(true)
|
||||
{}
|
||||
|
||||
public:
|
||||
@@ -42,7 +44,7 @@ public:
|
||||
|
||||
void cleanup(void);
|
||||
|
||||
boost::asio::io_service& getIoService(void) { return io_service; }
|
||||
boost::asio::io_context& getIoContext(void) { return io_context; }
|
||||
|
||||
static const std::shared_ptr<ComponentThread> getSelf(void);
|
||||
static bool tlsInitialized(void);
|
||||
@@ -64,8 +66,9 @@ public:
|
||||
public:
|
||||
ThreadId id;
|
||||
std::string name;
|
||||
boost::asio::io_service io_service;
|
||||
boost::asio::io_service::work work;
|
||||
boost::asio::io_context io_context;
|
||||
boost::asio::executor_work_guard<
|
||||
boost::asio::io_context::executor_type> work;
|
||||
std::atomic<bool> keepLooping;
|
||||
};
|
||||
|
||||
@@ -151,7 +154,7 @@ public:
|
||||
preJoltHookFn preJoltFn)
|
||||
: ComponentThread(_id, std::move(name)),
|
||||
pinnedCpuId(-1),
|
||||
pause_work(pause_io_service),
|
||||
pause_work(boost::asio::make_work_guard(pause_io_context)),
|
||||
entryFnArguments(*this, component, preJoltFn),
|
||||
thread(std::move(entryPoint), std::cref(entryFnArguments))
|
||||
{}
|
||||
@@ -160,12 +163,115 @@ public:
|
||||
|
||||
void initializeTls(void);
|
||||
|
||||
// Thread management methods
|
||||
typedef std::function<void()> threadLifetimeMgmtOpCbFn;
|
||||
void startThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void exitThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void pauseThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void resumeThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
|
||||
struct ViralThreadLifetimeMgmtInvoker
|
||||
{
|
||||
struct AsyncState
|
||||
{
|
||||
std::atomic<bool> settled{false};
|
||||
std::coroutine_handle<> callerSchedHandle;
|
||||
};
|
||||
|
||||
ViralThreadLifetimeMgmtInvoker(
|
||||
ThreadOp _threadOp,
|
||||
PuppetThread &_parentThread,
|
||||
const std::shared_ptr<PuppetThread> &_selfPtr = nullptr)
|
||||
: threadOp(_threadOp),
|
||||
asyncState(std::make_shared<AsyncState>()),
|
||||
parentThread(_parentThread),
|
||||
selfPtr(_selfPtr),
|
||||
lifetimeMgmtCallback{
|
||||
nullptr,
|
||||
[asyncState = asyncState]()
|
||||
{
|
||||
asyncState->settled.store(true, std::memory_order_release);
|
||||
|
||||
std::coroutine_handle<> handle =
|
||||
asyncState->callerSchedHandle;
|
||||
|
||||
if (!handle) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** Post resume to the puppeteer queue: direct resume() from
|
||||
* within an asio completion handler can destroy adapter
|
||||
* coroutine state while the handler is still unwinding.
|
||||
*/
|
||||
boost::asio::post(
|
||||
ComponentThread::getPptr()->getIoContext(),
|
||||
[handle]() { handle.resume(); });
|
||||
}}
|
||||
{
|
||||
if (threadOp == ThreadOp::JOLT && selfPtr == nullptr)
|
||||
{
|
||||
throw std::runtime_error(std::string(__func__)
|
||||
+ ": JOLT request must be made with a valid selfPtr");
|
||||
}
|
||||
|
||||
switch (threadOp)
|
||||
{
|
||||
case ThreadOp::START:
|
||||
parentThread.startThreadReq(lifetimeMgmtCallback);
|
||||
break;
|
||||
case ThreadOp::PAUSE:
|
||||
parentThread.pauseThreadReq(lifetimeMgmtCallback);
|
||||
break;
|
||||
case ThreadOp::RESUME:
|
||||
parentThread.resumeThreadReq(lifetimeMgmtCallback);
|
||||
break;
|
||||
case ThreadOp::EXIT:
|
||||
parentThread.exitThreadReq(lifetimeMgmtCallback);
|
||||
break;
|
||||
case ThreadOp::JOLT:
|
||||
parentThread.joltThreadReq(selfPtr, lifetimeMgmtCallback);
|
||||
break;
|
||||
|
||||
default:
|
||||
throw std::runtime_error(std::string(__func__)
|
||||
+ ": Invalid thread operation");
|
||||
}
|
||||
}
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{
|
||||
return asyncState->settled.load(std::memory_order_acquire);
|
||||
}
|
||||
|
||||
bool await_suspend(
|
||||
std::coroutine_handle<> _callerSchedHandle) noexcept
|
||||
{
|
||||
if (asyncState->settled.load(std::memory_order_acquire)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
asyncState->callerSchedHandle = _callerSchedHandle;
|
||||
return true;
|
||||
}
|
||||
|
||||
void await_resume() noexcept {}
|
||||
|
||||
ThreadOp threadOp;
|
||||
std::shared_ptr<AsyncState> asyncState;
|
||||
PuppetThread &parentThread;
|
||||
const std::shared_ptr<PuppetThread> selfPtr;
|
||||
cps::Callback<threadLifetimeMgmtOpCbFn> lifetimeMgmtCallback;
|
||||
};
|
||||
|
||||
// Thread lifetime management request invokers
|
||||
ViralThreadLifetimeMgmtInvoker startThreadAReq()
|
||||
{ return ViralThreadLifetimeMgmtInvoker(ThreadOp::START, *this); }
|
||||
ViralThreadLifetimeMgmtInvoker pauseThreadAReq()
|
||||
{ return ViralThreadLifetimeMgmtInvoker(ThreadOp::PAUSE, *this); }
|
||||
ViralThreadLifetimeMgmtInvoker resumeThreadAReq()
|
||||
{ return ViralThreadLifetimeMgmtInvoker(ThreadOp::RESUME, *this); }
|
||||
ViralThreadLifetimeMgmtInvoker exitThreadAReq()
|
||||
{ return ViralThreadLifetimeMgmtInvoker(ThreadOp::EXIT, *this); }
|
||||
|
||||
void startThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void exitThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void pauseThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
void resumeThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
|
||||
/**
|
||||
* JOLTs this thread to begin processing after global initialization.
|
||||
@@ -178,17 +284,22 @@ public:
|
||||
* isn't set up yet, so shared_from_this() can't be used)
|
||||
* @param callback Callback to invoke when JOLT completes
|
||||
*/
|
||||
ViralThreadLifetimeMgmtInvoker joltThreadAReq(
|
||||
const std::shared_ptr<PuppetThread> &selfPtr)
|
||||
{ return ViralThreadLifetimeMgmtInvoker(ThreadOp::JOLT, *this, selfPtr); }
|
||||
|
||||
void joltThreadReq(
|
||||
const std::shared_ptr<PuppetThread>& selfPtr,
|
||||
Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
cps::Callback<threadLifetimeMgmtOpCbFn> callback);
|
||||
|
||||
// CPU management methods
|
||||
void pinToCpu(int cpuId);
|
||||
|
||||
public:
|
||||
int pinnedCpuId;
|
||||
boost::asio::io_service pause_io_service;
|
||||
boost::asio::io_service::work pause_work;
|
||||
boost::asio::io_context pause_io_context;
|
||||
boost::asio::executor_work_guard<
|
||||
boost::asio::io_context::executor_type> pause_work;
|
||||
|
||||
public:
|
||||
EntryFnArguments entryFnArguments;
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
#ifndef ASYNCHRONOUS_BRIDGE_H
|
||||
#define ASYNCHRONOUS_BRIDGE_H
|
||||
|
||||
#include <atomic>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
namespace sscl::cps {
|
||||
|
||||
class AsynchronousBridge
|
||||
{
|
||||
public:
|
||||
AsynchronousBridge(boost::asio::io_context &io_context)
|
||||
: isAsyncOperationComplete(false), io_context(io_context)
|
||||
{}
|
||||
|
||||
void setAsyncOperationComplete(void)
|
||||
{
|
||||
/** EXPLANATION:
|
||||
* This empty post()ed message is necessary to ensure that the thread
|
||||
* that's waiting on the io_context is signaled to wake up and check
|
||||
* the io_context's queue.
|
||||
*/
|
||||
isAsyncOperationComplete.store(true);
|
||||
boost::asio::post(io_context, []{});
|
||||
}
|
||||
|
||||
/** Blocks the calling thread in run_one() on the bridge's io_context.
|
||||
* Used by syncAwaitAllSettlements(); that io_context must be the caller
|
||||
* thread's own queue so posted completions on the caller are not starved.
|
||||
*/
|
||||
void waitForAsyncOperationCompleteOrIoContextStopped(void)
|
||||
{
|
||||
for (;;)
|
||||
{
|
||||
io_context.run_one();
|
||||
if (isAsyncOperationComplete.load() || io_context.stopped())
|
||||
{ break; }
|
||||
|
||||
/** EXPLANATION:
|
||||
* In the puppeteer and mind thread loops we call checkException()
|
||||
* after run() returns, but we don't have to do that here because
|
||||
* setException() calls stop().
|
||||
*
|
||||
* So if an exception is set on our thread, we'll break out of this
|
||||
* loop due to the check for stopped() above, and that'll take us
|
||||
* back out to the main loop, where we'll catch the exception.
|
||||
*/
|
||||
}
|
||||
}
|
||||
|
||||
bool exitedBecauseIoContextStopped(void) const
|
||||
{ return io_context.stopped(); }
|
||||
|
||||
private:
|
||||
std::atomic<bool> isAsyncOperationComplete;
|
||||
boost::asio::io_context &io_context;
|
||||
};
|
||||
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // ASYNCHRONOUS_BRIDGE_H
|
||||
+9
-9
@@ -5,12 +5,12 @@
|
||||
#include <memory>
|
||||
#include <exception>
|
||||
#include <spinscale/componentThread.h>
|
||||
#include <spinscale/callback.h>
|
||||
#include <spinscale/callableTracer.h>
|
||||
#include <spinscale/asynchronousContinuationChainLink.h>
|
||||
#include <spinscale/cps/callback.h>
|
||||
#include <spinscale/cps/callableTracer.h>
|
||||
#include <spinscale/cps/asynchronousContinuationChainLink.h>
|
||||
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
/**
|
||||
* AsynchronousContinuation - Template base class for async sequence management
|
||||
@@ -90,7 +90,7 @@ public:
|
||||
* LockedNonPostedAsynchronousContinuation because the only way to implement
|
||||
* non-posted locking would be via busy-spinning or sleeplocks. This would
|
||||
* eliminate the throughput advantage from our Qspinning mechanism, which
|
||||
* relies on re-posting to the io_service queue when locks are unavailable.
|
||||
* relies on re-posting to the io_context queue when locks are unavailable.
|
||||
*/
|
||||
template <class OriginalCbFnT>
|
||||
class NonPostedAsynchronousContinuation
|
||||
@@ -129,7 +129,7 @@ class PostedAsynchronousContinuation
|
||||
{
|
||||
public:
|
||||
PostedAsynchronousContinuation(
|
||||
const std::shared_ptr<ComponentThread> &caller,
|
||||
const std::shared_ptr<sscl::ComponentThread> &caller,
|
||||
Callback<OriginalCbFnT> originalCbFn)
|
||||
: AsynchronousContinuation<OriginalCbFnT>(originalCbFn),
|
||||
caller(caller)
|
||||
@@ -141,7 +141,7 @@ public:
|
||||
if (AsynchronousContinuation<OriginalCbFnT>::originalCallback
|
||||
.callbackFn)
|
||||
{
|
||||
caller->getIoService().post(
|
||||
boost::asio::post(caller->getIoContext(),
|
||||
STC(std::bind(
|
||||
AsynchronousContinuation<OriginalCbFnT>::originalCallback
|
||||
.callbackFn,
|
||||
@@ -150,9 +150,9 @@ public:
|
||||
}
|
||||
|
||||
public:
|
||||
std::shared_ptr<ComponentThread> caller;
|
||||
std::shared_ptr<sscl::ComponentThread> caller;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // ASYNCHRONOUS_CONTINUATION_H
|
||||
+4
-4
@@ -4,10 +4,10 @@
|
||||
#include <functional>
|
||||
#include <memory>
|
||||
#include <optional>
|
||||
#include <vector>
|
||||
#include <spinscale/lockSet.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
class LockSet;
|
||||
|
||||
/**
|
||||
* @brief Base class for all asynchronous continuation chain links
|
||||
@@ -38,6 +38,6 @@ public:
|
||||
{ return std::nullopt; }
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // ASYNCHRONOUS_CONTINUATION_CHAIN_LINK_H
|
||||
@@ -8,14 +8,14 @@
|
||||
#include <cstdint>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
/**
|
||||
* @brief CallableTracer - Wraps callables with metadata for debugging
|
||||
*
|
||||
* This class wraps any callable object with metadata (caller function name,
|
||||
* line number, and return addresses) to help debug cases where callables
|
||||
* posted to boost::asio::io_service have gone out of scope. The metadata
|
||||
* posted to boost::asio::io_context have gone out of scope. The metadata
|
||||
* can be accessed from the callable's address when debugging.
|
||||
*/
|
||||
class CallableTracer
|
||||
@@ -49,8 +49,8 @@ public:
|
||||
if (optTraceCallables)
|
||||
{
|
||||
std::cout << "" << __func__ << ": On thread "
|
||||
<< (ComponentThread::tlsInitialized()
|
||||
? ComponentThread::getSelf()->name : "<TLS un-init'ed>")
|
||||
<< (sscl::ComponentThread::tlsInitialized()
|
||||
? sscl::ComponentThread::getSelf()->name : "<TLS un-init'ed>")
|
||||
<< ": Calling callable posted by:\n"
|
||||
<< "\t" << callerFuncName << "\n\tat line " << (int)callerLine
|
||||
<< " return addr 0: " << returnAddr0
|
||||
@@ -79,7 +79,7 @@ private:
|
||||
std::function<void()> callable;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
/**
|
||||
* @brief STC - SMO Traceable Callable macro
|
||||
@@ -100,7 +100,7 @@ private:
|
||||
* - Fallback: nullptr for return addresses
|
||||
*
|
||||
* Usage:
|
||||
* thread->getIoService().post(
|
||||
* boost::asio::post(thread->getIoContext(),
|
||||
* STC(std::bind(&SomeClass::method, this, arg1, arg2)));
|
||||
*/
|
||||
#ifdef CONFIG_DEBUG_TRACE_CALLABLES
|
||||
@@ -109,7 +109,7 @@ private:
|
||||
// e.g., "void smo::SomeClass::method(int, int)"
|
||||
// __builtin_return_address(0) = direct caller
|
||||
// __builtin_return_address(1) = caller before that
|
||||
#define STC(arg) sscl::CallableTracer( \
|
||||
#define STC(arg) sscl::cps::CallableTracer( \
|
||||
__PRETTY_FUNCTION__, \
|
||||
__LINE__, \
|
||||
__builtin_return_address(0), \
|
||||
@@ -120,7 +120,7 @@ private:
|
||||
// e.g., "void __cdecl smo::SomeClass::method(int, int)"
|
||||
// _ReturnAddress() = direct caller (only one level available)
|
||||
#include <intrin.h>
|
||||
#define STC(arg) sscl::CallableTracer( \
|
||||
#define STC(arg) sscl::cps::CallableTracer( \
|
||||
__FUNCSIG__, \
|
||||
__LINE__, \
|
||||
_ReturnAddress(), \
|
||||
@@ -129,7 +129,7 @@ private:
|
||||
#else
|
||||
// Fallback to standard __func__ (unqualified name only)
|
||||
// No return address support
|
||||
#define STC(arg) sscl::CallableTracer( \
|
||||
#define STC(arg) sscl::cps::CallableTracer( \
|
||||
__func__, \
|
||||
__LINE__, \
|
||||
nullptr, \
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
#include <memory>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
// Forward declaration
|
||||
class AsynchronousContinuationChainLink;
|
||||
@@ -26,6 +26,6 @@ public:
|
||||
CbFnT callbackFn;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // SPINSCALE_CALLBACK_H
|
||||
@@ -6,7 +6,7 @@
|
||||
#include <vector>
|
||||
#include <memory>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
// Forward declarations
|
||||
class AsynchronousContinuationChainLink;
|
||||
@@ -80,6 +80,6 @@ private:
|
||||
AdjacencyList adjacencyList;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // DEPENDENCY_GRAPH_H
|
||||
@@ -6,15 +6,30 @@
|
||||
#include <utility>
|
||||
#include <memory>
|
||||
#include <optional>
|
||||
#include <spinscale/qutex.h>
|
||||
#include <spinscale/lockerAndInvokerBase.h>
|
||||
#include <spinscale/cps/qutex.h>
|
||||
#include <spinscale/cps/lockerAndInvokerBase.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
class Qutex;
|
||||
|
||||
/**
|
||||
* @brief LockSet - Manages a collection of locks for acquisition/release
|
||||
*
|
||||
* LockSet exists only because the CPS re-enqueuing model had no way to acquire
|
||||
* locks in a fine-grained way. A LockerAndInvoker could re-post only the entire
|
||||
* continuation, and only before that continuation began executing; there was no
|
||||
* mechanism to re-enqueue individual segments within a continuation. The
|
||||
* practical consequence was that all required Qutexes had to be acquired at
|
||||
* once up front, before the continuation body could run at all.
|
||||
*
|
||||
* releaseQutexEarly() was a partial workaround for finer-grained control, but
|
||||
* it only helped on the release side and did not solve the fundamental problem
|
||||
* of acquiring locks one-at-a-time mid-sequence.
|
||||
*
|
||||
* co::CoQutex supersedes this abstraction: coroutines can co_await individual
|
||||
* locks at the points where they are actually needed, which is the finer control
|
||||
* LockSet and releaseQutexEarly() were aiming for with limited success.
|
||||
*/
|
||||
class LockSet
|
||||
{
|
||||
@@ -68,7 +83,7 @@ public:
|
||||
* time it will leave the qutexQ is when the program terminates.
|
||||
*
|
||||
* I'm not sure we'll actually cancal all in-flight async sequences --
|
||||
* and especially not all those that aren't even in any io_service queues.
|
||||
* and especially not all those that aren't even in any io_context queues.
|
||||
* To whatever extent these objects get cleaned up, they'll probably be
|
||||
* cleaned up in the qutexQ's std::list destructor -- and that won't
|
||||
* execute any fancy cleanup logic. It'll just clear() out the list.
|
||||
@@ -280,6 +295,6 @@ private:
|
||||
bool allLocksAcquired, registeredInQutexQueues;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // LOCK_SET_H
|
||||
+5
-5
@@ -4,7 +4,7 @@
|
||||
#include <list>
|
||||
#include <memory>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
// Forward declaration
|
||||
class Qutex;
|
||||
@@ -39,7 +39,7 @@ public:
|
||||
virtual List::iterator getLockvokerIteratorForQutex(Qutex& qutex) const = 0;
|
||||
|
||||
/**
|
||||
* @brief Awaken this lockvoker by posting it to its io_service
|
||||
* @brief Awaken this lockvoker by posting it to its io_context
|
||||
* @param forceAwaken If true, post even if already awake
|
||||
*/
|
||||
virtual void awaken(bool forceAwaken = false) = 0;
|
||||
@@ -55,12 +55,12 @@ public:
|
||||
*
|
||||
* Compare by the address of the continuation objects. Why?
|
||||
* Because there's no guarantee that the lockvoker object that was
|
||||
* passed in by the io_service invocation is the same object as that
|
||||
* passed in by the io_context invocation is the same object as that
|
||||
* which is in the qutexQs. Especially because we make_shared() a
|
||||
* copy when registerInQutexQueues()ing.
|
||||
*
|
||||
* Generally when we "wake" a lockvoker by enqueuing it, boost's
|
||||
* io_service::post will copy the lockvoker object.
|
||||
* io_context::post will copy the lockvoker object.
|
||||
*/
|
||||
bool operator==(const LockerAndInvokerBase &other) const
|
||||
{
|
||||
@@ -82,6 +82,6 @@ protected:
|
||||
const void* serializedContinuationVaddr;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // LOCKER_AND_INVOKER_BASE_H
|
||||
@@ -6,9 +6,9 @@
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <spinscale/spinLock.h>
|
||||
#include <spinscale/lockerAndInvokerBase.h>
|
||||
#include <spinscale/cps/lockerAndInvokerBase.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
/**
|
||||
* @brief Qutex - Queue-based mutex for asynchronous lock management
|
||||
@@ -97,11 +97,11 @@ public:
|
||||
std::string name;
|
||||
std::shared_ptr<LockerAndInvokerBase> currOwner;
|
||||
#endif
|
||||
SpinLock lock;
|
||||
sscl::SpinLock lock;
|
||||
LockerAndInvokerBase::List queue;
|
||||
bool isOwned;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // QUTEX_H
|
||||
+4
-4
@@ -5,10 +5,10 @@
|
||||
#include <memory>
|
||||
#include <forward_list>
|
||||
#include <functional>
|
||||
#include "spinLock.h"
|
||||
#include <spinscale/spinLock.h>
|
||||
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
// Forward declarations
|
||||
class Qutex;
|
||||
@@ -155,10 +155,10 @@ private:
|
||||
* Therefore, it's best to use a SpinLock on the history class to avoid
|
||||
* these coupling issues.
|
||||
*/
|
||||
SpinLock acquisitionHistoryLock;
|
||||
sscl::SpinLock acquisitionHistoryLock;
|
||||
AcquisitionHistoryMap acquisitionHistory;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // QUTEX_ACQUISITION_HISTORY_TRACKER_H
|
||||
+35
-25
@@ -8,13 +8,13 @@
|
||||
#include <iostream>
|
||||
#include <optional>
|
||||
#include <spinscale/componentThread.h>
|
||||
#include <spinscale/lockSet.h>
|
||||
#include <spinscale/asynchronousContinuation.h>
|
||||
#include <spinscale/lockerAndInvokerBase.h>
|
||||
#include <spinscale/callback.h>
|
||||
#include <spinscale/qutexAcquisitionHistoryTracker.h>
|
||||
#include <spinscale/cps/lockSet.h>
|
||||
#include <spinscale/cps/asynchronousContinuation.h>
|
||||
#include <spinscale/cps/lockerAndInvokerBase.h>
|
||||
#include <spinscale/cps/callback.h>
|
||||
#include <spinscale/cps/qutexAcquisitionHistoryTracker.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
template <class OriginalCbFnT>
|
||||
class SerializedAsynchronousContinuation
|
||||
@@ -22,7 +22,7 @@ class SerializedAsynchronousContinuation
|
||||
{
|
||||
public:
|
||||
SerializedAsynchronousContinuation(
|
||||
const std::shared_ptr<ComponentThread> &caller,
|
||||
const std::shared_ptr<sscl::ComponentThread> &caller,
|
||||
Callback<OriginalCbFnT> originalCbFn,
|
||||
std::vector<std::reference_wrapper<Qutex>> requiredLocks)
|
||||
: PostedAsynchronousContinuation<OriginalCbFnT>(caller, originalCbFn),
|
||||
@@ -65,7 +65,7 @@ public:
|
||||
* @brief LockerAndInvoker - Template class for lockvoking mechanism
|
||||
*
|
||||
* This class wraps a std::bind result and provides locking functionality.
|
||||
* When locks cannot be acquired, the object re-posts itself to the io_service
|
||||
* When locks cannot be acquired, the object re-posts itself to the io_context
|
||||
* queue, implementing the "spinqueueing" pattern.
|
||||
*/
|
||||
template <class InvocationTargetT>
|
||||
@@ -74,16 +74,16 @@ public:
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @brief Constructor that immediately posts to io_service
|
||||
* @brief Constructor that immediately posts to io_context
|
||||
* @param serializedContinuation Reference to the serialized continuation
|
||||
* containing LockSet and target io_service
|
||||
* @param target The ComponentThread whose io_service to post to
|
||||
* containing LockSet and target io_context
|
||||
* @param target The ComponentThread whose io_context to post to
|
||||
* @param invocationTarget The std::bind result to invoke when locks are acquired
|
||||
*/
|
||||
LockerAndInvoker(
|
||||
SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
&serializedContinuation,
|
||||
const std::shared_ptr<ComponentThread>& target,
|
||||
const std::shared_ptr<sscl::ComponentThread>& target,
|
||||
InvocationTargetT invocationTarget)
|
||||
: LockerAndInvokerBase(&serializedContinuation),
|
||||
#ifdef CONFIG_ENABLE_DEBUG_LOCKS
|
||||
@@ -127,7 +127,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Awaken this lockvoker by posting it to its io_service
|
||||
* @brief Awaken this lockvoker by posting it to its io_context
|
||||
* @param forceAwaken If true, post even if already awake
|
||||
*/
|
||||
void awaken(bool forceAwaken = false) override
|
||||
@@ -138,7 +138,7 @@ public:
|
||||
if (prevVal == true && !forceAwaken)
|
||||
{ return; }
|
||||
|
||||
target->getIoService().post(*this);
|
||||
boost::asio::post(target->getIoContext(), *this);
|
||||
}
|
||||
|
||||
size_t getLockSetSize() const override
|
||||
@@ -161,14 +161,14 @@ public:
|
||||
* the AsyncContinuation sh_ptr (which the Lockvoker contains within
|
||||
* itself) alive without wasting too much memory.
|
||||
*
|
||||
* This way the io_service objects can remove the lockvoker from
|
||||
* This way the io_context objects can remove the lockvoker from
|
||||
* their queues and there'll be a copy of the lockvoker in each
|
||||
* Qutex's queue.
|
||||
*
|
||||
* For non-serialized, posted continuations, they won't be removed
|
||||
* from the io_service queue until they're executed, so there's no
|
||||
* from the io_context queue until they're executed, so there's no
|
||||
* need to create copies of them. Lockvokers are removed from their
|
||||
* io_service, potentially without being executed if they fail to
|
||||
* io_context, potentially without being executed if they fail to
|
||||
* acquire all locks.
|
||||
*/
|
||||
void registerInLockSet()
|
||||
@@ -185,7 +185,7 @@ public:
|
||||
*
|
||||
* Sets isAwake=true before calling awaken with forceAwaken to ensure
|
||||
* that none of the locks we just registered with awaken()s a duplicate
|
||||
* copy of this lockvoker on the io_service.
|
||||
* copy of this lockvoker on the io_context.
|
||||
*/
|
||||
void firstWake()
|
||||
{
|
||||
@@ -213,8 +213,17 @@ public:
|
||||
{ return isDeadlockLikely(); }
|
||||
|
||||
#ifdef CONFIG_ENABLE_DEBUG_LOCKS
|
||||
struct obsolete {
|
||||
bool traceContinuationHistoryForGridlockOn(Qutex &firstFailedQutex);
|
||||
friend struct obsolete;
|
||||
|
||||
struct obsolete
|
||||
{
|
||||
explicit obsolete(LockerAndInvoker &_parent) : parent(_parent)
|
||||
{}
|
||||
|
||||
bool traceContinuationHistoryForGridlockOn(
|
||||
Qutex &firstFailedQutex);
|
||||
|
||||
LockerAndInvoker &parent;
|
||||
};
|
||||
|
||||
bool traceContinuationHistoryForDeadlockOn(Qutex &firstFailedQutex);
|
||||
@@ -266,7 +275,7 @@ public:
|
||||
#endif
|
||||
SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
&serializedContinuation;
|
||||
std::shared_ptr<ComponentThread> target;
|
||||
std::shared_ptr<sscl::ComponentThread> target;
|
||||
InvocationTargetT invocationTarget;
|
||||
};
|
||||
};
|
||||
@@ -435,7 +444,8 @@ SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
* should eventually be able to acquire that lock.
|
||||
*/
|
||||
for (std::shared_ptr<AsynchronousContinuationChainLink> currContin =
|
||||
this->serializedContinuation.getCallersContinuationShPtr();
|
||||
parent.serializedContinuation
|
||||
.getCallersContinuationShPtr();
|
||||
currContin != nullptr;
|
||||
currContin = currContin->getCallersContinuationShPtr())
|
||||
{
|
||||
@@ -470,7 +480,7 @@ template <class InvocationTargetT>
|
||||
void SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
::LockerAndInvoker<InvocationTargetT>::operator()()
|
||||
{
|
||||
if (ComponentThread::getSelf() != target)
|
||||
if (sscl::ComponentThread::getSelf() != target)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
"LockerAndInvoker::operator(): Thread safety violation - "
|
||||
@@ -484,7 +494,7 @@ void SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
if (!serializedContinuation.requiredLocks.tryAcquireOrBackOff(
|
||||
*this, firstFailedQutexRet))
|
||||
{
|
||||
// Just allow this lockvoker to be dropped from its io_service.
|
||||
// Just allow this lockvoker to be dropped from its io_context.
|
||||
allowAwakening();
|
||||
if (!deadlockLikely && !gridlockLikely)
|
||||
{ return; }
|
||||
@@ -588,6 +598,6 @@ void SerializedAsynchronousContinuation<OriginalCbFnT>
|
||||
invocationTarget();
|
||||
}
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
#endif // SERIALIZED_ASYNCHRONOUS_CONTINUATION_H
|
||||
@@ -0,0 +1,44 @@
|
||||
#ifndef SPINSCALE_ENV_KV_STORE_H
|
||||
#define SPINSCALE_ENV_KV_STORE_H
|
||||
|
||||
#include <filesystem>
|
||||
#include <optional>
|
||||
#include <ostream>
|
||||
#include <string>
|
||||
#include <string_view>
|
||||
#include <unordered_map>
|
||||
#include <vector>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
class EnvKvStore
|
||||
{
|
||||
public:
|
||||
explicit EnvKvStore(
|
||||
const std::vector<std::filesystem::path> &envFilePaths,
|
||||
std::ostream &warningStream);
|
||||
explicit EnvKvStore(
|
||||
const std::vector<std::filesystem::path> &envFilePaths);
|
||||
|
||||
std::optional<std::string> get(std::string_view name) const;
|
||||
|
||||
private:
|
||||
void loadFiles(
|
||||
const std::vector<std::filesystem::path> &envFilePaths,
|
||||
std::ostream &warningStream);
|
||||
void loadFile(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::ostream &warningStream);
|
||||
void storeValue(
|
||||
const std::filesystem::path &envFilePath,
|
||||
const std::string &name,
|
||||
const std::string &value,
|
||||
std::ostream &warningStream);
|
||||
|
||||
private:
|
||||
std::unordered_map<std::string, std::string> values;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
|
||||
#endif // SPINSCALE_ENV_KV_STORE_H
|
||||
@@ -0,0 +1,50 @@
|
||||
#ifndef MULTI_OPERATION_RESULT_SET_H
|
||||
#define MULTI_OPERATION_RESULT_SET_H
|
||||
|
||||
#include <exception>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
/** Plain aggregate for fan-out / fan-in results returned from coroutines. */
|
||||
struct MultiOperationResultSet
|
||||
{
|
||||
MultiOperationResultSet(
|
||||
unsigned int total = 0,
|
||||
unsigned int succeeded = 0,
|
||||
unsigned int failed = 0)
|
||||
: nTotal(total), nSucceeded(succeeded), nFailed(failed)
|
||||
{}
|
||||
|
||||
bool isComplete() const
|
||||
{ return nSucceeded + nFailed == nTotal; }
|
||||
|
||||
bool nTotalIsZero() const
|
||||
{ return nTotal == 0; }
|
||||
|
||||
unsigned int nTotal;
|
||||
unsigned int nSucceeded;
|
||||
unsigned int nFailed;
|
||||
};
|
||||
|
||||
/** Fan-out / fan-in counts plus optional aggregated member failure. */
|
||||
struct MultiOperationResultSetWithException
|
||||
{
|
||||
MultiOperationResultSetWithException() = default;
|
||||
|
||||
MultiOperationResultSetWithException(
|
||||
MultiOperationResultSet resultsIn,
|
||||
std::exception_ptr memberFailureExceptionIn = nullptr)
|
||||
: results(resultsIn),
|
||||
memberFailureException(memberFailureExceptionIn)
|
||||
{}
|
||||
|
||||
bool hasMemberFailure() const
|
||||
{ return memberFailureException != nullptr; }
|
||||
|
||||
MultiOperationResultSet results;
|
||||
std::exception_ptr memberFailureException = nullptr;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
|
||||
#endif // MULTI_OPERATION_RESULT_SET_H
|
||||
@@ -2,10 +2,12 @@
|
||||
#define PUPPET_APPLICATION_H
|
||||
|
||||
#include <config.h>
|
||||
#include <functional>
|
||||
#include <memory>
|
||||
#include <string_view>
|
||||
#include <vector>
|
||||
#include <spinscale/callback.h>
|
||||
|
||||
#include <spinscale/co/group.h>
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
namespace sscl {
|
||||
@@ -18,24 +20,25 @@ public:
|
||||
const std::vector<std::shared_ptr<PuppetThread>> &threads);
|
||||
~PuppetApplication() = default;
|
||||
|
||||
// Thread management methods
|
||||
typedef std::function<void()> puppetThreadLifetimeMgmtOpCbFn;
|
||||
void joltAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback);
|
||||
void startAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback);
|
||||
void pauseAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback);
|
||||
void resumeAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback);
|
||||
void exitAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback);
|
||||
co::ViralNonPostingInvoker<void> joltAllPuppetThreadsCReq();
|
||||
co::ViralNonPostingInvoker<void> startAllPuppetThreadsCReq();
|
||||
co::ViralNonPostingInvoker<void> pauseAllPuppetThreadsCReq();
|
||||
co::ViralNonPostingInvoker<void> resumeAllPuppetThreadsCReq();
|
||||
co::ViralNonPostingInvoker<void> exitAllPuppetThreadsCReq();
|
||||
|
||||
// CPU distribution method
|
||||
void distributeAndPinThreadsAcrossCpus();
|
||||
|
||||
protected:
|
||||
// Collection of PuppetThread instances
|
||||
using PuppetLifetimeMgmtInvoker =
|
||||
PuppetThread::ViralThreadLifetimeMgmtInvoker;
|
||||
using PuppetLifetimeMgmtGroup = co::Group;
|
||||
|
||||
void addAllPuppetLifetimeInvokersToGroup(
|
||||
PuppetLifetimeMgmtGroup &group,
|
||||
std::vector<PuppetLifetimeMgmtInvoker> &invokers,
|
||||
PuppetThread::ThreadOp threadOp) const;
|
||||
|
||||
std::vector<std::shared_ptr<PuppetThread>> componentThreads;
|
||||
|
||||
/**
|
||||
@@ -60,7 +63,9 @@ protected:
|
||||
bool threadsHaveBeenJolted = false;
|
||||
|
||||
private:
|
||||
class PuppetThreadLifetimeMgmtOp;
|
||||
co::ViralNonPostingInvoker<void> allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp threadOp,
|
||||
std::string_view emptyThreadsLogMessage);
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
#ifndef SHARED_RESOURCE_GROUP_H
|
||||
#define SHARED_RESOURCE_GROUP_H
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
template <typename LockType, typename ResourceType>
|
||||
@@ -8,6 +10,16 @@ class SharedResourceGroup
|
||||
{
|
||||
public:
|
||||
SharedResourceGroup() = default;
|
||||
|
||||
explicit SharedResourceGroup(const std::string& lockName)
|
||||
: lock(lockName)
|
||||
{}
|
||||
|
||||
SharedResourceGroup(
|
||||
const std::string& lockName, const ResourceType& initialRsrc)
|
||||
: lock(lockName), rsrc(initialRsrc)
|
||||
{}
|
||||
|
||||
~SharedResourceGroup() = default;
|
||||
|
||||
LockType lock;
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
#ifndef SYNC_CANCELER_FOR_ASYNC_WORK_H
|
||||
#define SYNC_CANCELER_FOR_ASYNC_WORK_H
|
||||
|
||||
#include <concepts>
|
||||
#include <utility>
|
||||
|
||||
#include <spinscale/sharedResourceGroup.h>
|
||||
#include <spinscale/spinLock.h>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
/**
|
||||
* SyncCancelerForAsyncWork
|
||||
*
|
||||
* A small helper to coordinate synchronous cancellation requests with
|
||||
* asynchronous work that must only observe cancellation at explicit
|
||||
* uncancelable segment boundaries.
|
||||
*
|
||||
* The async callee should structure its logic as:
|
||||
* - enter an uncancelable segment (execUncancelableSegmentOrAbort)
|
||||
* - perform synchronous work that must not be interrupted
|
||||
* - exit the segment
|
||||
* - perform cancelable async work (outside the lock)
|
||||
* - repeat
|
||||
*
|
||||
* requestStop() blocks until any currently-executing segment releases s.lock,
|
||||
* then flips shouldContinue to false. This guarantees shouldContinue is stable
|
||||
* throughout each uncancelable segment.
|
||||
*
|
||||
* startAcceptingWork() is intentionally unlocked. Precondition: callers must
|
||||
* only call startAcceptingWork() when no async callee is running yet (e.g. at
|
||||
* the end of setup(), before posting/arming the first async work). If this
|
||||
* method races a running callee, that is a caller bug.
|
||||
*/
|
||||
class SyncCancelerForAsyncWork
|
||||
{
|
||||
public:
|
||||
struct Resources
|
||||
{
|
||||
bool shouldContinue = false;
|
||||
};
|
||||
|
||||
SyncCancelerForAsyncWork() = default;
|
||||
|
||||
void startAcceptingWork()
|
||||
{
|
||||
// Intentionally unlocked — see class-level EXPLANATION above.
|
||||
s.rsrc.shouldContinue = true;
|
||||
}
|
||||
|
||||
/** @return shouldContinue before this call (was work being accepted?) */
|
||||
bool requestStop()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
const bool wasContinuing = s.rsrc.shouldContinue;
|
||||
s.rsrc.shouldContinue = false;
|
||||
return wasContinuing;
|
||||
}
|
||||
|
||||
/** @return true if requestStop() has set shouldContinue to false. */
|
||||
bool isCancellationRequested()
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
return isCancellationRequestedUnlocked();
|
||||
}
|
||||
|
||||
bool isCancellationRequestedUnlocked() const
|
||||
{ return !s.rsrc.shouldContinue; }
|
||||
|
||||
template<typename Body>
|
||||
requires std::invocable<Body>
|
||||
bool execUncancelableSegmentOrAbort(Body&& body)
|
||||
{
|
||||
sscl::SpinLock::Guard guard(s.lock);
|
||||
if (!s.rsrc.shouldContinue) {
|
||||
return false;
|
||||
}
|
||||
std::forward<Body>(body)();
|
||||
return true;
|
||||
}
|
||||
|
||||
public:
|
||||
sscl::SharedResourceGroup<sscl::SpinLock, Resources> s;
|
||||
};
|
||||
|
||||
} // namespace sscl
|
||||
|
||||
#endif // SYNC_CANCELER_FOR_ASYNC_WORK_H
|
||||
@@ -0,0 +1,18 @@
|
||||
#include <boost/asio/detail/call_stack.hpp>
|
||||
#include <boost/asio/detail/thread_context.hpp>
|
||||
#include <boost/asio/detail/tss_ptr.hpp>
|
||||
|
||||
namespace boost {
|
||||
namespace asio {
|
||||
namespace detail {
|
||||
|
||||
/** Single translation-unit definition for Boost.Asio call_stack TLS.
|
||||
* Other TUs include boostAsioLinkageFix.h first and use extern template.
|
||||
*/
|
||||
template
|
||||
tss_ptr<call_stack<thread_context, thread_info_base>::context>
|
||||
call_stack<thread_context, thread_info_base>::top_;
|
||||
|
||||
} // namespace detail
|
||||
} // namespace asio
|
||||
} // namespace boost
|
||||
@@ -1,7 +1,7 @@
|
||||
#include <spinscale/callableTracer.h>
|
||||
#include <spinscale/cps/callableTracer.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
bool CallableTracer::optTraceCallables = false;
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
+7
-7
@@ -27,10 +27,10 @@ void PuppetComponent::defaultPuppetMain(
|
||||
if (args.preJoltHook) { args.preJoltHook(thr); }
|
||||
|
||||
/** FIXME:
|
||||
* Figure out why we don't call reset() here, and then explicitly document
|
||||
* Figure out why we don't call restart() here, and then explicitly document
|
||||
* it.
|
||||
*/
|
||||
thr.getIoService().run();
|
||||
thr.getIoContext().run();
|
||||
thr.initializeTls();
|
||||
|
||||
comp.postJoltHook();
|
||||
@@ -52,15 +52,15 @@ void PuppetComponent::defaultPuppetMain(
|
||||
/** EXPLANATION:
|
||||
* This reset() call is crucial for async bridging patterns
|
||||
* to work.
|
||||
* When the outermost thread's io_service is stop()ped (e.g.,
|
||||
* When the outermost thread's io_context is stop()ped (e.g.,
|
||||
* from JOLT sequence), it won't process any new work until
|
||||
* reset() is called, even if nested async operations try to
|
||||
* restart() is called, even if nested async operations try to
|
||||
* post work to it. This means async bridges invoked from
|
||||
* the outermost thread main sequence won't work until this
|
||||
* reset() call.
|
||||
* restart() call.
|
||||
*/
|
||||
thr.getIoService().reset();
|
||||
thr.getIoService().run();
|
||||
thr.getIoContext().restart();
|
||||
thr.getIoContext().run();
|
||||
}
|
||||
catch (const std::exception& e)
|
||||
{
|
||||
|
||||
+28
-28
@@ -1,13 +1,13 @@
|
||||
#include <boostAsioLinkageFix.h>
|
||||
#include <unistd.h>
|
||||
#include <iostream>
|
||||
#include <string>
|
||||
#include <pthread.h>
|
||||
#include <sched.h>
|
||||
#include <boost/asio/io_service.hpp>
|
||||
#include <spinscale/asynchronousContinuation.h>
|
||||
#include <spinscale/callback.h>
|
||||
#include <spinscale/callableTracer.h>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <spinscale/cps/asynchronousContinuation.h>
|
||||
#include <spinscale/cps/callback.h>
|
||||
#include <spinscale/cps/callableTracer.h>
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/component.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
@@ -48,7 +48,7 @@ std::shared_ptr<PuppeteerThread> ComponentThread::getPptr()
|
||||
void PuppeteerThread::exitLoop(void)
|
||||
{
|
||||
keepLooping = false;
|
||||
getIoService().stop();
|
||||
getIoContext().stop();
|
||||
std::cout << name << ": Signaled main loop to exit." << "\n";
|
||||
}
|
||||
|
||||
@@ -79,14 +79,14 @@ const std::shared_ptr<ComponentThread> ComponentThread::getSelf(void)
|
||||
}
|
||||
|
||||
class PuppetThread::ThreadLifetimeMgmtOp
|
||||
: public PostedAsynchronousContinuation<threadLifetimeMgmtOpCbFn>
|
||||
: public cps::PostedAsynchronousContinuation<threadLifetimeMgmtOpCbFn>
|
||||
{
|
||||
public:
|
||||
ThreadLifetimeMgmtOp(
|
||||
const std::shared_ptr<ComponentThread> &caller,
|
||||
const std::shared_ptr<PuppetThread> &target,
|
||||
Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
: PostedAsynchronousContinuation<threadLifetimeMgmtOpCbFn>(
|
||||
cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
: cps::PostedAsynchronousContinuation<threadLifetimeMgmtOpCbFn>(
|
||||
caller, callback),
|
||||
target(target)
|
||||
{}
|
||||
@@ -103,7 +103,7 @@ public:
|
||||
"JOLT request."
|
||||
<< "\n";
|
||||
|
||||
target->io_service.stop();
|
||||
target->io_context.stop();
|
||||
callOriginalCb();
|
||||
}
|
||||
|
||||
@@ -129,7 +129,7 @@ public:
|
||||
"exitThread (main queue)." << "\n";
|
||||
|
||||
target->cleanup();
|
||||
target->io_service.stop();
|
||||
target->io_context.stop();
|
||||
callOriginalCb();
|
||||
}
|
||||
|
||||
@@ -141,8 +141,8 @@ public:
|
||||
"exitThread (pause queue)."<< "\n";
|
||||
|
||||
target->cleanup();
|
||||
target->pause_io_service.stop();
|
||||
target->io_service.stop();
|
||||
target->pause_io_context.stop();
|
||||
target->io_context.stop();
|
||||
callOriginalCb();
|
||||
}
|
||||
|
||||
@@ -158,8 +158,8 @@ public:
|
||||
* have a chance to invoke the callback until it's unblocked.
|
||||
*/
|
||||
callOriginalCb();
|
||||
target->pause_io_service.reset();
|
||||
target->pause_io_service.run();
|
||||
target->pause_io_context.restart();
|
||||
target->pause_io_context.run();
|
||||
}
|
||||
|
||||
void resumeThreadReq1_posted(
|
||||
@@ -169,7 +169,7 @@ public:
|
||||
std::cout << __func__ << ": Thread '" << target->name << "': handling "
|
||||
"resumeThread." << "\n";
|
||||
|
||||
target->pause_io_service.stop();
|
||||
target->pause_io_context.stop();
|
||||
callOriginalCb();
|
||||
}
|
||||
};
|
||||
@@ -181,7 +181,7 @@ void ComponentThread::cleanup(void)
|
||||
|
||||
void PuppetThread::joltThreadReq(
|
||||
const std::shared_ptr<PuppetThread>& selfPtr,
|
||||
Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
{
|
||||
/** EXPLANATION:
|
||||
* We can't use shared_from_this() here because JOLTing occurs prior to
|
||||
@@ -209,45 +209,45 @@ void PuppetThread::joltThreadReq(
|
||||
auto request = std::make_shared<ThreadLifetimeMgmtOp>(
|
||||
puppeteer, selfPtr, callback);
|
||||
|
||||
this->getIoService().post(
|
||||
boost::asio::post(this->getIoContext(),
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::joltThreadReq1_posted,
|
||||
request.get(), request)));
|
||||
}
|
||||
|
||||
// Thread management method implementations
|
||||
void PuppetThread::startThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
void PuppetThread::startThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
{
|
||||
std::shared_ptr<ComponentThread> caller = getSelf();
|
||||
auto request = std::make_shared<ThreadLifetimeMgmtOp>(
|
||||
caller, std::static_pointer_cast<PuppetThread>(shared_from_this()),
|
||||
callback);
|
||||
|
||||
this->getIoService().post(
|
||||
boost::asio::post(this->getIoContext(),
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::startThreadReq1_posted,
|
||||
request.get(), request)));
|
||||
}
|
||||
|
||||
void PuppetThread::exitThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
void PuppetThread::exitThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
{
|
||||
std::shared_ptr<ComponentThread> caller = getSelf();
|
||||
auto request = std::make_shared<ThreadLifetimeMgmtOp>(
|
||||
caller, std::static_pointer_cast<PuppetThread>(shared_from_this()),
|
||||
callback);
|
||||
|
||||
this->getIoService().post(
|
||||
boost::asio::post(this->getIoContext(),
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::exitThreadReq1_mainQueue_posted,
|
||||
request.get(), request)));
|
||||
|
||||
pause_io_service.post(
|
||||
boost::asio::post(pause_io_context,
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::exitThreadReq1_pauseQueue_posted,
|
||||
request.get(), request)));
|
||||
}
|
||||
|
||||
void PuppetThread::pauseThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
void PuppetThread::pauseThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
{
|
||||
if (id == sscl::pptr::puppeteerThreadId)
|
||||
{
|
||||
@@ -260,13 +260,13 @@ void PuppetThread::pauseThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
caller, std::static_pointer_cast<PuppetThread>(shared_from_this()),
|
||||
callback);
|
||||
|
||||
this->getIoService().post(
|
||||
boost::asio::post(this->getIoContext(),
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::pauseThreadReq1_posted,
|
||||
request.get(), request)));
|
||||
}
|
||||
|
||||
void PuppetThread::resumeThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
void PuppetThread::resumeThreadReq(cps::Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
{
|
||||
if (id == sscl::pptr::puppeteerThreadId)
|
||||
{
|
||||
@@ -274,13 +274,13 @@ void PuppetThread::resumeThreadReq(Callback<threadLifetimeMgmtOpCbFn> callback)
|
||||
+ ": invoked on puppeteer thread");
|
||||
}
|
||||
|
||||
// Post to the pause_io_service to unblock the paused thread
|
||||
// Post to the pause_io_context to unblock the paused thread
|
||||
std::shared_ptr<ComponentThread> caller = getSelf();
|
||||
auto request = std::make_shared<ThreadLifetimeMgmtOp>(
|
||||
caller, std::static_pointer_cast<PuppetThread>(shared_from_this()),
|
||||
callback);
|
||||
|
||||
pause_io_service.post(
|
||||
boost::asio::post(pause_io_context,
|
||||
STC(std::bind(
|
||||
&ThreadLifetimeMgmtOp::resumeThreadReq1_posted,
|
||||
request.get(), request)));
|
||||
|
||||
@@ -0,0 +1,278 @@
|
||||
#include <algorithm>
|
||||
#include <cctype>
|
||||
#include <cstdlib>
|
||||
#include <fstream>
|
||||
#include <iostream>
|
||||
#include <ranges>
|
||||
#include <sstream>
|
||||
#include <stdexcept>
|
||||
|
||||
#include <spinscale/envKvStore.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace {
|
||||
|
||||
std::string trim(std::string_view value)
|
||||
{
|
||||
auto begin = std::ranges::find_if_not(
|
||||
value, [](unsigned char c) { return std::isspace(c); });
|
||||
auto rbegin = std::ranges::find_if_not(
|
||||
value | std::views::reverse,
|
||||
[](unsigned char c) { return std::isspace(c); });
|
||||
auto end = rbegin.base();
|
||||
if (begin >= end)
|
||||
{
|
||||
return {};
|
||||
}
|
||||
return std::string(begin, end);
|
||||
}
|
||||
|
||||
bool characterIsValidNameStart(char c)
|
||||
{
|
||||
return std::isalpha(static_cast<unsigned char>(c)) || c == '_';
|
||||
}
|
||||
|
||||
bool characterIsValidNameBody(char c)
|
||||
{
|
||||
return std::isalnum(static_cast<unsigned char>(c)) || c == '_';
|
||||
}
|
||||
|
||||
bool nameIsValid(std::string_view name)
|
||||
{
|
||||
if (name.empty() || !characterIsValidNameStart(name.front()))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
return std::ranges::all_of(name.substr(1), characterIsValidNameBody);
|
||||
}
|
||||
|
||||
std::runtime_error makeParseError(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::size_t lineNumber,
|
||||
const std::string &message)
|
||||
{
|
||||
std::ostringstream stream;
|
||||
stream << envFilePath << ":" << lineNumber << ": " << message;
|
||||
return std::runtime_error(stream.str());
|
||||
}
|
||||
|
||||
bool lineIsBlankOrComment(const std::string &line)
|
||||
{
|
||||
std::string trimmed = trim(line);
|
||||
return trimmed.empty() || trimmed.front() == '#';
|
||||
}
|
||||
|
||||
std::size_t findClosingQuote(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::size_t lineNumber,
|
||||
std::string_view value)
|
||||
{
|
||||
char quote = value.front();
|
||||
bool escapeNext = false;
|
||||
for (std::size_t i = 1; i < value.size(); ++i)
|
||||
{
|
||||
if (escapeNext)
|
||||
{
|
||||
escapeNext = false;
|
||||
continue;
|
||||
}
|
||||
if (quote == '"' && value[i] == '\\')
|
||||
{
|
||||
escapeNext = true;
|
||||
continue;
|
||||
}
|
||||
if (value[i] == quote)
|
||||
{
|
||||
return i;
|
||||
}
|
||||
}
|
||||
throw makeParseError(envFilePath, lineNumber, "Unterminated quoted value.");
|
||||
}
|
||||
|
||||
std::string decodeDoubleQuotedValue(std::string_view value)
|
||||
{
|
||||
std::string decoded;
|
||||
decoded.reserve(value.size());
|
||||
bool escapeNext = false;
|
||||
for (char c : value)
|
||||
{
|
||||
if (!escapeNext && c == '\\')
|
||||
{
|
||||
escapeNext = true;
|
||||
continue;
|
||||
}
|
||||
if (escapeNext)
|
||||
{
|
||||
switch (c)
|
||||
{
|
||||
case 'n':
|
||||
decoded.push_back('\n');
|
||||
break;
|
||||
case 'r':
|
||||
decoded.push_back('\r');
|
||||
break;
|
||||
case 't':
|
||||
decoded.push_back('\t');
|
||||
break;
|
||||
default:
|
||||
decoded.push_back(c);
|
||||
break;
|
||||
}
|
||||
escapeNext = false;
|
||||
continue;
|
||||
}
|
||||
decoded.push_back(c);
|
||||
}
|
||||
if (escapeNext)
|
||||
{
|
||||
decoded.push_back('\\');
|
||||
}
|
||||
return decoded;
|
||||
}
|
||||
|
||||
std::string parseQuotedValue(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::size_t lineNumber,
|
||||
std::string_view value)
|
||||
{
|
||||
char quote = value.front();
|
||||
std::size_t closingQuote = findClosingQuote(envFilePath, lineNumber, value);
|
||||
std::string trailing = trim(value.substr(closingQuote + 1));
|
||||
if (!trailing.empty() && trailing.front() != '#')
|
||||
{
|
||||
throw makeParseError(
|
||||
envFilePath, lineNumber, "Unexpected text after quoted value.");
|
||||
}
|
||||
std::string_view quotedBody = value.substr(1, closingQuote - 1);
|
||||
if (quote == '"')
|
||||
{
|
||||
return decodeDoubleQuotedValue(quotedBody);
|
||||
}
|
||||
return std::string(quotedBody);
|
||||
}
|
||||
|
||||
std::string parseValue(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::size_t lineNumber,
|
||||
std::string_view rawValue)
|
||||
{
|
||||
std::string value = trim(rawValue);
|
||||
if (value.empty())
|
||||
{
|
||||
return {};
|
||||
}
|
||||
if (value.front() == '\'' || value.front() == '"')
|
||||
{
|
||||
return parseQuotedValue(envFilePath, lineNumber, value);
|
||||
}
|
||||
return trim(value.substr(0, value.find('#')));
|
||||
}
|
||||
|
||||
std::pair<std::string, std::string> parseAssignment(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::size_t lineNumber,
|
||||
const std::string &line)
|
||||
{
|
||||
std::size_t separator = line.find('=');
|
||||
if (separator == std::string::npos)
|
||||
{
|
||||
throw makeParseError(envFilePath, lineNumber, "Expected KEY=value.");
|
||||
}
|
||||
|
||||
std::string name = trim(std::string_view(line).substr(0, separator));
|
||||
if (!nameIsValid(name))
|
||||
{
|
||||
throw makeParseError(envFilePath, lineNumber, "Invalid variable name.");
|
||||
}
|
||||
|
||||
return {
|
||||
std::move(name),
|
||||
parseValue(
|
||||
envFilePath,
|
||||
lineNumber,
|
||||
std::string_view(line).substr(separator + 1))};
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
EnvKvStore::EnvKvStore(
|
||||
const std::vector<std::filesystem::path> &envFilePaths,
|
||||
std::ostream &warningStream)
|
||||
{
|
||||
loadFiles(envFilePaths, warningStream);
|
||||
}
|
||||
|
||||
EnvKvStore::EnvKvStore(
|
||||
const std::vector<std::filesystem::path> &envFilePaths)
|
||||
: EnvKvStore(envFilePaths, std::cerr)
|
||||
{
|
||||
}
|
||||
|
||||
void EnvKvStore::loadFiles(
|
||||
const std::vector<std::filesystem::path> &envFilePaths,
|
||||
std::ostream &warningStream)
|
||||
{
|
||||
for (const std::filesystem::path &envFilePath : envFilePaths)
|
||||
{
|
||||
loadFile(envFilePath, warningStream);
|
||||
}
|
||||
}
|
||||
|
||||
std::optional<std::string> EnvKvStore::get(std::string_view name) const
|
||||
{
|
||||
std::string ownedName(name);
|
||||
if (const char *value = std::getenv(ownedName.c_str()))
|
||||
{
|
||||
return std::string(value);
|
||||
}
|
||||
auto value = values.find(std::string(name));
|
||||
if (value == values.end())
|
||||
{
|
||||
return std::nullopt;
|
||||
}
|
||||
return value->second;
|
||||
}
|
||||
|
||||
void EnvKvStore::loadFile(
|
||||
const std::filesystem::path &envFilePath,
|
||||
std::ostream &warningStream)
|
||||
{
|
||||
std::ifstream file(envFilePath);
|
||||
if (!file)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
"Failed to open env file: " + envFilePath.string());
|
||||
}
|
||||
|
||||
std::string line;
|
||||
std::size_t lineNumber = 0;
|
||||
while (std::getline(file, line))
|
||||
{
|
||||
++lineNumber;
|
||||
if (lineIsBlankOrComment(line))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
auto [name, value] = parseAssignment(envFilePath, lineNumber, line);
|
||||
storeValue(envFilePath, name, value, warningStream);
|
||||
}
|
||||
}
|
||||
|
||||
void EnvKvStore::storeValue(
|
||||
const std::filesystem::path &envFilePath,
|
||||
const std::string &name,
|
||||
const std::string &value,
|
||||
std::ostream &warningStream)
|
||||
{
|
||||
if (auto oldValue = values.find(name); oldValue != values.end())
|
||||
{
|
||||
warningStream << "Warning: env file " << envFilePath
|
||||
<< " overwrites " << name << " from `" << oldValue->second
|
||||
<< "` to `" << value << "`.\n";
|
||||
oldValue->second = value;
|
||||
return;
|
||||
}
|
||||
values.emplace(name, value);
|
||||
}
|
||||
|
||||
} // namespace sscl
|
||||
@@ -1,5 +0,0 @@
|
||||
#include <spinscale/lockerAndInvokerBase.h>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
} // namespace sscl
|
||||
+103
-151
@@ -1,212 +1,164 @@
|
||||
#include <iostream>
|
||||
#include <spinscale/asynchronousContinuation.h>
|
||||
#include <spinscale/asynchronousLoop.h>
|
||||
#include <spinscale/callback.h>
|
||||
#include <string_view>
|
||||
#include <vector>
|
||||
|
||||
#include <spinscale/co/group.h>
|
||||
#include <spinscale/puppetApplication.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
namespace sscl {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr std::string_view noPuppetThreadsToStartLogMessage =
|
||||
"Mrntt: No puppet threads to start";
|
||||
constexpr std::string_view noPuppetThreadsToPauseLogMessage =
|
||||
"Mrntt: No puppet threads to pause";
|
||||
constexpr std::string_view noPuppetThreadsToResumeLogMessage =
|
||||
"Mrntt: No puppet threads to resume";
|
||||
constexpr std::string_view noPuppetThreadsToExitLogMessage =
|
||||
"Mrntt: No puppet threads to exit";
|
||||
|
||||
} // namespace
|
||||
|
||||
PuppetApplication::PuppetApplication(
|
||||
const std::vector<std::shared_ptr<PuppetThread>> &threads)
|
||||
: componentThreads(threads)
|
||||
{
|
||||
}
|
||||
|
||||
class PuppetApplication::PuppetThreadLifetimeMgmtOp
|
||||
: public NonPostedAsynchronousContinuation<puppetThreadLifetimeMgmtOpCbFn>
|
||||
void PuppetApplication::addAllPuppetLifetimeInvokersToGroup(
|
||||
PuppetLifetimeMgmtGroup &group,
|
||||
std::vector<PuppetLifetimeMgmtInvoker> &invokers,
|
||||
PuppetThread::ThreadOp threadOp) const
|
||||
{
|
||||
public:
|
||||
PuppetThreadLifetimeMgmtOp(
|
||||
PuppetApplication &parent, unsigned int nThreads,
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback)
|
||||
: NonPostedAsynchronousContinuation<puppetThreadLifetimeMgmtOpCbFn>(callback),
|
||||
loop(nThreads),
|
||||
parent(parent)
|
||||
{}
|
||||
invokers.reserve(componentThreads.size());
|
||||
|
||||
public:
|
||||
AsynchronousLoop loop;
|
||||
PuppetApplication &parent;
|
||||
|
||||
public:
|
||||
void joltAllPuppetThreadsReq1(
|
||||
[[maybe_unused]] std::shared_ptr<PuppetThreadLifetimeMgmtOp> context
|
||||
)
|
||||
for (const auto &thread : componentThreads)
|
||||
{
|
||||
loop.incrementSuccessOrFailureDueTo(true);
|
||||
if (!loop.isComplete()) {
|
||||
return;
|
||||
switch (threadOp)
|
||||
{
|
||||
case PuppetThread::ThreadOp::START:
|
||||
invokers.emplace_back(thread->startThreadAReq());
|
||||
break;
|
||||
case PuppetThread::ThreadOp::PAUSE:
|
||||
invokers.emplace_back(thread->pauseThreadAReq());
|
||||
break;
|
||||
case PuppetThread::ThreadOp::RESUME:
|
||||
invokers.emplace_back(thread->resumeThreadAReq());
|
||||
break;
|
||||
case PuppetThread::ThreadOp::EXIT:
|
||||
invokers.emplace_back(thread->exitThreadAReq());
|
||||
break;
|
||||
case PuppetThread::ThreadOp::JOLT:
|
||||
invokers.emplace_back(thread->joltThreadAReq(thread));
|
||||
break;
|
||||
default:
|
||||
throw std::runtime_error(
|
||||
std::string(__func__) + ": Invalid thread operation");
|
||||
}
|
||||
|
||||
parent.threadsHaveBeenJolted = true;
|
||||
callOriginalCb();
|
||||
group.add(invokers.back());
|
||||
}
|
||||
}
|
||||
|
||||
void executeGenericOpOnAllPuppetThreadsReq1(
|
||||
[[maybe_unused]] std::shared_ptr<PuppetThreadLifetimeMgmtOp> context
|
||||
)
|
||||
{
|
||||
loop.incrementSuccessOrFailureDueTo(true);
|
||||
if (!loop.isComplete()) {
|
||||
return;
|
||||
}
|
||||
|
||||
callOriginalCb();
|
||||
}
|
||||
|
||||
void exitAllPuppetThreadsReq1(
|
||||
[[maybe_unused]] std::shared_ptr<PuppetThreadLifetimeMgmtOp> context
|
||||
)
|
||||
{
|
||||
loop.incrementSuccessOrFailureDueTo(true);
|
||||
if (!loop.isComplete()) {
|
||||
return;
|
||||
}
|
||||
|
||||
for (auto& thread : parent.componentThreads) {
|
||||
thread->thread.join();
|
||||
}
|
||||
|
||||
callOriginalCb();
|
||||
}
|
||||
};
|
||||
|
||||
void PuppetApplication::joltAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback
|
||||
)
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::joltAllPuppetThreadsCReq()
|
||||
{
|
||||
if (threadsHaveBeenJolted)
|
||||
{
|
||||
std::cout << "Mrntt: All puppet threads already JOLTed. "
|
||||
<< "Skipping JOLT request." << "\n";
|
||||
callback.callbackFn();
|
||||
return;
|
||||
co_return;
|
||||
}
|
||||
|
||||
// If no threads, set flag and call callback immediately
|
||||
if (componentThreads.size() == 0 && callback.callbackFn)
|
||||
if (componentThreads.empty())
|
||||
{
|
||||
threadsHaveBeenJolted = true;
|
||||
callback.callbackFn();
|
||||
return;
|
||||
co_return;
|
||||
}
|
||||
|
||||
// Create a counter to track when all threads have been jolted
|
||||
auto request = std::make_shared<PuppetThreadLifetimeMgmtOp>(
|
||||
*this, componentThreads.size(), callback);
|
||||
PuppetLifetimeMgmtGroup group;
|
||||
std::vector<PuppetLifetimeMgmtInvoker> invokers;
|
||||
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
thread->joltThreadReq(
|
||||
thread,
|
||||
{request, std::bind(
|
||||
&PuppetThreadLifetimeMgmtOp::joltAllPuppetThreadsReq1,
|
||||
request.get(), request)});
|
||||
}
|
||||
addAllPuppetLifetimeInvokersToGroup(
|
||||
group, invokers, PuppetThread::ThreadOp::JOLT);
|
||||
co_await group.getAwaitAllSettlementsInvoker();
|
||||
group.checkForAndReThrowGroupExceptions();
|
||||
|
||||
threadsHaveBeenJolted = true;
|
||||
co_return;
|
||||
}
|
||||
|
||||
void PuppetApplication::startAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback
|
||||
)
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp threadOp,
|
||||
std::string_view emptyThreadsLogMessage)
|
||||
{
|
||||
// If no threads, call callback immediately
|
||||
if (componentThreads.size() == 0 && callback.callbackFn)
|
||||
if (componentThreads.empty())
|
||||
{
|
||||
callback.callbackFn();
|
||||
return;
|
||||
std::cout << emptyThreadsLogMessage << "\n";
|
||||
co_return;
|
||||
}
|
||||
|
||||
// Create a counter to track when all threads have started
|
||||
auto request = std::make_shared<PuppetThreadLifetimeMgmtOp>(
|
||||
*this, componentThreads.size(), callback);
|
||||
PuppetLifetimeMgmtGroup group;
|
||||
std::vector<PuppetLifetimeMgmtInvoker> invokers;
|
||||
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
thread->startThreadReq(
|
||||
{request, std::bind(
|
||||
&PuppetThreadLifetimeMgmtOp::executeGenericOpOnAllPuppetThreadsReq1,
|
||||
request.get(), request)});
|
||||
}
|
||||
addAllPuppetLifetimeInvokersToGroup(group, invokers, threadOp);
|
||||
co_await group.getAwaitAllSettlementsInvoker();
|
||||
group.checkForAndReThrowGroupExceptions();
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
void PuppetApplication::pauseAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback
|
||||
)
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::startAllPuppetThreadsCReq()
|
||||
{
|
||||
// If no threads, call callback immediately
|
||||
if (componentThreads.size() == 0 && callback.callbackFn)
|
||||
{
|
||||
callback.callbackFn();
|
||||
return;
|
||||
}
|
||||
|
||||
// Create a counter to track when all threads have paused
|
||||
auto request = std::make_shared<PuppetThreadLifetimeMgmtOp>(
|
||||
*this, componentThreads.size(), callback);
|
||||
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
thread->pauseThreadReq(
|
||||
{request, std::bind(
|
||||
&PuppetThreadLifetimeMgmtOp::executeGenericOpOnAllPuppetThreadsReq1,
|
||||
request.get(), request)});
|
||||
}
|
||||
return allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp::START,
|
||||
noPuppetThreadsToStartLogMessage);
|
||||
}
|
||||
|
||||
void PuppetApplication::resumeAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback
|
||||
)
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::pauseAllPuppetThreadsCReq()
|
||||
{
|
||||
// If no threads, call callback immediately
|
||||
if (componentThreads.size() == 0 && callback.callbackFn)
|
||||
{
|
||||
callback.callbackFn();
|
||||
return;
|
||||
}
|
||||
|
||||
// Create a counter to track when all threads have resumed
|
||||
auto request = std::make_shared<PuppetThreadLifetimeMgmtOp>(
|
||||
*this, componentThreads.size(), callback);
|
||||
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
thread->resumeThreadReq(
|
||||
{request, std::bind(
|
||||
&PuppetThreadLifetimeMgmtOp::executeGenericOpOnAllPuppetThreadsReq1,
|
||||
request.get(), request)});
|
||||
}
|
||||
return allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp::PAUSE,
|
||||
noPuppetThreadsToPauseLogMessage);
|
||||
}
|
||||
|
||||
void PuppetApplication::exitAllPuppetThreadsReq(
|
||||
Callback<puppetThreadLifetimeMgmtOpCbFn> callback
|
||||
)
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::resumeAllPuppetThreadsCReq()
|
||||
{
|
||||
// If no threads, call callback immediately
|
||||
if (componentThreads.size() == 0 && callback.callbackFn)
|
||||
return allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp::RESUME,
|
||||
noPuppetThreadsToResumeLogMessage);
|
||||
}
|
||||
|
||||
co::ViralNonPostingInvoker<void>
|
||||
PuppetApplication::exitAllPuppetThreadsCReq()
|
||||
{
|
||||
if (componentThreads.empty())
|
||||
{
|
||||
callback.callbackFn();
|
||||
return;
|
||||
std::cout << noPuppetThreadsToExitLogMessage << "\n";
|
||||
co_return;
|
||||
}
|
||||
|
||||
// Create a counter to track when all threads have exited
|
||||
auto request = std::make_shared<PuppetThreadLifetimeMgmtOp>(
|
||||
*this, componentThreads.size(), callback);
|
||||
co_await allPuppetThreadsLifetimeOpCReq(
|
||||
PuppetThread::ThreadOp::EXIT,
|
||||
noPuppetThreadsToExitLogMessage);
|
||||
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
thread->exitThreadReq(
|
||||
{request, std::bind(
|
||||
&PuppetThreadLifetimeMgmtOp::exitAllPuppetThreadsReq1,
|
||||
request.get(), request)});
|
||||
for (auto &thread : componentThreads) {
|
||||
thread->thread.join();
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
void PuppetApplication::distributeAndPinThreadsAcrossCpus()
|
||||
{
|
||||
int cpuCount = ComponentThread::getAvailableCpuCount();
|
||||
|
||||
// Distribute and pin threads across CPUs
|
||||
int threadIndex = 0;
|
||||
for (auto& thread : componentThreads)
|
||||
{
|
||||
|
||||
@@ -16,8 +16,8 @@ void PuppeteerComponent::defaultPuppeteerMain(
|
||||
|
||||
if (args.preJoltHook) { args.preJoltHook(thr); }
|
||||
|
||||
thr.getIoService().reset();
|
||||
thr.getIoService().run();
|
||||
thr.getIoContext().restart();
|
||||
thr.getIoContext().run();
|
||||
thr.initializeTls();
|
||||
|
||||
comp.postJoltHook();
|
||||
@@ -40,17 +40,17 @@ void PuppeteerComponent::defaultPuppeteerMain(
|
||||
|
||||
try {
|
||||
/** EXPLANATION:
|
||||
* This reset() call is crucial for async bridging
|
||||
* This restart() call is crucial for async bridging
|
||||
* patterns to work.
|
||||
* When the outermost thread's io_service is stop()ped
|
||||
* When the outermost thread's io_context is stop()ped
|
||||
* (e.g., from JOLT sequence), it won't process any new
|
||||
* work until reset() is called, even if nested async
|
||||
* work until restart() is called, even if nested async
|
||||
* operations try to post work to it. This means async
|
||||
* bridges invoked from the outermost thread main sequence
|
||||
* won't work until this reset() call.
|
||||
* won't work until this restart() call.
|
||||
*/
|
||||
thr.getIoService().reset();
|
||||
thr.getIoService().run();
|
||||
thr.getIoContext().restart();
|
||||
thr.getIoContext().run();
|
||||
}
|
||||
catch (const std::exception& e)
|
||||
{
|
||||
|
||||
+7
-7
@@ -1,7 +1,7 @@
|
||||
#include <spinscale/qutex.h>
|
||||
#include <spinscale/lockerAndInvokerBase.h>
|
||||
#include <spinscale/cps/qutex.h>
|
||||
#include <spinscale/cps/lockerAndInvokerBase.h>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
bool Qutex::tryAcquire(
|
||||
const LockerAndInvokerBase &tryingLockvoker, int nRequiredLocks
|
||||
@@ -288,8 +288,8 @@ void Qutex::backoff(
|
||||
* (Assume that Lv2 was not at the front of the common qutex's
|
||||
* internal queue -- it only needed to be in the top 66%.)
|
||||
* Lv1 tries to acquire the common lock and fails. It gets taken off of
|
||||
* its io_service. It's now asleep until it gets
|
||||
* re-added into an io_service.
|
||||
* its io_context. It's now asleep until it gets
|
||||
* re-added into an io_context.
|
||||
* Lv2 fails to acquire the other 2 locks it needs and backoff()s from
|
||||
* the common lock it shares with Lv1.
|
||||
*
|
||||
@@ -357,7 +357,7 @@ void Qutex::release()
|
||||
* Just before Lv1 can acquire the common lock, Lv2 acquires it now,
|
||||
* because it only needs to be in the top 66% to succeed.
|
||||
* Lv1 checks the currOwner and sees that it's owned. Lv1 is now
|
||||
* dequeued from its io_service. It won't be awakened until someone
|
||||
* dequeued from its io_context. It won't be awakened until someone
|
||||
* awakens it.
|
||||
* Lv2 finishes its critical section and releas()es the common lock.
|
||||
* Lv2 was not at the front of the qutexQ, so it does NOT awaken the
|
||||
@@ -377,4 +377,4 @@ void Qutex::release()
|
||||
front->awaken();
|
||||
}
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
#include <spinscale/qutexAcquisitionHistoryTracker.h>
|
||||
#include <spinscale/serializedAsynchronousContinuation.h>
|
||||
#include <spinscale/qutex.h>
|
||||
#include <spinscale/dependencyGraph.h>
|
||||
#include <spinscale/cps/qutexAcquisitionHistoryTracker.h>
|
||||
#include <spinscale/cps/serializedAsynchronousContinuation.h>
|
||||
#include <spinscale/cps/qutex.h>
|
||||
#include <spinscale/cps/dependencyGraph.h>
|
||||
#include <memory>
|
||||
#include <forward_list>
|
||||
#include <functional>
|
||||
#include <iostream>
|
||||
#include <algorithm>
|
||||
|
||||
namespace sscl {
|
||||
namespace sscl::cps {
|
||||
|
||||
void DependencyGraph::addNode(const Node& node)
|
||||
{
|
||||
@@ -390,4 +390,4 @@ bool QutexAcquisitionHistoryTracker
|
||||
return true;
|
||||
}
|
||||
|
||||
} // namespace sscl
|
||||
} // namespace sscl::cps
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
add_library(spinscale_test_support STATIC
|
||||
support/threadHarness.cpp
|
||||
support/probeComponentThread.cpp
|
||||
)
|
||||
|
||||
target_include_directories(spinscale_test_support PUBLIC
|
||||
${CMAKE_CURRENT_SOURCE_DIR}
|
||||
${CMAKE_SOURCE_DIR}/tests/fixtures
|
||||
)
|
||||
|
||||
target_link_libraries(spinscale_test_support PUBLIC
|
||||
spinscale
|
||||
gtest
|
||||
)
|
||||
|
||||
function(add_spinscale_gtest target)
|
||||
add_executable(${target} ${ARGN})
|
||||
target_link_libraries(${target} PRIVATE
|
||||
spinscale_test_support
|
||||
gtest_main
|
||||
)
|
||||
add_dependencies(${target} gtest_main)
|
||||
add_test(NAME ${target} COMMAND ${target})
|
||||
endfunction()
|
||||
|
||||
add_spinscale_gtest(spinscale_env_kv_store_tests
|
||||
env_kv_store_test.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(qutex_tests
|
||||
cps/qutex_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(nonViralTaskNursery_tests
|
||||
co/nonViralTaskNursery_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(co_viral_non_posting_tests
|
||||
co/viral_non_posting_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(co_posting_cross_thread_tests
|
||||
co/posting_cross_thread_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(co_group_edge_tests
|
||||
co/group_edge_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(co_group_timer_tests
|
||||
co/group_timer_tests.cpp
|
||||
)
|
||||
|
||||
add_spinscale_gtest(co_component_continuation_tests
|
||||
co/component_continuation_tests.cpp
|
||||
)
|
||||
@@ -0,0 +1,250 @@
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <mutex>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <spinscale/co/coQutex.h>
|
||||
|
||||
#include <support/threadHarness.h>
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int leftValue = 1;
|
||||
constexpr int rightValue = 2;
|
||||
constexpr int expectedIntSum = 3;
|
||||
constexpr int bodyArgument = 4;
|
||||
constexpr const char *bodyStringArgument = "KEKW";
|
||||
constexpr const char *leftString = "Hello";
|
||||
constexpr const char *rightString = "World";
|
||||
constexpr const char *expectedString = "Hello World";
|
||||
|
||||
using BodyNonViralInvoker =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::BODY>;
|
||||
|
||||
template <typename T>
|
||||
using BodyViralInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::BODY,
|
||||
T>;
|
||||
|
||||
template <typename T>
|
||||
using WorldViralInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::WORLD,
|
||||
T>;
|
||||
|
||||
template <typename T>
|
||||
using LegViralInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::LEG,
|
||||
T>;
|
||||
|
||||
class ComponentContinuationTrace
|
||||
{
|
||||
public:
|
||||
void recordBodyThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
bodyThreadId = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordWorldThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
worldThreadId = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordLegThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
legThreadId = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordCompletionThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
completionThreadId = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordLegSum(int value)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
legSum = value;
|
||||
}
|
||||
|
||||
void recordWorldString(std::string value)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
worldString = std::move(value);
|
||||
}
|
||||
|
||||
void recordBodyString(std::string value)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
bodyString = std::move(value);
|
||||
}
|
||||
|
||||
std::thread::id bodyThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return bodyThreadId;
|
||||
}
|
||||
|
||||
std::thread::id worldThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return worldThreadId;
|
||||
}
|
||||
|
||||
std::thread::id legThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return legThreadId;
|
||||
}
|
||||
|
||||
std::thread::id completionThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return completionThreadId;
|
||||
}
|
||||
|
||||
int recordedLegSum() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return legSum;
|
||||
}
|
||||
|
||||
std::string recordedWorldString() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return worldString;
|
||||
}
|
||||
|
||||
std::string recordedBodyString() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return bodyString;
|
||||
}
|
||||
|
||||
private:
|
||||
mutable std::mutex mutex;
|
||||
std::thread::id bodyThreadId;
|
||||
std::thread::id worldThreadId;
|
||||
std::thread::id legThreadId;
|
||||
std::thread::id completionThreadId;
|
||||
int legSum = 0;
|
||||
std::string worldString;
|
||||
std::string bodyString;
|
||||
};
|
||||
|
||||
LegViralInvoker<int> print2Ints(
|
||||
int arg1,
|
||||
int arg2,
|
||||
ComponentContinuationTrace &trace)
|
||||
{
|
||||
sscl::co::CoQutex print2IntsLock;
|
||||
trace.recordLegThread();
|
||||
auto releaseHandle =
|
||||
co_await print2IntsLock.getAcquireInvocationAndSuspensionPolicy();
|
||||
const int sum = arg1 + arg2;
|
||||
trace.recordLegSum(sum);
|
||||
releaseHandle.release();
|
||||
co_return sum;
|
||||
}
|
||||
|
||||
WorldViralInvoker<std::string> print2Strings(
|
||||
std::string arg1,
|
||||
std::string arg2,
|
||||
ComponentContinuationTrace &trace)
|
||||
{
|
||||
sscl::co::CoQutex print2StringsLock;
|
||||
trace.recordWorldThread();
|
||||
auto releaseHandle =
|
||||
co_await print2StringsLock.getAcquireInvocationAndSuspensionPolicy();
|
||||
const int returnedInt =
|
||||
co_await print2Ints(leftValue, rightValue, trace);
|
||||
releaseHandle.release();
|
||||
|
||||
if (returnedInt != expectedIntSum) {
|
||||
throw std::runtime_error("LEG int return mismatch");
|
||||
}
|
||||
|
||||
std::string returnedString = arg1 + " " + arg2;
|
||||
trace.recordWorldString(returnedString);
|
||||
co_return returnedString;
|
||||
}
|
||||
|
||||
BodyNonViralInvoker initializeDemoCReq(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
int arg3,
|
||||
std::string arg4,
|
||||
ComponentContinuationTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
(void)arg3;
|
||||
(void)arg4;
|
||||
|
||||
sscl::co::CoQutex initializeLock;
|
||||
trace.recordBodyThread();
|
||||
auto releaseHandle =
|
||||
co_await initializeLock.getAcquireInvocationAndSuspensionPolicy();
|
||||
std::string returnedString =
|
||||
co_await print2Strings(leftString, rightString, trace);
|
||||
releaseHandle.release();
|
||||
|
||||
trace.recordBodyString(returnedString);
|
||||
co_return;
|
||||
}
|
||||
|
||||
class ComponentContinuationTest
|
||||
: public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
TEST_F(ComponentContinuationTest, SyncMainStyleContinuationCrossesComponentThreads)
|
||||
{
|
||||
ComponentContinuationTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return initializeDemoCReq(
|
||||
exceptionPtr,
|
||||
[&trace, completion = std::move(completion)]() mutable
|
||||
{
|
||||
trace.recordCompletionThread();
|
||||
completion();
|
||||
},
|
||||
bodyArgument,
|
||||
bodyStringArgument,
|
||||
trace);
|
||||
}));
|
||||
|
||||
EXPECT_EQ(trace.bodyThread(), threads.body().osThreadId());
|
||||
EXPECT_EQ(trace.worldThread(), threads.world().osThreadId());
|
||||
EXPECT_EQ(trace.legThread(), threads.leg().osThreadId());
|
||||
EXPECT_EQ(trace.completionThread(), threads.caller().osThreadId());
|
||||
|
||||
EXPECT_NE(trace.bodyThread(), trace.worldThread());
|
||||
EXPECT_NE(trace.worldThread(), trace.legThread());
|
||||
EXPECT_NE(trace.legThread(), trace.completionThread());
|
||||
|
||||
EXPECT_EQ(trace.recordedLegSum(), expectedIntSum);
|
||||
EXPECT_EQ(trace.recordedWorldString(), expectedString);
|
||||
EXPECT_EQ(trace.recordedBodyString(), expectedString);
|
||||
}
|
||||
@@ -0,0 +1,864 @@
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <boost/asio/post.hpp>
|
||||
#include <boost/system/error_code.hpp>
|
||||
|
||||
#include <spinscale/co/group.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
#include <support/groupAssertions.h>
|
||||
#include <support/threadHarness.h>
|
||||
#include <support/timerAwaiters.h>
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int delayShortMs = 50;
|
||||
constexpr int delayMediumMs = 200;
|
||||
constexpr int delayLongMs = 500;
|
||||
constexpr int delayAddWhileSuspendedProbeMs = 80;
|
||||
constexpr int expectedNonStdThrowValue = 42;
|
||||
constexpr int wave2ImmediateSettlementLabel = 1000;
|
||||
constexpr const char *expectedThrowMessage =
|
||||
"group_edge_test intentional failure";
|
||||
|
||||
using CallerDriver =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLER>;
|
||||
|
||||
using CalleeIntInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLEE,
|
||||
int>;
|
||||
|
||||
using CalleeVoidInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLEE,
|
||||
void>;
|
||||
|
||||
CalleeIntInvoker waitAndReturnLabel(int timerLabelMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
timerLabelMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
co_return timerLabelMilliseconds;
|
||||
}
|
||||
|
||||
CalleeIntInvoker waitThenThrowAfterDelay(int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
throw std::runtime_error(expectedThrowMessage);
|
||||
}
|
||||
|
||||
CalleeIntInvoker waitThenThrowIntAfterDelay(int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
throw expectedNonStdThrowValue;
|
||||
}
|
||||
|
||||
CalleeIntInvoker returnLabelImmediately(int label)
|
||||
{
|
||||
co_return label;
|
||||
}
|
||||
|
||||
CalleeVoidInvoker voidMemberAfterDelay(int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
co_return;
|
||||
}
|
||||
|
||||
CalleeIntInvoker waitRecordThreadAndReturnLabel(
|
||||
int timerLabelMilliseconds,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
timerLabelMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
trace.recordCalleeExecutionThread();
|
||||
co_return timerLabelMilliseconds;
|
||||
}
|
||||
|
||||
sscl::co::ViralNonPostingInvoker<void> waitOnCallerThread(int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver mixedSuccessAndFailureAwaitFirstThenAll(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker successInvoker = waitAndReturnLabel(1);
|
||||
CalleeIntInvoker failureInvoker = waitThenThrowAfterDelay(delayShortMs);
|
||||
|
||||
group.add(successInvoker);
|
||||
group.add(failureInvoker);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
|
||||
if (firstDescriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::COMPLETED) {
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
1);
|
||||
}
|
||||
else if (firstDescriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::EXCEPTION_THROWN) {
|
||||
sscl::tests::requireRuntimeErrorSettlement(
|
||||
firstDescriptor,
|
||||
expectedThrowMessage);
|
||||
}
|
||||
else {
|
||||
throw std::runtime_error("first settlement has unexpected type");
|
||||
}
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allDescriptors = co_await awaitAll;
|
||||
|
||||
if (allDescriptors.size() != 2 || allAfterFirst.size() != 2) {
|
||||
throw std::runtime_error("mixed settlement count mismatch");
|
||||
}
|
||||
|
||||
std::size_t completedCount = 0;
|
||||
std::size_t exceptionCount = 0;
|
||||
|
||||
for (auto &descriptor : allDescriptors) {
|
||||
if (descriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::COMPLETED) {
|
||||
++completedCount;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
descriptor,
|
||||
1);
|
||||
}
|
||||
else if (descriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::EXCEPTION_THROWN) {
|
||||
++exceptionCount;
|
||||
sscl::tests::requireRuntimeErrorSettlement(
|
||||
descriptor,
|
||||
expectedThrowMessage);
|
||||
}
|
||||
}
|
||||
|
||||
if (completedCount != 1 || exceptionCount != 1) {
|
||||
throw std::runtime_error("mixed settlement type counts mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver singleMemberAwaitFirstThenAll(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker onlyInvoker = waitAndReturnLabel(delayShortMs);
|
||||
group.add(onlyInvoker);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
delayShortMs);
|
||||
|
||||
if (!group.allInvokersSettled() || allAfterFirst.size() != 1) {
|
||||
throw std::runtime_error("single member state mismatch");
|
||||
}
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allDescriptors = co_await awaitAll;
|
||||
|
||||
if (allDescriptors.size() != 1) {
|
||||
throw std::runtime_error("single member await-all count mismatch");
|
||||
}
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allDescriptors[0],
|
||||
delayShortMs);
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver allCompleteBeforeCoAwait(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker invokerTen = returnLabelImmediately(10);
|
||||
CalleeIntInvoker invokerTwenty = returnLabelImmediately(20);
|
||||
CalleeIntInvoker invokerThirty = returnLabelImmediately(30);
|
||||
|
||||
group.add(invokerTen);
|
||||
group.add(invokerTwenty);
|
||||
group.add(invokerThirty);
|
||||
|
||||
co_await waitOnCallerThread(delayShortMs);
|
||||
|
||||
if (!group.allInvokersSettled() || !group.firstInvokerSettled()) {
|
||||
throw std::runtime_error("immediate group did not settle before await");
|
||||
}
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
10);
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allDescriptors = co_await awaitAll;
|
||||
|
||||
if (allDescriptors.size() != 3 || allAfterFirst.size() != 3) {
|
||||
throw std::runtime_error("immediate settlement count mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
std::jthread startAddWhileGroupAwaiterSuspendedProbe(
|
||||
sscl::co::Group &group,
|
||||
CalleeIntInvoker &lateInvoker,
|
||||
std::atomic<bool> &groupIsAwaitingAll,
|
||||
std::atomic<bool> &addWasRejected)
|
||||
{
|
||||
return std::jthread(
|
||||
[&]()
|
||||
{
|
||||
while (!groupIsAwaitingAll.load(std::memory_order_acquire)) {
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(1));
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(
|
||||
std::chrono::milliseconds(delayAddWhileSuspendedProbeMs));
|
||||
|
||||
boost::asio::post(
|
||||
sscl::tests::ThreadRegistry::ioContext(
|
||||
sscl::tests::PostingThreadRole::CALLER),
|
||||
[&]()
|
||||
{
|
||||
try {
|
||||
group.add(lateInvoker);
|
||||
}
|
||||
catch (const std::runtime_error &) {
|
||||
addWasRejected.store(true, std::memory_order_release);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
CallerDriver addWhileAwaitAllSuspended(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
std::atomic<bool> groupIsAwaitingAll{false};
|
||||
std::atomic<bool> addWasRejected{false};
|
||||
|
||||
CalleeIntInvoker slowInvokerA = waitAndReturnLabel(delayLongMs);
|
||||
CalleeIntInvoker slowInvokerB = waitAndReturnLabel(delayLongMs);
|
||||
CalleeIntInvoker lateInvoker = waitAndReturnLabel(99);
|
||||
|
||||
group.add(slowInvokerA);
|
||||
group.add(slowInvokerB);
|
||||
|
||||
std::jthread addProbeThread = startAddWhileGroupAwaiterSuspendedProbe(
|
||||
group,
|
||||
lateInvoker,
|
||||
groupIsAwaitingAll,
|
||||
addWasRejected);
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
groupIsAwaitingAll.store(true, std::memory_order_release);
|
||||
co_await awaitAll;
|
||||
|
||||
addProbeThread.join();
|
||||
|
||||
if (!addWasRejected.load(std::memory_order_acquire)) {
|
||||
throw std::runtime_error("expected add while suspended to throw");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver awaitAllOnlyMixedOutcomes(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker successInvoker = returnLabelImmediately(7);
|
||||
CalleeIntInvoker failureInvoker = waitThenThrowAfterDelay(delayShortMs);
|
||||
|
||||
group.add(successInvoker);
|
||||
group.add(failureInvoker);
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allDescriptors = co_await awaitAll;
|
||||
|
||||
if (allDescriptors.size() != 2) {
|
||||
throw std::runtime_error("await-all-only count mismatch");
|
||||
}
|
||||
|
||||
std::size_t completedCount = 0;
|
||||
std::size_t exceptionCount = 0;
|
||||
|
||||
for (auto &descriptor : allDescriptors) {
|
||||
if (descriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::COMPLETED) {
|
||||
++completedCount;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
descriptor,
|
||||
7);
|
||||
}
|
||||
else if (descriptor.type
|
||||
== sscl::co::Group::SettlementDescriptor::TypeE::EXCEPTION_THROWN) {
|
||||
++exceptionCount;
|
||||
sscl::tests::requireRuntimeErrorSettlement(
|
||||
descriptor,
|
||||
expectedThrowMessage);
|
||||
}
|
||||
}
|
||||
|
||||
if (completedCount != 1 || exceptionCount != 1) {
|
||||
throw std::runtime_error("await-all-only mixed counts mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver checkForAndReThrowGroupExceptions(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker failureInvoker = waitThenThrowAfterDelay(delayShortMs);
|
||||
group.add(failureInvoker);
|
||||
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
try {
|
||||
group.checkForAndReThrowGroupExceptions();
|
||||
}
|
||||
catch (const std::runtime_error &aggregateError) {
|
||||
if (std::string(aggregateError.what()).find(expectedThrowMessage)
|
||||
== std::string::npos) {
|
||||
throw std::runtime_error("aggregate message missing callee text");
|
||||
}
|
||||
co_return;
|
||||
}
|
||||
|
||||
throw std::runtime_error("expected aggregate group exception");
|
||||
}
|
||||
|
||||
CallerDriver emptyGroupAwaitAllThrows(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
|
||||
try {
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
}
|
||||
catch (const std::runtime_error &runtimeError) {
|
||||
sscl::tests::requireEmptyGroupError(runtimeError);
|
||||
co_return;
|
||||
}
|
||||
|
||||
throw std::runtime_error("expected empty group await-all to throw");
|
||||
}
|
||||
|
||||
CallerDriver emptyGroupAwaitFirstThrows(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
|
||||
try {
|
||||
(void)co_await group.getAwaitFirstSettlementInvoker();
|
||||
}
|
||||
catch (const std::runtime_error &runtimeError) {
|
||||
sscl::tests::requireEmptyGroupError(runtimeError);
|
||||
co_return;
|
||||
}
|
||||
|
||||
throw std::runtime_error("expected empty group await-first to throw");
|
||||
}
|
||||
|
||||
CallerDriver wrongAwaitInvokerOrder(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker shortInvoker = waitAndReturnLabel(delayShortMs);
|
||||
CalleeIntInvoker mediumInvoker = waitAndReturnLabel(delayMediumMs);
|
||||
|
||||
group.add(shortInvoker);
|
||||
group.add(mediumInvoker);
|
||||
|
||||
auto awaitFirstHandle = group.getAwaitFirstSettlementInvoker();
|
||||
auto awaitAllHandle = group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
auto &allDescriptors = co_await awaitAllHandle;
|
||||
if (allDescriptors.size() != 2) {
|
||||
throw std::runtime_error("wrong-order await-all count mismatch");
|
||||
}
|
||||
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirstHandle;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
sscl::tests::completedIntValue(
|
||||
firstDescriptor.invokerAs<CalleeIntInvoker>()));
|
||||
|
||||
if (!group.firstInvokerSettled() || allAfterFirst.size() != 2) {
|
||||
throw std::runtime_error("wrong-order await-first state mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver doubleCoAwaitSameAwaitFirst(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker memberInvoker = returnLabelImmediately(delayShortMs);
|
||||
group.add(memberInvoker);
|
||||
|
||||
co_await waitOnCallerThread(delayShortMs);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptorA, allAfterFirstA] = co_await awaitFirst;
|
||||
auto [firstDescriptorB, allAfterFirstB] = co_await awaitFirst;
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptorA,
|
||||
delayShortMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptorB,
|
||||
delayShortMs);
|
||||
|
||||
if (&firstDescriptorA.invokerAs<CalleeIntInvoker>()
|
||||
!= &firstDescriptorB.invokerAs<CalleeIntInvoker>()) {
|
||||
throw std::runtime_error("double await-first descriptor mismatch");
|
||||
}
|
||||
|
||||
if (allAfterFirstA.size() != allAfterFirstB.size()) {
|
||||
throw std::runtime_error("double await-first snapshot mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver doubleCoAwaitSameAwaitAll(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker memberInvoker = waitAndReturnLabel(delayShortMs);
|
||||
group.add(memberInvoker);
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allDescriptorsA = co_await awaitAll;
|
||||
auto &allDescriptorsB = co_await awaitAll;
|
||||
|
||||
if (allDescriptorsA.size() != 1 || allDescriptorsB.size() != 1) {
|
||||
throw std::runtime_error("double await-all count mismatch");
|
||||
}
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allDescriptorsA[0],
|
||||
delayShortMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allDescriptorsB[0],
|
||||
delayShortMs);
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver twoAwaitFirstHandlesSequentially(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker shortInvoker = waitAndReturnLabel(delayShortMs);
|
||||
CalleeIntInvoker mediumInvoker = waitAndReturnLabel(delayMediumMs);
|
||||
|
||||
group.add(shortInvoker);
|
||||
group.add(mediumInvoker);
|
||||
|
||||
auto awaitFirstA = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptorA, allAfterFirstA] = co_await awaitFirstA;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptorA,
|
||||
delayShortMs);
|
||||
|
||||
auto awaitFirstB = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptorB, allAfterFirstB] = co_await awaitFirstB;
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptorB,
|
||||
delayShortMs);
|
||||
|
||||
if (&firstDescriptorA.invokerAs<CalleeIntInvoker>()
|
||||
!= &firstDescriptorB.invokerAs<CalleeIntInvoker>()) {
|
||||
throw std::runtime_error("sticky first settlement mismatch");
|
||||
}
|
||||
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
(void)allAfterFirstA;
|
||||
(void)allAfterFirstB;
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver addSecondWaveAfterAwaitAll(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker wave1MemberA = waitAndReturnLabel(delayLongMs);
|
||||
CalleeIntInvoker wave1MemberB = waitAndReturnLabel(delayLongMs);
|
||||
|
||||
group.add(wave1MemberA);
|
||||
group.add(wave1MemberB);
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
CalleeIntInvoker wave2Immediate =
|
||||
returnLabelImmediately(wave2ImmediateSettlementLabel);
|
||||
CalleeIntInvoker wave2Slow = waitAndReturnLabel(delayMediumMs);
|
||||
|
||||
group.add(wave2Immediate);
|
||||
group.add(wave2Slow);
|
||||
|
||||
co_await waitOnCallerThread(delayShortMs);
|
||||
|
||||
if (sscl::tests::completedIntValue(wave2Immediate)
|
||||
!= wave2ImmediateSettlementLabel) {
|
||||
throw std::runtime_error("wave-2 immediate member did not complete");
|
||||
}
|
||||
|
||||
if (group.allInvokersSettled()) {
|
||||
throw std::runtime_error("wave-2 slow member should still be in flight");
|
||||
}
|
||||
|
||||
auto &allDescriptors =
|
||||
co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
if (allDescriptors.size() != 4) {
|
||||
throw std::runtime_error("expected four settlements after second wave");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver shortTimerAddedAfterLongStillWinsRace(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker longInvoker = waitAndReturnLabel(delayLongMs);
|
||||
CalleeIntInvoker shortInvoker = waitAndReturnLabel(delayShortMs);
|
||||
|
||||
group.add(longInvoker);
|
||||
group.add(shortInvoker);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
delayShortMs);
|
||||
|
||||
if (&firstDescriptor.invokerAs<CalleeIntInvoker>() != &shortInvoker) {
|
||||
throw std::runtime_error("short timer should win first settlement");
|
||||
}
|
||||
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
(void)allAfterFirst;
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver nonStdExceptionSettlement(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker failureInvoker = waitThenThrowIntAfterDelay(delayShortMs);
|
||||
group.add(failureInvoker);
|
||||
|
||||
auto &allDescriptors = co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
if (allDescriptors.size() != 1) {
|
||||
throw std::runtime_error("non-std exception count mismatch");
|
||||
}
|
||||
|
||||
sscl::tests::requireIntExceptionSettlement(
|
||||
allDescriptors[0],
|
||||
expectedNonStdThrowValue);
|
||||
|
||||
try {
|
||||
group.checkForAndReThrowGroupExceptions();
|
||||
}
|
||||
catch (const std::runtime_error &) {
|
||||
co_return;
|
||||
}
|
||||
|
||||
throw std::runtime_error("expected aggregate for non-std exception");
|
||||
}
|
||||
|
||||
CallerDriver voidViralMemberInGroup(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeVoidInvoker voidInvoker = voidMemberAfterDelay(delayShortMs);
|
||||
group.add(voidInvoker);
|
||||
|
||||
auto &allDescriptors = co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
if (allDescriptors.size() != 1) {
|
||||
throw std::runtime_error("void group count mismatch");
|
||||
}
|
||||
|
||||
if (allDescriptors[0].type
|
||||
!= sscl::co::Group::SettlementDescriptor::TypeE::COMPLETED) {
|
||||
throw std::runtime_error("void member did not complete");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver returnValuesRemainReadableAfterAwaitFirst(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker slowInvoker = waitAndReturnLabel(delayLongMs);
|
||||
CalleeIntInvoker fastInvoker = waitAndReturnLabel(delayShortMs);
|
||||
|
||||
group.add(slowInvoker);
|
||||
group.add(fastInvoker);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
delayShortMs);
|
||||
|
||||
const int fastLabelFromDescriptor = sscl::tests::completedIntValue(
|
||||
firstDescriptor.invokerAs<CalleeIntInvoker>());
|
||||
const int fastLabelFromLocal =
|
||||
sscl::tests::completedIntValue(fastInvoker);
|
||||
|
||||
if (fastLabelFromDescriptor != fastLabelFromLocal) {
|
||||
throw std::runtime_error("descriptor/local return value mismatch");
|
||||
}
|
||||
|
||||
if (allAfterFirst.size() != 2) {
|
||||
throw std::runtime_error("expected two settlement slots");
|
||||
}
|
||||
|
||||
(void)co_await group.getAwaitAllSettlementsInvoker();
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver groupMemberRunsOnCalleeAndAwaitResumesOnCaller(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker memberInvoker = waitRecordThreadAndReturnLabel(
|
||||
delayShortMs,
|
||||
trace);
|
||||
group.add(memberInvoker);
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstDescriptor, allAfterFirst] = co_await awaitFirst;
|
||||
trace.recordAwaitResumeThread();
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstDescriptor,
|
||||
delayShortMs);
|
||||
|
||||
if (allAfterFirst.size() != 1) {
|
||||
throw std::runtime_error("cross-thread group trace count mismatch");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
class GroupEdgeTest
|
||||
: public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
template <typename Factory>
|
||||
void runScenario(Factory &&factory)
|
||||
{
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
std::forward<Factory>(factory)));
|
||||
}
|
||||
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
#define RUN_GROUP_EDGE_SCENARIO(testName, functionName) \
|
||||
TEST_F(GroupEdgeTest, testName) \
|
||||
{ \
|
||||
runScenario( \
|
||||
[]( \
|
||||
std::exception_ptr &exceptionPtr, \
|
||||
std::function<void()> completion) \
|
||||
{ \
|
||||
return functionName(exceptionPtr, std::move(completion)); \
|
||||
}); \
|
||||
}
|
||||
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
MixedSuccessAndFailureAwaitFirstThenAll,
|
||||
mixedSuccessAndFailureAwaitFirstThenAll)
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
SingleMemberAwaitFirstThenAll,
|
||||
singleMemberAwaitFirstThenAll)
|
||||
RUN_GROUP_EDGE_SCENARIO(AllCompleteBeforeCoAwait, allCompleteBeforeCoAwait)
|
||||
RUN_GROUP_EDGE_SCENARIO(AddWhileAwaitAllSuspended, addWhileAwaitAllSuspended)
|
||||
RUN_GROUP_EDGE_SCENARIO(AwaitAllOnlyMixedOutcomes, awaitAllOnlyMixedOutcomes)
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
CheckForAndReThrowGroupExceptions,
|
||||
checkForAndReThrowGroupExceptions)
|
||||
RUN_GROUP_EDGE_SCENARIO(EmptyGroupAwaitAllThrows, emptyGroupAwaitAllThrows)
|
||||
RUN_GROUP_EDGE_SCENARIO(EmptyGroupAwaitFirstThrows, emptyGroupAwaitFirstThrows)
|
||||
RUN_GROUP_EDGE_SCENARIO(WrongAwaitInvokerOrder, wrongAwaitInvokerOrder)
|
||||
RUN_GROUP_EDGE_SCENARIO(DoubleCoAwaitSameAwaitFirst, doubleCoAwaitSameAwaitFirst)
|
||||
RUN_GROUP_EDGE_SCENARIO(DoubleCoAwaitSameAwaitAll, doubleCoAwaitSameAwaitAll)
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
TwoAwaitFirstHandlesSequentially,
|
||||
twoAwaitFirstHandlesSequentially)
|
||||
RUN_GROUP_EDGE_SCENARIO(AddSecondWaveAfterAwaitAll, addSecondWaveAfterAwaitAll)
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
ShortTimerAddedAfterLongStillWinsRace,
|
||||
shortTimerAddedAfterLongStillWinsRace)
|
||||
RUN_GROUP_EDGE_SCENARIO(NonStdExceptionSettlement, nonStdExceptionSettlement)
|
||||
RUN_GROUP_EDGE_SCENARIO(VoidViralMemberInGroup, voidViralMemberInGroup)
|
||||
RUN_GROUP_EDGE_SCENARIO(
|
||||
ReturnValuesRemainReadableAfterAwaitFirst,
|
||||
returnValuesRemainReadableAfterAwaitFirst)
|
||||
|
||||
TEST_F(GroupEdgeTest, SuspendingMemberRunsOnCalleeAndAwaitResumesOnCaller)
|
||||
{
|
||||
sscl::tests::CrossThreadTrace trace;
|
||||
|
||||
runScenario(
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return groupMemberRunsOnCalleeAndAwaitResumesOnCaller(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
trace);
|
||||
});
|
||||
|
||||
EXPECT_EQ(trace.calleeExecutionThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.awaitResumeThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), trace.awaitResumeThread());
|
||||
}
|
||||
|
||||
TEST_F(GroupEdgeTest, NonViralVoidGroupTemplateInstantiates)
|
||||
{
|
||||
GTEST_SKIP()
|
||||
<< "NonViralPostingInvoker does not satisfy Group's awaitable concept.";
|
||||
}
|
||||
|
||||
TEST_F(GroupEdgeTest, EarlyInvokerDestructionIsUnsupported)
|
||||
{
|
||||
GTEST_SKIP()
|
||||
<< "Destroying a member invoker before group settlement completes is undefined.";
|
||||
}
|
||||
|
||||
TEST_F(GroupEdgeTest, OverlappingGroupWaitsAssertInDebug)
|
||||
{
|
||||
GTEST_SKIP()
|
||||
<< "Overlapping group co_await is debug-assert behavior.";
|
||||
}
|
||||
@@ -0,0 +1,368 @@
|
||||
#include <chrono>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <map>
|
||||
#include <mutex>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <boost/asio/error.hpp>
|
||||
#include <boost/system/error_code.hpp>
|
||||
|
||||
#include <spinscale/co/group.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
#include <support/groupAssertions.h>
|
||||
#include <support/threadHarness.h>
|
||||
#include <support/timerAwaiters.h>
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int timerDelayShortMs = 50;
|
||||
constexpr int timerDelayMediumMs = 200;
|
||||
constexpr int timerDelayLongMs = 500;
|
||||
constexpr int awaitAllTimingSlackMs = 25;
|
||||
constexpr int awaitAllLongCancelTimingMarginMs = 50;
|
||||
|
||||
using CallerDriver =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLER>;
|
||||
|
||||
using CalleeIntInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLEE,
|
||||
int>;
|
||||
|
||||
using Clock = std::chrono::steady_clock;
|
||||
using Ms = std::chrono::milliseconds;
|
||||
|
||||
class GroupTimerThreadTrace
|
||||
{
|
||||
public:
|
||||
void recordTimerCompletionThread(int timerLabelMilliseconds)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
timerCompletionThreads[timerLabelMilliseconds] =
|
||||
std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordAwaitFirstResumeThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
awaitFirstResumeThread = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
void recordAwaitAllResumeThread()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
awaitAllResumeThread = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
std::thread::id timerCompletionThread(int timerLabelMilliseconds) const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
const auto iterator =
|
||||
timerCompletionThreads.find(timerLabelMilliseconds);
|
||||
|
||||
if (iterator == timerCompletionThreads.end()) {
|
||||
throw std::runtime_error("Missing timer completion thread trace");
|
||||
}
|
||||
|
||||
return iterator->second;
|
||||
}
|
||||
|
||||
std::thread::id awaitFirstThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return awaitFirstResumeThread;
|
||||
}
|
||||
|
||||
std::thread::id awaitAllThread() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return awaitAllResumeThread;
|
||||
}
|
||||
|
||||
private:
|
||||
mutable std::mutex mutex;
|
||||
std::map<int, std::thread::id> timerCompletionThreads;
|
||||
std::thread::id awaitFirstResumeThread;
|
||||
std::thread::id awaitAllResumeThread;
|
||||
};
|
||||
|
||||
CalleeIntInvoker waitDeadlineTimer(
|
||||
int timerLabelMilliseconds,
|
||||
GroupTimerThreadTrace &trace)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
timerLabelMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
trace.recordTimerCompletionThread(timerLabelMilliseconds);
|
||||
co_return timerLabelMilliseconds;
|
||||
}
|
||||
|
||||
CalleeIntInvoker waitCancelableDeadlineTimer(
|
||||
int timerLabelMilliseconds,
|
||||
sscl::tests::CancelableDeadlineTimerRegistry ®istry,
|
||||
GroupTimerThreadTrace &trace)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::RegisteredDeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
timerLabelMilliseconds,
|
||||
timerLabelMilliseconds,
|
||||
registry};
|
||||
|
||||
if (sscl::tests::timerWasCanceled(waitError)) {
|
||||
trace.recordTimerCompletionThread(timerLabelMilliseconds);
|
||||
co_return timerLabelMilliseconds;
|
||||
}
|
||||
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
trace.recordTimerCompletionThread(timerLabelMilliseconds);
|
||||
co_return timerLabelMilliseconds;
|
||||
}
|
||||
|
||||
void throwIfElapsedTooLong(
|
||||
const Ms &elapsed,
|
||||
const Ms &limit,
|
||||
const char *message)
|
||||
{
|
||||
if (elapsed > limit) {
|
||||
throw std::runtime_error(
|
||||
std::string(message) + ": " + std::to_string(elapsed.count()));
|
||||
}
|
||||
}
|
||||
|
||||
void throwIfElapsedTooShort(
|
||||
const Ms &elapsed,
|
||||
const Ms &limit,
|
||||
const char *message)
|
||||
{
|
||||
if (elapsed < limit) {
|
||||
throw std::runtime_error(
|
||||
std::string(message) + ": " + std::to_string(elapsed.count()));
|
||||
}
|
||||
}
|
||||
|
||||
CallerDriver runGroupTimerRace(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
GroupTimerThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker invokerShort =
|
||||
waitDeadlineTimer(timerDelayShortMs, trace);
|
||||
CalleeIntInvoker invokerMedium =
|
||||
waitDeadlineTimer(timerDelayMediumMs, trace);
|
||||
CalleeIntInvoker invokerLong =
|
||||
waitDeadlineTimer(timerDelayLongMs, trace);
|
||||
|
||||
group.add(invokerShort);
|
||||
group.add(invokerMedium);
|
||||
group.add(invokerLong);
|
||||
|
||||
const auto testStart = Clock::now();
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstSettlement, allSettlementsAfterFirst] = co_await awaitFirst;
|
||||
trace.recordAwaitFirstResumeThread();
|
||||
|
||||
const auto firstElapsedMs =
|
||||
std::chrono::duration_cast<Ms>(Clock::now() - testStart);
|
||||
throwIfElapsedTooLong(
|
||||
firstElapsedMs,
|
||||
Ms(timerDelayMediumMs - awaitAllTimingSlackMs),
|
||||
"await-first took too long");
|
||||
|
||||
if (&firstSettlement.invokerAs<CalleeIntInvoker>() != &invokerShort) {
|
||||
throw std::runtime_error("first settlement was not shortest timer");
|
||||
}
|
||||
|
||||
if (group.allInvokersSettled()) {
|
||||
throw std::runtime_error("await-first returned after all settled");
|
||||
}
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allSettlements = co_await awaitAll;
|
||||
trace.recordAwaitAllResumeThread();
|
||||
|
||||
const auto allElapsedMs =
|
||||
std::chrono::duration_cast<Ms>(Clock::now() - testStart);
|
||||
throwIfElapsedTooShort(
|
||||
allElapsedMs,
|
||||
Ms(timerDelayLongMs - awaitAllLongCancelTimingMarginMs),
|
||||
"await-all finished too soon");
|
||||
|
||||
if (allSettlements.size() != 3) {
|
||||
throw std::runtime_error("expected three settlements");
|
||||
}
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
firstSettlement,
|
||||
timerDelayShortMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlementsAfterFirst[0],
|
||||
timerDelayShortMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlementsAfterFirst[1],
|
||||
timerDelayMediumMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlementsAfterFirst[2],
|
||||
timerDelayLongMs);
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerDriver runGroupTimerCancelLongAfterAwaitFirst(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CancelableDeadlineTimerRegistry ®istry,
|
||||
GroupTimerThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
CalleeIntInvoker invokerShort =
|
||||
waitCancelableDeadlineTimer(timerDelayShortMs, registry, trace);
|
||||
CalleeIntInvoker invokerMedium =
|
||||
waitCancelableDeadlineTimer(timerDelayMediumMs, registry, trace);
|
||||
CalleeIntInvoker invokerLong =
|
||||
waitCancelableDeadlineTimer(timerDelayLongMs, registry, trace);
|
||||
|
||||
group.add(invokerShort);
|
||||
group.add(invokerMedium);
|
||||
group.add(invokerLong);
|
||||
|
||||
const auto testStart = Clock::now();
|
||||
|
||||
auto awaitFirst = group.getAwaitFirstSettlementInvoker();
|
||||
auto [firstSettlement, allSettlementsAfterFirst] = co_await awaitFirst;
|
||||
trace.recordAwaitFirstResumeThread();
|
||||
|
||||
if (&firstSettlement.invokerAs<CalleeIntInvoker>() != &invokerShort) {
|
||||
throw std::runtime_error("cancel test first settlement mismatch");
|
||||
}
|
||||
|
||||
if (group.allInvokersSettled()) {
|
||||
throw std::runtime_error("cancel test all settled after await-first");
|
||||
}
|
||||
|
||||
registry.cancel(timerDelayLongMs);
|
||||
|
||||
auto awaitAll = group.getAwaitAllSettlementsInvoker();
|
||||
auto &allSettlements = co_await awaitAll;
|
||||
trace.recordAwaitAllResumeThread();
|
||||
|
||||
const auto allElapsedMs =
|
||||
std::chrono::duration_cast<Ms>(Clock::now() - testStart);
|
||||
|
||||
if (allElapsedMs >= Ms(timerDelayLongMs - awaitAllLongCancelTimingMarginMs)) {
|
||||
throw std::runtime_error("await-all waited for canceled long timer");
|
||||
}
|
||||
|
||||
throwIfElapsedTooShort(
|
||||
allElapsedMs,
|
||||
Ms(timerDelayMediumMs - awaitAllTimingSlackMs),
|
||||
"await-all finished before medium timer");
|
||||
|
||||
if (allSettlements.size() != 3) {
|
||||
throw std::runtime_error("cancel test expected three settlements");
|
||||
}
|
||||
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlements[0],
|
||||
timerDelayShortMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlements[1],
|
||||
timerDelayMediumMs);
|
||||
sscl::tests::requireCompletedIntSettlement<CalleeIntInvoker>(
|
||||
allSettlements[2],
|
||||
timerDelayLongMs);
|
||||
|
||||
if (&allSettlements[2].invokerAs<CalleeIntInvoker>() != &invokerLong) {
|
||||
throw std::runtime_error("cancel test long invoker mismatch");
|
||||
}
|
||||
|
||||
(void)allSettlementsAfterFirst;
|
||||
co_return;
|
||||
}
|
||||
|
||||
class GroupTimerTest
|
||||
: public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
void assertTimerTraceCrossedThreads(
|
||||
const GroupTimerThreadTrace &trace)
|
||||
{
|
||||
EXPECT_EQ(
|
||||
trace.timerCompletionThread(timerDelayShortMs),
|
||||
threads.callee().osThreadId());
|
||||
EXPECT_EQ(
|
||||
trace.timerCompletionThread(timerDelayMediumMs),
|
||||
threads.callee().osThreadId());
|
||||
EXPECT_EQ(
|
||||
trace.timerCompletionThread(timerDelayLongMs),
|
||||
threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.awaitFirstThread(), threads.caller().osThreadId());
|
||||
EXPECT_EQ(trace.awaitAllThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(
|
||||
trace.timerCompletionThread(timerDelayShortMs),
|
||||
trace.awaitFirstThread());
|
||||
}
|
||||
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
TEST_F(GroupTimerTest, AwaitFirstReturnsShortestTimerAndAwaitAllWaitsForLongest)
|
||||
{
|
||||
GroupTimerThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return runGroupTimerRace(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
trace);
|
||||
}));
|
||||
|
||||
assertTimerTraceCrossedThreads(trace);
|
||||
}
|
||||
|
||||
TEST_F(GroupTimerTest, CancelLongTimerAfterAwaitFirst)
|
||||
{
|
||||
sscl::tests::CancelableDeadlineTimerRegistry registry;
|
||||
GroupTimerThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[®istry, &trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return runGroupTimerCancelLongAfterAwaitFirst(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
registry,
|
||||
trace);
|
||||
}));
|
||||
|
||||
assertTimerTraceCrossedThreads(trace);
|
||||
}
|
||||
@@ -0,0 +1,657 @@
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <coroutine>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <gtest/gtest.h>
|
||||
#include <thread>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/co/nonViralTaskNursery.h>
|
||||
#include <spinscale/syncCancelerForAsyncWork.h>
|
||||
|
||||
namespace {
|
||||
|
||||
struct ResumeGate
|
||||
{
|
||||
std::coroutine_handle<> waitingHandle;
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ return false; }
|
||||
|
||||
bool await_suspend(std::coroutine_handle<> callerHandle) noexcept
|
||||
{
|
||||
waitingHandle = callerHandle;
|
||||
return true;
|
||||
}
|
||||
|
||||
void await_resume() const noexcept
|
||||
{}
|
||||
};
|
||||
|
||||
sscl::co::NonViralNonPostingInvoker immediateCompleteCReq(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
co_return;
|
||||
}
|
||||
|
||||
sscl::co::NonViralNonPostingInvoker throwingCompleteCReq(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
throw std::runtime_error("nursery test failure");
|
||||
co_return;
|
||||
}
|
||||
|
||||
sscl::co::NonViralNonPostingInvoker suspendUntilResumeCReq(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
ResumeGate &gate)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
co_await gate;
|
||||
co_return;
|
||||
}
|
||||
|
||||
sscl::co::NonViralNonPostingInvoker cancelAwareSuspendCReq(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::SyncCancelerForAsyncWork &canceler,
|
||||
ResumeGate &gate)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
while (!canceler.isCancellationRequested())
|
||||
{
|
||||
co_await gate;
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
class NonViralTaskNurseryTest : public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
void SetUp() override
|
||||
{
|
||||
nursery.openAdmission();
|
||||
}
|
||||
|
||||
sscl::co::NonViralTaskNursery nursery;
|
||||
ResumeGate gate;
|
||||
ResumeGate gate2;
|
||||
};
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, GetNewSlotLeaseFillCommitRetires)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, UncommittedLeaseReleasesReservation)
|
||||
{
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
(void)lease;
|
||||
}
|
||||
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, CloseAdmissionRejectsNewLeases)
|
||||
{
|
||||
nursery.closeAdmission();
|
||||
|
||||
EXPECT_THROW(nursery.getNewSlotLease(), std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SetOnSettledHookRejectsAfterFillSlot)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
|
||||
EXPECT_THROW(
|
||||
lease.setOnSettledHook([](std::exception_ptr &) {}),
|
||||
std::runtime_error);
|
||||
lease.commit();
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, AsyncAwaitFiresOnDrain)
|
||||
{
|
||||
std::atomic<bool> drained{false};
|
||||
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
nursery.closeAdmission();
|
||||
nursery.asyncAwaitAllSettlements(
|
||||
[&drained]()
|
||||
{
|
||||
drained.store(true, std::memory_order_release);
|
||||
});
|
||||
|
||||
EXPECT_TRUE(drained.load(std::memory_order_acquire));
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, AsyncAwaitRejectsWhenAdmissionOpen)
|
||||
{
|
||||
EXPECT_THROW(nursery.asyncAwaitAllSettlements([]() {}), std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SecondDrainWaiterThrows)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
nursery.closeAdmission();
|
||||
|
||||
bool firstWaiterRegistered = false;
|
||||
nursery.asyncAwaitAllSettlements(
|
||||
[&firstWaiterRegistered]()
|
||||
{
|
||||
firstWaiterRegistered = true;
|
||||
});
|
||||
|
||||
EXPECT_FALSE(firstWaiterRegistered);
|
||||
EXPECT_THROW(
|
||||
nursery.asyncAwaitAllSettlements([]() {}),
|
||||
std::runtime_error);
|
||||
|
||||
if (gate.waitingHandle)
|
||||
{
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SyncAwaitNestedRun)
|
||||
{
|
||||
boost::asio::io_context ioContext;
|
||||
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
std::thread awaitThread(
|
||||
[this, &ioContext]()
|
||||
{
|
||||
nursery.closeAdmission();
|
||||
nursery.syncAwaitAllSettlements(ioContext);
|
||||
});
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
|
||||
ASSERT_TRUE(static_cast<bool>(gate.waitingHandle));
|
||||
gate.waitingHandle.resume();
|
||||
|
||||
awaitThread.join();
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, RequestCancelOnAllDoesNotDestroyInvokers)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.getSyncCanceler().startAcceptingWork();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_EQ(nursery.unsettledCount(), 1U);
|
||||
nursery.requestCancelOnAll();
|
||||
EXPECT_EQ(nursery.unsettledCount(), 1U);
|
||||
|
||||
ASSERT_TRUE(static_cast<bool>(gate.waitingHandle));
|
||||
gate.waitingHandle.resume();
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, RequestCancelOnAllStopsCanceler)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.getSyncCanceler().startAcceptingWork();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return cancelAwareSuspendCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
lease.getSyncCanceler(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
nursery.requestCancelOnAll();
|
||||
EXPECT_TRUE(lease.getSyncCanceler().isCancellationRequested());
|
||||
|
||||
ASSERT_TRUE(static_cast<bool>(gate.waitingHandle));
|
||||
gate.waitingHandle.resume();
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, ExceptionPtrRecorded)
|
||||
{
|
||||
std::exception_ptr captured;
|
||||
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&captured, &lease]()
|
||||
{
|
||||
std::exception_ptr &exceptionStorage =
|
||||
lease.getExceptionStorage();
|
||||
auto invoker = throwingCompleteCReq(
|
||||
exceptionStorage,
|
||||
lease.getCallerLambda());
|
||||
captured = exceptionStorage;
|
||||
return invoker;
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_TRUE(captured != nullptr);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, LaunchSugar)
|
||||
{
|
||||
auto handle = nursery.launch(
|
||||
[](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
|
||||
EXPECT_TRUE(handle == handle);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, LaunchWithOnSettledHook)
|
||||
{
|
||||
std::atomic<bool> hookRan{false};
|
||||
|
||||
nursery.launch(
|
||||
[](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
},
|
||||
[&hookRan](std::exception_ptr &)
|
||||
{
|
||||
hookRan.store(true, std::memory_order_release);
|
||||
});
|
||||
|
||||
EXPECT_TRUE(hookRan.load(std::memory_order_acquire));
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, HandleStability)
|
||||
{
|
||||
auto handle = nursery.launch(
|
||||
[](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
|
||||
sscl::co::NonViralTaskNursery::Slot::Handle copy = handle;
|
||||
EXPECT_TRUE(handle == copy);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, CommitWithoutFillSlotThrows)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
|
||||
EXPECT_THROW(lease.commit(), std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, DoubleCommitThrows)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_THROW(lease.commit(), std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, FillSlotTwiceThrows)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
|
||||
EXPECT_THROW(
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
}),
|
||||
std::runtime_error);
|
||||
|
||||
if (gate.waitingHandle) {
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
|
||||
lease.commit();
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SyncAwaitRejectsWhenAdmissionOpen)
|
||||
{
|
||||
boost::asio::io_context ioContext;
|
||||
|
||||
EXPECT_THROW(
|
||||
nursery.syncAwaitAllSettlements(ioContext),
|
||||
std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SyncAwaitRejectsStoppedIoContext)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
nursery.closeAdmission();
|
||||
|
||||
boost::asio::io_context ioContext;
|
||||
ioContext.stop();
|
||||
|
||||
EXPECT_THROW(
|
||||
nursery.syncAwaitAllSettlements(ioContext),
|
||||
std::runtime_error);
|
||||
|
||||
if (gate.waitingHandle) {
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, SyncAwaitReturnsImmediatelyWhenDrained)
|
||||
{
|
||||
boost::asio::io_context ioContext;
|
||||
|
||||
nursery.closeAdmission();
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
|
||||
nursery.syncAwaitAllSettlements(ioContext);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, UnsettledCountTracksInFlightTasks)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&lease, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_EQ(nursery.unsettledCount(), 1U);
|
||||
EXPECT_FALSE(nursery.allSettled());
|
||||
|
||||
if (gate.waitingHandle) {
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, MultipleTasksDrainTogether)
|
||||
{
|
||||
std::atomic<bool> drained{false};
|
||||
|
||||
auto lease1 = nursery.getNewSlotLease();
|
||||
lease1.fillSlot(
|
||||
[&lease1, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease1.getExceptionStorage(),
|
||||
lease1.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
lease1.commit();
|
||||
|
||||
auto lease2 = nursery.getNewSlotLease();
|
||||
lease2.fillSlot(
|
||||
[&lease2, this]()
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease2.getExceptionStorage(),
|
||||
lease2.getCallerLambda(),
|
||||
gate2);
|
||||
});
|
||||
lease2.commit();
|
||||
|
||||
EXPECT_EQ(nursery.unsettledCount(), 2U);
|
||||
|
||||
nursery.closeAdmission();
|
||||
nursery.asyncAwaitAllSettlements(
|
||||
[&drained]()
|
||||
{
|
||||
drained.store(true, std::memory_order_release);
|
||||
});
|
||||
|
||||
EXPECT_FALSE(drained.load(std::memory_order_acquire));
|
||||
|
||||
if (gate.waitingHandle) {
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_FALSE(drained.load(std::memory_order_acquire));
|
||||
|
||||
if (gate2.waitingHandle) {
|
||||
gate2.waitingHandle.resume();
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_TRUE(drained.load(std::memory_order_acquire));
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, OnSettledHookRunsAtRetirement)
|
||||
{
|
||||
std::atomic<bool> hookRan{false};
|
||||
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.setOnSettledHook(
|
||||
[&hookRan](std::exception_ptr &)
|
||||
{
|
||||
hookRan.store(true, std::memory_order_release);
|
||||
});
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
EXPECT_TRUE(hookRan.load(std::memory_order_acquire));
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, OnSettledHookSeesRetiredSlot)
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.setOnSettledHook(
|
||||
[this](std::exception_ptr &)
|
||||
{
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
});
|
||||
lease.fillSlot(
|
||||
[&lease]()
|
||||
{
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda());
|
||||
});
|
||||
lease.commit();
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, DuplicateRetireThrows)
|
||||
{
|
||||
std::function<void()> completion;
|
||||
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
lease.fillSlot(
|
||||
[&completion, &lease]()
|
||||
{
|
||||
completion = lease.getCallerLambda();
|
||||
return immediateCompleteCReq(
|
||||
lease.getExceptionStorage(),
|
||||
completion);
|
||||
});
|
||||
lease.commit();
|
||||
|
||||
ASSERT_TRUE(static_cast<bool>(completion));
|
||||
EXPECT_THROW(completion(), std::runtime_error);
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, MovedLeaseTransfersReleaseObligation)
|
||||
{
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
{
|
||||
auto lease = nursery.getNewSlotLease();
|
||||
auto movedLease = std::move(lease);
|
||||
(void)movedLease;
|
||||
}
|
||||
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
EXPECT_EQ(nursery.unsettledCount(), 0U);
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, LaunchAssignsDistinctHandles)
|
||||
{
|
||||
auto handle1 = nursery.launch(
|
||||
[this](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate);
|
||||
});
|
||||
|
||||
auto handle2 = nursery.launch(
|
||||
[this](sscl::co::NonViralTaskNursery::Slot::Lease &lease)
|
||||
{
|
||||
return suspendUntilResumeCReq(
|
||||
lease.getExceptionStorage(),
|
||||
lease.getCallerLambda(),
|
||||
gate2);
|
||||
});
|
||||
|
||||
EXPECT_NE(handle1, handle2);
|
||||
EXPECT_EQ(nursery.unsettledCount(), 2U);
|
||||
|
||||
if (gate.waitingHandle) {
|
||||
gate.waitingHandle.resume();
|
||||
}
|
||||
|
||||
if (gate2.waitingHandle) {
|
||||
gate2.waitingHandle.resume();
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10));
|
||||
EXPECT_TRUE(nursery.allSettled());
|
||||
}
|
||||
|
||||
TEST_F(NonViralTaskNurseryTest, AdmissionIsOpenReflectsCloseAndOpen)
|
||||
{
|
||||
EXPECT_TRUE(nursery.admissionIsOpen());
|
||||
|
||||
nursery.closeAdmission();
|
||||
EXPECT_FALSE(nursery.admissionIsOpen());
|
||||
|
||||
nursery.openAdmission();
|
||||
EXPECT_TRUE(nursery.admissionIsOpen());
|
||||
}
|
||||
@@ -0,0 +1,252 @@
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <spinscale/co/postTarget.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
#include <support/threadHarness.h>
|
||||
#include <support/timerAwaiters.h>
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int expectedReturnValue = 42;
|
||||
constexpr int explicitTargetReturnValue = 77;
|
||||
constexpr const char *expectedThrowMessage =
|
||||
"posting cross-thread intentional failure";
|
||||
|
||||
using CallerNonViralInvoker =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLER>;
|
||||
using CalleeNonViralInvoker =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLEE>;
|
||||
|
||||
template <typename T>
|
||||
using CalleeViralInvoker =
|
||||
sscl::tests::RoleViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLEE,
|
||||
T>;
|
||||
|
||||
CalleeViralInvoker<int> returnFromCalleeThread(
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
trace.recordCalleeExecutionThread();
|
||||
trace.recordFinalSuspendThread();
|
||||
co_return expectedReturnValue;
|
||||
}
|
||||
|
||||
CalleeViralInvoker<int> returnFromExplicitTargetThread(
|
||||
sscl::co::ExplicitPostTarget postTarget,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)postTarget;
|
||||
trace.recordCalleeExecutionThread();
|
||||
trace.recordFinalSuspendThread();
|
||||
co_return explicitTargetReturnValue;
|
||||
}
|
||||
|
||||
CalleeViralInvoker<int> throwFromCalleeThread(
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
constexpr int throwDelayMs = 1;
|
||||
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
throwDelayMs};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
trace.recordCalleeExecutionThread();
|
||||
trace.recordFinalSuspendThread();
|
||||
throw std::runtime_error(expectedThrowMessage);
|
||||
}
|
||||
|
||||
CallerNonViralInvoker awaitCalleeDriver(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
const int value = co_await returnFromCalleeThread(trace);
|
||||
trace.recordAwaitResumeThread();
|
||||
|
||||
if (value != expectedReturnValue) {
|
||||
throw std::runtime_error("Unexpected callee return value");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerNonViralInvoker awaitExplicitTargetDriver(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::ExplicitPostTarget postTarget{
|
||||
sscl::tests::ThreadRegistry::ioContext(
|
||||
sscl::tests::PostingThreadRole::ALTERNATE)};
|
||||
const int value = co_await returnFromExplicitTargetThread(
|
||||
postTarget,
|
||||
trace);
|
||||
trace.recordAwaitResumeThread();
|
||||
|
||||
if (value != explicitTargetReturnValue) {
|
||||
throw std::runtime_error("Unexpected explicit-target return value");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerNonViralInvoker awaitThrowingCalleeDriver(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
try {
|
||||
(void)co_await throwFromCalleeThread(trace);
|
||||
throw std::runtime_error("Expected callee exception");
|
||||
}
|
||||
catch (const std::runtime_error &runtimeError) {
|
||||
trace.recordAwaitResumeThread();
|
||||
if (std::string(runtimeError.what()) != expectedThrowMessage) {
|
||||
throw std::runtime_error("Unexpected callee exception message");
|
||||
}
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CalleeNonViralInvoker nonViralCalleeCompletesToCaller(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion,
|
||||
sscl::tests::CrossThreadTrace &trace)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
trace.recordCalleeExecutionThread();
|
||||
trace.recordFinalSuspendThread();
|
||||
co_return;
|
||||
}
|
||||
|
||||
class PostingCrossThreadTest
|
||||
: public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
TEST_F(PostingCrossThreadTest, ViralAwaitPostsCalleeAndResumesCaller)
|
||||
{
|
||||
sscl::tests::CrossThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
trace.recordConstructionThread();
|
||||
return awaitCalleeDriver(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
trace);
|
||||
}));
|
||||
|
||||
EXPECT_EQ(trace.constructionThread(), threads.caller().osThreadId());
|
||||
EXPECT_EQ(trace.calleeExecutionThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.finalSuspendThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.awaitResumeThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), trace.awaitResumeThread());
|
||||
}
|
||||
|
||||
TEST_F(PostingCrossThreadTest, NonViralCompletionPostsBackToCaller)
|
||||
{
|
||||
sscl::tests::CrossThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
trace.recordConstructionThread();
|
||||
return nonViralCalleeCompletesToCaller(
|
||||
exceptionPtr,
|
||||
[&trace, completion = std::move(completion)]() mutable
|
||||
{
|
||||
trace.recordCompletionCallbackThread();
|
||||
completion();
|
||||
},
|
||||
trace);
|
||||
}));
|
||||
|
||||
EXPECT_EQ(trace.constructionThread(), threads.caller().osThreadId());
|
||||
EXPECT_EQ(trace.calleeExecutionThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.finalSuspendThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.completionCallbackThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), trace.completionCallbackThread());
|
||||
}
|
||||
|
||||
TEST_F(PostingCrossThreadTest, ExplicitPostTargetRoutesCalleeExecution)
|
||||
{
|
||||
sscl::tests::CrossThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
trace.recordConstructionThread();
|
||||
return awaitExplicitTargetDriver(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
trace);
|
||||
}));
|
||||
|
||||
EXPECT_EQ(trace.constructionThread(), threads.caller().osThreadId());
|
||||
EXPECT_EQ(trace.calleeExecutionThread(), threads.alternate().osThreadId());
|
||||
EXPECT_EQ(trace.awaitResumeThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), threads.callee().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), trace.awaitResumeThread());
|
||||
}
|
||||
|
||||
TEST_F(PostingCrossThreadTest, CalleeExceptionIsObservedOnCallerThread)
|
||||
{
|
||||
sscl::tests::CrossThreadTrace trace;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[&trace](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
trace.recordConstructionThread();
|
||||
return awaitThrowingCalleeDriver(
|
||||
exceptionPtr,
|
||||
std::move(completion),
|
||||
trace);
|
||||
}));
|
||||
|
||||
EXPECT_EQ(trace.constructionThread(), threads.caller().osThreadId());
|
||||
EXPECT_EQ(trace.calleeExecutionThread(), threads.callee().osThreadId());
|
||||
EXPECT_EQ(trace.awaitResumeThread(), threads.caller().osThreadId());
|
||||
EXPECT_NE(trace.calleeExecutionThread(), trace.awaitResumeThread());
|
||||
}
|
||||
@@ -0,0 +1,633 @@
|
||||
#include <chrono>
|
||||
#include <exception>
|
||||
#include <memory>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <utility>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/system/error_code.hpp>
|
||||
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/co/group.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
#include <support/coroutineDriver.h>
|
||||
#include <support/groupAssertions.h>
|
||||
#include <support/threadHarness.h>
|
||||
#include <support/timerAwaiters.h>
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr int delayShortMs = 50;
|
||||
constexpr int expectedNonStdThrowValue = 42;
|
||||
constexpr const char *expectedThrowMessage =
|
||||
"viral_non_posting_test intentional failure";
|
||||
|
||||
template <typename T>
|
||||
using TestInvoker = sscl::co::ViralNonPostingInvoker<T>;
|
||||
|
||||
using TestDriver = TestInvoker<int>;
|
||||
using TestVoidDriver = TestInvoker<void>;
|
||||
using CallerPostingDriver =
|
||||
sscl::tests::RoleNonViralPostingInvoker<
|
||||
sscl::tests::PostingThreadRole::CALLER>;
|
||||
|
||||
struct ThreadIdPair
|
||||
{
|
||||
std::thread::id callerIdAtCoAwait;
|
||||
std::thread::id calleeId;
|
||||
};
|
||||
|
||||
struct MoveCountedInt
|
||||
{
|
||||
std::shared_ptr<std::size_t> moveCount;
|
||||
int value = 0;
|
||||
|
||||
MoveCountedInt() = default;
|
||||
|
||||
MoveCountedInt(
|
||||
std::shared_ptr<std::size_t> moveCountIn,
|
||||
int valueIn)
|
||||
: moveCount(std::move(moveCountIn)),
|
||||
value(valueIn)
|
||||
{}
|
||||
|
||||
MoveCountedInt(const MoveCountedInt &) = delete;
|
||||
MoveCountedInt &operator=(const MoveCountedInt &) = delete;
|
||||
|
||||
MoveCountedInt(MoveCountedInt &&other) noexcept
|
||||
: moveCount(std::exchange(other.moveCount, {})),
|
||||
value(other.value)
|
||||
{
|
||||
if (moveCount) {
|
||||
++(*moveCount);
|
||||
}
|
||||
}
|
||||
|
||||
MoveCountedInt &operator=(MoveCountedInt &&other) noexcept
|
||||
{
|
||||
moveCount = std::exchange(other.moveCount, {});
|
||||
value = other.value;
|
||||
return *this;
|
||||
}
|
||||
};
|
||||
|
||||
template <typename T>
|
||||
struct CountingAwaiter
|
||||
{
|
||||
TestInvoker<T> &invoker;
|
||||
std::size_t &awaitResumeCallCount;
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ return invoker.await_ready(); }
|
||||
|
||||
template <typename CallerPromise>
|
||||
bool await_suspend(
|
||||
std::coroutine_handle<CallerPromise> callerSchedHandle) noexcept
|
||||
{ return invoker.await_suspend(callerSchedHandle); }
|
||||
|
||||
auto await_resume()
|
||||
{
|
||||
++awaitResumeCallCount;
|
||||
return invoker.await_resume();
|
||||
}
|
||||
};
|
||||
|
||||
class ViralNonPostingTest
|
||||
: public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
void TearDown() override
|
||||
{
|
||||
ioContext.restart();
|
||||
}
|
||||
|
||||
int runDriver(TestDriver &driver)
|
||||
{
|
||||
return sscl::tests::CoroutineDriver::pumpUntilIdleAndReturnValue(
|
||||
ioContext,
|
||||
driver);
|
||||
}
|
||||
|
||||
int finishDriver(TestDriver &driver)
|
||||
{
|
||||
return sscl::tests::CoroutineDriver::completedReturnValue(driver);
|
||||
}
|
||||
|
||||
boost::asio::io_context ioContext;
|
||||
};
|
||||
|
||||
TestInvoker<int> returnLabelImmediately(int label)
|
||||
{
|
||||
co_return label;
|
||||
}
|
||||
|
||||
TestInvoker<int> waitAndReturnLabel(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
ioContext,
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
co_return delayMilliseconds;
|
||||
}
|
||||
|
||||
TestVoidDriver voidReturnImmediately()
|
||||
{
|
||||
co_return;
|
||||
}
|
||||
|
||||
TestVoidDriver voidMemberAfterDelay(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
ioContext,
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
co_return;
|
||||
}
|
||||
|
||||
TestInvoker<int> throwRuntimeErrorImmediately()
|
||||
{
|
||||
throw std::runtime_error(expectedThrowMessage);
|
||||
}
|
||||
|
||||
TestInvoker<int> throwIntImmediately()
|
||||
{
|
||||
throw expectedNonStdThrowValue;
|
||||
}
|
||||
|
||||
TestInvoker<ThreadIdPair> recordThreadIdsAtReturn()
|
||||
{
|
||||
ThreadIdPair pair;
|
||||
pair.calleeId = std::this_thread::get_id();
|
||||
co_return pair;
|
||||
}
|
||||
|
||||
TestInvoker<ThreadIdPair> recordThreadIdsAfterDelay(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
{
|
||||
const boost::system::error_code waitError =
|
||||
co_await sscl::tests::DeadlineTimerAwaiter{
|
||||
ioContext,
|
||||
delayMilliseconds};
|
||||
sscl::tests::throwIfTimerWaitFailed(waitError);
|
||||
|
||||
ThreadIdPair pair;
|
||||
pair.calleeId = std::this_thread::get_id();
|
||||
co_return pair;
|
||||
}
|
||||
|
||||
TestInvoker<MoveCountedInt> returnMoveCountedInt(
|
||||
std::shared_ptr<std::size_t> moveCount,
|
||||
int value)
|
||||
{
|
||||
co_return MoveCountedInt{std::move(moveCount), value};
|
||||
}
|
||||
|
||||
TestInvoker<int> innerDelayedCoAwait(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
{
|
||||
const int label = co_await waitAndReturnLabel(
|
||||
ioContext,
|
||||
delayMilliseconds);
|
||||
co_return label;
|
||||
}
|
||||
|
||||
TestInvoker<int> nestedNonPostingSum(int left, int right)
|
||||
{
|
||||
const int leftSum = co_await returnLabelImmediately(left);
|
||||
const int rightSum = co_await returnLabelImmediately(right);
|
||||
co_return leftSum + rightSum;
|
||||
}
|
||||
|
||||
TestInvoker<int> outerCoAwaitingDelayedInner(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
{
|
||||
const int innerLabel = co_await innerDelayedCoAwait(
|
||||
ioContext,
|
||||
delayMilliseconds);
|
||||
co_return innerLabel + 1;
|
||||
}
|
||||
|
||||
TestDriver testImmediateReturnFastPath()
|
||||
{
|
||||
const int value = co_await returnLabelImmediately(42);
|
||||
if (value != 42) {
|
||||
throw std::runtime_error("immediateReturnFastPath value mismatch");
|
||||
}
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testAllCompleteBeforeCoAwait()
|
||||
{
|
||||
TestInvoker<int> invokerTen = returnLabelImmediately(10);
|
||||
TestInvoker<int> invokerTwenty = returnLabelImmediately(20);
|
||||
TestInvoker<int> invokerThirty = returnLabelImmediately(30);
|
||||
|
||||
const int valueTen = co_await invokerTen;
|
||||
const int valueTwenty = co_await invokerTwenty;
|
||||
const int valueThirty = co_await invokerThirty;
|
||||
|
||||
if (valueTen != 10 || valueTwenty != 20 || valueThirty != 30) {
|
||||
throw std::runtime_error("allCompleteBeforeCoAwait label mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testCallerSuspendsThenResumes(boost::asio::io_context &ioContext)
|
||||
{
|
||||
const int value = co_await waitAndReturnLabel(ioContext, delayShortMs);
|
||||
if (value != delayShortMs) {
|
||||
throw std::runtime_error("callerSuspendsThenResumes label mismatch");
|
||||
}
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testMixedImmediateAndDelayedInSequence(
|
||||
boost::asio::io_context &ioContext)
|
||||
{
|
||||
const int immediate = co_await returnLabelImmediately(7);
|
||||
const int delayed = co_await waitAndReturnLabel(ioContext, delayShortMs);
|
||||
|
||||
if (immediate != 7 || delayed != delayShortMs) {
|
||||
throw std::runtime_error("mixedImmediateAndDelayed label mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testAwaitResumeCalledOnceFastPath()
|
||||
{
|
||||
std::size_t awaitResumeCallCount = 0;
|
||||
TestInvoker<int> invoker = returnLabelImmediately(42);
|
||||
const int value = co_await CountingAwaiter<int>{
|
||||
invoker,
|
||||
awaitResumeCallCount};
|
||||
|
||||
if (value != 42 || awaitResumeCallCount != 1) {
|
||||
throw std::runtime_error("fast path await_resume count mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testAwaitResumeCalledOnceSlowPath(
|
||||
boost::asio::io_context &ioContext)
|
||||
{
|
||||
std::size_t awaitResumeCallCount = 0;
|
||||
TestInvoker<int> invoker = waitAndReturnLabel(ioContext, delayShortMs);
|
||||
const int value = co_await CountingAwaiter<int>{
|
||||
invoker,
|
||||
awaitResumeCallCount};
|
||||
|
||||
if (value != delayShortMs || awaitResumeCallCount != 1) {
|
||||
throw std::runtime_error("slow path await_resume count mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testAwaitResumeCalledOnceNested(
|
||||
boost::asio::io_context &ioContext)
|
||||
{
|
||||
std::size_t awaitResumeCallCount = 0;
|
||||
TestInvoker<int> inner = innerDelayedCoAwait(ioContext, delayShortMs);
|
||||
const int value = co_await CountingAwaiter<int>{
|
||||
inner,
|
||||
awaitResumeCallCount};
|
||||
|
||||
if (value != delayShortMs || awaitResumeCallCount != 1) {
|
||||
throw std::runtime_error("nested await_resume count mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testMoveCountedReturnNotDoubleMoved()
|
||||
{
|
||||
auto moveCount = std::make_shared<std::size_t>(0);
|
||||
TestInvoker<MoveCountedInt> invoker =
|
||||
returnMoveCountedInt(moveCount, 99);
|
||||
MoveCountedInt result = co_await invoker;
|
||||
|
||||
if (result.value != 99) {
|
||||
throw std::runtime_error("move counted value mismatch");
|
||||
}
|
||||
if (*moveCount > 2 || *moveCount < 1) {
|
||||
throw std::runtime_error("move counted return move-count mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testVoidReturnCompletes()
|
||||
{
|
||||
co_await voidReturnImmediately();
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testReturnValuesReadableBeforeDestroy()
|
||||
{
|
||||
TestInvoker<int> invoker = returnLabelImmediately(55);
|
||||
(void)co_await invoker;
|
||||
|
||||
if (invoker.completedReturnValues().myReturnValue != 55) {
|
||||
throw std::runtime_error("completed return value not readable");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testExceptionRethrowsOnCoAwait()
|
||||
{
|
||||
try {
|
||||
(void)co_await throwRuntimeErrorImmediately();
|
||||
throw std::runtime_error("expected runtime_error");
|
||||
}
|
||||
catch (const std::runtime_error &runtimeError) {
|
||||
if (std::string(runtimeError.what()) != expectedThrowMessage) {
|
||||
throw std::runtime_error("unexpected runtime_error message");
|
||||
}
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testNonStdExceptionRethrows()
|
||||
{
|
||||
try {
|
||||
(void)co_await throwIntImmediately();
|
||||
throw std::runtime_error("expected int exception");
|
||||
}
|
||||
catch (int caughtValue) {
|
||||
if (caughtValue != expectedNonStdThrowValue) {
|
||||
throw std::runtime_error("unexpected int exception value");
|
||||
}
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testCalleeRunsOnCallerThread()
|
||||
{
|
||||
const std::thread::id callerThreadId = std::this_thread::get_id();
|
||||
const ThreadIdPair pair = co_await recordThreadIdsAtReturn();
|
||||
|
||||
if (pair.calleeId != callerThreadId) {
|
||||
throw std::runtime_error("callee thread mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testDelayedCalleeStillOnCallerThread(
|
||||
boost::asio::io_context &ioContext)
|
||||
{
|
||||
const std::thread::id callerThreadId = std::this_thread::get_id();
|
||||
const ThreadIdPair pair =
|
||||
co_await recordThreadIdsAfterDelay(ioContext, delayShortMs);
|
||||
|
||||
if (pair.calleeId != callerThreadId) {
|
||||
throw std::runtime_error("delayed callee thread mismatch");
|
||||
}
|
||||
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testNestedNonPostingCoAwait()
|
||||
{
|
||||
const int sum = co_await nestedNonPostingSum(10, 32);
|
||||
if (sum != 42) {
|
||||
throw std::runtime_error("nested sum mismatch");
|
||||
}
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
TestDriver testNestedInnerSuspension(boost::asio::io_context &ioContext)
|
||||
{
|
||||
const int value = co_await outerCoAwaitingDelayedInner(
|
||||
ioContext,
|
||||
delayShortMs);
|
||||
if (value != delayShortMs + 1) {
|
||||
throw std::runtime_error("nested inner suspension value mismatch");
|
||||
}
|
||||
co_return 0;
|
||||
}
|
||||
|
||||
CallerPostingDriver nonPostingVoidMemberInGroupDriver(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
TestVoidDriver voidInvoker = voidMemberAfterDelay(
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayShortMs);
|
||||
group.add(voidInvoker);
|
||||
|
||||
auto &allDescriptors = co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
if (allDescriptors.size() != 1) {
|
||||
throw std::runtime_error("voidMemberInGroup count mismatch");
|
||||
}
|
||||
|
||||
sscl::tests::requireCompletedSettlement(allDescriptors[0]);
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
CallerPostingDriver nonPostingGroupMixedImmediateAndDelayedDriver(
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
(void)exceptionPtr;
|
||||
(void)completion;
|
||||
|
||||
sscl::co::Group group;
|
||||
TestInvoker<int> immediateInvoker = returnLabelImmediately(11);
|
||||
TestInvoker<int> delayedInvoker = waitAndReturnLabel(
|
||||
sscl::ComponentThread::getSelf()->getIoContext(),
|
||||
delayShortMs);
|
||||
|
||||
group.add(immediateInvoker);
|
||||
group.add(delayedInvoker);
|
||||
|
||||
auto &allDescriptors = co_await group.getAwaitAllSettlementsInvoker();
|
||||
|
||||
if (allDescriptors.size() != 2) {
|
||||
throw std::runtime_error("groupMixedImmediateAndDelayed count mismatch");
|
||||
}
|
||||
|
||||
bool sawImmediate = false;
|
||||
bool sawDelayed = false;
|
||||
|
||||
for (auto &descriptor : allDescriptors) {
|
||||
sscl::tests::requireCompletedSettlement(descriptor);
|
||||
const int label = sscl::tests::completedIntValue(
|
||||
descriptor.invokerAs<TestInvoker<int>>());
|
||||
if (label == 11) {
|
||||
sawImmediate = true;
|
||||
}
|
||||
else if (label == delayShortMs) {
|
||||
sawDelayed = true;
|
||||
}
|
||||
else {
|
||||
throw std::runtime_error(
|
||||
"groupMixedImmediateAndDelayed unexpected label");
|
||||
}
|
||||
}
|
||||
|
||||
if (!sawImmediate || !sawDelayed) {
|
||||
throw std::runtime_error(
|
||||
"groupMixedImmediateAndDelayed missing expected label");
|
||||
}
|
||||
|
||||
co_return;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
TEST_F(ViralNonPostingTest, ImmediateReturnFastPath)
|
||||
{
|
||||
TestDriver driver = testImmediateReturnFastPath();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, AllCompleteBeforeCoAwait)
|
||||
{
|
||||
TestDriver driver = testAllCompleteBeforeCoAwait();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, CallerSuspendsThenResumes)
|
||||
{
|
||||
TestDriver driver = testCallerSuspendsThenResumes(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, MixedImmediateAndDelayedInSequence)
|
||||
{
|
||||
TestDriver driver = testMixedImmediateAndDelayedInSequence(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, AwaitResumeCalledOnceFastPath)
|
||||
{
|
||||
TestDriver driver = testAwaitResumeCalledOnceFastPath();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, AwaitResumeCalledOnceSlowPath)
|
||||
{
|
||||
TestDriver driver = testAwaitResumeCalledOnceSlowPath(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, AwaitResumeCalledOnceNested)
|
||||
{
|
||||
TestDriver driver = testAwaitResumeCalledOnceNested(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, MoveCountedReturnNotDoubleMoved)
|
||||
{
|
||||
TestDriver driver = testMoveCountedReturnNotDoubleMoved();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, VoidReturnCompletes)
|
||||
{
|
||||
TestDriver driver = testVoidReturnCompletes();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, ReturnValuesReadableBeforeDestroy)
|
||||
{
|
||||
TestDriver driver = testReturnValuesReadableBeforeDestroy();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, ExceptionRethrowsOnCoAwait)
|
||||
{
|
||||
TestDriver driver = testExceptionRethrowsOnCoAwait();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, NonStdExceptionRethrows)
|
||||
{
|
||||
TestDriver driver = testNonStdExceptionRethrows();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, CalleeRunsOnCallerThread)
|
||||
{
|
||||
TestDriver driver = testCalleeRunsOnCallerThread();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, DelayedCalleeStillOnCallerThread)
|
||||
{
|
||||
TestDriver driver = testDelayedCalleeStillOnCallerThread(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, NestedNonPostingCoAwait)
|
||||
{
|
||||
TestDriver driver = testNestedNonPostingCoAwait();
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(finishDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST_F(ViralNonPostingTest, NestedInnerSuspension)
|
||||
{
|
||||
TestDriver driver = testNestedInnerSuspension(ioContext);
|
||||
EXPECT_NO_THROW({ EXPECT_EQ(runDriver(driver), 0); });
|
||||
}
|
||||
|
||||
TEST(ViralNonPostingGroupIntegrationTest, VoidMemberInGroup)
|
||||
{
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return nonPostingVoidMemberInGroupDriver(
|
||||
exceptionPtr,
|
||||
std::move(completion));
|
||||
}));
|
||||
}
|
||||
|
||||
TEST(ViralNonPostingGroupIntegrationTest, MixedImmediateAndDelayedInGroup)
|
||||
{
|
||||
sscl::tests::PostingThreadSet threads;
|
||||
|
||||
ASSERT_NO_THROW(
|
||||
sscl::tests::runNonViralPostingTask(
|
||||
threads.caller(),
|
||||
[](
|
||||
std::exception_ptr &exceptionPtr,
|
||||
std::function<void()> completion)
|
||||
{
|
||||
return nonPostingGroupMixedImmediateAndDelayedDriver(
|
||||
exceptionPtr,
|
||||
std::move(completion));
|
||||
}));
|
||||
}
|
||||
@@ -0,0 +1,371 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <spinscale/cps/qutex.h>
|
||||
#include <spinscale/cps/lockerAndInvokerBase.h>
|
||||
#include <memory>
|
||||
#include <stdexcept>
|
||||
#include <thread>
|
||||
#include <chrono>
|
||||
#include <vector>
|
||||
|
||||
namespace smo {
|
||||
|
||||
// Mock implementation of LockerAndInvokerBase for testing
|
||||
class MockLockerAndInvoker : public sscl::cps::LockerAndInvokerBase {
|
||||
public:
|
||||
explicit MockLockerAndInvoker(const void* addr)
|
||||
: sscl::cps::LockerAndInvokerBase(addr), awakened(false) {}
|
||||
|
||||
bool awakened;
|
||||
mutable sscl::cps::Qutex* registeredQutex = nullptr;
|
||||
mutable sscl::cps::LockerAndInvokerBase::List::iterator queueIterator;
|
||||
|
||||
sscl::cps::LockerAndInvokerBase::List::iterator
|
||||
getLockvokerIteratorForQutex(sscl::cps::Qutex& qutex) const override
|
||||
{
|
||||
registeredQutex = &qutex;
|
||||
|
||||
for (auto it = qutex.queue.begin(); it != qutex.queue.end(); ++it)
|
||||
{
|
||||
if ((**it) == *this)
|
||||
{
|
||||
queueIterator = it;
|
||||
return it;
|
||||
}
|
||||
}
|
||||
|
||||
throw std::runtime_error(
|
||||
"MockLockerAndInvoker: not registered in qutex queue");
|
||||
}
|
||||
|
||||
void awaken(bool forceAwaken = false) override
|
||||
{
|
||||
(void)forceAwaken;
|
||||
awakened = true;
|
||||
}
|
||||
|
||||
size_t getLockSetSize() const override
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
|
||||
sscl::cps::Qutex& getLockAt(size_t index) const override
|
||||
{
|
||||
if (index != 0 || registeredQutex == nullptr)
|
||||
{
|
||||
throw std::runtime_error(
|
||||
"MockLockerAndInvoker: invalid lock index or no registered qutex");
|
||||
}
|
||||
|
||||
return *registeredQutex;
|
||||
}
|
||||
};
|
||||
|
||||
class QutexTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
// Create mock lockvokers with unique addresses
|
||||
mock1 = std::make_shared<MockLockerAndInvoker>(&addr1);
|
||||
mock2 = std::make_shared<MockLockerAndInvoker>(&addr2);
|
||||
mock3 = std::make_shared<MockLockerAndInvoker>(&addr3);
|
||||
mock4 = std::make_shared<MockLockerAndInvoker>(&addr4);
|
||||
mock5 = std::make_shared<MockLockerAndInvoker>(&addr5);
|
||||
}
|
||||
|
||||
void TearDown() override {
|
||||
// Clean up
|
||||
}
|
||||
|
||||
sscl::cps::Qutex qutex{"test-qutex"};
|
||||
std::shared_ptr<MockLockerAndInvoker> mock1, mock2, mock3, mock4, mock5;
|
||||
|
||||
// Unique addresses for testing
|
||||
int addr1 = 1;
|
||||
int addr2 = 2;
|
||||
int addr3 = 3;
|
||||
int addr4 = 4;
|
||||
int addr5 = 5;
|
||||
};
|
||||
|
||||
// Test basic queue registration and unregistration
|
||||
TEST_F(QutexTest, QueueRegistrationAndUnregistration) {
|
||||
// Register mock1 in queue
|
||||
auto it1 = qutex.registerInQueue(mock1);
|
||||
EXPECT_EQ(qutex.queue.size(), 1);
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
|
||||
// Register mock2 in queue
|
||||
auto it2 = qutex.registerInQueue(mock2);
|
||||
EXPECT_EQ(qutex.queue.size(), 2);
|
||||
|
||||
// Unregister mock1
|
||||
qutex.unregisterFromQueue(it1);
|
||||
EXPECT_EQ(qutex.queue.size(), 1);
|
||||
|
||||
// Unregister mock2
|
||||
qutex.unregisterFromQueue(it2);
|
||||
EXPECT_EQ(qutex.queue.size(), 0);
|
||||
}
|
||||
|
||||
// Test single lock acquisition when queue is empty
|
||||
TEST_F(QutexTest, SingleLockAcquisitionEmptyQueue) {
|
||||
// Register mock1
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
|
||||
// Try to acquire with nRequiredLocks = 1
|
||||
bool acquired = qutex.tryAcquire(*mock1, 1);
|
||||
EXPECT_TRUE(acquired);
|
||||
EXPECT_TRUE(qutex.isOwned);
|
||||
}
|
||||
|
||||
// Test single lock acquisition when at front of queue
|
||||
TEST_F(QutexTest, SingleLockAcquisitionAtFront) {
|
||||
// Register multiple lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
(void)qutex.registerInQueue(mock3);
|
||||
|
||||
// mock1 should be at front, mock3 at back
|
||||
EXPECT_EQ(qutex.queue.front().get(), mock1.get());
|
||||
EXPECT_EQ(qutex.queue.back().get(), mock3.get());
|
||||
|
||||
// mock1 (at front) should succeed
|
||||
bool acquired = qutex.tryAcquire(*mock1, 1);
|
||||
EXPECT_TRUE(acquired);
|
||||
EXPECT_TRUE(qutex.isOwned);
|
||||
|
||||
// mock2 (not at front) should fail
|
||||
qutex.isOwned = false; // Reset for testing
|
||||
bool acquired2 = qutex.tryAcquire(*mock2, 1);
|
||||
EXPECT_FALSE(acquired2);
|
||||
}
|
||||
|
||||
// Test single lock acquisition failure when not at front
|
||||
TEST_F(QutexTest, SingleLockAcquisitionNotAtFront) {
|
||||
// Register multiple lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
|
||||
// mock2 (not at front) should fail
|
||||
bool acquired = qutex.tryAcquire(*mock2, 1);
|
||||
EXPECT_FALSE(acquired);
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
}
|
||||
|
||||
// Test multi-lock acquisition (nRequiredLocks > 1)
|
||||
TEST_F(QutexTest, MultiLockAcquisition) {
|
||||
// Register 4 lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
(void)qutex.registerInQueue(mock3);
|
||||
(void)qutex.registerInQueue(mock4);
|
||||
|
||||
// For nRequiredLocks = 2, need to be in top 50% (top 2 out of 4)
|
||||
// mock1 (position 1) should succeed
|
||||
bool acquired1 = qutex.tryAcquire(*mock1, 2);
|
||||
EXPECT_TRUE(acquired1);
|
||||
|
||||
// Reset for next test
|
||||
qutex.isOwned = false;
|
||||
|
||||
// mock2 (position 2) should succeed
|
||||
bool acquired2 = qutex.tryAcquire(*mock2, 2);
|
||||
EXPECT_TRUE(acquired2);
|
||||
|
||||
// Reset for next test
|
||||
qutex.isOwned = false;
|
||||
|
||||
// mock3 (position 3) should fail (in bottom 50%)
|
||||
bool acquired3 = qutex.tryAcquire(*mock3, 2);
|
||||
EXPECT_FALSE(acquired3);
|
||||
|
||||
// Reset for next test
|
||||
qutex.isOwned = false;
|
||||
|
||||
// mock4 (position 4) should fail (in bottom 50%)
|
||||
bool acquired4 = qutex.tryAcquire(*mock4, 2);
|
||||
EXPECT_FALSE(acquired4);
|
||||
}
|
||||
|
||||
// Test multi-lock acquisition with 3 required locks
|
||||
TEST_F(QutexTest, MultiLockAcquisitionThreeLocks) {
|
||||
// Register 6 lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
(void)qutex.registerInQueue(mock3);
|
||||
(void)qutex.registerInQueue(mock4);
|
||||
(void)qutex.registerInQueue(mock5);
|
||||
|
||||
// Create one more mock
|
||||
int addr6 = 6;
|
||||
auto mock6 = std::make_shared<MockLockerAndInvoker>(&addr6);
|
||||
(void)qutex.registerInQueue(mock6);
|
||||
|
||||
// For nRequiredLocks = 3, need to be in top 66% (top 4 out of 6)
|
||||
// Positions 1, 2, 3, 4 should succeed
|
||||
// Positions 5, 6 should fail
|
||||
|
||||
bool acquired1 = qutex.tryAcquire(*mock1, 3);
|
||||
EXPECT_TRUE(acquired1);
|
||||
qutex.isOwned = false;
|
||||
|
||||
bool acquired2 = qutex.tryAcquire(*mock2, 3);
|
||||
EXPECT_TRUE(acquired2);
|
||||
qutex.isOwned = false;
|
||||
|
||||
bool acquired3 = qutex.tryAcquire(*mock3, 3);
|
||||
EXPECT_TRUE(acquired3);
|
||||
qutex.isOwned = false;
|
||||
|
||||
bool acquired4 = qutex.tryAcquire(*mock4, 3);
|
||||
EXPECT_TRUE(acquired4);
|
||||
qutex.isOwned = false;
|
||||
|
||||
bool acquired5 = qutex.tryAcquire(*mock5, 3);
|
||||
EXPECT_FALSE(acquired5);
|
||||
|
||||
qutex.isOwned = false;
|
||||
bool acquired6 = qutex.tryAcquire(*mock6, 3);
|
||||
EXPECT_FALSE(acquired6);
|
||||
}
|
||||
|
||||
// Test acquisition failure when already owned
|
||||
TEST_F(QutexTest, AcquisitionFailureWhenOwned) {
|
||||
// Register mock1
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
|
||||
// Manually set as owned
|
||||
qutex.isOwned = true;
|
||||
|
||||
// Try to acquire should fail
|
||||
bool acquired = qutex.tryAcquire(*mock1, 1);
|
||||
EXPECT_FALSE(acquired);
|
||||
EXPECT_TRUE(qutex.isOwned);
|
||||
}
|
||||
|
||||
// Test backoff with single item (should not rotate)
|
||||
TEST_F(QutexTest, BackoffSingleItem) {
|
||||
// Register only one lockvoker
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
|
||||
// Set as owned first
|
||||
qutex.isOwned = true;
|
||||
|
||||
// nRequiredLocks > 1 avoids the "front item with nRequiredLocks==1" guard
|
||||
mock1->awakened = false;
|
||||
qutex.backoff(*mock1, 2);
|
||||
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
EXPECT_EQ(qutex.queue.size(), 1u);
|
||||
// Should not awaken since there's only one item
|
||||
EXPECT_FALSE(mock1->awakened);
|
||||
}
|
||||
|
||||
// Test backoff with multiple items and rotation
|
||||
TEST_F(QutexTest, BackoffWithRotation) {
|
||||
// Register multiple lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
(void)qutex.registerInQueue(mock3);
|
||||
|
||||
// Set as owned first
|
||||
qutex.isOwned = true;
|
||||
|
||||
// mock1 should be at front initially
|
||||
EXPECT_EQ(qutex.queue.front().get(), mock1.get());
|
||||
|
||||
// Backoff from mock1 (at front) with nRequiredLocks = 2
|
||||
mock2->awakened = false;
|
||||
qutex.backoff(*mock1, 2);
|
||||
|
||||
// mock1 should have been rotated to position 2
|
||||
// mock2 should now be at front
|
||||
EXPECT_EQ(qutex.queue.front().get(), mock2.get());
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
|
||||
// mock2 should have been awakened
|
||||
EXPECT_TRUE(mock2->awakened);
|
||||
}
|
||||
|
||||
// Test backoff with rotation to back when queue smaller than nRequiredLocks
|
||||
TEST_F(QutexTest, BackoffRotationToBack) {
|
||||
// Register only 2 lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
|
||||
// Set as owned first
|
||||
qutex.isOwned = true;
|
||||
|
||||
// mock1 should be at front initially
|
||||
EXPECT_EQ(qutex.queue.front().get(), mock1.get());
|
||||
EXPECT_EQ(qutex.queue.back().get(), mock2.get());
|
||||
|
||||
// Backoff from mock1 with nRequiredLocks = 5 (larger than queue size)
|
||||
mock2->awakened = false;
|
||||
qutex.backoff(*mock1, 5);
|
||||
|
||||
// mock1 should have been moved to the back
|
||||
EXPECT_EQ(qutex.queue.front().get(), mock2.get());
|
||||
EXPECT_EQ(qutex.queue.back().get(), mock1.get());
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
|
||||
// mock2 should have been awakened
|
||||
EXPECT_TRUE(mock2->awakened);
|
||||
}
|
||||
|
||||
// Test release functionality
|
||||
TEST_F(QutexTest, Release) {
|
||||
// Register multiple lockvokers
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
(void)qutex.registerInQueue(mock2);
|
||||
|
||||
ASSERT_TRUE(qutex.tryAcquire(*mock1, 1));
|
||||
|
||||
// Release should set isOwned to false and awaken front item
|
||||
mock1->awakened = false;
|
||||
qutex.release();
|
||||
|
||||
EXPECT_FALSE(qutex.isOwned);
|
||||
EXPECT_TRUE(mock1->awakened);
|
||||
}
|
||||
|
||||
// Test release without a prior acquire is rejected
|
||||
TEST_F(QutexTest, ReleaseWithoutAcquireThrows) {
|
||||
EXPECT_THROW(qutex.release(), std::runtime_error);
|
||||
EXPECT_TRUE(qutex.queue.empty());
|
||||
}
|
||||
|
||||
// Test exception when trying to acquire from empty queue
|
||||
TEST_F(QutexTest, ExceptionOnEmptyQueueAcquisition) {
|
||||
// Don't register any lockvokers
|
||||
EXPECT_THROW(qutex.tryAcquire(*mock1, 1), std::runtime_error);
|
||||
}
|
||||
|
||||
// Test exception when backoff called on empty queue
|
||||
TEST_F(QutexTest, ExceptionOnEmptyQueueBackoff) {
|
||||
// Don't register any lockvokers
|
||||
EXPECT_THROW(qutex.backoff(*mock1, 1), std::runtime_error);
|
||||
}
|
||||
|
||||
// Test edge case: single lockvoker with multiple required locks
|
||||
TEST_F(QutexTest, SingleLockvokerMultipleRequiredLocks) {
|
||||
// Register only one lockvoker
|
||||
(void)qutex.registerInQueue(mock1);
|
||||
|
||||
// Should succeed regardless of nRequiredLocks when only one item
|
||||
bool acquired = qutex.tryAcquire(*mock1, 5);
|
||||
EXPECT_TRUE(acquired);
|
||||
EXPECT_TRUE(qutex.isOwned);
|
||||
}
|
||||
|
||||
// Test unregistration without locking
|
||||
TEST_F(QutexTest, UnregistrationWithoutLocking) {
|
||||
// Register lockvoker
|
||||
auto it1 = qutex.registerInQueue(mock1);
|
||||
EXPECT_EQ(qutex.queue.size(), 1);
|
||||
|
||||
// Unregister without locking
|
||||
qutex.unregisterFromQueue(it1, false);
|
||||
EXPECT_EQ(qutex.queue.size(), 0);
|
||||
}
|
||||
|
||||
} // namespace smo
|
||||
@@ -0,0 +1,157 @@
|
||||
#include <cstdlib>
|
||||
#include <chrono>
|
||||
#include <filesystem>
|
||||
#include <fstream>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <spinscale/envKvStore.h>
|
||||
|
||||
namespace {
|
||||
|
||||
class EnvKvStoreTest
|
||||
: public testing::Test
|
||||
{
|
||||
protected:
|
||||
void SetUp() override
|
||||
{
|
||||
root = std::filesystem::temp_directory_path()
|
||||
/ ("spinscale-env-test-"
|
||||
+ std::to_string(std::chrono::steady_clock::now()
|
||||
.time_since_epoch().count())
|
||||
+ "-" + std::to_string(testCounter++));
|
||||
std::filesystem::create_directories(root);
|
||||
unsetenv("SSCL_ENV_TEST_VALUE");
|
||||
}
|
||||
|
||||
void TearDown() override
|
||||
{
|
||||
unsetenv("SSCL_ENV_TEST_VALUE");
|
||||
std::filesystem::remove_all(root);
|
||||
}
|
||||
|
||||
std::filesystem::path writeFile(
|
||||
const std::string &filename,
|
||||
const std::string &contents)
|
||||
{
|
||||
std::filesystem::path path = root / filename;
|
||||
std::ofstream file(path);
|
||||
file << contents;
|
||||
return path;
|
||||
}
|
||||
|
||||
std::filesystem::path root;
|
||||
static inline int testCounter = 0;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
TEST_F(EnvKvStoreTest, ParsesSupportedDotenvForms)
|
||||
{
|
||||
std::filesystem::path envFile = writeFile(
|
||||
"one.env",
|
||||
"\n"
|
||||
"# comment\n"
|
||||
"PLAIN=value\n"
|
||||
" TRIMMED = value with spaces \n"
|
||||
"SINGLE=' preserved value '\n"
|
||||
"DOUBLE=\"another preserved value\"\n"
|
||||
"ESCAPED=\"quote: \\\" slash: \\\\ tab: \\t\"\n"
|
||||
"COMMENTED=value # comment\n");
|
||||
|
||||
std::ostringstream warnings;
|
||||
sscl::EnvKvStore store({envFile}, warnings);
|
||||
|
||||
EXPECT_EQ(store.get("PLAIN"), "value");
|
||||
EXPECT_EQ(store.get("TRIMMED"), "value with spaces");
|
||||
EXPECT_EQ(store.get("SINGLE"), " preserved value ");
|
||||
EXPECT_EQ(store.get("DOUBLE"), "another preserved value");
|
||||
EXPECT_EQ(store.get("ESCAPED"), "quote: \" slash: \\ tab: \t");
|
||||
EXPECT_EQ(store.get("COMMENTED"), "value");
|
||||
EXPECT_TRUE(warnings.str().empty());
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, LaterFilesOverwriteEarlierFilesAndWarn)
|
||||
{
|
||||
std::filesystem::path first = writeFile("first.env", "VALUE=first\n");
|
||||
std::filesystem::path second = writeFile("second.env", "VALUE=second\n");
|
||||
|
||||
std::ostringstream warnings;
|
||||
sscl::EnvKvStore store({first, second}, warnings);
|
||||
|
||||
EXPECT_EQ(store.get("VALUE"), "second");
|
||||
EXPECT_NE(warnings.str().find("VALUE"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find("first"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find("second"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find(second.string()), std::string::npos);
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, DuplicateKeysInsideSameFileOverwriteAndWarn)
|
||||
{
|
||||
std::filesystem::path envFile =
|
||||
writeFile("one.env", "VALUE=first\nVALUE=second\n");
|
||||
|
||||
std::ostringstream warnings;
|
||||
sscl::EnvKvStore store({envFile}, warnings);
|
||||
|
||||
EXPECT_EQ(store.get("VALUE"), "second");
|
||||
EXPECT_NE(warnings.str().find("VALUE"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find("first"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find("second"), std::string::npos);
|
||||
EXPECT_NE(warnings.str().find(envFile.string()), std::string::npos);
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, ProcessEnvironmentOverridesStoreSilently)
|
||||
{
|
||||
std::filesystem::path envFile =
|
||||
writeFile("one.env", "SSCL_ENV_TEST_VALUE=file\n");
|
||||
setenv("SSCL_ENV_TEST_VALUE", "process", 1);
|
||||
|
||||
std::ostringstream warnings;
|
||||
sscl::EnvKvStore store({envFile}, warnings);
|
||||
|
||||
EXPECT_EQ(store.get("SSCL_ENV_TEST_VALUE"), "process");
|
||||
EXPECT_TRUE(warnings.str().empty());
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, EmptyProcessEnvironmentValueOverridesStoreSilently)
|
||||
{
|
||||
std::filesystem::path envFile =
|
||||
writeFile("one.env", "SSCL_ENV_TEST_VALUE=file\n");
|
||||
setenv("SSCL_ENV_TEST_VALUE", "", 1);
|
||||
|
||||
std::ostringstream warnings;
|
||||
sscl::EnvKvStore store({envFile}, warnings);
|
||||
|
||||
EXPECT_EQ(store.get("SSCL_ENV_TEST_VALUE"), "");
|
||||
EXPECT_TRUE(warnings.str().empty());
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, MissingFileThrows)
|
||||
{
|
||||
std::ostringstream warnings;
|
||||
EXPECT_THROW(
|
||||
sscl::EnvKvStore({root / "missing.env"}, warnings),
|
||||
std::runtime_error);
|
||||
}
|
||||
|
||||
TEST_F(EnvKvStoreTest, MalformedLineThrows)
|
||||
{
|
||||
std::filesystem::path envFile = writeFile("bad.env", "NOT AN ASSIGNMENT\n");
|
||||
std::ostringstream warnings;
|
||||
|
||||
try
|
||||
{
|
||||
sscl::EnvKvStore store({envFile}, warnings);
|
||||
FAIL() << "Expected malformed env file to throw.";
|
||||
}
|
||||
catch (const std::runtime_error &e)
|
||||
{
|
||||
std::string message = e.what();
|
||||
EXPECT_NE(message.find(envFile.string()), std::string::npos);
|
||||
EXPECT_NE(message.find(":1:"), std::string::npos);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,71 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_BAKED_DEVICE_CATALOG_H
|
||||
#define SPINSCALE_TEST_SUPPORT_BAKED_DEVICE_CATALOG_H
|
||||
|
||||
#include <cstddef>
|
||||
#include <optional>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include <bakedCameraProfiles.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
inline std::vector<const test_fixtures::BakedCameraProfile *>
|
||||
profilesForMachine(const char *machineTag)
|
||||
{
|
||||
std::vector<const test_fixtures::BakedCameraProfile *> matches;
|
||||
|
||||
for (std::size_t i = 0; i < test_fixtures::bakedCameraProfileCount; ++i)
|
||||
{
|
||||
const test_fixtures::BakedCameraProfile& profile =
|
||||
test_fixtures::bakedCameraProfiles[i];
|
||||
|
||||
if (std::string(profile.machineTag) == machineTag) {
|
||||
matches.push_back(&profile);
|
||||
}
|
||||
}
|
||||
|
||||
return matches;
|
||||
}
|
||||
|
||||
inline std::optional<const test_fixtures::BakedCameraProfile *>
|
||||
findProfileByTag(const char *machineTag, const char *profileTag)
|
||||
{
|
||||
for (std::size_t i = 0; i < test_fixtures::bakedCameraProfileCount; ++i)
|
||||
{
|
||||
const test_fixtures::BakedCameraProfile& profile =
|
||||
test_fixtures::bakedCameraProfiles[i];
|
||||
|
||||
if (std::string(profile.machineTag) == machineTag
|
||||
&& std::string(profile.profileTag) == profileTag)
|
||||
{
|
||||
return &profile;
|
||||
}
|
||||
}
|
||||
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
inline std::vector<const test_fixtures::BakedCameraProfile *>
|
||||
requiredProfilesForMachine(const char *machineTag)
|
||||
{
|
||||
std::vector<const test_fixtures::BakedCameraProfile *> matches;
|
||||
|
||||
for (std::size_t i = 0; i < test_fixtures::bakedCameraProfileCount; ++i)
|
||||
{
|
||||
const test_fixtures::BakedCameraProfile& profile =
|
||||
test_fixtures::bakedCameraProfiles[i];
|
||||
|
||||
if (std::string(profile.machineTag) == machineTag
|
||||
&& profile.requiredOnMachine)
|
||||
{
|
||||
matches.push_back(&profile);
|
||||
}
|
||||
}
|
||||
|
||||
return matches;
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_BAKED_DEVICE_CATALOG_H
|
||||
@@ -0,0 +1,38 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_COROUTINE_DRIVER_H
|
||||
#define SPINSCALE_TEST_SUPPORT_COROUTINE_DRIVER_H
|
||||
|
||||
#include <exception>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
|
||||
#include <support/threadHarness.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
class CoroutineDriver
|
||||
{
|
||||
public:
|
||||
template <typename Invoker>
|
||||
static auto completedReturnValue(Invoker &invoker)
|
||||
{
|
||||
if (invoker.completedReturnValues().myExceptionPtr) {
|
||||
std::rethrow_exception(
|
||||
invoker.completedReturnValues().myExceptionPtr);
|
||||
}
|
||||
|
||||
return invoker.completedReturnValues().myReturnValue;
|
||||
}
|
||||
|
||||
template <typename Invoker>
|
||||
static auto pumpUntilIdleAndReturnValue(
|
||||
boost::asio::io_context &ioContext,
|
||||
Invoker &invoker)
|
||||
{
|
||||
IoContextPump::pumpUntilIdle(ioContext);
|
||||
return completedReturnValue(invoker);
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_COROUTINE_DRIVER_H
|
||||
@@ -0,0 +1,63 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_EXCEPTION_ASSERTIONS_H
|
||||
#define SPINSCALE_TEST_SUPPORT_EXCEPTION_ASSERTIONS_H
|
||||
|
||||
#include <exception>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
inline void requireExceptionMessageContains(
|
||||
const std::exception &exception,
|
||||
const std::string &expectedSubstring)
|
||||
{
|
||||
const std::string message = exception.what();
|
||||
if (message.find(expectedSubstring) == std::string::npos) {
|
||||
throw std::runtime_error(
|
||||
"Expected exception message to contain \""
|
||||
+ expectedSubstring
|
||||
+ "\", got \""
|
||||
+ message
|
||||
+ "\"");
|
||||
}
|
||||
}
|
||||
|
||||
inline void expectExceptionMessageContains(
|
||||
const std::exception &exception,
|
||||
const std::string &expectedSubstring)
|
||||
{
|
||||
EXPECT_NO_THROW(
|
||||
requireExceptionMessageContains(exception, expectedSubstring));
|
||||
}
|
||||
|
||||
inline void requireExceptionPtrMessageContains(
|
||||
const std::exception_ptr &exceptionPtr,
|
||||
const std::string &expectedSubstring)
|
||||
{
|
||||
try {
|
||||
std::rethrow_exception(exceptionPtr);
|
||||
}
|
||||
catch (const std::exception &exception) {
|
||||
requireExceptionMessageContains(exception, expectedSubstring);
|
||||
return;
|
||||
}
|
||||
catch (...) {
|
||||
throw std::runtime_error("Expected std::exception in exception_ptr");
|
||||
}
|
||||
}
|
||||
|
||||
inline void expectExceptionPtrMessageContains(
|
||||
const std::exception_ptr &exceptionPtr,
|
||||
const std::string &expectedSubstring)
|
||||
{
|
||||
EXPECT_NO_THROW(
|
||||
requireExceptionPtrMessageContains(
|
||||
exceptionPtr,
|
||||
expectedSubstring));
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_EXCEPTION_ASSERTIONS_H
|
||||
@@ -0,0 +1,177 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_GROUP_ASSERTIONS_H
|
||||
#define SPINSCALE_TEST_SUPPORT_GROUP_ASSERTIONS_H
|
||||
|
||||
#include <exception>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <spinscale/co/group.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
template <typename Invoker>
|
||||
int completedIntValue(Invoker &invoker)
|
||||
{
|
||||
if (invoker.completedReturnValues().myExceptionPtr) {
|
||||
std::rethrow_exception(
|
||||
invoker.completedReturnValues().myExceptionPtr);
|
||||
}
|
||||
|
||||
return invoker.completedReturnValues().myReturnValue;
|
||||
}
|
||||
|
||||
inline void requireCompletedSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor)
|
||||
{
|
||||
if (descriptor.type !=
|
||||
sscl::co::Group::SettlementDescriptor::TypeE::COMPLETED)
|
||||
{
|
||||
throw std::runtime_error("Expected completed settlement");
|
||||
}
|
||||
}
|
||||
|
||||
template <typename Invoker>
|
||||
void requireCompletedIntSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
int expectedValue)
|
||||
{
|
||||
requireCompletedSettlement(descriptor);
|
||||
|
||||
const int actualValue = completedIntValue(descriptor.invokerAs<Invoker>());
|
||||
if (actualValue != expectedValue) {
|
||||
throw std::runtime_error(
|
||||
"Expected completed settlement value "
|
||||
+ std::to_string(expectedValue)
|
||||
+ ", got "
|
||||
+ std::to_string(actualValue));
|
||||
}
|
||||
}
|
||||
|
||||
template <typename Invoker>
|
||||
void expectCompletedIntSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
int expectedValue)
|
||||
{
|
||||
EXPECT_NO_THROW(
|
||||
requireCompletedIntSettlement<Invoker>(
|
||||
descriptor,
|
||||
expectedValue));
|
||||
}
|
||||
|
||||
inline void expectCompletedSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor)
|
||||
{
|
||||
EXPECT_NO_THROW(requireCompletedSettlement(descriptor));
|
||||
}
|
||||
|
||||
inline void requireExceptionSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor)
|
||||
{
|
||||
if (descriptor.type !=
|
||||
sscl::co::Group::SettlementDescriptor::TypeE::EXCEPTION_THROWN)
|
||||
{
|
||||
throw std::runtime_error("Expected exception settlement");
|
||||
}
|
||||
|
||||
if (!descriptor.calleeException) {
|
||||
throw std::runtime_error("Expected exception pointer in settlement");
|
||||
}
|
||||
}
|
||||
|
||||
inline void expectExceptionSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor)
|
||||
{
|
||||
EXPECT_NO_THROW(requireExceptionSettlement(descriptor));
|
||||
}
|
||||
|
||||
inline void requireRuntimeErrorSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
const std::string &expectedMessage)
|
||||
{
|
||||
requireExceptionSettlement(descriptor);
|
||||
|
||||
try {
|
||||
std::rethrow_exception(descriptor.calleeException);
|
||||
}
|
||||
catch (const std::runtime_error &runtimeError) {
|
||||
const std::string actualMessage = runtimeError.what();
|
||||
if (actualMessage != expectedMessage) {
|
||||
throw std::runtime_error(
|
||||
"Expected runtime_error settlement message \""
|
||||
+ expectedMessage
|
||||
+ "\", got \""
|
||||
+ actualMessage
|
||||
+ "\"");
|
||||
}
|
||||
return;
|
||||
}
|
||||
catch (...) {
|
||||
throw std::runtime_error("Expected std::runtime_error settlement");
|
||||
}
|
||||
}
|
||||
|
||||
inline void requireIntExceptionSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
int expectedValue)
|
||||
{
|
||||
requireExceptionSettlement(descriptor);
|
||||
|
||||
try {
|
||||
std::rethrow_exception(descriptor.calleeException);
|
||||
}
|
||||
catch (int caughtValue) {
|
||||
if (caughtValue != expectedValue) {
|
||||
throw std::runtime_error(
|
||||
"Expected int exception settlement value "
|
||||
+ std::to_string(expectedValue)
|
||||
+ ", got "
|
||||
+ std::to_string(caughtValue));
|
||||
}
|
||||
return;
|
||||
}
|
||||
catch (...) {
|
||||
throw std::runtime_error("Expected int exception settlement");
|
||||
}
|
||||
}
|
||||
|
||||
inline void expectIntExceptionSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
int expectedValue)
|
||||
{
|
||||
EXPECT_NO_THROW(
|
||||
requireIntExceptionSettlement(
|
||||
descriptor,
|
||||
expectedValue));
|
||||
}
|
||||
|
||||
inline void expectRuntimeErrorSettlement(
|
||||
const sscl::co::Group::SettlementDescriptor &descriptor,
|
||||
const std::string &expectedMessage)
|
||||
{
|
||||
EXPECT_NO_THROW(
|
||||
requireRuntimeErrorSettlement(
|
||||
descriptor,
|
||||
expectedMessage));
|
||||
}
|
||||
|
||||
inline void requireEmptyGroupError(
|
||||
const std::runtime_error &runtimeError)
|
||||
{
|
||||
constexpr const char *expectedMessage =
|
||||
"co_await: Group has no member invokers; call add() before awaiting";
|
||||
if (std::string(runtimeError.what()) != expectedMessage) {
|
||||
throw std::runtime_error("Unexpected empty group error message");
|
||||
}
|
||||
}
|
||||
|
||||
inline void expectEmptyGroupError(
|
||||
const std::runtime_error &runtimeError)
|
||||
{
|
||||
EXPECT_NO_THROW(requireEmptyGroupError(runtimeError));
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_GROUP_ASSERTIONS_H
|
||||
@@ -0,0 +1,118 @@
|
||||
#include <support/probeComponentThread.h>
|
||||
|
||||
#include <iostream>
|
||||
|
||||
#include <spinscale/component.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr sscl::ThreadId PROBE_PUPPETEER_THREAD_ID = 2;
|
||||
|
||||
class ProbeDummyPuppeteerComponent
|
||||
: public sscl::pptr::PuppeteerComponent
|
||||
{
|
||||
public:
|
||||
explicit ProbeDummyPuppeteerComponent(
|
||||
const std::shared_ptr<sscl::PuppeteerThread>& componentThreadIn)
|
||||
: sscl::pptr::PuppeteerComponent(componentThreadIn)
|
||||
{}
|
||||
|
||||
void handleLoopExceptionHook() override
|
||||
{
|
||||
std::cerr << "ProbeComponentThreadHarness: puppeteer loop exception\n";
|
||||
}
|
||||
};
|
||||
|
||||
void probePuppeteerMain(
|
||||
const sscl::PuppeteerThread::EntryFnArguments& args,
|
||||
const std::function<void(
|
||||
const std::shared_ptr<sscl::ComponentThread>&)>& work,
|
||||
std::promise<std::exception_ptr>& donePromise)
|
||||
{
|
||||
sscl::PuppeteerThread& thr = args.usableBeforeJolt;
|
||||
thr.initializeTls();
|
||||
sscl::ComponentThread::setPuppeteerThreadId(PROBE_PUPPETEER_THREAD_ID);
|
||||
|
||||
std::shared_ptr<sscl::PuppeteerThread> thrPtr =
|
||||
std::static_pointer_cast<sscl::PuppeteerThread>(thr.shared_from_this());
|
||||
sscl::ComponentThread::setPuppeteerThread(thrPtr);
|
||||
|
||||
try {
|
||||
work(thrPtr);
|
||||
donePromise.set_value(nullptr);
|
||||
}
|
||||
catch (...) {
|
||||
donePromise.set_value(std::current_exception());
|
||||
}
|
||||
|
||||
thr.getIoContext().stop();
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
ProbeComponentThreadHarness::ProbeComponentThreadHarness(
|
||||
const char *threadName)
|
||||
: threadName(threadName),
|
||||
dummyComponent(std::make_shared<ProbeDummyPuppeteerComponent>(
|
||||
std::shared_ptr<sscl::PuppeteerThread>()))
|
||||
{}
|
||||
|
||||
ProbeComponentThreadHarness::~ProbeComponentThreadHarness() = default;
|
||||
|
||||
std::shared_ptr<sscl::ComponentThread>
|
||||
ProbeComponentThreadHarness::componentThread() const
|
||||
{
|
||||
return lastComponentThread;
|
||||
}
|
||||
|
||||
void ProbeComponentThreadHarness::runSync(
|
||||
const std::function<void(
|
||||
const std::shared_ptr<sscl::ComponentThread>&)>& work)
|
||||
{
|
||||
std::promise<std::exception_ptr> donePromise;
|
||||
std::future<std::exception_ptr> doneFuture = donePromise.get_future();
|
||||
|
||||
std::shared_ptr<sscl::PuppeteerThread> runThread =
|
||||
std::make_shared<sscl::PuppeteerThread>(
|
||||
PROBE_PUPPETEER_THREAD_ID,
|
||||
threadName,
|
||||
[&work, &donePromise](
|
||||
const sscl::PuppeteerThread::EntryFnArguments& args)
|
||||
{
|
||||
probePuppeteerMain(args, work, donePromise);
|
||||
},
|
||||
*dummyComponent,
|
||||
nullptr);
|
||||
|
||||
dummyComponent->thread = runThread;
|
||||
lastComponentThread = runThread;
|
||||
runThread->thread.join();
|
||||
|
||||
std::exception_ptr probeException = doneFuture.get();
|
||||
if (probeException) {
|
||||
std::rethrow_exception(probeException);
|
||||
}
|
||||
}
|
||||
|
||||
void runNonViralNurseryOnComponentThread(
|
||||
const std::shared_ptr<sscl::ComponentThread>& componentThread,
|
||||
std::function<sscl::co::NonViralNonPostingInvoker(
|
||||
sscl::co::NonViralTaskNursery::Slot::Lease&)> invokerFactory,
|
||||
std::chrono::milliseconds timeout)
|
||||
{
|
||||
(void)timeout;
|
||||
|
||||
sscl::co::NonViralTaskNursery nursery;
|
||||
nursery.openAdmission();
|
||||
nursery.launch(
|
||||
[&invokerFactory](sscl::co::NonViralTaskNursery::Slot::Lease& lease)
|
||||
{
|
||||
return invokerFactory(lease);
|
||||
});
|
||||
nursery.closeAdmission();
|
||||
nursery.syncAwaitAllSettlements(componentThread->getIoContext());
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
@@ -0,0 +1,66 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_PROBE_COMPONENT_THREAD_H
|
||||
#define SPINSCALE_TEST_SUPPORT_PROBE_COMPONENT_THREAD_H
|
||||
|
||||
#include <chrono>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <future>
|
||||
#include <memory>
|
||||
#include <stdexcept>
|
||||
|
||||
#include <spinscale/componentThread.h>
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/co/nonViralTaskNursery.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
constexpr std::chrono::milliseconds defaultProbeTaskTimeout{10000};
|
||||
|
||||
void runNonViralNurseryOnComponentThread(
|
||||
const std::shared_ptr<sscl::ComponentThread>& componentThread,
|
||||
std::function<sscl::co::NonViralNonPostingInvoker(
|
||||
sscl::co::NonViralTaskNursery::Slot::Lease&)> invokerFactory,
|
||||
std::chrono::milliseconds timeout = defaultProbeTaskTimeout);
|
||||
|
||||
class ProbeComponentThreadHarness
|
||||
{
|
||||
public:
|
||||
explicit ProbeComponentThreadHarness(
|
||||
const char *threadName = "spinscale-probe");
|
||||
~ProbeComponentThreadHarness();
|
||||
|
||||
ProbeComponentThreadHarness(const ProbeComponentThreadHarness &) = delete;
|
||||
ProbeComponentThreadHarness &operator=(
|
||||
const ProbeComponentThreadHarness &) = delete;
|
||||
|
||||
std::shared_ptr<sscl::ComponentThread> componentThread() const;
|
||||
|
||||
void runSync(
|
||||
const std::function<void(
|
||||
const std::shared_ptr<sscl::ComponentThread>&)>& work);
|
||||
|
||||
template <typename InvokerFactory>
|
||||
void runNonViralNurseryTask(
|
||||
InvokerFactory &&invokerFactory,
|
||||
std::chrono::milliseconds timeout = defaultProbeTaskTimeout)
|
||||
{
|
||||
runSync(
|
||||
[this, &invokerFactory, timeout](
|
||||
const std::shared_ptr<sscl::ComponentThread>& componentThread)
|
||||
{
|
||||
sscl::tests::runNonViralNurseryOnComponentThread(
|
||||
componentThread,
|
||||
std::forward<InvokerFactory>(invokerFactory),
|
||||
timeout);
|
||||
});
|
||||
}
|
||||
|
||||
private:
|
||||
std::string threadName;
|
||||
std::shared_ptr<sscl::pptr::PuppeteerComponent> dummyComponent;
|
||||
std::shared_ptr<sscl::ComponentThread> lastComponentThread;
|
||||
};
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_PROBE_COMPONENT_THREAD_H
|
||||
@@ -0,0 +1,455 @@
|
||||
#include <support/threadHarness.h>
|
||||
|
||||
#include <cstdlib>
|
||||
#include <iostream>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
struct DedicatedIoThread::StartupState
|
||||
{
|
||||
std::mutex mutex;
|
||||
std::condition_variable condition;
|
||||
std::thread::id osThreadId;
|
||||
std::exception_ptr startupException;
|
||||
bool allowInitialization = false;
|
||||
bool initialized = false;
|
||||
};
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr const char *callerThreadName = "test:caller";
|
||||
constexpr const char *calleeThreadName = "test:callee";
|
||||
constexpr const char *alternateThreadName = "test:alternate";
|
||||
constexpr const char *bodyThreadName = "test:body";
|
||||
constexpr const char *worldThreadName = "test:world";
|
||||
constexpr const char *legThreadName = "test:leg";
|
||||
|
||||
void runDedicatedThread(
|
||||
const std::shared_ptr<DedicatedIoThread::StartupState> &state,
|
||||
const sscl::PuppeteerThread::EntryFnArguments &args)
|
||||
{
|
||||
{
|
||||
std::unique_lock<std::mutex> lock(state->mutex);
|
||||
state->condition.wait(
|
||||
lock,
|
||||
[&state]() { return state->allowInitialization; });
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
args.usableBeforeJolt.initializeTls();
|
||||
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(state->mutex);
|
||||
state->osThreadId = std::this_thread::get_id();
|
||||
state->initialized = true;
|
||||
}
|
||||
|
||||
state->condition.notify_all();
|
||||
|
||||
args.usableBeforeJolt.getIoContext().restart();
|
||||
args.usableBeforeJolt.getIoContext().run();
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(state->mutex);
|
||||
state->startupException = std::current_exception();
|
||||
state->initialized = true;
|
||||
}
|
||||
|
||||
state->condition.notify_all();
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
std::string threadRoleName(PostingThreadRole role)
|
||||
{
|
||||
switch (role)
|
||||
{
|
||||
case PostingThreadRole::CALLER:
|
||||
return callerThreadName;
|
||||
case PostingThreadRole::CALLEE:
|
||||
return calleeThreadName;
|
||||
case PostingThreadRole::ALTERNATE:
|
||||
return alternateThreadName;
|
||||
case PostingThreadRole::BODY:
|
||||
return bodyThreadName;
|
||||
case PostingThreadRole::WORLD:
|
||||
return worldThreadName;
|
||||
case PostingThreadRole::LEG:
|
||||
return legThreadName;
|
||||
}
|
||||
|
||||
throw std::runtime_error("Unknown PostingThreadRole");
|
||||
}
|
||||
|
||||
void IoContextPump::pumpUntilIdle(
|
||||
boost::asio::io_context &ioContext,
|
||||
std::chrono::milliseconds idleTimeout,
|
||||
std::chrono::milliseconds totalTimeout)
|
||||
{
|
||||
const auto totalDeadline =
|
||||
std::chrono::steady_clock::now() + totalTimeout;
|
||||
auto lastProgress = std::chrono::steady_clock::now();
|
||||
|
||||
while (std::chrono::steady_clock::now() < totalDeadline)
|
||||
{
|
||||
if (ioContext.poll_one() > 0)
|
||||
{
|
||||
lastProgress = std::chrono::steady_clock::now();
|
||||
continue;
|
||||
}
|
||||
|
||||
if (std::chrono::steady_clock::now() - lastProgress >= idleTimeout) {
|
||||
return;
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(1));
|
||||
}
|
||||
}
|
||||
|
||||
ThreadBoundComponent::ThreadBoundComponent()
|
||||
: sscl::pptr::PuppeteerComponent(nullptr)
|
||||
{
|
||||
}
|
||||
|
||||
void ThreadBoundComponent::handleLoopExceptionHook()
|
||||
{
|
||||
loopException = std::current_exception();
|
||||
}
|
||||
|
||||
DedicatedIoThread::DedicatedIoThread(PostingThreadRole roleIn)
|
||||
: role(roleIn),
|
||||
startupState(std::make_shared<StartupState>()),
|
||||
component(),
|
||||
thread(std::make_shared<sscl::PuppeteerThread>(
|
||||
static_cast<sscl::ThreadId>(roleIn),
|
||||
threadRoleName(roleIn),
|
||||
[state = startupState](
|
||||
const sscl::PuppeteerThread::EntryFnArguments &args)
|
||||
{
|
||||
runDedicatedThread(state, args);
|
||||
},
|
||||
component,
|
||||
nullptr))
|
||||
{
|
||||
component.thread = thread;
|
||||
releaseStartupBarrier();
|
||||
waitUntilInitialized();
|
||||
}
|
||||
|
||||
DedicatedIoThread::~DedicatedIoThread()
|
||||
{
|
||||
stopAndJoin();
|
||||
}
|
||||
|
||||
boost::asio::io_context &DedicatedIoThread::ioContext()
|
||||
{
|
||||
return thread->getIoContext();
|
||||
}
|
||||
|
||||
sscl::ThreadId DedicatedIoThread::threadId() const noexcept
|
||||
{
|
||||
return static_cast<sscl::ThreadId>(role);
|
||||
}
|
||||
|
||||
std::thread::id DedicatedIoThread::osThreadId() const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(startupState->mutex);
|
||||
return startupState->osThreadId;
|
||||
}
|
||||
|
||||
std::shared_ptr<sscl::PuppeteerThread> DedicatedIoThread::componentThread() const
|
||||
{
|
||||
return thread;
|
||||
}
|
||||
|
||||
void DedicatedIoThread::stopAndJoin()
|
||||
{
|
||||
if (!thread) {
|
||||
return;
|
||||
}
|
||||
|
||||
releaseStartupBarrier();
|
||||
thread->getIoContext().stop();
|
||||
|
||||
if (thread->thread.joinable()) {
|
||||
thread->thread.join();
|
||||
}
|
||||
|
||||
thread.reset();
|
||||
}
|
||||
|
||||
void DedicatedIoThread::releaseStartupBarrier()
|
||||
{
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(startupState->mutex);
|
||||
startupState->allowInitialization = true;
|
||||
}
|
||||
|
||||
startupState->condition.notify_all();
|
||||
}
|
||||
|
||||
void DedicatedIoThread::waitUntilInitialized()
|
||||
{
|
||||
std::unique_lock<std::mutex> lock(startupState->mutex);
|
||||
const bool initialized = startupState->condition.wait_for(
|
||||
lock,
|
||||
defaultPostingTaskTimeout,
|
||||
[this]() { return startupState->initialized; });
|
||||
|
||||
if (!initialized) {
|
||||
throw std::runtime_error("Timed out waiting for test thread startup");
|
||||
}
|
||||
|
||||
std::exception_ptr startupException = startupState->startupException;
|
||||
lock.unlock();
|
||||
|
||||
if (startupException) {
|
||||
std::rethrow_exception(startupException);
|
||||
}
|
||||
}
|
||||
|
||||
void ThreadRegistry::registerThread(
|
||||
PostingThreadRole role,
|
||||
DedicatedIoThread &thread)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(registryMutex());
|
||||
auto [iterator, inserted] = threadsByRole().emplace(role, &thread);
|
||||
|
||||
if (!inserted) {
|
||||
throw std::runtime_error(
|
||||
"Test thread role already registered for " + threadRoleName(role));
|
||||
}
|
||||
}
|
||||
|
||||
void ThreadRegistry::unregisterThread(
|
||||
PostingThreadRole role,
|
||||
DedicatedIoThread &expectedThread)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(registryMutex());
|
||||
auto iterator = threadsByRole().find(role);
|
||||
|
||||
if (iterator == threadsByRole().end()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (iterator->second != &expectedThread) {
|
||||
throw std::runtime_error(
|
||||
"Test thread role registered to a different thread for "
|
||||
+ threadRoleName(role));
|
||||
}
|
||||
|
||||
threadsByRole().erase(iterator);
|
||||
}
|
||||
|
||||
boost::asio::io_context &ThreadRegistry::ioContext(PostingThreadRole role)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(registryMutex());
|
||||
auto iterator = threadsByRole().find(role);
|
||||
|
||||
if (iterator == threadsByRole().end()) {
|
||||
throw std::runtime_error(
|
||||
"No test thread registered for " + threadRoleName(role));
|
||||
}
|
||||
|
||||
return iterator->second->ioContext();
|
||||
}
|
||||
|
||||
std::thread::id ThreadRegistry::osThreadId(PostingThreadRole role)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(registryMutex());
|
||||
auto iterator = threadsByRole().find(role);
|
||||
|
||||
if (iterator == threadsByRole().end()) {
|
||||
throw std::runtime_error(
|
||||
"No test thread registered for " + threadRoleName(role));
|
||||
}
|
||||
|
||||
return iterator->second->osThreadId();
|
||||
}
|
||||
|
||||
std::mutex &ThreadRegistry::registryMutex()
|
||||
{
|
||||
static std::mutex mutex;
|
||||
return mutex;
|
||||
}
|
||||
|
||||
std::map<PostingThreadRole, DedicatedIoThread *> &
|
||||
ThreadRegistry::threadsByRole()
|
||||
{
|
||||
static std::map<PostingThreadRole, DedicatedIoThread *> threads;
|
||||
return threads;
|
||||
}
|
||||
|
||||
PostingThreadSet::PostingThreadSet()
|
||||
: callerThread(PostingThreadRole::CALLER),
|
||||
calleeThread(PostingThreadRole::CALLEE),
|
||||
alternateThread(PostingThreadRole::ALTERNATE),
|
||||
bodyThread(PostingThreadRole::BODY),
|
||||
worldThread(PostingThreadRole::WORLD),
|
||||
legThread(PostingThreadRole::LEG)
|
||||
{
|
||||
previousPuppeteerThread = sscl::ComponentThread::getPptr();
|
||||
previousPuppeteerThreadId = sscl::pptr::puppeteerThreadId;
|
||||
registerAllThreads();
|
||||
installCallerAsPuppeteer();
|
||||
}
|
||||
|
||||
PostingThreadSet::~PostingThreadSet()
|
||||
{
|
||||
restorePreviousPuppeteer();
|
||||
unregisterAllThreads();
|
||||
}
|
||||
|
||||
void PostingThreadSet::registerAllThreads()
|
||||
{
|
||||
ThreadRegistry::registerThread(PostingThreadRole::CALLER, callerThread);
|
||||
ThreadRegistry::registerThread(PostingThreadRole::CALLEE, calleeThread);
|
||||
ThreadRegistry::registerThread(PostingThreadRole::ALTERNATE, alternateThread);
|
||||
ThreadRegistry::registerThread(PostingThreadRole::BODY, bodyThread);
|
||||
ThreadRegistry::registerThread(PostingThreadRole::WORLD, worldThread);
|
||||
ThreadRegistry::registerThread(PostingThreadRole::LEG, legThread);
|
||||
}
|
||||
|
||||
void PostingThreadSet::unregisterAllThreads()
|
||||
{
|
||||
ThreadRegistry::unregisterThread(PostingThreadRole::CALLER, callerThread);
|
||||
ThreadRegistry::unregisterThread(PostingThreadRole::CALLEE, calleeThread);
|
||||
ThreadRegistry::unregisterThread(
|
||||
PostingThreadRole::ALTERNATE,
|
||||
alternateThread);
|
||||
ThreadRegistry::unregisterThread(PostingThreadRole::BODY, bodyThread);
|
||||
ThreadRegistry::unregisterThread(PostingThreadRole::WORLD, worldThread);
|
||||
ThreadRegistry::unregisterThread(PostingThreadRole::LEG, legThread);
|
||||
}
|
||||
|
||||
void PostingThreadSet::installCallerAsPuppeteer()
|
||||
{
|
||||
sscl::ComponentThread::setPuppeteerThreadId(
|
||||
static_cast<sscl::ThreadId>(PostingThreadRole::CALLER));
|
||||
sscl::ComponentThread::setPuppeteerThread(callerThread.componentThread());
|
||||
}
|
||||
|
||||
void PostingThreadSet::restorePreviousPuppeteer()
|
||||
{
|
||||
sscl::ComponentThread::setPuppeteerThreadId(previousPuppeteerThreadId);
|
||||
sscl::ComponentThread::setPuppeteerThread(previousPuppeteerThread);
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::thread(PostingThreadRole role)
|
||||
{
|
||||
switch (role)
|
||||
{
|
||||
case PostingThreadRole::CALLER:
|
||||
return callerThread;
|
||||
case PostingThreadRole::CALLEE:
|
||||
return calleeThread;
|
||||
case PostingThreadRole::ALTERNATE:
|
||||
return alternateThread;
|
||||
case PostingThreadRole::BODY:
|
||||
return bodyThread;
|
||||
case PostingThreadRole::WORLD:
|
||||
return worldThread;
|
||||
case PostingThreadRole::LEG:
|
||||
return legThread;
|
||||
}
|
||||
|
||||
throw std::runtime_error("Unknown PostingThreadRole");
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::caller()
|
||||
{
|
||||
return callerThread;
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::callee()
|
||||
{
|
||||
return calleeThread;
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::alternate()
|
||||
{
|
||||
return alternateThread;
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::body()
|
||||
{
|
||||
return bodyThread;
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::world()
|
||||
{
|
||||
return worldThread;
|
||||
}
|
||||
|
||||
DedicatedIoThread &PostingThreadSet::leg()
|
||||
{
|
||||
return legThread;
|
||||
}
|
||||
|
||||
void CrossThreadTrace::recordConstructionThread()
|
||||
{
|
||||
record(constructionThreadId);
|
||||
}
|
||||
|
||||
void CrossThreadTrace::recordCalleeExecutionThread()
|
||||
{
|
||||
record(calleeExecutionThreadId);
|
||||
}
|
||||
|
||||
void CrossThreadTrace::recordFinalSuspendThread()
|
||||
{
|
||||
record(finalSuspendThreadId);
|
||||
}
|
||||
|
||||
void CrossThreadTrace::recordAwaitResumeThread()
|
||||
{
|
||||
record(awaitResumeThreadId);
|
||||
}
|
||||
|
||||
void CrossThreadTrace::recordCompletionCallbackThread()
|
||||
{
|
||||
record(completionCallbackThreadId);
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::constructionThread() const
|
||||
{
|
||||
return read(constructionThreadId);
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::calleeExecutionThread() const
|
||||
{
|
||||
return read(calleeExecutionThreadId);
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::finalSuspendThread() const
|
||||
{
|
||||
return read(finalSuspendThreadId);
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::awaitResumeThread() const
|
||||
{
|
||||
return read(awaitResumeThreadId);
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::completionCallbackThread() const
|
||||
{
|
||||
return read(completionCallbackThreadId);
|
||||
}
|
||||
|
||||
void CrossThreadTrace::record(std::thread::id &slot)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
slot = std::this_thread::get_id();
|
||||
}
|
||||
|
||||
std::thread::id CrossThreadTrace::read(const std::thread::id &slot) const
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
return slot;
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
@@ -0,0 +1,378 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_THREAD_HARNESS_H
|
||||
#define SPINSCALE_TEST_SUPPORT_THREAD_HARNESS_H
|
||||
|
||||
#include <chrono>
|
||||
#include <condition_variable>
|
||||
#include <exception>
|
||||
#include <functional>
|
||||
#include <future>
|
||||
#include <map>
|
||||
#include <memory>
|
||||
#include <mutex>
|
||||
#include <optional>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/post.hpp>
|
||||
|
||||
#include <spinscale/co/invokers.h>
|
||||
#include <spinscale/co/postingPromise.h>
|
||||
#include <spinscale/component.h>
|
||||
#include <spinscale/componentThread.h>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
constexpr std::chrono::milliseconds defaultIdleTimeout{800};
|
||||
constexpr std::chrono::milliseconds defaultTotalTimeout{10000};
|
||||
constexpr std::chrono::milliseconds defaultPostingTaskTimeout{10000};
|
||||
|
||||
enum class PostingThreadRole : sscl::ThreadId
|
||||
{
|
||||
CALLER = 70,
|
||||
CALLEE = 71,
|
||||
ALTERNATE = 72,
|
||||
BODY = 73,
|
||||
WORLD = 74,
|
||||
LEG = 75,
|
||||
};
|
||||
|
||||
std::string threadRoleName(PostingThreadRole role);
|
||||
|
||||
class IoContextPump
|
||||
{
|
||||
public:
|
||||
static void pumpUntilIdle(
|
||||
boost::asio::io_context &ioContext,
|
||||
std::chrono::milliseconds idleTimeout = defaultIdleTimeout,
|
||||
std::chrono::milliseconds totalTimeout = defaultTotalTimeout);
|
||||
|
||||
template <typename Predicate>
|
||||
static bool pumpUntil(
|
||||
boost::asio::io_context &ioContext,
|
||||
Predicate &&predicate,
|
||||
std::chrono::milliseconds idleTimeout = defaultIdleTimeout,
|
||||
std::chrono::milliseconds totalTimeout = defaultTotalTimeout)
|
||||
{
|
||||
const auto totalDeadline =
|
||||
std::chrono::steady_clock::now() + totalTimeout;
|
||||
auto lastProgress = std::chrono::steady_clock::now();
|
||||
|
||||
while (std::chrono::steady_clock::now() < totalDeadline)
|
||||
{
|
||||
if (std::invoke(predicate)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (ioContext.poll_one() > 0)
|
||||
{
|
||||
lastProgress = std::chrono::steady_clock::now();
|
||||
continue;
|
||||
}
|
||||
|
||||
if (std::chrono::steady_clock::now() - lastProgress >= idleTimeout) {
|
||||
return std::invoke(predicate);
|
||||
}
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(1));
|
||||
}
|
||||
|
||||
return std::invoke(predicate);
|
||||
}
|
||||
};
|
||||
|
||||
class ThreadBoundComponent final
|
||||
: public sscl::pptr::PuppeteerComponent
|
||||
{
|
||||
public:
|
||||
ThreadBoundComponent();
|
||||
void handleLoopExceptionHook() override;
|
||||
|
||||
std::exception_ptr loopException;
|
||||
};
|
||||
|
||||
class DedicatedIoThread
|
||||
{
|
||||
public:
|
||||
explicit DedicatedIoThread(PostingThreadRole role);
|
||||
~DedicatedIoThread();
|
||||
|
||||
DedicatedIoThread(const DedicatedIoThread &) = delete;
|
||||
DedicatedIoThread &operator=(const DedicatedIoThread &) = delete;
|
||||
DedicatedIoThread(DedicatedIoThread &&) = delete;
|
||||
DedicatedIoThread &operator=(DedicatedIoThread &&) = delete;
|
||||
|
||||
boost::asio::io_context &ioContext();
|
||||
sscl::ThreadId threadId() const noexcept;
|
||||
std::thread::id osThreadId() const;
|
||||
std::shared_ptr<sscl::PuppeteerThread> componentThread() const;
|
||||
|
||||
void stopAndJoin();
|
||||
|
||||
struct StartupState;
|
||||
|
||||
template <typename Function>
|
||||
void post(Function &&function)
|
||||
{
|
||||
boost::asio::post(
|
||||
ioContext(),
|
||||
std::forward<Function>(function));
|
||||
}
|
||||
|
||||
template <typename Function>
|
||||
auto runSync(Function &&function)
|
||||
-> std::invoke_result_t<Function &>
|
||||
{
|
||||
using Result = std::invoke_result_t<Function &>;
|
||||
|
||||
if (std::this_thread::get_id() == osThreadId()) {
|
||||
if constexpr (std::is_void_v<Result>) {
|
||||
std::invoke(function);
|
||||
return;
|
||||
} else {
|
||||
return std::invoke(function);
|
||||
}
|
||||
}
|
||||
|
||||
auto promise = std::make_shared<std::promise<Result>>();
|
||||
auto future = promise->get_future();
|
||||
|
||||
post(
|
||||
[promise, function = std::forward<Function>(function)]() mutable
|
||||
{
|
||||
try
|
||||
{
|
||||
if constexpr (std::is_void_v<Result>)
|
||||
{
|
||||
std::invoke(function);
|
||||
promise->set_value();
|
||||
}
|
||||
else
|
||||
{
|
||||
promise->set_value(std::invoke(function));
|
||||
}
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
promise->set_exception(std::current_exception());
|
||||
}
|
||||
});
|
||||
|
||||
return future.get();
|
||||
}
|
||||
|
||||
private:
|
||||
void releaseStartupBarrier();
|
||||
void waitUntilInitialized();
|
||||
|
||||
PostingThreadRole role;
|
||||
std::shared_ptr<StartupState> startupState;
|
||||
ThreadBoundComponent component;
|
||||
std::shared_ptr<sscl::PuppeteerThread> thread;
|
||||
};
|
||||
|
||||
class ThreadRegistry
|
||||
{
|
||||
public:
|
||||
static void registerThread(
|
||||
PostingThreadRole role,
|
||||
DedicatedIoThread &thread);
|
||||
static void unregisterThread(
|
||||
PostingThreadRole role,
|
||||
DedicatedIoThread &expectedThread);
|
||||
static boost::asio::io_context &ioContext(PostingThreadRole role);
|
||||
static std::thread::id osThreadId(PostingThreadRole role);
|
||||
|
||||
private:
|
||||
static std::mutex ®istryMutex();
|
||||
static std::map<PostingThreadRole, DedicatedIoThread *> &threadsByRole();
|
||||
};
|
||||
|
||||
template <PostingThreadRole role>
|
||||
struct PostingThreadTag
|
||||
{
|
||||
static boost::asio::io_context &io_context()
|
||||
{
|
||||
return ThreadRegistry::ioContext(role);
|
||||
}
|
||||
};
|
||||
|
||||
template <PostingThreadRole role, typename T>
|
||||
using RolePostingPromise =
|
||||
sscl::co::TaggedPostingPromise<T, PostingThreadTag<role>>;
|
||||
|
||||
template <PostingThreadRole role>
|
||||
struct RolePostingPromiseTemplate
|
||||
{
|
||||
template <typename T>
|
||||
using Type = RolePostingPromise<role, T>;
|
||||
};
|
||||
|
||||
template <PostingThreadRole role, typename T>
|
||||
using RoleViralPostingInvoker =
|
||||
sscl::co::ViralPostingInvoker<
|
||||
RolePostingPromiseTemplate<role>::template Type,
|
||||
T>;
|
||||
|
||||
template <PostingThreadRole role>
|
||||
using RoleNonViralPostingInvoker =
|
||||
sscl::co::NonViralPostingInvoker<
|
||||
RolePostingPromiseTemplate<role>::template Type>;
|
||||
|
||||
class PostingThreadSet
|
||||
{
|
||||
public:
|
||||
PostingThreadSet();
|
||||
~PostingThreadSet();
|
||||
|
||||
PostingThreadSet(const PostingThreadSet &) = delete;
|
||||
PostingThreadSet &operator=(const PostingThreadSet &) = delete;
|
||||
PostingThreadSet(PostingThreadSet &&) = delete;
|
||||
PostingThreadSet &operator=(PostingThreadSet &&) = delete;
|
||||
|
||||
DedicatedIoThread &thread(PostingThreadRole role);
|
||||
DedicatedIoThread &caller();
|
||||
DedicatedIoThread &callee();
|
||||
DedicatedIoThread &alternate();
|
||||
DedicatedIoThread &body();
|
||||
DedicatedIoThread &world();
|
||||
DedicatedIoThread &leg();
|
||||
|
||||
private:
|
||||
void registerAllThreads();
|
||||
void unregisterAllThreads();
|
||||
void installCallerAsPuppeteer();
|
||||
void restorePreviousPuppeteer();
|
||||
|
||||
DedicatedIoThread callerThread;
|
||||
DedicatedIoThread calleeThread;
|
||||
DedicatedIoThread alternateThread;
|
||||
DedicatedIoThread bodyThread;
|
||||
DedicatedIoThread worldThread;
|
||||
DedicatedIoThread legThread;
|
||||
std::shared_ptr<sscl::PuppeteerThread> previousPuppeteerThread;
|
||||
sscl::ThreadId previousPuppeteerThreadId = 0;
|
||||
};
|
||||
|
||||
template <typename Function>
|
||||
auto RunOnThread(DedicatedIoThread &thread, Function &&function)
|
||||
-> std::invoke_result_t<Function &>
|
||||
{
|
||||
return thread.runSync(std::forward<Function>(function));
|
||||
}
|
||||
|
||||
class CrossThreadTrace
|
||||
{
|
||||
public:
|
||||
void recordConstructionThread();
|
||||
void recordCalleeExecutionThread();
|
||||
void recordFinalSuspendThread();
|
||||
void recordAwaitResumeThread();
|
||||
void recordCompletionCallbackThread();
|
||||
|
||||
std::thread::id constructionThread() const;
|
||||
std::thread::id calleeExecutionThread() const;
|
||||
std::thread::id finalSuspendThread() const;
|
||||
std::thread::id awaitResumeThread() const;
|
||||
std::thread::id completionCallbackThread() const;
|
||||
|
||||
private:
|
||||
void record(std::thread::id &slot);
|
||||
std::thread::id read(const std::thread::id &slot) const;
|
||||
|
||||
mutable std::mutex mutex;
|
||||
std::thread::id constructionThreadId;
|
||||
std::thread::id calleeExecutionThreadId;
|
||||
std::thread::id finalSuspendThreadId;
|
||||
std::thread::id awaitResumeThreadId;
|
||||
std::thread::id completionCallbackThreadId;
|
||||
};
|
||||
|
||||
template <typename InvokerFactory>
|
||||
void runNonViralPostingTask(
|
||||
DedicatedIoThread &callerThread,
|
||||
InvokerFactory &&invokerFactory,
|
||||
std::chrono::milliseconds timeout = defaultPostingTaskTimeout)
|
||||
{
|
||||
using Factory = std::decay_t<InvokerFactory>;
|
||||
using Invoker = std::invoke_result_t<
|
||||
Factory &, std::exception_ptr &, std::function<void()>>;
|
||||
|
||||
struct TaskState
|
||||
{
|
||||
explicit TaskState(Factory factoryIn)
|
||||
: factory(std::move(factoryIn))
|
||||
{}
|
||||
|
||||
Factory factory;
|
||||
std::exception_ptr coroutineException;
|
||||
std::exception_ptr taskException;
|
||||
std::optional<Invoker> invoker;
|
||||
std::mutex mutex;
|
||||
std::condition_variable condition;
|
||||
bool completed = false;
|
||||
};
|
||||
|
||||
auto taskState = std::make_shared<TaskState>(
|
||||
std::forward<InvokerFactory>(invokerFactory));
|
||||
|
||||
callerThread.post(
|
||||
[taskState]()
|
||||
{
|
||||
auto completeTask = [taskState]()
|
||||
{
|
||||
taskState->taskException = taskState->coroutineException;
|
||||
taskState->invoker.reset();
|
||||
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(taskState->mutex);
|
||||
taskState->completed = true;
|
||||
}
|
||||
|
||||
taskState->condition.notify_one();
|
||||
};
|
||||
|
||||
try
|
||||
{
|
||||
taskState->invoker.emplace(
|
||||
std::invoke(
|
||||
taskState->factory,
|
||||
taskState->coroutineException,
|
||||
std::move(completeTask)));
|
||||
}
|
||||
catch (...)
|
||||
{
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(taskState->mutex);
|
||||
taskState->taskException = std::current_exception();
|
||||
taskState->completed = true;
|
||||
}
|
||||
|
||||
taskState->condition.notify_one();
|
||||
}
|
||||
});
|
||||
|
||||
std::unique_lock<std::mutex> lock(taskState->mutex);
|
||||
const bool completed = taskState->condition.wait_for(
|
||||
lock,
|
||||
timeout,
|
||||
[&taskState]() { return taskState->completed; });
|
||||
|
||||
if (!completed) {
|
||||
throw std::runtime_error("Timed out waiting for posting coroutine task");
|
||||
}
|
||||
|
||||
std::exception_ptr taskException = taskState->taskException;
|
||||
lock.unlock();
|
||||
|
||||
if (taskException) {
|
||||
std::rethrow_exception(taskException);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_THREAD_HARNESS_H
|
||||
@@ -0,0 +1,161 @@
|
||||
#ifndef SPINSCALE_TEST_SUPPORT_TIMER_AWAITERS_H
|
||||
#define SPINSCALE_TEST_SUPPORT_TIMER_AWAITERS_H
|
||||
|
||||
#include <coroutine>
|
||||
#include <memory>
|
||||
#include <mutex>
|
||||
#include <optional>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <unordered_map>
|
||||
|
||||
#include <boost/asio/deadline_timer.hpp>
|
||||
#include <boost/asio/error.hpp>
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/date_time/posix_time/posix_time_types.hpp>
|
||||
#include <boost/system/error_code.hpp>
|
||||
|
||||
namespace sscl::tests {
|
||||
|
||||
using SharedDeadlineTimer = std::shared_ptr<boost::asio::deadline_timer>;
|
||||
|
||||
class CancelableDeadlineTimerRegistry
|
||||
{
|
||||
public:
|
||||
void clear()
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
timersByLabel.clear();
|
||||
}
|
||||
|
||||
void registerTimer(
|
||||
int labelMilliseconds,
|
||||
const SharedDeadlineTimer &timer)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
timersByLabel[labelMilliseconds] = timer;
|
||||
}
|
||||
|
||||
void cancel(int labelMilliseconds)
|
||||
{
|
||||
std::lock_guard<std::mutex> guard(mutex);
|
||||
const auto iterator = timersByLabel.find(labelMilliseconds);
|
||||
|
||||
if (iterator == timersByLabel.end()) {
|
||||
throw std::runtime_error(
|
||||
"No cancelable deadline_timer registered for label "
|
||||
+ std::to_string(labelMilliseconds));
|
||||
}
|
||||
|
||||
const SharedDeadlineTimer timer = iterator->second.lock();
|
||||
|
||||
if (!timer) {
|
||||
throw std::runtime_error(
|
||||
"Cancelable deadline_timer expired before cancel for label "
|
||||
+ std::to_string(labelMilliseconds));
|
||||
}
|
||||
|
||||
timer->cancel();
|
||||
}
|
||||
|
||||
private:
|
||||
std::mutex mutex;
|
||||
std::unordered_map<int, std::weak_ptr<boost::asio::deadline_timer>>
|
||||
timersByLabel;
|
||||
};
|
||||
|
||||
struct DeadlineTimerAwaiter
|
||||
{
|
||||
DeadlineTimerAwaiter(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds)
|
||||
: timer(std::make_shared<boost::asio::deadline_timer>(ioContext))
|
||||
{
|
||||
start(delayMilliseconds);
|
||||
}
|
||||
|
||||
DeadlineTimerAwaiter(
|
||||
SharedDeadlineTimer sharedTimer,
|
||||
int delayMilliseconds)
|
||||
: timer(std::move(sharedTimer))
|
||||
{
|
||||
start(delayMilliseconds);
|
||||
}
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ return waitCompleted; }
|
||||
|
||||
bool await_suspend(std::coroutine_handle<> handle) noexcept
|
||||
{
|
||||
resumeHandle = handle;
|
||||
return !waitCompleted;
|
||||
}
|
||||
|
||||
boost::system::error_code await_resume() const noexcept
|
||||
{ return completionErrorCode; }
|
||||
|
||||
private:
|
||||
void start(int delayMilliseconds)
|
||||
{
|
||||
timer->expires_from_now(
|
||||
boost::posix_time::milliseconds(delayMilliseconds));
|
||||
timer->async_wait(
|
||||
[this](const boost::system::error_code &errorCode)
|
||||
{
|
||||
completionErrorCode = errorCode;
|
||||
waitCompleted = true;
|
||||
if (resumeHandle) {
|
||||
resumeHandle.resume();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
SharedDeadlineTimer timer;
|
||||
boost::system::error_code completionErrorCode;
|
||||
bool waitCompleted = false;
|
||||
std::coroutine_handle<> resumeHandle;
|
||||
};
|
||||
|
||||
struct RegisteredDeadlineTimerAwaiter
|
||||
{
|
||||
RegisteredDeadlineTimerAwaiter(
|
||||
boost::asio::io_context &ioContext,
|
||||
int delayMilliseconds,
|
||||
int registrationLabelMilliseconds,
|
||||
CancelableDeadlineTimerRegistry ®istry)
|
||||
: timer(std::make_shared<boost::asio::deadline_timer>(ioContext))
|
||||
{
|
||||
registry.registerTimer(registrationLabelMilliseconds, timer);
|
||||
waiter.emplace(timer, delayMilliseconds);
|
||||
}
|
||||
|
||||
bool await_ready() const noexcept
|
||||
{ return waiter->await_ready(); }
|
||||
|
||||
bool await_suspend(std::coroutine_handle<> handle) noexcept
|
||||
{ return waiter->await_suspend(handle); }
|
||||
|
||||
boost::system::error_code await_resume() const noexcept
|
||||
{ return waiter->await_resume(); }
|
||||
|
||||
SharedDeadlineTimer timer;
|
||||
std::optional<DeadlineTimerAwaiter> waiter;
|
||||
};
|
||||
|
||||
inline void throwIfTimerWaitFailed(
|
||||
const boost::system::error_code &waitError)
|
||||
{
|
||||
if (waitError) {
|
||||
throw std::runtime_error(
|
||||
"deadline_timer wait failed: " + waitError.message());
|
||||
}
|
||||
}
|
||||
|
||||
inline bool timerWasCanceled(const boost::system::error_code &waitError)
|
||||
{
|
||||
return waitError == boost::asio::error::operation_aborted;
|
||||
}
|
||||
|
||||
} // namespace sscl::tests
|
||||
|
||||
#endif // SPINSCALE_TEST_SUPPORT_TIMER_AWAITERS_H
|
||||
Reference in New Issue
Block a user