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_bit.h"
  22 #include "xfs_log.h"
  23 #include "xfs_inum.h"
  24 #include "xfs_trans.h"
  25 #include "xfs_sb.h"
  26 #include "xfs_ag.h"
  27 #include "xfs_dir2.h"
  28 #include "xfs_dmapi.h"
  29 #include "xfs_mount.h"
  30 #include "xfs_bmap_btree.h"
  31 #include "xfs_alloc_btree.h"
  32 #include "xfs_ialloc_btree.h"
  33 #include "xfs_dir2_sf.h"
  34 #include "xfs_attr_sf.h"
  35 #include "xfs_dinode.h"
  36 #include "xfs_inode.h"
  37 #include "xfs_btree.h"
  38 #include "xfs_ialloc.h"
  39 #include "xfs_quota.h"
  40 #include "xfs_utils.h"
  41
  42 /*
  43  * Look up an inode by number in the given file system.
  44  * The inode is looked up in the cache held in each AG.
  45  * If the inode is found in the cache, attach it to the provided
  46  * vnode.
  47  *
  48  * If it is not in core, read it in from the file system's device,
  49  * add it to the cache and attach the provided vnode.
  50  *
  51  * The inode is locked according to the value of the lock_flags parameter.
  52  * This flag parameter indicates how and if the inode's IO lock and inode lock
  53  * should be taken.
  54  *
  55  * mp -- the mount point structure for the current file system.  It points
  56  *       to the inode hash table.
  57  * tp -- a pointer to the current transaction if there is one.  This is
  58  *       simply passed through to the xfs_iread() call.
  59  * ino -- the number of the inode desired.  This is the unique identifier
  60  *        within the file system for the inode being requested.
  61  * lock_flags -- flags indicating how to lock the inode.  See the comment
  62  *               for xfs_ilock() for a list of valid values.
  63  * bno -- the block number starting the buffer containing the inode,
  64  *        if known (as by bulkstat), else 0.
  65  */
  66 STATIC int
  67 xfs_iget_core(
  68         struct inode    *inode,
  69         xfs_mount_t     *mp,
  70         xfs_trans_t     *tp,
  71         xfs_ino_t       ino,
  72         uint            flags,
  73         uint            lock_flags,
  74         xfs_inode_t     **ipp,
  75         xfs_daddr_t     bno)
  76 {
  77         struct inode    *old_inode;
  78         xfs_inode_t     *ip;
  79         xfs_inode_t     *iq;
  80         int             error;
  81         unsigned long   first_index, mask;
  82         xfs_perag_t     *pag;
  83         xfs_agino_t     agino;
  84
  85         /* the radix tree exists only in inode capable AGs */
  86         if (XFS_INO_TO_AGNO(mp, ino) >= mp->m_maxagi)
  87                 return EINVAL;
  88
  89         /* get the perag structure and ensure that it's inode capable */
  90         pag = xfs_get_perag(mp, ino);
  91         if (!pag->pagi_inodeok)
  92                 return EINVAL;
  93         ASSERT(pag->pag_ici_init);
  94         agino = XFS_INO_TO_AGINO(mp, ino);
  95
  96 again:
  97         read_lock(&pag->pag_ici_lock);
  98         ip = radix_tree_lookup(&pag->pag_ici_root, agino);
  99
 100         if (ip != NULL) {
 101                 /*
 102                  * If INEW is set this inode is being set up
 103                  * we need to pause and try again.
 104                  */
 105                 if (xfs_iflags_test(ip, XFS_INEW)) {
 106                         read_unlock(&pag->pag_ici_lock);
 107                         delay(1);
 108                         XFS_STATS_INC(xs_ig_frecycle);
 109
 110                         goto again;
 111                 }
 112
 113                 old_inode = ip->i_vnode;
 114                 if (old_inode == NULL) {
 115                         /*
 116                          * If IRECLAIM is set this inode is
 117                          * on its way out of the system,
 118                          * we need to pause and try again.
 119                          */
 120                         if (xfs_iflags_test(ip, XFS_IRECLAIM)) {
 121                                 read_unlock(&pag->pag_ici_lock);
 122                                 delay(1);
 123                                 XFS_STATS_INC(xs_ig_frecycle);
 124
 125                                 goto again;
 126                         }
 127                         ASSERT(xfs_iflags_test(ip, XFS_IRECLAIMABLE));
 128
 129                         /*
 130                          * If lookup is racing with unlink, then we
 131                          * should return an error immediately so we
 132                          * don't remove it from the reclaim list and
 133                          * potentially leak the inode.
 134                          */
 135                         if ((ip->i_d.di_mode == 0) &&
 136                             !(flags & XFS_IGET_CREATE)) {
 137                                 read_unlock(&pag->pag_ici_lock);
 138                                 xfs_put_perag(mp, pag);
 139                                 return ENOENT;
 140                         }
 141
 142                         xfs_itrace_exit_tag(ip, "xfs_iget.alloc");
 143
 144                         XFS_STATS_INC(xs_ig_found);
 145                         xfs_iflags_clear(ip, XFS_IRECLAIMABLE);
 146                         read_unlock(&pag->pag_ici_lock);
 147
 148                         XFS_MOUNT_ILOCK(mp);
 149                         list_del_init(&ip->i_reclaim);
 150                         XFS_MOUNT_IUNLOCK(mp);
 151
 152                         goto finish_inode;
 153
 154                 } else if (inode != old_inode) {
 155                         /* The inode is being torn down, pause and
 156                          * try again.
 157                          */
 158                         if (old_inode->i_state & (I_FREEING | I_CLEAR)) {
 159                                 read_unlock(&pag->pag_ici_lock);
 160                                 delay(1);
 161                                 XFS_STATS_INC(xs_ig_frecycle);
 162
 163                                 goto again;
 164                         }
 165 /* Chances are the other vnode (the one in the inode) is being torn
 166 * down right now, and we landed on top of it. Question is, what do
 167 * we do? Unhook the old inode and hook up the new one?
 168 */
 169                         cmn_err(CE_PANIC,
 170                 "xfs_iget_core: ambiguous vns: vp/0x%p, invp/0x%p",
 171                                         old_inode, inode);
 172                 }
 173
 174                 /*
 175                  * Inode cache hit
 176                  */
 177                 read_unlock(&pag->pag_ici_lock);
 178                 XFS_STATS_INC(xs_ig_found);
 179
 180 finish_inode:
 181                 if (ip->i_d.di_mode == 0 && !(flags & XFS_IGET_CREATE)) {
 182                         xfs_put_perag(mp, pag);
 183                         return ENOENT;
 184                 }
 185
 186                 if (lock_flags != 0)
 187                         xfs_ilock(ip, lock_flags);
 188
 189                 xfs_iflags_clear(ip, XFS_ISTALE);
 190                 xfs_itrace_exit_tag(ip, "xfs_iget.found");
 191                 goto return_ip;
 192         }
 193
 194         /*
 195          * Inode cache miss
 196          */
 197         read_unlock(&pag->pag_ici_lock);
 198         XFS_STATS_INC(xs_ig_missed);
 199
 200         /*
 201          * Read the disk inode attributes into a new inode structure and get
 202          * a new vnode for it. This should also initialize i_ino and i_mount.
 203          */
 204         error = xfs_iread(mp, tp, ino, &ip, bno,
 205                           (flags & XFS_IGET_BULKSTAT) ? XFS_IMAP_BULKSTAT : 0);
 206         if (error) {
 207                 xfs_put_perag(mp, pag);
 208                 return error;
 209         }
 210
 211         xfs_itrace_exit_tag(ip, "xfs_iget.alloc");
 212
 213
 214         mrlock_init(&ip->i_lock, MRLOCK_ALLOW_EQUAL_PRI|MRLOCK_BARRIER,
 215                      "xfsino", ip->i_ino);
 216         mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", ip->i_ino);
 217         init_waitqueue_head(&ip->i_ipin_wait);
 218         atomic_set(&ip->i_pincount, 0);
 219
 220         /*
 221          * Because we want to use a counting completion, complete
 222          * the flush completion once to allow a single access to
 223          * the flush completion without blocking.
 224          */
 225         init_completion(&ip->i_flush);
 226         complete(&ip->i_flush);
 227
 228         if (lock_flags)
 229                 xfs_ilock(ip, lock_flags);
 230
 231         if ((ip->i_d.di_mode == 0) && !(flags & XFS_IGET_CREATE)) {
 232                 xfs_idestroy(ip);
 233                 xfs_put_perag(mp, pag);
 234                 return ENOENT;
 235         }
 236
 237         /*
 238          * Preload the radix tree so we can insert safely under the
 239          * write spinlock.
 240          */
 241         if (radix_tree_preload(GFP_KERNEL)) {
 242                 xfs_idestroy(ip);
 243                 delay(1);
 244                 goto again;
 245         }
 246         mask = ~(((XFS_INODE_CLUSTER_SIZE(mp) >> mp->m_sb.sb_inodelog)) - 1);
 247         first_index = agino & mask;
 248         write_lock(&pag->pag_ici_lock);
 249         /*
 250          * insert the new inode
 251          */
 252         error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
 253         if (unlikely(error)) {
 254                 BUG_ON(error != -EEXIST);
 255                 write_unlock(&pag->pag_ici_lock);
 256                 radix_tree_preload_end();
 257                 xfs_idestroy(ip);
 258                 XFS_STATS_INC(xs_ig_dup);
 259                 goto again;
 260         }
 261
 262         /*
 263          * These values _must_ be set before releasing the radix tree lock!
 264          */
 265         ip->i_udquot = ip->i_gdquot = NULL;
 266         xfs_iflags_set(ip, XFS_INEW);
 267
 268         write_unlock(&pag->pag_ici_lock);
 269         radix_tree_preload_end();
 270
 271         /*
 272          * Link ip to its mount and thread it on the mount's inode list.
 273          */
 274         XFS_MOUNT_ILOCK(mp);
 275         if ((iq = mp->m_inodes)) {
 276                 ASSERT(iq->i_mprev->i_mnext == iq);
 277                 ip->i_mprev = iq->i_mprev;
 278                 iq->i_mprev->i_mnext = ip;
 279                 iq->i_mprev = ip;
 280                 ip->i_mnext = iq;
 281         } else {
 282                 ip->i_mnext = ip;
 283                 ip->i_mprev = ip;
 284         }
 285         mp->m_inodes = ip;
 286
 287         XFS_MOUNT_IUNLOCK(mp);
 288         xfs_put_perag(mp, pag);
 289
 290  return_ip:
 291         ASSERT(ip->i_df.if_ext_max ==
 292                XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
 293
 294         xfs_iflags_set(ip, XFS_IMODIFIED);
 295         *ipp = ip;
 296
 297         /*
 298          * Set up the Linux with the Linux inode.
 299          */
 300         ip->i_vnode = inode;
 301         inode->i_private = ip;
 302
 303         /*
 304          * If we have a real type for an on-disk inode, we can set ops(&unlock)
 305          * now.  If it's a new inode being created, xfs_ialloc will handle it.
 306          */
 307         if (ip->i_d.di_mode != 0)
 308                 xfs_setup_inode(ip);
 309         return 0;
 310 }
 311
 312
 313 /*
 314  * The 'normal' internal xfs_iget, if needed it will
 315  * 'allocate', or 'get', the vnode.
 316  */
 317 int
 318 xfs_iget(
 319         xfs_mount_t     *mp,
 320         xfs_trans_t     *tp,
 321         xfs_ino_t       ino,
 322         uint            flags,
 323         uint            lock_flags,
 324         xfs_inode_t     **ipp,
 325         xfs_daddr_t     bno)
 326 {
 327         struct inode    *inode;
 328         xfs_inode_t     *ip;
 329         int             error;
 330
 331         XFS_STATS_INC(xs_ig_attempts);
 332
 333 retry:
 334         inode = iget_locked(mp->m_super, ino);
 335         if (!inode)
 336                 /* If we got no inode we are out of memory */
 337                 return ENOMEM;
 338
 339         if (inode->i_state & I_NEW) {
 340                 XFS_STATS_INC(vn_active);
 341                 XFS_STATS_INC(vn_alloc);
 342
 343                 error = xfs_iget_core(inode, mp, tp, ino, flags,
 344                                 lock_flags, ipp, bno);
 345                 if (error) {
 346                         make_bad_inode(inode);
 347                         if (inode->i_state & I_NEW)
 348                                 unlock_new_inode(inode);
 349                         iput(inode);
 350                 }
 351                 return error;
 352         }
 353
 354         /*
 355          * If the inode is not fully constructed due to
 356          * filehandle mismatches wait for the inode to go
 357          * away and try again.
 358          *
 359          * iget_locked will call __wait_on_freeing_inode
 360          * to wait for the inode to go away.
 361          */
 362         if (is_bad_inode(inode)) {
 363                 iput(inode);
 364                 delay(1);
 365                 goto retry;
 366         }
 367
 368         ip = XFS_I(inode);
 369         if (!ip) {
 370                 iput(inode);
 371                 delay(1);
 372                 goto retry;
 373         }
 374
 375         if (lock_flags != 0)
 376                 xfs_ilock(ip, lock_flags);
 377         XFS_STATS_INC(xs_ig_found);
 378         *ipp = ip;
 379         return 0;
 380 }
 381
 382 /*
 383  * Look for the inode corresponding to the given ino in the hash table.
 384  * If it is there and its i_transp pointer matches tp, return it.
 385  * Otherwise, return NULL.
 386  */
 387 xfs_inode_t *
 388 xfs_inode_incore(xfs_mount_t    *mp,
 389                  xfs_ino_t      ino,
 390                  xfs_trans_t    *tp)
 391 {
 392         xfs_inode_t     *ip;
 393         xfs_perag_t     *pag;
 394
 395         pag = xfs_get_perag(mp, ino);
 396         read_lock(&pag->pag_ici_lock);
 397         ip = radix_tree_lookup(&pag->pag_ici_root, XFS_INO_TO_AGINO(mp, ino));
 398         read_unlock(&pag->pag_ici_lock);
 399         xfs_put_perag(mp, pag);
 400
 401         /* the returned inode must match the transaction */
 402         if (ip && (ip->i_transp != tp))
 403                 return NULL;
 404         return ip;
 405 }
 406
 407 /*
 408  * Decrement reference count of an inode structure and unlock it.
 409  *
 410  * ip -- the inode being released
 411  * lock_flags -- this parameter indicates the inode's locks to be
 412  *       to be released.  See the comment on xfs_iunlock() for a list
 413  *       of valid values.
 414  */
 415 void
 416 xfs_iput(xfs_inode_t    *ip,
 417          uint           lock_flags)
 418 {
 419         xfs_itrace_entry(ip);
 420         xfs_iunlock(ip, lock_flags);
 421         IRELE(ip);
 422 }
 423
 424 /*
 425  * Special iput for brand-new inodes that are still locked
 426  */
 427 void
 428 xfs_iput_new(
 429         xfs_inode_t     *ip,
 430         uint            lock_flags)
 431 {
 432         struct inode    *inode = VFS_I(ip);
 433
 434         xfs_itrace_entry(ip);
 435
 436         if ((ip->i_d.di_mode == 0)) {
 437                 ASSERT(!xfs_iflags_test(ip, XFS_IRECLAIMABLE));
 438                 make_bad_inode(inode);
 439         }
 440         if (inode->i_state & I_NEW)
 441                 unlock_new_inode(inode);
 442         if (lock_flags)
 443                 xfs_iunlock(ip, lock_flags);
 444         IRELE(ip);
 445 }
 446
 447
 448 /*
 449  * This routine embodies the part of the reclaim code that pulls
 450  * the inode from the inode hash table and the mount structure's
 451  * inode list.
 452  * This should only be called from xfs_reclaim().
 453  */
 454 void
 455 xfs_ireclaim(xfs_inode_t *ip)
 456 {
 457         /*
 458          * Remove from old hash list and mount list.
 459          */
 460         XFS_STATS_INC(xs_ig_reclaims);
 461
 462         xfs_iextract(ip);
 463
 464         /*
 465          * Here we do a spurious inode lock in order to coordinate with
 466          * xfs_sync().  This is because xfs_sync() references the inodes
 467          * in the mount list without taking references on the corresponding
 468          * vnodes.  We make that OK here by ensuring that we wait until
 469          * the inode is unlocked in xfs_sync() before we go ahead and
 470          * free it.  We get both the regular lock and the io lock because
 471          * the xfs_sync() code may need to drop the regular one but will
 472          * still hold the io lock.
 473          */
 474         xfs_ilock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 475
 476         /*
 477          * Release dquots (and their references) if any. An inode may escape
 478          * xfs_inactive and get here via vn_alloc->vn_reclaim path.
 479          */
 480         XFS_QM_DQDETACH(ip->i_mount, ip);
 481
 482         /*
 483          * Pull our behavior descriptor from the vnode chain.
 484          */
 485         if (ip->i_vnode) {
 486                 ip->i_vnode->i_private = NULL;
 487                 ip->i_vnode = NULL;
 488         }
 489
 490         /*
 491          * Free all memory associated with the inode.
 492          */
 493         xfs_iunlock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 494         xfs_idestroy(ip);
 495 }
 496
 497 /*
 498  * This routine removes an about-to-be-destroyed inode from
 499  * all of the lists in which it is located with the exception
 500  * of the behavior chain.
 501  */
 502 void
 503 xfs_iextract(
 504         xfs_inode_t     *ip)
 505 {
 506         xfs_mount_t     *mp = ip->i_mount;
 507         xfs_perag_t     *pag = xfs_get_perag(mp, ip->i_ino);
 508         xfs_inode_t     *iq;
 509
 510         write_lock(&pag->pag_ici_lock);
 511         radix_tree_delete(&pag->pag_ici_root, XFS_INO_TO_AGINO(mp, ip->i_ino));
 512         write_unlock(&pag->pag_ici_lock);
 513         xfs_put_perag(mp, pag);
 514
 515         /*
 516          * Remove from mount's inode list.
 517          */
 518         XFS_MOUNT_ILOCK(mp);
 519         ASSERT((ip->i_mnext != NULL) && (ip->i_mprev != NULL));
 520         iq = ip->i_mnext;
 521         iq->i_mprev = ip->i_mprev;
 522         ip->i_mprev->i_mnext = iq;
 523
 524         /*
 525          * Fix up the head pointer if it points to the inode being deleted.
 526          */
 527         if (mp->m_inodes == ip) {
 528                 if (ip == iq) {
 529                         mp->m_inodes = NULL;
 530                 } else {
 531                         mp->m_inodes = iq;
 532                 }
 533         }
 534
 535         /* Deal with the deleted inodes list */
 536         list_del_init(&ip->i_reclaim);
 537
 538         mp->m_ireclaims++;
 539         XFS_MOUNT_IUNLOCK(mp);
 540 }
 541
 542 /*
 543  * This is a wrapper routine around the xfs_ilock() routine
 544  * used to centralize some grungy code.  It is used in places
 545  * that wish to lock the inode solely for reading the extents.
 546  * The reason these places can't just call xfs_ilock(SHARED)
 547  * is that the inode lock also guards to bringing in of the
 548  * extents from disk for a file in b-tree format.  If the inode
 549  * is in b-tree format, then we need to lock the inode exclusively
 550  * until the extents are read in.  Locking it exclusively all
 551  * the time would limit our parallelism unnecessarily, though.
 552  * What we do instead is check to see if the extents have been
 553  * read in yet, and only lock the inode exclusively if they
 554  * have not.
 555  *
 556  * The function returns a value which should be given to the
 557  * corresponding xfs_iunlock_map_shared().  This value is
 558  * the mode in which the lock was actually taken.
 559  */
 560 uint
 561 xfs_ilock_map_shared(
 562         xfs_inode_t     *ip)
 563 {
 564         uint    lock_mode;
 565
 566         if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
 567             ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
 568                 lock_mode = XFS_ILOCK_EXCL;
 569         } else {
 570                 lock_mode = XFS_ILOCK_SHARED;
 571         }
 572
 573         xfs_ilock(ip, lock_mode);
 574
 575         return lock_mode;
 576 }
 577
 578 /*
 579  * This is simply the unlock routine to go with xfs_ilock_map_shared().
 580  * All it does is call xfs_iunlock() with the given lock_mode.
 581  */
 582 void
 583 xfs_iunlock_map_shared(
 584         xfs_inode_t     *ip,
 585         unsigned int    lock_mode)
 586 {
 587         xfs_iunlock(ip, lock_mode);
 588 }
 589
 590 /*
 591  * The xfs inode contains 2 locks: a multi-reader lock called the
 592  * i_iolock and a multi-reader lock called the i_lock.  This routine
 593  * allows either or both of the locks to be obtained.
 594  *
 595  * The 2 locks should always be ordered so that the IO lock is
 596  * obtained first in order to prevent deadlock.
 597  *
 598  * ip -- the inode being locked
 599  * lock_flags -- this parameter indicates the inode's locks
 600  *       to be locked.  It can be:
 601  *              XFS_IOLOCK_SHARED,
 602  *              XFS_IOLOCK_EXCL,
 603  *              XFS_ILOCK_SHARED,
 604  *              XFS_ILOCK_EXCL,
 605  *              XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
 606  *              XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
 607  *              XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
 608  *              XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
 609  */
 610 void
 611 xfs_ilock(
 612         xfs_inode_t             *ip,
 613         uint                    lock_flags)
 614 {
 615         /*
 616          * You can't set both SHARED and EXCL for the same lock,
 617          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 618          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 619          */
 620         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 621                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 622         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 623                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 624         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 625
 626         if (lock_flags & XFS_IOLOCK_EXCL)
 627                 mrupdate_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 628         else if (lock_flags & XFS_IOLOCK_SHARED)
 629                 mraccess_nested(&ip->i_iolock, XFS_IOLOCK_DEP(lock_flags));
 630
 631         if (lock_flags & XFS_ILOCK_EXCL)
 632                 mrupdate_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 633         else if (lock_flags & XFS_ILOCK_SHARED)
 634                 mraccess_nested(&ip->i_lock, XFS_ILOCK_DEP(lock_flags));
 635
 636         xfs_ilock_trace(ip, 1, lock_flags, (inst_t *)__return_address);
 637 }
 638
 639 /*
 640  * This is just like xfs_ilock(), except that the caller
 641  * is guaranteed not to sleep.  It returns 1 if it gets
 642  * the requested locks and 0 otherwise.  If the IO lock is
 643  * obtained but the inode lock cannot be, then the IO lock
 644  * is dropped before returning.
 645  *
 646  * ip -- the inode being locked
 647  * lock_flags -- this parameter indicates the inode's locks to be
 648  *       to be locked.  See the comment for xfs_ilock() for a list
 649  *       of valid values.
 650  */
 651 int
 652 xfs_ilock_nowait(
 653         xfs_inode_t             *ip,
 654         uint                    lock_flags)
 655 {
 656         /*
 657          * You can't set both SHARED and EXCL for the same lock,
 658          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 659          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 660          */
 661         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 662                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 663         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 664                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 665         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_LOCK_DEP_MASK)) == 0);
 666
 667         if (lock_flags & XFS_IOLOCK_EXCL) {
 668                 if (!mrtryupdate(&ip->i_iolock))
 669                         goto out;
 670         } else if (lock_flags & XFS_IOLOCK_SHARED) {
 671                 if (!mrtryaccess(&ip->i_iolock))
 672                         goto out;
 673         }
 674         if (lock_flags & XFS_ILOCK_EXCL) {
 675                 if (!mrtryupdate(&ip->i_lock))
 676                         goto out_undo_iolock;
 677         } else if (lock_flags & XFS_ILOCK_SHARED) {
 678                 if (!mrtryaccess(&ip->i_lock))
 679                         goto out_undo_iolock;
 680         }
 681         xfs_ilock_trace(ip, 2, lock_flags, (inst_t *)__return_address);
 682         return 1;
 683
 684  out_undo_iolock:
 685         if (lock_flags & XFS_IOLOCK_EXCL)
 686                 mrunlock_excl(&ip->i_iolock);
 687         else if (lock_flags & XFS_IOLOCK_SHARED)
 688                 mrunlock_shared(&ip->i_iolock);
 689  out:
 690         return 0;
 691 }
 692
 693 /*
 694  * xfs_iunlock() is used to drop the inode locks acquired with
 695  * xfs_ilock() and xfs_ilock_nowait().  The caller must pass
 696  * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
 697  * that we know which locks to drop.
 698  *
 699  * ip -- the inode being unlocked
 700  * lock_flags -- this parameter indicates the inode's locks to be
 701  *       to be unlocked.  See the comment for xfs_ilock() for a list
 702  *       of valid values for this parameter.
 703  *
 704  */
 705 void
 706 xfs_iunlock(
 707         xfs_inode_t             *ip,
 708         uint                    lock_flags)
 709 {
 710         /*
 711          * You can't set both SHARED and EXCL for the same lock,
 712          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 713          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 714          */
 715         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 716                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 717         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 718                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 719         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY |
 720                         XFS_LOCK_DEP_MASK)) == 0);
 721         ASSERT(lock_flags != 0);
 722
 723         if (lock_flags & XFS_IOLOCK_EXCL)
 724                 mrunlock_excl(&ip->i_iolock);
 725         else if (lock_flags & XFS_IOLOCK_SHARED)
 726                 mrunlock_shared(&ip->i_iolock);
 727
 728         if (lock_flags & XFS_ILOCK_EXCL)
 729                 mrunlock_excl(&ip->i_lock);
 730         else if (lock_flags & XFS_ILOCK_SHARED)
 731                 mrunlock_shared(&ip->i_lock);
 732
 733         if ((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) &&
 734             !(lock_flags & XFS_IUNLOCK_NONOTIFY) && ip->i_itemp) {
 735                 /*
 736                  * Let the AIL know that this item has been unlocked in case
 737                  * it is in the AIL and anyone is waiting on it.  Don't do
 738                  * this if the caller has asked us not to.
 739                  */
 740                 xfs_trans_unlocked_item(ip->i_mount,
 741                                         (xfs_log_item_t*)(ip->i_itemp));
 742         }
 743         xfs_ilock_trace(ip, 3, lock_flags, (inst_t *)__return_address);
 744 }
 745
 746 /*
 747  * give up write locks.  the i/o lock cannot be held nested
 748  * if it is being demoted.
 749  */
 750 void
 751 xfs_ilock_demote(
 752         xfs_inode_t             *ip,
 753         uint                    lock_flags)
 754 {
 755         ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
 756         ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
 757
 758         if (lock_flags & XFS_ILOCK_EXCL)
 759                 mrdemote(&ip->i_lock);
 760         if (lock_flags & XFS_IOLOCK_EXCL)
 761                 mrdemote(&ip->i_iolock);
 762 }
 763
 764 #ifdef DEBUG
 765 /*
 766  * Debug-only routine, without additional rw_semaphore APIs, we can
 767  * now only answer requests regarding whether we hold the lock for write
 768  * (reader state is outside our visibility, we only track writer state).
 769  *
 770  * Note: this means !xfs_isilocked would give false positives, so don't do that.
 771  */
 772 int
 773 xfs_isilocked(
 774         xfs_inode_t             *ip,
 775         uint                    lock_flags)
 776 {
 777         if ((lock_flags & (XFS_ILOCK_EXCL|XFS_ILOCK_SHARED)) ==
 778                         XFS_ILOCK_EXCL) {
 779                 if (!ip->i_lock.mr_writer)
 780                         return 0;
 781         }
 782
 783         if ((lock_flags & (XFS_IOLOCK_EXCL|XFS_IOLOCK_SHARED)) ==
 784                         XFS_IOLOCK_EXCL) {
 785                 if (!ip->i_iolock.mr_writer)
 786                         return 0;
 787         }
 788
 789         return 1;
 790 }
 791 #endif
 792