2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 #include "xfs_types.h"
23 #include "xfs_trans.h"
26 #include "xfs_dmapi.h"
27 #include "xfs_mount.h"
28 #include "xfs_da_btree.h"
29 #include "xfs_bmap_btree.h"
30 #include "xfs_dir2_sf.h"
31 #include "xfs_attr_sf.h"
32 #include "xfs_dinode.h"
33 #include "xfs_inode.h"
34 #include "xfs_inode_item.h"
36 #include "xfs_error.h"
37 #include "xfs_quota.h"
38 #include "xfs_refcache.h"
39 #include "xfs_utils.h"
40 #include "xfs_trans_space.h"
44 * Given an array of up to 4 inode pointers, unlock the pointed to inodes.
45 * If there are fewer than 4 entries in the array, the empty entries will
46 * be at the end and will have NULL pointers in them.
55 xfs_iunlock(i_tab[0], lock_mode);
56 for (i = 1; i < 4; i++) {
57 if (i_tab[i] == NULL) {
61 * Watch out for duplicate entries in the table.
63 if (i_tab[i] != i_tab[i-1]) {
64 xfs_iunlock(i_tab[i], lock_mode);
70 int xfs_rename_skip, xfs_rename_nskip;
74 * The following routine will acquire the locks required for a rename
75 * operation. The code understands the semantics of renames and will
76 * validate that name1 exists under dp1 & that name2 may or may not
79 * We are renaming dp1/name1 to dp2/name2.
81 * Return ENOENT if dp1 does not exist, other lookup errors, or 0 for success.
85 xfs_inode_t *dp1, /* old (source) directory inode */
86 xfs_inode_t *dp2, /* new (target) directory inode */
87 bhv_vname_t *vname1,/* old entry name */
88 bhv_vname_t *vname2,/* new entry name */
89 xfs_inode_t **ipp1, /* inode of old entry */
90 xfs_inode_t **ipp2, /* inode of new entry, if it
91 already exists, NULL otherwise. */
92 xfs_inode_t **i_tab,/* array of inode returned, sorted */
93 int *num_inodes) /* number of inodes in array */
95 xfs_inode_t *ip1, *ip2, *temp;
96 xfs_ino_t inum1, inum2;
100 int diff_dirs = (dp1 != dp2);
105 * First, find out the current inums of the entries so that we
106 * can determine the initial locking order. We'll have to
107 * sanity check stuff after all the locks have been acquired
108 * to see if we still have the right inodes, directories, etc.
110 lock_mode = xfs_ilock_map_shared(dp1);
111 error = xfs_get_dir_entry(vname1, &ip1);
113 xfs_iunlock_map_shared(dp1, lock_mode);
123 * Unlock dp1 and lock dp2 if they are different.
127 xfs_iunlock_map_shared(dp1, lock_mode);
128 lock_mode = xfs_ilock_map_shared(dp2);
131 error = xfs_dir_lookup_int(XFS_ITOBHV(dp2), lock_mode,
132 vname2, &inum2, &ip2);
133 if (error == ENOENT) { /* target does not need to exist. */
137 * If dp2 and dp1 are the same, the next line unlocks dp1.
140 xfs_iunlock_map_shared(dp2, lock_mode);
148 * i_tab contains a list of pointers to inodes. We initialize
149 * the table here & we'll sort it. We will then use it to
150 * order the acquisition of the inode locks.
152 * Note that the table may contain duplicates. e.g., dp1 == dp2.
166 * Sort the elements via bubble sort. (Remember, there are at
167 * most 4 elements to sort, so this is adequate.)
169 for (i=0; i < *num_inodes; i++) {
170 for (j=1; j < *num_inodes; j++) {
171 if (i_tab[j]->i_ino < i_tab[j-1]->i_ino) {
173 i_tab[j] = i_tab[j-1];
180 * We have dp2 locked. If it isn't first, unlock it.
181 * If it is first, tell xfs_lock_inodes so it can skip it
182 * when locking. if dp1 == dp2, xfs_lock_inodes will skip both
183 * since they are equal. xfs_lock_inodes needs all these inodes
184 * so that it can unlock and retry if there might be a dead-lock
185 * potential with the log.
188 if (i_tab[0] == dp2 && lock_mode == XFS_ILOCK_SHARED) {
192 xfs_lock_inodes(i_tab, *num_inodes, 1, XFS_ILOCK_SHARED);
197 xfs_iunlock_map_shared(dp2, lock_mode);
198 xfs_lock_inodes(i_tab, *num_inodes, 0, XFS_ILOCK_SHARED);
202 * Set the return value. Null out any unused entries in i_tab.
204 *ipp1 = *ipp2 = NULL;
205 for (i=0; i < *num_inodes; i++) {
206 if (i_tab[i]->i_ino == inum1) {
209 if (i_tab[i]->i_ino == inum2) {
224 bhv_desc_t *src_dir_bdp,
225 bhv_vname_t *src_vname,
226 bhv_vnode_t *target_dir_vp,
227 bhv_vname_t *target_vname,
231 xfs_inode_t *src_dp, *target_dp, *src_ip, *target_ip;
233 int new_parent; /* moving to a new dir */
234 int src_is_directory; /* src_name is a directory */
236 xfs_bmap_free_t free_list;
237 xfs_fsblock_t first_block;
240 xfs_inode_t *inodes[4];
241 int target_ip_dropped = 0; /* dropped target_ip link? */
242 bhv_vnode_t *src_dir_vp;
244 int target_link_zero = 0;
246 char *src_name = VNAME(src_vname);
247 char *target_name = VNAME(target_vname);
248 int src_namelen = VNAMELEN(src_vname);
249 int target_namelen = VNAMELEN(target_vname);
251 src_dir_vp = BHV_TO_VNODE(src_dir_bdp);
252 vn_trace_entry(src_dir_vp, "xfs_rename", (inst_t *)__return_address);
253 vn_trace_entry(target_dir_vp, "xfs_rename", (inst_t *)__return_address);
256 * Find the XFS behavior descriptor for the target directory
257 * vnode since it was not handed to us.
259 target_dp = xfs_vtoi(target_dir_vp);
260 if (target_dp == NULL) {
261 return XFS_ERROR(EXDEV);
264 src_dp = XFS_BHVTOI(src_dir_bdp);
265 mp = src_dp->i_mount;
267 if (DM_EVENT_ENABLED(src_dp, DM_EVENT_RENAME) ||
268 DM_EVENT_ENABLED(target_dp, DM_EVENT_RENAME)) {
269 error = XFS_SEND_NAMESP(mp, DM_EVENT_RENAME,
270 src_dir_vp, DM_RIGHT_NULL,
271 target_dir_vp, DM_RIGHT_NULL,
272 src_name, target_name,
278 /* Return through std_return after this point. */
281 * Lock all the participating inodes. Depending upon whether
282 * the target_name exists in the target directory, and
283 * whether the target directory is the same as the source
284 * directory, we can lock from 2 to 4 inodes.
285 * xfs_lock_for_rename() will return ENOENT if src_name
286 * does not exist in the source directory.
289 error = xfs_lock_for_rename(src_dp, target_dp, src_vname,
290 target_vname, &src_ip, &target_ip, inodes,
295 * We have nothing locked, no inode references, and
296 * no transaction, so just get out.
301 ASSERT(src_ip != NULL);
303 if ((src_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
305 * Check for link count overflow on target_dp
307 if (target_ip == NULL && (src_dp != target_dp) &&
308 target_dp->i_d.di_nlink >= XFS_MAXLINK) {
309 error = XFS_ERROR(EMLINK);
310 xfs_rename_unlock4(inodes, XFS_ILOCK_SHARED);
316 * If we are using project inheritance, we only allow renames
317 * into our tree when the project IDs are the same; else the
318 * tree quota mechanism would be circumvented.
320 if (unlikely((target_dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT) &&
321 (target_dp->i_d.di_projid != src_ip->i_d.di_projid))) {
322 error = XFS_ERROR(EXDEV);
323 xfs_rename_unlock4(inodes, XFS_ILOCK_SHARED);
327 new_parent = (src_dp != target_dp);
328 src_is_directory = ((src_ip->i_d.di_mode & S_IFMT) == S_IFDIR);
331 * Drop the locks on our inodes so that we can start the transaction.
333 xfs_rename_unlock4(inodes, XFS_ILOCK_SHARED);
335 XFS_BMAP_INIT(&free_list, &first_block);
336 tp = xfs_trans_alloc(mp, XFS_TRANS_RENAME);
337 cancel_flags = XFS_TRANS_RELEASE_LOG_RES;
338 spaceres = XFS_RENAME_SPACE_RES(mp, target_namelen);
339 error = xfs_trans_reserve(tp, spaceres, XFS_RENAME_LOG_RES(mp), 0,
340 XFS_TRANS_PERM_LOG_RES, XFS_RENAME_LOG_COUNT);
341 if (error == ENOSPC) {
343 error = xfs_trans_reserve(tp, 0, XFS_RENAME_LOG_RES(mp), 0,
344 XFS_TRANS_PERM_LOG_RES, XFS_RENAME_LOG_COUNT);
347 xfs_trans_cancel(tp, 0);
352 * Attach the dquots to the inodes
354 if ((error = XFS_QM_DQVOPRENAME(mp, inodes))) {
355 xfs_trans_cancel(tp, cancel_flags);
360 * Reacquire the inode locks we dropped above.
362 xfs_lock_inodes(inodes, num_inodes, 0, XFS_ILOCK_EXCL);
365 * Join all the inodes to the transaction. From this point on,
366 * we can rely on either trans_commit or trans_cancel to unlock
367 * them. Note that we need to add a vnode reference to the
368 * directories since trans_commit & trans_cancel will decrement
369 * them when they unlock the inodes. Also, we need to be careful
370 * not to add an inode to the transaction more than once.
373 xfs_trans_ijoin(tp, src_dp, XFS_ILOCK_EXCL);
375 VN_HOLD(target_dir_vp);
376 xfs_trans_ijoin(tp, target_dp, XFS_ILOCK_EXCL);
378 if ((src_ip != src_dp) && (src_ip != target_dp)) {
379 xfs_trans_ijoin(tp, src_ip, XFS_ILOCK_EXCL);
381 if ((target_ip != NULL) &&
382 (target_ip != src_ip) &&
383 (target_ip != src_dp) &&
384 (target_ip != target_dp)) {
385 xfs_trans_ijoin(tp, target_ip, XFS_ILOCK_EXCL);
391 if (target_ip == NULL) {
393 * If there's no space reservation, check the entry will
394 * fit before actually inserting it.
397 (error = xfs_dir_canenter(tp, target_dp, target_name,
401 * If target does not exist and the rename crosses
402 * directories, adjust the target directory link count
403 * to account for the ".." reference from the new entry.
405 error = xfs_dir_createname(tp, target_dp, target_name,
406 target_namelen, src_ip->i_ino,
407 &first_block, &free_list, spaceres);
412 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
414 if (new_parent && src_is_directory) {
415 error = xfs_bumplink(tp, target_dp);
419 } else { /* target_ip != NULL */
421 * If target exists and it's a directory, check that both
422 * target and source are directories and that target can be
423 * destroyed, or that neither is a directory.
425 if ((target_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
427 * Make sure target dir is empty.
429 if (!(xfs_dir_isempty(target_ip)) ||
430 (target_ip->i_d.di_nlink > 2)) {
431 error = XFS_ERROR(EEXIST);
437 * Link the source inode under the target name.
438 * If the source inode is a directory and we are moving
439 * it across directories, its ".." entry will be
440 * inconsistent until we replace that down below.
442 * In case there is already an entry with the same
443 * name at the destination directory, remove it first.
445 error = xfs_dir_replace(tp, target_dp, target_name,
446 target_namelen, src_ip->i_ino,
447 &first_block, &free_list, spaceres);
450 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
453 * Decrement the link count on the target since the target
454 * dir no longer points to it.
456 error = xfs_droplink(tp, target_ip);
459 target_ip_dropped = 1;
461 if (src_is_directory) {
463 * Drop the link from the old "." entry.
465 error = xfs_droplink(tp, target_ip);
470 /* Do this test while we still hold the locks */
471 target_link_zero = (target_ip)->i_d.di_nlink==0;
473 } /* target_ip != NULL */
478 if (new_parent && src_is_directory) {
480 * Rewrite the ".." entry to point to the new
483 error = xfs_dir_replace(tp, src_ip, "..", 2, target_dp->i_ino,
484 &first_block, &free_list, spaceres);
485 ASSERT(error != EEXIST);
488 xfs_ichgtime(src_ip, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
492 * We always want to hit the ctime on the source inode.
493 * We do it in the if clause above for the 'new_parent &&
494 * src_is_directory' case, and here we get all the other
495 * cases. This isn't strictly required by the standards
496 * since the source inode isn't really being changed,
497 * but old unix file systems did it and some incremental
498 * backup programs won't work without it.
500 xfs_ichgtime(src_ip, XFS_ICHGTIME_CHG);
504 * Adjust the link count on src_dp. This is necessary when
505 * renaming a directory, either within one parent when
506 * the target existed, or across two parent directories.
508 if (src_is_directory && (new_parent || target_ip != NULL)) {
511 * Decrement link count on src_directory since the
512 * entry that's moved no longer points to it.
514 error = xfs_droplink(tp, src_dp);
519 error = xfs_dir_removename(tp, src_dp, src_name, src_namelen,
520 src_ip->i_ino, &first_block, &free_list, spaceres);
523 xfs_ichgtime(src_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
526 * Update the generation counts on all the directory inodes
527 * that we're modifying.
530 xfs_trans_log_inode(tp, src_dp, XFS_ILOG_CORE);
534 xfs_trans_log_inode(tp, target_dp, XFS_ILOG_CORE);
538 * If there was a target inode, take an extra reference on
539 * it here so that it doesn't go to xfs_inactive() from
542 if (target_ip != NULL) {
547 * If this is a synchronous mount, make sure that the
548 * rename transaction goes to disk before returning to
551 if (mp->m_flags & (XFS_MOUNT_WSYNC|XFS_MOUNT_DIRSYNC)) {
552 xfs_trans_set_sync(tp);
556 * Take refs. for vop_link_removed calls below. No need to worry
557 * about directory refs. because the caller holds them.
559 * Do holds before the xfs_bmap_finish since it might rele them down
563 if (target_ip_dropped)
567 error = xfs_bmap_finish(&tp, &free_list, &committed);
569 xfs_bmap_cancel(&free_list);
570 xfs_trans_cancel(tp, (XFS_TRANS_RELEASE_LOG_RES |
572 if (target_ip != NULL) {
575 if (target_ip_dropped) {
583 * trans_commit will unlock src_ip, target_ip & decrement
584 * the vnode references.
586 error = xfs_trans_commit(tp, XFS_TRANS_RELEASE_LOG_RES);
587 if (target_ip != NULL) {
588 xfs_refcache_purge_ip(target_ip);
592 * Let interposed file systems know about removed links.
594 if (target_ip_dropped) {
595 bhv_vop_link_removed(XFS_ITOV(target_ip), target_dir_vp,
602 /* Fall through to std_return with error = 0 or errno from
603 * xfs_trans_commit */
605 if (DM_EVENT_ENABLED(src_dp, DM_EVENT_POSTRENAME) ||
606 DM_EVENT_ENABLED(target_dp, DM_EVENT_POSTRENAME)) {
607 (void) XFS_SEND_NAMESP (mp, DM_EVENT_POSTRENAME,
608 src_dir_vp, DM_RIGHT_NULL,
609 target_dir_vp, DM_RIGHT_NULL,
610 src_name, target_name,
616 cancel_flags |= XFS_TRANS_ABORT;
619 xfs_bmap_cancel(&free_list);
620 xfs_trans_cancel(tp, cancel_flags);
625 if (target_ip != NULL) {