1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gthread.c: solaris thread system implementation
5 * Copyright 1998-2001 Sebastian Wilhelmi; University of Karlsruhe
6 * Copyright 2001 Hans Breuer
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
26 * file for a list of people on the GLib Team. See the ChangeLog
27 * files for a list of changes. These files are distributed with
28 * GLib at ftp://ftp.gtk.org/pub/gtk/.
31 /* The GMutex and GCond implementations in this file are some of the
32 * lowest-level code in GLib. All other parts of GLib (messages,
33 * memory, slices, etc) assume that they can freely use these facilities
34 * without risking recursion.
36 * As such, these functions are NOT permitted to call any other part of
39 * The thread manipulation functions (create, exit, join, etc.) have
40 * more freedom -- they can do as they please.
47 #define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
55 g_thread_abort (gint status,
56 const gchar *function)
58 fprintf (stderr, "GLib (gthread-win32.c): Unexpected error from C library during '%s': %s. Aborting.\n",
59 strerror (status), function);
63 /* Starting with Vista and Windows 2008, we have access to the
64 * CONDITION_VARIABLE and SRWLock primatives on Windows, which are
65 * pretty reasonable approximations of the primatives specified in
66 * POSIX 2001 (pthread_cond_t and pthread_mutex_t respectively).
68 * Both of these types are structs containing a single pointer. That
69 * pointer is used as an atomic bitfield to support user-space mutexes
70 * that only get the kernel involved in cases of contention (similar
71 * to how futex()-based mutexes work on Linux). The biggest advantage
72 * of these new types is that they can be statically initialised to
73 * zero. This allows us to use them directly and still support:
75 * GMutex mutex = G_MUTEX_INIT;
79 * GCond cond = G_COND_INIT;
81 * Unfortunately, Windows XP lacks these facilities and GLib still
82 * needs to support Windows XP. Our approach here is as follows:
84 * - avoid depending on structure declarations at compile-time by
85 * declaring our own GMutex and GCond strutures to be
86 * ABI-compatible with SRWLock and CONDITION_VARIABLE and using
89 * - avoid a hard dependency on the symbols used to manipulate these
90 * structures by doing a dynamic lookup of those symbols at
93 * - if the symbols are not available, emulate them using other
96 * Using this approach also allows us to easily build a GLib that lacks
97 * support for Windows XP or to remove this code entirely when XP is no
98 * longer supported (end of line is currently April 8, 2014).
102 void (* CallThisOnThreadExit) (void); /* fake */
104 void (* InitializeSRWLock) (gpointer lock);
105 void (* DeleteSRWLock) (gpointer lock); /* fake */
106 void (* AcquireSRWLockExclusive) (gpointer lock);
107 BOOLEAN (* TryAcquireSRWLockExclusive) (gpointer lock);
108 void (* ReleaseSRWLockExclusive) (gpointer lock);
110 void (* InitializeConditionVariable) (gpointer cond);
111 void (* DeleteConditionVariable) (gpointer cond); /* fake */
112 BOOL (* SleepConditionVariableSRW) (gpointer cond,
116 void (* WakeAllConditionVariable) (gpointer cond);
117 void (* WakeConditionVariable) (gpointer cond);
120 static GThreadImplVtable g_thread_impl_vtable;
124 g_mutex_init (GMutex *mutex)
126 g_thread_impl_vtable.InitializeSRWLock (mutex);
130 g_mutex_clear (GMutex *mutex)
132 if (g_thread_impl_vtable.DeleteSRWLock != NULL)
133 g_thread_impl_vtable.DeleteSRWLock (mutex);
137 g_mutex_lock (GMutex *mutex)
139 g_thread_impl_vtable.AcquireSRWLockExclusive (mutex);
143 g_mutex_trylock (GMutex *mutex)
145 return g_thread_impl_vtable.TryAcquireSRWLockExclusive (mutex);
149 g_mutex_unlock (GMutex *mutex)
151 g_thread_impl_vtable.ReleaseSRWLockExclusive (mutex);
156 g_cond_init (GCond *cond)
158 g_thread_impl_vtable.InitializeConditionVariable (cond);
162 g_cond_clear (GCond *cond)
164 if (g_thread_impl_vtable.DeleteConditionVariable)
165 g_thread_impl_vtable.DeleteConditionVariable (cond);
169 g_cond_signal (GCond *cond)
171 g_thread_impl_vtable.WakeConditionVariable (cond);
175 g_cond_broadcast (GCond *cond)
177 g_thread_impl_vtable.WakeAllConditionVariable (cond);
181 g_cond_wait (GCond *cond,
182 GMutex *entered_mutex)
184 g_thread_impl_vtable.SleepConditionVariableSRW (cond, entered_mutex, INFINITE, 0);
188 g_cond_timedwait (GCond *cond,
189 GMutex *entered_mutex,
196 GetSystemTimeAsFileTime (&ft);
197 memmove (&now, &ft, sizeof (FILETIME));
199 now -= G_GINT64_CONSTANT (116444736000000000);
202 span = abs_time - now;
204 if G_UNLIKELY (span < 0)
207 if G_UNLIKELY (span > G_GINT64_CONSTANT (1000) * G_MAXINT32)
210 return g_thread_impl_vtable.SleepConditionVariableSRW (cond, entered_mutex, span / 1000, 0);
214 g_cond_timed_wait (GCond *cond,
215 GMutex *entered_mutex,
222 micros = abs_time->tv_sec;
224 micros += abs_time->tv_usec;
226 return g_cond_timedwait (cond, entered_mutex, micros);
230 g_cond_wait (cond, entered_mutex);
238 #include "gthreadprivate.h"
240 #define win32_check_for_error(what) G_STMT_START{ \
242 g_error ("file %s: line %d (%s): error %s during %s", \
243 __FILE__, __LINE__, G_STRFUNC, \
244 g_win32_error_message (GetLastError ()), #what); \
247 #define G_MUTEX_SIZE (sizeof (gpointer))
249 static DWORD g_thread_self_tls;
250 static DWORD g_private_tls;
251 static CRITICAL_SECTION g_thread_global_spinlock;
253 typedef BOOL (__stdcall *GTryEnterCriticalSectionFunc) (CRITICAL_SECTION *);
255 /* As noted in the docs, GPrivate is a limited resource, here we take
256 * a rather low maximum to save memory, use GStaticPrivate instead. */
257 #define G_PRIVATE_MAX 100
259 static GDestroyNotify g_private_destructors[G_PRIVATE_MAX];
261 static guint g_private_next = 0;
263 typedef struct _GThreadData GThreadData;
273 g_private_new_win32_impl (GDestroyNotify destructor)
276 EnterCriticalSection (&g_thread_global_spinlock);
277 if (g_private_next >= G_PRIVATE_MAX)
281 "Too many GPrivate allocated. Their number is limited to %d.",
283 MessageBox (NULL, buf, NULL, MB_ICONERROR|MB_SETFOREGROUND);
284 if (IsDebuggerPresent ())
288 g_private_destructors[g_private_next] = destructor;
289 result = GUINT_TO_POINTER (g_private_next);
291 LeaveCriticalSection (&g_thread_global_spinlock);
296 /* NOTE: the functions g_private_get and g_private_set may not use
297 functions from gmem.c and gmessages.c */
300 g_private_set_win32_impl (GPrivate * private_key, gpointer value)
302 gpointer* array = TlsGetValue (g_private_tls);
303 guint index = GPOINTER_TO_UINT (private_key);
305 if (index >= G_PRIVATE_MAX)
310 array = (gpointer*) calloc (G_PRIVATE_MAX, sizeof (gpointer));
311 TlsSetValue (g_private_tls, array);
314 array[index] = value;
318 g_private_get_win32_impl (GPrivate * private_key)
320 gpointer* array = TlsGetValue (g_private_tls);
321 guint index = GPOINTER_TO_UINT (private_key);
323 if (index >= G_PRIVATE_MAX || !array)
332 g_thread_set_priority_win32_impl (gpointer thread, GThreadPriority priority)
334 GThreadData *target = *(GThreadData **)thread;
339 case G_THREAD_PRIORITY_LOW:
340 native_prio = THREAD_PRIORITY_BELOW_NORMAL;
343 case G_THREAD_PRIORITY_NORMAL:
344 native_prio = THREAD_PRIORITY_NORMAL;
347 case G_THREAD_PRIORITY_HIGH:
348 native_prio = THREAD_PRIORITY_ABOVE_NORMAL;
351 case G_THREAD_PRIORITY_URGENT:
352 native_prio = THREAD_PRIORITY_HIGHEST;
356 g_return_if_reached ();
359 win32_check_for_error (SetThreadPriority (target->thread, native_prio));
363 g_thread_self_win32_impl (gpointer thread)
365 GThreadData *self = TlsGetValue (g_thread_self_tls);
369 /* This should only happen for the main thread! */
370 HANDLE handle = GetCurrentThread ();
371 HANDLE process = GetCurrentProcess ();
372 self = g_new (GThreadData, 1);
373 win32_check_for_error (DuplicateHandle (process, handle, process,
374 &self->thread, 0, FALSE,
375 DUPLICATE_SAME_ACCESS));
376 win32_check_for_error (TlsSetValue (g_thread_self_tls, self));
379 self->joinable = FALSE;
382 *(GThreadData **)thread = self;
386 g_thread_exit_win32_impl (void)
388 GThreadData *self = TlsGetValue (g_thread_self_tls);
389 guint i, private_max;
390 gpointer *array = TlsGetValue (g_private_tls);
392 EnterCriticalSection (&g_thread_global_spinlock);
393 private_max = g_private_next;
394 LeaveCriticalSection (&g_thread_global_spinlock);
398 gboolean some_data_non_null;
401 some_data_non_null = FALSE;
402 for (i = 0; i < private_max; i++)
404 GDestroyNotify destructor = g_private_destructors[i];
405 GDestroyNotify data = array[i];
408 some_data_non_null = TRUE;
412 if (destructor && data)
415 } while (some_data_non_null);
419 win32_check_for_error (TlsSetValue (g_private_tls, NULL));
426 win32_check_for_error (CloseHandle (self->thread));
429 win32_check_for_error (TlsSetValue (g_thread_self_tls, NULL));
432 if (g_thread_impl_vtable.CallThisOnThreadExit)
433 g_thread_impl_vtable.CallThisOnThreadExit ();
438 static guint __stdcall
439 g_thread_proxy (gpointer data)
441 GThreadData *self = (GThreadData*) data;
443 win32_check_for_error (TlsSetValue (g_thread_self_tls, self));
445 self->func (self->data);
447 g_thread_exit_win32_impl ();
449 g_assert_not_reached ();
455 g_thread_create_win32_impl (GThreadFunc func,
460 GThreadPriority priority,
467 g_return_if_fail (func);
468 g_return_if_fail (priority >= G_THREAD_PRIORITY_LOW);
469 g_return_if_fail (priority <= G_THREAD_PRIORITY_URGENT);
471 retval = g_new(GThreadData, 1);
475 retval->joinable = joinable;
477 retval->thread = (HANDLE) _beginthreadex (NULL, stack_size, g_thread_proxy,
480 if (retval->thread == NULL)
482 gchar *win_error = g_win32_error_message (GetLastError ());
483 g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
484 "Error creating thread: %s", win_error);
490 *(GThreadData **)thread = retval;
492 g_thread_set_priority_win32_impl (thread, priority);
496 g_thread_yield_win32_impl (void)
502 g_thread_join_win32_impl (gpointer thread)
504 GThreadData *target = *(GThreadData **)thread;
506 g_return_if_fail (target->joinable);
508 win32_check_for_error (WAIT_FAILED !=
509 WaitForSingleObject (target->thread, INFINITE));
511 win32_check_for_error (CloseHandle (target->thread));
515 /* {{{1 SRWLock and CONDITION_VARIABLE emulation (for Windows XP) */
517 static DWORD g_thread_xp_waiter_tls;
518 static CRITICAL_SECTION g_thread_xp_lock;
520 /* {{{2 GThreadWaiter utility class for CONDITION_VARIABLE emulation */
521 typedef struct _GThreadXpWaiter GThreadXpWaiter;
522 struct _GThreadXpWaiter
525 volatile GThreadXpWaiter *next;
528 static GThreadXpWaiter *
529 g_thread_xp_waiter_get (void)
531 GThreadXpWaiter *waiter;
533 waiter = TlsGetValue (g_thread_xp_waiter_tls);
535 if G_UNLIKELY (waiter == NULL)
537 waiter = malloc (sizeof (GThreadXpWaiter));
539 g_thread_abort (GetLastError (), "malloc");
540 waiter->event = CreateEvent (0, FALSE, FALSE, NULL);
541 if (waiter->event == NULL)
542 g_thread_abort (GetLastError (), "CreateEvent");
544 TlsSetValue (g_thread_xp_waiter_tls, waiter);
551 g_thread_xp_CallThisOnThreadExit (void)
553 GThreadXpWaiter *waiter;
555 waiter = TlsGetValue (g_thread_xp_waiter_tls);
559 TlsSetValue (g_thread_xp_waiter_tls, NULL);
560 CloseHandle (waiter->event);
565 /* {{{2 SRWLock emulation */
568 CRITICAL_SECTION critical_section;
572 g_thread_xp_InitializeSRWLock (gpointer mutex)
574 *(GThreadSRWLock * volatile *) mutex = NULL;
578 g_thread_xp_DeleteSRWLock (gpointer mutex)
580 GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
584 DeleteCriticalSection (&lock->critical_section);
589 static GThreadSRWLock *
590 g_thread_xp_get_srwlock (GThreadSRWLock * volatile *lock)
592 GThreadSRWLock *result;
594 /* It looks like we're missing some barriers here, but this code only
595 * ever runs on Windows XP, which in turn only ever runs on hardware
596 * with a relatively rigid memory model. The 'volatile' will take
597 * care of the compiler.
601 if G_UNLIKELY (result == NULL)
603 EnterCriticalSection (&g_thread_xp_lock);
605 result = malloc (sizeof (GThreadSRWLock));
608 g_thread_abort (errno, "malloc");
610 InitializeCriticalSection (&result->critical_section);
613 LeaveCriticalSection (&g_thread_xp_lock);
620 g_thread_xp_AcquireSRWLockExclusive (gpointer mutex)
622 GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
624 EnterCriticalSection (&lock->critical_section);
628 g_thread_xp_TryAcquireSRWLockExclusive (gpointer mutex)
630 GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
632 return TryEnterCriticalSection (&lock->critical_section);
636 g_thread_xp_ReleaseSRWLockExclusive (gpointer mutex)
638 GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
640 /* We need this until we fix some weird parts of GLib that try to
641 * unlock freshly-allocated mutexes.
644 LeaveCriticalSection (&lock->critical_section);
647 /* {{{2 CONDITION_VARIABLE emulation */
650 volatile GThreadXpWaiter *first;
651 volatile GThreadXpWaiter **last_ptr;
652 } GThreadXpCONDITION_VARIABLE;
655 g_thread_xp_InitializeConditionVariable (gpointer cond)
657 *(GThreadXpCONDITION_VARIABLE * volatile *) cond = NULL;
661 g_thread_xp_DeleteConditionVariable (gpointer cond)
663 GThreadXpCONDITION_VARIABLE *cv = *(GThreadXpCONDITION_VARIABLE * volatile *) cond;
669 static GThreadXpCONDITION_VARIABLE *
670 g_thread_xp_get_condition_variable (GThreadXpCONDITION_VARIABLE * volatile *cond)
672 GThreadXpCONDITION_VARIABLE *result;
674 /* It looks like we're missing some barriers here, but this code only
675 * ever runs on Windows XP, which in turn only ever runs on hardware
676 * with a relatively rigid memory model. The 'volatile' will take
677 * care of the compiler.
681 if G_UNLIKELY (result == NULL)
683 result = malloc (sizeof (GThreadXpCONDITION_VARIABLE));
686 g_thread_abort (errno, "malloc");
688 result->first = NULL;
689 result->last_ptr = &result->first;
691 if (InterlockedCompareExchangePointer (cond, result, NULL) != NULL)
702 g_thread_xp_SleepConditionVariableSRW (gpointer cond,
707 GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
708 GThreadXpWaiter *waiter = g_thread_xp_waiter_get ();
713 EnterCriticalSection (&g_thread_xp_lock);
714 *cv->last_ptr = waiter;
715 cv->last_ptr = &waiter->next;
716 LeaveCriticalSection (&g_thread_xp_lock);
718 g_mutex_unlock (mutex);
719 status = WaitForSingleObject (waiter->event, timeout);
721 if (status != WAIT_TIMEOUT && status != WAIT_OBJECT_0)
722 g_thread_abort (GetLastError (), "WaitForSingleObject");
724 g_mutex_lock (mutex);
726 return status == WAIT_OBJECT_0;
730 g_thread_xp_WakeConditionVariable (gpointer cond)
732 GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
733 volatile GThreadXpWaiter *waiter;
735 EnterCriticalSection (&g_thread_xp_lock);
739 cv->first = waiter->next;
740 if (cv->first == NULL)
741 cv->last_ptr = &cv->first;
743 LeaveCriticalSection (&g_thread_xp_lock);
746 SetEvent (waiter->event);
750 g_thread_xp_WakeAllConditionVariable (gpointer cond)
752 GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
753 volatile GThreadXpWaiter *waiter;
755 EnterCriticalSection (&g_thread_xp_lock);
758 cv->last_ptr = &cv->first;
759 LeaveCriticalSection (&g_thread_xp_lock);
761 while (waiter != NULL)
763 volatile GThreadXpWaiter *next;
766 SetEvent (waiter->event);
773 g_thread_xp_init (void)
775 static const GThreadImplVtable g_thread_xp_impl_vtable = {
776 g_thread_xp_CallThisOnThreadExit,
777 g_thread_xp_InitializeSRWLock,
778 g_thread_xp_DeleteSRWLock,
779 g_thread_xp_AcquireSRWLockExclusive,
780 g_thread_xp_TryAcquireSRWLockExclusive,
781 g_thread_xp_ReleaseSRWLockExclusive,
782 g_thread_xp_InitializeConditionVariable,
783 g_thread_xp_DeleteConditionVariable,
784 g_thread_xp_SleepConditionVariableSRW,
785 g_thread_xp_WakeAllConditionVariable,
786 g_thread_xp_WakeConditionVariable
789 InitializeCriticalSection (&g_thread_xp_lock);
790 g_thread_xp_waiter_tls = TlsAlloc ();
792 g_thread_impl_vtable = g_thread_xp_impl_vtable;
797 GThreadFunctions g_thread_functions_for_glib_use =
799 g_mutex_new, /* mutex */
804 g_cond_new, /* condition */
810 g_private_new_win32_impl, /* private thread data */
811 g_private_get_win32_impl,
812 g_private_set_win32_impl,
813 g_thread_create_win32_impl, /* thread */
814 g_thread_yield_win32_impl,
815 g_thread_join_win32_impl,
816 g_thread_exit_win32_impl,
817 g_thread_set_priority_win32_impl,
818 g_thread_self_win32_impl,
819 NULL /* no equal function necessary */
823 _g_thread_impl_init (void)
825 static gboolean beenhere = FALSE;
832 printf ("thread init\n");
833 win32_check_for_error (TLS_OUT_OF_INDEXES !=
834 (g_thread_self_tls = TlsAlloc ()));
835 win32_check_for_error (TLS_OUT_OF_INDEXES !=
836 (g_private_tls = TlsAlloc ()));
837 InitializeCriticalSection (&g_thread_global_spinlock);
841 g_thread_lookup_native_funcs (void)
843 GThreadImplVtable native_vtable = { 0, };
846 kernel32 = GetModuleHandle ("KERNEL32.DLL");
848 if (kernel32 == NULL)
851 #define GET_FUNC(name) if ((native_vtable.name = (void *) GetProcAddress (kernel32, #name)) == NULL) return FALSE
852 GET_FUNC(InitializeSRWLock);
853 GET_FUNC(AcquireSRWLockExclusive);
854 GET_FUNC(TryAcquireSRWLockExclusive);
855 GET_FUNC(ReleaseSRWLockExclusive);
857 GET_FUNC(InitializeConditionVariable);
858 GET_FUNC(SleepConditionVariableSRW);
859 GET_FUNC(WakeAllConditionVariable);
860 GET_FUNC(WakeConditionVariable);
863 g_thread_impl_vtable = native_vtable;
869 g_thread_DllMain (void)
871 /* XXX This is broken right now for some unknown reason...
873 if (g_thread_lookup_native_funcs ())
874 fprintf (stderr, "(debug) GThread using native mode\n");
878 fprintf (stderr, "(debug) GThread using Windows XP mode\n");
883 /* vim:set foldmethod=marker: */