[8def349] | 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 | // invoke.h --
|
---|
| 8 | //
|
---|
| 9 | // Author : Thierry Delisle
|
---|
| 10 | // Created On : Tue Jan 17 12:27:26 2016
|
---|
[6b0b624] | 11 | // Last Modified By : Peter A. Buhr
|
---|
[09d4b22] | 12 | // Last Modified On : Thu Dec 5 16:26:03 2019
|
---|
| 13 | // Update Count : 44
|
---|
[8def349] | 14 | //
|
---|
| 15 |
|
---|
[73abe95] | 16 | #include "bits/containers.hfa"
|
---|
| 17 | #include "bits/defs.hfa"
|
---|
| 18 | #include "bits/locks.hfa"
|
---|
[3e2b9c9] | 19 | #include "kernel/fwd.hfa"
|
---|
[78b3f52] | 20 |
|
---|
[0cf5b79] | 21 | #ifdef __cforall
|
---|
[5c81105] | 22 | extern "C" {
|
---|
| 23 | #endif
|
---|
| 24 |
|
---|
| 25 | #if ! defined(__CFA_INVOKE_PRIVATE__)
|
---|
[78b3f52] | 26 | #ifndef _INVOKE_H_
|
---|
| 27 | #define _INVOKE_H_
|
---|
| 28 |
|
---|
[80ec409] | 29 | struct __cfaehm_try_resume_node;
|
---|
| 30 | struct __cfaehm_base_exception_t;
|
---|
| 31 | struct exception_context_t {
|
---|
| 32 | struct __cfaehm_try_resume_node * top_resume;
|
---|
| 33 | struct __cfaehm_base_exception_t * current_exception;
|
---|
| 34 | };
|
---|
| 35 |
|
---|
[b2f6113] | 36 | struct __stack_context_t {
|
---|
| 37 | void * SP;
|
---|
| 38 | void * FP;
|
---|
| 39 | };
|
---|
| 40 |
|
---|
| 41 | // low adresses : +----------------------+ <- start of allocation
|
---|
| 42 | // | optional guard page |
|
---|
| 43 | // +----------------------+ <- __stack_t.limit
|
---|
| 44 | // | |
|
---|
| 45 | // | /\ /\ /\ |
|
---|
| 46 | // | || || || |
|
---|
| 47 | // | |
|
---|
| 48 | // | program stack |
|
---|
| 49 | // | |
|
---|
| 50 | // __stack_info_t.storage -> +----------------------+ <- __stack_t.base
|
---|
| 51 | // | __stack_t |
|
---|
| 52 | // high adresses : +----------------------+ <- end of allocation
|
---|
| 53 |
|
---|
| 54 | struct __stack_t {
|
---|
| 55 | // stack grows towards stack limit
|
---|
| 56 | void * limit;
|
---|
| 57 |
|
---|
| 58 | // base of stack
|
---|
| 59 | void * base;
|
---|
[80ec409] | 60 |
|
---|
| 61 | // Information for exception handling.
|
---|
| 62 | struct exception_context_t exception_context;
|
---|
[b2f6113] | 63 | };
|
---|
| 64 |
|
---|
| 65 | struct __stack_info_t {
|
---|
| 66 | // pointer to stack
|
---|
| 67 | struct __stack_t * storage;
|
---|
[025278e] | 68 | };
|
---|
| 69 |
|
---|
[ff79d5e] | 70 | enum __Coroutine_State { Halted, Start, Primed, Blocked, Ready, Active };
|
---|
[025278e] | 71 |
|
---|
[ac2b598] | 72 | struct $coroutine {
|
---|
[c7a900a] | 73 | // context that is switch during a __cfactx_switch
|
---|
[b2f6113] | 74 | struct __stack_context_t context;
|
---|
| 75 |
|
---|
[76e069f] | 76 | // stack information of the coroutine
|
---|
[b2f6113] | 77 | struct __stack_info_t stack;
|
---|
[76e069f] | 78 |
|
---|
[e8e457e] | 79 | // textual name for coroutine/task
|
---|
[76e069f] | 80 | const char * name;
|
---|
| 81 |
|
---|
| 82 | // current execution status for coroutine
|
---|
[ff79d5e] | 83 | enum __Coroutine_State state;
|
---|
[b2f6113] | 84 |
|
---|
[76e069f] | 85 | // first coroutine to resume this one
|
---|
[ac2b598] | 86 | struct $coroutine * starter;
|
---|
[76e069f] | 87 |
|
---|
| 88 | // last coroutine to resume this one
|
---|
[ac2b598] | 89 | struct $coroutine * last;
|
---|
[76e069f] | 90 |
|
---|
| 91 | // If non-null stack must be unwound with this exception
|
---|
| 92 | struct _Unwind_Exception * cancellation;
|
---|
| 93 |
|
---|
[025278e] | 94 | };
|
---|
| 95 |
|
---|
[80ec409] | 96 | static inline struct __stack_t * __get_stack( struct $coroutine * cor ) {
|
---|
| 97 | return (struct __stack_t*)(((uintptr_t)cor->stack.storage) & ((uintptr_t)-2));
|
---|
| 98 | }
|
---|
[210b8b3] | 99 |
|
---|
[5715d43] | 100 | struct exception_context_t * this_exception_context();
|
---|
| 101 |
|
---|
[f23b685] | 102 | // struct which calls the monitor is accepting
|
---|
[025278e] | 103 | struct __waitfor_mask_t {
|
---|
| 104 | // the index of the accepted function, -1 if none
|
---|
| 105 | short * accepted;
|
---|
| 106 |
|
---|
| 107 | // list of acceptable functions, null if any
|
---|
[b1672e1] | 108 | __cfa_anonymous_object( __small_array_t(struct __acceptable_t) );
|
---|
[025278e] | 109 | };
|
---|
| 110 |
|
---|
[ac2b598] | 111 | struct $monitor {
|
---|
[025278e] | 112 | // spinlock to protect internal data
|
---|
[ea7d2b0] | 113 | struct __spinlock_t lock;
|
---|
[025278e] | 114 |
|
---|
| 115 | // current owner of the monitor
|
---|
[ac2b598] | 116 | struct $thread * owner;
|
---|
[025278e] | 117 |
|
---|
| 118 | // queue of threads that are blocked waiting for the monitor
|
---|
[ac2b598] | 119 | __queue_t(struct $thread) entry_queue;
|
---|
[025278e] | 120 |
|
---|
| 121 | // stack of conditions to run next once we exit the monitor
|
---|
[0cf5b79] | 122 | __stack_t(struct __condition_criterion_t) signal_stack;
|
---|
[025278e] | 123 |
|
---|
| 124 | // monitor routines can be called recursively, we need to keep track of that
|
---|
| 125 | unsigned int recursion;
|
---|
| 126 |
|
---|
| 127 | // mask used to know if some thread is waiting for something while holding the monitor
|
---|
| 128 | struct __waitfor_mask_t mask;
|
---|
| 129 |
|
---|
| 130 | // node used to signal the dtor in a waitfor dtor
|
---|
| 131 | struct __condition_node_t * dtor_node;
|
---|
| 132 | };
|
---|
| 133 |
|
---|
| 134 | struct __monitor_group_t {
|
---|
| 135 | // currently held monitors
|
---|
[ac2b598] | 136 | __cfa_anonymous_object( __small_array_t($monitor*) );
|
---|
[025278e] | 137 |
|
---|
| 138 | // last function that acquired monitors
|
---|
[c1a9c86] | 139 | fptr_t func;
|
---|
[025278e] | 140 | };
|
---|
| 141 |
|
---|
[b798713] | 142 | // Link lists fields
|
---|
| 143 | // instrusive link field for threads
|
---|
| 144 | struct __thread_desc_link {
|
---|
[6a490b2] | 145 | struct $thread * next;
|
---|
| 146 | struct $thread * prev;
|
---|
[1b143de] | 147 | volatile unsigned long long ts;
|
---|
[d72c074] | 148 | int preferred;
|
---|
[b798713] | 149 | };
|
---|
| 150 |
|
---|
[ac2b598] | 151 | struct $thread {
|
---|
[025278e] | 152 | // Core threading fields
|
---|
[c7a900a] | 153 | // context that is switch during a __cfactx_switch
|
---|
[e8e457e] | 154 | struct __stack_context_t context;
|
---|
| 155 |
|
---|
| 156 | // current execution status for coroutine
|
---|
[ff79d5e] | 157 | volatile int ticket;
|
---|
| 158 | enum __Coroutine_State state:8;
|
---|
| 159 | enum __Preemption_Reason preempted:8;
|
---|
[e8e457e] | 160 |
|
---|
[5c1a531] | 161 | //SKULLDUGGERY errno is not save in the thread data structure because returnToKernel appears to be the only function to require saving and restoring it
|
---|
| 162 |
|
---|
[37ba662] | 163 | // pointer to the cluster on which the thread is running
|
---|
| 164 | struct cluster * curr_cluster;
|
---|
| 165 |
|
---|
| 166 | // Link lists fields
|
---|
| 167 | // instrusive link field for threads
|
---|
| 168 | struct __thread_desc_link link;
|
---|
| 169 |
|
---|
[025278e] | 170 | // coroutine body used to store context
|
---|
[ac2b598] | 171 | struct $coroutine self_cor;
|
---|
[025278e] | 172 |
|
---|
[82c948c] | 173 | // current active context
|
---|
[ac2b598] | 174 | struct $coroutine * curr_cor;
|
---|
[82c948c] | 175 |
|
---|
[025278e] | 176 | // monitor body used for mutual exclusion
|
---|
[ac2b598] | 177 | struct $monitor self_mon;
|
---|
[025278e] | 178 |
|
---|
| 179 | // pointer to monitor with sufficient lifetime for current monitors
|
---|
[ac2b598] | 180 | struct $monitor * self_mon_p;
|
---|
[025278e] | 181 |
|
---|
| 182 | // monitors currently held by this thread
|
---|
| 183 | struct __monitor_group_t monitors;
|
---|
| 184 |
|
---|
[de94a60] | 185 | struct {
|
---|
[ac2b598] | 186 | struct $thread * next;
|
---|
| 187 | struct $thread * prev;
|
---|
[de94a60] | 188 | } node;
|
---|
[ae66348] | 189 |
|
---|
| 190 | #ifdef __CFA_DEBUG__
|
---|
| 191 | // previous function to park/unpark the thread
|
---|
[ae7be7a] | 192 | const char * park_caller;
|
---|
[ff79d5e] | 193 | int park_result;
|
---|
| 194 | enum __Coroutine_State park_state;
|
---|
[ae66348] | 195 | bool park_stale;
|
---|
[ae7be7a] | 196 | const char * unpark_caller;
|
---|
[ff79d5e] | 197 | int unpark_result;
|
---|
| 198 | enum __Coroutine_State unpark_state;
|
---|
[ae66348] | 199 | bool unpark_stale;
|
---|
| 200 | #endif
|
---|
[212c2187] | 201 | };
|
---|
| 202 |
|
---|
[ae66348] | 203 | #ifdef __CFA_DEBUG__
|
---|
| 204 | void __cfaabi_dbg_record_thrd($thread & this, bool park, const char prev_name[]);
|
---|
| 205 | #else
|
---|
| 206 | #define __cfaabi_dbg_record_thrd(x, y, z)
|
---|
| 207 | #endif
|
---|
| 208 |
|
---|
[212c2187] | 209 | #ifdef __cforall
|
---|
| 210 | extern "Cforall" {
|
---|
[6a490b2] | 211 |
|
---|
[ac2b598] | 212 | static inline $thread *& get_next( $thread & this ) __attribute__((const)) {
|
---|
[b798713] | 213 | return this.link.next;
|
---|
[0cf5b79] | 214 | }
|
---|
| 215 |
|
---|
[ac2b598] | 216 | static inline [$thread *&, $thread *& ] __get( $thread & this ) __attribute__((const)) {
|
---|
[de94a60] | 217 | return this.node.[next, prev];
|
---|
| 218 | }
|
---|
| 219 |
|
---|
[0cf5b79] | 220 | static inline void ?{}(__monitor_group_t & this) {
|
---|
[121be3e] | 221 | (this.data){0p};
|
---|
[0cf5b79] | 222 | (this.size){0};
|
---|
| 223 | (this.func){NULL};
|
---|
| 224 | }
|
---|
| 225 |
|
---|
[ac2b598] | 226 | static inline void ?{}(__monitor_group_t & this, struct $monitor ** data, __lock_size_t size, fptr_t func) {
|
---|
[0cf5b79] | 227 | (this.data){data};
|
---|
| 228 | (this.size){size};
|
---|
| 229 | (this.func){func};
|
---|
[025278e] | 230 | }
|
---|
| 231 |
|
---|
[8c50aed] | 232 | static inline bool ?==?( const __monitor_group_t & lhs, const __monitor_group_t & rhs ) __attribute__((const)) {
|
---|
[0cf5b79] | 233 | if( (lhs.data != 0) != (rhs.data != 0) ) return false;
|
---|
[025278e] | 234 | if( lhs.size != rhs.size ) return false;
|
---|
| 235 | if( lhs.func != rhs.func ) return false;
|
---|
| 236 |
|
---|
| 237 | // Check that all the monitors match
|
---|
| 238 | for( int i = 0; i < lhs.size; i++ ) {
|
---|
| 239 | // If not a match, check next function
|
---|
| 240 | if( lhs[i] != rhs[i] ) return false;
|
---|
| 241 | }
|
---|
| 242 |
|
---|
| 243 | return true;
|
---|
| 244 | }
|
---|
[0cf5b79] | 245 |
|
---|
| 246 | static inline void ?=?(__monitor_group_t & lhs, const __monitor_group_t & rhs) {
|
---|
| 247 | lhs.data = rhs.data;
|
---|
| 248 | lhs.size = rhs.size;
|
---|
| 249 | lhs.func = rhs.func;
|
---|
| 250 | }
|
---|
[025278e] | 251 | }
|
---|
| 252 | #endif
|
---|
[b18830e] | 253 |
|
---|
[5c81105] | 254 | #endif //_INVOKE_H_
|
---|
| 255 | #else //! defined(__CFA_INVOKE_PRIVATE__)
|
---|
| 256 | #ifndef _INVOKE_PRIVATE_H_
|
---|
| 257 | #define _INVOKE_PRIVATE_H_
|
---|
[b227f68] | 258 |
|
---|
[025278e] | 259 | struct machine_context_t {
|
---|
| 260 | void *SP;
|
---|
| 261 | void *FP;
|
---|
| 262 | void *PC;
|
---|
| 263 | };
|
---|
| 264 |
|
---|
| 265 | // assembler routines that performs the context switch
|
---|
[c7a900a] | 266 | extern void __cfactx_invoke_stub( void );
|
---|
| 267 | extern void __cfactx_switch( struct __stack_context_t * from, struct __stack_context_t * to ) asm ("__cfactx_switch");
|
---|
[212c2187] | 268 | // void CtxStore ( void * this ) asm ("CtxStore");
|
---|
| 269 | // void CtxRet ( void * dst ) asm ("CtxRet");
|
---|
[025278e] | 270 |
|
---|
[5c81105] | 271 | #endif //_INVOKE_PRIVATE_H_
|
---|
| 272 | #endif //! defined(__CFA_INVOKE_PRIVATE__)
|
---|
[0cf5b79] | 273 | #ifdef __cforall
|
---|
[5c81105] | 274 | }
|
---|
| 275 | #endif
|
---|
[6b0b624] | 276 |
|
---|
| 277 | // Local Variables: //
|
---|
| 278 | // mode: c //
|
---|
| 279 | // tab-width: 4 //
|
---|
| 280 | // End: //
|
---|