]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - tools/kvm/kvm_stat/kvm_stat.txt
tools/kvm_stat: add new interactive command 'h'
[mirror_ubuntu-bionic-kernel.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
1eaa2f90
SR
40*p*:: filter by PID
41
42*q*:: quit
43
9f114a03
SR
44*r*:: reset stats
45
1eaa2f90
SR
46*x*:: toggle reporting of stats for child trace events
47
48Press any other key to refresh statistics immediately.
49
fd41b5a9
PB
50OPTIONS
51-------
52-1::
53--once::
54--batch::
55 run in batch mode for one second
56
57-l::
58--log::
59 run in logging mode (like vmstat)
60
61-t::
62--tracepoints::
63 retrieve statistics from tracepoints
64
65-d::
66--debugfs::
67 retrieve statistics from debugfs
68
f0cf040f
JF
69-p<pid>::
70--pid=<pid>::
71 limit statistics to one virtual machine (pid)
72
f9ff1087
SR
73-g<guest>::
74--guest=<guest_name>::
75 limit statistics to one virtual machine (guest name)
76
fd41b5a9
PB
77-f<fields>::
78--fields=<fields>::
79 fields to display (regex)
80
81-h::
82--help::
83 show help message
84
85SEE ALSO
86--------
87'perf'(1), 'trace-cmd'(1)
88
89AUTHOR
90------
91Stefan Hajnoczi <stefanha@redhat.com>