Remove WTF::SpinLock
[WebKit-https.git] / Source / WTF / wtf / WordLock.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_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 class WordLock {
46     WTF_MAKE_NONCOPYABLE(WordLock);
47 public:
48     WordLock()
49     {
50         m_word.store(0, std::memory_order_relaxed);
51     }
52
53     void lock()
54     {
55         if (LIKELY(m_word.compareExchangeWeak(0, isLockedBit, std::memory_order_acquire))) {
56             // WordLock acquired!
57             return;
58         }
59
60         lockSlow();
61     }
62
63     void unlock()
64     {
65         if (LIKELY(m_word.compareExchangeWeak(isLockedBit, 0, std::memory_order_release))) {
66             // WordLock released, and nobody was waiting!
67             return;
68         }
69
70         unlockSlow();
71     }
72
73     bool isHeld() const
74     {
75         return m_word.load(std::memory_order_acquire) & isLockedBit;
76     }
77
78     bool isLocked() const
79     {
80         return isHeld();
81     }
82
83 private:
84     friend struct TestWebKitAPI::LockInspector;
85     
86     static const uintptr_t isLockedBit = 1;
87     static const uintptr_t isQueueLockedBit = 2;
88     static const uintptr_t queueHeadMask = 3;
89
90     WTF_EXPORT_PRIVATE void lockSlow();
91     WTF_EXPORT_PRIVATE void unlockSlow();
92
93     // Method used for testing only.
94     bool isFullyReset() const
95     {
96         return !m_word.load();
97     }
98
99     Atomic<uintptr_t> m_word;
100 };
101
102 typedef Locker<WordLock> WordLockHolder;
103
104 } // namespace WTF
105
106 using WTF::WordLock;
107 using WTF::WordLockHolder;
108
109 #endif // WTF_WordLock_h
110