summaryrefslogtreecommitdiffstats
path: root/cc/scheduler/compositor_timing_history.cc
blob: d6727ede13491db869a1ce298345716a604531c2 (plain)
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
// Copyright 2014 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/scheduler/compositor_timing_history.h"

#include "base/metrics/histogram.h"
#include "base/trace_event/trace_event.h"
#include "cc/debug/rendering_stats_instrumentation.h"

namespace cc {

class CompositorTimingHistory::UMAReporter {
 public:
  virtual ~UMAReporter() {}

  virtual void AddBeginMainFrameToCommitDuration(base::TimeDelta duration,
                                                 base::TimeDelta estimate,
                                                 bool affects_estimate) = 0;
  virtual void AddCommitToReadyToActivateDuration(base::TimeDelta duration,
                                                  base::TimeDelta estimate,
                                                  bool affects_estimate) = 0;
  virtual void AddPrepareTilesDuration(base::TimeDelta duration,
                                       base::TimeDelta estimate,
                                       bool affects_estimate) = 0;
  virtual void AddActivateDuration(base::TimeDelta duration,
                                   base::TimeDelta estimate,
                                   bool affects_estimate) = 0;
  virtual void AddDrawDuration(base::TimeDelta duration,
                               base::TimeDelta estimate,
                               bool affects_estimate) = 0;
};

namespace {

// The estimates that affect the compositors deadline use the 100th percentile
// to avoid missing the Browser's deadline.
// The estimates related to main-thread responsiveness affect whether
// we attempt to recovery latency or not and use the 50th percentile.
// TODO(brianderson): Fine tune the percentiles below.
const size_t kDurationHistorySize = 60;
const size_t kDrawsBeforeEstimatesAffected = 2;
const double kBeginMainFrameToCommitEstimationPercentile = 50.0;
const double kCommitToReadyToActivateEstimationPercentile = 50.0;
const double kPrepareTilesEstimationPercentile = 100.0;
const double kActivateEstimationPercentile = 100.0;
const double kDrawEstimationPercentile = 100.0;

const int kUmaDurationMin_uS = 1;
const int64 kUmaDurationMax_uS = 1 * base::Time::kMicrosecondsPerSecond;
const size_t kUmaDurationBucketCount = 100;

// Deprecated because they combine Browser and Renderer stats and have low
// precision.
// TODO(brianderson): Remove.
void DeprecatedDrawDurationUMA(base::TimeDelta duration,
                               base::TimeDelta estimate) {
  base::TimeDelta duration_overestimate;
  base::TimeDelta duration_underestimate;
  if (duration > estimate)
    duration_underestimate = duration - estimate;
  else
    duration_overestimate = estimate - duration;
  UMA_HISTOGRAM_CUSTOM_TIMES("Renderer.DrawDuration", duration,
                             base::TimeDelta::FromMilliseconds(1),
                             base::TimeDelta::FromMilliseconds(100), 50);
  UMA_HISTOGRAM_CUSTOM_TIMES("Renderer.DrawDurationUnderestimate",
                             duration_underestimate,
                             base::TimeDelta::FromMilliseconds(1),
                             base::TimeDelta::FromMilliseconds(100), 50);
  UMA_HISTOGRAM_CUSTOM_TIMES("Renderer.DrawDurationOverestimate",
                             duration_overestimate,
                             base::TimeDelta::FromMilliseconds(1),
                             base::TimeDelta::FromMilliseconds(100), 50);
}

#define UMA_HISTOGRAM_CUSTOM_TIMES_MICROS(name, sample)  \
  UMA_HISTOGRAM_CUSTOM_COUNTS(                           \
      name, sample.InMicroseconds(), kUmaDurationMin_uS, \
      kUmaDurationMax_uS, kUmaDurationBucketCount);

#define REPORT_COMPOSITOR_TIMING_HISTORY_UMA(category, subcategory)            \
  do {                                                                         \
    base::TimeDelta duration_overestimate;                                     \
    base::TimeDelta duration_underestimate;                                    \
    if (duration > estimate)                                                   \
      duration_underestimate = duration - estimate;                            \
    else                                                                       \
      duration_overestimate = estimate - duration;                             \
    UMA_HISTOGRAM_CUSTOM_TIMES_MICROS(                                         \
        "Scheduling." category "." subcategory "Duration", duration);          \
    UMA_HISTOGRAM_CUSTOM_TIMES_MICROS("Scheduling." category "." subcategory   \
                                      "Duration.Underestimate",                \
                                      duration_underestimate);                 \
    UMA_HISTOGRAM_CUSTOM_TIMES_MICROS("Scheduling." category "." subcategory   \
                                      "Duration.Overestimate",                 \
                                      duration_overestimate);                  \
    if (!affects_estimate) {                                                   \
      UMA_HISTOGRAM_CUSTOM_TIMES_MICROS("Scheduling." category "." subcategory \
                                        "Duration.NotUsedForEstimate",         \
                                        duration);                             \
    }                                                                          \
  } while (false)

class RendererUMAReporter : public CompositorTimingHistory::UMAReporter {
 public:
  ~RendererUMAReporter() override {}

