Unreviewed, roll out http://trac.webkit.org/changeset/187972.
[WebKit-https.git] / Source / WTF / wtf / ThreadingWin.cpp
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  * Copyright (C) 2009 Torch Mobile, Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 /*
32  * There are numerous academic and practical works on how to implement pthread_cond_wait/pthread_cond_signal/pthread_cond_broadcast
33  * functions on Win32. Here is one example: http://www.cs.wustl.edu/~schmidt/win32-cv-1.html which is widely credited as a 'starting point'
34  * of modern attempts. There are several more or less proven implementations, one in Boost C++ library (http://www.boost.org) and another
35  * in pthreads-win32 (http://sourceware.org/pthreads-win32/).
36  *
37  * The number of articles and discussions is the evidence of significant difficulties in implementing these primitives correctly.
38  * The brief search of revisions, ChangeLog entries, discussions in comp.programming.threads and other places clearly documents
39  * numerous pitfalls and performance problems the authors had to overcome to arrive to the suitable implementations.
40  * Optimally, WebKit would use one of those supported/tested libraries directly. To roll out our own implementation is impractical,
41  * if even for the lack of sufficient testing. However, a faithful reproduction of the code from one of the popular supported
42  * libraries seems to be a good compromise.
43  *
44  * The early Boost implementation (http://www.boxbackup.org/trac/browser/box/nick/win/lib/win32/boost_1_32_0/libs/thread/src/condition.cpp?rev=30)
45  * is identical to pthreads-win32 (http://sourceware.org/cgi-bin/cvsweb.cgi/pthreads/pthread_cond_wait.c?rev=1.10&content-type=text/x-cvsweb-markup&cvsroot=pthreads-win32).
46  * Current Boost uses yet another (although seemingly equivalent) algorithm which came from their 'thread rewrite' effort.
47  *
48  * This file includes timedWait/signal/broadcast implementations translated to WebKit coding style from the latest algorithm by
49  * Alexander Terekhov and Louis Thomas, as captured here: http://sourceware.org/cgi-bin/cvsweb.cgi/pthreads/pthread_cond_wait.c?rev=1.10&content-type=text/x-cvsweb-markup&cvsroot=pthreads-win32
50  * It replaces the implementation of their previous algorithm, also documented in the same source above.
51  * The naming and comments are left very close to original to enable easy cross-check.
52  *
53  * The corresponding Pthreads-win32 License is included below, and CONTRIBUTORS file which it refers to is added to
54  * source directory (as CONTRIBUTORS.pthreads-win32).
55  */
56
57 /*
58  *      Pthreads-win32 - POSIX Threads Library for Win32
59  *      Copyright(C) 1998 John E. Bossom
60  *      Copyright(C) 1999,2005 Pthreads-win32 contributors
61  *
62  *      Contact Email: rpj@callisto.canberra.edu.au
63  *
64  *      The current list of contributors is contained
65  *      in the file CONTRIBUTORS included with the source
66  *      code distribution. The list can also be seen at the
67  *      following World Wide Web location:
68  *      http://sources.redhat.com/pthreads-win32/contributors.html
69  *
70  *      This library is free software; you can redistribute it and/or
71  *      modify it under the terms of the GNU Lesser General Public
72  *      License as published by the Free Software Foundation; either
73  *      version 2 of the License, or (at your option) any later version.
74  *
75  *      This library is distributed in the hope that it will be useful,
76  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
77  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
78  *      Lesser General Public License for more details.
79  *
80  *      You should have received a copy of the GNU Lesser General Public
81  *      License along with this library in the file COPYING.LIB;
82  *      if not, write to the Free Software Foundation, Inc.,
83  *      59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
84  */
85
86 #include "config.h"
87 #include "Threading.h"
88
89 #if OS(WINDOWS)
90
91 #include "DateMath.h"
92 #include "dtoa.h"
93 #include "dtoa/cached-powers.h"
94
95 #include "MainThread.h"
96 #include "ThreadFunctionInvocation.h"
97 #include <process.h>
98 #include <windows.h>
99 #include <wtf/CurrentTime.h>
100 #include <wtf/HashMap.h>
101 #include <wtf/MathExtras.h>
102 #include <wtf/RandomNumberSeed.h>
103 #include <wtf/WTFThreadData.h>
104
105 #if !USE(PTHREADS) && OS(WINDOWS)
106 #include "ThreadSpecific.h"
107 #endif
108
109 #if HAVE(ERRNO_H)
110 #include <errno.h>
111 #endif
112
113 namespace WTF {
114
115 // MS_VC_EXCEPTION, THREADNAME_INFO, and setThreadNameInternal all come from <http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx>.
116 static const DWORD MS_VC_EXCEPTION = 0x406D1388;
117
118 #pragma pack(push, 8)
119 typedef struct tagTHREADNAME_INFO {
120     DWORD dwType; // must be 0x1000
121     LPCSTR szName; // pointer to name (in user addr space)
122     DWORD dwThreadID; // thread ID (-1=caller thread)
123     DWORD dwFlags; // reserved for future use, must be zero
124 } THREADNAME_INFO;
125 #pragma pack(pop)
126
127 void initializeCurrentThreadInternal(const char* szThreadName)
128 {
129 #if COMPILER(MINGW)
130     // FIXME: Implement thread name setting with MingW.
131     UNUSED_PARAM(szThreadName);
132 #else
133     THREADNAME_INFO info;
134     info.dwType = 0x1000;
135     info.szName = szThreadName;
136     info.dwThreadID = GetCurrentThreadId();
137     info.dwFlags = 0;
138
139     __try {
140         RaiseException(MS_VC_EXCEPTION, 0, sizeof(info)/sizeof(ULONG_PTR), reinterpret_cast<ULONG_PTR*>(&info));
141     } __except (EXCEPTION_CONTINUE_EXECUTION) {
142     }
143 #endif
144 }
145
146 static Mutex& threadMapMutex()
147 {
148     static Mutex mutex;
149     return mutex;
150 }
151
152 void initializeThreading()
153 {
154     static bool isInitialized;
155     
156     if (isInitialized)
157         return;
158
159     isInitialized = true;
160
161     WTF::double_conversion::initialize();
162     // StringImpl::empty() does not construct its static string in a threadsafe fashion,
163     // so ensure it has been initialized from here.
164     StringImpl::empty();
165     threadMapMutex();
166     initializeRandomNumberGenerator();
167     wtfThreadData();
168     s_dtoaP5Mutex = new Mutex;
169     initializeDates();
170 }
171
172 static HashMap<DWORD, HANDLE>& threadMap()
173 {
174     static HashMap<DWORD, HANDLE> map;
175     return map;
176 }
177
178 static void storeThreadHandleByIdentifier(DWORD threadID, HANDLE threadHandle)
179 {
180     MutexLocker locker(threadMapMutex());
181     ASSERT(!threadMap().contains(threadID));
182     threadMap().add(threadID, threadHandle);
183 }
184
185 static HANDLE threadHandleForIdentifier(ThreadIdentifier id)
186 {
187     MutexLocker locker(threadMapMutex());
188     return threadMap().get(id);
189 }
190
191 static void clearThreadHandleForIdentifier(ThreadIdentifier id)
192 {
193     MutexLocker locker(threadMapMutex());
194     ASSERT(threadMap().contains(id));
195     threadMap().remove(id);
196 }
197
198 static unsigned __stdcall wtfThreadEntryPoint(void* param)
199 {
200     std::unique_ptr<ThreadFunctionInvocation> invocation(static_cast<ThreadFunctionInvocation*>(param));
201     invocation->function(invocation->data);
202
203 #if !USE(PTHREADS) && OS(WINDOWS)
204     // Do the TLS cleanup.
205     ThreadSpecificThreadExit();
206 #endif
207
208     return 0;
209 }
210
211 ThreadIdentifier createThreadInternal(ThreadFunction entryPoint, void* data, const char* threadName)
212 {
213     unsigned threadIdentifier = 0;
214     ThreadIdentifier threadID = 0;
215     auto invocation = std::make_unique<ThreadFunctionInvocation>(entryPoint, data);
216     HANDLE threadHandle = reinterpret_cast<HANDLE>(_beginthreadex(0, 0, wtfThreadEntryPoint, invocation.get(), 0, &threadIdentifier));
217     if (!threadHandle) {
218 #if !HAVE(ERRNO_H)
219         LOG_ERROR("Failed to create thread at entry point %p with data %p.", entryPoint, data);
220 #else
221         LOG_ERROR("Failed to create thread at entry point %p with data %p: %ld", entryPoint, data, errno);
222 #endif
223         return 0;
224     }
225
226     // The thread will take ownership of invocation.
227     ThreadFunctionInvocation* leakedInvocation = invocation.release();
228     UNUSED_PARAM(leakedInvocation);
229
230     threadID = static_cast<ThreadIdentifier>(threadIdentifier);
231     storeThreadHandleByIdentifier(threadIdentifier, threadHandle);
232
233     return threadID;
234 }
235
236 void changeThreadPriority(ThreadIdentifier threadID, int delta)
237 {
238     ASSERT(threadID);
239
240     HANDLE threadHandle = threadHandleForIdentifier(threadID);
241     if (!threadHandle)
242         LOG_ERROR("ThreadIdentifier %u does not correspond to an active thread", threadID);
243
244     SetThreadPriority(threadHandle, THREAD_PRIORITY_NORMAL + delta);
245 }
246
247 int waitForThreadCompletion(ThreadIdentifier threadID)
248 {
249     ASSERT(threadID);
250     
251     HANDLE threadHandle = threadHandleForIdentifier(threadID);
252     if (!threadHandle)
253         LOG_ERROR("ThreadIdentifier %u did not correspond to an active thread when trying to quit", threadID);
254  
255     DWORD joinResult = WaitForSingleObject(threadHandle, INFINITE);
256     if (joinResult == WAIT_FAILED)
257         LOG_ERROR("ThreadIdentifier %u was found to be deadlocked trying to quit", threadID);
258
259     CloseHandle(threadHandle);
260     clearThreadHandleForIdentifier(threadID);
261
262     return joinResult;
263 }
264
265 void detachThread(ThreadIdentifier threadID)
266 {
267     ASSERT(threadID);
268
269     HANDLE threadHandle = threadHandleForIdentifier(threadID);
270     if (threadHandle)
271         CloseHandle(threadHandle);
272     clearThreadHandleForIdentifier(threadID);
273 }
274
275 ThreadIdentifier currentThread()
276 {
277     return static_cast<ThreadIdentifier>(GetCurrentThreadId());
278 }
279
280 Mutex::Mutex()
281 {
282     m_mutex.m_recursionCount = 0;
283     InitializeCriticalSection(&m_mutex.m_internalMutex);
284 }
285
286 Mutex::~Mutex()
287 {
288     DeleteCriticalSection(&m_mutex.m_internalMutex);
289 }
290
291 void Mutex::lock()
292 {
293     EnterCriticalSection(&m_mutex.m_internalMutex);
294     ++m_mutex.m_recursionCount;
295 }
296     
297 #pragma warning(suppress: 26115)
298 bool Mutex::tryLock()
299 {
300     // This method is modeled after the behavior of pthread_mutex_trylock,
301     // which will return an error if the lock is already owned by the
302     // current thread.  Since the primitive Win32 'TryEnterCriticalSection'
303     // treats this as a successful case, it changes the behavior of several
304     // tests in WebKit that check to see if the current thread already
305     // owned this mutex (see e.g., IconDatabase::getOrCreateIconRecord)
306     DWORD result = TryEnterCriticalSection(&m_mutex.m_internalMutex);
307     
308     if (result != 0) {       // We got the lock
309         // If this thread already had the lock, we must unlock and
310         // return false so that we mimic the behavior of POSIX's
311         // pthread_mutex_trylock:
312         if (m_mutex.m_recursionCount > 0) {
313             LeaveCriticalSection(&m_mutex.m_internalMutex);
314             return false;
315         }
316
317         ++m_mutex.m_recursionCount;
318         return true;
319     }
320
321     return false;
322 }
323
324 void Mutex::unlock()
325 {
326     ASSERT(m_mutex.m_recursionCount);
327     --m_mutex.m_recursionCount;
328     LeaveCriticalSection(&m_mutex.m_internalMutex);
329 }
330
331 bool PlatformCondition::timedWait(PlatformMutex& mutex, DWORD durationMilliseconds)
332 {
333     // Enter the wait state.
334     DWORD res = WaitForSingleObject(m_blockLock, INFINITE);
335     ASSERT_UNUSED(res, res == WAIT_OBJECT_0);
336     ++m_waitersBlocked;
337     res = ReleaseSemaphore(m_blockLock, 1, 0);
338     ASSERT_UNUSED(res, res);
339
340     --mutex.m_recursionCount;
341     LeaveCriticalSection(&mutex.m_internalMutex);
342
343     // Main wait - use timeout.
344     bool timedOut = (WaitForSingleObject(m_blockQueue, durationMilliseconds) == WAIT_TIMEOUT);
345
346     res = WaitForSingleObject(m_unblockLock, INFINITE);
347     ASSERT_UNUSED(res, res == WAIT_OBJECT_0);
348
349     int signalsLeft = m_waitersToUnblock;
350
351     if (m_waitersToUnblock)
352         --m_waitersToUnblock;
353     else if (++m_waitersGone == (INT_MAX / 2)) { // timeout/canceled or spurious semaphore
354         // timeout or spurious wakeup occured, normalize the m_waitersGone count
355         // this may occur if many calls to wait with a timeout are made and
356         // no call to notify_* is made
357         res = WaitForSingleObject(m_blockLock, INFINITE);
358         ASSERT_UNUSED(res, res == WAIT_OBJECT_0);
359         m_waitersBlocked -= m_waitersGone;
360         res = ReleaseSemaphore(m_blockLock, 1, 0);
361         ASSERT_UNUSED(res, res);
362         m_waitersGone = 0;
363     }
364
365     res = ReleaseMutex(m_unblockLock);
366     ASSERT_UNUSED(res, res);
367
368     if (signalsLeft == 1) {
369         res = ReleaseSemaphore(m_blockLock, 1, 0); // Open the gate.
370         ASSERT_UNUSED(res, res);
371     }
372
373     EnterCriticalSection (&mutex.m_internalMutex);
374     ++mutex.m_recursionCount;
375
376     return !timedOut;
377 }
378
379 void PlatformCondition::signal(bool unblockAll)
380 {
381     unsigned signalsToIssue = 0;
382
383     DWORD res = WaitForSingleObject(m_unblockLock, INFINITE);
384     ASSERT_UNUSED(res, res == WAIT_OBJECT_0);
385
386     if (m_waitersToUnblock) { // the gate is already closed
387         if (!m_waitersBlocked) { // no-op
388             res = ReleaseMutex(m_unblockLock);
389             ASSERT_UNUSED(res, res);
390             return;
391         }
392
393         if (unblockAll) {
394             signalsToIssue = m_waitersBlocked;
395             m_waitersToUnblock += m_waitersBlocked;
396             m_waitersBlocked = 0;
397         } else {
398             signalsToIssue = 1;
399             ++m_waitersToUnblock;
400             --m_waitersBlocked;
401         }
402     } else if (m_waitersBlocked > m_waitersGone) {
403         res = WaitForSingleObject(m_blockLock, INFINITE); // Close the gate.
404         ASSERT_UNUSED(res, res == WAIT_OBJECT_0);
405         if (m_waitersGone != 0) {
406             m_waitersBlocked -= m_waitersGone;
407             m_waitersGone = 0;
408         }
409         if (unblockAll) {
410             signalsToIssue = m_waitersBlocked;
411             m_waitersToUnblock = m_waitersBlocked;
412             m_waitersBlocked = 0;
413         } else {
414             signalsToIssue = 1;
415             m_waitersToUnblock = 1;
416             --m_waitersBlocked;
417         }
418     } else { // No-op.
419         res = ReleaseMutex(m_unblockLock);
420         ASSERT_UNUSED(res, res);
421         return;
422     }
423
424     res = ReleaseMutex(m_unblockLock);
425     ASSERT_UNUSED(res, res);
426
427     if (signalsToIssue) {
428         res = ReleaseSemaphore(m_blockQueue, signalsToIssue, 0);
429         ASSERT_UNUSED(res, res);
430     }
431 }
432
433 static const long MaxSemaphoreCount = static_cast<long>(~0UL >> 1);
434
435 ThreadCondition::ThreadCondition()
436 {
437     m_condition.m_waitersGone = 0;
438     m_condition.m_waitersBlocked = 0;
439     m_condition.m_waitersToUnblock = 0;
440     m_condition.m_blockLock = CreateSemaphore(0, 1, 1, 0);
441     m_condition.m_blockQueue = CreateSemaphore(0, 0, MaxSemaphoreCount, 0);
442     m_condition.m_unblockLock = CreateMutex(0, 0, 0);
443
444     if (!m_condition.m_blockLock || !m_condition.m_blockQueue || !m_condition.m_unblockLock) {
445         if (m_condition.m_blockLock)
446             CloseHandle(m_condition.m_blockLock);
447         if (m_condition.m_blockQueue)
448             CloseHandle(m_condition.m_blockQueue);
449         if (m_condition.m_unblockLock)
450             CloseHandle(m_condition.m_unblockLock);
451     }
452 }
453
454 ThreadCondition::~ThreadCondition()
455 {
456     CloseHandle(m_condition.m_blockLock);
457     CloseHandle(m_condition.m_blockQueue);
458     CloseHandle(m_condition.m_unblockLock);
459 }
460
461 void ThreadCondition::wait(Mutex& mutex)
462 {
463     m_condition.timedWait(mutex.impl(), INFINITE);
464 }
465
466 bool ThreadCondition::timedWait(Mutex& mutex, double absoluteTime)
467 {
468     DWORD interval = absoluteTimeToWaitTimeoutInterval(absoluteTime);
469
470     if (!interval) {
471         // Consider the wait to have timed out, even if our condition has already been signaled, to
472         // match the pthreads implementation.
473         return false;
474     }
475
476     return m_condition.timedWait(mutex.impl(), interval);
477 }
478
479 void ThreadCondition::signal()
480 {
481     m_condition.signal(false); // Unblock only 1 thread.
482 }
483
484 void ThreadCondition::broadcast()
485 {
486     m_condition.signal(true); // Unblock all threads.
487 }
488
489 DWORD absoluteTimeToWaitTimeoutInterval(double absoluteTime)
490 {
491     double currentTime = WTF::currentTime();
492
493     // Time is in the past - return immediately.
494     if (absoluteTime < currentTime)
495         return 0;
496
497     // Time is too far in the future (and would overflow unsigned long) - wait forever.
498     if (absoluteTime - currentTime > static_cast<double>(INT_MAX) / 1000.0)
499         return INFINITE;
500
501     return static_cast<DWORD>((absoluteTime - currentTime) * 1000.0);
502 }
503
504 } // namespace WTF
505
506 #endif // OS(WINDOWS)