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