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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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 Computer, 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.
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.
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/).
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.
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.
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.
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).
58 * Pthreads-win32 - POSIX Threads Library for Win32
59 * Copyright(C) 1998 John E. Bossom
60 * Copyright(C) 1999,2005 Pthreads-win32 contributors
62 * Contact Email: rpj@callisto.canberra.edu.au
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
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.
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.
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
87 #include "Threading.h"
91 #include "wtf/CurrentTime.h"
92 #include "wtf/DateMath.h"
93 #include "wtf/HashMap.h"
94 #include "wtf/MainThread.h"
95 #include "wtf/MathExtras.h"
96 #include "wtf/OwnPtr.h"
97 #include "wtf/PassOwnPtr.h"
98 #include "wtf/ThreadSpecific.h"
99 #include "wtf/ThreadingPrimitives.h"
100 #include "wtf/WTFThreadData.h"
101 #include "wtf/dtoa.h"
102 #include "wtf/dtoa/cached-powers.h"
109 // THREADNAME_INFO comes from <http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx>.
110 #pragma pack(push, 8)
111 typedef struct tagTHREADNAME_INFO
{
112 DWORD dwType
; // must be 0x1000
113 LPCSTR szName
; // pointer to name (in user addr space)
114 DWORD dwThreadID
; // thread ID (-1=caller thread)
115 DWORD dwFlags
; // reserved for future use, must be zero
119 static Mutex
* atomicallyInitializedStaticMutex
;
121 void lockAtomicallyInitializedStaticMutex()
123 ASSERT(atomicallyInitializedStaticMutex
);
124 atomicallyInitializedStaticMutex
->lock();
127 void unlockAtomicallyInitializedStaticMutex()
129 atomicallyInitializedStaticMutex
->unlock();
132 void initializeThreading()
134 // This should only be called once.
135 ASSERT(!atomicallyInitializedStaticMutex
);
137 // StringImpl::empty() does not construct its static string in a threadsafe fashion,
138 // so ensure it has been initialized from here.
140 StringImpl::empty16Bit();
141 atomicallyInitializedStaticMutex
= new Mutex
;
143 s_dtoaP5Mutex
= new Mutex
;
145 // Force initialization of static DoubleToStringConverter converter variable
146 // inside EcmaScriptConverter function while we are in single thread mode.
147 double_conversion::DoubleToStringConverter::EcmaScriptConverter();
150 ThreadIdentifier
currentThread()
152 return static_cast<ThreadIdentifier
>(GetCurrentThreadId());
155 MutexBase::MutexBase(bool recursive
)
157 m_mutex
.m_recursionCount
= 0;
158 InitializeCriticalSection(&m_mutex
.m_internalMutex
);
161 MutexBase::~MutexBase()
163 DeleteCriticalSection(&m_mutex
.m_internalMutex
);
166 void MutexBase::lock()
168 EnterCriticalSection(&m_mutex
.m_internalMutex
);
169 ++m_mutex
.m_recursionCount
;
172 void MutexBase::unlock()
174 ASSERT(m_mutex
.m_recursionCount
);
175 --m_mutex
.m_recursionCount
;
176 LeaveCriticalSection(&m_mutex
.m_internalMutex
);
179 bool Mutex::tryLock()
181 // This method is modeled after the behavior of pthread_mutex_trylock,
182 // which will return an error if the lock is already owned by the
183 // current thread. Since the primitive Win32 'TryEnterCriticalSection'
184 // treats this as a successful case, it changes the behavior of several
185 // tests in WebKit that check to see if the current thread already
186 // owned this mutex (see e.g., IconDatabase::getOrCreateIconRecord)
187 DWORD result
= TryEnterCriticalSection(&m_mutex
.m_internalMutex
);
189 if (result
!= 0) { // We got the lock
190 // If this thread already had the lock, we must unlock and return
191 // false since this is a non-recursive mutex. This is to mimic the
192 // behavior of POSIX's pthread_mutex_trylock. We don't do this
193 // check in the lock method (presumably due to performance?). This
194 // means lock() will succeed even if the current thread has already
195 // entered the critical section.
196 if (m_mutex
.m_recursionCount
> 0) {
197 LeaveCriticalSection(&m_mutex
.m_internalMutex
);
200 ++m_mutex
.m_recursionCount
;
207 bool RecursiveMutex::tryLock()
209 // CRITICAL_SECTION is recursive/reentrant so TryEnterCriticalSection will
210 // succeed if the current thread is already in the critical section.
211 DWORD result
= TryEnterCriticalSection(&m_mutex
.m_internalMutex
);
212 if (result
== 0) { // We didn't get the lock.
215 ++m_mutex
.m_recursionCount
;
219 bool PlatformCondition::timedWait(PlatformMutex
& mutex
, DWORD durationMilliseconds
)
221 // Enter the wait state.
222 DWORD res
= WaitForSingleObject(m_blockLock
, INFINITE
);
223 ASSERT_UNUSED(res
, res
== WAIT_OBJECT_0
);
225 res
= ReleaseSemaphore(m_blockLock
, 1, 0);
226 ASSERT_UNUSED(res
, res
);
228 --mutex
.m_recursionCount
;
229 LeaveCriticalSection(&mutex
.m_internalMutex
);
231 // Main wait - use timeout.
232 bool timedOut
= (WaitForSingleObject(m_blockQueue
, durationMilliseconds
) == WAIT_TIMEOUT
);
234 res
= WaitForSingleObject(m_unblockLock
, INFINITE
);
235 ASSERT_UNUSED(res
, res
== WAIT_OBJECT_0
);
237 int signalsLeft
= m_waitersToUnblock
;
239 if (m_waitersToUnblock
)
240 --m_waitersToUnblock
;
241 else if (++m_waitersGone
== (INT_MAX
/ 2)) { // timeout/canceled or spurious semaphore
242 // timeout or spurious wakeup occured, normalize the m_waitersGone count
243 // this may occur if many calls to wait with a timeout are made and
244 // no call to notify_* is made
245 res
= WaitForSingleObject(m_blockLock
, INFINITE
);
246 ASSERT_UNUSED(res
, res
== WAIT_OBJECT_0
);
247 m_waitersBlocked
-= m_waitersGone
;
248 res
= ReleaseSemaphore(m_blockLock
, 1, 0);
249 ASSERT_UNUSED(res
, res
);
253 res
= ReleaseMutex(m_unblockLock
);
254 ASSERT_UNUSED(res
, res
);
256 if (signalsLeft
== 1) {
257 res
= ReleaseSemaphore(m_blockLock
, 1, 0); // Open the gate.
258 ASSERT_UNUSED(res
, res
);
261 EnterCriticalSection (&mutex
.m_internalMutex
);
262 ++mutex
.m_recursionCount
;
267 void PlatformCondition::signal(bool unblockAll
)
269 unsigned signalsToIssue
= 0;
271 DWORD res
= WaitForSingleObject(m_unblockLock
, INFINITE
);
272 ASSERT_UNUSED(res
, res
== WAIT_OBJECT_0
);
274 if (m_waitersToUnblock
) { // the gate is already closed
275 if (!m_waitersBlocked
) { // no-op
276 res
= ReleaseMutex(m_unblockLock
);
277 ASSERT_UNUSED(res
, res
);
282 signalsToIssue
= m_waitersBlocked
;
283 m_waitersToUnblock
+= m_waitersBlocked
;
284 m_waitersBlocked
= 0;
287 ++m_waitersToUnblock
;
290 } else if (m_waitersBlocked
> m_waitersGone
) {
291 res
= WaitForSingleObject(m_blockLock
, INFINITE
); // Close the gate.
292 ASSERT_UNUSED(res
, res
== WAIT_OBJECT_0
);
293 if (m_waitersGone
!= 0) {
294 m_waitersBlocked
-= m_waitersGone
;
298 signalsToIssue
= m_waitersBlocked
;
299 m_waitersToUnblock
= m_waitersBlocked
;
300 m_waitersBlocked
= 0;
303 m_waitersToUnblock
= 1;
307 res
= ReleaseMutex(m_unblockLock
);
308 ASSERT_UNUSED(res
, res
);
312 res
= ReleaseMutex(m_unblockLock
);
313 ASSERT_UNUSED(res
, res
);
315 if (signalsToIssue
) {
316 res
= ReleaseSemaphore(m_blockQueue
, signalsToIssue
, 0);
317 ASSERT_UNUSED(res
, res
);
321 static const long MaxSemaphoreCount
= static_cast<long>(~0UL >> 1);
323 ThreadCondition::ThreadCondition()
325 m_condition
.m_waitersGone
= 0;
326 m_condition
.m_waitersBlocked
= 0;
327 m_condition
.m_waitersToUnblock
= 0;
328 m_condition
.m_blockLock
= CreateSemaphore(0, 1, 1, 0);
329 m_condition
.m_blockQueue
= CreateSemaphore(0, 0, MaxSemaphoreCount
, 0);
330 m_condition
.m_unblockLock
= CreateMutex(0, 0, 0);
332 if (!m_condition
.m_blockLock
|| !m_condition
.m_blockQueue
|| !m_condition
.m_unblockLock
) {
333 if (m_condition
.m_blockLock
)
334 CloseHandle(m_condition
.m_blockLock
);
335 if (m_condition
.m_blockQueue
)
336 CloseHandle(m_condition
.m_blockQueue
);
337 if (m_condition
.m_unblockLock
)
338 CloseHandle(m_condition
.m_unblockLock
);
342 ThreadCondition::~ThreadCondition()
344 CloseHandle(m_condition
.m_blockLock
);
345 CloseHandle(m_condition
.m_blockQueue
);
346 CloseHandle(m_condition
.m_unblockLock
);
349 void ThreadCondition::wait(MutexBase
& mutex
)
351 m_condition
.timedWait(mutex
.impl(), INFINITE
);
354 bool ThreadCondition::timedWait(MutexBase
& mutex
, double absoluteTime
)
356 DWORD interval
= absoluteTimeToWaitTimeoutInterval(absoluteTime
);
359 // Consider the wait to have timed out, even if our condition has already been signaled, to
360 // match the pthreads implementation.
364 return m_condition
.timedWait(mutex
.impl(), interval
);
367 void ThreadCondition::signal()
369 m_condition
.signal(false); // Unblock only 1 thread.
372 void ThreadCondition::broadcast()
374 m_condition
.signal(true); // Unblock all threads.
377 DWORD
absoluteTimeToWaitTimeoutInterval(double absoluteTime
)
379 double currentTime
= WTF::currentTime();
381 // Time is in the past - return immediately.
382 if (absoluteTime
< currentTime
)
385 // Time is too far in the future (and would overflow unsigned long) - wait forever.
386 if (absoluteTime
- currentTime
> static_cast<double>(INT_MAX
) / 1000.0)
389 return static_cast<DWORD
>((absoluteTime
- currentTime
) * 1000.0);
393 static bool s_threadCreated
= false;
395 bool isAtomicallyInitializedStaticMutexLockHeld()
397 return atomicallyInitializedStaticMutex
&& atomicallyInitializedStaticMutex
->locked();
400 bool isBeforeThreadCreated()
402 return !s_threadCreated
;
405 void willCreateThread()
407 s_threadCreated
= true;