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