Merge branch 'for-linus' of git://oss.sgi.com:8090/xfs/xfs-2.6
[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_ag.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_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"
36 #include "xfs_bmap.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"
42
43
44 /*
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.
48  */
49 STATIC void
50 xfs_rename_unlock4(
51         xfs_inode_t     **i_tab,
52         uint            lock_mode)
53 {
54         int     i;
55
56         xfs_iunlock(i_tab[0], lock_mode);
57         for (i = 1; i < 4; i++) {
58                 if (i_tab[i] == NULL) {
59                         break;
60                 }
61                 /*
62                  * Watch out for duplicate entries in the table.
63                  */
64                 if (i_tab[i] != i_tab[i-1]) {
65                         xfs_iunlock(i_tab[i], lock_mode);
66                 }
67         }
68 }
69
70 #ifdef DEBUG
71 int xfs_rename_skip, xfs_rename_nskip;
72 #endif
73
74 /*
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
78  * exist under dp2.
79  *
80  * We are renaming dp1/name1 to dp2/name2.
81  *
82  * Return ENOENT if dp1 does not exist, other lookup errors, or 0 for success.
83  */
84 STATIC int
85 xfs_lock_for_rename(
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 */
95 {
96         xfs_inode_t             *ip1, *ip2, *temp;
97         xfs_ino_t               inum1, inum2;
98         int                     error;
99         int                     i, j;
100         uint                    lock_mode;
101         int                     diff_dirs = (dp1 != dp2);
102
103         ip2 = NULL;
104
105         /*
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.
110          */
111         lock_mode = xfs_ilock_map_shared(dp1);
112         error = xfs_get_dir_entry(vname1, &ip1);
113         if (error) {
114                 xfs_iunlock_map_shared(dp1, lock_mode);
115                 return error;
116         }
117
118         inum1 = ip1->i_ino;
119
120         ASSERT(ip1);
121         ITRACE(ip1);
122
123         /*
124          * Unlock dp1 and lock dp2 if they are different.
125          */
126
127         if (diff_dirs) {
128                 xfs_iunlock_map_shared(dp1, lock_mode);
129                 lock_mode = xfs_ilock_map_shared(dp2);
130         }
131
132         error = xfs_dir_lookup_int(dp2, lock_mode, vname2, &inum2, &ip2);
133         if (error == ENOENT) {          /* target does not need to exist. */
134                 inum2 = 0;
135         } else if (error) {
136                 /*
137                  * If dp2 and dp1 are the same, the next line unlocks dp1.
138                  * Got it?
139                  */
140                 xfs_iunlock_map_shared(dp2, lock_mode);
141                 IRELE (ip1);
142                 return error;
143         } else {
144                 ITRACE(ip2);
145         }
146
147         /*
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.
151          *
152          * Note that the table may contain duplicates.  e.g., dp1 == dp2.
153          */
154         i_tab[0] = dp1;
155         i_tab[1] = dp2;
156         i_tab[2] = ip1;
157         if (inum2 == 0) {
158                 *num_inodes = 3;
159                 i_tab[3] = NULL;
160         } else {
161                 *num_inodes = 4;
162                 i_tab[3] = ip2;
163         }
164
165         /*
166          * Sort the elements via bubble sort.  (Remember, there are at
167          * most 4 elements to sort, so this is adequate.)
168          */
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) {
172                                 temp = i_tab[j];
173                                 i_tab[j] = i_tab[j-1];
174                                 i_tab[j-1] = temp;
175                         }
176                 }
177         }
178
179         /*
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.
186          */
187
188         if (i_tab[0] == dp2 && lock_mode == XFS_ILOCK_SHARED) {
189 #ifdef DEBUG
190                 xfs_rename_skip++;
191 #endif
192                 xfs_lock_inodes(i_tab, *num_inodes, 1, XFS_ILOCK_SHARED);
193         } else {
194 #ifdef DEBUG
195                 xfs_rename_nskip++;
196 #endif
197                 xfs_iunlock_map_shared(dp2, lock_mode);
198                 xfs_lock_inodes(i_tab, *num_inodes, 0, XFS_ILOCK_SHARED);
199         }
200
201         /*
202          * Set the return value. Null out any unused entries in i_tab.
203          */
204         *ipp1 = *ipp2 = NULL;
205         for (i=0; i < *num_inodes; i++) {
206                 if (i_tab[i]->i_ino == inum1) {
207                         *ipp1 = i_tab[i];
208                 }
209                 if (i_tab[i]->i_ino == inum2) {
210                         *ipp2 = i_tab[i];
211                 }
212         }
213         for (;i < 4; i++) {
214                 i_tab[i] = NULL;
215         }
216         return 0;
217 }
218
219 /*
220  * xfs_rename
221  */
222 int
223 xfs_rename(
224         xfs_inode_t     *src_dp,
225         bhv_vname_t     *src_vname,
226         bhv_vnode_t     *target_dir_vp,
227         bhv_vname_t     *target_vname)
228 {
229         bhv_vnode_t     *src_dir_vp = XFS_ITOV(src_dp);
230         xfs_trans_t     *tp;
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 */
235         int             error;
236         xfs_bmap_free_t free_list;
237         xfs_fsblock_t   first_block;
238         int             cancel_flags;
239         int             committed;
240         xfs_inode_t     *inodes[4];
241         int             target_ip_dropped = 0;  /* dropped target_ip link? */
242         int             spaceres;
243         int             target_link_zero = 0;
244         int             num_inodes;
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);
249
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);
252
253         /*
254          * Find the XFS behavior descriptor for the target directory
255          * vnode since it was not handed to us.
256          */
257         target_dp = xfs_vtoi(target_dir_vp);
258         if (target_dp == NULL) {
259                 return XFS_ERROR(EXDEV);
260         }
261
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,
268                                         0, 0, 0);
269                 if (error) {
270                         return error;
271                 }
272         }
273         /* Return through std_return after this point. */
274
275         /*
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.
282          */
283         tp = NULL;
284         error = xfs_lock_for_rename(src_dp, target_dp, src_vname,
285                         target_vname, &src_ip, &target_ip, inodes,
286                         &num_inodes);
287
288         if (error) {
289                 /*
290                  * We have nothing locked, no inode references, and
291                  * no transaction, so just get out.
292                  */
293                 goto std_return;
294         }
295
296         ASSERT(src_ip != NULL);
297
298         if ((src_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
299                 /*
300                  * Check for link count overflow on target_dp
301                  */
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);
306                         goto rele_return;
307                 }
308         }
309
310         /*
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.
314          */
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);
319                 goto rele_return;
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(tp, target_dp, target_name,
393                                                 target_namelen)))
394                         goto error_return;
395                 /*
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.
399                  */
400                 error = xfs_dir_createname(tp, target_dp, target_name,
401                                            target_namelen, src_ip->i_ino,
402                                            &first_block, &free_list, spaceres);
403                 if (error == ENOSPC)
404                         goto error_return;
405                 if (error)
406                         goto abort_return;
407                 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
408
409                 if (new_parent && src_is_directory) {
410                         error = xfs_bumplink(tp, target_dp);
411                         if (error)
412                                 goto abort_return;
413                 }
414         } else { /* target_ip != NULL */
415                 /*
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.
419                  */
420                 if ((target_ip->i_d.di_mode & S_IFMT) == S_IFDIR) {
421                         /*
422                          * Make sure target dir is empty.
423                          */
424                         if (!(xfs_dir_isempty(target_ip)) ||
425                             (target_ip->i_d.di_nlink > 2)) {
426                                 error = XFS_ERROR(EEXIST);
427                                 goto error_return;
428                         }
429                 }
430
431                 /*
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.
436                  *
437                  * In case there is already an entry with the same
438                  * name at the destination directory, remove it first.
439                  */
440                 error = xfs_dir_replace(tp, target_dp, target_name,
441                                         target_namelen, src_ip->i_ino,
442                                         &first_block, &free_list, spaceres);
443                 if (error)
444                         goto abort_return;
445                 xfs_ichgtime(target_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
446
447                 /*
448                  * Decrement the link count on the target since the target
449                  * dir no longer points to it.
450                  */
451                 error = xfs_droplink(tp, target_ip);
452                 if (error)
453                         goto abort_return;
454                 target_ip_dropped = 1;
455
456                 if (src_is_directory) {
457                         /*
458                          * Drop the link from the old "." entry.
459                          */
460                         error = xfs_droplink(tp, target_ip);
461                         if (error)
462                                 goto abort_return;
463                 }
464
465                 /* Do this test while we still hold the locks */
466                 target_link_zero = (target_ip)->i_d.di_nlink==0;
467
468         } /* target_ip != NULL */
469
470         /*
471          * Remove the source.
472          */
473         if (new_parent && src_is_directory) {
474                 /*
475                  * Rewrite the ".." entry to point to the new
476                  * directory.
477                  */
478                 error = xfs_dir_replace(tp, src_ip, "..", 2, target_dp->i_ino,
479                                         &first_block, &free_list, spaceres);
480                 ASSERT(error != EEXIST);
481                 if (error)
482                         goto abort_return;
483                 xfs_ichgtime(src_ip, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
484
485         } else {
486                 /*
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.
494                  */
495                 xfs_ichgtime(src_ip, XFS_ICHGTIME_CHG);
496         }
497
498         /*
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.
502          */
503         if (src_is_directory && (new_parent || target_ip != NULL)) {
504
505                 /*
506                  * Decrement link count on src_directory since the
507                  * entry that's moved no longer points to it.
508                  */
509                 error = xfs_droplink(tp, src_dp);
510                 if (error)
511                         goto abort_return;
512         }
513
514         error = xfs_dir_removename(tp, src_dp, src_name, src_namelen,
515                         src_ip->i_ino, &first_block, &free_list, spaceres);
516         if (error)
517                 goto abort_return;
518         xfs_ichgtime(src_dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
519
520         /*
521          * Update the generation counts on all the directory inodes
522          * that we're modifying.
523          */
524         src_dp->i_gen++;
525         xfs_trans_log_inode(tp, src_dp, XFS_ILOG_CORE);
526
527         if (new_parent) {
528                 target_dp->i_gen++;
529                 xfs_trans_log_inode(tp, target_dp, XFS_ILOG_CORE);
530         }
531
532         /*
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
535          * within the commit.
536          */
537         if (target_ip != NULL) {
538                 IHOLD(target_ip);
539         }
540
541         /*
542          * If this is a synchronous mount, make sure that the
543          * rename transaction goes to disk before returning to
544          * the user.
545          */
546         if (mp->m_flags & (XFS_MOUNT_WSYNC|XFS_MOUNT_DIRSYNC)) {
547                 xfs_trans_set_sync(tp);
548         }
549
550         /*
551          * Take refs. for vop_link_removed calls below.  No need to worry
552          * about directory refs. because the caller holds them.
553          *
554          * Do holds before the xfs_bmap_finish since it might rele them down
555          * to zero.
556          */
557
558         if (target_ip_dropped)
559                 IHOLD(target_ip);
560         IHOLD(src_ip);
561
562         error = xfs_bmap_finish(&tp, &free_list, &committed);
563         if (error) {
564                 xfs_bmap_cancel(&free_list);
565                 xfs_trans_cancel(tp, (XFS_TRANS_RELEASE_LOG_RES |
566                                  XFS_TRANS_ABORT));
567                 if (target_ip != NULL) {
568                         IRELE(target_ip);
569                 }
570                 if (target_ip_dropped) {
571                         IRELE(target_ip);
572                 }
573                 IRELE(src_ip);
574                 goto std_return;
575         }
576
577         /*
578          * trans_commit will unlock src_ip, target_ip & decrement
579          * the vnode references.
580          */
581         error = xfs_trans_commit(tp, XFS_TRANS_RELEASE_LOG_RES);
582         if (target_ip != NULL) {
583                 xfs_refcache_purge_ip(target_ip);
584                 IRELE(target_ip);
585         }
586         /*
587          * Let interposed file systems know about removed links.
588          */
589         if (target_ip_dropped)
590                 IRELE(target_ip);
591
592         IRELE(src_ip);
593
594         /* Fall through to std_return with error = 0 or errno from
595          * xfs_trans_commit      */
596 std_return:
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,
603                                         0, error, 0);
604         }
605         return error;
606
607  abort_return:
608         cancel_flags |= XFS_TRANS_ABORT;
609         /* FALLTHROUGH */
610  error_return:
611         xfs_bmap_cancel(&free_list);
612         xfs_trans_cancel(tp, cancel_flags);
613         goto std_return;
614
615  rele_return:
616         IRELE(src_ip);
617         if (target_ip != NULL) {
618                 IRELE(target_ip);
619         }
620         goto std_return;
621 }