usr.bin/vmstat/vmstat.8

   1 .\" Copyright (c) 1986, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)vmstat.8    8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd August 8, 2014
  32 .Dt VMSTAT 8
  33 .Os
  34 .Sh NAME
  35 .Nm vmstat
  36 .Nd report virtual memory statistics
  37 .Sh SYNOPSIS
  38 .Nm
  39 .\" .Op Fl fimst
  40 .Op Fl afHhimPsz
  41 .Op Fl M Ar core Op Fl N Ar system
  42 .Op Fl c Ar count
  43 .Op Fl n Ar devs
  44 .Oo
  45 .Fl p
  46 .Sm off
  47 .Ar type , if , pass
  48 .Sm on
  49 .Oc
  50 .Op Fl w Ar wait
  51 .Op Ar disks ...
  52 .Op wait Op count
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility reports certain kernel statistics kept about process, virtual memory,
  57 disk, trap and cpu activity.
  58 .Pp
  59 If the
  60 .Fl M
  61 option is not specified, information is obtained from
  62 the currently running kernel via the
  63 .Xr sysctl 3
  64 interface.
  65 Otherwise, information is read from the specified core file,
  66 using the name list from the specified kernel image (or from
  67 the default image).
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width indent
  71 .It Fl a
  72 When used with
  73 .Fl i ,
  74 include statistics about interrupts that have never been generated.
  75 .It Fl c
  76 Repeat the display
  77 .Ar count
  78 times.
  79 The first display is for the time since a reboot and each subsequent
  80 report is for the time period since the last display.
  81 If no repeat
  82 .Ar count
  83 is specified, and
  84 .Fl w
  85 is specified, the default is infinity, otherwise the default is one.
  86 .It Fl f
  87 Report on the number
  88 .Xr fork 2 ,
  89 .Xr vfork 2
  90 and
  91 .Xr rfork 2
  92 system calls since system startup, and the number of pages of virtual memory
  93 involved in each.
  94 .It Fl h
  95 Changes memory columns into more easily human readable form.
  96 The default if
  97 standard output is a terminal device.
  98 .It Fl H
  99 Changes memory columns into straight numbers.
 100 The default if standard output
 101 is not a terminal device (such as a script).
 102 .It Fl i
 103 Report on the number of interrupts taken by each device since system
 104 startup.
 105 .It Fl M
 106 Extract values associated with the name list from the specified
 107 .Ar core .
 108 .It Fl N
 109 If
 110 .Fl M
 111 is also specified,
 112 extract the name list from the specified
 113 .Ar system
 114 instead of the default,
 115 which is the kernel image the system has booted from.
 116 .It Fl m
 117 Report on the usage of kernel dynamic memory allocated using
 118 .Xr malloc 9
 119 by type.
 120 .It Fl n
 121 Change the maximum number of disks to display from the default of 2.
 122 .It Fl P
 123 Report per-cpu system/user/idle cpu statistics.
 124 .It Fl p
 125 Specify which types of devices to display.
 126 There are three different
 127 categories of devices:
 128 .Pp
 129 .Bl -tag -width indent -compact
 130 .It device type:
 131 .Bl -tag -width 9n -compact
 132 .It da
 133 Direct Access devices
 134 .It sa
 135 Sequential Access devices
 136 .It printer
 137 Printers
 138 .It proc
 139 Processor devices
 140 .It worm
 141 Write Once Read Multiple devices
 142 .It cd
 143 CD devices
 144 .It scanner
 145 Scanner devices
 146 .It optical
 147 Optical Memory devices
 148 .It changer
 149 Medium Changer devices
 150 .It comm
 151 Communication devices
 152 .It array
 153 Storage Array devices
 154 .It enclosure
 155 Enclosure Services devices
 156 .It floppy
 157 Floppy devices
 158 .El
 159 .Pp
 160 .It interface:
 161 .Bl -tag -width 9n -compact
 162 .It IDE
 163 Integrated Drive Electronics devices
 164 .It SCSI
 165 Small Computer System Interface devices
 166 .It other
 167 Any other device interface
 168 .El
 169 .Pp
 170 .It passthrough:
 171 .Bl -tag -width 9n -compact
 172 .It pass
 173 Passthrough devices
 174 .El
 175 .El
 176 .Pp
 177 The user must specify at least one device type, and may specify at most
 178 one device type from each category.
 179 Multiple device types in a single
 180 device type statement must be separated by commas.
 181 .Pp
 182 Any number of
 183 .Fl p
 184 arguments may be specified on the command line.
 185 All
 186 .Fl p
 187 arguments are ORed together to form a matching expression against which
 188 all devices in the system are compared.
 189 Any device that fully matches
 190 any
 191 .Fl p
 192 argument will be included in the
 193 .Nm
 194 output, up to two devices, or the maximum number of devices specified
 195 by the user.
 196 .It Fl s
 197 Display the contents of the
 198 .Em sum
 199 structure, giving the total number of several kinds of paging related
 200 events which have occurred since system startup.
 201 .\" .It Fl t
 202 .\" Report on the number of page in and page reclaims since system startup,
 203 .\" and the amount of time required by each.
 204 .It Fl w
 205 Pause
 206 .Ar wait
 207 seconds between each display.
 208 If no repeat
 209 .Ar wait
 210 interval is specified, the default is 1 second.
 211 The
 212 .Nm
 213 command will accept and honor a non-integer number of seconds.
 214 .It Fl z
 215 Report on memory used by the kernel zone allocator,
 216 .Xr uma 9 ,
 217 by zone.
 218 .El
 219 .Pp
 220 The
 221 .Ar wait
 222 and
 223 .Ar count
 224 arguments may be given after their respective flags at any point
 225 on the command line before the
 226 .Ar disks
 227 argument(s), or without their flags, as the final argument(s).
 228 The latter form is accepted for backwards compatibility, but it is
 229 preferred to use the forms with
 230 .Fl w
 231 and
 232 .Fl c
 233 to avoid ambiguity.
 234 .Pp
 235 By default,
 236 .Nm
 237 displays the following information:
 238 .Bl -tag -width indent
 239 .It procs
 240 Information about the numbers of processes in various states.
 241 .Pp
 242 .Bl -tag -width indent -compact
 243 .It r
 244 in run queue
 245 .It b
 246 blocked for resources (i/o, paging, etc.)
 247 .It w
 248 runnable or short sleeper (< 20 secs) but swapped
 249 .El
 250 .It memory
 251 Information about the usage of virtual and real memory.
 252 Virtual pages (reported in units of 1024 bytes) are considered active if
 253 they belong to processes which are running or have run in the last 20
 254 seconds.
 255 .Pp
 256 .Bl -tag -width indent -compact
 257 .It avm
 258 active virtual pages
 259 .It fre
 260 size of the free list
 261 .El
 262 .It page
 263 Information about page faults and paging activity.
 264 These are averaged each five seconds, and given in units per second.
 265 .Pp
 266 .Bl -tag -width indent -compact
 267 .It flt
 268 total number of page faults
 269 .It re
 270 page reclaims (simulating reference bits)
 271 .\" .It at
 272 .\" pages attached (found in free list)
 273 .It pi
 274 pages paged in
 275 .It po
 276 pages paged out
 277 .It fr
 278 pages freed per second
 279 .\" .It de
 280 .\" anticipated short term memory shortfall
 281 .It sr
 282 pages scanned by clock algorithm, per-second
 283 .El
 284 .It disks
 285 Disk operations per second (this field is system dependent).
 286 Typically paging will be split across the available drives.
 287 The header of the field is the first two characters of the disk name and
 288 the unit number.
 289 If more than two disk drives are configured in the system,
 290 .Nm
 291 displays only the first two drives, unless the user specifies the
 292 .Fl n
 293 argument to increase the number of drives displayed.
 294 This will probably
 295 cause the display to exceed 80 columns, however.
 296 To force
 297 .Nm
 298 to display specific drives, their names may be supplied on the command line.
 299 The
 300 .Nm
 301 utility
 302 defaults to show disks first, and then various other random devices in the
 303 system to add up to two devices, if there are that many devices in the
 304 system.
 305 If devices are specified on the command line, or if a device type
 306 matching pattern is specified (see above),
 307 .Nm
 308 will only display the given devices or the devices matching the pattern,
 309 and will not randomly select other devices in the system.
 310 .It faults
 311 Trap/interrupt rate averages per second over last 5 seconds.
 312 .Pp
 313 .Bl -tag -width indent -compact
 314 .It in
 315 device interrupts per interval (including clock interrupts)
 316 .It sy
 317 system calls per interval
 318 .It cs
 319 cpu context switch rate (switches/interval)
 320 .El
 321 .It cpu
 322 Breakdown of percentage usage of CPU time.
 323 .Pp
 324 .Bl -tag -width indent -compact
 325 .It us
 326 user time for normal and low priority processes
 327 .It sy
 328 system time
 329 .It id
 330 cpu idle
 331 .El
 332 .El
 333 .Sh FILES
 334 .Bl -tag -width /boot/kernel/kernel -compact
 335 .It Pa /boot/kernel/kernel
 336 default kernel namelist
 337 .It Pa /dev/kmem
 338 default memory file
 339 .El
 340 .Sh EXAMPLES
 341 The command:
 342 .Dl vmstat -w 5
 343 will print what the system is doing every five
 344 seconds; this is a good choice of printing interval since this is how often
 345 some of the statistics are sampled in the system.
 346 Others vary every second and running the output for a while will make it
 347 apparent which are recomputed every second.
 348 .Pp
 349 The command:
 350 .Dl vmstat -p da -p cd -w 1
 351 will tell vmstat to select the first two direct access or CDROM devices
 352 and display statistics on those devices, as well as other systems
 353 statistics every second.
 354 .Sh SEE ALSO
 355 .Xr fstat 1 ,
 356 .Xr netstat 1 ,
 357 .Xr nfsstat 1 ,
 358 .Xr ps 1 ,
 359 .Xr systat 1 ,
 360 .Xr libmemstat 3 ,
 361 .Xr gstat 8 ,
 362 .Xr iostat 8 ,
 363 .Xr pstat 8 ,
 364 .Xr sysctl 8 ,
 365 .Xr malloc 9 ,
 366 .Xr uma 9
 367 .Pp
 368 The sections starting with ``Interpreting system activity'' in
 369 .%T "Installing and Operating 4.3BSD" .
 370 .Sh BUGS
 371 The
 372 .Fl c
 373 and
 374 .Fl w
 375 options are only available with the default output.