sys/vm/vm_swapout.c

   1 /*-
   2  * SPDX-License-Identifier: (BSD-4-Clause AND MIT-CMU)
   3  *
   4  * Copyright (c) 1991 Regents of the University of California.
   5  * All rights reserved.
   6  * Copyright (c) 1994 John S. Dyson
   7  * All rights reserved.
   8  * Copyright (c) 1994 David Greenman
   9  * All rights reserved.
  10  * Copyright (c) 2005 Yahoo! Technologies Norway AS
  11  * All rights reserved.
  12  *
  13  * This code is derived from software contributed to Berkeley by
  14  * The Mach Operating System project at Carnegie-Mellon University.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  * 3. All advertising materials mentioning features or use of this software
  25  *    must display the following acknowledgement:
  26  *      This product includes software developed by the University of
  27  *      California, Berkeley and its contributors.
  28  * 4. Neither the name of the University nor the names of its contributors
  29  *    may be used to endorse or promote products derived from this software
  30  *    without specific prior written permission.
  31  *
  32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  42  * SUCH DAMAGE.
  43  *
  44  *      from: @(#)vm_pageout.c  7.4 (Berkeley) 5/7/91
  45  *
  46  *
  47  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  48  * All rights reserved.
  49  *
  50  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  51  *
  52  * Permission to use, copy, modify and distribute this software and
  53  * its documentation is hereby granted, provided that both the copyright
  54  * notice and this permission notice appear in all copies of the
  55  * software, derivative works or modified versions, and any portions
  56  * thereof, and that both notices appear in supporting documentation.
  57  *
  58  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  59  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  60  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  61  *
  62  * Carnegie Mellon requests users of this software to return to
  63  *
  64  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  65  *  School of Computer Science
  66  *  Carnegie Mellon University
  67  *  Pittsburgh PA 15213-3890
  68  *
  69  * any improvements or extensions that they make and grant Carnegie the
  70  * rights to redistribute these changes.
  71  */
  72
  73 #include <sys/cdefs.h>
  74 __FBSDID("$FreeBSD$");
  75
  76 #include "opt_kstack_pages.h"
  77 #include "opt_kstack_max_pages.h"
  78 #include "opt_vm.h"
  79
  80 #include <sys/param.h>
  81 #include <sys/systm.h>
  82 #include <sys/limits.h>
  83 #include <sys/kernel.h>
  84 #include <sys/eventhandler.h>
  85 #include <sys/lock.h>
  86 #include <sys/mutex.h>
  87 #include <sys/proc.h>
  88 #include <sys/kthread.h>
  89 #include <sys/ktr.h>
  90 #include <sys/mount.h>
  91 #include <sys/racct.h>
  92 #include <sys/resourcevar.h>
  93 #include <sys/refcount.h>
  94 #include <sys/sched.h>
  95 #include <sys/sdt.h>
  96 #include <sys/signalvar.h>
  97 #include <sys/smp.h>
  98 #include <sys/time.h>
  99 #include <sys/vnode.h>
 100 #include <sys/vmmeter.h>
 101 #include <sys/rwlock.h>
 102 #include <sys/sx.h>
 103 #include <sys/sysctl.h>
 104
 105 #include <vm/vm.h>
 106 #include <vm/vm_param.h>
 107 #include <vm/vm_object.h>
 108 #include <vm/vm_page.h>
 109 #include <vm/vm_map.h>
 110 #include <vm/vm_pageout.h>
 111 #include <vm/vm_pager.h>
 112 #include <vm/vm_phys.h>
 113 #include <vm/swap_pager.h>
 114 #include <vm/vm_extern.h>
 115 #include <vm/uma.h>
 116
 117 /* the kernel process "vm_daemon" */
 118 static void vm_daemon(void);
 119 static struct proc *vmproc;
 120
 121 static struct kproc_desc vm_kp = {
 122         "vmdaemon",
 123         vm_daemon,
 124         &vmproc
 125 };
 126 SYSINIT(vmdaemon, SI_SUB_KTHREAD_VM, SI_ORDER_FIRST, kproc_start, &vm_kp);
 127
 128 static int vm_swap_enabled = 1;
 129 static int vm_swap_idle_enabled = 0;
 130
 131 SYSCTL_INT(_vm, VM_SWAPPING_ENABLED, swap_enabled, CTLFLAG_RW,
 132     &vm_swap_enabled, 0,
 133     "Enable entire process swapout");
 134 SYSCTL_INT(_vm, OID_AUTO, swap_idle_enabled, CTLFLAG_RW,
 135     &vm_swap_idle_enabled, 0,
 136     "Allow swapout on idle criteria");
 137
 138 /*
 139  * Swap_idle_threshold1 is the guaranteed swapped in time for a process
 140  */
 141 static int swap_idle_threshold1 = 2;
 142 SYSCTL_INT(_vm, OID_AUTO, swap_idle_threshold1, CTLFLAG_RW,
 143     &swap_idle_threshold1, 0,
 144     "Guaranteed swapped in time for a process");
 145
 146 /*
 147  * Swap_idle_threshold2 is the time that a process can be idle before
 148  * it will be swapped out, if idle swapping is enabled.
 149  */
 150 static int swap_idle_threshold2 = 10;
 151 SYSCTL_INT(_vm, OID_AUTO, swap_idle_threshold2, CTLFLAG_RW,
 152     &swap_idle_threshold2, 0,
 153     "Time before a process will be swapped out");
 154
 155 static int vm_pageout_req_swapout;      /* XXX */
 156 static int vm_daemon_needed;
 157 static struct mtx vm_daemon_mtx;
 158 /* Allow for use by vm_pageout before vm_daemon is initialized. */
 159 MTX_SYSINIT(vm_daemon, &vm_daemon_mtx, "vm daemon", MTX_DEF);
 160
 161 static int swapped_cnt;
 162 static int swap_inprogress;     /* Pending swap-ins done outside swapper. */
 163 static int last_swapin;
 164
 165 static void swapclear(struct proc *);
 166 static int swapout(struct proc *);
 167 static void vm_swapout_map_deactivate_pages(vm_map_t, long);
 168 static void vm_swapout_object_deactivate(pmap_t, vm_object_t, long);
 169 static void swapout_procs(int action);
 170 static void vm_req_vmdaemon(int req);
 171 static void vm_thread_swapout(struct thread *td);
 172
 173 static void
 174 vm_swapout_object_deactivate_page(pmap_t pmap, vm_page_t m, bool unmap)
 175 {
 176
 177         /*
 178          * Ignore unreclaimable wired pages.  Repeat the check after busying
 179          * since a busy holder may wire the page.
 180          */
 181         if (vm_page_wired(m) || !vm_page_tryxbusy(m))
 182                 return;
 183
 184         if (vm_page_wired(m) || !pmap_page_exists_quick(pmap, m)) {
 185                 vm_page_xunbusy(m);
 186                 return;
 187         }
 188         if (!pmap_is_referenced(m)) {
 189                 if (!vm_page_active(m))
 190                         (void)vm_page_try_remove_all(m);
 191                 else if (unmap && vm_page_try_remove_all(m))
 192                         vm_page_deactivate(m);
 193         }
 194         vm_page_xunbusy(m);
 195 }
 196
 197 /*
 198  *      vm_swapout_object_deactivate
 199  *
 200  *      Deactivate enough pages to satisfy the inactive target
 201  *      requirements.
 202  *
 203  *      The object and map must be locked.
 204  */
 205 static void
 206 vm_swapout_object_deactivate(pmap_t pmap, vm_object_t first_object,
 207     long desired)
 208 {
 209         vm_object_t backing_object, object;
 210         vm_page_t m;
 211         bool unmap;
 212
 213         VM_OBJECT_ASSERT_LOCKED(first_object);
 214         if ((first_object->flags & OBJ_FICTITIOUS) != 0)
 215                 return;
 216         for (object = first_object;; object = backing_object) {
 217                 if (pmap_resident_count(pmap) <= desired)
 218                         goto unlock_return;
 219                 VM_OBJECT_ASSERT_LOCKED(object);
 220                 if ((object->flags & OBJ_UNMANAGED) != 0 ||
 221                     REFCOUNT_COUNT(object->paging_in_progress) > 0)
 222                         goto unlock_return;
 223
 224                 unmap = true;
 225                 if (object->shadow_count > 1)
 226                         unmap = false;
 227
 228                 /*
 229                  * Scan the object's entire memory queue.
 230                  */
 231                 TAILQ_FOREACH(m, &object->memq, listq) {
 232                         if (pmap_resident_count(pmap) <= desired)
 233                                 goto unlock_return;
 234                         if (should_yield())
 235                                 goto unlock_return;
 236                         vm_swapout_object_deactivate_page(pmap, m, unmap);
 237                 }
 238                 if ((backing_object = object->backing_object) == NULL)
 239                         goto unlock_return;
 240                 VM_OBJECT_RLOCK(backing_object);
 241                 if (object != first_object)
 242                         VM_OBJECT_RUNLOCK(object);
 243         }
 244 unlock_return:
 245         if (object != first_object)
 246                 VM_OBJECT_RUNLOCK(object);
 247 }
 248
 249 /*
 250  * deactivate some number of pages in a map, try to do it fairly, but
 251  * that is really hard to do.
 252  */
 253 static void
 254 vm_swapout_map_deactivate_pages(vm_map_t map, long desired)
 255 {
 256         vm_map_entry_t tmpe;
 257         vm_object_t obj, bigobj;
 258         int nothingwired;
 259
 260         if (!vm_map_trylock_read(map))
 261                 return;
 262
 263         bigobj = NULL;
 264         nothingwired = TRUE;
 265
 266         /*
 267          * first, search out the biggest object, and try to free pages from
 268          * that.
 269          */
 270         VM_MAP_ENTRY_FOREACH(tmpe, map) {
 271                 if ((tmpe->eflags & MAP_ENTRY_IS_SUB_MAP) == 0) {
 272                         obj = tmpe->object.vm_object;
 273                         if (obj != NULL && VM_OBJECT_TRYRLOCK(obj)) {
 274                                 if (obj->shadow_count <= 1 &&
 275                                     (bigobj == NULL ||
 276                                      bigobj->resident_page_count <
 277                                      obj->resident_page_count)) {
 278                                         if (bigobj != NULL)
 279                                                 VM_OBJECT_RUNLOCK(bigobj);
 280                                         bigobj = obj;
 281                                 } else
 282                                         VM_OBJECT_RUNLOCK(obj);
 283                         }
 284                 }
 285                 if (tmpe->wired_count > 0)
 286                         nothingwired = FALSE;
 287         }
 288
 289         if (bigobj != NULL) {
 290                 vm_swapout_object_deactivate(map->pmap, bigobj, desired);
 291                 VM_OBJECT_RUNLOCK(bigobj);
 292         }
 293         /*
 294          * Next, hunt around for other pages to deactivate.  We actually
 295          * do this search sort of wrong -- .text first is not the best idea.
 296          */
 297         VM_MAP_ENTRY_FOREACH(tmpe, map) {
 298                 if (pmap_resident_count(vm_map_pmap(map)) <= desired)
 299                         break;
 300                 if ((tmpe->eflags & MAP_ENTRY_IS_SUB_MAP) == 0) {
 301                         obj = tmpe->object.vm_object;
 302                         if (obj != NULL) {
 303                                 VM_OBJECT_RLOCK(obj);
 304                                 vm_swapout_object_deactivate(map->pmap, obj,
 305                                     desired);
 306                                 VM_OBJECT_RUNLOCK(obj);
 307                         }
 308                 }
 309         }
 310
 311         /*
 312          * Remove all mappings if a process is swapped out, this will free page
 313          * table pages.
 314          */
 315         if (desired == 0 && nothingwired) {
 316                 pmap_remove(vm_map_pmap(map), vm_map_min(map),
 317                     vm_map_max(map));
 318         }
 319
 320         vm_map_unlock_read(map);
 321 }
 322
 323 /*
 324  * Swap out requests
 325  */
 326 #define VM_SWAP_NORMAL 1
 327 #define VM_SWAP_IDLE 2
 328
 329 void
 330 vm_swapout_run(void)
 331 {
 332
 333         if (vm_swap_enabled)
 334                 vm_req_vmdaemon(VM_SWAP_NORMAL);
 335 }
 336
 337 /*
 338  * Idle process swapout -- run once per second when pagedaemons are
 339  * reclaiming pages.
 340  */
 341 void
 342 vm_swapout_run_idle(void)
 343 {
 344         static long lsec;
 345
 346         if (!vm_swap_idle_enabled || time_second == lsec)
 347                 return;
 348         vm_req_vmdaemon(VM_SWAP_IDLE);
 349         lsec = time_second;
 350 }
 351
 352 static void
 353 vm_req_vmdaemon(int req)
 354 {
 355         static int lastrun = 0;
 356
 357         mtx_lock(&vm_daemon_mtx);
 358         vm_pageout_req_swapout |= req;
 359         if ((ticks > (lastrun + hz)) || (ticks < lastrun)) {
 360                 wakeup(&vm_daemon_needed);
 361                 lastrun = ticks;
 362         }
 363         mtx_unlock(&vm_daemon_mtx);
 364 }
 365
 366 static void
 367 vm_daemon(void)
 368 {
 369         struct rlimit rsslim;
 370         struct proc *p;
 371         struct thread *td;
 372         struct vmspace *vm;
 373         int breakout, swapout_flags, tryagain, attempts;
 374 #ifdef RACCT
 375         uint64_t rsize, ravailable;
 376 #endif
 377
 378         while (TRUE) {
 379                 mtx_lock(&vm_daemon_mtx);
 380                 msleep(&vm_daemon_needed, &vm_daemon_mtx, PPAUSE, "psleep",
 381 #ifdef RACCT
 382                     racct_enable ? hz : 0
 383 #else
 384                     0
 385 #endif
 386                 );
 387                 swapout_flags = vm_pageout_req_swapout;
 388                 vm_pageout_req_swapout = 0;
 389                 mtx_unlock(&vm_daemon_mtx);
 390                 if (swapout_flags != 0) {
 391                         /*
 392                          * Drain the per-CPU page queue batches as a deadlock
 393                          * avoidance measure.
 394                          */
 395                         if ((swapout_flags & VM_SWAP_NORMAL) != 0)
 396                                 vm_page_pqbatch_drain();
 397                         swapout_procs(swapout_flags);
 398                 }
 399
 400                 /*
 401                  * scan the processes for exceeding their rlimits or if
 402                  * process is swapped out -- deactivate pages
 403                  */
 404                 tryagain = 0;
 405                 attempts = 0;
 406 again:
 407                 attempts++;
 408                 sx_slock(&allproc_lock);
 409                 FOREACH_PROC_IN_SYSTEM(p) {
 410                         vm_pindex_t limit, size;
 411
 412                         /*
 413                          * if this is a system process or if we have already
 414                          * looked at this process, skip it.
 415                          */
 416                         PROC_LOCK(p);
 417                         if (p->p_state != PRS_NORMAL ||
 418                             p->p_flag & (P_INEXEC | P_SYSTEM | P_WEXIT)) {
 419                                 PROC_UNLOCK(p);
 420                                 continue;
 421                         }
 422                         /*
 423                          * if the process is in a non-running type state,
 424                          * don't touch it.
 425                          */
 426                         breakout = 0;
 427                         FOREACH_THREAD_IN_PROC(p, td) {
 428                                 thread_lock(td);
 429                                 if (!TD_ON_RUNQ(td) &&
 430                                     !TD_IS_RUNNING(td) &&
 431                                     !TD_IS_SLEEPING(td) &&
 432                                     !TD_IS_SUSPENDED(td)) {
 433                                         thread_unlock(td);
 434                                         breakout = 1;
 435                                         break;
 436                                 }
 437                                 thread_unlock(td);
 438                         }
 439                         if (breakout) {
 440                                 PROC_UNLOCK(p);
 441                                 continue;
 442                         }
 443                         /*
 444                          * get a limit
 445                          */
 446                         lim_rlimit_proc(p, RLIMIT_RSS, &rsslim);
 447                         limit = OFF_TO_IDX(
 448                             qmin(rsslim.rlim_cur, rsslim.rlim_max));
 449
 450                         /*
 451                          * let processes that are swapped out really be
 452                          * swapped out set the limit to nothing (will force a
 453                          * swap-out.)
 454                          */
 455                         if ((p->p_flag & P_INMEM) == 0)
 456                                 limit = 0;      /* XXX */
 457                         vm = vmspace_acquire_ref(p);
 458                         _PHOLD_LITE(p);
 459                         PROC_UNLOCK(p);
 460                         if (vm == NULL) {
 461                                 PRELE(p);
 462                                 continue;
 463                         }
 464                         sx_sunlock(&allproc_lock);
 465
 466                         size = vmspace_resident_count(vm);
 467                         if (size >= limit) {
 468                                 vm_swapout_map_deactivate_pages(
 469                                     &vm->vm_map, limit);
 470                                 size = vmspace_resident_count(vm);
 471                         }
 472 #ifdef RACCT
 473                         if (racct_enable) {
 474                                 rsize = IDX_TO_OFF(size);
 475                                 PROC_LOCK(p);
 476                                 if (p->p_state == PRS_NORMAL)
 477                                         racct_set(p, RACCT_RSS, rsize);
 478                                 ravailable = racct_get_available(p, RACCT_RSS);
 479                                 PROC_UNLOCK(p);
 480                                 if (rsize > ravailable) {
 481                                         /*
 482                                          * Don't be overly aggressive; this
 483                                          * might be an innocent process,
 484                                          * and the limit could've been exceeded
 485                                          * by some memory hog.  Don't try
 486                                          * to deactivate more than 1/4th
 487                                          * of process' resident set size.
 488                                          */
 489                                         if (attempts <= 8) {
 490                                                 if (ravailable < rsize -
 491                                                     (rsize / 4)) {
 492                                                         ravailable = rsize -
 493                                                             (rsize / 4);
 494                                                 }
 495                                         }
 496                                         vm_swapout_map_deactivate_pages(
 497                                             &vm->vm_map,
 498                                             OFF_TO_IDX(ravailable));
 499                                         /* Update RSS usage after paging out. */
 500                                         size = vmspace_resident_count(vm);
 501                                         rsize = IDX_TO_OFF(size);
 502                                         PROC_LOCK(p);
 503                                         if (p->p_state == PRS_NORMAL)
 504                                                 racct_set(p, RACCT_RSS, rsize);
 505                                         PROC_UNLOCK(p);
 506                                         if (rsize > ravailable)
 507                                                 tryagain = 1;
 508                                 }
 509                         }
 510 #endif
 511                         vmspace_free(vm);
 512                         sx_slock(&allproc_lock);
 513                         PRELE(p);
 514                 }
 515                 sx_sunlock(&allproc_lock);
 516                 if (tryagain != 0 && attempts <= 10) {
 517                         maybe_yield();
 518                         goto again;
 519                 }
 520         }
 521 }
 522
 523 /*
 524  * Allow a thread's kernel stack to be paged out.
 525  */
 526 static void
 527 vm_thread_swapout(struct thread *td)
 528 {
 529         vm_object_t ksobj;
 530         vm_page_t m;
 531         int i, pages;
 532
 533         cpu_thread_swapout(td);
 534         pages = td->td_kstack_pages;
 535         ksobj = td->td_kstack_obj;
 536         pmap_qremove(td->td_kstack, pages);
 537         VM_OBJECT_WLOCK(ksobj);
 538         for (i = 0; i < pages; i++) {
 539                 m = vm_page_lookup(ksobj, i);
 540                 if (m == NULL)
 541                         panic("vm_thread_swapout: kstack already missing?");
 542                 vm_page_dirty(m);
 543                 vm_page_unwire(m, PQ_LAUNDRY);
 544         }
 545         VM_OBJECT_WUNLOCK(ksobj);
 546 }
 547
 548 /*
 549  * Bring the kernel stack for a specified thread back in.
 550  */
 551 static void
 552 vm_thread_swapin(struct thread *td, int oom_alloc)
 553 {
 554         vm_object_t ksobj;
 555         vm_page_t ma[KSTACK_MAX_PAGES];
 556         int a, count, i, j, pages, rv;
 557
 558         pages = td->td_kstack_pages;
 559         ksobj = td->td_kstack_obj;
 560         VM_OBJECT_WLOCK(ksobj);
 561         (void)vm_page_grab_pages(ksobj, 0, oom_alloc | VM_ALLOC_WIRED, ma,
 562             pages);
 563         VM_OBJECT_WUNLOCK(ksobj);
 564         for (i = 0; i < pages;) {
 565                 vm_page_assert_xbusied(ma[i]);
 566                 if (vm_page_all_valid(ma[i])) {
 567                         vm_page_xunbusy(ma[i]);
 568                         i++;
 569                         continue;
 570                 }
 571                 vm_object_pip_add(ksobj, 1);
 572                 for (j = i + 1; j < pages; j++)
 573                         if (vm_page_all_valid(ma[j]))
 574                                 break;
 575                 VM_OBJECT_WLOCK(ksobj);
 576                 rv = vm_pager_has_page(ksobj, ma[i]->pindex, NULL, &a);
 577                 VM_OBJECT_WUNLOCK(ksobj);
 578                 KASSERT(rv == 1, ("%s: missing page %p", __func__, ma[i]));
 579                 count = min(a + 1, j - i);
 580                 rv = vm_pager_get_pages(ksobj, ma + i, count, NULL, NULL);
 581                 KASSERT(rv == VM_PAGER_OK, ("%s: cannot get kstack for proc %d",
 582                     __func__, td->td_proc->p_pid));
 583                 vm_object_pip_wakeup(ksobj);
 584                 for (j = i; j < i + count; j++)
 585                         vm_page_xunbusy(ma[j]);
 586                 i += count;
 587         }
 588         pmap_qenter(td->td_kstack, ma, pages);
 589         cpu_thread_swapin(td);
 590 }
 591
 592 void
 593 faultin(struct proc *p)
 594 {
 595         struct thread *td;
 596         int oom_alloc;
 597
 598         PROC_LOCK_ASSERT(p, MA_OWNED);
 599
 600         /*
 601          * If another process is swapping in this process,
 602          * just wait until it finishes.
 603          */
 604         if (p->p_flag & P_SWAPPINGIN) {
 605                 while (p->p_flag & P_SWAPPINGIN)
 606                         msleep(&p->p_flag, &p->p_mtx, PVM, "faultin", 0);
 607                 return;
 608         }
 609
 610         if ((p->p_flag & P_INMEM) == 0) {
 611                 oom_alloc = (p->p_flag & P_WKILLED) != 0 ? VM_ALLOC_SYSTEM :
 612                     VM_ALLOC_NORMAL;
 613
 614                 /*
 615                  * Don't let another thread swap process p out while we are
 616                  * busy swapping it in.
 617                  */
 618                 ++p->p_lock;
 619                 p->p_flag |= P_SWAPPINGIN;
 620                 PROC_UNLOCK(p);
 621                 sx_xlock(&allproc_lock);
 622                 MPASS(swapped_cnt > 0);
 623                 swapped_cnt--;
 624                 if (curthread != &thread0)
 625                         swap_inprogress++;
 626                 sx_xunlock(&allproc_lock);
 627
 628                 /*
 629                  * We hold no lock here because the list of threads
 630                  * can not change while all threads in the process are
 631                  * swapped out.
 632                  */
 633                 FOREACH_THREAD_IN_PROC(p, td)
 634                         vm_thread_swapin(td, oom_alloc);
 635
 636                 if (curthread != &thread0) {
 637                         sx_xlock(&allproc_lock);
 638                         MPASS(swap_inprogress > 0);
 639                         swap_inprogress--;
 640                         last_swapin = ticks;
 641                         sx_xunlock(&allproc_lock);
 642                 }
 643                 PROC_LOCK(p);
 644                 swapclear(p);
 645                 p->p_swtick = ticks;
 646
 647                 /* Allow other threads to swap p out now. */
 648                 wakeup(&p->p_flag);
 649                 --p->p_lock;
 650         }
 651 }
 652
 653 /*
 654  * This swapin algorithm attempts to swap-in processes only if there
 655  * is enough space for them.  Of course, if a process waits for a long
 656  * time, it will be swapped in anyway.
 657  */
 658
 659 static struct proc *
 660 swapper_selector(bool wkilled_only)
 661 {
 662         struct proc *p, *res;
 663         struct thread *td;
 664         int ppri, pri, slptime, swtime;
 665
 666         sx_assert(&allproc_lock, SA_SLOCKED);
 667         if (swapped_cnt == 0)
 668                 return (NULL);
 669         res = NULL;
 670         ppri = INT_MIN;
 671         FOREACH_PROC_IN_SYSTEM(p) {
 672                 PROC_LOCK(p);
 673                 if (p->p_state == PRS_NEW || (p->p_flag & (P_SWAPPINGOUT |
 674                     P_SWAPPINGIN | P_INMEM)) != 0) {
 675                         PROC_UNLOCK(p);
 676                         continue;
 677                 }
 678                 if (p->p_state == PRS_NORMAL && (p->p_flag & P_WKILLED) != 0) {
 679                         /*
 680                          * A swapped-out process might have mapped a
 681                          * large portion of the system's pages as
 682                          * anonymous memory.  There is no other way to
 683                          * release the memory other than to kill the
 684                          * process, for which we need to swap it in.
 685                          */
 686                         return (p);
 687                 }
 688                 if (wkilled_only) {
 689                         PROC_UNLOCK(p);
 690                         continue;
 691                 }
 692                 swtime = (ticks - p->p_swtick) / hz;
 693                 FOREACH_THREAD_IN_PROC(p, td) {
 694                         /*
 695                          * An otherwise runnable thread of a process
 696                          * swapped out has only the TDI_SWAPPED bit set.
 697                          */
 698                         thread_lock(td);
 699                         if (td->td_inhibitors == TDI_SWAPPED) {
 700                                 slptime = (ticks - td->td_slptick) / hz;
 701                                 pri = swtime + slptime;
 702                                 if ((td->td_flags & TDF_SWAPINREQ) == 0)
 703                                         pri -= p->p_nice * 8;
 704                                 /*
 705                                  * if this thread is higher priority
 706                                  * and there is enough space, then select
 707                                  * this process instead of the previous
 708                                  * selection.
 709                                  */
 710                                 if (pri > ppri) {
 711                                         res = p;
 712                                         ppri = pri;
 713                                 }
 714                         }
 715                         thread_unlock(td);
 716                 }
 717                 PROC_UNLOCK(p);
 718         }
 719
 720         if (res != NULL)
 721                 PROC_LOCK(res);
 722         return (res);
 723 }
 724
 725 #define SWAPIN_INTERVAL (MAXSLP * hz / 2)
 726
 727 /*
 728  * Limit swapper to swap in one non-WKILLED process in MAXSLP/2
 729  * interval, assuming that there is:
 730  * - at least one domain that is not suffering from a shortage of free memory;
 731  * - no parallel swap-ins;
 732  * - no other swap-ins in the current SWAPIN_INTERVAL.
 733  */
 734 static bool
 735 swapper_wkilled_only(void)
 736 {
 737
 738         return (vm_page_count_min_set(&all_domains) || swap_inprogress > 0 ||
 739             (u_int)(ticks - last_swapin) < SWAPIN_INTERVAL);
 740 }
 741
 742 void
 743 swapper(void)
 744 {
 745         struct proc *p;
 746
 747         for (;;) {
 748                 sx_slock(&allproc_lock);
 749                 p = swapper_selector(swapper_wkilled_only());
 750                 sx_sunlock(&allproc_lock);
 751
 752                 if (p == NULL) {
 753                         tsleep(&proc0, PVM, "swapin", SWAPIN_INTERVAL);
 754                 } else {
 755                         PROC_LOCK_ASSERT(p, MA_OWNED);
 756
 757                         /*
 758                          * Another process may be bringing or may have
 759                          * already brought this process in while we
 760                          * traverse all threads.  Or, this process may
 761                          * have exited or even being swapped out
 762                          * again.
 763                          */
 764                         if (p->p_state == PRS_NORMAL && (p->p_flag & (P_INMEM |
 765                             P_SWAPPINGOUT | P_SWAPPINGIN)) == 0) {
 766                                 faultin(p);
 767                         }
 768                         PROC_UNLOCK(p);
 769                 }
 770         }
 771 }
 772
 773 /*
 774  * First, if any processes have been sleeping or stopped for at least
 775  * "swap_idle_threshold1" seconds, they are swapped out.  If, however,
 776  * no such processes exist, then the longest-sleeping or stopped
 777  * process is swapped out.  Finally, and only as a last resort, if
 778  * there are no sleeping or stopped processes, the longest-resident
 779  * process is swapped out.
 780  */
 781 static void
 782 swapout_procs(int action)
 783 {
 784         struct proc *p;
 785         struct thread *td;
 786         int slptime;
 787         bool didswap, doswap;
 788
 789         MPASS((action & (VM_SWAP_NORMAL | VM_SWAP_IDLE)) != 0);
 790
 791         didswap = false;
 792         sx_slock(&allproc_lock);
 793         FOREACH_PROC_IN_SYSTEM(p) {
 794                 /*
 795                  * Filter out not yet fully constructed processes.  Do
 796                  * not swap out held processes.  Avoid processes which
 797                  * are system, exiting, execing, traced, already swapped
 798                  * out or are in the process of being swapped in or out.
 799                  */
 800                 PROC_LOCK(p);
 801                 if (p->p_state != PRS_NORMAL || p->p_lock != 0 || (p->p_flag &
 802                     (P_SYSTEM | P_WEXIT | P_INEXEC | P_STOPPED_SINGLE |
 803                     P_TRACED | P_SWAPPINGOUT | P_SWAPPINGIN | P_INMEM)) !=
 804                     P_INMEM) {
 805                         PROC_UNLOCK(p);
 806                         continue;
 807                 }
 808
 809                 /*
 810                  * Further consideration of this process for swap out
 811                  * requires iterating over its threads.  We release
 812                  * allproc_lock here so that process creation and
 813                  * destruction are not blocked while we iterate.
 814                  *
 815                  * To later reacquire allproc_lock and resume
 816                  * iteration over the allproc list, we will first have
 817                  * to release the lock on the process.  We place a
 818                  * hold on the process so that it remains in the
 819                  * allproc list while it is unlocked.
 820                  */
 821                 _PHOLD_LITE(p);
 822                 sx_sunlock(&allproc_lock);
 823
 824                 /*
 825                  * Do not swapout a realtime process.
 826                  * Guarantee swap_idle_threshold1 time in memory.
 827                  * If the system is under memory stress, or if we are
 828                  * swapping idle processes >= swap_idle_threshold2,
 829                  * then swap the process out.
 830                  */
 831                 doswap = true;
 832                 FOREACH_THREAD_IN_PROC(p, td) {
 833                         thread_lock(td);
 834                         slptime = (ticks - td->td_slptick) / hz;
 835                         if (PRI_IS_REALTIME(td->td_pri_class) ||
 836                             slptime < swap_idle_threshold1 ||
 837                             !thread_safetoswapout(td) ||
 838                             ((action & VM_SWAP_NORMAL) == 0 &&
 839                             slptime < swap_idle_threshold2))
 840                                 doswap = false;
 841                         thread_unlock(td);
 842                         if (!doswap)
 843                                 break;
 844                 }
 845                 if (doswap && swapout(p) == 0)
 846                         didswap = true;
 847
 848                 PROC_UNLOCK(p);
 849                 if (didswap) {
 850                         sx_xlock(&allproc_lock);
 851                         swapped_cnt++;
 852                         sx_downgrade(&allproc_lock);
 853                 } else
 854                         sx_slock(&allproc_lock);
 855                 PRELE(p);
 856         }
 857         sx_sunlock(&allproc_lock);
 858
 859         /*
 860          * If we swapped something out, and another process needed memory,
 861          * then wakeup the sched process.
 862          */
 863         if (didswap)
 864                 wakeup(&proc0);
 865 }
 866
 867 static void
 868 swapclear(struct proc *p)
 869 {
 870         struct thread *td;
 871
 872         PROC_LOCK_ASSERT(p, MA_OWNED);
 873
 874         FOREACH_THREAD_IN_PROC(p, td) {
 875                 thread_lock(td);
 876                 td->td_flags |= TDF_INMEM;
 877                 td->td_flags &= ~TDF_SWAPINREQ;
 878                 TD_CLR_SWAPPED(td);
 879                 if (TD_CAN_RUN(td)) {
 880                         if (setrunnable(td, 0)) {
 881 #ifdef INVARIANTS
 882                                 /*
 883                                  * XXX: We just cleared TDI_SWAPPED
 884                                  * above and set TDF_INMEM, so this
 885                                  * should never happen.
 886                                  */
 887                                 panic("not waking up swapper");
 888 #endif
 889                         }
 890                 } else
 891                         thread_unlock(td);
 892         }
 893         p->p_flag &= ~(P_SWAPPINGIN | P_SWAPPINGOUT);
 894         p->p_flag |= P_INMEM;
 895 }
 896
 897 static int
 898 swapout(struct proc *p)
 899 {
 900         struct thread *td;
 901
 902         PROC_LOCK_ASSERT(p, MA_OWNED);
 903
 904         /*
 905          * The states of this process and its threads may have changed
 906          * by now.  Assuming that there is only one pageout daemon thread,
 907          * this process should still be in memory.
 908          */
 909         KASSERT((p->p_flag & (P_INMEM | P_SWAPPINGOUT | P_SWAPPINGIN)) ==
 910             P_INMEM, ("swapout: lost a swapout race?"));
 911
 912         /*
 913          * Remember the resident count.
 914          */
 915         p->p_vmspace->vm_swrss = vmspace_resident_count(p->p_vmspace);
 916
 917         /*
 918          * Check and mark all threads before we proceed.
 919          */
 920         p->p_flag &= ~P_INMEM;
 921         p->p_flag |= P_SWAPPINGOUT;
 922         FOREACH_THREAD_IN_PROC(p, td) {
 923                 thread_lock(td);
 924                 if (!thread_safetoswapout(td)) {
 925                         thread_unlock(td);
 926                         swapclear(p);
 927                         return (EBUSY);
 928                 }
 929                 td->td_flags &= ~TDF_INMEM;
 930                 TD_SET_SWAPPED(td);
 931                 thread_unlock(td);
 932         }
 933         td = FIRST_THREAD_IN_PROC(p);
 934         ++td->td_ru.ru_nswap;
 935         PROC_UNLOCK(p);
 936
 937         /*
 938          * This list is stable because all threads are now prevented from
 939          * running.  The list is only modified in the context of a running
 940          * thread in this process.
 941          */
 942         FOREACH_THREAD_IN_PROC(p, td)
 943                 vm_thread_swapout(td);
 944
 945         PROC_LOCK(p);
 946         p->p_flag &= ~P_SWAPPINGOUT;
 947         p->p_swtick = ticks;
 948         return (0);
 949 }