share/man/man9/vget.9

   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: src/share/man/man9/vget.9,v 1.5.2.1 2001/12/17 11:30:19 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/vget.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
  31 .\"
  32 .Dd July 24, 1996
  33 .Os
  34 .Dt VGET 9
  35 .Sh NAME
  36 .Nm vget
  37 .Nd get a vnode from the free list
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/vnode.h
  41 .Ft int
  42 .Fn vget "struct vnode *vp" "int lockflag" "struct proc *p"
  43 .Sh DESCRIPTION
  44 Get a vnode from the free list and increment its reference count.
  45 .Bl -tag -width lockflag
  46 .It Fa vp
  47 the vnode to remove from the free list
  48 .It Fa lockflag
  49 if non-zero, the vnode will also be locked
  50 .El
  51 .Pp
  52 When not in use, vnodes are kept on a free list.  The vnodes still
  53 reference valid files but may be reused to refer to a new file at any
  54 time.  Often, these vnodes are also held in caches in the system, such
  55 as the name cache.
  56 .Pp
  57 When a vnode which is on the free list is used again, for instance if
  58 the vnode was found in the name cache as a result of a call to
  59 .Xr VOP_LOOKUP 9
  60 then the new user must call
  61 .Xr vget 9
  62 to increment the reference count and remove it from the free list.
  63 .Sh SEE ALSO
  64 .Xr vnode 9 ,
  65 .Xr vput 9 ,
  66 .Xr vref 9 ,
  67 .Xr vrele 9
  68 .Sh AUTHORS
  69 This man page was written by
  70 .An Doug Rabson .