xref: /freebsd/share/man/man9/VOP_INACTIVE.9 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
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.Dd March 15, 2019
30.Dt VOP_INACTIVE 9
31.Os
32.Sh NAME
33.Nm VOP_INACTIVE ,
34.Nm VOP_RECLAIM
35.Nd reclaim file system 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" "struct thread *td"
41.Ft int
42.Fn VOP_RECLAIM "struct vnode *vp" "struct thread *td"
43.Sh DESCRIPTION
44The arguments are:
45.Bl -tag -width 2n
46.It Fa vp
47The vnode being reclaimed.
48.El
49.Pp
50.Fn VOP_INACTIVE
51is usually called when the kernel is no longer using the vnode.
52However, there is no guarantee that it will be called at all, for example if
53the last reference was dropped while the vnode lock could not be upgraded
54to exclusive without sleeping.
55This may be
56because the reference count reaches zero or it may be that the
57file system is being forcibly unmounted while there are open files.
58It can be used to reclaim space on the last close of an
59.Sq open but deleted
60file.
61.Pp
62.Fn VOP_RECLAIM
63is called when a vnode is being reused for a different file system.
64Any file system specific resources associated with the vnode should be
65freed.
66.Sh LOCKS
67For both
68.Fn VOP_INACTIVE
69and
70.Fn VOP_RECLAIM ,
71the
72.Fa vp
73will be exclusively locked on entry, and must be left exclusively
74locked on return.
75.Sh SEE ALSO
76.Xr vnode 9
77.Sh AUTHORS
78This manual page was written by
79.An Doug Rabson .
80