| 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.c --
 | 
|---|
| 8 | //
 | 
|---|
| 9 | // Author           : Thierry Delisle
 | 
|---|
| 10 | // Created On       : Tue Jan 17 12:27:26 2016
 | 
|---|
| 11 | // Last Modified By : Peter A. Buhr
 | 
|---|
| 12 | // Last Modified On : Fri Feb  9 16:37:42 2018
 | 
|---|
| 13 | // Update Count     : 5
 | 
|---|
| 14 | //
 | 
|---|
| 15 | 
 | 
|---|
| 16 | #define __cforall_thread__
 | 
|---|
| 17 | 
 | 
|---|
| 18 | #include <stdbool.h>
 | 
|---|
| 19 | #include <stdlib.h>
 | 
|---|
| 20 | #include <stdio.h>
 | 
|---|
| 21 | #include <unwind.h>
 | 
|---|
| 22 | 
 | 
|---|
| 23 | #include "invoke.h"
 | 
|---|
| 24 | 
 | 
|---|
| 25 | #define __CFA_INVOKE_PRIVATE__
 | 
|---|
| 26 | #include "invoke.h"
 | 
|---|
| 27 | 
 | 
|---|
| 28 | // magically invoke the "main" of the most derived class
 | 
|---|
| 29 | // Called from the kernel when starting a coroutine or task so must switch back to user mode.
 | 
|---|
| 30 | 
 | 
|---|
| 31 | extern void __suspend_internal(void);
 | 
|---|
| 32 | extern void __leave_coroutine( struct coroutine_desc * );
 | 
|---|
| 33 | extern void __finish_creation( struct thread_desc * );
 | 
|---|
| 34 | extern void __leave_thread_monitor( struct thread_desc * this );
 | 
|---|
| 35 | extern void disable_interrupts() OPTIONAL_THREAD;
 | 
|---|
| 36 | extern void enable_interrupts( __cfaabi_dbg_ctx_param );
 | 
|---|
| 37 | 
 | 
|---|
| 38 | void CtxInvokeCoroutine(
 | 
|---|
| 39 |         void (*main)(void *),
 | 
|---|
| 40 |         struct coroutine_desc *(*get_coroutine)(void *),
 | 
|---|
| 41 |         void *this
 | 
|---|
| 42 | ) {
 | 
|---|
| 43 |         struct coroutine_desc* cor = get_coroutine( this );
 | 
|---|
| 44 | 
 | 
|---|
| 45 |         if(cor->state == Primed) {
 | 
|---|
| 46 |                 __suspend_internal();
 | 
|---|
| 47 |         }
 | 
|---|
| 48 | 
 | 
|---|
| 49 |         cor->state = Active;
 | 
|---|
| 50 | 
 | 
|---|
| 51 |         main( this );
 | 
|---|
| 52 | 
 | 
|---|
| 53 |         //Final suspend, should never return
 | 
|---|
| 54 |         __leave_coroutine( cor );
 | 
|---|
| 55 |         __cabi_abort( "Resumed dead coroutine" );
 | 
|---|
| 56 | }
 | 
|---|
| 57 | 
 | 
|---|
| 58 | static _Unwind_Reason_Code _CtxCoroutine_UnwindStop(
 | 
|---|
| 59 |         __attribute((__unused__)) int version,
 | 
|---|
| 60 |         _Unwind_Action actions,
 | 
|---|
| 61 |         __attribute((__unused__)) _Unwind_Exception_Class exceptionClass,
 | 
|---|
| 62 |         __attribute((__unused__)) struct _Unwind_Exception * unwind_exception,
 | 
|---|
| 63 |         __attribute((__unused__)) struct _Unwind_Context * context,
 | 
|---|
| 64 |         void * param
 | 
|---|
| 65 | ) {
 | 
|---|
| 66 |         if( actions & _UA_END_OF_STACK  ) {
 | 
|---|
| 67 |                 // We finished unwinding the coroutine,
 | 
|---|
| 68 |                 // leave it
 | 
|---|
| 69 |                 __leave_coroutine( param );
 | 
|---|
| 70 |                 __cabi_abort( "Resumed dead coroutine" );
 | 
|---|
| 71 |         }
 | 
|---|
| 72 |         if( actions & _UA_CLEANUP_PHASE ) return _URC_NO_REASON;
 | 
|---|
| 73 | 
 | 
|---|
| 74 |         return _URC_FATAL_PHASE2_ERROR;
 | 
|---|
| 75 | }
 | 
