?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
fixed: auto_ptr -> unique_ptr
[opensg.git] / Source / Base / Threading / OSGBarrier.h
blob4d52a31f00d040e99f8a5dc677b8d530036a487c
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 _OSGBARRIER_H_
40 #define _OSGBARRIER_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 #endif /* OSG_USE_PTHREADS */
57
58 #if defined (OSG_USE_SPROC)
59 #include <ulocks.h>
60 #endif /* OSG_USE_SPROC */
61
62 OSG_BEGIN_NAMESPACE
63
64 template <class MPFieldT>
65 class MPFieldStore;
66
67 //---------------------------------------------------------------------------
68 // Class
69 //---------------------------------------------------------------------------
70
71 /*! \ingroup GrpBaseMultiThreading
72 \ingroup GrpLibOSGBase
73 */
74
75 class OSG_BASE_DLLMAPPING BarrierCommonBase : public MPBase
76 {
77 /*========================== PUBLIC =================================*/
78
79 public:
80
81 /*========================= PROTECTED ===============================*/
82
83 protected:
84
85 typedef MPBase Inherited;
86
87 UInt32 _uiBarrierId;
88 volatile UInt32 _uiNumWaitFor;
89
90 /*---------------------------------------------------------------------*/
91 /*! \name Constructors */
92 /*! \{ */
93
94 BarrierCommonBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
95
96 /*! \} */
97 /*---------------------------------------------------------------------*/
98 /*! \name Destructor */
99 /*! \{ */
100
101 virtual ~BarrierCommonBase(void);
102
103 /*! \} */
104 /*---------------------------------------------------------------------*/
105 /*! \name Set */
106 /*! \{ */
107
108 void setNumWaitFor(UInt32 uiNumWaitFor);
109
110 /*! \} */
111 /*========================== PRIVATE ================================*/
112
113 private:
114
115 /*!\brief prohibit default function (move to 'public' if needed) */
116 BarrierCommonBase(const BarrierCommonBase &source);
117 /*!\brief prohibit default function (move to 'public' if needed) */
118 void operator =(const BarrierCommonBase &source);
119 };
120
121
122
123
124 //---------------------------------------------------------------------------
125 // Class
126 //---------------------------------------------------------------------------
127
128 #if defined (OSG_USE_PTHREADS)
129
130 /*! \ingroup GrpBaseMultiThreading
131 \ingroup GrpLibOSGBase
132 */
133
134 class PThreadBarrierBase : public BarrierCommonBase
135 {
136 /*========================== PUBLIC =================================*/
137
138 public:
139
140 /*========================= PROTECTED ===============================*/
141
142 protected:
143
144 typedef BarrierCommonBase Inherited;
145
146 /*---------------------------------------------------------------------*/
147 /*! \name Constructors */
148 /*! \{ */
149
150 PThreadBarrierBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
151
152 /*! \} */
153 /*---------------------------------------------------------------------*/
154 /*! \name Destructor */
155 /*! \{ */
156
157 virtual ~PThreadBarrierBase(void);
158
159 /*! \} */
160 /*---------------------------------------------------------------------*/
161 /*! \name Construction */
162 /*! \{ */
163
164 bool init ( void );
165
166 /*! \} */
167 /*---------------------------------------------------------------------*/
168 /*! \name Destruction */
169 /*! \{ */
170
171 void shutdown( void );
172
173 /*! \} */
174 /*---------------------------------------------------------------------*/
175 /*! \name Enter */
176 /*! \{ */
177
178 void enter (void );
179 void enter (UInt32 uiNumWaitFor);
180
181 UInt32 getNumWaiting(void );
182
183 /*! \} */
184 /*========================== PRIVATE ================================*/
185
186 private:
187
188 pthread_mutex_t _pLockOne;
189 pthread_cond_t _pWakeupCondition[2];
190 UInt32 _uiCount;
191 UInt32 _uiCurrentCond;
192
193 /*!\brief prohibit default function (move to 'public' if needed) */
194 PThreadBarrierBase(const PThreadBarrierBase &source);
195 /*!\brief prohibit default function (move to 'public' if needed) */
196 void operator =(const PThreadBarrierBase &source);
197 };
198
199 typedef PThreadBarrierBase BarrierBase;
200
201 #endif /* OSG_USE_PTHREADS */
202
203
204
205
206 //---------------------------------------------------------------------------
207 // Class
208 //---------------------------------------------------------------------------
209
210 #if defined (OSG_USE_SPROC)
211
212 /*! \ingroup GrpBaseMultiThreading
213 \ingroup GrpLibOSGBase
214 */
215
216 class SprocBarrierBase : public BarrierCommonBase
217 {
218 /*========================== PUBLIC =================================*/
219
220 public:
221
222 /*========================= PROTECTED ===============================*/
223
224 protected:
225
226 typedef BarrierCommonBase Inherited;
227
228 /*---------------------------------------------------------------------*/
229 /*! \name Constructors */
230 /*! \{ */
231
232 SprocBarrierBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
233
234 /*! \} */
235 /*---------------------------------------------------------------------*/
236 /*! \name Destructor */
237 /*! \{ */
238
239 virtual ~SprocBarrierBase(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 Enter */
258 /*! \{ */
259
260 void enter (void );
261 void enter (UInt32 uiNumWaitFor);
262
263 UInt32 getNumWaiting(void );
264
265 /*! \} */
266 /*========================== PRIVATE ================================*/
267
268 private:
269
270 barrier_t *_pBarrier;
271
272 /*!\brief prohibit default function (move to 'public' if needed) */
273 SprocBarrierBase(const SprocBarrierBase &source);
274 /*!\brief prohibit default function (move to 'public' if needed) */
275 void operator =(const SprocBarrierBase &source);
276 };
277
278 typedef SprocBarrierBase BarrierBase;
279
280 #endif /* OSG_USE_SPROC */
281
282
283
284
285 //---------------------------------------------------------------------------
286 // Class
287 //---------------------------------------------------------------------------
288
289 #if defined (OSG_USE_WINTHREADS)
290
291 /*! \ingroup GrpBaseMultiThreading
292 \ingroup GrpLibOSGBase
293 */
294
295 class OSG_BASE_DLLMAPPING WinThreadBarrierBase : public BarrierCommonBase
296 {
297 /*========================== PUBLIC =================================*/
298
299 public:
300
301 /*========================= PROTECTED ===============================*/
302
303 protected:
304
305 /*---------------------------------------------------------------------*/
306 /*! \name Constructors */
307 /*! \{ */
308
309 WinThreadBarrierBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
310
311 /*! \} */
312 /*---------------------------------------------------------------------*/
313 /*! \name Destructor */
314 /*! \{ */
315
316 virtual ~WinThreadBarrierBase(void);
317
318 /*! \} */
319 /*---------------------------------------------------------------------*/
320 /*! \name Construction */
321 /*! \{ */
322
323 bool init (void );
324
325 /*! \} */
326 /*---------------------------------------------------------------------*/
327 /*! \name Destruction */
328 /*! \{ */
329
330 void shutdown(void );
331
332 /*! \} */
333 /*---------------------------------------------------------------------*/
334 /*! \name Enter */
335 /*! \{ */
336
337 void enter (void );
338 void enter (UInt32 uiNumWaitFor);
339
340 UInt32 getNumWaiting(void );
341
342 /*! \} */
343 /*========================== PRIVATE ================================*/
344
345 private:
346
347 typedef BarrierCommonBase Inherited;
348
349 Handle _pMutex1;
350 Handle _pBarrierSema[2];
351 UInt32 _uiCount;
352 UInt32 _uiCurrentCond;
353
354 /*!\brief prohibit default function (move to 'public' if needed) */
355 WinThreadBarrierBase(const WinThreadBarrierBase &source);
356 /*!\brief prohibit default function (move to 'public' if needed) */
357 void operator =(const WinThreadBarrierBase &source);
358 };
359
360 typedef WinThreadBarrierBase BarrierBase;
361
362 #endif /* OSG_USE_WINTHREADS */
363
364
365
366
367 //---------------------------------------------------------------------------
368 // Class
369 //---------------------------------------------------------------------------
370
371 /*! \ingroup GrpBaseMultiThreading
372 \ingroup GrpLibOSGBase
373 */
374
375 class OSG_BASE_DLLMAPPING Barrier : public BarrierBase
376 {
377 /*========================== PUBLIC =================================*/
378
379 public:
380
381 typedef MPBarrierType Type;
382
383 OSG_GEN_INTERNAL_MEMOBJPTR(Barrier);
384
385 /*---------------------------------------------------------------------*/
386 /*! \name Get */
387 /*! \{ */
388
389 static ObjTransitPtr get (const Char8 *szName,
390 bool bGlobal);
391 static Barrier *find (const Char8 *szName );
392
393 static ObjTransitPtr create ( void );
394
395 static const MPBarrierType &getClassType( void );
396
397 /*! \} */
398 /*---------------------------------------------------------------------*/
399 /*! \name Enter */
400 /*! \{ */
401
402 void setNumWaitFor(UInt32 uiNumWaitFor);
403 UInt32 getNumWaiting(void );
404
405 /*! \} */
406 /*---------------------------------------------------------------------*/
407 /*! \name Enter */
408 /*! \{ */
409
410 void enter(void );
411 void enter(UInt32 uiNumWaitFor);
412
413 /*! \} */
414 /*========================= PROTECTED ===============================*/
415
416 protected:
417
418 typedef BarrierBase Inherited;
419
420 static MPBarrierType _type;
421
422 /*---------------------------------------------------------------------*/
423 /*! \name Constructors */
424 /*! \{ */
425
426 Barrier(const Char8 *szName, UInt32 uiId, bool bGlobal);
427
428 /*! \} */
429 /*---------------------------------------------------------------------*/
430 /*! \name Destructor */
431 /*! \{ */
432
433 virtual ~Barrier(void);
434
435 /*! \} */
436 /*---------------------------------------------------------------------*/
437 /*! \name Construction */
438 /*! \{ */
439
440 static Barrier *create(const Char8 *szName,
441 UInt32 uiId,
442 bool bGlobal);
443
444 /*! \} */
445 /*========================== PRIVATE ================================*/
446
447 private:
448
449 friend class MPFieldStore<Barrier>;
450
451 /*!\brief prohibit default function (move to 'public' if needed) */
452 Barrier(const Barrier &source);
453 /*!\brief prohibit default function (move to 'public' if needed) */
454 void operator =(const Barrier &source);
455 };
456
457 OSG_GEN_MEMOBJPTR(Barrier);
458
459 OSG_END_NAMESPACE
460
461 #include "OSGBarrier.inl"
462
463 #endif /* _OSGBARRIER_H_ */