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…
36 … event for given device from /sys/bus/event_source/devices/<device>/events/<event> eg. c1-residency
37 …perf/cstate_core/c1-residency would then use /sys/bus/event_source/devices/cstate_core/events/c1-r…
44 		MSRs are read as 64-bits, u32 truncates the displayed value to 32-bits.
54 		Any string that does not match a key-word above is used
58 …--add pmt,[attr_name=attr_value, ...]\fP add column with a PMT (Intel Platform Monitoring Technolo…
91 …--cpu cpu-set\fP limit output to system summary plus the specified cpu-set.  If cpu-set is the str…
93 \fB--hide column\fP do not show the specified built-in columns.  May be invoked multiple times, or …
95 \fB--enable column\fP show the specified built-in columns, which are otherwise disabled, by default…
96 The column name "all" can be used to enable all disabled-by-default built-in counters.
98 \fB--show column\fP show only the specified built-in columns.  May be invoked multiple times, or wi…
100 \fB--show CATEGORY --hide CATEGORY\fP  Show and hide also accept a single CATEGORY of columns: "all…
102 \fB--Dump\fP displays the raw counter values.
104 \fB--quiet\fP Do not decode and print the system configuration header information.
106 \fB--no-msr\fP Disable all the uses of the MSR driver.
108 \fB--no-perf\fP Disable all the uses of the perf API.
110 \fB--interval seconds\fP overrides the default 5.0 second measurement interval.
112 \fB--num_iterations num\fP number of the measurement iterations.
114 \fB--out output_file\fP turbostat output is written to the specified output_file.
117 \fB--help\fP displays usage for the most common parameters.
119 \fB--Joules\fP displays energy in Joules, rather than dividing Joules by time to print power in Wat…
121 \fB--list\fP display column header names available for use by --show and --hide, then exit.
123 \fB--Summary\fP limits output to a 1-line System Summary for each interval.
125 \fB--TCC temperature\fP sets the Thermal Control Circuit temperature for systems which do not expor…
127 \fB--version\fP displays the version.
133 …--quiet is not used) is followed by statistics.  The first row of the statistics labels the conten…
136 …on, including thread migration -- if any.  This counter is disabled by default, and is enabled wit…
138 …al were collected.  This column is disabled by default, and can be enabled with "--enable Time_Of_…
140 …umber.  Note that multiple CPUs per core indicate support for Intel(R) Hyper-Threading Technology …
142 …it is okay that on many systems the CPUs are not listed in numerical order -- for efficiency reaso…
144 \fBPackage\fP processor package number -- not present on systems with a single processor package.
146 \fBAvg_MHz\fP number of cycles executed divided by time elapsed.  Note that this includes idle-time…
156 …ced CPU during the measurement interval.  While this counter is actually per-CPU, SMI are triggere…
158 …-state names as exported in /sys/devices/system/cpu/cpu*/cpuidle/state*/name.  While their names a…
164 \fBCoreTmp\fP Degrees Celsius reported by the per-core Digital Thermal Sensor.
166 \fBPkgTmp\fP Degrees Celsius reported by the per-package Package Thermal Monitor.
186 \fBGFXWatt\fP Watts consumed by the Graphics part of the package -- available only on client proces…
188 \fBRAMWatt\fP Watts consumed by the DRAM DIMMS -- available only on server processors.
190 … of the package throttling time, and thus may be higher than 100% on a multi-package system.  Note…
194 \fBUncMHz\fP per-package uncore MHz, instantaneous sample.
196 \fBUMHz1.0\fP per-package uncore MHz for domain=1 and fabric_cluster=0, instantaneous sample.  Syst…
198 By default, turbostat dumps all possible information -- a system configuration header, followed by …
199 This is ideal for remote debugging, use the "--out" option to save everything to a text file, and g…
201 …--quiet" option will skip the configuration information, and turbostat will show only the counter …
203 …--show and --hide, the "--list" option is available.  Usually, the CATEGORY names above are used t…
206 sudo ./turbostat --show sysfs --quiet sleep 10
224 Output can instead be saved to a file using the --out option.
225 …ample, the "sleep 10" command is forked, and turbostat waits for it to complete before saving all …
228 [root@hsw]# ./turbostat -o ts.out sleep 10
234 Periodic output goes to stdout, by default, unless --out is used to specify an output file.
235 The 5-second interval can be changed with the "-i sec" option.
237 sudo turbostat --quiet --show CPU,frequency
239 	-	-	524	12.48	4198	3096	74.53	3800
249 	-	-	525	12.52	4198	3096	74.54	3800
259 This example also shows the use of the --show option to show only the desired columns.
264 before taking measurements.  In the example above, "--quiet" is used
267 turbostat version 2022.04.16 - Len Brown <lenb@kernel.org>
268 Kernel command line: BOOT_IMAGE=/boot/vmlinuz-5.18.0-rc6-00001-ge6891250e3b5 ...
272 CPUID(1): SSE3 MONITOR - EIST TM2 TSC MSR ACPI-TM HT TM
273 CPUID(6): APERF, TURBO, DTS, PTM, HWP, HWPnotify, HWPwindow, HWPepp, No-HWPpkg, EPB
280 cpu7: MSR_MISC_PWR_MGMT: 0x00401cc0 (ENable-EIST_Coordination DISable-EPB DISable-OOB)
285 cpu7: MSR_IA32_POWER_CTL: 0x002c005d (C1E auto-promotion: DISabled)
296 …SR_PKG_CST_CONFIG_CONTROL: 0x1e008008 (UNdemote-C3, UNdemote-C1, demote-C3, demote-C1, locked, pkg…
297 Uncore Frequency pkg0 die0: 800 - 3900 MHz (800 - 3900 MHz)
314 cpu7: MSR_MISC_FEATURE_CONTROL: 0x00000000 (L2-Prefetch L2-Prefetch-pair L1-Prefetch L1-IP-Prefetch)
319 cpu0: MSR_HWP_STATUS: 0x00000004 (No-Guaranteed_Perf_Change, No-Excursion_Min)
322 cpu0: MSR_PKG_POWER_INFO: 0x00000168 (45 W TDP, RAPL 0 - 0 W, 0.000000 sec.)
325 cpu0: PKG Limit #2: ENabled (65.000 Watts, 0.002441* sec, clamp DISabled)
329 cpu0: DRAM Limit: DISabled (0.000 Watts, 0.000977 sec, clamp DISabled)
332 cpu0: Cores Limit: DISabled (0.000 Watts, 0.000977 sec, clamp DISabled)
335 cpu0: GFX Limit: DISabled (0.000 Watts, 0.000977 sec, clamp DISabled)
336 cpu0: MSR_IA32_TEMPERATURE_TARGET: 0x00640000 (100 C) (100 default - 0 offset)
349 frequency of the processor -- this should match the brand string
356 Here we limit turbostat to showing just the CPU number for cpu0 - cpu3.
357 We add a counter showing the 32-bit raw value of MSR 0x199 (MSR_IA32_PERF_CTL),
359 after the conclusion of a 0.1 second sleep.
361 sudo ./turbostat --quiet --cpu 0-3 --show CPU --add msr0x199,u32,raw,PRF_CTRL sleep .1
364 -	0x00000000
373 Here we limit turbostat to showing just the CPU number for cpu0 - cpu3.
376 after the conclusion of 0.1 second sleep.
377 We also show CPU%c1 built-in counter that should show similar values.
379 sudo ./turbostat --quiet --cpu 0-3 --show CPU,CPU%c1 --add perf/cstate_core/c1-residency,cpu,delta,…
382 -       34.89   34.89
414 …o ./turbostat --quiet --cpu 0 --show CPU --add pmt,name=XTAL,type=raw,format=delta,domain=package0…
417 -       0x0000006d4d957ca7      0.00
424 For interval-mode, turbostat will immediately end the current interval
427 Control-C will be send a SIGINT to turbostat,
431 SIGINT will interrupt interval-mode.
432 The end-of-interval data will be collected and displayed before turbostat exits.
435 end-of-interval data will be collected and displayed before turbostat
441 Alternatively, non-root users can be enabled to run turbostat this way:
455 may work poorly on Linux-2.6.20 through 2.6.29,
456 as \fBacpi-cpufreq \fPperiodically cleared the APERF and MPERF MSRs
460 number of elapsed cycles divided by the entire sample interval --
462 to systems lacking a non-stop TSC.
484 The APERF, MPERF MSRs are defined to count non-halted cycles.