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.
38 .Fd #include <sys/param.h>
39 .Fd #include <sys/vnode.h>
41 .Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp"
43 This renames a file and possibly changes its parent directory.
44 If the destination object exists, it will be removed first.
49 the vnode of the old parent directory
51 the vnode of the file to be renamed
53 pathname information about the file's current name
55 the vnode of the new parent directory
57 the vnode of the target file (if it exists)
59 pathname information about the file's new name
62 The source directory and file are unlocked but are expected to have their
63 ref count bumped on entry. The VOP routine is expected to
68 The destination directory and file are locked as well as having their ref
69 count bumped. The VOP routine is expected to
76 vop_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp,
77 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp)
79 int doingdirectory = 0;
83 * Check for cross-device rename.
85 if (fvp->v_mount != tdvp->v_mount) {
88 VOP_ABORTOP(tdvp, tcnp);
95 VOP_ABORTOP(fdvp, fcnp);
101 if (tvp exists and is immutable) {
107 * Check if just deleting a link name.
110 if (fvp->v_type == VDIR) {
116 * Release destination.
118 VOP_ABORTOP(tdvp, tcnp);
123 * Delete source. Pretty bizarre stuff.
127 fcnp->cn_flags &= ~MODMASK;
128 fcnp->cn_flags |= LOCKPARENT | LOCKLEAF;
129 fcnp->cn_nameiop = DELETE;
131 error = relookup(fdvp, &fvp, fcnp);
134 return VOP_REMOVE(fdvp, fvp, fcnp);
137 if (fvp is immutable) {
142 error = VOP_LOCK(fvp);
146 if (vp is a directory) {
148 * Avoid ".", "..", and aliases of "." for obvious reasons.
150 if ((fcnp->cn_namelen == 1 && fcnp->cn_nameptr[0] == '.')
152 || ((fcnp->cn_flags | tcnp->cn_flags) & ISDOTDOT)) {
162 * Bump link count on fvp while we are moving stuff around. If we
163 * crash before completing the work, the link count may be wrong
169 * If ".." must be changed (ie the directory gets a new
170 * parent) then the source directory must not be in the
171 * directory hierarchy above the target, as this would
172 * orphan everything below the source directory. Also
173 * the user must have write permission in the source so
174 * as to be able to change "..".
176 error = VOP_ACCESS(fvp, VWRITE, tcnp->cn_cred, tcnp->cn_proc);
178 if (doingdirectory && fdvp != tdvp) {
180 * Check for pathname conflict.
186 * If the target doesn't exist, link the target to the source and
187 * unlink the source. Otherwise, rewrite the target directory to
188 * reference the source and remove the original entry.
192 * Account for ".." in new directory.
194 if (doingdirectory && fdvp != tdvp) {
196 * Increase link count of tdvp.
202 * Add name in new directory.
207 if (doingdirectory && fdvp != tdvp) {
209 * Decrease link count if tdvp.
218 * Target must be empty if a directory and have no links
219 * to it. Also, ensure source and target are compatible
220 * (both directories, or both not directories).
222 if (tvp is a directory) {
223 if (tvp is not empty) {
227 if (!doingdirectory) {
232 * Update name cache since directory is going away.
235 } else if (doingdirectory) {
241 * Change name tcnp in tdvp to point at fvp.
246 * If the target directory is in same directory as the source
247 * directory, decrement the link count on the parent of the
248 * target directory. This accounts for the fact that a
249 * directory links back to its parent with "..".
251 if (doingdirectory && fdvp == tdvp) {
253 * Decrement link count of tdvp.
260 * Decrement the link count of tvp since the directory no
261 * longer points at it.
264 if (doingdirectory) {
266 * Clean up the old directory tvp.
274 * Unlink the source. If a directory was moved to a new parent,
275 * update its ".." entry. Gobs of ugly UFS code omitted here.
284 if (VOP_LOCK(fvp) == 0) {
286 * Decrement link count of fvp.
299 the file is immutable
303 illegal directory rename
305 attempt to rename a directory to a file or vice versa
307 attempt to remove a directory which is not empty
312 This man page was written by