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_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         if (inode_init_always(mp->m_super, VFS_I(ip))) {
  68                 kmem_zone_free(xfs_inode_zone, ip);
  69                 return NULL;
  70         }
  71
  72         ASSERT(atomic_read(&ip->i_iocount) == 0);
  73         ASSERT(atomic_read(&ip->i_pincount) == 0);
  74         ASSERT(!spin_is_locked(&ip->i_flags_lock));
  75         ASSERT(completion_done(&ip->i_flush));
  76         ASSERT(!rwsem_is_locked(&ip->i_iolock.mr_lock));
  77
  78         mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
  79
  80         /* initialise the xfs inode */
  81         ip->i_ino = ino;
  82         ip->i_mount = mp;
  83         memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
  84         ip->i_afp = NULL;
  85         memset(&ip->i_df, 0, sizeof(xfs_ifork_t));
  86         ip->i_flags = 0;
  87         ip->i_update_core = 0;
  88         ip->i_delayed_blks = 0;
  89         memset(&ip->i_d, 0, sizeof(xfs_icdinode_t));
  90         ip->i_size = 0;
  91         ip->i_new_size = 0;
  92
  93         /* prevent anyone from using this yet */
  94         VFS_I(ip)->i_state = I_NEW|I_LOCK;
  95
  96         return ip;
  97 }
  98
  99 STATIC void
 100 xfs_inode_free(
 101         struct xfs_inode        *ip)
 102 {
 103         switch (ip->i_d.di_mode & S_IFMT) {
 104         case S_IFREG:
 105         case S_IFDIR:
 106         case S_IFLNK:
 107                 xfs_idestroy_fork(ip, XFS_DATA_FORK);
 108                 break;
 109         }
 110
 111         if (ip->i_afp)
 112                 xfs_idestroy_fork(ip, XFS_ATTR_FORK);
 113
 114         if (ip->i_itemp) {
 115                 /*
 116                  * Only if we are shutting down the fs will we see an
 117                  * inode still in the AIL. If it is there, we should remove
 118                  * it to prevent a use-after-free from occurring.
 119                  */
 120                 xfs_log_item_t  *lip = &ip->i_itemp->ili_item;
 121                 struct xfs_ail  *ailp = lip->li_ailp;
 122
 123                 ASSERT(((lip->li_flags & XFS_LI_IN_AIL) == 0) ||
 124                                        XFS_FORCED_SHUTDOWN(ip->i_mount));
 125                 if (lip->li_flags & XFS_LI_IN_AIL) {
 126                         spin_lock(&ailp->xa_lock);
 127                         if (lip->li_flags & XFS_LI_IN_AIL)
 128                                 xfs_trans_ail_delete(ailp, lip);
 129                         else
 130                                 spin_unlock(&ailp->xa_lock);
 131                 }
 132                 xfs_inode_item_destroy(ip);
 133                 ip->i_itemp = NULL;
 134         }
 135
 136         /* asserts to verify all state is correct here */
 137         ASSERT(atomic_read(&ip->i_iocount) == 0);
 138         ASSERT(atomic_read(&ip->i_pincount) == 0);
 139         ASSERT(!spin_is_locked(&ip->i_flags_lock));
 140         ASSERT(completion_done(&ip->i_flush));
 141
 142         kmem_zone_free(xfs_inode_zone, ip);
 143 }
 144
 145 /*
 146  * Check the validity of the inode we just found it the cache
 147  */
 148 static int
 149 xfs_iget_cache_hit(
 150         struct xfs_perag        *pag,
 151         struct xfs_inode        *ip,
 152         int                     flags,
 153         int                     lock_flags) __releases(pag->pag_ici_lock)
 154 {
 155         struct inode            *inode = VFS_I(ip);
 156         struct xfs_mount        *mp = ip->i_mount;
 157         int                     error;
 158
 159         spin_lock(&ip->i_flags_lock);
 160
 161         /*
 162          * If we are racing with another cache hit that is currently
 163          * instantiating this inode or currently recycling it out of
 164          * reclaimabe state, wait for the initialisation to complete
 165          * before continuing.
 166          *
 167          * XXX(hch): eventually we should do something equivalent to
 168          *           wait_on_inode to wait for these flags to be cleared
 169          *           instead of polling for it.
 170          */
 171         if (ip->i_flags & (XFS_INEW|XFS_IRECLAIM)) {
 172                 trace_xfs_iget_skip(ip);
 173                 XFS_STATS_INC(xs_ig_frecycle);
 174                 error = EAGAIN;
 175                 goto out_error;
 176         }
 177
 178         /*
 179          * If lookup is racing with unlink return an error immediately.
 180          */
 181         if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
 182                 error = ENOENT;
 183                 goto out_error;
 184         }
 185
 186         /*
 187          * If IRECLAIMABLE is set, we've torn down the VFS inode already.
 188          * Need to carefully get it back into useable state.
 189          */
 190         if (ip->i_flags & XFS_IRECLAIMABLE) {
 191                 trace_xfs_iget_reclaim(ip);
 192
 193                 /*
 194                  * We need to set XFS_INEW atomically with clearing the
 195                  * reclaimable tag so that we do have an indicator of the
 196                  * inode still being initialized.
 197                  */
 198                 ip->i_flags |= XFS_INEW;
 199                 ip->i_flags &= ~XFS_IRECLAIMABLE;
 200                 __xfs_inode_clear_reclaim_tag(mp, pag, ip);
 201
 202                 spin_unlock(&ip->i_flags_lock);
 203                 read_unlock(&pag->pag_ici_lock);
 204
 205                 error = -inode_init_always(mp->m_super, inode);
 206                 if (error) {
 207                         /*
 208                          * Re-initializing the inode failed, and we are in deep
 209                          * trouble.  Try to re-add it to the reclaim list.
 210                          */
 211                         read_lock(&pag->pag_ici_lock);
 212                         spin_lock(&ip->i_flags_lock);
 213
 214                         ip->i_flags &= ~XFS_INEW;
 215                         ip->i_flags |= XFS_IRECLAIMABLE;
 216                         __xfs_inode_set_reclaim_tag(pag, ip);
 217                         trace_xfs_iget_reclaim(ip);
 218                         goto out_error;
 219                 }
 220                 inode->i_state = I_LOCK|I_NEW;
 221         } else {
 222                 /* If the VFS inode is being torn down, pause and try again. */
 223                 if (!igrab(inode)) {
 224                         error = EAGAIN;
 225                         goto out_error;
 226                 }
 227
 228                 /* We've got a live one. */
 229                 spin_unlock(&ip->i_flags_lock);
 230                 read_unlock(&pag->pag_ici_lock);
 231         }
 232
 233         if (lock_flags != 0)
 234                 xfs_ilock(ip, lock_flags);
 235
 236         xfs_iflags_clear(ip, XFS_ISTALE);
 237         XFS_STATS_INC(xs_ig_found);
 238
 239         trace_xfs_iget_found(ip);
 240         return 0;
 241
 242 out_error:
 243         spin_unlock(&ip->i_flags_lock);
 244         read_unlock(&pag->pag_ici_lock);
 245         return error;
 246 }
 247
 248
 249 static int
 250 xfs_iget_cache_miss(
 251         struct xfs_mount        *mp,
 252         struct xfs_perag        *pag,
 253         xfs_trans_t             *tp,
 254         xfs_ino_t               ino,
 255         struct xfs_inode        **ipp,
 256         xfs_daddr_t             bno,
 257         int                     flags,
 258         int                     lock_flags)
 259 {
 260         struct xfs_inode        *ip;
 261         int                     error;
 262         unsigned long           first_index, mask;
 263         xfs_agino_t             agino = XFS_INO_TO_AGINO(mp, ino);
 264
 265         ip = xfs_inode_alloc(mp, ino);
 266         if (!ip)
 267                 return ENOMEM;
 268
 269         error = xfs_iread(mp, tp, ip, bno, flags);
 270         if (error)
 271                 goto out_destroy;
 272
 273         xfs_itrace_entry(ip);
 274
 275         if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
 276                 error = ENOENT;
 277                 goto out_destroy;
 278         }
 279
 280         /*
 281          * Preload the radix tree so we can insert safely under the
 282          * write spinlock. Note that we cannot sleep inside the preload
 283          * region.
 284          */
 285         if (radix_tree_preload(GFP_KERNEL)) {
 286                 error = EAGAIN;
 287                 goto out_destroy;
 288         }
 289
 290         /*
 291          * Because the inode hasn't been added to the radix-tree yet it can't
 292          * be found by another thread, so we can do the non-sleeping lock here.
 293          */
 294         if (lock_flags) {
 295                 if (!xfs_ilock_nowait(ip, lock_flags))
 296                         BUG();
 297         }
 298
 299         mask = ~(((XFS_INODE_CLUSTER_SIZE(mp) >> mp->m_sb.sb_inodelog)) - 1);
 300         first_index = agino & mask;
 301         write_lock(&pag->pag_ici_lock);
 302
 303         /* insert the new inode */
 304         error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
 305         if (unlikely(error)) {
 306                 WARN_ON(error != -EEXIST);
 307                 XFS_STATS_INC(xs_ig_dup);
 308                 error = EAGAIN;
 309                 goto out_preload_end;
 310         }
 311
 312         /* These values _must_ be set before releasing the radix tree lock! */
 313         ip->i_udquot = ip->i_gdquot = NULL;
 314         xfs_iflags_set(ip, XFS_INEW);
 315
 316         write_unlock(&pag->pag_ici_lock);
 317         radix_tree_preload_end();
 318
 319         trace_xfs_iget_alloc(ip);
 320         *ipp = ip;
 321         return 0;
 322
 323 out_preload_end:
 324         write_unlock(&pag->pag_ici_lock);
 325         radix_tree_preload_end();
 326         if (lock_flags)
 327                 xfs_iunlock(ip, lock_flags);
 328 out_destroy:
 329         __destroy_inode(VFS_I(ip));
 330         xfs_inode_free(ip);
 331         return error;
 332 }
 333
 334 /*
 335  * Look up an inode by number in the given file system.
 336  * The inode is looked up in the cache held in each AG.
 337  * If the inode is found in the cache, initialise the vfs inode
 338  * if necessary.
 339  *
 340  * If it is not in core, read it in from the file system's device,
 341  * add it to the cache and initialise the vfs inode.
 342  *
 343  * The inode is locked according to the value of the lock_flags parameter.
 344  * This flag parameter indicates how and if the inode's IO lock and inode lock
 345  * should be taken.
 346  *
 347  * mp -- the mount point structure for the current file system.  It points
 348  *       to the inode hash table.
 349  * tp -- a pointer to the current transaction if there is one.  This is
 350  *       simply passed through to the xfs_iread() call.
 351  * ino -- the number of the inode desired.  This is the unique identifier
 352  *        within the file system for the inode being requested.
 353  * lock_flags -- flags indicating how to lock the inode.  See the comment
 354  *               for xfs_ilock() for a list of valid values.
 355  * bno -- the block number starting the buffer containing the inode,
 356  *        if known (as by bulkstat), else 0.
 357  */
 358 int
 359 xfs_iget(
 360         xfs_mount_t     *mp,
 361         xfs_trans_t     *tp,
 362         xfs_ino_t       ino,
 363         uint            flags,
 364         uint            lock_flags,
 365         xfs_inode_t     **ipp,
 366         xfs_daddr_t     bno)
 367 {
 368         xfs_inode_t     *ip;
 369         int             error;
 370         xfs_perag_t     *pag;
 371         xfs_agino_t     agino;
 372
 373         /* the radix tree exists only in inode capable AGs */
 374         if (XFS_INO_TO_AGNO(mp, ino) >= mp->m_maxagi)
 375                 return EINVAL;
 376
 377         /* get the perag structure and ensure that it's inode capable */
 378         pag = xfs_get_perag(mp, ino);
 379         if (!pag->pagi_inodeok)
 380                 return EINVAL;
 381         ASSERT(pag->pag_ici_init);
 382         agino = XFS_INO_TO_AGINO(mp, ino);
 383
 384 again:
 385         error = 0;
 386         read_lock(&pag->pag_ici_lock);
 387         ip = radix_tree_lookup(&pag->pag_ici_root, agino);
 388
 389         if (ip) {
 390                 error = xfs_iget_cache_hit(pag, ip, flags, lock_flags);
 391                 if (error)
 392                         goto out_error_or_again;
 393         } else {
 394                 read_unlock(&pag->pag_ici_lock);
 395                 XFS_STATS_INC(xs_ig_missed);
 396
 397                 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip, bno,
 398                                                         flags, lock_flags);
 399                 if (error)
 400                         goto out_error_or_again;
 401         }
 402         xfs_put_perag(mp, pag);
 403
 404         *ipp = ip;
 405
 406         ASSERT(ip->i_df.if_ext_max ==
 407                XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
 408         /*
 409          * If we have a real type for an on-disk inode, we can set ops(&unlock)
 410          * now.  If it's a new inode being created, xfs_ialloc will handle it.
 411          */
 412         if (xfs_iflags_test(ip, XFS_INEW) && ip->i_d.di_mode != 0)
 413                 xfs_setup_inode(ip);
 414         return 0;
 415
 416 out_error_or_again:
 417         if (error == EAGAIN) {
 418                 delay(1);
 419                 goto again;
 420         }
 421         xfs_put_perag(mp, pag);
 422         return error;
 423 }
 424
 425 /*
 426  * Decrement reference count of an inode structure and unlock it.
 427  *
 428  * ip -- the inode being released
 429  * lock_flags -- this parameter indicates the inode's locks to be
 430  *       to be released.  See the comment on xfs_iunlock() for a list
 431  *       of valid values.
 432  */
 433 void
 434 xfs_iput(xfs_inode_t    *ip,
 435          uint           lock_flags)
 436 {
 437         xfs_itrace_entry(ip);
 438         xfs_iunlock(ip, lock_flags);
 439         IRELE(ip);
 440 }
 441
 442 /*
 443  * Special iput for brand-new inodes that are still locked
 444  */
 445 void
 446 xfs_iput_new(
 447         xfs_inode_t     *ip,
 448         uint            lock_flags)
 449 {
 450         struct inode    *inode = VFS_I(ip);
 451
 452         xfs_itrace_entry(ip);
 453
 454         if ((ip->i_d.di_mode == 0)) {
 455                 ASSERT(!xfs_iflags_test(ip, XFS_IRECLAIMABLE));
 456                 make_bad_inode(inode);
 457         }
 458         if (inode->i_state & I_NEW)
 459                 unlock_new_inode(inode);
 460         if (lock_flags)
 461                 xfs_iunlock(ip, lock_flags);
 462         IRELE(ip);
 463 }
 464
 465 /*
 466  * This is called free all the memory associated with an inode.
 467  * It must free the inode itself and any buffers allocated for
 468  * if_extents/if_data and if_broot.  It must also free the lock
 469  * associated with the inode.
 470  *
 471  * Note: because we don't initialise everything on reallocation out
 472  * of the zone, we must ensure we nullify everything correctly before
 473  * freeing the structure.
 474  */
 475 void
 476 xfs_ireclaim(
 477         struct xfs_inode        *ip)
 478 {
 479         struct xfs_mount        *mp = ip->i_mount;
 480         struct xfs_perag        *pag;
 481
 482         XFS_STATS_INC(xs_ig_reclaims);
 483
 484         /*
 485          * Remove the inode from the per-AG radix tree.  It doesn't matter
 486          * if it was never added to it because radix_tree_delete can deal
 487          * with that case just fine.
 488          */
 489         pag = xfs_get_perag(mp, ip->i_ino);
 490         write_lock(&pag->pag_ici_lock);
 491         radix_tree_delete(&pag->pag_ici_root, XFS_INO_TO_AGINO(mp, ip->i_ino));
 492         write_unlock(&pag->pag_ici_lock);
 493         xfs_put_perag(mp, pag);
 494
 495         /*
 496          * Here we do an (almost) spurious inode lock in order to coordinate
 497          * with inode cache radix tree lookups.  This is because the lookup
 498          * can reference the inodes in the cache without taking references.
 499          *
 500          * We make that OK here by ensuring that we wait until the inode is
 501          * unlocked after the lookup before we go ahead and free it.  We get
 502          * both the ilock and the iolock because the code may need to drop the
 503          * ilock one but will still hold the iolock.
 504          */
 505         xfs_ilock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 506         xfs_qm_dqdetach(ip);
 507         xfs_iunlock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 508
 509         xfs_inode_free(ip);
 510 }
 511
 512 /*
 513  * This is a wrapper routine around the xfs_ilock() routine
 514  * used to centralize some grungy code.  It is used in places
 515  * that wish to lock the inode solely for reading the extents.
 516  * The reason these places can't just call xfs_ilock(SHARED)
 517  * is that the inode lock also guards to bringing in of the
 518  * extents from disk for a file in b-tree format.  If the inode
 519  * is in b-tree format, then we need to lock the inode exclusively
 520  * until the extents are read in.  Locking it exclusively all
 521  * the time would limit our parallelism unnecessarily, though.
 522  * What we do instead is check to see if the extents have been
 523  * read in yet, and only lock the inode exclusively if they
 524  * have not.
 525  *
 526  * The function returns a value which should be given to the
 527  * corresponding xfs_iunlock_map_shared().  This value is
 528  * the mode in which the lock was actually taken.
 529  */
 530 uint
 531 xfs_ilock_map_shared(
 532         xfs_inode_t     *ip)
 533 {
 534         uint    lock_mode;
 535
 536         if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
 537             ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
 538                 lock_mode = XFS_ILOCK_EXCL;
 539         } else {
 540                 lock_mode = XFS_ILOCK_SHARED;
 541         }
 542
 543         xfs_ilock(ip, lock_mode);
 544
 545         return lock_mode;
 546 }
 547
 548 /*
 549  * This is simply the unlock routine to go with xfs_ilock_map_shared().
 550  * All it does is call xfs_iunlock() with the given lock_mode.
 551  */
 552 void
 553 xfs_iunlock_map_shared(
 554         xfs_inode_t     *ip,
 555         unsigned int    lock_mode)
 556 {
 557         xfs_iunlock(ip, lock_mode);
 558 }
 559
 560 /*
 561  * The xfs inode contains 2 locks: a multi-reader lock called the
 562  * i_iolock and a multi-reader lock called the i_lock.  This routine
 563  * allows either or both of the locks to be obtained.
 564  *
 565  * The 2 locks should always be ordered so that the IO lock is
 566  * obtained first in order to prevent deadlock.
 567  *
 568  * ip -- the inode being locked
 569  * lock_flags -- this parameter indicates the inode's locks
 570  *       to be locked.  It can be:
 571  *              XFS_IOLOCK_SHARED,
 572  *              XFS_IOLOCK_EXCL,
 573  *              XFS_ILOCK_SHARED,
 574  *              XFS_ILOCK_EXCL,
 575  *              XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
 576  *              XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
 577  *              XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
 578  *              XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
 579  */
 580 void
 581 xfs_ilock(
 582         xfs_inode_t             *ip,
 583         uint                    lock_flags)
 584 {
 585         /*
 586          * You can't set both SHARED and EXCL for the same lock,
 587          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 588          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 589          */
 590         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 591                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 592         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 593                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 594         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 595
 596         if (lock_flags & XFS_IOLOCK_EXCL)
 597                 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 598         else if (lock_flags & XFS_IOLOCK_SHARED)
 599                 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 600
 601         if (lock_flags & XFS_ILOCK_EXCL)
 602                 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 603         else if (lock_flags & XFS_ILOCK_SHARED)
 604                 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 605
 606         trace_xfs_ilock(ip, lock_flags, _RET_IP_);
 607 }
 608
 609 /*
 610  * This is just like xfs_ilock(), except that the caller
 611  * is guaranteed not to sleep.  It returns 1 if it gets
 612  * the requested locks and 0 otherwise.  If the IO lock is
 613  * obtained but the inode lock cannot be, then the IO lock
 614  * is dropped before returning.
 615  *
 616  * ip -- the inode being locked
 617  * lock_flags -- this parameter indicates the inode's locks to be
 618  *       to be locked.  See the comment for xfs_ilock() for a list
 619  *       of valid values.
 620  */
 621 int
 622 xfs_ilock_nowait(
 623         xfs_inode_t             *ip,
 624         uint                    lock_flags)
 625 {
 626         /*
 627          * You can't set both SHARED and EXCL for the same lock,
 628          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 629          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 630          */
 631         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 632                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 633         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 634                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 635         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 636
 637         if (lock_flags & XFS_IOLOCK_EXCL) {
 638                 if (!mrtryupdate(&ip->i_iolock))
 639                         goto out;
 640         } else if (lock_flags & XFS_IOLOCK_SHARED) {
 641                 if (!mrtryaccess(&ip->i_iolock))
 642                         goto out;
 643         }
 644         if (lock_flags & XFS_ILOCK_EXCL) {
 645                 if (!mrtryupdate(&ip->i_lock))
 646                         goto out_undo_iolock;
 647         } else if (lock_flags & XFS_ILOCK_SHARED) {
 648                 if (!mrtryaccess(&ip->i_lock))
 649                         goto out_undo_iolock;
 650         }
 651         trace_xfs_ilock_nowait(ip, lock_flags, _RET_IP_);
 652         return 1;
 653
 654  out_undo_iolock:
 655         if (lock_flags & XFS_IOLOCK_EXCL)
 656                 mrunlock_excl(&ip->i_iolock);
 657         else if (lock_flags & XFS_IOLOCK_SHARED)
 658                 mrunlock_shared(&ip->i_iolock);
 659  out:
 660         return 0;
 661 }
 662
 663 /*
 664  * xfs_iunlock() is used to drop the inode locks acquired with
 665  * xfs_ilock() and xfs_ilock_nowait().  The caller must pass
 666  * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
 667  * that we know which locks to drop.
 668  *
 669  * ip -- the inode being unlocked
 670  * lock_flags -- this parameter indicates the inode's locks to be
 671  *       to be unlocked.  See the comment for xfs_ilock() for a list
 672  *       of valid values for this parameter.
 673  *
 674  */
 675 void
 676 xfs_iunlock(
 677         xfs_inode_t             *ip,
 678         uint                    lock_flags)
 679 {
 680         /*
 681          * You can't set both SHARED and EXCL for the same lock,
 682          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 683          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 684          */
 685         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 686                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 687         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 688                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 689         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
 690                         XFS_LOCK_DEP_MASK)) == 0);
 691         ASSERT(lock_flags != 0);
 692
 693         if (lock_flags & XFS_IOLOCK_EXCL)
 694                 mrunlock_excl(&ip->i_iolock);
 695         else if (lock_flags & XFS_IOLOCK_SHARED)
 696                 mrunlock_shared(&ip->i_iolock);
 697
 698         if (lock_flags & XFS_ILOCK_EXCL)
 699                 mrunlock_excl(&ip->i_lock);
 700         else if (lock_flags & XFS_ILOCK_SHARED)
 701                 mrunlock_shared(&ip->i_lock);
 702
 703         if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
 704             !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
 705                 /*
 706                  * Let the AIL know that this item has been unlocked in case
 707                  * it is in the AIL and anyone is waiting on it.  Don't do
 708                  * this if the caller has asked us not to.
 709                  */
 710                 xfs_trans_unlocked_item(ip->i_itemp->ili_item.li_ailp,
 711                                         (xfs_log_item_t*)(ip->i_itemp));
 712         }
 713         trace_xfs_iunlock(ip, lock_flags, _RET_IP_);
 714 }
 715
 716 /*
 717  * give up write locks.  the i/o lock cannot be held nested
 718  * if it is being demoted.
 719  */
 720 void
 721 xfs_ilock_demote(
 722         xfs_inode_t             *ip,
 723         uint                    lock_flags)
 724 {
 725         ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
 726         ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
 727
 728         if (lock_flags & XFS_ILOCK_EXCL)
 729                 mrdemote(&ip->i_lock);
 730         if (lock_flags & XFS_IOLOCK_EXCL)
 731                 mrdemote(&ip->i_iolock);
 732
 733         trace_xfs_ilock_demote(ip, lock_flags, _RET_IP_);
 734 }
 735
 736 #ifdef DEBUG
 737 /*
 738  * Debug-only routine, without additional rw_semaphore APIs, we can
 739  * now only answer requests regarding whether we hold the lock for write
 740  * (reader state is outside our visibility, we only track writer state).
 741  *
 742  * Note: this means !xfs_isilocked would give false positives, so don't do that.
 743  */
 744 int
 745 xfs_isilocked(
 746         xfs_inode_t             *ip,
 747         uint                    lock_flags)
 748 {
 749         if ((lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) ==
 750                         XFS_ILOCK_EXCL) {
 751                 if (!ip->i_lock.mr_writer)
 752                         return 0;
 753         }
 754
 755         if ((lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) ==
 756                         XFS_IOLOCK_EXCL) {
 757                 if (!ip->i_iolock.mr_writer)
 758                         return 0;
 759         }
 760
 761         return 1;
 762 }
 763 #endif