Annotation of src/usr.bin/vmstat/vmstat.8, Revision 1.24
1.24 ! deraadt 1: .\" $OpenBSD: vmstat.8,v 1.23 2002/02/01 14:34:03 art Exp $
1.3 deraadt 2: .\" $NetBSD: vmstat.8,v 1.12 1996/05/10 23:19:30 thorpej Exp $
1.1 deraadt 3: .\"
4: .\" Copyright (c) 1986, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)vmstat.8 8.1 (Berkeley) 6/6/93
36: .\"
1.8 deraadt 37: .Dd June 6, 1993
38: .Dt VMSTAT 8
39: .Os
40: .Sh NAME
41: .Nm vmstat
1.24 ! deraadt 42: .Nd report statistics about kernel activities
1.8 deraadt 43: .Sh SYNOPSIS
44: .Nm vmstat
1.23 art 45: .Op Fl fimstv
1.8 deraadt 46: .Nm vmstat
47: .Op Fl c Ar count
1.9 janjaap 48: .Op Fl M Ar core
1.8 deraadt 49: .Op Fl N Ar system
50: .Op Fl w Ar wait
51: .Op disks
52: .Sh DESCRIPTION
1.15 aaron 53: .Nm
1.1 deraadt 54: reports certain kernel statistics kept about process, virtual memory,
1.15 aaron 55: disk, trap and CPU activity.
1.8 deraadt 56: .Pp
1.1 deraadt 57: The options are as follows:
1.17 aaron 58: .Bl -tag -width Ds
1.8 deraadt 59: .It Fl c Ar count
1.1 deraadt 60: Repeat the display
1.8 deraadt 61: .Ar count
1.1 deraadt 62: times.
63: The first display is for the time since a reboot and each subsequent report
64: is for the time period since the last display.
65: If no
1.8 deraadt 66: .Ar wait
1.1 deraadt 67: interval is specified, the default is 1 second.
1.8 deraadt 68: .It Fl f
1.1 deraadt 69: Report on the number
1.8 deraadt 70: .Xr fork 2 ,
71: .Xr vfork 2 ,
1.21 angelos 72: .Xr rfork 2
1.16 niklas 73: system calls as well as kernel thread creations since system startup,
74: and the number of pages of virtual memory involved in each.
1.8 deraadt 75: .It Fl i
1.1 deraadt 76: Report on the number of interrupts taken by each device since system
77: startup.
1.8 deraadt 78: .It Fl M Ar core
1.13 aaron 79: Extract values associated with the name list from the specified core
1.22 miod 80: instead of the running kernel.
1.8 deraadt 81: .It Fl N Ar system
1.22 miod 82: Extract the name list from the specified system instead of the running kernel.
1.8 deraadt 83: .It Fl m
1.1 deraadt 84: Report on the usage of kernel dynamic memory listed first by size of
85: allocation and then by type of usage.
1.8 deraadt 86: .It Fl s
1.1 deraadt 87: Display the contents of the
1.8 deraadt 88: .Ar sum
1.1 deraadt 89: structure, giving the total number of several kinds of paging related
90: events which have occurred since system startup.
1.8 deraadt 91: .It Fl t
1.1 deraadt 92: Report on the number of page in and page reclaims since system startup,
93: and the amount of time required by each.
1.8 deraadt 94: .It Fl w Ar wait
1.1 deraadt 95: Pause
1.8 deraadt 96: .Ar wait
1.1 deraadt 97: seconds between each display.
98: If no repeat
1.8 deraadt 99: .Ar count
1.1 deraadt 100: is specified, the default is infinity.
1.23 art 101: .It Fl v
102: Print more verbose information.
1.8 deraadt 103: .El
104: .Pp
1.1 deraadt 105: By default,
1.15 aaron 106: .Nm
1.8 deraadt 107: displays the following information just once:
108: .Bl -tag -width "whatever"
109: .It procs
1.1 deraadt 110: Information about the numbers of processes in various states.
1.8 deraadt 111: .Pp
112: .Bl -inset -width xxxxxx -compact
113: .It Ar r
114: in run queue
115: .It Ar b
116: blocked for resources (i/o, paging, etc.)
117: .It Ar w
118: runnable or short sleeper (< 20 secs) but swapped
119: .El
120: .Pp
121: .It Ar memory
1.15 aaron 122: Information about the usage of virtual and real memory.
123: Virtual pages
1.8 deraadt 124: (reported in units of 1024 bytes) are considered active if they belong
125: to processes which are running or have run in the last 20 seconds.
126: .Pp
127: .Bl -inset -width xxxxxx -compact
128: .It Ar avm
129: active virtual pages
130: .It Ar fre
131: size of the free list
132: .El
133: .Pp
134: .It Ar page
1.1 deraadt 135: Information about page faults and paging activity.
136: These are averaged each five seconds, and given in units per second.
1.8 deraadt 137: .Pp
138: .Bl -inset -width xxxxxx -compact
139: .It Ar re
140: page reclaims (simulating reference bits)
141: .It Ar at
142: pages attached (found in free list)
143: .It Ar pi
144: pages paged in
145: .It Ar po
146: pages paged out
147: .It Ar fr
148: pages freed per second
149: .It Ar de
150: anticipated short term memory shortfall
151: .It Ar sr
152: pages scanned by clock algorithm, per-second
153: .El
154: .Pp
155: .It Ar disks
1.2 tholo 156: Disk transfers per second.
1.1 deraadt 157: Typically paging will be split across the available drives.
158: The header of the field is the first character of the disk name and
159: the unit number.
160: If more than four disk drives are configured in the system,
1.15 aaron 161: .Nm
1.1 deraadt 162: displays only the first four drives.
163: To force
1.15 aaron 164: .Nm
1.1 deraadt 165: to display specific drives, their names may be supplied on the command line.
1.8 deraadt 166: .Pp
167: .It Ar faults
1.1 deraadt 168: Trap/interrupt rate averages per second over last 5 seconds.
1.8 deraadt 169: .Pp
170: .Bl -inset -width xxxxxx -compact
171: .It Ar in
172: device interrupts per interval (including clock interrupts)
173: .It Ar sy
174: system calls per interval
175: .It Ar cs
1.15 aaron 176: CPU context switch rate (switches/interval)
1.8 deraadt 177: .El
178: .Pp
179: .It Ar cpu
1.1 deraadt 180: Breakdown of percentage usage of CPU time.
1.8 deraadt 181: .Pp
182: .Bl -inset -width xxxxxx -compact
183: .It Ar us
184: user time for normal and low priority processes
185: .It Ar sy
186: system time
187: .It Ar id
1.15 aaron 188: CPU idle
1.8 deraadt 189: .El
190: .El
191: .Sh EXAMPLES
1.15 aaron 192: The command
193: .Ic vmstat -w 5
194: will print what the system is doing every five
1.1 deraadt 195: seconds; this is a good choice of printing interval since this is how often
196: some of the statistics are sampled in the system.
197: Others vary every second and running the output for a while will make it
198: apparent which are recomputed every second.
1.8 deraadt 199: .Sh SEE ALSO
200: .Xr fstat 1 ,
201: .Xr netstat 1 ,
202: .Xr nfsstat 1 ,
203: .Xr ps 1 ,
204: .Xr systat 1 ,
205: .Xr iostat 8 ,
206: .Xr pstat 8
1.14 aaron 207: .Pp
1.15 aaron 208: The sections starting with
209: .Dq Interpreting system activity
210: in
1.10 pjanzen 211: .%T "Installing and Operating 4.3BSD" .
1.8 deraadt 212: .Sh BUGS
213: The
214: .Fl c
215: and
216: .Fl w
217: options are only available with the default output.
218: .Pp
219: This manual page lacks an incredible amount of detail.