share/man/man9/vref.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$
  30 .\"
  31 .Dd January 18, 2016
  32 .Dt VREF 9
  33 .Os
  34 .Sh NAME
  35 .Nm vref , vrefl
  36 .Nd increment the use count for a vnode
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/vnode.h
  40 .Ft void
  41 .Fn vref "struct vnode *vp"
  42 .Ft void
  43 .Fn vrefl "struct vnode *vp"
  44 .Sh DESCRIPTION
  45 Increment the
  46 .Va v_usecount
  47 field of a vnode.
  48 .Bl -tag -width 2n
  49 .It Fa vp
  50 the vnode to increment
  51 .El
  52 .Pp
  53 Each vnode maintains a reference count of how many parts of the system
  54 are using the vnode.
  55 This allows the system to detect when a vnode is
  56 no longer being used and can be safely recycled for a different file.
  57 .Pp
  58 Any code in the system which is using a vnode (e.g.\& during the
  59 operation of some algorithm or to store in a data structure) should
  60 call
  61 .Fn vref
  62 or
  63 .Fn vrefl .
  64 .Pp
  65 .Fn vref
  66 locks the vnode interlock while
  67 .Fn vrefl
  68 expects the interlock to already be held.
  69 .Sh SEE ALSO
  70 .Xr vget 9 ,
  71 .Xr vnode 9 ,
  72 .Xr vput 9 ,
  73 .Xr vrefcnt 9 ,
  74 .Xr vrele 9
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Doug Rabson .