sjero.net Git - iperf/blob - include/Condition.h

   1 /*---------------------------------------------------------------
   2  * Copyright (c) 1999,2000,2001,2002,2003
   3  * The Board of Trustees of the University of Illinois
   4  * All Rights Reserved.
   5  *---------------------------------------------------------------
   6  * Permission is hereby granted, free of charge, to any person
   7  * obtaining a copy of this software (Iperf) and associated
   8  * documentation files (the "Software"), to deal in the Software
   9  * without restriction, including without limitation the
  10  * rights to use, copy, modify, merge, publish, distribute,
  11  * sublicense, and/or sell copies of the Software, and to permit
  12  * persons to whom the Software is furnished to do
  13  * so, subject to the following conditions:
  14  *
  15  *
  16  * Redistributions of source code must retain the above
  17  * copyright notice, this list of conditions and
  18  * the following disclaimers.
  19  *
  20  *
  21  * Redistributions in binary form must reproduce the above
  22  * copyright notice, this list of conditions and the following
  23  * disclaimers in the documentation and/or other materials
  24  * provided with the distribution.
  25  *
  26  *
  27  * Neither the names of the University of Illinois, NCSA,
  28  * nor the names of its contributors may be used to endorse
  29  * or promote products derived from this Software without
  30  * specific prior written permission.
  31  *
  32  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  33  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  34  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  35  * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT
  36  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  37  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  38  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  39  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  40  * ________________________________________________________________
  41  * National Laboratory for Applied Network Research
  42  * National Center for Supercomputing Applications
  43  * University of Illinois at Urbana-Champaign
  44  * http://www.ncsa.uiuc.edu
  45  * ________________________________________________________________
  46  *
  47  * Condition.h
  48  * by Mark Gates <mgates@nlanr.net>
  49  * -------------------------------------------------------------------
  50  * An abstract class for waiting on a condition variable. If
  51  * threads are not available, this does nothing.
  52  * ------------------------------------------------------------------- */
  53
  54 #ifndef CONDITION_H
  55 #define CONDITION_H
  56
  57 #include "headers.h"
  58 #include "Mutex.h"
  59 #include "util.h"
  60
  61 #if   defined( HAVE_POSIX_THREAD )
  62 typedef struct Condition {
  63     pthread_cond_t mCondition;
  64     pthread_mutex_t mMutex;
  65 } Condition;
  66 #elif defined( HAVE_WIN32_THREAD )
  67 typedef struct Condition {
  68     HANDLE mCondition;
  69     HANDLE mMutex;
  70 } Condition;
  71 #else
  72 typedef struct Condition {
  73     int mCondition;
  74     int mMutex;
  75 } Condition;
  76 #endif
  77
  78 #define Condition_Lock( Cond ) Mutex_Lock( &Cond.mMutex )
  79
  80 #define Condition_Unlock( Cond ) Mutex_Unlock( &Cond.mMutex )
  81
  82     // initialize condition
  83 #if   defined( HAVE_POSIX_THREAD )
  84     #define Condition_Initialize( Cond ) do {             \
  85         Mutex_Initialize( &(Cond)->mMutex );              \
  86         pthread_cond_init( &(Cond)->mCondition, NULL );   \
  87     } while ( 0 )
  88 #elif defined( HAVE_WIN32_THREAD )
  89     // set all conditions to be broadcast
  90     // unfortunately in Win32 you have to know at creation
  91     // whether the signal is broadcast or not.
  92     #define Condition_Initialize( Cond ) do {                         \
  93         Mutex_Initialize( &(Cond)->mMutex );                          \
  94         (Cond)->mCondition = CreateEvent( NULL, true, false, NULL );  \
  95     } while ( 0 )
  96 #else
  97     #define Condition_Initialize( Cond )
  98 #endif
  99
 100     // destroy condition
 101 #if   defined( HAVE_POSIX_THREAD )
 102     #define Condition_Destroy( Cond ) do {            \
 103         pthread_cond_destroy( &(Cond)->mCondition );  \
 104         Mutex_Destroy( &(Cond)->mMutex );             \
 105     } while ( 0 )
 106 #elif defined( HAVE_WIN32_THREAD )
 107     #define Condition_Destroy( Cond ) do {            \
 108         CloseHandle( (Cond)->mCondition );            \
 109         Mutex_Destroy( &(Cond)->mMutex );             \
 110     } while ( 0 )
 111 #else
 112     #define Condition_Destroy( Cond )
 113 #endif
 114
 115     // sleep this thread, waiting for condition signal
 116 #if   defined( HAVE_POSIX_THREAD )
 117     #define Condition_Wait( Cond ) pthread_cond_wait( &(Cond)->mCondition, &(Cond)->mMutex )
 118 #elif defined( HAVE_WIN32_THREAD )
 119     // atomically release mutex and wait on condition,
 120     // then re-acquire the mutex
 121     #define Condition_Wait( Cond ) do {                                         \
 122         SignalObjectAndWait( (Cond)->mMutex, (Cond)->mCondition, INFINITE, false ); \
 123         Mutex_Lock( &(Cond)->mMutex );                          \
 124     } while ( 0 )
 125 #else
 126     #define Condition_Wait( Cond )
 127 #endif
 128
 129     // sleep this thread, waiting for condition signal,
 130     // but bound sleep time by the relative time inSeconds.
 131 #if   defined( HAVE_POSIX_THREAD )
 132     #define Condition_TimedWait( Cond, inSeconds ) do {                         \
 133         struct timespec absTimeout;                                             \
 134         absTimeout.tv_sec  = time( NULL ) + inSeconds;                          \
 135         absTimeout.tv_nsec = 0;                                                 \
 136        pthread_cond_timedwait( &(Cond)->mCondition, &(Cond)->mMutex, &absTimeout ); \
 137     } while ( 0 )
 138 #elif defined( HAVE_WIN32_THREAD )
 139     // atomically release mutex and wait on condition,
 140     // then re-acquire the mutex
 141     #define Condition_TimedWait( Cond, inSeconds ) do {                         \
 142         SignalObjectAndWait( (Cond)->mMutex, (Cond)->mCondition, inSeconds*1000, false ); \
 143         Mutex_Lock( &(Cond)->mMutex );                          \
 144     } while ( 0 )
 145 #else
 146     #define Condition_TimedWait( Cond, inSeconds )
 147 #endif
 148
 149     // send a condition signal to wake one thread waiting on condition
 150     // in Win32, this actually wakes up all threads, same as Broadcast
 151     // use PulseEvent to auto-reset the signal after waking all threads
 152 #if   defined( HAVE_POSIX_THREAD )
 153     #define Condition_Signal( Cond ) pthread_cond_signal( &(Cond)->mCondition )
 154 #elif defined( HAVE_WIN32_THREAD )
 155     #define Condition_Signal( Cond ) PulseEvent( (Cond)->mCondition )
 156 #else
 157     #define Condition_Signal( Cond )
 158 #endif
 159
 160     // send a condition signal to wake all threads waiting on condition
 161 #if   defined( HAVE_POSIX_THREAD )
 162     #define Condition_Broadcast( Cond ) pthread_cond_broadcast( &(Cond)->mCondition )
 163 #elif defined( HAVE_WIN32_THREAD )
 164     #define Condition_Broadcast( Cond ) PulseEvent( (Cond)->mCondition )
 165 #else
 166     #define Condition_Broadcast( Cond )
 167 #endif
 168
 169 #endif // CONDITION_H