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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "CheckerboardReportService.h"
#include "jsapi.h" // for JS_Now
#include "MainThreadUtils.h" // for NS_IsMainThread
#include "mozilla/Assertions.h" // for MOZ_ASSERT
#include "mozilla/ClearOnShutdown.h" // for ClearOnShutdown
#include "mozilla/Preferences.h"
#include "mozilla/Services.h"
#include "mozilla/StaticPrefs_apz.h"
#include "mozilla/Unused.h"
#include "mozilla/dom/CheckerboardReportServiceBinding.h" // for dom::CheckerboardReports
#include "mozilla/gfx/GPUParent.h"
#include "mozilla/gfx/GPUProcessManager.h"
#include "nsContentUtils.h" // for nsContentUtils
#include "nsIObserverService.h"
#include "nsXULAppAPI.h"
namespace mozilla {
namespace layers {
/*static*/
StaticRefPtr<CheckerboardEventStorage> CheckerboardEventStorage::sInstance;
/*static*/
already_AddRefed<CheckerboardEventStorage>
CheckerboardEventStorage::GetInstance() {
// The instance in the parent process does all the work, so if this is getting
// called in the child process something is likely wrong.
MOZ_ASSERT(XRE_IsParentProcess());
MOZ_ASSERT(NS_IsMainThread());
if (!sInstance) {
sInstance = new CheckerboardEventStorage();
ClearOnShutdown(&sInstance);
}
RefPtr<CheckerboardEventStorage> instance = sInstance.get();
return instance.forget();
}
void CheckerboardEventStorage::Report(uint32_t aSeverity,
const std::string& aLog) {
if (!NS_IsMainThread()) {
RefPtr<Runnable> task = NS_NewRunnableFunction(
"layers::CheckerboardEventStorage::Report",
[aSeverity, aLog]() -> void {
CheckerboardEventStorage::Report(aSeverity, aLog);
});
NS_DispatchToMainThread(task.forget());
return;
}
if (XRE_IsGPUProcess()) {
if (gfx::GPUParent* gpu = gfx::GPUParent::GetSingleton()) {
nsCString log(aLog.c_str());
Unused << gpu->SendReportCheckerboard(aSeverity, log);
}
return;
}
RefPtr<CheckerboardEventStorage> storage = GetInstance();
storage->ReportCheckerboard(aSeverity, aLog);
}
void CheckerboardEventStorage::ReportCheckerboard(uint32_t aSeverity,
const std::string& aLog) {
MOZ_ASSERT(NS_IsMainThread());
if (aSeverity == 0) {
// This code assumes all checkerboard reports have a nonzero severity.
return;
}
CheckerboardReport severe(aSeverity, JS_Now(), aLog);
CheckerboardReport recent;
// First look in the "severe" reports to see if the new one belongs in that
// list.
for (int i = 0; i < SEVERITY_MAX_INDEX; i++) {
if (mCheckerboardReports[i].mSeverity >= severe.mSeverity) {
continue;
}
// The new one deserves to be in the "severe" list. Take the one getting
// bumped off the list, and put it in |recent| for possible insertion into
// the recents list.
recent = mCheckerboardReports[SEVERITY_MAX_INDEX - 1];
// Shuffle the severe list down, insert the new one.
for (int j = SEVERITY_MAX_INDEX - 1; j > i; j--) {
mCheckerboardReports[j] = mCheckerboardReports[j - 1];
}
mCheckerboardReports[i] = severe;
severe.mSeverity = 0; // mark |severe| as inserted
break;
}
// If |severe.mSeverity| is nonzero, the incoming report didn't get inserted
// into the severe list; put it into |recent| for insertion into the recent
// list.
if (severe.mSeverity) {
MOZ_ASSERT(recent.mSeverity == 0, "recent should be empty here");
recent = severe;
} // else |recent| may hold a report that got knocked out of the severe list.
if (recent.mSeverity == 0) {
// Nothing to be inserted into the recent list.
return;
}
// If it wasn't in the "severe" list, add it to the "recent" list.
for (int i = SEVERITY_MAX_INDEX; i < RECENT_MAX_INDEX; i++) {
if (mCheckerboardReports[i].mTimestamp >= recent.mTimestamp) {
continue;
}
// |recent| needs to be inserted at |i|. Shuffle the remaining ones down
// and insert it.
for (int j = RECENT_MAX_INDEX - 1; j > i; j--) {
mCheckerboardReports[j] = mCheckerboardReports[j - 1];
}
mCheckerboardReports[i] = recent;
break;
}
}
void CheckerboardEventStorage::GetReports(
nsTArray<dom::CheckerboardReport>& aOutReports) {
MOZ_ASSERT(NS_IsMainThread());
for (int i = 0; i < RECENT_MAX_INDEX; i++) {
CheckerboardReport& r = mCheckerboardReports[i];
if (r.mSeverity == 0) {
continue;
}
dom::CheckerboardReport report;
report.mSeverity.Construct() = r.mSeverity;
report.mTimestamp.Construct() = r.mTimestamp / 1000; // micros to millis
report.mLog.Construct() =
NS_ConvertUTF8toUTF16(r.mLog.c_str(), r.mLog.size());
report.mReason.Construct() = (i < SEVERITY_MAX_INDEX)
? dom::CheckerboardReason::Severe
: dom::CheckerboardReason::Recent;
aOutReports.AppendElement(report);
}
}
} // namespace layers
namespace dom {
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(CheckerboardReportService, mParent)
/*static*/
bool CheckerboardReportService::IsEnabled(JSContext* aCtx, JSObject* aGlobal) {
// Only allow this in the parent process
if (!XRE_IsParentProcess()) {
return false;
}
// Allow privileged code or about:checkerboard (unprivileged) to access this.
return nsContentUtils::IsSystemCaller(aCtx) ||
nsContentUtils::IsSpecificAboutPage(aGlobal, "about:checkerboard");
}
/*static*/
already_AddRefed<CheckerboardReportService>
CheckerboardReportService::Constructor(const dom::GlobalObject& aGlobal) {
RefPtr<CheckerboardReportService> ces =
new CheckerboardReportService(aGlobal.GetAsSupports());
return ces.forget();
}
CheckerboardReportService::CheckerboardReportService(nsISupports* aParent)
: mParent(aParent) {}
JSObject* CheckerboardReportService::WrapObject(
JSContext* aCtx, JS::Handle<JSObject*> aGivenProto) {
return CheckerboardReportService_Binding::Wrap(aCtx, this, aGivenProto);
}
nsISupports* CheckerboardReportService::GetParentObject() { return mParent; }
void CheckerboardReportService::GetReports(
nsTArray<dom::CheckerboardReport>& aOutReports) {
RefPtr<mozilla::layers::CheckerboardEventStorage> instance =
mozilla::layers::CheckerboardEventStorage::GetInstance();
MOZ_ASSERT(instance);
instance->GetReports(aOutReports);
}
bool CheckerboardReportService::IsRecordingEnabled() const {
return StaticPrefs::apz_record_checkerboarding();
}
void CheckerboardReportService::SetRecordingEnabled(bool aEnabled) {
Preferences::SetBool("apz.record_checkerboarding", aEnabled);
}
void CheckerboardReportService::FlushActiveReports() {
MOZ_ASSERT(XRE_IsParentProcess());
gfx::GPUProcessManager* gpu = gfx::GPUProcessManager::Get();
if (gpu && gpu->NotifyGpuObservers("APZ:FlushActiveCheckerboard")) {
return;
}
nsCOMPtr<nsIObserverService> obsSvc = mozilla::services::GetObserverService();
MOZ_ASSERT(obsSvc);
if (obsSvc) {
obsSvc->NotifyObservers(nullptr, "APZ:FlushActiveCheckerboard", nullptr);
}
}
} // namespace dom
} // namespace mozilla
|
