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