Unreviewed, roll out http://trac.webkit.org/changeset/187972.
[WebKit-https.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/Assertions.h>
35 #include <wtf/FastMalloc.h>
36 #include <wtf/Locker.h>
37 #include <wtf/Noncopyable.h>
38
39 #if OS(WINDOWS)
40 #include <windows.h>
41 #endif
42
43 #if USE(PTHREADS)
44 #include <pthread.h>
45 #endif
46
47 namespace WTF {
48
49 #if USE(PTHREADS)
50 typedef pthread_mutex_t PlatformMutex;
51 typedef pthread_cond_t PlatformCondition;
52 #elif OS(WINDOWS)
53 struct PlatformMutex {
54     CRITICAL_SECTION m_internalMutex;
55     size_t m_recursionCount;
56 };
57 struct PlatformCondition {
58     size_t m_waitersGone;
59     size_t m_waitersBlocked;
60     size_t m_waitersToUnblock; 
61     HANDLE m_blockLock;
62     HANDLE m_blockQueue;
63     HANDLE m_unblockLock;
64
65     bool timedWait(PlatformMutex&, DWORD durationMilliseconds);
66     void signal(bool unblockAll);
67 };
68 #else
69 typedef void* PlatformMutex;
70 typedef void* PlatformCondition;
71 #endif
72     
73 class Mutex {
74     WTF_MAKE_NONCOPYABLE(Mutex); WTF_MAKE_FAST_ALLOCATED;
75 public:
76     WTF_EXPORT_PRIVATE Mutex();
77     WTF_EXPORT_PRIVATE ~Mutex();
78
79     WTF_EXPORT_PRIVATE void lock();
80     WTF_EXPORT_PRIVATE bool tryLock();
81     WTF_EXPORT_PRIVATE void unlock();
82
83 public:
84     PlatformMutex& impl() { return m_mutex; }
85 private:
86     PlatformMutex m_mutex;
87 };
88
89 typedef Locker<Mutex> MutexLocker;
90
91 class ThreadCondition {
92     WTF_MAKE_NONCOPYABLE(ThreadCondition);
93 public:
94     WTF_EXPORT_PRIVATE ThreadCondition();
95     WTF_EXPORT_PRIVATE ~ThreadCondition();
96     
97     WTF_EXPORT_PRIVATE void wait(Mutex& mutex);
98     // Returns true if the condition was signaled before absoluteTime, false if the absoluteTime was reached or is in the past.
99     // The absoluteTime is in seconds, starting on January 1, 1970. The time is assumed to use the same time zone as WTF::currentTime().
100     WTF_EXPORT_PRIVATE bool timedWait(Mutex&, double absoluteTime);
101     WTF_EXPORT_PRIVATE void signal();
102     WTF_EXPORT_PRIVATE void broadcast();
103     
104 private:
105     PlatformCondition m_condition;
106 };
107
108 #if OS(WINDOWS)
109 // The absoluteTime is in seconds, starting on January 1, 1970. The time is assumed to use the same time zone as WTF::currentTime().
110 // Returns an interval in milliseconds suitable for passing to one of the Win32 wait functions (e.g., ::WaitForSingleObject).
111 WTF_EXPORT_PRIVATE DWORD absoluteTimeToWaitTimeoutInterval(double absoluteTime);
112 #endif
113
114 } // namespace WTF
115
116 using WTF::Mutex;
117 using WTF::MutexLocker;
118 using WTF::ThreadCondition;
119
120 #if OS(WINDOWS)
121 using WTF::absoluteTimeToWaitTimeoutInterval;
122 #endif
123
124 #endif // ThreadingPrimitives_h