xref: /freebsd/share/man/man9/VOP_INACTIVE.9 (revision 32c7dde816fd1d738a48af82bf490307cb7b4739)
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 March 15, 2019
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 usually called when the kernel is no longer using the vnode.
54However, there is no guarantee that it will be called at all, for example if
55the last reference was dropped while the vnode lock could not be upgraded
56to exclusive without sleeping.
57This may be
58because the reference count reaches zero or it may be that the
59file system is being forcibly unmounted while there are open files.
60It can be used to reclaim space on the last close of an
61.Sq open but deleted
62file.
63.Pp
64.Fn VOP_RECLAIM
65is called when a vnode is being reused for a different file system.
66Any file system specific resources associated with the vnode should be
67freed.
68.Sh LOCKS
69For both
70.Fn VOP_INACTIVE
71and
72.Fn VOP_RECLAIM ,
73the
74.Fa vp
75will be exclusively locked on entry, and must be left exclusively
76locked on return.
77.Sh SEE ALSO
78.Xr vnode 9
79.Sh AUTHORS
80This manual page was written by
81.An Doug Rabson .
82