xref: /freebsd/share/man/man9/VFS_SYNC.9 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
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.Dd May 23, 2009
30.Dt VFS_SYNC 9
31.Os
32.Sh NAME
33.Nm VFS_SYNC
34.Nd flush unwritten data
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/mount.h
38.In sys/vnode.h
39.Ft int
40.Fn VFS_SYNC "struct mount *mp" "int waitfor"
41.Sh DESCRIPTION
42The
43.Fn VFS_SYNC
44macro writes out all unwritten data in the file system mounted as
45.Fa mp .
46.Pp
47The arguments it expects are:
48.Bl -tag -width ".Fa waitfor"
49.It Fa mp
50The file system.
51.It Fa waitfor
52Whether the function should wait for I/O to complete.
53Possible values are:
54.Bl -tag -width MNT_NOWAIT
55.It Dv MNT_WAIT
56synchronously wait for I/O to complete
57.It Dv MNT_NOWAIT
58start all I/O, but do not wait for it
59.It Dv MNT_LAZY
60push data not written by file system syncer
61.El
62.El
63.Pp
64The
65.Fn VFS_SYNC
66macro calls the
67.Va vfs_sync
68method of the file system, which normally calls
69.Xr VOP_FSYNC 9
70for all the vnodes in the file system.
71.Sh SEE ALSO
72.Xr fsync 2 ,
73.Xr sync 2 ,
74.Xr VFS 9 ,
75.Xr vnode 9 ,
76.Xr VOP_FSYNC 9
77.Sh AUTHORS
78This manual page was written by
79.An Doug Rabson .
80