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_markers[PQ_COUNT]; /* markers for queue scans */ 111 struct vm_page vmd_inacthead; /* marker for LRU-defeating insertions */ 112 113 int vmd_pageout_wanted; /* (a, p) pageout daemon wait channel */ 114 int vmd_pageout_pages_needed; /* (d) page daemon waiting for pages? */ 115 bool vmd_minset; /* (d) Are we in vm_min_domains? */ 116 bool vmd_severeset; /* (d) Are we in vm_severe_domains? */ 117 enum { 118 VM_LAUNDRY_IDLE = 0, 119 VM_LAUNDRY_BACKGROUND, 120 VM_LAUNDRY_SHORTFALL 121 } vmd_laundry_request; 122 123 /* Paging thresholds and targets. */ 124 u_int vmd_clean_pages_freed; /* (q) accumulator for laundry thread */ 125 u_int vmd_background_launder_target; /* (c) */ 126 u_int vmd_free_reserved; /* (c) pages reserved for deadlock */ 127 u_int vmd_free_target; /* (c) pages desired free */ 128 u_int vmd_free_min; /* (c) pages desired free */ 129 u_int vmd_inactive_target; /* (c) pages desired inactive */ 130 u_int vmd_pageout_free_min; /* (c) min pages reserved for kernel */ 131 u_int vmd_pageout_wakeup_thresh;/* (c) min pages to wake pagedaemon */ 132 u_int vmd_interrupt_free_min; /* (c) reserved pages for int code */ 133 u_int vmd_free_severe; /* (c) severe page depletion point */ 134 135 /* Name for sysctl etc. */ 136 struct sysctl_oid *vmd_oid; 137 char vmd_name[sizeof(__XSTRING(MAXMEMDOM))]; 138 } __aligned(CACHE_LINE_SIZE); 139 140 extern struct vm_domain vm_dom[MAXMEMDOM]; 141 142 #define VM_DOMAIN(n) (&vm_dom[(n)]) 143 144 #define vm_pagequeue_assert_locked(pq) mtx_assert(&(pq)->pq_mutex, MA_OWNED) 145 #define vm_pagequeue_lock(pq) mtx_lock(&(pq)->pq_mutex) 146 #define vm_pagequeue_lockptr(pq) (&(pq)->pq_mutex) 147 #define vm_pagequeue_unlock(pq) mtx_unlock(&(pq)->pq_mutex) 148 149 #define vm_domain_free_assert_locked(n) \ 150 mtx_assert(vm_domain_free_lockptr((n)), MA_OWNED) 151 #define vm_domain_free_assert_unlocked(n) \ 152 mtx_assert(vm_domain_free_lockptr((n)), MA_NOTOWNED) 153 #define vm_domain_free_lock(d) \ 154 mtx_lock(vm_domain_free_lockptr((d))) 155 #define vm_domain_free_lockptr(d) \ 156 (&(d)->vmd_free_mtx) 157 #define vm_domain_free_unlock(d) \ 158 mtx_unlock(vm_domain_free_lockptr((d))) 159 160 #define vm_domain_pageout_lockptr(d) \ 161 (&(d)->vmd_pageout_mtx) 162 #define vm_domain_pageout_assert_locked(n) \ 163 mtx_assert(vm_domain_pageout_lockptr((n)), MA_OWNED) 164 #define vm_domain_pageout_assert_unlocked(n) \ 165 mtx_assert(vm_domain_pageout_lockptr((n)), MA_NOTOWNED) 166 #define vm_domain_pageout_lock(d) \ 167 mtx_lock(vm_domain_pageout_lockptr((d))) 168 #define vm_domain_pageout_unlock(d) \ 169 mtx_unlock(vm_domain_pageout_lockptr((d))) 170 171 static __inline void 172 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend) 173 { 174 175 #ifdef notyet 176 vm_pagequeue_assert_locked(pq); 177 #endif 178 pq->pq_cnt += addend; 179 } 180 #define vm_pagequeue_cnt_inc(pq) vm_pagequeue_cnt_add((pq), 1) 181 #define vm_pagequeue_cnt_dec(pq) vm_pagequeue_cnt_add((pq), -1) 182 183 void vm_domain_set(struct vm_domain *vmd); 184 void vm_domain_clear(struct vm_domain *vmd); 185 int vm_domain_allocate(struct vm_domain *vmd, int req, int npages); 186 187 /* 188 * vm_pagequeue_domain: 189 * 190 * Return the memory domain the page belongs to. 191 */ 192 static inline struct vm_domain * 193 vm_pagequeue_domain(vm_page_t m) 194 { 195 196 return (VM_DOMAIN(vm_phys_domain(m))); 197 } 198 199 /* 200 * Return the number of pages we need to free-up or cache 201 * A positive number indicates that we do not have enough free pages. 202 */ 203 static inline int 204 vm_paging_target(struct vm_domain *vmd) 205 { 206 207 return (vmd->vmd_free_target - vmd->vmd_free_count); 208 } 209 210 /* 211 * Returns TRUE if the pagedaemon needs to be woken up. 212 */ 213 static inline int 214 vm_paging_needed(struct vm_domain *vmd, u_int free_count) 215 { 216 217 return (free_count < vmd->vmd_pageout_wakeup_thresh); 218 } 219 220 /* 221 * Returns TRUE if the domain is below the min paging target. 222 */ 223 static inline int 224 vm_paging_min(struct vm_domain *vmd) 225 { 226 227 return (vmd->vmd_free_min > vmd->vmd_free_count); 228 } 229 230 /* 231 * Returns TRUE if the domain is below the severe paging target. 232 */ 233 static inline int 234 vm_paging_severe(struct vm_domain *vmd) 235 { 236 237 return (vmd->vmd_free_severe > vmd->vmd_free_count); 238 } 239 240 /* 241 * Return the number of pages we need to launder. 242 * A positive number indicates that we have a shortfall of clean pages. 243 */ 244 static inline int 245 vm_laundry_target(struct vm_domain *vmd) 246 { 247 248 return (vm_paging_target(vmd)); 249 } 250 251 void pagedaemon_wakeup(int domain); 252 253 static inline void 254 vm_domain_freecnt_inc(struct vm_domain *vmd, int adj) 255 { 256 u_int old, new; 257 258 old = atomic_fetchadd_int(&vmd->vmd_free_count, adj); 259 new = old + adj; 260 /* 261 * Only update bitsets on transitions. Notice we short-circuit the 262 * rest of the checks if we're above min already. 263 */ 264 if (old < vmd->vmd_free_min && (new >= vmd->vmd_free_min || 265 (old < vmd->vmd_free_severe && new >= vmd->vmd_free_severe) || 266 (old < vmd->vmd_pageout_free_min && 267 new >= vmd->vmd_pageout_free_min))) 268 vm_domain_clear(vmd); 269 } 270 271 #endif /* _KERNEL */ 272 #endif /* !_VM_PAGEQUEUE_ */ 273