Use WTF::Lock and WTF::Condition instead of WTF::Mutex, WTF::ThreadCondition, std...
[WebKit-https.git] / Source / WTF / wtf / Condition.h
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_Condition_h
27 #define WTF_Condition_h
28
29 #include <chrono>
30 #include <functional>
31 #include <mutex>
32 #include <wtf/ParkingLot.h>
33
34 namespace WTF {
35
36 class Condition {
37 public:
38     Condition() { }
39
40     // Wait on a parking queue while releasing the given lock. It will unlock the lock just before
41     // parking, and relock it upon wakeup. Returns true if we woke up due to some call to
42     // notifyOne() or notifyAll(). Returns false if we woke up due to a timeout.
43     template<typename LockType>
44     bool waitUntil(
45         LockType& lock, std::chrono::steady_clock::time_point timeout)
46     {
47         bool result = ParkingLot::parkConditionally(
48             &m_dummy,
49             [] () -> bool { return true; },
50             [&lock] () { lock.unlock(); },
51             timeout);
52         lock.lock();
53         return result;
54     }
55
56     // Wait until the given predicate is satisfied. Returns true if it is satisfied in the end.
57     // May return early due to timeout.
58     template<typename LockType, typename Functor>
59     bool waitUntil(
60         LockType& lock, std::chrono::steady_clock::time_point timeout, const Functor& predicate)
61     {
62         while (!predicate()) {
63             if (!waitUntil(lock, timeout))
64                 return predicate();
65         }
66         return true;
67     }
68
69     // Wait until the given predicate is satisfied. Returns true if it is satisfied in the end.
70     // May return early due to timeout.
71     template<typename LockType, typename DurationType, typename Functor>
72     bool waitFor(
73         LockType& lock, const DurationType& relativeTimeout, const Functor& predicate)
74     {
75         std::chrono::steady_clock::time_point absoluteTimeout =
76             std::chrono::steady_clock::now() +
77             std::chrono::duration_cast<std::chrono::steady_clock::duration>(relativeTimeout);
78
79         return waitUntil(lock, absoluteTimeout, predicate);
80     }
81
82     template<typename LockType>
83     void wait(LockType& lock)
84     {
85         waitUntil(lock, std::chrono::steady_clock::time_point::max());
86     }
87
88     template<typename LockType, typename Functor>
89     void wait(LockType& lock, const Functor& predicate)
90     {
91         while (!predicate())
92             wait(lock);
93     }
94
95     void notifyOne()
96     {
97         ParkingLot::unparkOne(&m_dummy);
98     }
99     
100     void notifyAll()
101     {
102         ParkingLot::unparkAll(&m_dummy);
103     }
104     
105 private:
106     
107     uint8_t m_dummy;
108 };
109
110 } // namespace WTF
111
112 using WTF::Condition;
113
114 #endif // WTF_Condition_h
115