File: histogram.h

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 (124 lines) | stat: -rw-r--r-- 4,769 bytes parent folder | download | duplicates (6)
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
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_HISTOGRAM_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_HISTOGRAM_H_

#include <stdint.h>
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/metrics/histogram_base.h"
#include "base/metrics/histogram_macros.h"
#include "base/time/default_tick_clock.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"

namespace base {
class HistogramBase;
}

namespace blink {

class PLATFORM_EXPORT CustomCountHistogram {
  USING_FAST_MALLOC(CustomCountHistogram);

 public:
  // Min values should be >=1 as emitted 0s still go into the underflow bucket.
  CustomCountHistogram(const char* name,
                       base::HistogramBase::Sample32 min,
                       base::HistogramBase::Sample32 max,
                       int32_t bucket_count);
  void Count(base::HistogramBase::Sample32);
  void CountMany(base::HistogramBase::Sample32, int count);
  void CountMicroseconds(base::TimeDelta);

 protected:
  explicit CustomCountHistogram(base::HistogramBase*);

  raw_ptr<base::HistogramBase> histogram_;
};

template <typename Derived>
class ScopedUsHistogramTimerBase {
  USING_FAST_MALLOC(ScopedUsHistogramTimerBase);

 public:
  explicit ScopedUsHistogramTimerBase(CustomCountHistogram& counter)
      : ScopedUsHistogramTimerBase(counter,
                                   base::DefaultTickClock::GetInstance()) {}

  ScopedUsHistogramTimerBase(CustomCountHistogram& counter,
                             const base::TickClock* clock)
      : clock_(*clock), start_time_(clock_->NowTicks()), counter_(counter) {}

  ~ScopedUsHistogramTimerBase() {
    if (Derived::ShouldRecord())
      counter_->CountMicroseconds(clock_->NowTicks() - start_time_);
  }

 private:
  const raw_ref<const base::TickClock> clock_;
  base::TimeTicks start_time_;
  const raw_ref<CustomCountHistogram> counter_;
};

class ScopedUsHistogramTimer
    : public ScopedUsHistogramTimerBase<ScopedUsHistogramTimer> {
 public:
  using ScopedUsHistogramTimerBase::ScopedUsHistogramTimerBase;
  static bool ShouldRecord() { return true; }
};

class ScopedHighResUsHistogramTimer
    : public ScopedUsHistogramTimerBase<ScopedHighResUsHistogramTimer> {
 public:
  using ScopedUsHistogramTimerBase::ScopedUsHistogramTimerBase;
  static bool ShouldRecord() { return base::TimeTicks::IsHighResolution(); }
};

static constexpr base::HistogramBase::Sample32 kTimeBasedHistogramMinSample = 1;
static constexpr base::HistogramBase::Sample32 kTimeBasedHistogramMaxSample =
    static_cast<base::Histogram::Sample32>(base::Seconds(10).InMicroseconds());
static constexpr int32_t kTimeBasedHistogramBucketCount = 50;

#define SCOPED_BLINK_UMA_HISTOGRAM_TIMER_IMPL(name, allow_cross_thread)  \
  DEFINE_STATIC_LOCAL_IMPL(                                              \
      CustomCountHistogram, scoped_us_counter,                           \
      (name, kTimeBasedHistogramMinSample, kTimeBasedHistogramMaxSample, \
       kTimeBasedHistogramBucketCount),                                  \
      allow_cross_thread);                                               \
  ScopedUsHistogramTimer timer(scoped_us_counter);

#define SCOPED_BLINK_UMA_HISTOGRAM_TIMER_HIGHRES_IMPL(name,               \
                                                      allow_cross_thread) \
  DEFINE_STATIC_LOCAL_IMPL(CustomCountHistogram, scoped_us_counter,       \
                           (name, 0, 10000000, 50), allow_cross_thread);  \
  ScopedHighResUsHistogramTimer timer(scoped_us_counter);

// Use code like this to record time, in microseconds, to execute a block of
// code:
//
// {
//     SCOPED_BLINK_UMA_HISTOGRAM_TIMER(myUmaStatName)
//     RunMyCode();
// }
// This macro records all times between 0us and 10 seconds.
// Do not change this macro without renaming all metrics that use it!
#define SCOPED_BLINK_UMA_HISTOGRAM_TIMER(name) \
  SCOPED_BLINK_UMA_HISTOGRAM_TIMER_IMPL(name, false)

// Only record samples when we have a high resolution timer
#define SCOPED_BLINK_UMA_HISTOGRAM_TIMER_HIGHRES(name) \
  SCOPED_BLINK_UMA_HISTOGRAM_TIMER_HIGHRES_IMPL(name, false)

// Thread-safe variant of SCOPED_BLINK_UMA_HISTOGRAM_TIMER.
// Use if the histogram can be accessed by multiple threads.
#define SCOPED_BLINK_UMA_HISTOGRAM_TIMER_THREAD_SAFE(name) \
  SCOPED_BLINK_UMA_HISTOGRAM_TIMER_IMPL(name, true)

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_HISTOGRAM_H_