OSGThread.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *             Copyright (C) 2000-2002 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 _OSGTHREAD_H_
#define _OSGTHREAD_H_
#ifdef __sgi
#pragma once
#endif

#ifdef OSG_DOC_FILES_IN_MODULE

#endif

#include <OSGSystemDef.h>
#include <OSGBaseTypes.h>
#include <OSGBaseThread.h>

#include <utility>

#include <OSGBaseTypes.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

#ifdef OSG_USE_PTHREADS
#   ifdef OSG_USE_SPROC
#       error  "PTHREAD and SPROC threading models defined. This is a bug!"
#   endif
#   ifdef OSG_USE_WINTHREADS
#       error  "PTHREAD and WINTHREADS threading models defined. This is a bug!"
#   endif
#elif defined(OSG_USE_SPROC)
#   ifdef OSG_USE_WINTHREADS
#       error  "SPROC and WINTHREADS threading models defined. This is a bug!"
#   endif
#endif

OSG_BEGIN_NAMESPACE

class Thread;
class ChangeList;

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

class OSG_SYSTEMLIB_DLLMAPPING ThreadCommonBase : public BaseThread
{
    /*==========================  PUBLIC  =================================*/

  public :

    static const UInt32 InvalidAspect;

    /*---------------------------------------------------------------------*/
    ChangeList *getChangeList(void);

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

  protected:

    typedef BaseThread Inherited;

    /*---------------------------------------------------------------------*/
    UInt32      _uiAspectId;
    ChangeList *_pChangeList;

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

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

    /*---------------------------------------------------------------------*/
    void setAspect    (UInt32      uiAspectId);
    void setChangeList(ChangeList *pChangeList);

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

  private:

    friend class ThreadManager;

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




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

#ifdef OSG_USE_PTHREADS

class PThreadBase : public ThreadCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public :

    /*---------------------------------------------------------------------*/
    static UInt32       getAspect           (void);
    static ChangeList  *getCurrentChangeList(void);

    /*---------------------------------------------------------------------*/
    bool runFunction(ThreadFuncF  fThreadFunc, 
                     UInt32       uiAspectId,
                     void        *pThreadArg);

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

  protected:

    typedef ThreadCommonBase Inherited;

    /*---------------------------------------------------------------------*/
#if defined(OSG_PTHREAD_ELF_TLS)
    static __thread UInt32      _uiTLSAspectId;
    static __thread ChangeList *_pTLSChangeList;
#else
    static pthread_key_t  _aspectKey;
    static pthread_key_t  _changeListKey;
#endif

    /*---------------------------------------------------------------------*/
#if !defined(OSG_PTHREAD_ELF_TLS)
    static void  freeAspect    (void *pAspect);
    static void  freeChangeList(void *pChangeList);
#endif

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

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

    /*---------------------------------------------------------------------*/
    virtual void init           (void);
    
            void setupAspect    (void);
            void setupChangeList(void);

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

  private:

    friend class ThreadManager;

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

typedef PThreadBase ThreadBase;

#endif /* OSG_USE_PTHREADS */




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

#ifdef OSG_USE_SPROC

class SprocBase : public ThreadCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public :

    /*---------------------------------------------------------------------*/
    static UInt32      getAspect           (void);
    static ChangeList *getCurrentChangeList(void);

    /*---------------------------------------------------------------------*/
    bool runFunction(ThreadFuncF  fThreadFunc, 
                     UInt32       uiAspectId,
                     void        *pThreadArg);

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

  protected:

    typedef ThreadCommonBase Inherited;

    struct OSGProcessData : public ProcessData
    {
        UInt32      _uiAspectId;
        ChangeList *_pChangeList;
    };

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

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

    /*---------------------------------------------------------------------*/
    void setAspectInternal(UInt32 uiAspect);

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

            void setupChangeListInternal(void);

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

  private:

    friend class ThreadManager;

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

typedef SprocBase ThreadBase;

#endif /* OSG_USE_SPROC */




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

#ifdef OSG_USE_WINTHREADS

class OSG_SYSTEMLIB_DLLMAPPING WinThreadBase : public ThreadCommonBase
{
    /*==========================  PUBLIC  =================================*/

  public :

    /*---------------------------------------------------------------------*/
    static UInt32      getAspect           (void);
    static ChangeList *getCurrentChangeList(void);

    /*---------------------------------------------------------------------*/
    bool runFunction(ThreadFuncF  fThreadFunc, 
                     UInt32       uiAspectId,
                     void        *pThreadArg);

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

  protected:

    typedef ThreadCommonBase Inherited;

    /*---------------------------------------------------------------------*/
#if defined(OSG_ASPECT_USE_LOCALSTORAGE)
    static UInt32 _aspectKey;
    static UInt32 _changeListKey;
#endif
#if defined(OSG_ASPECT_USE_DECLSPEC)
    static __declspec (thread) UInt32      _uiAspectLocal;
    static __declspec (thread) ChangeList *_pChangeListLocal;
#endif

#ifdef OSG_ASPECT_USE_LOCALSTORAGE
    /*---------------------------------------------------------------------*/
    static void freeAspect    (void);
    static void freeChangeList(void);
#endif

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

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

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

            void setupAspect     (void);
            void setupChangeList (void);

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

  private:

    friend class ThreadManager;

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

typedef WinThreadBase ThreadBase;

#endif /* OSG_USE_WINTHREADS */




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

class OSG_SYSTEMLIB_DLLMAPPING Thread : public ThreadBase
{
    /*=========================  PROTECTED  ===============================*/

  protected:

    typedef ThreadBase Inherited;

    /*==========================  PUBLIC  =================================*/

  public :

    typedef      MPThreadType Type;

    /*---------------------------------------------------------------------*/
    static ThreadBase *getCurrent(      void         );

    static Thread     *get       (const Char8 *szName);
    static Thread     *find      (const Char8 *szName);

    /*---------------------------------------------------------------------*/
    void run(UInt32 uiAspectId);

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

  protected:

    /*---------------------------------------------------------------------*/
    static MPThreadType _type;

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

    static void    initThreading(void);

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

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

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

  private:

    friend class ThreadManager;
    friend class MPFieldStore<BaseThread>;

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



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

class OSG_SYSTEMLIB_DLLMAPPING ExternalThread : public ThreadBase
{
    /*==========================  PUBLIC  =================================*/

  public :

    typedef MPThreadType Type;

    /*---------------------------------------------------------------------*/
    static ThreadBase     *getCurrent(      void         );

    static ExternalThread *get       (const Char8 *szName);
    static ExternalThread *find      (const Char8 *szName);

    /*---------------------------------------------------------------------*/
    void initialize   (UInt32 uiAspectId);

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

  protected:

    typedef ThreadBase Inherited;

    /*---------------------------------------------------------------------*/
    static MPThreadType _type;

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

//    static void            initThreading(void);

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

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

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

  private:

    friend class ThreadManager;
    friend class MPFieldStore<BaseThread>;

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

OSG_END_NAMESPACE

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

#endif /* _OSGTHREAD_H_ */

---