tools/perf/pmu-events/intel_metrics.py
Source file repositories/reference/linux-study-clean/tools/perf/pmu-events/intel_metrics.py
File Facts
- System
- Linux kernel
- Corpus path
tools/perf/pmu-events/intel_metrics.py- Extension
.py- Size
- 46100 bytes
- Lines
- 1130
- Domain
- Support Tooling And Documentation
- Bucket
- tools
- Inferred role
- Support Tooling And Documentation: tools
- Status
- atlas-only
Why This File Exists
Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
Dependency Surface
- No C-style include directives detected by the generator.
Detected Declarations
- No top-level syscall, struct, function, initcall, or export declaration detected by the generator.
Annotated Snippet
#!/usr/bin/env python3
# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
import argparse
import json
import math
import os
import re
from typing import Optional
from common_metrics import Cycles
from metric import (d_ratio, has_event, max, source_count, CheckPmu, Event,
JsonEncodeMetric, JsonEncodeMetricGroupDescriptions,
Literal, LoadEvents, Metric, MetricConstraint, MetricGroup,
MetricRef, Select)
# Global command line arguments.
_args = None
interval_sec = Event("duration_time")
def Idle() -> Metric:
cyc = Event("msr/mperf/")
tsc = Event("msr/tsc/")
low = max(tsc - cyc, 0)
return Metric(
"lpm_idle",
"Percentage of total wallclock cycles where CPUs are in low power state (C1 or deeper sleep state)",
d_ratio(low, tsc), "100%")
def Rapl() -> MetricGroup:
"""Processor power consumption estimate.
Use events from the running average power limit (RAPL) driver.
"""
# Watts = joules/second
pkg = Event("power/energy\\-pkg/")
cond_pkg = Select(pkg, has_event(pkg), math.nan)
cores = Event("power/energy\\-cores/")
cond_cores = Select(cores, has_event(cores), math.nan)
ram = Event("power/energy\\-ram/")
cond_ram = Select(ram, has_event(ram), math.nan)
gpu = Event("power/energy\\-gpu/")
cond_gpu = Select(gpu, has_event(gpu), math.nan)
psys = Event("power/energy\\-psys/")
cond_psys = Select(psys, has_event(psys), math.nan)
scale = 2.3283064365386962890625e-10
metrics = [
Metric("lpm_cpu_power_pkg", "",
d_ratio(cond_pkg * scale, interval_sec), "Watts"),
Metric("lpm_cpu_power_cores", "",
d_ratio(cond_cores * scale, interval_sec), "Watts"),
Metric("lpm_cpu_power_ram", "",
d_ratio(cond_ram * scale, interval_sec), "Watts"),
Metric("lpm_cpu_power_gpu", "",
d_ratio(cond_gpu * scale, interval_sec), "Watts"),
Metric("lpm_cpu_power_psys", "",
d_ratio(cond_psys * scale, interval_sec), "Watts"),
]
return MetricGroup("lpm_cpu_power", metrics,
description="Running Average Power Limit (RAPL) power consumption estimates")
def Smi() -> MetricGroup:
pmu = "<cpu_core or cpu_atom>" if CheckPmu("cpu_core") else "cpu"
aperf = Event('msr/aperf/')
cycles = Event('cycles')
smi_num = Event('msr/smi/')
smi_cycles = Select(Select((aperf - cycles) / aperf, smi_num > 0, 0),
has_event(aperf),
Annotation
- Atlas domain: Support Tooling And Documentation / tools.
- Implementation status: atlas-only.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.