xref: /dragonfly/sys/vm/vm_pager.c (revision 926deccb)
1 /*
2  * (MPSAFE)
3  *
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * The Mach Operating System project at Carnegie-Mellon University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	from: @(#)vm_pager.c	8.6 (Berkeley) 1/12/94
35  *
36  *
37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
38  * All rights reserved.
39  *
40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
41  *
42  * Permission to use, copy, modify and distribute this software and
43  * its documentation is hereby granted, provided that both the copyright
44  * notice and this permission notice appear in all copies of the
45  * software, derivative works or modified versions, and any portions
46  * thereof, and that both notices appear in supporting documentation.
47  *
48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
51  *
52  * Carnegie Mellon requests users of this software to return to
53  *
54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
55  *  School of Computer Science
56  *  Carnegie Mellon University
57  *  Pittsburgh PA 15213-3890
58  *
59  * any improvements or extensions that they make and grant Carnegie the
60  * rights to redistribute these changes.
61  *
62  * $FreeBSD: src/sys/vm/vm_pager.c,v 1.54.2.2 2001/11/18 07:11:00 dillon Exp $
63  */
64 
65 /*
66  *	Paging space routine stubs.  Emulates a matchmaker-like interface
67  *	for builtin pagers.
68  */
69 
70 #include <sys/param.h>
71 #include <sys/systm.h>
72 #include <sys/kernel.h>
73 #include <sys/vnode.h>
74 #include <sys/buf.h>
75 #include <sys/ucred.h>
76 #include <sys/dsched.h>
77 #include <sys/proc.h>
78 #include <sys/sysctl.h>
79 #include <sys/thread2.h>
80 
81 #include <vm/vm.h>
82 #include <vm/vm_param.h>
83 #include <vm/vm_kern.h>
84 #include <vm/vm_object.h>
85 #include <vm/vm_page.h>
86 #include <vm/vm_pager.h>
87 #include <vm/vm_extern.h>
88 
89 #include <sys/buf2.h>
90 
91 extern struct pagerops defaultpagerops;
92 extern struct pagerops swappagerops;
93 extern struct pagerops vnodepagerops;
94 extern struct pagerops devicepagerops;
95 extern struct pagerops physpagerops;
96 
97 int cluster_pbuf_freecnt = -1;	/* unlimited to begin with */
98 
99 static int dead_pager_getpage (vm_object_t, vm_page_t *, int);
100 static void dead_pager_putpages (vm_object_t, vm_page_t *, int, int, int *);
101 static boolean_t dead_pager_haspage (vm_object_t, vm_pindex_t);
102 static void dead_pager_dealloc (vm_object_t);
103 
104 /*
105  * No requirements.
106  */
107 static int
108 dead_pager_getpage(vm_object_t obj, vm_page_t *mpp, int seqaccess)
109 {
110 	return VM_PAGER_FAIL;
111 }
112 
113 /*
114  * No requirements.
115  */
116 static void
117 dead_pager_putpages(vm_object_t object, vm_page_t *m, int count, int flags,
118 		    int *rtvals)
119 {
120 	int i;
121 
122 	for (i = 0; i < count; i++) {
123 		rtvals[i] = VM_PAGER_AGAIN;
124 	}
125 }
126 
127 /*
128  * No requirements.
129  */
130 static int
131 dead_pager_haspage(vm_object_t object, vm_pindex_t pindex)
132 {
133 	return FALSE;
134 }
135 
136 /*
137  * No requirements.
138  */
139 static void
140 dead_pager_dealloc(vm_object_t object)
141 {
142 	KKASSERT(object->swblock_count == 0);
143 	return;
144 }
145 
146 static struct pagerops deadpagerops = {
147 	dead_pager_dealloc,
148 	dead_pager_getpage,
149 	dead_pager_putpages,
150 	dead_pager_haspage
151 };
152 
153 struct pagerops *pagertab[] = {
154 	&defaultpagerops,	/* OBJT_DEFAULT */
155 	&swappagerops,		/* OBJT_SWAP */
156 	&vnodepagerops,		/* OBJT_VNODE */
157 	&devicepagerops,	/* OBJT_DEVICE */
158 	&devicepagerops,	/* OBJT_MGTDEVICE */
159 	&physpagerops,		/* OBJT_PHYS */
160 	&deadpagerops		/* OBJT_DEAD */
161 };
162 
163 int npagers = NELEM(pagertab);
164 
165 /*
166  * Kernel address space for mapping pages.
167  * Used by pagers where KVAs are needed for IO.
168  *
169  * XXX needs to be large enough to support the number of pending async
170  * cleaning requests (NPENDINGIO == 64) * the maximum swap cluster size
171  * (MAXPHYS == 64k) if you want to get the most efficiency.
172  */
173 #define PAGER_MAP_SIZE	(8 * 1024 * 1024)
174 
175 TAILQ_HEAD(swqueue, buf);
176 
177 int pager_map_size = PAGER_MAP_SIZE;
178 struct vm_map pager_map;
179 
180 static int bswneeded_raw;
181 static int bswneeded_kva;
182 static long nswbuf_raw;
183 static struct buf *swbuf_raw;
184 static vm_offset_t swapbkva;		/* swap buffers kva */
185 static struct swqueue bswlist_raw;	/* without kva */
186 static struct swqueue bswlist_kva;	/* with kva */
187 static struct spinlock bswspin = SPINLOCK_INITIALIZER(&bswspin);
188 static int pbuf_raw_count;
189 static int pbuf_kva_count;
190 
191 SYSCTL_INT(_vfs, OID_AUTO, pbuf_raw_count, CTLFLAG_RD, &pbuf_raw_count, 0,
192     "Kernel virtual address space reservations");
193 SYSCTL_INT(_vfs, OID_AUTO, pbuf_kva_count, CTLFLAG_RD, &pbuf_kva_count, 0,
194     "Kernel raw address space reservations");
195 
196 /*
197  * Initialize the swap buffer list.
198  *
199  * Called from the low level boot code only.
200  */
201 static void
202 vm_pager_init(void *arg __unused)
203 {
204 	TAILQ_INIT(&bswlist_raw);
205 	TAILQ_INIT(&bswlist_kva);
206 }
207 SYSINIT(vm_mem, SI_BOOT1_VM, SI_ORDER_SECOND, vm_pager_init, NULL)
208 
209 /*
210  * Called from the low level boot code only.
211  */
212 void
213 vm_pager_bufferinit(void)
214 {
215 	struct buf *bp;
216 	long i;
217 
218 	/*
219 	 * Reserve KVM space for pbuf data.
220 	 */
221 	swapbkva = kmem_alloc_pageable(&pager_map, nswbuf * MAXPHYS);
222 	if (!swapbkva)
223 		panic("Not enough pager_map VM space for physical buffers");
224 
225 	/*
226 	 * Initial pbuf setup.  These pbufs have KVA reservations.
227 	 */
228 	bp = swbuf;
229 	for (i = 0; i < nswbuf; ++i, ++bp) {
230 		bp->b_kvabase = (caddr_t)((intptr_t)i * MAXPHYS) + swapbkva;
231 		bp->b_kvasize = MAXPHYS;
232 		BUF_LOCKINIT(bp);
233 		buf_dep_init(bp);
234 		TAILQ_INSERT_HEAD(&bswlist_kva, bp, b_freelist);
235 		++pbuf_kva_count;
236 	}
237 
238 	/*
239 	 * Initial pbuf setup.  These pbufs do not have KVA reservations,
240 	 * so we can have a lot more of them.  These are typically used
241 	 * to massage low level buf/bio requests.
242 	 */
243 	nswbuf_raw = nbuf * 2;
244 	swbuf_raw = (void *)kmem_alloc(&kernel_map,
245 				round_page(nswbuf_raw * sizeof(struct buf)));
246 	bp = swbuf_raw;
247 	for (i = 0; i < nswbuf_raw; ++i, ++bp) {
248 		BUF_LOCKINIT(bp);
249 		buf_dep_init(bp);
250 		TAILQ_INSERT_HEAD(&bswlist_raw, bp, b_freelist);
251 		++pbuf_raw_count;
252 	}
253 
254 	/*
255 	 * Allow the clustering code to use half of our pbufs.
256 	 */
257 	cluster_pbuf_freecnt = nswbuf / 2;
258 }
259 
260 /*
261  * No requirements.
262  */
263 void
264 vm_pager_deallocate(vm_object_t object)
265 {
266 	(*pagertab[object->type]->pgo_dealloc) (object);
267 }
268 
269 /*
270  * vm_pager_get_pages() - inline, see vm/vm_pager.h
271  * vm_pager_put_pages() - inline, see vm/vm_pager.h
272  * vm_pager_has_page() - inline, see vm/vm_pager.h
273  * vm_pager_page_inserted() - inline, see vm/vm_pager.h
274  * vm_pager_page_removed() - inline, see vm/vm_pager.h
275  */
276 
277 /*
278  * Search the specified pager object list for an object with the
279  * specified handle.  If an object with the specified handle is found,
280  * increase its reference count and return it.  Otherwise, return NULL.
281  *
282  * The pager object list must be locked.
283  */
284 vm_object_t
285 vm_pager_object_lookup(struct pagerlst *pg_list, void *handle)
286 {
287 	vm_object_t object;
288 
289 	TAILQ_FOREACH(object, pg_list, pager_object_list) {
290 		if (object->handle == handle) {
291 			VM_OBJECT_LOCK(object);
292 			if ((object->flags & OBJ_DEAD) == 0) {
293 				vm_object_reference_locked(object);
294 				VM_OBJECT_UNLOCK(object);
295 				break;
296 			}
297 			VM_OBJECT_UNLOCK(object);
298 		}
299 	}
300 	return (object);
301 }
302 
303 /*
304  * Initialize a physical buffer.
305  *
306  * No requirements.
307  */
308 static void
309 initpbuf(struct buf *bp)
310 {
311 	bp->b_qindex = 0;		/* BQUEUE_NONE */
312 	bp->b_data = bp->b_kvabase;	/* NULL if pbuf sans kva */
313 	bp->b_flags = B_PAGING;
314 	bp->b_cmd = BUF_CMD_DONE;
315 	bp->b_error = 0;
316 	bp->b_bcount = 0;
317 	bp->b_bufsize = MAXPHYS;
318 	initbufbio(bp);
319 	xio_init(&bp->b_xio);
320 	BUF_LOCK(bp, LK_EXCLUSIVE);
321 }
322 
323 /*
324  * Allocate a physical buffer
325  *
326  *	There are a limited number (nswbuf) of physical buffers.  We need
327  *	to make sure that no single subsystem is able to hog all of them,
328  *	so each subsystem implements a counter which is typically initialized
329  *	to 1/2 nswbuf.  getpbuf() decrements this counter in allocation and
330  *	increments it on release, and blocks if the counter hits zero.  A
331  *	subsystem may initialize the counter to -1 to disable the feature,
332  *	but it must still be sure to match up all uses of getpbuf() with
333  *	relpbuf() using the same variable.
334  *
335  *	NOTE: pfreecnt can be NULL, but this 'feature' will be removed
336  *	relatively soon when the rest of the subsystems get smart about it. XXX
337  *
338  *	Physical buffers can be with or without KVA space reserved.  There
339  *	are severe limitations on the ones with KVA reserved, and fewer
340  *	limitations on the ones without.  getpbuf() gets one without,
341  *	getpbuf_kva() gets one with.
342  *
343  * No requirements.
344  */
345 struct buf *
346 getpbuf(int *pfreecnt)
347 {
348 	struct buf *bp;
349 
350 	spin_lock(&bswspin);
351 
352 	for (;;) {
353 		if (pfreecnt) {
354 			while (*pfreecnt == 0)
355 				ssleep(pfreecnt, &bswspin, 0, "wswbuf0", 0);
356 		}
357 
358 		/* get a bp from the swap buffer header pool */
359 		if ((bp = TAILQ_FIRST(&bswlist_raw)) != NULL)
360 			break;
361 		bswneeded_raw = 1;
362 		ssleep(&bswneeded_raw, &bswspin, 0, "wswbuf1", 0);
363 		/* loop in case someone else grabbed one */
364 	}
365 	TAILQ_REMOVE(&bswlist_raw, bp, b_freelist);
366 	--pbuf_raw_count;
367 	if (pfreecnt)
368 		--*pfreecnt;
369 
370 	spin_unlock(&bswspin);
371 
372 	initpbuf(bp);
373 	KKASSERT(dsched_is_clear_buf_priv(bp));
374 
375 	return (bp);
376 }
377 
378 struct buf *
379 getpbuf_kva(int *pfreecnt)
380 {
381 	struct buf *bp;
382 
383 	spin_lock(&bswspin);
384 
385 	for (;;) {
386 		if (pfreecnt) {
387 			while (*pfreecnt == 0)
388 				ssleep(pfreecnt, &bswspin, 0, "wswbuf0", 0);
389 		}
390 
391 		/* get a bp from the swap buffer header pool */
392 		if ((bp = TAILQ_FIRST(&bswlist_kva)) != NULL)
393 			break;
394 		bswneeded_kva = 1;
395 		ssleep(&bswneeded_kva, &bswspin, 0, "wswbuf1", 0);
396 		/* loop in case someone else grabbed one */
397 	}
398 	TAILQ_REMOVE(&bswlist_kva, bp, b_freelist);
399 	--pbuf_kva_count;
400 	if (pfreecnt)
401 		--*pfreecnt;
402 
403 	spin_unlock(&bswspin);
404 
405 	initpbuf(bp);
406 	KKASSERT(dsched_is_clear_buf_priv(bp));
407 
408 	return (bp);
409 }
410 
411 /*
412  * Allocate a physical buffer, if one is available.
413  *
414  *	Note that there is no NULL hack here - all subsystems using this
415  *	call understand how to use pfreecnt.
416  *
417  * No requirements.
418  */
419 struct buf *
420 trypbuf(int *pfreecnt)
421 {
422 	struct buf *bp;
423 
424 	spin_lock(&bswspin);
425 
426 	if (*pfreecnt == 0 || (bp = TAILQ_FIRST(&bswlist_raw)) == NULL) {
427 		spin_unlock(&bswspin);
428 		return NULL;
429 	}
430 	TAILQ_REMOVE(&bswlist_raw, bp, b_freelist);
431 	--pbuf_raw_count;
432 	--*pfreecnt;
433 
434 	spin_unlock(&bswspin);
435 
436 	initpbuf(bp);
437 
438 	return bp;
439 }
440 
441 struct buf *
442 trypbuf_kva(int *pfreecnt)
443 {
444 	struct buf *bp;
445 
446 	spin_lock(&bswspin);
447 
448 	if (*pfreecnt == 0 || (bp = TAILQ_FIRST(&bswlist_kva)) == NULL) {
449 		spin_unlock(&bswspin);
450 		return NULL;
451 	}
452 	TAILQ_REMOVE(&bswlist_kva, bp, b_freelist);
453 	--pbuf_kva_count;
454 	--*pfreecnt;
455 
456 	spin_unlock(&bswspin);
457 
458 	initpbuf(bp);
459 
460 	return bp;
461 }
462 
463 /*
464  * Release a physical buffer
465  *
466  *	NOTE: pfreecnt can be NULL, but this 'feature' will be removed
467  *	relatively soon when the rest of the subsystems get smart about it. XXX
468  *
469  * No requirements.
470  */
471 void
472 relpbuf(struct buf *bp, int *pfreecnt)
473 {
474 	int wake_bsw_kva = 0;
475 	int wake_bsw_raw = 0;
476 	int wake_freecnt = 0;
477 
478 	KKASSERT(bp->b_flags & B_PAGING);
479 	dsched_exit_buf(bp);
480 
481 	BUF_UNLOCK(bp);
482 
483 	spin_lock(&bswspin);
484 	if (bp->b_kvabase) {
485 		TAILQ_INSERT_HEAD(&bswlist_kva, bp, b_freelist);
486 		++pbuf_kva_count;
487 	} else {
488 		TAILQ_INSERT_HEAD(&bswlist_raw, bp, b_freelist);
489 		++pbuf_raw_count;
490 	}
491 	if (bswneeded_kva) {
492 		bswneeded_kva = 0;
493 		wake_bsw_kva = 1;
494 	}
495 	if (bswneeded_raw) {
496 		bswneeded_raw = 0;
497 		wake_bsw_raw = 1;
498 	}
499 	if (pfreecnt) {
500 		if (++*pfreecnt == 1)
501 			wake_freecnt = 1;
502 	}
503 	spin_unlock(&bswspin);
504 
505 	if (wake_bsw_kva)
506 		wakeup(&bswneeded_kva);
507 	if (wake_bsw_raw)
508 		wakeup(&bswneeded_raw);
509 	if (wake_freecnt)
510 		wakeup(pfreecnt);
511 }
512 
513 void
514 pbuf_adjcount(int *pfreecnt, int n)
515 {
516 	if (n) {
517 		spin_lock(&bswspin);
518 		*pfreecnt += n;
519 		spin_unlock(&bswspin);
520 		wakeup(pfreecnt);
521 	}
522 }
523