ca41f3028f1b695e3054597e4f8f4c6e0e7f869f
[WebKit-https.git] / Source / WTF / wtf / Locker.h
1 /*
2  * Copyright (C) 2008, 2013, 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef Locker_h
29 #define Locker_h
30
31 #include <wtf/Assertions.h>
32 #include <wtf/Noncopyable.h>
33
34 namespace WTF {
35
36 enum NoLockingNecessaryTag { NoLockingNecessary };
37
38 class AbstractLocker {
39     WTF_MAKE_NONCOPYABLE(AbstractLocker);
40 public:
41     AbstractLocker(NoLockingNecessaryTag)
42     {
43     }
44     
45 protected:
46     AbstractLocker()
47     {
48     }
49 };
50
51 template <typename T> class Locker : public AbstractLocker {
52 public:
53     explicit Locker(T& lockable) : m_lockable(&lockable) { lock(); }
54     explicit Locker(T* lockable) : m_lockable(lockable) { lock(); }
55
56     // You should be wary of using this constructor. It's only applicable
57     // in places where there is a locking protocol for a particular object
58     // but it's not necessary to engage in that protocol yet. For example,
59     // this often happens when an object is newly allocated and it can not
60     // be accessed concurrently.
61     Locker(NoLockingNecessaryTag) : m_lockable(nullptr) { }
62     
63     Locker(int) = delete;
64
65     ~Locker()
66     {
67         if (m_lockable)
68             m_lockable->unlock();
69     }
70     
71     static Locker tryLock(T& lockable)
72     {
73         Locker result(NoLockingNecessary);
74         if (lockable.tryLock()) {
75             result.m_lockable = &lockable;
76             return result;
77         }
78         return result;
79     }
80     
81     explicit operator bool() const { return !!m_lockable; }
82     
83     void unlockEarly()
84     {
85         m_lockable->unlock();
86         m_lockable = 0;
87     }
88     
89     // It's great to be able to pass lockers around. It enables custom locking adaptors like
90     // JSC::LockDuringMarking.
91     Locker(Locker&& other)
92         : m_lockable(other.m_lockable)
93     {
94         other.m_lockable = nullptr;
95     }
96     
97     Locker& operator=(Locker&& other)
98     {
99         if (m_lockable)
100             m_lockable->unlock();
101         m_lockable = other.m_lockable;
102         other.m_lockable = nullptr;
103         return *this;
104     }
105     
106 private:
107     void lock()
108     {
109         if (m_lockable)
110             m_lockable->lock();
111     }
112     
113     T* m_lockable;
114 };
115
116 // Use this lock scope like so:
117 // auto locker = holdLock(lock);
118 template<typename LockType>
119 Locker<LockType> holdLock(LockType& lock)
120 {
121     return Locker<LockType>(lock);
122 }
123
124 template<typename LockType>
125 Locker<LockType> tryHoldLock(LockType& lock)
126 {
127     return Locker<LockType>::tryLock(lock);
128 }
129
130 }
131
132 using WTF::AbstractLocker;
133 using WTF::Locker;
134 using WTF::NoLockingNecessaryTag;
135 using WTF::NoLockingNecessary;
136 using WTF::holdLock;
137
138 #endif