ThreadTypes.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_THREAD_TYPES_HPP_
#define BLOCXX_THREAD_TYPES_HPP_
#include "blocxx/BLOCXX_config.h"

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

#if defined(BLOCXX_USE_PTHREAD)

   #include <pthread.h>

#ifdef BLOCXX_NCR //for the function pthread_cond_init
#define PTHREAD_COND_ATTR_DEFAULT  pthread_condattr_default
#else
#define PTHREAD_COND_ATTR_DEFAULT  0
#endif

   namespace BLOCXX_NAMESPACE
   {

      // Platform specific thread type
      typedef pthread_t       Thread_t;
      typedef pthread_mutex_t NativeMutex_t;
      struct NonRecursiveMutex_t
      {
         pthread_mutex_t mutex;
      };

      #if defined(BLOCXX_HAVE_PTHREAD_MUTEXATTR_SETTYPE)
      // Platform specific mutex type
      // we have native recursive mutexes.
      struct Mutex_t
      {
         pthread_mutex_t mutex;
      };

      #else

      // we have to emulate recursive mutexes.
      struct Mutex_t
      {
         pthread_mutex_t mutex;
         pthread_cond_t unlocked;
         bool valid_id;
         unsigned count;
         pthread_t thread_id;
      };
      #endif

      // Platform specific conditional variable type
      typedef pthread_cond_t        ConditionVar_t;
      struct NonRecursiveMutexLockState
      {
         pthread_t thread_id;
         NativeMutex_t* pmutex;
      };

   } // end namespace BLOCXX_NAMESPACE

#elif defined(BLOCXX_WIN32)

#define WIN32_LEAN_AND_MEAN  // Exclude rarely-used stuff from Windows headers
#include <wtypes.h>

   namespace BLOCXX_NAMESPACE
   {
      // Platform specific thread type
      typedef DWORD Thread_t;
      typedef HANDLE NativeMutex_t;
      typedef HANDLE NonRecursiveMutex_t;
      typedef LPCRITICAL_SECTION Mutex_t;

      // Platform specific conditional variable type
      typedef struct
      {
         // Number of waiting threads
         int waitersCount;
         // Serialize access to waitersCount
         CRITICAL_SECTION waitersCountLock;
         // Semaphore used to queue up threads waiting for the condition to
         // become signaled
         HANDLE queue;
         // An auto-reset event used during broadcasting to wait for all the 
         // threads to wake up and be released from the queue
         HANDLE waitersDone;
         // Keeps track of whether we are broadcasting or signaling. This allows
         // for optimization if just signaling.
         bool wasBroadcast;
      } ConditionInfo_t;

      typedef ConditionInfo_t* ConditionVar_t;
      //typedef void*         ConditionVar_t;
      struct NonRecursiveMutexLockState
      {
         DWORD thread_id;
         NativeMutex_t* pmutex;
      };

   } // end namespace BLOCXX_NAMESPACE

#endif

#endif   // #ifndef BLOCXX_THREAD_TYPES_HPP_