xref: /freebsd/sys/sys/vmmeter.h (revision d0b2dbfa)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 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. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)vmmeter.h	8.2 (Berkeley) 7/10/94
32  */
33 
34 #ifndef _SYS_VMMETER_H_
35 #define _SYS_VMMETER_H_
36 
37 /*
38  * This value is used by ps(1) to change sleep state flag from 'S' to
39  * 'I' and by the sched process to set the alarm clock.
40  */
41 #define	MAXSLP			20
42 
43 struct vmtotal {
44 	uint64_t	t_vm;		/* total virtual memory */
45 	uint64_t	t_avm;		/* active virtual memory */
46 	uint64_t	t_rm;		/* total real memory in use */
47 	uint64_t	t_arm;		/* active real memory */
48 	uint64_t	t_vmshr;	/* shared virtual memory */
49 	uint64_t	t_avmshr;	/* active shared virtual memory */
50 	uint64_t	t_rmshr;	/* shared real memory */
51 	uint64_t	t_armshr;	/* active shared real memory */
52 	uint64_t	t_free;		/* free memory pages */
53 	int16_t		t_rq;		/* length of the run queue */
54 	int16_t		t_dw;		/* threads in ``disk wait'' (neg
55 					   priority) */
56 	int16_t		t_pw;		/* threads in page wait */
57 	int16_t		t_sl;		/* threads sleeping in core */
58 	int16_t		t_sw;		/* swapped out runnable/short
59 					   block threads */
60 	uint16_t	t_pad[3];
61 };
62 
63 #if defined(_KERNEL) || defined(_WANT_VMMETER)
64 #include <sys/counter.h>
65 
66 #ifdef _KERNEL
67 #define VMMETER_ALIGNED	__aligned(CACHE_LINE_SIZE)
68 #else
69 #define VMMETER_ALIGNED
70 #endif
71 
72 /*
73  * System wide statistics counters.
74  * Locking:
75  *      c - constant after initialization
76  *      p - uses counter(9)
77  */
78 struct vmmeter {
79 	/*
80 	 * General system activity.
81 	 */
82 	counter_u64_t v_swtch;		/* (p) context switches */
83 	counter_u64_t v_trap;		/* (p) calls to trap */
84 	counter_u64_t v_syscall;	/* (p) calls to syscall() */
85 	counter_u64_t v_intr;		/* (p) device interrupts */
86 	counter_u64_t v_soft;		/* (p) software interrupts */
87 	/*
88 	 * Virtual memory activity.
89 	 */
90 	counter_u64_t v_vm_faults;	/* (p) address memory faults */
91 	counter_u64_t v_io_faults;	/* (p) page faults requiring I/O */
92 	counter_u64_t v_cow_faults;	/* (p) copy-on-writes faults */
93 	counter_u64_t v_cow_optim;	/* (p) optimized COW faults */
94 	counter_u64_t v_zfod;		/* (p) pages zero filled on demand */
95 	counter_u64_t v_ozfod;		/* (p) optimized zero fill pages */
96 	counter_u64_t v_swapin;		/* (p) swap pager pageins */
97 	counter_u64_t v_swapout;	/* (p) swap pager pageouts */
98 	counter_u64_t v_swappgsin;	/* (p) swap pager pages paged in */
99 	counter_u64_t v_swappgsout;	/* (p) swap pager pages paged out */
100 	counter_u64_t v_vnodein;	/* (p) vnode pager pageins */
101 	counter_u64_t v_vnodeout;	/* (p) vnode pager pageouts */
102 	counter_u64_t v_vnodepgsin;	/* (p) vnode_pager pages paged in */
103 	counter_u64_t v_vnodepgsout;	/* (p) vnode pager pages paged out */
104 	counter_u64_t v_intrans;	/* (p) intransit blocking page faults */
105 	counter_u64_t v_reactivated;	/* (p) reactivated by the pagedaemon */
106 	counter_u64_t v_pdwakeups;	/* (p) times daemon has awaken */
107 	counter_u64_t v_pdpages;	/* (p) pages analyzed by daemon */
108 	counter_u64_t v_pdshortfalls;	/* (p) page reclamation shortfalls */
109 
110 	counter_u64_t v_dfree;		/* (p) pages freed by daemon */
111 	counter_u64_t v_pfree;		/* (p) pages freed by processes */
112 	counter_u64_t v_tfree;		/* (p) total pages freed */
113 	/*
114 	 * Fork/vfork/rfork activity.
115 	 */
116 	counter_u64_t v_forks;		/* (p) fork() calls */
117 	counter_u64_t v_vforks;		/* (p) vfork() calls */
118 	counter_u64_t v_rforks;		/* (p) rfork() calls */
119 	counter_u64_t v_kthreads;	/* (p) fork() calls by kernel */
120 	counter_u64_t v_forkpages;	/* (p) pages affected by fork() */
121 	counter_u64_t v_vforkpages;	/* (p) pages affected by vfork() */
122 	counter_u64_t v_rforkpages;	/* (p) pages affected by rfork() */
123 	counter_u64_t v_kthreadpages;	/* (p) ... and by kernel fork() */
124 	counter_u64_t v_wire_count;	/* (p) pages wired down */
125 #define	VM_METER_NCOUNTERS	\
126 	(offsetof(struct vmmeter, v_page_size) / sizeof(counter_u64_t))
127 	/*
128 	 * Distribution of page usages.
129 	 */
130 	u_int v_page_size;	/* (c) page size in bytes */
131 	u_int v_page_count;	/* (c) total number of pages in system */
132 	u_int v_free_reserved;	/* (c) pages reserved for deadlock */
133 	u_int v_free_target;	/* (c) pages desired free */
134 	u_int v_free_min;	/* (c) pages desired free */
135 	u_int v_inactive_target; /* (c) pages desired inactive */
136 	u_int v_pageout_free_min;   /* (c) min pages reserved for kernel */
137 	u_int v_interrupt_free_min; /* (c) reserved pages for int code */
138 	u_int v_free_severe;	/* (c) severe page depletion point */
139 };
140 #endif /* _KERNEL || _WANT_VMMETER */
141 
142 #ifdef _KERNEL
143 
144 #include <sys/domainset.h>
145 
146 extern struct vmmeter vm_cnt;
147 extern domainset_t all_domains;
148 extern domainset_t vm_min_domains;
149 extern domainset_t vm_severe_domains;
150 
151 #define	VM_CNT_ADD(var, x)	counter_u64_add(vm_cnt.var, x)
152 #define	VM_CNT_INC(var)		VM_CNT_ADD(var, 1)
153 #define	VM_CNT_FETCH(var)	counter_u64_fetch(vm_cnt.var)
154 
155 extern u_long vm_user_wire_count;
156 
157 static inline void
158 vm_wire_add(int cnt)
159 {
160 
161 	VM_CNT_ADD(v_wire_count, cnt);
162 }
163 
164 static inline void
165 vm_wire_sub(int cnt)
166 {
167 
168 	VM_CNT_ADD(v_wire_count, -cnt);
169 }
170 
171 u_int vm_free_count(void);
172 static inline u_int
173 vm_wire_count(void)
174 {
175 
176 	return (VM_CNT_FETCH(v_wire_count));
177 }
178 
179 /*
180  * Return TRUE if we are under our severe low-free-pages threshold
181  *
182  * These routines are typically used at the user<->system interface to determine
183  * whether we need to block in order to avoid a low memory deadlock.
184  */
185 static inline int
186 vm_page_count_severe(void)
187 {
188 
189 	return (!DOMAINSET_EMPTY(&vm_severe_domains));
190 }
191 
192 static inline int
193 vm_page_count_severe_domain(int domain)
194 {
195 
196 	return (DOMAINSET_ISSET(domain, &vm_severe_domains));
197 }
198 
199 static inline int
200 vm_page_count_severe_set(const domainset_t *mask)
201 {
202 
203 	return (DOMAINSET_SUBSET(&vm_severe_domains, mask));
204 }
205 
206 /*
207  * Return TRUE if we are under our minimum low-free-pages threshold.
208  *
209  * These routines are typically used within the system to determine whether
210  * we can execute potentially very expensive code in terms of memory.  It
211  * is also used by the pageout daemon to calculate when to sleep, when
212  * to wake waiters up, and when (after making a pass) to become more
213  * desperate.
214  */
215 static inline int
216 vm_page_count_min(void)
217 {
218 
219 	return (!DOMAINSET_EMPTY(&vm_min_domains));
220 }
221 
222 static inline int
223 vm_page_count_min_domain(int domain)
224 {
225 
226 	return (DOMAINSET_ISSET(domain, &vm_min_domains));
227 }
228 
229 static inline int
230 vm_page_count_min_set(const domainset_t *mask)
231 {
232 
233 	return (DOMAINSET_SUBSET(&vm_min_domains, mask));
234 }
235 
236 #endif	/* _KERNEL */
237 #endif	/* _SYS_VMMETER_H_ */
238