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