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
|
/*
* Copyright (C) 2024 Igalia S.L.
*
* 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 "Compiler.h"
#include "DataLog.h"
#include "HashMap.h"
#include "Lock.h"
#include "StackShot.h"
#include "StackTrace.h"
#include <atomic>
namespace WTF {
// This file contains some tools for tracking references.
// See Strong.h for an example of how to use it.
#if ENABLE(REFTRACKER)
template<typename T>
struct RefTrackerLoggingDisabledScope {
WTF_MAKE_NONCOPYABLE(RefTrackerLoggingDisabledScope);
RefTrackerLoggingDisabledScope()
{
++T::refTrackerSingleton().loggingDisabledDepth;
}
~RefTrackerLoggingDisabledScope()
{
--T::refTrackerSingleton().loggingDisabledDepth;
}
};
struct RefTracker {
WTF_MAKE_FAST_ALLOCATED;
public:
RefTracker() = default;
~RefTracker() = default;
// NEVER_INLINE to make skipping frames more predictable.
WTF_EXPORT_PRIVATE void reportLive(void*);
WTF_EXPORT_PRIVATE void reportDead(void*);
WTF_EXPORT_PRIVATE void logAllLiveReferences();
Lock lock { };
UncheckedKeyHashMap<void*, std::unique_ptr<StackShot>> map WTF_GUARDED_BY_LOCK(lock) { };
std::atomic<int> loggingDisabledDepth { };
};
template<typename T>
struct RefTrackerMixin final {
ALWAYS_INLINE RefTrackerMixin()
{
RELEASE_ASSERT(!originalThis);
originalThis = this;
if (UNLIKELY(T::enabled()))
T::refTrackerSingleton().reportLive(static_cast<void*>(this));
}
ALWAYS_INLINE RefTrackerMixin(RefTrackerMixin<T>&&)
{
RELEASE_ASSERT(!originalThis);
originalThis = this;
if (UNLIKELY(T::enabled()))
T::refTrackerSingleton().reportLive(static_cast<void*>(this));
}
ALWAYS_INLINE RefTrackerMixin(const RefTrackerMixin<T>&)
{
RELEASE_ASSERT(!originalThis);
originalThis = this;
if (UNLIKELY(T::enabled()))
T::refTrackerSingleton().reportLive(static_cast<void*>(this));
}
ALWAYS_INLINE ~RefTrackerMixin()
{
RELEASE_ASSERT(originalThis == this);
if (UNLIKELY(T::enabled()))
T::refTrackerSingleton().reportDead(static_cast<void*>(this));
}
RefTrackerMixin& operator=(const RefTrackerMixin& o)
{
RELEASE_ASSERT(o.originalThis == &o);
RELEASE_ASSERT(originalThis == this);
return *this;
}
RefTrackerMixin& operator=(RefTrackerMixin&& o)
{
RELEASE_ASSERT(o.originalThis == &o);
RELEASE_ASSERT(originalThis == this);
return *this;
}
// This guards against seeing an unconstructed object (say, if we are zero-initialized)
RefTrackerMixin* originalThis = nullptr;
};
#define REFTRACKER_DECL(T, initializer) \
struct T final { \
inline static bool enabled() { \
initializer \
return Options::enable ## T(); \
} \
WTF_EXPORT_PRIVATE static WTF::RefTracker& refTrackerSingleton(); \
};
#define REFTRACKER_MEMBERS(T) \
WTF::RefTrackerMixin<T> m_refTrackerData;
#define REFTRACKER_IMPL(T) \
WTF::RefTracker& T::refTrackerSingleton() \
{ \
static WTF::LazyNeverDestroyed<WTF::RefTracker> s_singleton; \
static std::once_flag s_onceFlag; \
std::call_once(s_onceFlag, \
[] { \
s_singleton.construct(); \
}); \
return s_singleton.get(); \
}
#else // ENABLE(REFTRACKER)
#define REFTRACKER_DECL(_, initializer)
#define REFTRACKER_MEMBERS(_)
#define REFTRACKER_IMPL(_)
#endif
} // namespace WTF
|
