glib/gthread-win32.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * gthread.c: solaris thread system implementation
   5  * Copyright 1998-2001 Sebastian Wilhelmi; University of Karlsruhe
   6  * Copyright 2001 Hans Breuer
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 /*
  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/.
  29  */
  30
  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.
  35  *
  36  * As such, these functions are NOT permitted to call any other part of
  37  * GLib.
  38  *
  39  * The thread manipulation functions (create, exit, join, etc.) have
  40  * more freedom -- they can do as they please.
  41  */
  42
  43 #include "config.h"
  44
  45 #include "gthread.h"
  46 #include "gthreadprivate.h"
  47 #include "gslice.h"
  48
  49 #include <windows.h>
  50
  51 #include <process.h>
  52 #include <stdlib.h>
  53 #include <stdio.h>
  54
  55 static void
  56 g_thread_abort (gint         status,
  57                 const gchar *function)
  58 {
  59   fprintf (stderr, "GLib (gthread-win32.c): Unexpected error from C library during '%s': %s.  Aborting.\n",
  60            strerror (status), function);
  61   abort ();
  62 }
  63
  64 /* Starting with Vista and Windows 2008, we have access to the
  65  * CONDITION_VARIABLE and SRWLock primatives on Windows, which are
  66  * pretty reasonable approximations of the primatives specified in
  67  * POSIX 2001 (pthread_cond_t and pthread_mutex_t respectively).
  68  *
  69  * Both of these types are structs containing a single pointer.  That
  70  * pointer is used as an atomic bitfield to support user-space mutexes
  71  * that only get the kernel involved in cases of contention (similar
  72  * to how futex()-based mutexes work on Linux).  The biggest advantage
  73  * of these new types is that they can be statically initialised to
  74  * zero.  That means that they are completely ABI compatible with our
  75  * GMutex and GCond APIs.
  76  *
  77  * Unfortunately, Windows XP lacks these facilities and GLib still
  78  * needs to support Windows XP.  Our approach here is as follows:
  79  *
  80  *   - avoid depending on structure declarations at compile-time by
  81  *     declaring our own GMutex and GCond strutures to be
  82  *     ABI-compatible with SRWLock and CONDITION_VARIABLE and using
  83  *     those instead
  84  *
  85  *   - avoid a hard dependency on the symbols used to manipulate these
  86  *     structures by doing a dynamic lookup of those symbols at
  87  *     runtime
  88  *
  89  *   - if the symbols are not available, emulate them using other
  90  *     primatives
  91  *
  92  * Using this approach also allows us to easily build a GLib that lacks
  93  * support for Windows XP or to remove this code entirely when XP is no
  94  * longer supported (end of line is currently April 8, 2014).
  95  */
  96 typedef struct
  97 {
  98   void     (__stdcall * CallThisOnThreadExit)        (void);              /* fake */
  99
 100   void     (__stdcall * InitializeSRWLock)           (gpointer lock);
 101   void     (__stdcall * DeleteSRWLock)               (gpointer lock);     /* fake */
 102   void     (__stdcall * AcquireSRWLockExclusive)     (gpointer lock);
 103   BOOLEAN  (__stdcall * TryAcquireSRWLockExclusive)  (gpointer lock);
 104   void     (__stdcall * ReleaseSRWLockExclusive)     (gpointer lock);
 105   void     (__stdcall * AcquireSRWLockShared)        (gpointer lock);
 106   BOOLEAN  (__stdcall * TryAcquireSRWLockShared)     (gpointer lock);
 107   void     (__stdcall * ReleaseSRWLockShared)        (gpointer lock);
 108
 109   void     (__stdcall * InitializeConditionVariable) (gpointer cond);
 110   void     (__stdcall * DeleteConditionVariable)     (gpointer cond);     /* fake */
 111   BOOL     (__stdcall * SleepConditionVariableSRW)   (gpointer cond,
 112                                                       gpointer lock,
 113                                                       DWORD    timeout,
 114                                                       ULONG    flags);
 115   void     (__stdcall * WakeAllConditionVariable)    (gpointer cond);
 116   void     (__stdcall * WakeConditionVariable)       (gpointer cond);
 117 } GThreadImplVtable;
 118
 119 static GThreadImplVtable g_thread_impl_vtable;
 120
 121 /* {{{1 GMutex */
 122 void
 123 g_mutex_init (GMutex *mutex)
 124 {
 125   g_thread_impl_vtable.InitializeSRWLock (mutex);
 126 }
 127
 128 void
 129 g_mutex_clear (GMutex *mutex)
 130 {
 131   if (g_thread_impl_vtable.DeleteSRWLock != NULL)
 132     g_thread_impl_vtable.DeleteSRWLock (mutex);
 133 }
 134
 135 void
 136 g_mutex_lock (GMutex *mutex)
 137 {
 138   g_thread_impl_vtable.AcquireSRWLockExclusive (mutex);
 139 }
 140
 141 gboolean
 142 g_mutex_trylock (GMutex *mutex)
 143 {
 144   return g_thread_impl_vtable.TryAcquireSRWLockExclusive (mutex);
 145 }
 146
 147 void
 148 g_mutex_unlock (GMutex *mutex)
 149 {
 150   g_thread_impl_vtable.ReleaseSRWLockExclusive (mutex);
 151 }
 152
 153 /* {{{1 GRecMutex */
 154
 155 static CRITICAL_SECTION *
 156 g_rec_mutex_impl_new (void)
 157 {
 158   CRITICAL_SECTION *cs;
 159
 160   cs = g_slice_new (CRITICAL_SECTION);
 161   InitializeCriticalSection (cs);
 162
 163   return cs;
 164 }
 165
 166 static void
 167 g_rec_mutex_impl_free (CRITICAL_SECTION *cs)
 168 {
 169   DeleteCriticalSection (cs);
 170   g_slice_free (CRITICAL_SECTION, cs);
 171 }
 172
 173 static CRITICAL_SECTION *
 174 g_rec_mutex_get_impl (GRecMutex *mutex)
 175 {
 176   CRITICAL_SECTION *impl = mutex->p;
 177
 178   if G_UNLIKELY (mutex->p == NULL)
 179     {
 180       impl = g_rec_mutex_impl_new ();
 181       if (InterlockedCompareExchangePointer (&mutex->p, impl, NULL) != NULL)
 182         g_rec_mutex_impl_free (impl);
 183       impl = mutex->p;
 184     }
 185
 186   return impl;
 187 }
 188
 189 void
 190 g_rec_mutex_init (GRecMutex *mutex)
 191 {
 192   mutex->p = g_rec_mutex_impl_new ();
 193 }
 194
 195 void
 196 g_rec_mutex_clear (GRecMutex *mutex)
 197 {
 198   g_rec_mutex_impl_free (mutex->p);
 199 }
 200
 201 void
 202 g_rec_mutex_lock (GRecMutex *mutex)
 203 {
 204   EnterCriticalSection (g_rec_mutex_get_impl (mutex));
 205 }
 206
 207 void
 208 g_rec_mutex_unlock (GRecMutex *mutex)
 209 {
 210   LeaveCriticalSection (mutex->p);
 211 }
 212
 213 gboolean
 214 g_rec_mutex_trylock (GRecMutex *mutex)
 215 {
 216   return TryEnterCriticalSection (g_rec_mutex_get_impl (mutex));
 217 }
 218
 219 /* {{{1 GRWLock */
 220
 221 void
 222 g_rw_lock_init (GRWLock *lock)
 223 {
 224   g_thread_impl_vtable.InitializeSRWLock (lock);
 225 }
 226
 227 void
 228 g_rw_lock_clear (GRWLock *lock)
 229 {
 230   if (g_thread_impl_vtable.DeleteSRWLock != NULL)
 231     g_thread_impl_vtable.DeleteSRWLock (lock);
 232 }
 233
 234 void
 235 g_rw_lock_writer_lock (GRWLock *lock)
 236 {
 237   g_thread_impl_vtable.AcquireSRWLockExclusive (lock);
 238 }
 239
 240 gboolean
 241 g_rw_lock_writer_trylock (GRWLock *lock)
 242 {
 243   return g_thread_impl_vtable.TryAcquireSRWLockExclusive (lock);
 244 }
 245
 246 void
 247 g_rw_lock_writer_unlock (GRWLock *lock)
 248 {
 249   g_thread_impl_vtable.ReleaseSRWLockExclusive (lock);
 250 }
 251
 252 void
 253 g_rw_lock_reader_lock (GRWLock *lock)
 254 {
 255   g_thread_impl_vtable.AcquireSRWLockShared (lock);
 256 }
 257
 258 gboolean
 259 g_rw_lock_reader_trylock (GRWLock *lock)
 260 {
 261   return g_thread_impl_vtable.TryAcquireSRWLockShared (lock);
 262 }
 263
 264 void
 265 g_rw_lock_reader_unlock (GRWLock *lock)
 266 {
 267   g_thread_impl_vtable.ReleaseSRWLockShared (lock);
 268 }
 269
 270 /* {{{1 GCond */
 271 void
 272 g_cond_init (GCond *cond)
 273 {
 274   g_thread_impl_vtable.InitializeConditionVariable (cond);
 275 }
 276
 277 void
 278 g_cond_clear (GCond *cond)
 279 {
 280   if (g_thread_impl_vtable.DeleteConditionVariable)
 281     g_thread_impl_vtable.DeleteConditionVariable (cond);
 282 }
 283
 284 void
 285 g_cond_signal (GCond *cond)
 286 {
 287   g_thread_impl_vtable.WakeConditionVariable (cond);
 288 }
 289
 290 void
 291 g_cond_broadcast (GCond *cond)
 292 {
 293   g_thread_impl_vtable.WakeAllConditionVariable (cond);
 294 }
 295
 296 void
 297 g_cond_wait (GCond  *cond,
 298              GMutex *entered_mutex)
 299 {
 300   g_thread_impl_vtable.SleepConditionVariableSRW (cond, entered_mutex, INFINITE, 0);
 301 }
 302
 303 gboolean
 304 g_cond_timedwait (GCond  *cond,
 305                   GMutex *entered_mutex,
 306                   gint64  abs_time)
 307 {
 308   gint64 span;
 309   FILETIME ft;
 310   gint64 now;
 311
 312   GetSystemTimeAsFileTime (&ft);
 313   memmove (&now, &ft, sizeof (FILETIME));
 314
 315   now -= G_GINT64_CONSTANT (116444736000000000);
 316   now /= 10;
 317
 318   span = abs_time - now;
 319
 320   if G_UNLIKELY (span < 0)
 321     span = 0;
 322
 323   if G_UNLIKELY (span > G_GINT64_CONSTANT (1000) * G_MAXINT32)
 324     span = INFINITE;
 325
 326   return g_thread_impl_vtable.SleepConditionVariableSRW (cond, entered_mutex, span / 1000, 0);
 327 }
 328
 329 gboolean
 330 g_cond_timed_wait (GCond    *cond,
 331                    GMutex   *entered_mutex,
 332                    GTimeVal *abs_time)
 333 {
 334   if (abs_time)
 335     {
 336       gint64 micros;
 337
 338       micros = abs_time->tv_sec;
 339       micros *= 1000000;
 340       micros += abs_time->tv_usec;
 341
 342       return g_cond_timedwait (cond, entered_mutex, micros);
 343     }
 344   else
 345     {
 346       g_cond_wait (cond, entered_mutex);
 347       return TRUE;
 348     }
 349 }
 350
 351 /* {{{1 GPrivate */
 352
 353 typedef struct _GPrivateDestructor GPrivateDestructor;
 354
 355 struct _GPrivateDestructor
 356 {
 357   DWORD               index;
 358   GDestroyNotify      notify;
 359   GPrivateDestructor *next;
 360 };
 361
 362 static GPrivateDestructor * volatile g_private_destructors;
 363 static CRITICAL_SECTION g_private_lock;
 364
 365 static DWORD
 366 g_private_get_impl (GPrivate *key)
 367 {
 368   DWORD impl = (DWORD) key->p;
 369
 370   if G_UNLIKELY (impl == 0)
 371     {
 372       EnterCriticalSection (&g_private_lock);
 373       impl = (DWORD) key->p;
 374       if (impl == 0)
 375         {
 376           GPrivateDestructor *destructor;
 377
 378           impl = TlsAlloc ();
 379
 380           if (impl == TLS_OUT_OF_INDEXES)
 381             g_thread_abort (0, "TlsAlloc");
 382
 383           if (key->notify != NULL)
 384             {
 385               destructor = malloc (sizeof (GPrivateDestructor));
 386               if G_UNLIKELY (destructor == NULL)
 387                 g_thread_abort (errno, "malloc");
 388               destructor->index = impl;
 389               destructor->notify = key->notify;
 390               destructor->next = g_private_destructors;
 391
 392               /* We need to do an atomic store due to the unlocked
 393                * access to the destructor list from the thread exit
 394                * function.
 395                *
 396                * It can double as a sanity check...
 397                */
 398               if (InterlockedCompareExchangePointer (&g_private_destructors, destructor,
 399                                                      destructor->next) != destructor->next)
 400                 g_thread_abort (0, "g_private_get_impl(1)");
 401             }
 402
 403           /* Ditto, due to the unlocked access on the fast path */
 404           if (InterlockedCompareExchangePointer (&key->p, impl, NULL) != NULL)
 405             g_thread_abort (0, "g_private_get_impl(2)");
 406         }
 407       LeaveCriticalSection (&g_private_lock);
 408     }
 409
 410   return impl;
 411 }
 412
 413 gpointer
 414 g_private_get (GPrivate *key)
 415 {
 416   return TlsGetValue (g_private_get_impl (key));
 417 }
 418
 419 void
 420 g_private_set (GPrivate *key,
 421                gpointer  value)
 422 {
 423   TlsSetValue (g_private_get_impl (key), value);
 424 }
 425
 426 void
 427 g_private_replace (GPrivate *key,
 428                    gpointer  value)
 429 {
 430   DWORD impl = g_private_get_impl (key);
 431   gpointer old;
 432
 433   old = TlsGetValue (impl);
 434   if (old && key->notify)
 435     key->notify (old);
 436   TlsSetValue (impl, value);
 437 }
 438
 439 /* {{{1 GThread */
 440
 441 #include "glib.h"
 442 #include "gthreadprivate.h"
 443
 444 #define win32_check_for_error(what) G_STMT_START{                       \
 445   if (!(what))                                                          \
 446     g_error ("file %s: line %d (%s): error %s during %s",               \
 447              __FILE__, __LINE__, G_STRFUNC,                             \
 448              g_win32_error_message (GetLastError ()), #what);           \
 449   }G_STMT_END
 450
 451 #define G_MUTEX_SIZE (sizeof (gpointer))
 452
 453 typedef BOOL (__stdcall *GTryEnterCriticalSectionFunc) (CRITICAL_SECTION *);
 454
 455 typedef struct
 456 {
 457   GRealThread thread;
 458
 459   GThreadFunc proxy;
 460   HANDLE      handle;
 461 } GThreadWin32;
 462
 463 void
 464 g_system_thread_free (GRealThread *thread)
 465 {
 466   GThreadWin32 *wt = (GThreadWin32 *) thread;
 467
 468   win32_check_for_error (CloseHandle (wt->handle));
 469   g_slice_free (GThreadWin32, wt);
 470 }
 471
 472 void
 473 g_system_thread_exit (void)
 474 {
 475   _endthreadex (0);
 476 }
 477
 478 static guint __stdcall
 479 g_thread_win32_proxy (gpointer data)
 480 {
 481   GThreadWin32 *self = data;
 482
 483   self->proxy (self);
 484
 485   g_system_thread_exit ();
 486
 487   g_assert_not_reached ();
 488
 489   return 0;
 490 }
 491
 492 GRealThread *
 493 g_system_thread_new (GThreadFunc   func,
 494                      gulong        stack_size,
 495                      gboolean      joinable,
 496                      GError      **error)
 497 {
 498   GThreadWin32 *thread;
 499   guint ignore;
 500
 501   thread = g_slice_new0 (GThreadWin32);
 502   thread->proxy = func;
 503
 504   thread->handle = (HANDLE) _beginthreadex (NULL, stack_size, g_thread_win32_proxy, thread, 0, &ignore);
 505
 506   if (thread->handle == NULL)
 507     {
 508       gchar *win_error = g_win32_error_message (GetLastError ());
 509       g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
 510                    "Error creating thread: %s", win_error);
 511       g_free (win_error);
 512       g_slice_free (GThreadWin32, thread);
 513       return NULL;
 514     }
 515
 516   return (GRealThread *) thread;
 517 }
 518
 519 void
 520 g_thread_yield (void)
 521 {
 522   Sleep(0);
 523 }
 524
 525 void
 526 g_system_thread_wait (GRealThread *thread)
 527 {
 528   GThreadWin32 *wt = (GThreadWin32 *) thread;
 529
 530   win32_check_for_error (WAIT_FAILED != WaitForSingleObject (wt->handle, INFINITE));
 531 }
 532
 533 void
 534 g_system_thread_set_name (const gchar *name)
 535 {
 536   /* FIXME: implement */
 537 }
 538
 539 /* {{{1 SRWLock and CONDITION_VARIABLE emulation (for Windows XP) */
 540
 541 static CRITICAL_SECTION g_thread_xp_lock;
 542 static DWORD            g_thread_xp_waiter_tls;
 543
 544 /* {{{2 GThreadWaiter utility class for CONDITION_VARIABLE emulation */
 545 typedef struct _GThreadXpWaiter GThreadXpWaiter;
 546 struct _GThreadXpWaiter
 547 {
 548   HANDLE                    event;
 549   volatile GThreadXpWaiter *next;
 550 };
 551
 552 static GThreadXpWaiter *
 553 g_thread_xp_waiter_get (void)
 554 {
 555   GThreadXpWaiter *waiter;
 556
 557   waiter = TlsGetValue (g_thread_xp_waiter_tls);
 558
 559   if G_UNLIKELY (waiter == NULL)
 560     {
 561       waiter = malloc (sizeof (GThreadXpWaiter));
 562       if (waiter == NULL)
 563         g_thread_abort (GetLastError (), "malloc");
 564       waiter->event = CreateEvent (0, FALSE, FALSE, NULL);
 565       if (waiter->event == NULL)
 566         g_thread_abort (GetLastError (), "CreateEvent");
 567
 568       TlsSetValue (g_thread_xp_waiter_tls, waiter);
 569     }
 570
 571   return waiter;
 572 }
 573
 574 static void __stdcall
 575 g_thread_xp_CallThisOnThreadExit (void)
 576 {
 577   GThreadXpWaiter *waiter;
 578
 579   waiter = TlsGetValue (g_thread_xp_waiter_tls);
 580
 581   if (waiter != NULL)
 582     {
 583       TlsSetValue (g_thread_xp_waiter_tls, NULL);
 584       CloseHandle (waiter->event);
 585       free (waiter);
 586     }
 587 }
 588
 589 /* {{{2 SRWLock emulation */
 590 typedef struct
 591 {
 592   CRITICAL_SECTION  writer_lock;
 593   gboolean          ever_shared;    /* protected by writer_lock */
 594   gboolean          writer_locked;  /* protected by writer_lock */
 595
 596   /* below is only ever touched if ever_shared becomes true */
 597   CRITICAL_SECTION  atomicity;
 598   GThreadXpWaiter  *queued_writer; /* protected by atomicity lock */
 599   gint              num_readers;   /* protected by atomicity lock */
 600 } GThreadSRWLock;
 601
 602 static void __stdcall
 603 g_thread_xp_InitializeSRWLock (gpointer mutex)
 604 {
 605   *(GThreadSRWLock * volatile *) mutex = NULL;
 606 }
 607
 608 static void __stdcall
 609 g_thread_xp_DeleteSRWLock (gpointer mutex)
 610 {
 611   GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
 612
 613   if (lock)
 614     {
 615       if (lock->ever_shared)
 616         DeleteCriticalSection (&lock->atomicity);
 617
 618       DeleteCriticalSection (&lock->writer_lock);
 619       free (lock);
 620     }
 621 }
 622
 623 static GThreadSRWLock * __stdcall
 624 g_thread_xp_get_srwlock (GThreadSRWLock * volatile *lock)
 625 {
 626   GThreadSRWLock *result;
 627
 628   /* It looks like we're missing some barriers here, but this code only
 629    * ever runs on Windows XP, which in turn only ever runs on hardware
 630    * with a relatively rigid memory model.  The 'volatile' will take
 631    * care of the compiler.
 632    */
 633   result = *lock;
 634
 635   if G_UNLIKELY (result == NULL)
 636     {
 637       EnterCriticalSection (&g_thread_xp_lock);
 638
 639       result = malloc (sizeof (GThreadSRWLock));
 640
 641       if (result == NULL)
 642         g_thread_abort (errno, "malloc");
 643
 644       InitializeCriticalSection (&result->writer_lock);
 645       result->writer_locked = FALSE;
 646       result->ever_shared = FALSE;
 647       *lock = result;
 648
 649       LeaveCriticalSection (&g_thread_xp_lock);
 650     }
 651
 652   return result;
 653 }
 654
 655 static void __stdcall
 656 g_thread_xp_AcquireSRWLockExclusive (gpointer mutex)
 657 {
 658   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 659
 660   EnterCriticalSection (&lock->writer_lock);
 661
 662   /* CRITICAL_SECTION is reentrant, but SRWLock is not.
 663    * Detect the deadlock that would occur on later Windows version.
 664    */
 665   g_assert (!lock->writer_locked);
 666   lock->writer_locked = TRUE;
 667
 668   if (lock->ever_shared)
 669     {
 670       GThreadXpWaiter *waiter = NULL;
 671
 672       EnterCriticalSection (&lock->atomicity);
 673       if (lock->num_readers > 0)
 674         lock->queued_writer = waiter = g_thread_xp_waiter_get ();
 675       LeaveCriticalSection (&lock->atomicity);
 676
 677       if (waiter != NULL)
 678         WaitForSingleObject (waiter->event, INFINITE);
 679
 680       lock->queued_writer = NULL;
 681     }
 682 }
 683
 684 static BOOLEAN __stdcall
 685 g_thread_xp_TryAcquireSRWLockExclusive (gpointer mutex)
 686 {
 687   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 688
 689   if (!TryEnterCriticalSection (&lock->writer_lock))
 690     return FALSE;
 691
 692   /* CRITICAL_SECTION is reentrant, but SRWLock is not.
 693    * Ensure that this properly returns FALSE (as SRWLock would).
 694    */
 695   if G_UNLIKELY (lock->writer_locked)
 696     {
 697       LeaveCriticalSection (&lock->writer_lock);
 698       return FALSE;
 699     }
 700
 701   lock->writer_locked = TRUE;
 702
 703   if (lock->ever_shared)
 704     {
 705       gboolean available;
 706
 707       EnterCriticalSection (&lock->atomicity);
 708       available = lock->num_readers == 0;
 709       LeaveCriticalSection (&lock->atomicity);
 710
 711       if (!available)
 712         {
 713           LeaveCriticalSection (&lock->writer_lock);
 714           return FALSE;
 715         }
 716     }
 717
 718   return TRUE;
 719 }
 720
 721 static void __stdcall
 722 g_thread_xp_ReleaseSRWLockExclusive (gpointer mutex)
 723 {
 724   GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
 725
 726   lock->writer_locked = FALSE;
 727
 728   /* We need this until we fix some weird parts of GLib that try to
 729    * unlock freshly-allocated mutexes.
 730    */
 731   if (lock != NULL)
 732     LeaveCriticalSection (&lock->writer_lock);
 733 }
 734
 735 static void
 736 g_thread_xp_srwlock_become_reader (GThreadSRWLock *lock)
 737 {
 738   if G_UNLIKELY (!lock->ever_shared)
 739     {
 740       InitializeCriticalSection (&lock->atomicity);
 741       lock->queued_writer = NULL;
 742       lock->num_readers = 0;
 743
 744       lock->ever_shared = TRUE;
 745     }
 746
 747   EnterCriticalSection (&lock->atomicity);
 748   lock->num_readers++;
 749   LeaveCriticalSection (&lock->atomicity);
 750 }
 751
 752 static void __stdcall
 753 g_thread_xp_AcquireSRWLockShared (gpointer mutex)
 754 {
 755   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 756
 757   EnterCriticalSection (&lock->writer_lock);
 758
 759   /* See g_thread_xp_AcquireSRWLockExclusive */
 760   g_assert (!lock->writer_locked);
 761
 762   g_thread_xp_srwlock_become_reader (lock);
 763
 764   LeaveCriticalSection (&lock->writer_lock);
 765 }
 766
 767 static BOOLEAN __stdcall
 768 g_thread_xp_TryAcquireSRWLockShared (gpointer mutex)
 769 {
 770   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 771
 772   if (!TryEnterCriticalSection (&lock->writer_lock))
 773     return FALSE;
 774
 775   /* See g_thread_xp_AcquireSRWLockExclusive */
 776   if G_UNLIKELY (lock->writer_locked)
 777     {
 778       LeaveCriticalSection (&lock->writer_lock);
 779       return FALSE;
 780     }
 781
 782   g_thread_xp_srwlock_become_reader (lock);
 783
 784   LeaveCriticalSection (&lock->writer_lock);
 785
 786   return TRUE;
 787 }
 788
 789 static void __stdcall
 790 g_thread_xp_ReleaseSRWLockShared (gpointer mutex)
 791 {
 792   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 793
 794   EnterCriticalSection (&lock->atomicity);
 795
 796   lock->num_readers--;
 797
 798   if (lock->num_readers == 0 && lock->queued_writer)
 799     SetEvent (lock->queued_writer->event);
 800
 801   LeaveCriticalSection (&lock->atomicity);
 802 }
 803
 804 /* {{{2 CONDITION_VARIABLE emulation */
 805 typedef struct
 806 {
 807   volatile GThreadXpWaiter  *first;
 808   volatile GThreadXpWaiter **last_ptr;
 809 } GThreadXpCONDITION_VARIABLE;
 810
 811 static void __stdcall
 812 g_thread_xp_InitializeConditionVariable (gpointer cond)
 813 {
 814   *(GThreadXpCONDITION_VARIABLE * volatile *) cond = NULL;
 815 }
 816
 817 static void __stdcall
 818 g_thread_xp_DeleteConditionVariable (gpointer cond)
 819 {
 820   GThreadXpCONDITION_VARIABLE *cv = *(GThreadXpCONDITION_VARIABLE * volatile *) cond;
 821
 822   if (cv)
 823     free (cv);
 824 }
 825
 826 static GThreadXpCONDITION_VARIABLE * __stdcall
 827 g_thread_xp_get_condition_variable (GThreadXpCONDITION_VARIABLE * volatile *cond)
 828 {
 829   GThreadXpCONDITION_VARIABLE *result;
 830
 831   /* It looks like we're missing some barriers here, but this code only
 832    * ever runs on Windows XP, which in turn only ever runs on hardware
 833    * with a relatively rigid memory model.  The 'volatile' will take
 834    * care of the compiler.
 835    */
 836   result = *cond;
 837
 838   if G_UNLIKELY (result == NULL)
 839     {
 840       result = malloc (sizeof (GThreadXpCONDITION_VARIABLE));
 841
 842       if (result == NULL)
 843         g_thread_abort (errno, "malloc");
 844
 845       result->first = NULL;
 846       result->last_ptr = &result->first;
 847
 848       if (InterlockedCompareExchangePointer (cond, result, NULL) != NULL)
 849         {
 850           free (result);
 851           result = *cond;
 852         }
 853     }
 854
 855   return result;
 856 }
 857
 858 static BOOL __stdcall
 859 g_thread_xp_SleepConditionVariableSRW (gpointer cond,
 860                                        gpointer mutex,
 861                                        DWORD    timeout,
 862                                        ULONG    flags)
 863 {
 864   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 865   GThreadXpWaiter *waiter = g_thread_xp_waiter_get ();
 866   DWORD status;
 867
 868   waiter->next = NULL;
 869
 870   EnterCriticalSection (&g_thread_xp_lock);
 871   *cv->last_ptr = waiter;
 872   cv->last_ptr = &waiter->next;
 873   LeaveCriticalSection (&g_thread_xp_lock);
 874
 875   g_mutex_unlock (mutex);
 876   status = WaitForSingleObject (waiter->event, timeout);
 877
 878   if (status != WAIT_TIMEOUT && status != WAIT_OBJECT_0)
 879     g_thread_abort (GetLastError (), "WaitForSingleObject");
 880
 881   g_mutex_lock (mutex);
 882
 883   return status == WAIT_OBJECT_0;
 884 }
 885
 886 static void __stdcall
 887 g_thread_xp_WakeConditionVariable (gpointer cond)
 888 {
 889   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 890   volatile GThreadXpWaiter *waiter;
 891
 892   EnterCriticalSection (&g_thread_xp_lock);
 893   waiter = cv->first;
 894   if (waiter != NULL)
 895     {
 896       cv->first = waiter->next;
 897       if (cv->first == NULL)
 898         cv->last_ptr = &cv->first;
 899     }
 900   LeaveCriticalSection (&g_thread_xp_lock);
 901
 902   if (waiter != NULL)
 903     SetEvent (waiter->event);
 904 }
 905
 906 static void __stdcall
 907 g_thread_xp_WakeAllConditionVariable (gpointer cond)
 908 {
 909   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 910   volatile GThreadXpWaiter *waiter;
 911
 912   EnterCriticalSection (&g_thread_xp_lock);
 913   waiter = cv->first;
 914   cv->first = NULL;
 915   cv->last_ptr = &cv->first;
 916   LeaveCriticalSection (&g_thread_xp_lock);
 917
 918   while (waiter != NULL)
 919     {
 920       volatile GThreadXpWaiter *next;
 921
 922       next = waiter->next;
 923       SetEvent (waiter->event);
 924       waiter = next;
 925     }
 926 }
 927
 928 /* {{{2 XP Setup */
 929 static void
 930 g_thread_xp_init (void)
 931 {
 932   static const GThreadImplVtable g_thread_xp_impl_vtable = {
 933     g_thread_xp_CallThisOnThreadExit,
 934     g_thread_xp_InitializeSRWLock,
 935     g_thread_xp_DeleteSRWLock,
 936     g_thread_xp_AcquireSRWLockExclusive,
 937     g_thread_xp_TryAcquireSRWLockExclusive,
 938     g_thread_xp_ReleaseSRWLockExclusive,
 939     g_thread_xp_AcquireSRWLockShared,
 940     g_thread_xp_TryAcquireSRWLockShared,
 941     g_thread_xp_ReleaseSRWLockShared,
 942     g_thread_xp_InitializeConditionVariable,
 943     g_thread_xp_DeleteConditionVariable,
 944     g_thread_xp_SleepConditionVariableSRW,
 945     g_thread_xp_WakeAllConditionVariable,
 946     g_thread_xp_WakeConditionVariable
 947   };
 948
 949   InitializeCriticalSection (&g_thread_xp_lock);
 950   g_thread_xp_waiter_tls = TlsAlloc ();
 951
 952   g_thread_impl_vtable = g_thread_xp_impl_vtable;
 953 }
 954
 955 /* {{{1 Epilogue */
 956
 957 static gboolean
 958 g_thread_lookup_native_funcs (void)
 959 {
 960   GThreadImplVtable native_vtable = { 0, };
 961   HMODULE kernel32;
 962
 963   kernel32 = GetModuleHandle ("KERNEL32.DLL");
 964
 965   if (kernel32 == NULL)
 966     return FALSE;
 967
 968 #define GET_FUNC(name) if ((native_vtable.name = (void *) GetProcAddress (kernel32, #name)) == NULL) return FALSE
 969   GET_FUNC(InitializeSRWLock);
 970   GET_FUNC(AcquireSRWLockExclusive);
 971   GET_FUNC(TryAcquireSRWLockExclusive);
 972   GET_FUNC(ReleaseSRWLockExclusive);
 973   GET_FUNC(AcquireSRWLockShared);
 974   GET_FUNC(TryAcquireSRWLockShared);
 975   GET_FUNC(ReleaseSRWLockShared);
 976
 977   GET_FUNC(InitializeConditionVariable);
 978   GET_FUNC(SleepConditionVariableSRW);
 979   GET_FUNC(WakeAllConditionVariable);
 980   GET_FUNC(WakeConditionVariable);
 981 #undef GET_FUNC
 982
 983   g_thread_impl_vtable = native_vtable;
 984
 985   return TRUE;
 986 }
 987
 988 G_GNUC_INTERNAL void
 989 g_thread_win32_init (void)
 990 {
 991   if (g_thread_lookup_native_funcs ())
 992     fprintf (stderr, "(debug) GThread using native mode\n");
 993   else
 994     {
 995       fprintf (stderr, "(debug) GThread using Windows XP mode\n");
 996       g_thread_xp_init ();
 997     }
 998
 999   InitializeCriticalSection (&g_private_lock);
1000 }
1001
1002 G_GNUC_INTERNAL void
1003 g_thread_win32_thread_detach (void)
1004 {
1005   gboolean dtors_called;
1006
1007   do
1008     {
1009       GPrivateDestructor *dtor;
1010
1011       /* We go by the POSIX book on this one.
1012        *
1013        * If we call a destructor then there is a chance that some new
1014        * TLS variables got set by code called in that destructor.
1015        *
1016        * Loop until nothing is left.
1017        */
1018       dtors_called = FALSE;
1019
1020       for (dtor = g_private_destructors; dtor; dtor = dtor->next)
1021         {
1022           gpointer value;
1023
1024           value = TlsGetValue (dtor->index);
1025           if (value != NULL && dtor->notify != NULL)
1026             {
1027               /* POSIX says to clear this before the call */
1028               TlsSetValue (dtor->index, NULL);
1029               dtor->notify (value);
1030               dtors_called = TRUE;
1031             }
1032         }
1033     }
1034   while (dtors_called);
1035
1036   if (g_thread_impl_vtable.CallThisOnThreadExit)
1037     g_thread_impl_vtable.CallThisOnThreadExit ();
1038 }
1039
1040 /* vim:set foldmethod=marker: */