2 * w32semaphore-unix.c: Runtime support for managed Semaphore on Unix
5 * Ludovic Henry (luhenry@microsoft.com)
7 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
10 #include "w32semaphore.h"
12 #include "w32handle-namespace.h"
13 #include "mono/io-layer/io-layer.h"
14 #include "mono/utils/mono-logger-internals.h"
15 #include "mono/metadata/w32handle.h"
20 } MonoW32HandleSemaphore;
22 struct MonoW32HandleNamedSemaphore {
23 MonoW32HandleSemaphore s;
24 MonoW32HandleNamespace sharedns;
27 static gboolean sem_handle_own (gpointer handle, MonoW32HandleType type, guint32 *statuscode)
29 MonoW32HandleSemaphore *sem_handle;
31 *statuscode = WAIT_OBJECT_0;
33 if (!mono_w32handle_lookup (handle, type, (gpointer *)&sem_handle)) {
34 g_warning ("%s: error looking up %s handle %p",
35 __func__, mono_w32handle_ops_typename (type), handle);
39 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: owning %s handle %p",
40 __func__, mono_w32handle_ops_typename (type), handle);
44 if (sem_handle->val == 0)
45 mono_w32handle_set_signal_state (handle, FALSE, FALSE);
50 static void sema_signal(gpointer handle)
52 ves_icall_System_Threading_Semaphore_ReleaseSemaphore_internal(handle, 1, NULL);
55 static gboolean sema_own (gpointer handle, guint32 *statuscode)
57 return sem_handle_own (handle, MONO_W32HANDLE_SEM, statuscode);
60 static void namedsema_signal (gpointer handle)
62 ves_icall_System_Threading_Semaphore_ReleaseSemaphore_internal (handle, 1, NULL);
65 /* NB, always called with the shared handle lock held */
66 static gboolean namedsema_own (gpointer handle, guint32 *statuscode)
68 return sem_handle_own (handle, MONO_W32HANDLE_NAMEDSEM, statuscode);
71 static void sema_details (gpointer data)
73 MonoW32HandleSemaphore *sem = (MonoW32HandleSemaphore *)data;
74 g_print ("val: %5u, max: %5d", sem->val, sem->max);
77 static void namedsema_details (gpointer data)
79 MonoW32HandleNamedSemaphore *namedsem = (MonoW32HandleNamedSemaphore *)data;
80 g_print ("val: %5u, max: %5d, name: \"%s\"", namedsem->s.val, namedsem->s.max, namedsem->sharedns.name);
83 static const gchar* sema_typename (void)
88 static gsize sema_typesize (void)
90 return sizeof (MonoW32HandleSemaphore);
93 static const gchar* namedsema_typename (void)
98 static gsize namedsema_typesize (void)
100 return sizeof (MonoW32HandleNamedSemaphore);
104 mono_w32semaphore_init (void)
106 static MonoW32HandleOps sem_ops = {
108 sema_signal, /* signal */
111 NULL, /* special_wait */
113 sema_details, /* details */
114 sema_typename, /* typename */
115 sema_typesize, /* typesize */
118 static MonoW32HandleOps namedsem_ops = {
120 namedsema_signal, /* signal */
121 namedsema_own, /* own */
123 NULL, /* special_wait */
125 namedsema_details, /* details */
126 namedsema_typename, /* typename */
127 namedsema_typesize, /* typesize */
130 mono_w32handle_register_ops (MONO_W32HANDLE_SEM, &sem_ops);
131 mono_w32handle_register_ops (MONO_W32HANDLE_NAMEDSEM, &namedsem_ops);
133 mono_w32handle_register_capabilities (MONO_W32HANDLE_SEM,
134 (MonoW32HandleCapability)(MONO_W32HANDLE_CAP_WAIT | MONO_W32HANDLE_CAP_SIGNAL));
135 mono_w32handle_register_capabilities (MONO_W32HANDLE_NAMEDSEM,
136 (MonoW32HandleCapability)(MONO_W32HANDLE_CAP_WAIT | MONO_W32HANDLE_CAP_SIGNAL));
140 sem_handle_create (MonoW32HandleSemaphore *sem_handle, MonoW32HandleType type, gint32 initial, gint32 max)
144 sem_handle->val = initial;
145 sem_handle->max = max;
147 handle = mono_w32handle_new (type, sem_handle);
148 if (handle == INVALID_HANDLE_VALUE) {
149 g_warning ("%s: error creating %s handle",
150 __func__, mono_w32handle_ops_typename (type));
151 SetLastError (ERROR_GEN_FAILURE);
155 mono_w32handle_lock_handle (handle);
158 mono_w32handle_set_signal_state (handle, TRUE, FALSE);
160 mono_w32handle_unlock_handle (handle);
162 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: created %s handle %p",
163 __func__, mono_w32handle_ops_typename (type), handle);
169 sem_create (gint32 initial, gint32 max)
171 MonoW32HandleSemaphore sem_handle;
172 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: creating %s handle, initial %d max %d",
173 __func__, mono_w32handle_ops_typename (MONO_W32HANDLE_SEM), initial, max);
174 return sem_handle_create (&sem_handle, MONO_W32HANDLE_SEM, initial, max);
178 namedsem_create (gint32 initial, gint32 max, const gunichar2 *name)
183 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: creating %s handle, initial %d max %d name \"%s\"",
184 __func__, mono_w32handle_ops_typename (MONO_W32HANDLE_NAMEDSEM), initial, max, (const char*)name);
186 /* w32 seems to guarantee that opening named objects can't race each other */
187 mono_w32handle_namespace_lock ();
189 utf8_name = g_utf16_to_utf8 (name, -1, NULL, NULL, NULL);
191 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: Creating named sem name [%s] initial %d max %d", __func__, utf8_name, initial, max);
193 handle = mono_w32handle_namespace_search_handle (MONO_W32HANDLE_NAMEDSEM, utf8_name);
194 if (handle == INVALID_HANDLE_VALUE) {
195 /* The name has already been used for a different object. */
197 SetLastError (ERROR_INVALID_HANDLE);
199 /* Not an error, but this is how the caller is informed that the semaphore wasn't freshly created */
200 SetLastError (ERROR_ALREADY_EXISTS);
202 /* mono_w32handle_namespace_search_handle already adds a ref to the handle */
204 /* A new named semaphore */
205 MonoW32HandleNamedSemaphore namedsem_handle;
207 strncpy (&namedsem_handle.sharedns.name [0], utf8_name, MAX_PATH);
208 namedsem_handle.sharedns.name [MAX_PATH] = '\0';
210 handle = sem_handle_create ((MonoW32HandleSemaphore*) &namedsem_handle, MONO_W32HANDLE_NAMEDSEM, initial, max);
215 mono_w32handle_namespace_unlock ();
221 ves_icall_System_Threading_Semaphore_CreateSemaphore_internal (gint32 initialCount, gint32 maximumCount, MonoString *name, gint32 *error)
225 if (maximumCount <= 0) {
226 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: maximumCount <= 0", __func__);
228 *error = ERROR_INVALID_PARAMETER;
232 if (initialCount > maximumCount || initialCount < 0) {
233 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: initialCount > maximumCount or < 0", __func__);
235 *error = ERROR_INVALID_PARAMETER;
239 /* Need to blow away any old errors here, because code tests
240 * for ERROR_ALREADY_EXISTS on success (!) to see if a
241 * semaphore was freshly created
243 SetLastError (ERROR_SUCCESS);
246 sem = sem_create (initialCount, maximumCount);
248 sem = namedsem_create (initialCount, maximumCount, mono_string_chars (name));
250 *error = GetLastError ();
256 ves_icall_System_Threading_Semaphore_ReleaseSemaphore_internal (gpointer handle, gint32 releaseCount, gint32 *prevcount)
258 MonoW32HandleType type;
259 MonoW32HandleSemaphore *sem_handle;
263 SetLastError (ERROR_INVALID_HANDLE);
267 switch (type = mono_w32handle_get_type (handle)) {
268 case MONO_W32HANDLE_SEM:
269 case MONO_W32HANDLE_NAMEDSEM:
272 SetLastError (ERROR_INVALID_HANDLE);
276 if (!mono_w32handle_lookup (handle, type, (gpointer *)&sem_handle)) {
277 g_warning ("%s: error looking up sem handle %p", __func__, handle);
281 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: releasing %s handle %p",
282 __func__, mono_w32handle_ops_typename (type), handle);
284 mono_w32handle_lock_handle (handle);
286 /* Do this before checking for count overflow, because overflowing
287 * max is a listed technique for finding the current value */
289 *prevcount = sem_handle->val;
291 /* No idea why max is signed, but thats the spec :-( */
292 if (sem_handle->val + releaseCount > (guint32)sem_handle->max) {
293 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: %s handle %p val %d count %d max %d, max value would be exceeded",
294 __func__, mono_w32handle_ops_typename (type), handle, sem_handle->val, releaseCount, sem_handle->max);
298 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: %s handle %p val %d count %d max %d",
299 __func__, mono_w32handle_ops_typename (type), handle, sem_handle->val, releaseCount, sem_handle->max);
301 sem_handle->val += releaseCount;
302 mono_w32handle_set_signal_state (handle, TRUE, TRUE);
307 mono_w32handle_unlock_handle (handle);
313 ves_icall_System_Threading_Semaphore_OpenSemaphore_internal (MonoString *name, gint32 rights, gint32 *error)
318 *error = ERROR_SUCCESS;
320 /* w32 seems to guarantee that opening named objects can't race each other */
321 mono_w32handle_namespace_lock ();
323 utf8_name = g_utf16_to_utf8 (mono_string_chars (name), -1, NULL, NULL, NULL);
325 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: Opening named sem [%s]", __func__, utf8_name);
327 handle = mono_w32handle_namespace_search_handle (MONO_W32HANDLE_NAMEDSEM, utf8_name);
328 if (handle == INVALID_HANDLE_VALUE) {
329 /* The name has already been used for a different object. */
330 *error = ERROR_INVALID_HANDLE;
332 } else if (!handle) {
333 /* This name doesn't exist */
334 *error = ERROR_FILE_NOT_FOUND;
338 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_IO_LAYER, "%s: returning named sem handle %p", __func__, handle);
343 mono_w32handle_namespace_unlock ();
348 MonoW32HandleNamespace*
349 mono_w32semaphore_get_namespace (MonoW32HandleNamedSemaphore *semaphore)
351 return &semaphore->sharedns;