95a0ba616e00d4c003be235f044903302f6e3682
[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
52 // This is a struct without a constructor or destructor so that it can be statically initialized.
53 // Use Lock in instance variables.
54 struct LockBase {
55     void construct()
56     {
57         m_byte.store(0, std::memory_order_relaxed);
58     }
59     
60     void lock()
61     {
62         if (UNLIKELY(!DefaultLockAlgorithm::lockFastAssumingZero(m_byte)))
63             lockSlow();
64     }
65
66     bool tryLock()
67     {
68         return DefaultLockAlgorithm::tryLock(m_byte);
69     }
70
71     // Need this version for std::unique_lock.
72     bool try_lock()
73     {
74         return tryLock();
75     }
76
77     // Relinquish the lock. Either one of the threads that were waiting for the lock, or some other
78     // thread that happens to be running, will be able to grab the lock. This bit of unfairness is
79     // called barging, and we allow it because it maximizes throughput. However, we bound how unfair
80     // barging can get by ensuring that every once in a while, when there is a thread waiting on the
81     // lock, we hand the lock to that thread directly. Every time unlock() finds a thread waiting,
82     // we check if the last time that we did a fair unlock was more than roughly 1ms ago; if so, we
83     // unlock fairly. Fairness matters most for long critical sections, and this virtually
84     // guarantees that long critical sections always get a fair lock.
85     void unlock()
86     {
87         if (UNLIKELY(!DefaultLockAlgorithm::unlockFastAssumingZero(m_byte)))
88             unlockSlow();
89     }
90
91     // This is like unlock() but it guarantees that we unlock the lock fairly. For short critical
92     // sections, this is much slower than unlock(). For long critical sections, unlock() will learn
93     // to be fair anyway. However, if you plan to relock the lock right after unlocking and you want
94     // to ensure that some other thread runs in the meantime, this is probably the function you
95     // want.
96     void unlockFairly()
97     {
98         if (UNLIKELY(!DefaultLockAlgorithm::unlockFastAssumingZero(m_byte)))
99             unlockFairlySlow();
100     }
101     
102     void safepoint()
103     {
104         if (UNLIKELY(!DefaultLockAlgorithm::safepointFast(m_byte)))
105             safepointSlow();
106     }
107
108     bool isHeld() const
109     {
110         return DefaultLockAlgorithm::isLocked(m_byte);
111     }
112
113     bool isLocked() const
114     {
115         return isHeld();
116     }
117
118 private:
119     friend struct TestWebKitAPI::LockInspector;
120     
121     static const uint8_t isHeldBit = 1;
122     static const uint8_t hasParkedBit = 2;
123     
124     WTF_EXPORT_PRIVATE void lockSlow();
125     WTF_EXPORT_PRIVATE void unlockSlow();
126     WTF_EXPORT_PRIVATE void unlockFairlySlow();
127     WTF_EXPORT_PRIVATE void safepointSlow();
128
129     // Method used for testing only.
130     bool isFullyReset() const
131     {
132         return !m_byte.load();
133     }
134
135     Atomic<uint8_t> m_byte;
136 };
137
138 class Lock : public LockBase {
139     WTF_MAKE_NONCOPYABLE(Lock);
140     WTF_MAKE_FAST_ALLOCATED;
141 public:
142     Lock()
143     {
144         construct();
145     }
146 };
147
148 typedef LockBase StaticLock;
149 typedef Locker<LockBase> LockHolder;
150
151 } // namespace WTF
152
153 using WTF::Lock;
154 using WTF::LockHolder;
155 using WTF::StaticLock;
156
157 #endif // WTF_Lock_h
158