[WTF] Remove XXXLockBase since constexpr constructor can initialize static variables...
[WebKit-https.git] / Source / WTF / wtf / Lock.h
1 /*
2  * Copyright (C) 2015-2016 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_Lock_h
27 #define WTF_Lock_h
28
29 #include <wtf/LockAlgorithm.h>
30 #include <wtf/Locker.h>
31 #include <wtf/Noncopyable.h>
32
33 namespace TestWebKitAPI {
34 struct LockInspector;
35 };
36
37 namespace WTF {
38
39 typedef LockAlgorithm<uint8_t, 1, 2> DefaultLockAlgorithm;
40
41 // This is a fully adaptive mutex that only requires 1 byte of storage. It has fast paths that are
42 // competetive to a spinlock (uncontended locking is inlined and is just a CAS, microcontention is
43 // handled by spinning and yielding), and a slow path that is competetive to std::mutex (if a lock
44 // cannot be acquired in a short period of time, the thread is put to sleep until the lock is
45 // available again). It uses less memory than a std::mutex. This lock guarantees eventual stochastic
46 // fairness, even in programs that relock the lock immediately after unlocking it. Except when there
47 // are collisions between this lock and other locks in the ParkingLot, this lock will guarantee that
48 // at worst one call to unlock() per millisecond will do a direct hand-off to the thread that is at
49 // the head of the queue. When there are collisions, each collision increases the fair unlock delay
50 // by one millisecond in the worst case.
51 class Lock {
52     WTF_MAKE_NONCOPYABLE(Lock);
53     WTF_MAKE_FAST_ALLOCATED;
54 public:
55     Lock() = default;
56
57     void lock()
58     {
59         if (UNLIKELY(!DefaultLockAlgorithm::lockFastAssumingZero(m_byte)))
60             lockSlow();
61     }
62
63     bool tryLock()
64     {
65         return DefaultLockAlgorithm::tryLock(m_byte);
66     }
67
68     // Need this version for std::unique_lock.
69     bool try_lock()
70     {
71         return tryLock();
72     }
73
74     // Relinquish the lock. Either one of the threads that were waiting for the lock, or some other
75     // thread that happens to be running, will be able to grab the lock. This bit of unfairness is
76     // called barging, and we allow it because it maximizes throughput. However, we bound how unfair
77     // barging can get by ensuring that every once in a while, when there is a thread waiting on the
78     // lock, we hand the lock to that thread directly. Every time unlock() finds a thread waiting,
79     // we check if the last time that we did a fair unlock was more than roughly 1ms ago; if so, we
80     // unlock fairly. Fairness matters most for long critical sections, and this virtually
81     // guarantees that long critical sections always get a fair lock.
82     void unlock()
83     {
84         if (UNLIKELY(!DefaultLockAlgorithm::unlockFastAssumingZero(m_byte)))
85             unlockSlow();
86     }
87
88     // This is like unlock() but it guarantees that we unlock the lock fairly. For short critical
89     // sections, this is much slower than unlock(). For long critical sections, unlock() will learn
90     // to be fair anyway. However, if you plan to relock the lock right after unlocking and you want
91     // to ensure that some other thread runs in the meantime, this is probably the function you
92     // want.
93     void unlockFairly()
94     {
95         if (UNLIKELY(!DefaultLockAlgorithm::unlockFastAssumingZero(m_byte)))
96             unlockFairlySlow();
97     }
98     
99     void safepoint()
100     {
101         if (UNLIKELY(!DefaultLockAlgorithm::safepointFast(m_byte)))
102             safepointSlow();
103     }
104
105     bool isHeld() const
106     {
107         return DefaultLockAlgorithm::isLocked(m_byte);
108     }
109
110     bool isLocked() const
111     {
112         return isHeld();
113     }
114
115 private:
116     friend struct TestWebKitAPI::LockInspector;
117     
118     static const uint8_t isHeldBit = 1;
119     static const uint8_t hasParkedBit = 2;
120     
121     WTF_EXPORT_PRIVATE void lockSlow();
122     WTF_EXPORT_PRIVATE void unlockSlow();
123     WTF_EXPORT_PRIVATE void unlockFairlySlow();
124     WTF_EXPORT_PRIVATE void safepointSlow();
125
126     // Method used for testing only.
127     bool isFullyReset() const
128     {
129         return !m_byte.load();
130     }
131
132     Atomic<uint8_t> m_byte { 0 };
133 };
134
135 using StaticLock = Lock;
136 using LockHolder = Locker<Lock>;
137
138 } // namespace WTF
139
140 using WTF::Lock;
141 using WTF::LockHolder;
142 using WTF::StaticLock;
143
144 #endif // WTF_Lock_h
145