File: thread_scheduler_base.cc

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (214 lines) | stat: -rw-r--r-- 7,289 bytes parent folder | download | duplicates (11)
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "third_party/blink/renderer/platform/scheduler/common/thread_scheduler_base.h"

#include "base/trace_event/trace_event.h"
#include "third_party/blink/renderer/platform/scheduler/common/auto_advancing_virtual_time_domain.h"

namespace blink {
namespace scheduler {

void ThreadSchedulerBase::ExecuteAfterCurrentTask(
    base::OnceClosure on_completion_task) {
  GetOnTaskCompletionCallbacks().push_back(std::move(on_completion_task));
}

void ThreadSchedulerBase::Shutdown() {
  GetHelper().ResetTimeDomain();
  virtual_time_domain_.reset();
}

base::TimeTicks ThreadSchedulerBase::EnableVirtualTime(
    base::Time initial_time) {
  if (virtual_time_domain_)
    return virtual_time_domain_->InitialTicks();
  if (initial_time.is_null())
    initial_time = base::Time::Now();

  // TODO(caseq): Considering we're not enabling override atomically with
  // capturing current ticks, provide a safety margin to assure the emulated
  // ticks never get behind real clock, while the override is being enabled.
  base::TimeTicks initial_ticks = GetTickClock()->NowTicks();
  virtual_time_domain_ = std::make_unique<AutoAdvancingVirtualTimeDomain>(
      initial_time, initial_ticks, &GetHelper());
  GetHelper().SetTimeDomain(virtual_time_domain_.get());

  OnVirtualTimeEnabled();

  DCHECK(!virtual_time_stopped_);
  virtual_time_domain_->SetCanAdvanceVirtualTime(true);

  return virtual_time_domain_->InitialTicks();
}

void ThreadSchedulerBase::DisableVirtualTimeForTesting() {
  if (!IsVirtualTimeEnabled())
    return;
  // Reset virtual time and all tasks queues back to their initial state.
  SetVirtualTimeStopped(false);

  // This can only happen during test tear down, in which case there is no need
  // to notify the pages that virtual time was disabled.
  GetHelper().ResetTimeDomain();

  virtual_time_domain_.reset();

  OnVirtualTimeDisabled();
}

bool ThreadSchedulerBase::VirtualTimeAllowedToAdvance() const {
  DCHECK(!virtual_time_stopped_ || virtual_time_domain_);
  return !virtual_time_stopped_;
}

void ThreadSchedulerBase::GrantVirtualTimeBudget(
    base::TimeDelta budget,
    base::OnceClosure budget_exhausted_callback) {
  GetVirtualTimeTaskRunner()->PostDelayedTask(
      FROM_HERE, std::move(budget_exhausted_callback), budget);
  // This can shift time forwards if there's a pending MaybeAdvanceVirtualTime,
  // so it's important this is called second.
  virtual_time_domain_->SetVirtualTimeFence(GetTickClock()->NowTicks() +
                                            budget);
}

void ThreadSchedulerBase::SetVirtualTimePolicy(VirtualTimePolicy policy) {
  DCHECK(IsVirtualTimeEnabled());
  virtual_time_policy_ = policy;
  ApplyVirtualTimePolicy();
}

void ThreadSchedulerBase::SetMaxVirtualTimeTaskStarvationCount(
    int max_task_starvation_count) {
  DCHECK(IsVirtualTimeEnabled());
  max_virtual_time_task_starvation_count_ = max_task_starvation_count;
  ApplyVirtualTimePolicy();
}

WebScopedVirtualTimePauser
ThreadSchedulerBase::CreateWebScopedVirtualTimePauser(
    const WTF::String& name,
    WebScopedVirtualTimePauser::VirtualTaskDuration duration) {
  return WebScopedVirtualTimePauser(this, duration, name);
}

bool ThreadSchedulerBase::IsVirtualTimeEnabled() const {
  return !!virtual_time_domain_;
}

base::TimeTicks ThreadSchedulerBase::IncrementVirtualTimePauseCount() {
  virtual_time_pause_count_++;
  if (IsVirtualTimeEnabled())
    ApplyVirtualTimePolicy();
  return GetTickClock()->NowTicks();
}

void ThreadSchedulerBase::DecrementVirtualTimePauseCount() {
  virtual_time_pause_count_--;
  DCHECK_GE(virtual_time_pause_count_, 0);
  if (IsVirtualTimeEnabled())
    ApplyVirtualTimePolicy();
}

void ThreadSchedulerBase::MaybeAdvanceVirtualTime(
    base::TimeTicks new_virtual_time) {
  if (virtual_time_domain_)
    virtual_time_domain_->MaybeAdvanceVirtualTime(new_virtual_time);
}

AutoAdvancingVirtualTimeDomain* ThreadSchedulerBase::GetVirtualTimeDomain() {
  return virtual_time_domain_.get();
}

ThreadSchedulerBase::ThreadSchedulerBase() = default;
ThreadSchedulerBase::~ThreadSchedulerBase() = default;

void ThreadSchedulerBase::DispatchOnTaskCompletionCallbacks() {
  for (auto& closure : GetOnTaskCompletionCallbacks()) {
    std::move(closure).Run();
  }
  GetOnTaskCompletionCallbacks().clear();
}

namespace {
const char* VirtualTimePolicyToString(
    VirtualTimeController::VirtualTimePolicy virtual_time_policy) {
  switch (virtual_time_policy) {
    case VirtualTimeController::VirtualTimePolicy::kAdvance:
      return "ADVANCE";
    case VirtualTimeController::VirtualTimePolicy::kPause:
      return "PAUSE";
    case VirtualTimeController::VirtualTimePolicy::kDeterministicLoading:
      return "DETERMINISTIC_LOADING";
  }
}
}  // namespace

void ThreadSchedulerBase::WriteVirtualTimeInfoIntoTrace(
    perfetto::TracedDictionary& dict) const {
  dict.Add("virtual_time_stopped", virtual_time_stopped_);
  dict.Add("virtual_time_pause_count", virtual_time_pause_count_);
  dict.Add("virtual_time_policy",
           VirtualTimePolicyToString(virtual_time_policy_));
  dict.Add("virtual_time", !!virtual_time_domain_);
}

void ThreadSchedulerBase::SetVirtualTimeStopped(bool virtual_time_stopped) {
  DCHECK(virtual_time_domain_);
  if (virtual_time_stopped_ == virtual_time_stopped)
    return;
  virtual_time_stopped_ = virtual_time_stopped;
  virtual_time_domain_->SetCanAdvanceVirtualTime(!virtual_time_stopped);

  if (virtual_time_stopped)
    OnVirtualTimePaused();
  else
    OnVirtualTimeResumed();
}

void ThreadSchedulerBase::ApplyVirtualTimePolicy() {
  DCHECK(virtual_time_domain_);
  switch (virtual_time_policy_) {
    case VirtualTimePolicy::kAdvance:
      virtual_time_domain_->SetMaxVirtualTimeTaskStarvationCount(
          GetHelper().IsInNestedRunloop()
              ? 0
              : max_virtual_time_task_starvation_count_);
      virtual_time_domain_->SetVirtualTimeFence(base::TimeTicks());
      SetVirtualTimeStopped(false);
      break;
    case VirtualTimePolicy::kPause:
      virtual_time_domain_->SetMaxVirtualTimeTaskStarvationCount(0);
      virtual_time_domain_->SetVirtualTimeFence(GetTickClock()->NowTicks());
      SetVirtualTimeStopped(true);
      break;
    case VirtualTimePolicy::kDeterministicLoading:
      virtual_time_domain_->SetMaxVirtualTimeTaskStarvationCount(
          GetHelper().IsInNestedRunloop()
              ? 0
              : max_virtual_time_task_starvation_count_);

      // We pause virtual time while the run loop is nested because that implies
      // something modal is happening such as the DevTools debugger pausing the
      // system. We also pause while the renderer is waiting for various
      // asynchronous things e.g. resource load or navigation.
      SetVirtualTimeStopped(virtual_time_pause_count_ != 0 ||
                            GetHelper().IsInNestedRunloop());
      break;
  }
}

void ThreadSchedulerBase::OnBeginNestedRunLoop() {
  if (IsVirtualTimeEnabled())
    ApplyVirtualTimePolicy();
}

void ThreadSchedulerBase::OnExitNestedRunLoop() {
  if (IsVirtualTimeEnabled())
    ApplyVirtualTimePolicy();
}

}  // namespace scheduler
}  // namespace blink