xref: /freebsd/sys/sys/vmmeter.h (revision aa0a1e58)
1 /*-
2  * Copyright (c) 1982, 1986, 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  * 4. 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  *	@(#)vmmeter.h	8.2 (Berkeley) 7/10/94
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_VMMETER_H_
34 #define _SYS_VMMETER_H_
35 
36 /*
37  * This value is used by ps(1) to change sleep state flag from 'S' to
38  * 'I' and by the sched process to set the alarm clock.
39  */
40 #define	MAXSLP			20
41 
42 /*
43  * System wide statistics counters.
44  * Locking:
45  *      a - locked by atomic operations
46  *      c - constant after initialization
47  *      f - locked by vm_page_queue_free_mtx
48  *      p - locked by being in the PCPU and atomicity respect to interrupts
49  *      q - locked by vm_page_queue_mtx
50  */
51 struct vmmeter {
52 	/*
53 	 * General system activity.
54 	 */
55 	u_int v_swtch;		/* (p) context switches */
56 	u_int v_trap;		/* (p) calls to trap */
57 	u_int v_syscall;	/* (p) calls to syscall() */
58 	u_int v_intr;		/* (p) device interrupts */
59 	u_int v_soft;		/* (p) software interrupts */
60 	/*
61 	 * Virtual memory activity.
62 	 */
63 	u_int v_vm_faults;	/* (p) address memory faults */
64 	u_int v_cow_faults;	/* (p) copy-on-writes faults */
65 	u_int v_cow_optim;	/* (p) optimized copy-on-writes faults */
66 	u_int v_zfod;		/* (p) pages zero filled on demand */
67 	u_int v_ozfod;		/* (p) optimized zero fill pages */
68 	u_int v_swapin;		/* (p) swap pager pageins */
69 	u_int v_swapout;	/* (p) swap pager pageouts */
70 	u_int v_swappgsin;	/* (p) swap pager pages paged in */
71 	u_int v_swappgsout;	/* (p) swap pager pages paged out */
72 	u_int v_vnodein;	/* (p) vnode pager pageins */
73 	u_int v_vnodeout;	/* (p) vnode pager pageouts */
74 	u_int v_vnodepgsin;	/* (p) vnode_pager pages paged in */
75 	u_int v_vnodepgsout;	/* (p) vnode pager pages paged out */
76 	u_int v_intrans;	/* (p) intransit blocking page faults */
77 	u_int v_reactivated;	/* (f) pages reactivated from free list */
78 	u_int v_pdwakeups;	/* (f) times daemon has awaken from sleep */
79 	u_int v_pdpages;	/* (q) pages analyzed by daemon */
80 
81 	u_int v_tcached;	/* (p) total pages cached */
82 	u_int v_dfree;		/* (q) pages freed by daemon */
83 	u_int v_pfree;		/* (p) pages freed by exiting processes */
84 	u_int v_tfree;		/* (p) total pages freed */
85 	/*
86 	 * Distribution of page usages.
87 	 */
88 	u_int v_page_size;	/* (c) page size in bytes */
89 	u_int v_page_count;	/* (c) total number of pages in system */
90 	u_int v_free_reserved;	/* (c) pages reserved for deadlock */
91 	u_int v_free_target;	/* (c) pages desired free */
92 	u_int v_free_min;	/* (c) pages desired free */
93 	u_int v_free_count;	/* (f) pages free */
94 	u_int v_wire_count;	/* (a) pages wired down */
95 	u_int v_active_count;	/* (q) pages active */
96 	u_int v_inactive_target; /* (c) pages desired inactive */
97 	u_int v_inactive_count;	/* (q) pages inactive */
98 	u_int v_cache_count;	/* (f) pages on cache queue */
99 	u_int v_cache_min;	/* (c) min pages desired on cache queue */
100 	u_int v_cache_max;	/* (c) max pages in cached obj */
101 	u_int v_pageout_free_min;   /* (c) min pages reserved for kernel */
102 	u_int v_interrupt_free_min; /* (c) reserved pages for int code */
103 	u_int v_free_severe;	/* (c) severe page depletion point */
104 	/*
105 	 * Fork/vfork/rfork activity.
106 	 */
107 	u_int v_forks;		/* (p) fork() calls */
108 	u_int v_vforks;		/* (p) vfork() calls */
109 	u_int v_rforks;		/* (p) rfork() calls */
110 	u_int v_kthreads;	/* (p) fork() calls by kernel */
111 	u_int v_forkpages;	/* (p) VM pages affected by fork() */
112 	u_int v_vforkpages;	/* (p) VM pages affected by vfork() */
113 	u_int v_rforkpages;	/* (p) VM pages affected by rfork() */
114 	u_int v_kthreadpages;	/* (p) VM pages affected by fork() by kernel */
115 };
116 #ifdef _KERNEL
117 
118 extern struct vmmeter cnt;
119 
120 /*
121  * Return TRUE if we are under our severe low-free-pages threshold
122  *
123  * This routine is typically used at the user<->system interface to determine
124  * whether we need to block in order to avoid a low memory deadlock.
125  */
126 
127 static __inline
128 int
129 vm_page_count_severe(void)
130 {
131     return (cnt.v_free_severe > (cnt.v_free_count + cnt.v_cache_count));
132 }
133 
134 /*
135  * Return TRUE if we are under our minimum low-free-pages threshold.
136  *
137  * This routine is typically used within the system to determine whether
138  * we can execute potentially very expensive code in terms of memory.  It
139  * is also used by the pageout daemon to calculate when to sleep, when
140  * to wake waiters up, and when (after making a pass) to become more
141  * desparate.
142  */
143 
144 static __inline
145 int
146 vm_page_count_min(void)
147 {
148     return (cnt.v_free_min > (cnt.v_free_count + cnt.v_cache_count));
149 }
150 
151 /*
152  * Return TRUE if we have not reached our free page target during
153  * free page recovery operations.
154  */
155 
156 static __inline
157 int
158 vm_page_count_target(void)
159 {
160     return (cnt.v_free_target > (cnt.v_free_count + cnt.v_cache_count));
161 }
162 
163 /*
164  * Return the number of pages we need to free-up or cache
165  * A positive number indicates that we do not have enough free pages.
166  */
167 
168 static __inline
169 int
170 vm_paging_target(void)
171 {
172     return (
173 	(cnt.v_free_target + cnt.v_cache_min) -
174 	(cnt.v_free_count + cnt.v_cache_count)
175     );
176 }
177 
178 /*
179  * Returns TRUE if the pagedaemon needs to be woken up.
180  */
181 
182 static __inline
183 int
184 vm_paging_needed(void)
185 {
186     return (
187 	(cnt.v_free_reserved + cnt.v_cache_min) >
188 	(cnt.v_free_count + cnt.v_cache_count)
189     );
190 }
191 
192 #endif
193 
194 /* systemwide totals computed every five seconds */
195 struct vmtotal {
196 	int16_t	t_rq;		/* length of the run queue */
197 	int16_t	t_dw;		/* jobs in ``disk wait'' (neg priority) */
198 	int16_t	t_pw;		/* jobs in page wait */
199 	int16_t	t_sl;		/* jobs sleeping in core */
200 	int16_t	t_sw;		/* swapped out runnable/short block jobs */
201 	int32_t	t_vm;		/* total virtual memory */
202 	int32_t	t_avm;		/* active virtual memory */
203 	int32_t	t_rm;		/* total real memory in use */
204 	int32_t	t_arm;		/* active real memory */
205 	int32_t	t_vmshr;	/* shared virtual memory */
206 	int32_t	t_avmshr;	/* active shared virtual memory */
207 	int32_t	t_rmshr;	/* shared real memory */
208 	int32_t	t_armshr;	/* active shared real memory */
209 	int32_t	t_free;		/* free memory pages */
210 };
211 
212 #endif
213