mono/io-layer/mono-mutex.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  *  Authors: Jeffrey Stedfast <fejj@ximian.com>
   4  *
   5  *  Copyright 2002 Ximain, Inc. (www.ximian.com)
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
  20  *
  21  */
  22
  23
  24 #ifndef __MONO_MUTEX_H__
  25 #define __MONO_MUTEX_H__
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #pragma }
  30 #endif /* __cplusplus */
  31
  32 #include <glib.h>
  33 #include <pthread.h>
  34 #include <time.h>
  35
  36 typedef struct {
  37         pthread_mutex_t mutex;
  38         gboolean complete;
  39 } mono_once_t;
  40
  41 #define MONO_ONCE_INIT { PTHREAD_MUTEX_INITIALIZER, FALSE }
  42
  43 int mono_once (mono_once_t *once, void (*once_init) (void));
  44
  45
  46 #ifdef USE_MONO_MUTEX
  47
  48 #define MONO_THREAD_NONE ((pthread_t)~0)
  49
  50 /* mutex types... */
  51 enum {
  52         MONO_MUTEX_NORMAL,
  53         MONO_MUTEX_RECURSIVE,
  54         MONO_MUTEX_ERRORCHECK = MONO_MUTEX_NORMAL,
  55         MONO_MUTEX_DEFAULT = MONO_MUTEX_NORMAL
  56 };
  57
  58 /* mutex protocol attributes... */
  59 enum {
  60         MONO_THREAD_PRIO_NONE,
  61         MONO_THREAD_PRIO_INHERIT,
  62         MONO_THREAD_PRIO_PROTECT,
  63 };
  64
  65 /* mutex process sharing attributes... */
  66 enum {
  67         MONO_THREAD_PROCESS_PRIVATE,
  68         MONO_THREAD_PROCESS_SHARED
  69 };
  70
  71 typedef struct _mono_mutexattr_t {
  72         int type     : 1;
  73         int shared   : 1;
  74         int protocol : 2;
  75         int priority : 28;
  76 } mono_mutexattr_t;
  77
  78 typedef struct _mono_mutex_t {
  79         int type;
  80         pthread_t owner;
  81         short waiters;
  82         short depth;
  83         pthread_mutex_t mutex;
  84         pthread_cond_t cond;
  85 } mono_mutex_t;
  86
  87 /* static initializers */
  88 #define MONO_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, 0 }
  89 #define MONO_RECURSIVE_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, PTHREAD_COND_INITIALIZER }
  90
  91
  92 int mono_mutexattr_init (mono_mutexattr_t *attr);
  93 int mono_mutexattr_settype (mono_mutexattr_t *attr, int type);
  94 int mono_mutexattr_gettype (mono_mutexattr_t *attr, int *type);
  95 int mono_mutexattr_setpshared (mono_mutexattr_t *attr, int pshared);
  96 int mono_mutexattr_getpshared (mono_mutexattr_t *attr, int *pshared);
  97 int mono_mutexattr_setprotocol (mono_mutexattr_t *attr, int protocol);
  98 int mono_mutexattr_getprotocol (mono_mutexattr_t *attr, int *protocol);
  99 int mono_mutexattr_setprioceiling (mono_mutexattr_t *attr, int prioceiling);
 100 int mono_mutexattr_getprioceiling (mono_mutexattr_t *attr, int *prioceiling);
 101 int mono_mutexattr_destroy (mono_mutexattr_t *attr);
 102
 103
 104 int mono_mutex_init (mono_mutex_t *mutex, const mono_mutexattr_t *attr);
 105 int mono_mutex_lock (mono_mutex_t *mutex);
 106 int mono_mutex_trylock (mono_mutex_t *mutex);
 107 int mono_mutex_timedlock (mono_mutex_t *mutex, const struct timespec *timeout);
 108 int mono_mutex_unlock (mono_mutex_t *mutex);
 109 int mono_mutex_destroy (mono_mutex_t *mutex);
 110
 111 #define mono_cond_init(cond,attr) pthread_cond_init (cond, attr)
 112 int mono_cond_wait (pthread_cond_t *cond, mono_mutex_t *mutex);
 113 int mono_cond_timedwait (pthread_cond_t *cond, mono_mutex_t *mutex, const struct timespec *timeout);
 114 #define mono_cond_signal(cond) pthread_cond_signal (cond)
 115 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
 116
 117 #else /* system is equipped with a fully-functional pthread mutex library */
 118
 119 #define MONO_MUTEX_NORMAL             PTHREAD_MUTEX_NORMAL
 120 #define MONO_MUTEX_RECURSIVE          PTHREAD_MUTEX_RECURSIVE
 121 #define MONO_MUTEX_ERRORCHECK         PTHREAD_MUTEX_NORMAL
 122 #define MONO_MUTEX_DEFAULT            PTHREAD_MUTEX_NORMAL
 123
 124 #define MONO_THREAD_PRIO_NONE         PTHREAD_PRIO_NONE
 125 #define MONO_THREAD_PRIO_INHERIT      PTHREAD_PRIO_INHERIT
 126 #define MONO_THREAD_PRIO_PROTECT      PTHREAD_PRIO_PROTECT
 127
 128 #define MONO_THREAD_PROCESS_PRIVATE   PTHREAD_PROCESS_PRIVATE
 129 #define MONO_THREAD_PROCESS_SHARED    PTHREAD_PROCESS_SHARED
 130
 131 typedef pthread_mutex_t mono_mutex_t;
 132 typedef pthread_mutexattr_t mono_mutexattr_t;
 133
 134 #define MONO_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
 135 #define MONO_RECURSIVE_MUTEX_INITIALIZER PTHREAD_RECURSIVE_MUTEX_INITIALIZER
 136
 137 #define mono_mutexattr_init(attr) pthread_mutexattr_init (attr)
 138 #define mono_mutexattr_settype(attr,type) pthread_mutexattr_settype (attr, type)
 139 #define mono_mutexattr_gettype(attr,type) pthread_mutexattr_gettype (attr, type)
 140 #define mono_mutexattr_setpshared(attr,pshared) pthread_mutexattr_setpshared (attr, pshared)
 141 #define mono_mutexattr_getpshared(attr,pshared) pthread_mutexattr_getpshared (attr, pshared)
 142 #define mono_mutexattr_setprotocol(attr,protocol) pthread_mutexattr_setprotocol (attr, protocol)
 143 #define mono_mutexattr_getprotocol(attr,protocol) pthread_mutexattr_getprotocol (attr, protocol)
 144 #define mono_mutexattr_setprioceiling(attr,prioceiling) pthread_mutexattr_setprioceiling (attr, prioceiling)
 145 #define mono_mutexattr_getprioceiling(attr,prioceiling) pthread_mutexattr_getprioceiling (attr, prioceiling)
 146
 147 #define mono_mutex_init(mutex,attr) pthread_mutex_init (mutex, attr)
 148 #define mono_mutex_lock(mutex) pthread_mutex_lock (mutex)
 149 #define mono_mutex_trylock(mutex) pthread_mutex_trylock (mutex)
 150 #define mono_mutex_timedlock(mutex,timeout) pthread_mutex_timedlock (mutex, timeout)
 151 #define mono_mutex_unlock(mutex) pthread_mutex_unlock (mutex)
 152 #define mono_mutex_destroy(mutex) pthread_mutex_destroy (mutex)
 153
 154 #define mono_cond_init(cond,attr) pthread_cond_init (cond,attr)
 155 #define mono_cond_wait(cond,mutex) pthread_cond_wait (cond, mutex)
 156 #define mono_cond_timedwait(cond,mutex,timeout) pthread_cond_timedwait (cond, mutex, timeout)
 157 #define mono_cond_signal(cond) pthread_cond_signal (cond)
 158 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
 159
 160 #endif /* USE_MONO_MUTEX */
 161
 162 /* This is a function so it can be passed to pthread_cleanup_push -
 163  * that is a macro and giving it a macro as a parameter breaks.
 164  */
 165 G_GNUC_UNUSED
 166 static inline int mono_mutex_unlock_in_cleanup (mono_mutex_t *mutex)
 167 {
 168         return(mono_mutex_unlock (mutex));
 169 }
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif /* __cplusplus */
 174
 175 #endif /* __MONO_MUTEX_H__ */