source: src/libcfa/concurrency/coroutine@ c3acb841

//                              - *- Mode: CFA - *-
//
// 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.
//
// coroutine --
//
// Author           : Thierry Delisle
// Created On       : Mon Nov 28 12:27:26 2016
// Last Modified By : Thierry Delisle
// Last Modified On : Mon Nov 28 12:27:26 2016
// Update Count     : 0
//

#ifndef COROUTINES_H
#define COROUTINES_H

#include "assert"
#include "invoke.h"

//-----------------------------------------------------------------------------
// Coroutine trait
// Anything that implements this trait can be resumed.
// Anything that is resumed is a coroutine.
trait is_coroutine(dtype T) {
      void main(T * this);
      coroutine_desc * get_coroutine(T * this);
};

#define DECL_COROUTINE(X) static inline coroutine_desc* get_coroutine(X* this) { return &this->c; } void main(X* this)

//-----------------------------------------------------------------------------
// Ctors and dtors
void ?{}(coStack_t * this);
void ?{}(coroutine_desc * this);
void ?{}(coroutine_desc * this, const char * name);
void ^?{}(coStack_t * this);
void ^?{}(coroutine_desc * this);

//-----------------------------------------------------------------------------
// Public coroutine API
static inline void suspend();

forall(dtype T | is_coroutine(T))
static inline void resume(T * cor);

forall(dtype T | is_coroutine(T))
void prime(T * cor);

//-----------------------------------------------------------------------------
// PRIVATE exposed because of inline

// Start coroutine routines
extern "C" {
      forall(dtype T | is_coroutine(T))
      void CtxInvokeCoroutine(T * this);

      forall(dtype T | is_coroutine(T))
      void CtxStart(T * this, void ( *invoke)(T *));
}

// Get current coroutine
coroutine_desc * this_coroutine(void);

// Private wrappers for context switch and stack creation
extern void CoroutineCtxSwitch(coroutine_desc * src, coroutine_desc * dst);
extern void create_stack( coStack_t * this, unsigned int storageSize );

// Suspend implementation inlined for performance
static inline void suspend() {
      coroutine_desc * src = this_coroutine();          // optimization

        assertf( src->last != 0,
                "Attempt to suspend coroutine \"%.256s\" (%p) that has never been resumed.\n"
                "Possible cause is a suspend executed in a member called by a coroutine user rather than by the coroutine main.",
                src->name, src );
        assertf( src->last->state != Halted,
                "Attempt by coroutine \"%.256s\" (%p) to suspend back to terminated coroutine \"%.256s\" (%p).\n"
                "Possible cause is terminated coroutine's main routine has already returned.",
                src->name, src, src->last->name, src->last );

        CoroutineCtxSwitch( src, src->last );
}

// Resume implementation inlined for performance
forall(dtype T | is_coroutine(T))
static inline void resume(T * cor) {
        coroutine_desc * src = this_coroutine();                // optimization
        coroutine_desc * dst = get_coroutine(cor);

      if( unlikely(!dst->stack.base) ) {
                create_stack(&dst->stack, dst->stack.size);
                CtxStart(cor, CtxInvokeCoroutine);
        }

      // not resuming self ?
        if ( src != dst ) {
                assertf( dst->state != Halted ,
                        "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
                        "Possible cause is terminated coroutine's main routine has already returned.",
                        src->name, src, dst->name, dst );

            // set last resumer
                dst->last = src;
        } // if

      // always done for performance testing
        CoroutineCtxSwitch( src, dst );
}

static inline void resume(coroutine_desc * dst) {
        coroutine_desc * src = this_coroutine();                // optimization

      // not resuming self ?
        if ( src != dst ) {
                assertf( dst->state != Halted ,
                        "Attempt by coroutine %.256s (%p) to resume terminated coroutine %.256s (%p).\n"
                        "Possible cause is terminated coroutine's main routine has already returned.",
                        src->name, src, dst->name, dst );

            // set last resumer
                dst->last = src;
        } // if

      // always done for performance testing
        CoroutineCtxSwitch( src, dst );
}

#endif //COROUTINES_H

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