xref: /linux/tools/perf/pmu-events/common_metrics.py (revision c7decec2f2d2ab0366567f9e30c0e1418cece43f) 
1# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
2from metric import (d_ratio, Event, Metric, MetricGroup)
3
4
5def Cycles() -> MetricGroup:
6    cyc_k = Event("cpu\\-cycles:kHh")  # exclude user and guest
7    cyc_g = Event("cpu\\-cycles:G")   # exclude host
8    cyc_u = Event("cpu\\-cycles:uH")  # exclude kernel, hypervisor and guest
9    cyc = cyc_k + cyc_g + cyc_u
10
11    return MetricGroup("lpm_cycles", [
12        Metric("lpm_cycles_total", "Total number of cycles", cyc, "cycles"),
13        Metric("lpm_cycles_user", "User cycles as a percentage of all cycles",
14               d_ratio(cyc_u, cyc), "100%"),
15        Metric("lpm_cycles_kernel", "Kernel cycles as a percentage of all cycles",
16               d_ratio(cyc_k, cyc), "100%"),
17        Metric("lpm_cycles_guest", "Hypervisor guest cycles as a percentage of all cycles",
18               d_ratio(cyc_g, cyc), "100%"),
19    ], description="cycles breakdown per privilege level (users, kernel, guest)")
20