2 * w32handle.c: Generic and internal operations on handles
5 * Dick Porter (dick@ximian.com)
6 * Ludovic Henry (luhenry@microsoft.com)
8 * (C) 2002-2011 Novell, Inc.
9 * Copyright 2011 Xamarin Inc
10 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
15 #if !defined(HOST_WIN32)
25 #include <sys/types.h>
26 #ifdef HAVE_SYS_SOCKET_H
27 # include <sys/socket.h>
32 #ifdef HAVE_SYS_MMAN_H
33 # include <sys/mman.h>
39 #ifdef HAVE_SYS_RESOURCE_H
40 # include <sys/resource.h>
43 #include "w32handle.h"
46 #include "mono-logger-internals.h"
47 #include "mono-os-mutex.h"
48 #include "mono-proclib.h"
49 #include "mono-threads.h"
50 #include "mono-time.h"
54 #define SLOT_MAX (1024 * 16)
56 /* must be a power of 2 */
57 #define HANDLE_PER_SLOT (256)
59 #define INFINITE 0xFFFFFFFF
62 MonoW32HandleType type;
65 mono_mutex_t signal_mutex;
66 mono_cond_t signal_cond;
70 static MonoW32HandleCapability handle_caps [MONO_W32HANDLE_COUNT];
71 static MonoW32HandleOps *handle_ops [MONO_W32HANDLE_COUNT];
74 * We can hold SLOT_MAX * HANDLE_PER_SLOT handles.
75 * If 4M handles are not enough... Oh, well... we will crash.
77 #define SLOT_INDEX(x) (x / HANDLE_PER_SLOT)
78 #define SLOT_OFFSET(x) (x % HANDLE_PER_SLOT)
80 static MonoW32HandleBase *private_handles [SLOT_MAX];
81 static guint32 private_handles_count = 0;
82 static guint32 private_handles_slots_count = 0;
84 guint32 mono_w32handle_fd_reserve;
87 * This is an internal handle which is used for handling waiting for multiple handles.
88 * Threads which wait for multiple handles wait on this one handle, and when a handle
89 * is signalled, this handle is signalled too.
91 static mono_mutex_t global_signal_mutex;
92 static mono_cond_t global_signal_cond;
94 static mono_mutex_t scan_mutex;
96 static gboolean shutting_down = FALSE;
99 type_is_fd (MonoW32HandleType type)
102 case MONO_W32HANDLE_FILE:
103 case MONO_W32HANDLE_CONSOLE:
104 case MONO_W32HANDLE_SOCKET:
105 case MONO_W32HANDLE_PIPE:
113 mono_w32handle_lookup_data (gpointer handle, MonoW32HandleBase **handle_data)
117 g_assert (handle_data);
119 index = SLOT_INDEX ((gsize) handle);
120 if (index >= SLOT_MAX)
122 if (!private_handles [index])
125 offset = SLOT_OFFSET ((gsize) handle);
126 if (private_handles [index][offset].type == MONO_W32HANDLE_UNUSED)
129 *handle_data = &private_handles [index][offset];
134 mono_w32handle_get_type (gpointer handle)
136 MonoW32HandleBase *handle_data;
138 if (!mono_w32handle_lookup_data (handle, &handle_data))
139 return MONO_W32HANDLE_UNUSED; /* An impossible type */
141 return handle_data->type;
145 mono_w32handle_set_signal_state (gpointer handle, gboolean state, gboolean broadcast)
147 MonoW32HandleBase *handle_data;
149 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
154 g_message ("%s: setting state of %p to %s (broadcast %s)", __func__,
155 handle, state?"TRUE":"FALSE", broadcast?"TRUE":"FALSE");
159 /* Tell everyone blocking on a single handle */
161 /* The condition the global signal cond is waiting on is the signalling of
162 * _any_ handle. So lock it before setting the signalled state.
164 mono_os_mutex_lock (&global_signal_mutex);
166 /* This function _must_ be called with
167 * handle->signal_mutex locked
169 handle_data->signalled=state;
171 if (broadcast == TRUE) {
172 mono_os_cond_broadcast (&handle_data->signal_cond);
174 mono_os_cond_signal (&handle_data->signal_cond);
177 /* Tell everyone blocking on multiple handles that something
180 mono_os_cond_broadcast (&global_signal_cond);
182 mono_os_mutex_unlock (&global_signal_mutex);
184 handle_data->signalled=state;
189 mono_w32handle_issignalled (gpointer handle)
191 MonoW32HandleBase *handle_data;
193 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
197 return handle_data->signalled;
201 mono_w32handle_lock_signal_mutex (void)
204 g_message ("%s: lock global signal mutex", __func__);
207 mono_os_mutex_lock (&global_signal_mutex);
213 mono_w32handle_unlock_signal_mutex (void)
216 g_message ("%s: unlock global signal mutex", __func__);
219 mono_os_mutex_unlock (&global_signal_mutex);
225 mono_w32handle_lock_handle (gpointer handle)
227 MonoW32HandleBase *handle_data;
230 g_message ("%s: locking handle %p", __func__, handle);
233 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
237 mono_w32handle_ref (handle);
239 mono_os_mutex_lock (&handle_data->signal_mutex);
245 mono_w32handle_trylock_handle (gpointer handle)
247 MonoW32HandleBase *handle_data;
251 g_message ("%s: locking handle %p", __func__, handle);
254 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
258 mono_w32handle_ref (handle);
260 ret = mono_os_mutex_trylock (&handle_data->signal_mutex);
262 mono_w32handle_unref (handle);
269 mono_w32handle_unlock_handle (gpointer handle)
271 MonoW32HandleBase *handle_data;
274 g_message ("%s: unlocking handle %p", __func__, handle);
277 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
281 mono_os_mutex_unlock (&handle_data->signal_mutex);
283 mono_w32handle_unref (handle);
291 * Initialize the io-layer.
294 mono_w32handle_init (void)
296 static gboolean initialized = FALSE;
301 g_assert ((sizeof (handle_ops) / sizeof (handle_ops[0]))
302 == MONO_W32HANDLE_COUNT);
304 /* This is needed by the code in mono_w32handle_new_internal */
305 mono_w32handle_fd_reserve = (eg_getdtablesize () + (HANDLE_PER_SLOT - 1)) & ~(HANDLE_PER_SLOT - 1);
309 * The entries in private_handles reserved for fds are allocated lazily to
313 private_handles_count += HANDLE_PER_SLOT;
314 private_handles_slots_count ++;
315 } while(mono_w32handle_fd_reserve > private_handles_count);
317 mono_os_mutex_init (&scan_mutex);
319 mono_os_cond_init (&global_signal_cond);
320 mono_os_mutex_init (&global_signal_mutex);
326 mono_w32handle_cleanup (void)
330 g_assert (!shutting_down);
331 shutting_down = TRUE;
333 /* Every shared handle we were using ought really to be closed
334 * by now, but to make sure just blow them all away. The
335 * exiting finalizer thread in particular races us to the
336 * program exit and doesn't always win, so it can be left
337 * cluttering up the shared file. Anything else left over is
340 for(i = SLOT_INDEX (0); private_handles[i] != NULL; i++) {
341 for(j = SLOT_OFFSET (0); j < HANDLE_PER_SLOT; j++) {
342 MonoW32HandleBase *handle_data = &private_handles[i][j];
343 gpointer handle = GINT_TO_POINTER (i*HANDLE_PER_SLOT+j);
345 for(k = handle_data->ref; k > 0; k--) {
346 mono_w32handle_unref (handle);
351 for (i = 0; i < SLOT_MAX; ++i)
352 g_free (private_handles [i]);
355 static void mono_w32handle_init_handle (MonoW32HandleBase *handle,
356 MonoW32HandleType type, gpointer handle_specific)
358 g_assert (handle->ref == 0);
361 handle->signalled = FALSE;
364 mono_os_cond_init (&handle->signal_cond);
365 mono_os_mutex_init (&handle->signal_mutex);
368 handle->specific = g_memdup (handle_specific, mono_w32handle_ops_typesize (type));
372 * mono_w32handle_new_internal:
373 * @type: Init handle to this type
375 * Search for a free handle and initialize it. Return the handle on
376 * success and 0 on failure. This is only called from
377 * mono_w32handle_new, and scan_mutex must be held.
379 static guint32 mono_w32handle_new_internal (MonoW32HandleType type,
380 gpointer handle_specific)
383 static guint32 last = 0;
384 gboolean retry = FALSE;
386 /* A linear scan should be fast enough. Start from the last
387 * allocation, assuming that handles are allocated more often
388 * than they're freed. Leave the space reserved for file
392 if (last < mono_w32handle_fd_reserve) {
393 last = mono_w32handle_fd_reserve;
400 for(i = SLOT_INDEX (count); i < private_handles_slots_count; i++) {
401 if (private_handles [i]) {
402 for (k = SLOT_OFFSET (count); k < HANDLE_PER_SLOT; k++) {
403 MonoW32HandleBase *handle = &private_handles [i][k];
405 if(handle->type == MONO_W32HANDLE_UNUSED) {
408 mono_w32handle_init_handle (handle, type, handle_specific);
416 if(retry && last > mono_w32handle_fd_reserve) {
417 /* Try again from the beginning */
418 last = mono_w32handle_fd_reserve;
422 /* Will need to expand the array. The caller will sort it out */
428 mono_w32handle_new (MonoW32HandleType type, gpointer handle_specific)
430 guint32 handle_idx = 0;
433 g_assert (!shutting_down);
435 g_assert(!type_is_fd(type));
437 mono_os_mutex_lock (&scan_mutex);
439 while ((handle_idx = mono_w32handle_new_internal (type, handle_specific)) == 0) {
440 /* Try and expand the array, and have another go */
441 int idx = SLOT_INDEX (private_handles_count);
442 if (idx >= SLOT_MAX) {
446 private_handles [idx] = g_new0 (MonoW32HandleBase, HANDLE_PER_SLOT);
448 private_handles_count += HANDLE_PER_SLOT;
449 private_handles_slots_count ++;
452 mono_os_mutex_unlock (&scan_mutex);
454 if (handle_idx == 0) {
455 /* We ran out of slots */
456 handle = INVALID_HANDLE_VALUE;
457 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: failed to create %s handle", __func__, mono_w32handle_ops_typename (type));
461 /* Make sure we left the space for fd mappings */
462 g_assert (handle_idx >= mono_w32handle_fd_reserve);
464 handle = GUINT_TO_POINTER (handle_idx);
466 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: create %s handle %p", __func__, mono_w32handle_ops_typename (type), handle);
472 gpointer mono_w32handle_new_fd (MonoW32HandleType type, int fd,
473 gpointer handle_specific)
475 MonoW32HandleBase *handle_data;
476 int fd_index, fd_offset;
478 g_assert (!shutting_down);
480 g_assert(type_is_fd(type));
482 if (fd >= mono_w32handle_fd_reserve) {
483 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: failed to create %s handle, fd is too big", __func__, mono_w32handle_ops_typename (type));
485 return(GUINT_TO_POINTER (INVALID_HANDLE_VALUE));
488 fd_index = SLOT_INDEX (fd);
489 fd_offset = SLOT_OFFSET (fd);
491 /* Initialize the array entries on demand */
492 if (!private_handles [fd_index]) {
493 mono_os_mutex_lock (&scan_mutex);
495 if (!private_handles [fd_index])
496 private_handles [fd_index] = g_new0 (MonoW32HandleBase, HANDLE_PER_SLOT);
498 mono_os_mutex_unlock (&scan_mutex);
501 handle_data = &private_handles [fd_index][fd_offset];
503 if (handle_data->type != MONO_W32HANDLE_UNUSED) {
504 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: failed to create %s handle, fd is already in use", __func__, mono_w32handle_ops_typename (type));
505 /* FIXME: clean up this handle? We can't do anything
506 * with the fd, cos thats the new one
508 return(GUINT_TO_POINTER (INVALID_HANDLE_VALUE));
511 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: create %s handle %p", __func__, mono_w32handle_ops_typename (type), GUINT_TO_POINTER(fd));
513 mono_w32handle_init_handle (handle_data, type, handle_specific);
515 return(GUINT_TO_POINTER(fd));
519 mono_w32handle_lookup (gpointer handle, MonoW32HandleType type,
520 gpointer *handle_specific)
522 MonoW32HandleBase *handle_data;
524 g_assert (handle_specific);
526 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
530 if (handle_data->type != type) {
534 *handle_specific = handle_data->specific;
540 mono_w32handle_ref_core (gpointer handle, MonoW32HandleBase *handle_data);
543 mono_w32handle_unref_core (gpointer handle, MonoW32HandleBase *handle_data, guint minimum);
546 mono_w32handle_foreach (gboolean (*on_each)(gpointer handle, gpointer data, gpointer user_data), gpointer user_data)
550 mono_os_mutex_lock (&scan_mutex);
552 for (i = SLOT_INDEX (0); i < private_handles_slots_count; i++) {
553 if (!private_handles [i])
555 for (k = SLOT_OFFSET (0); k < HANDLE_PER_SLOT; k++) {
556 MonoW32HandleBase *handle_data = NULL;
558 gboolean destroy, finished;
560 handle_data = &private_handles [i][k];
561 if (handle_data->type == MONO_W32HANDLE_UNUSED)
564 handle = GUINT_TO_POINTER (i * HANDLE_PER_SLOT + k);
566 if (!mono_w32handle_ref_core (handle, handle_data)) {
567 /* we are racing with mono_w32handle_unref:
568 * the handle ref has been decremented, but it
569 * hasn't yet been destroyed. */
573 finished = on_each (handle, handle_data->specific, user_data);
575 /* we do not want to have to destroy the handle here,
576 * as it would means the ref/unref are unbalanced */
577 destroy = mono_w32handle_unref_core (handle, handle_data, 2);
586 mono_os_mutex_unlock (&scan_mutex);
590 MonoW32HandleType type;
591 gboolean (*search_user_callback)(gpointer handle, gpointer data);
592 gpointer search_user_data;
594 gpointer handle_specific;
598 search_callback (gpointer handle, gpointer handle_specific, gpointer user_data)
600 SearchData *search_data = (SearchData*) user_data;
602 if (search_data->type != mono_w32handle_get_type (handle))
605 if (!search_data->search_user_callback (handle, search_data->search_user_data))
608 mono_w32handle_ref (handle);
609 search_data->handle = handle;
610 search_data->handle_specific = handle_specific;
614 /* This might list some shared handles twice if they are already
615 * opened by this process, and the check function returns FALSE the
616 * first time. Shared handles that are created during the search are
617 * unreffed if the check function returns FALSE, so callers must not
618 * rely on the handle persisting (unless the check function returns
620 * The caller owns the returned handle.
622 gpointer mono_w32handle_search (MonoW32HandleType type,
623 gboolean (*check)(gpointer test, gpointer user),
625 gpointer *handle_specific,
626 gboolean search_shared)
628 SearchData search_data;
630 memset (&search_data, 0, sizeof (search_data));
631 search_data.type = type;
632 search_data.search_user_callback = check;
633 search_data.search_user_data = user_data;
634 mono_w32handle_foreach (search_callback, &search_data);
636 *handle_specific = search_data.handle_specific;
637 return search_data.handle;
641 mono_w32handle_ref_core (gpointer handle, MonoW32HandleBase *handle_data)
646 old = handle_data->ref;
651 } while (InterlockedCompareExchange ((gint32*) &handle_data->ref, new, old) != old);
653 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: ref %s handle %p, ref: %d -> %d",
654 __func__, mono_w32handle_ops_typename (handle_data->type), handle, old, new);
660 mono_w32handle_unref_core (gpointer handle, MonoW32HandleBase *handle_data, guint minimum)
662 MonoW32HandleType type;
665 type = handle_data->type;
668 old = handle_data->ref;
669 if (!(old >= minimum))
670 g_error ("%s: handle %p has ref %d, it should be >= %d", __func__, handle, old, minimum);
673 } while (InterlockedCompareExchange ((gint32*) &handle_data->ref, new, old) != old);
675 /* handle_data might contain invalid data from now on, if
676 * another thread is unref'ing this handle at the same time */
678 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: unref %s handle %p, ref: %d -> %d destroy: %s",
679 __func__, mono_w32handle_ops_typename (type), handle, old, new, new == 0 ? "true" : "false");
684 void mono_w32handle_ref (gpointer handle)
686 MonoW32HandleBase *handle_data;
688 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
689 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: failed to ref handle %p, unknown handle", __func__, handle);
693 if (!mono_w32handle_ref_core (handle, handle_data))
694 g_error ("%s: failed to ref handle %p", __func__, handle);
697 static void (*_wapi_handle_ops_get_close_func (MonoW32HandleType type))(gpointer, gpointer);
699 /* The handle must not be locked on entry to this function */
701 mono_w32handle_unref (gpointer handle)
703 MonoW32HandleBase *handle_data;
706 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
707 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: failed to unref handle %p, unknown handle",
712 destroy = mono_w32handle_unref_core (handle, handle_data, 1);
715 /* Need to copy the handle info, reset the slot in the
716 * array, and _only then_ call the close function to
717 * avoid race conditions (eg file descriptors being
718 * closed, and another file being opened getting the
719 * same fd racing the memset())
721 MonoW32HandleType type;
722 gpointer handle_specific;
723 void (*close_func)(gpointer, gpointer);
725 type = handle_data->type;
726 handle_specific = handle_data->specific;
728 mono_os_mutex_lock (&scan_mutex);
730 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: destroy %s handle %p", __func__, mono_w32handle_ops_typename (type), handle);
732 mono_os_mutex_destroy (&handle_data->signal_mutex);
733 mono_os_cond_destroy (&handle_data->signal_cond);
735 memset (handle_data, 0, sizeof (MonoW32HandleBase));
737 mono_os_mutex_unlock (&scan_mutex);
739 close_func = _wapi_handle_ops_get_close_func (type);
740 if (close_func != NULL) {
741 close_func (handle, handle_specific);
744 g_free (handle_specific);
749 mono_w32handle_register_ops (MonoW32HandleType type, MonoW32HandleOps *ops)
751 handle_ops [type] = ops;
754 void mono_w32handle_register_capabilities (MonoW32HandleType type,
755 MonoW32HandleCapability caps)
757 handle_caps[type] = caps;
760 gboolean mono_w32handle_test_capabilities (gpointer handle,
761 MonoW32HandleCapability caps)
763 MonoW32HandleBase *handle_data;
764 MonoW32HandleType type;
766 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
770 type = handle_data->type;
772 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: testing 0x%x against 0x%x (%d)", __func__,
773 handle_caps[type], caps, handle_caps[type] & caps);
775 return((handle_caps[type] & caps) != 0);
778 static void (*_wapi_handle_ops_get_close_func (MonoW32HandleType type))(gpointer, gpointer)
780 if (handle_ops[type] != NULL &&
781 handle_ops[type]->close != NULL) {
782 return (handle_ops[type]->close);
788 void mono_w32handle_ops_close (gpointer handle, gpointer data)
790 MonoW32HandleBase *handle_data;
791 MonoW32HandleType type;
793 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
797 type = handle_data->type;
799 if (handle_ops[type] != NULL &&
800 handle_ops[type]->close != NULL) {
801 handle_ops[type]->close (handle, data);
805 void mono_w32handle_ops_details (MonoW32HandleType type, gpointer data)
807 if (handle_ops[type] != NULL &&
808 handle_ops[type]->details != NULL) {
809 handle_ops[type]->details (data);
813 const gchar* mono_w32handle_ops_typename (MonoW32HandleType type)
815 g_assert (handle_ops [type]);
816 g_assert (handle_ops [type]->typename);
817 return handle_ops [type]->typename ();
820 gsize mono_w32handle_ops_typesize (MonoW32HandleType type)
822 g_assert (handle_ops [type]);
823 g_assert (handle_ops [type]->typesize);
824 return handle_ops [type]->typesize ();
827 void mono_w32handle_ops_signal (gpointer handle)
829 MonoW32HandleBase *handle_data;
830 MonoW32HandleType type;
832 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
836 type = handle_data->type;
838 if (handle_ops[type] != NULL && handle_ops[type]->signal != NULL) {
839 handle_ops[type]->signal (handle);
843 gboolean mono_w32handle_ops_own (gpointer handle, guint32 *statuscode)
845 MonoW32HandleBase *handle_data;
846 MonoW32HandleType type;
848 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
852 type = handle_data->type;
854 if (handle_ops[type] != NULL && handle_ops[type]->own_handle != NULL) {
855 return(handle_ops[type]->own_handle (handle, statuscode));
861 gboolean mono_w32handle_ops_isowned (gpointer handle)
863 MonoW32HandleBase *handle_data;
864 MonoW32HandleType type;
866 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
870 type = handle_data->type;
872 if (handle_ops[type] != NULL && handle_ops[type]->is_owned != NULL) {
873 return(handle_ops[type]->is_owned (handle));
879 guint32 mono_w32handle_ops_specialwait (gpointer handle, guint32 timeout, gboolean *alerted)
881 MonoW32HandleBase *handle_data;
882 MonoW32HandleType type;
884 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
888 type = handle_data->type;
890 if (handle_ops[type] != NULL &&
891 handle_ops[type]->special_wait != NULL) {
892 return(handle_ops[type]->special_wait (handle, timeout, alerted));
898 void mono_w32handle_ops_prewait (gpointer handle)
900 MonoW32HandleBase *handle_data;
901 MonoW32HandleType type;
903 if (!mono_w32handle_lookup_data (handle, &handle_data)) {
907 type = handle_data->type;
909 if (handle_ops[type] != NULL &&
910 handle_ops[type]->prewait != NULL) {
911 handle_ops[type]->prewait (handle);
918 struct timespec sleepytime;
920 g_assert (ms < 1000);
922 sleepytime.tv_sec = 0;
923 sleepytime.tv_nsec = ms * 1000000;
924 nanosleep (&sleepytime, NULL);
928 mono_w32handle_lock_handles (gpointer *handles, gsize numhandles)
933 /* Lock all the handles, with backoff */
935 for(i=0; i<numhandles; i++) {
936 gpointer handle = handles[i];
938 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: attempting to lock %p", __func__, handle);
940 thr_ret = mono_w32handle_trylock_handle (handle);
945 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: attempt failed for %p: %s", __func__,
946 handle, strerror (thr_ret));
951 thr_ret = mono_w32handle_unlock_handle (handle);
952 g_assert (thr_ret == 0);
955 /* If iter ever reaches 100 the nanosleep will
956 * return EINVAL immediately, but we have a
957 * design flaw if that happens.
961 g_warning ("%s: iteration overflow!",
966 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: Backing off for %d ms", __func__,
974 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: Locked all handles", __func__);
978 mono_w32handle_unlock_handles (gpointer *handles, gsize numhandles)
983 for(i=0; i<numhandles; i++) {
984 gpointer handle = handles[i];
986 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: unlocking handle %p", __func__, handle);
988 thr_ret = mono_w32handle_unlock_handle (handle);
989 g_assert (thr_ret == 0);
994 mono_w32handle_timedwait_signal_naked (mono_cond_t *cond, mono_mutex_t *mutex, guint32 timeout, gboolean poll, gboolean *alerted)
999 res = mono_os_cond_timedwait (cond, mutex, timeout);
1001 /* This is needed when waiting for process handles */
1004 * pthread_cond_(timed)wait() can return 0 even if the condition was not
1005 * signalled. This happens at least on Darwin. We surface this, i.e., we
1006 * get spurious wake-ups.
1008 * http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_cond_wait.html
1010 res = mono_os_cond_timedwait (cond, mutex, timeout);
1012 if (timeout < 100) {
1013 /* Real timeout is less than 100ms time */
1014 res = mono_os_cond_timedwait (cond, mutex, timeout);
1016 res = mono_os_cond_timedwait (cond, mutex, 100);
1018 /* Mask the fake timeout, this will cause
1019 * another poll if the cond was not really signaled
1031 signal_global (gpointer unused)
1033 /* If we reach here, then interrupt token is set to the flag value, which
1034 * means that the target thread is either
1035 * - before the first CAS in timedwait, which means it won't enter the wait.
1036 * - it is after the first CAS, so it is already waiting, or it will enter
1037 * the wait, and it will be interrupted by the broadcast. */
1038 mono_os_mutex_lock (&global_signal_mutex);
1039 mono_os_cond_broadcast (&global_signal_cond);
1040 mono_os_mutex_unlock (&global_signal_mutex);
1044 mono_w32handle_timedwait_signal (guint32 timeout, gboolean poll, gboolean *alerted)
1048 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: waiting for global", __func__);
1054 mono_thread_info_install_interrupt (signal_global, NULL, alerted);
1059 res = mono_w32handle_timedwait_signal_naked (&global_signal_cond, &global_signal_mutex, timeout, poll, alerted);
1062 mono_thread_info_uninstall_interrupt (alerted);
1068 signal_handle_and_unref (gpointer handle)
1070 MonoW32HandleBase *handle_data;
1072 mono_mutex_t *mutex;
1074 if (!mono_w32handle_lookup_data (handle, &handle_data))
1075 g_error ("cannot signal unknown handle %p", handle);
1077 /* If we reach here, then interrupt token is set to the flag value, which
1078 * means that the target thread is either
1079 * - before the first CAS in timedwait, which means it won't enter the wait.
1080 * - it is after the first CAS, so it is already waiting, or it will enter
1081 * the wait, and it will be interrupted by the broadcast. */
1082 cond = &handle_data->signal_cond;
1083 mutex = &handle_data->signal_mutex;
1085 mono_os_mutex_lock (mutex);
1086 mono_os_cond_broadcast (cond);
1087 mono_os_mutex_unlock (mutex);
1089 mono_w32handle_unref (handle);
1093 mono_w32handle_timedwait_signal_handle (gpointer handle, guint32 timeout, gboolean poll, gboolean *alerted)
1095 MonoW32HandleBase *handle_data;
1098 if (!mono_w32handle_lookup_data (handle, &handle_data))
1099 g_error ("cannot wait on unknown handle %p", handle);
1101 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: waiting for %p (type %s)", __func__, handle,
1102 mono_w32handle_ops_typename (mono_w32handle_get_type (handle)));
1108 mono_thread_info_install_interrupt (signal_handle_and_unref, handle, alerted);
1111 mono_w32handle_ref (handle);
1114 res = mono_w32handle_timedwait_signal_naked (&handle_data->signal_cond, &handle_data->signal_mutex, timeout, poll, alerted);
1117 mono_thread_info_uninstall_interrupt (alerted);
1119 /* if it is alerted, then the handle is unref in the interrupt callback */
1120 mono_w32handle_unref (handle);
1128 dump_callback (gpointer handle, gpointer handle_specific, gpointer user_data)
1130 MonoW32HandleBase *handle_data;
1132 if (!mono_w32handle_lookup_data (handle, &handle_data))
1133 g_error ("cannot dump unknown handle %p", handle);
1135 g_print ("%p [%7s] signalled: %5s ref: %3d ",
1136 handle, mono_w32handle_ops_typename (handle_data->type), handle_data->signalled ? "true" : "false", handle_data->ref);
1137 mono_w32handle_ops_details (handle_data->type, handle_data->specific);
1143 void mono_w32handle_dump (void)
1145 mono_w32handle_foreach (dump_callback, NULL);
1149 own_if_signalled (gpointer handle, guint32 *statuscode)
1151 if (!mono_w32handle_issignalled (handle))
1154 *statuscode = WAIT_OBJECT_0;
1155 mono_w32handle_ops_own (handle, statuscode);
1160 own_if_owned( gpointer handle, guint32 *statuscode)
1162 if (!mono_w32handle_ops_isowned (handle))
1165 *statuscode = WAIT_OBJECT_0;
1166 mono_w32handle_ops_own (handle, statuscode);
1170 MonoW32HandleWaitRet
1171 mono_w32handle_wait_one (gpointer handle, guint32 timeout, gboolean alertable)
1173 MonoW32HandleWaitRet ret;
1177 guint32 statuscode = 0;
1181 if (mono_w32handle_test_capabilities (handle, MONO_W32HANDLE_CAP_SPECIAL_WAIT)) {
1182 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p has special wait",
1185 switch (mono_w32handle_ops_specialwait (handle, timeout, alertable ? &alerted : NULL)) {
1187 ret = MONO_W32HANDLE_WAIT_RET_SUCCESS_0;
1189 case WAIT_ABANDONED_0:
1190 ret = MONO_W32HANDLE_WAIT_RET_ABANDONED_0;
1192 case WAIT_IO_COMPLETION:
1193 ret = MONO_W32HANDLE_WAIT_RET_ALERTED;
1196 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1199 ret = MONO_W32HANDLE_WAIT_RET_FAILED;
1202 g_assert_not_reached ();
1206 ret = MONO_W32HANDLE_WAIT_RET_ALERTED;
1211 if (!mono_w32handle_test_capabilities (handle, MONO_W32HANDLE_CAP_WAIT)) {
1212 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p can't be waited for",
1215 return MONO_W32HANDLE_WAIT_RET_FAILED;
1218 thr_ret = mono_w32handle_lock_handle (handle);
1219 g_assert (thr_ret == 0);
1221 if (mono_w32handle_test_capabilities (handle, MONO_W32HANDLE_CAP_OWN)) {
1222 if (own_if_owned (handle, &statuscode)) {
1223 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p already owned",
1226 ret = statuscode == WAIT_ABANDONED_0 ? MONO_W32HANDLE_WAIT_RET_ABANDONED_0 : MONO_W32HANDLE_WAIT_RET_SUCCESS_0;
1231 if (timeout != INFINITE)
1232 start = mono_msec_ticks ();
1237 if (own_if_signalled (handle, &statuscode)) {
1238 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p signalled",
1241 ret = statuscode == WAIT_ABANDONED_0 ? MONO_W32HANDLE_WAIT_RET_ABANDONED_0 : MONO_W32HANDLE_WAIT_RET_SUCCESS_0;
1245 mono_w32handle_ops_prewait (handle);
1247 if (timeout == INFINITE) {
1248 waited = mono_w32handle_timedwait_signal_handle (handle, INFINITE, FALSE, alertable ? &alerted : NULL);
1252 elapsed = mono_msec_ticks () - start;
1253 if (elapsed > timeout) {
1254 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1258 waited = mono_w32handle_timedwait_signal_handle (handle, timeout - elapsed, FALSE, alertable ? &alerted : NULL);
1262 ret = MONO_W32HANDLE_WAIT_RET_ALERTED;
1267 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1273 thr_ret = mono_w32handle_unlock_handle (handle);
1274 g_assert (thr_ret == 0);
1279 MonoW32HandleWaitRet
1280 mono_w32handle_wait_multiple (gpointer *handles, gsize nhandles, gboolean waitall, guint32 timeout, gboolean alertable)
1282 MonoW32HandleWaitRet ret;
1283 gboolean alerted, poll;
1286 gpointer handles_sorted [MONO_W32HANDLE_MAXIMUM_WAIT_OBJECTS];
1287 guint32 statuscodes [MONO_W32HANDLE_MAXIMUM_WAIT_OBJECTS] = {0};
1290 return MONO_W32HANDLE_WAIT_RET_FAILED;
1293 return mono_w32handle_wait_one (handles [0], timeout, alertable);
1297 if (nhandles > MONO_W32HANDLE_MAXIMUM_WAIT_OBJECTS) {
1298 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: too many handles: %zd",
1299 __func__, nhandles);
1301 return MONO_W32HANDLE_WAIT_RET_FAILED;
1304 for (i = 0; i < nhandles; ++i) {
1305 if (!mono_w32handle_test_capabilities (handles[i], MONO_W32HANDLE_CAP_WAIT)
1306 && !mono_w32handle_test_capabilities (handles[i], MONO_W32HANDLE_CAP_SPECIAL_WAIT))
1308 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p can't be waited for",
1309 __func__, handles [i]);
1311 return MONO_W32HANDLE_WAIT_RET_FAILED;
1314 handles_sorted [i] = handles [i];
1317 qsort (handles_sorted, nhandles, sizeof (gpointer), g_direct_equal);
1318 for (i = 1; i < nhandles; ++i) {
1319 if (handles_sorted [i - 1] == handles_sorted [i]) {
1320 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p is duplicated",
1321 __func__, handles_sorted [i]);
1323 return MONO_W32HANDLE_WAIT_RET_FAILED;
1328 for (i = 0; i < nhandles; ++i) {
1329 if (mono_w32handle_get_type (handles [i]) == MONO_W32HANDLE_PROCESS) {
1330 /* Can't wait for a process handle + another handle without polling */
1335 if (timeout != INFINITE)
1336 start = mono_msec_ticks ();
1338 for (i = 0; i < nhandles; ++i) {
1339 /* Add a reference, as we need to ensure the handle wont
1340 * disappear from under us while we're waiting in the loop
1341 * (not lock, as we don't want exclusive access here) */
1342 mono_w32handle_ref (handles [i]);
1346 gsize count, lowest;
1353 mono_w32handle_lock_handles (handles, nhandles);
1355 for (i = 0; i < nhandles; i++) {
1356 if ((mono_w32handle_test_capabilities (handles [i], MONO_W32HANDLE_CAP_OWN) && mono_w32handle_ops_isowned (handles [i]))
1357 || mono_w32handle_issignalled (handles [i]))
1366 signalled = (waitall && count == nhandles) || (!waitall && count > 0);
1369 for (i = 0; i < nhandles; i++)
1370 own_if_signalled (handles [i], &statuscodes [i]);
1373 mono_w32handle_unlock_handles (handles, nhandles);
1376 ret = MONO_W32HANDLE_WAIT_RET_SUCCESS_0 + lowest;
1377 for (i = lowest; i < nhandles; i++) {
1378 if (statuscodes [i] == WAIT_ABANDONED_0) {
1379 ret = MONO_W32HANDLE_WAIT_RET_ABANDONED_0 + lowest;
1386 for (i = 0; i < nhandles; i++) {
1387 mono_w32handle_ops_prewait (handles[i]);
1389 if (mono_w32handle_test_capabilities (handles [i], MONO_W32HANDLE_CAP_SPECIAL_WAIT)
1390 && !mono_w32handle_issignalled (handles [i]))
1392 mono_w32handle_ops_specialwait (handles [i], 0, alertable ? &alerted : NULL);
1396 thr_ret = mono_w32handle_lock_signal_mutex ();
1397 g_assert (thr_ret == 0);
1401 for (i = 0; i < nhandles; ++i) {
1402 if (!mono_w32handle_issignalled (handles [i])) {
1409 for (i = 0; i < nhandles; ++i) {
1410 if (mono_w32handle_issignalled (handles [i])) {
1420 if (timeout == INFINITE) {
1421 waited = mono_w32handle_timedwait_signal (INFINITE, poll, alertable ? &alerted : NULL);
1425 elapsed = mono_msec_ticks () - start;
1426 if (elapsed > timeout) {
1427 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1429 thr_ret = mono_w32handle_unlock_signal_mutex ();
1430 g_assert (thr_ret == 0);
1435 waited = mono_w32handle_timedwait_signal (timeout - elapsed, poll, alertable ? &alerted : NULL);
1439 thr_ret = mono_w32handle_unlock_signal_mutex ();
1440 g_assert (thr_ret == 0);
1443 ret = MONO_W32HANDLE_WAIT_RET_ALERTED;
1448 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1454 for (i = 0; i < nhandles; i++) {
1455 /* Unref everything we reffed above */
1456 mono_w32handle_unref (handles [i]);
1462 MonoW32HandleWaitRet
1463 mono_w32handle_signal_and_wait (gpointer signal_handle, gpointer wait_handle, guint32 timeout, gboolean alertable)
1465 MonoW32HandleWaitRet ret;
1469 guint32 statuscode = 0;
1473 if (!mono_w32handle_test_capabilities (signal_handle, MONO_W32HANDLE_CAP_SIGNAL))
1474 return MONO_W32HANDLE_WAIT_RET_FAILED;
1475 if (!mono_w32handle_test_capabilities (wait_handle, MONO_W32HANDLE_CAP_WAIT))
1476 return MONO_W32HANDLE_WAIT_RET_FAILED;
1478 if (mono_w32handle_test_capabilities (wait_handle, MONO_W32HANDLE_CAP_SPECIAL_WAIT)) {
1479 g_warning ("%s: handle %p has special wait, implement me!!", __func__, wait_handle);
1480 return MONO_W32HANDLE_WAIT_RET_FAILED;
1483 thr_ret = mono_w32handle_lock_handle (wait_handle);
1484 g_assert (thr_ret == 0);
1486 mono_w32handle_ops_signal (signal_handle);
1488 if (mono_w32handle_test_capabilities (wait_handle, MONO_W32HANDLE_CAP_OWN)) {
1489 if (own_if_owned (wait_handle, &statuscode)) {
1490 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p already owned",
1491 __func__, wait_handle);
1493 ret = statuscode == WAIT_ABANDONED_0 ? MONO_W32HANDLE_WAIT_RET_ABANDONED_0 : MONO_W32HANDLE_WAIT_RET_SUCCESS_0;
1498 if (timeout != INFINITE)
1499 start = mono_msec_ticks ();
1504 if (own_if_signalled (wait_handle, &statuscode)) {
1505 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_W32HANDLE, "%s: handle %p signalled",
1506 __func__, wait_handle);
1508 ret = statuscode == WAIT_ABANDONED_0 ? MONO_W32HANDLE_WAIT_RET_ABANDONED_0 : MONO_W32HANDLE_WAIT_RET_SUCCESS_0;
1512 mono_w32handle_ops_prewait (wait_handle);
1514 if (timeout == INFINITE) {
1515 waited = mono_w32handle_timedwait_signal_handle (wait_handle, INFINITE, FALSE, alertable ? &alerted : NULL);
1519 elapsed = mono_msec_ticks () - start;
1520 if (elapsed > timeout) {
1521 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1525 waited = mono_w32handle_timedwait_signal_handle (wait_handle, timeout - elapsed, FALSE, alertable ? &alerted : NULL);
1529 ret = MONO_W32HANDLE_WAIT_RET_ALERTED;
1534 ret = MONO_W32HANDLE_WAIT_RET_TIMEOUT;
1540 thr_ret = mono_w32handle_unlock_handle (wait_handle);
1541 g_assert (thr_ret == 0);
1546 #endif /* !defined(HOST_WIN32) */