xref: /freebsd/sys/vm/vnode_pager.c (revision 00a5db46de56179184c0f000eaacad695e2b0859)
1 /*-
2  * Copyright (c) 1990 University of Utah.
3  * Copyright (c) 1991 The Regents of the University of California.
4  * All rights reserved.
5  * Copyright (c) 1993, 1994 John S. Dyson
6  * Copyright (c) 1995, David Greenman
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  *	from: @(#)vnode_pager.c	7.5 (Berkeley) 4/20/91
41  */
42 
43 /*
44  * Page to/from files (vnodes).
45  */
46 
47 /*
48  * TODO:
49  *	Implement VOP_GETPAGES/PUTPAGES interface for filesystems. Will
50  *	greatly re-simplify the vnode_pager.
51  */
52 
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55 
56 #include <sys/param.h>
57 #include <sys/systm.h>
58 #include <sys/proc.h>
59 #include <sys/vnode.h>
60 #include <sys/mount.h>
61 #include <sys/bio.h>
62 #include <sys/buf.h>
63 #include <sys/vmmeter.h>
64 #include <sys/limits.h>
65 #include <sys/conf.h>
66 #include <sys/sf_buf.h>
67 
68 #include <machine/atomic.h>
69 
70 #include <vm/vm.h>
71 #include <vm/vm_object.h>
72 #include <vm/vm_page.h>
73 #include <vm/vm_pager.h>
74 #include <vm/vm_map.h>
75 #include <vm/vnode_pager.h>
76 #include <vm/vm_extern.h>
77 
78 static int vnode_pager_addr(struct vnode *vp, vm_ooffset_t address,
79     daddr_t *rtaddress, int *run);
80 static int vnode_pager_input_smlfs(vm_object_t object, vm_page_t m);
81 static int vnode_pager_input_old(vm_object_t object, vm_page_t m);
82 static void vnode_pager_dealloc(vm_object_t);
83 static int vnode_pager_getpages(vm_object_t, vm_page_t *, int, int);
84 static void vnode_pager_putpages(vm_object_t, vm_page_t *, int, boolean_t, int *);
85 static boolean_t vnode_pager_haspage(vm_object_t, vm_pindex_t, int *, int *);
86 static vm_object_t vnode_pager_alloc(void *, vm_ooffset_t, vm_prot_t, vm_ooffset_t);
87 
88 struct pagerops vnodepagerops = {
89 	.pgo_alloc =	vnode_pager_alloc,
90 	.pgo_dealloc =	vnode_pager_dealloc,
91 	.pgo_getpages =	vnode_pager_getpages,
92 	.pgo_putpages =	vnode_pager_putpages,
93 	.pgo_haspage =	vnode_pager_haspage,
94 };
95 
96 int vnode_pbuf_freecnt;
97 
98 /* Create the VM system backing object for this vnode */
99 int
100 vnode_create_vobject(struct vnode *vp, off_t isize, struct thread *td)
101 {
102 	vm_object_t object;
103 	vm_ooffset_t size = isize;
104 	struct vattr va;
105 
106 	if (!vn_isdisk(vp, NULL) && vn_canvmio(vp) == FALSE)
107 		return (0);
108 
109 	while ((object = vp->v_object) != NULL) {
110 		VM_OBJECT_LOCK(object);
111 		if (!(object->flags & OBJ_DEAD)) {
112 			VM_OBJECT_UNLOCK(object);
113 			return (0);
114 		}
115 		VOP_UNLOCK(vp, 0);
116 		vm_object_set_flag(object, OBJ_DISCONNECTWNT);
117 		msleep(object, VM_OBJECT_MTX(object), PDROP | PVM, "vodead", 0);
118 		vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
119 	}
120 
121 	if (size == 0) {
122 		if (vn_isdisk(vp, NULL)) {
123 			size = IDX_TO_OFF(INT_MAX);
124 		} else {
125 			if (VOP_GETATTR(vp, &va, td->td_ucred))
126 				return (0);
127 			size = va.va_size;
128 		}
129 	}
130 
131 	object = vnode_pager_alloc(vp, size, 0, 0);
132 	/*
133 	 * Dereference the reference we just created.  This assumes
134 	 * that the object is associated with the vp.
135 	 */
136 	VM_OBJECT_LOCK(object);
137 	object->ref_count--;
138 	VM_OBJECT_UNLOCK(object);
139 	vrele(vp);
140 
141 	KASSERT(vp->v_object != NULL, ("vnode_create_vobject: NULL object"));
142 
143 	return (0);
144 }
145 
146 void
147 vnode_destroy_vobject(struct vnode *vp)
148 {
149 	struct vm_object *obj;
150 
151 	obj = vp->v_object;
152 	if (obj == NULL)
153 		return;
154 	ASSERT_VOP_ELOCKED(vp, "vnode_destroy_vobject");
155 	VM_OBJECT_LOCK(obj);
156 	if (obj->ref_count == 0) {
157 		/*
158 		 * vclean() may be called twice. The first time
159 		 * removes the primary reference to the object,
160 		 * the second time goes one further and is a
161 		 * special-case to terminate the object.
162 		 *
163 		 * don't double-terminate the object
164 		 */
165 		if ((obj->flags & OBJ_DEAD) == 0)
166 			vm_object_terminate(obj);
167 		else
168 			VM_OBJECT_UNLOCK(obj);
169 	} else {
170 		/*
171 		 * Woe to the process that tries to page now :-).
172 		 */
173 		vm_pager_deallocate(obj);
174 		VM_OBJECT_UNLOCK(obj);
175 	}
176 	vp->v_object = NULL;
177 }
178 
179 
180 /*
181  * Allocate (or lookup) pager for a vnode.
182  * Handle is a vnode pointer.
183  *
184  * MPSAFE
185  */
186 vm_object_t
187 vnode_pager_alloc(void *handle, vm_ooffset_t size, vm_prot_t prot,
188 		  vm_ooffset_t offset)
189 {
190 	vm_object_t object;
191 	struct vnode *vp;
192 
193 	/*
194 	 * Pageout to vnode, no can do yet.
195 	 */
196 	if (handle == NULL)
197 		return (NULL);
198 
199 	vp = (struct vnode *) handle;
200 
201 	/*
202 	 * If the object is being terminated, wait for it to
203 	 * go away.
204 	 */
205 retry:
206 	while ((object = vp->v_object) != NULL) {
207 		VM_OBJECT_LOCK(object);
208 		if ((object->flags & OBJ_DEAD) == 0)
209 			break;
210 		vm_object_set_flag(object, OBJ_DISCONNECTWNT);
211 		msleep(object, VM_OBJECT_MTX(object), PDROP | PVM, "vadead", 0);
212 	}
213 
214 	if (vp->v_usecount == 0)
215 		panic("vnode_pager_alloc: no vnode reference");
216 
217 	if (object == NULL) {
218 		/*
219 		 * Add an object of the appropriate size
220 		 */
221 		object = vm_object_allocate(OBJT_VNODE, OFF_TO_IDX(round_page(size)));
222 
223 		object->un_pager.vnp.vnp_size = size;
224 
225 		object->handle = handle;
226 		VI_LOCK(vp);
227 		if (vp->v_object != NULL) {
228 			/*
229 			 * Object has been created while we were sleeping
230 			 */
231 			VI_UNLOCK(vp);
232 			vm_object_destroy(object);
233 			goto retry;
234 		}
235 		vp->v_object = object;
236 		VI_UNLOCK(vp);
237 	} else {
238 		object->ref_count++;
239 		VM_OBJECT_UNLOCK(object);
240 	}
241 	vref(vp);
242 	return (object);
243 }
244 
245 /*
246  *	The object must be locked.
247  */
248 static void
249 vnode_pager_dealloc(object)
250 	vm_object_t object;
251 {
252 	struct vnode *vp = object->handle;
253 
254 	if (vp == NULL)
255 		panic("vnode_pager_dealloc: pager already dealloced");
256 
257 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
258 	vm_object_pip_wait(object, "vnpdea");
259 
260 	object->handle = NULL;
261 	object->type = OBJT_DEAD;
262 	if (object->flags & OBJ_DISCONNECTWNT) {
263 		vm_object_clear_flag(object, OBJ_DISCONNECTWNT);
264 		wakeup(object);
265 	}
266 	ASSERT_VOP_ELOCKED(vp, "vnode_pager_dealloc");
267 	vp->v_object = NULL;
268 	vp->v_vflag &= ~VV_TEXT;
269 }
270 
271 static boolean_t
272 vnode_pager_haspage(object, pindex, before, after)
273 	vm_object_t object;
274 	vm_pindex_t pindex;
275 	int *before;
276 	int *after;
277 {
278 	struct vnode *vp = object->handle;
279 	daddr_t bn;
280 	int err;
281 	daddr_t reqblock;
282 	int poff;
283 	int bsize;
284 	int pagesperblock, blocksperpage;
285 	int vfslocked;
286 
287 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
288 	/*
289 	 * If no vp or vp is doomed or marked transparent to VM, we do not
290 	 * have the page.
291 	 */
292 	if (vp == NULL || vp->v_iflag & VI_DOOMED)
293 		return FALSE;
294 	/*
295 	 * If the offset is beyond end of file we do
296 	 * not have the page.
297 	 */
298 	if (IDX_TO_OFF(pindex) >= object->un_pager.vnp.vnp_size)
299 		return FALSE;
300 
301 	bsize = vp->v_mount->mnt_stat.f_iosize;
302 	pagesperblock = bsize / PAGE_SIZE;
303 	blocksperpage = 0;
304 	if (pagesperblock > 0) {
305 		reqblock = pindex / pagesperblock;
306 	} else {
307 		blocksperpage = (PAGE_SIZE / bsize);
308 		reqblock = pindex * blocksperpage;
309 	}
310 	VM_OBJECT_UNLOCK(object);
311 	vfslocked = VFS_LOCK_GIANT(vp->v_mount);
312 	err = VOP_BMAP(vp, reqblock, NULL, &bn, after, before);
313 	VFS_UNLOCK_GIANT(vfslocked);
314 	VM_OBJECT_LOCK(object);
315 	if (err)
316 		return TRUE;
317 	if (bn == -1)
318 		return FALSE;
319 	if (pagesperblock > 0) {
320 		poff = pindex - (reqblock * pagesperblock);
321 		if (before) {
322 			*before *= pagesperblock;
323 			*before += poff;
324 		}
325 		if (after) {
326 			int numafter;
327 			*after *= pagesperblock;
328 			numafter = pagesperblock - (poff + 1);
329 			if (IDX_TO_OFF(pindex + numafter) >
330 			    object->un_pager.vnp.vnp_size) {
331 				numafter =
332 		    		    OFF_TO_IDX(object->un_pager.vnp.vnp_size) -
333 				    pindex;
334 			}
335 			*after += numafter;
336 		}
337 	} else {
338 		if (before) {
339 			*before /= blocksperpage;
340 		}
341 
342 		if (after) {
343 			*after /= blocksperpage;
344 		}
345 	}
346 	return TRUE;
347 }
348 
349 /*
350  * Lets the VM system know about a change in size for a file.
351  * We adjust our own internal size and flush any cached pages in
352  * the associated object that are affected by the size change.
353  *
354  * Note: this routine may be invoked as a result of a pager put
355  * operation (possibly at object termination time), so we must be careful.
356  */
357 void
358 vnode_pager_setsize(vp, nsize)
359 	struct vnode *vp;
360 	vm_ooffset_t nsize;
361 {
362 	vm_object_t object;
363 	vm_page_t m;
364 	vm_pindex_t nobjsize;
365 
366 	if ((object = vp->v_object) == NULL)
367 		return;
368 /* 	ASSERT_VOP_ELOCKED(vp, "vnode_pager_setsize and not locked vnode"); */
369 	VM_OBJECT_LOCK(object);
370 	if (nsize == object->un_pager.vnp.vnp_size) {
371 		/*
372 		 * Hasn't changed size
373 		 */
374 		VM_OBJECT_UNLOCK(object);
375 		return;
376 	}
377 	nobjsize = OFF_TO_IDX(nsize + PAGE_MASK);
378 	if (nsize < object->un_pager.vnp.vnp_size) {
379 		/*
380 		 * File has shrunk. Toss any cached pages beyond the new EOF.
381 		 */
382 		if (nobjsize < object->size)
383 			vm_object_page_remove(object, nobjsize, object->size,
384 			    FALSE);
385 		/*
386 		 * this gets rid of garbage at the end of a page that is now
387 		 * only partially backed by the vnode.
388 		 *
389 		 * XXX for some reason (I don't know yet), if we take a
390 		 * completely invalid page and mark it partially valid
391 		 * it can screw up NFS reads, so we don't allow the case.
392 		 */
393 		if ((nsize & PAGE_MASK) &&
394 		    (m = vm_page_lookup(object, OFF_TO_IDX(nsize))) != NULL &&
395 		    m->valid != 0) {
396 			int base = (int)nsize & PAGE_MASK;
397 			int size = PAGE_SIZE - base;
398 
399 			/*
400 			 * Clear out partial-page garbage in case
401 			 * the page has been mapped.
402 			 */
403 			pmap_zero_page_area(m, base, size);
404 
405 			/*
406 			 * Clear out partial-page dirty bits.  This
407 			 * has the side effect of setting the valid
408 			 * bits, but that is ok.  There are a bunch
409 			 * of places in the VM system where we expected
410 			 * m->dirty == VM_PAGE_BITS_ALL.  The file EOF
411 			 * case is one of them.  If the page is still
412 			 * partially dirty, make it fully dirty.
413 			 *
414 			 * note that we do not clear out the valid
415 			 * bits.  This would prevent bogus_page
416 			 * replacement from working properly.
417 			 */
418 			vm_page_lock_queues();
419 			vm_page_set_validclean(m, base, size);
420 			if (m->dirty != 0)
421 				m->dirty = VM_PAGE_BITS_ALL;
422 			vm_page_unlock_queues();
423 		} else if ((nsize & PAGE_MASK) &&
424 		    __predict_false(object->cache != NULL)) {
425 			vm_page_cache_free(object, OFF_TO_IDX(nsize),
426 			    nobjsize);
427 		}
428 	}
429 	object->un_pager.vnp.vnp_size = nsize;
430 	object->size = nobjsize;
431 	VM_OBJECT_UNLOCK(object);
432 }
433 
434 /*
435  * calculate the linear (byte) disk address of specified virtual
436  * file address
437  */
438 static int
439 vnode_pager_addr(struct vnode *vp, vm_ooffset_t address, daddr_t *rtaddress,
440     int *run)
441 {
442 	int bsize;
443 	int err;
444 	daddr_t vblock;
445 	daddr_t voffset;
446 
447 	if (address < 0)
448 		return -1;
449 
450 	if (vp->v_iflag & VI_DOOMED)
451 		return -1;
452 
453 	bsize = vp->v_mount->mnt_stat.f_iosize;
454 	vblock = address / bsize;
455 	voffset = address % bsize;
456 
457 	err = VOP_BMAP(vp, vblock, NULL, rtaddress, run, NULL);
458 	if (err == 0) {
459 		if (*rtaddress != -1)
460 			*rtaddress += voffset / DEV_BSIZE;
461 		if (run) {
462 			*run += 1;
463 			*run *= bsize/PAGE_SIZE;
464 			*run -= voffset/PAGE_SIZE;
465 		}
466 	}
467 
468 	return (err);
469 }
470 
471 /*
472  * small block filesystem vnode pager input
473  */
474 static int
475 vnode_pager_input_smlfs(object, m)
476 	vm_object_t object;
477 	vm_page_t m;
478 {
479 	int bits, i;
480 	struct vnode *vp;
481 	struct bufobj *bo;
482 	struct buf *bp;
483 	struct sf_buf *sf;
484 	daddr_t fileaddr;
485 	vm_offset_t bsize;
486 	int error = 0;
487 
488 	vp = object->handle;
489 	if (vp->v_iflag & VI_DOOMED)
490 		return VM_PAGER_BAD;
491 
492 	bsize = vp->v_mount->mnt_stat.f_iosize;
493 
494 	VOP_BMAP(vp, 0, &bo, 0, NULL, NULL);
495 
496 	sf = sf_buf_alloc(m, 0);
497 
498 	for (i = 0; i < PAGE_SIZE / bsize; i++) {
499 		vm_ooffset_t address;
500 
501 		bits = vm_page_bits(i * bsize, bsize);
502 		if (m->valid & bits)
503 			continue;
504 
505 		address = IDX_TO_OFF(m->pindex) + i * bsize;
506 		if (address >= object->un_pager.vnp.vnp_size) {
507 			fileaddr = -1;
508 		} else {
509 			error = vnode_pager_addr(vp, address, &fileaddr, NULL);
510 			if (error)
511 				break;
512 		}
513 		if (fileaddr != -1) {
514 			bp = getpbuf(&vnode_pbuf_freecnt);
515 
516 			/* build a minimal buffer header */
517 			bp->b_iocmd = BIO_READ;
518 			bp->b_iodone = bdone;
519 			KASSERT(bp->b_rcred == NOCRED, ("leaking read ucred"));
520 			KASSERT(bp->b_wcred == NOCRED, ("leaking write ucred"));
521 			bp->b_rcred = crhold(curthread->td_ucred);
522 			bp->b_wcred = crhold(curthread->td_ucred);
523 			bp->b_data = (caddr_t)sf_buf_kva(sf) + i * bsize;
524 			bp->b_blkno = fileaddr;
525 			pbgetbo(bo, bp);
526 			bp->b_bcount = bsize;
527 			bp->b_bufsize = bsize;
528 			bp->b_runningbufspace = bp->b_bufsize;
529 			atomic_add_long(&runningbufspace, bp->b_runningbufspace);
530 
531 			/* do the input */
532 			bp->b_iooffset = dbtob(bp->b_blkno);
533 			bstrategy(bp);
534 
535 			bwait(bp, PVM, "vnsrd");
536 
537 			if ((bp->b_ioflags & BIO_ERROR) != 0)
538 				error = EIO;
539 
540 			/*
541 			 * free the buffer header back to the swap buffer pool
542 			 */
543 			pbrelbo(bp);
544 			relpbuf(bp, &vnode_pbuf_freecnt);
545 			if (error)
546 				break;
547 		} else
548 			bzero((caddr_t)sf_buf_kva(sf) + i * bsize, bsize);
549 		KASSERT((m->dirty & bits) == 0,
550 		    ("vnode_pager_input_smlfs: page %p is dirty", m));
551 		VM_OBJECT_LOCK(object);
552 		m->valid |= bits;
553 		VM_OBJECT_UNLOCK(object);
554 	}
555 	sf_buf_free(sf);
556 	if (error) {
557 		return VM_PAGER_ERROR;
558 	}
559 	return VM_PAGER_OK;
560 }
561 
562 /*
563  * old style vnode pager input routine
564  */
565 static int
566 vnode_pager_input_old(object, m)
567 	vm_object_t object;
568 	vm_page_t m;
569 {
570 	struct uio auio;
571 	struct iovec aiov;
572 	int error;
573 	int size;
574 	struct sf_buf *sf;
575 	struct vnode *vp;
576 
577 	VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
578 	error = 0;
579 
580 	/*
581 	 * Return failure if beyond current EOF
582 	 */
583 	if (IDX_TO_OFF(m->pindex) >= object->un_pager.vnp.vnp_size) {
584 		return VM_PAGER_BAD;
585 	} else {
586 		size = PAGE_SIZE;
587 		if (IDX_TO_OFF(m->pindex) + size > object->un_pager.vnp.vnp_size)
588 			size = object->un_pager.vnp.vnp_size - IDX_TO_OFF(m->pindex);
589 		vp = object->handle;
590 		VM_OBJECT_UNLOCK(object);
591 
592 		/*
593 		 * Allocate a kernel virtual address and initialize so that
594 		 * we can use VOP_READ/WRITE routines.
595 		 */
596 		sf = sf_buf_alloc(m, 0);
597 
598 		aiov.iov_base = (caddr_t)sf_buf_kva(sf);
599 		aiov.iov_len = size;
600 		auio.uio_iov = &aiov;
601 		auio.uio_iovcnt = 1;
602 		auio.uio_offset = IDX_TO_OFF(m->pindex);
603 		auio.uio_segflg = UIO_SYSSPACE;
604 		auio.uio_rw = UIO_READ;
605 		auio.uio_resid = size;
606 		auio.uio_td = curthread;
607 
608 		error = VOP_READ(vp, &auio, 0, curthread->td_ucred);
609 		if (!error) {
610 			int count = size - auio.uio_resid;
611 
612 			if (count == 0)
613 				error = EINVAL;
614 			else if (count != PAGE_SIZE)
615 				bzero((caddr_t)sf_buf_kva(sf) + count,
616 				    PAGE_SIZE - count);
617 		}
618 		sf_buf_free(sf);
619 
620 		VM_OBJECT_LOCK(object);
621 	}
622 	KASSERT(m->dirty == 0, ("vnode_pager_input_old: page %p is dirty", m));
623 	if (!error)
624 		m->valid = VM_PAGE_BITS_ALL;
625 	return error ? VM_PAGER_ERROR : VM_PAGER_OK;
626 }
627 
628 /*
629  * generic vnode pager input routine
630  */
631 
632 /*
633  * Local media VFS's that do not implement their own VOP_GETPAGES
634  * should have their VOP_GETPAGES call to vnode_pager_generic_getpages()
635  * to implement the previous behaviour.
636  *
637  * All other FS's should use the bypass to get to the local media
638  * backing vp's VOP_GETPAGES.
639  */
640 static int
641 vnode_pager_getpages(object, m, count, reqpage)
642 	vm_object_t object;
643 	vm_page_t *m;
644 	int count;
645 	int reqpage;
646 {
647 	int rtval;
648 	struct vnode *vp;
649 	int bytes = count * PAGE_SIZE;
650 	int vfslocked;
651 
652 	vp = object->handle;
653 	VM_OBJECT_UNLOCK(object);
654 	vfslocked = VFS_LOCK_GIANT(vp->v_mount);
655 	rtval = VOP_GETPAGES(vp, m, bytes, reqpage, 0);
656 	KASSERT(rtval != EOPNOTSUPP,
657 	    ("vnode_pager: FS getpages not implemented\n"));
658 	VFS_UNLOCK_GIANT(vfslocked);
659 	VM_OBJECT_LOCK(object);
660 	return rtval;
661 }
662 
663 /*
664  * This is now called from local media FS's to operate against their
665  * own vnodes if they fail to implement VOP_GETPAGES.
666  */
667 int
668 vnode_pager_generic_getpages(vp, m, bytecount, reqpage)
669 	struct vnode *vp;
670 	vm_page_t *m;
671 	int bytecount;
672 	int reqpage;
673 {
674 	vm_object_t object;
675 	vm_offset_t kva;
676 	off_t foff, tfoff, nextoff;
677 	int i, j, size, bsize, first;
678 	daddr_t firstaddr, reqblock;
679 	struct bufobj *bo;
680 	int runpg;
681 	int runend;
682 	struct buf *bp;
683 	int count;
684 	int error;
685 
686 	object = vp->v_object;
687 	count = bytecount / PAGE_SIZE;
688 
689 	KASSERT(vp->v_type != VCHR && vp->v_type != VBLK,
690 	    ("vnode_pager_generic_getpages does not support devices"));
691 	if (vp->v_iflag & VI_DOOMED)
692 		return VM_PAGER_BAD;
693 
694 	bsize = vp->v_mount->mnt_stat.f_iosize;
695 
696 	/* get the UNDERLYING device for the file with VOP_BMAP() */
697 
698 	/*
699 	 * originally, we did not check for an error return value -- assuming
700 	 * an fs always has a bmap entry point -- that assumption is wrong!!!
701 	 */
702 	foff = IDX_TO_OFF(m[reqpage]->pindex);
703 
704 	/*
705 	 * if we can't bmap, use old VOP code
706 	 */
707 	error = VOP_BMAP(vp, foff / bsize, &bo, &reqblock, NULL, NULL);
708 	if (error == EOPNOTSUPP) {
709 		VM_OBJECT_LOCK(object);
710 		vm_page_lock_queues();
711 		for (i = 0; i < count; i++)
712 			if (i != reqpage)
713 				vm_page_free(m[i]);
714 		vm_page_unlock_queues();
715 		PCPU_INC(cnt.v_vnodein);
716 		PCPU_INC(cnt.v_vnodepgsin);
717 		error = vnode_pager_input_old(object, m[reqpage]);
718 		VM_OBJECT_UNLOCK(object);
719 		return (error);
720 	} else if (error != 0) {
721 		VM_OBJECT_LOCK(object);
722 		vm_page_lock_queues();
723 		for (i = 0; i < count; i++)
724 			if (i != reqpage)
725 				vm_page_free(m[i]);
726 		vm_page_unlock_queues();
727 		VM_OBJECT_UNLOCK(object);
728 		return (VM_PAGER_ERROR);
729 
730 		/*
731 		 * if the blocksize is smaller than a page size, then use
732 		 * special small filesystem code.  NFS sometimes has a small
733 		 * blocksize, but it can handle large reads itself.
734 		 */
735 	} else if ((PAGE_SIZE / bsize) > 1 &&
736 	    (vp->v_mount->mnt_stat.f_type != nfs_mount_type)) {
737 		VM_OBJECT_LOCK(object);
738 		vm_page_lock_queues();
739 		for (i = 0; i < count; i++)
740 			if (i != reqpage)
741 				vm_page_free(m[i]);
742 		vm_page_unlock_queues();
743 		VM_OBJECT_UNLOCK(object);
744 		PCPU_INC(cnt.v_vnodein);
745 		PCPU_INC(cnt.v_vnodepgsin);
746 		return vnode_pager_input_smlfs(object, m[reqpage]);
747 	}
748 
749 	/*
750 	 * If we have a completely valid page available to us, we can
751 	 * clean up and return.  Otherwise we have to re-read the
752 	 * media.
753 	 */
754 	VM_OBJECT_LOCK(object);
755 	if (m[reqpage]->valid == VM_PAGE_BITS_ALL) {
756 		vm_page_lock_queues();
757 		for (i = 0; i < count; i++)
758 			if (i != reqpage)
759 				vm_page_free(m[i]);
760 		vm_page_unlock_queues();
761 		VM_OBJECT_UNLOCK(object);
762 		return VM_PAGER_OK;
763 	} else if (reqblock == -1) {
764 		pmap_zero_page(m[reqpage]);
765 		KASSERT(m[reqpage]->dirty == 0,
766 		    ("vnode_pager_generic_getpages: page %p is dirty", m));
767 		m[reqpage]->valid = VM_PAGE_BITS_ALL;
768 		vm_page_lock_queues();
769 		for (i = 0; i < count; i++)
770 			if (i != reqpage)
771 				vm_page_free(m[i]);
772 		vm_page_unlock_queues();
773 		VM_OBJECT_UNLOCK(object);
774 		return (VM_PAGER_OK);
775 	}
776 	m[reqpage]->valid = 0;
777 	VM_OBJECT_UNLOCK(object);
778 
779 	/*
780 	 * here on direct device I/O
781 	 */
782 	firstaddr = -1;
783 
784 	/*
785 	 * calculate the run that includes the required page
786 	 */
787 	for (first = 0, i = 0; i < count; i = runend) {
788 		if (vnode_pager_addr(vp, IDX_TO_OFF(m[i]->pindex), &firstaddr,
789 		    &runpg) != 0) {
790 			VM_OBJECT_LOCK(object);
791 			vm_page_lock_queues();
792 			for (; i < count; i++)
793 				if (i != reqpage)
794 					vm_page_free(m[i]);
795 			vm_page_unlock_queues();
796 			VM_OBJECT_UNLOCK(object);
797 			return (VM_PAGER_ERROR);
798 		}
799 		if (firstaddr == -1) {
800 			VM_OBJECT_LOCK(object);
801 			if (i == reqpage && foff < object->un_pager.vnp.vnp_size) {
802 				panic("vnode_pager_getpages: unexpected missing page: firstaddr: %jd, foff: 0x%jx%08jx, vnp_size: 0x%jx%08jx",
803 				    (intmax_t)firstaddr, (uintmax_t)(foff >> 32),
804 				    (uintmax_t)foff,
805 				    (uintmax_t)
806 				    (object->un_pager.vnp.vnp_size >> 32),
807 				    (uintmax_t)object->un_pager.vnp.vnp_size);
808 			}
809 			vm_page_lock_queues();
810 			vm_page_free(m[i]);
811 			vm_page_unlock_queues();
812 			VM_OBJECT_UNLOCK(object);
813 			runend = i + 1;
814 			first = runend;
815 			continue;
816 		}
817 		runend = i + runpg;
818 		if (runend <= reqpage) {
819 			VM_OBJECT_LOCK(object);
820 			vm_page_lock_queues();
821 			for (j = i; j < runend; j++)
822 				vm_page_free(m[j]);
823 			vm_page_unlock_queues();
824 			VM_OBJECT_UNLOCK(object);
825 		} else {
826 			if (runpg < (count - first)) {
827 				VM_OBJECT_LOCK(object);
828 				vm_page_lock_queues();
829 				for (i = first + runpg; i < count; i++)
830 					vm_page_free(m[i]);
831 				vm_page_unlock_queues();
832 				VM_OBJECT_UNLOCK(object);
833 				count = first + runpg;
834 			}
835 			break;
836 		}
837 		first = runend;
838 	}
839 
840 	/*
841 	 * the first and last page have been calculated now, move input pages
842 	 * to be zero based...
843 	 */
844 	if (first != 0) {
845 		m += first;
846 		count -= first;
847 		reqpage -= first;
848 	}
849 
850 	/*
851 	 * calculate the file virtual address for the transfer
852 	 */
853 	foff = IDX_TO_OFF(m[0]->pindex);
854 
855 	/*
856 	 * calculate the size of the transfer
857 	 */
858 	size = count * PAGE_SIZE;
859 	KASSERT(count > 0, ("zero count"));
860 	if ((foff + size) > object->un_pager.vnp.vnp_size)
861 		size = object->un_pager.vnp.vnp_size - foff;
862 	KASSERT(size > 0, ("zero size"));
863 
864 	/*
865 	 * round up physical size for real devices.
866 	 */
867 	if (1) {
868 		int secmask = bo->bo_bsize - 1;
869 		KASSERT(secmask < PAGE_SIZE && secmask > 0,
870 		    ("vnode_pager_generic_getpages: sector size %d too large",
871 		    secmask + 1));
872 		size = (size + secmask) & ~secmask;
873 	}
874 
875 	bp = getpbuf(&vnode_pbuf_freecnt);
876 	kva = (vm_offset_t) bp->b_data;
877 
878 	/*
879 	 * and map the pages to be read into the kva
880 	 */
881 	pmap_qenter(kva, m, count);
882 
883 	/* build a minimal buffer header */
884 	bp->b_iocmd = BIO_READ;
885 	bp->b_iodone = bdone;
886 	KASSERT(bp->b_rcred == NOCRED, ("leaking read ucred"));
887 	KASSERT(bp->b_wcred == NOCRED, ("leaking write ucred"));
888 	bp->b_rcred = crhold(curthread->td_ucred);
889 	bp->b_wcred = crhold(curthread->td_ucred);
890 	bp->b_blkno = firstaddr;
891 	pbgetbo(bo, bp);
892 	bp->b_bcount = size;
893 	bp->b_bufsize = size;
894 	bp->b_runningbufspace = bp->b_bufsize;
895 	atomic_add_long(&runningbufspace, bp->b_runningbufspace);
896 
897 	PCPU_INC(cnt.v_vnodein);
898 	PCPU_ADD(cnt.v_vnodepgsin, count);
899 
900 	/* do the input */
901 	bp->b_iooffset = dbtob(bp->b_blkno);
902 	bstrategy(bp);
903 
904 	bwait(bp, PVM, "vnread");
905 
906 	if ((bp->b_ioflags & BIO_ERROR) != 0)
907 		error = EIO;
908 
909 	if (!error) {
910 		if (size != count * PAGE_SIZE)
911 			bzero((caddr_t) kva + size, PAGE_SIZE * count - size);
912 	}
913 	pmap_qremove(kva, count);
914 
915 	/*
916 	 * free the buffer header back to the swap buffer pool
917 	 */
918 	pbrelbo(bp);
919 	relpbuf(bp, &vnode_pbuf_freecnt);
920 
921 	VM_OBJECT_LOCK(object);
922 	vm_page_lock_queues();
923 	for (i = 0, tfoff = foff; i < count; i++, tfoff = nextoff) {
924 		vm_page_t mt;
925 
926 		nextoff = tfoff + PAGE_SIZE;
927 		mt = m[i];
928 
929 		if (nextoff <= object->un_pager.vnp.vnp_size) {
930 			/*
931 			 * Read filled up entire page.
932 			 */
933 			mt->valid = VM_PAGE_BITS_ALL;
934 			KASSERT(mt->dirty == 0,
935 			    ("vnode_pager_generic_getpages: page %p is dirty",
936 			    mt));
937 			KASSERT(!pmap_page_is_mapped(mt),
938 			    ("vnode_pager_generic_getpages: page %p is mapped",
939 			    mt));
940 		} else {
941 			/*
942 			 * Read did not fill up entire page.
943 			 *
944 			 * Currently we do not set the entire page valid,
945 			 * we just try to clear the piece that we couldn't
946 			 * read.
947 			 */
948 			vm_page_set_valid(mt, 0,
949 			    object->un_pager.vnp.vnp_size - tfoff);
950 			KASSERT((mt->dirty & vm_page_bits(0,
951 			    object->un_pager.vnp.vnp_size - tfoff)) == 0,
952 			    ("vnode_pager_generic_getpages: page %p is dirty",
953 			    mt));
954 		}
955 
956 		if (i != reqpage) {
957 
958 			/*
959 			 * whether or not to leave the page activated is up in
960 			 * the air, but we should put the page on a page queue
961 			 * somewhere. (it already is in the object). Result:
962 			 * It appears that empirical results show that
963 			 * deactivating pages is best.
964 			 */
965 
966 			/*
967 			 * just in case someone was asking for this page we
968 			 * now tell them that it is ok to use
969 			 */
970 			if (!error) {
971 				if (mt->oflags & VPO_WANTED)
972 					vm_page_activate(mt);
973 				else
974 					vm_page_deactivate(mt);
975 				vm_page_wakeup(mt);
976 			} else {
977 				vm_page_free(mt);
978 			}
979 		}
980 	}
981 	vm_page_unlock_queues();
982 	VM_OBJECT_UNLOCK(object);
983 	if (error) {
984 		printf("vnode_pager_getpages: I/O read error\n");
985 	}
986 	return (error ? VM_PAGER_ERROR : VM_PAGER_OK);
987 }
988 
989 /*
990  * EOPNOTSUPP is no longer legal.  For local media VFS's that do not
991  * implement their own VOP_PUTPAGES, their VOP_PUTPAGES should call to
992  * vnode_pager_generic_putpages() to implement the previous behaviour.
993  *
994  * All other FS's should use the bypass to get to the local media
995  * backing vp's VOP_PUTPAGES.
996  */
997 static void
998 vnode_pager_putpages(object, m, count, sync, rtvals)
999 	vm_object_t object;
1000 	vm_page_t *m;
1001 	int count;
1002 	boolean_t sync;
1003 	int *rtvals;
1004 {
1005 	int rtval;
1006 	struct vnode *vp;
1007 	struct mount *mp;
1008 	int bytes = count * PAGE_SIZE;
1009 
1010 	/*
1011 	 * Force synchronous operation if we are extremely low on memory
1012 	 * to prevent a low-memory deadlock.  VOP operations often need to
1013 	 * allocate more memory to initiate the I/O ( i.e. do a BMAP
1014 	 * operation ).  The swapper handles the case by limiting the amount
1015 	 * of asynchronous I/O, but that sort of solution doesn't scale well
1016 	 * for the vnode pager without a lot of work.
1017 	 *
1018 	 * Also, the backing vnode's iodone routine may not wake the pageout
1019 	 * daemon up.  This should be probably be addressed XXX.
1020 	 */
1021 
1022 	if ((cnt.v_free_count + cnt.v_cache_count) < cnt.v_pageout_free_min)
1023 		sync |= OBJPC_SYNC;
1024 
1025 	/*
1026 	 * Call device-specific putpages function
1027 	 */
1028 	vp = object->handle;
1029 	VM_OBJECT_UNLOCK(object);
1030 	if (vp->v_type != VREG)
1031 		mp = NULL;
1032 	rtval = VOP_PUTPAGES(vp, m, bytes, sync, rtvals, 0);
1033 	KASSERT(rtval != EOPNOTSUPP,
1034 	    ("vnode_pager: stale FS putpages\n"));
1035 	VM_OBJECT_LOCK(object);
1036 }
1037 
1038 
1039 /*
1040  * This is now called from local media FS's to operate against their
1041  * own vnodes if they fail to implement VOP_PUTPAGES.
1042  *
1043  * This is typically called indirectly via the pageout daemon and
1044  * clustering has already typically occured, so in general we ask the
1045  * underlying filesystem to write the data out asynchronously rather
1046  * then delayed.
1047  */
1048 int
1049 vnode_pager_generic_putpages(vp, m, bytecount, flags, rtvals)
1050 	struct vnode *vp;
1051 	vm_page_t *m;
1052 	int bytecount;
1053 	int flags;
1054 	int *rtvals;
1055 {
1056 	int i;
1057 	vm_object_t object;
1058 	int count;
1059 
1060 	int maxsize, ncount;
1061 	vm_ooffset_t poffset;
1062 	struct uio auio;
1063 	struct iovec aiov;
1064 	int error;
1065 	int ioflags;
1066 	int ppscheck = 0;
1067 	static struct timeval lastfail;
1068 	static int curfail;
1069 
1070 	object = vp->v_object;
1071 	count = bytecount / PAGE_SIZE;
1072 
1073 	for (i = 0; i < count; i++)
1074 		rtvals[i] = VM_PAGER_AGAIN;
1075 
1076 	if ((int64_t)m[0]->pindex < 0) {
1077 		printf("vnode_pager_putpages: attempt to write meta-data!!! -- 0x%lx(%lx)\n",
1078 			(long)m[0]->pindex, (u_long)m[0]->dirty);
1079 		rtvals[0] = VM_PAGER_BAD;
1080 		return VM_PAGER_BAD;
1081 	}
1082 
1083 	maxsize = count * PAGE_SIZE;
1084 	ncount = count;
1085 
1086 	poffset = IDX_TO_OFF(m[0]->pindex);
1087 
1088 	/*
1089 	 * If the page-aligned write is larger then the actual file we
1090 	 * have to invalidate pages occuring beyond the file EOF.  However,
1091 	 * there is an edge case where a file may not be page-aligned where
1092 	 * the last page is partially invalid.  In this case the filesystem
1093 	 * may not properly clear the dirty bits for the entire page (which
1094 	 * could be VM_PAGE_BITS_ALL due to the page having been mmap()d).
1095 	 * With the page locked we are free to fix-up the dirty bits here.
1096 	 *
1097 	 * We do not under any circumstances truncate the valid bits, as
1098 	 * this will screw up bogus page replacement.
1099 	 */
1100 	if (maxsize + poffset > object->un_pager.vnp.vnp_size) {
1101 		if (object->un_pager.vnp.vnp_size > poffset) {
1102 			int pgoff;
1103 
1104 			maxsize = object->un_pager.vnp.vnp_size - poffset;
1105 			ncount = btoc(maxsize);
1106 			if ((pgoff = (int)maxsize & PAGE_MASK) != 0) {
1107 				vm_page_lock_queues();
1108 				vm_page_clear_dirty(m[ncount - 1], pgoff,
1109 					PAGE_SIZE - pgoff);
1110 				vm_page_unlock_queues();
1111 			}
1112 		} else {
1113 			maxsize = 0;
1114 			ncount = 0;
1115 		}
1116 		if (ncount < count) {
1117 			for (i = ncount; i < count; i++) {
1118 				rtvals[i] = VM_PAGER_BAD;
1119 			}
1120 		}
1121 	}
1122 
1123 	/*
1124 	 * pageouts are already clustered, use IO_ASYNC t o force a bawrite()
1125 	 * rather then a bdwrite() to prevent paging I/O from saturating
1126 	 * the buffer cache.  Dummy-up the sequential heuristic to cause
1127 	 * large ranges to cluster.  If neither IO_SYNC or IO_ASYNC is set,
1128 	 * the system decides how to cluster.
1129 	 */
1130 	ioflags = IO_VMIO;
1131 	if (flags & (VM_PAGER_PUT_SYNC | VM_PAGER_PUT_INVAL))
1132 		ioflags |= IO_SYNC;
1133 	else if ((flags & VM_PAGER_CLUSTER_OK) == 0)
1134 		ioflags |= IO_ASYNC;
1135 	ioflags |= (flags & VM_PAGER_PUT_INVAL) ? IO_INVAL: 0;
1136 	ioflags |= IO_SEQMAX << IO_SEQSHIFT;
1137 
1138 	aiov.iov_base = (caddr_t) 0;
1139 	aiov.iov_len = maxsize;
1140 	auio.uio_iov = &aiov;
1141 	auio.uio_iovcnt = 1;
1142 	auio.uio_offset = poffset;
1143 	auio.uio_segflg = UIO_NOCOPY;
1144 	auio.uio_rw = UIO_WRITE;
1145 	auio.uio_resid = maxsize;
1146 	auio.uio_td = (struct thread *) 0;
1147 	error = VOP_WRITE(vp, &auio, ioflags, curthread->td_ucred);
1148 	PCPU_INC(cnt.v_vnodeout);
1149 	PCPU_ADD(cnt.v_vnodepgsout, ncount);
1150 
1151 	if (error) {
1152 		if ((ppscheck = ppsratecheck(&lastfail, &curfail, 1)))
1153 			printf("vnode_pager_putpages: I/O error %d\n", error);
1154 	}
1155 	if (auio.uio_resid) {
1156 		if (ppscheck || ppsratecheck(&lastfail, &curfail, 1))
1157 			printf("vnode_pager_putpages: residual I/O %d at %lu\n",
1158 			    auio.uio_resid, (u_long)m[0]->pindex);
1159 	}
1160 	for (i = 0; i < ncount; i++) {
1161 		rtvals[i] = VM_PAGER_OK;
1162 	}
1163 	return rtvals[0];
1164 }
1165