Source/Base/Threading/OSGCondVar.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2003 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGCONDVAR_H_
  40 #define _OSGCONDVAR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBaseTypes.h"
  46 #include "OSGMPBase.h"
  47
  48 #if ! defined (OSG_USE_PTHREADS)   && \
  49     ! defined (OSG_USE_SPROC)      && \
  50     ! defined (OSG_USE_WINTHREADS)
  51 #error "No threading model defined,  check your system/compiler combination"
  52 #endif
  53
  54 #if defined (OSG_USE_PTHREADS)
  55 #include <pthread.h>
  56 #include <cerrno>
  57 #endif
  58
  59 #if defined (OSG_USE_SPROC)
  60 #include <ulocks.h>
  61 #endif
  62
  63 #include <boost/mpl/if.hpp>
  64
  65 OSG_BEGIN_NAMESPACE
  66
  67 template <class MPFieldT>
  68 class MPFieldStore;
  69
  70 //---------------------------------------------------------------------------
  71 //  Class
  72 //---------------------------------------------------------------------------
  73
  74 /*! \ingroup GrpBaseMultiThreading
  75     \ingroup GrpLibOSGBase
  76  */
  77
  78 class OSG_BASE_DLLMAPPING CondVarCommonBase : public MPBase
  79 {
  80     /*==========================  PUBLIC  =================================*/
  81
  82   public:
  83
  84     /*=========================  PROTECTED  ===============================*/
  85
  86   protected:
  87
  88     typedef MPBase  Inherited;
  89
  90             UInt32 _uiCondVarId;
  91
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                   Constructors                               */
  94     /*! \{                                                                 */
  95
  96     CondVarCommonBase(void);
  97     CondVarCommonBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Destructor                                 */
 102     /*! \{                                                                 */
 103
 104     virtual ~CondVarCommonBase(void);
 105
 106     /*! \}                                                                 */
 107     /*==========================  PRIVATE  ================================*/
 108
 109   private:
 110
 111     /*!\brief prohibit default function (move to 'public' if needed) */
 112     CondVarCommonBase  (const CondVarCommonBase &source);
 113     /*!\brief prohibit default function (move to 'public' if needed) */
 114     void operator = (const CondVarCommonBase &source);
 115 };
 116
 117
 118
 119
 120 //---------------------------------------------------------------------------
 121 //  Class
 122 //---------------------------------------------------------------------------
 123
 124 #if defined (OSG_USE_PTHREADS)
 125
 126 /*! \ingroup GrpBaseMultiThreading
 127     \ingroup GrpLibOSGBase
 128  */
 129
 130 class PThreadCondVarBase : public CondVarCommonBase
 131 {
 132     /*==========================  PUBLIC  =================================*/
 133
 134   public :
 135
 136     /*=========================  PROTECTED  ===============================*/
 137
 138   protected:
 139
 140     typedef CondVarCommonBase Inherited;
 141
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                   Constructors                               */
 144     /*! \{                                                                 */
 145
 146     PThreadCondVarBase(void);
 147     PThreadCondVarBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                   Destructor                                 */
 152     /*! \{                                                                 */
 153
 154     virtual ~PThreadCondVarBase(void);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                  Construction                                */
 159     /*! \{                                                                 */
 160
 161     bool init    (void);
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                  Destruction                                 */
 166     /*! \{                                                                 */
 167
 168     void shutdown(void);
 169
 170     /*! \}                                                                 */
 171     /*---------------------------------------------------------------------*/
 172     /*! \name                   CondVar                                    */
 173     /*! \{                                                                 */
 174
 175     void acquire(void);
 176     void release(void);
 177     bool request(void);
 178     bool wait(const Int32 timeToWait = -1);
 179     void signal();
 180     void broadcast();
 181
 182     /*! \}                                                                 */
 183     /*==========================  PRIVATE  ================================*/
 184
 185   private:
 186
 187     // XXX: We should make it so we can pass in a mutex some way.
 188     //CondVarCommonBase
 189     pthread_mutex_t _pLowLevelLock;
 190     pthread_cond_t _pLowLevelCondVar;
 191
 192     /*!\brief prohibit default function (move to 'public' if needed) */
 193     PThreadCondVarBase(const PThreadCondVarBase &source);
 194     /*!\brief prohibit default function (move to 'public' if needed) */
 195     void operator =(const PThreadCondVarBase &source);
 196 };
 197
 198 typedef PThreadCondVarBase CondVarBase;
 199
 200 #endif /* OSG_USE_PTHREADS */
 201
 202
 203
 204
 205 //---------------------------------------------------------------------------
 206 //  Class
 207 //---------------------------------------------------------------------------
 208
 209 #if defined (OSG_USE_SPROC)
 210
 211 /*! \ingroup GrpBaseMultiThreading
 212     \ingroup GrpLibOSGBase
 213  */
 214
 215 class SprocCondVarBase : public CondVarCommonBase
 216 {
 217     /*==========================  PUBLIC  =================================*/
 218
 219   public :
 220
 221     /*=========================  PROTECTED  ===============================*/
 222
 223   protected:
 224
 225     typedef CondVarCommonBase Inherited;
 226
 227     /*---------------------------------------------------------------------*/
 228     /*! \name                   Constructors                               */
 229     /*! \{                                                                 */
 230
 231     SprocCondVarBase(void);
 232     SprocCondVarBase(const Char8 *szName, UInt32 uiId  );
 233
 234     /*! \}                                                                 */
 235     /*---------------------------------------------------------------------*/
 236     /*! \name                   Destructor                                 */
 237     /*! \{                                                                 */
 238
 239     virtual ~SprocCondVarBase(void);
 240
 241     /*! \}                                                                 */
 242     /*---------------------------------------------------------------------*/
 243     /*! \name                   Construction                               */
 244     /*! \{                                                                 */
 245
 246     bool init    (void);
 247
 248     /*! \}                                                                 */
 249     /*---------------------------------------------------------------------*/
 250     /*! \name                   Destruction                                */
 251     /*! \{                                                                 */
 252
 253     void shutdown(void);
 254
 255     /*! \}                                                                 */
 256     /*---------------------------------------------------------------------*/
 257     /*! \name                    CondVar                                   */
 258     /*! \{                                                                 */
 259
 260     void acquire(void);
 261     void release(void);
 262     bool request(void);
 263     bool wait(const Int32 timeToWait = -1);
 264     void signal();
 265     void broadcast();
 266
 267     /*! \}                                                                 */
 268     /*==========================  PRIVATE  ================================*/
 269
 270   private:
 271
 272 #define OSG_SPROC_USE_LOCK
 273 #ifdef OSG_SPROC_USE_LOCK
 274     ulock_t  _pLowLevelLock;
 275 #else
 276     usema_t *_pLowLevelSema;
 277 #endif
 278
 279     /*!\brief prohibit default function (move to 'public' if needed) */
 280     SprocCondVarBase(const SprocCondVarBase &source);
 281     /*!\brief prohibit default function (move to 'public' if needed) */
 282     void operator =(const SprocCondVarBase &source);
 283 };
 284
 285 typedef SprocCondVarBase CondVarBase;
 286
 287 #endif /* OSG_USE_SPROC */
 288
 289
 290
 291
 292 //---------------------------------------------------------------------------
 293 //  Class
 294 //---------------------------------------------------------------------------
 295
 296 #if defined (OSG_USE_WINTHREADS)
 297
 298 /*! \ingroup GrpBaseMultiThreading
 299     \ingroup GrpLibOSGBase
 300     \nohierarchy
 301  */
 302
 303 typedef struct
 304 {
 305     // Number of waiting threads.
 306     int waiters_count_;
 307
 308     // Serialize access to <waiters_count_>.
 309     CRITICAL_SECTION waiters_count_lock_;
 310
 311     // Semaphore used to queue up threads waiting for the condition to
 312     // become signaled.
 313     HANDLE sema_;
 314
 315     // An auto-reset event used by the broadcast/signal thread to wait
 316     // for all the waiting thread(s) to wake up and be released from the
 317     // semaphore.
 318     HANDLE waiters_done_;
 319
 320     // Keeps track of whether we were broadcasting or signaling.  This
 321     // allows us to optimize the code if we're just signaling.
 322     size_t was_broadcast_;
 323 } pthread_cond_t;
 324
 325 typedef HANDLE pthread_mutex_t;
 326
 327 /*! \ingroup GrpBaseMultiThreading
 328  */
 329 int pthread_cond_init(pthread_cond_t *cv, void* dummy);
 330
 331 /*! \ingroup GrpBaseMultiThreading
 332  */
 333 int pthread_cond_wait(pthread_cond_t *cv,
 334                       pthread_mutex_t *external_mutex);
 335
 336 /*! \ingroup GrpBaseMultiThreading
 337  */
 338 int pthread_cond_signal(pthread_cond_t *cv);
 339
 340 /*! \ingroup GrpBaseMultiThreading
 341  */
 342 int pthread_cond_broadcast(pthread_cond_t *cv);
 343
 344 /*! \ingroup GrpBaseMultiThreading
 345     \ingroup GrpLibOSGBase
 346  */
 347
 348 class OSG_BASE_DLLMAPPING WinThreadCondVarBase : public CondVarCommonBase
 349 {
 350     /*==========================  PUBLIC  =================================*/
 351
 352   public :
 353
 354     /*=========================  PROTECTED  ===============================*/
 355
 356   protected:
 357
 358     typedef CondVarCommonBase Inherited;
 359
 360     /*---------------------------------------------------------------------*/
 361     /*! \name                   Constructors                               */
 362     /*! \{                                                                 */
 363
 364     WinThreadCondVarBase(void);
 365     WinThreadCondVarBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 366
 367     /*! \}                                                                 */
 368     /*---------------------------------------------------------------------*/
 369     /*! \name                   Destructor                                 */
 370     /*! \{                                                                 */
 371
 372     virtual ~WinThreadCondVarBase(void);
 373
 374     /*! \}                                                                 */
 375     /*---------------------------------------------------------------------*/
 376     /*! \name                   Construction                               */
 377     /*! \{                                                                 */
 378
 379     bool init    (void);
 380
 381     /*! \}                                                                 */
 382     /*---------------------------------------------------------------------*/
 383     /*! \name                   Destruction                                */
 384     /*! \{                                                                 */
 385
 386     void shutdown(void);
 387
 388     /*! \}                                                                 */
 389     /*---------------------------------------------------------------------*/
 390     /*! \name                       CondVar                                */
 391     /*! \{                                                                 */
 392
 393     void acquire(void);
 394     void release(void);
 395     bool request(void);
 396     bool wait(const Int32 timeToWait = -1);
 397     void signal();
 398     void broadcast();
 399
 400     /*! \}                                                                 */
 401     /*==========================  PRIVATE  ================================*/
 402   private:
 403
 404     Handle  _pMutex;
 405
 406     int waiters_count_;
 407     // Number of waiting threads.
 408
 409     CRITICAL_SECTION waiters_count_lock_;
 410     // Serialize access to <waiters_count_>.
 411
 412     HANDLE sema_;
 413     // Semaphore used to queue up threads waiting for the condition to
 414     // become signaled.
 415
 416     HANDLE waiters_done_;
 417     // An auto-reset event used by the broadcast/signal thread to wait
 418     // for all the waiting thread(s) to wake up and be released from the
 419     // semaphore.
 420
 421     // Keeps track of whether we were broadcasting or signaling.  This
 422     // allows us to optimize the code if we're just signaling.
 423     size_t was_broadcast_;
 424
 425
 426     /*!\brief prohibit default function (move to 'public' if needed) */
 427     WinThreadCondVarBase(const WinThreadCondVarBase &source);
 428     /*!\brief prohibit default function (move to 'public' if needed) */
 429     void operator =(const WinThreadCondVarBase &source);
 430 };
 431
 432 typedef WinThreadCondVarBase CondVarBase;
 433
 434 #endif /* OSG_USE_WINTHREADS */
 435
 436
 437
 438
 439 //---------------------------------------------------------------------------
 440 //  Class
 441 //---------------------------------------------------------------------------
 442
 443 /*! \ingroup GrpBaseMultiThreading
 444     \ingroup GrpLibOSGBase
 445  */
 446
 447 class OSG_BASE_DLLMAPPING CondVar : public CondVarBase
 448 {
 449     /*==========================  PUBLIC  =================================*/
 450
 451   public:
 452
 453     typedef MPCondVarType Type;
 454
 455     OSG_GEN_INTERNAL_MEMOBJPTR(CondVar);
 456
 457     /*---------------------------------------------------------------------*/
 458     /*! \name                      Get                                     */
 459     /*! \{                                                                 */
 460
 461     static       ObjTransitPtr  get         (const Char8 *szName,
 462                                                    bool   bGlobal);
 463     static       CondVar       *find        (const Char8 *szName );
 464
 465     static       ObjTransitPtr  create      (      void          );
 466
 467     static const MPCondVarType &getClassType(      void          );
 468
 469     /*! \}                                                                 */
 470     /*---------------------------------------------------------------------*/
 471     /*! \name                       CondVar                                */
 472     /*! \{                                                                 */
 473
 474     void acquire(void);
 475     void release(void);
 476     bool request(void);
 477     bool wait(const Int32 timeToWait = -1);
 478     void signal();
 479     void broadcast();
 480
 481     /*! \}                                                                 */
 482     /*=========================  PROTECTED  ===============================*/
 483
 484   protected:
 485
 486     typedef CondVarBase    Inherited;
 487
 488     static  MPCondVarType _type;
 489
 490     /*---------------------------------------------------------------------*/
 491     /*! \name                   Construction                               */
 492     /*! \{                                                                 */
 493
 494     static CondVar *create(const Char8 *szName, UInt32 uiId, bool bGlobal);
 495
 496     /*! \}                                                                 */
 497     /*---------------------------------------------------------------------*/
 498     /*! \name                   Constructors                               */
 499     /*! \{                                                                 */
 500
 501     CondVar(void);
 502     CondVar(const Char8 *szName, UInt32 uiId, bool bGlobal);
 503
 504     /*! \}                                                                 */
 505     /*---------------------------------------------------------------------*/
 506     /*! \name                   Destructor                                 */
 507     /*! \{                                                                 */
 508
 509     virtual ~CondVar(void);
 510
 511     /*! \}                                                                 */
 512     /*==========================  PRIVATE  ================================*/
 513
 514   private:
 515
 516     friend class MPFieldStore<CondVar>;
 517
 518     /*!\brief prohibit default function (move to 'public' if needed) */
 519     CondVar(const CondVar &source);
 520     /*!\brief prohibit default function (move to 'public' if needed) */
 521     void operator =(const CondVar &source);
 522 };
 523
 524 OSG_GEN_MEMOBJPTR(CondVar);
 525
 526 OSG_END_NAMESPACE
 527
 528 #include "OSGCondVar.inl"
 529
 530 #endif /* _OSGCONDVAR_H_ */