tools/power/x86/turbostat/turbostat.8

   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 [ "\-s" ]
   8 .RB [ "\-v" ]
   9 .RB [ "\-M MSR#" ]
  10 .RB command
  11 .br
  12 .B turbostat
  13 .RB [ "\-s" ]
  14 .RB [ "\-v" ]
  15 .RB [ "\-M MSR#" ]
  16 .RB [ "\-i interval_sec" ]
  17 .SH DESCRIPTION
  18 \fBturbostat \fP reports processor topology, frequency
  19 and idle power state statistics on modern X86 processors.
  20 Either \fBcommand\fP is forked and statistics are printed
  21 upon its completion, or statistics are printed periodically.
  22
  23 \fBturbostat \fP
  24 requires that the processor
  25 supports an "invariant" TSC, plus the APERF and MPERF MSRs.
  26 \fBturbostat \fP will report idle cpu power state residency
  27 on processors that additionally support C-state residency counters.
  28
  29 .SS Options
  30 The \fB-s\fP option limits output to a 1-line system summary for each interval.
  31 .PP
  32 The \fB-c\fP option limits output to the 1st thread in each core.
  33 .PP
  34 The \fB-p\fP option limits output to the 1st thread in each package.
  35 .PP
  36 The \fB-v\fP option increases verbosity.
  37 .PP
  38 The \fB-M MSR#\fP option dumps the specified MSR,
  39 in addition to the usual frequency and idle statistics.
  40 .PP
  41 The \fB-i interval_sec\fP option prints statistics every \fiinterval_sec\fP seconds.
  42 The default is 5 seconds.
  43 .PP
  44 The \fBcommand\fP parameter forks \fBcommand\fP and upon its exit,
  45 displays the statistics gathered since it was forked.
  46 .PP
  47 .SH FIELD DESCRIPTIONS
  48 .nf
  49 \fBpk\fP processor package number.
  50 \fBcor\fP processor core number.
  51 \fBCPU\fP Linux CPU (logical processor) number.
  52 Note that multiple CPUs per core indicate support for Intel(R) Hyper-Threading Technology.
  53 \fB%c0\fP percent of the interval that the CPU retired instructions.
  54 \fBGHz\fP average clock rate while the CPU was in c0 state.
  55 \fBTSC\fP average GHz that the TSC ran during the entire interval.
  56 \fB%c1, %c3, %c6, %c7\fP show the percentage residency in hardware core idle states.
  57 \fB%pc2, %pc3, %pc6, %pc7\fP percentage residency in hardware package idle states.
  58 .fi
  59 .PP
  60 .SH EXAMPLE
  61 Without any parameters, turbostat prints out counters ever 5 seconds.
  62 (override interval with "-i sec" option, or specify a command
  63 for turbostat to fork).
  64
  65 The first row of statistics is a summary for the entire system.
  66 Note that the summary is a weighted average.
  67 Subsequent rows show per-CPU statistics.
  68
  69 .nf
  70 [root@x980]# ./turbostat
  71 cor CPU    %c0  GHz  TSC    %c1    %c3    %c6   %pc3   %pc6
  72           0.09 1.62 3.38   1.83   0.32  97.76   1.26  83.61
  73   0   0   0.15 1.62 3.38  10.23   0.05  89.56   1.26  83.61
  74   0   6   0.05 1.62 3.38  10.34
  75   1   2   0.03 1.62 3.38   0.07   0.05  99.86
  76   1   8   0.03 1.62 3.38   0.06
  77   2   4   0.21 1.62 3.38   0.10   1.49  98.21
  78   2  10   0.02 1.62 3.38   0.29
  79   8   1   0.04 1.62 3.38   0.04   0.08  99.84
  80   8   7   0.01 1.62 3.38   0.06
  81   9   3   0.53 1.62 3.38   0.10   0.20  99.17
  82   9   9   0.02 1.62 3.38   0.60
  83  10   5   0.01 1.62 3.38   0.02   0.04  99.92
  84  10  11   0.02 1.62 3.38   0.02
  85 .fi
  86 .SH SUMMARY EXAMPLE
  87 The "-s" option prints the column headers just once,
  88 and then the one line system summary for each sample interval.
  89
  90 .nf
  91 [root@x980]# ./turbostat -s
  92    %c0  GHz  TSC    %c1    %c3    %c6   %pc3   %pc6
  93   0.23 1.67 3.38   2.00   0.30  97.47   1.07  82.12
  94   0.10 1.62 3.38   1.87   2.25  95.77  12.02  72.60
  95   0.20 1.64 3.38   1.98   0.11  97.72   0.30  83.36
  96   0.11 1.70 3.38   1.86   1.81  96.22   9.71  74.90
  97 .fi
  98 .SH VERBOSE EXAMPLE
  99 The "-v" option adds verbosity to the output:
 100
 101 .nf
 102 GenuineIntel 11 CPUID levels; family:model:stepping 0x6:2c:2 (6:44:2)
 103 12 * 133 = 1600 MHz max efficiency
 104 25 * 133 = 3333 MHz TSC frequency
 105 26 * 133 = 3467 MHz max turbo 4 active cores
 106 26 * 133 = 3467 MHz max turbo 3 active cores
 107 27 * 133 = 3600 MHz max turbo 2 active cores
 108 27 * 133 = 3600 MHz max turbo 1 active cores
 109
 110 .fi
 111 The \fBmax efficiency\fP frequency, a.k.a. Low Frequency Mode, is the frequency
 112 available at the minimum package voltage.  The \fBTSC frequency\fP is the nominal
 113 maximum frequency of the processor if turbo-mode were not available.  This frequency
 114 should be sustainable on all CPUs indefinitely, given nominal power and cooling.
 115 The remaining rows show what maximum turbo frequency is possible
 116 depending on the number of idle cores.  Note that this information is
 117 not available on all processors.
 118 .SH FORK EXAMPLE
 119 If turbostat is invoked with a command, it will fork that command
 120 and output the statistics gathered when the command exits.
 121 eg. Here a cycle soaker is run on 1 CPU (see %c0) for a few seconds
 122 until ^C while the other CPUs are mostly idle:
 123
 124 .nf
 125 [root@x980 lenb]# ./turbostat cat /dev/zero > /dev/null
 126 ^C
 127 cor CPU    %c0  GHz  TSC    %c1    %c3    %c6   %pc3   %pc6
 128           8.86 3.61 3.38  15.06  31.19  44.89   0.00   0.00
 129   0   0   1.46 3.22 3.38  16.84  29.48  52.22   0.00   0.00
 130   0   6   0.21 3.06 3.38  18.09
 131   1   2   0.53 3.33 3.38   2.80  46.40  50.27
 132   1   8   0.89 3.47 3.38   2.44
 133   2   4   1.36 3.43 3.38   9.04  23.71  65.89
 134   2  10   0.18 2.86 3.38  10.22
 135   8   1   0.04 2.87 3.38  99.96   0.01   0.00
 136   8   7  99.72 3.63 3.38   0.27
 137   9   3   0.31 3.21 3.38   7.64  56.55  35.50
 138   9   9   0.08 2.95 3.38   7.88
 139  10   5   1.42 3.43 3.38   2.14  30.99  65.44
 140  10  11   0.16 2.88 3.38   3.40
 141 .fi
 142 Above the cycle soaker drives cpu7 up its 3.6 Ghz turbo limit
 143 while the other processors are generally in various states of idle.
 144
 145 Note that cpu1 and cpu7 are HT siblings within core8.
 146 As cpu7 is very busy, it prevents its sibling, cpu1,
 147 from entering a c-state deeper than c1.
 148
 149 Note that turbostat reports average GHz of 3.63, while
 150 the arithmetic average of the GHz column above is lower.
 151 This is a weighted average, where the weight is %c0.  ie. it is the total number of
 152 un-halted cycles elapsed per time divided by the number of CPUs.
 153 .SH NOTES
 154
 155 .B "turbostat "
 156 must be run as root.
 157
 158 .B "turbostat "
 159 reads hardware counters, but doesn't write them.
 160 So it will not interfere with the OS or other programs, including
 161 multiple invocations of itself.
 162
 163 \fBturbostat \fP
 164 may work poorly on Linux-2.6.20 through 2.6.29,
 165 as \fBacpi-cpufreq \fPperiodically cleared the APERF and MPERF
 166 in those kernels.
 167
 168 The APERF, MPERF MSRs are defined to count non-halted cycles.
 169 Although it is not guaranteed by the architecture, turbostat assumes
 170 that they count at TSC rate, which is true on all processors tested to date.
 171
 172 .SH REFERENCES
 173 "Intel® Turbo Boost Technology
 174 in Intel® Core™ Microarchitecture (Nehalem) Based Processors"
 175 http://download.intel.com/design/processor/applnots/320354.pdf
 176
 177 "Intel® 64 and IA-32 Architectures Software Developer's Manual
 178 Volume 3B: System Programming Guide"
 179 http://www.intel.com/products/processor/manuals/
 180
 181 .SH FILES
 182 .ta
 183 .nf
 184 /dev/cpu/*/msr
 185 .fi
 186
 187 .SH "SEE ALSO"
 188 msr(4), vmstat(8)
 189 .PP
 190 .SH AUTHOR
 191 .nf
 192 Written by Len Brown <len.brown@intel.com>