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.1 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, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 /*
  23  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  24  * file for a list of people on the GLib Team.  See the ChangeLog
  25  * files for a list of changes.  These files are distributed with
  26  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  27  */
  28
  29 /* The GMutex and GCond implementations in this file are some of the
  30  * lowest-level code in GLib.  All other parts of GLib (messages,
  31  * memory, slices, etc) assume that they can freely use these facilities
  32  * without risking recursion.
  33  *
  34  * As such, these functions are NOT permitted to call any other part of
  35  * GLib.
  36  *
  37  * The thread manipulation functions (create, exit, join, etc.) have
  38  * more freedom -- they can do as they please.
  39  */
  40
  41 #include "config.h"
  42
  43 #include "glib.h"
  44 #include "glib-init.h"
  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   g_abort ();
  62 }
  63
  64 /* Starting with Vista and Windows 2008, we have access to the
  65  * CONDITION_VARIABLE and SRWLock primitives on Windows, which are
  66  * pretty reasonable approximations of the primitives 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
  78 /* {{{1 GMutex */
  79 void
  80 g_mutex_init (GMutex *mutex)
  81 {
  82   InitializeSRWLock ((gpointer) mutex);
  83 }
  84
  85 void
  86 g_mutex_clear (GMutex *mutex)
  87 {
  88 }
  89
  90 void
  91 g_mutex_lock (GMutex *mutex)
  92 {
  93   AcquireSRWLockExclusive ((gpointer) mutex);
  94 }
  95
  96 gboolean
  97 g_mutex_trylock (GMutex *mutex)
  98 {
  99   return TryAcquireSRWLockExclusive ((gpointer) mutex);
 100 }
 101
 102 void
 103 g_mutex_unlock (GMutex *mutex)
 104 {
 105   ReleaseSRWLockExclusive ((gpointer) mutex);
 106 }
 107
 108 /* {{{1 GRecMutex */
 109
 110 static CRITICAL_SECTION *
 111 g_rec_mutex_impl_new (void)
 112 {
 113   CRITICAL_SECTION *cs;
 114
 115   cs = g_slice_new (CRITICAL_SECTION);
 116   InitializeCriticalSection (cs);
 117
 118   return cs;
 119 }
 120
 121 static void
 122 g_rec_mutex_impl_free (CRITICAL_SECTION *cs)
 123 {
 124   DeleteCriticalSection (cs);
 125   g_slice_free (CRITICAL_SECTION, cs);
 126 }
 127
 128 static CRITICAL_SECTION *
 129 g_rec_mutex_get_impl (GRecMutex *mutex)
 130 {
 131   CRITICAL_SECTION *impl = mutex->p;
 132
 133   if G_UNLIKELY (mutex->p == NULL)
 134     {
 135       impl = g_rec_mutex_impl_new ();
 136       if (InterlockedCompareExchangePointer (&mutex->p, impl, NULL) != NULL)
 137         g_rec_mutex_impl_free (impl);
 138       impl = mutex->p;
 139     }
 140
 141   return impl;
 142 }
 143
 144 void
 145 g_rec_mutex_init (GRecMutex *mutex)
 146 {
 147   mutex->p = g_rec_mutex_impl_new ();
 148 }
 149
 150 void
 151 g_rec_mutex_clear (GRecMutex *mutex)
 152 {
 153   g_rec_mutex_impl_free (mutex->p);
 154 }
 155
 156 void
 157 g_rec_mutex_lock (GRecMutex *mutex)
 158 {
 159   EnterCriticalSection (g_rec_mutex_get_impl (mutex));
 160 }
 161
 162 void
 163 g_rec_mutex_unlock (GRecMutex *mutex)
 164 {
 165   LeaveCriticalSection (mutex->p);
 166 }
 167
 168 gboolean
 169 g_rec_mutex_trylock (GRecMutex *mutex)
 170 {
 171   return TryEnterCriticalSection (g_rec_mutex_get_impl (mutex));
 172 }
 173
 174 /* {{{1 GRWLock */
 175
 176 void
 177 g_rw_lock_init (GRWLock *lock)
 178 {
 179   InitializeSRWLock ((gpointer) lock);
 180 }
 181
 182 void
 183 g_rw_lock_clear (GRWLock *lock)
 184 {
 185 }
 186
 187 void
 188 g_rw_lock_writer_lock (GRWLock *lock)
 189 {
 190   AcquireSRWLockExclusive ((gpointer) lock);
 191 }
 192
 193 gboolean
 194 g_rw_lock_writer_trylock (GRWLock *lock)
 195 {
 196   return TryAcquireSRWLockExclusive ((gpointer) lock);
 197 }
 198
 199 void
 200 g_rw_lock_writer_unlock (GRWLock *lock)
 201 {
 202   ReleaseSRWLockExclusive ((gpointer) lock);
 203 }
 204
 205 void
 206 g_rw_lock_reader_lock (GRWLock *lock)
 207 {
 208   AcquireSRWLockShared ((gpointer) lock);
 209 }
 210
 211 gboolean
 212 g_rw_lock_reader_trylock (GRWLock *lock)
 213 {
 214   return TryAcquireSRWLockShared ((gpointer) lock);
 215 }
 216
 217 void
 218 g_rw_lock_reader_unlock (GRWLock *lock)
 219 {
 220   ReleaseSRWLockShared ((gpointer) lock);
 221 }
 222
 223 /* {{{1 GCond */
 224 void
 225 g_cond_init (GCond *cond)
 226 {
 227   InitializeConditionVariable ((gpointer) cond);
 228 }
 229
 230 void
 231 g_cond_clear (GCond *cond)
 232 {
 233 }
 234
 235 void
 236 g_cond_signal (GCond *cond)
 237 {
 238   WakeConditionVariable ((gpointer) cond);
 239 }
 240
 241 void
 242 g_cond_broadcast (GCond *cond)
 243 {
 244   WakeAllConditionVariable ((gpointer) cond);
 245 }
 246
 247 void
 248 g_cond_wait (GCond  *cond,
 249              GMutex *entered_mutex)
 250 {
 251   SleepConditionVariableSRW ((gpointer) cond, (gpointer) entered_mutex, INFINITE, 0);
 252 }
 253
 254 gboolean
 255 g_cond_wait_until (GCond  *cond,
 256                    GMutex *entered_mutex,
 257                    gint64  end_time)
 258 {
 259   gint64 span, start_time;
 260   DWORD span_millis;
 261   gboolean signalled;
 262
 263   start_time = g_get_monotonic_time ();
 264   do
 265     {
 266       span = end_time - start_time;
 267
 268       if G_UNLIKELY (span < 0)
 269         span_millis = 0;
 270       else if G_UNLIKELY (span > G_GINT64_CONSTANT (1000) * (DWORD) INFINITE)
 271         span_millis = INFINITE;
 272       else
 273         /* Round up so we don't time out too early */
 274         span_millis = (span + 1000 - 1) / 1000;
 275
 276       /* We never want to wait infinitely */
 277       if (span_millis >= INFINITE)
 278         span_millis = INFINITE - 1;
 279
 280       signalled = SleepConditionVariableSRW ((gpointer) cond, (gpointer) entered_mutex, span_millis, 0);
 281       if (signalled)
 282         break;
 283
 284       /* In case we didn't wait long enough after a timeout, wait again for the
 285        * remaining time */
 286       start_time = g_get_monotonic_time ();
 287     }
 288   while (start_time < end_time);
 289
 290   return signalled;
 291 }
 292
 293 /* {{{1 GPrivate */
 294
 295 typedef struct _GPrivateDestructor GPrivateDestructor;
 296
 297 struct _GPrivateDestructor
 298 {
 299   DWORD               index;
 300   GDestroyNotify      notify;
 301   GPrivateDestructor *next;
 302 };
 303
 304 static GPrivateDestructor * volatile g_private_destructors;
 305 static CRITICAL_SECTION g_private_lock;
 306
 307 static DWORD
 308 g_private_get_impl (GPrivate *key)
 309 {
 310   DWORD impl = (DWORD) key->p;
 311
 312   if G_UNLIKELY (impl == 0)
 313     {
 314       EnterCriticalSection (&g_private_lock);
 315       impl = (DWORD) key->p;
 316       if (impl == 0)
 317         {
 318           GPrivateDestructor *destructor;
 319
 320           impl = TlsAlloc ();
 321
 322           if (impl == TLS_OUT_OF_INDEXES)
 323             g_thread_abort (0, "TlsAlloc");
 324
 325           if (key->notify != NULL)
 326             {
 327               destructor = malloc (sizeof (GPrivateDestructor));
 328               if G_UNLIKELY (destructor == NULL)
 329                 g_thread_abort (errno, "malloc");
 330               destructor->index = impl;
 331               destructor->notify = key->notify;
 332               destructor->next = g_private_destructors;
 333
 334               /* We need to do an atomic store due to the unlocked
 335                * access to the destructor list from the thread exit
 336                * function.
 337                *
 338                * It can double as a sanity check...
 339                */
 340               if (InterlockedCompareExchangePointer (&g_private_destructors, destructor,
 341                                                      destructor->next) != destructor->next)
 342                 g_thread_abort (0, "g_private_get_impl(1)");
 343             }
 344
 345           /* Ditto, due to the unlocked access on the fast path */
 346           if (InterlockedCompareExchangePointer (&key->p, impl, NULL) != NULL)
 347             g_thread_abort (0, "g_private_get_impl(2)");
 348         }
 349       LeaveCriticalSection (&g_private_lock);
 350     }
 351
 352   return impl;
 353 }
 354
 355 gpointer
 356 g_private_get (GPrivate *key)
 357 {
 358   return TlsGetValue (g_private_get_impl (key));
 359 }
 360
 361 void
 362 g_private_set (GPrivate *key,
 363                gpointer  value)
 364 {
 365   TlsSetValue (g_private_get_impl (key), value);
 366 }
 367
 368 void
 369 g_private_replace (GPrivate *key,
 370                    gpointer  value)
 371 {
 372   DWORD impl = g_private_get_impl (key);
 373   gpointer old;
 374
 375   old = TlsGetValue (impl);
 376   TlsSetValue (impl, value);
 377   if (old && key->notify)
 378     key->notify (old);
 379 }
 380
 381 /* {{{1 GThread */
 382
 383 #define win32_check_for_error(what) G_STMT_START{                       \
 384   if (!(what))                                                          \
 385     g_error ("file %s: line %d (%s): error %s during %s",               \
 386              __FILE__, __LINE__, G_STRFUNC,                             \
 387              g_win32_error_message (GetLastError ()), #what);           \
 388   }G_STMT_END
 389
 390 #define G_MUTEX_SIZE (sizeof (gpointer))
 391
 392 typedef BOOL (__stdcall *GTryEnterCriticalSectionFunc) (CRITICAL_SECTION *);
 393
 394 typedef struct
 395 {
 396   GRealThread thread;
 397
 398   GThreadFunc proxy;
 399   HANDLE      handle;
 400 } GThreadWin32;
 401
 402 void
 403 g_system_thread_free (GRealThread *thread)
 404 {
 405   GThreadWin32 *wt = (GThreadWin32 *) thread;
 406
 407   win32_check_for_error (CloseHandle (wt->handle));
 408   g_slice_free (GThreadWin32, wt);
 409 }
 410
 411 void
 412 g_system_thread_exit (void)
 413 {
 414   _endthreadex (0);
 415 }
 416
 417 static guint __stdcall
 418 g_thread_win32_proxy (gpointer data)
 419 {
 420   GThreadWin32 *self = data;
 421
 422   self->proxy (self);
 423
 424   g_system_thread_exit ();
 425
 426   g_assert_not_reached ();
 427
 428   return 0;
 429 }
 430
 431 gboolean
 432 g_system_thread_get_scheduler_settings (GThreadSchedulerSettings *scheduler_settings)
 433 {
 434   HANDLE current_thread = GetCurrentThread ();
 435   scheduler_settings->thread_prio = GetThreadPriority (current_thread);
 436
 437   return TRUE;
 438 }
 439
 440 GRealThread *
 441 g_system_thread_new (GThreadFunc proxy,
 442                      gulong stack_size,
 443                      const GThreadSchedulerSettings *scheduler_settings,
 444                      const char *name,
 445                      GThreadFunc func,
 446                      gpointer data,
 447                      GError **error)
 448 {
 449   GThreadWin32 *thread;
 450   GRealThread *base_thread;
 451   guint ignore;
 452   const gchar *message = NULL;
 453   int thread_prio;
 454
 455   thread = g_slice_new0 (GThreadWin32);
 456   thread->proxy = proxy;
 457   thread->handle = (HANDLE) NULL;
 458   base_thread = (GRealThread*)thread;
 459   base_thread->ref_count = 2;
 460   base_thread->ours = TRUE;
 461   base_thread->thread.joinable = TRUE;
 462   base_thread->thread.func = func;
 463   base_thread->thread.data = data;
 464   base_thread->name = g_strdup (name);
 465
 466   thread->handle = (HANDLE) _beginthreadex (NULL, stack_size, g_thread_win32_proxy, thread,
 467                                             CREATE_SUSPENDED, &ignore);
 468
 469   if (thread->handle == NULL)
 470     {
 471       message = "Error creating thread";
 472       goto error;
 473     }
 474
 475   /* For thread priority inheritance we need to manually set the thread
 476    * priority of the new thread to the priority of the current thread. We
 477    * also have to start the thread suspended and resume it after actually
 478    * setting the priority here.
 479    *
 480    * On Windows, by default all new threads are created with NORMAL thread
 481    * priority.
 482    */
 483
 484   if (scheduler_settings)
 485     {
 486       thread_prio = scheduler_settings->thread_prio;
 487     }
 488   else
 489     {
 490       HANDLE current_thread = GetCurrentThread ();
 491       thread_prio = GetThreadPriority (current_thread);
 492     }
 493
 494   if (thread_prio == THREAD_PRIORITY_ERROR_RETURN)
 495     {
 496       message = "Error getting current thread priority";
 497       goto error;
 498     }
 499
 500   if (SetThreadPriority (thread->handle, thread_prio) == 0)
 501     {
 502       message = "Error setting new thread priority";
 503       goto error;
 504     }
 505
 506   if (ResumeThread (thread->handle) == -1)
 507     {
 508       message = "Error resuming new thread";
 509       goto error;
 510     }
 511
 512   return (GRealThread *) thread;
 513
 514 error:
 515   {
 516     gchar *win_error = g_win32_error_message (GetLastError ());
 517     g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
 518                  "%s: %s", message, win_error);
 519     g_free (win_error);
 520     if (thread->handle)
 521       CloseHandle (thread->handle);
 522     g_slice_free (GThreadWin32, thread);
 523     return NULL;
 524   }
 525 }
 526
 527 void
 528 g_thread_yield (void)
 529 {
 530   Sleep(0);
 531 }
 532
 533 void
 534 g_system_thread_wait (GRealThread *thread)
 535 {
 536   GThreadWin32 *wt = (GThreadWin32 *) thread;
 537
 538   win32_check_for_error (WAIT_FAILED != WaitForSingleObject (wt->handle, INFINITE));
 539 }
 540
 541 #define EXCEPTION_SET_THREAD_NAME ((DWORD) 0x406D1388)
 542
 543 #ifndef _MSC_VER
 544 static void *SetThreadName_VEH_handle = NULL;
 545
 546 static LONG __stdcall
 547 SetThreadName_VEH (PEXCEPTION_POINTERS ExceptionInfo)
 548 {
 549   if (ExceptionInfo->ExceptionRecord != NULL &&
 550       ExceptionInfo->ExceptionRecord->ExceptionCode == EXCEPTION_SET_THREAD_NAME)
 551     return EXCEPTION_CONTINUE_EXECUTION;
 552
 553   return EXCEPTION_CONTINUE_SEARCH;
 554 }
 555 #endif
 556
 557 typedef struct _THREADNAME_INFO
 558 {
 559   DWORD  dwType;        /* must be 0x1000 */
 560   LPCSTR szName;        /* pointer to name (in user addr space) */
 561   DWORD  dwThreadID;    /* thread ID (-1=caller thread) */
 562   DWORD  dwFlags;       /* reserved for future use, must be zero */
 563 } THREADNAME_INFO;
 564
 565 static void
 566 SetThreadName (DWORD  dwThreadID,
 567                LPCSTR szThreadName)
 568 {
 569    THREADNAME_INFO info;
 570    DWORD infosize;
 571
 572    info.dwType = 0x1000;
 573    info.szName = szThreadName;
 574    info.dwThreadID = dwThreadID;
 575    info.dwFlags = 0;
 576
 577    infosize = sizeof (info) / sizeof (DWORD);
 578
 579 #ifdef _MSC_VER
 580    __try
 581      {
 582        RaiseException (EXCEPTION_SET_THREAD_NAME, 0, infosize, (DWORD *) &info);
 583      }
 584    __except (EXCEPTION_EXECUTE_HANDLER)
 585      {
 586      }
 587 #else
 588    /* Without a debugger we *must* have an exception handler,
 589     * otherwise raising an exception will crash the process.
 590     */
 591    if ((!IsDebuggerPresent ()) && (SetThreadName_VEH_handle == NULL))
 592      return;
 593
 594    RaiseException (EXCEPTION_SET_THREAD_NAME, 0, infosize, (DWORD *) &info);
 595 #endif
 596 }
 597
 598 void
 599 g_system_thread_set_name (const gchar *name)
 600 {
 601   SetThreadName ((DWORD) -1, name);
 602 }
 603
 604 /* {{{1 Epilogue */
 605
 606 void
 607 g_thread_win32_init (void)
 608 {
 609   InitializeCriticalSection (&g_private_lock);
 610
 611 #ifndef _MSC_VER
 612   SetThreadName_VEH_handle = AddVectoredExceptionHandler (1, &SetThreadName_VEH);
 613   if (SetThreadName_VEH_handle == NULL)
 614     {
 615       /* This is bad, but what can we do? */
 616     }
 617 #endif
 618 }
 619
 620 void
 621 g_thread_win32_thread_detach (void)
 622 {
 623   gboolean dtors_called;
 624
 625   do
 626     {
 627       GPrivateDestructor *dtor;
 628
 629       /* We go by the POSIX book on this one.
 630        *
 631        * If we call a destructor then there is a chance that some new
 632        * TLS variables got set by code called in that destructor.
 633        *
 634        * Loop until nothing is left.
 635        */
 636       dtors_called = FALSE;
 637
 638       for (dtor = g_private_destructors; dtor; dtor = dtor->next)
 639         {
 640           gpointer value;
 641
 642           value = TlsGetValue (dtor->index);
 643           if (value != NULL && dtor->notify != NULL)
 644             {
 645               /* POSIX says to clear this before the call */
 646               TlsSetValue (dtor->index, NULL);
 647               dtor->notify (value);
 648               dtors_called = TRUE;
 649             }
 650         }
 651     }
 652   while (dtors_called);
 653 }
 654
 655 void
 656 g_thread_win32_process_detach (void)
 657 {
 658 #ifndef _MSC_VER
 659   if (SetThreadName_VEH_handle != NULL)
 660     {
 661       RemoveVectoredExceptionHandler (SetThreadName_VEH_handle);
 662       SetThreadName_VEH_handle = NULL;
 663     }
 664 #endif
 665 }
 666
 667 /* vim:set foldmethod=marker: */