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 #include <pthread.h>
  16 #include <time.h>
  17
  18 G_BEGIN_DECLS
  19
  20 typedef struct {
  21         pthread_mutex_t mutex;
  22         gboolean complete;
  23 } mono_once_t;
  24
  25 #define MONO_ONCE_INIT { PTHREAD_MUTEX_INITIALIZER, FALSE }
  26
  27 int mono_once (mono_once_t *once, void (*once_init) (void));
  28
  29
  30 #ifdef USE_MONO_MUTEX
  31
  32 #define MONO_THREAD_NONE ((pthread_t)~0)
  33
  34 /* mutex types... */
  35 enum {
  36         MONO_MUTEX_NORMAL,
  37         MONO_MUTEX_RECURSIVE,
  38         MONO_MUTEX_ERRORCHECK = MONO_MUTEX_NORMAL,
  39         MONO_MUTEX_DEFAULT = MONO_MUTEX_NORMAL
  40 };
  41
  42 /* mutex protocol attributes... */
  43 enum {
  44         MONO_THREAD_PRIO_NONE,
  45         MONO_THREAD_PRIO_INHERIT,
  46         MONO_THREAD_PRIO_PROTECT,
  47 };
  48
  49 /* mutex process sharing attributes... */
  50 enum {
  51         MONO_THREAD_PROCESS_PRIVATE,
  52         MONO_THREAD_PROCESS_SHARED
  53 };
  54
  55 typedef struct _mono_mutexattr_t {
  56         int type     : 1;
  57         int shared   : 1;
  58         int protocol : 2;
  59         int priority : 28;
  60 } mono_mutexattr_t;
  61
  62 typedef struct _mono_mutex_t {
  63         int type;
  64         pthread_t owner;
  65         short waiters;
  66         short depth;
  67         pthread_mutex_t mutex;
  68         pthread_cond_t cond;
  69 } mono_mutex_t;
  70
  71 /* static initializers */
  72 #define MONO_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, 0 }
  73 #define MONO_RECURSIVE_MUTEX_INITIALIZER { 0, MONO_THREAD_NONE, 0, 0, PTHREAD_MUTEX_INITIALIZER, PTHREAD_COND_INITIALIZER }
  74
  75 int mono_mutexattr_init (mono_mutexattr_t *attr);
  76 int mono_mutexattr_settype (mono_mutexattr_t *attr, int type);
  77 int mono_mutexattr_gettype (mono_mutexattr_t *attr, int *type);
  78 int mono_mutexattr_setpshared (mono_mutexattr_t *attr, int pshared);
  79 int mono_mutexattr_getpshared (mono_mutexattr_t *attr, int *pshared);
  80 int mono_mutexattr_setprotocol (mono_mutexattr_t *attr, int protocol);
  81 int mono_mutexattr_getprotocol (mono_mutexattr_t *attr, int *protocol);
  82 int mono_mutexattr_setprioceiling (mono_mutexattr_t *attr, int prioceiling);
  83 int mono_mutexattr_getprioceiling (mono_mutexattr_t *attr, int *prioceiling);
  84 int mono_mutexattr_destroy (mono_mutexattr_t *attr);
  85
  86
  87 int mono_mutex_init (mono_mutex_t *mutex, const mono_mutexattr_t *attr);
  88 int mono_mutex_lock (mono_mutex_t *mutex);
  89 int mono_mutex_trylock (mono_mutex_t *mutex);
  90 int mono_mutex_timedlock (mono_mutex_t *mutex, const struct timespec *timeout);
  91 int mono_mutex_unlock (mono_mutex_t *mutex);
  92 int mono_mutex_destroy (mono_mutex_t *mutex);
  93
  94 #define mono_cond_init(cond,attr) pthread_cond_init (cond, attr)
  95 int mono_cond_wait (pthread_cond_t *cond, mono_mutex_t *mutex);
  96 int mono_cond_timedwait (pthread_cond_t *cond, mono_mutex_t *mutex, const struct timespec *timeout);
  97 #define mono_cond_signal(cond) pthread_cond_signal (cond)
  98 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
  99
 100 #else /* system is equipped with a fully-functional pthread mutex library */
 101
 102 #define MONO_MUTEX_NORMAL             PTHREAD_MUTEX_NORMAL
 103 #define MONO_MUTEX_RECURSIVE          PTHREAD_MUTEX_RECURSIVE
 104 #define MONO_MUTEX_ERRORCHECK         PTHREAD_MUTEX_NORMAL
 105 #define MONO_MUTEX_DEFAULT            PTHREAD_MUTEX_NORMAL
 106
 107 #define MONO_THREAD_PRIO_NONE         PTHREAD_PRIO_NONE
 108 #define MONO_THREAD_PRIO_INHERIT      PTHREAD_PRIO_INHERIT
 109 #define MONO_THREAD_PRIO_PROTECT      PTHREAD_PRIO_PROTECT
 110
 111 #define MONO_THREAD_PROCESS_PRIVATE   PTHREAD_PROCESS_PRIVATE
 112 #define MONO_THREAD_PROCESS_SHARED    PTHREAD_PROCESS_SHARED
 113
 114 typedef pthread_mutex_t mono_mutex_t;
 115 typedef pthread_mutexattr_t mono_mutexattr_t;
 116
 117 #define MONO_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
 118 #define MONO_RECURSIVE_MUTEX_INITIALIZER PTHREAD_RECURSIVE_MUTEX_INITIALIZER
 119
 120 #define mono_mutexattr_init(attr) pthread_mutexattr_init (attr)
 121 #define mono_mutexattr_settype(attr,type) pthread_mutexattr_settype (attr, type)
 122 #define mono_mutexattr_gettype(attr,type) pthread_mutexattr_gettype (attr, type)
 123 #define mono_mutexattr_setpshared(attr,pshared) pthread_mutexattr_setpshared (attr, pshared)
 124 #define mono_mutexattr_getpshared(attr,pshared) pthread_mutexattr_getpshared (attr, pshared)
 125 #define mono_mutexattr_setprotocol(attr,protocol) pthread_mutexattr_setprotocol (attr, protocol)
 126 #define mono_mutexattr_getprotocol(attr,protocol) pthread_mutexattr_getprotocol (attr, protocol)
 127 #define mono_mutexattr_setprioceiling(attr,prioceiling) pthread_mutexattr_setprioceiling (attr, prioceiling)
 128 #define mono_mutexattr_getprioceiling(attr,prioceiling) pthread_mutexattr_getprioceiling (attr, prioceiling)
 129 #define mono_mutexattr_destroy(attr) pthread_mutexattr_destroy (attr)
 130
 131 #define mono_mutex_init(mutex,attr) pthread_mutex_init (mutex, attr)
 132 #define mono_mutex_lock(mutex) pthread_mutex_lock (mutex)
 133 #define mono_mutex_trylock(mutex) pthread_mutex_trylock (mutex)
 134 #define mono_mutex_timedlock(mutex,timeout) pthread_mutex_timedlock (mutex, timeout)
 135 #define mono_mutex_unlock(mutex) pthread_mutex_unlock (mutex)
 136 #define mono_mutex_destroy(mutex) pthread_mutex_destroy (mutex)
 137
 138 #define mono_cond_init(cond,attr) pthread_cond_init (cond,attr)
 139 #define mono_cond_wait(cond,mutex) pthread_cond_wait (cond, mutex)
 140 #define mono_cond_timedwait(cond,mutex,timeout) pthread_cond_timedwait (cond, mutex, timeout)
 141 #define mono_cond_signal(cond) pthread_cond_signal (cond)
 142 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
 143
 144 #endif /* USE_MONO_MUTEX */
 145
 146 /* This is a function so it can be passed to pthread_cleanup_push -
 147  * that is a macro and giving it a macro as a parameter breaks.
 148  */
 149 G_GNUC_UNUSED
 150 static inline int mono_mutex_unlock_in_cleanup (mono_mutex_t *mutex)
 151 {
 152         return(mono_mutex_unlock (mutex));
 153 }
 154
 155 G_END_DECLS
 156
 157 #endif /* __MONO_MUTEX_H__ */