SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/xfs/xfs_iget.c

   1 /*
   2  * Copyright (c) 2000-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_acl.h"
  22 #include "xfs_bit.h"
  23 #include "xfs_log.h"
  24 #include "xfs_inum.h"
  25 #include "xfs_trans.h"
  26 #include "xfs_sb.h"
  27 #include "xfs_ag.h"
  28 #include "xfs_dir2.h"
  29 #include "xfs_dmapi.h"
  30 #include "xfs_mount.h"
  31 #include "xfs_bmap_btree.h"
  32 #include "xfs_alloc_btree.h"
  33 #include "xfs_ialloc_btree.h"
  34 #include "xfs_dir2_sf.h"
  35 #include "xfs_attr_sf.h"
  36 #include "xfs_dinode.h"
  37 #include "xfs_inode.h"
  38 #include "xfs_btree.h"
  39 #include "xfs_ialloc.h"
  40 #include "xfs_quota.h"
  41 #include "xfs_utils.h"
  42 #include "xfs_trans_priv.h"
  43 #include "xfs_inode_item.h"
  44 #include "xfs_bmap.h"
  45 #include "xfs_btree_trace.h"
  46 #include "xfs_dir2_trace.h"
  47
  48
  49 /*
  50  * Allocate and initialise an xfs_inode.
  51  */
  52 STATIC struct xfs_inode *
  53 xfs_inode_alloc(
  54         struct xfs_mount        *mp,
  55         xfs_ino_t               ino)
  56 {
  57         struct xfs_inode        *ip;
  58
  59         /*
  60          * if this didn't occur in transactions, we could use
  61          * KM_MAYFAIL and return NULL here on ENOMEM. Set the
  62          * code up to do this anyway.
  63          */
  64         ip = kmem_zone_alloc(xfs_inode_zone, KM_SLEEP);
  65         if (!ip)
  66                 return NULL;
  67
  68         ASSERT(atomic_read(&ip->i_iocount) == 0);
  69         ASSERT(atomic_read(&ip->i_pincount) == 0);
  70         ASSERT(!spin_is_locked(&ip->i_flags_lock));
  71         ASSERT(completion_done(&ip->i_flush));
  72
  73         /* initialise the xfs inode */
  74         ip->i_ino = ino;
  75         ip->i_mount = mp;
  76         memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
  77         ip->i_afp = NULL;
  78         memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
  79         ip->i_flags = 0;
  80         ip->i_update_core = 0;
  81         ip->i_update_size = 0;
  82         ip->i_delayed_blks = 0;
  83         memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
  84         ip->i_size = 0;
  85         ip->i_new_size = 0;
  86         xfs_inode_init_acls(ip);
  87
  88         /*
  89          * Initialize inode's trace buffers.
  90          */
  91 #ifdef  XFS_INODE_TRACE
  92         ip->i_trace = ktrace_alloc(INODE_TRACE_SIZE, KM_NOFS);
  93 #endif
  94 #ifdef XFS_BMAP_TRACE
  95         ip->i_xtrace = ktrace_alloc(XFS_BMAP_KTRACE_SIZE, KM_NOFS);
  96 #endif
  97 #ifdef XFS_BTREE_TRACE
  98         ip->i_btrace = ktrace_alloc(XFS_BMBT_KTRACE_SIZE, KM_NOFS);
  99 #endif
 100 #ifdef XFS_RW_TRACE
 101         ip->i_rwtrace = ktrace_alloc(XFS_RW_KTRACE_SIZE, KM_NOFS);
 102 #endif
 103 #ifdef XFS_ILOCK_TRACE
 104         ip->i_lock_trace = ktrace_alloc(XFS_ILOCK_KTRACE_SIZE, KM_NOFS);
 105 #endif
 106 #ifdef XFS_DIR2_TRACE
 107         ip->i_dir_trace = ktrace_alloc(XFS_DIR2_KTRACE_SIZE, KM_NOFS);
 108 #endif
 109         /*
 110         * Now initialise the VFS inode. We do this after the xfs_inode
 111         * initialisation as internal failures will result in ->destroy_inode
 112         * being called and that will pass down through the reclaim path and
 113         * free the XFS inode. This path requires the XFS inode to already be
 114         * initialised. Hence if this call fails, the xfs_inode has already
 115         * been freed and we should not reference it at all in the error
 116         * handling.
 117         */
 118         if (!inode_init_always(mp->m_super, VFS_I(ip)))
 119                 return NULL;
 120
 121         /* prevent anyone from using this yet */
 122         VFS_I(ip)->i_state = I_NEW|I_LOCK;
 123
 124         return ip;
 125 }
 126
 127 /*
 128  * Check the validity of the inode we just found it the cache
 129  */
 130 static int
 131 xfs_iget_cache_hit(
 132         struct xfs_perag        *pag,
 133         struct xfs_inode        *ip,
 134         int                     flags,
 135         int                     lock_flags) __releases(pag->pag_ici_lock)
 136 {
 137         struct xfs_mount        *mp = ip->i_mount;
 138         int                     error = EAGAIN;
 139
 140         /*
 141          * If INEW is set this inode is being set up
 142          * If IRECLAIM is set this inode is being torn down
 143          * Pause and try again.
 144          */
 145         if (xfs_iflags_test(ip, (XFS_INEW|XFS_IRECLAIM))) {
 146                 XFS_STATS_INC(xs_ig_frecycle);
 147                 goto out_error;
 148         }
 149
 150         /* If IRECLAIMABLE is set, we've torn down the vfs inode part */
 151         if (xfs_iflags_test(ip, XFS_IRECLAIMABLE)) {
 152
 153                 /*
 154                  * If lookup is racing with unlink, then we should return an
 155                  * error immediately so we don't remove it from the reclaim
 156                  * list and potentially leak the inode.
 157                  */
 158                 if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
 159                         error = ENOENT;
 160                         goto out_error;
 161                 }
 162
 163                 xfs_itrace_exit_tag(ip, "xfs_iget.alloc");
 164
 165                 /*
 166                  * We need to re-initialise the VFS inode as it has been
 167                  * 'freed' by the VFS. Do this here so we can deal with
 168                  * errors cleanly, then tag it so it can be set up correctly
 169                  * later.
 170                  */
 171                 if (!inode_init_always(mp->m_super, VFS_I(ip))) {
 172                         error = ENOMEM;
 173                         goto out_error;
 174                 }
 175
 176                 /*
 177                  * We must set the XFS_INEW flag before clearing the
 178                  * XFS_IRECLAIMABLE flag so that if a racing lookup does
 179                  * not find the XFS_IRECLAIMABLE above but has the igrab()
 180                  * below succeed we can safely check XFS_INEW to detect
 181                  * that this inode is still being initialised.
 182                  */
 183                 xfs_iflags_set(ip, XFS_INEW);
 184                 xfs_iflags_clear(ip, XFS_IRECLAIMABLE);
 185
 186                 /* clear the radix tree reclaim flag as well. */
 187                 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
 188         } else if (!igrab(VFS_I(ip))) {
 189                 /* If the VFS inode is being torn down, pause and try again. */
 190                 XFS_STATS_INC(xs_ig_frecycle);
 191                 goto out_error;
 192         } else if (xfs_iflags_test(ip, XFS_INEW)) {
 193                 /*
 194                  * We are racing with another cache hit that is
 195                  * currently recycling this inode out of the XFS_IRECLAIMABLE
 196                  * state. Wait for the initialisation to complete before
 197                  * continuing.
 198                  */
 199                 wait_on_inode(VFS_I(ip));
 200         }
 201
 202         if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
 203                 error = ENOENT;
 204                 iput(VFS_I(ip));
 205                 goto out_error;
 206         }
 207
 208         /* We've got a live one. */
 209         read_unlock(&pag->pag_ici_lock);
 210
 211         if (lock_flags != 0)
 212                 xfs_ilock(ip, lock_flags);
 213
 214         xfs_iflags_clear(ip, XFS_ISTALE);
 215         xfs_itrace_exit_tag(ip, "xfs_iget.found");
 216         XFS_STATS_INC(xs_ig_found);
 217         return 0;
 218
 219 out_error:
 220         read_unlock(&pag->pag_ici_lock);
 221         return error;
 222 }
 223
 224
 225 static int
 226 xfs_iget_cache_miss(
 227         struct xfs_mount        *mp,
 228         struct xfs_perag        *pag,
 229         xfs_trans_t             *tp,
 230         xfs_ino_t               ino,
 231         struct xfs_inode        **ipp,
 232         xfs_daddr_t             bno,
 233         int                     flags,
 234         int                     lock_flags) __releases(pag->pag_ici_lock)
 235 {
 236         struct xfs_inode        *ip;
 237         int                     error;
 238         unsigned long           first_index, mask;
 239         xfs_agino_t             agino = XFS_INO_TO_AGINO(mp, ino);
 240
 241         ip = xfs_inode_alloc(mp, ino);
 242         if (!ip)
 243                 return ENOMEM;
 244
 245         error = xfs_iread(mp, tp, ip, bno, flags);
 246         if (error)
 247                 goto out_destroy;
 248
 249         xfs_itrace_exit_tag(ip, "xfs_iget.alloc");
 250
 251         if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
 252                 error = ENOENT;
 253                 goto out_destroy;
 254         }
 255
 256         /*
 257          * Preload the radix tree so we can insert safely under the
 258          * write spinlock. Note that we cannot sleep inside the preload
 259          * region.
 260          */
 261         if (radix_tree_preload(GFP_KERNEL)) {
 262                 error = EAGAIN;
 263                 goto out_destroy;
 264         }
 265
 266         /*
 267          * Because the inode hasn't been added to the radix-tree yet it can't
 268          * be found by another thread, so we can do the non-sleeping lock here.
 269          */
 270         if (lock_flags) {
 271                 if (!xfs_ilock_nowait(ip, lock_flags))
 272                         BUG();
 273         }
 274
 275         mask = ~(((XFS_INODE_CLUSTER_SIZE(mp) >> mp->m_sb.sb_inodelog)) - 1);
 276         first_index = agino & mask;
 277         write_lock(&pag->pag_ici_lock);
 278
 279         /* insert the new inode */
 280         error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
 281         if (unlikely(error)) {
 282                 WARN_ON(error != -EEXIST);
 283                 XFS_STATS_INC(xs_ig_dup);
 284                 error = EAGAIN;
 285                 goto out_preload_end;
 286         }
 287
 288         /* These values _must_ be set before releasing the radix tree lock! */
 289         ip->i_udquot = ip->i_gdquot = NULL;
 290         xfs_iflags_set(ip, XFS_INEW);
 291
 292         write_unlock(&pag->pag_ici_lock);
 293         radix_tree_preload_end();
 294         *ipp = ip;
 295         return 0;
 296
 297 out_preload_end:
 298         write_unlock(&pag->pag_ici_lock);
 299         radix_tree_preload_end();
 300         if (lock_flags)
 301                 xfs_iunlock(ip, lock_flags);
 302 out_destroy:
 303         xfs_destroy_inode(ip);
 304         return error;
 305 }
 306
 307 /*
 308  * Look up an inode by number in the given file system.
 309  * The inode is looked up in the cache held in each AG.
 310  * If the inode is found in the cache, initialise the vfs inode
 311  * if necessary.
 312  *
 313  * If it is not in core, read it in from the file system's device,
 314  * add it to the cache and initialise the vfs inode.
 315  *
 316  * The inode is locked according to the value of the lock_flags parameter.
 317  * This flag parameter indicates how and if the inode's IO lock and inode lock
 318  * should be taken.
 319  *
 320  * mp -- the mount point structure for the current file system.  It points
 321  *       to the inode hash table.
 322  * tp -- a pointer to the current transaction if there is one.  This is
 323  *       simply passed through to the xfs_iread() call.
 324  * ino -- the number of the inode desired.  This is the unique identifier
 325  *        within the file system for the inode being requested.
 326  * lock_flags -- flags indicating how to lock the inode.  See the comment
 327  *               for xfs_ilock() for a list of valid values.
 328  * bno -- the block number starting the buffer containing the inode,
 329  *        if known (as by bulkstat), else 0.
 330  */
 331 int
 332 xfs_iget(
 333         xfs_mount_t     *mp,
 334         xfs_trans_t     *tp,
 335         xfs_ino_t       ino,
 336         uint            flags,
 337         uint            lock_flags,
 338         xfs_inode_t     **ipp,
 339         xfs_daddr_t     bno)
 340 {
 341         xfs_inode_t     *ip;
 342         int             error;
 343         xfs_perag_t     *pag;
 344         xfs_agino_t     agino;
 345
 346         /* the radix tree exists only in inode capable AGs */
 347         if (XFS_INO_TO_AGNO(mp, ino) >= mp->m_maxagi)
 348                 return EINVAL;
 349
 350         /* get the perag structure and ensure that it's inode capable */
 351         pag = xfs_get_perag(mp, ino);
 352         if (!pag->pagi_inodeok)
 353                 return EINVAL;
 354         ASSERT(pag->pag_ici_init);
 355         agino = XFS_INO_TO_AGINO(mp, ino);
 356
 357 again:
 358         error = 0;
 359         read_lock(&pag->pag_ici_lock);
 360         ip = radix_tree_lookup(&pag->pag_ici_root, agino);
 361
 362         if (ip) {
 363                 error = xfs_iget_cache_hit(pag, ip, flags, lock_flags);
 364                 if (error)
 365                         goto out_error_or_again;
 366         } else {
 367                 read_unlock(&pag->pag_ici_lock);
 368                 XFS_STATS_INC(xs_ig_missed);
 369
 370                 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip, bno,
 371                                                         flags, lock_flags);
 372                 if (error)
 373                         goto out_error_or_again;
 374         }
 375         xfs_put_perag(mp, pag);
 376
 377         *ipp = ip;
 378
 379         ASSERT(ip->i_df.if_ext_max ==
 380                XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
 381         /*
 382          * If we have a real type for an on-disk inode, we can set ops(&unlock)
 383          * now.  If it's a new inode being created, xfs_ialloc will handle it.
 384          */
 385         if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
 386                 xfs_setup_inode(ip);
 387         return 0;
 388
 389 out_error_or_again:
 390         if (error == EAGAIN) {
 391                 delay(1);
 392                 goto again;
 393         }
 394         xfs_put_perag(mp, pag);
 395         return error;
 396 }
 397
 398
 399 /*
 400  * Look for the inode corresponding to the given ino in the hash table.
 401  * If it is there and its i_transp pointer matches tp, return it.
 402  * Otherwise, return NULL.
 403  */
 404 xfs_inode_t *
 405 xfs_inode_incore(xfs_mount_t    *mp,
 406                  xfs_ino_t      ino,
 407                  xfs_trans_t    *tp)
 408 {
 409         xfs_inode_t     *ip;
 410         xfs_perag_t     *pag;
 411
 412         pag = xfs_get_perag(mp, ino);
 413         read_lock(&pag->pag_ici_lock);
 414         ip = radix_tree_lookup(&pag->pag_ici_root, XFS_INO_TO_AGINO(mp, ino));
 415         read_unlock(&pag->pag_ici_lock);
 416         xfs_put_perag(mp, pag);
 417
 418         /* the returned inode must match the transaction */
 419         if (ip && (ip->i_transp != tp))
 420                 return NULL;
 421         return ip;
 422 }
 423
 424 /*
 425  * Decrement reference count of an inode structure and unlock it.
 426  *
 427  * ip -- the inode being released
 428  * lock_flags -- this parameter indicates the inode's locks to be
 429  *       to be released.  See the comment on xfs_iunlock() for a list
 430  *       of valid values.
 431  */
 432 void
 433 xfs_iput(xfs_inode_t    *ip,
 434          uint           lock_flags)
 435 {
 436         xfs_itrace_entry(ip);
 437         xfs_iunlock(ip, lock_flags);
 438         IRELE(ip);
 439 }
 440
 441 /*
 442  * Special iput for brand-new inodes that are still locked
 443  */
 444 void
 445 xfs_iput_new(
 446         xfs_inode_t     *ip,
 447         uint            lock_flags)
 448 {
 449         struct inode    *inode = VFS_I(ip);
 450
 451         xfs_itrace_entry(ip);
 452
 453         if ((ip->i_d.di_mode == 0)) {
 454                 ASSERT(!xfs_iflags_test(ip, XFS_IRECLAIMABLE));
 455                 make_bad_inode(inode);
 456         }
 457         if (inode->i_state & I_NEW)
 458                 unlock_new_inode(inode);
 459         if (lock_flags)
 460                 xfs_iunlock(ip, lock_flags);
 461         IRELE(ip);
 462 }
 463
 464 /*
 465  * This is called free all the memory associated with an inode.
 466  * It must free the inode itself and any buffers allocated for
 467  * if_extents/if_data and if_broot.  It must also free the lock
 468  * associated with the inode.
 469  *
 470  * Note: because we don't initialise everything on reallocation out
 471  * of the zone, we must ensure we nullify everything correctly before
 472  * freeing the structure.
 473  */
 474 void
 475 xfs_ireclaim(
 476         struct xfs_inode        *ip)
 477 {
 478         struct xfs_mount        *mp = ip->i_mount;
 479         struct xfs_perag        *pag;
 480
 481         XFS_STATS_INC(xs_ig_reclaims);
 482
 483         /*
 484          * Remove the inode from the per-AG radix tree.  It doesn't matter
 485          * if it was never added to it because radix_tree_delete can deal
 486          * with that case just fine.
 487          */
 488         pag = xfs_get_perag(mp, ip->i_ino);
 489         write_lock(&pag->pag_ici_lock);
 490         radix_tree_delete(&pag->pag_ici_root, XFS_INO_TO_AGINO(mp, ip->i_ino));
 491         write_unlock(&pag->pag_ici_lock);
 492         xfs_put_perag(mp, pag);
 493
 494         /*
 495          * Here we do an (almost) spurious inode lock in order to coordinate
 496          * with inode cache radix tree lookups.  This is because the lookup
 497          * can reference the inodes in the cache without taking references.
 498          *
 499          * We make that OK here by ensuring that we wait until the inode is
 500          * unlocked after the lookup before we go ahead and free it.  We get
 501          * both the ilock and the iolock because the code may need to drop the
 502          * ilock one but will still hold the iolock.
 503          */
 504         xfs_ilock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 505         xfs_qm_dqdetach(ip);
 506         xfs_iunlock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 507
 508         switch (ip->i_d.di_mode & S_IFMT) {
 509         case S_IFREG:
 510         case S_IFDIR:
 511         case S_IFLNK:
 512                 xfs_idestroy_fork(ip, XFS_DATA_FORK);
 513                 break;
 514         }
 515
 516         if (ip->i_afp)
 517                 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
 518
 519 #ifdef XFS_INODE_TRACE
 520         ktrace_free(ip->i_trace);
 521 #endif
 522 #ifdef XFS_BMAP_TRACE
 523         ktrace_free(ip->i_xtrace);
 524 #endif
 525 #ifdef XFS_BTREE_TRACE
 526         ktrace_free(ip->i_btrace);
 527 #endif
 528 #ifdef XFS_RW_TRACE
 529         ktrace_free(ip->i_rwtrace);
 530 #endif
 531 #ifdef XFS_ILOCK_TRACE
 532         ktrace_free(ip->i_lock_trace);
 533 #endif
 534 #ifdef XFS_DIR2_TRACE
 535         ktrace_free(ip->i_dir_trace);
 536 #endif
 537         if (ip->i_itemp) {
 538                 /*
 539                  * Only if we are shutting down the fs will we see an
 540                  * inode still in the AIL. If it is there, we should remove
 541                  * it to prevent a use-after-free from occurring.
 542                  */
 543                 xfs_log_item_t  *lip = &ip->i_itemp->ili_item;
 544                 struct xfs_ail  *ailp = lip->li_ailp;
 545
 546                 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
 547                                        XFS_FORCED_SHUTDOWN(ip->i_mount));
 548                 if (lip->li_flags & XFS_LI_IN_AIL) {
 549                         spin_lock(&ailp->xa_lock);
 550                         if (lip->li_flags & XFS_LI_IN_AIL)
 551                                 xfs_trans_ail_delete(ailp, lip);
 552                         else
 553                                 spin_unlock(&ailp->xa_lock);
 554                 }
 555                 xfs_inode_item_destroy(ip);
 556                 ip->i_itemp = NULL;
 557         }
 558         /* asserts to verify all state is correct here */
 559         ASSERT(atomic_read(&ip->i_iocount) == 0);
 560         ASSERT(atomic_read(&ip->i_pincount) == 0);
 561         ASSERT(!spin_is_locked(&ip->i_flags_lock));
 562         ASSERT(completion_done(&ip->i_flush));
 563         xfs_inode_clear_acls(ip);
 564         kmem_zone_free(xfs_inode_zone, ip);
 565 }
 566
 567 /*
 568  * This is a wrapper routine around the xfs_ilock() routine
 569  * used to centralize some grungy code.  It is used in places
 570  * that wish to lock the inode solely for reading the extents.
 571  * The reason these places can't just call xfs_ilock(SHARED)
 572  * is that the inode lock also guards to bringing in of the
 573  * extents from disk for a file in b-tree format.  If the inode
 574  * is in b-tree format, then we need to lock the inode exclusively
 575  * until the extents are read in.  Locking it exclusively all
 576  * the time would limit our parallelism unnecessarily, though.
 577  * What we do instead is check to see if the extents have been
 578  * read in yet, and only lock the inode exclusively if they
 579  * have not.
 580  *
 581  * The function returns a value which should be given to the
 582  * corresponding xfs_iunlock_map_shared().  This value is
 583  * the mode in which the lock was actually taken.
 584  */
 585 uint
 586 xfs_ilock_map_shared(
 587         xfs_inode_t     *ip)
 588 {
 589         uint    lock_mode;
 590
 591         if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
 592             ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
 593                 lock_mode = XFS_ILOCK_EXCL;
 594         } else {
 595                 lock_mode = XFS_ILOCK_SHARED;
 596         }
 597
 598         xfs_ilock(ip, lock_mode);
 599
 600         return lock_mode;
 601 }
 602
 603 /*
 604  * This is simply the unlock routine to go with xfs_ilock_map_shared().
 605  * All it does is call xfs_iunlock() with the given lock_mode.
 606  */
 607 void
 608 xfs_iunlock_map_shared(
 609         xfs_inode_t     *ip,
 610         unsigned int    lock_mode)
 611 {
 612         xfs_iunlock(ip, lock_mode);
 613 }
 614
 615 /*
 616  * The xfs inode contains 2 locks: a multi-reader lock called the
 617  * i_iolock and a multi-reader lock called the i_lock.  This routine
 618  * allows either or both of the locks to be obtained.
 619  *
 620  * The 2 locks should always be ordered so that the IO lock is
 621  * obtained first in order to prevent deadlock.
 622  *
 623  * ip -- the inode being locked
 624  * lock_flags -- this parameter indicates the inode's locks
 625  *       to be locked.  It can be:
 626  *              XFS_IOLOCK_SHARED,
 627  *              XFS_IOLOCK_EXCL,
 628  *              XFS_ILOCK_SHARED,
 629  *              XFS_ILOCK_EXCL,
 630  *              XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
 631  *              XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
 632  *              XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
 633  *              XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
 634  */
 635 void
 636 xfs_ilock(
 637         xfs_inode_t             *ip,
 638         uint                    lock_flags)
 639 {
 640         /*
 641          * You can't set both SHARED and EXCL for the same lock,
 642          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 643          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 644          */
 645         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 646                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 647         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 648                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 649         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 650
 651         if (lock_flags & XFS_IOLOCK_EXCL)
 652                 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 653         else if (lock_flags & XFS_IOLOCK_SHARED)
 654                 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 655
 656         if (lock_flags & XFS_ILOCK_EXCL)
 657                 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 658         else if (lock_flags & XFS_ILOCK_SHARED)
 659                 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 660
 661         xfs_ilock_trace(ip, 1, lock_flags, (inst_t *)__return_address);
 662 }
 663
 664 /*
 665  * This is just like xfs_ilock(), except that the caller
 666  * is guaranteed not to sleep.  It returns 1 if it gets
 667  * the requested locks and 0 otherwise.  If the IO lock is
 668  * obtained but the inode lock cannot be, then the IO lock
 669  * is dropped before returning.
 670  *
 671  * ip -- the inode being locked
 672  * lock_flags -- this parameter indicates the inode's locks to be
 673  *       to be locked.  See the comment for xfs_ilock() for a list
 674  *       of valid values.
 675  */
 676 int
 677 xfs_ilock_nowait(
 678         xfs_inode_t             *ip,
 679         uint                    lock_flags)
 680 {
 681         /*
 682          * You can't set both SHARED and EXCL for the same lock,
 683          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 684          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 685          */
 686         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 687                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 688         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 689                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 690         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 691
 692         if (lock_flags & XFS_IOLOCK_EXCL) {
 693                 if (!mrtryupdate(&ip->i_iolock))
 694                         goto out;
 695         } else if (lock_flags & XFS_IOLOCK_SHARED) {
 696                 if (!mrtryaccess(&ip->i_iolock))
 697                         goto out;
 698         }
 699         if (lock_flags & XFS_ILOCK_EXCL) {
 700                 if (!mrtryupdate(&ip->i_lock))
 701                         goto out_undo_iolock;
 702         } else if (lock_flags & XFS_ILOCK_SHARED) {
 703                 if (!mrtryaccess(&ip->i_lock))
 704                         goto out_undo_iolock;
 705         }
 706         xfs_ilock_trace(ip, 2, lock_flags, (inst_t *)__return_address);
 707         return 1;
 708
 709  out_undo_iolock:
 710         if (lock_flags & XFS_IOLOCK_EXCL)
 711                 mrunlock_excl(&ip->i_iolock);
 712         else if (lock_flags & XFS_IOLOCK_SHARED)
 713                 mrunlock_shared(&ip->i_iolock);
 714  out:
 715         return 0;
 716 }
 717
 718 /*
 719  * xfs_iunlock() is used to drop the inode locks acquired with
 720  * xfs_ilock() and xfs_ilock_nowait().  The caller must pass
 721  * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
 722  * that we know which locks to drop.
 723  *
 724  * ip -- the inode being unlocked
 725  * lock_flags -- this parameter indicates the inode's locks to be
 726  *       to be unlocked.  See the comment for xfs_ilock() for a list
 727  *       of valid values for this parameter.
 728  *
 729  */
 730 void
 731 xfs_iunlock(
 732         xfs_inode_t             *ip,
 733         uint                    lock_flags)
 734 {
 735         /*
 736          * You can't set both SHARED and EXCL for the same lock,
 737          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 738          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 739          */
 740         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 741                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 742         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 743                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 744         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
 745                         XFS_LOCK_DEP_MASK)) == 0);
 746         ASSERT(lock_flags != 0);
 747
 748         if (lock_flags & XFS_IOLOCK_EXCL)
 749                 mrunlock_excl(&ip->i_iolock);
 750         else if (lock_flags & XFS_IOLOCK_SHARED)
 751                 mrunlock_shared(&ip->i_iolock);
 752
 753         if (lock_flags & XFS_ILOCK_EXCL)
 754                 mrunlock_excl(&ip->i_lock);
 755         else if (lock_flags & XFS_ILOCK_SHARED)
 756                 mrunlock_shared(&ip->i_lock);
 757
 758         if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
 759             !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
 760                 /*
 761                  * Let the AIL know that this item has been unlocked in case
 762                  * it is in the AIL and anyone is waiting on it.  Don't do
 763                  * this if the caller has asked us not to.
 764                  */
 765                 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
 766                                         (xfs_log_item_t*)(ip->i_itemp));
 767         }
 768         xfs_ilock_trace(ip, 3, lock_flags, (inst_t *)__return_address);
 769 }
 770
 771 /*
 772  * give up write locks.  the i/o lock cannot be held nested
 773  * if it is being demoted.
 774  */
 775 void
 776 xfs_ilock_demote(
 777         xfs_inode_t             *ip,
 778         uint                    lock_flags)
 779 {
 780         ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
 781         ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
 782
 783         if (lock_flags & XFS_ILOCK_EXCL)
 784                 mrdemote(&ip->i_lock);
 785         if (lock_flags & XFS_IOLOCK_EXCL)
 786                 mrdemote(&ip->i_iolock);
 787 }
 788
 789 #ifdef DEBUG
 790 /*
 791  * Debug-only routine, without additional rw_semaphore APIs, we can
 792  * now only answer requests regarding whether we hold the lock for write
 793  * (reader state is outside our visibility, we only track writer state).
 794  *
 795  * Note: this means !xfs_isilocked would give false positives, so don't do that.
 796  */
 797 int
 798 xfs_isilocked(
 799         xfs_inode_t             *ip,
 800         uint                    lock_flags)
 801 {
 802         if ((lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) ==
 803                         XFS_ILOCK_EXCL) {
 804                 if (!ip->i_lock.mr_writer)
 805                         return 0;
 806         }
 807
 808         if ((lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) ==
 809                         XFS_IOLOCK_EXCL) {
 810                 if (!ip->i_iolock.mr_writer)
 811                         return 0;
 812         }
 813
 814         return 1;
 815 }
 816 #endif
 817
 818 #ifdef  XFS_INODE_TRACE
 819
 820 #define KTRACE_ENTER(ip, vk, s, line, ra)                       \
 821         ktrace_enter((ip)->i_trace,                             \
 822 /*  0 */                (void *)(__psint_t)(vk),                \
 823 /*  1 */                (void *)(s),                            \
 824 /*  2 */                (void *)(__psint_t) line,               \
 825 /*  3 */                (void *)(__psint_t)atomic_read(&VFS_I(ip)->i_count), \
 826 /*  4 */                (void *)(ra),                           \
 827 /*  5 */                NULL,                                   \
 828 /*  6 */                (void *)(__psint_t)current_cpu(),       \
 829 /*  7 */                (void *)(__psint_t)current_pid(),       \
 830 /*  8 */                (void *)__return_address,               \
 831 /*  9 */                NULL, NULL, NULL, NULL, NULL, NULL, NULL)
 832
 833 /*
 834  * Vnode tracing code.
 835  */
 836 void
 837 _xfs_itrace_entry(xfs_inode_t *ip, const char *func, inst_t *ra)
 838 {
 839         KTRACE_ENTER(ip, INODE_KTRACE_ENTRY, func, 0, ra);
 840 }
 841
 842 void
 843 _xfs_itrace_exit(xfs_inode_t *ip, const char *func, inst_t *ra)
 844 {
 845         KTRACE_ENTER(ip, INODE_KTRACE_EXIT, func, 0, ra);
 846 }
 847
 848 void
 849 xfs_itrace_hold(xfs_inode_t *ip, char *file, int line, inst_t *ra)
 850 {
 851         KTRACE_ENTER(ip, INODE_KTRACE_HOLD, file, line, ra);
 852 }
 853
 854 void
 855 _xfs_itrace_ref(xfs_inode_t *ip, char *file, int line, inst_t *ra)
 856 {
 857         KTRACE_ENTER(ip, INODE_KTRACE_REF, file, line, ra);
 858 }
 859
 860 void
 861 xfs_itrace_rele(xfs_inode_t *ip, char *file, int line, inst_t *ra)
 862 {
 863         KTRACE_ENTER(ip, INODE_KTRACE_RELE, file, line, ra);
 864 }
 865 #endif  /* XFS_INODE_TRACE */