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 *g_private_destructors;  /* (atomic) prepend-only */
 305 static CRITICAL_SECTION g_private_lock;
 306
 307 static DWORD
 308 g_private_get_impl (GPrivate *key)
 309 {
 310   DWORD impl = (DWORD) GPOINTER_TO_UINT(key->p);
 311
 312   if G_UNLIKELY (impl == 0)
 313     {
 314       EnterCriticalSection (&g_private_lock);
 315       impl = (UINT_PTR) key->p;
 316       if (impl == 0)
 317         {
 318           GPrivateDestructor *destructor;
 319
 320           impl = TlsAlloc ();
 321
 322           if G_UNLIKELY (impl == 0)
 323             {
 324               /* Ignore TLS index 0 temporarily (as 0 is the indicator that we
 325                * haven't allocated TLS yet) and alloc again;
 326                * See https://gitlab.gnome.org/GNOME/glib/-/issues/2058 */
 327               DWORD impl2 = TlsAlloc ();
 328               TlsFree (impl);
 329               impl = impl2;
 330             }
 331
 332           if (impl == TLS_OUT_OF_INDEXES || impl == 0)
 333             g_thread_abort (0, "TlsAlloc");
 334
 335           if (key->notify != NULL)
 336             {
 337               destructor = malloc (sizeof (GPrivateDestructor));
 338               if G_UNLIKELY (destructor == NULL)
 339                 g_thread_abort (errno, "malloc");
 340               destructor->index = impl;
 341               destructor->notify = key->notify;
 342               destructor->next = g_atomic_pointer_get (&g_private_destructors);
 343
 344               /* We need to do an atomic store due to the unlocked
 345                * access to the destructor list from the thread exit
 346                * function.
 347                *
 348                * It can double as a sanity check...
 349                */
 350               if (!g_atomic_pointer_compare_and_exchange (&g_private_destructors,
 351                                                           destructor->next,
 352                                                           destructor))
 353                 g_thread_abort (0, "g_private_get_impl(1)");
 354             }
 355
 356           /* Ditto, due to the unlocked access on the fast path */
 357           if (!g_atomic_pointer_compare_and_exchange (&key->p, NULL, impl))
 358             g_thread_abort (0, "g_private_get_impl(2)");
 359         }
 360       LeaveCriticalSection (&g_private_lock);
 361     }
 362
 363   return impl;
 364 }
 365
 366 gpointer
 367 g_private_get (GPrivate *key)
 368 {
 369   return TlsGetValue (g_private_get_impl (key));
 370 }
 371
 372 void
 373 g_private_set (GPrivate *key,
 374                gpointer  value)
 375 {
 376   TlsSetValue (g_private_get_impl (key), value);
 377 }
 378
 379 void
 380 g_private_replace (GPrivate *key,
 381                    gpointer  value)
 382 {
 383   DWORD impl = g_private_get_impl (key);
 384   gpointer old;
 385
 386   old = TlsGetValue (impl);
 387   TlsSetValue (impl, value);
 388   if (old && key->notify)
 389     key->notify (old);
 390 }
 391
 392 /* {{{1 GThread */
 393
 394 #define win32_check_for_error(what) G_STMT_START{                       \
 395   if (!(what))                                                          \
 396     g_error ("file %s: line %d (%s): error %s during %s",               \
 397              __FILE__, __LINE__, G_STRFUNC,                             \
 398              g_win32_error_message (GetLastError ()), #what);           \
 399   }G_STMT_END
 400
 401 #define G_MUTEX_SIZE (sizeof (gpointer))
 402
 403 typedef BOOL (__stdcall *GTryEnterCriticalSectionFunc) (CRITICAL_SECTION *);
 404
 405 typedef struct
 406 {
 407   GRealThread thread;
 408
 409   GThreadFunc proxy;
 410   HANDLE      handle;
 411 } GThreadWin32;
 412
 413 void
 414 g_system_thread_free (GRealThread *thread)
 415 {
 416   GThreadWin32 *wt = (GThreadWin32 *) thread;
 417
 418   win32_check_for_error (CloseHandle (wt->handle));
 419   g_slice_free (GThreadWin32, wt);
 420 }
 421
 422 void
 423 g_system_thread_exit (void)
 424 {
 425   _endthreadex (0);
 426 }
 427
 428 static guint __stdcall
 429 g_thread_win32_proxy (gpointer data)
 430 {
 431   GThreadWin32 *self = data;
 432
 433   self->proxy (self);
 434
 435   g_system_thread_exit ();
 436
 437   g_assert_not_reached ();
 438
 439   return 0;
 440 }
 441
 442 gboolean
 443 g_system_thread_get_scheduler_settings (GThreadSchedulerSettings *scheduler_settings)
 444 {
 445   HANDLE current_thread = GetCurrentThread ();
 446   scheduler_settings->thread_prio = GetThreadPriority (current_thread);
 447
 448   return TRUE;
 449 }
 450
 451 GRealThread *
 452 g_system_thread_new (GThreadFunc proxy,
 453                      gulong stack_size,
 454                      const GThreadSchedulerSettings *scheduler_settings,
 455                      const char *name,
 456                      GThreadFunc func,
 457                      gpointer data,
 458                      GError **error)
 459 {
 460   GThreadWin32 *thread;
 461   GRealThread *base_thread;
 462   guint ignore;
 463   const gchar *message = NULL;
 464   int thread_prio;
 465
 466   thread = g_slice_new0 (GThreadWin32);
 467   thread->proxy = proxy;
 468   thread->handle = (HANDLE) NULL;
 469   base_thread = (GRealThread*)thread;
 470   base_thread->ref_count = 2;
 471   base_thread->ours = TRUE;
 472   base_thread->thread.joinable = TRUE;
 473   base_thread->thread.func = func;
 474   base_thread->thread.data = data;
 475   base_thread->name = g_strdup (name);
 476
 477   thread->handle = (HANDLE) _beginthreadex (NULL, stack_size, g_thread_win32_proxy, thread,
 478                                             CREATE_SUSPENDED, &ignore);
 479
 480   if (thread->handle == NULL)
 481     {
 482       message = "Error creating thread";
 483       goto error;
 484     }
 485
 486   /* For thread priority inheritance we need to manually set the thread
 487    * priority of the new thread to the priority of the current thread. We
 488    * also have to start the thread suspended and resume it after actually
 489    * setting the priority here.
 490    *
 491    * On Windows, by default all new threads are created with NORMAL thread
 492    * priority.
 493    */
 494
 495   if (scheduler_settings)
 496     {
 497       thread_prio = scheduler_settings->thread_prio;
 498     }
 499   else
 500     {
 501       HANDLE current_thread = GetCurrentThread ();
 502       thread_prio = GetThreadPriority (current_thread);
 503     }
 504
 505   if (thread_prio == THREAD_PRIORITY_ERROR_RETURN)
 506     {
 507       message = "Error getting current thread priority";
 508       goto error;
 509     }
 510
 511   if (SetThreadPriority (thread->handle, thread_prio) == 0)
 512     {
 513       message = "Error setting new thread priority";
 514       goto error;
 515     }
 516
 517   if (ResumeThread (thread->handle) == -1)
 518     {
 519       message = "Error resuming new thread";
 520       goto error;
 521     }
 522
 523   return (GRealThread *) thread;
 524
 525 error:
 526   {
 527     gchar *win_error = g_win32_error_message (GetLastError ());
 528     g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
 529                  "%s: %s", message, win_error);
 530     g_free (win_error);
 531     if (thread->handle)
 532       CloseHandle (thread->handle);
 533     g_slice_free (GThreadWin32, thread);
 534     return NULL;
 535   }
 536 }
 537
 538 void
 539 g_thread_yield (void)
 540 {
 541   Sleep(0);
 542 }
 543
 544 void
 545 g_system_thread_wait (GRealThread *thread)
 546 {
 547   GThreadWin32 *wt = (GThreadWin32 *) thread;
 548
 549   win32_check_for_error (WAIT_FAILED != WaitForSingleObject (wt->handle, INFINITE));
 550 }
 551
 552 #define EXCEPTION_SET_THREAD_NAME ((DWORD) 0x406D1388)
 553
 554 #ifndef _MSC_VER
 555 static void *SetThreadName_VEH_handle = NULL;
 556
 557 static LONG __stdcall
 558 SetThreadName_VEH (PEXCEPTION_POINTERS ExceptionInfo)
 559 {
 560   if (ExceptionInfo->ExceptionRecord != NULL &&
 561       ExceptionInfo->ExceptionRecord->ExceptionCode == EXCEPTION_SET_THREAD_NAME)
 562     return EXCEPTION_CONTINUE_EXECUTION;
 563
 564   return EXCEPTION_CONTINUE_SEARCH;
 565 }
 566 #endif
 567
 568 typedef struct _THREADNAME_INFO
 569 {
 570   DWORD  dwType;        /* must be 0x1000 */
 571   LPCSTR szName;        /* pointer to name (in user addr space) */
 572   DWORD  dwThreadID;    /* thread ID (-1=caller thread) */
 573   DWORD  dwFlags;       /* reserved for future use, must be zero */
 574 } THREADNAME_INFO;
 575
 576 static void
 577 SetThreadName (DWORD  dwThreadID,
 578                LPCSTR szThreadName)
 579 {
 580    THREADNAME_INFO info;
 581    DWORD infosize;
 582
 583    info.dwType = 0x1000;
 584    info.szName = szThreadName;
 585    info.dwThreadID = dwThreadID;
 586    info.dwFlags = 0;
 587
 588    infosize = sizeof (info) / sizeof (DWORD);
 589
 590 #ifdef _MSC_VER
 591    __try
 592      {
 593        RaiseException (EXCEPTION_SET_THREAD_NAME, 0, infosize,
 594                        (const ULONG_PTR *) &info);
 595      }
 596    __except (EXCEPTION_EXECUTE_HANDLER)
 597      {
 598      }
 599 #else
 600    /* Without a debugger we *must* have an exception handler,
 601     * otherwise raising an exception will crash the process.
 602     */
 603    if ((!IsDebuggerPresent ()) && (SetThreadName_VEH_handle == NULL))
 604      return;
 605
 606    RaiseException (EXCEPTION_SET_THREAD_NAME, 0, infosize, (const ULONG_PTR *) &info);
 607 #endif
 608 }
 609
 610 typedef HRESULT (WINAPI *pSetThreadDescription) (HANDLE hThread,
 611                                                  PCWSTR lpThreadDescription);
 612 static pSetThreadDescription SetThreadDescriptionFunc = NULL;
 613 HMODULE kernel32_module = NULL;
 614
 615 static gboolean
 616 g_thread_win32_load_library (void)
 617 {
 618   /* FIXME: Add support for UWP app */
 619 #if !defined(G_WINAPI_ONLY_APP)
 620   static gsize _init_once = 0;
 621   if (g_once_init_enter (&_init_once))
 622     {
 623       kernel32_module = LoadLibraryW (L"kernel32.dll");
 624       if (kernel32_module)
 625         {
 626           SetThreadDescriptionFunc =
 627               (pSetThreadDescription) GetProcAddress (kernel32_module,
 628                                                       "SetThreadDescription");
 629           if (!SetThreadDescriptionFunc)
 630             FreeLibrary (kernel32_module);
 631         }
 632       g_once_init_leave (&_init_once, 1);
 633     }
 634 #endif
 635
 636   return !!SetThreadDescriptionFunc;
 637 }
 638
 639 static gboolean
 640 g_thread_win32_set_thread_desc (const gchar *name)
 641 {
 642   HRESULT hr;
 643   wchar_t *namew;
 644
 645   if (!g_thread_win32_load_library () || !name)
 646     return FALSE;
 647
 648   namew = g_utf8_to_utf16 (name, -1, NULL, NULL, NULL);
 649   if (!namew)
 650     return FALSE;
 651
 652   hr = SetThreadDescriptionFunc (GetCurrentThread (), namew);
 653
 654   g_free (namew);
 655   return SUCCEEDED (hr);
 656 }
 657
 658 void
 659 g_system_thread_set_name (const gchar *name)
 660 {
 661   /* Prefer SetThreadDescription over exception based way if available,
 662    * since thread description set by SetThreadDescription will be preserved
 663    * in dump file */
 664   if (!g_thread_win32_set_thread_desc (name))
 665     SetThreadName ((DWORD) -1, name);
 666 }
 667
 668 /* {{{1 Epilogue */
 669
 670 void
 671 g_thread_win32_init (void)
 672 {
 673   InitializeCriticalSection (&g_private_lock);
 674
 675 #ifndef _MSC_VER
 676   SetThreadName_VEH_handle = AddVectoredExceptionHandler (1, &SetThreadName_VEH);
 677   if (SetThreadName_VEH_handle == NULL)
 678     {
 679       /* This is bad, but what can we do? */
 680     }
 681 #endif
 682 }
 683
 684 void
 685 g_thread_win32_thread_detach (void)
 686 {
 687   gboolean dtors_called;
 688
 689   do
 690     {
 691       GPrivateDestructor *dtor;
 692
 693       /* We go by the POSIX book on this one.
 694        *
 695        * If we call a destructor then there is a chance that some new
 696        * TLS variables got set by code called in that destructor.
 697        *
 698        * Loop until nothing is left.
 699        */
 700       dtors_called = FALSE;
 701
 702       for (dtor = g_atomic_pointer_get (&g_private_destructors); dtor; dtor = dtor->next)
 703         {
 704           gpointer value;
 705
 706           value = TlsGetValue (dtor->index);
 707           if (value != NULL && dtor->notify != NULL)
 708             {
 709               /* POSIX says to clear this before the call */
 710               TlsSetValue (dtor->index, NULL);
 711               dtor->notify (value);
 712               dtors_called = TRUE;
 713             }
 714         }
 715     }
 716   while (dtors_called);
 717 }
 718
 719 void
 720 g_thread_win32_process_detach (void)
 721 {
 722 #ifndef _MSC_VER
 723   if (SetThreadName_VEH_handle != NULL)
 724     {
 725       RemoveVectoredExceptionHandler (SetThreadName_VEH_handle);
 726       SetThreadName_VEH_handle = NULL;
 727     }
 728 #endif
 729 }
 730
 731 /* vim:set foldmethod=marker: */