sys/vm/vm_glue.c

   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_glue.c     8.6 (Berkeley) 1/5/94
  35  *
  36  *
  37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  38  * All rights reserved.
  39  *
  40  * Permission to use, copy, modify and distribute this software and
  41  * its documentation is hereby granted, provided that both the copyright
  42  * notice and this permission notice appear in all copies of the
  43  * software, derivative works or modified versions, and any portions
  44  * thereof, and that both notices appear in supporting documentation.
  45  *
  46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  49  *
  50  * Carnegie Mellon requests users of this software to return to
  51  *
  52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  53  *  School of Computer Science
  54  *  Carnegie Mellon University
  55  *  Pittsburgh PA 15213-3890
  56  *
  57  * any improvements or extensions that they make and grant Carnegie the
  58  * rights to redistribute these changes.
  59  */
  60
  61 #include <sys/cdefs.h>
  62 __FBSDID("$FreeBSD$");
  63
  64 #include "opt_vm.h"
  65 #include "opt_kstack_pages.h"
  66 #include "opt_kstack_max_pages.h"
  67 #include "opt_kstack_usage_prof.h"
  68
  69 #include <sys/param.h>
  70 #include <sys/systm.h>
  71 #include <sys/domainset.h>
  72 #include <sys/limits.h>
  73 #include <sys/lock.h>
  74 #include <sys/malloc.h>
  75 #include <sys/mutex.h>
  76 #include <sys/proc.h>
  77 #include <sys/racct.h>
  78 #include <sys/resourcevar.h>
  79 #include <sys/rwlock.h>
  80 #include <sys/sched.h>
  81 #include <sys/sf_buf.h>
  82 #include <sys/shm.h>
  83 #include <sys/smp.h>
  84 #include <sys/vmmeter.h>
  85 #include <sys/vmem.h>
  86 #include <sys/sx.h>
  87 #include <sys/sysctl.h>
  88 #include <sys/eventhandler.h>
  89 #include <sys/kernel.h>
  90 #include <sys/ktr.h>
  91 #include <sys/unistd.h>
  92
  93 #include <vm/uma.h>
  94 #include <vm/vm.h>
  95 #include <vm/vm_param.h>
  96 #include <vm/pmap.h>
  97 #include <vm/vm_domainset.h>
  98 #include <vm/vm_map.h>
  99 #include <vm/vm_page.h>
 100 #include <vm/vm_pageout.h>
 101 #include <vm/vm_object.h>
 102 #include <vm/vm_kern.h>
 103 #include <vm/vm_extern.h>
 104 #include <vm/vm_pager.h>
 105 #include <vm/swap_pager.h>
 106
 107 #include <machine/cpu.h>
 108
 109 /*
 110  * MPSAFE
 111  *
 112  * WARNING!  This code calls vm_map_check_protection() which only checks
 113  * the associated vm_map_entry range.  It does not determine whether the
 114  * contents of the memory is actually readable or writable.  In most cases
 115  * just checking the vm_map_entry is sufficient within the kernel's address
 116  * space.
 117  */
 118 int
 119 kernacc(void *addr, int len, int rw)
 120 {
 121         boolean_t rv;
 122         vm_offset_t saddr, eaddr;
 123         vm_prot_t prot;
 124
 125         KASSERT((rw & ~VM_PROT_ALL) == 0,
 126             ("illegal ``rw'' argument to kernacc (%x)\n", rw));
 127
 128         if ((vm_offset_t)addr + len > vm_map_max(kernel_map) ||
 129             (vm_offset_t)addr + len < (vm_offset_t)addr)
 130                 return (FALSE);
 131
 132         prot = rw;
 133         saddr = trunc_page((vm_offset_t)addr);
 134         eaddr = round_page((vm_offset_t)addr + len);
 135         vm_map_lock_read(kernel_map);
 136         rv = vm_map_check_protection(kernel_map, saddr, eaddr, prot);
 137         vm_map_unlock_read(kernel_map);
 138         return (rv == TRUE);
 139 }
 140
 141 /*
 142  * MPSAFE
 143  *
 144  * WARNING!  This code calls vm_map_check_protection() which only checks
 145  * the associated vm_map_entry range.  It does not determine whether the
 146  * contents of the memory is actually readable or writable.  vmapbuf(),
 147  * vm_fault_quick(), or copyin()/copout()/su*()/fu*() functions should be
 148  * used in conjunction with this call.
 149  */
 150 int
 151 useracc(void *addr, int len, int rw)
 152 {
 153         boolean_t rv;
 154         vm_prot_t prot;
 155         vm_map_t map;
 156
 157         KASSERT((rw & ~VM_PROT_ALL) == 0,
 158             ("illegal ``rw'' argument to useracc (%x)\n", rw));
 159         prot = rw;
 160         map = &curproc->p_vmspace->vm_map;
 161         if ((vm_offset_t)addr + len > vm_map_max(map) ||
 162             (vm_offset_t)addr + len < (vm_offset_t)addr) {
 163                 return (FALSE);
 164         }
 165         vm_map_lock_read(map);
 166         rv = vm_map_check_protection(map, trunc_page((vm_offset_t)addr),
 167             round_page((vm_offset_t)addr + len), prot);
 168         vm_map_unlock_read(map);
 169         return (rv == TRUE);
 170 }
 171
 172 int
 173 vslock(void *addr, size_t len)
 174 {
 175         vm_offset_t end, last, start;
 176         vm_size_t npages;
 177         int error;
 178
 179         last = (vm_offset_t)addr + len;
 180         start = trunc_page((vm_offset_t)addr);
 181         end = round_page(last);
 182         if (last < (vm_offset_t)addr || end < (vm_offset_t)addr)
 183                 return (EINVAL);
 184         npages = atop(end - start);
 185         if (npages > vm_page_max_user_wired)
 186                 return (ENOMEM);
 187         error = vm_map_wire(&curproc->p_vmspace->vm_map, start, end,
 188             VM_MAP_WIRE_SYSTEM | VM_MAP_WIRE_NOHOLES);
 189         if (error == KERN_SUCCESS) {
 190                 curthread->td_vslock_sz += len;
 191                 return (0);
 192         }
 193
 194         /*
 195          * Return EFAULT on error to match copy{in,out}() behaviour
 196          * rather than returning ENOMEM like mlock() would.
 197          */
 198         return (EFAULT);
 199 }
 200
 201 void
 202 vsunlock(void *addr, size_t len)
 203 {
 204
 205         /* Rely on the parameter sanity checks performed by vslock(). */
 206         MPASS(curthread->td_vslock_sz >= len);
 207         curthread->td_vslock_sz -= len;
 208         (void)vm_map_unwire(&curproc->p_vmspace->vm_map,
 209             trunc_page((vm_offset_t)addr), round_page((vm_offset_t)addr + len),
 210             VM_MAP_WIRE_SYSTEM | VM_MAP_WIRE_NOHOLES);
 211 }
 212
 213 /*
 214  * Pin the page contained within the given object at the given offset.  If the
 215  * page is not resident, allocate and load it using the given object's pager.
 216  * Return the pinned page if successful; otherwise, return NULL.
 217  */
 218 static vm_page_t
 219 vm_imgact_hold_page(vm_object_t object, vm_ooffset_t offset)
 220 {
 221         vm_page_t m;
 222         vm_pindex_t pindex;
 223
 224         pindex = OFF_TO_IDX(offset);
 225         (void)vm_page_grab_valid_unlocked(&m, object, pindex,
 226             VM_ALLOC_NORMAL | VM_ALLOC_NOBUSY | VM_ALLOC_WIRED);
 227         return (m);
 228 }
 229
 230 /*
 231  * Return a CPU private mapping to the page at the given offset within the
 232  * given object.  The page is pinned before it is mapped.
 233  */
 234 struct sf_buf *
 235 vm_imgact_map_page(vm_object_t object, vm_ooffset_t offset)
 236 {
 237         vm_page_t m;
 238
 239         m = vm_imgact_hold_page(object, offset);
 240         if (m == NULL)
 241                 return (NULL);
 242         sched_pin();
 243         return (sf_buf_alloc(m, SFB_CPUPRIVATE));
 244 }
 245
 246 /*
 247  * Destroy the given CPU private mapping and unpin the page that it mapped.
 248  */
 249 void
 250 vm_imgact_unmap_page(struct sf_buf *sf)
 251 {
 252         vm_page_t m;
 253
 254         m = sf_buf_page(sf);
 255         sf_buf_free(sf);
 256         sched_unpin();
 257         vm_page_unwire(m, PQ_ACTIVE);
 258 }
 259
 260 void
 261 vm_sync_icache(vm_map_t map, vm_offset_t va, vm_offset_t sz)
 262 {
 263
 264         pmap_sync_icache(map->pmap, va, sz);
 265 }
 266
 267 static uma_zone_t kstack_cache;
 268 static int kstack_cache_size;
 269 static int kstack_domain_iter;
 270
 271 static int
 272 sysctl_kstack_cache_size(SYSCTL_HANDLER_ARGS)
 273 {
 274         int error, oldsize;
 275
 276         oldsize = kstack_cache_size;
 277         error = sysctl_handle_int(oidp, arg1, arg2, req);
 278         if (error == 0 && req->newptr && oldsize != kstack_cache_size)
 279                 uma_zone_set_maxcache(kstack_cache, kstack_cache_size);
 280         return (error);
 281 }
 282 SYSCTL_PROC(_vm, OID_AUTO, kstack_cache_size,
 283     CTLTYPE_INT|CTLFLAG_MPSAFE|CTLFLAG_RW, &kstack_cache_size, 0,
 284     sysctl_kstack_cache_size, "IU", "Maximum number of cached kernel stacks");
 285
 286 /*
 287  * Create the kernel stack (including pcb for i386) for a new thread.
 288  * This routine directly affects the fork perf for a process and
 289  * create performance for a thread.
 290  */
 291 static vm_offset_t
 292 vm_thread_stack_create(struct domainset *ds, vm_object_t *ksobjp, int pages)
 293 {
 294         vm_page_t ma[KSTACK_MAX_PAGES];
 295         vm_object_t ksobj;
 296         vm_offset_t ks;
 297         int i;
 298
 299         /*
 300          * Allocate an object for the kstack.
 301          */
 302         ksobj = vm_object_allocate(OBJT_DEFAULT, pages);
 303
 304         /*
 305          * Get a kernel virtual address for this thread's kstack.
 306          */
 307 #if defined(__mips__)
 308         /*
 309          * We need to align the kstack's mapped address to fit within
 310          * a single TLB entry.
 311          */
 312         if (vmem_xalloc(kernel_arena, (pages + KSTACK_GUARD_PAGES) * PAGE_SIZE,
 313             PAGE_SIZE * 2, 0, 0, VMEM_ADDR_MIN, VMEM_ADDR_MAX,
 314             M_BESTFIT | M_NOWAIT, &ks)) {
 315                 ks = 0;
 316         }
 317 #else
 318         ks = kva_alloc((pages + KSTACK_GUARD_PAGES) * PAGE_SIZE);
 319 #endif
 320         if (ks == 0) {
 321                 printf("%s: kstack allocation failed\n", __func__);
 322                 vm_object_deallocate(ksobj);
 323                 return (0);
 324         }
 325         if (vm_ndomains > 1) {
 326                 ksobj->domain.dr_policy = ds;
 327                 ksobj->domain.dr_iter =
 328                     atomic_fetchadd_int(&kstack_domain_iter, 1);
 329         }
 330
 331         if (KSTACK_GUARD_PAGES != 0) {
 332                 pmap_qremove(ks, KSTACK_GUARD_PAGES);
 333                 ks += KSTACK_GUARD_PAGES * PAGE_SIZE;
 334         }
 335
 336         /*
 337          * For the length of the stack, link in a real page of ram for each
 338          * page of stack.
 339          */
 340         VM_OBJECT_WLOCK(ksobj);
 341         (void)vm_page_grab_pages(ksobj, 0, VM_ALLOC_NORMAL | VM_ALLOC_WIRED,
 342             ma, pages);
 343         for (i = 0; i < pages; i++)
 344                 vm_page_valid(ma[i]);
 345         VM_OBJECT_WUNLOCK(ksobj);
 346         pmap_qenter(ks, ma, pages);
 347         *ksobjp = ksobj;
 348
 349         return (ks);
 350 }
 351
 352 static void
 353 vm_thread_stack_dispose(vm_object_t ksobj, vm_offset_t ks, int pages)
 354 {
 355         vm_page_t m;
 356         int i;
 357
 358         pmap_qremove(ks, pages);
 359         VM_OBJECT_WLOCK(ksobj);
 360         for (i = 0; i < pages; i++) {
 361                 m = vm_page_lookup(ksobj, i);
 362                 if (m == NULL)
 363                         panic("%s: kstack already missing?", __func__);
 364                 vm_page_xbusy_claim(m);
 365                 vm_page_unwire_noq(m);
 366                 vm_page_free(m);
 367         }
 368         VM_OBJECT_WUNLOCK(ksobj);
 369         vm_object_deallocate(ksobj);
 370         kva_free(ks - (KSTACK_GUARD_PAGES * PAGE_SIZE),
 371             (pages + KSTACK_GUARD_PAGES) * PAGE_SIZE);
 372 }
 373
 374 /*
 375  * Allocate the kernel stack for a new thread.
 376  */
 377 int
 378 vm_thread_new(struct thread *td, int pages)
 379 {
 380         vm_object_t ksobj;
 381         vm_offset_t ks;
 382
 383         /* Bounds check */
 384         if (pages <= 1)
 385                 pages = kstack_pages;
 386         else if (pages > KSTACK_MAX_PAGES)
 387                 pages = KSTACK_MAX_PAGES;
 388
 389         ks = 0;
 390         ksobj = NULL;
 391         if (pages == kstack_pages && kstack_cache != NULL) {
 392                 ks = (vm_offset_t)uma_zalloc(kstack_cache, M_NOWAIT);
 393                 if (ks != 0)
 394                         ksobj = PHYS_TO_VM_PAGE(pmap_kextract(ks))->object;
 395         }
 396
 397         /*
 398          * Ensure that kstack objects can draw pages from any memory
 399          * domain.  Otherwise a local memory shortage can block a process
 400          * swap-in.
 401          */
 402         if (ks == 0)
 403                 ks = vm_thread_stack_create(DOMAINSET_PREF(PCPU_GET(domain)),
 404                     &ksobj, pages);
 405         if (ks == 0)
 406                 return (0);
 407         td->td_kstack_obj = ksobj;
 408         td->td_kstack = ks;
 409         td->td_kstack_pages = pages;
 410         return (1);
 411 }
 412
 413 /*
 414  * Dispose of a thread's kernel stack.
 415  */
 416 void
 417 vm_thread_dispose(struct thread *td)
 418 {
 419         vm_object_t ksobj;
 420         vm_offset_t ks;
 421         int pages;
 422
 423         pages = td->td_kstack_pages;
 424         ksobj = td->td_kstack_obj;
 425         ks = td->td_kstack;
 426         td->td_kstack = 0;
 427         td->td_kstack_pages = 0;
 428         if (pages == kstack_pages)
 429                 uma_zfree(kstack_cache, (void *)ks);
 430         else
 431                 vm_thread_stack_dispose(ksobj, ks, pages);
 432 }
 433
 434 static int
 435 kstack_import(void *arg, void **store, int cnt, int domain, int flags)
 436 {
 437         struct domainset *ds;
 438         vm_object_t ksobj;
 439         int i;
 440
 441         if (domain == UMA_ANYDOMAIN)
 442                 ds = DOMAINSET_RR();
 443         else
 444                 ds = DOMAINSET_PREF(domain);
 445
 446         for (i = 0; i < cnt; i++) {
 447                 store[i] = (void *)vm_thread_stack_create(ds, &ksobj,
 448                     kstack_pages);
 449                 if (store[i] == NULL)
 450                         break;
 451         }
 452         return (i);
 453 }
 454
 455 static void
 456 kstack_release(void *arg, void **store, int cnt)
 457 {
 458         vm_offset_t ks;
 459         int i;
 460
 461         for (i = 0; i < cnt; i++) {
 462                 ks = (vm_offset_t)store[i];
 463                 vm_thread_stack_dispose(
 464                     PHYS_TO_VM_PAGE(pmap_kextract(ks))->object,
 465                     ks, kstack_pages);
 466         }
 467 }
 468
 469 static void
 470 kstack_cache_init(void *null)
 471 {
 472         kstack_cache = uma_zcache_create("kstack_cache",
 473             kstack_pages * PAGE_SIZE, NULL, NULL, NULL, NULL,
 474             kstack_import, kstack_release, NULL,
 475             UMA_ZONE_FIRSTTOUCH);
 476         kstack_cache_size = imax(128, mp_ncpus * 4);
 477         uma_zone_set_maxcache(kstack_cache, kstack_cache_size);
 478 }
 479
 480 SYSINIT(vm_kstacks, SI_SUB_KTHREAD_INIT, SI_ORDER_ANY, kstack_cache_init, NULL);
 481
 482 #ifdef KSTACK_USAGE_PROF
 483 /*
 484  * Track maximum stack used by a thread in kernel.
 485  */
 486 static int max_kstack_used;
 487
 488 SYSCTL_INT(_debug, OID_AUTO, max_kstack_used, CTLFLAG_RD,
 489     &max_kstack_used, 0,
 490     "Maxiumum stack depth used by a thread in kernel");
 491
 492 void
 493 intr_prof_stack_use(struct thread *td, struct trapframe *frame)
 494 {
 495         vm_offset_t stack_top;
 496         vm_offset_t current;
 497         int used, prev_used;
 498
 499         /*
 500          * Testing for interrupted kernel mode isn't strictly
 501          * needed. It optimizes the execution, since interrupts from
 502          * usermode will have only the trap frame on the stack.
 503          */
 504         if (TRAPF_USERMODE(frame))
 505                 return;
 506
 507         stack_top = td->td_kstack + td->td_kstack_pages * PAGE_SIZE;
 508         current = (vm_offset_t)(uintptr_t)&stack_top;
 509
 510         /*
 511          * Try to detect if interrupt is using kernel thread stack.
 512          * Hardware could use a dedicated stack for interrupt handling.
 513          */
 514         if (stack_top <= current || current < td->td_kstack)
 515                 return;
 516
 517         used = stack_top - current;
 518         for (;;) {
 519                 prev_used = max_kstack_used;
 520                 if (prev_used >= used)
 521                         break;
 522                 if (atomic_cmpset_int(&max_kstack_used, prev_used, used))
 523                         break;
 524         }
 525 }
 526 #endif /* KSTACK_USAGE_PROF */
 527
 528 /*
 529  * Implement fork's actions on an address space.
 530  * Here we arrange for the address space to be copied or referenced,
 531  * allocate a user struct (pcb and kernel stack), then call the
 532  * machine-dependent layer to fill those in and make the new process
 533  * ready to run.  The new process is set up so that it returns directly
 534  * to user mode to avoid stack copying and relocation problems.
 535  */
 536 int
 537 vm_forkproc(struct thread *td, struct proc *p2, struct thread *td2,
 538     struct vmspace *vm2, int flags)
 539 {
 540         struct proc *p1 = td->td_proc;
 541         struct domainset *dset;
 542         int error;
 543
 544         if ((flags & RFPROC) == 0) {
 545                 /*
 546                  * Divorce the memory, if it is shared, essentially
 547                  * this changes shared memory amongst threads, into
 548                  * COW locally.
 549                  */
 550                 if ((flags & RFMEM) == 0) {
 551                         if (p1->p_vmspace->vm_refcnt > 1) {
 552                                 error = vmspace_unshare(p1);
 553                                 if (error)
 554                                         return (error);
 555                         }
 556                 }
 557                 cpu_fork(td, p2, td2, flags);
 558                 return (0);
 559         }
 560
 561         if (flags & RFMEM) {
 562                 p2->p_vmspace = p1->p_vmspace;
 563                 atomic_add_int(&p1->p_vmspace->vm_refcnt, 1);
 564         }
 565         dset = td2->td_domain.dr_policy;
 566         while (vm_page_count_severe_set(&dset->ds_mask)) {
 567                 vm_wait_doms(&dset->ds_mask);
 568         }
 569
 570         if ((flags & RFMEM) == 0) {
 571                 p2->p_vmspace = vm2;
 572                 if (p1->p_vmspace->vm_shm)
 573                         shmfork(p1, p2);
 574         }
 575
 576         /*
 577          * cpu_fork will copy and update the pcb, set up the kernel stack,
 578          * and make the child ready to run.
 579          */
 580         cpu_fork(td, p2, td2, flags);
 581         return (0);
 582 }
 583
 584 /*
 585  * Called after process has been wait(2)'ed upon and is being reaped.
 586  * The idea is to reclaim resources that we could not reclaim while
 587  * the process was still executing.
 588  */
 589 void
 590 vm_waitproc(p)
 591         struct proc *p;
 592 {
 593
 594         vmspace_exitfree(p);            /* and clean-out the vmspace */
 595 }
 596
 597 void
 598 kick_proc0(void)
 599 {
 600
 601         wakeup(&proc0);
 602 }