xref: /freebsd/share/man/man9/vgone.9 (revision 2f02600abfddfc4e9f20dd384a2e729b451e16bd)
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.\" $FreeBSD$
28.\"
29.Dd November 12, 2010
30.Dt VGONE 9
31.Os
32.Sh NAME
33.Nm vgone
34.Nd "prepare a vnode for reuse"
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft void
39.Fn vgone "struct vnode *vp"
40.Sh DESCRIPTION
41The
42.Fn vgone
43function prepares the vnode to be destroyed.
44The preparation includes the cleaning of all file system specific data and
45the removal from its mount point vnode list.
46.Pp
47If the vnode has a
48.Va v_usecount
49of zero, and its
50.Dv VI_DOOMED
51flag is not set, it is moved to the head of the free list
52as in most cases the vnode
53is about to be reused, or its file system is being unmounted.
54.Pp
55The
56.Fn vgone
57function takes an exclusively locked vnode, and returns with the vnode
58exclusively locked.
59.Sh SEE ALSO
60.Xr vnode 9
61.Sh AUTHORS
62This manual page was written by
63.An Chad David Aq davidc@acns.ab.ca .
64