OSGBarrier.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *             Copyright (C) 2000-2003 by the OpenSG Forum                   *
 *                                                                           *
 *                            www.opensg.org                                 *
 *                                                                           *
 *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                License                                    *
 *                                                                           *
 * This library is free software; you can redistribute it and/or modify it   *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation, version 2.                               *
 *                                                                           *
 * This library is distributed in the hope that it will be useful, but       *
 * WITHOUT ANY WARRANTY; without even the implied warranty of                *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public         *
 * License along with this library; if not, write to the Free Software       *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                Changes                                    *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
\*---------------------------------------------------------------------------*/

#ifndef _OSGBARRIER_H_
#define _OSGBARRIER_H_
#ifdef __sgi
#pragma once
#endif

#include "OSGBaseTypes.h"
#include "OSGMPBase.h"

#if ! defined (OSG_USE_PTHREADS)   && \
    ! defined (OSG_USE_SPROC)      && \
    ! defined (OSG_USE_WINTHREADS)
#error "No threading model defined,  check your system/compiler combination"
#endif

#if defined (OSG_USE_PTHREADS)
#include <pthread.h>
#endif /* OSG_USE_PTHREADS */

#if defined (OSG_USE_SPROC)
#include <ulocks.h>
#endif /* OSG_USE_SPROC */

OSG_BEGIN_NAMESPACE

template <class MPFieldT>
class MPFieldStore;

//---------------------------------------------------------------------------
//  Class
//---------------------------------------------------------------------------

class OSG_BASE_DLLMAPPING BarrierCommonBase : public MPBase
{
    /*==========================  PUBLIC  =================================*/

  public:

    /*=========================  PROTECTED  ===============================*/

  protected:

    typedef MPBase Inherited;

             UInt32  _uiBarrierId;
    volatile UInt32  _uiNumWaitFor;

    /*---------------------------------------------------------------------*/
    BarrierCommonBase(const Char8 *szName, UInt32 uiId);

    /*---------------------------------------------------------------------*/
    virtual ~BarrierCommonBase(void);

    /*---------------------------------------------------------------------*/
    void setNumWaitFor(UInt32 uiNumWaitFor);

    /*==========================  PRIVATE  ================================*/
  private:

    BarrierCommonBase(const BarrierCommonBase &source);
    void operator =(const BarrierCommonBase &source);
};




//---------------------------------------------------------------------------
//  Class
//---------------------------------------------------------------------------

#if defined (OSG_USE_PTHREADS)

class PThreadBarrierBase : public BarrierCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public:

    /*=========================  PROTECTED  ===============================*/

  protected:

    typedef BarrierCommonBase Inherited;

    /*---------------------------------------------------------------------*/
    PThreadBarrierBase(const Char8 *szName, UInt32 uiId);

    /*---------------------------------------------------------------------*/
    virtual ~PThreadBarrierBase(void);

    /*---------------------------------------------------------------------*/
    bool init    (       void        );

    /*---------------------------------------------------------------------*/
    void shutdown(       void        );

    /*---------------------------------------------------------------------*/
    void enter   (void               );
    void enter   (UInt32 uiNumWaitFor);

    /*==========================  PRIVATE  ================================*/

  private:

    pthread_mutex_t _pLockOne;
    pthread_cond_t  _pWakeupCondition[2];
    UInt32          _uiCount;
    UInt32          _uiCurrentCond;

    PThreadBarrierBase(const PThreadBarrierBase &source);
    void operator =(const PThreadBarrierBase &source);
};

typedef PThreadBarrierBase BarrierBase;

#endif /* OSG_USE_PTHREADS */




//---------------------------------------------------------------------------
//  Class
//---------------------------------------------------------------------------

#if defined (OSG_USE_SPROC)

class SprocBarrierBase : public BarrierCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public:

    /*=========================  PROTECTED  ===============================*/

  protected:

    typedef BarrierCommonBase Inherited;

    /*---------------------------------------------------------------------*/
    SprocBarrierBase(const Char8 *szName, UInt32 uiId);

    /*---------------------------------------------------------------------*/
    virtual ~SprocBarrierBase(void);

    /*---------------------------------------------------------------------*/
    bool init    (void               );

    /*---------------------------------------------------------------------*/
    void shutdown(void               );

    /*---------------------------------------------------------------------*/
    void enter   (void               );
    void enter   (UInt32 uiNumWaitFor);

    /*==========================  PRIVATE  ================================*/

  private:

    barrier_t *_pBarrier;

    SprocBarrierBase(const SprocBarrierBase &source);
    void operator =(const SprocBarrierBase &source);
};

typedef SprocBarrierBase BarrierBase;

#endif /* OSG_USE_SPROC */




//---------------------------------------------------------------------------
//  Class
//---------------------------------------------------------------------------

#if defined (OSG_USE_WINTHREADS)

class OSG_BASE_DLLMAPPING WinThreadBarrierBase : public BarrierCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public:

    /*=========================  PROTECTED  ===============================*/

  protected:

    /*---------------------------------------------------------------------*/
    WinThreadBarrierBase(const Char8 *szName, UInt32 uiId);

    /*---------------------------------------------------------------------*/
    virtual ~WinThreadBarrierBase(void);

    /*---------------------------------------------------------------------*/
    bool init    (void               );

    /*---------------------------------------------------------------------*/
    void shutdown(void               );

    /*---------------------------------------------------------------------*/
    void enter   (void               );
    void enter   (UInt32 uiNumWaitFor);

    /*==========================  PRIVATE  ================================*/

  private:

    typedef BarrierCommonBase Inherited;

             Handle _pMutex1;
             Handle _pBarrierSema;
    volatile UInt32 _uiNumWaiters;

    WinThreadBarrierBase(const WinThreadBarrierBase &source);
    void operator =(const WinThreadBarrierBase &source);
};

typedef WinThreadBarrierBase BarrierBase;

#endif /* OSG_USE_WINTHREADS */




//---------------------------------------------------------------------------
//  Class
//---------------------------------------------------------------------------

class OSG_BASE_DLLMAPPING Barrier : public BarrierBase
{
    /*==========================  PUBLIC  =================================*/

  public:

    typedef MPBarrierType Type;

    /*---------------------------------------------------------------------*/
    static       Barrier       *get         (const Char8 *szName);
    static       Barrier       *find        (const Char8 *szName);

    static       Barrier       *create      (      void         );

    static const MPBarrierType &getClassType(      void         );

    /*---------------------------------------------------------------------*/
    void enter(void               );
    void enter(UInt32 uiNumWaitFor);

    /*=========================  PROTECTED  ===============================*/

  protected:

    typedef BarrierBase Inherited;

    static MPBarrierType _type;

    /*---------------------------------------------------------------------*/
    Barrier(const Char8 *szName, UInt32 uiId);

    /*---------------------------------------------------------------------*/
    virtual ~Barrier(void);

    /*---------------------------------------------------------------------*/
    static Barrier *create(const Char8  *szName,
                                 UInt32  uiId);

    /*==========================  PRIVATE  ================================*/

  private:

    friend class MPFieldStore<Barrier>;

    Barrier(const Barrier &source);
    void operator =(const Barrier &source);
};

OSG_END_NAMESPACE

#define OSGBARRIER_HEADER_CVSID "@(#)$Id: $"

#include "OSGBarrier.inl"

#endif /* _OSGBARRIER_H_ */

---