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
|
/*
* Copyright (C) 2006, 2007, 2008, 2009, 2010, 2013, 2025 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include <wtf/Assertions.h>
#include <wtf/Compiler.h>
#include <wtf/FastMalloc.h>
#include <wtf/MainThread.h>
#include <wtf/Noncopyable.h>
#include <wtf/SwiftBridging.h>
namespace WTF {
#if ASSERT_ENABLED || ENABLE(SECURITY_ASSERTIONS)
#define CHECK_REF_COUNTED_LIFECYCLE 1
#else
#define CHECK_REF_COUNTED_LIFECYCLE 0
#endif
// This base class holds debugging code, to share among refcounting subclasses.
class RefCountDebugger {
public:
enum class RefCountIsThreadSafe : bool { No, Yes };
WTF_EXPORT_PRIVATE static void logRefDuringDestruction(const void*);
WTF_EXPORT_PRIVATE static void printRefDuringDestructionLogAndCrash (const void*) NO_RETURN_DUE_TO_CRASH;
void willRef(unsigned refCount, RefCountIsThreadSafe isThreadSafe = RefCountIsThreadSafe::No) const
{
applyRefDerefThreadingCheck(refCount, isThreadSafe);
applyRefDuringDestructionCheck();
#if CHECK_REF_COUNTED_LIFECYCLE
ASSERT(!m_adoptionIsRequired);
#endif
}
void relaxAdoptionRequirement()
{
#if CHECK_REF_COUNTED_LIFECYCLE
ASSERT(m_adoptionIsRequired);
m_adoptionIsRequired = false;
#endif
}
// Unsafe precondition: The caller must ensure thread-safe access to this object,
// for example by using a mutex.
void disableThreadingChecks()
{
#if ASSERT_ENABLED
m_areThreadingChecksEnabled = false;
#endif
}
static void enableThreadingChecksGlobally()
{
#if ASSERT_ENABLED
areThreadingChecksEnabledGlobally = true;
#endif
}
protected:
RefCountDebugger()
#if ASSERT_ENABLED
: m_isOwnedByMainThread(isMainThread())
#endif
{
}
void applyRefDuringDestructionCheck() const
{
#if CHECK_REF_COUNTED_LIFECYCLE
if (!m_deletionHasBegun)
return;
logRefDuringDestruction(this);
#endif
}
void applyRefDerefThreadingCheck(unsigned refCount, RefCountIsThreadSafe isThreadSafe = RefCountIsThreadSafe::No) const
{
UNUSED_PARAM(refCount);
UNUSED_PARAM(isThreadSafe);
#if ASSERT_ENABLED
if (isThreadSafe == RefCountIsThreadSafe::Yes)
return;
if (refCount == 1) {
// Likely an ownership transfer across threads that may be safe.
m_isOwnedByMainThread = isMainThread();
} else if (areThreadingChecksEnabledGlobally && m_areThreadingChecksEnabled) {
// If you hit this assertion, it means that the RefCounted object was ref/deref'd
// from both the main thread and another in a way that is likely concurrent and unsafe.
// Derive from ThreadSafeRefCounted and make sure the destructor is safe on threads
// that call deref, or ref/deref from a single thread.
ASSERT_WITH_MESSAGE(m_isOwnedByMainThread == isMainThread(), "Unsafe to ref/deref from different threads");
}
#endif
}
~RefCountDebugger()
{
#if CHECK_REF_COUNTED_LIFECYCLE
ASSERT(m_deletionHasBegun);
ASSERT(!m_adoptionIsRequired);
#endif
}
void willDestroy(unsigned refCount) const
{
UNUSED_PARAM(refCount);
#if CHECK_REF_COUNTED_LIFECYCLE
if (refCount == 1)
return;
printRefDuringDestructionLogAndCrash(this);
#endif
}
void willDelete() const
{
#if CHECK_REF_COUNTED_LIFECYCLE
m_deletionHasBegun = true;
#endif
}
void willDeref(unsigned refCount, RefCountIsThreadSafe isThreadSafe = RefCountIsThreadSafe::No) const
{
applyRefDerefThreadingCheck(refCount, isThreadSafe);
#if CHECK_REF_COUNTED_LIFECYCLE
ASSERT(!m_adoptionIsRequired);
#endif
ASSERT(refCount);
}
#if CHECK_REF_COUNTED_LIFECYCLE
bool deletionHasBegun() const
{
return m_deletionHasBegun;
}
#endif
private:
#if CHECK_REF_COUNTED_LIFECYCLE
friend void adopted(RefCountDebugger*);
#endif
#if ASSERT_ENABLED
mutable bool m_isOwnedByMainThread;
bool m_areThreadingChecksEnabled { true };
#endif
WTF_EXPORT_PRIVATE static bool areThreadingChecksEnabledGlobally;
#if CHECK_REF_COUNTED_LIFECYCLE
mutable std::atomic<bool> m_deletionHasBegun { false };
mutable bool m_adoptionIsRequired { true };
#endif
};
#if CHECK_REF_COUNTED_LIFECYCLE
inline void adopted(RefCountDebugger* object)
{
if (!object)
return;
object->m_adoptionIsRequired = false;
}
#endif
} // namespace WTF
|
