1 perf-kvm(1)
2 ===========
3
4 NAME
5 ----
6 perf-kvm - Tool to trace/measure kvm guest os
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf kvm' [--host] [--guest] [--guestmount=<p
12 [--guestkallsyms=<path> --guestmodules
13 {top|record|report|diff|buildid-list}
14 'perf kvm' [--host] [--guest] [--guestkallsyms
15 | --guestvmlinux=<path>] {top|record|r
16 'perf kvm stat [record|report|live] [<options>
17
18 DESCRIPTION
19 -----------
20 There are a couple of variants of perf kvm:
21
22 'perf kvm [options] top <command>' to genera
23 a performance counter profile of guest os in
24 of an arbitrary workload.
25
26 'perf kvm record <command>' to record the pe
27 of an arbitrary workload and save it into a
28 default behavior of perf kvm as --guest, so
29 is input, the perf data file name is perf.da
30 the perf data file name is perf.data.kvm. If
31 perf.data.host, please input --host --no-gue
32 following:
33 Default('') -> perf.data.guest
34 --host -> perf.data.kvm
35 --guest -> perf.data.guest
36 --host --guest -> perf.data.kvm
37 --host --no-guest -> perf.data.host
38
39 'perf kvm report' to display the performance
40 recorded via perf kvm record.
41
42 'perf kvm diff' to displays the performance
43 files captured via perf record.
44
45 'perf kvm buildid-list' to display the buil
46 so that other tools can be used to fetch pac
47 for use by perf report. As buildid is read f
48 if you want to list the buildid for guest, p
49 was captured with --guestmount in perf kvm r
50
51 'perf kvm stat <command>' to run a command a
52 statistics.
53 Especially, perf 'kvm stat record/report' ge
54 of KVM events. Currently, vmexit, mmio (x86
55 events are supported. 'perf kvm stat record
56 and the events between start and end <comman
57 And this command produces a file which conta
58 events.
59
60 'perf kvm stat report' reports statistical d
61 handled sample, percent_sample, time, percen
62
63 'perf kvm stat live' reports statistical dat
64 record + report but with statistical data up
65 rate).
66
67 OPTIONS
68 -------
69 -i::
70 --input=<path>::
71 Input file name, for the 'report', 'di
72 -o::
73 --output=<path>::
74 Output file name, for the 'record' sub
75 just redirect the output to a file whe
76 --host::
77 Collect host side performance profile.
78 --guest::
79 Collect guest side performance profile
80
81 :GMEXAMPLECMD: kvm --host --guest
82 :GMEXAMPLESUBCMD: top
83 include::guest-files.txt[]
84
85 --stdio:: Use the stdio interface.
86
87 -v::
88 --verbose::
89 Be more verbose (show counter open err
90
91 STAT REPORT OPTIONS
92 -------------------
93 --vcpu=<value>::
94 analyze events which occur on this vcpu
95
96 --event=<value>::
97 event to be analyzed. Possible values:
98 ioport (x86 only). (default: vmexit)
99 -k::
100 --key=<value>::
101 Sorting key. Possible values: sample (d
102 number), percent_sample (sort by sample
103 (sort by average time), precent_time (s
104 max_t (sort by maximum time), min_t (so
105 (sort by mean time).
106 -p::
107 --pid=::
108 Analyze events only for given process ID(s
109
110 STAT LIVE OPTIONS
111 -----------------
112 -d::
113 --display::
114 Time in seconds between display update
115
116 -m::
117 --mmap-pages=::
118 Number of mmap data pages (must be a p
119 specification in bytes with appended u
120 The size is rounded up to the nearest
121
122 -a::
123 --all-cpus::
124 System-wide collection from all CPUs.
125
126 -p::
127 --pid=::
128 Analyze events only for given process ID(s
129
130 --vcpu=<value>::
131 analyze events which occur on this vcpu
132
133
134 --event=<value>::
135 event to be analyzed. Possible values:
136 mmio (x86 only), ioport (x86 only).
137 (default: vmexit)
138
139 -k::
140 --key=<value>::
141 Sorting key. Possible values: sample (d
142 number), time (sort by average time).
143
144 --duration=<value>::
145 Show events other than HLT (x86 only) o
146 that take longer than duration usecs.
147
148 --proc-map-timeout::
149 When processing pre-existing threads /
150 a long time, because the file may be h
151 in such cases.
152 This option sets the time out limit. T
153
154 SEE ALSO
155 --------
156 linkperf:perf-top[1], linkperf:perf-record[1],
157 linkperf:perf-diff[1], linkperf:perf-buildid-l
158 linkperf:perf-stat[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.