Merge branch 'vendor/OPENSSH'
[dragonfly.git] / sys / vm / vm_page.c
1 /*
2  * Copyright (c) 1991 Regents of the University of California.
3  * 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_page.c     7.4 (Berkeley) 5/7/91
37  * $FreeBSD: src/sys/vm/vm_page.c,v 1.147.2.18 2002/03/10 05:03:19 alc Exp $
38  * $DragonFly: src/sys/vm/vm_page.c,v 1.40 2008/08/25 17:01:42 dillon Exp $
39  */
40
41 /*
42  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
43  * All rights reserved.
44  *
45  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
46  *
47  * Permission to use, copy, modify and distribute this software and
48  * its documentation is hereby granted, provided that both the copyright
49  * notice and this permission notice appear in all copies of the
50  * software, derivative works or modified versions, and any portions
51  * thereof, and that both notices appear in supporting documentation.
52  *
53  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
54  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
55  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
56  *
57  * Carnegie Mellon requests users of this software to return to
58  *
59  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
60  *  School of Computer Science
61  *  Carnegie Mellon University
62  *  Pittsburgh PA 15213-3890
63  *
64  * any improvements or extensions that they make and grant Carnegie the
65  * rights to redistribute these changes.
66  */
67 /*
68  * Resident memory management module.  The module manipulates 'VM pages'.
69  * A VM page is the core building block for memory management.
70  */
71
72 #include <sys/param.h>
73 #include <sys/systm.h>
74 #include <sys/malloc.h>
75 #include <sys/proc.h>
76 #include <sys/vmmeter.h>
77 #include <sys/vnode.h>
78
79 #include <vm/vm.h>
80 #include <vm/vm_param.h>
81 #include <sys/lock.h>
82 #include <vm/vm_kern.h>
83 #include <vm/pmap.h>
84 #include <vm/vm_map.h>
85 #include <vm/vm_object.h>
86 #include <vm/vm_page.h>
87 #include <vm/vm_pageout.h>
88 #include <vm/vm_pager.h>
89 #include <vm/vm_extern.h>
90 #include <vm/vm_page2.h>
91
92 #include <machine/md_var.h>
93
94 static void vm_page_queue_init(void);
95 static void vm_page_free_wakeup(void);
96 static vm_page_t vm_page_select_cache(vm_object_t, vm_pindex_t);
97 static vm_page_t _vm_page_list_find2(int basequeue, int index);
98
99 struct vpgqueues vm_page_queues[PQ_COUNT]; /* Array of tailq lists */
100
101 #define ASSERT_IN_CRIT_SECTION()        KKASSERT(crit_test(curthread));
102
103 RB_GENERATE2(vm_page_rb_tree, vm_page, rb_entry, rb_vm_page_compare,
104              vm_pindex_t, pindex);
105
106 static void
107 vm_page_queue_init(void) 
108 {
109         int i;
110
111         for (i = 0; i < PQ_L2_SIZE; i++)
112                 vm_page_queues[PQ_FREE+i].cnt = &vmstats.v_free_count;
113         for (i = 0; i < PQ_L2_SIZE; i++)
114                 vm_page_queues[PQ_CACHE+i].cnt = &vmstats.v_cache_count;
115
116         vm_page_queues[PQ_INACTIVE].cnt = &vmstats.v_inactive_count;
117         vm_page_queues[PQ_ACTIVE].cnt = &vmstats.v_active_count;
118         vm_page_queues[PQ_HOLD].cnt = &vmstats.v_active_count;
119         /* PQ_NONE has no queue */
120
121         for (i = 0; i < PQ_COUNT; i++)
122                 TAILQ_INIT(&vm_page_queues[i].pl);
123 }
124
125 /*
126  * note: place in initialized data section?  Is this necessary?
127  */
128 long first_page = 0;
129 int vm_page_array_size = 0;
130 int vm_page_zero_count = 0;
131 vm_page_t vm_page_array = 0;
132
133 /*
134  * (low level boot)
135  *
136  * Sets the page size, perhaps based upon the memory size.
137  * Must be called before any use of page-size dependent functions.
138  */
139 void
140 vm_set_page_size(void)
141 {
142         if (vmstats.v_page_size == 0)
143                 vmstats.v_page_size = PAGE_SIZE;
144         if (((vmstats.v_page_size - 1) & vmstats.v_page_size) != 0)
145                 panic("vm_set_page_size: page size not a power of two");
146 }
147
148 /*
149  * (low level boot)
150  *
151  * Add a new page to the freelist for use by the system.  New pages
152  * are added to both the head and tail of the associated free page
153  * queue in a bottom-up fashion, so both zero'd and non-zero'd page
154  * requests pull 'recent' adds (higher physical addresses) first.
155  *
156  * Must be called in a critical section.
157  */
158 vm_page_t
159 vm_add_new_page(vm_paddr_t pa)
160 {
161         struct vpgqueues *vpq;
162         vm_page_t m;
163
164         ++vmstats.v_page_count;
165         ++vmstats.v_free_count;
166         m = PHYS_TO_VM_PAGE(pa);
167         m->phys_addr = pa;
168         m->flags = 0;
169         m->pc = (pa >> PAGE_SHIFT) & PQ_L2_MASK;
170         m->queue = m->pc + PQ_FREE;
171         KKASSERT(m->dirty == 0);
172
173         vpq = &vm_page_queues[m->queue];
174         if (vpq->flipflop)
175                 TAILQ_INSERT_TAIL(&vpq->pl, m, pageq);
176         else
177                 TAILQ_INSERT_HEAD(&vpq->pl, m, pageq);
178         vpq->flipflop = 1 - vpq->flipflop;
179
180         vm_page_queues[m->queue].lcnt++;
181         return (m);
182 }
183
184 /*
185  * (low level boot)
186  *
187  * Initializes the resident memory module.
188  *
189  * Allocates memory for the page cells, and for the object/offset-to-page
190  * hash table headers.  Each page cell is initialized and placed on the
191  * free list.
192  *
193  * starta/enda represents the range of physical memory addresses available
194  * for use (skipping memory already used by the kernel), subject to
195  * phys_avail[].  Note that phys_avail[] has already mapped out memory
196  * already in use by the kernel.
197  */
198 vm_offset_t
199 vm_page_startup(vm_offset_t vaddr)
200 {
201         vm_offset_t mapped;
202         vm_size_t npages;
203         vm_paddr_t page_range;
204         vm_paddr_t new_end;
205         int i;
206         vm_paddr_t pa;
207         int nblocks;
208         vm_paddr_t last_pa;
209         vm_paddr_t end;
210         vm_paddr_t biggestone, biggestsize;
211         vm_paddr_t total;
212
213         total = 0;
214         biggestsize = 0;
215         biggestone = 0;
216         nblocks = 0;
217         vaddr = round_page(vaddr);
218
219         for (i = 0; phys_avail[i + 1]; i += 2) {
220                 phys_avail[i] = round_page(phys_avail[i]);
221                 phys_avail[i + 1] = trunc_page(phys_avail[i + 1]);
222         }
223
224         for (i = 0; phys_avail[i + 1]; i += 2) {
225                 vm_paddr_t size = phys_avail[i + 1] - phys_avail[i];
226
227                 if (size > biggestsize) {
228                         biggestone = i;
229                         biggestsize = size;
230                 }
231                 ++nblocks;
232                 total += size;
233         }
234
235         end = phys_avail[biggestone+1];
236         end = trunc_page(end);
237
238         /*
239          * Initialize the queue headers for the free queue, the active queue
240          * and the inactive queue.
241          */
242
243         vm_page_queue_init();
244
245         /* VKERNELs don't support minidumps and as such don't need vm_page_dump */
246 #if !defined(_KERNEL_VIRTUAL)
247         /*
248          * Allocate a bitmap to indicate that a random physical page
249          * needs to be included in a minidump.
250          *
251          * The amd64 port needs this to indicate which direct map pages
252          * need to be dumped, via calls to dump_add_page()/dump_drop_page().
253          *
254          * However, i386 still needs this workspace internally within the
255          * minidump code.  In theory, they are not needed on i386, but are
256          * included should the sf_buf code decide to use them.
257          */
258         page_range = phys_avail[(nblocks - 1) * 2 + 1] / PAGE_SIZE;
259         vm_page_dump_size = round_page(roundup2(page_range, NBBY) / NBBY);
260         end -= vm_page_dump_size;
261         vm_page_dump = (void *)pmap_map(&vaddr, end, end + vm_page_dump_size,
262             VM_PROT_READ | VM_PROT_WRITE);
263         bzero((void *)vm_page_dump, vm_page_dump_size);
264 #endif
265
266         /*
267          * Compute the number of pages of memory that will be available for
268          * use (taking into account the overhead of a page structure per
269          * page).
270          */
271         first_page = phys_avail[0] / PAGE_SIZE;
272         page_range = phys_avail[(nblocks - 1) * 2 + 1] / PAGE_SIZE - first_page;
273         npages = (total - (page_range * sizeof(struct vm_page))) / PAGE_SIZE;
274
275         /*
276          * Initialize the mem entry structures now, and put them in the free
277          * queue.
278          */
279         new_end = trunc_page(end - page_range * sizeof(struct vm_page));
280         mapped = pmap_map(&vaddr, new_end, end,
281             VM_PROT_READ | VM_PROT_WRITE);
282         vm_page_array = (vm_page_t)mapped;
283
284 #ifdef __x86_64__
285         /*
286          * since pmap_map on amd64 returns stuff out of a direct-map region,
287          * we have to manually add these pages to the minidump tracking so
288          * that they can be dumped, including the vm_page_array.
289          */
290         for (pa = new_end; pa < phys_avail[biggestone + 1]; pa += PAGE_SIZE)
291                 dump_add_page(pa);
292 #endif
293
294         /*
295          * Clear all of the page structures
296          */
297         bzero((caddr_t) vm_page_array, page_range * sizeof(struct vm_page));
298         vm_page_array_size = page_range;
299
300         /*
301          * Construct the free queue(s) in ascending order (by physical
302          * address) so that the first 16MB of physical memory is allocated
303          * last rather than first.  On large-memory machines, this avoids
304          * the exhaustion of low physical memory before isa_dmainit has run.
305          */
306         vmstats.v_page_count = 0;
307         vmstats.v_free_count = 0;
308         for (i = 0; phys_avail[i + 1] && npages > 0; i += 2) {
309                 pa = phys_avail[i];
310                 if (i == biggestone)
311                         last_pa = new_end;
312                 else
313                         last_pa = phys_avail[i + 1];
314                 while (pa < last_pa && npages-- > 0) {
315                         vm_add_new_page(pa);
316                         pa += PAGE_SIZE;
317                 }
318         }
319         return (vaddr);
320 }
321
322 /*
323  * Scan comparison function for Red-Black tree scans.  An inclusive
324  * (start,end) is expected.  Other fields are not used.
325  */
326 int
327 rb_vm_page_scancmp(struct vm_page *p, void *data)
328 {
329         struct rb_vm_page_scan_info *info = data;
330
331         if (p->pindex < info->start_pindex)
332                 return(-1);
333         if (p->pindex > info->end_pindex)
334                 return(1);
335         return(0);
336 }
337
338 int
339 rb_vm_page_compare(struct vm_page *p1, struct vm_page *p2)
340 {
341         if (p1->pindex < p2->pindex)
342                 return(-1);
343         if (p1->pindex > p2->pindex)
344                 return(1);
345         return(0);
346 }
347
348 /*
349  * The opposite of vm_page_hold().  A page can be freed while being held,
350  * which places it on the PQ_HOLD queue.  We must call vm_page_free_toq()
351  * in this case to actually free it once the hold count drops to 0.
352  *
353  * This routine must be called at splvm().
354  */
355 void
356 vm_page_unhold(vm_page_t mem)
357 {
358         --mem->hold_count;
359         KASSERT(mem->hold_count >= 0, ("vm_page_unhold: hold count < 0!!!"));
360         if (mem->hold_count == 0 && mem->queue == PQ_HOLD) {
361                 vm_page_busy(mem);
362                 vm_page_free_toq(mem);
363         }
364 }
365
366 /*
367  * Inserts the given mem entry into the object and object list.
368  *
369  * The pagetables are not updated but will presumably fault the page
370  * in if necessary, or if a kernel page the caller will at some point
371  * enter the page into the kernel's pmap.  We are not allowed to block
372  * here so we *can't* do this anyway.
373  *
374  * This routine may not block.
375  * This routine must be called with a critical section held.
376  */
377 void
378 vm_page_insert(vm_page_t m, vm_object_t object, vm_pindex_t pindex)
379 {
380         ASSERT_IN_CRIT_SECTION();
381         if (m->object != NULL)
382                 panic("vm_page_insert: already inserted");
383
384         /*
385          * Record the object/offset pair in this page
386          */
387         m->object = object;
388         m->pindex = pindex;
389
390         /*
391          * Insert it into the object.
392          */
393         vm_page_rb_tree_RB_INSERT(&object->rb_memq, m);
394         object->generation++;
395
396         /*
397          * show that the object has one more resident page.
398          */
399         object->resident_page_count++;
400
401         /*
402          * Since we are inserting a new and possibly dirty page,
403          * update the object's OBJ_WRITEABLE and OBJ_MIGHTBEDIRTY flags.
404          */
405         if ((m->valid & m->dirty) || (m->flags & PG_WRITEABLE))
406                 vm_object_set_writeable_dirty(object);
407 }
408
409 /*
410  * Removes the given vm_page_t from the global (object,index) hash table
411  * and from the object's memq.
412  *
413  * The underlying pmap entry (if any) is NOT removed here.
414  * This routine may not block.
415  *
416  * The page must be BUSY and will remain BUSY on return.  No spl needs to be
417  * held on call to this routine.
418  *
419  * note: FreeBSD side effect was to unbusy the page on return.  We leave
420  * it busy.
421  */
422 void
423 vm_page_remove(vm_page_t m)
424 {
425         vm_object_t object;
426
427         crit_enter();
428         if (m->object == NULL) {
429                 crit_exit();
430                 return;
431         }
432
433         if ((m->flags & PG_BUSY) == 0)
434                 panic("vm_page_remove: page not busy");
435
436         object = m->object;
437
438         /*
439          * Remove the page from the object and update the object.
440          */
441         vm_page_rb_tree_RB_REMOVE(&object->rb_memq, m);
442         object->resident_page_count--;
443         object->generation++;
444         m->object = NULL;
445
446         crit_exit();
447 }
448
449 /*
450  * Locate and return the page at (object, pindex), or NULL if the
451  * page could not be found.
452  *
453  * This routine will operate properly without spl protection, but
454  * the returned page could be in flux if it is busy.  Because an
455  * interrupt can race a caller's busy check (unbusying and freeing the
456  * page we return before the caller is able to check the busy bit),
457  * the caller should generally call this routine with a critical
458  * section held.
459  *
460  * Callers may call this routine without spl protection if they know
461  * 'for sure' that the page will not be ripped out from under them
462  * by an interrupt.
463  */
464 vm_page_t
465 vm_page_lookup(vm_object_t object, vm_pindex_t pindex)
466 {
467         vm_page_t m;
468
469         /*
470          * Search the hash table for this object/offset pair
471          */
472         crit_enter();
473         m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq, pindex);
474         crit_exit();
475         KKASSERT(m == NULL || (m->object == object && m->pindex == pindex));
476         return(m);
477 }
478
479 /*
480  * vm_page_rename()
481  *
482  * Move the given memory entry from its current object to the specified
483  * target object/offset.
484  *
485  * The object must be locked.
486  * This routine may not block.
487  *
488  * Note: This routine will raise itself to splvm(), the caller need not. 
489  *
490  * Note: Swap associated with the page must be invalidated by the move.  We
491  *       have to do this for several reasons:  (1) we aren't freeing the
492  *       page, (2) we are dirtying the page, (3) the VM system is probably
493  *       moving the page from object A to B, and will then later move
494  *       the backing store from A to B and we can't have a conflict.
495  *
496  * Note: We *always* dirty the page.  It is necessary both for the
497  *       fact that we moved it, and because we may be invalidating
498  *       swap.  If the page is on the cache, we have to deactivate it
499  *       or vm_page_dirty() will panic.  Dirty pages are not allowed
500  *       on the cache.
501  */
502 void
503 vm_page_rename(vm_page_t m, vm_object_t new_object, vm_pindex_t new_pindex)
504 {
505         crit_enter();
506         vm_page_remove(m);
507         vm_page_insert(m, new_object, new_pindex);
508         if (m->queue - m->pc == PQ_CACHE)
509                 vm_page_deactivate(m);
510         vm_page_dirty(m);
511         vm_page_wakeup(m);
512         crit_exit();
513 }
514
515 /*
516  * vm_page_unqueue() without any wakeup.  This routine is used when a page
517  * is being moved between queues or otherwise is to remain BUSYied by the
518  * caller.
519  *
520  * This routine must be called at splhigh().
521  * This routine may not block.
522  */
523 void
524 vm_page_unqueue_nowakeup(vm_page_t m)
525 {
526         int queue = m->queue;
527         struct vpgqueues *pq;
528
529         if (queue != PQ_NONE) {
530                 pq = &vm_page_queues[queue];
531                 m->queue = PQ_NONE;
532                 TAILQ_REMOVE(&pq->pl, m, pageq);
533                 (*pq->cnt)--;
534                 pq->lcnt--;
535         }
536 }
537
538 /*
539  * vm_page_unqueue() - Remove a page from its queue, wakeup the pagedemon
540  * if necessary.
541  *
542  * This routine must be called at splhigh().
543  * This routine may not block.
544  */
545 void
546 vm_page_unqueue(vm_page_t m)
547 {
548         int queue = m->queue;
549         struct vpgqueues *pq;
550
551         if (queue != PQ_NONE) {
552                 m->queue = PQ_NONE;
553                 pq = &vm_page_queues[queue];
554                 TAILQ_REMOVE(&pq->pl, m, pageq);
555                 (*pq->cnt)--;
556                 pq->lcnt--;
557                 if ((queue - m->pc) == PQ_CACHE || (queue - m->pc) == PQ_FREE)
558                         pagedaemon_wakeup();
559         }
560 }
561
562 /*
563  * vm_page_list_find()
564  *
565  * Find a page on the specified queue with color optimization.
566  *
567  * The page coloring optimization attempts to locate a page that does
568  * not overload other nearby pages in the object in the cpu's L1 or L2
569  * caches.  We need this optimization because cpu caches tend to be
570  * physical caches, while object spaces tend to be virtual.
571  *
572  * This routine must be called at splvm().
573  * This routine may not block.
574  *
575  * Note that this routine is carefully inlined.  A non-inlined version
576  * is available for outside callers but the only critical path is
577  * from within this source file.
578  */
579 static __inline
580 vm_page_t
581 _vm_page_list_find(int basequeue, int index, boolean_t prefer_zero)
582 {
583         vm_page_t m;
584
585         if (prefer_zero)
586                 m = TAILQ_LAST(&vm_page_queues[basequeue+index].pl, pglist);
587         else
588                 m = TAILQ_FIRST(&vm_page_queues[basequeue+index].pl);
589         if (m == NULL)
590                 m = _vm_page_list_find2(basequeue, index);
591         return(m);
592 }
593
594 static vm_page_t
595 _vm_page_list_find2(int basequeue, int index)
596 {
597         int i;
598         vm_page_t m = NULL;
599         struct vpgqueues *pq;
600
601         pq = &vm_page_queues[basequeue];
602
603         /*
604          * Note that for the first loop, index+i and index-i wind up at the
605          * same place.  Even though this is not totally optimal, we've already
606          * blown it by missing the cache case so we do not care.
607          */
608
609         for(i = PQ_L2_SIZE / 2; i > 0; --i) {
610                 if ((m = TAILQ_FIRST(&pq[(index + i) & PQ_L2_MASK].pl)) != NULL)
611                         break;
612
613                 if ((m = TAILQ_FIRST(&pq[(index - i) & PQ_L2_MASK].pl)) != NULL)
614                         break;
615         }
616         return(m);
617 }
618
619 vm_page_t
620 vm_page_list_find(int basequeue, int index, boolean_t prefer_zero)
621 {
622         return(_vm_page_list_find(basequeue, index, prefer_zero));
623 }
624
625 /*
626  * Find a page on the cache queue with color optimization.  As pages
627  * might be found, but not applicable, they are deactivated.  This
628  * keeps us from using potentially busy cached pages.
629  *
630  * This routine must be called with a critical section held.
631  * This routine may not block.
632  */
633 vm_page_t
634 vm_page_select_cache(vm_object_t object, vm_pindex_t pindex)
635 {
636         vm_page_t m;
637
638         while (TRUE) {
639                 m = _vm_page_list_find(
640                     PQ_CACHE,
641                     (pindex + object->pg_color) & PQ_L2_MASK,
642                     FALSE
643                 );
644                 if (m && ((m->flags & (PG_BUSY|PG_UNMANAGED)) || m->busy ||
645                                m->hold_count || m->wire_count)) {
646                         vm_page_deactivate(m);
647                         continue;
648                 }
649                 return m;
650         }
651         /* not reached */
652 }
653
654 /*
655  * Find a free or zero page, with specified preference.  We attempt to
656  * inline the nominal case and fall back to _vm_page_select_free() 
657  * otherwise.
658  *
659  * This routine must be called with a critical section held.
660  * This routine may not block.
661  */
662 static __inline vm_page_t
663 vm_page_select_free(vm_object_t object, vm_pindex_t pindex, boolean_t prefer_zero)
664 {
665         vm_page_t m;
666
667         m = _vm_page_list_find(
668                 PQ_FREE,
669                 (pindex + object->pg_color) & PQ_L2_MASK,
670                 prefer_zero
671         );
672         return(m);
673 }
674
675 /*
676  * vm_page_alloc()
677  *
678  * Allocate and return a memory cell associated with this VM object/offset
679  * pair.
680  *
681  *      page_req classes:
682  *
683  *      VM_ALLOC_NORMAL         allow use of cache pages, nominal free drain
684  *      VM_ALLOC_SYSTEM         greater free drain
685  *      VM_ALLOC_INTERRUPT      allow free list to be completely drained
686  *      VM_ALLOC_ZERO           advisory request for pre-zero'd page
687  *
688  * The object must be locked.
689  * This routine may not block.
690  * The returned page will be marked PG_BUSY
691  *
692  * Additional special handling is required when called from an interrupt
693  * (VM_ALLOC_INTERRUPT).  We are not allowed to mess with the page cache
694  * in this case.
695  */
696 vm_page_t
697 vm_page_alloc(vm_object_t object, vm_pindex_t pindex, int page_req)
698 {
699         vm_page_t m = NULL;
700
701         KKASSERT(object != NULL);
702         KASSERT(!vm_page_lookup(object, pindex),
703                 ("vm_page_alloc: page already allocated"));
704         KKASSERT(page_req & 
705                 (VM_ALLOC_NORMAL|VM_ALLOC_INTERRUPT|VM_ALLOC_SYSTEM));
706
707         /*
708          * Certain system threads (pageout daemon, buf_daemon's) are
709          * allowed to eat deeper into the free page list.
710          */
711         if (curthread->td_flags & TDF_SYSTHREAD)
712                 page_req |= VM_ALLOC_SYSTEM;
713
714         crit_enter();
715 loop:
716         if (vmstats.v_free_count > vmstats.v_free_reserved ||
717             ((page_req & VM_ALLOC_INTERRUPT) && vmstats.v_free_count > 0) ||
718             ((page_req & VM_ALLOC_SYSTEM) && vmstats.v_cache_count == 0 &&
719                 vmstats.v_free_count > vmstats.v_interrupt_free_min)
720         ) {
721                 /*
722                  * The free queue has sufficient free pages to take one out.
723                  */
724                 if (page_req & VM_ALLOC_ZERO)
725                         m = vm_page_select_free(object, pindex, TRUE);
726                 else
727                         m = vm_page_select_free(object, pindex, FALSE);
728         } else if (page_req & VM_ALLOC_NORMAL) {
729                 /*
730                  * Allocatable from the cache (non-interrupt only).  On
731                  * success, we must free the page and try again, thus
732                  * ensuring that vmstats.v_*_free_min counters are replenished.
733                  */
734 #ifdef INVARIANTS
735                 if (curthread->td_preempted) {
736                         kprintf("vm_page_alloc(): warning, attempt to allocate"
737                                 " cache page from preempting interrupt\n");
738                         m = NULL;
739                 } else {
740                         m = vm_page_select_cache(object, pindex);
741                 }
742 #else
743                 m = vm_page_select_cache(object, pindex);
744 #endif
745                 /*
746                  * On success move the page into the free queue and loop.
747                  */
748                 if (m != NULL) {
749                         KASSERT(m->dirty == 0,
750                             ("Found dirty cache page %p", m));
751                         vm_page_busy(m);
752                         vm_page_protect(m, VM_PROT_NONE);
753                         vm_page_free(m);
754                         goto loop;
755                 }
756
757                 /*
758                  * On failure return NULL
759                  */
760                 crit_exit();
761 #if defined(DIAGNOSTIC)
762                 if (vmstats.v_cache_count > 0)
763                         kprintf("vm_page_alloc(NORMAL): missing pages on cache queue: %d\n", vmstats.v_cache_count);
764 #endif
765                 vm_pageout_deficit++;
766                 pagedaemon_wakeup();
767                 return (NULL);
768         } else {
769                 /*
770                  * No pages available, wakeup the pageout daemon and give up.
771                  */
772                 crit_exit();
773                 vm_pageout_deficit++;
774                 pagedaemon_wakeup();
775                 return (NULL);
776         }
777
778         /*
779          * Good page found.  The page has not yet been busied.  We are in
780          * a critical section.
781          */
782         KASSERT(m != NULL, ("vm_page_alloc(): missing page on free queue\n"));
783         KASSERT(m->dirty == 0, 
784                 ("vm_page_alloc: free/cache page %p was dirty", m));
785
786         /*
787          * Remove from free queue
788          */
789         vm_page_unqueue_nowakeup(m);
790
791         /*
792          * Initialize structure.  Only the PG_ZERO flag is inherited.  Set
793          * the page PG_BUSY
794          */
795         if (m->flags & PG_ZERO) {
796                 vm_page_zero_count--;
797                 m->flags = PG_ZERO | PG_BUSY;
798         } else {
799                 m->flags = PG_BUSY;
800         }
801         m->wire_count = 0;
802         m->hold_count = 0;
803         m->act_count = 0;
804         m->busy = 0;
805         m->valid = 0;
806
807         /*
808          * vm_page_insert() is safe prior to the crit_exit().  Note also that
809          * inserting a page here does not insert it into the pmap (which
810          * could cause us to block allocating memory).  We cannot block 
811          * anywhere.
812          */
813         vm_page_insert(m, object, pindex);
814
815         /*
816          * Don't wakeup too often - wakeup the pageout daemon when
817          * we would be nearly out of memory.
818          */
819         pagedaemon_wakeup();
820
821         crit_exit();
822
823         /*
824          * A PG_BUSY page is returned.
825          */
826         return (m);
827 }
828
829 /*
830  * Block until free pages are available for allocation, called in various
831  * places before memory allocations.
832  */
833 void
834 vm_wait(int timo)
835 {
836         crit_enter();
837         if (curthread == pagethread) {
838                 vm_pageout_pages_needed = 1;
839                 tsleep(&vm_pageout_pages_needed, 0, "VMWait", timo);
840         } else {
841                 if (vm_pages_needed == 0) {
842                         vm_pages_needed = 1;
843                         wakeup(&vm_pages_needed);
844                 }
845                 tsleep(&vmstats.v_free_count, 0, "vmwait", timo);
846         }
847         crit_exit();
848 }
849
850 /*
851  * Block until free pages are available for allocation
852  *
853  * Called only in vm_fault so that processes page faulting can be
854  * easily tracked.
855  */
856 void
857 vm_waitpfault(void)
858 {
859         crit_enter();
860         if (vm_pages_needed == 0) {
861                 vm_pages_needed = 1;
862                 wakeup(&vm_pages_needed);
863         }
864         tsleep(&vmstats.v_free_count, 0, "pfault", 0);
865         crit_exit();
866 }
867
868 /*
869  * Put the specified page on the active list (if appropriate).  Ensure
870  * that act_count is at least ACT_INIT but do not otherwise mess with it.
871  *
872  * The page queues must be locked.
873  * This routine may not block.
874  */
875 void
876 vm_page_activate(vm_page_t m)
877 {
878         crit_enter();
879         if (m->queue != PQ_ACTIVE) {
880                 if ((m->queue - m->pc) == PQ_CACHE)
881                         mycpu->gd_cnt.v_reactivated++;
882
883                 vm_page_unqueue(m);
884
885                 if (m->wire_count == 0 && (m->flags & PG_UNMANAGED) == 0) {
886                         m->queue = PQ_ACTIVE;
887                         vm_page_queues[PQ_ACTIVE].lcnt++;
888                         TAILQ_INSERT_TAIL(&vm_page_queues[PQ_ACTIVE].pl,
889                                             m, pageq);
890                         if (m->act_count < ACT_INIT)
891                                 m->act_count = ACT_INIT;
892                         vmstats.v_active_count++;
893                 }
894         } else {
895                 if (m->act_count < ACT_INIT)
896                         m->act_count = ACT_INIT;
897         }
898         crit_exit();
899 }
900
901 /*
902  * Helper routine for vm_page_free_toq() and vm_page_cache().  This
903  * routine is called when a page has been added to the cache or free
904  * queues.
905  *
906  * This routine may not block.
907  * This routine must be called at splvm()
908  */
909 static __inline void
910 vm_page_free_wakeup(void)
911 {
912         /*
913          * if pageout daemon needs pages, then tell it that there are
914          * some free.
915          */
916         if (vm_pageout_pages_needed &&
917             vmstats.v_cache_count + vmstats.v_free_count >= 
918             vmstats.v_pageout_free_min
919         ) {
920                 wakeup(&vm_pageout_pages_needed);
921                 vm_pageout_pages_needed = 0;
922         }
923
924         /*
925          * wakeup processes that are waiting on memory if we hit a
926          * high water mark. And wakeup scheduler process if we have
927          * lots of memory. this process will swapin processes.
928          */
929         if (vm_pages_needed && !vm_page_count_min(0)) {
930                 vm_pages_needed = 0;
931                 wakeup(&vmstats.v_free_count);
932         }
933 }
934
935 /*
936  *      vm_page_free_toq:
937  *
938  *      Returns the given page to the PQ_FREE list, disassociating it with
939  *      any VM object.
940  *
941  *      The vm_page must be PG_BUSY on entry.  PG_BUSY will be released on
942  *      return (the page will have been freed).  No particular spl is required
943  *      on entry.
944  *
945  *      This routine may not block.
946  */
947 void
948 vm_page_free_toq(vm_page_t m)
949 {
950         struct vpgqueues *pq;
951
952         crit_enter();
953         mycpu->gd_cnt.v_tfree++;
954
955         KKASSERT((m->flags & PG_MAPPED) == 0);
956
957         if (m->busy || ((m->queue - m->pc) == PQ_FREE)) {
958                 kprintf(
959                 "vm_page_free: pindex(%lu), busy(%d), PG_BUSY(%d), hold(%d)\n",
960                     (u_long)m->pindex, m->busy, (m->flags & PG_BUSY) ? 1 : 0,
961                     m->hold_count);
962                 if ((m->queue - m->pc) == PQ_FREE)
963                         panic("vm_page_free: freeing free page");
964                 else
965                         panic("vm_page_free: freeing busy page");
966         }
967
968         /*
969          * unqueue, then remove page.  Note that we cannot destroy
970          * the page here because we do not want to call the pager's
971          * callback routine until after we've put the page on the
972          * appropriate free queue.
973          */
974         vm_page_unqueue_nowakeup(m);
975         vm_page_remove(m);
976
977         /*
978          * No further management of fictitious pages occurs beyond object
979          * and queue removal.
980          */
981         if ((m->flags & PG_FICTITIOUS) != 0) {
982                 vm_page_wakeup(m);
983                 crit_exit();
984                 return;
985         }
986
987         m->valid = 0;
988         vm_page_undirty(m);
989
990         if (m->wire_count != 0) {
991                 if (m->wire_count > 1) {
992                     panic(
993                         "vm_page_free: invalid wire count (%d), pindex: 0x%lx",
994                         m->wire_count, (long)m->pindex);
995                 }
996                 panic("vm_page_free: freeing wired page");
997         }
998
999         /*
1000          * Clear the UNMANAGED flag when freeing an unmanaged page.
1001          */
1002         if (m->flags & PG_UNMANAGED) {
1003             m->flags &= ~PG_UNMANAGED;
1004         }
1005
1006         if (m->hold_count != 0) {
1007                 m->flags &= ~PG_ZERO;
1008                 m->queue = PQ_HOLD;
1009         } else {
1010                 m->queue = PQ_FREE + m->pc;
1011         }
1012         pq = &vm_page_queues[m->queue];
1013         pq->lcnt++;
1014         ++(*pq->cnt);
1015
1016         /*
1017          * Put zero'd pages on the end ( where we look for zero'd pages
1018          * first ) and non-zerod pages at the head.
1019          */
1020         if (m->flags & PG_ZERO) {
1021                 TAILQ_INSERT_TAIL(&pq->pl, m, pageq);
1022                 ++vm_page_zero_count;
1023         } else {
1024                 TAILQ_INSERT_HEAD(&pq->pl, m, pageq);
1025         }
1026         vm_page_wakeup(m);
1027         vm_page_free_wakeup();
1028         crit_exit();
1029 }
1030
1031 /*
1032  * vm_page_unmanage()
1033  *
1034  * Prevent PV management from being done on the page.  The page is
1035  * removed from the paging queues as if it were wired, and as a 
1036  * consequence of no longer being managed the pageout daemon will not
1037  * touch it (since there is no way to locate the pte mappings for the
1038  * page).  madvise() calls that mess with the pmap will also no longer
1039  * operate on the page.
1040  *
1041  * Beyond that the page is still reasonably 'normal'.  Freeing the page
1042  * will clear the flag.
1043  *
1044  * This routine is used by OBJT_PHYS objects - objects using unswappable
1045  * physical memory as backing store rather then swap-backed memory and
1046  * will eventually be extended to support 4MB unmanaged physical 
1047  * mappings.
1048  *
1049  * Must be called with a critical section held.
1050  */
1051 void
1052 vm_page_unmanage(vm_page_t m)
1053 {
1054         ASSERT_IN_CRIT_SECTION();
1055         if ((m->flags & PG_UNMANAGED) == 0) {
1056                 if (m->wire_count == 0)
1057                         vm_page_unqueue(m);
1058         }
1059         vm_page_flag_set(m, PG_UNMANAGED);
1060 }
1061
1062 /*
1063  * Mark this page as wired down by yet another map, removing it from
1064  * paging queues as necessary.
1065  *
1066  * The page queues must be locked.
1067  * This routine may not block.
1068  */
1069 void
1070 vm_page_wire(vm_page_t m)
1071 {
1072         /*
1073          * Only bump the wire statistics if the page is not already wired,
1074          * and only unqueue the page if it is on some queue (if it is unmanaged
1075          * it is already off the queues).  Don't do anything with fictitious
1076          * pages because they are always wired.
1077          */
1078         crit_enter();
1079         if ((m->flags & PG_FICTITIOUS) == 0) {
1080                 if (m->wire_count == 0) {
1081                         if ((m->flags & PG_UNMANAGED) == 0)
1082                                 vm_page_unqueue(m);
1083                         vmstats.v_wire_count++;
1084                 }
1085                 m->wire_count++;
1086                 KASSERT(m->wire_count != 0,
1087                         ("vm_page_wire: wire_count overflow m=%p", m));
1088         }
1089         crit_exit();
1090 }
1091
1092 /*
1093  * Release one wiring of this page, potentially enabling it to be paged again.
1094  *
1095  * Many pages placed on the inactive queue should actually go
1096  * into the cache, but it is difficult to figure out which.  What
1097  * we do instead, if the inactive target is well met, is to put
1098  * clean pages at the head of the inactive queue instead of the tail.
1099  * This will cause them to be moved to the cache more quickly and
1100  * if not actively re-referenced, freed more quickly.  If we just
1101  * stick these pages at the end of the inactive queue, heavy filesystem
1102  * meta-data accesses can cause an unnecessary paging load on memory bound 
1103  * processes.  This optimization causes one-time-use metadata to be
1104  * reused more quickly.
1105  *
1106  * BUT, if we are in a low-memory situation we have no choice but to
1107  * put clean pages on the cache queue.
1108  *
1109  * A number of routines use vm_page_unwire() to guarantee that the page
1110  * will go into either the inactive or active queues, and will NEVER
1111  * be placed in the cache - for example, just after dirtying a page.
1112  * dirty pages in the cache are not allowed.
1113  *
1114  * The page queues must be locked.
1115  * This routine may not block.
1116  */
1117 void
1118 vm_page_unwire(vm_page_t m, int activate)
1119 {
1120         crit_enter();
1121         if (m->flags & PG_FICTITIOUS) {
1122                 /* do nothing */
1123         } else if (m->wire_count <= 0) {
1124                 panic("vm_page_unwire: invalid wire count: %d", m->wire_count);
1125         } else {
1126                 if (--m->wire_count == 0) {
1127                         --vmstats.v_wire_count;
1128                         if (m->flags & PG_UNMANAGED) {
1129                                 ;
1130                         } else if (activate) {
1131                                 TAILQ_INSERT_TAIL(
1132                                     &vm_page_queues[PQ_ACTIVE].pl, m, pageq);
1133                                 m->queue = PQ_ACTIVE;
1134                                 vm_page_queues[PQ_ACTIVE].lcnt++;
1135                                 vmstats.v_active_count++;
1136                         } else {
1137                                 vm_page_flag_clear(m, PG_WINATCFLS);
1138                                 TAILQ_INSERT_TAIL(
1139                                     &vm_page_queues[PQ_INACTIVE].pl, m, pageq);
1140                                 m->queue = PQ_INACTIVE;
1141                                 vm_page_queues[PQ_INACTIVE].lcnt++;
1142                                 vmstats.v_inactive_count++;
1143                         }
1144                 }
1145         }
1146         crit_exit();
1147 }
1148
1149
1150 /*
1151  * Move the specified page to the inactive queue.  If the page has
1152  * any associated swap, the swap is deallocated.
1153  *
1154  * Normally athead is 0 resulting in LRU operation.  athead is set
1155  * to 1 if we want this page to be 'as if it were placed in the cache',
1156  * except without unmapping it from the process address space.
1157  *
1158  * This routine may not block.
1159  */
1160 static __inline void
1161 _vm_page_deactivate(vm_page_t m, int athead)
1162 {
1163         /*
1164          * Ignore if already inactive.
1165          */
1166         if (m->queue == PQ_INACTIVE)
1167                 return;
1168
1169         if (m->wire_count == 0 && (m->flags & PG_UNMANAGED) == 0) {
1170                 if ((m->queue - m->pc) == PQ_CACHE)
1171                         mycpu->gd_cnt.v_reactivated++;
1172                 vm_page_flag_clear(m, PG_WINATCFLS);
1173                 vm_page_unqueue(m);
1174                 if (athead)
1175                         TAILQ_INSERT_HEAD(&vm_page_queues[PQ_INACTIVE].pl, m, pageq);
1176                 else
1177                         TAILQ_INSERT_TAIL(&vm_page_queues[PQ_INACTIVE].pl, m, pageq);
1178                 m->queue = PQ_INACTIVE;
1179                 vm_page_queues[PQ_INACTIVE].lcnt++;
1180                 vmstats.v_inactive_count++;
1181         }
1182 }
1183
1184 void
1185 vm_page_deactivate(vm_page_t m)
1186 {
1187     crit_enter();
1188     _vm_page_deactivate(m, 0);
1189     crit_exit();
1190 }
1191
1192 /*
1193  * vm_page_try_to_cache:
1194  *
1195  * Returns 0 on failure, 1 on success
1196  */
1197 int
1198 vm_page_try_to_cache(vm_page_t m)
1199 {
1200         crit_enter();
1201         if (m->dirty || m->hold_count || m->busy || m->wire_count ||
1202             (m->flags & (PG_BUSY|PG_UNMANAGED))) {
1203                 crit_exit();
1204                 return(0);
1205         }
1206         vm_page_test_dirty(m);
1207         if (m->dirty) {
1208                 crit_exit();
1209                 return(0);
1210         }
1211         vm_page_cache(m);
1212         crit_exit();
1213         return(1);
1214 }
1215
1216 /*
1217  * Attempt to free the page.  If we cannot free it, we do nothing.
1218  * 1 is returned on success, 0 on failure.
1219  */
1220 int
1221 vm_page_try_to_free(vm_page_t m)
1222 {
1223         crit_enter();
1224         if (m->dirty || m->hold_count || m->busy || m->wire_count ||
1225             (m->flags & (PG_BUSY|PG_UNMANAGED))) {
1226                 crit_exit();
1227                 return(0);
1228         }
1229         vm_page_test_dirty(m);
1230         if (m->dirty) {
1231                 crit_exit();
1232                 return(0);
1233         }
1234         vm_page_busy(m);
1235         vm_page_protect(m, VM_PROT_NONE);
1236         vm_page_free(m);
1237         crit_exit();
1238         return(1);
1239 }
1240
1241 /*
1242  * vm_page_cache
1243  *
1244  * Put the specified page onto the page cache queue (if appropriate).
1245  *
1246  * This routine may not block.
1247  */
1248 void
1249 vm_page_cache(vm_page_t m)
1250 {
1251         ASSERT_IN_CRIT_SECTION();
1252
1253         if ((m->flags & (PG_BUSY|PG_UNMANAGED)) || m->busy ||
1254                         m->wire_count || m->hold_count) {
1255                 kprintf("vm_page_cache: attempting to cache busy/held page\n");
1256                 return;
1257         }
1258
1259         /*
1260          * Already in the cache (and thus not mapped)
1261          */
1262         if ((m->queue - m->pc) == PQ_CACHE) {
1263                 KKASSERT((m->flags & PG_MAPPED) == 0);
1264                 return;
1265         }
1266
1267         /*
1268          * Caller is required to test m->dirty, but note that the act of
1269          * removing the page from its maps can cause it to become dirty
1270          * on an SMP system due to another cpu running in usermode.
1271          */
1272         if (m->dirty) {
1273                 panic("vm_page_cache: caching a dirty page, pindex: %ld",
1274                         (long)m->pindex);
1275         }
1276
1277         /*
1278          * Remove all pmaps and indicate that the page is not
1279          * writeable or mapped.  Our vm_page_protect() call may
1280          * have blocked (especially w/ VM_PROT_NONE), so recheck
1281          * everything.
1282          */
1283         vm_page_busy(m);
1284         vm_page_protect(m, VM_PROT_NONE);
1285         vm_page_wakeup(m);
1286         if ((m->flags & (PG_BUSY|PG_UNMANAGED|PG_MAPPED)) || m->busy ||
1287                         m->wire_count || m->hold_count) {
1288                 /* do nothing */
1289         } else if (m->dirty) {
1290                 vm_page_deactivate(m);
1291         } else {
1292                 vm_page_unqueue_nowakeup(m);
1293                 m->queue = PQ_CACHE + m->pc;
1294                 vm_page_queues[m->queue].lcnt++;
1295                 TAILQ_INSERT_TAIL(&vm_page_queues[m->queue].pl, m, pageq);
1296                 vmstats.v_cache_count++;
1297                 vm_page_free_wakeup();
1298         }
1299 }
1300
1301 /*
1302  * vm_page_dontneed()
1303  *
1304  * Cache, deactivate, or do nothing as appropriate.  This routine
1305  * is typically used by madvise() MADV_DONTNEED.
1306  *
1307  * Generally speaking we want to move the page into the cache so
1308  * it gets reused quickly.  However, this can result in a silly syndrome
1309  * due to the page recycling too quickly.  Small objects will not be
1310  * fully cached.  On the otherhand, if we move the page to the inactive
1311  * queue we wind up with a problem whereby very large objects 
1312  * unnecessarily blow away our inactive and cache queues.
1313  *
1314  * The solution is to move the pages based on a fixed weighting.  We
1315  * either leave them alone, deactivate them, or move them to the cache,
1316  * where moving them to the cache has the highest weighting.
1317  * By forcing some pages into other queues we eventually force the
1318  * system to balance the queues, potentially recovering other unrelated
1319  * space from active.  The idea is to not force this to happen too
1320  * often.
1321  */
1322 void
1323 vm_page_dontneed(vm_page_t m)
1324 {
1325         static int dnweight;
1326         int dnw;
1327         int head;
1328
1329         dnw = ++dnweight;
1330
1331         /*
1332          * occassionally leave the page alone
1333          */
1334         crit_enter();
1335         if ((dnw & 0x01F0) == 0 ||
1336             m->queue == PQ_INACTIVE || 
1337             m->queue - m->pc == PQ_CACHE
1338         ) {
1339                 if (m->act_count >= ACT_INIT)
1340                         --m->act_count;
1341                 crit_exit();
1342                 return;
1343         }
1344
1345         if (m->dirty == 0)
1346                 vm_page_test_dirty(m);
1347
1348         if (m->dirty || (dnw & 0x0070) == 0) {
1349                 /*
1350                  * Deactivate the page 3 times out of 32.
1351                  */
1352                 head = 0;
1353         } else {
1354                 /*
1355                  * Cache the page 28 times out of every 32.  Note that
1356                  * the page is deactivated instead of cached, but placed
1357                  * at the head of the queue instead of the tail.
1358                  */
1359                 head = 1;
1360         }
1361         _vm_page_deactivate(m, head);
1362         crit_exit();
1363 }
1364
1365 /*
1366  * Grab a page, blocking if it is busy and allocating a page if necessary.
1367  * A busy page is returned or NULL.
1368  *
1369  * If VM_ALLOC_RETRY is specified VM_ALLOC_NORMAL must also be specified.
1370  * If VM_ALLOC_RETRY is not specified
1371  *
1372  * This routine may block, but if VM_ALLOC_RETRY is not set then NULL is
1373  * always returned if we had blocked.  
1374  * This routine will never return NULL if VM_ALLOC_RETRY is set.
1375  * This routine may not be called from an interrupt.
1376  * The returned page may not be entirely valid.
1377  *
1378  * This routine may be called from mainline code without spl protection and
1379  * be guarenteed a busied page associated with the object at the specified
1380  * index.
1381  */
1382 vm_page_t
1383 vm_page_grab(vm_object_t object, vm_pindex_t pindex, int allocflags)
1384 {
1385         vm_page_t m;
1386         int generation;
1387
1388         KKASSERT(allocflags &
1389                 (VM_ALLOC_NORMAL|VM_ALLOC_INTERRUPT|VM_ALLOC_SYSTEM));
1390         crit_enter();
1391 retrylookup:
1392         if ((m = vm_page_lookup(object, pindex)) != NULL) {
1393                 if (m->busy || (m->flags & PG_BUSY)) {
1394                         generation = object->generation;
1395
1396                         while ((object->generation == generation) &&
1397                                         (m->busy || (m->flags & PG_BUSY))) {
1398                                 vm_page_flag_set(m, PG_WANTED | PG_REFERENCED);
1399                                 tsleep(m, 0, "pgrbwt", 0);
1400                                 if ((allocflags & VM_ALLOC_RETRY) == 0) {
1401                                         m = NULL;
1402                                         goto done;
1403                                 }
1404                         }
1405                         goto retrylookup;
1406                 } else {
1407                         vm_page_busy(m);
1408                         goto done;
1409                 }
1410         }
1411         m = vm_page_alloc(object, pindex, allocflags & ~VM_ALLOC_RETRY);
1412         if (m == NULL) {
1413                 vm_wait(0);
1414                 if ((allocflags & VM_ALLOC_RETRY) == 0)
1415                         goto done;
1416                 goto retrylookup;
1417         }
1418 done:
1419         crit_exit();
1420         return(m);
1421 }
1422
1423 /*
1424  * Mapping function for valid bits or for dirty bits in
1425  * a page.  May not block.
1426  *
1427  * Inputs are required to range within a page.
1428  */
1429 __inline int
1430 vm_page_bits(int base, int size)
1431 {
1432         int first_bit;
1433         int last_bit;
1434
1435         KASSERT(
1436             base + size <= PAGE_SIZE,
1437             ("vm_page_bits: illegal base/size %d/%d", base, size)
1438         );
1439
1440         if (size == 0)          /* handle degenerate case */
1441                 return(0);
1442
1443         first_bit = base >> DEV_BSHIFT;
1444         last_bit = (base + size - 1) >> DEV_BSHIFT;
1445
1446         return ((2 << last_bit) - (1 << first_bit));
1447 }
1448
1449 /*
1450  * Sets portions of a page valid and clean.  The arguments are expected
1451  * to be DEV_BSIZE aligned but if they aren't the bitmap is inclusive
1452  * of any partial chunks touched by the range.  The invalid portion of
1453  * such chunks will be zero'd.
1454  *
1455  * NOTE: When truncating a buffer vnode_pager_setsize() will automatically
1456  *       align base to DEV_BSIZE so as not to mark clean a partially
1457  *       truncated device block.  Otherwise the dirty page status might be
1458  *       lost.
1459  *
1460  * This routine may not block.
1461  *
1462  * (base + size) must be less then or equal to PAGE_SIZE.
1463  */
1464 static void
1465 _vm_page_zero_valid(vm_page_t m, int base, int size)
1466 {
1467         int frag;
1468         int endoff;
1469
1470         if (size == 0)  /* handle degenerate case */
1471                 return;
1472
1473         /*
1474          * If the base is not DEV_BSIZE aligned and the valid
1475          * bit is clear, we have to zero out a portion of the
1476          * first block.
1477          */
1478
1479         if ((frag = base & ~(DEV_BSIZE - 1)) != base &&
1480             (m->valid & (1 << (base >> DEV_BSHIFT))) == 0
1481         ) {
1482                 pmap_zero_page_area(
1483                     VM_PAGE_TO_PHYS(m),
1484                     frag,
1485                     base - frag
1486                 );
1487         }
1488
1489         /*
1490          * If the ending offset is not DEV_BSIZE aligned and the 
1491          * valid bit is clear, we have to zero out a portion of
1492          * the last block.
1493          */
1494
1495         endoff = base + size;
1496
1497         if ((frag = endoff & ~(DEV_BSIZE - 1)) != endoff &&
1498             (m->valid & (1 << (endoff >> DEV_BSHIFT))) == 0
1499         ) {
1500                 pmap_zero_page_area(
1501                     VM_PAGE_TO_PHYS(m),
1502                     endoff,
1503                     DEV_BSIZE - (endoff & (DEV_BSIZE - 1))
1504                 );
1505         }
1506 }
1507
1508 /*
1509  * Set valid, clear dirty bits.  If validating the entire
1510  * page we can safely clear the pmap modify bit.  We also
1511  * use this opportunity to clear the PG_NOSYNC flag.  If a process
1512  * takes a write fault on a MAP_NOSYNC memory area the flag will
1513  * be set again.
1514  *
1515  * We set valid bits inclusive of any overlap, but we can only
1516  * clear dirty bits for DEV_BSIZE chunks that are fully within
1517  * the range.
1518  */
1519 void
1520 vm_page_set_valid(vm_page_t m, int base, int size)
1521 {
1522         _vm_page_zero_valid(m, base, size);
1523         m->valid |= vm_page_bits(base, size);
1524 }
1525
1526
1527 /*
1528  * Set valid bits and clear dirty bits.
1529  *
1530  * NOTE: This function does not clear the pmap modified bit.
1531  *       Also note that e.g. NFS may use a byte-granular base
1532  *       and size.
1533  */
1534 void
1535 vm_page_set_validclean(vm_page_t m, int base, int size)
1536 {
1537         int pagebits;
1538
1539         _vm_page_zero_valid(m, base, size);
1540         pagebits = vm_page_bits(base, size);
1541         m->valid |= pagebits;
1542         m->dirty &= ~pagebits;
1543         if (base == 0 && size == PAGE_SIZE) {
1544                 /*pmap_clear_modify(m);*/
1545                 vm_page_flag_clear(m, PG_NOSYNC);
1546         }
1547 }
1548
1549 /*
1550  * Clear dirty bits.
1551  *
1552  * NOTE: This function does not clear the pmap modified bit.
1553  *       Also note that e.g. NFS may use a byte-granular base
1554  *       and size.
1555  */
1556 void
1557 vm_page_clear_dirty(vm_page_t m, int base, int size)
1558 {
1559         m->dirty &= ~vm_page_bits(base, size);
1560         if (base == 0 && size == PAGE_SIZE) {
1561                 /*pmap_clear_modify(m);*/
1562                 vm_page_flag_clear(m, PG_NOSYNC);
1563         }
1564 }
1565
1566 /*
1567  * Make the page all-dirty.
1568  *
1569  * Also make sure the related object and vnode reflect the fact that the
1570  * object may now contain a dirty page.
1571  */
1572 void
1573 vm_page_dirty(vm_page_t m)
1574 {
1575 #ifdef INVARIANTS
1576         int pqtype = m->queue - m->pc;
1577 #endif
1578         KASSERT(pqtype != PQ_CACHE && pqtype != PQ_FREE,
1579                 ("vm_page_dirty: page in free/cache queue!"));
1580         if (m->dirty != VM_PAGE_BITS_ALL) {
1581                 m->dirty = VM_PAGE_BITS_ALL;
1582                 if (m->object)
1583                         vm_object_set_writeable_dirty(m->object);
1584         }
1585 }
1586
1587 /*
1588  * Invalidates DEV_BSIZE'd chunks within a page.  Both the
1589  * valid and dirty bits for the effected areas are cleared.
1590  *
1591  * May not block.
1592  */
1593 void
1594 vm_page_set_invalid(vm_page_t m, int base, int size)
1595 {
1596         int bits;
1597
1598         bits = vm_page_bits(base, size);
1599         m->valid &= ~bits;
1600         m->dirty &= ~bits;
1601         m->object->generation++;
1602 }
1603
1604 /*
1605  * The kernel assumes that the invalid portions of a page contain 
1606  * garbage, but such pages can be mapped into memory by user code.
1607  * When this occurs, we must zero out the non-valid portions of the
1608  * page so user code sees what it expects.
1609  *
1610  * Pages are most often semi-valid when the end of a file is mapped 
1611  * into memory and the file's size is not page aligned.
1612  */
1613 void
1614 vm_page_zero_invalid(vm_page_t m, boolean_t setvalid)
1615 {
1616         int b;
1617         int i;
1618
1619         /*
1620          * Scan the valid bits looking for invalid sections that
1621          * must be zerod.  Invalid sub-DEV_BSIZE'd areas ( where the
1622          * valid bit may be set ) have already been zerod by
1623          * vm_page_set_validclean().
1624          */
1625         for (b = i = 0; i <= PAGE_SIZE / DEV_BSIZE; ++i) {
1626                 if (i == (PAGE_SIZE / DEV_BSIZE) || 
1627                     (m->valid & (1 << i))
1628                 ) {
1629                         if (i > b) {
1630                                 pmap_zero_page_area(
1631                                     VM_PAGE_TO_PHYS(m), 
1632                                     b << DEV_BSHIFT,
1633                                     (i - b) << DEV_BSHIFT
1634                                 );
1635                         }
1636                         b = i + 1;
1637                 }
1638         }
1639
1640         /*
1641          * setvalid is TRUE when we can safely set the zero'd areas
1642          * as being valid.  We can do this if there are no cache consistency
1643          * issues.  e.g. it is ok to do with UFS, but not ok to do with NFS.
1644          */
1645         if (setvalid)
1646                 m->valid = VM_PAGE_BITS_ALL;
1647 }
1648
1649 /*
1650  * Is a (partial) page valid?  Note that the case where size == 0
1651  * will return FALSE in the degenerate case where the page is entirely
1652  * invalid, and TRUE otherwise.
1653  *
1654  * May not block.
1655  */
1656 int
1657 vm_page_is_valid(vm_page_t m, int base, int size)
1658 {
1659         int bits = vm_page_bits(base, size);
1660
1661         if (m->valid && ((m->valid & bits) == bits))
1662                 return 1;
1663         else
1664                 return 0;
1665 }
1666
1667 /*
1668  * update dirty bits from pmap/mmu.  May not block.
1669  */
1670 void
1671 vm_page_test_dirty(vm_page_t m)
1672 {
1673         if ((m->dirty != VM_PAGE_BITS_ALL) && pmap_is_modified(m)) {
1674                 vm_page_dirty(m);
1675         }
1676 }
1677
1678 /*
1679  * Issue an event on a VM page.  Corresponding action structures are
1680  * removed from the page's list and called.
1681  */
1682 void
1683 vm_page_event_internal(vm_page_t m, vm_page_event_t event)
1684 {
1685         struct vm_page_action *scan, *next;
1686
1687         LIST_FOREACH_MUTABLE(scan, &m->action_list, entry, next) {
1688                 if (scan->event == event) {
1689                         scan->event = VMEVENT_NONE;
1690                         LIST_REMOVE(scan, entry);
1691                         scan->func(m, scan);
1692                 }
1693         }
1694 }
1695
1696 #include "opt_ddb.h"
1697 #ifdef DDB
1698 #include <sys/kernel.h>
1699
1700 #include <ddb/ddb.h>
1701
1702 DB_SHOW_COMMAND(page, vm_page_print_page_info)
1703 {
1704         db_printf("vmstats.v_free_count: %d\n", vmstats.v_free_count);
1705         db_printf("vmstats.v_cache_count: %d\n", vmstats.v_cache_count);
1706         db_printf("vmstats.v_inactive_count: %d\n", vmstats.v_inactive_count);
1707         db_printf("vmstats.v_active_count: %d\n", vmstats.v_active_count);
1708         db_printf("vmstats.v_wire_count: %d\n", vmstats.v_wire_count);
1709         db_printf("vmstats.v_free_reserved: %d\n", vmstats.v_free_reserved);
1710         db_printf("vmstats.v_free_min: %d\n", vmstats.v_free_min);
1711         db_printf("vmstats.v_free_target: %d\n", vmstats.v_free_target);
1712         db_printf("vmstats.v_cache_min: %d\n", vmstats.v_cache_min);
1713         db_printf("vmstats.v_inactive_target: %d\n", vmstats.v_inactive_target);
1714 }
1715
1716 DB_SHOW_COMMAND(pageq, vm_page_print_pageq_info)
1717 {
1718         int i;
1719         db_printf("PQ_FREE:");
1720         for(i=0;i<PQ_L2_SIZE;i++) {
1721                 db_printf(" %d", vm_page_queues[PQ_FREE + i].lcnt);
1722         }
1723         db_printf("\n");
1724                 
1725         db_printf("PQ_CACHE:");
1726         for(i=0;i<PQ_L2_SIZE;i++) {
1727                 db_printf(" %d", vm_page_queues[PQ_CACHE + i].lcnt);
1728         }
1729         db_printf("\n");
1730
1731         db_printf("PQ_ACTIVE: %d, PQ_INACTIVE: %d\n",
1732                 vm_page_queues[PQ_ACTIVE].lcnt,
1733                 vm_page_queues[PQ_INACTIVE].lcnt);
1734 }
1735 #endif /* DDB */