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;
84 explicit operator bool() const noexcept {
85 return ( nullptr != ctx );
86 }
87 friend class co::coContext;
88 };
89
91 class semaphore final {
92 private:
93 size_t count{ 1U };
94 void signal( void ) noexcept;
95 bool tryLock( void ) noexcept;
96 semaphore( semaphore const& ) = delete;
97 void operator=( semaphore const& ) = delete;
98 public:
107 explicit semaphore( size_t init ) : count( init ) {}
116 void set( size_t val ) noexcept;
117 friend class co::coContext;
118 };
119
121 /*cstat -MISRAC++2008-7-1-2*/
122 class coContext final {
123 private:
124 coContext( coContext const& ) = delete;
125 void operator=( coContext const& ) = delete;
126 co::state label{ co::BEGINNING };
127 qOS::timer tm;
128 public:
129 coContext() = default;
130 inline void saveHandle( co::handle& h ) noexcept
131 {
132 h.ctx = this;
133 }
134 inline static void saveHandle( void ) noexcept {}
135 inline static void semSignal( semaphore& s ) noexcept
136 {
137 s.signal();
138 }
139 inline static bool semTrylock( semaphore& s ) noexcept
140 {
141 return s.tryLock();
142 }
143 inline coContext& operator=( co::state l )
144 {
145 label = l;
146 return *this;
147 }
148 inline co::state operator()( void ) const
149 {
150 return label;
151 }
152 inline void operator()( qOS::duration_t t )
153 {
154 (void)tm.set( t );
155 }
156 inline void operator()( coAction action )
157 {
158 if ( coAction::CO_TIMEOUT_DISARM == action ) {
159 tm.disarm();
160 }
161 }
162 inline bool operator==( const co::state l ) const
163 {
164 return l == label;
165 }
166 inline bool operator!=( const co::state l ) const
167 {
168 return l != label;
169 }
170 inline bool timeout( void ) const
171 {
172 return tm.expired();
173 }
174 friend class handle;
175 };
176 /*cstat -MISRAC++2008-0-1-11*/
177
178 inline void crNOP( void ) noexcept {}
180
194 inline void reenter( void ) noexcept {}
195
211 inline void reenter( qOS::co::handle h ) noexcept { Q_UNUSED(h); }
212
220 inline void yield( void ) noexcept {}
221
226 inline void delay( qOS::duration_t t ) noexcept { Q_UNUSED(t); }
227
240 inline void waitUntil( bool condition ) noexcept { Q_UNUSED(condition); }
241
256 inline void waitUntil( bool condition, qOS::duration_t timeout ) noexcept { Q_UNUSED(condition); Q_UNUSED(timeout); }
257
271 inline bool timeoutExpired( void ) noexcept
272 {
273 return false;
274 }
275
281 inline void restart( void ) noexcept {}
282
290 inline void semWait( co::semaphore& sem ) noexcept { Q_UNUSED(sem); }
291
299 inline void semSignal( co::semaphore& sem ) noexcept { Q_UNUSED(sem); }
300
308 inline void getPosition( co::position &var ) noexcept { Q_UNUSED(var); }
309
316 inline void setPosition( co::position &var ) noexcept { Q_UNUSED(var); }
317
331 inline void perform( void ) noexcept { }
332
347 inline void perform( qOS::duration_t t ) noexcept { Q_UNUSED(t); }
348
364 inline void until( bool condition ) noexcept { Q_UNUSED(condition); }
365 /*cstat +MISRAC++2008-0-1-11 +MISRAC++2008-7-1-2*/
366
368 }
369}
370/*============================================================================*/
372#define q_co_label ( __LINE__ )
373
374/*============================================================================*/
375#define reenter_0() q_co_reenter( Q_NONE )
376#define reenter_1(h) q_co_reenter( h )
377#define reenter(...) MACRO_OVERLOAD( reenter_ , __VA_ARGS__ )
378
379/*============================================================================*/
380// clang-format off
381#define q_co_reenter( h ) \
382reenter(); \
383static qOS::co::coContext co_ctx; \
384co_ctx.saveHandle( h ); \
385for ( ; co_ctx != qOS::co::SUSPENDED ; co_ctx = qOS::co::SUSPENDED ) \
386 if ( 0 ) { \
387 goto q_co_continue; \
388 q_co_continue: \
389 continue; \
390 } \
391 else if ( 0 ) { \
392 goto q_co_break; \
393 q_co_break: \
394 break; \
395 } \
396 else \
397 switch ( co_ctx() ) \
398 case 0 : \
399
400/*============================================================================*/
401#define q_co_SaveRestore( label, init_action, pos_label_action ) \
402init_action; \
403for ( co_ctx = (label) ;; ) \
404 if ( 0 ) { \
405 case ( label ) : { \
406 pos_label_action \
407 break; \
408 } \
409 } \
410 else goto q_co_break \
411// clang-format on
412
413/*============================================================================*/
414#define q_co_cond( c ) \
415if ( !(c) ) { \
416 goto q_co_break; \
417} \
418
419/*============================================================================*/
420#define q_co_t_cond( c ) \
421if ( !( (c) || co_ctx.timeout() ) ) { \
422 goto q_co_break; \
423}
424/*============================================================================*/
425#define yield() q_co_yield( q_co_label )
426#define q_co_yield(label) \
427yield(); \
428q_co_SaveRestore( label, qOS::co::crNOP(), Q_NONE ) \
429
430/*============================================================================*/
431#define delay( t ) q_co_delay( q_co_label , t)
432#define q_co_delay( label, t ) \
433delay( t ); \
434q_co_SaveRestore( label, co_ctx(t) , q_co_t_cond(0) ) \
435
436/*============================================================================*/
437#define q_co_wu_1( c ) q_co_waitUntil( q_co_label , c )
438#define q_co_waitUntil( label, c ) \
439waitUntil( c ); \
440q_co_SaveRestore( label, qOS::co::crNOP(), q_co_cond(c) ) \
441
442#define q_co_wu_2( c, t ) q_co_timedWaitUntil( q_co_label , c, t )
443#define q_co_timedWaitUntil( label, c, t ) \
444waitUntil( c, t ); \
445q_co_SaveRestore( label, qOS::co::crNOP(), q_co_t_cond(c) ) \
446
447#define waitUntil(...) MACRO_OVERLOAD( q_co_wu_ , __VA_ARGS__ )
448/*============================================================================*/
449#define timeoutExpired() timeoutExpired() || co_ctx.timeout()
450
451/*============================================================================*/
452#define restart() q_co_restart
453#define q_co_restart \
454restart(); \
455co_ctx = qOS::co::BEGINNING; \
456goto q_co_break \
457
458/*============================================================================*/
459#define semWait( sem ) \
460semWait( sem ); \
461q_co_SaveRestore( q_co_label, qOS::co::crNOP(), q_co_cond( co_ctx.semTrylock( sem )) ) \
462
463/*============================================================================*/
464#define semSignal( sem ) \
465semSignal( sem ); \
466co_ctx.semSignal( sem ) \
467
468/*============================================================================*/
469#define getPosition( var ) q_co_get_pos( var, q_co_label )
470#define q_co_get_pos( var, label ) \
471getPosition( var ); \
472var = label; \
473case ( label ) : qOS::co::crNOP() \
474
475/*============================================================================*/
476#define setPosition( var ) co_res_pos( var, q_co_label )
477#define co_res_pos( var, label ) \
478setPosition( var ); \
479co_ctx = var(); \
480goto q_co_break \
481
482/*============================================================================*/
483#define perform_0() q_co_perform( co::coAction::CO_TIMEOUT_DISARM )
484#define perform_1( t ) q_co_perform( t )
485#define perform(...) MACRO_OVERLOAD( perform_ , __VA_ARGS__ )
486
487#define q_co_perform( t ) \
488perform(); \
489q_co_SaveRestore( q_co_label, co_ctx(t), Q_NONE ); \
490
491/*============================================================================*/
492#define until( c ) \
493until( c ); \
494q_co_cond( ( c ) || co_ctx.timeout() ) \
495/*============================================================================*/
497
498#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:87
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:91
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:107
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:271
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:281
qOS::co::delay
void delay(qOS::duration_t t) noexcept
Delay a coroutine for a given number of time.
Definition coroutine.hpp:226
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:331
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:290
qOS::co::until
void until(bool condition) noexcept
This statement ends a blocking Job segment starting with the co::perform() statement.
Definition coroutine.hpp:364
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:220
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:194
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:308
qOS::co::setPosition
void setPosition(co::position &var) noexcept
Restores the Co-Routine position saved in var.
Definition coroutine.hpp:316
qOS::co::waitUntil
void waitUntil(bool condition) noexcept
Yields until the logical condition is met.
Definition coroutine.hpp:240
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:299
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