File: energy_metrics_provider.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (57 lines) | stat: -rw-r--r-- 1,943 bytes parent folder | download | duplicates (9)
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
// 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_ENERGY_METRICS_PROVIDER_H_
#define COMPONENTS_POWER_METRICS_ENERGY_METRICS_PROVIDER_H_

#include <cstdint>
#include <memory>
#include <optional>

namespace power_metrics {

// EnergyMetricsProvider provides system-wide energy consumption metrics.
class EnergyMetricsProvider {
 public:
  struct EnergyMetrics {
    // The absolute energy of the whole processor package.
    uint64_t package_nanojoules;
    // The absolute energy of all of the cores.
    uint64_t cpu_nanojoules;
    // The absolute energy of the uncore (usually the integrated GPU, only
    // available in client CPUs).
    uint64_t gpu_nanojoules;
    // The absolute energy of the DRAM (only available in server CPUs).
    uint64_t dram_nanojoules;
    // The absolute energy of the entire system.
    uint64_t psys_nanojoules;
    // The following metrics are emitted by AMD processors.
    // We don't know what they measure exactly.
    uint64_t vdd_nanojoules;
    uint64_t soc_nanojoules;
    uint64_t socket_nanojoules;
    uint64_t apu_nanojoules;
  };

  // Returns nullptr if no suitable implementation exists.
  static std::unique_ptr<EnergyMetricsProvider> Create();

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

  virtual ~EnergyMetricsProvider();

  // Used to capture energy consumption metrics. It returns nullopt if not
  // available on the current platform.
  virtual std::optional<EnergyMetrics> CaptureMetrics() = 0;

 protected:
  // The constructor is intentionally only exposed to subclasses. Production
  // code must use the Create() factory method.
  EnergyMetricsProvider();
};

}  // namespace power_metrics

#endif  // COMPONENTS_POWER_METRICS_ENERGY_METRICS_PROVIDER_H_