turbostat.8 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. .TH TURBOSTAT 8
  2. .SH NAME
  3. turbostat \- Report processor frequency and idle statistics
  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, frequency,
  15. idle power-state statistics, temperature and power on X86 processors.
  16. There are two ways to invoke turbostat.
  17. The first method is to supply a
  18. \fBcommand\fP, which is forked and statistics are printed
  19. upon its completion.
  20. The second method is to omit the command,
  21. and turbostat displays statistics every 5 seconds.
  22. The 5-second interval can be changed using the --interval option.
  23. .PP
  24. Some information is not available on older processors.
  25. .SS Options
  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-sensitive.
  28. \fB--Counter MSR#\fP shows the delta of the specified 64-bit MSR counter.
  29. .PP
  30. \fB--counter MSR#\fP shows the delta of the specified 32-bit MSR counter.
  31. .PP
  32. \fB--Dump\fP displays the raw counter values.
  33. .PP
  34. \fB--debug\fP displays additional system configuration information. Invoking this parameter
  35. more than once may also enable internal turbostat debug information.
  36. .PP
  37. \fB--interval seconds\fP overrides the default 5-second measurement interval.
  38. .PP
  39. \fB--help\fP displays usage for the most common parameters.
  40. .PP
  41. \fB--Joules\fP displays energy in Joules, rather than dividing Joules by time to print power in Watts.
  42. .PP
  43. \fB--MSR MSR#\fP shows the specified 64-bit MSR value.
  44. .PP
  45. \fB--msr MSR#\fP shows the specified 32-bit MSR value.
  46. .PP
  47. \fB--Package\fP limits output to the system summary plus the 1st thread in each Package.
  48. .PP
  49. \fB--processor\fP limits output to the system summary plus the 1st thread in each processor of each package. Ie. it skips hyper-threaded siblings.
  50. .PP
  51. \fB--Summary\fP limits output to a 1-line System Summary for each interval.
  52. .PP
  53. \fB--TCC temperature\fP sets the Thermal Control Circuit temperature for systems which do not export that value. This is used for making sense of the Digital Thermal Sensor outputs, as they return degrees Celsius below the TCC activation temperature.
  54. .PP
  55. \fB--version\fP displays the version.
  56. .PP
  57. The \fBcommand\fP parameter forks \fBcommand\fP, and upon its exit,
  58. displays the statistics gathered since it was forked.
  59. .PP
  60. .SH DEFAULT FIELD DESCRIPTIONS
  61. .nf
  62. \fBCPU\fP Linux CPU (logical processor) number. Yes, it is okay that on many systems the CPUs are not listed in numerical order -- for efficiency reasons, turbostat runs in topology order, so HT siblings appear together.
  63. \fBAVG_MHz\fP number of cycles executed divided by time elapsed.
  64. \fB%Busy\fP percent of the interval that the CPU retired instructions, aka. % of time in "C0" state.
  65. \fBBzy_MHz\fP average clock rate while the CPU was busy (in "c0" state).
  66. \fBTSC_MHz\fP average MHz that the TSC ran during the entire interval.
  67. .fi
  68. .PP
  69. .SH DEBUG FIELD DESCRIPTIONS
  70. .nf
  71. \fBPackage\fP processor package number.
  72. \fBCore\fP processor core number.
  73. Note that multiple CPUs per core indicate support for Intel(R) Hyper-Threading Technology (HT).
  74. \fBCPU%c1, CPU%c3, CPU%c6, CPU%c7\fP show the percentage residency in hardware core idle states.
  75. \fBCoreTmp\fP Degrees Celsius reported by the per-core Digital Thermal Sensor.
  76. \fBPkgTtmp\fP Degrees Celsius reported by the per-package Package Thermal Monitor.
  77. \fBPkg%pc2, Pkg%pc3, Pkg%pc6, Pkg%pc7\fP percentage residency in hardware package idle states.
  78. \fBPkgWatt\fP Watts consumed by the whole package.
  79. \fBCorWatt\fP Watts consumed by the core part of the package.
  80. \fBGFXWatt\fP Watts consumed by the Graphics part of the package -- available only on client processors.
  81. \fBRAMWatt\fP Watts consumed by the DRAM DIMMS -- available only on server processors.
  82. \fBPKG_%\fP percent of the interval that RAPL throttling was active on the Package.
  83. \fBRAM_%\fP percent of the interval that RAPL throttling was active on DRAM.
  84. .fi
  85. .PP
  86. .SH EXAMPLE
  87. Without any parameters, turbostat displays statistics ever 5 seconds.
  88. (override interval with "-i sec" option, or specify a command
  89. for turbostat to fork).
  90. .nf
  91. [root@hsw]# ./turbostat
  92. CPU Avg_MHz %Busy Bzy_MHz TSC_MHz
  93. - 488 12.51 3898 3498
  94. 0 0 0.01 3885 3498
  95. 4 3897 99.99 3898 3498
  96. 1 0 0.00 3861 3498
  97. 5 0 0.00 3882 3498
  98. 2 1 0.02 3894 3498
  99. 6 2 0.06 3898 3498
  100. 3 0 0.00 3849 3498
  101. 7 0 0.00 3877 3498
  102. .fi
  103. .SH DEBUG EXAMPLE
  104. The "--debug" option prints additional system information before measurements:
  105. The first row of statistics is a summary for the entire system.
  106. For residency % columns, the summary is a weighted average.
  107. For Temperature columns, the summary is the column maximum.
  108. For Watts columns, the summary is a system total.
  109. Subsequent rows show per-CPU statistics.
  110. .nf
  111. turbostat version 4.1 10-Feb, 2015 - Len Brown <lenb@kernel.org>
  112. CPUID(0): GenuineIntel 13 CPUID levels; family:model:stepping 0x6:3c:3 (6:60:3)
  113. CPUID(6): APERF, DTS, PTM, EPB
  114. RAPL: 3121 sec. Joule Counter Range, at 84 Watts
  115. cpu0: MSR_NHM_PLATFORM_INFO: 0x80838f3012300
  116. 8 * 100 = 800 MHz max efficiency
  117. 35 * 100 = 3500 MHz TSC frequency
  118. cpu0: MSR_IA32_POWER_CTL: 0x0004005d (C1E auto-promotion: DISabled)
  119. cpu0: MSR_NHM_SNB_PKG_CST_CFG_CTL: 0x1e000400 (UNdemote-C3, UNdemote-C1, demote-C3, demote-C1, UNlocked: pkg-cstate-limit=0: pc0)
  120. cpu0: MSR_NHM_TURBO_RATIO_LIMIT: 0x25262727
  121. 37 * 100 = 3700 MHz max turbo 4 active cores
  122. 38 * 100 = 3800 MHz max turbo 3 active cores
  123. 39 * 100 = 3900 MHz max turbo 2 active cores
  124. 39 * 100 = 3900 MHz max turbo 1 active cores
  125. cpu0: MSR_IA32_ENERGY_PERF_BIAS: 0x00000006 (balanced)
  126. cpu0: MSR_CORE_PERF_LIMIT_REASONS, 0x31200000 (Active: ) (Logged: Auto-HWP, Amps, MultiCoreTurbo, Transitions, )
  127. cpu0: MSR_GFX_PERF_LIMIT_REASONS, 0x00000000 (Active: ) (Logged: )
  128. cpu0: MSR_RING_PERF_LIMIT_REASONS, 0x0d000000 (Active: ) (Logged: Amps, PkgPwrL1, PkgPwrL2, )
  129. cpu0: MSR_RAPL_POWER_UNIT: 0x000a0e03 (0.125000 Watts, 0.000061 Joules, 0.000977 sec.)
  130. cpu0: MSR_PKG_POWER_INFO: 0x000002a0 (84 W TDP, RAPL 0 - 0 W, 0.000000 sec.)
  131. cpu0: MSR_PKG_POWER_LIMIT: 0x428348001a82a0 (UNlocked)
  132. cpu0: PKG Limit #1: ENabled (84.000000 Watts, 8.000000 sec, clamp DISabled)
  133. cpu0: PKG Limit #2: ENabled (105.000000 Watts, 0.002441* sec, clamp DISabled)
  134. cpu0: MSR_PP0_POLICY: 0
  135. cpu0: MSR_PP0_POWER_LIMIT: 0x00000000 (UNlocked)
  136. cpu0: Cores Limit: DISabled (0.000000 Watts, 0.000977 sec, clamp DISabled)
  137. cpu0: MSR_PP1_POLICY: 0
  138. cpu0: MSR_PP1_POWER_LIMIT: 0x00000000 (UNlocked)
  139. cpu0: GFX Limit: DISabled (0.000000 Watts, 0.000977 sec, clamp DISabled)
  140. cpu0: MSR_IA32_TEMPERATURE_TARGET: 0x00641400 (100 C)
  141. cpu0: MSR_IA32_PACKAGE_THERM_STATUS: 0x88340800 (48 C)
  142. cpu0: MSR_IA32_THERM_STATUS: 0x88340000 (48 C +/- 1)
  143. cpu1: MSR_IA32_THERM_STATUS: 0x88440000 (32 C +/- 1)
  144. cpu2: MSR_IA32_THERM_STATUS: 0x88450000 (31 C +/- 1)
  145. cpu3: MSR_IA32_THERM_STATUS: 0x88490000 (27 C +/- 1)
  146. Core CPU Avg_MHz %Busy Bzy_MHz TSC_MHz SMI CPU%c1 CPU%c3 CPU%c6 CPU%c7 CoreTmp PkgTmp PkgWatt CorWatt GFXWatt
  147. - - 493 12.64 3898 3498 0 12.64 0.00 0.00 74.72 47 47 21.62 13.74 0.00
  148. 0 0 4 0.11 3894 3498 0 99.89 0.00 0.00 0.00 47 47 21.62 13.74 0.00
  149. 0 4 3897 99.98 3898 3498 0 0.02
  150. 1 1 7 0.17 3887 3498 0 0.04 0.00 0.00 99.79 32
  151. 1 5 0 0.00 3885 3498 0 0.21
  152. 2 2 29 0.76 3895 3498 0 0.10 0.01 0.01 99.13 32
  153. 2 6 2 0.06 3896 3498 0 0.80
  154. 3 3 1 0.02 3832 3498 0 0.03 0.00 0.00 99.95 28
  155. 3 7 0 0.00 3879 3498 0 0.04
  156. ^C
  157. .fi
  158. The \fBmax efficiency\fP frequency, a.k.a. Low Frequency Mode, is the frequency
  159. available at the minimum package voltage. The \fBTSC frequency\fP is the base
  160. frequency of the processor -- this should match the brand string
  161. in /proc/cpuinfo. This base frequency
  162. should be sustainable on all CPUs indefinitely, given nominal power and cooling.
  163. The remaining rows show what maximum turbo frequency is possible
  164. depending on the number of idle cores. Note that not all information is
  165. available on all processors.
  166. .PP
  167. The --debug option adds additional columns to the measurement ouput, including CPU idle power-state residency processor temperature sensor readinds.
  168. See the field definitions above.
  169. .SH FORK EXAMPLE
  170. If turbostat is invoked with a command, it will fork that command
  171. and output the statistics gathered when the command exits.
  172. eg. Here a cycle soaker is run on 1 CPU (see %c0) for a few seconds
  173. until ^C while the other CPUs are mostly idle:
  174. .nf
  175. root@hsw: turbostat cat /dev/zero > /dev/null
  176. ^C
  177. CPU Avg_MHz %Busy Bzy_MHz TSC_MHz
  178. - 482 12.51 3854 3498
  179. 0 0 0.01 1960 3498
  180. 4 0 0.00 2128 3498
  181. 1 0 0.00 3003 3498
  182. 5 3854 99.98 3855 3498
  183. 2 0 0.01 3504 3498
  184. 6 3 0.08 3884 3498
  185. 3 0 0.00 2553 3498
  186. 7 0 0.00 2126 3498
  187. 10.783983 sec
  188. .fi
  189. Above the cycle soaker drives cpu5 up its 3.9 GHz turbo limit.
  190. The first row shows the average MHz and %Busy across all the processors in the system.
  191. Note that the Avg_MHz column reflects the total number of cycles executed
  192. divided by the measurement interval. If the %Busy column is 100%,
  193. then the processor was running at that speed the entire interval.
  194. The Avg_MHz multiplied by the %Busy results in the Bzy_MHz --
  195. which is the average frequency while the processor was executing --
  196. not including any non-busy idle time.
  197. .SH NOTES
  198. .B "turbostat "
  199. must be run as root.
  200. Alternatively, non-root users can be enabled to run turbostat this way:
  201. # setcap cap_sys_rawio=ep ./turbostat
  202. # chmod +r /dev/cpu/*/msr
  203. .B "turbostat "
  204. reads hardware counters, but doesn't write them.
  205. So it will not interfere with the OS or other programs, including
  206. multiple invocations of itself.
  207. \fBturbostat \fP
  208. may work poorly on Linux-2.6.20 through 2.6.29,
  209. as \fBacpi-cpufreq \fPperiodically cleared the APERF and MPERF MSRs
  210. in those kernels.
  211. AVG_MHz = APERF_delta/measurement_interval. This is the actual
  212. number of elapsed cycles divided by the entire sample interval --
  213. including idle time. Note that this calculation is resilient
  214. to systems lacking a non-stop TSC.
  215. TSC_MHz = TSC_delta/measurement_interval.
  216. On a system with an invariant TSC, this value will be constant
  217. and will closely match the base frequency value shown
  218. in the brand string in /proc/cpuinfo. On a system where
  219. the TSC stops in idle, TSC_MHz will drop
  220. below the processor's base frequency.
  221. %Busy = MPERF_delta/TSC_delta
  222. Bzy_MHz = TSC_delta/APERF_delta/MPERF_delta/measurement_interval
  223. Note that these calculations depend on TSC_delta, so they
  224. are not reliable during intervals when TSC_MHz is not running at the base frequency.
  225. Turbostat data collection is not atomic.
  226. Extremely short measurement intervals (much less than 1 second),
  227. or system activity that prevents turbostat from being able
  228. to run on all CPUS to quickly collect data, will result in
  229. inconsistent results.
  230. The APERF, MPERF MSRs are defined to count non-halted cycles.
  231. Although it is not guaranteed by the architecture, turbostat assumes
  232. that they count at TSC rate, which is true on all processors tested to date.
  233. .SH REFERENCES
  234. Volume 3B: System Programming Guide"
  235. http://www.intel.com/products/processor/manuals/
  236. .SH FILES
  237. .ta
  238. .nf
  239. /dev/cpu/*/msr
  240. .fi
  241. .SH "SEE ALSO"
  242. msr(4), vmstat(8)
  243. .PP
  244. .SH AUTHOR
  245. .nf
  246. Written by Len Brown <len.brown@intel.com>