xref: /freebsd/sys/vm/vm_map.c (revision a1db87ec73dd672c8255ec5495ee74706ba1a74c)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  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_map.c	8.3 (Berkeley) 1/12/94
33  *
34  *
35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36  * All rights reserved.
37  *
38  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
39  *
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.
45  *
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.
49  *
50  * Carnegie Mellon requests users of this software to return to
51  *
52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
53  *  School of Computer Science
54  *  Carnegie Mellon University
55  *  Pittsburgh PA 15213-3890
56  *
57  * any improvements or extensions that they make and grant Carnegie the
58  * rights to redistribute these changes.
59  */
60 
61 /*
62  *	Virtual memory mapping module.
63  */
64 
65 #include <sys/cdefs.h>
66 __FBSDID("$FreeBSD$");
67 
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h>
71 #include <sys/ktr.h>
72 #include <sys/lock.h>
73 #include <sys/mutex.h>
74 #include <sys/proc.h>
75 #include <sys/vmmeter.h>
76 #include <sys/mman.h>
77 #include <sys/vnode.h>
78 #include <sys/racct.h>
79 #include <sys/resourcevar.h>
80 #include <sys/rwlock.h>
81 #include <sys/file.h>
82 #include <sys/sysctl.h>
83 #include <sys/sysent.h>
84 #include <sys/shm.h>
85 
86 #include <vm/vm.h>
87 #include <vm/vm_param.h>
88 #include <vm/pmap.h>
89 #include <vm/vm_map.h>
90 #include <vm/vm_page.h>
91 #include <vm/vm_object.h>
92 #include <vm/vm_pager.h>
93 #include <vm/vm_kern.h>
94 #include <vm/vm_extern.h>
95 #include <vm/vnode_pager.h>
96 #include <vm/swap_pager.h>
97 #include <vm/uma.h>
98 
99 /*
100  *	Virtual memory maps provide for the mapping, protection,
101  *	and sharing of virtual memory objects.  In addition,
102  *	this module provides for an efficient virtual copy of
103  *	memory from one map to another.
104  *
105  *	Synchronization is required prior to most operations.
106  *
107  *	Maps consist of an ordered doubly-linked list of simple
108  *	entries; a self-adjusting binary search tree of these
109  *	entries is used to speed up lookups.
110  *
111  *	Since portions of maps are specified by start/end addresses,
112  *	which may not align with existing map entries, all
113  *	routines merely "clip" entries to these start/end values.
114  *	[That is, an entry is split into two, bordering at a
115  *	start or end value.]  Note that these clippings may not
116  *	always be necessary (as the two resulting entries are then
117  *	not changed); however, the clipping is done for convenience.
118  *
119  *	As mentioned above, virtual copy operations are performed
120  *	by copying VM object references from one map to
121  *	another, and then marking both regions as copy-on-write.
122  */
123 
124 static struct mtx map_sleep_mtx;
125 static uma_zone_t mapentzone;
126 static uma_zone_t kmapentzone;
127 static uma_zone_t mapzone;
128 static uma_zone_t vmspace_zone;
129 static int vmspace_zinit(void *mem, int size, int flags);
130 static void vmspace_zfini(void *mem, int size);
131 static int vm_map_zinit(void *mem, int ize, int flags);
132 static void vm_map_zfini(void *mem, int size);
133 static void _vm_map_init(vm_map_t map, pmap_t pmap, vm_offset_t min,
134     vm_offset_t max);
135 static void vm_map_entry_deallocate(vm_map_entry_t entry, boolean_t system_map);
136 static void vm_map_entry_dispose(vm_map_t map, vm_map_entry_t entry);
137 #ifdef INVARIANTS
138 static void vm_map_zdtor(void *mem, int size, void *arg);
139 static void vmspace_zdtor(void *mem, int size, void *arg);
140 #endif
141 
142 #define	ENTRY_CHARGED(e) ((e)->cred != NULL || \
143     ((e)->object.vm_object != NULL && (e)->object.vm_object->cred != NULL && \
144      !((e)->eflags & MAP_ENTRY_NEEDS_COPY)))
145 
146 /*
147  * PROC_VMSPACE_{UN,}LOCK() can be a noop as long as vmspaces are type
148  * stable.
149  */
150 #define PROC_VMSPACE_LOCK(p) do { } while (0)
151 #define PROC_VMSPACE_UNLOCK(p) do { } while (0)
152 
153 /*
154  *	VM_MAP_RANGE_CHECK:	[ internal use only ]
155  *
156  *	Asserts that the starting and ending region
157  *	addresses fall within the valid range of the map.
158  */
159 #define	VM_MAP_RANGE_CHECK(map, start, end)		\
160 		{					\
161 		if (start < vm_map_min(map))		\
162 			start = vm_map_min(map);	\
163 		if (end > vm_map_max(map))		\
164 			end = vm_map_max(map);		\
165 		if (start > end)			\
166 			start = end;			\
167 		}
168 
169 /*
170  *	vm_map_startup:
171  *
172  *	Initialize the vm_map module.  Must be called before
173  *	any other vm_map routines.
174  *
175  *	Map and entry structures are allocated from the general
176  *	purpose memory pool with some exceptions:
177  *
178  *	- The kernel map and kmem submap are allocated statically.
179  *	- Kernel map entries are allocated out of a static pool.
180  *
181  *	These restrictions are necessary since malloc() uses the
182  *	maps and requires map entries.
183  */
184 
185 void
186 vm_map_startup(void)
187 {
188 	mtx_init(&map_sleep_mtx, "vm map sleep mutex", NULL, MTX_DEF);
189 	mapzone = uma_zcreate("MAP", sizeof(struct vm_map), NULL,
190 #ifdef INVARIANTS
191 	    vm_map_zdtor,
192 #else
193 	    NULL,
194 #endif
195 	    vm_map_zinit, vm_map_zfini, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
196 	uma_prealloc(mapzone, MAX_KMAP);
197 	kmapentzone = uma_zcreate("KMAP ENTRY", sizeof(struct vm_map_entry),
198 	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,
199 	    UMA_ZONE_MTXCLASS | UMA_ZONE_VM);
200 	uma_prealloc(kmapentzone, MAX_KMAPENT);
201 	mapentzone = uma_zcreate("MAP ENTRY", sizeof(struct vm_map_entry),
202 	    NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
203 }
204 
205 static void
206 vmspace_zfini(void *mem, int size)
207 {
208 	struct vmspace *vm;
209 
210 	vm = (struct vmspace *)mem;
211 	vm_map_zfini(&vm->vm_map, sizeof(vm->vm_map));
212 }
213 
214 static int
215 vmspace_zinit(void *mem, int size, int flags)
216 {
217 	struct vmspace *vm;
218 
219 	vm = (struct vmspace *)mem;
220 
221 	vm->vm_map.pmap = NULL;
222 	(void)vm_map_zinit(&vm->vm_map, sizeof(vm->vm_map), flags);
223 	return (0);
224 }
225 
226 static void
227 vm_map_zfini(void *mem, int size)
228 {
229 	vm_map_t map;
230 
231 	map = (vm_map_t)mem;
232 	mtx_destroy(&map->system_mtx);
233 	sx_destroy(&map->lock);
234 }
235 
236 static int
237 vm_map_zinit(void *mem, int size, int flags)
238 {
239 	vm_map_t map;
240 
241 	map = (vm_map_t)mem;
242 	map->nentries = 0;
243 	map->size = 0;
244 	mtx_init(&map->system_mtx, "vm map (system)", NULL, MTX_DEF | MTX_DUPOK);
245 	sx_init(&map->lock, "vm map (user)");
246 	return (0);
247 }
248 
249 #ifdef INVARIANTS
250 static void
251 vmspace_zdtor(void *mem, int size, void *arg)
252 {
253 	struct vmspace *vm;
254 
255 	vm = (struct vmspace *)mem;
256 
257 	vm_map_zdtor(&vm->vm_map, sizeof(vm->vm_map), arg);
258 }
259 static void
260 vm_map_zdtor(void *mem, int size, void *arg)
261 {
262 	vm_map_t map;
263 
264 	map = (vm_map_t)mem;
265 	KASSERT(map->nentries == 0,
266 	    ("map %p nentries == %d on free.",
267 	    map, map->nentries));
268 	KASSERT(map->size == 0,
269 	    ("map %p size == %lu on free.",
270 	    map, (unsigned long)map->size));
271 }
272 #endif	/* INVARIANTS */
273 
274 /*
275  * Allocate a vmspace structure, including a vm_map and pmap,
276  * and initialize those structures.  The refcnt is set to 1.
277  */
278 struct vmspace *
279 vmspace_alloc(min, max)
280 	vm_offset_t min, max;
281 {
282 	struct vmspace *vm;
283 
284 	vm = uma_zalloc(vmspace_zone, M_WAITOK);
285 	if (vm->vm_map.pmap == NULL && !pmap_pinit(vmspace_pmap(vm))) {
286 		uma_zfree(vmspace_zone, vm);
287 		return (NULL);
288 	}
289 	CTR1(KTR_VM, "vmspace_alloc: %p", vm);
290 	_vm_map_init(&vm->vm_map, vmspace_pmap(vm), min, max);
291 	vm->vm_refcnt = 1;
292 	vm->vm_shm = NULL;
293 	vm->vm_swrss = 0;
294 	vm->vm_tsize = 0;
295 	vm->vm_dsize = 0;
296 	vm->vm_ssize = 0;
297 	vm->vm_taddr = 0;
298 	vm->vm_daddr = 0;
299 	vm->vm_maxsaddr = 0;
300 	return (vm);
301 }
302 
303 void
304 vm_init2(void)
305 {
306 	uma_zone_reserve_kva(kmapentzone, lmin(cnt.v_page_count,
307 	    (VM_MAX_KERNEL_ADDRESS - VM_MIN_KERNEL_ADDRESS) / PAGE_SIZE) / 8 +
308 	     maxproc * 2 + maxfiles);
309 	vmspace_zone = uma_zcreate("VMSPACE", sizeof(struct vmspace), NULL,
310 #ifdef INVARIANTS
311 	    vmspace_zdtor,
312 #else
313 	    NULL,
314 #endif
315 	    vmspace_zinit, vmspace_zfini, UMA_ALIGN_PTR, UMA_ZONE_NOFREE);
316 }
317 
318 static void
319 vmspace_container_reset(struct proc *p)
320 {
321 
322 #ifdef RACCT
323 	PROC_LOCK(p);
324 	racct_set(p, RACCT_DATA, 0);
325 	racct_set(p, RACCT_STACK, 0);
326 	racct_set(p, RACCT_RSS, 0);
327 	racct_set(p, RACCT_MEMLOCK, 0);
328 	racct_set(p, RACCT_VMEM, 0);
329 	PROC_UNLOCK(p);
330 #endif
331 }
332 
333 static inline void
334 vmspace_dofree(struct vmspace *vm)
335 {
336 
337 	CTR1(KTR_VM, "vmspace_free: %p", vm);
338 
339 	/*
340 	 * Make sure any SysV shm is freed, it might not have been in
341 	 * exit1().
342 	 */
343 	shmexit(vm);
344 
345 	/*
346 	 * Lock the map, to wait out all other references to it.
347 	 * Delete all of the mappings and pages they hold, then call
348 	 * the pmap module to reclaim anything left.
349 	 */
350 	(void)vm_map_remove(&vm->vm_map, vm->vm_map.min_offset,
351 	    vm->vm_map.max_offset);
352 
353 	pmap_release(vmspace_pmap(vm));
354 	vm->vm_map.pmap = NULL;
355 	uma_zfree(vmspace_zone, vm);
356 }
357 
358 void
359 vmspace_free(struct vmspace *vm)
360 {
361 
362 	if (vm->vm_refcnt == 0)
363 		panic("vmspace_free: attempt to free already freed vmspace");
364 
365 	if (atomic_fetchadd_int(&vm->vm_refcnt, -1) == 1)
366 		vmspace_dofree(vm);
367 }
368 
369 void
370 vmspace_exitfree(struct proc *p)
371 {
372 	struct vmspace *vm;
373 
374 	PROC_VMSPACE_LOCK(p);
375 	vm = p->p_vmspace;
376 	p->p_vmspace = NULL;
377 	PROC_VMSPACE_UNLOCK(p);
378 	KASSERT(vm == &vmspace0, ("vmspace_exitfree: wrong vmspace"));
379 	vmspace_free(vm);
380 }
381 
382 void
383 vmspace_exit(struct thread *td)
384 {
385 	int refcnt;
386 	struct vmspace *vm;
387 	struct proc *p;
388 
389 	/*
390 	 * Release user portion of address space.
391 	 * This releases references to vnodes,
392 	 * which could cause I/O if the file has been unlinked.
393 	 * Need to do this early enough that we can still sleep.
394 	 *
395 	 * The last exiting process to reach this point releases as
396 	 * much of the environment as it can. vmspace_dofree() is the
397 	 * slower fallback in case another process had a temporary
398 	 * reference to the vmspace.
399 	 */
400 
401 	p = td->td_proc;
402 	vm = p->p_vmspace;
403 	atomic_add_int(&vmspace0.vm_refcnt, 1);
404 	do {
405 		refcnt = vm->vm_refcnt;
406 		if (refcnt > 1 && p->p_vmspace != &vmspace0) {
407 			/* Switch now since other proc might free vmspace */
408 			PROC_VMSPACE_LOCK(p);
409 			p->p_vmspace = &vmspace0;
410 			PROC_VMSPACE_UNLOCK(p);
411 			pmap_activate(td);
412 		}
413 	} while (!atomic_cmpset_int(&vm->vm_refcnt, refcnt, refcnt - 1));
414 	if (refcnt == 1) {
415 		if (p->p_vmspace != vm) {
416 			/* vmspace not yet freed, switch back */
417 			PROC_VMSPACE_LOCK(p);
418 			p->p_vmspace = vm;
419 			PROC_VMSPACE_UNLOCK(p);
420 			pmap_activate(td);
421 		}
422 		pmap_remove_pages(vmspace_pmap(vm));
423 		/* Switch now since this proc will free vmspace */
424 		PROC_VMSPACE_LOCK(p);
425 		p->p_vmspace = &vmspace0;
426 		PROC_VMSPACE_UNLOCK(p);
427 		pmap_activate(td);
428 		vmspace_dofree(vm);
429 	}
430 	vmspace_container_reset(p);
431 }
432 
433 /* Acquire reference to vmspace owned by another process. */
434 
435 struct vmspace *
436 vmspace_acquire_ref(struct proc *p)
437 {
438 	struct vmspace *vm;
439 	int refcnt;
440 
441 	PROC_VMSPACE_LOCK(p);
442 	vm = p->p_vmspace;
443 	if (vm == NULL) {
444 		PROC_VMSPACE_UNLOCK(p);
445 		return (NULL);
446 	}
447 	do {
448 		refcnt = vm->vm_refcnt;
449 		if (refcnt <= 0) { 	/* Avoid 0->1 transition */
450 			PROC_VMSPACE_UNLOCK(p);
451 			return (NULL);
452 		}
453 	} while (!atomic_cmpset_int(&vm->vm_refcnt, refcnt, refcnt + 1));
454 	if (vm != p->p_vmspace) {
455 		PROC_VMSPACE_UNLOCK(p);
456 		vmspace_free(vm);
457 		return (NULL);
458 	}
459 	PROC_VMSPACE_UNLOCK(p);
460 	return (vm);
461 }
462 
463 void
464 _vm_map_lock(vm_map_t map, const char *file, int line)
465 {
466 
467 	if (map->system_map)
468 		mtx_lock_flags_(&map->system_mtx, 0, file, line);
469 	else
470 		sx_xlock_(&map->lock, file, line);
471 	map->timestamp++;
472 }
473 
474 static void
475 vm_map_process_deferred(void)
476 {
477 	struct thread *td;
478 	vm_map_entry_t entry, next;
479 	vm_object_t object;
480 
481 	td = curthread;
482 	entry = td->td_map_def_user;
483 	td->td_map_def_user = NULL;
484 	while (entry != NULL) {
485 		next = entry->next;
486 		if ((entry->eflags & MAP_ENTRY_VN_WRITECNT) != 0) {
487 			/*
488 			 * Decrement the object's writemappings and
489 			 * possibly the vnode's v_writecount.
490 			 */
491 			KASSERT((entry->eflags & MAP_ENTRY_IS_SUB_MAP) == 0,
492 			    ("Submap with writecount"));
493 			object = entry->object.vm_object;
494 			KASSERT(object != NULL, ("No object for writecount"));
495 			vnode_pager_release_writecount(object, entry->start,
496 			    entry->end);
497 		}
498 		vm_map_entry_deallocate(entry, FALSE);
499 		entry = next;
500 	}
501 }
502 
503 void
504 _vm_map_unlock(vm_map_t map, const char *file, int line)
505 {
506 
507 	if (map->system_map)
508 		mtx_unlock_flags_(&map->system_mtx, 0, file, line);
509 	else {
510 		sx_xunlock_(&map->lock, file, line);
511 		vm_map_process_deferred();
512 	}
513 }
514 
515 void
516 _vm_map_lock_read(vm_map_t map, const char *file, int line)
517 {
518 
519 	if (map->system_map)
520 		mtx_lock_flags_(&map->system_mtx, 0, file, line);
521 	else
522 		sx_slock_(&map->lock, file, line);
523 }
524 
525 void
526 _vm_map_unlock_read(vm_map_t map, const char *file, int line)
527 {
528 
529 	if (map->system_map)
530 		mtx_unlock_flags_(&map->system_mtx, 0, file, line);
531 	else {
532 		sx_sunlock_(&map->lock, file, line);
533 		vm_map_process_deferred();
534 	}
535 }
536 
537 int
538 _vm_map_trylock(vm_map_t map, const char *file, int line)
539 {
540 	int error;
541 
542 	error = map->system_map ?
543 	    !mtx_trylock_flags_(&map->system_mtx, 0, file, line) :
544 	    !sx_try_xlock_(&map->lock, file, line);
545 	if (error == 0)
546 		map->timestamp++;
547 	return (error == 0);
548 }
549 
550 int
551 _vm_map_trylock_read(vm_map_t map, const char *file, int line)
552 {
553 	int error;
554 
555 	error = map->system_map ?
556 	    !mtx_trylock_flags_(&map->system_mtx, 0, file, line) :
557 	    !sx_try_slock_(&map->lock, file, line);
558 	return (error == 0);
559 }
560 
561 /*
562  *	_vm_map_lock_upgrade:	[ internal use only ]
563  *
564  *	Tries to upgrade a read (shared) lock on the specified map to a write
565  *	(exclusive) lock.  Returns the value "0" if the upgrade succeeds and a
566  *	non-zero value if the upgrade fails.  If the upgrade fails, the map is
567  *	returned without a read or write lock held.
568  *
569  *	Requires that the map be read locked.
570  */
571 int
572 _vm_map_lock_upgrade(vm_map_t map, const char *file, int line)
573 {
574 	unsigned int last_timestamp;
575 
576 	if (map->system_map) {
577 		mtx_assert_(&map->system_mtx, MA_OWNED, file, line);
578 	} else {
579 		if (!sx_try_upgrade_(&map->lock, file, line)) {
580 			last_timestamp = map->timestamp;
581 			sx_sunlock_(&map->lock, file, line);
582 			vm_map_process_deferred();
583 			/*
584 			 * If the map's timestamp does not change while the
585 			 * map is unlocked, then the upgrade succeeds.
586 			 */
587 			sx_xlock_(&map->lock, file, line);
588 			if (last_timestamp != map->timestamp) {
589 				sx_xunlock_(&map->lock, file, line);
590 				return (1);
591 			}
592 		}
593 	}
594 	map->timestamp++;
595 	return (0);
596 }
597 
598 void
599 _vm_map_lock_downgrade(vm_map_t map, const char *file, int line)
600 {
601 
602 	if (map->system_map) {
603 		mtx_assert_(&map->system_mtx, MA_OWNED, file, line);
604 	} else
605 		sx_downgrade_(&map->lock, file, line);
606 }
607 
608 /*
609  *	vm_map_locked:
610  *
611  *	Returns a non-zero value if the caller holds a write (exclusive) lock
612  *	on the specified map and the value "0" otherwise.
613  */
614 int
615 vm_map_locked(vm_map_t map)
616 {
617 
618 	if (map->system_map)
619 		return (mtx_owned(&map->system_mtx));
620 	else
621 		return (sx_xlocked(&map->lock));
622 }
623 
624 #ifdef INVARIANTS
625 static void
626 _vm_map_assert_locked(vm_map_t map, const char *file, int line)
627 {
628 
629 	if (map->system_map)
630 		mtx_assert_(&map->system_mtx, MA_OWNED, file, line);
631 	else
632 		sx_assert_(&map->lock, SA_XLOCKED, file, line);
633 }
634 
635 #define	VM_MAP_ASSERT_LOCKED(map) \
636     _vm_map_assert_locked(map, LOCK_FILE, LOCK_LINE)
637 #else
638 #define	VM_MAP_ASSERT_LOCKED(map)
639 #endif
640 
641 /*
642  *	_vm_map_unlock_and_wait:
643  *
644  *	Atomically releases the lock on the specified map and puts the calling
645  *	thread to sleep.  The calling thread will remain asleep until either
646  *	vm_map_wakeup() is performed on the map or the specified timeout is
647  *	exceeded.
648  *
649  *	WARNING!  This function does not perform deferred deallocations of
650  *	objects and map	entries.  Therefore, the calling thread is expected to
651  *	reacquire the map lock after reawakening and later perform an ordinary
652  *	unlock operation, such as vm_map_unlock(), before completing its
653  *	operation on the map.
654  */
655 int
656 _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line)
657 {
658 
659 	mtx_lock(&map_sleep_mtx);
660 	if (map->system_map)
661 		mtx_unlock_flags_(&map->system_mtx, 0, file, line);
662 	else
663 		sx_xunlock_(&map->lock, file, line);
664 	return (msleep(&map->root, &map_sleep_mtx, PDROP | PVM, "vmmaps",
665 	    timo));
666 }
667 
668 /*
669  *	vm_map_wakeup:
670  *
671  *	Awaken any threads that have slept on the map using
672  *	vm_map_unlock_and_wait().
673  */
674 void
675 vm_map_wakeup(vm_map_t map)
676 {
677 
678 	/*
679 	 * Acquire and release map_sleep_mtx to prevent a wakeup()
680 	 * from being performed (and lost) between the map unlock
681 	 * and the msleep() in _vm_map_unlock_and_wait().
682 	 */
683 	mtx_lock(&map_sleep_mtx);
684 	mtx_unlock(&map_sleep_mtx);
685 	wakeup(&map->root);
686 }
687 
688 void
689 vm_map_busy(vm_map_t map)
690 {
691 
692 	VM_MAP_ASSERT_LOCKED(map);
693 	map->busy++;
694 }
695 
696 void
697 vm_map_unbusy(vm_map_t map)
698 {
699 
700 	VM_MAP_ASSERT_LOCKED(map);
701 	KASSERT(map->busy, ("vm_map_unbusy: not busy"));
702 	if (--map->busy == 0 && (map->flags & MAP_BUSY_WAKEUP)) {
703 		vm_map_modflags(map, 0, MAP_BUSY_WAKEUP);
704 		wakeup(&map->busy);
705 	}
706 }
707 
708 void
709 vm_map_wait_busy(vm_map_t map)
710 {
711 
712 	VM_MAP_ASSERT_LOCKED(map);
713 	while (map->busy) {
714 		vm_map_modflags(map, MAP_BUSY_WAKEUP, 0);
715 		if (map->system_map)
716 			msleep(&map->busy, &map->system_mtx, 0, "mbusy", 0);
717 		else
718 			sx_sleep(&map->busy, &map->lock, 0, "mbusy", 0);
719 	}
720 	map->timestamp++;
721 }
722 
723 long
724 vmspace_resident_count(struct vmspace *vmspace)
725 {
726 	return pmap_resident_count(vmspace_pmap(vmspace));
727 }
728 
729 /*
730  *	vm_map_create:
731  *
732  *	Creates and returns a new empty VM map with
733  *	the given physical map structure, and having
734  *	the given lower and upper address bounds.
735  */
736 vm_map_t
737 vm_map_create(pmap_t pmap, vm_offset_t min, vm_offset_t max)
738 {
739 	vm_map_t result;
740 
741 	result = uma_zalloc(mapzone, M_WAITOK);
742 	CTR1(KTR_VM, "vm_map_create: %p", result);
743 	_vm_map_init(result, pmap, min, max);
744 	return (result);
745 }
746 
747 /*
748  * Initialize an existing vm_map structure
749  * such as that in the vmspace structure.
750  */
751 static void
752 _vm_map_init(vm_map_t map, pmap_t pmap, vm_offset_t min, vm_offset_t max)
753 {
754 
755 	map->header.next = map->header.prev = &map->header;
756 	map->needs_wakeup = FALSE;
757 	map->system_map = 0;
758 	map->pmap = pmap;
759 	map->min_offset = min;
760 	map->max_offset = max;
761 	map->flags = 0;
762 	map->root = NULL;
763 	map->timestamp = 0;
764 	map->busy = 0;
765 }
766 
767 void
768 vm_map_init(vm_map_t map, pmap_t pmap, vm_offset_t min, vm_offset_t max)
769 {
770 
771 	_vm_map_init(map, pmap, min, max);
772 	mtx_init(&map->system_mtx, "system map", NULL, MTX_DEF | MTX_DUPOK);
773 	sx_init(&map->lock, "user map");
774 }
775 
776 /*
777  *	vm_map_entry_dispose:	[ internal use only ]
778  *
779  *	Inverse of vm_map_entry_create.
780  */
781 static void
782 vm_map_entry_dispose(vm_map_t map, vm_map_entry_t entry)
783 {
784 	uma_zfree(map->system_map ? kmapentzone : mapentzone, entry);
785 }
786 
787 /*
788  *	vm_map_entry_create:	[ internal use only ]
789  *
790  *	Allocates a VM map entry for insertion.
791  *	No entry fields are filled in.
792  */
793 static vm_map_entry_t
794 vm_map_entry_create(vm_map_t map)
795 {
796 	vm_map_entry_t new_entry;
797 
798 	if (map->system_map)
799 		new_entry = uma_zalloc(kmapentzone, M_NOWAIT);
800 	else
801 		new_entry = uma_zalloc(mapentzone, M_WAITOK);
802 	if (new_entry == NULL)
803 		panic("vm_map_entry_create: kernel resources exhausted");
804 	return (new_entry);
805 }
806 
807 /*
808  *	vm_map_entry_set_behavior:
809  *
810  *	Set the expected access behavior, either normal, random, or
811  *	sequential.
812  */
813 static inline void
814 vm_map_entry_set_behavior(vm_map_entry_t entry, u_char behavior)
815 {
816 	entry->eflags = (entry->eflags & ~MAP_ENTRY_BEHAV_MASK) |
817 	    (behavior & MAP_ENTRY_BEHAV_MASK);
818 }
819 
820 /*
821  *	vm_map_entry_set_max_free:
822  *
823  *	Set the max_free field in a vm_map_entry.
824  */
825 static inline void
826 vm_map_entry_set_max_free(vm_map_entry_t entry)
827 {
828 
829 	entry->max_free = entry->adj_free;
830 	if (entry->left != NULL && entry->left->max_free > entry->max_free)
831 		entry->max_free = entry->left->max_free;
832 	if (entry->right != NULL && entry->right->max_free > entry->max_free)
833 		entry->max_free = entry->right->max_free;
834 }
835 
836 /*
837  *	vm_map_entry_splay:
838  *
839  *	The Sleator and Tarjan top-down splay algorithm with the
840  *	following variation.  Max_free must be computed bottom-up, so
841  *	on the downward pass, maintain the left and right spines in
842  *	reverse order.  Then, make a second pass up each side to fix
843  *	the pointers and compute max_free.  The time bound is O(log n)
844  *	amortized.
845  *
846  *	The new root is the vm_map_entry containing "addr", or else an
847  *	adjacent entry (lower or higher) if addr is not in the tree.
848  *
849  *	The map must be locked, and leaves it so.
850  *
851  *	Returns: the new root.
852  */
853 static vm_map_entry_t
854 vm_map_entry_splay(vm_offset_t addr, vm_map_entry_t root)
855 {
856 	vm_map_entry_t llist, rlist;
857 	vm_map_entry_t ltree, rtree;
858 	vm_map_entry_t y;
859 
860 	/* Special case of empty tree. */
861 	if (root == NULL)
862 		return (root);
863 
864 	/*
865 	 * Pass One: Splay down the tree until we find addr or a NULL
866 	 * pointer where addr would go.  llist and rlist are the two
867 	 * sides in reverse order (bottom-up), with llist linked by
868 	 * the right pointer and rlist linked by the left pointer in
869 	 * the vm_map_entry.  Wait until Pass Two to set max_free on
870 	 * the two spines.
871 	 */
872 	llist = NULL;
873 	rlist = NULL;
874 	for (;;) {
875 		/* root is never NULL in here. */
876 		if (addr < root->start) {
877 			y = root->left;
878 			if (y == NULL)
879 				break;
880 			if (addr < y->start && y->left != NULL) {
881 				/* Rotate right and put y on rlist. */
882 				root->left = y->right;
883 				y->right = root;
884 				vm_map_entry_set_max_free(root);
885 				root = y->left;
886 				y->left = rlist;
887 				rlist = y;
888 			} else {
889 				/* Put root on rlist. */
890 				root->left = rlist;
891 				rlist = root;
892 				root = y;
893 			}
894 		} else if (addr >= root->end) {
895 			y = root->right;
896 			if (y == NULL)
897 				break;
898 			if (addr >= y->end && y->right != NULL) {
899 				/* Rotate left and put y on llist. */
900 				root->right = y->left;
901 				y->left = root;
902 				vm_map_entry_set_max_free(root);
903 				root = y->right;
904 				y->right = llist;
905 				llist = y;
906 			} else {
907 				/* Put root on llist. */
908 				root->right = llist;
909 				llist = root;
910 				root = y;
911 			}
912 		} else
913 			break;
914 	}
915 
916 	/*
917 	 * Pass Two: Walk back up the two spines, flip the pointers
918 	 * and set max_free.  The subtrees of the root go at the
919 	 * bottom of llist and rlist.
920 	 */
921 	ltree = root->left;
922 	while (llist != NULL) {
923 		y = llist->right;
924 		llist->right = ltree;
925 		vm_map_entry_set_max_free(llist);
926 		ltree = llist;
927 		llist = y;
928 	}
929 	rtree = root->right;
930 	while (rlist != NULL) {
931 		y = rlist->left;
932 		rlist->left = rtree;
933 		vm_map_entry_set_max_free(rlist);
934 		rtree = rlist;
935 		rlist = y;
936 	}
937 
938 	/*
939 	 * Final assembly: add ltree and rtree as subtrees of root.
940 	 */
941 	root->left = ltree;
942 	root->right = rtree;
943 	vm_map_entry_set_max_free(root);
944 
945 	return (root);
946 }
947 
948 /*
949  *	vm_map_entry_{un,}link:
950  *
951  *	Insert/remove entries from maps.
952  */
953 static void
954 vm_map_entry_link(vm_map_t map,
955 		  vm_map_entry_t after_where,
956 		  vm_map_entry_t entry)
957 {
958 
959 	CTR4(KTR_VM,
960 	    "vm_map_entry_link: map %p, nentries %d, entry %p, after %p", map,
961 	    map->nentries, entry, after_where);
962 	VM_MAP_ASSERT_LOCKED(map);
963 	map->nentries++;
964 	entry->prev = after_where;
965 	entry->next = after_where->next;
966 	entry->next->prev = entry;
967 	after_where->next = entry;
968 
969 	if (after_where != &map->header) {
970 		if (after_where != map->root)
971 			vm_map_entry_splay(after_where->start, map->root);
972 		entry->right = after_where->right;
973 		entry->left = after_where;
974 		after_where->right = NULL;
975 		after_where->adj_free = entry->start - after_where->end;
976 		vm_map_entry_set_max_free(after_where);
977 	} else {
978 		entry->right = map->root;
979 		entry->left = NULL;
980 	}
981 	entry->adj_free = (entry->next == &map->header ? map->max_offset :
982 	    entry->next->start) - entry->end;
983 	vm_map_entry_set_max_free(entry);
984 	map->root = entry;
985 }
986 
987 static void
988 vm_map_entry_unlink(vm_map_t map,
989 		    vm_map_entry_t entry)
990 {
991 	vm_map_entry_t next, prev, root;
992 
993 	VM_MAP_ASSERT_LOCKED(map);
994 	if (entry != map->root)
995 		vm_map_entry_splay(entry->start, map->root);
996 	if (entry->left == NULL)
997 		root = entry->right;
998 	else {
999 		root = vm_map_entry_splay(entry->start, entry->left);
1000 		root->right = entry->right;
1001 		root->adj_free = (entry->next == &map->header ? map->max_offset :
1002 		    entry->next->start) - root->end;
1003 		vm_map_entry_set_max_free(root);
1004 	}
1005 	map->root = root;
1006 
1007 	prev = entry->prev;
1008 	next = entry->next;
1009 	next->prev = prev;
1010 	prev->next = next;
1011 	map->nentries--;
1012 	CTR3(KTR_VM, "vm_map_entry_unlink: map %p, nentries %d, entry %p", map,
1013 	    map->nentries, entry);
1014 }
1015 
1016 /*
1017  *	vm_map_entry_resize_free:
1018  *
1019  *	Recompute the amount of free space following a vm_map_entry
1020  *	and propagate that value up the tree.  Call this function after
1021  *	resizing a map entry in-place, that is, without a call to
1022  *	vm_map_entry_link() or _unlink().
1023  *
1024  *	The map must be locked, and leaves it so.
1025  */
1026 static void
1027 vm_map_entry_resize_free(vm_map_t map, vm_map_entry_t entry)
1028 {
1029 
1030 	/*
1031 	 * Using splay trees without parent pointers, propagating
1032 	 * max_free up the tree is done by moving the entry to the
1033 	 * root and making the change there.
1034 	 */
1035 	if (entry != map->root)
1036 		map->root = vm_map_entry_splay(entry->start, map->root);
1037 
1038 	entry->adj_free = (entry->next == &map->header ? map->max_offset :
1039 	    entry->next->start) - entry->end;
1040 	vm_map_entry_set_max_free(entry);
1041 }
1042 
1043 /*
1044  *	vm_map_lookup_entry:	[ internal use only ]
1045  *
1046  *	Finds the map entry containing (or
1047  *	immediately preceding) the specified address
1048  *	in the given map; the entry is returned
1049  *	in the "entry" parameter.  The boolean
1050  *	result indicates whether the address is
1051  *	actually contained in the map.
1052  */
1053 boolean_t
1054 vm_map_lookup_entry(
1055 	vm_map_t map,
1056 	vm_offset_t address,
1057 	vm_map_entry_t *entry)	/* OUT */
1058 {
1059 	vm_map_entry_t cur;
1060 	boolean_t locked;
1061 
1062 	/*
1063 	 * If the map is empty, then the map entry immediately preceding
1064 	 * "address" is the map's header.
1065 	 */
1066 	cur = map->root;
1067 	if (cur == NULL)
1068 		*entry = &map->header;
1069 	else if (address >= cur->start && cur->end > address) {
1070 		*entry = cur;
1071 		return (TRUE);
1072 	} else if ((locked = vm_map_locked(map)) ||
1073 	    sx_try_upgrade(&map->lock)) {
1074 		/*
1075 		 * Splay requires a write lock on the map.  However, it only
1076 		 * restructures the binary search tree; it does not otherwise
1077 		 * change the map.  Thus, the map's timestamp need not change
1078 		 * on a temporary upgrade.
1079 		 */
1080 		map->root = cur = vm_map_entry_splay(address, cur);
1081 		if (!locked)
1082 			sx_downgrade(&map->lock);
1083 
1084 		/*
1085 		 * If "address" is contained within a map entry, the new root
1086 		 * is that map entry.  Otherwise, the new root is a map entry
1087 		 * immediately before or after "address".
1088 		 */
1089 		if (address >= cur->start) {
1090 			*entry = cur;
1091 			if (cur->end > address)
1092 				return (TRUE);
1093 		} else
1094 			*entry = cur->prev;
1095 	} else
1096 		/*
1097 		 * Since the map is only locked for read access, perform a
1098 		 * standard binary search tree lookup for "address".
1099 		 */
1100 		for (;;) {
1101 			if (address < cur->start) {
1102 				if (cur->left == NULL) {
1103 					*entry = cur->prev;
1104 					break;
1105 				}
1106 				cur = cur->left;
1107 			} else if (cur->end > address) {
1108 				*entry = cur;
1109 				return (TRUE);
1110 			} else {
1111 				if (cur->right == NULL) {
1112 					*entry = cur;
1113 					break;
1114 				}
1115 				cur = cur->right;
1116 			}
1117 		}
1118 	return (FALSE);
1119 }
1120 
1121 /*
1122  *	vm_map_insert:
1123  *
1124  *	Inserts the given whole VM object into the target
1125  *	map at the specified address range.  The object's
1126  *	size should match that of the address range.
1127  *
1128  *	Requires that the map be locked, and leaves it so.
1129  *
1130  *	If object is non-NULL, ref count must be bumped by caller
1131  *	prior to making call to account for the new entry.
1132  */
1133 int
1134 vm_map_insert(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
1135 	      vm_offset_t start, vm_offset_t end, vm_prot_t prot, vm_prot_t max,
1136 	      int cow)
1137 {
1138 	vm_map_entry_t new_entry;
1139 	vm_map_entry_t prev_entry;
1140 	vm_map_entry_t temp_entry;
1141 	vm_eflags_t protoeflags;
1142 	struct ucred *cred;
1143 	vm_inherit_t inheritance;
1144 	boolean_t charge_prev_obj;
1145 
1146 	VM_MAP_ASSERT_LOCKED(map);
1147 
1148 	/*
1149 	 * Check that the start and end points are not bogus.
1150 	 */
1151 	if ((start < map->min_offset) || (end > map->max_offset) ||
1152 	    (start >= end))
1153 		return (KERN_INVALID_ADDRESS);
1154 
1155 	/*
1156 	 * Find the entry prior to the proposed starting address; if it's part
1157 	 * of an existing entry, this range is bogus.
1158 	 */
1159 	if (vm_map_lookup_entry(map, start, &temp_entry))
1160 		return (KERN_NO_SPACE);
1161 
1162 	prev_entry = temp_entry;
1163 
1164 	/*
1165 	 * Assert that the next entry doesn't overlap the end point.
1166 	 */
1167 	if ((prev_entry->next != &map->header) &&
1168 	    (prev_entry->next->start < end))
1169 		return (KERN_NO_SPACE);
1170 
1171 	protoeflags = 0;
1172 	charge_prev_obj = FALSE;
1173 
1174 	if (cow & MAP_COPY_ON_WRITE)
1175 		protoeflags |= MAP_ENTRY_COW|MAP_ENTRY_NEEDS_COPY;
1176 
1177 	if (cow & MAP_NOFAULT) {
1178 		protoeflags |= MAP_ENTRY_NOFAULT;
1179 
1180 		KASSERT(object == NULL,
1181 			("vm_map_insert: paradoxical MAP_NOFAULT request"));
1182 	}
1183 	if (cow & MAP_DISABLE_SYNCER)
1184 		protoeflags |= MAP_ENTRY_NOSYNC;
1185 	if (cow & MAP_DISABLE_COREDUMP)
1186 		protoeflags |= MAP_ENTRY_NOCOREDUMP;
1187 	if (cow & MAP_VN_WRITECOUNT)
1188 		protoeflags |= MAP_ENTRY_VN_WRITECNT;
1189 	if (cow & MAP_INHERIT_SHARE)
1190 		inheritance = VM_INHERIT_SHARE;
1191 	else
1192 		inheritance = VM_INHERIT_DEFAULT;
1193 
1194 	cred = NULL;
1195 	KASSERT((object != kmem_object && object != kernel_object) ||
1196 	    ((object == kmem_object || object == kernel_object) &&
1197 		!(protoeflags & MAP_ENTRY_NEEDS_COPY)),
1198 	    ("kmem or kernel object and cow"));
1199 	if (cow & (MAP_ACC_NO_CHARGE | MAP_NOFAULT))
1200 		goto charged;
1201 	if ((cow & MAP_ACC_CHARGED) || ((prot & VM_PROT_WRITE) &&
1202 	    ((protoeflags & MAP_ENTRY_NEEDS_COPY) || object == NULL))) {
1203 		if (!(cow & MAP_ACC_CHARGED) && !swap_reserve(end - start))
1204 			return (KERN_RESOURCE_SHORTAGE);
1205 		KASSERT(object == NULL || (protoeflags & MAP_ENTRY_NEEDS_COPY) ||
1206 		    object->cred == NULL,
1207 		    ("OVERCOMMIT: vm_map_insert o %p", object));
1208 		cred = curthread->td_ucred;
1209 		crhold(cred);
1210 		if (object == NULL && !(protoeflags & MAP_ENTRY_NEEDS_COPY))
1211 			charge_prev_obj = TRUE;
1212 	}
1213 
1214 charged:
1215 	/* Expand the kernel pmap, if necessary. */
1216 	if (map == kernel_map && end > kernel_vm_end)
1217 		pmap_growkernel(end);
1218 	if (object != NULL) {
1219 		/*
1220 		 * OBJ_ONEMAPPING must be cleared unless this mapping
1221 		 * is trivially proven to be the only mapping for any
1222 		 * of the object's pages.  (Object granularity
1223 		 * reference counting is insufficient to recognize
1224 		 * aliases with precision.)
1225 		 */
1226 		VM_OBJECT_WLOCK(object);
1227 		if (object->ref_count > 1 || object->shadow_count != 0)
1228 			vm_object_clear_flag(object, OBJ_ONEMAPPING);
1229 		VM_OBJECT_WUNLOCK(object);
1230 	}
1231 	else if ((prev_entry != &map->header) &&
1232 		 (prev_entry->eflags == protoeflags) &&
1233 		 (prev_entry->end == start) &&
1234 		 (prev_entry->wired_count == 0) &&
1235 		 (prev_entry->cred == cred ||
1236 		  (prev_entry->object.vm_object != NULL &&
1237 		   (prev_entry->object.vm_object->cred == cred))) &&
1238 		   vm_object_coalesce(prev_entry->object.vm_object,
1239 		       prev_entry->offset,
1240 		       (vm_size_t)(prev_entry->end - prev_entry->start),
1241 		       (vm_size_t)(end - prev_entry->end), charge_prev_obj)) {
1242 		/*
1243 		 * We were able to extend the object.  Determine if we
1244 		 * can extend the previous map entry to include the
1245 		 * new range as well.
1246 		 */
1247 		if ((prev_entry->inheritance == inheritance) &&
1248 		    (prev_entry->protection == prot) &&
1249 		    (prev_entry->max_protection == max)) {
1250 			map->size += (end - prev_entry->end);
1251 			prev_entry->end = end;
1252 			vm_map_entry_resize_free(map, prev_entry);
1253 			vm_map_simplify_entry(map, prev_entry);
1254 			if (cred != NULL)
1255 				crfree(cred);
1256 			return (KERN_SUCCESS);
1257 		}
1258 
1259 		/*
1260 		 * If we can extend the object but cannot extend the
1261 		 * map entry, we have to create a new map entry.  We
1262 		 * must bump the ref count on the extended object to
1263 		 * account for it.  object may be NULL.
1264 		 */
1265 		object = prev_entry->object.vm_object;
1266 		offset = prev_entry->offset +
1267 			(prev_entry->end - prev_entry->start);
1268 		vm_object_reference(object);
1269 		if (cred != NULL && object != NULL && object->cred != NULL &&
1270 		    !(prev_entry->eflags & MAP_ENTRY_NEEDS_COPY)) {
1271 			/* Object already accounts for this uid. */
1272 			crfree(cred);
1273 			cred = NULL;
1274 		}
1275 	}
1276 
1277 	/*
1278 	 * NOTE: if conditionals fail, object can be NULL here.  This occurs
1279 	 * in things like the buffer map where we manage kva but do not manage
1280 	 * backing objects.
1281 	 */
1282 
1283 	/*
1284 	 * Create a new entry
1285 	 */
1286 	new_entry = vm_map_entry_create(map);
1287 	new_entry->start = start;
1288 	new_entry->end = end;
1289 	new_entry->cred = NULL;
1290 
1291 	new_entry->eflags = protoeflags;
1292 	new_entry->object.vm_object = object;
1293 	new_entry->offset = offset;
1294 	new_entry->avail_ssize = 0;
1295 
1296 	new_entry->inheritance = inheritance;
1297 	new_entry->protection = prot;
1298 	new_entry->max_protection = max;
1299 	new_entry->wired_count = 0;
1300 	new_entry->read_ahead = VM_FAULT_READ_AHEAD_INIT;
1301 	new_entry->next_read = OFF_TO_IDX(offset);
1302 
1303 	KASSERT(cred == NULL || !ENTRY_CHARGED(new_entry),
1304 	    ("OVERCOMMIT: vm_map_insert leaks vm_map %p", new_entry));
1305 	new_entry->cred = cred;
1306 
1307 	/*
1308 	 * Insert the new entry into the list
1309 	 */
1310 	vm_map_entry_link(map, prev_entry, new_entry);
1311 	map->size += new_entry->end - new_entry->start;
1312 
1313 	/*
1314 	 * It may be possible to merge the new entry with the next and/or
1315 	 * previous entries.  However, due to MAP_STACK_* being a hack, a
1316 	 * panic can result from merging such entries.
1317 	 */
1318 	if ((cow & (MAP_STACK_GROWS_DOWN | MAP_STACK_GROWS_UP)) == 0)
1319 		vm_map_simplify_entry(map, new_entry);
1320 
1321 	if (cow & (MAP_PREFAULT|MAP_PREFAULT_PARTIAL)) {
1322 		vm_map_pmap_enter(map, start, prot,
1323 				    object, OFF_TO_IDX(offset), end - start,
1324 				    cow & MAP_PREFAULT_PARTIAL);
1325 	}
1326 
1327 	return (KERN_SUCCESS);
1328 }
1329 
1330 /*
1331  *	vm_map_findspace:
1332  *
1333  *	Find the first fit (lowest VM address) for "length" free bytes
1334  *	beginning at address >= start in the given map.
1335  *
1336  *	In a vm_map_entry, "adj_free" is the amount of free space
1337  *	adjacent (higher address) to this entry, and "max_free" is the
1338  *	maximum amount of contiguous free space in its subtree.  This
1339  *	allows finding a free region in one path down the tree, so
1340  *	O(log n) amortized with splay trees.
1341  *
1342  *	The map must be locked, and leaves it so.
1343  *
1344  *	Returns: 0 on success, and starting address in *addr,
1345  *		 1 if insufficient space.
1346  */
1347 int
1348 vm_map_findspace(vm_map_t map, vm_offset_t start, vm_size_t length,
1349     vm_offset_t *addr)	/* OUT */
1350 {
1351 	vm_map_entry_t entry;
1352 	vm_offset_t st;
1353 
1354 	/*
1355 	 * Request must fit within min/max VM address and must avoid
1356 	 * address wrap.
1357 	 */
1358 	if (start < map->min_offset)
1359 		start = map->min_offset;
1360 	if (start + length > map->max_offset || start + length < start)
1361 		return (1);
1362 
1363 	/* Empty tree means wide open address space. */
1364 	if (map->root == NULL) {
1365 		*addr = start;
1366 		return (0);
1367 	}
1368 
1369 	/*
1370 	 * After splay, if start comes before root node, then there
1371 	 * must be a gap from start to the root.
1372 	 */
1373 	map->root = vm_map_entry_splay(start, map->root);
1374 	if (start + length <= map->root->start) {
1375 		*addr = start;
1376 		return (0);
1377 	}
1378 
1379 	/*
1380 	 * Root is the last node that might begin its gap before
1381 	 * start, and this is the last comparison where address
1382 	 * wrap might be a problem.
1383 	 */
1384 	st = (start > map->root->end) ? start : map->root->end;
1385 	if (length <= map->root->end + map->root->adj_free - st) {
1386 		*addr = st;
1387 		return (0);
1388 	}
1389 
1390 	/* With max_free, can immediately tell if no solution. */
1391 	entry = map->root->right;
1392 	if (entry == NULL || length > entry->max_free)
1393 		return (1);
1394 
1395 	/*
1396 	 * Search the right subtree in the order: left subtree, root,
1397 	 * right subtree (first fit).  The previous splay implies that
1398 	 * all regions in the right subtree have addresses > start.
1399 	 */
1400 	while (entry != NULL) {
1401 		if (entry->left != NULL && entry->left->max_free >= length)
1402 			entry = entry->left;
1403 		else if (entry->adj_free >= length) {
1404 			*addr = entry->end;
1405 			return (0);
1406 		} else
1407 			entry = entry->right;
1408 	}
1409 
1410 	/* Can't get here, so panic if we do. */
1411 	panic("vm_map_findspace: max_free corrupt");
1412 }
1413 
1414 int
1415 vm_map_fixed(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
1416     vm_offset_t start, vm_size_t length, vm_prot_t prot,
1417     vm_prot_t max, int cow)
1418 {
1419 	vm_offset_t end;
1420 	int result;
1421 
1422 	end = start + length;
1423 	vm_map_lock(map);
1424 	VM_MAP_RANGE_CHECK(map, start, end);
1425 	(void) vm_map_delete(map, start, end);
1426 	result = vm_map_insert(map, object, offset, start, end, prot,
1427 	    max, cow);
1428 	vm_map_unlock(map);
1429 	return (result);
1430 }
1431 
1432 /*
1433  *	vm_map_find finds an unallocated region in the target address
1434  *	map with the given length.  The search is defined to be
1435  *	first-fit from the specified address; the region found is
1436  *	returned in the same parameter.
1437  *
1438  *	If object is non-NULL, ref count must be bumped by caller
1439  *	prior to making call to account for the new entry.
1440  */
1441 int
1442 vm_map_find(vm_map_t map, vm_object_t object, vm_ooffset_t offset,
1443 	    vm_offset_t *addr,	/* IN/OUT */
1444 	    vm_size_t length, int find_space, vm_prot_t prot,
1445 	    vm_prot_t max, int cow)
1446 {
1447 	vm_offset_t start;
1448 	int result;
1449 
1450 	start = *addr;
1451 	vm_map_lock(map);
1452 	do {
1453 		if (find_space != VMFS_NO_SPACE) {
1454 			if (vm_map_findspace(map, start, length, addr)) {
1455 				vm_map_unlock(map);
1456 				return (KERN_NO_SPACE);
1457 			}
1458 			switch (find_space) {
1459 			case VMFS_ALIGNED_SPACE:
1460 				pmap_align_superpage(object, offset, addr,
1461 				    length);
1462 				break;
1463 #ifdef VMFS_TLB_ALIGNED_SPACE
1464 			case VMFS_TLB_ALIGNED_SPACE:
1465 				pmap_align_tlb(addr);
1466 				break;
1467 #endif
1468 			default:
1469 				break;
1470 			}
1471 
1472 			start = *addr;
1473 		}
1474 		result = vm_map_insert(map, object, offset, start, start +
1475 		    length, prot, max, cow);
1476 	} while (result == KERN_NO_SPACE && (find_space == VMFS_ALIGNED_SPACE
1477 #ifdef VMFS_TLB_ALIGNED_SPACE
1478 	    || find_space == VMFS_TLB_ALIGNED_SPACE
1479 #endif
1480 	    ));
1481 	vm_map_unlock(map);
1482 	return (result);
1483 }
1484 
1485 /*
1486  *	vm_map_simplify_entry:
1487  *
1488  *	Simplify the given map entry by merging with either neighbor.  This
1489  *	routine also has the ability to merge with both neighbors.
1490  *
1491  *	The map must be locked.
1492  *
1493  *	This routine guarentees that the passed entry remains valid (though
1494  *	possibly extended).  When merging, this routine may delete one or
1495  *	both neighbors.
1496  */
1497 void
1498 vm_map_simplify_entry(vm_map_t map, vm_map_entry_t entry)
1499 {
1500 	vm_map_entry_t next, prev;
1501 	vm_size_t prevsize, esize;
1502 
1503 	if (entry->eflags & (MAP_ENTRY_IN_TRANSITION | MAP_ENTRY_IS_SUB_MAP))
1504 		return;
1505 
1506 	prev = entry->prev;
1507 	if (prev != &map->header) {
1508 		prevsize = prev->end - prev->start;
1509 		if ( (prev->end == entry->start) &&
1510 		     (prev->object.vm_object == entry->object.vm_object) &&
1511 		     (!prev->object.vm_object ||
1512 			(prev->offset + prevsize == entry->offset)) &&
1513 		     (prev->eflags == entry->eflags) &&
1514 		     (prev->protection == entry->protection) &&
1515 		     (prev->max_protection == entry->max_protection) &&
1516 		     (prev->inheritance == entry->inheritance) &&
1517 		     (prev->wired_count == entry->wired_count) &&
1518 		     (prev->cred == entry->cred)) {
1519 			vm_map_entry_unlink(map, prev);
1520 			entry->start = prev->start;
1521 			entry->offset = prev->offset;
1522 			if (entry->prev != &map->header)
1523 				vm_map_entry_resize_free(map, entry->prev);
1524 
1525 			/*
1526 			 * If the backing object is a vnode object,
1527 			 * vm_object_deallocate() calls vrele().
1528 			 * However, vrele() does not lock the vnode
1529 			 * because the vnode has additional
1530 			 * references.  Thus, the map lock can be kept
1531 			 * without causing a lock-order reversal with
1532 			 * the vnode lock.
1533 			 *
1534 			 * Since we count the number of virtual page
1535 			 * mappings in object->un_pager.vnp.writemappings,
1536 			 * the writemappings value should not be adjusted
1537 			 * when the entry is disposed of.
1538 			 */
1539 			if (prev->object.vm_object)
1540 				vm_object_deallocate(prev->object.vm_object);
1541 			if (prev->cred != NULL)
1542 				crfree(prev->cred);
1543 			vm_map_entry_dispose(map, prev);
1544 		}
1545 	}
1546 
1547 	next = entry->next;
1548 	if (next != &map->header) {
1549 		esize = entry->end - entry->start;
1550 		if ((entry->end == next->start) &&
1551 		    (next->object.vm_object == entry->object.vm_object) &&
1552 		     (!entry->object.vm_object ||
1553 			(entry->offset + esize == next->offset)) &&
1554 		    (next->eflags == entry->eflags) &&
1555 		    (next->protection == entry->protection) &&
1556 		    (next->max_protection == entry->max_protection) &&
1557 		    (next->inheritance == entry->inheritance) &&
1558 		    (next->wired_count == entry->wired_count) &&
1559 		    (next->cred == entry->cred)) {
1560 			vm_map_entry_unlink(map, next);
1561 			entry->end = next->end;
1562 			vm_map_entry_resize_free(map, entry);
1563 
1564 			/*
1565 			 * See comment above.
1566 			 */
1567 			if (next->object.vm_object)
1568 				vm_object_deallocate(next->object.vm_object);
1569 			if (next->cred != NULL)
1570 				crfree(next->cred);
1571 			vm_map_entry_dispose(map, next);
1572 		}
1573 	}
1574 }
1575 /*
1576  *	vm_map_clip_start:	[ internal use only ]
1577  *
1578  *	Asserts that the given entry begins at or after
1579  *	the specified address; if necessary,
1580  *	it splits the entry into two.
1581  */
1582 #define vm_map_clip_start(map, entry, startaddr) \
1583 { \
1584 	if (startaddr > entry->start) \
1585 		_vm_map_clip_start(map, entry, startaddr); \
1586 }
1587 
1588 /*
1589  *	This routine is called only when it is known that
1590  *	the entry must be split.
1591  */
1592 static void
1593 _vm_map_clip_start(vm_map_t map, vm_map_entry_t entry, vm_offset_t start)
1594 {
1595 	vm_map_entry_t new_entry;
1596 
1597 	VM_MAP_ASSERT_LOCKED(map);
1598 
1599 	/*
1600 	 * Split off the front portion -- note that we must insert the new
1601 	 * entry BEFORE this one, so that this entry has the specified
1602 	 * starting address.
1603 	 */
1604 	vm_map_simplify_entry(map, entry);
1605 
1606 	/*
1607 	 * If there is no object backing this entry, we might as well create
1608 	 * one now.  If we defer it, an object can get created after the map
1609 	 * is clipped, and individual objects will be created for the split-up
1610 	 * map.  This is a bit of a hack, but is also about the best place to
1611 	 * put this improvement.
1612 	 */
1613 	if (entry->object.vm_object == NULL && !map->system_map) {
1614 		vm_object_t object;
1615 		object = vm_object_allocate(OBJT_DEFAULT,
1616 				atop(entry->end - entry->start));
1617 		entry->object.vm_object = object;
1618 		entry->offset = 0;
1619 		if (entry->cred != NULL) {
1620 			object->cred = entry->cred;
1621 			object->charge = entry->end - entry->start;
1622 			entry->cred = NULL;
1623 		}
1624 	} else if (entry->object.vm_object != NULL &&
1625 		   ((entry->eflags & MAP_ENTRY_NEEDS_COPY) == 0) &&
1626 		   entry->cred != NULL) {
1627 		VM_OBJECT_WLOCK(entry->object.vm_object);
1628 		KASSERT(entry->object.vm_object->cred == NULL,
1629 		    ("OVERCOMMIT: vm_entry_clip_start: both cred e %p", entry));
1630 		entry->object.vm_object->cred = entry->cred;
1631 		entry->object.vm_object->charge = entry->end - entry->start;
1632 		VM_OBJECT_WUNLOCK(entry->object.vm_object);
1633 		entry->cred = NULL;
1634 	}
1635 
1636 	new_entry = vm_map_entry_create(map);
1637 	*new_entry = *entry;
1638 
1639 	new_entry->end = start;
1640 	entry->offset += (start - entry->start);
1641 	entry->start = start;
1642 	if (new_entry->cred != NULL)
1643 		crhold(entry->cred);
1644 
1645 	vm_map_entry_link(map, entry->prev, new_entry);
1646 
1647 	if ((entry->eflags & MAP_ENTRY_IS_SUB_MAP) == 0) {
1648 		vm_object_reference(new_entry->object.vm_object);
1649 		/*
1650 		 * The object->un_pager.vnp.writemappings for the
1651 		 * object of MAP_ENTRY_VN_WRITECNT type entry shall be
1652 		 * kept as is here.  The virtual pages are
1653 		 * re-distributed among the clipped entries, so the sum is
1654 		 * left the same.
1655 		 */
1656 	}
1657 }
1658 
1659 /*
1660  *	vm_map_clip_end:	[ internal use only ]
1661  *
1662  *	Asserts that the given entry ends at or before
1663  *	the specified address; if necessary,
1664  *	it splits the entry into two.
1665  */
1666 #define vm_map_clip_end(map, entry, endaddr) \
1667 { \
1668 	if ((endaddr) < (entry->end)) \
1669 		_vm_map_clip_end((map), (entry), (endaddr)); \
1670 }
1671 
1672 /*
1673  *	This routine is called only when it is known that
1674  *	the entry must be split.
1675  */
1676 static void
1677 _vm_map_clip_end(vm_map_t map, vm_map_entry_t entry, vm_offset_t end)
1678 {
1679 	vm_map_entry_t new_entry;
1680 
1681 	VM_MAP_ASSERT_LOCKED(map);
1682 
1683 	/*
1684 	 * If there is no object backing this entry, we might as well create
1685 	 * one now.  If we defer it, an object can get created after the map
1686 	 * is clipped, and individual objects will be created for the split-up
1687 	 * map.  This is a bit of a hack, but is also about the best place to
1688 	 * put this improvement.
1689 	 */
1690 	if (entry->object.vm_object == NULL && !map->system_map) {
1691 		vm_object_t object;
1692 		object = vm_object_allocate(OBJT_DEFAULT,
1693 				atop(entry->end - entry->start));
1694 		entry->object.vm_object = object;
1695 		entry->offset = 0;
1696 		if (entry->cred != NULL) {
1697 			object->cred = entry->cred;
1698 			object->charge = entry->end - entry->start;
1699 			entry->cred = NULL;
1700 		}
1701 	} else if (entry->object.vm_object != NULL &&
1702 		   ((entry->eflags & MAP_ENTRY_NEEDS_COPY) == 0) &&
1703 		   entry->cred != NULL) {
1704 		VM_OBJECT_WLOCK(entry->object.vm_object);
1705 		KASSERT(entry->object.vm_object->cred == NULL,
1706 		    ("OVERCOMMIT: vm_entry_clip_end: both cred e %p", entry));
1707 		entry->object.vm_object->cred = entry->cred;
1708 		entry->object.vm_object->charge = entry->end - entry->start;
1709 		VM_OBJECT_WUNLOCK(entry->object.vm_object);
1710 		entry->cred = NULL;
1711 	}
1712 
1713 	/*
1714 	 * Create a new entry and insert it AFTER the specified entry
1715 	 */
1716 	new_entry = vm_map_entry_create(map);
1717 	*new_entry = *entry;
1718 
1719 	new_entry->start = entry->end = end;
1720 	new_entry->offset += (end - entry->start);
1721 	if (new_entry->cred != NULL)
1722 		crhold(entry->cred);
1723 
1724 	vm_map_entry_link(map, entry, new_entry);
1725 
1726 	if ((entry->eflags & MAP_ENTRY_IS_SUB_MAP) == 0) {
1727 		vm_object_reference(new_entry->object.vm_object);
1728 	}
1729 }
1730 
1731 /*
1732  *	vm_map_submap:		[ kernel use only ]
1733  *
1734  *	Mark the given range as handled by a subordinate map.
1735  *
1736  *	This range must have been created with vm_map_find,
1737  *	and no other operations may have been performed on this
1738  *	range prior to calling vm_map_submap.
1739  *
1740  *	Only a limited number of operations can be performed
1741  *	within this rage after calling vm_map_submap:
1742  *		vm_fault
1743  *	[Don't try vm_map_copy!]
1744  *
1745  *	To remove a submapping, one must first remove the
1746  *	range from the superior map, and then destroy the
1747  *	submap (if desired).  [Better yet, don't try it.]
1748  */
1749 int
1750 vm_map_submap(
1751 	vm_map_t map,
1752 	vm_offset_t start,
1753 	vm_offset_t end,
1754 	vm_map_t submap)
1755 {
1756 	vm_map_entry_t entry;
1757 	int result = KERN_INVALID_ARGUMENT;
1758 
1759 	vm_map_lock(map);
1760 
1761 	VM_MAP_RANGE_CHECK(map, start, end);
1762 
1763 	if (vm_map_lookup_entry(map, start, &entry)) {
1764 		vm_map_clip_start(map, entry, start);
1765 	} else
1766 		entry = entry->next;
1767 
1768 	vm_map_clip_end(map, entry, end);
1769 
1770 	if ((entry->start == start) && (entry->end == end) &&
1771 	    ((entry->eflags & MAP_ENTRY_COW) == 0) &&
1772 	    (entry->object.vm_object == NULL)) {
1773 		entry->object.sub_map = submap;
1774 		entry->eflags |= MAP_ENTRY_IS_SUB_MAP;
1775 		result = KERN_SUCCESS;
1776 	}
1777 	vm_map_unlock(map);
1778 
1779 	return (result);
1780 }
1781 
1782 /*
1783  * The maximum number of pages to map
1784  */
1785 #define	MAX_INIT_PT	96
1786 
1787 /*
1788  *	vm_map_pmap_enter:
1789  *
1790  *	Preload read-only mappings for the specified object's resident pages
1791  *	into the target map.  If "flags" is MAP_PREFAULT_PARTIAL, then only
1792  *	the resident pages within the address range [addr, addr + ulmin(size,
1793  *	ptoa(MAX_INIT_PT))) are mapped.  Otherwise, all resident pages within
1794  *	the specified address range are mapped.  This eliminates many soft
1795  *	faults on process startup and immediately after an mmap(2).  Because
1796  *	these are speculative mappings, cached pages are not reactivated and
1797  *	mapped.
1798  */
1799 void
1800 vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot,
1801     vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags)
1802 {
1803 	vm_offset_t start;
1804 	vm_page_t p, p_start;
1805 	vm_pindex_t psize, tmpidx;
1806 
1807 	if ((prot & (VM_PROT_READ | VM_PROT_EXECUTE)) == 0 || object == NULL)
1808 		return;
1809 	VM_OBJECT_RLOCK(object);
1810 	if (object->type == OBJT_DEVICE || object->type == OBJT_SG) {
1811 		VM_OBJECT_RUNLOCK(object);
1812 		VM_OBJECT_WLOCK(object);
1813 		if (object->type == OBJT_DEVICE || object->type == OBJT_SG) {
1814 			pmap_object_init_pt(map->pmap, addr, object, pindex,
1815 			    size);
1816 			VM_OBJECT_WUNLOCK(object);
1817 			return;
1818 		}
1819 		VM_OBJECT_LOCK_DOWNGRADE(object);
1820 	}
1821 
1822 	psize = atop(size);
1823 	if (psize > MAX_INIT_PT && (flags & MAP_PREFAULT_PARTIAL) != 0)
1824 		psize = MAX_INIT_PT;
1825 	if (psize + pindex > object->size) {
1826 		if (object->size < pindex) {
1827 			VM_OBJECT_RUNLOCK(object);
1828 			return;
1829 		}
1830 		psize = object->size - pindex;
1831 	}
1832 
1833 	start = 0;
1834 	p_start = NULL;
1835 
1836 	p = vm_page_find_least(object, pindex);
1837 	/*
1838 	 * Assert: the variable p is either (1) the page with the
1839 	 * least pindex greater than or equal to the parameter pindex
1840 	 * or (2) NULL.
1841 	 */
1842 	for (;
1843 	     p != NULL && (tmpidx = p->pindex - pindex) < psize;
1844 	     p = TAILQ_NEXT(p, listq)) {
1845 		/*
1846 		 * don't allow an madvise to blow away our really
1847 		 * free pages allocating pv entries.
1848 		 */
1849 		if ((flags & MAP_PREFAULT_MADVISE) &&
1850 		    cnt.v_free_count < cnt.v_free_reserved) {
1851 			psize = tmpidx;
1852 			break;
1853 		}
1854 		if (p->valid == VM_PAGE_BITS_ALL) {
1855 			if (p_start == NULL) {
1856 				start = addr + ptoa(tmpidx);
1857 				p_start = p;
1858 			}
1859 		} else if (p_start != NULL) {
1860 			pmap_enter_object(map->pmap, start, addr +
1861 			    ptoa(tmpidx), p_start, prot);
1862 			p_start = NULL;
1863 		}
1864 	}
1865 	if (p_start != NULL)
1866 		pmap_enter_object(map->pmap, start, addr + ptoa(psize),
1867 		    p_start, prot);
1868 	VM_OBJECT_RUNLOCK(object);
1869 }
1870 
1871 /*
1872  *	vm_map_protect:
1873  *
1874  *	Sets the protection of the specified address
1875  *	region in the target map.  If "set_max" is
1876  *	specified, the maximum protection is to be set;
1877  *	otherwise, only the current protection is affected.
1878  */
1879 int
1880 vm_map_protect(vm_map_t map, vm_offset_t start, vm_offset_t end,
1881 	       vm_prot_t new_prot, boolean_t set_max)
1882 {
1883 	vm_map_entry_t current, entry;
1884 	vm_object_t obj;
1885 	struct ucred *cred;
1886 	vm_prot_t old_prot;
1887 
1888 	vm_map_lock(map);
1889 
1890 	VM_MAP_RANGE_CHECK(map, start, end);
1891 
1892 	if (vm_map_lookup_entry(map, start, &entry)) {
1893 		vm_map_clip_start(map, entry, start);
1894 	} else {
1895 		entry = entry->next;
1896 	}
1897 
1898 	/*
1899 	 * Make a first pass to check for protection violations.
1900 	 */
1901 	current = entry;
1902 	while ((current != &map->header) && (current->start < end)) {
1903 		if (current->eflags & MAP_ENTRY_IS_SUB_MAP) {
1904 			vm_map_unlock(map);
1905 			return (KERN_INVALID_ARGUMENT);
1906 		}
1907 		if ((new_prot & current->max_protection) != new_prot) {
1908 			vm_map_unlock(map);
1909 			return (KERN_PROTECTION_FAILURE);
1910 		}
1911 		current = current->next;
1912 	}
1913 
1914 
1915 	/*
1916 	 * Do an accounting pass for private read-only mappings that
1917 	 * now will do cow due to allowed write (e.g. debugger sets
1918 	 * breakpoint on text segment)
1919 	 */
1920 	for (current = entry; (current != &map->header) &&
1921 	     (current->start < end); current = current->next) {
1922 
1923 		vm_map_clip_end(map, current, end);
1924 
1925 		if (set_max ||
1926 		    ((new_prot & ~(current->protection)) & VM_PROT_WRITE) == 0 ||
1927 		    ENTRY_CHARGED(current)) {
1928 			continue;
1929 		}
1930 
1931 		cred = curthread->td_ucred;
1932 		obj = current->object.vm_object;
1933 
1934 		if (obj == NULL || (current->eflags & MAP_ENTRY_NEEDS_COPY)) {
1935 			if (!swap_reserve(current->end - current->start)) {
1936 				vm_map_unlock(map);
1937 				return (KERN_RESOURCE_SHORTAGE);
1938 			}
1939 			crhold(cred);
1940 			current->cred = cred;
1941 			continue;
1942 		}
1943 
1944 		VM_OBJECT_WLOCK(obj);
1945 		if (obj->type != OBJT_DEFAULT && obj->type != OBJT_SWAP) {
1946 			VM_OBJECT_WUNLOCK(obj);
1947 			continue;
1948 		}
1949 
1950 		/*
1951 		 * Charge for the whole object allocation now, since
1952 		 * we cannot distinguish between non-charged and
1953 		 * charged clipped mapping of the same object later.
1954 		 */
1955 		KASSERT(obj->charge == 0,
1956 		    ("vm_map_protect: object %p overcharged\n", obj));
1957 		if (!swap_reserve(ptoa(obj->size))) {
1958 			VM_OBJECT_WUNLOCK(obj);
1959 			vm_map_unlock(map);
1960 			return (KERN_RESOURCE_SHORTAGE);
1961 		}
1962 
1963 		crhold(cred);
1964 		obj->cred = cred;
1965 		obj->charge = ptoa(obj->size);
1966 		VM_OBJECT_WUNLOCK(obj);
1967 	}
1968 
1969 	/*
1970 	 * Go back and fix up protections. [Note that clipping is not
1971 	 * necessary the second time.]
1972 	 */
1973 	current = entry;
1974 	while ((current != &map->header) && (current->start < end)) {
1975 		old_prot = current->protection;
1976 
1977 		if (set_max)
1978 			current->protection =
1979 			    (current->max_protection = new_prot) &
1980 			    old_prot;
1981 		else
1982 			current->protection = new_prot;
1983 
1984 		if ((current->eflags & (MAP_ENTRY_COW | MAP_ENTRY_USER_WIRED))
1985 		     == (MAP_ENTRY_COW | MAP_ENTRY_USER_WIRED) &&
1986 		    (current->protection & VM_PROT_WRITE) != 0 &&
1987 		    (old_prot & VM_PROT_WRITE) == 0) {
1988 			vm_fault_copy_entry(map, map, current, current, NULL);
1989 		}
1990 
1991 		/*
1992 		 * When restricting access, update the physical map.  Worry
1993 		 * about copy-on-write here.
1994 		 */
1995 		if ((old_prot & ~current->protection) != 0) {
1996 #define MASK(entry)	(((entry)->eflags & MAP_ENTRY_COW) ? ~VM_PROT_WRITE : \
1997 							VM_PROT_ALL)
1998 			pmap_protect(map->pmap, current->start,
1999 			    current->end,
2000 			    current->protection & MASK(current));
2001 #undef	MASK
2002 		}
2003 		vm_map_simplify_entry(map, current);
2004 		current = current->next;
2005 	}
2006 	vm_map_unlock(map);
2007 	return (KERN_SUCCESS);
2008 }
2009 
2010 /*
2011  *	vm_map_madvise:
2012  *
2013  *	This routine traverses a processes map handling the madvise
2014  *	system call.  Advisories are classified as either those effecting
2015  *	the vm_map_entry structure, or those effecting the underlying
2016  *	objects.
2017  */
2018 int
2019 vm_map_madvise(
2020 	vm_map_t map,
2021 	vm_offset_t start,
2022 	vm_offset_t end,
2023 	int behav)
2024 {
2025 	vm_map_entry_t current, entry;
2026 	int modify_map = 0;
2027 
2028 	/*
2029 	 * Some madvise calls directly modify the vm_map_entry, in which case
2030 	 * we need to use an exclusive lock on the map and we need to perform
2031 	 * various clipping operations.  Otherwise we only need a read-lock
2032 	 * on the map.
2033 	 */
2034 	switch(behav) {
2035 	case MADV_NORMAL:
2036 	case MADV_SEQUENTIAL:
2037 	case MADV_RANDOM:
2038 	case MADV_NOSYNC:
2039 	case MADV_AUTOSYNC:
2040 	case MADV_NOCORE:
2041 	case MADV_CORE:
2042 		modify_map = 1;
2043 		vm_map_lock(map);
2044 		break;
2045 	case MADV_WILLNEED:
2046 	case MADV_DONTNEED:
2047 	case MADV_FREE:
2048 		vm_map_lock_read(map);
2049 		break;
2050 	default:
2051 		return (KERN_INVALID_ARGUMENT);
2052 	}
2053 
2054 	/*
2055 	 * Locate starting entry and clip if necessary.
2056 	 */
2057 	VM_MAP_RANGE_CHECK(map, start, end);
2058 
2059 	if (vm_map_lookup_entry(map, start, &entry)) {
2060 		if (modify_map)
2061 			vm_map_clip_start(map, entry, start);
2062 	} else {
2063 		entry = entry->next;
2064 	}
2065 
2066 	if (modify_map) {
2067 		/*
2068 		 * madvise behaviors that are implemented in the vm_map_entry.
2069 		 *
2070 		 * We clip the vm_map_entry so that behavioral changes are
2071 		 * limited to the specified address range.
2072 		 */
2073 		for (current = entry;
2074 		     (current != &map->header) && (current->start < end);
2075 		     current = current->next
2076 		) {
2077 			if (current->eflags & MAP_ENTRY_IS_SUB_MAP)
2078 				continue;
2079 
2080 			vm_map_clip_end(map, current, end);
2081 
2082 			switch (behav) {
2083 			case MADV_NORMAL:
2084 				vm_map_entry_set_behavior(current, MAP_ENTRY_BEHAV_NORMAL);
2085 				break;
2086 			case MADV_SEQUENTIAL:
2087 				vm_map_entry_set_behavior(current, MAP_ENTRY_BEHAV_SEQUENTIAL);
2088 				break;
2089 			case MADV_RANDOM:
2090 				vm_map_entry_set_behavior(current, MAP_ENTRY_BEHAV_RANDOM);
2091 				break;
2092 			case MADV_NOSYNC:
2093 				current->eflags |= MAP_ENTRY_NOSYNC;
2094 				break;
2095 			case MADV_AUTOSYNC:
2096 				current->eflags &= ~MAP_ENTRY_NOSYNC;
2097 				break;
2098 			case MADV_NOCORE:
2099 				current->eflags |= MAP_ENTRY_NOCOREDUMP;
2100 				break;
2101 			case MADV_CORE:
2102 				current->eflags &= ~MAP_ENTRY_NOCOREDUMP;
2103 				break;
2104 			default:
2105 				break;
2106 			}
2107 			vm_map_simplify_entry(map, current);
2108 		}
2109 		vm_map_unlock(map);
2110 	} else {
2111 		vm_pindex_t pstart, pend;
2112 
2113 		/*
2114 		 * madvise behaviors that are implemented in the underlying
2115 		 * vm_object.
2116 		 *
2117 		 * Since we don't clip the vm_map_entry, we have to clip
2118 		 * the vm_object pindex and count.
2119 		 */
2120 		for (current = entry;
2121 		     (current != &map->header) && (current->start < end);
2122 		     current = current->next
2123 		) {
2124 			vm_offset_t useStart;
2125 
2126 			if (current->eflags & MAP_ENTRY_IS_SUB_MAP)
2127 				continue;
2128 
2129 			pstart = OFF_TO_IDX(current->offset);
2130 			pend = pstart + atop(current->end - current->start);
2131 			useStart = current->start;
2132 
2133 			if (current->start < start) {
2134 				pstart += atop(start - current->start);
2135 				useStart = start;
2136 			}
2137 			if (current->end > end)
2138 				pend -= atop(current->end - end);
2139 
2140 			if (pstart >= pend)
2141 				continue;
2142 
2143 			vm_object_madvise(current->object.vm_object, pstart,
2144 			    pend, behav);
2145 			if (behav == MADV_WILLNEED) {
2146 				vm_map_pmap_enter(map,
2147 				    useStart,
2148 				    current->protection,
2149 				    current->object.vm_object,
2150 				    pstart,
2151 				    ptoa(pend - pstart),
2152 				    MAP_PREFAULT_MADVISE
2153 				);
2154 			}
2155 		}
2156 		vm_map_unlock_read(map);
2157 	}
2158 	return (0);
2159 }
2160 
2161 
2162 /*
2163  *	vm_map_inherit:
2164  *
2165  *	Sets the inheritance of the specified address
2166  *	range in the target map.  Inheritance
2167  *	affects how the map will be shared with
2168  *	child maps at the time of vmspace_fork.
2169  */
2170 int
2171 vm_map_inherit(vm_map_t map, vm_offset_t start, vm_offset_t end,
2172 	       vm_inherit_t new_inheritance)
2173 {
2174 	vm_map_entry_t entry;
2175 	vm_map_entry_t temp_entry;
2176 
2177 	switch (new_inheritance) {
2178 	case VM_INHERIT_NONE:
2179 	case VM_INHERIT_COPY:
2180 	case VM_INHERIT_SHARE:
2181 		break;
2182 	default:
2183 		return (KERN_INVALID_ARGUMENT);
2184 	}
2185 	vm_map_lock(map);
2186 	VM_MAP_RANGE_CHECK(map, start, end);
2187 	if (vm_map_lookup_entry(map, start, &temp_entry)) {
2188 		entry = temp_entry;
2189 		vm_map_clip_start(map, entry, start);
2190 	} else
2191 		entry = temp_entry->next;
2192 	while ((entry != &map->header) && (entry->start < end)) {
2193 		vm_map_clip_end(map, entry, end);
2194 		entry->inheritance = new_inheritance;
2195 		vm_map_simplify_entry(map, entry);
2196 		entry = entry->next;
2197 	}
2198 	vm_map_unlock(map);
2199 	return (KERN_SUCCESS);
2200 }
2201 
2202 /*
2203  *	vm_map_unwire:
2204  *
2205  *	Implements both kernel and user unwiring.
2206  */
2207 int
2208 vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
2209     int flags)
2210 {
2211 	vm_map_entry_t entry, first_entry, tmp_entry;
2212 	vm_offset_t saved_start;
2213 	unsigned int last_timestamp;
2214 	int rv;
2215 	boolean_t need_wakeup, result, user_unwire;
2216 
2217 	user_unwire = (flags & VM_MAP_WIRE_USER) ? TRUE : FALSE;
2218 	vm_map_lock(map);
2219 	VM_MAP_RANGE_CHECK(map, start, end);
2220 	if (!vm_map_lookup_entry(map, start, &first_entry)) {
2221 		if (flags & VM_MAP_WIRE_HOLESOK)
2222 			first_entry = first_entry->next;
2223 		else {
2224 			vm_map_unlock(map);
2225 			return (KERN_INVALID_ADDRESS);
2226 		}
2227 	}
2228 	last_timestamp = map->timestamp;
2229 	entry = first_entry;
2230 	while (entry != &map->header && entry->start < end) {
2231 		if (entry->eflags & MAP_ENTRY_IN_TRANSITION) {
2232 			/*
2233 			 * We have not yet clipped the entry.
2234 			 */
2235 			saved_start = (start >= entry->start) ? start :
2236 			    entry->start;
2237 			entry->eflags |= MAP_ENTRY_NEEDS_WAKEUP;
2238 			if (vm_map_unlock_and_wait(map, 0)) {
2239 				/*
2240 				 * Allow interruption of user unwiring?
2241 				 */
2242 			}
2243 			vm_map_lock(map);
2244 			if (last_timestamp+1 != map->timestamp) {
2245 				/*
2246 				 * Look again for the entry because the map was
2247 				 * modified while it was unlocked.
2248 				 * Specifically, the entry may have been
2249 				 * clipped, merged, or deleted.
2250 				 */
2251 				if (!vm_map_lookup_entry(map, saved_start,
2252 				    &tmp_entry)) {
2253 					if (flags & VM_MAP_WIRE_HOLESOK)
2254 						tmp_entry = tmp_entry->next;
2255 					else {
2256 						if (saved_start == start) {
2257 							/*
2258 							 * First_entry has been deleted.
2259 							 */
2260 							vm_map_unlock(map);
2261 							return (KERN_INVALID_ADDRESS);
2262 						}
2263 						end = saved_start;
2264 						rv = KERN_INVALID_ADDRESS;
2265 						goto done;
2266 					}
2267 				}
2268 				if (entry == first_entry)
2269 					first_entry = tmp_entry;
2270 				else
2271 					first_entry = NULL;
2272 				entry = tmp_entry;
2273 			}
2274 			last_timestamp = map->timestamp;
2275 			continue;
2276 		}
2277 		vm_map_clip_start(map, entry, start);
2278 		vm_map_clip_end(map, entry, end);
2279 		/*
2280 		 * Mark the entry in case the map lock is released.  (See
2281 		 * above.)
2282 		 */
2283 		entry->eflags |= MAP_ENTRY_IN_TRANSITION;
2284 		entry->wiring_thread = curthread;
2285 		/*
2286 		 * Check the map for holes in the specified region.
2287 		 * If VM_MAP_WIRE_HOLESOK was specified, skip this check.
2288 		 */
2289 		if (((flags & VM_MAP_WIRE_HOLESOK) == 0) &&
2290 		    (entry->end < end && (entry->next == &map->header ||
2291 		    entry->next->start > entry->end))) {
2292 			end = entry->end;
2293 			rv = KERN_INVALID_ADDRESS;
2294 			goto done;
2295 		}
2296 		/*
2297 		 * If system unwiring, require that the entry is system wired.
2298 		 */
2299 		if (!user_unwire &&
2300 		    vm_map_entry_system_wired_count(entry) == 0) {
2301 			end = entry->end;
2302 			rv = KERN_INVALID_ARGUMENT;
2303 			goto done;
2304 		}
2305 		entry = entry->next;
2306 	}
2307 	rv = KERN_SUCCESS;
2308 done:
2309 	need_wakeup = FALSE;
2310 	if (first_entry == NULL) {
2311 		result = vm_map_lookup_entry(map, start, &first_entry);
2312 		if (!result && (flags & VM_MAP_WIRE_HOLESOK))
2313 			first_entry = first_entry->next;
2314 		else
2315 			KASSERT(result, ("vm_map_unwire: lookup failed"));
2316 	}
2317 	for (entry = first_entry; entry != &map->header && entry->start < end;
2318 	    entry = entry->next) {
2319 		/*
2320 		 * If VM_MAP_WIRE_HOLESOK was specified, an empty
2321 		 * space in the unwired region could have been mapped
2322 		 * while the map lock was dropped for draining
2323 		 * MAP_ENTRY_IN_TRANSITION.  Moreover, another thread
2324 		 * could be simultaneously wiring this new mapping
2325 		 * entry.  Detect these cases and skip any entries
2326 		 * marked as in transition by us.
2327 		 */
2328 		if ((entry->eflags & MAP_ENTRY_IN_TRANSITION) == 0 ||
2329 		    entry->wiring_thread != curthread) {
2330 			KASSERT((flags & VM_MAP_WIRE_HOLESOK) != 0,
2331 			    ("vm_map_unwire: !HOLESOK and new/changed entry"));
2332 			continue;
2333 		}
2334 
2335 		if (rv == KERN_SUCCESS && (!user_unwire ||
2336 		    (entry->eflags & MAP_ENTRY_USER_WIRED))) {
2337 			if (user_unwire)
2338 				entry->eflags &= ~MAP_ENTRY_USER_WIRED;
2339 			entry->wired_count--;
2340 			if (entry->wired_count == 0) {
2341 				/*
2342 				 * Retain the map lock.
2343 				 */
2344 				vm_fault_unwire(map, entry->start, entry->end,
2345 				    entry->object.vm_object != NULL &&
2346 				    (entry->object.vm_object->flags &
2347 				    OBJ_FICTITIOUS) != 0);
2348 			}
2349 		}
2350 		KASSERT((entry->eflags & MAP_ENTRY_IN_TRANSITION) != 0,
2351 		    ("vm_map_unwire: in-transition flag missing"));
2352 		entry->eflags &= ~MAP_ENTRY_IN_TRANSITION;
2353 		entry->wiring_thread = NULL;
2354 		if (entry->eflags & MAP_ENTRY_NEEDS_WAKEUP) {
2355 			entry->eflags &= ~MAP_ENTRY_NEEDS_WAKEUP;
2356 			need_wakeup = TRUE;
2357 		}
2358 		vm_map_simplify_entry(map, entry);
2359 	}
2360 	vm_map_unlock(map);
2361 	if (need_wakeup)
2362 		vm_map_wakeup(map);
2363 	return (rv);
2364 }
2365 
2366 /*
2367  *	vm_map_wire:
2368  *
2369  *	Implements both kernel and user wiring.
2370  */
2371 int
2372 vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end,
2373     int flags)
2374 {
2375 	vm_map_entry_t entry, first_entry, tmp_entry;
2376 	vm_offset_t saved_end, saved_start;
2377 	unsigned int last_timestamp;
2378 	int rv;
2379 	boolean_t fictitious, need_wakeup, result, user_wire;
2380 	vm_prot_t prot;
2381 
2382 	prot = 0;
2383 	if (flags & VM_MAP_WIRE_WRITE)
2384 		prot |= VM_PROT_WRITE;
2385 	user_wire = (flags & VM_MAP_WIRE_USER) ? TRUE : FALSE;
2386 	vm_map_lock(map);
2387 	VM_MAP_RANGE_CHECK(map, start, end);
2388 	if (!vm_map_lookup_entry(map, start, &first_entry)) {
2389 		if (flags & VM_MAP_WIRE_HOLESOK)
2390 			first_entry = first_entry->next;
2391 		else {
2392 			vm_map_unlock(map);
2393 			return (KERN_INVALID_ADDRESS);
2394 		}
2395 	}
2396 	last_timestamp = map->timestamp;
2397 	entry = first_entry;
2398 	while (entry != &map->header && entry->start < end) {
2399 		if (entry->eflags & MAP_ENTRY_IN_TRANSITION) {
2400 			/*
2401 			 * We have not yet clipped the entry.
2402 			 */
2403 			saved_start = (start >= entry->start) ? start :
2404 			    entry->start;
2405 			entry->eflags |= MAP_ENTRY_NEEDS_WAKEUP;
2406 			if (vm_map_unlock_and_wait(map, 0)) {
2407 				/*
2408 				 * Allow interruption of user wiring?
2409 				 */
2410 			}
2411 			vm_map_lock(map);
2412 			if (last_timestamp + 1 != map->timestamp) {
2413 				/*
2414 				 * Look again for the entry because the map was
2415 				 * modified while it was unlocked.
2416 				 * Specifically, the entry may have been
2417 				 * clipped, merged, or deleted.
2418 				 */
2419 				if (!vm_map_lookup_entry(map, saved_start,
2420 				    &tmp_entry)) {
2421 					if (flags & VM_MAP_WIRE_HOLESOK)
2422 						tmp_entry = tmp_entry->next;
2423 					else {
2424 						if (saved_start == start) {
2425 							/*
2426 							 * first_entry has been deleted.
2427 							 */
2428 							vm_map_unlock(map);
2429 							return (KERN_INVALID_ADDRESS);
2430 						}
2431 						end = saved_start;
2432 						rv = KERN_INVALID_ADDRESS;
2433 						goto done;
2434 					}
2435 				}
2436 				if (entry == first_entry)
2437 					first_entry = tmp_entry;
2438 				else
2439 					first_entry = NULL;
2440 				entry = tmp_entry;
2441 			}
2442 			last_timestamp = map->timestamp;
2443 			continue;
2444 		}
2445 		vm_map_clip_start(map, entry, start);
2446 		vm_map_clip_end(map, entry, end);
2447 		/*
2448 		 * Mark the entry in case the map lock is released.  (See
2449 		 * above.)
2450 		 */
2451 		entry->eflags |= MAP_ENTRY_IN_TRANSITION;
2452 		entry->wiring_thread = curthread;
2453 		if ((entry->protection & (VM_PROT_READ | VM_PROT_EXECUTE)) == 0
2454 		    || (entry->protection & prot) != prot) {
2455 			entry->eflags |= MAP_ENTRY_WIRE_SKIPPED;
2456 			if ((flags & VM_MAP_WIRE_HOLESOK) == 0) {
2457 				end = entry->end;
2458 				rv = KERN_INVALID_ADDRESS;
2459 				goto done;
2460 			}
2461 			goto next_entry;
2462 		}
2463 		if (entry->wired_count == 0) {
2464 			entry->wired_count++;
2465 			saved_start = entry->start;
2466 			saved_end = entry->end;
2467 			fictitious = entry->object.vm_object != NULL &&
2468 			    (entry->object.vm_object->flags &
2469 			    OBJ_FICTITIOUS) != 0;
2470 			/*
2471 			 * Release the map lock, relying on the in-transition
2472 			 * mark.  Mark the map busy for fork.
2473 			 */
2474 			vm_map_busy(map);
2475 			vm_map_unlock(map);
2476 			rv = vm_fault_wire(map, saved_start, saved_end,
2477 			    fictitious);
2478 			vm_map_lock(map);
2479 			vm_map_unbusy(map);
2480 			if (last_timestamp + 1 != map->timestamp) {
2481 				/*
2482 				 * Look again for the entry because the map was
2483 				 * modified while it was unlocked.  The entry
2484 				 * may have been clipped, but NOT merged or
2485 				 * deleted.
2486 				 */
2487 				result = vm_map_lookup_entry(map, saved_start,
2488 				    &tmp_entry);
2489 				KASSERT(result, ("vm_map_wire: lookup failed"));
2490 				if (entry == first_entry)
2491 					first_entry = tmp_entry;
2492 				else
2493 					first_entry = NULL;
2494 				entry = tmp_entry;
2495 				while (entry->end < saved_end) {
2496 					if (rv != KERN_SUCCESS) {
2497 						KASSERT(entry->wired_count == 1,
2498 						    ("vm_map_wire: bad count"));
2499 						entry->wired_count = -1;
2500 					}
2501 					entry = entry->next;
2502 				}
2503 			}
2504 			last_timestamp = map->timestamp;
2505 			if (rv != KERN_SUCCESS) {
2506 				KASSERT(entry->wired_count == 1,
2507 				    ("vm_map_wire: bad count"));
2508 				/*
2509 				 * Assign an out-of-range value to represent
2510 				 * the failure to wire this entry.
2511 				 */
2512 				entry->wired_count = -1;
2513 				end = entry->end;
2514 				goto done;
2515 			}
2516 		} else if (!user_wire ||
2517 			   (entry->eflags & MAP_ENTRY_USER_WIRED) == 0) {
2518 			entry->wired_count++;
2519 		}
2520 		/*
2521 		 * Check the map for holes in the specified region.
2522 		 * If VM_MAP_WIRE_HOLESOK was specified, skip this check.
2523 		 */
2524 	next_entry:
2525 		if (((flags & VM_MAP_WIRE_HOLESOK) == 0) &&
2526 		    (entry->end < end && (entry->next == &map->header ||
2527 		    entry->next->start > entry->end))) {
2528 			end = entry->end;
2529 			rv = KERN_INVALID_ADDRESS;
2530 			goto done;
2531 		}
2532 		entry = entry->next;
2533 	}
2534 	rv = KERN_SUCCESS;
2535 done:
2536 	need_wakeup = FALSE;
2537 	if (first_entry == NULL) {
2538 		result = vm_map_lookup_entry(map, start, &first_entry);
2539 		if (!result && (flags & VM_MAP_WIRE_HOLESOK))
2540 			first_entry = first_entry->next;
2541 		else
2542 			KASSERT(result, ("vm_map_wire: lookup failed"));
2543 	}
2544 	for (entry = first_entry; entry != &map->header && entry->start < end;
2545 	    entry = entry->next) {
2546 		if ((entry->eflags & MAP_ENTRY_WIRE_SKIPPED) != 0)
2547 			goto next_entry_done;
2548 
2549 		/*
2550 		 * If VM_MAP_WIRE_HOLESOK was specified, an empty
2551 		 * space in the unwired region could have been mapped
2552 		 * while the map lock was dropped for faulting in the
2553 		 * pages or draining MAP_ENTRY_IN_TRANSITION.
2554 		 * Moreover, another thread could be simultaneously
2555 		 * wiring this new mapping entry.  Detect these cases
2556 		 * and skip any entries marked as in transition by us.
2557 		 */
2558 		if ((entry->eflags & MAP_ENTRY_IN_TRANSITION) == 0 ||
2559 		    entry->wiring_thread != curthread) {
2560 			KASSERT((flags & VM_MAP_WIRE_HOLESOK) != 0,
2561 			    ("vm_map_wire: !HOLESOK and new/changed entry"));
2562 			continue;
2563 		}
2564 
2565 		if (rv == KERN_SUCCESS) {
2566 			if (user_wire)
2567 				entry->eflags |= MAP_ENTRY_USER_WIRED;
2568 		} else if (entry->wired_count == -1) {
2569 			/*
2570 			 * Wiring failed on this entry.  Thus, unwiring is
2571 			 * unnecessary.
2572 			 */
2573 			entry->wired_count = 0;
2574 		} else {
2575 			if (!user_wire ||
2576 			    (entry->eflags & MAP_ENTRY_USER_WIRED) == 0)
2577 				entry->wired_count--;
2578 			if (entry->wired_count == 0) {
2579 				/*
2580 				 * Retain the map lock.
2581 				 */
2582 				vm_fault_unwire(map, entry->start, entry->end,
2583 				    entry->object.vm_object != NULL &&
2584 				    (entry->object.vm_object->flags &
2585 				    OBJ_FICTITIOUS) != 0);
2586 			}
2587 		}
2588 	next_entry_done:
2589 		KASSERT((entry->eflags & MAP_ENTRY_IN_TRANSITION) != 0,
2590 		    ("vm_map_wire: in-transition flag missing %p", entry));
2591 		KASSERT(entry->wiring_thread == curthread,
2592 		    ("vm_map_wire: alien wire %p", entry));
2593 		entry->eflags &= ~(MAP_ENTRY_IN_TRANSITION |
2594 		    MAP_ENTRY_WIRE_SKIPPED);
2595 		entry->wiring_thread = NULL;
2596 		if (entry->eflags & MAP_ENTRY_NEEDS_WAKEUP) {
2597 			entry->eflags &= ~MAP_ENTRY_NEEDS_WAKEUP;
2598 			need_wakeup = TRUE;
2599 		}
2600 		vm_map_simplify_entry(map, entry);
2601 	}
2602 	vm_map_unlock(map);
2603 	if (need_wakeup)
2604 		vm_map_wakeup(map);
2605 	return (rv);
2606 }
2607 
2608 /*
2609  * vm_map_sync
2610  *
2611  * Push any dirty cached pages in the address range to their pager.
2612  * If syncio is TRUE, dirty pages are written synchronously.
2613  * If invalidate is TRUE, any cached pages are freed as well.
2614  *
2615  * If the size of the region from start to end is zero, we are
2616  * supposed to flush all modified pages within the region containing
2617  * start.  Unfortunately, a region can be split or coalesced with
2618  * neighboring regions, making it difficult to determine what the
2619  * original region was.  Therefore, we approximate this requirement by
2620  * flushing the current region containing start.
2621  *
2622  * Returns an error if any part of the specified range is not mapped.
2623  */
2624 int
2625 vm_map_sync(
2626 	vm_map_t map,
2627 	vm_offset_t start,
2628 	vm_offset_t end,
2629 	boolean_t syncio,
2630 	boolean_t invalidate)
2631 {
2632 	vm_map_entry_t current;
2633 	vm_map_entry_t entry;
2634 	vm_size_t size;
2635 	vm_object_t object;
2636 	vm_ooffset_t offset;
2637 	unsigned int last_timestamp;
2638 	boolean_t failed;
2639 
2640 	vm_map_lock_read(map);
2641 	VM_MAP_RANGE_CHECK(map, start, end);
2642 	if (!vm_map_lookup_entry(map, start, &entry)) {
2643 		vm_map_unlock_read(map);
2644 		return (KERN_INVALID_ADDRESS);
2645 	} else if (start == end) {
2646 		start = entry->start;
2647 		end = entry->end;
2648 	}
2649 	/*
2650 	 * Make a first pass to check for user-wired memory and holes.
2651 	 */
2652 	for (current = entry; current != &map->header && current->start < end;
2653 	    current = current->next) {
2654 		if (invalidate && (current->eflags & MAP_ENTRY_USER_WIRED)) {
2655 			vm_map_unlock_read(map);
2656 			return (KERN_INVALID_ARGUMENT);
2657 		}
2658 		if (end > current->end &&
2659 		    (current->next == &map->header ||
2660 			current->end != current->next->start)) {
2661 			vm_map_unlock_read(map);
2662 			return (KERN_INVALID_ADDRESS);
2663 		}
2664 	}
2665 
2666 	if (invalidate)
2667 		pmap_remove(map->pmap, start, end);
2668 	failed = FALSE;
2669 
2670 	/*
2671 	 * Make a second pass, cleaning/uncaching pages from the indicated
2672 	 * objects as we go.
2673 	 */
2674 	for (current = entry; current != &map->header && current->start < end;) {
2675 		offset = current->offset + (start - current->start);
2676 		size = (end <= current->end ? end : current->end) - start;
2677 		if (current->eflags & MAP_ENTRY_IS_SUB_MAP) {
2678 			vm_map_t smap;
2679 			vm_map_entry_t tentry;
2680 			vm_size_t tsize;
2681 
2682 			smap = current->object.sub_map;
2683 			vm_map_lock_read(smap);
2684 			(void) vm_map_lookup_entry(smap, offset, &tentry);
2685 			tsize = tentry->end - offset;
2686 			if (tsize < size)
2687 				size = tsize;
2688 			object = tentry->object.vm_object;
2689 			offset = tentry->offset + (offset - tentry->start);
2690 			vm_map_unlock_read(smap);
2691 		} else {
2692 			object = current->object.vm_object;
2693 		}
2694 		vm_object_reference(object);
2695 		last_timestamp = map->timestamp;
2696 		vm_map_unlock_read(map);
2697 		if (!vm_object_sync(object, offset, size, syncio, invalidate))
2698 			failed = TRUE;
2699 		start += size;
2700 		vm_object_deallocate(object);
2701 		vm_map_lock_read(map);
2702 		if (last_timestamp == map->timestamp ||
2703 		    !vm_map_lookup_entry(map, start, &current))
2704 			current = current->next;
2705 	}
2706 
2707 	vm_map_unlock_read(map);
2708 	return (failed ? KERN_FAILURE : KERN_SUCCESS);
2709 }
2710 
2711 /*
2712  *	vm_map_entry_unwire:	[ internal use only ]
2713  *
2714  *	Make the region specified by this entry pageable.
2715  *
2716  *	The map in question should be locked.
2717  *	[This is the reason for this routine's existence.]
2718  */
2719 static void
2720 vm_map_entry_unwire(vm_map_t map, vm_map_entry_t entry)
2721 {
2722 	vm_fault_unwire(map, entry->start, entry->end,
2723 	    entry->object.vm_object != NULL &&
2724 	    (entry->object.vm_object->flags & OBJ_FICTITIOUS) != 0);
2725 	entry->wired_count = 0;
2726 }
2727 
2728 static void
2729 vm_map_entry_deallocate(vm_map_entry_t entry, boolean_t system_map)
2730 {
2731 
2732 	if ((entry->eflags & MAP_ENTRY_IS_SUB_MAP) == 0)
2733 		vm_object_deallocate(entry->object.vm_object);
2734 	uma_zfree(system_map ? kmapentzone : mapentzone, entry);
2735 }
2736 
2737 /*
2738  *	vm_map_entry_delete:	[ internal use only ]
2739  *
2740  *	Deallocate the given entry from the target map.
2741  */
2742 static void
2743 vm_map_entry_delete(vm_map_t map, vm_map_entry_t entry)
2744 {
2745 	vm_object_t object;
2746 	vm_pindex_t offidxstart, offidxend, count, size1;
2747 	vm_ooffset_t size;
2748 
2749 	vm_map_entry_unlink(map, entry);
2750 	object = entry->object.vm_object;
2751 	size = entry->end - entry->start;
2752 	map->size -= size;
2753 
2754 	if (entry->cred != NULL) {
2755 		swap_release_by_cred(size, entry->cred);
2756 		crfree(entry->cred);
2757 	}
2758 
2759 	if ((entry->eflags & MAP_ENTRY_IS_SUB_MAP) == 0 &&
2760 	    (object != NULL)) {
2761 		KASSERT(entry->cred == NULL || object->cred == NULL ||
2762 		    (entry->eflags & MAP_ENTRY_NEEDS_COPY),
2763 		    ("OVERCOMMIT vm_map_entry_delete: both cred %p", entry));
2764 		count = OFF_TO_IDX(size);
2765 		offidxstart = OFF_TO_IDX(entry->offset);
2766 		offidxend = offidxstart + count;
2767 		VM_OBJECT_WLOCK(object);
2768 		if (object->ref_count != 1 &&
2769 		    ((object->flags & (OBJ_NOSPLIT|OBJ_ONEMAPPING)) == OBJ_ONEMAPPING ||
2770 		    object == kernel_object || object == kmem_object)) {
2771 			vm_object_collapse(object);
2772 
2773 			/*
2774 			 * The option OBJPR_NOTMAPPED can be passed here
2775 			 * because vm_map_delete() already performed
2776 			 * pmap_remove() on the only mapping to this range
2777 			 * of pages.
2778 			 */
2779 			vm_object_page_remove(object, offidxstart, offidxend,
2780 			    OBJPR_NOTMAPPED);
2781 			if (object->type == OBJT_SWAP)
2782 				swap_pager_freespace(object, offidxstart, count);
2783 			if (offidxend >= object->size &&
2784 			    offidxstart < object->size) {
2785 				size1 = object->size;
2786 				object->size = offidxstart;
2787 				if (object->cred != NULL) {
2788 					size1 -= object->size;
2789 					KASSERT(object->charge >= ptoa(size1),
2790 					    ("vm_map_entry_delete: object->charge < 0"));
2791 					swap_release_by_cred(ptoa(size1), object->cred);
2792 					object->charge -= ptoa(size1);
2793 				}
2794 			}
2795 		}
2796 		VM_OBJECT_WUNLOCK(object);
2797 	} else
2798 		entry->object.vm_object = NULL;
2799 	if (map->system_map)
2800 		vm_map_entry_deallocate(entry, TRUE);
2801 	else {
2802 		entry->next = curthread->td_map_def_user;
2803 		curthread->td_map_def_user = entry;
2804 	}
2805 }
2806 
2807 /*
2808  *	vm_map_delete:	[ internal use only ]
2809  *
2810  *	Deallocates the given address range from the target
2811  *	map.
2812  */
2813 int
2814 vm_map_delete(vm_map_t map, vm_offset_t start, vm_offset_t end)
2815 {
2816 	vm_map_entry_t entry;
2817 	vm_map_entry_t first_entry;
2818 
2819 	VM_MAP_ASSERT_LOCKED(map);
2820 
2821 	/*
2822 	 * Find the start of the region, and clip it
2823 	 */
2824 	if (!vm_map_lookup_entry(map, start, &first_entry))
2825 		entry = first_entry->next;
2826 	else {
2827 		entry = first_entry;
2828 		vm_map_clip_start(map, entry, start);
2829 	}
2830 
2831 	/*
2832 	 * Step through all entries in this region
2833 	 */
2834 	while ((entry != &map->header) && (entry->start < end)) {
2835 		vm_map_entry_t next;
2836 
2837 		/*
2838 		 * Wait for wiring or unwiring of an entry to complete.
2839 		 * Also wait for any system wirings to disappear on
2840 		 * user maps.
2841 		 */
2842 		if ((entry->eflags & MAP_ENTRY_IN_TRANSITION) != 0 ||
2843 		    (vm_map_pmap(map) != kernel_pmap &&
2844 		    vm_map_entry_system_wired_count(entry) != 0)) {
2845 			unsigned int last_timestamp;
2846 			vm_offset_t saved_start;
2847 			vm_map_entry_t tmp_entry;
2848 
2849 			saved_start = entry->start;
2850 			entry->eflags |= MAP_ENTRY_NEEDS_WAKEUP;
2851 			last_timestamp = map->timestamp;
2852 			(void) vm_map_unlock_and_wait(map, 0);
2853 			vm_map_lock(map);
2854 			if (last_timestamp + 1 != map->timestamp) {
2855 				/*
2856 				 * Look again for the entry because the map was
2857 				 * modified while it was unlocked.
2858 				 * Specifically, the entry may have been
2859 				 * clipped, merged, or deleted.
2860 				 */
2861 				if (!vm_map_lookup_entry(map, saved_start,
2862 							 &tmp_entry))
2863 					entry = tmp_entry->next;
2864 				else {
2865 					entry = tmp_entry;
2866 					vm_map_clip_start(map, entry,
2867 							  saved_start);
2868 				}
2869 			}
2870 			continue;
2871 		}
2872 		vm_map_clip_end(map, entry, end);
2873 
2874 		next = entry->next;
2875 
2876 		/*
2877 		 * Unwire before removing addresses from the pmap; otherwise,
2878 		 * unwiring will put the entries back in the pmap.
2879 		 */
2880 		if (entry->wired_count != 0) {
2881 			vm_map_entry_unwire(map, entry);
2882 		}
2883 
2884 		pmap_remove(map->pmap, entry->start, entry->end);
2885 
2886 		/*
2887 		 * Delete the entry only after removing all pmap
2888 		 * entries pointing to its pages.  (Otherwise, its
2889 		 * page frames may be reallocated, and any modify bits
2890 		 * will be set in the wrong object!)
2891 		 */
2892 		vm_map_entry_delete(map, entry);
2893 		entry = next;
2894 	}
2895 	return (KERN_SUCCESS);
2896 }
2897 
2898 /*
2899  *	vm_map_remove:
2900  *
2901  *	Remove the given address range from the target map.
2902  *	This is the exported form of vm_map_delete.
2903  */
2904 int
2905 vm_map_remove(vm_map_t map, vm_offset_t start, vm_offset_t end)
2906 {
2907 	int result;
2908 
2909 	vm_map_lock(map);
2910 	VM_MAP_RANGE_CHECK(map, start, end);
2911 	result = vm_map_delete(map, start, end);
2912 	vm_map_unlock(map);
2913 	return (result);
2914 }
2915 
2916 /*
2917  *	vm_map_check_protection:
2918  *
2919  *	Assert that the target map allows the specified privilege on the
2920  *	entire address region given.  The entire region must be allocated.
2921  *
2922  *	WARNING!  This code does not and should not check whether the
2923  *	contents of the region is accessible.  For example a smaller file
2924  *	might be mapped into a larger address space.
2925  *
2926  *	NOTE!  This code is also called by munmap().
2927  *
2928  *	The map must be locked.  A read lock is sufficient.
2929  */
2930 boolean_t
2931 vm_map_check_protection(vm_map_t map, vm_offset_t start, vm_offset_t end,
2932 			vm_prot_t protection)
2933 {
2934 	vm_map_entry_t entry;
2935 	vm_map_entry_t tmp_entry;
2936 
2937 	if (!vm_map_lookup_entry(map, start, &tmp_entry))
2938 		return (FALSE);
2939 	entry = tmp_entry;
2940 
2941 	while (start < end) {
2942 		if (entry == &map->header)
2943 			return (FALSE);
2944 		/*
2945 		 * No holes allowed!
2946 		 */
2947 		if (start < entry->start)
2948 			return (FALSE);
2949 		/*
2950 		 * Check protection associated with entry.
2951 		 */
2952 		if ((entry->protection & protection) != protection)
2953 			return (FALSE);
2954 		/* go to next entry */
2955 		start = entry->end;
2956 		entry = entry->next;
2957 	}
2958 	return (TRUE);
2959 }
2960 
2961 /*
2962  *	vm_map_copy_entry:
2963  *
2964  *	Copies the contents of the source entry to the destination
2965  *	entry.  The entries *must* be aligned properly.
2966  */
2967 static void
2968 vm_map_copy_entry(
2969 	vm_map_t src_map,
2970 	vm_map_t dst_map,
2971 	vm_map_entry_t src_entry,
2972 	vm_map_entry_t dst_entry,
2973 	vm_ooffset_t *fork_charge)
2974 {
2975 	vm_object_t src_object;
2976 	vm_map_entry_t fake_entry;
2977 	vm_offset_t size;
2978 	struct ucred *cred;
2979 	int charged;
2980 
2981 	VM_MAP_ASSERT_LOCKED(dst_map);
2982 
2983 	if ((dst_entry->eflags|src_entry->eflags) & MAP_ENTRY_IS_SUB_MAP)
2984 		return;
2985 
2986 	if (src_entry->wired_count == 0) {
2987 
2988 		/*
2989 		 * If the source entry is marked needs_copy, it is already
2990 		 * write-protected.
2991 		 */
2992 		if ((src_entry->eflags & MAP_ENTRY_NEEDS_COPY) == 0) {
2993 			pmap_protect(src_map->pmap,
2994 			    src_entry->start,
2995 			    src_entry->end,
2996 			    src_entry->protection & ~VM_PROT_WRITE);
2997 		}
2998 
2999 		/*
3000 		 * Make a copy of the object.
3001 		 */
3002 		size = src_entry->end - src_entry->start;
3003 		if ((src_object = src_entry->object.vm_object) != NULL) {
3004 			VM_OBJECT_WLOCK(src_object);
3005 			charged = ENTRY_CHARGED(src_entry);
3006 			if ((src_object->handle == NULL) &&
3007 				(src_object->type == OBJT_DEFAULT ||
3008 				 src_object->type == OBJT_SWAP)) {
3009 				vm_object_collapse(src_object);
3010 				if ((src_object->flags & (OBJ_NOSPLIT|OBJ_ONEMAPPING)) == OBJ_ONEMAPPING) {
3011 					vm_object_split(src_entry);
3012 					src_object = src_entry->object.vm_object;
3013 				}
3014 			}
3015 			vm_object_reference_locked(src_object);
3016 			vm_object_clear_flag(src_object, OBJ_ONEMAPPING);
3017 			if (src_entry->cred != NULL &&
3018 			    !(src_entry->eflags & MAP_ENTRY_NEEDS_COPY)) {
3019 				KASSERT(src_object->cred == NULL,
3020 				    ("OVERCOMMIT: vm_map_copy_entry: cred %p",
3021 				     src_object));
3022 				src_object->cred = src_entry->cred;
3023 				src_object->charge = size;
3024 			}
3025 			VM_OBJECT_WUNLOCK(src_object);
3026 			dst_entry->object.vm_object = src_object;
3027 			if (charged) {
3028 				cred = curthread->td_ucred;
3029 				crhold(cred);
3030 				dst_entry->cred = cred;
3031 				*fork_charge += size;
3032 				if (!(src_entry->eflags &
3033 				      MAP_ENTRY_NEEDS_COPY)) {
3034 					crhold(cred);
3035 					src_entry->cred = cred;
3036 					*fork_charge += size;
3037 				}
3038 			}
3039 			src_entry->eflags |= (MAP_ENTRY_COW|MAP_ENTRY_NEEDS_COPY);
3040 			dst_entry->eflags |= (MAP_ENTRY_COW|MAP_ENTRY_NEEDS_COPY);
3041 			dst_entry->offset = src_entry->offset;
3042 			if (src_entry->eflags & MAP_ENTRY_VN_WRITECNT) {
3043 				/*
3044 				 * MAP_ENTRY_VN_WRITECNT cannot
3045 				 * indicate write reference from
3046 				 * src_entry, since the entry is
3047 				 * marked as needs copy.  Allocate a
3048 				 * fake entry that is used to
3049 				 * decrement object->un_pager.vnp.writecount
3050 				 * at the appropriate time.  Attach
3051 				 * fake_entry to the deferred list.
3052 				 */
3053 				fake_entry = vm_map_entry_create(dst_map);
3054 				fake_entry->eflags = MAP_ENTRY_VN_WRITECNT;
3055 				src_entry->eflags &= ~MAP_ENTRY_VN_WRITECNT;
3056 				vm_object_reference(src_object);
3057 				fake_entry->object.vm_object = src_object;
3058 				fake_entry->start = src_entry->start;
3059 				fake_entry->end = src_entry->end;
3060 				fake_entry->next = curthread->td_map_def_user;
3061 				curthread->td_map_def_user = fake_entry;
3062 			}
3063 		} else {
3064 			dst_entry->object.vm_object = NULL;
3065 			dst_entry->offset = 0;
3066 			if (src_entry->cred != NULL) {
3067 				dst_entry->cred = curthread->td_ucred;
3068 				crhold(dst_entry->cred);
3069 				*fork_charge += size;
3070 			}
3071 		}
3072 
3073 		pmap_copy(dst_map->pmap, src_map->pmap, dst_entry->start,
3074 		    dst_entry->end - dst_entry->start, src_entry->start);
3075 	} else {
3076 		/*
3077 		 * Of course, wired down pages can't be set copy-on-write.
3078 		 * Cause wired pages to be copied into the new map by
3079 		 * simulating faults (the new pages are pageable)
3080 		 */
3081 		vm_fault_copy_entry(dst_map, src_map, dst_entry, src_entry,
3082 		    fork_charge);
3083 	}
3084 }
3085 
3086 /*
3087  * vmspace_map_entry_forked:
3088  * Update the newly-forked vmspace each time a map entry is inherited
3089  * or copied.  The values for vm_dsize and vm_tsize are approximate
3090  * (and mostly-obsolete ideas in the face of mmap(2) et al.)
3091  */
3092 static void
3093 vmspace_map_entry_forked(const struct vmspace *vm1, struct vmspace *vm2,
3094     vm_map_entry_t entry)
3095 {
3096 	vm_size_t entrysize;
3097 	vm_offset_t newend;
3098 
3099 	entrysize = entry->end - entry->start;
3100 	vm2->vm_map.size += entrysize;
3101 	if (entry->eflags & (MAP_ENTRY_GROWS_DOWN | MAP_ENTRY_GROWS_UP)) {
3102 		vm2->vm_ssize += btoc(entrysize);
3103 	} else if (entry->start >= (vm_offset_t)vm1->vm_daddr &&
3104 	    entry->start < (vm_offset_t)vm1->vm_daddr + ctob(vm1->vm_dsize)) {
3105 		newend = MIN(entry->end,
3106 		    (vm_offset_t)vm1->vm_daddr + ctob(vm1->vm_dsize));
3107 		vm2->vm_dsize += btoc(newend - entry->start);
3108 	} else if (entry->start >= (vm_offset_t)vm1->vm_taddr &&
3109 	    entry->start < (vm_offset_t)vm1->vm_taddr + ctob(vm1->vm_tsize)) {
3110 		newend = MIN(entry->end,
3111 		    (vm_offset_t)vm1->vm_taddr + ctob(vm1->vm_tsize));
3112 		vm2->vm_tsize += btoc(newend - entry->start);
3113 	}
3114 }
3115 
3116 /*
3117  * vmspace_fork:
3118  * Create a new process vmspace structure and vm_map
3119  * based on those of an existing process.  The new map
3120  * is based on the old map, according to the inheritance
3121  * values on the regions in that map.
3122  *
3123  * XXX It might be worth coalescing the entries added to the new vmspace.
3124  *
3125  * The source map must not be locked.
3126  */
3127 struct vmspace *
3128 vmspace_fork(struct vmspace *vm1, vm_ooffset_t *fork_charge)
3129 {
3130 	struct vmspace *vm2;
3131 	vm_map_t new_map, old_map;
3132 	vm_map_entry_t new_entry, old_entry;
3133 	vm_object_t object;
3134 	int locked;
3135 
3136 	old_map = &vm1->vm_map;
3137 	/* Copy immutable fields of vm1 to vm2. */
3138 	vm2 = vmspace_alloc(old_map->min_offset, old_map->max_offset);
3139 	if (vm2 == NULL)
3140 		return (NULL);
3141 	vm2->vm_taddr = vm1->vm_taddr;
3142 	vm2->vm_daddr = vm1->vm_daddr;
3143 	vm2->vm_maxsaddr = vm1->vm_maxsaddr;
3144 	vm_map_lock(old_map);
3145 	if (old_map->busy)
3146 		vm_map_wait_busy(old_map);
3147 	new_map = &vm2->vm_map;
3148 	locked = vm_map_trylock(new_map); /* trylock to silence WITNESS */
3149 	KASSERT(locked, ("vmspace_fork: lock failed"));
3150 
3151 	old_entry = old_map->header.next;
3152 
3153 	while (old_entry != &old_map->header) {
3154 		if (old_entry->eflags & MAP_ENTRY_IS_SUB_MAP)
3155 			panic("vm_map_fork: encountered a submap");
3156 
3157 		switch (old_entry->inheritance) {
3158 		case VM_INHERIT_NONE:
3159 			break;
3160 
3161 		case VM_INHERIT_SHARE:
3162 			/*
3163 			 * Clone the entry, creating the shared object if necessary.
3164 			 */
3165 			object = old_entry->object.vm_object;
3166 			if (object == NULL) {
3167 				object = vm_object_allocate(OBJT_DEFAULT,
3168 					atop(old_entry->end - old_entry->start));
3169 				old_entry->object.vm_object = object;
3170 				old_entry->offset = 0;
3171 				if (old_entry->cred != NULL) {
3172 					object->cred = old_entry->cred;
3173 					object->charge = old_entry->end -
3174 					    old_entry->start;
3175 					old_entry->cred = NULL;
3176 				}
3177 			}
3178 
3179 			/*
3180 			 * Add the reference before calling vm_object_shadow
3181 			 * to insure that a shadow object is created.
3182 			 */
3183 			vm_object_reference(object);
3184 			if (old_entry->eflags & MAP_ENTRY_NEEDS_COPY) {
3185 				vm_object_shadow(&old_entry->object.vm_object,
3186 				    &old_entry->offset,
3187 				    old_entry->end - old_entry->start);
3188 				old_entry->eflags &= ~MAP_ENTRY_NEEDS_COPY;
3189 				/* Transfer the second reference too. */
3190 				vm_object_reference(
3191 				    old_entry->object.vm_object);
3192 
3193 				/*
3194 				 * As in vm_map_simplify_entry(), the
3195 				 * vnode lock will not be acquired in
3196 				 * this call to vm_object_deallocate().
3197 				 */
3198 				vm_object_deallocate(object);
3199 				object = old_entry->object.vm_object;
3200 			}
3201 			VM_OBJECT_WLOCK(object);
3202 			vm_object_clear_flag(object, OBJ_ONEMAPPING);
3203 			if (old_entry->cred != NULL) {
3204 				KASSERT(object->cred == NULL, ("vmspace_fork both cred"));
3205 				object->cred = old_entry->cred;
3206 				object->charge = old_entry->end - old_entry->start;
3207 				old_entry->cred = NULL;
3208 			}
3209 
3210 			/*
3211 			 * Assert the correct state of the vnode
3212 			 * v_writecount while the object is locked, to
3213 			 * not relock it later for the assertion
3214 			 * correctness.
3215 			 */
3216 			if (old_entry->eflags & MAP_ENTRY_VN_WRITECNT &&
3217 			    object->type == OBJT_VNODE) {
3218 				KASSERT(((struct vnode *)object->handle)->
3219 				    v_writecount > 0,
3220 				    ("vmspace_fork: v_writecount %p", object));
3221 				KASSERT(object->un_pager.vnp.writemappings > 0,
3222 				    ("vmspace_fork: vnp.writecount %p",
3223 				    object));
3224 			}
3225 			VM_OBJECT_WUNLOCK(object);
3226 
3227 			/*
3228 			 * Clone the entry, referencing the shared object.
3229 			 */
3230 			new_entry = vm_map_entry_create(new_map);
3231 			*new_entry = *old_entry;
3232 			new_entry->eflags &= ~(MAP_ENTRY_USER_WIRED |
3233 			    MAP_ENTRY_IN_TRANSITION);
3234 			new_entry->wiring_thread = NULL;
3235 			new_entry->wired_count = 0;
3236 			if (new_entry->eflags & MAP_ENTRY_VN_WRITECNT) {
3237 				vnode_pager_update_writecount(object,
3238 				    new_entry->start, new_entry->end);
3239 			}
3240 
3241 			/*
3242 			 * Insert the entry into the new map -- we know we're
3243 			 * inserting at the end of the new map.
3244 			 */
3245 			vm_map_entry_link(new_map, new_map->header.prev,
3246 			    new_entry);
3247 			vmspace_map_entry_forked(vm1, vm2, new_entry);
3248 
3249 			/*
3250 			 * Update the physical map
3251 			 */
3252 			pmap_copy(new_map->pmap, old_map->pmap,
3253 			    new_entry->start,
3254 			    (old_entry->end - old_entry->start),
3255 			    old_entry->start);
3256 			break;
3257 
3258 		case VM_INHERIT_COPY:
3259 			/*
3260 			 * Clone the entry and link into the map.
3261 			 */
3262 			new_entry = vm_map_entry_create(new_map);
3263 			*new_entry = *old_entry;
3264 			/*
3265 			 * Copied entry is COW over the old object.
3266 			 */
3267 			new_entry->eflags &= ~(MAP_ENTRY_USER_WIRED |
3268 			    MAP_ENTRY_IN_TRANSITION | MAP_ENTRY_VN_WRITECNT);
3269 			new_entry->wiring_thread = NULL;
3270 			new_entry->wired_count = 0;
3271 			new_entry->object.vm_object = NULL;
3272 			new_entry->cred = NULL;
3273 			vm_map_entry_link(new_map, new_map->header.prev,
3274 			    new_entry);
3275 			vmspace_map_entry_forked(vm1, vm2, new_entry);
3276 			vm_map_copy_entry(old_map, new_map, old_entry,
3277 			    new_entry, fork_charge);
3278 			break;
3279 		}
3280 		old_entry = old_entry->next;
3281 	}
3282 	/*
3283 	 * Use inlined vm_map_unlock() to postpone handling the deferred
3284 	 * map entries, which cannot be done until both old_map and
3285 	 * new_map locks are released.
3286 	 */
3287 	sx_xunlock(&old_map->lock);
3288 	sx_xunlock(&new_map->lock);
3289 	vm_map_process_deferred();
3290 
3291 	return (vm2);
3292 }
3293 
3294 int
3295 vm_map_stack(vm_map_t map, vm_offset_t addrbos, vm_size_t max_ssize,
3296     vm_prot_t prot, vm_prot_t max, int cow)
3297 {
3298 	vm_map_entry_t new_entry, prev_entry;
3299 	vm_offset_t bot, top;
3300 	vm_size_t growsize, init_ssize;
3301 	int orient, rv;
3302 	rlim_t lmemlim, vmemlim;
3303 
3304 	/*
3305 	 * The stack orientation is piggybacked with the cow argument.
3306 	 * Extract it into orient and mask the cow argument so that we
3307 	 * don't pass it around further.
3308 	 * NOTE: We explicitly allow bi-directional stacks.
3309 	 */
3310 	orient = cow & (MAP_STACK_GROWS_DOWN|MAP_STACK_GROWS_UP);
3311 	cow &= ~orient;
3312 	KASSERT(orient != 0, ("No stack grow direction"));
3313 
3314 	if (addrbos < vm_map_min(map) ||
3315 	    addrbos > vm_map_max(map) ||
3316 	    addrbos + max_ssize < addrbos)
3317 		return (KERN_NO_SPACE);
3318 
3319 	growsize = sgrowsiz;
3320 	init_ssize = (max_ssize < growsize) ? max_ssize : growsize;
3321 
3322 	PROC_LOCK(curproc);
3323 	lmemlim = lim_cur(curproc, RLIMIT_MEMLOCK);
3324 	vmemlim = lim_cur(curproc, RLIMIT_VMEM);
3325 	PROC_UNLOCK(curproc);
3326 
3327 	vm_map_lock(map);
3328 
3329 	/* If addr is already mapped, no go */
3330 	if (vm_map_lookup_entry(map, addrbos, &prev_entry)) {
3331 		vm_map_unlock(map);
3332 		return (KERN_NO_SPACE);
3333 	}
3334 
3335 	if (!old_mlock && map->flags & MAP_WIREFUTURE) {
3336 		if (ptoa(pmap_wired_count(map->pmap)) + init_ssize > lmemlim) {
3337 			vm_map_unlock(map);
3338 			return (KERN_NO_SPACE);
3339 		}
3340 	}
3341 
3342 	/* If we would blow our VMEM resource limit, no go */
3343 	if (map->size + init_ssize > vmemlim) {
3344 		vm_map_unlock(map);
3345 		return (KERN_NO_SPACE);
3346 	}
3347 
3348 	/*
3349 	 * If we can't accomodate max_ssize in the current mapping, no go.
3350 	 * However, we need to be aware that subsequent user mappings might
3351 	 * map into the space we have reserved for stack, and currently this
3352 	 * space is not protected.
3353 	 *
3354 	 * Hopefully we will at least detect this condition when we try to
3355 	 * grow the stack.
3356 	 */
3357 	if ((prev_entry->next != &map->header) &&
3358 	    (prev_entry->next->start < addrbos + max_ssize)) {
3359 		vm_map_unlock(map);
3360 		return (KERN_NO_SPACE);
3361 	}
3362 
3363 	/*
3364 	 * We initially map a stack of only init_ssize.  We will grow as
3365 	 * needed later.  Depending on the orientation of the stack (i.e.
3366 	 * the grow direction) we either map at the top of the range, the
3367 	 * bottom of the range or in the middle.
3368 	 *
3369 	 * Note: we would normally expect prot and max to be VM_PROT_ALL,
3370 	 * and cow to be 0.  Possibly we should eliminate these as input
3371 	 * parameters, and just pass these values here in the insert call.
3372 	 */
3373 	if (orient == MAP_STACK_GROWS_DOWN)
3374 		bot = addrbos + max_ssize - init_ssize;
3375 	else if (orient == MAP_STACK_GROWS_UP)
3376 		bot = addrbos;
3377 	else
3378 		bot = round_page(addrbos + max_ssize/2 - init_ssize/2);
3379 	top = bot + init_ssize;
3380 	rv = vm_map_insert(map, NULL, 0, bot, top, prot, max, cow);
3381 
3382 	/* Now set the avail_ssize amount. */
3383 	if (rv == KERN_SUCCESS) {
3384 		if (prev_entry != &map->header)
3385 			vm_map_clip_end(map, prev_entry, bot);
3386 		new_entry = prev_entry->next;
3387 		if (new_entry->end != top || new_entry->start != bot)
3388 			panic("Bad entry start/end for new stack entry");
3389 
3390 		new_entry->avail_ssize = max_ssize - init_ssize;
3391 		if (orient & MAP_STACK_GROWS_DOWN)
3392 			new_entry->eflags |= MAP_ENTRY_GROWS_DOWN;
3393 		if (orient & MAP_STACK_GROWS_UP)
3394 			new_entry->eflags |= MAP_ENTRY_GROWS_UP;
3395 	}
3396 
3397 	vm_map_unlock(map);
3398 	return (rv);
3399 }
3400 
3401 static int stack_guard_page = 0;
3402 TUNABLE_INT("security.bsd.stack_guard_page", &stack_guard_page);
3403 SYSCTL_INT(_security_bsd, OID_AUTO, stack_guard_page, CTLFLAG_RW,
3404     &stack_guard_page, 0,
3405     "Insert stack guard page ahead of the growable segments.");
3406 
3407 /* Attempts to grow a vm stack entry.  Returns KERN_SUCCESS if the
3408  * desired address is already mapped, or if we successfully grow
3409  * the stack.  Also returns KERN_SUCCESS if addr is outside the
3410  * stack range (this is strange, but preserves compatibility with
3411  * the grow function in vm_machdep.c).
3412  */
3413 int
3414 vm_map_growstack(struct proc *p, vm_offset_t addr)
3415 {
3416 	vm_map_entry_t next_entry, prev_entry;
3417 	vm_map_entry_t new_entry, stack_entry;
3418 	struct vmspace *vm = p->p_vmspace;
3419 	vm_map_t map = &vm->vm_map;
3420 	vm_offset_t end;
3421 	vm_size_t growsize;
3422 	size_t grow_amount, max_grow;
3423 	rlim_t lmemlim, stacklim, vmemlim;
3424 	int is_procstack, rv;
3425 	struct ucred *cred;
3426 #ifdef notyet
3427 	uint64_t limit;
3428 #endif
3429 #ifdef RACCT
3430 	int error;
3431 #endif
3432 
3433 Retry:
3434 	PROC_LOCK(p);
3435 	lmemlim = lim_cur(p, RLIMIT_MEMLOCK);
3436 	stacklim = lim_cur(p, RLIMIT_STACK);
3437 	vmemlim = lim_cur(p, RLIMIT_VMEM);
3438 	PROC_UNLOCK(p);
3439 
3440 	vm_map_lock_read(map);
3441 
3442 	/* If addr is already in the entry range, no need to grow.*/
3443 	if (vm_map_lookup_entry(map, addr, &prev_entry)) {
3444 		vm_map_unlock_read(map);
3445 		return (KERN_SUCCESS);
3446 	}
3447 
3448 	next_entry = prev_entry->next;
3449 	if (!(prev_entry->eflags & MAP_ENTRY_GROWS_UP)) {
3450 		/*
3451 		 * This entry does not grow upwards. Since the address lies
3452 		 * beyond this entry, the next entry (if one exists) has to
3453 		 * be a downward growable entry. The entry list header is
3454 		 * never a growable entry, so it suffices to check the flags.
3455 		 */
3456 		if (!(next_entry->eflags & MAP_ENTRY_GROWS_DOWN)) {
3457 			vm_map_unlock_read(map);
3458 			return (KERN_SUCCESS);
3459 		}
3460 		stack_entry = next_entry;
3461 	} else {
3462 		/*
3463 		 * This entry grows upward. If the next entry does not at
3464 		 * least grow downwards, this is the entry we need to grow.
3465 		 * otherwise we have two possible choices and we have to
3466 		 * select one.
3467 		 */
3468 		if (next_entry->eflags & MAP_ENTRY_GROWS_DOWN) {
3469 			/*
3470 			 * We have two choices; grow the entry closest to
3471 			 * the address to minimize the amount of growth.
3472 			 */
3473 			if (addr - prev_entry->end <= next_entry->start - addr)
3474 				stack_entry = prev_entry;
3475 			else
3476 				stack_entry = next_entry;
3477 		} else
3478 			stack_entry = prev_entry;
3479 	}
3480 
3481 	if (stack_entry == next_entry) {
3482 		KASSERT(stack_entry->eflags & MAP_ENTRY_GROWS_DOWN, ("foo"));
3483 		KASSERT(addr < stack_entry->start, ("foo"));
3484 		end = (prev_entry != &map->header) ? prev_entry->end :
3485 		    stack_entry->start - stack_entry->avail_ssize;
3486 		grow_amount = roundup(stack_entry->start - addr, PAGE_SIZE);
3487 		max_grow = stack_entry->start - end;
3488 	} else {
3489 		KASSERT(stack_entry->eflags & MAP_ENTRY_GROWS_UP, ("foo"));
3490 		KASSERT(addr >= stack_entry->end, ("foo"));
3491 		end = (next_entry != &map->header) ? next_entry->start :
3492 		    stack_entry->end + stack_entry->avail_ssize;
3493 		grow_amount = roundup(addr + 1 - stack_entry->end, PAGE_SIZE);
3494 		max_grow = end - stack_entry->end;
3495 	}
3496 
3497 	if (grow_amount > stack_entry->avail_ssize) {
3498 		vm_map_unlock_read(map);
3499 		return (KERN_NO_SPACE);
3500 	}
3501 
3502 	/*
3503 	 * If there is no longer enough space between the entries nogo, and
3504 	 * adjust the available space.  Note: this  should only happen if the
3505 	 * user has mapped into the stack area after the stack was created,
3506 	 * and is probably an error.
3507 	 *
3508 	 * This also effectively destroys any guard page the user might have
3509 	 * intended by limiting the stack size.
3510 	 */
3511 	if (grow_amount + (stack_guard_page ? PAGE_SIZE : 0) > max_grow) {
3512 		if (vm_map_lock_upgrade(map))
3513 			goto Retry;
3514 
3515 		stack_entry->avail_ssize = max_grow;
3516 
3517 		vm_map_unlock(map);
3518 		return (KERN_NO_SPACE);
3519 	}
3520 
3521 	is_procstack = (addr >= (vm_offset_t)vm->vm_maxsaddr) ? 1 : 0;
3522 
3523 	/*
3524 	 * If this is the main process stack, see if we're over the stack
3525 	 * limit.
3526 	 */
3527 	if (is_procstack && (ctob(vm->vm_ssize) + grow_amount > stacklim)) {
3528 		vm_map_unlock_read(map);
3529 		return (KERN_NO_SPACE);
3530 	}
3531 #ifdef RACCT
3532 	PROC_LOCK(p);
3533 	if (is_procstack &&
3534 	    racct_set(p, RACCT_STACK, ctob(vm->vm_ssize) + grow_amount)) {
3535 		PROC_UNLOCK(p);
3536 		vm_map_unlock_read(map);
3537 		return (KERN_NO_SPACE);
3538 	}
3539 	PROC_UNLOCK(p);
3540 #endif
3541 
3542 	/* Round up the grow amount modulo sgrowsiz */
3543 	growsize = sgrowsiz;
3544 	grow_amount = roundup(grow_amount, growsize);
3545 	if (grow_amount > stack_entry->avail_ssize)
3546 		grow_amount = stack_entry->avail_ssize;
3547 	if (is_procstack && (ctob(vm->vm_ssize) + grow_amount > stacklim)) {
3548 		grow_amount = trunc_page((vm_size_t)stacklim) -
3549 		    ctob(vm->vm_ssize);
3550 	}
3551 #ifdef notyet
3552 	PROC_LOCK(p);
3553 	limit = racct_get_available(p, RACCT_STACK);
3554 	PROC_UNLOCK(p);
3555 	if (is_procstack && (ctob(vm->vm_ssize) + grow_amount > limit))
3556 		grow_amount = limit - ctob(vm->vm_ssize);
3557 #endif
3558 	if (!old_mlock && map->flags & MAP_WIREFUTURE) {
3559 		if (ptoa(pmap_wired_count(map->pmap)) + grow_amount > lmemlim) {
3560 			vm_map_unlock_read(map);
3561 			rv = KERN_NO_SPACE;
3562 			goto out;
3563 		}
3564 #ifdef RACCT
3565 		PROC_LOCK(p);
3566 		if (racct_set(p, RACCT_MEMLOCK,
3567 		    ptoa(pmap_wired_count(map->pmap)) + grow_amount)) {
3568 			PROC_UNLOCK(p);
3569 			vm_map_unlock_read(map);
3570 			rv = KERN_NO_SPACE;
3571 			goto out;
3572 		}
3573 		PROC_UNLOCK(p);
3574 #endif
3575 	}
3576 	/* If we would blow our VMEM resource limit, no go */
3577 	if (map->size + grow_amount > vmemlim) {
3578 		vm_map_unlock_read(map);
3579 		rv = KERN_NO_SPACE;
3580 		goto out;
3581 	}
3582 #ifdef RACCT
3583 	PROC_LOCK(p);
3584 	if (racct_set(p, RACCT_VMEM, map->size + grow_amount)) {
3585 		PROC_UNLOCK(p);
3586 		vm_map_unlock_read(map);
3587 		rv = KERN_NO_SPACE;
3588 		goto out;
3589 	}
3590 	PROC_UNLOCK(p);
3591 #endif
3592 
3593 	if (vm_map_lock_upgrade(map))
3594 		goto Retry;
3595 
3596 	if (stack_entry == next_entry) {
3597 		/*
3598 		 * Growing downward.
3599 		 */
3600 		/* Get the preliminary new entry start value */
3601 		addr = stack_entry->start - grow_amount;
3602 
3603 		/*
3604 		 * If this puts us into the previous entry, cut back our
3605 		 * growth to the available space. Also, see the note above.
3606 		 */
3607 		if (addr < end) {
3608 			stack_entry->avail_ssize = max_grow;
3609 			addr = end;
3610 			if (stack_guard_page)
3611 				addr += PAGE_SIZE;
3612 		}
3613 
3614 		rv = vm_map_insert(map, NULL, 0, addr, stack_entry->start,
3615 		    next_entry->protection, next_entry->max_protection, 0);
3616 
3617 		/* Adjust the available stack space by the amount we grew. */
3618 		if (rv == KERN_SUCCESS) {
3619 			if (prev_entry != &map->header)
3620 				vm_map_clip_end(map, prev_entry, addr);
3621 			new_entry = prev_entry->next;
3622 			KASSERT(new_entry == stack_entry->prev, ("foo"));
3623 			KASSERT(new_entry->end == stack_entry->start, ("foo"));
3624 			KASSERT(new_entry->start == addr, ("foo"));
3625 			grow_amount = new_entry->end - new_entry->start;
3626 			new_entry->avail_ssize = stack_entry->avail_ssize -
3627 			    grow_amount;
3628 			stack_entry->eflags &= ~MAP_ENTRY_GROWS_DOWN;
3629 			new_entry->eflags |= MAP_ENTRY_GROWS_DOWN;
3630 		}
3631 	} else {
3632 		/*
3633 		 * Growing upward.
3634 		 */
3635 		addr = stack_entry->end + grow_amount;
3636 
3637 		/*
3638 		 * If this puts us into the next entry, cut back our growth
3639 		 * to the available space. Also, see the note above.
3640 		 */
3641 		if (addr > end) {
3642 			stack_entry->avail_ssize = end - stack_entry->end;
3643 			addr = end;
3644 			if (stack_guard_page)
3645 				addr -= PAGE_SIZE;
3646 		}
3647 
3648 		grow_amount = addr - stack_entry->end;
3649 		cred = stack_entry->cred;
3650 		if (cred == NULL && stack_entry->object.vm_object != NULL)
3651 			cred = stack_entry->object.vm_object->cred;
3652 		if (cred != NULL && !swap_reserve_by_cred(grow_amount, cred))
3653 			rv = KERN_NO_SPACE;
3654 		/* Grow the underlying object if applicable. */
3655 		else if (stack_entry->object.vm_object == NULL ||
3656 			 vm_object_coalesce(stack_entry->object.vm_object,
3657 			 stack_entry->offset,
3658 			 (vm_size_t)(stack_entry->end - stack_entry->start),
3659 			 (vm_size_t)grow_amount, cred != NULL)) {
3660 			map->size += (addr - stack_entry->end);
3661 			/* Update the current entry. */
3662 			stack_entry->end = addr;
3663 			stack_entry->avail_ssize -= grow_amount;
3664 			vm_map_entry_resize_free(map, stack_entry);
3665 			rv = KERN_SUCCESS;
3666 
3667 			if (next_entry != &map->header)
3668 				vm_map_clip_start(map, next_entry, addr);
3669 		} else
3670 			rv = KERN_FAILURE;
3671 	}
3672 
3673 	if (rv == KERN_SUCCESS && is_procstack)
3674 		vm->vm_ssize += btoc(grow_amount);
3675 
3676 	vm_map_unlock(map);
3677 
3678 	/*
3679 	 * Heed the MAP_WIREFUTURE flag if it was set for this process.
3680 	 */
3681 	if (rv == KERN_SUCCESS && (map->flags & MAP_WIREFUTURE)) {
3682 		vm_map_wire(map,
3683 		    (stack_entry == next_entry) ? addr : addr - grow_amount,
3684 		    (stack_entry == next_entry) ? stack_entry->start : addr,
3685 		    (p->p_flag & P_SYSTEM)
3686 		    ? VM_MAP_WIRE_SYSTEM|VM_MAP_WIRE_NOHOLES
3687 		    : VM_MAP_WIRE_USER|VM_MAP_WIRE_NOHOLES);
3688 	}
3689 
3690 out:
3691 #ifdef RACCT
3692 	if (rv != KERN_SUCCESS) {
3693 		PROC_LOCK(p);
3694 		error = racct_set(p, RACCT_VMEM, map->size);
3695 		KASSERT(error == 0, ("decreasing RACCT_VMEM failed"));
3696 		if (!old_mlock) {
3697 			error = racct_set(p, RACCT_MEMLOCK,
3698 			    ptoa(pmap_wired_count(map->pmap)));
3699 			KASSERT(error == 0, ("decreasing RACCT_MEMLOCK failed"));
3700 		}
3701 	    	error = racct_set(p, RACCT_STACK, ctob(vm->vm_ssize));
3702 		KASSERT(error == 0, ("decreasing RACCT_STACK failed"));
3703 		PROC_UNLOCK(p);
3704 	}
3705 #endif
3706 
3707 	return (rv);
3708 }
3709 
3710 /*
3711  * Unshare the specified VM space for exec.  If other processes are
3712  * mapped to it, then create a new one.  The new vmspace is null.
3713  */
3714 int
3715 vmspace_exec(struct proc *p, vm_offset_t minuser, vm_offset_t maxuser)
3716 {
3717 	struct vmspace *oldvmspace = p->p_vmspace;
3718 	struct vmspace *newvmspace;
3719 
3720 	newvmspace = vmspace_alloc(minuser, maxuser);
3721 	if (newvmspace == NULL)
3722 		return (ENOMEM);
3723 	newvmspace->vm_swrss = oldvmspace->vm_swrss;
3724 	/*
3725 	 * This code is written like this for prototype purposes.  The
3726 	 * goal is to avoid running down the vmspace here, but let the
3727 	 * other process's that are still using the vmspace to finally
3728 	 * run it down.  Even though there is little or no chance of blocking
3729 	 * here, it is a good idea to keep this form for future mods.
3730 	 */
3731 	PROC_VMSPACE_LOCK(p);
3732 	p->p_vmspace = newvmspace;
3733 	PROC_VMSPACE_UNLOCK(p);
3734 	if (p == curthread->td_proc)
3735 		pmap_activate(curthread);
3736 	vmspace_free(oldvmspace);
3737 	return (0);
3738 }
3739 
3740 /*
3741  * Unshare the specified VM space for forcing COW.  This
3742  * is called by rfork, for the (RFMEM|RFPROC) == 0 case.
3743  */
3744 int
3745 vmspace_unshare(struct proc *p)
3746 {
3747 	struct vmspace *oldvmspace = p->p_vmspace;
3748 	struct vmspace *newvmspace;
3749 	vm_ooffset_t fork_charge;
3750 
3751 	if (oldvmspace->vm_refcnt == 1)
3752 		return (0);
3753 	fork_charge = 0;
3754 	newvmspace = vmspace_fork(oldvmspace, &fork_charge);
3755 	if (newvmspace == NULL)
3756 		return (ENOMEM);
3757 	if (!swap_reserve_by_cred(fork_charge, p->p_ucred)) {
3758 		vmspace_free(newvmspace);
3759 		return (ENOMEM);
3760 	}
3761 	PROC_VMSPACE_LOCK(p);
3762 	p->p_vmspace = newvmspace;
3763 	PROC_VMSPACE_UNLOCK(p);
3764 	if (p == curthread->td_proc)
3765 		pmap_activate(curthread);
3766 	vmspace_free(oldvmspace);
3767 	return (0);
3768 }
3769 
3770 /*
3771  *	vm_map_lookup:
3772  *
3773  *	Finds the VM object, offset, and
3774  *	protection for a given virtual address in the
3775  *	specified map, assuming a page fault of the
3776  *	type specified.
3777  *
3778  *	Leaves the map in question locked for read; return
3779  *	values are guaranteed until a vm_map_lookup_done
3780  *	call is performed.  Note that the map argument
3781  *	is in/out; the returned map must be used in
3782  *	the call to vm_map_lookup_done.
3783  *
3784  *	A handle (out_entry) is returned for use in
3785  *	vm_map_lookup_done, to make that fast.
3786  *
3787  *	If a lookup is requested with "write protection"
3788  *	specified, the map may be changed to perform virtual
3789  *	copying operations, although the data referenced will
3790  *	remain the same.
3791  */
3792 int
3793 vm_map_lookup(vm_map_t *var_map,		/* IN/OUT */
3794 	      vm_offset_t vaddr,
3795 	      vm_prot_t fault_typea,
3796 	      vm_map_entry_t *out_entry,	/* OUT */
3797 	      vm_object_t *object,		/* OUT */
3798 	      vm_pindex_t *pindex,		/* OUT */
3799 	      vm_prot_t *out_prot,		/* OUT */
3800 	      boolean_t *wired)			/* OUT */
3801 {
3802 	vm_map_entry_t entry;
3803 	vm_map_t map = *var_map;
3804 	vm_prot_t prot;
3805 	vm_prot_t fault_type = fault_typea;
3806 	vm_object_t eobject;
3807 	vm_size_t size;
3808 	struct ucred *cred;
3809 
3810 RetryLookup:;
3811 
3812 	vm_map_lock_read(map);
3813 
3814 	/*
3815 	 * Lookup the faulting address.
3816 	 */
3817 	if (!vm_map_lookup_entry(map, vaddr, out_entry)) {
3818 		vm_map_unlock_read(map);
3819 		return (KERN_INVALID_ADDRESS);
3820 	}
3821 
3822 	entry = *out_entry;
3823 
3824 	/*
3825 	 * Handle submaps.
3826 	 */
3827 	if (entry->eflags & MAP_ENTRY_IS_SUB_MAP) {
3828 		vm_map_t old_map = map;
3829 
3830 		*var_map = map = entry->object.sub_map;
3831 		vm_map_unlock_read(old_map);
3832 		goto RetryLookup;
3833 	}
3834 
3835 	/*
3836 	 * Check whether this task is allowed to have this page.
3837 	 */
3838 	prot = entry->protection;
3839 	fault_type &= (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE);
3840 	if ((fault_type & prot) != fault_type || prot == VM_PROT_NONE) {
3841 		vm_map_unlock_read(map);
3842 		return (KERN_PROTECTION_FAILURE);
3843 	}
3844 	if ((entry->eflags & MAP_ENTRY_USER_WIRED) &&
3845 	    (entry->eflags & MAP_ENTRY_COW) &&
3846 	    (fault_type & VM_PROT_WRITE)) {
3847 		vm_map_unlock_read(map);
3848 		return (KERN_PROTECTION_FAILURE);
3849 	}
3850 	if ((fault_typea & VM_PROT_COPY) != 0 &&
3851 	    (entry->max_protection & VM_PROT_WRITE) == 0 &&
3852 	    (entry->eflags & MAP_ENTRY_COW) == 0) {
3853 		vm_map_unlock_read(map);
3854 		return (KERN_PROTECTION_FAILURE);
3855 	}
3856 
3857 	/*
3858 	 * If this page is not pageable, we have to get it for all possible
3859 	 * accesses.
3860 	 */
3861 	*wired = (entry->wired_count != 0);
3862 	if (*wired)
3863 		fault_type = entry->protection;
3864 	size = entry->end - entry->start;
3865 	/*
3866 	 * If the entry was copy-on-write, we either ...
3867 	 */
3868 	if (entry->eflags & MAP_ENTRY_NEEDS_COPY) {
3869 		/*
3870 		 * If we want to write the page, we may as well handle that
3871 		 * now since we've got the map locked.
3872 		 *
3873 		 * If we don't need to write the page, we just demote the
3874 		 * permissions allowed.
3875 		 */
3876 		if ((fault_type & VM_PROT_WRITE) != 0 ||
3877 		    (fault_typea & VM_PROT_COPY) != 0) {
3878 			/*
3879 			 * Make a new object, and place it in the object
3880 			 * chain.  Note that no new references have appeared
3881 			 * -- one just moved from the map to the new
3882 			 * object.
3883 			 */
3884 			if (vm_map_lock_upgrade(map))
3885 				goto RetryLookup;
3886 
3887 			if (entry->cred == NULL) {
3888 				/*
3889 				 * The debugger owner is charged for
3890 				 * the memory.
3891 				 */
3892 				cred = curthread->td_ucred;
3893 				crhold(cred);
3894 				if (!swap_reserve_by_cred(size, cred)) {
3895 					crfree(cred);
3896 					vm_map_unlock(map);
3897 					return (KERN_RESOURCE_SHORTAGE);
3898 				}
3899 				entry->cred = cred;
3900 			}
3901 			vm_object_shadow(&entry->object.vm_object,
3902 			    &entry->offset, size);
3903 			entry->eflags &= ~MAP_ENTRY_NEEDS_COPY;
3904 			eobject = entry->object.vm_object;
3905 			if (eobject->cred != NULL) {
3906 				/*
3907 				 * The object was not shadowed.
3908 				 */
3909 				swap_release_by_cred(size, entry->cred);
3910 				crfree(entry->cred);
3911 				entry->cred = NULL;
3912 			} else if (entry->cred != NULL) {
3913 				VM_OBJECT_WLOCK(eobject);
3914 				eobject->cred = entry->cred;
3915 				eobject->charge = size;
3916 				VM_OBJECT_WUNLOCK(eobject);
3917 				entry->cred = NULL;
3918 			}
3919 
3920 			vm_map_lock_downgrade(map);
3921 		} else {
3922 			/*
3923 			 * We're attempting to read a copy-on-write page --
3924 			 * don't allow writes.
3925 			 */
3926 			prot &= ~VM_PROT_WRITE;
3927 		}
3928 	}
3929 
3930 	/*
3931 	 * Create an object if necessary.
3932 	 */
3933 	if (entry->object.vm_object == NULL &&
3934 	    !map->system_map) {
3935 		if (vm_map_lock_upgrade(map))
3936 			goto RetryLookup;
3937 		entry->object.vm_object = vm_object_allocate(OBJT_DEFAULT,
3938 		    atop(size));
3939 		entry->offset = 0;
3940 		if (entry->cred != NULL) {
3941 			VM_OBJECT_WLOCK(entry->object.vm_object);
3942 			entry->object.vm_object->cred = entry->cred;
3943 			entry->object.vm_object->charge = size;
3944 			VM_OBJECT_WUNLOCK(entry->object.vm_object);
3945 			entry->cred = NULL;
3946 		}
3947 		vm_map_lock_downgrade(map);
3948 	}
3949 
3950 	/*
3951 	 * Return the object/offset from this entry.  If the entry was
3952 	 * copy-on-write or empty, it has been fixed up.
3953 	 */
3954 	*pindex = OFF_TO_IDX((vaddr - entry->start) + entry->offset);
3955 	*object = entry->object.vm_object;
3956 
3957 	*out_prot = prot;
3958 	return (KERN_SUCCESS);
3959 }
3960 
3961 /*
3962  *	vm_map_lookup_locked:
3963  *
3964  *	Lookup the faulting address.  A version of vm_map_lookup that returns
3965  *      KERN_FAILURE instead of blocking on map lock or memory allocation.
3966  */
3967 int
3968 vm_map_lookup_locked(vm_map_t *var_map,		/* IN/OUT */
3969 		     vm_offset_t vaddr,
3970 		     vm_prot_t fault_typea,
3971 		     vm_map_entry_t *out_entry,	/* OUT */
3972 		     vm_object_t *object,	/* OUT */
3973 		     vm_pindex_t *pindex,	/* OUT */
3974 		     vm_prot_t *out_prot,	/* OUT */
3975 		     boolean_t *wired)		/* OUT */
3976 {
3977 	vm_map_entry_t entry;
3978 	vm_map_t map = *var_map;
3979 	vm_prot_t prot;
3980 	vm_prot_t fault_type = fault_typea;
3981 
3982 	/*
3983 	 * Lookup the faulting address.
3984 	 */
3985 	if (!vm_map_lookup_entry(map, vaddr, out_entry))
3986 		return (KERN_INVALID_ADDRESS);
3987 
3988 	entry = *out_entry;
3989 
3990 	/*
3991 	 * Fail if the entry refers to a submap.
3992 	 */
3993 	if (entry->eflags & MAP_ENTRY_IS_SUB_MAP)
3994 		return (KERN_FAILURE);
3995 
3996 	/*
3997 	 * Check whether this task is allowed to have this page.
3998 	 */
3999 	prot = entry->protection;
4000 	fault_type &= VM_PROT_READ | VM_PROT_WRITE | VM_PROT_EXECUTE;
4001 	if ((fault_type & prot) != fault_type)
4002 		return (KERN_PROTECTION_FAILURE);
4003 	if ((entry->eflags & MAP_ENTRY_USER_WIRED) &&
4004 	    (entry->eflags & MAP_ENTRY_COW) &&
4005 	    (fault_type & VM_PROT_WRITE))
4006 		return (KERN_PROTECTION_FAILURE);
4007 
4008 	/*
4009 	 * If this page is not pageable, we have to get it for all possible
4010 	 * accesses.
4011 	 */
4012 	*wired = (entry->wired_count != 0);
4013 	if (*wired)
4014 		fault_type = entry->protection;
4015 
4016 	if (entry->eflags & MAP_ENTRY_NEEDS_COPY) {
4017 		/*
4018 		 * Fail if the entry was copy-on-write for a write fault.
4019 		 */
4020 		if (fault_type & VM_PROT_WRITE)
4021 			return (KERN_FAILURE);
4022 		/*
4023 		 * We're attempting to read a copy-on-write page --
4024 		 * don't allow writes.
4025 		 */
4026 		prot &= ~VM_PROT_WRITE;
4027 	}
4028 
4029 	/*
4030 	 * Fail if an object should be created.
4031 	 */
4032 	if (entry->object.vm_object == NULL && !map->system_map)
4033 		return (KERN_FAILURE);
4034 
4035 	/*
4036 	 * Return the object/offset from this entry.  If the entry was
4037 	 * copy-on-write or empty, it has been fixed up.
4038 	 */
4039 	*pindex = OFF_TO_IDX((vaddr - entry->start) + entry->offset);
4040 	*object = entry->object.vm_object;
4041 
4042 	*out_prot = prot;
4043 	return (KERN_SUCCESS);
4044 }
4045 
4046 /*
4047  *	vm_map_lookup_done:
4048  *
4049  *	Releases locks acquired by a vm_map_lookup
4050  *	(according to the handle returned by that lookup).
4051  */
4052 void
4053 vm_map_lookup_done(vm_map_t map, vm_map_entry_t entry)
4054 {
4055 	/*
4056 	 * Unlock the main-level map
4057 	 */
4058 	vm_map_unlock_read(map);
4059 }
4060 
4061 #include "opt_ddb.h"
4062 #ifdef DDB
4063 #include <sys/kernel.h>
4064 
4065 #include <ddb/ddb.h>
4066 
4067 static void
4068 vm_map_print(vm_map_t map)
4069 {
4070 	vm_map_entry_t entry;
4071 
4072 	db_iprintf("Task map %p: pmap=%p, nentries=%d, version=%u\n",
4073 	    (void *)map,
4074 	    (void *)map->pmap, map->nentries, map->timestamp);
4075 
4076 	db_indent += 2;
4077 	for (entry = map->header.next; entry != &map->header;
4078 	    entry = entry->next) {
4079 		db_iprintf("map entry %p: start=%p, end=%p\n",
4080 		    (void *)entry, (void *)entry->start, (void *)entry->end);
4081 		{
4082 			static char *inheritance_name[4] =
4083 			{"share", "copy", "none", "donate_copy"};
4084 
4085 			db_iprintf(" prot=%x/%x/%s",
4086 			    entry->protection,
4087 			    entry->max_protection,
4088 			    inheritance_name[(int)(unsigned char)entry->inheritance]);
4089 			if (entry->wired_count != 0)
4090 				db_printf(", wired");
4091 		}
4092 		if (entry->eflags & MAP_ENTRY_IS_SUB_MAP) {
4093 			db_printf(", share=%p, offset=0x%jx\n",
4094 			    (void *)entry->object.sub_map,
4095 			    (uintmax_t)entry->offset);
4096 			if ((entry->prev == &map->header) ||
4097 			    (entry->prev->object.sub_map !=
4098 				entry->object.sub_map)) {
4099 				db_indent += 2;
4100 				vm_map_print((vm_map_t)entry->object.sub_map);
4101 				db_indent -= 2;
4102 			}
4103 		} else {
4104 			if (entry->cred != NULL)
4105 				db_printf(", ruid %d", entry->cred->cr_ruid);
4106 			db_printf(", object=%p, offset=0x%jx",
4107 			    (void *)entry->object.vm_object,
4108 			    (uintmax_t)entry->offset);
4109 			if (entry->object.vm_object && entry->object.vm_object->cred)
4110 				db_printf(", obj ruid %d charge %jx",
4111 				    entry->object.vm_object->cred->cr_ruid,
4112 				    (uintmax_t)entry->object.vm_object->charge);
4113 			if (entry->eflags & MAP_ENTRY_COW)
4114 				db_printf(", copy (%s)",
4115 				    (entry->eflags & MAP_ENTRY_NEEDS_COPY) ? "needed" : "done");
4116 			db_printf("\n");
4117 
4118 			if ((entry->prev == &map->header) ||
4119 			    (entry->prev->object.vm_object !=
4120 				entry->object.vm_object)) {
4121 				db_indent += 2;
4122 				vm_object_print((db_expr_t)(intptr_t)
4123 						entry->object.vm_object,
4124 						1, 0, (char *)0);
4125 				db_indent -= 2;
4126 			}
4127 		}
4128 	}
4129 	db_indent -= 2;
4130 }
4131 
4132 DB_SHOW_COMMAND(map, map)
4133 {
4134 
4135 	if (!have_addr) {
4136 		db_printf("usage: show map <addr>\n");
4137 		return;
4138 	}
4139 	vm_map_print((vm_map_t)addr);
4140 }
4141 
4142 DB_SHOW_COMMAND(procvm, procvm)
4143 {
4144 	struct proc *p;
4145 
4146 	if (have_addr) {
4147 		p = (struct proc *) addr;
4148 	} else {
4149 		p = curproc;
4150 	}
4151 
4152 	db_printf("p = %p, vmspace = %p, map = %p, pmap = %p\n",
4153 	    (void *)p, (void *)p->p_vmspace, (void *)&p->p_vmspace->vm_map,
4154 	    (void *)vmspace_pmap(p->p_vmspace));
4155 
4156 	vm_map_print((vm_map_t)&p->p_vmspace->vm_map);
4157 }
4158 
4159 #endif /* DDB */
4160