xref: /freebsd/share/man/man9/vgone.9 (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.Dd December 8, 2019
28.Dt VGONE 9
29.Os
30.Sh NAME
31.Nm vgone
32.Nd "prepare a vnode for reuse"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/vnode.h
36.Ft void
37.Fn vgone "struct vnode *vp"
38.Sh DESCRIPTION
39The
40.Fn vgone
41function prepares the vnode to be destroyed.
42The preparation includes the cleaning of all file system specific data and
43the removal from its mount point vnode list.
44.Pp
45If the vnode has a
46.Va v_usecount
47of zero, and its
48.Dv VIRF_DOOMED
49flag is not set, it is moved to the head of the free list
50as in most cases the vnode
51is about to be reused, or its file system is being unmounted.
52.Pp
53The
54.Fn vgone
55function takes an exclusively locked vnode, and returns with the vnode
56exclusively locked.
57.Sh SEE ALSO
58.Xr vnode 9
59.Sh AUTHORS
60This manual page was written by
61.An Chad David Aq Mt davidc@acns.ab.ca .
62