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