2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * from: @(#)vm_object.c 8.5 (Berkeley) 3/22/94
35 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36 * All rights reserved.
38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
40 * Permission to use, copy, modify and distribute this software and
41 * its documentation is hereby granted, provided that both the copyright
42 * notice and this permission notice appear in all copies of the
43 * software, derivative works or modified versions, and any portions
44 * thereof, and that both notices appear in supporting documentation.
46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
50 * Carnegie Mellon requests users of this software to return to
52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
53 * School of Computer Science
54 * Carnegie Mellon University
55 * Pittsburgh PA 15213-3890
57 * any improvements or extensions that they make and grant Carnegie the
58 * rights to redistribute these changes.
62 * Virtual memory object module.
65 #include <sys/cdefs.h>
66 __FBSDID("$FreeBSD$");
70 #include <sys/param.h>
71 #include <sys/systm.h>
74 #include <sys/mount.h>
75 #include <sys/kernel.h>
76 #include <sys/sysctl.h>
77 #include <sys/mutex.h>
78 #include <sys/proc.h> /* for curproc, pageproc */
79 #include <sys/socket.h>
80 #include <sys/resourcevar.h>
81 #include <sys/vnode.h>
82 #include <sys/vmmeter.h>
86 #include <vm/vm_param.h>
88 #include <vm/vm_map.h>
89 #include <vm/vm_object.h>
90 #include <vm/vm_page.h>
91 #include <vm/vm_pageout.h>
92 #include <vm/vm_pager.h>
93 #include <vm/swap_pager.h>
94 #include <vm/vm_kern.h>
95 #include <vm/vm_extern.h>
96 #include <vm/vm_reserv.h>
100 SYSCTL_INT(_vm, OID_AUTO, old_msync, CTLFLAG_RW, &old_msync, 0,
101 "Use old (insecure) msync behavior");
103 static int vm_object_page_collect_flush(vm_object_t object, vm_page_t p,
104 int pagerflags, int flags, boolean_t *clearobjflags,
106 static boolean_t vm_object_page_remove_write(vm_page_t p, int flags,
107 boolean_t *clearobjflags);
108 static void vm_object_qcollapse(vm_object_t object);
109 static void vm_object_vndeallocate(vm_object_t object);
112 * Virtual memory objects maintain the actual data
113 * associated with allocated virtual memory. A given
114 * page of memory exists within exactly one object.
116 * An object is only deallocated when all "references"
117 * are given up. Only one "reference" to a given
118 * region of an object should be writeable.
120 * Associated with each object is a list of all resident
121 * memory pages belonging to that object; this list is
122 * maintained by the "vm_page" module, and locked by the object's
125 * Each object also records a "pager" routine which is
126 * used to retrieve (and store) pages to the proper backing
127 * storage. In addition, objects may be backed by other
128 * objects from which they were virtual-copied.
130 * The only items within the object structure which are
131 * modified after time of creation are:
132 * reference count locked by object's lock
133 * pager routine locked by object's lock
137 struct object_q vm_object_list;
138 struct mtx vm_object_list_mtx; /* lock for object list and count */
140 struct vm_object kernel_object_store;
141 struct vm_object kmem_object_store;
143 static SYSCTL_NODE(_vm_stats, OID_AUTO, object, CTLFLAG_RD, 0,
146 static long object_collapses;
147 SYSCTL_LONG(_vm_stats_object, OID_AUTO, collapses, CTLFLAG_RD,
148 &object_collapses, 0, "VM object collapses");
150 static long object_bypasses;
151 SYSCTL_LONG(_vm_stats_object, OID_AUTO, bypasses, CTLFLAG_RD,
152 &object_bypasses, 0, "VM object bypasses");
154 static uma_zone_t obj_zone;
156 static int vm_object_zinit(void *mem, int size, int flags);
159 static void vm_object_zdtor(void *mem, int size, void *arg);
162 vm_object_zdtor(void *mem, int size, void *arg)
166 object = (vm_object_t)mem;
167 KASSERT(object->ref_count == 0,
168 ("object %p ref_count = %d", object, object->ref_count));
169 KASSERT(TAILQ_EMPTY(&object->memq),
170 ("object %p has resident pages",
172 #if VM_NRESERVLEVEL > 0
173 KASSERT(LIST_EMPTY(&object->rvq),
174 ("object %p has reservations",
177 KASSERT(object->cache == NULL,
178 ("object %p has cached pages",
180 KASSERT(object->paging_in_progress == 0,
181 ("object %p paging_in_progress = %d",
182 object, object->paging_in_progress));
183 KASSERT(object->resident_page_count == 0,
184 ("object %p resident_page_count = %d",
185 object, object->resident_page_count));
186 KASSERT(object->shadow_count == 0,
187 ("object %p shadow_count = %d",
188 object, object->shadow_count));
189 KASSERT(object->type == OBJT_DEAD,
190 ("object %p has non-dead type %d",
191 object, object->type));
196 vm_object_zinit(void *mem, int size, int flags)
200 object = (vm_object_t)mem;
201 bzero(&object->mtx, sizeof(object->mtx));
202 VM_OBJECT_LOCK_INIT(object, "standard object");
204 /* These are true for any object that has been freed */
205 object->type = OBJT_DEAD;
206 object->ref_count = 0;
207 object->paging_in_progress = 0;
208 object->resident_page_count = 0;
209 object->shadow_count = 0;
211 mtx_lock(&vm_object_list_mtx);
212 TAILQ_INSERT_TAIL(&vm_object_list, object, object_list);
213 mtx_unlock(&vm_object_list_mtx);
218 _vm_object_allocate(objtype_t type, vm_pindex_t size, vm_object_t object)
221 TAILQ_INIT(&object->memq);
222 LIST_INIT(&object->shadow_head);
227 object->generation = 1;
228 object->ref_count = 1;
229 object->memattr = VM_MEMATTR_DEFAULT;
233 if ((object->type == OBJT_DEFAULT) || (object->type == OBJT_SWAP))
234 object->flags = OBJ_ONEMAPPING;
235 object->pg_color = 0;
236 object->handle = NULL;
237 object->backing_object = NULL;
238 object->backing_object_offset = (vm_ooffset_t) 0;
239 #if VM_NRESERVLEVEL > 0
240 LIST_INIT(&object->rvq);
242 object->cache = NULL;
248 * Initialize the VM objects module.
253 TAILQ_INIT(&vm_object_list);
254 mtx_init(&vm_object_list_mtx, "vm object_list", NULL, MTX_DEF);
256 VM_OBJECT_LOCK_INIT(kernel_object, "kernel object");
257 _vm_object_allocate(OBJT_PHYS, OFF_TO_IDX(VM_MAX_KERNEL_ADDRESS - VM_MIN_KERNEL_ADDRESS),
259 #if VM_NRESERVLEVEL > 0
260 kernel_object->flags |= OBJ_COLORED;
261 kernel_object->pg_color = (u_short)atop(VM_MIN_KERNEL_ADDRESS);
264 VM_OBJECT_LOCK_INIT(kmem_object, "kmem object");
265 _vm_object_allocate(OBJT_PHYS, OFF_TO_IDX(VM_MAX_KERNEL_ADDRESS - VM_MIN_KERNEL_ADDRESS),
267 #if VM_NRESERVLEVEL > 0
268 kmem_object->flags |= OBJ_COLORED;
269 kmem_object->pg_color = (u_short)atop(VM_MIN_KERNEL_ADDRESS);
273 * The lock portion of struct vm_object must be type stable due
274 * to vm_pageout_fallback_object_lock locking a vm object
275 * without holding any references to it.
277 obj_zone = uma_zcreate("VM OBJECT", sizeof (struct vm_object), NULL,
283 vm_object_zinit, NULL, UMA_ALIGN_PTR, UMA_ZONE_VM|UMA_ZONE_NOFREE);
287 vm_object_clear_flag(vm_object_t object, u_short bits)
290 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
291 object->flags &= ~bits;
295 * Sets the default memory attribute for the specified object. Pages
296 * that are allocated to this object are by default assigned this memory
299 * Presently, this function must be called before any pages are allocated
300 * to the object. In the future, this requirement may be relaxed for
301 * "default" and "swap" objects.
304 vm_object_set_memattr(vm_object_t object, vm_memattr_t memattr)
307 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
308 switch (object->type) {
315 if (!TAILQ_EMPTY(&object->memq))
316 return (KERN_FAILURE);
319 return (KERN_INVALID_ARGUMENT);
321 object->memattr = memattr;
322 return (KERN_SUCCESS);
326 vm_object_pip_add(vm_object_t object, short i)
329 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
330 object->paging_in_progress += i;
334 vm_object_pip_subtract(vm_object_t object, short i)
337 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
338 object->paging_in_progress -= i;
342 vm_object_pip_wakeup(vm_object_t object)
345 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
346 object->paging_in_progress--;
347 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
348 vm_object_clear_flag(object, OBJ_PIPWNT);
354 vm_object_pip_wakeupn(vm_object_t object, short i)
357 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
359 object->paging_in_progress -= i;
360 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
361 vm_object_clear_flag(object, OBJ_PIPWNT);
367 vm_object_pip_wait(vm_object_t object, char *waitid)
370 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
371 while (object->paging_in_progress) {
372 object->flags |= OBJ_PIPWNT;
373 msleep(object, VM_OBJECT_MTX(object), PVM, waitid, 0);
378 * vm_object_allocate:
380 * Returns a new object with the given size.
383 vm_object_allocate(objtype_t type, vm_pindex_t size)
387 object = (vm_object_t)uma_zalloc(obj_zone, M_WAITOK);
388 _vm_object_allocate(type, size, object);
394 * vm_object_reference:
396 * Gets another reference to the given object. Note: OBJ_DEAD
397 * objects can be referenced during final cleaning.
400 vm_object_reference(vm_object_t object)
404 VM_OBJECT_LOCK(object);
405 vm_object_reference_locked(object);
406 VM_OBJECT_UNLOCK(object);
410 * vm_object_reference_locked:
412 * Gets another reference to the given object.
414 * The object must be locked.
417 vm_object_reference_locked(vm_object_t object)
421 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
423 if (object->type == OBJT_VNODE) {
430 * Handle deallocating an object of type OBJT_VNODE.
433 vm_object_vndeallocate(vm_object_t object)
435 struct vnode *vp = (struct vnode *) object->handle;
437 VFS_ASSERT_GIANT(vp->v_mount);
438 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
439 KASSERT(object->type == OBJT_VNODE,
440 ("vm_object_vndeallocate: not a vnode object"));
441 KASSERT(vp != NULL, ("vm_object_vndeallocate: missing vp"));
443 if (object->ref_count == 0) {
444 vprint("vm_object_vndeallocate", vp);
445 panic("vm_object_vndeallocate: bad object reference count");
449 if (object->ref_count > 1) {
451 VM_OBJECT_UNLOCK(object);
452 /* vrele may need the vnode lock. */
456 VM_OBJECT_UNLOCK(object);
457 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
459 VM_OBJECT_LOCK(object);
461 if (object->type == OBJT_DEAD) {
462 VM_OBJECT_UNLOCK(object);
465 if (object->ref_count == 0)
467 VM_OBJECT_UNLOCK(object);
474 * vm_object_deallocate:
476 * Release a reference to the specified object,
477 * gained either through a vm_object_allocate
478 * or a vm_object_reference call. When all references
479 * are gone, storage associated with this object
480 * may be relinquished.
482 * No object may be locked.
485 vm_object_deallocate(vm_object_t object)
489 while (object != NULL) {
494 VM_OBJECT_LOCK(object);
495 if (object->type == OBJT_VNODE) {
496 struct vnode *vp = (struct vnode *) object->handle;
499 * Conditionally acquire Giant for a vnode-backed
500 * object. We have to be careful since the type of
501 * a vnode object can change while the object is
504 if (VFS_NEEDSGIANT(vp->v_mount) && !vfslocked) {
506 if (!mtx_trylock(&Giant)) {
507 VM_OBJECT_UNLOCK(object);
512 vm_object_vndeallocate(object);
513 VFS_UNLOCK_GIANT(vfslocked);
517 * This is to handle the case that the object
518 * changed type while we dropped its lock to
521 VFS_UNLOCK_GIANT(vfslocked);
523 KASSERT(object->ref_count != 0,
524 ("vm_object_deallocate: object deallocated too many times: %d", object->type));
527 * If the reference count goes to 0 we start calling
528 * vm_object_terminate() on the object chain.
529 * A ref count of 1 may be a special case depending on the
530 * shadow count being 0 or 1.
533 if (object->ref_count > 1) {
534 VM_OBJECT_UNLOCK(object);
536 } else if (object->ref_count == 1) {
537 if (object->shadow_count == 0 &&
538 object->handle == NULL &&
539 (object->type == OBJT_DEFAULT ||
540 object->type == OBJT_SWAP)) {
541 vm_object_set_flag(object, OBJ_ONEMAPPING);
542 } else if ((object->shadow_count == 1) &&
543 (object->handle == NULL) &&
544 (object->type == OBJT_DEFAULT ||
545 object->type == OBJT_SWAP)) {
548 robject = LIST_FIRST(&object->shadow_head);
549 KASSERT(robject != NULL,
550 ("vm_object_deallocate: ref_count: %d, shadow_count: %d",
552 object->shadow_count));
553 if (!VM_OBJECT_TRYLOCK(robject)) {
555 * Avoid a potential deadlock.
558 VM_OBJECT_UNLOCK(object);
560 * More likely than not the thread
561 * holding robject's lock has lower
562 * priority than the current thread.
563 * Let the lower priority thread run.
569 * Collapse object into its shadow unless its
570 * shadow is dead. In that case, object will
571 * be deallocated by the thread that is
572 * deallocating its shadow.
574 if ((robject->flags & OBJ_DEAD) == 0 &&
575 (robject->handle == NULL) &&
576 (robject->type == OBJT_DEFAULT ||
577 robject->type == OBJT_SWAP)) {
579 robject->ref_count++;
581 if (robject->paging_in_progress) {
582 VM_OBJECT_UNLOCK(object);
583 vm_object_pip_wait(robject,
585 temp = robject->backing_object;
586 if (object == temp) {
587 VM_OBJECT_LOCK(object);
590 } else if (object->paging_in_progress) {
591 VM_OBJECT_UNLOCK(robject);
592 object->flags |= OBJ_PIPWNT;
594 VM_OBJECT_MTX(object),
595 PDROP | PVM, "objde2", 0);
596 VM_OBJECT_LOCK(robject);
597 temp = robject->backing_object;
598 if (object == temp) {
599 VM_OBJECT_LOCK(object);
603 VM_OBJECT_UNLOCK(object);
605 if (robject->ref_count == 1) {
606 robject->ref_count--;
611 vm_object_collapse(object);
612 VM_OBJECT_UNLOCK(object);
615 VM_OBJECT_UNLOCK(robject);
617 VM_OBJECT_UNLOCK(object);
621 temp = object->backing_object;
623 VM_OBJECT_LOCK(temp);
624 LIST_REMOVE(object, shadow_list);
625 temp->shadow_count--;
626 VM_OBJECT_UNLOCK(temp);
627 object->backing_object = NULL;
630 * Don't double-terminate, we could be in a termination
631 * recursion due to the terminate having to sync data
634 if ((object->flags & OBJ_DEAD) == 0)
635 vm_object_terminate(object);
637 VM_OBJECT_UNLOCK(object);
643 * vm_object_destroy removes the object from the global object list
644 * and frees the space for the object.
647 vm_object_destroy(vm_object_t object)
651 * Release the allocation charge.
653 if (object->cred != NULL) {
654 swap_release_by_cred(object->charge, object->cred);
656 crfree(object->cred);
661 * Free the space for the object.
663 uma_zfree(obj_zone, object);
667 * vm_object_terminate actually destroys the specified object, freeing
668 * up all previously used resources.
670 * The object must be locked.
671 * This routine may block.
674 vm_object_terminate(vm_object_t object)
678 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
681 * Make sure no one uses us.
683 vm_object_set_flag(object, OBJ_DEAD);
686 * wait for the pageout daemon to be done with the object
688 vm_object_pip_wait(object, "objtrm");
690 KASSERT(!object->paging_in_progress,
691 ("vm_object_terminate: pageout in progress"));
694 * Clean and free the pages, as appropriate. All references to the
695 * object are gone, so we don't need to lock it.
697 if (object->type == OBJT_VNODE) {
698 struct vnode *vp = (struct vnode *)object->handle;
701 * Clean pages and flush buffers.
703 vm_object_page_clean(object, 0, 0, OBJPC_SYNC);
704 VM_OBJECT_UNLOCK(object);
706 vinvalbuf(vp, V_SAVE, 0, 0);
708 VM_OBJECT_LOCK(object);
711 KASSERT(object->ref_count == 0,
712 ("vm_object_terminate: object with references, ref_count=%d",
716 * Free any remaining pageable pages. This also removes them from the
717 * paging queues. However, don't free wired pages, just remove them
718 * from the object. Rather than incrementally removing each page from
719 * the object, the page and object are reset to any empty state.
721 TAILQ_FOREACH_SAFE(p, &object->memq, listq, p_next) {
722 KASSERT(!p->busy && (p->oflags & VPO_BUSY) == 0,
723 ("vm_object_terminate: freeing busy page %p", p));
726 * Optimize the page's removal from the object by resetting
727 * its "object" field. Specifically, if the page is not
728 * wired, then the effect of this assignment is that
729 * vm_page_free()'s call to vm_page_remove() will return
730 * immediately without modifying the page or the object.
733 if (p->wire_count == 0) {
735 PCPU_INC(cnt.v_pfree);
740 * If the object contained any pages, then reset it to an empty state.
741 * None of the object's fields, including "resident_page_count", were
742 * modified by the preceding loop.
744 if (object->resident_page_count != 0) {
746 TAILQ_INIT(&object->memq);
747 object->resident_page_count = 0;
748 if (object->type == OBJT_VNODE)
749 vdrop(object->handle);
752 #if VM_NRESERVLEVEL > 0
753 if (__predict_false(!LIST_EMPTY(&object->rvq)))
754 vm_reserv_break_all(object);
756 if (__predict_false(object->cache != NULL))
757 vm_page_cache_free(object, 0, 0);
759 KASSERT(object->cred == NULL || object->type == OBJT_DEFAULT ||
760 object->type == OBJT_SWAP,
761 ("%s: non-swap obj %p has cred", __func__, object));
764 * Let the pager know object is dead.
766 vm_pager_deallocate(object);
767 VM_OBJECT_UNLOCK(object);
769 vm_object_destroy(object);
773 * Make the page read-only so that we can clear the object flags. However, if
774 * this is a nosync mmap then the object is likely to stay dirty so do not
775 * mess with the page and do not clear the object flags. Returns TRUE if the
776 * page should be flushed, and FALSE otherwise.
779 vm_object_page_remove_write(vm_page_t p, int flags, boolean_t *clearobjflags)
783 * If we have been asked to skip nosync pages and this is a
784 * nosync page, skip it. Note that the object flags were not
785 * cleared in this case so we do not have to set them.
787 if ((flags & OBJPC_NOSYNC) != 0 && (p->oflags & VPO_NOSYNC) != 0) {
788 *clearobjflags = FALSE;
791 pmap_remove_write(p);
792 return (p->dirty != 0);
797 * vm_object_page_clean
799 * Clean all dirty pages in the specified range of object. Leaves page
800 * on whatever queue it is currently on. If NOSYNC is set then do not
801 * write out pages with VPO_NOSYNC set (originally comes from MAP_NOSYNC),
802 * leaving the object dirty.
804 * When stuffing pages asynchronously, allow clustering. XXX we need a
805 * synchronous clustering mode implementation.
807 * Odd semantics: if start == end, we clean everything.
809 * The object must be locked.
811 * Returns FALSE if some page from the range was not written, as
812 * reported by the pager, and TRUE otherwise.
815 vm_object_page_clean(vm_object_t object, vm_ooffset_t start, vm_ooffset_t end,
819 vm_pindex_t pi, tend, tstart;
820 int curgeneration, n, pagerflags;
821 boolean_t clearobjflags, eio, res;
823 mtx_assert(&vm_page_queue_mtx, MA_NOTOWNED);
824 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
825 KASSERT(object->type == OBJT_VNODE, ("Not a vnode object"));
826 if ((object->flags & OBJ_MIGHTBEDIRTY) == 0 ||
827 object->resident_page_count == 0)
830 pagerflags = (flags & (OBJPC_SYNC | OBJPC_INVAL)) != 0 ?
831 VM_PAGER_PUT_SYNC : VM_PAGER_CLUSTER_OK;
832 pagerflags |= (flags & OBJPC_INVAL) != 0 ? VM_PAGER_PUT_INVAL : 0;
834 tstart = OFF_TO_IDX(start);
835 tend = (end == 0) ? object->size : OFF_TO_IDX(end + PAGE_MASK);
836 clearobjflags = tstart == 0 && tend >= object->size;
840 curgeneration = object->generation;
842 for (p = vm_page_find_least(object, tstart); p != NULL; p = np) {
846 np = TAILQ_NEXT(p, listq);
849 if (vm_page_sleep_if_busy(p, TRUE, "vpcwai")) {
850 if (object->generation != curgeneration) {
851 if ((flags & OBJPC_SYNC) != 0)
854 clearobjflags = FALSE;
856 np = vm_page_find_least(object, pi);
859 if (!vm_object_page_remove_write(p, flags, &clearobjflags))
862 n = vm_object_page_collect_flush(object, p, pagerflags,
863 flags, &clearobjflags, &eio);
866 clearobjflags = FALSE;
868 if (object->generation != curgeneration) {
869 if ((flags & OBJPC_SYNC) != 0)
872 clearobjflags = FALSE;
876 * If the VOP_PUTPAGES() did a truncated write, so
877 * that even the first page of the run is not fully
878 * written, vm_pageout_flush() returns 0 as the run
879 * length. Since the condition that caused truncated
880 * write may be permanent, e.g. exhausted free space,
881 * accepting n == 0 would cause an infinite loop.
883 * Forwarding the iterator leaves the unwritten page
884 * behind, but there is not much we can do there if
885 * filesystem refuses to write it.
889 clearobjflags = FALSE;
891 np = vm_page_find_least(object, pi + n);
894 VOP_FSYNC(vp, (pagerflags & VM_PAGER_PUT_SYNC) ? MNT_WAIT : 0);
898 vm_object_clear_flag(object, OBJ_MIGHTBEDIRTY);
903 vm_object_page_collect_flush(vm_object_t object, vm_page_t p, int pagerflags,
904 int flags, boolean_t *clearobjflags, boolean_t *eio)
906 vm_page_t ma[vm_pageout_page_count], p_first, tp;
907 int count, i, mreq, runlen;
909 mtx_assert(&vm_page_queue_mtx, MA_NOTOWNED);
910 vm_page_lock_assert(p, MA_NOTOWNED);
911 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
916 for (tp = p; count < vm_pageout_page_count; count++) {
917 tp = vm_page_next(tp);
918 if (tp == NULL || tp->busy != 0 || (tp->oflags & VPO_BUSY) != 0)
920 if (!vm_object_page_remove_write(tp, flags, clearobjflags))
924 for (p_first = p; count < vm_pageout_page_count; count++) {
925 tp = vm_page_prev(p_first);
926 if (tp == NULL || tp->busy != 0 || (tp->oflags & VPO_BUSY) != 0)
928 if (!vm_object_page_remove_write(tp, flags, clearobjflags))
934 for (tp = p_first, i = 0; i < count; tp = TAILQ_NEXT(tp, listq), i++)
937 vm_pageout_flush(ma, count, pagerflags, mreq, &runlen, eio);
942 * Note that there is absolutely no sense in writing out
943 * anonymous objects, so we track down the vnode object
945 * We invalidate (remove) all pages from the address space
946 * for semantic correctness.
948 * If the backing object is a device object with unmanaged pages, then any
949 * mappings to the specified range of pages must be removed before this
950 * function is called.
952 * Note: certain anonymous maps, such as MAP_NOSYNC maps,
953 * may start out with a NULL object.
956 vm_object_sync(vm_object_t object, vm_ooffset_t offset, vm_size_t size,
957 boolean_t syncio, boolean_t invalidate)
959 vm_object_t backing_object;
962 int error, flags, fsync_after;
969 VM_OBJECT_LOCK(object);
970 while ((backing_object = object->backing_object) != NULL) {
971 VM_OBJECT_LOCK(backing_object);
972 offset += object->backing_object_offset;
973 VM_OBJECT_UNLOCK(object);
974 object = backing_object;
975 if (object->size < OFF_TO_IDX(offset + size))
976 size = IDX_TO_OFF(object->size) - offset;
979 * Flush pages if writing is allowed, invalidate them
980 * if invalidation requested. Pages undergoing I/O
981 * will be ignored by vm_object_page_remove().
983 * We cannot lock the vnode and then wait for paging
984 * to complete without deadlocking against vm_fault.
985 * Instead we simply call vm_object_page_remove() and
986 * allow it to block internally on a page-by-page
987 * basis when it encounters pages undergoing async
990 if (object->type == OBJT_VNODE &&
991 (object->flags & OBJ_MIGHTBEDIRTY) != 0) {
994 VM_OBJECT_UNLOCK(object);
995 (void) vn_start_write(vp, &mp, V_WAIT);
996 vfslocked = VFS_LOCK_GIANT(vp->v_mount);
997 vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
998 if (syncio && !invalidate && offset == 0 &&
999 OFF_TO_IDX(size) == object->size) {
1001 * If syncing the whole mapping of the file,
1002 * it is faster to schedule all the writes in
1003 * async mode, also allowing the clustering,
1004 * and then wait for i/o to complete.
1009 flags = (syncio || invalidate) ? OBJPC_SYNC : 0;
1010 flags |= invalidate ? (OBJPC_SYNC | OBJPC_INVAL) : 0;
1011 fsync_after = FALSE;
1013 VM_OBJECT_LOCK(object);
1014 res = vm_object_page_clean(object, offset, offset + size,
1016 VM_OBJECT_UNLOCK(object);
1018 error = VOP_FSYNC(vp, MNT_WAIT, curthread);
1020 VFS_UNLOCK_GIANT(vfslocked);
1021 vn_finished_write(mp);
1024 VM_OBJECT_LOCK(object);
1026 if ((object->type == OBJT_VNODE ||
1027 object->type == OBJT_DEVICE) && invalidate) {
1028 if (object->type == OBJT_DEVICE)
1030 * The option OBJPR_NOTMAPPED must be passed here
1031 * because vm_object_page_remove() cannot remove
1032 * unmanaged mappings.
1034 flags = OBJPR_NOTMAPPED;
1036 flags = OBJPR_NOTWIRED;
1038 flags = OBJPR_CLEANONLY | OBJPR_NOTWIRED;
1039 vm_object_page_remove(object, OFF_TO_IDX(offset),
1040 OFF_TO_IDX(offset + size + PAGE_MASK), flags);
1042 VM_OBJECT_UNLOCK(object);
1047 * vm_object_madvise:
1049 * Implements the madvise function at the object/page level.
1051 * MADV_WILLNEED (any object)
1053 * Activate the specified pages if they are resident.
1055 * MADV_DONTNEED (any object)
1057 * Deactivate the specified pages if they are resident.
1059 * MADV_FREE (OBJT_DEFAULT/OBJT_SWAP objects,
1060 * OBJ_ONEMAPPING only)
1062 * Deactivate and clean the specified pages if they are
1063 * resident. This permits the process to reuse the pages
1064 * without faulting or the kernel to reclaim the pages
1068 vm_object_madvise(vm_object_t object, vm_pindex_t pindex, vm_pindex_t end,
1071 vm_pindex_t tpindex;
1072 vm_object_t backing_object, tobject;
1077 VM_OBJECT_LOCK(object);
1079 * Locate and adjust resident pages
1081 for (; pindex < end; pindex += 1) {
1087 * MADV_FREE only operates on OBJT_DEFAULT or OBJT_SWAP pages
1088 * and those pages must be OBJ_ONEMAPPING.
1090 if (advise == MADV_FREE) {
1091 if ((tobject->type != OBJT_DEFAULT &&
1092 tobject->type != OBJT_SWAP) ||
1093 (tobject->flags & OBJ_ONEMAPPING) == 0) {
1094 goto unlock_tobject;
1096 } else if (tobject->type == OBJT_PHYS)
1097 goto unlock_tobject;
1098 m = vm_page_lookup(tobject, tpindex);
1099 if (m == NULL && advise == MADV_WILLNEED) {
1101 * If the page is cached, reactivate it.
1103 m = vm_page_alloc(tobject, tpindex, VM_ALLOC_IFCACHED |
1108 * There may be swap even if there is no backing page
1110 if (advise == MADV_FREE && tobject->type == OBJT_SWAP)
1111 swap_pager_freespace(tobject, tpindex, 1);
1115 backing_object = tobject->backing_object;
1116 if (backing_object == NULL)
1117 goto unlock_tobject;
1118 VM_OBJECT_LOCK(backing_object);
1119 tpindex += OFF_TO_IDX(tobject->backing_object_offset);
1120 if (tobject != object)
1121 VM_OBJECT_UNLOCK(tobject);
1122 tobject = backing_object;
1124 } else if (m->valid != VM_PAGE_BITS_ALL)
1125 goto unlock_tobject;
1127 * If the page is not in a normal state, skip it.
1130 if (m->hold_count != 0 || m->wire_count != 0) {
1132 goto unlock_tobject;
1134 KASSERT((m->flags & PG_FICTITIOUS) == 0,
1135 ("vm_object_madvise: page %p is fictitious", m));
1136 KASSERT((m->oflags & VPO_UNMANAGED) == 0,
1137 ("vm_object_madvise: page %p is not managed", m));
1138 if ((m->oflags & VPO_BUSY) || m->busy) {
1139 if (advise == MADV_WILLNEED) {
1141 * Reference the page before unlocking and
1142 * sleeping so that the page daemon is less
1143 * likely to reclaim it.
1145 vm_page_aflag_set(m, PGA_REFERENCED);
1148 if (object != tobject)
1149 VM_OBJECT_UNLOCK(object);
1150 m->oflags |= VPO_WANTED;
1151 msleep(m, VM_OBJECT_MTX(tobject), PDROP | PVM, "madvpo",
1153 VM_OBJECT_LOCK(object);
1156 if (advise == MADV_WILLNEED) {
1157 vm_page_activate(m);
1158 } else if (advise == MADV_DONTNEED) {
1159 vm_page_dontneed(m);
1160 } else if (advise == MADV_FREE) {
1162 * Mark the page clean. This will allow the page
1163 * to be freed up by the system. However, such pages
1164 * are often reused quickly by malloc()/free()
1165 * so we do not do anything that would cause
1166 * a page fault if we can help it.
1168 * Specifically, we do not try to actually free
1169 * the page now nor do we try to put it in the
1170 * cache (which would cause a page fault on reuse).
1172 * But we do make the page is freeable as we
1173 * can without actually taking the step of unmapping
1176 pmap_clear_modify(m);
1179 vm_page_dontneed(m);
1182 if (advise == MADV_FREE && tobject->type == OBJT_SWAP)
1183 swap_pager_freespace(tobject, tpindex, 1);
1185 if (tobject != object)
1186 VM_OBJECT_UNLOCK(tobject);
1188 VM_OBJECT_UNLOCK(object);
1194 * Create a new object which is backed by the
1195 * specified existing object range. The source
1196 * object reference is deallocated.
1198 * The new object and offset into that object
1199 * are returned in the source parameters.
1203 vm_object_t *object, /* IN/OUT */
1204 vm_ooffset_t *offset, /* IN/OUT */
1213 * Don't create the new object if the old object isn't shared.
1215 if (source != NULL) {
1216 VM_OBJECT_LOCK(source);
1217 if (source->ref_count == 1 &&
1218 source->handle == NULL &&
1219 (source->type == OBJT_DEFAULT ||
1220 source->type == OBJT_SWAP)) {
1221 VM_OBJECT_UNLOCK(source);
1224 VM_OBJECT_UNLOCK(source);
1228 * Allocate a new object with the given length.
1230 result = vm_object_allocate(OBJT_DEFAULT, atop(length));
1233 * The new object shadows the source object, adding a reference to it.
1234 * Our caller changes his reference to point to the new object,
1235 * removing a reference to the source object. Net result: no change
1236 * of reference count.
1238 * Try to optimize the result object's page color when shadowing
1239 * in order to maintain page coloring consistency in the combined
1242 result->backing_object = source;
1244 * Store the offset into the source object, and fix up the offset into
1247 result->backing_object_offset = *offset;
1248 if (source != NULL) {
1249 VM_OBJECT_LOCK(source);
1250 LIST_INSERT_HEAD(&source->shadow_head, result, shadow_list);
1251 source->shadow_count++;
1252 #if VM_NRESERVLEVEL > 0
1253 result->flags |= source->flags & OBJ_COLORED;
1254 result->pg_color = (source->pg_color + OFF_TO_IDX(*offset)) &
1255 ((1 << (VM_NFREEORDER - 1)) - 1);
1257 VM_OBJECT_UNLOCK(source);
1262 * Return the new things
1271 * Split the pages in a map entry into a new object. This affords
1272 * easier removal of unused pages, and keeps object inheritance from
1273 * being a negative impact on memory usage.
1276 vm_object_split(vm_map_entry_t entry)
1278 vm_page_t m, m_next;
1279 vm_object_t orig_object, new_object, source;
1280 vm_pindex_t idx, offidxstart;
1283 orig_object = entry->object.vm_object;
1284 if (orig_object->type != OBJT_DEFAULT && orig_object->type != OBJT_SWAP)
1286 if (orig_object->ref_count <= 1)
1288 VM_OBJECT_UNLOCK(orig_object);
1290 offidxstart = OFF_TO_IDX(entry->offset);
1291 size = atop(entry->end - entry->start);
1294 * If swap_pager_copy() is later called, it will convert new_object
1295 * into a swap object.
1297 new_object = vm_object_allocate(OBJT_DEFAULT, size);
1300 * At this point, the new object is still private, so the order in
1301 * which the original and new objects are locked does not matter.
1303 VM_OBJECT_LOCK(new_object);
1304 VM_OBJECT_LOCK(orig_object);
1305 source = orig_object->backing_object;
1306 if (source != NULL) {
1307 VM_OBJECT_LOCK(source);
1308 if ((source->flags & OBJ_DEAD) != 0) {
1309 VM_OBJECT_UNLOCK(source);
1310 VM_OBJECT_UNLOCK(orig_object);
1311 VM_OBJECT_UNLOCK(new_object);
1312 vm_object_deallocate(new_object);
1313 VM_OBJECT_LOCK(orig_object);
1316 LIST_INSERT_HEAD(&source->shadow_head,
1317 new_object, shadow_list);
1318 source->shadow_count++;
1319 vm_object_reference_locked(source); /* for new_object */
1320 vm_object_clear_flag(source, OBJ_ONEMAPPING);
1321 VM_OBJECT_UNLOCK(source);
1322 new_object->backing_object_offset =
1323 orig_object->backing_object_offset + entry->offset;
1324 new_object->backing_object = source;
1326 if (orig_object->cred != NULL) {
1327 new_object->cred = orig_object->cred;
1328 crhold(orig_object->cred);
1329 new_object->charge = ptoa(size);
1330 KASSERT(orig_object->charge >= ptoa(size),
1331 ("orig_object->charge < 0"));
1332 orig_object->charge -= ptoa(size);
1335 m = vm_page_find_least(orig_object, offidxstart);
1336 for (; m != NULL && (idx = m->pindex - offidxstart) < size;
1338 m_next = TAILQ_NEXT(m, listq);
1341 * We must wait for pending I/O to complete before we can
1344 * We do not have to VM_PROT_NONE the page as mappings should
1345 * not be changed by this operation.
1347 if ((m->oflags & VPO_BUSY) || m->busy) {
1348 VM_OBJECT_UNLOCK(new_object);
1349 m->oflags |= VPO_WANTED;
1350 msleep(m, VM_OBJECT_MTX(orig_object), PVM, "spltwt", 0);
1351 VM_OBJECT_LOCK(new_object);
1355 vm_page_rename(m, new_object, idx);
1357 /* page automatically made dirty by rename and cache handled */
1360 if (orig_object->type == OBJT_SWAP) {
1362 * swap_pager_copy() can sleep, in which case the orig_object's
1363 * and new_object's locks are released and reacquired.
1365 swap_pager_copy(orig_object, new_object, offidxstart, 0);
1368 * Transfer any cached pages from orig_object to new_object.
1370 if (__predict_false(orig_object->cache != NULL))
1371 vm_page_cache_transfer(orig_object, offidxstart,
1374 VM_OBJECT_UNLOCK(orig_object);
1375 TAILQ_FOREACH(m, &new_object->memq, listq)
1377 VM_OBJECT_UNLOCK(new_object);
1378 entry->object.vm_object = new_object;
1379 entry->offset = 0LL;
1380 vm_object_deallocate(orig_object);
1381 VM_OBJECT_LOCK(new_object);
1384 #define OBSC_TEST_ALL_SHADOWED 0x0001
1385 #define OBSC_COLLAPSE_NOWAIT 0x0002
1386 #define OBSC_COLLAPSE_WAIT 0x0004
1389 vm_object_backing_scan(vm_object_t object, int op)
1393 vm_object_t backing_object;
1394 vm_pindex_t backing_offset_index;
1396 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1397 VM_OBJECT_LOCK_ASSERT(object->backing_object, MA_OWNED);
1399 backing_object = object->backing_object;
1400 backing_offset_index = OFF_TO_IDX(object->backing_object_offset);
1403 * Initial conditions
1405 if (op & OBSC_TEST_ALL_SHADOWED) {
1407 * We do not want to have to test for the existence of cache
1408 * or swap pages in the backing object. XXX but with the
1409 * new swapper this would be pretty easy to do.
1411 * XXX what about anonymous MAP_SHARED memory that hasn't
1412 * been ZFOD faulted yet? If we do not test for this, the
1413 * shadow test may succeed! XXX
1415 if (backing_object->type != OBJT_DEFAULT) {
1419 if (op & OBSC_COLLAPSE_WAIT) {
1420 vm_object_set_flag(backing_object, OBJ_DEAD);
1426 p = TAILQ_FIRST(&backing_object->memq);
1428 vm_page_t next = TAILQ_NEXT(p, listq);
1429 vm_pindex_t new_pindex = p->pindex - backing_offset_index;
1431 if (op & OBSC_TEST_ALL_SHADOWED) {
1435 * Ignore pages outside the parent object's range
1436 * and outside the parent object's mapping of the
1439 * note that we do not busy the backing object's
1443 p->pindex < backing_offset_index ||
1444 new_pindex >= object->size
1451 * See if the parent has the page or if the parent's
1452 * object pager has the page. If the parent has the
1453 * page but the page is not valid, the parent's
1454 * object pager must have the page.
1456 * If this fails, the parent does not completely shadow
1457 * the object and we might as well give up now.
1460 pp = vm_page_lookup(object, new_pindex);
1462 (pp == NULL || pp->valid == 0) &&
1463 !vm_pager_has_page(object, new_pindex, NULL, NULL)
1471 * Check for busy page
1473 if (op & (OBSC_COLLAPSE_WAIT | OBSC_COLLAPSE_NOWAIT)) {
1476 if (op & OBSC_COLLAPSE_NOWAIT) {
1477 if ((p->oflags & VPO_BUSY) ||
1483 } else if (op & OBSC_COLLAPSE_WAIT) {
1484 if ((p->oflags & VPO_BUSY) || p->busy) {
1485 VM_OBJECT_UNLOCK(object);
1486 p->oflags |= VPO_WANTED;
1487 msleep(p, VM_OBJECT_MTX(backing_object),
1488 PDROP | PVM, "vmocol", 0);
1489 VM_OBJECT_LOCK(object);
1490 VM_OBJECT_LOCK(backing_object);
1492 * If we slept, anything could have
1493 * happened. Since the object is
1494 * marked dead, the backing offset
1495 * should not have changed so we
1496 * just restart our scan.
1498 p = TAILQ_FIRST(&backing_object->memq);
1504 p->object == backing_object,
1505 ("vm_object_backing_scan: object mismatch")
1509 * Destroy any associated swap
1511 if (backing_object->type == OBJT_SWAP) {
1512 swap_pager_freespace(
1520 p->pindex < backing_offset_index ||
1521 new_pindex >= object->size
1524 * Page is out of the parent object's range, we
1525 * can simply destroy it.
1528 KASSERT(!pmap_page_is_mapped(p),
1529 ("freeing mapped page %p", p));
1530 if (p->wire_count == 0)
1539 pp = vm_page_lookup(object, new_pindex);
1541 (op & OBSC_COLLAPSE_NOWAIT) != 0 &&
1542 (pp != NULL && pp->valid == 0)
1545 * The page in the parent is not (yet) valid.
1546 * We don't know anything about the state of
1547 * the original page. It might be mapped,
1548 * so we must avoid the next if here.
1550 * This is due to a race in vm_fault() where
1551 * we must unbusy the original (backing_obj)
1552 * page before we can (re)lock the parent.
1553 * Hence we can get here.
1560 vm_pager_has_page(object, new_pindex, NULL, NULL)
1563 * page already exists in parent OR swap exists
1564 * for this location in the parent. Destroy
1565 * the original page from the backing object.
1567 * Leave the parent's page alone
1570 KASSERT(!pmap_page_is_mapped(p),
1571 ("freeing mapped page %p", p));
1572 if (p->wire_count == 0)
1581 #if VM_NRESERVLEVEL > 0
1583 * Rename the reservation.
1585 vm_reserv_rename(p, object, backing_object,
1586 backing_offset_index);
1590 * Page does not exist in parent, rename the
1591 * page from the backing object to the main object.
1593 * If the page was mapped to a process, it can remain
1594 * mapped through the rename.
1597 vm_page_rename(p, object, new_pindex);
1599 /* page automatically made dirty by rename */
1608 * this version of collapse allows the operation to occur earlier and
1609 * when paging_in_progress is true for an object... This is not a complete
1610 * operation, but should plug 99.9% of the rest of the leaks.
1613 vm_object_qcollapse(vm_object_t object)
1615 vm_object_t backing_object = object->backing_object;
1617 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1618 VM_OBJECT_LOCK_ASSERT(backing_object, MA_OWNED);
1620 if (backing_object->ref_count != 1)
1623 vm_object_backing_scan(object, OBSC_COLLAPSE_NOWAIT);
1627 * vm_object_collapse:
1629 * Collapse an object with the object backing it.
1630 * Pages in the backing object are moved into the
1631 * parent, and the backing object is deallocated.
1634 vm_object_collapse(vm_object_t object)
1636 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1639 vm_object_t backing_object;
1642 * Verify that the conditions are right for collapse:
1644 * The object exists and the backing object exists.
1646 if ((backing_object = object->backing_object) == NULL)
1650 * we check the backing object first, because it is most likely
1653 VM_OBJECT_LOCK(backing_object);
1654 if (backing_object->handle != NULL ||
1655 (backing_object->type != OBJT_DEFAULT &&
1656 backing_object->type != OBJT_SWAP) ||
1657 (backing_object->flags & OBJ_DEAD) ||
1658 object->handle != NULL ||
1659 (object->type != OBJT_DEFAULT &&
1660 object->type != OBJT_SWAP) ||
1661 (object->flags & OBJ_DEAD)) {
1662 VM_OBJECT_UNLOCK(backing_object);
1667 object->paging_in_progress != 0 ||
1668 backing_object->paging_in_progress != 0
1670 vm_object_qcollapse(object);
1671 VM_OBJECT_UNLOCK(backing_object);
1675 * We know that we can either collapse the backing object (if
1676 * the parent is the only reference to it) or (perhaps) have
1677 * the parent bypass the object if the parent happens to shadow
1678 * all the resident pages in the entire backing object.
1680 * This is ignoring pager-backed pages such as swap pages.
1681 * vm_object_backing_scan fails the shadowing test in this
1684 if (backing_object->ref_count == 1) {
1686 * If there is exactly one reference to the backing
1687 * object, we can collapse it into the parent.
1689 vm_object_backing_scan(object, OBSC_COLLAPSE_WAIT);
1691 #if VM_NRESERVLEVEL > 0
1693 * Break any reservations from backing_object.
1695 if (__predict_false(!LIST_EMPTY(&backing_object->rvq)))
1696 vm_reserv_break_all(backing_object);
1700 * Move the pager from backing_object to object.
1702 if (backing_object->type == OBJT_SWAP) {
1704 * swap_pager_copy() can sleep, in which case
1705 * the backing_object's and object's locks are
1706 * released and reacquired.
1711 OFF_TO_IDX(object->backing_object_offset), TRUE);
1714 * Free any cached pages from backing_object.
1716 if (__predict_false(backing_object->cache != NULL))
1717 vm_page_cache_free(backing_object, 0, 0);
1720 * Object now shadows whatever backing_object did.
1721 * Note that the reference to
1722 * backing_object->backing_object moves from within
1723 * backing_object to within object.
1725 LIST_REMOVE(object, shadow_list);
1726 backing_object->shadow_count--;
1727 if (backing_object->backing_object) {
1728 VM_OBJECT_LOCK(backing_object->backing_object);
1729 LIST_REMOVE(backing_object, shadow_list);
1731 &backing_object->backing_object->shadow_head,
1732 object, shadow_list);
1734 * The shadow_count has not changed.
1736 VM_OBJECT_UNLOCK(backing_object->backing_object);
1738 object->backing_object = backing_object->backing_object;
1739 object->backing_object_offset +=
1740 backing_object->backing_object_offset;
1743 * Discard backing_object.
1745 * Since the backing object has no pages, no pager left,
1746 * and no object references within it, all that is
1747 * necessary is to dispose of it.
1749 KASSERT(backing_object->ref_count == 1, (
1750 "backing_object %p was somehow re-referenced during collapse!",
1752 backing_object->type = OBJT_DEAD;
1753 backing_object->ref_count = 0;
1754 VM_OBJECT_UNLOCK(backing_object);
1755 vm_object_destroy(backing_object);
1759 vm_object_t new_backing_object;
1762 * If we do not entirely shadow the backing object,
1763 * there is nothing we can do so we give up.
1765 if (object->resident_page_count != object->size &&
1766 vm_object_backing_scan(object,
1767 OBSC_TEST_ALL_SHADOWED) == 0) {
1768 VM_OBJECT_UNLOCK(backing_object);
1773 * Make the parent shadow the next object in the
1774 * chain. Deallocating backing_object will not remove
1775 * it, since its reference count is at least 2.
1777 LIST_REMOVE(object, shadow_list);
1778 backing_object->shadow_count--;
1780 new_backing_object = backing_object->backing_object;
1781 if ((object->backing_object = new_backing_object) != NULL) {
1782 VM_OBJECT_LOCK(new_backing_object);
1784 &new_backing_object->shadow_head,
1788 new_backing_object->shadow_count++;
1789 vm_object_reference_locked(new_backing_object);
1790 VM_OBJECT_UNLOCK(new_backing_object);
1791 object->backing_object_offset +=
1792 backing_object->backing_object_offset;
1796 * Drop the reference count on backing_object. Since
1797 * its ref_count was at least 2, it will not vanish.
1799 backing_object->ref_count--;
1800 VM_OBJECT_UNLOCK(backing_object);
1805 * Try again with this object's new backing object.
1811 * vm_object_page_remove:
1813 * For the given object, either frees or invalidates each of the
1814 * specified pages. In general, a page is freed. However, if a page is
1815 * wired for any reason other than the existence of a managed, wired
1816 * mapping, then it may be invalidated but not removed from the object.
1817 * Pages are specified by the given range ["start", "end") and the option
1818 * OBJPR_CLEANONLY. As a special case, if "end" is zero, then the range
1819 * extends from "start" to the end of the object. If the option
1820 * OBJPR_CLEANONLY is specified, then only the non-dirty pages within the
1821 * specified range are affected. If the option OBJPR_NOTMAPPED is
1822 * specified, then the pages within the specified range must have no
1823 * mappings. Otherwise, if this option is not specified, any mappings to
1824 * the specified pages are removed before the pages are freed or
1827 * In general, this operation should only be performed on objects that
1828 * contain managed pages. There are, however, two exceptions. First, it
1829 * is performed on the kernel and kmem objects by vm_map_entry_delete().
1830 * Second, it is used by msync(..., MS_INVALIDATE) to invalidate device-
1831 * backed pages. In both of these cases, the option OBJPR_CLEANONLY must
1832 * not be specified and the option OBJPR_NOTMAPPED must be specified.
1834 * The object must be locked.
1837 vm_object_page_remove(vm_object_t object, vm_pindex_t start, vm_pindex_t end,
1843 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1844 KASSERT((object->type != OBJT_DEVICE && object->type != OBJT_PHYS) ||
1845 (options & (OBJPR_CLEANONLY | OBJPR_NOTMAPPED)) == OBJPR_NOTMAPPED,
1846 ("vm_object_page_remove: illegal options for object %p", object));
1847 if (object->resident_page_count == 0)
1849 vm_object_pip_add(object, 1);
1851 p = vm_page_find_least(object, start);
1854 * Here, the variable "p" is either (1) the page with the least pindex
1855 * greater than or equal to the parameter "start" or (2) NULL.
1857 for (; p != NULL && (p->pindex < end || end == 0); p = next) {
1858 next = TAILQ_NEXT(p, listq);
1861 * If the page is wired for any reason besides the existence
1862 * of managed, wired mappings, then it cannot be freed. For
1863 * example, fictitious pages, which represent device memory,
1864 * are inherently wired and cannot be freed. They can,
1865 * however, be invalidated if the option OBJPR_CLEANONLY is
1869 if ((wirings = p->wire_count) != 0 &&
1870 (wirings = pmap_page_wired_mappings(p)) != p->wire_count) {
1871 if ((options & (OBJPR_NOTWIRED | OBJPR_NOTMAPPED)) ==
1874 /* Account for removal of wired mappings. */
1876 p->wire_count -= wirings;
1878 if ((options & OBJPR_CLEANONLY) == 0) {
1884 if (vm_page_sleep_if_busy(p, TRUE, "vmopar"))
1886 KASSERT((p->flags & PG_FICTITIOUS) == 0,
1887 ("vm_object_page_remove: page %p is fictitious", p));
1888 if ((options & OBJPR_CLEANONLY) != 0 && p->valid != 0) {
1889 if ((options & OBJPR_NOTMAPPED) == 0)
1890 pmap_remove_write(p);
1894 if ((options & OBJPR_NOTMAPPED) == 0) {
1895 if ((options & OBJPR_NOTWIRED) != 0 && wirings != 0)
1898 /* Account for removal of wired mappings. */
1900 KASSERT(p->wire_count == wirings,
1901 ("inconsistent wire count %d %d %p",
1902 p->wire_count, wirings, p));
1904 atomic_subtract_int(&cnt.v_wire_count, 1);
1911 vm_object_pip_wakeup(object);
1913 if (__predict_false(object->cache != NULL))
1914 vm_page_cache_free(object, start, end);
1918 * vm_object_page_cache:
1920 * For the given object, attempt to move the specified clean
1921 * pages to the cache queue. If a page is wired for any reason,
1922 * then it will not be changed. Pages are specified by the given
1923 * range ["start", "end"). As a special case, if "end" is zero,
1924 * then the range extends from "start" to the end of the object.
1925 * Any mappings to the specified pages are removed before the
1926 * pages are moved to the cache queue.
1928 * This operation should only be performed on objects that
1929 * contain managed pages.
1931 * The object must be locked.
1934 vm_object_page_cache(vm_object_t object, vm_pindex_t start, vm_pindex_t end)
1936 struct mtx *mtx, *new_mtx;
1939 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1940 KASSERT((object->type != OBJT_DEVICE && object->type != OBJT_SG &&
1941 object->type != OBJT_PHYS),
1942 ("vm_object_page_cache: illegal object %p", object));
1943 if (object->resident_page_count == 0)
1945 p = vm_page_find_least(object, start);
1948 * Here, the variable "p" is either (1) the page with the least pindex
1949 * greater than or equal to the parameter "start" or (2) NULL.
1952 for (; p != NULL && (p->pindex < end || end == 0); p = next) {
1953 next = TAILQ_NEXT(p, listq);
1956 * Avoid releasing and reacquiring the same page lock.
1958 new_mtx = vm_page_lockptr(p);
1959 if (mtx != new_mtx) {
1965 vm_page_try_to_cache(p);
1972 * Populate the specified range of the object with valid pages. Returns
1973 * TRUE if the range is successfully populated and FALSE otherwise.
1975 * Note: This function should be optimized to pass a larger array of
1976 * pages to vm_pager_get_pages() before it is applied to a non-
1977 * OBJT_DEVICE object.
1979 * The object must be locked.
1982 vm_object_populate(vm_object_t object, vm_pindex_t start, vm_pindex_t end)
1988 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1989 for (pindex = start; pindex < end; pindex++) {
1990 m = vm_page_grab(object, pindex, VM_ALLOC_NORMAL |
1992 if (m->valid != VM_PAGE_BITS_ALL) {
1994 rv = vm_pager_get_pages(object, ma, 1, 0);
1995 m = vm_page_lookup(object, pindex);
1998 if (rv != VM_PAGER_OK) {
2006 * Keep "m" busy because a subsequent iteration may unlock
2010 if (pindex > start) {
2011 m = vm_page_lookup(object, start);
2012 while (m != NULL && m->pindex < pindex) {
2014 m = TAILQ_NEXT(m, listq);
2017 return (pindex == end);
2021 * Routine: vm_object_coalesce
2022 * Function: Coalesces two objects backing up adjoining
2023 * regions of memory into a single object.
2025 * returns TRUE if objects were combined.
2027 * NOTE: Only works at the moment if the second object is NULL -
2028 * if it's not, which object do we lock first?
2031 * prev_object First object to coalesce
2032 * prev_offset Offset into prev_object
2033 * prev_size Size of reference to prev_object
2034 * next_size Size of reference to the second object
2035 * reserved Indicator that extension region has
2036 * swap accounted for
2039 * The object must *not* be locked.
2042 vm_object_coalesce(vm_object_t prev_object, vm_ooffset_t prev_offset,
2043 vm_size_t prev_size, vm_size_t next_size, boolean_t reserved)
2045 vm_pindex_t next_pindex;
2047 if (prev_object == NULL)
2049 VM_OBJECT_LOCK(prev_object);
2050 if (prev_object->type != OBJT_DEFAULT &&
2051 prev_object->type != OBJT_SWAP) {
2052 VM_OBJECT_UNLOCK(prev_object);
2057 * Try to collapse the object first
2059 vm_object_collapse(prev_object);
2062 * Can't coalesce if: . more than one reference . paged out . shadows
2063 * another object . has a copy elsewhere (any of which mean that the
2064 * pages not mapped to prev_entry may be in use anyway)
2066 if (prev_object->backing_object != NULL) {
2067 VM_OBJECT_UNLOCK(prev_object);
2071 prev_size >>= PAGE_SHIFT;
2072 next_size >>= PAGE_SHIFT;
2073 next_pindex = OFF_TO_IDX(prev_offset) + prev_size;
2075 if ((prev_object->ref_count > 1) &&
2076 (prev_object->size != next_pindex)) {
2077 VM_OBJECT_UNLOCK(prev_object);
2082 * Account for the charge.
2084 if (prev_object->cred != NULL) {
2087 * If prev_object was charged, then this mapping,
2088 * althought not charged now, may become writable
2089 * later. Non-NULL cred in the object would prevent
2090 * swap reservation during enabling of the write
2091 * access, so reserve swap now. Failed reservation
2092 * cause allocation of the separate object for the map
2093 * entry, and swap reservation for this entry is
2094 * managed in appropriate time.
2096 if (!reserved && !swap_reserve_by_cred(ptoa(next_size),
2097 prev_object->cred)) {
2100 prev_object->charge += ptoa(next_size);
2104 * Remove any pages that may still be in the object from a previous
2107 if (next_pindex < prev_object->size) {
2108 vm_object_page_remove(prev_object, next_pindex, next_pindex +
2110 if (prev_object->type == OBJT_SWAP)
2111 swap_pager_freespace(prev_object,
2112 next_pindex, next_size);
2114 if (prev_object->cred != NULL) {
2115 KASSERT(prev_object->charge >=
2116 ptoa(prev_object->size - next_pindex),
2117 ("object %p overcharged 1 %jx %jx", prev_object,
2118 (uintmax_t)next_pindex, (uintmax_t)next_size));
2119 prev_object->charge -= ptoa(prev_object->size -
2126 * Extend the object if necessary.
2128 if (next_pindex + next_size > prev_object->size)
2129 prev_object->size = next_pindex + next_size;
2131 VM_OBJECT_UNLOCK(prev_object);
2136 vm_object_set_writeable_dirty(vm_object_t object)
2139 VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
2140 if (object->type != OBJT_VNODE)
2142 object->generation++;
2143 if ((object->flags & OBJ_MIGHTBEDIRTY) != 0)
2145 vm_object_set_flag(object, OBJ_MIGHTBEDIRTY);
2148 #include "opt_ddb.h"
2150 #include <sys/kernel.h>
2152 #include <sys/cons.h>
2154 #include <ddb/ddb.h>
2157 _vm_object_in_map(vm_map_t map, vm_object_t object, vm_map_entry_t entry)
2160 vm_map_entry_t tmpe;
2168 tmpe = map->header.next;
2169 entcount = map->nentries;
2170 while (entcount-- && (tmpe != &map->header)) {
2171 if (_vm_object_in_map(map, object, tmpe)) {
2176 } else if (entry->eflags & MAP_ENTRY_IS_SUB_MAP) {
2177 tmpm = entry->object.sub_map;
2178 tmpe = tmpm->header.next;
2179 entcount = tmpm->nentries;
2180 while (entcount-- && tmpe != &tmpm->header) {
2181 if (_vm_object_in_map(tmpm, object, tmpe)) {
2186 } else if ((obj = entry->object.vm_object) != NULL) {
2187 for (; obj; obj = obj->backing_object)
2188 if (obj == object) {
2196 vm_object_in_map(vm_object_t object)
2200 /* sx_slock(&allproc_lock); */
2201 FOREACH_PROC_IN_SYSTEM(p) {
2202 if (!p->p_vmspace /* || (p->p_flag & (P_SYSTEM|P_WEXIT)) */)
2204 if (_vm_object_in_map(&p->p_vmspace->vm_map, object, 0)) {
2205 /* sx_sunlock(&allproc_lock); */
2209 /* sx_sunlock(&allproc_lock); */
2210 if (_vm_object_in_map(kernel_map, object, 0))
2212 if (_vm_object_in_map(kmem_map, object, 0))
2214 if (_vm_object_in_map(pager_map, object, 0))
2216 if (_vm_object_in_map(buffer_map, object, 0))
2221 DB_SHOW_COMMAND(vmochk, vm_object_check)
2226 * make sure that internal objs are in a map somewhere
2227 * and none have zero ref counts.
2229 TAILQ_FOREACH(object, &vm_object_list, object_list) {
2230 if (object->handle == NULL &&
2231 (object->type == OBJT_DEFAULT || object->type == OBJT_SWAP)) {
2232 if (object->ref_count == 0) {
2233 db_printf("vmochk: internal obj has zero ref count: %ld\n",
2234 (long)object->size);
2236 if (!vm_object_in_map(object)) {
2238 "vmochk: internal obj is not in a map: "
2239 "ref: %d, size: %lu: 0x%lx, backing_object: %p\n",
2240 object->ref_count, (u_long)object->size,
2241 (u_long)object->size,
2242 (void *)object->backing_object);
2249 * vm_object_print: [ debug ]
2251 DB_SHOW_COMMAND(object, vm_object_print_static)
2253 /* XXX convert args. */
2254 vm_object_t object = (vm_object_t)addr;
2255 boolean_t full = have_addr;
2259 /* XXX count is an (unused) arg. Avoid shadowing it. */
2260 #define count was_count
2268 "Object %p: type=%d, size=0x%jx, res=%d, ref=%d, flags=0x%x ruid %d charge %jx\n",
2269 object, (int)object->type, (uintmax_t)object->size,
2270 object->resident_page_count, object->ref_count, object->flags,
2271 object->cred ? object->cred->cr_ruid : -1, (uintmax_t)object->charge);
2272 db_iprintf(" sref=%d, backing_object(%d)=(%p)+0x%jx\n",
2273 object->shadow_count,
2274 object->backing_object ? object->backing_object->ref_count : 0,
2275 object->backing_object, (uintmax_t)object->backing_object_offset);
2282 TAILQ_FOREACH(p, &object->memq, listq) {
2284 db_iprintf("memory:=");
2285 else if (count == 6) {
2293 db_printf("(off=0x%jx,page=0x%jx)",
2294 (uintmax_t)p->pindex, (uintmax_t)VM_PAGE_TO_PHYS(p));
2304 /* XXX need this non-static entry for calling from vm_map_print. */
2307 /* db_expr_t */ long addr,
2308 boolean_t have_addr,
2309 /* db_expr_t */ long count,
2312 vm_object_print_static(addr, have_addr, count, modif);
2315 DB_SHOW_COMMAND(vmopag, vm_object_print_pages)
2320 vm_page_t m, prev_m;
2324 TAILQ_FOREACH(object, &vm_object_list, object_list) {
2325 db_printf("new object: %p\n", (void *)object);
2336 TAILQ_FOREACH(m, &object->memq, listq) {
2337 if (m->pindex > 128)
2339 if ((prev_m = TAILQ_PREV(m, pglist, listq)) != NULL &&
2340 prev_m->pindex + 1 != m->pindex) {
2342 db_printf(" index(%ld)run(%d)pa(0x%lx)\n",
2343 (long)fidx, rcount, (long)pa);
2355 (VM_PAGE_TO_PHYS(m) == pa + rcount * PAGE_SIZE)) {
2360 db_printf(" index(%ld)run(%d)pa(0x%lx)\n",
2361 (long)fidx, rcount, (long)pa);
2371 pa = VM_PAGE_TO_PHYS(m);
2375 db_printf(" index(%ld)run(%d)pa(0x%lx)\n",
2376 (long)fidx, rcount, (long)pa);