xref: /freebsd/share/man/man9/VOP_INACTIVE.9 (revision df7f5d4de4592a8948a25ce01e5bddfbb7ce39dc)
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.\" $Id$
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/vnode.h>
40.Ft int
41.Fn VOP_INACTIVE "struct vnode *vp"
42.Ft int
43.Fn VOP_RECLAIM "struct vnode *vp"
44.Sh DESCRIPTION
45.Pp
46The arguments are:
47.Bl -tag -width vp
48.It Ar vp
49the vnode being reclaimed
50.El
51.Pp
52.Xr VOP_INACTIVE 9
53is called when the kernel is no longer using the vnode.  This may be
54because the reference count reaches zero or it may be that the
55filesystem is being forcibly unmounted while there are open files.
56It can be used to reclaim space for 'open but deleted' files.
57.Xr VOP_RECLAIM 9
58is called when a vnode is being reused for a different filesystem.
59Any filesystem specific resources associated with the vnode should be
60freed.
61.Sh PSEUDOCODE
62.Bd -literal
63int
64vop_inactive(struct vnode *vp)
65{
66    if (link count of vp == 0) {
67	/*
68	 * Reclaim space in filesystem for vp.
69	 */
70	...;
71    }
72
73    return 0;
74}
75
76int
77vop_reclaim(struct vnode *vp)
78{
79    /*
80     * Clean out the name cache.
81     */
82    cache_purge(vp);
83
84    /*
85     * Free filesystem-related data.
86     */
87    ...;
88
89    return 0;
90}
91.Ed
92.Sh SEE ALSO
93.Xr vnode 9
94.Sh AUTHORS
95This man page was written by Doug Rabson.
96