share/man/man9/VOP_REMOVE.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/VOP_REMOVE.9,v 1.7.2.2 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd July 24, 1996
  30 .Dt VOP_REMOVE 9
  31 .Os
  32 .Sh NAME
  33 .Nm VOP_REMOVE ,
  34 .Nm VOP_RMDIR
  35 .Nd remove a file or directory
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fn VOP_REMOVE "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
  41 .Ft int
  42 .Fn VOP_RMDIR "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
  43 .Sh DESCRIPTION
  44 These entry points remove files and directories respectively.
  45 .Pp
  46 The arguments are:
  47 .Bl -tag -width dvp
  48 .It Fa dvp
  49 the vnode of the directory
  50 .It Fa vp
  51 the vnode of the file to be removed
  52 .It Fa cnp
  53 pathname information about the file
  54 .El
  55 .Sh LOCKS
  56 Both
  57 .Fa dvp
  58 and
  59 .Fa vp
  60 should be locked on entry and remain locked on return.
  61 .Sh RETURN VALUES
  62 Zero is returned on success, otherwise an error code is returned.
  63 .Sh PSEUDOCODE
  64 .Bd -literal
  65 int
  66 vop_remove(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
  67 {
  68     int error = 0;
  69
  70     if (vp is immutable) {
  71         error = EPERM;
  72         goto out;
  73     }
  74
  75     /*
  76      * Remove name cnp->cn_nameptr from directory and update link count
  77      * of vp.
  78      */
  79     ...;
  80
  81     /*
  82      * Careful about trying to remove ".".  XXX this should be handled
  83      * higher up.
  84      */
  85     if (dvp == vp)
  86         vrele(vp);
  87     else
  88         vput(vp);
  89     vput(dvp);
  90
  91     return error;
  92 }
  93 .Ed
  94 .Sh ERRORS
  95 .Bl -tag -width Er
  96 .It Bq Er EPERM
  97 the file is immutable
  98 .It Bq Er ENOTEMPTY
  99 attempt to remove a directory which is not empty
 100 .El
 101 .Sh SEE ALSO
 102 .Xr vnode 9 ,
 103 .Xr VOP_LOOKUP 9
 104 .Sh AUTHORS
 105 This man page was written by
 106 .An Doug Rabson .