mono/io-layer/mono-mutex.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * mono-mutex.h: Portability wrappers around POSIX Mutexes
   4  *
   5  * Authors: Jeffrey Stedfast <fejj@ximian.com>
   6  *
   7  * Copyright 2002 Ximian, Inc. (www.ximian.com)
   8  */
   9
  10
  11 #ifndef __MONO_MUTEX_H__
  12 #define __MONO_MUTEX_H__
  13
  14 #include <glib.h>
  15 #ifdef HAVE_PTHREAD_H
  16 #include <pthread.h>
  17 #endif
  18 #include <time.h>
  19
  20 G_BEGIN_DECLS
  21
  22 #ifndef HOST_WIN32
  23
  24 typedef struct {
  25         pthread_mutex_t mutex;
  26         gboolean complete;
  27 } mono_once_t;
  28
  29 #define MONO_ONCE_INIT { PTHREAD_MUTEX_INITIALIZER, FALSE }
  30
  31 int mono_once (mono_once_t *once, void (*once_init) (void));
  32
  33
  34 #ifdef USE_MONO_MUTEX
  35
  36 #define MONO_THREAD_NONE ((pthread_t)~0)
  37
  38 /* mutex types... */
  39 enum {
  40         MONO_MUTEX_NORMAL,
  41         MONO_MUTEX_RECURSIVE,
  42         MONO_MUTEX_ERRORCHECK = MONO_MUTEX_NORMAL,
  43         MONO_MUTEX_DEFAULT = MONO_MUTEX_NORMAL
  44 };
  45
  46 /* mutex protocol attributes... */
  47 enum {
  48         MONO_THREAD_PRIO_NONE,
  49         MONO_THREAD_PRIO_INHERIT,
  50         MONO_THREAD_PRIO_PROTECT,
  51 };
  52
  53 /* mutex process sharing attributes... */
  54 enum {
  55         MONO_THREAD_PROCESS_PRIVATE,
  56         MONO_THREAD_PROCESS_SHARED
  57 };
  58
  59 typedef struct _mono_mutexattr_t {
  60         int type     : 1;
  61         int shared   : 1;
  62         int protocol : 2;
  63         int priority : 28;
  64 } mono_mutexattr_t;
  65
  66 typedef struct _mono_mutex_t {
  67         int type;
  68         pthread_t owner;
  69         short waiters;
  70         short depth;
  71         pthread_mutex_t mutex;
  72         pthread_cond_t cond;
  73 } mono_mutex_t;
  74
  75 /* static initializers */
  76 #define MONO_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, 0 }
  77 #define MONO_RECURSIVE_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, PTHREAD_COND_INITIALIZER }
  78
  79 int mono_mutexattr_init (mono_mutexattr_t *attr);
  80 int mono_mutexattr_settype (mono_mutexattr_t *attr, int type);
  81 int mono_mutexattr_gettype (mono_mutexattr_t *attr, int *type);
  82 int mono_mutexattr_setpshared (mono_mutexattr_t *attr, int pshared);
  83 int mono_mutexattr_getpshared (mono_mutexattr_t *attr, int *pshared);
  84 int mono_mutexattr_setprotocol (mono_mutexattr_t *attr, int protocol);
  85 int mono_mutexattr_getprotocol (mono_mutexattr_t *attr, int *protocol);
  86 int mono_mutexattr_setprioceiling (mono_mutexattr_t *attr, int prioceiling);
  87 int mono_mutexattr_getprioceiling (mono_mutexattr_t *attr, int *prioceiling);
  88 int mono_mutexattr_destroy (mono_mutexattr_t *attr);
  89
  90
  91 int mono_mutex_init (mono_mutex_t *mutex, const mono_mutexattr_t *attr);
  92 int mono_mutex_lock (mono_mutex_t *mutex);
  93 int mono_mutex_trylock (mono_mutex_t *mutex);
  94 int mono_mutex_timedlock (mono_mutex_t *mutex, const struct timespec *timeout);
  95 int mono_mutex_unlock (mono_mutex_t *mutex);
  96 int mono_mutex_destroy (mono_mutex_t *mutex);
  97
  98 #define mono_cond_init(cond,attr) pthread_cond_init (cond, attr)
  99 int mono_cond_wait (pthread_cond_t *cond, mono_mutex_t *mutex);
 100 int mono_cond_timedwait (pthread_cond_t *cond, mono_mutex_t *mutex, const struct timespec *timeout);
 101 #define mono_cond_signal(cond) pthread_cond_signal (cond)
 102 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
 103 #define mono_cond_destroy(cond)
 104
 105 #else /* system is equipped with a fully-functional pthread mutex library */
 106
 107 #define MONO_MUTEX_NORMAL             PTHREAD_MUTEX_NORMAL
 108 #define MONO_MUTEX_RECURSIVE          PTHREAD_MUTEX_RECURSIVE
 109 #define MONO_MUTEX_ERRORCHECK         PTHREAD_MUTEX_NORMAL
 110 #define MONO_MUTEX_DEFAULT            PTHREAD_MUTEX_NORMAL
 111
 112 #define MONO_THREAD_PRIO_NONE         PTHREAD_PRIO_NONE
 113 #define MONO_THREAD_PRIO_INHERIT      PTHREAD_PRIO_INHERIT
 114 #define MONO_THREAD_PRIO_PROTECT      PTHREAD_PRIO_PROTECT
 115
 116 #define MONO_THREAD_PROCESS_PRIVATE   PTHREAD_PROCESS_PRIVATE
 117 #define MONO_THREAD_PROCESS_SHARED    PTHREAD_PROCESS_SHARED
 118
 119 typedef pthread_mutex_t mono_mutex_t;
 120 typedef pthread_mutexattr_t mono_mutexattr_t;
 121 typedef pthread_cond_t mono_cond_t;
 122
 123 #define MONO_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
 124 #define MONO_RECURSIVE_MUTEX_INITIALIZER PTHREAD_RECURSIVE_MUTEX_INITIALIZER
 125 #define MONO_COND_INITIALIZER PTHREAD_COND_INITIALIZER
 126
 127 #define mono_mutexattr_init(attr) pthread_mutexattr_init (attr)
 128 #define mono_mutexattr_settype(attr,type) pthread_mutexattr_settype (attr, type)
 129 #define mono_mutexattr_gettype(attr,type) pthread_mutexattr_gettype (attr, type)
 130 #define mono_mutexattr_setpshared(attr,pshared) pthread_mutexattr_setpshared (attr, pshared)
 131 #define mono_mutexattr_getpshared(attr,pshared) pthread_mutexattr_getpshared (attr, pshared)
 132 #define mono_mutexattr_setprotocol(attr,protocol) pthread_mutexattr_setprotocol (attr, protocol)
 133 #define mono_mutexattr_getprotocol(attr,protocol) pthread_mutexattr_getprotocol (attr, protocol)
 134 #define mono_mutexattr_setprioceiling(attr,prioceiling) pthread_mutexattr_setprioceiling (attr, prioceiling)
 135 #define mono_mutexattr_getprioceiling(attr,prioceiling) pthread_mutexattr_getprioceiling (attr, prioceiling)
 136 #define mono_mutexattr_destroy(attr) pthread_mutexattr_destroy (attr)
 137
 138 #define mono_mutex_init(mutex,attr) pthread_mutex_init (mutex, attr)
 139 #define mono_mutex_lock(mutex) pthread_mutex_lock (mutex)
 140 #define mono_mutex_trylock(mutex) pthread_mutex_trylock (mutex)
 141 #define mono_mutex_timedlock(mutex,timeout) pthread_mutex_timedlock (mutex, timeout)
 142 #define mono_mutex_unlock(mutex) pthread_mutex_unlock (mutex)
 143 #define mono_mutex_destroy(mutex) pthread_mutex_destroy (mutex)
 144
 145 #define mono_cond_init(cond,attr) pthread_cond_init (cond,attr)
 146 #define mono_cond_wait(cond,mutex) pthread_cond_wait (cond, mutex)
 147 #define mono_cond_timedwait(cond,mutex,timeout) pthread_cond_timedwait (cond, mutex, timeout)
 148 #define mono_cond_signal(cond) pthread_cond_signal (cond)
 149 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
 150 #define mono_cond_destroy(cond)
 151
 152 #endif /* USE_MONO_MUTEX */
 153
 154 /* This is a function so it can be passed to pthread_cleanup_push -
 155  * that is a macro and giving it a macro as a parameter breaks.
 156  */
 157 G_GNUC_UNUSED
 158 static inline int mono_mutex_unlock_in_cleanup (mono_mutex_t *mutex)
 159 {
 160         return(mono_mutex_unlock (mutex));
 161 }
 162
 163 #else
 164
 165 typedef CRITICAL_SECTION mono_mutex_t;
 166 typedef HANDLE mono_cond_t;
 167
 168 #define mono_mutex_init(mutex,attr) InitializeCriticalSection((mutex))
 169 #define mono_mutex_lock(mutex) EnterCriticalSection((mutex))
 170 #define mono_mutex_trylock(mutex) TryEnterCriticalSection((mutex))
 171 #define mono_mutex_unlock(mutex)  LeaveCriticalSection((mutex))
 172 #define mono_mutex_destroy(mutex) DeleteCriticalSection((mutex))
 173
 174
 175 #define mono_cond_init(cond,attr) do{*(cond) = CreateEvent(NULL,FALSE,FALSE,NULL); } while (0)
 176 #define mono_cond_wait(cond,mutex) WaitForSingleObject(*(cond),INFINITE)
 177 #define mono_cond_timedwait(cond,mutex,timeout) WaitForSingleObject(*(cond),timeout)
 178 #define mono_cond_signal(cond) SetEvent(*(cond))
 179 #define mono_cond_broadcast(cond) (!SetEvent(*(cond)))
 180 #define mono_cond_destroy(cond) CloseHandle(*(cond))
 181
 182 #define MONO_COND_INITIALIZER NULL
 183 #endif
 184
 185 G_END_DECLS
 186
 187 #endif /* __MONO_MUTEX_H__ */