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