xref: /freebsd/share/man/man9/vflush.9 (revision 8a7314fcb5347f8296a072e0c4f67a9f64303186)
121642577SAlfred Perlstein.\"
221642577SAlfred Perlstein.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
321642577SAlfred Perlstein.\"
421642577SAlfred Perlstein.\" Redistribution and use in source and binary forms, with or without
521642577SAlfred Perlstein.\" modification, are permitted provided that the following conditions
621642577SAlfred Perlstein.\" are met:
721642577SAlfred Perlstein.\" 1. Redistributions of source code must retain the above copyright
821642577SAlfred Perlstein.\"    notice(s), this list of conditions and the following disclaimer as
921642577SAlfred Perlstein.\"    the first lines of this file unmodified other than the possible
1021642577SAlfred Perlstein.\"    addition of one or more copyright notices.
1121642577SAlfred Perlstein.\" 2. Redistributions in binary form must reproduce the above copyright
1221642577SAlfred Perlstein.\"    notice(s), this list of conditions and the following disclaimer in the
1321642577SAlfred Perlstein.\"    documentation and/or other materials provided with the distribution.
1421642577SAlfred Perlstein.\"
1521642577SAlfred Perlstein.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
1621642577SAlfred Perlstein.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1721642577SAlfred Perlstein.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1821642577SAlfred Perlstein.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
1921642577SAlfred Perlstein.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2021642577SAlfred Perlstein.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2121642577SAlfred Perlstein.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
2221642577SAlfred Perlstein.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2321642577SAlfred Perlstein.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2421642577SAlfred Perlstein.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
2521642577SAlfred Perlstein.\" DAMAGE.
2621642577SAlfred Perlstein.\"
2721642577SAlfred Perlstein.\" $FreeBSD$
2821642577SAlfred Perlstein.\"
2921642577SAlfred Perlstein.Dd November 21, 2001
3021642577SAlfred Perlstein.Dt VFLUSH 9
3121642577SAlfred Perlstein.Os
3221642577SAlfred Perlstein.Sh NAME
3321642577SAlfred Perlstein.Nm vflush
3421642577SAlfred Perlstein.Nd "flush vnodes for a mount point"
3521642577SAlfred Perlstein.Sh SYNOPSIS
3621642577SAlfred Perlstein.In sys/param.h
371f620c2eSRuslan Ermilov.In sys/vnode.h
3821642577SAlfred Perlstein.Ft int
392e168c9bSAlfred Perlstein.Fn vflush "struct mount *mp" "int rootrefs" "int flags" "struct thread *td"
4021642577SAlfred Perlstein.Sh DESCRIPTION
4121642577SAlfred PerlsteinThe
4221642577SAlfred Perlstein.Fn vflush
431f620c2eSRuslan Ermilovfunction removes any vnodes in the vnode table that belong to the given
441f620c2eSRuslan Ermilov.Vt mount
4521642577SAlfred Perlsteinstructure.
4621642577SAlfred Perlstein.Pp
4721642577SAlfred PerlsteinIts arguments are:
4821642577SAlfred Perlstein.Bl -tag -width ".Fa rootrefs"
4921642577SAlfred Perlstein.It Fa mp
5021642577SAlfred PerlsteinThe mount point whose vnodes should be removed.
5121642577SAlfred Perlstein.It Fa rootrefs
5221642577SAlfred PerlsteinThe number of references expected on the root vnode.
531f620c2eSRuslan Ermilov.Xr vrele 9
5421642577SAlfred Perlsteinwill be invoked on the root vnode
5521642577SAlfred Perlstein.Fa rootrefs
5621642577SAlfred Perlsteintimes.
5721642577SAlfred Perlstein.It Fa flags
5821642577SAlfred PerlsteinThe flags indicating how vnodes should be handled.
5921642577SAlfred Perlstein.Bl -tag -width ".Dv WRITECLOSE"
6021642577SAlfred Perlstein.It Dv FORCECLOSE
611f620c2eSRuslan ErmilovIf set, busy vnodes will be forcibly closed.
6221642577SAlfred Perlstein.It Dv SKIPSYSTEM
631f620c2eSRuslan ErmilovIf set, vnodes with the
64ce916253SMaxim Konovalov.Dv VV_SYSTEM
651f620c2eSRuslan Ermilovflag set will be skipped.
6621642577SAlfred Perlstein.It Dv WRITECLOSE
671f620c2eSRuslan ErmilovIf set, only regular files currently opened for writing will be removed.
6821642577SAlfred Perlstein.El
692e168c9bSAlfred Perlstein.It Fa td
70c0854fb7SRuslan ErmilovThe calling thread.
7121642577SAlfred Perlstein.El
7221642577SAlfred Perlstein.Sh RETURN VALUES
7321642577SAlfred PerlsteinA value of 0 is returned if the flush is successful; otherwise,
741f620c2eSRuslan Ermilov.Er EBUSY
7521642577SAlfred Perlsteinwill be returned.
7621642577SAlfred Perlstein.Sh SEE ALSO
7721642577SAlfred Perlstein.Xr vgone 9 ,
781f620c2eSRuslan Ermilov.Xr vrele 9
7921642577SAlfred Perlstein.Sh AUTHORS
80571dba6eSHiten PandyaThis manual page was written by
81*8a7314fcSBaptiste Daroussin.An Chad David Aq Mt davidc@acns.ab.ca .
82