xref: /freebsd/sys/vm/vm_pagequeue.h (revision b79f74cc64d83c03851fd418f9437e653642607f)
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 #ifndef VM_BATCHQUEUE_SIZE
77 #define	VM_BATCHQUEUE_SIZE	7
78 #endif
79 
80 struct vm_batchqueue {
81 	vm_page_t	bq_pa[VM_BATCHQUEUE_SIZE];
82 	int		bq_cnt;
83 } __aligned(CACHE_LINE_SIZE);
84 
85 #include <vm/uma.h>
86 #include <sys/pidctrl.h>
87 struct sysctl_oid;
88 
89 /*
90  * One vm_domain per-numa domain.  Contains pagequeues, free page structures,
91  * and accounting.
92  *
93  * Lock Key:
94  * f	vmd_free_mtx
95  * p	vmd_pageout_mtx
96  * d	vm_domainset_lock
97  * a	atomic
98  * c	const after boot
99  * q	page queue lock
100 */
101 struct vm_domain {
102 	struct vm_pagequeue vmd_pagequeues[PQ_COUNT];
103 	struct mtx_padalign vmd_free_mtx;
104 	struct mtx_padalign vmd_pageout_mtx;
105 	uma_zone_t vmd_pgcache;		/* (c) page free cache. */
106 	struct vmem *vmd_kernel_arena;	/* (c) per-domain kva arena. */
107 	u_int vmd_domain;		/* (c) Domain number. */
108 	u_int vmd_page_count;		/* (c) Total page count. */
109 	long vmd_segs;			/* (c) bitmask of the segments */
110 	u_int __aligned(CACHE_LINE_SIZE) vmd_free_count; /* (a,f) free page count */
111 	u_int vmd_pageout_deficit;	/* (a) Estimated number of pages deficit */
112 	uint8_t vmd_pad[CACHE_LINE_SIZE - (sizeof(u_int) * 2)];
113 
114 	/* Paging control variables, used within single threaded page daemon. */
115 	struct pidctrl vmd_pid;		/* Pageout controller. */
116 	boolean_t vmd_oom;
117 	int vmd_oom_seq;
118 	int vmd_last_active_scan;
119 	struct vm_page vmd_markers[PQ_COUNT]; /* (q) markers for queue scans */
120 	struct vm_page vmd_inacthead; /* marker for LRU-defeating insertions */
121 	struct vm_page vmd_clock[2]; /* markers for active queue scan */
122 
123 	int vmd_pageout_wanted;		/* (a, p) pageout daemon wait channel */
124 	int vmd_pageout_pages_needed;	/* (d) page daemon waiting for pages? */
125 	bool vmd_minset;		/* (d) Are we in vm_min_domains? */
126 	bool vmd_severeset;		/* (d) Are we in vm_severe_domains? */
127 	enum {
128 		VM_LAUNDRY_IDLE = 0,
129 		VM_LAUNDRY_BACKGROUND,
130 		VM_LAUNDRY_SHORTFALL
131 	} vmd_laundry_request;
132 
133 	/* Paging thresholds and targets. */
134 	u_int vmd_clean_pages_freed;	/* (q) accumulator for laundry thread */
135 	u_int vmd_background_launder_target; /* (c) */
136 	u_int vmd_free_reserved;	/* (c) pages reserved for deadlock */
137 	u_int vmd_free_target;		/* (c) pages desired free */
138 	u_int vmd_free_min;		/* (c) pages desired free */
139 	u_int vmd_inactive_target;	/* (c) pages desired inactive */
140 	u_int vmd_pageout_free_min;	/* (c) min pages reserved for kernel */
141 	u_int vmd_pageout_wakeup_thresh;/* (c) min pages to wake pagedaemon */
142 	u_int vmd_interrupt_free_min;	/* (c) reserved pages for int code */
143 	u_int vmd_free_severe;		/* (c) severe page depletion point */
144 
145 	/* Name for sysctl etc. */
146 	struct sysctl_oid *vmd_oid;
147 	char vmd_name[sizeof(__XSTRING(MAXMEMDOM))];
148 } __aligned(CACHE_LINE_SIZE);
149 
150 extern struct vm_domain vm_dom[MAXMEMDOM];
151 
152 #define	VM_DOMAIN(n)	(&vm_dom[(n)])
153 
154 #define	vm_pagequeue_assert_locked(pq)	mtx_assert(&(pq)->pq_mutex, MA_OWNED)
155 #define	vm_pagequeue_lock(pq)		mtx_lock(&(pq)->pq_mutex)
156 #define	vm_pagequeue_lockptr(pq)	(&(pq)->pq_mutex)
157 #define	vm_pagequeue_trylock(pq)	mtx_trylock(&(pq)->pq_mutex)
158 #define	vm_pagequeue_unlock(pq)		mtx_unlock(&(pq)->pq_mutex)
159 
160 #define	vm_domain_free_assert_locked(n)					\
161 	    mtx_assert(vm_domain_free_lockptr((n)), MA_OWNED)
162 #define	vm_domain_free_assert_unlocked(n)				\
163 	    mtx_assert(vm_domain_free_lockptr((n)), MA_NOTOWNED)
164 #define	vm_domain_free_lock(d)						\
165 	    mtx_lock(vm_domain_free_lockptr((d)))
166 #define	vm_domain_free_lockptr(d)					\
167 	    (&(d)->vmd_free_mtx)
168 #define	vm_domain_free_trylock(d)					\
169 	    mtx_trylock(vm_domain_free_lockptr((d)))
170 #define	vm_domain_free_unlock(d)					\
171 	    mtx_unlock(vm_domain_free_lockptr((d)))
172 
173 #define	vm_domain_pageout_lockptr(d)					\
174 	    (&(d)->vmd_pageout_mtx)
175 #define	vm_domain_pageout_assert_locked(n)				\
176 	    mtx_assert(vm_domain_pageout_lockptr((n)), MA_OWNED)
177 #define	vm_domain_pageout_assert_unlocked(n)				\
178 	    mtx_assert(vm_domain_pageout_lockptr((n)), MA_NOTOWNED)
179 #define	vm_domain_pageout_lock(d)					\
180 	    mtx_lock(vm_domain_pageout_lockptr((d)))
181 #define	vm_domain_pageout_unlock(d)					\
182 	    mtx_unlock(vm_domain_pageout_lockptr((d)))
183 
184 static __inline void
185 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend)
186 {
187 
188 	vm_pagequeue_assert_locked(pq);
189 	pq->pq_cnt += addend;
190 }
191 #define	vm_pagequeue_cnt_inc(pq)	vm_pagequeue_cnt_add((pq), 1)
192 #define	vm_pagequeue_cnt_dec(pq)	vm_pagequeue_cnt_add((pq), -1)
193 
194 static inline void
195 vm_batchqueue_init(struct vm_batchqueue *bq)
196 {
197 
198 	bq->bq_cnt = 0;
199 }
200 
201 static inline bool
202 vm_batchqueue_insert(struct vm_batchqueue *bq, vm_page_t m)
203 {
204 
205 	if (bq->bq_cnt < nitems(bq->bq_pa)) {
206 		bq->bq_pa[bq->bq_cnt++] = m;
207 		return (true);
208 	}
209 	return (false);
210 }
211 
212 static inline vm_page_t
213 vm_batchqueue_pop(struct vm_batchqueue *bq)
214 {
215 
216 	if (bq->bq_cnt == 0)
217 		return (NULL);
218 	return (bq->bq_pa[--bq->bq_cnt]);
219 }
220 
221 void vm_domain_set(struct vm_domain *vmd);
222 void vm_domain_clear(struct vm_domain *vmd);
223 int vm_domain_allocate(struct vm_domain *vmd, int req, int npages);
224 
225 /*
226  *      vm_pagequeue_domain:
227  *
228  *      Return the memory domain the page belongs to.
229  */
230 static inline struct vm_domain *
231 vm_pagequeue_domain(vm_page_t m)
232 {
233 
234 	return (VM_DOMAIN(vm_phys_domain(m)));
235 }
236 
237 /*
238  * Return the number of pages we need to free-up or cache
239  * A positive number indicates that we do not have enough free pages.
240  */
241 static inline int
242 vm_paging_target(struct vm_domain *vmd)
243 {
244 
245 	return (vmd->vmd_free_target - vmd->vmd_free_count);
246 }
247 
248 /*
249  * Returns TRUE if the pagedaemon needs to be woken up.
250  */
251 static inline int
252 vm_paging_needed(struct vm_domain *vmd, u_int free_count)
253 {
254 
255 	return (free_count < vmd->vmd_pageout_wakeup_thresh);
256 }
257 
258 /*
259  * Returns TRUE if the domain is below the min paging target.
260  */
261 static inline int
262 vm_paging_min(struct vm_domain *vmd)
263 {
264 
265         return (vmd->vmd_free_min > vmd->vmd_free_count);
266 }
267 
268 /*
269  * Returns TRUE if the domain is below the severe paging target.
270  */
271 static inline int
272 vm_paging_severe(struct vm_domain *vmd)
273 {
274 
275         return (vmd->vmd_free_severe > vmd->vmd_free_count);
276 }
277 
278 /*
279  * Return the number of pages we need to launder.
280  * A positive number indicates that we have a shortfall of clean pages.
281  */
282 static inline int
283 vm_laundry_target(struct vm_domain *vmd)
284 {
285 
286 	return (vm_paging_target(vmd));
287 }
288 
289 void pagedaemon_wakeup(int domain);
290 
291 static inline void
292 vm_domain_freecnt_inc(struct vm_domain *vmd, int adj)
293 {
294 	u_int old, new;
295 
296 	old = atomic_fetchadd_int(&vmd->vmd_free_count, adj);
297 	new = old + adj;
298 	/*
299 	 * Only update bitsets on transitions.  Notice we short-circuit the
300 	 * rest of the checks if we're above min already.
301 	 */
302 	if (old < vmd->vmd_free_min && (new >= vmd->vmd_free_min ||
303 	    (old < vmd->vmd_free_severe && new >= vmd->vmd_free_severe) ||
304 	    (old < vmd->vmd_pageout_free_min &&
305 	    new >= vmd->vmd_pageout_free_min)))
306 		vm_domain_clear(vmd);
307 }
308 
309 #endif	/* _KERNEL */
310 #endif				/* !_VM_PAGEQUEUE_ */
311