tools/kvm/kvm_stat/kvm_stat.txt

   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.
  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.
  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
  29 INTERACTIVE COMMANDS
  30 --------------------
  31 [horizontal]
  32 *b*::   toggle events by guests (debugfs only, honors filters)
  33
  34 *c*::   clear filter
  35
  36 *f*::   filter by regular expression
  37
  38 *g*::   filter by guest name
  39
  40 *h*::   display interactive commands reference
  41
  42 *o*::   toggle sorting order (Total vs CurAvg/s)
  43
  44 *p*::   filter by PID
  45
  46 *q*::   quit
  47
  48 *r*::   reset stats
  49
  50 *s*::   set update interval
  51
  52 *x*::   toggle reporting of stats for child trace events
  53  ::     *Note*: The stats for the parents summarize the respective child trace
  54                 events
  55
  56 Press any other key to refresh statistics immediately.
  57
  58 OPTIONS
  59 -------
  60 -1::
  61 --once::
  62 --batch::
  63         run in batch mode for one second
  64
  65 -l::
  66 --log::
  67         run in logging mode (like vmstat)
  68
  69 -t::
  70 --tracepoints::
  71         retrieve statistics from tracepoints
  72
  73 -d::
  74 --debugfs::
  75         retrieve statistics from debugfs
  76
  77 -i::
  78 --debugfs-include-past::
  79         include all available data on past events for debugfs
  80
  81 -p<pid>::
  82 --pid=<pid>::
  83         limit statistics to one virtual machine (pid)
  84
  85 -g<guest>::
  86 --guest=<guest_name>::
  87         limit statistics to one virtual machine (guest name)
  88
  89 -f<fields>::
  90 --fields=<fields>::
  91         fields to display (regex), "-f help" for a list of available events
  92
  93 -h::
  94 --help::
  95         show help message
  96
  97 SEE ALSO
  98 --------
  99 'perf'(1), 'trace-cmd'(1)
 100
 101 AUTHOR
 102 ------
 103 Stefan Hajnoczi <stefanha@redhat.com>