2001-12-02 02:13:35 +00:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer as
|
|
|
|
|
.\" the first lines of this file unmodified other than the possible
|
|
|
|
|
.\" addition of one or more copyright notices.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
|
|
|
|
|
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
|
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
|
.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
|
|
|
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
|
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
|
|
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
|
|
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
|
|
|
|
.\" DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd November 21, 2001
|
|
|
|
|
.Dt VFLUSH 9
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm vflush
|
|
|
|
|
.Nd "flush vnodes for a mount point"
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In sys/param.h
|
2001-12-14 09:11:13 +00:00
|
|
|
.In sys/vnode.h
|
2001-12-02 02:13:35 +00:00
|
|
|
.Ft int
|
|
|
|
|
.Fn vflush "struct mount *mp" "int rootrefs" "int flags"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn vflush
|
2001-12-14 09:11:13 +00:00
|
|
|
function removes any vnodes in the vnode table that belong to the given
|
|
|
|
|
.Vt mount
|
2001-12-02 02:13:35 +00:00
|
|
|
structure.
|
|
|
|
|
.Pp
|
|
|
|
|
Its arguments are:
|
|
|
|
|
.Bl -tag -width ".Fa rootrefs"
|
|
|
|
|
.It Fa mp
|
|
|
|
|
The mount point whose vnodes should be removed.
|
|
|
|
|
.It Fa rootrefs
|
|
|
|
|
The number of references expected on the root vnode.
|
2001-12-14 09:11:13 +00:00
|
|
|
.Xr vrele 9
|
2001-12-02 02:13:35 +00:00
|
|
|
will be invoked on the root vnode
|
|
|
|
|
.Fa rootrefs
|
|
|
|
|
times.
|
|
|
|
|
.It Fa flags
|
|
|
|
|
The flags indicating how vnodes should be handled.
|
|
|
|
|
.Bl -tag -width ".Dv WRITECLOSE"
|
|
|
|
|
.It Dv FORCECLOSE
|
2001-12-14 09:11:13 +00:00
|
|
|
If set, busy vnodes will be forcibly closed.
|
2001-12-02 02:13:35 +00:00
|
|
|
.It Dv SKIPSYSTEM
|
2001-12-14 09:11:13 +00:00
|
|
|
If set, vnodes with the
|
|
|
|
|
.Dv VSYSTEM
|
|
|
|
|
flag set will be skipped.
|
2001-12-02 02:13:35 +00:00
|
|
|
.It Dv WRITECLOSE
|
2001-12-14 09:11:13 +00:00
|
|
|
If set, only regular files currently opened for writing will be removed.
|
2001-12-02 02:13:35 +00:00
|
|
|
.El
|
|
|
|
|
.El
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
A value of 0 is returned if the flush is successful; otherwise,
|
2001-12-14 09:11:13 +00:00
|
|
|
.Er EBUSY
|
2001-12-02 02:13:35 +00:00
|
|
|
will be returned.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr vgone 9 ,
|
2001-12-14 09:11:13 +00:00
|
|
|
.Xr vgonel 9 ,
|
|
|
|
|
.Xr vrele 9
|
2001-12-02 02:13:35 +00:00
|
|
|
.Sh AUTHORS
|
|
|
|
|
This man page was written by
|
|
|
|
|
.An Chad David Aq davidc@acns.ab.ca .
|
