xref: /linux/tools/kvm/kvm_stat/kvm_stat.txt (revision e58e871becec2d3b04ed91c0c16fe8deac9c9dfa)
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.
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.
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
29INTERACTIVE COMMANDS
30--------------------
31[horizontal]
32*c*::	clear filter
33
34*f*::	filter by regular expression
35
36*g*::	filter by guest name
37
38*p*::	filter by PID
39
40*q*::	quit
41
42*r*::	reset stats
43
44*x*::	toggle reporting of stats for child trace events
45
46Press any other key to refresh statistics immediately.
47
48OPTIONS
49-------
50-1::
51--once::
52--batch::
53	run in batch mode for one second
54
55-l::
56--log::
57	run in logging mode (like vmstat)
58
59-t::
60--tracepoints::
61	retrieve statistics from tracepoints
62
63-d::
64--debugfs::
65	retrieve statistics from debugfs
66
67-p<pid>::
68--pid=<pid>::
69	limit statistics to one virtual machine (pid)
70
71-g<guest>::
72--guest=<guest_name>::
73	limit statistics to one virtual machine (guest name)
74
75-f<fields>::
76--fields=<fields>::
77	fields to display (regex)
78
79-h::
80--help::
81	show help message
82
83SEE ALSO
84--------
85'perf'(1), 'trace-cmd'(1)
86
87AUTHOR
88------
89Stefan Hajnoczi <stefanha@redhat.com>
90