xref: /freebsd/share/man/man9/VOP_INACTIVE.9 (revision 1b833d535b9ce1789dca84d8bd15d22e1ed58d46)
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 27, 2014
32.Dt VOP_INACTIVE 9
33.Os
34.Sh NAME
35.Nm VOP_INACTIVE ,
36.Nm VOP_RECLAIM
37.Nd reclaim file system resources for a vnode
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/vnode.h
41.Ft int
42.Fn VOP_INACTIVE "struct vnode *vp" "struct thread *td"
43.Ft int
44.Fn VOP_RECLAIM "struct vnode *vp" "struct thread *td"
45.Sh DESCRIPTION
46The arguments are:
47.Bl -tag -width 2n
48.It Fa vp
49The vnode being reclaimed.
50.El
51.Pp
52.Fn VOP_INACTIVE
53is called when the kernel is no longer using the vnode.
54This may be
55because the reference count reaches zero or it may be that the
56file system is being forcibly unmounted while there are open files.
57It can be used to reclaim space for
58.Sq open but deleted
59files.
60.Pp
61.Fn VOP_RECLAIM
62is called when a vnode is being reused for a different file system.
63Any file system specific resources associated with the vnode should be
64freed.
65.Sh LOCKS
66For both
67.Fn VOP_INACTIVE
68and
69.Fn VOP_RECLAIM ,
70the
71.Fa vp
72will be exclusively locked on entry, and must be left exclusively
73locked on return.
74.Sh SEE ALSO
75.Xr vnode 9
76.Sh AUTHORS
77This manual page was written by
78.An Doug Rabson .
79