share/man/man1/kvmstat.1

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright (c) 2014, Joyent, Inc.
  13 .\"
  14 .Dd Dec 20, 2014
  15 .Dt KVMSTAT 1
  16 .Os
  17 .Sh NAME
  18 .Nm kvmstat
  19 .Nd report KVM statistics
  20 .Sh SYNOPSIS
  21 .Nm kvmstat
  22 .Oo
  23 .Ar interval
  24 .Op Ar count
  25 .Oc
  26 .Sh DESCRIPTION
  27 .Nm
  28 reports the activity of running KVM virtual machines and their exit activity,
  29 injected interrupts, emulations, and more, on a per virtual CPU basis.
  30 .Lp
  31 .Nm
  32 should be used when trying to get a rough sense of guest activity from the
  33 hypervisor's perspective, and allows one to understand from a low-level
  34 perspective, what kind of activity is going on inside of the virtual machine.
  35 In addition,
  36 .Nm
  37 is useful for diagnosing reports of pathological or faulty behavior inside of
  38 guests.
  39 While there is no expected range of values for the fields displayed as that
  40 varies with the use of virtual machines, if all of the virtual CPUs for a given
  41 virtual machine are consistently zero, then that may indicate that a problem has
  42 occurred, for example, a panic inside of the guest or a bug in the hypervisor.
  43 .Lp
  44 If no operands are specified, then
  45 .Nm
  46 will display statistics every second until the program is terminated.
  47 .Ss Output Fields
  48 Every
  49 .Ar interval
  50 .Nm
  51 will report data with the following fields:
  52 .Bl -tag -width Ds
  53 .It Nm pid
  54 Identifier of the process controlling the virtual CPU.
  55 .It Nm vcpu
  56 Virtual CPU identifier relative to its virtual machine.
  57 .It Nm exits
  58 Count of all virtual machine exits for the virtual CPU over
  59 .Ar interval .
  60 .It Nm haltx
  61 Count of virtual machine exits due to the guest executing the
  62 .Sy HLT
  63 instruction for the virtual CPU over
  64 .Ar interval .
  65 .It Nm irqx
  66 Count of virtual machine exits due to a pending external interrupt arriving
  67 on the physical CPU that the virtual CPU was actively running on over
  68 .Ar interval .
  69 .It Nm irqwx
  70 Count of virtual machine exits due to an open interrupt window on the
  71 virtual CPU over
  72 .Ar interval .
  73 .It Nm iox
  74 Count of virtual machine exits due to the execution of an I/O instruction,
  75 such as
  76 .Sy inb ,
  77 on the virtual CPU over
  78 .Ar interval .
  79 .It Nm mmiox
  80 Count of virtual machine exits due to performing memory mapped I/O on the
  81 virtual CPU over
  82 .Ar interval .
  83 .It Nm irqs
  84 Count of interrupts injected into the virtual CPU over
  85 .Ar interval .
  86 .It Nm emul
  87 Count of instructions the hypervisor had to emulate on behalf of the guest
  88 virtual CPU over
  89 .Ar interval .
  90 .It Nm eptv
  91 Count of extended page table violations serviced on the virtual CPU over
  92 .Ar interval .
  93 .El
  94 .Sh OPERANDS
  95 The following operands are supported:
  96 .Bl -hang -width Ds
  97 .It Ar count
  98 .Bd -filled -compact
  99 Specifies the number of times that the statistics are repeated.
 100 If not specified,
 101 .Nm
 102 will continue until it is terminated.
 103 .Ed
 104 .It Ar interval
 105 .Bd -filled -compact
 106 Specifies the number of seconds between reports of statistics.
 107 If not specified, reports are generated every second.
 108 .Ed
 109 .El
 110 .Sh STABILITY
 111 The arguments are
 112 .Sy committed ,
 113 while the output format is
 114 .Sy Not an interface .
 115 .Sh SEE ALSO
 116 .Xr iostat 8 ,
 117 .Xr mpstat 8 ,
 118 .Xr attributes 5