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
|
/* -*- 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 "mozilla/layers/APZSampler.h"
#include "AsyncPanZoomController.h"
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/layers/APZThreadUtils.h"
#include "mozilla/layers/APZUtils.h"
#include "mozilla/layers/CompositorThread.h"
#include "mozilla/layers/SynchronousTask.h"
#include "TreeTraversal.h"
#include "mozilla/webrender/WebRenderAPI.h"
namespace mozilla {
namespace layers {
StaticMutex APZSampler::sWindowIdLock;
StaticAutoPtr<std::unordered_map<uint64_t, RefPtr<APZSampler>>>
APZSampler::sWindowIdMap;
APZSampler::APZSampler(const RefPtr<APZCTreeManager>& aApz,
bool aIsUsingWebRender)
: mApz(aApz),
mIsUsingWebRender(aIsUsingWebRender),
mThreadIdLock("APZSampler::mThreadIdLock"),
mSampleTimeLock("APZSampler::mSampleTimeLock") {
MOZ_ASSERT(aApz);
mApz->SetSampler(this);
}
APZSampler::~APZSampler() { mApz->SetSampler(nullptr); }
void APZSampler::Destroy() {
StaticMutexAutoLock lock(sWindowIdLock);
if (mWindowId) {
MOZ_ASSERT(sWindowIdMap);
sWindowIdMap->erase(wr::AsUint64(*mWindowId));
}
}
void APZSampler::SetWebRenderWindowId(const wr::WindowId& aWindowId) {
StaticMutexAutoLock lock(sWindowIdLock);
MOZ_ASSERT(!mWindowId);
mWindowId = Some(aWindowId);
if (!sWindowIdMap) {
sWindowIdMap = new std::unordered_map<uint64_t, RefPtr<APZSampler>>();
NS_DispatchToMainThread(NS_NewRunnableFunction(
"APZSampler::ClearOnShutdown", [] { ClearOnShutdown(&sWindowIdMap); }));
}
(*sWindowIdMap)[wr::AsUint64(aWindowId)] = this;
}
/*static*/
void APZSampler::SetSamplerThread(const wr::WrWindowId& aWindowId) {
if (RefPtr<APZSampler> sampler = GetSampler(aWindowId)) {
MutexAutoLock lock(sampler->mThreadIdLock);
sampler->mSamplerThreadId = Some(PlatformThread::CurrentId());
}
}
/*static*/
void APZSampler::SampleForWebRender(const wr::WrWindowId& aWindowId,
const uint64_t* aGeneratedFrameId,
wr::Transaction* aTransaction) {
if (RefPtr<APZSampler> sampler = GetSampler(aWindowId)) {
wr::TransactionWrapper txn(aTransaction);
Maybe<VsyncId> vsyncId =
aGeneratedFrameId ? Some(VsyncId{*aGeneratedFrameId}) : Nothing();
sampler->SampleForWebRender(vsyncId, txn);
}
}
void APZSampler::SetSampleTime(const SampleTime& aSampleTime) {
MOZ_ASSERT(CompositorThreadHolder::IsInCompositorThread());
MutexAutoLock lock(mSampleTimeLock);
// This only gets called with WR, and the time provided is going to be
// the time at which the current vsync interval ends. i.e. it is the timestamp
// for the next vsync that will occur.
mSampleTime = aSampleTime;
}
void APZSampler::SampleForWebRender(const Maybe<VsyncId>& aVsyncId,
wr::TransactionWrapper& aTxn) {
AssertOnSamplerThread();
SampleTime sampleTime;
{ // scope lock
MutexAutoLock lock(mSampleTimeLock);
// If mSampleTime is null we're in a startup phase where the
// WebRenderBridgeParent hasn't yet provided us with a sample time.
// If we're that early there probably aren't any APZ animations happening
// anyway, so using Timestamp::Now() should be fine.
SampleTime now = SampleTime::FromNow();
sampleTime = mSampleTime.IsNull() ? now : mSampleTime;
}
mApz->SampleForWebRender(aVsyncId, aTxn, sampleTime);
}
AsyncTransform APZSampler::GetCurrentAsyncTransform(
const LayersId& aLayersId, const ScrollableLayerGuid::ViewID& aScrollId,
AsyncTransformComponents aComponents,
const MutexAutoLock& aProofOfMapLock) const {
MOZ_ASSERT(!CompositorThreadHolder::IsInCompositorThread());
AssertOnSamplerThread();
RefPtr<AsyncPanZoomController> apzc =
mApz->GetTargetAPZC(aLayersId, aScrollId, aProofOfMapLock);
if (!apzc) {
// It's possible that this function can get called even after the target
// APZC has been already destroyed because destroying the animation which
// triggers this function call is basically processed later than the APZC,
// i.e. queue mCompositorAnimationsToDelete in WebRenderBridgeParent and
// then remove in WebRenderBridgeParent::RemoveEpochDataPriorTo.
return AsyncTransform{};
}
return apzc->GetCurrentAsyncTransform(AsyncPanZoomController::eForCompositing,
aComponents);
}
ParentLayerRect APZSampler::GetCompositionBounds(
const LayersId& aLayersId, const ScrollableLayerGuid::ViewID& aScrollId,
const MutexAutoLock& aProofOfMapLock) const {
// This function can get called on the compositor in case of non WebRender
// get called on the sampler thread in case of WebRender.
AssertOnSamplerThread();
RefPtr<AsyncPanZoomController> apzc =
mApz->GetTargetAPZC(aLayersId, aScrollId, aProofOfMapLock);
if (!apzc) {
// On WebRender it's possible that this function can get called even after
// the target APZC has been already destroyed because destroying the
// animation which triggers this function call is basically processed later
// than the APZC one, i.e. queue mCompositorAnimationsToDelete in
// WebRenderBridgeParent and then remove them in
// WebRenderBridgeParent::RemoveEpochDataPriorTo.
return ParentLayerRect();
}
return apzc->GetCompositionBounds();
}
Maybe<APZSampler::ScrollOffsetAndRange>
APZSampler::GetCurrentScrollOffsetAndRange(
const LayersId& aLayersId, const ScrollableLayerGuid::ViewID& aScrollId,
const MutexAutoLock& aProofOfMapLock) const {
// Note: This is called from OMTA Sampler thread, or Compositor thread for
// testing.
RefPtr<AsyncPanZoomController> apzc =
mApz->GetTargetAPZC(aLayersId, aScrollId, aProofOfMapLock);
if (!apzc) {
return Nothing();
}
return Some(ScrollOffsetAndRange{
// FIXME: Use the one-frame delayed offset now. This doesn't take
// scroll-linked effets into accounts, so we have to fix this in the
// future.
apzc->GetCurrentAsyncVisualViewport(
AsyncPanZoomController::AsyncTransformConsumer::eForCompositing)
.TopLeft(),
apzc->GetCurrentScrollRangeInCssPixels()});
}
void APZSampler::AssertOnSamplerThread() const {
if (APZThreadUtils::GetThreadAssertionsEnabled()) {
MOZ_ASSERT(IsSamplerThread());
}
}
bool APZSampler::IsSamplerThread() const {
if (mIsUsingWebRender) {
// If the sampler thread id isn't set yet then we cannot be running on the
// sampler thread (because we will have the thread id before we run any
// other C++ code on it, and this function is only ever invoked from C++
// code), so return false in that scenario.
MutexAutoLock lock(mThreadIdLock);
return mSamplerThreadId && PlatformThread::CurrentId() == *mSamplerThreadId;
}
return CompositorThreadHolder::IsInCompositorThread();
}
/*static*/
already_AddRefed<APZSampler> APZSampler::GetSampler(
const wr::WrWindowId& aWindowId) {
RefPtr<APZSampler> sampler;
StaticMutexAutoLock lock(sWindowIdLock);
if (sWindowIdMap) {
auto it = sWindowIdMap->find(wr::AsUint64(aWindowId));
if (it != sWindowIdMap->end()) {
sampler = it->second;
}
}
return sampler.forget();
}
} // namespace layers
} // namespace mozilla
void apz_register_sampler(mozilla::wr::WrWindowId aWindowId) {
mozilla::layers::APZSampler::SetSamplerThread(aWindowId);
}
void apz_sample_transforms(mozilla::wr::WrWindowId aWindowId,
const uint64_t* aGeneratedFrameId,
mozilla::wr::Transaction* aTransaction) {
mozilla::layers::APZSampler::SampleForWebRender(aWindowId, aGeneratedFrameId,
aTransaction);
}
void apz_deregister_sampler(mozilla::wr::WrWindowId aWindowId) {}
|
