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