|---|
| 76 | 
 | 
|---|
| 77 | void _CtxCoroutine_Unwind(struct _Unwind_Exception * storage, struct coroutine_desc * cor) __attribute__ ((__noreturn__));
 | 
|---|
| 78 | void _CtxCoroutine_Unwind(struct _Unwind_Exception * storage, struct coroutine_desc * cor) {
 | 
|---|
| 79 |         _Unwind_Reason_Code ret = _Unwind_ForcedUnwind( storage, _CtxCoroutine_UnwindStop, cor );
 | 
|---|
| 80 |         printf("UNWIND ERROR %d after force unwind\n", ret);
 | 
|---|
| 81 |         abort();
 | 
|---|
| 82 | }
 | 
|---|
| 83 | 
 | 
|---|
| 84 | void CtxInvokeThread(
 | 
|---|
| 85 |         void (*dtor)(void *),
 | 
|---|
| 86 |         void (*main)(void *),
 | 
|---|
| 87 |         struct thread_desc *(*get_thread)(void *),
 | 
|---|
| 88 |         void *this
 | 
|---|
| 89 | ) {
 | 
|---|
| 90 |         // Fetch the thread handle from the user defined thread structure
 | 
|---|
| 91 |         struct thread_desc* thrd = get_thread( this );
 | 
|---|
| 92 | 
 | 
|---|
| 93 |         // First suspend, once the thread arrives here,
 | 
|---|
| 94 |         // the function pointer to main can be invalidated without risk
 | 
|---|
| 95 |         __finish_creation( thrd );
 | 
|---|
| 96 | 
 | 
|---|
| 97 |         // Officially start the thread by enabling preemption
 | 
|---|
| 98 |         enable_interrupts( __cfaabi_dbg_ctx );
 | 
|---|
| 99 | 
 | 
|---|
| 100 |         // Call the main of the thread
 | 
|---|
| 101 |         main( this );
 | 
|---|
| 102 | 
 | 
|---|
| 103 |         // To exit a thread we must :
 | 
|---|
| 104 |         // 1 - Mark it as halted
 | 
|---|
| 105 |         // 2 - Leave its monitor
 | 
|---|
| 106 |         // 3 - Disable the interupts
 | 
|---|
| 107 |         // 4 - Final suspend
 | 
|---|
| 108 |         // The order of these 4 operations is very important
 | 
|---|
| 109 |         //Final suspend, should never return
 | 
|---|
| 110 |         __leave_thread_monitor( thrd );
 | 
|---|
| 111 |         __cabi_abort( "Resumed dead thread" );
 | 
|---|
| 112 | }
 | 
|---|
| 113 | 
 | 
|---|
| 114 | 
 | 
