Merge branch 'master'
[linux-2.6] / fs / xfs / xfs_rename.c
1 /*
2  * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
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.
8  *
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.
13  *
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
17  */
18 #include "xfs.h"
19 #include "xfs_fs.h"
20 #include "xfs_types.h"
21 #include "xfs_log.h"
22 #include "xfs_inum.h"
23 #include "xfs_trans.h"
24 #include "xfs_sb.h"
25 #include "xfs_dir.h"
26 #include "xfs_dir2.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_dir_sf.h"
32 #include "xfs_dir2_sf.h"
33 #include "xfs_attr_sf.h"
34 #include "xfs_dinode.h"
35 #include "xfs_inode.h"
36 #include "xfs_inode_item.h"
37 #include "xfs_bmap.h"
38 #include "xfs_error.h"
39 #include "xfs_quota.h"
40 #include "xfs_refcache.h"
41 #include "xfs_utils.h"
42 #include "xfs_trans_space.h"
43 #include "xfs_dir_leaf.h"
44
45
46 /*
47  * Given an array of up to 4 inode pointers, unlock the pointed to inodes.
48  * If there are fewer than 4 entries in the array, the empty entries will
49  * be at the end and will have NULL pointers in them.
50  */
51 STATIC void
52 xfs_rename_unlock4(
53         xfs_inode_t     **i_tab,
54         uint            lock_mode)
55 {
56         int     i;
57
58         xfs_iunlock(i_tab[0], lock_mode);
59         for (i = 1; i < 4; i++) {
60                 if (i_tab[i] == NULL) {
61                         break;
62                 }
63                 /*
64                  * Watch out for duplicate entries in the table.
65                  */
66                 if (i_tab[i] != i_tab[i-1]) {
67                         xfs_iunlock(i_tab[i], lock_mode);
68                 }
69         }
70 }
71
72 #ifdef DEBUG
73 int xfs_rename_skip, xfs_rename_nskip;
74 #endif
75
76 /*
77  * The following routine will acquire the locks required for a rename
78  * operation. The code understands the semantics of renames and will
79  * validate that name1 exists under dp1 & that name2 may or may not
80  * exist under dp2.
81  *
82  * We are renaming dp1/name1 to dp2/name2.
83  *
84  * Return ENOENT if dp1 does not exist, other lookup errors, or 0 for success.
85  */
86 STATIC int
87 xfs_lock_for_rename(
88         xfs_inode_t     *dp1,   /* old (source) directory inode */
89         xfs_inode_t     *dp2,   /* new (target) directory inode */
90         vname_t         *vname1,/* old entry name */
91         vname_t         *vname2,/* new entry name */
92         xfs_inode_t     **ipp1, /* inode of old entry */
93         xfs_inode_t     **ipp2, /* inode of new entry, if it
94                                    already exists, NULL otherwise. */
95         xfs_inode_t     **i_tab,/* array of inode returned, sorted */
96         int             *num_inodes)  /* number of inodes in array */
97 {
98         xfs_inode_t             *ip1, *ip2, *temp;
99         xfs_ino_t               inum1, inum2;
100         int                     error;
101         int                     i, j;
102         uint                    lock_mode;
103         int                     diff_dirs = (dp1 != dp2);
104
105         ip2 = NULL;
106
107         /*
108          * First, find out the current inums of the entries so that we
109          * can determine the initial locking order.  We'll have to
110          * sanity check stuff after all the locks have been acquired
111          * to see if we still have the right inodes, directories, etc.
112          */
113         lock_mode = xfs_ilock_map_shared(dp1);
114         error = xfs_get_dir_entry(vname1, &ip1);
115         if (error) {
116                 xfs_iunlock_map_shared(dp1, lock_mode);
117                 return error;
118         }
119
120         inum1 = ip1->i_ino;
121
122         ASSERT(ip1);
123         ITRACE(ip1);
124
125         /*
126          * Unlock dp1 and lock dp2 if they are different.
127          */
128
129         if (diff_dirs) {
130                 xfs_iunlock_map_shared(dp1, lock_mode);
131                 lock_mode = xfs_ilock_map_shared(dp2);
132         }
133
134         error = xfs_dir_lookup_int(XFS_ITOBHV(dp2), lock_mode,
135                                    vname2, &inum2, &ip2);
136         if (error == ENOENT) {          /* target does not need to exist. */
137                 inum2 = 0;
138         } else if (error) {
139                 /*
140                  * If dp2 and dp1 are the same, the next line unlocks dp1.
141                  * Got it?
142                  */
143                 xfs_iunlock_map_shared(dp2, lock_mode);
144                 IRELE (ip1);
145                 return error;
146         } else {
147                 ITRACE(ip2);
148         }
149
150         /*
151          * i_tab contains a list of pointers to inodes.  We initialize
152          * the table here & we'll sort it.  We will then use it to
153          * order the acquisition of the inode locks.
154          *
155          * Note that the table may contain duplicates.  e.g., dp1 == dp2.
156          */
157         i_tab[0] = dp1;
158         i_tab[1] = dp2;
159         i_tab[2] = ip1;
160         if (inum2 == 0) {
161                 *num_inodes = 3;
162                 i_tab[3] = NULL;
163         } else {
164                 *num_inodes = 4;
165                 i_tab[3] = ip2;
166         }
167
168         /*
169          * Sort the elements via bubble sort.  (Remember, there are at
170          * most 4 elements to sort, so this is adequate.)
171          */
172         for (i=0; i < *num_inodes; i++) {
173                 for (j=1; j < *num_inodes; j++) {
174                         if (i_tab[j]->i_ino < i_tab[j-1]->i_ino) {
175                                 temp = i_tab[j];
176                                 i_tab[j] = i_tab[j-1];
177                                 i_tab[j-1] = temp;
178                         }
179                 }
180         }
181
182         /*
183          * We have dp2 locked. If it isn't first, unlock it.
184          * If it is first, tell xfs_lock_inodes so it can skip it
185          * when locking. if dp1 == dp2, xfs_lock_inodes will skip both
186          * since they are equal. xfs_lock_inodes needs all these inodes
187          * so that it can unlock and retry if there might be a dead-lock
188          * potential with the log.
189          */
190
191         if (i_tab[0] == dp2 && lock_mode == XFS_ILOCK_SHARED) {
192 #ifdef DEBUG
193                 xfs_rename_skip++;
194 #endif
195                 xfs_lock_inodes(i_tab, *num_inodes, 1, XFS_ILOCK_SHARED);
196         } else {
197 #ifdef DEBUG
198                 xfs_rename_nskip++;
199 #endif
200                 xfs_iunlock_map_shared(dp2, lock_mode);
201                 xfs_lock_inodes(i_tab, *num_inodes, 0, XFS_ILOCK_SHARED);
202         }
203
204         /*
205          * Set the return value. Null out any unused entries in i_tab.
206          */
207         *ipp1 = *ipp2 = NULL;
208         for (i=0; i < *num_inodes; i++) {
209                 if (i_tab[i]->i_ino == inum1) {
210                         *ipp1 = i_tab[i];
211                 }
212                 if (i_tab[i]->i_ino == inum2) {
213                         *ipp2 = i_tab[i];
214                 }
215         }
216         for (;i < 4; i++) {
217                 i_tab[i] = NULL;
218         }
219         return 0;
220 }
221
222 /*
223  * xfs_rename
224  */
225 int
226 xfs_rename(
227         bhv_desc_t      *src_dir_bdp,
228         vname_t         *src_vname,
229         vnode_t         *target_dir_vp,
230         vname_t         *target_vname,
231         cred_t          *credp)
232 {
233         xfs_trans_t     *tp;
234         xfs_inode_t     *src_dp, *target_dp, *src_ip, *target_ip;
235         xfs_mount_t     *mp;
236         int             new_parent;             /* moving to a new dir */
237         int             src_is_directory;       /* src_name is a directory */
238         int             error;
239         xfs_bmap_free_t free_list;
240         xfs_fsblock_t   first_block;
241         int             cancel_flags;
242         int             committed;
243         xfs_inode_t     *inodes[4];
244         int             target_ip_dropped = 0;  /* dropped target_ip link? */
245         vnode_t         *src_dir_vp;
246         bhv_desc_t      *target_dir_bdp;
247         int             spaceres;
248         int             target_link_zero = 0;
249         int             num_inodes;
250         char            *src_name = VNAME(src_vname);
251         char            *target_name = VNAME(target_vname);
252         int             src_namelen = VNAMELEN(src_vname);
253         int             target_namelen = VNAMELEN(target_vname);
254
255         src_dir_vp = BHV_TO_VNODE(src_dir_bdp);
256         vn_trace_entry(src_dir_vp, "xfs_rename", (inst_t *)__return_address);
257         vn_trace_entry(target_dir_vp, "xfs_rename", (inst_t *)__return_address);
258
259         /*
260          * Find the XFS behavior descriptor for the target directory
261          * vnode since it was not handed to us.
262          */
263         target_dir_bdp = vn_bhv_lookup_unlocked(VN_BHV_HEAD(target_dir_vp),
264                                                 &xfs_vnodeops);
265         if (target_dir_bdp == NULL) {
266                 return XFS_ERROR(EXDEV);
267         }
268
269         src_dp = XFS_BHVTOI(src_dir_bdp);
270         target_dp = XFS_BHVTOI(target_dir_bdp);
271         mp = src_dp->i_mount;
272
273         if (DM_EVENT_ENABLED(src_dir_vp->v_vfsp, src_dp, DM_EVENT_RENAME) ||
274             DM_EVENT_ENABLED(target_dir_vp->v_vfsp,
275                                 target_dp, DM_EVENT_RENAME)) {
276                 error = XFS_SEND_NAMESP(mp, DM_EVENT_RENAME,
277                                         src_dir_vp, DM_RIGHT_NULL,
278                                         target_dir_vp, DM_RIGHT_NULL,
279                                         src_name, target_name,
280                                         0, 0, 0);
281                 if (error) {
282                         return error;
283                 }
284         }
285         /* Return through std_return after this point. */
286
287         /*
288          * Lock all the participating inodes. Depending upon whether
289          * the target_name exists in the target directory, and
290          * whether the target directory is the same as the source
291          * directory, we can lock from 2 to 4 inodes.
292          * xfs_lock_for_rename() will return ENOENT if src_name
293          * does not exist in the source directory.
294          */
295         tp = NULL;
296         error = xfs_lock_for_rename(src_dp, target_dp, src_vname,
297                         target_vname, &src_ip, &target_ip, inodes,
298                         &num_inodes);
299
300         if (error) {
301                 /*
302                  * We have nothing locked, no inode references, and
303                  * no transaction, so just get out.
304                  */
305                 goto std_return;
306         }
307
308         ASSERT(src_ip != NULL);
309
310         if ((src_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
311                 /*
312                  * Check for link count overflow on target_dp
313                  */
314                 if (target_ip == NULL && (src_dp != target_dp) &&
315                     target_dp->i_d.di_nlink >= XFS_MAXLINK) {
316                         error = XFS_ERROR(EMLINK);
317                         xfs_rename_unlock4(inodes, XFS_ILOCK_SHARED);
318                         goto rele_return;
319                 }
320         }
321
322         new_parent = (src_dp != target_dp);
323         src_is_directory = ((src_ip->i_d.di_mode & S_IFMT) == S_IFDIR);
324
325         /*
326          * Drop the locks on our inodes so that we can start the transaction.
327          */
328         xfs_rename_unlock4(inodes, XFS_ILOCK_SHARED);
329
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) {
337                 spaceres = 0;
338                 error = xfs_trans_reserve(tp, 0, XFS_RENAME_LOG_RES(mp), 0,
339                                 XFS_TRANS_PERM_LOG_RES, XFS_RENAME_LOG_COUNT);
340         }
341         if (error) {
342                 xfs_trans_cancel(tp, 0);
343                 goto rele_return;
344         }
345
346         /*
347          * Attach the dquots to the inodes
348          */
349         if ((error = XFS_QM_DQVOPRENAME(mp, inodes))) {
350                 xfs_trans_cancel(tp, cancel_flags);
351                 goto rele_return;
352         }
353
354         /*
355          * Reacquire the inode locks we dropped above.
356          */
357         xfs_lock_inodes(inodes, num_inodes, 0, XFS_ILOCK_EXCL);
358
359         /*
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.
366          */
367         VN_HOLD(src_dir_vp);
368         xfs_trans_ijoin(tp, src_dp, XFS_ILOCK_EXCL);
369         if (new_parent) {
370                 VN_HOLD(target_dir_vp);
371                 xfs_trans_ijoin(tp, target_dp, XFS_ILOCK_EXCL);
372         }
373         if ((src_ip != src_dp) && (src_ip != target_dp)) {
374                 xfs_trans_ijoin(tp, src_ip, XFS_ILOCK_EXCL);
375         }
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);
381         }
382
383         /*
384          * Set up the target.
385          */
386         if (target_ip == NULL) {
387                 /*
388                  * If there's no space reservation, check the entry will
389                  * fit before actually inserting it.
390                  */
391                 if (spaceres == 0 &&
392                     (error = XFS_DIR_CANENTER(mp, tp, target_dp, target_name,
393                                 target_namelen))) {
394                         goto error_return;
395                 }
396                 /*
397                  * If target does not exist and the rename crosses
398                  * directories, adjust the target directory link count
399                  * to account for the ".." reference from the new entry.
400                  */
401                 error = XFS_DIR_CREATENAME(mp, tp, target_dp, target_name,
402                                            target_namelen, src_ip->i_ino,
403                                            &first_block, &free_list, spaceres);
404                 if (error == ENOSPC) {
405                         goto error_return;
406                 }
407                 if (error) {
408                         goto abort_return;
409                 }
410                 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
411
412                 if (new_parent && src_is_directory) {
413                         error = xfs_bumplink(tp, target_dp);
414                         if (error) {
415                                 goto abort_return;
416                         }
417                 }
418         } else { /* target_ip != NULL */
419
420                 /*
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.
424                  */
425                 if ((target_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
426                         /*
427                          * Make sure target dir is empty.
428                          */
429                         if (!(XFS_DIR_ISEMPTY(target_ip->i_mount, target_ip)) ||
430                             (target_ip->i_d.di_nlink > 2)) {
431                                 error = XFS_ERROR(EEXIST);
432                                 goto error_return;
433                         }
434                 }
435
436                 /*
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.
441                  *
442                  * In case there is already an entry with the same
443                  * name at the destination directory, remove it first.
444                  */
445                 error = XFS_DIR_REPLACE(mp, tp, target_dp, target_name,
446                         target_namelen, src_ip->i_ino, &first_block,
447                         &free_list, spaceres);
448                 if (error) {
449                         goto abort_return;
450                 }
451                 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
452
453                 /*
454                  * Decrement the link count on the target since the target
455                  * dir no longer points to it.
456                  */
457                 error = xfs_droplink(tp, target_ip);
458                 if (error) {
459                         goto abort_return;
460                 }
461                 target_ip_dropped = 1;
462
463                 if (src_is_directory) {
464                         /*
465                          * Drop the link from the old "." entry.
466                          */
467                         error = xfs_droplink(tp, target_ip);
468                         if (error) {
469                                 goto abort_return;
470                         }
471                 }
472
473                 /* Do this test while we still hold the locks */
474                 target_link_zero = (target_ip)->i_d.di_nlink==0;
475
476         } /* target_ip != NULL */
477
478         /*
479          * Remove the source.
480          */
481         if (new_parent && src_is_directory) {
482
483                 /*
484                  * Rewrite the ".." entry to point to the new
485                  * directory.
486                  */
487                 error = XFS_DIR_REPLACE(mp, tp, src_ip, "..", 2,
488                                         target_dp->i_ino, &first_block,
489                                         &free_list, spaceres);
490                 ASSERT(error != EEXIST);
491                 if (error) {
492                         goto abort_return;
493                 }
494                 xfs_ichgtime(src_ip, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
495
496         } else {
497                 /*
498                  * We always want to hit the ctime on the source inode.
499                  * We do it in the if clause above for the 'new_parent &&
500                  * src_is_directory' case, and here we get all the other
501                  * cases.  This isn't strictly required by the standards
502                  * since the source inode isn't really being changed,
503                  * but old unix file systems did it and some incremental
504                  * backup programs won't work without it.
505                  */
506                 xfs_ichgtime(src_ip, XFS_ICHGTIME_CHG);
507         }
508
509         /*
510          * Adjust the link count on src_dp.  This is necessary when
511          * renaming a directory, either within one parent when
512          * the target existed, or across two parent directories.
513          */
514         if (src_is_directory && (new_parent || target_ip != NULL)) {
515
516                 /*
517                  * Decrement link count on src_directory since the
518                  * entry that's moved no longer points to it.
519                  */
520                 error = xfs_droplink(tp, src_dp);
521                 if (error) {
522                         goto abort_return;
523                 }
524         }
525
526         error = XFS_DIR_REMOVENAME(mp, tp, src_dp, src_name, src_namelen,
527                         src_ip->i_ino, &first_block, &free_list, spaceres);
528         if (error) {
529                 goto abort_return;
530         }
531         xfs_ichgtime(src_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
532
533         /*
534          * Update the generation counts on all the directory inodes
535          * that we're modifying.
536          */
537         src_dp->i_gen++;
538         xfs_trans_log_inode(tp, src_dp, XFS_ILOG_CORE);
539
540         if (new_parent) {
541                 target_dp->i_gen++;
542                 xfs_trans_log_inode(tp, target_dp, XFS_ILOG_CORE);
543         }
544
545         /*
546          * If there was a target inode, take an extra reference on
547          * it here so that it doesn't go to xfs_inactive() from
548          * within the commit.
549          */
550         if (target_ip != NULL) {
551                 IHOLD(target_ip);
552         }
553
554         /*
555          * If this is a synchronous mount, make sure that the
556          * rename transaction goes to disk before returning to
557          * the user.
558          */
559         if (mp->m_flags & (XFS_MOUNT_WSYNC|XFS_MOUNT_DIRSYNC)) {
560                 xfs_trans_set_sync(tp);
561         }
562
563         /*
564          * Take refs. for vop_link_removed calls below.  No need to worry
565          * about directory refs. because the caller holds them.
566          *
567          * Do holds before the xfs_bmap_finish since it might rele them down
568          * to zero.
569          */
570
571         if (target_ip_dropped)
572                 IHOLD(target_ip);
573         IHOLD(src_ip);
574
575         error = xfs_bmap_finish(&tp, &free_list, first_block, &committed);
576         if (error) {
577                 xfs_bmap_cancel(&free_list);
578                 xfs_trans_cancel(tp, (XFS_TRANS_RELEASE_LOG_RES |
579                                  XFS_TRANS_ABORT));
580                 if (target_ip != NULL) {
581                         IRELE(target_ip);
582                 }
583                 if (target_ip_dropped) {
584                         IRELE(target_ip);
585                 }
586                 IRELE(src_ip);
587                 goto std_return;
588         }
589
590         /*
591          * trans_commit will unlock src_ip, target_ip & decrement
592          * the vnode references.
593          */
594         error = xfs_trans_commit(tp, XFS_TRANS_RELEASE_LOG_RES, NULL);
595         if (target_ip != NULL) {
596                 xfs_refcache_purge_ip(target_ip);
597                 IRELE(target_ip);
598         }
599         /*
600          * Let interposed file systems know about removed links.
601          */
602         if (target_ip_dropped) {
603                 VOP_LINK_REMOVED(XFS_ITOV(target_ip), target_dir_vp,
604                                         target_link_zero);
605                 IRELE(target_ip);
606         }
607
608         IRELE(src_ip);
609
610         /* Fall through to std_return with error = 0 or errno from
611          * xfs_trans_commit      */
612 std_return:
613         if (DM_EVENT_ENABLED(src_dir_vp->v_vfsp, src_dp, DM_EVENT_POSTRENAME) ||
614             DM_EVENT_ENABLED(target_dir_vp->v_vfsp,
615                                 target_dp, DM_EVENT_POSTRENAME)) {
616                 (void) XFS_SEND_NAMESP (mp, DM_EVENT_POSTRENAME,
617                                         src_dir_vp, DM_RIGHT_NULL,
618                                         target_dir_vp, DM_RIGHT_NULL,
619                                         src_name, target_name,
620                                         0, error, 0);
621         }
622         return error;
623
624  abort_return:
625         cancel_flags |= XFS_TRANS_ABORT;
626         /* FALLTHROUGH */
627  error_return:
628         xfs_bmap_cancel(&free_list);
629         xfs_trans_cancel(tp, cancel_flags);
630         goto std_return;
631
632  rele_return:
633         IRELE(src_ip);
634         if (target_ip != NULL) {
635                 IRELE(target_ip);
636         }
637         goto std_return;
638 }