1 kvm_stat(1) 1 kvm_stat(1)
2 =========== 2 ===========
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 kvm_stat - Report KVM kernel module event coun 6 kvm_stat - Report KVM kernel module event counters
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'kvm_stat' [OPTION]... 11 'kvm_stat' [OPTION]...
12 12
13 DESCRIPTION 13 DESCRIPTION
14 ----------- 14 -----------
15 kvm_stat prints counts of KVM kernel module tr 15 kvm_stat prints counts of KVM kernel module trace events. These events signify
16 state transitions such as guest mode entry and 16 state transitions such as guest mode entry and exit.
17 17
18 This tool is useful for observing guest behavi 18 This tool is useful for observing guest behavior from the host perspective.
19 Often conclusions about performance or buggy b 19 Often conclusions about performance or buggy behavior can be drawn from the
20 output. 20 output.
21 While running in regular mode, use any of the 21 While running in regular mode, use any of the keys listed in section
22 'Interactive Commands' below. 22 'Interactive Commands' below.
23 Use batch and logging modes for scripting purp 23 Use batch and logging modes for scripting purposes.
24 24
25 The set of KVM kernel module trace events may 25 The set of KVM kernel module trace events may be specific to the kernel version
26 or architecture. It is best to check the KVM 26 or architecture. It is best to check the KVM kernel module source code for the
27 meaning of events. 27 meaning of events.
28 28
29 INTERACTIVE COMMANDS 29 INTERACTIVE COMMANDS
30 -------------------- 30 --------------------
31 [horizontal] 31 [horizontal]
32 *b*:: toggle events by guests (debugfs only, 32 *b*:: toggle events by guests (debugfs only, honors filters)
33 33
34 *c*:: clear filter 34 *c*:: clear filter
35 35
36 *f*:: filter by regular expression 36 *f*:: filter by regular expression
37 :: *Note*: Child events pull in their par <<
38 all child events, not just the <<
39 37
40 *g*:: filter by guest name/PID 38 *g*:: filter by guest name/PID
41 39
42 *h*:: display interactive commands reference 40 *h*:: display interactive commands reference
43 41
44 *o*:: toggle sorting order (Total vs CurAvg/ 42 *o*:: toggle sorting order (Total vs CurAvg/s)
45 43
46 *p*:: filter by guest name/PID 44 *p*:: filter by guest name/PID
47 45
48 *q*:: quit 46 *q*:: quit
49 47
50 *r*:: reset stats 48 *r*:: reset stats
51 49
52 *s*:: set delay between refreshs !! 50 *s*:: set update interval
53 51
54 *x*:: toggle reporting of stats for child tr 52 *x*:: toggle reporting of stats for child trace events
55 :: *Note*: The stats for the parents summ 53 :: *Note*: The stats for the parents summarize the respective child trace
56 events 54 events
57 55
58 Press any other key to refresh statistics imme 56 Press any other key to refresh statistics immediately.
59 57
60 OPTIONS 58 OPTIONS
61 ------- 59 -------
62 -1:: 60 -1::
63 --once:: 61 --once::
64 --batch:: 62 --batch::
65 run in batch mode for one second 63 run in batch mode for one second
66 64
67 -c:: !! 65 -l::
68 --csv:: !! 66 --log::
69 log in csv format. Requires option -l/ !! 67 run in logging mode (like vmstat)
70 When used with option -L/--log-to-file !! 68
71 written to start of file to preserve t !! 69 -t::
>> 70 --tracepoints::
>> 71 retrieve statistics from tracepoints
72 72
73 -d:: 73 -d::
74 --debugfs:: 74 --debugfs::
75 retrieve statistics from debugfs 75 retrieve statistics from debugfs
76 76
77 -f<fields>:: <<
78 --fields=<fields>:: <<
79 fields to display (regex), "-f help" f <<
80 <<
81 -g<guest>:: <<
82 --guest=<guest_name>:: <<
83 limit statistics to one virtual machin <<
84 <<
85 -h:: <<
86 --help:: <<
87 show help message <<
88 <<
89 -i:: 77 -i::
90 --debugfs-include-past:: 78 --debugfs-include-past::
91 include all available data on past eve 79 include all available data on past events for debugfs
92 80
93 -l:: <<
94 --log:: <<
95 run in logging mode (like vmstat) <<
96 <<
97 <<
98 -L<file>:: <<
99 --log-to-file=<file>:: <<
100 like -l/--log, but logging to a file. <<
101 <<
102 -p<pid>:: 81 -p<pid>::
103 --pid=<pid>:: 82 --pid=<pid>::
104 limit statistics to one virtual machin 83 limit statistics to one virtual machine (pid)
105 84
106 -s:: !! 85 -g<guest>::
107 --set-delay:: !! 86 --guest=<guest_name>::
108 set delay between refreshs (value rang !! 87 limit statistics to one virtual machine (guest name)
109 88
110 -t:: !! 89 -f<fields>::
111 --tracepoints:: !! 90 --fields=<fields>::
112 retrieve statistics from tracepoints !! 91 fields to display (regex), "-f help" for a list of available events
113 92
114 -z:: !! 93 -h::
115 --skip-zero-records:: !! 94 --help::
116 omit records with all zeros in logging !! 95 show help message
117 96
118 SEE ALSO 97 SEE ALSO
119 -------- 98 --------
120 'perf'(1), 'trace-cmd'(1) 99 'perf'(1), 'trace-cmd'(1)
121 100
122 AUTHOR 101 AUTHOR
123 ------ 102 ------
124 Stefan Hajnoczi <stefanha@redhat.com> 103 Stefan Hajnoczi <stefanha@redhat.com>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.