xref: /dragonfly/share/man/man9/VOP_INACTIVE.9 (revision 0720b42f)
1.\" Copyright (c) 1996 Doug Rabson
2.\"
3.\" All rights reserved.
4.\"
5.\" This program is free software.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, 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 DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/share/man/man9/VOP_INACTIVE.9,v 1.5.2.3 2001/12/17 11:30:18 ru Exp $
28.\"
29.Dd November 15, 2014
30.Dt VOP_INACTIVE 9
31.Os
32.Sh NAME
33.Nm VOP_INACTIVE ,
34.Nm VOP_RECLAIM
35.Nd reclaim filesystem resources for a vnode
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/vnode.h
39.Ft int
40.Fn VOP_INACTIVE "struct vnode *vp"
41.Ft int
42.Fn VOP_RECLAIM "struct vnode *vp"
43.Sh DESCRIPTION
44The arguments are:
45.Bl -tag -width 2n
46.It Fa vp
47the vnode being reclaimed
48.El
49.Pp
50.Xr VOP_INACTIVE 9
51is called when the kernel is no longer using the vnode.  This may be
52because the reference count reaches zero or it may be that the
53filesystem is being forcibly unmounted while there are open files.
54It can be used to reclaim space for 'open but deleted' files.
55.Xr VOP_RECLAIM 9
56is called when a vnode is being reused for a different filesystem.
57Any filesystem specific resources associated with the vnode should be
58freed.
59.Sh SEE ALSO
60.Xr vnode 9
61.Sh AUTHORS
62This man page was written by
63.An Doug Rabson .
64