Unreviewed, rolling out r220060.
[WebKit.git] / Source / WTF / wtf / ThreadingPrimitives.h
1 /*
2  * Copyright (C) 2007, 2008, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  */
30
31 #ifndef ThreadingPrimitives_h
32 #define ThreadingPrimitives_h
33
34 #include <wtf/FastMalloc.h>
35 #include <wtf/Locker.h>
36 #include <wtf/Noncopyable.h>
37
38 #if OS(WINDOWS)
39 #include <windows.h>
40 #endif
41
42 #if USE(PTHREADS)
43 #include <pthread.h>
44 #endif
45
46 namespace WTF {
47
48 #if USE(PTHREADS)
49 using PlatformThreadHandle = pthread_t;
50 using PlatformMutex = pthread_mutex_t;
51 using PlatformCondition = pthread_cond_t;
52 #elif OS(WINDOWS)
53 using PlatformThreadHandle = HANDLE;
54 struct PlatformMutex {
55     CRITICAL_SECTION m_internalMutex;
56     size_t m_recursionCount;
57 };
58 struct PlatformCondition {
59     size_t m_waitersGone;
60     size_t m_waitersBlocked;
61     size_t m_waitersToUnblock; 
62     HANDLE m_blockLock;
63     HANDLE m_blockQueue;
64     HANDLE m_unblockLock;
65
66     bool timedWait(PlatformMutex&, DWORD durationMilliseconds);
67     void signal(bool unblockAll);
68 };
69 #else
70 typedef void* PlatformMutex;
71 typedef void* PlatformCondition;
72 #endif
73     
74 class Mutex {
75     WTF_MAKE_NONCOPYABLE(Mutex); WTF_MAKE_FAST_ALLOCATED;
76 public:
77     WTF_EXPORT_PRIVATE Mutex();
78     WTF_EXPORT_PRIVATE ~Mutex();
79
80     WTF_EXPORT_PRIVATE void lock();
81     WTF_EXPORT_PRIVATE bool tryLock();
82     WTF_EXPORT_PRIVATE void unlock();
83
84 public:
85     PlatformMutex& impl() { return m_mutex; }
86 private:
87     PlatformMutex m_mutex;
88 };
89
90 typedef Locker<Mutex> MutexLocker;
91
92 class ThreadCondition {
93     WTF_MAKE_NONCOPYABLE(ThreadCondition);
94 public:
95     WTF_EXPORT_PRIVATE ThreadCondition();
96     WTF_EXPORT_PRIVATE ~ThreadCondition();
97     
98     WTF_EXPORT_PRIVATE void wait(Mutex& mutex);
99     // Returns true if the condition was signaled before absoluteTime, false if the absoluteTime was reached or is in the past.
100     // The absoluteTime is in seconds, starting on January 1, 1970. The time is assumed to use the same time zone as WTF::currentTime().
101     WTF_EXPORT_PRIVATE bool timedWait(Mutex&, double absoluteTime);
102     WTF_EXPORT_PRIVATE void signal();
103     WTF_EXPORT_PRIVATE void broadcast();
104     
105 private:
106     PlatformCondition m_condition;
107 };
108
109 #if OS(WINDOWS)
110 // The absoluteTime is in seconds, starting on January 1, 1970. The time is assumed to use the same time zone as WTF::currentTime().
111 // Returns an interval in milliseconds suitable for passing to one of the Win32 wait functions (e.g., ::WaitForSingleObject).
112 WTF_EXPORT_PRIVATE DWORD absoluteTimeToWaitTimeoutInterval(double absoluteTime);
113 #endif
114
115 } // namespace WTF
116
117 using WTF::Mutex;
118 using WTF::MutexLocker;
119 using WTF::ThreadCondition;
120
121 #if OS(WINDOWS)
122 using WTF::absoluteTimeToWaitTimeoutInterval;
123 #endif
124
125 #endif // ThreadingPrimitives_h