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 *c*::   clear filter
  33
  34 *f*::   filter by regular expression
  35
  36 *g*::   filter by guest name
  37
  38 *h*::   display interactive commands reference
  39
  40 *p*::   filter by PID
  41
  42 *q*::   quit
  43
  44 *r*::   reset stats
  45
  46 *s*::   set update interval
  47
  48 *x*::   toggle reporting of stats for child trace events
  49
  50 Press any other key to refresh statistics immediately.
  51
  52 OPTIONS
  53 -------
  54 -1::
  55 --once::
  56 --batch::
  57         run in batch mode for one second
  58
  59 -l::
  60 --log::
  61         run in logging mode (like vmstat)
  62
  63 -t::
  64 --tracepoints::
  65         retrieve statistics from tracepoints
  66
  67 -d::
  68 --debugfs::
  69         retrieve statistics from debugfs
  70
  71 -p<pid>::
  72 --pid=<pid>::
  73         limit statistics to one virtual machine (pid)
  74
  75 -g<guest>::
  76 --guest=<guest_name>::
  77         limit statistics to one virtual machine (guest name)
  78
  79 -f<fields>::
  80 --fields=<fields>::
  81         fields to display (regex)
  82
  83 -h::
  84 --help::
  85         show help message
  86
  87 SEE ALSO
  88 --------
  89 'perf'(1), 'trace-cmd'(1)
  90
  91 AUTHOR
  92 ------
  93 Stefan Hajnoczi <stefanha@redhat.com>