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