|---|
| 115 | void CtxStart(
 | 
|---|
| 116 |         void (*main)(void *),
 | 
|---|
| 117 |         struct coroutine_desc *(*get_coroutine)(void *),
 | 
|---|
| 118 |         void *this,
 | 
|---|
| 119 |         void (*invoke)(void *)
 | 
|---|
| 120 | ) {
 | 
|---|
| 121 |         struct coroutine_desc * cor = get_coroutine( this );
 | 
|---|
| 122 |         struct __stack_t * stack = cor->stack.storage;
 | 
|---|
| 123 | 
 | 
|---|
| 124 | #if defined( __i386 )
 | 
|---|
| 125 | 
 | 
|---|
| 126 |         struct FakeStack {
 | 
|---|
| 127 |             void *fixedRegisters[3];              // fixed registers ebx, edi, esi (popped on 1st uSwitch, values unimportant)
 | 
|---|
| 128 |             void *rturn;                          // where to go on return from uSwitch
 | 
|---|
| 129 |             void *dummyReturn;                    // fake return compiler would have pushed on call to uInvoke
 | 
|---|
| 130 |             void *argument[3];                    // for 16-byte ABI, 16-byte alignment starts here
 | 
|---|
| 131 |             void *padding;                        // padding to force 16-byte alignment, as "base" is 16-byte aligned
 | 
|---|
| 132 |         };
 | 
|---|
| 133 | 
 | 
|---|
| 134 |         cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
 | 
|---|
| 135 |         cor->context.FP = NULL;         // terminate stack with NULL fp
 | 
|---|
| 136 | 
 | 
|---|
| 137 |         struct FakeStack *fs = (struct FakeStack *)cor->context.SP;
 | 
|---|
| 138 | 
 | 
|---|
| 139 |         fs->dummyReturn = NULL;
 | 
|---|
| 140 |         fs->argument[0] = this;     // argument to invoke
 | 
|---|
| 141 |         fs->rturn = invoke;
 | 
|---|
| 142 | 
 | 
|---|
| 143 | #elif defined( __x86_64 )
 | 
|---|
| 144 | 
 | 
|---|
| 145 |         struct FakeStack {
 | 
|---|
| 146 |                 void *fixedRegisters[5];            // fixed registers rbx, r12, r13, r14, r15
 | 
|---|
| 147 |                 void *rturn;                        // where to go on return from uSwitch
 | 
|---|
| 148 |                 void *dummyReturn;                  // NULL return address to provide proper alignment
 | 
|---|
| 149 |         };
 | 
|---|
| 150 | 
 | 
|---|
| 151 |         cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
 | 
|---|
| 152 |         cor->context.FP = NULL;         // terminate stack with NULL fp
 | 
|---|
| 153 | 
 | 
|---|
| 154 |         struct FakeStack *fs = (struct FakeStack *)cor->context.SP;
 | 
|---|
| 155 | 
 | 
|---|
| 156 |         fs->dummyReturn = NULL;
 | 
|---|
| 157 |         fs->rturn = CtxInvokeStub;
 | 
|---|
| 158 |         fs->fixedRegisters[0] = this;
 | 
|---|
| 159 |         fs->fixedRegisters[1] = invoke;
 | 
|---|
| 160 | 
 | 
|---|
| 161 | #elif defined( __ARM_ARCH )
 | 
|---|
| 162 | 
 | 
|---|
| 163 |         struct FakeStack {
 | 
|---|
| 164 |                 float fpRegs[16];                       // floating point registers
 | 
|---|
| 165 |                 void *intRegs[9];                       // integer/pointer registers
 | 
|---|
| 166 |                 void *arg[2];                           // placeholder for this pointer
 | 
|---|
| 167 |         };
 | 
|---|
| 168 | 
 | 
|---|
| 169 |         cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
 | 
|---|
| 170 |         cor->context.FP = NULL;
 | 
|---|
| 171 | 
 | 
|---|
| 172 |         struct FakeStack *fs = (struct FakeStack *)cor->context.SP;
 | 
|---|
| 173 | 
 | 
|---|
| 174 |         fs->intRegs[8] = CtxInvokeStub;
 | 
|---|
| 175 |         fs->arg[0] = this;
 | 
|---|
| 176 |         fs->arg[1] = invoke;
 | 
|---|
| 177 | 
 | 
|---|
| 178 | #else
 | 
|---|
| 179 |         #error uknown hardware architecture
 | 
|---|
| 180 | #endif
 | 
|---|
| 181 | }
 | 
|---|
| 182 | 
 | 
|---|
| 183 | // Local Variables: //
 | 
|---|
| 184 | // mode: c //
 | 
|---|
| 185 | // tab-width: 4 //
 | 
|---|
| 186 | // End: //
 | 
|---|