  void AddBeginMainFrameToCommitDuration(base::TimeDelta duration,
                                         base::TimeDelta estimate,
                                         bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Renderer", "BeginMainFrameToCommit");
  }

  void AddCommitToReadyToActivateDuration(base::TimeDelta duration,
                                          base::TimeDelta estimate,
                                          bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Renderer", "CommitToReadyToActivate");
  }

  void AddPrepareTilesDuration(base::TimeDelta duration,
                               base::TimeDelta estimate,
                               bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Renderer", "PrepareTiles");
  }

  void AddActivateDuration(base::TimeDelta duration,
                           base::TimeDelta estimate,
                           bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Renderer", "Activate");
  }

  void AddDrawDuration(base::TimeDelta duration,
                       base::TimeDelta estimate,
                       bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Renderer", "Draw");
    DeprecatedDrawDurationUMA(duration, estimate);
  }
};

class BrowserUMAReporter : public CompositorTimingHistory::UMAReporter {
 public:
  ~BrowserUMAReporter() override {}

  void AddBeginMainFrameToCommitDuration(base::TimeDelta duration,
                                         base::TimeDelta estimate,
                                         bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Browser", "BeginMainFrameToCommit");
  }

  void AddCommitToReadyToActivateDuration(base::TimeDelta duration,
                                          base::TimeDelta estimate,
                                          bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Browser", "CommitToReadyToActivate");
  }

  void AddPrepareTilesDuration(base::TimeDelta duration,
                               base::TimeDelta estimate,
                               bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Browser", "PrepareTiles");
  }

  void AddActivateDuration(base::TimeDelta duration,
                           base::TimeDelta estimate,
                           bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Browser", "Activate");
  }

