1.\" $OpenBSD: vrecycle.9,v 1.11 2020/08/05 11:10:24 tim 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: August 5 2020 $ 29.Dt VRECYCLE 9 30.Os 31.Sh NAME 32.Nm vrecycle 33.Nd recycle a vnode if its reference count is zero 34.Sh SYNOPSIS 35.In sys/param.h 36.In sys/vnode.h 37.Ft int 38.Fo vrecycle 39.Fa "struct vnode *vp" 40.Fa "struct proc *p" 41.Fc 42.Sh DESCRIPTION 43The 44.Fn vrecycle 45function places the vnode 46.Fa vp 47on the free list using 48.Xr vgonel 9 49if its 50.Va v_usecount 51field is zero. 52If 53.Va v_usecount 54is non-zero, it simply returns. 55The 56.Fa p 57argument specifies the process responsible for the call. 58.Sh RETURN VALUES 59.Fn vrecycle 60will return 1 if the vnode was placed on the free list. 61It will return 0 if the reference count was non-zero. 62.Sh SEE ALSO 63.Xr vgonel 9 , 64.Xr vnode 9 65.Sh HISTORY 66This man page was originally written for 67.Ox . 68