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