x86/turbostat/turbostat.8

3 turbostat \- Report processor frequency and idle statistics
12 .RB [ "\--interval seconds" ]
15 idle power-state statistics, temperature and power on X86 processors.
19 in one-shot upon its completion.
22 The 5-second interval can be changed using the --interval option.
26 Options can be specified with a single or double '-', and only as much of the option
27 name as necessary to disambiguate it from others is necessary.  Note that options are case-sensitiv…
29 \fB--add attributes\fP add column with counter having specified 'attributes'.  The 'location' attri…
39 … event for given device from /sys/bus/event_source/devices/<device>/events/<event> eg. c1-residency
40 …perf/cstate_core/c1-residency would then use /sys/bus/event_source/devices/cstate_core/events/c1-r…
47 		MSRs are read as 64-bits, u32 truncates the displayed value to 32-bits.
57 		Any string that does not match a key-word above is used
61 …--add pmt,[attr_name=attr_value, ...]\fP add column with a PMT (Intel Platform Monitoring Technolo…
79 …'%u' denotes id of the domain that the counter is associated with. For example core4 would mean th…
94 …--cpu cpu-set\fP limit output to system summary plus the specified cpu-set.  If cpu-set is the str…
96 \fB--hide column\fP do not show the specified built-in columns.  May be invoked multiple times, or …
98 \fB--enable column\fP show the specified built-in columns, which are otherwise disabled, by default…
99 The column name "all" can be used to enable all disabled-by-default built-in counters.
101 \fB--show column\fP show only the specified built-in columns.  May be invoked multiple times, or wi…
103 …--show CATEGORY --hide CATEGORY\fP  Show and hide also accept a single CATEGORY of columns: "all",…
105 \fB--Dump\fP displays the raw counter values.
107 \fB--quiet\fP Do not decode and print the system configuration header information.
109 \fB--no-msr\fP Disable all the uses of the MSR driver.
111 \fB--no-perf\fP Disable all the uses of the perf API.
113 \fB--interval seconds\fP overrides the default 5.0 second measurement interval.
115 \fB--num_iterations num\fP number of the measurement iterations.
117 \fB--out output_file\fP turbostat output is written to the specified output_file.
120 \fB--help\fP displays usage for the most common parameters.
122 \fB--Joules\fP displays energy in Joules, rather than dividing Joules by time to print power in Wat…
124 \fB--list\fP display column header names available for use by --show and --hide, then exit.
126 \fB--Summary\fP limits output to a 1-line System Summary for each interval.
128 \fB--TCC temperature\fP sets the Thermal Control Circuit temperature for systems which do not expor…
130 \fB--version\fP displays the version.
136 …--quiet is not used) is followed by statistics.  The first row of the statistics labels the conten…
139 …on, including thread migration -- if any.  This counter is disabled by default, and is enabled wit…
141 …s column is disabled by default, and can be enabled with "--enable Time_Of_Day_Seconds" or "--debu…
143 …umber.  Note that multiple CPUs per core indicate support for Intel(R) Hyper-Threading Technology …
145 …it is okay that on many systems the CPUs are not listed in numerical order -- for efficiency reaso…
147 \fBPackage\fP processor package number -- not present on systems with a single processor package.
149 \fBAvg_MHz\fP number of cycles executed divided by time elapsed.  Note that this includes idle-time…
151 …rcent of the measurement interval that the CPU executes instructions, aka. % of time in "C0" state.
153 \fBBzy_MHz\fP average clock rate while the CPU was not idle (ie. in "c0" state).
159 …ced CPU during the measurement interval.  While this counter is actually per-CPU, SMI are triggere…
161 …idle state during the measurement interval.  The system summary line shows the sum for all CPUs.  …
163 …idle governor idle state misprediction statistics. Inidcates the number times Linux requested the …
165 …-, C2-, C3-...\fP The idle governor idle state misprediction statistics. Inidcates the number time…
169 \fBCPU%c1, CPU%c3, CPU%c6, CPU%c7\fP show the percentage residency in hardware core idle states.  T…
171 \fBCoreTmp\fP Degrees Celsius reported by the per-core Digital Thermal Sensor.
173 \fBPkgTmp\fP Degrees Celsius reported by the per-package Package Thermal Monitor.
177 \fBGFX%rc6\fP The percentage of time the GPU is in the "render C6" state, rc6, during the measureme…
183 \fBSAM%mc6\fP The percentage of time the SA Media is in the "module C6" state, mc6, during the meas…
189 \fBPkg%pc2, Pkg%pc3, Pkg%pc6, Pkg%pc7\fP percentage residency in hardware package idle states.  The…
195 \fBGFXWatt\fP Watts consumed by the Graphics part of the package -- available only on client proces…
197 \fBRAMWatt\fP Watts consumed by the DRAM DIMMS -- available only on server processors.
201 … of the package throttling time, and thus may be higher than 100% on a multi-package system.  Note…
205 \fBUncMHz\fP per-package uncore MHz, instantaneous sample.
207 \fBUMHz1.0\fP per-package uncore MHz for domain=1 and fabric_cluster=0, instantaneous sample.  Syst…
208 Intel Granite Rapids systems use domains 0-2 for CPUs, and 3-4 for IO, with cluster always 0.
209 For the "--show" and "--hide" options, use "UncMHz" to operate on all UMHz*.* as a group.
211 By default, turbostat dumps all possible information -- a system configuration header, followed by …
212 This is ideal for remote debugging, use the "--out" option to save everything to a text file, and g…
214 …--quiet" option will skip the configuration information, and turbostat will show only the counter …
216 …--show and --hide, the "--list" option is available.  Usually, the CATEGORY names above are used t…
219 sudo ./turbostat --show sysfs --quiet sleep 10
237 Output can instead be saved to a file using the --out option.
241 [root@hsw]# ./turbostat -o ts.out sleep 10
247 Periodic output goes to stdout, by default, unless --out is used to specify an output file.
248 The 5-second interval can be changed with the "-i sec" option.
250 sudo turbostat --quiet --show CPU,frequency
252 	-	-	524	12.48	4198	3096	74.53	3800
262 	-	-	525	12.52	4198	3096	74.54	3800
272 This example also shows the use of the --show option to show only the desired columns.
277 before taking measurements.  In the example above, "--quiet" is used
280 turbostat version 2022.04.16 - Len Brown <lenb@kernel.org>
281 Kernel command line: BOOT_IMAGE=/boot/vmlinuz-5.18.0-rc6-00001-ge6891250e3b5 ...
285 CPUID(1): SSE3 MONITOR - EIST TM2 TSC MSR ACPI-TM HT TM
286 CPUID(6): APERF, TURBO, DTS, PTM, HWP, HWPnotify, HWPwindow, HWPepp, No-HWPpkg, EPB
293 cpu7: MSR_MISC_PWR_MGMT: 0x00401cc0 (ENable-EIST_Coordination DISable-EPB DISable-OOB)
298 cpu7: MSR_IA32_POWER_CTL: 0x002c005d (C1E auto-promotion: DISabled)
309 …SR_PKG_CST_CONFIG_CONTROL: 0x1e008008 (UNdemote-C3, UNdemote-C1, demote-C3, demote-C1, locked, pkg…
310 Uncore Frequency pkg0 die0: 800 - 3900 MHz (800 - 3900 MHz)
315 cpu7: POLL: CPUIDLE CORE POLL IDLE
327 cpu7: MSR_MISC_FEATURE_CONTROL: 0x00000000 (L2-Prefetch L2-Prefetch-pair L1-Prefetch L1-IP-Prefetch)
332 cpu0: MSR_HWP_STATUS: 0x00000004 (No-Guaranteed_Perf_Change, No-Excursion_Min)
335 cpu0: MSR_PKG_POWER_INFO: 0x00000168 (45 W TDP, RAPL 0 - 0 W, 0.000000 sec.)
349 cpu0: MSR_IA32_TEMPERATURE_TARGET: 0x00640000 (100 C) (100 default - 0 offset)
362 frequency of the processor -- this should match the brand string
366 depending on the number of idle cores.  Note that not all information is
369 Here we limit turbostat to showing just the CPU number for cpu0 - cpu3.
370 We add a counter showing the 32-bit raw value of MSR 0x199 (MSR_IA32_PERF_CTL),
374 sudo ./turbostat --quiet --cpu 0-3 --show CPU --add msr0x199,u32,raw,PRF_CTRL sleep .1
377 -	0x00000000
386 Here we limit turbostat to showing just the CPU number for cpu0 - cpu3.
390 We also show CPU%c1 built-in counter that should show similar values.
392 sudo ./turbostat --quiet --cpu 0-3 --show CPU,CPU%c1 --add perf/cstate_core/c1-residency,cpu,delta,…
395 -       34.89   34.89
414 …--quiet --cpu 0,12 --show CPU --add perf/cpu/cache-misses,cpu,delta,raw,VCMISS --add perf/cpu_core…
415 turbostat: added_perf_counters_init_: perf/cpu_atom/cache-misses: failed to open counter on cpu0
416 turbostat: added_perf_counters_init_: perf/cpu_core/cache-misses: failed to open counter on cpu12
419 -       0x0000000000000000      0x0000000000000000      0x0000000000000000
434 we set the domain to 'package0', to collect it and associate it with the whole package number 0,
443 we set the domain to 'package0', to collect it and associate it with the whole package number 0,
449 …--quiet --cpu 0 --show CPU --add pmt,name=XTAL,type=raw,format=delta,domain=package0,offset=0,lsb=…
452 -       0x0000006d4d957ca7      0.00
459 For interval-mode, turbostat will immediately end the current interval
462 Control-C will be send a SIGINT to turbostat,
466 SIGINT will interrupt interval-mode.
467 The end-of-interval data will be collected and displayed before turbostat exits.
470 end-of-interval data will be collected and displayed before turbostat
476 Alternatively, non-root users can be enabled to run turbostat this way:
490 may work poorly on Linux-2.6.20 through 2.6.29,
491 as \fBacpi-cpufreq \fPperiodically cleared the APERF and MPERF MSRs
495 number of elapsed cycles divided by the entire sample interval --
496 including idle time.  Note that this calculation is resilient
497 to systems lacking a non-stop TSC.
503 the TSC stops in idle, TSC_MHz will drop
519 The APERF, MPERF MSRs are defined to count non-halted cycles.