forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
call_stack_profile_metrics_provider.cc
238 lines (180 loc) · 8.28 KB
/
call_stack_profile_metrics_provider.cc
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/metrics/call_stack_profile_metrics_provider.h"
#include <utility>
#include <vector>
#include "base/bind.h"
#include "base/macros.h"
#include "base/memory/singleton.h"
#include "base/synchronization/lock.h"
#include "base/time/time.h"
#include "third_party/metrics_proto/chrome_user_metrics_extension.pb.h"
namespace metrics {
namespace {
// Cap the number of pending profiles to avoid excessive memory usage when
// profile uploads are delayed (e.g. due to being offline). 1250 profiles
// corresponds to 80MB of storage. Capping at this threshold loses approximately
// 0.5% of profiles on canary and dev.
// TODO(chengx): Remove this threshold after moving to a more memory-efficient
// profile representation.
const size_t kMaxPendingProfiles = 1250;
// ProfileState --------------------------------------------------------------
// A set of profiles and the start time of the collection associated with them.
struct ProfileState {
ProfileState(base::TimeTicks start_timestamp, SampledProfile profile);
ProfileState(ProfileState&&);
ProfileState& operator=(ProfileState&&);
// The time at which the profile collection was started.
base::TimeTicks start_timestamp;
// The call stack profile message collected by the profiler.
SampledProfile profile;
private:
DISALLOW_COPY_AND_ASSIGN(ProfileState);
};
ProfileState::ProfileState(base::TimeTicks start_timestamp,
SampledProfile profile)
: start_timestamp(start_timestamp), profile(std::move(profile)) {}
ProfileState::ProfileState(ProfileState&&) = default;
// Some versions of GCC need this for push_back to work with std::move.
ProfileState& ProfileState::operator=(ProfileState&&) = default;
// PendingProfiles ------------------------------------------------------------
// Singleton class responsible for retaining profiles received via the callback
// created by GetProfilerCallback(). These are then sent to UMA on the
// invocation of CallStackProfileMetricsProvider::ProvideCurrentSessionData().
// We need to store the profiles outside of a CallStackProfileMetricsProvider
// instance since callers may start profiling before the
// CallStackProfileMetricsProvider is created.
//
// Member functions on this class may be called on any thread.
class PendingProfiles {
public:
static PendingProfiles* GetInstance();
void Swap(std::vector<ProfileState>* profiles);
// Enables the collection of profiles by CollectProfilesIfCollectionEnabled if
// |enabled| is true. Otherwise, clears current profiles and ignores profiles
// provided to future invocations of CollectProfilesIfCollectionEnabled.
void SetCollectionEnabled(bool enabled);
// True if profiles are being collected.
bool IsCollectionEnabled() const;
// Adds |profile| to the list of profiles if collection is enabled; it is
// not const& because it must be passed with std::move.
void CollectProfilesIfCollectionEnabled(ProfileState profile);
// Allows testing against the initial state multiple times.
void ResetToDefaultStateForTesting();
private:
friend struct base::DefaultSingletonTraits<PendingProfiles>;
PendingProfiles();
~PendingProfiles() = default;
mutable base::Lock lock_;
// If true, profiles provided to CollectProfilesIfCollectionEnabled should be
// collected. Otherwise they will be ignored.
bool collection_enabled_;
// The last time collection was disabled. Used to determine if collection was
// disabled at any point since a profile was started.
base::TimeTicks last_collection_disable_time_;
// The set of completed profiles that should be reported.
std::vector<ProfileState> profiles_;
DISALLOW_COPY_AND_ASSIGN(PendingProfiles);
};
// static
PendingProfiles* PendingProfiles::GetInstance() {
// Leaky for performance rather than correctness reasons.
return base::Singleton<PendingProfiles,
base::LeakySingletonTraits<PendingProfiles>>::get();
}
void PendingProfiles::Swap(std::vector<ProfileState>* profiles) {
base::AutoLock scoped_lock(lock_);
profiles_.swap(*profiles);
}
void PendingProfiles::SetCollectionEnabled(bool enabled) {
base::AutoLock scoped_lock(lock_);
collection_enabled_ = enabled;
if (!collection_enabled_) {
profiles_.clear();
last_collection_disable_time_ = base::TimeTicks::Now();
}
}
bool PendingProfiles::IsCollectionEnabled() const {
base::AutoLock scoped_lock(lock_);
return collection_enabled_;
}
void PendingProfiles::CollectProfilesIfCollectionEnabled(ProfileState profile) {
base::AutoLock scoped_lock(lock_);
// Only collect if collection is not disabled and hasn't been disabled
// since the start of collection for this profile.
if (!collection_enabled_ ||
(!last_collection_disable_time_.is_null() &&
last_collection_disable_time_ >= profile.start_timestamp)) {
return;
}
if (profiles_.size() < kMaxPendingProfiles)
profiles_.push_back(std::move(profile));
}
void PendingProfiles::ResetToDefaultStateForTesting() {
base::AutoLock scoped_lock(lock_);
collection_enabled_ = true;
last_collection_disable_time_ = base::TimeTicks();
profiles_.clear();
}
// |collection_enabled_| is initialized to true to collect any profiles that are
// generated prior to creation of the CallStackProfileMetricsProvider. The
// ultimate disposition of these pre-creation collected profiles will be
// determined by the initial recording state provided to
// CallStackProfileMetricsProvider.
PendingProfiles::PendingProfiles() : collection_enabled_(true) {}
// Functions to process completed profile ------------------------------------
// Will be invoked on either the main thread or the profiler's thread. Provides
// the profile to PendingProfiles to append, if the collecting state allows.
void ReceiveCompletedProfileImpl(base::TimeTicks start_timestamp,
SampledProfile profile) {
PendingProfiles::GetInstance()->CollectProfilesIfCollectionEnabled(
ProfileState(start_timestamp, std::move(profile)));
}
// Invoked on an arbitrary thread. Ignores the provided profile.
void IgnoreCompletedProfile(SampledProfile profile) {}
} // namespace
// CallStackProfileMetricsProvider --------------------------------------------
const base::Feature CallStackProfileMetricsProvider::kEnableReporting = {
"SamplingProfilerReporting", base::FEATURE_DISABLED_BY_DEFAULT};
CallStackProfileMetricsProvider::CallStackProfileMetricsProvider() {}
CallStackProfileMetricsProvider::~CallStackProfileMetricsProvider() {}
CallStackProfileBuilder::CompletedCallback
CallStackProfileMetricsProvider::GetProfilerCallbackForBrowserProcess() {
// Ignore the profile if the collection is disabled. If the collection state
// changes while collecting, this will be detected by the callback and
// profile will be ignored at that point.
if (!PendingProfiles::GetInstance()->IsCollectionEnabled())
return base::BindRepeating(&IgnoreCompletedProfile);
return base::BindRepeating(&ReceiveCompletedProfileImpl,
base::TimeTicks::Now());
}
// static
void CallStackProfileMetricsProvider::ReceiveCompletedProfile(
base::TimeTicks profile_start_time,
SampledProfile profile) {
ReceiveCompletedProfileImpl(profile_start_time, std::move(profile));
}
void CallStackProfileMetricsProvider::OnRecordingEnabled() {
PendingProfiles::GetInstance()->SetCollectionEnabled(
base::FeatureList::IsEnabled(kEnableReporting));
}
void CallStackProfileMetricsProvider::OnRecordingDisabled() {
PendingProfiles::GetInstance()->SetCollectionEnabled(false);
}
void CallStackProfileMetricsProvider::ProvideCurrentSessionData(
ChromeUserMetricsExtension* uma_proto) {
std::vector<ProfileState> pending_profiles;
PendingProfiles::GetInstance()->Swap(&pending_profiles);
DCHECK(base::FeatureList::IsEnabled(kEnableReporting) ||
pending_profiles.empty());
for (const auto& profile_state : pending_profiles) {
SampledProfile* sampled_profile = uma_proto->add_sampled_profile();
*sampled_profile = std::move(profile_state.profile);
}
}
// static
void CallStackProfileMetricsProvider::ResetStaticStateForTesting() {
PendingProfiles::GetInstance()->ResetToDefaultStateForTesting();
}
} // namespace metrics