source: libcfa/src/concurrency/invoke.c@ 211228e0

//
// Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// invoke.c --
//
// Author           : Thierry Delisle
// Created On       : Tue Jan 17 12:27:26 2016
// Last Modified By : Peter A. Buhr
// Last Modified On : Fri Feb  9 16:37:42 2018
// Update Count     : 5
//

#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>
#include <unwind.h>

#include "invoke.h"

#define __CFA_INVOKE_PRIVATE__
#include "invoke.h"

// magically invoke the "main" of the most derived class
// Called from the kernel when starting a coroutine or task so must switch back to user mode.

extern void __suspend_internal(void);
extern void __leave_coroutine( struct coroutine_desc * );
extern void __finish_creation( struct coroutine_desc * );
extern void __leave_thread_monitor( struct thread_desc * this );
extern void disable_interrupts();
extern void enable_interrupts( __cfaabi_dbg_ctx_param );

void CtxInvokeCoroutine(
        void (*main)(void *),
        struct coroutine_desc *(*get_coroutine)(void *),
        void *this
) {
        struct coroutine_desc* cor = get_coroutine( this );

        if(cor->state == Primed) {
                __suspend_internal();
        }

        cor->state = Active;

        enable_interrupts( __cfaabi_dbg_ctx );

        main( this );

        //Final suspend, should never return
        __leave_coroutine( cor );
        __cabi_abort( "Resumed dead coroutine" );
}

static _Unwind_Reason_Code _CtxCoroutine_UnwindStop(
        __attribute((__unused__)) int version,
        _Unwind_Action actions,
        __attribute((__unused__)) _Unwind_Exception_Class exceptionClass,
        __attribute((__unused__)) struct _Unwind_Exception * unwind_exception,
        __attribute((__unused__)) struct _Unwind_Context * context,
        void * param
) {
        if( actions & _UA_END_OF_STACK  ) {
                // We finished unwinding the coroutine,
                // leave it
                __leave_coroutine( param );
                __cabi_abort( "Resumed dead coroutine" );
        }
        if( actions & _UA_CLEANUP_PHASE ) return _URC_NO_REASON;

        return _URC_FATAL_PHASE2_ERROR;
}

void _CtxCoroutine_Unwind(struct _Unwind_Exception * storage, struct coroutine_desc * cor) __attribute__ ((__noreturn__));
void _CtxCoroutine_Unwind(struct _Unwind_Exception * storage, struct coroutine_desc * cor) {
        _Unwind_Reason_Code ret = _Unwind_ForcedUnwind( storage, _CtxCoroutine_UnwindStop, cor );
        printf("UNWIND ERROR %d after force unwind\n", ret);
        abort();
}

void CtxInvokeThread(
        void (*dtor)(void *),
        void (*main)(void *),
        struct thread_desc *(*get_thread)(void *),
        void *this
) {
        // Fetch the thread handle from the user defined thread structure
        struct thread_desc* thrd = get_thread( this );

        // First suspend, once the thread arrives here,
        // the function pointer to main can be invalidated without risk
        __finish_creation(&thrd->self_cor);

        // Restore the last to NULL, we clobbered because of the thunk problem
        thrd->self_cor.last = NULL;

        // Officially start the thread by enabling preemption
        enable_interrupts( __cfaabi_dbg_ctx );

        // Call the main of the thread
        main( this );

        // To exit a thread we must :
        // 1 - Mark it as halted
        // 2 - Leave its monitor
        // 3 - Disable the interupts
        // 4 - Final suspend
        // The order of these 4 operations is very important
        //Final suspend, should never return
        __leave_thread_monitor( thrd );
        __cabi_abort( "Resumed dead thread" );
}


void CtxStart(
        void (*main)(void *),
        struct coroutine_desc *(*get_coroutine)(void *),
        void *this,
        void (*invoke)(void *)
) {
        struct coroutine_desc * cor = get_coroutine( this );
        struct __stack_t * stack = cor->stack.storage;

#if defined( __i386 )

        struct FakeStack {
            void *fixedRegisters[3];                    // fixed registers ebx, edi, esi (popped on 1st uSwitch, values unimportant)
            uint32_t mxcr;                        // SSE Status and Control bits (control bits are preserved across function calls)
            uint16_t fcw;                         // X97 FPU control word (preserved across function calls)
            void *rturn;                          // where to go on return from uSwitch
            void *dummyReturn;                          // fake return compiler would have pushed on call to uInvoke
            void *argument[3];                          // for 16-byte ABI, 16-byte alignment starts here
            void *padding;                              // padding to force 16-byte alignment, as "base" is 16-byte aligned
        };

        cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
        cor->context.FP = NULL;         // terminate stack with NULL fp

        struct FakeStack *fs = (struct FakeStack *)cor->context.SP;

        fs->dummyReturn = NULL;
        fs->argument[0] = this;     // argument to invoke
        fs->rturn = invoke;
        fs->mxcr = 0x1F80; //Vol. 2A 3-520
        fs->fcw = 0x037F;  //Vol. 1 8-7

#elif defined( __x86_64 )

        struct FakeStack {
                void *fixedRegisters[5];            // fixed registers rbx, r12, r13, r14, r15
                uint32_t mxcr;                      // SSE Status and Control bits (control bits are preserved across function calls)
                uint16_t fcw;                       // X97 FPU control word (preserved across function calls)
                void *rturn;                        // where to go on return from uSwitch
                void *dummyReturn;                  // NULL return address to provide proper alignment
        };

        cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
        cor->context.FP = NULL;         // terminate stack with NULL fp

        struct FakeStack *fs = (struct FakeStack *)cor->context.SP;

        fs->dummyReturn = NULL;
        fs->rturn = CtxInvokeStub;
        fs->fixedRegisters[0] = this;
        fs->fixedRegisters[1] = invoke;
        fs->mxcr = 0x1F80; //Vol. 2A 3-520
        fs->fcw = 0x037F;  //Vol. 1 8-7

#elif defined( __ARM_ARCH )

        struct FakeStack {
                float fpRegs[16];                       // floating point registers
                void *intRegs[9];                       // integer/pointer registers
                void *arg[2];                           // placeholder for this pointer
        };

        cor->context.SP = (char *)stack->base - sizeof( struct FakeStack );
        cor->context.FP = NULL;

        struct FakeStack *fs = (struct FakeStack *)cor->context.SP;

        fs->intRegs[8] = CtxInvokeStub;
        fs->arg[0] = this;
        fs->arg[1] = invoke;

#else
        #error uknown hardware architecture
#endif
}

// Local Variables: //
// mode: c //
// tab-width: 4 //
// End: //