summaryrefslogtreecommitdiffstats
path: root/gfx/layers/apz/src/PotentialCheckerboardDurationTracker.cpp
blob: 28730ae5aadba2332e3d43de251b5a363fdca879 (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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "PotentialCheckerboardDurationTracker.h"

#include "mozilla/Telemetry.h"           // for Telemetry
#include "mozilla/glean/GleanMetrics.h"  // for Glean telemetry

namespace mozilla {
namespace layers {

PotentialCheckerboardDurationTracker::PotentialCheckerboardDurationTracker()
    : mInCheckerboard(false), mInTransform(false) {}

void PotentialCheckerboardDurationTracker::CheckerboardSeen() {
  // This might get called while mInCheckerboard is already true
  if (!Tracking()) {
    mCurrentPeriodStart = TimeStamp::Now();
  }
  mInCheckerboard = true;
}

void PotentialCheckerboardDurationTracker::CheckerboardDone(
    bool aRecordTelemetry) {
  MOZ_ASSERT(Tracking());
  mInCheckerboard = false;
  if (!Tracking()) {
    if (aRecordTelemetry) {
      mozilla::glean::gfx_checkerboard::potential_duration
          .AccumulateRawDuration(mCurrentPeriodStart - TimeStamp::Now());
    }
  }
}

void PotentialCheckerboardDurationTracker::InTransform(bool aInTransform,
                                                       bool aRecordTelemetry) {
  if (aInTransform == mInTransform) {
    // no-op
    return;
  }

  if (!Tracking()) {
    // Because !Tracking(), mInTransform must be false, and so aInTransform
    // must be true (or we would have early-exited this function already).
    // Therefore, we are starting a potential checkerboard period.
    mInTransform = aInTransform;
    mCurrentPeriodStart = TimeStamp::Now();
    return;
  }

  mInTransform = aInTransform;

  if (!Tracking()) {
    // Tracking() must have been true at the start of this function, or we
    // would have taken the other !Tracking branch above. If it's false now,
    // it means we just stopped tracking, so we are ending a potential
    // checkerboard period.
    if (aRecordTelemetry) {
      mozilla::Telemetry::AccumulateTimeDelta(
          mozilla::Telemetry::CHECKERBOARD_POTENTIAL_DURATION,
          mCurrentPeriodStart);
    }
  }
}

bool PotentialCheckerboardDurationTracker::Tracking() const {
  return mInTransform || mInCheckerboard;
}

}  // namespace layers
}  // namespace mozilla