xref: /freebsd/sys/vm/vm_meter.c (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)vm_meter.c	8.4 (Berkeley) 1/4/94
30  */
31 
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #include "opt_compat.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/proc.h>
43 #include <sys/resource.h>
44 #include <sys/rwlock.h>
45 #include <sys/sx.h>
46 #include <sys/vmmeter.h>
47 #include <sys/smp.h>
48 
49 #include <vm/vm.h>
50 #include <vm/vm_page.h>
51 #include <vm/vm_extern.h>
52 #include <vm/vm_param.h>
53 #include <vm/pmap.h>
54 #include <vm/vm_map.h>
55 #include <vm/vm_object.h>
56 #include <sys/sysctl.h>
57 
58 struct vmmeter vm_cnt;
59 
60 SYSCTL_UINT(_vm, VM_V_FREE_MIN, v_free_min,
61 	CTLFLAG_RW, &vm_cnt.v_free_min, 0, "Minimum low-free-pages threshold");
62 SYSCTL_UINT(_vm, VM_V_FREE_TARGET, v_free_target,
63 	CTLFLAG_RW, &vm_cnt.v_free_target, 0, "Desired free pages");
64 SYSCTL_UINT(_vm, VM_V_FREE_RESERVED, v_free_reserved,
65 	CTLFLAG_RW, &vm_cnt.v_free_reserved, 0, "Pages reserved for deadlock");
66 SYSCTL_UINT(_vm, VM_V_INACTIVE_TARGET, v_inactive_target,
67 	CTLFLAG_RW, &vm_cnt.v_inactive_target, 0, "Pages desired inactive");
68 SYSCTL_UINT(_vm, VM_V_PAGEOUT_FREE_MIN, v_pageout_free_min,
69 	CTLFLAG_RW, &vm_cnt.v_pageout_free_min, 0, "Min pages reserved for kernel");
70 SYSCTL_UINT(_vm, OID_AUTO, v_free_severe,
71 	CTLFLAG_RW, &vm_cnt.v_free_severe, 0, "Severe page depletion point");
72 
73 static int
74 sysctl_vm_loadavg(SYSCTL_HANDLER_ARGS)
75 {
76 
77 #ifdef SCTL_MASK32
78 	u_int32_t la[4];
79 
80 	if (req->flags & SCTL_MASK32) {
81 		la[0] = averunnable.ldavg[0];
82 		la[1] = averunnable.ldavg[1];
83 		la[2] = averunnable.ldavg[2];
84 		la[3] = averunnable.fscale;
85 		return SYSCTL_OUT(req, la, sizeof(la));
86 	} else
87 #endif
88 		return SYSCTL_OUT(req, &averunnable, sizeof(averunnable));
89 }
90 SYSCTL_PROC(_vm, VM_LOADAVG, loadavg, CTLTYPE_STRUCT | CTLFLAG_RD |
91     CTLFLAG_MPSAFE, NULL, 0, sysctl_vm_loadavg, "S,loadavg",
92     "Machine loadaverage history");
93 
94 /*
95  * This function aims to determine if the object is mapped,
96  * specifically, if it is referenced by a vm_map_entry.  Because
97  * objects occasionally acquire transient references that do not
98  * represent a mapping, the method used here is inexact.  However, it
99  * has very low overhead and is good enough for the advisory
100  * vm.vmtotal sysctl.
101  */
102 static bool
103 is_object_active(vm_object_t obj)
104 {
105 
106 	return (obj->ref_count > obj->shadow_count);
107 }
108 
109 static int
110 vmtotal(SYSCTL_HANDLER_ARGS)
111 {
112 	struct vmtotal total;
113 	vm_object_t object;
114 	struct proc *p;
115 	struct thread *td;
116 
117 	bzero(&total, sizeof(total));
118 
119 	/*
120 	 * Calculate process statistics.
121 	 */
122 	sx_slock(&allproc_lock);
123 	FOREACH_PROC_IN_SYSTEM(p) {
124 		if ((p->p_flag & P_SYSTEM) != 0)
125 			continue;
126 		PROC_LOCK(p);
127 		if (p->p_state != PRS_NEW) {
128 			FOREACH_THREAD_IN_PROC(p, td) {
129 				thread_lock(td);
130 				switch (td->td_state) {
131 				case TDS_INHIBITED:
132 					if (TD_IS_SWAPPED(td))
133 						total.t_sw++;
134 					else if (TD_IS_SLEEPING(td)) {
135 						if (td->td_priority <= PZERO)
136 							total.t_dw++;
137 						else
138 							total.t_sl++;
139 						if (td->td_wchan ==
140 						    &vm_cnt.v_free_count)
141 							total.t_pw++;
142 					}
143 					break;
144 				case TDS_CAN_RUN:
145 					total.t_sw++;
146 					break;
147 				case TDS_RUNQ:
148 				case TDS_RUNNING:
149 					total.t_rq++;
150 					break;
151 				default:
152 					break;
153 				}
154 				thread_unlock(td);
155 			}
156 		}
157 		PROC_UNLOCK(p);
158 	}
159 	sx_sunlock(&allproc_lock);
160 	/*
161 	 * Calculate object memory usage statistics.
162 	 */
163 	mtx_lock(&vm_object_list_mtx);
164 	TAILQ_FOREACH(object, &vm_object_list, object_list) {
165 		/*
166 		 * Perform unsynchronized reads on the object.  In
167 		 * this case, the lack of synchronization should not
168 		 * impair the accuracy of the reported statistics.
169 		 */
170 		if ((object->flags & OBJ_FICTITIOUS) != 0) {
171 			/*
172 			 * Devices, like /dev/mem, will badly skew our totals.
173 			 */
174 			continue;
175 		}
176 		if (object->ref_count == 0) {
177 			/*
178 			 * Also skip unreferenced objects, including
179 			 * vnodes representing mounted file systems.
180 			 */
181 			continue;
182 		}
183 		if (object->ref_count == 1 &&
184 		    (object->flags & OBJ_NOSPLIT) != 0) {
185 			/*
186 			 * Also skip otherwise unreferenced swap
187 			 * objects backing tmpfs vnodes, and POSIX or
188 			 * SysV shared memory.
189 			 */
190 			continue;
191 		}
192 		total.t_vm += object->size;
193 		total.t_rm += object->resident_page_count;
194 		if (is_object_active(object)) {
195 			total.t_avm += object->size;
196 			total.t_arm += object->resident_page_count;
197 		}
198 		if (object->shadow_count > 1) {
199 			/* shared object */
200 			total.t_vmshr += object->size;
201 			total.t_rmshr += object->resident_page_count;
202 			if (is_object_active(object)) {
203 				total.t_avmshr += object->size;
204 				total.t_armshr += object->resident_page_count;
205 			}
206 		}
207 	}
208 	mtx_unlock(&vm_object_list_mtx);
209 	total.t_free = vm_cnt.v_free_count;
210 	return (sysctl_handle_opaque(oidp, &total, sizeof(total), req));
211 }
212 
213 /*
214  * vm_meter_cnt() -	accumulate statistics from all cpus and the global cnt
215  *			structure.
216  *
217  *	The vmmeter structure is now per-cpu as well as global.  Those
218  *	statistics which can be kept on a per-cpu basis (to avoid cache
219  *	stalls between cpus) can be moved to the per-cpu vmmeter.  Remaining
220  *	statistics, such as v_free_reserved, are left in the global
221  *	structure.
222  */
223 u_int
224 vm_meter_cnt(size_t offset)
225 {
226 	struct pcpu *pcpu;
227 	u_int count;
228 	int i;
229 
230 	count = *(u_int *)((char *)&vm_cnt + offset);
231 	CPU_FOREACH(i) {
232 		pcpu = pcpu_find(i);
233 		count += *(u_int *)((char *)&pcpu->pc_cnt + offset);
234 	}
235 	return (count);
236 }
237 
238 static int
239 cnt_sysctl(SYSCTL_HANDLER_ARGS)
240 {
241 	u_int count;
242 
243 	count = vm_meter_cnt((char *)arg1 - (char *)&vm_cnt);
244 	return (SYSCTL_OUT(req, &count, sizeof(count)));
245 }
246 
247 SYSCTL_PROC(_vm, VM_TOTAL, vmtotal, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
248     0, sizeof(struct vmtotal), vmtotal, "S,vmtotal",
249     "System virtual memory statistics");
250 SYSCTL_NODE(_vm, OID_AUTO, stats, CTLFLAG_RW, 0, "VM meter stats");
251 static SYSCTL_NODE(_vm_stats, OID_AUTO, sys, CTLFLAG_RW, 0,
252 	"VM meter sys stats");
253 static SYSCTL_NODE(_vm_stats, OID_AUTO, vm, CTLFLAG_RW, 0,
254 	"VM meter vm stats");
255 SYSCTL_NODE(_vm_stats, OID_AUTO, misc, CTLFLAG_RW, 0, "VM meter misc stats");
256 
257 #define	VM_STATS(parent, var, descr) \
258 	SYSCTL_PROC(parent, OID_AUTO, var, \
259 	    CTLTYPE_UINT | CTLFLAG_RD | CTLFLAG_MPSAFE, &vm_cnt.var, 0,	\
260 	    cnt_sysctl, "IU", descr)
261 #define	VM_STATS_VM(var, descr)		VM_STATS(_vm_stats_vm, var, descr)
262 #define	VM_STATS_SYS(var, descr)	VM_STATS(_vm_stats_sys, var, descr)
263 
264 VM_STATS_SYS(v_swtch, "Context switches");
265 VM_STATS_SYS(v_trap, "Traps");
266 VM_STATS_SYS(v_syscall, "System calls");
267 VM_STATS_SYS(v_intr, "Device interrupts");
268 VM_STATS_SYS(v_soft, "Software interrupts");
269 VM_STATS_VM(v_vm_faults, "Address memory faults");
270 VM_STATS_VM(v_io_faults, "Page faults requiring I/O");
271 VM_STATS_VM(v_cow_faults, "Copy-on-write faults");
272 VM_STATS_VM(v_cow_optim, "Optimized COW faults");
273 VM_STATS_VM(v_zfod, "Pages zero-filled on demand");
274 VM_STATS_VM(v_ozfod, "Optimized zero fill pages");
275 VM_STATS_VM(v_swapin, "Swap pager pageins");
276 VM_STATS_VM(v_swapout, "Swap pager pageouts");
277 VM_STATS_VM(v_swappgsin, "Swap pages swapped in");
278 VM_STATS_VM(v_swappgsout, "Swap pages swapped out");
279 VM_STATS_VM(v_vnodein, "Vnode pager pageins");
280 VM_STATS_VM(v_vnodeout, "Vnode pager pageouts");
281 VM_STATS_VM(v_vnodepgsin, "Vnode pages paged in");
282 VM_STATS_VM(v_vnodepgsout, "Vnode pages paged out");
283 VM_STATS_VM(v_intrans, "In transit page faults");
284 VM_STATS_VM(v_reactivated, "Pages reactivated by pagedaemon");
285 VM_STATS_VM(v_pdwakeups, "Pagedaemon wakeups");
286 VM_STATS_VM(v_pdpages, "Pages analyzed by pagedaemon");
287 VM_STATS_VM(v_pdshortfalls, "Page reclamation shortfalls");
288 VM_STATS_VM(v_dfree, "Pages freed by pagedaemon");
289 VM_STATS_VM(v_pfree, "Pages freed by exiting processes");
290 VM_STATS_VM(v_tfree, "Total pages freed");
291 VM_STATS_VM(v_page_size, "Page size in bytes");
292 VM_STATS_VM(v_page_count, "Total number of pages in system");
293 VM_STATS_VM(v_free_reserved, "Pages reserved for deadlock");
294 VM_STATS_VM(v_free_target, "Pages desired free");
295 VM_STATS_VM(v_free_min, "Minimum low-free-pages threshold");
296 VM_STATS_VM(v_free_count, "Free pages");
297 VM_STATS_VM(v_wire_count, "Wired pages");
298 VM_STATS_VM(v_active_count, "Active pages");
299 VM_STATS_VM(v_inactive_target, "Desired inactive pages");
300 VM_STATS_VM(v_inactive_count, "Inactive pages");
301 VM_STATS_VM(v_laundry_count, "Pages eligible for laundering");
302 VM_STATS_VM(v_pageout_free_min, "Min pages reserved for kernel");
303 VM_STATS_VM(v_interrupt_free_min, "Reserved pages for interrupt code");
304 VM_STATS_VM(v_forks, "Number of fork() calls");
305 VM_STATS_VM(v_vforks, "Number of vfork() calls");
306 VM_STATS_VM(v_rforks, "Number of rfork() calls");
307 VM_STATS_VM(v_kthreads, "Number of fork() calls by kernel");
308 VM_STATS_VM(v_forkpages, "VM pages affected by fork()");
309 VM_STATS_VM(v_vforkpages, "VM pages affected by vfork()");
310 VM_STATS_VM(v_rforkpages, "VM pages affected by rfork()");
311 VM_STATS_VM(v_kthreadpages, "VM pages affected by fork() by kernel");
312 
313 #ifdef COMPAT_FREEBSD11
314 /*
315  * Provide compatibility sysctls for the benefit of old utilities which exit
316  * with an error if they cannot be found.
317  */
318 SYSCTL_UINT(_vm_stats_vm, OID_AUTO, v_cache_count, CTLFLAG_RD,
319     SYSCTL_NULL_UINT_PTR, 0, "Dummy for compatibility");
320 SYSCTL_UINT(_vm_stats_vm, OID_AUTO, v_tcached, CTLFLAG_RD,
321     SYSCTL_NULL_UINT_PTR, 0, "Dummy for compatibility");
322 #endif
323