Home | History | Annotate | Line # | Download | only in uvm
uvm_pager.c revision 1.16.4.7
      1 /*	$NetBSD: uvm_pager.c,v 1.16.4.7 1999/08/09 00:05:56 chs 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_pager.c,v 1.1.2.23 1998/02/02 20:38:06 chuck Exp
     35  */
     36 
     37 #include "opt_pmap_new.h"
     38 #include "opt_uvmhist.h"
     39 
     40 /*
     41  * uvm_pager.c: generic functions used to assist the pagers.
     42  */
     43 
     44 #include <sys/param.h>
     45 #include <sys/systm.h>
     46 #include <sys/proc.h>
     47 #include <sys/malloc.h>
     48 #include <sys/pool.h>
     49 #include <sys/vnode.h>
     50 
     51 #include <vm/vm.h>
     52 #include <vm/vm_page.h>
     53 #include <vm/vm_kern.h>
     54 
     55 #define UVM_PAGER
     56 #include <uvm/uvm.h>
     57 
     58 struct pool *uvm_aiobuf_pool;
     59 
     60 /*
     61  * list of uvm pagers in the system
     62  */
     63 
     64 extern struct uvm_pagerops aobj_pager;
     65 extern struct uvm_pagerops uvm_deviceops;
     66 extern struct uvm_pagerops uvm_vnodeops;
     67 extern struct uvm_pagerops ubc_pager;
     68 
     69 struct uvm_pagerops *uvmpagerops[] = {
     70 	&aobj_pager,
     71 	&uvm_deviceops,
     72 	&uvm_vnodeops,
     73 	&ubc_pager,
     74 };
     75 
     76 /*
     77  * the pager map: provides KVA for I/O
     78  */
     79 
     80 #define PAGER_MAP_SIZE       (4 * 1024 * 1024)
     81 vm_map_t pager_map;		/* XXX */
     82 simple_lock_data_t pager_map_wanted_lock;
     83 boolean_t pager_map_wanted;	/* locked by pager map */
     84 
     85 
     86 /*
     87  * uvm_pager_init: init pagers (at boot time)
     88  */
     89 
     90 void
     91 uvm_pager_init()
     92 {
     93 	int lcv;
     94 
     95 	/*
     96 	 * init pager map
     97 	 */
     98 
     99 	pager_map = uvm_km_suballoc(kernel_map, &uvm.pager_sva, &uvm.pager_eva,
    100 	 			    PAGER_MAP_SIZE, 0, FALSE, NULL);
    101 	simple_lock_init(&pager_map_wanted_lock);
    102 	pager_map_wanted = FALSE;
    103 
    104 	/*
    105 	 * init ASYNC I/O queue
    106 	 */
    107 
    108 	TAILQ_INIT(&uvm.aio_done);
    109 
    110 	/*
    111 	 * call pager init functions
    112 	 */
    113 	for (lcv = 0 ; lcv < sizeof(uvmpagerops)/sizeof(struct uvm_pagerops *);
    114 	    lcv++) {
    115 		if (uvmpagerops[lcv]->pgo_init)
    116 			uvmpagerops[lcv]->pgo_init();
    117 	}
    118 }
    119 
    120 /*
    121  * uvm_pagermapin: map pages into KVA (pager_map) for I/O that needs mappings
    122  *
    123  * we basically just map in a blank map entry to reserve the space in the
    124  * map and then use pmap_enter() to put the mappings in by hand.
    125  *
    126  * XXX It would be nice to know the direction of the I/O, so that we can
    127  * XXX map only what is necessary.
    128  */
    129 
    130 vaddr_t
    131 uvm_pagermapin(pps, npages, waitf)
    132 	struct vm_page **pps;
    133 	int npages;
    134 	int waitf;
    135 {
    136 	vsize_t size;
    137 	vaddr_t kva;
    138 	vaddr_t cva;
    139 	struct vm_page *pp;
    140 	UVMHIST_FUNC("uvm_pagermapin"); UVMHIST_CALLED(maphist);
    141 
    142 	UVMHIST_LOG(maphist,"(pps=0x%x, npages=%d, waitf=%d)",
    143 	      pps, npages, waitf, 0);
    144 
    145 ReStart:
    146 	size = npages << PAGE_SHIFT;
    147 	kva = NULL;			/* let system choose VA */
    148 
    149 	if (uvm_map(pager_map, &kva, size, NULL,
    150 	      UVM_UNKNOWN_OFFSET, UVM_FLAG_NOMERGE) != KERN_SUCCESS) {
    151 		if (waitf == M_NOWAIT) {
    152 			UVMHIST_LOG(maphist,"<- NOWAIT failed", 0,0,0,0);
    153 			return(0);
    154 		}
    155 		simple_lock(&pager_map_wanted_lock);
    156 		pager_map_wanted = TRUE;
    157 		UVMHIST_LOG(maphist, "  SLEEPING on pager_map",0,0,0,0);
    158 		UVM_UNLOCK_AND_WAIT(pager_map, &pager_map_wanted_lock, FALSE,
    159 		    "pager_map",0);
    160 		goto ReStart;
    161 	}
    162 
    163 	/* got it */
    164 	for (cva = kva ; size != 0 ; size -= PAGE_SIZE, cva += PAGE_SIZE) {
    165 		pp = *pps++;
    166 #ifdef DEBUG
    167 		if ((pp->flags & PG_BUSY) == 0)
    168 			panic("uvm_pagermapin: page not busy");
    169 #endif
    170 
    171 		/*
    172 		 * XXX VM_PROT_DEFAULT includes VM_PROT_EXEC; is that
    173 		 * XXX really necessary?  It could lead to unnecessary
    174 		 * XXX instruction cache flushes.
    175 		 */
    176 		pmap_enter(vm_map_pmap(pager_map), cva, VM_PAGE_TO_PHYS(pp),
    177 		    VM_PROT_DEFAULT, TRUE,
    178 		    VM_PROT_READ | VM_PROT_WRITE);
    179 	}
    180 
    181 	UVMHIST_LOG(maphist, "<- done (KVA=0x%x)", kva,0,0,0);
    182 	return(kva);
    183 }
    184 
    185 /*
    186  * uvm_pagermapout: remove pager_map mapping
    187  *
    188  * we remove our mappings by hand and then remove the mapping (waking
    189  * up anyone wanting space).
    190  */
    191 
    192 void
    193 uvm_pagermapout(kva, npages)
    194 	vaddr_t kva;
    195 	int npages;
    196 {
    197 	vsize_t size = npages << PAGE_SHIFT;
    198 	vm_map_entry_t entries;
    199 	UVMHIST_FUNC("uvm_pagermapout"); UVMHIST_CALLED(maphist);
    200 	UVMHIST_LOG(maphist, " (kva=0x%x, npages=%d)", kva, npages,0,0);
    201 
    202 	/*
    203 	 * duplicate uvm_unmap, but add in pager_map_wanted handling.
    204 	 */
    205 
    206 	vm_map_lock(pager_map);
    207 	(void) uvm_unmap_remove(pager_map, kva, kva + size, &entries);
    208 	simple_lock(&pager_map_wanted_lock);
    209 	if (pager_map_wanted) {
    210 		pager_map_wanted = FALSE;
    211 		wakeup(pager_map);
    212 	}
    213 	simple_unlock(&pager_map_wanted_lock);
    214 	vm_map_unlock(pager_map);
    215 	pmap_remove(pmap_kernel(), kva, kva + (npages << PAGE_SHIFT));
    216 	if (entries)
    217 		uvm_unmap_detach(entries, 0);
    218 
    219 	UVMHIST_LOG(maphist,"<- done",0,0,0,0);
    220 }
    221 
    222 /*
    223  * uvm_mk_pcluster
    224  *
    225  * generic "make 'pager put' cluster" function.  a pager can either
    226  * [1] set pgo_mk_pcluster to NULL (never cluster), [2] set it to this
    227  * generic function, or [3] set it to a pager specific function.
    228  *
    229  * => caller must lock object _and_ pagequeues (since we need to look
    230  *    at active vs. inactive bits, etc.)
    231  * => caller must make center page busy and write-protect it
    232  * => we mark all cluster pages busy for the caller
    233  * => the caller must unbusy all pages (and check wanted/released
    234  *    status if it drops the object lock)
    235  * => flags:
    236  *      PGO_ALLPAGES:  all pages in object are valid targets
    237  *      !PGO_ALLPAGES: use "lo" and "hi" to limit range of cluster
    238  *      PGO_DOACTCLUST: include active pages in cluster.
    239  *        NOTE: the caller should clear PG_CLEANCHK bits if PGO_DOACTCLUST.
    240  *              PG_CLEANCHK is only a hint, but clearing will help reduce
    241  *		the number of calls we make to the pmap layer.
    242  */
    243 
    244 struct vm_page **
    245 uvm_mk_pcluster(uobj, pps, npages, center, flags, mlo, mhi)
    246 	struct uvm_object *uobj;	/* IN */
    247 	struct vm_page **pps, *center;  /* IN/OUT, IN */
    248 	int *npages, flags;		/* IN/OUT, IN */
    249 	voff_t mlo, mhi;		/* IN (if !PGO_ALLPAGES) */
    250 {
    251 	struct vm_page **ppsp, *pclust;
    252 	voff_t lo, hi, curoff;
    253 	int center_idx, forward, incr;
    254 	UVMHIST_FUNC("uvm_mk_pcluster"); UVMHIST_CALLED(maphist);
    255 
    256 	/*
    257 	 * center page should already be busy and write protected.  XXX:
    258 	 * suppose page is wired?  if we lock, then a process could
    259 	 * fault/block on it.  if we don't lock, a process could write the
    260 	 * pages in the middle of an I/O.  (consider an msync()).  let's
    261 	 * lock it for now (better to delay than corrupt data?).
    262 	 */
    263 
    264 	/*
    265 	 * get cluster boundaries, check sanity, and apply our limits as well.
    266 	 */
    267 
    268 	uobj->pgops->pgo_cluster(uobj, center->offset, &lo, &hi);
    269 	if ((flags & PGO_ALLPAGES) == 0) {
    270 		if (lo < mlo)
    271 			lo = mlo;
    272 		if (hi > mhi)
    273 			hi = mhi;
    274 	}
    275 	if ((hi - lo) >> PAGE_SHIFT > *npages) { /* pps too small, bail out! */
    276 #ifdef DIAGNOSTIC
    277 		printf("uvm_mk_pcluster uobj %p npages %d lo 0x%llx hi 0x%llx "
    278 		       "flags 0x%x\n", uobj, *npages, (long long)lo,
    279 		       (long long)hi, flags);
    280 #endif
    281 		pps[0] = center;
    282 		*npages = 1;
    283 		return(pps);
    284 	}
    285 
    286 	/*
    287 	 * now determine the center and attempt to cluster around the
    288 	 * edges
    289 	 */
    290 
    291 	center_idx = (center->offset - lo) >> PAGE_SHIFT;
    292 	pps[center_idx] = center;	/* plug in the center page */
    293 	ppsp = &pps[center_idx];
    294 	*npages = 1;
    295 
    296 	/*
    297 	 * attempt to cluster around the left [backward], and then
    298 	 * the right side [forward].
    299 	 *
    300 	 * note that for inactive pages (pages that have been deactivated)
    301 	 * there are no valid mappings and PG_CLEAN should be up to date.
    302 	 * [i.e. there is no need to query the pmap with pmap_is_modified
    303 	 * since there are no mappings].
    304 	 */
    305 
    306 	for (forward  = 0 ; forward <= 1 ; forward++) {
    307 		incr = forward ? PAGE_SIZE : -PAGE_SIZE;
    308 		curoff = center->offset + incr;
    309 		for ( ;(forward == 0 && curoff >= lo) ||
    310 		       (forward && curoff < hi);
    311 		      curoff += incr) {
    312 
    313 			pclust = uvm_pagelookup(uobj, curoff); /* lookup page */
    314 			if (pclust == NULL) {
    315 				break;			/* no page */
    316 			}
    317 			/* handle active pages */
    318 			/* NOTE: inactive pages don't have pmap mappings */
    319 			if ((pclust->pqflags & PQ_INACTIVE) == 0) {
    320 				if ((flags & PGO_DOACTCLUST) == 0) {
    321 					/* dont want mapped pages at all */
    322 					break;
    323 				}
    324 
    325 				/* make sure "clean" bit is sync'd */
    326 				if ((pclust->flags & PG_CLEANCHK) == 0) {
    327 					if ((pclust->flags & (PG_CLEAN|PG_BUSY))
    328 					   == PG_CLEAN &&
    329 					   pmap_is_modified(PMAP_PGARG(pclust)))
    330 					pclust->flags &= ~PG_CLEAN;
    331 					/* now checked */
    332 					pclust->flags |= PG_CLEANCHK;
    333 				}
    334 			}
    335 
    336 			/* is page available for cleaning and does it need it */
    337 			if ((pclust->flags & (PG_CLEAN|PG_BUSY)) != 0) {
    338 				break;	/* page is already clean or is busy */
    339 			}
    340 
    341 			/* yes!   enroll the page in our array */
    342 			pclust->flags |= PG_BUSY;		/* busy! */
    343 			UVM_PAGE_OWN(pclust, "uvm_mk_pcluster");
    344 
    345 			/* XXX: protect wired page?   see above comment. */
    346 			pmap_page_protect(PMAP_PGARG(pclust), VM_PROT_READ);
    347 			if (!forward) {
    348 				ppsp--;			/* back up one page */
    349 				*ppsp = pclust;
    350 			} else {
    351 				/* move forward one page */
    352 				ppsp[*npages] = pclust;
    353 			}
    354 			(*npages)++;
    355 		}
    356 	}
    357 
    358 	/*
    359 	 * done!  return the cluster array to the caller!!!
    360 	 */
    361 
    362 	UVMHIST_LOG(maphist, "<- done",0,0,0,0);
    363 	return(ppsp);
    364 }
    365 
    366 
    367 /*
    368  * uvm_shareprot: generic share protect routine
    369  *
    370  * => caller must lock map entry's map
    371  * => caller must lock object pointed to by map entry
    372  */
    373 
    374 void
    375 uvm_shareprot(entry, prot)
    376 	vm_map_entry_t entry;
    377 	vm_prot_t prot;
    378 {
    379 	struct uvm_object *uobj = entry->object.uvm_obj;
    380 	struct vm_page *pp;
    381 	voff_t start, stop;
    382 	UVMHIST_FUNC("uvm_shareprot"); UVMHIST_CALLED(maphist);
    383 
    384 	if (UVM_ET_ISSUBMAP(entry))
    385 		panic("uvm_shareprot: non-object attached");
    386 
    387 	start = entry->offset;
    388 	stop = start + (entry->end - entry->start);
    389 
    390 	/*
    391 	 * traverse list of pages in object.   if page in range, pmap_prot it
    392 	 */
    393 
    394 	for (pp = uobj->memq.tqh_first ; pp != NULL ; pp = pp->listq.tqe_next) {
    395 		if (pp->offset >= start && pp->offset < stop)
    396 			pmap_page_protect(PMAP_PGARG(pp), prot);
    397 	}
    398 	UVMHIST_LOG(maphist, "<- done",0,0,0,0);
    399 }
    400 
    401 /*
    402  * uvm_pager_put: high level pageout routine
    403  *
    404  * we want to pageout page "pg" to backing store, clustering if
    405  * possible.
    406  *
    407  * => page queues must be locked by caller
    408  * => if page is not swap-backed, then "uobj" points to the object
    409  *	backing it.   this object should be locked by the caller.
    410  * => if page is swap-backed, then "uobj" should be NULL.
    411  * => "pg" should be PG_BUSY (by caller), and !PG_CLEAN
    412  *    for swap-backed memory, "pg" can be NULL if there is no page
    413  *    of interest [sometimes the case for the pagedaemon]
    414  * => "ppsp_ptr" should point to an array of npages vm_page pointers
    415  *	for possible cluster building
    416  * => flags (first two for non-swap-backed pages)
    417  *	PGO_ALLPAGES: all pages in uobj are valid targets
    418  *	PGO_DOACTCLUST: include "PQ_ACTIVE" pages as valid targets
    419  *	PGO_SYNCIO: do SYNC I/O (no async)
    420  *	PGO_PDFREECLUST: pagedaemon: drop cluster on successful I/O
    421  * => start/stop: if (uobj && !PGO_ALLPAGES) limit targets to this range
    422  *		  if (!uobj) start is the (daddr_t) of the starting swapblk
    423  * => return state:
    424  *	1. we return the VM_PAGER status code of the pageout
    425  *	2. we return with the page queues unlocked
    426  *	3. if (uobj != NULL) [!swap_backed] we return with
    427  *		uobj locked _only_ if PGO_PDFREECLUST is set
    428  *		AND result != VM_PAGER_PEND.   in all other cases
    429  *		we return with uobj unlocked.   [this is a hack
    430  *		that allows the pagedaemon to save one lock/unlock
    431  *		pair in the !swap_backed case since we have to
    432  *		lock the uobj to drop the cluster anyway]
    433  *	4. on errors we always drop the cluster.   thus, if we return
    434  *		!PEND, !OK, then the caller only has to worry about
    435  *		un-busying the main page (not the cluster pages).
    436  *	5. on success, if !PGO_PDFREECLUST, we return the cluster
    437  *		with all pages busy (caller must un-busy and check
    438  *		wanted/released flags).
    439  */
    440 
    441 int
    442 uvm_pager_put(uobj, pg, ppsp_ptr, npages, flags, start, stop)
    443 	struct uvm_object *uobj;	/* IN */
    444 	struct vm_page *pg, ***ppsp_ptr;/* IN, IN/OUT */
    445 	int *npages;			/* IN/OUT */
    446 	int flags;			/* IN */
    447 	voff_t start, stop;		/* IN, IN */
    448 {
    449 	int result;
    450 	daddr_t swblk;
    451 	struct vm_page **ppsp = *ppsp_ptr;
    452 
    453 	/*
    454 	 * note that uobj is null  if we are doing a swap-backed pageout.
    455 	 * note that uobj is !null if we are doing normal object pageout.
    456 	 * note that the page queues must be locked to cluster.
    457 	 */
    458 
    459 	if (uobj) {	/* if !swap-backed */
    460 
    461 		/*
    462 		 * attempt to build a cluster for pageout using its
    463 		 * make-put-cluster function (if it has one).
    464 		 */
    465 
    466 		if (uobj->pgops->pgo_mk_pcluster) {
    467 			ppsp = uobj->pgops->pgo_mk_pcluster(uobj, ppsp,
    468 			    npages, pg, flags, start, stop);
    469 			*ppsp_ptr = ppsp;  /* update caller's pointer */
    470 		} else {
    471 			ppsp[0] = pg;
    472 			*npages = 1;
    473 		}
    474 
    475 		swblk = 0;		/* XXX: keep gcc happy */
    476 
    477 	} else {
    478 
    479 		/*
    480 		 * for swap-backed pageout, the caller (the pagedaemon) has
    481 		 * already built the cluster for us.   the starting swap
    482 		 * block we are writing to has been passed in as "start."
    483 		 * "pg" could be NULL if there is no page we are especially
    484 		 * interested in (in which case the whole cluster gets dropped
    485 		 * in the event of an error or a sync "done").
    486 		 */
    487 		swblk = (daddr_t) start;
    488 		/* ppsp and npages should be ok */
    489 	}
    490 
    491 	/* now that we've clustered we can unlock the page queues */
    492 	uvm_unlock_pageq();
    493 
    494 	/*
    495 	 * now attempt the I/O.   if we have a failure and we are
    496 	 * clustered, we will drop the cluster and try again.
    497 	 */
    498 
    499 ReTry:
    500 	if (uobj) {
    501 		/* object is locked */
    502 		result = uobj->pgops->pgo_put(uobj, ppsp, *npages, flags);
    503 		/* object is now unlocked */
    504 	} else {
    505 		/* nothing locked */
    506 		result = uvm_swap_put(swblk, ppsp, *npages, flags);
    507 		/* nothing locked */
    508 	}
    509 
    510 	/*
    511 	 * we have attempted the I/O.
    512 	 *
    513 	 * if the I/O was a success then:
    514 	 * 	if !PGO_PDFREECLUST, we return the cluster to the
    515 	 *		caller (who must un-busy all pages)
    516 	 *	else we un-busy cluster pages for the pagedaemon
    517 	 *
    518 	 * if I/O is pending (async i/o) then we return the pending code.
    519 	 * [in this case the async i/o done function must clean up when
    520 	 *  i/o is done...]
    521 	 */
    522 
    523 	if (result == VM_PAGER_PEND || result == VM_PAGER_OK) {
    524 		if (result == VM_PAGER_OK && (flags & PGO_PDFREECLUST)) {
    525 			/*
    526 			 * drop cluster and relock object (only if I/O is
    527 			 * not pending)
    528 			 */
    529 			if (uobj)
    530 				/* required for dropcluster */
    531 				simple_lock(&uobj->vmobjlock);
    532 			if (*npages > 1 || pg == NULL)
    533 				uvm_pager_dropcluster(uobj, pg, ppsp, npages,
    534 				    PGO_PDFREECLUST, 0);
    535 			/* if (uobj): object still locked, as per
    536 			 * return-state item #3 */
    537 		}
    538 		return (result);
    539 	}
    540 
    541 	/*
    542 	 * a pager error occured.    if we have clustered, we drop the
    543 	 * cluster and try again.
    544 	 */
    545 
    546 	if (*npages > 1 || pg == NULL) {
    547 		if (uobj)
    548 			simple_lock(&uobj->vmobjlock);
    549 		uvm_pager_dropcluster(uobj, pg, ppsp, npages, PGO_REALLOCSWAP,
    550 		    swblk);
    551 		if (pg != NULL)
    552 			goto ReTry;
    553 	}
    554 
    555 	/*
    556 	 * a pager error occured (even after dropping the cluster, if there
    557 	 * was one).    give up!   the caller only has one page ("pg")
    558 	 * to worry about.
    559 	 */
    560 
    561 	if (uobj && (flags & PGO_PDFREECLUST) != 0)
    562 		simple_lock(&uobj->vmobjlock);
    563 	return(result);
    564 }
    565 
    566 /*
    567  * uvm_pager_dropcluster: drop a cluster we have built (because we
    568  * got an error, or, if PGO_PDFREECLUST we are un-busying the
    569  * cluster pages on behalf of the pagedaemon).
    570  *
    571  * => uobj, if non-null, is a non-swap-backed object that is
    572  *	locked by the caller.   we return with this object still
    573  *	locked.
    574  * => page queues are not locked
    575  * => pg is our page of interest (the one we clustered around, can be null)
    576  * => ppsp/npages is our current cluster
    577  * => flags: PGO_PDFREECLUST: pageout was a success: un-busy cluster
    578  *	pages on behalf of the pagedaemon.
    579  *           PGO_REALLOCSWAP: drop previously allocated swap slots for
    580  *		clustered swap-backed pages (except for "pg" if !NULL)
    581  *		"swblk" is the start of swap alloc (e.g. for ppsp[0])
    582  *		[only meaningful if swap-backed (uobj == NULL)]
    583  */
    584 
    585 
    586 void
    587 uvm_pager_dropcluster(uobj, pg, ppsp, npages, flags, swblk)
    588 	struct uvm_object *uobj;	/* IN */
    589 	struct vm_page *pg, **ppsp;	/* IN, IN/OUT */
    590 	int *npages;			/* IN/OUT */
    591 	int flags;
    592 	int swblk;			/* valid if (uobj == NULL &&
    593 					   PGO_REALLOCSWAP) */
    594 {
    595 	int lcv;
    596 	boolean_t obj_is_alive;
    597 	struct uvm_object *saved_uobj;
    598 
    599 	/*
    600 	 * if we need to reallocate swap space for the cluster we are dropping
    601 	 * (true if swap-backed and PGO_REALLOCSWAP) then free the old
    602 	 * allocation now.   save a block for "pg" if it is non-NULL.
    603 	 *
    604 	 * note that we will zap the object's pointer to swap in the "for" loop
    605 	 * below...
    606 	 */
    607 
    608 	if (uobj == NULL && (flags & PGO_REALLOCSWAP)) {
    609 		if (pg)
    610 			uvm_swap_free(swblk + 1, *npages - 1);
    611 		else
    612 			uvm_swap_free(swblk, *npages);
    613 	}
    614 
    615 	/*
    616 	 * drop all pages but "pg"
    617 	 */
    618 
    619 	for (lcv = 0 ; lcv < *npages ; lcv++) {
    620 
    621 		/* skip "pg" or empty slot */
    622 		if (ppsp[lcv] == pg || ppsp[lcv] == NULL)
    623 			continue;
    624 
    625 		/*
    626 		 * if swap-backed, gain lock on object that owns page.  note
    627 		 * that PQ_ANON bit can't change as long as we are holding
    628 		 * the PG_BUSY bit (so there is no need to lock the page
    629 		 * queues to test it).
    630 		 *
    631 		 * once we have the lock, dispose of the pointer to swap, if
    632 		 * requested
    633 		 */
    634 		if (!uobj) {
    635 			if (ppsp[lcv]->pqflags & PQ_ANON) {
    636 				simple_lock(&ppsp[lcv]->uanon->an_lock);
    637 				if (flags & PGO_REALLOCSWAP)
    638 					  /* zap swap block */
    639 					  ppsp[lcv]->uanon->an_swslot = 0;
    640 			} else {
    641 				simple_lock(&ppsp[lcv]->uobject->vmobjlock);
    642 				if (flags & PGO_REALLOCSWAP)
    643 					uao_set_swslot(ppsp[lcv]->uobject,
    644 					    ppsp[lcv]->offset >> PAGE_SHIFT, 0);
    645 			}
    646 		}
    647 
    648 		/* did someone want the page while we had it busy-locked? */
    649 		if (ppsp[lcv]->flags & PG_WANTED) {
    650 			/* still holding obj lock */
    651 			wakeup(ppsp[lcv]);
    652 		}
    653 
    654 		/* if page was released, release it.  otherwise un-busy it */
    655 		if (ppsp[lcv]->flags & PG_RELEASED) {
    656 
    657 			if (ppsp[lcv]->pqflags & PQ_ANON) {
    658 				/* so that anfree will free */
    659 				ppsp[lcv]->flags &= ~(PG_BUSY);
    660 				UVM_PAGE_OWN(ppsp[lcv], NULL);
    661 
    662 				pmap_page_protect(PMAP_PGARG(ppsp[lcv]),
    663 				    VM_PROT_NONE); /* be safe */
    664 				simple_unlock(&ppsp[lcv]->uanon->an_lock);
    665 				/* kills anon and frees pg */
    666 				uvm_anfree(ppsp[lcv]->uanon);
    667 
    668 				continue;
    669 			}
    670 
    671 			/*
    672 			 * pgo_releasepg will dump the page for us
    673 			 */
    674 
    675 #ifdef DIAGNOSTIC
    676 			if (ppsp[lcv]->uobject->pgops->pgo_releasepg == NULL)
    677 				panic("uvm_pager_dropcluster: no releasepg "
    678 				    "function");
    679 #endif
    680 			saved_uobj = ppsp[lcv]->uobject;
    681 			obj_is_alive =
    682 			    saved_uobj->pgops->pgo_releasepg(ppsp[lcv], NULL);
    683 
    684 #ifdef DIAGNOSTIC
    685 			/* for normal objects, "pg" is still PG_BUSY by us,
    686 			 * so obj can't die */
    687 			if (uobj && !obj_is_alive)
    688 				panic("uvm_pager_dropcluster: object died "
    689 				    "with active page");
    690 #endif
    691 			/* only unlock the object if it is still alive...  */
    692 			if (obj_is_alive && saved_uobj != uobj)
    693 				simple_unlock(&saved_uobj->vmobjlock);
    694 
    695 			/*
    696 			 * XXXCDC: suppose uobj died in the pgo_releasepg?
    697 			 * how pass that
    698 			 * info up to caller.  we are currently ignoring it...
    699 			 */
    700 
    701 			continue;		/* next page */
    702 
    703 		} else {
    704 			ppsp[lcv]->flags &= ~(PG_BUSY|PG_WANTED|PG_FAKE);
    705 			UVM_PAGE_OWN(ppsp[lcv], NULL);
    706 		}
    707 
    708 		/*
    709 		 * if we are operating on behalf of the pagedaemon and we
    710 		 * had a successful pageout update the page!
    711 		 */
    712 		if (flags & PGO_PDFREECLUST) {
    713 			pmap_clear_reference(PMAP_PGARG(ppsp[lcv]));
    714 			pmap_clear_modify(PMAP_PGARG(ppsp[lcv]));
    715 			ppsp[lcv]->flags |= PG_CLEAN;
    716 		}
    717 
    718 		/* if anonymous cluster, unlock object and move on */
    719 		if (!uobj) {
    720 			if (ppsp[lcv]->pqflags & PQ_ANON)
    721 				simple_unlock(&ppsp[lcv]->uanon->an_lock);
    722 			else
    723 				simple_unlock(&ppsp[lcv]->uobject->vmobjlock);
    724 		}
    725 
    726 	}
    727 
    728 	/*
    729 	 * drop to a cluster of 1 page ("pg") if requested
    730 	 */
    731 
    732 	if (pg && (flags & PGO_PDFREECLUST) == 0) {
    733 		/*
    734 		 * if we are not a successful pageout, we make a 1 page cluster.
    735 		 */
    736 		ppsp[0] = pg;
    737 		*npages = 1;
    738 
    739 		/*
    740 		 * assign new swap block to new cluster, if anon backed
    741 		 */
    742 		if (uobj == NULL && (flags & PGO_REALLOCSWAP)) {
    743 			if (pg->pqflags & PQ_ANON) {
    744 				simple_lock(&pg->uanon->an_lock);
    745 				pg->uanon->an_swslot = swblk;	/* reassign */
    746 				simple_unlock(&pg->uanon->an_lock);
    747 			} else {
    748 				simple_lock(&pg->uobject->vmobjlock);
    749 				uao_set_swslot(pg->uobject,
    750 				    pg->offset >> PAGE_SHIFT, swblk);
    751 				simple_unlock(&pg->uobject->vmobjlock);
    752 			}
    753 		}
    754 	}
    755 }
    756 
    757 /*
    758  * interrupt-context iodone handler for nested i/o bufs.
    759  *
    760  * => must be at splbio().
    761  */
    762 
    763 void
    764 uvm_aio_biodone1(bp)
    765 	struct buf *bp;
    766 {
    767 	struct buf *mbp = bp->b_private;
    768 
    769 #ifdef DIAGNOSTIC
    770 	if (mbp == bp) {
    771 		panic("uvm_aio_biodone1: mbp == bp %p", bp);
    772 	}
    773 #endif
    774 
    775 	if (bp->b_flags & B_ERROR) {
    776 		mbp->b_flags |= B_ERROR;
    777 		mbp->b_error = bp->b_error;
    778 	}
    779 	mbp->b_resid -= bp->b_bcount;
    780 	pool_put(&bufpool, bp);
    781 	if (mbp->b_resid == 0) {
    782 		biodone(mbp);
    783 	}
    784 }
    785 
    786 /*
    787  * interrupt-context iodone handler for single-buf i/os
    788  * or the top-level buf of a nested-buf i/o.
    789  *
    790  * => must be at splbio().
    791  */
    792 
    793 void
    794 uvm_aio_biodone(bp)
    795 	struct buf *bp;
    796 {
    797 	/* reset b_iodone for when this is a single-buf i/o. */
    798 	bp->b_iodone = uvm_aio_aiodone;
    799 
    800 	simple_lock(&uvm.aiodoned_lock);	/* locks uvm.aio_done */
    801 	TAILQ_INSERT_TAIL(&uvm.aio_done, bp, b_freelist);
    802 	wakeup(&uvm.aiodoned);
    803 	simple_unlock(&uvm.aiodoned_lock);
    804 }
    805 
    806 /*
    807  * uvm_aio_aiodone: do iodone processing for async i/os.
    808  * this should be called in thread context, not interrupt context.
    809  */
    810 
    811 void
    812 uvm_aio_aiodone(bp)
    813 	struct buf *bp;
    814 {
    815 	int npages = bp->b_bufsize >> PAGE_SHIFT;
    816 	struct vm_page *pg, *pgs[npages];
    817 	struct uvm_object *uobj;
    818 	int s, i;
    819 	boolean_t release, write, swap;
    820 	UVMHIST_FUNC("uvm_aio_aiodone"); UVMHIST_CALLED(ubchist);
    821 	UVMHIST_LOG(ubchist, "bp %p", bp, 0,0,0);
    822 
    823 	release = (bp->b_flags & (B_ERROR|B_READ)) == (B_ERROR|B_READ);
    824 	write = (bp->b_flags & B_READ) == 0;
    825 	uobj = NULL;
    826 	for (i = 0; i < npages; i++) {
    827 		pgs[i] = uvm_pageratop((vaddr_t)bp->b_data + (i << PAGE_SHIFT));
    828 	}
    829 	uvm_pagermapout((vaddr_t)bp->b_data, npages);
    830 	for (i = 0; i < npages; i++) {
    831 		pg = pgs[i];
    832 
    833 		if (i == 0) {
    834 			swap = (pg->pqflags & PQ_SWAPBACKED) != 0;
    835 			if (!swap) {
    836 				uobj = pg->uobject;
    837 				simple_lock(&uobj->vmobjlock);
    838 			}
    839 		}
    840 #ifdef DIAGNOSTIC
    841 		if (!swap && pg->uobject != uobj) {
    842 			panic("uvm_aio_aiodone: mismatched pg %d %p uobj %p",
    843 			      i, pg, uobj);
    844 		}
    845 #endif
    846 
    847 		if (swap) {
    848 			if (pg->pqflags & PQ_ANON) {
    849 				simple_lock(&pg->uanon->an_lock);
    850 			} else {
    851 				simple_lock(&pg->uobject->vmobjlock);
    852 			}
    853 		}
    854 
    855 		/*
    856 		 * if this is a read and we got an error, mark the pages
    857 		 * PG_RELEASED so that uvm_page_unbusy() will free them.
    858 		 */
    859 
    860 		if (release) {
    861 			if (pg->pqflags & PQ_ANON) {
    862 				pg->flags &= ~(PG_BUSY);
    863 				UVM_PAGE_OWN(pg, NULL);
    864 				simple_unlock(&pg->uanon->an_lock);
    865 				uvm_anfree(pg->uanon);
    866 			} else {
    867 				uobj->pgops->pgo_releasepg(pg, NULL);
    868 				if (swap) {
    869 					simple_unlock(&pg->uobject->vmobjlock);
    870 				}
    871 			}
    872 			continue;
    873 		}
    874 
    875 #ifdef DIAGNOSTIC
    876 		if (write && pgs[i]->flags & PG_FAKE) {
    877 			panic("uvm_aio_aiodone: wrote PG_FAKE page %p", pgs[i]);
    878 		}
    879 #endif
    880 
    881 		/*
    882 		 * if this is a read and the page is PG_FAKE
    883 		 * or this was a write, mark the page PG_CLEAN and not PG_FAKE.
    884 		 */
    885 
    886 		if (pgs[i]->flags & PG_FAKE || write) {
    887 			pmap_clear_reference(PMAP_PGARG(pgs[i]));
    888 			pmap_clear_modify(PMAP_PGARG(pgs[i]));
    889 			pgs[i]->flags |= PG_CLEAN;
    890 			pgs[i]->flags &= ~PG_FAKE;
    891 		}
    892 		if (swap) {
    893 			if (pg->pqflags & PQ_ANON) {
    894 				simple_unlock(&pg->uanon->an_lock);
    895 			} else {
    896 				simple_unlock(&pg->uobject->vmobjlock);
    897 			}
    898 		}
    899 	}
    900 	uvm_page_unbusy(pgs, npages);
    901 	if (!swap) {
    902 		simple_unlock(&uobj->vmobjlock);
    903 	}
    904 
    905 	s = splbio();
    906 	pool_put(&bufpool, bp);
    907 	splx(s);
    908 }
    909 
    910 /*
    911  * translate unix errno values to VM_PAGER_*.
    912  */
    913 
    914 int
    915 uvm_errno2vmerror(errno)
    916 	int errno;
    917 {
    918 	switch (errno) {
    919 	case 0:
    920 		return VM_PAGER_OK;
    921 	case EINVAL:
    922 		return VM_PAGER_BAD;
    923 	case EINPROGRESS:
    924 		return VM_PAGER_PEND;
    925 	case EIO:
    926 		return VM_PAGER_ERROR;
    927 	case EAGAIN:
    928 		return VM_PAGER_AGAIN;
    929 	case EBUSY:
    930 		return VM_PAGER_UNLOCK;
    931 	default:
    932 		return VM_PAGER_ERROR;
    933 	}
    934 }
    935