Merge remote-tracking branches 'asoc/topic/mc13783', 'asoc/topic/msm8916', 'asoc...
[linux-2.6-block.git] / tools / kvm / kvm_stat / kvm_stat.txt
CommitLineData
fd41b5a9
PB
1kvm_stat(1)
2===========
3
4NAME
5----
6kvm_stat - Report KVM kernel module event counters
7
8SYNOPSIS
9--------
10[verse]
11'kvm_stat' [OPTION]...
12
13DESCRIPTION
14-----------
15kvm_stat prints counts of KVM kernel module trace events. These events signify
16state transitions such as guest mode entry and exit.
17
18This tool is useful for observing guest behavior from the host perspective.
19Often conclusions about performance or buggy behavior can be drawn from the
20output.
1eaa2f90
SR
21While running in regular mode, use any of the keys listed in section
22'Interactive Commands' below.
23Use batch and logging modes for scripting purposes.
fd41b5a9
PB
24
25The set of KVM kernel module trace events may be specific to the kernel version
26or architecture. It is best to check the KVM kernel module source code for the
27meaning of events.
28
1eaa2f90
SR
29INTERACTIVE COMMANDS
30--------------------
31[horizontal]
5c1954d2
SR
32*b*:: toggle events by guests (debugfs only, honors filters)
33
4443084f
SR
34*c*:: clear filter
35
1eaa2f90
SR
36*f*:: filter by regular expression
37
f9ff1087
SR
38*g*:: filter by guest name
39
1fdea7b2
SR
40*h*:: display interactive commands reference
41
6667ae8f
SR
42*o*:: toggle sorting order (Total vs CurAvg/s)
43
1eaa2f90
SR
44*p*:: filter by PID
45
46*q*:: quit
47
9f114a03
SR
48*r*:: reset stats
49
64eefad2
SR
50*s*:: set update interval
51
1eaa2f90 52*x*:: toggle reporting of stats for child trace events
fff8c9eb
SR
53 :: *Note*: The stats for the parents summarize the respective child trace
54 events
1eaa2f90
SR
55
56Press any other key to refresh statistics immediately.
57
fd41b5a9
PB
58OPTIONS
59-------
60-1::
61--once::
62--batch::
63 run in batch mode for one second
64
65-l::
66--log::
67 run in logging mode (like vmstat)
68
69-t::
70--tracepoints::
71 retrieve statistics from tracepoints
72
73-d::
74--debugfs::
75 retrieve statistics from debugfs
76
ab7ef193
SR
77-i::
78--debugfs-include-past::
79 include all available data on past events for debugfs
80
f0cf040f
JF
81-p<pid>::
82--pid=<pid>::
83 limit statistics to one virtual machine (pid)
84
f9ff1087
SR
85-g<guest>::
86--guest=<guest_name>::
87 limit statistics to one virtual machine (guest name)
88
fd41b5a9
PB
89-f<fields>::
90--fields=<fields>::
f3d11b0e 91 fields to display (regex), "-f help" for a list of available events
fd41b5a9
PB
92
93-h::
94--help::
95 show help message
96
97SEE ALSO
98--------
99'perf'(1), 'trace-cmd'(1)
100
101AUTHOR
102------
103Stefan Hajnoczi <stefanha@redhat.com>