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.\" $Id: VOP_REMOVE.9,v 1.2 1997/03/04 10:02:36 dfr Exp $ 30.\" 31.Dd July 24, 1996 32.Os 33.Dt VOP_REMOVE 9 34.Sh NAME 35.Nm VOP_REMOVE , 36.Nm VOP_RMDIR 37.Nd remove a file or directory 38.Sh SYNOPSIS 39.Fd #include <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 45These entry points remove files and directories respectively. 46.Pp 47The arguments are: 48.Bl -tag -width dvp 49.It Ar dvp 50the vnode of the directory 51.It Ar vp 52the vnode of the file to be removed 53.It Ar cnp 54pathname information about the file 55.El 56.Sh LOCKS 57Both 58.Fa dvp 59and 60.Fa vp 61should be locked on entry and are unlocked and released on exit. 62.Sh RETURN VALUES 63Zero is returned on success, otherwise an error code is returned. 64.Sh PSEUDOCODE 65.Bd -literal 66int 67vop_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 98the file is immutable 99.It Bq Er ENOTEMPTY 100attempt 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 106This man page was written by Doug Rabson. 107 108