ccoroutine.h

//==========================================================================
//   CCOROUTINE.H  -  header for
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __OMNETPP_CCOROUTINE_H
#define __OMNETPP_CCOROUTINE_H

#include "platdep/platmisc.h"  // for <windows.h>
#include "simkerneldefs.h"

#if !defined(USE_WIN32_FIBERS) && !defined(USE_POSIX_COROUTINES) && !defined(USE_PORTABLE_COROUTINES)
#error "Coroutine library choice not specified"
#endif

#ifdef USE_POSIX_COROUTINES
#include <ucontext.h>
#endif

namespace omnetpp {

#ifdef USE_PORTABLE_COROUTINES
struct _Task;
#endif

typedef void (*CoroutineFnp)( void * );

//--------------------------------------------------------------------------

class SIM_API cCoroutine
{
  protected:
#ifdef USE_WIN32_FIBERS
    LPVOID lpFiber;
    static LPVOID lpMainFiber;
    unsigned stackSize;
#endif
#ifdef USE_POSIX_COROUTINES
    static ucontext_t mainContext;
    static ucontext_t *curContextPtr;
    static unsigned totalStackLimit;
    static unsigned totalStackUsage;
    unsigned stackSize;
    char *stackPtr;
    ucontext_t context;
#endif
#ifdef USE_PORTABLE_COROUTINES
    _Task *task;
#endif

  public:

    static void init(unsigned totalStack, unsigned mainStack);

    static void switchTo(cCoroutine *cor);

    static void switchToMain();


    bool setup(CoroutineFnp fnp, void *arg, unsigned stackSize);

    cCoroutine();

    virtual ~cCoroutine();


    virtual bool hasStackOverflow() const;

    virtual unsigned getStackSize() const;

    virtual unsigned getStackUsage() const;
};

}  // namespace omnetpp


#endif