forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlayer_tree_host.cc
1993 lines (1715 loc) · 71.7 KB
/
layer_tree_host.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2011 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 "cc/trees/layer_tree_host.h"
#include <stddef.h>
#include <stdint.h>
#include <algorithm>
#include <memory>
#include <string>
#include "base/atomic_sequence_num.h"
#include "base/auto_reset.h"
#include "base/bind.h"
#include "base/command_line.h"
#include "base/containers/adapters.h"
#include "base/containers/contains.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/numerics/safe_math.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/task/single_thread_task_runner.h"
#include "base/threading/thread_task_runner_handle.h"
#include "base/timer/elapsed_timer.h"
#include "base/trace_event/trace_event.h"
#include "base/trace_event/traced_value.h"
#include "build/build_config.h"
#include "cc/base/devtools_instrumentation.h"
#include "cc/base/features.h"
#include "cc/base/histograms.h"
#include "cc/base/math_util.h"
#include "cc/debug/rendering_stats_instrumentation.h"
#include "cc/document_transition/document_transition_request.h"
#include "cc/input/layer_selection_bound.h"
#include "cc/input/overscroll_behavior.h"
#include "cc/input/page_scale_animation.h"
#include "cc/layers/heads_up_display_layer.h"
#include "cc/layers/heads_up_display_layer_impl.h"
#include "cc/layers/layer.h"
#include "cc/layers/painted_scrollbar_layer.h"
#include "cc/metrics/ukm_smoothness_data.h"
#include "cc/paint/paint_worklet_layer_painter.h"
#include "cc/resources/ui_resource_manager.h"
#include "cc/tiles/raster_dark_mode_filter.h"
#include "cc/trees/clip_node.h"
#include "cc/trees/commit_state.h"
#include "cc/trees/compositor_commit_data.h"
#include "cc/trees/draw_property_utils.h"
#include "cc/trees/effect_node.h"
#include "cc/trees/layer_tree_host_client.h"
#include "cc/trees/layer_tree_host_impl.h"
#include "cc/trees/layer_tree_impl.h"
#include "cc/trees/mobile_optimized_viewport_util.h"
#include "cc/trees/mutator_host.h"
#include "cc/trees/paint_holding_reason.h"
#include "cc/trees/property_tree_builder.h"
#include "cc/trees/proxy_main.h"
#include "cc/trees/render_frame_metadata_observer.h"
#include "cc/trees/scroll_node.h"
#include "cc/trees/single_thread_proxy.h"
#include "cc/trees/swap_promise_manager.h"
#include "cc/trees/transform_node.h"
#include "cc/trees/tree_synchronizer.h"
#include "cc/trees/ukm_manager.h"
#include "components/viz/common/features.h"
#include "components/viz/common/frame_sinks/copy_output_request.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "services/tracing/public/cpp/perfetto/flow_event_utils.h"
#include "services/tracing/public/cpp/perfetto/macros.h"
#include "ui/gfx/geometry/size_conversions.h"
#include "ui/gfx/geometry/vector2d_conversions.h"
#include "ui/gfx/presentation_feedback.h"
namespace {
static base::AtomicSequenceNumber s_layer_tree_host_sequence_number;
static base::AtomicSequenceNumber s_image_decode_sequence_number;
} // namespace
namespace cc {
namespace {
bool AreEmbedTokensEqual(const viz::LocalSurfaceId& lsi1,
const viz::LocalSurfaceId& lsi2) {
return lsi1.embed_token() == lsi2.embed_token();
}
bool AreParentSequencesEqual(const viz::LocalSurfaceId& lsi1,
const viz::LocalSurfaceId& lsi2) {
return lsi1.parent_sequence_number() == lsi2.parent_sequence_number();
}
} // namespace
LayerTreeHost::InitParams::InitParams() = default;
LayerTreeHost::InitParams::~InitParams() = default;
LayerTreeHost::InitParams::InitParams(InitParams&&) = default;
LayerTreeHost::InitParams& LayerTreeHost::InitParams::operator=(InitParams&&) =
default;
LayerTreeHost::ScrollAnimationState::ScrollAnimationState() = default;
LayerTreeHost::ScrollAnimationState::~ScrollAnimationState() = default;
std::unique_ptr<LayerTreeHost> LayerTreeHost::CreateThreaded(
scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner,
InitParams params) {
DCHECK(params.settings);
scoped_refptr<base::SingleThreadTaskRunner> main_task_runner =
params.main_task_runner;
DCHECK(main_task_runner);
DCHECK(impl_task_runner);
auto layer_tree_host = base::WrapUnique(
new LayerTreeHost(std::move(params), CompositorMode::THREADED));
layer_tree_host->InitializeThreaded(std::move(main_task_runner),
std::move(impl_task_runner));
return layer_tree_host;
}
std::unique_ptr<LayerTreeHost> LayerTreeHost::CreateSingleThreaded(
LayerTreeHostSingleThreadClient* single_thread_client,
InitParams params) {
DCHECK(params.settings);
scoped_refptr<base::SingleThreadTaskRunner> main_task_runner =
params.main_task_runner;
auto layer_tree_host = base::WrapUnique(
new LayerTreeHost(std::move(params), CompositorMode::SINGLE_THREADED));
layer_tree_host->InitializeSingleThreaded(single_thread_client,
std::move(main_task_runner));
return layer_tree_host;
}
LayerTreeHost::LayerTreeHost(InitParams params, CompositorMode mode)
: micro_benchmark_controller_(this),
image_worker_task_runner_(std::move(params.image_worker_task_runner)),
ukm_recorder_factory_(std::move(params.ukm_recorder_factory)),
compositor_mode_(mode),
ui_resource_manager_(std::make_unique<UIResourceManager>()),
client_(params.client),
scheduling_client_(params.scheduling_client),
rendering_stats_instrumentation_(RenderingStatsInstrumentation::Create()),
pending_commit_state_(std::make_unique<CommitState>()),
thread_unsafe_commit_state_(params.mutator_host, *this),
settings_(*params.settings),
id_(s_layer_tree_host_sequence_number.GetNext() + 1),
task_graph_runner_(params.task_graph_runner),
mutator_host_(params.mutator_host),
dark_mode_filter_(params.dark_mode_filter) {
DCHECK(task_graph_runner_);
DCHECK(!settings_.enable_checker_imaging || image_worker_task_runner_);
pending_commit_state_->needs_gpu_rasterization_histogram =
(mode == CompositorMode::THREADED);
pending_commit_state_->needs_full_tree_sync = true;
pending_commit_state_->debug_state = settings_.initial_debug_state;
rendering_stats_instrumentation_->set_record_rendering_stats(
pending_commit_state_->debug_state.RecordRenderingStats());
}
bool LayerTreeHost::IsMobileOptimized() const {
gfx::SizeF scrollable_viewport_size;
const auto* inner_node = property_trees()->scroll_tree().Node(
pending_commit_state()->viewport_property_ids.inner_scroll);
if (!inner_node)
scrollable_viewport_size = gfx::SizeF();
else
scrollable_viewport_size = gfx::ScaleSize(
gfx::SizeF(inner_node->container_bounds),
1.0f / (pending_commit_state()->external_page_scale_factor *
page_scale_factor()));
gfx::SizeF scrollable_size;
const auto* scroll_node = property_trees()->scroll_tree().Node(
pending_commit_state()->viewport_property_ids.outer_scroll);
if (!scroll_node) {
DCHECK(!inner_node);
scrollable_size = gfx::SizeF();
} else {
const auto& scroll_tree = property_trees()->scroll_tree();
auto size = scroll_tree.scroll_bounds(scroll_node->id);
size.SetToMax(gfx::SizeF(scroll_tree.container_bounds(scroll_node->id)));
scrollable_size = size;
}
return util::IsMobileOptimized(
min_page_scale_factor(), max_page_scale_factor(), page_scale_factor(),
scrollable_viewport_size, scrollable_size,
pending_commit_state()->is_viewport_mobile_optimized);
}
void LayerTreeHost::InitializeThreaded(
scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner) {
task_runner_provider_ =
TaskRunnerProvider::Create(main_task_runner, impl_task_runner);
std::unique_ptr<ProxyMain> proxy_main =
std::make_unique<ProxyMain>(this, task_runner_provider_.get());
InitializeProxy(std::move(proxy_main));
}
void LayerTreeHost::InitializeSingleThreaded(
LayerTreeHostSingleThreadClient* single_thread_client,
scoped_refptr<base::SingleThreadTaskRunner> main_task_runner) {
task_runner_provider_ = TaskRunnerProvider::Create(main_task_runner, nullptr);
InitializeProxy(SingleThreadProxy::Create(this, single_thread_client,
task_runner_provider_.get()));
}
void LayerTreeHost::InitializeForTesting(
std::unique_ptr<TaskRunnerProvider> task_runner_provider,
std::unique_ptr<Proxy> proxy_for_testing) {
task_runner_provider_ = std::move(task_runner_provider);
InitializeProxy(std::move(proxy_for_testing));
}
void LayerTreeHost::SetTaskRunnerProviderForTesting(
std::unique_ptr<TaskRunnerProvider> task_runner_provider) {
DCHECK(!task_runner_provider_);
task_runner_provider_ = std::move(task_runner_provider);
// This is done in InitializeProxy(), but not all tests call it.
mutator_host_->SetMutatorHostClient(this);
}
void LayerTreeHost::SetUIResourceManagerForTesting(
std::unique_ptr<UIResourceManager> ui_resource_manager) {
ui_resource_manager_ = std::move(ui_resource_manager);
}
void LayerTreeHost::InitializeProxy(std::unique_ptr<Proxy> proxy) {
TRACE_EVENT0("cc", "LayerTreeHost::InitializeForReal");
DCHECK(task_runner_provider_);
DCHECK(IsMainThread());
mutator_host_->SetMutatorHostClient(this);
proxy_ = std::move(proxy);
proxy_->Start();
UpdateDeferMainFrameUpdateInternal();
}
LayerTreeHost::~LayerTreeHost() {
// Track when we're inside a main frame to see if compositor is being
// destroyed midway which causes a crash. crbug.com/895883
CHECK(!inside_main_frame_);
DCHECK(!in_commit());
TRACE_EVENT0("cc", "LayerTreeHost::~LayerTreeHost");
// Clear any references into the LayerTreeHost.
mutator_host()->SetMutatorHostClient(nullptr);
if (root_layer()) {
root_layer()->SetLayerTreeHost(nullptr);
// The root layer must be destroyed before the layer tree. We've made a
// contract with our animation controllers that the animation_host will
// outlive them, and we must make good.
thread_unsafe_commit_state().root_layer = nullptr;
}
// Fail any pending image decodes.
for (auto& pair : pending_image_decodes_)
std::move(pair.second).Run(false);
if (proxy_) {
proxy_->Stop();
// Proxy must be destroyed before the Task Runner Provider.
proxy_ = nullptr;
}
}
int LayerTreeHost::GetId() const {
return id_;
}
int LayerTreeHost::SourceFrameNumber() const {
return pending_commit_state()->source_frame_number;
}
UIResourceManager* LayerTreeHost::GetUIResourceManager() {
DCHECK(IsMainThread());
return ui_resource_manager_.get();
}
TaskRunnerProvider* LayerTreeHost::GetTaskRunnerProvider() {
return task_runner_provider_.get();
}
bool LayerTreeHost::IsMainThread() const {
return task_runner_provider_ && task_runner_provider_->IsMainThread();
}
bool LayerTreeHost::IsImplThread() const {
return task_runner_provider_ && task_runner_provider_->IsImplThread();
}
bool LayerTreeHost::IsOwnerThread() const {
return task_runner_provider_->MainThreadTaskRunner()
->RunsTasksInCurrentSequence();
}
bool LayerTreeHost::InProtectedSequence() const {
return in_commit();
}
SwapPromiseManager* LayerTreeHost::GetSwapPromiseManager() {
DCHECK(IsMainThread());
return &swap_promise_manager_;
}
std::unique_ptr<EventsMetricsManager::ScopedMonitor>
LayerTreeHost::GetScopedEventMetricsMonitor(
EventsMetricsManager::ScopedMonitor::DoneCallback done_callback) {
DCHECK(IsMainThread());
return events_metrics_manager_.GetScopedMonitor(std::move(done_callback));
}
void LayerTreeHost::ClearEventsMetrics() {
// Take events metrics and drop them.
DCHECK(IsMainThread());
events_metrics_manager_.TakeSavedEventsMetrics();
}
const LayerTreeSettings& LayerTreeHost::GetSettings() const {
DCHECK(IsMainThread());
return settings_;
}
void LayerTreeHost::QueueSwapPromise(
std::unique_ptr<SwapPromise> swap_promise) {
DCHECK(IsMainThread());
swap_promise_manager_.QueueSwapPromise(std::move(swap_promise));
}
void LayerTreeHost::WillBeginMainFrame() {
DCHECK(IsMainThread());
inside_main_frame_ = true;
devtools_instrumentation::WillBeginMainThreadFrame(GetId(),
SourceFrameNumber());
client_->WillBeginMainFrame();
}
void LayerTreeHost::DidBeginMainFrame() {
DCHECK(IsMainThread());
inside_main_frame_ = false;
client_->DidBeginMainFrame();
}
void LayerTreeHost::BeginMainFrameNotExpectedSoon() {
DCHECK(IsMainThread());
client_->BeginMainFrameNotExpectedSoon();
}
void LayerTreeHost::BeginMainFrameNotExpectedUntil(base::TimeTicks time) {
DCHECK(IsMainThread());
client_->BeginMainFrameNotExpectedUntil(time);
}
void LayerTreeHost::BeginMainFrame(const viz::BeginFrameArgs& args) {
DCHECK(IsMainThread());
client_->BeginMainFrame(args);
}
const LayerTreeDebugState& LayerTreeHost::GetDebugState() const {
return pending_commit_state()->debug_state;
}
void LayerTreeHost::RequestMainFrameUpdate(bool report_metrics) {
DCHECK(IsMainThread());
client_->UpdateLayerTreeHost();
if (report_metrics)
pending_commit_state()->begin_main_frame_metrics =
client_->GetBeginMainFrameMetrics();
else
pending_commit_state()->begin_main_frame_metrics.reset();
}
void LayerTreeHost::ImageDecodesFinished(
const std::vector<std::pair<int, bool>>& results) {
DCHECK(IsMainThread());
// Issue stored callbacks and remove them from the pending list.
for (const auto& pair : results) {
auto it = pending_image_decodes_.find(pair.first);
DCHECK(it != pending_image_decodes_.end());
std::move(it->second).Run(pair.second);
pending_image_decodes_.erase(it);
}
}
void LayerTreeHost::SetNextCommitWaitsForActivation() {
pending_commit_state()->commit_waits_for_activation = true;
}
std::unique_ptr<CommitState> LayerTreeHost::WillCommit(
std::unique_ptr<CompletionEvent> completion,
bool has_updates) {
DCHECK(IsMainThread());
DCHECK(!commit_completion_event_);
std::unique_ptr<CommitState> result;
if (has_updates)
result = ActivateCommitState();
swap_promise_manager_.WillCommit();
client_->WillCommit(has_updates ? *result : *pending_commit_state());
pending_commit_state()->source_frame_number++;
commit_completion_event_ = std::move(completion);
pending_commit_state()->previous_surfaces_visual_update_duration =
base::TimeDelta();
return result;
}
std::unique_ptr<CommitState> LayerTreeHost::ActivateCommitState() {
DCHECK(IsMainThread());
DCHECK(pending_commit_state());
// Pull state not stored directly on LayerTreeHost
pending_commit_state()->event_metrics =
events_metrics_manager_.TakeSavedEventsMetrics();
pending_commit_state()->swap_promises =
GetSwapPromiseManager()->TakeSwapPromises();
pending_commit_state()->ui_resource_request_queue =
ui_resource_manager_->TakeUIResourcesRequests();
pending_commit_state()->ui_resource_sizes =
ui_resource_manager_->GetUIResourceSizes();
pending_commit_state()->benchmarks =
micro_benchmark_controller_.CreateImplBenchmarks();
// Snapshot PropertyTrees change tracking state prior to resetting it.
property_trees()->GetChangeState(
pending_commit_state()->property_trees_change_state);
property_trees()->ResetAllChangeTracking();
auto active_commit_state = std::move(pending_commit_state_);
pending_commit_state_ = std::make_unique<CommitState>(*active_commit_state);
return active_commit_state;
}
void LayerTreeHost::WaitForProtectedSequenceCompletion() const {
if (compositor_mode_ == CompositorMode::SINGLE_THREADED)
return;
WaitForCommitCompletion(/* for_protected_sequence */ true);
}
void LayerTreeHost::WaitForCommitCompletion(bool for_protected_sequence) const {
DCHECK(IsMainThread());
if (commit_completion_event_) {
TRACE_EVENT0("cc", "LayerTreeHost::WaitForCommitCompletion");
base::ElapsedTimer timer;
commit_completion_event_->Wait();
commit_completion_event_ = nullptr;
if (for_protected_sequence) {
waited_for_protected_sequence_ = true;
base::UmaHistogramMicrosecondsTimes(
"Compositing.MainThreadBlockedDuringCommitTime", timer.Elapsed());
}
}
}
void LayerTreeHost::UpdateDeferMainFrameUpdateInternal() {
DCHECK(IsMainThread());
proxy_->SetDeferMainFrameUpdate(MainFrameUpdatesAreDeferred());
}
bool LayerTreeHost::MainFrameUpdatesAreDeferred() const {
return defer_main_frame_update_count_ > 0 ||
!pending_commit_state()->local_surface_id_from_parent.is_valid();
}
bool LayerTreeHost::IsUsingLayerLists() const {
return settings_.use_layer_lists;
}
void LayerTreeHost::CommitComplete(const CommitTimestamps& commit_timestamps) {
// This DCHECK ensures that commit_completion_event_.Wait() will not block.
DCHECK(IsMainThread());
DCHECK(!in_commit());
WaitForCommitCompletion(/* for_protected_sequence */ false);
client_->DidCommit(commit_timestamps.start, commit_timestamps.finish);
if (did_complete_scale_animation_) {
client_->DidCompletePageScaleAnimation();
did_complete_scale_animation_ = false;
}
if (compositor_mode_ == CompositorMode::THREADED) {
base::UmaHistogramBoolean("Compositing.DidMainThreadBlockDuringCommit",
waited_for_protected_sequence_);
}
waited_for_protected_sequence_ = false;
}
void LayerTreeHost::NotifyTransitionRequestsFinished(
const std::vector<uint32_t>& sequence_ids) {
DCHECK(IsMainThread());
// TODO(vmpstr): This might also be a good spot to expire long standing
// requests if they were not finished.
for (auto& sequence_id : sequence_ids) {
auto it = document_transition_callbacks_.find(sequence_id);
if (it == document_transition_callbacks_.end())
continue;
std::move(it->second).Run();
document_transition_callbacks_.erase(it);
}
}
void LayerTreeHost::SetLayerTreeFrameSink(
std::unique_ptr<LayerTreeFrameSink> surface) {
DCHECK(IsMainThread());
TRACE_EVENT0("cc", "LayerTreeHost::SetLayerTreeFrameSink");
DCHECK(surface);
DCHECK(!new_layer_tree_frame_sink_);
new_layer_tree_frame_sink_ = std::move(surface);
proxy_->SetLayerTreeFrameSink(new_layer_tree_frame_sink_.get());
}
std::unique_ptr<LayerTreeFrameSink> LayerTreeHost::ReleaseLayerTreeFrameSink() {
DCHECK(IsMainThread());
DCHECK(!visible_);
DidLoseLayerTreeFrameSink();
proxy_->ReleaseLayerTreeFrameSink();
return std::move(current_layer_tree_frame_sink_);
}
void LayerTreeHost::RequestNewLayerTreeFrameSink() {
DCHECK(IsMainThread());
client_->RequestNewLayerTreeFrameSink();
}
void LayerTreeHost::DidInitializeLayerTreeFrameSink() {
DCHECK(IsMainThread());
DCHECK(new_layer_tree_frame_sink_);
current_layer_tree_frame_sink_ = std::move(new_layer_tree_frame_sink_);
client_->DidInitializeLayerTreeFrameSink();
}
void LayerTreeHost::DidFailToInitializeLayerTreeFrameSink() {
DCHECK(IsMainThread());
DCHECK(new_layer_tree_frame_sink_);
// Note: It is safe to drop all output surface references here as
// LayerTreeHostImpl will not keep a pointer to either the old or
// new LayerTreeFrameSink after failing to initialize the new one.
current_layer_tree_frame_sink_ = nullptr;
new_layer_tree_frame_sink_ = nullptr;
client_->DidFailToInitializeLayerTreeFrameSink();
}
std::unique_ptr<LayerTreeHostImpl> LayerTreeHost::CreateLayerTreeHostImpl(
LayerTreeHostImplClient* client) {
// This method is special: it should be the only LayerTreeHost method that
// runs on the impl thread. As such, it cannot use LayerTreeHost getter
// methods that enforce DCHECK(IsMainThread()). Because it only ever runs when
// the main thread is blocked, it's safe to access member variables directly.
DCHECK(IsImplThread());
DCHECK(task_runner_provider_->IsMainThreadBlocked());
return CreateLayerTreeHostImplInternal(
client, thread_unsafe_commit_state_.mutator_host, settings_,
task_runner_provider_.get(), dark_mode_filter_, id_, task_graph_runner_,
image_worker_task_runner_, scheduling_client_,
rendering_stats_instrumentation_.get(), ukm_recorder_factory_,
compositor_delegate_weak_ptr_);
}
std::unique_ptr<LayerTreeHostImpl>
LayerTreeHost::CreateLayerTreeHostImplInternal(
LayerTreeHostImplClient* client,
MutatorHost* mutator_host,
const LayerTreeSettings& settings,
TaskRunnerProvider* task_runner_provider,
raw_ptr<RasterDarkModeFilter>& dark_mode_filter,
int id,
raw_ptr<TaskGraphRunner>& task_graph_runner,
scoped_refptr<base::SequencedTaskRunner> image_worker_task_runner,
LayerTreeHostSchedulingClient* scheduling_client,
RenderingStatsInstrumentation* rendering_stats_instrumentation,
std::unique_ptr<UkmRecorderFactory>& ukm_recorder_factory,
base::WeakPtr<CompositorDelegateForInput>& compositor_delegate_weak_ptr) {
std::unique_ptr<MutatorHost> mutator_host_impl =
mutator_host->CreateImplInstance();
if (!settings.scroll_animation_duration_for_testing.is_zero()) {
mutator_host->SetScrollAnimationDurationForTesting( // IN-TEST
settings.scroll_animation_duration_for_testing);
}
std::unique_ptr<LayerTreeHostImpl> host_impl = LayerTreeHostImpl::Create(
settings, client, task_runner_provider, rendering_stats_instrumentation,
task_graph_runner, std::move(mutator_host_impl), dark_mode_filter, id,
std::move(image_worker_task_runner), scheduling_client);
if (ukm_recorder_factory) {
host_impl->InitializeUkm(ukm_recorder_factory->CreateRecorder());
ukm_recorder_factory.reset();
}
task_graph_runner = nullptr;
dark_mode_filter = nullptr;
compositor_delegate_weak_ptr = host_impl->AsWeakPtr();
return host_impl;
}
void LayerTreeHost::DidLoseLayerTreeFrameSink() {
TRACE_EVENT0("cc", "LayerTreeHost::DidLoseLayerTreeFrameSink");
DCHECK(task_runner_provider_->IsMainThread());
SetNeedsCommit();
}
ScopedDeferMainFrameUpdate::ScopedDeferMainFrameUpdate(LayerTreeHost* host)
: host_(host->defer_main_frame_update_weak_ptr_factory_.GetWeakPtr()) {
host->defer_main_frame_update_count_++;
host->UpdateDeferMainFrameUpdateInternal();
}
ScopedDeferMainFrameUpdate::~ScopedDeferMainFrameUpdate() {
LayerTreeHost* host = host_.get();
if (host) {
DCHECK_GT(host->defer_main_frame_update_count_, 0u);
if (--host->defer_main_frame_update_count_ == 0)
host->UpdateDeferMainFrameUpdateInternal();
}
}
std::unique_ptr<ScopedDeferMainFrameUpdate>
LayerTreeHost::DeferMainFrameUpdate() {
DCHECK(IsMainThread());
return std::make_unique<ScopedDeferMainFrameUpdate>(this);
}
void LayerTreeHost::OnDeferMainFrameUpdatesChanged(bool defer_status) {
DCHECK(IsMainThread());
client_->OnDeferMainFrameUpdatesChanged(defer_status);
}
bool LayerTreeHost::StartDeferringCommits(base::TimeDelta timeout,
PaintHoldingReason reason) {
DCHECK(IsMainThread());
return proxy_->StartDeferringCommits(timeout, reason);
}
void LayerTreeHost::StopDeferringCommits(PaintHoldingCommitTrigger trigger) {
DCHECK(IsMainThread());
proxy_->StopDeferringCommits(trigger);
}
bool LayerTreeHost::IsDeferringCommits() const {
DCHECK(IsMainThread());
return proxy_->IsDeferringCommits();
}
void LayerTreeHost::OnDeferCommitsChanged(
bool defer_status,
PaintHoldingReason reason,
absl::optional<PaintHoldingCommitTrigger> trigger) {
DCHECK(IsMainThread());
client_->OnDeferCommitsChanged(defer_status, reason, trigger);
}
DISABLE_CFI_PERF
void LayerTreeHost::SetNeedsAnimate() {
DCHECK(IsMainThread());
proxy_->SetNeedsAnimate();
swap_promise_manager_.NotifyLatencyInfoSwapPromiseMonitors();
events_metrics_manager_.SaveActiveEventMetrics();
}
void LayerTreeHost::SetNeedsAnimateIfNotInsideMainFrame() {
DCHECK(IsMainThread());
if (!inside_main_frame_)
SetNeedsAnimate();
}
DISABLE_CFI_PERF
void LayerTreeHost::SetNeedsUpdateLayers() {
DCHECK(IsMainThread());
proxy_->SetNeedsUpdateLayers();
swap_promise_manager_.NotifyLatencyInfoSwapPromiseMonitors();
events_metrics_manager_.SaveActiveEventMetrics();
}
void LayerTreeHost::SetNeedsCommit() {
DCHECK(IsMainThread());
proxy_->SetNeedsCommit();
swap_promise_manager_.NotifyLatencyInfoSwapPromiseMonitors();
events_metrics_manager_.SaveActiveEventMetrics();
}
void LayerTreeHost::SetTargetLocalSurfaceId(
const viz::LocalSurfaceId& target_local_surface_id) {
DCHECK(IsMainThread());
proxy_->SetTargetLocalSurfaceId(target_local_surface_id);
}
bool LayerTreeHost::RequestedMainFramePending() const {
DCHECK(IsMainThread());
return proxy_->RequestedAnimatePending();
}
void LayerTreeHost::SetNeedsRecalculateRasterScales() {
pending_commit_state()->next_commit_forces_recalculate_raster_scales = true;
proxy_->SetNeedsCommit();
}
void LayerTreeHost::SetNeedsRedrawRect(const gfx::Rect& damage_rect) {
DCHECK(IsMainThread());
proxy_->SetNeedsRedraw(damage_rect);
}
bool LayerTreeHost::CommitRequested() const {
DCHECK(IsMainThread());
return proxy_->CommitRequested();
}
void LayerTreeHost::SetNeedsCommitWithForcedRedraw() {
pending_commit_state()->next_commit_forces_redraw = true;
// This method is used by tests to ensure a commit before grabbing a screen
// shot or processing input, so do not defer the commit.
StopDeferringCommits(PaintHoldingCommitTrigger::kFeatureDisabled);
proxy_->SetNeedsCommit();
}
void LayerTreeHost::SetDebugState(const LayerTreeDebugState& new_debug_state) {
if (LayerTreeDebugState::Equal(pending_commit_state()->debug_state,
new_debug_state))
return;
pending_commit_state()->debug_state = new_debug_state;
rendering_stats_instrumentation_->set_record_rendering_stats(
pending_commit_state()->debug_state.RecordRenderingStats());
SetNeedsCommit();
}
void LayerTreeHost::ApplyPageScaleDeltaFromImplSide(float page_scale_delta) {
DCHECK(IsMainThread());
DCHECK(syncing_deltas_for_test_ || CommitRequested());
if (page_scale_delta == 1.f)
return;
float page_scale =
pending_commit_state()->page_scale_factor * page_scale_delta;
SetPageScaleFromImplSide(page_scale);
}
void LayerTreeHost::SetVisible(bool visible) {
DCHECK(IsMainThread());
if (visible_ == visible)
return;
visible_ = visible;
proxy_->SetVisible(visible);
}
bool LayerTreeHost::IsVisible() const {
DCHECK(IsMainThread());
return visible_;
}
void LayerTreeHost::LayoutAndUpdateLayers() {
DCHECK(IsSingleThreaded());
// This function is only valid when not using the scheduler.
DCHECK(!settings_.single_thread_proxy_scheduler);
RequestMainFrameUpdate(false);
UpdateLayers();
}
void LayerTreeHost::CompositeForTest(base::TimeTicks frame_begin_time,
bool raster) {
DCHECK(IsSingleThreaded());
// This function is only valid when not using the scheduler.
DCHECK(!settings_.single_thread_proxy_scheduler);
SingleThreadProxy* proxy = static_cast<SingleThreadProxy*>(proxy_.get());
proxy->CompositeImmediatelyForTest(frame_begin_time, raster); // IN-TEST
}
bool LayerTreeHost::UpdateLayers() {
if (!root_layer()) {
property_trees()->clear();
pending_commit_state()->viewport_property_ids = ViewportPropertyIds();
return false;
}
DCHECK(!root_layer()->parent());
base::ElapsedTimer timer;
client_->WillUpdateLayers();
bool result = DoUpdateLayers();
client_->DidUpdateLayers();
micro_benchmark_controller_.DidUpdateLayers();
base::TimeDelta elapsed_delta = timer.Elapsed();
if (pending_commit_state()->begin_main_frame_metrics) {
pending_commit_state()->begin_main_frame_metrics->update_layers =
elapsed_delta;
}
if (const char* client_name = GetClientNameForMetrics()) {
auto elapsed = elapsed_delta.InMicroseconds();
std::string histogram_name =
base::StringPrintf("Compositing.%s.LayersUpdateTime", client_name);
base::UmaHistogramCounts10M(histogram_name, elapsed);
}
return result;
}
void LayerTreeHost::DidPresentCompositorFrame(
uint32_t frame_token,
std::vector<PresentationTimeCallbackBuffer::MainCallback> callbacks,
const gfx::PresentationFeedback& feedback) {
DCHECK(IsMainThread());
for (auto& callback : callbacks)
std::move(callback).Run(feedback);
client_->DidPresentCompositorFrame(frame_token, feedback);
}
void LayerTreeHost::DidCompletePageScaleAnimation() {
DCHECK(IsMainThread());
did_complete_scale_animation_ = true;
}
std::string LayerTreeHost::LayersAsString() const {
std::string layers;
for (const auto* layer : *this)
layers += layer->ToString() + "\n";
return layers;
}
bool LayerTreeHost::CaptureContent(std::vector<NodeInfo>* content) const {
DCHECK(IsMainThread());
if (visual_device_viewport_intersection_rect_.IsEmpty())
return false;
gfx::Rect rect =
gfx::Rect(visual_device_viewport_intersection_rect_.width(),
visual_device_viewport_intersection_rect_.height());
for (const auto* layer : *this) {
// Normally, the node won't be drawn in multiple layers, even it is, such as
// text strokes, the visual rect don't have too much different.
layer->CaptureContent(rect, content);
}
return true;
}
void LayerTreeHost::DidObserveFirstScrollDelay(
base::TimeDelta first_scroll_delay,
base::TimeTicks first_scroll_timestamp) {
DCHECK(IsMainThread());
client_->DidObserveFirstScrollDelay(first_scroll_delay,
first_scroll_timestamp);
}
void LayerTreeHost::AddDocumentTransitionRequest(
std::unique_ptr<DocumentTransitionRequest> request) {
// Store the commit callback on LayerTreeHost, so that we can invoke them
// when the request is finished.
DCHECK(
!base::Contains(document_transition_callbacks_, request->sequence_id()));
document_transition_callbacks_[request->sequence_id()] =
request->TakeFinishedCallback();
pending_commit_state()->document_transition_requests.push_back(
std::move(request));
SetNeedsCommit();
}
bool LayerTreeHost::DoUpdateLayers() {
DCHECK(IsMainThread());
TRACE_EVENT1("cc,benchmark", "LayerTreeHost::DoUpdateLayers",
"source_frame_number", SourceFrameNumber());
UpdateHudLayer(pending_commit_state()->debug_state.ShouldCreateHudLayer());
// In layer lists mode, the cc property trees are built directly and do not
// need to be built here.
if (!IsUsingLayerLists()) {
TRACE_EVENT0("cc", "LayerTreeHost::UpdateLayers::BuildPropertyTrees");
PropertyTreeBuilder::BuildPropertyTrees(this);
TRACE_EVENT_INSTANT1(TRACE_DISABLED_BY_DEFAULT("cc.debug"),
"LayerTreeHost::UpdateLayers_BuiltPropertyTrees",
TRACE_EVENT_SCOPE_THREAD, "property_trees",
property_trees()->AsTracedValue());
} else {
TRACE_EVENT_INSTANT1(TRACE_DISABLED_BY_DEFAULT("cc.debug"),
"LayerTreeHost::UpdateLayers_ReceivedPropertyTrees",
TRACE_EVENT_SCOPE_THREAD, "property_trees",
property_trees()->AsTracedValue());
// The HUD layer is managed outside the layer list sent to LayerTreeHost
// and needs to have its property tree state set.
if (hud_layer() && root_layer()) {
hud_layer()->SetTransformTreeIndex(root_layer()->transform_tree_index());
hud_layer()->SetEffectTreeIndex(root_layer()->effect_tree_index());
hud_layer()->SetClipTreeIndex(root_layer()->clip_tree_index());
hud_layer()->SetScrollTreeIndex(root_layer()->scroll_tree_index());
hud_layer()->set_property_tree_sequence_number(
root_layer()->property_tree_sequence_number());
}
}
#if DCHECK_IS_ON()
// Ensure property tree nodes were created for all layers. When using layer
// lists, this can fail if blink doesn't setup layers or nodes correctly in
// |PaintArtifactCompositor|. When not using layer lists, this can fail if
// |PropertyTreeBuilder::BuildPropertyTrees| fails to create property tree
// nodes.
for (auto* layer : *this) {
DCHECK(property_trees()->effect_tree().Node(layer->effect_tree_index()));
DCHECK(
property_trees()->transform_tree().Node(layer->transform_tree_index()));
DCHECK(property_trees()->clip_tree().Node(layer->clip_tree_index()));
DCHECK(property_trees()->scroll_tree().Node(layer->scroll_tree_index()));
}
#else
// This is a quick sanity check for readiness of paint properties.
// TODO(crbug.com/913464): This is to help analysis of crashes of the bug.
// Remove this CHECK when we close the bug.
CHECK(
property_trees()->effect_tree().Node(root_layer()->effect_tree_index()));
#endif
draw_property_utils::UpdatePropertyTrees(this);
LayerList update_layer_list;
draw_property_utils::FindLayersThatNeedUpdates(this, &update_layer_list);
bool did_paint_content = PaintContent(update_layer_list);
return did_paint_content;
}
void LayerTreeHost::ApplyViewportChanges(
const CompositorCommitData& commit_data) {
DCHECK(IsMainThread());
gfx::Vector2dF inner_viewport_scroll_delta;
if (commit_data.inner_viewport_scroll.element_id)
inner_viewport_scroll_delta =
commit_data.inner_viewport_scroll.scroll_delta;
// When a new scroll-animation starts, it is necessary to check
// |commit_data.manipulation_info| to make sure the scroll-animation was
// started by an input event. If there is already an ongoing scroll-animation,
// then it is necessary to only look at |commit_data.ongoing_scroll_animation|
// (since it is possible for the scroll-animation to continue even if no event
// was handled).
bool new_ongoing_scroll = scroll_animation_.in_progress
? commit_data.ongoing_scroll_animation
: (commit_data.ongoing_scroll_animation &&
commit_data.manipulation_info);
if (scroll_animation_.in_progress && !new_ongoing_scroll) {
scroll_animation_.in_progress = false;
if (!scroll_animation_.end_notification.is_null())
std::move(scroll_animation_.end_notification).Run();
} else {
scroll_animation_.in_progress = new_ongoing_scroll;
}
if (inner_viewport_scroll_delta.IsZero() &&
commit_data.page_scale_delta == 1.f &&
commit_data.elastic_overscroll_delta.IsZero() &&
!commit_data.top_controls_delta && !commit_data.bottom_controls_delta &&
!commit_data.browser_controls_constraint_changed &&
!commit_data.scroll_gesture_did_end &&
commit_data.is_pinch_gesture_active ==
is_pinch_gesture_active_from_impl_) {
return;
}
is_pinch_gesture_active_from_impl_ = commit_data.is_pinch_gesture_active;
if (const auto* inner_scroll = property_trees()->scroll_tree().Node(
pending_commit_state()->viewport_property_ids.inner_scroll)) {
UpdateScrollOffsetFromImpl(
inner_scroll->element_id, inner_viewport_scroll_delta,
commit_data.inner_viewport_scroll.snap_target_element_ids);
}
ApplyPageScaleDeltaFromImplSide(commit_data.page_scale_delta);
SetElasticOverscrollFromImplSide(pending_commit_state()->elastic_overscroll +
commit_data.elastic_overscroll_delta);
// TODO(ccameron): pass the elastic overscroll here so that input events
// may be translated appropriately.
client_->ApplyViewportChanges(
{inner_viewport_scroll_delta, commit_data.elastic_overscroll_delta,
commit_data.page_scale_delta, commit_data.is_pinch_gesture_active,
commit_data.top_controls_delta, commit_data.bottom_controls_delta,
commit_data.browser_controls_constraint,
commit_data.scroll_gesture_did_end});
SetNeedsUpdateLayers();
}
void LayerTreeHost::UpdateScrollOffsetFromImpl(
const ElementId& id,
const gfx::Vector2dF& delta,
const absl::optional<TargetSnapAreaElementIds>& snap_target_ids) {
if (IsUsingLayerLists()) {
auto& scroll_tree = property_trees()->scroll_tree_mutable();
auto new_offset = scroll_tree.current_scroll_offset(id) + delta;
TRACE_EVENT_INSTANT2("cc", "NotifyDidScroll", TRACE_EVENT_SCOPE_THREAD,
"cur_y", scroll_tree.current_scroll_offset(id).y(),
"delta", delta.y());
if (auto* scroll_node = scroll_tree.FindNodeFromElementId(id)) {
// This update closely follows
// blink::PropertyTreeManager::DirectlyUpdateScrollOffsetTransform.