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 static DWORD g_thread_self_tls;
 454
 455 typedef BOOL (__stdcall *GTryEnterCriticalSectionFunc) (CRITICAL_SECTION *);
 456
 457 typedef struct _GThreadData GThreadData;
 458 struct _GThreadData
 459 {
 460   GThreadFunc func;
 461   gpointer data;
 462   HANDLE thread;
 463   gboolean joinable;
 464 };
 465
 466 void
 467 g_system_thread_self (gpointer thread)
 468 {
 469   GThreadData *self = TlsGetValue (g_thread_self_tls);
 470
 471   if (!self)
 472     {
 473       /* This should only happen for the main thread! */
 474       HANDLE handle = GetCurrentThread ();
 475       HANDLE process = GetCurrentProcess ();
 476       self = g_new (GThreadData, 1);
 477       win32_check_for_error (DuplicateHandle (process, handle, process,
 478                                               &self->thread, 0, FALSE,
 479                                               DUPLICATE_SAME_ACCESS));
 480       win32_check_for_error (TlsSetValue (g_thread_self_tls, self));
 481       self->func = NULL;
 482       self->data = NULL;
 483       self->joinable = FALSE;
 484     }
 485
 486   *(GThreadData **)thread = self;
 487 }
 488
 489 void
 490 g_system_thread_exit (void)
 491 {
 492   GThreadData *self = TlsGetValue (g_thread_self_tls);
 493   gboolean dtors_called;
 494
 495   do
 496     {
 497       GPrivateDestructor *dtor;
 498
 499       /* We go by the POSIX book on this one.
 500        *
 501        * If we call a destructor then there is a chance that some new
 502        * TLS variables got set by code called in that destructor.
 503        *
 504        * Loop until nothing is left.
 505        */
 506       dtors_called = FALSE;
 507
 508       for (dtor = g_private_destructors; dtor; dtor = dtor->next)
 509         {
 510           gpointer value;
 511
 512           value = TlsGetValue (dtor->index);
 513           if (value != NULL && dtor->notify != NULL)
 514             {
 515               /* POSIX says to clear this before the call */
 516               TlsSetValue (dtor->index, NULL);
 517               dtor->notify (value);
 518               dtors_called = TRUE;
 519             }
 520         }
 521     }
 522   while (dtors_called);
 523
 524   if (self)
 525     {
 526       if (!self->joinable)
 527         {
 528           win32_check_for_error (CloseHandle (self->thread));
 529           g_free (self);
 530         }
 531       win32_check_for_error (TlsSetValue (g_thread_self_tls, NULL));
 532     }
 533
 534   if (g_thread_impl_vtable.CallThisOnThreadExit)
 535     g_thread_impl_vtable.CallThisOnThreadExit ();
 536
 537   _endthreadex (0);
 538 }
 539
 540 static guint __stdcall
 541 g_thread_proxy (gpointer data)
 542 {
 543   GThreadData *self = (GThreadData*) data;
 544
 545   win32_check_for_error (TlsSetValue (g_thread_self_tls, self));
 546
 547   self->func (self->data);
 548
 549   g_system_thread_exit ();
 550
 551   g_assert_not_reached ();
 552
 553   return 0;
 554 }
 555
 556 void
 557 g_system_thread_create (GThreadFunc       func,
 558                         gpointer          data,
 559                         gulong            stack_size,
 560                         gboolean          joinable,
 561                         gpointer          thread,
 562                         GError          **error)
 563 {
 564   guint ignore;
 565   GThreadData *retval;
 566
 567   g_return_if_fail (func);
 568
 569   retval = g_new(GThreadData, 1);
 570   retval->func = func;
 571   retval->data = data;
 572
 573   retval->joinable = joinable;
 574
 575   retval->thread = (HANDLE) _beginthreadex (NULL, stack_size, g_thread_proxy,
 576                                             retval, 0, &ignore);
 577
 578   if (retval->thread == NULL)
 579     {
 580       gchar *win_error = g_win32_error_message (GetLastError ());
 581       g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
 582                    "Error creating thread: %s", win_error);
 583       g_free (retval);
 584       g_free (win_error);
 585       return;
 586     }
 587
 588   *(GThreadData **)thread = retval;
 589 }
 590
 591 void
 592 g_thread_yield (void)
 593 {
 594   Sleep(0);
 595 }
 596
 597 void
 598 g_system_thread_join (gpointer thread)
 599 {
 600   GThreadData *target = *(GThreadData **)thread;
 601
 602   g_return_if_fail (target->joinable);
 603
 604   win32_check_for_error (WAIT_FAILED !=
 605                          WaitForSingleObject (target->thread, INFINITE));
 606
 607   win32_check_for_error (CloseHandle (target->thread));
 608   g_free (target);
 609 }
 610
 611 gboolean
 612 g_system_thread_equal (gpointer thread1,
 613                        gpointer thread2)
 614 {
 615    return ((GSystemThread*)thread1)->dummy_pointer == ((GSystemThread*)thread2)->dummy_pointer;
 616 }
 617
 618 void
 619 g_system_thread_set_name (const gchar *name)
 620 {
 621   /* FIXME: implement */
 622 }
 623
 624 /* {{{1 SRWLock and CONDITION_VARIABLE emulation (for Windows XP) */
 625
 626 static CRITICAL_SECTION g_thread_xp_lock;
 627 static DWORD            g_thread_xp_waiter_tls;
 628
 629 /* {{{2 GThreadWaiter utility class for CONDITION_VARIABLE emulation */
 630 typedef struct _GThreadXpWaiter GThreadXpWaiter;
 631 struct _GThreadXpWaiter
 632 {
 633   HANDLE                    event;
 634   volatile GThreadXpWaiter *next;
 635 };
 636
 637 static GThreadXpWaiter *
 638 g_thread_xp_waiter_get (void)
 639 {
 640   GThreadXpWaiter *waiter;
 641
 642   waiter = TlsGetValue (g_thread_xp_waiter_tls);
 643
 644   if G_UNLIKELY (waiter == NULL)
 645     {
 646       waiter = malloc (sizeof (GThreadXpWaiter));
 647       if (waiter == NULL)
 648         g_thread_abort (GetLastError (), "malloc");
 649       waiter->event = CreateEvent (0, FALSE, FALSE, NULL);
 650       if (waiter->event == NULL)
 651         g_thread_abort (GetLastError (), "CreateEvent");
 652
 653       TlsSetValue (g_thread_xp_waiter_tls, waiter);
 654     }
 655
 656   return waiter;
 657 }
 658
 659 static void __stdcall
 660 g_thread_xp_CallThisOnThreadExit (void)
 661 {
 662   GThreadXpWaiter *waiter;
 663
 664   waiter = TlsGetValue (g_thread_xp_waiter_tls);
 665
 666   if (waiter != NULL)
 667     {
 668       TlsSetValue (g_thread_xp_waiter_tls, NULL);
 669       CloseHandle (waiter->event);
 670       free (waiter);
 671     }
 672 }
 673
 674 /* {{{2 SRWLock emulation */
 675 typedef struct
 676 {
 677   CRITICAL_SECTION  writer_lock;
 678   gboolean          ever_shared;    /* protected by writer_lock */
 679   gboolean          writer_locked;  /* protected by writer_lock */
 680
 681   /* below is only ever touched if ever_shared becomes true */
 682   CRITICAL_SECTION  atomicity;
 683   GThreadXpWaiter  *queued_writer; /* protected by atomicity lock */
 684   gint              num_readers;   /* protected by atomicity lock */
 685 } GThreadSRWLock;
 686
 687 static void __stdcall
 688 g_thread_xp_InitializeSRWLock (gpointer mutex)
 689 {
 690   *(GThreadSRWLock * volatile *) mutex = NULL;
 691 }
 692
 693 static void __stdcall
 694 g_thread_xp_DeleteSRWLock (gpointer mutex)
 695 {
 696   GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
 697
 698   if (lock)
 699     {
 700       if (lock->ever_shared)
 701         DeleteCriticalSection (&lock->atomicity);
 702
 703       DeleteCriticalSection (&lock->writer_lock);
 704       free (lock);
 705     }
 706 }
 707
 708 static GThreadSRWLock * __stdcall
 709 g_thread_xp_get_srwlock (GThreadSRWLock * volatile *lock)
 710 {
 711   GThreadSRWLock *result;
 712
 713   /* It looks like we're missing some barriers here, but this code only
 714    * ever runs on Windows XP, which in turn only ever runs on hardware
 715    * with a relatively rigid memory model.  The 'volatile' will take
 716    * care of the compiler.
 717    */
 718   result = *lock;
 719
 720   if G_UNLIKELY (result == NULL)
 721     {
 722       EnterCriticalSection (&g_thread_xp_lock);
 723
 724       result = malloc (sizeof (GThreadSRWLock));
 725
 726       if (result == NULL)
 727         g_thread_abort (errno, "malloc");
 728
 729       InitializeCriticalSection (&result->writer_lock);
 730       result->writer_locked = FALSE;
 731       result->ever_shared = FALSE;
 732       *lock = result;
 733
 734       LeaveCriticalSection (&g_thread_xp_lock);
 735     }
 736
 737   return result;
 738 }
 739
 740 static void __stdcall
 741 g_thread_xp_AcquireSRWLockExclusive (gpointer mutex)
 742 {
 743   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 744
 745   EnterCriticalSection (&lock->writer_lock);
 746
 747   /* CRITICAL_SECTION is reentrant, but SRWLock is not.
 748    * Detect the deadlock that would occur on later Windows version.
 749    */
 750   g_assert (!lock->writer_locked);
 751   lock->writer_locked = TRUE;
 752
 753   if (lock->ever_shared)
 754     {
 755       GThreadXpWaiter *waiter = NULL;
 756
 757       EnterCriticalSection (&lock->atomicity);
 758       if (lock->num_readers > 0)
 759         lock->queued_writer = waiter = g_thread_xp_waiter_get ();
 760       LeaveCriticalSection (&lock->atomicity);
 761
 762       if (waiter != NULL)
 763         WaitForSingleObject (waiter->event, INFINITE);
 764
 765       lock->queued_writer = NULL;
 766     }
 767 }
 768
 769 static BOOLEAN __stdcall
 770 g_thread_xp_TryAcquireSRWLockExclusive (gpointer mutex)
 771 {
 772   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 773
 774   if (!TryEnterCriticalSection (&lock->writer_lock))
 775     return FALSE;
 776
 777   /* CRITICAL_SECTION is reentrant, but SRWLock is not.
 778    * Ensure that this properly returns FALSE (as SRWLock would).
 779    */
 780   if G_UNLIKELY (lock->writer_locked)
 781     {
 782       LeaveCriticalSection (&lock->writer_lock);
 783       return FALSE;
 784     }
 785
 786   lock->writer_locked = TRUE;
 787
 788   if (lock->ever_shared)
 789     {
 790       gboolean available;
 791
 792       EnterCriticalSection (&lock->atomicity);
 793       available = lock->num_readers == 0;
 794       LeaveCriticalSection (&lock->atomicity);
 795
 796       if (!available)
 797         {
 798           LeaveCriticalSection (&lock->writer_lock);
 799           return FALSE;
 800         }
 801     }
 802
 803   return TRUE;
 804 }
 805
 806 static void __stdcall
 807 g_thread_xp_ReleaseSRWLockExclusive (gpointer mutex)
 808 {
 809   GThreadSRWLock *lock = *(GThreadSRWLock * volatile *) mutex;
 810
 811   lock->writer_locked = FALSE;
 812
 813   /* We need this until we fix some weird parts of GLib that try to
 814    * unlock freshly-allocated mutexes.
 815    */
 816   if (lock != NULL)
 817     LeaveCriticalSection (&lock->writer_lock);
 818 }
 819
 820 static void
 821 g_thread_xp_srwlock_become_reader (GThreadSRWLock *lock)
 822 {
 823   if G_UNLIKELY (!lock->ever_shared)
 824     {
 825       InitializeCriticalSection (&lock->atomicity);
 826       lock->queued_writer = NULL;
 827       lock->num_readers = 0;
 828
 829       lock->ever_shared = TRUE;
 830     }
 831
 832   EnterCriticalSection (&lock->atomicity);
 833   lock->num_readers++;
 834   LeaveCriticalSection (&lock->atomicity);
 835 }
 836
 837 static void __stdcall
 838 g_thread_xp_AcquireSRWLockShared (gpointer mutex)
 839 {
 840   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 841
 842   EnterCriticalSection (&lock->writer_lock);
 843
 844   /* See g_thread_xp_AcquireSRWLockExclusive */
 845   g_assert (!lock->writer_locked);
 846
 847   g_thread_xp_srwlock_become_reader (lock);
 848
 849   LeaveCriticalSection (&lock->writer_lock);
 850 }
 851
 852 static BOOLEAN __stdcall
 853 g_thread_xp_TryAcquireSRWLockShared (gpointer mutex)
 854 {
 855   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 856
 857   if (!TryEnterCriticalSection (&lock->writer_lock))
 858     return FALSE;
 859
 860   /* See g_thread_xp_AcquireSRWLockExclusive */
 861   if G_UNLIKELY (lock->writer_locked)
 862     {
 863       LeaveCriticalSection (&lock->writer_lock);
 864       return FALSE;
 865     }
 866
 867   g_thread_xp_srwlock_become_reader (lock);
 868
 869   LeaveCriticalSection (&lock->writer_lock);
 870
 871   return TRUE;
 872 }
 873
 874 static void __stdcall
 875 g_thread_xp_ReleaseSRWLockShared (gpointer mutex)
 876 {
 877   GThreadSRWLock *lock = g_thread_xp_get_srwlock (mutex);
 878
 879   EnterCriticalSection (&lock->atomicity);
 880
 881   lock->num_readers--;
 882
 883   if (lock->num_readers == 0 && lock->queued_writer)
 884     SetEvent (lock->queued_writer->event);
 885
 886   LeaveCriticalSection (&lock->atomicity);
 887 }
 888
 889 /* {{{2 CONDITION_VARIABLE emulation */
 890 typedef struct
 891 {
 892   volatile GThreadXpWaiter  *first;
 893   volatile GThreadXpWaiter **last_ptr;
 894 } GThreadXpCONDITION_VARIABLE;
 895
 896 static void __stdcall
 897 g_thread_xp_InitializeConditionVariable (gpointer cond)
 898 {
 899   *(GThreadXpCONDITION_VARIABLE * volatile *) cond = NULL;
 900 }
 901
 902 static void __stdcall
 903 g_thread_xp_DeleteConditionVariable (gpointer cond)
 904 {
 905   GThreadXpCONDITION_VARIABLE *cv = *(GThreadXpCONDITION_VARIABLE * volatile *) cond;
 906
 907   if (cv)
 908     free (cv);
 909 }
 910
 911 static GThreadXpCONDITION_VARIABLE * __stdcall
 912 g_thread_xp_get_condition_variable (GThreadXpCONDITION_VARIABLE * volatile *cond)
 913 {
 914   GThreadXpCONDITION_VARIABLE *result;
 915
 916   /* It looks like we're missing some barriers here, but this code only
 917    * ever runs on Windows XP, which in turn only ever runs on hardware
 918    * with a relatively rigid memory model.  The 'volatile' will take
 919    * care of the compiler.
 920    */
 921   result = *cond;
 922
 923   if G_UNLIKELY (result == NULL)
 924     {
 925       result = malloc (sizeof (GThreadXpCONDITION_VARIABLE));
 926
 927       if (result == NULL)
 928         g_thread_abort (errno, "malloc");
 929
 930       result->first = NULL;
 931       result->last_ptr = &result->first;
 932
 933       if (InterlockedCompareExchangePointer (cond, result, NULL) != NULL)
 934         {
 935           free (result);
 936           result = *cond;
 937         }
 938     }
 939
 940   return result;
 941 }
 942
 943 static BOOL __stdcall
 944 g_thread_xp_SleepConditionVariableSRW (gpointer cond,
 945                                        gpointer mutex,
 946                                        DWORD    timeout,
 947                                        ULONG    flags)
 948 {
 949   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 950   GThreadXpWaiter *waiter = g_thread_xp_waiter_get ();
 951   DWORD status;
 952
 953   waiter->next = NULL;
 954
 955   EnterCriticalSection (&g_thread_xp_lock);
 956   *cv->last_ptr = waiter;
 957   cv->last_ptr = &waiter->next;
 958   LeaveCriticalSection (&g_thread_xp_lock);
 959
 960   g_mutex_unlock (mutex);
 961   status = WaitForSingleObject (waiter->event, timeout);
 962
 963   if (status != WAIT_TIMEOUT && status != WAIT_OBJECT_0)
 964     g_thread_abort (GetLastError (), "WaitForSingleObject");
 965
 966   g_mutex_lock (mutex);
 967
 968   return status == WAIT_OBJECT_0;
 969 }
 970
 971 static void __stdcall
 972 g_thread_xp_WakeConditionVariable (gpointer cond)
 973 {
 974   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 975   volatile GThreadXpWaiter *waiter;
 976
 977   EnterCriticalSection (&g_thread_xp_lock);
 978   waiter = cv->first;
 979   if (waiter != NULL)
 980     {
 981       cv->first = waiter->next;
 982       if (cv->first == NULL)
 983         cv->last_ptr = &cv->first;
 984     }
 985   LeaveCriticalSection (&g_thread_xp_lock);
 986
 987   if (waiter != NULL)
 988     SetEvent (waiter->event);
 989 }
 990
 991 static void __stdcall
 992 g_thread_xp_WakeAllConditionVariable (gpointer cond)
 993 {
 994   GThreadXpCONDITION_VARIABLE *cv = g_thread_xp_get_condition_variable (cond);
 995   volatile GThreadXpWaiter *waiter;
 996
 997   EnterCriticalSection (&g_thread_xp_lock);
 998   waiter = cv->first;
 999   cv->first = NULL;
1000   cv->last_ptr = &cv->first;
1001   LeaveCriticalSection (&g_thread_xp_lock);
1002
1003   while (waiter != NULL)
1004     {
1005       volatile GThreadXpWaiter *next;
1006
1007       next = waiter->next;
1008       SetEvent (waiter->event);
1009       waiter = next;
1010     }
1011 }
1012
1013 /* {{{2 XP Setup */
1014 static void
1015 g_thread_xp_init (void)
1016 {
1017   static const GThreadImplVtable g_thread_xp_impl_vtable = {
1018     g_thread_xp_CallThisOnThreadExit,
1019     g_thread_xp_InitializeSRWLock,
1020     g_thread_xp_DeleteSRWLock,
1021     g_thread_xp_AcquireSRWLockExclusive,
1022     g_thread_xp_TryAcquireSRWLockExclusive,
1023     g_thread_xp_ReleaseSRWLockExclusive,
1024     g_thread_xp_AcquireSRWLockShared,
1025     g_thread_xp_TryAcquireSRWLockShared,
1026     g_thread_xp_ReleaseSRWLockShared,
1027     g_thread_xp_InitializeConditionVariable,
1028     g_thread_xp_DeleteConditionVariable,
1029     g_thread_xp_SleepConditionVariableSRW,
1030     g_thread_xp_WakeAllConditionVariable,
1031     g_thread_xp_WakeConditionVariable
1032   };
1033
1034   InitializeCriticalSection (&g_thread_xp_lock);
1035   g_thread_xp_waiter_tls = TlsAlloc ();
1036
1037   g_thread_impl_vtable = g_thread_xp_impl_vtable;
1038 }
1039
1040 /* {{{1 Epilogue */
1041
1042 static gboolean
1043 g_thread_lookup_native_funcs (void)
1044 {
1045   GThreadImplVtable native_vtable = { 0, };
1046   HMODULE kernel32;
1047
1048   kernel32 = GetModuleHandle ("KERNEL32.DLL");
1049
1050   if (kernel32 == NULL)
1051     return FALSE;
1052
1053 #define GET_FUNC(name) if ((native_vtable.name = (void *) GetProcAddress (kernel32, #name)) == NULL) return FALSE
1054   GET_FUNC(InitializeSRWLock);
1055   GET_FUNC(AcquireSRWLockExclusive);
1056   GET_FUNC(TryAcquireSRWLockExclusive);
1057   GET_FUNC(ReleaseSRWLockExclusive);
1058   GET_FUNC(AcquireSRWLockShared);
1059   GET_FUNC(TryAcquireSRWLockShared);
1060   GET_FUNC(ReleaseSRWLockShared);
1061
1062   GET_FUNC(InitializeConditionVariable);
1063   GET_FUNC(SleepConditionVariableSRW);
1064   GET_FUNC(WakeAllConditionVariable);
1065   GET_FUNC(WakeConditionVariable);
1066 #undef GET_FUNC
1067
1068   g_thread_impl_vtable = native_vtable;
1069
1070   return TRUE;
1071 }
1072
1073 G_GNUC_INTERNAL void
1074 g_thread_win32_init (void)
1075 {
1076   if (g_thread_lookup_native_funcs ())
1077     fprintf (stderr, "(debug) GThread using native mode\n");
1078   else
1079     {
1080       fprintf (stderr, "(debug) GThread using Windows XP mode\n");
1081       g_thread_xp_init ();
1082     }
1083
1084   win32_check_for_error (TLS_OUT_OF_INDEXES != (g_thread_self_tls = TlsAlloc ()));
1085   InitializeCriticalSection (&g_private_lock);
1086 }
1087
1088 /* vim:set foldmethod=marker: */
1089