xref: /freebsd/sys/vm/vm_pagequeue.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
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 
77 struct vm_domain {
78 	struct vm_pagequeue vmd_pagequeues[PQ_COUNT];
79 	struct mtx_padalign vmd_free_mtx;
80 	struct vmem *vmd_kernel_arena;
81 	u_int vmd_domain;		/* Domain number. */
82 	u_int vmd_page_count;
83 	long vmd_segs;			/* bitmask of the segments */
84 
85 	/* Paging control variables, locked by domain_free_mtx. */
86 	u_int vmd_free_count;
87 	boolean_t vmd_oom;
88 	int vmd_oom_seq;
89 	int vmd_last_active_scan;
90 	struct vm_page vmd_laundry_marker;
91 	struct vm_page vmd_marker; /* marker for pagedaemon private use */
92 	struct vm_page vmd_inacthead; /* marker for LRU-defeating insertions */
93 
94 	int vmd_pageout_pages_needed;	/* page daemon waiting for pages? */
95 	int vmd_pageout_deficit;	/* Estimated number of pages deficit */
96 	int vmd_waiters;		/* Pageout waiters. */
97 	bool vmd_pages_needed;	/* Are threads waiting for free pages? */
98 	bool vmd_pageout_wanted;	/* pageout daemon wait channel */
99 	bool vmd_minset;		/* Are we in vm_min_domains? */
100 	bool vmd_severeset;		/* Are we in vm_severe_domains? */
101 	int vmd_inactq_scans;
102 	enum {
103 		VM_LAUNDRY_IDLE = 0,
104 		VM_LAUNDRY_BACKGROUND,
105 		VM_LAUNDRY_SHORTFALL
106 	} vmd_laundry_request;
107 
108 	/* Paging thresholds. */
109 	u_int vmd_background_launder_target;
110 	u_int vmd_free_reserved;	/* (c) pages reserved for deadlock */
111 	u_int vmd_free_target;		/* (c) pages desired free */
112 	u_int vmd_free_min;		/* (c) pages desired free */
113 	u_int vmd_inactive_target;	/* (c) pages desired inactive */
114 	u_int vmd_pageout_free_min;	/* (c) min pages reserved for kernel */
115 	u_int vmd_pageout_wakeup_thresh;/* (c) min pages to wake pagedaemon */
116 	u_int vmd_interrupt_free_min;	/* (c) reserved pages for int code */
117 	u_int vmd_free_severe;		/* (c) severe page depletion point */
118 } __aligned(CACHE_LINE_SIZE);
119 
120 extern struct vm_domain vm_dom[MAXMEMDOM];
121 
122 #define	VM_DOMAIN(n)	(&vm_dom[(n)])
123 
124 #define	vm_pagequeue_assert_locked(pq)	mtx_assert(&(pq)->pq_mutex, MA_OWNED)
125 #define	vm_pagequeue_lock(pq)		mtx_lock(&(pq)->pq_mutex)
126 #define	vm_pagequeue_lockptr(pq)	(&(pq)->pq_mutex)
127 #define	vm_pagequeue_unlock(pq)		mtx_unlock(&(pq)->pq_mutex)
128 
129 #define	vm_domain_free_assert_locked(n)					\
130 	    mtx_assert(vm_domain_free_lockptr((n)), MA_OWNED)
131 #define	vm_domain_free_assert_unlocked(n)				\
132 	    mtx_assert(vm_domain_free_lockptr((n)), MA_NOTOWNED)
133 #define	vm_domain_free_lock(d)						\
134 	    mtx_lock(vm_domain_free_lockptr((d)))
135 #define	vm_domain_free_lockptr(d)					\
136 	    (&(d)->vmd_free_mtx)
137 #define	vm_domain_free_unlock(d)					\
138 	    mtx_unlock(vm_domain_free_lockptr((d)))
139 
140 static __inline void
141 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend)
142 {
143 
144 #ifdef notyet
145 	vm_pagequeue_assert_locked(pq);
146 #endif
147 	pq->pq_cnt += addend;
148 }
149 #define	vm_pagequeue_cnt_inc(pq)	vm_pagequeue_cnt_add((pq), 1)
150 #define	vm_pagequeue_cnt_dec(pq)	vm_pagequeue_cnt_add((pq), -1)
151 
152 void vm_domain_set(struct vm_domain *vmd);
153 int vm_domain_available(struct vm_domain *vmd, int req, int npages);
154 
155 /*
156  *      vm_pagequeue_domain:
157  *
158  *      Return the memory domain the page belongs to.
159  */
160 static inline struct vm_domain *
161 vm_pagequeue_domain(vm_page_t m)
162 {
163 
164 	return (VM_DOMAIN(vm_phys_domain(m)));
165 }
166 
167 /*
168  * Return the number of pages we need to free-up or cache
169  * A positive number indicates that we do not have enough free pages.
170  */
171 static inline int
172 vm_paging_target(struct vm_domain *vmd)
173 {
174 
175 	return (vmd->vmd_free_target - vmd->vmd_free_count);
176 }
177 
178 /*
179  * Returns TRUE if the pagedaemon needs to be woken up.
180  */
181 static inline int
182 vm_paging_needed(struct vm_domain *vmd, u_int free_count)
183 {
184 
185 	return (free_count < vmd->vmd_pageout_wakeup_thresh);
186 }
187 
188 /*
189  * Returns TRUE if the domain is below the min paging target.
190  */
191 static inline int
192 vm_paging_min(struct vm_domain *vmd)
193 {
194 
195         return (vmd->vmd_free_min > vmd->vmd_free_count);
196 }
197 
198 /*
199  * Returns TRUE if the domain is below the severe paging target.
200  */
201 static inline int
202 vm_paging_severe(struct vm_domain *vmd)
203 {
204 
205         return (vmd->vmd_free_severe > vmd->vmd_free_count);
206 }
207 
208 /*
209  * Return the number of pages we need to launder.
210  * A positive number indicates that we have a shortfall of clean pages.
211  */
212 static inline int
213 vm_laundry_target(struct vm_domain *vmd)
214 {
215 
216 	return (vm_paging_target(vmd));
217 }
218 
219 static inline u_int
220 vm_domain_freecnt_adj(struct vm_domain *vmd, int adj)
221 {
222 	u_int ret;
223 
224 	vm_domain_free_assert_locked(vmd);
225 	ret = vmd->vmd_free_count += adj;
226 	if ((!vmd->vmd_minset && vm_paging_min(vmd)) ||
227 	    (!vmd->vmd_severeset && vm_paging_severe(vmd)))
228 		vm_domain_set(vmd);
229 
230 	return (ret);
231 }
232 
233 
234 #endif	/* _KERNEL */
235 #endif				/* !_VM_PAGEQUEUE_ */
236