[6a3d2e7] | 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 | // |
---|
[75a17f1] | 7 | // coroutine -- |
---|
[6a3d2e7] | 8 | // |
---|
| 9 | // Author : Thierry Delisle |
---|
| 10 | // Created On : Mon Nov 28 12:27:26 2016 |
---|
[91c389a] | 11 | // Last Modified By : Peter A. Buhr |
---|
[b10affd] | 12 | // Last Modified On : Fri Mar 30 18:23:45 2018 |
---|
| 13 | // Update Count : 8 |
---|
[6a3d2e7] | 14 | // |
---|
| 15 | |
---|
[6b0b624] | 16 | #pragma once |
---|
[6a3d2e7] | 17 | |
---|
[91c389a] | 18 | #include <assert.h> |
---|
[6a3d2e7] | 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) { |
---|
[83a071f9] | 26 | void main(T & this); |
---|
| 27 | coroutine_desc * get_coroutine(T & this); |
---|
[6a3d2e7] | 28 | }; |
---|
| 29 | |
---|
[83a071f9] | 30 | #define DECL_COROUTINE(X) static inline coroutine_desc* get_coroutine(X& this) { return &this.__cor; } void main(X& this) |
---|
[c84e80a] | 31 | |
---|
[6a3d2e7] | 32 | //----------------------------------------------------------------------------- |
---|
| 33 | // Ctors and dtors |
---|
[242a902] | 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); |
---|
[6a3d2e7] | 39 | |
---|
| 40 | //----------------------------------------------------------------------------- |
---|
| 41 | // Public coroutine API |
---|
| 42 | static inline void suspend(); |
---|
| 43 | |
---|
| 44 | forall(dtype T | is_coroutine(T)) |
---|
[83a071f9] | 45 | static inline void resume(T & cor); |
---|
[6a3d2e7] | 46 | |
---|
| 47 | forall(dtype T | is_coroutine(T)) |
---|
[83a071f9] | 48 | void prime(T & cor); |
---|
[6a3d2e7] | 49 | |
---|
| 50 | //----------------------------------------------------------------------------- |
---|
| 51 | // PRIVATE exposed because of inline |
---|
| 52 | |
---|
| 53 | // Start coroutine routines |
---|
| 54 | extern "C" { |
---|
| 55 | forall(dtype T | is_coroutine(T)) |
---|
[8118303] | 56 | void CtxInvokeCoroutine(T * this); |
---|
[6a3d2e7] | 57 | |
---|
| 58 | forall(dtype T | is_coroutine(T)) |
---|
[8118303] | 59 | void CtxStart(T * this, void ( *invoke)(T *)); |
---|
[6a3d2e7] | 60 | } |
---|
| 61 | |
---|
| 62 | // Private wrappers for context switch and stack creation |
---|
[c3acb841] | 63 | extern void CoroutineCtxSwitch(coroutine_desc * src, coroutine_desc * dst); |
---|
[8118303] | 64 | extern void create_stack( coStack_t * this, unsigned int storageSize ); |
---|
[6a3d2e7] | 65 | |
---|
| 66 | // Suspend implementation inlined for performance |
---|
| 67 | static inline void suspend() { |
---|
[b10affd] | 68 | coroutine_desc * src = TL_GET( this_coroutine ); // optimization |
---|
[6a3d2e7] | 69 | |
---|
| 70 | assertf( src->last != 0, |
---|
[8def349] | 71 | "Attempt to suspend coroutine \"%.256s\" (%p) that has never been resumed.\n" |
---|
[6a3d2e7] | 72 | "Possible cause is a suspend executed in a member called by a coroutine user rather than by the coroutine main.", |
---|
| 73 | src->name, src ); |
---|
[ee897e4b] | 74 | assertf( src->last->state != Halted, |
---|
[8def349] | 75 | "Attempt by coroutine \"%.256s\" (%p) to suspend back to terminated coroutine \"%.256s\" (%p).\n" |
---|
[6a3d2e7] | 76 | "Possible cause is terminated coroutine's main routine has already returned.", |
---|
| 77 | src->name, src, src->last->name, src->last ); |
---|
| 78 | |
---|
[0c92c9f] | 79 | CoroutineCtxSwitch( src, src->last ); |
---|
[6a3d2e7] | 80 | } |
---|
| 81 | |
---|
| 82 | // Resume implementation inlined for performance |
---|
| 83 | forall(dtype T | is_coroutine(T)) |
---|
[83a071f9] | 84 | static inline void resume(T & cor) { |
---|
[b10affd] | 85 | coroutine_desc * src = TL_GET( this_coroutine ); // optimization |
---|
[c3acb841] | 86 | coroutine_desc * dst = get_coroutine(cor); |
---|
[6a3d2e7] | 87 | |
---|
[4aa2fb2] | 88 | if( unlikely(!dst->stack.base) ) { |
---|
[6a3d2e7] | 89 | create_stack(&dst->stack, dst->stack.size); |
---|
[83a071f9] | 90 | CtxStart(&cor, CtxInvokeCoroutine); |
---|
[6a3d2e7] | 91 | } |
---|
| 92 | |
---|
[4aa2fb2] | 93 | // not resuming self ? |
---|
[6a3d2e7] | 94 | if ( src != dst ) { |
---|
[ee897e4b] | 95 | assertf( dst->state != Halted , |
---|
[6a3d2e7] | 96 | "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n" |
---|
| 97 | "Possible cause is terminated coroutine's main routine has already returned.", |
---|
| 98 | src->name, src, dst->name, dst ); |
---|
| 99 | |
---|
[4aa2fb2] | 100 | // set last resumer |
---|
[6a3d2e7] | 101 | dst->last = src; |
---|
[b462670] | 102 | dst->starter = dst->starter ? dst->starter : src; |
---|
[6a3d2e7] | 103 | } // if |
---|
| 104 | |
---|
[4aa2fb2] | 105 | // always done for performance testing |
---|
[0c92c9f] | 106 | CoroutineCtxSwitch( src, dst ); |
---|
[6a3d2e7] | 107 | } |
---|
| 108 | |
---|
[c3acb841] | 109 | static inline void resume(coroutine_desc * dst) { |
---|
[b10affd] | 110 | coroutine_desc * src = TL_GET( this_coroutine ); // optimization |
---|
[77e6fcb] | 111 | |
---|
[4aa2fb2] | 112 | // not resuming self ? |
---|
[77e6fcb] | 113 | if ( src != dst ) { |
---|
[ee897e4b] | 114 | assertf( dst->state != Halted , |
---|
[77e6fcb] | 115 | "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n" |
---|
| 116 | "Possible cause is terminated coroutine's main routine has already returned.", |
---|
| 117 | src->name, src, dst->name, dst ); |
---|
| 118 | |
---|
[4aa2fb2] | 119 | // set last resumer |
---|
[77e6fcb] | 120 | dst->last = src; |
---|
| 121 | } // if |
---|
| 122 | |
---|
[4aa2fb2] | 123 | // always done for performance testing |
---|
[77e6fcb] | 124 | CoroutineCtxSwitch( src, dst ); |
---|
| 125 | } |
---|
| 126 | |
---|
[6a3d2e7] | 127 | // Local Variables: // |
---|
| 128 | // mode: c // |
---|
| 129 | // tab-width: 4 // |
---|
| 130 | // End: // |
---|