tools/kvm_stat: add new command line switch '-i'
[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]
4443084f
SR
32*c*:: clear filter
33
1eaa2f90
SR
34*f*:: filter by regular expression
35
f9ff1087
SR
36*g*:: filter by guest name
37
1fdea7b2
SR
38*h*:: display interactive commands reference
39
6667ae8f
SR
40*o*:: toggle sorting order (Total vs CurAvg/s)
41
1eaa2f90
SR
42*p*:: filter by PID
43
44*q*:: quit
45
9f114a03
SR
46*r*:: reset stats
47
64eefad2
SR
48*s*:: set update interval
49
1eaa2f90
SR
50*x*:: toggle reporting of stats for child trace events
51
52Press any other key to refresh statistics immediately.
53
fd41b5a9
PB
54OPTIONS
55-------
56-1::
57--once::
58--batch::
59 run in batch mode for one second
60
61-l::
62--log::
63 run in logging mode (like vmstat)
64
65-t::
66--tracepoints::
67 retrieve statistics from tracepoints
68
69-d::
70--debugfs::
71 retrieve statistics from debugfs
72
ab7ef193
SR
73-i::
74--debugfs-include-past::
75 include all available data on past events for debugfs
76
f0cf040f
JF
77-p<pid>::
78--pid=<pid>::
79 limit statistics to one virtual machine (pid)
80
f9ff1087
SR
81-g<guest>::
82--guest=<guest_name>::
83 limit statistics to one virtual machine (guest name)
84
fd41b5a9
PB
85-f<fields>::
86--fields=<fields>::
87 fields to display (regex)
88
89-h::
90--help::
91 show help message
92
93SEE ALSO
94--------
95'perf'(1), 'trace-cmd'(1)
96
97AUTHOR
98------
99Stefan Hajnoczi <stefanha@redhat.com>