1 .TH TURBOSTAT 8
2 .SH NAME
3 turbostat \- Report processor frequency and id
4 .SH SYNOPSIS
5 .ft B
6 .B turbostat
7 .RB [ Options ]
8 .RB command
9 .br
10 .B turbostat
11 .RB [ Options ]
12 .RB [ "\--interval seconds" ]
13 .SH DESCRIPTION
14 \fBturbostat \fP reports processor topology, f
15 idle power-state statistics, temperature and p
16 There are two ways to invoke turbostat.
17 The first method is to supply a
18 \fBcommand\fP, which is forked and statistics
19 in one-shot upon its completion.
20 The second method is to omit the command,
21 and turbostat displays statistics every 5 seco
22 The 5-second interval can be changed using the
23 .PP
24 Some information is not available on older pro
25 .SS Options
26 Options can be specified with a single or doub
27 name as necessary to disambiguate it from othe
28 .PP
29 \fB--add attributes\fP add column with counter
30 .nf
31 location: {\fBmsrDDD\fP | \fBmsr0xXXX\
32 msrDDD is a decimal offset, eg
33 msr0xXXX is a hex offset, eg.
34 /sys/path... is an absolute pa
35 <device> is a perf device from
36 <event> is a perf event for gi
37 perf/cstate_core/c1-re
38
39 scope: {\fBcpu\fP | \fBcore\fP | \fBpa
40 sample and print the counter f
41 default: cpu
42
43 size: {\fBu32\fP | \fBu64\fP }
44 MSRs are read as 64-bits, u32
45 default: u64
46
47 format: {\fBraw\fP | \fBdelta\fP | \fB
48 'raw' shows the MSR contents i
49 'delta' shows the difference i
50 'percent' shows the delta as a
51 default: delta
52
53 name: "name_string"
54 Any string that does not match
55 as the column header.
56 .fi
57 .PP
58 \fB--add pmt,[attr_name=attr_value, ...]\fP ad
59 .nf
60 name="name_string"
61 For column header.
62
63 type={\fBraw\fP}
64 'raw' shows the counter conten
65 default: raw
66
67 format={\fBraw\fP | \fBdelta\fP}
68 'raw' shows the counter conten
69 'delta' shows the difference i
70 default: raw
71
72 domain={\fBcpu%u\fP | \fBcore%u\fP | \
73 'cpu' per cpu/thread counter.
74 'core' per core counter.
75 'package' per package counter.
76 '%u' denotes id of the domain
77
78 offset=\fB%u\fP
79 '%u' offset within the PMT MMI
80
81 lsb=\fB%u\fP
82 '%u' least significant bit wit
83
84 msb=\fB%u\fP
85 '%u' most significant bit with
86
87 guid=\fB%x\fP
88 '%x' hex identifier of the PMT
89 .fi
90 .PP
91 \fB--cpu cpu-set\fP limit output to system sum
92 .PP
93 \fB--hide column\fP do not show the specified
94 .PP
95 \fB--enable column\fP show the specified built
96 The column name "all" can be used to enable al
97 .PP
98 \fB--show column\fP show only the specified bu
99 .PP
100 \fB--show CATEGORY --hide CATEGORY\fP Show an
101 .PP
102 \fB--Dump\fP displays the raw counter values.
103 .PP
104 \fB--quiet\fP Do not decode and print the syst
105 .PP
106 \fB--no-msr\fP Disable all the uses of the MSR
107 .PP
108 \fB--no-perf\fP Disable all the uses of the pe
109 .PP
110 \fB--interval seconds\fP overrides the default
111 .PP
112 \fB--num_iterations num\fP number of the measu
113 .PP
114 \fB--out output_file\fP turbostat output is wr
115 The file is truncated if it already exists, an
116 .PP
117 \fB--help\fP displays usage for the most commo
118 .PP
119 \fB--Joules\fP displays energy in Joules, rath
120 .PP
121 \fB--list\fP display column header names avail
122 .PP
123 \fB--Summary\fP limits output to a 1-line Syst
124 .PP
125 \fB--TCC temperature\fP sets the Thermal Contr
126 .PP
127 \fB--version\fP displays the version.
128 .PP
129 The \fBcommand\fP parameter forks \fBcommand\f
130 displays the statistics gathered since it was
131 .PP
132 .SH ROW DESCRIPTIONS
133 The system configuration dump (if --quiet is n
134 .SH COLUMN DESCRIPTIONS
135 .PP
136 \fBusec\fP For each CPU, the number of microse
137 .PP
138 \fBTime_Of_Day_Seconds\fP For each CPU, the ge
139 .PP
140 \fBCore\fP processor core number. Note that m
141 .PP
142 \fBCPU\fP Linux CPU (logical processor) number
143 .PP
144 \fBPackage\fP processor package number -- not
145 .PP
146 \fBAvg_MHz\fP number of cycles executed divide
147 .PP
148 \fBBusy%\fP percent of the measurement interva
149 .PP
150 \fBBzy_MHz\fP average clock rate while the CPU
151 .PP
152 \fBTSC_MHz\fP average MHz that the TSC ran dur
153 .PP
154 \fBIRQ\fP The number of interrupts serviced by
155 .PP
156 \fBSMI\fP The number of System Management Inte
157 .PP
158 \fBC1, C2, C3...\fP The number times Linux req
159 .PP
160 \fBC1%, C2%, C3%\fP The residency percentage t
161 .PP
162 \fBCPU%c1, CPU%c3, CPU%c6, CPU%c7\fP show the
163 .PP
164 \fBCoreTmp\fP Degrees Celsius reported by the
165 .PP
166 \fBPkgTmp\fP Degrees Celsius reported by the p
167 .PP
168 \fBGFX%rc6\fP The percentage of time the GPU i
169 .PP
170 \fBGFXMHz\fP Instantaneous snapshot of what sy
171 .PP
172 \fBGFXAMHz\fP Instantaneous snapshot of what s
173 .PP
174 \fBSAM%mc6\fP The percentage of time the SA Me
175 .PP
176 \fBSAMMHz\fP Instantaneous snapshot of what sy
177 .PP
178 \fBSAMAMHz\fP Instantaneous snapshot of what s
179 .PP
180 \fBPkg%pc2, Pkg%pc3, Pkg%pc6, Pkg%pc7\fP perce
181 .PP
182 \fBPkgWatt\fP Watts consumed by the whole pack
183 .PP
184 \fBCorWatt\fP Watts consumed by the core part
185 .PP
186 \fBGFXWatt\fP Watts consumed by the Graphics p
187 .PP
188 \fBRAMWatt\fP Watts consumed by the DRAM DIMMS
189 .PP
190 \fBPKG_%\fP percent of the interval that RAPL
191 .PP
192 \fBRAM_%\fP percent of the interval that RAPL
193 .PP
194 \fBUncMHz\fP per-package uncore MHz, instantan
195 .PP
196 \fBUMHz1.0\fP per-package uncore MHz for domai
197 .SH TOO MUCH INFORMATION EXAMPLE
198 By default, turbostat dumps all possible infor
199 This is ideal for remote debugging, use the "-
200 .PP
201 When you are not interested in all that inform
202 .PP
203 To find out what columns are available for --s
204 .PP
205 .nf
206 sudo ./turbostat --show sysfs --quiet sleep 10
207 10.003837 sec
208 C1 C1E C3 C6 C7s
209 4 21 2 2 459
210 1 17 2 2 130
211 0 0 0 0 31
212 2 1 0 0 52
213 1 2 0 0 52
214 0 0 0 0 71
215 0 0 0 0 25
216 0 0 0 0 74
217 0 1 0 0 24
218 .fi
219 .PP
220 .SH ONE SHOT COMMAND EXAMPLE
221 If turbostat is invoked with a command, it wil
222 and output the statistics gathered after the c
223 In this case, turbostat output goes to stderr,
224 Output can instead be saved to a file using th
225 In this example, the "sleep 10" command is for
226
227 .nf
228 [root@hsw]# ./turbostat -o ts.out sleep 10
229 [root@hsw]#
230 .fi
231
232 .SH PERIODIC INTERVAL EXAMPLE
233 Without a command to fork, turbostat displays
234 Periodic output goes to stdout, by default, un
235 The 5-second interval can be changed with the
236 .nf
237 sudo turbostat --quiet --show CPU,frequency
238 Core CPU Avg_MHz Busy% Bzy_MH
239 - - 524 12.48 4198
240 0 0 4 0.09 4081
241 0 4 1 0.02 4063
242 1 1 2 0.06 4063
243 1 5 2 0.05 4070
244 2 2 4178 99.52 4199
245 2 6 3 0.08 4159
246 3 3 1 0.04 4046
247 3 7 0 0.01 3989
248 Core CPU Avg_MHz Busy% Bzy_MH
249 - - 525 12.52 4198
250 0 0 4 0.10 4051
251 0 4 2 0.04 3993
252 1 1 3 0.07 4054
253 1 5 4 0.10 4018
254 2 2 4178 99.51 4199
255 2 6 4 0.09 4143
256 3 3 2 0.06 4026
257 3 7 7 0.17 4074
258 .fi
259 This example also shows the use of the --show
260
261 .SH SYSTEM CONFIGURATION INFORMATION EXAMPLE
262
263 By default, turbostat always dumps system conf
264 before taking measurements. In the example ab
265 to suppress that output. Here is an example o
266 .nf
267 turbostat version 2022.04.16 - Len Brown <lenb@
268 Kernel command line: BOOT_IMAGE=/boot/vmlinuz-
269 CPUID(0): GenuineIntel 0x16 CPUID levels
270 CPUID(1): family:model:stepping 0x6:9e:9 (6:15
271 CPUID(0x80000000): max_extended_levels: 0x8000
272 CPUID(1): SSE3 MONITOR - EIST TM2 TSC MSR ACPI
273 CPUID(6): APERF, TURBO, DTS, PTM, HWP, HWPnoti
274 cpu7: MSR_IA32_MISC_ENABLE: 0x00850089 (TCC EI
275 CPUID(7): SGX
276 cpu7: MSR_IA32_FEATURE_CONTROL: 0x00000005 (Lo
277 CPUID(0x15): eax_crystal: 2 ebx_tsc: 258 ecx_c
278 TSC: 3096 MHz (24000000 Hz * 258 / 2 / 1000000
279 CPUID(0x16): base_mhz: 3100 max_mhz: 4200 bus_
280 cpu7: MSR_MISC_PWR_MGMT: 0x00401cc0 (ENable-EI
281 RAPL: 5825 sec. Joule Counter Range, at 45 Wat
282 cpu7: MSR_PLATFORM_INFO: 0x80839f1011f00
283 8 * 100.0 = 800.0 MHz max efficiency frequency
284 31 * 100.0 = 3100.0 MHz base frequency
285 cpu7: MSR_IA32_POWER_CTL: 0x002c005d (C1E auto
286 cpu7: MSR_TURBO_RATIO_LIMIT: 0x2728292a
287 39 * 100.0 = 3900.0 MHz max turbo 4 active cor
288 40 * 100.0 = 4000.0 MHz max turbo 3 active cor
289 41 * 100.0 = 4100.0 MHz max turbo 2 active cor
290 42 * 100.0 = 4200.0 MHz max turbo 1 active cor
291 cpu7: MSR_CONFIG_TDP_NOMINAL: 0x0000001f (base
292 cpu7: MSR_CONFIG_TDP_LEVEL_1: 0x00000000 ()
293 cpu7: MSR_CONFIG_TDP_LEVEL_2: 0x00000000 ()
294 cpu7: MSR_CONFIG_TDP_CONTROL: 0x80000000 ( loc
295 cpu7: MSR_TURBO_ACTIVATION_RATIO: 0x00000000 (
296 cpu7: MSR_PKG_CST_CONFIG_CONTROL: 0x1e008008 (
297 Uncore Frequency pkg0 die0: 800 - 3900 MHz (80
298 /dev/cpu_dma_latency: 2000000000 usec (default
299 current_driver: intel_idle
300 current_governor: menu
301 current_governor_ro: menu
302 cpu7: POLL: CPUIDLE CORE POLL IDLE
303 cpu7: C1: MWAIT 0x00
304 cpu7: C1E: MWAIT 0x01
305 cpu7: C3: MWAIT 0x10
306 cpu7: C6: MWAIT 0x20
307 cpu7: C7s: MWAIT 0x33
308 cpu7: C8: MWAIT 0x40
309 cpu7: C9: MWAIT 0x50
310 cpu7: C10: MWAIT 0x60
311 cpu7: cpufreq driver: intel_pstate
312 cpu7: cpufreq governor: performance
313 cpufreq intel_pstate no_turbo: 0
314 cpu7: MSR_MISC_FEATURE_CONTROL: 0x00000000 (L2
315 cpu0: MSR_PM_ENABLE: 0x00000001 (HWP)
316 cpu0: MSR_HWP_CAPABILITIES: 0x01101f53 (high 8
317 cpu0: MSR_HWP_REQUEST: 0x00005353 (min 83 max
318 cpu0: MSR_HWP_INTERRUPT: 0x00000001 (EN_Guaran
319 cpu0: MSR_HWP_STATUS: 0x00000004 (No-Guarantee
320 cpu0: EPB: 6 (balanced)
321 cpu0: MSR_RAPL_POWER_UNIT: 0x000a0e03 (0.12500
322 cpu0: MSR_PKG_POWER_INFO: 0x00000168 (45 W TDP
323 cpu0: MSR_PKG_POWER_LIMIT: 0x42820800218208 (U
324 cpu0: PKG Limit #1: ENabled (65.000 Watts, 64.
325 cpu0: PKG Limit #2: ENabled (65.000 Watts, 0.0
326 cpu0: MSR_VR_CURRENT_CONFIG: 0x00000000
327 cpu0: PKG Limit #4: 0.000000 Watts (UNlocked)
328 cpu0: MSR_DRAM_POWER_LIMIT: 0x5400de00000000 (
329 cpu0: DRAM Limit: DISabled (0.000 Watts, 0.000
330 cpu0: MSR_PP0_POLICY: 0
331 cpu0: MSR_PP0_POWER_LIMIT: 0x00000000 (UNlocke
332 cpu0: Cores Limit: DISabled (0.000 Watts, 0.00
333 cpu0: MSR_PP1_POLICY: 0
334 cpu0: MSR_PP1_POWER_LIMIT: 0x00000000 (UNlocke
335 cpu0: GFX Limit: DISabled (0.000 Watts, 0.0009
336 cpu0: MSR_IA32_TEMPERATURE_TARGET: 0x00640000
337 cpu0: MSR_IA32_PACKAGE_THERM_STATUS: 0x8820080
338 cpu0: MSR_IA32_PACKAGE_THERM_INTERRUPT: 0x0000
339 cpu7: MSR_PKGC3_IRTL: 0x0000884e (valid, 79872
340 cpu7: MSR_PKGC6_IRTL: 0x00008876 (valid, 12083
341 cpu7: MSR_PKGC7_IRTL: 0x00008894 (valid, 15155
342 cpu7: MSR_PKGC8_IRTL: 0x000088fa (valid, 25600
343 cpu7: MSR_PKGC9_IRTL: 0x0000894c (valid, 33996
344 cpu7: MSR_PKGC10_IRTL: 0x00008bf2 (valid, 1034
345 .fi
346 .PP
347 The \fBmax efficiency\fP frequency, a.k.a. Low
348 available at the minimum package voltage. The
349 frequency of the processor -- this should matc
350 in /proc/cpuinfo. This base frequency
351 should be sustainable on all CPUs indefinitely
352 The remaining rows show what maximum turbo fre
353 depending on the number of idle cores. Note t
354 available on all processors.
355 .SH ADD COUNTER EXAMPLE
356 Here we limit turbostat to showing just the CP
357 We add a counter showing the 32-bit raw value
358 labeling it with the column header, "PRF_CTRL"
359 after the conclusion of a 0.1 second sleep.
360 .nf
361 sudo ./turbostat --quiet --cpu 0-3 --show CPU
362 0.101604 sec
363 CPU PRF_CTRL
364 - 0x00000000
365 0 0x00000c00
366 1 0x00000800
367 2 0x00000a00
368 3 0x00000800
369
370 .fi
371
372 .SH ADD PERF COUNTER EXAMPLE
373 Here we limit turbostat to showing just the CP
374 We add a counter showing time spent in C1 core
375 labeling it with the column header, "pCPU%c1",
376 after the conclusion of 0.1 second sleep.
377 We also show CPU%c1 built-in counter that shou
378 .nf
379 sudo ./turbostat --quiet --cpu 0-3 --show CPU,
380 0.102448 sec
381 CPU pCPU%c1 CPU%c1
382 - 34.89 34.89
383 0 45.99 45.99
384 1 45.94 45.94
385 2 23.83 23.83
386 3 23.84 23.84
387
388 .fi
389
390 .SH ADD PMT COUNTER EXAMPLE
391 Here we limit turbostat to showing just the CP
392 We add two counters, showing crystal clock cou
393 All the parameters passed are based on the met
394
395 For the crystal clock count, we
396 label it with the column header, "XTAL",
397 we set the type to 'raw', to read the number o
398 we set the format to 'delta', to display the d
399 we set the domain to 'package0', to collect it
400 we set the offset to '0', which is a offset of
401 we set the lsb and msb to cover all 64 bits of
402 and finally we set the guid to '0x1a067102', t
403
404 For the DC6 residency counter, we
405 label it with the column header, "Die%c6",
406 we set the type to 'txtal_time', to obtain the
407 we set the format to 'delta', to display the d
408 we set the domain to 'package0', to collect it
409 we set the offset to '0', which is a offset of
410 we set the lsb and msb to cover all 64 bits of
411 and finally we set the guid to '0x1a067102', t
412
413 .nf
414 sudo ./turbostat --quiet --cpu 0 --show CPU --
415 0.104352 sec
416 CPU XTAL Die%c6
417 - 0x0000006d4d957ca7 0.00
418 0 0x0000006d4d957ca7 0.00
419 0.102448 sec
420 .fi
421
422 .SH INPUT
423
424 For interval-mode, turbostat will immediately
425 when it sees a newline on standard input.
426 turbostat will then start the next interval.
427 Control-C will be send a SIGINT to turbostat,
428 which will immediately abort the program with
429 .SH SIGNALS
430
431 SIGINT will interrupt interval-mode.
432 The end-of-interval data will be collected and
433
434 SIGUSR1 will end current interval,
435 end-of-interval data will be collected and dis
436 starts a new interval.
437 .SH NOTES
438
439 .B "turbostat "
440 must be run as root.
441 Alternatively, non-root users can be enabled t
442
443 # setcap cap_sys_admin,cap_sys_rawio,cap_sys_n
444
445 # chmod +r /dev/cpu/*/msr
446
447 # chmod +r /dev/cpu_dma_latency
448
449 .B "turbostat "
450 reads hardware counters, but doesn't write the
451 So it will not interfere with the OS or other
452 multiple invocations of itself.
453
454 \fBturbostat \fP
455 may work poorly on Linux-2.6.20 through 2.6.29
456 as \fBacpi-cpufreq \fPperiodically cleared the
457 in those kernels.
458
459 AVG_MHz = APERF_delta/measurement_interval. T
460 number of elapsed cycles divided by the entire
461 including idle time. Note that this calculati
462 to systems lacking a non-stop TSC.
463
464 TSC_MHz = TSC_delta/measurement_interval.
465 On a system with an invariant TSC, this value
466 and will closely match the base frequency valu
467 in the brand string in /proc/cpuinfo. On a sy
468 the TSC stops in idle, TSC_MHz will drop
469 below the processor's base frequency.
470
471 Busy% = MPERF_delta/TSC_delta
472
473 Bzy_MHz = TSC_delta*APERF_delta/MPERF_delta/me
474
475 Note that these calculations depend on TSC_del
476 are not reliable during intervals when TSC_MHz
477
478 Turbostat data collection is not atomic.
479 Extremely short measurement intervals (much le
480 or system activity that prevents turbostat fro
481 to run on all CPUS to quickly collect data, wi
482 inconsistent results.
483
484 The APERF, MPERF MSRs are defined to count non
485 Although it is not guaranteed by the architect
486 that they count at TSC rate, which is true on
487
488 .SH REFERENCES
489 Volume 3B: System Programming Guide"
490 https://www.intel.com/products/processor/manua
491
492 .SH FILES
493 .ta
494 .nf
495 /dev/cpu/*/msr
496 .fi
497
498 .SH "SEE ALSO"
499 msr(4), vmstat(8)
500 .PP
501 .SH AUTHOR
502 .nf
503 Written by Len Brown <len.brown@intel.com>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.