1.\" $OpenBSD: vclean.9,v 1.11 2020/11/14 10:35:58 jmc Exp $ 2.\"- 3.\" Copyright (c) 2002 Peter Werner 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER 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 25.\" SUCH DAMAGE. 26.\" 27.\" 28.Dd $Mdocdate: November 14 2020 $ 29.Dt VCLEAN 9 30.Os 31.Sh NAME 32.Nm vclean 33.Nd disassociate the underlying file system from a vnode 34.Sh SYNOPSIS 35.In sys/param.h 36.In sys/vnode.h 37.Ft void 38.Fo vclean 39.Fa "struct vnode *vp" 40.Fa "int flags" 41.Fa "struct proc *p" 42.Fc 43.Sh DESCRIPTION 44The 45.Fn vclean 46function clears any VM and buffer data associated with the vnode 47.Fa vp 48and reclaims it from the underlying file system. 49.Pp 50Its arguments are: 51.Bl -tag -width "flags" 52.It Fa vp 53The vnode to be cleaned. 54.It Fa flags 55The flags indicating how the vnode should be handled. 56.Bl -tag -width "DOCLOSE" 57.It Dv DOCLOSE 58If this flag is set, 59.Fn vclean 60will call 61.Xr vinvalbuf 9 62on the vnode. 63If the vnode is active, it will be closed and inactivated in the 64underlying file system. 65.El 66.It Fa p 67The process responsible for this call. 68.El 69.Pp 70On exit, the 71.Va v_tag 72field of the vnode will be set to 73.Dv VT_NON , 74and if the vnode was active, it will be placed on the vnode free list. 75.Sh SEE ALSO 76.Xr vinvalbuf 9 , 77.Xr vnode 9 78.Sh HISTORY 79This man page was originally written for 80.Ox . 81