gcc/config/i386/gthr-win32.c

   1 /* Implementation of W32-specific threads compatibility routines for
   2    libgcc2.  */
   3
   4 /* Copyright (C) 1999, 2000, 2002, 2004 Free Software Foundation, Inc.
   5    Contributed by Mumit Khan <khan@xraylith.wisc.edu>.
   6    Modified and moved to separate file by Danny Smith
   7    <dannysmith@users.sourceforge.net>.
   8
   9 This file is part of GCC.
  10
  11 GCC is free software; you can redistribute it and/or modify it under
  12 the terms of the GNU General Public License as published by the Free
  13 Software Foundation; either version 2, or (at your option) any later
  14 version.
  15
  16 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  17 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 for more details.
  20
  21 You should have received a copy of the GNU General Public License
  22 along with GCC; see the file COPYING.  If not, write to the Free
  23 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  24 02111-1307, USA.  */
  25
  26 /* As a special exception, if you link this library with other files,
  27    some of which are compiled with GCC, to produce an executable,
  28    this library does not by itself cause the resulting executable
  29    to be covered by the GNU General Public License.
  30    This exception does not however invalidate any other reasons why
  31    the executable file might be covered by the GNU General Public License.  */
  32
  33
  34 #ifndef __GTHREAD_HIDE_WIN32API
  35 # define __GTHREAD_HIDE_WIN32API 1
  36 #endif
  37 #include <gthr-win32.h>
  38 #include <windows.h>
  39
  40 /* Windows32 threads specific definitions. The windows32 threading model
  41    does not map well into pthread-inspired gcc's threading model, and so
  42    there are caveats one needs to be aware of.
  43
  44    1. The destructor supplied to __gthread_key_create is ignored for
  45       generic x86-win32 ports. This will certainly cause memory leaks
  46       due to unreclaimed eh contexts (sizeof (eh_context) is at least
  47       24 bytes for x86 currently).
  48
  49       This memory leak may be significant for long-running applications
  50       that make heavy use of C++ EH.
  51
  52       However, Mingw runtime (version 0.3 or newer) provides a mechanism
  53       to emulate pthreads key dtors; the runtime provides a special DLL,
  54       linked in if -mthreads option is specified, that runs the dtors in
  55       the reverse order of registration when each thread exits. If
  56       -mthreads option is not given, a stub is linked in instead of the
  57       DLL, which results in memory leak. Other x86-win32 ports can use
  58       the same technique of course to avoid the leak.
  59
  60    2. The error codes returned are non-POSIX like, and cast into ints.
  61       This may cause incorrect error return due to truncation values on
  62       hw where sizeof (DWORD) > sizeof (int).
  63
  64    3. We are currently using a special mutex instead of the Critical
  65       Sections, since Win9x does not support TryEnterCriticalSection
  66       (while NT does).
  67
  68    The basic framework should work well enough. In the long term, GCC
  69    needs to use Structured Exception Handling on Windows32.  */
  70
  71 int
  72 __gthr_win32_once (__gthread_once_t *once, void (*func) (void))
  73 {
  74   if (once == NULL || func == NULL)
  75     return EINVAL;
  76
  77   if (! once->done)
  78     {
  79       if (InterlockedIncrement (&(once->started)) == 0)
  80         {
  81           (*func) ();
  82           once->done = TRUE;
  83         }
  84       else
  85         {
  86           /* Another thread is currently executing the code, so wait for it
  87              to finish; yield the CPU in the meantime.  If performance
  88              does become an issue, the solution is to use an Event that
  89              we wait on here (and set above), but that implies a place to
  90              create the event before this routine is called.  */
  91           while (! once->done)
  92             Sleep (0);
  93         }
  94     }
  95   return 0;
  96 }
  97
  98 /* Windows32 thread local keys don't support destructors; this leads to
  99    leaks, especially in threaded applications making extensive use of
 100    C++ EH. Mingw uses a thread-support DLL to work-around this problem.  */
 101
 102 int
 103 __gthr_win32_key_create (__gthread_key_t *key, void (*dtor) (void *))
 104 {
 105   int status = 0;
 106   DWORD tls_index = TlsAlloc ();
 107   if (tls_index != 0xFFFFFFFF)
 108     {
 109       *key = tls_index;
 110 #ifdef MINGW32_SUPPORTS_MT_EH
 111       /* Mingw runtime will run the dtors in reverse order for each thread
 112          when the thread exits.  */
 113       status = __mingwthr_key_dtor (*key, dtor);
 114 #endif
 115     }
 116   else
 117     status = (int) GetLastError ();
 118   return status;
 119 }
 120
 121 int
 122 __gthr_win32_key_delete (__gthread_key_t key)
 123 {
 124   return (TlsFree (key) != 0) ? 0 : (int) GetLastError ();
 125 }
 126
 127 void *
 128 __gthr_win32_getspecific (__gthread_key_t key)
 129 {
 130   DWORD lasterror;
 131   void *ptr;
 132   lasterror = GetLastError();
 133   ptr = TlsGetValue(key);
 134   SetLastError( lasterror );
 135   return ptr;
 136 }
 137
 138 int
 139 __gthr_win32_setspecific (__gthread_key_t key, const void *ptr)
 140 {
 141   return (TlsSetValue (key, (void*) ptr) != 0) ? 0 : (int) GetLastError ();
 142 }
 143
 144 void
 145 __gthr_win32_mutex_init_function (__gthread_mutex_t *mutex)
 146 {
 147   mutex->counter = 0;
 148   mutex->sema = CreateSemaphore (NULL, 0, 65535, NULL);
 149 }
 150
 151 int
 152 __gthr_win32_mutex_lock (__gthread_mutex_t *mutex)
 153 {
 154   if (InterlockedIncrement (&mutex->counter) == 1 ||
 155       WaitForSingleObject (mutex->sema, INFINITE) == WAIT_OBJECT_0)
 156     return 0;
 157   else
 158     {
 159       // WaitForSingleObject returns WAIT_FAILED, and we can only do
 160       // some best-effort cleanup here.
 161       InterlockedDecrement (&mutex->counter);
 162       return 1;
 163     }
 164 }
 165
 166 int
 167 __gthr_win32_mutex_trylock (__gthread_mutex_t *mutex)
 168 {
 169   if (InterlockedCompareExchange (&mutex->counter, 1, 0 ) == 0)
 170     return 0;
 171   else
 172     return 1;
 173 }
 174
 175 int
 176 __gthr_win32_mutex_unlock (__gthread_mutex_t *mutex)
 177 {
 178   if (InterlockedDecrement (&mutex->counter))
 179     return ReleaseSemaphore (mutex->sema, 1, NULL) ? 0 : 1;
 180   else
 181     return 0;
 182 }