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