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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "cc/trees/proxy_impl.h"
#include <string.h>
#include <algorithm>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/auto_reset.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/notreached.h"
#include "base/task/common/task_annotator.h"
#include "base/task/single_thread_task_runner.h"
#include "base/trace_event/trace_event.h"
#include "base/trace_event/traced_value.h"
#include "base/trace_event/typed_macros.h"
#include "base/types/optional_ref.h"
#include "cc/base/devtools_instrumentation.h"
#include "cc/base/features.h"
#include "cc/benchmarks/benchmark_instrumentation.h"
#include "cc/input/browser_controls_offset_manager.h"
#include "cc/input/browser_controls_offset_tag_modifications.h"
#include "cc/metrics/compositor_timing_history.h"
#include "cc/paint/paint_image.h"
#include "cc/paint/paint_worklet_layer_painter.h"
#include "cc/trees/commit_state.h"
#include "cc/trees/compositor_commit_data.h"
#include "cc/trees/layer_tree_frame_sink.h"
#include "cc/trees/layer_tree_host.h"
#include "cc/trees/layer_tree_host_impl.h"
#include "cc/trees/layer_tree_impl.h"
#include "cc/trees/layer_tree_mutator.h"
#include "cc/trees/layer_tree_settings.h"
#include "cc/trees/mutator_host.h"
#include "cc/trees/proxy_main.h"
#include "cc/trees/render_frame_metadata_observer.h"
#include "cc/trees/swap_promise.h"
#include "cc/trees/task_runner_provider.h"
#include "cc/trees/trace_utils.h"
#include "components/viz/common/frame_sinks/begin_frame_args.h"
#include "components/viz/common/frame_sinks/delay_based_time_source.h"
#include "components/viz/common/frame_timing_details.h"
#include "components/viz/common/gpu/raster_context_provider.h"
#include "gpu/command_buffer/client/raster_interface.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
namespace cc {
namespace {
// Measured in seconds.
constexpr auto kSmoothnessTakesPriorityExpirationDelay =
base::Milliseconds(250);
} // namespace
// Ensures that a CompletionEvent for commit is always signaled.
class ScopedCommitCompletionEvent {
public:
ScopedCommitCompletionEvent(
int source_frame_number,
CompletionEvent* event,
base::TimeTicks start_time,
base::SingleThreadTaskRunner* main_thread_task_runner,
bool notify_main,
base::WeakPtr<ProxyMain> proxy_main_weak_ptr)
: source_frame_number_(source_frame_number),
event_(event),
commit_timestamps_({start_time, base::TimeTicks()}),
main_thread_task_runner_(main_thread_task_runner),
notify_main_(notify_main),
proxy_main_weak_ptr_(proxy_main_weak_ptr) {}
ScopedCommitCompletionEvent(const ScopedCommitCompletionEvent&) = delete;
~ScopedCommitCompletionEvent() {
event_.ExtractAsDangling()->Signal();
if (notify_main_) {
main_thread_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::DidCompleteCommit, proxy_main_weak_ptr_,
source_frame_number_, commit_timestamps_));
}
}
ScopedCommitCompletionEvent& operator=(const ScopedCommitCompletionEvent&) =
delete;
void SetFinishTime(base::TimeTicks finish_time) {
commit_timestamps_.finish = finish_time;
}
private:
const int source_frame_number_;
raw_ptr<CompletionEvent> event_;
CommitTimestamps commit_timestamps_;
raw_ptr<base::SingleThreadTaskRunner> main_thread_task_runner_;
bool notify_main_;
base::WeakPtr<ProxyMain> proxy_main_weak_ptr_;
};
ProxyImpl::ProxyImpl(base::WeakPtr<ProxyMain> proxy_main_weak_ptr,
LayerTreeHost* layer_tree_host,
int id,
const LayerTreeSettings* settings,
TaskRunnerProvider* task_runner_provider)
: layer_tree_host_id_(id),
next_frame_is_newly_committed_frame_(false),
inside_draw_(false),
task_runner_provider_(task_runner_provider),
smoothness_priority_expiration_notifier_(
task_runner_provider->ImplThreadTaskRunner(),
base::BindRepeating(&ProxyImpl::RenewTreePriority,
base::Unretained(this)),
kSmoothnessTakesPriorityExpirationDelay),
proxy_main_weak_ptr_(proxy_main_weak_ptr) {
TRACE_EVENT0("cc", "ProxyImpl::ProxyImpl");
DCHECK(IsImplThread());
DCHECK(IsMainThreadBlocked());
host_impl_ = layer_tree_host->CreateLayerTreeHostImpl(this);
SchedulerSettings scheduler_settings(settings->ToSchedulerSettings());
scheduler_settings.main_frame_before_commit_enabled = true;
std::unique_ptr<CompositorTimingHistory> compositor_timing_history(
new CompositorTimingHistory(CompositorTimingHistory::RENDERER_UMA));
scheduler_ = std::make_unique<Scheduler>(
this, scheduler_settings, layer_tree_host_id_,
task_runner_provider_->ImplThreadTaskRunner(),
std::move(compositor_timing_history),
host_impl_->compositor_frame_reporting_controller());
DCHECK_EQ(scheduler_->visible(), host_impl_->visible());
}
ProxyImpl::~ProxyImpl() {
TRACE_EVENT0("cc", "ProxyImpl::~ProxyImpl");
DCHECK(IsImplThread());
DCHECK(IsMainThreadBlocked());
// Prevent the scheduler from performing actions while we're in an
// inconsistent state.
scheduler_->Stop();
// Take away the LayerTreeFrameSink before destroying things so it doesn't
// try to call into its client mid-shutdown.
host_impl_->ReleaseLayerTreeFrameSink();
// It is important to destroy LTHI before the Scheduler since it can make
// callbacks that access it during destruction cleanup.
host_impl_ = nullptr;
scheduler_ = nullptr;
// We need to explicitly shutdown the notifier to destroy any weakptrs it is
// holding while still on the compositor thread. This also ensures any
// callbacks holding a ProxyImpl pointer are cancelled.
smoothness_priority_expiration_notifier_.Shutdown();
}
void ProxyImpl::InitializeMutatorOnImpl(
std::unique_ptr<LayerTreeMutator> mutator) {
TRACE_EVENT0("cc", "ProxyImpl::InitializeMutatorOnImpl");
DCHECK(IsImplThread());
host_impl_->SetLayerTreeMutator(std::move(mutator));
}
void ProxyImpl::InitializePaintWorkletLayerPainterOnImpl(
std::unique_ptr<PaintWorkletLayerPainter> painter) {
TRACE_EVENT0("cc", "ProxyImpl::InitializePaintWorkletLayerPainterOnImpl");
DCHECK(IsImplThread());
host_impl_->SetPaintWorkletLayerPainter(std::move(painter));
}
void ProxyImpl::UpdateBrowserControlsStateOnImpl(
BrowserControlsState constraints,
BrowserControlsState current,
bool animate,
base::optional_ref<const BrowserControlsOffsetTagModifications>
offset_tag_modifications) {
DCHECK(IsImplThread());
host_impl_->browser_controls_manager()->UpdateBrowserControlsState(
constraints, current, animate, offset_tag_modifications);
}
void ProxyImpl::InitializeLayerTreeFrameSinkOnImpl(
LayerTreeFrameSink* layer_tree_frame_sink,
base::WeakPtr<ProxyMain> proxy_main_frame_sink_bound_weak_ptr) {
TRACE_EVENT0("cc", "ProxyImpl::InitializeLayerTreeFrameSinkOnImplThread");
DCHECK(IsImplThread());
proxy_main_frame_sink_bound_weak_ptr_ = proxy_main_frame_sink_bound_weak_ptr;
LayerTreeHostImpl* host_impl = host_impl_.get();
bool success = host_impl->InitializeFrameSink(layer_tree_frame_sink);
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::DidInitializeLayerTreeFrameSink,
proxy_main_weak_ptr_, success));
if (success)
scheduler_->DidCreateAndInitializeLayerTreeFrameSink();
}
bool ProxyImpl::ShouldDeferBeginMainFrame() const {
return main_wants_defer_begin_main_frame_ ||
impl_wants_defer_begin_main_frame_;
}
void ProxyImpl::SetDeferBeginMainFrameFromMain(bool defer_begin_main_frame) {
// This is the impl-side update of a main-thread request (that is, through
// ProxyMain::SetDeferMainFrameUpdate) to defer BeginMainFrame.
DCHECK(IsImplThread());
bool was_deferring = ShouldDeferBeginMainFrame();
main_wants_defer_begin_main_frame_ = defer_begin_main_frame;
bool should_defer = ShouldDeferBeginMainFrame();
if (was_deferring != should_defer)
scheduler_->SetDeferBeginMainFrame(ShouldDeferBeginMainFrame());
}
void ProxyImpl::SetPauseRendering(bool pause_rendering) {
DCHECK(IsImplThread());
scheduler_->SetPauseRendering(pause_rendering);
}
void ProxyImpl::SetDeferBeginMainFrameFromImpl(bool defer_begin_main_frame) {
// This is a request from the impl thread to defer BeginMainFrame.
DCHECK(IsImplThread());
bool was_deferring = ShouldDeferBeginMainFrame();
impl_wants_defer_begin_main_frame_ = defer_begin_main_frame;
bool should_defer = ShouldDeferBeginMainFrame();
if (was_deferring != should_defer)
scheduler_->SetDeferBeginMainFrame(ShouldDeferBeginMainFrame());
}
void ProxyImpl::SetNeedsRedrawOnImpl(const gfx::Rect& damage_rect) {
DCHECK(IsImplThread());
host_impl_->SetViewportDamage(damage_rect);
SetNeedsRedrawOnImplThread();
}
void ProxyImpl::SetNeedsCommitOnImpl(bool urgent) {
SetNeedsCommitOnImplThread(urgent);
}
void ProxyImpl::SetTargetLocalSurfaceIdOnImpl(
const viz::LocalSurfaceId& target_local_surface_id) {
DCHECK(IsImplThread());
host_impl_->SetTargetLocalSurfaceId(target_local_surface_id);
}
void ProxyImpl::BeginMainFrameAbortedOnImpl(
CommitEarlyOutReason reason,
base::TimeTicks main_thread_start_time,
std::vector<std::unique_ptr<SwapPromise>> swap_promises,
bool scroll_and_viewport_changes_synced) {
TRACE_EVENT1("cc", "ProxyImpl::BeginMainFrameAbortedOnImplThread", "reason",
CommitEarlyOutReasonToString(reason));
DCHECK(IsImplThread());
DCHECK(scheduler_->CommitPending());
host_impl_->BeginMainFrameAborted(
reason, std::move(swap_promises),
scheduler_->last_dispatched_begin_main_frame_args(),
static_cast<bool>(data_for_commit_.get()),
scroll_and_viewport_changes_synced);
scheduler_->NotifyBeginMainFrameStarted(main_thread_start_time);
scheduler_->BeginMainFrameAborted(reason);
}
void ProxyImpl::SetVisibleOnImpl(bool visible) {
TRACE_EVENT1("cc", "ProxyImpl::SetVisibleOnImplThread", "visible", visible);
DCHECK(IsImplThread());
host_impl_->SetVisible(visible);
scheduler_->SetVisible(visible);
}
void ProxyImpl::SetShouldWarmUpOnImpl() {
TRACE_EVENT0("cc", "ProxyImpl::SetShouldWarmUpOnImpl");
DCHECK(IsImplThread());
scheduler_->SetShouldWarmUp();
}
void ProxyImpl::ReleaseLayerTreeFrameSinkOnImpl(CompletionEvent* completion) {
TRACE_EVENT0("cc", "ProxyImpl::ReleaseLayerTreeFrameSinkOnImpl");
base::ScopedUmaHistogramTimer histogram_timer(
"Navigation.ProxyImpl.ReleaseLayerTreeFrameSinkOnImpl");
DCHECK(IsImplThread());
// Unlike DidLoseLayerTreeFrameSinkOnImplThread, we don't need to call
// LayerTreeHost::DidLoseLayerTreeFrameSink since it already knows.
scheduler_->DidLoseLayerTreeFrameSink();
host_impl_->ReleaseLayerTreeFrameSink();
completion->Signal();
}
void ProxyImpl::FinishGLOnImpl(CompletionEvent* completion) {
TRACE_EVENT0("cc", "ProxyImpl::FinishGLOnImplThread");
DCHECK(IsImplThread());
if (host_impl_->layer_tree_frame_sink()) {
auto* context_provider =
host_impl_->layer_tree_frame_sink()->context_provider();
if (context_provider) {
context_provider->RasterInterface()->Finish();
}
}
completion->Signal();
}
void ProxyImpl::MainFrameWillHappenOnImplForTesting(
CompletionEvent* completion,
bool* main_frame_will_happen) {
DCHECK(IsImplThread());
if (host_impl_->layer_tree_frame_sink()) {
*main_frame_will_happen = scheduler_->MainFrameForTestingWillHappen();
} else {
*main_frame_will_happen = false;
}
completion->Signal();
}
void ProxyImpl::RequestBeginMainFrameNotExpectedOnImpl(bool new_state) {
DCHECK(IsImplThread());
DCHECK(scheduler_);
TRACE_EVENT1("cc", "ProxyImpl::RequestBeginMainFrameNotExpectedOnImpl",
"new_state", new_state);
scheduler_->SetMainThreadWantsBeginMainFrameNotExpected(new_state);
}
bool ProxyImpl::IsInSynchronousComposite() const {
return false;
}
void ProxyImpl::FrameSinksToThrottleUpdated(
const base::flat_set<viz::FrameSinkId>& ids) {
NOTREACHED();
}
void ProxyImpl::SetHasActiveThreadedScroll(bool is_scrolling) {
scheduler_->SetIsScrolling(is_scrolling);
}
void ProxyImpl::SetWaitingForScrollEvent(bool waiting_for_scroll_event) {
scheduler_->SetWaitingForScrollEvent(waiting_for_scroll_event);
}
void ProxyImpl::NotifyReadyToCommitOnImpl(
CompletionEvent* completion_event,
std::unique_ptr<CommitState> commit_state,
const ThreadUnsafeCommitState* unsafe_state,
base::TimeTicks main_thread_start_time,
bool scroll_and_viewport_changes_synced,
CommitTimestamps* commit_timestamps,
bool commit_timeout) {
TRACE_EVENT("cc,benchmark", "ProxyImpl::ReadyToCommit",
[&](perfetto::EventContext ctx) {
EmitMainFramePipelineStep(
ctx, commit_state->trace_id,
perfetto::protos::pbzero::MainFramePipeline::Step::
READY_TO_COMMIT_ON_IMPL);
});
DCHECK(!data_for_commit_.get());
DCHECK(IsImplThread());
DCHECK(scheduler_);
DCHECK(scheduler_->CommitPending());
// Inform the layer tree host that the commit has started, so that metrics
// can determine how long we waited for thread synchronization.
//
// If the main thread is blocked waiting for commit, then commit_timestamps
// points to a variable on the call stack of the main thread. If the main
// thread is not blocked, then the commit timestamps are transmitted back to
// the main thread by ScopedCommitCompletionEvent.
DCHECK_EQ((bool)commit_timestamps,
task_runner_provider_->IsMainThreadBlocked());
base::TimeTicks start_time = base::TimeTicks::Now();
if (commit_timestamps)
commit_timestamps->start = start_time;
if (!host_impl_) {
TRACE_EVENT_INSTANT0("cc", "EarlyOut_NoLayerTree",
TRACE_EVENT_SCOPE_THREAD);
completion_event->Signal();
return;
}
// Ideally, we should inform to impl thread when BeginMainFrame is started.
// But, we can avoid a PostTask in here.
scheduler_->NotifyBeginMainFrameStarted(main_thread_start_time);
auto& begin_main_frame_metrics = commit_state->begin_main_frame_metrics;
host_impl_->ReadyToCommit(scroll_and_viewport_changes_synced,
begin_main_frame_metrics.get(), commit_timeout);
int source_frame_number = commit_state->source_frame_number;
data_for_commit_ = std::make_unique<DataForCommit>(
std::make_unique<ScopedCommitCompletionEvent>(
source_frame_number, completion_event, start_time,
MainThreadTaskRunner(),
/*notify_main*/ !commit_timestamps, proxy_main_weak_ptr_),
std::move(commit_state), unsafe_state, commit_timestamps);
// Extract metrics data from the layer tree host and send them to the
// scheduler to pass them to the compositor_timing_history object.
scheduler_->NotifyReadyToCommit(std::move(begin_main_frame_metrics));
// If scroll offsets were not synchronized by this commit we need another main
// frame to sync them.
// Note that scroll_and_viewport_changes_synced will be false for the frame
// that contains the first contentful paint, since paint holding makes us skip
// ApplyCompositorChanges. This means we are guaranteed to run another main
// frame after FCP, which is good because there may be hover effects to apply.
if (!scroll_and_viewport_changes_synced)
scheduler_->SetNeedsBeginMainFrame(false);
}
void ProxyImpl::DidLoseLayerTreeFrameSinkOnImplThread() {
TRACE_EVENT0("cc", "ProxyImpl::DidLoseLayerTreeFrameSinkOnImplThread");
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::DidLoseLayerTreeFrameSink,
proxy_main_weak_ptr_));
scheduler_->DidLoseLayerTreeFrameSink();
}
void ProxyImpl::SetBeginFrameSource(viz::BeginFrameSource* source) {
// During shutdown, destroying the LayerTreeFrameSink may unset the
// viz::BeginFrameSource.
if (scheduler_) {
// TODO(enne): this overrides any preexisting begin frame source. Those
// other sources will eventually be removed and this will be the only path.
scheduler_->SetBeginFrameSource(source);
}
}
void ProxyImpl::DidReceiveCompositorFrameAckOnImplThread() {
TRACE_EVENT0("cc,benchmark",
"ProxyImpl::DidReceiveCompositorFrameAckOnImplThread");
DCHECK(IsImplThread());
scheduler_->DidReceiveCompositorFrameAck();
}
void ProxyImpl::OnCanDrawStateChanged(bool can_draw) {
TRACE_EVENT1("cc", "ProxyImpl::OnCanDrawStateChanged", "can_draw", can_draw);
DCHECK(IsImplThread());
scheduler_->SetCanDraw(can_draw);
}
void ProxyImpl::NotifyReadyToActivate() {
DCHECK(IsImplThread());
TRACE_EVENT_INSTANT("cc,benchmark", "ProxyImpl::ReadyToActivate",
[&](perfetto::EventContext ctx) {
EmitMainFramePipelineStep(
ctx, host_impl_->active_tree()->trace_id(),
perfetto::protos::pbzero::MainFramePipeline::Step::
READY_TO_ACTIVATE);
});
scheduler_->NotifyReadyToActivate();
}
bool ProxyImpl::IsReadyToActivate() {
DCHECK(IsImplThread());
return scheduler_->IsReadyToActivate();
}
void ProxyImpl::NotifyReadyToDraw() {
TRACE_EVENT0("cc", "ProxyImpl::NotifyReadyToDraw");
DCHECK(IsImplThread());
scheduler_->NotifyReadyToDraw();
}
void ProxyImpl::SetNeedsRedrawOnImplThread() {
TRACE_EVENT0("cc", "ProxyImpl::SetNeedsRedrawOnImplThread");
DCHECK(IsImplThread());
scheduler_->SetNeedsRedraw();
}
void ProxyImpl::SetNeedsOneBeginImplFrameOnImplThread() {
TRACE_EVENT0("cc", "ProxyImpl::SetNeedsOneBeginImplFrameOnImplThread");
DCHECK(IsImplThread());
scheduler_->SetNeedsOneBeginImplFrame();
}
void ProxyImpl::SetNeedsPrepareTilesOnImplThread() {
DCHECK(IsImplThread());
scheduler_->SetNeedsPrepareTiles();
}
void ProxyImpl::SetNeedsCommitOnImplThread(bool urgent) {
TRACE_EVENT0("cc", "ProxyImpl::SetNeedsCommitOnImplThread");
DCHECK(IsImplThread());
scheduler_->SetNeedsBeginMainFrame(urgent);
}
void ProxyImpl::SetVideoNeedsBeginFrames(bool needs_begin_frames) {
TRACE_EVENT1("cc", "ProxyImpl::SetVideoNeedsBeginFrames",
"needs_begin_frames", needs_begin_frames);
DCHECK(IsImplThread());
// In tests the layer tree is destroyed after the scheduler is.
if (scheduler_)
scheduler_->SetVideoNeedsBeginFrames(needs_begin_frames);
}
bool ProxyImpl::IsInsideDraw() {
return inside_draw_;
}
void ProxyImpl::RenewTreePriority() {
DCHECK(IsImplThread());
bool precise_scrolling_in_progress =
host_impl_->GetActivelyScrollingType() == ActivelyScrollingType::kPrecise;
bool avoid_entering_smoothness =
(base::FeatureList::IsEnabled(
features::kNewContentForCheckerboardedScrolls) &&
host_impl_->ScrollCheckerboardsIncompleteRecording()) ||
(precise_scrolling_in_progress &&
host_impl_->IsCurrentScrollMainRepainted());
bool non_scroll_interaction_in_progress =
host_impl_->IsPinchGestureActive() ||
host_impl_->page_scale_animation_active();
// Schedule expiration if smoothness currently takes priority.
if ((non_scroll_interaction_in_progress || precise_scrolling_in_progress) &&
!avoid_entering_smoothness) {
smoothness_priority_expiration_notifier_.Schedule();
}
// We use the same priority for both trees by default.
TreePriority tree_priority = SAME_PRIORITY_FOR_BOTH_TREES;
// Smoothness takes priority if we have an expiration for it scheduled.
if (smoothness_priority_expiration_notifier_.HasPendingNotification()) {
tree_priority = SMOOTHNESS_TAKES_PRIORITY;
}
// New content takes priority in certain cases:
// - When ui resources have been evicted.
// - When the viewport is 0x0 (may be invalid/unset?)
// - When the active scroll gesture requires main-thread repainting for the
// scroll offset change to be visible.
if (host_impl_->active_tree()->GetDeviceViewport().size().IsEmpty() ||
host_impl_->EvictedUIResourcesExist() ||
(host_impl_->IsCurrentScrollMainRepainted() &&
base::FeatureList::IsEnabled(
features::kMainRepaintScrollPrefersNewContent))) {
// Once we enter NEW_CONTENTS_TAKES_PRIORITY mode, visible tiles on active
// tree might be freed. We need to set RequiresHighResToDraw to ensure that
// high res tiles will be required to activate pending tree.
host_impl_->SetRequiresHighResToDraw();
tree_priority = NEW_CONTENT_TAKES_PRIORITY;
}
host_impl_->SetTreePriority(tree_priority);
// Only put the scheduler in impl latency prioritization mode if we don't
// have a scroll listener. This gives the scroll listener a better chance of
// handling scroll updates within the same frame. The tree itself is still
// kept in prefer smoothness mode to allow checkerboarding.
ScrollHandlerState scroll_handler_state =
host_impl_->ScrollAffectsScrollHandler()
? ScrollHandlerState::SCROLL_AFFECTS_SCROLL_HANDLER
: ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER;
scheduler_->SetTreePrioritiesAndScrollState(tree_priority,
scroll_handler_state);
}
void ProxyImpl::PostDelayedAnimationTaskOnImplThread(base::OnceClosure task,
base::TimeDelta delay) {
DCHECK(IsImplThread());
task_runner_provider_->ImplThreadTaskRunner()->PostDelayedTask(
FROM_HERE, std::move(task), delay);
}
void ProxyImpl::DidActivateSyncTree() {
TRACE_EVENT0("cc", "ProxyImpl::DidActivateSyncTreeOnImplThread");
DCHECK(IsImplThread());
if (activation_completion_event_) {
TRACE_EVENT_INSTANT0("cc", "ReleaseCommitbyActivation",
TRACE_EVENT_SCOPE_THREAD);
activation_completion_event_ = nullptr;
}
}
void ProxyImpl::DidPrepareTiles() {
DCHECK(IsImplThread());
scheduler_->DidPrepareTiles();
}
void ProxyImpl::DidCompletePageScaleAnimationOnImplThread() {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::DidCompletePageScaleAnimation,
proxy_main_weak_ptr_));
}
void ProxyImpl::OnDrawForLayerTreeFrameSink(bool resourceless_software_draw,
bool skip_draw) {
DCHECK(IsImplThread());
scheduler_->OnDrawForLayerTreeFrameSink(resourceless_software_draw,
skip_draw);
}
void ProxyImpl::SetNeedsImplSideInvalidation(
bool needs_first_draw_on_activation) {
DCHECK(IsImplThread());
scheduler_->SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
}
void ProxyImpl::NotifyImageDecodeRequestFinished(int request_id,
bool speculative,
bool decode_succeeded) {
DCHECK(IsImplThread());
if (base::FeatureList::IsEnabled(
features::kSendExplicitDecodeRequestsImmediately)) {
if (speculative) {
SetSpeculativeDecodeRequestInFlight(false);
}
MainThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::NotifyImageDecodeRequestFinished,
proxy_main_weak_ptr_, request_id, decode_succeeded));
} else {
SetNeedsCommitOnImplThread(/* urgent= */ false);
}
}
void ProxyImpl::NotifyTransitionRequestFinished(
uint32_t sequence_id,
const viz::ViewTransitionElementResourceRects& rects) {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::NotifyTransitionRequestFinished,
proxy_main_weak_ptr_, sequence_id, rects));
}
void ProxyImpl::DidPresentCompositorFrameOnImplThread(
uint32_t frame_token,
PresentationTimeCallbackBuffer::PendingCallbacks activated,
const viz::FrameTimingDetails& details) {
host_impl_->NotifyDidPresentCompositorFrameOnImplThread(
frame_token, std::move(activated.compositor_successful_callbacks),
details);
MainThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::DidPresentCompositorFrame,
proxy_main_weak_ptr_, frame_token,
std::move(activated.main_callbacks),
std::move(activated.main_successful_callbacks), details));
if (scheduler_)
scheduler_->DidPresentCompositorFrame(frame_token, details);
}
void ProxyImpl::NotifyAnimationWorkletStateChange(
AnimationWorkletMutationState state,
ElementListType element_list_type) {
DCHECK(IsImplThread());
Scheduler::AnimationWorkletState animation_worklet_state =
(state == AnimationWorkletMutationState::STARTED)
? Scheduler::AnimationWorkletState::PROCESSING
: Scheduler::AnimationWorkletState::IDLE;
Scheduler::TreeType tree_type = (element_list_type == ElementListType::ACTIVE)
? Scheduler::TreeType::ACTIVE
: Scheduler::TreeType::PENDING;
scheduler_->NotifyAnimationWorkletStateChange(animation_worklet_state,
tree_type);
}
void ProxyImpl::NotifyPaintWorkletStateChange(
Scheduler::PaintWorkletState state) {
DCHECK(IsImplThread());
scheduler_->NotifyPaintWorkletStateChange(state);
}
void ProxyImpl::NotifyCompositorMetricsTrackerResults(
CustomTrackerResults results) {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::NotifyCompositorMetricsTrackerResults,
proxy_main_weak_ptr_, std::move(results)));
}
void ProxyImpl::DidObserveFirstScrollDelay(
int source_frame_number,
base::TimeDelta first_scroll_delay,
base::TimeTicks first_scroll_timestamp) {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::DidObserveFirstScrollDelay,
proxy_main_weak_ptr_, source_frame_number,
first_scroll_delay, first_scroll_timestamp));
}
bool ProxyImpl::WillBeginImplFrame(const viz::BeginFrameArgs& args) {
DCHECK(IsImplThread());
return host_impl_->WillBeginImplFrame(args);
}
void ProxyImpl::DidFinishImplFrame(
const viz::BeginFrameArgs& last_activated_args) {
DCHECK(IsImplThread());
host_impl_->DidFinishImplFrame(last_activated_args);
}
void ProxyImpl::DidNotProduceFrame(const viz::BeginFrameAck& ack,
FrameSkippedReason reason) {
DCHECK(IsImplThread());
host_impl_->DidNotProduceFrame(ack, reason);
}
void ProxyImpl::WillNotReceiveBeginFrame() {
DCHECK(IsImplThread());
host_impl_->DidNotNeedBeginFrame();
}
void ProxyImpl::ScheduledActionSendBeginMainFrame(
const viz::BeginFrameArgs& args) {
DCHECK(IsImplThread());
benchmark_instrumentation::ScopedBeginFrameTask begin_frame_task(
benchmark_instrumentation::kSendBeginFrame,
args.frame_id.sequence_number);
std::unique_ptr<BeginMainFrameAndCommitState> begin_main_frame_state(
new BeginMainFrameAndCommitState);
begin_main_frame_state->begin_frame_args = args;
DCHECK(!data_for_commit_ || data_for_commit_->unsafe_state->mutator_host);
begin_main_frame_state->commit_data = host_impl_->ProcessCompositorDeltas(
data_for_commit_ ? data_for_commit_->unsafe_state->mutator_host
: nullptr);
begin_main_frame_state->completed_image_decode_requests =
host_impl_->TakeCompletedImageDecodeRequests();
DCHECK(!base::FeatureList::IsEnabled(
features::kSendExplicitDecodeRequestsImmediately) ||
begin_main_frame_state->completed_image_decode_requests.empty());
begin_main_frame_state->mutator_events = host_impl_->TakeMutatorEvents();
begin_main_frame_state->active_sequence_trackers =
host_impl_->FrameSequenceTrackerActiveTypes();
begin_main_frame_state->evicted_ui_resources =
host_impl_->EvictedUIResourcesExist();
host_impl_->WillSendBeginMainFrame();
{
TRACE_EVENT_INSTANT(
"cc,benchmark", "SendBeginMainFrame", [&](perfetto::EventContext ctx) {
auto* pipeline = EmitMainFramePipelineStep(
ctx, begin_main_frame_state->trace_id,
perfetto::protos::pbzero::MainFramePipeline::Step::
SEND_BEGIN_MAIN_FRAME);
auto* begin_frame_id = pipeline->set_begin_frame_id();
begin_frame_id->set_sequence_number(args.frame_id.sequence_number);
begin_frame_id->set_source_id(args.frame_id.source_id);
});
}
MainThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::BeginMainFrame, proxy_main_weak_ptr_,
std::move(begin_main_frame_state)));
devtools_instrumentation::DidRequestMainThreadFrame(layer_tree_host_id_);
}
DrawResult ProxyImpl::ScheduledActionDrawIfPossible() {
TRACE_EVENT0("cc", "ProxyImpl::ScheduledActionDraw");
DCHECK(IsImplThread());
// The scheduler should never generate this call when it can't draw.
DCHECK(host_impl_->CanDraw());
bool forced_draw = false;
return DrawInternal(forced_draw);
}
DrawResult ProxyImpl::ScheduledActionDrawForced() {
TRACE_EVENT0("cc", "ProxyImpl::ScheduledActionDrawForced");
DCHECK(IsImplThread());
bool forced_draw = true;
return DrawInternal(forced_draw);
}
void ProxyImpl::ScheduledActionCommit() {
TRACE_EVENT(
"cc,benchmark", "ProxyImpl::Commit", [&](perfetto::EventContext ctx) {
EmitMainFramePipelineStep(
ctx, data_for_commit_->commit_state->trace_id,
perfetto::protos::pbzero::MainFramePipeline::Step::COMMIT_ON_IMPL);
});
DCHECK(IsImplThread());
DCHECK(data_for_commit_.get());
DCHECK(data_for_commit_->IsValid());
auto* commit_state = data_for_commit_->commit_state.get();
auto* unsafe_state = data_for_commit_->unsafe_state.get();
host_impl_->BeginCommit(commit_state->source_frame_number,
commit_state->trace_id);
host_impl_->FinishCommit(*commit_state, *unsafe_state);
base::TimeTicks finish_time = base::TimeTicks::Now();
if (data_for_commit_->commit_timestamps)
data_for_commit_->commit_timestamps->finish = finish_time;
data_for_commit_->commit_completion_event->SetFinishTime(finish_time);
if (commit_state->commit_waits_for_activation) {
// For some layer types in impl-side painting, the commit is held until the
// sync tree is activated. It's also possible that the sync tree has
// already activated if there was no work to be done.
TRACE_EVENT_INSTANT0("cc", "HoldCommit", TRACE_EVENT_SCOPE_THREAD);
activation_completion_event_ =
std::move(data_for_commit_->commit_completion_event);
}
data_for_commit_.reset();
}
void ProxyImpl::ScheduledActionPostCommit() {
DCHECK(IsImplThread());
// This is run as a separate step from commit because it can be time-consuming
// and ought not delay sending the next BeginMainFrame.
host_impl_->CommitComplete();
}
void ProxyImpl::ScheduledActionActivateSyncTree() {
if (host_impl_->sync_tree() &&
host_impl_->sync_tree()->source_frame_number() !=
host_impl_->active_tree()->source_frame_number()) {
next_frame_is_newly_committed_frame_ = true;
}
DCHECK(IsImplThread());
host_impl_->ActivateSyncTree();
}
void ProxyImpl::ScheduledActionBeginLayerTreeFrameSinkCreation() {
TRACE_EVENT0("cc",
"ProxyImpl::ScheduledActionBeginLayerTreeFrameSinkCreation");
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::RequestNewLayerTreeFrameSink,
proxy_main_weak_ptr_));
}
void ProxyImpl::ScheduledActionPrepareTiles() {
TRACE_EVENT0("cc", "ProxyImpl::ScheduledActionPrepareTiles");
DCHECK(IsImplThread());
host_impl_->PrepareTiles();
}
void ProxyImpl::ScheduledActionInvalidateLayerTreeFrameSink(bool needs_redraw) {
TRACE_EVENT0("cc", "ProxyImpl::ScheduledActionInvalidateLayerTreeFrameSink");
DCHECK(IsImplThread());
host_impl_->InvalidateLayerTreeFrameSink(needs_redraw);
}
void ProxyImpl::ScheduledActionPerformImplSideInvalidation() {
TRACE_EVENT0("cc", "ProxyImpl::ScheduledActionPerformImplSideInvalidation");
DCHECK(IsImplThread());
host_impl_->InvalidateContentOnImplSide();
}
void ProxyImpl::SendBeginMainFrameNotExpectedSoon() {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::BeginMainFrameNotExpectedSoon,
proxy_main_weak_ptr_));
}
void ProxyImpl::ScheduledActionBeginMainFrameNotExpectedUntil(
base::TimeTicks time) {
DCHECK(IsImplThread());
MainThreadTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&ProxyMain::BeginMainFrameNotExpectedUntil,
proxy_main_weak_ptr_, time));
}
void ProxyImpl::OnBeginImplFrameDeadline() {
DCHECK(IsImplThread());
host_impl_->OnBeginImplFrameDeadline();
}
DrawResult ProxyImpl::DrawInternal(bool forced_draw) {
DCHECK(IsImplThread());
DCHECK(host_impl_.get());
TRACE_EVENT(
"cc,benchmark", "MainFrame.Draw", [&](perfetto::EventContext ctx) {
auto* pipeline = EmitMainFramePipelineStep(
ctx, host_impl_->active_tree()->trace_id(),
perfetto::protos::pbzero::MainFramePipeline::Step::DRAW);
if (next_frame_is_newly_committed_frame_) {
viz::BeginFrameId frame_id =
host_impl_->CurrentBeginFrameArgs().frame_id;
auto* first_draw_frame_id =
pipeline->set_last_begin_frame_id_during_first_draw();
first_draw_frame_id->set_source_id(frame_id.source_id);
first_draw_frame_id->set_sequence_number(frame_id.sequence_number);
}
});
base::AutoReset<bool> mark_inside(&inside_draw_, true);
// This method is called on a forced draw, regardless of whether we are able
// to produce a frame, as the calling site on main thread is blocked until its
// request completes, and we signal completion here. If CanDraw() is false, we
// will indicate success=false to the caller, but we must still signal
// completion to avoid deadlock.
// We guard PrepareToDraw() with CanDraw() because it always returns a valid
// frame, so can only be used when such a frame is possible. Since
// DrawLayers() depends on the result of PrepareToDraw(), it is guarded on
// CanDraw() as well.
LayerTreeHostImpl::FrameData frame;
frame.begin_frame_ack = scheduler_->CurrentBeginFrameAckForActiveTree();
frame.origin_begin_main_frame_args =
scheduler_->last_activate_origin_frame_args();
bool draw_frame = false;
DrawResult result;
{
TRACE_EVENT(
"viz,benchmark,graphics.pipeline", "Graphics.Pipeline",
perfetto::Flow::Global(host_impl_->CurrentBeginFrameArgs().trace_id),
[&](perfetto::EventContext ctx) {
base::TaskAnnotator::EmitTaskTimingDetails(ctx);
auto* event = ctx.event<perfetto::protos::pbzero::ChromeTrackEvent>();
auto* data = event->set_chrome_graphics_pipeline();
data->set_step(perfetto::protos::pbzero::ChromeGraphicsPipeline::
StepName::STEP_GENERATE_COMPOSITOR_FRAME);
data->set_surface_frame_trace_id(
host_impl_->CurrentBeginFrameArgs().trace_id);
});
if (host_impl_->CanDraw()) {
result = host_impl_->PrepareToDraw(&frame);
draw_frame = forced_draw || result == DrawResult::kSuccess;
} else {
result = DrawResult::kAbortedCantDraw;
}
if (draw_frame) {
if (std::optional<SubmitInfo> submit_info =
host_impl_->DrawLayers(&frame)) {
DCHECK_NE(frame.frame_token, 0u);
// Drawing implies we submitted a frame to the LayerTreeFrameSink.
scheduler_->DidSubmitCompositorFrame(submit_info.value());
}
result = DrawResult::kSuccess;
} else {
DCHECK_NE(DrawResult::kSuccess, result);
}
}
host_impl_->DidDrawAllLayers(frame);
bool start_ready_animations = draw_frame;
host_impl_->UpdateAnimationState(start_ready_animations);
// Tell the main thread that the frame was drawn.
if (next_frame_is_newly_committed_frame_) {
next_frame_is_newly_committed_frame_ = false;
MainThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(&ProxyMain::DidCommitAndDrawFrame, proxy_main_weak_ptr_,
host_impl_->active_tree()->source_frame_number()));
}
// The tile visibility/priority of the pending tree needs to be updated so
// that it doesn't get activated before the raster is complete. But this needs
// to happen after the draw, off of the critical path to draw.
if (host_impl_->pending_tree()) {
host_impl_->pending_tree()->UpdateDrawProperties(
/*update_tiles=*/true, /*update_image_animation_controller=*/true);
}
DCHECK_NE(DrawResult::kInvalidResult, result);
return result;
}
bool ProxyImpl::IsImplThread() const {
return task_runner_provider_->IsImplThread();
}
bool ProxyImpl::IsMainThreadBlocked() const {
return task_runner_provider_->IsMainThreadBlocked();
}
base::SingleThreadTaskRunner* ProxyImpl::MainThreadTaskRunner() {
return task_runner_provider_->MainThreadTaskRunner();
}
void ProxyImpl::QueueImageDecodeOnImpl(int request_id,
std::unique_ptr<DrawImage> image,
bool speculative) {
host_impl_->QueueImageDecode(request_id, *image, speculative);
}
bool ProxyImpl::SpeculativeDecodeRequestInFlight() const {
return speculative_decode_request_in_flight_.load();
}
void ProxyImpl::SetSpeculativeDecodeRequestInFlight(bool value) {
CHECK(value != speculative_decode_request_in_flight_.load());
speculative_decode_request_in_flight_.store(value);
}
void ProxyImpl::SetSourceURL(ukm::SourceId source_id, const GURL& url) {
DCHECK(IsImplThread());
host_impl_->SetActiveURL(url, source_id);
}
void ProxyImpl::SetUkmSmoothnessDestination(
base::WritableSharedMemoryMapping ukm_smoothness_data) {
DCHECK(IsImplThread());
host_impl_->SetUkmSmoothnessDestination(std::move(ukm_smoothness_data));
}
void ProxyImpl::SetUkmDroppedFramesDestination(
base::WritableSharedMemoryMapping ukm_dropped_frames_data) {
DCHECK(IsImplThread());
host_impl_->SetUkmDroppedFramesDestination(
std::move(ukm_dropped_frames_data));
}
void ProxyImpl::ClearHistory() {
DCHECK(IsImplThread());
scheduler_->ClearHistory();
}
size_t ProxyImpl::CommitDurationSampleCountForTesting() const {
return scheduler_->CommitDurationSampleCountForTesting(); // IN-TEST
}
void ProxyImpl::SetRenderFrameObserver(
std::unique_ptr<RenderFrameMetadataObserver> observer) {
host_impl_->SetRenderFrameObserver(std::move(observer));
}
void ProxyImpl::DetachInputDelegateAndRenderFrameObserver(
CompletionEvent* completion_event) {
host_impl_->DetachInputDelegateAndRenderFrameObserver();
completion_event->Signal();
}
ProxyImpl::DataForCommit::DataForCommit(
std::unique_ptr<ScopedCommitCompletionEvent> commit_completion_event,
std::unique_ptr<CommitState> commit_state,
const ThreadUnsafeCommitState* unsafe_state,
CommitTimestamps* commit_timestamps)
: commit_completion_event(std::move(commit_completion_event)),
commit_state(std::move(commit_state)),
unsafe_state(unsafe_state),
commit_timestamps(commit_timestamps) {}
ProxyImpl::DataForCommit::~DataForCommit() = default;
bool ProxyImpl::DataForCommit::IsValid() const {
return commit_completion_event.get() && commit_state.get() && unsafe_state;
}
void ProxyImpl::SetShouldThrottleFrameRate(bool flag) {
scheduler_->SetShouldThrottleFrameRate(flag);
}
void ProxyImpl::NotifyNewLocalSurfaceIdExpectedWhilePaused() {
host_impl_->NotifyNewLocalSurfaceIdExpectedWhilePaused();
}
} // namespace cc
|