Source/Base/Threading/OSGBaseThread.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 _OSGBASETHREAD_H_
  40 #define _OSGBASETHREAD_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBaseTypes.h"
  46 #include "OSGMPBase.h"
  47
  48 #ifdef OSG_USE_PTHREADS
  49 #include <pthread.h>
  50 #endif
  51
  52 #include <utility>
  53
  54 #if ! defined (OSG_USE_PTHREADS)   && \
  55     ! defined (OSG_USE_SPROC)      && \
  56     ! defined (OSG_USE_WINTHREADS)
  57 #error "No threading model defined, check your system/compiler combination"
  58 #endif
  59
  60 #if defined (OSG_USE_PTHREADS) && defined (OSG_USE_SPROC)
  61 #error "PTHREAD and SPROC defined, check your system/compiler combination"
  62 #endif
  63
  64 #if defined (OSG_USE_WINTHREADS) && defined (OSG_USE_SPROC)
  65 #error "Winthreads and SPROC defined, check your system/compiler combination"
  66 #endif
  67
  68 OSG_BEGIN_NAMESPACE
  69
  70 class BaseThread;
  71
  72 template <class MPFieldT>
  73 class MPFieldStore;
  74
  75 //---------------------------------------------------------------------------
  76 //  Class
  77 //---------------------------------------------------------------------------
  78
  79 /*! \ingroup GrpBaseMultiThreading
  80     \ingroup GrpLibOSGBase
  81  */
  82
  83 class OSG_BASE_DLLMAPPING BaseThreadCommonBase : public MPBase
  84 {
  85     /*==========================  PUBLIC  =================================*/
  86
  87   public:
  88
  89     typedef void (*ThreadFuncF)(void *pThreadArg);
  90
  91     bool isInitialized(void);
  92
  93     /*=========================  PROTECTED  ===============================*/
  94
  95   protected:
  96
  97     typedef MPBase  Inherited;
  98
  99             UInt32 _uiThreadId;
 100             bool   _bInitialized;
 101
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                   Constructors                               */
 104     /*! \{                                                                 */
 105
 106     BaseThreadCommonBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Destructors                                */
 111     /*! \{                                                                 */
 112
 113     virtual ~BaseThreadCommonBase(void);
 114
 115     /*! \}                                                                 */
 116     /*==========================  PRIVATE  ================================*/
 117
 118   private:
 119
 120     friend class ThreadManager;
 121
 122     /*!\brief prohibit default function (move to 'public' if needed) */
 123     BaseThreadCommonBase(const BaseThreadCommonBase &source);
 124     /*!\brief prohibit default function (move to 'public' if needed) */
 125     void operator =(const BaseThreadCommonBase &source);
 126 };
 127
 128
 129
 130
 131 //---------------------------------------------------------------------------
 132 //  Class
 133 //---------------------------------------------------------------------------
 134
 135 #ifdef OSG_USE_PTHREADS
 136
 137 /*! \ingroup GrpBaseMultiThreading
 138     \ingroup GrpLibOSGBase
 139  */
 140
 141 class BasePThreadBase : public BaseThreadCommonBase
 142 {
 143     /*==========================  PUBLIC  =================================*/
 144
 145   public:
 146
 147     /*=========================  PROTECTED  ===============================*/
 148
 149   protected:
 150
 151     typedef BaseThreadCommonBase  Inherited;
 152
 153 #if defined(OSG_PTHREAD_ELF_TLS)
 154     static  __thread BaseThread    *_pLocalThread;
 155 #else
 156     static           pthread_key_t  _threadKey;
 157 #endif
 158
 159     /*---------------------------------------------------------------------*/
 160     /*! \name                      Helper                                  */
 161     /*! \{                                                                 */
 162
 163     static void *threadFunc(void *pThreadArg);
 164
 165 #if !defined(OSG_PTHREAD_ELF_TLS)
 166     static void  freeThread(void *pThread   );
 167 #endif
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                   Instance Variables                         */
 172     /*! \{                                                                 */
 173
 174     void            *_pThreadData[3];
 175     pthread_t       *_pThreadDesc;
 176
 177     pthread_cond_t  *_pBlockCond;
 178     pthread_mutex_t *_pBlockMutex;
 179
 180     /*! \}                                                                 */
 181     /*---------------------------------------------------------------------*/
 182     /*! \name                   Constructors                               */
 183     /*! \{                                                                 */
 184
 185     BasePThreadBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 186
 187     /*! \}                                                                 */
 188     /*---------------------------------------------------------------------*/
 189     /*! \name                   Destructors                                */
 190     /*! \{                                                                 */
 191
 192     virtual ~BasePThreadBase(void);
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name                   Construction                               */
 197     /*! \{                                                                 */
 198
 199     virtual void init          (void);
 200     virtual void shutdown      (void);
 201
 202             void setupThread   (void);
 203             void setupBlockCond(void);
 204
 205     virtual void doAutoInit    (void);
 206
 207     /*! \}                                                                 */
 208     /*---------------------------------------------------------------------*/
 209     /*! \name                       Get                                    */
 210     /*! \{                                                                 */
 211
 212     static BaseThread *getCurrent(void);
 213
 214     /*! \}                                                                 */
 215     /*---------------------------------------------------------------------*/
 216     /*! \name                      Join                                    */
 217     /*! \{                                                                 */
 218
 219     static void join(BasePThreadBase *threadP);
 220
 221     /*! \}                                                                 */
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                      Run                                     */
 224     /*! \{                                                                 */
 225
 226     bool runFunction(ThreadFuncF  fThreadFunc,
 227                      void        *pThreadArg );
 228
 229     /*! \}                                                                 */
 230     /*---------------------------------------------------------------------*/
 231     /*! \name                   Blocking                                   */
 232     /*! \{                                                                 */
 233
 234     void block  (void);
 235     void unblock(void);
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                    Helper                                    */
 240     /*! \{                                                                 */
 241
 242     bool exists   (void);
 243
 244     void terminate(void);
 245     void kill     (void);
 246
 247     /*! \}                                                                 */
 248     /*---------------------------------------------------------------------*/
 249     /*! \name                    Dump                                      */
 250     /*! \{                                                                 */
 251
 252     void print(void);
 253
 254     /*! \}                                                                 */
 255     /*==========================  PRIVATE  ================================*/
 256
 257   private:
 258
 259     friend class ThreadManager;
 260
 261     /*!\brief prohibit default function (move to 'public' if needed) */
 262     BasePThreadBase(const BasePThreadBase &source);
 263     /*!\brief prohibit default function (move to 'public' if needed) */
 264     void operator =(const BasePThreadBase &source);
 265 };
 266
 267 typedef BasePThreadBase BaseThreadBase;
 268
 269 #endif /* OSG_USE_PTHREADS */
 270
 271
 272
 273
 274 //---------------------------------------------------------------------------
 275 //  Class
 276 //---------------------------------------------------------------------------
 277
 278 #ifdef OSG_USE_SPROC
 279
 280 /*! \ingroup GrpBaseMultiThreading
 281     \ingroup GrpLibOSGBase
 282  */
 283
 284 class BaseSprocBase : public BaseThreadCommonBase
 285 {
 286     /*==========================  PUBLIC  =================================*/
 287
 288   public:
 289
 290     /*=========================  PROTECTED  ===============================*/
 291
 292   protected:
 293
 294     typedef BaseThreadCommonBase Inherited;
 295
 296     /*! \hideinhierarchy
 297      */
 298
 299     struct ProcessData
 300     {
 301         BaseThread *_pThread;
 302     };
 303
 304     /*---------------------------------------------------------------------*/
 305     /*! \name                      Helper                                  */
 306     /*! \{                                                                 */
 307
 308     static void threadFunc(void *pThreadArgP);
 309
 310     /*! \}                                                                 */
 311     /*---------------------------------------------------------------------*/
 312     /*! \name                   Instance Variables                         */
 313     /*! \{                                                                 */
 314
 315     void  *_pThreadData[3];
 316     pid_t  _pid;
 317
 318     /*! \}                                                                 */
 319     /*---------------------------------------------------------------------*/
 320     /*! \name                   Constructors                               */
 321     /*! \{                                                                 */
 322
 323     BaseSprocBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 324
 325     /*! \}                                                                 */
 326     /*---------------------------------------------------------------------*/
 327     /*! \name                    Destructors                               */
 328     /*! \{                                                                 */
 329
 330     virtual ~BaseSprocBase(void);
 331
 332     /*! \}                                                                 */
 333     /*---------------------------------------------------------------------*/
 334     /*! \name                   Construction                               */
 335     /*! \{                                                                 */
 336
 337     virtual void init              (void               );
 338     virtual void shutdown          (void               );
 339
 340             void setPid            (void               );
 341             void setCurrentInternal(BaseThread *pThread);
 342
 343     /*! \}                                                                 */
 344     /*---------------------------------------------------------------------*/
 345     /*! \name                       Get                                    */
 346     /*! \{                                                                 */
 347
 348     static BaseThread *getCurrent(void);
 349
 350     /*! \}                                                                 */
 351     /*---------------------------------------------------------------------*/
 352     /*! \name                      Join                                    */
 353     /*! \{                                                                 */
 354
 355     static void join(BaseSprocBase *pThread);
 356
 357     /*! \}                                                                 */
 358     /*---------------------------------------------------------------------*/
 359     /*! \name                      Run                                     */
 360     /*! \{                                                                 */
 361
 362     bool runFunction(ThreadFuncF  fThreadFunc,
 363                      void        *pThreadArg);
 364
 365     /*! \}                                                                 */
 366     /*---------------------------------------------------------------------*/
 367     /*! \name                   Blocking                                   */
 368     /*! \{                                                                 */
 369
 370     void block    (void);
 371     void unblock  (void);
 372
 373     /*! \}                                                                 */
 374     /*---------------------------------------------------------------------*/
 375     /*! \name                    Helper                                    */
 376     /*! \{                                                                 */
 377
 378     bool exists   (void);
 379
 380     void terminate(void);
 381     void kill     (void);
 382
 383     /*! \}                                                                 */
 384     /*---------------------------------------------------------------------*/
 385     /*! \name                    Dump                                      */
 386     /*! \{                                                                 */
 387
 388     void print(void);
 389
 390     /*! \}                                                                 */
 391     /*==========================  PRIVATE  ================================*/
 392
 393   private:
 394
 395     friend class ThreadManager;
 396
 397     /*!\brief prohibit default function (move to 'public' if needed) */
 398     BaseSprocBase(const BaseSprocBase &source);
 399     /*!\brief prohibit default function (move to 'public' if needed) */
 400     void operator =(const BaseSprocBase &source);
 401 };
 402
 403 typedef BaseSprocBase BaseThreadBase;
 404
 405 #endif /* OSG_USE_SPROC */
 406
 407
 408
 409
 410 //---------------------------------------------------------------------------
 411 //  Class
 412 //---------------------------------------------------------------------------
 413
 414 #ifdef OSG_USE_WINTHREADS
 415
 416 #ifdef OSG_ENABLE_AUTOINIT_THREADS
 417 static void doThreadCleanup(void);
 418 #endif
 419
 420 /*! \ingroup GrpBaseMultiThreading
 421     \ingroup GrpLibOSGBase
 422  */
 423
 424 class BaseWinThreadBase : public BaseThreadCommonBase
 425 {
 426     /*==========================  PUBLIC  =================================*/
 427
 428    public:
 429
 430     /*=========================  PROTECTED  ===============================*/
 431
 432   protected:
 433
 434     typedef BaseThreadCommonBase Inherited;
 435
 436 #if defined(OSG_WIN32_ASPECT_USE_LOCALSTORAGE)
 437     static UInt32 _threadKey;
 438 #else
 439     static __declspec (thread) BaseThread *_pThreadLocal;
 440 #endif
 441
 442     /*---------------------------------------------------------------------*/
 443     /*! \name                   Class Specific                             */
 444     /*! \{                                                                 */
 445
 446     OSG_BASE_DLLMAPPING
 447     static void threadFunc(void *pThreadArg);
 448
 449 #ifdef OSG_WIN32_ASPECT_USE_LOCALSTORAGE
 450     OSG_BASE_DLLMAPPING
 451     static void freeThread(void            );
 452 #endif
 453
 454     /*! \}                                                                 */
 455     /*---------------------------------------------------------------------*/
 456     /*! \name                   Instance Variables                         */
 457     /*! \{                                                                 */
 458
 459     void   *_pThreadData[3];
 460
 461     Handle  _pThreadHandle;
 462     Handle  _pExternalHandle;
 463     UInt32  _uiNativeThreadId;
 464
 465     /*! \}                                                                 */
 466     /*---------------------------------------------------------------------*/
 467     /*! \name                   Constructors                               */
 468     /*! \{                                                                 */
 469
 470     OSG_BASE_DLLMAPPING
 471     BaseWinThreadBase(const Char8 *szName, UInt32 uiId, bool bGlobal);
 472
 473     /*! \}                                                                 */
 474     /*---------------------------------------------------------------------*/
 475     /*! \name                    Destructors                               */
 476     /*! \{                                                                 */
 477
 478     OSG_BASE_DLLMAPPING
 479     virtual ~BaseWinThreadBase(void);
 480
 481     /*! \}                                                                 */
 482     /*---------------------------------------------------------------------*/
 483     /*! \name                   Construction                               */
 484     /*! \{                                                                 */
 485
 486     OSG_BASE_DLLMAPPING
 487     virtual void init             (void                  );
 488     OSG_BASE_DLLMAPPING
 489     virtual void shutdown         (void                  );
 490
 491             OSG_BASE_DLLMAPPING
 492             void setPid           (void                  );
 493             OSG_BASE_DLLMAPPING
 494             void setExternalHandle(Handle pExternalHandle);
 495
 496             OSG_BASE_DLLMAPPING
 497             void setupThread      (void                  );
 498
 499     OSG_BASE_DLLMAPPING
 500     virtual void doAutoInit       (void                  );
 501
 502     /*! \}                                                                 */
 503     /*---------------------------------------------------------------------*/
 504     /*! \name                       Get                                    */
 505     /*! \{                                                                 */
 506
 507     OSG_BASE_DLLMAPPING
 508     static BaseThread *getCurrent(void);
 509
 510     OSG_BASE_DLLMAPPING
 511     static BaseThread *getCurrentInternal(void);
 512
 513     /*! \}                                                                 */
 514     /*---------------------------------------------------------------------*/
 515     /*! \name                      Join                                    */
 516     /*! \{                                                                 */
 517
 518     OSG_BASE_DLLMAPPING
 519     static void join(BaseWinThreadBase *pThread);
 520
 521     /*! \}                                                                 */
 522     /*---------------------------------------------------------------------*/
 523     /*! \name                      Run                                     */
 524     /*! \{                                                                 */
 525
 526     OSG_BASE_DLLMAPPING
 527     bool runFunction(ThreadFuncF fThreadFunc,
 528                      void        *pThreadArg);
 529
 530     /*! \}                                                                 */
 531     /*---------------------------------------------------------------------*/
 532     /*! \name                   Blocking                                   */
 533     /*! \{                                                                 */
 534
 535     OSG_BASE_DLLMAPPING
 536     void block  (void);
 537     OSG_BASE_DLLMAPPING
 538     void unblock(void);
 539
 540     /*! \}                                                                 */
 541     /*---------------------------------------------------------------------*/
 542     /*! \name                    Helper                                    */
 543     /*! \{                                                                 */
 544
 545     OSG_BASE_DLLMAPPING
 546     bool exists   (void);
 547
 548     OSG_BASE_DLLMAPPING
 549     void terminate(void);
 550     OSG_BASE_DLLMAPPING
 551     void kill     (void);
 552
 553     /*! \}                                                                 */
 554     /*---------------------------------------------------------------------*/
 555     /*! \name                    Dump                                      */
 556     /*! \{                                                                 */
 557
 558     OSG_BASE_DLLMAPPING
 559     void print(void);
 560
 561     /*! \}                                                                 */
 562     /*==========================  PRIVATE  ================================*/
 563    private:
 564
 565     friend class ThreadManager;
 566 #ifdef OSG_ENABLE_AUTOINIT_THREADS
 567     friend void doThreadCleanup(void);
 568 #endif
 569
 570     /*!\brief prohibit default function (move to 'public' if needed) */
 571     BaseWinThreadBase(const BaseWinThreadBase &source);
 572     /*!\brief prohibit default function (move to 'public' if needed) */
 573     void operator =(const BaseWinThreadBase &source);
 574 };
 575
 576 typedef BaseWinThreadBase BaseThreadBase;
 577
 578 #endif /* OSG_USE_WINTHREADS */
 579
 580
 581
 582
 583 //---------------------------------------------------------------------------
 584 //  Class
 585 //---------------------------------------------------------------------------
 586
 587 /*! \ingroup GrpBaseMultiThreading
 588     \ingroup GrpLibOSGBase
 589  */
 590
 591 class OSG_BASE_DLLMAPPING BaseThread : public BaseThreadBase
 592 {
 593     /*==========================  PRIVATE  ================================*/
 594
 595   private:
 596
 597     typedef BaseThreadBase Inherited;
 598
 599     /*==========================  PUBLIC  =================================*/
 600
 601   public:
 602
 603     typedef MPThreadType Type;
 604
 605     OSG_GEN_INTERNAL_MEMOBJPTR(BaseThread);
 606
 607     /*---------------------------------------------------------------------*/
 608     /*! \name                      Get                                     */
 609     /*! \{                                                                 */
 610
 611     static       ObjTransitPtr  get         (const Char8 *szName,
 612                                                    bool   bGlobal);
 613     static       BaseThread    *find        (const Char8 *szName );
 614     static       ObjTransitPtr  create      (      void          );
 615
 616     static const MPThreadType  &getClassType(      void          );
 617
 618     /*! \}                                                                 */
 619     /*---------------------------------------------------------------------*/
 620     /*! \name                       Get                                    */
 621     /*! \{                                                                 */
 622
 623     static BaseThread *getCurrent(void);
 624
 625     /*! \}                                                                 */
 626     /*---------------------------------------------------------------------*/
 627     /*! \name                      Join                                    */
 628     /*! \{                                                                 */
 629
 630     static void join(BaseThread *pThread);
 631
 632     /*! \}                                                                 */
 633     /*---------------------------------------------------------------------*/
 634     /*! \name                      Run                                     */
 635     /*! \{                                                                 */
 636
 637     void run        (void                   );
 638
 639     bool runFunction(ThreadFuncF fThreadFunc,
 640                      void        *pThreadArg);
 641
 642     /*! \}                                                                 */
 643     /*---------------------------------------------------------------------*/
 644     /*! \name                   Blocking                                   */
 645     /*! \{                                                                 */
 646
 647     void block  (void);
 648     void unblock(void);
 649
 650     /*! \}                                                                 */
 651     /*---------------------------------------------------------------------*/
 652     /*! \name                    Helper                                    */
 653     /*! \{                                                                 */
 654
 655     bool exists   (void);
 656
 657     void terminate(void);
 658     void kill     (void);
 659
 660     /*! \}                                                                 */
 661     /*---------------------------------------------------------------------*/
 662     /*! \name                    Dump                                      */
 663     /*! \{                                                                 */
 664
 665     void print(void);
 666
 667     /*! \}                                                                 */
 668     /*=========================  PROTECTED  ===============================*/
 669
 670   protected:
 671
 672     static MPThreadType _type;
 673
 674     /*---------------------------------------------------------------------*/
 675     /*! \name                   Class Specific                             */
 676     /*! \{                                                                 */
 677
 678     static BaseThread *create            (const Char8 *szName,
 679                                                 UInt32 uiId,
 680                                                 bool   bGlobal);
 681
 682     static void        initThreading     (      void          );
 683     static void        terminateThreading(      void          );
 684
 685     static void        runWorkProc       (      void  *pThread);
 686
 687     /*! \}                                                                 */
 688     /*---------------------------------------------------------------------*/
 689     /*! \name                   Constructors                               */
 690     /*! \{                                                                 */
 691
 692     BaseThread(const Char8 *szName, UInt32 uiId, bool bGlobal);
 693
 694     /*! \}                                                                 */
 695     /*---------------------------------------------------------------------*/
 696     /*! \name                    Destructors                               */
 697     /*! \{                                                                 */
 698
 699     virtual ~BaseThread(void);
 700
 701     /*! \}                                                                 */
 702     /*---------------------------------------------------------------------*/
 703     /*! \name                      Workproc                                */
 704     /*! \{                                                                 */
 705
 706     virtual void workProc(void);
 707
 708     /*! \}                                                                 */
 709     /*==========================  PRIVATE  ================================*/
 710
 711   private:
 712
 713     friend class ThreadManager;
 714     friend class MPFieldStore<BaseThread>;
 715
 716     /*!\brief prohibit default function (move to 'public' if needed) */
 717     BaseThread(const BaseThread &source);
 718     /*!\brief prohibit default function (move to 'public' if needed) */
 719     void operator =(const BaseThread &source);
 720 };
 721
 722 OSG_GEN_MEMOBJPTR(BaseThread);
 723
 724 OSG_END_NAMESPACE
 725
 726 #include "OSGBaseThread.inl"
 727
 728 #endif /* _OSGBASETHREAD_H_ */