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