  void AddDrawDuration(base::TimeDelta duration,
                       base::TimeDelta estimate,
                       bool affects_estimate) override {
    REPORT_COMPOSITOR_TIMING_HISTORY_UMA("Browser", "Draw");
    DeprecatedDrawDurationUMA(duration, estimate);
  }
};

class NullUMAReporter : public CompositorTimingHistory::UMAReporter {
 public:
  ~NullUMAReporter() override {}
  void AddPrepareTilesDuration(base::TimeDelta duration,
                               base::TimeDelta estimate,
                               bool affects_estimate) override {}
  void AddBeginMainFrameToCommitDuration(base::TimeDelta duration,
                                         base::TimeDelta estimate,
                                         bool affects_estimate) override {}
  void AddCommitToReadyToActivateDuration(base::TimeDelta duration,
                                          base::TimeDelta estimate,
                                          bool affects_estimate) override {}
  void AddActivateDuration(base::TimeDelta duration,
                           base::TimeDelta estimate,
                           bool affects_estimate) override {}
  void AddDrawDuration(base::TimeDelta duration,
                       base::TimeDelta estimate,
                       bool affects_estimate) override {}
};

}  // namespace

CompositorTimingHistory::CompositorTimingHistory(
    UMACategory uma_category,
    RenderingStatsInstrumentation* rendering_stats_instrumentation)
    : enabled_(false),
      draws_left_before_estimates_affected_(0),
      begin_main_frame_to_commit_duration_history_(kDurationHistorySize),
      commit_to_ready_to_activate_duration_history_(kDurationHistorySize),
      prepare_tiles_duration_history_(kDurationHistorySize),
      activate_duration_history_(kDurationHistorySize),
      draw_duration_history_(kDurationHistorySize),
      uma_reporter_(CreateUMAReporter(uma_category)),
      rendering_stats_instrumentation_(rendering_stats_instrumentation) {}

CompositorTimingHistory::~CompositorTimingHistory() {
}

scoped_ptr<CompositorTimingHistory::UMAReporter>
CompositorTimingHistory::CreateUMAReporter(UMACategory category) {
  switch (category) {
    case RENDERER_UMA:
      return make_scoped_ptr(new RendererUMAReporter);
      break;
    case BROWSER_UMA:
      return make_scoped_ptr(new BrowserUMAReporter);
      break;
    case NULL_UMA:
      return make_scoped_ptr(new NullUMAReporter);
      break;
  }
  NOTREACHED();
  return make_scoped_ptr<CompositorTimingHistory::UMAReporter>(nullptr);
}

void CompositorTimingHistory::AsValueInto(
    base::trace_event::TracedValue* state) const {
  state->SetDouble("begin_main_frame_to_commit_estimate_ms",
                   BeginMainFrameToCommitDurationEstimate().InMillisecondsF());
  state->SetDouble("commit_to_ready_to_activate_estimate_ms",
                   CommitToReadyToActivateDurationEstimate().InMillisecondsF());
  state->SetDouble("prepare_tiles_estimate_ms",
                   PrepareTilesDurationEstimate().InMillisecondsF());
  state->SetDouble("activate_estimate_ms",
                   ActivateDurationEstimate().InMillisecondsF());
  state->SetDouble("draw_estimate_ms",
                   DrawDurationEstimate().InMillisecondsF());
}

base::TimeTicks CompositorTimingHistory::Now() const {
  return base::TimeTicks::Now();
}

bool CompositorTimingHistory::AffectsEstimate() const {
  return enabled_ && (draws_left_before_estimates_affected_ == 0);
}

void CompositorTimingHistory::SetRecordingEnabled(bool enabled) {
  if (enabled == enabled_)
    return;

  enabled_ = enabled;

  if (enabled_)
    draws_left_before_estimates_affected_ = kDrawsBeforeEstimatesAffected;
}

base::TimeDelta
CompositorTimingHistory::BeginMainFrameToCommitDurationEstimate() const {
  return begin_main_frame_to_commit_duration_history_.Percentile(
      kBeginMainFrameToCommitEstimationPercentile);
}

base::TimeDelta
CompositorTimingHistory::CommitToReadyToActivateDurationEstimate() const {
  return commit_to_ready_to_activate_duration_history_.Percentile(
      kCommitToReadyToActivateEstimationPercentile);
}

base::TimeDelta CompositorTimingHistory::PrepareTilesDurationEstimate() const {
  return prepare_tiles_duration_history_.Percentile(
      kPrepareTilesEstimationPercentile);
}

base::TimeDelta CompositorTimingHistory::ActivateDurationEstimate() const {
  return activate_duration_history_.Percentile(kActivateEstimationPercentile);
}

base::TimeDelta CompositorTimingHistory::DrawDurationEstimate() const {
  return draw_duration_history_.Percentile(kDrawEstimationPercentile);
}

void CompositorTimingHistory::WillBeginMainFrame() {
  DCHECK_EQ(base::TimeTicks(), begin_main_frame_sent_time_);
  begin_main_frame_sent_time_ = Now();
}

void CompositorTimingHistory::BeginMainFrameAborted() {
  DidCommit();
}

void CompositorTimingHistory::DidCommit() {
  DCHECK_NE(base::TimeTicks(), begin_main_frame_sent_time_);

  commit_time_ = Now();

  base::TimeDelta begin_main_frame_to_commit_duration =
      commit_time_ - begin_main_frame_sent_time_;

  // Before adding the new data point to the timing history, see what we would
  // have predicted for this frame. This allows us to keep track of the accuracy
  // of our predictions.
  base::TimeDelta begin_main_frame_to_commit_estimate =
      BeginMainFrameToCommitDurationEstimate();

  rendering_stats_instrumentation_->AddBeginMainFrameToCommitDuration(
      begin_main_frame_to_commit_duration, begin_main_frame_to_commit_estimate);

  bool affects_estimate = AffectsEstimate();
  uma_reporter_->AddBeginMainFrameToCommitDuration(
      begin_main_frame_to_commit_duration, begin_main_frame_to_commit_estimate,
      affects_estimate);
  if (affects_estimate) {
    begin_main_frame_to_commit_duration_history_.InsertSample(
        begin_main_frame_to_commit_duration);
  }

  begin_main_frame_sent_time_ = base::TimeTicks();
}

void CompositorTimingHistory::WillPrepareTiles() {
  DCHECK_EQ(base::TimeTicks(), start_prepare_tiles_time_);
  start_prepare_tiles_time_ = Now();
}

void CompositorTimingHistory::DidPrepareTiles() {
  DCHECK_NE(base::TimeTicks(), start_prepare_tiles_time_);

  base::TimeDelta prepare_tiles_duration = Now() - start_prepare_tiles_time_;

  bool affects_estimate = AffectsEstimate();
  uma_reporter_->AddPrepareTilesDuration(
      prepare_tiles_duration, PrepareTilesDurationEstimate(), affects_estimate);
  if (affects_estimate)
    prepare_tiles_duration_history_.InsertSample(prepare_tiles_duration);

  start_prepare_tiles_time_ = base::TimeTicks();
}

void CompositorTimingHistory::ReadyToActivate() {
  // We only care about the first ready to activate signal
  // after a commit.
  if (commit_time_ == base::TimeTicks())
    return;

  base::TimeDelta time_since_commit = Now() - commit_time_;

  // Before adding the new data point to the timing history, see what we would
  // have predicted for this frame. This allows us to keep track of the accuracy
  // of our predictions.

  base::TimeDelta commit_to_ready_to_activate_estimate =
      CommitToReadyToActivateDurationEstimate();
  rendering_stats_instrumentation_->AddCommitToActivateDuration(
      time_since_commit, commit_to_ready_to_activate_estimate);

  bool affects_estimate = AffectsEstimate();
  uma_reporter_->AddCommitToReadyToActivateDuration(
      time_since_commit, commit_to_ready_to_activate_estimate,
      affects_estimate);
  if (affects_estimate) {
    commit_to_ready_to_activate_duration_history_.InsertSample(
        time_since_commit);
  }

  commit_time_ = base::TimeTicks();
}

void CompositorTimingHistory::WillActivate() {
  DCHECK_EQ(base::TimeTicks(), start_activate_time_);
  start_activate_time_ = Now();
}

void CompositorTimingHistory::DidActivate() {
  DCHECK_NE(base::TimeTicks(), start_activate_time_);
  base::TimeDelta activate_duration = Now() - start_activate_time_;

  bool affects_estimate = AffectsEstimate();
  uma_reporter_->AddActivateDuration(
      activate_duration, ActivateDurationEstimate(), affects_estimate);
  if (affects_estimate)
    activate_duration_history_.InsertSample(activate_duration);

  start_activate_time_ = base::TimeTicks();
}

void CompositorTimingHistory::WillDraw() {
  DCHECK_EQ(base::TimeTicks(), start_draw_time_);
  start_draw_time_ = Now();
}

void CompositorTimingHistory::DidDraw() {
  DCHECK_NE(base::TimeTicks(), start_draw_time_);
  base::TimeDelta draw_duration = Now() - start_draw_time_;

  // Before adding the new data point to the timing history, see what we would
  // have predicted for this frame. This allows us to keep track of the accuracy
  // of our predictions.
  base::TimeDelta draw_estimate = DrawDurationEstimate();
  rendering_stats_instrumentation_->AddDrawDuration(draw_duration,
                                                    draw_estimate);

  bool affects_estimate = AffectsEstimate();
  uma_reporter_->AddDrawDuration(draw_duration, draw_estimate,
                                 affects_estimate);
  if (affects_estimate)
    draw_duration_history_.InsertSample(draw_duration);

  if (draws_left_before_estimates_affected_ > 0)
    draws_left_before_estimates_affected_--;

  start_draw_time_ = base::TimeTicks();
}

}  // namespace cc