xref: /openbsd/share/man/man9/vflush.9 (revision 55cc5ba3)
1.\"     $OpenBSD: vflush.9,v 1.7 2020/11/14 10:35:58 jmc Exp $
2.\"
3.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice(s), this list of conditions and the following disclaimer as
10.\"    the first lines of this file unmodified other than the possible
11.\"    addition of one or more copyright notices.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice(s), this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
20.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
26.\" DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man9/vflush.9,v 1.2 2001/12/14 09:11:13 ru Exp $
29.\"
30.Dd $Mdocdate: November 14 2020 $
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" "struct vnode *skipvp" "int flags"
41.Sh DESCRIPTION
42The
43.Fn vflush
44function removes any vnodes in the vnode table that belong to the given
45mount structure.
46.Pp
47Its arguments are:
48.Bl -tag -width "rootrefs"
49.It Fa mp
50The mount point whose vnodes should be removed.
51.It Fa skipvp
52If this is given, the vnode it represents will be skipped.
53.It Fa flags
54The flags indicating how vnodes should be handled.
55.Bl -tag -width "WRITECLOSE"
56.It Dv FORCECLOSE
57If set, busy vnodes will be forcibly closed.
58.It Dv SKIPSYSTEM
59If set, vnodes with the
60.Dv VSYSTEM
61flag set will be skipped.
62.It Dv WRITECLOSE
63If set, only regular files currently opened for writing will be removed.
64.El
65.El
66.Sh RETURN VALUES
67A value of 0 is returned if the flush is successful; otherwise,
68.Er EBUSY
69will be returned.
70.Sh SEE ALSO
71.Xr vgone 9 ,
72.Xr vgonel 9 ,
73.Xr vnode 9 ,
74.Xr vrele 9
75.Sh AUTHORS
76This man page was originally written by
77.An Chad David Aq Mt davidc@acns.ab.ca
78for
79.Fx .
80