18c2ecf20Sopenharmony_cikvm_stat(1) 28c2ecf20Sopenharmony_ci=========== 38c2ecf20Sopenharmony_ci 48c2ecf20Sopenharmony_ciNAME 58c2ecf20Sopenharmony_ci---- 68c2ecf20Sopenharmony_cikvm_stat - Report KVM kernel module event counters 78c2ecf20Sopenharmony_ci 88c2ecf20Sopenharmony_ciSYNOPSIS 98c2ecf20Sopenharmony_ci-------- 108c2ecf20Sopenharmony_ci[verse] 118c2ecf20Sopenharmony_ci'kvm_stat' [OPTION]... 128c2ecf20Sopenharmony_ci 138c2ecf20Sopenharmony_ciDESCRIPTION 148c2ecf20Sopenharmony_ci----------- 158c2ecf20Sopenharmony_cikvm_stat prints counts of KVM kernel module trace events. These events signify 168c2ecf20Sopenharmony_cistate transitions such as guest mode entry and exit. 178c2ecf20Sopenharmony_ci 188c2ecf20Sopenharmony_ciThis tool is useful for observing guest behavior from the host perspective. 198c2ecf20Sopenharmony_ciOften conclusions about performance or buggy behavior can be drawn from the 208c2ecf20Sopenharmony_cioutput. 218c2ecf20Sopenharmony_ciWhile running in regular mode, use any of the keys listed in section 228c2ecf20Sopenharmony_ci'Interactive Commands' below. 238c2ecf20Sopenharmony_ciUse batch and logging modes for scripting purposes. 248c2ecf20Sopenharmony_ci 258c2ecf20Sopenharmony_ciThe set of KVM kernel module trace events may be specific to the kernel version 268c2ecf20Sopenharmony_cior architecture. It is best to check the KVM kernel module source code for the 278c2ecf20Sopenharmony_cimeaning of events. 288c2ecf20Sopenharmony_ci 298c2ecf20Sopenharmony_ciINTERACTIVE COMMANDS 308c2ecf20Sopenharmony_ci-------------------- 318c2ecf20Sopenharmony_ci[horizontal] 328c2ecf20Sopenharmony_ci*b*:: toggle events by guests (debugfs only, honors filters) 338c2ecf20Sopenharmony_ci 348c2ecf20Sopenharmony_ci*c*:: clear filter 358c2ecf20Sopenharmony_ci 368c2ecf20Sopenharmony_ci*f*:: filter by regular expression 378c2ecf20Sopenharmony_ci :: *Note*: Child events pull in their parents, and parents' stats summarize 388c2ecf20Sopenharmony_ci all child events, not just the filtered ones 398c2ecf20Sopenharmony_ci 408c2ecf20Sopenharmony_ci*g*:: filter by guest name/PID 418c2ecf20Sopenharmony_ci 428c2ecf20Sopenharmony_ci*h*:: display interactive commands reference 438c2ecf20Sopenharmony_ci 448c2ecf20Sopenharmony_ci*o*:: toggle sorting order (Total vs CurAvg/s) 458c2ecf20Sopenharmony_ci 468c2ecf20Sopenharmony_ci*p*:: filter by guest name/PID 478c2ecf20Sopenharmony_ci 488c2ecf20Sopenharmony_ci*q*:: quit 498c2ecf20Sopenharmony_ci 508c2ecf20Sopenharmony_ci*r*:: reset stats 518c2ecf20Sopenharmony_ci 528c2ecf20Sopenharmony_ci*s*:: set delay between refreshs 538c2ecf20Sopenharmony_ci 548c2ecf20Sopenharmony_ci*x*:: toggle reporting of stats for child trace events 558c2ecf20Sopenharmony_ci :: *Note*: The stats for the parents summarize the respective child trace 568c2ecf20Sopenharmony_ci events 578c2ecf20Sopenharmony_ci 588c2ecf20Sopenharmony_ciPress any other key to refresh statistics immediately. 598c2ecf20Sopenharmony_ci 608c2ecf20Sopenharmony_ciOPTIONS 618c2ecf20Sopenharmony_ci------- 628c2ecf20Sopenharmony_ci-1:: 638c2ecf20Sopenharmony_ci--once:: 648c2ecf20Sopenharmony_ci--batch:: 658c2ecf20Sopenharmony_ci run in batch mode for one second 668c2ecf20Sopenharmony_ci 678c2ecf20Sopenharmony_ci-c:: 688c2ecf20Sopenharmony_ci--csv:: 698c2ecf20Sopenharmony_ci log in csv format. Requires option -l/--log or -L/--log-to-file. 708c2ecf20Sopenharmony_ci When used with option -L/--log-to-file, the header is only ever 718c2ecf20Sopenharmony_ci written to start of file to preserve the format. 728c2ecf20Sopenharmony_ci 738c2ecf20Sopenharmony_ci-d:: 748c2ecf20Sopenharmony_ci--debugfs:: 758c2ecf20Sopenharmony_ci retrieve statistics from debugfs 768c2ecf20Sopenharmony_ci 778c2ecf20Sopenharmony_ci-f<fields>:: 788c2ecf20Sopenharmony_ci--fields=<fields>:: 798c2ecf20Sopenharmony_ci fields to display (regex), "-f help" for a list of available events 808c2ecf20Sopenharmony_ci 818c2ecf20Sopenharmony_ci-g<guest>:: 828c2ecf20Sopenharmony_ci--guest=<guest_name>:: 838c2ecf20Sopenharmony_ci limit statistics to one virtual machine (guest name) 848c2ecf20Sopenharmony_ci 858c2ecf20Sopenharmony_ci-h:: 868c2ecf20Sopenharmony_ci--help:: 878c2ecf20Sopenharmony_ci show help message 888c2ecf20Sopenharmony_ci 898c2ecf20Sopenharmony_ci-i:: 908c2ecf20Sopenharmony_ci--debugfs-include-past:: 918c2ecf20Sopenharmony_ci include all available data on past events for debugfs 928c2ecf20Sopenharmony_ci 938c2ecf20Sopenharmony_ci-l:: 948c2ecf20Sopenharmony_ci--log:: 958c2ecf20Sopenharmony_ci run in logging mode (like vmstat) 968c2ecf20Sopenharmony_ci 978c2ecf20Sopenharmony_ci 988c2ecf20Sopenharmony_ci-L<file>:: 998c2ecf20Sopenharmony_ci--log-to-file=<file>:: 1008c2ecf20Sopenharmony_ci like -l/--log, but logging to a file. Appends to existing files. 1018c2ecf20Sopenharmony_ci 1028c2ecf20Sopenharmony_ci-p<pid>:: 1038c2ecf20Sopenharmony_ci--pid=<pid>:: 1048c2ecf20Sopenharmony_ci limit statistics to one virtual machine (pid) 1058c2ecf20Sopenharmony_ci 1068c2ecf20Sopenharmony_ci-s:: 1078c2ecf20Sopenharmony_ci--set-delay:: 1088c2ecf20Sopenharmony_ci set delay between refreshs (value range: 0.1-25.5 secs) 1098c2ecf20Sopenharmony_ci 1108c2ecf20Sopenharmony_ci-t:: 1118c2ecf20Sopenharmony_ci--tracepoints:: 1128c2ecf20Sopenharmony_ci retrieve statistics from tracepoints 1138c2ecf20Sopenharmony_ci 1148c2ecf20Sopenharmony_ci*z*:: 1158c2ecf20Sopenharmony_ci--skip-zero-records:: 1168c2ecf20Sopenharmony_ci omit records with all zeros in logging mode 1178c2ecf20Sopenharmony_ci 1188c2ecf20Sopenharmony_ciSEE ALSO 1198c2ecf20Sopenharmony_ci-------- 1208c2ecf20Sopenharmony_ci'perf'(1), 'trace-cmd'(1) 1218c2ecf20Sopenharmony_ci 1228c2ecf20Sopenharmony_ciAUTHOR 1238c2ecf20Sopenharmony_ci------ 1248c2ecf20Sopenharmony_ciStefan Hajnoczi <stefanha@redhat.com> 125