xref: /freebsd/sys/vm/vm_pagequeue.h (revision 74ca7bf1d4c7173d5575ba168bc4b5f6d181ff5a)
1 /*-
2  * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
3  *
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * The Mach Operating System project at Carnegie-Mellon University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	from: @(#)vm_page.h	8.2 (Berkeley) 12/13/93
35  *
36  *
37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38  * All rights reserved.
39  *
40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
41  *
42  * Permission to use, copy, modify and distribute this software and
43  * its documentation is hereby granted, provided that both the copyright
44  * notice and this permission notice appear in all copies of the
45  * software, derivative works or modified versions, and any portions
46  * thereof, and that both notices appear in supporting documentation.
47  *
48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
51  *
52  * Carnegie Mellon requests users of this software to return to
53  *
54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
55  *  School of Computer Science
56  *  Carnegie Mellon University
57  *  Pittsburgh PA 15213-3890
58  *
59  * any improvements or extensions that they make and grant Carnegie the
60  * rights to redistribute these changes.
61  *
62  * $FreeBSD$
63  */
64 
65 #ifndef	_VM_PAGEQUEUE_
66 #define	_VM_PAGEQUEUE_
67 
68 #ifdef _KERNEL
69 struct vm_pagequeue {
70 	struct mtx	pq_mutex;
71 	struct pglist	pq_pl;
72 	int		pq_cnt;
73 	const char	* const pq_name;
74 } __aligned(CACHE_LINE_SIZE);
75 
76 #include <sys/pidctrl.h>
77 #include <vm/uma.h>
78 struct sysctl_oid;
79 
80 /*
81  * One vm_domain per-numa domain.  Contains pagequeues, free page structures,
82  * and accounting.
83  *
84  * Lock Key:
85  * f   vmd_free_mtx
86  * p   vmd_pageout_mtx
87  * d   vm_domainset_lock
88  * a   atomic
89  * c   const after boot
90  * q   page queue lock
91 */
92 struct vm_domain {
93 	struct vm_pagequeue vmd_pagequeues[PQ_COUNT];
94 	struct mtx_padalign vmd_free_mtx;
95 	struct mtx_padalign vmd_pageout_mtx;
96 	uma_zone_t vmd_pgcache;		/* (c) page free cache. */
97 	struct vmem *vmd_kernel_arena;	/* (c) per-domain kva arena. */
98 	u_int vmd_domain;		/* (c) Domain number. */
99 	u_int vmd_page_count;		/* (c) Total page count. */
100 	long vmd_segs;			/* (c) bitmask of the segments */
101 	u_int __aligned(CACHE_LINE_SIZE) vmd_free_count; /* (a,f) free page count */
102 	u_int vmd_pageout_deficit;	/* (a) Estimated number of pages deficit */
103 	uint8_t vmd_pad[CACHE_LINE_SIZE - (sizeof(u_int) * 2)];
104 
105 	/* Paging control variables, used within single threaded page daemon. */
106 	struct pidctrl vmd_pid;		/* Pageout controller. */
107 	boolean_t vmd_oom;
108 	int vmd_oom_seq;
109 	int vmd_last_active_scan;
110 	struct vm_page vmd_laundry_marker;
111 	struct vm_page vmd_marker; /* marker for pagedaemon private use */
112 	struct vm_page vmd_inacthead; /* marker for LRU-defeating insertions */
113 
114 	int vmd_pageout_wanted;		/* (a, p) pageout daemon wait channel */
115 	int vmd_pageout_pages_needed;	/* (d) page daemon waiting for pages? */
116 	bool vmd_minset;		/* (d) Are we in vm_min_domains? */
117 	bool vmd_severeset;		/* (d) Are we in vm_severe_domains? */
118 	enum {
119 		VM_LAUNDRY_IDLE = 0,
120 		VM_LAUNDRY_BACKGROUND,
121 		VM_LAUNDRY_SHORTFALL
122 	} vmd_laundry_request;
123 
124 	/* Paging thresholds and targets. */
125 	u_int vmd_clean_pages_freed;	/* (q) accumulator for laundry thread */
126 	u_int vmd_background_launder_target; /* (c) */
127 	u_int vmd_free_reserved;	/* (c) pages reserved for deadlock */
128 	u_int vmd_free_target;		/* (c) pages desired free */
129 	u_int vmd_free_min;		/* (c) pages desired free */
130 	u_int vmd_inactive_target;	/* (c) pages desired inactive */
131 	u_int vmd_pageout_free_min;	/* (c) min pages reserved for kernel */
132 	u_int vmd_pageout_wakeup_thresh;/* (c) min pages to wake pagedaemon */
133 	u_int vmd_interrupt_free_min;	/* (c) reserved pages for int code */
134 	u_int vmd_free_severe;		/* (c) severe page depletion point */
135 
136 	/* Name for sysctl etc. */
137 	struct sysctl_oid *vmd_oid;
138 	char vmd_name[sizeof(__XSTRING(MAXMEMDOM))];
139 } __aligned(CACHE_LINE_SIZE);
140 
141 extern struct vm_domain vm_dom[MAXMEMDOM];
142 
143 #define	VM_DOMAIN(n)	(&vm_dom[(n)])
144 
145 #define	vm_pagequeue_assert_locked(pq)	mtx_assert(&(pq)->pq_mutex, MA_OWNED)
146 #define	vm_pagequeue_lock(pq)		mtx_lock(&(pq)->pq_mutex)
147 #define	vm_pagequeue_lockptr(pq)	(&(pq)->pq_mutex)
148 #define	vm_pagequeue_unlock(pq)		mtx_unlock(&(pq)->pq_mutex)
149 
150 #define	vm_domain_free_assert_locked(n)					\
151 	    mtx_assert(vm_domain_free_lockptr((n)), MA_OWNED)
152 #define	vm_domain_free_assert_unlocked(n)				\
153 	    mtx_assert(vm_domain_free_lockptr((n)), MA_NOTOWNED)
154 #define	vm_domain_free_lock(d)						\
155 	    mtx_lock(vm_domain_free_lockptr((d)))
156 #define	vm_domain_free_lockptr(d)					\
157 	    (&(d)->vmd_free_mtx)
158 #define	vm_domain_free_unlock(d)					\
159 	    mtx_unlock(vm_domain_free_lockptr((d)))
160 
161 #define	vm_domain_pageout_lockptr(d)					\
162 	    (&(d)->vmd_pageout_mtx)
163 #define	vm_domain_pageout_assert_locked(n)				\
164 	    mtx_assert(vm_domain_pageout_lockptr((n)), MA_OWNED)
165 #define	vm_domain_pageout_assert_unlocked(n)				\
166 	    mtx_assert(vm_domain_pageout_lockptr((n)), MA_NOTOWNED)
167 #define	vm_domain_pageout_lock(d)					\
168 	    mtx_lock(vm_domain_pageout_lockptr((d)))
169 #define	vm_domain_pageout_unlock(d)					\
170 	    mtx_unlock(vm_domain_pageout_lockptr((d)))
171 
172 static __inline void
173 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend)
174 {
175 
176 #ifdef notyet
177 	vm_pagequeue_assert_locked(pq);
178 #endif
179 	pq->pq_cnt += addend;
180 }
181 #define	vm_pagequeue_cnt_inc(pq)	vm_pagequeue_cnt_add((pq), 1)
182 #define	vm_pagequeue_cnt_dec(pq)	vm_pagequeue_cnt_add((pq), -1)
183 
184 void vm_domain_set(struct vm_domain *vmd);
185 void vm_domain_clear(struct vm_domain *vmd);
186 int vm_domain_allocate(struct vm_domain *vmd, int req, int npages);
187 
188 /*
189  *      vm_pagequeue_domain:
190  *
191  *      Return the memory domain the page belongs to.
192  */
193 static inline struct vm_domain *
194 vm_pagequeue_domain(vm_page_t m)
195 {
196 
197 	return (VM_DOMAIN(vm_phys_domain(m)));
198 }
199 
200 /*
201  * Return the number of pages we need to free-up or cache
202  * A positive number indicates that we do not have enough free pages.
203  */
204 static inline int
205 vm_paging_target(struct vm_domain *vmd)
206 {
207 
208 	return (vmd->vmd_free_target - vmd->vmd_free_count);
209 }
210 
211 /*
212  * Returns TRUE if the pagedaemon needs to be woken up.
213  */
214 static inline int
215 vm_paging_needed(struct vm_domain *vmd, u_int free_count)
216 {
217 
218 	return (free_count < vmd->vmd_pageout_wakeup_thresh);
219 }
220 
221 /*
222  * Returns TRUE if the domain is below the min paging target.
223  */
224 static inline int
225 vm_paging_min(struct vm_domain *vmd)
226 {
227 
228         return (vmd->vmd_free_min > vmd->vmd_free_count);
229 }
230 
231 /*
232  * Returns TRUE if the domain is below the severe paging target.
233  */
234 static inline int
235 vm_paging_severe(struct vm_domain *vmd)
236 {
237 
238         return (vmd->vmd_free_severe > vmd->vmd_free_count);
239 }
240 
241 /*
242  * Return the number of pages we need to launder.
243  * A positive number indicates that we have a shortfall of clean pages.
244  */
245 static inline int
246 vm_laundry_target(struct vm_domain *vmd)
247 {
248 
249 	return (vm_paging_target(vmd));
250 }
251 
252 void pagedaemon_wakeup(int domain);
253 
254 static inline void
255 vm_domain_freecnt_inc(struct vm_domain *vmd, int adj)
256 {
257 	u_int old, new;
258 
259 	old = atomic_fetchadd_int(&vmd->vmd_free_count, adj);
260 	new = old + adj;
261 	/*
262 	 * Only update bitsets on transitions.  Notice we short-circuit the
263 	 * rest of the checks if we're above min already.
264 	 */
265 	if (old < vmd->vmd_free_min && (new >= vmd->vmd_free_min ||
266 	    (old < vmd->vmd_free_severe && new >= vmd->vmd_free_severe) ||
267 	    (old < vmd->vmd_pageout_free_min &&
268 	    new >= vmd->vmd_pageout_free_min)))
269 		vm_domain_clear(vmd);
270 }
271 
272 #endif	/* _KERNEL */
273 #endif				/* !_VM_PAGEQUEUE_ */
274