File: system_power_monitor.h

package info (click to toggle)
chromium 138.0.7204.92-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,576 kB
  • sloc: cpp: 34,933,512; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,956; 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 (107 lines) | stat: -rw-r--r-- 3,454 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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_POWER_METRICS_SYSTEM_POWER_MONITOR_H_
#define COMPONENTS_POWER_METRICS_SYSTEM_POWER_MONITOR_H_

#include <memory>
#include <vector>

#include "base/threading/sequence_bound.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "base/trace_event/trace_log.h"
#include "components/power_metrics/energy_metrics_provider.h"

namespace power_metrics {

// A delegate to isolate System Power Monitor functionality mainly for
// testing.
class SystemPowerMonitorDelegate {
 public:
  SystemPowerMonitorDelegate();

  SystemPowerMonitorDelegate(const SystemPowerMonitorDelegate&) = delete;
  SystemPowerMonitorDelegate& operator=(const SystemPowerMonitorDelegate&) =
      delete;

  virtual ~SystemPowerMonitorDelegate();

  // Emits trace counter. The metric string stands for trace counter name,
  // timestamp is the counter timestamp, power is the corresponding counter
  // value of system power consumption in units of milliwatts.
  virtual void RecordSystemPower(const char* metric,
                                 base::TimeTicks timestamp,
                                 int64_t power);

  // Returns whether the tracing category is enabled to determine if we should
  // record.
  virtual bool IsTraceCategoryEnabled() const;
};

// Manages a timer to regularly sample and emit trace events, whose start and
// stop are controlled by System Power Monitor.
class SystemPowerMonitorHelper {
 public:
  // Default sampling interval, which should be set to larger or equal to 50 ms.
  static constexpr base::TimeDelta kDefaultSampleInterval =
      base::Milliseconds(50);

  SystemPowerMonitorHelper(
      std::unique_ptr<EnergyMetricsProvider> provider,
      std::unique_ptr<SystemPowerMonitorDelegate> delegate);

  SystemPowerMonitorHelper(const SystemPowerMonitorHelper&) = delete;
  SystemPowerMonitorHelper& operator=(const SystemPowerMonitorHelper&) = delete;

  ~SystemPowerMonitorHelper();

  void Start();
  void Stop();
  void Sample();

  bool IsTimerRunningForTesting();

 private:
  std::vector<const char*> valid_metrics_;
  EnergyMetricsProvider::EnergyMetrics last_sample_;
  base::TimeTicks last_timestamp_;
  base::RepeatingTimer timer_;

  // Used to derive instant system energy metrics.
  std::unique_ptr<EnergyMetricsProvider> provider_;
  std::unique_ptr<SystemPowerMonitorDelegate> delegate_;
};

// Monitors system-wide power consumption. Gets data from EnergyMetricsProvider.
class SystemPowerMonitor
    : public base::trace_event::TraceLog::EnabledStateObserver {
 public:
  SystemPowerMonitor();

  SystemPowerMonitor(const SystemPowerMonitor&) = delete;
  SystemPowerMonitor& operator=(const SystemPowerMonitor&) = delete;

  ~SystemPowerMonitor() override;

  static SystemPowerMonitor* GetInstance();

  // TraceLog::EnabledStateObserver.
  void OnTraceLogEnabled() override;
  void OnTraceLogDisabled() override;

 private:
  friend class SystemPowerMonitorTest;

  SystemPowerMonitor(std::unique_ptr<EnergyMetricsProvider> provider,
                     std::unique_ptr<SystemPowerMonitorDelegate> delegate);

  base::SequenceBound<SystemPowerMonitorHelper>* GetHelperForTesting();

  base::SequenceBound<SystemPowerMonitorHelper> helper_;
};

}  // namespace power_metrics

#endif  // COMPONENTS_POWER_METRICS_SYSTEM_POWER_MONITOR_H_