1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ThreadRestrictionVerifier_h
#define ThreadRestrictionVerifier_h
#include <wtf/Assertions.h>
#include <wtf/Threading.h>
#include <wtf/ThreadingPrimitives.h>
#if HAVE(DISPATCH_H)
#include <dispatch/dispatch.h>
#endif
#ifndef NDEBUG
namespace WTF {
// Verifies that a class is used in a way that respects its lack of thread-safety.
// The default mode is to verify that the object will only be used on a single thread. The
// thread gets captured when setShared(true) is called.
// The mode may be changed by calling useMutexMode (or turnOffVerification).
// FIXME: This verifier is switched off because it fires false positives for
// objects that are used on multiple threads. Instead of an opt-out verifier,
// we probably need an opt-in verifier that marks select objects as being
// tied to select threads.
#if 0
class ThreadRestrictionVerifier {
public:
ThreadRestrictionVerifier()
: m_mode(SingleThreadVerificationMode)
, m_shared(false)
, m_owningThread(0)
, m_mutex(0)
#if HAVE(DISPATCH_H)
, m_owningQueue(0)
#endif
{
}
#if HAVE(DISPATCH_H)
~ThreadRestrictionVerifier()
{
if (m_owningQueue)
dispatch_release(m_owningQueue);
}
#endif
void setMutexMode(Mutex& mutex)
{
m_mode = MutexVerificationMode;
m_mutex = &mutex;
}
#if HAVE(DISPATCH_H)
void setDispatchQueueMode(dispatch_queue_t queue)
{
m_mode = SingleDispatchQueueVerificationMode;
m_owningQueue = queue;
dispatch_retain(m_owningQueue);
}
#endif
void turnOffVerification()
{
m_mode = NoVerificationMode;
}
// Indicates that the object may (or may not) be owned by more than one place.
void setShared(bool shared)
{
#if !ASSERT_DISABLED
bool previouslyShared = m_shared;
#endif
m_shared = shared;
if (!m_shared)
return;
switch (m_mode) {
case SingleThreadVerificationMode:
ASSERT(shared != previouslyShared);
// Capture the current thread to verify that subsequent ref/deref happen on this thread.
m_owningThread = currentThread();
return;
#if HAVE(DISPATCH_H)
case SingleDispatchQueueVerificationMode:
#endif
case MutexVerificationMode:
case NoVerificationMode:
return;
}
ASSERT_NOT_REACHED();
}
// Is it OK to use the object at this moment on the current thread?
bool isSafeToUse() const
{
if (!m_shared)
return true;
switch (m_mode) {
case SingleThreadVerificationMode:
return m_owningThread == currentThread();
case MutexVerificationMode:
if (!m_mutex->tryLock())
return true;
m_mutex->unlock();
return false;
#if HAVE(DISPATCH_H)
case SingleDispatchQueueVerificationMode:
return m_owningQueue == dispatch_get_current_queue();
#endif
case NoVerificationMode:
return true;
}
ASSERT_NOT_REACHED();
return true;
}
private:
enum VerificationMode {
SingleThreadVerificationMode,
MutexVerificationMode,
NoVerificationMode,
#if HAVE(DISPATCH_H)
SingleDispatchQueueVerificationMode,
#endif
};
VerificationMode m_mode;
bool m_shared;
// Used by SingleThreadVerificationMode
ThreadIdentifier m_owningThread;
// Used by MutexVerificationMode.
Mutex* m_mutex;
#if HAVE(DISPATCH_H)
// Used by SingleDispatchQueueVerificationMode.
dispatch_queue_t m_owningQueue;
#endif
};
#else
class ThreadRestrictionVerifier {
public:
ThreadRestrictionVerifier()
{
}
void setMutexMode(Mutex&)
{
}
#if HAVE(DISPATCH_H)
void setDispatchQueueMode(dispatch_queue_t)
{
}
#endif
void turnOffVerification()
{
}
// Indicates that the object may (or may not) be owned by more than one place.
void setShared(bool)
{
}
// Is it OK to use the object at this moment on the current thread?
bool isSafeToUse() const
{
return true;
}
};
#endif
}
#endif
#endif
|
