Home | History | Annotate | Line # | Download | only in uvm
uvm_fault.c revision 1.25
      1 /*	$NetBSD: uvm_fault.c,v 1.25 1999/03/28 21:01:25 mycroft 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(PMAP_PGARG(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);
    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 				thread_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(PMAP_PGARG(pg),
    453 				    VM_PROT_NONE); /* to be safe */
    454 				simple_unlock(&anon->an_lock);
    455 				uvm_anfree(anon);	/* frees page for us */
    456 				if (locked)
    457 				  uvmfault_unlockall(ufi, amap, NULL, NULL);
    458 				uvmexp.fltpgrele++;
    459 				UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
    460 				return (VM_PAGER_REFAULT);	/* refault! */
    461 			}
    462 
    463 			if (result != VM_PAGER_OK) {
    464 #ifdef DIAGNOSTIC
    465 				if (result == VM_PAGER_PEND)
    466 		panic("uvmfault_anonget: got PENDING for non-async I/O");
    467 #endif
    468 				/* remove page from anon */
    469 				anon->u.an_page = NULL;
    470 
    471 				/*
    472 				 * note: page was never !PG_BUSY, so it
    473 				 * can't be mapped and thus no need to
    474 				 * pmap_page_protect it...
    475 				 */
    476 				uvm_lock_pageq();
    477 				uvm_pagefree(pg);
    478 				uvm_unlock_pageq();
    479 
    480 				if (locked)
    481 					uvmfault_unlockall(ufi, amap, NULL,
    482 					    anon);
    483 				else
    484 					simple_unlock(&anon->an_lock);
    485 				UVMHIST_LOG(maphist, "<- ERROR", 0,0,0,0);
    486 				return (VM_PAGER_ERROR);
    487 			}
    488 
    489 			/*
    490 			 * must be OK, clear modify (already PG_CLEAN)
    491 			 * and activate
    492 			 */
    493 			pmap_clear_modify(PMAP_PGARG(pg));
    494 			uvm_lock_pageq();
    495 			uvm_pageactivate(pg);
    496 			uvm_unlock_pageq();
    497 			if (!locked)
    498 				simple_unlock(&anon->an_lock);
    499 		}
    500 
    501 		/*
    502 		 * we were not able to relock.   restart fault.
    503 		 */
    504 
    505 		if (!locked) {
    506 			UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
    507 			return (VM_PAGER_REFAULT);
    508 		}
    509 
    510 		/*
    511 		 * verify no one has touched the amap and moved the anon on us.
    512 		 */
    513 
    514 		if (amap_lookup(&ufi->entry->aref,
    515 		    ufi->orig_rvaddr - ufi->entry->start) != anon) {
    516 
    517 			uvmfault_unlockall(ufi, amap, NULL, anon);
    518 			UVMHIST_LOG(maphist, "<- REFAULT", 0,0,0,0);
    519 			return (VM_PAGER_REFAULT);
    520 		}
    521 
    522 		/*
    523 		 * try it again!
    524 		 */
    525 
    526 		uvmexp.fltanretry++;
    527 		continue;
    528 
    529 	} /* while (1) */
    530 
    531 	/*NOTREACHED*/
    532 }
    533 
    534 /*
    535  *   F A U L T   -   m a i n   e n t r y   p o i n t
    536  */
    537 
    538 /*
    539  * uvm_fault: page fault handler
    540  *
    541  * => called from MD code to resolve a page fault
    542  * => VM data structures usually should be unlocked.   however, it is
    543  *	possible to call here with the main map locked if the caller
    544  *	gets a write lock, sets it recusive, and then calls us (c.f.
    545  *	uvm_map_pageable).   this should be avoided because it keeps
    546  *	the map locked off during I/O.
    547  */
    548 
    549 #define MASK(entry)     (UVM_ET_ISCOPYONWRITE(entry) ? \
    550 			 ~VM_PROT_WRITE : VM_PROT_ALL)
    551 
    552 int
    553 uvm_fault(orig_map, vaddr, fault_type, access_type)
    554 	vm_map_t orig_map;
    555 	vaddr_t vaddr;
    556 	vm_fault_t fault_type;
    557 	vm_prot_t access_type;
    558 {
    559 	struct uvm_faultinfo ufi;
    560 	vm_prot_t enter_prot;
    561 	boolean_t wired, narrow, promote, locked, shadowed;
    562 	int npages, nback, nforw, centeridx, result, lcv, gotpages;
    563 	vaddr_t startva, objaddr, currva, offset;
    564 	paddr_t pa;
    565 	struct vm_amap *amap;
    566 	struct uvm_object *uobj;
    567 	struct vm_anon *anons_store[UVM_MAXRANGE], **anons, *anon, *oanon;
    568 	struct vm_page *pages[UVM_MAXRANGE], *pg, *uobjpage;
    569 	UVMHIST_FUNC("uvm_fault"); UVMHIST_CALLED(maphist);
    570 
    571 	UVMHIST_LOG(maphist, "(map=0x%x, vaddr=0x%x, ft=%d, at=%d)",
    572 	      orig_map, vaddr, fault_type, access_type);
    573 
    574 	anon = NULL; /* XXX: shut up gcc */
    575 
    576 	uvmexp.faults++;	/* XXX: locking? */
    577 
    578 	/*
    579 	 * init the IN parameters in the ufi
    580 	 */
    581 
    582 	ufi.orig_map = orig_map;
    583 	ufi.orig_rvaddr = trunc_page(vaddr);
    584 	ufi.orig_size = PAGE_SIZE;	/* can't get any smaller than this */
    585 	if (fault_type == VM_FAULT_WIRE)
    586 		narrow = TRUE;		/* don't look for neighborhood
    587 					 * pages on wire */
    588 	else
    589 		narrow = FALSE;		/* normal fault */
    590 
    591 	/*
    592 	 * "goto ReFault" means restart the page fault from ground zero.
    593 	 */
    594 ReFault:
    595 
    596 	/*
    597 	 * lookup and lock the maps
    598 	 */
    599 
    600 	if (uvmfault_lookup(&ufi, FALSE) == FALSE) {
    601 		UVMHIST_LOG(maphist, "<- no mapping @ 0x%x", vaddr, 0,0,0);
    602 		return (KERN_INVALID_ADDRESS);
    603 	}
    604 	/* locked: maps(read) */
    605 
    606 	/*
    607 	 * check protection
    608 	 */
    609 
    610 	if ((ufi.entry->protection & access_type) != access_type) {
    611 		UVMHIST_LOG(maphist,
    612 		    "<- protection failure (prot=0x%x, access=0x%x)",
    613 		    ufi.entry->protection, access_type, 0, 0);
    614 		uvmfault_unlockmaps(&ufi, FALSE);
    615 		return (KERN_PROTECTION_FAILURE);
    616 	}
    617 
    618 	/*
    619 	 * "enter_prot" is the protection we want to enter the page in at.
    620 	 * for certain pages (e.g. copy-on-write pages) this protection can
    621 	 * be more strict than ufi.entry->protection.  "wired" means either
    622 	 * the entry is wired or we are fault-wiring the pg.
    623 	 */
    624 
    625 	enter_prot = ufi.entry->protection;
    626 	wired = (ufi.entry->wired_count != 0) || (fault_type == VM_FAULT_WIRE);
    627 	if (wired)
    628 		access_type = enter_prot; /* full access for wired */
    629 
    630 	/*
    631 	 * handle "needs_copy" case.   if we need to copy the amap we will
    632 	 * have to drop our readlock and relock it with a write lock.  (we
    633 	 * need a write lock to change anything in a map entry [e.g.
    634 	 * needs_copy]).
    635 	 */
    636 
    637 	if (UVM_ET_ISNEEDSCOPY(ufi.entry)) {
    638 		if ((access_type & VM_PROT_WRITE) ||
    639 		    (ufi.entry->object.uvm_obj == NULL)) {
    640 			/* need to clear */
    641 			UVMHIST_LOG(maphist,
    642 			    "  need to clear needs_copy and refault",0,0,0,0);
    643 			uvmfault_unlockmaps(&ufi, FALSE);
    644 			uvmfault_amapcopy(&ufi);
    645 			uvmexp.fltamcopy++;
    646 			goto ReFault;
    647 
    648 		} else {
    649 
    650 			/*
    651 			 * ensure that we pmap_enter page R/O since
    652 			 * needs_copy is still true
    653 			 */
    654 			enter_prot &= ~VM_PROT_WRITE;
    655 
    656 		}
    657 	}
    658 
    659 	/*
    660 	 * identify the players
    661 	 */
    662 
    663 	amap = ufi.entry->aref.ar_amap;	/* top layer */
    664 	uobj = ufi.entry->object.uvm_obj;	/* bottom layer */
    665 
    666 	/*
    667 	 * check for a case 0 fault.  if nothing backing the entry then
    668 	 * error now.
    669 	 */
    670 
    671 	if (amap == NULL && uobj == NULL) {
    672 		uvmfault_unlockmaps(&ufi, FALSE);
    673 		UVMHIST_LOG(maphist,"<- no backing store, no overlay",0,0,0,0);
    674 		return (KERN_INVALID_ADDRESS);
    675 	}
    676 
    677 	/*
    678 	 * establish range of interest based on advice from mapper
    679 	 * and then clip to fit map entry.   note that we only want
    680 	 * to do this the first time through the fault.   if we
    681 	 * ReFault we will disable this by setting "narrow" to true.
    682 	 */
    683 
    684 	if (narrow == FALSE) {
    685 
    686 		/* wide fault (!narrow) */
    687 #ifdef DIAGNOSTIC
    688 		if (uvmadvice[ufi.entry->advice].advice != ufi.entry->advice)
    689 			panic("fault: advice mismatch!");
    690 #endif
    691 		nback = min(uvmadvice[ufi.entry->advice].nback,
    692 			    (ufi.orig_rvaddr - ufi.entry->start) >> PAGE_SHIFT);
    693 		startva = ufi.orig_rvaddr - (nback << PAGE_SHIFT);
    694 		nforw = min(uvmadvice[ufi.entry->advice].nforw,
    695 			    ((ufi.entry->end - ufi.orig_rvaddr) >>
    696 			     PAGE_SHIFT) - 1);
    697 		/*
    698 		 * note: "-1" because we don't want to count the
    699 		 * faulting page as forw
    700 		 */
    701 		npages = nback + nforw + 1;
    702 		centeridx = nback;
    703 
    704 		narrow = FALSE;	/* ensure only once per-fault */
    705 
    706 	} else {
    707 
    708 		/* narrow fault! */
    709 		nback = nforw = 0;
    710 		startva = ufi.orig_rvaddr;
    711 		npages = 1;
    712 		centeridx = 0;
    713 
    714 	}
    715 
    716 	/* locked: maps(read) */
    717 	UVMHIST_LOG(maphist, "  narrow=%d, back=%d, forw=%d, startva=0x%x",
    718 		    narrow, nback, nforw, startva);
    719 	UVMHIST_LOG(maphist, "  entry=0x%x, amap=0x%x, obj=0x%x", ufi.entry,
    720 		    amap, uobj, 0);
    721 
    722 	/*
    723 	 * if we've got an amap, lock it and extract current anons.
    724 	 */
    725 
    726 	if (amap) {
    727 		amap_lock(amap);
    728 		anons = anons_store;
    729 		amap_lookups(&ufi.entry->aref, startva - ufi.entry->start,
    730 		    anons, npages);
    731 	} else {
    732 		anons = NULL;	/* to be safe */
    733 	}
    734 
    735 	/* locked: maps(read), amap(if there) */
    736 
    737 	/*
    738 	 * for MADV_SEQUENTIAL mappings we want to deactivate the back pages
    739 	 * now and then forget about them (for the rest of the fault).
    740 	 */
    741 
    742 	if (ufi.entry->advice == MADV_SEQUENTIAL) {
    743 
    744 		UVMHIST_LOG(maphist, "  MADV_SEQUENTIAL: flushing backpages",
    745 		    0,0,0,0);
    746 		/* flush back-page anons? */
    747 		if (amap)
    748 			uvmfault_anonflush(anons, nback);
    749 
    750 		/* flush object? */
    751 		if (uobj) {
    752 			objaddr =
    753 			    (startva - ufi.entry->start) + ufi.entry->offset;
    754 			simple_lock(&uobj->vmobjlock);
    755 			(void) uobj->pgops->pgo_flush(uobj, objaddr, objaddr +
    756 				    (nback << PAGE_SHIFT), PGO_DEACTIVATE);
    757 			simple_unlock(&uobj->vmobjlock);
    758 		}
    759 
    760 		/* now forget about the backpages */
    761 		if (amap)
    762 			anons += nback;
    763 		startva = startva + (nback << PAGE_SHIFT);
    764 		npages -= nback;
    765 		nback = centeridx = 0;
    766 	}
    767 
    768 	/* locked: maps(read), amap(if there) */
    769 
    770 	/*
    771 	 * map in the backpages and frontpages we found in the amap in hopes
    772 	 * of preventing future faults.    we also init the pages[] array as
    773 	 * we go.
    774 	 */
    775 
    776 	currva = startva;
    777 	shadowed = FALSE;
    778 	for (lcv = 0 ; lcv < npages ; lcv++, currva += PAGE_SIZE) {
    779 
    780 		/*
    781 		 * dont play with VAs that are already mapped
    782 		 * except for center)
    783 		 * XXX: return value of pmap_extract disallows PA 0
    784 		 */
    785 		if (lcv != centeridx) {
    786 			pa = pmap_extract(ufi.orig_map->pmap, currva);
    787 			if (pa != NULL) {
    788 				pages[lcv] = PGO_DONTCARE;
    789 				continue;
    790 			}
    791 		}
    792 
    793 		/*
    794 		 * unmapped or center page.   check if any anon at this level.
    795 		 */
    796 		if (amap == NULL || anons[lcv] == NULL) {
    797 			pages[lcv] = NULL;
    798 			continue;
    799 		}
    800 
    801 		/*
    802 		 * check for present page and map if possible.   re-activate it.
    803 		 */
    804 
    805 		pages[lcv] = PGO_DONTCARE;
    806 		if (lcv == centeridx) {		/* save center for later! */
    807 			shadowed = TRUE;
    808 			continue;
    809 		}
    810 		anon = anons[lcv];
    811 		simple_lock(&anon->an_lock);
    812 		/* ignore loaned pages */
    813 		if (anon->u.an_page && anon->u.an_page->loan_count == 0 &&
    814 			(anon->u.an_page->flags & (PG_RELEASED|PG_BUSY)) == 0) {
    815 			uvm_lock_pageq();
    816 			uvm_pageactivate(anon->u.an_page);	/* reactivate */
    817 			uvm_unlock_pageq();
    818 			UVMHIST_LOG(maphist,
    819 			    "  MAPPING: n anon: pm=0x%x, va=0x%x, pg=0x%x",
    820 			    ufi.orig_map->pmap, currva, anon->u.an_page, 0);
    821 			uvmexp.fltnamap++;
    822 			pmap_enter(ufi.orig_map->pmap, currva,
    823 			    VM_PAGE_TO_PHYS(anon->u.an_page),
    824 			    (anon->an_ref > 1) ? (enter_prot & ~VM_PROT_WRITE) :
    825 			    enter_prot,
    826 			    (ufi.entry->wired_count != 0), 0);
    827 		}
    828 		simple_unlock(&anon->an_lock);
    829 	}
    830 
    831 	/* locked: maps(read), amap(if there) */
    832 	/* (shadowed == TRUE) if there is an anon at the faulting address */
    833 	UVMHIST_LOG(maphist, "  shadowed=%d, will_get=%d", shadowed,
    834 	    (uobj && shadowed == FALSE),0,0);
    835 
    836 	/*
    837 	 * note that if we are really short of RAM we could sleep in the above
    838 	 * call to pmap_enter with everything locked.   bad?
    839 	 * XXXCDC: this is fixed in PMAP_NEW (no sleep alloc's in pmap)
    840 	 */
    841 
    842 	/*
    843 	 * if the desired page is not shadowed by the amap and we have a
    844 	 * backing object, then we check to see if the backing object would
    845 	 * prefer to handle the fault itself (rather than letting us do it
    846 	 * with the usual pgo_get hook).  the backing object signals this by
    847 	 * providing a pgo_fault routine.
    848 	 */
    849 
    850 	if (uobj && shadowed == FALSE && uobj->pgops->pgo_fault != NULL) {
    851 
    852 		simple_lock(&uobj->vmobjlock);
    853 
    854 		/* locked: maps(read), amap (if there), uobj */
    855 		result = uobj->pgops->pgo_fault(&ufi, startva, pages, npages,
    856 				    centeridx, fault_type, access_type,
    857 				    PGO_LOCKED);
    858 		/* locked: nothing, pgo_fault has unlocked everything */
    859 
    860 		if (result == VM_PAGER_OK)
    861 			return (KERN_SUCCESS);	/* pgo_fault did pmap enter */
    862 		else if (result == VM_PAGER_REFAULT)
    863 			goto ReFault;		/* try again! */
    864 		else
    865 			return (KERN_PROTECTION_FAILURE);
    866 	}
    867 
    868 	/*
    869 	 * now, if the desired page is not shadowed by the amap and we have
    870 	 * a backing object that does not have a special fault routine, then
    871 	 * we ask (with pgo_get) the object for resident pages that we care
    872 	 * about and attempt to map them in.  we do not let pgo_get block
    873 	 * (PGO_LOCKED).
    874 	 *
    875 	 * ("get" has the option of doing a pmap_enter for us)
    876 	 */
    877 
    878 	if (uobj && shadowed == FALSE) {
    879 		simple_lock(&uobj->vmobjlock);
    880 
    881 		/* locked (!shadowed): maps(read), amap (if there), uobj */
    882 		/*
    883 		 * the following call to pgo_get does _not_ change locking state
    884 		 */
    885 
    886 		uvmexp.fltlget++;
    887 		gotpages = npages;
    888 		result = uobj->pgops->pgo_get(uobj, ufi.entry->offset +
    889 				(startva - ufi.entry->start),
    890 				pages, &gotpages, centeridx,
    891 				access_type & MASK(ufi.entry),
    892 				ufi.entry->advice, PGO_LOCKED);
    893 
    894 		/*
    895 		 * check for pages to map, if we got any
    896 		 */
    897 
    898 		uobjpage = NULL;
    899 
    900 		if (gotpages) {
    901 			currva = startva;
    902 			for (lcv = 0 ; lcv < npages ;
    903 			    lcv++, currva += PAGE_SIZE) {
    904 
    905 				if (pages[lcv] == NULL ||
    906 				    pages[lcv] == PGO_DONTCARE)
    907 					continue;
    908 
    909 #ifdef DIAGNOSTIC
    910 					/*
    911 					 * pager sanity check: pgo_get with
    912 					 * PGO_LOCKED should never return a
    913 					 * released page to us.
    914 					 */
    915 					if (pages[lcv]->flags & PG_RELEASED)
    916 		panic("uvm_fault: pgo_get PGO_LOCKED gave us a RELEASED page");
    917 #endif
    918 
    919 					/*
    920 					 * if center page is resident and not
    921 					 * PG_BUSY|PG_RELEASED then pgo_get
    922 					 * made it PG_BUSY for us and gave
    923 					 * us a handle to it.   remember this
    924 					 * page as "uobjpage." (for later use).
    925 					 */
    926 
    927 					if (lcv == centeridx) {
    928 						uobjpage = pages[lcv];
    929 	UVMHIST_LOG(maphist, "  got uobjpage (0x%x) with locked get",
    930 					    uobjpage, 0,0,0);
    931 						continue;
    932 				}
    933 
    934 				/*
    935 				 * note: calling pgo_get with locked data
    936 				 * structures returns us pages which are
    937 				 * neither busy nor released, so we don't
    938 				 * need to check for this.   we can just
    939 				 * directly enter the page (after moving it
    940 				 * to the head of the active queue [useful?]).
    941 				 */
    942 
    943 				uvm_lock_pageq();
    944 				uvm_pageactivate(pages[lcv]);	/* reactivate */
    945 				uvm_unlock_pageq();
    946 				UVMHIST_LOG(maphist,
    947 				  "  MAPPING: n obj: pm=0x%x, va=0x%x, pg=0x%x",
    948 				  ufi.orig_map->pmap, currva, pages[lcv], 0);
    949 				uvmexp.fltnomap++;
    950 				pmap_enter(ufi.orig_map->pmap, currva,
    951 				    VM_PAGE_TO_PHYS(pages[lcv]),
    952 				    enter_prot & MASK(ufi.entry),
    953 				    wired, access_type);
    954 
    955 				/*
    956 				 * NOTE: page can't be PG_WANTED or PG_RELEASED
    957 				 * because we've held the lock the whole time
    958 				 * we've had the handle.
    959 				 */
    960 				pages[lcv]->flags &= ~(PG_BUSY); /* un-busy! */
    961 				UVM_PAGE_OWN(pages[lcv], NULL);
    962 
    963 				/* done! */
    964 			}	/* for "lcv" loop */
    965 		}   /* "gotpages" != 0 */
    966 
    967 		/* note: object still _locked_ */
    968 	} else {
    969 
    970 		uobjpage = NULL;
    971 
    972 	}
    973 
    974 	/* locked (shadowed): maps(read), amap */
    975 	/* locked (!shadowed): maps(read), amap(if there),
    976 		 uobj(if !null), uobjpage(if !null) */
    977 
    978 	/*
    979 	 * note that at this point we are done with any front or back pages.
    980 	 * we are now going to focus on the center page (i.e. the one we've
    981 	 * faulted on).  if we have faulted on the top (anon) layer
    982 	 * [i.e. case 1], then the anon we want is anons[centeridx] (we have
    983 	 * not touched it yet).  if we have faulted on the bottom (uobj)
    984 	 * layer [i.e. case 2] and the page was both present and available,
    985 	 * then we've got a pointer to it as "uobjpage" and we've already
    986 	 * made it BUSY.
    987 	 */
    988 
    989 	/*
    990 	 * there are four possible cases we must address: 1A, 1B, 2A, and 2B
    991 	 */
    992 
    993 	/*
    994 	 * redirect case 2: if we are not shadowed, go to case 2.
    995 	 */
    996 
    997 	if (shadowed == FALSE)
    998 		goto Case2;
    999 
   1000 	/* locked: maps(read), amap */
   1001 
   1002 	/*
   1003 	 * handle case 1: fault on an anon in our amap
   1004 	 */
   1005 
   1006 	anon = anons[centeridx];
   1007 	UVMHIST_LOG(maphist, "  case 1 fault: anon=0x%x", anon, 0,0,0);
   1008 	simple_lock(&anon->an_lock);
   1009 
   1010 	/* locked: maps(read), amap, anon */
   1011 
   1012 	/*
   1013 	 * no matter if we have case 1A or case 1B we are going to need to
   1014 	 * have the anon's memory resident.   ensure that now.
   1015 	 */
   1016 
   1017 	/*
   1018 	 * let uvmfault_anonget do the dirty work.   if it fails (!OK) it will
   1019 	 * unlock for us.   if it is OK, locks are still valid and locked.
   1020 	 * also, if it is OK, then the anon's page is on the queues.
   1021 	 * if the page is on loan from a uvm_object, then anonget will
   1022 	 * lock that object for us if it does not fail.
   1023 	 */
   1024 
   1025 	result = uvmfault_anonget(&ufi, amap, anon);
   1026 
   1027 	if (result == VM_PAGER_REFAULT)
   1028 		goto ReFault;
   1029 
   1030 	if (result == VM_PAGER_AGAIN) {
   1031 		tsleep((caddr_t)&lbolt, PVM, "fltagain1", 0);
   1032 		goto ReFault;
   1033 	}
   1034 
   1035 	if (result != VM_PAGER_OK)
   1036 		return (KERN_PROTECTION_FAILURE);		/* XXX??? */
   1037 
   1038 	/*
   1039 	 * uobj is non null if the page is on loan from an object (i.e. uobj)
   1040 	 */
   1041 
   1042 	uobj = anon->u.an_page->uobject;	/* locked by anonget if !NULL */
   1043 
   1044 	/* locked: maps(read), amap, anon, uobj(if one) */
   1045 
   1046 	/*
   1047 	 * special handling for loaned pages
   1048 	 */
   1049 	if (anon->u.an_page->loan_count) {
   1050 
   1051 		if ((access_type & VM_PROT_WRITE) == 0) {
   1052 
   1053 			/*
   1054 			 * for read faults on loaned pages we just cap the
   1055 			 * protection at read-only.
   1056 			 */
   1057 
   1058 			enter_prot = enter_prot & ~VM_PROT_WRITE;
   1059 
   1060 		} else {
   1061 			/*
   1062 			 * note that we can't allow writes into a loaned page!
   1063 			 *
   1064 			 * if we have a write fault on a loaned page in an
   1065 			 * anon then we need to look at the anon's ref count.
   1066 			 * if it is greater than one then we are going to do
   1067 			 * a normal copy-on-write fault into a new anon (this
   1068 			 * is not a problem).  however, if the reference count
   1069 			 * is one (a case where we would normally allow a
   1070 			 * write directly to the page) then we need to kill
   1071 			 * the loan before we continue.
   1072 			 */
   1073 
   1074 			/* >1 case is already ok */
   1075 			if (anon->an_ref == 1) {
   1076 
   1077 				/* get new un-owned replacement page */
   1078 				pg = uvm_pagealloc(NULL, 0, NULL);
   1079 				if (pg == NULL) {
   1080 					uvmfault_unlockall(&ufi, amap, uobj,
   1081 					    anon);
   1082 					uvm_wait("flt_noram2");
   1083 					goto ReFault;
   1084 				}
   1085 
   1086 				/*
   1087 				 * copy data, kill loan, and drop uobj lock
   1088 				 * (if any)
   1089 				 */
   1090 				/* copy old -> new */
   1091 				uvm_pagecopy(anon->u.an_page, pg);
   1092 
   1093 				/* force reload */
   1094 				pmap_page_protect(PMAP_PGARG(anon->u.an_page),
   1095 				    VM_PROT_NONE);
   1096 				uvm_lock_pageq();	  /* KILL loan */
   1097 				if (uobj)
   1098 					/* if we were loaning */
   1099 					anon->u.an_page->loan_count--;
   1100 				anon->u.an_page->uanon = NULL;
   1101 				/* in case we owned */
   1102 				anon->u.an_page->pqflags &= ~PQ_ANON;
   1103 				uvm_unlock_pageq();
   1104 				if (uobj) {
   1105 					simple_unlock(&uobj->vmobjlock);
   1106 					uobj = NULL;
   1107 				}
   1108 
   1109 				/* install new page in anon */
   1110 				anon->u.an_page = pg;
   1111 				pg->uanon = anon;
   1112 				pg->pqflags |= PQ_ANON;
   1113 				pg->flags &= ~(PG_BUSY|PG_FAKE);
   1114 				UVM_PAGE_OWN(pg, NULL);
   1115 
   1116 				/* done! */
   1117 			}     /* ref == 1 */
   1118 		}       /* write fault */
   1119 	}         /* loan count */
   1120 
   1121 	/*
   1122 	 * if we are case 1B then we will need to allocate a new blank
   1123 	 * anon to transfer the data into.   note that we have a lock
   1124 	 * on anon, so no one can busy or release the page until we are done.
   1125 	 * also note that the ref count can't drop to zero here because
   1126 	 * it is > 1 and we are only dropping one ref.
   1127 	 *
   1128 	 * in the (hopefully very rare) case that we are out of RAM we
   1129 	 * will unlock, wait for more RAM, and refault.
   1130 	 *
   1131 	 * if we are out of anon VM we kill the process (XXX: could wait?).
   1132 	 */
   1133 
   1134 	if ((access_type & VM_PROT_WRITE) != 0 && anon->an_ref > 1) {
   1135 
   1136 		UVMHIST_LOG(maphist, "  case 1B: COW fault",0,0,0,0);
   1137 		uvmexp.flt_acow++;
   1138 		oanon = anon;		/* oanon = old, locked anon */
   1139 		anon = uvm_analloc();
   1140 		if (anon)
   1141 			pg = uvm_pagealloc(NULL, 0, anon);
   1142 #ifdef __GNUC__
   1143 		else
   1144 			pg = NULL; /* XXX: gcc */
   1145 #endif
   1146 
   1147 		/* check for out of RAM */
   1148 		if (anon == NULL || pg == NULL) {
   1149 			if (anon)
   1150 				uvm_anfree(anon);
   1151 			uvmfault_unlockall(&ufi, amap, uobj, oanon);
   1152 #ifdef DIAGNOSTIC
   1153 			if (uvmexp.swpgonly > uvmexp.swpages) {
   1154 				panic("uvmexp.swpgonly botch");
   1155 			}
   1156 #endif
   1157 			if (anon == NULL || uvmexp.swpgonly == uvmexp.swpages) {
   1158 				UVMHIST_LOG(maphist,
   1159 				    "<- failed.  out of VM",0,0,0,0);
   1160 				uvmexp.fltnoanon++;
   1161 				return (KERN_RESOURCE_SHORTAGE);
   1162 			}
   1163 
   1164 			uvmexp.fltnoram++;
   1165 			uvm_wait("flt_noram3");	/* out of RAM, wait for more */
   1166 			goto ReFault;
   1167 		}
   1168 
   1169 		/* got all resources, replace anon with nanon */
   1170 
   1171 		uvm_pagecopy(oanon->u.an_page, pg);	/* pg now !PG_CLEAN */
   1172 		pg->flags &= ~(PG_BUSY|PG_FAKE);	/* un-busy! new page */
   1173 		UVM_PAGE_OWN(pg, NULL);
   1174 		amap_add(&ufi.entry->aref, ufi.orig_rvaddr - ufi.entry->start,
   1175 		    anon, 1);
   1176 
   1177 		/* deref: can not drop to zero here by defn! */
   1178 		oanon->an_ref--;
   1179 
   1180 		/*
   1181 		 * note: oanon still locked.   anon is _not_ locked, but we
   1182 		 * have the sole references to in from amap which _is_ locked.
   1183 		 * thus, no one can get at it until we are done with it.
   1184 		 */
   1185 
   1186 	} else {
   1187 
   1188 		uvmexp.flt_anon++;
   1189 		oanon = anon;		/* old, locked anon is same as anon */
   1190 		pg = anon->u.an_page;
   1191 		if (anon->an_ref > 1)     /* disallow writes to ref > 1 anons */
   1192 			enter_prot = enter_prot & ~VM_PROT_WRITE;
   1193 
   1194 	}
   1195 
   1196 	/* locked: maps(read), amap, anon */
   1197 
   1198 	/*
   1199 	 * now map the page in ...
   1200 	 * XXX: old fault unlocks object before pmap_enter.  this seems
   1201 	 * suspect since some other thread could blast the page out from
   1202 	 * under us between the unlock and the pmap_enter.
   1203 	 */
   1204 
   1205 	UVMHIST_LOG(maphist, "  MAPPING: anon: pm=0x%x, va=0x%x, pg=0x%x",
   1206 	    ufi.orig_map->pmap, ufi.orig_rvaddr, pg, 0);
   1207 	pmap_enter(ufi.orig_map->pmap, ufi.orig_rvaddr, VM_PAGE_TO_PHYS(pg),
   1208 	    enter_prot, wired, access_type);
   1209 
   1210 	/*
   1211 	 * ... and update the page queues.
   1212 	 */
   1213 
   1214 	uvm_lock_pageq();
   1215 
   1216 	if (fault_type == VM_FAULT_WIRE) {
   1217 		uvm_pagewire(pg);
   1218 		uvm_anon_dropswap(anon);
   1219 	} else {
   1220 		/* activate it */
   1221 		uvm_pageactivate(pg);
   1222 
   1223 	}
   1224 
   1225 	uvm_unlock_pageq();
   1226 
   1227 	/*
   1228 	 * done case 1!  finish up by unlocking everything and returning success
   1229 	 */
   1230 
   1231 	uvmfault_unlockall(&ufi, amap, uobj, oanon);
   1232 	return (KERN_SUCCESS);
   1233 
   1234 
   1235 Case2:
   1236 	/*
   1237 	 * handle case 2: faulting on backing object or zero fill
   1238 	 */
   1239 
   1240 	/*
   1241 	 * locked:
   1242 	 * maps(read), amap(if there), uobj(if !null), uobjpage(if !null)
   1243 	 */
   1244 
   1245 	/*
   1246 	 * note that uobjpage can not be PGO_DONTCARE at this point.  we now
   1247 	 * set uobjpage to PGO_DONTCARE if we are doing a zero fill.  if we
   1248 	 * have a backing object, check and see if we are going to promote
   1249 	 * the data up to an anon during the fault.
   1250 	 */
   1251 
   1252 	if (uobj == NULL) {
   1253 		uobjpage = PGO_DONTCARE;
   1254 		promote = TRUE;		/* always need anon here */
   1255 	} else {
   1256 		/* assert(uobjpage != PGO_DONTCARE) */
   1257 		promote = (access_type & VM_PROT_WRITE) &&
   1258 		     UVM_ET_ISCOPYONWRITE(ufi.entry);
   1259 	}
   1260 	UVMHIST_LOG(maphist, "  case 2 fault: promote=%d, zfill=%d",
   1261 	promote, (uobj == NULL), 0,0);
   1262 
   1263 	/*
   1264 	 * if uobjpage is not null then we do not need to do I/O to get the
   1265 	 * uobjpage.
   1266 	 *
   1267 	 * if uobjpage is null, then we need to unlock and ask the pager to
   1268 	 * get the data for us.   once we have the data, we need to reverify
   1269 	 * the state the world.   we are currently not holding any resources.
   1270 	 */
   1271 
   1272 	if (uobjpage) {
   1273 		/* update rusage counters */
   1274 		curproc->p_addr->u_stats.p_ru.ru_minflt++;
   1275 	} else {
   1276 		/* update rusage counters */
   1277 		curproc->p_addr->u_stats.p_ru.ru_majflt++;
   1278 
   1279 		/* locked: maps(read), amap(if there), uobj */
   1280 		uvmfault_unlockall(&ufi, amap, NULL, NULL);
   1281 		/* locked: uobj */
   1282 
   1283 		uvmexp.fltget++;
   1284 		gotpages = 1;
   1285 		result = uobj->pgops->pgo_get(uobj,
   1286 		    (ufi.orig_rvaddr - ufi.entry->start) + ufi.entry->offset,
   1287 		    &uobjpage, &gotpages, 0,
   1288 			access_type & MASK(ufi.entry),
   1289 			ufi.entry->advice, 0);
   1290 
   1291 		/* locked: uobjpage(if result OK) */
   1292 
   1293 		/*
   1294 		 * recover from I/O
   1295 		 */
   1296 
   1297 		if (result != VM_PAGER_OK) {
   1298 
   1299 #ifdef DIAGNOSTIC
   1300 			if (result == VM_PAGER_PEND)
   1301 	panic("uvm_fault: pgo_get got PENDing on non-async I/O");
   1302 #endif
   1303 
   1304 			if (result == VM_PAGER_AGAIN) {
   1305 	UVMHIST_LOG(maphist, "  pgo_get says TRY AGAIN!",0,0,0,0);
   1306 	tsleep((caddr_t)&lbolt, PVM, "fltagain2", 0);
   1307 	goto ReFault;
   1308 			}
   1309 
   1310 			UVMHIST_LOG(maphist, "<- pgo_get failed (code %d)",
   1311 			    result, 0,0,0);
   1312 			return (KERN_PROTECTION_FAILURE); /* XXX i/o error */
   1313 		}
   1314 
   1315 		/* locked: uobjpage */
   1316 
   1317 		/*
   1318 		 * re-verify the state of the world by first trying to relock
   1319 		 * the maps.  always relock the object.
   1320 		 */
   1321 
   1322 		locked = uvmfault_relock(&ufi);
   1323 		if (locked && amap)
   1324 			amap_lock(amap);
   1325 		simple_lock(&uobj->vmobjlock);
   1326 
   1327 		/* locked(locked): maps(read), amap(if !null), uobj, uobjpage */
   1328 		/* locked(!locked): uobj, uobjpage */
   1329 
   1330 		/*
   1331 		 * verify that the page has not be released and re-verify
   1332 		 * that amap slot is still free.   if there is a problem,
   1333 		 * we unlock and clean up.
   1334 		 */
   1335 
   1336 		if ((uobjpage->flags & PG_RELEASED) != 0 ||
   1337 		    (locked && amap &&
   1338 		    amap_lookup(&ufi.entry->aref,
   1339 		      ufi.orig_rvaddr - ufi.entry->start))) {
   1340 			if (locked)
   1341 				uvmfault_unlockall(&ufi, amap, NULL, NULL);
   1342 			locked = FALSE;
   1343 		}
   1344 
   1345 		/*
   1346 		 * didn't get the lock?   release the page and retry.
   1347 		 */
   1348 
   1349 		if (locked == FALSE) {
   1350 
   1351 			UVMHIST_LOG(maphist,
   1352 			    "  wasn't able to relock after fault: retry",
   1353 			    0,0,0,0);
   1354 			if (uobjpage->flags & PG_WANTED)
   1355 				/* still holding object lock */
   1356 				thread_wakeup(uobjpage);
   1357 
   1358 			if (uobjpage->flags & PG_RELEASED) {
   1359 				uvmexp.fltpgrele++;
   1360 #ifdef DIAGNOSTIC
   1361 				if (uobj->pgops->pgo_releasepg == NULL)
   1362 			panic("uvm_fault: object has no releasepg function");
   1363 #endif
   1364 				/* frees page */
   1365 				if (uobj->pgops->pgo_releasepg(uobjpage,NULL))
   1366 					/* unlock if still alive */
   1367 					simple_unlock(&uobj->vmobjlock);
   1368 				goto ReFault;
   1369 			}
   1370 
   1371 			uvm_lock_pageq();
   1372 			/* make sure it is in queues */
   1373 			uvm_pageactivate(uobjpage);
   1374 
   1375 			uvm_unlock_pageq();
   1376 			uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
   1377 			UVM_PAGE_OWN(uobjpage, NULL);
   1378 			simple_unlock(&uobj->vmobjlock);
   1379 			goto ReFault;
   1380 
   1381 		}
   1382 
   1383 		/*
   1384 		 * we have the data in uobjpage which is PG_BUSY and
   1385 		 * !PG_RELEASED.  we are holding object lock (so the page
   1386 		 * can't be released on us).
   1387 		 */
   1388 
   1389 		/* locked: maps(read), amap(if !null), uobj, uobjpage */
   1390 
   1391 	}
   1392 
   1393 	/*
   1394 	 * locked:
   1395 	 * maps(read), amap(if !null), uobj(if !null), uobjpage(if uobj)
   1396 	 */
   1397 
   1398 	/*
   1399 	 * notes:
   1400 	 *  - at this point uobjpage can not be NULL
   1401 	 *  - at this point uobjpage can not be PG_RELEASED (since we checked
   1402 	 *  for it above)
   1403 	 *  - at this point uobjpage could be PG_WANTED (handle later)
   1404 	 */
   1405 
   1406 	if (promote == FALSE) {
   1407 
   1408 		/*
   1409 		 * we are not promoting.   if the mapping is COW ensure that we
   1410 		 * don't give more access than we should (e.g. when doing a read
   1411 		 * fault on a COPYONWRITE mapping we want to map the COW page in
   1412 		 * R/O even though the entry protection could be R/W).
   1413 		 *
   1414 		 * set "pg" to the page we want to map in (uobjpage, usually)
   1415 		 */
   1416 
   1417 		uvmexp.flt_obj++;
   1418 		if (UVM_ET_ISCOPYONWRITE(ufi.entry))
   1419 			enter_prot &= ~VM_PROT_WRITE;
   1420 		pg = uobjpage;		/* map in the actual object */
   1421 
   1422 		/* assert(uobjpage != PGO_DONTCARE) */
   1423 
   1424 		/*
   1425 		 * we are faulting directly on the page.   be careful
   1426 		 * about writing to loaned pages...
   1427 		 */
   1428 		if (uobjpage->loan_count) {
   1429 
   1430 			if ((access_type & VM_PROT_WRITE) == 0) {
   1431 				/* read fault: cap the protection at readonly */
   1432 				/* cap! */
   1433 				enter_prot = enter_prot & ~VM_PROT_WRITE;
   1434 			} else {
   1435 				/* write fault: must break the loan here */
   1436 
   1437 				/* alloc new un-owned page */
   1438 				pg = uvm_pagealloc(NULL, 0, NULL);
   1439 
   1440 				if (pg == NULL) {
   1441 					/*
   1442 					 * drop ownership of page, it can't
   1443 					 * be released
   1444 					 * */
   1445 					if (uobjpage->flags & PG_WANTED)
   1446 						thread_wakeup(uobjpage);
   1447 					uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
   1448 					UVM_PAGE_OWN(uobjpage, NULL);
   1449 
   1450 					uvm_lock_pageq();
   1451 					/* activate: we will need it later */
   1452 					uvm_pageactivate(uobjpage);
   1453 
   1454 					uvm_unlock_pageq();
   1455 					uvmfault_unlockall(&ufi, amap, uobj,
   1456 					  NULL);
   1457 					UVMHIST_LOG(maphist,
   1458 					  "  out of RAM breaking loan, waiting",
   1459 					  0,0,0,0);
   1460 					uvmexp.fltnoram++;
   1461 					uvm_wait("flt_noram4");
   1462 					goto ReFault;
   1463 				}
   1464 
   1465 				/*
   1466 				 * copy the data from the old page to the new
   1467 				 * one and clear the fake/clean flags on the
   1468 				 * new page (keep it busy).  force a reload
   1469 				 * of the old page by clearing it from all
   1470 				 * pmaps.  then lock the page queues to
   1471 				 * rename the pages.
   1472 				 */
   1473 				uvm_pagecopy(uobjpage, pg);	/* old -> new */
   1474 				pg->flags &= ~(PG_FAKE|PG_CLEAN);
   1475 				pmap_page_protect(PMAP_PGARG(uobjpage),
   1476 				    VM_PROT_NONE);
   1477 				if (uobjpage->flags & PG_WANTED)
   1478 					thread_wakeup(uobjpage);
   1479 				/* uobj still locked */
   1480 				uobjpage->flags &= ~(PG_WANTED|PG_BUSY);
   1481 				UVM_PAGE_OWN(uobjpage, NULL);
   1482 
   1483 				uvm_lock_pageq();
   1484 				offset = uobjpage->offset;
   1485 				/* remove old page */
   1486 				uvm_pagerealloc(uobjpage, NULL, 0);
   1487 
   1488 				/*
   1489 				 * at this point we have absolutely no
   1490 				 * control over uobjpage
   1491 				 */
   1492 				/* install new page */
   1493 				uvm_pagerealloc(pg, uobj, offset);
   1494 				uvm_unlock_pageq();
   1495 
   1496 				/*
   1497 				 * done!  loan is broken and "pg" is
   1498 				 * PG_BUSY.   it can now replace uobjpage.
   1499 				 */
   1500 
   1501 				uobjpage = pg;
   1502 
   1503 			}		/* write fault case */
   1504 		}		/* if loan_count */
   1505 
   1506 	} else {
   1507 
   1508 		/*
   1509 		 * if we are going to promote the data to an anon we
   1510 		 * allocate a blank anon here and plug it into our amap.
   1511 		 */
   1512 #if DIAGNOSTIC
   1513 		if (amap == NULL)
   1514 			panic("uvm_fault: want to promote data, but no anon");
   1515 #endif
   1516 
   1517 		anon = uvm_analloc();
   1518 		if (anon)
   1519 			pg = uvm_pagealloc(NULL, 0, anon); /* BUSY+CLEAN+FAKE */
   1520 #ifdef __GNUC__
   1521 		else
   1522 			pg = NULL; /* XXX: gcc */
   1523 #endif
   1524 
   1525 		/*
   1526 		 * out of memory resources?
   1527 		 */
   1528 		if (anon == NULL || pg == NULL) {
   1529 
   1530 			/*
   1531 			 * arg!  must unbusy our page and fail or sleep.
   1532 			 */
   1533 			if (uobjpage != PGO_DONTCARE) {
   1534 				if (uobjpage->flags & PG_WANTED)
   1535 					/* still holding object lock */
   1536 					thread_wakeup(uobjpage);
   1537 
   1538 				uvm_lock_pageq();
   1539 				/* make sure it is in queues */
   1540 				uvm_pageactivate(uobjpage);
   1541 				uvm_unlock_pageq();
   1542 				/* un-busy! (still locked) */
   1543 				uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
   1544 				UVM_PAGE_OWN(uobjpage, NULL);
   1545 			}
   1546 
   1547 			/* unlock and fail ... */
   1548 			uvmfault_unlockall(&ufi, amap, uobj, NULL);
   1549 #ifdef DIAGNOSTIC
   1550 			if (uvmexp.swpgonly > uvmexp.swpages) {
   1551 				panic("uvmexp.swpgonly botch");
   1552 			}
   1553 #endif
   1554 			if (anon == NULL || uvmexp.swpgonly == uvmexp.swpages) {
   1555 				UVMHIST_LOG(maphist, "  promote: out of VM",
   1556 				    0,0,0,0);
   1557 				uvmexp.fltnoanon++;
   1558 				return (KERN_RESOURCE_SHORTAGE);
   1559 			}
   1560 
   1561 			UVMHIST_LOG(maphist, "  out of RAM, waiting for more",
   1562 			    0,0,0,0);
   1563 			uvm_anfree(anon);
   1564 			uvmexp.fltnoram++;
   1565 			uvm_wait("flt_noram5");
   1566 			goto ReFault;
   1567 		}
   1568 
   1569 		/*
   1570 		 * fill in the data
   1571 		 */
   1572 
   1573 		if (uobjpage != PGO_DONTCARE) {
   1574 			uvmexp.flt_prcopy++;
   1575 			/* copy page [pg now dirty] */
   1576 			uvm_pagecopy(uobjpage, pg);
   1577 
   1578 			/*
   1579 			 * promote to shared amap?  make sure all sharing
   1580 			 * procs see it
   1581 			 */
   1582 			if ((amap_flags(amap) & AMAP_SHARED) != 0) {
   1583 				pmap_page_protect(PMAP_PGARG(uobjpage),
   1584 				    VM_PROT_NONE);
   1585 			}
   1586 
   1587 			/*
   1588 			 * dispose of uobjpage.  it can't be PG_RELEASED
   1589 			 * since we still hold the object lock.   drop
   1590 			 * handle to uobj as well.
   1591 			 */
   1592 
   1593 			if (uobjpage->flags & PG_WANTED)
   1594 				/* still have the obj lock */
   1595 				thread_wakeup(uobjpage);
   1596 			uobjpage->flags &= ~(PG_BUSY|PG_WANTED);
   1597 			UVM_PAGE_OWN(uobjpage, NULL);
   1598 			uvm_lock_pageq();
   1599 			uvm_pageactivate(uobjpage);	/* put it back */
   1600 			uvm_unlock_pageq();
   1601 			simple_unlock(&uobj->vmobjlock);
   1602 			uobj = NULL;
   1603 			UVMHIST_LOG(maphist,
   1604 			    "  promote uobjpage 0x%x to anon/page 0x%x/0x%x",
   1605 			    uobjpage, anon, pg, 0);
   1606 
   1607 		} else {
   1608 			uvmexp.flt_przero++;
   1609 			uvm_pagezero(pg);	/* zero page [pg now dirty] */
   1610 			UVMHIST_LOG(maphist,"  zero fill anon/page 0x%x/0%x",
   1611 			    anon, pg, 0, 0);
   1612 		}
   1613 
   1614 		amap_add(&ufi.entry->aref, ufi.orig_rvaddr - ufi.entry->start,
   1615 		    anon, 0);
   1616 
   1617 	}
   1618 
   1619 	/*
   1620 	 * locked:
   1621 	 * maps(read), amap(if !null), uobj(if !null), uobjpage(if uobj)
   1622 	 *
   1623 	 * note: pg is either the uobjpage or the new page in the new anon
   1624 	 */
   1625 
   1626 	/*
   1627 	 * all resources are present.   we can now map it in and free our
   1628 	 * resources.
   1629 	 */
   1630 
   1631 	UVMHIST_LOG(maphist,
   1632 	    "  MAPPING: case2: pm=0x%x, va=0x%x, pg=0x%x, promote=%d",
   1633 	    ufi.orig_map->pmap, ufi.orig_rvaddr, pg, promote);
   1634 	pmap_enter(ufi.orig_map->pmap, ufi.orig_rvaddr, VM_PAGE_TO_PHYS(pg),
   1635 	    enter_prot, wired, access_type);
   1636 
   1637 	uvm_lock_pageq();
   1638 
   1639 	if (fault_type == VM_FAULT_WIRE) {
   1640 		uvm_pagewire(pg);
   1641 		if (pg->pqflags & PQ_AOBJ) {
   1642 			uao_dropswap(uobj, pg->offset >> PAGE_SHIFT);
   1643 		}
   1644 	} else {
   1645 
   1646 		/* activate it */
   1647 		uvm_pageactivate(pg);
   1648 
   1649 	}
   1650 
   1651 	uvm_unlock_pageq();
   1652 
   1653 	if (pg->flags & PG_WANTED)
   1654 		thread_wakeup(pg);		/* lock still held */
   1655 
   1656 	/*
   1657 	 * note that pg can't be PG_RELEASED since we did not drop the object
   1658 	 * lock since the last time we checked.
   1659 	 */
   1660 
   1661 	pg->flags &= ~(PG_BUSY|PG_FAKE|PG_WANTED);
   1662 	UVM_PAGE_OWN(pg, NULL);
   1663 	uvmfault_unlockall(&ufi, amap, uobj, NULL);
   1664 
   1665 	UVMHIST_LOG(maphist, "<- done (SUCCESS!)",0,0,0,0);
   1666 	return (KERN_SUCCESS);
   1667 }
   1668 
   1669 
   1670 /*
   1671  * uvm_fault_wire: wire down a range of virtual addresses in a map.
   1672  *
   1673  * => map should be locked by caller?   If so how can we call
   1674  *	uvm_fault?   WRONG.
   1675  * => XXXCDC: locking here is all screwed up!!!  start with
   1676  *	uvm_map_pageable and fix it.
   1677  */
   1678 
   1679 int
   1680 uvm_fault_wire(map, start, end)
   1681 	vm_map_t map;
   1682 	vaddr_t start, end;
   1683 {
   1684 	vaddr_t va;
   1685 	pmap_t  pmap;
   1686 	int rv;
   1687 
   1688 	pmap = vm_map_pmap(map);
   1689 
   1690 	/*
   1691 	 * call pmap pageable: this tells the pmap layer to lock down these
   1692 	 * page tables.
   1693 	 */
   1694 
   1695 	pmap_pageable(pmap, start, end, FALSE);
   1696 
   1697 	/*
   1698 	 * now fault it in page at a time.   if the fault fails then we have
   1699 	 * to undo what we have done.   note that in uvm_fault VM_PROT_NONE
   1700 	 * is replaced with the max protection if fault_type is VM_FAULT_WIRE.
   1701 	 */
   1702 
   1703 	for (va = start ; va < end ; va += PAGE_SIZE) {
   1704 		rv = uvm_fault(map, va, VM_FAULT_WIRE, VM_PROT_NONE);
   1705 		if (rv) {
   1706 			if (va != start) {
   1707 				uvm_fault_unwire(map->pmap, start, va);
   1708 			}
   1709 			return (rv);
   1710 		}
   1711 	}
   1712 
   1713 	return (KERN_SUCCESS);
   1714 }
   1715 
   1716 /*
   1717  * uvm_fault_unwire(): unwire range of virtual space.
   1718  *
   1719  * => caller holds reference to pmap (via its map)
   1720  */
   1721 
   1722 void
   1723 uvm_fault_unwire(pmap, start, end)
   1724 	struct pmap *pmap;
   1725 	vaddr_t start, end;
   1726 {
   1727 	vaddr_t va;
   1728 	paddr_t pa;
   1729 	struct vm_page *pg;
   1730 
   1731 	/*
   1732 	 * we assume that the area we are unwiring has actually been wired
   1733 	 * in the first place.   this means that we should be able to extract
   1734 	 * the PAs from the pmap.   we also lock out the page daemon so that
   1735 	 * we can call uvm_pageunwire.
   1736 	 */
   1737 
   1738 	uvm_lock_pageq();
   1739 
   1740 	for (va = start; va < end ; va += PAGE_SIZE) {
   1741 		pa = pmap_extract(pmap, va);
   1742 
   1743 		/* XXX: assumes PA 0 cannot be in map */
   1744 		if (pa == (paddr_t) 0) {
   1745 			panic("uvm_fault_unwire: unwiring non-wired memory");
   1746 		}
   1747 		pmap_change_wiring(pmap, va, FALSE);  /* tell the pmap */
   1748 		pg = PHYS_TO_VM_PAGE(pa);
   1749 		if (pg)
   1750 			uvm_pageunwire(pg);
   1751 	}
   1752 
   1753 	uvm_unlock_pageq();
   1754 
   1755 	/*
   1756 	 * now we call pmap_pageable to let the pmap know that the page tables
   1757 	 * in this space no longer need to be wired.
   1758 	 */
   1759 
   1760 	pmap_pageable(pmap, start, end, TRUE);
   1761 
   1762 }
   1763