xref: /xnu-11417.101.15/doc/observability/cpu_counters.md (revision e3723e1f17661b24996789d8afc084c0c3303b26) !
1*e3723e1fSApple OSS Distributions# CPU Counters
2*e3723e1fSApple OSS Distributions
3*e3723e1fSApple OSS DistributionsThe xnu subsystems that manage CPU performance counters.
4*e3723e1fSApple OSS Distributions
5*e3723e1fSApple OSS Distributions## Overview
6*e3723e1fSApple OSS Distributions
7*e3723e1fSApple OSS DistributionsCPU performance counters are hardware registers that count events of interest to efficient CPU execution.
8*e3723e1fSApple OSS DistributionsCounters that measure events closely correlated with each CPU's execution pipeline are managed by the Core Performance Monitoring Unit (CPMU).
9*e3723e1fSApple OSS DistributionsThe CPMU contains both fixed instructions and cycles counters, as well as configurable counters that can be programmed to count any of several hundred possible events.
10*e3723e1fSApple OSS DistributionsIn addition to the CPMU, the Last Level Cache (LLC) hosts the Uncore Performance Monitoring Unit (UPMU), which measures effects that aren't necessarily correlated to a single CPU.
11*e3723e1fSApple OSS DistributionsAll counters in the UPMU are configurable.
12*e3723e1fSApple OSS Distributions
13*e3723e1fSApple OSS DistributionsCounters are typically used in one of two ways:
14*e3723e1fSApple OSS Distributions
15*e3723e1fSApple OSS Distributions1. In "counting" mode, their counts are periodically queried and tallied up for a duration of interest.
16*e3723e1fSApple OSS Distributions2. In "sampling" mode, the counters are programmed to generate a Performance Monitor Interrupt (PMI) periodically, during which the currently running code can be sampled, like a time profiler.
17*e3723e1fSApple OSS Distributions
18*e3723e1fSApple OSS Distributions## Subsystems
19*e3723e1fSApple OSS Distributions
20*e3723e1fSApple OSS DistributionsThere are several subsystems that provide access to CPU counter hardware:
21*e3723e1fSApple OSS Distributions
22*e3723e1fSApple OSS Distributions- kpc: The Kernel Performance Counter system is the oldest subsystem and still manages the configurable CPMU counters.
23*e3723e1fSApple OSS DistributionsIt can use PMIs from these counters to trigger kperf samples and counter values can be recorded in kperf samples.
24*e3723e1fSApple OSS Distributions
25*e3723e1fSApple OSS Distributions- Monotonic: The Monotonic system provides access to the fixed CPMU counters with limited support for PMIs.
26*e3723e1fSApple OSS DistributionsAdditionally, the UPMU is entirely provided by a Monotonic dev node interface.
27*e3723e1fSApple OSS Distributions
28*e3723e1fSApple OSS Distributions- cpc: The CPU Performance Counter subsystem provides a policy layer on top of kpc and Monotonic to prevent malicious use of the hardware.
29*e3723e1fSApple OSS Distributions
30*e3723e1fSApple OSS DistributionsEventually, cpc will subsume kpc's and Monotonic's roles in the system.
31*e3723e1fSApple OSS Distributions
32*e3723e1fSApple OSS Distributions## Integrations
33*e3723e1fSApple OSS Distributions
34*e3723e1fSApple OSS Distributions- The Recount subsystem makes extensive use of the fixed CPMU counters to attribute CPU resources back to threads and processes.
35*e3723e1fSApple OSS Distributions
36*e3723e1fSApple OSS Distributions- Microstackshot telemetry is sampled periodically using the CPMU's cycle PMI trigger.
37*e3723e1fSApple OSS Distributions
38*e3723e1fSApple OSS Distributions- Stackshot includes cycles and instructions for each thread container in its kcdata.
39*e3723e1fSApple OSS Distributions
40*e3723e1fSApple OSS Distributions- The kperf profiling system can trigger samples of thread states and call stacks using CPMU PMIs, allowing it to sample thread states and call stacks.
41*e3723e1fSApple OSS DistributionsAnd CPU counter values can be sampled by kperf on other triggers, like timers or kdebug events.
42*e3723e1fSApple OSS Distributions
43*e3723e1fSApple OSS Distributions## See Also
44*e3723e1fSApple OSS Distributions
45*e3723e1fSApple OSS Distributions- <doc:recount>
46