1 .\" Copyright (c) 1996 Doug Rabson
3 .\" All rights reserved.
5 .\" This program is free software.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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.
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.
27 .\" $FreeBSD: src/share/man/man9/VOP_RENAME.9,v 1.10.2.2 2001/12/17 11:30:18 ru Exp $
39 .Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp"
41 This renames a file and possibly changes its parent directory.
42 If the destination object exists, it will be removed first.
47 the vnode of the old parent directory
49 the vnode of the file to be renamed
51 pathname information about the file's current name
53 the vnode of the new parent directory
55 the vnode of the target file (if it exists)
57 pathname information about the file's new name
60 The source directory and file are unlocked but are expected to have their
61 ref count bumped on entry. The VOP routine is expected to
66 The destination directory and file are locked as well as having their ref
67 count bumped. The VOP routine is expected to
74 vop_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp,
75 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp)
77 int doingdirectory = 0;
81 * Check for cross-device rename.
83 if (fvp->v_mount != tdvp->v_mount) {
86 VOP_ABORTOP(tdvp, tcnp);
93 VOP_ABORTOP(fdvp, fcnp);
99 if (tvp exists and is immutable) {
105 * Check if just deleting a link name.
108 if (fvp->v_type == VDIR) {
114 * Release destination.
116 VOP_ABORTOP(tdvp, tcnp);
121 * Delete source. Pretty bizarre stuff.
125 fcnp->cn_flags &= ~MODMASK;
126 fcnp->cn_flags |= LOCKPARENT | LOCKLEAF;
127 fcnp->cn_nameiop = DELETE;
129 error = relookup(fdvp, &fvp, fcnp);
132 return VOP_REMOVE(fdvp, fvp, fcnp);
135 if (fvp is immutable) {
140 error = VOP_LOCK(fvp);
144 if (vp is a directory) {
146 * Avoid ".", "..", and aliases of "." for obvious reasons.
148 if ((fcnp->cn_namelen == 1 && fcnp->cn_nameptr[0] == '.')
150 || ((fcnp->cn_flags | tcnp->cn_flags) & ISDOTDOT)) {
160 * Bump link count on fvp while we are moving stuff around. If we
161 * crash before completing the work, the link count may be wrong
167 * If ".." must be changed (ie the directory gets a new
168 * parent) then the source directory must not be in the
169 * directory hierarchy above the target, as this would
170 * orphan everything below the source directory. Also
171 * the user must have write permission in the source so
172 * as to be able to change "..".
174 error = VOP_ACCESS(fvp, VWRITE, tcnp->cn_cred, tcnp->cn_proc);
176 if (doingdirectory && fdvp != tdvp) {
178 * Check for pathname conflict.
184 * If the target doesn't exist, link the target to the source and
185 * unlink the source. Otherwise, rewrite the target directory to
186 * reference the source and remove the original entry.
190 * Account for ".." in new directory.
192 if (doingdirectory && fdvp != tdvp) {
194 * Increase link count of tdvp.
200 * Add name in new directory.
205 if (doingdirectory && fdvp != tdvp) {
207 * Decrease link count if tdvp.
216 * Target must be empty if a directory and have no links
217 * to it. Also, ensure source and target are compatible
218 * (both directories, or both not directories).
220 if (tvp is a directory) {
221 if (tvp is not empty) {
225 if (!doingdirectory) {
230 * Update name cache since directory is going away.
233 } else if (doingdirectory) {
239 * Change name tcnp in tdvp to point at fvp.
244 * If the target directory is in same directory as the source
245 * directory, decrement the link count on the parent of the
246 * target directory. This accounts for the fact that a
247 * directory links back to its parent with "..".
249 if (doingdirectory && fdvp == tdvp) {
251 * Decrement link count of tdvp.
258 * Decrement the link count of tvp since the directory no
259 * longer points at it.
262 if (doingdirectory) {
264 * Clean up the old directory tvp.
272 * Unlink the source. If a directory was moved to a new parent,
273 * update its ".." entry. Gobs of ugly UFS code omitted here.
282 if (VOP_LOCK(fvp) == 0) {
284 * Decrement link count of fvp.
297 the file is immutable
301 illegal directory rename
303 attempt to rename a directory to a file or vice versa
305 attempt to remove a directory which is not empty
310 This man page was written by