vm_page.c revision 166699
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 * 4. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	from: @(#)vm_page.c	7.4 (Berkeley) 5/7/91
33 */
34
35/*-
36 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
37 * All rights reserved.
38 *
39 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
40 *
41 * Permission to use, copy, modify and distribute this software and
42 * its documentation is hereby granted, provided that both the copyright
43 * notice and this permission notice appear in all copies of the
44 * software, derivative works or modified versions, and any portions
45 * thereof, and that both notices appear in supporting documentation.
46 *
47 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
48 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
49 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
50 *
51 * Carnegie Mellon requests users of this software to return to
52 *
53 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
54 *  School of Computer Science
55 *  Carnegie Mellon University
56 *  Pittsburgh PA 15213-3890
57 *
58 * any improvements or extensions that they make and grant Carnegie the
59 * rights to redistribute these changes.
60 */
61
62/*
63 *			GENERAL RULES ON VM_PAGE MANIPULATION
64 *
65 *	- a pageq mutex is required when adding or removing a page from a
66 *	  page queue (vm_page_queue[]), regardless of other mutexes or the
67 *	  busy state of a page.
68 *
69 *	- a hash chain mutex is required when associating or disassociating
70 *	  a page from the VM PAGE CACHE hash table (vm_page_buckets),
71 *	  regardless of other mutexes or the busy state of a page.
72 *
73 *	- either a hash chain mutex OR a busied page is required in order
74 *	  to modify the page flags.  A hash chain mutex must be obtained in
75 *	  order to busy a page.  A page's flags cannot be modified by a
76 *	  hash chain mutex if the page is marked busy.
77 *
78 *	- The object memq mutex is held when inserting or removing
79 *	  pages from an object (vm_page_insert() or vm_page_remove()).  This
80 *	  is different from the object's main mutex.
81 *
82 *	Generally speaking, you have to be aware of side effects when running
83 *	vm_page ops.  A vm_page_lookup() will return with the hash chain
84 *	locked, whether it was able to lookup the page or not.  vm_page_free(),
85 *	vm_page_cache(), vm_page_activate(), and a number of other routines
86 *	will release the hash chain mutex for you.  Intermediate manipulation
87 *	routines such as vm_page_flag_set() expect the hash chain to be held
88 *	on entry and the hash chain will remain held on return.
89 *
90 *	pageq scanning can only occur with the pageq in question locked.
91 *	We have a known bottleneck with the active queue, but the cache
92 *	and free queues are actually arrays already.
93 */
94
95/*
96 *	Resident memory management module.
97 */
98
99#include <sys/cdefs.h>
100__FBSDID("$FreeBSD: head/sys/vm/vm_page.c 166699 2007-02-14 07:05:55Z alc $");
101
102#include <sys/param.h>
103#include <sys/systm.h>
104#include <sys/lock.h>
105#include <sys/kernel.h>
106#include <sys/malloc.h>
107#include <sys/mutex.h>
108#include <sys/proc.h>
109#include <sys/sysctl.h>
110#include <sys/vmmeter.h>
111#include <sys/vnode.h>
112
113#include <vm/vm.h>
114#include <vm/vm_param.h>
115#include <vm/vm_kern.h>
116#include <vm/vm_object.h>
117#include <vm/vm_page.h>
118#include <vm/vm_pageout.h>
119#include <vm/vm_pager.h>
120#include <vm/vm_extern.h>
121#include <vm/uma.h>
122#include <vm/uma_int.h>
123
124#include <machine/md_var.h>
125
126/*
127 *	Associated with page of user-allocatable memory is a
128 *	page structure.
129 */
130
131struct mtx vm_page_queue_mtx;
132struct mtx vm_page_queue_free_mtx;
133
134vm_page_t vm_page_array = 0;
135int vm_page_array_size = 0;
136long first_page = 0;
137int vm_page_zero_count = 0;
138
139static int boot_pages = UMA_BOOT_PAGES;
140TUNABLE_INT("vm.boot_pages", &boot_pages);
141SYSCTL_INT(_vm, OID_AUTO, boot_pages, CTLFLAG_RD, &boot_pages, 0,
142	"number of pages allocated for bootstrapping the VM system");
143
144/*
145 *	vm_set_page_size:
146 *
147 *	Sets the page size, perhaps based upon the memory
148 *	size.  Must be called before any use of page-size
149 *	dependent functions.
150 */
151void
152vm_set_page_size(void)
153{
154	if (cnt.v_page_size == 0)
155		cnt.v_page_size = PAGE_SIZE;
156	if (((cnt.v_page_size - 1) & cnt.v_page_size) != 0)
157		panic("vm_set_page_size: page size not a power of two");
158}
159
160/*
161 *	vm_page_blacklist_lookup:
162 *
163 *	See if a physical address in this page has been listed
164 *	in the blacklist tunable.  Entries in the tunable are
165 *	separated by spaces or commas.  If an invalid integer is
166 *	encountered then the rest of the string is skipped.
167 */
168static int
169vm_page_blacklist_lookup(char *list, vm_paddr_t pa)
170{
171	vm_paddr_t bad;
172	char *cp, *pos;
173
174	for (pos = list; *pos != '\0'; pos = cp) {
175		bad = strtoq(pos, &cp, 0);
176		if (*cp != '\0') {
177			if (*cp == ' ' || *cp == ',') {
178				cp++;
179				if (cp == pos)
180					continue;
181			} else
182				break;
183		}
184		if (pa == trunc_page(bad))
185			return (1);
186	}
187	return (0);
188}
189
190/*
191 *	vm_page_startup:
192 *
193 *	Initializes the resident memory module.
194 *
195 *	Allocates memory for the page cells, and
196 *	for the object/offset-to-page hash table headers.
197 *	Each page cell is initialized and placed on the free list.
198 */
199vm_offset_t
200vm_page_startup(vm_offset_t vaddr)
201{
202	vm_offset_t mapped;
203	vm_size_t npages;
204	vm_paddr_t page_range;
205	vm_paddr_t new_end;
206	int i;
207	vm_paddr_t pa;
208	int nblocks;
209	vm_paddr_t last_pa;
210	char *list;
211
212	/* the biggest memory array is the second group of pages */
213	vm_paddr_t end;
214	vm_paddr_t biggestsize;
215	vm_paddr_t low_water, high_water;
216	int biggestone;
217
218	vm_paddr_t total;
219
220	total = 0;
221	biggestsize = 0;
222	biggestone = 0;
223	nblocks = 0;
224	vaddr = round_page(vaddr);
225
226	for (i = 0; phys_avail[i + 1]; i += 2) {
227		phys_avail[i] = round_page(phys_avail[i]);
228		phys_avail[i + 1] = trunc_page(phys_avail[i + 1]);
229	}
230
231	low_water = phys_avail[0];
232	high_water = phys_avail[1];
233
234	for (i = 0; phys_avail[i + 1]; i += 2) {
235		vm_paddr_t size = phys_avail[i + 1] - phys_avail[i];
236
237		if (size > biggestsize) {
238			biggestone = i;
239			biggestsize = size;
240		}
241		if (phys_avail[i] < low_water)
242			low_water = phys_avail[i];
243		if (phys_avail[i + 1] > high_water)
244			high_water = phys_avail[i + 1];
245		++nblocks;
246		total += size;
247	}
248
249	end = phys_avail[biggestone+1];
250
251	/*
252	 * Initialize the locks.
253	 */
254	mtx_init(&vm_page_queue_mtx, "vm page queue mutex", NULL, MTX_DEF |
255	    MTX_RECURSE);
256	mtx_init(&vm_page_queue_free_mtx, "vm page queue free mutex", NULL,
257	    MTX_DEF);
258
259	/*
260	 * Initialize the queue headers for the free queue, the active queue
261	 * and the inactive queue.
262	 */
263	vm_pageq_init();
264
265	/*
266	 * Allocate memory for use when boot strapping the kernel memory
267	 * allocator.
268	 */
269	new_end = end - (boot_pages * UMA_SLAB_SIZE);
270	new_end = trunc_page(new_end);
271	mapped = pmap_map(&vaddr, new_end, end,
272	    VM_PROT_READ | VM_PROT_WRITE);
273	bzero((void *)mapped, end - new_end);
274	uma_startup((void *)mapped, boot_pages);
275
276#if defined(__amd64__) || defined(__i386__)
277	/*
278	 * Allocate a bitmap to indicate that a random physical page
279	 * needs to be included in a minidump.
280	 *
281	 * The amd64 port needs this to indicate which direct map pages
282	 * need to be dumped, via calls to dump_add_page()/dump_drop_page().
283	 *
284	 * However, i386 still needs this workspace internally within the
285	 * minidump code.  In theory, they are not needed on i386, but are
286	 * included should the sf_buf code decide to use them.
287	 */
288	page_range = phys_avail[(nblocks - 1) * 2 + 1] / PAGE_SIZE;
289	vm_page_dump_size = round_page(roundup2(page_range, NBBY) / NBBY);
290	new_end -= vm_page_dump_size;
291	vm_page_dump = (void *)(uintptr_t)pmap_map(&vaddr, new_end,
292	    new_end + vm_page_dump_size, VM_PROT_READ | VM_PROT_WRITE);
293	bzero((void *)vm_page_dump, vm_page_dump_size);
294#endif
295	/*
296	 * Compute the number of pages of memory that will be available for
297	 * use (taking into account the overhead of a page structure per
298	 * page).
299	 */
300	first_page = low_water / PAGE_SIZE;
301	page_range = high_water / PAGE_SIZE - first_page;
302	npages = (total - (page_range * sizeof(struct vm_page)) -
303	    (end - new_end)) / PAGE_SIZE;
304	end = new_end;
305
306	/*
307	 * Reserve an unmapped guard page to trap access to vm_page_array[-1].
308	 */
309	vaddr += PAGE_SIZE;
310
311	/*
312	 * Initialize the mem entry structures now, and put them in the free
313	 * queue.
314	 */
315	new_end = trunc_page(end - page_range * sizeof(struct vm_page));
316	mapped = pmap_map(&vaddr, new_end, end,
317	    VM_PROT_READ | VM_PROT_WRITE);
318	vm_page_array = (vm_page_t) mapped;
319#ifdef __amd64__
320	/*
321	 * pmap_map on amd64 comes out of the direct-map, not kvm like i386,
322	 * so the pages must be tracked for a crashdump to include this data.
323	 * This includes the vm_page_array and the early UMA bootstrap pages.
324	 */
325	for (pa = new_end; pa < phys_avail[biggestone + 1]; pa += PAGE_SIZE)
326		dump_add_page(pa);
327#endif
328	phys_avail[biggestone + 1] = new_end;
329
330	/*
331	 * Clear all of the page structures
332	 */
333	bzero((caddr_t) vm_page_array, page_range * sizeof(struct vm_page));
334	vm_page_array_size = page_range;
335
336	/*
337	 * This assertion tests the hypothesis that npages and total are
338	 * redundant.  XXX
339	 */
340	page_range = 0;
341	for (i = 0; phys_avail[i + 1] != 0; i += 2)
342		page_range += atop(phys_avail[i + 1] - phys_avail[i]);
343	KASSERT(page_range == npages,
344	    ("vm_page_startup: inconsistent page counts"));
345
346	/*
347	 * Construct the free queue(s) in descending order (by physical
348	 * address) so that the first 16MB of physical memory is allocated
349	 * last rather than first.  On large-memory machines, this avoids
350	 * the exhaustion of low physical memory before isa_dma_init has run.
351	 */
352	cnt.v_page_count = 0;
353	cnt.v_free_count = 0;
354	list = getenv("vm.blacklist");
355	for (i = 0; phys_avail[i + 1] != 0; i += 2) {
356		pa = phys_avail[i];
357		last_pa = phys_avail[i + 1];
358		while (pa < last_pa) {
359			if (list != NULL &&
360			    vm_page_blacklist_lookup(list, pa))
361				printf("Skipping page with pa 0x%jx\n",
362				    (uintmax_t)pa);
363			else
364				vm_pageq_add_new_page(pa);
365			pa += PAGE_SIZE;
366		}
367	}
368	freeenv(list);
369	return (vaddr);
370}
371
372void
373vm_page_flag_set(vm_page_t m, unsigned short bits)
374{
375
376	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
377	m->flags |= bits;
378}
379
380void
381vm_page_flag_clear(vm_page_t m, unsigned short bits)
382{
383
384	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
385	m->flags &= ~bits;
386}
387
388void
389vm_page_busy(vm_page_t m)
390{
391
392	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
393	KASSERT((m->oflags & VPO_BUSY) == 0,
394	    ("vm_page_busy: page already busy!!!"));
395	m->oflags |= VPO_BUSY;
396}
397
398/*
399 *      vm_page_flash:
400 *
401 *      wakeup anyone waiting for the page.
402 */
403void
404vm_page_flash(vm_page_t m)
405{
406
407	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
408	if (m->oflags & VPO_WANTED) {
409		m->oflags &= ~VPO_WANTED;
410		wakeup(m);
411	}
412}
413
414/*
415 *      vm_page_wakeup:
416 *
417 *      clear the VPO_BUSY flag and wakeup anyone waiting for the
418 *      page.
419 *
420 */
421void
422vm_page_wakeup(vm_page_t m)
423{
424
425	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
426	KASSERT(m->oflags & VPO_BUSY, ("vm_page_wakeup: page not busy!!!"));
427	m->oflags &= ~VPO_BUSY;
428	vm_page_flash(m);
429}
430
431void
432vm_page_io_start(vm_page_t m)
433{
434
435	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
436	m->busy++;
437}
438
439void
440vm_page_io_finish(vm_page_t m)
441{
442
443	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
444	m->busy--;
445	if (m->busy == 0)
446		vm_page_flash(m);
447}
448
449/*
450 * Keep page from being freed by the page daemon
451 * much of the same effect as wiring, except much lower
452 * overhead and should be used only for *very* temporary
453 * holding ("wiring").
454 */
455void
456vm_page_hold(vm_page_t mem)
457{
458
459	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
460        mem->hold_count++;
461}
462
463void
464vm_page_unhold(vm_page_t mem)
465{
466
467	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
468	--mem->hold_count;
469	KASSERT(mem->hold_count >= 0, ("vm_page_unhold: hold count < 0!!!"));
470	if (mem->hold_count == 0 && VM_PAGE_INQUEUE2(mem, PQ_HOLD))
471		vm_page_free_toq(mem);
472}
473
474/*
475 *	vm_page_free:
476 *
477 *	Free a page
478 *
479 *	The clearing of PG_ZERO is a temporary safety until the code can be
480 *	reviewed to determine that PG_ZERO is being properly cleared on
481 *	write faults or maps.  PG_ZERO was previously cleared in
482 *	vm_page_alloc().
483 */
484void
485vm_page_free(vm_page_t m)
486{
487	vm_page_flag_clear(m, PG_ZERO);
488	vm_page_free_toq(m);
489}
490
491/*
492 *	vm_page_free_zero:
493 *
494 *	Free a page to the zerod-pages queue
495 */
496void
497vm_page_free_zero(vm_page_t m)
498{
499	vm_page_flag_set(m, PG_ZERO);
500	vm_page_free_toq(m);
501}
502
503/*
504 *	vm_page_sleep:
505 *
506 *	Sleep and release the page queues lock.
507 *
508 *	The object containing the given page must be locked.
509 */
510void
511vm_page_sleep(vm_page_t m, const char *msg)
512{
513
514	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
515	if (!mtx_owned(&vm_page_queue_mtx))
516		vm_page_lock_queues();
517	vm_page_flag_set(m, PG_REFERENCED);
518	vm_page_unlock_queues();
519
520	/*
521	 * It's possible that while we sleep, the page will get
522	 * unbusied and freed.  If we are holding the object
523	 * lock, we will assume we hold a reference to the object
524	 * such that even if m->object changes, we can re-lock
525	 * it.
526	 */
527	m->oflags |= VPO_WANTED;
528	msleep(m, VM_OBJECT_MTX(m->object), PVM, msg, 0);
529}
530
531/*
532 *	vm_page_dirty:
533 *
534 *	make page all dirty
535 */
536void
537vm_page_dirty(vm_page_t m)
538{
539	KASSERT(VM_PAGE_GETKNOWNQUEUE1(m) != PQ_CACHE,
540	    ("vm_page_dirty: page in cache!"));
541	KASSERT(VM_PAGE_GETKNOWNQUEUE1(m) != PQ_FREE,
542	    ("vm_page_dirty: page is free!"));
543	m->dirty = VM_PAGE_BITS_ALL;
544}
545
546/*
547 *	vm_page_splay:
548 *
549 *	Implements Sleator and Tarjan's top-down splay algorithm.  Returns
550 *	the vm_page containing the given pindex.  If, however, that
551 *	pindex is not found in the vm_object, returns a vm_page that is
552 *	adjacent to the pindex, coming before or after it.
553 */
554vm_page_t
555vm_page_splay(vm_pindex_t pindex, vm_page_t root)
556{
557	struct vm_page dummy;
558	vm_page_t lefttreemax, righttreemin, y;
559
560	if (root == NULL)
561		return (root);
562	lefttreemax = righttreemin = &dummy;
563	for (;; root = y) {
564		if (pindex < root->pindex) {
565			if ((y = root->left) == NULL)
566				break;
567			if (pindex < y->pindex) {
568				/* Rotate right. */
569				root->left = y->right;
570				y->right = root;
571				root = y;
572				if ((y = root->left) == NULL)
573					break;
574			}
575			/* Link into the new root's right tree. */
576			righttreemin->left = root;
577			righttreemin = root;
578		} else if (pindex > root->pindex) {
579			if ((y = root->right) == NULL)
580				break;
581			if (pindex > y->pindex) {
582				/* Rotate left. */
583				root->right = y->left;
584				y->left = root;
585				root = y;
586				if ((y = root->right) == NULL)
587					break;
588			}
589			/* Link into the new root's left tree. */
590			lefttreemax->right = root;
591			lefttreemax = root;
592		} else
593			break;
594	}
595	/* Assemble the new root. */
596	lefttreemax->right = root->left;
597	righttreemin->left = root->right;
598	root->left = dummy.right;
599	root->right = dummy.left;
600	return (root);
601}
602
603/*
604 *	vm_page_insert:		[ internal use only ]
605 *
606 *	Inserts the given mem entry into the object and object list.
607 *
608 *	The pagetables are not updated but will presumably fault the page
609 *	in if necessary, or if a kernel page the caller will at some point
610 *	enter the page into the kernel's pmap.  We are not allowed to block
611 *	here so we *can't* do this anyway.
612 *
613 *	The object and page must be locked.
614 *	This routine may not block.
615 */
616void
617vm_page_insert(vm_page_t m, vm_object_t object, vm_pindex_t pindex)
618{
619	vm_page_t root;
620
621	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
622	if (m->object != NULL)
623		panic("vm_page_insert: page already inserted");
624
625	/*
626	 * Record the object/offset pair in this page
627	 */
628	m->object = object;
629	m->pindex = pindex;
630
631	/*
632	 * Now link into the object's ordered list of backed pages.
633	 */
634	root = object->root;
635	if (root == NULL) {
636		m->left = NULL;
637		m->right = NULL;
638		TAILQ_INSERT_TAIL(&object->memq, m, listq);
639	} else {
640		root = vm_page_splay(pindex, root);
641		if (pindex < root->pindex) {
642			m->left = root->left;
643			m->right = root;
644			root->left = NULL;
645			TAILQ_INSERT_BEFORE(root, m, listq);
646		} else if (pindex == root->pindex)
647			panic("vm_page_insert: offset already allocated");
648		else {
649			m->right = root->right;
650			m->left = root;
651			root->right = NULL;
652			TAILQ_INSERT_AFTER(&object->memq, root, m, listq);
653		}
654	}
655	object->root = m;
656	object->generation++;
657
658	/*
659	 * show that the object has one more resident page.
660	 */
661	object->resident_page_count++;
662	/*
663	 * Hold the vnode until the last page is released.
664	 */
665	if (object->resident_page_count == 1 && object->type == OBJT_VNODE)
666		vhold((struct vnode *)object->handle);
667
668	/*
669	 * Since we are inserting a new and possibly dirty page,
670	 * update the object's OBJ_MIGHTBEDIRTY flag.
671	 */
672	if (m->flags & PG_WRITEABLE)
673		vm_object_set_writeable_dirty(object);
674}
675
676/*
677 *	vm_page_remove:
678 *				NOTE: used by device pager as well -wfj
679 *
680 *	Removes the given mem entry from the object/offset-page
681 *	table and the object page list, but do not invalidate/terminate
682 *	the backing store.
683 *
684 *	The object and page must be locked.
685 *	The underlying pmap entry (if any) is NOT removed here.
686 *	This routine may not block.
687 */
688void
689vm_page_remove(vm_page_t m)
690{
691	vm_object_t object;
692	vm_page_t root;
693
694	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
695	if ((object = m->object) == NULL)
696		return;
697	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
698	if (m->oflags & VPO_BUSY) {
699		m->oflags &= ~VPO_BUSY;
700		vm_page_flash(m);
701	}
702
703	/*
704	 * Now remove from the object's list of backed pages.
705	 */
706	if (m != object->root)
707		vm_page_splay(m->pindex, object->root);
708	if (m->left == NULL)
709		root = m->right;
710	else {
711		root = vm_page_splay(m->pindex, m->left);
712		root->right = m->right;
713	}
714	object->root = root;
715	TAILQ_REMOVE(&object->memq, m, listq);
716
717	/*
718	 * And show that the object has one fewer resident page.
719	 */
720	object->resident_page_count--;
721	object->generation++;
722	/*
723	 * The vnode may now be recycled.
724	 */
725	if (object->resident_page_count == 0 && object->type == OBJT_VNODE)
726		vdrop((struct vnode *)object->handle);
727
728	m->object = NULL;
729}
730
731/*
732 *	vm_page_lookup:
733 *
734 *	Returns the page associated with the object/offset
735 *	pair specified; if none is found, NULL is returned.
736 *
737 *	The object must be locked.
738 *	This routine may not block.
739 *	This is a critical path routine
740 */
741vm_page_t
742vm_page_lookup(vm_object_t object, vm_pindex_t pindex)
743{
744	vm_page_t m;
745
746	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
747	if ((m = object->root) != NULL && m->pindex != pindex) {
748		m = vm_page_splay(pindex, m);
749		if ((object->root = m)->pindex != pindex)
750			m = NULL;
751	}
752	return (m);
753}
754
755/*
756 *	vm_page_rename:
757 *
758 *	Move the given memory entry from its
759 *	current object to the specified target object/offset.
760 *
761 *	The object must be locked.
762 *	This routine may not block.
763 *
764 *	Note: swap associated with the page must be invalidated by the move.  We
765 *	      have to do this for several reasons:  (1) we aren't freeing the
766 *	      page, (2) we are dirtying the page, (3) the VM system is probably
767 *	      moving the page from object A to B, and will then later move
768 *	      the backing store from A to B and we can't have a conflict.
769 *
770 *	Note: we *always* dirty the page.  It is necessary both for the
771 *	      fact that we moved it, and because we may be invalidating
772 *	      swap.  If the page is on the cache, we have to deactivate it
773 *	      or vm_page_dirty() will panic.  Dirty pages are not allowed
774 *	      on the cache.
775 */
776void
777vm_page_rename(vm_page_t m, vm_object_t new_object, vm_pindex_t new_pindex)
778{
779
780	vm_page_remove(m);
781	vm_page_insert(m, new_object, new_pindex);
782	if (VM_PAGE_INQUEUE1(m, PQ_CACHE))
783		vm_page_deactivate(m);
784	vm_page_dirty(m);
785}
786
787/*
788 *	vm_page_select_cache:
789 *
790 *	Move a page of the given color from the cache queue to the free
791 *	queue.  As pages might be found, but are not applicable, they are
792 *	deactivated.
793 *
794 *	This routine may not block.
795 */
796vm_page_t
797vm_page_select_cache(int color)
798{
799	vm_object_t object;
800	vm_page_t m;
801	boolean_t was_trylocked;
802
803	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
804	while ((m = vm_pageq_find(PQ_CACHE, color, FALSE)) != NULL) {
805		KASSERT(m->dirty == 0, ("Found dirty cache page %p", m));
806		KASSERT(!pmap_page_is_mapped(m),
807		    ("Found mapped cache page %p", m));
808		KASSERT((m->flags & PG_UNMANAGED) == 0,
809		    ("Found unmanaged cache page %p", m));
810		KASSERT(m->wire_count == 0, ("Found wired cache page %p", m));
811		if (m->hold_count == 0 && (object = m->object,
812		    (was_trylocked = VM_OBJECT_TRYLOCK(object)) ||
813		    VM_OBJECT_LOCKED(object))) {
814			KASSERT((m->oflags & VPO_BUSY) == 0 && m->busy == 0,
815			    ("Found busy cache page %p", m));
816			vm_page_free(m);
817			if (was_trylocked)
818				VM_OBJECT_UNLOCK(object);
819			break;
820		}
821		vm_page_deactivate(m);
822	}
823	return (m);
824}
825
826/*
827 *	vm_page_alloc:
828 *
829 *	Allocate and return a memory cell associated
830 *	with this VM object/offset pair.
831 *
832 *	page_req classes:
833 *	VM_ALLOC_NORMAL		normal process request
834 *	VM_ALLOC_SYSTEM		system *really* needs a page
835 *	VM_ALLOC_INTERRUPT	interrupt time request
836 *	VM_ALLOC_ZERO		zero page
837 *
838 *	This routine may not block.
839 *
840 *	Additional special handling is required when called from an
841 *	interrupt (VM_ALLOC_INTERRUPT).  We are not allowed to mess with
842 *	the page cache in this case.
843 */
844vm_page_t
845vm_page_alloc(vm_object_t object, vm_pindex_t pindex, int req)
846{
847	vm_page_t m = NULL;
848	int color, flags, page_req;
849
850	page_req = req & VM_ALLOC_CLASS_MASK;
851	KASSERT(curthread->td_intr_nesting_level == 0 ||
852	    page_req == VM_ALLOC_INTERRUPT,
853	    ("vm_page_alloc(NORMAL|SYSTEM) in interrupt context"));
854
855	if ((req & VM_ALLOC_NOOBJ) == 0) {
856		KASSERT(object != NULL,
857		    ("vm_page_alloc: NULL object."));
858		VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
859		color = (pindex + object->pg_color) & PQ_COLORMASK;
860	} else
861		color = pindex & PQ_COLORMASK;
862
863	/*
864	 * The pager is allowed to eat deeper into the free page list.
865	 */
866	if ((curproc == pageproc) && (page_req != VM_ALLOC_INTERRUPT)) {
867		page_req = VM_ALLOC_SYSTEM;
868	};
869
870loop:
871	mtx_lock(&vm_page_queue_free_mtx);
872	if (cnt.v_free_count > cnt.v_free_reserved ||
873	    (page_req == VM_ALLOC_SYSTEM &&
874	     cnt.v_cache_count == 0 &&
875	     cnt.v_free_count > cnt.v_interrupt_free_min) ||
876	    (page_req == VM_ALLOC_INTERRUPT && cnt.v_free_count > 0)) {
877		/*
878		 * Allocate from the free queue if the number of free pages
879		 * exceeds the minimum for the request class.
880		 */
881		m = vm_pageq_find(PQ_FREE, color, (req & VM_ALLOC_ZERO) != 0);
882	} else if (page_req != VM_ALLOC_INTERRUPT) {
883		mtx_unlock(&vm_page_queue_free_mtx);
884		/*
885		 * Allocatable from cache (non-interrupt only).  On success,
886		 * we must free the page and try again, thus ensuring that
887		 * cnt.v_*_free_min counters are replenished.
888		 */
889		vm_page_lock_queues();
890		if ((m = vm_page_select_cache(color)) == NULL) {
891			KASSERT(cnt.v_cache_count == 0,
892			    ("vm_page_alloc: cache queue is missing %d pages",
893			    cnt.v_cache_count));
894			vm_page_unlock_queues();
895			atomic_add_int(&vm_pageout_deficit, 1);
896			pagedaemon_wakeup();
897
898			if (page_req != VM_ALLOC_SYSTEM)
899				return (NULL);
900
901			mtx_lock(&vm_page_queue_free_mtx);
902			if (cnt.v_free_count <= cnt.v_interrupt_free_min) {
903				mtx_unlock(&vm_page_queue_free_mtx);
904				return (NULL);
905			}
906			m = vm_pageq_find(PQ_FREE, color, (req & VM_ALLOC_ZERO) != 0);
907		} else {
908			vm_page_unlock_queues();
909			goto loop;
910		}
911	} else {
912		/*
913		 * Not allocatable from cache from interrupt, give up.
914		 */
915		mtx_unlock(&vm_page_queue_free_mtx);
916		atomic_add_int(&vm_pageout_deficit, 1);
917		pagedaemon_wakeup();
918		return (NULL);
919	}
920
921	/*
922	 *  At this point we had better have found a good page.
923	 */
924
925	KASSERT(
926	    m != NULL,
927	    ("vm_page_alloc(): missing page on free queue")
928	);
929
930	/*
931	 * Remove from free queue
932	 */
933	vm_pageq_remove_nowakeup(m);
934
935	/*
936	 * Initialize structure.  Only the PG_ZERO flag is inherited.
937	 */
938	flags = 0;
939	if (m->flags & PG_ZERO) {
940		vm_page_zero_count--;
941		if (req & VM_ALLOC_ZERO)
942			flags = PG_ZERO;
943	}
944	m->flags = flags;
945	if (req & (VM_ALLOC_NOBUSY | VM_ALLOC_NOOBJ))
946		m->oflags = 0;
947	else
948		m->oflags = VPO_BUSY;
949	if (req & VM_ALLOC_WIRED) {
950		atomic_add_int(&cnt.v_wire_count, 1);
951		m->wire_count = 1;
952	} else
953		m->wire_count = 0;
954	m->hold_count = 0;
955	m->act_count = 0;
956	m->busy = 0;
957	m->valid = 0;
958	KASSERT(m->dirty == 0, ("vm_page_alloc: free/cache page %p was dirty", m));
959	mtx_unlock(&vm_page_queue_free_mtx);
960
961	if ((req & VM_ALLOC_NOOBJ) == 0)
962		vm_page_insert(m, object, pindex);
963	else
964		m->pindex = pindex;
965
966	/*
967	 * Don't wakeup too often - wakeup the pageout daemon when
968	 * we would be nearly out of memory.
969	 */
970	if (vm_paging_needed())
971		pagedaemon_wakeup();
972
973	return (m);
974}
975
976/*
977 *	vm_wait:	(also see VM_WAIT macro)
978 *
979 *	Block until free pages are available for allocation
980 *	- Called in various places before memory allocations.
981 */
982void
983vm_wait(void)
984{
985
986	mtx_lock(&vm_page_queue_free_mtx);
987	if (curproc == pageproc) {
988		vm_pageout_pages_needed = 1;
989		msleep(&vm_pageout_pages_needed, &vm_page_queue_free_mtx,
990		    PDROP | PSWP, "VMWait", 0);
991	} else {
992		if (!vm_pages_needed) {
993			vm_pages_needed = 1;
994			wakeup(&vm_pages_needed);
995		}
996		msleep(&cnt.v_free_count, &vm_page_queue_free_mtx, PDROP | PVM,
997		    "vmwait", 0);
998	}
999}
1000
1001/*
1002 *	vm_waitpfault:	(also see VM_WAITPFAULT macro)
1003 *
1004 *	Block until free pages are available for allocation
1005 *	- Called only in vm_fault so that processes page faulting
1006 *	  can be easily tracked.
1007 *	- Sleeps at a lower priority than vm_wait() so that vm_wait()ing
1008 *	  processes will be able to grab memory first.  Do not change
1009 *	  this balance without careful testing first.
1010 */
1011void
1012vm_waitpfault(void)
1013{
1014
1015	mtx_lock(&vm_page_queue_free_mtx);
1016	if (!vm_pages_needed) {
1017		vm_pages_needed = 1;
1018		wakeup(&vm_pages_needed);
1019	}
1020	msleep(&cnt.v_free_count, &vm_page_queue_free_mtx, PDROP | PUSER,
1021	    "pfault", 0);
1022}
1023
1024/*
1025 *	vm_page_activate:
1026 *
1027 *	Put the specified page on the active list (if appropriate).
1028 *	Ensure that act_count is at least ACT_INIT but do not otherwise
1029 *	mess with it.
1030 *
1031 *	The page queues must be locked.
1032 *	This routine may not block.
1033 */
1034void
1035vm_page_activate(vm_page_t m)
1036{
1037
1038	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1039	if (VM_PAGE_GETKNOWNQUEUE2(m) != PQ_ACTIVE) {
1040		if (VM_PAGE_INQUEUE1(m, PQ_CACHE))
1041			cnt.v_reactivated++;
1042		vm_pageq_remove(m);
1043		if (m->wire_count == 0 && (m->flags & PG_UNMANAGED) == 0) {
1044			if (m->act_count < ACT_INIT)
1045				m->act_count = ACT_INIT;
1046			vm_pageq_enqueue(PQ_ACTIVE, m);
1047		}
1048	} else {
1049		if (m->act_count < ACT_INIT)
1050			m->act_count = ACT_INIT;
1051	}
1052}
1053
1054/*
1055 *	vm_page_free_wakeup:
1056 *
1057 *	Helper routine for vm_page_free_toq() and vm_page_cache().  This
1058 *	routine is called when a page has been added to the cache or free
1059 *	queues.
1060 *
1061 *	The page queues must be locked.
1062 *	This routine may not block.
1063 */
1064static inline void
1065vm_page_free_wakeup(void)
1066{
1067
1068	mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
1069	/*
1070	 * if pageout daemon needs pages, then tell it that there are
1071	 * some free.
1072	 */
1073	if (vm_pageout_pages_needed &&
1074	    cnt.v_cache_count + cnt.v_free_count >= cnt.v_pageout_free_min) {
1075		wakeup(&vm_pageout_pages_needed);
1076		vm_pageout_pages_needed = 0;
1077	}
1078	/*
1079	 * wakeup processes that are waiting on memory if we hit a
1080	 * high water mark. And wakeup scheduler process if we have
1081	 * lots of memory. this process will swapin processes.
1082	 */
1083	if (vm_pages_needed && !vm_page_count_min()) {
1084		vm_pages_needed = 0;
1085		wakeup(&cnt.v_free_count);
1086	}
1087}
1088
1089/*
1090 *	vm_page_free_toq:
1091 *
1092 *	Returns the given page to the PQ_FREE list,
1093 *	disassociating it with any VM object.
1094 *
1095 *	Object and page must be locked prior to entry.
1096 *	This routine may not block.
1097 */
1098
1099void
1100vm_page_free_toq(vm_page_t m)
1101{
1102	struct vpgqueues *pq;
1103
1104	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1105	KASSERT(!pmap_page_is_mapped(m),
1106	    ("vm_page_free_toq: freeing mapped page %p", m));
1107	cnt.v_tfree++;
1108
1109	if (m->busy || VM_PAGE_INQUEUE1(m, PQ_FREE)) {
1110		printf(
1111		"vm_page_free: pindex(%lu), busy(%d), VPO_BUSY(%d), hold(%d)\n",
1112		    (u_long)m->pindex, m->busy, (m->oflags & VPO_BUSY) ? 1 : 0,
1113		    m->hold_count);
1114		if (VM_PAGE_INQUEUE1(m, PQ_FREE))
1115			panic("vm_page_free: freeing free page");
1116		else
1117			panic("vm_page_free: freeing busy page");
1118	}
1119
1120	/*
1121	 * unqueue, then remove page.  Note that we cannot destroy
1122	 * the page here because we do not want to call the pager's
1123	 * callback routine until after we've put the page on the
1124	 * appropriate free queue.
1125	 */
1126	vm_pageq_remove_nowakeup(m);
1127	vm_page_remove(m);
1128
1129	/*
1130	 * If fictitious remove object association and
1131	 * return, otherwise delay object association removal.
1132	 */
1133	if ((m->flags & PG_FICTITIOUS) != 0) {
1134		return;
1135	}
1136
1137	m->valid = 0;
1138	vm_page_undirty(m);
1139
1140	if (m->wire_count != 0) {
1141		if (m->wire_count > 1) {
1142			panic("vm_page_free: invalid wire count (%d), pindex: 0x%lx",
1143				m->wire_count, (long)m->pindex);
1144		}
1145		panic("vm_page_free: freeing wired page");
1146	}
1147	if (m->hold_count != 0) {
1148		m->flags &= ~PG_ZERO;
1149		vm_pageq_enqueue(PQ_HOLD, m);
1150		return;
1151	}
1152	VM_PAGE_SETQUEUE1(m, PQ_FREE);
1153	mtx_lock(&vm_page_queue_free_mtx);
1154	pq = &vm_page_queues[VM_PAGE_GETQUEUE(m)];
1155	pq->lcnt++;
1156	++(*pq->cnt);
1157
1158	/*
1159	 * Put zero'd pages on the end ( where we look for zero'd pages
1160	 * first ) and non-zerod pages at the head.
1161	 */
1162	if (m->flags & PG_ZERO) {
1163		TAILQ_INSERT_TAIL(&pq->pl, m, pageq);
1164		++vm_page_zero_count;
1165	} else {
1166		TAILQ_INSERT_HEAD(&pq->pl, m, pageq);
1167		vm_page_zero_idle_wakeup();
1168	}
1169	vm_page_free_wakeup();
1170	mtx_unlock(&vm_page_queue_free_mtx);
1171}
1172
1173/*
1174 *	vm_page_unmanage:
1175 *
1176 * 	Prevent PV management from being done on the page.  The page is
1177 *	removed from the paging queues as if it were wired, and as a
1178 *	consequence of no longer being managed the pageout daemon will not
1179 *	touch it (since there is no way to locate the pte mappings for the
1180 *	page).  madvise() calls that mess with the pmap will also no longer
1181 *	operate on the page.
1182 *
1183 *	Beyond that the page is still reasonably 'normal'.  Freeing the page
1184 *	will clear the flag.
1185 *
1186 *	This routine is used by OBJT_PHYS objects - objects using unswappable
1187 *	physical memory as backing store rather then swap-backed memory and
1188 *	will eventually be extended to support 4MB unmanaged physical
1189 *	mappings.
1190 */
1191void
1192vm_page_unmanage(vm_page_t m)
1193{
1194
1195	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1196	if ((m->flags & PG_UNMANAGED) == 0) {
1197		if (m->wire_count == 0)
1198			vm_pageq_remove(m);
1199	}
1200	vm_page_flag_set(m, PG_UNMANAGED);
1201}
1202
1203/*
1204 *	vm_page_wire:
1205 *
1206 *	Mark this page as wired down by yet
1207 *	another map, removing it from paging queues
1208 *	as necessary.
1209 *
1210 *	The page queues must be locked.
1211 *	This routine may not block.
1212 */
1213void
1214vm_page_wire(vm_page_t m)
1215{
1216
1217	/*
1218	 * Only bump the wire statistics if the page is not already wired,
1219	 * and only unqueue the page if it is on some queue (if it is unmanaged
1220	 * it is already off the queues).
1221	 */
1222	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1223	if (m->flags & PG_FICTITIOUS)
1224		return;
1225	if (m->wire_count == 0) {
1226		if ((m->flags & PG_UNMANAGED) == 0)
1227			vm_pageq_remove(m);
1228		atomic_add_int(&cnt.v_wire_count, 1);
1229	}
1230	m->wire_count++;
1231	KASSERT(m->wire_count != 0, ("vm_page_wire: wire_count overflow m=%p", m));
1232}
1233
1234/*
1235 *	vm_page_unwire:
1236 *
1237 *	Release one wiring of this page, potentially
1238 *	enabling it to be paged again.
1239 *
1240 *	Many pages placed on the inactive queue should actually go
1241 *	into the cache, but it is difficult to figure out which.  What
1242 *	we do instead, if the inactive target is well met, is to put
1243 *	clean pages at the head of the inactive queue instead of the tail.
1244 *	This will cause them to be moved to the cache more quickly and
1245 *	if not actively re-referenced, freed more quickly.  If we just
1246 *	stick these pages at the end of the inactive queue, heavy filesystem
1247 *	meta-data accesses can cause an unnecessary paging load on memory bound
1248 *	processes.  This optimization causes one-time-use metadata to be
1249 *	reused more quickly.
1250 *
1251 *	BUT, if we are in a low-memory situation we have no choice but to
1252 *	put clean pages on the cache queue.
1253 *
1254 *	A number of routines use vm_page_unwire() to guarantee that the page
1255 *	will go into either the inactive or active queues, and will NEVER
1256 *	be placed in the cache - for example, just after dirtying a page.
1257 *	dirty pages in the cache are not allowed.
1258 *
1259 *	The page queues must be locked.
1260 *	This routine may not block.
1261 */
1262void
1263vm_page_unwire(vm_page_t m, int activate)
1264{
1265
1266	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1267	if (m->flags & PG_FICTITIOUS)
1268		return;
1269	if (m->wire_count > 0) {
1270		m->wire_count--;
1271		if (m->wire_count == 0) {
1272			atomic_subtract_int(&cnt.v_wire_count, 1);
1273			if (m->flags & PG_UNMANAGED) {
1274				;
1275			} else if (activate)
1276				vm_pageq_enqueue(PQ_ACTIVE, m);
1277			else {
1278				vm_page_flag_clear(m, PG_WINATCFLS);
1279				vm_pageq_enqueue(PQ_INACTIVE, m);
1280			}
1281		}
1282	} else {
1283		panic("vm_page_unwire: invalid wire count: %d", m->wire_count);
1284	}
1285}
1286
1287
1288/*
1289 * Move the specified page to the inactive queue.  If the page has
1290 * any associated swap, the swap is deallocated.
1291 *
1292 * Normally athead is 0 resulting in LRU operation.  athead is set
1293 * to 1 if we want this page to be 'as if it were placed in the cache',
1294 * except without unmapping it from the process address space.
1295 *
1296 * This routine may not block.
1297 */
1298static inline void
1299_vm_page_deactivate(vm_page_t m, int athead)
1300{
1301
1302	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1303
1304	/*
1305	 * Ignore if already inactive.
1306	 */
1307	if (VM_PAGE_INQUEUE2(m, PQ_INACTIVE))
1308		return;
1309	if (m->wire_count == 0 && (m->flags & PG_UNMANAGED) == 0) {
1310		if (VM_PAGE_INQUEUE1(m, PQ_CACHE))
1311			cnt.v_reactivated++;
1312		vm_page_flag_clear(m, PG_WINATCFLS);
1313		vm_pageq_remove(m);
1314		if (athead)
1315			TAILQ_INSERT_HEAD(&vm_page_queues[PQ_INACTIVE].pl, m, pageq);
1316		else
1317			TAILQ_INSERT_TAIL(&vm_page_queues[PQ_INACTIVE].pl, m, pageq);
1318		VM_PAGE_SETQUEUE2(m, PQ_INACTIVE);
1319		vm_page_queues[PQ_INACTIVE].lcnt++;
1320		cnt.v_inactive_count++;
1321	}
1322}
1323
1324void
1325vm_page_deactivate(vm_page_t m)
1326{
1327    _vm_page_deactivate(m, 0);
1328}
1329
1330/*
1331 * vm_page_try_to_cache:
1332 *
1333 * Returns 0 on failure, 1 on success
1334 */
1335int
1336vm_page_try_to_cache(vm_page_t m)
1337{
1338
1339	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1340	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1341	if (m->dirty || m->hold_count || m->busy || m->wire_count ||
1342	    (m->oflags & VPO_BUSY) || (m->flags & PG_UNMANAGED)) {
1343		return (0);
1344	}
1345	pmap_remove_all(m);
1346	if (m->dirty)
1347		return (0);
1348	vm_page_cache(m);
1349	return (1);
1350}
1351
1352/*
1353 * vm_page_try_to_free()
1354 *
1355 *	Attempt to free the page.  If we cannot free it, we do nothing.
1356 *	1 is returned on success, 0 on failure.
1357 */
1358int
1359vm_page_try_to_free(vm_page_t m)
1360{
1361
1362	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1363	if (m->object != NULL)
1364		VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1365	if (m->dirty || m->hold_count || m->busy || m->wire_count ||
1366	    (m->oflags & VPO_BUSY) || (m->flags & PG_UNMANAGED)) {
1367		return (0);
1368	}
1369	pmap_remove_all(m);
1370	if (m->dirty)
1371		return (0);
1372	vm_page_free(m);
1373	return (1);
1374}
1375
1376/*
1377 * vm_page_cache
1378 *
1379 * Put the specified page onto the page cache queue (if appropriate).
1380 *
1381 * This routine may not block.
1382 */
1383void
1384vm_page_cache(vm_page_t m)
1385{
1386
1387	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1388	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1389	if ((m->flags & PG_UNMANAGED) || (m->oflags & VPO_BUSY) || m->busy ||
1390	    m->hold_count || m->wire_count) {
1391		printf("vm_page_cache: attempting to cache busy page\n");
1392		return;
1393	}
1394	if (VM_PAGE_INQUEUE1(m, PQ_CACHE))
1395		return;
1396
1397	/*
1398	 * Remove all pmaps and indicate that the page is not
1399	 * writeable or mapped.
1400	 */
1401	pmap_remove_all(m);
1402	if (m->dirty != 0) {
1403		panic("vm_page_cache: caching a dirty page, pindex: %ld",
1404			(long)m->pindex);
1405	}
1406	vm_pageq_remove_nowakeup(m);
1407	vm_pageq_enqueue(PQ_CACHE + m->pc, m);
1408	mtx_lock(&vm_page_queue_free_mtx);
1409	vm_page_free_wakeup();
1410	mtx_unlock(&vm_page_queue_free_mtx);
1411}
1412
1413/*
1414 * vm_page_dontneed
1415 *
1416 *	Cache, deactivate, or do nothing as appropriate.  This routine
1417 *	is typically used by madvise() MADV_DONTNEED.
1418 *
1419 *	Generally speaking we want to move the page into the cache so
1420 *	it gets reused quickly.  However, this can result in a silly syndrome
1421 *	due to the page recycling too quickly.  Small objects will not be
1422 *	fully cached.  On the otherhand, if we move the page to the inactive
1423 *	queue we wind up with a problem whereby very large objects
1424 *	unnecessarily blow away our inactive and cache queues.
1425 *
1426 *	The solution is to move the pages based on a fixed weighting.  We
1427 *	either leave them alone, deactivate them, or move them to the cache,
1428 *	where moving them to the cache has the highest weighting.
1429 *	By forcing some pages into other queues we eventually force the
1430 *	system to balance the queues, potentially recovering other unrelated
1431 *	space from active.  The idea is to not force this to happen too
1432 *	often.
1433 */
1434void
1435vm_page_dontneed(vm_page_t m)
1436{
1437	static int dnweight;
1438	int dnw;
1439	int head;
1440
1441	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1442	dnw = ++dnweight;
1443
1444	/*
1445	 * occassionally leave the page alone
1446	 */
1447	if ((dnw & 0x01F0) == 0 ||
1448	    VM_PAGE_INQUEUE2(m, PQ_INACTIVE) ||
1449	    VM_PAGE_INQUEUE1(m, PQ_CACHE)
1450	) {
1451		if (m->act_count >= ACT_INIT)
1452			--m->act_count;
1453		return;
1454	}
1455
1456	if (m->dirty == 0 && pmap_is_modified(m))
1457		vm_page_dirty(m);
1458
1459	if (m->dirty || (dnw & 0x0070) == 0) {
1460		/*
1461		 * Deactivate the page 3 times out of 32.
1462		 */
1463		head = 0;
1464	} else {
1465		/*
1466		 * Cache the page 28 times out of every 32.  Note that
1467		 * the page is deactivated instead of cached, but placed
1468		 * at the head of the queue instead of the tail.
1469		 */
1470		head = 1;
1471	}
1472	_vm_page_deactivate(m, head);
1473}
1474
1475/*
1476 * Grab a page, waiting until we are waken up due to the page
1477 * changing state.  We keep on waiting, if the page continues
1478 * to be in the object.  If the page doesn't exist, first allocate it
1479 * and then conditionally zero it.
1480 *
1481 * This routine may block.
1482 */
1483vm_page_t
1484vm_page_grab(vm_object_t object, vm_pindex_t pindex, int allocflags)
1485{
1486	vm_page_t m;
1487
1488	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1489retrylookup:
1490	if ((m = vm_page_lookup(object, pindex)) != NULL) {
1491		if (vm_page_sleep_if_busy(m, TRUE, "pgrbwt")) {
1492			if ((allocflags & VM_ALLOC_RETRY) == 0)
1493				return (NULL);
1494			goto retrylookup;
1495		} else {
1496			if ((allocflags & VM_ALLOC_WIRED) != 0) {
1497				vm_page_lock_queues();
1498				vm_page_wire(m);
1499				vm_page_unlock_queues();
1500			}
1501			if ((allocflags & VM_ALLOC_NOBUSY) == 0)
1502				vm_page_busy(m);
1503			return (m);
1504		}
1505	}
1506	m = vm_page_alloc(object, pindex, allocflags & ~VM_ALLOC_RETRY);
1507	if (m == NULL) {
1508		VM_OBJECT_UNLOCK(object);
1509		VM_WAIT;
1510		VM_OBJECT_LOCK(object);
1511		if ((allocflags & VM_ALLOC_RETRY) == 0)
1512			return (NULL);
1513		goto retrylookup;
1514	}
1515	if (allocflags & VM_ALLOC_ZERO && (m->flags & PG_ZERO) == 0)
1516		pmap_zero_page(m);
1517	return (m);
1518}
1519
1520/*
1521 * Mapping function for valid bits or for dirty bits in
1522 * a page.  May not block.
1523 *
1524 * Inputs are required to range within a page.
1525 */
1526inline int
1527vm_page_bits(int base, int size)
1528{
1529	int first_bit;
1530	int last_bit;
1531
1532	KASSERT(
1533	    base + size <= PAGE_SIZE,
1534	    ("vm_page_bits: illegal base/size %d/%d", base, size)
1535	);
1536
1537	if (size == 0)		/* handle degenerate case */
1538		return (0);
1539
1540	first_bit = base >> DEV_BSHIFT;
1541	last_bit = (base + size - 1) >> DEV_BSHIFT;
1542
1543	return ((2 << last_bit) - (1 << first_bit));
1544}
1545
1546/*
1547 *	vm_page_set_validclean:
1548 *
1549 *	Sets portions of a page valid and clean.  The arguments are expected
1550 *	to be DEV_BSIZE aligned but if they aren't the bitmap is inclusive
1551 *	of any partial chunks touched by the range.  The invalid portion of
1552 *	such chunks will be zero'd.
1553 *
1554 *	This routine may not block.
1555 *
1556 *	(base + size) must be less then or equal to PAGE_SIZE.
1557 */
1558void
1559vm_page_set_validclean(vm_page_t m, int base, int size)
1560{
1561	int pagebits;
1562	int frag;
1563	int endoff;
1564
1565	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1566	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1567	if (size == 0)	/* handle degenerate case */
1568		return;
1569
1570	/*
1571	 * If the base is not DEV_BSIZE aligned and the valid
1572	 * bit is clear, we have to zero out a portion of the
1573	 * first block.
1574	 */
1575	if ((frag = base & ~(DEV_BSIZE - 1)) != base &&
1576	    (m->valid & (1 << (base >> DEV_BSHIFT))) == 0)
1577		pmap_zero_page_area(m, frag, base - frag);
1578
1579	/*
1580	 * If the ending offset is not DEV_BSIZE aligned and the
1581	 * valid bit is clear, we have to zero out a portion of
1582	 * the last block.
1583	 */
1584	endoff = base + size;
1585	if ((frag = endoff & ~(DEV_BSIZE - 1)) != endoff &&
1586	    (m->valid & (1 << (endoff >> DEV_BSHIFT))) == 0)
1587		pmap_zero_page_area(m, endoff,
1588		    DEV_BSIZE - (endoff & (DEV_BSIZE - 1)));
1589
1590	/*
1591	 * Set valid, clear dirty bits.  If validating the entire
1592	 * page we can safely clear the pmap modify bit.  We also
1593	 * use this opportunity to clear the VPO_NOSYNC flag.  If a process
1594	 * takes a write fault on a MAP_NOSYNC memory area the flag will
1595	 * be set again.
1596	 *
1597	 * We set valid bits inclusive of any overlap, but we can only
1598	 * clear dirty bits for DEV_BSIZE chunks that are fully within
1599	 * the range.
1600	 */
1601	pagebits = vm_page_bits(base, size);
1602	m->valid |= pagebits;
1603#if 0	/* NOT YET */
1604	if ((frag = base & (DEV_BSIZE - 1)) != 0) {
1605		frag = DEV_BSIZE - frag;
1606		base += frag;
1607		size -= frag;
1608		if (size < 0)
1609			size = 0;
1610	}
1611	pagebits = vm_page_bits(base, size & (DEV_BSIZE - 1));
1612#endif
1613	m->dirty &= ~pagebits;
1614	if (base == 0 && size == PAGE_SIZE) {
1615		pmap_clear_modify(m);
1616		m->oflags &= ~VPO_NOSYNC;
1617	}
1618}
1619
1620void
1621vm_page_clear_dirty(vm_page_t m, int base, int size)
1622{
1623
1624	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1625	m->dirty &= ~vm_page_bits(base, size);
1626}
1627
1628/*
1629 *	vm_page_set_invalid:
1630 *
1631 *	Invalidates DEV_BSIZE'd chunks within a page.  Both the
1632 *	valid and dirty bits for the effected areas are cleared.
1633 *
1634 *	May not block.
1635 */
1636void
1637vm_page_set_invalid(vm_page_t m, int base, int size)
1638{
1639	int bits;
1640
1641	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1642	bits = vm_page_bits(base, size);
1643	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1644	if (m->valid == VM_PAGE_BITS_ALL && bits != 0)
1645		pmap_remove_all(m);
1646	m->valid &= ~bits;
1647	m->dirty &= ~bits;
1648	m->object->generation++;
1649}
1650
1651/*
1652 * vm_page_zero_invalid()
1653 *
1654 *	The kernel assumes that the invalid portions of a page contain
1655 *	garbage, but such pages can be mapped into memory by user code.
1656 *	When this occurs, we must zero out the non-valid portions of the
1657 *	page so user code sees what it expects.
1658 *
1659 *	Pages are most often semi-valid when the end of a file is mapped
1660 *	into memory and the file's size is not page aligned.
1661 */
1662void
1663vm_page_zero_invalid(vm_page_t m, boolean_t setvalid)
1664{
1665	int b;
1666	int i;
1667
1668	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1669	/*
1670	 * Scan the valid bits looking for invalid sections that
1671	 * must be zerod.  Invalid sub-DEV_BSIZE'd areas ( where the
1672	 * valid bit may be set ) have already been zerod by
1673	 * vm_page_set_validclean().
1674	 */
1675	for (b = i = 0; i <= PAGE_SIZE / DEV_BSIZE; ++i) {
1676		if (i == (PAGE_SIZE / DEV_BSIZE) ||
1677		    (m->valid & (1 << i))
1678		) {
1679			if (i > b) {
1680				pmap_zero_page_area(m,
1681				    b << DEV_BSHIFT, (i - b) << DEV_BSHIFT);
1682			}
1683			b = i + 1;
1684		}
1685	}
1686
1687	/*
1688	 * setvalid is TRUE when we can safely set the zero'd areas
1689	 * as being valid.  We can do this if there are no cache consistancy
1690	 * issues.  e.g. it is ok to do with UFS, but not ok to do with NFS.
1691	 */
1692	if (setvalid)
1693		m->valid = VM_PAGE_BITS_ALL;
1694}
1695
1696/*
1697 *	vm_page_is_valid:
1698 *
1699 *	Is (partial) page valid?  Note that the case where size == 0
1700 *	will return FALSE in the degenerate case where the page is
1701 *	entirely invalid, and TRUE otherwise.
1702 *
1703 *	May not block.
1704 */
1705int
1706vm_page_is_valid(vm_page_t m, int base, int size)
1707{
1708	int bits = vm_page_bits(base, size);
1709
1710	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
1711	if (m->valid && ((m->valid & bits) == bits))
1712		return 1;
1713	else
1714		return 0;
1715}
1716
1717/*
1718 * update dirty bits from pmap/mmu.  May not block.
1719 */
1720void
1721vm_page_test_dirty(vm_page_t m)
1722{
1723	if ((m->dirty != VM_PAGE_BITS_ALL) && pmap_is_modified(m)) {
1724		vm_page_dirty(m);
1725	}
1726}
1727
1728int so_zerocp_fullpage = 0;
1729
1730void
1731vm_page_cowfault(vm_page_t m)
1732{
1733	vm_page_t mnew;
1734	vm_object_t object;
1735	vm_pindex_t pindex;
1736
1737	object = m->object;
1738	pindex = m->pindex;
1739
1740 retry_alloc:
1741	pmap_remove_all(m);
1742	vm_page_remove(m);
1743	mnew = vm_page_alloc(object, pindex, VM_ALLOC_NORMAL | VM_ALLOC_NOBUSY);
1744	if (mnew == NULL) {
1745		vm_page_insert(m, object, pindex);
1746		vm_page_unlock_queues();
1747		VM_OBJECT_UNLOCK(object);
1748		VM_WAIT;
1749		VM_OBJECT_LOCK(object);
1750		vm_page_lock_queues();
1751		goto retry_alloc;
1752	}
1753
1754	if (m->cow == 0) {
1755		/*
1756		 * check to see if we raced with an xmit complete when
1757		 * waiting to allocate a page.  If so, put things back
1758		 * the way they were
1759		 */
1760		vm_page_free(mnew);
1761		vm_page_insert(m, object, pindex);
1762	} else { /* clear COW & copy page */
1763		if (!so_zerocp_fullpage)
1764			pmap_copy_page(m, mnew);
1765		mnew->valid = VM_PAGE_BITS_ALL;
1766		vm_page_dirty(mnew);
1767		mnew->wire_count = m->wire_count - m->cow;
1768		m->wire_count = m->cow;
1769	}
1770}
1771
1772void
1773vm_page_cowclear(vm_page_t m)
1774{
1775
1776	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1777	if (m->cow) {
1778		m->cow--;
1779		/*
1780		 * let vm_fault add back write permission  lazily
1781		 */
1782	}
1783	/*
1784	 *  sf_buf_free() will free the page, so we needn't do it here
1785	 */
1786}
1787
1788void
1789vm_page_cowsetup(vm_page_t m)
1790{
1791
1792	mtx_assert(&vm_page_queue_mtx, MA_OWNED);
1793	m->cow++;
1794	pmap_remove_write(m);
1795}
1796
1797#include "opt_ddb.h"
1798#ifdef DDB
1799#include <sys/kernel.h>
1800
1801#include <ddb/ddb.h>
1802
1803DB_SHOW_COMMAND(page, vm_page_print_page_info)
1804{
1805	db_printf("cnt.v_free_count: %d\n", cnt.v_free_count);
1806	db_printf("cnt.v_cache_count: %d\n", cnt.v_cache_count);
1807	db_printf("cnt.v_inactive_count: %d\n", cnt.v_inactive_count);
1808	db_printf("cnt.v_active_count: %d\n", cnt.v_active_count);
1809	db_printf("cnt.v_wire_count: %d\n", cnt.v_wire_count);
1810	db_printf("cnt.v_free_reserved: %d\n", cnt.v_free_reserved);
1811	db_printf("cnt.v_free_min: %d\n", cnt.v_free_min);
1812	db_printf("cnt.v_free_target: %d\n", cnt.v_free_target);
1813	db_printf("cnt.v_cache_min: %d\n", cnt.v_cache_min);
1814	db_printf("cnt.v_inactive_target: %d\n", cnt.v_inactive_target);
1815}
1816
1817DB_SHOW_COMMAND(pageq, vm_page_print_pageq_info)
1818{
1819	int i;
1820	db_printf("PQ_FREE:");
1821	for (i = 0; i < PQ_NUMCOLORS; i++) {
1822		db_printf(" %d", vm_page_queues[PQ_FREE + i].lcnt);
1823	}
1824	db_printf("\n");
1825
1826	db_printf("PQ_CACHE:");
1827	for (i = 0; i < PQ_NUMCOLORS; i++) {
1828		db_printf(" %d", vm_page_queues[PQ_CACHE + i].lcnt);
1829	}
1830	db_printf("\n");
1831
1832	db_printf("PQ_ACTIVE: %d, PQ_INACTIVE: %d\n",
1833		vm_page_queues[PQ_ACTIVE].lcnt,
1834		vm_page_queues[PQ_INACTIVE].lcnt);
1835}
1836#endif /* DDB */
1837