share/man/man9/vflush.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 November 21, 2001
  30 .Dt VFLUSH 9
  31 .Os
  32 .Sh NAME
  33 .Nm vflush
  34 .Nd "flush vnodes for a mount point"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft int
  39 .Fn vflush "struct mount *mp" "int rootrefs" "int flags" "struct thread *td"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vflush
  43 function removes any vnodes in the vnode table that belong to the given
  44 .Vt mount
  45 structure.
  46 .Pp
  47 Its arguments are:
  48 .Bl -tag -width ".Fa rootrefs"
  49 .It Fa mp
  50 The mount point whose vnodes should be removed.
  51 .It Fa rootrefs
  52 The number of references expected on the root vnode.
  53 .Xr vrele 9
  54 will be invoked on the root vnode
  55 .Fa rootrefs
  56 times.
  57 .It Fa flags
  58 The flags indicating how vnodes should be handled.
  59 .Bl -tag -width ".Dv WRITECLOSE"
  60 .It Dv FORCECLOSE
  61 If set, busy vnodes will be forcibly closed.
  62 .It Dv SKIPSYSTEM
  63 If set, vnodes with the
  64 .Dv VV_SYSTEM
  65 flag set will be skipped.
  66 .It Dv WRITECLOSE
  67 If set, only regular files currently opened for writing will be removed.
  68 .El
  69 .It Fa td
  70 The calling thread.
  71 .El
  72 .Sh RETURN VALUES
  73 A value of 0 is returned if the flush is successful; otherwise,
  74 .Er EBUSY
  75 will be returned.
  76 .Sh SEE ALSO
  77 .Xr vgone 9 ,
  78 .Xr vrele 9
  79 .Sh AUTHORS
  80 This manual page was written by
  81 .An Chad David Aq davidc@acns.ab.ca .