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