share/man/man9/vinvalbuf.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd October 20, 2008
  30 .Dt VINVALBUF 9
  31 .Os
  32 .Sh NAME
  33 .Nm vinvalbuf
  34 .Nd "flushes and invalidates all buffers associated with a vnode"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft int
  39 .Fn vinvalbuf "struct vnode *vp" "int flags" "struct ucred *cred" "int slpflag" "int slptimeo"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vinvalbuf
  43 function invalidates all of the buffers associated with the given vnode.
  44 This includes buffers on the clean list and the dirty list.
  45 If the
  46 .Dv V_SAVE
  47 flag is specified then the buffers on the dirty list are synced prior to being
  48 released.
  49 If there is a VM Object associated with the vnode, it is removed.
  50 .Pp
  51 Its arguments are:
  52 .Bl -tag -width ".Fa spltimeo"
  53 .It Fa vp
  54 A pointer to the vnode whose buffers will be invalidated.
  55 .It Fa flags
  56 The only supported flag is
  57 .Dv V_SAVE
  58 and it indicates that dirty buffers should be synced with the disk.
  59 .It Fa cred
  60 The user credentials that are used to
  61 .Xr VOP_FSYNC 9
  62 buffers if
  63 .Dv V_SAVE
  64 is set.
  65 .It Fa slpflag
  66 The slp flag that will be used in the priority of any sleeps in the function.
  67 .It Fa slptimeo
  68 The timeout for any sleeps in the function.
  69 .El
  70 .Sh LOCKS
  71 The vnode is assumed to be locked prior to the call and remains locked upon return.
  72 .Pp
  73 .Va Giant
  74 must be held by prior to the call and remains locked upon return.
  75 .Sh RETURN VALUES
  76 A 0 value is returned on success.
  77 .Sh PSEUDOCODE
  78 .Bd -literal -offset indent
  79 vn_lock(devvp, LK_EXCLUSIVE | LK_RETRY);
  80 error = vinvalbuf(devvp, V_SAVE, cred, 0, 0);
  81 VOP_UNLOCK(devvp, 0);
  82 if (error)
  83         return (error);
  84 .Ed
  85 .Sh ERRORS
  86 .Bl -tag -width Er
  87 .It Bq Er ENOSPC
  88 The file system is full.
  89 (With
  90 .Dv V_SAVE )
  91 .It Bq Er EDQUOT
  92 Disc quota exceeded.
  93 (With
  94 .Dv V_SAVE )
  95 .It Bq Er EWOULDBLOCK
  96 Sleep operation timed out.
  97 (See
  98 .Fa slptimeo )
  99 .It Bq Er ERESTART
 100 A signal needs to be delivered and the system call should be restarted.
 101 (With
 102 .Dv PCATCH
 103 set in
 104 .Fa slpflag )
 105 .It Bq Er EINTR
 106 The system has been interrupted by a signal.
 107 (With
 108 .Dv PCATCH
 109 set in
 110 .Fa slpflag )
 111 .El
 112 .Sh SEE ALSO
 113 .Xr tsleep 9 ,
 114 .Xr VOP_FSYNC 9
 115 .Sh AUTHORS
 116 This manual page was written by
 117 .An Chad David Aq davidc@acns.ab.ca .