1) Fix prototype in vget(9).
[dragonfly.git] / share / man / man9 / vget.9
1 .\" Copyright (c) 1996 Doug Rabson
2 .\"
3 .\" All rights reserved.
4 .\"
5 .\" This program is free software.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man9/vget.9,v 1.5.2.1 2001/12/17 11:30:19 ru Exp $
28 .\" $DragonFly: src/share/man/man9/vget.9,v 1.5 2007/03/04 02:45:08 swildner Exp $
29 .\"
30 .Dd March 4, 2007
31 .Os
32 .Dt VGET 9
33 .Sh NAME
34 .Nm vget
35 .Nd get a vnode from the free list
36 .Sh SYNOPSIS
37 .In sys/param.h
38 .In sys/vnode.h
39 .Ft int
40 .Fn vget "struct vnode *vp" "int lockflag"
41 .Sh DESCRIPTION
42 Get a vnode from the free list and increment its reference count.
43 .Bl -tag -width ".Fa lockflag"
44 .It Fa vp
45 The vnode to remove from the free list.
46 .It Fa lockflag
47 If non-zero, the vnode will also be locked.
48 .El
49 .Pp
50 When not in use, vnodes are kept on a free list.  The vnodes still
51 reference valid files but may be reused to refer to a new file at any
52 time.  Often, these vnodes are also held in caches in the system, such
53 as the name cache.
54 .Pp
55 When a vnode which is on the free list is used again, for instance if
56 the vnode was found in the name cache as a result of a call to
57 .Xr VOP_LOOKUP 9
58 then the new user must call
59 .Fn vget
60 to increment the reference count and remove it from the free list.
61 .Sh SEE ALSO
62 .Xr vnode 9 ,
63 .Xr vput 9 ,
64 .Xr vref 9 ,
65 .Xr vrele 9
66 .Sh AUTHORS
67 This manual page was written by
68 .An Doug Rabson .