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_dir_vp
->v_vfsp
, src_dp
, DM_EVENT_RENAME
) ||
268 DM_EVENT_ENABLED(target_dir_vp
->v_vfsp
,
269 target_dp
, DM_EVENT_RENAME
)) {
270 error
= XFS_SEND_NAMESP(mp
, DM_EVENT_RENAME
,
271 src_dir_vp
, DM_RIGHT_NULL
,
272 target_dir_vp
, DM_RIGHT_NULL
,
273 src_name
, target_name
,
279 /* Return through std_return after this point. */
282 * Lock all the participating inodes. Depending upon whether
283 * the target_name exists in the target directory, and
284 * whether the target directory is the same as the source
285 * directory, we can lock from 2 to 4 inodes.
286 * xfs_lock_for_rename() will return ENOENT if src_name
287 * does not exist in the source directory.
290 error
= xfs_lock_for_rename(src_dp
, target_dp
, src_vname
,
291 target_vname
, &src_ip
, &target_ip
, inodes
,
296 * We have nothing locked, no inode references, and
297 * no transaction, so just get out.
302 ASSERT(src_ip
!= NULL
);
304 if ((src_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
) {
306 * Check for link count overflow on target_dp
308 if (target_ip
== NULL
&& (src_dp
!= target_dp
) &&
309 target_dp
->i_d
.di_nlink
>= XFS_MAXLINK
) {
310 error
= XFS_ERROR(EMLINK
);
311 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
317 * If we are using project inheritance, we only allow renames
318 * into our tree when the project IDs are the same; else the
319 * tree quota mechanism would be circumvented.
321 if (unlikely((target_dp
->i_d
.di_flags
& XFS_DIFLAG_PROJINHERIT
) &&
322 (target_dp
->i_d
.di_projid
!= src_ip
->i_d
.di_projid
))) {
323 error
= XFS_ERROR(EXDEV
);
324 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
328 new_parent
= (src_dp
!= target_dp
);
329 src_is_directory
= ((src_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
);
332 * Drop the locks on our inodes so that we can start the transaction.
334 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
336 XFS_BMAP_INIT(&free_list
, &first_block
);
337 tp
= xfs_trans_alloc(mp
, XFS_TRANS_RENAME
);
338 cancel_flags
= XFS_TRANS_RELEASE_LOG_RES
;
339 spaceres
= XFS_RENAME_SPACE_RES(mp
, target_namelen
);
340 error
= xfs_trans_reserve(tp
, spaceres
, XFS_RENAME_LOG_RES(mp
), 0,
341 XFS_TRANS_PERM_LOG_RES
, XFS_RENAME_LOG_COUNT
);
342 if (error
== ENOSPC
) {
344 error
= xfs_trans_reserve(tp
, 0, XFS_RENAME_LOG_RES(mp
), 0,
345 XFS_TRANS_PERM_LOG_RES
, XFS_RENAME_LOG_COUNT
);
348 xfs_trans_cancel(tp
, 0);
353 * Attach the dquots to the inodes
355 if ((error
= XFS_QM_DQVOPRENAME(mp
, inodes
))) {
356 xfs_trans_cancel(tp
, cancel_flags
);
361 * Reacquire the inode locks we dropped above.
363 xfs_lock_inodes(inodes
, num_inodes
, 0, XFS_ILOCK_EXCL
);
366 * Join all the inodes to the transaction. From this point on,
367 * we can rely on either trans_commit or trans_cancel to unlock
368 * them. Note that we need to add a vnode reference to the
369 * directories since trans_commit & trans_cancel will decrement
370 * them when they unlock the inodes. Also, we need to be careful
371 * not to add an inode to the transaction more than once.
374 xfs_trans_ijoin(tp
, src_dp
, XFS_ILOCK_EXCL
);
376 VN_HOLD(target_dir_vp
);
377 xfs_trans_ijoin(tp
, target_dp
, XFS_ILOCK_EXCL
);
379 if ((src_ip
!= src_dp
) && (src_ip
!= target_dp
)) {
380 xfs_trans_ijoin(tp
, src_ip
, XFS_ILOCK_EXCL
);
382 if ((target_ip
!= NULL
) &&
383 (target_ip
!= src_ip
) &&
384 (target_ip
!= src_dp
) &&
385 (target_ip
!= target_dp
)) {
386 xfs_trans_ijoin(tp
, target_ip
, XFS_ILOCK_EXCL
);
392 if (target_ip
== NULL
) {
394 * If there's no space reservation, check the entry will
395 * fit before actually inserting it.
398 (error
= xfs_dir_canenter(tp
, target_dp
, target_name
,
402 * If target does not exist and the rename crosses
403 * directories, adjust the target directory link count
404 * to account for the ".." reference from the new entry.
406 error
= xfs_dir_createname(tp
, target_dp
, target_name
,
407 target_namelen
, src_ip
->i_ino
,
408 &first_block
, &free_list
, spaceres
);
413 xfs_ichgtime(target_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
415 if (new_parent
&& src_is_directory
) {
416 error
= xfs_bumplink(tp
, target_dp
);
420 } else { /* target_ip != NULL */
422 * If target exists and it's a directory, check that both
423 * target and source are directories and that target can be
424 * destroyed, or that neither is a directory.
426 if ((target_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
) {
428 * Make sure target dir is empty.
430 if (!(xfs_dir_isempty(target_ip
)) ||
431 (target_ip
->i_d
.di_nlink
> 2)) {
432 error
= XFS_ERROR(EEXIST
);
438 * Link the source inode under the target name.
439 * If the source inode is a directory and we are moving
440 * it across directories, its ".." entry will be
441 * inconsistent until we replace that down below.
443 * In case there is already an entry with the same
444 * name at the destination directory, remove it first.
446 error
= xfs_dir_replace(tp
, target_dp
, target_name
,
447 target_namelen
, src_ip
->i_ino
,
448 &first_block
, &free_list
, spaceres
);
451 xfs_ichgtime(target_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
454 * Decrement the link count on the target since the target
455 * dir no longer points to it.
457 error
= xfs_droplink(tp
, target_ip
);
460 target_ip_dropped
= 1;
462 if (src_is_directory
) {
464 * Drop the link from the old "." entry.
466 error
= xfs_droplink(tp
, target_ip
);
471 /* Do this test while we still hold the locks */
472 target_link_zero
= (target_ip
)->i_d
.di_nlink
==0;
474 } /* target_ip != NULL */
479 if (new_parent
&& src_is_directory
) {
481 * Rewrite the ".." entry to point to the new
484 error
= xfs_dir_replace(tp
, src_ip
, "..", 2, target_dp
->i_ino
,
485 &first_block
, &free_list
, spaceres
);
486 ASSERT(error
!= EEXIST
);
489 xfs_ichgtime(src_ip
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
493 * We always want to hit the ctime on the source inode.
494 * We do it in the if clause above for the 'new_parent &&
495 * src_is_directory' case, and here we get all the other
496 * cases. This isn't strictly required by the standards
497 * since the source inode isn't really being changed,
498 * but old unix file systems did it and some incremental
499 * backup programs won't work without it.
501 xfs_ichgtime(src_ip
, XFS_ICHGTIME_CHG
);
505 * Adjust the link count on src_dp. This is necessary when
506 * renaming a directory, either within one parent when
507 * the target existed, or across two parent directories.
509 if (src_is_directory
&& (new_parent
|| target_ip
!= NULL
)) {
512 * Decrement link count on src_directory since the
513 * entry that's moved no longer points to it.
515 error
= xfs_droplink(tp
, src_dp
);
520 error
= xfs_dir_removename(tp
, src_dp
, src_name
, src_namelen
,
521 src_ip
->i_ino
, &first_block
, &free_list
, spaceres
);
524 xfs_ichgtime(src_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
527 * Update the generation counts on all the directory inodes
528 * that we're modifying.
531 xfs_trans_log_inode(tp
, src_dp
, XFS_ILOG_CORE
);
535 xfs_trans_log_inode(tp
, target_dp
, XFS_ILOG_CORE
);
539 * If there was a target inode, take an extra reference on
540 * it here so that it doesn't go to xfs_inactive() from
543 if (target_ip
!= NULL
) {
548 * If this is a synchronous mount, make sure that the
549 * rename transaction goes to disk before returning to
552 if (mp
->m_flags
& (XFS_MOUNT_WSYNC
|XFS_MOUNT_DIRSYNC
)) {
553 xfs_trans_set_sync(tp
);
557 * Take refs. for vop_link_removed calls below. No need to worry
558 * about directory refs. because the caller holds them.
560 * Do holds before the xfs_bmap_finish since it might rele them down
564 if (target_ip_dropped
)
568 error
= xfs_bmap_finish(&tp
, &free_list
, &committed
);
570 xfs_bmap_cancel(&free_list
);
571 xfs_trans_cancel(tp
, (XFS_TRANS_RELEASE_LOG_RES
|
573 if (target_ip
!= NULL
) {
576 if (target_ip_dropped
) {
584 * trans_commit will unlock src_ip, target_ip & decrement
585 * the vnode references.
587 error
= xfs_trans_commit(tp
, XFS_TRANS_RELEASE_LOG_RES
);
588 if (target_ip
!= NULL
) {
589 xfs_refcache_purge_ip(target_ip
);
593 * Let interposed file systems know about removed links.
595 if (target_ip_dropped
) {
596 bhv_vop_link_removed(XFS_ITOV(target_ip
), target_dir_vp
,
603 /* Fall through to std_return with error = 0 or errno from
604 * xfs_trans_commit */
606 if (DM_EVENT_ENABLED(src_dir_vp
->v_vfsp
, src_dp
, DM_EVENT_POSTRENAME
) ||
607 DM_EVENT_ENABLED(target_dir_vp
->v_vfsp
,
608 target_dp
, DM_EVENT_POSTRENAME
)) {
609 (void) XFS_SEND_NAMESP (mp
, DM_EVENT_POSTRENAME
,
610 src_dir_vp
, DM_RIGHT_NULL
,
611 target_dir_vp
, DM_RIGHT_NULL
,
612 src_name
, target_name
,
618 cancel_flags
|= XFS_TRANS_ABORT
;
621 xfs_bmap_cancel(&free_list
);
622 xfs_trans_cancel(tp
, cancel_flags
);
627 if (target_ip
!= NULL
) {