share/man/man9/vhold.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/vhold.9,v 1.4 2005/07/22 00:28:22 rodrigc Exp $
  28 .\" $DragonFly: src/share/man/man9/vhold.9,v 1.1 2007/03/04 02:45:08 swildner Exp $
  29 .\"
  30 .Dd March 4, 2007
  31 .Dt VHOLD 9
  32 .Os
  33 .Sh NAME
  34 .Nm vhold , vdrop
  35 .Nd "acquire/release a hold on a vnode"
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft void
  40 .Fn vhold "struct vnode *vp"
  41 .Ft void
  42 .Fn vdrop "struct vnode *vp"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn vhold
  46 function increments the
  47 .Va v_holdcnt
  48 of the given vnode.
  49 If the vnode has already been added to the free list and is still referenced,
  50 it will be removed.
  51 .Pp
  52 The
  53 .Fn vdrop
  54 function decrements the
  55 .Va v_holdcnt
  56 of the vnode.
  57 If the holdcount is less than or equal to zero prior to calling
  58 .Fn vdrop ,
  59 the system will panic.
  60 If the vnode is no longer referenced, it will be freed.
  61 .Sh SEE ALSO
  62 .Xr vbusy 9 ,
  63 .Xr vfree 9
  64 .Sh AUTHORS
  65 This manual page was written by
  66 .An Chad David Aq davidc@acns.ab.ca .