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"
27 #include "xfs_dmapi.h"
28 #include "xfs_mount.h"
29 #include "xfs_da_btree.h"
30 #include "xfs_bmap_btree.h"
31 #include "xfs_dir2_sf.h"
32 #include "xfs_attr_sf.h"
33 #include "xfs_dinode.h"
34 #include "xfs_inode.h"
35 #include "xfs_inode_item.h"
37 #include "xfs_error.h"
38 #include "xfs_quota.h"
39 #include "xfs_refcache.h"
40 #include "xfs_utils.h"
41 #include "xfs_trans_space.h"
45 * Given an array of up to 4 inode pointers, unlock the pointed to inodes.
46 * If there are fewer than 4 entries in the array, the empty entries will
47 * be at the end and will have NULL pointers in them.
56 xfs_iunlock(i_tab
[0], lock_mode
);
57 for (i
= 1; i
< 4; i
++) {
58 if (i_tab
[i
] == NULL
) {
62 * Watch out for duplicate entries in the table.
64 if (i_tab
[i
] != i_tab
[i
-1]) {
65 xfs_iunlock(i_tab
[i
], lock_mode
);
71 int xfs_rename_skip
, xfs_rename_nskip
;
75 * The following routine will acquire the locks required for a rename
76 * operation. The code understands the semantics of renames and will
77 * validate that name1 exists under dp1 & that name2 may or may not
80 * We are renaming dp1/name1 to dp2/name2.
82 * Return ENOENT if dp1 does not exist, other lookup errors, or 0 for success.
86 xfs_inode_t
*dp1
, /* old (source) directory inode */
87 xfs_inode_t
*dp2
, /* new (target) directory inode */
88 bhv_vname_t
*vname1
,/* old entry name */
89 bhv_vname_t
*vname2
,/* new entry name */
90 xfs_inode_t
**ipp1
, /* inode of old entry */
91 xfs_inode_t
**ipp2
, /* inode of new entry, if it
92 already exists, NULL otherwise. */
93 xfs_inode_t
**i_tab
,/* array of inode returned, sorted */
94 int *num_inodes
) /* number of inodes in array */
96 xfs_inode_t
*ip1
, *ip2
, *temp
;
97 xfs_ino_t inum1
, inum2
;
101 int diff_dirs
= (dp1
!= dp2
);
106 * First, find out the current inums of the entries so that we
107 * can determine the initial locking order. We'll have to
108 * sanity check stuff after all the locks have been acquired
109 * to see if we still have the right inodes, directories, etc.
111 lock_mode
= xfs_ilock_map_shared(dp1
);
112 error
= xfs_get_dir_entry(vname1
, &ip1
);
114 xfs_iunlock_map_shared(dp1
, lock_mode
);
124 * Unlock dp1 and lock dp2 if they are different.
128 xfs_iunlock_map_shared(dp1
, lock_mode
);
129 lock_mode
= xfs_ilock_map_shared(dp2
);
132 error
= xfs_dir_lookup_int(dp2
, lock_mode
, 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
) {
225 bhv_vname_t
*src_vname
,
226 bhv_vnode_t
*target_dir_vp
,
227 bhv_vname_t
*target_vname
)
229 bhv_vnode_t
*src_dir_vp
= XFS_ITOV(src_dp
);
231 xfs_inode_t
*target_dp
, *src_ip
, *target_ip
;
232 xfs_mount_t
*mp
= src_dp
->i_mount
;
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? */
243 int target_link_zero
= 0;
245 char *src_name
= VNAME(src_vname
);
246 char *target_name
= VNAME(target_vname
);
247 int src_namelen
= VNAMELEN(src_vname
);
248 int target_namelen
= VNAMELEN(target_vname
);
250 vn_trace_entry(src_dp
, "xfs_rename", (inst_t
*)__return_address
);
251 vn_trace_entry(xfs_vtoi(target_dir_vp
), "xfs_rename", (inst_t
*)__return_address
);
254 * Find the XFS behavior descriptor for the target directory
255 * vnode since it was not handed to us.
257 target_dp
= xfs_vtoi(target_dir_vp
);
258 if (target_dp
== NULL
) {
259 return XFS_ERROR(EXDEV
);
262 if (DM_EVENT_ENABLED(src_dp
, DM_EVENT_RENAME
) ||
263 DM_EVENT_ENABLED(target_dp
, DM_EVENT_RENAME
)) {
264 error
= XFS_SEND_NAMESP(mp
, DM_EVENT_RENAME
,
265 src_dir_vp
, DM_RIGHT_NULL
,
266 target_dir_vp
, DM_RIGHT_NULL
,
267 src_name
, target_name
,
273 /* Return through std_return after this point. */
276 * Lock all the participating inodes. Depending upon whether
277 * the target_name exists in the target directory, and
278 * whether the target directory is the same as the source
279 * directory, we can lock from 2 to 4 inodes.
280 * xfs_lock_for_rename() will return ENOENT if src_name
281 * does not exist in the source directory.
284 error
= xfs_lock_for_rename(src_dp
, target_dp
, src_vname
,
285 target_vname
, &src_ip
, &target_ip
, inodes
,
290 * We have nothing locked, no inode references, and
291 * no transaction, so just get out.
296 ASSERT(src_ip
!= NULL
);
298 if ((src_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
) {
300 * Check for link count overflow on target_dp
302 if (target_ip
== NULL
&& (src_dp
!= target_dp
) &&
303 target_dp
->i_d
.di_nlink
>= XFS_MAXLINK
) {
304 error
= XFS_ERROR(EMLINK
);
305 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
311 * If we are using project inheritance, we only allow renames
312 * into our tree when the project IDs are the same; else the
313 * tree quota mechanism would be circumvented.
315 if (unlikely((target_dp
->i_d
.di_flags
& XFS_DIFLAG_PROJINHERIT
) &&
316 (target_dp
->i_d
.di_projid
!= src_ip
->i_d
.di_projid
))) {
317 error
= XFS_ERROR(EXDEV
);
318 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
322 new_parent
= (src_dp
!= target_dp
);
323 src_is_directory
= ((src_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
);
326 * Drop the locks on our inodes so that we can start the transaction.
328 xfs_rename_unlock4(inodes
, XFS_ILOCK_SHARED
);
330 XFS_BMAP_INIT(&free_list
, &first_block
);
331 tp
= xfs_trans_alloc(mp
, XFS_TRANS_RENAME
);
332 cancel_flags
= XFS_TRANS_RELEASE_LOG_RES
;
333 spaceres
= XFS_RENAME_SPACE_RES(mp
, target_namelen
);
334 error
= xfs_trans_reserve(tp
, spaceres
, XFS_RENAME_LOG_RES(mp
), 0,
335 XFS_TRANS_PERM_LOG_RES
, XFS_RENAME_LOG_COUNT
);
336 if (error
== ENOSPC
) {
338 error
= xfs_trans_reserve(tp
, 0, XFS_RENAME_LOG_RES(mp
), 0,
339 XFS_TRANS_PERM_LOG_RES
, XFS_RENAME_LOG_COUNT
);
342 xfs_trans_cancel(tp
, 0);
347 * Attach the dquots to the inodes
349 if ((error
= XFS_QM_DQVOPRENAME(mp
, inodes
))) {
350 xfs_trans_cancel(tp
, cancel_flags
);
355 * Reacquire the inode locks we dropped above.
357 xfs_lock_inodes(inodes
, num_inodes
, 0, XFS_ILOCK_EXCL
);
360 * Join all the inodes to the transaction. From this point on,
361 * we can rely on either trans_commit or trans_cancel to unlock
362 * them. Note that we need to add a vnode reference to the
363 * directories since trans_commit & trans_cancel will decrement
364 * them when they unlock the inodes. Also, we need to be careful
365 * not to add an inode to the transaction more than once.
368 xfs_trans_ijoin(tp
, src_dp
, XFS_ILOCK_EXCL
);
370 VN_HOLD(target_dir_vp
);
371 xfs_trans_ijoin(tp
, target_dp
, XFS_ILOCK_EXCL
);
373 if ((src_ip
!= src_dp
) && (src_ip
!= target_dp
)) {
374 xfs_trans_ijoin(tp
, src_ip
, XFS_ILOCK_EXCL
);
376 if ((target_ip
!= NULL
) &&
377 (target_ip
!= src_ip
) &&
378 (target_ip
!= src_dp
) &&
379 (target_ip
!= target_dp
)) {
380 xfs_trans_ijoin(tp
, target_ip
, XFS_ILOCK_EXCL
);
386 if (target_ip
== NULL
) {
388 * If there's no space reservation, check the entry will
389 * fit before actually inserting it.
392 (error
= xfs_dir_canenter(tp
, target_dp
, target_name
,
396 * If target does not exist and the rename crosses
397 * directories, adjust the target directory link count
398 * to account for the ".." reference from the new entry.
400 error
= xfs_dir_createname(tp
, target_dp
, target_name
,
401 target_namelen
, src_ip
->i_ino
,
402 &first_block
, &free_list
, spaceres
);
407 xfs_ichgtime(target_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
409 if (new_parent
&& src_is_directory
) {
410 error
= xfs_bumplink(tp
, target_dp
);
414 } else { /* target_ip != NULL */
416 * If target exists and it's a directory, check that both
417 * target and source are directories and that target can be
418 * destroyed, or that neither is a directory.
420 if ((target_ip
->i_d
.di_mode
& S_IFMT
) == S_IFDIR
) {
422 * Make sure target dir is empty.
424 if (!(xfs_dir_isempty(target_ip
)) ||
425 (target_ip
->i_d
.di_nlink
> 2)) {
426 error
= XFS_ERROR(EEXIST
);
432 * Link the source inode under the target name.
433 * If the source inode is a directory and we are moving
434 * it across directories, its ".." entry will be
435 * inconsistent until we replace that down below.
437 * In case there is already an entry with the same
438 * name at the destination directory, remove it first.
440 error
= xfs_dir_replace(tp
, target_dp
, target_name
,
441 target_namelen
, src_ip
->i_ino
,
442 &first_block
, &free_list
, spaceres
);
445 xfs_ichgtime(target_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
448 * Decrement the link count on the target since the target
449 * dir no longer points to it.
451 error
= xfs_droplink(tp
, target_ip
);
454 target_ip_dropped
= 1;
456 if (src_is_directory
) {
458 * Drop the link from the old "." entry.
460 error
= xfs_droplink(tp
, target_ip
);
465 /* Do this test while we still hold the locks */
466 target_link_zero
= (target_ip
)->i_d
.di_nlink
==0;
468 } /* target_ip != NULL */
473 if (new_parent
&& src_is_directory
) {
475 * Rewrite the ".." entry to point to the new
478 error
= xfs_dir_replace(tp
, src_ip
, "..", 2, target_dp
->i_ino
,
479 &first_block
, &free_list
, spaceres
);
480 ASSERT(error
!= EEXIST
);
483 xfs_ichgtime(src_ip
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
487 * We always want to hit the ctime on the source inode.
488 * We do it in the if clause above for the 'new_parent &&
489 * src_is_directory' case, and here we get all the other
490 * cases. This isn't strictly required by the standards
491 * since the source inode isn't really being changed,
492 * but old unix file systems did it and some incremental
493 * backup programs won't work without it.
495 xfs_ichgtime(src_ip
, XFS_ICHGTIME_CHG
);
499 * Adjust the link count on src_dp. This is necessary when
500 * renaming a directory, either within one parent when
501 * the target existed, or across two parent directories.
503 if (src_is_directory
&& (new_parent
|| target_ip
!= NULL
)) {
506 * Decrement link count on src_directory since the
507 * entry that's moved no longer points to it.
509 error
= xfs_droplink(tp
, src_dp
);
514 error
= xfs_dir_removename(tp
, src_dp
, src_name
, src_namelen
,
515 src_ip
->i_ino
, &first_block
, &free_list
, spaceres
);
518 xfs_ichgtime(src_dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
521 * Update the generation counts on all the directory inodes
522 * that we're modifying.
525 xfs_trans_log_inode(tp
, src_dp
, XFS_ILOG_CORE
);
529 xfs_trans_log_inode(tp
, target_dp
, XFS_ILOG_CORE
);
533 * If there was a target inode, take an extra reference on
534 * it here so that it doesn't go to xfs_inactive() from
537 if (target_ip
!= NULL
) {
542 * If this is a synchronous mount, make sure that the
543 * rename transaction goes to disk before returning to
546 if (mp
->m_flags
& (XFS_MOUNT_WSYNC
|XFS_MOUNT_DIRSYNC
)) {
547 xfs_trans_set_sync(tp
);
551 * Take refs. for vop_link_removed calls below. No need to worry
552 * about directory refs. because the caller holds them.
554 * Do holds before the xfs_bmap_finish since it might rele them down
558 if (target_ip_dropped
)
562 error
= xfs_bmap_finish(&tp
, &free_list
, &committed
);
564 xfs_bmap_cancel(&free_list
);
565 xfs_trans_cancel(tp
, (XFS_TRANS_RELEASE_LOG_RES
|
567 if (target_ip
!= NULL
) {
570 if (target_ip_dropped
) {
578 * trans_commit will unlock src_ip, target_ip & decrement
579 * the vnode references.
581 error
= xfs_trans_commit(tp
, XFS_TRANS_RELEASE_LOG_RES
);
582 if (target_ip
!= NULL
) {
583 xfs_refcache_purge_ip(target_ip
);
587 * Let interposed file systems know about removed links.
589 if (target_ip_dropped
)
594 /* Fall through to std_return with error = 0 or errno from
595 * xfs_trans_commit */
597 if (DM_EVENT_ENABLED(src_dp
, DM_EVENT_POSTRENAME
) ||
598 DM_EVENT_ENABLED(target_dp
, DM_EVENT_POSTRENAME
)) {
599 (void) XFS_SEND_NAMESP (mp
, DM_EVENT_POSTRENAME
,
600 src_dir_vp
, DM_RIGHT_NULL
,
601 target_dir_vp
, DM_RIGHT_NULL
,
602 src_name
, target_name
,
608 cancel_flags
|= XFS_TRANS_ABORT
;
611 xfs_bmap_cancel(&free_list
);
612 xfs_trans_cancel(tp
, cancel_flags
);
617 if (target_ip
!= NULL
) {