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