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
|
/*
* Copyright (C) 2009 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 CrossThreadRefCounted_h
#define CrossThreadRefCounted_h
#include <wtf/Noncopyable.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/Threading.h>
namespace WTF {
// Used to allowing sharing data across classes and threads (like ThreadedSafeShared).
//
// Why not just use ThreadSafeShared?
// ThreadSafeShared can have a significant perf impact when used in low level classes
// (like UString) that get ref/deref'ed a lot. This class has the benefit of doing fast ref
// counts like RefPtr whenever possible, but it has the downside that you need to copy it
// to use it on another thread.
//
// Is this class threadsafe?
// While each instance of the class is not threadsafe, the copied instance is threadsafe
// with respect to the original and any other copies. The underlying m_data is jointly
// owned by the original instance and all copies.
template<class T>
class CrossThreadRefCounted : Noncopyable {
public:
static PassRefPtr<CrossThreadRefCounted<T> > create(T* data)
{
return adoptRef(new CrossThreadRefCounted<T>(data, 0));
}
// Used to make an instance that can be used on another thread.
PassRefPtr<CrossThreadRefCounted<T> > crossThreadCopy();
void ref();
void deref();
T* release();
bool isShared() const
{
return !m_refCounter.hasOneRef() || (m_threadSafeRefCounter && !m_threadSafeRefCounter->hasOneRef());
}
#ifndef NDEBUG
bool mayBePassedToAnotherThread() const { ASSERT(!m_threadId); return m_refCounter.hasOneRef(); }
#endif
private:
CrossThreadRefCounted(T* data, ThreadSafeSharedBase* threadedCounter)
: m_threadSafeRefCounter(threadedCounter)
, m_data(data)
#ifndef NDEBUG
, m_threadId(0)
#endif
{
}
~CrossThreadRefCounted()
{
if (!m_threadSafeRefCounter)
delete m_data;
}
void threadSafeDeref();
RefCountedBase m_refCounter;
ThreadSafeSharedBase* m_threadSafeRefCounter;
T* m_data;
#ifndef NDEBUG
ThreadIdentifier m_threadId;
#endif
};
template<class T>
void CrossThreadRefCounted<T>::ref()
{
ASSERT(!m_threadId || m_threadId == currentThread());
m_refCounter.ref();
#ifndef NDEBUG
// Store the threadId as soon as the ref count gets to 2.
// The class gets created with a ref count of 1 and then passed
// to another thread where to ref count get increased. This
// is a heuristic but it seems to always work and has helped
// find some bugs.
if (!m_threadId && m_refCounter.refCount() == 2)
m_threadId = currentThread();
#endif
}
template<class T>
void CrossThreadRefCounted<T>::deref()
{
ASSERT(!m_threadId || m_threadId == currentThread());
if (m_refCounter.derefBase()) {
threadSafeDeref();
delete this;
} else {
#ifndef NDEBUG
// Clear the threadId when the ref goes to 1 because it
// is safe to be passed to another thread at this point.
if (m_threadId && m_refCounter.refCount() == 1)
m_threadId = 0;
#endif
}
}
template<class T>
T* CrossThreadRefCounted<T>::release()
{
ASSERT(!isShared());
T* data = m_data;
m_data = 0;
return data;
}
template<class T>
PassRefPtr<CrossThreadRefCounted<T> > CrossThreadRefCounted<T>::crossThreadCopy()
{
if (m_threadSafeRefCounter)
m_threadSafeRefCounter->ref();
else
m_threadSafeRefCounter = new ThreadSafeSharedBase(2);
return adoptRef(new CrossThreadRefCounted<T>(m_data, m_threadSafeRefCounter));
}
template<class T>
void CrossThreadRefCounted<T>::threadSafeDeref()
{
if (m_threadSafeRefCounter && m_threadSafeRefCounter->derefBase()) {
delete m_threadSafeRefCounter;
m_threadSafeRefCounter = 0;
}
}
} // namespace WTF
using WTF::CrossThreadRefCounted;
#endif // CrossThreadRefCounted_h
|
