xref: /netbsd-src/sys/uvm/uvm_fault.c (revision 95d875fb90b1458e4f1de6950286ddcd6644bc61)
1 /*	$NetBSD: uvm_fault.c,v 1.46 1999/11/13 00:24:38 thorpej Exp $	*/
2 
3 /*
4  *
5  * Copyright (c) 1997 Charles D. Cranor and Washington University.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by Charles D. Cranor and
19  *      Washington University.
20  * 4. The name of the author may not be used to endorse or promote products
21  *    derived from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * from: Id: uvm_fault.c,v 1.1.2.23 1998/02/06 05:29:05 chs Exp
35  */
36 
37 #include "opt_uvmhist.h"
38 
39 /*
40  * uvm_fault.c: fault handler
41  */
42 
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/proc.h>
47 #include <sys/malloc.h>
48 #include <sys/mman.h>
49 #include <sys/user.h>
50 
51 #include <vm/vm.h>
52 #include <vm/vm_page.h>
53 #include <vm/vm_kern.h>
54 
55 #include <uvm/uvm.h>
56 
57 /*
58  *
59  * a word on page faults:
60  *
61  * types of page faults we handle:
62  *
63  * CASE 1: upper layer faults                   CASE 2: lower layer faults
64  *
65  *    CASE 1A         CASE 1B                  CASE 2A        CASE 2B
66  *    read/write1     write>1                  read/write   +-cow_write/zero
67  *         |             |                         |        |
68  *      +--|--+       +--|--+     +-----+       +  |  +     | +-----+
69  * amap |  V  |       |  ----------->new|          |        | |  ^  |
70  *      +-----+       +-----+     +-----+       +  |  +     | +--|--+
71  *                                                 |        |    |
72  *      +-----+       +-----+                   +--|--+     | +--|--+
73  * uobj | d/c |       | d/c |                   |  V  |     +----|  |
74  *      +-----+       +-----+                   +-----+       +-----+
75  *
76  * d/c = don't care
77  *
78  *   case [0]: layerless fault
79  *	no amap or uobj is present.   this is an error.
80  *
81  *   case [1]: upper layer fault [anon active]
82  *     1A: [read] or [write with anon->an_ref == 1]
83  *		I/O takes place in top level anon and uobj is not touched.
84  *     1B: [write with anon->an_ref > 1]
85  *		new anon is alloc'd and data is copied off ["COW"]
86  *
87  *   case [2]: lower layer fault [uobj]
88  *     2A: [read on non-NULL uobj] or [write to non-copy_on_write area]
89  *		I/O takes place directly in object.
90  *     2B: [write to copy_on_write] or [read on NULL uobj]
91  *		data is "promoted" from uobj to a new anon.
92  *		if uobj is null, then we zero fill.
93  *
94  * we follow the standard UVM locking protocol ordering:
95  *
96  * MAPS => AMAP => UOBJ => ANON => PAGE QUEUES (PQ)
97  * we hold a PG_BUSY page if we unlock for I/O
98  *
99  *
100  * the code is structured as follows:
101  *
102  *     - init the "IN" params in the ufi structure
103  *   ReFault:
104  *     - do lookups [locks maps], check protection, handle needs_copy
105  *     - check for case 0 fault (error)
106  *     - establish "range" of fault
107  *     - if we have an amap lock it and extract the anons
108  *     - if sequential advice deactivate pages behind us
109  *     - at the same time check pmap for unmapped areas and anon for pages
110  *	 that we could map in (and do map it if found)
111  *     - check object for resident pages that we could map in
112  *     - if (case 2) goto Case2
113  *     - >>> handle case 1
114  *           - ensure source anon is resident in RAM
115  *           - if case 1B alloc new anon and copy from source
116  *           - map the correct page in
117  *   Case2:
118  *     - >>> handle case 2
119  *           - ensure source page is resident (if uobj)
120  *           - if case 2B alloc new anon and copy from source (could be zero
121  *		fill if uobj == NULL)
122  *           - map the correct page in
123  *     - done!
124  *
125  * note on paging:
126  *   if we have to do I/O we place a PG_BUSY page in the correct object,
127  * unlock everything, and do the I/O.   when I/O is done we must reverify
128  * the state of the world before assuming that our data structures are
129  * valid.   [because mappings could change while the map is unlocked]
130  *
131  *  alternative 1: unbusy the page in question and restart the page fault
132  *    from the top (ReFault).   this is easy but does not take advantage
133  *    of the information that we already have from our previous lookup,
134  *    although it is possible that the "hints" in the vm_map will help here.
135  *
136  * alternative 2: the system already keeps track of a "version" number of
137  *    a map.   [i.e. every time you write-lock a map (e.g. to change a
138  *    mapping) you bump the version number up by one...]   so, we can save
139  *    the version number of the map before we release the lock and start I/O.
140  *    then when I/O is done we can relock and check the version numbers
141  *    to see if anything changed.    this might save us some over 1 because
142  *    we don't have to unbusy the page and may be less compares(?).
143  *
144  * alternative 3: put in backpointers or a way to "hold" part of a map
145  *    in place while I/O is in progress.   this could be complex to
146  *    implement (especially with structures like amap that can be referenced
147  *    by multiple map entries, and figuring out what should wait could be
148  *    complex as well...).
149  *
150  * given that we are not currently multiprocessor or multithreaded we might
151  * as well choose alternative 2 now.   maybe alternative 3 would be useful
152  * in the future.    XXX keep in mind for future consideration//rechecking.
153  */
154 
155 /*
156  * local data structures
157  */
158 
159 struct uvm_advice {
160 	int advice;
161 	int nback;
162 	int nforw;
163 };
164 
165 /*
166  * page range array:
167  * note: index in array must match "advice" value
168  * XXX: borrowed numbers from freebsd.   do they work well for us?
169  */
170 
171 static struct uvm_advice uvmadvice[] = {
172 	{ MADV_NORMAL, 3, 4 },
173 	{ MADV_RANDOM, 0, 0 },
174 	{ MADV_SEQUENTIAL, 8, 7},
175 };
176 
177 #define UVM_MAXRANGE 16	/* must be max() of nback+nforw+1 */
178 
179 /*
180  * private prototypes
181  */
182 
183 static void uvmfault_amapcopy __P((struct uvm_faultinfo *));
184 static __inline void uvmfault_anonflush __P((struct vm_anon **, int));
185 
186 /*
187  * inline functions
188  */
189 
190 /*
191  * uvmfault_anonflush: try and deactivate pages in specified anons
192  *
193  * => does not have to deactivate page if it is busy
194  */
195 
196 static __inline void
197 uvmfault_anonflush(anons, n)
198 	struct vm_anon **anons;
199 	int n;
200 {
201 	int lcv;
202 	struct vm_page *pg;
203 
204 	for (lcv = 0 ; lcv < n ; lcv++) {
205 		if (anons[lcv] == NULL)
206 			continue;
207 		simple_lock(&anons[lcv]->an_lock);
208 		pg = anons[lcv]->u.an_page;
209 		if (pg && (pg->flags & PG_BUSY) == 0 && pg->loan_count == 0) {
210 			uvm_lock_pageq();
211 			if (pg->wire_count == 0) {
212 				pmap_page_protect(pg, VM_PROT_NONE);
213 				uvm_pagedeactivate(pg);
214 			}
215 			uvm_unlock_pageq();
216 		}
217 		simple_unlock(&anons[lcv]->an_lock);
218 	}
219 }
220 
221 /*
222  * normal functions
223  */
224 
225 /*
226  * uvmfault_amapcopy: clear "needs_copy" in a map.
227  *
228  * => called with VM data structures unlocked (usually, see below)
229  * => we get a write lock on the maps and clear needs_copy for a VA
230  * => if we are out of RAM we sleep (waiting for more)
231  */
232 
233 static void
234 uvmfault_amapcopy(ufi)
235 	struct uvm_faultinfo *ufi;
236 {
237 
238 	/*
239 	 * while we haven't done the job
240 	 */
241 
242 	while (1) {
243 
244 		/*
245 		 * no mapping?  give up.
246 		 */
247 
248 		if (uvmfault_lookup(ufi, TRUE) == FALSE)
249 			return;
250 
251 		/*
252 		 * copy if needed.
253 		 */
254 
255 		if (UVM_ET_ISNEEDSCOPY(ufi->entry))
256 			amap_copy(ufi->map, ufi->entry, M_NOWAIT, TRUE,
257 				ufi->orig_rvaddr, ufi->orig_rvaddr + 1);
258 
259 		/*
260 		 * didn't work?  must be out of RAM.   unlock and sleep.
261 		 */
262 
263 		if (UVM_ET_ISNEEDSCOPY(ufi->entry)) {
264 			uvmfault_unlockmaps(ufi, TRUE);
265 			uvm_wait("fltamapcopy");
266 			continue;
267 		}
268 
269 		/*
270 		 * got it!   unlock and return.
271 		 */
272 
273 		uvmfault_unlockmaps(ufi, TRUE);
274 		return;
275 	}
276 	/*NOTREACHED*/
277 }
278 
279 /*
280  * uvmfault_anonget: get data in an anon into a non-busy, non-released
281  * page in that anon.
282  *
283  * => maps, amap, and anon locked by caller.
284  * => if we fail (result != VM_PAGER_OK) we unlock everything.
285  * => if we are successful, we return with everything still locked.
286  * => we don't move the page on the queues [gets moved later]
287  * => if we allocate a new page [we_own], it gets put on the queues.
288  *    either way, the result is that the page is on the queues at return time
289  * => for pages which are on loan from a uvm_object (and thus are not
290  *    owned by the anon): if successful, we return with the owning object
291  *    locked.   the caller must unlock this object when it unlocks everything
292  *    else.
293  */
294 
295 int uvmfault_anonget(ufi, amap, anon)
296 	struct uvm_faultinfo *ufi;
297 	struct vm_amap *amap;
298 	struct vm_anon *anon;
299 {
300 	boolean_t we_own;	/* we own anon's page? */
301 	boolean_t locked;	/* did we relock? */
302 	struct vm_page *pg;
303 	int result;
304 	UVMHIST_FUNC("uvmfault_anonget"); UVMHIST_CALLED(maphist);
305 
306 	result = 0;		/* XXX shut up gcc */
307 	uvmexp.fltanget++;
308         /* bump rusage counters */
309 	if (anon->u.an_page)
310 		curproc->p_addr->u_stats.p_ru.ru_minflt++;
311 	else
312 		curproc->p_addr->u_stats.p_ru.ru_majflt++;
313 
314 	/*
315 	 * loop until we get it, or fail.
316 	 */
317 
318 	while (1) {
319 
320 		we_own = FALSE;		/* TRUE if we set PG_BUSY on a page */
321 		pg = anon->u.an_page;
322 
323 		/*
324 		 * if there is a resident page and it is loaned, then anon
325 		 * may not own it.   call out to uvm_anon_lockpage() to ensure
326 		 * the real owner of the page has been identified and locked.
327 		 */
328 
329 		if (pg && pg->loan_count)
330 			pg = uvm_anon_lockloanpg(anon);
331 
332 		/*
333 		 * page there?   make sure it is not busy/released.
334 		 */
335 
336 		if (pg) {
337 
338 			/*
339 			 * at this point, if the page has a uobject [meaning
340 			 * we have it on loan], then that uobject is locked
341 			 * by us!   if the page is busy, we drop all the
342 			 * locks (including uobject) and try again.
343 			 */
344 
345 			if ((pg->flags & (PG_BUSY|PG_RELEASED)) == 0) {
346 				UVMHIST_LOG(maphist, "<- OK",0,0,0,0);
347 				return (VM_PAGER_OK);
348 			}
349 			pg->flags |= PG_WANTED;
350 			uvmexp.fltpgwait++;
351 
352 			/*
353 			 * the last unlock must be an atomic unlock+wait on
354 			 * the owner of page
355 			 */
356 			if (pg->uobject) {	/* owner is uobject ? */
357 				uvmfault_unlockall(ufi, amap, NULL, anon);
358 				UVMHIST_LOG(maphist, " unlock+wait on uobj",0,
359 				    0,0,0);
360 				UVM_UNLOCK_AND_WAIT(pg,
361 				    &pg->uobject->vmobjlock,
362 				    FALSE, "anonget1",0);
363 			} else {
364 				/* anon owns page */
365 				uvmfault_unlockall(ufi, amap, NULL, NULL);
366 				UVMHIST_LOG(maphist, " unlock+wait on anon",0,
367 				    0,0,0);
368 				UVM_UNLOCK_AND_WAIT(pg,&anon->an_lock,0,
369 				    "anonget2",0);
370 			}
371 			/* ready to relock and try again */
372 
373 		} else {
374 
375 			/*
376 			 * no page, we must try and bring it in.
377 			 */
378 			pg = uvm_pagealloc(NULL, 0, anon, 0);
379 
380 			if (pg == NULL) {		/* out of RAM.  */
381 
382 				uvmfault_unlockall(ufi, amap, NULL, anon);
383 				uvmexp.fltnoram++;
384 				UVMHIST_LOG(maphist, "  noram -- UVM_WAIT",0,
385 				    0,0,0);
386 				uvm_wait("flt_noram1");
387 				/* ready to relock and try again */
388 
389 			} else {
390 
391 				/* we set the PG_BUSY bit */
392 				we_own = TRUE;
393 				uvmfault_unlockall(ufi, amap, NULL, anon);
394 
395 				/*
396 				 * we are passing a PG_BUSY+PG_FAKE+PG_CLEAN
397 				 * page into the uvm_swap_get function with
398 				 * all data structures unlocked.  note that
399 				 * it is ok to read an_swslot here because
400 				 * we hold PG_BUSY on the page.
401 				 */
402 				uvmexp.pageins++;
403 				result = uvm_swap_get(pg, anon->an_swslot,
404 				    PGO_SYNCIO);
405 
406 				/*
407 				 * we clean up after the i/o below in the
408 				 * "we_own" case
409 				 */
410 				/* ready to relock and try again */
411 			}
412 		}
413 
414 		/*
415 		 * now relock and try again
416 		 */
417 
418 		locked = uvmfault_relock(ufi);
419 		if (locked) {
420 			amap_lock(amap);
421 		}
422 		if (locked || we_own)
423 			simple_lock(&anon->an_lock);
424 
425 		/*
426 		 * if we own the page (i.e. we set PG_BUSY), then we need
427 		 * to clean up after the I/O. there are three cases to
428 		 * consider:
429 		 *   [1] page released during I/O: free anon and ReFault.
430 		 *   [2] I/O not OK.   free the page and cause the fault
431 		 *       to fail.
432 		 *   [3] I/O OK!   activate the page and sync with the
433 		 *       non-we_own case (i.e. drop anon lock if not locked).
434 		 */
435 
436 		if (we_own) {
437 
438 			if (pg->flags & PG_WANTED) {
439 				/* still holding object lock */
440 				wakeup(pg);
441 			}
442 			/* un-busy! */
443 			pg->flags &= ~(PG_WANTED|PG_BUSY|PG_FAKE);
444 			UVM_PAGE_OWN(pg, NULL);
445 
446 			/*
447 			 * if we were RELEASED during I/O, then our anon is
448 			 * no longer part of an amap.   we need to free the
449 			 * anon and try again.
450 			 */
451 			if (pg->flags & PG_RELEASED) {
452 				pmap_page_protect(pg, VM_PROT_NONE);
453 				simple_unlock(&anon->an_lock);
454 				uvm_anfree(anon);	/* frees page for us */
455 				if (locked)
456 				  uvmfault_unlockall(ufi, amap, NULL, NULL);
457 				uvmexp.fltpgrele++;
458 				UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
459 				return (VM_PAGER_REFAULT);	/* refault! */
460 			}
461 
462 			if (result != VM_PAGER_OK) {
463 #ifdef DIAGNOSTIC
464 				if (result == VM_PAGER_PEND)
465 		panic("uvmfault_anonget: got PENDING for non-async I/O");
466 #endif
467 				/* remove page from anon */
468 				anon->u.an_page = NULL;
469 
470 				/*
471 				 * note: page was never !PG_BUSY, so it
472 				 * can't be mapped and thus no need to
473 				 * pmap_page_protect it...
474 				 */
475 				uvm_lock_pageq();
476 				uvm_pagefree(pg);
477 				uvm_unlock_pageq();
478 
479 				if (locked)
480 					uvmfault_unlockall(ufi, amap, NULL,
481 					    anon);
482 				else
483 					simple_unlock(&anon->an_lock);
484 				UVMHIST_LOG(maphist, "<- ERROR", 0,0,0,0);
485 				return (VM_PAGER_ERROR);
486 			}
487 
488 			/*
489 			 * must be OK, clear modify (already PG_CLEAN)
490 			 * and activate
491 			 */
492 			pmap_clear_modify(pg);
493 			uvm_lock_pageq();
494 			uvm_pageactivate(pg);
495 			uvm_unlock_pageq();
496 			if (!locked)
497 				simple_unlock(&anon->an_lock);
498 		}
499 
500 		/*
501 		 * we were not able to relock.   restart fault.
502 		 */
503 
504 		if (!locked) {
505 			UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
506 			return (VM_PAGER_REFAULT);
507 		}
508 
509 		/*
510 		 * verify no one has touched the amap and moved the anon on us.
511 		 */
512 
513 		if (amap_lookup(&ufi->entry->aref,
514 		    ufi->orig_rvaddr - ufi->entry->start) != anon) {
515 
516 			uvmfault_unlockall(ufi, amap, NULL, anon);
517 			UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
518 			return (VM_PAGER_REFAULT);
519 		}
520 
521 		/*
522 		 * try it again!
523 		 */
524 
525 		uvmexp.fltanretry++;
526 		continue;
527 
528 	} /* while (1) */
529 
530 	/*NOTREACHED*/
531 }
532 
533 /*
534  *   F A U L T   -   m a i n   e n t r y   p o i n t
535  */
536 
537 /*
538  * uvm_fault: page fault handler
539  *
540  * => called from MD code to resolve a page fault
541  * => VM data structures usually should be unlocked.   however, it is
542  *	possible to call here with the main map locked if the caller
543  *	gets a write lock, sets it recusive, and then calls us (c.f.
544  *	uvm_map_pageable).   this should be avoided because it keeps
545  *	the map locked off during I/O.
546  */
547 
548 #define MASK(entry)     (UVM_ET_ISCOPYONWRITE(entry) ? \
549 			 ~VM_PROT_WRITE : VM_PROT_ALL)
550 
551 int
552 uvm_fault(orig_map, vaddr, fault_type, access_type)
553 	vm_map_t orig_map;
554 	vaddr_t vaddr;
555 	vm_fault_t fault_type;
556 	vm_prot_t access_type;
557 {
558 	struct uvm_faultinfo ufi;
559 	vm_prot_t enter_prot;
560 	boolean_t wired, narrow, promote, locked, shadowed;
561 	int npages, nback, nforw, centeridx, result, lcv, gotpages;
562 	vaddr_t startva, objaddr, currva, offset;
563 	paddr_t pa;
564 	struct vm_amap *amap;
565 	struct uvm_object *uobj;
566 	struct vm_anon *anons_store[UVM_MAXRANGE], **anons, *anon, *oanon;
567 	struct vm_page *pages[UVM_MAXRANGE], *pg, *uobjpage;
568 	UVMHIST_FUNC("uvm_fault"); UVMHIST_CALLED(maphist);
569 
570 	UVMHIST_LOG(maphist, "(map=0x%x, vaddr=0x%x, ft=%d, at=%d)",
571 	      orig_map, vaddr, fault_type, access_type);
572 
573 	anon = NULL; /* XXX: shut up gcc */
574 
575 	uvmexp.faults++;	/* XXX: locking? */
576 
577 	/*
578 	 * init the IN parameters in the ufi
579 	 */
580 
581 	ufi.orig_map = orig_map;
582 	ufi.orig_rvaddr = trunc_page(vaddr);
583 	ufi.orig_size = PAGE_SIZE;	/* can't get any smaller than this */
584 	if (fault_type == VM_FAULT_WIRE)
585 		narrow = TRUE;		/* don't look for neighborhood
586 					 * pages on wire */
587 	else
588 		narrow = FALSE;		/* normal fault */
589 
590 	/*
591 	 * before we do anything else, if this is a fault on a kernel
592 	 * address, check to see if the address is managed by an
593 	 * interrupt-safe map.  If it is, we fail immediately.  Intrsafe
594 	 * maps are never pageable, and this approach avoids an evil
595 	 * locking mess.
596 	 */
597 	if (orig_map == kernel_map && uvmfault_check_intrsafe(&ufi)) {
598 		UVMHIST_LOG(maphist, "<- VA 0x%lx in intrsafe map %p",
599 		    ufi.orig_rvaddr, ufi.map, 0, 0);
600 		return (KERN_FAILURE);
601 	}
602 
603 	/*
604 	 * "goto ReFault" means restart the page fault from ground zero.
605 	 */
606 ReFault:
607 
608 	/*
609 	 * lookup and lock the maps
610 	 */
611 
612 	if (uvmfault_lookup(&ufi, FALSE) == FALSE) {
613 		UVMHIST_LOG(maphist, "<- no mapping @ 0x%x", vaddr, 0,0,0);
614 		return (KERN_INVALID_ADDRESS);
615 	}
616 	/* locked: maps(read) */
617 
618 	/*
619 	 * check protection
620 	 */
621 
622 	if ((ufi.entry->protection & access_type) != access_type) {
623 		UVMHIST_LOG(maphist,
624 		    "<- protection failure (prot=0x%x, access=0x%x)",
625 		    ufi.entry->protection, access_type, 0, 0);
626 		uvmfault_unlockmaps(&ufi, FALSE);
627 		return (KERN_PROTECTION_FAILURE);
628 	}
629 
630 	/*
631 	 * if the map is not a pageable map, a page fault always fails.
632 	 */
633 
634 	if ((ufi.map->flags & VM_MAP_PAGEABLE) == 0) {
635 		UVMHIST_LOG(maphist,
636 		    "<- map %p not pageable", ufi.map, 0, 0, 0);
637 		uvmfault_unlockmaps(&ufi, FALSE);
638 		return (KERN_FAILURE);
639 	}
640 
641 	/*
642 	 * "enter_prot" is the protection we want to enter the page in at.
643 	 * for certain pages (e.g. copy-on-write pages) this protection can
644 	 * be more strict than ufi.entry->protection.  "wired" means either
645 	 * the entry is wired or we are fault-wiring the pg.
646 	 */
647 
648 	enter_prot = ufi.entry->protection;
649 	wired = VM_MAPENT_ISWIRED(ufi.entry) || (fault_type == VM_FAULT_WIRE);
650 	if (wired)
651 		access_type = enter_prot; /* full access for wired */
652 
653 	/*
654 	 * handle "needs_copy" case.   if we need to copy the amap we will
655 	 * have to drop our readlock and relock it with a write lock.  (we
656 	 * need a write lock to change anything in a map entry [e.g.
657 	 * needs_copy]).
658 	 */
659 
660 	if (UVM_ET_ISNEEDSCOPY(ufi.entry)) {
661 		if ((access_type & VM_PROT_WRITE) ||
662 		    (ufi.entry->object.uvm_obj == NULL)) {
663 			/* need to clear */
664 			UVMHIST_LOG(maphist,
665 			    "  need to clear needs_copy and refault",0,0,0,0);
666 			uvmfault_unlockmaps(&ufi, FALSE);
667 			uvmfault_amapcopy(&ufi);
668 			uvmexp.fltamcopy++;
669 			goto ReFault;
670 
671 		} else {
672 
673 			/*
674 			 * ensure that we pmap_enter page R/O since
675 			 * needs_copy is still true
676 			 */
677 			enter_prot &= ~VM_PROT_WRITE;
678 
679 		}
680 	}
681 
682 	/*
683 	 * identify the players
684 	 */
685 
686 	amap = ufi.entry->aref.ar_amap;		/* top layer */
687 	uobj = ufi.entry->object.uvm_obj;	/* bottom layer */
688 
689 	/*
690 	 * check for a case 0 fault.  if nothing backing the entry then
691 	 * error now.
692 	 */
693 
694 	if (amap == NULL && uobj == NULL) {
695 		uvmfault_unlockmaps(&ufi, FALSE);
696 		UVMHIST_LOG(maphist,"<- no backing store, no overlay",0,0,0,0);
697 		return (KERN_INVALID_ADDRESS);
698 	}
699 
700 	/*
701 	 * establish range of interest based on advice from mapper
702 	 * and then clip to fit map entry.   note that we only want
703 	 * to do this the first time through the fault.   if we
704 	 * ReFault we will disable this by setting "narrow" to true.
705 	 */
706 
707 	if (narrow == FALSE) {
708 
709 		/* wide fault (!narrow) */
710 #ifdef DIAGNOSTIC
711 		if (uvmadvice[ufi.entry->advice].advice != ufi.entry->advice)
712 			panic("fault: advice mismatch!");
713 #endif
714 		nback = min(uvmadvice[ufi.entry->advice].nback,
715 			    (ufi.orig_rvaddr - ufi.entry->start) >> PAGE_SHIFT);
716 		startva = ufi.orig_rvaddr - (nback << PAGE_SHIFT);
717 		nforw = min(uvmadvice[ufi.entry->advice].nforw,
718 			    ((ufi.entry->end - ufi.orig_rvaddr) >>
719 			     PAGE_SHIFT) - 1);
720 		/*
721 		 * note: "-1" because we don't want to count the
722 		 * faulting page as forw
723 		 */
724 		npages = nback + nforw + 1;
725 		centeridx = nback;
726 
727 		narrow = TRUE;	/* ensure only once per-fault */
728 
729 	} else {
730 
731 		/* narrow fault! */
732 		nback = nforw = 0;
733 		startva = ufi.orig_rvaddr;
734 		npages = 1;
735 		centeridx = 0;
736 
737 	}
738 
739 	/* locked: maps(read) */
740 	UVMHIST_LOG(maphist, "  narrow=%d, back=%d, forw=%d, startva=0x%x",
741 		    narrow, nback, nforw, startva);
742 	UVMHIST_LOG(maphist, "  entry=0x%x, amap=0x%x, obj=0x%x", ufi.entry,
743 		    amap, uobj, 0);
744 
745 	/*
746 	 * if we've got an amap, lock it and extract current anons.
747 	 */
748 
749 	if (amap) {
750 		amap_lock(amap);
751 		anons = anons_store;
752 		amap_lookups(&ufi.entry->aref, startva - ufi.entry->start,
753 		    anons, npages);
754 	} else {
755 		anons = NULL;	/* to be safe */
756 	}
757 
758 	/* locked: maps(read), amap(if there) */
759 
760 	/*
761 	 * for MADV_SEQUENTIAL mappings we want to deactivate the back pages
762 	 * now and then forget about them (for the rest of the fault).
763 	 */
764 
765 	if (ufi.entry->advice == MADV_SEQUENTIAL) {
766 
767 		UVMHIST_LOG(maphist, "  MADV_SEQUENTIAL: flushing backpages",
768 		    0,0,0,0);
769 		/* flush back-page anons? */
770 		if (amap)
771 			uvmfault_anonflush(anons, nback);
772 
773 		/* flush object? */
774 		if (uobj) {
775 			objaddr =
776 			    (startva - ufi.entry->start) + ufi.entry->offset;
777 			simple_lock(&uobj->vmobjlock);
778 			(void) uobj->pgops->pgo_flush(uobj, objaddr, objaddr +
779 				    (nback << PAGE_SHIFT), PGO_DEACTIVATE);
780 			simple_unlock(&uobj->vmobjlock);
781 		}
782 
783 		/* now forget about the backpages */
784 		if (amap)
785 			anons += nback;
786 		startva = startva + (nback << PAGE_SHIFT);
787 		npages -= nback;
788 		nback = centeridx = 0;
789 	}
790 
791 	/* locked: maps(read), amap(if there) */
792 
793 	/*
794 	 * map in the backpages and frontpages we found in the amap in hopes
795 	 * of preventing future faults.    we also init the pages[] array as
796 	 * we go.
797 	 */
798 
799 	currva = startva;
800 	shadowed = FALSE;
801 	for (lcv = 0 ; lcv < npages ; lcv++, currva += PAGE_SIZE) {
802 
803 		/*
804 		 * dont play with VAs that are already mapped
805 		 * except for center)
806 		 */
807 		if (lcv != centeridx) {
808 			if (pmap_extract(ufi.orig_map->pmap, currva, &pa) ==
809 			    TRUE) {
810 				pages[lcv] = PGO_DONTCARE;
811 				continue;
812 			}
813 		}
814 
815 		/*
816 		 * unmapped or center page.   check if any anon at this level.
817 		 */
818 		if (amap == NULL || anons[lcv] == NULL) {
819 			pages[lcv] = NULL;
820 			continue;
821 		}
822 
823 		/*
824 		 * check for present page and map if possible.   re-activate it.
825 		 */
826 
827 		pages[lcv] = PGO_DONTCARE;
828 		if (lcv == centeridx) {		/* save center for later! */
829 			shadowed = TRUE;
830 			continue;
831 		}
832 		anon = anons[lcv];
833 		simple_lock(&anon->an_lock);
834 		/* ignore loaned pages */
835 		if (anon->u.an_page && anon->u.an_page->loan_count == 0 &&
836 			(anon->u.an_page->flags & (PG_RELEASED|PG_BUSY)) == 0) {
837 			uvm_lock_pageq();
838 			uvm_pageactivate(anon->u.an_page);	/* reactivate */
839 			uvm_unlock_pageq();
840 			UVMHIST_LOG(maphist,
841 			    "  MAPPING: n anon: pm=0x%x, va=0x%x, pg=0x%x",
842 			    ufi.orig_map->pmap, currva, anon->u.an_page, 0);
843 			uvmexp.fltnamap++;
844 			/*
845 			 * Since this isn't the page that's actually faulting,
846 			 * ignore pmap_enter() failures; it's not critical
847 			 * that we enter these right now.
848 			 */
849 			(void) pmap_enter(ufi.orig_map->pmap, currva,
850 			    VM_PAGE_TO_PHYS(anon->u.an_page),
851 			    (anon->an_ref > 1) ? (enter_prot & ~VM_PROT_WRITE) :
852 			    enter_prot,
853 			    PMAP_CANFAIL |
854 			     (VM_MAPENT_ISWIRED(ufi.entry) ? PMAP_WIRED : 0));
855 		}
856 		simple_unlock(&anon->an_lock);
857 	}
858 
859 	/* locked: maps(read), amap(if there) */
860 	/* (shadowed == TRUE) if there is an anon at the faulting address */
861 	UVMHIST_LOG(maphist, "  shadowed=%d, will_get=%d", shadowed,
862 	    (uobj && shadowed == FALSE),0,0);
863 
864 	/*
865 	 * note that if we are really short of RAM we could sleep in the above
866 	 * call to pmap_enter with everything locked.   bad?
867 	 *
868 	 * XXX Actually, that is bad; pmap_enter() should just fail in that
869 	 * XXX case.  --thorpej
870 	 */
871 
872 	/*
873 	 * if the desired page is not shadowed by the amap and we have a
874 	 * backing object, then we check to see if the backing object would
875 	 * prefer to handle the fault itself (rather than letting us do it
876 	 * with the usual pgo_get hook).  the backing object signals this by
877 	 * providing a pgo_fault routine.
878 	 */
879 
880 	if (uobj && shadowed == FALSE && uobj->pgops->pgo_fault != NULL) {
881 
882 		simple_lock(&uobj->vmobjlock);
883 
884 		/* locked: maps(read), amap (if there), uobj */
885 		result = uobj->pgops->pgo_fault(&ufi, startva, pages, npages,
886 				    centeridx, fault_type, access_type,
887 				    PGO_LOCKED);
888 		/* locked: nothing, pgo_fault has unlocked everything */
889 
890 		if (result == VM_PAGER_OK)
891 			return (KERN_SUCCESS);	/* pgo_fault did pmap enter */
892 		else if (result == VM_PAGER_REFAULT)
893 			goto ReFault;		/* try again! */
894 		else
895 			return (KERN_PROTECTION_FAILURE);
896 	}
897 
898 	/*
899 	 * now, if the desired page is not shadowed by the amap and we have
900 	 * a backing object that does not have a special fault routine, then
901 	 * we ask (with pgo_get) the object for resident pages that we care
902 	 * about and attempt to map them in.  we do not let pgo_get block
903 	 * (PGO_LOCKED).
904 	 *
905 	 * ("get" has the option of doing a pmap_enter for us)
906 	 */
907 
908 	if (uobj && shadowed == FALSE) {
909 		simple_lock(&uobj->vmobjlock);
910 
911 		/* locked (!shadowed): maps(read), amap (if there), uobj */
912 		/*
913 		 * the following call to pgo_get does _not_ change locking state
914 		 */
915 
916 		uvmexp.fltlget++;
917 		gotpages = npages;
918 		result = uobj->pgops->pgo_get(uobj, ufi.entry->offset +
919 				(startva - ufi.entry->start),
920 				pages, &gotpages, centeridx,
921 				access_type & MASK(ufi.entry),
922 				ufi.entry->advice, PGO_LOCKED);
923 
924 		/*
925 		 * check for pages to map, if we got any
926 		 */
927 
928 		uobjpage = NULL;
929 
930 		if (gotpages) {
931 			currva = startva;
932 			for (lcv = 0 ; lcv < npages ;
933 			    lcv++, currva += PAGE_SIZE) {
934 
935 				if (pages[lcv] == NULL ||
936 				    pages[lcv] == PGO_DONTCARE)
937 					continue;
938 
939 #ifdef DIAGNOSTIC
940 					/*
941 					 * pager sanity check: pgo_get with
942 					 * PGO_LOCKED should never return a
943 					 * released page to us.
944 					 */
945 					if (pages[lcv]->flags & PG_RELEASED)
946 		panic("uvm_fault: pgo_get PGO_LOCKED gave us a RELEASED page");
947 #endif
948 
949 					/*
950 					 * if center page is resident and not
951 					 * PG_BUSY|PG_RELEASED then pgo_get
952 					 * made it PG_BUSY for us and gave
953 					 * us a handle to it.   remember this
954 					 * page as "uobjpage." (for later use).
955 					 */
956 
957 					if (lcv == centeridx) {
958 						uobjpage = pages[lcv];
959 	UVMHIST_LOG(maphist, "  got uobjpage (0x%x) with locked get",
960 					    uobjpage, 0,0,0);
961 						continue;
962 				}
963 
964 				/*
965 				 * note: calling pgo_get with locked data
966 				 * structures returns us pages which are
967 				 * neither busy nor released, so we don't
968 				 * need to check for this.   we can just
969 				 * directly enter the page (after moving it
970 				 * to the head of the active queue [useful?]).
971 				 */
972 
973 				uvm_lock_pageq();
974 				uvm_pageactivate(pages[lcv]);	/* reactivate */
975 				uvm_unlock_pageq();
976 				UVMHIST_LOG(maphist,
977 				  "  MAPPING: n obj: pm=0x%x, va=0x%x, pg=0x%x",
978 				  ufi.orig_map->pmap, currva, pages[lcv], 0);
979 				uvmexp.fltnomap++;
980 				/*
981 				 * Since this page isn't the page that's
982 				 * actually fauling, ignore pmap_enter()
983 				 * failures; it's not critical that we
984 				 * enter these right now.
985 				 */
986 				(void) pmap_enter(ufi.orig_map->pmap, currva,
987 				    VM_PAGE_TO_PHYS(pages[lcv]),
988 				    enter_prot & MASK(ufi.entry),
989 				    PMAP_CANFAIL |
990 				     (wired ? PMAP_WIRED : 0));
991 
992 				/*
993 				 * NOTE: page can't be PG_WANTED or PG_RELEASED
994 				 * because we've held the lock the whole time
995 				 * we've had the handle.
996 				 */
997 				pages[lcv]->flags &= ~(PG_BUSY); /* un-busy! */
998 				UVM_PAGE_OWN(pages[lcv], NULL);
999 
1000 				/* done! */
1001 			}	/* for "lcv" loop */
1002 		}   /* "gotpages" != 0 */
1003 
1004 		/* note: object still _locked_ */
1005 	} else {
1006 
1007 		uobjpage = NULL;
1008 
1009 	}
1010 
1011 	/* locked (shadowed): maps(read), amap */
1012 	/* locked (!shadowed): maps(read), amap(if there),
1013 		 uobj(if !null), uobjpage(if !null) */
1014 
1015 	/*
1016 	 * note that at this point we are done with any front or back pages.
1017 	 * we are now going to focus on the center page (i.e. the one we've
1018 	 * faulted on).  if we have faulted on the top (anon) layer
1019 	 * [i.e. case 1], then the anon we want is anons[centeridx] (we have
1020 	 * not touched it yet).  if we have faulted on the bottom (uobj)
1021 	 * layer [i.e. case 2] and the page was both present and available,
1022 	 * then we've got a pointer to it as "uobjpage" and we've already
1023 	 * made it BUSY.
1024 	 */
1025 
1026 	/*
1027 	 * there are four possible cases we must address: 1A, 1B, 2A, and 2B
1028 	 */
1029 
1030 	/*
1031 	 * redirect case 2: if we are not shadowed, go to case 2.
1032 	 */
1033 
1034 	if (shadowed == FALSE)
1035 		goto Case2;
1036 
1037 	/* locked: maps(read), amap */
1038 
1039 	/*
1040 	 * handle case 1: fault on an anon in our amap
1041 	 */
1042 
1043 	anon = anons[centeridx];
1044 	UVMHIST_LOG(maphist, "  case 1 fault: anon=0x%x", anon, 0,0,0);
1045 	simple_lock(&anon->an_lock);
1046 
1047 	/* locked: maps(read), amap, anon */
1048 
1049 	/*
1050 	 * no matter if we have case 1A or case 1B we are going to need to
1051 	 * have the anon's memory resident.   ensure that now.
1052 	 */
1053 
1054 	/*
1055 	 * let uvmfault_anonget do the dirty work.   if it fails (!OK) it will
1056 	 * unlock for us.   if it is OK, locks are still valid and locked.
1057 	 * also, if it is OK, then the anon's page is on the queues.
1058 	 * if the page is on loan from a uvm_object, then anonget will
1059 	 * lock that object for us if it does not fail.
1060 	 */
1061 
1062 	result = uvmfault_anonget(&ufi, amap, anon);
1063 
1064 	if (result == VM_PAGER_REFAULT)
1065 		goto ReFault;
1066 
1067 	if (result == VM_PAGER_AGAIN) {
1068 		tsleep((caddr_t)&lbolt, PVM, "fltagain1", 0);
1069 		goto ReFault;
1070 	}
1071 
1072 	if (result != VM_PAGER_OK)
1073 		return (KERN_PROTECTION_FAILURE);		/* XXX??? */
1074 
1075 	/*
1076 	 * uobj is non null if the page is on loan from an object (i.e. uobj)
1077 	 */
1078 
1079 	uobj = anon->u.an_page->uobject;	/* locked by anonget if !NULL */
1080 
1081 	/* locked: maps(read), amap, anon, uobj(if one) */
1082 
1083 	/*
1084 	 * special handling for loaned pages
1085 	 */
1086 	if (anon->u.an_page->loan_count) {
1087 
1088 		if ((access_type & VM_PROT_WRITE) == 0) {
1089 
1090 			/*
1091 			 * for read faults on loaned pages we just cap the
1092 			 * protection at read-only.
1093 			 */
1094 
1095 			enter_prot = enter_prot & ~VM_PROT_WRITE;
1096 
1097 		} else {
1098 			/*
1099 			 * note that we can't allow writes into a loaned page!
1100 			 *
1101 			 * if we have a write fault on a loaned page in an
1102 			 * anon then we need to look at the anon's ref count.
1103 			 * if it is greater than one then we are going to do
1104 			 * a normal copy-on-write fault into a new anon (this
1105 			 * is not a problem).  however, if the reference count
1106 			 * is one (a case where we would normally allow a
1107 			 * write directly to the page) then we need to kill
1108 			 * the loan before we continue.
1109 			 */
1110 
1111 			/* >1 case is already ok */
1112 			if (anon->an_ref == 1) {
1113 
1114 				/* get new un-owned replacement page */
1115 				pg = uvm_pagealloc(NULL, 0, NULL, 0);
1116 				if (pg == NULL) {
1117 					uvmfault_unlockall(&ufi, amap, uobj,
1118 					    anon);
1119 					uvm_wait("flt_noram2");
1120 					goto ReFault;
1121 				}
1122 
1123 				/*
1124 				 * copy data, kill loan, and drop uobj lock
1125 				 * (if any)
1126 				 */
1127 				/* copy old -> new */
1128 				uvm_pagecopy(anon->u.an_page, pg);
1129 
1130 				/* force reload */
1131 				pmap_page_protect(anon->u.an_page,
1132 						  VM_PROT_NONE);
1133 				uvm_lock_pageq();	  /* KILL loan */
1134 				if (uobj)
1135 					/* if we were loaning */
1136 					anon->u.an_page->loan_count--;
1137 				anon->u.an_page->uanon = NULL;
1138 				/* in case we owned */
1139 				anon->u.an_page->pqflags &= ~PQ_ANON;
1140 				uvm_unlock_pageq();
1141 				if (uobj) {
1142 					simple_unlock(&uobj->vmobjlock);
1143 					uobj = NULL;
1144 				}
1145 
1146 				/* install new page in anon */
1147 				anon->u.an_page = pg;
1148 				pg->uanon = anon;
1149 				pg->pqflags |= PQ_ANON;
1150 				pg->flags &= ~(PG_BUSY|PG_FAKE);
1151 				UVM_PAGE_OWN(pg, NULL);
1152 
1153 				/* done! */
1154 			}     /* ref == 1 */
1155 		}       /* write fault */
1156 	}         /* loan count */
1157 
1158 	/*
1159 	 * if we are case 1B then we will need to allocate a new blank
1160 	 * anon to transfer the data into.   note that we have a lock
1161 	 * on anon, so no one can busy or release the page until we are done.
1162 	 * also note that the ref count can't drop to zero here because
1163 	 * it is > 1 and we are only dropping one ref.
1164 	 *
1165 	 * in the (hopefully very rare) case that we are out of RAM we
1166 	 * will unlock, wait for more RAM, and refault.
1167 	 *
1168 	 * if we are out of anon VM we kill the process (XXX: could wait?).
1169 	 */
1170 
1171 	if ((access_type & VM_PROT_WRITE) != 0 && anon->an_ref > 1) {
1172 
1173 		UVMHIST_LOG(maphist, "  case 1B: COW fault",0,0,0,0);
1174 		uvmexp.flt_acow++;
1175 		oanon = anon;		/* oanon = old, locked anon */
1176 		anon = uvm_analloc();
1177 		if (anon)
1178 			pg = uvm_pagealloc(NULL, 0, anon, 0);
1179 #ifdef __GNUC__
1180 		else
1181 			pg = NULL; /* XXX: gcc */
1182 #endif
1183 
1184 		/* check for out of RAM */
1185 		if (anon == NULL || pg == NULL) {
1186 			if (anon)
1187 				uvm_anfree(anon);
1188 			uvmfault_unlockall(&ufi, amap, uobj, oanon);
1189 #ifdef DIAGNOSTIC
1190 			if (uvmexp.swpgonly > uvmexp.swpages) {
1191 				panic("uvmexp.swpgonly botch");
1192 			}
1193 #endif
1194 			if (anon == NULL || uvmexp.swpgonly == uvmexp.swpages) {
1195 				UVMHIST_LOG(maphist,
1196 				    "<- failed.  out of VM",0,0,0,0);
1197 				uvmexp.fltnoanon++;
1198 				return (KERN_RESOURCE_SHORTAGE);
1199 			}
1200 
1201 			uvmexp.fltnoram++;
1202 			uvm_wait("flt_noram3");	/* out of RAM, wait for more */
1203 			goto ReFault;
1204 		}
1205 
1206 		/* got all resources, replace anon with nanon */
1207 
1208 		uvm_pagecopy(oanon->u.an_page, pg);	/* pg now !PG_CLEAN */
1209 		pg->flags &= ~(PG_BUSY|PG_FAKE);	/* un-busy! new page */
1210 		UVM_PAGE_OWN(pg, NULL);
1211 		amap_add(&ufi.entry->aref, ufi.orig_rvaddr - ufi.entry->start,
1212 		    anon, 1);
1213 
1214 		/* deref: can not drop to zero here by defn! */
1215 		oanon->an_ref--;
1216 
1217 		/*
1218 		 * note: oanon still locked.   anon is _not_ locked, but we
1219 		 * have the sole references to in from amap which _is_ locked.
1220 		 * thus, no one can get at it until we are done with it.
1221 		 */
1222 
1223 	} else {
1224 
1225 		uvmexp.flt_anon++;
1226 		oanon = anon;		/* old, locked anon is same as anon */
1227 		pg = anon->u.an_page;
1228 		if (anon->an_ref > 1)     /* disallow writes to ref > 1 anons */
1229 			enter_prot = enter_prot & ~VM_PROT_WRITE;
1230 
1231 	}
1232 
1233 	/* locked: maps(read), amap, anon */
1234 
1235 	/*
1236 	 * now map the page in ...
1237 	 * XXX: old fault unlocks object before pmap_enter.  this seems
1238 	 * suspect since some other thread could blast the page out from
1239 	 * under us between the unlock and the pmap_enter.
1240 	 */
1241 
1242 	UVMHIST_LOG(maphist, "  MAPPING: anon: pm=0x%x, va=0x%x, pg=0x%x",
1243 	    ufi.orig_map->pmap, ufi.orig_rvaddr, pg, 0);
1244 	if (pmap_enter(ufi.orig_map->pmap, ufi.orig_rvaddr, VM_PAGE_TO_PHYS(pg),
1245 	    enter_prot, access_type | PMAP_CANFAIL | (wired ? PMAP_WIRED : 0))
1246 	    != KERN_SUCCESS) {
1247 		/*
1248 		 * No need to undo what we did; we can simply think of
1249 		 * this as the pmap throwing away the mapping information.
1250 		 *
1251 		 * We do, however, have to go through the ReFault path,
1252 		 * as the map may change while we're asleep.
1253 		 */
1254 		uvmfault_unlockall(&ufi, amap, uobj, oanon);
1255 #ifdef DIAGNOSTIC
1256 		if (uvmexp.swpgonly > uvmexp.swpages)
1257 			panic("uvmexp.swpgonly botch");
1258 #endif
1259 		if (uvmexp.swpgonly == uvmexp.swpages) {
1260 			UVMHIST_LOG(maphist,
1261 			    "<- failed.  out of VM",0,0,0,0);
1262 			/* XXX instrumentation */
1263 			return (KERN_RESOURCE_SHORTAGE);
1264 		}
1265 		/* XXX instrumentation */
1266 		uvm_wait("flt_pmfail1");
1267 		goto ReFault;
1268 	}
1269 
1270 	/*
1271 	 * ... update the page queues.
1272 	 */
1273 
1274 	uvm_lock_pageq();
1275 
1276 	if (fault_type == VM_FAULT_WIRE) {
1277 		uvm_pagewire(pg);
1278 
1279 		/*
1280 		 * since the now-wired page cannot be paged out,
1281 		 * release its swap resources for others to use.
1282 		 * since an anon with no swap cannot be PG_CLEAN,
1283 		 * clear its clean flag now.
1284 		 */
1285 
1286 		pg->flags &= ~(PG_CLEAN);
1287 		uvm_anon_dropswap(anon);
1288 	} else {
1289 		/* activate it */
1290 		uvm_pageactivate(pg);
1291 	}
1292 
1293 	uvm_unlock_pageq();
1294 
1295 	/*
1296 	 * done case 1!  finish up by unlocking everything and returning success
1297 	 */
1298 
1299 	uvmfault_unlockall(&ufi, amap, uobj, oanon);
1300 	return (KERN_SUCCESS);
1301 
1302 
1303 Case2:
1304 	/*
1305 	 * handle case 2: faulting on backing object or zero fill
1306 	 */
1307 
1308 	/*
1309 	 * locked:
1310 	 * maps(read), amap(if there), uobj(if !null), uobjpage(if !null)
1311 	 */
1312 
1313 	/*
1314 	 * note that uobjpage can not be PGO_DONTCARE at this point.  we now
1315 	 * set uobjpage to PGO_DONTCARE if we are doing a zero fill.  if we
1316 	 * have a backing object, check and see if we are going to promote
1317 	 * the data up to an anon during the fault.
1318 	 */
1319 
1320 	if (uobj == NULL) {
1321 		uobjpage = PGO_DONTCARE;
1322 		promote = TRUE;		/* always need anon here */
1323 	} else {
1324 		/* assert(uobjpage != PGO_DONTCARE) */
1325 		promote = (access_type & VM_PROT_WRITE) &&
1326 		     UVM_ET_ISCOPYONWRITE(ufi.entry);
1327 	}
1328 	UVMHIST_LOG(maphist, "  case 2 fault: promote=%d, zfill=%d",
1329 	    promote, (uobj == NULL), 0,0);
1330 
1331 	/*
1332 	 * if uobjpage is not null then we do not need to do I/O to get the
1333 	 * uobjpage.
1334 	 *
1335 	 * if uobjpage is null, then we need to unlock and ask the pager to
1336 	 * get the data for us.   once we have the data, we need to reverify
1337 	 * the state the world.   we are currently not holding any resources.
1338 	 */
1339 
1340 	if (uobjpage) {
1341 		/* update rusage counters */
1342 		curproc->p_addr->u_stats.p_ru.ru_minflt++;
1343 	} else {
1344 		/* update rusage counters */
1345 		curproc->p_addr->u_stats.p_ru.ru_majflt++;
1346 
1347 		/* locked: maps(read), amap(if there), uobj */
1348 		uvmfault_unlockall(&ufi, amap, NULL, NULL);
1349 		/* locked: uobj */
1350 
1351 		uvmexp.fltget++;
1352 		gotpages = 1;
1353 		result = uobj->pgops->pgo_get(uobj,
1354 		    (ufi.orig_rvaddr - ufi.entry->start) + ufi.entry->offset,
1355 		    &uobjpage, &gotpages, 0,
1356 			access_type & MASK(ufi.entry),
1357 			ufi.entry->advice, 0);
1358 
1359 		/* locked: uobjpage(if result OK) */
1360 
1361 		/*
1362 		 * recover from I/O
1363 		 */
1364 
1365 		if (result != VM_PAGER_OK) {
1366 #ifdef DIAGNOSTIC
1367 			if (result == VM_PAGER_PEND)
1368 				panic("uvm_fault: pgo_get got PENDing "
1369 				    "on non-async I/O");
1370 #endif
1371 
1372 			if (result == VM_PAGER_AGAIN) {
1373 				UVMHIST_LOG(maphist,
1374 				    "  pgo_get says TRY AGAIN!",0,0,0,0);
1375 				tsleep((caddr_t)&lbolt, PVM, "fltagain2", 0);
1376 				goto ReFault;
1377 			}
1378 
1379 			UVMHIST_LOG(maphist, "<- pgo_get failed (code %d)",
1380 			    result, 0,0,0);
1381 			return (KERN_PROTECTION_FAILURE); /* XXX i/o error */
1382 		}
1383 
1384 		/* locked: uobjpage */
1385 
1386 		/*
1387 		 * re-verify the state of the world by first trying to relock
1388 		 * the maps.  always relock the object.
1389 		 */
1390 
1391 		locked = uvmfault_relock(&ufi);
1392 		if (locked && amap)
1393 			amap_lock(amap);
1394 		simple_lock(&uobj->vmobjlock);
1395 
1396 		/* locked(locked): maps(read), amap(if !null), uobj, uobjpage */
1397 		/* locked(!locked): uobj, uobjpage */
1398 
1399 		/*
1400 		 * verify that the page has not be released and re-verify
1401 		 * that amap slot is still free.   if there is a problem,
1402 		 * we unlock and clean up.
1403 		 */
1404 
1405 		if ((uobjpage->flags & PG_RELEASED) != 0 ||
1406 		    (locked && amap &&
1407 		    amap_lookup(&ufi.entry->aref,
1408 		      ufi.orig_rvaddr - ufi.entry->start))) {
1409 			if (locked)
1410 				uvmfault_unlockall(&ufi, amap, NULL, NULL);
1411 			locked = FALSE;
1412 		}
1413 
1414 		/*
1415 		 * didn't get the lock?   release the page and retry.
1416 		 */
1417 
1418 		if (locked == FALSE) {
1419 
1420 			UVMHIST_LOG(maphist,
1421 			    "  wasn't able to relock after fault: retry",
1422 			    0,0,0,0);
1423 			if (uobjpage->flags & PG_WANTED)
1424 				/* still holding object lock */
1425 				wakeup(uobjpage);
1426 
1427 			if (uobjpage->flags & PG_RELEASED) {
1428 				uvmexp.fltpgrele++;
1429 #ifdef DIAGNOSTIC
1430 				if (uobj->pgops->pgo_releasepg == NULL)
1431 					panic("uvm_fault: object has no "
1432 					    "releasepg function");
1433 #endif
1434 				/* frees page */
1435 				if (uobj->pgops->pgo_releasepg(uobjpage,NULL))
1436 					/* unlock if still alive */
1437 					simple_unlock(&uobj->vmobjlock);
1438 				goto ReFault;
1439 			}
1440 
1441 			uvm_lock_pageq();
1442 			/* make sure it is in queues */
1443 			uvm_pageactivate(uobjpage);
1444 
1445 			uvm_unlock_pageq();
1446 			uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
1447 			UVM_PAGE_OWN(uobjpage, NULL);
1448 			simple_unlock(&uobj->vmobjlock);
1449 			goto ReFault;
1450 
1451 		}
1452 
1453 		/*
1454 		 * we have the data in uobjpage which is PG_BUSY and
1455 		 * !PG_RELEASED.  we are holding object lock (so the page
1456 		 * can't be released on us).
1457 		 */
1458 
1459 		/* locked: maps(read), amap(if !null), uobj, uobjpage */
1460 
1461 	}
1462 
1463 	/*
1464 	 * locked:
1465 	 * maps(read), amap(if !null), uobj(if !null), uobjpage(if uobj)
1466 	 */
1467 
1468 	/*
1469 	 * notes:
1470 	 *  - at this point uobjpage can not be NULL
1471 	 *  - at this point uobjpage can not be PG_RELEASED (since we checked
1472 	 *  for it above)
1473 	 *  - at this point uobjpage could be PG_WANTED (handle later)
1474 	 */
1475 
1476 	if (promote == FALSE) {
1477 
1478 		/*
1479 		 * we are not promoting.   if the mapping is COW ensure that we
1480 		 * don't give more access than we should (e.g. when doing a read
1481 		 * fault on a COPYONWRITE mapping we want to map the COW page in
1482 		 * R/O even though the entry protection could be R/W).
1483 		 *
1484 		 * set "pg" to the page we want to map in (uobjpage, usually)
1485 		 */
1486 
1487 		uvmexp.flt_obj++;
1488 		if (UVM_ET_ISCOPYONWRITE(ufi.entry))
1489 			enter_prot &= ~VM_PROT_WRITE;
1490 		pg = uobjpage;		/* map in the actual object */
1491 
1492 		/* assert(uobjpage != PGO_DONTCARE) */
1493 
1494 		/*
1495 		 * we are faulting directly on the page.   be careful
1496 		 * about writing to loaned pages...
1497 		 */
1498 		if (uobjpage->loan_count) {
1499 
1500 			if ((access_type & VM_PROT_WRITE) == 0) {
1501 				/* read fault: cap the protection at readonly */
1502 				/* cap! */
1503 				enter_prot = enter_prot & ~VM_PROT_WRITE;
1504 			} else {
1505 				/* write fault: must break the loan here */
1506 
1507 				/* alloc new un-owned page */
1508 				pg = uvm_pagealloc(NULL, 0, NULL, 0);
1509 
1510 				if (pg == NULL) {
1511 					/*
1512 					 * drop ownership of page, it can't
1513 					 * be released
1514 					 */
1515 					if (uobjpage->flags & PG_WANTED)
1516 						wakeup(uobjpage);
1517 					uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
1518 					UVM_PAGE_OWN(uobjpage, NULL);
1519 
1520 					uvm_lock_pageq();
1521 					/* activate: we will need it later */
1522 					uvm_pageactivate(uobjpage);
1523 
1524 					uvm_unlock_pageq();
1525 					uvmfault_unlockall(&ufi, amap, uobj,
1526 					  NULL);
1527 					UVMHIST_LOG(maphist,
1528 					  "  out of RAM breaking loan, waiting",
1529 					  0,0,0,0);
1530 					uvmexp.fltnoram++;
1531 					uvm_wait("flt_noram4");
1532 					goto ReFault;
1533 				}
1534 
1535 				/*
1536 				 * copy the data from the old page to the new
1537 				 * one and clear the fake/clean flags on the
1538 				 * new page (keep it busy).  force a reload
1539 				 * of the old page by clearing it from all
1540 				 * pmaps.  then lock the page queues to
1541 				 * rename the pages.
1542 				 */
1543 				uvm_pagecopy(uobjpage, pg);	/* old -> new */
1544 				pg->flags &= ~(PG_FAKE|PG_CLEAN);
1545 				pmap_page_protect(uobjpage, VM_PROT_NONE);
1546 				if (uobjpage->flags & PG_WANTED)
1547 					wakeup(uobjpage);
1548 				/* uobj still locked */
1549 				uobjpage->flags &= ~(PG_WANTED|PG_BUSY);
1550 				UVM_PAGE_OWN(uobjpage, NULL);
1551 
1552 				uvm_lock_pageq();
1553 				offset = uobjpage->offset;
1554 				/* remove old page */
1555 				uvm_pagerealloc(uobjpage, NULL, 0);
1556 
1557 				/*
1558 				 * at this point we have absolutely no
1559 				 * control over uobjpage
1560 				 */
1561 				/* install new page */
1562 				uvm_pagerealloc(pg, uobj, offset);
1563 				uvm_unlock_pageq();
1564 
1565 				/*
1566 				 * done!  loan is broken and "pg" is
1567 				 * PG_BUSY.   it can now replace uobjpage.
1568 				 */
1569 
1570 				uobjpage = pg;
1571 
1572 			}		/* write fault case */
1573 		}		/* if loan_count */
1574 
1575 	} else {
1576 
1577 		/*
1578 		 * if we are going to promote the data to an anon we
1579 		 * allocate a blank anon here and plug it into our amap.
1580 		 */
1581 #if DIAGNOSTIC
1582 		if (amap == NULL)
1583 			panic("uvm_fault: want to promote data, but no anon");
1584 #endif
1585 
1586 		anon = uvm_analloc();
1587 		if (anon)
1588 			pg = uvm_pagealloc(NULL, 0, anon, 0);
1589 #ifdef __GNUC__
1590 		else
1591 			pg = NULL; /* XXX: gcc */
1592 #endif
1593 
1594 		/*
1595 		 * out of memory resources?
1596 		 */
1597 		if (anon == NULL || pg == NULL) {
1598 
1599 			/*
1600 			 * arg!  must unbusy our page and fail or sleep.
1601 			 */
1602 			if (uobjpage != PGO_DONTCARE) {
1603 				if (uobjpage->flags & PG_WANTED)
1604 					/* still holding object lock */
1605 					wakeup(uobjpage);
1606 
1607 				uvm_lock_pageq();
1608 				/* make sure it is in queues */
1609 				uvm_pageactivate(uobjpage);
1610 				uvm_unlock_pageq();
1611 				/* un-busy! (still locked) */
1612 				uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
1613 				UVM_PAGE_OWN(uobjpage, NULL);
1614 			}
1615 
1616 			/* unlock and fail ... */
1617 			uvmfault_unlockall(&ufi, amap, uobj, NULL);
1618 #ifdef DIAGNOSTIC
1619 			if (uvmexp.swpgonly > uvmexp.swpages) {
1620 				panic("uvmexp.swpgonly botch");
1621 			}
1622 #endif
1623 			if (anon == NULL || uvmexp.swpgonly == uvmexp.swpages) {
1624 				UVMHIST_LOG(maphist, "  promote: out of VM",
1625 				    0,0,0,0);
1626 				uvmexp.fltnoanon++;
1627 				return (KERN_RESOURCE_SHORTAGE);
1628 			}
1629 
1630 			UVMHIST_LOG(maphist, "  out of RAM, waiting for more",
1631 			    0,0,0,0);
1632 			uvm_anfree(anon);
1633 			uvmexp.fltnoram++;
1634 			uvm_wait("flt_noram5");
1635 			goto ReFault;
1636 		}
1637 
1638 		/*
1639 		 * fill in the data
1640 		 */
1641 
1642 		if (uobjpage != PGO_DONTCARE) {
1643 			uvmexp.flt_prcopy++;
1644 			/* copy page [pg now dirty] */
1645 			uvm_pagecopy(uobjpage, pg);
1646 
1647 			/*
1648 			 * promote to shared amap?  make sure all sharing
1649 			 * procs see it
1650 			 */
1651 			if ((amap_flags(amap) & AMAP_SHARED) != 0) {
1652 				pmap_page_protect(uobjpage, VM_PROT_NONE);
1653 			}
1654 
1655 			/*
1656 			 * dispose of uobjpage.  it can't be PG_RELEASED
1657 			 * since we still hold the object lock.   drop
1658 			 * handle to uobj as well.
1659 			 */
1660 
1661 			if (uobjpage->flags & PG_WANTED)
1662 				/* still have the obj lock */
1663 				wakeup(uobjpage);
1664 			uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
1665 			UVM_PAGE_OWN(uobjpage, NULL);
1666 			uvm_lock_pageq();
1667 			uvm_pageactivate(uobjpage);	/* put it back */
1668 			uvm_unlock_pageq();
1669 			simple_unlock(&uobj->vmobjlock);
1670 			uobj = NULL;
1671 			UVMHIST_LOG(maphist,
1672 			    "  promote uobjpage 0x%x to anon/page 0x%x/0x%x",
1673 			    uobjpage, anon, pg, 0);
1674 
1675 		} else {
1676 			uvmexp.flt_przero++;
1677 			uvm_pagezero(pg);	/* zero page [pg now dirty] */
1678 			UVMHIST_LOG(maphist,"  zero fill anon/page 0x%x/0%x",
1679 			    anon, pg, 0, 0);
1680 		}
1681 
1682 		amap_add(&ufi.entry->aref, ufi.orig_rvaddr - ufi.entry->start,
1683 		    anon, 0);
1684 
1685 	}
1686 
1687 	/*
1688 	 * locked:
1689 	 * maps(read), amap(if !null), uobj(if !null), uobjpage(if uobj)
1690 	 *
1691 	 * note: pg is either the uobjpage or the new page in the new anon
1692 	 */
1693 
1694 	/*
1695 	 * all resources are present.   we can now map it in and free our
1696 	 * resources.
1697 	 */
1698 
1699 	UVMHIST_LOG(maphist,
1700 	    "  MAPPING: case2: pm=0x%x, va=0x%x, pg=0x%x, promote=%d",
1701 	    ufi.orig_map->pmap, ufi.orig_rvaddr, pg, promote);
1702 	if (pmap_enter(ufi.orig_map->pmap, ufi.orig_rvaddr, VM_PAGE_TO_PHYS(pg),
1703 	    enter_prot, access_type | PMAP_CANFAIL | (wired ? PMAP_WIRED : 0))
1704 	    != KERN_SUCCESS) {
1705 		/*
1706 		 * No need to undo what we did; we can simply think of
1707 		 * this as the pmap throwing away the mapping information.
1708 		 *
1709 		 * We do, however, have to go through the ReFault path,
1710 		 * as the map may change while we're asleep.
1711 		 */
1712 		if (pg->flags & PG_WANTED)
1713 			wakeup(pg);		/* lock still held */
1714 
1715 		/*
1716 		 * note that pg can't be PG_RELEASED since we did not drop
1717 		 * the object lock since the last time we checked.
1718 		 */
1719 
1720 		pg->flags &= ~(PG_BUSY|PG_FAKE|PG_WANTED);
1721 		UVM_PAGE_OWN(pg, NULL);
1722 		uvmfault_unlockall(&ufi, amap, uobj, NULL);
1723 #ifdef DIAGNOSTIC
1724 		if (uvmexp.swpgonly > uvmexp.swpages)
1725 			panic("uvmexp.swpgonly botch");
1726 #endif
1727 		if (uvmexp.swpgonly == uvmexp.swpages) {
1728 			UVMHIST_LOG(maphist,
1729 			    "<- failed.  out of VM",0,0,0,0);
1730 			/* XXX instrumentation */
1731 			return (KERN_RESOURCE_SHORTAGE);
1732 		}
1733 		/* XXX instrumentation */
1734 		uvm_wait("flt_pmfail2");
1735 		goto ReFault;
1736 	}
1737 
1738 	uvm_lock_pageq();
1739 
1740 	if (fault_type == VM_FAULT_WIRE) {
1741 		uvm_pagewire(pg);
1742 		if (pg->pqflags & PQ_AOBJ) {
1743 
1744 			/*
1745 			 * since the now-wired page cannot be paged out,
1746 			 * release its swap resources for others to use.
1747 			 * since an aobj page with no swap cannot be PG_CLEAN,
1748 			 * clear its clean flag now.
1749 			 */
1750 
1751 			pg->flags &= ~(PG_CLEAN);
1752 			uao_dropswap(uobj, pg->offset >> PAGE_SHIFT);
1753 		}
1754 	} else {
1755 		/* activate it */
1756 		uvm_pageactivate(pg);
1757 	}
1758 
1759 	uvm_unlock_pageq();
1760 
1761 	if (pg->flags & PG_WANTED)
1762 		wakeup(pg);		/* lock still held */
1763 
1764 	/*
1765 	 * note that pg can't be PG_RELEASED since we did not drop the object
1766 	 * lock since the last time we checked.
1767 	 */
1768 
1769 	pg->flags &= ~(PG_BUSY|PG_FAKE|PG_WANTED);
1770 	UVM_PAGE_OWN(pg, NULL);
1771 	uvmfault_unlockall(&ufi, amap, uobj, NULL);
1772 
1773 	UVMHIST_LOG(maphist, "<- done (SUCCESS!)",0,0,0,0);
1774 	return (KERN_SUCCESS);
1775 }
1776 
1777 
1778 /*
1779  * uvm_fault_wire: wire down a range of virtual addresses in a map.
1780  *
1781  * => map may be read-locked by caller, but MUST NOT be write-locked.
1782  * => if map is read-locked, any operations which may cause map to
1783  *	be write-locked in uvm_fault() must be taken care of by
1784  *	the caller.  See uvm_map_pageable().
1785  */
1786 
1787 int
1788 uvm_fault_wire(map, start, end, access_type)
1789 	vm_map_t map;
1790 	vaddr_t start, end;
1791 	vm_prot_t access_type;
1792 {
1793 	vaddr_t va;
1794 	pmap_t  pmap;
1795 	int rv;
1796 
1797 	pmap = vm_map_pmap(map);
1798 
1799 	/*
1800 	 * fault it in page at a time.   if the fault fails then we have
1801 	 * to undo what we have done.
1802 	 */
1803 
1804 	for (va = start ; va < end ; va += PAGE_SIZE) {
1805 		rv = uvm_fault(map, va, VM_FAULT_WIRE, access_type);
1806 		if (rv) {
1807 			if (va != start) {
1808 				uvm_fault_unwire(map, start, va);
1809 			}
1810 			return (rv);
1811 		}
1812 	}
1813 
1814 	return (KERN_SUCCESS);
1815 }
1816 
1817 /*
1818  * uvm_fault_unwire(): unwire range of virtual space.
1819  */
1820 
1821 void
1822 uvm_fault_unwire(map, start, end)
1823 	vm_map_t map;
1824 	vaddr_t start, end;
1825 {
1826 
1827 	vm_map_lock_read(map);
1828 	uvm_fault_unwire_locked(map, start, end);
1829 	vm_map_unlock_read(map);
1830 }
1831 
1832 /*
1833  * uvm_fault_unwire_locked(): the guts of uvm_fault_unwire().
1834  *
1835  * => map must be at least read-locked.
1836  */
1837 
1838 void
1839 uvm_fault_unwire_locked(map, start, end)
1840 	vm_map_t map;
1841 	vaddr_t start, end;
1842 {
1843 	vm_map_entry_t entry;
1844 	pmap_t pmap = vm_map_pmap(map);
1845 	vaddr_t va;
1846 	paddr_t pa;
1847 	struct vm_page *pg;
1848 
1849 #ifdef DIAGNOSTIC
1850 	if (map->flags & VM_MAP_INTRSAFE)
1851 		panic("uvm_fault_unwire_locked: intrsafe map");
1852 #endif
1853 
1854 	/*
1855 	 * we assume that the area we are unwiring has actually been wired
1856 	 * in the first place.   this means that we should be able to extract
1857 	 * the PAs from the pmap.   we also lock out the page daemon so that
1858 	 * we can call uvm_pageunwire.
1859 	 */
1860 
1861 	uvm_lock_pageq();
1862 
1863 	/*
1864 	 * find the beginning map entry for the region.
1865 	 */
1866 #ifdef DIAGNOSTIC
1867 	if (start < vm_map_min(map) || end > vm_map_max(map))
1868 		panic("uvm_fault_unwire_locked: address out of range");
1869 #endif
1870 	if (uvm_map_lookup_entry(map, start, &entry) == FALSE)
1871 		panic("uvm_fault_unwire_locked: address not in map");
1872 
1873 	for (va = start; va < end ; va += PAGE_SIZE) {
1874 		if (pmap_extract(pmap, va, &pa) == FALSE)
1875 			panic("uvm_fault_unwire_locked: unwiring "
1876 			    "non-wired memory");
1877 
1878 		/*
1879 		 * make sure the current entry is for the address we're
1880 		 * dealing with.  if not, grab the next entry.
1881 		 */
1882 #ifdef DIAGNOSTIC
1883 		if (va < entry->start)
1884 			panic("uvm_fault_unwire_locked: hole 1");
1885 #endif
1886 		if (va >= entry->end) {
1887 #ifdef DIAGNOSTIC
1888 			if (entry->next == &map->header ||
1889 			    entry->next->start > entry->end)
1890 				panic("uvm_fault_unwire_locked: hole 2");
1891 #endif
1892 			entry = entry->next;
1893 		}
1894 
1895 		/*
1896 		 * if the entry is no longer wired, tell the pmap.
1897 		 */
1898 		if (VM_MAPENT_ISWIRED(entry) == 0)
1899 			pmap_unwire(pmap, va);
1900 
1901 		pg = PHYS_TO_VM_PAGE(pa);
1902 		if (pg)
1903 			uvm_pageunwire(pg);
1904 	}
1905 
1906 	uvm_unlock_pageq();
1907 }
1908