1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 1996 Doug Rabson 4.\" 5.\" All rights reserved. 6.\" 7.\" This program is free software. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28.\" 29.\" $FreeBSD$ 30.\" 31.Dd July 24, 1996 32.Os 33.Dt VOP_INACTIVE 9 34.Sh NAME 35.Nm VOP_INACTIVE , 36.Nm VOP_RECLAIM 37.Nd reclaim filesystem resources for a vnode 38.Sh SYNOPSIS 39.Fd #include <sys/param.h> 40.Fd #include <sys/vnode.h> 41.Ft int 42.Fn VOP_INACTIVE "struct vnode *vp" "struct proc *p" 43.Ft int 44.Fn VOP_RECLAIM "struct vnode *vp" "struct proc *p" 45.Sh DESCRIPTION 46.Pp 47The arguments are: 48.Bl -tag -width 2n 49.It Ar vp 50the vnode being reclaimed 51.El 52.Pp 53.Xr VOP_INACTIVE 9 54is called when the kernel is no longer using the vnode. This may be 55because the reference count reaches zero or it may be that the 56filesystem is being forcibly unmounted while there are open files. 57It can be used to reclaim space for 'open but deleted' files. 58.Xr VOP_RECLAIM 9 59is called when a vnode is being reused for a different filesystem. 60Any filesystem specific resources associated with the vnode should be 61freed. 62.Sh LOCKS 63.Pp 64For VOP_INACTIVE, the vp will be locked on entry. Your VOP_INACTIVE code 65must unlock the vp prior to returning. 66.Pp 67For VOP_RECLAIM, the vp will not be locked on entry and should be left 68unlocked on return. 69.Pp 70.Sh PSEUDOCODE 71.Bd -literal 72int 73vop_inactive(struct vnode *vp) 74{ 75 if (link count of vp == 0) { 76 /* 77 * Reclaim space in filesystem for vp. 78 */ 79 ...; 80 } 81 VOP_UNLOCK(vp, 0, p); 82 83 return 0; 84} 85 86int 87vop_reclaim(struct vnode *vp) 88{ 89 /* 90 * Clean out the name cache. 91 */ 92 cache_purge(vp); 93 94 /* 95 * Free filesystem-related data. 96 */ 97 ...; 98 99 return 0; 100} 101.Ed 102.Sh SEE ALSO 103.Xr vnode 9 104.Sh AUTHORS 105This man page was written by 106.An Doug Rabson . 107