db694a9d5b528da69af2a4d51dc683214074fd6d
[dragonfly.git] / share / man / man9 / VOP_FSYNC.9
1 .\" Copyright (c) 1996 Doug Rabson
2 .\"
3 .\" All rights reserved.
4 .\"
5 .\" This program is free software.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man9/VOP_FSYNC.9,v 1.6.2.2 2001/12/17 11:30:18 ru Exp $
28 .\"
29 .Dd October 8, 2014
30 .Dt VOP_FSYNC 9
31 .Os
32 .Sh NAME
33 .Nm VOP_FSYNC
34 .Nd flush filesystem buffers for a file
35 .Sh SYNOPSIS
36 .In sys/param.h
37 .In sys/vnode.h
38 .Ft int
39 .Fn VOP_FSYNC "struct vnode *vp" "int waitfor" "int flags"
40 .Sh DESCRIPTION
41 This call flushes any dirty filesystem buffers for the file.
42 It is used to implement the
43 .Xr sync 2
44 and
45 .Xr fsync 2
46 system calls.
47 .Pp
48 Its arguments are:
49 .Bl -tag -width waitfor
50 .It Ar vp
51 the vnode of the file.
52 .It Ar waitfor
53 whether the function should do data, meta-data updates or be full-synchronous.
54 .It Ar flags
55 are additional flags to be passed to the filesystem specific
56 .Xr fsync 2
57 function.
58 .El
59 .Pp
60 The argument
61 .Fa waitfor
62 can use the following flags:
63 .Bl -tag -width ".Dv MNT_NOWAIT"
64 .It Dv MNT_NOWAIT
65 is for an asychronous data pass and a meta-data pass as well.
66 .It Dv MNT_LAZY
67 means a limited amount of data from dirty buffers and a full meta-data synchronization pass.
68 .It Dv MNT_WAIT
69 will make
70 .Xr syncer 4
71 try to do a full synchronization pass.
72 That is, a meta-data pass and multiple data passes.
73 .El
74 .Pp
75 The argument
76 .Fa flags
77 is to specify additional flags passed to the filesystem specific
78 .Xr fsync 2
79 call.
80 The only supported flag at the moment is
81 .Dv VOP_FSYNC_SYSCALL
82 which indicates the file synchronization was requested from userland.
83 .Sh RETURN VALUES
84 Zero is returned if the call is successful, otherwise an appropriate
85 error code is returned.
86 .Sh ERRORS
87 .Bl -tag -width Er
88 .It Bq Er ENOSPC
89 The filesystem is full.
90 .It Bq Er EDQUOT
91 Quota exceeded.
92 .El
93 .Sh SEE ALSO
94 .Xr syncer 4
95 .Xr vnode 9
96 .Sh AUTHORS
97 This man page was written by
98 .An Doug Rabson .