* Use SYSREF for vmspace structures. This replaces the vmspace structure's
[dragonfly.git] / sys / vm / vm_glue.c
1 /*
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      from: @(#)vm_glue.c     8.6 (Berkeley) 1/5/94
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
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: src/sys/vm/vm_glue.c,v 1.94.2.4 2003/01/13 22:51:17 dillon Exp $
63  * $DragonFly: src/sys/vm/vm_glue.c,v 1.54 2007/04/29 18:25:41 dillon Exp $
64  */
65
66 #include "opt_vm.h"
67
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/proc.h>
71 #include <sys/resourcevar.h>
72 #include <sys/buf.h>
73 #include <sys/shm.h>
74 #include <sys/vmmeter.h>
75 #include <sys/sysctl.h>
76
77 #include <sys/kernel.h>
78 #include <sys/unistd.h>
79
80 #include <machine/limits.h>
81
82 #include <vm/vm.h>
83 #include <vm/vm_param.h>
84 #include <sys/lock.h>
85 #include <vm/pmap.h>
86 #include <vm/vm_map.h>
87 #include <vm/vm_page.h>
88 #include <vm/vm_pageout.h>
89 #include <vm/vm_kern.h>
90 #include <vm/vm_extern.h>
91
92 #include <sys/user.h>
93 #include <vm/vm_page2.h>
94 #include <sys/thread2.h>
95 #include <sys/sysref2.h>
96
97 /*
98  * System initialization
99  *
100  * Note: proc0 from proc.h
101  */
102
103 static void vm_init_limits (void *);
104 SYSINIT(vm_limits, SI_SUB_VM_CONF, SI_ORDER_FIRST, vm_init_limits, &proc0)
105
106 /*
107  * THIS MUST BE THE LAST INITIALIZATION ITEM!!!
108  *
109  * Note: run scheduling should be divorced from the vm system.
110  */
111 static void scheduler (void *);
112 SYSINIT(scheduler, SI_SUB_RUN_SCHEDULER, SI_ORDER_FIRST, scheduler, NULL)
113
114 #ifdef INVARIANTS
115
116 static int swap_debug = 0;
117 SYSCTL_INT(_vm, OID_AUTO, swap_debug,
118         CTLFLAG_RW, &swap_debug, 0, "");
119
120 #endif
121
122 static int scheduler_notify;
123
124 static void swapout (struct proc *);
125
126 int
127 kernacc(c_caddr_t addr, int len, int rw)
128 {
129         boolean_t rv;
130         vm_offset_t saddr, eaddr;
131         vm_prot_t prot;
132
133         KASSERT((rw & (~VM_PROT_ALL)) == 0,
134             ("illegal ``rw'' argument to kernacc (%x)\n", rw));
135
136         /*
137          * The globaldata space is not part of the kernel_map proper,
138          * check access separately.
139          */
140         if (is_globaldata_space((vm_offset_t)addr, (vm_offset_t)(addr + len)))
141                 return (TRUE);
142
143         /*
144          * Nominal kernel memory access - check access via kernel_map.
145          */
146         if ((vm_offset_t)addr + len > kernel_map.max_offset ||
147             (vm_offset_t)addr + len < (vm_offset_t)addr) {
148                 return (FALSE);
149         }
150         prot = rw;
151         saddr = trunc_page((vm_offset_t)addr);
152         eaddr = round_page((vm_offset_t)addr + len);
153         vm_map_lock_read(&kernel_map);
154         rv = vm_map_check_protection(&kernel_map, saddr, eaddr, prot);
155         vm_map_unlock_read(&kernel_map);
156         return (rv == TRUE);
157 }
158
159 int
160 useracc(c_caddr_t addr, int len, int rw)
161 {
162         boolean_t rv;
163         vm_prot_t prot;
164         vm_map_t map;
165         vm_map_entry_t save_hint;
166
167         KASSERT((rw & (~VM_PROT_ALL)) == 0,
168             ("illegal ``rw'' argument to useracc (%x)\n", rw));
169         prot = rw;
170         /*
171          * XXX - check separately to disallow access to user area and user
172          * page tables - they are in the map.
173          *
174          * XXX - VM_MAX_USER_ADDRESS is an end address, not a max.  It was once
175          * only used (as an end address) in trap.c.  Use it as an end address
176          * here too.  This bogusness has spread.  I just fixed where it was
177          * used as a max in vm_mmap.c.
178          */
179         if ((vm_offset_t) addr + len > /* XXX */ VM_MAX_USER_ADDRESS
180             || (vm_offset_t) addr + len < (vm_offset_t) addr) {
181                 return (FALSE);
182         }
183         map = &curproc->p_vmspace->vm_map;
184         vm_map_lock_read(map);
185         /*
186          * We save the map hint, and restore it.  Useracc appears to distort
187          * the map hint unnecessarily.
188          */
189         save_hint = map->hint;
190         rv = vm_map_check_protection(map,
191             trunc_page((vm_offset_t)addr), round_page((vm_offset_t)addr + len), prot);
192         map->hint = save_hint;
193         vm_map_unlock_read(map);
194         
195         return (rv == TRUE);
196 }
197
198 void
199 vslock(caddr_t addr, u_int len)
200 {
201         if (len) {
202                 vm_map_wire(&curproc->p_vmspace->vm_map,
203                             trunc_page((vm_offset_t)addr),
204                             round_page((vm_offset_t)addr + len), 0);
205         }
206 }
207
208 void
209 vsunlock(caddr_t addr, u_int len)
210 {
211         if (len) {
212                 vm_map_wire(&curproc->p_vmspace->vm_map,
213                             trunc_page((vm_offset_t)addr),
214                             round_page((vm_offset_t)addr + len),
215                             KM_PAGEABLE);
216         }
217 }
218
219 /*
220  * Implement fork's actions on an address space.
221  * Here we arrange for the address space to be copied or referenced,
222  * allocate a user struct (pcb and kernel stack), then call the
223  * machine-dependent layer to fill those in and make the new process
224  * ready to run.  The new process is set up so that it returns directly
225  * to user mode to avoid stack copying and relocation problems.
226  */
227 void
228 vm_fork(struct proc *p1, struct proc *p2, int flags)
229 {
230         if ((flags & RFPROC) == 0) {
231                 /*
232                  * Divorce the memory, if it is shared, essentially
233                  * this changes shared memory amongst threads, into
234                  * COW locally.
235                  */
236                 if ((flags & RFMEM) == 0) {
237                         if (p1->p_vmspace->vm_sysref.refcnt > 1) {
238                                 vmspace_unshare(p1);
239                         }
240                 }
241                 cpu_fork(ONLY_LWP_IN_PROC(p1), NULL, flags);
242                 return;
243         }
244
245         if (flags & RFMEM) {
246                 p2->p_vmspace = p1->p_vmspace;
247                 sysref_get(&p1->p_vmspace->vm_sysref);
248         }
249
250         while (vm_page_count_severe()) {
251                 vm_wait();
252         }
253
254         if ((flags & RFMEM) == 0) {
255                 p2->p_vmspace = vmspace_fork(p1->p_vmspace);
256
257                 pmap_pinit2(vmspace_pmap(p2->p_vmspace));
258
259                 if (p1->p_vmspace->vm_shm)
260                         shmfork(p1, p2);
261         }
262
263         pmap_init_proc(p2);
264 }
265
266 /*
267  * Called after process has been wait(2)'ed apon and is being reaped.
268  * The idea is to reclaim resources that we could not reclaim while  
269  * the process was still executing.
270  */
271 void
272 vm_waitproc(struct proc *p)
273 {
274         cpu_proc_wait(p);
275         vmspace_exitfree(p);    /* and clean-out the vmspace */
276 }
277
278 /*
279  * Set default limits for VM system.
280  * Called for proc 0, and then inherited by all others.
281  *
282  * XXX should probably act directly on proc0.
283  */
284 static void
285 vm_init_limits(void *udata)
286 {
287         struct proc *p = udata;
288         int rss_limit;
289
290         /*
291          * Set up the initial limits on process VM. Set the maximum resident
292          * set size to be half of (reasonably) available memory.  Since this
293          * is a soft limit, it comes into effect only when the system is out
294          * of memory - half of main memory helps to favor smaller processes,
295          * and reduces thrashing of the object cache.
296          */
297         p->p_rlimit[RLIMIT_STACK].rlim_cur = dflssiz;
298         p->p_rlimit[RLIMIT_STACK].rlim_max = maxssiz;
299         p->p_rlimit[RLIMIT_DATA].rlim_cur = dfldsiz;
300         p->p_rlimit[RLIMIT_DATA].rlim_max = maxdsiz;
301         /* limit the limit to no less than 2MB */
302         rss_limit = max(vmstats.v_free_count, 512);
303         p->p_rlimit[RLIMIT_RSS].rlim_cur = ptoa(rss_limit);
304         p->p_rlimit[RLIMIT_RSS].rlim_max = RLIM_INFINITY;
305 }
306
307 /*
308  * Faultin the specified process.  Note that the process can be in any
309  * state.  Just clear P_SWAPPEDOUT and call wakeup in case the process is
310  * sleeping.
311  */
312 void
313 faultin(struct proc *p)
314 {
315         if (p->p_flag & P_SWAPPEDOUT) {
316                 /*
317                  * The process is waiting in the kernel to return to user
318                  * mode but cannot until P_SWAPPEDOUT gets cleared.
319                  */
320                 crit_enter();
321                 p->p_flag &= ~(P_SWAPPEDOUT | P_SWAPWAIT);
322 #ifdef INVARIANTS
323                 if (swap_debug)
324                         kprintf("swapping in %d (%s)\n", p->p_pid, p->p_comm);
325 #endif
326                 wakeup(p);
327
328                 crit_exit();
329         }
330 }
331
332 /*
333  * Kernel initialization eventually falls through to this function,
334  * which is process 0.
335  *
336  * This swapin algorithm attempts to swap-in processes only if there
337  * is enough space for them.  Of course, if a process waits for a long
338  * time, it will be swapped in anyway.
339  */
340
341 struct scheduler_info {
342         struct proc *pp;
343         int ppri;
344 };
345
346 static int scheduler_callback(struct proc *p, void *data);
347
348 static void
349 scheduler(void *dummy)
350 {
351         struct scheduler_info info;
352         struct proc *p;
353
354         KKASSERT(!IN_CRITICAL_SECT(curthread));
355 loop:
356         scheduler_notify = 0;
357         /*
358          * Don't try to swap anything in if we are low on memory.
359          */
360         if (vm_page_count_min()) {
361                 vm_wait();
362                 goto loop;
363         }
364
365         /*
366          * Look for a good candidate to wake up
367          */
368         info.pp = NULL;
369         info.ppri = INT_MIN;
370         allproc_scan(scheduler_callback, &info);
371
372         /*
373          * Nothing to do, back to sleep for at least 1/10 of a second.  If
374          * we are woken up, immediately process the next request.  If
375          * multiple requests have built up the first is processed 
376          * immediately and the rest are staggered.
377          */
378         if ((p = info.pp) == NULL) {
379                 tsleep(&proc0, 0, "nowork", hz / 10);
380                 if (scheduler_notify == 0)
381                         tsleep(&scheduler_notify, 0, "nowork", 0);
382                 goto loop;
383         }
384
385         /*
386          * Fault the selected process in, then wait for a short period of
387          * time and loop up.
388          *
389          * XXX we need a heuristic to get a measure of system stress and
390          * then adjust our stagger wakeup delay accordingly.
391          */
392         faultin(p);
393         p->p_swtime = 0;
394         PRELE(p);
395         tsleep(&proc0, 0, "swapin", hz / 10);
396         goto loop;
397 }
398
399 static int
400 scheduler_callback(struct proc *p, void *data)
401 {
402         struct scheduler_info *info = data;
403         struct lwp *lp;
404         segsz_t pgs;
405         int pri;
406
407         if (p->p_flag & P_SWAPWAIT) {
408                 pri = 0;
409                 FOREACH_LWP_IN_PROC(lp, p) {
410                         /* XXX lwp might need a different metric */
411                         pri += lp->lwp_slptime;
412                 }
413                 pri += p->p_swtime - p->p_nice * 8;
414
415                 /*
416                  * The more pages paged out while we were swapped,
417                  * the more work we have to do to get up and running
418                  * again and the lower our wakeup priority.
419                  *
420                  * Each second of sleep time is worth ~1MB
421                  */
422                 pgs = vmspace_resident_count(p->p_vmspace);
423                 if (pgs < p->p_vmspace->vm_swrss) {
424                         pri -= (p->p_vmspace->vm_swrss - pgs) /
425                                 (1024 * 1024 / PAGE_SIZE);
426                 }
427
428                 /*
429                  * If this process is higher priority and there is
430                  * enough space, then select this process instead of
431                  * the previous selection.
432                  */
433                 if (pri > info->ppri) {
434                         if (info->pp)
435                                 PRELE(info->pp);
436                         PHOLD(p);
437                         info->pp = p;
438                         info->ppri = pri;
439                 }
440         }
441         return(0);
442 }
443
444 void
445 swapin_request(void)
446 {
447         if (scheduler_notify == 0) {
448                 scheduler_notify = 1;
449                 wakeup(&scheduler_notify);
450         }
451 }
452
453 #ifndef NO_SWAPPING
454
455 #define swappable(p) \
456         (((p)->p_lock == 0) && \
457         ((p)->p_flag & (P_TRACED|P_SYSTEM|P_SWAPPEDOUT|P_WEXIT)) == 0)
458
459
460 /*
461  * Swap_idle_threshold1 is the guaranteed swapped in time for a process
462  */
463 static int swap_idle_threshold1 = 15;
464 SYSCTL_INT(_vm, OID_AUTO, swap_idle_threshold1,
465         CTLFLAG_RW, &swap_idle_threshold1, 0, "");
466
467 /*
468  * Swap_idle_threshold2 is the time that a process can be idle before
469  * it will be swapped out, if idle swapping is enabled.  Default is
470  * one minute.
471  */
472 static int swap_idle_threshold2 = 60;
473 SYSCTL_INT(_vm, OID_AUTO, swap_idle_threshold2,
474         CTLFLAG_RW, &swap_idle_threshold2, 0, "");
475
476 /*
477  * Swapout is driven by the pageout daemon.  Very simple, we find eligible
478  * procs and mark them as being swapped out.  This will cause the kernel
479  * to prefer to pageout those proc's pages first and the procs in question 
480  * will not return to user mode until the swapper tells them they can.
481  *
482  * If any procs have been sleeping/stopped for at least maxslp seconds,
483  * they are swapped.  Else, we swap the longest-sleeping or stopped process,
484  * if any, otherwise the longest-resident process.
485  */
486
487 static int swapout_procs_callback(struct proc *p, void *data);
488
489 void
490 swapout_procs(int action)
491 {
492         allproc_scan(swapout_procs_callback, &action);
493 }
494
495 static int
496 swapout_procs_callback(struct proc *p, void *data)
497 {
498         struct vmspace *vm;
499         struct lwp *lp;
500         int action = *(int *)data;
501         int minslp = -1;
502
503         if (!swappable(p))
504                 return(0);
505
506         vm = p->p_vmspace;
507
508         /*
509          * We only consider active processes.
510          */
511         if (p->p_stat != SACTIVE && p->p_stat != SSTOP)
512                 return(0);
513
514         FOREACH_LWP_IN_PROC(lp, p) {
515                 /*
516                  * do not swap out a realtime process
517                  */
518                 if (RTP_PRIO_IS_REALTIME(lp->lwp_rtprio.type))
519                         return(0);
520
521                 /*
522                  * Guarentee swap_idle_threshold time in memory
523                  */
524                 if (lp->lwp_slptime < swap_idle_threshold1)
525                         return(0);
526
527                 /*
528                  * If the system is under memory stress, or if we
529                  * are swapping idle processes >= swap_idle_threshold2,
530                  * then swap the process out.
531                  */
532                 if (((action & VM_SWAP_NORMAL) == 0) &&
533                     (((action & VM_SWAP_IDLE) == 0) ||
534                      (lp->lwp_slptime < swap_idle_threshold2))) {
535                         return(0);
536                 }
537
538                 if (minslp == -1 || lp->lwp_slptime < minslp)
539                         minslp = lp->lwp_slptime;
540         }
541
542         sysref_get(&vm->vm_sysref);
543
544         /*
545          * If the process has been asleep for awhile, swap
546          * it out.
547          */
548         if ((action & VM_SWAP_NORMAL) ||
549             ((action & VM_SWAP_IDLE) &&
550              (minslp > swap_idle_threshold2))) {
551                 swapout(p);
552         }
553
554         /*
555          * cleanup our reference
556          */
557         sysref_put(&vm->vm_sysref);
558
559         return(0);
560 }
561
562 static void
563 swapout(struct proc *p)
564 {
565 #ifdef INVARIANTS
566         if (swap_debug)
567                 kprintf("swapping out %d (%s)\n", p->p_pid, p->p_comm);
568 #endif
569         ++p->p_ru.ru_nswap;
570         /*
571          * remember the process resident count
572          */
573         p->p_vmspace->vm_swrss = vmspace_resident_count(p->p_vmspace);
574         p->p_flag |= P_SWAPPEDOUT;
575         p->p_swtime = 0;
576 }
577
578 #endif /* !NO_SWAPPING */
579