share/man/man9/VOP_INACTIVE.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: src/share/man/man9/VOP_INACTIVE.9,v 1.5.2.3 2001/12/17 11:30:18 ru Exp $
  30 .\"
  31 .Dd July 24, 1996
  32 .Os
  33 .Dt VOP_INACTIVE 9
  34 .Sh NAME
  35 .Nm VOP_INACTIVE ,
  36 .Nm VOP_RECLAIM
  37 .Nd reclaim filesystem resources for a vnode
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/vnode.h
  41 .Ft int
  42 .Fn VOP_INACTIVE "struct vnode *vp" "struct proc *p"
  43 .Ft int
  44 .Fn VOP_RECLAIM "struct vnode *vp" "struct proc *p"
  45 .Sh DESCRIPTION
  46 The arguments are:
  47 .Bl -tag -width 2n
  48 .It Ar vp
  49 the vnode being reclaimed
  50 .El
  51 .Pp
  52 .Xr VOP_INACTIVE 9
  53 is called when the kernel is no longer using the vnode.  This may be
  54 because the reference count reaches zero or it may be that the
  55 filesystem is being forcibly unmounted while there are open files.
  56 It can be used to reclaim space for 'open but deleted' files.
  57 .Xr VOP_RECLAIM 9
  58 is called when a vnode is being reused for a different filesystem.
  59 Any filesystem specific resources associated with the vnode should be
  60 freed.
  61 .Sh LOCKS
  62 For VOP_INACTIVE, the vp will be locked on entry.  Your VOP_INACTIVE code
  63 must unlock the vp prior to returning.
  64 .Pp
  65 For VOP_RECLAIM, the vp will not be locked on entry and should be left
  66 unlocked on return.
  67 .Sh PSEUDOCODE
  68 .Bd -literal
  69 int
  70 vop_inactive(struct vnode *vp)
  71 {
  72     if (link count of vp == 0) {
  73         /*
  74          * Reclaim space in filesystem for vp.
  75          */
  76         ...;
  77     }
  78     VOP_UNLOCK(vp, 0, p);
  79
  80     return 0;
  81 }
  82
  83 int
  84 vop_reclaim(struct vnode *vp)
  85 {
  86     /*
  87      * Clean out the name cache.
  88      */
  89     cache_purge(vp);
  90
  91     /*
  92      * Free filesystem-related data.
  93      */
  94     ...;
  95
  96     return 0;
  97 }
  98 .Ed
  99 .Sh SEE ALSO
 100 .Xr vnode 9
 101 .Sh AUTHORS
 102 This man page was written by
 103 .An Doug Rabson .