enhanced libproc cgroup/cmdline support, exploited by top
[procps:crrodriguezs-procps.git] / vmstat.8
1 .\"  This page Copyright (C) 1994 Henry Ware <al172@yfn.ysu.edu>
2 .\"  Distributed under the GPL, Copyleft 1994.
3 .TH VMSTAT 8 "2009 Jan 9" "Throatwobbler Ginkgo Labs" "Linux Administrator's Manual"
4 .SH NAME
5 vmstat \- Report virtual memory statistics
6 .SH SYNOPSIS
7 .ft B
8 .B vmstat
9 .RB [ "\-a" ]
10 .RB [ "\-n" ]
11 .RI [ delay " [ " count ]]
12 .br
13 .B vmstat
14 .RB [ "\-f" ]
15 .RB [ "\-s" ]
16 .RB [ "\-m" ]
17 .br
18 .B vmstat
19 .RB [ "\-S unit"]
20 .br
21 .B vmstat
22 .RB [ "\-d"]
23 .br
24 .B vmstat
25 .RB [ "\-D"]
26 .br
27 .B vmstat
28 .RB [ "\-p disk partition"]
29 .br
30 .B vmstat
31 .RB [ "\-V" ]
32 .SH DESCRIPTION
33 \fBvmstat\fP reports information about processes, memory, paging,
34 block IO, traps, disks and cpu activity.
35
36 The first report produced gives averages since the last reboot.  Additional
37 reports give information on a sampling period of length \fIdelay\fP.
38 The process and memory reports are instantaneous in either case.
39
40 .SS Options
41 The \fB\-a\fP switch displays active/inactive memory, given a 2.5.41 kernel or better.
42 .PP
43 The \fB\-f\fP switch displays the number of forks since boot.
44 This includes the fork, vfork, and clone system calls, and is
45 equivalent to the total number of tasks created. Each process
46 is represented by one or more tasks, depending on thread usage.
47 This display does not repeat.
48 .PP
49 The \fB\-m\fP displays slabinfo.
50 .PP
51 The \fB\-n\fP switch causes the header to be displayed only once rather than periodically.
52 .PP
53 The \fB\-s\fP switch displays a table of various event counters
54 and memory statistics. This display does not repeat.
55 .PP
56 .I delay
57 is the delay between updates in seconds.  If no delay is specified,
58 only one report is printed with the average values since boot.
59 .PP
60 .I count
61 is the number of updates.  If no count is specified and delay is
62 defined, \fIcount\fP defaults to infinity.
63 .PP
64 The \fB\-d\fP reports disk statistics (2.5.70 or above required)
65 .PP
66 The \fB-D\fP reports some summary statistics about disk activity.
67 .PP
68 The \fB\-p\fP followed by some partition name for detailed statistics (2.5.70 or above required)
69 .PP
70 The \fB\-S\fP followed by k or K or m or M switches outputs between 1000, 1024, 1000000, or 1048576 bytes
71 .PP
72 The \fB\-V\fP switch results in displaying version information.
73 .PP
74 .SH FIELD DESCRIPTION FOR VM MODE
75 .SS
76 .B "Procs"
77 .nf
78 r: The number of processes waiting for run time.  
79 b: The number of processes in uninterruptible sleep.
80 .fi
81 .PP
82 .SS
83 .B "Memory"
84 .nf
85 swpd: the amount of virtual memory used.
86 free: the amount of idle memory.
87 buff: the amount of memory used as buffers.
88 cache: the amount of memory used as cache.
89 inact: the amount of inactive memory. (\-a option)
90 active: the amount of active memory. (\-a option)
91 .fi
92 .PP
93 .SS
94 .B "Swap"
95 .nf
96 si: Amount of memory swapped in from disk (/s).
97 so: Amount of memory swapped to disk (/s).
98 .fi
99 .PP
100 .SS
101 .B "IO"
102 .nf
103 bi: Blocks received from a block device (blocks/s).
104 bo: Blocks sent to a block device (blocks/s).
105 .fi
106 .PP
107 .SS
108 .B "System"
109 .nf
110 in: The number of interrupts per second, including the clock.
111 cs: The number of context switches per second.
112 .fi
113 .PP
114 .SS
115 .B "CPU "
116 These are percentages of total CPU time.
117 .nf
118 us: Time spent running non\-kernel code. (user time, including nice time)
119 sy: Time spent running kernel code. (system time)
120 id: Time spent idle. Prior to Linux 2.5.41, this includes IO\-wait time.
121 wa: Time spent waiting for IO. Prior to Linux 2.5.41, included in idle.
122 st: Time stolen from a virtual machine. Prior to Linux 2.6.11, unknown.
123 .fi
124 .PP
125 .SH FIELD DESCRIPTION FOR DISK MODE 
126 .SS
127 .B "Reads"
128 .nf
129 total: Total reads completed successfully 
130 merged: grouped reads (resulting in one I/O)
131 sectors: Sectors read successfully
132 ms: milliseconds spent reading
133 .fi
134 .PP
135 .SS
136 .B "Writes"
137 .nf
138 total: Total writes completed successfully
139 merged: grouped writes (resulting in one I/O)
140 sectors: Sectors written successfully
141 ms: milliseconds spent writing
142 .fi
143 .PP
144 .SS
145 .B "IO"
146 .nf
147 cur: I/O in progress
148 s: seconds spent for I/O
149 .fi
150
151 .PP
152 .SH FIELD DESCRIPTION FOR DISK PARTITION MODE
153 .nf
154 reads: Total number of reads issued to this partition
155 read sectors: Total read sectors for partition
156 writes : Total number of writes issued to this partition
157 requested writes: Total number of write requests made for partition
158
159 .fi
160
161 .PP
162 .SH FIELD DESCRIPTION FOR SLAB MODE 
163 .nf
164 cache: Cache name
165 num: Number of currently active objects
166 total: Total number of available objects
167 size: Size of each object
168 pages: Number of pages with at least one active object
169 .fi
170
171 .SH NOTES
172 .B "vmstat "
173 does not require special permissions.
174 .PP
175 These reports are intended to help identify system bottlenecks.  Linux
176 .B "vmstat "
177 does not count itself as a running process.
178 .PP
179 All linux blocks are currently 1024 bytes. Old kernels may report
180 blocks as 512 bytes, 2048 bytes, or 4096 bytes.
181 .PP
182 Since procps 3.1.9, vmstat lets you choose units (k, K, m, M) default is K (1024 bytes) in the default mode
183 .PP
184 vmstat uses slabinfo 1.1    FIXME
185 .SH FILES
186 .ta
187 .nf
188 /proc/meminfo
189 /proc/stat
190 /proc/*/stat
191 .fi
192
193 .SH "SEE ALSO"
194 .BR iostat (1),
195 .BR sar (1),
196 .BR mpstat (1),
197 .BR ps (1),
198 .BR top (1),
199 .BR free (1)
200 .PP
201 .SH BUGS
202 Does not tabulate the block io per device or count the number of system calls.
203 .SH AUTHORS
204 .nf
205 Written by Henry Ware <al172@yfn.ysu.edu>. 
206 Fabian Fr\('ed\('erick <ffrederick@users.sourceforge.net> (diskstat, slab, partitions...)