4f9a97523e2d63e92405466bd814d1f1668a41ba
[mono.git] / mono / utils / 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 #ifndef __MONO_MUTEX_H__
11 #define __MONO_MUTEX_H__
12
13 #include <config.h>
14
15 #include <glib.h>
16 #ifdef HAVE_PTHREAD_H
17 #include <pthread.h>
18 #endif
19 #include <time.h>
20
21 #ifdef HOST_WIN32
22 #include <winsock2.h>
23 #include <windows.h>
24 #endif
25
26 G_BEGIN_DECLS
27
28 #ifndef HOST_WIN32
29
30 typedef struct {
31         pthread_mutex_t mutex;
32         gboolean complete;
33 } mono_once_t;
34
35 #define MONO_ONCE_INIT { PTHREAD_MUTEX_INITIALIZER, FALSE }
36
37 int mono_once (mono_once_t *once, void (*once_init) (void));
38
39 typedef pthread_mutex_t mono_mutex_t;
40 typedef pthread_cond_t mono_cond_t;
41
42 #define mono_mutex_init(mutex) pthread_mutex_init (mutex, NULL)
43 #define mono_mutex_lock(mutex) pthread_mutex_lock (mutex)
44 #define mono_mutex_trylock(mutex) pthread_mutex_trylock (mutex)
45 #define mono_mutex_timedlock(mutex,timeout) pthread_mutex_timedlock (mutex, timeout)
46 #define mono_mutex_unlock(mutex) pthread_mutex_unlock (mutex)
47 #define mono_mutex_destroy(mutex) pthread_mutex_destroy (mutex)
48
49 #define mono_cond_init(cond,attr) pthread_cond_init (cond,attr)
50 #define mono_cond_wait(cond,mutex) pthread_cond_wait (cond, mutex)
51 #define mono_cond_timedwait(cond,mutex,timeout) pthread_cond_timedwait (cond, mutex, timeout)
52 #define mono_cond_signal(cond) pthread_cond_signal (cond)
53 #define mono_cond_broadcast(cond) pthread_cond_broadcast (cond)
54 #define mono_cond_destroy(cond)
55
56 /*
57  * This should be used instead of mono_cond_timedwait, since that function is not implemented on windows.
58  */
59 int mono_cond_timedwait_ms (mono_cond_t *cond, mono_mutex_t *mutex, int timeout_ms);
60
61 /* This is a function so it can be passed to pthread_cleanup_push -
62  * that is a macro and giving it a macro as a parameter breaks.
63  */
64 G_GNUC_UNUSED
65 static inline int mono_mutex_unlock_in_cleanup (mono_mutex_t *mutex)
66 {
67         return(mono_mutex_unlock (mutex));
68 }
69
70 /* Returns zero on success. */
71 static inline int
72 mono_mutex_init_recursive (mono_mutex_t *mutex)
73 {
74         int res;
75         pthread_mutexattr_t attr;
76
77         pthread_mutexattr_init (&attr);
78         pthread_mutexattr_settype (&attr, PTHREAD_MUTEX_RECURSIVE);
79         res = pthread_mutex_init (mutex, &attr);
80         pthread_mutexattr_destroy (&attr);
81
82         return res;
83 }
84
85 #else
86
87 typedef CRITICAL_SECTION mono_mutex_t;
88 typedef CONDITION_VARIABLE mono_cond_t;
89
90 #define mono_mutex_init(mutex) (InitializeCriticalSection((mutex)), 0)
91 #define mono_mutex_init_recursive(mutex) (InitializeCriticalSection((mutex)), 0)
92 #define mono_mutex_lock(mutex) EnterCriticalSection((mutex))
93 #define mono_mutex_trylock(mutex) (!TryEnterCriticalSection((mutex)))
94 #define mono_mutex_unlock(mutex)  LeaveCriticalSection((mutex))
95 #define mono_mutex_destroy(mutex) DeleteCriticalSection((mutex))
96
97 static inline int
98 mono_cond_init (mono_cond_t *cond, int attr)
99 {
100         InitializeConditionVariable (cond);
101         return 0;
102 }
103
104 static inline int
105 mono_cond_wait (mono_cond_t *cond, mono_mutex_t *mutex)
106 {
107         return SleepConditionVariableCS (cond, mutex, INFINITE) ? 0 : 1;
108 }
109
110 static inline int
111 mono_cond_timedwait (mono_cond_t *cond, mono_mutex_t *mutex, struct timespec *timeout)
112 {
113         // FIXME:
114         g_assert_not_reached ();
115         return 0;
116 }
117
118 static inline int
119 mono_cond_signal (mono_cond_t *cond)
120 {
121         WakeConditionVariable (cond);
122         return 0;
123 }
124
125 static inline int
126 mono_cond_broadcast (mono_cond_t *cond)
127 {
128         WakeAllConditionVariable (cond);
129         return 0;
130 }
131
132 static inline int
133 mono_cond_destroy (mono_cond_t *cond)
134 {
135         return 0;
136 }
137
138 static inline int
139 mono_cond_timedwait_ms (mono_cond_t *cond, mono_mutex_t *mutex, int timeout_ms)
140 {
141         return SleepConditionVariableCS (cond, mutex, timeout_ms) ? 0 : 1;
142 }
143
144 #endif
145
146 int mono_mutex_init_suspend_safe (mono_mutex_t *mutex);
147
148 G_END_DECLS
149
150 #endif /* __MONO_MUTEX_H__ */