xref: /freebsd/sys/vm/swap_pager.c (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
1 /*-
2  * Copyright (c) 1998 Matthew Dillon,
3  * Copyright (c) 1994 John S. Dyson
4  * Copyright (c) 1990 University of Utah.
5  * Copyright (c) 1982, 1986, 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * the Systems Programming Group of the University of Utah Computer
10  * Science Department.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the University of
23  *	California, Berkeley and its contributors.
24  * 4. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *				New Swap System
41  *				Matthew Dillon
42  *
43  * Radix Bitmap 'blists'.
44  *
45  *	- The new swapper uses the new radix bitmap code.  This should scale
46  *	  to arbitrarily small or arbitrarily large swap spaces and an almost
47  *	  arbitrary degree of fragmentation.
48  *
49  * Features:
50  *
51  *	- on the fly reallocation of swap during putpages.  The new system
52  *	  does not try to keep previously allocated swap blocks for dirty
53  *	  pages.
54  *
55  *	- on the fly deallocation of swap
56  *
57  *	- No more garbage collection required.  Unnecessarily allocated swap
58  *	  blocks only exist for dirty vm_page_t's now and these are already
59  *	  cycled (in a high-load system) by the pager.  We also do on-the-fly
60  *	  removal of invalidated swap blocks when a page is destroyed
61  *	  or renamed.
62  *
63  * from: Utah $Hdr: swap_pager.c 1.4 91/04/30$
64  *
65  *	@(#)swap_pager.c	8.9 (Berkeley) 3/21/94
66  *	@(#)vm_swap.c	8.5 (Berkeley) 2/17/94
67  */
68 
69 #include <sys/cdefs.h>
70 __FBSDID("$FreeBSD$");
71 
72 #include "opt_mac.h"
73 #include "opt_swap.h"
74 #include "opt_vm.h"
75 
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/conf.h>
79 #include <sys/kernel.h>
80 #include <sys/priv.h>
81 #include <sys/proc.h>
82 #include <sys/bio.h>
83 #include <sys/buf.h>
84 #include <sys/disk.h>
85 #include <sys/fcntl.h>
86 #include <sys/mount.h>
87 #include <sys/namei.h>
88 #include <sys/vnode.h>
89 #include <sys/malloc.h>
90 #include <sys/sysctl.h>
91 #include <sys/sysproto.h>
92 #include <sys/blist.h>
93 #include <sys/lock.h>
94 #include <sys/sx.h>
95 #include <sys/vmmeter.h>
96 
97 #include <security/mac/mac_framework.h>
98 
99 #include <vm/vm.h>
100 #include <vm/pmap.h>
101 #include <vm/vm_map.h>
102 #include <vm/vm_kern.h>
103 #include <vm/vm_object.h>
104 #include <vm/vm_page.h>
105 #include <vm/vm_pager.h>
106 #include <vm/vm_pageout.h>
107 #include <vm/vm_param.h>
108 #include <vm/swap_pager.h>
109 #include <vm/vm_extern.h>
110 #include <vm/uma.h>
111 
112 #include <geom/geom.h>
113 
114 /*
115  * SWB_NPAGES must be a power of 2.  It may be set to 1, 2, 4, 8, or 16
116  * pages per allocation.  We recommend you stick with the default of 8.
117  * The 16-page limit is due to the radix code (kern/subr_blist.c).
118  */
119 #ifndef MAX_PAGEOUT_CLUSTER
120 #define MAX_PAGEOUT_CLUSTER 16
121 #endif
122 
123 #if !defined(SWB_NPAGES)
124 #define SWB_NPAGES	MAX_PAGEOUT_CLUSTER
125 #endif
126 
127 /*
128  * Piecemeal swap metadata structure.  Swap is stored in a radix tree.
129  *
130  * If SWB_NPAGES is 8 and sizeof(char *) == sizeof(daddr_t), our radix
131  * is basically 8.  Assuming PAGE_SIZE == 4096, one tree level represents
132  * 32K worth of data, two levels represent 256K, three levels represent
133  * 2 MBytes.   This is acceptable.
134  *
135  * Overall memory utilization is about the same as the old swap structure.
136  */
137 #define SWCORRECT(n) (sizeof(void *) * (n) / sizeof(daddr_t))
138 #define SWAP_META_PAGES		(SWB_NPAGES * 2)
139 #define SWAP_META_MASK		(SWAP_META_PAGES - 1)
140 
141 struct swblock {
142 	struct swblock	*swb_hnext;
143 	vm_object_t	swb_object;
144 	vm_pindex_t	swb_index;
145 	int		swb_count;
146 	daddr_t		swb_pages[SWAP_META_PAGES];
147 };
148 
149 static struct mtx sw_dev_mtx;
150 static TAILQ_HEAD(, swdevt) swtailq = TAILQ_HEAD_INITIALIZER(swtailq);
151 static struct swdevt *swdevhd;	/* Allocate from here next */
152 static int nswapdev;		/* Number of swap devices */
153 int swap_pager_avail;
154 static int swdev_syscall_active = 0; /* serialize swap(on|off) */
155 
156 static void swapdev_strategy(struct buf *, struct swdevt *sw);
157 
158 #define SWM_FREE	0x02	/* free, period			*/
159 #define SWM_POP		0x04	/* pop out			*/
160 
161 int swap_pager_full = 2;	/* swap space exhaustion (task killing) */
162 static int swap_pager_almost_full = 1; /* swap space exhaustion (w/hysteresis)*/
163 static int nsw_rcount;		/* free read buffers			*/
164 static int nsw_wcount_sync;	/* limit write buffers / synchronous	*/
165 static int nsw_wcount_async;	/* limit write buffers / asynchronous	*/
166 static int nsw_wcount_async_max;/* assigned maximum			*/
167 static int nsw_cluster_max;	/* maximum VOP I/O allowed		*/
168 
169 static struct swblock **swhash;
170 static int swhash_mask;
171 static struct mtx swhash_mtx;
172 
173 static int swap_async_max = 4;	/* maximum in-progress async I/O's	*/
174 static struct sx sw_alloc_sx;
175 
176 
177 SYSCTL_INT(_vm, OID_AUTO, swap_async_max,
178         CTLFLAG_RW, &swap_async_max, 0, "Maximum running async swap ops");
179 
180 /*
181  * "named" and "unnamed" anon region objects.  Try to reduce the overhead
182  * of searching a named list by hashing it just a little.
183  */
184 
185 #define NOBJLISTS		8
186 
187 #define NOBJLIST(handle)	\
188 	(&swap_pager_object_list[((int)(intptr_t)handle >> 4) & (NOBJLISTS-1)])
189 
190 static struct mtx sw_alloc_mtx;	/* protect list manipulation */
191 static struct pagerlst	swap_pager_object_list[NOBJLISTS];
192 static uma_zone_t	swap_zone;
193 static struct vm_object	swap_zone_obj;
194 
195 /*
196  * pagerops for OBJT_SWAP - "swap pager".  Some ops are also global procedure
197  * calls hooked from other parts of the VM system and do not appear here.
198  * (see vm/swap_pager.h).
199  */
200 static vm_object_t
201 		swap_pager_alloc(void *handle, vm_ooffset_t size,
202 				      vm_prot_t prot, vm_ooffset_t offset);
203 static void	swap_pager_dealloc(vm_object_t object);
204 static int	swap_pager_getpages(vm_object_t, vm_page_t *, int, int);
205 static void	swap_pager_putpages(vm_object_t, vm_page_t *, int, boolean_t, int *);
206 static boolean_t
207 		swap_pager_haspage(vm_object_t object, vm_pindex_t pindex, int *before, int *after);
208 static void	swap_pager_init(void);
209 static void	swap_pager_unswapped(vm_page_t);
210 static void	swap_pager_swapoff(struct swdevt *sp);
211 
212 struct pagerops swappagerops = {
213 	.pgo_init =	swap_pager_init,	/* early system initialization of pager	*/
214 	.pgo_alloc =	swap_pager_alloc,	/* allocate an OBJT_SWAP object		*/
215 	.pgo_dealloc =	swap_pager_dealloc,	/* deallocate an OBJT_SWAP object	*/
216 	.pgo_getpages =	swap_pager_getpages,	/* pagein				*/
217 	.pgo_putpages =	swap_pager_putpages,	/* pageout				*/
218 	.pgo_haspage =	swap_pager_haspage,	/* get backing store status for page	*/
219 	.pgo_pageunswapped = swap_pager_unswapped,	/* remove swap related to page		*/
220 };
221 
222 /*
223  * dmmax is in page-sized chunks with the new swap system.  It was
224  * dev-bsized chunks in the old.  dmmax is always a power of 2.
225  *
226  * swap_*() routines are externally accessible.  swp_*() routines are
227  * internal.
228  */
229 static int dmmax;
230 static int nswap_lowat = 128;	/* in pages, swap_pager_almost_full warn */
231 static int nswap_hiwat = 512;	/* in pages, swap_pager_almost_full warn */
232 
233 SYSCTL_INT(_vm, OID_AUTO, dmmax,
234 	CTLFLAG_RD, &dmmax, 0, "Maximum size of a swap block");
235 
236 static void	swp_sizecheck(void);
237 static void	swp_pager_async_iodone(struct buf *bp);
238 static int	swapongeom(struct thread *, struct vnode *);
239 static int	swaponvp(struct thread *, struct vnode *, u_long);
240 static int	swapoff_one(struct swdevt *sp, struct ucred *cred);
241 
242 /*
243  * Swap bitmap functions
244  */
245 static void	swp_pager_freeswapspace(daddr_t blk, int npages);
246 static daddr_t	swp_pager_getswapspace(int npages);
247 
248 /*
249  * Metadata functions
250  */
251 static struct swblock **swp_pager_hash(vm_object_t object, vm_pindex_t index);
252 static void swp_pager_meta_build(vm_object_t, vm_pindex_t, daddr_t);
253 static void swp_pager_meta_free(vm_object_t, vm_pindex_t, daddr_t);
254 static void swp_pager_meta_free_all(vm_object_t);
255 static daddr_t swp_pager_meta_ctl(vm_object_t, vm_pindex_t, int);
256 
257 /*
258  * SWP_SIZECHECK() -	update swap_pager_full indication
259  *
260  *	update the swap_pager_almost_full indication and warn when we are
261  *	about to run out of swap space, using lowat/hiwat hysteresis.
262  *
263  *	Clear swap_pager_full ( task killing ) indication when lowat is met.
264  *
265  *	No restrictions on call
266  *	This routine may not block.
267  *	This routine must be called at splvm()
268  */
269 static void
270 swp_sizecheck(void)
271 {
272 
273 	if (swap_pager_avail < nswap_lowat) {
274 		if (swap_pager_almost_full == 0) {
275 			printf("swap_pager: out of swap space\n");
276 			swap_pager_almost_full = 1;
277 		}
278 	} else {
279 		swap_pager_full = 0;
280 		if (swap_pager_avail > nswap_hiwat)
281 			swap_pager_almost_full = 0;
282 	}
283 }
284 
285 /*
286  * SWP_PAGER_HASH() -	hash swap meta data
287  *
288  *	This is an helper function which hashes the swapblk given
289  *	the object and page index.  It returns a pointer to a pointer
290  *	to the object, or a pointer to a NULL pointer if it could not
291  *	find a swapblk.
292  *
293  *	This routine must be called at splvm().
294  */
295 static struct swblock **
296 swp_pager_hash(vm_object_t object, vm_pindex_t index)
297 {
298 	struct swblock **pswap;
299 	struct swblock *swap;
300 
301 	index &= ~(vm_pindex_t)SWAP_META_MASK;
302 	pswap = &swhash[(index ^ (int)(intptr_t)object) & swhash_mask];
303 	while ((swap = *pswap) != NULL) {
304 		if (swap->swb_object == object &&
305 		    swap->swb_index == index
306 		) {
307 			break;
308 		}
309 		pswap = &swap->swb_hnext;
310 	}
311 	return (pswap);
312 }
313 
314 /*
315  * SWAP_PAGER_INIT() -	initialize the swap pager!
316  *
317  *	Expected to be started from system init.  NOTE:  This code is run
318  *	before much else so be careful what you depend on.  Most of the VM
319  *	system has yet to be initialized at this point.
320  */
321 static void
322 swap_pager_init(void)
323 {
324 	/*
325 	 * Initialize object lists
326 	 */
327 	int i;
328 
329 	for (i = 0; i < NOBJLISTS; ++i)
330 		TAILQ_INIT(&swap_pager_object_list[i]);
331 	mtx_init(&sw_alloc_mtx, "swap_pager list", NULL, MTX_DEF);
332 	mtx_init(&sw_dev_mtx, "swapdev", NULL, MTX_DEF);
333 
334 	/*
335 	 * Device Stripe, in PAGE_SIZE'd blocks
336 	 */
337 	dmmax = SWB_NPAGES * 2;
338 }
339 
340 /*
341  * SWAP_PAGER_SWAP_INIT() - swap pager initialization from pageout process
342  *
343  *	Expected to be started from pageout process once, prior to entering
344  *	its main loop.
345  */
346 void
347 swap_pager_swap_init(void)
348 {
349 	int n, n2;
350 
351 	/*
352 	 * Number of in-transit swap bp operations.  Don't
353 	 * exhaust the pbufs completely.  Make sure we
354 	 * initialize workable values (0 will work for hysteresis
355 	 * but it isn't very efficient).
356 	 *
357 	 * The nsw_cluster_max is constrained by the bp->b_pages[]
358 	 * array (MAXPHYS/PAGE_SIZE) and our locally defined
359 	 * MAX_PAGEOUT_CLUSTER.   Also be aware that swap ops are
360 	 * constrained by the swap device interleave stripe size.
361 	 *
362 	 * Currently we hardwire nsw_wcount_async to 4.  This limit is
363 	 * designed to prevent other I/O from having high latencies due to
364 	 * our pageout I/O.  The value 4 works well for one or two active swap
365 	 * devices but is probably a little low if you have more.  Even so,
366 	 * a higher value would probably generate only a limited improvement
367 	 * with three or four active swap devices since the system does not
368 	 * typically have to pageout at extreme bandwidths.   We will want
369 	 * at least 2 per swap devices, and 4 is a pretty good value if you
370 	 * have one NFS swap device due to the command/ack latency over NFS.
371 	 * So it all works out pretty well.
372 	 */
373 	nsw_cluster_max = min((MAXPHYS/PAGE_SIZE), MAX_PAGEOUT_CLUSTER);
374 
375 	mtx_lock(&pbuf_mtx);
376 	nsw_rcount = (nswbuf + 1) / 2;
377 	nsw_wcount_sync = (nswbuf + 3) / 4;
378 	nsw_wcount_async = 4;
379 	nsw_wcount_async_max = nsw_wcount_async;
380 	mtx_unlock(&pbuf_mtx);
381 
382 	/*
383 	 * Initialize our zone.  Right now I'm just guessing on the number
384 	 * we need based on the number of pages in the system.  Each swblock
385 	 * can hold 16 pages, so this is probably overkill.  This reservation
386 	 * is typically limited to around 32MB by default.
387 	 */
388 	n = cnt.v_page_count / 2;
389 	if (maxswzone && n > maxswzone / sizeof(struct swblock))
390 		n = maxswzone / sizeof(struct swblock);
391 	n2 = n;
392 	swap_zone = uma_zcreate("SWAPMETA", sizeof(struct swblock), NULL, NULL,
393 	    NULL, NULL, UMA_ALIGN_PTR, UMA_ZONE_NOFREE | UMA_ZONE_VM);
394 	if (swap_zone == NULL)
395 		panic("failed to create swap_zone.");
396 	do {
397 		if (uma_zone_set_obj(swap_zone, &swap_zone_obj, n))
398 			break;
399 		/*
400 		 * if the allocation failed, try a zone two thirds the
401 		 * size of the previous attempt.
402 		 */
403 		n -= ((n + 2) / 3);
404 	} while (n > 0);
405 	if (n2 != n)
406 		printf("Swap zone entries reduced from %d to %d.\n", n2, n);
407 	n2 = n;
408 
409 	/*
410 	 * Initialize our meta-data hash table.  The swapper does not need to
411 	 * be quite as efficient as the VM system, so we do not use an
412 	 * oversized hash table.
413 	 *
414 	 * 	n: 		size of hash table, must be power of 2
415 	 *	swhash_mask:	hash table index mask
416 	 */
417 	for (n = 1; n < n2 / 8; n *= 2)
418 		;
419 	swhash = malloc(sizeof(struct swblock *) * n, M_VMPGDATA, M_WAITOK | M_ZERO);
420 	swhash_mask = n - 1;
421 	mtx_init(&swhash_mtx, "swap_pager swhash", NULL, MTX_DEF);
422 }
423 
424 /*
425  * SWAP_PAGER_ALLOC() -	allocate a new OBJT_SWAP VM object and instantiate
426  *			its metadata structures.
427  *
428  *	This routine is called from the mmap and fork code to create a new
429  *	OBJT_SWAP object.  We do this by creating an OBJT_DEFAULT object
430  *	and then converting it with swp_pager_meta_build().
431  *
432  *	This routine may block in vm_object_allocate() and create a named
433  *	object lookup race, so we must interlock.   We must also run at
434  *	splvm() for the object lookup to handle races with interrupts, but
435  *	we do not have to maintain splvm() in between the lookup and the
436  *	add because (I believe) it is not possible to attempt to create
437  *	a new swap object w/handle when a default object with that handle
438  *	already exists.
439  *
440  * MPSAFE
441  */
442 static vm_object_t
443 swap_pager_alloc(void *handle, vm_ooffset_t size, vm_prot_t prot,
444 		 vm_ooffset_t offset)
445 {
446 	vm_object_t object;
447 	vm_pindex_t pindex;
448 
449 	pindex = OFF_TO_IDX(offset + PAGE_MASK + size);
450 
451 	if (handle) {
452 		mtx_lock(&Giant);
453 		/*
454 		 * Reference existing named region or allocate new one.  There
455 		 * should not be a race here against swp_pager_meta_build()
456 		 * as called from vm_page_remove() in regards to the lookup
457 		 * of the handle.
458 		 */
459 		sx_xlock(&sw_alloc_sx);
460 		object = vm_pager_object_lookup(NOBJLIST(handle), handle);
461 
462 		if (object == NULL) {
463 			object = vm_object_allocate(OBJT_DEFAULT, pindex);
464 			object->handle = handle;
465 
466 			VM_OBJECT_LOCK(object);
467 			swp_pager_meta_build(object, 0, SWAPBLK_NONE);
468 			VM_OBJECT_UNLOCK(object);
469 		}
470 		sx_xunlock(&sw_alloc_sx);
471 		mtx_unlock(&Giant);
472 	} else {
473 		object = vm_object_allocate(OBJT_DEFAULT, pindex);
474 
475 		VM_OBJECT_LOCK(object);
476 		swp_pager_meta_build(object, 0, SWAPBLK_NONE);
477 		VM_OBJECT_UNLOCK(object);
478 	}
479 	return (object);
480 }
481 
482 /*
483  * SWAP_PAGER_DEALLOC() -	remove swap metadata from object
484  *
485  *	The swap backing for the object is destroyed.  The code is
486  *	designed such that we can reinstantiate it later, but this
487  *	routine is typically called only when the entire object is
488  *	about to be destroyed.
489  *
490  *	This routine may block, but no longer does.
491  *
492  *	The object must be locked or unreferenceable.
493  */
494 static void
495 swap_pager_dealloc(vm_object_t object)
496 {
497 
498 	/*
499 	 * Remove from list right away so lookups will fail if we block for
500 	 * pageout completion.
501 	 */
502 	if (object->handle != NULL) {
503 		mtx_lock(&sw_alloc_mtx);
504 		TAILQ_REMOVE(NOBJLIST(object->handle), object, pager_object_list);
505 		mtx_unlock(&sw_alloc_mtx);
506 	}
507 
508 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
509 	vm_object_pip_wait(object, "swpdea");
510 
511 	/*
512 	 * Free all remaining metadata.  We only bother to free it from
513 	 * the swap meta data.  We do not attempt to free swapblk's still
514 	 * associated with vm_page_t's for this object.  We do not care
515 	 * if paging is still in progress on some objects.
516 	 */
517 	swp_pager_meta_free_all(object);
518 }
519 
520 /************************************************************************
521  *			SWAP PAGER BITMAP ROUTINES			*
522  ************************************************************************/
523 
524 /*
525  * SWP_PAGER_GETSWAPSPACE() -	allocate raw swap space
526  *
527  *	Allocate swap for the requested number of pages.  The starting
528  *	swap block number (a page index) is returned or SWAPBLK_NONE
529  *	if the allocation failed.
530  *
531  *	Also has the side effect of advising that somebody made a mistake
532  *	when they configured swap and didn't configure enough.
533  *
534  *	Must be called at splvm() to avoid races with bitmap frees from
535  *	vm_page_remove() aka swap_pager_page_removed().
536  *
537  *	This routine may not block
538  *	This routine must be called at splvm().
539  *
540  *	We allocate in round-robin fashion from the configured devices.
541  */
542 static daddr_t
543 swp_pager_getswapspace(int npages)
544 {
545 	daddr_t blk;
546 	struct swdevt *sp;
547 	int i;
548 
549 	blk = SWAPBLK_NONE;
550 	mtx_lock(&sw_dev_mtx);
551 	sp = swdevhd;
552 	for (i = 0; i < nswapdev; i++) {
553 		if (sp == NULL)
554 			sp = TAILQ_FIRST(&swtailq);
555 		if (!(sp->sw_flags & SW_CLOSING)) {
556 			blk = blist_alloc(sp->sw_blist, npages);
557 			if (blk != SWAPBLK_NONE) {
558 				blk += sp->sw_first;
559 				sp->sw_used += npages;
560 				swap_pager_avail -= npages;
561 				swp_sizecheck();
562 				swdevhd = TAILQ_NEXT(sp, sw_list);
563 				goto done;
564 			}
565 		}
566 		sp = TAILQ_NEXT(sp, sw_list);
567 	}
568 	if (swap_pager_full != 2) {
569 		printf("swap_pager_getswapspace(%d): failed\n", npages);
570 		swap_pager_full = 2;
571 		swap_pager_almost_full = 1;
572 	}
573 	swdevhd = NULL;
574 done:
575 	mtx_unlock(&sw_dev_mtx);
576 	return (blk);
577 }
578 
579 static int
580 swp_pager_isondev(daddr_t blk, struct swdevt *sp)
581 {
582 
583 	return (blk >= sp->sw_first && blk < sp->sw_end);
584 }
585 
586 static void
587 swp_pager_strategy(struct buf *bp)
588 {
589 	struct swdevt *sp;
590 
591 	mtx_lock(&sw_dev_mtx);
592 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
593 		if (bp->b_blkno >= sp->sw_first && bp->b_blkno < sp->sw_end) {
594 			mtx_unlock(&sw_dev_mtx);
595 			sp->sw_strategy(bp, sp);
596 			return;
597 		}
598 	}
599 	panic("Swapdev not found");
600 }
601 
602 
603 /*
604  * SWP_PAGER_FREESWAPSPACE() -	free raw swap space
605  *
606  *	This routine returns the specified swap blocks back to the bitmap.
607  *
608  *	Note:  This routine may not block (it could in the old swap code),
609  *	and through the use of the new blist routines it does not block.
610  *
611  *	We must be called at splvm() to avoid races with bitmap frees from
612  *	vm_page_remove() aka swap_pager_page_removed().
613  *
614  *	This routine may not block
615  *	This routine must be called at splvm().
616  */
617 static void
618 swp_pager_freeswapspace(daddr_t blk, int npages)
619 {
620 	struct swdevt *sp;
621 
622 	mtx_lock(&sw_dev_mtx);
623 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
624 		if (blk >= sp->sw_first && blk < sp->sw_end) {
625 			sp->sw_used -= npages;
626 			/*
627 			 * If we are attempting to stop swapping on
628 			 * this device, we don't want to mark any
629 			 * blocks free lest they be reused.
630 			 */
631 			if ((sp->sw_flags & SW_CLOSING) == 0) {
632 				blist_free(sp->sw_blist, blk - sp->sw_first,
633 				    npages);
634 				swap_pager_avail += npages;
635 				swp_sizecheck();
636 			}
637 			mtx_unlock(&sw_dev_mtx);
638 			return;
639 		}
640 	}
641 	panic("Swapdev not found");
642 }
643 
644 /*
645  * SWAP_PAGER_FREESPACE() -	frees swap blocks associated with a page
646  *				range within an object.
647  *
648  *	This is a globally accessible routine.
649  *
650  *	This routine removes swapblk assignments from swap metadata.
651  *
652  *	The external callers of this routine typically have already destroyed
653  *	or renamed vm_page_t's associated with this range in the object so
654  *	we should be ok.
655  *
656  *	This routine may be called at any spl.  We up our spl to splvm temporarily
657  *	in order to perform the metadata removal.
658  */
659 void
660 swap_pager_freespace(vm_object_t object, vm_pindex_t start, vm_size_t size)
661 {
662 
663 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
664 	swp_pager_meta_free(object, start, size);
665 }
666 
667 /*
668  * SWAP_PAGER_RESERVE() - reserve swap blocks in object
669  *
670  *	Assigns swap blocks to the specified range within the object.  The
671  *	swap blocks are not zerod.  Any previous swap assignment is destroyed.
672  *
673  *	Returns 0 on success, -1 on failure.
674  */
675 int
676 swap_pager_reserve(vm_object_t object, vm_pindex_t start, vm_size_t size)
677 {
678 	int n = 0;
679 	daddr_t blk = SWAPBLK_NONE;
680 	vm_pindex_t beg = start;	/* save start index */
681 
682 	VM_OBJECT_LOCK(object);
683 	while (size) {
684 		if (n == 0) {
685 			n = BLIST_MAX_ALLOC;
686 			while ((blk = swp_pager_getswapspace(n)) == SWAPBLK_NONE) {
687 				n >>= 1;
688 				if (n == 0) {
689 					swp_pager_meta_free(object, beg, start - beg);
690 					VM_OBJECT_UNLOCK(object);
691 					return (-1);
692 				}
693 			}
694 		}
695 		swp_pager_meta_build(object, start, blk);
696 		--size;
697 		++start;
698 		++blk;
699 		--n;
700 	}
701 	swp_pager_meta_free(object, start, n);
702 	VM_OBJECT_UNLOCK(object);
703 	return (0);
704 }
705 
706 /*
707  * SWAP_PAGER_COPY() -  copy blocks from source pager to destination pager
708  *			and destroy the source.
709  *
710  *	Copy any valid swapblks from the source to the destination.  In
711  *	cases where both the source and destination have a valid swapblk,
712  *	we keep the destination's.
713  *
714  *	This routine is allowed to block.  It may block allocating metadata
715  *	indirectly through swp_pager_meta_build() or if paging is still in
716  *	progress on the source.
717  *
718  *	This routine can be called at any spl
719  *
720  *	XXX vm_page_collapse() kinda expects us not to block because we
721  *	supposedly do not need to allocate memory, but for the moment we
722  *	*may* have to get a little memory from the zone allocator, but
723  *	it is taken from the interrupt memory.  We should be ok.
724  *
725  *	The source object contains no vm_page_t's (which is just as well)
726  *
727  *	The source object is of type OBJT_SWAP.
728  *
729  *	The source and destination objects must be locked or
730  *	inaccessible (XXX are they ?)
731  */
732 void
733 swap_pager_copy(vm_object_t srcobject, vm_object_t dstobject,
734     vm_pindex_t offset, int destroysource)
735 {
736 	vm_pindex_t i;
737 
738 	VM_OBJECT_LOCK_ASSERT(srcobject, MA_OWNED);
739 	VM_OBJECT_LOCK_ASSERT(dstobject, MA_OWNED);
740 
741 	/*
742 	 * If destroysource is set, we remove the source object from the
743 	 * swap_pager internal queue now.
744 	 */
745 	if (destroysource) {
746 		if (srcobject->handle != NULL) {
747 			mtx_lock(&sw_alloc_mtx);
748 			TAILQ_REMOVE(
749 			    NOBJLIST(srcobject->handle),
750 			    srcobject,
751 			    pager_object_list
752 			);
753 			mtx_unlock(&sw_alloc_mtx);
754 		}
755 	}
756 
757 	/*
758 	 * transfer source to destination.
759 	 */
760 	for (i = 0; i < dstobject->size; ++i) {
761 		daddr_t dstaddr;
762 
763 		/*
764 		 * Locate (without changing) the swapblk on the destination,
765 		 * unless it is invalid in which case free it silently, or
766 		 * if the destination is a resident page, in which case the
767 		 * source is thrown away.
768 		 */
769 		dstaddr = swp_pager_meta_ctl(dstobject, i, 0);
770 
771 		if (dstaddr == SWAPBLK_NONE) {
772 			/*
773 			 * Destination has no swapblk and is not resident,
774 			 * copy source.
775 			 */
776 			daddr_t srcaddr;
777 
778 			srcaddr = swp_pager_meta_ctl(
779 			    srcobject,
780 			    i + offset,
781 			    SWM_POP
782 			);
783 
784 			if (srcaddr != SWAPBLK_NONE) {
785 				/*
786 				 * swp_pager_meta_build() can sleep.
787 				 */
788 				vm_object_pip_add(srcobject, 1);
789 				VM_OBJECT_UNLOCK(srcobject);
790 				vm_object_pip_add(dstobject, 1);
791 				swp_pager_meta_build(dstobject, i, srcaddr);
792 				vm_object_pip_wakeup(dstobject);
793 				VM_OBJECT_LOCK(srcobject);
794 				vm_object_pip_wakeup(srcobject);
795 			}
796 		} else {
797 			/*
798 			 * Destination has valid swapblk or it is represented
799 			 * by a resident page.  We destroy the sourceblock.
800 			 */
801 
802 			swp_pager_meta_ctl(srcobject, i + offset, SWM_FREE);
803 		}
804 	}
805 
806 	/*
807 	 * Free left over swap blocks in source.
808 	 *
809 	 * We have to revert the type to OBJT_DEFAULT so we do not accidently
810 	 * double-remove the object from the swap queues.
811 	 */
812 	if (destroysource) {
813 		swp_pager_meta_free_all(srcobject);
814 		/*
815 		 * Reverting the type is not necessary, the caller is going
816 		 * to destroy srcobject directly, but I'm doing it here
817 		 * for consistency since we've removed the object from its
818 		 * queues.
819 		 */
820 		srcobject->type = OBJT_DEFAULT;
821 	}
822 }
823 
824 /*
825  * SWAP_PAGER_HASPAGE() -	determine if we have good backing store for
826  *				the requested page.
827  *
828  *	We determine whether good backing store exists for the requested
829  *	page and return TRUE if it does, FALSE if it doesn't.
830  *
831  *	If TRUE, we also try to determine how much valid, contiguous backing
832  *	store exists before and after the requested page within a reasonable
833  *	distance.  We do not try to restrict it to the swap device stripe
834  *	(that is handled in getpages/putpages).  It probably isn't worth
835  *	doing here.
836  */
837 static boolean_t
838 swap_pager_haspage(vm_object_t object, vm_pindex_t pindex, int *before, int *after)
839 {
840 	daddr_t blk0;
841 
842 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
843 	/*
844 	 * do we have good backing store at the requested index ?
845 	 */
846 	blk0 = swp_pager_meta_ctl(object, pindex, 0);
847 
848 	if (blk0 == SWAPBLK_NONE) {
849 		if (before)
850 			*before = 0;
851 		if (after)
852 			*after = 0;
853 		return (FALSE);
854 	}
855 
856 	/*
857 	 * find backwards-looking contiguous good backing store
858 	 */
859 	if (before != NULL) {
860 		int i;
861 
862 		for (i = 1; i < (SWB_NPAGES/2); ++i) {
863 			daddr_t blk;
864 
865 			if (i > pindex)
866 				break;
867 			blk = swp_pager_meta_ctl(object, pindex - i, 0);
868 			if (blk != blk0 - i)
869 				break;
870 		}
871 		*before = (i - 1);
872 	}
873 
874 	/*
875 	 * find forward-looking contiguous good backing store
876 	 */
877 	if (after != NULL) {
878 		int i;
879 
880 		for (i = 1; i < (SWB_NPAGES/2); ++i) {
881 			daddr_t blk;
882 
883 			blk = swp_pager_meta_ctl(object, pindex + i, 0);
884 			if (blk != blk0 + i)
885 				break;
886 		}
887 		*after = (i - 1);
888 	}
889 	return (TRUE);
890 }
891 
892 /*
893  * SWAP_PAGER_PAGE_UNSWAPPED() - remove swap backing store related to page
894  *
895  *	This removes any associated swap backing store, whether valid or
896  *	not, from the page.
897  *
898  *	This routine is typically called when a page is made dirty, at
899  *	which point any associated swap can be freed.  MADV_FREE also
900  *	calls us in a special-case situation
901  *
902  *	NOTE!!!  If the page is clean and the swap was valid, the caller
903  *	should make the page dirty before calling this routine.  This routine
904  *	does NOT change the m->dirty status of the page.  Also: MADV_FREE
905  *	depends on it.
906  *
907  *	This routine may not block
908  *	This routine must be called at splvm()
909  */
910 static void
911 swap_pager_unswapped(vm_page_t m)
912 {
913 
914 	VM_OBJECT_LOCK_ASSERT(m->object, MA_OWNED);
915 	swp_pager_meta_ctl(m->object, m->pindex, SWM_FREE);
916 }
917 
918 /*
919  * SWAP_PAGER_GETPAGES() - bring pages in from swap
920  *
921  *	Attempt to retrieve (m, count) pages from backing store, but make
922  *	sure we retrieve at least m[reqpage].  We try to load in as large
923  *	a chunk surrounding m[reqpage] as is contiguous in swap and which
924  *	belongs to the same object.
925  *
926  *	The code is designed for asynchronous operation and
927  *	immediate-notification of 'reqpage' but tends not to be
928  *	used that way.  Please do not optimize-out this algorithmic
929  *	feature, I intend to improve on it in the future.
930  *
931  *	The parent has a single vm_object_pip_add() reference prior to
932  *	calling us and we should return with the same.
933  *
934  *	The parent has BUSY'd the pages.  We should return with 'm'
935  *	left busy, but the others adjusted.
936  */
937 static int
938 swap_pager_getpages(vm_object_t object, vm_page_t *m, int count, int reqpage)
939 {
940 	struct buf *bp;
941 	vm_page_t mreq;
942 	int i;
943 	int j;
944 	daddr_t blk;
945 
946 	mreq = m[reqpage];
947 
948 	KASSERT(mreq->object == object,
949 	    ("swap_pager_getpages: object mismatch %p/%p",
950 	    object, mreq->object));
951 
952 	/*
953 	 * Calculate range to retrieve.  The pages have already been assigned
954 	 * their swapblks.  We require a *contiguous* range but we know it to
955 	 * not span devices.   If we do not supply it, bad things
956 	 * happen.  Note that blk, iblk & jblk can be SWAPBLK_NONE, but the
957 	 * loops are set up such that the case(s) are handled implicitly.
958 	 *
959 	 * The swp_*() calls must be made at splvm().  vm_page_free() does
960 	 * not need to be, but it will go a little faster if it is.
961 	 */
962 	blk = swp_pager_meta_ctl(mreq->object, mreq->pindex, 0);
963 
964 	for (i = reqpage - 1; i >= 0; --i) {
965 		daddr_t iblk;
966 
967 		iblk = swp_pager_meta_ctl(m[i]->object, m[i]->pindex, 0);
968 		if (blk != iblk + (reqpage - i))
969 			break;
970 	}
971 	++i;
972 
973 	for (j = reqpage + 1; j < count; ++j) {
974 		daddr_t jblk;
975 
976 		jblk = swp_pager_meta_ctl(m[j]->object, m[j]->pindex, 0);
977 		if (blk != jblk - (j - reqpage))
978 			break;
979 	}
980 
981 	/*
982 	 * free pages outside our collection range.   Note: we never free
983 	 * mreq, it must remain busy throughout.
984 	 */
985 	if (0 < i || j < count) {
986 		int k;
987 
988 		vm_page_lock_queues();
989 		for (k = 0; k < i; ++k)
990 			vm_page_free(m[k]);
991 		for (k = j; k < count; ++k)
992 			vm_page_free(m[k]);
993 		vm_page_unlock_queues();
994 	}
995 
996 	/*
997 	 * Return VM_PAGER_FAIL if we have nothing to do.  Return mreq
998 	 * still busy, but the others unbusied.
999 	 */
1000 	if (blk == SWAPBLK_NONE)
1001 		return (VM_PAGER_FAIL);
1002 
1003 	/*
1004 	 * Getpbuf() can sleep.
1005 	 */
1006 	VM_OBJECT_UNLOCK(object);
1007 	/*
1008 	 * Get a swap buffer header to perform the IO
1009 	 */
1010 	bp = getpbuf(&nsw_rcount);
1011 	bp->b_flags |= B_PAGING;
1012 
1013 	/*
1014 	 * map our page(s) into kva for input
1015 	 */
1016 	pmap_qenter((vm_offset_t)bp->b_data, m + i, j - i);
1017 
1018 	bp->b_iocmd = BIO_READ;
1019 	bp->b_iodone = swp_pager_async_iodone;
1020 	bp->b_rcred = crhold(thread0.td_ucred);
1021 	bp->b_wcred = crhold(thread0.td_ucred);
1022 	bp->b_blkno = blk - (reqpage - i);
1023 	bp->b_bcount = PAGE_SIZE * (j - i);
1024 	bp->b_bufsize = PAGE_SIZE * (j - i);
1025 	bp->b_pager.pg_reqpage = reqpage - i;
1026 
1027 	VM_OBJECT_LOCK(object);
1028 	{
1029 		int k;
1030 
1031 		for (k = i; k < j; ++k) {
1032 			bp->b_pages[k - i] = m[k];
1033 			m[k]->oflags |= VPO_SWAPINPROG;
1034 		}
1035 	}
1036 	bp->b_npages = j - i;
1037 
1038 	PCPU_INC(cnt.v_swapin);
1039 	PCPU_ADD(cnt.v_swappgsin, bp->b_npages);
1040 
1041 	/*
1042 	 * We still hold the lock on mreq, and our automatic completion routine
1043 	 * does not remove it.
1044 	 */
1045 	vm_object_pip_add(object, bp->b_npages);
1046 	VM_OBJECT_UNLOCK(object);
1047 
1048 	/*
1049 	 * perform the I/O.  NOTE!!!  bp cannot be considered valid after
1050 	 * this point because we automatically release it on completion.
1051 	 * Instead, we look at the one page we are interested in which we
1052 	 * still hold a lock on even through the I/O completion.
1053 	 *
1054 	 * The other pages in our m[] array are also released on completion,
1055 	 * so we cannot assume they are valid anymore either.
1056 	 *
1057 	 * NOTE: b_blkno is destroyed by the call to swapdev_strategy
1058 	 */
1059 	BUF_KERNPROC(bp);
1060 	swp_pager_strategy(bp);
1061 
1062 	/*
1063 	 * wait for the page we want to complete.  VPO_SWAPINPROG is always
1064 	 * cleared on completion.  If an I/O error occurs, SWAPBLK_NONE
1065 	 * is set in the meta-data.
1066 	 */
1067 	VM_OBJECT_LOCK(object);
1068 	while ((mreq->oflags & VPO_SWAPINPROG) != 0) {
1069 		mreq->oflags |= VPO_WANTED;
1070 		vm_page_lock_queues();
1071 		vm_page_flag_set(mreq, PG_REFERENCED);
1072 		vm_page_unlock_queues();
1073 		PCPU_INC(cnt.v_intrans);
1074 		if (msleep(mreq, VM_OBJECT_MTX(object), PSWP, "swread", hz*20)) {
1075 			printf(
1076 "swap_pager: indefinite wait buffer: bufobj: %p, blkno: %jd, size: %ld\n",
1077 			    bp->b_bufobj, (intmax_t)bp->b_blkno, bp->b_bcount);
1078 		}
1079 	}
1080 
1081 	/*
1082 	 * mreq is left busied after completion, but all the other pages
1083 	 * are freed.  If we had an unrecoverable read error the page will
1084 	 * not be valid.
1085 	 */
1086 	if (mreq->valid != VM_PAGE_BITS_ALL) {
1087 		return (VM_PAGER_ERROR);
1088 	} else {
1089 		return (VM_PAGER_OK);
1090 	}
1091 
1092 	/*
1093 	 * A final note: in a low swap situation, we cannot deallocate swap
1094 	 * and mark a page dirty here because the caller is likely to mark
1095 	 * the page clean when we return, causing the page to possibly revert
1096 	 * to all-zero's later.
1097 	 */
1098 }
1099 
1100 /*
1101  *	swap_pager_putpages:
1102  *
1103  *	Assign swap (if necessary) and initiate I/O on the specified pages.
1104  *
1105  *	We support both OBJT_DEFAULT and OBJT_SWAP objects.  DEFAULT objects
1106  *	are automatically converted to SWAP objects.
1107  *
1108  *	In a low memory situation we may block in VOP_STRATEGY(), but the new
1109  *	vm_page reservation system coupled with properly written VFS devices
1110  *	should ensure that no low-memory deadlock occurs.  This is an area
1111  *	which needs work.
1112  *
1113  *	The parent has N vm_object_pip_add() references prior to
1114  *	calling us and will remove references for rtvals[] that are
1115  *	not set to VM_PAGER_PEND.  We need to remove the rest on I/O
1116  *	completion.
1117  *
1118  *	The parent has soft-busy'd the pages it passes us and will unbusy
1119  *	those whos rtvals[] entry is not set to VM_PAGER_PEND on return.
1120  *	We need to unbusy the rest on I/O completion.
1121  */
1122 void
1123 swap_pager_putpages(vm_object_t object, vm_page_t *m, int count,
1124     boolean_t sync, int *rtvals)
1125 {
1126 	int i;
1127 	int n = 0;
1128 
1129 	if (count && m[0]->object != object) {
1130 		panic("swap_pager_putpages: object mismatch %p/%p",
1131 		    object,
1132 		    m[0]->object
1133 		);
1134 	}
1135 
1136 	/*
1137 	 * Step 1
1138 	 *
1139 	 * Turn object into OBJT_SWAP
1140 	 * check for bogus sysops
1141 	 * force sync if not pageout process
1142 	 */
1143 	if (object->type != OBJT_SWAP)
1144 		swp_pager_meta_build(object, 0, SWAPBLK_NONE);
1145 	VM_OBJECT_UNLOCK(object);
1146 
1147 	if (curproc != pageproc)
1148 		sync = TRUE;
1149 
1150 	/*
1151 	 * Step 2
1152 	 *
1153 	 * Update nsw parameters from swap_async_max sysctl values.
1154 	 * Do not let the sysop crash the machine with bogus numbers.
1155 	 */
1156 	mtx_lock(&pbuf_mtx);
1157 	if (swap_async_max != nsw_wcount_async_max) {
1158 		int n;
1159 
1160 		/*
1161 		 * limit range
1162 		 */
1163 		if ((n = swap_async_max) > nswbuf / 2)
1164 			n = nswbuf / 2;
1165 		if (n < 1)
1166 			n = 1;
1167 		swap_async_max = n;
1168 
1169 		/*
1170 		 * Adjust difference ( if possible ).  If the current async
1171 		 * count is too low, we may not be able to make the adjustment
1172 		 * at this time.
1173 		 */
1174 		n -= nsw_wcount_async_max;
1175 		if (nsw_wcount_async + n >= 0) {
1176 			nsw_wcount_async += n;
1177 			nsw_wcount_async_max += n;
1178 			wakeup(&nsw_wcount_async);
1179 		}
1180 	}
1181 	mtx_unlock(&pbuf_mtx);
1182 
1183 	/*
1184 	 * Step 3
1185 	 *
1186 	 * Assign swap blocks and issue I/O.  We reallocate swap on the fly.
1187 	 * The page is left dirty until the pageout operation completes
1188 	 * successfully.
1189 	 */
1190 	for (i = 0; i < count; i += n) {
1191 		int j;
1192 		struct buf *bp;
1193 		daddr_t blk;
1194 
1195 		/*
1196 		 * Maximum I/O size is limited by a number of factors.
1197 		 */
1198 		n = min(BLIST_MAX_ALLOC, count - i);
1199 		n = min(n, nsw_cluster_max);
1200 
1201 		/*
1202 		 * Get biggest block of swap we can.  If we fail, fall
1203 		 * back and try to allocate a smaller block.  Don't go
1204 		 * overboard trying to allocate space if it would overly
1205 		 * fragment swap.
1206 		 */
1207 		while (
1208 		    (blk = swp_pager_getswapspace(n)) == SWAPBLK_NONE &&
1209 		    n > 4
1210 		) {
1211 			n >>= 1;
1212 		}
1213 		if (blk == SWAPBLK_NONE) {
1214 			for (j = 0; j < n; ++j)
1215 				rtvals[i+j] = VM_PAGER_FAIL;
1216 			continue;
1217 		}
1218 
1219 		/*
1220 		 * All I/O parameters have been satisfied, build the I/O
1221 		 * request and assign the swap space.
1222 		 */
1223 		if (sync == TRUE) {
1224 			bp = getpbuf(&nsw_wcount_sync);
1225 		} else {
1226 			bp = getpbuf(&nsw_wcount_async);
1227 			bp->b_flags = B_ASYNC;
1228 		}
1229 		bp->b_flags |= B_PAGING;
1230 		bp->b_iocmd = BIO_WRITE;
1231 
1232 		pmap_qenter((vm_offset_t)bp->b_data, &m[i], n);
1233 
1234 		bp->b_rcred = crhold(thread0.td_ucred);
1235 		bp->b_wcred = crhold(thread0.td_ucred);
1236 		bp->b_bcount = PAGE_SIZE * n;
1237 		bp->b_bufsize = PAGE_SIZE * n;
1238 		bp->b_blkno = blk;
1239 
1240 		VM_OBJECT_LOCK(object);
1241 		for (j = 0; j < n; ++j) {
1242 			vm_page_t mreq = m[i+j];
1243 
1244 			swp_pager_meta_build(
1245 			    mreq->object,
1246 			    mreq->pindex,
1247 			    blk + j
1248 			);
1249 			vm_page_dirty(mreq);
1250 			rtvals[i+j] = VM_PAGER_OK;
1251 
1252 			mreq->oflags |= VPO_SWAPINPROG;
1253 			bp->b_pages[j] = mreq;
1254 		}
1255 		VM_OBJECT_UNLOCK(object);
1256 		bp->b_npages = n;
1257 		/*
1258 		 * Must set dirty range for NFS to work.
1259 		 */
1260 		bp->b_dirtyoff = 0;
1261 		bp->b_dirtyend = bp->b_bcount;
1262 
1263 		PCPU_INC(cnt.v_swapout);
1264 		PCPU_ADD(cnt.v_swappgsout, bp->b_npages);
1265 
1266 		/*
1267 		 * asynchronous
1268 		 *
1269 		 * NOTE: b_blkno is destroyed by the call to swapdev_strategy
1270 		 */
1271 		if (sync == FALSE) {
1272 			bp->b_iodone = swp_pager_async_iodone;
1273 			BUF_KERNPROC(bp);
1274 			swp_pager_strategy(bp);
1275 
1276 			for (j = 0; j < n; ++j)
1277 				rtvals[i+j] = VM_PAGER_PEND;
1278 			/* restart outter loop */
1279 			continue;
1280 		}
1281 
1282 		/*
1283 		 * synchronous
1284 		 *
1285 		 * NOTE: b_blkno is destroyed by the call to swapdev_strategy
1286 		 */
1287 		bp->b_iodone = bdone;
1288 		swp_pager_strategy(bp);
1289 
1290 		/*
1291 		 * Wait for the sync I/O to complete, then update rtvals.
1292 		 * We just set the rtvals[] to VM_PAGER_PEND so we can call
1293 		 * our async completion routine at the end, thus avoiding a
1294 		 * double-free.
1295 		 */
1296 		bwait(bp, PVM, "swwrt");
1297 		for (j = 0; j < n; ++j)
1298 			rtvals[i+j] = VM_PAGER_PEND;
1299 		/*
1300 		 * Now that we are through with the bp, we can call the
1301 		 * normal async completion, which frees everything up.
1302 		 */
1303 		swp_pager_async_iodone(bp);
1304 	}
1305 	VM_OBJECT_LOCK(object);
1306 }
1307 
1308 /*
1309  *	swp_pager_async_iodone:
1310  *
1311  *	Completion routine for asynchronous reads and writes from/to swap.
1312  *	Also called manually by synchronous code to finish up a bp.
1313  *
1314  *	For READ operations, the pages are PG_BUSY'd.  For WRITE operations,
1315  *	the pages are vm_page_t->busy'd.  For READ operations, we PG_BUSY
1316  *	unbusy all pages except the 'main' request page.  For WRITE
1317  *	operations, we vm_page_t->busy'd unbusy all pages ( we can do this
1318  *	because we marked them all VM_PAGER_PEND on return from putpages ).
1319  *
1320  *	This routine may not block.
1321  */
1322 static void
1323 swp_pager_async_iodone(struct buf *bp)
1324 {
1325 	int i;
1326 	vm_object_t object = NULL;
1327 
1328 	/*
1329 	 * report error
1330 	 */
1331 	if (bp->b_ioflags & BIO_ERROR) {
1332 		printf(
1333 		    "swap_pager: I/O error - %s failed; blkno %ld,"
1334 			"size %ld, error %d\n",
1335 		    ((bp->b_iocmd == BIO_READ) ? "pagein" : "pageout"),
1336 		    (long)bp->b_blkno,
1337 		    (long)bp->b_bcount,
1338 		    bp->b_error
1339 		);
1340 	}
1341 
1342 	/*
1343 	 * remove the mapping for kernel virtual
1344 	 */
1345 	pmap_qremove((vm_offset_t)bp->b_data, bp->b_npages);
1346 
1347 	if (bp->b_npages) {
1348 		object = bp->b_pages[0]->object;
1349 		VM_OBJECT_LOCK(object);
1350 	}
1351 	vm_page_lock_queues();
1352 	/*
1353 	 * cleanup pages.  If an error occurs writing to swap, we are in
1354 	 * very serious trouble.  If it happens to be a disk error, though,
1355 	 * we may be able to recover by reassigning the swap later on.  So
1356 	 * in this case we remove the m->swapblk assignment for the page
1357 	 * but do not free it in the rlist.  The errornous block(s) are thus
1358 	 * never reallocated as swap.  Redirty the page and continue.
1359 	 */
1360 	for (i = 0; i < bp->b_npages; ++i) {
1361 		vm_page_t m = bp->b_pages[i];
1362 
1363 		m->oflags &= ~VPO_SWAPINPROG;
1364 
1365 		if (bp->b_ioflags & BIO_ERROR) {
1366 			/*
1367 			 * If an error occurs I'd love to throw the swapblk
1368 			 * away without freeing it back to swapspace, so it
1369 			 * can never be used again.  But I can't from an
1370 			 * interrupt.
1371 			 */
1372 			if (bp->b_iocmd == BIO_READ) {
1373 				/*
1374 				 * When reading, reqpage needs to stay
1375 				 * locked for the parent, but all other
1376 				 * pages can be freed.  We still want to
1377 				 * wakeup the parent waiting on the page,
1378 				 * though.  ( also: pg_reqpage can be -1 and
1379 				 * not match anything ).
1380 				 *
1381 				 * We have to wake specifically requested pages
1382 				 * up too because we cleared VPO_SWAPINPROG and
1383 				 * someone may be waiting for that.
1384 				 *
1385 				 * NOTE: for reads, m->dirty will probably
1386 				 * be overridden by the original caller of
1387 				 * getpages so don't play cute tricks here.
1388 				 */
1389 				m->valid = 0;
1390 				if (i != bp->b_pager.pg_reqpage)
1391 					vm_page_free(m);
1392 				else
1393 					vm_page_flash(m);
1394 				/*
1395 				 * If i == bp->b_pager.pg_reqpage, do not wake
1396 				 * the page up.  The caller needs to.
1397 				 */
1398 			} else {
1399 				/*
1400 				 * If a write error occurs, reactivate page
1401 				 * so it doesn't clog the inactive list,
1402 				 * then finish the I/O.
1403 				 */
1404 				vm_page_dirty(m);
1405 				vm_page_activate(m);
1406 				vm_page_io_finish(m);
1407 			}
1408 		} else if (bp->b_iocmd == BIO_READ) {
1409 			/*
1410 			 * For read success, clear dirty bits.  Nobody should
1411 			 * have this page mapped but don't take any chances,
1412 			 * make sure the pmap modify bits are also cleared.
1413 			 *
1414 			 * NOTE: for reads, m->dirty will probably be
1415 			 * overridden by the original caller of getpages so
1416 			 * we cannot set them in order to free the underlying
1417 			 * swap in a low-swap situation.  I don't think we'd
1418 			 * want to do that anyway, but it was an optimization
1419 			 * that existed in the old swapper for a time before
1420 			 * it got ripped out due to precisely this problem.
1421 			 *
1422 			 * If not the requested page then deactivate it.
1423 			 *
1424 			 * Note that the requested page, reqpage, is left
1425 			 * busied, but we still have to wake it up.  The
1426 			 * other pages are released (unbusied) by
1427 			 * vm_page_wakeup().  We do not set reqpage's
1428 			 * valid bits here, it is up to the caller.
1429 			 */
1430 			pmap_clear_modify(m);
1431 			m->valid = VM_PAGE_BITS_ALL;
1432 			vm_page_undirty(m);
1433 
1434 			/*
1435 			 * We have to wake specifically requested pages
1436 			 * up too because we cleared VPO_SWAPINPROG and
1437 			 * could be waiting for it in getpages.  However,
1438 			 * be sure to not unbusy getpages specifically
1439 			 * requested page - getpages expects it to be
1440 			 * left busy.
1441 			 */
1442 			if (i != bp->b_pager.pg_reqpage) {
1443 				vm_page_deactivate(m);
1444 				vm_page_wakeup(m);
1445 			} else {
1446 				vm_page_flash(m);
1447 			}
1448 		} else {
1449 			/*
1450 			 * For write success, clear the modify and dirty
1451 			 * status, then finish the I/O ( which decrements the
1452 			 * busy count and possibly wakes waiter's up ).
1453 			 */
1454 			pmap_clear_modify(m);
1455 			vm_page_undirty(m);
1456 			vm_page_io_finish(m);
1457 			if (vm_page_count_severe())
1458 				vm_page_try_to_cache(m);
1459 		}
1460 	}
1461 	vm_page_unlock_queues();
1462 
1463 	/*
1464 	 * adjust pip.  NOTE: the original parent may still have its own
1465 	 * pip refs on the object.
1466 	 */
1467 	if (object != NULL) {
1468 		vm_object_pip_wakeupn(object, bp->b_npages);
1469 		VM_OBJECT_UNLOCK(object);
1470 	}
1471 
1472 	/*
1473 	 * swapdev_strategy() manually sets b_vp and b_bufobj before calling
1474 	 * bstrategy(). Set them back to NULL now we're done with it, or we'll
1475 	 * trigger a KASSERT in relpbuf().
1476 	 */
1477 	if (bp->b_vp) {
1478 		    bp->b_vp = NULL;
1479 		    bp->b_bufobj = NULL;
1480 	}
1481 	/*
1482 	 * release the physical I/O buffer
1483 	 */
1484 	relpbuf(
1485 	    bp,
1486 	    ((bp->b_iocmd == BIO_READ) ? &nsw_rcount :
1487 		((bp->b_flags & B_ASYNC) ?
1488 		    &nsw_wcount_async :
1489 		    &nsw_wcount_sync
1490 		)
1491 	    )
1492 	);
1493 }
1494 
1495 /*
1496  *	swap_pager_isswapped:
1497  *
1498  *	Return 1 if at least one page in the given object is paged
1499  *	out to the given swap device.
1500  *
1501  *	This routine may not block.
1502  */
1503 int
1504 swap_pager_isswapped(vm_object_t object, struct swdevt *sp)
1505 {
1506 	daddr_t index = 0;
1507 	int bcount;
1508 	int i;
1509 
1510 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1511 	if (object->type != OBJT_SWAP)
1512 		return (0);
1513 
1514 	mtx_lock(&swhash_mtx);
1515 	for (bcount = 0; bcount < object->un_pager.swp.swp_bcount; bcount++) {
1516 		struct swblock *swap;
1517 
1518 		if ((swap = *swp_pager_hash(object, index)) != NULL) {
1519 			for (i = 0; i < SWAP_META_PAGES; ++i) {
1520 				if (swp_pager_isondev(swap->swb_pages[i], sp)) {
1521 					mtx_unlock(&swhash_mtx);
1522 					return (1);
1523 				}
1524 			}
1525 		}
1526 		index += SWAP_META_PAGES;
1527 		if (index > 0x20000000)
1528 			panic("swap_pager_isswapped: failed to locate all swap meta blocks");
1529 	}
1530 	mtx_unlock(&swhash_mtx);
1531 	return (0);
1532 }
1533 
1534 /*
1535  * SWP_PAGER_FORCE_PAGEIN() - force a swap block to be paged in
1536  *
1537  *	This routine dissociates the page at the given index within a
1538  *	swap block from its backing store, paging it in if necessary.
1539  *	If the page is paged in, it is placed in the inactive queue,
1540  *	since it had its backing store ripped out from under it.
1541  *	We also attempt to swap in all other pages in the swap block,
1542  *	we only guarantee that the one at the specified index is
1543  *	paged in.
1544  *
1545  *	XXX - The code to page the whole block in doesn't work, so we
1546  *	      revert to the one-by-one behavior for now.  Sigh.
1547  */
1548 static inline void
1549 swp_pager_force_pagein(vm_object_t object, vm_pindex_t pindex)
1550 {
1551 	vm_page_t m;
1552 
1553 	vm_object_pip_add(object, 1);
1554 	m = vm_page_grab(object, pindex, VM_ALLOC_NORMAL|VM_ALLOC_RETRY);
1555 	if (m->valid == VM_PAGE_BITS_ALL) {
1556 		vm_object_pip_subtract(object, 1);
1557 		vm_page_lock_queues();
1558 		vm_page_activate(m);
1559 		vm_page_dirty(m);
1560 		vm_page_unlock_queues();
1561 		vm_page_wakeup(m);
1562 		vm_pager_page_unswapped(m);
1563 		return;
1564 	}
1565 
1566 	if (swap_pager_getpages(object, &m, 1, 0) != VM_PAGER_OK)
1567 		panic("swap_pager_force_pagein: read from swap failed");/*XXX*/
1568 	vm_object_pip_subtract(object, 1);
1569 	vm_page_lock_queues();
1570 	vm_page_dirty(m);
1571 	vm_page_dontneed(m);
1572 	vm_page_unlock_queues();
1573 	vm_page_wakeup(m);
1574 	vm_pager_page_unswapped(m);
1575 }
1576 
1577 /*
1578  *	swap_pager_swapoff:
1579  *
1580  *	Page in all of the pages that have been paged out to the
1581  *	given device.  The corresponding blocks in the bitmap must be
1582  *	marked as allocated and the device must be flagged SW_CLOSING.
1583  *	There may be no processes swapped out to the device.
1584  *
1585  *	This routine may block.
1586  */
1587 static void
1588 swap_pager_swapoff(struct swdevt *sp)
1589 {
1590 	struct swblock *swap;
1591 	int i, j, retries;
1592 
1593 	GIANT_REQUIRED;
1594 
1595 	retries = 0;
1596 full_rescan:
1597 	mtx_lock(&swhash_mtx);
1598 	for (i = 0; i <= swhash_mask; i++) { /* '<=' is correct here */
1599 restart:
1600 		for (swap = swhash[i]; swap != NULL; swap = swap->swb_hnext) {
1601 			vm_object_t object = swap->swb_object;
1602 			vm_pindex_t pindex = swap->swb_index;
1603                         for (j = 0; j < SWAP_META_PAGES; ++j) {
1604                                 if (swp_pager_isondev(swap->swb_pages[j], sp)) {
1605 					/* avoid deadlock */
1606 					if (!VM_OBJECT_TRYLOCK(object)) {
1607 						break;
1608 					} else {
1609 						mtx_unlock(&swhash_mtx);
1610 						swp_pager_force_pagein(object,
1611 						    pindex + j);
1612 						VM_OBJECT_UNLOCK(object);
1613 						mtx_lock(&swhash_mtx);
1614 						goto restart;
1615 					}
1616 				}
1617                         }
1618 		}
1619 	}
1620 	mtx_unlock(&swhash_mtx);
1621 	if (sp->sw_used) {
1622 		/*
1623 		 * Objects may be locked or paging to the device being
1624 		 * removed, so we will miss their pages and need to
1625 		 * make another pass.  We have marked this device as
1626 		 * SW_CLOSING, so the activity should finish soon.
1627 		 */
1628 		retries++;
1629 		if (retries > 100) {
1630 			panic("swapoff: failed to locate %d swap blocks",
1631 			    sp->sw_used);
1632 		}
1633 		pause("swpoff", hz / 20);
1634 		goto full_rescan;
1635 	}
1636 }
1637 
1638 /************************************************************************
1639  *				SWAP META DATA 				*
1640  ************************************************************************
1641  *
1642  *	These routines manipulate the swap metadata stored in the
1643  *	OBJT_SWAP object.  All swp_*() routines must be called at
1644  *	splvm() because swap can be freed up by the low level vm_page
1645  *	code which might be called from interrupts beyond what splbio() covers.
1646  *
1647  *	Swap metadata is implemented with a global hash and not directly
1648  *	linked into the object.  Instead the object simply contains
1649  *	appropriate tracking counters.
1650  */
1651 
1652 /*
1653  * SWP_PAGER_META_BUILD() -	add swap block to swap meta data for object
1654  *
1655  *	We first convert the object to a swap object if it is a default
1656  *	object.
1657  *
1658  *	The specified swapblk is added to the object's swap metadata.  If
1659  *	the swapblk is not valid, it is freed instead.  Any previously
1660  *	assigned swapblk is freed.
1661  *
1662  *	This routine must be called at splvm(), except when used to convert
1663  *	an OBJT_DEFAULT object into an OBJT_SWAP object.
1664  */
1665 static void
1666 swp_pager_meta_build(vm_object_t object, vm_pindex_t pindex, daddr_t swapblk)
1667 {
1668 	struct swblock *swap;
1669 	struct swblock **pswap;
1670 	int idx;
1671 
1672 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1673 	/*
1674 	 * Convert default object to swap object if necessary
1675 	 */
1676 	if (object->type != OBJT_SWAP) {
1677 		object->type = OBJT_SWAP;
1678 		object->un_pager.swp.swp_bcount = 0;
1679 
1680 		if (object->handle != NULL) {
1681 			mtx_lock(&sw_alloc_mtx);
1682 			TAILQ_INSERT_TAIL(
1683 			    NOBJLIST(object->handle),
1684 			    object,
1685 			    pager_object_list
1686 			);
1687 			mtx_unlock(&sw_alloc_mtx);
1688 		}
1689 	}
1690 
1691 	/*
1692 	 * Locate hash entry.  If not found create, but if we aren't adding
1693 	 * anything just return.  If we run out of space in the map we wait
1694 	 * and, since the hash table may have changed, retry.
1695 	 */
1696 retry:
1697 	mtx_lock(&swhash_mtx);
1698 	pswap = swp_pager_hash(object, pindex);
1699 
1700 	if ((swap = *pswap) == NULL) {
1701 		int i;
1702 
1703 		if (swapblk == SWAPBLK_NONE)
1704 			goto done;
1705 
1706 		swap = *pswap = uma_zalloc(swap_zone, M_NOWAIT);
1707 		if (swap == NULL) {
1708 			mtx_unlock(&swhash_mtx);
1709 			VM_OBJECT_UNLOCK(object);
1710 			if (uma_zone_exhausted(swap_zone)) {
1711 				printf("swap zone exhausted, increase kern.maxswzone\n");
1712 				vm_pageout_oom(VM_OOM_SWAPZ);
1713 				pause("swzonex", 10);
1714 			} else
1715 				VM_WAIT;
1716 			VM_OBJECT_LOCK(object);
1717 			goto retry;
1718 		}
1719 
1720 		swap->swb_hnext = NULL;
1721 		swap->swb_object = object;
1722 		swap->swb_index = pindex & ~(vm_pindex_t)SWAP_META_MASK;
1723 		swap->swb_count = 0;
1724 
1725 		++object->un_pager.swp.swp_bcount;
1726 
1727 		for (i = 0; i < SWAP_META_PAGES; ++i)
1728 			swap->swb_pages[i] = SWAPBLK_NONE;
1729 	}
1730 
1731 	/*
1732 	 * Delete prior contents of metadata
1733 	 */
1734 	idx = pindex & SWAP_META_MASK;
1735 
1736 	if (swap->swb_pages[idx] != SWAPBLK_NONE) {
1737 		swp_pager_freeswapspace(swap->swb_pages[idx], 1);
1738 		--swap->swb_count;
1739 	}
1740 
1741 	/*
1742 	 * Enter block into metadata
1743 	 */
1744 	swap->swb_pages[idx] = swapblk;
1745 	if (swapblk != SWAPBLK_NONE)
1746 		++swap->swb_count;
1747 done:
1748 	mtx_unlock(&swhash_mtx);
1749 }
1750 
1751 /*
1752  * SWP_PAGER_META_FREE() - free a range of blocks in the object's swap metadata
1753  *
1754  *	The requested range of blocks is freed, with any associated swap
1755  *	returned to the swap bitmap.
1756  *
1757  *	This routine will free swap metadata structures as they are cleaned
1758  *	out.  This routine does *NOT* operate on swap metadata associated
1759  *	with resident pages.
1760  *
1761  *	This routine must be called at splvm()
1762  */
1763 static void
1764 swp_pager_meta_free(vm_object_t object, vm_pindex_t index, daddr_t count)
1765 {
1766 
1767 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1768 	if (object->type != OBJT_SWAP)
1769 		return;
1770 
1771 	while (count > 0) {
1772 		struct swblock **pswap;
1773 		struct swblock *swap;
1774 
1775 		mtx_lock(&swhash_mtx);
1776 		pswap = swp_pager_hash(object, index);
1777 
1778 		if ((swap = *pswap) != NULL) {
1779 			daddr_t v = swap->swb_pages[index & SWAP_META_MASK];
1780 
1781 			if (v != SWAPBLK_NONE) {
1782 				swp_pager_freeswapspace(v, 1);
1783 				swap->swb_pages[index & SWAP_META_MASK] =
1784 					SWAPBLK_NONE;
1785 				if (--swap->swb_count == 0) {
1786 					*pswap = swap->swb_hnext;
1787 					uma_zfree(swap_zone, swap);
1788 					--object->un_pager.swp.swp_bcount;
1789 				}
1790 			}
1791 			--count;
1792 			++index;
1793 		} else {
1794 			int n = SWAP_META_PAGES - (index & SWAP_META_MASK);
1795 			count -= n;
1796 			index += n;
1797 		}
1798 		mtx_unlock(&swhash_mtx);
1799 	}
1800 }
1801 
1802 /*
1803  * SWP_PAGER_META_FREE_ALL() - destroy all swap metadata associated with object
1804  *
1805  *	This routine locates and destroys all swap metadata associated with
1806  *	an object.
1807  *
1808  *	This routine must be called at splvm()
1809  */
1810 static void
1811 swp_pager_meta_free_all(vm_object_t object)
1812 {
1813 	daddr_t index = 0;
1814 
1815 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1816 	if (object->type != OBJT_SWAP)
1817 		return;
1818 
1819 	while (object->un_pager.swp.swp_bcount) {
1820 		struct swblock **pswap;
1821 		struct swblock *swap;
1822 
1823 		mtx_lock(&swhash_mtx);
1824 		pswap = swp_pager_hash(object, index);
1825 		if ((swap = *pswap) != NULL) {
1826 			int i;
1827 
1828 			for (i = 0; i < SWAP_META_PAGES; ++i) {
1829 				daddr_t v = swap->swb_pages[i];
1830 				if (v != SWAPBLK_NONE) {
1831 					--swap->swb_count;
1832 					swp_pager_freeswapspace(v, 1);
1833 				}
1834 			}
1835 			if (swap->swb_count != 0)
1836 				panic("swap_pager_meta_free_all: swb_count != 0");
1837 			*pswap = swap->swb_hnext;
1838 			uma_zfree(swap_zone, swap);
1839 			--object->un_pager.swp.swp_bcount;
1840 		}
1841 		mtx_unlock(&swhash_mtx);
1842 		index += SWAP_META_PAGES;
1843 		if (index > 0x20000000)
1844 			panic("swp_pager_meta_free_all: failed to locate all swap meta blocks");
1845 	}
1846 }
1847 
1848 /*
1849  * SWP_PAGER_METACTL() -  misc control of swap and vm_page_t meta data.
1850  *
1851  *	This routine is capable of looking up, popping, or freeing
1852  *	swapblk assignments in the swap meta data or in the vm_page_t.
1853  *	The routine typically returns the swapblk being looked-up, or popped,
1854  *	or SWAPBLK_NONE if the block was freed, or SWAPBLK_NONE if the block
1855  *	was invalid.  This routine will automatically free any invalid
1856  *	meta-data swapblks.
1857  *
1858  *	It is not possible to store invalid swapblks in the swap meta data
1859  *	(other then a literal 'SWAPBLK_NONE'), so we don't bother checking.
1860  *
1861  *	When acting on a busy resident page and paging is in progress, we
1862  *	have to wait until paging is complete but otherwise can act on the
1863  *	busy page.
1864  *
1865  *	This routine must be called at splvm().
1866  *
1867  *	SWM_FREE	remove and free swap block from metadata
1868  *	SWM_POP		remove from meta data but do not free.. pop it out
1869  */
1870 static daddr_t
1871 swp_pager_meta_ctl(vm_object_t object, vm_pindex_t pindex, int flags)
1872 {
1873 	struct swblock **pswap;
1874 	struct swblock *swap;
1875 	daddr_t r1;
1876 	int idx;
1877 
1878 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
1879 	/*
1880 	 * The meta data only exists of the object is OBJT_SWAP
1881 	 * and even then might not be allocated yet.
1882 	 */
1883 	if (object->type != OBJT_SWAP)
1884 		return (SWAPBLK_NONE);
1885 
1886 	r1 = SWAPBLK_NONE;
1887 	mtx_lock(&swhash_mtx);
1888 	pswap = swp_pager_hash(object, pindex);
1889 
1890 	if ((swap = *pswap) != NULL) {
1891 		idx = pindex & SWAP_META_MASK;
1892 		r1 = swap->swb_pages[idx];
1893 
1894 		if (r1 != SWAPBLK_NONE) {
1895 			if (flags & SWM_FREE) {
1896 				swp_pager_freeswapspace(r1, 1);
1897 				r1 = SWAPBLK_NONE;
1898 			}
1899 			if (flags & (SWM_FREE|SWM_POP)) {
1900 				swap->swb_pages[idx] = SWAPBLK_NONE;
1901 				if (--swap->swb_count == 0) {
1902 					*pswap = swap->swb_hnext;
1903 					uma_zfree(swap_zone, swap);
1904 					--object->un_pager.swp.swp_bcount;
1905 				}
1906 			}
1907 		}
1908 	}
1909 	mtx_unlock(&swhash_mtx);
1910 	return (r1);
1911 }
1912 
1913 /*
1914  * System call swapon(name) enables swapping on device name,
1915  * which must be in the swdevsw.  Return EBUSY
1916  * if already swapping on this device.
1917  */
1918 #ifndef _SYS_SYSPROTO_H_
1919 struct swapon_args {
1920 	char *name;
1921 };
1922 #endif
1923 
1924 /*
1925  * MPSAFE
1926  */
1927 /* ARGSUSED */
1928 int
1929 swapon(struct thread *td, struct swapon_args *uap)
1930 {
1931 	struct vattr attr;
1932 	struct vnode *vp;
1933 	struct nameidata nd;
1934 	int error;
1935 
1936 	error = priv_check(td, PRIV_SWAPON);
1937 	if (error)
1938 		return (error);
1939 
1940 	mtx_lock(&Giant);
1941 	while (swdev_syscall_active)
1942 	    tsleep(&swdev_syscall_active, PUSER - 1, "swpon", 0);
1943 	swdev_syscall_active = 1;
1944 
1945 	/*
1946 	 * Swap metadata may not fit in the KVM if we have physical
1947 	 * memory of >1GB.
1948 	 */
1949 	if (swap_zone == NULL) {
1950 		error = ENOMEM;
1951 		goto done;
1952 	}
1953 
1954 	NDINIT(&nd, LOOKUP, ISOPEN | FOLLOW | AUDITVNODE1, UIO_USERSPACE,
1955 	    uap->name, td);
1956 	error = namei(&nd);
1957 	if (error)
1958 		goto done;
1959 
1960 	NDFREE(&nd, NDF_ONLY_PNBUF);
1961 	vp = nd.ni_vp;
1962 
1963 	if (vn_isdisk(vp, &error)) {
1964 		error = swapongeom(td, vp);
1965 	} else if (vp->v_type == VREG &&
1966 	    (vp->v_mount->mnt_vfc->vfc_flags & VFCF_NETWORK) != 0 &&
1967 	    (error = VOP_GETATTR(vp, &attr, td->td_ucred)) == 0) {
1968 		/*
1969 		 * Allow direct swapping to NFS regular files in the same
1970 		 * way that nfs_mountroot() sets up diskless swapping.
1971 		 */
1972 		error = swaponvp(td, vp, attr.va_size / DEV_BSIZE);
1973 	}
1974 
1975 	if (error)
1976 		vrele(vp);
1977 done:
1978 	swdev_syscall_active = 0;
1979 	wakeup_one(&swdev_syscall_active);
1980 	mtx_unlock(&Giant);
1981 	return (error);
1982 }
1983 
1984 static void
1985 swaponsomething(struct vnode *vp, void *id, u_long nblks, sw_strategy_t *strategy, sw_close_t *close, dev_t dev)
1986 {
1987 	struct swdevt *sp, *tsp;
1988 	swblk_t dvbase;
1989 	u_long mblocks;
1990 
1991 	/*
1992 	 * If we go beyond this, we get overflows in the radix
1993 	 * tree bitmap code.
1994 	 */
1995 	mblocks = 0x40000000 / BLIST_META_RADIX;
1996 	if (nblks > mblocks) {
1997 		printf("WARNING: reducing size to maximum of %lu blocks per swap unit\n",
1998 			mblocks);
1999 		nblks = mblocks;
2000 	}
2001 	/*
2002 	 * nblks is in DEV_BSIZE'd chunks, convert to PAGE_SIZE'd chunks.
2003 	 * First chop nblks off to page-align it, then convert.
2004 	 *
2005 	 * sw->sw_nblks is in page-sized chunks now too.
2006 	 */
2007 	nblks &= ~(ctodb(1) - 1);
2008 	nblks = dbtoc(nblks);
2009 
2010 	sp = malloc(sizeof *sp, M_VMPGDATA, M_WAITOK | M_ZERO);
2011 	sp->sw_vp = vp;
2012 	sp->sw_id = id;
2013 	sp->sw_dev = dev;
2014 	sp->sw_flags = 0;
2015 	sp->sw_nblks = nblks;
2016 	sp->sw_used = 0;
2017 	sp->sw_strategy = strategy;
2018 	sp->sw_close = close;
2019 
2020 	sp->sw_blist = blist_create(nblks, M_WAITOK);
2021 	/*
2022 	 * Do not free the first two block in order to avoid overwriting
2023 	 * any bsd label at the front of the partition
2024 	 */
2025 	blist_free(sp->sw_blist, 2, nblks - 2);
2026 
2027 	dvbase = 0;
2028 	mtx_lock(&sw_dev_mtx);
2029 	TAILQ_FOREACH(tsp, &swtailq, sw_list) {
2030 		if (tsp->sw_end >= dvbase) {
2031 			/*
2032 			 * We put one uncovered page between the devices
2033 			 * in order to definitively prevent any cross-device
2034 			 * I/O requests
2035 			 */
2036 			dvbase = tsp->sw_end + 1;
2037 		}
2038 	}
2039 	sp->sw_first = dvbase;
2040 	sp->sw_end = dvbase + nblks;
2041 	TAILQ_INSERT_TAIL(&swtailq, sp, sw_list);
2042 	nswapdev++;
2043 	swap_pager_avail += nblks;
2044 	swp_sizecheck();
2045 	mtx_unlock(&sw_dev_mtx);
2046 }
2047 
2048 /*
2049  * SYSCALL: swapoff(devname)
2050  *
2051  * Disable swapping on the given device.
2052  *
2053  * XXX: Badly designed system call: it should use a device index
2054  * rather than filename as specification.  We keep sw_vp around
2055  * only to make this work.
2056  */
2057 #ifndef _SYS_SYSPROTO_H_
2058 struct swapoff_args {
2059 	char *name;
2060 };
2061 #endif
2062 
2063 /*
2064  * MPSAFE
2065  */
2066 /* ARGSUSED */
2067 int
2068 swapoff(struct thread *td, struct swapoff_args *uap)
2069 {
2070 	struct vnode *vp;
2071 	struct nameidata nd;
2072 	struct swdevt *sp;
2073 	int error;
2074 
2075 	error = priv_check(td, PRIV_SWAPOFF);
2076 	if (error)
2077 		return (error);
2078 
2079 	mtx_lock(&Giant);
2080 	while (swdev_syscall_active)
2081 	    tsleep(&swdev_syscall_active, PUSER - 1, "swpoff", 0);
2082 	swdev_syscall_active = 1;
2083 
2084 	NDINIT(&nd, LOOKUP, FOLLOW | AUDITVNODE1, UIO_USERSPACE, uap->name,
2085 	    td);
2086 	error = namei(&nd);
2087 	if (error)
2088 		goto done;
2089 	NDFREE(&nd, NDF_ONLY_PNBUF);
2090 	vp = nd.ni_vp;
2091 
2092 	mtx_lock(&sw_dev_mtx);
2093 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
2094 		if (sp->sw_vp == vp)
2095 			break;
2096 	}
2097 	mtx_unlock(&sw_dev_mtx);
2098 	if (sp == NULL) {
2099 		error = EINVAL;
2100 		goto done;
2101 	}
2102 	error = swapoff_one(sp, td->td_ucred);
2103 done:
2104 	swdev_syscall_active = 0;
2105 	wakeup_one(&swdev_syscall_active);
2106 	mtx_unlock(&Giant);
2107 	return (error);
2108 }
2109 
2110 static int
2111 swapoff_one(struct swdevt *sp, struct ucred *cred)
2112 {
2113 	u_long nblks, dvbase;
2114 #ifdef MAC
2115 	int error;
2116 #endif
2117 
2118 	mtx_assert(&Giant, MA_OWNED);
2119 #ifdef MAC
2120 	(void) vn_lock(sp->sw_vp, LK_EXCLUSIVE | LK_RETRY);
2121 	error = mac_system_check_swapoff(cred, sp->sw_vp);
2122 	(void) VOP_UNLOCK(sp->sw_vp, 0);
2123 	if (error != 0)
2124 		return (error);
2125 #endif
2126 	nblks = sp->sw_nblks;
2127 
2128 	/*
2129 	 * We can turn off this swap device safely only if the
2130 	 * available virtual memory in the system will fit the amount
2131 	 * of data we will have to page back in, plus an epsilon so
2132 	 * the system doesn't become critically low on swap space.
2133 	 */
2134 	if (cnt.v_free_count + cnt.v_cache_count + swap_pager_avail <
2135 	    nblks + nswap_lowat) {
2136 		return (ENOMEM);
2137 	}
2138 
2139 	/*
2140 	 * Prevent further allocations on this device.
2141 	 */
2142 	mtx_lock(&sw_dev_mtx);
2143 	sp->sw_flags |= SW_CLOSING;
2144 	for (dvbase = 0; dvbase < sp->sw_end; dvbase += dmmax) {
2145 		swap_pager_avail -= blist_fill(sp->sw_blist,
2146 		     dvbase, dmmax);
2147 	}
2148 	mtx_unlock(&sw_dev_mtx);
2149 
2150 	/*
2151 	 * Page in the contents of the device and close it.
2152 	 */
2153 	swap_pager_swapoff(sp);
2154 
2155 	sp->sw_close(curthread, sp);
2156 	sp->sw_id = NULL;
2157 	mtx_lock(&sw_dev_mtx);
2158 	TAILQ_REMOVE(&swtailq, sp, sw_list);
2159 	nswapdev--;
2160 	if (nswapdev == 0) {
2161 		swap_pager_full = 2;
2162 		swap_pager_almost_full = 1;
2163 	}
2164 	if (swdevhd == sp)
2165 		swdevhd = NULL;
2166 	mtx_unlock(&sw_dev_mtx);
2167 	blist_destroy(sp->sw_blist);
2168 	free(sp, M_VMPGDATA);
2169 	return (0);
2170 }
2171 
2172 void
2173 swapoff_all(void)
2174 {
2175 	struct swdevt *sp, *spt;
2176 	const char *devname;
2177 	int error;
2178 
2179 	mtx_lock(&Giant);
2180 	while (swdev_syscall_active)
2181 		tsleep(&swdev_syscall_active, PUSER - 1, "swpoff", 0);
2182 	swdev_syscall_active = 1;
2183 
2184 	mtx_lock(&sw_dev_mtx);
2185 	TAILQ_FOREACH_SAFE(sp, &swtailq, sw_list, spt) {
2186 		mtx_unlock(&sw_dev_mtx);
2187 		if (vn_isdisk(sp->sw_vp, NULL))
2188 			devname = sp->sw_vp->v_rdev->si_name;
2189 		else
2190 			devname = "[file]";
2191 		error = swapoff_one(sp, thread0.td_ucred);
2192 		if (error != 0) {
2193 			printf("Cannot remove swap device %s (error=%d), "
2194 			    "skipping.\n", devname, error);
2195 		} else if (bootverbose) {
2196 			printf("Swap device %s removed.\n", devname);
2197 		}
2198 		mtx_lock(&sw_dev_mtx);
2199 	}
2200 	mtx_unlock(&sw_dev_mtx);
2201 
2202 	swdev_syscall_active = 0;
2203 	wakeup_one(&swdev_syscall_active);
2204 	mtx_unlock(&Giant);
2205 }
2206 
2207 void
2208 swap_pager_status(int *total, int *used)
2209 {
2210 	struct swdevt *sp;
2211 
2212 	*total = 0;
2213 	*used = 0;
2214 	mtx_lock(&sw_dev_mtx);
2215 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
2216 		*total += sp->sw_nblks;
2217 		*used += sp->sw_used;
2218 	}
2219 	mtx_unlock(&sw_dev_mtx);
2220 }
2221 
2222 static int
2223 sysctl_vm_swap_info(SYSCTL_HANDLER_ARGS)
2224 {
2225 	int	*name = (int *)arg1;
2226 	int	error, n;
2227 	struct xswdev xs;
2228 	struct swdevt *sp;
2229 
2230 	if (arg2 != 1) /* name length */
2231 		return (EINVAL);
2232 
2233 	n = 0;
2234 	mtx_lock(&sw_dev_mtx);
2235 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
2236 		if (n == *name) {
2237 			mtx_unlock(&sw_dev_mtx);
2238 			xs.xsw_version = XSWDEV_VERSION;
2239 			xs.xsw_dev = sp->sw_dev;
2240 			xs.xsw_flags = sp->sw_flags;
2241 			xs.xsw_nblks = sp->sw_nblks;
2242 			xs.xsw_used = sp->sw_used;
2243 
2244 			error = SYSCTL_OUT(req, &xs, sizeof(xs));
2245 			return (error);
2246 		}
2247 		n++;
2248 	}
2249 	mtx_unlock(&sw_dev_mtx);
2250 	return (ENOENT);
2251 }
2252 
2253 SYSCTL_INT(_vm, OID_AUTO, nswapdev, CTLFLAG_RD, &nswapdev, 0,
2254     "Number of swap devices");
2255 SYSCTL_NODE(_vm, OID_AUTO, swap_info, CTLFLAG_RD, sysctl_vm_swap_info,
2256     "Swap statistics by device");
2257 
2258 /*
2259  * vmspace_swap_count() - count the approximate swap useage in pages for a
2260  *			  vmspace.
2261  *
2262  *	The map must be locked.
2263  *
2264  *	Swap useage is determined by taking the proportional swap used by
2265  *	VM objects backing the VM map.  To make up for fractional losses,
2266  *	if the VM object has any swap use at all the associated map entries
2267  *	count for at least 1 swap page.
2268  */
2269 int
2270 vmspace_swap_count(struct vmspace *vmspace)
2271 {
2272 	vm_map_t map = &vmspace->vm_map;
2273 	vm_map_entry_t cur;
2274 	int count = 0;
2275 
2276 	for (cur = map->header.next; cur != &map->header; cur = cur->next) {
2277 		vm_object_t object;
2278 
2279 		if ((cur->eflags & MAP_ENTRY_IS_SUB_MAP) == 0 &&
2280 		    (object = cur->object.vm_object) != NULL) {
2281 			VM_OBJECT_LOCK(object);
2282 			if (object->type == OBJT_SWAP &&
2283 			    object->un_pager.swp.swp_bcount != 0) {
2284 				int n = (cur->end - cur->start) / PAGE_SIZE;
2285 
2286 				count += object->un_pager.swp.swp_bcount *
2287 				    SWAP_META_PAGES * n / object->size + 1;
2288 			}
2289 			VM_OBJECT_UNLOCK(object);
2290 		}
2291 	}
2292 	return (count);
2293 }
2294 
2295 /*
2296  * GEOM backend
2297  *
2298  * Swapping onto disk devices.
2299  *
2300  */
2301 
2302 static g_orphan_t swapgeom_orphan;
2303 
2304 static struct g_class g_swap_class = {
2305 	.name = "SWAP",
2306 	.version = G_VERSION,
2307 	.orphan = swapgeom_orphan,
2308 };
2309 
2310 DECLARE_GEOM_CLASS(g_swap_class, g_class);
2311 
2312 
2313 static void
2314 swapgeom_done(struct bio *bp2)
2315 {
2316 	struct buf *bp;
2317 
2318 	bp = bp2->bio_caller2;
2319 	bp->b_ioflags = bp2->bio_flags;
2320 	if (bp2->bio_error)
2321 		bp->b_ioflags |= BIO_ERROR;
2322 	bp->b_resid = bp->b_bcount - bp2->bio_completed;
2323 	bp->b_error = bp2->bio_error;
2324 	bufdone(bp);
2325 	g_destroy_bio(bp2);
2326 }
2327 
2328 static void
2329 swapgeom_strategy(struct buf *bp, struct swdevt *sp)
2330 {
2331 	struct bio *bio;
2332 	struct g_consumer *cp;
2333 
2334 	cp = sp->sw_id;
2335 	if (cp == NULL) {
2336 		bp->b_error = ENXIO;
2337 		bp->b_ioflags |= BIO_ERROR;
2338 		bufdone(bp);
2339 		return;
2340 	}
2341 	if (bp->b_iocmd == BIO_WRITE)
2342 		bio = g_new_bio();
2343 	else
2344 		bio = g_alloc_bio();
2345 	if (bio == NULL) {
2346 		bp->b_error = ENOMEM;
2347 		bp->b_ioflags |= BIO_ERROR;
2348 		bufdone(bp);
2349 		return;
2350 	}
2351 
2352 	bio->bio_caller2 = bp;
2353 	bio->bio_cmd = bp->b_iocmd;
2354 	bio->bio_data = bp->b_data;
2355 	bio->bio_offset = (bp->b_blkno - sp->sw_first) * PAGE_SIZE;
2356 	bio->bio_length = bp->b_bcount;
2357 	bio->bio_done = swapgeom_done;
2358 	g_io_request(bio, cp);
2359 	return;
2360 }
2361 
2362 static void
2363 swapgeom_orphan(struct g_consumer *cp)
2364 {
2365 	struct swdevt *sp;
2366 
2367 	mtx_lock(&sw_dev_mtx);
2368 	TAILQ_FOREACH(sp, &swtailq, sw_list)
2369 		if (sp->sw_id == cp)
2370 			sp->sw_id = NULL;
2371 	mtx_unlock(&sw_dev_mtx);
2372 }
2373 
2374 static void
2375 swapgeom_close_ev(void *arg, int flags)
2376 {
2377 	struct g_consumer *cp;
2378 
2379 	cp = arg;
2380 	g_access(cp, -1, -1, 0);
2381 	g_detach(cp);
2382 	g_destroy_consumer(cp);
2383 }
2384 
2385 static void
2386 swapgeom_close(struct thread *td, struct swdevt *sw)
2387 {
2388 
2389 	/* XXX: direct call when Giant untangled */
2390 	g_waitfor_event(swapgeom_close_ev, sw->sw_id, M_WAITOK, NULL);
2391 }
2392 
2393 
2394 struct swh0h0 {
2395 	struct cdev *dev;
2396 	struct vnode *vp;
2397 	int	error;
2398 };
2399 
2400 static void
2401 swapongeom_ev(void *arg, int flags)
2402 {
2403 	struct swh0h0 *swh;
2404 	struct g_provider *pp;
2405 	struct g_consumer *cp;
2406 	static struct g_geom *gp;
2407 	struct swdevt *sp;
2408 	u_long nblks;
2409 	int error;
2410 
2411 	swh = arg;
2412 	swh->error = 0;
2413 	pp = g_dev_getprovider(swh->dev);
2414 	if (pp == NULL) {
2415 		swh->error = ENODEV;
2416 		return;
2417 	}
2418 	mtx_lock(&sw_dev_mtx);
2419 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
2420 		cp = sp->sw_id;
2421 		if (cp != NULL && cp->provider == pp) {
2422 			mtx_unlock(&sw_dev_mtx);
2423 			swh->error = EBUSY;
2424 			return;
2425 		}
2426 	}
2427 	mtx_unlock(&sw_dev_mtx);
2428 	if (gp == NULL)
2429 		gp = g_new_geomf(&g_swap_class, "swap", NULL);
2430 	cp = g_new_consumer(gp);
2431 	g_attach(cp, pp);
2432 	/*
2433 	 * XXX: Everytime you think you can improve the margin for
2434 	 * footshooting, somebody depends on the ability to do so:
2435 	 * savecore(8) wants to write to our swapdev so we cannot
2436 	 * set an exclusive count :-(
2437 	 */
2438 	error = g_access(cp, 1, 1, 0);
2439 	if (error) {
2440 		g_detach(cp);
2441 		g_destroy_consumer(cp);
2442 		swh->error = error;
2443 		return;
2444 	}
2445 	nblks = pp->mediasize / DEV_BSIZE;
2446 	swaponsomething(swh->vp, cp, nblks, swapgeom_strategy,
2447 	    swapgeom_close, dev2udev(swh->dev));
2448 	swh->error = 0;
2449 	return;
2450 }
2451 
2452 static int
2453 swapongeom(struct thread *td, struct vnode *vp)
2454 {
2455 	int error;
2456 	struct swh0h0 swh;
2457 
2458 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2459 
2460 	swh.dev = vp->v_rdev;
2461 	swh.vp = vp;
2462 	swh.error = 0;
2463 	/* XXX: direct call when Giant untangled */
2464 	error = g_waitfor_event(swapongeom_ev, &swh, M_WAITOK, NULL);
2465 	if (!error)
2466 		error = swh.error;
2467 	VOP_UNLOCK(vp, 0);
2468 	return (error);
2469 }
2470 
2471 /*
2472  * VNODE backend
2473  *
2474  * This is used mainly for network filesystem (read: probably only tested
2475  * with NFS) swapfiles.
2476  *
2477  */
2478 
2479 static void
2480 swapdev_strategy(struct buf *bp, struct swdevt *sp)
2481 {
2482 	struct vnode *vp2;
2483 
2484 	bp->b_blkno = ctodb(bp->b_blkno - sp->sw_first);
2485 
2486 	vp2 = sp->sw_id;
2487 	vhold(vp2);
2488 	if (bp->b_iocmd == BIO_WRITE) {
2489 		if (bp->b_bufobj)
2490 			bufobj_wdrop(bp->b_bufobj);
2491 		bufobj_wref(&vp2->v_bufobj);
2492 	}
2493 	if (bp->b_bufobj != &vp2->v_bufobj)
2494 		bp->b_bufobj = &vp2->v_bufobj;
2495 	bp->b_vp = vp2;
2496 	bp->b_iooffset = dbtob(bp->b_blkno);
2497 	bstrategy(bp);
2498 	return;
2499 }
2500 
2501 static void
2502 swapdev_close(struct thread *td, struct swdevt *sp)
2503 {
2504 
2505 	VOP_CLOSE(sp->sw_vp, FREAD | FWRITE, td->td_ucred, td);
2506 	vrele(sp->sw_vp);
2507 }
2508 
2509 
2510 static int
2511 swaponvp(struct thread *td, struct vnode *vp, u_long nblks)
2512 {
2513 	struct swdevt *sp;
2514 	int error;
2515 
2516 	if (nblks == 0)
2517 		return (ENXIO);
2518 	mtx_lock(&sw_dev_mtx);
2519 	TAILQ_FOREACH(sp, &swtailq, sw_list) {
2520 		if (sp->sw_id == vp) {
2521 			mtx_unlock(&sw_dev_mtx);
2522 			return (EBUSY);
2523 		}
2524 	}
2525 	mtx_unlock(&sw_dev_mtx);
2526 
2527 	(void) vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
2528 #ifdef MAC
2529 	error = mac_system_check_swapon(td->td_ucred, vp);
2530 	if (error == 0)
2531 #endif
2532 		error = VOP_OPEN(vp, FREAD | FWRITE, td->td_ucred, td, NULL);
2533 	(void) VOP_UNLOCK(vp, 0);
2534 	if (error)
2535 		return (error);
2536 
2537 	swaponsomething(vp, vp, nblks, swapdev_strategy, swapdev_close,
2538 	    NODEV);
2539 	return (0);
2540 }
2541