xref: /freebsd/share/man/man9/VFS_SYNC.9 (revision b601c69bdbe8755d26570261d7fd4c02ee4eff74)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd July 24, 1996
32.Os
33.Dt VFS_SYNC 9
34.Sh NAME
35.Nm VFS_SYNC
36.Nd flush unwritten data
37.Sh SYNOPSIS
38.Fd #include <sys/param.h>
39.Fd #include <sys/mount.h>
40.Fd #include <sys/vnode.h>
41.Ft int
42.Fn VFS_SYNC "struct mount *mp" "int waitfor" "struct ucred *cred" "struct proc *p"
43.Sh DESCRIPTION
44This writes out all unwritten data in a filesystem.
45.Pp
46Its arguments are:
47.Bl -tag -width waitfor
48.It Ar mp
49The filesystem.
50.It Ar waitfor
51Whether the function should wait for I/O to complete.
52Possible values are:
53.Bl -tag -width MNT_NOWAIT
54.It Dv MNT_WAIT
55synchronously wait for I/O to complete
56.It Dv MNT_NOWAIT
57start all I/O, but do not wait for it
58.It Dv MNT_LAZY
59push data not written by filesystem syncer
60.El
61.It Ar cred
62The caller's credentials.
63.It Ar p
64The calling process.
65.El
66.Pp
67This would normally call
68.Xr VOP_FSYNC 9
69for all the vnodes in the filesystem.
70.Sh SEE ALSO
71.Xr fsync 2 ,
72.Xr sync 2 ,
73.Xr VFS 9 ,
74.Xr vnode 9 ,
75.Xr VOP_FSYNC 9
76.Sh AUTHORS
77This man page was written by
78.An Doug Rabson .
79