KiCad PCB EDA Suite
|
Implement a coroutine. More...
#include <coroutine.h>
Classes | |
class | CALL_CONTEXT |
struct | CONTEXT_T |
struct | INVOCATION_ARGS |
Public Member Functions | |
COROUTINE () | |
template<class T > | |
COROUTINE (T *object, ReturnType(T::*ptr)(ArgType)) | |
Create a coroutine from a member method of an object. More... | |
COROUTINE (std::function< ReturnType(ArgType)> aEntry) | |
Create a coroutine from a delegate object. More... | |
~COROUTINE () | |
void | KiYield () |
Stop execution of the coroutine and returns control to the caller. More... | |
void | KiYield (ReturnType &aRetVal) |
KiYield with a value. More... | |
void | RunMainStack (std::function< void()> func) |
Run a functor inside the application main stack context. More... | |
bool | Call (ArgType aArg) |
Start execution of a coroutine, passing args as its arguments. More... | |
bool | Call (const COROUTINE &aCor, ArgType aArg) |
Start execution of a coroutine, passing args as its arguments. More... | |
bool | Resume () |
Resume execution of a previously yielded coroutine. More... | |
bool | Resume (const COROUTINE &aCor) |
Resume execution of a previously yielded coroutine. More... | |
const ReturnType & | ReturnValue () const |
Return the yielded value (the argument KiYield() was called with). More... | |
bool | Running () const |
Private Member Functions | |
INVOCATION_ARGS * | doCall (INVOCATION_ARGS *aInvArgs, ArgType aArgs) |
INVOCATION_ARGS * | doResume (INVOCATION_ARGS *args) |
INVOCATION_ARGS * | jumpIn (INVOCATION_ARGS *args) |
void | jumpOut () |
coroutine stack More... | |
Static Private Member Functions | |
static void | callerStub (intptr_t aData) |
Private Attributes | |
std::unique_ptr< char[]> | m_stack |
int | m_stacksize |
std::function< ReturnType(ArgType)> | m_func |
bool | m_running |
pointer to coroutine entry arguments. More... | |
std::remove_reference< ArgType >::type * | m_args |
saved caller context More... | |
CONTEXT_T | m_caller |
main stack information More... | |
CALL_CONTEXT * | m_callContext |
saved coroutine context More... | |
CONTEXT_T | m_callee |
ReturnType | m_retVal |
Implement a coroutine.
Wikipedia has a good explanation:
"Coroutines are computer program components that generalize subroutines to allow multiple entry points for suspending and resuming execution at certain locations. Coroutines are well-suited for implementing more familiar program components such as cooperative tasks, exceptions, event loop, iterators, infinite lists and pipes."
In other words, a coroutine can be considered a lightweight thread - which can be preempted only when it deliberately yields the control to the caller. This way, we avoid concurrency problems such as locking / race conditions.
Uses libcontext library to do the actual context switching.
This particular version takes a DELEGATE as an entry point, so it can invoke methods within a given object as separate coroutines.
See coroutine_example.cpp for sample code.
Definition at line 75 of file coroutine.h.
|
inline |
Definition at line 172 of file coroutine.h.
|
inline |
Create a coroutine from a member method of an object.
Definition at line 181 of file coroutine.h.
|
inline |
Create a coroutine from a delegate object.
Definition at line 189 of file coroutine.h.
References ADVANCED_CFG::GetCfg(), ADVANCED_CFG::m_CoroutineStackSize, and COROUTINE< ReturnType, ArgType >::m_stacksize.
|
inline |
Definition at line 207 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::CONTEXT_T::ctx, COROUTINE< ReturnType, ArgType >::m_callee, and COROUTINE< ReturnType, ArgType >::m_caller.
|
inline |
Start execution of a coroutine, passing args as its arguments.
Call this method from the application main stack only.
Definition at line 264 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::Continue(), COROUTINE< ReturnType, ArgType >::doCall(), COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROOT, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_caller, and COROUTINE< ReturnType, ArgType >::Running().
Referenced by TOOL_MANAGER::dispatchInternal().
|
inline |
Start execution of a coroutine, passing args as its arguments.
Call this method for a nested coroutine invocation.
Definition at line 290 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::doCall(), COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROUTINE, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_callContext, and COROUTINE< ReturnType, ArgType >::Running().
|
inlinestaticprivate |
Definition at line 416 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::context, COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::destination, COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROOT, COROUTINE< ReturnType, ArgType >::jumpOut(), COROUTINE< ReturnType, ArgType >::m_args, COROUTINE< ReturnType, ArgType >::m_callContext, COROUTINE< ReturnType, ArgType >::m_caller, COROUTINE< ReturnType, ArgType >::m_func, COROUTINE< ReturnType, ArgType >::m_retVal, COROUTINE< ReturnType, ArgType >::m_running, COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::SetMainStack(), and COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::type.
Referenced by COROUTINE< ReturnType, ArgType >::doCall().
|
inlineprivate |
Definition at line 365 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::callerStub(), COROUTINE< ReturnType, ArgType >::CONTEXT_T::ctx, COROUTINE< ReturnType, ArgType >::jumpIn(), kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_args, COROUTINE< ReturnType, ArgType >::m_callee, COROUTINE< ReturnType, ArgType >::m_func, COROUTINE< ReturnType, ArgType >::m_running, COROUTINE< ReturnType, ArgType >::m_stack, and COROUTINE< ReturnType, ArgType >::m_stacksize.
Referenced by COROUTINE< ReturnType, ArgType >::Call().
|
inlineprivate |
Definition at line 410 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::jumpIn().
Referenced by COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::Continue(), and COROUTINE< ReturnType, ArgType >::Resume().
|
inlineprivate |
Definition at line 435 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::CONTEXT_T::ctx, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_callee, and COROUTINE< ReturnType, ArgType >::m_caller.
Referenced by COROUTINE< ReturnType, ArgType >::doCall(), and COROUTINE< ReturnType, ArgType >::doResume().
|
inlineprivate |
coroutine stack
Definition at line 452 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::context, COROUTINE< ReturnType, ArgType >::CONTEXT_T::ctx, COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROOT, COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROUTINE, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_callContext, COROUTINE< ReturnType, ArgType >::m_callee, COROUTINE< ReturnType, ArgType >::m_caller, COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::SetMainStack(), and COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::type.
Referenced by COROUTINE< ReturnType, ArgType >::callerStub(), and COROUTINE< ReturnType, ArgType >::KiYield().
|
inline |
Stop execution of the coroutine and returns control to the caller.
After a yield, Call() or Resume() methods invoked by the caller will immediately return true, indicating that we are not done yet, just asleep.
Definition at line 227 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::jumpOut().
Referenced by TOOL_MANAGER::ScheduleWait().
|
inline |
KiYield with a value.
Passe a value of given type to the caller. Useful for implementing generator objects.
Definition at line 237 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::jumpOut(), and COROUTINE< ReturnType, ArgType >::m_retVal.
|
inline |
Resume execution of a previously yielded coroutine.
Call this method only from the main application stack.
Definition at line 310 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::Continue(), COROUTINE< ReturnType, ArgType >::doResume(), COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROOT, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_caller, and COROUTINE< ReturnType, ArgType >::Running().
Referenced by TOOL_MANAGER::dispatchInternal(), and TOOL_MANAGER::ShutdownTool().
|
inline |
Resume execution of a previously yielded coroutine.
Call this method for a nested coroutine invocation.
Definition at line 336 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::doResume(), COROUTINE< ReturnType, ArgType >::INVOCATION_ARGS::FROM_ROUTINE, kicadTraceCoroutineStack, COROUTINE< ReturnType, ArgType >::m_callContext, and COROUTINE< ReturnType, ArgType >::Running().
|
inline |
Return the yielded value (the argument KiYield() was called with).
Definition at line 351 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::m_retVal.
|
inline |
Run a functor inside the application main stack context.
Call this function for example if the operation will spawn a webkit browser instance which will walk the stack to the upper border of the address space on mac osx systems because its javascript needs garbage collection (for example if you paste text into an edit box).
Definition at line 250 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::m_callContext, and COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::RunMainStack().
Referenced by TOOL_MANAGER::RunMainStack().
|
inline |
Definition at line 359 of file coroutine.h.
References COROUTINE< ReturnType, ArgType >::m_running.
Referenced by COROUTINE< ReturnType, ArgType >::Call(), TOOL_MANAGER::dispatchInternal(), and COROUTINE< ReturnType, ArgType >::Resume().
|
private |
saved caller context
Definition at line 488 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::callerStub(), and COROUTINE< ReturnType, ArgType >::doCall().
|
private |
saved coroutine context
Definition at line 494 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::Call(), COROUTINE< ReturnType, ArgType >::callerStub(), COROUTINE< ReturnType, ArgType >::jumpOut(), COROUTINE< ReturnType, ArgType >::Resume(), and COROUTINE< ReturnType, ArgType >::RunMainStack().
|
private |
Definition at line 497 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::doCall(), COROUTINE< ReturnType, ArgType >::jumpIn(), COROUTINE< ReturnType, ArgType >::jumpOut(), COROUTINE< ReturnType, ArgType >::CALL_CONTEXT::RunMainStack(), and COROUTINE< ReturnType, ArgType >::~COROUTINE().
|
private |
main stack information
Definition at line 491 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::Call(), COROUTINE< ReturnType, ArgType >::callerStub(), COROUTINE< ReturnType, ArgType >::jumpIn(), COROUTINE< ReturnType, ArgType >::jumpOut(), COROUTINE< ReturnType, ArgType >::Resume(), and COROUTINE< ReturnType, ArgType >::~COROUTINE().
|
private |
Definition at line 482 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::callerStub(), and COROUTINE< ReturnType, ArgType >::doCall().
|
private |
Definition at line 499 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::callerStub(), COROUTINE< ReturnType, ArgType >::KiYield(), and COROUTINE< ReturnType, ArgType >::ReturnValue().
|
private |
pointer to coroutine entry arguments.
Stripped of references to avoid compiler errors.
Definition at line 484 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::callerStub(), COROUTINE< ReturnType, ArgType >::doCall(), and COROUTINE< ReturnType, ArgType >::Running().
|
private |
Definition at line 478 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::doCall().
|
private |
Definition at line 480 of file coroutine.h.
Referenced by COROUTINE< ReturnType, ArgType >::COROUTINE(), and COROUTINE< ReturnType, ArgType >::doCall().