3 .\" Copyright (c) 1996 Doug Rabson
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
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.
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.
29 .\" $FreeBSD: src/share/man/man9/VOP_RENAME.9,v 1.10.2.2 2001/12/17 11:30:18 ru Exp $
30 .\" $DragonFly: src/share/man/man9/VOP_RENAME.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
42 .Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp"
44 This renames a file and possibly changes its parent directory.
45 If the destination object exists, it will be removed first.
50 the vnode of the old parent directory
52 the vnode of the file to be renamed
54 pathname information about the file's current name
56 the vnode of the new parent directory
58 the vnode of the target file (if it exists)
60 pathname information about the file's new name
63 The source directory and file are unlocked but are expected to have their
64 ref count bumped on entry. The VOP routine is expected to
69 The destination directory and file are locked as well as having their ref
70 count bumped. The VOP routine is expected to
77 vop_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp,
78 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp)
80 int doingdirectory = 0;
84 * Check for cross-device rename.
86 if (fvp->v_mount != tdvp->v_mount) {
89 VOP_ABORTOP(tdvp, tcnp);
96 VOP_ABORTOP(fdvp, fcnp);
102 if (tvp exists and is immutable) {
108 * Check if just deleting a link name.
111 if (fvp->v_type == VDIR) {
117 * Release destination.
119 VOP_ABORTOP(tdvp, tcnp);
124 * Delete source. Pretty bizarre stuff.
128 fcnp->cn_flags &= ~MODMASK;
129 fcnp->cn_flags |= LOCKPARENT | LOCKLEAF;
130 fcnp->cn_nameiop = DELETE;
132 error = relookup(fdvp, &fvp, fcnp);
135 return VOP_REMOVE(fdvp, fvp, fcnp);
138 if (fvp is immutable) {
143 error = VOP_LOCK(fvp);
147 if (vp is a directory) {
149 * Avoid ".", "..", and aliases of "." for obvious reasons.
151 if ((fcnp->cn_namelen == 1 && fcnp->cn_nameptr[0] == '.')
153 || ((fcnp->cn_flags | tcnp->cn_flags) & ISDOTDOT)) {
163 * Bump link count on fvp while we are moving stuff around. If we
164 * crash before completing the work, the link count may be wrong
170 * If ".." must be changed (ie the directory gets a new
171 * parent) then the source directory must not be in the
172 * directory hierarchy above the target, as this would
173 * orphan everything below the source directory. Also
174 * the user must have write permission in the source so
175 * as to be able to change "..".
177 error = VOP_ACCESS(fvp, VWRITE, tcnp->cn_cred, tcnp->cn_proc);
179 if (doingdirectory && fdvp != tdvp) {
181 * Check for pathname conflict.
187 * If the target doesn't exist, link the target to the source and
188 * unlink the source. Otherwise, rewrite the target directory to
189 * reference the source and remove the original entry.
193 * Account for ".." in new directory.
195 if (doingdirectory && fdvp != tdvp) {
197 * Increase link count of tdvp.
203 * Add name in new directory.
208 if (doingdirectory && fdvp != tdvp) {
210 * Decrease link count if tdvp.
219 * Target must be empty if a directory and have no links
220 * to it. Also, ensure source and target are compatible
221 * (both directories, or both not directories).
223 if (tvp is a directory) {
224 if (tvp is not empty) {
228 if (!doingdirectory) {
233 * Update name cache since directory is going away.
236 } else if (doingdirectory) {
242 * Change name tcnp in tdvp to point at fvp.
247 * If the target directory is in same directory as the source
248 * directory, decrement the link count on the parent of the
249 * target directory. This accounts for the fact that a
250 * directory links back to its parent with "..".
252 if (doingdirectory && fdvp == tdvp) {
254 * Decrement link count of tdvp.
261 * Decrement the link count of tvp since the directory no
262 * longer points at it.
265 if (doingdirectory) {
267 * Clean up the old directory tvp.
275 * Unlink the source. If a directory was moved to a new parent,
276 * update its ".." entry. Gobs of ugly UFS code omitted here.
285 if (VOP_LOCK(fvp) == 0) {
287 * Decrement link count of fvp.
300 the file is immutable
304 illegal directory rename
306 attempt to rename a directory to a file or vice versa
308 attempt to remove a directory which is not empty
313 This man page was written by