share/man/man9/vrele.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1996 Doug Rabson
   4 .\" Copyright (c) 2010 Konstantin Belousov <kib@FreeBSD.org>
   5 .\"
   6 .\" All rights reserved.
   7 .\"
   8 .\" This program is free software.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd November 20, 2010
  33 .Dt VRELE 9
  34 .Os
  35 .Sh NAME
  36 .Nm vput ,
  37 .Nm vrele ,
  38 .Nm vunref
  39 .Nd decrement the use count for a vnode
  40 .Sh SYNOPSIS
  41 .In sys/param.h
  42 .In sys/vnode.h
  43 .Ft void
  44 .Fn vput "struct vnode *vp"
  45 .Ft void
  46 .Fn vrele "struct vnode *vp"
  47 .Ft void
  48 .Fn vunref "struct vnode *vp"
  49 .Sh DESCRIPTION
  50 Decrement the
  51 .Va v_usecount
  52 field of a vnode.
  53 .Bl -tag -width 2n
  54 .It Fa vp
  55 the vnode to decrement
  56 .El
  57 .Pp
  58 The
  59 .Fn vrele
  60 function takes an unlocked vnode and returns with the vnode unlocked.
  61 .Pp
  62 The
  63 .Fn vput
  64 function should be given a locked vnode as argument, the vnode is unlocked
  65 after the function returned.
  66 The
  67 .Fn vput
  68 is operationally equivalent to calling
  69 .Xr VOP_UNLOCK 9
  70 followed by
  71 .Xr vrele 9 ,
  72 with less overhead.
  73 .Pp
  74 The
  75 .Fn vunref
  76 function takes a locked vnode as argument, and returns with the vnode locked.
  77 .Pp
  78 Any code in the system which signified its use of a vnode by usecount
  79 should call one of the listed function to decrement use counter.
  80 If the
  81 .Va v_usecount
  82 field of the non-doomed vnode reaches zero, then it will be inactivated
  83 and placed on the free list.
  84 Since the functions might need to call VOPs for the vnode, the
  85 .Va Giant
  86 mutex should be conditionally locked around the call.
  87 .Pp
  88 The hold count for the vnode is always greater or equal to the usecount.
  89 Non-forced unmount fails when mount point owns a vnode that has non-zero
  90 usecount, see
  91 .Xr vflush 9 .
  92 .Sh SEE ALSO
  93 .Xr vget 9 ,
  94 .Xr vnode 9 ,
  95 .Xr vref 9 ,
  96 .Xr vrefcnt 9
  97 .Sh AUTHORS
  98 This manual page was written by
  99 .An Doug Rabson
 100 and
 101 .An Konstantin Belousov .