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