File: cpu_measurement_delegate.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; 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,811; 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 (71 lines) | stat: -rw-r--r-- 2,821 bytes parent folder | download | duplicates (4)
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
// 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_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_CPU_MEASUREMENT_DELEGATE_H_
#define COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_CPU_MEASUREMENT_DELEGATE_H_

#include <memory>

#include "base/process/process_metrics.h"
#include "base/time/time.h"
#include "base/types/expected.h"

namespace performance_manager {
class Graph;
class ProcessNode;
}  // namespace performance_manager

namespace resource_attribution {

// A shim that Resource Attribution queries use to request CPU measurements for
// a process. A new CPUMeasurementDelegate object will be created for each
// ProcessNode to be measured. Public so that users of the API can inject a test
// override by passing a factory object to SetDelegateFactoryForTesting().
class CPUMeasurementDelegate {
 public:
  class Factory;

  // Export ProcessCPUUsageError so callers don't need to include
  // "base/process/process_metrics.h" for the definition.
  using ProcessCPUUsageError = base::ProcessCPUUsageError;

  // The given `factory` will be used to create a CPUMeasurementDelegate for
  // each ProcessNode in `graph` to be measured. The factory object must outlive
  // the graph. Usually it's owned by the test harness. nullptr will cause the
  // factory returned by GetDefaultFactory() to be used.
  static void SetDelegateFactoryForTesting(performance_manager::Graph* graph,
                                           Factory* factory);

  // Returns the default factory to use in production.
  static Factory* GetDefaultFactory();

  CPUMeasurementDelegate() = default;
  virtual ~CPUMeasurementDelegate() = default;

  // Requests CPU usage for the process. Should match the semantics of
  // ProcessMetrics::GetCumulativeCPUUsage().
  virtual base::expected<base::TimeDelta, ProcessCPUUsageError>
  GetCumulativeCPUUsage() = 0;
};

class CPUMeasurementDelegate::Factory {
 public:
  virtual ~Factory() = default;

  // Returns true iff a CPUMeasurementDelegate should be created for
  // `process_node`. The production factory returns true to measure
  // renderer processes with a valid (running) base::Process and a
  // base::ProcessId assigned.
  virtual bool ShouldMeasureProcess(
      const performance_manager::ProcessNode* process_node) = 0;

  // Creates a CPUMeasurementDelegate for `process_node`. This should only be
  // called if ShouldMeasureProcess(process_node) returns true.
  virtual std::unique_ptr<CPUMeasurementDelegate> CreateDelegateForProcess(
      const performance_manager::ProcessNode* process_node) = 0;
};

}  // namespace resource_attribution

#endif  // COMPONENTS_PERFORMANCE_MANAGER_PUBLIC_RESOURCE_ATTRIBUTION_CPU_MEASUREMENT_DELEGATE_H_