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 July 24, 1996
  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" "struct ucred *cred" "int waitfor" "struct proc *p"
  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 cred
  53 the caller's credentials
  54 .It Ar waitfor
  55 whether the function should wait for I/O to complete
  56 .It Ar p
  57 the calling process
  58 .El
  59 .Pp
  60 The argument
  61 .Fa waitfor
  62 is either
  63 .Dv MNT_WAIT
  64 or
  65 .Dv MNT_NOWAIT
  66 and specifies whether or not the function should wait for the writes
  67 to finish before returning.
  68 .Sh LOCKS
  69 The file should be locked on entry.
  70 .Sh RETURN VALUES
  71 Zero is returned if the call is successful, otherwise an appropriate
  72 error code is returned.
  73 .Sh ERRORS
  74 .Bl -tag -width Er
  75 .It Bq Er ENOSPC
  76 The filesystem is full.
  77 .It Bq Er EDQUOT
  78 Quota exceeded.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr vnode 9
  82 .Sh AUTHORS
  83 This man page was written by
  84 .An Doug Rabson .