xref: /dragonfly/sys/kern/vfs_sync.c (revision 16dd80e4)
1 /*
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
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  *	@(#)vfs_subr.c	8.31 (Berkeley) 5/26/95
35  * $FreeBSD: src/sys/kern/vfs_subr.c,v 1.249.2.30 2003/04/04 20:35:57 tegge Exp $
36  */
37 
38 /*
39  * External virtual filesystem routines
40  */
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/buf.h>
45 #include <sys/conf.h>
46 #include <sys/dirent.h>
47 #include <sys/domain.h>
48 #include <sys/eventhandler.h>
49 #include <sys/fcntl.h>
50 #include <sys/kernel.h>
51 #include <sys/kthread.h>
52 #include <sys/malloc.h>
53 #include <sys/mbuf.h>
54 #include <sys/mount.h>
55 #include <sys/proc.h>
56 #include <sys/namei.h>
57 #include <sys/reboot.h>
58 #include <sys/socket.h>
59 #include <sys/stat.h>
60 #include <sys/sysctl.h>
61 #include <sys/syslog.h>
62 #include <sys/vmmeter.h>
63 #include <sys/vnode.h>
64 
65 #include <machine/limits.h>
66 
67 #include <vm/vm.h>
68 #include <vm/vm_object.h>
69 #include <vm/vm_extern.h>
70 #include <vm/vm_kern.h>
71 #include <vm/pmap.h>
72 #include <vm/vm_map.h>
73 #include <vm/vm_page.h>
74 #include <vm/vm_pager.h>
75 #include <vm/vnode_pager.h>
76 
77 #include <sys/buf2.h>
78 
79 /*
80  * The workitem queue.
81  */
82 #define SYNCER_MAXDELAY		32
83 static int sysctl_kern_syncdelay(SYSCTL_HANDLER_ARGS);
84 time_t syncdelay = 30;		/* max time to delay syncing data */
85 SYSCTL_PROC(_kern, OID_AUTO, syncdelay, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
86 		sysctl_kern_syncdelay, "I", "VFS data synchronization delay");
87 time_t filedelay = 30;		/* time to delay syncing files */
88 SYSCTL_INT(_kern, OID_AUTO, filedelay, CTLFLAG_RW,
89 		&filedelay, 0, "File synchronization delay");
90 time_t dirdelay = 29;		/* time to delay syncing directories */
91 SYSCTL_INT(_kern, OID_AUTO, dirdelay, CTLFLAG_RW,
92 		&dirdelay, 0, "Directory synchronization delay");
93 time_t metadelay = 28;		/* time to delay syncing metadata */
94 SYSCTL_INT(_kern, OID_AUTO, metadelay, CTLFLAG_RW,
95 		&metadelay, 0, "VFS metadata synchronization delay");
96 time_t retrydelay = 1;		/* retry delay after failure */
97 SYSCTL_INT(_kern, OID_AUTO, retrydelay, CTLFLAG_RW,
98 		&retrydelay, 0, "VFS retry synchronization delay");
99 static int rushjob;			/* number of slots to run ASAP */
100 static int stat_rush_requests;	/* number of times I/O speeded up */
101 SYSCTL_INT(_debug, OID_AUTO, rush_requests, CTLFLAG_RW,
102 		&stat_rush_requests, 0, "");
103 
104 LIST_HEAD(synclist, vnode);
105 
106 #define	SC_FLAG_EXIT		(0x1)		/* request syncer exit */
107 #define	SC_FLAG_DONE		(0x2)		/* syncer confirm exit */
108 
109 struct syncer_ctx {
110 	struct mount		*sc_mp;
111 	struct lwkt_token 	sc_token;
112 	struct thread		*sc_thread;
113 	int			sc_flags;
114 	struct synclist 	*syncer_workitem_pending;
115 	long			syncer_mask;
116 	int 			syncer_delayno;
117 	int			syncer_forced;
118 	int			syncer_rushjob;	/* sequence vnodes faster */
119 	int			syncer_trigger;	/* trigger full sync */
120 	long			syncer_count;
121 };
122 
123 static void syncer_thread(void *);
124 
125 static int
126 sysctl_kern_syncdelay(SYSCTL_HANDLER_ARGS)
127 {
128 	int error;
129 	int v = syncdelay;
130 
131 	error = sysctl_handle_int(oidp, &v, 0, req);
132 	if (error || !req->newptr)
133 		return (error);
134 	if (v < 1)
135 		v = 1;
136 	if (v > SYNCER_MAXDELAY)
137 		v = SYNCER_MAXDELAY;
138 	syncdelay = v;
139 
140 	return(0);
141 }
142 
143 /*
144  * The workitem queue.
145  *
146  * It is useful to delay writes of file data and filesystem metadata
147  * for tens of seconds so that quickly created and deleted files need
148  * not waste disk bandwidth being created and removed. To realize this,
149  * we append vnodes to a "workitem" queue. When running with a soft
150  * updates implementation, most pending metadata dependencies should
151  * not wait for more than a few seconds. Thus, mounted on block devices
152  * are delayed only about a half the time that file data is delayed.
153  * Similarly, directory updates are more critical, so are only delayed
154  * about a third the time that file data is delayed. Thus, there are
155  * SYNCER_MAXDELAY queues that are processed round-robin at a rate of
156  * one each second (driven off the filesystem syncer process). The
157  * syncer_delayno variable indicates the next queue that is to be processed.
158  * Items that need to be processed soon are placed in this queue:
159  *
160  *	syncer_workitem_pending[syncer_delayno]
161  *
162  * A delay of fifteen seconds is done by placing the request fifteen
163  * entries later in the queue:
164  *
165  *	syncer_workitem_pending[(syncer_delayno + 15) & syncer_mask]
166  *
167  */
168 
169 /*
170  * Return the number of vnodes on the syncer's timed list.  This will
171  * include the syncer vnode (mp->mnt_syncer) so if used, a minimum
172  * value of 1 will be returned.
173  */
174 long
175 vn_syncer_count(struct mount *mp)
176 {
177 	struct syncer_ctx *ctx;
178 
179 	ctx = mp->mnt_syncer_ctx;
180 	if (ctx)
181 		return (ctx->syncer_count);
182 	return 0;
183 }
184 
185 /*
186  * Add an item to the syncer work queue.
187  *
188  * WARNING: Cannot get vp->v_token here if not already held, we must
189  *	    depend on the syncer_token (which might already be held by
190  *	    the caller) to protect v_synclist and VONWORKLST.
191  *
192  * WARNING: The syncer depends on this function not blocking if the caller
193  *	    already holds the syncer token.
194  */
195 void
196 vn_syncer_add(struct vnode *vp, int delay)
197 {
198 	struct syncer_ctx *ctx;
199 	int slot;
200 
201 	ctx = vp->v_mount->mnt_syncer_ctx;
202 	lwkt_gettoken(&ctx->sc_token);
203 
204 	if (vp->v_flag & VONWORKLST) {
205 		LIST_REMOVE(vp, v_synclist);
206 		--ctx->syncer_count;
207 	}
208 	if (delay <= 0) {
209 		slot = -delay & ctx->syncer_mask;
210 	} else {
211 		if (delay > SYNCER_MAXDELAY - 2)
212 			delay = SYNCER_MAXDELAY - 2;
213 		slot = (ctx->syncer_delayno + delay) & ctx->syncer_mask;
214 	}
215 
216 	LIST_INSERT_HEAD(&ctx->syncer_workitem_pending[slot], vp, v_synclist);
217 	vsetflags(vp, VONWORKLST);
218 	++ctx->syncer_count;
219 
220 	lwkt_reltoken(&ctx->sc_token);
221 }
222 
223 /*
224  * Removes the vnode from the syncer list.  Since we might block while
225  * acquiring the syncer_token we have to [re]check conditions to determine
226  * that it is ok to remove the vnode.
227  *
228  * Force removal if force != 0.  This can only occur during a forced unmount.
229  *
230  * vp->v_token held on call
231  */
232 void
233 vn_syncer_remove(struct vnode *vp, int force)
234 {
235 	struct syncer_ctx *ctx;
236 
237 	ctx = vp->v_mount->mnt_syncer_ctx;
238 	lwkt_gettoken(&ctx->sc_token);
239 
240 	if ((vp->v_flag & (VISDIRTY | VONWORKLST | VOBJDIRTY)) == VONWORKLST &&
241 	    RB_EMPTY(&vp->v_rbdirty_tree)) {
242 		vclrflags(vp, VONWORKLST);
243 		LIST_REMOVE(vp, v_synclist);
244 		--ctx->syncer_count;
245 	} else if (force && (vp->v_flag & VONWORKLST)) {
246 		vclrflags(vp, VONWORKLST);
247 		LIST_REMOVE(vp, v_synclist);
248 		--ctx->syncer_count;
249 	}
250 
251 	lwkt_reltoken(&ctx->sc_token);
252 }
253 
254 /*
255  * vnode must be locked
256  */
257 void
258 vclrisdirty(struct vnode *vp)
259 {
260 	vclrflags(vp, VISDIRTY);
261 	if (vp->v_flag & VONWORKLST)
262 		vn_syncer_remove(vp, 0);
263 }
264 
265 void
266 vclrobjdirty(struct vnode *vp)
267 {
268 	vclrflags(vp, VOBJDIRTY);
269 	if (vp->v_flag & VONWORKLST)
270 		vn_syncer_remove(vp, 0);
271 }
272 
273 /*
274  * vnode must be stable
275  */
276 void
277 vsetisdirty(struct vnode *vp)
278 {
279 	struct syncer_ctx *ctx;
280 
281 	if ((vp->v_flag & VISDIRTY) == 0) {
282 		ctx = vp->v_mount->mnt_syncer_ctx;
283 		vsetflags(vp, VISDIRTY);
284 		lwkt_gettoken(&ctx->sc_token);
285 		if ((vp->v_flag & VONWORKLST) == 0)
286 			vn_syncer_add(vp, syncdelay);
287 		lwkt_reltoken(&ctx->sc_token);
288 	}
289 }
290 
291 void
292 vsetobjdirty(struct vnode *vp)
293 {
294 	struct syncer_ctx *ctx;
295 
296 	if ((vp->v_flag & VOBJDIRTY) == 0) {
297 		ctx = vp->v_mount->mnt_syncer_ctx;
298 		vsetflags(vp, VOBJDIRTY);
299 		lwkt_gettoken(&ctx->sc_token);
300 		if ((vp->v_flag & VONWORKLST) == 0)
301 			vn_syncer_add(vp, syncdelay);
302 		lwkt_reltoken(&ctx->sc_token);
303 	}
304 }
305 
306 /*
307  * Create per-filesystem syncer process
308  */
309 void
310 vn_syncer_thr_create(struct mount *mp)
311 {
312 	struct syncer_ctx *ctx;
313 	static int syncalloc = 0;
314 
315 	ctx = kmalloc(sizeof(struct syncer_ctx), M_TEMP, M_WAITOK | M_ZERO);
316 	ctx->sc_mp = mp;
317 	ctx->sc_flags = 0;
318 	ctx->syncer_workitem_pending = hashinit(SYNCER_MAXDELAY, M_DEVBUF,
319 						&ctx->syncer_mask);
320 	ctx->syncer_delayno = 0;
321 	lwkt_token_init(&ctx->sc_token, "syncer");
322 	mp->mnt_syncer_ctx = ctx;
323 	kthread_create(syncer_thread, ctx, &ctx->sc_thread,
324 		       "syncer%d", ++syncalloc & 0x7FFFFFFF);
325 }
326 
327 /*
328  * Stop per-filesystem syncer process
329  */
330 void
331 vn_syncer_thr_stop(struct mount *mp)
332 {
333 	struct syncer_ctx *ctx;
334 
335 	ctx = mp->mnt_syncer_ctx;
336 	if (ctx == NULL)
337 		return;
338 
339 	lwkt_gettoken(&ctx->sc_token);
340 
341 	/* Signal the syncer process to exit */
342 	ctx->sc_flags |= SC_FLAG_EXIT;
343 	wakeup(ctx);
344 
345 	/* Wait till syncer process exits */
346 	while ((ctx->sc_flags & SC_FLAG_DONE) == 0)
347 		tsleep(&ctx->sc_flags, 0, "syncexit", hz);
348 
349 	mp->mnt_syncer_ctx = NULL;
350 	lwkt_reltoken(&ctx->sc_token);
351 
352 	hashdestroy(ctx->syncer_workitem_pending, M_DEVBUF, ctx->syncer_mask);
353 	kfree(ctx, M_TEMP);
354 }
355 
356 struct  thread *updatethread;
357 
358 /*
359  * System filesystem synchronizer daemon.
360  */
361 static void
362 syncer_thread(void *_ctx)
363 {
364 	struct syncer_ctx *ctx = _ctx;
365 	struct synclist *slp;
366 	struct vnode *vp;
367 	long starttime;
368 	int *sc_flagsp;
369 	int sc_flags;
370 	int vnodes_synced = 0;
371 	int delta;
372 	int dummy = 0;
373 
374 	for (;;) {
375 		kproc_suspend_loop();
376 
377 		starttime = time_uptime;
378 		lwkt_gettoken(&ctx->sc_token);
379 
380 		/*
381 		 * Push files whose dirty time has expired.  Be careful
382 		 * of interrupt race on slp queue.
383 		 *
384 		 * Note that vsyncscan() and vn_syncer_one() can pull items
385 		 * off the same list, so we shift vp's position in the
386 		 * list immediately.
387 		 */
388 		slp = &ctx->syncer_workitem_pending[ctx->syncer_delayno];
389 
390 		/*
391 		 * If syncer_trigger is set (from trigger_syncer(mp)),
392 		 * Immediately do a full filesystem sync.
393 		 */
394 		if (ctx->syncer_trigger) {
395 			ctx->syncer_trigger = 0;
396 			if (ctx->sc_mp && ctx->sc_mp->mnt_syncer) {
397 				vp = ctx->sc_mp->mnt_syncer;
398 				if (vp->v_flag & VONWORKLST) {
399 					vn_syncer_add(vp, retrydelay);
400 					if (vget(vp, LK_EXCLUSIVE) == 0) {
401 						VOP_FSYNC(vp, MNT_LAZY, 0);
402 						vput(vp);
403 						vnodes_synced++;
404 					}
405 				}
406 			}
407 		}
408 
409 		while ((vp = LIST_FIRST(slp)) != NULL) {
410 			vn_syncer_add(vp, retrydelay);
411 			if (ctx->syncer_forced) {
412 				if (vget(vp, LK_EXCLUSIVE) == 0) {
413 					VOP_FSYNC(vp, MNT_NOWAIT, 0);
414 					vput(vp);
415 					vnodes_synced++;
416 				}
417 			} else {
418 				if (vget(vp, LK_EXCLUSIVE | LK_NOWAIT) == 0) {
419 					VOP_FSYNC(vp, MNT_LAZY, 0);
420 					vput(vp);
421 					vnodes_synced++;
422 				}
423 			}
424 		}
425 
426 		/*
427 		 * Increment the slot upon completion.
428 		 */
429 		ctx->syncer_delayno = (ctx->syncer_delayno + 1) &
430 				      ctx->syncer_mask;
431 
432 		sc_flags = ctx->sc_flags;
433 
434 		/* Exit on unmount */
435 		if (sc_flags & SC_FLAG_EXIT)
436 			break;
437 
438 		lwkt_reltoken(&ctx->sc_token);
439 
440 		/*
441 		 * Do sync processing for each mount.
442 		 */
443 		if (ctx->sc_mp)
444 			bio_ops_sync(ctx->sc_mp);
445 
446 		/*
447 		 * The variable rushjob allows the kernel to speed up the
448 		 * processing of the filesystem syncer process. A rushjob
449 		 * value of N tells the filesystem syncer to process the next
450 		 * N seconds worth of work on its queue ASAP. Currently rushjob
451 		 * is used by the soft update code to speed up the filesystem
452 		 * syncer process when the incore state is getting so far
453 		 * ahead of the disk that the kernel memory pool is being
454 		 * threatened with exhaustion.
455 		 */
456 		delta = rushjob - ctx->syncer_rushjob;
457 		if ((u_int)delta > syncdelay / 2) {
458 			ctx->syncer_rushjob = rushjob - syncdelay / 2;
459 			tsleep(&dummy, 0, "rush", 1);
460 			continue;
461 		}
462 		if (delta) {
463 			++ctx->syncer_rushjob;
464 			tsleep(&dummy, 0, "rush", 1);
465 			continue;
466 		}
467 
468 		/*
469 		 * If it has taken us less than a second to process the
470 		 * current work, then wait. Otherwise start right over
471 		 * again. We can still lose time if any single round
472 		 * takes more than two seconds, but it does not really
473 		 * matter as we are just trying to generally pace the
474 		 * filesystem activity.
475 		 */
476 		if (time_uptime == starttime)
477 			tsleep(ctx, 0, "syncer", hz);
478 	}
479 
480 	/*
481 	 * Unmount/exit path for per-filesystem syncers; sc_token held
482 	 */
483 	ctx->sc_flags |= SC_FLAG_DONE;
484 	sc_flagsp = &ctx->sc_flags;
485 	lwkt_reltoken(&ctx->sc_token);
486 	wakeup(sc_flagsp);
487 
488 	kthread_exit();
489 }
490 
491 /*
492  * This allows a filesystem to pro-actively request that a dirty
493  * vnode be fsync()d.  This routine does not guarantee that one
494  * will actually be fsynced.
495  */
496 void
497 vn_syncer_one(struct mount *mp)
498 {
499 	struct syncer_ctx *ctx;
500 	struct synclist *slp;
501 	struct vnode *vp;
502 	int i;
503 	int n = syncdelay;
504 
505 	ctx = mp->mnt_syncer_ctx;
506 	i = ctx->syncer_delayno & ctx->syncer_mask;
507 	cpu_ccfence();
508 
509 	if (lwkt_trytoken(&ctx->sc_token) == 0)
510 		return;
511 
512 	/*
513 	 * Look ahead on our syncer time array.
514 	 */
515 	do {
516 		slp = &ctx->syncer_workitem_pending[i];
517 		vp = LIST_FIRST(slp);
518 		if (vp && vp->v_type == VNON)
519 			vp = LIST_NEXT(vp, v_synclist);
520 		if (vp)
521 			break;
522 		i = (i + 1) & ctx->syncer_mask;
523 		/* i will be wrong if we stop here but vp is NULL so ok */
524 	} while(--n);
525 
526 	/*
527 	 * Process one vnode, skip the syncer vnode but also stop
528 	 * if the syncer vnode is the only thing on this list.
529 	 */
530 	if (vp) {
531 		vn_syncer_add(vp, retrydelay);
532 		if (vget(vp, LK_EXCLUSIVE | LK_NOWAIT) == 0) {
533 			VOP_FSYNC(vp, MNT_LAZY, 0);
534 			vput(vp);
535 		}
536 	}
537 	lwkt_reltoken(&ctx->sc_token);
538 }
539 
540 /*
541  * Request that the syncer daemon for a specific mount speed up its work.
542  * If mp is NULL the caller generally wants to speed up all syncers.
543  */
544 void
545 speedup_syncer(struct mount *mp)
546 {
547 	/*
548 	 * Don't bother protecting the test.  unsleep_and_wakeup_thread()
549 	 * will only do something real if the thread is in the right state.
550 	 */
551 	atomic_add_int(&rushjob, 1);
552 	++stat_rush_requests;
553 	if (mp && mp->mnt_syncer_ctx)
554 		wakeup(mp->mnt_syncer_ctx);
555 }
556 
557 /*
558  * trigger a full sync
559  */
560 void
561 trigger_syncer(struct mount *mp)
562 {
563 	struct syncer_ctx *ctx;
564 
565 	if (mp && (ctx = mp->mnt_syncer_ctx) != NULL) {
566 		if (ctx->syncer_trigger == 0) {
567 			ctx->syncer_trigger = 1;
568 			wakeup(ctx);
569 		}
570 	}
571 }
572 
573 /*
574  * Routine to create and manage a filesystem syncer vnode.
575  */
576 static int sync_close(struct vop_close_args *);
577 static int sync_fsync(struct vop_fsync_args *);
578 static int sync_inactive(struct vop_inactive_args *);
579 static int sync_reclaim (struct vop_reclaim_args *);
580 static int sync_print(struct vop_print_args *);
581 
582 static struct vop_ops sync_vnode_vops = {
583 	.vop_default =	vop_eopnotsupp,
584 	.vop_close =	sync_close,
585 	.vop_fsync =	sync_fsync,
586 	.vop_inactive =	sync_inactive,
587 	.vop_reclaim =	sync_reclaim,
588 	.vop_print =	sync_print,
589 };
590 
591 static struct vop_ops *sync_vnode_vops_p = &sync_vnode_vops;
592 
593 VNODEOP_SET(sync_vnode_vops);
594 
595 /*
596  * Create a new filesystem syncer vnode for the specified mount point.
597  * This vnode is placed on the worklist and is responsible for sync'ing
598  * the filesystem.
599  *
600  * NOTE: read-only mounts are also placed on the worklist.  The filesystem
601  * sync code is also responsible for cleaning up vnodes.
602  */
603 int
604 vfs_allocate_syncvnode(struct mount *mp)
605 {
606 	struct vnode *vp;
607 	static long start, incr, next;
608 	int error;
609 
610 	/* Allocate a new vnode */
611 	error = getspecialvnode(VT_VFS, mp, &sync_vnode_vops_p, &vp, 0, 0);
612 	if (error) {
613 		mp->mnt_syncer = NULL;
614 		return (error);
615 	}
616 	vp->v_type = VNON;
617 	/*
618 	 * Place the vnode onto the syncer worklist. We attempt to
619 	 * scatter them about on the list so that they will go off
620 	 * at evenly distributed times even if all the filesystems
621 	 * are mounted at once.
622 	 */
623 	next += incr;
624 	if (next == 0 || next > SYNCER_MAXDELAY) {
625 		start /= 2;
626 		incr /= 2;
627 		if (start == 0) {
628 			start = SYNCER_MAXDELAY / 2;
629 			incr = SYNCER_MAXDELAY;
630 		}
631 		next = start;
632 	}
633 
634 	/*
635 	 * Only put the syncer vnode onto the syncer list if we have a
636 	 * syncer thread.  Some VFS's (aka NULLFS) don't need a syncer
637 	 * thread.
638 	 */
639 	if (mp->mnt_syncer_ctx)
640 		vn_syncer_add(vp, syncdelay > 0 ? next % syncdelay : 0);
641 
642 	/*
643 	 * The mnt_syncer field inherits the vnode reference, which is
644 	 * held until later decomissioning.
645 	 */
646 	mp->mnt_syncer = vp;
647 	vx_unlock(vp);
648 	return (0);
649 }
650 
651 static int
652 sync_close(struct vop_close_args *ap)
653 {
654 	return (0);
655 }
656 
657 /*
658  * Do a lazy sync of the filesystem.
659  *
660  * sync_fsync { struct vnode *a_vp, int a_waitfor }
661  */
662 static int
663 sync_fsync(struct vop_fsync_args *ap)
664 {
665 	struct vnode *syncvp = ap->a_vp;
666 	struct mount *mp = syncvp->v_mount;
667 	int asyncflag;
668 
669 	/*
670 	 * We only need to do something if this is a lazy evaluation.
671 	 */
672 	if ((ap->a_waitfor & MNT_LAZY) == 0)
673 		return (0);
674 
675 	/*
676 	 * Move ourselves to the back of the sync list.
677 	 */
678 	vn_syncer_add(syncvp, syncdelay);
679 
680 	/*
681 	 * Walk the list of vnodes pushing all that are dirty and
682 	 * not already on the sync list, and freeing vnodes which have
683 	 * no refs and whos VM objects are empty.  vfs_msync() handles
684 	 * the VM issues and must be called whether the mount is readonly
685 	 * or not.
686 	 */
687 	if (vfs_busy(mp, LK_NOWAIT) != 0)
688 		return (0);
689 	if (mp->mnt_flag & MNT_RDONLY) {
690 		vfs_msync(mp, MNT_NOWAIT);
691 	} else {
692 		asyncflag = mp->mnt_flag & MNT_ASYNC;
693 		mp->mnt_flag &= ~MNT_ASYNC;	/* ZZZ hack */
694 		vfs_msync(mp, MNT_NOWAIT);
695 		VFS_SYNC(mp, MNT_NOWAIT | MNT_LAZY);
696 		if (asyncflag)
697 			mp->mnt_flag |= MNT_ASYNC;
698 	}
699 	vfs_unbusy(mp);
700 	return (0);
701 }
702 
703 /*
704  * The syncer vnode is no longer referenced.
705  *
706  * sync_inactive { struct vnode *a_vp, struct proc *a_p }
707  */
708 static int
709 sync_inactive(struct vop_inactive_args *ap)
710 {
711 	vgone_vxlocked(ap->a_vp);
712 	return (0);
713 }
714 
715 /*
716  * The syncer vnode is no longer needed and is being decommissioned.
717  * This can only occur when the last reference has been released on
718  * mp->mnt_syncer, so mp->mnt_syncer had better be NULL.
719  *
720  * Modifications to the worklist must be protected with a critical
721  * section.
722  *
723  *	sync_reclaim { struct vnode *a_vp }
724  */
725 static int
726 sync_reclaim(struct vop_reclaim_args *ap)
727 {
728 	struct vnode *vp = ap->a_vp;
729 	struct syncer_ctx *ctx;
730 
731 	ctx = vp->v_mount->mnt_syncer_ctx;
732 	if (ctx) {
733 		lwkt_gettoken(&ctx->sc_token);
734 		KKASSERT(vp->v_mount->mnt_syncer != vp);
735 		if (vp->v_flag & VONWORKLST) {
736 			LIST_REMOVE(vp, v_synclist);
737 			vclrflags(vp, VONWORKLST);
738 			--ctx->syncer_count;
739 		}
740 		lwkt_reltoken(&ctx->sc_token);
741 	} else {
742 		KKASSERT((vp->v_flag & VONWORKLST) == 0);
743 	}
744 
745 	return (0);
746 }
747 
748 /*
749  * This is very similar to vmntvnodescan() but it only scans the
750  * vnodes on the syncer list.  VFS's which support faster VFS_SYNC
751  * operations use the VISDIRTY flag on the vnode to ensure that vnodes
752  * with dirty inodes are added to the syncer in addition to vnodes
753  * with dirty buffers, and can use this function instead of nmntvnodescan().
754  *
755  * This scan does not issue VOP_FSYNC()s.  The supplied callback is intended
756  * to synchronize the file in the manner intended by the VFS using it.
757  *
758  * This is important when a system has millions of vnodes.
759  */
760 int
761 vsyncscan(
762     struct mount *mp,
763     int vmsc_flags,
764     int (*slowfunc)(struct mount *mp, struct vnode *vp, void *data),
765     void *data
766 ) {
767 	struct syncer_ctx *ctx;
768 	struct synclist *slp;
769 	struct vnode *vp;
770 	int i;
771 	int count;
772 	int lkflags;
773 
774 	if (vmsc_flags & VMSC_NOWAIT)
775 		lkflags = LK_NOWAIT;
776 	else
777 		lkflags = 0;
778 
779 	/*
780 	 * Syncer list context.  This API requires a dedicated syncer thread.
781 	 * (MNTK_THR_SYNC).
782 	 */
783 	KKASSERT(mp->mnt_kern_flag & MNTK_THR_SYNC);
784 	ctx = mp->mnt_syncer_ctx;
785 	lwkt_gettoken(&ctx->sc_token);
786 
787 	/*
788 	 * Setup for loop.  Allow races against the syncer thread but
789 	 * require that the syncer thread no be lazy if we were told
790 	 * not to be lazy.
791 	 */
792 	i = ctx->syncer_delayno & ctx->syncer_mask;
793 	if ((vmsc_flags & VMSC_NOWAIT) == 0)
794 		++ctx->syncer_forced;
795 	for (count = 0; count <= ctx->syncer_mask; ++count) {
796 		slp = &ctx->syncer_workitem_pending[i];
797 
798 		while ((vp = LIST_FIRST(slp)) != NULL) {
799 			KKASSERT(vp->v_mount == mp);
800 			if (vmsc_flags & VMSC_GETVP) {
801 				if (vget(vp, LK_EXCLUSIVE | lkflags) == 0) {
802 					slowfunc(mp, vp, data);
803 					vput(vp);
804 				}
805 			} else if (vmsc_flags & VMSC_GETVX) {
806 				vx_get(vp);
807 				slowfunc(mp, vp, data);
808 				vx_put(vp);
809 			} else {
810 				vhold(vp);
811 				slowfunc(mp, vp, data);
812 				vdrop(vp);
813 			}
814 
815 			/*
816 			 * vp could be invalid.  However, if vp is still at
817 			 * the head of the list it is clearly valid and we
818 			 * can safely move it.
819 			 */
820 			if (LIST_FIRST(slp) == vp)
821 				vn_syncer_add(vp, -(i + syncdelay));
822 		}
823 		i = (i + 1) & ctx->syncer_mask;
824 	}
825 
826 	if ((vmsc_flags & VMSC_NOWAIT) == 0)
827 		--ctx->syncer_forced;
828 	lwkt_reltoken(&ctx->sc_token);
829 	return(0);
830 }
831 
832 /*
833  * Print out a syncer vnode.
834  *
835  *	sync_print { struct vnode *a_vp }
836  */
837 static int
838 sync_print(struct vop_print_args *ap)
839 {
840 	struct vnode *vp = ap->a_vp;
841 
842 	kprintf("syncer vnode");
843 	lockmgr_printinfo(&vp->v_lock);
844 	kprintf("\n");
845 	return (0);
846 }
847 
848