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