OS  v1.7.5
Documentation
Loading...
Searching...
No Matches
coroutine.hpp
1#ifndef QOS_CPP_CO
2#define QOS_CPP_CO
3
4#include "include/types.hpp"
5#include "include/timer.hpp"
6#include "include/macro_overload.hpp"
7
8namespace qOS {
9
13 namespace co {
14
19
21 using state = base_t;
23
24 /*cstat -MISRAC++2008-0-1-4_b*/
25 const state UNDEFINED = -2;
26 const state SUSPENDED = -1;
27 const state BEGINNING = 0;
28 /*cstat +MISRAC++2008-0-1-4_b*/
29
30 class coContext;
31
32 enum class coAction {
33 CO_TIMEOUT_DISARM,
34 };
36
38 class position final {
39 state pos{ BEGINNING };
41 public:
42 state operator()(void) const
43 {
44 return pos;
45 }
46 position& operator=( co::state l )
47 {
48 pos = l;
49 return *this;
50 }
52 };
53
55 class handle final {
56 private:
57 co::state prev = { co::UNDEFINED };
58 coContext *ctx{ nullptr };
59 handle( handle const& ) = delete;
60 void operator=( handle const& ) = delete;
61 public:
62 handle() = default;
66 void try_restart( void ) noexcept;
70 void try_suspend( void ) noexcept;
75 void try_resume( void ) noexcept;
79 void try_set( co::state p ) noexcept;
80 friend class co::coContext;
81 };
82
84 class semaphore final {
85 private:
86 size_t count{ 1U };
87 void signal( void ) noexcept;
88 bool tryLock( void ) noexcept;
89 semaphore( semaphore const& ) = delete;
90 void operator=( semaphore const& ) = delete;
91 public:
100 explicit semaphore( size_t init ) : count( init ) {}
109 void set( size_t val ) noexcept;
110 friend class co::coContext;
111 };
112
114 /*cstat -MISRAC++2008-7-1-2*/
115 class coContext final {
116 private:
117 coContext( coContext const& ) = delete;
118 void operator=( coContext const& ) = delete;
119 co::state label{ co::BEGINNING };
120 qOS::timer tm;
121 public:
122 coContext() = default;
123 inline void saveHandle( co::handle& h ) noexcept
124 {
125 h.ctx = this;
126 }
127 inline static void saveHandle( void ) noexcept {}
128 inline static void semSignal( semaphore& s ) noexcept
129 {
130 s.signal();
131 }
132 inline static bool semTrylock( semaphore& s ) noexcept
133 {
134 return s.tryLock();
135 }
136 inline coContext& operator=( co::state l )
137 {
138 label = l;
139 return *this;
140 }
141 inline co::state operator()( void ) const
142 {
143 return label;
144 }
145 inline void operator()( qOS::duration_t t )
146 {
147 (void)tm.set( t );
148 }
149 inline void operator()( coAction action )
150 {
151 if ( coAction::CO_TIMEOUT_DISARM == action ) {
152 tm.disarm();
153 }
154 }
155 inline bool operator==( const co::state l ) const
156 {
157 return l == label;
158 }
159 inline bool operator!=( const co::state l ) const
160 {
161 return l != label;
162 }
163 inline bool timeout( void ) const
164 {
165 return tm.expired();
166 }
167 friend class handle;
168 };
169 /*cstat -MISRAC++2008-0-1-11*/
170
171 inline void crNOP( void ) noexcept {}
173
187 inline void reenter( void ) noexcept {}
188
204 inline void reenter( qOS::co::handle h ) noexcept { Q_UNUSED(h); }
205
213 inline void yield( void ) noexcept {}
214
219 inline void delay( qOS::duration_t t ) noexcept { Q_UNUSED(t); }
220
233 inline void waitUntil( bool condition ) noexcept { Q_UNUSED(condition); }
234
249 inline void waitUntil( bool condition, qOS::duration_t timeout ) noexcept { Q_UNUSED(condition); Q_UNUSED(timeout); }
250
264 inline bool timeoutExpired( void ) noexcept
265 {
266 return false;
267 }
268
274 inline void restart( void ) noexcept {}
275
283 inline void semWait( co::semaphore& sem ) noexcept { Q_UNUSED(sem); }
284
292 inline void semSignal( co::semaphore& sem ) noexcept { Q_UNUSED(sem); }
293
301 inline void getPosition( co::position &var ) noexcept { Q_UNUSED(var); }
302
309 inline void setPosition( co::position &var ) noexcept { Q_UNUSED(var); }
310
324 inline void perform( void ) noexcept { }
325
340 inline void perform( qOS::duration_t t ) noexcept { Q_UNUSED(t); }
341
357 inline void until( bool condition ) noexcept { Q_UNUSED(condition); }
358 /*cstat +MISRAC++2008-0-1-11 +MISRAC++2008-7-1-2*/
359
361 }
362}
363/*============================================================================*/
365#define q_co_label ( __LINE__ )
366
367/*============================================================================*/
368#define reenter_0() q_co_reenter( Q_NONE )
369#define reenter_1(h) q_co_reenter( h )
370#define reenter(...) MACRO_OVERLOAD( reenter_ , __VA_ARGS__ )
371
372/*============================================================================*/
373// clang-format off
374#define q_co_reenter( h ) \
375reenter(); \
376static qOS::co::coContext co_ctx; \
377co_ctx.saveHandle( h ); \
378for ( ; co_ctx != qOS::co::SUSPENDED ; co_ctx = qOS::co::SUSPENDED ) \
379 if ( 0 ) { \
380 goto q_co_continue; \
381 q_co_continue: \
382 continue; \
383 } \
384 else if ( 0 ) { \
385 goto q_co_break; \
386 q_co_break: \
387 break; \
388 } \
389 else \
390 switch ( co_ctx() ) \
391 case 0 : \
392
393/*============================================================================*/
394#define q_co_SaveRestore( label, init_action, pos_label_action ) \
395init_action; \
396for ( co_ctx = (label) ;; ) \
397 if ( 0 ) { \
398 case ( label ) : { \
399 pos_label_action \
400 break; \
401 } \
402 } \
403 else goto q_co_break \
404// clang-format on
405
406/*============================================================================*/
407#define q_co_cond( c ) \
408if ( !(c) ) { \
409 goto q_co_break; \
410} \
411
412/*============================================================================*/
413#define q_co_t_cond( c ) \
414if ( !( (c) || co_ctx.timeout() ) ) { \
415 goto q_co_break; \
416}
417/*============================================================================*/
418#define yield() q_co_yield( q_co_label )
419#define q_co_yield(label) \
420yield(); \
421q_co_SaveRestore( label, qOS::co::crNOP(), Q_NONE ) \
422
423/*============================================================================*/
424#define delay( t ) q_co_delay( q_co_label , t)
425#define q_co_delay( label, t ) \
426delay( t ); \
427q_co_SaveRestore( label, co_ctx(t) , q_co_t_cond(0) ) \
428
429/*============================================================================*/
430#define q_co_wu_1( c ) q_co_waitUntil( q_co_label , c )
431#define q_co_waitUntil( label, c ) \
432waitUntil( c ); \
433q_co_SaveRestore( label, qOS::co::crNOP(), q_co_cond(c) ) \
434
435#define q_co_wu_2( c, t ) q_co_timedWaitUntil( q_co_label , c, t )
436#define q_co_timedWaitUntil( label, c, t ) \
437waitUntil( c, t ); \
438q_co_SaveRestore( label, qOS::co::crNOP(), q_co_t_cond(c) ) \
439
440#define waitUntil(...) MACRO_OVERLOAD( q_co_wu_ , __VA_ARGS__ )
441/*============================================================================*/
442#define timeoutExpired() timeoutExpired() || co_ctx.timeout()
443
444/*============================================================================*/
445#define restart() q_co_restart
446#define q_co_restart \
447restart(); \
448co_ctx = qOS::co::BEGINNING; \
449goto q_co_break \
450
451/*============================================================================*/
452#define semWait( sem ) \
453semWait( sem ); \
454q_co_SaveRestore( q_co_label, qOS::co::crNOP(), q_co_cond( co_ctx.semTrylock( sem )) ) \
455
456/*============================================================================*/
457#define semSignal( sem ) \
458semSignal( sem ); \
459co_ctx.semSignal( sem ) \
460
461/*============================================================================*/
462#define getPosition( var ) q_co_get_pos( var, q_co_label )
463#define q_co_get_pos( var, label ) \
464getPosition( var ); \
465var = label; \
466case ( label ) : qOS::co::crNOP() \
467
468/*============================================================================*/
469#define setPosition( var ) co_res_pos( var, q_co_label )
470#define co_res_pos( var, label ) \
471setPosition( var ); \
472co_ctx = var(); \
473goto q_co_break \
474
475/*============================================================================*/
476#define perform_0() q_co_perform( co::coAction::CO_TIMEOUT_DISARM )
477#define perform_1( t ) q_co_perform( t )
478#define perform(...) MACRO_OVERLOAD( perform_ , __VA_ARGS__ )
479
480#define q_co_perform( t ) \
481perform(); \
482q_co_SaveRestore( q_co_label, co_ctx(t), Q_NONE ); \
483
484/*============================================================================*/
485#define until( c ) \
486until( c ); \
487q_co_cond( ( c ) || co_ctx.timeout() ) \
488/*============================================================================*/
490
491#endif /*QOS_CPP_CO*/
qOS::co::handle
A Co-Routine handle.
Definition coroutine.hpp:55
qOS::co::handle::handle
handle()=default
qOS::co::handle::try_restart
void try_restart(void) noexcept
Try to execute the co::restart() statement externally.
qOS::co::handle::try_resume
void try_resume(void) noexcept
Try to resume the coroutine execution externally after a suspend operation.
qOS::co::handle::try_suspend
void try_suspend(void) noexcept
Try to suspend the coroutine execution externally.
qOS::co::handle::coContext
friend class co::coContext
Definition coroutine.hpp:80
qOS::co::handle::try_set
void try_set(co::state p) noexcept
Try to execute co::setPosition() statement externally.
qOS::co::position
A placeholder for the Co-Routine current position or progress.
Definition coroutine.hpp:38
qOS::co::semaphore
A Co-Routine Semaphore.
Definition coroutine.hpp:84
qOS::co::semaphore::semaphore
semaphore(size_t init)
Initializes a coroutine semaphore with a value for the counter. Internally, the semaphores use an siz...
Definition coroutine.hpp:100
qOS::co::semaphore::set
void set(size_t val) noexcept
Set the coroutine semaphore with a value for the counter. Internally, the semaphores use an size_t to...
qOS::timer
A non-blocking Timer object.
Definition timer.hpp:26
qOS::timer::set
bool set(const qOS::duration_t tTime) noexcept
Set the expiration time for a timer. On success, the timer gets armed immediately.
qOS::timer::expired
bool expired(void) const noexcept
Non-Blocking timer check.
qOS::timer::disarm
void disarm(void) noexcept
Disarms the timer object.
qOS::duration_t
timeCount_t duration_t
The typedef that specified an time quantity, usually expressed in milliseconds.
Definition clock.hpp:18
qOS::co::timeoutExpired
bool timeoutExpired(void) noexcept
Check if the internal Co-routine timeout expires.
Definition coroutine.hpp:264
qOS::co::restart
void restart(void) noexcept
This statement cause the running Coroutine to restart its execution at the place of the co::reenter()...
Definition coroutine.hpp:274
qOS::co::delay
void delay(qOS::duration_t t) noexcept
Delay a coroutine for a given number of time.
Definition coroutine.hpp:219
qOS::co::state
base_t state
The intrinsic type of co::position to hold a coroutine progress.
Definition coroutine.hpp:21
qOS::co::perform
void perform(void) noexcept
This statement start a blocking Job segment.
Definition coroutine.hpp:324
qOS::co::semWait
void semWait(co::semaphore &sem) noexcept
Carries out the "wait" operation on the semaphore. The wait operation causes the Co-routine to block ...
Definition coroutine.hpp:283
qOS::co::until
void until(bool condition) noexcept
This statement ends a blocking Job segment starting with the co::perform() statement.
Definition coroutine.hpp:357
qOS::co::yield
void yield(void) noexcept
This statement is only allowed inside a Coroutine segment. co::yield return the CPU control back to t...
Definition coroutine.hpp:213
qOS::co::reenter
void reenter(void) noexcept
Defines a Coroutine segment. The co::reenter() statement is used to declare the starting point of a C...
Definition coroutine.hpp:187
qOS::co::getPosition
void getPosition(co::position &var) noexcept
Labels the current position and saves it to var so it can be later restored by co::setPosition()
Definition coroutine.hpp:301
qOS::co::setPosition
void setPosition(co::position &var) noexcept
Restores the Co-Routine position saved in var.
Definition coroutine.hpp:309
qOS::co::waitUntil
void waitUntil(bool condition) noexcept
Yields until the logical condition is met.
Definition coroutine.hpp:233
qOS::co::semSignal
void semSignal(co::semaphore &sem) noexcept
Carries out the "signal" operation on the semaphore. The signal operation increments the counter insi...
Definition coroutine.hpp:292
qOS::globalState::SUSPENDED
@ SUSPENDED
Definition task.hpp:90
qOS::globalState::UNDEFINED
@ UNDEFINED
Definition task.hpp:87
qOS::base_t
int base_t
A type to instantiate a integer-base variable. This size of this type is implementation-defined.
Definition types.hpp:62
qOS::co
CoRoutines interfaces.
Definition coroutine.hpp:13
qOS
OS/Kernel interfaces.
Definition bytebuffer.hpp:7