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