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/vmmeter.h>
  84 #include <sys/vmem.h>
  85 #include <sys/sx.h>
  86 #include <sys/sysctl.h>
  87 #include <sys/_kstack_cache.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/vm.h>
  94 #include <vm/vm_param.h>
  95 #include <vm/pmap.h>
  96 #include <vm/vm_domainset.h>
  97 #include <vm/vm_map.h>
  98 #include <vm/vm_page.h>
  99 #include <vm/vm_pageout.h>
 100 #include <vm/vm_object.h>
 101 #include <vm/vm_kern.h>
 102 #include <vm/vm_extern.h>
 103 #include <vm/vm_pager.h>
 104 #include <vm/swap_pager.h>
 105
 106 #include <machine/cpu.h>
 107
 108 /*
 109  * MPSAFE
 110  *
 111  * WARNING!  This code calls vm_map_check_protection() which only checks
 112  * the associated vm_map_entry range.  It does not determine whether the
 113  * contents of the memory is actually readable or writable.  In most cases
 114  * just checking the vm_map_entry is sufficient within the kernel's address
 115  * space.
 116  */
 117 int
 118 kernacc(void *addr, int len, int rw)
 119 {
 120         boolean_t rv;
 121         vm_offset_t saddr, eaddr;
 122         vm_prot_t prot;
 123
 124         KASSERT((rw & ~VM_PROT_ALL) == 0,
 125             ("illegal ``rw'' argument to kernacc (%x)\n", rw));
 126
 127         if ((vm_offset_t)addr + len > vm_map_max(kernel_map) ||
 128             (vm_offset_t)addr + len < (vm_offset_t)addr)
 129                 return (FALSE);
 130
 131         prot = rw;
 132         saddr = trunc_page((vm_offset_t)addr);
 133         eaddr = round_page((vm_offset_t)addr + len);
 134         vm_map_lock_read(kernel_map);
 135         rv = vm_map_check_protection(kernel_map, saddr, eaddr, prot);
 136         vm_map_unlock_read(kernel_map);
 137         return (rv == TRUE);
 138 }
 139
 140 /*
 141  * MPSAFE
 142  *
 143  * WARNING!  This code calls vm_map_check_protection() which only checks
 144  * the associated vm_map_entry range.  It does not determine whether the
 145  * contents of the memory is actually readable or writable.  vmapbuf(),
 146  * vm_fault_quick(), or copyin()/copout()/su*()/fu*() functions should be
 147  * used in conjunction with this call.
 148  */
 149 int
 150 useracc(void *addr, int len, int rw)
 151 {
 152         boolean_t rv;
 153         vm_prot_t prot;
 154         vm_map_t map;
 155
 156         KASSERT((rw & ~VM_PROT_ALL) == 0,
 157             ("illegal ``rw'' argument to useracc (%x)\n", rw));
 158         prot = rw;
 159         map = &curproc->p_vmspace->vm_map;
 160         if ((vm_offset_t)addr + len > vm_map_max(map) ||
 161             (vm_offset_t)addr + len < (vm_offset_t)addr) {
 162                 return (FALSE);
 163         }
 164         vm_map_lock_read(map);
 165         rv = vm_map_check_protection(map, trunc_page((vm_offset_t)addr),
 166             round_page((vm_offset_t)addr + len), prot);
 167         vm_map_unlock_read(map);
 168         return (rv == TRUE);
 169 }
 170
 171 int
 172 vslock(void *addr, size_t len)
 173 {
 174         vm_offset_t end, last, start;
 175         vm_size_t npages;
 176         int error;
 177
 178         last = (vm_offset_t)addr + len;
 179         start = trunc_page((vm_offset_t)addr);
 180         end = round_page(last);
 181         if (last < (vm_offset_t)addr || end < (vm_offset_t)addr)
 182                 return (EINVAL);
 183         npages = atop(end - start);
 184         if (npages > vm_page_max_user_wired)
 185                 return (ENOMEM);
 186         error = vm_map_wire(&curproc->p_vmspace->vm_map, start, end,
 187             VM_MAP_WIRE_SYSTEM | VM_MAP_WIRE_NOHOLES);
 188         if (error == KERN_SUCCESS) {
 189                 curthread->td_vslock_sz += len;
 190                 return (0);
 191         }
 192
 193         /*
 194          * Return EFAULT on error to match copy{in,out}() behaviour
 195          * rather than returning ENOMEM like mlock() would.
 196          */
 197         return (EFAULT);
 198 }
 199
 200 void
 201 vsunlock(void *addr, size_t len)
 202 {
 203
 204         /* Rely on the parameter sanity checks performed by vslock(). */
 205         MPASS(curthread->td_vslock_sz >= len);
 206         curthread->td_vslock_sz -= len;
 207         (void)vm_map_unwire(&curproc->p_vmspace->vm_map,
 208             trunc_page((vm_offset_t)addr), round_page((vm_offset_t)addr + len),
 209             VM_MAP_WIRE_SYSTEM | VM_MAP_WIRE_NOHOLES);
 210 }
 211
 212 /*
 213  * Pin the page contained within the given object at the given offset.  If the
 214  * page is not resident, allocate and load it using the given object's pager.
 215  * Return the pinned page if successful; otherwise, return NULL.
 216  */
 217 static vm_page_t
 218 vm_imgact_hold_page(vm_object_t object, vm_ooffset_t offset)
 219 {
 220         vm_page_t m;
 221         vm_pindex_t pindex;
 222         int rv;
 223
 224         VM_OBJECT_WLOCK(object);
 225         pindex = OFF_TO_IDX(offset);
 226         m = vm_page_grab(object, pindex, VM_ALLOC_NORMAL | VM_ALLOC_NOBUSY |
 227             VM_ALLOC_WIRED);
 228         if (m->valid != VM_PAGE_BITS_ALL) {
 229                 vm_page_xbusy(m);
 230                 rv = vm_pager_get_pages(object, &m, 1, NULL, NULL);
 231                 if (rv != VM_PAGER_OK) {
 232                         vm_page_lock(m);
 233                         vm_page_unwire(m, PQ_NONE);
 234                         vm_page_free(m);
 235                         vm_page_unlock(m);
 236                         m = NULL;
 237                         goto out;
 238                 }
 239                 vm_page_xunbusy(m);
 240         }
 241 out:
 242         VM_OBJECT_WUNLOCK(object);
 243         return (m);
 244 }
 245
 246 /*
 247  * Return a CPU private mapping to the page at the given offset within the
 248  * given object.  The page is pinned before it is mapped.
 249  */
 250 struct sf_buf *
 251 vm_imgact_map_page(vm_object_t object, vm_ooffset_t offset)
 252 {
 253         vm_page_t m;
 254
 255         m = vm_imgact_hold_page(object, offset);
 256         if (m == NULL)
 257                 return (NULL);
 258         sched_pin();
 259         return (sf_buf_alloc(m, SFB_CPUPRIVATE));
 260 }
 261
 262 /*
 263  * Destroy the given CPU private mapping and unpin the page that it mapped.
 264  */
 265 void
 266 vm_imgact_unmap_page(struct sf_buf *sf)
 267 {
 268         vm_page_t m;
 269
 270         m = sf_buf_page(sf);
 271         sf_buf_free(sf);
 272         sched_unpin();
 273         vm_page_lock(m);
 274         vm_page_unwire(m, PQ_ACTIVE);
 275         vm_page_unlock(m);
 276 }
 277
 278 void
 279 vm_sync_icache(vm_map_t map, vm_offset_t va, vm_offset_t sz)
 280 {
 281
 282         pmap_sync_icache(map->pmap, va, sz);
 283 }
 284
 285 struct kstack_cache_entry *kstack_cache;
 286 static int kstack_cache_size = 128;
 287 static int kstacks, kstack_domain_iter;
 288 static struct mtx kstack_cache_mtx;
 289 MTX_SYSINIT(kstack_cache, &kstack_cache_mtx, "kstkch", MTX_DEF);
 290
 291 SYSCTL_INT(_vm, OID_AUTO, kstack_cache_size, CTLFLAG_RW, &kstack_cache_size, 0,
 292     "");
 293 SYSCTL_INT(_vm, OID_AUTO, kstacks, CTLFLAG_RD, &kstacks, 0,
 294     "");
 295
 296 /*
 297  * Create the kernel stack (including pcb for i386) for a new thread.
 298  * This routine directly affects the fork perf for a process and
 299  * create performance for a thread.
 300  */
 301 int
 302 vm_thread_new(struct thread *td, int pages)
 303 {
 304         vm_object_t ksobj;
 305         vm_offset_t ks;
 306         vm_page_t ma[KSTACK_MAX_PAGES];
 307         struct kstack_cache_entry *ks_ce;
 308         int i;
 309
 310         /* Bounds check */
 311         if (pages <= 1)
 312                 pages = kstack_pages;
 313         else if (pages > KSTACK_MAX_PAGES)
 314                 pages = KSTACK_MAX_PAGES;
 315
 316         if (pages == kstack_pages && kstack_cache != NULL) {
 317                 mtx_lock(&kstack_cache_mtx);
 318                 if (kstack_cache != NULL) {
 319                         ks_ce = kstack_cache;
 320                         kstack_cache = ks_ce->next_ks_entry;
 321                         mtx_unlock(&kstack_cache_mtx);
 322
 323                         td->td_kstack_obj = ks_ce->ksobj;
 324                         td->td_kstack = (vm_offset_t)ks_ce;
 325                         td->td_kstack_pages = kstack_pages;
 326                         return (1);
 327                 }
 328                 mtx_unlock(&kstack_cache_mtx);
 329         }
 330
 331         /*
 332          * Allocate an object for the kstack.
 333          */
 334         ksobj = vm_object_allocate(OBJT_DEFAULT, pages);
 335
 336         /*
 337          * Get a kernel virtual address for this thread's kstack.
 338          */
 339 #if defined(__mips__)
 340         /*
 341          * We need to align the kstack's mapped address to fit within
 342          * a single TLB entry.
 343          */
 344         if (vmem_xalloc(kernel_arena, (pages + KSTACK_GUARD_PAGES) * PAGE_SIZE,
 345             PAGE_SIZE * 2, 0, 0, VMEM_ADDR_MIN, VMEM_ADDR_MAX,
 346             M_BESTFIT | M_NOWAIT, &ks)) {
 347                 ks = 0;
 348         }
 349 #else
 350         ks = kva_alloc((pages + KSTACK_GUARD_PAGES) * PAGE_SIZE);
 351 #endif
 352         if (ks == 0) {
 353                 printf("vm_thread_new: kstack allocation failed\n");
 354                 vm_object_deallocate(ksobj);
 355                 return (0);
 356         }
 357
 358         /*
 359          * Ensure that kstack objects can draw pages from any memory
 360          * domain.  Otherwise a local memory shortage can block a process
 361          * swap-in.
 362          */
 363         if (vm_ndomains > 1) {
 364                 ksobj->domain.dr_policy = DOMAINSET_RR();
 365                 ksobj->domain.dr_iter =
 366                     atomic_fetchadd_int(&kstack_domain_iter, 1);
 367         }
 368
 369         atomic_add_int(&kstacks, 1);
 370         if (KSTACK_GUARD_PAGES != 0) {
 371                 pmap_qremove(ks, KSTACK_GUARD_PAGES);
 372                 ks += KSTACK_GUARD_PAGES * PAGE_SIZE;
 373         }
 374         td->td_kstack_obj = ksobj;
 375         td->td_kstack = ks;
 376         /*
 377          * Knowing the number of pages allocated is useful when you
 378          * want to deallocate them.
 379          */
 380         td->td_kstack_pages = pages;
 381         /*
 382          * For the length of the stack, link in a real page of ram for each
 383          * page of stack.
 384          */
 385         VM_OBJECT_WLOCK(ksobj);
 386         (void)vm_page_grab_pages(ksobj, 0, VM_ALLOC_NORMAL | VM_ALLOC_NOBUSY |
 387             VM_ALLOC_WIRED, ma, pages);
 388         for (i = 0; i < pages; i++)
 389                 ma[i]->valid = VM_PAGE_BITS_ALL;
 390         VM_OBJECT_WUNLOCK(ksobj);
 391         pmap_qenter(ks, ma, pages);
 392         return (1);
 393 }
 394
 395 static void
 396 vm_thread_stack_dispose(vm_object_t ksobj, vm_offset_t ks, int pages)
 397 {
 398         vm_page_t m;
 399         int i;
 400
 401         atomic_add_int(&kstacks, -1);
 402         pmap_qremove(ks, pages);
 403         VM_OBJECT_WLOCK(ksobj);
 404         for (i = 0; i < pages; i++) {
 405                 m = vm_page_lookup(ksobj, i);
 406                 if (m == NULL)
 407                         panic("vm_thread_dispose: kstack already missing?");
 408                 vm_page_lock(m);
 409                 vm_page_unwire_noq(m);
 410                 vm_page_free(m);
 411                 vm_page_unlock(m);
 412         }
 413         VM_OBJECT_WUNLOCK(ksobj);
 414         vm_object_deallocate(ksobj);
 415         kva_free(ks - (KSTACK_GUARD_PAGES * PAGE_SIZE),
 416             (pages + KSTACK_GUARD_PAGES) * PAGE_SIZE);
 417 }
 418
 419 /*
 420  * Dispose of a thread's kernel stack.
 421  */
 422 void
 423 vm_thread_dispose(struct thread *td)
 424 {
 425         vm_object_t ksobj;
 426         vm_offset_t ks;
 427         struct kstack_cache_entry *ks_ce;
 428         int pages;
 429
 430         pages = td->td_kstack_pages;
 431         ksobj = td->td_kstack_obj;
 432         ks = td->td_kstack;
 433         td->td_kstack = 0;
 434         td->td_kstack_pages = 0;
 435         if (pages == kstack_pages && kstacks <= kstack_cache_size) {
 436                 ks_ce = (struct kstack_cache_entry *)ks;
 437                 ks_ce->ksobj = ksobj;
 438                 mtx_lock(&kstack_cache_mtx);
 439                 ks_ce->next_ks_entry = kstack_cache;
 440                 kstack_cache = ks_ce;
 441                 mtx_unlock(&kstack_cache_mtx);
 442                 return;
 443         }
 444         vm_thread_stack_dispose(ksobj, ks, pages);
 445 }
 446
 447 static void
 448 vm_thread_stack_lowmem(void *nulll)
 449 {
 450         struct kstack_cache_entry *ks_ce, *ks_ce1;
 451
 452         mtx_lock(&kstack_cache_mtx);
 453         ks_ce = kstack_cache;
 454         kstack_cache = NULL;
 455         mtx_unlock(&kstack_cache_mtx);
 456
 457         while (ks_ce != NULL) {
 458                 ks_ce1 = ks_ce;
 459                 ks_ce = ks_ce->next_ks_entry;
 460
 461                 vm_thread_stack_dispose(ks_ce1->ksobj, (vm_offset_t)ks_ce1,
 462                     kstack_pages);
 463         }
 464 }
 465
 466 static void
 467 kstack_cache_init(void *nulll)
 468 {
 469
 470         EVENTHANDLER_REGISTER(vm_lowmem, vm_thread_stack_lowmem, NULL,
 471             EVENTHANDLER_PRI_ANY);
 472 }
 473
 474 SYSINIT(vm_kstacks, SI_SUB_KTHREAD_INIT, SI_ORDER_ANY, kstack_cache_init, NULL);
 475
 476 #ifdef KSTACK_USAGE_PROF
 477 /*
 478  * Track maximum stack used by a thread in kernel.
 479  */
 480 static int max_kstack_used;
 481
 482 SYSCTL_INT(_debug, OID_AUTO, max_kstack_used, CTLFLAG_RD,
 483     &max_kstack_used, 0,
 484     "Maxiumum stack depth used by a thread in kernel");
 485
 486 void
 487 intr_prof_stack_use(struct thread *td, struct trapframe *frame)
 488 {
 489         vm_offset_t stack_top;
 490         vm_offset_t current;
 491         int used, prev_used;
 492
 493         /*
 494          * Testing for interrupted kernel mode isn't strictly
 495          * needed. It optimizes the execution, since interrupts from
 496          * usermode will have only the trap frame on the stack.
 497          */
 498         if (TRAPF_USERMODE(frame))
 499                 return;
 500
 501         stack_top = td->td_kstack + td->td_kstack_pages * PAGE_SIZE;
 502         current = (vm_offset_t)(uintptr_t)&stack_top;
 503
 504         /*
 505          * Try to detect if interrupt is using kernel thread stack.
 506          * Hardware could use a dedicated stack for interrupt handling.
 507          */
 508         if (stack_top <= current || current < td->td_kstack)
 509                 return;
 510
 511         used = stack_top - current;
 512         for (;;) {
 513                 prev_used = max_kstack_used;
 514                 if (prev_used >= used)
 515                         break;
 516                 if (atomic_cmpset_int(&max_kstack_used, prev_used, used))
 517                         break;
 518         }
 519 }
 520 #endif /* KSTACK_USAGE_PROF */
 521
 522 /*
 523  * Implement fork's actions on an address space.
 524  * Here we arrange for the address space to be copied or referenced,
 525  * allocate a user struct (pcb and kernel stack), then call the
 526  * machine-dependent layer to fill those in and make the new process
 527  * ready to run.  The new process is set up so that it returns directly
 528  * to user mode to avoid stack copying and relocation problems.
 529  */
 530 int
 531 vm_forkproc(struct thread *td, struct proc *p2, struct thread *td2,
 532     struct vmspace *vm2, int flags)
 533 {
 534         struct proc *p1 = td->td_proc;
 535         struct domainset *dset;
 536         int error;
 537
 538         if ((flags & RFPROC) == 0) {
 539                 /*
 540                  * Divorce the memory, if it is shared, essentially
 541                  * this changes shared memory amongst threads, into
 542                  * COW locally.
 543                  */
 544                 if ((flags & RFMEM) == 0) {
 545                         if (p1->p_vmspace->vm_refcnt > 1) {
 546                                 error = vmspace_unshare(p1);
 547                                 if (error)
 548                                         return (error);
 549                         }
 550                 }
 551                 cpu_fork(td, p2, td2, flags);
 552                 return (0);
 553         }
 554
 555         if (flags & RFMEM) {
 556                 p2->p_vmspace = p1->p_vmspace;
 557                 atomic_add_int(&p1->p_vmspace->vm_refcnt, 1);
 558         }
 559         dset = td2->td_domain.dr_policy;
 560         while (vm_page_count_severe_set(&dset->ds_mask)) {
 561                 vm_wait_doms(&dset->ds_mask);
 562         }
 563
 564         if ((flags & RFMEM) == 0) {
 565                 p2->p_vmspace = vm2;
 566                 if (p1->p_vmspace->vm_shm)
 567                         shmfork(p1, p2);
 568         }
 569
 570         /*
 571          * cpu_fork will copy and update the pcb, set up the kernel stack,
 572          * and make the child ready to run.
 573          */
 574         cpu_fork(td, p2, td2, flags);
 575         return (0);
 576 }
 577
 578 /*
 579  * Called after process has been wait(2)'ed upon and is being reaped.
 580  * The idea is to reclaim resources that we could not reclaim while
 581  * the process was still executing.
 582  */
 583 void
 584 vm_waitproc(p)
 585         struct proc *p;
 586 {
 587
 588         vmspace_exitfree(p);            /* and clean-out the vmspace */
 589 }
 590
 591 void
 592 kick_proc0(void)
 593 {
 594
 595         wakeup(&proc0);
 596 }