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$
  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 file system 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 thread *td"
  43 .Ft int
  44 .Fn VOP_RECLAIM "struct vnode *vp" "struct thread *td"
  45 .Sh DESCRIPTION
  46 The arguments are:
  47 .Bl -tag -width 2n
  48 .It Fa vp
  49 The vnode being reclaimed.
  50 .El
  51 .Pp
  52 .Fn VOP_INACTIVE
  53 is called when the kernel is no longer using the vnode.
  54 This may be
  55 because the reference count reaches zero or it may be that the
  56 file system is being forcibly unmounted while there are open files.
  57 It can be used to reclaim space for
  58 .Sq open but deleted
  59 files.
  60 .Pp
  61 .Fn VOP_RECLAIM
  62 is called when a vnode is being reused for a different file system.
  63 Any file system specific resources associated with the vnode should be
  64 freed.
  65 .Sh LOCKS
  66 For VOP_INACTIVE, the
  67 .Fa vp
  68 will be locked on entry.
  69 Your VOP_INACTIVE code
  70 must unlock the
  71 .Fa vp
  72 prior to returning.
  73 .Pp
  74 For VOP_RECLAIM, the
  75 .Fa vp
  76 will not be locked on entry and should be left unlocked on return.
  77 .Sh PSEUDOCODE
  78 .Bd -literal
  79 int
  80 vop_inactive(struct vnode *vp, struct thread *td)
  81 {
  82     if (link count of vp == 0) {
  83         /*
  84          * Reclaim space in file system for vp.
  85          */
  86         ...;
  87     }
  88     VOP_UNLOCK(vp, 0, td);
  89
  90     return 0;
  91 }
  92
  93 int
  94 vop_reclaim(struct vnode *vp, struct thread *td)
  95 {
  96     /*
  97      * Clean out the name cache.
  98      */
  99     cache_purge(vp);
 100
 101     /*
 102      * Free file system related data.
 103      */
 104     ...;
 105
 106     return 0;
 107 }
 108 .Ed
 109 .Sh SEE ALSO
 110 .Xr vnode 9
 111 .Sh AUTHORS
 112 This manual page was written by
 113 .An Doug Rabson .