Source/Base/Threading/OSGSemaphore.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 _OSGSEMAPHORE_H_
  40 #define _OSGSEMAPHORE_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 <semaphore.h>
  56 #include <cerrno>
  57 #endif
  58
  59 #if defined (OSG_USE_SPROC)
  60 #include <semaphore.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 SemaphoreCommonBase : public MPBase
  79 {
  80     /*==========================  PUBLIC  =================================*/
  81
  82   public:
  83
  84     /*=========================  PROTECTED  ===============================*/
  85
  86   protected:
  87
  88     typedef MPBase  Inherited;
  89
  90             UInt32 _uiSemaphoreId;
  91
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                   Constructors                               */
  94     /*! \{                                                                 */
  95
  96     SemaphoreCommonBase(void);
  97     SemaphoreCommonBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Destructor                                 */
 102     /*! \{                                                                 */
 103
 104     virtual ~SemaphoreCommonBase(void);
 105
 106     /*! \}                                                                 */
 107     /*==========================  PRIVATE  ================================*/
 108
 109   private:
 110
 111     /*!\brief prohibit default function (move to 'public' if needed) */
 112     SemaphoreCommonBase  (const SemaphoreCommonBase &source);
 113     /*!\brief prohibit default function (move to 'public' if needed) */
 114     void operator = (const SemaphoreCommonBase &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 PThreadSemaphoreBase : public SemaphoreCommonBase
 131 {
 132     /*==========================  PUBLIC  =================================*/
 133
 134   public :
 135
 136     /*=========================  PROTECTED  ===============================*/
 137
 138   protected:
 139
 140     typedef SemaphoreCommonBase Inherited;
 141
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                   Constructors                               */
 144     /*! \{                                                                 */
 145
 146     PThreadSemaphoreBase(void);
 147     PThreadSemaphoreBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                   Destructor                                 */
 152     /*! \{                                                                 */
 153
 154     virtual ~PThreadSemaphoreBase(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                   Semaphore                                  */
 173     /*! \{                                                                 */
 174
 175     void wait(void);
 176     void post(void);
 177
 178     /*! \}                                                                 */
 179     /*==========================  PRIVATE  ================================*/
 180
 181   private:
 182
 183     sem_t _pLowLevelSemaphore;
 184
 185     /*!\brief prohibit default function (move to 'public' if needed) */
 186     PThreadSemaphoreBase(const PThreadSemaphoreBase &source);
 187     /*!\brief prohibit default function (move to 'public' if needed) */
 188     void operator =(const PThreadSemaphoreBase &source);
 189 };
 190
 191 typedef PThreadSemaphoreBase SemaphoreBase;
 192
 193 #endif /* OSG_USE_PTHREADS */
 194
 195
 196
 197
 198 //---------------------------------------------------------------------------
 199 //  Class
 200 //---------------------------------------------------------------------------
 201
 202 #if defined (OSG_USE_SPROC)
 203
 204 /*! \ingroup GrpBaseMultiThreading
 205     \ingroup GrpLibOSGBase
 206  */
 207
 208 class SprocSemaphoreBase : public SemaphoreCommonBase
 209 {
 210     /*==========================  PUBLIC  =================================*/
 211
 212   public :
 213
 214     /*=========================  PROTECTED  ===============================*/
 215
 216   protected:
 217
 218     typedef SemaphoreCommonBase Inherited;
 219
 220     /*---------------------------------------------------------------------*/
 221     /*! \name                   Constructors                               */
 222     /*! \{                                                                 */
 223
 224     SprocSemaphoreBase(void);
 225     SprocSemaphoreBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 226
 227     /*! \}                                                                 */
 228     /*---------------------------------------------------------------------*/
 229     /*! \name                   Destructor                                 */
 230     /*! \{                                                                 */
 231
 232     virtual ~SprocSemaphoreBase(void);
 233
 234     /*! \}                                                                 */
 235     /*---------------------------------------------------------------------*/
 236     /*! \name                   Construction                               */
 237     /*! \{                                                                 */
 238
 239     bool init    (void);
 240
 241     /*! \}                                                                 */
 242     /*---------------------------------------------------------------------*/
 243     /*! \name                   Destruction                                */
 244     /*! \{                                                                 */
 245
 246     void shutdown(void);
 247
 248     /*! \}                                                                 */
 249     /*---------------------------------------------------------------------*/
 250     /*! \name                    Semaphore                                 */
 251     /*! \{                                                                 */
 252
 253     void wait(void);
 254     void post(void);
 255
 256     /*! \}                                                                 */
 257     /*==========================  PRIVATE  ================================*/
 258
 259   private:
 260
 261     usema_t *_pLowLevelSema;
 262
 263     /*!\brief prohibit default function (move to 'public' if needed) */
 264     SprocSemaphoreBase(const SprocSemaphoreBase &source);
 265     /*!\brief prohibit default function (move to 'public' if needed) */
 266     void operator =(const SprocSemaphoreBase &source);
 267 };
 268
 269 typedef SprocSemaphoreBase SemaphoreBase;
 270
 271 #endif /* OSG_USE_SPROC */
 272
 273
 274
 275
 276 //---------------------------------------------------------------------------
 277 //  Class
 278 //---------------------------------------------------------------------------
 279
 280 #if defined (OSG_USE_WINTHREADS)
 281
 282 /*! \ingroup GrpBaseMultiThreading
 283     \ingroup GrpLibOSGBase
 284  */
 285
 286 class OSG_BASE_DLLMAPPING WinThreadSemaphoreBase : public SemaphoreCommonBase
 287 {
 288     /*==========================  PUBLIC  =================================*/
 289
 290   public :
 291
 292     /*=========================  PROTECTED  ===============================*/
 293
 294   protected:
 295
 296     typedef SemaphoreCommonBase Inherited;
 297
 298     /*---------------------------------------------------------------------*/
 299     /*! \name                   Constructors                               */
 300     /*! \{                                                                 */
 301
 302     WinThreadSemaphoreBase(void);
 303     WinThreadSemaphoreBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 304
 305     /*! \}                                                                 */
 306     /*---------------------------------------------------------------------*/
 307     /*! \name                   Destructor                                 */
 308     /*! \{                                                                 */
 309
 310     virtual ~WinThreadSemaphoreBase(void);
 311
 312     /*! \}                                                                 */
 313     /*---------------------------------------------------------------------*/
 314     /*! \name                   Construction                               */
 315     /*! \{                                                                 */
 316
 317     bool init    (void);
 318
 319     /*! \}                                                                 */
 320     /*---------------------------------------------------------------------*/
 321     /*! \name                   Destruction                                */
 322     /*! \{                                                                 */
 323
 324     void shutdown(void);
 325
 326     /*! \}                                                                 */
 327     /*---------------------------------------------------------------------*/
 328     /*! \name                     Semaphore                                */
 329     /*! \{                                                                 */
 330
 331     void wait(void);
 332     void post(void);
 333
 334     /*! \}                                                                 */
 335     /*==========================  PRIVATE  ================================*/
 336   private:
 337
 338     Handle  _pSemaphore;
 339
 340     /*!\brief prohibit default function (move to 'public' if needed) */
 341     WinThreadSemaphoreBase(const WinThreadSemaphoreBase &source);
 342     /*!\brief prohibit default function (move to 'public' if needed) */
 343     void operator =(const WinThreadSemaphoreBase &source);
 344 };
 345
 346 typedef WinThreadSemaphoreBase SemaphoreBase;
 347
 348 #endif /* OSG_USE_WINTHREADS */
 349
 350
 351
 352
 353 //---------------------------------------------------------------------------
 354 //  Class
 355 //---------------------------------------------------------------------------
 356
 357 /*! \ingroup GrpBaseMultiThreading
 358     \ingroup GrpLibOSGBase
 359  */
 360
 361 class OSG_BASE_DLLMAPPING Semaphore : public SemaphoreBase
 362 {
 363     /*==========================  PUBLIC  =================================*/
 364
 365   public:
 366
 367     typedef MPSemaphoreType Type;
 368
 369     OSG_GEN_INTERNAL_MEMOBJPTR(Semaphore);
 370
 371     /*---------------------------------------------------------------------*/
 372     /*! \name                      Get                                     */
 373     /*! \{                                                                 */
 374
 375     static       ObjTransitPtr    get         (const Char8 *szName,
 376                                                      bool   bGlobal);
 377     static       Semaphore       *find        (const Char8 *szName );
 378
 379     static       ObjTransitPtr    create      (      void          );
 380
 381     static const MPSemaphoreType &getClassType(      void          );
 382
 383     /*! \}                                                                 */
 384     /*---------------------------------------------------------------------*/
 385     /*! \name                    Semaphore                                 */
 386     /*! \{                                                                 */
 387
 388     void wait(void);
 389     void post(void);
 390
 391     /*! \}                                                                 */
 392     /*=========================  PROTECTED  ===============================*/
 393
 394   protected:
 395
 396     typedef SemaphoreBase    Inherited;
 397
 398     static  MPSemaphoreType _type;
 399
 400     /*---------------------------------------------------------------------*/
 401     /*! \name                   Construction                               */
 402     /*! \{                                                                 */
 403
 404     static Semaphore *create(const Char8 *szName, UInt32 uiId, bool bGlobal);
 405
 406     /*! \}                                                                 */
 407     /*---------------------------------------------------------------------*/
 408     /*! \name                   Constructors                               */
 409     /*! \{                                                                 */
 410
 411     Semaphore(void);
 412     Semaphore(const Char8 *szName, UInt32 uiId, bool bGlobal);
 413
 414     /*! \}                                                                 */
 415     /*---------------------------------------------------------------------*/
 416     /*! \name                   Destructor                                 */
 417     /*! \{                                                                 */
 418
 419     virtual ~Semaphore(void);
 420
 421     /*! \}                                                                 */
 422     /*==========================  PRIVATE  ================================*/
 423
 424   private:
 425
 426     friend class MPFieldStore<Semaphore>;
 427
 428     /*!\brief prohibit default function (move to 'public' if needed) */
 429     Semaphore(const Semaphore &source);
 430     /*!\brief prohibit default function (move to 'public' if needed) */
 431     void operator =(const Semaphore &source);
 432 };
 433
 434 OSG_GEN_MEMOBJPTR(Semaphore);
 435
 436 OSG_END_NAMESPACE
 437
 438 #include "OSGSemaphore.inl"
 439
 440 #endif /* _OSGSEMAPHORE_H_ */