share/man/man9/vrele.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/vrele.9,v 1.6.2.2 2001/12/17 11:30:19 ru Exp $
  28 .\"
  29 .Dd May 5, 2007
  30 .Dt VRELE 9
  31 .Os
  32 .Sh NAME
  33 .Nm vrele
  34 .Nd Release a previously obtained primary reference for a vnode
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft void
  39 .Fn vrele "struct vnode *vp"
  40 .Sh DESCRIPTION
  41 The caller is holding a primary reference to the vnode and wishes to
  42 release it.
  43 .Bl -tag -width ".Fa vp"
  44 .It Fa vp
  45 The vnode being released.
  46 .El
  47 .Pp
  48 Any code in the system which obtains a primary reference to a vnode via
  49 .Xr vref 9
  50 typically releases that reference with
  51 .Fn vrele
  52 when it is finished with the vnode.
  53 Upon release of the last primary
  54 reference, the vnode will be deactivated and either moved to the free
  55 list for later reuse or marked as being cache.
  56 The vnode can be reactivated at any time prior to the system reusing it.
  57 .Sh SEE ALSO
  58 .Xr vdrop 9 ,
  59 .Xr vget 9 ,
  60 .Xr vhold 9 ,
  61 .Xr vnode 9 ,
  62 .Xr vn_lock 9 ,
  63 .Xr vn_unlock 9 ,
  64 .Xr vput 9 ,
  65 .Xr vref 9
  66 .Sh AUTHORS
  67 This manual page was written by
  68 .An Doug Rabson .