share/man/man9/vref.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/vref.9,v 1.6.2.2 2001/12/17 11:30:19 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/vref.9,v 1.4 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd July 24, 1996
  31 .Os
  32 .Dt VREF 9
  33 .Sh NAME
  34 .Nm vref
  35 .Nd increment the use count for a vnode
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft void
  40 .Fn vref "struct vnode *vp"
  41 .Sh DESCRIPTION
  42 Increment the
  43 .Va v_usecount
  44 field of a vnode.
  45 .Bl -tag -width 2n
  46 .It Fa vp
  47 the vnode to increment
  48 .El
  49 .Pp
  50 Each vnode maintains a reference count of how many parts of the system
  51 are using the vnode.  This allows the system to detect when a vnode is
  52 no longer being used and can be safely recycled for a different file.
  53 .Pp
  54 Any code in the system which is using a vnode (e.g. during the
  55 operation of some algorithm or to store in a data structure) should
  56 call
  57 .Xr vref 9 .
  58 .Sh SEE ALSO
  59 .Xr vget 9 ,
  60 .Xr vnode 9 ,
  61 .Xr vput 9 ,
  62 .Xr vrele 9
  63 .Sh AUTHORS
  64 This man page was written by
  65 .An Doug Rabson .