| 1 | //
|
|---|
| 2 | // Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
|
|---|
| 3 | //
|
|---|
| 4 | // The contents of this file are covered under the licence agreement in the
|
|---|
| 5 | // file "LICENCE" distributed with Cforall.
|
|---|
| 6 | //
|
|---|
| 7 | // coroutine --
|
|---|
| 8 | //
|
|---|
| 9 | // Author : Thierry Delisle
|
|---|
| 10 | // Created On : Mon Nov 28 12:27:26 2016
|
|---|
| 11 | // Last Modified By : Peter A. Buhr
|
|---|
| 12 | // Last Modified On : Wed Aug 30 07:58:29 2017
|
|---|
| 13 | // Update Count : 3
|
|---|
| 14 | //
|
|---|
| 15 |
|
|---|
| 16 | #pragma once
|
|---|
| 17 |
|
|---|
| 18 | #include <assert.h>
|
|---|
| 19 | #include "invoke.h"
|
|---|
| 20 |
|
|---|
| 21 | //-----------------------------------------------------------------------------
|
|---|
| 22 | // Coroutine trait
|
|---|
| 23 | // Anything that implements this trait can be resumed.
|
|---|
| 24 | // Anything that is resumed is a coroutine.
|
|---|
| 25 | trait is_coroutine(dtype T) {
|
|---|
| 26 | void main(T & this);
|
|---|
| 27 | coroutine_desc * get_coroutine(T & this);
|
|---|
| 28 | };
|
|---|
| 29 |
|
|---|
| 30 | #define DECL_COROUTINE(X) static inline coroutine_desc* get_coroutine(X& this) { return &this.__cor; } void main(X& this)
|
|---|
| 31 |
|
|---|
| 32 | //-----------------------------------------------------------------------------
|
|---|
| 33 | // Ctors and dtors
|
|---|
| 34 | void ?{}(coStack_t & this);
|
|---|
| 35 | void ?{}(coroutine_desc & this);
|
|---|
| 36 | void ?{}(coroutine_desc & this, const char * name);
|
|---|
| 37 | void ^?{}(coStack_t & this);
|
|---|
| 38 | void ^?{}(coroutine_desc & this);
|
|---|
| 39 |
|
|---|
| 40 | //-----------------------------------------------------------------------------
|
|---|
| 41 | // Public coroutine API
|
|---|
| 42 | static inline void suspend();
|
|---|
| 43 |
|
|---|
| 44 | forall(dtype T | is_coroutine(T))
|
|---|
| 45 | static inline void resume(T & cor);
|
|---|
| 46 |
|
|---|
| 47 | forall(dtype T | is_coroutine(T))
|
|---|
| 48 | void prime(T & cor);
|
|---|
| 49 |
|
|---|
| 50 | //-----------------------------------------------------------------------------
|
|---|
| 51 | // PRIVATE exposed because of inline
|
|---|
| 52 |
|
|---|
| 53 | // Start coroutine routines
|
|---|
| 54 | extern "C" {
|
|---|
| 55 | forall(dtype T | is_coroutine(T))
|
|---|
| 56 | void CtxInvokeCoroutine(T * this);
|
|---|
| 57 |
|
|---|
| 58 | forall(dtype T | is_coroutine(T))
|
|---|
| 59 | void CtxStart(T * this, void ( *invoke)(T *));
|
|---|
| 60 | }
|
|---|
| 61 |
|
|---|
| 62 | // Get current coroutine
|
|---|
| 63 | extern thread_local coroutine_desc * volatile this_coroutine;
|
|---|
| 64 |
|
|---|
| 65 | // Private wrappers for context switch and stack creation
|
|---|
| 66 | extern void CoroutineCtxSwitch(coroutine_desc * src, coroutine_desc * dst);
|
|---|
| 67 | extern void create_stack( coStack_t * this, unsigned int storageSize );
|
|---|
| 68 |
|
|---|
| 69 | // Suspend implementation inlined for performance
|
|---|
| 70 | static inline void suspend() {
|
|---|
| 71 | coroutine_desc * src = this_coroutine; // optimization
|
|---|
| 72 |
|
|---|
| 73 | assertf( src->last != 0,
|
|---|
| 74 | "Attempt to suspend coroutine \"%.256s\" (%p) that has never been resumed.\n"
|
|---|
| 75 | "Possible cause is a suspend executed in a member called by a coroutine user rather than by the coroutine main.",
|
|---|
| 76 | src->name, src );
|
|---|
| 77 | assertf( src->last->state != Halted,
|
|---|
| 78 | "Attempt by coroutine \"%.256s\" (%p) to suspend back to terminated coroutine \"%.256s\" (%p).\n"
|
|---|
| 79 | "Possible cause is terminated coroutine's main routine has already returned.",
|
|---|
| 80 | src->name, src, src->last->name, src->last );
|
|---|
| 81 |
|
|---|
| 82 | CoroutineCtxSwitch( src, src->last );
|
|---|
| 83 | }
|
|---|
| 84 |
|
|---|
| 85 | // Resume implementation inlined for performance
|
|---|
| 86 | forall(dtype T | is_coroutine(T))
|
|---|
| 87 | static inline void resume(T & cor) {
|
|---|
| 88 | coroutine_desc * src = this_coroutine; // optimization
|
|---|
| 89 | coroutine_desc * dst = get_coroutine(cor);
|
|---|
| 90 |
|
|---|
| 91 | if( unlikely(!dst->stack.base) ) {
|
|---|
| 92 | create_stack(&dst->stack, dst->stack.size);
|
|---|
| 93 | CtxStart(&cor, CtxInvokeCoroutine);
|
|---|
| 94 | }
|
|---|
| 95 |
|
|---|
| 96 | // not resuming self ?
|
|---|
| 97 | if ( src != dst ) {
|
|---|
| 98 | assertf( dst->state != Halted ,
|
|---|
| 99 | "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
|
|---|
| 100 | "Possible cause is terminated coroutine's main routine has already returned.",
|
|---|
| 101 | src->name, src, dst->name, dst );
|
|---|
| 102 |
|
|---|
| 103 | // set last resumer
|
|---|
| 104 | dst->last = src;
|
|---|
| 105 | dst->starter = dst->starter ? dst->starter : src;
|
|---|
| 106 | } // if
|
|---|
| 107 |
|
|---|
| 108 | // always done for performance testing
|
|---|
| 109 | CoroutineCtxSwitch( src, dst );
|
|---|
| 110 | }
|
|---|
| 111 |
|
|---|
| 112 | static inline void resume(coroutine_desc * dst) {
|
|---|
| 113 | coroutine_desc * src = this_coroutine; // optimization
|
|---|
| 114 |
|
|---|
| 115 | // not resuming self ?
|
|---|
| 116 | if ( src != dst ) {
|
|---|
| 117 | assertf( dst->state != Halted ,
|
|---|
| 118 | "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
|
|---|
| 119 | "Possible cause is terminated coroutine's main routine has already returned.",
|
|---|
| 120 | src->name, src, dst->name, dst );
|
|---|
| 121 |
|
|---|
| 122 | // set last resumer
|
|---|
| 123 | dst->last = src;
|
|---|
| 124 | } // if
|
|---|
| 125 |
|
|---|
| 126 | // always done for performance testing
|
|---|
| 127 | CoroutineCtxSwitch( src, dst );
|
|---|
| 128 | }
|
|---|
| 129 |
|
|---|
| 130 | // Local Variables: //
|
|---|
| 131 | // mode: c //
|
|---|
| 132 | // tab-width: 4 //
|
|---|
| 133 | // End: //
|
|---|
