52191ee01d947fe3c4f08e355fdaa8ad5727a73c
[WebKit-https.git] / Source / WTF / wtf / WordLock.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_WordLock_h
27 #define WTF_WordLock_h
28
29 #include <wtf/Atomics.h>
30 #include <wtf/Compiler.h>
31 #include <wtf/Locker.h>
32 #include <wtf/Noncopyable.h>
33
34 namespace TestWebKitAPI {
35 struct LockInspector;
36 };
37
38 namespace WTF {
39
40 // A WordLock is a fully adaptive mutex that uses sizeof(void*) storage. It has a fast path that is
41 // similar to a spinlock, and a slow path that is similar to std::mutex. In most cases, you should use
42 // Lock instead. WordLock sits lower in the stack and is used to implement Lock, so Lock is the main
43 // client of WordLock.
44
45 // NOTE: This is also a great lock to use if you are very low in the stack. For example,
46 // PrintStream uses this so that ParkingLot and Lock can use PrintStream. This means that if you
47 // try to use dataLog to debug this code, you will have a bad time.
48
49 struct WordLockBase {
50     void lock()
51     {
52         if (LIKELY(m_word.compareExchangeWeak(0, isLockedBit, std::memory_order_acquire))) {
53             // WordLock acquired!
54             return;
55         }
56
57         lockSlow();
58     }
59
60     void unlock()
61     {
62         if (LIKELY(m_word.compareExchangeWeak(isLockedBit, 0, std::memory_order_release))) {
63             // WordLock released, and nobody was waiting!
64             return;
65         }
66
67         unlockSlow();
68     }
69
70     bool isHeld() const
71     {
72         return m_word.load(std::memory_order_acquire) & isLockedBit;
73     }
74
75     bool isLocked() const
76     {
77         return isHeld();
78     }
79
80 protected:
81     friend struct TestWebKitAPI::LockInspector;
82     
83     static const uintptr_t isLockedBit = 1;
84     static const uintptr_t isQueueLockedBit = 2;
85     static const uintptr_t queueHeadMask = 3;
86
87     WTF_EXPORT_PRIVATE void lockSlow();
88     WTF_EXPORT_PRIVATE void unlockSlow();
89
90     // Method used for testing only.
91     bool isFullyReset() const
92     {
93         return !m_word.load();
94     }
95
96     Atomic<uintptr_t> m_word;
97 };
98
99 class WordLock : public WordLockBase {
100     WTF_MAKE_NONCOPYABLE(WordLock);
101 public:
102     WordLock()
103     {
104         m_word.store(0, std::memory_order_relaxed);
105     }
106 };
107
108 typedef WordLockBase StaticWordLock;
109 typedef Locker<WordLockBase> WordLockHolder;
110
111 } // namespace WTF
112
113 using WTF::WordLock;
114 using WTF::WordLockHolder;
115 using WTF::StaticWordLock;
116
117 #endif // WTF_WordLock_h
118