sys/vm/vm_pagequeue.h

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