source: libcfa/src/concurrency/coroutine.hfa @ fd54fef

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since fd54fef was fd54fef, checked in by Michael Brooks <mlbrooks@…>, 9 months ago

Converting the project to use the new syntax for otype, dtype and ttytpe.

Changed prelude (gen), libcfa and test suite to use it. Added a simple deprecation rule of the old syntax to the parser; we might wish to support both syntaxes "officially," like with an extra CLI switch, but this measure should serve as a simple reminder for our team to try the new syntax.

  • Property mode set to 100644
File size: 6.8 KB
Line 
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 : Tue Feb  4 12:29:26 2020
13// Update Count     : 11
14//
15
16#pragma once
17
18#include <assert.h>
19#include "invoke.h"
20#include "../exception.hfa"
21
22//-----------------------------------------------------------------------------
23// Exception thrown from resume when a coroutine stack is cancelled.
24FORALL_DATA_EXCEPTION(CoroutineCancelled, (coroutine_t &), (coroutine_t)) (
25        coroutine_t * the_coroutine;
26        exception_t * the_exception;
27);
28
29forall(T &)
30void copy(CoroutineCancelled(T) * dst, CoroutineCancelled(T) * src);
31
32forall(T &)
33const char * msg(CoroutineCancelled(T) *);
34
35//-----------------------------------------------------------------------------
36// Coroutine trait
37// Anything that implements this trait can be resumed.
38// Anything that is resumed is a coroutine.
39trait is_coroutine(T & | IS_RESUMPTION_EXCEPTION(CoroutineCancelled, (T))) {
40        void main(T & this);
41        $coroutine * get_coroutine(T & this);
42};
43
44#define DECL_COROUTINE(X) static inline $coroutine* get_coroutine(X& this) { return &this.__cor; } void main(X& this)
45
46//-----------------------------------------------------------------------------
47// Ctors and dtors
48// void ?{}( coStack_t & this );
49// void ^?{}( coStack_t & this );
50
51void  ?{}( $coroutine & this, const char name[], void * storage, size_t storageSize );
52void ^?{}( $coroutine & this );
53
54static inline void ?{}( $coroutine & this)                                       { this{ "Anonymous Coroutine", 0p, 0 }; }
55static inline void ?{}( $coroutine & this, size_t stackSize)                     { this{ "Anonymous Coroutine", 0p, stackSize }; }
56static inline void ?{}( $coroutine & this, void * storage, size_t storageSize )  { this{ "Anonymous Coroutine", storage, storageSize }; }
57static inline void ?{}( $coroutine & this, const char name[])                    { this{ name, 0p, 0 }; }
58static inline void ?{}( $coroutine & this, const char name[], size_t stackSize ) { this{ name, 0p, stackSize }; }
59
60//-----------------------------------------------------------------------------
61// Public coroutine API
62forall(T & | is_coroutine(T))
63void prime(T & cor);
64
65static inline struct $coroutine * active_coroutine() { return active_thread()->curr_cor; }
66
67//-----------------------------------------------------------------------------
68// PRIVATE exposed because of inline
69
70// Start coroutine routines
71extern "C" {
72        void __cfactx_invoke_coroutine(void (*main)(void *), void * this);
73
74        forall(T &)
75        void __cfactx_start(void (*main)(T &), struct $coroutine * cor, T & this, void (*invoke)(void (*main)(void *), void *));
76
77        extern void __cfactx_coroutine_unwind(struct _Unwind_Exception * storage, struct $coroutine *) __attribute__ ((__noreturn__));
78
79        extern void __cfactx_switch( struct __stack_context_t * from, struct __stack_context_t * to ) asm ("__cfactx_switch");
80}
81
82// Private wrappers for context switch and stack creation
83// Wrapper for co
84static inline void $ctx_switch( $coroutine * src, $coroutine * dst ) __attribute__((nonnull (1, 2))) {
85        // set state of current coroutine to inactive
86        src->state = src->state == Halted ? Halted : Blocked;
87
88        // set new coroutine that task is executing
89        active_thread()->curr_cor = dst;
90
91        // context switch to specified coroutine
92        verify( dst->context.SP );
93        __cfactx_switch( &src->context, &dst->context );
94        // when __cfactx_switch returns we are back in the src coroutine
95
96        // set state of new coroutine to active
97        src->state = Active;
98
99        if( unlikely(src->cancellation != 0p) ) {
100                __cfactx_coroutine_unwind(src->cancellation, src);
101        }
102}
103
104extern void __stack_prepare( __stack_info_t * this, size_t size /* ignored if storage already allocated */);
105extern void __stack_clean  ( __stack_info_t * this );
106
107
108// Suspend implementation inlined for performance
109extern "C" {
110        static inline void __cfactx_suspend(void) {
111                // optimization : read TLS once and reuse it
112                // Safety note: this is preemption safe since if
113                // preemption occurs after this line, the pointer
114                // will also migrate which means this value will
115                // stay in syn with the TLS
116                $coroutine * src = active_coroutine();
117
118                assertf( src->last != 0,
119                        "Attempt to suspend coroutine \"%.256s\" (%p) that has never been resumed.\n"
120                        "Possible cause is a suspend executed in a member called by a coroutine user rather than by the coroutine main.",
121                        src->name, src );
122                assertf( src->last->state != Halted,
123                        "Attempt by coroutine \"%.256s\" (%p) to suspend back to terminated coroutine \"%.256s\" (%p).\n"
124                        "Possible cause is terminated coroutine's main routine has already returned.",
125                        src->name, src, src->last->name, src->last );
126
127                $ctx_switch( src, src->last );
128        }
129}
130
131forall(T & | is_coroutine(T))
132void __cfaehm_cancelled_coroutine( T & cor, $coroutine * desc );
133
134// Resume implementation inlined for performance
135forall(T & | is_coroutine(T))
136static inline T & resume(T & cor) {
137        // optimization : read TLS once and reuse it
138        // Safety note: this is preemption safe since if
139        // preemption occurs after this line, the pointer
140        // will also migrate which means this value will
141        // stay in syn with the TLS
142        $coroutine * src = active_coroutine();
143        $coroutine * dst = get_coroutine(cor);
144
145        if( unlikely(dst->context.SP == 0p) ) {
146                __stack_prepare(&dst->stack, 65000);
147                __cfactx_start(main, dst, cor, __cfactx_invoke_coroutine);
148        }
149
150        // not resuming self ?
151        if ( src != dst ) {
152                assertf( dst->state != Halted ,
153                        "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
154                        "Possible cause is terminated coroutine's main routine has already returned.",
155                        src->name, src, dst->name, dst );
156
157                // set last resumer
158                dst->last = src;
159                dst->starter = dst->starter ? dst->starter : src;
160        }
161
162        // always done for performance testing
163        $ctx_switch( src, dst );
164        if ( unlikely(dst->cancellation) ) {
165                __cfaehm_cancelled_coroutine( cor, dst );
166        }
167
168        return cor;
169}
170
171static inline void resume( $coroutine * dst ) __attribute__((nonnull (1))) {
172        // optimization : read TLS once and reuse it
173        // Safety note: this is preemption safe since if
174        // preemption occurs after this line, the pointer
175        // will also migrate which means this value will
176        // stay in syn with the TLS
177        $coroutine * src = active_coroutine();
178
179        // not resuming self ?
180        if ( src != dst ) {
181                assertf( dst->state != Halted ,
182                        "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
183                        "Possible cause is terminated coroutine's main routine has already returned.",
184                        src->name, src, dst->name, dst );
185
186                // set last resumer
187                dst->last = src;
188        }
189
190        // always done for performance testing
191        $ctx_switch( src, dst );
192}
193
194// Local Variables: //
195// mode: c //
196// tab-width: 4 //
197// End: //
Note: See TracBrowser for help on using the repository browser.