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