projects / thirdparty / kernel / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| fd41b5a9 PB |
1 | kvm_stat(1) |
| 2 | =========== | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | kvm_stat - Report KVM kernel module event counters | |
| 7 | ||
| 8 | SYNOPSIS | |
| 9 | -------- | |
| 10 | [verse] | |
| 11 | 'kvm_stat' [OPTION]... | |
| 12 | ||
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 15 | kvm_stat prints counts of KVM kernel module trace events. These events signify | |
| 16 | state transitions such as guest mode entry and exit. | |
| 17 | ||
| 18 | This tool is useful for observing guest behavior from the host perspective. | |
| 19 | Often conclusions about performance or buggy behavior can be drawn from the | |
| 20 | output. | |
| 1eaa2f90 SR |
21 | While running in regular mode, use any of the keys listed in section |
| 22 | 'Interactive Commands' below. | |
| 23 | Use batch and logging modes for scripting purposes. | |
| fd41b5a9 PB |
24 | |
| 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 kernel module source code for the | |
| 27 | meaning of events. | |
| 28 | ||
| 1eaa2f90 SR |
29 | INTERACTIVE COMMANDS |
| 30 | -------------------- | |
| 31 | [horizontal] | |
| 5c1954d2 SR |
32 | *b*:: toggle events by guests (debugfs only, honors filters) |
| 33 | ||
| 4443084f SR |
34 | *c*:: clear filter |
| 35 | ||
| 1eaa2f90 | 36 | *f*:: filter by regular expression |
| 883d25e7 SR |
37 | :: *Note*: Child events pull in their parents, and parents' stats summarize |
| 38 | all child events, not just the filtered ones | |
| 1eaa2f90 | 39 | |
| 516f1190 | 40 | *g*:: filter by guest name/PID |
| f9ff1087 | 41 | |
| 1fdea7b2 SR |
42 | *h*:: display interactive commands reference |
| 43 | ||
| 6667ae8f SR |
44 | *o*:: toggle sorting order (Total vs CurAvg/s) |
| 45 | ||
| 516f1190 | 46 | *p*:: filter by guest name/PID |
| 1eaa2f90 SR |
47 | |
| 48 | *q*:: quit | |
| 49 | ||
| 9f114a03 SR |
50 | *r*:: reset stats |
| 51 | ||
| 64eefad2 SR |
52 | *s*:: set update interval |
| 53 | ||
| 1eaa2f90 | 54 | *x*:: toggle reporting of stats for child trace events |
| fff8c9eb SR |
55 | :: *Note*: The stats for the parents summarize the respective child trace |
| 56 | events | |
| 1eaa2f90 SR |
57 | |
| 58 | Press any other key to refresh statistics immediately. | |
| 59 | ||
| fd41b5a9 PB |
60 | OPTIONS |
| 61 | ------- | |
| 62 | -1:: | |
| 63 | --once:: | |
| 64 | --batch:: | |
| 65 | run in batch mode for one second | |
| 66 | ||
| 67 | -l:: | |
| 68 | --log:: | |
| 69 | run in logging mode (like vmstat) | |
| 70 | ||
| 71 | -t:: | |
| 72 | --tracepoints:: | |
| 73 | retrieve statistics from tracepoints | |
| 74 | ||
| 75 | -d:: | |
| 76 | --debugfs:: | |
| 77 | retrieve statistics from debugfs | |
| 78 | ||
| ab7ef193 SR |
79 | -i:: |
| 80 | --debugfs-include-past:: | |
| 81 | include all available data on past events for debugfs | |
| 82 | ||
| f0cf040f JF |
83 | -p<pid>:: |
| 84 | --pid=<pid>:: | |
| 85 | limit statistics to one virtual machine (pid) | |
| 86 | ||
| f9ff1087 SR |
87 | -g<guest>:: |
| 88 | --guest=<guest_name>:: | |
| 89 | limit statistics to one virtual machine (guest name) | |
| 90 | ||
| fd41b5a9 PB |
91 | -f<fields>:: |
| 92 | --fields=<fields>:: | |
| f3d11b0e | 93 | fields to display (regex), "-f help" for a list of available events |
| fd41b5a9 PB |
94 | |
| 95 | -h:: | |
| 96 | --help:: | |
| 97 | show help message | |
| 98 | ||
| 99 | SEE ALSO | |
| 100 | -------- | |
| 101 | 'perf'(1), 'trace-cmd'(1) | |
| 102 | ||
| 103 | AUTHOR | |
| 104 | ------ | |
| 105 | Stefan Hajnoczi <stefanha@redhat.com> |